Home

Resume

Blog

Teikitu


/* =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-==-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= */
/*  »Project«   Teikitu Gaming System (TgS) (∂)
    »File«      TgS Common - Mem MGR.h
    »Author«    Andrew Aye (EMail: mailto:andrew.aye@gmail.com, Web: http://www.andrewaye.com)
    »Version«   4.51 / »GUID« A9981407-3EC9-42AF-8B6F-8BE6DD919615                                                                                                        */
/*   -------------------------------------------------------------------------------------------------------------------------------------------------------------------- */
/*  Copyright: © 2002-2017, Andrew Aye.  All Rights Reserved.
    This software is free for non-commercial use.  Redistribution and use in source and binary forms, with or without modification, are permitted provided that the
      following conditions are met:
        Redistribution of source code must retain this copyright notice, this list of conditions and the following disclaimers.
        Redistribution in binary form must reproduce this copyright notice, this list of conditions and the following disclaimers in the documentation and other materials
          provided with the distribution.
    The name of the author may not be used to endorse or promote products derived from this software without specific prior written permission.
    The intellectual property rights of the algorithms used reside with Andrew Aye.
    You may not use this software, in whole or in part, in support of any commercial product without the express written consent of the author.
    There is no warranty or other guarantee of fitness of this software for any purpose. It is provided solely "as is".                                                   */
/* =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-==-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= */
#if !defined(TGS_COMMON_MEMMGR_H)
#define TGS_COMMON_MEMMGR_H
#pragma once


/* == Common ============================================================================================================================================================ */

/* -.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-. */
/*  Public Constants                                                                                                                                                      */
/* -.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-. */

enum { KTgMIN_ALLOC_BIT                     = 4 }; /*« Note: This can not be smaller than sizeof(void*) */
enum { KTgMIN_ALLOC                         = 1 << KTgMIN_ALLOC_BIT };
enum { KTgMAX_POOLS                         = 53L };
enum { KTgDEFAULT_SCRATCH_SIZE              = 128*1024 };

TgTYPE_ENUM( ETgMM_ALLOCATOR, TgSINT32,
    ETgMM_ALLOCATOR_BEGIN = 0,
    ETgMM_ALLOCATOR_POOL = ETgMM_ALLOCATOR_BEGIN,
    ETgMM_ALLOCATOR_TEMP,
    ETgMM_ALLOCATOR_VIRTUAL,
    ETgMM_ALLOCATOR_USER_0,
    ETgMM_ALLOCATOR_USER_1,
    ETgMM_ALLOCATOR_USER_2,
    ETgMM_ALLOCATOR_USER_3,
    ETgMM_ALLOCATOR_END,
    ETgMM_ALLOCATOR_COUNT = ETgMM_ALLOCATOR_END - ETgMM_ALLOCATOR_BEGIN
);

#if TgCOMPILE_MEM_TRACK
    #define MEM_TRACK_PARAMETERS            , CPC_TgCHAR pszF, C_TgUINT32 uiL
    #define MEM_TRACK_VARS                  , pszF, uiL
#else
    #define MEM_TRACK_PARAMETERS
    #define MEM_TRACK_VARS
#endif


/* -.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-. */
/*  Public Types                                                                                                                                                          */
/* -.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-. */

TgTYPE_STRUCT(STg2_MM_MGR,)
{
    TgRESULT                                    (*m_pfnInit_MGR)( TgVOID );
    TgRESULT                                    (*m_pfnBoot_MGR)( TgVOID );
    TgRESULT                                    (*m_pfnStop_MGR)( TgVOID );
    TgRESULT                                    (*m_pfnFree_MGR)( TgVOID );

#if TgS_STAT_COMMON
    TgRESULT                                    (*m_pfnStats)( PC_STg2_Output );
#endif

    TgSIZE                                      (*m_pfnSize)( CPC_TgVOID );
    P_TgVOID                                    (*m_pfnMalloc)( C_TgSIZE MEM_TRACK_PARAMETERS );
    P_TgVOID                                    (*m_pfnReserve)( C_TgSIZE MEM_TRACK_PARAMETERS );
    P_TgVOID                                    (*m_pfnCommit)( PC_TgVOID, C_TgSIZE MEM_TRACK_PARAMETERS );
    TgVOID                                      (*m_pfnFree)( PC_TgVOID MEM_TRACK_PARAMETERS );
    P_TgVOID                                    (*m_pfnRealloc)( PC_TgVOID, C_TgSIZE MEM_TRACK_PARAMETERS );
};


