l_alloc_new.h

Go to the documentation of this file.

/*****************************************************************************\
 *  Copyright  1993  The Board of Trustees of the University of Illinois.
 *  All rights reserved.
 *
 *  l_alloc_new.h, part of the IMPACT memory-allocation manager
 *  John C. Gyllenhaal, Wen-mei Hwu, and The IMPACT Research Group
 *  Coordinated Science Laboratory
 *  University of Illinois at Urbana-Champaign
 *
 *  The IMPACT Research Group may be contacted at impact@crhc.uiuc.edu.
 *
 *  l_alloc_new.h (part of the IMPACT memory-allocation manager),
 *  including both binary and source (hereafter, Software) is copyrighted by
 *  The Board of Trustees of the University of Illinois (UI),
 *  and ownership remains with the UI.
 *
 *  The UI grants you (hereafter, Licensee) a license to use the Software for
 *  academic, research and internal business purposes only, without a fee.
 *  Licensee may distribute the Software to third parties provided that the
 *  copyright notice and this statement appears on all copies and that no
 *  charge is associated with such copies.
 *
 *  Licensee may make derivative works.  However, if Licensee distributes
 *  any derivative work based on or derived from the Software, then Licensee
 *  will clearly notify users that such derivative work is a modified
 *  version and not the original Software distributed by the UI.
 *
 *  Any Licensee wishing to make commercial use of the Software should contact
 *  the UI, c/o the Research and Technology Management Office [rtmo@uiuc.edu],
 *  to negotiate an appropriate license for such commercial use.  Commercial
 *  use includes (1) integration of all or part of the source code into a
 *  product for sale or license by or on behalf of Licensee to third parties,
 *  or (2) distribution of the Software to third parties that need it to
 *  utilize a commercial product sold or licensed by or on behalf of Licensee.
 *
 *  UI MAKES NO REPRESENTATIONS ABOUT THE SUITABILITY OF THIS SOFTWARE FOR
 *  ANY PURPOSE.  IT IS PROVIDED "AS IS" WITHOUT EXPRESS OR IMPLIED WARRANTY.
 *  THE UI SHALL NOT BE LIABLE FOR ANY DAMAGES SUFFERED BY THE USERS OF THIS
 *  SOFTWARE.
 *
 *  By using or copying this Software, Licensee agrees to abide by the
 *  copyright law and all other applicable laws of the U.S. including, but
 *  not limited to, export control laws, and the terms of this license.
 *  UI shall have the right to terminate this license immediately by written
 *  notice upon Licensee's breach of, or non-compliance with, any of its terms.
 *  Licensee may be held legally responsible for any copyright infringement
 *  that is caused or encouraged by Licensee's failure to abide by the terms
 *  of this license.
 *
 *  Form approved by University Counsel, M.A.R., 05/10/93
\*****************************************************************************/
/*===========================================================================
 *
 *      File :          l_alloc_new.h
 *      Description :   New and improved data structure allocation/mgmt
 *      Creation Date : May 1993
 *      Authors :       John C. Gyllenhaal and Wen-mei Hwu
 *      Contributors:   Roger Bringmann and Scott Mahlke
 *
 *==========================================================================*/
#ifndef L_ALLOC_NEW_H
#define L_ALLOC_NEW_H

#include <stdio.h>

typedef struct L_Alloc_Pool_Header
{
        struct L_Alloc_Pool_Header   *next;
} L_Alloc_Pool_Header;

typedef struct L_Alloc_Pool
{
    char                        *name;
    int                         element_size;     
    int                         block_size;  /* Block size to allocate */
    int                         num_in_block;/* Num elements in block */
    struct L_Alloc_Pool_Header  *head;       /* Pointer to head of free list*/
    int                         allocated;   /* Number allocated */
    int                         free;        /* Number free */
    int                         blocks_allocated; 
    struct L_Alloc_Pool_Header  *block_list; /* Pointer to blocks allocated */
    int                         bypass_routines;
} L_Alloc_Pool;


/* Prototypes */
#ifdef __cplusplus
extern "C" {
#endif

extern L_Alloc_Pool *L_create_alloc_pool (char *, int, int);
        /* (char *name, int size, int num_in_block) */
extern void L_free_alloc_pool (L_Alloc_Pool *);
        /* (L_Alloc_Pool *pool) */

extern void *L_alloc (L_Alloc_Pool *);
        /* (L_Alloc_Pool *pool) */
extern void L_free (L_Alloc_Pool *, void *);
        /* (L_Alloc_Pool *pool, void *ptr) */
extern void L_print_alloc_info(FILE *, L_Alloc_Pool *, int);
        /* (FILE *F, L_Alloc_Pool *pool, int verbose) */

#ifdef __cplusplus
}
#endif


/* 
 * Set this to 1 before creating an alloc pool to bypass alloc routines
 * so that malloc and free are called each time L_alloc and L_free are called
 * with that alloc pool. 
 * This allows efficient use of the debug malloc routines.
 */

#ifdef __cplusplus
extern "C" {
#endif

extern int bypass_alloc_routines;

#ifdef __cplusplus
}
#endif

#endif

---