Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
new option to any SimGrid-based simulator: --cfg=model-check:1 (for now, that's a...
[simgrid.git] / src / xbt / mallocator.c
index 5f16196..93e6a5b 100644 (file)
@@ -1,6 +1,7 @@
 /* mallocator - recycle objects to avoid malloc() / free()                  */
 
-/* Copyright (c) 2006 Christophe Thiery. All rights reserved.               */
+/* Copyright (c) 2006, 2007, 2008, 2009, 2010. The SimGrid Team.
+ * All rights reserved.                                                     */
 
 /* This program is free software; you can redistribute it and/or modify it
  * under the terms of the license (GNU LGPL) which comes with this package. */
@@ -10,6 +11,9 @@
 #include "xbt/sysdep.h"
 #include "mallocator_private.h"
 
+XBT_LOG_NEW_DEFAULT_SUBCATEGORY(xbt_mallocator, xbt, "Mallocators");
+extern int _surf_do_model_check; /* kill mallocators when this is true */
+
 /**
  * \brief Constructor
  * \param size size of the internal stack: number of objects the mallocator
@@ -20,7 +24,7 @@
  * in \a xbt_mallocator_release() when the stack is full, and when
  * the mallocator is freed.
  * \param reset_f function to reinitialise an object of your datatype, called
- * when you extract an object from the mallocator 
+ * when you extract an object from the mallocator
  *
  * Create and initialize a new mallocator for a given datatype.
  *
  * \see xbt_mallocator_free()
  */
 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) {
+                                    pvoid_f_void_t new_f,
+                                    void_f_pvoid_t free_f,
+                                    void_f_pvoid_t reset_f)
+{
 
 
   xbt_mallocator_t m;
 
   xbt_assert0(size > 0, "size must be positive");
-  xbt_assert0(new_f != NULL && free_f != NULL && reset_f != NULL,"invalid parameter");
-
+  xbt_assert0(new_f != NULL && free_f != NULL
+              && reset_f != NULL, "invalid parameter");
+
+  /* Let's force 0 size mallocator! (Dirty hack, blame Martin :) )*/
+
+  /* mallocators and memory mess introduced by model-checking do not mix well together:
+   *   The mallocator will give standard memory when we are using raw memory (so these blocks are killed on restore)
+   *   and the contrary (so these blocks will leak accross restores)
+   */
+  if (_surf_do_model_check)
+    size = 0;
+  
   m = xbt_new0(s_xbt_mallocator_t, 1);
+  VERB1("Create mallocator %p", m);
+  if (XBT_LOG_ISENABLED(xbt_mallocator, xbt_log_priority_verbose))
+    xbt_backtrace_display_current();
 
-  m->objects = xbt_new0(void*, size);
+  m->objects = xbt_new0(void *, _surf_do_model_check?1:size);
   m->max_size = size;
   m->current_size = 0;
   m->new_f = new_f;
@@ -58,14 +76,15 @@ xbt_mallocator_t xbt_mallocator_new(int size,
  *
  * \see xbt_mallocator_new()
  */
-void xbt_mallocator_free(xbt_mallocator_t m) {
+void xbt_mallocator_free(xbt_mallocator_t m)
+{
 
   int i;
   xbt_assert0(m != NULL, "Invalid parameter");
 
-
+  VERB3("Frees mallocator %p (size:%d/%d)", m, m->current_size, m->max_size);
   for (i = 0; i < m->current_size; i++) {
-    m->free_f(m->objects[i]);
+    (*(m->free_f)) (m->objects[i]);
   }
   xbt_free(m->objects);
   xbt_free(m);
@@ -79,29 +98,31 @@ void xbt_mallocator_free(xbt_mallocator_t m) {
  * This function is designed to be used instead of malloc().
  * If the mallocator is not empty, an object is
  * extracted from the mallocator and no malloc is done.
- * 
+ *
  * If the mallocator is empty, a new object is created,
  * by calling the function new_f().
- * 
+ *
  * In both cases, the function reset_f() is called on the object.
  *
  * \see xbt_mallocator_release()
  */
-void *xbt_mallocator_get(xbt_mallocator_t m) {
-
-void *object;
+void *xbt_mallocator_get(xbt_mallocator_t m)
+{
+  void *object;
   xbt_assert0(m != NULL, "Invalid parameter");
 
-
   if (m->current_size > 0) {
     /* there is at least an available object */
+    DEBUG3("Reuse an old object for mallocator %p (size:%d/%d)", m,
+           m->current_size, m->max_size);
     object = m->objects[--m->current_size];
-  }
-  else {
+  } else {
     /* otherwise we must allocate a new object */
-    object = m->new_f();
+    DEBUG3("Create a new object for mallocator %p (size:%d/%d)", m,
+           m->current_size, m->max_size);
+    object = (*(m->new_f)) ();
   }
-  m->reset_f(object);
+  (*(m->reset_f)) (object);
   return object;
 }
 
@@ -118,15 +139,20 @@ void *object;
  *
  * \see xbt_mallocator_get()
  */
-void xbt_mallocator_release(xbt_mallocator_t m, void *object) {
+void xbt_mallocator_release(xbt_mallocator_t m, void *object)
+{
   xbt_assert0(m != NULL && object != NULL, "Invalid parameter");
 
   if (m->current_size < m->max_size) {
     /* there is enough place to push the object */
+    DEBUG3
+      ("Store deleted object in mallocator %p for further use (size:%d/%d)",
+       m, m->current_size, m->max_size);
     m->objects[m->current_size++] = object;
-  }
-  else {
+  } else {
     /* otherwise we don't have a choice, we must free the object */
-    m->free_f(object);
+    DEBUG3("Free deleted object: mallocator %p is full (size:%d/%d)", m,
+           m->current_size, m->max_size);
+    (*(m->free_f)) (object);
   }
 }