/* -.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-. */
/*  Public Functions                                                                                                                                                      */
/* -.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-. */

/* #REVIEW: Do we need a way to segment | heap the allocations - maybe include the FAC code with each allocation request? */

TgEXTN TgRESULT                             tgMM_Init_MGR( TgVOID );
TgEXTN TgRESULT                             tgMM_Boot_MGR( TgVOID );
TgEXTN TgRESULT                             tgMM_Stop_MGR( TgVOID );
TgEXTN TgRESULT                             tgMM_Free_MGR( TgVOID );
TgEXTN TgRESULT                             tgMM_Update_MGR( C_TgFLOAT32 );

TgEXTN TgBOOL                               tgMM_Query_Init( TgVOID );
TgEXTN TgBOOL                               tgMM_Query_Boot( TgVOID );

TgEXTN TgSIZE                               tgMM_Query_Fixed_Memory( TgVOID );

TgEXTN TgUINT32                             tgMM_Page_Size( TgVOID );

TgEXTN TgVOID                               tgMM_Register_Allocator( C_ETgMM_ALLOCATOR, P_STg2_MM_MGR );

#if TgS_STAT_COMMON
TgEXTN TgVOID                               tgMM_Stats( PC_STg2_Output );
TgEXTN TgVOID                               tgMM_Pool_Stats( C_TgSINT32, P_TgSINT32, P_TgSINT32 );
/*# TgS_STAT_COMMON */
#endif

TgEXTN TgSIZE                               tgMM_Size( C_ETgMM_ALLOCATOR, CPC_TgVOID );
TgEXTN P_TgVOID                             tgMM_Malloc( C_ETgMM_ALLOCATOR, C_TgSIZE MEM_TRACK_PARAMETERS );
TgEXTN P_TgVOID                             tgMM_Reserve( C_ETgMM_ALLOCATOR, C_TgSIZE MEM_TRACK_PARAMETERS );
TgEXTN P_TgVOID                             tgMM_Commit( C_ETgMM_ALLOCATOR, PC_TgVOID, C_TgSIZE MEM_TRACK_PARAMETERS );
TgEXTN TgVOID                               tgMM_Free( C_ETgMM_ALLOCATOR, PC_TgVOID MEM_TRACK_PARAMETERS );
TgEXTN P_TgVOID                             tgMM_Realloc( C_ETgMM_ALLOCATOR, PC_TgVOID, C_TgSIZE MEM_TRACK_PARAMETERS );

                                            /* Memory Managed Pool - Direct call into the pool allocator */
TgEXTN TgSIZE                               tgMM_Size_Pool( CPC_TgVOID );
TgEXTN P_TgVOID                             tgMM_Malloc_Pool( C_TgSIZE MEM_TRACK_PARAMETERS );
TgEXTN TgVOID                               tgMM_Free_Pool( PC_TgVOID MEM_TRACK_PARAMETERS );
TgEXTN P_TgVOID                             tgMM_Realloc_Pool( PC_TgVOID, C_TgSIZE MEM_TRACK_PARAMETERS );

                                            /* Virtual Memory - Direct call into the virtual allocator */
TgEXTN P_TgVOID                             tgMM_Reserve_Virtual( C_TgSIZE MEM_TRACK_PARAMETERS );
TgEXTN P_TgVOID                             tgMM_Commit_Virtual( PC_TgVOID, C_TgSIZE MEM_TRACK_PARAMETERS );
TgEXTN TgVOID                               tgMM_Free_Virtual( PC_TgVOID MEM_TRACK_PARAMETERS );

#if TgCOMPILE_THREAD_LOCAL
                                            /* Scratch Memory */
TgEXTN TgRESULT                             tgMM_TL_Init_Scratch( C_TgSIZE );
TgEXTN TgVOID                               tgMM_TL_Free_Scratch( TgVOID );
TgEXTN P_TgVOID                             tgMM_TL_Push_Scratch( TgUINT32 MEM_TRACK_PARAMETERS );
TgEXTN TgVOID                               tgMM_TL_Pop_Scratch( TgUINT32 MEM_TRACK_PARAMETERS );
/*# TgCOMPILE_THREAD_LOCAL */
#endif

/* ====================================================================================================================================================================== */
#endif