mirror of
https://github.com/ClickHouse/ClickHouse.git
synced 2024-12-01 12:01:58 +00:00
5a4f21c50f
- TSA is a static analyzer build by Google which finds race conditions
and deadlocks at compile time.
- It works by associating a shared member variable with a
synchronization primitive that protects it. The compiler can then
check at each access if proper locking happened before. A good
introduction are [0] and [1].
- TSA requires some help by the programmer via annotations. Luckily,
LLVM's libcxx already has annotations for std::mutex, std::lock_guard,
std::shared_mutex and std::scoped_lock. This commit enables them
(--> contrib/libcxx-cmake/CMakeLists.txt).
- Further, this commit adds convenience macros for the low-level
annotations for use in ClickHouse (--> base/defines.h). For
demonstration, they are leveraged in a few places.
- As we compile with "-Wall -Wextra -Weverything", the required compiler
flag "-Wthread-safety-analysis" was already enabled. Negative checks
are an experimental feature of TSA and disabled
(--> cmake/warnings.cmake). Compile times did not increase noticeably.
- TSA is used in a few places with simple locking. I tried TSA also
where locking is more complex. The problem was usually that it is
unclear which data is protected by which lock :-(. But there was
definitely some weird code where locking looked broken. So there is
some potential to find bugs.
*** Limitations of TSA besides the ones listed in [1]:
- The programmer needs to know which lock protects which piece of shared
data. This is not always easy for large classes.
- Two synchronization primitives used in ClickHouse are not annotated in
libcxx:
(1) std::unique_lock: A releaseable lock handle often together with
std::condition_variable, e.g. in solve producer-consumer problems.
(2) std::recursive_mutex: A re-entrant mutex variant. Its usage can be
considered a design flaw + typically it is slower than a standard
mutex. In this commit, one std::recursive_mutex was converted to
std::mutex and annotated with TSA.
- For free-standing functions (e.g. helper functions) which are passed
shared data members, it can be tricky to specify the associated lock.
This is because the annotations use the normal C++ rules for symbol
resolution.
[0] https://clang.llvm.org/docs/ThreadSafetyAnalysis.html
[1] https://static.googleusercontent.com/media/research.google.com/en//pubs/archive/42958.pdf
98 lines
3.3 KiB
CMake
98 lines
3.3 KiB
CMake
include(CheckCXXCompilerFlag)
|
|
|
|
set(LIBCXX_SOURCE_DIR "${ClickHouse_SOURCE_DIR}/contrib/libcxx")
|
|
|
|
set(SRCS
|
|
"${LIBCXX_SOURCE_DIR}/src/algorithm.cpp"
|
|
"${LIBCXX_SOURCE_DIR}/src/any.cpp"
|
|
"${LIBCXX_SOURCE_DIR}/src/atomic.cpp"
|
|
"${LIBCXX_SOURCE_DIR}/src/barrier.cpp"
|
|
"${LIBCXX_SOURCE_DIR}/src/bind.cpp"
|
|
"${LIBCXX_SOURCE_DIR}/src/charconv.cpp"
|
|
"${LIBCXX_SOURCE_DIR}/src/chrono.cpp"
|
|
"${LIBCXX_SOURCE_DIR}/src/condition_variable.cpp"
|
|
"${LIBCXX_SOURCE_DIR}/src/condition_variable_destructor.cpp"
|
|
"${LIBCXX_SOURCE_DIR}/src/debug.cpp"
|
|
"${LIBCXX_SOURCE_DIR}/src/exception.cpp"
|
|
"${LIBCXX_SOURCE_DIR}/src/experimental/memory_resource.cpp"
|
|
"${LIBCXX_SOURCE_DIR}/src/filesystem/directory_iterator.cpp"
|
|
"${LIBCXX_SOURCE_DIR}/src/filesystem/int128_builtins.cpp"
|
|
"${LIBCXX_SOURCE_DIR}/src/filesystem/operations.cpp"
|
|
"${LIBCXX_SOURCE_DIR}/src/format.cpp"
|
|
"${LIBCXX_SOURCE_DIR}/src/functional.cpp"
|
|
"${LIBCXX_SOURCE_DIR}/src/future.cpp"
|
|
"${LIBCXX_SOURCE_DIR}/src/hash.cpp"
|
|
"${LIBCXX_SOURCE_DIR}/src/ios.cpp"
|
|
"${LIBCXX_SOURCE_DIR}/src/ios.instantiations.cpp"
|
|
"${LIBCXX_SOURCE_DIR}/src/iostream.cpp"
|
|
"${LIBCXX_SOURCE_DIR}/src/legacy_pointer_safety.cpp"
|
|
"${LIBCXX_SOURCE_DIR}/src/locale.cpp"
|
|
"${LIBCXX_SOURCE_DIR}/src/memory.cpp"
|
|
"${LIBCXX_SOURCE_DIR}/src/mutex.cpp"
|
|
"${LIBCXX_SOURCE_DIR}/src/mutex_destructor.cpp"
|
|
"${LIBCXX_SOURCE_DIR}/src/new.cpp"
|
|
"${LIBCXX_SOURCE_DIR}/src/optional.cpp"
|
|
"${LIBCXX_SOURCE_DIR}/src/random.cpp"
|
|
"${LIBCXX_SOURCE_DIR}/src/random_shuffle.cpp"
|
|
"${LIBCXX_SOURCE_DIR}/src/regex.cpp"
|
|
"${LIBCXX_SOURCE_DIR}/src/ryu/d2fixed.cpp"
|
|
"${LIBCXX_SOURCE_DIR}/src/ryu/d2s.cpp"
|
|
"${LIBCXX_SOURCE_DIR}/src/ryu/f2s.cpp"
|
|
"${LIBCXX_SOURCE_DIR}/src/shared_mutex.cpp"
|
|
"${LIBCXX_SOURCE_DIR}/src/stdexcept.cpp"
|
|
"${LIBCXX_SOURCE_DIR}/src/string.cpp"
|
|
"${LIBCXX_SOURCE_DIR}/src/strstream.cpp"
|
|
"${LIBCXX_SOURCE_DIR}/src/system_error.cpp"
|
|
"${LIBCXX_SOURCE_DIR}/src/thread.cpp"
|
|
"${LIBCXX_SOURCE_DIR}/src/typeinfo.cpp"
|
|
"${LIBCXX_SOURCE_DIR}/src/utility.cpp"
|
|
"${LIBCXX_SOURCE_DIR}/src/valarray.cpp"
|
|
"${LIBCXX_SOURCE_DIR}/src/variant.cpp"
|
|
"${LIBCXX_SOURCE_DIR}/src/vector.cpp"
|
|
)
|
|
|
|
add_library(cxx ${SRCS})
|
|
set_target_properties(cxx PROPERTIES FOLDER "contrib/libcxx-cmake")
|
|
|
|
target_include_directories(cxx SYSTEM BEFORE PUBLIC
|
|
$<BUILD_INTERFACE:${LIBCXX_SOURCE_DIR}/include>
|
|
$<BUILD_INTERFACE:${LIBCXX_SOURCE_DIR}>/src)
|
|
target_compile_definitions(cxx PRIVATE -D_LIBCPP_BUILDING_LIBRARY -DLIBCXX_BUILDING_LIBCXXABI)
|
|
|
|
# Enable capturing stack traces for all exceptions.
|
|
if (USE_UNWIND)
|
|
target_compile_definitions(cxx PUBLIC -DSTD_EXCEPTION_HAS_STACK_TRACE=1)
|
|
endif ()
|
|
|
|
if (USE_MUSL)
|
|
target_compile_definitions(cxx PUBLIC -D_LIBCPP_HAS_MUSL_LIBC=1)
|
|
endif ()
|
|
|
|
# Override the deduced attribute support that causes error.
|
|
if (OS_DARWIN AND COMPILER_GCC)
|
|
add_compile_definitions(_LIBCPP_INIT_PRIORITY_MAX)
|
|
endif ()
|
|
|
|
target_compile_options(cxx PUBLIC $<$<COMPILE_LANGUAGE:CXX>:-nostdinc++>)
|
|
|
|
# Third party library may have substandard code.
|
|
target_compile_options(cxx PRIVATE -w)
|
|
|
|
# Enable support for Clang-Thread-Safety-Analysis in libcxx
|
|
target_compile_definitions(cxx PUBLIC -D_LIBCPP_ENABLE_THREAD_SAFETY_ANNOTATIONS)
|
|
|
|
target_link_libraries(cxx PUBLIC cxxabi)
|
|
|
|
# For __udivmodti4, __divmodti4.
|
|
if (OS_DARWIN AND COMPILER_GCC)
|
|
target_link_libraries(cxx PRIVATE gcc)
|
|
endif ()
|
|
|
|
install(
|
|
TARGETS cxx
|
|
EXPORT global
|
|
ARCHIVE DESTINATION lib
|
|
RUNTIME DESTINATION lib
|
|
LIBRARY DESTINATION lib
|
|
)
|