genesis-3d_engine/Engine/ExtIncludes/physX3/windows/physxprofilesdk/PxProfileEventSender.h

122 lines
4.5 KiB
C
Raw Normal View History

// 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_PROFILE_EVENT_SENDER_H
#define PX_PROFILE_EVENT_SENDER_H
#include "physxprofilesdk/PxProfileBase.h"
#include "physxprofilesdk/PxProfileContextProvider.h"
#include "physxprofilesdk/PxProfileEventId.h"
namespace physx {
/**
* Tagging interface to indicate an object that is capable of flushing a profile
* event stream at a certain point.
*/
class PxProfileEventFlusher
{
protected:
virtual ~PxProfileEventFlusher(){}
public:
virtual void flushProfileEvents() = 0;
};
/**
* Sends the full events where the caller must provide the context and thread id.
*/
class PxProfileEventSender
{
protected:
virtual ~PxProfileEventSender(){}
public:
//Send a profile event, optionally with a context. Events are sorted by thread
//and context in the client side.
virtual void startEvent( PxU16 inId, PxU64 contextId) = 0;
virtual void stopEvent( PxU16 inId, PxU64 contextId) = 0;
virtual void startEvent( PxU16 inId, PxU64 contextId, PxU32 threadId) = 0;
virtual void stopEvent( PxU16 inId, PxU64 contextId, PxU32 threadId ) = 0;
/**
* Set an specific events value. This is different than the profiling value
* for the event; it is a value recorded and kept around without a timestamp associated
* with it. This value is displayed when the event itself is processed.
*/
virtual void eventValue( PxU16 inId, PxU64 contextId, PxI64 inValue ) = 0;
//GPUProfile.h ..
/*
typedef struct CUDA_ALIGN_16
{
PxU16 block;
PxU8 warp;
PxU8 mpId;
PxU8 hwWarpId;
PxU8 userDataCfg;
PxU16 eventId;
PxU32 startTime;
PxU32 endTime;
} warpProfileEvent;
*/
static const PxU32 CurrentCUDABufferFormat = 1;
/**
* Send a CUDA profile buffer. We assume the submit time is almost exactly the end time of the batch.
* We then work backwards, using the batchRuntimeInMilliseconds in order to get the original time
* of the batch. The buffer format is described in GPUProfile.h.
*
* \param batchRuntimeInMilliseconds The batch runtime in milliseconds, see cuEventElapsedTime.
* \param cudaData An opaque pointer to the buffer of cuda data.
* \param bufLenInBytes length of the cuda data buffer in bytes
* \param bufferVersion Version of the format of the cuda data.
*/
virtual void CUDAProfileBuffer( PxF32 batchRuntimeInMilliseconds, const PxU8* cudaData, PxU32 bufLenInBytes, PxU32 bufferVersion = CurrentCUDABufferFormat ) = 0;
};
/**
Tagging interface to indicate an object that may or may not return
an object capable of adding profile events to a buffer.
*/
class PxProfileEventSenderProvider
{
protected:
virtual ~PxProfileEventSenderProvider(){}
public:
/**
This method can *always* return NULL.
Thus need to always check that what you are getting is what
you think it is.
\return Perhaps a profile event sender.
*/
virtual PxProfileEventSender* getProfileEventSender() = 0;
};
}
#endif // PX_PROFILE_EVENT_SENDER_H