kmemory.h

Go to the documentation of this file.

#ifndef FBXFILESDK_COMPONENTS_KBASELIB_KLIB_KMEMORY_H
#define FBXFILESDK_COMPONENTS_KBASELIB_KLIB_KMEMORY_H

/**************************************************************************************

 Copyright (C) 2001 - 2009 Autodesk, Inc. and/or its licensors.
 All Rights Reserved.

 The coded instructions, statements, computer programs, and/or related material 
 (collectively the "Data") in these files contain unpublished information 
 proprietary to Autodesk, Inc. and/or its licensors, which is protected by 
 Canada and United States of America federal copyright law and by international 
 treaties. 
 
 The Data may not be disclosed or distributed to third parties, in whole or in
 part, without the prior written consent of Autodesk, Inc. ("Autodesk").

 THE DATA IS PROVIDED "AS IS" AND WITHOUT WARRANTY.
 ALL WARRANTIES ARE EXPRESSLY EXCLUDED AND DISCLAIMED. AUTODESK MAKES NO
 WARRANTY OF ANY KIND WITH RESPECT TO THE DATA, EXPRESS, IMPLIED OR ARISING
 BY CUSTOM OR TRADE USAGE, AND DISCLAIMS ANY IMPLIED WARRANTIES OF TITLE, 
 NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE OR USE. 
 WITHOUT LIMITING THE FOREGOING, AUTODESK DOES NOT WARRANT THAT THE OPERATION
 OF THE DATA WILL BE UNINTERRUPTED OR ERROR FREE. 
 
 IN NO EVENT SHALL AUTODESK, ITS AFFILIATES, PARENT COMPANIES, LICENSORS
 OR SUPPLIERS ("AUTODESK GROUP") BE LIABLE FOR ANY LOSSES, DAMAGES OR EXPENSES
 OF ANY KIND (INCLUDING WITHOUT LIMITATION PUNITIVE OR MULTIPLE DAMAGES OR OTHER
 SPECIAL, DIRECT, INDIRECT, EXEMPLARY, INCIDENTAL, LOSS OF PROFITS, REVENUE
 OR DATA, COST OF COVER OR CONSEQUENTIAL LOSSES OR DAMAGES OF ANY KIND),
 HOWEVER CAUSED, AND REGARDLESS OF THE THEORY OF LIABILITY, WHETHER DERIVED
 FROM CONTRACT, TORT (INCLUDING, BUT NOT LIMITED TO, NEGLIGENCE), OR OTHERWISE,
 ARISING OUT OF OR RELATING TO THE DATA OR ITS USE OR ANY OTHER PERFORMANCE,
 WHETHER OR NOT AUTODESK HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH LOSS
 OR DAMAGE. 

**************************************************************************************/

#include <fbxfilesdk/components/kbaselib/kbaselib_h.h>

#include <string.h>

#ifndef KARCH_ENV_MACOSX
    #include <stdlib.h>
#endif

#include <fbxfilesdk/fbxfilesdk_nsbegin.h>

class KMpStack;
class KMpMutex;
#define KMEMORY_DEFAULTALIGNEMENT   4

#define kMalloc( pSize )                                                        malloc( pSize )
#define kRealloc( pOldMemBlock, pNewSize )                                      realloc( pOldMemBlock, pNewSize )
#define kFree(pAllocatedMemBlock)                                               free(pAllocatedMemBlock)

KFBX_DLL void* kMallocAligned( kSizeT pSize, kUInt pAlignement = KMEMORY_DEFAULTALIGNEMENT);

KFBX_DLL void* kReallocAligned( void* pAlignedPtr, kSizeT pSize, kUInt pAlignement = KMEMORY_DEFAULTALIGNEMENT);

KFBX_DLL void kFreeAligned( void* pAlignedPtr );


// for debugging portability
#ifndef _INC_CRTDBG
#define _NORMAL_BLOCK   1
#define _malloc_dbg(size, blockType, filename, linenumber)          malloc(size)
#define _realloc_dbg(ptr, size, blockType, filename, linenumber)    realloc(ptr, size)
#define _free_dbg(ptr, blockType)                                   free(ptr)
#endif
#define kMallocDbg( pSize, blockType, filename, linenumber )                    _malloc_dbg( pSize, blockType, filename, linenumber )
#define kReallocDbg( pOldMemBlock, pNewSize, blockType, filename, linenumber )  _realloc_dbg( pOldMemBlock, pNewSize, blockType, filename, linenumber )
#define kFreeDbg(pAllocatedMemBlock, blockType, filename, linenumber)           _free_dbg(pAllocatedMemBlock, blockType)
KFBX_DLL void* kMallocAlignedDbg( kSizeT pSize, kUInt pAlignement, int blockType, const char *filename, int linenumber);
KFBX_DLL void* kReallocAlignedDbg( void* pAlignedPtr, kSizeT pSize, kUInt pAlignement, int blockType, const char *filename, int linenumber);
KFBX_DLL void  kFreeAlignedDbg( void* pAlignedPtr, int blockType, const char *filename, int linenumber );

