src/nmem.c

   1 /*
   2  * Copyright (C) 1995-2005, Index Data ApS
   3  * See the file LICENSE for details.
   4  *
   5  * $Id: nmem.c,v 1.22 2006-04-21 10:28:06 adam Exp $
   6  */
   7
   8 /**
   9  * \file nmem.c
  10  * \brief Implements Nibble Memory
  11  *
  12  * This is a simple and fairly wasteful little module for nibble memory
  13  * allocation. Evemtually we'll put in something better.
  14  *
  15  * FIXME - it also has some semaphore stuff, and stuff to handle errno.
  16  *         These should be moved to some other place!
  17  */
  18 #if HAVE_CONFIG_H
  19 #include <config.h>
  20 #endif
  21
  22 #include <assert.h>
  23 #include <stdlib.h>
  24 #include <string.h>
  25 #include <errno.h>
  26 #include <stddef.h>
  27 #include <yaz/xmalloc.h>
  28 #include <yaz/nmem.h>
  29 #include <yaz/log.h>
  30 #include <yaz/oid.h>
  31
  32 #ifdef WIN32
  33 #include <windows.h>
  34 #endif
  35
  36 #if YAZ_POSIX_THREADS
  37 #include <pthread.h>
  38 #endif
  39
  40 #if YAZ_GNU_THREADS
  41 #include <pth.h>
  42 #endif
  43
  44 #define NMEM_CHUNK (4*1024)
  45
  46 struct nmem_block
  47 {
  48     char *buf;              /* memory allocated in this block */
  49     size_t size;            /* size of buf */
  50     size_t top;             /* top of buffer */
  51     struct nmem_block *next;
  52 };
  53
  54 struct nmem_control
  55 {
  56     int total;
  57     nmem_block *blocks;
  58     struct nmem_control *next;
  59 };
  60
  61 struct align {
  62     char x;
  63     union {
  64         char c;
  65         short s;
  66         int i;
  67         long l;
  68 #if HAVE_LONG_LONG
  69         long long ll;
  70 #endif
  71         float f;
  72         double d;
  73     } u;
  74 };
  75
  76 #define NMEM_ALIGN (offsetof(struct align, u))
  77
  78 static int log_level = 0;
  79 static int log_level_initialized = 0;
  80
  81 #ifdef WIN32
  82 static CRITICAL_SECTION critical_section;
  83 #define NMEM_ENTER EnterCriticalSection(&critical_section)
  84 #define NMEM_LEAVE LeaveCriticalSection(&critical_section)
  85 struct nmem_mutex {
  86     CRITICAL_SECTION m_handle;
  87 };
  88 #elif YAZ_POSIX_THREADS
  89 static pthread_mutex_t nmem_mutex = PTHREAD_MUTEX_INITIALIZER;
  90 #define NMEM_ENTER pthread_mutex_lock(&nmem_mutex);
  91 #define NMEM_LEAVE pthread_mutex_unlock(&nmem_mutex);
  92 struct nmem_mutex {
  93     pthread_mutex_t m_handle;
  94 };
  95 #elif YAZ_GNU_THREADS
  96 static pth_mutex_t nmem_mutex = PTH_MUTEX_INIT;
  97 #define NMEM_ENTER pth_mutex_acquire(&nmem_mutex, 0, 0)
  98 #define NMEM_LEAVE pth_mutex_release(&nmem_mutex)
  99 struct nmem_mutex {
 100     pth_mutex_t m_handle;
 101 };
 102 #else
 103 #define NMEM_ENTER
 104 #define NMEM_LEAVE
 105 struct nmem_mutex {
 106     int dummy;
 107 };
 108 #endif
 109
 110 YAZ_EXPORT void nmem_mutex_create(NMEM_MUTEX *p)
 111 {
 112     NMEM_ENTER;
 113     if (!*p)
 114     {
 115         *p = (NMEM_MUTEX) malloc(sizeof(**p));
 116 #ifdef WIN32
 117         InitializeCriticalSection(&(*p)->m_handle);
 118 #elif YAZ_POSIX_THREADS
 119         pthread_mutex_init(&(*p)->m_handle, 0);
 120 #elif YAZ_GNU_THREADS
 121         pth_mutex_init(&(*p)->m_handle);
 122 #endif
 123     }
 124     NMEM_LEAVE;
 125     if (!log_level_initialized)
 126     {
 127         log_level_initialized = 1;
 128         log_level = yaz_log_module_level("nmem");
 129     }
 130
 131 }
 132
 133 YAZ_EXPORT void nmem_mutex_enter(NMEM_MUTEX p)
 134 {
 135     if (p)
 136     {
 137 #ifdef WIN32
 138         EnterCriticalSection(&p->m_handle);
 139 #elif YAZ_POSIX_THREADS
 140         pthread_mutex_lock(&p->m_handle);
 141 #endif
 142     }
 143 }
 144
 145 YAZ_EXPORT void nmem_mutex_leave(NMEM_MUTEX p)
 146 {
 147     if (p)
 148     {
 149 #ifdef WIN32
 150         LeaveCriticalSection(&p->m_handle);
 151 #elif YAZ_POSIX_THREADS
 152         pthread_mutex_unlock(&p->m_handle);
 153 #endif
 154     }
 155 }
 156
 157 YAZ_EXPORT void nmem_mutex_destroy(NMEM_MUTEX *p)
 158 {
 159     if (*p)
 160     {
 161 #ifdef WIN32
 162         DeleteCriticalSection(&(*p)->m_handle);
 163 #endif
 164         free(*p);
 165         *p = 0;
 166     }
 167 }
 168
 169 static nmem_block *freelist = NULL;        /* "global" freelists */
 170 static nmem_control *cfreelist = NULL;
 171 static int nmem_active_no = 0;
 172 static int nmem_init_flag = 0;
 173
 174 #if NMEM_DEBUG
 175 struct nmem_debug_info {
 176     void *p;
 177     char file[40];
 178     int line;
 179     struct nmem_debug_info *next;
 180 };
 181
 182 struct nmem_debug_info *nmem_debug_list = 0;
 183 #endif
 184
 185 static void free_block(nmem_block *p)
 186 {
 187     memset(p->buf, 'Y', p->size);
 188     p->next = freelist;
 189     freelist = p;
 190     if (log_level)
 191         yaz_log (log_level, "nmem free_block p=%p", p);
 192 }
 193
 194 #if NMEM_DEBUG
 195 void nmem_print_list (void)
 196 {
 197     if(log_level)
 198         nmem_print_list_l(log_level);
 199 }
 200
 201 void nmem_print_list_l (int level)
 202 {
 203     struct nmem_debug_info *p;
 204
 205     yaz_log (level, "nmem print list");
 206     NMEM_ENTER;
 207     for (p = nmem_debug_list; p; p = p->next)
 208         yaz_log (level, " %s:%d p=%p size=%d", p->file, p->line, p->p,
 209                  nmem_total(p->p));
 210     NMEM_LEAVE;
 211 }
 212 #endif
 213 /*
 214  * acquire a block with a minimum of size free bytes.
 215  */
 216 static nmem_block *get_block(size_t size)
 217 {
 218     nmem_block *r, *l;
 219
 220     if (log_level)
 221         yaz_log (log_level, "nmem get_block size=%ld", (long) size);
 222
 223     for (r = freelist, l = 0; r; l = r, r = r->next)
 224         if (r->size >= size)
 225             break;
 226     if (r)
 227     {
 228         if (log_level)
 229             yaz_log (log_level, "nmem get_block found free block p=%p", r);
 230         if (l)
 231             l->next = r->next;
 232         else
 233             freelist = r->next;
 234     }
 235     else
 236     {
 237         size_t get = NMEM_CHUNK;
 238
 239         if (get < size)
 240             get = size;
 241         if(log_level)
 242             yaz_log (log_level, "nmem get_block alloc new block size=%ld",
 243                      (long) get);
 244
 245         r = (nmem_block *)xmalloc(sizeof(*r));
 246         r->buf = (char *)xmalloc(r->size = get);
 247     }
 248     r->top = 0;
 249     return r;
 250 }
 251
 252 void nmem_reset(NMEM n)
 253 {
 254     nmem_block *t;
 255
 256     yaz_log (log_level, "nmem_reset p=%p", n);
 257     if (!n)
 258         return;
 259     NMEM_ENTER;
 260     while (n->blocks)
 261     {
 262         t = n->blocks;
 263         n->blocks = n->blocks->next;
 264         free_block(t);
 265     }
 266     n->total = 0;
 267     NMEM_LEAVE;
 268 }
 269
 270 #if NMEM_DEBUG
 271 void *nmem_malloc_f (const char *file, int line, NMEM n, int size)
 272 #else
 273 void *nmem_malloc(NMEM n, int size)
 274 #endif
 275 {
 276     struct nmem_block *p;
 277     char *r;
 278
 279 #if NMEM_DEBUG
 280     if (log_level)
 281         yaz_log (log_level, "%s:%d: nmem_malloc p=%p size=%d",
 282                 file, line, n, size);
 283 #endif
 284     if (!n)
 285     {
 286         yaz_log (YLOG_FATAL, "calling nmem_malloc with an null pointer");
 287         abort ();
 288     }
 289 #ifdef WIN32
 290     assert (nmem_init_flag);
 291 #endif
 292     NMEM_ENTER;
 293     p = n->blocks;
 294     if (!p || p->size < size + p->top)
 295     {
 296         p = get_block(size);
 297         p->next = n->blocks;
 298         n->blocks = p;
 299     }
 300     r = p->buf + p->top;
 301     /* align size */
 302     p->top += (size + (NMEM_ALIGN - 1)) & ~(NMEM_ALIGN - 1);
 303     n->total += size;
 304     NMEM_LEAVE;
 305     return r;
 306 }
 307
 308 int nmem_total(NMEM n)
 309 {
 310     return n->total;
 311 }
 312
 313 #if NMEM_DEBUG
 314 NMEM nmem_create_f(const char *file, int line)
 315 #else
 316 NMEM nmem_create(void)
 317 #endif
 318 {
 319     NMEM r;
 320 #if NMEM_DEBUG
 321     struct nmem_debug_info *debug_p;
 322 #endif
 323     if (!log_level_initialized)
 324     {
 325         log_level = yaz_log_module_level("nmem");
 326         log_level_initialized = 1;
 327     }
 328
 329     NMEM_ENTER;
 330     nmem_active_no++;
 331     r = cfreelist;
 332     if (r)
 333         cfreelist = cfreelist->next;
 334     else
 335         r = (nmem_control *)xmalloc(sizeof(*r));
 336     NMEM_LEAVE;
 337
 338 #if NMEM_DEBUG
 339     yaz_log (YLOG_DEBUG, "%s:%d: nmem_create %d p=%p", file, line,
 340                      nmem_active_no, r);
 341 #endif
 342     r->blocks = 0;
 343     r->total = 0;
 344     r->next = 0;
 345
 346 #if NMEM_DEBUG
 347     for (debug_p = nmem_debug_list; debug_p; debug_p = debug_p->next)
 348         if (debug_p->p == r)
 349         {
 350             yaz_log (YLOG_FATAL, "multi used block in nmem");
 351             abort ();
 352         }
 353     debug_p = xmalloc (sizeof(*debug_p));
 354     strncpy (debug_p->file, file, sizeof(debug_p->file)-1);
 355     debug_p->file[sizeof(debug_p->file)-1] = '\0';
 356     debug_p->line = line;
 357     debug_p->p = r;
 358     debug_p->next = nmem_debug_list;
 359     nmem_debug_list = debug_p;
 360
 361     nmem_print_list();
 362 #endif
 363     return r;
 364 }
 365
 366 #if NMEM_DEBUG
 367 void nmem_destroy_f(const char *file, int line, NMEM n)
 368 #else
 369 void nmem_destroy(NMEM n)
 370 #endif
 371 {
 372 #if NMEM_DEBUG
 373     struct nmem_debug_info **debug_p;
 374     int ok = 0;
 375 #endif
 376     if (!n)
 377         return;
 378
 379 #if NMEM_DEBUG
 380     yaz_log (log_level, "%s:%d: nmem_destroy %d p=%p", file, line,
 381                      nmem_active_no-1, n);
 382     NMEM_ENTER;
 383     for (debug_p = &nmem_debug_list; *debug_p; debug_p = &(*debug_p)->next)
 384         if ((*debug_p)->p == n)
 385         {
 386             struct nmem_debug_info *debug_save = *debug_p;
 387             *debug_p = (*debug_p)->next;
 388             xfree (debug_save);
 389             ok = 1;
 390             break;
 391         }
 392     NMEM_LEAVE;
 393     nmem_print_list();
 394     if (!ok)
 395     {
 396         yaz_log (YLOG_WARN, "%s:%d destroying unallocated nmem block p=%p",
 397                  file, line, n);
 398         return;
 399     }
 400 #endif
 401     nmem_reset(n);
 402     NMEM_ENTER;
 403     nmem_active_no--;
 404     n->next = cfreelist;
 405     cfreelist = n;
 406     NMEM_LEAVE;
 407 }
 408
 409 void nmem_transfer (NMEM dst, NMEM src)
 410 {
 411     nmem_block *t;
 412     while ((t = src->blocks))
 413     {
 414         src->blocks = t->next;
 415         t->next = dst->blocks;
 416         dst->blocks = t;
 417     }
 418     dst->total += src->total;
 419     src->total = 0;
 420 }
 421
 422 void nmem_critical_enter (void)
 423 {
 424     NMEM_ENTER;
 425 }
 426
 427 void nmem_critical_leave (void)
 428 {
 429     NMEM_LEAVE;
 430 }
 431
 432 void nmem_init (void)
 433 {
 434
 435     if (++nmem_init_flag == 1)
 436     {
 437 #ifdef WIN32
 438         InitializeCriticalSection(&critical_section);
 439 #elif YAZ_GNU_THREADS
 440         pth_init ();
 441 #endif
 442         nmem_active_no = 0;
 443         freelist = NULL;
 444         cfreelist = NULL;
 445     }
 446     if (!log_level_initialized)
 447     {
 448         log_level = yaz_log_module_level("nmem");
 449         log_level_initialized = 1;
 450     }
 451 }
 452
 453 void nmem_exit (void)
 454 {
 455     if (--nmem_init_flag == 0)
 456     {
 457         oid_exit();
 458         while (freelist)
 459         {
 460             struct nmem_block *fl = freelist;
 461             freelist = freelist->next;
 462             xfree (fl->buf);
 463             xfree (fl);
 464         }
 465         while (cfreelist)
 466         {
 467             struct nmem_control *cfl = cfreelist;
 468             cfreelist = cfreelist->next;
 469             xfree (cfl);
 470         }
 471 #ifdef WIN32
 472         DeleteCriticalSection(&critical_section);
 473 #endif
 474     }
 475 }
 476
 477
 478 #ifdef WIN32
 479 BOOL WINAPI DllMain (HINSTANCE hinstDLL,
 480                      DWORD reason,
 481                      LPVOID reserved)
 482 {
 483     switch (reason)
 484     {
 485     case DLL_PROCESS_ATTACH:
 486         nmem_init ();
 487         break;
 488     case DLL_PROCESS_DETACH:
 489         nmem_exit ();
 490     }
 491     return TRUE;
 492 }
 493 #endif
 494
 495 int yaz_errno(void)
 496 {
 497     return errno;
 498 }
 499
 500 void yaz_set_errno(int v)
 501 {
 502     errno = v;
 503 }
 504
 505 void yaz_strerror(char *buf, int max)
 506 {
 507 #ifdef WIN32
 508     DWORD err;
 509 #endif
 510     char *cp;
 511     if (!log_level_initialized)
 512     {
 513         log_level = yaz_log_module_level("nmem");
 514         log_level_initialized = 1;
 515     }
 516
 517 #ifdef WIN32
 518     err = GetLastError();
 519     if (err)
 520     {
 521         FormatMessage(
 522                 FORMAT_MESSAGE_FROM_SYSTEM,
 523                 NULL,
 524                 err,
 525                 MAKELANGID(LANG_NEUTRAL, SUBLANG_DEFAULT), /* Default lang */
 526                 (LPTSTR) buf,
 527                 max-1,
 528                 NULL);
 529     }
 530     else
 531         *buf = '\0';
 532 #else
 533 /* UNIX */
 534 #if HAVE_STRERROR_R
 535 #if YAZ_POSIX_THREADS
 536     *buf = '\0';
 537     strerror_r(errno, buf, max);
 538     /* if buffer is unset - use strerror anyway (GLIBC bug) */
 539     if (*buf == '\0')
 540         strcpy(buf, strerror(yaz_errno()));
 541 #else
 542     strcpy(buf, strerror(yaz_errno()));
 543 #endif
 544 #else
 545     strcpy(buf, strerror(yaz_errno()));
 546 #endif
 547 /* UNIX */
 548 #endif
 549     if ((cp = strrchr(buf, '\n')))
 550         *cp = '\0';
 551     if ((cp = strrchr(buf, '\r')))
 552         *cp = '\0';
 553 }
 554 /*
 555  * Local variables:
 556  * c-basic-offset: 4
 557  * indent-tabs-mode: nil
 558  * End:
 559  * vim: shiftwidth=4 tabstop=8 expandtab
 560  */
 561