core/thread/BaseWorker.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
#include "BaseWorker.h"
dvander@2168
    33
dvander@2168
    34
BaseWorker::BaseWorker(IThreadWorkerCallbacks *hooks) : 
dvander@2168
    35
	m_perFrame(SM_DEFAULT_THREADS_PER_FRAME),
dvander@2168
    36
	m_state(Worker_Stopped),
dvander@2168
    37
	m_pHooks(hooks)
dvander@2168
    38
{
dvander@2168
    39
}
dvander@2168
    40
dvander@2168
    41
BaseWorker::~BaseWorker()
dvander@2168
    42
{
dvander@2168
    43
	if (m_state != Worker_Stopped || m_state != Worker_Invalid)
dvander@2168
    44
		Stop(true);
dvander@2168
    45
dvander@2168
    46
	if (m_ThreadQueue.size())
dvander@2168
    47
		Flush(true);
dvander@2168
    48
}
dvander@2168
    49
dvander@2168
    50
void BaseWorker::MakeThread(IThread *pThread)
dvander@2168
    51
{
dvander@2168
    52
	ThreadParams pt;
dvander@2168
    53
dvander@2168
    54
	pt.flags = Thread_AutoRelease;
dvander@2168
    55
	pt.prio = ThreadPrio_Normal;
dvander@2168
    56
dvander@2168
    57
	MakeThread(pThread, &pt);
dvander@2168
    58
}
dvander@2168
    59
dvander@2168
    60
IThreadHandle *BaseWorker::MakeThread(IThread *pThread, ThreadFlags flags)
dvander@2168
    61
{
dvander@2168
    62
	ThreadParams pt;
dvander@2168
    63
dvander@2168
    64
	pt.flags = flags;
dvander@2168
    65
	pt.prio = ThreadPrio_Normal;
dvander@2168
    66
dvander@2168
    67
	return MakeThread(pThread, &pt);
dvander@2168
    68
}
dvander@2168
    69
dvander@2168
    70
IThreadHandle *BaseWorker::MakeThread(IThread *pThread, const ThreadParams *params)
dvander@2168
    71
{
dvander@2168
    72
	if (m_state != Worker_Running)
dvander@2168
    73
		return NULL;
dvander@2168
    74
dvander@2168
    75
	SWThreadHandle *swt = new SWThreadHandle(this, params, pThread);
dvander@2168
    76
dvander@2168
    77
	AddThreadToQueue(swt);
dvander@2168
    78
dvander@2168
    79
	return swt;
dvander@2168
    80
}
dvander@2168
    81
dvander@2168
    82
void BaseWorker::GetPriorityBounds(ThreadPriority &max, ThreadPriority &min)
dvander@2168
    83
{
dvander@2168
    84
	max = ThreadPrio_Normal;
dvander@2168
    85
	min = ThreadPrio_Normal;
dvander@2168
    86
}
dvander@2168
    87
dvander@2168
    88
unsigned int BaseWorker::Flush(bool flush_cancel)
dvander@2168
    89
{
dvander@2168
    90
	SWThreadHandle *swt;
dvander@2168
    91
	unsigned int num = 0;
dvander@2168
    92
dvander@2168
    93
	while ((swt=PopThreadFromQueue()) != NULL)
dvander@2168
    94
	{
dvander@2168
    95
		swt->m_state = Thread_Done;
dvander@2168
    96
		if (!flush_cancel)
dvander@2168
    97
			swt->pThread->RunThread(swt);
dvander@2168
    98
		swt->pThread->OnTerminate(swt, flush_cancel);
dvander@2168
    99
		if (swt->m_params.flags & Thread_AutoRelease)
dvander@2168
   100
			delete swt;
dvander@2168
   101
		num++;
dvander@2168
   102
	}
dvander@2168
   103
dvander@2168
   104
	return num;
dvander@2168
   105
}
dvander@2168
   106
dvander@2168
   107
