core/thread/ThreadWorker.cpp
author David Anderson <dvander@alliedmods.net>
Thu Jul 12 16:57:26 2007 +0000 (2007-07-12)
changeset 1090 5c54e353c019
parent 1084 241c1b9b4048
child 1231 17badaf66ce4
permissions -rw-r--r--
- added callback functionality to IThreadWorker
- added exposure of IThreader to sample sdk
dvander@1084
     1
/**
dvander@1084
     2
 * vim: set ts=4 :
dvander@1084
     3
 * ===============================================================
dvander@1084
     4
 * SourceMod (C)2004-2007 AlliedModders LLC.  All rights reserved.
dvander@1084
     5
 * ===============================================================
dvander@1084
     6
 *
dvander@1084
     7
 * This file is not open source and may not be copied without explicit
dvander@1084
     8
 * written permission of AlliedModders LLC.  This file may not be redistributed 
dvander@1084
     9
 * in whole or significant part.
dvander@1084
    10
 * For information, see LICENSE.txt or http://www.sourcemod.net/license.php
dvander@1084
    11
 *
dvander@1084
    12
 * Version: $Id$
dvander@1084
    13
 */
dvander@1084
    14
dvander@1084
    15
#include "ThreadWorker.h"
dvander@1084
    16
dvander@1090
    17
ThreadWorker::ThreadWorker(IThreadWorkerCallbacks *hooks) : BaseWorker(hooks),
dvander@1084
    18
	m_Threader(NULL),
dvander@1084
    19
	m_QueueLock(NULL),
dvander@1084
    20
	m_StateLock(NULL),
dvander@1084
    21
	m_PauseSignal(NULL),
dvander@1084
    22
	m_AddSignal(NULL),
dvander@1084
    23
	me(NULL),
dvander@1084
    24
	m_think_time(DEFAULT_THINK_TIME_MS)
dvander@1084
    25
{
dvander@1084
    26
	m_state = Worker_Invalid;
dvander@1084
    27
}
dvander@1084
    28
dvander@1090
    29
ThreadWorker::ThreadWorker(IThreadWorkerCallbacks *hooks, IThreader *pThreader, unsigned int thinktime) : 
dvander@1090
    30
	BaseWorker(hooks),
dvander@1084
    31
	m_Threader(pThreader),
dvander@1084
    32
	m_QueueLock(NULL),
dvander@1084
    33
	m_StateLock(NULL),
dvander@1084
    34
	m_PauseSignal(NULL),
dvander@1084
    35
	m_AddSignal(NULL),
dvander@1084
    36
	me(NULL),
dvander@1084
    37
	m_think_time(thinktime)
dvander@1084
    38
{
dvander@1084
    39
	if (m_Threader)
dvander@1084
    40
	{
dvander@1084
    41
		m_state = Worker_Stopped;
dvander@1084
    42
	} else {
dvander@1084
    43
		m_state = Worker_Invalid;
dvander@1084
    44
	}
dvander@1084
    45
}
dvander@1084
    46
dvander@1084
    47
ThreadWorker::~ThreadWorker()
dvander@1084
    48
{
dvander@1084
    49
	if (m_state != Worker_Stopped || m_state != Worker_Invalid)
dvander@1090
    50
	{
dvander@1084
    51
		Stop(true);
dvander@1090
    52
	}
dvander@1084
    53
dvander@1084
    54
	if (m_ThreadQueue.size())
dvander@1090
    55
	{
dvander@1084
    56
		Flush(true);
dvander@1090
    57
	}
dvander@1084
    58
}
dvander@1084
    59
dvander@1084
    60
void ThreadWorker::OnTerminate(IThreadHandle *pHandle, bool cancel)
dvander@1084
    61
{
dvander@1084
    62
	//we don't particularly care
dvander@1084
    63
	return;
dvander@1084
    64
}
dvander@1084
    65
dvander@1084
    66
