dvander@1084: /**
dvander@1084:  * vim: set ts=4 :
dvander@1231:  * ================================================================
dvander@1231:  * SourceMod
dvander@1231:  * Copyright (C) 2004-2007 AlliedModders LLC.  All rights reserved.
dvander@1231:  * ================================================================
dvander@1084:  *
dvander@1231:  * This program is free software; you can redistribute it and/or 
dvander@1231:  * modify it under the terms of the GNU General Public License, 
dvander@1231:  * version 3.0, as published by the Free Software Foundation.
dvander@1231:  * 
dvander@1231:  * This program is distributed in the hope that it will be useful,
dvander@1231:  * but WITHOUT ANY WARRANTY; without even the implied warranty of
dvander@1231:  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
dvander@1231:  * GNU General Public License for more details.
dvander@1231:  *
dvander@1231:  * You should have received a copy of the GNU General Public License
dvander@1231:  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
dvander@1231:  *
dvander@1231:  * As a special exception, AlliedModders LLC gives you permission to 
dvander@1231:  * link the code of this program (as well as its derivative works) to 
dvander@1231:  * "Half-Life 2," the "Source Engine," the "SourcePawn JIT," and any 
dvander@1231:  * Game MODs that run on software by the Valve Corporation.  You must 
dvander@1231:  * obey the GNU General Public License in all respects for all other 
dvander@1231:  * code used. Additionally, AlliedModders LLC grants this exception 
dvander@1231:  * to all derivative works. AlliedModders LLC defines further 
dvander@1231:  * exceptions, found in LICENSE.txt (as of this writing, version 
dvander@1231:  * JULY-31-2007), or <http://www.sourcemod.net/license.php>.
dvander@1084:  *
dvander@1084:  * Version: $Id$
dvander@1084:  */
dvander@1084: 
dvander@1084: #include "ThreadWorker.h"
dvander@1084: 
dvander@1090: ThreadWorker::ThreadWorker(IThreadWorkerCallbacks *hooks) : BaseWorker(hooks),
dvander@1084: 	m_Threader(NULL),
dvander@1084: 	m_QueueLock(NULL),
dvander@1084: 	m_StateLock(NULL),
dvander@1084: 	m_PauseSignal(NULL),
dvander@1084: 	m_AddSignal(NULL),
dvander@1084: 	me(NULL),
dvander@1084: 	m_think_time(DEFAULT_THINK_TIME_MS)
dvander@1084: {
dvander@1084: 	m_state = Worker_Invalid;
dvander@1084: }
dvander@1084: 
dvander@1090: ThreadWorker::ThreadWorker(IThreadWorkerCallbacks *hooks, IThreader *pThreader, unsigned int thinktime) : 
dvander@1090: 	BaseWorker(hooks),
dvander@1084: 	m_Threader(pThreader),
dvander@1084: 	m_QueueLock(NULL),
dvander@1084: 	m_StateLock(NULL),
dvander@1084: 	m_PauseSignal(NULL),
dvander@1084: 	m_AddSignal(NULL),
dvander@1084: 	me(NULL),
dvander@1084: 	m_think_time(thinktime)
dvander@1084: {
dvander@1084: 	if (m_Threader)
dvander@1084: 	{
dvander@1084: 		m_state = Worker_Stopped;
dvander@1084: 	} else {
dvander@1084: 		m_state = Worker_Invalid;
dvander@1084: 	}
dvander@1084: }
dvander@1084: 
dvander@1084: ThreadWorker::~ThreadWorker()
dvander@1084: {
dvander@1084: 	if (m_state != Worker_Stopped || m_state != Worker_Invalid)
dvander@1090: 	{
dvander@1084: 		Stop(true);
dvander@1090: 	}
dvander@1084: 
dvander@1084: 	if (m_ThreadQueue.size())
dvander@1090: 	{
dvander@1084: 		Flush(true);
dvander@1090: 	}
dvander@1084: }
dvander@1084: 
dvander@1084: void ThreadWorker::OnTerminate(IThreadHandle *pHandle, bool cancel)
dvander@1084: {
dvander@1084: 	//we don't particularly care
dvander@1084: 	return;
dvander@1084: }
dvander@1084: 
dvander@1084: void ThreadWorker::RunThread(IThreadHandle *pHandle)
dvander@1084: {
dvander@1084: 	WorkerState this_state = Worker_Running;
dvander@1084: 	size_t num;
dvander@1090: 
dvander@1090: 	if (m_pHooks)
dvander@1090: 	{
dvander@1090: 		m_pHooks->OnWorkerStart(this);
dvander@1090: 	}
dvander@1084:     
dvander@1084: 	while (true)
dvander@1084: 	{
dvander@1084: 		/**
dvander@1084: 		 * Check number of items in the queue
dvander@1084: 		 */
dvander@1084: 		m_StateLock->Lock();
dvander@1084: 		this_state = m_state;
dvander@1084: 		m_StateLock->Unlock();
dvander@1084: 		if (this_state != Worker_Stopped)
dvander@1084: 		{
dvander@1084: 			m_QueueLock->Lock();
dvander@1084: 			num = m_ThreadQueue.size();
dvander@1084: 			if (!num)
dvander@1084: 			{
dvander@1084: 				/** 
dvander@1084: 				 * if none, wait for an item
dvander@1084: 				 */
dvander@1084: 				m_Waiting = true;
dvander@1084: 				m_QueueLock->Unlock();
dvander@1084: 				/* first check if we should end again */
dvander@1084: 				if (this_state == Worker_Stopped)
dvander@1084: 				{
dvander@1084: 					break;
dvander@1084: 				}
dvander@1084: 				m_AddSignal->Wait();
dvander@1084: 				m_Waiting = false;
dvander@1084: 			} else {
dvander@1084: 				m_QueueLock->Unlock();
dvander@1084: 			}
dvander@1084: 		}
dvander@1084: 		m_StateLock->Lock();
dvander@1084: 		this_state = m_state;
dvander@1084: 		m_StateLock->Unlock();
dvander@1084: 		if (this_state != Worker_Running)
dvander@1084: 		{
dvander@1084: 			if (this_state == Worker_Paused || this_state == Worker_Stopped)
dvander@1084: 			{
dvander@1084: 				//wait until the lock is cleared.
dvander@1084: 				if (this_state == Worker_Paused)
dvander@1084: 				{
dvander@1084: 					m_PauseSignal->Wait();
dvander@1084: 				}
dvander@1084: 				if (this_state == Worker_Stopped)
dvander@1084: 				{
dvander@1084: 					//if we're supposed to flush cleanrly, 
dvander@1084: 					// run all of the remaining frames first.
dvander@1084: 					if (!m_FlushType)
dvander@1084: 					{
dvander@1084: 						while (m_ThreadQueue.size())
dvander@1090: 						{
dvander@1084: 							RunFrame();
dvander@1090: 						}
dvander@1084: 					}
dvander@1084: 					break;
dvander@1084: 				}
dvander@1084: 			}
dvander@1084: 		}
dvander@1084: 		/**
dvander@1084: 		 * Run the frame.
dvander@1084: 		 */
dvander@1084: 		RunFrame();
dvander@1084: 
dvander@1084: 		/**
dvander@1084: 		 * wait in between threads if specified
dvander@1084: 		 */
dvander@1084: 		if (m_think_time)
dvander@1090: 		{
dvander@1084: 			m_Threader->ThreadSleep(m_think_time);
dvander@1090: 		}
dvander@1090: 	}
dvander@1090: 
dvander@1090: 	if (m_pHooks)
dvander@1090: 	{
dvander@1090: 		m_pHooks->OnWorkerStop(this);
dvander@1084: 	}
dvander@1084: }
dvander@1084: 
dvander@1084: SWThreadHandle *ThreadWorker::PopThreadFromQueue()
dvander@1084: {
dvander@1084: 	if (m_state <= Worker_Stopped && !m_QueueLock)
dvander@1090: 	{
dvander@1084: 		return NULL;
dvander@1090: 	}
dvander@1084: 
dvander@1084: 	SWThreadHandle *swt;
dvander@1084: 	m_QueueLock->Lock();
dvander@1084: 	swt = BaseWorker::PopThreadFromQueue();
dvander@1084: 	m_QueueLock->Unlock();
dvander@1084: 
dvander@1084: 	return swt;
dvander@1084: }
dvander@1084: 
dvander@1084: void ThreadWorker::AddThreadToQueue(SWThreadHandle *pHandle)
dvander@1084: {
dvander@1084: 	if (m_state <= Worker_Stopped)
dvander@1090: 	{
dvander@1084: 		return;
dvander@1090: 	}
dvander@1084: 
dvander@1084: 	m_QueueLock->Lock();
dvander@1084: 	BaseWorker::AddThreadToQueue(pHandle);
dvander@1084: 	if (m_Waiting)
dvander@1084: 	{
dvander@1084: 		m_AddSignal->Signal();
dvander@1084: 	}
dvander@1084: 	m_QueueLock->Unlock();
dvander@1084: }
dvander@1084: 
dvander@1084: WorkerState ThreadWorker::GetStatus(unsigned int *threads)
dvander@1084: {
dvander@1084: 	WorkerState state;
dvander@1084: 
dvander@1084: 	m_StateLock->Lock();
dvander@1084: 	state = BaseWorker::GetStatus(threads);
dvander@1084: 	m_StateLock->Unlock();
dvander@1084: 
dvander@1084: 	return state;
dvander@1084: }
dvander@1084: 
dvander@1084: bool ThreadWorker::Start()
dvander@1084: {
dvander@1084: 	if (m_state == Worker_Invalid)
dvander@1084: 	{
dvander@1084: 		if (m_Threader == NULL)
dvander@1090: 		{
dvander@1084: 			return false;
dvander@1090: 		}
dvander@1084: 	} else if (m_state != Worker_Stopped) {
dvander@1084: 		return false;
dvander@1084: 	}
dvander@1084: 
dvander@1084: 	m_Waiting = false;
dvander@1084: 	m_QueueLock = m_Threader->MakeMutex();
dvander@1084: 	m_StateLock = m_Threader->MakeMutex();
dvander@1084: 	m_PauseSignal = m_Threader->MakeEventSignal();
dvander@1084: 	m_AddSignal = m_Threader->MakeEventSignal();
dvander@1084: 	m_state = Worker_Running;
dvander@1084: 	ThreadParams pt;
dvander@1084: 	pt.flags = Thread_Default;
dvander@1084: 	pt.prio = ThreadPrio_Normal;
dvander@1084: 	me = m_Threader->MakeThread(this, &pt);
dvander@1084: 
dvander@1084: 	return true;
dvander@1084: }
dvander@1084: 
dvander@1084: bool ThreadWorker::Stop(bool flush_cancel)
dvander@1084: {
dvander@1084: 	if (m_state == Worker_Invalid || m_state == Worker_Stopped)
dvander@1090: 	{
dvander@1084: 		return false;
dvander@1090: 	}
dvander@1084: 
dvander@1084: 	WorkerState oldstate;
dvander@1084: 
dvander@1084: 	//set new state
dvander@1084: 	m_StateLock->Lock();
dvander@1084: 	oldstate = m_state;
dvander@1084: 	m_state = Worker_Stopped;
dvander@1084: 	m_FlushType = flush_cancel;
dvander@1084: 	m_StateLock->Unlock();
dvander@1084: 
dvander@1084: 	if (oldstate == Worker_Paused)
dvander@1084: 	{
dvander@1084: 		Unpause();
dvander@1084: 	} else {
dvander@1084: 		m_QueueLock->Lock();
dvander@1084: 		if (m_Waiting)
dvander@1084: 		{
dvander@1084: 			m_AddSignal->Signal();
dvander@1084: 		}
dvander@1084: 		m_QueueLock->Unlock();
dvander@1084: 	}
dvander@1084: 
dvander@1084: 	me->WaitForThread();
dvander@1084: 	//destroy it
dvander@1084: 	me->DestroyThis();
dvander@1084: 	//flush all remaining events
dvander@1084: 	Flush(true);
dvander@1084: 
dvander@1084: 	//free mutex locks
dvander@1084: 	m_QueueLock->DestroyThis();
dvander@1084: 	m_StateLock->DestroyThis();
dvander@1084: 	m_PauseSignal->DestroyThis();
dvander@1084: 	m_AddSignal->DestroyThis();
dvander@1084: 
dvander@1084: 	//invalidizzle
dvander@1084: 	m_QueueLock = NULL;
dvander@1084: 	m_StateLock = NULL;
dvander@1084: 	m_PauseSignal = NULL;
dvander@1084: 	m_AddSignal = NULL;
dvander@1084: 	me = NULL;
dvander@1084: 
dvander@1084: 	return true;
dvander@1084: }
dvander@1084: 
dvander@1084: bool ThreadWorker::Pause()
dvander@1084: {
dvander@1084: 	if (m_state != Worker_Running)
dvander@1090: 	{
dvander@1084: 		return false;
dvander@1090: 	}
dvander@1084: 
dvander@1084: 	m_StateLock->Lock();
dvander@1084: 	m_state = Worker_Paused;
dvander@1084: 	m_StateLock->Unlock();
dvander@1084: 
dvander@1084: 	return true;
dvander@1084: }
dvander@1084: 
dvander@1084: 
dvander@1084: bool ThreadWorker::Unpause()
dvander@1084: {
dvander@1084: 	if (m_state != Worker_Paused)
dvander@1090: 	{
dvander@1084: 		return false;
dvander@1090: 	}
dvander@1084: 
dvander@1084: 	m_StateLock->Lock();
dvander@1084: 	m_state = Worker_Running;
dvander@1084: 	m_StateLock->Unlock();
dvander@1084: 	m_PauseSignal->Signal();
dvander@1084: 	if (m_Waiting)
dvander@1084: 	{
dvander@1084: 		m_AddSignal->Signal();
dvander@1084: 	}
dvander@1084: 
dvander@1084: 	return true;
dvander@1084: }