-/* 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 "mmprivate.h"
-#include "gras_config.h"
-#include <math.h>
+#include <stdlib.h>
-XBT_LOG_NEW_DEFAULT_SUBCATEGORY(xbt_mm_legacy, xbt,
- "Logging specific to mm_legacy in mmalloc");
+#include <dlfcn.h>
-static void *__mmalloc_current_heap = NULL; /* The heap we are currently using. */
+#include "src/mc/mc_base.h"
+#include "mmprivate.h"
+#include "src/xbt_modinter.h"
+#include "src/internal_config.h"
+#include <math.h>
+#include "src/mc/mc_protocol.h"
-#include "xbt_modinter.h"
+/* ***** Whether to use `mmalloc` of the undrlying malloc ***** */
-void *mmalloc_get_current_heap(void)
-{
- return __mmalloc_current_heap;
-}
+static int __malloc_use_mmalloc;
-void mmalloc_set_current_heap(void *new_heap)
+int malloc_use_mmalloc(void)
{
- __mmalloc_current_heap = new_heap;
-}
-
-#ifdef MMALLOC_WANT_OVERIDE_LEGACY
-void *malloc(size_t n)
-{
- void *mdp = __mmalloc_current_heap;
-#ifdef HAVE_MMAP
- if (!mdp)
- mmalloc_preinit();
-#endif
- LOCK(mdp);
- void *ret = mmalloc(mdp, n);
- UNLOCK(mdp);
-
- return ret;
+ return __malloc_use_mmalloc;
}
-void *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);
+/* ***** Current heap ***** */
- /* Fill the allocated memory with zeroes to mimic calloc behaviour */
- memset(ret, '\0', total_size);
+/* 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;
- return ret;
-}
+/* The heap we are currently using. */
+static xbt_mheap_t __mmalloc_current_heap = NULL;
-void *realloc(void *p, size_t s)
+xbt_mheap_t mmalloc_get_current_heap(void)
{
- 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);
- } else {
- mfree(mdp, p);
- }
- UNLOCK(mdp);
-
- return ret;
+ return __mmalloc_current_heap;
}
-void free(void *p)
+xbt_mheap_t mmalloc_set_current_heap(xbt_mheap_t new_heap)
{
- void *mdp = __mmalloc_current_heap;
-#ifdef HAVE_GTNETS
- if(!mdp) return;
-#endif
- LOCK(mdp);
- mfree(mdp, p);
- UNLOCK(mdp);
+ xbt_mheap_t heap = __mmalloc_current_heap;
+ __mmalloc_current_heap = new_heap;
+ return heap;
}
-#endif
-/* Make sure it works with md==NULL */
+/* Override the malloc-like functions if MC is activated at compile time */
+#if HAVE_MC
-/* Safety gap from the heap's break address.
- * Try to increase this first if you experience strange errors under
- * valgrind. */
-#define HEAP_OFFSET (128UL<<20)
+/* ***** Temporary allocator
+ *
+ * This is used before we have found the real malloc implementation with dlsym.
+ */
-void *mmalloc_get_default_md(void)
-{
- xbt_assert(__mmalloc_default_mdp);
- return __mmalloc_default_mdp;
-}
+#define BUFFER_SIZE 32
+static size_t fake_alloc_index;
+static uint64_t buffer[BUFFER_SIZE];
-static void mmalloc_fork_prepare(void)
+/* 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)
{
- struct mdesc* mdp = NULL;
- if ((mdp =__mmalloc_default_mdp)){
- while(mdp){
- LOCK(mdp);
- if(mdp->fd >= 0){
- mdp->refcount++;
- }
- mdp = mdp->next_mdesc;
- }
- }
+ // 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;
}
-static void mmalloc_fork_parent(void)
+static void* mm_fake_calloc(size_t nmemb, size_t size)
{
- struct mdesc* mdp = NULL;
- if ((mdp =__mmalloc_default_mdp)){
- while(mdp){
- if(mdp->fd < 0)
- UNLOCK(mdp);
- mdp = mdp->next_mdesc;
- }
- }
-}
-
-static void mmalloc_fork_child(void)
-{
- struct mdesc* mdp = NULL;
- if ((mdp =__mmalloc_default_mdp)){
- while(mdp){
- UNLOCK(mdp);
- mdp = mdp->next_mdesc;
- }
- }
+ // This is fresh .bss data, we don't need to clear it:
+ size_t n = nmemb * size;
+ return mm_fake_malloc(n);
}
-/* Initialize the default malloc descriptor. */
-void mmalloc_preinit(void)
+static void* mm_fake_realloc(void *p, size_t s)
{
- int res;
- if (!__mmalloc_default_mdp) {
- unsigned long mask = ~((unsigned long)getpagesize() - 1);
- void *addr = (void*)(((unsigned long)sbrk(0) + HEAP_OFFSET) & mask);
- __mmalloc_default_mdp = mmalloc_attach(-1, addr);
- /* Fixme? only the default mdp in protected against forks */
- res = xbt_os_thread_atfork(mmalloc_fork_prepare,
- mmalloc_fork_parent, mmalloc_fork_child);
- if (res != 0)
- THROWF(system_error,0,"xbt_os_thread_atfork() failed: return value %d",res);
- }
- xbt_assert(__mmalloc_default_mdp != NULL);
+ return mm_fake_malloc(s);
}
-void mmalloc_postexit(void)
+static void mm_fake_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);
}
-int mmalloc_compare_heap(void *h1, void *h2){
-
- if(h1 == NULL && h2 == NULL){
- XBT_DEBUG("Malloc descriptors null");
- return 0;
- }
-
- /* Heapstats */
-
- struct mstats ms1 = mmstats(h1);
- struct mstats ms2 = mmstats(h2);
-
- if(ms1.chunks_used != ms2.chunks_used){
- XBT_DEBUG("Different chunks allocated by the user : %Zu - %Zu", ms1.chunks_used, ms2.chunks_used);
- return 1;
- }
+/* 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);
- if(ms1.bytes_used != ms2.bytes_used){
- XBT_DEBUG("Different byte total of user-allocated chunks : %Zu - %Zu", ms1.bytes_used, ms2.bytes_used);
- return 1;
- }
+/* 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;
- if(ms1.bytes_free != ms2.bytes_free){
- XBT_DEBUG("Different byte total of chunks in the free list : %Zu - %Zu", ms1.bytes_free, ms2.bytes_free);
- return 1;
- }
+static int mm_initializing;
+static int mm_initialized;
- if(ms1.chunks_free != ms2.chunks_free){
- XBT_DEBUG("Different chunks in the free list : %Zu - %Zu", ms1.chunks_free, ms2.chunks_free);
- return 1;
+/** Constructor functions used to initialize the malloc implementation
+ */
+static void __attribute__((constructor(101))) mm_legacy_constructor()
+{
+ 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 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
}
-
- struct mdesc *mdp1, *mdp2;
- mdp1 = MD_TO_MDP(h1);
- mdp2 = MD_TO_MDP(h2);
-
- return mmalloc_compare_mdesc(mdp1, mdp2);
-
+ mm_initializing = 0;
+ mm_initialized = 1;
}
-int mmalloc_compare_mdesc(struct mdesc *mdp1, struct mdesc *mdp2){
+/* ***** 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.
+ */
- if(mdp1->headersize != mdp2->headersize){
- XBT_DEBUG("Different size of the file header for the mapped files");
- return 1;
- }
+#define GET_HEAP() __mmalloc_current_heap
- if(mdp1->refcount != mdp2->refcount){
- XBT_DEBUG("Different number of processes that attached the heap");
- return 1;
- }
-
- if(strcmp(mdp1->magic, mdp2->magic) != 0){
- XBT_DEBUG("Different magic number");
- return 1;
+void* malloc_no_memset(size_t n)
+{
+ if (!mm_initialized) {
+ if (mm_initializing)
+ return mm_fake_malloc(n);
+ mm_legacy_constructor();
}
- if(mdp1->flags != mdp2->flags){
- XBT_DEBUG("Different flags");
- return 1;
+ if (!__malloc_use_mmalloc) {
+ return mm_real_malloc(n);
}
- if(mdp1->heapsize != mdp2->heapsize){
- XBT_DEBUG("Different number of info entries");
- return 1;
- }
+ xbt_mheap_t mdp = GET_HEAP();
+ if (!mdp)
+ return NULL;
- //XBT_DEBUG("Heap size : %Zu", mdp1->heapsize);
+ LOCK(mdp);
+ void *ret = mmalloc_no_memset(mdp, n);
+ UNLOCK(mdp);
+ return ret;
+}
- if(mdp1->heapbase != mdp2->heapbase){
- XBT_DEBUG("Different first block of the heap");
- return 1;
+void *malloc(size_t n)
+{
+ if (!mm_initialized) {
+ if (mm_initializing)
+ return mm_fake_malloc(n);
+ mm_legacy_constructor();
}
-
- if(mdp1->heapindex != mdp2->heapindex){
- XBT_DEBUG("Different index for the heap table : %Zu - %Zu", mdp1->heapindex, mdp2->heapindex);
- return 1;
+ if (!__malloc_use_mmalloc) {
+ return mm_real_malloc(n);
}
- //XBT_DEBUG("Heap index : %Zu", mdp1->heapindex);
+ xbt_mheap_t mdp = GET_HEAP();
+ if (!mdp)
+ return NULL;
- if(mdp1->base != mdp2->base){
- XBT_DEBUG("Different base address of the memory region");
- return 1;
- }
+ LOCK(mdp);
+ void *ret = mmalloc(mdp, n);
+ UNLOCK(mdp);
+ return ret;
+}
- if(mdp1->breakval != mdp2->breakval){
- XBT_DEBUG("Different current location in the memory region");
- return 1;
+void *calloc(size_t nmemb, size_t size)
+{
+ if (!mm_initialized) {
+ if (mm_initializing)
+ return mm_fake_calloc(nmemb, size);
+ mm_legacy_constructor();
}
- if(mdp1->top != mdp2->top){
- XBT_DEBUG("Different end of the current location in the memory region");
- return 1;
- }
-
- if(mdp1->heaplimit != mdp2->heaplimit){
- XBT_DEBUG("Different limit of valid info table indices");
- return 1;
+ if (!__malloc_use_mmalloc) {
+ return mm_real_calloc(nmemb, size);
}
- //XBT_DEBUG("Heap limit : %Zu", mdp1->heaplimit);
-
+ xbt_mheap_t mdp = GET_HEAP();
+ if (!mdp)
+ return NULL;
- if(mdp1->fd != mdp2->fd){
- XBT_DEBUG("Different file descriptor for the file to which this malloc heap is mapped");
- return 1;
+ 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;
+}
- if(mdp1->saved_errno != mdp2->saved_errno){
- XBT_DEBUG("Different errno");
- return 1;
+void *realloc(void *p, size_t s)
+{
+ if (!mm_initialized) {
+ if (mm_initializing)
+ return mm_fake_realloc(p, s);
+ mm_legacy_constructor();
}
- if(mdp1->version != mdp2->version){
- XBT_DEBUG("Different version of the mmalloc package");
- return 1;
+ if (!__malloc_use_mmalloc) {
+ return mm_real_realloc(p, s);
}
-
- size_t block_free1, block_free2 , next_block_free, first_block_free, block_free ;
- size_t i, j;
- void *addr_block1, *addr_block2;
- size_t frag_size;
-
-
- /* Search index of the first free block */
-
- block_free1 = mdp1->heapindex;
- block_free2 = mdp2->heapindex;
-
- while(mdp1->heapinfo[block_free1].free.prev != 0){
- block_free1 = mdp1->heapinfo[block_free1].free.prev;
- }
+ xbt_mheap_t mdp = GET_HEAP();
+ if (!mdp)
+ return NULL;
- while(mdp2->heapinfo[block_free2].free.prev != 0){
- block_free2 = mdp1->heapinfo[block_free2].free.prev;
- }
+ LOCK(mdp);
+ void* ret = mrealloc(mdp, p, s);
+ UNLOCK(mdp);
+ return ret;
+}
- if(block_free1 != block_free2){
- XBT_DEBUG("Different first free block");
- return 1;
+void free(void *p)
+{
+ if (!mm_initialized) {
+ if (mm_initializing)
+ return mm_fake_free(p);
+ mm_legacy_constructor();
}
- first_block_free = block_free1;
-
- if(mdp1->heapinfo[first_block_free].free.size != mdp2->heapinfo[first_block_free].free.size){
- XBT_DEBUG("Different size (in blocks) of the first free cluster");
- return 1;
+ if (!__malloc_use_mmalloc) {
+ mm_real_free(p);
+ return;
}
- /* Check busy blocks (circular checking)*/
-
- i = first_block_free + mdp1->heapinfo[first_block_free].free.size;
+ if (!p)
+ return;
- if(mdp1->heapinfo[first_block_free].free.next != mdp2->heapinfo[first_block_free].free.next){
- XBT_DEBUG("Different next block free");
- return 1;
- }
-
- block_free = first_block_free;
- next_block_free = mdp1->heapinfo[first_block_free].free.next;
-
- //XBT_DEBUG("First block free : %Zu (size=%Zu), Next block free : %Zu", first_block_free, mdp1->heapinfo[block_free1].free.size, next_block_free);
-
- if(next_block_free == 0)
- next_block_free = mdp1->heaplimit;
-
-
- while(i != first_block_free){
-
- while(i<next_block_free){
-
- if(mdp1->heapinfo[i].busy.type != mdp2->heapinfo[i].busy.type){
- XBT_DEBUG("Different type of busy block");
- return 1;
- }else{
-
- addr_block1 = (char *)mdp1 + sizeof(struct mdesc) + ((i-1) * BLOCKSIZE);
- addr_block2 = (char *)mdp2 + sizeof(struct mdesc) + ((i-1) * BLOCKSIZE);
-
- switch(mdp1->heapinfo[i].busy.type){
- case 0 :
- if(mdp1->heapinfo[i].busy.info.size != mdp2->heapinfo[i].busy.info.size){
- XBT_DEBUG("Different size of a large cluster");
- return 1;
- }else{
- if(memcmp(addr_block1, addr_block2, (mdp1->heapinfo[i].busy.info.size * BLOCKSIZE)) != 0){
- XBT_DEBUG("Different data in block %Zu", i);
- return 1;
- }
- }
- i = i+mdp1->heapinfo[i].busy.info.size;
- break;
- default :
- if(mdp1->heapinfo[i].busy.info.frag.nfree != mdp2->heapinfo[i].busy.info.frag.nfree){
- XBT_DEBUG("Different free fragments in the fragmented block %Zu", i);
- return 1;
- }else{
- if(mdp1->heapinfo[i].busy.info.frag.first != mdp2->heapinfo[i].busy.info.frag.first){
- XBT_DEBUG("Different first free fragments in the block %Zu", i);
- return 1;
- }else{
- frag_size = pow(2,mdp1->heapinfo[i].busy.type);
- for(j=0 ; j< (BLOCKSIZE/frag_size); j++){
- if(memcmp((char *)addr_block1 + (j * frag_size), (char *)addr_block2 + (j * frag_size), frag_size) != 0){
- XBT_DEBUG("Different data in fragment %d of block %Zu", j + 1, i);
- return 1;
- }
- }
- }
- }
- i++;
- break;
- }
-
- }
- }
-
- if(mdp1->heapinfo[block_free].free.next != mdp2->heapinfo[block_free].free.next){
- XBT_DEBUG("Different next block free");
- return 1;
- }
-
- block_free = mdp1->heapinfo[block_free].free.next;
- next_block_free = mdp1->heapinfo[block_free].free.next;
- if(i != first_block_free){
- if(block_free != 0){
- if(mdp1->heapinfo[block_free].free.size != mdp2->heapinfo[block_free].free.size){
- XBT_DEBUG("Different size of block free");
- return 1;
- }
- i = block_free + mdp1->heapinfo[block_free].free.size;
- }else{
- i = 1;
- }
- }
-
- }
-
- return 0;
-
-
+ xbt_mheap_t mdp = GET_HEAP();
+ LOCK(mdp);
+ mfree(mdp, p);
+ UNLOCK(mdp);
}
-
-
-
-
-
+#endif /* HAVE_MC */
