summaryrefslogtreecommitdiffstats
path: root/src/OSSupport/IsThread.cpp
blob: 28ed327f1b0d2d94cddea4b10d91d9945a8b448c (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

// IsThread.cpp

// Implements the cIsThread class representing an OS-independent wrapper for a class that implements a thread.

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





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

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





cIsThread::~cIsThread()
{
	Stop();
}





void cIsThread::Start(void)
{
	// Initialize the thread:
	m_Thread = std::thread(&cIsThread::Entrypoint, this);

	// Notify the thread that initialization is complete and it can run its code safely:
	m_Initialisation.Set();
}





void cIsThread::Stop(void)
{
	m_ShouldTerminate = true;
	{
		LOGD("Waiting for the %s thread to finish", m_ThreadName.c_str());
		if (m_Thread.joinable())
		{
			m_Thread.join();
		}
		LOGD("The %s thread finished", m_ThreadName.c_str());
	}
	m_ShouldTerminate = false;
}





void cIsThread::Entrypoint(void)
{
	// Apply thread naming:
	SetThreadName();

	// Wait for initialisation:
	m_Initialisation.Wait();

	try
	{
		Execute();
	}
	catch (const std::exception & Oops)
	{
		LOGERROR("Thread %s faulted with standard exception: %s", m_ThreadName.c_str(), Oops.what());
		std::abort();
	}
	catch (...)
	{
		LOGERROR("Thread %s faulted with unknown exception!", m_ThreadName.c_str());
		std::abort();
	}
}





void cIsThread::SetThreadName() const
{
#if defined(_MSC_VER) && !defined(NDEBUG)
	/* Sets the name of this thread.
	(When in MSVC, the debugger provides "thread naming" by catching special exceptions)
	Code adapted from MSDN: https://msdn.microsoft.com/en-us/library/xcb2z8hs.aspx */

	if (m_ThreadName.empty())
	{
		return;
	}

#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)

	const DWORD NAME_EXCEPTION = 0x406D1388;
	const THREADNAME_INFO Name = { 0x1000, m_ThreadName.c_str(), -1, 0 };

	__try
	{
		RaiseException(NAME_EXCEPTION, 0, sizeof(Name) / sizeof(ULONG_PTR), reinterpret_cast<const ULONG_PTR *>(&Name));
	}
	__except (EXCEPTION_EXECUTE_HANDLER)
	{
	}
#endif
}