9#ifdef DEBUG_LOCKCONTENTION
18#include <condition_variable>
57template <
typename MutexType>
58void EnterCritical(
const char* pszName,
const char* pszFile,
int nLine, MutexType*
cs,
bool fTry =
false);
60void CheckLastCritical(
void*
cs, std::string& lockname,
const char* guardname,
const char* file,
int line);
61template <
typename MutexType>
63template <
typename MutexType>
73extern bool g_debug_lockorder_abort;
75template <
typename MutexType>
76inline void EnterCritical(
const char* pszName,
const char* pszFile,
int nLine, MutexType*
cs,
bool fTry =
false) {}
78inline void CheckLastCritical(
void*
cs, std::string& lockname,
const char* guardname,
const char* file,
int line) {}
79template <
typename MutexType>
81template <
typename MutexType>
91template <
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)
151template <
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();
220 assert(std::addressof(mutex) == lock.mutex());
230 EnterCritical(lockname.c_str(), file.c_str(), line, lock.mutex());
251#define REVERSE_LOCK(g, cs) typename std::decay<decltype(g)>::type::reverse_lock UNIQUE_NAME(revlock)(g, cs, #g, __FILE__, __LINE__)
260template <
typename MutexType>
262template <
typename MutexType>
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))
273#define ENTER_CRITICAL_SECTION(cs) \
275 EnterCritical(#cs, __FILE__, __LINE__, &cs); \
279#define LEAVE_CRITICAL_SECTION(cs) \
281 std::string lockname; \
282 CheckLastCritical((void*)(&cs), lockname, #cs, __FILE__, __LINE__); \
310#define WITH_LOCK(cs, code) (MaybeCheckNotHeld(cs), [&]() -> decltype(auto) { LOCK(cs); code; }())
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()
(Un)serialize a number as raw byte or 2 hexadecimal chars.
Different type to mark Mutex at global scope.
An RAII-style reverse lock.
~reverse_lock() UNLOCK_FUNCTION()
reverse_lock(UniqueLock &_lock, const MutexType &mutex, const char *_guardname, const char *_file, int _line) UNLOCK_FUNCTION(mutex)
reverse_lock(reverse_lock const &)
reverse_lock & operator=(reverse_lock const &)
Wrapper around std::unique_lock style lock for MutexType.
~UniqueLock() UNLOCK_FUNCTION()
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)
void CheckLastCritical(void *cs, std::string &lockname, const char *guardname, const char *file, int line)
Mutex & MaybeCheckNotHeld(Mutex &cs) EXCLUSIVE_LOCKS_REQUIRED(!cs) LOCK_RETURNED(cs)
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)