Allow a flag nmem_release_in_heap to be set (1) in which case
[yaz-moved-to-github.git] / src / nmem.c
index 9738a6f..233abcc 100644 (file)
@@ -1,8 +1,8 @@
 /*
- * Copyright (c) 1995-2004, Index Data.
+ * Copyright (C) 1995-2005, Index Data ApS
  * See the file LICENSE for details.
  *
- * $Id: nmem.c,v 1.4 2004-10-15 00:19:00 adam Exp $
+ * $Id: nmem.c,v 1.23 2006-08-09 14:00:18 adam Exp $
  */
 
 /**
  *
  * This is a simple and fairly wasteful little module for nibble memory
  * allocation. Evemtually we'll put in something better.
+ *
+ * FIXME - it also has some semaphore stuff, and stuff to handle errno.
+ *         These should be moved to some other place!
  */
 #if HAVE_CONFIG_H
 #include <config.h>
 #endif
 
 #include <assert.h>
+#include <stdlib.h>
 #include <string.h>
 #include <errno.h>
+#include <stddef.h>
 #include <yaz/xmalloc.h>
 #include <yaz/nmem.h>
 #include <yaz/log.h>
 
 #define NMEM_CHUNK (4*1024)
 
+struct nmem_block
+{
+    char *buf;              /* memory allocated in this block */
+    size_t size;            /* size of buf */
+    size_t top;             /* top of buffer */
+    struct nmem_block *next;
+};
+
+struct nmem_control
+{
+    int total;
+    nmem_block *blocks;
+    struct nmem_control *next;
+};
+
+struct align {
+    char x;
+    union {
+        char c;
+        short s;
+        int i;
+        long l;
+#if HAVE_LONG_LONG
+        long long ll;
+#endif
+        float f;
+        double d;
+    } u;
+};
+
+#define NMEM_ALIGN (offsetof(struct align, u))
+
+static int log_level = 0;
+static int log_level_initialized = 0;
+
 #ifdef WIN32
 static CRITICAL_SECTION critical_section;
 #define NMEM_ENTER EnterCriticalSection(&critical_section)
@@ -72,16 +112,22 @@ YAZ_EXPORT void nmem_mutex_create(NMEM_MUTEX *p)
     NMEM_ENTER;
     if (!*p)
     {
-       *p = (NMEM_MUTEX) malloc (sizeof(**p));
+        *p = (NMEM_MUTEX) malloc(sizeof(**p));
 #ifdef WIN32
-       InitializeCriticalSection(&(*p)->m_handle);
+        InitializeCriticalSection(&(*p)->m_handle);
 #elif YAZ_POSIX_THREADS
-       pthread_mutex_init (&(*p)->m_handle, 0);
+        pthread_mutex_init(&(*p)->m_handle, 0);
 #elif YAZ_GNU_THREADS
-        pth_mutex_init (&(*p)->m_handle);
+        pth_mutex_init(&(*p)->m_handle);
 #endif
     }
     NMEM_LEAVE;
+    if (!log_level_initialized)
+    {
+        log_level_initialized = 1;
+        log_level = yaz_log_module_level("nmem");
+    }
+
 }
 
 YAZ_EXPORT void nmem_mutex_enter(NMEM_MUTEX p)
@@ -89,9 +135,9 @@ YAZ_EXPORT void nmem_mutex_enter(NMEM_MUTEX p)
     if (p)
     {
 #ifdef WIN32
-       EnterCriticalSection(&p->m_handle);
+        EnterCriticalSection(&p->m_handle);
 #elif YAZ_POSIX_THREADS
-       pthread_mutex_lock(&p->m_handle);
+        pthread_mutex_lock(&p->m_handle);
 #endif
     }
 }
@@ -101,32 +147,33 @@ YAZ_EXPORT void nmem_mutex_leave(NMEM_MUTEX p)
     if (p)
     {
 #ifdef WIN32
-       LeaveCriticalSection(&p->m_handle);
+        LeaveCriticalSection(&p->m_handle);
 #elif YAZ_POSIX_THREADS
-       pthread_mutex_unlock(&p->m_handle);
+        pthread_mutex_unlock(&p->m_handle);
 #endif
     }
 }
 
 YAZ_EXPORT void nmem_mutex_destroy(NMEM_MUTEX *p)
 {
-    NMEM_ENTER;
     if (*p)
     {
 #ifdef WIN32
-       DeleteCriticalSection(&(*p)->m_handle);
+        DeleteCriticalSection(&(*p)->m_handle);
 #endif
-       free (*p);
-       *p = 0;
+        free(*p);
+        *p = 0;
     }
-    NMEM_LEAVE;
 }
 
