Improved memory debugging for xmalloc/nmem.c. References to NMEM
[yaz-moved-to-github.git] / include / nmem.h
1 /*
2  * Copyright (c) 1995-1997, 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  1997-10-31 12:20:08  adam
28  * Improved memory debugging for xmalloc/nmem.c. References to NMEM
29  * instead of ODR in n ESPEC-1 handling in source d1_espec.c.
30  * Bug fix: missing fclose in data1_read_espec1.
31  *
32  */
33
34 #ifndef NMEM_H
35 #define NMEM_H
36 #include <yconfig.h>
37
38 #define NMEM_DEBUG 0
39
40 #ifndef NMEM_DEBUG
41 #define NMEM_DEBUG 0
42 #endif
43
44 #ifdef __cplusplus
45 extern "C" {
46 #endif
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_control *NMEM;
64
65 YAZ_EXPORT void nmem_reset(NMEM n);
66 YAZ_EXPORT void *nmem_malloc(NMEM n, int size);
67 YAZ_EXPORT int nmem_total(NMEM n);
68 YAZ_EXPORT char *nmem_strdup (NMEM mem, const char *src);
69
70 #if NMEM_DEBUG
71
72 YAZ_EXPORT NMEM nmem_create_f(const char *file, int line);
73 YAZ_EXPORT void nmem_destroy_f(const char *file, int line, NMEM n);
74 #define nmem_create() nmem_create_f(__FILE__, __LINE__)
75 #define nmem_destroy(x) nmem_destroy_f(__FILE__, __LINE__, (x))
76
77 #else
78
79 YAZ_EXPORT NMEM nmem_create(void);
80 YAZ_EXPORT void nmem_destroy(NMEM n);
81
82 #endif
83
84 YAZ_EXPORT void nmem_init (void);
85 YAZ_EXPORT void nmem_exit (void);
86 #ifdef __cplusplus
87 }
88 #endif
89
90 #endif