src/xbt/mallocator.c

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