[compiler-rt] [cmake] Respect COMPILER_RT_BUILD_* for libs, headers and tests

[mgorny]

Summary

Refactor the code to respect COMPILER_RT_BUILD_SANITIZERS and COMPILER_RT_BUILD_XRAY consistently for libraries, headers and tests. In order to achieve that, factor those variables in when setting COMPILER_RT_* in config-ix.cmake. This makes the COMPILER_RT_* variables suitable for determining both whether to build libraries and whether to run tests.

Add a new set of conditionals to include/CMakeLists.txt to prevent installing xray and sanitizer headers when XRay is disabled or sanitizers are disabled or unsupported appropriately.

Update the conditionals in lib/CMakeLists.txt appropriately to remove unnecessary double-use of COMPILER_RT_BUILD_* variables when COMPILER_RT_HAS_* already controls the particular component.

Fix sanitizer_common tests to respect COMPILER_RT_HAS_* when determining which tools are supported.

[mgorny]

Updated to control installing headers as well.

[mgorny]

Rebased. Ping. Now that we have lit tests for builtins, it would be really useful for us to be able to build them without having to enable sanitizers.

[jroelofs]

test/sanitizer_common/CMakeLists.txt

7–8

Are the CMAKE_SYSTEM_NAME_MATCHES guards here necessary any more, now that the checks are happening in config-ix.cmake?

[mgorny]

test/sanitizer_common/CMakeLists.txt

7–8

ASAN doesn't have any system guard in config-ix.cmake, and the other guards are different (narrower) than those in config-ix. I think those restrictions might be like that on purpose, so if I were to drop them, I'd rather do it in separate patch. @samsonov?

[mgorny]

Needed to rebase again.

[weimingz]

Looks good to me but I'm not very familiar with the build of sanitizer and xray.

[compnerd]

cmake/config-ix.cmake

438–441

What does this really leave in terms of targets which the sanitizer supports but doesn't have the common library?

562

Seems like it might be a good time to hoist the OS checks and add a COMPILER_RT_*_SUPPORTED macro (e.g. COMPILER_RT_XRAY_SUPPORTED).

lib/CMakeLists.txt

60

Im not sure I understand the comment. This looks like it may prevent disabling X-ray?

[mgorny]

cmake/config-ix.cmake

438–441

I'm not sure if I understand your question correctly. If it's about the platform logic, I don't know what it is about and I think it's a bit out of scope of this change. My goal is to merely disable sanitizer-related stuff when sanitizers are not built.

562

Sounds like material for a separate patch to me.

lib/CMakeLists.txt

60

The comment was supposed to indicate that we don't need if(COMPILER_RT_BUILD_XRAY) here because it is already included in COMPILER_RT_HAS_... value.

[mgorny]

D31864 covered all that was needed for Gentoo, and I lack the knowledge to push the full split properly forward.

cmake/config-ix.cmake

else()
   set(OS_NAME "${CMAKE_SYSTEM_NAME}")
 endif()
 
 set(ALL_SANITIZERS asan;dfsan;msan;tsan;safestack;cfi;esan;scudo)
 set(COMPILER_RT_SANITIZERS_TO_BUILD ${ALL_SANITIZERS} CACHE STRING
     "sanitizers to build if supported on the target (all;${ALL_SANITIZERS})")
 list_replace(COMPILER_RT_SANITIZERS_TO_BUILD all "${ALL_SANITIZERS}")
 
 if (SANITIZER_COMMON_SUPPORTED_ARCH AND NOT LLVM_USE_SANITIZER AND
+    (COMPILER_RT_BUILD_SANITIZERS OR COMPILER_RT_BUILD_XRAY) AND
     (OS_NAME MATCHES "Android|Darwin|Linux|FreeBSD" OR
     (OS_NAME MATCHES "Windows" AND (NOT MINGW AND NOT CYGWIN))))
   set(COMPILER_RT_HAS_SANITIZER_COMMON TRUE)
 else()
   set(COMPILER_RT_HAS_SANITIZER_COMMON FALSE)
 endif()
 
