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-2012. 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
  23 /* Datatype representing a separate heap. The whole point of the mmalloc module
  24  * is to allow several such heaps in the process. It thus works by redefining
  25  * all the classical memory management functions (malloc and friends) with an
  26  * extra first argument: the heap in which the memory is to be taken.
  27  *
  28  * The heap structure itself is an opaque object that shouldnt be messed with.
  29  */
  30 typedef struct mdesc *xbt_mheap_t;
  31
  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
  39    SIZE bytes long.  */
  40 XBT_PUBLIC( void ) *mrealloc(xbt_mheap_t md, void *ptr, size_t size);
  41
  42 /* Free a block allocated by `mmalloc', `mrealloc' or `mcalloc'.  */
  43 XBT_PUBLIC( void ) mfree(xbt_mheap_t md, void *ptr);
  44
  45 /* Allocate SIZE bytes allocated to ALIGNMENT bytes.  */
  46 XBT_PUBLIC( void ) *mmemalign(xbt_mheap_t md, size_t alignment, size_t size);
  47
  48 /* Allocate SIZE bytes on a page boundary.  */
  49 XBT_PUBLIC( void ) *mvalloc(xbt_mheap_t md, size_t size);
  50
  51 XBT_PUBLIC( xbt_mheap_t ) xbt_mheap_new(int fd, void *baseaddr);
  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 /* return the heap used when NULL is passed as first argument to any mm* function */
  58 XBT_PUBLIC( xbt_mheap_t ) mmalloc_get_default_md(void);
  59
  60 /* To change the heap used when using the legacy version malloc/free/realloc and such */
  61 void mmalloc_set_current_heap(xbt_mheap_t new_heap);
  62 xbt_mheap_t mmalloc_get_current_heap(void);
  63
  64 int mmalloc_compare_heap(xbt_mheap_t heap1, xbt_mheap_t heap2, xbt_dynar_t *stacks1, xbt_dynar_t *stacks2, xbt_dynar_t *equals);
  65 int mmalloc_linear_compare_heap(xbt_mheap_t heap1, xbt_mheap_t heap2);
  66
  67 void mmalloc_backtrace_block_display(void* heapinfo, int block);
  68 void mmalloc_backtrace_fragment_display(void* heapinfo, int block, int frag);
  69 void mmalloc_backtrace_display(void *addr);
  70
  71 int is_free_area(void *area, xbt_mheap_t heap);
  72
  73 size_t mmalloc_get_chunks_used(xbt_mheap_t);
  74
  75
  76
  77 #endif                          /* MMALLOC_H */