SWThreadHandle *BaseWorker::PopThreadFromQueue()
dvander@2168
   108
{
dvander@2168
   109
	if (!m_ThreadQueue.size())
dvander@2168
   110
		return NULL;
dvander@2168
   111
dvander@2168
   112
	SourceHook::List<SWThreadHandle *>::iterator begin;
dvander@2168
   113
	SWThreadHandle *swt;
dvander@2168
   114
dvander@2168
   115
	begin = m_ThreadQueue.begin();
dvander@2168
   116
	swt = (*begin);
dvander@2168
   117
	m_ThreadQueue.erase(begin);
dvander@2168
   118
dvander@2168
   119
	return swt;
dvander@2168
   120
}
dvander@2168
   121
dvander@2168
   122
void BaseWorker::AddThreadToQueue(SWThreadHandle *pHandle)
dvander@2168
   123
{
dvander@2168
   124
	m_ThreadQueue.push_back(pHandle);
dvander@2168
   125
}
dvander@2168
   126
dvander@2168
   127
unsigned int BaseWorker::GetMaxThreadsPerFrame()
dvander@2168
   128
{
dvander@2168
   129
	return m_perFrame;
dvander@2168
   130
}
dvander@2168
   131
dvander@2168
   132
WorkerState BaseWorker::GetStatus(unsigned int *threads)
dvander@2168
   133
{
dvander@2168
   134
	if (threads)
dvander@2168
   135
		*threads = m_perFrame;
dvander@2168
   136
dvander@2168
   137
	return m_state;
dvander@2168
   138
}
dvander@2168
   139
dvander@2168
   140
unsigned int BaseWorker::RunFrame()
dvander@2168
   141
{
dvander@2168
   142
	unsigned int done = 0;
dvander@2168
   143
	unsigned int max = GetMaxThreadsPerFrame();
dvander@2168
   144
	SWThreadHandle *swt = NULL;
dvander@2168
   145
	IThread *pThread = NULL;
dvander@2168
   146
dvander@2168
   147
	while (done < max)
dvander@2168
   148
	{
dvander@2168
   149
		if ((swt=PopThreadFromQueue()) == NULL)
dvander@2168
   150
		{
dvander@2168
   151
			break;
dvander@2168
   152
		}
dvander@2168
   153
		pThread = swt->pThread;
dvander@2168
   154
		swt->m_state = Thread_Running;
dvander@2168
   155
		pThread->RunThread(swt);
dvander@2168
   156
		swt->m_state = Thread_Done;
dvander@2168
   157
		pThread->OnTerminate(swt, false);
dvander@2168
   158
		if (swt->m_params.flags & Thread_AutoRelease)
dvander@2168
   159
		{
dvander@2168
   160
			delete swt;
dvander@2168
   161
		}
dvander@2168
   162
		done++;
dvander@2168
   163
	}
dvander@2168
   164
dvander@2168
   165
	return done;
dvander@2168
   166
}
dvander@2168
   167
dvander@2168
   168
void BaseWorker::SetMaxThreadsPerFrame(unsigned int threads)
dvander@2168
   169
{
dvander@2168
   170
	m_perFrame = threads;
dvander@2168
   171
}
dvander@2168
   172
dvander@2168
   173
bool BaseWorker::Start()
dvander@2168
   174
{
dvander@2168
   175
	if (m_state != Worker_Invalid && m_state != Worker_Stopped)
dvander@2168
   176
	{
dvander@2168
   177
		return false;
dvander@2168
   178
	}
dvander@2168
   179
dvander@2168
   180
	m_state = Worker_Running;
dvander@2168
   181
dvander@2168
   182
	if (m_pHooks)
dvander@2168
   183
	{
dvander@2168
   184
		m_pHooks->OnWorkerStart(this);
dvander@2168
   185
	}
dvander@2168
   186
dvander@2168
   187
    return true;
dvander@2168
   188
}
dvander@2168
   189
dvander@2168
   190
bool BaseWorker::Stop(bool flush_cancel)
dvander@2168
   191
{
dvander@2168
   192
	if (m_state == Worker_Invalid || m_state == Worker_Stopped)
dvander@2168
   193
	{
dvander@2168
   194
		return false;
dvander@2168
   195
	}
dvander@2168
   196
dvander@2168
   197
	if (m_state == Worker_Paused)
dvander@2168
   198
	{
dvander@2168
   199
		if (!Unpause())
dvander@2168
   200
		{
dvander@2168
   201
			return false;
dvander@2168
   202
		}
dvander@2168
   203
	}
dvander@2168
   204
dvander@2168
   205
	m_state = Worker_Stopped;
dvander@2168
   206
	Flush(flush_cancel);
dvander@2168
   207
dvander@2168
   208
	if (m_pHooks)
dvander@2168
   209
	{
dvander@2168
   210
		m_pHooks->OnWorkerStop(this);
dvander@2168
   211
	}
dvander@2168
   212
dvander@2168
   213
	return true;
dvander@2168
   214
}
dvander@2168
   215
