Add sanitizer flags to cmake

Author: kswiecicki

CMakeLists.txt

@@ -26,6 +26,9 @@ option(UMF_BUILD_BENCHMARKS "Build UMF benchmarks" OFF)
 option(UMF_ENABLE_POOL_TRACKING "Build UMF with pool tracking" ON)
 option(UMF_DEVELOPER_MODE "Enable developer checks, treats warnings as errors" OFF)
 option(UMF_FORMAT_CODE_STYLE "Format UMF code with clang-format" OFF)
+option(USE_ASAN "Enable AddressSanitizer checks" OFF)
+option(USE_UBSAN "Enable UndefinedBehaviorSanitizer checks" OFF)
+option(USE_TSAN "Enable ThreadSanitizer checks" OFF)
 
 if(${CMAKE_SYSTEM_NAME} MATCHES "Linux")
     set(LINUX TRUE)
@@ -57,6 +60,17 @@ if(MSVC)
     set(CUSTOM_COMMAND_BINARY_DIR ${CUSTOM_COMMAND_BINARY_DIR}/$<CONFIG>)
 endif()
 
+# Sanitizer flags
+if(USE_ASAN)
+	add_sanitizer_flag(address)
+endif()
+if(USE_UBSAN)
+	add_sanitizer_flag(undefined)
+endif()
+if(USE_TSAN)
+	add_sanitizer_flag(thread)
+endif()
+
 # A header only library to specify include directories in transitive
 # dependencies.
 add_library(umf_headers INTERFACE)
@@ -94,7 +108,7 @@ endif()
 if(UMF_FORMAT_CODE_STYLE)
     find_program(CLANG_FORMAT NAMES clang-format-15 clang-format-15.0 clang-format)
 
-    if(CLANG_FORMAT)        
+    if(CLANG_FORMAT)
         get_program_version_major_minor(${CLANG_FORMAT} CLANG_FORMAT_VERSION)
         message(STATUS "Found clang-format: ${CLANG_FORMAT} (version: ${CLANG_FORMAT_VERSION})")
 
@@ -105,7 +119,7 @@ if(UMF_FORMAT_CODE_STYLE)
     else()
         message(FATAL_ERROR "UMF_FORMAT_CODE_STYLE=ON, but clang-format not found (required version: ${CLANG_FORMAT_REQUIRED})")
     endif()
-    
+
     # Obtain files for clang-format check
     set(format_glob)
     foreach(DIR IN ITEMS include src test benchmark)
@@ -123,11 +137,11 @@ if(UMF_FORMAT_CODE_STYLE)
     file(GLOB_RECURSE format_list ${format_glob})
 
     message(STATUS "Adding clang-format-check and clang-format-apply make targets")
-    
+
     add_custom_target(clang-format-check
         COMMAND ${CLANG_FORMAT}
-            --style=file            
-            --dry-run 
+            --style=file
+            --dry-run
             -Werror
             ${format_list}
         COMMENT "Check files formatting using clang-format")
@@ -137,7 +151,7 @@ if(UMF_FORMAT_CODE_STYLE)
             --style=file
             --i
             ${format_list}
-        COMMENT "Format files using clang-format")        
+        COMMENT "Format files using clang-format")
 endif()
 
 # Add license to the installation path

cmake/helpers.cmake

@@ -6,6 +6,10 @@
 # helpers.cmake -- helper functions for top-level CMakeLists.txt
 #
 
+# CMake modules that check whether the C/C++ compiler supports a given flag
+include(CheckCCompilerFlag)
+include(CheckCXXCompilerFlag)
+
 # Sets ${ret} to version of program specified by ${name} in major.minor format
 function(get_program_version_major_minor name ret)
     execute_process(COMMAND ${name} --version
@@ -104,3 +108,46 @@ function(add_umf_library)
     add_umf_target_compile_options(${ARG_NAME})
     add_umf_target_link_options(${ARG_NAME})
 endfunction()
+
+# Add sanitizer ${flag}, if it is supported, for both C and C++ compiler
+macro(add_sanitizer_flag flag)
+    # Save current 'CMAKE_REQUIRED_LIBRARIES' state and temporarily extend it with
+    # '-fsanitize=${flag}'. It is required by CMake to check the compiler for
+    # availability of provided sanitizer ${flag}.
+    if(WINDOWS)
+        set(SANITIZER_FLAG "/fsanitize=${flag}")
+        set(SANITIZER_ARGS "")
+    else()
+        set(SANITIZER_FLAG "-fsanitize=${flag}")
+        set(SANITIZER_ARGS "-fno-sanitize-recover=all")
+    endif()
+
+	set(SAVED_CMAKE_REQUIRED_LIBRARIES ${CMAKE_REQUIRED_LIBRARIES})
+	set(CMAKE_REQUIRED_LIBRARIES "${CMAKE_REQUIRED_LIBRARIES} ${SANITIZER_FLAG}")
+
+    if(${flag} STREQUAL "address")
+        set(check_name "HAS_ASAN")
+    elseif(${flag} STREQUAL "undefined")
+        set(check_name "HAS_UBSAN")
+    elseif(${flag} STREQUAL "thread")
+        set(check_name "HAS_TSAN")
+    endif()
+
+    # Check C and CXX compilers for given sanitizer flag.
+	check_c_compiler_flag("${SANITIZER_FLAG}" "C_${check_name}")
+	check_cxx_compiler_flag("${SANITIZER_FLAG}" "CXX_${check_name}")
+	if (${C_${check_name}} OR ${CXX_${check_name}})
+        # Set appropriate linker flags for building executables.
+		set(CMAKE_EXE_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS} ${SANITIZER_FLAG} ${SANITIZER_ARGS}")
+		if (${C_${check_name}})
+			set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} ${SANITIZER_FLAG} ${SANITIZER_ARGS}")
+		endif()
+		if (${CXX_${check_name}})
+			set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} ${SANITIZER_FLAG} ${SANITIZER_ARGS}")
+		endif()
+	else()
+		message(FATAL_ERROR "${flag} sanitizer is not supported (neither by C nor CXX compiler)")
+	endif()
+
+	set(CMAKE_REQUIRED_LIBRARIES ${SAVED_CMAKE_REQUIRED_LIBRARIES})
+endmacro()