void ThreadWorker::RunThread(IThreadHandle *pHandle)
dvander@1084
    67
{
dvander@1084
    68
	WorkerState this_state = Worker_Running;
dvander@1084
    69
	size_t num;
dvander@1090
    70
dvander@1090
    71
	if (m_pHooks)
dvander@1090
    72
	{
dvander@1090
    73
		m_pHooks->OnWorkerStart(this);
dvander@1090
    74
	}
dvander@1084
    75
    
dvander@1084
    76
	while (true)
dvander@1084
    77
	{
dvander@1084
    78
		/**
dvander@1084
    79
		 * Check number of items in the queue
dvander@1084
    80
		 */
dvander@1084
    81
		m_StateLock->Lock();
dvander@1084
    82
		this_state = m_state;
dvander@1084
    83
		m_StateLock->Unlock();
dvander@1084
    84
		if (this_state != Worker_Stopped)
dvander@1084
    85
		{
dvander@1084
    86
			m_QueueLock->Lock();
dvander@1084
    87
			num = m_ThreadQueue.size();
dvander@1084
    88
			if (!num)
dvander@1084
    89
			{
dvander@1084
    90
				/** 
dvander@1084
    91
				 * if none, wait for an item
dvander@1084
    92
				 */
dvander@1084
    93
				m_Waiting = true;
dvander@1084
    94
				m_QueueLock->Unlock();
dvander@1084
    95
				/* first check if we should end again */
dvander@1084
    96
				if (this_state == Worker_Stopped)
dvander@1084
    97
				{
dvander@1084
    98
					break;
dvander@1084
    99
				}
dvander@1084
   100
				m_AddSignal->Wait();
dvander@1084
   101
				m_Waiting = false;
dvander@1084
   102
			} else {
dvander@1084
   103
				m_QueueLock->Unlock();
dvander@1084
   104
			}
dvander@1084
   105
		}
dvander@1084
   106
		m_StateLock->Lock();
dvander@1084
   107
		this_state = m_state;
dvander@1084
   108
		m_StateLock->Unlock();
dvander@1084
   109
		if (this_state != Worker_Running)
dvander@1084
   110
		{
dvander@1084
   111
			if (this_state == Worker_Paused || this_state == Worker_Stopped)
dvander@1084
   112
			{
dvander@1084
   113
				//wait until the lock is cleared.
dvander@1084
   114
				if (this_state == Worker_Paused)
dvander@1084
   115
				{
dvander@1084
   116
					m_PauseSignal->Wait();
dvander@1084
   117
				}
dvander@1084
   118
				if (this_state == Worker_Stopped)
dvander@1084
   119
				{
dvander@1084
   120
					//if we're supposed to flush cleanrly, 
dvander@1084
   121
					// run all of the remaining frames first.
dvander@1084
   122
					if (!m_FlushType)
dvander@1084
   123
					{
dvander@1084
   124
						while (m_ThreadQueue.size())
dvander@1090
   125
						{
dvander@1084
   126
							RunFrame();
dvander@1090
   127
						}
dvander@1084
   128
					}
dvander@1084
   129
					break;
dvander@1084
   130
				}
dvander@1084
   131
			}
dvander@1084
   132
		}
dvander@1084
   133
		/**
dvander@1084
   134
		 * Run the frame.
dvander@1084
   135
		 */
dvander@1084
   136
		RunFrame();
dvander@1084
   137
dvander@1084
   138
		/**
dvander@1084
   139
		 * wait in between threads if specified
dvander@1084
   140
		 */
dvander@1084
   141
		if (m_think_time)
dvander@1090
   142
		{
dvander@1084
   143
			m_Threader->ThreadSleep(m_think_time);
dvander@1090
   144
		}
dvander@1090
   145
	}
dvander@1090
   146
dvander@1090
   147
	if (m_pHooks)
dvander@1090
   148
	{
dvander@1090
   149
		m_pHooks->OnWorkerStop(this);
dvander@1084
   150
	}
dvander@1084
   151
}
dvander@1084
   152
dvander@1084
   153
SWThreadHandle *ThreadWorker::PopThreadFromQueue()
dvander@1084
   154
{
dvander@1084
   155
	if (m_state <= Worker_Stopped && !m_QueueLock)
dvander@1090
   156
	{
dvander@1084
   157
		return NULL;
dvander@1090
   158
	}
dvander@1084
   159
dvander@1084
   160
	SWThreadHandle *swt;
dvander@1084
   161
	m_QueueLock->Lock();
dvander@1084
   162
	swt = BaseWorker::PopThreadFromQueue();
dvander@1084
   163
	m_QueueLock->Unlock();
dvander@1084
   164
dvander@1084
   165
	return swt;
dvander@1084
   166
}
dvander@1084
   167
dvander@1084
   168
void ThreadWorker::AddThreadToQueue(SWThreadHandle *pHandle)
dvander@1084
   169
{
dvander@1084
   170
	if (m_state <= Worker_Stopped)
dvander@1090
   171
	{
dvander@1084
   172
		return;
dvander@1090
   173
	}
dvander@1084
   174
dvander@1084
   175
	m_QueueLock->Lock();
dvander@1084
   176
	BaseWorker::AddThreadToQueue(pHandle);
dvander@1084
   177
	if (m_Waiting)
dvander@1084
   178
	{
dvander@1084
   179
		m_AddSignal->Signal();
dvander@1084
   180
	}
dvander@1084
   181
	m_QueueLock->Unlock();
dvander@1084
   182
}
dvander@1084
   183
dvander@1084
   184
WorkerState ThreadWorker::GetStatus(unsigned int *threads)
dvander@1084
   185
{
dvander@1084
   186
	WorkerState state;
dvander@1084
   187
dvander@1084
   188
	m_StateLock->Lock();
dvander@1084
   189
	state = BaseWorker::GetStatus(threads);
dvander@1084
   190
	m_StateLock->Unlock();
dvander@1084
   191
dvander@1084
   192
	return state;
dvander@1084
   193
}
dvander@1084
   194
dvander@1084
   195
