dvander@1084: /**
dvander@1084:  * vim: set ts=4 :
ds@1330:  * =============================================================================
dvander@1231:  * SourceMod
ds@1947:  * Copyright (C) 2004-2008 AlliedModders LLC.  All rights reserved.
ds@1330:  * =============================================================================
dvander@1084:  *
ds@1330:  * This program is free software; you can redistribute it and/or modify it under
ds@1330:  * the terms of the GNU General Public License, version 3.0, as published by the
ds@1330:  * Free Software Foundation.
dvander@1231:  * 
ds@1330:  * This program is distributed in the hope that it will be useful, but WITHOUT
ds@1330:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
ds@1330:  * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
ds@1330:  * details.
dvander@1231:  *
ds@1330:  * You should have received a copy of the GNU General Public License along with
ds@1330:  * this program.  If not, see <http://www.gnu.org/licenses/>.
dvander@1231:  *
ds@1330:  * As a special exception, AlliedModders LLC gives you permission to link the
ds@1330:  * code of this program (as well as its derivative works) to "Half-Life 2," the
ds@1330:  * "Source Engine," the "SourcePawn JIT," and any Game MODs that run on software
ds@1330:  * by the Valve Corporation.  You must obey the GNU General Public License in
ds@1330:  * all respects for all other code used.  Additionally, AlliedModders LLC grants
ds@1330:  * this exception to all derivative works.  AlliedModders LLC defines further
ds@1330:  * exceptions, found in LICENSE.txt (as of this writing, version JULY-31-2007),
ds@1330:  * or <http://www.sourcemod.net/license.php>.
dvander@1084:  *
dvander@1084:  * Version: $Id$
dvander@1084:  */
dvander@1084: 
dvander@1084: #include <unistd.h>
dvander@1084: #include "PosixThreads.h"
dvander@1084: #include "ThreadWorker.h"
dvander@1084: 
dvander@1090: IThreadWorker *PosixThreader::MakeWorker(IThreadWorkerCallbacks *hooks, bool threaded)
dvander@1084: {
dvander@1084: 	if (threaded)
dvander@1084: 	{
dvander@1090: 		return new ThreadWorker(hooks, this, DEFAULT_THINK_TIME_MS);
dvander@1084: 	} else {
dvander@1090: 		return new BaseWorker(hooks);
dvander@1084: 	}
dvander@1084: }
dvander@1084: 
dvander@1084: void PosixThreader::DestroyWorker(IThreadWorker *pWorker)
dvander@1084: {
dvander@1084: 	delete pWorker;
dvander@1084: }
dvander@1084: 
dvander@1084: void PosixThreader::ThreadSleep(unsigned int ms)
dvander@1084: {
dvander@1084: 	usleep( ms * 1000 );
dvander@1084: }
dvander@1084: 
dvander@1084: void PosixThreader::GetPriorityBounds(ThreadPriority &max, ThreadPriority &min)
dvander@1084: {
dvander@1084: 	max = ThreadPrio_Normal;
dvander@1084: 	min = ThreadPrio_Normal;
dvander@1084: }
dvander@1084: 
dvander@1084: IMutex *PosixThreader::MakeMutex()
dvander@1084: {
dvander@1084: 	pthread_mutex_t mutex;
dvander@1084: 
dvander@1084: 	if (pthread_mutex_init(&mutex, NULL) != 0)
dvander@1084: 		return NULL;
dvander@1084: 
dvander@1084: 	PosixMutex *pMutex = new PosixMutex(mutex);
dvander@1084: 
dvander@1084: 	return pMutex;
dvander@1084: }
dvander@1084: 
dvander@1084: 
dvander@1084: void PosixThreader::MakeThread(IThread *pThread)
dvander@1084: {
dvander@1084: 	ThreadParams defparams;
dvander@1084: 
dvander@1084: 	defparams.flags = Thread_AutoRelease;
dvander@1084: 	defparams.prio = ThreadPrio_Normal;
dvander@1084: 
dvander@1084: 	MakeThread(pThread, &defparams);
dvander@1084: }
dvander@1084: 
dvander@1084: IThreadHandle *PosixThreader::MakeThread(IThread *pThread, ThreadFlags flags)
dvander@1084: {
dvander@1084: 	ThreadParams defparams;
dvander@1084: 
dvander@1084: 	defparams.flags = flags;
dvander@1084: 	defparams.prio = ThreadPrio_Normal;
dvander@1084: 
dvander@1084: 	return MakeThread(pThread, &defparams);
dvander@1084: }
dvander@1084: 
dvander@1084: void *Posix_ThreadGate(void *param)
dvander@1084: {
dvander@1084: 	PosixThreader::ThreadHandle *pHandle = 
dvander@1084: 		reinterpret_cast<PosixThreader::ThreadHandle *>(param);
dvander@1084: 
dvander@1084: 	//Block this thread from being started initially.
dvander@1084: 	pthread_mutex_lock(&pHandle->m_runlock);
dvander@1084: 	//if we get here, we've obtained the lock and are allowed to run.
dvander@1084: 	//unlock and continue.
dvander@1084: 	pthread_mutex_unlock(&pHandle->m_runlock);
dvander@1084: 
dvander@1084: 	pHandle->m_run->RunThread(pHandle);
dvander@1084: 
dvander@1084: 	ThreadParams params;
dvander@1084: 	pthread_mutex_lock(&pHandle->m_statelock);
dvander@1084: 	pHandle->m_state = Thread_Done;
dvander@1084: 	pHandle->GetParams(&params);
dvander@1084: 	pthread_mutex_unlock(&pHandle->m_statelock);
dvander@1084: 
dvander@1084: 	pHandle->m_run->OnTerminate(pHandle, false);
dvander@1084: 	if (params.flags & Thread_AutoRelease)
dvander@1084: 		delete pHandle;
dvander@1084: 
dvander@1084: 	return 0;
dvander@1084: }
dvander@1084: 
dvander@1084: ThreadParams g_defparams;
dvander@1084: IThreadHandle *PosixThreader::MakeThread(IThread *pThread, const ThreadParams *params)
dvander@1084: {
dvander@1084: 	if (params == NULL)
dvander@1084: 		params = &g_defparams;
dvander@1084: 
dvander@1084: 	PosixThreader::ThreadHandle *pHandle = 
dvander@1084: 		new PosixThreader::ThreadHandle(this, pThread, params);
dvander@1084: 
dvander@1084: 	pthread_mutex_lock(&pHandle->m_runlock);
dvander@1084: 
dvander@1084: 	int err;
dvander@1084: 	err = pthread_create(&pHandle->m_thread, NULL, Posix_ThreadGate, (void *)pHandle);	
dvander@1084: 
dvander@1084: 	if (err != 0)
dvander@1084: 	{
dvander@1084: 		pthread_mutex_unlock(&pHandle->m_runlock);
dvander@1084: 		delete pHandle;
dvander@1084: 		return NULL;
dvander@1084: 	}
dvander@1084: 
dvander@1084: 	//Don't bother setting priority...
dvander@1084: 
dvander@1084: 	if (!(pHandle->m_params.flags & Thread_CreateSuspended))
dvander@1084: 	{
dvander@1084: 		pHandle->m_state = Thread_Running;
dvander@1084: 		err = pthread_mutex_unlock(&pHandle->m_runlock);
dvander@1084: 		if (err != 0)
dvander@1084: 			pHandle->m_state = Thread_Paused;
dvander@1084: 	}
dvander@1084: 
dvander@1084: 	return pHandle;
dvander@1084: }
dvander@1084: 
dvander@1084: IEventSignal *PosixThreader::MakeEventSignal()
dvander@1084: {
dvander@1084: 	return new PosixEventSignal();
dvander@1084: }
dvander@1084: 
dvander@1084: /*****************
dvander@1084: **** Mutexes ****
dvander@1084: *****************/
dvander@1084: 
dvander@1084: PosixThreader::PosixMutex::~PosixMutex()
dvander@1084: {
dvander@1084: 	pthread_mutex_destroy(&m_mutex);
dvander@1084: }
dvander@1084: 
dvander@1084: bool PosixThreader::PosixMutex::TryLock()
dvander@1084: {
dvander@1084: 	int err = pthread_mutex_trylock(&m_mutex);
dvander@1084: 
dvander@1084: 	return (err == 0);
dvander@1084: }
dvander@1084: 
dvander@1084: void PosixThreader::PosixMutex::Lock()
dvander@1084: {
dvander@1084: 	pthread_mutex_lock(&m_mutex);
dvander@1084: }
dvander@1084: 
dvander@1084: void PosixThreader::PosixMutex::Unlock()
dvander@1084: {
dvander@1084: 	pthread_mutex_unlock(&m_mutex);
dvander@1084: }
dvander@1084: 
dvander@1084: void PosixThreader::PosixMutex::DestroyThis()
dvander@1084: {
dvander@1084: 	delete this;
dvander@1084: }
dvander@1084: 
dvander@1084: /******************
dvander@1084: * Thread Handles *
dvander@1084: ******************/
dvander@1084: 
dvander@1084: PosixThreader::ThreadHandle::ThreadHandle(IThreader *parent, IThread *run, const ThreadParams *params) : 
dvander@1084: 	m_parent(parent), m_params(*params), m_run(run), m_state(Thread_Paused)
dvander@1084: {
dvander@1084: 	pthread_mutex_init(&m_runlock, NULL);
dvander@1084: 	pthread_mutex_init(&m_statelock, NULL);
dvander@1084: }
dvander@1084: 
dvander@1084: PosixThreader::ThreadHandle::~ThreadHandle()
dvander@1084: {
dvander@1084: 	pthread_mutex_destroy(&m_runlock);
dvander@1084: 	pthread_mutex_destroy(&m_statelock);
dvander@1084: }
dvander@1084: 
dvander@1084: bool PosixThreader::ThreadHandle::WaitForThread()
dvander@1084: {
dvander@1084: 	void *arg;
dvander@1084: 	
dvander@1084: 	if (pthread_join(m_thread, &arg) != 0)
dvander@1084: 		return false;
dvander@1084: 
dvander@1084: 	return true;
dvander@1084: }
dvander@1084: 
dvander@1084: ThreadState PosixThreader::ThreadHandle::GetState()
dvander@1084: {
dvander@1084: 	ThreadState state;
dvander@1084: 
dvander@1084: 	pthread_mutex_lock(&m_statelock);
dvander@1084: 	state = m_state;
dvander@1084: 	pthread_mutex_unlock(&m_statelock);
dvander@1084: 
dvander@1084: 	return state;
dvander@1084: }
dvander@1084: 
dvander@1084: IThreadCreator *PosixThreader::ThreadHandle::Parent()
dvander@1084: {
dvander@1084: 	return m_parent;
dvander@1084: }
dvander@1084: 
dvander@1084: void PosixThreader::ThreadHandle::DestroyThis()
dvander@1084: {
dvander@1084: 	if (m_params.flags & Thread_AutoRelease)
dvander@1084: 		return;
dvander@1084: 
dvander@1084: 	delete this;
dvander@1084: }
dvander@1084: 
dvander@1084: void PosixThreader::ThreadHandle::GetParams(ThreadParams *ptparams)
dvander@1084: {
dvander@1084: 	if (!ptparams)
dvander@1084: 		return;
dvander@1084: 
dvander@1084: 	*ptparams = m_params;
dvander@1084: }
dvander@1084: 
dvander@1084: ThreadPriority PosixThreader::ThreadHandle::GetPriority()
dvander@1084: {
dvander@1084: 	return ThreadPrio_Normal;
dvander@1084: }
dvander@1084: 
dvander@1084: bool PosixThreader::ThreadHandle::SetPriority(ThreadPriority prio)
dvander@1084: {
dvander@1084: 	return (prio == ThreadPrio_Normal);
dvander@1084: }
dvander@1084: 
dvander@1084: bool PosixThreader::ThreadHandle::Unpause()
dvander@1084: {
dvander@1084: 	if (m_state != Thread_Paused)
dvander@1084: 		return false;
dvander@1084: 
dvander@1084: 	m_state = Thread_Running;
dvander@1084: 
dvander@1084: 	if (pthread_mutex_unlock(&m_runlock) != 0)
dvander@1084: 	{
dvander@1084: 		m_state = Thread_Paused;
dvander@1084: 		return false;
dvander@1084: 	}
dvander@1084: 
dvander@1084: 	return true;
dvander@1084: }
dvander@1084: 
dvander@1084: /*****************
dvander@1084:  * EVENT SIGNALS *
dvander@1084:  *****************/
dvander@1084: 
dvander@1084: PosixThreader::PosixEventSignal::PosixEventSignal()
dvander@1084: {
dvander@1084: 	pthread_cond_init(&m_cond, NULL);
dvander@1084: 	pthread_mutex_init(&m_mutex, NULL);
dvander@1084: }
dvander@1084: 
dvander@1084: PosixThreader::PosixEventSignal::~PosixEventSignal()
dvander@1084: {
dvander@1084: 	pthread_cond_destroy(&m_cond);
dvander@1084: 	pthread_mutex_destroy(&m_mutex);
dvander@1084: }
dvander@1084: 
dvander@1084: void PosixThreader::PosixEventSignal::Wait()
dvander@1084: {
dvander@1084: 	pthread_mutex_lock(&m_mutex);
dvander@1084: 	pthread_cond_wait(&m_cond, &m_mutex);
dvander@1084: 	pthread_mutex_unlock(&m_mutex);
dvander@1084: }
dvander@1084: 
dvander@1084: void PosixThreader::PosixEventSignal::Signal()
dvander@1084: {
dvander@1084: 	pthread_mutex_lock(&m_mutex);
dvander@1084: 	pthread_cond_broadcast(&m_cond);
dvander@1084: 	pthread_mutex_unlock(&m_mutex);
dvander@1084: }
dvander@1084: 
dvander@1084: void PosixThreader::PosixEventSignal::DestroyThis()
dvander@1084: {
dvander@1084:         delete this;
dvander@1084: }