[ASanStableABI][Driver] Stop linking to asan dylib when stable abi is enabled

[thetruestblue]

Summary

This patch enables linking of the static archive when fsanitize-stable-abi is set and stops linking to the asan dylib.

To link to the Address Sanitizer stable abi static library use "-fsanitize=address -fsanitize-stable-abi"

Updates a test with these flags.

rdar://112480890

[rsundahl]

This looks good to me. Thanks for the additional clean-up @thetruestblue.

[wrotki]

Yes, it looks good. I downloaded the patch and ran the test - had some doubts about 'otool -L %t |grep -q "dynamic.dylib"' - but verified with other ASAN tests binaries and convinced myself that it's the right thing to do.

clang/include/clang/Driver/SanitizerArgs.h

class SanitizerArgs {
   std::string MemtagMode;
 
 public:
   /// Parses the sanitizer arguments from an argument list.
   SanitizerArgs(const ToolChain &TC, const llvm::opt::ArgList &Args,
                 bool DiagnoseErrors = true);
 
   bool needsSharedRt() const { return SharedRuntime; }
+  bool needsStableAbi() const { return StableABI; }
 
   bool needsMemProfRt() const { return NeedsMemProfRt; }
   bool needsAsanRt() const { return Sanitizers.has(SanitizerKind::Address); }
   bool needsHwasanRt() const {
     return Sanitizers.has(SanitizerKind::HWAddress);
   }
   bool needsHwasanAliasesRt() const {
     return needsHwasanRt() && HwasanUseAliases;

clang/lib/Driver/ToolChains/Darwin.cpp

if (sanitizer) {
       getDriver().Diag(diag::err_drv_unsupported_static_sanitizer_darwin)
           << sanitizer;
       return;
     }
   }
 
