X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/7377fcd26c41f42160b385faf84135857928bda0..2d37e348a09783cda723c7019640ee69de168324:/src/xbt/mallocator.c diff --git a/src/xbt/mallocator.c b/src/xbt/mallocator.c index ec32f179c5..041f82c1ea 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-2019. 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: @@ -78,19 +84,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 reinitialise 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,12 +116,12 @@ 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) { @@ -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) { @@ -179,16 +185,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) {