Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Merge branch 'master' of git+ssh://scm.gforge.inria.fr//gitroot//simgrid/simgrid
[simgrid.git] / src / xbt / mmalloc / mm_legacy.c
index 3b581c7..3d58ba5 100644 (file)
@@ -1,4 +1,4 @@
-/* Copyright (c) 2010. The SimGrid Team.
+/* Copyright (c) 2010-2014. The SimGrid Team.
  * All rights reserved.                                                     */
 
 /* This program is free software; you can redistribute it and/or modify it
 /* Redefine the classical malloc/free/realloc functions so that they fit well in the mmalloc framework */
 
 #include "mmprivate.h"
-#include "gras_config.h"
+#include "xbt_modinter.h"
+#include "internal_config.h"
+#include <math.h>
 
-XBT_LOG_NEW_DEFAULT_SUBCATEGORY(xbt_mm_legacy, xbt,
-                                "Logging specific to mm_legacy in mmalloc");
+//#define MM_LEGACY_VERBOSE 1 /* define this to see which version of malloc gets used */
 
-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"
 
-void *mmalloc_get_current_heap(void)
+static xbt_mheap_t __mmalloc_current_heap = NULL;     /* The heap we are currently using. */
+
+xbt_mheap_t mmalloc_get_current_heap(void)
 {
   return __mmalloc_current_heap;
 }
 
-void mmalloc_set_current_heap(void *new_heap)
+void mmalloc_set_current_heap(xbt_mheap_t new_heap)
 {
   __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();
+
+#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;
+
+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;
+} 
+
+/* 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.
+ */
+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
-  LOCK(mdp);
-  void *ret = mmalloc(mdp, n);
-  UNLOCK(mdp);
 
+  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;
 }
 
-void *calloc(size_t nmemb, size_t size)
+void *malloc(size_t n)
 {
-  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);
-
-  /* Fill the allocated memory with zeroes to mimic calloc behaviour */
-  memset(ret, '\0', total_size);
+  return malloc_or_calloc(n, 0);
+}
 
-  return ret;
+void *calloc(size_t nmemb, size_t size)
+{
+  return malloc_or_calloc(nmemb*size, 1);
 }
 
 void *realloc(void *p, size_t s)
 {
-  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);
+  xbt_mheap_t mdp = __mmalloc_current_heap;
+  void *ret;
+
+  if (mdp) {
+    LOCK(mdp);
+    ret = mrealloc(mdp, p, s);
+    UNLOCK(mdp);
   } else {
-    if (p)
-      mfree(mdp, p);
+    ret = real_realloc(p,s);
   }
-  UNLOCK(mdp);
 
   return ret;
 }
 
 void free(void *p)
 {
-  void *mdp = __mmalloc_current_heap;
-#ifdef HAVE_GTNETS
-  if(!mdp) return;
-#endif
-  LOCK(mdp);
-  mfree(mdp, p);
-  UNLOCK(mdp);
-}
-#endif
-
-/* Make sure it works with md==NULL */
+  if (p==NULL)
+    return;
+  if (p<(void*)junkareas || p>=(void*)(junkareas[MAX_JUNK_AREAS]) ) {
+    // main use case
 
-/* 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)
+    xbt_mheap_t mdp = __mmalloc_current_heap;
 
-void *mmalloc_get_default_md(void)
-{
-  xbt_assert(__mmalloc_default_mdp);
-  return __mmalloc_default_mdp;
-}
-
-static void mmalloc_fork_prepare(void)
-{
-  struct mdesc* mdp = NULL;
-  if ((mdp =__mmalloc_default_mdp)){
-    while(mdp){
+    if (mdp) {
       LOCK(mdp);
-      if(mdp->fd >= 0){
-        mdp->refcount++;
-      }
-      mdp = mdp->next_mdesc;
-    }
-  }
-}
-
-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;
-    }
-  }
-}
-
-static void mmalloc_fork_child(void)
-{
-  struct mdesc* mdp = NULL;
-  if ((mdp =__mmalloc_default_mdp)){
-    while(mdp){
+      mfree(mdp, p);
       UNLOCK(mdp);
-      mdp = mdp->next_mdesc;
+    } else {
+      real_free(p);
+    }
+  } 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.
     }
   }
 }
 
-/* Initialize the default malloc descriptor. */
-void mmalloc_preinit(void)
-{
-  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);
-}
 
