/* mallocator - recycle objects to avoid malloc() / free() */
-/* Copyright (c) 2006-2014. 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. */
-#include "src/internal_config.h"
#include "xbt/mallocator.h"
+#include "mallocator_private.h"
+#include "simgrid/modelchecker.h" /* kill mallocators when model-checking is enabled */
+#include "src/internal_config.h"
#include "xbt/asserts.h"
#include "xbt/sysdep.h"
-#include "mc/mc.h" /* kill mallocators when model-checking is enabled */
-#include "mallocator_private.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");
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) {
- int *lock = &m->lock;
- while (__sync_lock_test_and_set(lock, 1))
+ while (atomic_flag_test_and_set(&m->lock))
/* nop */;
}
}
static inline void lock_release(xbt_mallocator_t m)
{
if (initialization_done > 1)
- __sync_lock_release(&m->lock);
+ 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 */
static inline int xbt_mallocator_is_active(void) {
-#if HAVE_MALLOCATOR
+#if SIMGRID_HAVE_MALLOCATOR
return initialization_done && !MC_is_active();
#else
return 0;
}
/**
- * \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)
{
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);
}
/**
- * \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().
*
* 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)
{
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) */
-
- /* XBT_DEBUG("Create a new object for mallocator %p (size:%d/%d)", m, m->current_size, m->max_size); */
- 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;
}
/* there is at least an available object, now */
- /* XBT_DEBUG("Reuse an old object for mallocator %p (size:%d/%d)", m, m->current_size, m->max_size); */
object = m->objects[--m->current_size];
lock_release(m);
} else {
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)
{
lock_acquire(m);
if (m->current_size < m->max_size) {
/* there is enough place to push the object */
- /* XBT_DEBUG("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;
lock_release(m);
} else {
lock_release(m);
/* otherwise we don't have a choice, we must free the object */
- /* XBT_DEBUG("Free deleted object: mallocator %p is full (size:%d/%d)", m, m->current_size, m->max_size); */
m->free_f(object);
}
} else {