include/yaz/nmem.h

   1 /*
   2  * Copyright (c) 1995-2001, 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.7  2002-09-10 18:41:18  adam
  28  * Added yaz_errno
  29  *
  30  * Revision 1.6  2001/06/26 14:11:27  adam
  31  * Added MUTEX functions for NMEM module (used by OID utility).
  32  *
  33  * Revision 1.5  2001/03/25 21:55:12  adam
  34  * Added odr_intdup. Ztest server returns TaskPackage for ItemUpdate.
  35  *
  36  * Revision 1.4  2000/05/09 11:48:58  adam
  37  * Fix (bug introduced by previous commit).
  38  *
  39  * Revision 1.3  2000/05/09 10:55:05  adam
  40  * Public nmem_print_list (for debugging).
  41  *
  42  * Revision 1.2  2000/02/28 11:20:06  adam
  43  * Using autoconf. New definitions: YAZ_BEGIN_CDECL/YAZ_END_CDECL.
  44  *
  45  * Revision 1.1  1999/11/30 13:47:11  adam
  46  * Improved installation. Moved header files to include/yaz.
  47  *
  48  * Revision 1.10  1998/10/19 15:24:20  adam
  49  * New nmem utility, nmem_transfer, that transfer blocks from one
  50  * NMEM to another.
  51  *
  52  * Revision 1.9  1998/10/13 16:00:17  adam
  53  * Implemented nmem_critical_{enter,leave}.
  54  *
  55  * Revision 1.8  1998/07/20 12:35:59  adam
  56  * Added more memory diagnostics (when NMEM_DEBUG is 1).
  57  *
  58  * Revision 1.7  1997/10/31 12:20:08  adam
  59  * Improved memory debugging for xmalloc/nmem.c. References to NMEM
  60  * instead of ODR in n ESPEC-1 handling in source d1_espec.c.
  61  * Bug fix: missing fclose in data1_read_espec1.
  62  *
  63  */
  64
  65 #ifndef NMEM_H
  66 #define NMEM_H
  67 #include <yaz/yconfig.h>
  68
  69 #define NMEM_DEBUG 0
  70
  71 #ifndef NMEM_DEBUG
  72 #define NMEM_DEBUG 0
  73 #endif
  74
  75 YAZ_BEGIN_CDECL
  76
  77 typedef struct nmem_block
  78 {
  79     char *buf;              /* memory allocated in this block */
  80     int size;               /* size of buf */
  81     int top;                /* top of buffer */
  82     struct nmem_block *next;
  83 } nmem_block;
  84
  85 typedef struct nmem_control
  86 {
  87     int total;
  88     nmem_block *blocks;
  89     struct nmem_control *next;
  90 } nmem_control;
  91
  92 typedef struct nmem_mutex *NMEM_MUTEX;
  93 YAZ_EXPORT void nmem_mutex_create(NMEM_MUTEX *);
  94 YAZ_EXPORT void nmem_mutex_enter(NMEM_MUTEX);
  95 YAZ_EXPORT void nmem_mutex_leave(NMEM_MUTEX);
  96 YAZ_EXPORT void nmem_mutex_destroy(NMEM_MUTEX *);
  97
  98 typedef struct nmem_control *NMEM;
  99
 100 YAZ_EXPORT void nmem_reset(NMEM n);
 101 YAZ_EXPORT int nmem_total(NMEM n);
 102 YAZ_EXPORT char *nmem_strdup (NMEM mem, const char *src);
 103 YAZ_EXPORT int *nmem_intdup (NMEM mem, int v);
 104 YAZ_EXPORT void nmem_transfer (NMEM dst, NMEM src);
 105
 106 YAZ_EXPORT void nmem_critical_enter (void);
 107 YAZ_EXPORT void nmem_critical_leave (void);
 108
 109 #if NMEM_DEBUG
 110
 111 YAZ_EXPORT NMEM nmem_create_f(const char *file, int line);
 112 YAZ_EXPORT void nmem_destroy_f(const char *file, int line, NMEM n);
 113 YAZ_EXPORT void *nmem_malloc_f(const char *file, int line, NMEM n, int size);
 114 #define nmem_create() nmem_create_f(__FILE__, __LINE__)
 115 #define nmem_destroy(x) nmem_destroy_f(__FILE__, __LINE__, (x))
 116 #define nmem_malloc(x, y) nmem_malloc_f(__FILE__, __LINE__, (x), (y))
 117
 118 YAZ_EXPORT void nmem_print_list (void);
 119
 120 #else
 121
 122 YAZ_EXPORT NMEM nmem_create(void);
 123 YAZ_EXPORT void nmem_destroy(NMEM n);
 124 YAZ_EXPORT void *nmem_malloc(NMEM n, int size);
 125
 126 #define nmem_print_list()
 127
 128 #endif
 129
 130 YAZ_EXPORT void nmem_init (void);
 131 YAZ_EXPORT void nmem_exit (void);
 132 YAZ_EXPORT int yaz_errno (void);
 133
 134 YAZ_END_CDECL
 135
 136 #endif