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