orxMemory.h

Go to the documentation of this file.

/* Orx - Portable Game Engine
 *
 * Copyright (c) 2008-2018 Orx-Project
 *
 * This software is provided 'as-is', without any express or implied
 * warranty. In no event will the authors be held liable for any damages
 * arising from the use of this software.
 *
 * Permission is granted to anyone to use this software for any purpose,
 * including commercial applications, and to alter it and redistribute it
 * freely, subject to the following restrictions:
 *
 *    1. The origin of this software must not be misrepresented; you must not
 *    claim that you wrote the original software. If you use this software
 *    in a product, an acknowledgment in the product documentation would be
 *    appreciated but is not required.
 *
 *    2. Altered source versions must be plainly marked as such, and must not be
 *    misrepresented as being the original software.
 *
 *    3. This notice may not be removed or altered from any source
 *    distribution.
 */

#ifndef _orxMEMORY_H_
#define _orxMEMORY_H_


#include "orxInclude.h"
#include "debug/orxDebug.h"

#include <string.h>


#ifdef __orxWINDOWS__
  #ifdef NO_WIN32_LEAN_AND_MEAN
    #undef WIN32_LEAN_AND_MEAN
  #else /* NO_WIN32_LEAN_AND_MEAN */
    #ifndef WIN32_LEAN_AND_MEAN
      #define WIN32_LEAN_AND_MEAN
      #define DEFINED_WIN32_LEAN_AND_MEAN
    #endif /* !WIN32_LEAN_AND_MEAN */
  #endif /* NO_WIN32_LEAN_AND_MEAN */
  #include <windows.h>
  #ifdef DEFINED_WIN32_LEAN_AND_MEAN
    #undef WIN32_LEAN_AND_MEAN
    #undef DEFINED_WIN32_LEAN_AND_MEAN
  #endif /* DEFINED_WIN32_LEAN_AND_MEAN */
  #undef NO_WIN32_LEAN_AND_MEAN
#endif /* __orxWINDOWS__ */


#if defined(__orxGCC__) || defined(__orxLLVM__)
  #define orxMEMORY_BARRIER()                             __sync_synchronize()
  #define orxHAS_MEMORY_BARRIER
#elif defined(__orxMSVC__)
  #define orxMEMORY_BARRIER()                             MemoryBarrier()
  #define orxHAS_MEMORY_BARRIER
#else
  #define orxMEMORY_BARRIER()
  #undef orxHAS_MEMORY_BARRIER

  #warning !!WARNING!! This compiler does not have any hardware memory barrier builtin.
#endif


#ifdef __orxPROFILER__
  #define orxMEMORY_TRACK(TYPE, SIZE, ALLOCATE)           orxMemory_Track(orxMEMORY_TYPE_##TYPE, SIZE, ALLOCATE)
#else /* __orxPROFILER__ */
  #define orxMEMORY_TRACK(TYPE, SIZE, ALLOCATE)
#endif /* __orxPROFILER__ */


typedef enum __orxMEMORY_TYPE_t
{
  orxMEMORY_TYPE_MAIN = 0,                                
  orxMEMORY_TYPE_AUDIO,                                   
  orxMEMORY_TYPE_CONFIG,                                  
  orxMEMORY_TYPE_DEBUG,                                   
  orxMEMORY_TYPE_PHYSICS,                                 
  orxMEMORY_TYPE_SYSTEM,                                  
  orxMEMORY_TYPE_TEMP,                                    
  orxMEMORY_TYPE_TEXT,                                    
  orxMEMORY_TYPE_VIDEO,                                   
  orxMEMORY_TYPE_NUMBER,                                  
  orxMEMORY_TYPE_NONE = orxENUM_NONE                      
} orxMEMORY_TYPE;


extern orxDLLAPI void orxFASTCALL                         orxMemory_Setup();

extern orxDLLAPI orxSTATUS orxFASTCALL                    orxMemory_Init();

extern orxDLLAPI void orxFASTCALL                         orxMemory_Exit();

extern orxDLLAPI void *orxFASTCALL                        orxMemory_Allocate(orxU32 _u32Size, orxMEMORY_TYPE _eMemType);

extern orxDLLAPI void *orxFASTCALL                        orxMemory_Reallocate(void *_pMem, orxU32 _u32Size);

extern orxDLLAPI void orxFASTCALL                         orxMemory_Free(void *_pMem);


static orxINLINE void *                                   orxMemory_Copy(void *_pDest, const void *_pSrc, orxU32 _u32Size)
{
  /* Checks */
  orxASSERT(_pDest != orxNULL);
  orxASSERT(_pSrc != orxNULL);

  /* Done! */
  return((void *)memcpy(_pDest, _pSrc, (size_t)_u32Size));
}

static orxINLINE void *                                   orxMemory_Move(void *_pDest, void *_pSrc, orxU32 _u32Size)
{
  /* Checks */
  orxASSERT(_pDest != orxNULL);
  orxASSERT(_pSrc != orxNULL);

  /* Done! */
  return((void *)memmove(_pDest, _pSrc, (size_t)_u32Size));
}

static orxINLINE orxU32                                   orxMemory_Compare(const void *_pMem1, const void *_pMem2, orxU32 _u32Size)
{
  /* Checks */
  orxASSERT(_pMem1 != orxNULL);
  orxASSERT(_pMem2 != orxNULL);

  /* Done! */
  return((orxU32)memcmp(_pMem1, _pMem2, (size_t)_u32Size));
}

static orxINLINE void *                                   orxMemory_Set(void *_pDest, orxU8 _u8Data, orxU32 _u32Size)
{
  /* Checks */
  orxASSERT(_pDest != orxNULL);

  /* Done! */
  return((void *)memset(_pDest, _u8Data, (size_t)_u32Size));
}

static orxINLINE void *                                   orxMemory_Zero(void *_pDest, orxU32 _u32Size)
{
  /* Checks */
  orxASSERT(_pDest != orxNULL);

  /* Done! */
  return((void *)memset(_pDest, 0, (size_t)_u32Size));
}


extern orxDLLAPI const orxSTRING orxFASTCALL              orxMemory_GetTypeName(orxMEMORY_TYPE _eMemType);


extern orxDLLAPI orxU32 orxFASTCALL                       orxMemory_GetCacheLineSize();


#ifdef __orxPROFILER__

extern orxDLLAPI orxSTATUS orxFASTCALL                    orxMemory_GetUsage(orxMEMORY_TYPE _eMemType, orxU32 *_pu32Count, orxU32 *_pu32PeakCount, orxU32 *_pu32Size, orxU32 *_pu32PeakSize, orxU32 *_pu32OperationCount);


extern orxDLLAPI orxSTATUS orxFASTCALL                    orxMemory_Track(orxMEMORY_TYPE _eMemType, orxU32 _u32Size, orxBOOL _bAllocate);

#endif /* __orxPROFILER__  */

#endif /* _orxMEMORY_H_ */