Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
419a836d4be1cf3bc550fbca7e53d5069b7337c8
[simgrid.git] / include / xbt / mmalloc.h
1 /* Copyright (c) 2010-2015. 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 #include "src/mc/mc_forward.h"
26
27 SG_BEGIN_DECL()
28
29 /* Datatype representing a separate heap. The whole point of the mmalloc module is to allow several such heaps in the
30  * process. It thus works by redefining all the classical memory management functions (malloc and friends) with an
31  * extra first argument: the heap in which the memory is to be taken.
32  *
33  * The heap structure itself is an opaque object that shouldnt be messed with.
34  */
35 typedef struct mdesc s_xbt_mheap_t;
36 typedef struct mdesc *xbt_mheap_t;
37
38 /* Allocate SIZE bytes of memory (and memset it to 0).  */
39 XBT_PUBLIC( void ) *mmalloc(xbt_mheap_t md, size_t size);
40
41 /* Allocate SIZE bytes of memory (and don't mess with it) */
42 void *mmalloc_no_memset(xbt_mheap_t mdp, size_t size);
43
44 /* Re-allocate the previously allocated block in void*, making the new block SIZE bytes long.  */
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 #define XBT_MHEAP_OPTION_MEMSET 1
53
54 XBT_PUBLIC( xbt_mheap_t ) xbt_mheap_new_options(int fd, void *baseaddr, int options);
55
56 XBT_PUBLIC( void ) xbt_mheap_destroy_no_free(xbt_mheap_t md);
57
58 XBT_PUBLIC( void ) *xbt_mheap_destroy(xbt_mheap_t md);
59
60 /* return the heap used when NULL is passed as first argument to any mm* function */
61 XBT_PUBLIC( xbt_mheap_t ) mmalloc_get_default_md(void);
62
63 /* To change the heap used when using the legacy version malloc/free/realloc and such */
64 xbt_mheap_t mmalloc_set_current_heap(xbt_mheap_t new_heap);
65 xbt_mheap_t mmalloc_get_current_heap(void);
66
67 int mmalloc_compare_heap(mc_snapshot_t snapshot1, mc_snapshot_t snapshot2);
68 int mmalloc_linear_compare_heap(xbt_mheap_t heap1, xbt_mheap_t heap2);
69 int init_heap_information(xbt_mheap_t heap1, xbt_mheap_t heap2, xbt_dynar_t to_ignore1, xbt_dynar_t to_ignore2);
70 int compare_heap_area(int process_index, const void *area1, const void* area2, mc_snapshot_t snapshot1,
71                       mc_snapshot_t snapshot2, xbt_dynar_t previous, mc_type_t type, int pointer_level);
72 void reset_heap_information(void);
73
74 size_t mmalloc_get_bytes_used(xbt_mheap_t);
75 ssize_t mmalloc_get_busy_size(xbt_mheap_t, void *ptr);
76
77 void* malloc_no_memset(size_t n);
78
79 SG_END_DECL()
80
81 #endif
82 #endif                          /* MMALLOC_H */