core/thread/WinThreads.cpp
author David Anderson <dvander@alliedmods.net>
Fri Jul 11 06:51:21 2008 +0000 (2008-07-11)
branchrefac-jit
changeset 2192 7602d7fb60d9
parent 2168 c24a6fa957db
child 2289 44045ead61cd
permissions -rw-r--r--
fixed a compat regression, forgot msvc does funky things with overloaded virtual calls
dvander@2168
     1
/**
dvander@2168
     2
 * vim: set ts=4 :
dvander@2168
     3
 * =============================================================================
dvander@2168
     4
 * SourceMod
dvander@2168
     5
 * Copyright (C) 2004-2008 AlliedModders LLC.  All rights reserved.
dvander@2168
     6
 * =============================================================================
dvander@2168
     7
 *
dvander@2168
     8
 * This program is free software; you can redistribute it and/or modify it under
dvander@2168
     9
 * the terms of the GNU General Public License, version 3.0, as published by the
dvander@2168
    10
 * Free Software Foundation.
dvander@2168
    11
 * 
dvander@2168
    12
 * This program is distributed in the hope that it will be useful, but WITHOUT
dvander@2168
    13
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
dvander@2168
    14
 * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
dvander@2168
    15
 * details.
dvander@2168
    16
 *
dvander@2168
    17
 * You should have received a copy of the GNU General Public License along with
dvander@2168
    18
 * this program.  If not, see <http://www.gnu.org/licenses/>.
dvander@2168
    19
 *
dvander@2168
    20
 * As a special exception, AlliedModders LLC gives you permission to link the
dvander@2168
    21
 * code of this program (as well as its derivative works) to "Half-Life 2," the
dvander@2168
    22
 * "Source Engine," the "SourcePawn JIT," and any Game MODs that run on software
dvander@2168
    23
 * by the Valve Corporation.  You must obey the GNU General Public License in
dvander@2168
    24
 * all respects for all other code used.  Additionally, AlliedModders LLC grants
dvander@2168
    25
 * this exception to all derivative works.  AlliedModders LLC defines further
dvander@2168
    26
 * exceptions, found in LICENSE.txt (as of this writing, version JULY-31-2007),
dvander@2168
    27
 * or <http://www.sourcemod.net/license.php>.
dvander@2168
    28
 *
dvander@2168
    29
 * Version: $Id$
dvander@2168
    30
 */
dvander@2168
    31
dvander@2168
    32
#define _WIN32_WINNT 0x0400
dvander@2168
    33
#include "WinThreads.h"
dvander@2168
    34
#include "ThreadWorker.h"
dvander@2168
    35
dvander@2168
    36
IThreadWorker *WinThreader::MakeWorker(IThreadWorkerCallbacks *hooks, bool threaded)
dvander@2168
    37
{
dvander@2168
    38
	if (threaded)
dvander@2168
    39
	{
dvander@2168
    40
		return new ThreadWorker(hooks, this, DEFAULT_THINK_TIME_MS);
dvander@2168
    41
	} else {
dvander@2168
    42
		return new BaseWorker(hooks);
dvander@2168
    43
	}
dvander@2168
    44
}
dvander@2168
    45
dvander@2168
    46
void WinThreader::DestroyWorker(IThreadWorker *pWorker)
dvander@2168
    47
{
dvander@2168
    48
	delete pWorker;
dvander@2168
    49
}
dvander@2168
    50
dvander@2168
    51
void WinThreader::ThreadSleep(unsigned int ms)
dvander@2168
    52
{
dvander@2168
    53
	Sleep((DWORD)ms);
dvander@2168
    54
}
dvander@2168
    55
dvander@2168
    56
IMutex *WinThreader::MakeMutex()
dvander@2168
    57
{
dvander@2168
    58
	WinMutex *pMutex = new WinMutex();
dvander@2168
    59
dvander@2168
    60
	return pMutex;
dvander@2168
    61
}
dvander@2168
    62
dvander@2168
    63
IThreadHandle *WinThreader::MakeThread(IThread *pThread, ThreadFlags flags)
dvander@2168
    64
{
dvander@2168
    65
	ThreadParams defparams;
dvander@2168
    66
dvander@2168
    67
	defparams.flags = flags;
dvander@2168
    68
	defparams.prio = ThreadPrio_Normal;
dvander@2168
    69
dvander@2168
    70
	return MakeThread(pThread, &defparams);
dvander@2168
    71
}
dvander@2168
    72
