blockpool.h

/*---------------------------------------------------------------
 * HISTORY
 * 7-Dec-2004       Graeme McKerrell    
 *    Updated to use the "lub" prefix
 * 6-Feb-2004       Graeme McKerrell    
 *    removed init_fn type definition and parameter, the client had
 *    more flexiblity in defining their own initialisation operation with
 *    arguments rather than use a "one-size-fits-all" approach.
 *    Modified blockpool structure to support FIFO block allocation.
 * 23-Jan-2004      Graeme McKerrell    
 *    Initial version
 *---------------------------------------------------------------
 * Copyright (C) 2004 3Com Corporation. All Rights Reserved.
 *--------------------------------------------------------------- */
#ifndef _lub_blockpool_h
#define _lub_blockpool_h
#include <stddef.h>

/****************************************************************
 * TYPE DEFINITIONS
 **************************************************************** */
typedef struct _lub_blockpool_block lub_blockpool_block_t;
typedef struct _lub_blockpool lub_blockpool_t;
struct _lub_blockpool
{
    /* CLIENTS MUSTN'T TOUCH THESE DETAILS */
    lub_blockpool_block_t *m_head;
    lub_blockpool_block_t *m_tail;
    size_t                 m_block_size;
    size_t                 m_num_blocks;
    unsigned               m_alloc_blocks;
    unsigned               m_alloc_total_blocks;
    unsigned               m_alloc_hightide_blocks;
    unsigned               m_alloc_failures;
};
typedef struct _lub_blockpool_stats lub_blockpool_stats_t;
struct _lub_blockpool_stats
{
    /*----------------------------------------------------- */
    size_t block_size;
    size_t num_blocks;
    /*----------------------------------------------------- */
    size_t alloc_blocks;
    size_t alloc_bytes;
    size_t free_blocks;
    size_t free_bytes;
    /*----------------------------------------------------- */
    size_t alloc_total_blocks;
    size_t alloc_total_bytes;
    /*----------------------------------------------------- */
    size_t alloc_hightide_blocks;
    size_t alloc_hightide_bytes;
    size_t free_hightide_blocks;
    size_t free_hightide_bytes;
    /*----------------------------------------------------- */
    size_t alloc_failures;
    /*----------------------------------------------------- */
};
/****************************************************************
 * BLOCKPOOL OPERATIONS
 **************************************************************** */
extern void
    lub_blockpool_init(
        lub_blockpool_t *blockpool,
        void *memory,
        size_t blocksize,
        unsigned blockcount
    );

extern void *
    lub_blockpool_alloc(
        lub_blockpool_t *blockpool
    );

extern void
    lub_blockpool_free(
        lub_blockpool_t *blockpool,
        void *block
    );
void
    lub_blockpool__get_stats(
        lub_blockpool_t *instance,
        lub_blockpool_stats_t *stats
    );

#endif /* _lub_blockpool_h */

---