framework/c/inc/le_mem.h

Go to the documentation of this file.

//--------------------------------------------------------------------------------------------------
#ifndef LEGATO_MEM_INCLUDE_GUARD
#define LEGATO_MEM_INCLUDE_GUARD

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef struct le_mem_Pool* le_mem_PoolRef_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef void (*le_mem_Destructor_t)
(
    void* objPtr    
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef struct
{
    uint64_t    numAllocs;      
    size_t      numFree;        
    size_t      numOverflows;   
}
le_mem_PoolStats_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_mem_PoolRef_t le_mem_CreatePool
(
    const char* name,   
    size_t      objSize 

);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_mem_PoolRef_t le_mem_ExpandPool
(
    le_mem_PoolRef_t    pool,       
    size_t              numObjects  
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void* le_mem_TryAlloc
(
    le_mem_PoolRef_t    pool    
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void* le_mem_AssertAlloc
(
    le_mem_PoolRef_t    pool    
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void* le_mem_ForceAlloc
(
    le_mem_PoolRef_t    pool    
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void le_mem_SetNumObjsToForce
(
    le_mem_PoolRef_t    pool,       
    size_t              numObjects  

);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void le_mem_Release
(
    void*   objPtr  
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void le_mem_AddRef
(
    void*   objPtr  
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void le_mem_SetDestructor
(
    le_mem_PoolRef_t    pool,       
    le_mem_Destructor_t destructor  
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void le_mem_GetStats
(
    le_mem_PoolRef_t    pool,       
    le_mem_PoolStats_t* statsPtr    
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void le_mem_ResetStats
(
    le_mem_PoolRef_t    pool        
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
size_t le_mem_GetTotalNumObjs
(
    le_mem_PoolRef_t    pool        
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
size_t le_mem_GetObjectSize
(
    le_mem_PoolRef_t    pool        
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_mem_PoolRef_t le_mem_FindPool
(
    const char* name    
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_mem_PoolRef_t le_mem_CreateSubPool
(
    le_mem_PoolRef_t    superPool,  
    const char*         name,       

    size_t              numObjects  
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void le_mem_DeleteSubPool
(
    le_mem_PoolRef_t    subPool     
);


#endif // LEGATO_MEM_INCLUDE_GUARD