PxProfileAllocatorWrapper.h

// 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-2022 NVIDIA Corporation. All rights reserved.
// Copyright (c) 2004-2008 AGEIA Technologies, Inc. All rights reserved.
// Copyright (c) 2001-2004 NovodeX AG. All rights reserved.
 
#ifndef PX_PROFILE_ALLOCATOR_WRAPPER_H
#define PX_PROFILE_ALLOCATOR_WRAPPER_H
 
#include "foundation/PxPreprocessor.h"
#include "foundation/PxAllocatorCallback.h"
#include "foundation/PxErrorCallback.h"
#include "foundation/PxAssert.h"
#include "foundation/PxHashMap.h"
#include "foundation/PxArray.h"
 
namespace physx { namespace profile {
 
    struct PxProfileAllocatorWrapper
    {
        PxAllocatorCallback*            mUserAllocator;
 
        PxProfileAllocatorWrapper( PxAllocatorCallback& inUserAllocator )
            : mUserAllocator( &inUserAllocator )
        {
        }
 
        PxProfileAllocatorWrapper( PxAllocatorCallback* inUserAllocator )
            : mUserAllocator( inUserAllocator )
        {
        }
 
        PxAllocatorCallback&        getAllocator() const
        {
            PX_ASSERT( NULL != mUserAllocator );
            return *mUserAllocator;
        }
    };
 
    template <typename T>
    class PxProfileWrapperReflectionAllocator
    {
        static const char* getName()
        {
#if PX_LINUX || PX_OSX || PX_EMSCRIPTEN || PX_SWITCH
            return __PRETTY_FUNCTION__;
#else
            return typeid(T).name();
#endif
        }
        PxProfileAllocatorWrapper* mWrapper;
 
    public:
        PxProfileWrapperReflectionAllocator(PxProfileAllocatorWrapper& inWrapper) : mWrapper( &inWrapper )  {}
        PxProfileWrapperReflectionAllocator( const PxProfileWrapperReflectionAllocator& inOther )
            : mWrapper( inOther.mWrapper )
        {
        }
        PxProfileWrapperReflectionAllocator& operator=( const PxProfileWrapperReflectionAllocator& inOther )
        {
            mWrapper = inOther.mWrapper;
            return *this;
        }
        PxAllocatorCallback& getAllocator() { return mWrapper->getAllocator(); }
        void* allocate(size_t size, const char* filename, int line)
        {
#if PX_CHECKED // checked and debug builds
            if(!size)
                return 0;
            return getAllocator().allocate(size, getName(), filename, line);
#else
            return getAllocator().allocate(size, "<no allocation names in this config>", filename, line);
#endif
        }
        void deallocate(void* ptr)
        {
            if(ptr)
                getAllocator().deallocate(ptr);
        }
    };
 
    struct PxProfileWrapperNamedAllocator
    {
        PxProfileAllocatorWrapper*  mWrapper;
        const char*         mAllocationName;
        PxProfileWrapperNamedAllocator(PxProfileAllocatorWrapper& inWrapper, const char* inAllocationName)
            : mWrapper( &inWrapper )
            , mAllocationName( inAllocationName )
        {}
        PxProfileWrapperNamedAllocator( const PxProfileWrapperNamedAllocator& inOther )
            : mWrapper( inOther.mWrapper )
            , mAllocationName( inOther.mAllocationName )
        {
        }
        PxProfileWrapperNamedAllocator& operator=( const PxProfileWrapperNamedAllocator& inOther )
        {
            mWrapper = inOther.mWrapper;
            mAllocationName = inOther.mAllocationName;
            return *this;
        }
        PxAllocatorCallback& getAllocator() { return mWrapper->getAllocator(); }
        void* allocate(size_t size, const char* filename, int line)
        {
            if(!size)
                return 0;
            return getAllocator().allocate(size, mAllocationName, filename, line);
        }
        void deallocate(void* ptr)
        {
            if(ptr)
                getAllocator().deallocate(ptr);
        }
    };
 
    template<class T>
    struct PxProfileArray : public PxArray<T, PxProfileWrapperReflectionAllocator<T> >
    {
        typedef PxProfileWrapperReflectionAllocator<T> TAllocatorType;
 
        PxProfileArray( PxProfileAllocatorWrapper& inWrapper )
            : PxArray<T, TAllocatorType >( TAllocatorType( inWrapper ) )
        {
        }
 
        PxProfileArray( const PxProfileArray< T >& inOther )
            : PxArray<T, TAllocatorType >( inOther, inOther )
        {
        }
    };
 
    template<typename TKeyType, typename TValueType, typename THashType=PxHash<TKeyType> >
    struct PxProfileHashMap : public PxHashMap<TKeyType, TValueType, THashType, PxProfileWrapperReflectionAllocator< TValueType > >
    {
        typedef PxHashMap<TKeyType, TValueType, THashType, PxProfileWrapperReflectionAllocator< TValueType > > THashMapType;
        typedef PxProfileWrapperReflectionAllocator<TValueType> TAllocatorType;
        PxProfileHashMap( PxProfileAllocatorWrapper& inWrapper )
            : THashMapType( TAllocatorType( inWrapper ) )
        {
        }
    };
 
    template<typename TDataType>
    inline TDataType* PxProfileAllocate( PxAllocatorCallback* inAllocator, const char* file, int inLine )
    {
        PxProfileAllocatorWrapper wrapper( inAllocator );
        typedef PxProfileWrapperReflectionAllocator< TDataType > TAllocator;
        TAllocator theAllocator( wrapper );
        return reinterpret_cast<TDataType*>( theAllocator.allocate( sizeof( TDataType ), file, inLine ) );
    }
 
    template<typename TDataType>
    inline TDataType* PxProfileAllocate( PxAllocatorCallback& inAllocator, const char* file, int inLine )
    {
        return PxProfileAllocate<TDataType>( &inAllocator, file, inLine );
    }
 
    template<typename TDataType>
    inline void PxProfileDeleteAndDeallocate( PxProfileAllocatorWrapper& inAllocator, TDataType* inDType )
    {
        PX_ASSERT(inDType);
        PxAllocatorCallback& allocator( inAllocator.getAllocator() );
        inDType->~TDataType();
        allocator.deallocate( inDType );
    }
 
    template<typename TDataType>
    inline void PxProfileDeleteAndDeallocate( PxAllocatorCallback& inAllocator, TDataType* inDType )
    {
        PxProfileAllocatorWrapper wrapper( &inAllocator );
        PxProfileDeleteAndDeallocate( wrapper, inDType );
    }
 
} }
 
#define PX_PROFILE_NEW( allocator, dtype ) new (physx::profile::PxProfileAllocate<dtype>( allocator, __FILE__, __LINE__ )) dtype
#define PX_PROFILE_DELETE( allocator, obj ) physx::profile::PxProfileDeleteAndDeallocate( allocator, obj );
 
#endif