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