include/xbt/mmalloc.h

   1 /* Copyright (C) 1991, 1992 Free Software Foundation, Inc.
   2    This file was then part of the GNU C Library. */
   3
   4 /* Copyright (c) 2010-2013. The SimGrid Team.
   5  * All rights reserved.                                                     */
   6
   7 /* This program is free software; you can redistribute it and/or modify it
   8  * under the terms of the license (GNU LGPL) which comes with this package. */
   9
  10
  11 #ifndef MMALLOC_H
  12 #define MMALLOC_H 1
  13
  14 #ifdef HAVE_STDDEF_H
  15 #  include <stddef.h>
  16 #else
  17 #  include <sys/types.h>        /* for size_t */
  18 #  include <stdio.h>            /* for NULL */
  19 #endif
  20
  21 #include "xbt/dynar.h"
  22 #include "xbt/dict.h"
  23 #include "mc/datatypes.h"
  24
  25 /* Datatype representing a separate heap. The whole point of the mmalloc module
  26  * is to allow several such heaps in the process. It thus works by redefining
  27  * all the classical memory management functions (malloc and friends) with an
  28  * extra first argument: the heap in which the memory is to be taken.
  29  *
  30  * The heap structure itself is an opaque object that shouldnt be messed with.
  31  */
  32 typedef struct mdesc *xbt_mheap_t;
  33
  34 /* Allocate SIZE bytes of memory (and memset it to 0).  */
  35 XBT_PUBLIC( void ) *mmalloc(xbt_mheap_t md, size_t size);
  36
  37 /* Allocate SIZE bytes of memory (and don't mess with it) */
  38 void *mmalloc_no_memset(xbt_mheap_t mdp, size_t size);
  39
  40 /* Re-allocate the previously allocated block in void*, making the new block
  41    SIZE bytes long.  */
  42
  43 XBT_PUBLIC( void ) *mrealloc(xbt_mheap_t md, void *ptr, size_t size);
  44
  45 /* Free a block allocated by `mmalloc', `mrealloc' or `mcalloc'.  */
  46 XBT_PUBLIC( void ) mfree(xbt_mheap_t md, void *ptr);
  47
  48 XBT_PUBLIC( xbt_mheap_t ) xbt_mheap_new(int fd, void *baseaddr);
  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 /* return the heap used when NULL is passed as first argument to any mm* function */
  55 XBT_PUBLIC( xbt_mheap_t ) mmalloc_get_default_md(void);
  56
  57 /* To change the heap used when using the legacy version malloc/free/realloc and such */
  58 void mmalloc_set_current_heap(xbt_mheap_t new_heap);
  59 xbt_mheap_t mmalloc_get_current_heap(void);
  60
  61 int mmalloc_compare_heap(xbt_mheap_t heap1, xbt_mheap_t heap2, mc_object_info_t info, mc_object_info_t other_info);
  62 int mmalloc_linear_compare_heap(xbt_mheap_t heap1, xbt_mheap_t heap2);
  63 int init_heap_information(xbt_mheap_t heap1, xbt_mheap_t heap2, xbt_dynar_t to_ignore1, xbt_dynar_t to_ignore2);
  64 int compare_heap_area(void *area1, void* area2, xbt_dynar_t previous, mc_object_info_t info, mc_object_info_t other_info, char *type, int pointer_level);
  65 void reset_heap_information(void);
  66
  67 size_t mmalloc_get_bytes_used(xbt_mheap_t);
  68 ssize_t mmalloc_get_busy_size(xbt_mheap_t, void *ptr);
  69
  70 #endif                          /* MMALLOC_H */