Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
codacy
[simgrid.git] / src / xbt / mmalloc / mmalloc.c
index e6f796d..35baa0f 100644 (file)
@@ -1,15 +1,16 @@
-/* Memory allocator `malloc'.
-   Copyright 1990, 1991, 1992 Free Software Foundation
+/* Memory allocator `malloc'. */
 
-   Written May 1989 by Mike Haertel.
-   Heavily modified Mar 1992 by Fred Fish for mmap'd version. */
-
-/* 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. */
 
+/* Copyright 1990, 1991, 1992 Free Software Foundation
+
+   Written May 1989 by Mike Haertel.
+   Heavily modified Mar 1992 by Fred Fish for mmap'd version. */
+
 #include <string.h>             /* Prototypes for memcpy, memmove, memset, etc */
 #include <stdio.h>
 #include "mmprivate.h"
@@ -32,7 +33,7 @@ static void *align(struct mdesc *mdp, size_t size)
   result = mmorecore(mdp, size);
 
   /* if this reservation does not fill up the last block of our resa,
-   * complete the reservation by also asking for the full lastest block.
+   * complete the reservation by also asking for the full latest block.
    *
    * Also, the returned block is aligned to the end of block (but I've
    * no fucking idea of why, actually -- http://abstrusegoose.com/432 --
@@ -47,78 +48,132 @@ static void *align(struct mdesc *mdp, size_t size)
   return (result);
 }
 
+/** Initialise heapinfo about the heapinfo pages :)
+ *
+ */
+static void initialize_heapinfo_heapinfo(xbt_mheap_t mdp)
+{
+  // Update heapinfo about the heapinfo pages (!):
+  xbt_assert((uintptr_t) mdp->heapinfo % BLOCKSIZE == 0);
+  int block = BLOCK(mdp->heapinfo);
+  size_t nblocks = mdp->heapsize * sizeof(malloc_info) / BLOCKSIZE;
+  // Mark them as free:
+  for (size_t j=0; j!=nblocks; ++j) {
+    mdp->heapinfo[block+j].type = MMALLOC_TYPE_FREE;
+    mdp->heapinfo[block+j].free_block.size = 0;
+    mdp->heapinfo[block+j].free_block.next = 0;
+    mdp->heapinfo[block+j].free_block.prev = 0;
+  }
+  mdp->heapinfo[block].free_block.size = nblocks;
+}
+
 /* Finish the initialization of the mheap. If we want to inline it
  * properly, we need to make the align function publicly visible, too  */
 static void initialize(xbt_mheap_t mdp)
 {
+  int i;
+  malloc_info mi; /* to compute the offset of the swag hook */
+
+  // Update mdp meta-data:
   mdp->heapsize = HEAP / BLOCKSIZE;
   mdp->heapinfo = (malloc_info *)
     align(mdp, mdp->heapsize * sizeof(malloc_info));
+  mdp->heapbase = (void *) mdp->heapinfo;
+  mdp->flags |= MMALLOC_INITIALIZED;
 
+  // Update root heapinfo:
   memset((void *) mdp->heapinfo, 0, mdp->heapsize * sizeof(malloc_info));
-  mdp->heapinfo[0].type=-1;
+  mdp->heapinfo[0].type = MMALLOC_TYPE_FREE;
   mdp->heapinfo[0].free_block.size = 0;
   mdp->heapinfo[0].free_block.next = mdp->heapinfo[0].free_block.prev = 0;
   mdp->heapindex = 0;
-  mdp->heapbase = (void *) mdp->heapinfo;
-  mdp->flags |= MMALLOC_INITIALIZED;
+
+  initialize_heapinfo_heapinfo(mdp);
+
+  for (i=0;i<BLOCKLOG;i++) {
+      xbt_swag_init(&(mdp->fraghead[i]),
+                    xbt_swag_offset(mi, freehook));
+  }
 }
 
