Torque3D/Engine/lib/bullet/examples/MultiThreading/b3Win32ThreadSupport.h

/*
Bullet Continuous Collision Detection and Physics Library
Copyright (c) 2003-2007 Erwin Coumans  http://bulletphysics.com

This software is provided 'as-is', without any express or implied warranty.
In no event will the authors be held liable for any damages arising from the use of this software.
Permission is granted to anyone to use this software for any purpose, 
including commercial applications, and to alter it and redistribute it freely, 
subject to the following restrictions:

1. The origin of this software must not be misrepresented; you must not claim that you wrote the original software. If you use this software in a product, an acknowledgment in the product documentation would be appreciated but is not required.
2. Altered source versions must be plainly marked as such, and must not be misrepresented as being the original software.
3. This notice may not be removed or altered from any source distribution.
*/

#include "Bullet3Common/b3Scalar.h"

#ifndef BT_WIN32_THREAD_SUPPORT_H
#define BT_WIN32_THREAD_SUPPORT_H

#include "Bullet3Common/b3AlignedObjectArray.h"

#include "b3ThreadSupportInterface.h"

typedef void (*b3Win32ThreadFunc)(void* userPtr, void* lsMemory);
typedef void* (*b3Win32lsMemorySetupFunc)();
typedef void (*b3Win32lsMemoryReleaseFunc)(void*);

///b3Win32ThreadSupport helps to initialize/shutdown libspe2, start/stop SPU tasks and communication
class b3Win32ThreadSupport : public b3ThreadSupportInterface
{
public:
	///placeholder, until libspe2 support is there
	struct b3ThreadStatus
	{
		int m_taskId;
		int m_commandId;
		int m_status;

		b3Win32ThreadFunc m_userThreadFunc;
		void* m_userPtr;   //for taskDesc etc
		void* m_lsMemory;  //initialized using Win32LocalStoreMemorySetupFunc

		b3Win32lsMemoryReleaseFunc m_lsMemoryReleaseFunc;

		void* m_threadHandle;  //this one is calling 'Win32ThreadFunc'

		void* m_eventStartHandle;
		char m_eventStartHandleName[32];

		void* m_eventCompletetHandle;
		char m_eventCompletetHandleName[32];
	};

private:
	b3AlignedObjectArray<b3ThreadStatus> m_activeThreadStatus;
	b3AlignedObjectArray<void*> m_completeHandles;

	int m_maxNumTasks;

public:
	///Setup and initialize SPU/CELL/Libspe2

	struct Win32ThreadConstructionInfo
	{
		Win32ThreadConstructionInfo(const char* uniqueName,
									b3Win32ThreadFunc userThreadFunc,
									b3Win32lsMemorySetupFunc lsMemoryFunc,
									b3Win32lsMemoryReleaseFunc lsMemoryReleaseFunc,
									int numThreads = 1,
									int threadStackSize = 65535)
			: m_uniqueName(uniqueName),
			  m_userThreadFunc(userThreadFunc),
			  m_lsMemoryFunc(lsMemoryFunc),
			  m_lsMemoryReleaseFunc(lsMemoryReleaseFunc),
			  m_numThreads(numThreads),
			  m_threadStackSize(threadStackSize),
			  m_priority(0)
		{
		}

		const char* m_uniqueName;
		b3Win32ThreadFunc m_userThreadFunc;
		b3Win32lsMemorySetupFunc m_lsMemoryFunc;
		b3Win32lsMemoryReleaseFunc m_lsMemoryReleaseFunc;
		int m_numThreads;
		int m_threadStackSize;
		int m_priority;
	};

	b3Win32ThreadSupport(const Win32ThreadConstructionInfo& threadConstructionInfo);

	///cleanup/shutdown Libspe2
	virtual ~b3Win32ThreadSupport();

	void startThreads(const Win32ThreadConstructionInfo& threadInfo);

	///send messages to SPUs
	virtual void runTask(int uiCommand, void* uiArgument0, int uiArgument1);

	///check for messages from SPUs
	virtual void waitForResponse(int* puiArgument0, int* puiArgument1);

	virtual bool isTaskCompleted(int* puiArgument0, int* puiArgument1, int timeOutInMilliseconds);

	///start the spus (can be called at the beginning of each frame, to make sure that the right SPU program is loaded)
	virtual void startThreads();

	///tell the task scheduler we are done with the SPU tasks
	virtual void stopThreads();

	virtual void setNumTasks(int numTasks)
	{
		m_maxNumTasks = numTasks;
	}

	virtual int getNumTasks() const
	{
		return m_maxNumTasks;
	}

	virtual void* getThreadLocalMemory(int taskId)
	{
		return m_activeThreadStatus[taskId].m_lsMemory;
	}
	virtual b3Barrier* createBarrier();

	virtual b3CriticalSection* createCriticalSection();

	virtual void deleteBarrier(b3Barrier* barrier);

	virtual void deleteCriticalSection(b3CriticalSection* criticalSection);
};

#endif  //BT_WIN32_THREAD_SUPPORT_H