src/xbt/mmalloc/mmalloc.c

   1 /* Memory allocator `malloc'.
   2    Copyright 1990, 1991, 1992 Free Software Foundation
   3
   4    Written May 1989 by Mike Haertel.
   5    Heavily modified Mar 1992 by Fred Fish for mmap'd version. */
   6
   7 /* Copyright (c) 2010. The SimGrid Team.
   8  * All rights reserved.                                                     */
   9
  10 /* This program is free software; you can redistribute it and/or modify it
  11  * under the terms of the license (GNU LGPL) which comes with this package. */
  12
  13 #include <string.h>             /* Prototypes for memcpy, memmove, memset, etc */
  14 #include <stdio.h>
  15 #include "mmprivate.h"
  16
  17 /* Prototypes for local functions */
  18
  19 static void initialize(xbt_mheap_t mdp);
  20 static void *register_morecore(xbt_mheap_t mdp, size_t size);
  21 static void *align(xbt_mheap_t mdp, size_t size);
  22
  23 /* Allocation aligned on block boundary.
  24  *
  25  * It never returns NULL, but dies verbosely on error.
  26  */
  27 static void *align(struct mdesc *mdp, size_t size)
  28 {
  29   void *result;
  30   unsigned long int adj;
  31
  32   result = mmorecore(mdp, size);
  33
  34   /* if this reservation does not fill up the last block of our resa,
  35    * complete the reservation by also asking for the full lastest block.
  36    *
  37    * Also, the returned block is aligned to the end of block (but I've
  38    * no fucking idea of why, actually -- http://abstrusegoose.com/432 --
  39    * but not doing so seems to lead to issues).
  40    */
  41   adj = RESIDUAL(result, BLOCKSIZE);
  42   if (adj != 0) {
  43     adj = BLOCKSIZE - adj;
  44     mmorecore(mdp, adj);
  45     result = (char *) result + adj;
  46   }
  47   return (result);
  48 }
  49
  50 /* Finish the initialization of the mheap. If we want to inline it
  51  * properly, we need to make the align function publicly visible, too  */
  52 static void initialize(xbt_mheap_t mdp)
  53 {
  54   mdp->heapsize = HEAP / BLOCKSIZE;
  55   mdp->heapinfo = (malloc_info *)
  56       align(mdp, mdp->heapsize * sizeof(malloc_info));
  57
  58   memset((void *) mdp->heapinfo, 0, mdp->heapsize * sizeof(malloc_info));
  59   mdp->heapinfo[0].type=-1;
  60   mdp->heapinfo[0].free_block.size = 0;
  61   mdp->heapinfo[0].free_block.next = mdp->heapinfo[0].free_block.prev = 0;
  62   mdp->heapindex = 0;
  63   mdp->heapbase = (void *) mdp->heapinfo;
  64   mdp->flags |= MMALLOC_INITIALIZED;
  65 }
  66
  67 /* Get neatly aligned memory from the low level layers, and register it
  68  * into the heap info table as necessary. */
  69 static void *register_morecore(struct mdesc *mdp, size_t size)
  70 {
  71   void *result;
  72   malloc_info *newinfo, *oldinfo;
  73   size_t newsize;
  74
  75   result = align(mdp, size); // Never returns NULL
  76
  77   /* Check if we need to grow the info table (in a multiplicative manner)  */
  78   if ((size_t) BLOCK((char *) result + size) > mdp->heapsize) {
  79         int it;
  80
  81     newsize = mdp->heapsize;
  82     while ((size_t) BLOCK((char *) result + size) > newsize)
  83       newsize *= 2;
  84
  85     /* Copy old info into new location */
  86     oldinfo = mdp->heapinfo;
  87     newinfo = (malloc_info *) align(mdp, newsize * sizeof(malloc_info));
  88     memset(newinfo, 0, newsize * sizeof(malloc_info));
  89     memcpy(newinfo, oldinfo, mdp->heapsize * sizeof(malloc_info));
  90     mdp->heapinfo = newinfo;
  91
  92     /* mark the space previously occupied by the block info as free by first marking it
  93      * as occupied in the regular way, and then freing it */
  94     for (it=0; it<BLOCKIFY(mdp->heapsize * sizeof(malloc_info)); it++)
  95         newinfo[BLOCK(oldinfo)+it].type = 0;
  96
  97     newinfo[BLOCK(oldinfo)].busy_block.size = BLOCKIFY(mdp->heapsize * sizeof(malloc_info));
  98     newinfo[BLOCK(oldinfo)].busy_block.busy_size = size;
  99     mfree(mdp, (void *) oldinfo);
 100     mdp->heapsize = newsize;
 101   }
 102
 103   mdp->heaplimit = BLOCK((char *) result + size);
 104   return (result);
 105 }
 106
 107 /* Allocate memory from the heap.  */
 108
 109 void *mmalloc(xbt_mheap_t mdp, size_t size)
 110 {
 111   void *result;
 112   size_t block, blocks, lastblocks, start;
 113   register size_t i;
 114   struct list *next;
 115   register size_t log;
 116   int it;
 117
 118   size_t requested_size = size; // The amount of memory requested by user, for real
 119
 120   /* Work even if the user was stupid enough to ask a ridicullously small block (even 0-length),
 121    *    ie return a valid block that can be realloced and freed.
 122    * glibc malloc does not use this trick but return a constant pointer, but we need to enlist the free fragments later on.
 123    */
 124   if (size < SMALLEST_POSSIBLE_MALLOC)
 125     size = SMALLEST_POSSIBLE_MALLOC;
 126
 127 //  printf("(%s) Mallocing %d bytes on %p (default: %p)...",xbt_thread_self_name(),size,mdp,__mmalloc_default_mdp);fflush(stdout);
 128
 129   if (!(mdp->flags & MMALLOC_INITIALIZED))
 130           initialize(mdp);
 131
 132   /* Determine the allocation policy based on the request size.  */
 133   if (size <= BLOCKSIZE / 2) {
 134     /* Small allocation to receive a fragment of a block.
 135        Determine the logarithm to base two of the fragment size. */
 136     log = 1;
 137     --size;
 138     while ((size /= 2) != 0) {
 139       ++log;
 140     }
 141
 142     /* Look in the fragment lists for a
 143        free fragment of the desired size. */
 144     next = mdp->fraghead[log].next;
 145     if (next != NULL) {
 146       /* There are free fragments of this size.
 147          Pop a fragment out of the fragment list and return it.
 148          Update the block's nfree and first counters. */
 149       int frag_nb;
 150       result = (void *) next;
 151       block = BLOCK(result);
 152
 153       frag_nb = RESIDUAL(result, BLOCKSIZE) >> log;
 154       mdp->heapinfo[block].busy_frag.frag_size[frag_nb] = requested_size;
 155       //FIXME setup backtrace
 156
 157       next->prev->next = next->next;
 158       if (next->next != NULL) {
 159         next->next->prev = next->prev;
 160       }
 161       if (--mdp->heapinfo[block].busy_frag.nfree != 0) {
 162         mdp->heapinfo[block].busy_frag.first =
 163             RESIDUAL(next->next, BLOCKSIZE) >> log;
 164       }
 165
 166     } else {
 167       /* No free fragments of the desired size, so get a new block
 168          and break it into fragments, returning the first.  */
 169       //printf("(%s) No free fragment...",xbt_thread_self_name());
 170
 171       result = mmalloc(mdp, BLOCKSIZE); // does not return NULL
 172
 173       /* Link all fragments but the first into the free list, and mark their requested size to 0.  */
 174       block = BLOCK(result);
 175       for (i = 1; i < (size_t) (BLOCKSIZE >> log); ++i) {
 176         mdp->heapinfo[block].busy_frag.frag_size[i] = 0;
 177         next = (struct list *) ((char *) result + (i << log));
 178         next->next = mdp->fraghead[log].next;
 179         next->prev = &mdp->fraghead[log];
 180         next->prev->next = next;
 181         if (next->next != NULL) {
 182           next->next->prev = next;
 183         }
 184       }
 185           mdp->heapinfo[block].busy_frag.frag_size[0] = requested_size;
 186           // FIXME: setup backtrace
 187
 188       /* Initialize the nfree and first counters for this block.  */
 189       mdp->heapinfo[block].type = log;
 190       mdp->heapinfo[block].busy_frag.nfree = i - 1;
 191       mdp->heapinfo[block].busy_frag.first = i - 1;
 192     }
 193   } else {
 194     /* Large allocation to receive one or more blocks.
 195        Search the free list in a circle starting at the last place visited.
 196        If we loop completely around without finding a large enough
 197        space we will have to get more memory from the system.  */
 198     blocks = BLOCKIFY(size);
 199     start = block = MALLOC_SEARCH_START;
 200     while (mdp->heapinfo[block].free_block.size < blocks) {
 201         if (mdp->heapinfo[block].type >=0) { // Don't trust xbt_die and friends in malloc-level library, you fool!
 202                 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);
 203                 abort();
 204         }
 205
 206       block = mdp->heapinfo[block].free_block.next;
 207       if (block == start) {
 208         /* Need to get more from the system.  Check to see if
 209            the new core will be contiguous with the final free
 210            block; if so we don't need to get as much.  */
 211         block = mdp->heapinfo[0].free_block.prev;
 212         lastblocks = mdp->heapinfo[block].free_block.size;
 213         if (mdp->heaplimit != 0 &&
 214             block + lastblocks == mdp->heaplimit &&
 215             mmorecore(mdp, 0) == ADDRESS(block + lastblocks) &&
 216             (register_morecore(mdp, (blocks - lastblocks) * BLOCKSIZE)) != NULL) {
 217           /* Which block we are extending (the `final free
 218              block' referred to above) might have changed, if
 219              it got combined with a freed info table.  */
 220           block = mdp->heapinfo[0].free_block.prev;
 221
 222           mdp->heapinfo[block].free_block.size += (blocks - lastblocks);
 223           continue;
 224         }
 225         result = register_morecore(mdp, blocks * BLOCKSIZE);
 226
 227         block = BLOCK(result);
 228         for (it=0;it<blocks;it++)
 229                 mdp->heapinfo[block+it].type = 0;
 230         mdp->heapinfo[block].busy_block.size = blocks;
 231         mdp->heapinfo[block].busy_block.busy_size = requested_size;
 232         // FIXME: setup backtrace
 233
 234         return result;
 235       }
 236       /* Need large block(s), but found some in the existing heap */
 237     }
 238
 239     /* At this point we have found a suitable free list entry.
 240        Figure out how to remove what we need from the list. */
 241     result = ADDRESS(block);
 242     if (mdp->heapinfo[block].free_block.size > blocks) {
 243       /* The block we found has a bit left over,
 244          so relink the tail end back into the free list. */
 245       mdp->heapinfo[block + blocks].free_block.size
 246           = mdp->heapinfo[block].free_block.size - blocks;
 247       mdp->heapinfo[block + blocks].free_block.next
 248           = mdp->heapinfo[block].free_block.next;
 249       mdp->heapinfo[block + blocks].free_block.prev
 250           = mdp->heapinfo[block].free_block.prev;
 251       mdp->heapinfo[mdp->heapinfo[block].free_block.prev].free_block.next
 252           = mdp->heapinfo[mdp->heapinfo[block].free_block.next].free_block.prev
 253           = mdp->heapindex = block + blocks;
 254     } else {
 255       /* The block exactly matches our requirements,
 256          so just remove it from the list. */
 257       mdp->heapinfo[mdp->heapinfo[block].free_block.next].free_block.prev
 258           = mdp->heapinfo[block].free_block.prev;
 259       mdp->heapinfo[mdp->heapinfo[block].free_block.prev].free_block.next
 260           = mdp->heapindex = mdp->heapinfo[block].free_block.next;
 261     }
 262
 263     for (it=0;it<blocks;it++)
 264         mdp->heapinfo[block+it].type = 0;
 265     mdp->heapinfo[block].busy_block.size = blocks;
 266     mdp->heapinfo[block].busy_block.busy_size = requested_size;
 267   }
 268   //printf("(%s) Done mallocing. Result is %p\n",xbt_thread_self_name(),result);fflush(stdout);
 269   return (result);
 270 }