-if (COMPILER_RT_HAS_SANITIZER_COMMON)
+if (COMPILER_RT_HAS_SANITIZER_COMMON AND
+    COMPILER_RT_BUILD_SANITIZERS)
   set(COMPILER_RT_HAS_INTERCEPTION TRUE)
 else()
   set(COMPILER_RT_HAS_INTERCEPTION FALSE)
 endif()
 
-if (COMPILER_RT_HAS_SANITIZER_COMMON AND ASAN_SUPPORTED_ARCH)
+if (COMPILER_RT_HAS_SANITIZER_COMMON AND ASAN_SUPPORTED_ARCH AND
+    COMPILER_RT_BUILD_SANITIZERS)
   set(COMPILER_RT_HAS_ASAN TRUE)
 else()
   set(COMPILER_RT_HAS_ASAN FALSE)
 endif()
 
 if (OS_NAME MATCHES "Linux|FreeBSD|Windows")
   set(COMPILER_RT_ASAN_HAS_STATIC_RUNTIME TRUE)
 else()
   set(COMPILER_RT_ASAN_HAS_STATIC_RUNTIME FALSE)
 endif()
 
 # TODO: Add builtins support.
 
 if (COMPILER_RT_HAS_SANITIZER_COMMON AND DFSAN_SUPPORTED_ARCH AND
+    COMPILER_RT_BUILD_SANITIZERS AND
     OS_NAME MATCHES "Linux")
   set(COMPILER_RT_HAS_DFSAN TRUE)
 else()
   set(COMPILER_RT_HAS_DFSAN FALSE)
 endif()
 
 if (COMPILER_RT_HAS_SANITIZER_COMMON AND LSAN_SUPPORTED_ARCH AND
+    COMPILER_RT_BUILD_SANITIZERS AND
     OS_NAME MATCHES "Linux|FreeBSD")
   set(COMPILER_RT_HAS_LSAN TRUE)
 else()
   set(COMPILER_RT_HAS_LSAN FALSE)
 endif()
 
 if(APPLE)
   option(COMPILER_RT_ENABLE_LSAN_OSX "Enable building LSan for OS X - Experimental" Off)
   if(COMPILER_RT_ENABLE_LSAN_OSX)
     set(COMPILER_RT_HAS_LSAN TRUE)
   endif()
 endif()
 
 if (COMPILER_RT_HAS_SANITIZER_COMMON AND MSAN_SUPPORTED_ARCH AND
+    COMPILER_RT_BUILD_SANITIZERS AND
     OS_NAME MATCHES "Linux")
   set(COMPILER_RT_HAS_MSAN TRUE)
 else()
   set(COMPILER_RT_HAS_MSAN FALSE)
 endif()
 
 if (PROFILE_SUPPORTED_ARCH AND NOT LLVM_USE_SANITIZER AND
+    COMPILER_RT_BUILD_SANITIZERS AND
     OS_NAME MATCHES "Darwin|Linux|FreeBSD|Windows|Android")
   set(COMPILER_RT_HAS_PROFILE TRUE)
 else()
   set(COMPILER_RT_HAS_PROFILE FALSE)
 endif()
 
 if (COMPILER_RT_HAS_SANITIZER_COMMON AND TSAN_SUPPORTED_ARCH AND
+    COMPILER_RT_BUILD_SANITIZERS AND
     OS_NAME MATCHES "Darwin|Linux|FreeBSD|Android")
   set(COMPILER_RT_HAS_TSAN TRUE)
 else()
   set(COMPILER_RT_HAS_TSAN FALSE)
 endif()
 
 if (COMPILER_RT_HAS_SANITIZER_COMMON AND UBSAN_SUPPORTED_ARCH AND
+    COMPILER_RT_BUILD_SANITIZERS AND
     OS_NAME MATCHES "Darwin|Linux|FreeBSD|Windows|Android")
   set(COMPILER_RT_HAS_UBSAN TRUE)
 else()
   set(COMPILER_RT_HAS_UBSAN FALSE)
 endif()
 
 if (COMPILER_RT_HAS_SANITIZER_COMMON AND SAFESTACK_SUPPORTED_ARCH AND
+    COMPILER_RT_BUILD_SANITIZERS AND
     OS_NAME MATCHES "Darwin|Linux|FreeBSD")
   set(COMPILER_RT_HAS_SAFESTACK TRUE)
 else()
   set(COMPILER_RT_HAS_SAFESTACK FALSE)
 endif()
 
 if (COMPILER_RT_HAS_SANITIZER_COMMON AND CFI_SUPPORTED_ARCH AND
+    COMPILER_RT_BUILD_SANITIZERS AND
     OS_NAME MATCHES "Linux")
   set(COMPILER_RT_HAS_CFI TRUE)
 else()
   set(COMPILER_RT_HAS_CFI FALSE)
 endif()
 
 if (COMPILER_RT_HAS_SANITIZER_COMMON AND ESAN_SUPPORTED_ARCH AND
+    COMPILER_RT_BUILD_SANITIZERS AND
     OS_NAME MATCHES "Linux")
   set(COMPILER_RT_HAS_ESAN TRUE)
 else()
   set(COMPILER_RT_HAS_ESAN FALSE)
 endif()
 
 if (COMPILER_RT_HAS_SANITIZER_COMMON AND SCUDO_SUPPORTED_ARCH AND
+    COMPILER_RT_BUILD_SANITIZERS AND
     OS_NAME MATCHES "Linux")
   set(COMPILER_RT_HAS_SCUDO TRUE)
 else()
   set(COMPILER_RT_HAS_SCUDO FALSE)
 endif()
 
 if (COMPILER_RT_HAS_SANITIZER_COMMON AND XRAY_SUPPORTED_ARCH AND
+    COMPILER_RT_BUILD_XRAY AND
     OS_NAME MATCHES "Linux")
   set(COMPILER_RT_HAS_XRAY TRUE)
 else()
   set(COMPILER_RT_HAS_XRAY FALSE)
 endif()