bool ThreadWorker::Start()
dvander@1084
   196
{
dvander@1084
   197
	if (m_state == Worker_Invalid)
dvander@1084
   198
	{
dvander@1084
   199
		if (m_Threader == NULL)
dvander@1090
   200
		{
dvander@1084
   201
			return false;
dvander@1090
   202
		}
dvander@1084
   203
	} else if (m_state != Worker_Stopped) {
dvander@1084
   204
		return false;
dvander@1084
   205
	}
dvander@1084
   206
dvander@1084
   207
	m_Waiting = false;
dvander@1084
   208
	m_QueueLock = m_Threader->MakeMutex();
dvander@1084
   209
	m_StateLock = m_Threader->MakeMutex();
dvander@1084
   210
	m_PauseSignal = m_Threader->MakeEventSignal();
dvander@1084
   211
	m_AddSignal = m_Threader->MakeEventSignal();
dvander@1084
   212
	m_state = Worker_Running;
dvander@1084
   213
	ThreadParams pt;
dvander@1084
   214
	pt.flags = Thread_Default;
dvander@1084
   215
	pt.prio = ThreadPrio_Normal;
dvander@1084
   216
	me = m_Threader->MakeThread(this, &pt);
dvander@1084
   217
dvander@1084
   218
	return true;
dvander@1084
   219
}
dvander@1084
   220
dvander@1084
   221
bool ThreadWorker::Stop(bool flush_cancel)
dvander@1084
   222
{
dvander@1084
   223
	if (m_state == Worker_Invalid || m_state == Worker_Stopped)
dvander@1090
   224
	{
dvander@1084
   225
		return false;
dvander@1090
   226
	}
dvander@1084
   227
dvander@1084
   228
	WorkerState oldstate;
dvander@1084
   229
dvander@1084
   230
	//set new state
dvander@1084
   231
	m_StateLock->Lock();
dvander@1084
   232
	oldstate = m_state;
dvander@1084
   233
	m_state = Worker_Stopped;
dvander@1084
   234
	m_FlushType = flush_cancel;
dvander@1084
   235
	m_StateLock->Unlock();
dvander@1084
   236
dvander@1084
   237
	if (oldstate == Worker_Paused)
dvander@1084
   238
	{
dvander@1084
   239
		Unpause();
dvander@1084
   240
	} else {
dvander@1084
   241
		m_QueueLock->Lock();
dvander@1084
   242
		if (m_Waiting)
dvander@1084
   243
		{
dvander@1084
   244
			m_AddSignal->Signal();
dvander@1084
   245
		}
dvander@1084
   246
		m_QueueLock->Unlock();
dvander@1084
   247
	}
dvander@1084
   248
dvander@1084
   249
	me->WaitForThread();
dvander@1084
   250
	//destroy it
dvander@1084
   251
	me->DestroyThis();
dvander@1084
   252
	//flush all remaining events
dvander@1084
   253
	Flush(true);
dvander@1084
   254
dvander@1084
   255
	//free mutex locks
dvander@1084
   256
	m_QueueLock->DestroyThis();
dvander@1084
   257
	m_StateLock->DestroyThis();
dvander@1084
   258
	m_PauseSignal->DestroyThis();
dvander@1084
   259
	m_AddSignal->DestroyThis();
dvander@1084
   260
dvander@1084
   261
	//invalidizzle
dvander@1084
   262
	m_QueueLock = NULL;
dvander@1084
   263
	m_StateLock = NULL;
dvander@1084
   264
	m_PauseSignal = NULL;
dvander@1084
   265
	m_AddSignal = NULL;
dvander@1084
   266
	me = NULL;
dvander@1084
   267
dvander@1084
   268
	return true;
dvander@1084
   269
}
dvander@1084
   270
dvander@1084
   271
bool ThreadWorker::Pause()
dvander@1084
   272
{
dvander@1084
   273
	if (m_state != Worker_Running)
dvander@1090
   274
	{
dvander@1084
   275
		return false;
dvander@1090
   276
	}
dvander@1084
   277
dvander@1084
   278
	m_StateLock->Lock();
dvander@1084
   279
	m_state = Worker_Paused;
dvander@1084
   280
	m_StateLock->Unlock();
dvander@1084
   281
dvander@1084
   282
	return true;
dvander@1084
   283
}
dvander@1084
   284
dvander@1084
   285
dvander@1084
   286
bool ThreadWorker::Unpause()
dvander@1084
   287
{
dvander@1084
   288
	if (m_state != Worker_Paused)
dvander@1090
   289
	{
dvander@1084
   290
		return false;
dvander@1090
   291
	}
dvander@1084
   292
dvander@1084
   293
	m_StateLock->Lock();
dvander@1084
   294
	m_state = Worker_Running;
dvander@1084
   295
	m_StateLock->Unlock();
dvander@1084
   296
	m_PauseSignal->Signal();
dvander@1084
   297
	if (m_Waiting)
dvander@1084
   298
	{
dvander@1084
   299
		m_AddSignal->Signal();
dvander@1084
   300
	}
dvander@1084
   301
dvander@1084
   302
	return true;
dvander@1084
   303
}