src/xbt/mmalloc/mrealloc.c

   1 /* Change the size of a block allocated by `mmalloc'. */
   2
   3 /* Copyright (c) 2010-2022. The SimGrid Team.
   4  * All rights reserved.                                                     */
   5
   6 /* This program is free software; you can redistribute it and/or modify it
   7  * under the terms of the license (GNU LGPL) which comes with this package. */
   8
   9 /* Copyright 1990, 1991 Free Software Foundation
  10    Written May 1989 by Mike Haertel. */
  11
  12 #include <string.h>             /* Prototypes for memcpy, memmove, memset, etc */
  13 #include <stdlib.h> /* abort */
  14
  15 #include "mmprivate.h"
  16
  17 #ifndef MIN
  18 #define MIN(a, b) ((a) < (b) ? (a) : (b))
  19 #endif
  20
  21 /* Resize the given region to the new size, returning a pointer to the (possibly moved) region. This is optimized for
  22  * speed; some benchmarks seem to indicate that greater compactness is achieved by unconditionally allocating and
  23  * copying to a new region.  This module has incestuous knowledge of the internals of both mfree and mmalloc. */
  24
  25 void *mrealloc(xbt_mheap_t mdp, void *ptr, size_t size)
  26 {
  27   void *result;
  28   size_t blocks;
  29
  30   /* Only keep real realloc, and reroute hidden malloc and free to the relevant functions */
  31   if (size == 0) {
  32     mfree(mdp, ptr);
  33     return mmalloc(mdp, 0);
  34   } else if (ptr == NULL) {
  35     return mmalloc(mdp, size);
  36   }
  37
  38   if ((char *) ptr < (char *) mdp->heapbase || BLOCK(ptr) > mdp->heapsize) {
  39     // Don't trust xbt_assert and friends in malloc-level library, you fool!
  40     fprintf(stderr, "This pointer is not mine, refusing to realloc it (maybe you wanted to malloc it instead?)\n");
  41     abort();
  42   }
  43
  44   size_t requested_size = size; // The amount of memory requested by user, for real
  45
  46   /* Work even if the user was stupid enough to ask a ridiculously small block (even 0-length),
  47    *    ie return a valid block that can be realloced and freed.
  48    * glibc malloc does not use this trick but return a constant pointer, but we need to enlist the free fragments later on.
  49    */
  50   if (size < SMALLEST_POSSIBLE_MALLOC)
  51     size = SMALLEST_POSSIBLE_MALLOC;
  52
  53   size_t block = BLOCK(ptr);
  54
  55   int type = mdp->heapinfo[block].type;
  56
  57   switch (type) {
  58   case MMALLOC_TYPE_HEAPINFO:
  59     fprintf(stderr, "Asked realloc a fragment coming from a heapinfo block. I'm confused.\n");
  60     abort();
  61     break;
  62
  63   case MMALLOC_TYPE_FREE:
  64     fprintf(stderr, "Asked realloc a fragment coming from a *free* block. I'm puzzled.\n");
  65     abort();
  66     break;
  67
  68   case MMALLOC_TYPE_UNFRAGMENTED:
  69     /* Maybe reallocate a large block to a small fragment.  */
  70
  71     if (size <= BLOCKSIZE / 2) { // Full block -> Fragment; no need to optimize for time
  72
  73       result = mmalloc(mdp, size);
  74       memcpy(result, ptr, requested_size);
  75       mfree(mdp, ptr);
  76       return result;
  77     }
  78
  79     /* Full blocks -> Full blocks; see if we can hold it in place. */
  80     blocks = BLOCKIFY(size);
  81     if (blocks < mdp->heapinfo[block].busy_block.size) {
  82       /* The new size is smaller; return excess memory to the free list. */
  83       for (size_t it = block + blocks; it < mdp->heapinfo[block].busy_block.size; it++) {
  84         mdp->heapinfo[it].type = MMALLOC_TYPE_UNFRAGMENTED; // FIXME that should be useless, type should already be 0 here
  85         mdp->heapinfo[it].busy_block.ignore = 0;
  86         mdp->heapinfo[it].busy_block.size = 0;
  87         mdp->heapinfo[it].busy_block.busy_size = 0;
  88       }
  89
  90       mdp->heapinfo[block + blocks].busy_block.size = mdp->heapinfo[block].busy_block.size - blocks;
  91       mfree(mdp, ADDRESS(block + blocks));
  92
  93       mdp->heapinfo[block].busy_block.size = blocks;
  94       mdp->heapinfo[block].busy_block.busy_size = requested_size;
  95       mdp->heapinfo[block].busy_block.ignore = 0;
  96
  97       result = ptr;
  98     } else if (blocks == mdp->heapinfo[block].busy_block.size) {
  99
 100       /* No block size change necessary; only update the requested size  */
 101       result = ptr;
 102       mdp->heapinfo[block].busy_block.busy_size = requested_size;
 103       mdp->heapinfo[block].busy_block.ignore = 0;
 104
 105     } else {
 106       /* Won't fit, so allocate a new region that will.
 107          Free the old region first in case there is sufficient adjacent free space to grow without moving.
 108          This trick mandates using a specific version of mmalloc that does not memset the memory to 0 after
 109            action for obvious reasons. */
 110       blocks = mdp->heapinfo[block].busy_block.size;
 111       /* Prevent free from actually returning memory to the system.  */
 112       size_t oldlimit = mdp->heaplimit;
 113       mdp->heaplimit = 0;
 114       mfree(mdp, ptr);
 115       mdp->heaplimit = oldlimit;
 116
 117       result = mmalloc_no_memset(mdp, requested_size);
 118
 119       if (ptr != result)
 120         memmove(result, ptr, blocks * BLOCKSIZE);
 121       /* FIXME: we should memset the end of the recently area */
 122     }
 123     break;
 124
 125   default: /* Fragment -> ??; type=logarithm to base two of the fragment size.  */
 126
 127     if (type <= 0) {
 128       fprintf(stderr, "Unknown mmalloc block type.\n");
 129       abort();
 130     }
 131
 132     if (size > ((size_t)1 << (type - 1)) && size <= ((size_t)1 << type)) {
 133       /* The new size is the same kind of fragment.  */
 134
 135       result = ptr;
 136       uintptr_t frag_nb                                 = RESIDUAL(result, BLOCKSIZE) >> type;
 137       mdp->heapinfo[block].busy_frag.frag_size[frag_nb] = requested_size;
 138       mdp->heapinfo[block].busy_frag.ignore[frag_nb] = 0;
 139
 140     } else { /* fragment -> Either other fragment, or block */
 141       /* The new size is different; allocate a new space,
 142          and copy the lesser of the new size and the old. */
 143
 144       result = mmalloc(mdp, requested_size);
 145
 146       memcpy(result, ptr, MIN(requested_size, (size_t) 1 << type));
 147       mfree(mdp, ptr);
 148     }
 149     break;
 150   }
 151   return result;
 152 }