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 #define _XOPEN_SOURCE 600       /* posix_memalign() */
  21 #include <stdlib.h>             /* posix_memalign() */
  22 #include <unistd.h>             /* sysconf() */
  23 #include <assert.h>             /* assert() for nomessage phase */
  24 #include <string.h>
  25 #include <errno.h>
  26 #include "config.h"
  27 #include "gmem.h"               /* gslice.h */
  28 #include "gthreadinit.h"
  29 #include "galias.h"
  30 #include "glib.h"
  31
  32 /* the GSlice allocator is split up into 4 layers, roughly modelled after the slab
  33  * allocator and magazine extensions as outlined in:
  34  * + [Bonwick94] Jeff Bonwick, The slab allocator: An object-caching kernel
  35  *   memory allocator. USENIX 1994, http://citeseer.ist.psu.edu/bonwick94slab.html
  36  * + [Bonwick01] Bonwick and Jonathan Adams, Magazines and vmem: Extending the
  37  *   slab allocator to many cpu's and arbitrary resources.
  38  *   USENIX 2001, http://citeseer.ist.psu.edu/bonwick01magazines.html
  39  * the layers are:
  40  * - the thread magazines. for each (aligned) chunk size, a magazine (a list)
  41  *   of recently freed and soon to be allocated chunks is maintained per thread.
  42  *   this way, most alloc/free requests can be quickly satisfied from per-thread
  43  *   free lists which only require one g_private_get() call to retrive the
  44  *   thread handle.
  45  * - the magazine cache. allocating and freeing chunks to/from threads only
  46  *   occours at magazine sizes from a global depot of magazines. the depot
  47  *   maintaines a 15 second working set of allocated magazines, so full
  48  *   magazines are not allocated and released too often.
  49  *   the chunk size dependent magazine sizes automatically adapt (within limits,
  50  *   see [3]) to lock contention to properly scale performance across a variety
  51  *   of SMP systems.
  52  * - the slab allocator. this allocator allocates slabs (blocks of memory) close
  53  *   to the system page size or multiples thereof which have to be page aligned.
  54  *   the blocks are divided into smaller chunks which are used to satisfy
  55  *   allocations from the upper layers. the space provided by the reminder of
  56  *   the chunk size division is used for cache colorization (random distribution
  57  *   of chunk addresses) to improve processor cache utilization. multiple slabs
  58  *   with the same chunk size are kept in a partially sorted ring to allow O(1)
  59  *   freeing and allocation of chunks (as long as the allocation of an entirely
  60  *   new slab can be avoided).
  61  * - the page allocator. on most modern systems, posix_memalign(3) or
  62  *   memalign(3) should be available, so this is used to allocate blocks with
  63  *   system page size based alignments and sizes or multiples thereof.
  64  *   if no memalign variant is provided, valloc() is used instead and
  65  *   block sizes are limited to the system page size (no multiples thereof).
  66  *   as a fallback, on system without even valloc(), a malloc(3)-based page
  67  *   allocator with alloc-only behaviour is used.
  68  *
  69  * NOTES:
  70  * [1] some systems memalign(3) implementations may rely on boundary tagging for
  71  *     the handed out memory chunks. to avoid excessive page-wise fragmentation,
  72  *     we reserve 2 * sizeof (void*) per block size for the systems memalign(3),
  73  *     specified in NATIVE_MALLOC_PADDING.
  74  * [2] using the slab allocator alone already provides for a fast and efficient
  75  *     allocator, it doesn't properly scale beyond single-threaded uses though.
  76  *     also, the slab allocator implements eager free(3)-ing, i.e. does not
  77  *     provide any form of caching or working set maintenance. so if used alone,
  78  *     it's vulnerable to trashing for sequences of balanced (alloc, free) pairs
  79  *     at certain thresholds.
  80  * [3] magazine sizes are bound by an implementation specific minimum size and
  81  *     a chunk size specific maximum to limit magazine storage sizes to roughly
  82  *     16KB.
  83  * [4] allocating ca. 8 chunks per block/page keeps a good balance between
  84  *     external and internal fragmentation (<= 12.5%) [Bonwick94]
  85  */
  86
  87 /* --- macros and constants --- */
  88 #define LARGEALIGNMENT          (256)
  89 #define P2ALIGNMENT             (2 * sizeof (gsize))                            /* fits 2 pointers (assumed to be 2 * GLIB_SIZEOF_SIZE_T below) */
  90 #define ALIGN(size, base)       ((base) * (gsize) (((size) + (base) - 1) / (base)))
  91 #define NATIVE_MALLOC_PADDING   P2ALIGNMENT                                     /* per-page padding left for native malloc(3) see [1] */
  92 #define SLAB_INFO_SIZE          P2ALIGN (sizeof (SlabInfo) + NATIVE_MALLOC_PADDING)
  93 #define MAX_MAGAZINE_SIZE       (256)                                           /* see [3] and allocator_get_magazine_threshold() for this */
  94 #define MIN_MAGAZINE_SIZE       (4)
  95 #define MAX_STAMP_COUNTER       (7)                                             /* distributes the load of gettimeofday() */
  96 #define MAX_SLAB_CHUNK_SIZE(al) (((al)->max_page_size - SLAB_INFO_SIZE) / 8)    /* we want at last 8 chunks per page, see [4] */
  97 #define MAX_SLAB_INDEX(al)      (SLAB_INDEX (al, MAX_SLAB_CHUNK_SIZE (al)) + 1)
  98 #define SLAB_INDEX(al, asize)   ((asize) / P2ALIGNMENT - 1)                     /* asize must be P2ALIGNMENT aligned */
  99 #define SLAB_CHUNK_SIZE(al, ix) (((ix) + 1) * P2ALIGNMENT)
 100 #define SLAB_PAGE_SIZE(al,csz)  (ALIGN (8 * (csz) + SLAB_INFO_SIZE, (al)->min_page_size))
 101
 102 /* optimized version of ALIGN (size, P2ALIGNMENT) */
 103 #if     GLIB_SIZEOF_SIZE_T * 2 == 8  /* P2ALIGNMENT */
 104 #define P2ALIGN(size)   (((size) + 0x7) & ~(gsize) 0x7)
 105 #elif   GLIB_SIZEOF_SIZE_T * 2 == 16 /* P2ALIGNMENT */
 106 #define P2ALIGN(size)   (((size) + 0xf) & ~(gsize) 0xf)
 107 #else
 108 #define P2ALIGN(size)   ALIGN (size, P2ALIGNMENT)
 109 #endif
 110
 111 /* --- structures --- */
 112 typedef struct _ChunkLink      ChunkLink;
 113 typedef struct _SlabInfo       SlabInfo;
 114 typedef struct _CachedMagazine CachedMagazine;
 115 struct _ChunkLink {
 116   ChunkLink *next;
 117   ChunkLink *data;
 118 };
 119 struct _SlabInfo {
 120   ChunkLink *chunks;
 121   guint n_allocated;
 122   SlabInfo *next, *prev;
 123 };
 124 typedef struct {
 125   ChunkLink *chunks;
 126   gsize      count;                     /* approximative chunks list length */
 127 } Magazine;
 128 typedef struct {
 129   Magazine   *magazine1;                /* array of MAX_SLAB_INDEX (allocator) */
 130   Magazine   *magazine2;                /* array of MAX_SLAB_INDEX (allocator) */
 131 } ThreadMemory;
 132 typedef struct {
 133   gboolean always_malloc;
 134   gboolean bypass_magazines;
 135   gboolean always_free;
 136   gsize    working_set_msecs;
 137 } SliceConfig;
 138 typedef struct {
 139   /* const after initialization */
 140   gsize         min_page_size, max_page_size;
 141   SliceConfig   config;
 142   guint         max_slab_chunk_size_for_magazine_cache;
 143   /* magazine cache */
 144   GMutex       *magazine_mutex;
 145   ChunkLink   **magazines;                /* array of MAX_SLAB_INDEX (allocator) */
 146   guint        *contention_counters;      /* array of MAX_SLAB_INDEX (allocator) */
 147   gint          mutex_counter;
 148   guint         stamp_counter;
 149   guint         last_stamp;
 150   /* slab allocator */
 151   GMutex       *slab_mutex;
 152   SlabInfo    **slab_stack;                /* array of MAX_SLAB_INDEX (allocator) */
 153   guint        color_accu;
 154 } Allocator;
 155
 156 /* --- prototypes --- */
 157 static gpointer     slab_allocator_alloc_chunk       (gsize      chunk_size);
 158 static void         slab_allocator_free_chunk        (gsize      chunk_size,
 159                                                       gpointer   mem);
 160 static void         private_thread_memory_cleanup    (gpointer   data);
 161 static gpointer     allocator_memalign               (gsize      alignment,
 162                                                       gsize      memsize);
 163 static void         allocator_memfree                (gsize      memsize,
 164                                                       gpointer   mem);
 165 static inline void  magazine_cache_update_stamp      (void);
 166 static inline gsize allocator_get_magazine_threshold (Allocator *allocator,
 167                                                       guint      ix);
 168
 169 /* --- variables --- */
 170 static GPrivate        *private_thread_memory = NULL;
 171 static gsize            sys_page_size = 0;
 172 static Allocator        allocator[1] = { { 0, }, };
 173 static SliceConfig      slice_config = {
 174   FALSE,        /* always_malloc */
 175   FALSE,        /* bypass_magazines */
 176   FALSE,        /* always_free */
 177   15 * 1000,    /* working_set_msecs */
 178 };
 179
 180 /* --- auxillary funcitons --- */
 181 void
 182 g_slice_set_config (GSliceConfig ckey,
 183                     gint64       value)
 184 {
 185   g_return_if_fail (sys_page_size == 0);
 186   switch (ckey)
 187     {
 188     case G_SLICE_CONFIG_ALWAYS_MALLOC:
 189       slice_config.always_malloc = value != 0;
 190       break;
 191     case G_SLICE_CONFIG_BYPASS_MAGAZINES:
 192       slice_config.bypass_magazines = value != 0;
 193       break;
 194     case G_SLICE_CONFIG_ALWAYS_FREE:
 195       slice_config.always_free = value != 0;
 196       break;
 197     case G_SLICE_CONFIG_WORKING_SET_MSECS:
 198       slice_config.working_set_msecs = value;
 199       break;
 200     default: ;
 201     }
 202 }
 203
 204 gint64
 205 g_slice_get_config (GSliceConfig ckey)
 206 {
 207   switch (ckey)
 208     {
 209     case G_SLICE_CONFIG_ALWAYS_MALLOC:
 210       return slice_config.always_malloc;
 211     case G_SLICE_CONFIG_BYPASS_MAGAZINES:
 212       return slice_config.bypass_magazines;
 213     case G_SLICE_CONFIG_ALWAYS_FREE:
 214       return slice_config.always_free;
 215     case G_SLICE_CONFIG_WORKING_SET_MSECS:
 216       return slice_config.working_set_msecs;
 217     case G_SLICE_CONFIG_CHUNK_SIZES:
 218       return MAX_SLAB_INDEX (allocator);
 219     default:
 220       return 0;
 221     }
 222 }
 223
 224 gint64*
 225 g_slice_get_config_state (GSliceConfig ckey,
 226                           gint64       address,
 227                           guint       *n_values)
 228 {
 229   guint i = 0;
 230   g_return_val_if_fail (n_values != NULL, NULL);
 231   *n_values = 0;
 232   switch (ckey)
 233     {
 234       gint64 array[64];
 235     case G_SLICE_CONFIG_CONTENTION_COUNTER:
 236       array[i++] = SLAB_CHUNK_SIZE (allocator, address);
 237       array[i++] = allocator->contention_counters[address];
 238       array[i++] = allocator_get_magazine_threshold (allocator, address);
 239       *n_values = i;
 240       return g_memdup (array, sizeof (array[0]) * *n_values);
 241     default:
 242       return NULL;
 243     }
 244 }
 245
 246 static void
 247 g_slice_init_nomessage (void)
 248 {
 249   /* we may not use g_error() or friends here */
 250   assert (sys_page_size == 0);
 251
 252   sys_page_size = sysconf (_SC_PAGESIZE); /* = sysconf (_SC_PAGE_SIZE); = getpagesize(); */
 253   assert (sys_page_size >= 2 * LARGEALIGNMENT);
 254   allocator->config = slice_config;
 255   allocator->min_page_size = sys_page_size;
 256 #if HAVE_POSIX_MEMALIGN || HAVE_MEMALIGN
 257   /* allow allocation of pages up to 8KB (with 8KB alignment).
 258    * this is useful because many medium to large sized structures
 259    * fit less than 8 times (see [4]) into 4KB pages.
 260    */
 261   allocator->min_page_size = MAX (allocator->min_page_size, 4096);
 262   allocator->max_page_size = MAX (allocator->min_page_size, 8192);
 263 #else
 264   /* we can only align to system page size */
 265   allocator->max_page_size = sys_page_size;
 266 #endif
 267   allocator->magazine_mutex = NULL;     /* _g_slice_thread_init_nomessage() */
 268   allocator->magazines = g_new0 (ChunkLink*, MAX_SLAB_INDEX (allocator));
 269   allocator->contention_counters = g_new0 (guint, MAX_SLAB_INDEX (allocator));
 270   allocator->mutex_counter = 0;
 271   allocator->stamp_counter = MAX_STAMP_COUNTER; /* force initial update */
 272   allocator->last_stamp = 0;
 273   allocator->slab_mutex = NULL;         /* _g_slice_thread_init_nomessage() */
 274   allocator->slab_stack = g_new0 (SlabInfo*, MAX_SLAB_INDEX (allocator));
 275   allocator->color_accu = 0;
 276   magazine_cache_update_stamp();
 277   /* values cached for performance reasons */
 278   allocator->max_slab_chunk_size_for_magazine_cache = MAX_SLAB_CHUNK_SIZE (allocator);
 279   if (allocator->config.always_malloc || allocator->config.bypass_magazines)
 280     allocator->max_slab_chunk_size_for_magazine_cache = 0;      /* non-optimized cases */
 281 }
 282
 283 static inline guint
 284 allocator_categorize (gsize aligned_chunk_size)
 285 {
 286   /* speed up the likely path */
 287   if (G_LIKELY (aligned_chunk_size && aligned_chunk_size <= allocator->max_slab_chunk_size_for_magazine_cache))
 288     return 1;           /* use magazine cache */
 289
 290   /* the above will fail (max_slab_chunk_size_for_magazine_cache == 0) if the
 291    * allocator is still uninitialized, or if we are not configured to use the
 292    * magazine cache.
 293    */
 294   if (!sys_page_size)
 295     g_slice_init_nomessage ();
 296   if (!allocator->config.always_malloc &&
 297       aligned_chunk_size &&
 298       aligned_chunk_size <= MAX_SLAB_CHUNK_SIZE (allocator))
 299     {
 300       if (allocator->config.bypass_magazines)
 301         return 2;       /* use slab allocator, see [2] */
 302       return 1;         /* use magazine cache */
 303     }
 304   return 0;             /* use malloc() */
 305 }
 306
 307 void
 308 _g_slice_thread_init_nomessage (void)
 309 {
 310   /* we may not use g_error() or friends here */
 311   if (!sys_page_size)
 312     g_slice_init_nomessage();
 313   private_thread_memory = g_private_new (private_thread_memory_cleanup);
 314   allocator->magazine_mutex = g_mutex_new();
 315   allocator->slab_mutex = g_mutex_new();
 316 }
 317
 318 static inline void
 319 g_mutex_lock_a (GMutex *mutex,
 320                 guint  *contention_counter)
 321 {
 322   gboolean contention = FALSE;
 323   if (!g_mutex_trylock (mutex))
 324     {
 325       g_mutex_lock (mutex);
 326       contention = TRUE;
 327     }
 328   if (contention)
 329     {
 330       allocator->mutex_counter++;
 331       if (allocator->mutex_counter >= 1)        /* quickly adapt to contention */
 332         {
 333           allocator->mutex_counter = 0;
 334           *contention_counter = MIN (*contention_counter + 1, MAX_MAGAZINE_SIZE);
 335         }
 336     }
 337   else /* !contention */
 338     {
 339       allocator->mutex_counter--;
 340       if (allocator->mutex_counter < -11)       /* moderately recover magazine sizes */
 341         {
 342           allocator->mutex_counter = 0;
 343           *contention_counter = MAX (*contention_counter, 1) - 1;
 344         }
 345     }
 346 }
 347
 348 static inline ThreadMemory*
 349 thread_memory_from_self (void)
 350 {
 351   ThreadMemory *tmem = g_private_get (private_thread_memory);
 352   if (G_UNLIKELY (!tmem))
 353     {
 354       const guint n_magazines = MAX_SLAB_INDEX (allocator);
 355       tmem = g_malloc0 (sizeof (ThreadMemory) + sizeof (Magazine) * 2 * n_magazines);
 356       tmem->magazine1 = (Magazine*) (tmem + 1);
 357       tmem->magazine2 = &tmem->magazine1[n_magazines];
 358       g_private_set (private_thread_memory, tmem);
 359     }
 360   return tmem;
 361 }
 362
 363 static inline ChunkLink*
 364 magazine_chain_pop_head (ChunkLink **magazine_chunks)
 365 {
 366   /* magazine chains are linked via ChunkLink->next.
 367    * each ChunkLink->data of the toplevel chain may point to a subchain,
 368    * linked via ChunkLink->next. ChunkLink->data of the subchains just
 369    * contains uninitialized junk.
 370    */
 371   ChunkLink *chunk = (*magazine_chunks)->data;
 372   if (G_UNLIKELY (chunk))
 373     {
 374       /* allocating from freed list */
 375       (*magazine_chunks)->data = chunk->next;
 376     }
 377   else
 378     {
 379       chunk = *magazine_chunks;
 380       *magazine_chunks = chunk->next;
 381     }
 382   return chunk;
 383 }
 384
 385 #if 0 /* useful for debugging */
 386 static guint
 387 magazine_count (ChunkLink *head)
 388 {
 389   guint count = 0;
 390   if (!head)
 391     return 0;
 392   while (head)
 393     {
 394       ChunkLink *child = head->data;
 395       count += 1;
 396       for (child = head->data; child; child = child->next)
 397         count += 1;
 398       head = head->next;
 399     }
 400   return count;
 401 }
 402 #endif
 403
 404 static inline gsize
 405 allocator_get_magazine_threshold (Allocator *allocator,
 406                                   guint      ix)
 407 {
 408   /* the magazine size calculated here has a lower bound of MIN_MAGAZINE_SIZE,
 409    * which is required by the implementation. also, for moderately sized chunks
 410    * (say >= 64 bytes), magazine sizes shouldn't be much smaller then the number
 411    * of chunks available per page/2 to avoid excessive traffic in the magazine
 412    * cache for small to medium sized structures.
 413    * the upper bound of the magazine size is effectively provided by
 414    * MAX_MAGAZINE_SIZE. for larger chunks, this number is scaled down so that
 415    * the content of a single magazine doesn't exceed ca. 16KB.
 416    */
 417   gsize chunk_size = SLAB_CHUNK_SIZE (allocator, ix);
 418   guint threshold = MAX (MIN_MAGAZINE_SIZE, allocator->max_page_size / MAX (5 * chunk_size, 5 * 32));
 419   guint contention_counter = allocator->contention_counters[ix];
 420   if (G_UNLIKELY (contention_counter))  /* single CPU bias */
 421     {
 422       /* adapt contention counter thresholds to chunk sizes */
 423       contention_counter = contention_counter * 64 / chunk_size;
 424       threshold = MAX (threshold, contention_counter);
 425     }
 426   return threshold;
 427 }
 428
 429 /* --- magazine cache --- */
 430 static inline void
 431 magazine_cache_update_stamp (void)
 432 {
 433   if (allocator->stamp_counter >= MAX_STAMP_COUNTER)
 434     {
 435       GTimeVal tv;
 436       g_get_current_time (&tv);
 437       allocator->last_stamp = tv.tv_sec * 1000 + tv.tv_usec / 1000; /* milli seconds */
 438       allocator->stamp_counter = 0;
 439     }
 440   else
 441     allocator->stamp_counter++;
 442 }
 443
 444 static inline ChunkLink*
 445 magazine_chain_prepare_fields (ChunkLink *magazine_chunks)
 446 {
 447   g_assert (MIN_MAGAZINE_SIZE >= 4);
 448   /* ensure a magazine with at least 4 unused data pointers */
 449   ChunkLink *chunk1 = magazine_chain_pop_head (&magazine_chunks);
 450   ChunkLink *chunk2 = magazine_chain_pop_head (&magazine_chunks);
 451   ChunkLink *chunk3 = magazine_chain_pop_head (&magazine_chunks);
 452   ChunkLink *chunk4 = magazine_chain_pop_head (&magazine_chunks);
 453   chunk4->next = magazine_chunks;
 454   chunk3->next = chunk4;
 455   chunk2->next = chunk3;
 456   chunk1->next = chunk2;
 457   return chunk1;
 458 }
 459
 460 /* access the first 3 fields of a specially prepared magazine chain */
 461 #define magazine_chain_prev(mc)         ((mc)->data)
 462 #define magazine_chain_stamp(mc)        ((mc)->next->data)
 463 #define magazine_chain_next(mc)         ((mc)->next->next->data)
 464 #define magazine_chain_count(mc)        ((mc)->next->next->next->data)
 465
 466 static void
 467 magazine_cache_trim (Allocator *allocator,
 468                      guint      ix,
 469                      guint      stamp)
 470 {
 471   /* g_mutex_lock (allocator->mutex); done by caller */
 472   /* trim magazine cache from tail */
 473   ChunkLink *current = magazine_chain_prev (allocator->magazines[ix]);
 474   ChunkLink *trash = NULL;
 475   while (allocator->config.always_free ||
 476          ABS (stamp - (guint) magazine_chain_stamp (current)) > allocator->config.working_set_msecs)
 477     {
 478       /* unlink */
 479       ChunkLink *prev = magazine_chain_prev (current);
 480       ChunkLink *next = magazine_chain_next (current);
 481       magazine_chain_next (prev) = next;
 482       magazine_chain_prev (next) = prev;
 483       /* clear special fields, put on trash stack */
 484       magazine_chain_next (current) = NULL;
 485       magazine_chain_count (current) = NULL;
 486       magazine_chain_stamp (current) = NULL;
 487       magazine_chain_prev (current) = trash;
 488       trash = current;
 489       /* fixup list head if required */
 490       if (current == allocator->magazines[ix])
 491         {
 492           allocator->magazines[ix] = NULL;
 493           break;
 494         }
 495       current = prev;
 496     }
 497   g_mutex_unlock (allocator->magazine_mutex);
 498   /* free trash */
 499   if (trash)
 500     {
 501       const gsize chunk_size = SLAB_CHUNK_SIZE (allocator, ix);
 502       g_mutex_lock (allocator->slab_mutex);
 503       while (trash)
 504         {
 505           current = trash;
 506           trash = magazine_chain_prev (current);
 507           magazine_chain_prev (current) = NULL; /* clear special field */
 508           while (current)
 509             {
 510               ChunkLink *chunk = magazine_chain_pop_head (&current);
 511               slab_allocator_free_chunk (chunk_size, chunk);
 512             }
 513         }
 514       g_mutex_unlock (allocator->slab_mutex);
 515     }
 516 }
 517
 518 static void
 519 magazine_cache_push_magazine (guint      ix,
 520                               ChunkLink *magazine_chunks,
 521                               gsize      count) /* must be >= MIN_MAGAZINE_SIZE */
 522 {
 523   ChunkLink *current = magazine_chain_prepare_fields (magazine_chunks);
 524   ChunkLink *next, *prev;
 525   g_mutex_lock (allocator->magazine_mutex);
 526   /* add magazine at head */
 527   next = allocator->magazines[ix];
 528   if (next)
 529     prev = magazine_chain_prev (next);
 530   else
 531     next = prev = current;
 532   magazine_chain_next (prev) = current;
 533   magazine_chain_prev (next) = current;
 534   magazine_chain_prev (current) = prev;
 535   magazine_chain_next (current) = next;
 536   magazine_chain_count (current) = (gpointer) count;
 537   /* stamp magazine */
 538   magazine_cache_update_stamp();
 539   magazine_chain_stamp (current) = (gpointer) allocator->last_stamp;
 540   allocator->magazines[ix] = current;
 541   /* free old magazines beyond a certain threshold */
 542   magazine_cache_trim (allocator, ix, allocator->last_stamp);
 543   /* g_mutex_unlock (allocator->mutex); was done by magazine_cache_trim() */
 544 }
 545
 546 static ChunkLink*
 547 magazine_cache_pop_magazine (guint  ix,
 548                              gsize *countp)
 549 {
 550   g_mutex_lock_a (allocator->magazine_mutex, &allocator->contention_counters[ix]);
 551   if (!allocator->magazines[ix])
 552     {
 553       guint magazine_threshold = allocator_get_magazine_threshold (allocator, ix);
 554       gsize i, chunk_size = SLAB_CHUNK_SIZE (allocator, ix);
 555       ChunkLink *current = NULL;
 556       g_mutex_unlock (allocator->magazine_mutex);
 557       g_mutex_lock (allocator->slab_mutex);
 558       for (i = 0; i < magazine_threshold; i++)
 559         {
 560           ChunkLink *chunk = slab_allocator_alloc_chunk (chunk_size);
 561           chunk->data = NULL;
 562           chunk->next = current;
 563           current = chunk;
 564         }
 565       g_mutex_unlock (allocator->slab_mutex);
 566       *countp = i;
 567       return current;
 568     }
 569   else
 570     {
 571       ChunkLink *current = allocator->magazines[ix];
 572       ChunkLink *prev = magazine_chain_prev (current);
 573       ChunkLink *next = magazine_chain_next (current);
 574       /* unlink */
 575       magazine_chain_next (prev) = next;
 576       magazine_chain_prev (next) = prev;
 577       allocator->magazines[ix] = next == current ? NULL : next;
 578       g_mutex_unlock (allocator->magazine_mutex);
 579       /* clear special fields and hand out */
 580       *countp = (gsize) magazine_chain_count (current);
 581       magazine_chain_prev (current) = NULL;
 582       magazine_chain_next (current) = NULL;
 583       magazine_chain_count (current) = NULL;
 584       magazine_chain_stamp (current) = NULL;
 585       return current;
 586     }
 587 }
 588
 589 /* --- thread magazines --- */
 590 static void
 591 private_thread_memory_cleanup (gpointer data)
 592 {
 593   ThreadMemory *tmem = data;
 594   const guint n_magazines = MAX_SLAB_INDEX (allocator);
 595   guint ix;
 596   for (ix = 0; ix < n_magazines; ix++)
 597     {
 598       Magazine *mags[2];
 599       guint j;
 600       mags[0] = &tmem->magazine1[ix];
 601       mags[1] = &tmem->magazine2[ix];
 602       for (j = 0; j < 2; j++)
 603         {
 604           Magazine *mag = mags[j];
 605           if (mag->count >= MIN_MAGAZINE_SIZE)
 606             magazine_cache_push_magazine (ix, mag->chunks, mag->count);
 607           else
 608             {
 609               const gsize chunk_size = SLAB_CHUNK_SIZE (allocator, ix);
 610               g_mutex_lock (allocator->slab_mutex);
 611               while (mag->chunks)
 612                 {
 613                   ChunkLink *chunk = magazine_chain_pop_head (&mag->chunks);
 614                   slab_allocator_free_chunk (chunk_size, chunk);
 615                 }
 616               g_mutex_unlock (allocator->slab_mutex);
 617             }
 618         }
 619     }
 620   g_free (tmem);
 621 }
 622
 623 static void
 624 thread_memory_magazine1_reload (ThreadMemory *tmem,
 625                                 guint         ix)
 626 {
 627   Magazine *mag = &tmem->magazine1[ix];
 628   g_assert (mag->chunks == NULL); /* ensure that we may reset mag->count */
 629   mag->count = 0;
 630   mag->chunks = magazine_cache_pop_magazine (ix, &mag->count);
 631 }
 632
 633 static void
 634 thread_memory_magazine2_unload (ThreadMemory *tmem,
 635                                 guint         ix)
 636 {
 637   Magazine *mag = &tmem->magazine2[ix];
 638   magazine_cache_push_magazine (ix, mag->chunks, mag->count);
 639   mag->chunks = NULL;
 640   mag->count = 0;
 641 }
 642
 643 static inline void
 644 thread_memory_swap_magazines (ThreadMemory *tmem,
 645                               guint         ix)
 646 {
 647   Magazine xmag = tmem->magazine1[ix];
 648   tmem->magazine1[ix] = tmem->magazine2[ix];
 649   tmem->magazine2[ix] = xmag;
 650 }
 651
 652 static inline gboolean
 653 thread_memory_magazine1_is_empty (ThreadMemory *tmem,
 654                                   guint         ix)
 655 {
 656   return tmem->magazine1[ix].chunks == NULL;
 657 }
 658
 659 static inline gboolean
 660 thread_memory_magazine2_is_full (ThreadMemory *tmem,
 661                                  guint         ix)
 662 {
 663   return tmem->magazine2[ix].count >= allocator_get_magazine_threshold (allocator, ix);
 664 }
 665
 666 static inline gpointer
 667 thread_memory_magazine1_alloc (ThreadMemory *tmem,
 668                                guint         ix)
 669 {
 670   Magazine *mag = &tmem->magazine1[ix];
 671   ChunkLink *chunk = magazine_chain_pop_head (&mag->chunks);
 672   if (G_LIKELY (mag->count > 0))
 673     mag->count--;
 674   return chunk;
 675 }
 676
 677 static inline void
 678 thread_memory_magazine2_free (ThreadMemory *tmem,
 679                               guint         ix,
 680                               gpointer      mem)
 681 {
 682   Magazine *mag = &tmem->magazine2[ix];
 683   ChunkLink *chunk = mem;
 684   chunk->data = NULL;
 685   chunk->next = mag->chunks;
 686   mag->chunks = chunk;
 687   mag->count++;
 688 }
 689
 690 /* --- API functions --- */
 691 gpointer
 692 g_slice_alloc (gsize mem_size)
 693 {
 694   gsize chunk_size;
 695   gpointer mem;
 696   guint acat;
 697   chunk_size = P2ALIGN (mem_size);
 698   acat = allocator_categorize (chunk_size);
 699   if (G_LIKELY (acat == 1))     /* allocate through magazine layer */
 700     {
 701       ThreadMemory *tmem = thread_memory_from_self();
 702       guint ix = SLAB_INDEX (allocator, chunk_size);
 703       if (G_UNLIKELY (thread_memory_magazine1_is_empty (tmem, ix)))
 704         {
 705           thread_memory_swap_magazines (tmem, ix);
 706           if (G_UNLIKELY (thread_memory_magazine1_is_empty (tmem, ix)))
 707             thread_memory_magazine1_reload (tmem, ix);
 708         }
 709       mem = thread_memory_magazine1_alloc (tmem, ix);
 710     }
 711   else if (acat == 2)           /* allocate through slab allocator */
 712     {
 713       g_mutex_lock (allocator->slab_mutex);
 714       mem = slab_allocator_alloc_chunk (chunk_size);
 715       g_mutex_unlock (allocator->slab_mutex);
 716     }
 717   else                          /* delegate to system malloc */
 718     mem = g_malloc (mem_size);
 719   return mem;
 720 }
 721
 722 gpointer
 723 g_slice_alloc0 (gsize mem_size)
 724 {
 725   gpointer mem = g_slice_alloc (mem_size);
 726   if (mem)
 727     memset (mem, 0, mem_size);
 728   return mem;
 729 }
 730
 731 void
 732 g_slice_free1 (gsize    mem_size,
 733                gpointer mem_block)
 734 {
 735   gsize chunk_size = P2ALIGN (mem_size);
 736   guint acat = allocator_categorize (chunk_size);
 737   if (G_UNLIKELY (!mem_block))
 738     /* pass */;
 739   else if (G_LIKELY (acat == 1))        /* allocate through magazine layer */
 740     {
 741       ThreadMemory *tmem = thread_memory_from_self();
 742       guint ix = SLAB_INDEX (allocator, chunk_size);
 743       if (G_UNLIKELY (thread_memory_magazine2_is_full (tmem, ix)))
 744         {
 745           thread_memory_swap_magazines (tmem, ix);
 746           if (G_UNLIKELY (thread_memory_magazine2_is_full (tmem, ix)))
 747             thread_memory_magazine2_unload (tmem, ix);
 748         }
 749       thread_memory_magazine2_free (tmem, ix, mem_block);
 750     }
 751   else if (acat == 2)                   /* allocate through slab allocator */
 752     {
 753       g_mutex_lock (allocator->slab_mutex);
 754       slab_allocator_free_chunk (chunk_size, mem_block);
 755       g_mutex_unlock (allocator->slab_mutex);
 756     }
 757   else                          /* delegate to system malloc */
 758     g_free (mem_block);
 759 }
 760
 761 void
 762 g_slice_free_chain (gsize    mem_size,
 763                     gpointer mem_chain,
 764                     gsize    next_offset)
 765 {
 766   GSList *slice = mem_chain;
 767   g_return_if_fail (next_offset == G_STRUCT_OFFSET (GSList, next));
 768   g_return_if_fail (mem_size >= sizeof (GSList));
 769   while (slice)
 770     {
 771       GSList *current = slice;
 772       slice = slice->next;
 773       g_slice_free1 (mem_size, current);
 774     }
 775   /* while the thread magazines and the magazine cache are implemented so that
 776    * they can easily be extended to allow for free lists containing more free
 777    * lists for the first level nodes, which would allow O(1) freeing in this
 778    * function, the benefit of such an extension is questionable, because:
 779    * - the magazine size counts will become mere lower bounds which confuses
 780    *   the code adapting to lock contention;
 781    * - freeing a single node to the thread magazines is very fast, so this
 782    *   O(list_length) operation is multiplied by a fairly small factor;
 783    * - memory usage histograms on larger applications seem to indicate that
 784    *   the amount of released multi node lists is negligible in comparison
 785    *   to single node releases.
 786    */
 787 }
 788
 789 /* --- single page allocator --- */
 790 static void
 791 allocator_slab_stack_push (Allocator *allocator,
 792                            guint      ix,
 793                            SlabInfo  *sinfo)
 794 {
 795   /* insert slab at slab ring head */
 796   if (!allocator->slab_stack[ix])
 797     {
 798       sinfo->next = sinfo;
 799       sinfo->prev = sinfo;
 800     }
 801   else
 802     {
 803       SlabInfo *next = allocator->slab_stack[ix], *prev = next->prev;
 804       next->prev = sinfo;
 805       prev->next = sinfo;
 806       sinfo->next = next;
 807       sinfo->prev = prev;
 808     }
 809   allocator->slab_stack[ix] = sinfo;
 810 }
 811
 812 static void
 813 allocator_add_slab (Allocator *allocator,
 814                     guint      ix,
 815                     gsize      chunk_size)
 816 {
 817   SlabInfo *sinfo;
 818   gsize padding, n_chunks, color = 0;
 819   gsize page_size = SLAB_PAGE_SIZE (allocator, chunk_size);
 820   /* allocate 1 page for the chunks and the slab */
 821   gpointer aligned_memory = allocator_memalign (page_size, page_size - NATIVE_MALLOC_PADDING);
 822   guint8 *mem = aligned_memory;
 823   if (!mem)
 824     g_error ("%s: failed to allocate %lu bytes: %s", "GSlicedMemory", (gulong) (page_size - NATIVE_MALLOC_PADDING), g_strerror (errno));
 825   /* mask page adress */
 826   gsize addr = ((gsize) mem / page_size) * page_size;
 827   /* assert alignment */
 828   g_assert (aligned_memory == (gpointer) addr);
 829   /* basic slab info setup */
 830   sinfo = (SlabInfo*) (mem + page_size - SLAB_INFO_SIZE);
 831   sinfo->n_allocated = 0;
 832   sinfo->chunks = NULL;
 833   /* figure cache colorization */
 834   n_chunks = ((guint8*) sinfo - mem) / chunk_size;
 835   padding = ((guint8*) sinfo - mem) - n_chunks * chunk_size;
 836   if (padding)
 837     {
 838       color = (allocator->color_accu * P2ALIGNMENT) % padding;
 839       allocator->color_accu += 1;       /* alternatively: + 0x7fffffff */
 840     }
 841   /* add chunks to free list */
 842   ChunkLink *chunk = (ChunkLink*) (mem + color);
 843   guint i;
 844   sinfo->chunks = chunk;
 845   for (i = 0; i < n_chunks - 1; i++)
 846     {
 847       chunk->next = (ChunkLink*) ((guint8*) chunk + chunk_size);
 848       chunk = chunk->next;
 849     }
 850   chunk->next = NULL;   /* last chunk */
 851   /* add slab to slab ring */
 852   allocator_slab_stack_push (allocator, ix, sinfo);
 853 }
 854
 855 static gpointer
 856 slab_allocator_alloc_chunk (gsize chunk_size)
 857 {
 858   guint ix = SLAB_INDEX (allocator, chunk_size);
 859   /* ensure non-empty slab */
 860   if (!allocator->slab_stack[ix] || !allocator->slab_stack[ix]->chunks)
 861     allocator_add_slab (allocator, ix, chunk_size);
 862   /* allocate chunk */
 863   ChunkLink *chunk = allocator->slab_stack[ix]->chunks;
 864   allocator->slab_stack[ix]->chunks = chunk->next;
 865   allocator->slab_stack[ix]->n_allocated++;
 866   /* rotate empty slabs */
 867   if (!allocator->slab_stack[ix]->chunks)
 868     allocator->slab_stack[ix] = allocator->slab_stack[ix]->next;
 869   return chunk;
 870 }
 871
 872 static void
 873 slab_allocator_free_chunk (gsize    chunk_size,
 874                            gpointer mem)
 875 {
 876   guint ix = SLAB_INDEX (allocator, chunk_size);
 877   gsize page_size = SLAB_PAGE_SIZE (allocator, chunk_size);
 878   gsize addr = ((gsize) mem / page_size) * page_size;
 879   /* mask page adress */
 880   guint8 *page = (guint8*) addr;
 881   SlabInfo *sinfo = (SlabInfo*) (page + page_size - SLAB_INFO_SIZE);
 882   /* assert valid chunk count */
 883   g_assert (sinfo->n_allocated > 0);
 884   /* add chunk to free list */
 885   gboolean was_empty = sinfo->chunks == NULL;
 886   ChunkLink *chunk = (ChunkLink*) mem;
 887   chunk->next = sinfo->chunks;
 888   sinfo->chunks = chunk;
 889   sinfo->n_allocated--;
 890   /* keep slab ring partially sorted, empty slabs at end */
 891   if (was_empty)
 892     {
 893       /* unlink slab */
 894       SlabInfo *next = sinfo->next, *prev = sinfo->prev;
 895       next->prev = prev;
 896       prev->next = next;
 897       if (allocator->slab_stack[ix] == sinfo)
 898         allocator->slab_stack[ix] = next == sinfo ? NULL : next;
 899       /* insert slab at head */
 900       allocator_slab_stack_push (allocator, ix, sinfo);
 901     }
 902   /* eagerly free complete unused slabs */
 903   if (!sinfo->n_allocated)
 904     {
 905       /* unlink slab */
 906       SlabInfo *next = sinfo->next, *prev = sinfo->prev;
 907       next->prev = prev;
 908       prev->next = next;
 909       if (allocator->slab_stack[ix] == sinfo)
 910         allocator->slab_stack[ix] = next == sinfo ? NULL : next;
 911       /* free slab */
 912       allocator_memfree (page_size, page);
 913     }
 914 }
 915
 916 /* --- memalign implementation --- */
 917 #include <malloc.h>             /* memalign() */
 918
 919 /* from config.h:
 920  * define HAVE_POSIX_MEMALIGN     1     // if free(posix_memalign(3)) works, <stdlib.h>
 921  * define HAVE_MEMALIGN           1     // if free(memalign(3)) works, <malloc.h>
 922  * define HAVE_VALLOC             1     // if free(valloc(3)) works, <stdlib.h> or <malloc.h>
 923  * if none is provided, we implement malloc(3)-based alloc-only page alignment
 924  */
 925
 926 #if !(HAVE_POSIX_MEMALIGN || HAVE_MEMALIGN || HAVE_VALLOC)
 927 static GTrashStack *compat_valloc_trash = NULL;
 928 #endif
 929
 930 static gpointer
 931 allocator_memalign (gsize alignment,
 932                     gsize memsize)
 933 {
 934   gpointer aligned_memory = NULL;
 935   gint err = ENOMEM;
 936 #if     HAVE_POSIX_MEMALIGN
 937   err = posix_memalign (&aligned_memory, alignment, memsize);
 938 #elif   HAVE_MEMALIGN
 939   errno = 0;
 940   aligned_memory = memalign (alignment, memsize);
 941   err = errno;
 942 #elif   HAVE_VALLOC
 943   errno = 0;
 944   aligned_memory = valloc (memsize);
 945   err = errno;
 946 #else
 947   /* simplistic non-freeing page allocator */
 948   g_assert (alignment == sys_page_size);
 949   g_assert (memsize <= sys_page_size);
 950   if (!compat_valloc_trash)
 951     {
 952       const guint n_pages = 16;
 953       guint8 *mem = malloc (n_pages * sys_page_size);
 954       err = errno;
 955       if (mem)
 956         {
 957           gint i = n_pages;
 958           guint8 *amem = (guint8*) ALIGN ((gsize) mem, sys_page_size);
 959           if (amem != mem)
 960             i--;        /* mem wasn't page aligned */
 961           while (--i >= 0)
 962             g_trash_stack_push (&compat_valloc_trash, amem + i * sys_page_size);
 963         }
 964     }
 965   aligned_memory = g_trash_stack_pop (&compat_valloc_trash);
 966 #endif
 967   if (!aligned_memory)
 968     errno = err;
 969   return aligned_memory;
 970 }
 971
 972 static void
 973 allocator_memfree (gsize    memsize,
 974                    gpointer mem)
 975 {
 976 #if     HAVE_POSIX_MEMALIGN || HAVE_MEMALIGN || HAVE_VALLOC
 977   free (mem);
 978 #else
 979   g_assert (memsize <= sys_page_size);
 980   g_trash_stack_push (&compat_valloc_trash, mem);
 981 #endif
 982 }
 983
 984 #define __G_SLICE_C__
 985 #include "galiasdef.c"