core/thread/BaseWorker.cpp
author Matt Woodrow <pred@alliedmods.net>
Tue Mar 11 23:52:56 2008 +0000 (2008-03-11)
changeset 1921 f993e100e5a3
parent 1330 ab94316bb52b
child 1947 e73a1e51833b
permissions -rw-r--r--
Fixed bug in GetAdjustedTime()
dvander@1084
     1
/**
dvander@1084
     2
 * vim: set ts=4 :
ds@1330
     3
 * =============================================================================
dvander@1231
     4
 * SourceMod
dvander@1231
     5
 * Copyright (C) 2004-2007 AlliedModders LLC.  All rights reserved.
ds@1330
     6
 * =============================================================================
dvander@1084
     7
 *
ds@1330
     8
 * This program is free software; you can redistribute it and/or modify it under
ds@1330
     9
 * the terms of the GNU General Public License, version 3.0, as published by the
ds@1330
    10
 * Free Software Foundation.
dvander@1231
    11
 * 
ds@1330
    12
 * This program is distributed in the hope that it will be useful, but WITHOUT
ds@1330
    13
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
ds@1330
    14
 * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
ds@1330
    15
 * details.
dvander@1231
    16
 *
ds@1330
    17
 * You should have received a copy of the GNU General Public License along with
ds@1330
    18
 * this program.  If not, see <http://www.gnu.org/licenses/>.
dvander@1231
    19
 *
ds@1330
    20
 * As a special exception, AlliedModders LLC gives you permission to link the
ds@1330
    21
 * code of this program (as well as its derivative works) to "Half-Life 2," the
ds@1330
    22
 * "Source Engine," the "SourcePawn JIT," and any Game MODs that run on software
ds@1330
    23
 * by the Valve Corporation.  You must obey the GNU General Public License in
ds@1330
    24
 * all respects for all other code used.  Additionally, AlliedModders LLC grants
ds@1330
    25
 * this exception to all derivative works.  AlliedModders LLC defines further
ds@1330
    26
 * exceptions, found in LICENSE.txt (as of this writing, version JULY-31-2007),
ds@1330
    27
 * or <http://www.sourcemod.net/license.php>.
dvander@1084
    28
 *
dvander@1084
    29
 * Version: $Id$
dvander@1084
    30
 */
dvander@1084
    31
dvander@1084
    32
#include "BaseWorker.h"
dvander@1084
    33
dvander@1090
    34
BaseWorker::BaseWorker(IThreadWorkerCallbacks *hooks) : 
dvander@1084
    35
	m_perFrame(SM_DEFAULT_THREADS_PER_FRAME),
dvander@1090
    36
	m_state(Worker_Stopped),
dvander@1090
    37
	m_pHooks(hooks)
dvander@1084
    38
{
dvander@1084
    39
}
dvander@1084
    40
dvander@1084
    41
BaseWorker::~BaseWorker()
dvander@1084
    42
{
dvander@1084
    43
	if (m_state != Worker_Stopped || m_state != Worker_Invalid)
dvander@1084
    44
		Stop(true);
dvander@1084
    45
dvander@1084
    46
	if (m_ThreadQueue.size())
dvander@1084
    47
		Flush(true);
dvander@1084
    48
}
dvander@1084
    49
dvander@1084
    50
void BaseWorker::MakeThread(IThread *pThread)
dvander@1084
    51
{
dvander@1084
    52
	ThreadParams pt;
dvander@1084
    53
dvander@1084
    54
	pt.flags = Thread_AutoRelease;
dvander@1084
    55
	pt.prio = ThreadPrio_Normal;
dvander@1084
    56
dvander@1084
    57
	MakeThread(pThread, &pt);
dvander@1084
    58
}
dvander@1084
    59
dvander@1084
    60
IThreadHandle *BaseWorker::MakeThread(IThread *pThread, ThreadFlags flags)
dvander@1084
    61
{
dvander@1084
    62
	ThreadParams pt;
dvander@1084
    63
dvander@1084
    64
	pt.flags = flags;
dvander@1084
    65
	pt.prio = ThreadPrio_Normal;
dvander@1084
    66
dvander@1084
    67
	return MakeThread(pThread, &pt);
dvander@1084
    68
}
dvander@1084
    69
dvander@1084
    70
IThreadHandle *BaseWorker::MakeThread(IThread *pThread, const ThreadParams *params)
dvander@1084
    71
{
dvander@1084
    72
	if (m_state != Worker_Running)
dvander@1084
    73
		return NULL;
dvander@1084
    74
dvander@1084
    75
	SWThreadHandle *swt = new SWThreadHandle(this, params, pThread);
dvander@1084
    76
dvander@1084
    77
	AddThreadToQueue(swt);
dvander@1084
    78
dvander@1084
    79
	return swt;
dvander@1084
    80
}
dvander@1084
    81
dvander@1084
    82
