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 #define INT_BIT         (CHAR_BIT * sizeof(int))
  41 #define BLOCKLOG        (INT_BIT > 16 ? 12 : 9)
  42 #define BLOCKSIZE       ((unsigned int) 1 << BLOCKLOG)
  43 #define BLOCKIFY(SIZE)  (((SIZE) + BLOCKSIZE - 1) / BLOCKSIZE)
  44
  45 /* The difference between two pointers is a signed int.  On machines where
  46    the data addresses have the high bit set, we need to ensure that the
  47    difference becomes an unsigned int when we are using the address as an
  48    integral value.  In addition, when using with the '%' operator, the
  49    sign of the result is machine dependent for negative values, so force
  50    it to be treated as an unsigned int. */
  51
  52 #define ADDR2UINT(addr) ((unsigned int) ((char*) (addr) - (char*) NULL))
  53 #define RESIDUAL(addr,bsize) ((unsigned int) (ADDR2UINT (addr) % (bsize)))
  54
  55 /* Determine the amount of memory spanned by the initial heap table
  56    (not an absolute limit).  */
  57
  58 #define HEAP            (INT_BIT > 16 ? 4194304 : 65536)
  59
  60 /* Number of contiguous free blocks allowed to build up at the end of
  61    memory before they will be returned to the system.  */
  62
  63 #define FINAL_FREE_BLOCKS       8
  64
  65 /* Where to start searching the free list when looking for new memory.
  66    The two possible values are 0 and heapindex.  Starting at 0 seems
  67    to reduce total memory usage, while starting at heapindex seems to
  68    run faster.  */
  69
  70 #define MALLOC_SEARCH_START     mdp -> heapindex
  71
  72 /* Address to block number and vice versa.  */
  73
  74 #define BLOCK(A) (((char*) (A) - (char*) mdp -> heapbase) / BLOCKSIZE + 1)
  75
  76 #define ADDRESS(B) ((void*) (((ADDR2UINT(B)) - 1) * BLOCKSIZE + (char*) mdp -> heapbase))
  77
  78 const char *xbt_thread_self_name(void);
  79
  80 /* Data structure giving per-block information.
  81  *
  82  * There is one such structure in the mdp->heapinfo array,
  83  * that is addressed by block number.
  84  *
  85  * There is several types of blocks in memory:
  86  *  - full busy blocks: used when we are asked to malloc a block which size is > BLOCKSIZE/2
  87  *    In this situation, the full block is given to the malloc.
  88  *
  89  *  - fragmented busy blocks: when asked for smaller amount of memory.
  90  *    Fragment sizes are only power of 2. When looking for such a free fragment,
  91  *    we get one from mdp->fraghead (that contains a linked list of blocks fragmented at that
  92  *    size and containing a free fragment), or we get a fresh block that we fragment.
  93  *
  94  *  - free blocks are grouped by clusters, that are chained together.
  95  *    When looking for free blocks, we traverse the mdp->heapinfo looking
  96  *    for a cluster of free blocks that would be large enough.
  97  *
  98  * Note that there is no way to determine if the block is free or busy by exploring
  99  * this structure only. It wasn't intended to be crawled for comparison and we should fix it (TODO).
 100  *
 101  * TODO: understand whether the information are written in each blocks of a cluster (be it
 102  * free or busy) or only in the first block of the cluster. And in the latter case, how can
 103  * I retrieve the first block of my cluster.
 104  *
 105  * TODO:
 106  *  - add an indication of the requested size in the busy.block structure
 107  *  - add the same for each fragments
 108  *  - make room to store the backtrace of where the fragment were malloced, too.
 109  */
 110 typedef struct {
 111         int type; /*  0: busy large block
 112                          >0: busy fragmented (fragments of size 2^type bytes)
 113                          <0: free block */
 114         union {
 115         /* Heap information for a busy block.  */
 116                 struct {
 117                         size_t nfree;           /* Free fragments in a fragmented block.  */
 118                         size_t first;           /* First free fragment of the block.  */
 119                 } busy_frag;
 120                 struct {
 121                         size_t size; /* Size (in blocks) of a large cluster.  */
 122                         size_t busy_size;
 123                 } busy_block;
 124                 /* Heap information for a free block (that may be the first of a free cluster).  */
 125                 struct {
 126                         size_t size;                /* Size (in blocks) of a free cluster.  */
 127                         size_t next;                /* Index of next free cluster.  */
 128                         size_t prev;                /* Index of previous free cluster.  */
 129                 } free_block;
 130         };
 131 } malloc_info;
 132
 133 /* Doubly linked lists of free fragments.  */
 134 struct list {
 135         struct list *next;
 136         struct list *prev;
 137 };
 138
 139 /* Internal structure that defines the format of the malloc-descriptor.
 140    This gets written to the base address of the region that mmalloc is
 141    managing, and thus also becomes the file header for the mapped file,
 142    if such a file exists. */
 143
 144 struct mdesc {
 145
 146         /* Semaphore locking the access to the heap */
 147         sem_t sem;
 148
 149         /* Number of processes that attached the heap */
 150         unsigned int refcount;
 151
 152         /* Chained lists of mdescs */
 153         struct mdesc *next_mdesc;
 154
 155         /* The "magic number" for an mmalloc file. */
 156         char magic[MMALLOC_MAGIC_SIZE];
 157
 158         /* The size in bytes of this structure, used as a sanity check when reusing
 159      a previously created mapped file. */
 160         unsigned int headersize;
 161
 162         /* The version number of the mmalloc package that created this file. */
 163         unsigned char version;
 164
 165         /* Some flag bits to keep track of various internal things. */
 166         unsigned int flags;
 167
 168         /* Number of info entries.  */
 169         size_t heapsize;
 170
 171         /* Pointer to first block of the heap (base of the first block).  */
 172         void *heapbase;
 173
 174         /* Current search index for the heap table.  */
 175         /* Search index in the info table.  */
 176         size_t heapindex;
 177
 178         /* Limit of valid info table indices.  */
 179         size_t heaplimit;
 180
 181         /* Block information table.
 182      Allocated with malign/__mmalloc_free (not mmalloc/mfree).  */
 183         /* Table indexed by block number giving per-block information.  */
 184         malloc_info *heapinfo;
 185
 186         /* List of all blocks containing free fragments of this size. The array indice is the log2 of requested size */
 187         struct list fraghead[BLOCKLOG];
 188
 189         /* The base address of the memory region for this malloc heap.  This
 190      is the location where the bookkeeping data for mmap and for malloc
 191      begins. */
 192
 193         void *base;
 194
 195         /* The current location in the memory region for this malloc heap which
 196      represents the end of memory in use. */
 197
 198         void *breakval;
 199
 200         /* The end of the current memory region for this malloc heap.  This is
 201      the first location past the end of mapped memory. */
 202
 203         void *top;
 204
 205         /* Open file descriptor for the file to which this malloc heap is mapped.
 206      This will always be a valid file descriptor, since /dev/zero is used
 207      by default if no open file is supplied by the client.  Also note that
 208      it may change each time the region is mapped and unmapped. */
 209
 210         int fd;
 211
 212 };
 213
 214 int mmalloc_compare_mdesc(struct mdesc *mdp1, struct mdesc *mdp2, void *std_heap_addr);
 215
 216 void mmalloc_display_info(void *h);
 217
 218 /* Bits to look at in the malloc descriptor flags word */
 219
 220 #define MMALLOC_DEVZERO         (1 << 0)        /* Have mapped to /dev/zero */
 221 #define MMALLOC_ANONYMOUS (1 << 1)      /* Use anonymous mapping */
 222 #define MMALLOC_INITIALIZED     (1 << 2)        /* Initialized mmalloc */
 223
 224 /* Internal version of `mfree' used in `morecore'. */
 225
 226 extern void __mmalloc_free(struct mdesc *mdp, void *ptr);
 227
 228 /* A default malloc descriptor for the single sbrk() managed region. */
 229
 230 extern struct mdesc *__mmalloc_default_mdp;
 231
 232 /* Remap a mmalloc region that was previously mapped. */
 233
 234 extern void *__mmalloc_remap_core(xbt_mheap_t mdp);
 235
 236 /*  Get core for the memory region specified by MDP, using SIZE as the
 237     amount to either add to or subtract from the existing region.  Works
 238     like sbrk(), but using mmap(). */
 239 extern void *mmorecore(struct mdesc *mdp, int size);
 240
 241 /* Thread-safety (if the sem is already created) FIXME: KILLIT*/
 242 #define LOCK(mdp)                                        \
 243                 sem_wait(&mdp->sem)
 244
 245 #define UNLOCK(mdp)                                        \
 246                 sem_post(&mdp->sem)
 247
 248 #endif                          /* __MMPRIVATE_H */