Logo AND Algorithmique Numérique Distribuée

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