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