+#define update_hook(a,offset) do { if (a) { a = ((char*)a +(offset));} }while(0)
+
 /* Get neatly aligned memory from the low level layers, and register it
  * into the heap info table as necessary. */
 static void *register_morecore(struct mdesc *mdp, size_t size)
 {
-  void *result;
-  malloc_info *newinfo, *oldinfo;
-  size_t newsize;
-
-  result = align(mdp, size); // Never returns NULL
+  void* result = align(mdp, size); // Never returns NULL
 
   /* Check if we need to grow the info table (in a multiplicative manner)  */
   if ((size_t) BLOCK((char *) result + size) > mdp->heapsize) {
     int it;
 
-    newsize = mdp->heapsize;
+    size_t newsize = mdp->heapsize;
     while ((size_t) BLOCK((char *) result + size) > newsize)
       newsize *= 2;
 
     /* Copy old info into new location */
-    oldinfo = mdp->heapinfo;
-    newinfo = (malloc_info *) align(mdp, newsize * sizeof(malloc_info));
-    memset(newinfo, 0, newsize * sizeof(malloc_info));
+    malloc_info* oldinfo = mdp->heapinfo;
+    malloc_info* newinfo = (malloc_info*)align(mdp, newsize * sizeof(malloc_info));
     memcpy(newinfo, oldinfo, mdp->heapsize * sizeof(malloc_info));
+
+    /* Initialise the new blockinfo : */
+    memset((char*) newinfo + mdp->heapsize * sizeof(malloc_info), 0,
+      (newsize - mdp->heapsize)* sizeof(malloc_info));
+
+    /* Update the swag of busy blocks containing free fragments by applying the offset to all swag_hooks. Yeah. My hand is right in the fan and I still type */
+    size_t offset=((char*)newinfo)-((char*)oldinfo);
+
+    for (int i = 1 /*first element of heapinfo describes the mdesc area*/; i < mdp->heaplimit; i++) {
+      update_hook(newinfo[i].freehook.next,offset);
+      update_hook(newinfo[i].freehook.prev,offset);
+    }
+    // also update the starting points of the swag
+    for (int i = 0; i < BLOCKLOG; i++) {
+      update_hook(mdp->fraghead[i].head,offset);
+      update_hook(mdp->fraghead[i].tail,offset);
+    }
     mdp->heapinfo = newinfo;
 
     /* mark the space previously occupied by the block info as free by first marking it
      * as occupied in the regular way, and then freing it */
-    for (it=0; it<BLOCKIFY(mdp->heapsize * sizeof(malloc_info)); it++)
-      newinfo[BLOCK(oldinfo)+it].type = 0;
+    for (it=0; it<BLOCKIFY(mdp->heapsize * sizeof(malloc_info)); it++){
+      newinfo[BLOCK(oldinfo)+it].type = MMALLOC_TYPE_UNFRAGMENTED;
+      newinfo[BLOCK(oldinfo)+it].busy_block.ignore = 0;
+    }
 
     newinfo[BLOCK(oldinfo)].busy_block.size = BLOCKIFY(mdp->heapsize * sizeof(malloc_info));
     newinfo[BLOCK(oldinfo)].busy_block.busy_size = size;
-    newinfo[BLOCK(oldinfo)].busy_block.bt_size = 0;// FIXME setup the backtrace
     mfree(mdp, (void *) oldinfo);
     mdp->heapsize = newsize;
+
+    initialize_heapinfo_heapinfo(mdp);
   }
 
   mdp->heaplimit = BLOCK((char *) result + size);
   return (result);
 }
+#undef update_hook
 
 /* Allocate memory from the heap.  */
