rts: Fix use of #if
[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 #if defined(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 * This function is called eventually on every object destroyed during
23 * a garbage collection, whether it is a major garbage collection or
24 * not. If c is an 'inherently used' closure, nothing happens. If c
25 * is an ordinary closure, LDV_recordDead() is called on c with its
26 * proper size which excludes the profiling header portion in the
27 * closure. Returns the size of the closure, including the profiling
28 * header portion, so that the caller can find the next closure.
29 * ----------------------------------------------------------------------- */
30 STATIC_INLINE uint32_t
31 processHeapClosureForDead( const StgClosure *c )
32 {
33 uint32_t size;
34 const StgInfoTable *info;
35
36 info = get_itbl(c);
37
38 info = c->header.info;
39 if (IS_FORWARDING_PTR(info)) {
40 // The size of the evacuated closure is currently stored in
41 // the LDV field. See SET_EVACUAEE_FOR_LDV() in
42 // includes/StgLdvProf.h.
43 return LDVW(c);
44 }
45 info = INFO_PTR_TO_STRUCT(info);
46
47 ASSERT(((LDVW(c) & LDV_CREATE_MASK) >> LDV_SHIFT) <= era &&
48 ((LDVW(c) & LDV_CREATE_MASK) >> LDV_SHIFT) > 0);
49 ASSERT(((LDVW(c) & LDV_STATE_MASK) == LDV_STATE_CREATE) ||
50 (
51 (LDVW(c) & LDV_LAST_MASK) <= era &&
52 (LDVW(c) & LDV_LAST_MASK) > 0
53 ));
54
55
56 size = closure_sizeW(c);
57
58 switch (info->type) {
59 /*
60 'inherently used' cases: do nothing.
61 */
62 case TSO:
63 case STACK:
64 case MVAR_CLEAN:
65 case MVAR_DIRTY:
66 case TVAR:
67 case MUT_ARR_PTRS_CLEAN:
68 case MUT_ARR_PTRS_DIRTY:
69 case MUT_ARR_PTRS_FROZEN:
70 case MUT_ARR_PTRS_FROZEN0:
71 case SMALL_MUT_ARR_PTRS_CLEAN:
72 case SMALL_MUT_ARR_PTRS_DIRTY:
73 case SMALL_MUT_ARR_PTRS_FROZEN:
74 case SMALL_MUT_ARR_PTRS_FROZEN0:
75 case ARR_WORDS:
76 case WEAK:
77 case MUT_VAR_CLEAN:
78 case MUT_VAR_DIRTY:
79 case BCO:
80 case PRIM:
81 case MUT_PRIM:
82 case TREC_CHUNK:
83 return size;
84
85 /*
86 ordinary cases: call LDV_recordDead().
87 */
88 case THUNK:
89 case THUNK_1_0:
90 case THUNK_0_1:
91 case THUNK_SELECTOR:
92 case THUNK_2_0:
93 case THUNK_1_1:
94 case THUNK_0_2:
95 case AP:
96 case PAP:
97 case AP_STACK:
98 case CONSTR:
99 case CONSTR_1_0:
100 case CONSTR_0_1:
101 case CONSTR_2_0:
102 case CONSTR_1_1:
103 case CONSTR_0_2:
104 case FUN:
105 case FUN_1_0:
106 case FUN_0_1:
107 case FUN_2_0:
108 case FUN_1_1:
109 case FUN_0_2:
110 case BLACKHOLE:
111 case BLOCKING_QUEUE:
112 /*
113 'Ingore' cases
114 */
115 // Why can we ignore IND closures? We assume that
116 // any census is preceded by a major garbage collection, which
117 // IND closures cannot survive. Therefore, it is no
118 // use considering IND closures in the meanwhile
119 // because they will perish before the next census at any
120 // rate.
121 case IND:
122 // Found a dead closure: record its size
123 LDV_recordDead(c, size);
124 return size;
125
126 /*
127 Error case
128 */
129 // static objects
130 case IND_STATIC:
131 case FUN_STATIC:
132 case THUNK_STATIC:
133 case CONSTR_NOCAF:
134 // stack objects
135 case UPDATE_FRAME:
136 case CATCH_FRAME:
137 case UNDERFLOW_FRAME:
138 case STOP_FRAME:
139 case RET_BCO:
140 case RET_SMALL:
141 case RET_BIG:
142 // others
143 case INVALID_OBJECT:
144 case COMPACT_NFDATA:
145 default:
146 barf("Invalid object in processHeapClosureForDead(): %d", info->type);
147 return 0;
148 }
149 }
150
151 /* --------------------------------------------------------------------------
152 * Calls processHeapClosureForDead() on every *dead* closures in the
153 * heap blocks starting at bd.
154 * ----------------------------------------------------------------------- */
155 static void
156 processHeapForDead( bdescr *bd )
157 {
158 StgPtr p;
159
160 while (bd != NULL) {
161 p = bd->start;
162 while (p < bd->free) {
163 p += processHeapClosureForDead((StgClosure *)p);
164 while (p < bd->free && !*p) // skip slop
165 p++;
166 }
167 ASSERT(p == bd->free);
168 bd = bd->link;
169 }
170 }
171
172 /* --------------------------------------------------------------------------
173 * Calls processHeapClosureForDead() on every *dead* closures in the nursery.
174 * ----------------------------------------------------------------------- */
175 static void
176 processNurseryForDead( void )
177 {
178 StgPtr p;
179 bdescr *bd;
180
181 if (MainCapability.r.rNursery == NULL)
182 return;
183
184 for (bd = MainCapability.r.rNursery->blocks; bd != NULL; bd = bd->link) {
185 p = bd->start;
186 while (p < bd->free) {
187 while (p < bd->free && !*p) p++; // skip slop
188 if (p >= bd->free) break;
189 p += processHeapClosureForDead((StgClosure *)p);
190 }
191 }
192 }
193
194 /* --------------------------------------------------------------------------
195 * Calls processHeapClosureForDead() on every *dead* closures in the closure
196 * chain.
197 * ----------------------------------------------------------------------- */
198 static void
199 processChainForDead( bdescr *bd )
200 {
201 // Any object still in the chain is dead!
202 while (bd != NULL) {
203 if (!(bd->flags & BF_PINNED)) {
204 processHeapClosureForDead((StgClosure *)bd->start);
205 }
206 bd = bd->link;
207 }
208 }
209
210 /* --------------------------------------------------------------------------
211 * Start a census for *dead* closures, and calls
212 * processHeapClosureForDead() on every closure which died in the
213 * current garbage collection. This function is called from a garbage
214 * collector right before tidying up, when all dead closures are still
215 * stored in the heap and easy to identify. Generations 0 through N
216 * have just been garbage collected.
217 * ----------------------------------------------------------------------- */
218 void
219 LdvCensusForDead( uint32_t N )
220 {
221 uint32_t g;
222
223 // ldvTime == 0 means that LDV profiling is currently turned off.
224 if (era == 0)
225 return;
226
227 if (RtsFlags.GcFlags.generations == 1) {
228 //
229 // Todo: support LDV for two-space garbage collection.
230 //
231 barf("Lag/Drag/Void profiling not supported with -G1");
232 } else {
233 processNurseryForDead();
234 for (g = 0; g <= N; g++) {
235 processHeapForDead(generations[g].old_blocks);
236 processChainForDead(generations[g].large_objects);
237 }
238 }
239 }
240
241 /* --------------------------------------------------------------------------
242 * Regard any closure in the current heap as dead or moribund and update
243 * LDV statistics accordingly.
244 * Called from shutdownHaskell() in RtsStartup.c.
245 * Also, stops LDV profiling by resetting ldvTime to 0.
246 * ----------------------------------------------------------------------- */
247 void
248 LdvCensusKillAll( void )
249 {
250 LdvCensusForDead(RtsFlags.GcFlags.generations - 1);
251 }
252
253 #endif /* PROFILING */