-static nmem_block *freelist = NULL;        /* "global" freelists */
+static nmem_block *freelist = NULL;       /* "global" freelists */
 static nmem_control *cfreelist = NULL;
 static int nmem_active_no = 0;
 static int nmem_init_flag = 0;
 
+/** \brief whether nmem blocks should be reassigned to heap */
+static int nmem_release_in_heap = 0;
+
 #if NMEM_DEBUG
 struct nmem_debug_info {
     void *p;
@@ -140,18 +187,26 @@ struct nmem_debug_info *nmem_debug_list = 0;
 
 static void free_block(nmem_block *p)
 {  
-    memset(p->buf, 'Y', p->size);
-    p->next = freelist;
-    freelist = p;
-#if NMEM_DEBUG
-    yaz_log (LOG_DEBUG, "nmem free_block p=%p", p);
-#endif
+    if (nmem_release_in_heap)
+    {
+        xfree(p->buf);
+        xfree(p);
+    }
+    else
+    {
+        memset(p->buf, 'Y', p->size);
+        p->next = freelist;
+        freelist = p;
+    }
+    if (log_level)
+        yaz_log (log_level, "nmem free_block p=%p", p);
 }
 
 #if NMEM_DEBUG
 void nmem_print_list (void)
 {
-    nmem_print_list_l(LOG_DEBUG);
+    if (log_level)
+        nmem_print_list_l(log_level);
 }
 
 void nmem_print_list_l (int level)
@@ -161,45 +216,45 @@ void nmem_print_list_l (int level)
     yaz_log (level, "nmem print list");
     NMEM_ENTER;
     for (p = nmem_debug_list; p; p = p->next)
-       yaz_log (level, " %s:%d p=%p size=%d", p->file, p->line, p->p,
-                nmem_total(p->p));
+        yaz_log (level, " %s:%d p=%p size=%d", p->file, p->line, p->p,
+                 nmem_total(p->p));
     NMEM_LEAVE;
 }
 #endif
 /*
  * acquire a block with a minimum of size free bytes.
  */
