1 /* -----------------------------------------------------------------------------
3 * (c) The GHC Team 1998-2003
5 * Generational garbage collector
7 * ---------------------------------------------------------------------------*/
9 #include "PosixSource.h"
14 #include "OSThreads.h"
16 #include "LdvProfile.h"
21 #include "BlockAlloc.h"
27 #include "ParTicky.h" // ToDo: move into Rts.h
28 #include "GCCompact.h"
31 #if defined(GRAN) || defined(PAR)
32 # include "GranSimRts.h"
33 # include "ParallelRts.h"
37 # include "ParallelDebug.h"
42 #if defined(RTS_GTK_FRONTPANEL)
43 #include "FrontPanel.h"
46 #include "RetainerProfile.h"
50 // Turn off inlining when debugging - it obfuscates things
53 # define STATIC_INLINE static
56 /* STATIC OBJECT LIST.
59 * We maintain a linked list of static objects that are still live.
60 * The requirements for this list are:
62 * - we need to scan the list while adding to it, in order to
63 * scavenge all the static objects (in the same way that
64 * breadth-first scavenging works for dynamic objects).
66 * - we need to be able to tell whether an object is already on
67 * the list, to break loops.
69 * Each static object has a "static link field", which we use for
70 * linking objects on to the list. We use a stack-type list, consing
71 * objects on the front as they are added (this means that the
72 * scavenge phase is depth-first, not breadth-first, but that
75 * A separate list is kept for objects that have been scavenged
76 * already - this is so that we can zero all the marks afterwards.
78 * An object is on the list if its static link field is non-zero; this
79 * means that we have to mark the end of the list with '1', not NULL.
81 * Extra notes for generational GC:
83 * Each generation has a static object list associated with it. When
84 * collecting generations up to N, we treat the static object lists
85 * from generations > N as roots.
87 * We build up a static object list while collecting generations 0..N,
88 * which is then appended to the static object list of generation N+1.
90 static StgClosure* static_objects; // live static objects
91 StgClosure* scavenged_static_objects; // static objects scavenged so far
93 /* N is the oldest generation being collected, where the generations
94 * are numbered starting at 0. A major GC (indicated by the major_gc
95 * flag) is when we're collecting all generations. We only attempt to
96 * deal with static objects and GC CAFs when doing a major GC.
99 static rtsBool major_gc;
101 /* Youngest generation that objects should be evacuated to in
102 * evacuate(). (Logically an argument to evacuate, but it's static
103 * a lot of the time so we optimise it into a global variable).
109 StgWeak *old_weak_ptr_list; // also pending finaliser list
111 /* Which stage of processing various kinds of weak pointer are we at?
112 * (see traverse_weak_ptr_list() below for discussion).
114 typedef enum { WeakPtrs, WeakThreads, WeakDone } WeakStage;
115 static WeakStage weak_stage;
117 /* List of all threads during GC
119 static StgTSO *old_all_threads;
120 StgTSO *resurrected_threads;
122 /* Flag indicating failure to evacuate an object to the desired
125 static rtsBool failed_to_evac;
127 /* Old to-space (used for two-space collector only)
129 static bdescr *old_to_blocks;
131 /* Data used for allocation area sizing.
133 static lnat new_blocks; // blocks allocated during this GC
134 static lnat g0s0_pcnt_kept = 30; // percentage of g0s0 live at last minor GC
136 /* Used to avoid long recursion due to selector thunks
138 static lnat thunk_selector_depth = 0;
139 #define MAX_THUNK_SELECTOR_DEPTH 8
141 /* -----------------------------------------------------------------------------
142 Static function declarations
143 -------------------------------------------------------------------------- */
145 static bdescr * gc_alloc_block ( step *stp );
146 static void mark_root ( StgClosure **root );
148 // Use a register argument for evacuate, if available.
150 #define REGPARM1 __attribute__((regparm(1)))
155 REGPARM1 static StgClosure * evacuate (StgClosure *q);
157 static void zero_static_object_list ( StgClosure* first_static );
159 static rtsBool traverse_weak_ptr_list ( void );
160 static void mark_weak_ptr_list ( StgWeak **list );
162 static StgClosure * eval_thunk_selector ( nat field, StgSelector * p );
165 static void scavenge ( step * );
166 static void scavenge_mark_stack ( void );
167 static void scavenge_stack ( StgPtr p, StgPtr stack_end );
168 static rtsBool scavenge_one ( StgPtr p );
169 static void scavenge_large ( step * );
170 static void scavenge_static ( void );
171 static void scavenge_mutable_list ( generation *g );
173 static void scavenge_large_bitmap ( StgPtr p,
174 StgLargeBitmap *large_bitmap,
177 #if 0 && defined(DEBUG)
178 static void gcCAFs ( void );
181 /* -----------------------------------------------------------------------------
182 inline functions etc. for dealing with the mark bitmap & stack.
183 -------------------------------------------------------------------------- */
185 #define MARK_STACK_BLOCKS 4
187 static bdescr *mark_stack_bdescr;
188 static StgPtr *mark_stack;
189 static StgPtr *mark_sp;
190 static StgPtr *mark_splim;
192 // Flag and pointers used for falling back to a linear scan when the
193 // mark stack overflows.
194 static rtsBool mark_stack_overflowed;
195 static bdescr *oldgen_scan_bd;
196 static StgPtr oldgen_scan;
198 STATIC_INLINE rtsBool
199 mark_stack_empty(void)
201 return mark_sp == mark_stack;
204 STATIC_INLINE rtsBool
205 mark_stack_full(void)
207 return mark_sp >= mark_splim;
211 reset_mark_stack(void)
213 mark_sp = mark_stack;
217 push_mark_stack(StgPtr p)
228 /* -----------------------------------------------------------------------------
229 Allocate a new to-space block in the given step.
230 -------------------------------------------------------------------------- */
233 gc_alloc_block(step *stp)
235 bdescr *bd = allocBlock();
236 bd->gen_no = stp->gen_no;
240 // blocks in to-space in generations up to and including N
241 // get the BF_EVACUATED flag.
242 if (stp->gen_no <= N) {
243 bd->flags = BF_EVACUATED;
248 // Start a new to-space block, chain it on after the previous one.
249 if (stp->hp_bd == NULL) {
252 stp->hp_bd->free = stp->hp;
253 stp->hp_bd->link = bd;
258 stp->hpLim = stp->hp + BLOCK_SIZE_W;
266 /* -----------------------------------------------------------------------------
269 Rough outline of the algorithm: for garbage collecting generation N
270 (and all younger generations):
272 - follow all pointers in the root set. the root set includes all
273 mutable objects in all generations (mutable_list).
275 - for each pointer, evacuate the object it points to into either
277 + to-space of the step given by step->to, which is the next
278 highest step in this generation or the first step in the next
279 generation if this is the last step.
281 + to-space of generations[evac_gen]->steps[0], if evac_gen != 0.
282 When we evacuate an object we attempt to evacuate
283 everything it points to into the same generation - this is
284 achieved by setting evac_gen to the desired generation. If
285 we can't do this, then an entry in the mut list has to
286 be made for the cross-generation pointer.
288 + if the object is already in a generation > N, then leave
291 - repeatedly scavenge to-space from each step in each generation
292 being collected until no more objects can be evacuated.
294 - free from-space in each step, and set from-space = to-space.
296 Locks held: sched_mutex
298 -------------------------------------------------------------------------- */
301 GarbageCollect ( void (*get_roots)(evac_fn), rtsBool force_major_gc )
305 lnat live, allocated, collected = 0, copied = 0;
306 lnat oldgen_saved_blocks = 0;
310 CostCentreStack *prev_CCS;
313 #if defined(DEBUG) && defined(GRAN)
314 IF_DEBUG(gc, debugBelch("@@ Starting garbage collection at %ld (%lx)\n",
318 #if defined(RTS_USER_SIGNALS)
323 // tell the STM to discard any cached closures its hoping to re-use
326 // tell the stats department that we've started a GC
329 // Init stats and print par specific (timing) info
330 PAR_TICKY_PAR_START();
332 // attribute any costs to CCS_GC
338 /* Approximate how much we allocated.
339 * Todo: only when generating stats?
341 allocated = calcAllocated();
343 /* Figure out which generation to collect
345 if (force_major_gc) {
346 N = RtsFlags.GcFlags.generations - 1;
350 for (g = 0; g < RtsFlags.GcFlags.generations; g++) {
351 if (generations[g].steps[0].n_blocks +
352 generations[g].steps[0].n_large_blocks
353 >= generations[g].max_blocks) {
357 major_gc = (N == RtsFlags.GcFlags.generations-1);
360 #ifdef RTS_GTK_FRONTPANEL
361 if (RtsFlags.GcFlags.frontpanel) {
362 updateFrontPanelBeforeGC(N);
366 // check stack sanity *before* GC (ToDo: check all threads)
368 // ToDo!: check sanity IF_DEBUG(sanity, checkTSOsSanity());
370 IF_DEBUG(sanity, checkFreeListSanity());
372 /* Initialise the static object lists
374 static_objects = END_OF_STATIC_LIST;
375 scavenged_static_objects = END_OF_STATIC_LIST;
377 /* Save the old to-space if we're doing a two-space collection
379 if (RtsFlags.GcFlags.generations == 1) {
380 old_to_blocks = g0s0->to_blocks;
381 g0s0->to_blocks = NULL;
382 g0s0->n_to_blocks = 0;
385 /* Keep a count of how many new blocks we allocated during this GC
386 * (used for resizing the allocation area, later).
390 // Initialise to-space in all the generations/steps that we're
393 for (g = 0; g <= N; g++) {
395 // throw away the mutable list. Invariant: the mutable list
396 // always has at least one block; this means we can avoid a check for
397 // NULL in recordMutable().
399 freeChain(generations[g].mut_list);
400 generations[g].mut_list = allocBlock();
403 for (s = 0; s < generations[g].n_steps; s++) {
405 // generation 0, step 0 doesn't need to-space
406 if (g == 0 && s == 0 && RtsFlags.GcFlags.generations > 1) {
410 stp = &generations[g].steps[s];
411 ASSERT(stp->gen_no == g);
413 // start a new to-space for this step.
416 stp->to_blocks = NULL;
418 // allocate the first to-space block; extra blocks will be
419 // chained on as necessary.
420 bd = gc_alloc_block(stp);
422 stp->scan = bd->start;
425 // initialise the large object queues.
426 stp->new_large_objects = NULL;
427 stp->scavenged_large_objects = NULL;
428 stp->n_scavenged_large_blocks = 0;
430 // mark the large objects as not evacuated yet
431 for (bd = stp->large_objects; bd; bd = bd->link) {
432 bd->flags &= ~BF_EVACUATED;
435 // for a compacted step, we need to allocate the bitmap
436 if (stp->is_compacted) {
437 nat bitmap_size; // in bytes
438 bdescr *bitmap_bdescr;
441 bitmap_size = stp->n_blocks * BLOCK_SIZE / (sizeof(W_)*BITS_PER_BYTE);
443 if (bitmap_size > 0) {
444 bitmap_bdescr = allocGroup((lnat)BLOCK_ROUND_UP(bitmap_size)
446 stp->bitmap = bitmap_bdescr;
447 bitmap = bitmap_bdescr->start;
449 IF_DEBUG(gc, debugBelch("bitmap_size: %d, bitmap: %p",
450 bitmap_size, bitmap););
452 // don't forget to fill it with zeros!
453 memset(bitmap, 0, bitmap_size);
455 // For each block in this step, point to its bitmap from the
457 for (bd=stp->blocks; bd != NULL; bd = bd->link) {
458 bd->u.bitmap = bitmap;
459 bitmap += BLOCK_SIZE_W / (sizeof(W_)*BITS_PER_BYTE);
461 // Also at this point we set the BF_COMPACTED flag
462 // for this block. The invariant is that
463 // BF_COMPACTED is always unset, except during GC
464 // when it is set on those blocks which will be
466 bd->flags |= BF_COMPACTED;
473 /* make sure the older generations have at least one block to
474 * allocate into (this makes things easier for copy(), see below).
476 for (g = N+1; g < RtsFlags.GcFlags.generations; g++) {
477 for (s = 0; s < generations[g].n_steps; s++) {
478 stp = &generations[g].steps[s];
479 if (stp->hp_bd == NULL) {
480 ASSERT(stp->blocks == NULL);
481 bd = gc_alloc_block(stp);
485 /* Set the scan pointer for older generations: remember we
486 * still have to scavenge objects that have been promoted. */
488 stp->scan_bd = stp->hp_bd;
489 stp->to_blocks = NULL;
490 stp->n_to_blocks = 0;
491 stp->new_large_objects = NULL;
492 stp->scavenged_large_objects = NULL;
493 stp->n_scavenged_large_blocks = 0;
497 /* Allocate a mark stack if we're doing a major collection.
500 mark_stack_bdescr = allocGroup(MARK_STACK_BLOCKS);
501 mark_stack = (StgPtr *)mark_stack_bdescr->start;
502 mark_sp = mark_stack;
503 mark_splim = mark_stack + (MARK_STACK_BLOCKS * BLOCK_SIZE_W);
505 mark_stack_bdescr = NULL;
508 /* -----------------------------------------------------------------------
509 * follow all the roots that we know about:
510 * - mutable lists from each generation > N
511 * we want to *scavenge* these roots, not evacuate them: they're not
512 * going to move in this GC.
513 * Also: do them in reverse generation order. This is because we
514 * often want to promote objects that are pointed to by older
515 * generations early, so we don't have to repeatedly copy them.
516 * Doing the generations in reverse order ensures that we don't end
517 * up in the situation where we want to evac an object to gen 3 and
518 * it has already been evaced to gen 2.
522 for (g = RtsFlags.GcFlags.generations-1; g > N; g--) {
523 generations[g].saved_mut_list = generations[g].mut_list;
524 generations[g].mut_list = allocBlock();
525 // mut_list always has at least one block.
528 for (g = RtsFlags.GcFlags.generations-1; g > N; g--) {
529 IF_PAR_DEBUG(verbose, printMutableList(&generations[g]));
530 scavenge_mutable_list(&generations[g]);
532 for (st = generations[g].n_steps-1; st >= 0; st--) {
533 scavenge(&generations[g].steps[st]);
538 /* follow roots from the CAF list (used by GHCi)
543 /* follow all the roots that the application knows about.
546 get_roots(mark_root);
549 /* And don't forget to mark the TSO if we got here direct from
551 /* Not needed in a seq version?
553 CurrentTSO = (StgTSO *)MarkRoot((StgClosure *)CurrentTSO);
557 // Mark the entries in the GALA table of the parallel system
558 markLocalGAs(major_gc);
559 // Mark all entries on the list of pending fetches
560 markPendingFetches(major_gc);
563 /* Mark the weak pointer list, and prepare to detect dead weak
566 mark_weak_ptr_list(&weak_ptr_list);
567 old_weak_ptr_list = weak_ptr_list;
568 weak_ptr_list = NULL;
569 weak_stage = WeakPtrs;
571 /* The all_threads list is like the weak_ptr_list.
572 * See traverse_weak_ptr_list() for the details.
574 old_all_threads = all_threads;
575 all_threads = END_TSO_QUEUE;
576 resurrected_threads = END_TSO_QUEUE;
578 /* Mark the stable pointer table.
580 markStablePtrTable(mark_root);
582 /* -------------------------------------------------------------------------
583 * Repeatedly scavenge all the areas we know about until there's no
584 * more scavenging to be done.
591 // scavenge static objects
592 if (major_gc && static_objects != END_OF_STATIC_LIST) {
593 IF_DEBUG(sanity, checkStaticObjects(static_objects));
597 /* When scavenging the older generations: Objects may have been
598 * evacuated from generations <= N into older generations, and we
599 * need to scavenge these objects. We're going to try to ensure that
600 * any evacuations that occur move the objects into at least the
601 * same generation as the object being scavenged, otherwise we
602 * have to create new entries on the mutable list for the older
606 // scavenge each step in generations 0..maxgen
612 // scavenge objects in compacted generation
613 if (mark_stack_overflowed || oldgen_scan_bd != NULL ||
614 (mark_stack_bdescr != NULL && !mark_stack_empty())) {
615 scavenge_mark_stack();
619 for (gen = RtsFlags.GcFlags.generations; --gen >= 0; ) {
620 for (st = generations[gen].n_steps; --st >= 0; ) {
621 if (gen == 0 && st == 0 && RtsFlags.GcFlags.generations > 1) {
624 stp = &generations[gen].steps[st];
626 if (stp->hp_bd != stp->scan_bd || stp->scan < stp->hp) {
631 if (stp->new_large_objects != NULL) {
640 if (flag) { goto loop; }
642 // must be last... invariant is that everything is fully
643 // scavenged at this point.
644 if (traverse_weak_ptr_list()) { // returns rtsTrue if evaced something
649 /* Update the pointers from the "main thread" list - these are
650 * treated as weak pointers because we want to allow a main thread
651 * to get a BlockedOnDeadMVar exception in the same way as any other
652 * thread. Note that the threads should all have been retained by
653 * GC by virtue of being on the all_threads list, we're just
654 * updating pointers here.
659 for (m = main_threads; m != NULL; m = m->link) {
660 tso = (StgTSO *) isAlive((StgClosure *)m->tso);
662 barf("main thread has been GC'd");
669 // Reconstruct the Global Address tables used in GUM
670 rebuildGAtables(major_gc);
671 IF_DEBUG(sanity, checkLAGAtable(rtsTrue/*check closures, too*/));
674 // Now see which stable names are still alive.
677 // Tidy the end of the to-space chains
678 for (g = 0; g < RtsFlags.GcFlags.generations; g++) {
679 for (s = 0; s < generations[g].n_steps; s++) {
680 stp = &generations[g].steps[s];
681 if (!(g == 0 && s == 0 && RtsFlags.GcFlags.generations > 1)) {
682 ASSERT(Bdescr(stp->hp) == stp->hp_bd);
683 stp->hp_bd->free = stp->hp;
689 // We call processHeapClosureForDead() on every closure destroyed during
690 // the current garbage collection, so we invoke LdvCensusForDead().
691 if (RtsFlags.ProfFlags.doHeapProfile == HEAP_BY_LDV
692 || RtsFlags.ProfFlags.bioSelector != NULL)
696 // NO MORE EVACUATION AFTER THIS POINT!
697 // Finally: compaction of the oldest generation.
698 if (major_gc && oldest_gen->steps[0].is_compacted) {
699 // save number of blocks for stats
700 oldgen_saved_blocks = oldest_gen->steps[0].n_blocks;
704 IF_DEBUG(sanity, checkGlobalTSOList(rtsFalse));
706 /* run through all the generations/steps and tidy up
708 copied = new_blocks * BLOCK_SIZE_W;
709 for (g = 0; g < RtsFlags.GcFlags.generations; g++) {
712 generations[g].collections++; // for stats
715 // Count the mutable list as bytes "copied" for the purposes of
716 // stats. Every mutable list is copied during every GC.
718 for (bd = generations[g].mut_list; bd != NULL; bd = bd->link) {
719 copied += (bd->free - bd->start) * sizeof(StgWord);
723 for (s = 0; s < generations[g].n_steps; s++) {
725 stp = &generations[g].steps[s];
727 if (!(g == 0 && s == 0 && RtsFlags.GcFlags.generations > 1)) {
728 // stats information: how much we copied
730 copied -= stp->hp_bd->start + BLOCK_SIZE_W -
735 // for generations we collected...
738 // rough calculation of garbage collected, for stats output
739 if (stp->is_compacted) {
740 collected += (oldgen_saved_blocks - stp->n_blocks) * BLOCK_SIZE_W;
742 collected += stp->n_blocks * BLOCK_SIZE_W;
745 /* free old memory and shift to-space into from-space for all
746 * the collected steps (except the allocation area). These
747 * freed blocks will probaby be quickly recycled.
749 if (!(g == 0 && s == 0)) {
750 if (stp->is_compacted) {
751 // for a compacted step, just shift the new to-space
752 // onto the front of the now-compacted existing blocks.
753 for (bd = stp->to_blocks; bd != NULL; bd = bd->link) {
754 bd->flags &= ~BF_EVACUATED; // now from-space
756 // tack the new blocks on the end of the existing blocks
757 if (stp->blocks == NULL) {
758 stp->blocks = stp->to_blocks;
760 for (bd = stp->blocks; bd != NULL; bd = next) {
763 bd->link = stp->to_blocks;
765 // NB. this step might not be compacted next
766 // time, so reset the BF_COMPACTED flags.
767 // They are set before GC if we're going to
768 // compact. (search for BF_COMPACTED above).
769 bd->flags &= ~BF_COMPACTED;
772 // add the new blocks to the block tally
773 stp->n_blocks += stp->n_to_blocks;
775 freeChain(stp->blocks);
776 stp->blocks = stp->to_blocks;
777 stp->n_blocks = stp->n_to_blocks;
778 for (bd = stp->blocks; bd != NULL; bd = bd->link) {
779 bd->flags &= ~BF_EVACUATED; // now from-space
782 stp->to_blocks = NULL;
783 stp->n_to_blocks = 0;
786 /* LARGE OBJECTS. The current live large objects are chained on
787 * scavenged_large, having been moved during garbage
788 * collection from large_objects. Any objects left on
789 * large_objects list are therefore dead, so we free them here.
791 for (bd = stp->large_objects; bd != NULL; bd = next) {
797 // update the count of blocks used by large objects
798 for (bd = stp->scavenged_large_objects; bd != NULL; bd = bd->link) {
799 bd->flags &= ~BF_EVACUATED;
801 stp->large_objects = stp->scavenged_large_objects;
802 stp->n_large_blocks = stp->n_scavenged_large_blocks;
805 // for older generations...
807 /* For older generations, we need to append the
808 * scavenged_large_object list (i.e. large objects that have been
809 * promoted during this GC) to the large_object list for that step.
811 for (bd = stp->scavenged_large_objects; bd; bd = next) {
813 bd->flags &= ~BF_EVACUATED;
814 dbl_link_onto(bd, &stp->large_objects);
817 // add the new blocks we promoted during this GC
818 stp->n_blocks += stp->n_to_blocks;
819 stp->n_to_blocks = 0;
820 stp->n_large_blocks += stp->n_scavenged_large_blocks;
825 /* Reset the sizes of the older generations when we do a major
828 * CURRENT STRATEGY: make all generations except zero the same size.
829 * We have to stay within the maximum heap size, and leave a certain
830 * percentage of the maximum heap size available to allocate into.
832 if (major_gc && RtsFlags.GcFlags.generations > 1) {
833 nat live, size, min_alloc;
834 nat max = RtsFlags.GcFlags.maxHeapSize;
835 nat gens = RtsFlags.GcFlags.generations;
837 // live in the oldest generations
838 live = oldest_gen->steps[0].n_blocks +
839 oldest_gen->steps[0].n_large_blocks;
841 // default max size for all generations except zero
842 size = stg_max(live * RtsFlags.GcFlags.oldGenFactor,
843 RtsFlags.GcFlags.minOldGenSize);
845 // minimum size for generation zero
846 min_alloc = stg_max((RtsFlags.GcFlags.pcFreeHeap * max) / 200,
847 RtsFlags.GcFlags.minAllocAreaSize);
849 // Auto-enable compaction when the residency reaches a
850 // certain percentage of the maximum heap size (default: 30%).
851 if (RtsFlags.GcFlags.generations > 1 &&
852 (RtsFlags.GcFlags.compact ||
854 oldest_gen->steps[0].n_blocks >
855 (RtsFlags.GcFlags.compactThreshold * max) / 100))) {
856 oldest_gen->steps[0].is_compacted = 1;
857 // debugBelch("compaction: on\n", live);
859 oldest_gen->steps[0].is_compacted = 0;
860 // debugBelch("compaction: off\n", live);
863 // if we're going to go over the maximum heap size, reduce the
864 // size of the generations accordingly. The calculation is
865 // different if compaction is turned on, because we don't need
866 // to double the space required to collect the old generation.
869 // this test is necessary to ensure that the calculations
870 // below don't have any negative results - we're working
871 // with unsigned values here.
872 if (max < min_alloc) {
876 if (oldest_gen->steps[0].is_compacted) {
877 if ( (size + (size - 1) * (gens - 2) * 2) + min_alloc > max ) {
878 size = (max - min_alloc) / ((gens - 1) * 2 - 1);
881 if ( (size * (gens - 1) * 2) + min_alloc > max ) {
882 size = (max - min_alloc) / ((gens - 1) * 2);
892 debugBelch("live: %d, min_alloc: %d, size : %d, max = %d\n", live,
893 min_alloc, size, max);
896 for (g = 0; g < gens; g++) {
897 generations[g].max_blocks = size;
901 // Guess the amount of live data for stats.
904 /* Free the small objects allocated via allocate(), since this will
905 * all have been copied into G0S1 now.
907 if (small_alloc_list != NULL) {
908 freeChain(small_alloc_list);
910 small_alloc_list = NULL;
914 alloc_blocks_lim = RtsFlags.GcFlags.minAllocAreaSize;
916 // Start a new pinned_object_block
917 pinned_object_block = NULL;
919 /* Free the mark stack.
921 if (mark_stack_bdescr != NULL) {
922 freeGroup(mark_stack_bdescr);
927 for (g = 0; g <= N; g++) {
928 for (s = 0; s < generations[g].n_steps; s++) {
929 stp = &generations[g].steps[s];
930 if (stp->is_compacted && stp->bitmap != NULL) {
931 freeGroup(stp->bitmap);
936 /* Two-space collector:
937 * Free the old to-space, and estimate the amount of live data.
939 if (RtsFlags.GcFlags.generations == 1) {
942 if (old_to_blocks != NULL) {
943 freeChain(old_to_blocks);
945 for (bd = g0s0->to_blocks; bd != NULL; bd = bd->link) {
946 bd->flags = 0; // now from-space
949 /* For a two-space collector, we need to resize the nursery. */
951 /* set up a new nursery. Allocate a nursery size based on a
952 * function of the amount of live data (by default a factor of 2)
953 * Use the blocks from the old nursery if possible, freeing up any
956 * If we get near the maximum heap size, then adjust our nursery
957 * size accordingly. If the nursery is the same size as the live
958 * data (L), then we need 3L bytes. We can reduce the size of the
959 * nursery to bring the required memory down near 2L bytes.
961 * A normal 2-space collector would need 4L bytes to give the same
962 * performance we get from 3L bytes, reducing to the same
963 * performance at 2L bytes.
965 blocks = g0s0->n_to_blocks;
967 if ( RtsFlags.GcFlags.maxHeapSize != 0 &&
968 blocks * RtsFlags.GcFlags.oldGenFactor * 2 >
969 RtsFlags.GcFlags.maxHeapSize ) {
970 long adjusted_blocks; // signed on purpose
973 adjusted_blocks = (RtsFlags.GcFlags.maxHeapSize - 2 * blocks);
974 IF_DEBUG(gc, debugBelch("@@ Near maximum heap size of 0x%x blocks, blocks = %d, adjusted to %ld", RtsFlags.GcFlags.maxHeapSize, blocks, adjusted_blocks));
975 pc_free = adjusted_blocks * 100 / RtsFlags.GcFlags.maxHeapSize;
976 if (pc_free < RtsFlags.GcFlags.pcFreeHeap) /* might even be < 0 */ {
979 blocks = adjusted_blocks;
982 blocks *= RtsFlags.GcFlags.oldGenFactor;
983 if (blocks < RtsFlags.GcFlags.minAllocAreaSize) {
984 blocks = RtsFlags.GcFlags.minAllocAreaSize;
987 resizeNurseries(blocks);
990 /* Generational collector:
991 * If the user has given us a suggested heap size, adjust our
992 * allocation area to make best use of the memory available.
995 if (RtsFlags.GcFlags.heapSizeSuggestion) {
997 nat needed = calcNeeded(); // approx blocks needed at next GC
999 /* Guess how much will be live in generation 0 step 0 next time.
1000 * A good approximation is obtained by finding the
1001 * percentage of g0s0 that was live at the last minor GC.
1004 g0s0_pcnt_kept = (new_blocks * 100) / countNurseryBlocks();
1007 /* Estimate a size for the allocation area based on the
1008 * information available. We might end up going slightly under
1009 * or over the suggested heap size, but we should be pretty
1012 * Formula: suggested - needed
1013 * ----------------------------
1014 * 1 + g0s0_pcnt_kept/100
1016 * where 'needed' is the amount of memory needed at the next
1017 * collection for collecting all steps except g0s0.
1020 (((long)RtsFlags.GcFlags.heapSizeSuggestion - (long)needed) * 100) /
1021 (100 + (long)g0s0_pcnt_kept);
1023 if (blocks < (long)RtsFlags.GcFlags.minAllocAreaSize) {
1024 blocks = RtsFlags.GcFlags.minAllocAreaSize;
1027 resizeNurseries((nat)blocks);
1030 // we might have added extra large blocks to the nursery, so
1031 // resize back to minAllocAreaSize again.
1032 resizeNurseries(RtsFlags.GcFlags.minAllocAreaSize);
1036 // mark the garbage collected CAFs as dead
1037 #if 0 && defined(DEBUG) // doesn't work at the moment
1038 if (major_gc) { gcCAFs(); }
1042 // resetStaticObjectForRetainerProfiling() must be called before
1044 resetStaticObjectForRetainerProfiling();
1047 // zero the scavenged static object list
1049 zero_static_object_list(scavenged_static_objects);
1052 // Reset the nursery
1055 RELEASE_LOCK(&sched_mutex);
1057 // start any pending finalizers
1058 scheduleFinalizers(old_weak_ptr_list);
1060 // send exceptions to any threads which were about to die
1061 resurrectThreads(resurrected_threads);
1063 ACQUIRE_LOCK(&sched_mutex);
1065 // Update the stable pointer hash table.
1066 updateStablePtrTable(major_gc);
1068 // check sanity after GC
1069 IF_DEBUG(sanity, checkSanity());
1071 // extra GC trace info
1072 IF_DEBUG(gc, statDescribeGens());
1075 // symbol-table based profiling
1076 /* heapCensus(to_blocks); */ /* ToDo */
1079 // restore enclosing cost centre
1084 // check for memory leaks if sanity checking is on
1085 IF_DEBUG(sanity, memInventory());
1087 #ifdef RTS_GTK_FRONTPANEL
1088 if (RtsFlags.GcFlags.frontpanel) {
1089 updateFrontPanelAfterGC( N, live );
1093 // ok, GC over: tell the stats department what happened.
1094 stat_endGC(allocated, collected, live, copied, N);
1096 #if defined(RTS_USER_SIGNALS)
1097 // unblock signals again
1098 unblockUserSignals();
1105 /* -----------------------------------------------------------------------------
1108 traverse_weak_ptr_list is called possibly many times during garbage
1109 collection. It returns a flag indicating whether it did any work
1110 (i.e. called evacuate on any live pointers).
1112 Invariant: traverse_weak_ptr_list is called when the heap is in an
1113 idempotent state. That means that there are no pending
1114 evacuate/scavenge operations. This invariant helps the weak
1115 pointer code decide which weak pointers are dead - if there are no
1116 new live weak pointers, then all the currently unreachable ones are
1119 For generational GC: we just don't try to finalize weak pointers in
1120 older generations than the one we're collecting. This could
1121 probably be optimised by keeping per-generation lists of weak
1122 pointers, but for a few weak pointers this scheme will work.
1124 There are three distinct stages to processing weak pointers:
1126 - weak_stage == WeakPtrs
1128 We process all the weak pointers whos keys are alive (evacuate
1129 their values and finalizers), and repeat until we can find no new
1130 live keys. If no live keys are found in this pass, then we
1131 evacuate the finalizers of all the dead weak pointers in order to
1134 - weak_stage == WeakThreads
1136 Now, we discover which *threads* are still alive. Pointers to
1137 threads from the all_threads and main thread lists are the
1138 weakest of all: a pointers from the finalizer of a dead weak
1139 pointer can keep a thread alive. Any threads found to be unreachable
1140 are evacuated and placed on the resurrected_threads list so we
1141 can send them a signal later.
1143 - weak_stage == WeakDone
1145 No more evacuation is done.
1147 -------------------------------------------------------------------------- */
1150 traverse_weak_ptr_list(void)
1152 StgWeak *w, **last_w, *next_w;
1154 rtsBool flag = rtsFalse;
1156 switch (weak_stage) {
1162 /* doesn't matter where we evacuate values/finalizers to, since
1163 * these pointers are treated as roots (iff the keys are alive).
1167 last_w = &old_weak_ptr_list;
1168 for (w = old_weak_ptr_list; w != NULL; w = next_w) {
1170 /* There might be a DEAD_WEAK on the list if finalizeWeak# was
1171 * called on a live weak pointer object. Just remove it.
1173 if (w->header.info == &stg_DEAD_WEAK_info) {
1174 next_w = ((StgDeadWeak *)w)->link;
1179 switch (get_itbl(w)->type) {
1182 next_w = (StgWeak *)((StgEvacuated *)w)->evacuee;
1187 /* Now, check whether the key is reachable.
1189 new = isAlive(w->key);
1192 // evacuate the value and finalizer
1193 w->value = evacuate(w->value);
1194 w->finalizer = evacuate(w->finalizer);
1195 // remove this weak ptr from the old_weak_ptr list
1197 // and put it on the new weak ptr list
1199 w->link = weak_ptr_list;
1202 IF_DEBUG(weak, debugBelch("Weak pointer still alive at %p -> %p",
1207 last_w = &(w->link);
1213 barf("traverse_weak_ptr_list: not WEAK");
1217 /* If we didn't make any changes, then we can go round and kill all
1218 * the dead weak pointers. The old_weak_ptr list is used as a list
1219 * of pending finalizers later on.
1221 if (flag == rtsFalse) {
1222 for (w = old_weak_ptr_list; w; w = w->link) {
1223 w->finalizer = evacuate(w->finalizer);
1226 // Next, move to the WeakThreads stage after fully
1227 // scavenging the finalizers we've just evacuated.
1228 weak_stage = WeakThreads;
1234 /* Now deal with the all_threads list, which behaves somewhat like
1235 * the weak ptr list. If we discover any threads that are about to
1236 * become garbage, we wake them up and administer an exception.
1239 StgTSO *t, *tmp, *next, **prev;
1241 prev = &old_all_threads;
1242 for (t = old_all_threads; t != END_TSO_QUEUE; t = next) {
1244 tmp = (StgTSO *)isAlive((StgClosure *)t);
1250 ASSERT(get_itbl(t)->type == TSO);
1251 switch (t->what_next) {
1252 case ThreadRelocated:
1257 case ThreadComplete:
1258 // finshed or died. The thread might still be alive, but we
1259 // don't keep it on the all_threads list. Don't forget to
1260 // stub out its global_link field.
1261 next = t->global_link;
1262 t->global_link = END_TSO_QUEUE;
1270 // not alive (yet): leave this thread on the
1271 // old_all_threads list.
1272 prev = &(t->global_link);
1273 next = t->global_link;
1276 // alive: move this thread onto the all_threads list.
1277 next = t->global_link;
1278 t->global_link = all_threads;
1285 /* And resurrect any threads which were about to become garbage.
1288 StgTSO *t, *tmp, *next;
1289 for (t = old_all_threads; t != END_TSO_QUEUE; t = next) {
1290 next = t->global_link;
1291 tmp = (StgTSO *)evacuate((StgClosure *)t);
1292 tmp->global_link = resurrected_threads;
1293 resurrected_threads = tmp;
1297 weak_stage = WeakDone; // *now* we're done,
1298 return rtsTrue; // but one more round of scavenging, please
1301 barf("traverse_weak_ptr_list");
1307 /* -----------------------------------------------------------------------------
1308 After GC, the live weak pointer list may have forwarding pointers
1309 on it, because a weak pointer object was evacuated after being
1310 moved to the live weak pointer list. We remove those forwarding
1313 Also, we don't consider weak pointer objects to be reachable, but
1314 we must nevertheless consider them to be "live" and retain them.
1315 Therefore any weak pointer objects which haven't as yet been
1316 evacuated need to be evacuated now.
1317 -------------------------------------------------------------------------- */
1321 mark_weak_ptr_list ( StgWeak **list )
1323 StgWeak *w, **last_w;
1326 for (w = *list; w; w = w->link) {
1327 // w might be WEAK, EVACUATED, or DEAD_WEAK (actually CON_STATIC) here
1328 ASSERT(w->header.info == &stg_DEAD_WEAK_info
1329 || get_itbl(w)->type == WEAK || get_itbl(w)->type == EVACUATED);
1330 w = (StgWeak *)evacuate((StgClosure *)w);
1332 last_w = &(w->link);
1336 /* -----------------------------------------------------------------------------
1337 isAlive determines whether the given closure is still alive (after
1338 a garbage collection) or not. It returns the new address of the
1339 closure if it is alive, or NULL otherwise.
1341 NOTE: Use it before compaction only!
1342 -------------------------------------------------------------------------- */
1346 isAlive(StgClosure *p)
1348 const StgInfoTable *info;
1353 ASSERT(LOOKS_LIKE_CLOSURE_PTR(p));
1356 // ignore static closures
1358 // ToDo: for static closures, check the static link field.
1359 // Problem here is that we sometimes don't set the link field, eg.
1360 // for static closures with an empty SRT or CONSTR_STATIC_NOCAFs.
1362 if (!HEAP_ALLOCED(p)) {
1366 // ignore closures in generations that we're not collecting.
1368 if (bd->gen_no > N) {
1372 // if it's a pointer into to-space, then we're done
1373 if (bd->flags & BF_EVACUATED) {
1377 // large objects use the evacuated flag
1378 if (bd->flags & BF_LARGE) {
1382 // check the mark bit for compacted steps
1383 if ((bd->flags & BF_COMPACTED) && is_marked((P_)p,bd)) {
1387 switch (info->type) {
1392 case IND_OLDGEN: // rely on compatible layout with StgInd
1393 case IND_OLDGEN_PERM:
1394 // follow indirections
1395 p = ((StgInd *)p)->indirectee;
1400 return ((StgEvacuated *)p)->evacuee;
1403 if (((StgTSO *)p)->what_next == ThreadRelocated) {
1404 p = (StgClosure *)((StgTSO *)p)->link;
1417 mark_root(StgClosure **root)
1419 *root = evacuate(*root);
1423 upd_evacuee(StgClosure *p, StgClosure *dest)
1425 // not true: (ToDo: perhaps it should be)
1426 // ASSERT(Bdescr((P_)dest)->flags & BF_EVACUATED);
1427 SET_INFO(p, &stg_EVACUATED_info);
1428 ((StgEvacuated *)p)->evacuee = dest;
1432 STATIC_INLINE StgClosure *
1433 copy(StgClosure *src, nat size, step *stp)
1438 nat size_org = size;
1441 TICK_GC_WORDS_COPIED(size);
1442 /* Find out where we're going, using the handy "to" pointer in
1443 * the step of the source object. If it turns out we need to
1444 * evacuate to an older generation, adjust it here (see comment
1447 if (stp->gen_no < evac_gen) {
1448 #ifdef NO_EAGER_PROMOTION
1449 failed_to_evac = rtsTrue;
1451 stp = &generations[evac_gen].steps[0];
1455 /* chain a new block onto the to-space for the destination step if
1458 if (stp->hp + size >= stp->hpLim) {
1459 gc_alloc_block(stp);
1462 for(to = stp->hp, from = (P_)src; size>0; --size) {
1468 upd_evacuee(src,(StgClosure *)dest);
1470 // We store the size of the just evacuated object in the LDV word so that
1471 // the profiler can guess the position of the next object later.
1472 SET_EVACUAEE_FOR_LDV(src, size_org);
1474 return (StgClosure *)dest;
1477 /* Special version of copy() for when we only want to copy the info
1478 * pointer of an object, but reserve some padding after it. This is
1479 * used to optimise evacuation of BLACKHOLEs.
1484 copyPart(StgClosure *src, nat size_to_reserve, nat size_to_copy, step *stp)
1489 nat size_to_copy_org = size_to_copy;
1492 TICK_GC_WORDS_COPIED(size_to_copy);
1493 if (stp->gen_no < evac_gen) {
1494 #ifdef NO_EAGER_PROMOTION
1495 failed_to_evac = rtsTrue;
1497 stp = &generations[evac_gen].steps[0];
1501 if (stp->hp + size_to_reserve >= stp->hpLim) {
1502 gc_alloc_block(stp);
1505 for(to = stp->hp, from = (P_)src; size_to_copy>0; --size_to_copy) {
1510 stp->hp += size_to_reserve;
1511 upd_evacuee(src,(StgClosure *)dest);
1513 // We store the size of the just evacuated object in the LDV word so that
1514 // the profiler can guess the position of the next object later.
1515 // size_to_copy_org is wrong because the closure already occupies size_to_reserve
1517 SET_EVACUAEE_FOR_LDV(src, size_to_reserve);
1519 if (size_to_reserve - size_to_copy_org > 0)
1520 FILL_SLOP(stp->hp - 1, (int)(size_to_reserve - size_to_copy_org));
1522 return (StgClosure *)dest;
1526 /* -----------------------------------------------------------------------------
1527 Evacuate a large object
1529 This just consists of removing the object from the (doubly-linked)
1530 step->large_objects list, and linking it on to the (singly-linked)
1531 step->new_large_objects list, from where it will be scavenged later.
1533 Convention: bd->flags has BF_EVACUATED set for a large object
1534 that has been evacuated, or unset otherwise.
1535 -------------------------------------------------------------------------- */
1539 evacuate_large(StgPtr p)
1541 bdescr *bd = Bdescr(p);
1544 // object must be at the beginning of the block (or be a ByteArray)
1545 ASSERT(get_itbl((StgClosure *)p)->type == ARR_WORDS ||
1546 (((W_)p & BLOCK_MASK) == 0));
1548 // already evacuated?
1549 if (bd->flags & BF_EVACUATED) {
1550 /* Don't forget to set the failed_to_evac flag if we didn't get
1551 * the desired destination (see comments in evacuate()).
1553 if (bd->gen_no < evac_gen) {
1554 failed_to_evac = rtsTrue;
1555 TICK_GC_FAILED_PROMOTION();
1561 // remove from large_object list
1563 bd->u.back->link = bd->link;
1564 } else { // first object in the list
1565 stp->large_objects = bd->link;
1568 bd->link->u.back = bd->u.back;
1571 /* link it on to the evacuated large object list of the destination step
1574 if (stp->gen_no < evac_gen) {
1575 #ifdef NO_EAGER_PROMOTION
1576 failed_to_evac = rtsTrue;
1578 stp = &generations[evac_gen].steps[0];
1583 bd->gen_no = stp->gen_no;
1584 bd->link = stp->new_large_objects;
1585 stp->new_large_objects = bd;
1586 bd->flags |= BF_EVACUATED;
1589 /* -----------------------------------------------------------------------------
1592 This is called (eventually) for every live object in the system.
1594 The caller to evacuate specifies a desired generation in the
1595 evac_gen global variable. The following conditions apply to
1596 evacuating an object which resides in generation M when we're
1597 collecting up to generation N
1601 else evac to step->to
1603 if M < evac_gen evac to evac_gen, step 0
1605 if the object is already evacuated, then we check which generation
1608 if M >= evac_gen do nothing
1609 if M < evac_gen set failed_to_evac flag to indicate that we
1610 didn't manage to evacuate this object into evac_gen.
1615 evacuate() is the single most important function performance-wise
1616 in the GC. Various things have been tried to speed it up, but as
1617 far as I can tell the code generated by gcc 3.2 with -O2 is about
1618 as good as it's going to get. We pass the argument to evacuate()
1619 in a register using the 'regparm' attribute (see the prototype for
1620 evacuate() near the top of this file).
1622 Changing evacuate() to take an (StgClosure **) rather than
1623 returning the new pointer seems attractive, because we can avoid
1624 writing back the pointer when it hasn't changed (eg. for a static
1625 object, or an object in a generation > N). However, I tried it and
1626 it doesn't help. One reason is that the (StgClosure **) pointer
1627 gets spilled to the stack inside evacuate(), resulting in far more
1628 extra reads/writes than we save.
1629 -------------------------------------------------------------------------- */
1631 REGPARM1 static StgClosure *
1632 evacuate(StgClosure *q)
1639 const StgInfoTable *info;
1642 if (HEAP_ALLOCED(q)) {
1645 if (bd->gen_no > N) {
1646 /* Can't evacuate this object, because it's in a generation
1647 * older than the ones we're collecting. Let's hope that it's
1648 * in evac_gen or older, or we will have to arrange to track
1649 * this pointer using the mutable list.
1651 if (bd->gen_no < evac_gen) {
1653 failed_to_evac = rtsTrue;
1654 TICK_GC_FAILED_PROMOTION();
1659 /* evacuate large objects by re-linking them onto a different list.
1661 if (bd->flags & BF_LARGE) {
1663 if (info->type == TSO &&
1664 ((StgTSO *)q)->what_next == ThreadRelocated) {
1665 q = (StgClosure *)((StgTSO *)q)->link;
1668 evacuate_large((P_)q);
1672 /* If the object is in a step that we're compacting, then we
1673 * need to use an alternative evacuate procedure.
1675 if (bd->flags & BF_COMPACTED) {
1676 if (!is_marked((P_)q,bd)) {
1678 if (mark_stack_full()) {
1679 mark_stack_overflowed = rtsTrue;
1682 push_mark_stack((P_)q);
1687 /* Object is not already evacuated. */
1688 ASSERT((bd->flags & BF_EVACUATED) == 0);
1693 else stp = NULL; // make sure copy() will crash if HEAP_ALLOCED is wrong
1696 // make sure the info pointer is into text space
1697 ASSERT(LOOKS_LIKE_CLOSURE_PTR(q));
1700 switch (info -> type) {
1704 return copy(q,sizeW_fromITBL(info),stp);
1708 StgWord w = (StgWord)q->payload[0];
1709 if (q->header.info == Czh_con_info &&
1710 // unsigned, so always true: (StgChar)w >= MIN_CHARLIKE &&
1711 (StgChar)w <= MAX_CHARLIKE) {
1712 return (StgClosure *)CHARLIKE_CLOSURE((StgChar)w);
1714 if (q->header.info == Izh_con_info &&
1715 (StgInt)w >= MIN_INTLIKE && (StgInt)w <= MAX_INTLIKE) {
1716 return (StgClosure *)INTLIKE_CLOSURE((StgInt)w);
1718 // else, fall through ...
1724 return copy(q,sizeofW(StgHeader)+1,stp);
1728 return copy(q,sizeofW(StgThunk)+1,stp);
1733 #ifdef NO_PROMOTE_THUNKS
1734 if (bd->gen_no == 0 &&
1735 bd->step->no != 0 &&
1736 bd->step->no == generations[bd->gen_no].n_steps-1) {
1740 return copy(q,sizeofW(StgThunk)+2,stp);
1748 return copy(q,sizeofW(StgHeader)+2,stp);
1751 return copy(q,thunk_sizeW_fromITBL(info),stp);
1756 case IND_OLDGEN_PERM:
1760 return copy(q,sizeW_fromITBL(info),stp);
1763 return copy(q,bco_sizeW((StgBCO *)q),stp);
1766 case SE_CAF_BLACKHOLE:
1769 return copyPart(q,BLACKHOLE_sizeW(),sizeofW(StgHeader),stp);
1771 case THUNK_SELECTOR:
1775 if (thunk_selector_depth > MAX_THUNK_SELECTOR_DEPTH) {
1776 return copy(q,THUNK_SELECTOR_sizeW(),stp);
1779 p = eval_thunk_selector(info->layout.selector_offset,
1783 return copy(q,THUNK_SELECTOR_sizeW(),stp);
1785 // q is still BLACKHOLE'd.
1786 thunk_selector_depth++;
1788 thunk_selector_depth--;
1791 // We store the size of the just evacuated object in the
1792 // LDV word so that the profiler can guess the position of
1793 // the next object later.
1794 SET_EVACUAEE_FOR_LDV(q, THUNK_SELECTOR_sizeW());
1802 // follow chains of indirections, don't evacuate them
1803 q = ((StgInd*)q)->indirectee;
1807 if (info->srt_bitmap != 0 && major_gc &&
1808 *THUNK_STATIC_LINK((StgClosure *)q) == NULL) {
1809 *THUNK_STATIC_LINK((StgClosure *)q) = static_objects;
1810 static_objects = (StgClosure *)q;
1815 if (info->srt_bitmap != 0 && major_gc &&
1816 *FUN_STATIC_LINK((StgClosure *)q) == NULL) {
1817 *FUN_STATIC_LINK((StgClosure *)q) = static_objects;
1818 static_objects = (StgClosure *)q;
1823 /* If q->saved_info != NULL, then it's a revertible CAF - it'll be
1824 * on the CAF list, so don't do anything with it here (we'll
1825 * scavenge it later).
1828 && ((StgIndStatic *)q)->saved_info == NULL
1829 && *IND_STATIC_LINK((StgClosure *)q) == NULL) {
1830 *IND_STATIC_LINK((StgClosure *)q) = static_objects;
1831 static_objects = (StgClosure *)q;
1836 if (major_gc && *STATIC_LINK(info,(StgClosure *)q) == NULL) {
1837 *STATIC_LINK(info,(StgClosure *)q) = static_objects;
1838 static_objects = (StgClosure *)q;
1842 case CONSTR_INTLIKE:
1843 case CONSTR_CHARLIKE:
1844 case CONSTR_NOCAF_STATIC:
1845 /* no need to put these on the static linked list, they don't need
1859 case CATCH_STM_FRAME:
1860 case CATCH_RETRY_FRAME:
1861 case ATOMICALLY_FRAME:
1862 // shouldn't see these
1863 barf("evacuate: stack frame at %p\n", q);
1866 return copy(q,pap_sizeW((StgPAP*)q),stp);
1869 return copy(q,ap_sizeW((StgAP*)q),stp);
1872 return copy(q,ap_stack_sizeW((StgAP_STACK*)q),stp);
1875 /* Already evacuated, just return the forwarding address.
1876 * HOWEVER: if the requested destination generation (evac_gen) is
1877 * older than the actual generation (because the object was
1878 * already evacuated to a younger generation) then we have to
1879 * set the failed_to_evac flag to indicate that we couldn't
1880 * manage to promote the object to the desired generation.
1882 if (evac_gen > 0) { // optimisation
1883 StgClosure *p = ((StgEvacuated*)q)->evacuee;
1884 if (HEAP_ALLOCED(p) && Bdescr((P_)p)->gen_no < evac_gen) {
1885 failed_to_evac = rtsTrue;
1886 TICK_GC_FAILED_PROMOTION();
1889 return ((StgEvacuated*)q)->evacuee;
1892 // just copy the block
1893 return copy(q,arr_words_sizeW((StgArrWords *)q),stp);
1896 case MUT_ARR_PTRS_FROZEN:
1897 case MUT_ARR_PTRS_FROZEN0:
1898 // just copy the block
1899 return copy(q,mut_arr_ptrs_sizeW((StgMutArrPtrs *)q),stp);
1903 StgTSO *tso = (StgTSO *)q;
1905 /* Deal with redirected TSOs (a TSO that's had its stack enlarged).
1907 if (tso->what_next == ThreadRelocated) {
1908 q = (StgClosure *)tso->link;
1912 /* To evacuate a small TSO, we need to relocate the update frame
1919 new_tso = (StgTSO *)copyPart((StgClosure *)tso,
1921 sizeofW(StgTSO), stp);
1922 move_TSO(tso, new_tso);
1923 for (p = tso->sp, q = new_tso->sp;
1924 p < tso->stack+tso->stack_size;) {
1928 return (StgClosure *)new_tso;
1935 //StgInfoTable *rip = get_closure_info(q, &size, &ptrs, &nonptrs, &vhs, str);
1936 to = copy(q,BLACKHOLE_sizeW(),stp);
1937 //ToDo: derive size etc from reverted IP
1938 //to = copy(q,size,stp);
1940 debugBelch("@@ evacuate: RBH %p (%s) to %p (%s)",
1941 q, info_type(q), to, info_type(to)));
1946 ASSERT(sizeofW(StgBlockedFetch) >= MIN_NONUPD_SIZE);
1947 to = copy(q,sizeofW(StgBlockedFetch),stp);
1949 debugBelch("@@ evacuate: %p (%s) to %p (%s)",
1950 q, info_type(q), to, info_type(to)));
1957 ASSERT(sizeofW(StgBlockedFetch) >= MIN_UPD_SIZE);
1958 to = copy(q,sizeofW(StgFetchMe),stp);
1960 debugBelch("@@ evacuate: %p (%s) to %p (%s)",
1961 q, info_type(q), to, info_type(to)));
1965 ASSERT(sizeofW(StgBlockedFetch) >= MIN_UPD_SIZE);
1966 to = copy(q,sizeofW(StgFetchMeBlockingQueue),stp);
1968 debugBelch("@@ evacuate: %p (%s) to %p (%s)",
1969 q, info_type(q), to, info_type(to)));
1974 return copy(q,sizeofW(StgTRecHeader),stp);
1976 case TVAR_WAIT_QUEUE:
1977 return copy(q,sizeofW(StgTVarWaitQueue),stp);
1980 return copy(q,sizeofW(StgTVar),stp);
1983 return copy(q,sizeofW(StgTRecChunk),stp);
1986 barf("evacuate: strange closure type %d", (int)(info->type));
1992 /* -----------------------------------------------------------------------------
1993 Evaluate a THUNK_SELECTOR if possible.
1995 returns: NULL if we couldn't evaluate this THUNK_SELECTOR, or
1996 a closure pointer if we evaluated it and this is the result. Note
1997 that "evaluating" the THUNK_SELECTOR doesn't necessarily mean
1998 reducing it to HNF, just that we have eliminated the selection.
1999 The result might be another thunk, or even another THUNK_SELECTOR.
2001 If the return value is non-NULL, the original selector thunk has
2002 been BLACKHOLE'd, and should be updated with an indirection or a
2003 forwarding pointer. If the return value is NULL, then the selector
2007 ToDo: the treatment of THUNK_SELECTORS could be improved in the
2008 following way (from a suggestion by Ian Lynagh):
2010 We can have a chain like this:
2014 |-----> sel_0 --> (a,b)
2016 |-----> sel_0 --> ...
2018 and the depth limit means we don't go all the way to the end of the
2019 chain, which results in a space leak. This affects the recursive
2020 call to evacuate() in the THUNK_SELECTOR case in evacuate(): *not*
2021 the recursive call to eval_thunk_selector() in
2022 eval_thunk_selector().
2024 We could eliminate the depth bound in this case, in the following
2027 - traverse the chain once to discover the *value* of the
2028 THUNK_SELECTOR. Mark all THUNK_SELECTORS that we
2029 visit on the way as having been visited already (somehow).
2031 - in a second pass, traverse the chain again updating all
2032 THUNK_SEELCTORS that we find on the way with indirections to
2035 - if we encounter a "marked" THUNK_SELECTOR in a normal
2036 evacuate(), we konw it can't be updated so just evac it.
2038 Program that illustrates the problem:
2041 foo (x:xs) = let (ys, zs) = foo xs
2042 in if x >= 0 then (x:ys, zs) else (ys, x:zs)
2044 main = bar [1..(100000000::Int)]
2045 bar xs = (\(ys, zs) -> print ys >> print zs) (foo xs)
2047 -------------------------------------------------------------------------- */
2049 static inline rtsBool
2050 is_to_space ( StgClosure *p )
2054 bd = Bdescr((StgPtr)p);
2055 if (HEAP_ALLOCED(p) &&
2056 ((bd->flags & BF_EVACUATED)
2057 || ((bd->flags & BF_COMPACTED) &&
2058 is_marked((P_)p,bd)))) {
2066 eval_thunk_selector( nat field, StgSelector * p )
2069 const StgInfoTable *info_ptr;
2070 StgClosure *selectee;
2072 selectee = p->selectee;
2074 // Save the real info pointer (NOTE: not the same as get_itbl()).
2075 info_ptr = p->header.info;
2077 // If the THUNK_SELECTOR is in a generation that we are not
2078 // collecting, then bail out early. We won't be able to save any
2079 // space in any case, and updating with an indirection is trickier
2081 if (Bdescr((StgPtr)p)->gen_no > N) {
2085 // BLACKHOLE the selector thunk, since it is now under evaluation.
2086 // This is important to stop us going into an infinite loop if
2087 // this selector thunk eventually refers to itself.
2088 SET_INFO(p,&stg_BLACKHOLE_info);
2092 // We don't want to end up in to-space, because this causes
2093 // problems when the GC later tries to evacuate the result of
2094 // eval_thunk_selector(). There are various ways this could
2097 // 1. following an IND_STATIC
2099 // 2. when the old generation is compacted, the mark phase updates
2100 // from-space pointers to be to-space pointers, and we can't
2101 // reliably tell which we're following (eg. from an IND_STATIC).
2103 // 3. compacting GC again: if we're looking at a constructor in
2104 // the compacted generation, it might point directly to objects
2105 // in to-space. We must bale out here, otherwise doing the selection
2106 // will result in a to-space pointer being returned.
2108 // (1) is dealt with using a BF_EVACUATED test on the
2109 // selectee. (2) and (3): we can tell if we're looking at an
2110 // object in the compacted generation that might point to
2111 // to-space objects by testing that (a) it is BF_COMPACTED, (b)
2112 // the compacted generation is being collected, and (c) the
2113 // object is marked. Only a marked object may have pointers that
2114 // point to to-space objects, because that happens when
2117 // The to-space test is now embodied in the in_to_space() inline
2118 // function, as it is re-used below.
2120 if (is_to_space(selectee)) {
2124 info = get_itbl(selectee);
2125 switch (info->type) {
2133 case CONSTR_NOCAF_STATIC:
2134 // check that the size is in range
2135 ASSERT(field < (StgWord32)(info->layout.payload.ptrs +
2136 info->layout.payload.nptrs));
2138 // Select the right field from the constructor, and check
2139 // that the result isn't in to-space. It might be in
2140 // to-space if, for example, this constructor contains
2141 // pointers to younger-gen objects (and is on the mut-once
2146 q = selectee->payload[field];
2147 if (is_to_space(q)) {
2157 case IND_OLDGEN_PERM:
2159 selectee = ((StgInd *)selectee)->indirectee;
2163 // We don't follow pointers into to-space; the constructor
2164 // has already been evacuated, so we won't save any space
2165 // leaks by evaluating this selector thunk anyhow.
2168 case THUNK_SELECTOR:
2172 // check that we don't recurse too much, re-using the
2173 // depth bound also used in evacuate().
2174 if (thunk_selector_depth >= MAX_THUNK_SELECTOR_DEPTH) {
2177 thunk_selector_depth++;
2179 val = eval_thunk_selector(info->layout.selector_offset,
2180 (StgSelector *)selectee);
2182 thunk_selector_depth--;
2187 // We evaluated this selector thunk, so update it with
2188 // an indirection. NOTE: we don't use UPD_IND here,
2189 // because we are guaranteed that p is in a generation
2190 // that we are collecting, and we never want to put the
2191 // indirection on a mutable list.
2193 // For the purposes of LDV profiling, we have destroyed
2194 // the original selector thunk.
2195 SET_INFO(p, info_ptr);
2196 LDV_RECORD_DEAD_FILL_SLOP_DYNAMIC(selectee);
2198 ((StgInd *)selectee)->indirectee = val;
2199 SET_INFO(selectee,&stg_IND_info);
2201 // For the purposes of LDV profiling, we have created an
2203 LDV_RECORD_CREATE(selectee);
2220 case SE_CAF_BLACKHOLE:
2232 // not evaluated yet
2236 barf("eval_thunk_selector: strange selectee %d",
2241 // We didn't manage to evaluate this thunk; restore the old info pointer
2242 SET_INFO(p, info_ptr);
2246 /* -----------------------------------------------------------------------------
2247 move_TSO is called to update the TSO structure after it has been
2248 moved from one place to another.
2249 -------------------------------------------------------------------------- */
2252 move_TSO (StgTSO *src, StgTSO *dest)
2256 // relocate the stack pointer...
2257 diff = (StgPtr)dest - (StgPtr)src; // In *words*
2258 dest->sp = (StgPtr)dest->sp + diff;
2261 /* Similar to scavenge_large_bitmap(), but we don't write back the
2262 * pointers we get back from evacuate().
2265 scavenge_large_srt_bitmap( StgLargeSRT *large_srt )
2272 bitmap = large_srt->l.bitmap[b];
2273 size = (nat)large_srt->l.size;
2274 p = (StgClosure **)large_srt->srt;
2275 for (i = 0; i < size; ) {
2276 if ((bitmap & 1) != 0) {
2281 if (i % BITS_IN(W_) == 0) {
2283 bitmap = large_srt->l.bitmap[b];
2285 bitmap = bitmap >> 1;
2290 /* evacuate the SRT. If srt_bitmap is zero, then there isn't an
2291 * srt field in the info table. That's ok, because we'll
2292 * never dereference it.
2295 scavenge_srt (StgClosure **srt, nat srt_bitmap)
2300 bitmap = srt_bitmap;
2303 if (bitmap == (StgHalfWord)(-1)) {
2304 scavenge_large_srt_bitmap( (StgLargeSRT *)srt );
2308 while (bitmap != 0) {
2309 if ((bitmap & 1) != 0) {
2310 #ifdef ENABLE_WIN32_DLL_SUPPORT
2311 // Special-case to handle references to closures hiding out in DLLs, since
2312 // double indirections required to get at those. The code generator knows
2313 // which is which when generating the SRT, so it stores the (indirect)
2314 // reference to the DLL closure in the table by first adding one to it.
2315 // We check for this here, and undo the addition before evacuating it.
2317 // If the SRT entry hasn't got bit 0 set, the SRT entry points to a
2318 // closure that's fixed at link-time, and no extra magic is required.
2319 if ( (unsigned long)(*srt) & 0x1 ) {
2320 evacuate(*stgCast(StgClosure**,(stgCast(unsigned long, *srt) & ~0x1)));
2329 bitmap = bitmap >> 1;
2335 scavenge_thunk_srt(const StgInfoTable *info)
2337 StgThunkInfoTable *thunk_info;
2339 thunk_info = itbl_to_thunk_itbl(info);
2340 scavenge_srt((StgClosure **)GET_SRT(thunk_info), thunk_info->i.srt_bitmap);
2344 scavenge_fun_srt(const StgInfoTable *info)
2346 StgFunInfoTable *fun_info;
2348 fun_info = itbl_to_fun_itbl(info);
2349 scavenge_srt((StgClosure **)GET_FUN_SRT(fun_info), fun_info->i.srt_bitmap);
2352 /* -----------------------------------------------------------------------------
2354 -------------------------------------------------------------------------- */
2357 scavengeTSO (StgTSO *tso)
2359 // chase the link field for any TSOs on the same queue
2360 tso->link = (StgTSO *)evacuate((StgClosure *)tso->link);
2361 if ( tso->why_blocked == BlockedOnMVar
2362 || tso->why_blocked == BlockedOnBlackHole
2363 || tso->why_blocked == BlockedOnException
2365 || tso->why_blocked == BlockedOnGA
2366 || tso->why_blocked == BlockedOnGA_NoSend
2369 tso->block_info.closure = evacuate(tso->block_info.closure);
2371 if ( tso->blocked_exceptions != NULL ) {
2372 tso->blocked_exceptions =
2373 (StgTSO *)evacuate((StgClosure *)tso->blocked_exceptions);
2376 // scavange current transaction record
2377 tso->trec = (StgTRecHeader *)evacuate((StgClosure *)tso->trec);
2379 // scavenge this thread's stack
2380 scavenge_stack(tso->sp, &(tso->stack[tso->stack_size]));
2383 /* -----------------------------------------------------------------------------
2384 Blocks of function args occur on the stack (at the top) and
2386 -------------------------------------------------------------------------- */
2388 STATIC_INLINE StgPtr
2389 scavenge_arg_block (StgFunInfoTable *fun_info, StgClosure **args)
2396 switch (fun_info->f.fun_type) {
2398 bitmap = BITMAP_BITS(fun_info->f.b.bitmap);
2399 size = BITMAP_SIZE(fun_info->f.b.bitmap);
2402 size = GET_FUN_LARGE_BITMAP(fun_info)->size;
2403 scavenge_large_bitmap(p, GET_FUN_LARGE_BITMAP(fun_info), size);
2407 bitmap = BITMAP_BITS(stg_arg_bitmaps[fun_info->f.fun_type]);
2408 size = BITMAP_SIZE(stg_arg_bitmaps[fun_info->f.fun_type]);
2411 if ((bitmap & 1) == 0) {
2412 *p = (StgWord)(StgPtr)evacuate((StgClosure *)*p);
2415 bitmap = bitmap >> 1;
2423 STATIC_INLINE StgPtr
2424 scavenge_PAP_payload (StgClosure *fun, StgClosure **payload, StgWord size)
2428 StgFunInfoTable *fun_info;
2430 fun_info = get_fun_itbl(fun);
2431 ASSERT(fun_info->i.type != PAP);
2432 p = (StgPtr)payload;
2434 switch (fun_info->f.fun_type) {
2436 bitmap = BITMAP_BITS(fun_info->f.b.bitmap);
2439 scavenge_large_bitmap(p, GET_FUN_LARGE_BITMAP(fun_info), size);
2443 scavenge_large_bitmap((StgPtr)payload, BCO_BITMAP(fun), size);
2447 bitmap = BITMAP_BITS(stg_arg_bitmaps[fun_info->f.fun_type]);
2450 if ((bitmap & 1) == 0) {
2451 *p = (StgWord)(StgPtr)evacuate((StgClosure *)*p);
2454 bitmap = bitmap >> 1;
2462 STATIC_INLINE StgPtr
2463 scavenge_PAP (StgPAP *pap)
2465 pap->fun = evacuate(pap->fun);
2466 return scavenge_PAP_payload (pap->fun, pap->payload, pap->n_args);
2469 STATIC_INLINE StgPtr
2470 scavenge_AP (StgAP *ap)
2472 ap->fun = evacuate(ap->fun);
2473 return scavenge_PAP_payload (ap->fun, ap->payload, ap->n_args);
2476 /* -----------------------------------------------------------------------------
2477 Scavenge a given step until there are no more objects in this step
2480 evac_gen is set by the caller to be either zero (for a step in a
2481 generation < N) or G where G is the generation of the step being
2484 We sometimes temporarily change evac_gen back to zero if we're
2485 scavenging a mutable object where early promotion isn't such a good
2487 -------------------------------------------------------------------------- */
2495 nat saved_evac_gen = evac_gen;
2500 failed_to_evac = rtsFalse;
2502 /* scavenge phase - standard breadth-first scavenging of the
2506 while (bd != stp->hp_bd || p < stp->hp) {
2508 // If we're at the end of this block, move on to the next block
2509 if (bd != stp->hp_bd && p == bd->free) {
2515 ASSERT(LOOKS_LIKE_CLOSURE_PTR(p));
2516 info = get_itbl((StgClosure *)p);
2518 ASSERT(thunk_selector_depth == 0);
2521 switch (info->type) {
2525 StgMVar *mvar = ((StgMVar *)p);
2527 mvar->head = (StgTSO *)evacuate((StgClosure *)mvar->head);
2528 mvar->tail = (StgTSO *)evacuate((StgClosure *)mvar->tail);
2529 mvar->value = evacuate((StgClosure *)mvar->value);
2530 evac_gen = saved_evac_gen;
2531 failed_to_evac = rtsTrue; // mutable.
2532 p += sizeofW(StgMVar);
2537 scavenge_fun_srt(info);
2538 ((StgClosure *)p)->payload[1] = evacuate(((StgClosure *)p)->payload[1]);
2539 ((StgClosure *)p)->payload[0] = evacuate(((StgClosure *)p)->payload[0]);
2540 p += sizeofW(StgHeader) + 2;
2544 scavenge_thunk_srt(info);
2545 ((StgThunk *)p)->payload[1] = evacuate(((StgThunk *)p)->payload[1]);
2546 ((StgThunk *)p)->payload[0] = evacuate(((StgThunk *)p)->payload[0]);
2547 p += sizeofW(StgThunk) + 2;
2551 ((StgClosure *)p)->payload[1] = evacuate(((StgClosure *)p)->payload[1]);
2552 ((StgClosure *)p)->payload[0] = evacuate(((StgClosure *)p)->payload[0]);
2553 p += sizeofW(StgHeader) + 2;
2557 scavenge_thunk_srt(info);
2558 ((StgThunk *)p)->payload[0] = evacuate(((StgThunk *)p)->payload[0]);
2559 p += sizeofW(StgThunk) + 1;
2563 scavenge_fun_srt(info);
2565 ((StgClosure *)p)->payload[0] = evacuate(((StgClosure *)p)->payload[0]);
2566 p += sizeofW(StgHeader) + 1;
2570 scavenge_thunk_srt(info);
2571 p += sizeofW(StgThunk) + 1;
2575 scavenge_fun_srt(info);
2577 p += sizeofW(StgHeader) + 1;
2581 scavenge_thunk_srt(info);
2582 p += sizeofW(StgThunk) + 2;
2586 scavenge_fun_srt(info);
2588 p += sizeofW(StgHeader) + 2;
2592 scavenge_thunk_srt(info);
2593 ((StgThunk *)p)->payload[0] = evacuate(((StgThunk *)p)->payload[0]);
2594 p += sizeofW(StgThunk) + 2;
2598 scavenge_fun_srt(info);
2600 ((StgClosure *)p)->payload[0] = evacuate(((StgClosure *)p)->payload[0]);
2601 p += sizeofW(StgHeader) + 2;
2605 scavenge_fun_srt(info);
2612 scavenge_thunk_srt(info);
2613 end = (P_)((StgThunk *)p)->payload + info->layout.payload.ptrs;
2614 for (p = (P_)((StgThunk *)p)->payload; p < end; p++) {
2615 *p = (StgWord)(StgPtr)evacuate((StgClosure *)*p);
2617 p += info->layout.payload.nptrs;
2629 end = (P_)((StgClosure *)p)->payload + info->layout.payload.ptrs;
2630 for (p = (P_)((StgClosure *)p)->payload; p < end; p++) {
2631 *p = (StgWord)(StgPtr)evacuate((StgClosure *)*p);
2633 p += info->layout.payload.nptrs;
2638 StgBCO *bco = (StgBCO *)p;
2639 bco->instrs = (StgArrWords *)evacuate((StgClosure *)bco->instrs);
2640 bco->literals = (StgArrWords *)evacuate((StgClosure *)bco->literals);
2641 bco->ptrs = (StgMutArrPtrs *)evacuate((StgClosure *)bco->ptrs);
2642 bco->itbls = (StgArrWords *)evacuate((StgClosure *)bco->itbls);
2643 p += bco_sizeW(bco);
2648 if (stp->gen->no != 0) {
2651 // No need to call LDV_recordDead_FILL_SLOP_DYNAMIC() because an
2652 // IND_OLDGEN_PERM closure is larger than an IND_PERM closure.
2653 LDV_recordDead((StgClosure *)p, sizeofW(StgInd));
2656 // Todo: maybe use SET_HDR() and remove LDV_RECORD_CREATE()?
2658 SET_INFO(((StgClosure *)p), &stg_IND_OLDGEN_PERM_info);
2660 // We pretend that p has just been created.
2661 LDV_RECORD_CREATE((StgClosure *)p);
2664 case IND_OLDGEN_PERM:
2665 ((StgInd *)p)->indirectee = evacuate(((StgInd *)p)->indirectee);
2666 p += sizeofW(StgInd);
2671 ((StgMutVar *)p)->var = evacuate(((StgMutVar *)p)->var);
2672 evac_gen = saved_evac_gen;
2673 failed_to_evac = rtsTrue; // mutable anyhow
2674 p += sizeofW(StgMutVar);
2678 case SE_CAF_BLACKHOLE:
2681 p += BLACKHOLE_sizeW();
2684 case THUNK_SELECTOR:
2686 StgSelector *s = (StgSelector *)p;
2687 s->selectee = evacuate(s->selectee);
2688 p += THUNK_SELECTOR_sizeW();
2692 // A chunk of stack saved in a heap object
2695 StgAP_STACK *ap = (StgAP_STACK *)p;
2697 ap->fun = evacuate(ap->fun);
2698 scavenge_stack((StgPtr)ap->payload, (StgPtr)ap->payload + ap->size);
2699 p = (StgPtr)ap->payload + ap->size;
2704 p = scavenge_PAP((StgPAP *)p);
2708 p = scavenge_AP((StgAP *)p);
2712 // nothing to follow
2713 p += arr_words_sizeW((StgArrWords *)p);
2717 // follow everything
2721 evac_gen = 0; // repeatedly mutable
2722 next = p + mut_arr_ptrs_sizeW((StgMutArrPtrs*)p);
2723 for (p = (P_)((StgMutArrPtrs *)p)->payload; p < next; p++) {
2724 *p = (StgWord)(StgPtr)evacuate((StgClosure *)*p);
2726 evac_gen = saved_evac_gen;
2727 failed_to_evac = rtsTrue; // mutable anyhow.
2731 case MUT_ARR_PTRS_FROZEN:
2732 case MUT_ARR_PTRS_FROZEN0:
2733 // follow everything
2737 next = p + mut_arr_ptrs_sizeW((StgMutArrPtrs*)p);
2738 for (p = (P_)((StgMutArrPtrs *)p)->payload; p < next; p++) {
2739 *p = (StgWord)(StgPtr)evacuate((StgClosure *)*p);
2741 // it's tempting to recordMutable() if failed_to_evac is
2742 // false, but that breaks some assumptions (eg. every
2743 // closure on the mutable list is supposed to have the MUT
2744 // flag set, and MUT_ARR_PTRS_FROZEN doesn't).
2750 StgTSO *tso = (StgTSO *)p;
2753 evac_gen = saved_evac_gen;
2754 failed_to_evac = rtsTrue; // mutable anyhow.
2755 p += tso_sizeW(tso);
2763 nat size, ptrs, nonptrs, vhs;
2765 StgInfoTable *rip = get_closure_info(p, &size, &ptrs, &nonptrs, &vhs, str);
2767 StgRBH *rbh = (StgRBH *)p;
2768 (StgClosure *)rbh->blocking_queue =
2769 evacuate((StgClosure *)rbh->blocking_queue);
2770 failed_to_evac = rtsTrue; // mutable anyhow.
2772 debugBelch("@@ scavenge: RBH %p (%s) (new blocking_queue link=%p)",
2773 p, info_type(p), (StgClosure *)rbh->blocking_queue));
2774 // ToDo: use size of reverted closure here!
2775 p += BLACKHOLE_sizeW();
2781 StgBlockedFetch *bf = (StgBlockedFetch *)p;
2782 // follow the pointer to the node which is being demanded
2783 (StgClosure *)bf->node =
2784 evacuate((StgClosure *)bf->node);
2785 // follow the link to the rest of the blocking queue
2786 (StgClosure *)bf->link =
2787 evacuate((StgClosure *)bf->link);
2789 debugBelch("@@ scavenge: %p (%s); node is now %p; exciting, isn't it",
2790 bf, info_type((StgClosure *)bf),
2791 bf->node, info_type(bf->node)));
2792 p += sizeofW(StgBlockedFetch);
2800 p += sizeofW(StgFetchMe);
2801 break; // nothing to do in this case
2805 StgFetchMeBlockingQueue *fmbq = (StgFetchMeBlockingQueue *)p;
2806 (StgClosure *)fmbq->blocking_queue =
2807 evacuate((StgClosure *)fmbq->blocking_queue);
2809 debugBelch("@@ scavenge: %p (%s) exciting, isn't it",
2810 p, info_type((StgClosure *)p)));
2811 p += sizeofW(StgFetchMeBlockingQueue);
2816 case TVAR_WAIT_QUEUE:
2818 StgTVarWaitQueue *wq = ((StgTVarWaitQueue *) p);
2820 wq->waiting_tso = (StgTSO *)evacuate((StgClosure*)wq->waiting_tso);
2821 wq->next_queue_entry = (StgTVarWaitQueue *)evacuate((StgClosure*)wq->next_queue_entry);
2822 wq->prev_queue_entry = (StgTVarWaitQueue *)evacuate((StgClosure*)wq->prev_queue_entry);
2823 evac_gen = saved_evac_gen;
2824 failed_to_evac = rtsTrue; // mutable
2825 p += sizeofW(StgTVarWaitQueue);
2831 StgTVar *tvar = ((StgTVar *) p);
2833 tvar->current_value = evacuate((StgClosure*)tvar->current_value);
2834 tvar->first_wait_queue_entry = (StgTVarWaitQueue *)evacuate((StgClosure*)tvar->first_wait_queue_entry);
2835 evac_gen = saved_evac_gen;
2836 failed_to_evac = rtsTrue; // mutable
2837 p += sizeofW(StgTVar);
2843 StgTRecHeader *trec = ((StgTRecHeader *) p);
2845 trec->enclosing_trec = (StgTRecHeader *)evacuate((StgClosure*)trec->enclosing_trec);
2846 trec->current_chunk = (StgTRecChunk *)evacuate((StgClosure*)trec->current_chunk);
2847 evac_gen = saved_evac_gen;
2848 failed_to_evac = rtsTrue; // mutable
2849 p += sizeofW(StgTRecHeader);
2856 StgTRecChunk *tc = ((StgTRecChunk *) p);
2857 TRecEntry *e = &(tc -> entries[0]);
2859 tc->prev_chunk = (StgTRecChunk *)evacuate((StgClosure*)tc->prev_chunk);
2860 for (i = 0; i < tc -> next_entry_idx; i ++, e++ ) {
2861 e->tvar = (StgTVar *)evacuate((StgClosure*)e->tvar);
2862 e->expected_value = evacuate((StgClosure*)e->expected_value);
2863 e->new_value = evacuate((StgClosure*)e->new_value);
2865 evac_gen = saved_evac_gen;
2866 failed_to_evac = rtsTrue; // mutable
2867 p += sizeofW(StgTRecChunk);
2872 barf("scavenge: unimplemented/strange closure type %d @ %p",
2877 * We need to record the current object on the mutable list if
2878 * (a) It is actually mutable, or
2879 * (b) It contains pointers to a younger generation.
2880 * Case (b) arises if we didn't manage to promote everything that
2881 * the current object points to into the current generation.
2883 if (failed_to_evac) {
2884 failed_to_evac = rtsFalse;
2885 recordMutableGen((StgClosure *)q, stp->gen);
2893 /* -----------------------------------------------------------------------------
2894 Scavenge everything on the mark stack.
2896 This is slightly different from scavenge():
2897 - we don't walk linearly through the objects, so the scavenger
2898 doesn't need to advance the pointer on to the next object.
2899 -------------------------------------------------------------------------- */
2902 scavenge_mark_stack(void)
2908 evac_gen = oldest_gen->no;
2909 saved_evac_gen = evac_gen;
2912 while (!mark_stack_empty()) {
2913 p = pop_mark_stack();
2915 ASSERT(LOOKS_LIKE_CLOSURE_PTR(p));
2916 info = get_itbl((StgClosure *)p);
2919 switch (info->type) {
2923 StgMVar *mvar = ((StgMVar *)p);
2925 mvar->head = (StgTSO *)evacuate((StgClosure *)mvar->head);
2926 mvar->tail = (StgTSO *)evacuate((StgClosure *)mvar->tail);
2927 mvar->value = evacuate((StgClosure *)mvar->value);
2928 evac_gen = saved_evac_gen;
2929 failed_to_evac = rtsTrue; // mutable.
2934 scavenge_fun_srt(info);
2935 ((StgClosure *)p)->payload[1] = evacuate(((StgClosure *)p)->payload[1]);
2936 ((StgClosure *)p)->payload[0] = evacuate(((StgClosure *)p)->payload[0]);
2940 scavenge_thunk_srt(info);
2941 ((StgThunk *)p)->payload[1] = evacuate(((StgThunk *)p)->payload[1]);
2942 ((StgThunk *)p)->payload[0] = evacuate(((StgThunk *)p)->payload[0]);
2946 ((StgClosure *)p)->payload[1] = evacuate(((StgClosure *)p)->payload[1]);
2947 ((StgClosure *)p)->payload[0] = evacuate(((StgClosure *)p)->payload[0]);
2952 scavenge_fun_srt(info);
2953 ((StgClosure *)p)->payload[0] = evacuate(((StgClosure *)p)->payload[0]);
2958 scavenge_thunk_srt(info);
2959 ((StgThunk *)p)->payload[0] = evacuate(((StgThunk *)p)->payload[0]);
2964 ((StgClosure *)p)->payload[0] = evacuate(((StgClosure *)p)->payload[0]);
2969 scavenge_fun_srt(info);
2974 scavenge_thunk_srt(info);
2982 scavenge_fun_srt(info);
2989 scavenge_thunk_srt(info);
2990 end = (P_)((StgThunk *)p)->payload + info->layout.payload.ptrs;
2991 for (p = (P_)((StgThunk *)p)->payload; p < end; p++) {
2992 *p = (StgWord)(StgPtr)evacuate((StgClosure *)*p);
3005 end = (P_)((StgClosure *)p)->payload + info->layout.payload.ptrs;
3006 for (p = (P_)((StgClosure *)p)->payload; p < end; p++) {
3007 *p = (StgWord)(StgPtr)evacuate((StgClosure *)*p);
3013 StgBCO *bco = (StgBCO *)p;
3014 bco->instrs = (StgArrWords *)evacuate((StgClosure *)bco->instrs);
3015 bco->literals = (StgArrWords *)evacuate((StgClosure *)bco->literals);
3016 bco->ptrs = (StgMutArrPtrs *)evacuate((StgClosure *)bco->ptrs);
3017 bco->itbls = (StgArrWords *)evacuate((StgClosure *)bco->itbls);
3022 // don't need to do anything here: the only possible case
3023 // is that we're in a 1-space compacting collector, with
3024 // no "old" generation.
3028 case IND_OLDGEN_PERM:
3029 ((StgInd *)p)->indirectee =
3030 evacuate(((StgInd *)p)->indirectee);
3035 ((StgMutVar *)p)->var = evacuate(((StgMutVar *)p)->var);
3036 evac_gen = saved_evac_gen;
3037 failed_to_evac = rtsTrue;
3041 case SE_CAF_BLACKHOLE:
3047 case THUNK_SELECTOR:
3049 StgSelector *s = (StgSelector *)p;
3050 s->selectee = evacuate(s->selectee);
3054 // A chunk of stack saved in a heap object
3057 StgAP_STACK *ap = (StgAP_STACK *)p;
3059 ap->fun = evacuate(ap->fun);
3060 scavenge_stack((StgPtr)ap->payload, (StgPtr)ap->payload + ap->size);
3065 scavenge_PAP((StgPAP *)p);
3069 scavenge_AP((StgAP *)p);
3073 // follow everything
3077 evac_gen = 0; // repeatedly mutable
3078 next = p + mut_arr_ptrs_sizeW((StgMutArrPtrs*)p);
3079 for (p = (P_)((StgMutArrPtrs *)p)->payload; p < next; p++) {
3080 *p = (StgWord)(StgPtr)evacuate((StgClosure *)*p);
3082 evac_gen = saved_evac_gen;
3083 failed_to_evac = rtsTrue; // mutable anyhow.
3087 case MUT_ARR_PTRS_FROZEN:
3088 case MUT_ARR_PTRS_FROZEN0:
3089 // follow everything
3093 next = p + mut_arr_ptrs_sizeW((StgMutArrPtrs*)p);
3094 for (p = (P_)((StgMutArrPtrs *)p)->payload; p < next; p++) {
3095 *p = (StgWord)(StgPtr)evacuate((StgClosure *)*p);
3102 StgTSO *tso = (StgTSO *)p;
3105 evac_gen = saved_evac_gen;
3106 failed_to_evac = rtsTrue;
3114 nat size, ptrs, nonptrs, vhs;
3116 StgInfoTable *rip = get_closure_info(p, &size, &ptrs, &nonptrs, &vhs, str);
3118 StgRBH *rbh = (StgRBH *)p;
3119 bh->blocking_queue =
3120 (StgTSO *)evacuate((StgClosure *)bh->blocking_queue);
3121 failed_to_evac = rtsTrue; // mutable anyhow.
3123 debugBelch("@@ scavenge: RBH %p (%s) (new blocking_queue link=%p)",
3124 p, info_type(p), (StgClosure *)rbh->blocking_queue));
3130 StgBlockedFetch *bf = (StgBlockedFetch *)p;
3131 // follow the pointer to the node which is being demanded
3132 (StgClosure *)bf->node =
3133 evacuate((StgClosure *)bf->node);
3134 // follow the link to the rest of the blocking queue
3135 (StgClosure *)bf->link =
3136 evacuate((StgClosure *)bf->link);
3138 debugBelch("@@ scavenge: %p (%s); node is now %p; exciting, isn't it",
3139 bf, info_type((StgClosure *)bf),
3140 bf->node, info_type(bf->node)));
3148 break; // nothing to do in this case
3152 StgFetchMeBlockingQueue *fmbq = (StgFetchMeBlockingQueue *)p;
3153 (StgClosure *)fmbq->blocking_queue =
3154 evacuate((StgClosure *)fmbq->blocking_queue);
3156 debugBelch("@@ scavenge: %p (%s) exciting, isn't it",
3157 p, info_type((StgClosure *)p)));
3162 case TVAR_WAIT_QUEUE:
3164 StgTVarWaitQueue *wq = ((StgTVarWaitQueue *) p);
3166 wq->waiting_tso = (StgTSO *)evacuate((StgClosure*)wq->waiting_tso);
3167 wq->next_queue_entry = (StgTVarWaitQueue *)evacuate((StgClosure*)wq->next_queue_entry);
3168 wq->prev_queue_entry = (StgTVarWaitQueue *)evacuate((StgClosure*)wq->prev_queue_entry);
3169 evac_gen = saved_evac_gen;
3170 failed_to_evac = rtsTrue; // mutable
3176 StgTVar *tvar = ((StgTVar *) p);
3178 tvar->current_value = evacuate((StgClosure*)tvar->current_value);
3179 tvar->first_wait_queue_entry = (StgTVarWaitQueue *)evacuate((StgClosure*)tvar->first_wait_queue_entry);
3180 evac_gen = saved_evac_gen;
3181 failed_to_evac = rtsTrue; // mutable
3188 StgTRecChunk *tc = ((StgTRecChunk *) p);
3189 TRecEntry *e = &(tc -> entries[0]);
3191 tc->prev_chunk = (StgTRecChunk *)evacuate((StgClosure*)tc->prev_chunk);
3192 for (i = 0; i < tc -> next_entry_idx; i ++, e++ ) {
3193 e->tvar = (StgTVar *)evacuate((StgClosure*)e->tvar);
3194 e->expected_value = evacuate((StgClosure*)e->expected_value);
3195 e->new_value = evacuate((StgClosure*)e->new_value);
3197 evac_gen = saved_evac_gen;
3198 failed_to_evac = rtsTrue; // mutable
3204 StgTRecHeader *trec = ((StgTRecHeader *) p);
3206 trec->enclosing_trec = (StgTRecHeader *)evacuate((StgClosure*)trec->enclosing_trec);
3207 trec->current_chunk = (StgTRecChunk *)evacuate((StgClosure*)trec->current_chunk);
3208 evac_gen = saved_evac_gen;
3209 failed_to_evac = rtsTrue; // mutable
3214 barf("scavenge_mark_stack: unimplemented/strange closure type %d @ %p",
3218 if (failed_to_evac) {
3219 failed_to_evac = rtsFalse;
3220 recordMutableGen((StgClosure *)q, &generations[evac_gen]);
3223 // mark the next bit to indicate "scavenged"
3224 mark(q+1, Bdescr(q));
3226 } // while (!mark_stack_empty())
3228 // start a new linear scan if the mark stack overflowed at some point
3229 if (mark_stack_overflowed && oldgen_scan_bd == NULL) {
3230 IF_DEBUG(gc, debugBelch("scavenge_mark_stack: starting linear scan"));
3231 mark_stack_overflowed = rtsFalse;
3232 oldgen_scan_bd = oldest_gen->steps[0].blocks;
3233 oldgen_scan = oldgen_scan_bd->start;
3236 if (oldgen_scan_bd) {
3237 // push a new thing on the mark stack
3239 // find a closure that is marked but not scavenged, and start
3241 while (oldgen_scan < oldgen_scan_bd->free
3242 && !is_marked(oldgen_scan,oldgen_scan_bd)) {
3246 if (oldgen_scan < oldgen_scan_bd->free) {
3248 // already scavenged?
3249 if (is_marked(oldgen_scan+1,oldgen_scan_bd)) {
3250 oldgen_scan += sizeofW(StgHeader) + MIN_NONUPD_SIZE;
3253 push_mark_stack(oldgen_scan);
3254 // ToDo: bump the linear scan by the actual size of the object
3255 oldgen_scan += sizeofW(StgHeader) + MIN_NONUPD_SIZE;
3259 oldgen_scan_bd = oldgen_scan_bd->link;
3260 if (oldgen_scan_bd != NULL) {
3261 oldgen_scan = oldgen_scan_bd->start;
3267 /* -----------------------------------------------------------------------------
3268 Scavenge one object.
3270 This is used for objects that are temporarily marked as mutable
3271 because they contain old-to-new generation pointers. Only certain
3272 objects can have this property.
3273 -------------------------------------------------------------------------- */
3276 scavenge_one(StgPtr p)
3278 const StgInfoTable *info;
3279 nat saved_evac_gen = evac_gen;
3282 ASSERT(LOOKS_LIKE_CLOSURE_PTR(p));
3283 info = get_itbl((StgClosure *)p);
3285 switch (info->type) {
3289 StgMVar *mvar = ((StgMVar *)p);
3291 mvar->head = (StgTSO *)evacuate((StgClosure *)mvar->head);
3292 mvar->tail = (StgTSO *)evacuate((StgClosure *)mvar->tail);
3293 mvar->value = evacuate((StgClosure *)mvar->value);
3294 evac_gen = saved_evac_gen;
3295 failed_to_evac = rtsTrue; // mutable.
3308 end = (StgPtr)((StgThunk *)p)->payload + info->layout.payload.ptrs;
3309 for (q = (StgPtr)((StgThunk *)p)->payload; q < end; q++) {
3310 *q = (StgWord)(StgPtr)evacuate((StgClosure *)*q);
3316 case FUN_1_0: // hardly worth specialising these guys
3333 end = (StgPtr)((StgClosure *)p)->payload + info->layout.payload.ptrs;
3334 for (q = (StgPtr)((StgClosure *)p)->payload; q < end; q++) {
3335 *q = (StgWord)(StgPtr)evacuate((StgClosure *)*q);
3342 ((StgMutVar *)p)->var = evacuate(((StgMutVar *)p)->var);
3343 evac_gen = saved_evac_gen;
3344 failed_to_evac = rtsTrue; // mutable anyhow
3348 case SE_CAF_BLACKHOLE:
3353 case THUNK_SELECTOR:
3355 StgSelector *s = (StgSelector *)p;
3356 s->selectee = evacuate(s->selectee);
3362 StgAP_STACK *ap = (StgAP_STACK *)p;
3364 ap->fun = evacuate(ap->fun);
3365 scavenge_stack((StgPtr)ap->payload, (StgPtr)ap->payload + ap->size);
3366 p = (StgPtr)ap->payload + ap->size;
3371 p = scavenge_AP((StgAP *)p);
3375 p = scavenge_PAP((StgPAP *)p);
3379 // nothing to follow
3384 // follow everything
3387 evac_gen = 0; // repeatedly mutable
3388 next = p + mut_arr_ptrs_sizeW((StgMutArrPtrs*)p);
3389 for (p = (P_)((StgMutArrPtrs *)p)->payload; p < next; p++) {
3390 *p = (StgWord)(StgPtr)evacuate((StgClosure *)*p);
3392 evac_gen = saved_evac_gen;
3393 failed_to_evac = rtsTrue;
3397 case MUT_ARR_PTRS_FROZEN:
3398 case MUT_ARR_PTRS_FROZEN0:
3400 // follow everything
3403 next = p + mut_arr_ptrs_sizeW((StgMutArrPtrs*)p);
3404 for (p = (P_)((StgMutArrPtrs *)p)->payload; p < next; p++) {
3405 *p = (StgWord)(StgPtr)evacuate((StgClosure *)*p);
3412 StgTSO *tso = (StgTSO *)p;
3414 evac_gen = 0; // repeatedly mutable
3416 evac_gen = saved_evac_gen;
3417 failed_to_evac = rtsTrue;
3425 nat size, ptrs, nonptrs, vhs;
3427 StgInfoTable *rip = get_closure_info(p, &size, &ptrs, &nonptrs, &vhs, str);
3429 StgRBH *rbh = (StgRBH *)p;
3430 (StgClosure *)rbh->blocking_queue =
3431 evacuate((StgClosure *)rbh->blocking_queue);
3432 failed_to_evac = rtsTrue; // mutable anyhow.
3434 debugBelch("@@ scavenge: RBH %p (%s) (new blocking_queue link=%p)",
3435 p, info_type(p), (StgClosure *)rbh->blocking_queue));
3436 // ToDo: use size of reverted closure here!
3442 StgBlockedFetch *bf = (StgBlockedFetch *)p;
3443 // follow the pointer to the node which is being demanded
3444 (StgClosure *)bf->node =
3445 evacuate((StgClosure *)bf->node);
3446 // follow the link to the rest of the blocking queue
3447 (StgClosure *)bf->link =
3448 evacuate((StgClosure *)bf->link);
3450 debugBelch("@@ scavenge: %p (%s); node is now %p; exciting, isn't it",
3451 bf, info_type((StgClosure *)bf),
3452 bf->node, info_type(bf->node)));
3460 break; // nothing to do in this case
3464 StgFetchMeBlockingQueue *fmbq = (StgFetchMeBlockingQueue *)p;
3465 (StgClosure *)fmbq->blocking_queue =
3466 evacuate((StgClosure *)fmbq->blocking_queue);
3468 debugBelch("@@ scavenge: %p (%s) exciting, isn't it",
3469 p, info_type((StgClosure *)p)));
3474 case TVAR_WAIT_QUEUE:
3476 StgTVarWaitQueue *wq = ((StgTVarWaitQueue *) p);
3478 wq->waiting_tso = (StgTSO *)evacuate((StgClosure*)wq->waiting_tso);
3479 wq->next_queue_entry = (StgTVarWaitQueue *)evacuate((StgClosure*)wq->next_queue_entry);
3480 wq->prev_queue_entry = (StgTVarWaitQueue *)evacuate((StgClosure*)wq->prev_queue_entry);
3481 evac_gen = saved_evac_gen;
3482 failed_to_evac = rtsTrue; // mutable
3488 StgTVar *tvar = ((StgTVar *) p);
3490 tvar->current_value = evacuate((StgClosure*)tvar->current_value);
3491 tvar->first_wait_queue_entry = (StgTVarWaitQueue *)evacuate((StgClosure*)tvar->first_wait_queue_entry);
3492 evac_gen = saved_evac_gen;
3493 failed_to_evac = rtsTrue; // mutable
3499 StgTRecHeader *trec = ((StgTRecHeader *) p);
3501 trec->enclosing_trec = (StgTRecHeader *)evacuate((StgClosure*)trec->enclosing_trec);
3502 trec->current_chunk = (StgTRecChunk *)evacuate((StgClosure*)trec->current_chunk);
3503 evac_gen = saved_evac_gen;
3504 failed_to_evac = rtsTrue; // mutable
3511 StgTRecChunk *tc = ((StgTRecChunk *) p);
3512 TRecEntry *e = &(tc -> entries[0]);
3514 tc->prev_chunk = (StgTRecChunk *)evacuate((StgClosure*)tc->prev_chunk);
3515 for (i = 0; i < tc -> next_entry_idx; i ++, e++ ) {
3516 e->tvar = (StgTVar *)evacuate((StgClosure*)e->tvar);
3517 e->expected_value = evacuate((StgClosure*)e->expected_value);
3518 e->new_value = evacuate((StgClosure*)e->new_value);
3520 evac_gen = saved_evac_gen;
3521 failed_to_evac = rtsTrue; // mutable
3526 case IND_OLDGEN_PERM:
3529 /* Careful here: a THUNK can be on the mutable list because
3530 * it contains pointers to young gen objects. If such a thunk
3531 * is updated, the IND_OLDGEN will be added to the mutable
3532 * list again, and we'll scavenge it twice. evacuate()
3533 * doesn't check whether the object has already been
3534 * evacuated, so we perform that check here.
3536 StgClosure *q = ((StgInd *)p)->indirectee;
3537 if (HEAP_ALLOCED(q) && Bdescr((StgPtr)q)->flags & BF_EVACUATED) {
3540 ((StgInd *)p)->indirectee = evacuate(q);
3543 #if 0 && defined(DEBUG)
3544 if (RtsFlags.DebugFlags.gc)
3545 /* Debugging code to print out the size of the thing we just
3549 StgPtr start = gen->steps[0].scan;
3550 bdescr *start_bd = gen->steps[0].scan_bd;
3552 scavenge(&gen->steps[0]);
3553 if (start_bd != gen->steps[0].scan_bd) {
3554 size += (P_)BLOCK_ROUND_UP(start) - start;
3555 start_bd = start_bd->link;
3556 while (start_bd != gen->steps[0].scan_bd) {
3557 size += BLOCK_SIZE_W;
3558 start_bd = start_bd->link;
3560 size += gen->steps[0].scan -
3561 (P_)BLOCK_ROUND_DOWN(gen->steps[0].scan);
3563 size = gen->steps[0].scan - start;
3565 debugBelch("evac IND_OLDGEN: %ld bytes", size * sizeof(W_));
3571 barf("scavenge_one: strange object %d", (int)(info->type));
3574 no_luck = failed_to_evac;
3575 failed_to_evac = rtsFalse;
3579 /* -----------------------------------------------------------------------------
3580 Scavenging mutable lists.
3582 We treat the mutable list of each generation > N (i.e. all the
3583 generations older than the one being collected) as roots. We also
3584 remove non-mutable objects from the mutable list at this point.
3585 -------------------------------------------------------------------------- */
3588 scavenge_mutable_list(generation *gen)
3593 bd = gen->saved_mut_list;
3596 for (; bd != NULL; bd = bd->link) {
3597 for (q = bd->start; q < bd->free; q++) {
3599 ASSERT(LOOKS_LIKE_CLOSURE_PTR(p));
3600 if (scavenge_one(p)) {
3601 /* didn't manage to promote everything, so put the
3602 * object back on the list.
3604 recordMutableGen((StgClosure *)p,gen);
3609 // free the old mut_list
3610 freeChain(gen->saved_mut_list);
3611 gen->saved_mut_list = NULL;
3616 scavenge_static(void)
3618 StgClosure* p = static_objects;
3619 const StgInfoTable *info;
3621 /* Always evacuate straight to the oldest generation for static
3623 evac_gen = oldest_gen->no;
3625 /* keep going until we've scavenged all the objects on the linked
3627 while (p != END_OF_STATIC_LIST) {
3629 ASSERT(LOOKS_LIKE_CLOSURE_PTR(p));
3632 if (info->type==RBH)
3633 info = REVERT_INFOPTR(info); // if it's an RBH, look at the orig closure
3635 // make sure the info pointer is into text space
3637 /* Take this object *off* the static_objects list,
3638 * and put it on the scavenged_static_objects list.
3640 static_objects = *STATIC_LINK(info,p);
3641 *STATIC_LINK(info,p) = scavenged_static_objects;
3642 scavenged_static_objects = p;
3644 switch (info -> type) {
3648 StgInd *ind = (StgInd *)p;
3649 ind->indirectee = evacuate(ind->indirectee);
3651 /* might fail to evacuate it, in which case we have to pop it
3652 * back on the mutable list of the oldest generation. We
3653 * leave it *on* the scavenged_static_objects list, though,
3654 * in case we visit this object again.
3656 if (failed_to_evac) {
3657 failed_to_evac = rtsFalse;
3658 recordMutableGen((StgClosure *)p,oldest_gen);
3664 scavenge_thunk_srt(info);
3668 scavenge_fun_srt(info);
3675 next = (P_)p->payload + info->layout.payload.ptrs;
3676 // evacuate the pointers
3677 for (q = (P_)p->payload; q < next; q++) {
3678 *q = (StgWord)(StgPtr)evacuate((StgClosure *)*q);
3684 barf("scavenge_static: strange closure %d", (int)(info->type));
3687 ASSERT(failed_to_evac == rtsFalse);
3689 /* get the next static object from the list. Remember, there might
3690 * be more stuff on this list now that we've done some evacuating!
3691 * (static_objects is a global)
3697 /* -----------------------------------------------------------------------------
3698 scavenge a chunk of memory described by a bitmap
3699 -------------------------------------------------------------------------- */
3702 scavenge_large_bitmap( StgPtr p, StgLargeBitmap *large_bitmap, nat size )
3708 bitmap = large_bitmap->bitmap[b];
3709 for (i = 0; i < size; ) {
3710 if ((bitmap & 1) == 0) {
3711 *p = (StgWord)(StgPtr)evacuate((StgClosure *)*p);
3715 if (i % BITS_IN(W_) == 0) {
3717 bitmap = large_bitmap->bitmap[b];
3719 bitmap = bitmap >> 1;
3724 STATIC_INLINE StgPtr
3725 scavenge_small_bitmap (StgPtr p, nat size, StgWord bitmap)
3728 if ((bitmap & 1) == 0) {
3729 *p = (StgWord)(StgPtr)evacuate((StgClosure *)*p);
3732 bitmap = bitmap >> 1;
3738 /* -----------------------------------------------------------------------------
3739 scavenge_stack walks over a section of stack and evacuates all the
3740 objects pointed to by it. We can use the same code for walking
3741 AP_STACK_UPDs, since these are just sections of copied stack.
3742 -------------------------------------------------------------------------- */
3746 scavenge_stack(StgPtr p, StgPtr stack_end)
3748 const StgRetInfoTable* info;
3752 //IF_DEBUG(sanity, debugBelch(" scavenging stack between %p and %p", p, stack_end));
3755 * Each time around this loop, we are looking at a chunk of stack
3756 * that starts with an activation record.
3759 while (p < stack_end) {
3760 info = get_ret_itbl((StgClosure *)p);
3762 switch (info->i.type) {
3765 ((StgUpdateFrame *)p)->updatee
3766 = evacuate(((StgUpdateFrame *)p)->updatee);
3767 p += sizeofW(StgUpdateFrame);
3770 // small bitmap (< 32 entries, or 64 on a 64-bit machine)
3771 case CATCH_STM_FRAME:
3772 case CATCH_RETRY_FRAME:
3773 case ATOMICALLY_FRAME:
3778 bitmap = BITMAP_BITS(info->i.layout.bitmap);
3779 size = BITMAP_SIZE(info->i.layout.bitmap);
3780 // NOTE: the payload starts immediately after the info-ptr, we
3781 // don't have an StgHeader in the same sense as a heap closure.
3783 p = scavenge_small_bitmap(p, size, bitmap);
3786 scavenge_srt((StgClosure **)GET_SRT(info), info->i.srt_bitmap);
3794 *p = (StgWord)(StgPtr)evacuate((StgClosure *)*p);
3797 size = BCO_BITMAP_SIZE(bco);
3798 scavenge_large_bitmap(p, BCO_BITMAP(bco), size);
3803 // large bitmap (> 32 entries, or > 64 on a 64-bit machine)
3809 size = GET_LARGE_BITMAP(&info->i)->size;
3811 scavenge_large_bitmap(p, GET_LARGE_BITMAP(&info->i), size);
3813 // and don't forget to follow the SRT
3817 // Dynamic bitmap: the mask is stored on the stack, and
3818 // there are a number of non-pointers followed by a number
3819 // of pointers above the bitmapped area. (see StgMacros.h,
3824 dyn = ((StgRetDyn *)p)->liveness;
3826 // traverse the bitmap first
3827 bitmap = RET_DYN_LIVENESS(dyn);
3828 p = (P_)&((StgRetDyn *)p)->payload[0];
3829 size = RET_DYN_BITMAP_SIZE;
3830 p = scavenge_small_bitmap(p, size, bitmap);
3832 // skip over the non-ptr words
3833 p += RET_DYN_NONPTRS(dyn) + RET_DYN_NONPTR_REGS_SIZE;
3835 // follow the ptr words
3836 for (size = RET_DYN_PTRS(dyn); size > 0; size--) {
3837 *p = (StgWord)(StgPtr)evacuate((StgClosure *)*p);
3845 StgRetFun *ret_fun = (StgRetFun *)p;
3846 StgFunInfoTable *fun_info;
3848 ret_fun->fun = evacuate(ret_fun->fun);
3849 fun_info = get_fun_itbl(ret_fun->fun);
3850 p = scavenge_arg_block(fun_info, ret_fun->payload);
3855 barf("scavenge_stack: weird activation record found on stack: %d", (int)(info->i.type));
3860 /*-----------------------------------------------------------------------------
3861 scavenge the large object list.
3863 evac_gen set by caller; similar games played with evac_gen as with
3864 scavenge() - see comment at the top of scavenge(). Most large
3865 objects are (repeatedly) mutable, so most of the time evac_gen will
3867 --------------------------------------------------------------------------- */
3870 scavenge_large(step *stp)
3875 bd = stp->new_large_objects;
3877 for (; bd != NULL; bd = stp->new_large_objects) {
3879 /* take this object *off* the large objects list and put it on
3880 * the scavenged large objects list. This is so that we can
3881 * treat new_large_objects as a stack and push new objects on
3882 * the front when evacuating.
3884 stp->new_large_objects = bd->link;
3885 dbl_link_onto(bd, &stp->scavenged_large_objects);
3887 // update the block count in this step.
3888 stp->n_scavenged_large_blocks += bd->blocks;
3891 if (scavenge_one(p)) {
3892 recordMutableGen((StgClosure *)p, stp->gen);
3897 /* -----------------------------------------------------------------------------
3898 Initialising the static object & mutable lists
3899 -------------------------------------------------------------------------- */
3902 zero_static_object_list(StgClosure* first_static)
3906 const StgInfoTable *info;
3908 for (p = first_static; p != END_OF_STATIC_LIST; p = link) {
3910 link = *STATIC_LINK(info, p);
3911 *STATIC_LINK(info,p) = NULL;
3915 /* -----------------------------------------------------------------------------
3917 -------------------------------------------------------------------------- */
3924 for (c = (StgIndStatic *)revertible_caf_list; c != NULL;
3925 c = (StgIndStatic *)c->static_link)
3927 SET_INFO(c, c->saved_info);
3928 c->saved_info = NULL;
3929 // could, but not necessary: c->static_link = NULL;
3931 revertible_caf_list = NULL;
3935 markCAFs( evac_fn evac )
3939 for (c = (StgIndStatic *)caf_list; c != NULL;
3940 c = (StgIndStatic *)c->static_link)
3942 evac(&c->indirectee);
3944 for (c = (StgIndStatic *)revertible_caf_list; c != NULL;
3945 c = (StgIndStatic *)c->static_link)
3947 evac(&c->indirectee);
3951 /* -----------------------------------------------------------------------------
3952 Sanity code for CAF garbage collection.
3954 With DEBUG turned on, we manage a CAF list in addition to the SRT
3955 mechanism. After GC, we run down the CAF list and blackhole any
3956 CAFs which have been garbage collected. This means we get an error
3957 whenever the program tries to enter a garbage collected CAF.
3959 Any garbage collected CAFs are taken off the CAF list at the same
3961 -------------------------------------------------------------------------- */
3963 #if 0 && defined(DEBUG)
3970 const StgInfoTable *info;
3981 ASSERT(info->type == IND_STATIC);
3983 if (STATIC_LINK(info,p) == NULL) {
3984 IF_DEBUG(gccafs, debugBelch("CAF gc'd at 0x%04lx", (long)p));
3986 SET_INFO(p,&stg_BLACKHOLE_info);
3987 p = STATIC_LINK2(info,p);
3991 pp = &STATIC_LINK2(info,p);
3998 // debugBelch("%d CAFs live", i);
4003 /* -----------------------------------------------------------------------------
4006 Whenever a thread returns to the scheduler after possibly doing
4007 some work, we have to run down the stack and black-hole all the
4008 closures referred to by update frames.
4009 -------------------------------------------------------------------------- */
4012 threadLazyBlackHole(StgTSO *tso)
4015 StgRetInfoTable *info;
4019 stack_end = &tso->stack[tso->stack_size];
4021 frame = (StgClosure *)tso->sp;
4024 info = get_ret_itbl(frame);
4026 switch (info->i.type) {
4029 bh = ((StgUpdateFrame *)frame)->updatee;
4031 /* if the thunk is already blackholed, it means we've also
4032 * already blackholed the rest of the thunks on this stack,
4033 * so we can stop early.
4035 * The blackhole made for a CAF is a CAF_BLACKHOLE, so they
4036 * don't interfere with this optimisation.
4038 if (bh->header.info == &stg_BLACKHOLE_info) {
4042 if (bh->header.info != &stg_CAF_BLACKHOLE_info) {
4043 #if (!defined(LAZY_BLACKHOLING)) && defined(DEBUG)
4044 debugBelch("Unexpected lazy BHing required at 0x%04x\n",(int)bh);
4048 // We pretend that bh is now dead.
4049 LDV_recordDead_FILL_SLOP_DYNAMIC((StgClosure *)bh);
4051 SET_INFO(bh,&stg_BLACKHOLE_info);
4053 // We pretend that bh has just been created.
4054 LDV_RECORD_CREATE(bh);
4057 frame = (StgClosure *) ((StgUpdateFrame *)frame + 1);
4063 // normal stack frames; do nothing except advance the pointer
4065 frame = (StgClosure *)((StgPtr)frame + stack_frame_sizeW(frame));
4071 /* -----------------------------------------------------------------------------
4074 * Code largely pinched from old RTS, then hacked to bits. We also do
4075 * lazy black holing here.
4077 * -------------------------------------------------------------------------- */
4079 struct stack_gap { StgWord gap_size; struct stack_gap *next_gap; };
4082 threadSqueezeStack(StgTSO *tso)
4085 rtsBool prev_was_update_frame;
4086 StgClosure *updatee = NULL;
4088 StgRetInfoTable *info;
4089 StgWord current_gap_size;
4090 struct stack_gap *gap;
4093 // Traverse the stack upwards, replacing adjacent update frames
4094 // with a single update frame and a "stack gap". A stack gap
4095 // contains two values: the size of the gap, and the distance
4096 // to the next gap (or the stack top).
4098 bottom = &(tso->stack[tso->stack_size]);
4102 ASSERT(frame < bottom);
4104 prev_was_update_frame = rtsFalse;
4105 current_gap_size = 0;
4106 gap = (struct stack_gap *) (tso->sp - sizeofW(StgUpdateFrame));
4108 while (frame < bottom) {
4110 info = get_ret_itbl((StgClosure *)frame);
4111 switch (info->i.type) {
4115 StgUpdateFrame *upd = (StgUpdateFrame *)frame;
4117 if (upd->updatee->header.info == &stg_BLACKHOLE_info) {
4119 // found a BLACKHOLE'd update frame; we've been here
4120 // before, in a previous GC, so just break out.
4122 // Mark the end of the gap, if we're in one.
4123 if (current_gap_size != 0) {
4124 gap = (struct stack_gap *)(frame-sizeofW(StgUpdateFrame));
4127 frame += sizeofW(StgUpdateFrame);
4128 goto done_traversing;
4131 if (prev_was_update_frame) {
4133 TICK_UPD_SQUEEZED();
4134 /* wasn't there something about update squeezing and ticky to be
4135 * sorted out? oh yes: we aren't counting each enter properly
4136 * in this case. See the log somewhere. KSW 1999-04-21
4138 * Check two things: that the two update frames don't point to
4139 * the same object, and that the updatee_bypass isn't already an
4140 * indirection. Both of these cases only happen when we're in a
4141 * block hole-style loop (and there are multiple update frames
4142 * on the stack pointing to the same closure), but they can both
4143 * screw us up if we don't check.
4145 if (upd->updatee != updatee && !closure_IND(upd->updatee)) {
4146 UPD_IND_NOLOCK(upd->updatee, updatee);
4149 // now mark this update frame as a stack gap. The gap
4150 // marker resides in the bottom-most update frame of
4151 // the series of adjacent frames, and covers all the
4152 // frames in this series.
4153 current_gap_size += sizeofW(StgUpdateFrame);
4154 ((struct stack_gap *)frame)->gap_size = current_gap_size;
4155 ((struct stack_gap *)frame)->next_gap = gap;
4157 frame += sizeofW(StgUpdateFrame);
4161 // single update frame, or the topmost update frame in a series
4163 StgClosure *bh = upd->updatee;
4165 // Do lazy black-holing
4166 if (bh->header.info != &stg_BLACKHOLE_info &&
4167 bh->header.info != &stg_CAF_BLACKHOLE_info) {
4168 #if (!defined(LAZY_BLACKHOLING)) && defined(DEBUG)
4169 debugBelch("Unexpected lazy BHing required at 0x%04x",(int)bh);
4172 /* zero out the slop so that the sanity checker can tell
4173 * where the next closure is.
4176 StgInfoTable *bh_info = get_itbl(bh);
4177 nat np = bh_info->layout.payload.ptrs,
4178 nw = bh_info->layout.payload.nptrs, i;
4179 /* don't zero out slop for a THUNK_SELECTOR,
4180 * because its layout info is used for a
4181 * different purpose, and it's exactly the
4182 * same size as a BLACKHOLE in any case.
4184 if (bh_info->type != THUNK_SELECTOR) {
4185 for (i = 0; i < np + nw; i++) {
4186 ((StgClosure *)bh)->payload[i] = INVALID_OBJECT;
4192 // We pretend that bh is now dead.
4193 LDV_recordDead_FILL_SLOP_DYNAMIC((StgClosure *)bh);
4195 // Todo: maybe use SET_HDR() and remove LDV_RECORD_CREATE()?
4196 SET_INFO(bh,&stg_BLACKHOLE_info);
4198 // We pretend that bh has just been created.
4199 LDV_RECORD_CREATE(bh);
4202 prev_was_update_frame = rtsTrue;
4203 updatee = upd->updatee;
4204 frame += sizeofW(StgUpdateFrame);
4210 prev_was_update_frame = rtsFalse;
4212 // we're not in a gap... check whether this is the end of a gap
4213 // (an update frame can't be the end of a gap).
4214 if (current_gap_size != 0) {
4215 gap = (struct stack_gap *) (frame - sizeofW(StgUpdateFrame));
4217 current_gap_size = 0;
4219 frame += stack_frame_sizeW((StgClosure *)frame);
4226 // Now we have a stack with gaps in it, and we have to walk down
4227 // shoving the stack up to fill in the gaps. A diagram might
4231 // | ********* | <- sp
4235 // | stack_gap | <- gap | chunk_size
4237 // | ......... | <- gap_end v
4243 // 'sp' points the the current top-of-stack
4244 // 'gap' points to the stack_gap structure inside the gap
4245 // ***** indicates real stack data
4246 // ..... indicates gap
4247 // <empty> indicates unused
4251 void *gap_start, *next_gap_start, *gap_end;
4254 next_gap_start = (void *)((unsigned char*)gap + sizeof(StgUpdateFrame));
4255 sp = next_gap_start;
4257 while ((StgPtr)gap > tso->sp) {
4259 // we're working in *bytes* now...
4260 gap_start = next_gap_start;
4261 gap_end = (void*) ((unsigned char*)gap_start - gap->gap_size * sizeof(W_));
4263 gap = gap->next_gap;
4264 next_gap_start = (void *)((unsigned char*)gap + sizeof(StgUpdateFrame));
4266 chunk_size = (unsigned char*)gap_end - (unsigned char*)next_gap_start;
4268 memmove(sp, next_gap_start, chunk_size);
4271 tso->sp = (StgPtr)sp;
4275 /* -----------------------------------------------------------------------------
4278 * We have to prepare for GC - this means doing lazy black holing
4279 * here. We also take the opportunity to do stack squeezing if it's
4281 * -------------------------------------------------------------------------- */
4283 threadPaused(StgTSO *tso)
4285 if ( RtsFlags.GcFlags.squeezeUpdFrames == rtsTrue )
4286 threadSqueezeStack(tso); // does black holing too
4288 threadLazyBlackHole(tso);
4291 /* -----------------------------------------------------------------------------
4293 * -------------------------------------------------------------------------- */
4297 printMutableList(generation *gen)
4302 debugBelch("@@ Mutable list %p: ", gen->mut_list);
4304 for (bd = gen->mut_list; bd != NULL; bd = bd->link) {
4305 for (p = bd->start; p < bd->free; p++) {
4306 debugBelch("%p (%s), ", (void *)*p, info_type((StgClosure *)*p));