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