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_s lub_blockpool_t;
struct lub_blockpool_s
{
    /* CLIENTS MUSTN'T TOUCH THESE DETAILS */
        lub_blockpool_t *head;
        lub_blockpool_t *tail;
};

/****************************************************************
 * 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
        );

#endif /* _lub_blockpool_h */

---