-/* Copyright (c) 2010-2014. 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 "src/mc/mc_base.h"
#include "mmprivate.h"
-#include "xbt_modinter.h"
-#include "internal_config.h"
+#include "src/xbt_modinter.h"
+#include "src/internal_config.h"
#include <math.h>
+#include "src/mc/mc_protocol.h"
-//#define MM_LEGACY_VERBOSE 1 /* define this to see which version of malloc gets used */
+/* ***** Whether to use `mmalloc` of the undrlying malloc ***** */
+
+static int __malloc_use_mmalloc;
+
+int malloc_use_mmalloc(void)
+{
+ return __malloc_use_mmalloc;
+}
+
+/* ***** Current heap ***** */
/* The mmalloc() package can use a single implicit malloc descriptor
for mmalloc/mrealloc/mfree operations which do not supply an explicit
backwards compatibility with the non-mmap'd version. */
xbt_mheap_t __mmalloc_default_mdp = NULL;
-
-static xbt_mheap_t __mmalloc_current_heap = NULL; /* The heap we are currently using. */
+/* The heap we are currently using. */
+static xbt_mheap_t __mmalloc_current_heap = NULL;
xbt_mheap_t mmalloc_get_current_heap(void)
{
return __mmalloc_current_heap;
}
-void mmalloc_set_current_heap(xbt_mheap_t 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;
}
+/* Override the malloc-like functions if MC is activated at compile time */
+#if HAVE_MC
-#ifdef MMALLOC_WANT_OVERRIDE_LEGACY
-#if 0 && defined(HAVE_GNU_LD)
-
-#undef _GNU_SOURCE
-#define _GNU_SOURCE 1
-#include <dlfcn.h>
-
-static void * (*real_malloc) (size_t) = NULL;
-static void * (*real_realloc) (void*,size_t) = NULL;
-static void * (*real_free) (void*) = NULL;
+/* ***** Temporary allocator
+ *
+ * This is used before we have found the real malloc implementation with dlsym.
+ */
-static void mm_gnuld_legacy_init(void) { /* This function is called from mmalloc_preinit(); it works even if it's static because all mm is in mm.c */
- real_malloc = (void * (*) (size_t)) dlsym(RTLD_NEXT, "malloc");
- real_realloc = (void * (*) (void*,size_t)) dlsym(RTLD_NEXT, "realloc");
- real_free = (void * (*) (void*)) dlsym(RTLD_NEXT, "free");
- __mmalloc_current_heap = __mmalloc_default_mdp;
-}
+#define BUFFER_SIZE 32
+static size_t fake_alloc_index;
+static uint64_t buffer[BUFFER_SIZE];
-/* Hello pimple!
- * DL needs some memory while resolving the malloc symbol, that is somehow problematic
- * To that extend, we have a little area here living in .BSS that we return if asked for memory before the malloc is resolved.
+/* Fake implementations, they are used to fool dlsym:
+ * dlsym used calloc and falls back to some other mechanism
+ * if this fails.
*/
-static int allocated_junk = 0; /* keep track of many blocks of our little area was already given to someone */
-#define JUNK_SIZE 8
-#define MAX_JUNK_AREAS (64 * 1024 / JUNK_SIZE)
-static char junkareas[MAX_JUNK_AREAS][JUNK_SIZE];
-
-/* This version use mmalloc if there is a current heap, or the legacy implem if not */
-static void *malloc_or_calloc(size_t n, int setzero) {
- xbt_mheap_t mdp = __mmalloc_current_heap;
- void *ret;
-#ifdef MM_LEGACY_VERBOSE
- static int warned_raw = 0;
- static int warned_mmalloc = 0;
-#endif
-
- if (mdp) {
- LOCK(mdp);
- ret = mmalloc(mdp, n);
- UNLOCK(mdp);
- // This was already done by mmalloc:
- if (mdp->options & XBT_MHEAP_OPTION_MEMSET) {
- setzero = 0;
- }
-#ifdef MM_LEGACY_VERBOSE
- if (!warned_mmalloc) {
- fprintf(stderr,"Using mmalloc; enabling the model-checker in cmake may have a bad impact on your simulation performance\n");
- warned_mmalloc = 1;
- }
-#endif
- } else if (!real_malloc) {
- size_t needed_areas = n / JUNK_SIZE;
- if(needed_areas * JUNK_SIZE != n) needed_areas++;
- if (allocated_junk+needed_areas>=MAX_JUNK_AREAS) {
- fprintf(stderr,
- "Panic: real malloc symbol not resolved yet, and I already gave my little private memory chunk away.\n");
- exit(1);
- } else {
- size_t i = allocated_junk;
- allocated_junk += needed_areas;
- ret = junkareas[i];
- }
- }
- else {
-#ifdef MM_LEGACY_VERBOSE
- if (!warned_raw) {
- fprintf(stderr,"Using system malloc after interception; you seem to be currently model-checking\n");
- warned_raw = 1;
- }
-#endif
- ret = real_malloc(n);
- }
- if (ret && setzero) {
- memset(ret, 0, n);
- }
- return ret;
+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 availabel 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 *malloc(size_t n)
+static void* mm_fake_calloc(size_t nmemb, size_t size)
{
- return malloc_or_calloc(n, 0);
+ // This is fresh .bss data, we don't need to clear it:
+ size_t n = nmemb * size;
+ return mm_fake_malloc(n);
}
-void *calloc(size_t nmemb, size_t size)
+static void* mm_fake_realloc(void *p, size_t s)
{
- return malloc_or_calloc(nmemb*size, 1);
+ return mm_fake_malloc(s);
}
-void *realloc(void *p, size_t s)
+static void mm_fake_free(void *p)
{
- xbt_mheap_t mdp = __mmalloc_current_heap;
- void *ret;
+}
- if (mdp) {
- LOCK(mdp);
- ret = mrealloc(mdp, p, s);
- UNLOCK(mdp);
- } else {
- ret = real_realloc(p,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);
- return ret;
-}
+/* 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;
-void free(void *p)
+static int mm_initializing;
+static int mm_initialized;
+
+/** Constructor functions used to initialize the malloc implementation
+ */
+static void __attribute__((constructor(101))) mm_legacy_constructor()
{
- if (p==NULL)
+ if (mm_initialized)
return;
- if (p<(void*)junkareas || p>=(void*)(junkareas[MAX_JUNK_AREAS]) ) {
- // main use case
-
- xbt_mheap_t mdp = __mmalloc_current_heap;
-
- if (mdp) {
- LOCK(mdp);
- mfree(mdp, p);
- UNLOCK(mdp);
- } else {
- real_free(p);
- }
+ mm_initializing = 1;
+ __malloc_use_mmalloc = getenv(MC_ENV_VARIABLE) ? 1 : 0;
+ if (__malloc_use_mmalloc) {
+ __mmalloc_current_heap = mmalloc_preinit();
} else {
- // We are in the junkarea.
- // This area is used to allocate memory at initilization time.
-
- if(allocated_junk && p==junkareas[allocated_junk-1]) {
- // Last junkarea. We can reuse it.
- allocated_junk--;
- } else {
- // We currently cannot reuse freed junkareas in the general case.
- }
+#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
}
+ mm_initializing = 0;
+ mm_initialized = 1;
}
+/* ***** 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.
+ */
-#else /* NO GNU_LD */
-void *malloc(size_t n)
+#define GET_HEAP() __mmalloc_current_heap
+
+void* malloc_no_memset(size_t n)
{
- xbt_mheap_t mdp = __mmalloc_current_heap ?: (xbt_mheap_t) mmalloc_preinit();
+ 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);
- void *ret = mmalloc(mdp, n);
+ void *ret = mmalloc_no_memset(mdp, n);
UNLOCK(mdp);
+ return ret;
+}
+
+void *malloc(size_t n)
+{
+ 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);
+ void *ret = mmalloc(mdp, n);
+ UNLOCK(mdp);
return ret;
}
void *calloc(size_t nmemb, size_t size)
{
- xbt_mheap_t mdp = __mmalloc_current_heap ?: (xbt_mheap_t) mmalloc_preinit();
+ if (!mm_initialized) {
+ if (mm_initializing)
+ return mm_fake_calloc(nmemb, size);
+ mm_legacy_constructor();
+ }
+
+ if (!__malloc_use_mmalloc) {
+ return mm_real_calloc(nmemb, size);
+ }
+
+ 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;
}
void *realloc(void *p, size_t s)
{
- void *ret = NULL;
- xbt_mheap_t mdp = __mmalloc_current_heap ?: (xbt_mheap_t) mmalloc_preinit();
+ if (!mm_initialized) {
+ if (mm_initializing)
+ return mm_fake_realloc(p, s);
+ mm_legacy_constructor();
+ }
+
+ if (!__malloc_use_mmalloc) {
+ return mm_real_realloc(p, s);
+ }
+
+ xbt_mheap_t mdp = GET_HEAP();
+ if (!mdp)
+ return NULL;
LOCK(mdp);
- ret = mrealloc(mdp, p, s);
+ void* ret = mrealloc(mdp, p, s);
UNLOCK(mdp);
-
return ret;
}
void free(void *p)
{
- if (p != NULL) {
- xbt_mheap_t mdp = __mmalloc_current_heap ?: (xbt_mheap_t) mmalloc_preinit();
+ if (!mm_initialized) {
+ if (mm_initializing)
+ return mm_fake_free(p);
+ mm_legacy_constructor();
+ }
- LOCK(mdp);
- mfree(mdp, p);
- UNLOCK(mdp);
+ 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 /* NO GNU_LD */
-#endif /* WANT_MALLOC_OVERRIDE */
+#endif /* HAVE_MC */