dvander@2168
   216
bool BaseWorker::Pause()
dvander@2168
   217
{
dvander@2168
   218
	if (m_state != Worker_Running)
dvander@2168
   219
	{
dvander@2168
   220
		return false;
dvander@2168
   221
	}
dvander@2168
   222
dvander@2168
   223
	m_state = Worker_Paused;
dvander@2168
   224
dvander@2168
   225
	return true;
dvander@2168
   226
}
dvander@2168
   227
dvander@2168
   228
dvander@2168
   229
bool BaseWorker::Unpause()
dvander@2168
   230
{
dvander@2168
   231
	if (m_state != Worker_Paused)
dvander@2168
   232
	{
dvander@2168
   233
		return false;
dvander@2168
   234
	}
dvander@2168
   235
dvander@2168
   236
	m_state = Worker_Running;
dvander@2168
   237
dvander@2168
   238
	return true;
dvander@2168
   239
}
dvander@2168
   240
dvander@2168
   241
/***********************
dvander@2168
   242
 * THREAD HANDLE STUFF *
dvander@2168
   243
 ***********************/
dvander@2168
   244
dvander@2168
   245
void SWThreadHandle::DestroyThis()
dvander@2168
   246
{
dvander@2168
   247
	delete this;
dvander@2168
   248
}
dvander@2168
   249
dvander@2168
   250
void SWThreadHandle::GetParams(ThreadParams *p)
dvander@2168
   251
{
dvander@2168
   252
	*p = m_params;
dvander@2168
   253
}
dvander@2168
   254
dvander@2168
   255
ThreadPriority SWThreadHandle::GetPriority()
dvander@2168
   256
{
dvander@2168
   257
	return m_params.prio;
dvander@2168
   258
}
dvander@2168
   259
dvander@2168
   260
ThreadState SWThreadHandle::GetState()
dvander@2168
   261
{
dvander@2168
   262
	return m_state;
dvander@2168
   263
}
dvander@2168
   264
dvander@2168
   265
IThreadCreator *SWThreadHandle::Parent()
dvander@2168
   266
{
dvander@2168
   267
	return m_parent;
dvander@2168
   268
}
dvander@2168
   269
dvander@2168
   270
bool SWThreadHandle::SetPriority(ThreadPriority prio)
dvander@2168
   271
{
dvander@2168
   272
	if (m_params.prio != ThreadPrio_Normal)
dvander@2168
   273
		return false;
dvander@2168
   274
dvander@2168
   275
	m_params.prio = prio;
dvander@2168
   276
dvander@2168
   277
	return true;
dvander@2168
   278
}
dvander@2168
   279
dvander@2168
   280
bool SWThreadHandle::Unpause()
dvander@2168
   281
{
dvander@2168
   282
	if (m_state != Thread_Paused)
dvander@2168
   283
		return false;
dvander@2168
   284
dvander@2168
   285
	m_state = Thread_Running;
dvander@2168
   286
dvander@2168
   287
	return true;
dvander@2168
   288
}
dvander@2168
   289
dvander@2168
   290
bool SWThreadHandle::WaitForThread()
dvander@2168
   291
{
dvander@2168
   292
	return false;
dvander@2168
   293
}
dvander@2168
   294
dvander@2168
   295
SWThreadHandle::SWThreadHandle(IThreadCreator *parent, const ThreadParams *p, IThread *thread) : 
dvander@2168
   296
	m_state(Thread_Paused), m_params(*p), m_parent(parent), pThread(thread)
dvander@2168
   297
{
dvander@2168
   298
}
dvander@2168
   299
dvander@2168
   300
IThread *SWThreadHandle::GetThread()
dvander@2168
   301
{
dvander@2168
   302
	return pThread;
dvander@2168
   303
}