---

chunkallocator.h

Go to the documentation of this file.

/***************************************************************************
 *  @file  chunkallocator.h
 *  @brief chunkallocator Header File.
 *
 *  @date   : 15-08-03 00:45
 *  @author : Pedro Ortega C. <peortega@dcc.uchile.cl>
 *  Copyright  2003  Pedro Ortega C.
 ****************************************************************************/
/*
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2 of the License, or
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU Library General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 */


#ifndef _CHUNKALLOCATOR_H_
#define _CHUNKALLOCATOR_H_



/******************************************/
/* Macros and Definitions                 */
/******************************************/

/**
 * @brief Minimum of Chunkblock.
 * @ingroup chunkallocator_doc
 *
 * This is the size of the first chunkblock to be created. If full, subsequent
 * chunkblocks double its predecessor's size.
 */
#define CHUNKBLOCK_MINSIZE 32



/******************************************/
/* Typedefs                               */
/******************************************/

/**
 * @brief Chunkblock.
 * @ingroup chunkallocator_doc
 *
 * The structure that holds the information of a single chunkblock. The begin
 * and endpointer delimite the chunkblock.
 */
typedef struct
{
    unsigned char *beginptr;
    unsigned char *endptr;
} chunkblock;

/**
 * @brief Chunkallocator structure.
 * @ingroup chunkallocator_doc
 *
 * This is the structure that makes a Chunkallocator. Its fields hold the
 * information for managing the memory.
 */
typedef struct
{
    size_t          binsize;     /**< The size of the bins.                   */
    size_t          allocated;   /**< The number of currently allocated bins. */
    size_t          deallocated; /**< The number of the currently deallocated
                                      bins.                                   */
    unsigned char **nextdealloc; /**< Pointer to the first deallocated bin.   */
    unsigned char  *nextfree;    /**< Pointer to the next free bin.           */
    chunkblock     *cblock;      /**< Pointer to currently used chunkblock.   */
    chunkblock     *memblocks;   /**< Array of chunkblocks.                   */
} chunkallocator;



/******************************************/
/* Public Interface                       */
/******************************************/

chunkallocator *
chunkallocator_new (size_t binsize);

void
chunkallocator_destroy (chunkallocator *a);

void *
chunkallocator_alloc (chunkallocator *a);

void
gnn_chunkallocator_free (chunkallocator *a, void *memblock);


#endif /* _GNN_CHUNKALLOCATOR_H_ */

---