Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
ab6ca00e2a6298e990c9178757760647050c2514
[simgrid.git] / src / include / xbt / mmalloc.h
1 /* Copyright (c) 2010-2018. The SimGrid Team. All rights reserved.          */
2
3 /* This program is free software; you can redistribute it and/or modify it
4  * under the terms of the license (GNU LGPL) which comes with this package. */
5
6 /* Copyright (C) 1991, 1992 Free Software Foundation, Inc.
7    This file was then part of the GNU C Library. */
8
9 #ifndef SIMGRID_MMALLOC_H
10 #define SIMGRID_MMALLOC_H 1
11
12 #include "src/internal_config.h"
13 #if HAVE_MMALLOC
14
15 #include <stdio.h>     /* for NULL */
16 #include <sys/types.h> /* for size_t */
17
18 #include "xbt/dict.h"
19 #include "xbt/dynar.h"
20
21 SG_BEGIN_DECL()
22
23 /* Datatype representing a separate heap. The whole point of the mmalloc module is to allow several such heaps in the
24  * process. It thus works by redefining all the classical memory management functions (malloc and friends) with an
25  * extra first argument: the heap in which the memory is to be taken.
26  *
27  * The heap structure itself is an opaque object that shouldnt be messed with.
28  */
29 typedef struct mdesc s_xbt_mheap_t;
30 typedef struct mdesc* xbt_mheap_t;
31
32 /* Allocate SIZE bytes of memory (and memset it to 0).  */
33 XBT_PUBLIC void* mmalloc(xbt_mheap_t md, size_t size);
34
35 /* Allocate SIZE bytes of memory (and don't mess with it) */
36 void* mmalloc_no_memset(xbt_mheap_t mdp, size_t size);
37
38 /* Re-allocate the previously allocated block in void*, making the new block SIZE bytes long.  */
39 XBT_PUBLIC void* mrealloc(xbt_mheap_t md, void* ptr, size_t size);
40
41 /* Free a block allocated by `mmalloc', `mrealloc' or `mcalloc'.  */
42 XBT_PUBLIC void mfree(xbt_mheap_t md, void* ptr);
43
44 XBT_PUBLIC xbt_mheap_t xbt_mheap_new(int fd, void* baseaddr);
45
46 #define XBT_MHEAP_OPTION_MEMSET 1
47
48 XBT_PUBLIC xbt_mheap_t xbt_mheap_new_options(int fd, void* baseaddr, int options);
49
50 XBT_PUBLIC void xbt_mheap_destroy_no_free(xbt_mheap_t md);
51
52 XBT_PUBLIC void* xbt_mheap_destroy(xbt_mheap_t md);
53
54 /* return the heap used when NULL is passed as first argument to any mm* function */
55 XBT_PUBLIC xbt_mheap_t mmalloc_get_default_md(void);
56
57 /* To change the heap used when using the legacy version malloc/free/realloc and such */
58 xbt_mheap_t mmalloc_set_current_heap(xbt_mheap_t new_heap);
59 xbt_mheap_t mmalloc_get_current_heap(void);
60
61 size_t mmalloc_get_bytes_used(xbt_mheap_t);
62 ssize_t mmalloc_get_busy_size(xbt_mheap_t, void* ptr);
63
64 void* malloc_no_memset(size_t n);
65
66 SG_END_DECL()
67
68 #endif
69 #endif /* SIMGRID_MMALLOC_H */