summaryrefslogtreecommitdiffstats
path: root/src/OSSupport/CriticalSection.h
blob: 7634e5a8c61bb118038dc2c54c213837422904d3 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89

#pragma once





class cCriticalSection
{
	friend class cDeadlockDetect;  // Allow the DeadlockDetect to read the internals, so that it may output some
								   // statistics

  public:
	void Lock(void);
	void Unlock(void);

	cCriticalSection(void);

	/** Returns true if the CS is currently locked.
	Note that since it relies on the m_RecursionCount value, it is inherently thread-unsafe, prone to false positives.
	Also, due to multithreading, the state can change between this when function is evaluated and the returned value is
	used. To be used in ASSERT(IsLocked()) only. */
	bool IsLocked(void);

	/** Returns true if the CS is currently locked by the thread calling this function.
	Note that since it relies on the m_RecursionCount value, it is inherently thread-unsafe, prone to false positives.
	Also, due to multithreading, the state can change between this when function is evaluated and the returned value is
	used. To be used in ASSERT(IsLockedByCurrentThread()) only. */
	bool IsLockedByCurrentThread(void);

  private:
	/** Number of times that this CS is currently locked (levels of recursion). Zero if not locked.
	Note that this value should be considered true only when the CS is locked; without the lock, it is UndefinedBehavior
	to even read it, but making it std::atomic would impose too much of a runtime penalty. It is only ever read without
	the lock in the DeadlockDetect, where the server is terminating anyway. */
	int m_RecursionCount;

	/** ID of the thread that is currently holding the CS.
	Note that this value should be considered true only when the CS is locked; without the lock, it is UndefinedBehavior
	to even read it, but making it std::atomic would impose too much of a runtime penalty. When unlocked, the value
	stored here has no meaning, it may be an ID of a previous holder, or it could be any garbage. It is only ever read
	without the lock in the DeadlockDetect, where the server is terminating anyway. */
	std::thread::id m_OwningThreadID;

	std::recursive_mutex m_Mutex;
};




/** 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);
};