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 extern void freeStorage(void);
 113
 114 /* -----------------------------------------------------------------------------
 115    Generic allocation
 116
 117    StgPtr allocateInGen(generation *g, nat n)
 118                                 Allocates a chunk of contiguous store
 119                                 n words long in generation g,
 120                                 returning a pointer to the first word.
 121                                 Always succeeds.
 122
 123    StgPtr allocate(nat n)       Equaivalent to allocateInGen(g0)
 124
 125    StgPtr allocateLocal(Capability *cap, nat n)
 126                                 Allocates memory from the nursery in
 127                                 the current Capability.  This can be
 128                                 done without taking a global lock,
 129                                 unlike allocate().
 130
 131    StgPtr allocatePinned(nat n) Allocates a chunk of contiguous store
 132                                 n words long, which is at a fixed
 133                                 address (won't be moved by GC).
 134                                 Returns a pointer to the first word.
 135                                 Always succeeds.
 136
 137                                 NOTE: the GC can't in general handle
 138                                 pinned objects, so allocatePinned()
 139                                 can only be used for ByteArrays at the
 140                                 moment.
 141
 142                                 Don't forget to TICK_ALLOC_XXX(...)
 143                                 after calling allocate or
 144                                 allocatePinned, for the
 145                                 benefit of the ticky-ticky profiler.
 146
 147    rtsBool doYouWantToGC(void)  Returns True if the storage manager is
 148                                 ready to perform a GC, False otherwise.
 149
 150    lnat  allocatedBytes(void)  Returns the number of bytes allocated
 151                                 via allocate() since the last GC.
 152                                 Used in the reporting of statistics.
 153
 154    -------------------------------------------------------------------------- */
 155
 156 extern StgPtr  allocate        ( nat n );
 157 extern StgPtr  allocateInGen   ( generation *g, nat n );
 158 extern StgPtr  allocateLocal   ( Capability *cap, nat n );
 159 extern StgPtr  allocatePinned  ( nat n );
 160 extern lnat    allocatedBytes  ( void );
 161
 162 extern bdescr * RTS_VAR(small_alloc_list);
 163 extern bdescr * RTS_VAR(large_alloc_list);
 164 extern bdescr * RTS_VAR(pinned_object_block);
 165
 166 extern StgPtr RTS_VAR(alloc_Hp);
 167 extern StgPtr RTS_VAR(alloc_HpLim);
 168
 169 extern nat RTS_VAR(alloc_blocks);
 170 extern nat RTS_VAR(alloc_blocks_lim);
 171
 172 INLINE_HEADER rtsBool
 173 doYouWantToGC( void )
 174 {
 175   return (alloc_blocks >= alloc_blocks_lim);
 176 }
 177
 178 /* memory allocator for executable memory */
 179 extern void *allocateExec (nat bytes);
 180 extern void freeExec (void *p);
 181
 182 /* -----------------------------------------------------------------------------
 183    Performing Garbage Collection
 184
 185    GarbageCollect(get_roots)    Performs a garbage collection.
 186                                 'get_roots' is called to find all the
 187                                 roots that the system knows about.
 188
 189    StgClosure                   Called by get_roots on each root.
 190    MarkRoot(StgClosure *p)      Returns the new location of the root.
 191    -------------------------------------------------------------------------- */
 192
 193 extern void GarbageCollect(rtsBool force_major_gc);
 194
 195 /* -----------------------------------------------------------------------------
 196    Generational garbage collection support
 197
 198    recordMutable(StgPtr p)       Informs the garbage collector that a
 199                                  previously immutable object has
 200                                  become (permanently) mutable.  Used
 201                                  by thawArray and similar.
 202
 203    updateWithIndirection(p1,p2)  Updates the object at p1 with an
 204                                  indirection pointing to p2.  This is
 205                                  normally called for objects in an old
 206                                  generation (>0) when they are updated.
 207
 208    updateWithPermIndirection(p1,p2)  As above but uses a permanent indir.
 209
 210    -------------------------------------------------------------------------- */
 211
 212 /*
 213  * Storage manager mutex
 214  */
 215 #if defined(THREADED_RTS)
 216 extern Mutex sm_mutex;
 217 extern Mutex atomic_modify_mutvar_mutex;
 218 #endif
 219
 220 #if defined(THREADED_RTS)
 221 #define ACQUIRE_SM_LOCK   ACQUIRE_LOCK(&sm_mutex);
 222 #define RELEASE_SM_LOCK   RELEASE_LOCK(&sm_mutex);
 223 #define ASSERT_SM_LOCK()  ASSERT_LOCK_HELD(&sm_mutex);
 224 #else
 225 #define ACQUIRE_SM_LOCK
 226 #define RELEASE_SM_LOCK
 227 #define ASSERT_SM_LOCK()
 228 #endif
 229
 230 INLINE_HEADER void
 231 recordMutableGen(StgClosure *p, generation *gen)
 232 {
 233     bdescr *bd;
 234
 235     bd = gen->mut_list;
 236     if (bd->free >= bd->start + BLOCK_SIZE_W) {
 237         bdescr *new_bd;
 238         new_bd = allocBlock();
 239         new_bd->link = bd;
 240         bd = new_bd;
 241         gen->mut_list = bd;
 242     }
 243     *bd->free++ = (StgWord)p;
 244
 245 }
 246
 247 INLINE_HEADER void
 248 recordMutableGenLock(StgClosure *p, generation *gen)
 249 {
 250     ACQUIRE_SM_LOCK;
 251     recordMutableGen(p,gen);
 252     RELEASE_SM_LOCK;
 253 }
 254
 255 INLINE_HEADER void
 256 recordMutable(StgClosure *p)
 257 {
 258     bdescr *bd;
 259     ASSERT(closure_MUTABLE(p));
 260     bd = Bdescr((P_)p);
 261     if (bd->gen_no > 0) recordMutableGen(p, &RTS_DEREF(generations)[bd->gen_no]);
 262 }
 263
 264 INLINE_HEADER void
 265 recordMutableLock(StgClosure *p)
 266 {
 267     ACQUIRE_SM_LOCK;
 268     recordMutable(p);
 269     RELEASE_SM_LOCK;
 270 }
 271
 272 /* -----------------------------------------------------------------------------
 273    The CAF table - used to let us revert CAFs in GHCi
 274    -------------------------------------------------------------------------- */
 275
 276 /* set to disable CAF garbage collection in GHCi. */
 277 /* (needed when dynamic libraries are used). */
 278 extern rtsBool keepCAFs;
 279
 280 /* -----------------------------------------------------------------------------
 281    This is the write barrier for MUT_VARs, a.k.a. IORefs.  A
 282    MUT_VAR_CLEAN object is not on the mutable list; a MUT_VAR_DIRTY
 283    is.  When written to, a MUT_VAR_CLEAN turns into a MUT_VAR_DIRTY
 284    and is put on the mutable list.
 285    -------------------------------------------------------------------------- */
 286
 287 void dirty_MUT_VAR(StgRegTable *reg, StgClosure *p);
 288
 289 /* -----------------------------------------------------------------------------
 290    DEBUGGING predicates for pointers
 291
 292    LOOKS_LIKE_INFO_PTR(p)    returns False if p is definitely not an info ptr
 293    LOOKS_LIKE_CLOSURE_PTR(p) returns False if p is definitely not a closure ptr
 294
 295    These macros are complete but not sound.  That is, they might
 296    return false positives.  Do not rely on them to distinguish info
 297    pointers from closure pointers, for example.
 298
 299    We don't use address-space predicates these days, for portability
 300    reasons, and the fact that code/data can be scattered about the
 301    address space in a dynamically-linked environment.  Our best option
 302    is to look at the alleged info table and see whether it seems to
 303    make sense...
 304    -------------------------------------------------------------------------- */
 305
 306 #define LOOKS_LIKE_INFO_PTR(p) \
 307    (p && ((StgInfoTable *)(INFO_PTR_TO_STRUCT(p)))->type != INVALID_OBJECT && \
 308     ((StgInfoTable *)(INFO_PTR_TO_STRUCT(p)))->type < N_CLOSURE_TYPES)
 309
 310 #define LOOKS_LIKE_CLOSURE_PTR(p) \
 311   (LOOKS_LIKE_INFO_PTR((UNTAG_CLOSURE((StgClosure *)(p)))->header.info))
 312
 313 /* -----------------------------------------------------------------------------
 314    Macros for calculating how big a closure will be (used during allocation)
 315    -------------------------------------------------------------------------- */
 316
 317 INLINE_HEADER StgOffset PAP_sizeW   ( nat n_args )
 318 { return sizeofW(StgPAP) + n_args; }
 319
 320 INLINE_HEADER StgOffset AP_sizeW   ( nat n_args )
 321 { return sizeofW(StgAP) + n_args; }
 322
 323 INLINE_HEADER StgOffset AP_STACK_sizeW ( nat size )
 324 { return sizeofW(StgAP_STACK) + size; }
 325
 326 INLINE_HEADER StgOffset CONSTR_sizeW( nat p, nat np )
 327 { return sizeofW(StgHeader) + p + np; }
 328
 329 INLINE_HEADER StgOffset THUNK_SELECTOR_sizeW ( void )
 330 { return sizeofW(StgSelector); }
 331
 332 INLINE_HEADER StgOffset BLACKHOLE_sizeW ( void )
 333 { return sizeofW(StgHeader)+MIN_PAYLOAD_SIZE; }
 334
 335 /* --------------------------------------------------------------------------
 336    Sizes of closures
 337    ------------------------------------------------------------------------*/
 338
 339 INLINE_HEADER StgOffset sizeW_fromITBL( const StgInfoTable* itbl )
 340 { return sizeofW(StgClosure)
 341        + sizeofW(StgPtr)  * itbl->layout.payload.ptrs
 342        + sizeofW(StgWord) * itbl->layout.payload.nptrs; }
 343
 344 INLINE_HEADER StgOffset thunk_sizeW_fromITBL( const StgInfoTable* itbl )
 345 { return sizeofW(StgThunk)
 346        + sizeofW(StgPtr)  * itbl->layout.payload.ptrs
 347        + sizeofW(StgWord) * itbl->layout.payload.nptrs; }
 348
 349 INLINE_HEADER StgOffset ap_stack_sizeW( StgAP_STACK* x )
 350 { return AP_STACK_sizeW(x->size); }
 351
 352 INLINE_HEADER StgOffset ap_sizeW( StgAP* x )
 353 { return AP_sizeW(x->n_args); }
 354
 355 INLINE_HEADER StgOffset pap_sizeW( StgPAP* x )
 356 { return PAP_sizeW(x->n_args); }
 357
 358 INLINE_HEADER StgOffset arr_words_sizeW( StgArrWords* x )
 359 { return sizeofW(StgArrWords) + x->words; }
 360
 361 INLINE_HEADER StgOffset mut_arr_ptrs_sizeW( StgMutArrPtrs* x )
 362 { return sizeofW(StgMutArrPtrs) + x->ptrs; }
 363
 364 INLINE_HEADER StgWord tso_sizeW ( StgTSO *tso )
 365 { return TSO_STRUCT_SIZEW + tso->stack_size; }
 366
 367 INLINE_HEADER StgWord bco_sizeW ( StgBCO *bco )
 368 { return bco->size; }
 369
 370 INLINE_HEADER nat
 371 closure_sizeW_ (StgClosure *p, StgInfoTable *info)
 372 {
 373     switch (info->type) {
 374     case THUNK_0_1:
 375     case THUNK_1_0:
 376         return sizeofW(StgThunk) + 1;
 377     case FUN_0_1:
 378     case CONSTR_0_1:
 379     case FUN_1_0:
 380     case CONSTR_1_0:
 381         return sizeofW(StgHeader) + 1;
 382     case THUNK_0_2:
 383     case THUNK_1_1:
 384     case THUNK_2_0:
 385         return sizeofW(StgThunk) + 2;
 386     case FUN_0_2:
 387     case CONSTR_0_2:
 388     case FUN_1_1:
 389     case CONSTR_1_1:
 390     case FUN_2_0:
 391     case CONSTR_2_0:
 392         return sizeofW(StgHeader) + 2;
 393     case THUNK:
 394         return thunk_sizeW_fromITBL(info);
 395     case THUNK_SELECTOR:
 396         return THUNK_SELECTOR_sizeW();
 397     case AP_STACK:
 398         return ap_stack_sizeW((StgAP_STACK *)p);
 399     case AP:
 400         return ap_sizeW((StgAP *)p);
 401     case PAP:
 402         return pap_sizeW((StgPAP *)p);
 403     case IND:
 404     case IND_PERM:
 405     case IND_OLDGEN:
 406     case IND_OLDGEN_PERM:
 407         return sizeofW(StgInd);
 408     case ARR_WORDS:
 409         return arr_words_sizeW((StgArrWords *)p);
 410     case MUT_ARR_PTRS_CLEAN:
 411     case MUT_ARR_PTRS_DIRTY:
 412     case MUT_ARR_PTRS_FROZEN:
 413     case MUT_ARR_PTRS_FROZEN0:
 414         return mut_arr_ptrs_sizeW((StgMutArrPtrs*)p);
 415     case TSO:
 416         return tso_sizeW((StgTSO *)p);
 417     case BCO:
 418         return bco_sizeW((StgBCO *)p);
 419     case TVAR_WATCH_QUEUE:
 420         return sizeofW(StgTVarWatchQueue);
 421     case TVAR:
 422         return sizeofW(StgTVar);
 423     case TREC_CHUNK:
 424         return sizeofW(StgTRecChunk);
 425     case TREC_HEADER:
 426         return sizeofW(StgTRecHeader);
 427     case ATOMIC_INVARIANT:
 428         return sizeofW(StgAtomicInvariant);
 429     case INVARIANT_CHECK_QUEUE:
 430         return sizeofW(StgInvariantCheckQueue);
 431     default:
 432         return sizeW_fromITBL(info);
 433     }
 434 }
 435
 436 // The definitive way to find the size, in words, of a heap-allocated closure
 437 INLINE_HEADER nat
 438 closure_sizeW (StgClosure *p)
 439 {
 440     return closure_sizeW_(p, get_itbl(p));
 441 }
 442
 443 /* -----------------------------------------------------------------------------
 444    Sizes of stack frames
 445    -------------------------------------------------------------------------- */
 446
 447 INLINE_HEADER StgWord stack_frame_sizeW( StgClosure *frame )
 448 {
 449     StgRetInfoTable *info;
 450
 451     info = get_ret_itbl(frame);
 452     switch (info->i.type) {
 453
 454     case RET_DYN:
 455     {
 456         StgRetDyn *dyn = (StgRetDyn *)frame;
 457         return  sizeofW(StgRetDyn) + RET_DYN_BITMAP_SIZE +
 458             RET_DYN_NONPTR_REGS_SIZE +
 459             RET_DYN_PTRS(dyn->liveness) + RET_DYN_NONPTRS(dyn->liveness);
 460     }
 461
 462     case RET_FUN:
 463         return sizeofW(StgRetFun) + ((StgRetFun *)frame)->size;
 464
 465     case RET_BIG:
 466         return 1 + GET_LARGE_BITMAP(&info->i)->size;
 467
 468     case RET_BCO:
 469         return 2 + BCO_BITMAP_SIZE((StgBCO *)((P_)frame)[1]);
 470
 471     default:
 472         return 1 + BITMAP_SIZE(info->i.layout.bitmap);
 473     }
 474 }
 475
 476 /* -----------------------------------------------------------------------------
 477    Nursery manipulation
 478    -------------------------------------------------------------------------- */
 479
 480 extern void     allocNurseries       ( void );
 481 extern void     resetNurseries       ( void );
 482 extern void     resizeNurseries      ( nat blocks );
 483 extern void     resizeNurseriesFixed ( nat blocks );
 484 extern lnat     countNurseryBlocks   ( void );
 485
 486 /* -----------------------------------------------------------------------------
 487    Functions from GC.c
 488    -------------------------------------------------------------------------- */
 489
 490 typedef void (*evac_fn)(StgClosure **);
 491
 492 extern void         threadPaused ( Capability *cap, StgTSO * );
 493 extern StgClosure * isAlive      ( StgClosure *p );
 494 extern void         markCAFs     ( evac_fn evac );
 495
 496 /* -----------------------------------------------------------------------------
 497    Stats 'n' DEBUG stuff
 498    -------------------------------------------------------------------------- */
 499
 500 extern ullong RTS_VAR(total_allocated);
 501
 502 extern lnat calcAllocated  ( void );
 503 extern lnat calcLive       ( void );
 504 extern lnat calcNeeded     ( void );
 505
 506 #if defined(DEBUG)
 507 extern void memInventory(void);
 508 extern void checkSanity(void);
 509 extern nat  countBlocks(bdescr *);
 510 extern void checkNurserySanity( step *stp );
 511 #endif
 512
 513 #if defined(DEBUG)
 514 void printMutOnceList(generation *gen);
 515 void printMutableList(generation *gen);
 516 #endif
 517
 518 /* ----------------------------------------------------------------------------
 519    Storage manager internal APIs and globals
 520    ------------------------------------------------------------------------- */
 521
 522 #define END_OF_STATIC_LIST stgCast(StgClosure*,1)
 523
 524 extern void newDynCAF(StgClosure *);
 525
 526 extern void move_TSO(StgTSO *src, StgTSO *dest);
 527 extern StgTSO *relocate_stack(StgTSO *dest, ptrdiff_t diff);
 528
 529 extern StgClosure * RTS_VAR(scavenged_static_objects);
 530 extern StgWeak    * RTS_VAR(old_weak_ptr_list);
 531 extern StgWeak    * RTS_VAR(weak_ptr_list);
 532 extern StgClosure * RTS_VAR(caf_list);
 533 extern StgClosure * RTS_VAR(revertible_caf_list);
 534 extern StgTSO     * RTS_VAR(resurrected_threads);
 535
 536 #endif /* STORAGE_H */