1 /* -----------------------------------------------------------------------------
3 * (c) The GHC Team, 1998-2004
5 * External Storage Manger Interface
7 * ---------------------------------------------------------------------------*/
13 #include "OSThreads.h"
16 /* -----------------------------------------------------------------------------
19 * We support an arbitrary number of generations, with an arbitrary number
20 * of steps per generation. Notes (in no particular order):
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.
27 * - the oldest generation has one step. There's no point in aging
28 * objects in the oldest generation.
30 * - generation 0, step 0 (G0S0) is the allocation area. It is given
31 * a fixed set of blocks during initialisation, and these blocks
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.
40 * - the mutable-list is per-generation (not per-step). G0 doesn't
41 * have one (since every garbage collection collects at least G0).
43 * - block descriptors contain pointers to both the step and the
44 * generation that the block belongs to, for convenience.
46 * - static objects are stored in per-generation lists. See GC.c for
47 * details of how we collect CAFs in the generational scheme.
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.
53 * ------------------------------------------------------------------------- */
55 typedef struct step_ {
56 unsigned int no; // step number in this generation
57 unsigned int abs_no; // absolute step number
59 struct generation_ * gen; // generation this step belongs to
60 unsigned int gen_no; // generation number (cached)
62 bdescr * blocks; // blocks in this step
63 unsigned int n_blocks; // number of blocks
64 unsigned int n_words; // number of words
66 struct step_ * to; // destination step for live objects
68 bdescr * large_objects; // large objects (doubly linked)
69 unsigned int n_large_blocks; // no. of blocks used by large objs
71 StgTSO * threads; // threads in this step
72 // linked via global_link
74 // ------------------------------------
75 // Fields below are used during GC only
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
81 #if defined(THREADED_RTS)
82 char pad[128]; // make sure the following is
83 // on a separate cache line.
84 SpinLock sync_todo; // lock for todos
85 SpinLock sync_large_objects; // lock for large_objects
86 // and scavenged_large_objects
89 int mark; // mark (not copy)? (old gen only)
90 int compact; // compact (not sweep)? (old gen only)
92 bdescr * old_blocks; // bdescr of first from-space block
93 unsigned int n_old_blocks; // number of blocks in from-space
94 unsigned int live_estimate; // for sweeping: estimate of live data
96 bdescr * todos; // blocks waiting to be scavenged
98 unsigned int n_todos; // count of above
100 bdescr * part_blocks; // partially-full scanned blocks
101 unsigned int n_part_blocks; // count of above
103 bdescr * scavenged_large_objects; // live large objs after GC (d-link)
104 unsigned int n_scavenged_large_blocks; // size (not count) of above
106 bdescr * bitmap; // bitmap for compacting collection
108 StgTSO * old_threads;
113 typedef struct generation_ {
114 unsigned int no; // generation number
115 step * steps; // steps
116 unsigned int n_steps; // number of steps
117 unsigned int max_blocks; // max blocks in step 0
118 bdescr *mut_list; // mut objects in this gen (not G0)
121 unsigned int collections;
122 unsigned int par_collections;
123 unsigned int failed_promotions;
125 // temporary use during GC:
126 bdescr *saved_mut_list;
129 extern generation * RTS_VAR(generations);
131 extern generation * RTS_VAR(g0);
132 extern step * RTS_VAR(g0s0);
133 extern generation * RTS_VAR(oldest_gen);
134 extern step * RTS_VAR(all_steps);
135 extern nat RTS_VAR(total_steps);
137 /* -----------------------------------------------------------------------------
138 Initialisation / De-initialisation
139 -------------------------------------------------------------------------- */
141 extern void initStorage(void);
142 extern void exitStorage(void);
143 extern void freeStorage(void);
145 /* -----------------------------------------------------------------------------
148 StgPtr allocateInGen(generation *g, nat n)
149 Allocates a chunk of contiguous store
150 n words long in generation g,
151 returning a pointer to the first word.
154 StgPtr allocate(nat n) Equaivalent to allocateInGen(g0)
156 StgPtr allocateLocal(Capability *cap, nat n)
157 Allocates memory from the nursery in
158 the current Capability. This can be
159 done without taking a global lock,
162 StgPtr allocatePinned(nat n) Allocates a chunk of contiguous store
163 n words long, which is at a fixed
164 address (won't be moved by GC).
165 Returns a pointer to the first word.
168 NOTE: the GC can't in general handle
169 pinned objects, so allocatePinned()
170 can only be used for ByteArrays at the
173 Don't forget to TICK_ALLOC_XXX(...)
174 after calling allocate or
175 allocatePinned, for the
176 benefit of the ticky-ticky profiler.
178 rtsBool doYouWantToGC(void) Returns True if the storage manager is
179 ready to perform a GC, False otherwise.
181 lnat allocatedBytes(void) Returns the number of bytes allocated
182 via allocate() since the last GC.
183 Used in the reporting of statistics.
185 -------------------------------------------------------------------------- */
187 extern StgPtr allocate ( nat n );
188 extern StgPtr allocateInGen ( generation *g, nat n );
189 extern StgPtr allocateLocal ( Capability *cap, nat n );
190 extern StgPtr allocatePinned ( nat n );
191 extern lnat allocatedBytes ( void );
193 extern bdescr * RTS_VAR(small_alloc_list);
194 extern bdescr * RTS_VAR(large_alloc_list);
195 extern bdescr * RTS_VAR(pinned_object_block);
197 extern nat RTS_VAR(alloc_blocks);
198 extern nat RTS_VAR(alloc_blocks_lim);
200 INLINE_HEADER rtsBool
201 doYouWantToGC( void )
203 return (alloc_blocks >= alloc_blocks_lim);
206 /* memory allocator for executable memory */
207 extern void *allocateExec (nat bytes);
208 extern void freeExec (void *p);
210 /* for splitting blocks groups in two */
211 extern bdescr * splitLargeBlock (bdescr *bd, nat blocks);
213 /* -----------------------------------------------------------------------------
214 Performing Garbage Collection
216 GarbageCollect(get_roots) Performs a garbage collection.
217 'get_roots' is called to find all the
218 roots that the system knows about.
221 -------------------------------------------------------------------------- */
223 extern void GarbageCollect(rtsBool force_major_gc);
225 /* -----------------------------------------------------------------------------
226 Generational garbage collection support
228 recordMutable(StgPtr p) Informs the garbage collector that a
229 previously immutable object has
230 become (permanently) mutable. Used
231 by thawArray and similar.
233 updateWithIndirection(p1,p2) Updates the object at p1 with an
234 indirection pointing to p2. This is
235 normally called for objects in an old
236 generation (>0) when they are updated.
238 updateWithPermIndirection(p1,p2) As above but uses a permanent indir.
240 -------------------------------------------------------------------------- */
243 * Storage manager mutex
245 #if defined(THREADED_RTS)
246 extern Mutex sm_mutex;
247 extern Mutex atomic_modify_mutvar_mutex;
248 extern SpinLock recordMutableGen_sync;
251 #if defined(THREADED_RTS)
252 #define ACQUIRE_SM_LOCK ACQUIRE_LOCK(&sm_mutex);
253 #define RELEASE_SM_LOCK RELEASE_LOCK(&sm_mutex);
254 #define ASSERT_SM_LOCK() ASSERT_LOCK_HELD(&sm_mutex);
256 #define ACQUIRE_SM_LOCK
257 #define RELEASE_SM_LOCK
258 #define ASSERT_SM_LOCK()
262 recordMutableGen(StgClosure *p, generation *gen)
267 if (bd->free >= bd->start + BLOCK_SIZE_W) {
269 new_bd = allocBlock();
274 *bd->free++ = (StgWord)p;
279 recordMutableGenLock(StgClosure *p, generation *gen)
282 recordMutableGen(p,gen);
286 extern bdescr *allocBlock_sync(void);
288 // Version of recordMutableGen() for use in parallel GC. The same as
289 // recordMutableGen(), except that we surround it with a spinlock and
290 // call the spinlock version of allocBlock().
292 recordMutableGen_GC(StgClosure *p, generation *gen)
296 ACQUIRE_SPIN_LOCK(&recordMutableGen_sync);
299 if (bd->free >= bd->start + BLOCK_SIZE_W) {
301 new_bd = allocBlock_sync();
306 *bd->free++ = (StgWord)p;
308 RELEASE_SPIN_LOCK(&recordMutableGen_sync);
312 recordMutable(StgClosure *p)
315 ASSERT(closure_MUTABLE(p));
317 if (bd->gen_no > 0) recordMutableGen(p, &RTS_DEREF(generations)[bd->gen_no]);
321 recordMutableLock(StgClosure *p)
328 /* -----------------------------------------------------------------------------
329 The CAF table - used to let us revert CAFs in GHCi
330 -------------------------------------------------------------------------- */
332 /* set to disable CAF garbage collection in GHCi. */
333 /* (needed when dynamic libraries are used). */
334 extern rtsBool keepCAFs;
336 /* -----------------------------------------------------------------------------
337 This is the write barrier for MUT_VARs, a.k.a. IORefs. A
338 MUT_VAR_CLEAN object is not on the mutable list; a MUT_VAR_DIRTY
339 is. When written to, a MUT_VAR_CLEAN turns into a MUT_VAR_DIRTY
340 and is put on the mutable list.
341 -------------------------------------------------------------------------- */
343 void dirty_MUT_VAR(StgRegTable *reg, StgClosure *p);
345 /* -----------------------------------------------------------------------------
346 DEBUGGING predicates for pointers
348 LOOKS_LIKE_INFO_PTR(p) returns False if p is definitely not an info ptr
349 LOOKS_LIKE_CLOSURE_PTR(p) returns False if p is definitely not a closure ptr
351 These macros are complete but not sound. That is, they might
352 return false positives. Do not rely on them to distinguish info
353 pointers from closure pointers, for example.
355 We don't use address-space predicates these days, for portability
356 reasons, and the fact that code/data can be scattered about the
357 address space in a dynamically-linked environment. Our best option
358 is to look at the alleged info table and see whether it seems to
360 -------------------------------------------------------------------------- */
362 #define LOOKS_LIKE_INFO_PTR(p) \
363 (p && (IS_FORWARDING_PTR(p) || LOOKS_LIKE_INFO_PTR_NOT_NULL(p)))
365 #define LOOKS_LIKE_INFO_PTR_NOT_NULL(p) \
366 (((StgInfoTable *)(INFO_PTR_TO_STRUCT(p)))->type != INVALID_OBJECT && \
367 ((StgInfoTable *)(INFO_PTR_TO_STRUCT(p)))->type < N_CLOSURE_TYPES)
369 #define LOOKS_LIKE_CLOSURE_PTR(p) \
370 (LOOKS_LIKE_INFO_PTR((UNTAG_CLOSURE((StgClosure *)(p)))->header.info))
372 /* -----------------------------------------------------------------------------
373 Macros for calculating how big a closure will be (used during allocation)
374 -------------------------------------------------------------------------- */
376 INLINE_HEADER StgOffset PAP_sizeW ( nat n_args )
377 { return sizeofW(StgPAP) + n_args; }
379 INLINE_HEADER StgOffset AP_sizeW ( nat n_args )
380 { return sizeofW(StgAP) + n_args; }
382 INLINE_HEADER StgOffset AP_STACK_sizeW ( nat size )
383 { return sizeofW(StgAP_STACK) + size; }
385 INLINE_HEADER StgOffset CONSTR_sizeW( nat p, nat np )
386 { return sizeofW(StgHeader) + p + np; }
388 INLINE_HEADER StgOffset THUNK_SELECTOR_sizeW ( void )
389 { return sizeofW(StgSelector); }
391 INLINE_HEADER StgOffset BLACKHOLE_sizeW ( void )
392 { return sizeofW(StgHeader)+MIN_PAYLOAD_SIZE; }
394 /* --------------------------------------------------------------------------
396 ------------------------------------------------------------------------*/
398 INLINE_HEADER StgOffset sizeW_fromITBL( const StgInfoTable* itbl )
399 { return sizeofW(StgClosure)
400 + sizeofW(StgPtr) * itbl->layout.payload.ptrs
401 + sizeofW(StgWord) * itbl->layout.payload.nptrs; }
403 INLINE_HEADER StgOffset thunk_sizeW_fromITBL( const StgInfoTable* itbl )
404 { return sizeofW(StgThunk)
405 + sizeofW(StgPtr) * itbl->layout.payload.ptrs
406 + sizeofW(StgWord) * itbl->layout.payload.nptrs; }
408 INLINE_HEADER StgOffset ap_stack_sizeW( StgAP_STACK* x )
409 { return AP_STACK_sizeW(x->size); }
411 INLINE_HEADER StgOffset ap_sizeW( StgAP* x )
412 { return AP_sizeW(x->n_args); }
414 INLINE_HEADER StgOffset pap_sizeW( StgPAP* x )
415 { return PAP_sizeW(x->n_args); }
417 INLINE_HEADER StgOffset arr_words_sizeW( StgArrWords* x )
418 { return sizeofW(StgArrWords) + x->words; }
420 INLINE_HEADER StgOffset mut_arr_ptrs_sizeW( StgMutArrPtrs* x )
421 { return sizeofW(StgMutArrPtrs) + x->ptrs; }
423 INLINE_HEADER StgWord tso_sizeW ( StgTSO *tso )
424 { return TSO_STRUCT_SIZEW + tso->stack_size; }
426 INLINE_HEADER StgWord bco_sizeW ( StgBCO *bco )
427 { return bco->size; }
430 closure_sizeW_ (StgClosure *p, StgInfoTable *info)
432 switch (info->type) {
435 return sizeofW(StgThunk) + 1;
440 return sizeofW(StgHeader) + 1;
444 return sizeofW(StgThunk) + 2;
451 return sizeofW(StgHeader) + 2;
453 return thunk_sizeW_fromITBL(info);
455 return THUNK_SELECTOR_sizeW();
457 return ap_stack_sizeW((StgAP_STACK *)p);
459 return ap_sizeW((StgAP *)p);
461 return pap_sizeW((StgPAP *)p);
465 case IND_OLDGEN_PERM:
466 return sizeofW(StgInd);
468 return arr_words_sizeW((StgArrWords *)p);
469 case MUT_ARR_PTRS_CLEAN:
470 case MUT_ARR_PTRS_DIRTY:
471 case MUT_ARR_PTRS_FROZEN:
472 case MUT_ARR_PTRS_FROZEN0:
473 return mut_arr_ptrs_sizeW((StgMutArrPtrs*)p);
475 return tso_sizeW((StgTSO *)p);
477 return bco_sizeW((StgBCO *)p);
478 case TVAR_WATCH_QUEUE:
479 return sizeofW(StgTVarWatchQueue);
481 return sizeofW(StgTVar);
483 return sizeofW(StgTRecChunk);
485 return sizeofW(StgTRecHeader);
486 case ATOMIC_INVARIANT:
487 return sizeofW(StgAtomicInvariant);
488 case INVARIANT_CHECK_QUEUE:
489 return sizeofW(StgInvariantCheckQueue);
491 return sizeW_fromITBL(info);
495 // The definitive way to find the size, in words, of a heap-allocated closure
497 closure_sizeW (StgClosure *p)
499 return closure_sizeW_(p, get_itbl(p));
502 /* -----------------------------------------------------------------------------
503 Sizes of stack frames
504 -------------------------------------------------------------------------- */
506 INLINE_HEADER StgWord stack_frame_sizeW( StgClosure *frame )
508 StgRetInfoTable *info;
510 info = get_ret_itbl(frame);
511 switch (info->i.type) {
515 StgRetDyn *dyn = (StgRetDyn *)frame;
516 return sizeofW(StgRetDyn) + RET_DYN_BITMAP_SIZE +
517 RET_DYN_NONPTR_REGS_SIZE +
518 RET_DYN_PTRS(dyn->liveness) + RET_DYN_NONPTRS(dyn->liveness);
522 return sizeofW(StgRetFun) + ((StgRetFun *)frame)->size;
525 return 1 + GET_LARGE_BITMAP(&info->i)->size;
528 return 2 + BCO_BITMAP_SIZE((StgBCO *)((P_)frame)[1]);
531 return 1 + BITMAP_SIZE(info->i.layout.bitmap);
535 /* -----------------------------------------------------------------------------
537 -------------------------------------------------------------------------- */
539 extern void allocNurseries ( void );
540 extern void resetNurseries ( void );
541 extern void resizeNurseries ( nat blocks );
542 extern void resizeNurseriesFixed ( nat blocks );
543 extern lnat countNurseryBlocks ( void );
546 /* -----------------------------------------------------------------------------
548 -------------------------------------------------------------------------- */
550 typedef void (*evac_fn)(void *user, StgClosure **root);
552 extern void threadPaused ( Capability *cap, StgTSO * );
553 extern StgClosure * isAlive ( StgClosure *p );
554 extern void markCAFs ( evac_fn evac, void *user );
555 extern void GetRoots ( evac_fn evac, void *user );
557 /* -----------------------------------------------------------------------------
558 Stats 'n' DEBUG stuff
559 -------------------------------------------------------------------------- */
561 extern ullong RTS_VAR(total_allocated);
563 extern lnat calcAllocated ( void );
564 extern lnat calcLiveBlocks ( void );
565 extern lnat calcLiveWords ( void );
566 extern lnat countOccupied ( bdescr *bd );
567 extern lnat calcNeeded ( void );
570 extern void memInventory(rtsBool show);
571 extern void checkSanity(void);
572 extern nat countBlocks(bdescr *);
573 extern void checkNurserySanity( step *stp );
577 void printMutOnceList(generation *gen);
578 void printMutableList(generation *gen);
581 /* ----------------------------------------------------------------------------
582 Storage manager internal APIs and globals
583 ------------------------------------------------------------------------- */
585 #define END_OF_STATIC_LIST stgCast(StgClosure*,1)
587 extern void newDynCAF(StgClosure *);
589 extern void move_TSO(StgTSO *src, StgTSO *dest);
590 extern StgTSO *relocate_stack(StgTSO *dest, ptrdiff_t diff);
592 extern StgWeak * RTS_VAR(old_weak_ptr_list);
593 extern StgWeak * RTS_VAR(weak_ptr_list);
594 extern StgClosure * RTS_VAR(caf_list);
595 extern StgClosure * RTS_VAR(revertible_caf_list);
596 extern StgTSO * RTS_VAR(resurrected_threads);
598 #define IS_FORWARDING_PTR(p) ((((StgWord)p) & 1) != 0)
599 #define MK_FORWARDING_PTR(p) (((StgWord)p) | 1)
600 #define UN_FORWARDING_PTR(p) (((StgWord)p) - 1)
602 #endif /* STORAGE_H */