| 1 | // |
|---|
| 2 | // Redistribution and use in source and binary forms, with or without |
|---|
| 3 | // modification, are permitted provided that the following conditions |
|---|
| 4 | // are met: |
|---|
| 5 | // * Redistributions of source code must retain the above copyright |
|---|
| 6 | // notice, this list of conditions and the following disclaimer. |
|---|
| 7 | // * Redistributions in binary form must reproduce the above copyright |
|---|
| 8 | // notice, this list of conditions and the following disclaimer in the |
|---|
| 9 | // documentation and/or other materials provided with the distribution. |
|---|
| 10 | // * Neither the name of NVIDIA CORPORATION nor the names of its |
|---|
| 11 | // contributors may be used to endorse or promote products derived |
|---|
| 12 | // from this software without specific prior written permission. |
|---|
| 13 | // |
|---|
| 14 | // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ''AS IS'' AND ANY |
|---|
| 15 | // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
|---|
| 16 | // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR |
|---|
| 17 | // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR |
|---|
| 18 | // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, |
|---|
| 19 | // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, |
|---|
| 20 | // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR |
|---|
| 21 | // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY |
|---|
| 22 | // OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
|---|
| 23 | // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE |
|---|
| 24 | // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
|---|
| 25 | // |
|---|
| 26 | // Copyright (c) 2008-2021 NVIDIA Corporation. All rights reserved. |
|---|
| 27 | |
|---|
| 28 | #ifndef PXTASK_PXCPUDISPATCHER_H |
|---|
| 29 | #define PXTASK_PXCPUDISPATCHER_H |
|---|
| 30 | |
|---|
| 31 | #include "task/PxTaskDefine.h" |
|---|
| 32 | #include "foundation/PxSimpleTypes.h" |
|---|
| 33 | |
|---|
| 34 | namespace physx |
|---|
| 35 | { |
|---|
| 36 | |
|---|
| 37 | class PxBaseTask; |
|---|
| 38 | |
|---|
| 39 | /** |
|---|
| 40 | \brief A CpuDispatcher is responsible for scheduling the execution of tasks passed to it by the SDK. |
|---|
| 41 | |
|---|
| 42 | A typical implementation would for example use a thread pool with the dispatcher |
|---|
| 43 | pushing tasks onto worker thread queues or a global queue. |
|---|
| 44 | |
|---|
| 45 | @see PxBaseTask |
|---|
| 46 | @see PxTask |
|---|
| 47 | @see PxTaskManager |
|---|
| 48 | */ |
|---|
| 49 | class PxCpuDispatcher |
|---|
| 50 | { |
|---|
| 51 | public: |
|---|
| 52 | /** |
|---|
| 53 | \brief Called by the TaskManager when a task is to be queued for execution. |
|---|
| 54 | |
|---|
| 55 | Upon receiving a task, the dispatcher should schedule the task |
|---|
| 56 | to run when resource is available. After the task has been run, |
|---|
| 57 | it should call the release() method and discard it's pointer. |
|---|
| 58 | |
|---|
| 59 | \param[in] task The task to be run. |
|---|
| 60 | |
|---|
| 61 | @see PxBaseTask |
|---|
| 62 | */ |
|---|
| 63 | virtual void submitTask( PxBaseTask& task ) = 0; |
|---|
| 64 | |
|---|
| 65 | /** |
|---|
| 66 | \brief Returns the number of available worker threads for this dispatcher. |
|---|
| 67 | |
|---|
| 68 | The SDK will use this count to control how many tasks are submitted. By |
|---|
| 69 | matching the number of tasks with the number of execution units task |
|---|
| 70 | overhead can be reduced. |
|---|
| 71 | */ |
|---|
| 72 | virtual uint32_t getWorkerCount() const = 0; |
|---|
| 73 | |
|---|
| 74 | virtual ~PxCpuDispatcher() {} |
|---|
| 75 | }; |
|---|
| 76 | |
|---|
| 77 | } // end physx namespace |
|---|
| 78 | |
|---|
| 79 | #endif // PXTASK_PXCPUDISPATCHER_H |
|---|
| 80 | |
|---|
