NvBlastGlobals.h

Go to the documentation of this file.

// 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) 2016-2020 NVIDIA Corporation. All rights reserved.


#ifndef NVBLASTGLOBALS_H
#define NVBLASTGLOBALS_H

#include <new>
#include "NvBlastTypes.h"


namespace Nv
{
namespace Blast
{


class AllocatorCallback
{
public:
    virtual ~AllocatorCallback()
    {
    }

    virtual void* allocate(size_t size, const char* typeName, const char* filename, int line) = 0;

    virtual void deallocate(void* ptr) = 0;
};


struct ErrorCode
{
    enum Enum
    {
        eNO_ERROR = 0,

        eDEBUG_INFO = 1,

        eDEBUG_WARNING = 2,

        eINVALID_PARAMETER = 4,

        eINVALID_OPERATION = 8,

        eOUT_OF_MEMORY = 16,

        eINTERNAL_ERROR = 32,

        eABORT = 64,

        ePERF_WARNING = 128,

        eMASK_ALL = -1
    };
};


class ErrorCallback
{
public:
    virtual ~ErrorCallback()
    {
    }

    virtual void reportError(ErrorCode::Enum code, const char* message, const char* file, int line) = 0;
};


} // namespace Blast
} // namespace Nv



NVBLAST_API Nv::Blast::AllocatorCallback* NvBlastGlobalGetAllocatorCallback();

NVBLAST_API void NvBlastGlobalSetAllocatorCallback(Nv::Blast::AllocatorCallback* allocatorCallback);

NVBLAST_API Nv::Blast::ErrorCallback* NvBlastGlobalGetErrorCallback();

NVBLAST_API void NvBlastGlobalSetErrorCallback(Nv::Blast::ErrorCallback* errorCallback);



namespace Nv
{
namespace Blast
{


NV_INLINE void logLL(int type, const char* msg, const char* file, int line)
{
    ErrorCode::Enum errorCode = ErrorCode::eNO_ERROR;
    switch (type)
    {
    case NvBlastMessage::Error:     errorCode = ErrorCode::eINVALID_OPERATION;  break;
    case NvBlastMessage::Warning:   errorCode = ErrorCode::eDEBUG_WARNING;      break;
    case NvBlastMessage::Info:      errorCode = ErrorCode::eDEBUG_INFO;         break;
    case NvBlastMessage::Debug:     errorCode = ErrorCode::eNO_ERROR;           break;
    }

    NvBlastGlobalGetErrorCallback()->reportError(errorCode, msg, file, line);
}


} // namespace Blast
} // namespace Nv




#define NVBLAST_ALLOC(_size)                NvBlastGlobalGetAllocatorCallback()->allocate(_size, nullptr, __FILE__, __LINE__)
#define NVBLAST_ALLOC_NAMED(_size, _name)   NvBlastGlobalGetAllocatorCallback()->allocate(_size, _name, __FILE__, __LINE__)
#define NVBLAST_FREE(_mem)                  NvBlastGlobalGetAllocatorCallback()->deallocate(_mem)

#define NVBLAST_NEW(T) new (NvBlastGlobalGetAllocatorCallback()->allocate(sizeof(T), #T, __FILE__, __LINE__)) T

#define NVBLAST_DELETE(obj, T)                  \
    (obj)->~T();                                \
    NvBlastGlobalGetAllocatorCallback()->deallocate(obj)




#define NVBLAST_LOG(_code, _msg)    NvBlastGlobalGetErrorCallback()->reportError(_code, _msg, __FILE__, __LINE__)
#define NVBLAST_LOG_ERROR(_msg)     NVBLAST_LOG(Nv::Blast::ErrorCode::eINVALID_OPERATION, _msg)
#define NVBLAST_LOG_WARNING(_msg)   NVBLAST_LOG(Nv::Blast::ErrorCode::eDEBUG_WARNING, _msg)
#define NVBLAST_LOG_INFO(_msg)      NVBLAST_LOG(Nv::Blast::ErrorCode::eDEBUG_INFO, _msg)
#define NVBLAST_LOG_DEBUG(_msg)     NVBLAST_LOG(Nv::Blast::ErrorCode::eNO_ERROR, _msg)

#define NVBLAST_CHECK(_code, _expr, _msg, _onFail)                                                                      \
    {                                                                                                                   \
        if(!(_expr))                                                                                                    \
        {                                                                                                               \
            NVBLAST_LOG(_code, _msg);                                                                                   \
            { _onFail; };                                                                                               \
        }                                                                                                               \
    }                                                                                                                   

#define NVBLAST_CHECK_ERROR(_expr, _msg, _onFail)   NVBLAST_CHECK(Nv::Blast::ErrorCode::eINVALID_OPERATION, _expr, _msg, _onFail)
#define NVBLAST_CHECK_WARNING(_expr, _msg, _onFail) NVBLAST_CHECK(Nv::Blast::ErrorCode::eDEBUG_WARNING, _expr, _msg, _onFail)
#define NVBLAST_CHECK_INFO(_expr, _msg, _onFail)    NVBLAST_CHECK(Nv::Blast::ErrorCode::eDEBUG_INFO, _expr, _msg, _onFail)
#define NVBLAST_CHECK_DEBUG(_expr, _msg, _onFail)   NVBLAST_CHECK(Nv::Blast::ErrorCode::eNO_ERROR, _expr, _msg, _onFail)




// Macro to load a uint32_t (or larger) with four characters
#define NVBLAST_FOURCC(_a, _b, _c, _d)  ( (uint32_t)(_a) | (uint32_t)(_b)<<8 | (uint32_t)(_c)<<16 | (uint32_t)(_d)<<24 )


#endif // ifndef NVBLASTGLOBALS_H