src/xbt/mallocator.c

   1 /* mallocator - recycle objects to avoid malloc() / free()                  */
   2
   3 /* Copyright (c) 2006 Christophe Thiery. 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 "xbt/asserts.h"
  10 #include "xbt/sysdep.h"
  11 #include "mallocator_private.h"
  12
  13 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(xbt_mallocator,xbt,"Mallocators");
  14
  15 /**
  16  * \brief Constructor
  17  * \param size size of the internal stack: number of objects the mallocator
  18  * will be able to store
  19  * \param new_f function to allocate a new object of your datatype, called
  20  * in \a xbt_mallocator_get() when the mallocator is empty
  21  * \param free_f function to free an object of your datatype, called
  22  * in \a xbt_mallocator_release() when the stack is full, and when
  23  * the mallocator is freed.
  24  * \param reset_f function to reinitialise an object of your datatype, called
  25  * when you extract an object from the mallocator
  26  *
  27  * Create and initialize a new mallocator for a given datatype.
  28  *
  29  * \return pointer to the created mallocator
  30  * \see xbt_mallocator_free()
  31  */
  32 xbt_mallocator_t xbt_mallocator_new(int size,
  33                                     pvoid_f_void_t new_f,
  34                                     void_f_pvoid_t free_f,
  35                                     void_f_pvoid_t reset_f) {
  36
  37
  38   xbt_mallocator_t m;
  39
  40   xbt_assert0(size > 0, "size must be positive");
  41   xbt_assert0(new_f != NULL && free_f != NULL && reset_f != NULL,"invalid parameter");
  42
  43   m = xbt_new0(s_xbt_mallocator_t, 1);
  44   DEBUG1("Create mallocator %p",m);
  45
  46   m->objects = xbt_new0(void*, size);
  47   m->max_size = size;
  48   m->current_size = 0;
  49   m->new_f = new_f;
  50   m->free_f = free_f;
  51   m->reset_f = reset_f;
  52
  53   return m;
  54 }
  55
  56 /** \brief Destructor
  57  * \param m the mallocator you want to destroy
  58  *
  59  * Destroy the mallocator and all its data. The function
  60  * free_f is called on each object in the mallocator.
  61  *
  62  * \see xbt_mallocator_new()
  63  */
  64 void xbt_mallocator_free(xbt_mallocator_t m) {
  65
  66   int i;
  67   xbt_assert0(m != NULL, "Invalid parameter");
  68
  69   DEBUG3("Frees mallocator %p (size:%d/%d)",m,m->current_size,m->max_size);
  70   for (i = 0; i < m->current_size; i++) {
  71     (*(m->free_f))(m->objects[i]);
  72   }
  73   xbt_free(m->objects);
  74   xbt_free(m);
  75 }
  76
  77 /**
  78  * \brief Extract an object from a mallocator
  79  * \param m a mallocator
  80  *
  81  * Remove an object from the mallocator and return it.
  82  * This function is designed to be used instead of malloc().
  83  * If the mallocator is not empty, an object is
  84  * extracted from the mallocator and no malloc is done.
  85  *
  86  * If the mallocator is empty, a new object is created,
  87  * by calling the function new_f().
  88  *
  89  * In both cases, the function reset_f() is called on the object.
  90  *
  91  * \see xbt_mallocator_release()
  92  */
  93 void *xbt_mallocator_get(xbt_mallocator_t m) {
  94   void *object;
  95   xbt_assert0(m != NULL, "Invalid parameter");
  96
  97   if (m->current_size > 0) {
  98     /* there is at least an available object */
  99     DEBUG3("Reuse an old object for mallocator %p (size:%d/%d)",m,m->current_size,m->max_size);
 100     object = m->objects[--m->current_size];
 101   }
 102   else {
 103     /* otherwise we must allocate a new object */
 104     DEBUG3("Create a new object for mallocator %p (size:%d/%d)",m,m->current_size,m->max_size);
 105     object = (*(m->new_f))();
 106   }
 107   (*(m->reset_f))(object);
 108   return object;
 109 }
 110
 111 /** \brief Push an object into a mallocator
 112  * \param m a mallocator
 113  * \param object an object you don't need anymore
 114  *
 115  * Push into the mallocator an object you don't need anymore.
 116  * This function is designed to be used instead of free().
 117  * If the mallocator is not full, your object if stored into
 118  * the mallocator and no free is done.
 119  * If the mallocator is full, the object is freed by calling
 120  * the function free_f().
 121  *
 122  * \see xbt_mallocator_get()
 123  */
 124 void xbt_mallocator_release(xbt_mallocator_t m, void *object) {
 125   xbt_assert0(m != NULL && object != NULL, "Invalid parameter");
 126
 127   if (m->current_size < m->max_size) {
 128     /* there is enough place to push the object */
 129     DEBUG3("Store deleted object in mallocator %p for further use (size:%d/%d)",m,m->current_size,m->max_size);
 130     m->objects[m->current_size++] = object;
 131   }
 132   else {
 133     /* otherwise we don't have a choice, we must free the object */
 134     DEBUG3("Free deleted object: mallocator %p is full (size:%d/%d)",m,m->current_size,m->max_size);
 135     (*(m->free_f))(object);
 136   }
 137 }