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