path: root/src/OSSupport/CriticalSection.h

#pragma once
#include <mutex>
#include <thread>





class cCriticalSection
{
public:
	void Lock(void);
	void Unlock(void);
	
	// IsLocked / IsLockedByCurrentThread are only used in ASSERT statements, but because of the changes with ASSERT they must always be defined
	// The fake versions (in Release) will not effect the program in any way
	#ifdef _DEBUG
		cCriticalSection(void);
		bool IsLocked(void);
		bool IsLockedByCurrentThread(void);
	#else
		bool IsLocked(void) { return false; }
		bool IsLockedByCurrentThread(void) { return false; }
	#endif  // _DEBUG
	
private:

	#ifdef _DEBUG
	int           m_IsLocked;  // Number of times this CS is locked
	std::thread::id m_OwningThreadID;
	#endif  // _DEBUG
	
	std::recursive_mutex m_Mutex;
} ALIGN_8;




/** RAII for cCriticalSection - locks the CS on creation, unlocks on destruction */
class cCSLock
{
	cCriticalSection * m_CS;

	// Unlike a cCriticalSection, this object should be used from a single thread, therefore access to m_IsLocked is not threadsafe
	// In Windows, it is an error to call cCriticalSection::Unlock() multiple times if the lock is not held,
	// therefore we need to check this value whether we are locked or not.
	bool m_IsLocked;
	
public:
	cCSLock(cCriticalSection * a_CS);
	cCSLock(cCriticalSection & a_CS);
	~cCSLock();
	
	// Temporarily unlock or re-lock:
	void Lock(void);
	void Unlock(void);

private:
	DISALLOW_COPY_AND_ASSIGN(cCSLock);
} ;





/** Temporary RAII unlock for a cCSLock. Useful for unlock-wait-relock scenarios */
class cCSUnlock
{
	cCSLock & m_Lock;
public:
	cCSUnlock(cCSLock & a_Lock);
	~cCSUnlock();
	
private:
	DISALLOW_COPY_AND_ASSIGN(cCSUnlock);
} ;