Only test sanitizers that are built when COMPILER_RT_SANITIZERS_TO_BUILD is used

[fjricci]

Summary

This allows check-all to be used when only a subset of the sanitizers are built.

[fjricci]

Fix typo

[fjricci]

Actually fix typo

[compnerd]

test/CMakeLists.txt

60–73

Why not just walk COMPILER_RT_SANITIZERS_TO_BUILD rather than doing an intersection for each one?

[fjricci]

test/CMakeLists.txt

60–73

Will address in a follow-up commit for the build case as well as the test case.

[fjricci]

Broke cfi in cases when the cfi runtime isn't built.

[fjricci]

Test cfi even when cfi runtime isn't built

[pcc]

I don't understand why we have this COMPILER_RT_SANITIZERS_TO_BUILD feature, but given that we have it, this seems reasonable to me.

test/CMakeLists.txt

63

I guess if you want this to be controlled by COMPILER_RT_SANITIZERS_TO_BUILD it would need to be calling compiler_rt_test_sanitizer.

72

Probably want to preserve this comment.

[fjricci]

As far as I'm aware, the feature exists both to save time building and testing sanitizers you don't need, and to get around differing build requirements across the sanitizers (it's possible, especially when cross-compiling, that some sanitizers build in a given configuration and others do not).

test/CMakeLists.txt

63

The components built as part of the common runtime aren't controlled by COMPILER_RT_SANITIZERS_TO_BUILD (lsan, ubsan, sanitizer_common, interception, etc).

[fjricci]

Add back cfi comment

[pcc]

In D34644#792470, @fjricci wrote:

As far as I'm aware, the feature exists both to save time building and testing sanitizers you don't need, and to get around differing build requirements across the sanitizers (it's possible, especially when cross-compiling, that some sanitizers build in a given configuration and others do not).

You can achieve that though by choosing not to build the sanitizer runtimes that you don't want when you run "make" or "ninja" or whatever.

But anyway, this seems fine to me. LGTM.

lib/CMakeLists.txt

if(COMPILER_RT_HAS_${runtime_uppercase})
     add_subdirectory(${runtime})
     foreach(directory ${ARGN})
       add_subdirectory(${directory})
     endforeach()
   endif()
 endfunction()
 
 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)

test/CMakeLists.txt

if (WIN32)
       list(APPEND SANITIZER_COMMON_LIT_TEST_DEPS KillTheDoctor)
     endif()
   endif()
   if(CMAKE_HOST_UNIX)
     list(APPEND SANITIZER_COMMON_LIT_TEST_DEPS SanitizerLintCheck)
   endif()
 endif()
 
+function(compiler_rt_test_runtime runtime)
+  string(TOUPPER ${runtime} runtime_uppercase)
+  if(COMPILER_RT_HAS_${runtime_uppercase})
+    add_subdirectory(${runtime})
+  endif()
+endfunction()
+
+function(compiler_rt_test_sanitizer sanitizer)
+  string(TOLOWER ${sanitizer} sanitizer_lowercase)
+  list(FIND COMPILER_RT_SANITIZERS_TO_BUILD ${sanitizer_lowercase} result)
+  if(NOT ${result} EQUAL -1)
+    compiler_rt_test_runtime(${sanitizer})
+  endif()
+endfunction()
+
 # Run sanitizer tests only if we're sure that clang would produce
 # working binaries.
 if(COMPILER_RT_CAN_EXECUTE_TESTS)
   if(COMPILER_RT_BUILD_BUILTINS)
     add_subdirectory(builtins)
   endif()
   if(COMPILER_RT_BUILD_SANITIZERS)
-    if(COMPILER_RT_HAS_ASAN)
-      add_subdirectory(asan)
-    endif()
-    if(COMPILER_RT_HAS_DFSAN)
-      add_subdirectory(dfsan)
-    endif()
-    if (COMPILER_RT_HAS_INTERCEPTION)
-      add_subdirectory(interception)
-    endif()
-    if(COMPILER_RT_HAS_LSAN)
-      add_subdirectory(lsan)
-    endif()
-    if(COMPILER_RT_HAS_MSAN)
-      add_subdirectory(msan)
-    endif()
-    if(COMPILER_RT_HAS_PROFILE)
-      add_subdirectory(profile)
-    endif()
-    if(COMPILER_RT_HAS_SANITIZER_COMMON)
-      add_subdirectory(sanitizer_common)
-    endif()
-    if(COMPILER_RT_HAS_TSAN)
-      add_subdirectory(tsan)
-    endif()
-    if(COMPILER_RT_HAS_UBSAN)
-      add_subdirectory(ubsan)
-    endif()
-    # CFI tests require diagnostic mode, which is implemented in UBSan.
-    if(COMPILER_RT_HAS_UBSAN)
-      add_subdirectory(cfi)
-    endif()
-    if(COMPILER_RT_HAS_SAFESTACK)
-      add_subdirectory(safestack)
-    endif()
-    if(COMPILER_RT_HAS_ESAN)
-      add_subdirectory(esan)
-    endif()
-    if(COMPILER_RT_HAS_SCUDO)
-      add_subdirectory(scudo)
-    endif()
+    compiler_rt_test_runtime(interception)
+
+    compiler_rt_test_runtime(lsan)
+    compiler_rt_test_runtime(ubsan)
+    compiler_rt_test_runtime(sanitizer_common)
+
+    compiler_rt_test_sanitizer(asan)
+    compiler_rt_test_sanitizer(dfsan)
+    compiler_rt_test_sanitizer(msan)
+    compiler_rt_test_sanitizer(tsan)
+    compiler_rt_test_sanitizer(safestack)
+    compiler_rt_test_sanitizer(cfi)
+    compiler_rt_test_sanitizer(esan)
+    compiler_rt_test_sanitizer(scudo)
+
+    compiler_rt_test_runtime(profile)
   endif()
   if(COMPILER_RT_BUILD_XRAY AND COMPILER_RT_HAS_XRAY)
-    add_subdirectory(xray)
+    compiler_rt_test_runtime(xray)
   endif()
 endif()
 
 if(COMPILER_RT_STANDALONE_BUILD)
   # Now that we've traversed all the directories and know all the lit testsuites,
   # introduce a rule to run to run all of them.
   get_property(LLVM_LIT_TESTSUITES GLOBAL PROPERTY LLVM_LIT_TESTSUITES)
   get_property(LLVM_LIT_DEPENDS GLOBAL PROPERTY LLVM_LIT_DEPENDS)