[CMake] Provide options for toggling on and off various runtime libraries.

[beanz]

Summary

Rather than having to add new "experimental" options each time someone wants to work on bringing a sanitizer to a new platform, this patch makes options for all of them.

The default values for the options are set by the platform checks that would have enabled them, but they can be overridden on or off.

[samsonov]

Can we have smth. like LLVM_TARGETS_TO_BUILD ? I.e. have the one CMake variable which takes semicolon-separated list of sanitizers / configurations to build (which defaults to ALL, which expands to everything supported on a given platform)?

[beanz]

Migrating enabling sanitizers to a semi-colon separated list. "all" defaults to the list of supported sanitizers determined by config-ix.cmake.

[kubamracek]

cmake/config-ix.cmake

637

I think we need to add interception here as well. Otherwise using COMPILER_RT_RUNTIMES_TO_BUILD=asan doesn't build for me.

lib/lsan/CMakeLists.txt

28 ↗

(On Diff #40811)

Can we wrap this in a macro (and use it in ubsan/CMakeLists.txt as well)?

lib/tsan/CMakeLists.txt

178 ↗

(On Diff #40811)

Shouldn't this be just dd instead of tsan/dd?

test/ubsan/CMakeLists.txt

38 ↗

(On Diff #40811)

remove the extra paren

42 ↗

(On Diff #40811)

same here

[beanz]

Updates based on feedback from Kuba.

[samsonov]

Looks reasonable, several comments/nits below.

cmake/Modules/CompilerRTUtils.cmake

81 ↗

(On Diff #41951)

I'm curious, can we make it look more like "check_c_compiler_flag" or "check_symbol_exists"

check_list_contains(list value output)

?

84 ↗

(On Diff #41951)

use True/False instead?

90 ↗

(On Diff #41951)

See note below - probably remove this?

cmake/config-ix.cmake

607

cfi is available not only on Windows, I think lib/cfi is added unconditionally.

626

Please describe what you're doing here.

lib/CMakeLists.txt

12 ↗

(On Diff #41951)

Is it a debug output?

test/CMakeLists.txt

40 ↗

(On Diff #41951)

How do you handle CFI special case here?

test/ubsan/CMakeLists.txt

23 ↗

(On Diff #41951)

I actually think this macro is an overkill, and would prefer literal mentioning of COMPILER_RT_RUNTIMES_TO_BUILD here. Sorry for the nit.

[beanz]

Updated patches coming shortly. One comment below.

lib/CMakeLists.txt

12 ↗

(On Diff #41951)

I intended this to be much like the logging we do in LLVM for adding targets.

I thought this heading should be there because if there are no runtimes following it you know there are no runtimes being included.

[beanz]

Updates based on feedback from samsonov.

[samsonov]

LGTM. Thanks!

test/cfi/CMakeLists.txt

2 ↗

(On Diff #42331)

Copy the comment from test/CMakeLists.txt
\# CFI tests require diagnostic mode, which is implemented in UBSan.

cmake/config-ix.cmake

if(ANDROID)
   set(OS_NAME "Android")
 else()
   set(OS_NAME "${CMAKE_SYSTEM_NAME}")
 endif()
 
 if (SANITIZER_COMMON_SUPPORTED_ARCH AND NOT LLVM_USE_SANITIZER AND
     (OS_NAME MATCHES "Android|Darwin|Linux|FreeBSD" OR
     (OS_NAME MATCHES "Windows" AND MSVC)))
-  set(COMPILER_RT_HAS_SANITIZER_COMMON TRUE)
+  set(COMPILER_RT_HAS_SANITIZER_COMMON_DEFAULT TRUE)
 else()
-  set(COMPILER_RT_HAS_SANITIZER_COMMON FALSE)
+  set(COMPILER_RT_HAS_SANITIZER_COMMON_DEFAULT FALSE)
 endif()
 
+option(COMPILER_RT_HAS_SANITIZER_COMMON
+  "Enable common sanitizer (Defaults based on system support)"
+  ${COMPILER_RT_HAS_SANITIZER_COMMON_DEFAULT})
+
 if (COMPILER_RT_HAS_SANITIZER_COMMON AND
     (NOT OS_NAME MATCHES "Windows" OR CMAKE_SIZEOF_VOID_P EQUAL 4))
-  set(COMPILER_RT_HAS_INTERCEPTION TRUE)
+  set(COMPILER_RT_HAS_INTERCEPTION_DEFAULT TRUE)
 else()
-  set(COMPILER_RT_HAS_INTERCEPTION FALSE)
+  set(COMPILER_RT_HAS_INTERCEPTION_DEFAULT FALSE)
 endif()
 
+option(COMPILER_RT_HAS_INTERCEPTION
+  "Enable interception (Defaults based on system support)"
+  ${COMPILER_RT_HAS_INTERCEPTION_DEFAULT})
+
 if (COMPILER_RT_HAS_SANITIZER_COMMON AND ASAN_SUPPORTED_ARCH AND
     (NOT OS_NAME MATCHES "Windows" OR CMAKE_SIZEOF_VOID_P EQUAL 4))
-  set(COMPILER_RT_HAS_ASAN TRUE)
+  set(COMPILER_RT_HAS_ASAN_DEFAULT TRUE)
 else()
-  set(COMPILER_RT_HAS_ASAN FALSE)
+  set(COMPILER_RT_HAS_ASAN_DEFAULT FALSE)
 endif()
 
+option(COMPILER_RT_HAS_ASAN
+  "Enable address sanitizer (Defaults based on system support)"
+  ${COMPILER_RT_HAS_ASAN_DEFAULT})
+
 if (OS_NAME MATCHES "Linux|FreeBSD|Windows")
-  set(COMPILER_RT_ASAN_HAS_STATIC_RUNTIME TRUE)
+  set(COMPILER_RT_ASAN_HAS_STATIC_RUNTIME_DEFAULT TRUE)
 else()
-  set(COMPILER_RT_ASAN_HAS_STATIC_RUNTIME FALSE)
+  set(COMPILER_RT_ASAN_HAS_STATIC_RUNTIME_DEFAULT FALSE)
 endif()
 
+option(COMPILER_RT_ASAN_HAS_STATIC_RUNTIME
+  "Enable address sanitizer static (Defaults based on system support)"
+  ${COMPILER_RT_ASAN_HAS_STATIC_RUNTIME_DEFAULT})
+
 # TODO: Add builtins support.
 
 if (COMPILER_RT_HAS_SANITIZER_COMMON AND DFSAN_SUPPORTED_ARCH AND
     OS_NAME MATCHES "Linux")
-  set(COMPILER_RT_HAS_DFSAN TRUE)
+  set(COMPILER_RT_HAS_DFSAN_DEFAULT TRUE)
 else()
-  set(COMPILER_RT_HAS_DFSAN FALSE)
+  set(COMPILER_RT_HAS_DFSAN_DEFAULT FALSE)
 endif()
 
+option(COMPILER_RT_HAS_DFSAN
+  "Enable data flow sanitizer (Defaults based on system support)"
+  ${COMPILER_RT_HAS_DFSAN_DEFAULT})
+
 if (COMPILER_RT_HAS_SANITIZER_COMMON AND LSAN_SUPPORTED_ARCH AND
     OS_NAME MATCHES "Linux|FreeBSD")
-  set(COMPILER_RT_HAS_LSAN TRUE)
+  set(COMPILER_RT_HAS_LSAN_DEFAULT TRUE)
 else()
-  set(COMPILER_RT_HAS_LSAN FALSE)
+  set(COMPILER_RT_HAS_LSAN_DEFAULT FALSE)
 endif()
 
+option(COMPILER_RT_HAS_LSAN
+  "Enable leak sanitizer (Defaults based on system support)"
+  ${COMPILER_RT_HAS_LSAN_DEFAULT})
+
 if (COMPILER_RT_HAS_SANITIZER_COMMON AND MSAN_SUPPORTED_ARCH AND
     OS_NAME MATCHES "Linux")
-  set(COMPILER_RT_HAS_MSAN TRUE)
+  set(COMPILER_RT_HAS_MSAN_DEFAULT TRUE)
 else()
-  set(COMPILER_RT_HAS_MSAN FALSE)
+  set(COMPILER_RT_HAS_MSAN_DEFAULT FALSE)
 endif()
 
+option(COMPILER_RT_HAS_MSAN
+  "Enable memory sanitizer (Defaults based on system support)"
+  ${COMPILER_RT_HAS_MSAN_DEFAULT})
+
 if (PROFILE_SUPPORTED_ARCH AND
     OS_NAME MATCHES "Darwin|Linux|FreeBSD")
-  set(COMPILER_RT_HAS_PROFILE TRUE)
+  set(COMPILER_RT_HAS_PROFILE_DEFAULT TRUE)
 else()
-  set(COMPILER_RT_HAS_PROFILE FALSE)
+  set(COMPILER_RT_HAS_PROFILE_DEFAULT FALSE)
 endif()
 
+option(COMPILER_RT_HAS_PROFILE
+  "Enable profile runtime (Defaults based on system support)"
+  ${COMPILER_RT_HAS_PROFILE_DEFAULT})
+
 if (COMPILER_RT_HAS_SANITIZER_COMMON AND TSAN_SUPPORTED_ARCH AND
     OS_NAME MATCHES "Linux|FreeBSD")
-  set(COMPILER_RT_HAS_TSAN TRUE)
+  set(COMPILER_RT_HAS_TSAN_DEFAULT TRUE)
 else()
-  set(COMPILER_RT_HAS_TSAN FALSE)
+  set(COMPILER_RT_HAS_TSAN_DEFAULT FALSE)
 endif()
 
-if(APPLE)
-  option(COMPILER_RT_ENABLE_TSAN_OSX "Enable building TSan for OS X - Experimental" Off)
-  if(COMPILER_RT_ENABLE_TSAN_OSX)
-    set(COMPILER_RT_HAS_TSAN TRUE)
-  endif()
-endif()
+option(COMPILER_RT_HAS_TSAN
+  "Enable thread sanitizer (Defaults based on system support)"
+  ${COMPILER_RT_HAS_TSAN_DEFAULT})
 
 if (COMPILER_RT_HAS_SANITIZER_COMMON AND UBSAN_SUPPORTED_ARCH AND
     OS_NAME MATCHES "Darwin|Linux|FreeBSD|Windows")
-  set(COMPILER_RT_HAS_UBSAN TRUE)
+  set(COMPILER_RT_HAS_UBSAN_DEFAULT TRUE)
 else()
-  set(COMPILER_RT_HAS_UBSAN FALSE)
+  set(COMPILER_RT_HAS_UBSAN_DEFAULT FALSE)
 endif()
 
+option(COMPILER_RT_HAS_UBSAN
+  "Enable undefined behavior sanitizer (Defaults based on system support)"
+  ${COMPILER_RT_HAS_UBSAN_DEFAULT})
+
 # -msse3 flag is not valid for Mips therefore clang gives a warning
 # message with -msse3. But check_c_compiler_flags() checks only for
 # compiler error messages. Therefore COMPILER_RT_HAS_MSSE3_FLAG turns out to be
 # true on Mips, so we make it false here.
 if("${COMPILER_RT_DEFAULT_TARGET_ARCH}" MATCHES "mips")
   set(COMPILER_RT_HAS_MSSE3_FLAG FALSE)
 endif()
 
 if (COMPILER_RT_HAS_SANITIZER_COMMON AND SAFESTACK_SUPPORTED_ARCH AND
     OS_NAME MATCHES "Darwin|Linux|FreeBSD")
-  set(COMPILER_RT_HAS_SAFESTACK TRUE)
+  set(COMPILER_RT_HAS_SAFESTACK_DEFAULT TRUE)
 else()
-  set(COMPILER_RT_HAS_SAFESTACK FALSE)
+  set(COMPILER_RT_HAS_SAFESTACK_DEFAULT FALSE)
 endif()
+
+option(COMPILER_RT_HAS_SAFESTACK
+  "Enable safestack runtime (Defaults based on system support)"
+  ${COMPILER_RT_HAS_SAFESTACK_DEFAULT})
+