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.2  2000-02-28 11:20:06  adam
  28  * Using autoconf. New definitions: YAZ_BEGIN_CDECL/YAZ_END_CDECL.
  29  *
  30  * Revision 1.1  1999/11/30 13:47:11  adam
  31  * Improved installation. Moved header files to include/yaz.
  32  *
  33  * Revision 1.10  1998/10/19 15:24:20  adam
  34  * New nmem utility, nmem_transfer, that transfer blocks from one
  35  * NMEM to another.
  36  *
  37  * Revision 1.9  1998/10/13 16:00:17  adam
  38  * Implemented nmem_critical_{enter,leave}.
  39  *
  40  * Revision 1.8  1998/07/20 12:35:59  adam
  41  * Added more memory diagnostics (when NMEM_DEBUG is 1).
  42  *
  43  * Revision 1.7  1997/10/31 12:20:08  adam
  44  * Improved memory debugging for xmalloc/nmem.c. References to NMEM
  45  * instead of ODR in n ESPEC-1 handling in source d1_espec.c.
  46  * Bug fix: missing fclose in data1_read_espec1.
  47  *
  48  */
  49
  50 #ifndef NMEM_H
  51 #define NMEM_H
  52 #include <yaz/yconfig.h>
  53
  54 #define NMEM_DEBUG 0
  55
  56 #ifndef NMEM_DEBUG
  57 #define NMEM_DEBUG 0
  58 #endif
  59
  60 YAZ_BEGIN_CDECL
  61
  62 typedef struct nmem_block
  63 {
  64     char *buf;              /* memory allocated in this block */
  65     int size;               /* size of buf */
  66     int top;                /* top of buffer */
  67     struct nmem_block *next;
  68 } nmem_block;
  69
  70 typedef struct nmem_control
  71 {
  72     int total;
  73     nmem_block *blocks;
  74     struct nmem_control *next;
  75 } nmem_control;
  76
  77 typedef struct nmem_control *NMEM;
  78
  79 YAZ_EXPORT void nmem_reset(NMEM n);
  80 YAZ_EXPORT int nmem_total(NMEM n);
  81 YAZ_EXPORT char *nmem_strdup (NMEM mem, const char *src);
  82 YAZ_EXPORT void nmem_transfer (NMEM dst, NMEM src);
  83
  84 YAZ_EXPORT void nmem_critical_enter (void);
  85 YAZ_EXPORT void nmem_critical_leave (void);
  86
  87 #if NMEM_DEBUG
  88
  89 YAZ_EXPORT NMEM nmem_create_f(const char *file, int line);
  90 YAZ_EXPORT void nmem_destroy_f(const char *file, int line, NMEM n);
  91 YAZ_EXPORT void *nmem_malloc_f(const char *file, int line, NMEM n, int size);
  92 #define nmem_create() nmem_create_f(__FILE__, __LINE__)
  93 #define nmem_destroy(x) nmem_destroy_f(__FILE__, __LINE__, (x))
  94 #define nmem_malloc(x, y) nmem_malloc_f(__FILE__, __LINE__, (x), (y))
  95
  96 #else
  97
  98 YAZ_EXPORT NMEM nmem_create(void);
  99 YAZ_EXPORT void nmem_destroy(NMEM n);
 100 YAZ_EXPORT void *nmem_malloc(NMEM n, int size);
 101
 102 #endif
 103
 104 YAZ_EXPORT void nmem_init (void);
 105 YAZ_EXPORT void nmem_exit (void);
 106
 107 YAZ_END_CDECL
 108
 109 #endif