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 )
42 #if defined(__GNUC__) && __GNUC__ < 3 && defined(DEBUG)
43 #error Please use gcc 3.0+ to compile this file with DEBUG; gcc < 3.0 miscompiles it
58 nw = info->layout.payload.ptrs + info->layout.payload.nptrs;
59 if (nw < MIN_UPD_SIZE)
63 nw = sizeofW(StgPAP) - sizeofW(StgHeader) + ((StgPAP *)p)->n_args;
66 nw = sizeofW(StgAP_STACK) - sizeofW(StgHeader)
67 + ((StgAP_STACK *)p)->size;
72 case SE_CAF_BLACKHOLE:
73 nw = info->layout.payload.ptrs + info->layout.payload.nptrs;
76 barf("Unexpected closure type %u in LDV_recordDead_FILL_SLOP_DYNAMIC()", info->type);
79 LDV_recordDead((StgClosure *)(p), nw + sizeofW(StgHeader));
80 for (i = 0; i < nw; i++) {
81 ((StgClosure *)(p))->payload[i] = 0;
86 /* --------------------------------------------------------------------------
87 * This function is called eventually on every object destroyed during
88 * a garbage collection, whether it is a major garbage collection or
89 * not. If c is an 'inherently used' closure, nothing happens. If c
90 * is an ordinary closure, LDV_recordDead() is called on c with its
91 * proper size which excludes the profiling header portion in the
92 * closure. Returns the size of the closure, including the profiling
93 * header portion, so that the caller can find the next closure.
94 * ----------------------------------------------------------------------- */
96 processHeapClosureForDead( StgClosure *c )
103 if (info->type != EVACUATED) {
104 ASSERT(((LDVW(c) & LDV_CREATE_MASK) >> LDV_SHIFT) <= era &&
105 ((LDVW(c) & LDV_CREATE_MASK) >> LDV_SHIFT) > 0);
106 ASSERT(((LDVW(c) & LDV_STATE_MASK) == LDV_STATE_CREATE) ||
108 (LDVW(c) & LDV_LAST_MASK) <= era &&
109 (LDVW(c) & LDV_LAST_MASK) > 0
113 switch (info->type) {
115 'inherently used' cases: do nothing.
119 size = tso_sizeW((StgTSO *)c);
123 size = sizeofW(StgMVar);
127 case MUT_ARR_PTRS_FROZEN:
128 size = mut_arr_ptrs_sizeW((StgMutArrPtrs *)c);
132 size = arr_words_sizeW((StgArrWords *)c);
140 size = sizeW_fromITBL(info);
144 ordinary cases: call LDV_recordDead().
148 size = stg_max(sizeW_fromITBL(info), sizeofW(StgHeader) + MIN_UPD_SIZE);
157 size = sizeofW(StgHeader) + MIN_UPD_SIZE;
162 size = pap_sizeW((StgPAP *)c);
166 size = ap_stack_sizeW((StgAP_STACK *)c);
186 case SE_CAF_BLACKHOLE:
187 size = sizeW_fromITBL(info);
191 case IND_OLDGEN_PERM:
192 size = sizeofW(StgInd);
198 // Why can we ignore IND/IND_OLDGEN closures? We assume that
199 // any census is preceded by a major garbage collection, which
200 // IND/IND_OLDGEN closures cannot survive. Therefore, it is no
201 // use considering IND/IND_OLDGEN closures in the meanwhile
202 // because they will perish before the next census at any
206 size = sizeofW(StgInd);
210 // The size of the evacuated closure is currently stored in
211 // the LDV field. See SET_EVACUAEE_FOR_LDV() in
212 // includes/StgLdvProf.h.
224 case CONSTR_CHARLIKE:
225 case CONSTR_NOCAF_STATIC:
244 barf("Invalid object in processHeapClosureForDead(): %d", info->type);
248 // Found a dead closure: record its size
249 LDV_recordDead(c, size);
253 /* --------------------------------------------------------------------------
254 * Calls processHeapClosureForDead() on every *dead* closures in the
255 * heap blocks starting at bd.
256 * ----------------------------------------------------------------------- */
258 processHeapForDead( bdescr *bd )
264 while (p < bd->free) {
265 p += processHeapClosureForDead((StgClosure *)p);
266 while (p < bd->free && !*p) // skip slop
269 ASSERT(p == bd->free);
274 /* --------------------------------------------------------------------------
275 * Calls processHeapClosureForDead() on every *dead* closures in the nursery.
276 * ----------------------------------------------------------------------- */
278 processNurseryForDead( void )
283 bd = MainCapability.r.rNursery;
284 while (bd->start < bd->free) {
286 bdLimit = bd->start + BLOCK_SIZE_W;
287 while (p < bd->free && p < bdLimit) {
288 p += processHeapClosureForDead((StgClosure *)p);
289 while (p < bd->free && p < bdLimit && !*p) // skip slop
298 /* --------------------------------------------------------------------------
299 * Calls processHeapClosureForDead() on every *dead* closures in the
301 * ----------------------------------------------------------------------- */
303 processSmallObjectPoolForDead( void )
308 bd = small_alloc_list;
315 while (p < alloc_Hp) {
316 p += processHeapClosureForDead((StgClosure *)p);
317 while (p < alloc_Hp && !*p) // skip slop
320 ASSERT(p == alloc_Hp);
325 while (p < bd->free) {
326 p += processHeapClosureForDead((StgClosure *)p);
327 while (p < bd->free && !*p) // skip slop
330 ASSERT(p == bd->free);
335 /* --------------------------------------------------------------------------
336 * Calls processHeapClosureForDead() on every *dead* closures in the closure
338 * ----------------------------------------------------------------------- */
340 processChainForDead( bdescr *bd )
342 // Any object still in the chain is dead!
344 processHeapClosureForDead((StgClosure *)bd->start);
349 /* --------------------------------------------------------------------------
350 * Start a census for *dead* closures, and calls
351 * processHeapClosureForDead() on every closure which died in the
352 * current garbage collection. This function is called from a garbage
353 * collector right before tidying up, when all dead closures are still
354 * stored in the heap and easy to identify. Generations 0 through N
355 * have just beed garbage collected.
356 * ----------------------------------------------------------------------- */
358 LdvCensusForDead( nat N )
362 // ldvTime == 0 means that LDV profiling is currently turned off.
366 if (RtsFlags.GcFlags.generations == 1) {
368 // Todo: support LDV for two-space garbage collection.
370 barf("Lag/Drag/Void profiling not supported with -G1");
372 for (g = 0; g <= N; g++)
373 for (s = 0; s < generations[g].n_steps; s++) {
374 if (g == 0 && s == 0) {
375 processSmallObjectPoolForDead();
376 processNurseryForDead();
377 processChainForDead(generations[g].steps[s].large_objects);
379 processHeapForDead(generations[g].steps[s].blocks);
380 processChainForDead(generations[g].steps[s].large_objects);
386 /* --------------------------------------------------------------------------
387 * Regard any closure in the current heap as dead or moribund and update
388 * LDV statistics accordingly.
389 * Called from shutdownHaskell() in RtsStartup.c.
390 * Also, stops LDV profiling by resetting ldvTime to 0.
391 * ----------------------------------------------------------------------- */
393 LdvCensusKillAll( void )
395 LdvCensusForDead(RtsFlags.GcFlags.generations - 1);
398 #endif /* PROFILING */