include/CMakeLists.txt

-set(SANITIZER_HEADERS
+set(SANITIZER_HEADERS)
+if(COMPILER_RT_HAS_SANITIZER_COMMON)
+  list(APPEND SANITIZER_HEADERS
        sanitizer/allocator_interface.h
-  sanitizer/asan_interface.h
        sanitizer/common_interface_defs.h
        sanitizer/coverage_interface.h
-  sanitizer/dfsan_interface.h
-  sanitizer/esan_interface.h
-  sanitizer/linux_syscall_hooks.h
-  sanitizer/lsan_interface.h
-  sanitizer/msan_interface.h
+       sanitizer/linux_syscall_hooks.h)
+endif()
+if(COMPILER_RT_HAS_ASAN)
+  list(APPEND SANITIZER_HEADERS
+       sanitizer/asan_interface.h)
+endif()
+if(COMPILER_RT_HAS_DFSAN)
+  list(APPEND SANITIZER_HEADERS
+       sanitizer/dfsan_interface.h)
+endif()
+if(COMPILER_RT_HAS_ESAN)
+  list(APPEND SANITIZER_HEADERS
+       sanitizer/esan_interface.h)
+endif()
+if(COMPILER_RT_HAS_LSAN)
+  list(APPEND SANITIZER_HEADERS
+       sanitizer/lsan_interface.h)
+endif()
+if(COMPILER_RT_HAS_MSAN)
+  list(APPEND SANITIZER_HEADERS
+       sanitizer/msan_interface.h)
+endif()
+if(COMPILER_RT_HAS_TSAN)
+  list(APPEND SANITIZER_HEADERS
        sanitizer/tsan_interface.h
        sanitizer/tsan_interface_atomic.h)
+endif()
 
-set(XRAY_HEADERS
+set(XRAY_HEADERS)
+if(COMPILER_RT_BUILD_XRAY)
+  list(APPEND XRAY_HEADERS
        xray/xray_interface.h
        xray/xray_log_interface.h)
+endif()
 
 set(COMPILER_RT_HEADERS
   ${SANITIZER_HEADERS}
   ${XRAY_HEADERS})
 
 set(output_dir ${COMPILER_RT_OUTPUT_DIR}/include)
 
 # Copy compiler-rt headers to the build tree.

lib/CMakeLists.txt

 # First, add the subdirectories which contain feature-based runtime libraries
 # and several convenience helper libraries.
 
 include(AddCompilerRT)
 include(SanitizerUtils)
 
 # Hoist the building of sanitizer_common on whether we're building either the
 # sanitizers or xray (or both).
 #
 #TODO: Refactor sanitizer_common into smaller pieces (e.g. flag parsing, utils).
-if (COMPILER_RT_HAS_SANITIZER_COMMON AND
-    (COMPILER_RT_BUILD_SANITIZERS OR COMPILER_RT_BUILD_XRAY))
+if (COMPILER_RT_HAS_SANITIZER_COMMON)
   add_subdirectory(sanitizer_common)
 endif()
 
 if(COMPILER_RT_BUILD_BUILTINS)
   add_subdirectory(builtins)
 endif()
 
 function(compiler_rt_build_runtime runtime)
function(compiler_rt_build_sanitizer sanitizer)
   string(TOUPPER ${sanitizer} sanitizer_uppercase)
   string(TOLOWER ${sanitizer} sanitizer_lowercase)
   list(FIND COMPILER_RT_SANITIZERS_TO_BUILD ${sanitizer_lowercase} result)
   if(NOT ${result} EQUAL -1)
     compiler_rt_build_runtime(${sanitizer} ${ARGN})
   endif()
 endfunction()
 
-if(COMPILER_RT_BUILD_SANITIZERS)
-  compiler_rt_build_runtime(interception)
+# the following set is conditional to COMPILER_RT_BUILD_SANITIZERS
+# (via COMPILER_RT_HAS_* in config-ix.cmake)
 
-  if(COMPILER_RT_HAS_SANITIZER_COMMON)
-    add_subdirectory(stats)
-    add_subdirectory(lsan)
-    add_subdirectory(ubsan)
-  endif()
+if(COMPILER_RT_BUILD_SANITIZERS AND COMPILER_RT_HAS_SANITIZER_COMMON)
 
-  compiler_rt_build_sanitizer(asan)
-  compiler_rt_build_sanitizer(dfsan)
-  compiler_rt_build_sanitizer(msan)
-  compiler_rt_build_sanitizer(tsan tsan/dd)
-  compiler_rt_build_sanitizer(safestack)
-  compiler_rt_build_sanitizer(cfi)
-  compiler_rt_build_sanitizer(esan)
-  compiler_rt_build_sanitizer(scudo)
 
-  compiler_rt_build_runtime(profile)
-endif()
 
-if(COMPILER_RT_BUILD_XRAY)
-  compiler_rt_build_runtime(xray)
-endif()
+# the following set is conditional to COMPILER_RT_BUILD_XRAY
+# (via COMPILER_RT_HAS_* in config-ix.cmake)

test/sanitizer_common/CMakeLists.txt

 set(SANITIZER_COMMON_LIT_SOURCE_DIR ${CMAKE_CURRENT_SOURCE_DIR})
 
 set(SANITIZER_COMMON_TEST_DEPS ${SANITIZER_COMMON_LIT_TEST_DEPS})
 set(SANITIZER_COMMON_TESTSUITES)
 
 set(SUPPORTED_TOOLS)
-if(CMAKE_SYSTEM_NAME MATCHES "Darwin|Linux|FreeBSD" AND NOT ANDROID)
+if(CMAKE_SYSTEM_NAME MATCHES "Darwin|Linux|FreeBSD" AND NOT ANDROID AND
+   COMPILER_RT_HAS_ASAN)
   list(APPEND SUPPORTED_TOOLS asan)
 endif()
 if(CMAKE_SYSTEM_NAME MATCHES "Linux" AND NOT ANDROID)
+  if(COMPILER_RT_HAS_TSAN)
     list(APPEND SUPPORTED_TOOLS tsan)
+  endif()
+  if(COMPILER_RT_HAS_MSAN)
     list(APPEND SUPPORTED_TOOLS msan)
+  endif()
+  if(COMPILER_RT_HAS_LSAN)
     list(APPEND SUPPORTED_TOOLS lsan)
   endif()
+endif()
 
 # Create a separate config for each tool we support.
 foreach(tool ${SUPPORTED_TOOLS})
   string(TOUPPER ${tool} tool_toupper)
   if(${tool_toupper}_SUPPORTED_ARCH AND NOT COMPILER_RT_STANDALONE_BUILD)
     list(APPEND SANITIZER_COMMON_TEST_DEPS ${tool})
   endif()
   set(TEST_ARCH ${${tool_toupper}_SUPPORTED_ARCH})