src/BulletMultiThreaded/SequentialThreadSupport.h

   1 /*
   2 Bullet Continuous Collision Detection and Physics Library
   3 Copyright (c) 2003-2007 Erwin Coumans  http://bulletphysics.com
   4
   5 This software is provided 'as-is', without any express or implied warranty.
   6 In no event will the authors be held liable for any damages arising from the use of this software.
   7 Permission is granted to anyone to use this software for any purpose,
   8 including commercial applications, and to alter it and redistribute it freely,
   9 subject to the following restrictions:
  10
  11 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.
  12 2. Altered source versions must be plainly marked as such, and must not be misrepresented as being the original software.
  13 3. This notice may not be removed or altered from any source distribution.
  14 */
  15
  16 #include "LinearMath/btScalar.h"
  17 #include "PlatformDefinitions.h"
  18
  19
  20 #ifndef BT_SEQUENTIAL_THREAD_SUPPORT_H
  21 #define BT_SEQUENTIAL_THREAD_SUPPORT_H
  22
  23 #include "LinearMath/btAlignedObjectArray.h"
  24
  25 #include "btThreadSupportInterface.h"
  26
  27 typedef void (*SequentialThreadFunc)(void* userPtr,void* lsMemory);
  28 typedef void* (*SequentiallsMemorySetupFunc)();
  29
  30
  31
  32 ///The SequentialThreadSupport is a portable non-parallel implementation of the btThreadSupportInterface
  33 ///This is useful for debugging and porting SPU Tasks to other platforms.
  34 class SequentialThreadSupport : public btThreadSupportInterface
  35 {
  36 public:
  37         struct  btSpuStatus
  38         {
  39                 uint32_t        m_taskId;
  40                 uint32_t        m_commandId;
  41                 uint32_t        m_status;
  42
  43                 SequentialThreadFunc    m_userThreadFunc;
  44
  45                 void*   m_userPtr; //for taskDesc etc
  46                 void*   m_lsMemory; //initialized using SequentiallsMemorySetupFunc
  47         };
  48 private:
  49         btAlignedObjectArray<btSpuStatus>       m_activeSpuStatus;
  50         btAlignedObjectArray<void*>                     m_completeHandles;
  51 public:
  52         struct  SequentialThreadConstructionInfo
  53         {
  54                 SequentialThreadConstructionInfo (const char* uniqueName,
  55                                                                         SequentialThreadFunc userThreadFunc,
  56                                                                         SequentiallsMemorySetupFunc     lsMemoryFunc
  57                                                                         )
  58                                                                         :m_uniqueName(uniqueName),
  59                                                                         m_userThreadFunc(userThreadFunc),
  60                                                                         m_lsMemoryFunc(lsMemoryFunc)
  61                 {
  62
  63                 }
  64
  65                 const char*                                             m_uniqueName;
  66                 SequentialThreadFunc            m_userThreadFunc;
  67                 SequentiallsMemorySetupFunc     m_lsMemoryFunc;
  68         };
  69
  70         SequentialThreadSupport(SequentialThreadConstructionInfo& threadConstructionInfo);
  71         virtual ~SequentialThreadSupport();
  72         void    startThreads(SequentialThreadConstructionInfo&  threadInfo);
  73 ///send messages to SPUs
  74         virtual void sendRequest(uint32_t uiCommand, ppu_address_t uiArgument0, uint32_t uiArgument1);
  75 ///check for messages from SPUs
  76         virtual void waitForResponse(unsigned int *puiArgument0, unsigned int *puiArgument1);
  77 ///start the spus (can be called at the beginning of each frame, to make sure that the right SPU program is loaded)
  78         virtual void startSPU();
  79 ///tell the task scheduler we are done with the SPU tasks
  80         virtual void stopSPU();
  81
  82         virtual void setNumTasks(int numTasks);
  83
  84         virtual int getNumTasks() const
  85         {
  86                 return 1;
  87         }
  88         virtual btBarrier*      createBarrier();
  89
  90         virtual btCriticalSection* createCriticalSection();
  91
  92     virtual void deleteBarrier(btBarrier* barrier);
  93
  94     virtual void deleteCriticalSection(btCriticalSection* criticalSection);
  95
  96
  97 };
  98
  99 #endif //BT_SEQUENTIAL_THREAD_SUPPORT_H
 100