PxTaskManager.h

// This code contains NVIDIA Confidential Information and is disclosed to you
// under a form of NVIDIA software license agreement provided separately to you.
//
// Notice
// NVIDIA Corporation and its licensors retain all intellectual property and
// proprietary rights in and to this software and related documentation and
// any modifications thereto. Any use, reproduction, disclosure, or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA Corporation is strictly prohibited.
//
// ALL NVIDIA DESIGN SPECIFICATIONS, CODE ARE PROVIDED "AS IS.". NVIDIA MAKES
// NO WARRANTIES, EXPRESSED, IMPLIED, STATUTORY, OR OTHERWISE WITH RESPECT TO
// THE MATERIALS, AND EXPRESSLY DISCLAIMS ALL IMPLIED WARRANTIES OF NONINFRINGEMENT,
// MERCHANTABILITY, AND FITNESS FOR A PARTICULAR PURPOSE.
//
// Information and code furnished is believed to be accurate and reliable.
// However, NVIDIA Corporation assumes no responsibility for the consequences of use of such
// information or for any infringement of patents or other rights of third parties that may
// result from its use. No license is granted by implication or otherwise under any patent
// or patent rights of NVIDIA Corporation. Details are subject to change without notice.
// This code supersedes and replaces all information previously supplied.
// NVIDIA Corporation products are not authorized for use as critical
// components in life support devices or systems without express written approval of
// NVIDIA Corporation.
//
// Copyright (c) 2008-2013 NVIDIA Corporation. All rights reserved.

#ifndef PX_TASK_MANAGER_H
#define PX_TASK_MANAGER_H

#include "foundation/Px.h"

#ifndef PX_DOXYGEN
namespace physx
{
#endif

class PxProfileZoneManager;

PX_PUSH_PACK_DEFAULT

class PxBaseTask;
class PxTask;
class PxLightCpuTask;
class PxSpuTask;
typedef unsigned long PxTaskID;

struct PxTaskType
{
    enum Enum
    {
        TT_CPU,             
        TT_GPU,             
        TT_NOT_PRESENT,     
        TT_COMPLETED        
    };
};

class PxCpuDispatcher;
class PxSpuDispatcher;
class PxGpuDispatcher;

class PxTaskManager
{
public:

    virtual void     setCpuDispatcher(PxCpuDispatcher& ref) = 0;

    virtual void     setGpuDispatcher(PxGpuDispatcher& ref) = 0;
    
    virtual void     setSpuDispatcher(PxSpuDispatcher& ref) = 0;

    virtual void     initializeProfiling(PxProfileZoneManager& ref) = 0;

    virtual PxCpuDispatcher*            getCpuDispatcher() const = 0;

    virtual PxGpuDispatcher*            getGpuDispatcher() const = 0;

    virtual PxSpuDispatcher*            getSpuDispatcher() const = 0;

    virtual void    resetDependencies() = 0;
    
    virtual void    startSimulation() = 0;

    virtual void    stopSimulation() = 0;

    virtual void    taskCompleted(PxTask& task) = 0;

    virtual PxTaskID  getNamedTask(const char* name) = 0;

    virtual PxTaskID  submitNamedTask(PxTask* task, const char* name, PxTaskType::Enum type = PxTaskType::TT_CPU) = 0;

    virtual PxTaskID  submitUnnamedTask(PxTask& task, PxTaskType::Enum type = PxTaskType::TT_CPU) = 0;

    virtual PxTask*   getTaskFromID(PxTaskID id) = 0;

    virtual void        release() = 0;

    static PxTaskManager* createTaskManager(PxCpuDispatcher* = 0, PxGpuDispatcher* = 0, PxSpuDispatcher* = 0);
    
protected:
    virtual ~PxTaskManager() {}

    virtual void finishBefore(PxTask& task, PxTaskID taskID) = 0;
    virtual void startAfter(PxTask& task, PxTaskID taskID) = 0;

    virtual void addReference(PxTaskID taskID) = 0;
    virtual void decrReference(PxTaskID taskID) = 0;
    virtual PxI32 getReference(PxTaskID taskID) const = 0;

    virtual void decrReference(PxLightCpuTask&) = 0;
    virtual void addReference(PxLightCpuTask&) = 0;

    virtual void decrReference(PxSpuTask& spuTask) = 0;

    virtual void emitStartEvent(PxBaseTask&, PxU32 threadId=0) = 0;
    virtual void emitStopEvent(PxBaseTask&, PxU32 threadId=0) = 0;

    friend class PxBaseTask;
    friend class PxTask;
    friend class PxLightCpuTask;
    friend class PxSpuTask;
    friend class PxGpuWorkerThread;
};

PX_POP_PACK

#ifndef PX_DOXYGEN
} // end physx namespace
#endif

#endif