summaryrefslogtreecommitdiffstats
path: root/src/OSSupport/IsThread.cpp
blob: 94bed1f5699fdeb342c8faf74b40fca5bfcc952c (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
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136

// IsThread.cpp

// Implements the cIsThread class representing an OS-independent wrapper for a class that implements a thread.
// This class will eventually suupersede the old cThread class

#include "Globals.h"
#include "IsThread.h"





#if defined(_MSC_VER) && defined(_DEBUG)
	// Code adapted from MSDN: http://msdn.microsoft.com/en-us/library/xcb2z8hs.aspx

	const DWORD MS_VC_EXCEPTION = 0x406D1388;
	#pragma pack(push, 8)
		struct THREADNAME_INFO
		{
			DWORD  dwType;      // Must be 0x1000.
			LPCSTR szName;      // Pointer to name (in user addr space).
			DWORD  dwThreadID;  // Thread ID (-1 = caller thread).
			DWORD  dwFlags;     // Reserved for future use, must be zero.
		};
	#pragma pack(pop)

	/** Sets the name of a thread with the specified ID
	(When in MSVC, the debugger provides "thread naming" by catching special exceptions)
	*/
	static void SetThreadName(std::thread * a_Thread, const char * a_ThreadName)
	{
		THREADNAME_INFO info { 0x1000, a_ThreadName, GetThreadId(a_Thread->native_handle()), 0 };
		__try
		{
			RaiseException(MS_VC_EXCEPTION, 0, sizeof(info) / sizeof(ULONG_PTR), (ULONG_PTR *)&info);
		}
		__except (EXCEPTION_EXECUTE_HANDLER)
		{
		}
	}
#endif  // _MSC_VER && _DEBUG





////////////////////////////////////////////////////////////////////////////////
// cIsThread:

cIsThread::cIsThread(const AString & a_ThreadName) :
	m_ShouldTerminate(false),
	m_ThreadName(a_ThreadName)
{
}





cIsThread::~cIsThread()
{
	m_ShouldTerminate = true;
	Wait();
}





bool cIsThread::Start(void)
{
	try
	{
		m_Thread = std::thread(&cIsThread::Execute, this);

		#if defined (_MSC_VER) && defined(_DEBUG)
		if (!m_ThreadName.empty())
		{
			SetThreadName(&m_Thread, m_ThreadName.c_str());
		}
		#endif

		return true;
	}
	catch (std::system_error & a_Exception)
	{
		LOGERROR("cIsThread::Start error %i: could not construct thread %s; %s", a_Exception.code().value(), m_ThreadName.c_str(), a_Exception.code().message().c_str());
		return false;
	}
}





void cIsThread::Stop(void)
{
	if (!m_Thread.joinable())
	{
		// The thread hasn't been started or has already been joined
		return;
	}

	m_ShouldTerminate = true;
	Wait();
}





bool cIsThread::Wait(void)
{
	LOGD("Waiting for thread %s to finish", m_ThreadName.c_str());
	if (m_Thread.joinable())
	{
		try
		{
			m_Thread.join();
			return true;
		}
		catch (std::system_error & a_Exception)
		{
			LOGERROR("cIsThread::Wait error %i: could not join thread %s; %s", a_Exception.code().value(), m_ThreadName.c_str(), a_Exception.code().message().c_str());
			return false;
		}
	}

	LOGD("Thread %s finished", m_ThreadName.c_str());
	return true;
}