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