include/yaz/nmem.h

   1 /*
   2  * Copyright (c) 1995-2000, Index Data.
   3  *
   4  * Permission to use, copy, modify, distribute, and sell this software and
   5  * its documentation, in whole or in part, for any purpose, is hereby granted,
   6  * provided that:
   7  *
   8  * 1. This copyright and permission notice appear in all copies of the
   9  * software and its documentation. Notices of copyright or attribution
  10  * which appear at the beginning of any file must remain unchanged.
  11  *
  12  * 2. The names of Index Data or the individual authors may not be used to
  13  * endorse or promote products derived from this software without specific
  14  * prior written permission.
  15  *
  16  * THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT WARRANTY OF ANY KIND,
  17  * EXPRESS, IMPLIED, OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY
  18  * WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
  19  * IN NO EVENT SHALL INDEX DATA BE LIABLE FOR ANY SPECIAL, INCIDENTAL,
  20  * INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND, OR ANY DAMAGES
  21  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER OR
  22  * NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF
  23  * LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
  24  * OF THIS SOFTWARE.
  25  *
  26  * $Log: nmem.h,v $
  27  * Revision 1.4  2000-05-09 11:48:58  adam
  28  * Fix (bug introduced by previous commit).
  29  *
  30  * Revision 1.3  2000/05/09 10:55:05  adam
  31  * Public nmem_print_list (for debugging).
  32  *
  33  * Revision 1.2  2000/02/28 11:20:06  adam
  34  * Using autoconf. New definitions: YAZ_BEGIN_CDECL/YAZ_END_CDECL.
  35  *
  36  * Revision 1.1  1999/11/30 13:47:11  adam
  37  * Improved installation. Moved header files to include/yaz.
  38  *
  39  * Revision 1.10  1998/10/19 15:24:20  adam
  40  * New nmem utility, nmem_transfer, that transfer blocks from one
  41  * NMEM to another.
  42  *
  43  * Revision 1.9  1998/10/13 16:00:17  adam
  44  * Implemented nmem_critical_{enter,leave}.
  45  *
  46  * Revision 1.8  1998/07/20 12:35:59  adam
  47  * Added more memory diagnostics (when NMEM_DEBUG is 1).
  48  *
  49  * Revision 1.7  1997/10/31 12:20:08  adam
  50  * Improved memory debugging for xmalloc/nmem.c. References to NMEM
  51  * instead of ODR in n ESPEC-1 handling in source d1_espec.c.
  52  * Bug fix: missing fclose in data1_read_espec1.
  53  *
  54  */
  55
  56 #ifndef NMEM_H
  57 #define NMEM_H
  58 #include <yaz/yconfig.h>
  59
  60 #define NMEM_DEBUG 0
  61
  62 #ifndef NMEM_DEBUG
  63 #define NMEM_DEBUG 0
  64 #endif
  65
  66 YAZ_BEGIN_CDECL
  67
  68 typedef struct nmem_block
  69 {
  70     char *buf;              /* memory allocated in this block */
  71     int size;               /* size of buf */
  72     int top;                /* top of buffer */
  73     struct nmem_block *next;
  74 } nmem_block;
  75
  76 typedef struct nmem_control
  77 {
  78     int total;
  79     nmem_block *blocks;
  80     struct nmem_control *next;
  81 } nmem_control;
  82
  83 typedef struct nmem_control *NMEM;
  84
  85 YAZ_EXPORT void nmem_reset(NMEM n);
  86 YAZ_EXPORT int nmem_total(NMEM n);
  87 YAZ_EXPORT char *nmem_strdup (NMEM mem, const char *src);
  88 YAZ_EXPORT void nmem_transfer (NMEM dst, NMEM src);
  89
  90 YAZ_EXPORT void nmem_critical_enter (void);
  91 YAZ_EXPORT void nmem_critical_leave (void);
  92
  93 #if NMEM_DEBUG
  94
  95 YAZ_EXPORT NMEM nmem_create_f(const char *file, int line);
  96 YAZ_EXPORT void nmem_destroy_f(const char *file, int line, NMEM n);
  97 YAZ_EXPORT void *nmem_malloc_f(const char *file, int line, NMEM n, int size);
  98 #define nmem_create() nmem_create_f(__FILE__, __LINE__)
  99 #define nmem_destroy(x) nmem_destroy_f(__FILE__, __LINE__, (x))
 100 #define nmem_malloc(x, y) nmem_malloc_f(__FILE__, __LINE__, (x), (y))
 101
 102 YAZ_EXPORT void nmem_print_list (void);
 103
 104 #else
 105
 106 YAZ_EXPORT NMEM nmem_create(void);
 107 YAZ_EXPORT void nmem_destroy(NMEM n);
 108 YAZ_EXPORT void *nmem_malloc(NMEM n, int size);
 109
 110 #define nmem_print_list()
 111
 112 #endif
 113
 114 YAZ_EXPORT void nmem_init (void);
 115 YAZ_EXPORT void nmem_exit (void);
 116
 117 YAZ_END_CDECL
 118
 119 #endif