src/xbt/mmalloc/mmprivate.h

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