PxCudaContextManager.h

Go to the documentation of this file.

//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions
// are met:
//  * Redistributions of source code must retain the above copyright
//    notice, this list of conditions and the following disclaimer.
//  * Redistributions in binary form must reproduce the above copyright
//    notice, this list of conditions and the following disclaimer in the
//    documentation and/or other materials provided with the distribution.
//  * Neither the name of NVIDIA CORPORATION nor the names of its
//    contributors may be used to endorse or promote products derived
//    from this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ''AS IS'' AND ANY
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
// OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Copyright (c) 2008-2021 NVIDIA Corporation. All rights reserved.


#ifndef PXCUDACONTEXTMANAGER_PXCUDACONTEXTMANAGER_H
#define PXCUDACONTEXTMANAGER_PXCUDACONTEXTMANAGER_H

#include "foundation/PxPreprocessor.h"

#if PX_SUPPORT_GPU_PHYSX

#include "foundation/PxSimpleTypes.h"
#include "foundation/PxErrorCallback.h"
#include "foundation/PxFlags.h"
#include "task/PxTaskDefine.h"
#include "cudamanager/PxCudaMemoryManager.h"

/* Forward decl to avoid inclusion of cuda.h */
typedef struct CUctx_st *CUcontext;
typedef struct CUgraphicsResource_st *CUgraphicsResource;
typedef int CUdevice;

namespace physx
{ 
    
struct PxCudaInteropMode
{
    enum Enum
    {
        NO_INTEROP = 0,
        D3D10_INTEROP,
        D3D11_INTEROP,
        OGL_INTEROP,

        COUNT
    };
};

struct PxCudaInteropRegisterFlag
{
    enum Enum
    {
        eNONE           = 0x00,
        eREAD_ONLY      = 0x01,
        eWRITE_DISCARD  = 0x02,
        eSURFACE_LDST   = 0x04,
        eTEXTURE_GATHER = 0x08
    };
};

typedef PxFlags<PxCudaInteropRegisterFlag::Enum, uint32_t> PxCudaInteropRegisterFlags;
PX_FLAGS_OPERATORS(PxCudaInteropRegisterFlag::Enum, uint32_t)

class PxCudaContextManagerDesc
{
public:
    CUcontext            *ctx;

    void                 *graphicsDevice;

#if PX_SUPPORT_GPU_PHYSX

    const char*          appGUID;
#endif

    PxCudaInteropMode::Enum interopMode;


    uint32_t    memoryBaseSize[PxCudaBufferMemorySpace::COUNT];

    uint32_t    memoryPageSize[PxCudaBufferMemorySpace::COUNT];

    uint32_t    maxMemorySize[PxCudaBufferMemorySpace::COUNT];

    PX_INLINE PxCudaContextManagerDesc()
    {
        ctx = NULL;
        interopMode = PxCudaInteropMode::NO_INTEROP;
        graphicsDevice = 0;
#if PX_SUPPORT_GPU_PHYSX
        appGUID  = NULL;
#endif
        for(uint32_t i = 0; i < PxCudaBufferMemorySpace::COUNT; i++)
        {
            memoryBaseSize[i] = 0;
            memoryPageSize[i] = 2 * 1024*1024;
            maxMemorySize[i] = UINT32_MAX;
        }
    }
};


class PxCudaContextManager
{
public:
    virtual void acquireContext() = 0;

    virtual void releaseContext() = 0;

    virtual CUcontext getContext() = 0;

    virtual PxCudaMemoryManager *getMemoryManager() = 0;

    virtual bool contextIsValid() const = 0;

    /* Query CUDA context and device properties, without acquiring context */

    virtual bool supportsArchSM10() const = 0;  
    virtual bool supportsArchSM11() const = 0;  
    virtual bool supportsArchSM12() const = 0;  
    virtual bool supportsArchSM13() const = 0;  
    virtual bool supportsArchSM20() const = 0;  
    virtual bool supportsArchSM30() const = 0;  
    virtual bool supportsArchSM35() const = 0;  
    virtual bool supportsArchSM50() const = 0;  
    virtual bool supportsArchSM52() const = 0;  
    virtual bool supportsArchSM60() const = 0;  
    virtual bool isIntegrated() const = 0;      
    virtual bool canMapHostMemory() const = 0;  
    virtual int  getDriverVersion() const = 0;  
    virtual size_t getDeviceTotalMemBytes() const = 0; 
    virtual int getMultiprocessorCount() const = 0; 
    virtual unsigned int getClockRate() const = 0; 
    virtual int  getSharedMemPerBlock() const = 0; 
    virtual int  getSharedMemPerMultiprocessor() const = 0; 
    virtual unsigned int getMaxThreadsPerBlock() const = 0; 
    virtual const char *getDeviceName() const = 0; 
    virtual CUdevice getDevice() const = 0; 
    virtual PxCudaInteropMode::Enum getInteropMode() const = 0; 

    virtual void setUsingConcurrentStreams(bool) = 0; 
    virtual bool getUsingConcurrentStreams() const = 0; 
    /* End query methods that don't require context to be acquired */

    virtual bool registerResourceInCudaGL(CUgraphicsResource &resource, uint32_t buffer, PxCudaInteropRegisterFlags flags = PxCudaInteropRegisterFlags()) = 0;

    virtual bool registerResourceInCudaD3D(CUgraphicsResource &resource, void *resourcePointer, PxCudaInteropRegisterFlags flags = PxCudaInteropRegisterFlags()) = 0;

    virtual bool unregisterResourceInCuda(CUgraphicsResource resource) = 0;

    virtual int usingDedicatedGPU() const = 0;

    virtual void release() = 0;

protected:

    virtual ~PxCudaContextManager() {}
};

class PxScopedCudaLock
{
public:
    PxScopedCudaLock(PxCudaContextManager& ctx) : mCtx(&ctx)
    {
        mCtx->acquireContext();
    }

    ~PxScopedCudaLock()
    {
        mCtx->releaseContext();
    }

protected:

    PxCudaContextManager* mCtx;
};

} // end physx namespace

#endif // PX_SUPPORT_GPU_PHYSX
#endif // PXCUDACONTEXTMANAGER_PXCUDACONTEXTMANAGER_H