includes/rts/storage/Block.h

   1 /* -----------------------------------------------------------------------------
   2  *
   3  * (c) The GHC Team, 1998-1999
   4  *
   5  * Block structure for the storage manager
   6  *
   7  * ---------------------------------------------------------------------------*/
   8
   9 #ifndef RTS_STORAGE_BLOCK_H
  10 #define RTS_STORAGE_BLOCK_H
  11
  12 /* The actual block and megablock-size constants are defined in
  13  * includes/Constants.h, all constants here are derived from these.
  14  */
  15
  16 /* Block related constants (BLOCK_SHIFT is defined in Constants.h) */
  17
  18 #define BLOCK_SIZE   (1<<BLOCK_SHIFT)
  19 #define BLOCK_SIZE_W (BLOCK_SIZE/sizeof(W_))
  20 #define BLOCK_MASK   (BLOCK_SIZE-1)
  21
  22 #define BLOCK_ROUND_UP(p)   ((void *) (((W_)(p)+BLOCK_SIZE-1) & ~BLOCK_MASK))
  23 #define BLOCK_ROUND_DOWN(p) ((void *) ((W_)(p) & ~BLOCK_MASK))
  24
  25 /* Megablock related constants (MBLOCK_SHIFT is defined in Constants.h) */
  26
  27 #define MBLOCK_SIZE    (1<<MBLOCK_SHIFT)
  28 #define MBLOCK_SIZE_W  (MBLOCK_SIZE/sizeof(W_))
  29 #define MBLOCK_MASK    (MBLOCK_SIZE-1)
  30
  31 #define MBLOCK_ROUND_UP(p)   ((void *)(((W_)(p)+MBLOCK_SIZE-1) & ~MBLOCK_MASK))
  32 #define MBLOCK_ROUND_DOWN(p) ((void *)((W_)(p) & ~MBLOCK_MASK ))
  33
  34 /* The largest size an object can be before we give it a block of its
  35  * own and treat it as an immovable object during GC, expressed as a
  36  * fraction of BLOCK_SIZE.
  37  */
  38 #define LARGE_OBJECT_THRESHOLD ((nat)(BLOCK_SIZE * 8 / 10))
  39
  40 /* -----------------------------------------------------------------------------
  41  * Block descriptor.  This structure *must* be the right length, so we
  42  * can do pointer arithmetic on pointers to it.
  43  */
  44
  45 /* The block descriptor is 64 bytes on a 64-bit machine, and 32-bytes
  46  * on a 32-bit machine.
  47  */
  48
  49 #ifndef CMINUSMINUS
  50 typedef struct bdescr_ {
  51     StgPtr start;              /* start addr of memory */
  52     StgPtr free;               /* first free byte of memory */
  53     struct bdescr_ *link;      /* used for chaining blocks together */
  54     union {
  55         struct bdescr_ *back;  /* used (occasionally) for doubly-linked lists*/
  56         StgWord *bitmap;
  57         StgPtr  scan;           /* scan pointer for copying GC */
  58     } u;
  59
  60     struct generation_ *gen;   /* generation */
  61     struct generation_ *dest;  /* destination gen */
  62
  63     StgWord32 blocks;           /* no. of blocks (if grp head, 0 otherwise) */
  64
  65     StgWord16 gen_no;
  66     StgWord16 flags;            /* block flags, see below */
  67 #if SIZEOF_VOID_P == 8
  68     StgWord32 _padding[2];
  69 #else
  70     StgWord32 _padding[0];
  71 #endif
  72 } bdescr;
  73 #endif
  74
  75 #if SIZEOF_VOID_P == 8
  76 #define BDESCR_SIZE  0x40
  77 #define BDESCR_MASK  0x3f
  78 #define BDESCR_SHIFT 6
  79 #else
  80 #define BDESCR_SIZE  0x20
  81 #define BDESCR_MASK  0x1f
  82 #define BDESCR_SHIFT 5
  83 #endif
  84
  85 /* Block contains objects evacuated during this GC */
  86 #define BF_EVACUATED 1
  87 /* Block is a large object */
  88 #define BF_LARGE     2
  89 /* Block is pinned */
  90 #define BF_PINNED    4
  91 /* Block is to be marked, not copied */
  92 #define BF_MARKED    8
  93 /* Block is free, and on the free list  (TODO: is this used?) */
  94 #define BF_FREE      16
  95 /* Block is executable */
  96 #define BF_EXEC      32
  97 /* Block contains only a small amount of live data */
  98 #define BF_FRAGMENTED 64
  99 /* we know about this block (for finding leaks) */
 100 #define BF_KNOWN     128
 101
 102 /* Finding the block descriptor for a given block -------------------------- */
 103
 104 #ifdef CMINUSMINUS
 105
 106 #define Bdescr(p) \
 107     ((((p) &  MBLOCK_MASK & ~BLOCK_MASK) >> (BLOCK_SHIFT-BDESCR_SHIFT)) \
 108      | ((p) & ~MBLOCK_MASK))
 109
 110 #else
 111
 112 INLINE_HEADER bdescr *Bdescr(StgPtr p)
 113 {
 114   return (bdescr *)
 115     ((((W_)p &  MBLOCK_MASK & ~BLOCK_MASK) >> (BLOCK_SHIFT-BDESCR_SHIFT))
 116      | ((W_)p & ~MBLOCK_MASK)
 117      );
 118 }
 119
 120 #endif
 121
 122 /* Useful Macros ------------------------------------------------------------ */
 123
 124 /* Offset of first real data block in a megablock */
 125
 126 #define FIRST_BLOCK_OFF \
 127    ((W_)BLOCK_ROUND_UP(BDESCR_SIZE * (MBLOCK_SIZE / BLOCK_SIZE)))
 128
 129 /* First data block in a given megablock */
 130
 131 #define FIRST_BLOCK(m) ((void *)(FIRST_BLOCK_OFF + (W_)(m)))
 132
 133 /* Last data block in a given megablock */
 134
 135 #define LAST_BLOCK(m)  ((void *)(MBLOCK_SIZE-BLOCK_SIZE + (W_)(m)))
 136
 137 /* First real block descriptor in a megablock */
 138
 139 #define FIRST_BDESCR(m) \
 140    ((bdescr *)((FIRST_BLOCK_OFF>>(BLOCK_SHIFT-BDESCR_SHIFT)) + (W_)(m)))
 141
 142 /* Last real block descriptor in a megablock */
 143
 144 #define LAST_BDESCR(m) \
 145   ((bdescr *)(((MBLOCK_SIZE-BLOCK_SIZE)>>(BLOCK_SHIFT-BDESCR_SHIFT)) + (W_)(m)))
 146
 147 /* Number of usable blocks in a megablock */
 148
 149 #define BLOCKS_PER_MBLOCK ((MBLOCK_SIZE - FIRST_BLOCK_OFF) / BLOCK_SIZE)
 150
 151 /* How many blocks in this megablock group */
 152
 153 #define MBLOCK_GROUP_BLOCKS(n) \
 154    (BLOCKS_PER_MBLOCK + (n-1) * (MBLOCK_SIZE / BLOCK_SIZE))
 155
 156 /* Compute the required size of a megablock group */
 157
 158 #define BLOCKS_TO_MBLOCKS(n) \
 159    (1 + (W_)MBLOCK_ROUND_UP((n-BLOCKS_PER_MBLOCK) * BLOCK_SIZE) / MBLOCK_SIZE)
 160
 161
 162 #ifndef CMINUSMINUS
 163 /* to the end... */
 164
 165 /* Double-linked block lists: --------------------------------------------- */
 166
 167 INLINE_HEADER void
 168 dbl_link_onto(bdescr *bd, bdescr **list)
 169 {
 170   bd->link = *list;
 171   bd->u.back = NULL;
 172   if (*list) {
 173     (*list)->u.back = bd; /* double-link the list */
 174   }
 175   *list = bd;
 176 }
 177
 178 INLINE_HEADER void
 179 dbl_link_remove(bdescr *bd, bdescr **list)
 180 {
 181     if (bd->u.back) {
 182         bd->u.back->link = bd->link;
 183     } else {
 184         *list = bd->link;
 185     }
 186     if (bd->link) {
 187         bd->link->u.back = bd->u.back;
 188     }
 189 }
 190
 191 INLINE_HEADER void
 192 dbl_link_insert_after(bdescr *bd, bdescr *after)
 193 {
 194     bd->link = after->link;
 195     bd->u.back = after;
 196     if (after->link) {
 197         after->link->u.back = bd;
 198     }
 199     after->link = bd;
 200 }
 201
 202 INLINE_HEADER void
 203 dbl_link_replace(bdescr *new, bdescr *old, bdescr **list)
 204 {
 205     new->link = old->link;
 206     new->u.back = old->u.back;
 207     if (old->link) {
 208         old->link->u.back = new;
 209     }
 210     if (old->u.back) {
 211         old->u.back->link = new;
 212     } else {
 213         *list = new;
 214     }
 215 }
 216
 217 /* Initialisation ---------------------------------------------------------- */
 218
 219 extern void initBlockAllocator(void);
 220
 221 /* Allocation -------------------------------------------------------------- */
 222
 223 bdescr *allocGroup(nat n);
 224 bdescr *allocBlock(void);
 225
 226 // versions that take the storage manager lock for you:
 227 bdescr *allocGroup_lock(nat n);
 228 bdescr *allocBlock_lock(void);
 229
 230 /* De-Allocation ----------------------------------------------------------- */
 231
 232 void freeGroup(bdescr *p);
 233 void freeChain(bdescr *p);
 234
 235 // versions that take the storage manager lock for you:
 236 void freeGroup_lock(bdescr *p);
 237 void freeChain_lock(bdescr *p);
 238
 239 bdescr * splitBlockGroup (bdescr *bd, nat blocks);
 240
 241 /* Round a value to megablocks --------------------------------------------- */
 242
 243 // We want to allocate an object around a given size, round it up or
 244 // down to the nearest size that will fit in an mblock group.
 245 INLINE_HEADER StgWord
 246 round_to_mblocks(StgWord words)
 247 {
 248     if (words > BLOCKS_PER_MBLOCK * BLOCK_SIZE_W) {
 249         // first, ignore the gap at the beginning of the first mblock by
 250         // adding it to the total words.  Then we can pretend we're
 251         // dealing in a uniform unit of megablocks.
 252         words += FIRST_BLOCK_OFF/sizeof(W_);
 253
 254         if ((words % MBLOCK_SIZE_W) < (MBLOCK_SIZE_W / 2)) {
 255             words = (words / MBLOCK_SIZE_W) * MBLOCK_SIZE_W;
 256         } else {
 257             words = ((words / MBLOCK_SIZE_W) + 1) * MBLOCK_SIZE_W;
 258         }
 259
 260         words -= FIRST_BLOCK_OFF/sizeof(W_);
 261     }
 262     return words;
 263 }
 264
 265 INLINE_HEADER StgWord
 266 round_up_to_mblocks(StgWord words)
 267 {
 268     words += FIRST_BLOCK_OFF/sizeof(W_);
 269     words = ((words / MBLOCK_SIZE_W) + 1) * MBLOCK_SIZE_W;
 270     words -= FIRST_BLOCK_OFF/sizeof(W_);
 271     return words;
 272 }
 273
 274 #endif /* !CMINUSMINUS */
 275 #endif /* RTS_STORAGE_BLOCK_H */