src/xbt/mmalloc/mmprivate.h

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