src/xbt/mmalloc/mmprivate.h

   1 /* Declarations for `mmalloc' and friends. */
   2
   3 /* Copyright (c) 2010-2022. The SimGrid Team. All rights reserved.          */
   4
   5 /* This program is free software; you can redistribute it and/or modify it
   6  * under the terms of the license (GNU LGPL) which comes with this package. */
   7
   8 /* Copyright 1990, 1991, 1992 Free Software Foundation
   9
  10    Written May 1989 by Mike Haertel.
  11    Heavily modified Mar 1992 by Fred Fish. (fnf@cygnus.com) */
  12
  13 #ifndef XBT_MMPRIVATE_H
  14 #define XBT_MMPRIVATE_H 1
  15
  16 #include "swag.h"
  17 #include "src/internal_config.h"
  18 #include "xbt/mmalloc.h"
  19
  20 #include <limits.h>
  21 #include <pthread.h>
  22 #include <stdint.h>
  23 #include <stdio.h>
  24 #include <stdlib.h>
  25
  26 // This macro is veery similar to xbt_assert, but with no dependency on XBT
  27 #define mmalloc_assert(cond, ...)                                                                                      \
  28   do {                                                                                                                 \
  29     if (!(cond)) {                                                                                                     \
  30       fprintf(stderr, __VA_ARGS__);                                                                                    \
  31       abort();                                                                                                         \
  32     }                                                                                                                  \
  33   } while (0)
  34
  35 XBT_PUBLIC_DATA int mmalloc_pagesize;
  36 XBT_PRIVATE xbt_mheap_t mmalloc_preinit(void);
  37
  38 #define MMALLOC_MAGIC    "mmalloc"       /* Mapped file magic number */
  39 #define MMALLOC_MAGIC_SIZE  8       /* Size of magic number buf */
  40 #define MMALLOC_VERSION    2       /* Current mmalloc version */
  41
  42 /* The allocator divides the heap into blocks of fixed size; large
  43    requests receive one or more whole blocks, and small requests
  44    receive a fragment of a block.  Fragment sizes are powers of two,
  45    and all fragments of a block are the same size.  When all the
  46    fragments in a block have been freed, the block itself is freed.
  47
  48    FIXME: we are not targeting 16bits machines anymore; update values */
  49
  50 #define INT_BIT    (CHAR_BIT * sizeof(int))
  51 #define BLOCKLOG  (INT_BIT > 16 ? 12 : 9)
  52 #define BLOCKSIZE  ((unsigned int) 1 << BLOCKLOG)
  53 #define BLOCKIFY(SIZE)  (((SIZE) + BLOCKSIZE - 1) / BLOCKSIZE)
  54
  55 /* We keep fragment-specific meta-data for introspection purposes, and these
  56  * information are kept in fixed length arrays. Here is the computation of
  57  * that size.
  58  *
  59  * Never make SMALLEST_POSSIBLE_MALLOC too small because we need to enlist
  60  * the free fragments.
  61  *
  62  * FIXME: what's the correct size, actually? The used one is a guess.
  63  */
  64
  65 #define SMALLEST_POSSIBLE_MALLOC (32 * sizeof(void*))
  66 #define MAX_FRAGMENT_PER_BLOCK (BLOCKSIZE / SMALLEST_POSSIBLE_MALLOC)
  67
  68 /* The difference between two pointers is a signed int.  On machines where
  69    the data addresses have the high bit set, we need to ensure that the
  70    difference becomes an unsigned int when we are using the address as an
  71    integral value.  In addition, when using with the '%' operator, the
  72    sign of the result is machine dependent for negative values, so force
  73    it to be treated as an unsigned int. */
  74
  75 #define ADDR2UINT(addr)  ((uintptr_t) (addr))
  76 #define RESIDUAL(addr,bsize) ((uintptr_t) (ADDR2UINT (addr) % (bsize)))
  77
  78 /* Determine the amount of memory spanned by the initial heap table
  79    (not an absolute limit).  */
  80
  81 #define HEAP    (INT_BIT > 16 ? 4194304 : 65536)
  82
  83 /* Number of contiguous free blocks allowed to build up at the end of
  84    memory before they will be returned to the system.
  85    FIXME: this is not used anymore: we never return memory to the system. */
  86 #define FINAL_FREE_BLOCKS  8
  87
  88 /* Where to start searching the free list when looking for new memory.
  89    The two possible values are 0 and heapindex.  Starting at 0 seems
  90    to reduce total memory usage, while starting at heapindex seems to
  91    run faster.  */
  92
  93 #define MALLOC_SEARCH_START  mdp -> heapindex
  94
  95 /* Address to block number and vice versa.  */
  96
  97 #define BLOCK(A) (((char*) (A) - (char*) mdp -> heapbase) / BLOCKSIZE + 1)
  98
  99 #define ADDRESS(B) ((void*) (((ADDR2UINT(B)) - 1) * BLOCKSIZE + (char*) mdp -> heapbase))
 100
 101 SG_BEGIN_DECL
 102
 103 /* Statistics available to the user. */
 104 struct mstats
 105 {
 106   size_t bytes_total;    /* Total size of the heap. */
 107   size_t chunks_used;    /* Chunks allocated by the user. */
 108   size_t bytes_used;    /* Byte total of user-allocated chunks. */
 109   size_t chunks_free;    /* Chunks in the free list. */
 110   size_t bytes_free;    /* Byte total of chunks in the free list. */
 111 };
 112
 113 #define MMALLOC_TYPE_HEAPINFO (-2)
 114 #define MMALLOC_TYPE_FREE (-1)
 115 #define MMALLOC_TYPE_UNFRAGMENTED 0
 116 /* >0 values are fragmented blocks */
 117
 118 /* Data structure giving per-block information.
 119  *
 120  * There is one such structure in the mdp->heapinfo array per block used in that heap,
 121  *    the array index is the block number.
 122  *
 123  * There is several types of blocks in memory:
 124  *  - full busy blocks: used when we are asked to malloc a block which size is > BLOCKSIZE/2
 125  *    In this situation, the full block is given to the malloc.
 126  *
 127  *  - fragmented busy blocks: when asked for smaller amount of memory.
 128  *    Fragment sizes are only power of 2. When looking for such a free fragment,
 129  *    we get one from mdp->fraghead (that contains a linked list of blocks fragmented at that
 130  *    size and containing a free fragment), or we get a fresh block that we fragment.
 131  *
 132  *  - free blocks are grouped by clusters, that are chained together.
 133  *    When looking for free blocks, we traverse the mdp->heapinfo looking
 134  *    for a cluster of free blocks that would be large enough.
 135  *
 136  *    The size of the cluster is only to be trusted in the first block of the cluster, not in the middle blocks.
 137  *
 138  * The type field is consistently updated for every blocks, even within clusters of blocks.
 139  * You can crawl the array and rely on that value.
 140  *
 141  */
 142 typedef struct {
 143   s_xbt_swag_hookup_t freehook; /* to register this block as having empty frags when needed */
 144   int type; /*  0: busy large block
 145                 >0: busy fragmented (fragments of size 2^type bytes)
 146                 <0: free block */
 147
 148   union {
 149     /* Heap information for a busy block.  */
 150     struct {
 151       size_t nfree;               /* Free fragments in a fragmented block.  */
 152       ssize_t frag_size[MAX_FRAGMENT_PER_BLOCK];
 153       int ignore[MAX_FRAGMENT_PER_BLOCK];
 154     } busy_frag;
 155     struct {
 156       size_t size; /* Size (in blocks) of a large cluster.  */
 157       size_t busy_size; /* Actually used space, in bytes */
 158       int ignore;
 159     } busy_block;
 160     /* Heap information for a free block (that may be the first of a free cluster).  */
 161     struct {
 162       size_t size;                /* Size (in blocks) of a free cluster.  */
 163       size_t next;                /* Index of next free cluster.  */
 164       size_t prev;                /* Index of previous free cluster.  */
 165     } free_block;
 166   };
 167 } malloc_info;
 168
 169 /** @brief Descriptor of a mmalloc area
 170  *
 171  * Internal structure that defines the format of the malloc-descriptor.
 172  * This gets written to the base address of the region that mmalloc is
 173  * managing, and thus also becomes the file header for the mapped file,
 174  * if such a file exists.
 175  * */
 176 struct mdesc {
 177   /** @brief Chained lists of mdescs */
 178   struct mdesc *next_mdesc;
 179
 180   /** @brief The "magic number" for an mmalloc file. */
 181   char magic[MMALLOC_MAGIC_SIZE];
 182
 183   /** @brief The size in bytes of this structure
 184    *
 185    * Used as a sanity check when reusing a previously created mapped file.
 186    * */
 187   unsigned int headersize;
 188
 189   /** @brief Version number of the mmalloc package that created this file. */
 190   unsigned char version;
 191
 192   unsigned int options;
 193
 194   /** @brief Some flag bits to keep track of various internal things. */
 195   unsigned int flags;
 196
 197   /** @brief Number of info entries.  */
 198   size_t heapsize;
 199
 200   /** @brief Pointer to first block of the heap (base of the first block).  */
 201   void *heapbase;
 202
 203   /** @brief Current search index for the heap table.
 204    *
 205    *  Search index in the info table.
 206    */
 207   size_t heapindex;
 208
 209   /** @brief Limit of valid info table indices.  */
 210   size_t heaplimit;
 211
 212   /** @brief Block information table.
 213    *
 214    * Table indexed by block number giving per-block information.
 215    */
 216   malloc_info *heapinfo;
 217
 218   /* @brief List of all blocks containing free fragments of a given size.
 219    *
 220    * The array index is the log2 of requested size.
 221    * Actually only the sizes 8->11 seem to be used, but who cares? */
 222   s_xbt_swag_t fraghead[BLOCKLOG];
 223
 224   /* @brief Base address of the memory region for this malloc heap
 225    *
 226    * This is the location where the bookkeeping data for mmap and
 227    * for malloc begins.
 228    */
 229   void *base;
 230
 231   /** @brief End of memory in use
 232    *
 233    *  Some memory might be already mapped by the OS but not used
 234    *  by the heap.
 235    * */
 236   void *breakval;
 237
 238   /** @brief End of the current memory region for this malloc heap.
 239    *
 240    *  This is the first location past the end of mapped memory.
 241    *
 242    *  Compared to breakval, this value is rounded to the next memory page.
 243    */
 244   void *top;
 245
 246   /* @brief Instrumentation */
 247   struct mstats heapstats;
 248 };
 249
 250 /* Bits to look at in the malloc descriptor flags word */
 251
 252 #define MMALLOC_DEVZERO    (1 << 0)        /* Have mapped to /dev/zero */
 253 #define MMALLOC_INITIALIZED (1 << 1)      /* Initialized mmalloc */
 254
 255 /* A default malloc descriptor for the single sbrk() managed region. */
 256
 257 XBT_PUBLIC_DATA struct mdesc* __mmalloc_default_mdp;
 258
 259 XBT_PUBLIC void* mmorecore(struct mdesc* mdp, ssize_t size);
 260
 261 XBT_PRIVATE size_t mmalloc_get_bytes_used_remote(size_t heaplimit, const malloc_info* heapinfo);
 262
 263 /* We call dlsym during mmalloc initialization, but dlsym uses malloc.
 264  * So during mmalloc initialization, any call to malloc is diverted to a private static buffer.
 265  */
 266 extern uint64_t* mmalloc_preinit_buffer;
 267 #ifdef __FreeBSD__ /* FreeBSD require more memory, other might */
 268 #define mmalloc_preinit_buffer_size 256
 269 #else /* Valid on: Linux */
 270 #define mmalloc_preinit_buffer_size 32
 271 #endif
 272
 273 SG_END_DECL
 274
 275 #endif