src/include/xbt/mmalloc.h

   1 /* Copyright (c) 2010-2022. 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 /** Environment variable name used to pass the communication socket.
  15  *
  16  * It is set by `simgrid-mc` to enable MC support in the children processes.
  17  *
  18  * It is placed in this file so that it's visible from mmalloc and MC without sharing anythin of xbt in mmalloc
  19  */
  20 #define MC_ENV_SOCKET_FD "SIMGRID_MC_SOCKET_FD"
  21
  22 #include <stdio.h>     /* for NULL */
  23 #include <sys/types.h> /* for size_t */
  24
  25 SG_BEGIN_DECL
  26
  27 /* Datatype representing a separate heap. The whole point of the mmalloc module is to allow several such heaps in the
  28  * process. It thus works by redefining 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 shouldn't be messed with.
  32  */
  33 typedef struct mdesc s_xbt_mheap_t;
  34 typedef s_xbt_mheap_t* xbt_mheap_t;
  35
  36 #if HAVE_MMALLOC
  37 /* Allocate SIZE bytes of memory (and memset it to 0).  */
  38 XBT_PUBLIC void* mmalloc(xbt_mheap_t md, size_t size);
  39
  40 /* Allocate SIZE bytes of memory (and don't mess with it) */
  41 void* mmalloc_no_memset(xbt_mheap_t mdp, size_t size);
  42
  43 /* Re-allocate the previously allocated block in void*, making the new block SIZE bytes long.  */
  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 #define XBT_MHEAP_OPTION_MEMSET 1
  50
  51 XBT_PUBLIC xbt_mheap_t xbt_mheap_new(void* baseaddr, int options);
  52
  53 XBT_PUBLIC void xbt_mheap_destroy_no_free(xbt_mheap_t md);
  54
  55 XBT_PUBLIC void* xbt_mheap_destroy(xbt_mheap_t md);
  56
  57 /* To get the heap used when using the legacy version malloc/free/realloc and such */
  58 xbt_mheap_t mmalloc_get_current_heap(void);
  59
  60 #endif
  61 SG_END_DECL
  62
  63 #endif /* SIMGRID_MMALLOC_H */