Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Make code simpler.
[simgrid.git] / include / xbt / mallocator.h
1 /* xbt/mallocator.h -- api to recycle allocated objects                     */
2
3 /* Copyright (c) 2006-2020. The SimGrid Team. 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 #ifndef XBT_MALLOCATOR_H
9 #define XBT_MALLOCATOR_H
10
11 #include <xbt/function_types.h>
12 #include <xbt/misc.h>
13
14 SG_BEGIN_DECL
15
16 /** @addtogroup XBT_mallocator
17  *  @brief The mallocator system
18  *
19  *  This section describes the API to a mallocator.
20  *  A mallocator allows you to recycle the objects you don't need anymore  instead of freeing them. A mallocator is a
21  *  stack which stores the unused objects  or a given type. If you often need to malloc() / free() objects of a certain
22  *  type, you should use a mallocator and call @a xbt_mallocator_get() and @a xbt_mallocator_release() instead of
23  *  malloc() and free().
24  *
25  *  When you release an object, it is not freed but it is stored into the mallocator (unless the mallocator is full).
26  *  And when you want to get a new object, the object is just extracted from the mallocator. No malloc() is  done,
27  *  unless there is no more object in the mallocator.
28  */
29 /** @defgroup XBT_mallocator_cons Mallocator constructor and destructor
30  *  @ingroup XBT_mallocator
31  *
32  *  @{
33  */
34 /** @brief Mallocator data type (opaque structure) */
35 typedef struct s_xbt_mallocator *xbt_mallocator_t;
36 XBT_PUBLIC xbt_mallocator_t xbt_mallocator_new(int size, pvoid_f_void_t new_f, void_f_pvoid_t free_f,
37                                                void_f_pvoid_t reset_f);
38 XBT_PUBLIC void xbt_mallocator_free(xbt_mallocator_t mallocator);
39 /** @} */
40
41 /* object handling */
42 /** @defgroup XBT_mallocator_objects Mallocator object handling
43  *  @ingroup XBT_mallocator
44  *
45  *  @{
46  */
47 XBT_PUBLIC void* xbt_mallocator_get(xbt_mallocator_t mallocator);
48 XBT_PUBLIC void xbt_mallocator_release(xbt_mallocator_t mallocator, void* object);
49
50 XBT_PUBLIC void xbt_mallocator_initialization_is_done(int protect);
51 /** @} */
52
53 SG_END_DECL
54 #endif /* XBT_MALLOCATOR_H */