1 /* -----------------------------------------------------------------------------
3 * (c) The GHC Team, 2001
6 * Lag/Drag/Void profiling.
8 * ---------------------------------------------------------------------------*/
13 #include "LdvProfile.h"
15 #include "Profiling.h"
20 /* --------------------------------------------------------------------------
21 * Fills in the slop when a *dynamic* closure changes its type.
22 * First calls LDV_recordDead() to declare the closure is dead, and then
26 * 1) blackholing, UPD_BH_UPDATABLE() and UPD_BH_SINGLE_ENTRY (in
27 * includes/StgMacros.h), threadLazyBlackHole() and
28 * threadSqueezeStack() (in GC.c).
29 * 2) updating with indirection closures, updateWithIndirection()
30 * and updateWithPermIndirection() (in Storage.h).
32 * LDV_recordDead_FILL_SLOP_DYNAMIC() is not called on 'inherently used'
33 * closures such as TSO. It is not called on PAP because PAP is not updatable.
34 * ----------------------------------------------------------------------- */
36 LDV_recordDead_FILL_SLOP_DYNAMIC( StgClosure *p )
40 #if defined(__GNUC__) && __GNUC__ < 3 && defined(DEBUG)
41 #error Please use gcc 3.0+ to compile this file with DEBUG; gcc < 3.0 miscompiles it
45 // very like FILL_SLOP(), except that we call LDV_recordDead().
46 size = closure_sizeW(p);
48 LDV_recordDead((StgClosure *)(p), size);
50 if (size > sizeofW(StgThunkHeader)) {
51 for (i = 0; i < size - sizeofW(StgThunkHeader); i++) {
52 ((StgThunk *)(p))->payload[i] = 0;
58 /* --------------------------------------------------------------------------
59 * This function is called eventually on every object destroyed during
60 * a garbage collection, whether it is a major garbage collection or
61 * not. If c is an 'inherently used' closure, nothing happens. If c
62 * is an ordinary closure, LDV_recordDead() is called on c with its
63 * proper size which excludes the profiling header portion in the
64 * closure. Returns the size of the closure, including the profiling
65 * header portion, so that the caller can find the next closure.
66 * ----------------------------------------------------------------------- */
68 processHeapClosureForDead( StgClosure *c )
75 if (info->type != EVACUATED) {
76 ASSERT(((LDVW(c) & LDV_CREATE_MASK) >> LDV_SHIFT) <= era &&
77 ((LDVW(c) & LDV_CREATE_MASK) >> LDV_SHIFT) > 0);
78 ASSERT(((LDVW(c) & LDV_STATE_MASK) == LDV_STATE_CREATE) ||
80 (LDVW(c) & LDV_LAST_MASK) <= era &&
81 (LDVW(c) & LDV_LAST_MASK) > 0
85 if (info->type == EVACUATED) {
86 // The size of the evacuated closure is currently stored in
87 // the LDV field. See SET_EVACUAEE_FOR_LDV() in
88 // includes/StgLdvProf.h.
92 size = closure_sizeW(c);
96 'inherently used' cases: do nothing.
101 case MUT_ARR_PTRS_CLEAN:
102 case MUT_ARR_PTRS_DIRTY:
103 case MUT_ARR_PTRS_FROZEN:
104 case MUT_ARR_PTRS_FROZEN0:
111 case TVAR_WATCH_QUEUE:
115 case INVARIANT_CHECK_QUEUE:
116 case ATOMIC_INVARIANT:
120 ordinary cases: call LDV_recordDead().
147 case SE_CAF_BLACKHOLE:
149 case IND_OLDGEN_PERM:
153 // Why can we ignore IND/IND_OLDGEN closures? We assume that
154 // any census is preceded by a major garbage collection, which
155 // IND/IND_OLDGEN closures cannot survive. Therefore, it is no
156 // use considering IND/IND_OLDGEN closures in the meanwhile
157 // because they will perish before the next census at any
161 // Found a dead closure: record its size
162 LDV_recordDead(c, size);
173 case CONSTR_NOCAF_STATIC:
190 barf("Invalid object in processHeapClosureForDead(): %d", info->type);
195 /* --------------------------------------------------------------------------
196 * Calls processHeapClosureForDead() on every *dead* closures in the
197 * heap blocks starting at bd.
198 * ----------------------------------------------------------------------- */
200 processHeapForDead( bdescr *bd )
206 while (p < bd->free) {
207 p += processHeapClosureForDead((StgClosure *)p);
208 while (p < bd->free && !*p) // skip slop
211 ASSERT(p == bd->free);
216 /* --------------------------------------------------------------------------
217 * Calls processHeapClosureForDead() on every *dead* closures in the nursery.
218 * ----------------------------------------------------------------------- */
220 processNurseryForDead( void )
225 bd = MainCapability.r.rNursery->blocks;
226 while (bd->start < bd->free) {
228 bdLimit = bd->start + BLOCK_SIZE_W;
229 while (p < bd->free && p < bdLimit) {
230 p += processHeapClosureForDead((StgClosure *)p);
231 while (p < bd->free && p < bdLimit && !*p) // skip slop
240 /* --------------------------------------------------------------------------
241 * Calls processHeapClosureForDead() on every *dead* closures in the
243 * ----------------------------------------------------------------------- */
245 processSmallObjectPoolForDead( void )
250 for (bd = g0s0->blocks; bd != NULL; bd = bd->link) {
252 while (p < bd->free) {
253 p += processHeapClosureForDead((StgClosure *)p);
254 while (p < bd->free && !*p) // skip slop
257 ASSERT(p == bd->free);
261 /* --------------------------------------------------------------------------
262 * Calls processHeapClosureForDead() on every *dead* closures in the closure
264 * ----------------------------------------------------------------------- */
266 processChainForDead( bdescr *bd )
268 // Any object still in the chain is dead!
270 processHeapClosureForDead((StgClosure *)bd->start);
275 /* --------------------------------------------------------------------------
276 * Start a census for *dead* closures, and calls
277 * processHeapClosureForDead() on every closure which died in the
278 * current garbage collection. This function is called from a garbage
279 * collector right before tidying up, when all dead closures are still
280 * stored in the heap and easy to identify. Generations 0 through N
281 * have just beed garbage collected.
282 * ----------------------------------------------------------------------- */
284 LdvCensusForDead( nat N )
288 // ldvTime == 0 means that LDV profiling is currently turned off.
292 if (RtsFlags.GcFlags.generations == 1) {
294 // Todo: support LDV for two-space garbage collection.
296 barf("Lag/Drag/Void profiling not supported with -G1");
298 for (g = 0; g <= N; g++)
299 for (s = 0; s < generations[g].n_steps; s++) {
300 if (g == 0 && s == 0) {
301 processSmallObjectPoolForDead();
302 processNurseryForDead();
303 processChainForDead(generations[g].steps[s].large_objects);
305 processHeapForDead(generations[g].steps[s].old_blocks);
306 processChainForDead(generations[g].steps[s].large_objects);
312 /* --------------------------------------------------------------------------
313 * Regard any closure in the current heap as dead or moribund and update
314 * LDV statistics accordingly.
315 * Called from shutdownHaskell() in RtsStartup.c.
316 * Also, stops LDV profiling by resetting ldvTime to 0.
317 * ----------------------------------------------------------------------- */
319 LdvCensusKillAll( void )
321 LdvCensusForDead(RtsFlags.GcFlags.generations - 1);
324 #endif /* PROFILING */