vl_pool.h

Go to the documentation of this file.

 
#ifndef VL_FIXED_POOL
#define VL_FIXED_POOL
 
#include "vl_memory.h"
#include "vl_numtypes.h"
 
#ifndef VL_POOL_DEFAULT_SIZE
#define VL_POOL_DEFAULT_SIZE 16
#endif
 
#if defined(VL_U64_T) && defined(VL_U32_T)
#define VL_POOL_INDEX_T VL_U64_T
#define VL_POOL_ORDINAL_T VL_U32_T
#define VL_POOL_LOOKUP_MAX 0xFFFFFFFF
#define VL_POOL_INVALID_IDX 0xFFFFFFFFFFFFFFFF
#elif defined(VL_U32_T) && defined(VL_U16_T)
#define VL_POOL_INDEX_T VL_U32_T
#define VL_POOL_ORDINAL_T VL_U16_T
#define VL_POOL_LOOKUP_MAX 0xFFFF
#define VL_POOL_INVALID_IDX 0xFFFFFFFF
#elif defined(VL_U16_T) && defined(VL_U8_T)
#define VL_POOL_INDEX_T VL_U16_T
#define VL_POOL_ORDINAL_T VL_U8_T
#define VL_POOL_LOOKUP_MAX 0xFF
#define VL_POOL_INVALID_IDX 0xFFFF
#else
#error Failed to configure vl_pool types.
#endif
 
typedef VL_POOL_INDEX_T vl_pool_idx;
 
typedef struct vl_pool_node vl_pool_node;
 
typedef struct vl_pool_node
{
    VL_POOL_ORDINAL_T totalTaken; // Total elements taken from this node.
    VL_POOL_ORDINAL_T blockSize; // Size of this node, in elements
    VL_POOL_ORDINAL_T blockOrdinal; // Ordinal location of this block.
    vl_pool_node* nextLookup; // Pointer to the next element in the chain.
    void* elements; // Pointer to element data
} vl_pool_node;
 
typedef struct vl_pool
{
    vl_uint16_t elementSize; 
    vl_uint16_t elementAlign; 
    vl_pool_idx growthIncrement; 
    vl_dsidx_t lookupTotal; 
    vl_dsidx_t lookupCapacity; 
    vl_pool_node** lookupTable; 
    vl_pool_node* lookupHead; 
    vl_dsidx_t freeCapacity; 
    vl_pool_idx* freeStack; 
    vl_pool_idx* freeTop; 
} vl_pool;
 
VL_API void vlPoolInitAligned(vl_pool* pool, vl_uint16_t elementSize, vl_uint16_t alignment);
 
static inline void vlPoolInit(vl_pool* pool, vl_uint16_t elementSize)
{
    vlPoolInitAligned(pool, elementSize, VL_DEFAULT_MEMORY_ALIGN);
}
 
VL_API void vlPoolFree(vl_pool* pool);
 
VL_API vl_pool* vlPoolNewAligned(vl_uint16_t elementSize, vl_uint16_t alignment);
 
static inline vl_pool* vlPoolNew(vl_uint16_t elementSize)
{
    return vlPoolNewAligned(elementSize, VL_DEFAULT_MEMORY_ALIGN);
}
 
VL_API void vlPoolDelete(vl_pool* pool);
 
VL_API vl_pool_idx vlPoolTake(vl_pool* pool);
 
VL_API void vlPoolReturn(vl_pool* pool, vl_pool_idx idx);
 
VL_API void* vlPoolSample(vl_pool* pool, vl_pool_idx idx);
 
VL_API void vlPoolClear(vl_pool* pool);
 
VL_API void vlPoolReset(vl_pool* pool);
 
VL_API void vlPoolReserve(vl_pool* pool, vl_dsidx_t n);
 
VL_API vl_pool* vlPoolClone(const vl_pool* src, vl_pool* dest);
 
#endif