glib/gslice.c

   1 /* GLIB sliced memory - fast concurrent memory chunk allocator
   2  * Copyright (C) 2005 Tim Janik
   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 /* MT safe */
  20
  21 #include "config.h"
  22
  23 #if     defined HAVE_POSIX_MEMALIGN && defined POSIX_MEMALIGN_WITH_COMPLIANT_ALLOCS
  24 #  define HAVE_COMPLIANT_POSIX_MEMALIGN 1
  25 #endif
  26
  27 #ifdef HAVE_COMPLIANT_POSIX_MEMALIGN
  28 #define _XOPEN_SOURCE 600       /* posix_memalign() */
  29 #endif
  30 #include <stdlib.h>             /* posix_memalign() */
  31 #include <string.h>
  32 #include <errno.h>
  33 #include "gmem.h"               /* gslice.h */
  34 #include "gthreadprivate.h"
  35 #include "glib.h"
  36 #include "galias.h"
  37 #ifdef HAVE_UNISTD_H
  38 #include <unistd.h>             /* sysconf() */
  39 #endif
  40 #ifdef G_OS_WIN32
  41 #include <windows.h>
  42 #include <process.h>
  43 #endif
  44
  45 #include <stdio.h>              /* fputs/fprintf */
  46
  47
  48 /* the GSlice allocator is split up into 4 layers, roughly modelled after the slab
  49  * allocator and magazine extensions as outlined in:
  50  * + [Bonwick94] Jeff Bonwick, The slab allocator: An object-caching kernel
  51  *   memory allocator. USENIX 1994, http://citeseer.ist.psu.edu/bonwick94slab.html
  52  * + [Bonwick01] Bonwick and Jonathan Adams, Magazines and vmem: Extending the
  53  *   slab allocator to many cpu's and arbitrary resources.
  54  *   USENIX 2001, http://citeseer.ist.psu.edu/bonwick01magazines.html
  55  * the layers are:
  56  * - the thread magazines. for each (aligned) chunk size, a magazine (a list)
  57  *   of recently freed and soon to be allocated chunks is maintained per thread.
  58  *   this way, most alloc/free requests can be quickly satisfied from per-thread
  59  *   free lists which only require one g_private_get() call to retrive the
  60  *   thread handle.
  61  * - the magazine cache. allocating and freeing chunks to/from threads only
  62  *   occours at magazine sizes from a global depot of magazines. the depot
  63  *   maintaines a 15 second working set of allocated magazines, so full
  64  *   magazines are not allocated and released too often.
  65  *   the chunk size dependent magazine sizes automatically adapt (within limits,
  66  *   see [3]) to lock contention to properly scale performance across a variety
  67  *   of SMP systems.
  68  * - the slab allocator. this allocator allocates slabs (blocks of memory) close
  69  *   to the system page size or multiples thereof which have to be page aligned.
  70  *   the blocks are divided into smaller chunks which are used to satisfy
  71  *   allocations from the upper layers. the space provided by the reminder of
  72  *   the chunk size division is used for cache colorization (random distribution
  73  *   of chunk addresses) to improve processor cache utilization. multiple slabs
  74  *   with the same chunk size are kept in a partially sorted ring to allow O(1)
  75  *   freeing and allocation of chunks (as long as the allocation of an entirely
  76  *   new slab can be avoided).
  77  * - the page allocator. on most modern systems, posix_memalign(3) or
  78  *   memalign(3) should be available, so this is used to allocate blocks with
  79  *   system page size based alignments and sizes or multiples thereof.
  80  *   if no memalign variant is provided, valloc() is used instead and
  81  *   block sizes are limited to the system page size (no multiples thereof).
  82  *   as a fallback, on system without even valloc(), a malloc(3)-based page
  83  *   allocator with alloc-only behaviour is used.
  84  *
  85  * NOTES:
  86  * [1] some systems memalign(3) implementations may rely on boundary tagging for
  87  *     the handed out memory chunks. to avoid excessive page-wise fragmentation,
  88  *     we reserve 2 * sizeof (void*) per block size for the systems memalign(3),
  89  *     specified in NATIVE_MALLOC_PADDING.
  90  * [2] using the slab allocator alone already provides for a fast and efficient
  91  *     allocator, it doesn't properly scale beyond single-threaded uses though.
  92  *     also, the slab allocator implements eager free(3)-ing, i.e. does not
  93  *     provide any form of caching or working set maintenance. so if used alone,
  94  *     it's vulnerable to trashing for sequences of balanced (alloc, free) pairs
  95  *     at certain thresholds.
  96  * [3] magazine sizes are bound by an implementation specific minimum size and
  97  *     a chunk size specific maximum to limit magazine storage sizes to roughly
  98  *     16KB.
  99  * [4] allocating ca. 8 chunks per block/page keeps a good balance between
 100  *     external and internal fragmentation (<= 12.5%). [Bonwick94]
 101  */
 102
 103 /* --- macros and constants --- */
 104 #define LARGEALIGNMENT          (256)
 105 #define P2ALIGNMENT             (2 * sizeof (gsize))                            /* fits 2 pointers (assumed to be 2 * GLIB_SIZEOF_SIZE_T below) */
 106 #define ALIGN(size, base)       ((base) * (gsize) (((size) + (base) - 1) / (base)))
 107 #define NATIVE_MALLOC_PADDING   P2ALIGNMENT                                     /* per-page padding left for native malloc(3) see [1] */
 108 #define SLAB_INFO_SIZE          P2ALIGN (sizeof (SlabInfo) + NATIVE_MALLOC_PADDING)
 109 #define MAX_MAGAZINE_SIZE       (256)                                           /* see [3] and allocator_get_magazine_threshold() for this */
 110 #define MIN_MAGAZINE_SIZE       (4)
 111 #define MAX_STAMP_COUNTER       (7)                                             /* distributes the load of gettimeofday() */
 112 #define MAX_SLAB_CHUNK_SIZE(al) (((al)->max_page_size - SLAB_INFO_SIZE) / 8)    /* we want at last 8 chunks per page, see [4] */
 113 #define MAX_SLAB_INDEX(al)      (SLAB_INDEX (al, MAX_SLAB_CHUNK_SIZE (al)) + 1)
 114 #define SLAB_INDEX(al, asize)   ((asize) / P2ALIGNMENT - 1)                     /* asize must be P2ALIGNMENT aligned */
 115 #define SLAB_CHUNK_SIZE(al, ix) (((ix) + 1) * P2ALIGNMENT)
 116 #define SLAB_BPAGE_SIZE(al,csz) (8 * (csz) + SLAB_INFO_SIZE)
 117
 118 /* optimized version of ALIGN (size, P2ALIGNMENT) */
 119 #if     GLIB_SIZEOF_SIZE_T * 2 == 8  /* P2ALIGNMENT */
 120 #define P2ALIGN(size)   (((size) + 0x7) & ~(gsize) 0x7)
 121 #elif   GLIB_SIZEOF_SIZE_T * 2 == 16 /* P2ALIGNMENT */
 122 #define P2ALIGN(size)   (((size) + 0xf) & ~(gsize) 0xf)
 123 #else
 124 #define P2ALIGN(size)   ALIGN (size, P2ALIGNMENT)
 125 #endif
 126
 127 /* special helpers to avoid gmessage.c dependency */
 128 static void mem_error (const char *format, ...) G_GNUC_PRINTF (1,2);
 129 #define mem_assert(cond)    do { if (G_LIKELY (cond)) ; else mem_error ("assertion failed: %s", #cond); } while (0)
 130
 131 /* --- structures --- */
 132 typedef struct _ChunkLink      ChunkLink;
 133 typedef struct _SlabInfo       SlabInfo;
 134 typedef struct _CachedMagazine CachedMagazine;
 135 struct _ChunkLink {
 136   ChunkLink *next;
 137   ChunkLink *data;
 138 };
 139 struct _SlabInfo {
 140   ChunkLink *chunks;
 141   guint n_allocated;
 142   SlabInfo *next, *prev;
 143 };
 144 typedef struct {
 145   ChunkLink *chunks;
 146   gsize      count;                     /* approximative chunks list length */
 147 } Magazine;
 148 typedef struct {
 149   Magazine   *magazine1;                /* array of MAX_SLAB_INDEX (allocator) */
 150   Magazine   *magazine2;                /* array of MAX_SLAB_INDEX (allocator) */
 151 } ThreadMemory;
 152 typedef struct {
 153   gboolean always_malloc;
 154   gboolean bypass_magazines;
 155   gboolean debug_blocks;
 156   gsize    working_set_msecs;
 157   guint    color_increment;
 158 } SliceConfig;
 159 typedef struct {
 160   /* const after initialization */
 161   gsize         min_page_size, max_page_size;
 162   SliceConfig   config;
 163   gsize         max_slab_chunk_size_for_magazine_cache;
 164   /* magazine cache */
 165   GMutex       *magazine_mutex;
 166   ChunkLink   **magazines;                /* array of MAX_SLAB_INDEX (allocator) */
 167   guint        *contention_counters;      /* array of MAX_SLAB_INDEX (allocator) */
 168   gint          mutex_counter;
 169   guint         stamp_counter;
 170   guint         last_stamp;
 171   /* slab allocator */
 172   GMutex       *slab_mutex;
 173   SlabInfo    **slab_stack;                /* array of MAX_SLAB_INDEX (allocator) */
 174   guint        color_accu;
 175 } Allocator;
 176
 177 /* --- g-slice prototypes --- */
 178 static gpointer     slab_allocator_alloc_chunk       (gsize      chunk_size);
 179 static void         slab_allocator_free_chunk        (gsize      chunk_size,
 180                                                       gpointer   mem);
 181 static void         private_thread_memory_cleanup    (gpointer   data);
 182 static gpointer     allocator_memalign               (gsize      alignment,
 183                                                       gsize      memsize);
 184 static void         allocator_memfree                (gsize      memsize,
 185                                                       gpointer   mem);
 186 static inline void  magazine_cache_update_stamp      (void);
 187 static inline gsize allocator_get_magazine_threshold (Allocator *allocator,
 188                                                       guint      ix);
 189
 190 /* --- g-slice memory checker --- */
 191 static void     smc_notify_alloc  (void   *pointer,
 192                                    size_t  size);
 193 static int      smc_notify_free   (void   *pointer,
 194                                    size_t  size);
 195
 196 /* --- variables --- */
 197 static GPrivate   *private_thread_memory = NULL;
 198 static gsize       sys_page_size = 0;
 199 static Allocator   allocator[1] = { { 0, }, };
 200 static SliceConfig slice_config = {
 201   FALSE,        /* always_malloc */
 202   FALSE,        /* bypass_magazines */
 203   FALSE,        /* debug_blocks */
 204   15 * 1000,    /* working_set_msecs */
 205   1,            /* color increment, alt: 0x7fffffff */
 206 };
 207 static GMutex     *smc_tree_mutex = NULL; /* mutex for G_SLICE=debug-blocks */
 208
 209 /* --- auxillary funcitons --- */
 210 void
 211 g_slice_set_config (GSliceConfig ckey,
 212                     gint64       value)
 213 {
 214   g_return_if_fail (sys_page_size == 0);
 215   switch (ckey)
 216     {
 217     case G_SLICE_CONFIG_ALWAYS_MALLOC:
 218       slice_config.always_malloc = value != 0;
 219       break;
 220     case G_SLICE_CONFIG_BYPASS_MAGAZINES:
 221       slice_config.bypass_magazines = value != 0;
 222       break;
 223     case G_SLICE_CONFIG_WORKING_SET_MSECS:
 224       slice_config.working_set_msecs = value;
 225       break;
 226     case G_SLICE_CONFIG_COLOR_INCREMENT:
 227       slice_config.color_increment = value;
 228     default: ;
 229     }
 230 }
 231
 232 gint64
 233 g_slice_get_config (GSliceConfig ckey)
 234 {
 235   switch (ckey)
 236     {
 237     case G_SLICE_CONFIG_ALWAYS_MALLOC:
 238       return slice_config.always_malloc;
 239     case G_SLICE_CONFIG_BYPASS_MAGAZINES:
 240       return slice_config.bypass_magazines;
 241     case G_SLICE_CONFIG_WORKING_SET_MSECS:
 242       return slice_config.working_set_msecs;
 243     case G_SLICE_CONFIG_CHUNK_SIZES:
 244       return MAX_SLAB_INDEX (allocator);
 245     case G_SLICE_CONFIG_COLOR_INCREMENT:
 246       return slice_config.color_increment;
 247     default:
 248       return 0;
 249     }
 250 }
 251
 252 gint64*
 253 g_slice_get_config_state (GSliceConfig ckey,
 254                           gint64       address,
 255                           guint       *n_values)
 256 {
 257   guint i = 0;
 258   g_return_val_if_fail (n_values != NULL, NULL);
 259   *n_values = 0;
 260   switch (ckey)
 261     {
 262       gint64 array[64];
 263     case G_SLICE_CONFIG_CONTENTION_COUNTER:
 264       array[i++] = SLAB_CHUNK_SIZE (allocator, address);
 265       array[i++] = allocator->contention_counters[address];
 266       array[i++] = allocator_get_magazine_threshold (allocator, address);
 267       *n_values = i;
 268       return g_memdup (array, sizeof (array[0]) * *n_values);
 269     default:
 270       return NULL;
 271     }
 272 }
 273
 274 static void
 275 slice_config_init (SliceConfig *config)
 276 {
 277   /* don't use g_malloc/g_message here */
 278   gchar buffer[1024];
 279   const gchar *val = _g_getenv_nomalloc ("G_SLICE", buffer);
 280   static const GDebugKey keys[] = {
 281     { "always-malloc", 1 << 0 },
 282     { "debug-blocks",  1 << 1 },
 283   };
 284   gint flags = !val ? 0 : g_parse_debug_string (val, keys, G_N_ELEMENTS (keys));
 285   *config = slice_config;
 286   if (flags & (1 << 0))         /* always-malloc */
 287     config->always_malloc = TRUE;
 288   if (flags & (1 << 1))         /* debug-blocks */
 289     config->debug_blocks = TRUE;
 290 }
 291
 292 static void
 293 g_slice_init_nomessage (void)
 294 {
 295   /* we may not use g_error() or friends here */
 296   mem_assert (sys_page_size == 0);
 297   mem_assert (MIN_MAGAZINE_SIZE >= 4);
 298
 299 #ifdef G_OS_WIN32
 300   {
 301     SYSTEM_INFO system_info;
 302     GetSystemInfo (&system_info);
 303     sys_page_size = system_info.dwPageSize;
 304   }
 305 #else
 306   sys_page_size = sysconf (_SC_PAGESIZE); /* = sysconf (_SC_PAGE_SIZE); = getpagesize(); */
 307 #endif
 308   mem_assert (sys_page_size >= 2 * LARGEALIGNMENT);
 309   mem_assert ((sys_page_size & (sys_page_size - 1)) == 0);
 310   slice_config_init (&allocator->config);
 311   allocator->min_page_size = sys_page_size;
 312 #if HAVE_COMPLIANT_POSIX_MEMALIGN || HAVE_MEMALIGN
 313   /* allow allocation of pages up to 8KB (with 8KB alignment).
 314    * this is useful because many medium to large sized structures
 315    * fit less than 8 times (see [4]) into 4KB pages.
 316    * we allow very small page sizes here, to reduce wastage in
 317    * threads if only small allocations are required (this does
 318    * bear the risk of incresing allocation times and fragmentation
 319    * though).
 320    */
 321   allocator->min_page_size = MAX (allocator->min_page_size, 4096);
 322   allocator->max_page_size = MAX (allocator->min_page_size, 8192);
 323   allocator->min_page_size = MIN (allocator->min_page_size, 128);
 324 #else
 325   /* we can only align to system page size */
 326   allocator->max_page_size = sys_page_size;
 327 #endif
 328   allocator->magazine_mutex = NULL;     /* _g_slice_thread_init_nomessage() */
 329   allocator->magazines = g_new0 (ChunkLink*, MAX_SLAB_INDEX (allocator));
 330   allocator->contention_counters = g_new0 (guint, MAX_SLAB_INDEX (allocator));
 331   allocator->mutex_counter = 0;
 332   allocator->stamp_counter = MAX_STAMP_COUNTER; /* force initial update */
 333   allocator->last_stamp = 0;
 334   allocator->slab_mutex = NULL;         /* _g_slice_thread_init_nomessage() */
 335   allocator->slab_stack = g_new0 (SlabInfo*, MAX_SLAB_INDEX (allocator));
 336   allocator->color_accu = 0;
 337   magazine_cache_update_stamp();
 338   /* values cached for performance reasons */
 339   allocator->max_slab_chunk_size_for_magazine_cache = MAX_SLAB_CHUNK_SIZE (allocator);
 340   if (allocator->config.always_malloc || allocator->config.bypass_magazines)
 341     allocator->max_slab_chunk_size_for_magazine_cache = 0;      /* non-optimized cases */
 342   /* at this point, g_mem_gc_friendly() should be initialized, this
 343    * should have been accomplished by the above g_malloc/g_new calls
 344    */
 345 }
 346
 347 static inline guint
 348 allocator_categorize (gsize aligned_chunk_size)
 349 {
 350   /* speed up the likely path */
 351   if (G_LIKELY (aligned_chunk_size && aligned_chunk_size <= allocator->max_slab_chunk_size_for_magazine_cache))
 352     return 1;           /* use magazine cache */
 353
 354   /* the above will fail (max_slab_chunk_size_for_magazine_cache == 0) if the
 355    * allocator is still uninitialized, or if we are not configured to use the
 356    * magazine cache.
 357    */
 358   if (!sys_page_size)
 359     g_slice_init_nomessage ();
 360   if (!allocator->config.always_malloc &&
 361       aligned_chunk_size &&
 362       aligned_chunk_size <= MAX_SLAB_CHUNK_SIZE (allocator))
 363     {
 364       if (allocator->config.bypass_magazines)
 365         return 2;       /* use slab allocator, see [2] */
 366       return 1;         /* use magazine cache */
 367     }
 368   return 0;             /* use malloc() */
 369 }
 370
 371 void
 372 _g_slice_thread_init_nomessage (void)
 373 {
 374   /* we may not use g_error() or friends here */
 375   if (sys_page_size)
 376     {
 377       /* mem_error ("g_thread_init() must be called before GSlice is used, memory corrupted..."); */
 378       fputs ("\n***MEMORY-WARNING***: ", stderr);
 379       const char *pname = g_get_prgname();
 380       fprintf (stderr, "%s[%u]: GSlice: ", pname ? pname : "", getpid());
 381       fputs ("g_thread_init() must be called before all other GLib functions; "
 382              "memory corruption due to late invocation of g_thread_init() has been detected; "
 383              "this program is likely to crash, leak or unexpectedly abort soon...\n", stderr);
 384     }
 385   if (!sys_page_size)
 386     g_slice_init_nomessage();
 387   private_thread_memory = g_private_new (private_thread_memory_cleanup);
 388   allocator->magazine_mutex = g_mutex_new();
 389   allocator->slab_mutex = g_mutex_new();
 390   if (allocator->config.debug_blocks)
 391     smc_tree_mutex = g_mutex_new();
 392 }
 393
 394 static inline void
 395 g_mutex_lock_a (GMutex *mutex,
 396                 guint  *contention_counter)
 397 {
 398   gboolean contention = FALSE;
 399   if (!g_mutex_trylock (mutex))
 400     {
 401       g_mutex_lock (mutex);
 402       contention = TRUE;
 403     }
 404   if (contention)
 405     {
 406       allocator->mutex_counter++;
 407       if (allocator->mutex_counter >= 1)        /* quickly adapt to contention */
 408         {
 409           allocator->mutex_counter = 0;
 410           *contention_counter = MIN (*contention_counter + 1, MAX_MAGAZINE_SIZE);
 411         }
 412     }
 413   else /* !contention */
 414     {
 415       allocator->mutex_counter--;
 416       if (allocator->mutex_counter < -11)       /* moderately recover magazine sizes */
 417         {
 418           allocator->mutex_counter = 0;
 419           *contention_counter = MAX (*contention_counter, 1) - 1;
 420         }
 421     }
 422 }
 423
 424 static inline ThreadMemory*
 425 thread_memory_from_self (void)
 426 {
 427   ThreadMemory *tmem = g_private_get (private_thread_memory);
 428   if (G_UNLIKELY (!tmem))
 429     {
 430       const guint n_magazines = MAX_SLAB_INDEX (allocator);
 431       tmem = g_malloc0 (sizeof (ThreadMemory) + sizeof (Magazine) * 2 * n_magazines);
 432       tmem->magazine1 = (Magazine*) (tmem + 1);
 433       tmem->magazine2 = &tmem->magazine1[n_magazines];
 434       g_private_set (private_thread_memory, tmem);
 435     }
 436   return tmem;
 437 }
 438
 439 static inline ChunkLink*
 440 magazine_chain_pop_head (ChunkLink **magazine_chunks)
 441 {
 442   /* magazine chains are linked via ChunkLink->next.
 443    * each ChunkLink->data of the toplevel chain may point to a subchain,
 444    * linked via ChunkLink->next. ChunkLink->data of the subchains just
 445    * contains uninitialized junk.
 446    */
 447   ChunkLink *chunk = (*magazine_chunks)->data;
 448   if (G_UNLIKELY (chunk))
 449     {
 450       /* allocating from freed list */
 451       (*magazine_chunks)->data = chunk->next;
 452     }
 453   else
 454     {
 455       chunk = *magazine_chunks;
 456       *magazine_chunks = chunk->next;
 457     }
 458   return chunk;
 459 }
 460
 461 #if 0 /* useful for debugging */
 462 static guint
 463 magazine_count (ChunkLink *head)
 464 {
 465   guint count = 0;
 466   if (!head)
 467     return 0;
 468   while (head)
 469     {
 470       ChunkLink *child = head->data;
 471       count += 1;
 472       for (child = head->data; child; child = child->next)
 473         count += 1;
 474       head = head->next;
 475     }
 476   return count;
 477 }
 478 #endif
 479
 480 static inline gsize
 481 allocator_get_magazine_threshold (Allocator *allocator,
 482                                   guint      ix)
 483 {
 484   /* the magazine size calculated here has a lower bound of MIN_MAGAZINE_SIZE,
 485    * which is required by the implementation. also, for moderately sized chunks
 486    * (say >= 64 bytes), magazine sizes shouldn't be much smaller then the number
 487    * of chunks available per page/2 to avoid excessive traffic in the magazine
 488    * cache for small to medium sized structures.
 489    * the upper bound of the magazine size is effectively provided by
 490    * MAX_MAGAZINE_SIZE. for larger chunks, this number is scaled down so that
 491    * the content of a single magazine doesn't exceed ca. 16KB.
 492    */
 493   gsize chunk_size = SLAB_CHUNK_SIZE (allocator, ix);
 494   guint threshold = MAX (MIN_MAGAZINE_SIZE, allocator->max_page_size / MAX (5 * chunk_size, 5 * 32));
 495   guint contention_counter = allocator->contention_counters[ix];
 496   if (G_UNLIKELY (contention_counter))  /* single CPU bias */
 497     {
 498       /* adapt contention counter thresholds to chunk sizes */
 499       contention_counter = contention_counter * 64 / chunk_size;
 500       threshold = MAX (threshold, contention_counter);
 501     }
 502   return threshold;
 503 }
 504
 505 /* --- magazine cache --- */
 506 static inline void
 507 magazine_cache_update_stamp (void)
 508 {
 509   if (allocator->stamp_counter >= MAX_STAMP_COUNTER)
 510     {
 511       GTimeVal tv;
 512       g_get_current_time (&tv);
 513       allocator->last_stamp = tv.tv_sec * 1000 + tv.tv_usec / 1000; /* milli seconds */
 514       allocator->stamp_counter = 0;
 515     }
 516   else
 517     allocator->stamp_counter++;
 518 }
 519
 520 static inline ChunkLink*
 521 magazine_chain_prepare_fields (ChunkLink *magazine_chunks)
 522 {
 523   ChunkLink *chunk1;
 524   ChunkLink *chunk2;
 525   ChunkLink *chunk3;
 526   ChunkLink *chunk4;
 527   /* checked upon initialization: mem_assert (MIN_MAGAZINE_SIZE >= 4); */
 528   /* ensure a magazine with at least 4 unused data pointers */
 529   chunk1 = magazine_chain_pop_head (&magazine_chunks);
 530   chunk2 = magazine_chain_pop_head (&magazine_chunks);
 531   chunk3 = magazine_chain_pop_head (&magazine_chunks);
 532   chunk4 = magazine_chain_pop_head (&magazine_chunks);
 533   chunk4->next = magazine_chunks;
 534   chunk3->next = chunk4;
 535   chunk2->next = chunk3;
 536   chunk1->next = chunk2;
 537   return chunk1;
 538 }
 539
 540 /* access the first 3 fields of a specially prepared magazine chain */
 541 #define magazine_chain_prev(mc)         ((mc)->data)
 542 #define magazine_chain_stamp(mc)        ((mc)->next->data)
 543 #define magazine_chain_uint_stamp(mc)   GPOINTER_TO_UINT ((mc)->next->data)
 544 #define magazine_chain_next(mc)         ((mc)->next->next->data)
 545 #define magazine_chain_count(mc)        ((mc)->next->next->next->data)
 546
 547 static void
 548 magazine_cache_trim (Allocator *allocator,
 549                      guint      ix,
 550                      guint      stamp)
 551 {
 552   /* g_mutex_lock (allocator->mutex); done by caller */
 553   /* trim magazine cache from tail */
 554   ChunkLink *current = magazine_chain_prev (allocator->magazines[ix]);
 555   ChunkLink *trash = NULL;
 556   while (ABS (stamp - magazine_chain_uint_stamp (current)) >= allocator->config.working_set_msecs)
 557     {
 558       /* unlink */
 559       ChunkLink *prev = magazine_chain_prev (current);
 560       ChunkLink *next = magazine_chain_next (current);
 561       magazine_chain_next (prev) = next;
 562       magazine_chain_prev (next) = prev;
 563       /* clear special fields, put on trash stack */
 564       magazine_chain_next (current) = NULL;
 565       magazine_chain_count (current) = NULL;
 566       magazine_chain_stamp (current) = NULL;
 567       magazine_chain_prev (current) = trash;
 568       trash = current;
 569       /* fixup list head if required */
 570       if (current == allocator->magazines[ix])
 571         {
 572           allocator->magazines[ix] = NULL;
 573           break;
 574         }
 575       current = prev;
 576     }
 577   g_mutex_unlock (allocator->magazine_mutex);
 578   /* free trash */
 579   if (trash)
 580     {
 581       const gsize chunk_size = SLAB_CHUNK_SIZE (allocator, ix);
 582       g_mutex_lock (allocator->slab_mutex);
 583       while (trash)
 584         {
 585           current = trash;
 586           trash = magazine_chain_prev (current);
 587           magazine_chain_prev (current) = NULL; /* clear special field */
 588           while (current)
 589             {
 590               ChunkLink *chunk = magazine_chain_pop_head (&current);
 591               slab_allocator_free_chunk (chunk_size, chunk);
 592             }
 593         }
 594       g_mutex_unlock (allocator->slab_mutex);
 595     }
 596 }
 597
 598 static void
 599 magazine_cache_push_magazine (guint      ix,
 600                               ChunkLink *magazine_chunks,
 601                               gsize      count) /* must be >= MIN_MAGAZINE_SIZE */
 602 {
 603   ChunkLink *current = magazine_chain_prepare_fields (magazine_chunks);
 604   ChunkLink *next, *prev;
 605   g_mutex_lock (allocator->magazine_mutex);
 606   /* add magazine at head */
 607   next = allocator->magazines[ix];
 608   if (next)
 609     prev = magazine_chain_prev (next);
 610   else
 611     next = prev = current;
 612   magazine_chain_next (prev) = current;
 613   magazine_chain_prev (next) = current;
 614   magazine_chain_prev (current) = prev;
 615   magazine_chain_next (current) = next;
 616   magazine_chain_count (current) = (gpointer) count;
 617   /* stamp magazine */
 618   magazine_cache_update_stamp();
 619   magazine_chain_stamp (current) = GUINT_TO_POINTER (allocator->last_stamp);
 620   allocator->magazines[ix] = current;
 621   /* free old magazines beyond a certain threshold */
 622   magazine_cache_trim (allocator, ix, allocator->last_stamp);
 623   /* g_mutex_unlock (allocator->mutex); was done by magazine_cache_trim() */
 624 }
 625
 626 static ChunkLink*
 627 magazine_cache_pop_magazine (guint  ix,
 628                              gsize *countp)
 629 {
 630   g_mutex_lock_a (allocator->magazine_mutex, &allocator->contention_counters[ix]);
 631   if (!allocator->magazines[ix])
 632     {
 633       guint magazine_threshold = allocator_get_magazine_threshold (allocator, ix);
 634       gsize i, chunk_size = SLAB_CHUNK_SIZE (allocator, ix);
 635       ChunkLink *chunk, *head;
 636       g_mutex_unlock (allocator->magazine_mutex);
 637       g_mutex_lock (allocator->slab_mutex);
 638       head = slab_allocator_alloc_chunk (chunk_size);
 639       head->data = NULL;
 640       chunk = head;
 641       for (i = 1; i < magazine_threshold; i++)
 642         {
 643           chunk->next = slab_allocator_alloc_chunk (chunk_size);
 644           chunk = chunk->next;
 645           chunk->data = NULL;
 646         }
 647       chunk->next = NULL;
 648       g_mutex_unlock (allocator->slab_mutex);
 649       *countp = i;
 650       return head;
 651     }
 652   else
 653     {
 654       ChunkLink *current = allocator->magazines[ix];
 655       ChunkLink *prev = magazine_chain_prev (current);
 656       ChunkLink *next = magazine_chain_next (current);
 657       /* unlink */
 658       magazine_chain_next (prev) = next;
 659       magazine_chain_prev (next) = prev;
 660       allocator->magazines[ix] = next == current ? NULL : next;
 661       g_mutex_unlock (allocator->magazine_mutex);
 662       /* clear special fields and hand out */
 663       *countp = (gsize) magazine_chain_count (current);
 664       magazine_chain_prev (current) = NULL;
 665       magazine_chain_next (current) = NULL;
 666       magazine_chain_count (current) = NULL;
 667       magazine_chain_stamp (current) = NULL;
 668       return current;
 669     }
 670 }
 671
 672 /* --- thread magazines --- */
 673 static void
 674 private_thread_memory_cleanup (gpointer data)
 675 {
 676   ThreadMemory *tmem = data;
 677   const guint n_magazines = MAX_SLAB_INDEX (allocator);
 678   guint ix;
 679   for (ix = 0; ix < n_magazines; ix++)
 680     {
 681       Magazine *mags[2];
 682       guint j;
 683       mags[0] = &tmem->magazine1[ix];
 684       mags[1] = &tmem->magazine2[ix];
 685       for (j = 0; j < 2; j++)
 686         {
 687           Magazine *mag = mags[j];
 688           if (mag->count >= MIN_MAGAZINE_SIZE)
 689             magazine_cache_push_magazine (ix, mag->chunks, mag->count);
 690           else
 691             {
 692               const gsize chunk_size = SLAB_CHUNK_SIZE (allocator, ix);
 693               g_mutex_lock (allocator->slab_mutex);
 694               while (mag->chunks)
 695                 {
 696                   ChunkLink *chunk = magazine_chain_pop_head (&mag->chunks);
 697                   slab_allocator_free_chunk (chunk_size, chunk);
 698                 }
 699               g_mutex_unlock (allocator->slab_mutex);
 700             }
 701         }
 702     }
 703   g_free (tmem);
 704 }
 705
 706 static void
 707 thread_memory_magazine1_reload (ThreadMemory *tmem,
 708                                 guint         ix)
 709 {
 710   Magazine *mag = &tmem->magazine1[ix];
 711   mem_assert (mag->chunks == NULL); /* ensure that we may reset mag->count */
 712   mag->count = 0;
 713   mag->chunks = magazine_cache_pop_magazine (ix, &mag->count);
 714 }
 715
 716 static void
 717 thread_memory_magazine2_unload (ThreadMemory *tmem,
 718                                 guint         ix)
 719 {
 720   Magazine *mag = &tmem->magazine2[ix];
 721   magazine_cache_push_magazine (ix, mag->chunks, mag->count);
 722   mag->chunks = NULL;
 723   mag->count = 0;
 724 }
 725
 726 static inline void
 727 thread_memory_swap_magazines (ThreadMemory *tmem,
 728                               guint         ix)
 729 {
 730   Magazine xmag = tmem->magazine1[ix];
 731   tmem->magazine1[ix] = tmem->magazine2[ix];
 732   tmem->magazine2[ix] = xmag;
 733 }
 734
 735 static inline gboolean
 736 thread_memory_magazine1_is_empty (ThreadMemory *tmem,
 737                                   guint         ix)
 738 {
 739   return tmem->magazine1[ix].chunks == NULL;
 740 }
 741
 742 static inline gboolean
 743 thread_memory_magazine2_is_full (ThreadMemory *tmem,
 744                                  guint         ix)
 745 {
 746   return tmem->magazine2[ix].count >= allocator_get_magazine_threshold (allocator, ix);
 747 }
 748
 749 static inline gpointer
 750 thread_memory_magazine1_alloc (ThreadMemory *tmem,
 751                                guint         ix)
 752 {
 753   Magazine *mag = &tmem->magazine1[ix];
 754   ChunkLink *chunk = magazine_chain_pop_head (&mag->chunks);
 755   if (G_LIKELY (mag->count > 0))
 756     mag->count--;
 757   return chunk;
 758 }
 759
 760 static inline void
 761 thread_memory_magazine2_free (ThreadMemory *tmem,
 762                               guint         ix,
 763                               gpointer      mem)
 764 {
 765   Magazine *mag = &tmem->magazine2[ix];
 766   ChunkLink *chunk = mem;
 767   chunk->data = NULL;
 768   chunk->next = mag->chunks;
 769   mag->chunks = chunk;
 770   mag->count++;
 771 }
 772
 773 /* --- API functions --- */
 774 gpointer
 775 g_slice_alloc (gsize mem_size)
 776 {
 777   gsize chunk_size;
 778   gpointer mem;
 779   guint acat;
 780   chunk_size = P2ALIGN (mem_size);
 781   acat = allocator_categorize (chunk_size);
 782   if (G_LIKELY (acat == 1))     /* allocate through magazine layer */
 783     {
 784       ThreadMemory *tmem = thread_memory_from_self();
 785       guint ix = SLAB_INDEX (allocator, chunk_size);
 786       if (G_UNLIKELY (thread_memory_magazine1_is_empty (tmem, ix)))
 787         {
 788           thread_memory_swap_magazines (tmem, ix);
 789           if (G_UNLIKELY (thread_memory_magazine1_is_empty (tmem, ix)))
 790             thread_memory_magazine1_reload (tmem, ix);
 791         }
 792       mem = thread_memory_magazine1_alloc (tmem, ix);
 793     }
 794   else if (acat == 2)           /* allocate through slab allocator */
 795     {
 796       g_mutex_lock (allocator->slab_mutex);
 797       mem = slab_allocator_alloc_chunk (chunk_size);
 798       g_mutex_unlock (allocator->slab_mutex);
 799     }
 800   else                          /* delegate to system malloc */
 801     mem = g_malloc (mem_size);
 802   if (G_UNLIKELY (allocator->config.debug_blocks))
 803     smc_notify_alloc (mem, mem_size);
 804   return mem;
 805 }
 806
 807 gpointer
 808 g_slice_alloc0 (gsize mem_size)
 809 {
 810   gpointer mem = g_slice_alloc (mem_size);
 811   if (mem)
 812     memset (mem, 0, mem_size);
 813   return mem;
 814 }
 815
 816 void
 817 g_slice_free1 (gsize    mem_size,
 818                gpointer mem_block)
 819 {
 820   gsize chunk_size = P2ALIGN (mem_size);
 821   guint acat = allocator_categorize (chunk_size);
 822   if (G_UNLIKELY (!mem_block))
 823     return;
 824   if (G_UNLIKELY (allocator->config.debug_blocks) &&
 825       !smc_notify_free (mem_block, mem_size))
 826     abort();
 827   if (G_LIKELY (acat == 1))             /* allocate through magazine layer */
 828     {
 829       ThreadMemory *tmem = thread_memory_from_self();
 830       guint ix = SLAB_INDEX (allocator, chunk_size);
 831       if (G_UNLIKELY (thread_memory_magazine2_is_full (tmem, ix)))
 832         {
 833           thread_memory_swap_magazines (tmem, ix);
 834           if (G_UNLIKELY (thread_memory_magazine2_is_full (tmem, ix)))
 835             thread_memory_magazine2_unload (tmem, ix);
 836         }
 837       if (G_UNLIKELY (g_mem_gc_friendly))
 838         memset (mem_block, 0, chunk_size);
 839       thread_memory_magazine2_free (tmem, ix, mem_block);
 840     }
 841   else if (acat == 2)                   /* allocate through slab allocator */
 842     {
 843       if (G_UNLIKELY (g_mem_gc_friendly))
 844         memset (mem_block, 0, chunk_size);
 845       g_mutex_lock (allocator->slab_mutex);
 846       slab_allocator_free_chunk (chunk_size, mem_block);
 847       g_mutex_unlock (allocator->slab_mutex);
 848     }
 849   else                                  /* delegate to system malloc */
 850     {
 851       if (G_UNLIKELY (g_mem_gc_friendly))
 852         memset (mem_block, 0, mem_size);
 853       g_free (mem_block);
 854     }
 855 }
 856
 857 void
 858 g_slice_free_chain_with_offset (gsize    mem_size,
 859                                 gpointer mem_chain,
 860                                 gsize    next_offset)
 861 {
 862   gpointer slice = mem_chain;
 863   /* while the thread magazines and the magazine cache are implemented so that
 864    * they can easily be extended to allow for free lists containing more free
 865    * lists for the first level nodes, which would allow O(1) freeing in this
 866    * function, the benefit of such an extension is questionable, because:
 867    * - the magazine size counts will become mere lower bounds which confuses
 868    *   the code adapting to lock contention;
 869    * - freeing a single node to the thread magazines is very fast, so this
 870    *   O(list_length) operation is multiplied by a fairly small factor;
 871    * - memory usage histograms on larger applications seem to indicate that
 872    *   the amount of released multi node lists is negligible in comparison
 873    *   to single node releases.
 874    * - the major performance bottle neck, namely g_private_get() or
 875    *   g_mutex_lock()/g_mutex_unlock() has already been moved out of the
 876    *   inner loop for freeing chained slices.
 877    */
 878   gsize chunk_size = P2ALIGN (mem_size);
 879   guint acat = allocator_categorize (chunk_size);
 880   if (G_LIKELY (acat == 1))             /* allocate through magazine layer */
 881     {
 882       ThreadMemory *tmem = thread_memory_from_self();
 883       guint ix = SLAB_INDEX (allocator, chunk_size);
 884       while (slice)
 885         {
 886           guint8 *current = slice;
 887           slice = *(gpointer*) (current + next_offset);
 888           if (G_UNLIKELY (allocator->config.debug_blocks) &&
 889               !smc_notify_free (current, mem_size))
 890             abort();
 891           if (G_UNLIKELY (thread_memory_magazine2_is_full (tmem, ix)))
 892             {
 893               thread_memory_swap_magazines (tmem, ix);
 894               if (G_UNLIKELY (thread_memory_magazine2_is_full (tmem, ix)))
 895                 thread_memory_magazine2_unload (tmem, ix);
 896             }
 897           if (G_UNLIKELY (g_mem_gc_friendly))
 898             memset (current, 0, chunk_size);
 899           thread_memory_magazine2_free (tmem, ix, current);
 900         }
 901     }
 902   else if (acat == 2)                   /* allocate through slab allocator */
 903     {
 904       g_mutex_lock (allocator->slab_mutex);
 905       while (slice)
 906         {
 907           guint8 *current = slice;
 908           slice = *(gpointer*) (current + next_offset);
 909           if (G_UNLIKELY (allocator->config.debug_blocks) &&
 910               !smc_notify_free (current, mem_size))
 911             abort();
 912           if (G_UNLIKELY (g_mem_gc_friendly))
 913             memset (current, 0, chunk_size);
 914           slab_allocator_free_chunk (chunk_size, current);
 915         }
 916       g_mutex_unlock (allocator->slab_mutex);
 917     }
 918   else                                  /* delegate to system malloc */
 919     while (slice)
 920       {
 921         guint8 *current = slice;
 922         slice = *(gpointer*) (current + next_offset);
 923         if (G_UNLIKELY (allocator->config.debug_blocks) &&
 924             !smc_notify_free (current, mem_size))
 925           abort();
 926         if (G_UNLIKELY (g_mem_gc_friendly))
 927           memset (current, 0, mem_size);
 928         g_free (current);
 929       }
 930 }
 931
 932 /* --- single page allocator --- */
 933 static void
 934 allocator_slab_stack_push (Allocator *allocator,
 935                            guint      ix,
 936                            SlabInfo  *sinfo)
 937 {
 938   /* insert slab at slab ring head */
 939   if (!allocator->slab_stack[ix])
 940     {
 941       sinfo->next = sinfo;
 942       sinfo->prev = sinfo;
 943     }
 944   else
 945     {
 946       SlabInfo *next = allocator->slab_stack[ix], *prev = next->prev;
 947       next->prev = sinfo;
 948       prev->next = sinfo;
 949       sinfo->next = next;
 950       sinfo->prev = prev;
 951     }
 952   allocator->slab_stack[ix] = sinfo;
 953 }
 954
 955 static gsize
 956 allocator_aligned_page_size (Allocator *allocator,
 957                              gsize      n_bytes)
 958 {
 959   gsize val = 1 << g_bit_storage (n_bytes - 1);
 960   val = MAX (val, allocator->min_page_size);
 961   return val;
 962 }
 963
 964 static void
 965 allocator_add_slab (Allocator *allocator,
 966                     guint      ix,
 967                     gsize      chunk_size)
 968 {
 969   ChunkLink *chunk;
 970   SlabInfo *sinfo;
 971   gsize addr, padding, n_chunks, color = 0;
 972   gsize page_size = allocator_aligned_page_size (allocator, SLAB_BPAGE_SIZE (allocator, chunk_size));
 973   /* allocate 1 page for the chunks and the slab */
 974   gpointer aligned_memory = allocator_memalign (page_size, page_size - NATIVE_MALLOC_PADDING);
 975   guint8 *mem = aligned_memory;
 976   guint i;
 977   if (!mem)
 978     {
 979       const gchar *syserr = "unknown error";
 980 #if HAVE_STRERROR
 981       syserr = strerror (errno);
 982 #endif
 983       mem_error ("failed to allocate %u bytes (alignment: %u): %s\n",
 984                  (guint) (page_size - NATIVE_MALLOC_PADDING), (guint) page_size, syserr);
 985     }
 986   /* mask page adress */
 987   addr = ((gsize) mem / page_size) * page_size;
 988   /* assert alignment */
 989   mem_assert (aligned_memory == (gpointer) addr);
 990   /* basic slab info setup */
 991   sinfo = (SlabInfo*) (mem + page_size - SLAB_INFO_SIZE);
 992   sinfo->n_allocated = 0;
 993   sinfo->chunks = NULL;
 994   /* figure cache colorization */
 995   n_chunks = ((guint8*) sinfo - mem) / chunk_size;
 996   padding = ((guint8*) sinfo - mem) - n_chunks * chunk_size;
 997   if (padding)
 998     {
 999       color = (allocator->color_accu * P2ALIGNMENT) % padding;
1000       allocator->color_accu += allocator->config.color_increment;
1001     }
1002   /* add chunks to free list */
1003   chunk = (ChunkLink*) (mem + color);
1004   sinfo->chunks = chunk;
1005   for (i = 0; i < n_chunks - 1; i++)
1006     {
1007       chunk->next = (ChunkLink*) ((guint8*) chunk + chunk_size);
1008       chunk = chunk->next;
1009     }
1010   chunk->next = NULL;   /* last chunk */
1011   /* add slab to slab ring */
1012   allocator_slab_stack_push (allocator, ix, sinfo);
1013 }
1014
1015 static gpointer
1016 slab_allocator_alloc_chunk (gsize chunk_size)
1017 {
1018   ChunkLink *chunk;
1019   guint ix = SLAB_INDEX (allocator, chunk_size);
1020   /* ensure non-empty slab */
1021   if (!allocator->slab_stack[ix] || !allocator->slab_stack[ix]->chunks)
1022     allocator_add_slab (allocator, ix, chunk_size);
1023   /* allocate chunk */
1024   chunk = allocator->slab_stack[ix]->chunks;
1025   allocator->slab_stack[ix]->chunks = chunk->next;
1026   allocator->slab_stack[ix]->n_allocated++;
1027   /* rotate empty slabs */
1028   if (!allocator->slab_stack[ix]->chunks)
1029     allocator->slab_stack[ix] = allocator->slab_stack[ix]->next;
1030   return chunk;
1031 }
1032
1033 static void
1034 slab_allocator_free_chunk (gsize    chunk_size,
1035                            gpointer mem)
1036 {
1037   ChunkLink *chunk;
1038   gboolean was_empty;
1039   guint ix = SLAB_INDEX (allocator, chunk_size);
1040   gsize page_size = allocator_aligned_page_size (allocator, SLAB_BPAGE_SIZE (allocator, chunk_size));
1041   gsize addr = ((gsize) mem / page_size) * page_size;
1042   /* mask page adress */
1043   guint8 *page = (guint8*) addr;
1044   SlabInfo *sinfo = (SlabInfo*) (page + page_size - SLAB_INFO_SIZE);
1045   /* assert valid chunk count */
1046   mem_assert (sinfo->n_allocated > 0);
1047   /* add chunk to free list */
1048   was_empty = sinfo->chunks == NULL;
1049   chunk = (ChunkLink*) mem;
1050   chunk->next = sinfo->chunks;
1051   sinfo->chunks = chunk;
1052   sinfo->n_allocated--;
1053   /* keep slab ring partially sorted, empty slabs at end */
1054   if (was_empty)
1055     {
1056       /* unlink slab */
1057       SlabInfo *next = sinfo->next, *prev = sinfo->prev;
1058       next->prev = prev;
1059       prev->next = next;
1060       if (allocator->slab_stack[ix] == sinfo)
1061         allocator->slab_stack[ix] = next == sinfo ? NULL : next;
1062       /* insert slab at head */
1063       allocator_slab_stack_push (allocator, ix, sinfo);
1064     }
1065   /* eagerly free complete unused slabs */
1066   if (!sinfo->n_allocated)
1067     {
1068       /* unlink slab */
1069       SlabInfo *next = sinfo->next, *prev = sinfo->prev;
1070       next->prev = prev;
1071       prev->next = next;
1072       if (allocator->slab_stack[ix] == sinfo)
1073         allocator->slab_stack[ix] = next == sinfo ? NULL : next;
1074       /* free slab */
1075       allocator_memfree (page_size, page);
1076     }
1077 }
1078
1079 /* --- memalign implementation --- */
1080 #ifdef HAVE_MALLOC_H
1081 #include <malloc.h>             /* memalign() */
1082 #endif
1083
1084 /* from config.h:
1085  * define HAVE_POSIX_MEMALIGN           1 // if free(posix_memalign(3)) works, <stdlib.h>
1086  * define HAVE_COMPLIANT_POSIX_MEMALIGN 1 // if free(posix_memalign(3)) works for sizes != 2^n, <stdlib.h>
1087  * define HAVE_MEMALIGN                 1 // if free(memalign(3)) works, <malloc.h>
1088  * define HAVE_VALLOC                   1 // if free(valloc(3)) works, <stdlib.h> or <malloc.h>
1089  * if none is provided, we implement malloc(3)-based alloc-only page alignment
1090  */
1091
1092 #if !(HAVE_COMPLIANT_POSIX_MEMALIGN || HAVE_MEMALIGN || HAVE_VALLOC)
1093 static GTrashStack *compat_valloc_trash = NULL;
1094 #endif
1095
1096 static gpointer
1097 allocator_memalign (gsize alignment,
1098                     gsize memsize)
1099 {
1100   gpointer aligned_memory = NULL;
1101   gint err = ENOMEM;
1102 #if     HAVE_COMPLIANT_POSIX_MEMALIGN
1103   err = posix_memalign (&aligned_memory, alignment, memsize);
1104 #elif   HAVE_MEMALIGN
1105   errno = 0;
1106   aligned_memory = memalign (alignment, memsize);
1107   err = errno;
1108 #elif   HAVE_VALLOC
1109   errno = 0;
1110   aligned_memory = valloc (memsize);
1111   err = errno;
1112 #else
1113   /* simplistic non-freeing page allocator */
1114   mem_assert (alignment == sys_page_size);
1115   mem_assert (memsize <= sys_page_size);
1116   if (!compat_valloc_trash)
1117     {
1118       const guint n_pages = 16;
1119       guint8 *mem = malloc (n_pages * sys_page_size);
1120       err = errno;
1121       if (mem)
1122         {
1123           gint i = n_pages;
1124           guint8 *amem = (guint8*) ALIGN ((gsize) mem, sys_page_size);
1125           if (amem != mem)
1126             i--;        /* mem wasn't page aligned */
1127           while (--i >= 0)
1128             g_trash_stack_push (&compat_valloc_trash, amem + i * sys_page_size);
1129         }
1130     }
1131   aligned_memory = g_trash_stack_pop (&compat_valloc_trash);
1132 #endif
1133   if (!aligned_memory)
1134     errno = err;
1135   return aligned_memory;
1136 }
1137
1138 static void
1139 allocator_memfree (gsize    memsize,
1140                    gpointer mem)
1141 {
1142 #if     HAVE_COMPLIANT_POSIX_MEMALIGN || HAVE_MEMALIGN || HAVE_VALLOC
1143   free (mem);
1144 #else
1145   mem_assert (memsize <= sys_page_size);
1146   g_trash_stack_push (&compat_valloc_trash, mem);
1147 #endif
1148 }
1149
1150 static void
1151 mem_error (const char *format,
1152            ...)
1153 {
1154   const char *pname;
1155   va_list args;
1156   /* at least, put out "MEMORY-ERROR", in case we segfault during the rest of the function */
1157   fputs ("\n***MEMORY-ERROR***: ", stderr);
1158   pname = g_get_prgname();
1159   fprintf (stderr, "%s[%u]: GSlice: ", pname ? pname : "", getpid());
1160   va_start (args, format);
1161   vfprintf (stderr, format, args);
1162   va_end (args);
1163   fputs ("\n", stderr);
1164   abort();
1165   _exit (1);
1166 }
1167
1168 /* --- g-slice memory checker tree --- */
1169 typedef size_t SmcKType;                /* key type */
1170 typedef size_t SmcVType;                /* value type */
1171 typedef struct {
1172   SmcKType key;
1173   SmcVType value;
1174 } SmcEntry;
1175 static void             smc_tree_insert      (SmcKType  key,
1176                                               SmcVType  value);
1177 static gboolean         smc_tree_lookup      (SmcKType  key,
1178                                               SmcVType *value_p);
1179 static gboolean         smc_tree_remove      (SmcKType  key);
1180
1181
1182 /* --- g-slice memory checker implementation --- */
1183 static void
1184 smc_notify_alloc (void   *pointer,
1185                   size_t  size)
1186 {
1187   size_t adress = (size_t) pointer;
1188   if (pointer)
1189     smc_tree_insert (adress, size);
1190 }
1191
1192 #if 0
1193 static void
1194 smc_notify_ignore (void *pointer)
1195 {
1196   size_t adress = (size_t) pointer;
1197   if (pointer)
1198     smc_tree_remove (adress);
1199 }
1200 #endif
1201
1202 static int
1203 smc_notify_free (void   *pointer,
1204                  size_t  size)
1205 {
1206   size_t adress = (size_t) pointer;
1207   if (!pointer)
1208     return 1; /* ignore */
1209   SmcVType real_size;
1210   gboolean found_one = smc_tree_lookup (adress, &real_size);
1211   if (!found_one)
1212     {
1213       fprintf (stderr, "GSlice: MemChecker: attempt to release non-allocated block: %p size=%zu\n", pointer, size);
1214       return 0;
1215     }
1216   if (real_size != size && (real_size || size))
1217     {
1218       fprintf (stderr, "GSlice: MemChecker: attempt to release block with invalid size: %p size=%zu invalid-size=%zu\n", pointer, real_size, size);
1219       return 0;
1220     }
1221   if (!smc_tree_remove (adress))
1222     {
1223       fprintf (stderr, "GSlice: MemChecker: attempt to release non-allocated block: %p size=%zu\n", pointer, size);
1224       return 0;
1225     }
1226   return 1; /* all fine */
1227 }
1228
1229 /* --- g-slice memory checker tree implementation --- */
1230 #define SMC_TRUNK_COUNT     (4093 /* 16381 */)          /* prime, to distribute trunk collisions (big, allocated just once) */
1231 #define SMC_BRANCH_COUNT    (511)                       /* prime, to distribute branch collisions */
1232 #define SMC_TRUNK_EXTENT    (SMC_BRANCH_COUNT * 2039)   /* key adress space per trunk, should distribute uniformly across BRANCH_COUNT */
1233 #define SMC_TRUNK_HASH(k)   ((k / SMC_TRUNK_EXTENT) % SMC_TRUNK_COUNT)  /* generate new trunk hash per megabyte (roughly) */
1234 #define SMC_BRANCH_HASH(k)  (k % SMC_BRANCH_COUNT)
1235
1236 typedef struct {
1237   SmcEntry    *entries;
1238   unsigned int n_entries;
1239 } SmcBranch;
1240
1241 static SmcBranch     **smc_tree_root = NULL;
1242
1243 static void
1244 smc_tree_abort (int errval)
1245 {
1246   const char *syserr = "unknown error";
1247 #if HAVE_STRERROR
1248   syserr = strerror (errval);
1249 #endif
1250   mem_error ("MemChecker: failure in debugging tree: %s", syserr);
1251 }
1252
1253 static inline SmcEntry*
1254 smc_tree_branch_grow_L (SmcBranch   *branch,
1255                         unsigned int index)
1256 {
1257   unsigned int old_size = branch->n_entries * sizeof (branch->entries[0]);
1258   unsigned int new_size = old_size + sizeof (branch->entries[0]);
1259   SmcEntry *entry;
1260   mem_assert (index <= branch->n_entries);
1261   branch->entries = (SmcEntry*) realloc (branch->entries, new_size);
1262   if (!branch->entries)
1263     smc_tree_abort (errno);
1264   entry = branch->entries + index;
1265   g_memmove (entry + 1, entry, (branch->n_entries - index) * sizeof (entry[0]));
1266   branch->n_entries += 1;
1267   return entry;
1268 }
1269
1270 static inline SmcEntry*
1271 smc_tree_branch_lookup_nearest_L (SmcBranch *branch,
1272                                   SmcKType   key)
1273 {
1274   unsigned int n_nodes = branch->n_entries, offs = 0;
1275   SmcEntry *check = branch->entries;
1276   int cmp = 0;
1277   while (offs < n_nodes)
1278     {
1279       unsigned int i = (offs + n_nodes) >> 1;
1280       check = branch->entries + i;
1281       cmp = key < check->key ? -1 : key != check->key;
1282       if (cmp == 0)
1283         return check;                   /* return exact match */
1284       else if (cmp < 0)
1285         n_nodes = i;
1286       else /* (cmp > 0) */
1287         offs = i + 1;
1288     }
1289   /* check points at last mismatch, cmp > 0 indicates greater key */
1290   return cmp > 0 ? check + 1 : check;   /* return insertion position for inexact match */
1291 }
1292
1293 static void
1294 smc_tree_insert (SmcKType key,
1295                  SmcVType value)
1296 {
1297   g_mutex_lock (smc_tree_mutex);
1298   unsigned int ix0 = SMC_TRUNK_HASH (key), ix1 = SMC_BRANCH_HASH (key);
1299   if (!smc_tree_root)
1300     {
1301       smc_tree_root = calloc (SMC_TRUNK_COUNT, sizeof (smc_tree_root[0]));
1302       if (!smc_tree_root)
1303         smc_tree_abort (errno);
1304     }
1305   if (!smc_tree_root[ix0])
1306     {
1307       smc_tree_root[ix0] = calloc (SMC_BRANCH_COUNT, sizeof (smc_tree_root[0][0]));
1308       if (!smc_tree_root[ix0])
1309         smc_tree_abort (errno);
1310     }
1311   SmcEntry *entry = smc_tree_branch_lookup_nearest_L (&smc_tree_root[ix0][ix1], key);
1312   if (!entry ||                                                                         /* need create */
1313       entry >= smc_tree_root[ix0][ix1].entries + smc_tree_root[ix0][ix1].n_entries ||   /* need append */
1314       entry->key != key)                                                                /* need insert */
1315     entry = smc_tree_branch_grow_L (&smc_tree_root[ix0][ix1], entry - smc_tree_root[ix0][ix1].entries);
1316   entry->key = key;
1317   entry->value = value;
1318   g_mutex_unlock (smc_tree_mutex);
1319 }
1320
1321 static gboolean
1322 smc_tree_lookup (SmcKType  key,
1323                  SmcVType *value_p)
1324 {
1325   unsigned int ix0 = SMC_TRUNK_HASH (key), ix1 = SMC_BRANCH_HASH (key);
1326   gboolean found_one = FALSE;
1327   *value_p = 0;
1328   g_mutex_lock (smc_tree_mutex);
1329   SmcEntry *entry = NULL;
1330   if (smc_tree_root && smc_tree_root[ix0])
1331     {
1332       entry = smc_tree_branch_lookup_nearest_L (&smc_tree_root[ix0][ix1], key);
1333       if (entry &&
1334           entry < smc_tree_root[ix0][ix1].entries + smc_tree_root[ix0][ix1].n_entries &&
1335           entry->key == key)
1336         {
1337           found_one = TRUE;
1338           *value_p = entry->value;
1339         }
1340     }
1341   g_mutex_unlock (smc_tree_mutex);
1342   return found_one;
1343 }
1344
1345 static gboolean
1346 smc_tree_remove (SmcKType key)
1347 {
1348   unsigned int ix0 = SMC_TRUNK_HASH (key), ix1 = SMC_BRANCH_HASH (key);
1349   gboolean found_one = FALSE;
1350   g_mutex_lock (smc_tree_mutex);
1351   if (smc_tree_root && smc_tree_root[ix0])
1352     {
1353       SmcEntry *entry = smc_tree_branch_lookup_nearest_L (&smc_tree_root[ix0][ix1], key);
1354       if (entry &&
1355           entry < smc_tree_root[ix0][ix1].entries + smc_tree_root[ix0][ix1].n_entries &&
1356           entry->key == key)
1357         {
1358           unsigned int i = entry - smc_tree_root[ix0][ix1].entries;
1359           smc_tree_root[ix0][ix1].n_entries -= 1;
1360           g_memmove (entry, entry + 1, (smc_tree_root[ix0][ix1].n_entries - i) * sizeof (entry[0]));
1361           if (!smc_tree_root[ix0][ix1].n_entries)
1362             {
1363               /* avoid useless pressure on the memory system */
1364               free (smc_tree_root[ix0][ix1].entries);
1365               smc_tree_root[ix0][ix1].entries = NULL;
1366             }
1367           found_one = TRUE;
1368         }
1369     }
1370   g_mutex_unlock (smc_tree_mutex);
1371   return found_one;
1372 }
1373
1374 #ifdef  G_ENABLE_DEBUG
1375 void
1376 g_slice_debug_tree_statistics (void)
1377 {
1378   g_mutex_lock (smc_tree_mutex);
1379   if (smc_tree_root)
1380     {
1381       unsigned int i, j, t = 0, o = 0, b = 0, su = 0, ex = 0, en = 4294967295u;
1382       double tf, bf;
1383       for (i = 0; i < SMC_TRUNK_COUNT; i++)
1384         if (smc_tree_root[i])
1385           {
1386             t++;
1387             for (j = 0; j < SMC_BRANCH_COUNT; j++)
1388               if (smc_tree_root[i][j].n_entries)
1389                 {
1390                   b++;
1391                   su += smc_tree_root[i][j].n_entries;
1392                   en = MIN (en, smc_tree_root[i][j].n_entries);
1393                   ex = MAX (ex, smc_tree_root[i][j].n_entries);
1394                 }
1395               else if (smc_tree_root[i][j].entries)
1396                 o++; /* formerly used, now empty */
1397           }
1398       en = b ? en : 0;
1399       tf = MAX (t, 1.0); // max(1) to be a valid divisor
1400       bf = MAX (b, 1.0); // max(1) to be a valid divisor
1401       fprintf (stderr, "GSlice: MemChecker: %u trunks, %u branches, %u old branches\n", t, b, o);
1402       fprintf (stderr, "GSlice: MemChecker: %f branches per trunk, %.2f%% utilization\n",
1403                b / tf,
1404                100.0 - (SMC_BRANCH_COUNT - b / tf) / (0.01 * SMC_BRANCH_COUNT));
1405       fprintf (stderr, "GSlice: MemChecker: %f entries per branch, %u minimum, %u maximum\n",
1406                su / bf, en, ex);
1407     }
1408   else
1409     fprintf (stderr, "GSlice: MemChecker: root=NULL\n");
1410   g_mutex_unlock (smc_tree_mutex);
1411
1412   /* sample statistics (beast + GSLice + 24h scripted core & GUI activity):
1413    *  PID %CPU %MEM   VSZ  RSS      COMMAND
1414    * 8887 30.3 45.8 456068 414856   beast-0.7.1 empty.bse
1415    * $ cat /proc/8887/statm # total-program-size resident-set-size shared-pages text/code data/stack library dirty-pages
1416    * 114017 103714 2354 344 0 108676 0
1417    * $ cat /proc/8887/status
1418    * Name:   beast-0.7.1
1419    * VmSize:   456068 kB
1420    * VmLck:         0 kB
1421    * VmRSS:    414856 kB
1422    * VmData:   434620 kB
1423    * VmStk:        84 kB
1424    * VmExe:      1376 kB
1425    * VmLib:     13036 kB
1426    * VmPTE:       456 kB
1427    * Threads:        3
1428    * (gdb) print g_slice_debug_tree_statistics ()
1429    * GSlice: MemChecker: 422 trunks, 213068 branches, 0 old branches
1430    * GSlice: MemChecker: 504.900474 branches per trunk, 98.81% utilization
1431    * GSlice: MemChecker: 4.965039 entries per branch, 1 minimum, 37 maximum
1432    */
1433 }
1434 #endif /* G_ENABLE_DEBUG */
1435
1436 #define __G_SLICE_C__
1437 #include "galiasdef.c"