mirror of
https://github.com/ClickHouse/ClickHouse.git
synced 2024-12-15 10:52:30 +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
76 lines
1.9 KiB
C++
76 lines
1.9 KiB
C++
#pragma once
|
|
|
|
#include <cstddef>
|
|
#include <cstdint>
|
|
#include <utility>
|
|
#include <mutex>
|
|
#include <string_view>
|
|
#include <vector>
|
|
#include <base/defines.h>
|
|
#include <base/types.h>
|
|
|
|
/** Allows to count number of simultaneously happening error codes.
|
|
* See also Exception.cpp for incrementing part.
|
|
*/
|
|
|
|
namespace DB
|
|
{
|
|
|
|
namespace ErrorCodes
|
|
{
|
|
/// ErrorCode identifier (index in array).
|
|
using ErrorCode = int;
|
|
using Value = size_t;
|
|
using FramePointers = std::vector<void *>;
|
|
|
|
/// Get name of error_code by identifier.
|
|
/// Returns statically allocated string.
|
|
std::string_view getName(ErrorCode error_code);
|
|
/// Get error code value by name.
|
|
///
|
|
/// It has O(N) complexity, but this is not major, since it is used only
|
|
/// for test hints, and it does not worth to keep another structure for
|
|
/// this.
|
|
ErrorCode getErrorCodeByName(std::string_view error_name);
|
|
|
|
struct Error
|
|
{
|
|
/// Number of times Exception with this ErrorCode had been throw.
|
|
Value count = 0;
|
|
/// Time of the last error.
|
|
UInt64 error_time_ms = 0;
|
|
/// Message for the last error.
|
|
std::string message;
|
|
/// Stacktrace for the last error.
|
|
FramePointers trace;
|
|
};
|
|
struct ErrorPair
|
|
{
|
|
Error local;
|
|
Error remote;
|
|
};
|
|
|
|
/// Thread-safe
|
|
struct ErrorPairHolder
|
|
{
|
|
public:
|
|
ErrorPair get();
|
|
void increment(bool remote, const std::string & message, const FramePointers & trace);
|
|
|
|
private:
|
|
ErrorPair value TSA_GUARDED_BY(mutex);
|
|
std::mutex mutex;
|
|
};
|
|
|
|
/// ErrorCode identifier -> current value of error_code.
|
|
extern ErrorPairHolder values[];
|
|
|
|
/// Get index just after last error_code identifier.
|
|
ErrorCode end();
|
|
|
|
/// Add value for specified error_code.
|
|
void increment(ErrorCode error_code, bool remote, const std::string & message, const FramePointers & trace);
|
|
}
|
|
|
|
}
|