include/yaz/nmem.h

   1 /*
   2  * Copyright (C) 1995-2005, Index Data ApS
   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  * $Id: nmem.h,v 1.15 2005-05-02 19:14:33 adam Exp $
  27  */
  28
  29 /**
  30  * \file nmem.h
  31  * \brief Header for Nibble Memory functions
  32  *
  33  * This is a simple and fairly wasteful little module for nibble memory
  34  * allocation. Evemtually we'll put in something better.
  35  */
  36 #ifndef NMEM_H
  37 #define NMEM_H
  38 #include <yaz/yconfig.h>
  39
  40 #define NMEM_DEBUG 0
  41
  42 #ifndef NMEM_DEBUG
  43 #define NMEM_DEBUG 0
  44 #endif
  45
  46 YAZ_BEGIN_CDECL
  47
  48 typedef struct nmem_block
  49 {
  50     char *buf;              /* memory allocated in this block */
  51     int size;               /* size of buf */
  52     int top;                /* top of buffer */
  53     struct nmem_block *next;
  54 } nmem_block;
  55
  56 typedef struct nmem_control
  57 {
  58     int total;
  59     nmem_block *blocks;
  60     struct nmem_control *next;
  61 } nmem_control;
  62
  63 typedef struct nmem_mutex *NMEM_MUTEX;
  64 YAZ_EXPORT void nmem_mutex_create(NMEM_MUTEX *);
  65 YAZ_EXPORT void nmem_mutex_enter(NMEM_MUTEX);
  66 YAZ_EXPORT void nmem_mutex_leave(NMEM_MUTEX);
  67 YAZ_EXPORT void nmem_mutex_destroy(NMEM_MUTEX *);
  68
  69 typedef struct nmem_control *NMEM;
  70
  71 YAZ_EXPORT void nmem_reset(NMEM n);
  72 YAZ_EXPORT int nmem_total(NMEM n);
  73 YAZ_EXPORT char *nmem_strdup (NMEM mem, const char *src);
  74 YAZ_EXPORT char *nmem_strdupn (NMEM mem, const char *src, size_t n);
  75 YAZ_EXPORT void nmem_strsplit_blank(NMEM nmem, const char *dstr,
  76                                     char ***darray, int *num);
  77 YAZ_EXPORT void nmem_strsplit(NMEM nmem, const char *delim,
  78                               const char *dstr,
  79                               char ***darray, int *num);
  80
  81 YAZ_EXPORT int *nmem_intdup (NMEM mem, int v);
  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 YAZ_EXPORT void nmem_print_list (void);
  97 YAZ_EXPORT void nmem_print_list_l (int level);
  98
  99 #else
 100
 101 YAZ_EXPORT NMEM nmem_create(void);
 102 YAZ_EXPORT void nmem_destroy(NMEM n);
 103 YAZ_EXPORT void *nmem_malloc(NMEM n, int size);
 104
 105 #define nmem_print_list()
 106
 107 #endif
 108
 109 YAZ_EXPORT void nmem_init (void);
 110 YAZ_EXPORT void nmem_exit (void);
 111 YAZ_EXPORT int yaz_errno (void);
 112 YAZ_EXPORT void yaz_set_errno (int v);
 113 YAZ_EXPORT void yaz_strerror(char *buf, int max);
 114
 115 YAZ_END_CDECL
 116
 117 #endif