Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Disable mmalloc when !HAVE_MC.
[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-2014. 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 #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 #include "mc/datatypes.h"
26
27 /* Datatype representing a separate heap. The whole point of the mmalloc module
28  * is to allow several such heaps in the process. It thus works by redefining
29  * all the classical memory management functions (malloc and friends) with an
30  * extra first argument: the heap in which the memory is to be taken.
31  *
32  * The heap structure itself is an opaque object that shouldnt be messed with.
33  */
34 typedef struct mdesc *xbt_mheap_t;
35
36 /* Allocate SIZE bytes of memory (and memset it to 0).  */
37 XBT_PUBLIC( void ) *mmalloc(xbt_mheap_t md, size_t size);
38
39 /* Allocate SIZE bytes of memory (and don't mess with it) */
40 void *mmalloc_no_memset(xbt_mheap_t mdp, size_t size);
41
42 /* Re-allocate the previously allocated block in void*, making the new block
43    SIZE bytes long.  */
44
45 XBT_PUBLIC( void ) *mrealloc(xbt_mheap_t md, void *ptr, size_t size);
46
47 /* Free a block allocated by `mmalloc', `mrealloc' or `mcalloc'.  */
48 XBT_PUBLIC( void ) mfree(xbt_mheap_t md, void *ptr);
49
50 XBT_PUBLIC( xbt_mheap_t ) xbt_mheap_new(int fd, void *baseaddr);
51
52 XBT_PUBLIC( void ) xbt_mheap_destroy_no_free(xbt_mheap_t md);
53
54 XBT_PUBLIC( void ) *xbt_mheap_destroy(xbt_mheap_t md);
55
56 /* return the heap used when NULL is passed as first argument to any mm* function */
57 XBT_PUBLIC( xbt_mheap_t ) mmalloc_get_default_md(void);
58
59 /* To change the heap used when using the legacy version malloc/free/realloc and such */
60 void mmalloc_set_current_heap(xbt_mheap_t new_heap);
61 xbt_mheap_t mmalloc_get_current_heap(void);
62
63 struct s_mc_snapshot;
64
65 int mmalloc_compare_heap(struct s_mc_snapshot* snapshot1, struct s_mc_snapshot* snapshot2, xbt_mheap_t heap1, xbt_mheap_t heap2);
66 int mmalloc_linear_compare_heap(xbt_mheap_t heap1, xbt_mheap_t heap2);
67 int init_heap_information(xbt_mheap_t heap1, xbt_mheap_t heap2, xbt_dynar_t to_ignore1, xbt_dynar_t to_ignore2);
68 int compare_heap_area(void *area1, void* area2, struct s_mc_snapshot* snapshot1, struct s_mc_snapshot* snapshot2, xbt_dynar_t previous, dw_type_t type, int pointer_level);
69 void reset_heap_information(void);
70
71 size_t mmalloc_get_bytes_used(xbt_mheap_t);
72 ssize_t mmalloc_get_busy_size(xbt_mheap_t, void *ptr);
73
74 #endif
75 #endif                          /* MMALLOC_H */