-static nmem_block *get_block(int size)
+static nmem_block *get_block(size_t size)
 {
     nmem_block *r, *l;
 
-#if NMEM_DEBUG
-    yaz_log (LOG_DEBUG, "nmem get_block size=%d", size);
-#endif
+    if (log_level)
+        yaz_log (log_level, "nmem get_block size=%ld", (long) size);
+
     for (r = freelist, l = 0; r; l = r, r = r->next)
-       if (r->size >= size)
-           break;
+        if (r->size >= size)
+            break;
     if (r)
     {
-#if NMEM_DEBUG
-       yaz_log (LOG_DEBUG, "nmem get_block found free block p=%p", r);
-#endif
-       if (l)
-           l->next = r->next;
-       else
-           freelist = r->next;
+        if (log_level)
+            yaz_log (log_level, "nmem get_block found free block p=%p", r);
+        if (l)
+            l->next = r->next;
+        else
+            freelist = r->next;
     }
     else
     {
-       int get = NMEM_CHUNK;
+        size_t get = NMEM_CHUNK;
 
-       if (get < size)
-           get = size;
-#if NMEM_DEBUG
-       yaz_log (LOG_DEBUG, "nmem get_block alloc new block size=%d", get);
-#endif
-       r = (nmem_block *)xmalloc(sizeof(*r));
-       r->buf = (char *)xmalloc(r->size = get);
+        if (get < size)
+            get = size;
+        if(log_level)
+            yaz_log (log_level, "nmem get_block alloc new block size=%ld",
+                     (long) get);
+
+        r = (nmem_block *)xmalloc(sizeof(*r));
+        r->buf = (char *)xmalloc(r->size = get);
     }
     r->top = 0;
     return r;
@@ -208,18 +263,16 @@ static nmem_block *get_block(int size)
 void nmem_reset(NMEM n)
 {
     nmem_block *t;
-
-#if NMEM_DEBUG
-    yaz_log (LOG_DEBUG, "nmem_reset p=%p", n);
-#endif
+    
+    yaz_log (log_level, "nmem_reset p=%p", n);
     if (!n)
-       return;
+        return;
     NMEM_ENTER;
     while (n->blocks)
     {
-       t = n->blocks;
-       n->blocks = n->blocks->next;
-       free_block(t);
+        t = n->blocks;
+        n->blocks = n->blocks->next;
+        free_block(t);
     }
     n->total = 0;
     NMEM_LEAVE;
@@ -235,12 +288,13 @@ void *nmem_malloc(NMEM n, int size)
     char *r;
 
 #if NMEM_DEBUG
-    yaz_log (LOG_DEBUG, "%s:%d: nmem_malloc p=%p size=%d", file, line,
-                     n, size);
+    if (log_level)
+        yaz_log (log_level, "%s:%d: nmem_malloc p=%p size=%d", 
+                file, line, n, size);
 #endif
     if (!n)
     {
-        yaz_log (LOG_FATAL, "calling nmem_malloc with an null pointer");
+        yaz_log (YLOG_FATAL, "calling nmem_malloc with an null pointer");
         abort ();
     }
 #ifdef WIN32
@@ -248,15 +302,15 @@ void *nmem_malloc(NMEM n, int size)
 #endif
     NMEM_ENTER;
     p = n->blocks;
-    if (!p || p->size - p->top < size)
+    if (!p || p->size < size + p->top)
     {
-       p = get_block(size);
-       p->next = n->blocks;
-       n->blocks = p;
+        p = get_block(size);
+        p->next = n->blocks;
+        n->blocks = p;
     }
     r = p->buf + p->top;
     /* align size */
-    p->top += (size + (sizeof(long) - 1)) & ~(sizeof(long) - 1);
+    p->top += (size + (NMEM_ALIGN - 1)) & ~(NMEM_ALIGN - 1);
     n->total += size;
     NMEM_LEAVE;
     return r;
@@ -277,18 +331,23 @@ NMEM nmem_create(void)
 #if NMEM_DEBUG
     struct nmem_debug_info *debug_p;
 #endif
+    if (!log_level_initialized)
+    {
+        log_level = yaz_log_module_level("nmem");
+        log_level_initialized = 1;
+    }
     
     NMEM_ENTER;
     nmem_active_no++;
     r = cfreelist;
     if (r)
-       cfreelist = cfreelist->next;
+        cfreelist = cfreelist->next;
     else
-       r = (nmem_control *)xmalloc(sizeof(*r));
+        r = (nmem_control *)xmalloc(sizeof(*r));
     NMEM_LEAVE;
 
 #if NMEM_DEBUG
-    yaz_log (LOG_DEBUG, "%s:%d: nmem_create %d p=%p", file, line,
+    yaz_log (YLOG_DEBUG, "%s:%d: nmem_create %d p=%p", file, line,
                      nmem_active_no, r);
 #endif
     r->blocks = 0;
@@ -297,11 +356,11 @@ NMEM nmem_create(void)
 
 #if NMEM_DEBUG
     for (debug_p = nmem_debug_list; debug_p; debug_p = debug_p->next)
-       if (debug_p->p == r)
-       {
-           yaz_log (LOG_FATAL, "multi used block in nmem");
-           abort ();
-       }
+        if (debug_p->p == r)
+        {
+            yaz_log (YLOG_FATAL, "multi used block in nmem");
+            abort ();
+        }
     debug_p = xmalloc (sizeof(*debug_p));
     strncpy (debug_p->file, file, sizeof(debug_p->file)-1);
     debug_p->file[sizeof(debug_p->file)-1] = '\0';
@@ -326,46 +385,53 @@ void nmem_destroy(NMEM n)
     int ok = 0;
 #endif
     if (!n)
-       return;
+        return;
     
 #if NMEM_DEBUG
-    yaz_log (LOG_DEBUG, "%s:%d: nmem_destroy %d p=%p", file, line,
+    yaz_log (log_level, "%s:%d: nmem_destroy %d p=%p", file, line,
                      nmem_active_no-1, n);
     NMEM_ENTER;
     for (debug_p = &nmem_debug_list; *debug_p; debug_p = &(*debug_p)->next)
-       if ((*debug_p)->p == n)
-       {
-           struct nmem_debug_info *debug_save = *debug_p;
-           *debug_p = (*debug_p)->next;
-           xfree (debug_save);
-           ok = 1;
-           break;
-       }
+        if ((*debug_p)->p == n)
+        {
+            struct nmem_debug_info *debug_save = *debug_p;
+            *debug_p = (*debug_p)->next;
+            xfree (debug_save);
+            ok = 1;
+            break;
+        }
     NMEM_LEAVE;
     nmem_print_list();
     if (!ok)
     {
-       yaz_log (LOG_WARN, "%s:%d destroying unallocated nmem block p=%p",
-                file, line, n);
-       return;
+        yaz_log (YLOG_WARN, "%s:%d destroying unallocated nmem block p=%p",
+                 file, line, n);
+        return;
     }
 #endif
     nmem_reset(n);
     NMEM_ENTER;
     nmem_active_no--;
-    n->next = cfreelist;
-    cfreelist = n;
+    if (nmem_release_in_heap)
+    {
+        xfree(n);
+    }
+    else
+    {
+        n->next = cfreelist;
+        cfreelist = n;
+    }
     NMEM_LEAVE;
 }
 
 void nmem_transfer (NMEM dst, NMEM src)
 {
     nmem_block *t;
-    while ((t=src->blocks))
+    while ((t = src->blocks))
     {
-       src->blocks = t->next;
-       t->next = dst->blocks;
-       dst->blocks = t;
+        src->blocks = t->next;
+        t->next = dst->blocks;
+        dst->blocks = t;
     }
     dst->total += src->total;
     src->total = 0;
@@ -383,17 +449,22 @@ void nmem_critical_leave (void)
 
 void nmem_init (void)
 {
+    
     if (++nmem_init_flag == 1)
     {
 #ifdef WIN32
-       InitializeCriticalSection(&critical_section);
+        InitializeCriticalSection(&critical_section);
 #elif YAZ_GNU_THREADS
-       yaz_log (LOG_LOG, "pth_init");
         pth_init ();
 #endif
-       nmem_active_no = 0;
-       freelist = NULL;
-       cfreelist = NULL;
+        nmem_active_no = 0;
+        freelist = NULL;
+        cfreelist = NULL;
+    }
+    if (!log_level_initialized)
+    {
+        log_level = yaz_log_module_level("nmem");
+        log_level_initialized = 1;
     }
 }
 
@@ -402,21 +473,21 @@ void nmem_exit (void)
     if (--nmem_init_flag == 0)
     {
         oid_exit();
-       while (freelist)
-       {
-           struct nmem_block *fl = freelist;
-           freelist = freelist->next;
-           xfree (fl->buf);
-           xfree (fl);
-       }
-       while (cfreelist)
-       {
-           struct nmem_control *cfl = cfreelist;
-           cfreelist = cfreelist->next;
-           xfree (cfl);
-       }
+        while (freelist)
+        {
+            struct nmem_block *fl = freelist;
+            freelist = freelist->next;
+            xfree (fl->buf);
+            xfree (fl);
+        }
+        while (cfreelist)
+        {
+            struct nmem_control *cfl = cfreelist;
+            cfreelist = cfreelist->next;
+            xfree (cfl);
+        }
 #ifdef WIN32
-       DeleteCriticalSection(&critical_section);
+        DeleteCriticalSection(&critical_section);
 #endif
     }
 }
@@ -424,16 +495,16 @@ void nmem_exit (void)
 
 #ifdef WIN32
 BOOL WINAPI DllMain (HINSTANCE hinstDLL,
-                    DWORD reason,
-                    LPVOID reserved)
+                     DWORD reason,
+                     LPVOID reserved)
 {
     switch (reason)
     {
     case DLL_PROCESS_ATTACH:
-       nmem_init ();
-       break;
+        nmem_init ();
+        break;
     case DLL_PROCESS_DETACH:
-       nmem_exit ();
+        nmem_exit ();
     }
     return TRUE;
 }
@@ -451,22 +522,31 @@ void yaz_set_errno(int v)
 
 void yaz_strerror(char *buf, int max)
 {
+#ifdef WIN32
+    DWORD err;
+#endif
     char *cp;
+    if (!log_level_initialized)
+    {
+        log_level = yaz_log_module_level("nmem");
+        log_level_initialized = 1;
+    }
+    
 #ifdef WIN32
-    DWORD err = GetLastError();
+    err = GetLastError();
     if (err)
     {
         FormatMessage(
-               FORMAT_MESSAGE_FROM_SYSTEM,
-               NULL,
-               err,
-               MAKELANGID(LANG_NEUTRAL, SUBLANG_DEFAULT), /* Default lang */
-               (LPTSTR) buf,
-               max-1,
-               NULL);
+                FORMAT_MESSAGE_FROM_SYSTEM,
+                NULL,
+                err,
+                MAKELANGID(LANG_NEUTRAL, SUBLANG_DEFAULT), /* Default lang */
+                (LPTSTR) buf,
+                max-1,
+                NULL);
     }
     else
-       *buf = '\0';
+        *buf = '\0';
 #else
 /* UNIX */
 #if HAVE_STRERROR_R
@@ -484,8 +564,16 @@ void yaz_strerror(char *buf, int max)
 #endif
 /* UNIX */
 #endif
-    if ((cp=strrchr(buf, '\n')))
-       *cp = '\0';
-    if ((cp=strrchr(buf, '\r')))
-       *cp = '\0';
+    if ((cp = strrchr(buf, '\n')))
+        *cp = '\0';
+    if ((cp = strrchr(buf, '\r')))
+        *cp = '\0';
 }
+/*
+ * Local variables:
+ * c-basic-offset: 4
+ * indent-tabs-mode: nil
+ * End:
+ * vim: shiftwidth=4 tabstop=8 expandtab
+ */
+