1 /* Copyright (c) 2010-2018. The SimGrid Team.
2 * All rights reserved. */
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. */
7 /* Copyright (C) 1991, 1992 Free Software Foundation, Inc.
8 This file was then part of the GNU C Library. */
10 #ifndef SIMGRID_MMALLOC_H
11 #define SIMGRID_MMALLOC_H 1
13 #include "src/internal_config.h"
16 # include <sys/types.h> /* for size_t */
17 # include <stdio.h> /* for NULL */
19 #include "xbt/dynar.h"
24 /* Datatype representing a separate heap. The whole point of the mmalloc module is to allow several such heaps in the
25 * process. It thus works by redefining all the classical memory management functions (malloc and friends) with an
26 * extra first argument: the heap in which the memory is to be taken.
28 * The heap structure itself is an opaque object that shouldnt be messed with.
30 typedef struct mdesc s_xbt_mheap_t;
31 typedef struct mdesc *xbt_mheap_t;
33 /* Allocate SIZE bytes of memory (and memset it to 0). */
34 XBT_PUBLIC void* mmalloc(xbt_mheap_t md, size_t size);
36 /* Allocate SIZE bytes of memory (and don't mess with it) */
37 void *mmalloc_no_memset(xbt_mheap_t mdp, size_t size);
39 /* Re-allocate the previously allocated block in void*, making the new block SIZE bytes long. */
40 XBT_PUBLIC void* mrealloc(xbt_mheap_t md, void* ptr, size_t size);
42 /* Free a block allocated by `mmalloc', `mrealloc' or `mcalloc'. */
43 XBT_PUBLIC void mfree(xbt_mheap_t md, void* ptr);
45 XBT_PUBLIC xbt_mheap_t xbt_mheap_new(int fd, void* baseaddr);
47 #define XBT_MHEAP_OPTION_MEMSET 1
49 XBT_PUBLIC xbt_mheap_t xbt_mheap_new_options(int fd, void* baseaddr, int options);
51 XBT_PUBLIC void xbt_mheap_destroy_no_free(xbt_mheap_t md);
53 XBT_PUBLIC void* xbt_mheap_destroy(xbt_mheap_t md);
55 /* return the heap used when NULL is passed as first argument to any mm* function */
56 XBT_PUBLIC xbt_mheap_t mmalloc_get_default_md(void);
58 /* To change the heap used when using the legacy version malloc/free/realloc and such */
59 xbt_mheap_t mmalloc_set_current_heap(xbt_mheap_t new_heap);
60 xbt_mheap_t mmalloc_get_current_heap(void);
62 size_t mmalloc_get_bytes_used(xbt_mheap_t);
63 ssize_t mmalloc_get_busy_size(xbt_mheap_t, void *ptr);
65 void* malloc_no_memset(size_t n);
70 #endif /* SIMGRID_MMALLOC_H */