glib/gmem.c

   1 /* GLIB - Library of useful routines for C programming
   2  * Copyright (C) 1995-1997  Peter Mattis, Spencer Kimball and Josh MacDonald
   3  *
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Lesser General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2 of the License, or (at your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Lesser General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Lesser General Public
  15  * License along with this library; if not, write to the
  16  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  17  * Boston, MA 02111-1307, USA.
  18  */
  19
  20 /*
  21  * Modified by the GLib Team and others 1997-2000.  See the AUTHORS
  22  * file for a list of people on the GLib Team.  See the ChangeLog
  23  * files for a list of changes.  These files are distributed with
  24  * GLib at ftp://ftp.gtk.org/pub/gtk/.
  25  */
  26
  27 /*
  28  * MT safe
  29  */
  30
  31 #ifdef HAVE_CONFIG_H
  32 #include <config.h>
  33 #endif
  34
  35 #include <stdlib.h>
  36 #include <string.h>
  37 #include "glib.h"
  38
  39
  40 /* notes on macros:
  41  * having DISABLE_MEM_POOLS defined, disables mem_chunks alltogether, their
  42  * allocations are performed through ordinary g_malloc/g_free.
  43  * having G_DISABLE_CHECKS defined disables use of glib_mem_profiler_table and
  44  * g_mem_profile().
  45  * REALLOC_0_WORKS is defined if g_realloc (NULL, x) works.
  46  * SANE_MALLOC_PROTOS is defined if the systems malloc() and friends functions
  47  * match the corresponding GLib prototypes, keep configure.in and gmem.h in sync here.
  48  * if ENABLE_GC_FRIENDLY is defined, freed memory should be 0-wiped.
  49  */
  50
  51 #define MEM_PROFILE_TABLE_SIZE 4096
  52
  53 #define MEM_AREA_SIZE 4L
  54
  55 #ifdef  G_DISABLE_CHECKS
  56 #  define ENTER_MEM_CHUNK_ROUTINE()
  57 #  define LEAVE_MEM_CHUNK_ROUTINE()
  58 #  define IN_MEM_CHUNK_ROUTINE()        FALSE
  59 #else   /* !G_DISABLE_CHECKS */
  60 static GPrivate* mem_chunk_recursion = NULL;
  61 #  define MEM_CHUNK_ROUTINE_COUNT()     GPOINTER_TO_UINT (g_private_get (mem_chunk_recursion))
  62 #  define ENTER_MEM_CHUNK_ROUTINE()     g_private_set (mem_chunk_recursion, GUINT_TO_POINTER (MEM_CHUNK_ROUTINE_COUNT () + 1))
  63 #  define LEAVE_MEM_CHUNK_ROUTINE()     g_private_set (mem_chunk_recursion, GUINT_TO_POINTER (MEM_CHUNK_ROUTINE_COUNT () - 1))
  64 #endif  /* !G_DISABLE_CHECKS */
  65
  66 #ifndef REALLOC_0_WORKS
  67 static gpointer
  68 standard_realloc (gpointer mem,
  69                   gsize    n_bytes)
  70 {
  71   if (!mem)
  72     return malloc (n_bytes);
  73   else
  74     return realloc (mem, n_bytes);
  75 }
  76 #endif  /* !REALLOC_0_WORKS */
  77
  78 #ifdef SANE_MALLOC_PROTOS
  79 #  define standard_malloc       malloc
  80 #  ifdef REALLOC_0_WORKS
  81 #    define standard_realloc    realloc
  82 #  endif /* REALLOC_0_WORKS */
  83 #  define standard_free         free
  84 #  define standard_calloc       calloc
  85 #  define standard_try_malloc   malloc
  86 #  define standard_try_realloc  realloc
  87 #else   /* !SANE_MALLOC_PROTOS */
  88 static gpointer
  89 standard_malloc (gsize n_bytes)
  90 {
  91   return malloc (n_bytes);
  92 }
  93 #  ifdef REALLOC_0_WORKS
  94 static gpointer
  95 standard_realloc (gpointer mem,
  96                   gsize    n_bytes)
  97 {
  98   return realloc (mem, n_bytes);
  99 }
 100 #  endif /* REALLOC_0_WORKS */
 101 static void
 102 standard_free (gpointer mem)
 103 {
 104   free (mem);
 105 }
 106 static gpointer
 107 standard_calloc (gsize n_blocks,
 108                  gsize n_bytes)
 109 {
 110   return calloc (n_blocks, n_bytes);
 111 }
 112 #define standard_try_malloc     standard_malloc
 113 #define standard_try_realloc    standard_realloc
 114 #endif  /* !SANE_MALLOC_PROTOS */
 115
 116
 117 /* --- variables --- */
 118 static GMemVTable glib_mem_vtable = {
 119   standard_malloc,
 120   standard_realloc,
 121   standard_free,
 122   standard_calloc,
 123   standard_try_malloc,
 124   standard_try_realloc,
 125 };
 126
 127
 128 /* --- functions --- */
 129 gpointer
 130 g_malloc (gulong n_bytes)
 131 {
 132   if (n_bytes)
 133     {
 134       gpointer mem;
 135
 136       mem = glib_mem_vtable.malloc (n_bytes);
 137       if (mem)
 138         return mem;
 139
 140       g_error ("%s: failed to allocate %lu bytes", G_STRLOC, n_bytes);
 141     }
 142
 143   return NULL;
 144 }
 145
 146 gpointer
 147 g_malloc0 (gulong n_bytes)
 148 {
 149   if (n_bytes)
 150     {
 151       gpointer mem;
 152
 153       mem = glib_mem_vtable.calloc (1, n_bytes);
 154       if (mem)
 155         return mem;
 156
 157       g_error ("%s: failed to allocate %lu bytes", G_STRLOC, n_bytes);
 158     }
 159
 160   return NULL;
 161 }
 162
 163 gpointer
 164 g_realloc (gpointer mem,
 165            gulong   n_bytes)
 166 {
 167   if (n_bytes)
 168     {
 169       mem = glib_mem_vtable.realloc (mem, n_bytes);
 170       if (mem)
 171         return mem;
 172
 173       g_error ("%s: failed to allocate %lu bytes", G_STRLOC, n_bytes);
 174     }
 175
 176   if (mem)
 177     glib_mem_vtable.free (mem);
 178
 179   return NULL;
 180 }
 181
 182 void
 183 g_free (gpointer mem)
 184 {
 185   if (mem)
 186     glib_mem_vtable.free (mem);
 187 }
 188
 189 gpointer
 190 g_try_malloc (gulong n_bytes)
 191 {
 192   if (n_bytes)
 193     return glib_mem_vtable.try_malloc (n_bytes);
 194   else
 195     return NULL;
 196 }
 197
 198 gpointer
 199 g_try_realloc (gpointer mem,
 200                gulong   n_bytes)
 201 {
 202   if (n_bytes)
 203     return glib_mem_vtable.try_realloc (mem, n_bytes);
 204
 205   if (mem)
 206     glib_mem_vtable.free (mem);
 207
 208   return NULL;
 209 }
 210
 211 static gpointer
 212 fallback_calloc (gsize n_blocks,
 213                  gsize n_block_bytes)
 214 {
 215   gsize l = n_blocks * n_block_bytes;
 216   gpointer mem = glib_mem_vtable.malloc (l);
 217
 218   if (mem)
 219     memset (mem, 0, l);
 220
 221   return mem;
 222 }
 223
 224 static gboolean vtable_set = FALSE;
 225
 226 /**
 227  * g_mem_vtable_is_set:
 228  *
 229  * Checks whether a custom vtable as been set by g_mem_set_vtable.
 230  * If a custom vtable has not been set, memory allocated with
 231  * free() can be used interchangeable with memory allocated using
 232  * g_free(). This function is useful for avoiding an extra copy
 233  * of allocated memory returned by a non-GLib-based API.
 234  *
 235  * Return value: if %TRUE, a custom vtable has been set.
 236  **/
 237 gboolean
 238 g_mem_vtable_is_set (void)
 239 {
 240   return vtable_set;
 241 }
 242
 243 void
 244 g_mem_set_vtable (GMemVTable *vtable)
 245 {
 246   if (!vtable_set)
 247     {
 248       vtable_set = TRUE;
 249       if (vtable->malloc && vtable->realloc && vtable->free)
 250         {
 251           glib_mem_vtable.malloc = vtable->malloc;
 252           glib_mem_vtable.realloc = vtable->realloc;
 253           glib_mem_vtable.free = vtable->free;
 254           glib_mem_vtable.calloc = vtable->calloc ? vtable->calloc : fallback_calloc;
 255           glib_mem_vtable.try_malloc = vtable->try_malloc ? vtable->try_malloc : glib_mem_vtable.malloc;
 256           glib_mem_vtable.try_realloc = vtable->try_realloc ? vtable->try_realloc : glib_mem_vtable.realloc;
 257         }
 258       else
 259         g_warning (G_STRLOC ": memory allocation vtable lacks one of malloc(), realloc() or free()");
 260     }
 261   else
 262     g_warning (G_STRLOC ": memory allocation vtable can only be set once at startup");
 263 }
 264
 265
 266 /* --- memory profiling and checking --- */
 267 #ifdef  G_DISABLE_CHECKS
 268 GMemVTable *glib_mem_profiler_table = &glib_mem_vtable;
 269 void
 270 g_mem_profile (void)
 271 {
 272 }
 273 #else   /* !G_DISABLE_CHECKS */
 274 typedef enum {
 275   PROFILER_FREE         = 0,
 276   PROFILER_ALLOC        = 1,
 277   PROFILER_RELOC        = 2,
 278   PROFILER_ZINIT        = 4
 279 } ProfilerJob;
 280 static guint *profile_data = NULL;
 281 static gulong profile_allocs = 0;
 282 static gulong profile_mc_allocs = 0;
 283 static gulong profile_zinit = 0;
 284 static gulong profile_frees = 0;
 285 static gulong profile_mc_frees = 0;
 286 static GMutex *g_profile_mutex = NULL;
 287 #ifdef  G_ENABLE_DEBUG
 288 static volatile gulong g_trap_free_size = 0;
 289 static volatile gulong g_trap_realloc_size = 0;
 290 static volatile gulong g_trap_malloc_size = 0;
 291 #endif  /* G_ENABLE_DEBUG */
 292
 293 #define PROFILE_TABLE(f1,f2,f3)   ( ( ((f3) << 2) | ((f2) << 1) | (f1) ) * (MEM_PROFILE_TABLE_SIZE + 1))
 294
 295 static void
 296 profiler_log (ProfilerJob job,
 297               gulong      n_bytes,
 298               gboolean    success)
 299 {
 300   g_mutex_lock (g_profile_mutex);
 301   if (!profile_data)
 302     {
 303       profile_data = standard_malloc ((MEM_PROFILE_TABLE_SIZE + 1) * 8 * sizeof (profile_data[0]));
 304       if (!profile_data)        /* memory system kiddin' me, eh? */
 305         {
 306           g_mutex_unlock (g_profile_mutex);
 307           return;
 308         }
 309     }
 310
 311   if (MEM_CHUNK_ROUTINE_COUNT () == 0)
 312     {
 313       if (n_bytes < MEM_PROFILE_TABLE_SIZE)
 314         profile_data[n_bytes + PROFILE_TABLE ((job & PROFILER_ALLOC) != 0,
 315                                               (job & PROFILER_RELOC) != 0,
 316                                               success != 0)] += 1;
 317       else
 318         profile_data[MEM_PROFILE_TABLE_SIZE + PROFILE_TABLE ((job & PROFILER_ALLOC) != 0,
 319                                                              (job & PROFILER_RELOC) != 0,
 320                                                              success != 0)] += 1;
 321       if (success)
 322         {
 323           if (job & PROFILER_ALLOC)
 324             {
 325               profile_allocs += n_bytes;
 326               if (job & PROFILER_ZINIT)
 327                 profile_zinit += n_bytes;
 328             }
 329           else
 330             profile_frees += n_bytes;
 331         }
 332     }
 333   else if (success)
 334     {
 335       if (job & PROFILER_ALLOC)
 336         profile_mc_allocs += n_bytes;
 337       else
 338         profile_mc_frees += n_bytes;
 339     }
 340   g_mutex_unlock (g_profile_mutex);
 341 }
 342
 343 static void
 344 profile_print_locked (guint   *local_data,
 345                       gboolean success)
 346 {
 347   gboolean need_header = TRUE;
 348   guint i;
 349
 350   for (i = 0; i <= MEM_PROFILE_TABLE_SIZE; i++)
 351     {
 352       glong t_malloc = local_data[i + PROFILE_TABLE (1, 0, success)];
 353       glong t_realloc = local_data[i + PROFILE_TABLE (1, 1, success)];
 354       glong t_free = local_data[i + PROFILE_TABLE (0, 0, success)];
 355       glong t_refree = local_data[i + PROFILE_TABLE (0, 1, success)];
 356
 357       if (!t_malloc && !t_realloc && !t_free && !t_refree)
 358         continue;
 359       else if (need_header)
 360         {
 361           need_header = FALSE;
 362           g_print (" blocks of | allocated  | freed      | allocated  | freed      | n_bytes   \n");
 363           g_print ("  n_bytes  | n_times by | n_times by | n_times by | n_times by | remaining \n");
 364           g_print ("           | malloc()   | free()     | realloc()  | realloc()  |           \n");
 365           g_print ("===========|============|============|============|============|===========\n");
 366         }
 367       if (i < MEM_PROFILE_TABLE_SIZE)
 368         g_print ("%10u | %10ld | %10ld | %10ld | %10ld |%+11ld\n",
 369                  i, t_malloc, t_free, t_realloc, t_refree,
 370                  (t_malloc - t_free + t_realloc - t_refree) * i);
 371       else if (i >= MEM_PROFILE_TABLE_SIZE)
 372         g_print ("   >%6u | %10ld | %10ld | %10ld | %10ld |        ***\n",
 373                  i, t_malloc, t_free, t_realloc, t_refree);
 374     }
 375   if (need_header)
 376     g_print (" --- none ---\n");
 377 }
 378
 379 void
 380 g_mem_profile (void)
 381 {
 382   guint local_data[(MEM_PROFILE_TABLE_SIZE + 1) * 8 * sizeof (profile_data[0])];
 383   gulong local_allocs;
 384   gulong local_zinit;
 385   gulong local_frees;
 386   gulong local_mc_allocs;
 387   gulong local_mc_frees;
 388
 389   g_mutex_lock (g_profile_mutex);
 390
 391   local_allocs = profile_allocs;
 392   local_zinit = profile_zinit;
 393   local_frees = profile_frees;
 394   local_mc_allocs = profile_mc_allocs;
 395   local_mc_frees = profile_mc_frees;
 396
 397   if (!profile_data)
 398     {
 399       g_mutex_unlock (g_profile_mutex);
 400       return;
 401     }
 402
 403   memcpy (local_data, profile_data,
 404           (MEM_PROFILE_TABLE_SIZE + 1) * 8 * sizeof (profile_data[0]));
 405
 406   g_mutex_unlock (g_profile_mutex);
 407
 408   g_print ("GLib Memory statistics (successful operations):\n");
 409   profile_print_locked (local_data, TRUE);
 410   g_print ("GLib Memory statistics (failing operations):\n");
 411   profile_print_locked (local_data, FALSE);
 412   g_print ("Total bytes: allocated=%lu, zero-initialized=%lu (%.2f%%), freed=%lu (%.2f%%), remaining=%lu\n",
 413            local_allocs,
 414            local_zinit,
 415            ((gdouble) local_zinit) / local_allocs * 100.0,
 416            local_frees,
 417            ((gdouble) local_frees) / local_allocs * 100.0,
 418            local_allocs - local_frees);
 419   g_print ("MemChunk bytes: allocated=%lu, freed=%lu (%.2f%%), remaining=%lu\n",
 420            local_mc_allocs,
 421            local_mc_frees,
 422            ((gdouble) local_mc_frees) / local_mc_allocs * 100.0,
 423            local_mc_allocs - local_mc_frees);
 424 }
 425
 426 static gpointer
 427 profiler_try_malloc (gsize n_bytes)
 428 {
 429   gulong *p;
 430
 431 #ifdef  G_ENABLE_DEBUG
 432   if (g_trap_malloc_size == n_bytes)
 433     G_BREAKPOINT ();
 434 #endif  /* G_ENABLE_DEBUG */
 435
 436   p = standard_malloc (sizeof (gulong) * 2 + n_bytes);
 437
 438   if (p)
 439     {
 440       p[0] = 0;         /* free count */
 441       p[1] = n_bytes;   /* length */
 442       profiler_log (PROFILER_ALLOC, n_bytes, TRUE);
 443       p += 2;
 444     }
 445   else
 446     profiler_log (PROFILER_ALLOC, n_bytes, FALSE);
 447
 448   return p;
 449 }
 450
 451 static gpointer
 452 profiler_malloc (gsize n_bytes)
 453 {
 454   gpointer mem = profiler_try_malloc (n_bytes);
 455
 456   if (!mem)
 457     g_mem_profile ();
 458
 459   return mem;
 460 }
 461
 462 static gpointer
 463 profiler_calloc (gsize n_blocks,
 464                  gsize n_block_bytes)
 465 {
 466   gsize l = n_blocks * n_block_bytes;
 467   gulong *p;
 468
 469 #ifdef  G_ENABLE_DEBUG
 470   if (g_trap_malloc_size == l)
 471     G_BREAKPOINT ();
 472 #endif  /* G_ENABLE_DEBUG */
 473
 474   p = standard_calloc (1, sizeof (gulong) * 2 + l);
 475
 476   if (p)
 477     {
 478       p[0] = 0;         /* free count */
 479       p[1] = l;         /* length */
 480       profiler_log (PROFILER_ALLOC | PROFILER_ZINIT, l, TRUE);
 481       p += 2;
 482     }
 483   else
 484     {
 485       profiler_log (PROFILER_ALLOC | PROFILER_ZINIT, l, FALSE);
 486       g_mem_profile ();
 487     }
 488
 489   return p;
 490 }
 491
 492 static void
 493 profiler_free (gpointer mem)
 494 {
 495   gulong *p = mem;
 496
 497   p -= 2;
 498   if (p[0])     /* free count */
 499     {
 500       g_warning ("free(%p): memory has been freed %lu times already", p + 2, p[0]);
 501       profiler_log (PROFILER_FREE,
 502                     p[1],       /* length */
 503                     FALSE);
 504     }
 505   else
 506     {
 507 #ifdef  G_ENABLE_DEBUG
 508       if (g_trap_free_size == p[1])
 509         G_BREAKPOINT ();
 510 #endif  /* G_ENABLE_DEBUG */
 511
 512       profiler_log (PROFILER_FREE,
 513                     p[1],       /* length */
 514                     TRUE);
 515       memset (p + 2, 0xaa, p[1]);
 516
 517       /* for all those that miss standard_free (p); in this place, yes,
 518        * we do leak all memory when profiling, and that is intentional
 519        * to catch double frees. patch submissions are futile.
 520        */
 521     }
 522   p[0] += 1;
 523 }
 524
 525 static gpointer
 526 profiler_try_realloc (gpointer mem,
 527                       gsize    n_bytes)
 528 {
 529   gulong *p = mem;
 530
 531   p -= 2;
 532
 533 #ifdef  G_ENABLE_DEBUG
 534   if (g_trap_realloc_size == n_bytes)
 535     G_BREAKPOINT ();
 536 #endif  /* G_ENABLE_DEBUG */
 537
 538   if (mem && p[0])      /* free count */
 539     {
 540       g_warning ("realloc(%p, %u): memory has been freed %lu times already", p + 2, n_bytes, p[0]);
 541       profiler_log (PROFILER_ALLOC | PROFILER_RELOC, n_bytes, FALSE);
 542
 543       return NULL;
 544     }
 545   else
 546     {
 547       p = standard_realloc (mem ? p : NULL, sizeof (gulong) * 2 + n_bytes);
 548
 549       if (p)
 550         {
 551           if (mem)
 552             profiler_log (PROFILER_FREE | PROFILER_RELOC, p[1], TRUE);
 553           p[0] = 0;
 554           p[1] = n_bytes;
 555           profiler_log (PROFILER_ALLOC | PROFILER_RELOC, p[1], TRUE);
 556           p += 2;
 557         }
 558       else
 559         profiler_log (PROFILER_ALLOC | PROFILER_RELOC, n_bytes, FALSE);
 560
 561       return p;
 562     }
 563 }
 564
 565 static gpointer
 566 profiler_realloc (gpointer mem,
 567                   gsize    n_bytes)
 568 {
 569   mem = profiler_try_realloc (mem, n_bytes);
 570
 571   if (!mem)
 572     g_mem_profile ();
 573
 574   return mem;
 575 }
 576
 577 static GMemVTable profiler_table = {
 578   profiler_malloc,
 579   profiler_realloc,
 580   profiler_free,
 581   profiler_calloc,
 582   profiler_try_malloc,
 583   profiler_try_realloc,
 584 };
 585 GMemVTable *glib_mem_profiler_table = &profiler_table;
 586
 587 #endif  /* !G_DISABLE_CHECKS */
 588
 589
 590 /* --- MemChunks --- */
 591 typedef struct _GFreeAtom      GFreeAtom;
 592 typedef struct _GMemArea       GMemArea;
 593
 594 struct _GFreeAtom
 595 {
 596   GFreeAtom *next;
 597 };
 598
 599 struct _GMemArea
 600 {
 601   GMemArea *next;            /* the next mem area */
 602   GMemArea *prev;            /* the previous mem area */
 603   gulong index;              /* the current index into the "mem" array */
 604   gulong free;               /* the number of free bytes in this mem area */
 605   gulong allocated;          /* the number of atoms allocated from this area */
 606   gulong mark;               /* is this mem area marked for deletion */
 607   gchar mem[MEM_AREA_SIZE];  /* the mem array from which atoms get allocated
 608                               * the actual size of this array is determined by
 609                               *  the mem chunk "area_size". ANSI says that it
 610                               *  must be declared to be the maximum size it
 611                               *  can possibly be (even though the actual size
 612                               *  may be less).
 613                               */
 614 };
 615
 616 struct _GMemChunk
 617 {
 618   const gchar *name;         /* name of this MemChunk...used for debugging output */
 619   gint type;                 /* the type of MemChunk: ALLOC_ONLY or ALLOC_AND_FREE */
 620   gint num_mem_areas;        /* the number of memory areas */
 621   gint num_marked_areas;     /* the number of areas marked for deletion */
 622   guint atom_size;           /* the size of an atom */
 623   gulong area_size;          /* the size of a memory area */
 624   GMemArea *mem_area;        /* the current memory area */
 625   GMemArea *mem_areas;       /* a list of all the mem areas owned by this chunk */
 626   GMemArea *free_mem_area;   /* the free area...which is about to be destroyed */
 627   GFreeAtom *free_atoms;     /* the free atoms list */
 628   GTree *mem_tree;           /* tree of mem areas sorted by memory address */
 629   GMemChunk *next;           /* pointer to the next chunk */
 630   GMemChunk *prev;           /* pointer to the previous chunk */
 631 };
 632
 633
 634 #ifndef DISABLE_MEM_POOLS
 635 static gulong g_mem_chunk_compute_size (gulong    size,
 636                                         gulong    min_size) G_GNUC_CONST;
 637 static gint   g_mem_chunk_area_compare (GMemArea *a,
 638                                         GMemArea *b);
 639 static gint   g_mem_chunk_area_search  (GMemArea *a,
 640                                         gchar    *addr);
 641
 642 /* here we can't use StaticMutexes, as they depend upon a working
 643  * g_malloc, the same holds true for StaticPrivate
 644  */
 645 static GMutex        *mem_chunks_lock = NULL;
 646 static GMemChunk     *mem_chunks = NULL;
 647
 648 GMemChunk*
 649 g_mem_chunk_new (const gchar  *name,
 650                  gint          atom_size,
 651                  gulong        area_size,
 652                  gint          type)
 653 {
 654   GMemChunk *mem_chunk;
 655   gulong rarea_size;
 656
 657   g_return_val_if_fail (atom_size > 0, NULL);
 658   g_return_val_if_fail (area_size >= atom_size, NULL);
 659
 660   ENTER_MEM_CHUNK_ROUTINE ();
 661
 662   area_size = (area_size + atom_size - 1) / atom_size;
 663   area_size *= atom_size;
 664
 665   mem_chunk = g_new (GMemChunk, 1);
 666   mem_chunk->name = name;
 667   mem_chunk->type = type;
 668   mem_chunk->num_mem_areas = 0;
 669   mem_chunk->num_marked_areas = 0;
 670   mem_chunk->mem_area = NULL;
 671   mem_chunk->free_mem_area = NULL;
 672   mem_chunk->free_atoms = NULL;
 673   mem_chunk->mem_tree = NULL;
 674   mem_chunk->mem_areas = NULL;
 675   mem_chunk->atom_size = atom_size;
 676
 677   if (mem_chunk->type == G_ALLOC_AND_FREE)
 678     mem_chunk->mem_tree = g_tree_new ((GCompareFunc) g_mem_chunk_area_compare);
 679
 680   if (mem_chunk->atom_size % G_MEM_ALIGN)
 681     mem_chunk->atom_size += G_MEM_ALIGN - (mem_chunk->atom_size % G_MEM_ALIGN);
 682
 683   rarea_size = area_size + sizeof (GMemArea) - MEM_AREA_SIZE;
 684   rarea_size = g_mem_chunk_compute_size (rarea_size, atom_size + sizeof (GMemArea) - MEM_AREA_SIZE);
 685   mem_chunk->area_size = rarea_size - (sizeof (GMemArea) - MEM_AREA_SIZE);
 686
 687   g_mutex_lock (mem_chunks_lock);
 688   mem_chunk->next = mem_chunks;
 689   mem_chunk->prev = NULL;
 690   if (mem_chunks)
 691     mem_chunks->prev = mem_chunk;
 692   mem_chunks = mem_chunk;
 693   g_mutex_unlock (mem_chunks_lock);
 694
 695   LEAVE_MEM_CHUNK_ROUTINE ();
 696
 697   return mem_chunk;
 698 }
 699
 700 void
 701 g_mem_chunk_destroy (GMemChunk *mem_chunk)
 702 {
 703   GMemArea *mem_areas;
 704   GMemArea *temp_area;
 705
 706   g_return_if_fail (mem_chunk != NULL);
 707
 708   ENTER_MEM_CHUNK_ROUTINE ();
 709
 710   mem_areas = mem_chunk->mem_areas;
 711   while (mem_areas)
 712     {
 713       temp_area = mem_areas;
 714       mem_areas = mem_areas->next;
 715       g_free (temp_area);
 716     }
 717
 718   if (mem_chunk->next)
 719     mem_chunk->next->prev = mem_chunk->prev;
 720   if (mem_chunk->prev)
 721     mem_chunk->prev->next = mem_chunk->next;
 722
 723   g_mutex_lock (mem_chunks_lock);
 724   if (mem_chunk == mem_chunks)
 725     mem_chunks = mem_chunks->next;
 726   g_mutex_unlock (mem_chunks_lock);
 727
 728   if (mem_chunk->type == G_ALLOC_AND_FREE)
 729     g_tree_destroy (mem_chunk->mem_tree);
 730
 731   g_free (mem_chunk);
 732
 733   LEAVE_MEM_CHUNK_ROUTINE ();
 734 }
 735
 736 gpointer
 737 g_mem_chunk_alloc (GMemChunk *mem_chunk)
 738 {
 739   GMemArea *temp_area;
 740   gpointer mem;
 741
 742   ENTER_MEM_CHUNK_ROUTINE ();
 743
 744   g_return_val_if_fail (mem_chunk != NULL, NULL);
 745
 746   while (mem_chunk->free_atoms)
 747     {
 748       /* Get the first piece of memory on the "free_atoms" list.
 749        * We can go ahead and destroy the list node we used to keep
 750        *  track of it with and to update the "free_atoms" list to
 751        *  point to its next element.
 752        */
 753       mem = mem_chunk->free_atoms;
 754       mem_chunk->free_atoms = mem_chunk->free_atoms->next;
 755
 756       /* Determine which area this piece of memory is allocated from */
 757       temp_area = g_tree_search (mem_chunk->mem_tree,
 758                                  (GCompareFunc) g_mem_chunk_area_search,
 759                                  mem);
 760
 761       /* If the area has been marked, then it is being destroyed.
 762        *  (ie marked to be destroyed).
 763        * We check to see if all of the segments on the free list that
 764        *  reference this area have been removed. This occurs when
 765        *  the ammount of free memory is less than the allocatable size.
 766        * If the chunk should be freed, then we place it in the "free_mem_area".
 767        * This is so we make sure not to free the mem area here and then
 768        *  allocate it again a few lines down.
 769        * If we don't allocate a chunk a few lines down then the "free_mem_area"
 770        *  will be freed.
 771        * If there is already a "free_mem_area" then we'll just free this mem area.
 772        */
 773       if (temp_area->mark)
 774         {
 775           /* Update the "free" memory available in that area */
 776           temp_area->free += mem_chunk->atom_size;
 777
 778           if (temp_area->free == mem_chunk->area_size)
 779             {
 780               if (temp_area == mem_chunk->mem_area)
 781                 mem_chunk->mem_area = NULL;
 782
 783               if (mem_chunk->free_mem_area)
 784                 {
 785                   mem_chunk->num_mem_areas -= 1;
 786
 787                   if (temp_area->next)
 788                     temp_area->next->prev = temp_area->prev;
 789                   if (temp_area->prev)
 790                     temp_area->prev->next = temp_area->next;
 791                   if (temp_area == mem_chunk->mem_areas)
 792                     mem_chunk->mem_areas = mem_chunk->mem_areas->next;
 793
 794                   if (mem_chunk->type == G_ALLOC_AND_FREE)
 795                     g_tree_remove (mem_chunk->mem_tree, temp_area);
 796                   g_free (temp_area);
 797                 }
 798               else
 799                 mem_chunk->free_mem_area = temp_area;
 800
 801               mem_chunk->num_marked_areas -= 1;
 802             }
 803         }
 804       else
 805         {
 806           /* Update the number of allocated atoms count.
 807            */
 808           temp_area->allocated += 1;
 809
 810           /* The area wasn't marked...return the memory
 811            */
 812           goto outa_here;
 813         }
 814     }
 815
 816   /* If there isn't a current mem area or the current mem area is out of space
 817    *  then allocate a new mem area. We'll first check and see if we can use
 818    *  the "free_mem_area". Otherwise we'll just malloc the mem area.
 819    */
 820   if ((!mem_chunk->mem_area) ||
 821       ((mem_chunk->mem_area->index + mem_chunk->atom_size) > mem_chunk->area_size))
 822     {
 823       if (mem_chunk->free_mem_area)
 824         {
 825           mem_chunk->mem_area = mem_chunk->free_mem_area;
 826           mem_chunk->free_mem_area = NULL;
 827         }
 828       else
 829         {
 830 #ifdef ENABLE_GC_FRIENDLY
 831           mem_chunk->mem_area = (GMemArea*) g_malloc0 (sizeof (GMemArea) -
 832                                                        MEM_AREA_SIZE +
 833                                                        mem_chunk->area_size);
 834 #else /* !ENABLE_GC_FRIENDLY */
 835           mem_chunk->mem_area = (GMemArea*) g_malloc (sizeof (GMemArea) -
 836                                                       MEM_AREA_SIZE +
 837                                                       mem_chunk->area_size);
 838 #endif /* ENABLE_GC_FRIENDLY */
 839
 840           mem_chunk->num_mem_areas += 1;
 841           mem_chunk->mem_area->next = mem_chunk->mem_areas;
 842           mem_chunk->mem_area->prev = NULL;
 843
 844           if (mem_chunk->mem_areas)
 845             mem_chunk->mem_areas->prev = mem_chunk->mem_area;
 846           mem_chunk->mem_areas = mem_chunk->mem_area;
 847
 848           if (mem_chunk->type == G_ALLOC_AND_FREE)
 849             g_tree_insert (mem_chunk->mem_tree, mem_chunk->mem_area, mem_chunk->mem_area);
 850         }
 851
 852       mem_chunk->mem_area->index = 0;
 853       mem_chunk->mem_area->free = mem_chunk->area_size;
 854       mem_chunk->mem_area->allocated = 0;
 855       mem_chunk->mem_area->mark = 0;
 856     }
 857
 858   /* Get the memory and modify the state variables appropriately.
 859    */
 860   mem = (gpointer) &mem_chunk->mem_area->mem[mem_chunk->mem_area->index];
 861   mem_chunk->mem_area->index += mem_chunk->atom_size;
 862   mem_chunk->mem_area->free -= mem_chunk->atom_size;
 863   mem_chunk->mem_area->allocated += 1;
 864
 865 outa_here:
 866
 867   LEAVE_MEM_CHUNK_ROUTINE ();
 868
 869   return mem;
 870 }
 871
 872 gpointer
 873 g_mem_chunk_alloc0 (GMemChunk *mem_chunk)
 874 {
 875   gpointer mem;
 876
 877   mem = g_mem_chunk_alloc (mem_chunk);
 878   if (mem)
 879     {
 880       memset (mem, 0, mem_chunk->atom_size);
 881     }
 882
 883   return mem;
 884 }
 885
 886 void
 887 g_mem_chunk_free (GMemChunk *mem_chunk,
 888                   gpointer   mem)
 889 {
 890   GMemArea *temp_area;
 891   GFreeAtom *free_atom;
 892
 893   g_return_if_fail (mem_chunk != NULL);
 894   g_return_if_fail (mem != NULL);
 895
 896   ENTER_MEM_CHUNK_ROUTINE ();
 897
 898 #ifdef ENABLE_GC_FRIENDLY
 899   memset (mem, 0, mem_chunk->atom_size);
 900 #endif /* ENABLE_GC_FRIENDLY */
 901
 902   /* Don't do anything if this is an ALLOC_ONLY chunk
 903    */
 904   if (mem_chunk->type == G_ALLOC_AND_FREE)
 905     {
 906       /* Place the memory on the "free_atoms" list
 907        */
 908       free_atom = (GFreeAtom*) mem;
 909       free_atom->next = mem_chunk->free_atoms;
 910       mem_chunk->free_atoms = free_atom;
 911
 912       temp_area = g_tree_search (mem_chunk->mem_tree,
 913                                  (GCompareFunc) g_mem_chunk_area_search,
 914                                  mem);
 915
 916       temp_area->allocated -= 1;
 917
 918       if (temp_area->allocated == 0)
 919         {
 920           temp_area->mark = 1;
 921           mem_chunk->num_marked_areas += 1;
 922         }
 923     }
 924
 925   LEAVE_MEM_CHUNK_ROUTINE ();
 926 }
 927
 928 /* This doesn't free the free_area if there is one */
 929 void
 930 g_mem_chunk_clean (GMemChunk *mem_chunk)
 931 {
 932   GMemArea *mem_area;
 933   GFreeAtom *prev_free_atom;
 934   GFreeAtom *temp_free_atom;
 935   gpointer mem;
 936
 937   g_return_if_fail (mem_chunk != NULL);
 938
 939   ENTER_MEM_CHUNK_ROUTINE ();
 940
 941   if (mem_chunk->type == G_ALLOC_AND_FREE)
 942     {
 943       prev_free_atom = NULL;
 944       temp_free_atom = mem_chunk->free_atoms;
 945
 946       while (temp_free_atom)
 947         {
 948           mem = (gpointer) temp_free_atom;
 949
 950           mem_area = g_tree_search (mem_chunk->mem_tree,
 951                                     (GCompareFunc) g_mem_chunk_area_search,
 952                                     mem);
 953
 954           /* If this mem area is marked for destruction then delete the
 955            *  area and list node and decrement the free mem.
 956            */
 957           if (mem_area->mark)
 958             {
 959               if (prev_free_atom)
 960                 prev_free_atom->next = temp_free_atom->next;
 961               else
 962                 mem_chunk->free_atoms = temp_free_atom->next;
 963               temp_free_atom = temp_free_atom->next;
 964
 965               mem_area->free += mem_chunk->atom_size;
 966               if (mem_area->free == mem_chunk->area_size)
 967                 {
 968                   mem_chunk->num_mem_areas -= 1;
 969                   mem_chunk->num_marked_areas -= 1;
 970
 971                   if (mem_area->next)
 972                     mem_area->next->prev = mem_area->prev;
 973                   if (mem_area->prev)
 974                     mem_area->prev->next = mem_area->next;
 975                   if (mem_area == mem_chunk->mem_areas)
 976                     mem_chunk->mem_areas = mem_chunk->mem_areas->next;
 977                   if (mem_area == mem_chunk->mem_area)
 978                     mem_chunk->mem_area = NULL;
 979
 980                   if (mem_chunk->type == G_ALLOC_AND_FREE)
 981                     g_tree_remove (mem_chunk->mem_tree, mem_area);
 982                   g_free (mem_area);
 983                 }
 984             }
 985           else
 986             {
 987               prev_free_atom = temp_free_atom;
 988               temp_free_atom = temp_free_atom->next;
 989             }
 990         }
 991     }
 992   LEAVE_MEM_CHUNK_ROUTINE ();
 993 }
 994
 995 void
 996 g_mem_chunk_reset (GMemChunk *mem_chunk)
 997 {
 998   GMemArea *mem_areas;
 999   GMemArea *temp_area;
1000
1001   g_return_if_fail (mem_chunk != NULL);
1002
1003   ENTER_MEM_CHUNK_ROUTINE ();
1004
1005   mem_areas = mem_chunk->mem_areas;
1006   mem_chunk->num_mem_areas = 0;
1007   mem_chunk->mem_areas = NULL;
1008   mem_chunk->mem_area = NULL;
1009
1010   while (mem_areas)
1011     {
1012       temp_area = mem_areas;
1013       mem_areas = mem_areas->next;
1014       g_free (temp_area);
1015     }
1016
1017   mem_chunk->free_atoms = NULL;
1018
1019   if (mem_chunk->mem_tree)
1020     g_tree_destroy (mem_chunk->mem_tree);
1021   mem_chunk->mem_tree = g_tree_new ((GCompareFunc) g_mem_chunk_area_compare);
1022
1023   LEAVE_MEM_CHUNK_ROUTINE ();
1024 }
1025
1026 void
1027 g_mem_chunk_print (GMemChunk *mem_chunk)
1028 {
1029   GMemArea *mem_areas;
1030   gulong mem;
1031
1032   g_return_if_fail (mem_chunk != NULL);
1033
1034   mem_areas = mem_chunk->mem_areas;
1035   mem = 0;
1036
1037   while (mem_areas)
1038     {
1039       mem += mem_chunk->area_size - mem_areas->free;
1040       mem_areas = mem_areas->next;
1041     }
1042
1043   g_log (g_log_domain_glib, G_LOG_LEVEL_INFO,
1044          "%s: %ld bytes using %d mem areas",
1045          mem_chunk->name, mem, mem_chunk->num_mem_areas);
1046 }
1047
1048 void
1049 g_mem_chunk_info (void)
1050 {
1051   GMemChunk *mem_chunk;
1052   gint count;
1053
1054   count = 0;
1055   g_mutex_lock (mem_chunks_lock);
1056   mem_chunk = mem_chunks;
1057   while (mem_chunk)
1058     {
1059       count += 1;
1060       mem_chunk = mem_chunk->next;
1061     }
1062   g_mutex_unlock (mem_chunks_lock);
1063
1064   g_log (g_log_domain_glib, G_LOG_LEVEL_INFO, "%d mem chunks", count);
1065
1066   g_mutex_lock (mem_chunks_lock);
1067   mem_chunk = mem_chunks;
1068   g_mutex_unlock (mem_chunks_lock);
1069
1070   while (mem_chunk)
1071     {
1072       g_mem_chunk_print ((GMemChunk*) mem_chunk);
1073       mem_chunk = mem_chunk->next;
1074     }
1075 }
1076
1077 void
1078 g_blow_chunks (void)
1079 {
1080   GMemChunk *mem_chunk;
1081
1082   g_mutex_lock (mem_chunks_lock);
1083   mem_chunk = mem_chunks;
1084   g_mutex_unlock (mem_chunks_lock);
1085   while (mem_chunk)
1086     {
1087       g_mem_chunk_clean ((GMemChunk*) mem_chunk);
1088       mem_chunk = mem_chunk->next;
1089     }
1090 }
1091
1092 static gulong
1093 g_mem_chunk_compute_size (gulong size,
1094                           gulong min_size)
1095 {
1096   gulong power_of_2;
1097   gulong lower, upper;
1098
1099   power_of_2 = 16;
1100   while (power_of_2 < size)
1101     power_of_2 <<= 1;
1102
1103   lower = power_of_2 >> 1;
1104   upper = power_of_2;
1105
1106   if (size - lower < upper - size && lower >= min_size)
1107     return lower;
1108   else
1109     return upper;
1110 }
1111
1112 static gint
1113 g_mem_chunk_area_compare (GMemArea *a,
1114                           GMemArea *b)
1115 {
1116   if (a->mem > b->mem)
1117     return 1;
1118   else if (a->mem < b->mem)
1119     return -1;
1120   return 0;
1121 }
1122
1123 static gint
1124 g_mem_chunk_area_search (GMemArea *a,
1125                          gchar    *addr)
1126 {
1127   if (a->mem <= addr)
1128     {
1129       if (addr < &a->mem[a->index])
1130         return 0;
1131       return 1;
1132     }
1133   return -1;
1134 }
1135
1136 #else /* DISABLE_MEM_POOLS */
1137
1138 typedef struct {
1139   guint alloc_size;           /* the size of an atom */
1140 }  GMinimalMemChunk;
1141
1142 GMemChunk*
1143 g_mem_chunk_new (const gchar  *name,
1144                  gint          atom_size,
1145                  gulong        area_size,
1146                  gint          type)
1147 {
1148   GMinimalMemChunk *mem_chunk;
1149
1150   g_return_val_if_fail (atom_size > 0, NULL);
1151
1152   mem_chunk = g_new (GMinimalMemChunk, 1);
1153   mem_chunk->alloc_size = atom_size;
1154
1155   return ((GMemChunk*) mem_chunk);
1156 }
1157
1158 void
1159 g_mem_chunk_destroy (GMemChunk *mem_chunk)
1160 {
1161   g_return_if_fail (mem_chunk != NULL);
1162
1163   g_free (mem_chunk);
1164 }
1165
1166 gpointer
1167 g_mem_chunk_alloc (GMemChunk *mem_chunk)
1168 {
1169   GMinimalMemChunk *minimal = (GMinimalMemChunk *)mem_chunk;
1170
1171   g_return_val_if_fail (mem_chunk != NULL, NULL);
1172
1173   return g_malloc (minimal->alloc_size);
1174 }
1175
1176 gpointer
1177 g_mem_chunk_alloc0 (GMemChunk *mem_chunk)
1178 {
1179   GMinimalMemChunk *minimal = (GMinimalMemChunk *)mem_chunk;
1180
1181   g_return_val_if_fail (mem_chunk != NULL, NULL);
1182
1183   return g_malloc0 (minimal->alloc_size);
1184 }
1185
1186 void
1187 g_mem_chunk_free (GMemChunk *mem_chunk,
1188                   gpointer   mem)
1189 {
1190   g_return_if_fail (mem_chunk != NULL);
1191
1192   g_free (mem);
1193 }
1194
1195 void    g_mem_chunk_clean       (GMemChunk *mem_chunk)  {}
1196 void    g_mem_chunk_reset       (GMemChunk *mem_chunk)  {}
1197 void    g_mem_chunk_print       (GMemChunk *mem_chunk)  {}
1198 void    g_mem_chunk_info        (void)                  {}
1199 void    g_blow_chunks           (void)                  {}
1200
1201 #endif /* DISABLE_MEM_POOLS */
1202
1203
1204 /* generic allocators
1205  */
1206 struct _GAllocator /* from gmem.c */
1207 {
1208   gchar         *name;
1209   guint16        n_preallocs;
1210   guint          is_unused : 1;
1211   guint          type : 4;
1212   GAllocator    *last;
1213   GMemChunk     *mem_chunk;
1214   gpointer       dummy; /* implementation specific */
1215 };
1216
1217 GAllocator*
1218 g_allocator_new (const gchar *name,
1219                  guint        n_preallocs)
1220 {
1221   GAllocator *allocator;
1222
1223   g_return_val_if_fail (name != NULL, NULL);
1224
1225   allocator = g_new0 (GAllocator, 1);
1226   allocator->name = g_strdup (name);
1227   allocator->n_preallocs = CLAMP (n_preallocs, 1, 65535);
1228   allocator->is_unused = TRUE;
1229   allocator->type = 0;
1230   allocator->last = NULL;
1231   allocator->mem_chunk = NULL;
1232   allocator->dummy = NULL;
1233
1234   return allocator;
1235 }
1236
1237 void
1238 g_allocator_free (GAllocator *allocator)
1239 {
1240   g_return_if_fail (allocator != NULL);
1241   g_return_if_fail (allocator->is_unused == TRUE);
1242
1243   g_free (allocator->name);
1244   if (allocator->mem_chunk)
1245     g_mem_chunk_destroy (allocator->mem_chunk);
1246
1247   g_free (allocator);
1248 }
1249
1250 void
1251 g_mem_init (void)
1252 {
1253 #ifndef DISABLE_MEM_POOLS
1254   mem_chunks_lock = g_mutex_new ();
1255 #endif
1256 #ifndef G_DISABLE_CHECKS
1257   mem_chunk_recursion = g_private_new (NULL);
1258   g_profile_mutex = g_mutex_new ();
1259 #endif
1260 }