src/xbt/mmalloc/mmprivate.h

   1 /* Declarations for `mmalloc' and friends.
   2    Copyright 1990, 1991, 1992 Free Software Foundation
   3
   4    Written May 1989 by Mike Haertel.
   5    Heavily modified Mar 1992 by Fred Fish. (fnf@cygnus.com) */
   6
   7 /* Copyright (c) 2010. The SimGrid Team.
   8  * All rights reserved.                                                     */
   9
  10 /* This program is free software; you can redistribute it and/or modify it
  11  * under the terms of the license (GNU LGPL) which comes with this package. */
  12
  13 #ifndef __MMPRIVATE_H
  14 #define __MMPRIVATE_H 1
  15
  16 #include "portable.h"
  17 #include "xbt/xbt_os_thread.h"
  18 #include "xbt/mmalloc.h"
  19 #include "xbt/ex.h"
  20 #include <semaphore.h>
  21
  22 #ifdef HAVE_LIMITS_H
  23 #  include <limits.h>
  24 #else
  25 #  ifndef CHAR_BIT
  26 #    define CHAR_BIT 8
  27 #  endif
  28 #endif
  29
  30 #define MMALLOC_MAGIC           "mmalloc"       /* Mapped file magic number */
  31 #define MMALLOC_MAGIC_SIZE      8       /* Size of magic number buf */
  32 #define MMALLOC_VERSION         1       /* Current mmalloc version */
  33
  34 /* The allocator divides the heap into blocks of fixed size; large
  35    requests receive one or more whole blocks, and small requests
  36    receive a fragment of a block.  Fragment sizes are powers of two,
  37    and all fragments of a block are the same size.  When all the
  38    fragments in a block have been freed, the block itself is freed.
  39
  40    FIXME: we are not targeting 16bits machines anymore; update values */
  41
  42 #define INT_BIT         (CHAR_BIT * sizeof(int))
  43 #define BLOCKLOG        (INT_BIT > 16 ? 12 : 9)
  44 #define BLOCKSIZE       ((unsigned int) 1 << BLOCKLOG)
  45 #define BLOCKIFY(SIZE)  (((SIZE) + BLOCKSIZE - 1) / BLOCKSIZE)
  46
  47 /* We keep fragment-specific meta-data for introspection purposes, and these
  48  * information are kept in fixed lenght arrays. Here is the computation of
  49  * that size.
  50  *
  51  * Never make SMALLEST_POSSIBLE_MALLOC smaller than sizeof(list) because we
  52  * need to enlist the free fragments.
  53  */
  54
  55 #define SMALLEST_POSSIBLE_MALLOC (sizeof(struct list))
  56 #define MAX_FRAGMENT_PER_BLOCK (BLOCKSIZE / SMALLEST_POSSIBLE_MALLOC)
  57
  58 /* The difference between two pointers is a signed int.  On machines where
  59    the data addresses have the high bit set, we need to ensure that the
  60    difference becomes an unsigned int when we are using the address as an
  61    integral value.  In addition, when using with the '%' operator, the
  62    sign of the result is machine dependent for negative values, so force
  63    it to be treated as an unsigned int. */
  64
  65 #define ADDR2UINT(addr) ((unsigned int) ((char*) (addr) - (char*) NULL))
  66 #define RESIDUAL(addr,bsize) ((unsigned int) (ADDR2UINT (addr) % (bsize)))
  67
  68 /* Determine the amount of memory spanned by the initial heap table
  69    (not an absolute limit).  */
  70
  71 #define HEAP            (INT_BIT > 16 ? 4194304 : 65536)
  72
  73 /* Number of contiguous free blocks allowed to build up at the end of
  74    memory before they will be returned to the system.
  75    FIXME: this is not used anymore: we never return memory to the system. */
  76 #define FINAL_FREE_BLOCKS       8
  77
  78 /* Where to start searching the free list when looking for new memory.
  79    The two possible values are 0 and heapindex.  Starting at 0 seems
  80    to reduce total memory usage, while starting at heapindex seems to
  81    run faster.  */
  82
  83 #define MALLOC_SEARCH_START     mdp -> heapindex
  84
  85 /* Address to block number and vice versa.  */
  86
  87 #define BLOCK(A) (((char*) (A) - (char*) mdp -> heapbase) / BLOCKSIZE + 1)
  88
  89 #define ADDRESS(B) ((void*) (((ADDR2UINT(B)) - 1) * BLOCKSIZE + (char*) mdp -> heapbase))
  90
  91 const char *xbt_thread_self_name(void);
  92
  93 /* Doubly linked lists of free fragments.  */
  94 struct list {
  95         struct list *next;
  96         struct list *prev;
  97 };
  98
  99 /* Data structure giving per-block information.
 100  *
 101  * There is one such structure in the mdp->heapinfo array,
 102  * that is addressed by block number.
 103  *
 104  * There is several types of blocks in memory:
 105  *  - full busy blocks: used when we are asked to malloc a block which size is > BLOCKSIZE/2
 106  *    In this situation, the full block is given to the malloc.
 107  *
 108  *  - fragmented busy blocks: when asked for smaller amount of memory.
 109  *    Fragment sizes are only power of 2. When looking for such a free fragment,
 110  *    we get one from mdp->fraghead (that contains a linked list of blocks fragmented at that
 111  *    size and containing a free fragment), or we get a fresh block that we fragment.
 112  *
 113  *  - free blocks are grouped by clusters, that are chained together.
 114  *    When looking for free blocks, we traverse the mdp->heapinfo looking
 115  *    for a cluster of free blocks that would be large enough.
 116  *
 117  *    The size of the cluster is only to be trusted in the first block of the cluster, not in the middle blocks.
 118  *
 119  * The type field is consistently updated for every blocks, even within clusters of blocks.
 120  * You can crawl the array and rely on that value.
 121  *
 122  * TODO:
 123  *  - add an indication of the requested size in each fragment, similarly to busy_block.busy_size
 124  *  - make room to store the backtrace of where the blocks and fragment were malloced, too.
 125  */
 126 typedef struct {
 127         int type; /*  0: busy large block
 128                          >0: busy fragmented (fragments of size 2^type bytes)
 129                          <0: free block */
 130         union {
 131         /* Heap information for a busy block.  */
 132                 struct {
 133                         size_t nfree;           /* Free fragments in a fragmented block.  */
 134                         size_t first;           /* First free fragment of the block.  */
 135                         unsigned short frag_size[MAX_FRAGMENT_PER_BLOCK];
 136                 } busy_frag;
 137                 struct {
 138                         size_t size; /* Size (in blocks) of a large cluster.  */
 139                         size_t busy_size; /* Actually used space, in bytes */
 140                 } busy_block;
 141                 /* Heap information for a free block (that may be the first of a free cluster).  */
 142                 struct {
 143                         size_t size;                /* Size (in blocks) of a free cluster.  */
 144                         size_t next;                /* Index of next free cluster.  */
 145                         size_t prev;                /* Index of previous free cluster.  */
 146                 } free_block;
 147         };
 148 } malloc_info;
 149
 150 /* Internal structure that defines the format of the malloc-descriptor.
 151    This gets written to the base address of the region that mmalloc is
 152    managing, and thus also becomes the file header for the mapped file,
 153    if such a file exists. */
 154
 155 struct mdesc {
 156
 157         /* Semaphore locking the access to the heap */
 158         sem_t sem;
 159
 160         /* Number of processes that attached the heap */
 161         unsigned int refcount;
 162
 163         /* Chained lists of mdescs */
 164         struct mdesc *next_mdesc;
 165
 166         /* The "magic number" for an mmalloc file. */
 167         char magic[MMALLOC_MAGIC_SIZE];
 168
 169         /* The size in bytes of this structure, used as a sanity check when reusing
 170      a previously created mapped file. */
 171         unsigned int headersize;
 172
 173         /* The version number of the mmalloc package that created this file. */
 174         unsigned char version;
 175
 176         /* Some flag bits to keep track of various internal things. */
 177         unsigned int flags;
 178
 179         /* Number of info entries.  */
 180         size_t heapsize;
 181
 182         /* Pointer to first block of the heap (base of the first block).  */
 183         void *heapbase;
 184
 185         /* Current search index for the heap table.  */
 186         /* Search index in the info table.  */
 187         size_t heapindex;
 188
 189         /* Limit of valid info table indices.  */
 190         size_t heaplimit;
 191
 192         /* Block information table.
 193      Allocated with malign/mfree (not mmalloc/mfree).  */
 194         /* Table indexed by block number giving per-block information.  */
 195         malloc_info *heapinfo;
 196
 197         /* List of all blocks containing free fragments of this size. The array indice is the log2 of requested size */
 198         struct list fraghead[BLOCKLOG];
 199
 200         /* The base address of the memory region for this malloc heap.  This
 201      is the location where the bookkeeping data for mmap and for malloc
 202      begins. */
 203
 204         void *base;
 205
 206         /* The current location in the memory region for this malloc heap which
 207      represents the end of memory in use. */
 208
 209         void *breakval;
 210
 211         /* The end of the current memory region for this malloc heap.  This is
 212      the first location past the end of mapped memory. */
 213
 214         void *top;
 215
 216         /* Open file descriptor for the file to which this malloc heap is mapped.
 217      This will always be a valid file descriptor, since /dev/zero is used
 218      by default if no open file is supplied by the client.  Also note that
 219      it may change each time the region is mapped and unmapped. */
 220
 221         int fd;
 222
 223 };
 224
 225 int mmalloc_compare_mdesc(struct mdesc *mdp1, struct mdesc *mdp2, void *std_heap_addr);
 226
 227 void mmalloc_display_info(void *h);
 228
 229 /* Bits to look at in the malloc descriptor flags word */
 230
 231 #define MMALLOC_DEVZERO         (1 << 0)        /* Have mapped to /dev/zero */
 232 #define MMALLOC_ANONYMOUS (1 << 1)      /* Use anonymous mapping */
 233 #define MMALLOC_INITIALIZED     (1 << 2)        /* Initialized mmalloc */
 234
 235 /* A default malloc descriptor for the single sbrk() managed region. */
 236
 237 extern struct mdesc *__mmalloc_default_mdp;
 238
 239 /* Remap a mmalloc region that was previously mapped. */
 240
 241 extern void *__mmalloc_remap_core(xbt_mheap_t mdp);
 242
 243 /*  Get core for the memory region specified by MDP, using SIZE as the
 244     amount to either add to or subtract from the existing region.  Works
 245     like sbrk(), but using mmap(). */
 246 extern void *mmorecore(struct mdesc *mdp, int size);
 247
 248 /* Thread-safety (if the sem is already created) FIXME: KILLIT*/
 249 #define LOCK(mdp)                                        \
 250                 sem_wait(&mdp->sem)
 251
 252 #define UNLOCK(mdp)                                        \
 253                 sem_post(&mdp->sem)
 254
 255 #endif                          /* __MMPRIVATE_H */