-
-void *mmalloc(xbt_mheap_t mdp, size_t size)
+void *mmalloc(xbt_mheap_t mdp, size_t size) {
+  void *res= mmalloc_no_memset(mdp,size);
+  if (mdp->options & XBT_MHEAP_OPTION_MEMSET) {
+    memset(res,0,size);
+  }
+  return res;
+}
+/* Spliting mmalloc this way is mandated by a trick in mrealloc, that gives
+   back the memory of big blocks to the system before reallocating them: we don't
+   want to loose the beginning of the area when this happens */
+void *mmalloc_no_memset(xbt_mheap_t mdp, size_t size)
 {
   void *result;
-  size_t block, blocks, lastblocks, start;
-  register size_t i;
-  struct list *next;
-  register size_t log;
-  int it;
+  size_t block;
 
   size_t requested_size = size; // The amount of memory requested by user, for real
 
-  /* Work even if the user was stupid enough to ask a ridicullously small block (even 0-length),
+  /* Work even if the user was stupid enough to ask a ridiculously small block (even 0-length),
    *    ie return a valid block that can be realloced and freed.
    * glibc malloc does not use this trick but return a constant pointer, but we need to enlist the free fragments later on.
    */
@@ -130,77 +185,80 @@ void *mmalloc(xbt_mheap_t mdp, size_t size)
   if (!(mdp->flags & MMALLOC_INITIALIZED))
     initialize(mdp);
 
+  mmalloc_paranoia(mdp);
+
   /* Determine the allocation policy based on the request size.  */
   if (size <= BLOCKSIZE / 2) {
     /* Small allocation to receive a fragment of a block.
        Determine the logarithm to base two of the fragment size. */
-    log = 1;
+    size_t log = 1;
     --size;
     while ((size /= 2) != 0) {
       ++log;
     }
 
-    /* Look in the fragment lists for a
-       free fragment of the desired size. */
-    next = mdp->fraghead[log].next;
-    if (next != NULL) {
-      /* There are free fragments of this size.
-         Pop a fragment out of the fragment list and return it.
-         Update the block's nfree and first counters. */
-      int frag_nb;
-      result = (void *) next;
-      block = BLOCK(result);
-
-      frag_nb = RESIDUAL(result, BLOCKSIZE) >> log;
-      mdp->heapinfo[block].busy_frag.frag_size[frag_nb] = requested_size;
-      xbt_backtrace_no_malloc(mdp->heapinfo[block].busy_frag.bt[frag_nb],XBT_BACKTRACE_SIZE);
-
-      next->prev->next = next->next;
-      if (next->next != NULL) {
-        next->next->prev = next->prev;
-      }
-      if (--mdp->heapinfo[block].busy_frag.nfree != 0) {
-        mdp->heapinfo[block].busy_frag.first =
-          RESIDUAL(next->next, BLOCKSIZE) >> log;
+    /* Look in the fragment lists for a free fragment of the desired size. */
+    if (xbt_swag_size(&mdp->fraghead[log])>0) {
+      /* There are free fragments of this size; Get one of them and prepare to return it.
+         Update the block's nfree and if no other free fragment, get out of the swag. */
+
+      /* search a fragment that I could return as a result */
+      malloc_info *candidate_info = xbt_swag_getFirst(&mdp->fraghead[log]);
+      size_t candidate_block = (candidate_info - &(mdp->heapinfo[0]));
+      size_t candidate_frag;
+      for (candidate_frag=0;candidate_frag<(size_t) (BLOCKSIZE >> log);candidate_frag++)
+        if (candidate_info->busy_frag.frag_size[candidate_frag] == -1)
+          break;
+      xbt_assert(candidate_frag < (size_t) (BLOCKSIZE >> log),
+          "Block %zu was registered as containing free fragments of type %zu, but I can't find any",candidate_block,log);
+
+      result = (void*) (((char*)ADDRESS(candidate_block)) + (candidate_frag << log));
+
+      /* Remove this fragment from the list of free guys */
+      candidate_info->busy_frag.nfree--;
+      if (candidate_info->busy_frag.nfree == 0) {
+        xbt_swag_remove(candidate_info,&mdp->fraghead[log]);
       }
 
+      /* Update our metadata about this fragment */
+      candidate_info->busy_frag.frag_size[candidate_frag] = requested_size;
+      candidate_info->busy_frag.ignore[candidate_frag] = 0;
+      //xbt_backtrace_no_malloc(candidate_info->busy_frag.bt[candidate_frag],XBT_BACKTRACE_SIZE);
+      //xbt_libunwind_backtrace(candidate_info->busy_frag.bt[candidate_frag],XBT_BACKTRACE_SIZE);
+
       /* Update the statistics.  */
       mdp -> heapstats.chunks_used++;
       mdp -> heapstats.bytes_used += 1 << log;
       mdp -> heapstats.chunks_free--;
       mdp -> heapstats.bytes_free -= 1 << log;
 
-      memset(result, 0, requested_size);
-      
     } else {
       /* No free fragments of the desired size, so get a new block
          and break it into fragments, returning the first.  */
-      //printf("(%s) No free fragment...",xbt_thread_self_name());
 
       result = mmalloc(mdp, BLOCKSIZE); // does not return NULL
-      memset(result, 0, requested_size);
-
-      /* Link all fragments but the first into the free list, and mark their requested size to 0.  */
       block = BLOCK(result);
+
+      mdp->heapinfo[block].type = log;
+      /* Link all fragments but the first as free, and add the block to the swag of blocks containing free frags  */
+      size_t i;
       for (i = 1; i < (size_t) (BLOCKSIZE >> log); ++i) {
-        mdp->heapinfo[block].busy_frag.frag_size[i] = 0;
-        mdp->heapinfo[block].busy_frag.equal_to[i] = -1;
-        next = (struct list *) ((char *) result + (i << log));
-        next->next = mdp->fraghead[log].next;
-        next->prev = &mdp->fraghead[log];
-        next->prev->next = next;
-        if (next->next != NULL) {
-          next->next->prev = next;
-        }
+        mdp->heapinfo[block].busy_frag.frag_size[i] = -1;
+        mdp->heapinfo[block].busy_frag.ignore[i] = 0;
       }
-      mdp->heapinfo[block].busy_frag.frag_size[0] = requested_size;
-      xbt_backtrace_no_malloc(mdp->heapinfo[block].busy_frag.bt[0],XBT_BACKTRACE_SIZE);
-      
-      /* Initialize the nfree and first counters for this block.  */
-      mdp->heapinfo[block].type = log;
       mdp->heapinfo[block].busy_frag.nfree = i - 1;
-      mdp->heapinfo[block].busy_frag.first = i - 1;
+      mdp->heapinfo[block].freehook.prev = NULL;
+      mdp->heapinfo[block].freehook.next = NULL;
 
+      xbt_swag_insert(&mdp->heapinfo[block], &(mdp->fraghead[log]));
+
+      /* mark the fragment returned as busy */
+      mdp->heapinfo[block].busy_frag.frag_size[0] = requested_size;
+      mdp->heapinfo[block].busy_frag.ignore[0] = 0;
+      //xbt_backtrace_no_malloc(mdp->heapinfo[block].busy_frag.bt[0],XBT_BACKTRACE_SIZE);
+      //xbt_libunwind_backtrace(mdp->heapinfo[block].busy_frag.bt[0],XBT_BACKTRACE_SIZE);
+
+      /* update stats */
       mdp -> heapstats.chunks_free += (BLOCKSIZE >> log) - 1;
       mdp -> heapstats.bytes_free += BLOCKSIZE - (1 << log);
       mdp -> heapstats.bytes_used -= BLOCKSIZE - (1 << log);
@@ -210,8 +268,8 @@ void *mmalloc(xbt_mheap_t mdp, size_t size)
        Search the free list in a circle starting at the last place visited.
        If we loop completely around without finding a large enough
        space we will have to get more memory from the system.  */
-    blocks = BLOCKIFY(size);
-    start = block = MALLOC_SEARCH_START;
+    size_t blocks = BLOCKIFY(size);
+    size_t start = block = MALLOC_SEARCH_START;
     while (mdp->heapinfo[block].free_block.size < blocks) {
       if (mdp->heapinfo[block].type >=0) { // Don't trust xbt_die and friends in malloc-level library, you fool!
         fprintf(stderr,"Internal error: found a free block not marked as such (block=%lu type=%lu). Please report this bug.\n",(unsigned long)block,(unsigned long)mdp->heapinfo[block].type);
@@ -224,7 +282,7 @@ void *mmalloc(xbt_mheap_t mdp, size_t size)
            the new core will be contiguous with the final free
            block; if so we don't need to get as much.  */
         block = mdp->heapinfo[0].free_block.prev;
-        lastblocks = mdp->heapinfo[block].free_block.size;
+        size_t lastblocks = mdp->heapinfo[block].free_block.size;
         if (mdp->heaplimit != 0 &&
             block + lastblocks == mdp->heaplimit &&
             mmorecore(mdp, 0) == ADDRESS(block + lastblocks) &&
@@ -238,17 +296,21 @@ void *mmalloc(xbt_mheap_t mdp, size_t size)
           continue;
         }
         result = register_morecore(mdp, blocks * BLOCKSIZE);
-        memset(result, 0, requested_size);
 
         block = BLOCK(result);
-        for (it=0;it<blocks;it++){
-          mdp->heapinfo[block+it].type = 0;
+        for (int it = 0; it < blocks; it++) {
+          mdp->heapinfo[block + it].type                 = MMALLOC_TYPE_UNFRAGMENTED;
+          mdp->heapinfo[block + it].busy_block.busy_size = 0;
+          mdp->heapinfo[block + it].busy_block.ignore    = 0;
+          mdp->heapinfo[block + it].busy_block.size      = 0;
         }
         mdp->heapinfo[block].busy_block.size = blocks;
         mdp->heapinfo[block].busy_block.busy_size = requested_size;
-        mdp->heapinfo[block].busy_block.bt_size=xbt_backtrace_no_malloc(mdp->heapinfo[block].busy_block.bt,XBT_BACKTRACE_SIZE);
+        //mdp->heapinfo[block].busy_block.bt_size=xbt_backtrace_no_malloc(mdp->heapinfo[block].busy_block.bt,XBT_BACKTRACE_SIZE);
+        //mdp->heapinfo[block].busy_block.bt_size = xbt_libunwind_backtrace(mdp->heapinfo[block].busy_block.bt,XBT_BACKTRACE_SIZE);
         mdp -> heapstats.chunks_used++;
         mdp -> heapstats.bytes_used += blocks * BLOCKSIZE;
+
         return result;
       }
       /* Need large block(s), but found some in the existing heap */
@@ -278,18 +340,23 @@ void *mmalloc(xbt_mheap_t mdp, size_t size)
         = mdp->heapindex = mdp->heapinfo[block].free_block.next;
     }
 
-    for (it=0;it<blocks;it++){
-      mdp->heapinfo[block+it].type = 0;
+    for (int it = 0; it < blocks; it++) {
+      mdp->heapinfo[block+it].type = MMALLOC_TYPE_UNFRAGMENTED;
+      mdp->heapinfo[block+it].busy_block.busy_size = 0;
+      mdp->heapinfo[block+it].busy_block.ignore = 0;
+      mdp->heapinfo[block+it].busy_block.size = 0;
     }
     mdp->heapinfo[block].busy_block.size = blocks;
     mdp->heapinfo[block].busy_block.busy_size = requested_size;
-    //mdp->heapinfo[block].busy_block.bt_size = 0;
-    mdp->heapinfo[block].busy_block.bt_size = xbt_backtrace_no_malloc(mdp->heapinfo[block].busy_block.bt,XBT_BACKTRACE_SIZE);
+    //mdp->heapinfo[block].busy_block.bt_size = xbt_backtrace_no_malloc(mdp->heapinfo[block].busy_block.bt,XBT_BACKTRACE_SIZE);
+    //mdp->heapinfo[block].busy_block.bt_size = xbt_libunwind_backtrace(mdp->heapinfo[block].busy_block.bt,XBT_BACKTRACE_SIZE);
 
     mdp -> heapstats.chunks_used++;
     mdp -> heapstats.bytes_used += blocks * BLOCKSIZE;
     mdp -> heapstats.bytes_free -= blocks * BLOCKSIZE;
+
   }
   //printf("(%s) Done mallocing. Result is %p\n",xbt_thread_self_name(),result);fflush(stdout);
+
   return (result);
 }