[TSan][libdispatch] Enable linking and running of tests on Linux

[yln]

Summary

When COMPILER_RT_INTERCEPT_LIBDISPATCH is ON the TSan runtime library
now has a dependency on the blocks runtime and libdispatch. Make sure we
set all the required linking options.

Also add cmake options for specifying additional library paths to
instruct the linker where to search for libdispatch and the blocks
runtime. This allows us to build TSan runtime with libdispatch support
without installing those libraries into default linker library paths.

CMAKE_TRY_COMPILE_TARGET_TYPE=STATIC_LIBRARY is necessary to avoid
aborting the build due to failing the link step in CMake's
check_c_compiler test.

[yln]

Refactor CMake options. All logic is in one place now.

[yln]

Provide necessary linker flags when compiling tests.

[kubamracek]

This looks fine to me, but I think we need @dvyukov to sign off on this.

[dvyukov]

I don't see any problems (because I don't understand cmake), so I am signing off :)

[beanz]

compiler-rt/trunk/cmake/Modules/AddCompilerRT.cmake

598 ↗

(On Diff #190855)

FYI, this isn't safe to do. CMAKE_TRY_COMPILE_TARGET_TYPE was added in CMake 3.6, and LLVM and Compiler-RT support building with CMake 3.4 and up.

compiler-rt/CMakeLists.txt

 
 option(COMPILER_RT_DEBUG "Build runtimes with full debug info" OFF)
 option(COMPILER_RT_EXTERNALIZE_DEBUGINFO
   "Generate dSYM files and strip executables and libraries (Darwin Only)" OFF)
 # COMPILER_RT_DEBUG_PYBOOL is used by lit.common.configured.in.
 pythonize_bool(COMPILER_RT_DEBUG)
 
 option(COMPILER_RT_INTERCEPT_LIBDISPATCH
-  "Support interception of libdispatch (GCD). Requires '-fblocks'." OFF)
+  "Support interception of libdispatch (GCD). Requires '-fblocks'" OFF)
+option(COMPILER_RT_BLOCKS_RUNTIME_LIBRARY_PATH
+  "Library search path for blocks runtime (-lBlocksRuntime)" "")
+option(COMPILER_RT_LIBDISPATCH_LIBRARY_PATH
+  "Library search path for libdispatch (-ldispatch)" "")
+if (COMPILER_RT_INTERCEPT_LIBDISPATCH)
+  set(COMPILER_RT_INTERCEPT_LIBDISPATCH_CFLAGS -fblocks)
+  set(COMPILER_RT_INTERCEPT_LIBDISPATCH_LINK_FLAGS)
+  append_list_if(COMPILER_RT_BLOCKS_RUNTIME_LIBRARY_PATH -L${COMPILER_RT_BLOCKS_RUNTIME_LIBRARY_PATH}
+      COMPILER_RT_INTERCEPT_LIBDISPATCH_LINK_FLAGS)
+  append_list_if(COMPILER_RT_LIBDISPATCH_LIBRARY_PATH -L${COMPILER_RT_LIBDISPATCH_LIBRARY_PATH}
+      COMPILER_RT_INTERCEPT_LIBDISPATCH_LINK_FLAGS)
+  list(APPEND COMPILER_RT_INTERCEPT_LIBDISPATCH_LINK_FLAGS -lBlocksRuntime -ldispatch)
+endif()
 if (APPLE) # Always enable on Apple platforms.
   set(COMPILER_RT_INTERCEPT_LIBDISPATCH ON)
 endif()
 pythonize_bool(COMPILER_RT_INTERCEPT_LIBDISPATCH)
 
 if(APPLE AND SANITIZER_MIN_OSX_VERSION AND SANITIZER_MIN_OSX_VERSION VERSION_LESS "10.9")
   # Mac OS X prior to 10.9 had problems with exporting symbols from
   # libc++/libc++abi.

compiler-rt/lib/tsan/CMakeLists.txt

elseif(UNIX)
   # Assume Linux
   list(APPEND TSAN_SOURCES
     rtl/tsan_platform_linux.cc
     rtl/tsan_platform_posix.cc)
 endif()
 
 if(COMPILER_RT_INTERCEPT_LIBDISPATCH)
   list(APPEND TSAN_SOURCES rtl/tsan_libdispatch.cc)
-  # Libdispatch support for non-Apple platforms requires '-fblocks'.
-  if (NOT APPLE)
-    list(APPEND TSAN_RTL_CFLAGS "-fblocks")
-  endif()
+  list(APPEND TSAN_RTL_CFLAGS ${COMPILER_RT_INTERCEPT_LIBDISPATCH_CFLAGS})
 endif()
 
 set(TSAN_HEADERS
   rtl/tsan_clock.h
   rtl/tsan_defs.h
   rtl/tsan_dense_alloc.h
   rtl/tsan_fd.h
   rtl/tsan_flags.h
if(COMPILER_RT_LIBCXX_PATH AND
    COMPILER_RT_TEST_COMPILER_ID STREQUAL "Clang" AND
    NOT ANDROID)
   set(libcxx_tsan_deps)
   foreach(arch ${TSAN_SUPPORTED_ARCH})
     get_target_flags_for_arch(${arch} TARGET_CFLAGS)
     set(LIBCXX_PREFIX ${CMAKE_CURRENT_BINARY_DIR}/libcxx_tsan_${arch})
     add_custom_libcxx(libcxx_tsan_${arch} ${LIBCXX_PREFIX}
       DEPS ${TSAN_RUNTIME_LIBRARIES}
-      CFLAGS ${TARGET_CFLAGS} -fsanitize=thread
+      CFLAGS ${TARGET_CFLAGS} -fsanitize=thread ${COMPILER_RT_INTERCEPT_LIBDISPATCH_LINK_FLAGS}
       USE_TOOLCHAIN)
     list(APPEND libcxx_tsan_deps libcxx_tsan_${arch}-build)
   endforeach()
 
   add_custom_target(libcxx_tsan DEPENDS ${libcxx_tsan_deps})
   set_target_properties(libcxx_tsan PROPERTIES FOLDER "Compiler-RT Misc")
 endif()
 
 if(COMPILER_RT_INCLUDE_TESTS)
   add_subdirectory(tests)
 endif()

compiler-rt/lib/tsan/tests/CMakeLists.txt

if(APPLE)
   list(APPEND TSAN_UNITTEST_CFLAGS ${DARWIN_osx_CFLAGS})
 
   list(APPEND LINK_FLAGS ${DARWIN_osx_LINK_FLAGS})
   add_weak_symbols("ubsan" LINK_FLAGS)
   add_weak_symbols("sanitizer_common" LINK_FLAGS)
 else()
   list(APPEND LINK_FLAGS -fsanitize=thread)
   list(APPEND LINK_FLAGS -lm)
+  list(APPEND LINK_FLAGS ${COMPILER_RT_INTERCEPT_LIBDISPATCH_LINK_FLAGS})
 endif()
 
 set(TSAN_RTL_HEADERS)
 foreach (header ${TSAN_HEADERS})
   list(APPEND TSAN_RTL_HEADERS ${CMAKE_CURRENT_SOURCE_DIR}/../${header})
 endforeach()
 
 # add_tsan_unittest(<name>