9 #ifdef DEBUG_LOCKCONTENTION
17 #include <condition_variable>
55 #ifdef DEBUG_LOCKORDER
56 template <
typename MutexType>
57 void EnterCritical(
const char* pszName,
const char* pszFile,
int nLine, MutexType*
cs,
bool fTry =
false);
59 void CheckLastCritical(
void*
cs, std::string& lockname,
const char* guardname,
const char* file,
int line);
60 std::string LocksHeld();
61 template <
typename MutexType>
63 template <
typename MutexType>
73 extern bool g_debug_lockorder_abort;
75 template <
typename MutexType>
76 inline void EnterCritical(
const char* pszName,
const char* pszFile,
int nLine, MutexType*
cs,
bool fTry =
false) {}
78 inline void CheckLastCritical(
void*
cs, std::string& lockname,
const char* guardname,
const char* file,
int line) {}
79 template <
typename MutexType>
81 template <
typename MutexType>
91 template <
typename PARENT>
111 return PARENT::try_lock();
143 #define AssertLockHeld(cs) AssertLockHeldInternal(#cs, __FILE__, __LINE__, &cs)
148 #define AssertLockNotHeld(cs) AssertLockNotHeldInline(#cs, __FILE__, __LINE__, &cs)
151 template <
typename MutexType>
155 using Base =
typename MutexType::unique_lock;
157 void Enter(
const char* pszName,
const char* pszFile,
int nLine)
160 #ifdef DEBUG_LOCKCONTENTION
161 if (Base::try_lock())
return;
167 bool TryEnter(
const char* pszName,
const char* pszFile,
int nLine)
170 if (Base::try_lock()) {
181 TryEnter(pszName, pszFile, nLine);
183 Enter(pszName, pszFile, nLine);
188 if (!pmutexIn)
return;
190 *
static_cast<Base*
>(
this) =
Base(*pmutexIn, std::defer_lock);
192 TryEnter(pszName, pszFile, nLine);
194 Enter(pszName, pszFile, nLine);
199 if (Base::owns_lock())
205 return Base::owns_lock();
218 explicit reverse_lock(
UniqueLock& _lock,
const char* _guardname,
const char* _file,
int _line) : lock(_lock), file(_file), line(_line) {
227 EnterCritical(lockname.c_str(), file.c_str(), line, lock.mutex());
244 #define REVERSE_LOCK(g) typename std::decay<decltype(g)>::type::reverse_lock UNIQUE_NAME(revlock)(g, #g, __FILE__, __LINE__)
253 template <
typename MutexType>
255 template <
typename MutexType>
258 #define LOCK(cs) UniqueLock UNIQUE_NAME(criticalblock)(MaybeCheckNotHeld(cs), #cs, __FILE__, __LINE__)
259 #define LOCK2(cs1, cs2) \
260 UniqueLock criticalblock1(MaybeCheckNotHeld(cs1), #cs1, __FILE__, __LINE__); \
261 UniqueLock criticalblock2(MaybeCheckNotHeld(cs2), #cs2, __FILE__, __LINE__)
262 #define TRY_LOCK(cs, name) UniqueLock name(MaybeCheckNotHeld(cs), #cs, __FILE__, __LINE__, true)
263 #define WAIT_LOCK(cs, name) UniqueLock name(MaybeCheckNotHeld(cs), #cs, __FILE__, __LINE__)
265 #define ENTER_CRITICAL_SECTION(cs) \
267 EnterCritical(#cs, __FILE__, __LINE__, &cs); \
271 #define LEAVE_CRITICAL_SECTION(cs) \
273 std::string lockname; \
274 CheckLastCritical((void*)(&cs), lockname, #cs, __FILE__, __LINE__); \
302 #define WITH_LOCK(cs, code) (MaybeCheckNotHeld(cs), [&]() -> decltype(auto) { LOCK(cs); code; }())
316 std::unique_lock<std::mutex> lock(
mutex);
323 std::lock_guard<std::mutex> lock(
mutex);
333 std::lock_guard<std::mutex> lock(
mutex);
394 operator bool()
const
Template mixin that adds -Wthread-safety locking annotations and lock order checking to a subset of t...
std::unique_lock< PARENT > unique_lock
bool try_lock() EXCLUSIVE_TRYLOCK_FUNCTION(true)
void unlock() UNLOCK_FUNCTION()
void lock() EXCLUSIVE_LOCK_FUNCTION()
RAII-style semaphore lock.
CSemaphoreGrant(CSemaphore &sema, bool fTry=false)
void MoveTo(CSemaphoreGrant &grant)
std::condition_variable condition
Different type to mark Mutex at global scope.
An RAII-style reverse lock.
reverse_lock(reverse_lock const &)
reverse_lock(UniqueLock &_lock, const char *_guardname, const char *_file, int _line)
reverse_lock & operator=(reverse_lock const &)
Wrapper around std::unique_lock style lock for MutexType.
~UniqueLock() UNLOCK_FUNCTION()
typename MutexType::unique_lock Base
bool TryEnter(const char *pszName, const char *pszFile, int nLine)
void Enter(const char *pszName, const char *pszFile, int nLine)
UniqueLock(MutexType &mutexIn, const char *pszName, const char *pszFile, int nLine, bool fTry=false) EXCLUSIVE_LOCK_FUNCTION(mutexIn)
UniqueLock(MutexType *pmutexIn, const char *pszName, const char *pszFile, int nLine, bool fTry=false) EXCLUSIVE_LOCK_FUNCTION(pmutexIn)
void AssertLockHeldInternal(const char *pszName, const char *pszFile, int nLine, MutexType *cs) EXCLUSIVE_LOCKS_REQUIRED(cs)
void AssertLockNotHeldInline(const char *name, const char *file, int line, Mutex *cs) EXCLUSIVE_LOCKS_REQUIRED(!cs)
void EnterCritical(const char *pszName, const char *pszFile, int nLine, MutexType *cs, bool fTry=false)
void DeleteLock(void *cs)
Mutex & MaybeCheckNotHeld(Mutex &cs) EXCLUSIVE_LOCKS_REQUIRED(!cs) LOCK_RETURNED(cs)
void CheckLastCritical(void *cs, std::string &lockname, const char *guardname, const char *file, int line)
void AssertLockNotHeldInternal(const char *pszName, const char *pszFile, int nLine, MutexType *cs) LOCKS_EXCLUDED(cs)
#define EXCLUSIVE_LOCKS_REQUIRED(...)
#define EXCLUSIVE_TRYLOCK_FUNCTION(...)
#define LOCKS_EXCLUDED(...)
#define EXCLUSIVE_LOCK_FUNCTION(...)
#define UNLOCK_FUNCTION(...)
#define LOG_TIME_MICROS_WITH_CATEGORY(end_msg, log_category)