Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Merge branch 'master' of framagit.org:simgrid/simgrid
[simgrid.git] / src / xbt / mmalloc / mmalloc.h
index 98642f9..7dff4e7 100644 (file)
@@ -1,62 +1,56 @@
-#ifndef MMALLOC_H
-#define MMALLOC_H 1
-
-#ifdef HAVE_STDDEF_H
-#  include <stddef.h>
-#else
-#  include <sys/types.h>   /* for size_t */
-#  include <stdio.h>       /* for NULL */
-#endif
-//#include "./include/ansidecl.h"
-
-/* Allocate SIZE bytes of memory.  */
-
-extern void* mmalloc(void* md, size_t size);
+/* Copyright (c) 2010-2023. The SimGrid Team. All rights reserved.          */
 
-/* Re-allocate the previously allocated block in void*, making the new block
  SIZE bytes long.  */
+/* This program is free software; you can redistribute it and/or modify it
* under the terms of the license (GNU LGPL) which comes with this package. */
 
-extern void* mrealloc(void* md, void* ptr, size_t size);
+/* Copyright (C) 1991, 1992 Free Software Foundation, Inc.
+   This file was then part of the GNU C Library. */
 
-/* Allocate NMEMB elements of SIZE bytes each, all initialized to 0.  */
-
-extern void* mcalloc (void* md, size_t nmemb, size_t size);
-
-/* Free a block allocated by `mmalloc', `mrealloc' or `mcalloc'.  */
+#ifndef SIMGRID_MMALLOC_H
+#define SIMGRID_MMALLOC_H
 
-extern void mfree (void* md, void* ptr);
+#include "src/internal_config.h"
 
-/* Allocate SIZE bytes allocated to ALIGNMENT bytes.  */
+#include <stdio.h>     /* for NULL */
+#include <sys/types.h> /* for size_t */
 
-extern void* mmemalign (void* md, size_t alignment, size_t size);
+SG_BEGIN_DECL
 
-/* Allocate SIZE bytes on a page boundary.  */
+/* Datatype representing a separate heap. The whole point of the mmalloc module is to allow several such heaps in the
+ * process. It thus works by redefining all the classical memory management functions (malloc and friends) with an
+ * extra first argument: the heap in which the memory is to be taken.
+ *
+ * The heap structure itself is an opaque object that shouldn't be messed with.
+ */
+typedef struct mdesc s_xbt_mheap_t;
+typedef s_xbt_mheap_t* xbt_mheap_t;
 
-extern void* mvalloc (void* md, size_t size);
+#if HAVE_MMALLOC
+/* Allocate SIZE bytes of memory (and memset it to 0).  */
+XBT_PUBLIC void* mmalloc(xbt_mheap_t md, size_t size);
 
-/* Activate a standard collection of debugging hooks.  */
+/* Allocate SIZE bytes of memory (and don't mess with it) */
+void* mmalloc_no_memset(xbt_mheap_t mdp, size_t size);
 
-extern int mmcheck (void* md, void (*func) (void));
+/* Re-allocate the previously allocated block in void*, making the new block SIZE bytes long.  */
+XBT_PUBLIC void* mrealloc(xbt_mheap_t md, void* ptr, size_t size);
 
-extern int mmcheckf (void* md, void (*func) (void), int force);
-
-/* Pick up the current statistics. (see FIXME elsewhere) */
-
-extern struct mstats mmstats (void* md);
-
-extern void* mmalloc_attach (int fd, void* baseaddr);
+/* Free a block allocated by `mmalloc', `mrealloc' or `mcalloc'.  */
+XBT_PUBLIC void mfree(xbt_mheap_t md, void* ptr);
 
-extern void* mmalloc_detach (void* md);
+#define XBT_MHEAP_OPTION_MEMSET 1
 
-extern int mmalloc_setkey (void* md, int keynum, void* key);
+XBT_PUBLIC xbt_mheap_t xbt_mheap_new(void* baseaddr, int options);
 
-extern void* mmalloc_getkey (void* md, int keynum);
+XBT_PUBLIC void* xbt_mheap_destroy(xbt_mheap_t md);
 
-// FIXME: this function is not implemented anymore?
-//extern int mmalloc_errno (void* md);
+/* To get the heap used when using the legacy version malloc/free/realloc and such */
+xbt_mheap_t mmalloc_get_current_heap(void);
 
-extern int mmtrace(void);
+/* Returns true if we are using the internal mmalloc, and false if we are using the libc's malloc */
+XBT_PUBLIC int malloc_use_mmalloc(void);
 
-extern void* mmalloc_findbase(int size);
+#endif
+SG_END_DECL
 
-#endif  /* MMALLOC_H */
+#endif /* SIMGRID_MMALLOC_H */