class KFBX_DLL KMemoryUsageCounter {
public:
    KMemoryUsageCounter();
    ~KMemoryUsageCounter();
#ifdef _DEBUG
    kInt64  GetMemoryUsage();
    kInt64  GetMallocCount();
    kInt64  GetReallocCount();
    kInt64  GetFreeCount();
    kInt64  GetMallocMemoryUsage();
    kInt64  GetReallocMemoryUsage();
    kInt64  GetFreeMemoryUsage();

    void CounterFree( void *pData );
    void CounterMalloc( size_t pValue );
    void CounterRealloc( void *pData,size_t pValue );
#else
    // in Release the MemoryUsageCounter is not available
    inline kInt64 GetMemoryUsage()          { return 0; }
    inline kInt64 GetMallocCount()          { return 0; }
    inline kInt64 GetReallocCount()         { return 0; }
    inline kInt64 GetFreeCount()            { return 0; }
    inline kInt64 GetMallocMemoryUsage()    { return 0; }
    inline kInt64 GetReallocMemoryUsage()   { return 0; }
    inline kInt64 GetFreeMemoryUsage()      { return 0; }

    inline void CounterFree( void* )                {};
    inline void CounterMalloc( size_t )             {};
    inline void CounterRealloc( void* , size_t )    {};
#endif

    KMemoryUsageCounter operator + (KMemoryUsageCounter& pSrc);
    KMemoryUsageCounter operator - (KMemoryUsageCounter& pSrc);

private:
#ifdef _DEBUG
    kInt64  mMemoryUsage;
    kInt64  mMallocCount;
    kInt64  mMallocMemoryUsage;
    kInt64  mReallocCount;
    kInt64  mReallocMemoryUsage;
    kInt64  mFreeCount;
    kInt64  mFreeMemoryUsage;
#endif
};

class KFBX_DLL KMemoryAllocator : public KMemoryUsageCounter 
{
public:
    explicit KMemoryAllocator(const char *pId){}
    ~KMemoryAllocator();
public:
    virtual void    Purge() {}

    virtual void *  Malloc  (size_t pSize);
    virtual void *  Calloc  (size_t pCount,size_t pSize);
    virtual void *  Realloc (void* pData,size_t pSize);
    virtual void    Free    (void* pData);
};

#define KMEMORY_DEFAULTALIGNEMENT   4

class KFBX_DLL KMemoryReusePool : public KMemoryAllocator{

public:
    // Public interface.
    explicit KMemoryReusePool(size_t pSizeRange = 1024 * 128, int pStrideShift = 2, int pAlignmentShift = 0, size_t pTotalAllocatedMax = 0);
    ~KMemoryReusePool();

    // Allocation
public:
    virtual void    Purge();

    virtual void *  Malloc  (size_t pSize);
    virtual void *  Calloc  (size_t pCount,size_t pSize);
    virtual void *  Realloc (void* pData,size_t pSize);
    virtual void    Free    (void* pData);
protected:
    // Implementation.
    bool        SizeFitsInPool(size_t pSize) const { return (pSize >= GetHeaderSize() && pSize < mSizeRange); }
    bool        PoolIsFull() const { return (0 != mTotalAllocatedMax && mTotalAllocated > mTotalAllocatedMax); }
    kUChar      ComputeAlignmentOffset(void* pBuffer);
    static int  ComputeRightShiftRemainder(int pStrideShift);

protected:
    struct KBlockHeader {
        size_t  mSize;
        kUChar  mAlignmentOffset;
    };
    void*           AssignHeaderAndReturnBlock(void* pBuffer, size_t pBufferSize);
    size_t          GetBufferAndSize(void* pBlock, void* & pBuffer);
    static size_t   GetHeaderSize();

private:
    KMemoryReusePool(KMemoryReusePool const &);
    KMemoryReusePool & operator=(KMemoryReusePool const &);

protected:
    // Fundamental data.
    KMpMutex *      mLock;              
    void* *         mBuffer;            
    size_t const    mSizeRange;         
    size_t const    mBufferSize;        
    int const       mStrideShift;       
    int const       mStrideRemainder;   
    int const       mAlignmentShift;    
    size_t const    mTotalAllocatedMax; 
    size_t          mTotalAllocated;    
    size_t          mTotalBlocks;       
};

class KFBX_DLL KMemoryPool {
public:
    explicit KMemoryPool( kSizeT pBlockSize = 0,kUInt pBlockCount = 0,kUInt pAlignment = 0,bool pResizable = true );
    ~KMemoryPool();

    void Init(  kSizeT pBlockSize,kUInt pBlockCount = 0,kUInt pAlignement = 0,bool pResizable = true );

    void Clear();

    void* Allocate();

    void Free( void* pMemBlock );

private:
    void InitVars();

private:
    kAtomic     mCountFreeBlock;
    KMpStack*   mFreeBlocks;
    kSizeT      mBlockSize;
    kUInt       mAlignment;
    bool        mResizable;
};



#if ( (defined(MEMORY_DEBUG) || defined(MEMORY_DEBUG_FBXFILESDK_MEMORY)) && defined(_DEBUG) && defined(KARCH_ENV_WIN32))
KFBX_DLL void KMemoryLeakInit();
KFBX_DLL void KMemoryLeakDumpReport();
#endif

#include <fbxfilesdk/fbxfilesdk_nsend.h>

#endif // FBXFILESDK_COMPONENTS_KBASELIB_KLIB_KMEMORY_H