1 /* -----------------------------------------------------------------------------
3 * (c) The GHC Team, 2001
6 * Lag/Drag/Void profiling.
8 * ---------------------------------------------------------------------------*/
13 #include "LdvProfile.h"
15 #include "Profiling.h"
21 /* --------------------------------------------------------------------------
22 * Fills in the slop when a *dynamic* closure changes its type.
23 * First calls LDV_recordDead() to declare the closure is dead, and then
27 * 1) blackholing, UPD_BH_UPDATABLE() and UPD_BH_SINGLE_ENTRY (in
28 * includes/StgMacros.h), threadLazyBlackHole() and
29 * threadSqueezeStack() (in GC.c).
30 * 2) updating with indirection closures, updateWithIndirection()
31 * and updateWithPermIndirection() (in Storage.h).
33 * LDV_recordDead_FILL_SLOP_DYNAMIC() is not called on 'inherently used'
34 * closures such as TSO. It is not called on PAP because PAP is not updatable.
35 * ----------------------------------------------------------------------- */
37 LDV_recordDead_FILL_SLOP_DYNAMIC( StgClosure *p )
41 #if defined(__GNUC__) && __GNUC__ < 3 && defined(DEBUG)
42 #error Please use gcc 3.0+ to compile this file with DEBUG; gcc < 3.0 miscompiles it
46 // very like FILL_SLOP(), except that we call LDV_recordDead().
47 size = closure_sizeW(p);
49 LDV_recordDead((StgClosure *)(p), size);
51 if (size > sizeofW(StgThunkHeader)) {
52 for (i = 0; i < size - sizeofW(StgThunkHeader); i++) {
53 ((StgThunk *)(p))->payload[i] = 0;
59 /* --------------------------------------------------------------------------
60 * This function is called eventually on every object destroyed during
61 * a garbage collection, whether it is a major garbage collection or
62 * not. If c is an 'inherently used' closure, nothing happens. If c
63 * is an ordinary closure, LDV_recordDead() is called on c with its
64 * proper size which excludes the profiling header portion in the
65 * closure. Returns the size of the closure, including the profiling
66 * header portion, so that the caller can find the next closure.
67 * ----------------------------------------------------------------------- */
69 processHeapClosureForDead( StgClosure *c )
76 if (info->type != EVACUATED) {
77 ASSERT(((LDVW(c) & LDV_CREATE_MASK) >> LDV_SHIFT) <= era &&
78 ((LDVW(c) & LDV_CREATE_MASK) >> LDV_SHIFT) > 0);
79 ASSERT(((LDVW(c) & LDV_STATE_MASK) == LDV_STATE_CREATE) ||
81 (LDVW(c) & LDV_LAST_MASK) <= era &&
82 (LDVW(c) & LDV_LAST_MASK) > 0
86 if (info->type == EVACUATED) {
87 // The size of the evacuated closure is currently stored in
88 // the LDV field. See SET_EVACUAEE_FOR_LDV() in
89 // includes/StgLdvProf.h.
93 size = closure_sizeW(c);
97 '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_WAIT_QUEUE:
118 ordinary cases: call LDV_recordDead().
145 case SE_CAF_BLACKHOLE:
147 case IND_OLDGEN_PERM:
151 // Why can we ignore IND/IND_OLDGEN closures? We assume that
152 // any census is preceded by a major garbage collection, which
153 // IND/IND_OLDGEN closures cannot survive. Therefore, it is no
154 // use considering IND/IND_OLDGEN closures in the meanwhile
155 // because they will perish before the next census at any
159 // Found a dead closure: record its size
160 LDV_recordDead(c, size);
171 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 bd = small_alloc_list;
257 while (p < alloc_Hp) {
258 p += processHeapClosureForDead((StgClosure *)p);
259 while (p < alloc_Hp && !*p) // skip slop
262 ASSERT(p == alloc_Hp);
267 while (p < bd->free) {
268 p += processHeapClosureForDead((StgClosure *)p);
269 while (p < bd->free && !*p) // skip slop
272 ASSERT(p == bd->free);
277 /* --------------------------------------------------------------------------
278 * Calls processHeapClosureForDead() on every *dead* closures in the closure
280 * ----------------------------------------------------------------------- */
282 processChainForDead( bdescr *bd )
284 // Any object still in the chain is dead!
286 processHeapClosureForDead((StgClosure *)bd->start);
291 /* --------------------------------------------------------------------------
292 * Start a census for *dead* closures, and calls
293 * processHeapClosureForDead() on every closure which died in the
294 * current garbage collection. This function is called from a garbage
295 * collector right before tidying up, when all dead closures are still
296 * stored in the heap and easy to identify. Generations 0 through N
297 * have just beed garbage collected.
298 * ----------------------------------------------------------------------- */
300 LdvCensusForDead( nat N )
304 // ldvTime == 0 means that LDV profiling is currently turned off.
308 if (RtsFlags.GcFlags.generations == 1) {
310 // Todo: support LDV for two-space garbage collection.
312 barf("Lag/Drag/Void profiling not supported with -G1");
314 for (g = 0; g <= N; g++)
315 for (s = 0; s < generations[g].n_steps; s++) {
316 if (g == 0 && s == 0) {
317 processSmallObjectPoolForDead();
318 processNurseryForDead();
319 processChainForDead(generations[g].steps[s].large_objects);
321 processHeapForDead(generations[g].steps[s].old_blocks);
322 processChainForDead(generations[g].steps[s].large_objects);
328 /* --------------------------------------------------------------------------
329 * Regard any closure in the current heap as dead or moribund and update
330 * LDV statistics accordingly.
331 * Called from shutdownHaskell() in RtsStartup.c.
332 * Also, stops LDV profiling by resetting ldvTime to 0.
333 * ----------------------------------------------------------------------- */
335 LdvCensusKillAll( void )
337 LdvCensusForDead(RtsFlags.GcFlags.generations - 1);
340 #endif /* PROFILING */