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