-/* Copyright (c) 2010. The SimGrid Team.
+/* Copyright (c) 2010-2015. The SimGrid Team.
* All rights reserved. */
/* 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. */
/* Redefine the classical malloc/free/realloc functions so that they fit well in the mmalloc framework */
+#define _GNU_SOURCE
+
+#include <stdlib.h>
+
+#include <dlfcn.h>
#include "mmprivate.h"
-#include "gras_config.h"
+#include "src/internal_config.h"
+#include "src/mc/mc_base.h"
+#include "src/mc/remote/mc_protocol.h"
+#include "src/xbt_modinter.h"
+#include <math.h>
+
+/* ***** Whether to use `mmalloc` of the underlying malloc ***** */
+
+static int __malloc_use_mmalloc;
+
+int malloc_use_mmalloc(void)
+{
+ return __malloc_use_mmalloc;
+}
+
+/* ***** Current heap ***** */
-static void *__mmalloc_current_heap = NULL; /* The heap we are currently using. */
+/* The mmalloc() package can use a single implicit malloc descriptor
+ for mmalloc/mrealloc/mfree operations which do not supply an explicit
+ descriptor. This allows mmalloc() to provide
+ backwards compatibility with the non-mmap'd version. */
+xbt_mheap_t __mmalloc_default_mdp = NULL;
-#include "xbt_modinter.h"
+/* The heap we are currently using. */
+static xbt_mheap_t __mmalloc_current_heap = NULL;
-void *mmalloc_get_current_heap(void)
+xbt_mheap_t mmalloc_get_current_heap(void)
{
return __mmalloc_current_heap;
}
-void mmalloc_set_current_heap(void *new_heap)
+xbt_mheap_t mmalloc_set_current_heap(xbt_mheap_t new_heap)
{
+ xbt_mheap_t heap = __mmalloc_current_heap;
__mmalloc_current_heap = new_heap;
+ return heap;
}
-#ifdef MMALLOC_WANT_OVERIDE_LEGACY
-void *malloc(size_t n)
-{
- void *mdp = __mmalloc_current_heap;
-#ifdef HAVE_MMAP
- if (!mdp)
- mmalloc_preinit();
+/* Override the malloc-like functions if MC is activated at compile time */
+#if HAVE_MC
+
+/* ***** Temporary allocator
+ *
+ * This is used before we have found the real malloc implementation with dlsym.
+ */
+
+#ifdef __FreeBSD__ /* FreeBSD require more memory, other might */
+# define BUFFER_SIZE 256
+#else /* Valid on: Linux */
+# define BUFFER_SIZE 32
#endif
- LOCK(mdp);
- void *ret = mmalloc(mdp, n);
- UNLOCK(mdp);
+static size_t fake_alloc_index;
+static uint64_t buffer[BUFFER_SIZE];
- return ret;
+/* Fake implementations, they are used to fool dlsym:
+ * dlsym used calloc and falls back to some other mechanism
+ * if this fails.
+ */
+static void* mm_fake_malloc(size_t n)
+{
+ // How many uint64_t do w need?
+ size_t count = n / sizeof(uint64_t);
+ if (n % sizeof(uint64_t))
+ count++;
+ // Check that we have enough available memory:
+ if (fake_alloc_index + count >= BUFFER_SIZE)
+ exit(127);
+ // Allocate it:
+ uint64_t* res = buffer + fake_alloc_index;
+ fake_alloc_index += count;
+ return res;
}
-void *calloc(size_t nmemb, size_t size)
+static void* mm_fake_calloc(size_t nmemb, size_t size)
{
- size_t total_size = nmemb * size;
- void *mdp = __mmalloc_current_heap;
-#ifdef HAVE_MMAP
- if (!mdp)
- mmalloc_preinit();
-#endif
- LOCK(mdp);
- void *ret = mmalloc(mdp, total_size);
- UNLOCK(mdp);
+ // This is fresh .bss data, we don't need to clear it:
+ size_t n = nmemb * size;
+ return mm_fake_malloc(n);
+}
- /* Fill the allocated memory with zeroes to mimic calloc behaviour */
- memset(ret, '\0', total_size);
+static void* mm_fake_realloc(void *p, size_t s)
+{
+ return mm_fake_malloc(s);
+}
- return ret;
+static void mm_fake_free(void *p)
+{
}
-void *realloc(void *p, size_t s)
+/* Function signatures for the main malloc functions: */
+typedef void* (*mm_malloc_t)(size_t size);
+typedef void (*mm_free_t)(void*);
+typedef void* (*mm_calloc_t)(size_t nmemb, size_t size);
+typedef void* (*mm_realloc_t)(void *ptr, size_t size);
+
+/* Function pointers to the real/next implementations: */
+static mm_malloc_t mm_real_malloc;
+static mm_free_t mm_real_free;
+static mm_calloc_t mm_real_calloc;
+static mm_realloc_t mm_real_realloc;
+
+static int mm_initializing;
+static int mm_initialized;
+
+/** Constructor functions used to initialize the malloc implementation
+ */
+static void __attribute__((constructor(101))) mm_legacy_constructor()
{
- void *ret = NULL;
- void *mdp = __mmalloc_current_heap;
-#ifdef HAVE_MMAP
- if (!mdp)
- mmalloc_preinit();
-#endif
- LOCK(mdp);
- if (s) {
- if (p)
- ret = mrealloc(mdp, p, s);
- else
- ret = mmalloc(mdp, s);
+ if (mm_initialized)
+ return;
+ mm_initializing = 1;
+ __malloc_use_mmalloc = getenv(MC_ENV_VARIABLE) ? 1 : 0;
+ if (__malloc_use_mmalloc) {
+ __mmalloc_current_heap = mmalloc_preinit();
} else {
- if (p)
- mfree(mdp, p);
+#if HAVE_DLFUNC
+ mm_real_realloc = (void *(*)(void *, size_t))dlfunc(RTLD_NEXT, "realloc");
+ mm_real_malloc = (void *(*)(size_t))dlfunc(RTLD_NEXT, "malloc");
+ mm_real_free = (void (*)(void *))dlfunc(RTLD_NEXT, "free");
+ mm_real_calloc = (void *(*)(size_t, size_t))dlfunc(RTLD_NEXT, "calloc");
+#else
+ mm_real_realloc = dlsym(RTLD_NEXT, "realloc");
+ mm_real_malloc = dlsym(RTLD_NEXT, "malloc");
+ mm_real_free = dlsym(RTLD_NEXT, "free");
+ mm_real_calloc = dlsym(RTLD_NEXT, "calloc");
+#endif
}
- UNLOCK(mdp);
-
- return ret;
+ mm_initializing = 0;
+ mm_initialized = 1;
}
-void free(void *p)
+/* ***** malloc/free implementation
+ *
+ * They call either the underlying/native/RTLD_NEXT implementation (non MC mode)
+ * or the mm implementation (MC mode).
+ *
+ * If we are initializing the malloc subsystem, we call the fake/dummy `malloc`
+ * implementation. This is necessary because `dlsym` calls `malloc` and friends.
+ */
+
+#define GET_HEAP() __mmalloc_current_heap
+
+void* malloc_no_memset(size_t n)
{
- void *mdp = __mmalloc_current_heap;
-#ifdef HAVE_GTNETS
- if(!mdp) return;
-#endif
+ if (!mm_initialized) {
+ if (mm_initializing)
+ return mm_fake_malloc(n);
+ mm_legacy_constructor();
+ }
+
+ if (!__malloc_use_mmalloc) {
+ return mm_real_malloc(n);
+ }
+
+ xbt_mheap_t mdp = GET_HEAP();
+ if (!mdp)
+ return NULL;
+
LOCK(mdp);
- mfree(mdp, p);
+ void *ret = mmalloc_no_memset(mdp, n);
UNLOCK(mdp);
+ return ret;
}
-#endif
-/* Make sure it works with md==NULL */
+void *malloc(size_t n)
+{
+ if (!mm_initialized) {
+ if (mm_initializing)
+ return mm_fake_malloc(n);
+ mm_legacy_constructor();
+ }
-#define HEAP_OFFSET (128<<20) /* Safety gap from the heap's break address.
- * Try to increase this first if you experience
- * strange errors under valgrind. */
+ if (!__malloc_use_mmalloc) {
+ return mm_real_malloc(n);
+ }
-void *mmalloc_get_default_md(void)
-{
- xbt_assert(__mmalloc_default_mdp);
- return __mmalloc_default_mdp;
+ xbt_mheap_t mdp = GET_HEAP();
+ if (!mdp)
+ return NULL;
+
+ LOCK(mdp);
+ void *ret = mmalloc(mdp, n);
+ UNLOCK(mdp);
+ return ret;
}
-static void mmalloc_fork_prepare(void)
+void *calloc(size_t nmemb, size_t size)
{
- struct mdesc* mdp = NULL;
- if ((mdp =__mmalloc_default_mdp)){
- while(mdp){
- LOCK(mdp);
- if(mdp->fd >= 0){
- mdp->refcount++;
- }
- mdp = mdp->next_mdesc;
- }
+ if (!mm_initialized) {
+ if (mm_initializing)
+ return mm_fake_calloc(nmemb, size);
+ mm_legacy_constructor();
}
-}
-static void mmalloc_fork_parent(void)
-{
- struct mdesc* mdp = NULL;
- if ((mdp =__mmalloc_default_mdp)){
- while(mdp){
- if(mdp->fd < 0)
- UNLOCK(mdp);
- mdp = mdp->next_mdesc;
- }
+ if (!__malloc_use_mmalloc) {
+ return mm_real_calloc(nmemb, size);
}
-}
-static void mmalloc_fork_child(void)
-{
- struct mdesc* mdp = NULL;
- if ((mdp =__mmalloc_default_mdp)){
- while(mdp){
- UNLOCK(mdp);
- mdp = mdp->next_mdesc;
- }
+ xbt_mheap_t mdp = GET_HEAP();
+ if (!mdp)
+ return NULL;
+
+ LOCK(mdp);
+ void *ret = mmalloc(mdp, nmemb*size);
+ UNLOCK(mdp);
+ // This was already done in the callee:
+ if(!(mdp->options & XBT_MHEAP_OPTION_MEMSET)) {
+ memset(ret, 0, nmemb * size);
}
+ return ret;
}
-/* Initialize the default malloc descriptor. */
-void mmalloc_preinit(void)
+void *realloc(void *p, size_t s)
{
- if (!__mmalloc_default_mdp) {
- __mmalloc_default_mdp =
- mmalloc_attach(-1, (char *) sbrk(0) + HEAP_OFFSET);
- /* Fixme? only the default mdp in protected against forks */
- if (xbt_os_thread_atfork(mmalloc_fork_prepare,
- mmalloc_fork_parent, mmalloc_fork_child) != 0)
- abort();
+ if (!mm_initialized) {
+ if (mm_initializing)
+ return mm_fake_realloc(p, s);
+ mm_legacy_constructor();
}
- xbt_assert(__mmalloc_default_mdp != NULL);
+
+ if (!__malloc_use_mmalloc) {
+ return mm_real_realloc(p, s);
+ }
+
+ xbt_mheap_t mdp = GET_HEAP();
+ if (!mdp)
+ return NULL;
+
+ LOCK(mdp);
+ void* ret = mrealloc(mdp, p, s);
+ UNLOCK(mdp);
+ return ret;
}
-void mmalloc_postexit(void)
+void free(void *p)
{
- /* Do not detach the default mdp or ldl won't be able to free the memory it allocated since we're in memory */
- // mmalloc_detach(__mmalloc_default_mdp);
- mmalloc_pre_detach(__mmalloc_default_mdp);
+ if (!mm_initialized) {
+ if (mm_initializing)
+ return mm_fake_free(p);
+ mm_legacy_constructor();
+ }
+
+ if (!__malloc_use_mmalloc) {
+ mm_real_free(p);
+ return;
+ }
+
+ if (!p)
+ return;
+
+ xbt_mheap_t mdp = GET_HEAP();
+ LOCK(mdp);
+ mfree(mdp, p);
+ UNLOCK(mdp);
}
+#endif /* HAVE_MC */