src/xbt/mallocator.c

   1 /* mallocator - recycle objects to avoid malloc() / free()                  */
   2
   3 /* Copyright (c) 2006, 2007, 2008, 2009, 2010. 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 /**
  18  * \brief Constructor
  19  * \param size size of the internal stack: number of objects the mallocator
  20  * will be able to store
  21  * \param new_f function to allocate a new object of your datatype, called
  22  * in \a xbt_mallocator_get() when the mallocator is empty
  23  * \param free_f function to free an object of your datatype, called
  24  * in \a xbt_mallocator_release() when the stack is full, and when
  25  * the mallocator is freed.
  26  * \param reset_f function to reinitialise an object of your datatype, called
  27  * when you extract an object from the mallocator
  28  *
  29  * Create and initialize a new mallocator for a given datatype.
  30  *
  31  * \return pointer to the created mallocator
  32  * \see xbt_mallocator_free()
  33  */
  34 xbt_mallocator_t xbt_mallocator_new(int size,
  35                                     pvoid_f_void_t new_f,
  36                                     void_f_pvoid_t free_f,
  37                                     void_f_pvoid_t reset_f)
  38 {
  39
  40
  41   xbt_mallocator_t m;
  42
  43   xbt_assert(size > 0, "size must be positive");
  44   xbt_assert(new_f != NULL && free_f != NULL
  45               && reset_f != NULL, "invalid parameter");
  46
  47   /* Let's force 0 size mallocator! (Dirty hack, blame Martin :) ) */
  48
  49   /* mallocators and memory mess introduced by model-checking do not mix well together:
  50    *   The mallocator will give standard memory when we are using raw memory (so these blocks are killed on restore)
  51    *   and the contrary (so these blocks will leak accross restores)
  52    */
  53   if (MC_IS_ENABLED)
  54     size = 0;
  55
  56   m = xbt_new0(s_xbt_mallocator_t, 1);
  57   XBT_VERB("Create mallocator %p", m);
  58   if (XBT_LOG_ISENABLED(xbt_mallocator, xbt_log_priority_verbose))
  59     xbt_backtrace_display_current();
  60
  61   m->objects = xbt_new0(void *, MC_IS_ENABLED ? 1 : size);
  62   m->max_size = size;
  63   m->current_size = 0;
  64   m->new_f = new_f;
  65   m->free_f = free_f;
  66   m->reset_f = reset_f;
  67
  68   return m;
  69 }
  70
  71 /** \brief Destructor
  72  * \param m the mallocator you want to destroy
  73  *
  74  * Destroy the mallocator and all its data. The function
  75  * free_f is called on each object in the mallocator.
  76  *
  77  * \see xbt_mallocator_new()
  78  */
  79 void xbt_mallocator_free(xbt_mallocator_t m)
  80 {
  81
  82   int i;
  83   xbt_assert(m != NULL, "Invalid parameter");
  84
  85   XBT_VERB("Frees mallocator %p (size:%d/%d)", m, m->current_size,
  86         m->max_size);
  87   for (i = 0; i < m->current_size; i++) {
  88     (*(m->free_f)) (m->objects[i]);
  89   }
  90   xbt_free(m->objects);
  91   xbt_free(m);
  92 }
  93
  94 /**
  95  * \brief Extract an object from a mallocator
  96  * \param m a mallocator
  97  *
  98  * Remove an object from the mallocator and return it.
  99  * This function is designed to be used instead of malloc().
 100  * If the mallocator is not empty, an object is
 101  * extracted from the mallocator and no malloc is done.
 102  *
 103  * If the mallocator is empty, a new object is created,
 104  * by calling the function new_f().
 105  *
 106  * In both cases, the function reset_f() is called on the object.
 107  *
 108  * \see xbt_mallocator_release()
 109  */
 110 void *xbt_mallocator_get(xbt_mallocator_t m)
 111 {
 112   void *object;
 113
 114   if (m->current_size <= 0) {
 115     /* No object is ready yet. Create a bunch of them to try to group the mallocs
 116      *  on the same memory pages (to help the cache lines) */
 117
 118     /* XBT_DEBUG("Create a new object for mallocator %p (size:%d/%d)", m,
 119            m->current_size, m->max_size); */
 120     int i;
 121     int amount=MIN( (m->max_size) /2,1000);
 122     for (i=0;i<amount;i++)
 123       m->objects[i] = (*(m->new_f)) ();
 124     m->current_size=amount;
 125   }
 126
 127   /* there is at least an available object, now */
 128   /* XBT_DEBUG("Reuse an old object for mallocator %p (size:%d/%d)", m,
 129            m->current_size, m->max_size); */
 130   if (MC_IS_ENABLED) /* no mallocator with MC */
 131     object = (*(m->new_f)) ();
 132   else
 133     object = m->objects[--m->current_size];
 134
 135   (*(m->reset_f)) (object);
 136   return object;
 137 }
 138
 139 /** \brief Push an object into a mallocator
 140  * \param m a mallocator
 141  * \param object an object you don't need anymore
 142  *
 143  * Push into the mallocator an object you don't need anymore.
 144  * This function is designed to be used instead of free().
 145  * If the mallocator is not full, your object if stored into
 146  * the mallocator and no free is done.
 147  * If the mallocator is full, the object is freed by calling
 148  * the function free_f().
 149  *
 150  * \see xbt_mallocator_get()
 151  */
 152 void xbt_mallocator_release(xbt_mallocator_t m, void *object)
 153 {
 154   if (m->current_size < m->max_size) {
 155     /* there is enough place to push the object */
 156     /* XBT_DEBUG
 157         ("Store deleted object in mallocator %p for further use (size:%d/%d)",
 158          m, m->current_size, m->max_size); */
 159     m->objects[m->current_size++] = object;
 160   } else {
 161     /* otherwise we don't have a choice, we must free the object */
 162     /* XBT_DEBUG("Free deleted object: mallocator %p is full (size:%d/%d)", m,
 163            m->current_size, m->max_size); */
 164     (*(m->free_f)) (object);
 165   }
 166 }