vl_fixed_pool.h

Go to the documentation of this file.

#ifndef VL_FIXED_POOL
#define VL_FIXED_POOL
 
#include "vl_numtypes.h"
 
#ifndef VL_FIXEDPOOL_DEFAULT_SIZE
#define VL_FIXEDPOOL_DEFAULT_SIZE 16
#endif
 
#if defined(VL_U64_T) && defined(VL_U32_T)
#define VL_FIXEDPOOL_INDEX_T         VL_U64_T
#define VL_FIXEDPOOL_ORDINAL_T       VL_U32_T
#define VL_FIXEDPOOL_SHIFT           32
#define VL_FIXEDPOOL_LOOKUP_MAX      0xFFFFFFFF
#define VL_FIXEDPOOL_MASK            0x00000000FFFFFFFF
#define VL_FIXEDPOOL_INVALID_IDX     0xFFFFFFFFFFFFFFFF
#elif defined(VL_U32_T) && defined(VL_U16_T)
#define VL_FIXEDPOOL_INDEX_T         VL_U32_T
#define VL_FIXEDPOOL_ORDINAL_T       VL_U16_T
#define VL_FIXEDPOOL_SHIFT           16
#define VL_FIXEDPOOL_LOOKUP_MAX      0xFFFF
#define VL_FIXEDPOOL_MASK            0x0000FFFF
#define VL_FIXEDPOOL_INVALID_IDX     0xFFFFFFFF
#elif defined(VL_U16_T) && defined(VL_U8_T)
#define VL_FIXEDPOOL_INDEX_T         VL_U16_T
#define VL_FIXEDPOOL_ORDINAL_T       VL_U8_T
#define VL_FIXEDPOOL_SHIFT           8
#define VL_FIXEDPOOL_LOOKUP_MAX      0xFF
#define VL_FIXEDPOOL_MASK            0x00FF
#define VL_FIXEDPOOL_INVALID_IDX     0xFFFF
#else
#error Failed to configure vl_linearpool types.
#endif
 
typedef VL_FIXEDPOOL_INDEX_T     vl_fixedpool_idx;
 
typedef struct vl_fixed_pool_node vl_fixed_pool_node;
 
typedef struct vl_fixed_pool_node{
    VL_FIXEDPOOL_ORDINAL_T              totalTaken;     //Total elements taken from this node.
    VL_FIXEDPOOL_ORDINAL_T              blockSize;      //Size of this node, in elements
    VL_FIXEDPOOL_ORDINAL_T              blockOrdinal;   //Ordinal location of this block.
    vl_fixed_pool_node*                 nextLookup;     //Pointer to next element in the chain.
    void*                               elements;       //Pointer to element data
} vl_fixed_pool_node;
 
 
typedef struct{
    vl_ularge_t         elementSize;                    //Size of each element, in bytes.
    vl_fixedpool_idx    growthIncrement;                //Size of the next allocated block, in elements.
 
    vl_dsidx_t          lookupTotal, lookupCapacity;    //Number of used locations in the lookup table, and capacity thereof.
    vl_fixed_pool_node  **lookupTable,  *lookupHead;    //Lookup table, and the "leading" lookup element.
 
    vl_dsidx_t          freeCapacity;                   //Size of the free stack, in elements.
    vl_fixedpool_idx    *freeStack,     *freeTop;       //Pointer to the base of the free stack, and the top.
} vl_fixedpool;
 
void vlFixedPoolInit(vl_fixedpool* pool, vl_ularge_t elementSize);
 
void vlFixedPoolFree(vl_fixedpool* pool);
 
vl_fixedpool* vlFixedPoolNew(vl_ularge_t elementSize);
 
void vlFixedPoolDelete(vl_fixedpool* pool);
 
vl_fixedpool_idx vlFixedPoolTake(vl_fixedpool* pool);
 
void vlFixedPoolReturn(vl_fixedpool* pool, vl_fixedpool_idx idx);
 
#ifndef vlFixedPoolSample
#define vlFixedPoolSample(pool, idx) (void*)(((vl_usmall_t*)((pool)->lookupTable[(idx) & VL_FIXEDPOOL_MASK])->elements) + (((idx) >> VL_FIXEDPOOL_SHIFT) * (pool)->elementSize))
#endif
 
void        vlFixedPoolClear(vl_fixedpool* pool);
 
void        vlFixedPoolReset(vl_fixedpool* pool);
 
void        vlFixedPoolReserve(vl_fixedpool* pool, vl_dsidx_t n);
 
vl_fixedpool*  vlFixedPoolClone(const vl_fixedpool* src, vl_fixedpool* dest);
 
#endif