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
  24 /* Datatype representing a separate heap. The whole point of the mmalloc module
  25  * is to allow several such heaps in the process. It thus works by redefining
  26  * all the classical memory management functions (malloc and friends) with an
  27  * extra first argument: the heap in which the memory is to be taken.
  28  *
  29  * The heap structure itself is an opaque object that shouldnt be messed with.
  30  */
  31 typedef struct mdesc *xbt_mheap_t;
  32
  33 /* Allocate SIZE bytes of memory (and memset it to 0).  */
  34 XBT_PUBLIC( void ) *mmalloc(xbt_mheap_t md, size_t size);
  35
  36 /* Allocate SIZE bytes of memory (and don't mess with it) */
  37 void *mmalloc_no_memset(xbt_mheap_t mdp, size_t size);
  38
  39 /* Re-allocate the previously allocated block in void*, making the new block
  40    SIZE bytes long.  */
  41 XBT_PUBLIC( void ) *mrealloc(xbt_mheap_t md, void *ptr, size_t size);
  42
  43 /* Free a block allocated by `mmalloc', `mrealloc' or `mcalloc'.  */
  44 XBT_PUBLIC( void ) mfree(xbt_mheap_t md, void *ptr);
  45
  46 XBT_PUBLIC( xbt_mheap_t ) xbt_mheap_new(int fd, void *baseaddr);
  47
  48 XBT_PUBLIC( void ) xbt_mheap_destroy_no_free(xbt_mheap_t md);
  49
  50 XBT_PUBLIC( void ) *xbt_mheap_destroy(xbt_mheap_t md);
  51
  52 /* return the heap used when NULL is passed as first argument to any mm* function */
  53 XBT_PUBLIC( xbt_mheap_t ) mmalloc_get_default_md(void);
  54
  55 /* To change the heap used when using the legacy version malloc/free/realloc and such */
  56 void mmalloc_set_current_heap(xbt_mheap_t new_heap);
  57 xbt_mheap_t mmalloc_get_current_heap(void);
  58
  59 int mmalloc_compare_heap(xbt_mheap_t heap1, xbt_mheap_t heap2);
  60 int mmalloc_linear_compare_heap(xbt_mheap_t heap1, xbt_mheap_t heap2);
  61 int init_heap_information(xbt_mheap_t heap1, xbt_mheap_t heap2, xbt_dynar_t to_ignore1, xbt_dynar_t to_ignore2);
  62 int compare_heap_area(void *area1, void* area2, xbt_dynar_t previous, xbt_dict_t all_types, xbt_dict_t other_types, char *type, int pointer_level);
  63 void reset_heap_information(void);
  64 int get_pointed_area_size(void *area, int heap);
  65
  66 size_t mmalloc_get_bytes_used(xbt_mheap_t);
  67 ssize_t mmalloc_get_busy_size(xbt_mheap_t, void *ptr);
  68
  69 #endif                          /* MMALLOC_H */