include/xbt/mmalloc.h

   1 /* Copyright (c) 2010-2014. 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
  26 SG_BEGIN_DECL()
  27
  28 /* Datatype representing a separate heap. The whole point of the mmalloc module
  29  * is to allow several such heaps in the process. It thus works by redefining
  30  * 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 *xbt_mheap_t;
  36
  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
  44    SIZE bytes long.  */
  45
  46 XBT_PUBLIC( void ) *mrealloc(xbt_mheap_t md, void *ptr, size_t size);
  47
  48 /* Free a block allocated by `mmalloc', `mrealloc' or `mcalloc'.  */
  49 XBT_PUBLIC( void ) mfree(xbt_mheap_t md, void *ptr);
  50
  51 XBT_PUBLIC( xbt_mheap_t ) xbt_mheap_new(int fd, void *baseaddr);
  52
  53 #define XBT_MHEAP_OPTION_MEMSET 1
  54
  55 XBT_PUBLIC( xbt_mheap_t ) xbt_mheap_new_options(int fd, void *baseaddr, int options);
  56
  57 XBT_PUBLIC( void ) xbt_mheap_destroy_no_free(xbt_mheap_t md);
  58
  59 XBT_PUBLIC( void ) *xbt_mheap_destroy(xbt_mheap_t md);
  60
  61 /* return the heap used when NULL is passed as first argument to any mm* function */
  62 XBT_PUBLIC( xbt_mheap_t ) mmalloc_get_default_md(void);
  63
  64 /* To change the heap used when using the legacy version malloc/free/realloc and such */
  65 void mmalloc_set_current_heap(xbt_mheap_t new_heap);
  66 xbt_mheap_t mmalloc_get_current_heap(void);
  67
  68 struct s_mc_snapshot;
  69 struct s_dw_type;
  70
  71 int mmalloc_compare_heap(struct s_mc_snapshot* snapshot1, struct s_mc_snapshot* snapshot2);
  72 int mmalloc_linear_compare_heap(xbt_mheap_t heap1, xbt_mheap_t heap2);
  73 int init_heap_information(xbt_mheap_t heap1, xbt_mheap_t heap2, xbt_dynar_t to_ignore1, xbt_dynar_t to_ignore2);
  74 int compare_heap_area(int process_index, const void *area1, const void* area2, struct s_mc_snapshot* snapshot1, struct s_mc_snapshot* snapshot2, xbt_dynar_t previous, struct s_dw_type *type, int pointer_level);
  75 void reset_heap_information(void);
  76
  77 size_t mmalloc_get_bytes_used(xbt_mheap_t);
  78 ssize_t mmalloc_get_busy_size(xbt_mheap_t, void *ptr);
  79
  80 SG_END_DECL()
  81
  82 #endif
  83 #endif                          /* MMALLOC_H */