src/xbt/mallocator.c

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