src/xbt/mmalloc/mmprivate.h

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