-void mmalloc_postexit(void)
+#else /* NO GNU_LD */
+void *malloc(size_t n)
 {
-  /* 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);
-}
+  xbt_mheap_t mdp = __mmalloc_current_heap ?: (xbt_mheap_t) mmalloc_preinit();
 
-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.bytes_total !=  ms2.bytes_total){
-    XBT_DEBUG("Different total size of the heap");
-    return 1;
-  }
-
-  if(ms1.chunks_used !=  ms2.chunks_used){
-    XBT_DEBUG("Different chunks allocated by the user");
-    return 1;
-  }
-
-  if(ms1.bytes_used !=  ms2.bytes_used){
-    XBT_DEBUG("Different byte total of user-allocated chunks");
-    return 1;
-  }
-
-  if(ms1.bytes_free !=  ms2.bytes_free){
-    XBT_DEBUG("Different byte total of chunks in the free list");
-    return 1;
-  }
-
-  if(ms1.chunks_free !=  ms2.chunks_free){
-    XBT_DEBUG("Different chunks in the free list");
-    return 1;
-  }
+  LOCK(mdp);
+  void *ret = mmalloc(mdp, n);
+  UNLOCK(mdp);
 
-  struct mdesc *mdp1, *mdp2;
-  mdp1 = MD_TO_MDP(h1);
-  mdp2 = MD_TO_MDP(h2);
-  
-  if(mmalloc_compare_mdesc(mdp1, mdp2))
-    return 1;
-  
 
-  return 0;
+  return ret;
 }
 
-int mmalloc_compare_mdesc(struct mdesc *mdp1, struct mdesc *mdp2){
-
-   if(mdp1->headersize != mdp2->headersize){
-    XBT_DEBUG("Different size of the file header for the mapped files");
-    return 1;
-  }
-
-  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;
-  }
-
-  if(mdp1->flags != mdp2->flags){
-    XBT_DEBUG("Different flags");
-    return 1;
-  }
-
-  if(mdp1->heapsize != mdp2->heapsize){
-    XBT_DEBUG("Different number of info entries");
-    return 1;
-  }
-
-  //XBT_DEBUG("Heap size : %d", mdp1->heapsize);
-
-  if(mdp1->heapbase != mdp2->heapbase){
-    XBT_DEBUG("Different first block of the heap");
-    return 1;
-  }
-
-  if(mdp1->heapindex != mdp2->heapindex){
-    XBT_DEBUG("Different index for the heap table");
-    return 1;
-  }
-
-  XBT_DEBUG("Heap index : %d", mdp1->heapindex);
-
-  if(mdp1->base != mdp2->base){
-    XBT_DEBUG("Different base address of the memory region");
-    return 1;
-  }
+void *calloc(size_t nmemb, size_t size)
+{
+  xbt_mheap_t mdp = __mmalloc_current_heap ?: (xbt_mheap_t) mmalloc_preinit();
 
-  if(mdp1->breakval != mdp2->breakval){
-    XBT_DEBUG("Different current location in the memory region");
-    return 1;
-  }
+  LOCK(mdp);
+  void *ret = mmalloc(mdp, nmemb*size);
+  UNLOCK(mdp);
 
-  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;
+  // This was already done in the callee:
+  if(!(mdp->options & XBT_MHEAP_OPTION_MEMSET)) {
+    memset(ret, 0, nmemb * size);
   }
 
-  //XBT_DEBUG("Heap limit : %d", mdp1->heaplimit);
-
-
-  if(mdp1->fd != mdp2->fd){
-    XBT_DEBUG("Different file descriptor for the file to which this malloc heap is mapped");
-    return 1;
-  }
+  return ret;
+}
 
-  if(mdp1->saved_errno != mdp2->saved_errno){
-    XBT_DEBUG("Different errno");
-    return 1;
-  }
+void *realloc(void *p, size_t s)
+{
+  void *ret = NULL;
+  xbt_mheap_t mdp = __mmalloc_current_heap ?: (xbt_mheap_t) mmalloc_preinit();
 
-  if(mdp1->version != mdp2->version){
-    XBT_DEBUG("Different version of the mmalloc package");
-    return 1;
-  }
+  LOCK(mdp);
+  ret = mrealloc(mdp, p, s);
+  UNLOCK(mdp);
 
-  size_t block_free1, start1, block_free2 , start2, block_busy1, block_busy2 ;
-  unsigned int i;
-
-  start1 = block_free1 = mdp1->heapindex; 
-  start2 = block_free2 = mdp2->heapindex;
-  block_busy1 = start1 + mdp1->heapinfo[start1].free.size;
-  block_busy2 = start2 + mdp2->heapinfo[start2].free.size;
-
-  //XBT_DEBUG("Block busy : %d - %d", block_busy1, block_busy2);
-
-
-  if(mdp1->heapinfo[start1].free.size != mdp2->heapinfo[start2].free.size){ // <=> check block_busy
-    
-    XBT_DEBUG("Different size (in blocks) of a free cluster");
-    return 1;
-
-  }else{
-
-    if(mdp1->heapinfo[start1].free.next != mdp2->heapinfo[start1].free.next){
-
-      XBT_DEBUG("Different index of next free cluster");
-      return 1;
-
-    }else{
-   
-      for(i=block_busy1 ; i<mdp1->heapinfo[start1].free.next ; i++){
-       if(mdp1->heapinfo[i].busy.type != mdp2->heapinfo[i].busy.type){
-         XBT_DEBUG("Different type of busy block");
-         return 1;
-       }else{
-         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;
-           }
-           break;
-         default :       
-           if(mdp1->heapinfo[i].busy.info.frag.nfree != mdp2->heapinfo[i].busy.info.frag.nfree){
-             XBT_DEBUG("Different free fragments in a fragmented block");
-             return 1;
-           }else{
-             if(mdp1->heapinfo[i].busy.info.frag.first != mdp2->heapinfo[i].busy.info.frag.first){
-               XBT_DEBUG("Different first free fragments of the block");
-               return 1; 
-             }
-           }
-           break;
-         }
-       } 
-      }
-    }
+  return ret;
+}
 
-    block_free1 = mdp1->heapinfo[start1].free.next;
-    block_free2 = mdp2->heapinfo[start2].free.next;
-
-    //XBT_DEBUG("Index of next free cluster : %d", block_free1);
-
-    while((block_free1 != start1) && (block_free2 != start2)){ 
-
-      block_busy1 = block_free1 + mdp1->heapinfo[block_free1].free.size;
-      block_busy2 = block_free2 + mdp2->heapinfo[block_free2].free.size;
-
-      if(block_busy1 != block_busy2){
-       XBT_DEBUG("Different index of busy block");
-       return 1;
-      }else{
-
-       //XBT_DEBUG("Index of next busy block : %d - %d", block_busy1, block_busy2);
-       //XBT_DEBUG("Index of next free cluster : %d", mdp1->heapinfo[block_free1].free.next);
-       
-       for(i=block_busy1 ; i<mdp1->heapinfo[block_free1].free.next ; i++){
-         if(mdp1->heapinfo[i].busy.type != mdp2->heapinfo[i].busy.type){
-           XBT_DEBUG("Different type of busy block");
-           return 1;
-         }else{
-           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;
-             }
-             break;
-           default :     
-             if(mdp1->heapinfo[i].busy.info.frag.nfree != mdp2->heapinfo[i].busy.info.frag.nfree){
-               XBT_DEBUG("Different free fragments in a fragmented block");
-               return 1;
-             }else{
-               if(mdp1->heapinfo[i].busy.info.frag.first != mdp2->heapinfo[i].busy.info.frag.first){
-                 XBT_DEBUG("Different first free fragments of the block");
-                 return 1; 
-               }
-             }
-             break;
-           }
-         } 
-       }
-      }
+void free(void *p)
+{
+  if (p != NULL) {
+    xbt_mheap_t mdp = __mmalloc_current_heap ?: (xbt_mheap_t) mmalloc_preinit();
 
-      block_free1 = mdp1->heapinfo[block_free1].free.next;
-      block_free2 = mdp2->heapinfo[block_free2].free.next;
-      
-    } 
-    
+    LOCK(mdp);
+    mfree(mdp, p);
+    UNLOCK(mdp);
   }
-  
-  
-  return 0;   
-  
-  
-  
 }
-
-  
-  
-
+#endif /* NO GNU_LD */
+#endif /* WANT_MALLOC_OVERRIDE */