dvander@2168
    73
void WinThreader::MakeThread(IThread *pThread)
dvander@2168
    74
{
dvander@2168
    75
	ThreadParams defparams;
dvander@2168
    76
dvander@2168
    77
	defparams.flags = Thread_AutoRelease;
dvander@2168
    78
	defparams.prio = ThreadPrio_Normal;
dvander@2168
    79
dvander@2168
    80
	MakeThread(pThread, &defparams);
dvander@2168
    81
}
dvander@2168
    82
dvander@2168
    83
DWORD WINAPI Win32_ThreadGate(LPVOID param)
dvander@2168
    84
{
dvander@2168
    85
	WinThreader::ThreadHandle *pHandle = 
dvander@2168
    86
		reinterpret_cast<WinThreader::ThreadHandle *>(param);
dvander@2168
    87
dvander@2168
    88
	pHandle->m_run->RunThread(pHandle);
dvander@2168
    89
dvander@2168
    90
	ThreadParams params;
dvander@2168
    91
	EnterCriticalSection(&pHandle->m_crit);
dvander@2168
    92
	pHandle->m_state = Thread_Done;
dvander@2168
    93
	pHandle->GetParams(&params);
dvander@2168
    94
	LeaveCriticalSection(&pHandle->m_crit);
dvander@2168
    95
dvander@2168
    96
	pHandle->m_run->OnTerminate(pHandle, false);
dvander@2168
    97
	if (params.flags & Thread_AutoRelease)
dvander@2168
    98
		delete pHandle;
dvander@2168
    99
dvander@2168
   100
	return 0;
dvander@2168
   101
}
dvander@2168
   102
dvander@2168
   103
void WinThreader::GetPriorityBounds(ThreadPriority &max, ThreadPriority &min)
dvander@2168
   104
{
dvander@2168
   105
	max = ThreadPrio_Maximum;
dvander@2168
   106
	min = ThreadPrio_Minimum;
dvander@2168
   107
}
dvander@2168
   108
dvander@2168
   109
ThreadParams g_defparams;
dvander@2168
   110
IThreadHandle *WinThreader::MakeThread(IThread *pThread, const ThreadParams *params)
dvander@2168
   111
{
dvander@2168
   112
	if (params == NULL)
dvander@2168
   113
		params = &g_defparams;
dvander@2168
   114
dvander@2168
   115
	WinThreader::ThreadHandle *pHandle = 
dvander@2168
   116
		new WinThreader::ThreadHandle(this, NULL, pThread, params);
dvander@2168
   117
dvander@2168
   118
	DWORD tid;
dvander@2168
   119
	pHandle->m_thread = 
dvander@2168
   120
		CreateThread(NULL, 0, &Win32_ThreadGate, (LPVOID)pHandle, CREATE_SUSPENDED, &tid);
dvander@2168
   121
dvander@2168
   122
	if (!pHandle->m_thread)
dvander@2168
   123
	{
dvander@2168
   124
		delete pHandle;
dvander@2168
   125
		return NULL;
dvander@2168
   126
	}
dvander@2168
   127
dvander@2168
   128
	if (pHandle->m_params.prio != ThreadPrio_Normal)
dvander@2168
   129
	{
dvander@2168
   130
		pHandle->SetPriority(pHandle->m_params.prio);
dvander@2168
   131
	}
dvander@2168
   132
dvander@2168
   133
	if (!(pHandle->m_params.flags & Thread_CreateSuspended))
dvander@2168
   134
	{
dvander@2168
   135
		pHandle->Unpause();
dvander@2168
   136
	}
dvander@2168
   137
dvander@2168
   138
	return pHandle;
dvander@2168
   139
}
dvander@2168
   140
dvander@2168
   141
