Remove the IND_OLDGEN and IND_OLDGEN_PERM closure types
[ghc.git] / rts / LdvProfile.c
1 /* -----------------------------------------------------------------------------
2 *
3 * (c) The GHC Team, 2001
4 * Author: Sungwoo Park
5 *
6 * Lag/Drag/Void profiling.
7 *
8 * ---------------------------------------------------------------------------*/
9
10 #ifdef PROFILING
11
12 #include "PosixSource.h"
13 #include "Rts.h"
14
15 #include "Profiling.h"
16 #include "LdvProfile.h"
17 #include "Stats.h"
18 #include "RtsUtils.h"
19 #include "Schedule.h"
20
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
24 * fills in the slop.
25 *
26 * Invoked when:
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).
32 *
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 * ----------------------------------------------------------------------- */
36 void
37 LDV_recordDead_FILL_SLOP_DYNAMIC( StgClosure *p )
38 {
39 nat size, i;
40
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
43 #endif
44
45 if (era > 0) {
46 // very like FILL_SLOP(), except that we call LDV_recordDead().
47 size = closure_sizeW(p);
48
49 LDV_recordDead((StgClosure *)(p), size);
50
51 if (size > sizeofW(StgThunkHeader)) {
52 for (i = 0; i < size - sizeofW(StgThunkHeader); i++) {
53 ((StgThunk *)(p))->payload[i] = 0;
54 }
55 }
56 }
57 }
58
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 * ----------------------------------------------------------------------- */
68 STATIC_INLINE nat
69 processHeapClosureForDead( StgClosure *c )
70 {
71 nat size;
72 const StgInfoTable *info;
73
74 info = get_itbl(c);
75
76 info = c->header.info;
77 if (IS_FORWARDING_PTR(info)) {
78 // The size of the evacuated closure is currently stored in
79 // the LDV field. See SET_EVACUAEE_FOR_LDV() in
80 // includes/StgLdvProf.h.
81 return LDVW(c);
82 }
83 info = INFO_PTR_TO_STRUCT(info);
84
85 ASSERT(((LDVW(c) & LDV_CREATE_MASK) >> LDV_SHIFT) <= era &&
86 ((LDVW(c) & LDV_CREATE_MASK) >> LDV_SHIFT) > 0);
87 ASSERT(((LDVW(c) & LDV_STATE_MASK) == LDV_STATE_CREATE) ||
88 (
89 (LDVW(c) & LDV_LAST_MASK) <= era &&
90 (LDVW(c) & LDV_LAST_MASK) > 0
91 ));
92
93
94 size = closure_sizeW(c);
95
96 switch (info->type) {
97 /*
98 'inherently used' cases: do nothing.
99 */
100 case TSO:
101 case MVAR_CLEAN:
102 case MVAR_DIRTY:
103 case MUT_ARR_PTRS_CLEAN:
104 case MUT_ARR_PTRS_DIRTY:
105 case MUT_ARR_PTRS_FROZEN:
106 case MUT_ARR_PTRS_FROZEN0:
107 case ARR_WORDS:
108 case WEAK:
109 case MUT_VAR_CLEAN:
110 case MUT_VAR_DIRTY:
111 case BCO:
112 case PRIM:
113 case MUT_PRIM:
114 case TREC_CHUNK:
115 return size;
116
117 /*
118 ordinary cases: call LDV_recordDead().
119 */
120 case THUNK:
121 case THUNK_1_0:
122 case THUNK_0_1:
123 case THUNK_SELECTOR:
124 case THUNK_2_0:
125 case THUNK_1_1:
126 case THUNK_0_2:
127 case AP:
128 case PAP:
129 case AP_STACK:
130 case CONSTR:
131 case CONSTR_1_0:
132 case CONSTR_0_1:
133 case CONSTR_2_0:
134 case CONSTR_1_1:
135 case CONSTR_0_2:
136 case FUN:
137 case FUN_1_0:
138 case FUN_0_1:
139 case FUN_2_0:
140 case FUN_1_1:
141 case FUN_0_2:
142 case BLACKHOLE:
143 case BLOCKING_QUEUE:
144 case IND_PERM:
145 /*
146 'Ingore' cases
147 */
148 // Why can we ignore IND closures? We assume that
149 // any census is preceded by a major garbage collection, which
150 // IND closures cannot survive. Therefore, it is no
151 // use considering IND closures in the meanwhile
152 // because they will perish before the next census at any
153 // rate.
154 case IND:
155 // Found a dead closure: record its size
156 LDV_recordDead(c, size);
157 return size;
158
159 /*
160 Error case
161 */
162 // static objects
163 case IND_STATIC:
164 case CONSTR_STATIC:
165 case FUN_STATIC:
166 case THUNK_STATIC:
167 case CONSTR_NOCAF_STATIC:
168 // stack objects
169 case UPDATE_FRAME:
170 case CATCH_FRAME:
171 case STOP_FRAME:
172 case RET_DYN:
173 case RET_BCO:
174 case RET_SMALL:
175 case RET_BIG:
176 // others
177 case INVALID_OBJECT:
178 default:
179 barf("Invalid object in processHeapClosureForDead(): %d", info->type);
180 return 0;
181 }
182 }
183
184 /* --------------------------------------------------------------------------
185 * Calls processHeapClosureForDead() on every *dead* closures in the
186 * heap blocks starting at bd.
187 * ----------------------------------------------------------------------- */
188 static void
189 processHeapForDead( bdescr *bd )
190 {
191 StgPtr p;
192
193 while (bd != NULL) {
194 p = bd->start;
195 while (p < bd->free) {
196 p += processHeapClosureForDead((StgClosure *)p);
197 while (p < bd->free && !*p) // skip slop
198 p++;
199 }
200 ASSERT(p == bd->free);
201 bd = bd->link;
202 }
203 }
204
205 /* --------------------------------------------------------------------------
206 * Calls processHeapClosureForDead() on every *dead* closures in the nursery.
207 * ----------------------------------------------------------------------- */
208 static void
209 processNurseryForDead( void )
210 {
211 StgPtr p, bdLimit;
212 bdescr *bd;
213
214 bd = MainCapability.r.rNursery->blocks;
215 while (bd->start < bd->free) {
216 p = bd->start;
217 bdLimit = bd->start + BLOCK_SIZE_W;
218 while (p < bd->free && p < bdLimit) {
219 p += processHeapClosureForDead((StgClosure *)p);
220 while (p < bd->free && p < bdLimit && !*p) // skip slop
221 p++;
222 }
223 bd = bd->link;
224 if (bd == NULL)
225 break;
226 }
227 }
228
229 /* --------------------------------------------------------------------------
230 * Calls processHeapClosureForDead() on every *dead* closures in the closure
231 * chain.
232 * ----------------------------------------------------------------------- */
233 static void
234 processChainForDead( bdescr *bd )
235 {
236 // Any object still in the chain is dead!
237 while (bd != NULL) {
238 if (!(bd->flags & BF_PINNED)) {
239 processHeapClosureForDead((StgClosure *)bd->start);
240 }
241 bd = bd->link;
242 }
243 }
244
245 /* --------------------------------------------------------------------------
246 * Start a census for *dead* closures, and calls
247 * processHeapClosureForDead() on every closure which died in the
248 * current garbage collection. This function is called from a garbage
249 * collector right before tidying up, when all dead closures are still
250 * stored in the heap and easy to identify. Generations 0 through N
251 * have just beed garbage collected.
252 * ----------------------------------------------------------------------- */
253 void
254 LdvCensusForDead( nat N )
255 {
256 nat g;
257
258 // ldvTime == 0 means that LDV profiling is currently turned off.
259 if (era == 0)
260 return;
261
262 if (RtsFlags.GcFlags.generations == 1) {
263 //
264 // Todo: support LDV for two-space garbage collection.
265 //
266 barf("Lag/Drag/Void profiling not supported with -G1");
267 } else {
268 processNurseryForDead();
269 for (g = 0; g <= N; g++) {
270 processHeapForDead(generations[g].old_blocks);
271 processChainForDead(generations[g].large_objects);
272 }
273 }
274 }
275
276 /* --------------------------------------------------------------------------
277 * Regard any closure in the current heap as dead or moribund and update
278 * LDV statistics accordingly.
279 * Called from shutdownHaskell() in RtsStartup.c.
280 * Also, stops LDV profiling by resetting ldvTime to 0.
281 * ----------------------------------------------------------------------- */
282 void
283 LdvCensusKillAll( void )
284 {
285 LdvCensusForDead(RtsFlags.GcFlags.generations - 1);
286 }
287
288 #endif /* PROFILING */