1 /* -----------------------------------------------------------------------------
3 * (c) The GHC Team 1998-2006
5 * Generational garbage collector: scavenging functions
7 * Documentation on the architecture of the Garbage Collector can be
8 * found in the online commentary:
10 * http://hackage.haskell.org/trac/ghc/wiki/Commentary/Rts/Storage/GC
12 * ---------------------------------------------------------------------------*/
14 // This file is #included into Scav.c, twice: firstly with MINOR_GC
15 // defined, the second time without.
18 #define scavenge_block(a,b) scavenge_block0(a,b)
19 #define evacuate(a) evacuate0(a)
25 static void scavenge_block (bdescr *bd, StgPtr scan);
27 /* -----------------------------------------------------------------------------
28 Scavenge a block from the given scan pointer up to bd->free.
30 evac_step is set by the caller to be either zero (for a step in a
31 generation < N) or G where G is the generation of the step being
34 We sometimes temporarily change evac_step back to zero if we're
35 scavenging a mutable object where eager promotion isn't such a good
37 -------------------------------------------------------------------------- */
40 scavenge_block (bdescr *bd, StgPtr scan)
44 step *saved_evac_step;
45 rtsBool saved_eager_promotion;
49 debugTrace(DEBUG_gc, "scavenging block %p (gen %d, step %d) @ %p",
50 bd->start, bd->gen_no, bd->step->no, scan);
52 gct->evac_step = bd->step;
53 saved_evac_step = gct->evac_step;
54 saved_eager_promotion = gct->eager_promotion;
55 gct->failed_to_evac = rtsFalse;
57 // we might be evacuating into the very object that we're
58 // scavenging, so we have to check the real bd->free pointer each
59 // time around the loop.
60 while (p < bd->free) {
62 ASSERT(LOOKS_LIKE_CLOSURE_PTR(p));
63 info = get_itbl((StgClosure *)p);
65 ASSERT(gct->thunk_selector_depth == 0);
73 StgMVar *mvar = ((StgMVar *)p);
74 gct->eager_promotion = rtsFalse;
75 evacuate((StgClosure **)&mvar->head);
76 evacuate((StgClosure **)&mvar->tail);
77 evacuate((StgClosure **)&mvar->value);
78 gct->eager_promotion = saved_eager_promotion;
80 if (gct->failed_to_evac) {
81 mvar->header.info = &stg_MVAR_DIRTY_info;
83 mvar->header.info = &stg_MVAR_CLEAN_info;
85 p += sizeofW(StgMVar);
91 scavenge_fun_srt(info);
93 evacuate(&((StgClosure *)p)->payload[1]);
94 evacuate(&((StgClosure *)p)->payload[0]);
95 p += sizeofW(StgHeader) + 2;
100 scavenge_thunk_srt(info);
102 evacuate(&((StgThunk *)p)->payload[1]);
103 evacuate(&((StgThunk *)p)->payload[0]);
104 p += sizeofW(StgThunk) + 2;
108 evacuate(&((StgClosure *)p)->payload[1]);
109 evacuate(&((StgClosure *)p)->payload[0]);
110 p += sizeofW(StgHeader) + 2;
115 scavenge_thunk_srt(info);
117 evacuate(&((StgThunk *)p)->payload[0]);
118 p += sizeofW(StgThunk) + 1;
123 scavenge_fun_srt(info);
126 evacuate(&((StgClosure *)p)->payload[0]);
127 p += sizeofW(StgHeader) + 1;
132 scavenge_thunk_srt(info);
134 p += sizeofW(StgThunk) + 1;
139 scavenge_fun_srt(info);
142 p += sizeofW(StgHeader) + 1;
147 scavenge_thunk_srt(info);
149 p += sizeofW(StgThunk) + 2;
154 scavenge_fun_srt(info);
157 p += sizeofW(StgHeader) + 2;
162 scavenge_thunk_srt(info);
164 evacuate(&((StgThunk *)p)->payload[0]);
165 p += sizeofW(StgThunk) + 2;
170 scavenge_fun_srt(info);
173 evacuate(&((StgClosure *)p)->payload[0]);
174 p += sizeofW(StgHeader) + 2;
179 scavenge_fun_srt(info);
188 scavenge_thunk_srt(info);
190 end = (P_)((StgThunk *)p)->payload + info->layout.payload.ptrs;
191 for (p = (P_)((StgThunk *)p)->payload; p < end; p++) {
192 evacuate((StgClosure **)p);
194 p += info->layout.payload.nptrs;
205 end = (P_)((StgClosure *)p)->payload + info->layout.payload.ptrs;
206 for (p = (P_)((StgClosure *)p)->payload; p < end; p++) {
207 evacuate((StgClosure **)p);
209 p += info->layout.payload.nptrs;
214 StgBCO *bco = (StgBCO *)p;
215 evacuate((StgClosure **)&bco->instrs);
216 evacuate((StgClosure **)&bco->literals);
217 evacuate((StgClosure **)&bco->ptrs);
223 if (bd->gen_no != 0) {
226 // No need to call LDV_recordDead_FILL_SLOP_DYNAMIC() because an
227 // IND_OLDGEN_PERM closure is larger than an IND_PERM closure.
228 LDV_recordDead((StgClosure *)p, sizeofW(StgInd));
231 // Todo: maybe use SET_HDR() and remove LDV_RECORD_CREATE()?
233 SET_INFO(((StgClosure *)p), &stg_IND_OLDGEN_PERM_info);
235 // We pretend that p has just been created.
236 LDV_RECORD_CREATE((StgClosure *)p);
239 case IND_OLDGEN_PERM:
240 evacuate(&((StgInd *)p)->indirectee);
241 p += sizeofW(StgInd);
246 gct->eager_promotion = rtsFalse;
247 evacuate(&((StgMutVar *)p)->var);
248 gct->eager_promotion = saved_eager_promotion;
250 if (gct->failed_to_evac) {
251 ((StgClosure *)q)->header.info = &stg_MUT_VAR_DIRTY_info;
253 ((StgClosure *)q)->header.info = &stg_MUT_VAR_CLEAN_info;
255 p += sizeofW(StgMutVar);
259 case SE_CAF_BLACKHOLE:
262 p += BLACKHOLE_sizeW();
267 StgSelector *s = (StgSelector *)p;
268 evacuate(&s->selectee);
269 p += THUNK_SELECTOR_sizeW();
273 // A chunk of stack saved in a heap object
276 StgAP_STACK *ap = (StgAP_STACK *)p;
279 scavenge_stack((StgPtr)ap->payload, (StgPtr)ap->payload + ap->size);
280 p = (StgPtr)ap->payload + ap->size;
285 p = scavenge_PAP((StgPAP *)p);
289 p = scavenge_AP((StgAP *)p);
294 p += arr_words_sizeW((StgArrWords *)p);
297 case MUT_ARR_PTRS_CLEAN:
298 case MUT_ARR_PTRS_DIRTY:
303 // We don't eagerly promote objects pointed to by a mutable
304 // array, but if we find the array only points to objects in
305 // the same or an older generation, we mark it "clean" and
306 // avoid traversing it during minor GCs.
307 gct->eager_promotion = rtsFalse;
308 next = p + mut_arr_ptrs_sizeW((StgMutArrPtrs*)p);
309 for (p = (P_)((StgMutArrPtrs *)p)->payload; p < next; p++) {
310 evacuate((StgClosure **)p);
312 gct->eager_promotion = saved_eager_promotion;
314 if (gct->failed_to_evac) {
315 ((StgClosure *)q)->header.info = &stg_MUT_ARR_PTRS_DIRTY_info;
317 ((StgClosure *)q)->header.info = &stg_MUT_ARR_PTRS_CLEAN_info;
320 gct->failed_to_evac = rtsTrue; // always put it on the mutable list.
324 case MUT_ARR_PTRS_FROZEN:
325 case MUT_ARR_PTRS_FROZEN0:
330 next = p + mut_arr_ptrs_sizeW((StgMutArrPtrs*)p);
331 for (p = (P_)((StgMutArrPtrs *)p)->payload; p < next; p++) {
332 evacuate((StgClosure **)p);
335 // If we're going to put this object on the mutable list, then
336 // set its info ptr to MUT_ARR_PTRS_FROZEN0 to indicate that.
337 if (gct->failed_to_evac) {
338 ((StgClosure *)q)->header.info = &stg_MUT_ARR_PTRS_FROZEN0_info;
340 ((StgClosure *)q)->header.info = &stg_MUT_ARR_PTRS_FROZEN_info;
347 StgTSO *tso = (StgTSO *)p;
349 gct->eager_promotion = rtsFalse;
351 gct->eager_promotion = saved_eager_promotion;
353 if (gct->failed_to_evac) {
354 tso->flags |= TSO_DIRTY;
356 tso->flags &= ~TSO_DIRTY;
359 gct->failed_to_evac = rtsTrue; // always on the mutable list
364 case TVAR_WATCH_QUEUE:
366 StgTVarWatchQueue *wq = ((StgTVarWatchQueue *) p);
368 evacuate((StgClosure **)&wq->closure);
369 evacuate((StgClosure **)&wq->next_queue_entry);
370 evacuate((StgClosure **)&wq->prev_queue_entry);
371 gct->evac_step = saved_evac_step;
372 gct->failed_to_evac = rtsTrue; // mutable
373 p += sizeofW(StgTVarWatchQueue);
379 StgTVar *tvar = ((StgTVar *) p);
381 evacuate((StgClosure **)&tvar->current_value);
382 evacuate((StgClosure **)&tvar->first_watch_queue_entry);
383 gct->evac_step = saved_evac_step;
384 gct->failed_to_evac = rtsTrue; // mutable
385 p += sizeofW(StgTVar);
391 StgTRecHeader *trec = ((StgTRecHeader *) p);
393 evacuate((StgClosure **)&trec->enclosing_trec);
394 evacuate((StgClosure **)&trec->current_chunk);
395 evacuate((StgClosure **)&trec->invariants_to_check);
396 gct->evac_step = saved_evac_step;
397 gct->failed_to_evac = rtsTrue; // mutable
398 p += sizeofW(StgTRecHeader);
405 StgTRecChunk *tc = ((StgTRecChunk *) p);
406 TRecEntry *e = &(tc -> entries[0]);
408 evacuate((StgClosure **)&tc->prev_chunk);
409 for (i = 0; i < tc -> next_entry_idx; i ++, e++ ) {
410 evacuate((StgClosure **)&e->tvar);
411 evacuate((StgClosure **)&e->expected_value);
412 evacuate((StgClosure **)&e->new_value);
414 gct->evac_step = saved_evac_step;
415 gct->failed_to_evac = rtsTrue; // mutable
416 p += sizeofW(StgTRecChunk);
420 case ATOMIC_INVARIANT:
422 StgAtomicInvariant *invariant = ((StgAtomicInvariant *) p);
424 evacuate(&invariant->code);
425 evacuate((StgClosure **)&invariant->last_execution);
426 gct->evac_step = saved_evac_step;
427 gct->failed_to_evac = rtsTrue; // mutable
428 p += sizeofW(StgAtomicInvariant);
432 case INVARIANT_CHECK_QUEUE:
434 StgInvariantCheckQueue *queue = ((StgInvariantCheckQueue *) p);
436 evacuate((StgClosure **)&queue->invariant);
437 evacuate((StgClosure **)&queue->my_execution);
438 evacuate((StgClosure **)&queue->next_queue_entry);
439 gct->evac_step = saved_evac_step;
440 gct->failed_to_evac = rtsTrue; // mutable
441 p += sizeofW(StgInvariantCheckQueue);
446 barf("scavenge: unimplemented/strange closure type %d @ %p",
451 * We need to record the current object on the mutable list if
452 * (a) It is actually mutable, or
453 * (b) It contains pointers to a younger generation.
454 * Case (b) arises if we didn't manage to promote everything that
455 * the current object points to into the current generation.
457 if (gct->failed_to_evac) {
458 gct->failed_to_evac = rtsFalse;
459 if (bd->gen_no > 0) {
460 recordMutableGen_GC((StgClosure *)q, &generations[bd->gen_no]);
465 debugTrace(DEBUG_gc, " scavenged %ld bytes",
466 (unsigned long)((bd->free - scan) * sizeof(W_)));