void BaseWorker::GetPriorityBounds(ThreadPriority &max, ThreadPriority &min)
dvander@1084
    83
{
dvander@1084
    84
	max = ThreadPrio_Normal;
dvander@1084
    85
	min = ThreadPrio_Normal;
dvander@1084
    86
}
dvander@1084
    87
dvander@1084
    88
unsigned int BaseWorker::Flush(bool flush_cancel)
dvander@1084
    89
{
dvander@1084
    90
	SWThreadHandle *swt;
dvander@1084
    91
	unsigned int num = 0;
dvander@1084
    92
dvander@1084
    93
	while ((swt=PopThreadFromQueue()) != NULL)
dvander@1084
    94
	{
dvander@1084
    95
		swt->m_state = Thread_Done;
dvander@1084
    96
		if (!flush_cancel)
dvander@1084
    97
			swt->pThread->RunThread(swt);
dvander@1084
    98
		swt->pThread->OnTerminate(swt, flush_cancel);
dvander@1084
    99
		if (swt->m_params.flags & Thread_AutoRelease)
dvander@1084
   100
			delete swt;
dvander@1084
   101
		num++;
dvander@1084
   102
	}
dvander@1084
   103
dvander@1084
   104
	return num;
dvander@1084
   105
}
dvander@1084
   106
dvander@1084
   107
SWThreadHandle *BaseWorker::PopThreadFromQueue()
dvander@1084
   108
{
dvander@1084
   109
	if (!m_ThreadQueue.size())
dvander@1084
   110
		return NULL;
dvander@1084
   111
dvander@1084
   112
	SourceHook::List<SWThreadHandle *>::iterator begin;
dvander@1084
   113
	SWThreadHandle *swt;
dvander@1084
   114
dvander@1084
   115
	begin = m_ThreadQueue.begin();
dvander@1084
   116
	swt = (*begin);
dvander@1084
   117
	m_ThreadQueue.erase(begin);
dvander@1084
   118
dvander@1084
   119
	return swt;
dvander@1084
   120
}
dvander@1084
   121
dvander@1084
   122
void BaseWorker::AddThreadToQueue(SWThreadHandle *pHandle)
dvander@1084
   123
{
dvander@1084
   124
	m_ThreadQueue.push_back(pHandle);
dvander@1084
   125
}
dvander@1084
   126
dvander@1084
   127
unsigned int BaseWorker::GetMaxThreadsPerFrame()
dvander@1084
   128
{
dvander@1084
   129
	return m_perFrame;
dvander@1084
   130
}
dvander@1084
   131
dvander@1084
   132
WorkerState BaseWorker::GetStatus(unsigned int *threads)
dvander@1084
   133
{
dvander@1084
   134
	if (threads)
dvander@1084
   135
		*threads = m_perFrame;
dvander@1084
   136
dvander@1084
   137
	return m_state;
dvander@1084
   138
}
dvander@1084
   139
dvander@1084
   140
unsigned int BaseWorker::RunFrame()
dvander@1084
   141
{
dvander@1084
   142
	unsigned int done = 0;
dvander@1084
   143
	unsigned int max = GetMaxThreadsPerFrame();
dvander@1084
   144
	SWThreadHandle *swt = NULL;
dvander@1084
   145
	IThread *pThread = NULL;
dvander@1084
   146
dvander@1084
   147
	while (done < max)
dvander@1084
   148
	{
dvander@1084
   149
		if ((swt=PopThreadFromQueue()) == NULL)
dvander@1090
   150
		{
dvander@1084
   151
			break;
dvander@1090
   152
		}
dvander@1084
   153
		pThread = swt->pThread;
dvander@1084
   154
		swt->m_state = Thread_Running;
dvander@1084
   155
		pThread->RunThread(swt);
dvander@1084
   156
		swt->m_state = Thread_Done;
dvander@1084
   157
		pThread->OnTerminate(swt, false);
dvander@1084
   158
		if (swt->m_params.flags & Thread_AutoRelease)
dvander@1090
   159
		{
dvander@1084
   160
			delete swt;
dvander@1090
   161
		}
dvander@1084
   162
		done++;
dvander@1084
   163
	}
dvander@1084
   164
dvander@1084
   165
	return done;
dvander@1084
   166
}
dvander@1084
   167
dvander@1084
   168
void BaseWorker::SetMaxThreadsPerFrame(unsigned int threads)
dvander@1084
   169
{
dvander@1084
   170
	m_perFrame = threads;
dvander@1084
   171
}
dvander@1084
   172
dvander@1084
   173
bool BaseWorker::Start()
dvander@1084
   174
{
dvander@1084
   175
	if (m_state != Worker_Invalid && m_state != Worker_Stopped)
dvander@1084
   176
	{
dvander@1084
   177
		return false;
dvander@1084
   178
	}
dvander@1084
   179
dvander@1084
   180
	m_state = Worker_Running;
dvander@1084
   181
dvander@1090
   182
	if (m_pHooks)
dvander@1090
   183
	{
dvander@1090
   184
		m_pHooks->OnWorkerStart(this);
dvander@1090
   185
	}
dvander@1090
   186
dvander@1084
   187
    return true;
dvander@1084
   188
}
dvander@1084
   189
