src/xbt/mmalloc/mmprivate.h

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