Skip to content

Add address_sanitizer option for MSVC builds #1035

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Add address_sanitizer option for MSVC builds #1035

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
63cea95
#1034: add a CMake option for MSVC builds to use address_sanitizer
lederernc Nov 5, 2025
af81575
#1034: add a readme
lederernc Nov 5, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
91 changes: 88 additions & 3 deletions CPP/CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ option(CLIPPER2_EXAMPLES "Build examples" ON)
option(CLIPPER2_TESTS "Build tests" ON)
option(USE_EXTERNAL_GTEST "Use system-wide installed GoogleTest" OFF)
option(USE_EXTERNAL_GBENCHMARK "Use the googlebenchmark" OFF)
option(USE_MSVC_ADDRESS_SANITIZER "Enable sanitize address" off)
option(BUILD_SHARED_LIBS "Build shared libs" OFF)
set(CLIPPER2_USINGZ "ON" CACHE STRING "Build Clipper2Z, either \"ON\" or \"OFF\" or \"ONLY\"")
# CLIPPER2_MAX_DECIMAL_PRECISION: maximum decimal precision when scaling PathsD to Paths64.
Expand All @@ -34,6 +35,29 @@ if (APPLE)
set(CMAKE_SHARED_LIBRARY_SUFFIX ".dylib")
endif ()

if(WIN32)
if(USE_MSVC_ADDRESS_SANITIZER AND MSVC_VERSION GREATER_EQUAL 1927)
find_library(MSVC_CLANG_RT
NAMES
clang_rt.asan_dynamic-x86_64
REQUIRED
PATHS
"C:/Program Files/Microsoft Visual Studio/2022/Community/VC/Tools/MSVC/14.44.35207/lib/x64"
"C:/Program Files/Microsoft Visual Studio/2022/Community/VC/Tools/MSVC/14.35.32215/lib/x64"
"C:/Program Files (x86)/Microsoft Visual Studio/2019/Community/VC/Tools/MSVC/14.27.29110/lib/x64"
)
find_library(MSVC_CLANG_RT_THUNK
NAMES
clang_rt.asan_dynamic_runtime_thunk-x86_64
REQUIRED
PATHS
"C:/Program Files/Microsoft Visual Studio/2022/Community/VC/Tools/MSVC/14.44.35207/lib/x64"
"C:/Program Files/Microsoft Visual Studio/2022/Community/VC/Tools/MSVC/14.35.32215/lib/x64"
"C:/Program Files (x86)/Microsoft Visual Studio/2019/Community/VC/Tools/MSVC/14.27.29110/lib/x64"
)
endif()
endif()

