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
  42 static int initialization_done = 0;
  43 /**
  44  * This function must be called once the framework configuration is done. If not,
  45  * mallocators will never get used. Check the implementation notes in
  46  * src/xbt/mallocator.c for the justification of this.
  47  *
  48  * For example, surf_config uses this function to tell to the mallocators that
  49  * the simgrid
  50  * configuration is now finished and that it can create them if not done yet */
  51 void xbt_mallocator_initialization_is_done(void) {
  52   initialization_done = 1;
  53 }
  54
  55 /** used by the module to know if it's time to activate the mallocators yet */
  56 static XBT_INLINE int xbt_mallocator_is_active(void) {
  57 #ifndef MALLOCATOR_COMPILED_IN
  58   return 0;
  59 #else
  60   return initialization_done && !MC_is_active();
  61 #endif
  62 }
  63
  64 /**
  65  * \brief Constructor
  66  * \param size size of the internal stack: number of objects the mallocator
  67  * will be able to store
  68  * \param new_f function to allocate a new object of your datatype, called
  69  * in \a xbt_mallocator_get() when the mallocator is empty
  70  * \param free_f function to free an object of your datatype, called
  71  * in \a xbt_mallocator_release() when the stack is full, and when
  72  * the mallocator is freed.
  73  * \param reset_f function to reinitialise an object of your datatype, called
  74  * when you extract an object from the mallocator (can be NULL)
  75  *
  76  * Create and initialize a new mallocator for a given datatype.
  77  *
  78  * \return pointer to the created mallocator
  79  * \see xbt_mallocator_free()
  80  */
  81 xbt_mallocator_t xbt_mallocator_new(int size,
  82                                     pvoid_f_void_t new_f,
  83                                     void_f_pvoid_t free_f,
  84                                     void_f_pvoid_t reset_f)
  85 {
  86   xbt_mallocator_t m;
  87
  88   xbt_assert(size > 0, "size must be positive");
  89   xbt_assert(new_f != NULL && free_f != NULL, "invalid parameter");
  90
  91   m = xbt_new0(s_xbt_mallocator_t, 1);
  92   XBT_VERB("Create mallocator %p (%s)",
  93            m, xbt_mallocator_is_active() ? "enabled" : "disabled");
  94   m->current_size = 0;
  95   m->new_f = new_f;
  96   m->free_f = free_f;
  97   m->reset_f = reset_f;
  98   m->max_size = size;
  99
 100   return m;
 101 }
 102
 103 /** \brief Destructor
 104  * \param m the mallocator you want to destroy
 105  *
 106  * Destroy the mallocator and all its data. The function
 107  * free_f is called on each object in the mallocator.
 108  *
 109  * \see xbt_mallocator_new()
 110  */
 111 void xbt_mallocator_free(xbt_mallocator_t m)
 112 {
 113
 114   int i;
 115   xbt_assert(m != NULL, "Invalid parameter");
 116
 117   XBT_VERB("Frees mallocator %p (size:%d/%d)", m, m->current_size,
 118         m->max_size);
 119   for (i = 0; i < m->current_size; i++) {
 120     m->free_f(m->objects[i]);
 121   }
 122   xbt_free(m->objects);
 123   xbt_os_mutex_destroy(m->mutex);
 124   xbt_free(m);
 125 }
 126
 127 /**
 128  * \brief Extract an object from a mallocator
 129  * \param m a mallocator
 130  *
 131  * Remove an object from the mallocator and return it.
 132  * This function is designed to be used instead of malloc().
 133  * If the mallocator is not empty, an object is
 134  * extracted from the mallocator and no malloc is done.
 135  *
 136  * If the mallocator is empty, a new object is created,
 137  * by calling the function new_f().
 138  *
 139  * In both cases, the function reset_f() (if defined) is called on the object.
 140  *
 141  * \see xbt_mallocator_release()
 142  */
 143 void *xbt_mallocator_get(xbt_mallocator_t m)
 144 {
 145   void *object;
 146
 147   if (m->objects != NULL) { // this mallocator is active, stop thinking and go for it!
 148     xbt_os_mutex_acquire(m->mutex);
 149     if (m->current_size <= 0) {
 150       /* No object is ready yet. Create a bunch of them to try to group the
 151        * mallocs on the same memory pages (to help the cache lines) */
 152
 153       /* XBT_DEBUG("Create a new object for mallocator %p (size:%d/%d)", */
 154       /*           m, m->current_size, m->max_size); */
 155       int i;
 156       int amount = MIN(m->max_size / 2, 1000);
 157       for (i = 0; i < amount; i++)
 158         m->objects[i] = m->new_f();
 159       m->current_size = amount;
 160     }
 161
 162     /* there is at least an available object, now */
 163     /* XBT_DEBUG("Reuse an old object for mallocator %p (size:%d/%d)", */
 164     /*           m, m->current_size, m->max_size); */
 165     object = m->objects[--m->current_size];
 166     xbt_os_mutex_release(m->mutex);
 167   } else {
 168     if (xbt_mallocator_is_active()) {
 169       // We have to switch this mallocator from inactive to active (and then get an object)
 170       m->objects = xbt_new0(void *, m->max_size);
 171       m->mutex = xbt_os_mutex_init();
 172       return xbt_mallocator_get(m);
 173     } else {
 174       object = m->new_f();
 175     }
 176   }
 177
 178   if (m->reset_f)
 179     m->reset_f(object);
 180   return object;
 181 }
 182
 183 /** \brief Push an object into a mallocator
 184  * \param m a mallocator
 185  * \param object an object you don't need anymore
 186  *
 187  * Push into the mallocator an object you don't need anymore.
 188  * This function is designed to be used instead of free().
 189  * If the mallocator is not full, your object if stored into
 190  * the mallocator and no free is done.
 191  * If the mallocator is full, the object is freed by calling
 192  * the function free_f().
 193  *
 194  * \see xbt_mallocator_get()
 195  */
 196 void xbt_mallocator_release(xbt_mallocator_t m, void *object)
 197 {
 198   if (m->objects != NULL) { // Go for it
 199     xbt_os_mutex_acquire(m->mutex);
 200     if (m->current_size < m->max_size) {
 201       /* there is enough place to push the object */
 202       /* XBT_DEBUG
 203          ("Store deleted object in mallocator %p for further use (size:%d/%d)",
 204          m, m->current_size, m->max_size); */
 205       m->objects[m->current_size++] = object;
 206       xbt_os_mutex_release(m->mutex);
 207     } else {
 208       xbt_os_mutex_release(m->mutex);
 209       /* otherwise we don't have a choice, we must free the object */
 210       /* XBT_DEBUG("Free deleted object: mallocator %p is full (size:%d/%d)", m,
 211          m->current_size, m->max_size); */
 212       m->free_f(object);
 213     }
 214   } else {
 215     if (xbt_mallocator_is_active()) {
 216       // We have to switch this mallocator from inactive to active (and then store that object)
 217       m->objects = xbt_new0(void *, m->max_size);
 218       m->mutex = xbt_os_mutex_init();
 219       xbt_mallocator_release(m,object);
 220     } else {
 221       m->free_f(object);
 222     }
 223   }
 224 }