src/xbt/mmalloc/mmprivate.h

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