Bitcoin Core  0.20.99
P2P Digital Currency
threadsafety.h
Go to the documentation of this file.
1 // Copyright (c) 2009-2010 Satoshi Nakamoto
2 // Copyright (c) 2009-2019 The Bitcoin Core developers
3 // Distributed under the MIT software license, see the accompanying
4 // file COPYING or http://www.opensource.org/licenses/mit-license.php.
5 
6 #ifndef BITCOIN_THREADSAFETY_H
7 #define BITCOIN_THREADSAFETY_H
8 
9 #include <mutex>
10 
11 #ifdef __clang__
12 // TL;DR Add GUARDED_BY(mutex) to member variables. The others are
13 // rarely necessary. Ex: int nFoo GUARDED_BY(cs_foo);
14 //
15 // See https://clang.llvm.org/docs/ThreadSafetyAnalysis.html
16 // for documentation. The clang compiler can do advanced static analysis
17 // of locking when given the -Wthread-safety option.
18 #define LOCKABLE __attribute__((lockable))
19 #define SCOPED_LOCKABLE __attribute__((scoped_lockable))
20 #define GUARDED_BY(x) __attribute__((guarded_by(x)))
21 #define GUARDED_VAR __attribute__((guarded_var))
22 #define PT_GUARDED_BY(x) __attribute__((pt_guarded_by(x)))
23 #define PT_GUARDED_VAR __attribute__((pt_guarded_var))
24 #define ACQUIRED_AFTER(...) __attribute__((acquired_after(__VA_ARGS__)))
25 #define ACQUIRED_BEFORE(...) __attribute__((acquired_before(__VA_ARGS__)))
26 #define EXCLUSIVE_LOCK_FUNCTION(...) __attribute__((exclusive_lock_function(__VA_ARGS__)))
27 #define SHARED_LOCK_FUNCTION(...) __attribute__((shared_lock_function(__VA_ARGS__)))
28 #define EXCLUSIVE_TRYLOCK_FUNCTION(...) __attribute__((exclusive_trylock_function(__VA_ARGS__)))
29 #define SHARED_TRYLOCK_FUNCTION(...) __attribute__((shared_trylock_function(__VA_ARGS__)))
30 #define UNLOCK_FUNCTION(...) __attribute__((unlock_function(__VA_ARGS__)))
31 #define LOCK_RETURNED(x) __attribute__((lock_returned(x)))
32 #define LOCKS_EXCLUDED(...) __attribute__((locks_excluded(__VA_ARGS__)))
33 #define EXCLUSIVE_LOCKS_REQUIRED(...) __attribute__((exclusive_locks_required(__VA_ARGS__)))
34 #define SHARED_LOCKS_REQUIRED(...) __attribute__((shared_locks_required(__VA_ARGS__)))
35 #define NO_THREAD_SAFETY_ANALYSIS __attribute__((no_thread_safety_analysis))
36 #define ASSERT_EXCLUSIVE_LOCK(...) __attribute((assert_exclusive_lock(__VA_ARGS__)))
37 #else
38 #define LOCKABLE
39 #define SCOPED_LOCKABLE
40 #define GUARDED_BY(x)
41 #define GUARDED_VAR
42 #define PT_GUARDED_BY(x)
43 #define PT_GUARDED_VAR
44 #define ACQUIRED_AFTER(...)
45 #define ACQUIRED_BEFORE(...)
46 #define EXCLUSIVE_LOCK_FUNCTION(...)
47 #define SHARED_LOCK_FUNCTION(...)
48 #define EXCLUSIVE_TRYLOCK_FUNCTION(...)
49 #define SHARED_TRYLOCK_FUNCTION(...)
50 #define UNLOCK_FUNCTION(...)
51 #define LOCK_RETURNED(x)
52 #define LOCKS_EXCLUDED(...)
53 #define EXCLUSIVE_LOCKS_REQUIRED(...)
54 #define SHARED_LOCKS_REQUIRED(...)
55 #define NO_THREAD_SAFETY_ANALYSIS
56 #define ASSERT_EXCLUSIVE_LOCK(...)
57 #endif // __GNUC__
58 
59 // StdMutex provides an annotated version of std::mutex for us,
60 // and should only be used when sync.h Mutex/LOCK/etc are not usable.
61 class LOCKABLE StdMutex : public std::mutex
62 {
63 };
64 
65 // StdLockGuard provides an annotated version of std::lock_guard for us,
66 // and should only be used when sync.h Mutex/LOCK/etc are not usable.
67 class SCOPED_LOCKABLE StdLockGuard : public std::lock_guard<StdMutex>
68 {
69 public:
70  explicit StdLockGuard(StdMutex& cs) EXCLUSIVE_LOCK_FUNCTION(cs) : std::lock_guard<StdMutex>(cs) {}
72 };
73 
74 #endif // BITCOIN_THREADSAFETY_H
#define EXCLUSIVE_LOCK_FUNCTION(...)
Definition: threadsafety.h:46
static void pool cs
~StdLockGuard() UNLOCK_FUNCTION()
Definition: threadsafety.h:71
#define UNLOCK_FUNCTION(...)
Definition: threadsafety.h:50
#define LOCKABLE
Definition: threadsafety.h:38
StdLockGuard(StdMutex &cs) EXCLUSIVE_LOCK_FUNCTION(cs)
Definition: threadsafety.h:70
#define SCOPED_LOCKABLE
Definition: threadsafety.h:39