src/xbt/mallocator.c

   1 /* mallocator - recycle objects to avoid malloc() / free()                  */
   2
   3 /* Copyright (c) 2006-2011. The SimGrid Team.
   4  * All rights reserved.                                                     */
   5
   6 /* This program is free software; you can redistribute it and/or modify it
   7  * under the terms of the license (GNU LGPL) which comes with this package. */
   8
   9 #include "xbt/mallocator.h"
  10 #include "xbt/asserts.h"
  11 #include "xbt/sysdep.h"
  12 #include "mc/mc.h" /* kill mallocators when model-checking is enabled */
  13 #include "mallocator_private.h"
  14
  15 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(xbt_mallocator, xbt, "Mallocators");
  16
  17 /** Implementation note on the mallocators:
  18  *
  19  * Mallocators and memory mess introduced by model-checking do not mix well
  20  * together: the mallocator will give standard memory when we are using raw
  21  * memory (so these blocks are killed on restore) and the contrary (so these
  22  * blocks will leak across restores).
  23  *
  24  * In addition, model-checking is activated when the command-line arguments
  25  * are parsed, at the beginning of main, while most of the mallocators are
  26  * created during the constructor functions launched from xbt_preinit, before
  27  * the beginning of the main function.
  28  *
  29  * We want the code as fast as possible when they are active while we can deal
  30  * with a little slow-down when they are inactive. So we start the mallocators
  31  * as inactive. When they are so, they check at each use whether they should
  32  * switch to the fast active mode or should stay in inactive mode.
  33  * Finally, we give external elements a way to switch them
  34  * all to the active mode (through xbt_mallocator_initialization_is_done).
  35  *
  36  * This design avoids to store all mallocators somewhere for later conversion,
  37  * which would be hard to achieve provided that all our data structures use
  38  * some mallocators internally...
  39  */
  40
  41 /* Value != 0 when the framework configuration is done.  Value > 1 if the
  42  * mallocators should be protected from concurrent accesses.  */
  43 static int initialization_done = 0;
  44
  45 static XBT_INLINE void lock_create(xbt_mallocator_t m)
  46 {
  47   m->lock = 0;
  48 }
  49
  50 static XBT_INLINE void lock_destroy(xbt_mallocator_t m)
  51 {
  52 }
  53
  54 static XBT_INLINE void lock_acquire(xbt_mallocator_t m)
  55 {
  56   if (initialization_done > 1) {
  57     int *lock = &m->lock;
  58     while (__sync_lock_test_and_set(lock, 1))
  59       /* nop */;
  60   }
  61 }
  62
  63 static XBT_INLINE void lock_release(xbt_mallocator_t m)
  64 {
  65   if (initialization_done > 1)
  66     __sync_lock_release(&m->lock);
  67 }
  68
  69 /**
  70  * This function must be called once the framework configuration is done. If not,
  71  * mallocators will never get used. Check the implementation notes in
  72  * src/xbt/mallocator.c for the justification of this.
  73  *
  74  * For example, surf_config uses this function to tell to the mallocators that
  75  * the simgrid
  76  * configuration is now finished and that it can create them if not done yet */
  77 void xbt_mallocator_initialization_is_done(int protect)
  78 {
  79   initialization_done = protect ? 2 : 1;
  80 }
  81
  82 /** used by the module to know if it's time to activate the mallocators yet */
  83 static XBT_INLINE int xbt_mallocator_is_active(void) {
  84 #if MALLOCATOR_COMPILED_IN
  85   return initialization_done && !MC_is_active();
  86 #else
  87   return 0;
  88 #endif
  89 }
  90
  91 /**
  92  * \brief Constructor
  93  * \param size size of the internal stack: number of objects the mallocator
  94  * will be able to store
  95  * \param new_f function to allocate a new object of your datatype, called
  96  * in \a xbt_mallocator_get() when the mallocator is empty
  97  * \param free_f function to free an object of your datatype, called
  98  * in \a xbt_mallocator_release() when the stack is full, and when
  99  * the mallocator is freed.
 100  * \param reset_f function to reinitialise an object of your datatype, called
 101  * when you extract an object from the mallocator (can be NULL)
 102  *
 103  * Create and initialize a new mallocator for a given datatype.
 104  *
 105  * \return pointer to the created mallocator
 106  * \see xbt_mallocator_free()
 107  */
 108 xbt_mallocator_t xbt_mallocator_new(int size,
 109                                     pvoid_f_void_t new_f,
 110                                     void_f_pvoid_t free_f,
 111                                     void_f_pvoid_t reset_f)
 112 {
 113   xbt_mallocator_t m;
 114
 115   xbt_assert(size > 0, "size must be positive");
 116   xbt_assert(new_f != NULL && free_f != NULL, "invalid parameter");
 117
 118   m = xbt_new0(s_xbt_mallocator_t, 1);
 119   XBT_VERB("Create mallocator %p (%s)",
 120            m, xbt_mallocator_is_active() ? "enabled" : "disabled");
 121   m->current_size = 0;
 122   m->new_f = new_f;
 123   m->free_f = free_f;
 124   m->reset_f = reset_f;
 125   m->max_size = size;
 126
 127   return m;
 128 }
 129
 130 /** \brief Destructor
 131  * \param m the mallocator you want to destroy
 132  *
 133  * Destroy the mallocator and all its data. The function
 134  * free_f is called on each object in the mallocator.
 135  *
 136  * \see xbt_mallocator_new()
 137  */
 138 void xbt_mallocator_free(xbt_mallocator_t m)
 139 {
 140
 141   int i;
 142   xbt_assert(m != NULL, "Invalid parameter");
 143
 144   XBT_VERB("Frees mallocator %p (size:%d/%d)", m, m->current_size,
 145         m->max_size);
 146   for (i = 0; i < m->current_size; i++) {
 147     m->free_f(m->objects[i]);
 148   }
 149   xbt_free(m->objects);
 150   lock_destroy(m);
 151   xbt_free(m);
 152 }
 153
 154 /**
 155  * \brief Extract an object from a mallocator
 156  * \param m a mallocator
 157  *
 158  * Remove an object from the mallocator and return it.
 159  * This function is designed to be used instead of malloc().
 160  * If the mallocator is not empty, an object is
 161  * extracted from the mallocator and no malloc is done.
 162  *
 163  * If the mallocator is empty, a new object is created,
 164  * by calling the function new_f().
 165  *
 166  * In both cases, the function reset_f() (if defined) is called on the object.
 167  *
 168  * \see xbt_mallocator_release()
 169  */
 170 void *xbt_mallocator_get(xbt_mallocator_t m)
 171 {
 172   void *object;
 173
 174   if (m->objects != NULL) { // this mallocator is active, stop thinking and go for it!
 175     lock_acquire(m);
 176     if (m->current_size <= 0) {
 177       /* No object is ready yet. Create a bunch of them to try to group the
 178        * mallocs on the same memory pages (to help the cache lines) */
 179
 180       /* XBT_DEBUG("Create a new object for mallocator %p (size:%d/%d)", */
 181       /*           m, m->current_size, m->max_size); */
 182       int i;
 183       int amount = MIN(m->max_size / 2, 1000);
 184       for (i = 0; i < amount; i++)
 185         m->objects[i] = m->new_f();
 186       m->current_size = amount;
 187     }
 188
 189     /* there is at least an available object, now */
 190     /* XBT_DEBUG("Reuse an old object for mallocator %p (size:%d/%d)", */
 191     /*           m, m->current_size, m->max_size); */
 192     object = m->objects[--m->current_size];
 193     lock_release(m);
 194   } else {
 195     if (xbt_mallocator_is_active()) {
 196       // We have to switch this mallocator from inactive to active (and then get an object)
 197       m->objects = xbt_new0(void *, m->max_size);
 198       lock_create(m);
 199       return xbt_mallocator_get(m);
 200     } else {
 201       object = m->new_f();
 202     }
 203   }
 204
 205   if (m->reset_f)
 206     m->reset_f(object);
 207   return object;
 208 }
 209
 210 /** \brief Push an object into a mallocator
 211  * \param m a mallocator
 212  * \param object an object you don't need anymore
 213  *
 214  * Push into the mallocator an object you don't need anymore.
 215  * This function is designed to be used instead of free().
 216  * If the mallocator is not full, your object if stored into
 217  * the mallocator and no free is done.
 218  * If the mallocator is full, the object is freed by calling
 219  * the function free_f().
 220  *
 221  * \see xbt_mallocator_get()
 222  */
 223 void xbt_mallocator_release(xbt_mallocator_t m, void *object)
 224 {
 225   if (m->objects != NULL) { // Go for it
 226     lock_acquire(m);
 227     if (m->current_size < m->max_size) {
 228       /* there is enough place to push the object */
 229       /* XBT_DEBUG
 230          ("Store deleted object in mallocator %p for further use (size:%d/%d)",
 231          m, m->current_size, m->max_size); */
 232       m->objects[m->current_size++] = object;
 233       lock_release(m);
 234     } else {
 235       lock_release(m);
 236       /* otherwise we don't have a choice, we must free the object */
 237       /* XBT_DEBUG("Free deleted object: mallocator %p is full (size:%d/%d)", m,
 238          m->current_size, m->max_size); */
 239       m->free_f(object);
 240     }
 241   } else {
 242     if (xbt_mallocator_is_active()) {
 243       // We have to switch this mallocator from inactive to active (and then store that object)
 244       m->objects = xbt_new0(void *, m->max_size);
 245       lock_create(m);
 246       xbt_mallocator_release(m,object);
 247     } else {
 248       m->free_f(object);
 249     }
 250   }
 251 }