dvander@1084
   190
bool BaseWorker::Stop(bool flush_cancel)
dvander@1084
   191
{
dvander@1084
   192
	if (m_state == Worker_Invalid || m_state == Worker_Stopped)
dvander@1090
   193
	{
dvander@1084
   194
		return false;
dvander@1090
   195
	}
dvander@1084
   196
dvander@1084
   197
	if (m_state == Worker_Paused)
dvander@1084
   198
	{
dvander@1084
   199
		if (!Unpause())
dvander@1090
   200
		{
dvander@1084
   201
			return false;
dvander@1090
   202
		}
dvander@1084
   203
	}
dvander@1084
   204
dvander@1084
   205
	m_state = Worker_Stopped;
dvander@1084
   206
	Flush(flush_cancel);
dvander@1084
   207
dvander@1090
   208
	if (m_pHooks)
dvander@1090
   209
	{
dvander@1090
   210
		m_pHooks->OnWorkerStop(this);
dvander@1090
   211
	}
dvander@1090
   212
dvander@1084
   213
	return true;
dvander@1084
   214
}
dvander@1084
   215
dvander@1084
   216
bool BaseWorker::Pause()
dvander@1084
   217
{
dvander@1084
   218
	if (m_state != Worker_Running)
dvander@1090
   219
	{
dvander@1084
   220
		return false;
dvander@1090
   221
	}
dvander@1084
   222
dvander@1084
   223
	m_state = Worker_Paused;
dvander@1084
   224
dvander@1084
   225
	return true;
dvander@1084
   226
}
dvander@1084
   227
dvander@1084
   228
dvander@1084
   229
bool BaseWorker::Unpause()
dvander@1084
   230
{
dvander@1084
   231
	if (m_state != Worker_Paused)
dvander@1090
   232
	{
dvander@1084
   233
		return false;
dvander@1090
   234
	}
dvander@1084
   235
dvander@1084
   236
	m_state = Worker_Running;
dvander@1084
   237
dvander@1084
   238
	return true;
dvander@1084
   239
}
dvander@1084
   240
dvander@1084
   241
/***********************
dvander@1084
   242
 * THREAD HANDLE STUFF *
dvander@1084
   243
 ***********************/
dvander@1084
   244
dvander@1084
   245
void SWThreadHandle::DestroyThis()
dvander@1084
   246
{
dvander@1084
   247
	delete this;
dvander@1084
   248
}
dvander@1084
   249
dvander@1084
   250
void SWThreadHandle::GetParams(ThreadParams *p)
dvander@1084
   251
{
dvander@1084
   252
	*p = m_params;
dvander@1084
   253
}
dvander@1084
   254
dvander@1084
   255
ThreadPriority SWThreadHandle::GetPriority()
dvander@1084
   256
{
dvander@1084
   257
	return m_params.prio;
dvander@1084
   258
}
dvander@1084
   259
dvander@1084
   260
ThreadState SWThreadHandle::GetState()
dvander@1084
   261
{
dvander@1084
   262
	return m_state;
dvander@1084
   263
}
dvander@1084
   264
dvander@1084
   265
IThreadCreator *SWThreadHandle::Parent()
dvander@1084
   266
{
dvander@1084
   267
	return m_parent;
dvander@1084
   268
}
dvander@1084
   269
dvander@1084
   270
bool SWThreadHandle::SetPriority(ThreadPriority prio)
dvander@1084
   271
{
dvander@1084
   272
	if (m_params.prio != ThreadPrio_Normal)
dvander@1084
   273
		return false;
dvander@1084
   274
dvander@1084
   275
	m_params.prio = prio;
dvander@1084
   276
dvander@1084
   277
	return true;
dvander@1084
   278
}
dvander@1084
   279
dvander@1084
   280
bool SWThreadHandle::Unpause()
dvander@1084
   281
{
dvander@1084
   282
	if (m_state != Thread_Paused)
dvander@1084
   283
		return false;
dvander@1084
   284
dvander@1084
   285
	m_state = Thread_Running;
dvander@1084
   286
dvander@1084
   287
	return true;
dvander@1084
   288
}
dvander@1084
   289
dvander@1084
   290
bool SWThreadHandle::WaitForThread()
dvander@1084
   291
{
dvander@1084
   292
	return false;
dvander@1084
   293
}
dvander@1084
   294
dvander@1084
   295
SWThreadHandle::SWThreadHandle(IThreadCreator *parent, const ThreadParams *p, IThread *thread) : 
dvander@1084
   296
	m_state(Thread_Paused), m_params(*p), m_parent(parent), pThread(thread)
dvander@1084
   297
{
dvander@1084
   298
}
dvander@1084
   299
dvander@1084
   300
IThread *SWThreadHandle::GetThread()
dvander@1084
   301
{
dvander@1084
   302
	return pThread;
dvander@1084
   303
}