2 * Copyright (c) 1995-2001, Index Data.
3 * See the file LICENSE for details.
4 * Sebastian Hammer, Adam Dickmeiss
7 * Revision 1.30 2001-10-05 13:55:17 adam
8 * Added defines YAZ_GNU_THREADS, YAZ_POSIX_THREADS in code and yaz-config
10 * Revision 1.29 2001/10/04 00:37:58 adam
11 * Fixes for GNU threads (not working yet).
13 * Revision 1.28 2001/10/03 23:55:18 adam
14 * GNU threads support.
16 * Revision 1.27 2001/09/27 12:09:18 adam
17 * Function nmem_exit calls oid_exit (when reference is 0).
19 * Revision 1.26 2001/07/19 19:51:42 adam
20 * Added typecasts to make C++ happy.
22 * Revision 1.25 2001/06/26 14:11:27 adam
23 * Added MUTEX functions for NMEM module (used by OID utility).
25 * Revision 1.24 2000/05/11 14:37:55 adam
28 * Revision 1.23 2000/05/09 10:55:05 adam
29 * Public nmem_print_list (for debugging).
31 * Revision 1.22 2000/05/03 22:00:00 adam
32 * Reference counter (if multiple modules are init/freeing nmem).
34 * Revision 1.21 2000/02/29 13:44:55 adam
35 * Check for config.h (currently not generated).
37 * Revision 1.20 2000/01/06 14:59:13 adam
38 * Added oid_init/oid_exit. Changed oid_exit.
40 * Revision 1.19 1999/11/30 13:47:12 adam
41 * Improved installation. Moved header files to include/yaz.
43 * Revision 1.18 1999/08/27 09:40:32 adam
44 * Renamed logf function to yaz_log. Removed VC++ project files.
46 * Revision 1.17 1999/07/13 13:28:25 adam
47 * Better debugging for NMEM routines.
49 * Revision 1.16 1999/03/31 11:18:25 adam
50 * Implemented odr_strdup. Added Reference ID to backend server API.
52 * Revision 1.15 1999/02/11 09:10:26 adam
53 * Function nmem_init only mandatory on Windows.
55 * Revision 1.14 1999/02/02 13:57:40 adam
56 * Uses preprocessor define WIN32 instead of WINDOWS to build code
57 * for Microsoft WIN32.
59 * Revision 1.13 1998/10/19 15:24:21 adam
60 * New nmem utility, nmem_transfer, that transfer blocks from one
63 * Revision 1.12 1998/10/13 16:00:18 adam
64 * Implemented nmem_critical_{enter,leave}.
66 * Revision 1.11 1998/08/21 14:13:36 adam
67 * Added GNU Configure script to build Makefiles.
69 * Revision 1.10 1998/07/20 12:35:57 adam
70 * Added more memory diagnostics (when NMEM_DEBUG is 1).
72 * Revision 1.9 1998/07/07 15:49:01 adam
75 * Revision 1.8 1998/07/03 14:21:27 adam
76 * Added critical sections for pthreads-library. Thanks to Ian Ibbotson,
77 * Fretwell Downing Informatics.
79 * Revision 1.7 1998/02/11 11:53:36 adam
80 * Changed code so that it compiles as C++.
82 * Revision 1.6 1997/10/31 12:20:09 adam
83 * Improved memory debugging for xmalloc/nmem.c. References to NMEM
84 * instead of ODR in n ESPEC-1 handling in source d1_espec.c.
85 * Bug fix: missing fclose in data1_read_espec1.
87 * Revision 1.5 1997/10/06 09:09:52 adam
88 * Function mmem_exit releases memory used by the freelists.
90 * Revision 1.4 1997/09/29 07:12:50 adam
91 * NMEM thread safe. NMEM must be initialized before use (sigh) -
92 * routine nmem_init/nmem_exit implemented.
94 * Revision 1.3 1997/07/21 12:47:38 adam
95 * Moved definition of nmem_control and nmem_block.
97 * Revision 1.2 1995/12/13 13:44:37 quinn
98 * Modified Data1-system to use nmem
100 * Revision 1.1 1995/11/13 09:27:52 quinn
101 * Fiddling with the variant stuff.
107 * This is a simple and fairly wasteful little module for nibble memory
108 * allocation. Evemtually we'll put in something better.
116 #include <yaz/xmalloc.h>
117 #include <yaz/nmem.h>
125 #if YAZ_POSIX_THREADS
133 #define NMEM_CHUNK (4*1024)
136 static CRITICAL_SECTION critical_section;
137 #define NMEM_ENTER EnterCriticalSection(&critical_section)
138 #define NMEM_LEAVE LeaveCriticalSection(&critical_section)
140 CRITICAL_SECTION m_handle;
142 #elif YAZ_POSIX_THREADS
143 static pthread_mutex_t nmem_mutex = PTHREAD_MUTEX_INITIALIZER;
144 #define NMEM_ENTER pthread_mutex_lock(&nmem_mutex);
145 #define NMEM_LEAVE pthread_mutex_unlock(&nmem_mutex);
147 pthread_mutex_t m_handle;
149 #elif YAZ_GNU_THREADS
150 static pth_mutex_t nmem_mutex = PTH_MUTEX_INIT;
151 #define NMEM_ENTER pth_mutex_acquire(&nmem_mutex, 0, 0)
152 #define NMEM_LEAVE pth_mutex_release(&nmem_mutex)
154 pth_mutex_t m_handle;
164 YAZ_EXPORT void nmem_mutex_create(NMEM_MUTEX *p)
169 *p = (NMEM_MUTEX) malloc (sizeof(**p));
171 InitializeCriticalSection(&(*p)->m_handle);
172 #elif YAZ_POSIX_THREADS
173 pthread_mutex_init (&(*p)->m_handle, 0);
174 #elif YAZ_GNU_THREADS
175 pth_mutex_init (&(*p)->m_handle);
181 YAZ_EXPORT void nmem_mutex_enter(NMEM_MUTEX p)
186 EnterCriticalSection(&p->m_handle);
187 #elif YAZ_POSIX_THREADS
188 pthread_mutex_lock(&p->m_handle);
193 YAZ_EXPORT void nmem_mutex_leave(NMEM_MUTEX p)
198 LeaveCriticalSection(&p->m_handle);
199 #elif YAZ_POSIX_THREADS
200 pthread_mutex_unlock(&p->m_handle);
205 YAZ_EXPORT void nmem_mutex_destroy(NMEM_MUTEX *p)
211 DeleteCriticalSection(&(*p)->m_handle);
219 static nmem_block *freelist = NULL; /* "global" freelists */
220 static nmem_control *cfreelist = NULL;
221 static int nmem_active_no = 0;
222 static int nmem_init_flag = 0;
225 struct nmem_debug_info {
229 struct nmem_debug_info *next;
232 struct nmem_debug_info *nmem_debug_list = 0;
235 static void free_block(nmem_block *p)
240 yaz_log (LOG_DEBUG, "nmem free_block p=%p", p);
245 void nmem_print_list (void)
247 struct nmem_debug_info *p;
249 yaz_log (LOG_DEBUG, "nmem print list");
251 for (p = nmem_debug_list; p; p = p->next)
252 yaz_log (LOG_DEBUG, " %s:%d p=%p size=%d", p->file, p->line, p->p,
258 * acquire a block with a minimum of size free bytes.
260 static nmem_block *get_block(int size)
265 yaz_log (LOG_DEBUG, "nmem get_block size=%d", size);
267 for (r = freelist, l = 0; r; l = r, r = r->next)
273 yaz_log (LOG_DEBUG, "nmem get_block found free block p=%p", r);
282 int get = NMEM_CHUNK;
287 yaz_log (LOG_DEBUG, "nmem get_block alloc new block size=%d", get);
289 r = (nmem_block *)xmalloc(sizeof(*r));
290 r->buf = (char *)xmalloc(r->size = get);
296 void nmem_reset(NMEM n)
301 yaz_log (LOG_DEBUG, "nmem_reset p=%p", n);
309 n->blocks = n->blocks->next;
317 void *nmem_malloc_f (const char *file, int line, NMEM n, int size)
319 void *nmem_malloc(NMEM n, int size)
322 struct nmem_block *p;
326 yaz_log (LOG_DEBUG, "%s:%d: nmem_malloc p=%p size=%d", file, line,
332 return xmalloc(size);
335 assert (nmem_init_flag);
339 if (!p || p->size - p->top < size)
347 p->top += (size + (sizeof(long) - 1)) & ~(sizeof(long) - 1);
353 int nmem_total(NMEM n)
359 NMEM nmem_create_f(const char *file, int line)
361 NMEM nmem_create(void)
366 struct nmem_debug_info *debug_p;
373 cfreelist = cfreelist->next;
375 r = (nmem_control *)xmalloc(sizeof(*r));
379 yaz_log (LOG_DEBUG, "%s:%d: nmem_create %d p=%p", file, line,
387 for (debug_p = nmem_debug_list; debug_p; debug_p = debug_p->next)
390 yaz_log (LOG_FATAL, "multi used block in nmem");
393 debug_p = xmalloc (sizeof(*debug_p));
394 strncpy (debug_p->file, file, sizeof(debug_p->file)-1);
395 debug_p->file[sizeof(debug_p->file)-1] = '\0';
396 debug_p->line = line;
398 debug_p->next = nmem_debug_list;
399 nmem_debug_list = debug_p;
407 void nmem_destroy_f(const char *file, int line, NMEM n)
409 void nmem_destroy(NMEM n)
413 struct nmem_debug_info **debug_p;
420 yaz_log (LOG_DEBUG, "%s:%d: nmem_destroy %d p=%p", file, line,
421 nmem_active_no-1, n);
423 for (debug_p = &nmem_debug_list; *debug_p; debug_p = &(*debug_p)->next)
424 if ((*debug_p)->p == n)
426 struct nmem_debug_info *debug_save = *debug_p;
427 *debug_p = (*debug_p)->next;
436 yaz_log (LOG_WARN, "%s:%d destroying unallocated nmem block p=%p",
449 void nmem_transfer (NMEM dst, NMEM src)
452 while ((t=src->blocks))
454 src->blocks = t->next;
455 t->next = dst->blocks;
458 dst->total += src->total;
462 void nmem_critical_enter (void)
467 void nmem_critical_leave (void)
472 void nmem_init (void)
474 if (++nmem_init_flag == 1)
477 InitializeCriticalSection(&critical_section);
478 #elif YAZ_GNU_THREADS
479 yaz_log (LOG_LOG, "pth_init");
488 void nmem_exit (void)
490 if (--nmem_init_flag == 0)
495 struct nmem_block *fl = freelist;
496 freelist = freelist->next;
502 struct nmem_control *cfl = cfreelist;
503 cfreelist = cfreelist->next;
507 DeleteCriticalSection(&critical_section);