IEventSignal *WinThreader::MakeEventSignal()
dvander@2168
   142
{
dvander@2168
   143
	HANDLE event = CreateEventA(NULL, FALSE, FALSE, NULL);
dvander@2168
   144
dvander@2168
   145
	if (!event)
dvander@2168
   146
		return NULL;
dvander@2168
   147
dvander@2168
   148
	WinEvent *pEvent = new WinEvent(event);
dvander@2168
   149
dvander@2168
   150
	return pEvent;
dvander@2168
   151
}
dvander@2168
   152
dvander@2168
   153
/*****************
dvander@2168
   154
 **** Mutexes ****
dvander@2168
   155
 *****************/
dvander@2168
   156
dvander@2168
   157
WinThreader::WinMutex::WinMutex()
dvander@2168
   158
{
dvander@2168
   159
	InitializeCriticalSection(&m_crit);
dvander@2168
   160
}
dvander@2168
   161
dvander@2168
   162
WinThreader::WinMutex::~WinMutex()
dvander@2168
   163
{
dvander@2168
   164
	DeleteCriticalSection(&m_crit);
dvander@2168
   165
}
dvander@2168
   166
dvander@2168
   167
bool WinThreader::WinMutex::TryLock()
dvander@2168
   168
{
dvander@2168
   169
	return (TryEnterCriticalSection(&m_crit) != FALSE);
dvander@2168
   170
}
dvander@2168
   171
dvander@2168
   172
void WinThreader::WinMutex::Lock()
dvander@2168
   173
{
dvander@2168
   174
	EnterCriticalSection(&m_crit);
dvander@2168
   175
}
dvander@2168
   176
dvander@2168
   177
void WinThreader::WinMutex::Unlock()
dvander@2168
   178
{
dvander@2168
   179
	LeaveCriticalSection(&m_crit);
dvander@2168
   180
}
dvander@2168
   181
dvander@2168
   182
void WinThreader::WinMutex::DestroyThis()
dvander@2168
   183
{
dvander@2168
   184
	delete this;
dvander@2168
   185
}
dvander@2168
   186
dvander@2168
   187
/******************
dvander@2168
   188
 * Thread Handles *
dvander@2168
   189
 ******************/
dvander@2168
   190
dvander@2168
   191
WinThreader::ThreadHandle::ThreadHandle(IThreader *parent, HANDLE hthread, IThread *run, const ThreadParams *params) : 
dvander@2168
   192
	m_parent(parent), m_thread(hthread), m_run(run), m_params(*params),
dvander@2168
   193
	m_state(Thread_Paused)
dvander@2168
   194
{
dvander@2168
   195
	InitializeCriticalSection(&m_crit);
dvander@2168
   196
}
dvander@2168
   197
dvander@2168
   198
WinThreader::ThreadHandle::~ThreadHandle()
dvander@2168
   199
{
dvander@2168
   200
	if (m_thread)
dvander@2168
   201
	{
dvander@2168
   202
		CloseHandle(m_thread);
dvander@2168
   203
		m_thread = NULL;
dvander@2168
   204
	}
dvander@2168
   205
	DeleteCriticalSection(&m_crit);
dvander@2168
   206
}
dvander@2168
   207
dvander@2168
   208
bool WinThreader::ThreadHandle::WaitForThread()
dvander@2168
   209
{
dvander@2168
   210
	if (m_thread == NULL)
dvander@2168
   211
		return false;
dvander@2168
   212
dvander@2168
   213
	if (WaitForSingleObject(m_thread, INFINITE) != 0)
dvander@2168
   214
		return false;
dvander@2168
   215
dvander@2168
   216
	return true;
dvander@2168
   217
}
dvander@2168
   218
dvander@2168
   219
ThreadState WinThreader::ThreadHandle::GetState()
dvander@2168
   220
{
dvander@2168
   221
	ThreadState state;
dvander@2168
   222
dvander@2168
   223
	EnterCriticalSection(&m_crit);
dvander@2168
   224
	state = m_state;
dvander@2168
   225
	LeaveCriticalSection(&m_crit);
dvander@2168
   226
dvander@2168
   227
	return state;
dvander@2168
   228
}
dvander@2168
   229
dvander@2168
   230
IThreadCreator *WinThreader::ThreadHandle::Parent()
dvander@2168
   231
{
dvander@2168
   232
	return m_parent;
dvander@2168
   233
}
dvander@2168
   234
dvander@2168
   235
