Copy LLVM's ThreadSanitizer (TSan) library to LDC's libraries like we do for ASan, and set the correct linker flags.

TSan is not supported on Windows.

Author: JohanEngelen

CMakeLists.txt

@@ -763,6 +763,7 @@ if (LDC_INSTALL_LLVM_RUNTIME_LIBS)
 
     if(APPLE)
         copy_compilerrt_lib("darwin/libclang_rt.asan_osx_dynamic.dylib" "libldc_rt.asan.dylib" TRUE)
+        copy_compilerrt_lib("darwin/libclang_rt.tsan_osx_dynamic.dylib" "libldc_rt.tsan.dylib" TRUE)
         copy_compilerrt_lib("darwin/libclang_rt.osx.a"                  "libldc_rt.builtins.a" FALSE)
         copy_compilerrt_lib("darwin/libclang_rt.profile_osx.a"          "libldc_rt.profile.a"  FALSE)
         copy_compilerrt_lib("darwin/libclang_rt.fuzzer_osx.a"           "libldc_rt.fuzzer.a"   FALSE)
@@ -777,6 +778,7 @@ if (LDC_INSTALL_LLVM_RUNTIME_LIBS)
         set(LDC_INSTALL_LLVM_RUNTIME_LIBS_ARCH "x86_64" CACHE STRING "Non-Mac Posix: architecture used as libname suffix for the compiler-rt source libraries, e.g., 'aarch64'.")
 
         copy_compilerrt_lib("${LDC_INSTALL_LLVM_RUNTIME_LIBS_OS}/libclang_rt.asan-${LDC_INSTALL_LLVM_RUNTIME_LIBS_ARCH}.a"       "libldc_rt.asan.a"     FALSE)
+        copy_compilerrt_lib("${LDC_INSTALL_LLVM_RUNTIME_LIBS_OS}/libclang_rt.tsan-${LDC_INSTALL_LLVM_RUNTIME_LIBS_ARCH}.a"       "libldc_rt.tsan.a"     FALSE)
         copy_compilerrt_lib("${LDC_INSTALL_LLVM_RUNTIME_LIBS_OS}/libclang_rt.builtins-${LDC_INSTALL_LLVM_RUNTIME_LIBS_ARCH}.a"   "libldc_rt.builtins.a" FALSE)
         copy_compilerrt_lib("${LDC_INSTALL_LLVM_RUNTIME_LIBS_OS}/libclang_rt.profile-${LDC_INSTALL_LLVM_RUNTIME_LIBS_ARCH}.a"    "libldc_rt.profile.a"  FALSE)
         copy_compilerrt_lib("${LDC_INSTALL_LLVM_RUNTIME_LIBS_OS}/libclang_rt.xray-${LDC_INSTALL_LLVM_RUNTIME_LIBS_ARCH}.a"       "libldc_rt.xray.a"     FALSE)

driver/linker-gcc.cpp

@@ -57,6 +57,7 @@ class ArgsBuilder {
 private:
   virtual void addSanitizers(const llvm::Triple &triple);
   virtual void addASanLinkFlags(const llvm::Triple &triple);
+  virtual void addTSanLinkFlags(const llvm::Triple &triple);
   virtual void addFuzzLinkFlags(const llvm::Triple &triple);
   virtual void addCppStdlibLinkFlags(const llvm::Triple &triple);
   virtual void addProfileRuntimeLinkFlags(const llvm::Triple &triple);
@@ -322,6 +323,47 @@ void ArgsBuilder::addASanLinkFlags(const llvm::Triple &triple) {
   args.push_back("-fsanitize=address");
 }
 
+void ArgsBuilder::addTSanLinkFlags(const llvm::Triple &triple) {
+  // Examples: "libclang_rt.tsan-x86_64.a" or "libclang_rt.tsan-arm.a" and
+  // "libclang_rt.tsan-x86_64.so"
+
+  // TODO: let user choose to link with shared lib.
+  // In case of shared TSan, I think we also need to statically link with
+  // libclang_rt.tsan-preinit-<arch>.a on Linux. On Darwin, the only option is
+  // to use the shared library.
+  bool linkSharedTSan = triple.isOSDarwin();
+  const auto searchPaths =
+      getFullCompilerRTLibPathCandidates("tsan", triple, linkSharedTSan);
+
+  for (const auto &filepath : searchPaths) {
+    IF_LOG Logger::println("Searching TSan lib: %s", filepath.c_str());
+
+    if (llvm::sys::fs::exists(filepath) &&
+        !llvm::sys::fs::is_directory(filepath)) {
+      IF_LOG Logger::println("Found, linking with %s", filepath.c_str());
+      args.push_back(filepath);
+
+      if (linkSharedTSan) {
+        // Add @executable_path to rpath to support having the shared lib copied
+        // with the executable.
+        args.push_back("-rpath");
+        args.push_back("@executable_path");
+
+        // Add the path to the resource dir to rpath to support using the shared
+        // lib from the default location without copying.
+        args.push_back("-rpath");
+        args.push_back(std::string(llvm::sys::path::parent_path(filepath)));
+      }
+
+      return;
+    }
+  }
+
+  // When we reach here, we did not find the TSan library.
+  // Fallback, requires Clang.
+  args.push_back("-fsanitize=thread");
+}
+
 // Adds all required link flags for -fsanitize=fuzzer when libFuzzer library is
 // found.
 void ArgsBuilder::addFuzzLinkFlags(const llvm::Triple &triple) {
@@ -459,10 +501,8 @@ void ArgsBuilder::addSanitizers(const llvm::Triple &triple) {
     args.push_back("-fsanitize=memory");
   }
 
-  // TODO: instead of this, we should link with our own sanitizer libraries
-  // because LDC's LLVM version could be different from the system clang.
   if (opts::isSanitizerEnabled(opts::ThreadSanitizer)) {
-    args.push_back("-fsanitize=thread");
+    addTSanLinkFlags(triple);
   }
 }
 

tests/sanitizers/fsanitize_thread.d

@@ -1,10 +1,19 @@
 // Test basic ThreadSanitizer functionality
 
+// REQUIRES: TSan
+
 // RUN: %ldc -c -output-ll -g -fsanitize=thread -of=%t.ll %s && FileCheck %s < %t.ll
 
+// RUN: %ldc -fsanitize=thread %s -of=%t%exe
+// RUN: %t%exe
+
 // CHECK-LABEL: define {{.*}}D16fsanitize_thread3foo
 int foo(int i) {
     // CHECK: call {{.*}}_tsan_func_entry
     return i + 1;
     // CHECK: ret i
 }
+
+void main() {
+    foo(0);
+}

tests/sanitizers/lit.local.cfg

@@ -11,6 +11,10 @@ if (platform.system() == 'Darwin') or (platform.system() == 'Linux'):
         if m is not None:
             config.available_features.add('ASan')
             continue
+        m = re.match('.*tsan.*', file)
+        if m is not None:
+            config.available_features.add('TSan')
+            continue
         m = re.match('.*(F|f)uzzer.*', file)
         if m is not None:
             config.available_features.add('Fuzzer')