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 smaller than sizeof(list) because we
  60  * need to enlist the free fragments.
  61  */
  62
  63 #define SMALLEST_POSSIBLE_MALLOC (16*sizeof(struct list))
  64 #define MAX_FRAGMENT_PER_BLOCK (BLOCKSIZE / SMALLEST_POSSIBLE_MALLOC)
  65
  66 /* The difference between two pointers is a signed int.  On machines where
  67    the data addresses have the high bit set, we need to ensure that the
  68    difference becomes an unsigned int when we are using the address as an
  69    integral value.  In addition, when using with the '%' operator, the
  70    sign of the result is machine dependent for negative values, so force
  71    it to be treated as an unsigned int. */
  72
  73 #define ADDR2UINT(addr)  ((uintptr_t) (addr))
  74 #define RESIDUAL(addr,bsize) ((uintptr_t) (ADDR2UINT (addr) % (bsize)))
  75
  76 /* Determine the amount of memory spanned by the initial heap table
  77    (not an absolute limit).  */
  78
  79 #define HEAP    (INT_BIT > 16 ? 4194304 : 65536)
  80
  81 /* Number of contiguous free blocks allowed to build up at the end of
  82    memory before they will be returned to the system.
  83    FIXME: this is not used anymore: we never return memory to the system. */
  84 #define FINAL_FREE_BLOCKS  8
  85
  86 /* Where to start searching the free list when looking for new memory.
  87    The two possible values are 0 and heapindex.  Starting at 0 seems
  88    to reduce total memory usage, while starting at heapindex seems to
  89    run faster.  */
  90
  91 #define MALLOC_SEARCH_START  mdp -> heapindex
  92
  93 /* Address to block number and vice versa.  */
  94
  95 #define BLOCK(A) (((char*) (A) - (char*) mdp -> heapbase) / BLOCKSIZE + 1)
  96
  97 #define ADDRESS(B) ((void*) (((ADDR2UINT(B)) - 1) * BLOCKSIZE + (char*) mdp -> heapbase))
  98
  99 SG_BEGIN_DECL
 100
 101 /* Doubly linked lists of free fragments.  */
 102 struct list {
 103   struct list *next;
 104   struct list *prev;
 105 };
 106
 107 /* Statistics available to the user. */
 108 struct mstats
 109 {
 110   size_t bytes_total;    /* Total size of the heap. */
 111   size_t chunks_used;    /* Chunks allocated by the user. */
 112   size_t bytes_used;    /* Byte total of user-allocated chunks. */
 113   size_t chunks_free;    /* Chunks in the free list. */
 114   size_t bytes_free;    /* Byte total of chunks in the free list. */
 115 };
 116
 117 #define MMALLOC_TYPE_HEAPINFO (-2)
 118 #define MMALLOC_TYPE_FREE (-1)
 119 #define MMALLOC_TYPE_UNFRAGMENTED 0
 120 /* >0 values are fragmented blocks */
 121
 122 /* Data structure giving per-block information.
 123  *
 124  * There is one such structure in the mdp->heapinfo array per block used in that heap,
 125  *    the array index is the block number.
 126  *
 127  * There is several types of blocks in memory:
 128  *  - full busy blocks: used when we are asked to malloc a block which size is > BLOCKSIZE/2
 129  *    In this situation, the full block is given to the malloc.
 130  *
 131  *  - fragmented busy blocks: when asked for smaller amount of memory.
 132  *    Fragment sizes are only power of 2. When looking for such a free fragment,
 133  *    we get one from mdp->fraghead (that contains a linked list of blocks fragmented at that
 134  *    size and containing a free fragment), or we get a fresh block that we fragment.
 135  *
 136  *  - free blocks are grouped by clusters, that are chained together.
 137  *    When looking for free blocks, we traverse the mdp->heapinfo looking
 138  *    for a cluster of free blocks that would be large enough.
 139  *
 140  *    The size of the cluster is only to be trusted in the first block of the cluster, not in the middle blocks.
 141  *
 142  * The type field is consistently updated for every blocks, even within clusters of blocks.
 143  * You can crawl the array and rely on that value.
 144  *
 145  */
 146 typedef struct {
 147   s_xbt_swag_hookup_t freehook; /* to register this block as having empty frags when needed */
 148   int type; /*  0: busy large block
 149                 >0: busy fragmented (fragments of size 2^type bytes)
 150                 <0: free block */
 151
 152   union {
 153     /* Heap information for a busy block.  */
 154     struct {
 155       size_t nfree;               /* Free fragments in a fragmented block.  */
 156       ssize_t frag_size[MAX_FRAGMENT_PER_BLOCK];
 157       int ignore[MAX_FRAGMENT_PER_BLOCK];
 158     } busy_frag;
 159     struct {
 160       size_t size; /* Size (in blocks) of a large cluster.  */
 161       size_t busy_size; /* Actually used space, in bytes */
 162       int ignore;
 163     } busy_block;
 164     /* Heap information for a free block (that may be the first of a free cluster).  */
 165     struct {
 166       size_t size;                /* Size (in blocks) of a free cluster.  */
 167       size_t next;                /* Index of next free cluster.  */
 168       size_t prev;                /* Index of previous free cluster.  */
 169     } free_block;
 170   };
 171 } malloc_info;
 172
 173 /** @brief Descriptor of a mmalloc area
 174  *
 175  * Internal structure that defines the format of the malloc-descriptor.
 176  * This gets written to the base address of the region that mmalloc is
 177  * managing, and thus also becomes the file header for the mapped file,
 178  * if such a file exists.
 179  * */
 180 struct mdesc {
 181   /** @brief Mutex locking the access to the heap */
 182   pthread_mutex_t mutex;
 183
 184   /** @brief Chained lists of mdescs */
 185   struct mdesc *next_mdesc;
 186
 187   /** @brief The "magic number" for an mmalloc file. */
 188   char magic[MMALLOC_MAGIC_SIZE];
 189
 190   /** @brief The size in bytes of this structure
 191    *
 192    * Used as a sanity check when reusing a previously created mapped file.
 193    * */
 194   unsigned int headersize;
 195
 196   /** @brief Version number of the mmalloc package that created this file. */
 197   unsigned char version;
 198
 199   unsigned int options;
 200
 201   /** @brief Some flag bits to keep track of various internal things. */
 202   unsigned int flags;
 203
 204   /** @brief Number of info entries.  */
 205   size_t heapsize;
 206
 207   /** @brief Pointer to first block of the heap (base of the first block).  */
 208   void *heapbase;
 209
 210   /** @brief Current search index for the heap table.
 211    *
 212    *  Search index in the info table.
 213    */
 214   size_t heapindex;
 215
 216   /** @brief Limit of valid info table indices.  */
 217   size_t heaplimit;
 218
 219   /** @brief Block information table.
 220    *
 221    * Table indexed by block number giving per-block information.
 222    */
 223   malloc_info *heapinfo;
 224
 225   /* @brief List of all blocks containing free fragments of a given size.
 226    *
 227    * The array index is the log2 of requested size.
 228    * Actually only the sizes 8->11 seem to be used, but who cares? */
 229   s_xbt_swag_t fraghead[BLOCKLOG];
 230
 231   /* @brief Base address of the memory region for this malloc heap
 232    *
 233    * This is the location where the bookkeeping data for mmap and
 234    * for malloc begins.
 235    */
 236   void *base;
 237
 238   /** @brief End of memory in use
 239    *
 240    *  Some memory might be already mapped by the OS but not used
 241    *  by the heap.
 242    * */
 243   void *breakval;
 244
 245   /** @brief End of the current memory region for this malloc heap.
 246    *
 247    *  This is the first location past the end of mapped memory.
 248    *
 249    *  Compared to breakval, this value is rounded to the next memory page.
 250    */
 251   void *top;
 252
 253   /* @brief Instrumentation */
 254   struct mstats heapstats;
 255 };
 256
 257 /* Bits to look at in the malloc descriptor flags word */
 258
 259 #define MMALLOC_DEVZERO    (1 << 0)        /* Have mapped to /dev/zero */
 260 #define MMALLOC_INITIALIZED (1 << 1)      /* Initialized mmalloc */
 261
 262 /* A default malloc descriptor for the single sbrk() managed region. */
 263
 264 XBT_PUBLIC_DATA struct mdesc* __mmalloc_default_mdp;
 265
 266 XBT_PUBLIC void* mmorecore(struct mdesc* mdp, ssize_t size);
 267
 268 /** Thread-safety (if the mutex is already created)
 269  *
 270  * This is mandatory in the case where the user runs a parallel simulation
 271  * in a model-checking enabled tree. Without this protection, our malloc
 272  * implementation will not like multi-threading AT ALL.
 273  */
 274 #define LOCK(mdp) pthread_mutex_lock(&(mdp)->mutex)
 275 #define UNLOCK(mdp) pthread_mutex_unlock(&(mdp)->mutex)
 276
 277 XBT_PRIVATE int malloc_use_mmalloc(void);
 278
 279 XBT_PRIVATE size_t mmalloc_get_bytes_used_remote(size_t heaplimit, const malloc_info* heapinfo);
 280
 281 SG_END_DECL
 282
 283 #endif