[svn-r2073] Added free-list code to the library and took out the older "temporary buffer"

code, since the functionality was superceded.  See the followup document for
details on the free-list code.

1 files changed, 173 insertions, 0 deletions

diff --git a/src/H5FLprivate.h b/src/H5FLprivate.h
new file mode 100644
index 0000000..d5caa32
--- /dev/null
+++ b/src/H5FLprivate.h
@@ -0,0 +1,173 @@
+/*-------------------------------------------------------------------------
+ * Copyright (C) 2000	National Center for Supercomputing Applications.
+ *			All rights reserved.
+ *
+ *-------------------------------------------------------------------------
+ *
+ * Created:		H5FLprivate.h
+ *			Mar 23 2000
+ *			Quincey Koziol <koziol@ncsa.uiuc.edu>
+ *
+ * Purpose:		Private non-prototype header.
+ *
+ * Modifications:
+ *
+ *-------------------------------------------------------------------------
+ */
+#ifndef _H5FLprivate_H
+#define _H5FLprivate_H
+
+/* Public headers needed by this file */
+#ifdef LATER
+#include <H5FLpublic.h>		/*API prototypes			     */
+#endif /* LATER */
+
+/* Private headers needed by this file */
+
+/*
+ * Private datatypes.
+ */
+
+/* Data structure to store each block in free list */
+typedef struct H5FL_node_t {
+    struct H5FL_node_t *next;   /* Pointer to next block in free list */
+#ifdef H5FL_DEBUG
+    uintn inuse;                /* Indicate when object is in use */
+#endif /* H5FL_DEBUG */
+    unsigned char block;        /* Actual storage for the data */
+} H5FL_node_t;
+
+/* Data structure for free list of blocks */
+typedef struct H5FL_head_t {
+    uintn init;         /* Whether the free list has been initialized */
+    uintn allocated;    /* Number of blocks allocated */
+    uintn onlist;       /* Number of blocks on free list */
+    const char *name;   /* Name of the type */
+    size_t size;        /* Size of the blocks in the list */
+    H5FL_node_t *list;  /* List of free blocks */
+} H5FL_head_t;
+
+/*
+ * Macros for defining & using free lists for a type
+ */
+/* Declare a free list to manage objects of type 't' */
+#define H5FL_DEFINE(t)  H5FL_head_t t##_free_list={0,0,0,#t,sizeof(t),NULL}
+
+/* Reference a free list for type 't' defined in another file */
+#define H5FL_EXTERN(t)  extern H5FL_head_t t##_free_list
+
+/* Declare a static free list to manage objects of type 't' */
+#define H5FL_DEFINE_STATIC(t)  static H5FL_DEFINE(t)
+
+/* Allocate an object of type 't' */
+#define H5FL_ALLOC(t,clr) H5FL_alloc(&(t##_free_list),clr)
+
+/* Free an object of type 't' */
+#define H5FL_FREE(t,obj) H5FL_free(&(t##_free_list),obj)
+
+/* Re-allocating an object of type 't' is not defined, because these free-lists
+ * only support fixed sized types, like structs, etc..
+ */
+
+/* Data structure to store each block in free list */
+typedef struct H5FL_blk_list_t {
+    size_t size;                /* Size of the page */
+    struct H5FL_blk_list_t *next;   /* Pointer to next block in free list */
+    unsigned char block;        /* Actual storage for the data */
+} H5FL_blk_list_t;
+
+/* Data structure for priority queue node of block free lists */
+typedef struct H5FL_blk_node_t {
+    size_t size;            /* Size of the blocks in the list */
+    H5FL_blk_list_t *list;      /* List of free blocks */
+    struct H5FL_blk_node_t *next;    /* Pointer to next free list in queue */
+    struct H5FL_blk_node_t *prev;    /* Pointer to previous free list in queue */
+} H5FL_blk_node_t;
+
+/* Data structure for priority queue of native block free lists */
+typedef struct H5FL_blk_head_t {
+    uintn init;         /* Whether the free list has been initialized */
+    uintn allocated;    /* Number of blocks allocated */
+    uintn onlist;       /* Number of blocks on free list */
+    const char *name;   /* Name of the type */
+    H5FL_blk_node_t *head;  /* Pointer to first free list in queue */
+}H5FL_blk_head_t;
+
+/*
+ * Macros for defining & using priority queues 
+ */
+/* Declare a free list to manage objects of type 't' */
+#define H5FL_BLK_DEFINE(t)  H5FL_blk_head_t t##_pq={0,0,0,#t,NULL}
+
+/* Reference a free list for type 't' defined in another file */
+#define H5FL_BLK_EXTERN(t)  extern H5FL_blk_head_t t##_pq
+
+/* Declare a static free list to manage objects of type 't' */
+#define H5FL_BLK_DEFINE_STATIC(t)  static H5FL_BLK_DEFINE(t)
+
+/* Allocate an block of type 't' */
+#define H5FL_BLK_ALLOC(t,size,clr) H5FL_blk_alloc(&(t##_pq),size,clr)
+
+/* Free a block of type 't' */
+#define H5FL_BLK_FREE(t,blk) H5FL_blk_free(&(t##_pq),blk)
+
+/* Re-allocate a block of type 't' */
+#define H5FL_BLK_REALLOC(t,blk,new_size) H5FL_blk_realloc(&(t##_pq),blk,new_size)
+
+/* Data structure to store each array in free list */
+typedef struct H5FL_arr_node_t {
+    struct H5FL_arr_node_t *next;   /* Pointer to next block in free list */
+    size_t nelem;               /* Number of elements in this array */
+    unsigned char arr;          /* Actual storage for the array data */
+} H5FL_arr_node_t;
+
+/* Data structure for free list of array blocks */
+typedef struct H5FL_arr_head_t {
+    uintn init;         /* Whether the free list has been initialized */
+    uintn allocated;    /* Number of blocks allocated */
+    uintn onlist;       /* Number of blocks on free list */
+    const char *name;   /* Name of the type */
+    intn  maxelem;      /* Maximum number of elements in an array */
+    size_t size;        /* Size of the array elements in the list */
+    union {
+        H5FL_arr_node_t **list_arr;  /* Array of lists of free blocks */
+        H5FL_blk_head_t queue;  /* Priority queue of array blocks */
+    }u;
+} H5FL_arr_head_t;
+
+/*
+ * Macros for defining & using free lists for an array of a type
+ */
+/* Declare a free list to manage arrays of type 't' */
+#define H5FL_ARR_DEFINE(t,m)  H5FL_arr_head_t t##_arr_free_list={0,0,0,#t##"_arr",m,sizeof(t),{NULL}}
+
+/* Reference a free list for arrays of type 't' defined in another file */
+#define H5FL_ARR_EXTERN(t)  extern H5FL_arr_head_t t##_arr_free_list
+
+/* Declare a static free list to manage arrays of type 't' */
+#define H5FL_ARR_DEFINE_STATIC(t,m)  static H5FL_ARR_DEFINE(t,m)
+
+/* Allocate an array of type 't' */
+#define H5FL_ARR_ALLOC(t,elem,clr) H5FL_arr_alloc(&(t##_arr_free_list),elem,clr)
+
+/* Free an array of type 't' */
+#define H5FL_ARR_FREE(t,obj) H5FL_arr_free(&(t##_arr_free_list),obj)
+
+/* Re-allocate an array of type 't' */
+#define H5FL_ARR_REALLOC(t,obj,new_elem) H5FL_arr_realloc(&(t##_arr_free_list),obj,new_elem)
+
+/*
+ * Library prototypes.
+ */
+__DLL__ void * H5FL_blk_alloc(H5FL_blk_head_t *head, size_t size, uintn clear);
+__DLL__ void * H5FL_blk_free(H5FL_blk_head_t *head, void *block);
+__DLL__ void * H5FL_blk_realloc(H5FL_blk_head_t *head, void *block, size_t new_size);
+__DLL__ void * H5FL_alloc(H5FL_head_t *head, uintn clear);
+__DLL__ void * H5FL_free(H5FL_head_t *head, void *obj);
+__DLL__ void * H5FL_arr_alloc(H5FL_arr_head_t *head, uintn elem, uintn clear);
+__DLL__ void * H5FL_arr_free(H5FL_arr_head_t *head, void *obj);
+__DLL__ void * H5FL_arr_realloc(H5FL_arr_head_t *head, void *obj, uintn new_elem);
+__DLL__ herr_t H5FL_garbage_coll(void);
+__DLL__ intn   H5FL_term_interface(void);
+
+#endif