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
 116 struct list {
 117   struct list *next;
 118   struct list *prev;
 119 };
 120
 121 /* Internal structure that defines the format of the malloc-descriptor.
 122    This gets written to the base address of the region that mmalloc is
 123    managing, and thus also becomes the file header for the mapped file,
 124    if such a file exists. */
 125
 126 struct mdesc {
 127
 128   /* Semaphore locking the access to the heap */
 129   sem_t sem;
 130
 131   /* Number of processes that attached the heap */
 132   unsigned int refcount;
 133
 134   /* Chained lists of mdescs */
 135   struct mdesc *next_mdesc;
 136
 137   /* The "magic number" for an mmalloc file. */
 138   char magic[MMALLOC_MAGIC_SIZE];
 139
 140   /* The size in bytes of this structure, used as a sanity check when reusing
 141      a previously created mapped file. */
 142   unsigned int headersize;
 143
 144   /* The version number of the mmalloc package that created this file. */
 145   unsigned char version;
 146
 147   /* Some flag bits to keep track of various internal things. */
 148   unsigned int flags;
 149
 150   /* Number of info entries.  */
 151   size_t heapsize;
 152
 153   /* Pointer to first block of the heap (base of the first block).  */
 154   void *heapbase;
 155
 156   /* Current search index for the heap table.  */
 157   /* Search index in the info table.  */
 158   size_t heapindex;
 159
 160   /* Limit of valid info table indices.  */
 161   size_t heaplimit;
 162
 163   /* Block information table.
 164      Allocated with malign/__mmalloc_free (not mmalloc/mfree).  */
 165   /* Table indexed by block number giving per-block information.  */
 166
 167   malloc_info *heapinfo;
 168
 169   /* Free list headers for each fragment size.  */
 170   /* Free lists for each fragment size.  */
 171
 172   struct list fraghead[BLOCKLOG];
 173
 174   /* List of blocks allocated by memalign.  */
 175
 176   struct alignlist *aligned_blocks;
 177
 178   /* The base address of the memory region for this malloc heap.  This
 179      is the location where the bookkeeping data for mmap and for malloc
 180      begins. */
 181
 182   void *base;
 183
 184   /* The current location in the memory region for this malloc heap which
 185      represents the end of memory in use. */
 186
 187   void *breakval;
 188
 189   /* The end of the current memory region for this malloc heap.  This is
 190      the first location past the end of mapped memory. */
 191
 192   void *top;
 193
 194   /* Open file descriptor for the file to which this malloc heap is mapped.
 195      This will always be a valid file descriptor, since /dev/zero is used
 196      by default if no open file is supplied by the client.  Also note that
 197      it may change each time the region is mapped and unmapped. */
 198
 199   int fd;
 200
 201 };
 202
 203 int mmalloc_compare_heap(void *h1, void *h2, void *std_heap_addr);
 204
 205 int mmalloc_compare_mdesc(struct mdesc *mdp1, struct mdesc *mdp2, void *std_heap_addr);
 206
 207 void mmalloc_display_info(void *h);
 208
 209 /* Bits to look at in the malloc descriptor flags word */
 210
 211 #define MMALLOC_DEVZERO         (1 << 0)        /* Have mapped to /dev/zero */
 212 #define MMALLOC_ANONYMOUS (1 << 1)      /* Use anonymous mapping */
 213 #define MMALLOC_INITIALIZED     (1 << 2)        /* Initialized mmalloc */
 214
 215 /* Internal version of `mfree' used in `morecore'. */
 216
 217 extern void __mmalloc_free(struct mdesc *mdp, void *ptr);
 218
 219 /* A default malloc descriptor for the single sbrk() managed region. */
 220
 221 extern struct mdesc *__mmalloc_default_mdp;
 222
 223 /* Initialize the first use of the default malloc descriptor, which uses
 224    an sbrk() region. */
 225
 226 extern struct mdesc *__mmalloc_create_default_mdp(void);
 227
 228 /* Grow or shrink a contiguous mapped region using mmap().
 229    Works much like sbrk(), only faster */
 230
 231 extern void *__mmalloc_mmap_morecore(struct mdesc *mdp, int size);
 232
 233
 234 /* Remap a mmalloc region that was previously mapped. */
 235
 236 extern void *__mmalloc_remap_core(struct mdesc *mdp);
 237
 238 /*  Get core for the memory region specified by MDP, using SIZE as the
 239     amount to either add to or subtract from the existing region.  Works
 240     like sbrk(), but using mmap(). */
 241 extern void *mmorecore(struct mdesc *mdp, int size);
 242
 243 /* Macro to convert from a user supplied malloc descriptor to pointer to the
 244    internal malloc descriptor.  If the user supplied descriptor is NULL, then
 245    use the default internal version, initializing it if necessary.  Otherwise
 246    just cast the user supplied version (which is void *) to the proper type
 247    (struct mdesc *). */
 248
 249 #define MD_TO_MDP(md) \
 250   ((md) == NULL \
 251    ? __mmalloc_default_mdp  \
 252    : (struct mdesc *) (md))
 253
 254 /* Thread-safety (if the sem is already created)*/
 255 #define LOCK(md)                                        \
 256   do {\
 257     struct mdesc *lock_local_mdp = MD_TO_MDP(md);       \
 258     sem_wait(&lock_local_mdp->sem);     \
 259   } while (0)
 260
 261 #define UNLOCK(md)                                        \
 262   do {                                                  \
 263     struct mdesc *unlock_local_mdp = MD_TO_MDP(md);       \
 264     sem_post(&unlock_local_mdp->sem);     \
 265   } while (0)
 266
 267 #endif                          /* __MMPRIVATE_H */