Logo AND Algorithmique Numérique Distribuée

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