X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/d772981fd6feca0308c485375de4191d6634658c..6582744db5a014857b7a914815b147e88adead81:/src/xbt/mallocator.c

diff --git a/src/xbt/mallocator.c b/src/xbt/mallocator.c
index ec32f179c5..d5a0a55156 100644
--- a/src/xbt/mallocator.c
+++ b/src/xbt/mallocator.c
@@ -1,7 +1,6 @@
 /* mallocator - recycle objects to avoid malloc() / free()                  */
 
-/* Copyright (c) 2006-2017. The SimGrid Team.
- * All rights reserved.                                                     */
+/* Copyright (c) 2006-2023. 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. */
@@ -13,6 +12,13 @@
 #include "xbt/asserts.h"
 #include "xbt/sysdep.h"
 
+#ifndef MIN
+#define MIN(a, b) ((a) < (b) ? (a) : (b))
+#endif
+#ifndef MAX
+#define MAX(a, b) ((a) > (b) ? (a) : (b))
+#endif
+
 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(xbt_mallocator, xbt, "Mallocators");
 
 /** Implementation note on the mallocators:
@@ -40,13 +46,13 @@ static int initialization_done = 0;
 
 static inline void lock_reset(xbt_mallocator_t m)
 {
-  m->lock = 0;
+  atomic_flag_clear(&m->lock);
 }
 
 static inline void lock_acquire(xbt_mallocator_t m)
 {
   if (initialization_done > 1) {
-    while (__atomic_test_and_set(&m->lock, __ATOMIC_ACQUIRE))
+    while (atomic_flag_test_and_set(&m->lock))
       /* nop */;
   }
 }
@@ -54,18 +60,19 @@ static inline void lock_acquire(xbt_mallocator_t m)
 static inline void lock_release(xbt_mallocator_t m)
 {
   if (initialization_done > 1)
-    __atomic_clear(&m->lock, __ATOMIC_RELEASE);
+    atomic_flag_clear(&m->lock);
 }
 
 /**
- * This function must be called once the framework configuration is done. If not, mallocators will never get used.
- * Check the implementation notes in src/xbt/mallocator.c for the justification of this.
+ * This function must be called once the framework configuration is done. mallocators will not get used until it's
+ * called (check the implementation notes above for more info).
  *
- * For example, surf_config uses this function to tell to the mallocators that the simgrid configuration is now
- * finished and that it can create them if not done yet */
-void xbt_mallocator_initialization_is_done(int protect)
+ * sg_config uses this function to inform the mallocators when simgrid is configured, and whether lock protection is
+ * needed.
+ */
+void xbt_mallocator_initialization_is_done(int need_protection)
 {
-  initialization_done = protect ? 2 : 1;
+  initialization_done = need_protection ? 2 : 1;
 }
 
 /** used by the module to know if it's time to activate the mallocators yet */
@@ -78,19 +85,19 @@ static inline int xbt_mallocator_is_active(void) {
 }
 
 /**
- * \brief Constructor
- * \param size size of the internal stack: number of objects the mallocator will be able to store
- * \param new_f function to allocate a new object of your datatype, called in \a xbt_mallocator_get() when the
+ * @brief Constructor
+ * @param size size of the internal stack: number of objects the mallocator will be able to store
+ * @param new_f function to allocate a new object of your datatype, called in @a xbt_mallocator_get() when the
  *              mallocator is empty
- * \param free_f function to free an object of your datatype, called in \a xbt_mallocator_release() when the stack is
+ * @param free_f function to free an object of your datatype, called 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
+ * @param reset_f function to reinitialize an object of your datatype, called when you extract an object from the
  *                mallocator (can be NULL)
  *
  * Create and initialize a new mallocator for a given datatype.
  *
- * \return pointer to the created mallocator
- * \see xbt_mallocator_free()
+ * @return pointer to the created mallocator
+ * @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)
 {
@@ -110,20 +117,19 @@ xbt_mallocator_t xbt_mallocator_new(int size, pvoid_f_void_t new_f, void_f_pvoid
   return m;
 }
 
-/** \brief Destructor
- * \param m the mallocator you want to destroy
+/** @brief Destructor
+ * @param m the mallocator you want to destroy
  *
  * Destroy the mallocator and all its data. The function free_f is called on each object in the mallocator.
  *
- * \see xbt_mallocator_new()
+ * @see xbt_mallocator_new()
  */
 void xbt_mallocator_free(xbt_mallocator_t m)
 {
-  int i;
   xbt_assert(m != NULL, "Invalid parameter");
 
   XBT_VERB("Frees mallocator %p (size:%d/%d)", m, m->current_size, m->max_size);
-  for (i = 0; i < m->current_size; i++) {
+  for (int i = 0; i < m->current_size; i++) {
     m->free_f(m->objects[i]);
   }
   xbt_free(m->objects);
@@ -131,8 +137,8 @@ void xbt_mallocator_free(xbt_mallocator_t m)
 }
 
 /**
- * \brief Extract an object from a mallocator
- * \param m a mallocator
+ * @brief Extract an object from a mallocator
+ * @param m a mallocator
  *
  * Remove an object from the mallocator and return it.
  * This function is designed to be used instead of malloc().
@@ -142,7 +148,7 @@ void xbt_mallocator_free(xbt_mallocator_t m)
  *
  * In both cases, the function reset_f() (if defined) is called on the object.
  *
- * \see xbt_mallocator_release()
+ * @see xbt_mallocator_release()
  */
 void *xbt_mallocator_get(xbt_mallocator_t m)
 {
@@ -153,9 +159,8 @@ void *xbt_mallocator_get(xbt_mallocator_t m)
     if (m->current_size <= 0) {
       /* No object is ready yet. Create a bunch of them to try to group the
        * mallocs on the same memory pages (to help the cache lines) */
-      int i;
       int amount = MIN(m->max_size / 2, 1000);
-      for (i = 0; i < amount; i++)
+      for (int i = 0; i < amount; i++)
         m->objects[i] = m->new_f();
       m->current_size = amount;
     }
@@ -179,16 +184,16 @@ void *xbt_mallocator_get(xbt_mallocator_t m)
   return object;
 }
 
-/** \brief Push an object into a mallocator
- * \param m a mallocator
- * \param object an object you don't need anymore
+/** @brief Push an object into a mallocator
+ * @param m a mallocator
+ * @param object an object you don't need anymore
  *
  * Push into the mallocator an object you don't need anymore.
  * This function is designed to be used instead of free().
  * If the mallocator is not full, your object if stored into the mallocator and no free is done.
  * If the mallocator is full, the object is freed by calling the function free_f().
  *
- * \see xbt_mallocator_get()
+ * @see xbt_mallocator_get()
  */
 void xbt_mallocator_release(xbt_mallocator_t m, void *object)
 {