Branch data Line data Source code
1 : : // Copyright (c) 2009-2010 Satoshi Nakamoto
2 : : // Copyright (c) 2009-present 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_SYNC_H
7 : : #define BITCOIN_SYNC_H
8 : :
9 : : #include <threadsafety.h> // IWYU pragma: export
10 : : #include <util/macros.h>
11 : :
12 : : #include <cassert>
13 : : #include <condition_variable>
14 : : #include <mutex>
15 : : #include <string>
16 : : #include <thread>
17 : :
18 : : ////////////////////////////////////////////////
19 : : // //
20 : : // THE SIMPLE DEFINITION, EXCLUDING DEBUG CODE //
21 : : // //
22 : : ////////////////////////////////////////////////
23 : :
24 : : /*
25 : : RecursiveMutex mutex;
26 : : std::recursive_mutex mutex;
27 : :
28 : : LOCK(mutex);
29 : : std::unique_lock<std::recursive_mutex> criticalblock(mutex);
30 : :
31 : : LOCK2(mutex1, mutex2);
32 : : std::unique_lock<std::recursive_mutex> criticalblock1(mutex1);
33 : : std::unique_lock<std::recursive_mutex> criticalblock2(mutex2);
34 : :
35 : : TRY_LOCK(mutex, name);
36 : : std::unique_lock<std::recursive_mutex> name(mutex, std::try_to_lock_t);
37 : : */
38 : :
39 : : ///////////////////////////////
40 : : // //
41 : : // THE ACTUAL IMPLEMENTATION //
42 : : // //
43 : : ///////////////////////////////
44 : :
45 : : #ifdef DEBUG_LOCKORDER
46 : : template <typename MutexType>
47 : : void EnterCritical(const char* pszName, const char* pszFile, int nLine, MutexType* cs, bool fTry = false);
48 : : void LeaveCritical();
49 : : void CheckLastCritical(void* cs, std::string& lockname, const char* guardname, const char* file, int line);
50 : : template <typename MutexType>
51 : : void AssertLockHeldInternal(const char* pszName, const char* pszFile, int nLine, MutexType* cs) EXCLUSIVE_LOCKS_REQUIRED(cs);
52 : : template <typename MutexType>
53 : : void AssertLockNotHeldInternal(const char* pszName, const char* pszFile, int nLine, MutexType* cs) LOCKS_EXCLUDED(cs);
54 : : void DeleteLock(void* cs);
55 : : bool LockStackEmpty();
56 : :
57 : : /**
58 : : * Call abort() if a potential lock order deadlock bug is detected, instead of
59 : : * just logging information and throwing a logic_error. Defaults to true, and
60 : : * set to false in DEBUG_LOCKORDER unit tests.
61 : : */
62 : : extern bool g_debug_lockorder_abort;
63 : : #else
64 : : template <typename MutexType>
65 : 807461 : inline void EnterCritical(const char* pszName, const char* pszFile, int nLine, MutexType* cs, bool fTry = false) {}
66 [ + - + - ]: 85507997 : inline void LeaveCritical() {}
[ + - # # ]
[ + - + -
+ - ][ + -
+ - + - +
- + - ][ #
# # # # #
# # ]
67 : 807461 : inline void CheckLastCritical(void* cs, std::string& lockname, const char* guardname, const char* file, int line) {}
68 : : template <typename MutexType>
69 : 2241145 : inline void AssertLockHeldInternal(const char* pszName, const char* pszFile, int nLine, MutexType* cs) EXCLUSIVE_LOCKS_REQUIRED(cs) {}
70 : : template <typename MutexType>
71 : : void AssertLockNotHeldInternal(const char* pszName, const char* pszFile, int nLine, MutexType* cs) LOCKS_EXCLUDED(cs) {}
72 : 59243 : inline void DeleteLock(void* cs) {}
73 : : inline bool LockStackEmpty() { return true; }
74 : : #endif
75 : :
76 : : /*
77 : : * Called when a mutex fails to lock immediately because it is held by another
78 : : * thread, or spuriously. Responsible for locking the lock before returning.
79 : : */
80 : : #ifdef DEBUG_LOCKCONTENTION
81 : :
82 : : template <typename LockType>
83 : : void ContendedLock(std::string_view name, std::string_view file, int nLine, LockType& lock);
84 : : #endif
85 : :
86 : : /**
87 : : * Template mixin that adds -Wthread-safety locking annotations and lock order
88 : : * checking to a subset of the mutex API.
89 : : */
90 : : template <typename PARENT>
91 [ + - + + ]: 206303 : class LOCKABLE AnnotatedMixin : public PARENT
[ + + ][ + -
+ + + - #
# # # # #
# # # # ]
[ + - + +
+ - + - +
- + - + +
- + ]
92 : : {
93 : : public:
94 : 59243 : ~AnnotatedMixin() {
95 : 59243 : DeleteLock((void*)this);
96 [ + - - - : 50237 : }
- - ]
97 : :
98 : : void lock() EXCLUSIVE_LOCK_FUNCTION()
99 : : {
100 : : PARENT::lock();
101 : : }
102 : :
103 : : void unlock() UNLOCK_FUNCTION()
104 : : {
105 : : PARENT::unlock();
106 : : }
107 : :
108 : : bool try_lock() EXCLUSIVE_TRYLOCK_FUNCTION(true)
109 : : {
110 : : return PARENT::try_lock();
111 : : }
112 : :
113 : : using unique_lock = std::unique_lock<PARENT>;
114 : : #ifdef __clang__
115 : : //! For negative capabilities in the Clang Thread Safety Analysis.
116 : : //! A negative requirement uses the EXCLUSIVE_LOCKS_REQUIRED attribute, in conjunction
117 : : //! with the ! operator, to indicate that a mutex should not be held.
118 : : const AnnotatedMixin& operator!() const { return *this; }
119 : : #endif // __clang__
120 : : };
121 : :
122 : : /**
123 : : * Wrapped mutex: supports recursive locking, but no waiting
124 : : * TODO: We should move away from using the recursive lock by default.
125 : : */
126 : : using RecursiveMutex = AnnotatedMixin<std::recursive_mutex>;
127 : :
128 : : /** Wrapped mutex: supports waiting but not recursive locking */
129 : : using Mutex = AnnotatedMixin<std::mutex>;
130 : :
131 : : /** Different type to mark Mutex at global scope
132 : : *
133 : : * Thread safety analysis can't handle negative assertions about mutexes
134 : : * with global scope well, so mark them with a separate type, and
135 : : * eventually move all the mutexes into classes so they are not globally
136 : : * visible.
137 : : *
138 : : * See: https://github.com/bitcoin/bitcoin/pull/20272#issuecomment-720755781
139 : : */
140 : : class GlobalMutex : public Mutex { };
141 : :
142 : : #define AssertLockHeld(cs) AssertLockHeldInternal(#cs, __FILE__, __LINE__, &cs)
143 : :
144 : 0 : inline void AssertLockNotHeldInline(const char* name, const char* file, int line, Mutex* cs) EXCLUSIVE_LOCKS_REQUIRED(!cs) { AssertLockNotHeldInternal(name, file, line, cs); }
145 : : inline void AssertLockNotHeldInline(const char* name, const char* file, int line, RecursiveMutex* cs) LOCKS_EXCLUDED(cs) { AssertLockNotHeldInternal(name, file, line, cs); }
146 : : inline void AssertLockNotHeldInline(const char* name, const char* file, int line, GlobalMutex* cs) LOCKS_EXCLUDED(cs) { AssertLockNotHeldInternal(name, file, line, cs); }
147 : : #define AssertLockNotHeld(cs) AssertLockNotHeldInline(#cs, __FILE__, __LINE__, &cs)
148 : :
149 : : /** Wrapper around std::unique_lock style lock for MutexType. */
150 : : template <typename MutexType>
151 : : class SCOPED_LOCKABLE UniqueLock : public MutexType::unique_lock
152 : : {
153 : : private:
154 : : using Base = typename MutexType::unique_lock;
155 : :
156 : 109744438 : void Enter(const char* pszName, const char* pszFile, int nLine)
157 : : {
158 : 109744438 : EnterCritical(pszName, pszFile, nLine, Base::mutex());
159 : : #ifdef DEBUG_LOCKCONTENTION
160 : : if (!Base::try_lock()) {
161 : : ContendedLock(pszName, pszFile, nLine, static_cast<Base&>(*this));
162 : : }
163 : : #else
164 [ + - # # ]: 109744438 : Base::lock();
[ # # # # ]
[ + - - -
- - ]
165 : : #endif
166 : 109744438 : }
167 : :
168 : 0 : bool TryEnter(const char* pszName, const char* pszFile, int nLine)
169 : : {
170 : 0 : EnterCritical(pszName, pszFile, nLine, Base::mutex(), true);
171 [ # # # # ]: 0 : if (Base::try_lock()) {
[ # # # # ]
[ # # # #
# # ]
172 : : return true;
173 : : }
174 : : LeaveCritical();
175 : : return false;
176 : : }
177 : :
178 : : public:
179 [ - + ]: 109630975 : UniqueLock(MutexType& mutexIn, const char* pszName, const char* pszFile, int nLine, bool fTry = false) EXCLUSIVE_LOCK_FUNCTION(mutexIn) : Base(mutexIn, std::defer_lock)
180 : : {
181 [ - + ]: 109630975 : if (fTry)
182 : 109630975 : TryEnter(pszName, pszFile, nLine);
183 : : else
184 : 109630975 : Enter(pszName, pszFile, nLine);
185 [ - - ]: 109630975 : }
186 : :
187 : 113463 : UniqueLock(MutexType* pmutexIn, const char* pszName, const char* pszFile, int nLine, bool fTry = false) EXCLUSIVE_LOCK_FUNCTION(pmutexIn)
188 [ + - ]: 113463 : {
189 [ + - ]: 113463 : if (!pmutexIn) return;
190 : :
191 [ - + ]: 113463 : *static_cast<Base*>(this) = Base(*pmutexIn, std::defer_lock);
192 [ - + ]: 113463 : if (fTry)
193 : 113463 : TryEnter(pszName, pszFile, nLine);
194 : : else
195 : 113463 : Enter(pszName, pszFile, nLine);
196 [ - - ]: 0 : }
197 : :
198 : 110551899 : ~UniqueLock() UNLOCK_FUNCTION()
199 : : {
200 [ + - + - : 109744438 : if (Base::owns_lock())
+ - + - +
- - - # #
# # # # #
# # # # #
# # # # ]
[ - - - -
- - - - -
- - - - -
+ - + - -
- - - - -
- - - - -
- - - ][ +
- + - #
# ][ - - +
- + - - -
+ - - - +
- + - - -
# # ][ + -
- - + - -
- + - - -
+ - + - -
- + - + -
+ - + - +
- + - - -
- - - - -
- - - - -
+ - - - +
- - - + -
- - + - -
- + - - -
+ - - - +
- ][ + - -
- + - - -
+ - - - +
- - - + -
- - + - -
- + - - -
+ - - - +
- - - + -
- - + - #
# # # # #
# # # # #
# # # # #
# # # # #
# # # #
# ][ + - +
- + - + -
+ - + - +
- + - + -
+ - ][ + -
+ - + - +
- - - - -
- - - - +
- - - - -
- - - - -
- + - - -
+ - - - +
- - - + -
- - + - -
- + - - -
+ - - - +
- - - + -
- - + - -
- + - -
- ][ + - +
- + - + -
+ - - - -
- - - - -
+ - - - #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # ]
[ + - - -
- - - - +
- + - - -
- - + - +
- + - + -
+ - + - +
- + - + -
+ - - - -
- - - - -
- - - - -
- - - + -
- - + - +
- - - - -
- - + - +
- + - + -
+ - - - -
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
- - - - +
- + - - -
+ - - - -
- + - + -
+ - + - +
- + - + -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - + -
- - + - -
- + - - -
- - + - -
- + - + -
+ - - - +
- - - - -
+ - - - -
- + - + -
- - + - +
- - - - -
- - + - +
- + - + -
- - - - -
- + - - -
+ - - - +
- - - + -
- - + - +
- - - + -
- - + - +
- - - - -
+ - + - +
- + - + -
+ - + - +
- - - - -
- - - - -
- - - - -
- - + - -
- - - - -
- - - - -
- + - + -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - +
- - - + -
- - - - +
- + - + -
- - + - +
- + - + -
+ - + - -
- - - + -
- - - - -
- + - + -
- - - - +
- - - - -
+ - - - +
- + - - -
+ - - - -
- - - - -
- - - - ]
[ + - - -
+ - - - +
- - - - -
- - + - -
- + - - -
+ - - - +
- - - + -
- - + - -
- - - + -
+ - - - #
# # # # #
# # ][ # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # ][ + -
+ - + - -
- + - + -
- - + - +
- + - + -
+ - + - +
- + - - -
+ - - - ]
[ + - + -
+ - - - +
- + - - -
- - + - +
- + - + -
- - + - +
- + - - -
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # ]
[ - - - -
+ - - - +
- - - + -
+ - + - +
- + - - -
+ - - - +
- + - + -
- - + - -
- + - - -
+ - - - -
- - - + -
- - + - +
- - - + -
+ - + - -
- - - - -
- - - - -
- + - - -
+ - + - -
- - - - -
- - - - -
- - - - -
- - - - -
- + - - -
- - - - -
- - - - -
+ - - - +
- - - - -
- - + - +
- - - - -
- - - - -
- - - + -
+ - - - +
- + - - -
- - + - +
- - - + -
- - - - -
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - - -
+ - + - -
- + - + -
+ - - - -
- - - + -
- - + - +
- - - - -
- - - - -
- + - + -
- - + - -
- + - + -
- - + - -
- + - - -
+ - - - +
- - - - -
+ - - - -
- - - + -
- - - - -
- - - - -
- - - - -
- - - -
- ][ + - -
- + - - -
+ - - - +
- - - + -
- - + - -
- + - + -
- - - - +
- - - - -
- - + - -
- + - + -
- - + - -
- + - + -
- - + - -
- + - - -
+ - - - -
- + - - -
+ - - - -
- ][ # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # ][ - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
+ - + - -
- - - + -
- - ][ - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - + - -
- - - - -
- - - - -
- - - + -
- - + - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - ][ +
- - - - -
- - - - -
- + - + -
+ - - - -
- - - + -
- - + - +
- - - + -
- - - - -
- - - + -
+ - - - +
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - ]
[ + - - -
+ - + - -
- + - + -
- - + - -
- + - - -
+ - - - +
- - - + -
+ - + - +
- + - + -
- - - - +
- - - # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# ][ + - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
+ - + - +
- + - + -
- - - - -
- - - - -
- - - - -
- - - + -
- - + - +
- - - + -
+ - + - +
- + - + -
+ - + - -
- + - + -
+ - - - +
- - - + -
+ - - - +
- + - - -
- - - - -
- - - - -
- - + - +
- - - - -
+ - - - +
- - - + -
- - + - +
- + - - -
- - + - -
- + - - -
+ - - - +
- - - + -
+ - - - +
- + - ][ +
- - - + -
- - + - +
- + - - -
+ - - - +
- + - +
- ][ - - -
- + - - -
+ - - - +
- - - # #
# # # # #
# # # # #
# # # # #
# # # ][ +
- - - + -
- - - - -
- - - + -
- - + - -
- + - - -
+ - + - -
- + - + -
- - - - +
- - - - -
- - - - -
- - - # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # #
# ][ + - +
- - - + -
+ - + - +
- + - - -
+ - + - -
- + - + -
- - + - +
- - - + -
- - # # #
# # # # #
# # # # #
# ][ - - -
- - - - -
- - - - +
- - - - -
- - - - -
- - - + -
+ - + - -
- + - - -
- - - - +
- - - + -
- - + - -
- + - + -
+ - + - +
- + - - -
- - - - -
- - - + -
- - - - +
- - - + -
- - + - -
- + - - -
- - - - +
- - - + -
- - + - +
- - - + -
- - + - -
- + - + -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - + -
- - + - +
- + - - -
- - + - -
- + - + -
- - - - -
- - - + -
+ - + - -
- + - - -
- - + - -
- + - - -
+ - - - +
- - - - -
- - - - ]
[ # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # ][ - -
- - + - -
- + - - -
+ - - - -
- - - - -
- - + - -
- - - - -
+ - + - -
- - - - -
+ - - - +
- - - - -
- - - - -
- - - - -
- - - - +
- + - - -
+ - - - +
- - - + -
- - - - +
- - - + -
- - + - -
- + - - -
+ - - - ]
[ - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
+ - - - +
- - - - -
- - - - -
- - - + -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - + - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
+ - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - ][ # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # ]
[ + - - -
+ - - - -
- - - - -
+ - - - +
- - - + -
- - + - -
- - - - -
- - - - -
- + - + -
- - + - -
- + - - -
+ - + - -
- + - + -
- - + - -
- - - - -
+ - - - +
- - - + -
- - + - -
- + - - -
- - - - -
- - - + -
+ - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- ][ # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # ][ + -
+ - + - +
- + - + -
+ - + - +
- - - + -
+ - + - -
- ][ + - ]
[ + - + -
+ - + - +
- # # ][ +
- - - + -
# # # # ]
[ + - + -
+ - + - ]
[ + - + -
- - + - +
- + - +
- ]
201 : : LeaveCritical();
202 [ + - - - : 186996964 : }
+ - + - +
- - - # #
# # # # #
# # # # #
# # # # #
# ][ + - -
- - - - -
+ - + - -
- - - + -
+ - - - +
- - - - -
- - - - -
- ][ + - +
- # # ][ +
- + - + -
+ - + - +
- - - # #
# # # # ]
[ + - - -
+ - + - +
- - - + -
- - + - -
- ][ + - -
- + - - -
+ - - - +
- + - - -
+ - + - +
- + - + -
+ - - - -
- - - - -
- - - - +
- - - + -
- - + - -
- + - - -
+ - - - +
- - - +
- ][ + - -
- + - - -
+ + - - +
- + - + -
+ - + - +
- + - - -
+ - + - +
- + - + -
+ - + - #
# # # # #
# # # # #
# # # # #
# # # # #
# # # #
# ][ + - +
- + - + -
- - - - -
- - - + -
- - - - -
- - - - -
+ - - - +
- - - + -
- - + - -
- + - - -
+ - - - +
- - - + -
- - + - -
- + - - -
+ - - - ]
[ + - - -
+ - + - -
- - - - -
- - - - +
- + - -
- ][ + - -
- - - - -
+ - + - -
- - - - -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + + +
- + - + -
- - - - -
- - - - -
- - - - -
- + - - -
+ - + - -
- - - - -
+ - + - +
- + - + +
+ - + - +
- - - - -
+ - + - +
+ + - + +
+ - + + +
- + + + -
+ - + - +
- + - + -
+ - + - +
- + - - +
+ - + - +
+ + - - -
- - - - +
- + - + -
- - - - +
- - - - -
- - + - +
- + - + -
+ - + - +
- + + + -
+ - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
+ - - - +
- - - + -
- - - - +
- - - + -
+ - + - -
- - - + -
- - - - +
- - - - -
+ - + - +
+ - - + -
+ - - - -
- - - + -
+ - + - +
- + + - -
- - - - +
- - - + -
- - + - -
- + - - -
+ - + - -
- + - - -
+ - + - -
- - - + -
+ - + - +
- + - + +
+ - - + +
- + - + +
+ - + + -
- - - - -
- - - - -
- - - - -
+ - - - -
- - - - -
- - - - +
- + - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - + -
- - + - -
- - - + -
+ - + - -
- + - + -
+ - + - +
+ + - + +
+ - + + -
- - - + -
- - - - -
- + - + -
+ - - - -
- + - - -
- - + - -
- + - + -
- - + - -
- - - - -
- - - - -
- ][ - - -
- + - - -
+ - - - +
- - - - -
- - + - -
- + - - -
+ - - - +
- - - + -
- - + - -
- - - + -
+ - - - #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# ][ # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # ][ +
- + - - -
- - + - +
- - - - -
+ - - - +
- - - - -
+ - - - -
- - - -
- ][ - - -
- - - + -
- - + - +
+ - - + -
+ - + - +
- + - - -
+ - - - +
- + - + -
- - + - -
- + - - -
+ - - - -
- - - + -
- - + - +
- - - + -
+ - + - -
- - - - -
- - - - -
- - - + -
- - + - +
- + - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- + - + -
- - - - -
- - - - -
- - - - +
- - + - -
+ - + + -
- - - - -
+ - - + +
- - - - -
- - - - -
- - - - -
- - + - +
+ + - - -
+ - + - +
- - - - -
+ - + + +
- - - + -
- - - - -
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - - -
+ - + - -
- + - + -
+ - - - -
- - - + -
- - + - +
- - - - -
- - - - -
- - - + -
+ - - - +
- - - + -
+ - - - +
- - - + -
- - + - -
- + - - -
- - + - +
+ - - - -
- - + - -
+ - - - -
- - - - -
- - - - -
- - - - -
- ][ + - -
- + - - -
+ - - - +
- - - + -
- - + - -
- + - + -
- - - - +
- - - - -
- - + - -
- + - + -
- - + - -
- + - + -
- - + - -
- + - - -
+ - - - -
- + - - -
+ - - - -
- # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# ][ # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# ][ - - -
- + - + -
+ - + - +
- - - - -
- - - - -
- + - + -
+ - - - +
- + - - -
+ - + - -
- # # # #
# # # # ]
[ - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - +
- - - - -
- - - - -
- - - - -
+ - - - +
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - -
- ][ + - -
- - - - -
- - - - +
- + - + -
- - - - -
- + - - -
+ - + - -
- + - - -
- - - - -
- + - + -
+ - - - +
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - ]
[ + - + -
+ - + - +
- + - + -
- - + - +
- + - # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # ][ +
- - - + -
+ - - + -
- + - - +
+ - - - +
- - - + -
- - + - -
- + - - -
+ - + - +
- + - + -
+ - - - -
- + - - -
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # ][ +
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - +
- + - + -
+ - + - +
- - - - -
- - - - -
- - - - -
- - - - -
- + - + -
- - + - +
- - - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
- - + - +
- + - - -
+ - - - +
- + - - -
+ - + - +
- - - - -
- - - - -
- - - - -
+ - + - -
- - - - -
+ - - - +
- + - - -
+ - + + -
- + - + -
+ - - - -
- + - - -
+ - - - +
- - - + -
- - + - +
- - - + -
+ - ][ + -
- - + - -
- + - + -
+ - - - +
- - - + -
+ - + - #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# ][ + - +
+ + - - -
+ - + - +
+ + - + -
# # # # #
# # # # #
# # # # #
# # # ][ +
- - - + -
- - - - -
- - - - -
+ - - - +
- - - + -
- - + - +
- - - + -
+ - + + -
- - - + -
- - - - -
- - - - -
- - ][ + -
+ - - - +
- + - + -
+ - + - -
- + - + -
- - + - +
- + - + -
+ - - - +
- - - # #
# # # # #
# # # # #
# # # # ]
[ - - - -
- - - - -
- - - - -
- - + - -
- - - - -
- - - - -
- + - + -
+ - - - +
- - - - -
- - + - -
- + - - -
+ - - - +
- + - + -
+ - + - +
- + - - -
- - - - -
- - - + -
- - - - +
- - - + -
- - + - -
+ - - + -
- - - - -
- + - - -
+ - - - +
- + - - -
+ - - - +
- - - + -
+ - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - + - +
- - - + -
+ + + - +
- - - - -
+ - + - -
- + - - +
+ - - - -
- - - - -
+ - + - +
+ + - + +
- - + - -
- - - + -
- - + - -
- + - - -
+ - - - -
- - - -
- ][ # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # ][ - -
- - + - -
- + - - -
+ - - - -
- - - - -
- - + - -
- - - - -
+ - + - -
- - - - -
+ - - - +
- - - - -
- - - - -
- - - - -
- - - - +
- + - - -
+ - - - +
- - - + -
- - - - +
- - - + -
- - + - -
- + - - -
+ - - - ]
[ - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - + - -
- + - - -
- - - - -
- - - - -
- - + - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - + -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- + - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - ]
[ # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # ]
[ # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# ][ + - -
- + - - -
- - - - -
- + - - -
+ - - - +
- - - + -
- - - - -
- - - - -
- - + - +
- - - + -
- - + - -
- + - + -
- - + - +
- - - + -
- - - - -
- + - - -
+ - - - +
- - - + -
- - + - -
- - - - -
- - - - +
- + - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - -
- - - - ]
[ # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# ][ + - +
- + - - -
- - + - -
- - - + -
+ - - - -
- + - + -
- - ][ # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# ][ + - ]
[ + - + +
+ - + - +
- # # ][ +
- - + + -
# # # # ]
[ + - + -
+ - - - ]
[ + - + -
+ - + - +
- + - + -
+ - + - -
- + - - -
+ - - - ]
203 : :
204 : 0 : operator bool()
205 : : {
206 [ # # ]: 0 : return Base::owns_lock();
[ # # # # ]
207 : : }
208 : :
209 : : protected:
210 : : // needed for reverse_lock
211 : 807461 : UniqueLock() = default;
212 : :
213 : : public:
214 : : /**
215 : : * An RAII-style reverse lock. Unlocks on construction and locks on destruction.
216 : : */
217 : : class SCOPED_LOCKABLE reverse_lock {
218 : : public:
219 [ + - ]: 807461 : explicit reverse_lock(UniqueLock& _lock, const MutexType& mutex, const char* _guardname, const char* _file, int _line) UNLOCK_FUNCTION(mutex) : lock(_lock), file(_file), line(_line) {
220 : : // Ensure that mutex passed back for thread-safety analysis is indeed the original
221 [ - + ]: 807461 : assert(std::addressof(mutex) == lock.mutex());
222 : :
223 [ + - ]: 807461 : CheckLastCritical((void*)lock.mutex(), lockname, _guardname, _file, _line);
224 [ + - ]: 807461 : lock.unlock();
225 : : LeaveCritical();
226 : 807461 : lock.swap(templock);
227 [ - - ]: 807461 : }
228 : :
229 : 807461 : ~reverse_lock() UNLOCK_FUNCTION() {
230 : 807461 : templock.swap(lock);
231 : 807461 : EnterCritical(lockname.c_str(), file.c_str(), line, lock.mutex());
232 : 807461 : lock.lock();
233 [ - + ]: 807461 : }
234 : :
235 : : private:
236 : : reverse_lock(reverse_lock const&);
237 : : reverse_lock& operator=(reverse_lock const&);
238 : :
239 : : UniqueLock& lock;
240 : : UniqueLock templock;
241 : : std::string lockname;
242 : : const std::string file;
243 : : const int line;
244 : : };
245 : : friend class reverse_lock;
246 : : };
247 : :
248 : : // clang's thread-safety analyzer is unable to deal with aliases of mutexes, so
249 : : // it is not possible to use the lock's copy of the mutex for that purpose.
250 : : // Instead, the original mutex needs to be passed back to the reverse_lock for
251 : : // the sake of thread-safety analysis, but it is not actually used otherwise.
252 : : #define REVERSE_LOCK(g, cs) typename std::decay<decltype(g)>::type::reverse_lock UNIQUE_NAME(revlock)(g, cs, #cs, __FILE__, __LINE__)
253 : :
254 : : // When locking a Mutex, require negative capability to ensure the lock
255 : : // is not already held
256 [ + - ]: 64565 : inline Mutex& MaybeCheckNotHeld(Mutex& cs) EXCLUSIVE_LOCKS_REQUIRED(!cs) LOCK_RETURNED(cs) { return cs; }
257 : : inline Mutex* MaybeCheckNotHeld(Mutex* cs) EXCLUSIVE_LOCKS_REQUIRED(!cs) LOCK_RETURNED(cs) { return cs; }
258 : :
259 : : // When locking a GlobalMutex or RecursiveMutex, just check it is not
260 : : // locked in the surrounding scope.
261 : : template <typename MutexType>
262 [ + - ]: 5771 : inline MutexType& MaybeCheckNotHeld(MutexType& m) LOCKS_EXCLUDED(m) LOCK_RETURNED(m) { return m; }
263 : : template <typename MutexType>
264 : : inline MutexType* MaybeCheckNotHeld(MutexType* m) LOCKS_EXCLUDED(m) LOCK_RETURNED(m) { return m; }
265 : :
266 : : #define LOCK(cs) UniqueLock UNIQUE_NAME(criticalblock)(MaybeCheckNotHeld(cs), #cs, __FILE__, __LINE__)
267 : : #define LOCK2(cs1, cs2) \
268 : : UniqueLock criticalblock1(MaybeCheckNotHeld(cs1), #cs1, __FILE__, __LINE__); \
269 : : UniqueLock criticalblock2(MaybeCheckNotHeld(cs2), #cs2, __FILE__, __LINE__)
270 : : #define LOCK_ARGS(cs) MaybeCheckNotHeld(cs), #cs, __FILE__, __LINE__
271 : : #define TRY_LOCK(cs, name) UniqueLock name(LOCK_ARGS(cs), true)
272 : : #define WAIT_LOCK(cs, name) UniqueLock name(LOCK_ARGS(cs))
273 : :
274 : : //! Run code while locking a mutex.
275 : : //!
276 : : //! Examples:
277 : : //!
278 : : //! WITH_LOCK(cs, shared_val = shared_val + 1);
279 : : //!
280 : : //! int val = WITH_LOCK(cs, return shared_val);
281 : : //!
282 : : //! Note:
283 : : //!
284 : : //! Since the return type deduction follows that of decltype(auto), while the
285 : : //! deduced type of:
286 : : //!
287 : : //! WITH_LOCK(cs, int i = 1; return i);
288 : : //!
289 : : //! is int, the deduced type of:
290 : : //!
291 : : //! WITH_LOCK(cs, int j = 1; return (j));
292 : : //!
293 : : //! is &int, a reference to a local variable
294 : : //!
295 : : //! The above is detectable at compile-time with the -Wreturn-local-addr flag in
296 : : //! gcc and the -Wreturn-stack-address flag in clang, both enabled by default.
297 : : #define WITH_LOCK(cs, code) (MaybeCheckNotHeld(cs), [&]() -> decltype(auto) { LOCK(cs); code; }())
298 : :
299 : : #endif // BITCOIN_SYNC_H
|
