ghc/includes/Storage.h

   1 /* -----------------------------------------------------------------------------
   2  *
   3  * (c) The GHC Team, 1998-2004
   4  *
   5  * External Storage Manger Interface
   6  *
   7  * ---------------------------------------------------------------------------*/
   8
   9 #ifndef STORAGE_H
  10 #define STORAGE_H
  11
  12 #include <stddef.h>
  13 #include "OSThreads.h"
  14
  15 /* -----------------------------------------------------------------------------
  16  * Generational GC
  17  *
  18  * We support an arbitrary number of generations, with an arbitrary number
  19  * of steps per generation.  Notes (in no particular order):
  20  *
  21  *       - all generations except the oldest should have two steps.  This gives
  22  *         objects a decent chance to age before being promoted, and in
  23  *         particular will ensure that we don't end up with too many
  24  *         thunks being updated in older generations.
  25  *
  26  *       - the oldest generation has one step.  There's no point in aging
  27  *         objects in the oldest generation.
  28  *
  29  *       - generation 0, step 0 (G0S0) is the allocation area.  It is given
  30  *         a fixed set of blocks during initialisation, and these blocks
  31  *         are never freed.
  32  *
  33  *       - during garbage collection, each step which is an evacuation
  34  *         destination (i.e. all steps except G0S0) is allocated a to-space.
  35  *         evacuated objects are allocated into the step's to-space until
  36  *         GC is finished, when the original step's contents may be freed
  37  *         and replaced by the to-space.
  38  *
  39  *       - the mutable-list is per-generation (not per-step).  G0 doesn't
  40  *         have one (since every garbage collection collects at least G0).
  41  *
  42  *       - block descriptors contain pointers to both the step and the
  43  *         generation that the block belongs to, for convenience.
  44  *
  45  *       - static objects are stored in per-generation lists.  See GC.c for
  46  *         details of how we collect CAFs in the generational scheme.
  47  *
  48  *       - large objects are per-step, and are promoted in the same way
  49  *         as small objects, except that we may allocate large objects into
  50  *         generation 1 initially.
  51  *
  52  * ------------------------------------------------------------------------- */
  53
  54 typedef struct step_ {
  55   unsigned int         no;              /* step number */
  56   bdescr *             blocks;          /* blocks in this step */
  57   unsigned int         n_blocks;        /* number of blocks */
  58   struct step_ *       to;              /* destination step for live objects */
  59   struct generation_ * gen;             /* generation this step belongs to */
  60   unsigned int         gen_no;          /* generation number (cached) */
  61   bdescr *             large_objects;   /* large objects (doubly linked) */
  62   unsigned int         n_large_blocks;  /* no. of blocks used by large objs */
  63   int                  is_compacted;    /* compact this step? (old gen only) */
  64
  65   /* During GC, if we are collecting this step, blocks and n_blocks
  66    * are copied into the following two fields.  After GC, these blocks
  67    * are freed. */
  68   bdescr *     old_blocks;              /* bdescr of first from-space block */
  69   unsigned int n_old_blocks;            /* number of blocks in from-space */
  70
  71   /* temporary use during GC: */
  72   StgPtr       hp;                      /* next free locn in to-space */
  73   StgPtr       hpLim;                   /* end of current to-space block */
  74   bdescr *     hp_bd;                   /* bdescr of current to-space block */
  75   StgPtr       scavd_hp;                /* ... same as above, but already */
  76   StgPtr       scavd_hpLim;             /*     scavenged.  */
  77   bdescr *     scan_bd;                 /* block currently being scanned */
  78   StgPtr       scan;                    /* scan pointer in current block */
  79   bdescr *     new_large_objects;       /* large objects collected so far */
  80   bdescr *     scavenged_large_objects; /* live large objs after GC (d-link) */
  81   unsigned int n_scavenged_large_blocks;/* size of above */
  82   bdescr *     bitmap;                  /* bitmap for compacting collection */
  83 } step;
  84
  85 typedef struct generation_ {
  86   unsigned int   no;                    /* generation number */
  87   step *         steps;                 /* steps */
  88   unsigned int   n_steps;               /* number of steps */
  89   unsigned int   max_blocks;            /* max blocks in step 0 */
  90   bdescr        *mut_list;              /* mut objects in this gen (not G0)*/
  91
  92   /* temporary use during GC: */
  93   bdescr        *saved_mut_list;
  94
  95   /* stats information */
  96   unsigned int collections;
  97   unsigned int failed_promotions;
  98 } generation;
  99
 100 extern generation * RTS_VAR(generations);
 101
 102 extern generation * RTS_VAR(g0);
 103 extern step * RTS_VAR(g0s0);
 104 extern generation * RTS_VAR(oldest_gen);
 105
 106 /* -----------------------------------------------------------------------------
 107    Initialisation / De-initialisation
 108    -------------------------------------------------------------------------- */
 109
 110 extern void initStorage(void);
 111 extern void exitStorage(void);
 112
 113 /* -----------------------------------------------------------------------------
 114    Generic allocation
 115
 116    StgPtr allocate(nat n)       Allocates a chunk of contiguous store
 117                                 n words long, returning a pointer to
 118                                 the first word.  Always succeeds.
 119
 120    StgPtr allocatePinned(nat n) Allocates a chunk of contiguous store
 121                                 n words long, which is at a fixed
 122                                 address (won't be moved by GC).
 123                                 Returns a pointer to the first word.
 124                                 Always succeeds.
 125
 126                                 NOTE: the GC can't in general handle
 127                                 pinned objects, so allocatePinned()
 128                                 can only be used for ByteArrays at the
 129                                 moment.
 130
 131                                 Don't forget to TICK_ALLOC_XXX(...)
 132                                 after calling allocate or
 133                                 allocatePinned, for the
 134                                 benefit of the ticky-ticky profiler.
 135
 136    rtsBool doYouWantToGC(void)  Returns True if the storage manager is
 137                                 ready to perform a GC, False otherwise.
 138
 139    lnat  allocated_bytes(void)  Returns the number of bytes allocated
 140                                 via allocate() since the last GC.
 141                                 Used in the reporting of statistics.
 142
 143    THREADED_RTS: allocate and doYouWantToGC can be used from STG code, they are
 144    surrounded by a mutex.
 145    -------------------------------------------------------------------------- */
 146
 147 extern StgPtr  allocate        ( nat n );
 148 extern StgPtr  allocateLocal   ( Capability *cap, nat n );
 149 extern StgPtr  allocatePinned  ( nat n );
 150 extern lnat    allocated_bytes ( void );
 151
 152 extern bdescr * RTS_VAR(small_alloc_list);
 153 extern bdescr * RTS_VAR(large_alloc_list);
 154 extern bdescr * RTS_VAR(pinned_object_block);
 155
 156 extern StgPtr RTS_VAR(alloc_Hp);
 157 extern StgPtr RTS_VAR(alloc_HpLim);
 158
 159 extern nat RTS_VAR(alloc_blocks);
 160 extern nat RTS_VAR(alloc_blocks_lim);
 161
 162 INLINE_HEADER rtsBool
 163 doYouWantToGC( void )
 164 {
 165   return (alloc_blocks >= alloc_blocks_lim);
 166 }
 167
 168 /* -----------------------------------------------------------------------------
 169    Performing Garbage Collection
 170
 171    GarbageCollect(get_roots)    Performs a garbage collection.
 172                                 'get_roots' is called to find all the
 173                                 roots that the system knows about.
 174
 175    StgClosure                   Called by get_roots on each root.
 176    MarkRoot(StgClosure *p)      Returns the new location of the root.
 177    -------------------------------------------------------------------------- */
 178
 179 extern void GarbageCollect(void (*get_roots)(evac_fn),rtsBool force_major_gc);
 180
 181 /* -----------------------------------------------------------------------------
 182    Generational garbage collection support
 183
 184    recordMutable(StgPtr p)       Informs the garbage collector that a
 185                                  previously immutable object has
 186                                  become (permanently) mutable.  Used
 187                                  by thawArray and similar.
 188
 189    updateWithIndirection(p1,p2)  Updates the object at p1 with an
 190                                  indirection pointing to p2.  This is
 191                                  normally called for objects in an old
 192                                  generation (>0) when they are updated.
 193
 194    updateWithPermIndirection(p1,p2)  As above but uses a permanent indir.
 195
 196    -------------------------------------------------------------------------- */
 197
 198 /*
 199  * Storage manager mutex
 200  */
 201 #if defined(THREADED_RTS)
 202 extern Mutex sm_mutex;
 203 #endif
 204
 205 #if defined(THREADED_RTS)
 206 #define ACQUIRE_SM_LOCK   ACQUIRE_LOCK(&sm_mutex);
 207 #define RELEASE_SM_LOCK   RELEASE_LOCK(&sm_mutex);
 208 #define ASSERT_SM_LOCK()  ASSERT_LOCK_HELD(&sm_mutex);
 209 #else
 210 #define ACQUIRE_SM_LOCK
 211 #define RELEASE_SM_LOCK
 212 #define ASSERT_SM_LOCK()
 213 #endif
 214
 215 INLINE_HEADER void
 216 recordMutableGen(StgClosure *p, generation *gen)
 217 {
 218     bdescr *bd;
 219
 220     bd = gen->mut_list;
 221     if (bd->free >= bd->start + BLOCK_SIZE_W) {
 222         bdescr *new_bd;
 223         new_bd = allocBlock();
 224         new_bd->link = bd;
 225         bd = new_bd;
 226         gen->mut_list = bd;
 227     }
 228     *bd->free++ = (StgWord)p;
 229
 230 }
 231
 232 INLINE_HEADER void
 233 recordMutableGenLock(StgClosure *p, generation *gen)
 234 {
 235     ACQUIRE_SM_LOCK;
 236     recordMutableGen(p,gen);
 237     RELEASE_SM_LOCK;
 238 }
 239
 240 INLINE_HEADER void
 241 recordMutable(StgClosure *p)
 242 {
 243     bdescr *bd;
 244     ASSERT(closure_MUTABLE(p));
 245     bd = Bdescr((P_)p);
 246     if (bd->gen_no > 0) recordMutableGen(p, &RTS_DEREF(generations)[bd->gen_no]);
 247 }
 248
 249 INLINE_HEADER void
 250 recordMutableLock(StgClosure *p)
 251 {
 252     ACQUIRE_SM_LOCK;
 253     recordMutable(p);
 254     RELEASE_SM_LOCK;
 255 }
 256
 257 /* -----------------------------------------------------------------------------
 258    The CAF table - used to let us revert CAFs in GHCi
 259    -------------------------------------------------------------------------- */
 260
 261 /* set to disable CAF garbage collection in GHCi. */
 262 /* (needed when dynamic libraries are used). */
 263 extern rtsBool keepCAFs;
 264
 265 /* -----------------------------------------------------------------------------
 266    This is the write barrier for MUT_VARs, a.k.a. IORefs.  A
 267    MUT_VAR_CLEAN object is not on the mutable list; a MUT_VAR_DIRTY
 268    is.  When written to, a MUT_VAR_CLEAN turns into a MUT_VAR_DIRTY
 269    and is put on the mutable list.
 270    -------------------------------------------------------------------------- */
 271
 272 void dirty_MUT_VAR(StgRegTable *reg, StgClosure *p);
 273
 274 /* -----------------------------------------------------------------------------
 275    DEBUGGING predicates for pointers
 276
 277    LOOKS_LIKE_INFO_PTR(p)    returns False if p is definitely not an info ptr
 278    LOOKS_LIKE_CLOSURE_PTR(p) returns False if p is definitely not a closure ptr
 279
 280    These macros are complete but not sound.  That is, they might
 281    return false positives.  Do not rely on them to distinguish info
 282    pointers from closure pointers, for example.
 283
 284    We don't use address-space predicates these days, for portability
 285    reasons, and the fact that code/data can be scattered about the
 286    address space in a dynamically-linked environment.  Our best option
 287    is to look at the alleged info table and see whether it seems to
 288    make sense...
 289    -------------------------------------------------------------------------- */
 290
 291 #define LOOKS_LIKE_INFO_PTR(p) \
 292    (p && ((StgInfoTable *)(INFO_PTR_TO_STRUCT(p)))->type != INVALID_OBJECT && \
 293     ((StgInfoTable *)(INFO_PTR_TO_STRUCT(p)))->type < N_CLOSURE_TYPES)
 294
 295 #define LOOKS_LIKE_CLOSURE_PTR(p) \
 296    (LOOKS_LIKE_INFO_PTR(((StgClosure *)(p))->header.info))
 297
 298 /* -----------------------------------------------------------------------------
 299    Macros for calculating how big a closure will be (used during allocation)
 300    -------------------------------------------------------------------------- */
 301
 302 INLINE_HEADER StgOffset PAP_sizeW   ( nat n_args )
 303 { return sizeofW(StgPAP) + n_args; }
 304
 305 INLINE_HEADER StgOffset AP_sizeW   ( nat n_args )
 306 { return sizeofW(StgAP) + n_args; }
 307
 308 INLINE_HEADER StgOffset AP_STACK_sizeW ( nat size )
 309 { return sizeofW(StgAP_STACK) + size; }
 310
 311 INLINE_HEADER StgOffset CONSTR_sizeW( nat p, nat np )
 312 { return sizeofW(StgHeader) + p + np; }
 313
 314 INLINE_HEADER StgOffset THUNK_SELECTOR_sizeW ( void )
 315 { return sizeofW(StgSelector); }
 316
 317 INLINE_HEADER StgOffset BLACKHOLE_sizeW ( void )
 318 { return sizeofW(StgHeader)+MIN_PAYLOAD_SIZE; }
 319
 320 /* --------------------------------------------------------------------------
 321    Sizes of closures
 322    ------------------------------------------------------------------------*/
 323
 324 INLINE_HEADER StgOffset sizeW_fromITBL( const StgInfoTable* itbl )
 325 { return sizeofW(StgClosure)
 326        + sizeofW(StgPtr)  * itbl->layout.payload.ptrs
 327        + sizeofW(StgWord) * itbl->layout.payload.nptrs; }
 328
 329 INLINE_HEADER StgOffset thunk_sizeW_fromITBL( const StgInfoTable* itbl )
 330 { return sizeofW(StgThunk)
 331        + sizeofW(StgPtr)  * itbl->layout.payload.ptrs
 332        + sizeofW(StgWord) * itbl->layout.payload.nptrs; }
 333
 334 INLINE_HEADER StgOffset ap_stack_sizeW( StgAP_STACK* x )
 335 { return AP_STACK_sizeW(x->size); }
 336
 337 INLINE_HEADER StgOffset ap_sizeW( StgAP* x )
 338 { return AP_sizeW(x->n_args); }
 339
 340 INLINE_HEADER StgOffset pap_sizeW( StgPAP* x )
 341 { return PAP_sizeW(x->n_args); }
 342
 343 INLINE_HEADER StgOffset arr_words_sizeW( StgArrWords* x )
 344 { return sizeofW(StgArrWords) + x->words; }
 345
 346 INLINE_HEADER StgOffset mut_arr_ptrs_sizeW( StgMutArrPtrs* x )
 347 { return sizeofW(StgMutArrPtrs) + x->ptrs; }
 348
 349 INLINE_HEADER StgWord tso_sizeW ( StgTSO *tso )
 350 { return TSO_STRUCT_SIZEW + tso->stack_size; }
 351
 352 INLINE_HEADER StgWord bco_sizeW ( StgBCO *bco )
 353 { return bco->size; }
 354
 355 STATIC_INLINE nat
 356 closure_sizeW_ (StgClosure *p, StgInfoTable *info)
 357 {
 358     switch (info->type) {
 359     case THUNK_0_1:
 360     case THUNK_1_0:
 361         return sizeofW(StgThunk) + 1;
 362     case FUN_0_1:
 363     case CONSTR_0_1:
 364     case FUN_1_0:
 365     case CONSTR_1_0:
 366         return sizeofW(StgHeader) + 1;
 367     case THUNK_0_2:
 368     case THUNK_1_1:
 369     case THUNK_2_0:
 370         return sizeofW(StgThunk) + 2;
 371     case FUN_0_2:
 372     case CONSTR_0_2:
 373     case FUN_1_1:
 374     case CONSTR_1_1:
 375     case FUN_2_0:
 376     case CONSTR_2_0:
 377         return sizeofW(StgHeader) + 2;
 378     case THUNK:
 379         return thunk_sizeW_fromITBL(info);
 380     case THUNK_SELECTOR:
 381         return THUNK_SELECTOR_sizeW();
 382     case AP_STACK:
 383         return ap_stack_sizeW((StgAP_STACK *)p);
 384     case AP:
 385     case PAP:
 386         return pap_sizeW((StgPAP *)p);
 387     case IND:
 388     case IND_PERM:
 389     case IND_OLDGEN:
 390     case IND_OLDGEN_PERM:
 391         return sizeofW(StgInd);
 392     case ARR_WORDS:
 393         return arr_words_sizeW((StgArrWords *)p);
 394     case MUT_ARR_PTRS_CLEAN:
 395     case MUT_ARR_PTRS_DIRTY:
 396     case MUT_ARR_PTRS_FROZEN:
 397     case MUT_ARR_PTRS_FROZEN0:
 398         return mut_arr_ptrs_sizeW((StgMutArrPtrs*)p);
 399     case TSO:
 400         return tso_sizeW((StgTSO *)p);
 401     case BCO:
 402         return bco_sizeW((StgBCO *)p);
 403     case TVAR_WAIT_QUEUE:
 404         return sizeofW(StgTVarWaitQueue);
 405     case TVAR:
 406         return sizeofW(StgTVar);
 407     case TREC_CHUNK:
 408         return sizeofW(StgTRecChunk);
 409     case TREC_HEADER:
 410         return sizeofW(StgTRecHeader);
 411     default:
 412         return sizeW_fromITBL(info);
 413     }
 414 }
 415
 416 // The definitive way to find the size, in words, of a heap-allocated closure
 417 STATIC_INLINE nat
 418 closure_sizeW (StgClosure *p)
 419 {
 420     return closure_sizeW_(p, get_itbl(p));
 421 }
 422
 423 /* -----------------------------------------------------------------------------
 424    Sizes of stack frames
 425    -------------------------------------------------------------------------- */
 426
 427 INLINE_HEADER StgWord stack_frame_sizeW( StgClosure *frame )
 428 {
 429     StgRetInfoTable *info;
 430
 431     info = get_ret_itbl(frame);
 432     switch (info->i.type) {
 433
 434     case RET_DYN:
 435     {
 436         StgRetDyn *dyn = (StgRetDyn *)frame;
 437         return  sizeofW(StgRetDyn) + RET_DYN_BITMAP_SIZE +
 438             RET_DYN_NONPTR_REGS_SIZE +
 439             RET_DYN_PTRS(dyn->liveness) + RET_DYN_NONPTRS(dyn->liveness);
 440     }
 441
 442     case RET_FUN:
 443         return sizeofW(StgRetFun) + ((StgRetFun *)frame)->size;
 444
 445     case RET_BIG:
 446     case RET_VEC_BIG:
 447         return 1 + GET_LARGE_BITMAP(&info->i)->size;
 448
 449     case RET_BCO:
 450         return 2 + BCO_BITMAP_SIZE((StgBCO *)((P_)frame)[1]);
 451
 452     default:
 453         return 1 + BITMAP_SIZE(info->i.layout.bitmap);
 454     }
 455 }
 456
 457 /* -----------------------------------------------------------------------------
 458    Nursery manipulation
 459    -------------------------------------------------------------------------- */
 460
 461 extern void     allocNurseries       ( void );
 462 extern void     resetNurseries       ( void );
 463 extern void     resizeNurseries      ( nat blocks );
 464 extern void     resizeNurseriesFixed ( nat blocks );
 465 extern void     tidyAllocateLists    ( void );
 466 extern lnat     countNurseryBlocks   ( void );
 467
 468 /* -----------------------------------------------------------------------------
 469    Functions from GC.c
 470    -------------------------------------------------------------------------- */
 471
 472 extern void         threadPaused ( Capability *cap, StgTSO * );
 473 extern StgClosure * isAlive      ( StgClosure *p );
 474 extern void         markCAFs     ( evac_fn evac );
 475
 476 /* -----------------------------------------------------------------------------
 477    Stats 'n' DEBUG stuff
 478    -------------------------------------------------------------------------- */
 479
 480 extern ullong RTS_VAR(total_allocated);
 481
 482 extern lnat calcAllocated  ( void );
 483 extern lnat calcLive       ( void );
 484 extern lnat calcNeeded     ( void );
 485
 486 #if defined(DEBUG)
 487 extern void memInventory(void);
 488 extern void checkSanity(void);
 489 extern nat  countBlocks(bdescr *);
 490 extern void checkNurserySanity( step *stp );
 491 #endif
 492
 493 #if defined(DEBUG)
 494 void printMutOnceList(generation *gen);
 495 void printMutableList(generation *gen);
 496 #endif
 497
 498 /* ----------------------------------------------------------------------------
 499    Storage manager internal APIs and globals
 500    ------------------------------------------------------------------------- */
 501
 502 #define END_OF_STATIC_LIST stgCast(StgClosure*,1)
 503
 504 extern void newDynCAF(StgClosure *);
 505
 506 extern void move_TSO(StgTSO *src, StgTSO *dest);
 507 extern StgTSO *relocate_stack(StgTSO *dest, ptrdiff_t diff);
 508
 509 extern StgClosure * RTS_VAR(scavenged_static_objects);
 510 extern StgWeak    * RTS_VAR(old_weak_ptr_list);
 511 extern StgWeak    * RTS_VAR(weak_ptr_list);
 512 extern StgClosure * RTS_VAR(caf_list);
 513 extern StgClosure * RTS_VAR(revertible_caf_list);
 514 extern StgTSO     * RTS_VAR(resurrected_threads);
 515
 516 #endif /* STORAGE_H */