include(GNUInstallDirs)
set(CLIPPER2_INC_FOLDER ${PROJECT_SOURCE_DIR}/Clipper2Lib/include/clipper2)
configure_file(clipper.version.in
Expand Down Expand Up @@ -77,6 +101,11 @@ if (NOT (CLIPPER2_USINGZ STREQUAL "ONLY"))

if (MSVC)
target_compile_options(Clipper2 PRIVATE /W4 /WX)
if (USE_MSVC_ADDRESS_SANITIZER)
target_compile_options(Clipper2 PRIVATE $<$<COMPILE_LANGUAGE:C>:/fsanitize=address>)
target_compile_options(Clipper2 PRIVATE $<$<COMPILE_LANGUAGE:CXX>:/fsanitize=address>)
target_link_libraries(Clipper2 PRIVATE ${MSVC_CLANG_RT} ${MSVC_CLANG_RT_THUNK})
endif()
else()
target_compile_options(Clipper2 PRIVATE -Wall -Wextra -Wpedantic -Werror)
target_link_libraries(Clipper2 PUBLIC -lm)
Expand All @@ -102,6 +131,11 @@ if (NOT (CLIPPER2_USINGZ STREQUAL "OFF"))

if (MSVC)
target_compile_options(Clipper2Z PRIVATE /W4 /WX)
if (USE_MSVC_ADDRESS_SANITIZER)
target_compile_options(Clipper2Z PRIVATE $<$<COMPILE_LANGUAGE:C>:/fsanitize=address>)
target_compile_options(Clipper2Z PRIVATE $<$<COMPILE_LANGUAGE:CXX>:/fsanitize=address>)
target_link_libraries(Clipper2Z PRIVATE ${MSVC_CLANG_RT} ${MSVC_CLANG_RT_THUNK})
endif()
else()
target_compile_options(Clipper2Z PRIVATE -Wall -Wextra -Wpedantic -Werror)
target_link_libraries(Clipper2Z PUBLIC -lm)
Expand Down Expand Up @@ -135,13 +169,27 @@ if(CLIPPER2_UTILS OR CLIPPER2_TESTS OR CLIPPER2_EXAMPLES)
add_library(Clipper2utils STATIC ${CLIPPER2_UTILS_INC} ${CLIPPER2_UTILS_SRC})

target_link_libraries(Clipper2utils PUBLIC Clipper2)
if(WIN32)
if (USE_MSVC_ADDRESS_SANITIZER)
target_compile_options(Clipper2utils PRIVATE $<$<COMPILE_LANGUAGE:C>:/fsanitize=address>)
target_compile_options(Clipper2utils PRIVATE $<$<COMPILE_LANGUAGE:CXX>:/fsanitize=address>)
target_link_libraries(Clipper2utils PRIVATE ${MSVC_CLANG_RT} ${MSVC_CLANG_RT_THUNK})
endif()
endif()
endif()

if (NOT (CLIPPER2_USINGZ STREQUAL "OFF"))
list(APPEND CLIPPER2_UTILS Clipper2Zutils)
add_library(Clipper2Zutils STATIC ${CLIPPER2_UTILS_INC} ${CLIPPER2_UTILS_SRC})

target_link_libraries(Clipper2Zutils PUBLIC Clipper2Z)
if(WIN32)
if (USE_MSVC_ADDRESS_SANITIZER)
target_compile_options(Clipper2Zutils PRIVATE $<$<COMPILE_LANGUAGE:C>:/fsanitize=address>)
target_compile_options(Clipper2Zutils PRIVATE $<$<COMPILE_LANGUAGE:CXX>:/fsanitize=address>)
target_link_libraries(Clipper2Zutils PRIVATE ${MSVC_CLANG_RT} ${MSVC_CLANG_RT_THUNK})
endif()
endif()
endif()

set_target_properties(${CLIPPER2_UTILS} PROPERTIES FOLDER Libraries)
Expand Down Expand Up @@ -193,6 +241,13 @@ if(CLIPPER2_EXAMPLES)
foreach(ex ${EXAMPLES})
add_executable(${ex} Examples/${ex}/${ex}.cpp)
target_link_libraries(${ex} PRIVATE Clipper2 Clipper2utils)
if (WIN32)
if (USE_MSVC_ADDRESS_SANITIZER)
target_compile_options(${ex} PRIVATE $<$<COMPILE_LANGUAGE:C>:/fsanitize=address>)
target_compile_options(${ex} PRIVATE $<$<COMPILE_LANGUAGE:CXX>:/fsanitize=address>)
target_link_libraries(${ex} PRIVATE ${MSVC_CLANG_RT} ${MSVC_CLANG_RT_THUNK})
endif()
endif()
endforeach()

file(COPY Examples/Inflate/rabbit.svg DESTINATION ${CMAKE_BINARY_DIR} FILE_PERMISSIONS OWNER_READ GROUP_READ WORLD_READ )
Expand All @@ -204,6 +259,13 @@ if(CLIPPER2_EXAMPLES)
foreach(ex ${EXAMPLESZ})
add_executable(${ex} Examples/${ex}/${ex}.cpp)
target_link_libraries(${ex} PRIVATE Clipper2Z Clipper2Zutils)
if (WIN32)
if (USE_MSVC_ADDRESS_SANITIZER)
target_compile_options(${ex} PRIVATE $<$<COMPILE_LANGUAGE:C>:/fsanitize=address>)
target_compile_options(${ex} PRIVATE $<$<COMPILE_LANGUAGE:CXX>:/fsanitize=address>)
target_link_libraries(${ex} PRIVATE ${MSVC_CLANG_RT} ${MSVC_CLANG_RT_THUNK})
endif()
endif()
endforeach()

list(APPEND ALL_EXAMPLES ${EXAMPLESZ})
Expand Down Expand Up @@ -236,6 +298,16 @@ else()
endif()
add_subdirectory("${PROJECT_SOURCE_DIR}/Tests/googletest/")
set_target_properties(gtest gtest_main PROPERTIES FOLDER GTest)
if(WIN32)
if (USE_MSVC_ADDRESS_SANITIZER)
target_compile_options(gtest PRIVATE $<$<COMPILE_LANGUAGE:C>:/fsanitize=address>)
target_compile_options(gtest PRIVATE $<$<COMPILE_LANGUAGE:CXX>:/fsanitize=address>)
target_link_libraries(gtest PRIVATE ${MSVC_CLANG_RT} ${MSVC_CLANG_RT_THUNK})
target_compile_options(gtest_main PRIVATE $<$<COMPILE_LANGUAGE:C>:/fsanitize=address>)
target_compile_options(gtest_main PRIVATE $<$<COMPILE_LANGUAGE:CXX>:/fsanitize=address>)
target_link_libraries(gtest_main PRIVATE ${MSVC_CLANG_RT} ${MSVC_CLANG_RT_THUNK})
endif()
endif()
endif()

if(TARGET gtest AND TARGET gtest_main)
Expand Down Expand Up @@ -267,7 +339,14 @@ endif()
if (NOT (CLIPPER2_USINGZ STREQUAL "ONLY"))
list(APPEND CLIPPER2_TESTS "ClipperTests")
add_executable(ClipperTests ${ClipperTests_SRC})
target_link_libraries(ClipperTests ${gtest_libs} Clipper2 Clipper2utils)
target_link_libraries(ClipperTests PUBLIC ${gtest_libs} Clipper2 Clipper2utils)
if (WIN32)
if (USE_MSVC_ADDRESS_SANITIZER)
target_compile_options(ClipperTests PRIVATE $<$<COMPILE_LANGUAGE:C>:/fsanitize=address>)
target_compile_options(ClipperTests PRIVATE $<$<COMPILE_LANGUAGE:CXX>:/fsanitize=address>)
target_link_libraries(ClipperTests PRIVATE ${MSVC_CLANG_RT} ${MSVC_CLANG_RT_THUNK})
endif()
endif()

gtest_discover_tests(ClipperTests
# set a working directory to your project root so that you can find test data via paths relative to the project root
Expand All @@ -279,8 +358,14 @@ endif()
if (NOT (CLIPPER2_USINGZ STREQUAL "OFF"))
list(APPEND CLIPPER2_TESTS "ClipperTestsZ")
add_executable(ClipperTestsZ ${ClipperTests_SRC})
target_link_libraries(ClipperTestsZ ${gtest_libs} Clipper2Z Clipper2Zutils)

target_link_libraries(ClipperTestsZ PUBLIC ${gtest_libs} Clipper2Z Clipper2Zutils)
if (WIN32)
if (USE_MSVC_ADDRESS_SANITIZER)
target_compile_options(ClipperTestsZ PRIVATE $<$<COMPILE_LANGUAGE:C>:/fsanitize=address>)
target_compile_options(ClipperTestsZ PRIVATE $<$<COMPILE_LANGUAGE:CXX>:/fsanitize=address>)
target_link_libraries(ClipperTestsZ PRIVATE ${MSVC_CLANG_RT} ${MSVC_CLANG_RT_THUNK})
endif()
endif()
gtest_discover_tests(ClipperTestsZ
# set a working directory so your project root so that you can find test data via paths relative to the project root
WORKING_DIRECTORY ${PROJECT_SOURCE_DIR}/../Tests
Expand Down
9 changes: 9 additions & 0 deletions CPP/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# README

## Address Sanitizer

To build with address_sanitizer enabled use the following command:

`cd Clipper2 && mkdir build && cd build && cmake ../CPP -G "Visual Studio 17 2022" -DUSE_MSVC_ADDRESS_SANITIZER:BOOL=YES`

or something along those lines.
Loading