src/include/xbt/mmalloc.h

   1 /* Copyright (c) 2010-2019. The SimGrid Team. All rights reserved.          */
   2
   3 /* This program is free software; you can redistribute it and/or modify it
   4  * under the terms of the license (GNU LGPL) which comes with this package. */
   5
   6 /* Copyright (C) 1991, 1992 Free Software Foundation, Inc.
   7    This file was then part of the GNU C Library. */
   8
   9 #ifndef SIMGRID_MMALLOC_H
  10 #define SIMGRID_MMALLOC_H
  11
  12 #include "src/internal_config.h"
  13
  14 #include <stdio.h>     /* for NULL */
  15 #include <sys/types.h> /* for size_t */
  16
  17 #include "xbt/dict.h"
  18 #include "xbt/dynar.h"
  19
  20 SG_BEGIN_DECL()
  21
  22 /* Datatype representing a separate heap. The whole point of the mmalloc module is to allow several such heaps in the
  23  * process. It thus works by redefining 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 shouldn't be messed with.
  27  */
  28 typedef struct mdesc s_xbt_mheap_t;
  29 typedef s_xbt_mheap_t* xbt_mheap_t;
  30
  31 #if HAVE_MMALLOC
  32 /* Allocate SIZE bytes of memory (and memset it to 0).  */
  33 XBT_PUBLIC void* mmalloc(xbt_mheap_t md, size_t size);
  34
  35 /* Allocate SIZE bytes of memory (and don't mess with it) */
  36 void* mmalloc_no_memset(xbt_mheap_t mdp, size_t size);
  37
  38 /* Re-allocate the previously allocated block in void*, making the new block SIZE bytes long.  */
  39 XBT_PUBLIC void* mrealloc(xbt_mheap_t md, void* ptr, size_t size);
  40
  41 /* Free a block allocated by `mmalloc', `mrealloc' or `mcalloc'.  */
  42 XBT_PUBLIC void mfree(xbt_mheap_t md, void* ptr);
  43
  44 XBT_PUBLIC xbt_mheap_t xbt_mheap_new(int fd, void* baseaddr);
  45
  46 #define XBT_MHEAP_OPTION_MEMSET 1
  47
  48 XBT_PUBLIC xbt_mheap_t xbt_mheap_new_options(int fd, void* baseaddr, int options);
  49
  50 XBT_PUBLIC void xbt_mheap_destroy_no_free(xbt_mheap_t md);
  51
  52 XBT_PUBLIC void* xbt_mheap_destroy(xbt_mheap_t md);
  53
  54 /* To get the heap used when using the legacy version malloc/free/realloc and such */
  55 xbt_mheap_t mmalloc_get_current_heap(void);
  56
  57 #endif
  58 SG_END_DECL()
  59
  60 #endif /* SIMGRID_MMALLOC_H */