Allow combining multiple sanitizers in one build.

Each selected sanitizer is tested individually, and if test fails the configure step aborts.
After that, all selected sanitizers are tested for mutual compatibility.

It reuse SET_SANITIZER, sanitizers are passed as a string which is tested with MATCHES. No Delimeter is actually required.

Author: rlalik

sanitizers.cmake

@@ -13,6 +13,8 @@
 # License for the specific language governing permissions and limitations under
 # the License.
 
+include(CheckCXXSourceCompiles)
+
 set(USE_SANITIZER
     ""
     CACHE
@@ -28,48 +30,109 @@ function(append value)
   endforeach(variable)
 endfunction()
 
+function(test_san_flags return_var flags)
+    set(QUIET_BACKUP ${CMAKE_REQUIRED_QUIET})
+    set(CMAKE_REQUIRED_QUIET TRUE)
+    unset(${return_var} CACHE)
+    set(FLAGS_BACKUP ${CMAKE_REQUIRED_FLAGS})
+    set(CMAKE_REQUIRED_FLAGS "${flags}")
+    check_cxx_source_compiles("int main() { return 0; }" ${return_var})
+    set(CMAKE_REQUIRED_FLAGS "${FLAGS_BACKUP}")
+    set(CMAKE_REQUIRED_QUIET "${QUIET_BACKUP}")
+endfunction()
+
 if(USE_SANITIZER)
   append("-fno-omit-frame-pointer" CMAKE_C_FLAGS CMAKE_CXX_FLAGS)
 
+  unset(SANITIZER_SELECTED_FLAGS)
+
   if(UNIX)
 
     if(uppercase_CMAKE_BUILD_TYPE STREQUAL "DEBUG")
       append("-O1" CMAKE_C_FLAGS CMAKE_CXX_FLAGS)
     endif()
 
-    if(USE_SANITIZER MATCHES "([Aa]ddress);([Uu]ndefined)"
-       OR USE_SANITIZER MATCHES "([Uu]ndefined);([Aa]ddress)")
-      message(STATUS "Building with Address, Undefined sanitizers")
-      append("-fsanitize=address,undefined" CMAKE_C_FLAGS CMAKE_CXX_FLAGS)
-    elseif(USE_SANITIZER MATCHES "([Aa]ddress)")
+    if(USE_SANITIZER MATCHES "([Aa]ddress)")
       # Optional: -fno-optimize-sibling-calls -fsanitize-address-use-after-scope
-      message(STATUS "Building with Address sanitizer")
-      append("-fsanitize=address" CMAKE_C_FLAGS CMAKE_CXX_FLAGS)
-    elseif(USE_SANITIZER MATCHES "([Mm]emory([Ww]ith[Oo]rigins)?)")
+      message(STATUS "Testing with Address sanitizer")
+      set(SANITIZER_ADDR_FLAG "-fsanitize=address")
+      test_san_flags(SANITIZER_ADDR_AVAILABLE ${SANITIZER_ADDR_FLAG})
+      if (SANITIZER_ADDR_AVAILABLE)
+        message(STATUS "  Building with Address sanitizer")
+        append("${SANITIZER_ADDR_FLAG}" SANITIZER_SELECTED_FLAGS)
+      else()
+        message(FATAL_ERROR "Address sanitizer not available for ${CMAKE_CXX_COMPILER}")
+      endif()
+    endif()
+
+    if(USE_SANITIZER MATCHES "([Mm]emory([Ww]ith[Oo]rigins)?)")
       # Optional: -fno-optimize-sibling-calls -fsanitize-memory-track-origins=2
-      append("-fsanitize=memory" CMAKE_C_FLAGS CMAKE_CXX_FLAGS)
+      set(SANITIZER_MEM_FLAG "-fsanitize=memory")
       if(USE_SANITIZER MATCHES "([Mm]emory[Ww]ith[Oo]rigins)")
-        message(STATUS "Building with MemoryWithOrigins sanitizer")
-        append("-fsanitize-memory-track-origins" CMAKE_C_FLAGS CMAKE_CXX_FLAGS)
+        message(STATUS "Testing with MemoryWithOrigins sanitizer")
+        append("-fsanitize-memory-track-origins" SANITIZER_MEM_FLAG)
       else()
-        message(STATUS "Building with Memory sanitizer")
+        message(STATUS "Testing with Memory sanitizer")
       endif()
-    elseif(USE_SANITIZER MATCHES "([Uu]ndefined)")
-      message(STATUS "Building with Undefined sanitizer")
-      append("-fsanitize=undefined" CMAKE_C_FLAGS CMAKE_CXX_FLAGS)
+      test_san_flags(SANITIZER_MEM_AVAILABLE ${SANITIZER_MEM_FLAG})
+      if (SANITIZER_MEM_AVAILABLE)
+        if(USE_SANITIZER MATCHES "([Mm]emory[Ww]ith[Oo]rigins)")
+            message(STATUS "  Building with MemoryWithOrigins sanitizer")
+        else()
+            message(STATUS "  Building with Memory sanitizer")
+        endif()
+        append("${SANITIZER_MEM_FLAG}" SANITIZER_SELECTED_FLAGS)
+      else()
+        message(FATAL_ERROR "Memory [With Origins] sanitizer not available for ${CMAKE_CXX_COMPILER}")
+      endif()
+    endif()
+
+    if(USE_SANITIZER MATCHES "([Uu]ndefined)")
+      message(STATUS "Testing with Undefined Behaviour sanitizer")
+      set(SANITIZER_UB_FLAG "-fsanitize=undefined")
       if(EXISTS "${BLACKLIST_FILE}")
-        append("-fsanitize-blacklist=${BLACKLIST_FILE}" CMAKE_C_FLAGS
-               CMAKE_CXX_FLAGS)
+        append("-fsanitize-blacklist=${BLACKLIST_FILE}" SANITIZER_UB_FLAG)
+      endif()
+      test_san_flags(SANITIZER_UB_AVAILABLE ${SANITIZER_UB_FLAG})
+      if (SANITIZER_UB_AVAILABLE)
+        message(STATUS "  Building with Undefined Behaviour sanitizer")
+        append("${SANITIZER_UB_FLAG}" SANITIZER_SELECTED_FLAGS)
+      else()
+        message(FATAL_ERROR "Undefined Behaviour sanitizer not available for ${CMAKE_CXX_COMPILER}")
+      endif()
+    endif()
+
+    if(USE_SANITIZER MATCHES "([Tt]hread)")
+      message(STATUS "Testing with Thread sanitizer")
+      set(SANITIZER_THREAD_FLAG "-fsanitize=thread")
+      test_san_flags(SANITIZER_THREAD_AVAILABLE ${SANITIZER_THREAD_FLAG})
+      if (SANITIZER_THREAD_AVAILABLE)
+        message(STATUS "  Building with Thread sanitizer")
+        append("${SANITIZER_THREAD_FLAG}" SANITIZER_SELECTED_FLAGS)
+      else()
+        message(FATAL_ERROR "Thread sanitizer not available for ${CMAKE_CXX_COMPILER}")
       endif()
-    elseif(USE_SANITIZER MATCHES "([Tt]hread)")
-      message(STATUS "Building with Thread sanitizer")
-      append("-fsanitize=thread" CMAKE_C_FLAGS CMAKE_CXX_FLAGS)
-    elseif(USE_SANITIZER MATCHES "([Ll]eak)")
-      message(STATUS "Building with Leak sanitizer")
-      append("-fsanitize=leak" CMAKE_C_FLAGS CMAKE_CXX_FLAGS)
+    endif()
+
+    if(USE_SANITIZER MATCHES "([Ll]eak)")
+      message(STATUS "Testing with Leak sanitizer")
+      set(SANITIZER_LEAK_FLAG "-fsanitize=leak")
+      test_san_flags(SANITIZER_LEAK_AVAILABLE ${SANITIZER_LEAK_FLAG})
+      if (SANITIZER_LEAK_AVAILABLE)
+        message(STATUS "  Building with Leak sanitizer")
+        append("${SANITIZER_LEAK_FLAG}" SANITIZER_SELECTED_FLAGS)
+      else()
+        message(FATAL_ERROR "Thread sanitizer not available for ${CMAKE_CXX_COMPILER}")
+      endif()
+    endif()
+
+    message(STATUS "Sanitizer flags: ${SANITIZER_SELECTED_FLAGS}")
+    test_san_flags(SANITIZER_SELECTED_COMPATIBLE ${SANITIZER_SELECTED_FLAGS})
+    if (SANITIZER_SELECTED_COMPATIBLE)
+      message(STATUS " Building with ${SANITIZER_SELECTED_FLAGS}")
+      append("${SANITIZER_SELECTED_FLAGS}" CMAKE_C_FLAGS CMAKE_CXX_FLAGS)
     else()
-      message(
-        FATAL_ERROR "Unsupported value of USE_SANITIZER: ${USE_SANITIZER}")
+      message(FATAL_ERROR " Sanitizer flags ${SANITIZER_SELECTED_FLAGS} are not compatible.")
     endif()
   elseif(MSVC)
     if(USE_SANITIZER MATCHES "([Aa]ddress)")