   if (Sanitize.linkRuntimes()) {
     if (Sanitize.needsAsanRt()) {
+      if (Sanitize.needsStableAbi()) {
+        AddLinkSanitizerLibArgs(Args, CmdArgs, "asan_abi", /*shared=*/false);
+      } else {
         assert(Sanitize.needsSharedRt() &&
                "Static sanitizer runtimes not supported");
         AddLinkSanitizerLibArgs(Args, CmdArgs, "asan");
       }
+    }
     if (Sanitize.needsLsanRt())
       AddLinkSanitizerLibArgs(Args, CmdArgs, "lsan");
     if (Sanitize.needsUbsanRt()) {
       assert(Sanitize.needsSharedRt() &&
              "Static sanitizer runtimes not supported");
       AddLinkSanitizerLibArgs(
           Args, CmdArgs,
           Sanitize.requiresMinimalRuntime() ? "ubsan_minimal" : "ubsan");

compiler-rt/test/asan_abi/CMakeLists.txt

 set(ASAN_ABI_LIT_SOURCE_DIR ${CMAKE_CURRENT_SOURCE_DIR})
 set(ASAN_ABI_TESTSUITES)
 
 macro(get_bits_for_arch arch bits)
   if (${arch} MATCHES "arm64|x86_64")
     set(${bits} 64)
   else()
     message(FATAL_ERROR "Unknown target architecture: ${arch}")
   endif()
 endmacro()
 
 set(ASAN_ABI_TEST_DEPS ${SANITIZER_COMMON_LIT_TEST_DEPS})
 if(NOT COMPILER_RT_STANDALONE_BUILD)
   list(APPEND ASAN_ABI_TEST_DEPS asan_abi)
 endif()
-set(ASAN_ABI_DYNAMIC_TEST_DEPS ${ASAN_ABI_TEST_DEPS})
 
 set(ASAN_ABI_TEST_ARCH ${ASAN_ABI_SUPPORTED_ARCH})
 if(APPLE)
   darwin_filter_host_archs(ASAN_ABI_SUPPORTED_ARCH ASAN_ABI_TEST_ARCH)
 endif()
 
 foreach(arch ${ASAN_ABI_TEST_ARCH})
   set(ASAN_ABI_TEST_TARGET_ARCH ${arch})
   set(ASAN_ABI_TEST_APPLE_PLATFORM "osx")
   set(ASAN_ABI_TEST_MIN_DEPLOYMENT_TARGET_FLAG "${DARWIN_osx_MIN_VER_FLAG}")
   string(TOLOWER "-${arch}-${OS_NAME}" ASAN_ABI_TEST_CONFIG_SUFFIX)
   get_bits_for_arch(${arch} ASAN_ABI_TEST_BITS)
   get_test_cc_for_arch(${arch} ASAN_ABI_TEST_TARGET_CC ASAN_ABI_TEST_TARGET_CFLAGS)
-  set(ASAN_ABI_TEST_DYNAMIC True)
 
   string(TOUPPER ${arch} ARCH_UPPER_CASE)
   set(CONFIG_NAME ${ARCH_UPPER_CASE}${OS_NAME}Config)
 
   list(APPEND ASAN_ABI_TESTSUITES ${CMAKE_CURRENT_BINARY_DIR}/${CONFIG_NAME})
   configure_lit_site_cfg(
     ${CMAKE_CURRENT_SOURCE_DIR}/lit.site.cfg.py.in
     ${CMAKE_CURRENT_BINARY_DIR}/${CONFIG_NAME}/lit.site.cfg.py

compiler-rt/test/asan_abi/TestCases/Darwin/llvm_interface_symbols.cpp

 // RUN: %clang_asan_abi -O0 -c -fsanitize-stable-abi -fsanitize=address %s -o %t.o
 // RUN: %clangxx -c %p/../../../../lib/asan_abi/asan_abi.cpp -o asan_abi.o
-// RUN: %clangxx -dead_strip -o %t %t.o %libasan_abi asan_abi.o && %run %t 2>&1
+// RUN: %clangxx -dead_strip -o %t %t.o -fsanitize-stable-abi -fsanitize=address asan_abi.o && %run %t 2>&1
 // RUN: %clangxx -x c++-header -o - -E %p/../../../../lib/asan/asan_interface.inc \
 // RUN: | sed "s/INTERFACE_FUNCTION/\nINTERFACE_FUNCTION/g" > %t.asan_interface.inc
 // RUN: llvm-nm -g %libasan_abi                                   \
 // RUN: | grep " [TU] "                                           \
 // RUN: | grep -o "\(__asan\)[^ ]*"                               \
 // RUN: | grep -v "\(__asan_abi\)[^ ]*"                           \
 // RUN: | sed -e "s/__asan_version_mismatch_check_v[0-9]+/__asan_version_mismatch_check/" \
 // RUN: > %t.exports
 // RUN: sed -e ':a' -e 'N' -e '$!ba'                              \
 // RUN:     -e 's/ //g'                                           \
 // RUN:     -e ':b' -e 's/\n\n/\n/g' -e 'tb'                      \
 // RUN:     -e 's/(\n/(/g'                                        \
 // RUN: %t.asan_interface.inc                                     \
 // RUN: | grep -v -f %p/../../../../lib/asan_abi/asan_abi_tbd.txt \
 // RUN: | grep -e "INTERFACE_\(WEAK_\)\?FUNCTION"                 \
 // RUN: | grep -v "__sanitizer[^ ]*"                              \
 // RUN: | sed -e "s/.*(//" -e "s/).*//" > %t.imports
 // RUN: sort %t.imports | uniq > %t.imports-sorted
 // RUN: sort %t.exports | uniq > %t.exports-sorted
 // RUN: diff %t.imports-sorted %t.exports-sorted
 
+// Ensure that there is no dynamic dylib linked.
+// RUN: otool -L %t | (! grep -q "dynamic.dylib")
+
 // UNSUPPORTED: ios
 
 int main() { return 0; }

compiler-rt/test/asan_abi/TestCases/linkstaticlibrary.cpp

 // RUN: %clang_asan_abi  -O2 -c -fsanitize-stable-abi -fsanitize=address -O0 %s -o %t.o
 // RUN: %clangxx -c %p/../../../lib/asan_abi/asan_abi.cpp -o asan_abi.o
-// RUN: %clangxx -o %t %t.o %libasan_abi asan_abi.o && %run %t 2>&1
+// RUN: %clangxx -o %t %t.o -fsanitize-stable-abi -fsanitize=address asan_abi.o && %run %t 2>&1
 
 int main() { return 0; }

compiler-rt/test/asan_abi/lit.site.cfg.py.in

 @LIT_SITE_CFG_IN_HEADER@
 
 # Tool-specific config options.
 config.name_suffix = "@ASAN_ABI_TEST_CONFIG_SUFFIX@"
 config.target_cflags = "@ASAN_ABI_TEST_TARGET_CFLAGS@"
 config.clang = "@ASAN_ABI_TEST_TARGET_CC@"
 config.bits = "@ASAN_ABI_TEST_BITS@"
 config.arm_thumb = "@COMPILER_RT_ARM_THUMB@"
 config.apple_platform = "@ASAN_ABI_TEST_APPLE_PLATFORM@"
 config.apple_platform_min_deployment_target_flag = "@ASAN_ABI_TEST_MIN_DEPLOYMENT_TARGET_FLAG@"
-config.asan_abi_dynamic = @ASAN_ABI_TEST_DYNAMIC@
 config.target_arch = "@ASAN_ABI_TEST_TARGET_ARCH@"
 
 # Load common config for all compiler-rt lit tests.
 lit_config.load_config(config, "@COMPILER_RT_BINARY_DIR@/test/lit.common.configured")
 
 # Load tool-specific config that would do the real work.
 lit_config.load_config(config, "@ASAN_ABI_LIT_SOURCE_DIR@/lit.cfg.py")