src/xbt/mmalloc/mmprivate.h

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