void WinThreader::ThreadHandle::DestroyThis()
dvander@2168
   236
{
dvander@2168
   237
	if (m_params.flags & Thread_AutoRelease)
dvander@2168
   238
		return;
dvander@2168
   239
dvander@2168
   240
	delete this;
dvander@2168
   241
}
dvander@2168
   242
dvander@2168
   243
void WinThreader::ThreadHandle::GetParams(ThreadParams *ptparams)
dvander@2168
   244
{
dvander@2168
   245
	if (!ptparams)
dvander@2168
   246
		return;
dvander@2168
   247
dvander@2168
   248
	*ptparams = m_params;
dvander@2168
   249
}
dvander@2168
   250
dvander@2168
   251
ThreadPriority WinThreader::ThreadHandle::GetPriority()
dvander@2168
   252
{
dvander@2168
   253
	return m_params.prio;
dvander@2168
   254
}
dvander@2168
   255
dvander@2168
   256
bool WinThreader::ThreadHandle::SetPriority(ThreadPriority prio)
dvander@2168
   257
{
dvander@2168
   258
	if (!m_thread)
dvander@2168
   259
		return false;
dvander@2168
   260
dvander@2168
   261
	BOOL res = FALSE;
dvander@2168
   262
dvander@2168
   263
	if (prio >= ThreadPrio_Maximum)
dvander@2168
   264
		res = SetThreadPriority(m_thread, THREAD_PRIORITY_HIGHEST);
dvander@2168
   265
	else if (prio <= ThreadPrio_Minimum)
dvander@2168
   266
		res = SetThreadPriority(m_thread, THREAD_PRIORITY_LOWEST);
dvander@2168
   267
	else if (prio == ThreadPrio_Normal)
dvander@2168
   268
		res = SetThreadPriority(m_thread, THREAD_PRIORITY_NORMAL);
dvander@2168
   269
	else if (prio == ThreadPrio_High)
dvander@2168
   270
		res = SetThreadPriority(m_thread, THREAD_PRIORITY_ABOVE_NORMAL);
dvander@2168
   271
	else if (prio == ThreadPrio_Low)
dvander@2168
   272
		res = SetThreadPriority(m_thread, THREAD_PRIORITY_BELOW_NORMAL);
dvander@2168
   273
dvander@2168
   274
	m_params.prio = prio;
dvander@2168
   275
dvander@2168
   276
	return (res != FALSE);
dvander@2168
   277
}
dvander@2168
   278
dvander@2168
   279
bool WinThreader::ThreadHandle::Unpause()
dvander@2168
   280
{
dvander@2168
   281
	if (!m_thread)
dvander@2168
   282
		return false;
dvander@2168
   283
dvander@2168
   284
	if (m_state != Thread_Paused)
dvander@2168
   285
		return false;
dvander@2168
   286
dvander@2168
   287
	m_state = Thread_Running;
dvander@2168
   288
dvander@2168
   289
	if (ResumeThread(m_thread) == -1)
dvander@2168
   290
	{
dvander@2168
   291
		m_state = Thread_Paused;
dvander@2168
   292
		return false;
dvander@2168
   293
	}
dvander@2168
   294
dvander@2168
   295
	return true;
dvander@2168
   296
}
dvander@2168
   297
dvander@2168
   298
/*****************
dvander@2168
   299
 * EVENT SIGNALS *
dvander@2168
   300
 *****************/
dvander@2168
   301
dvander@2168
   302
WinThreader::WinEvent::~WinEvent()
dvander@2168
   303
{
dvander@2168
   304
	CloseHandle(m_event);
dvander@2168
   305
}
dvander@2168
   306
dvander@2168
   307
void WinThreader::WinEvent::Wait()
dvander@2168
   308
{
dvander@2168
   309
	WaitForSingleObject(m_event, INFINITE);
dvander@2168
   310
}
dvander@2168
   311
dvander@2168
   312
void WinThreader::WinEvent::Signal()
dvander@2168
   313
{
dvander@2168
   314
	SetEvent(m_event);
dvander@2168
   315
}
dvander@2168
   316
dvander@2168
   317
void WinThreader::WinEvent::DestroyThis()
dvander@2168
   318
{
dvander@2168
   319
	delete this;
dvander@2168
   320
}