1 /* ----------------------------------------------------------------------------
2 * $Id: StgTicky.h,v 1.1 1999/01/21 10:31:44 simonm Exp $
4 * Ticky-ticky profiling macros.
6 * -------------------------------------------------------------------------- */
13 /* -----------------------------------------------------------------------------
15 -------------------------------------------------------------------------- */
17 /* How many times we do a heap check and move Hp; comparing this with
18 * the allocations gives an indication of how many things we get per trip
21 #define TICK_ALLOC_HEAP(n) ALLOC_HEAP_ctr++; ALLOC_HEAP_tot += (n)
23 /* We count things every time we allocate something in the dynamic heap.
24 * For each, we count the number of words of (1) ``admin'' (header),
25 * (2) good stuff (useful pointers and data), and (3) ``slop'' (extra
26 * space, to leave room for an old generation indirection for example).
28 * The first five macros are inserted when the compiler generates code
29 * to allocate something; the categories correspond to the @ClosureClass@
30 * datatype (manifest functions, thunks, constructors, big tuples, and
31 * partial applications).
34 #define _HS sizeofW(StgHeader)
36 #define TICK_ALLOC_FUN(g,s) \
37 ALLOC_FUN_ctr++; ALLOC_FUN_adm += _HS; \
38 ALLOC_FUN_gds += (g); ALLOC_FUN_slp += (s); \
39 TICK_ALLOC_HISTO(FUN,_HS,g,s)
41 #define TICK_ALLOC_THK(g,s) \
42 ALLOC_THK_ctr++; ALLOC_THK_adm += _HS; \
43 ALLOC_THK_gds += (g); ALLOC_THK_slp += (s); \
44 TICK_ALLOC_HISTO(THK,_HS,g,s)
46 #define TICK_ALLOC_CON(g,s) \
47 ALLOC_CON_ctr++; ALLOC_CON_adm += _HS; \
48 ALLOC_CON_gds += (g); ALLOC_CON_slp += (s); \
49 TICK_ALLOC_HISTO(CON,_HS,g,s)
51 #define TICK_ALLOC_TUP(g,s) \
52 ALLOC_TUP_ctr++; ALLOC_TUP_adm += _HS; \
53 ALLOC_TUP_gds += (g); ALLOC_TUP_slp += (s); \
54 TICK_ALLOC_HISTO(TUP,_HS,g,s)
56 #define TICK_ALLOC_BH(g,s) \
57 ALLOC_BH_ctr++; ALLOC_BH_adm += _HS; \
58 ALLOC_BH_gds += (g); ALLOC_BH_slp += (s); \
59 TICK_ALLOC_HISTO(BH,_HS,g,s)
61 #define TICK_ALLOC_UPD_PAP(g,s) \
62 ALLOC_UPD_PAP_ctr++; ALLOC_UPD_PAP_adm += sizeofW(StgPAP)-1; \
63 ALLOC_UPD_PAP_gds += (g); ALLOC_UPD_PAP_slp += (s); \
64 TICK_ALLOC_HISTO(UPD_PAP,sizeofW(StgPAP)-1,g,s)
66 #define TICK_ALLOC_TSO(g,s) \
67 ALLOC_TSO_ctr++; ALLOC_TSO_adm += sizeofW(StgTSO); \
68 ALLOC_TSO_gds += (g); ALLOC_TSO_slp += (s); \
69 TICK_ALLOC_HISTO(TSO,sizeofW(StgTSO),g,s)
72 #define TICK_ALLOC_FMBQ(a,g,s) \
73 ALLOC_FMBQ_ctr++; ALLOC_FMBQ_adm += (a); \
74 ALLOC_FMBQ_gds += (g); ALLOC_FMBQ_slp += (s); \
75 TICK_ALLOC_HISTO(FMBQ,a,g,s)
77 #define TICK_ALLOC_FME(a,g,s) \
78 ALLOC_FME_ctr++; ALLOC_FME_adm += (a); \
79 ALLOC_FME_gds += (g); ALLOC_FME_slp += (s); \
80 TICK_ALLOC_HISTO(FME,a,g,s)
82 #define TICK_ALLOC_BF(a,g,s) \
83 ALLOC_BF_ctr++; ALLOC_BF_adm += (a); \
84 ALLOC_BF_gds += (g); ALLOC_BF_slp += (s); \
85 TICK_ALLOC_HISTO(BF,a,g,s)
88 /* The histogrammy bit is fairly straightforward; the -2 is: one for
89 * 0-origin C arrays; the other one because we do no one-word
90 * allocations, so we would never inc that histogram slot; so we shift
91 * everything over by one.
93 #define TICK_ALLOC_HISTO(categ,a,g,s) \
95 __idx = (a) + (g) + (s) - 2; \
96 ALLOC_##categ##_hst[((__idx > 4) ? 4 : __idx)] += 1;}
98 /* Some hard-to-account-for words are allocated by/for primitives,
99 * includes Integer support. ALLOC_PRIM2 tells us about these. We
100 * count everything as ``goods'', which is not strictly correct.
101 * (ALLOC_PRIM is the same sort of stuff, but we know the
102 * admin/goods/slop breakdown.)
104 #define TICK_ALLOC_PRIM(a,g,s) \
105 ALLOC_PRIM_ctr++; ALLOC_PRIM_adm += (a); \
106 ALLOC_PRIM_gds += (g); ALLOC_PRIM_slp += (s); \
107 TICK_ALLOC_HISTO(PRIM,a,g,s)
109 #define TICK_ALLOC_PRIM2(w) ALLOC_PRIM_ctr++; ALLOC_PRIM_gds +=(w); \
110 TICK_ALLOC_HISTO(PRIM,0,w,0)
113 /* -----------------------------------------------------------------------------
115 -------------------------------------------------------------------------- */
117 #define TICK_ENT_VIA_NODE() ENT_VIA_NODE_ctr++
119 #define TICK_ENT_THK() ENT_THK_ctr++ /* thunk */
120 #define TICK_ENT_FUN_STD() ENT_FUN_STD_ctr++ /* std entry pt */
121 #define TICK_ENT_FUN_DIRECT(n) ENT_FUN_DIRECT_ctr++ /* fast entry pt */
123 #define TICK_ENT_CON(n) ENT_CON_ctr++ /* enter constructor */
124 #define TICK_ENT_IND(n) ENT_IND_ctr++ /* enter indirection */
125 #define TICK_ENT_PAP(n) ENT_PAP_ctr++ /* enter PAP */
126 #define TICK_ENT_AP_UPD(n) ENT_AP_UPD_ctr++ /* enter AP_UPD */
127 #define TICK_ENT_BH() ENT_BH_ctr++ /* enter BLACKHOLE */
129 /* -----------------------------------------------------------------------------
131 -------------------------------------------------------------------------- */
133 /* Whenever a ``return'' occurs, it is returning the constituent parts of
134 * a data constructor. The parts can be returned either in registers, or
135 * by allocating some heap to put it in (the TICK_ALLOC_* macros account for
136 * the allocation). The constructor can either be an existing one
137 * *OLD* or we could have {\em just} figured out this stuff
141 #define TICK_RET_HISTO(categ,n) \
144 RET_##categ##_hst[((__idx > 8) ? 8 : __idx)] += 1;}
146 #define TICK_RET_NEW(n) RET_NEW_ctr++; \
147 TICK_RET_HISTO(NEW,n)
149 #define TICK_RET_OLD(n) RET_OLD_ctr++; \
150 TICK_RET_HISTO(OLD,n)
152 #define TICK_RET_UNBOXED_TUP(n) RET_UNBOXED_TUP_ctr++; \
153 TICK_RET_HISTO(UNBOXED_TUP,n)
155 #define TICK_RET_SEMI(n) RET_SEMI_IN_HEAP_ctr++; \
156 TICK_RET_HISTO(SEMI_IN_HEAP,n)
158 #define TICK_RET_SEMI_BY_DEFAULT()/*???*/ RET_SEMI_BY_DEFAULT_ctr++
160 #define TICK_RET_SEMI_FAILED(tag) do { \
161 if ((tag) == INFO_IND_TAG) \
162 RET_SEMI_FAILED_IND_ctr++; \
164 RET_SEMI_FAILED_UNEVAL_ctr++; \
167 #define TICK_VEC_RETURN(n) VEC_RETURN_ctr++; \
168 TICK_RET_HISTO(VEC_RETURN,n)
170 /* -----------------------------------------------------------------------------
174 ------------------ -------------------------------------------
175 TICK_UPDF_PUSHED Update frame pushed
176 TICK_SEQF_PUSHED Seq frame pushed
177 TICK_CATCHF_PUSHED Catch frame pushed
178 TICK_UPDF_OMITTED A thunk decided not to push an update frame
179 TICK_UPDF_RCC_PUSHED Cost Centre restore frame pushed
180 TICK_UPDF_RCC_OMITTED Cost Centres not required -- not pushed
182 -------------------------------------------------------------------------- */
184 #define TICK_UPDF_OMITTED() UPDF_OMITTED_ctr++
185 #define TICK_UPDF_PUSHED() UPDF_PUSHED_ctr++
186 #define TICK_SEQF_PUSHED() SEQF_PUSHED_ctr++
187 #define TICK_CATCHF_PUSHED() CATCHF_PUSHED_ctr++
188 #define TICK_UPDF_RCC_PUSHED() UPDF_RCC_PUSHED_ctr++
189 #define TICK_UPDF_RCC_OMITTED() UPDF_RCC_OMITTED_ctr++
191 /* -----------------------------------------------------------------------------
194 These macros record information when we do an update. We always
195 update either with a data constructor (CON) or a partial application
200 ----------------------- --------------------------------------------
201 TICK_UPD_EXISTING Updating with an indirection to something
203 TICK_UPD_SQUEEZED Same as UPD_EXISTING but because
205 TICK_UPD_CON_IN_NEW Allocating a new CON
206 TICK_UPD_PAP_IN_NEW Allocating a new PAP
207 TICK_UPD_PAP_IN_PLACE Updating with a PAP in place
209 -------------------------------------------------------------------------- */
211 #define TICK_UPD_HISTO(categ,n) \
214 UPD_##categ##_hst[((__idx > 8) ? 8 : __idx)] += 1;}
216 #define TICK_UPD_EXISTING() UPD_EXISTING_ctr++
217 #define TICK_UPD_SQUEEZED() UPD_SQUEEZED_ctr++
219 #define TICK_UPD_CON_IN_NEW(n) UPD_CON_IN_NEW_ctr++ ; \
220 TICK_UPD_HISTO(CON_IN_NEW,n)
222 #define TICK_UPD_PAP_IN_NEW(n) UPD_PAP_IN_NEW_ctr++ ; \
223 TICK_UPD_HISTO(PAP_IN_NEW,n)
225 #define TICK_UPD_PAP_IN_PLACE() UPD_PAP_IN_PLACE_ctr++
227 /* For the generational collector:
229 #define TICK_UPD_NEW_IND() UPD_NEW_IND_ctr++
230 #define TICK_UPD_OLD_IND() UPD_OLD_IND_ctr++
232 /* -----------------------------------------------------------------------------
233 Garbage collection counters
234 -------------------------------------------------------------------------- */
238 * GC_SEL_ABANDONED: we could've done the selection, but we gave up
239 * (e.g., to avoid overflowing the C stack); GC_SEL_MINOR: did a
240 * selection in a minor GC; GC_SEL_MAJOR: ditto, but major GC.
242 #define TICK_GC_SEL_ABANDONED() GC_SEL_ABANDONED_ctr++
243 #define TICK_GC_SEL_MINOR() GC_SEL_MINOR_ctr++
244 #define TICK_GC_SEL_MAJOR() GC_SEL_MAJOR_ctr++
246 /* Failed promotion: we wanted to promote an object early, but
247 * it had already been evacuated to (or resided in) a younger
250 #define TICK_GC_FAILED_PROMOTION() GC_FAILED_PROMOTION_ctr++
252 /* -----------------------------------------------------------------------------
253 The accumulators (extern decls)
254 -------------------------------------------------------------------------- */
257 #define INIT(ializer) = ializer
260 #define INIT(ializer)
261 #define EXTERN extern
264 EXTERN unsigned long ALLOC_HEAP_ctr INIT(0);
265 EXTERN unsigned long ALLOC_HEAP_tot INIT(0);
267 EXTERN unsigned long ALLOC_FUN_ctr INIT(0);
268 EXTERN unsigned long ALLOC_FUN_adm INIT(0);
269 EXTERN unsigned long ALLOC_FUN_gds INIT(0);
270 EXTERN unsigned long ALLOC_FUN_slp INIT(0);
271 EXTERN unsigned long ALLOC_FUN_hst[5]
273 = {0,0,0,0,0} /* urk, can't use INIT macro 'cause of the commas */
277 EXTERN unsigned long ALLOC_THK_ctr INIT(0);
278 EXTERN unsigned long ALLOC_THK_adm INIT(0);
279 EXTERN unsigned long ALLOC_THK_gds INIT(0);
280 EXTERN unsigned long ALLOC_THK_slp INIT(0);
281 EXTERN unsigned long ALLOC_THK_hst[5]
287 EXTERN unsigned long ALLOC_CON_ctr INIT(0);
288 EXTERN unsigned long ALLOC_CON_adm INIT(0);
289 EXTERN unsigned long ALLOC_CON_gds INIT(0);
290 EXTERN unsigned long ALLOC_CON_slp INIT(0);
291 EXTERN unsigned long ALLOC_CON_hst[5]
297 EXTERN unsigned long ALLOC_TUP_ctr INIT(0);
298 EXTERN unsigned long ALLOC_TUP_adm INIT(0);
299 EXTERN unsigned long ALLOC_TUP_gds INIT(0);
300 EXTERN unsigned long ALLOC_TUP_slp INIT(0);
301 EXTERN unsigned long ALLOC_TUP_hst[5]
307 EXTERN unsigned long ALLOC_BH_ctr INIT(0);
308 EXTERN unsigned long ALLOC_BH_adm INIT(0);
309 EXTERN unsigned long ALLOC_BH_gds INIT(0);
310 EXTERN unsigned long ALLOC_BH_slp INIT(0);
311 EXTERN unsigned long ALLOC_BH_hst[5]
317 EXTERN unsigned long ALLOC_PRIM_ctr INIT(0);
318 EXTERN unsigned long ALLOC_PRIM_adm INIT(0);
319 EXTERN unsigned long ALLOC_PRIM_gds INIT(0);
320 EXTERN unsigned long ALLOC_PRIM_slp INIT(0);
321 EXTERN unsigned long ALLOC_PRIM_hst[5]
327 EXTERN unsigned long ALLOC_UPD_PAP_ctr INIT(0);
328 EXTERN unsigned long ALLOC_UPD_PAP_adm INIT(0);
329 EXTERN unsigned long ALLOC_UPD_PAP_gds INIT(0);
330 EXTERN unsigned long ALLOC_UPD_PAP_slp INIT(0);
331 EXTERN unsigned long ALLOC_UPD_PAP_hst[5]
337 EXTERN unsigned long ALLOC_TSO_ctr INIT(0);
338 EXTERN unsigned long ALLOC_TSO_adm INIT(0);
339 EXTERN unsigned long ALLOC_TSO_gds INIT(0);
340 EXTERN unsigned long ALLOC_TSO_slp INIT(0);
341 EXTERN unsigned long ALLOC_TSO_hst[5]
348 EXTERN unsigned long ALLOC_FMBQ_ctr INIT(0);
349 EXTERN unsigned long ALLOC_FMBQ_adm INIT(0);
350 EXTERN unsigned long ALLOC_FMBQ_gds INIT(0);
351 EXTERN unsigned long ALLOC_FMBQ_slp INIT(0);
352 EXTERN unsigned long ALLOC_FMBQ_hst[5]
358 EXTERN unsigned long ALLOC_FME_ctr INIT(0);
359 EXTERN unsigned long ALLOC_FME_adm INIT(0);
360 EXTERN unsigned long ALLOC_FME_gds INIT(0);
361 EXTERN unsigned long ALLOC_FME_slp INIT(0);
362 EXTERN unsigned long ALLOC_FME_hst[5]
368 EXTERN unsigned long ALLOC_BF_ctr INIT(0);
369 EXTERN unsigned long ALLOC_BF_adm INIT(0);
370 EXTERN unsigned long ALLOC_BF_gds INIT(0);
371 EXTERN unsigned long ALLOC_BF_slp INIT(0);
372 EXTERN unsigned long ALLOC_BF_hst[5]
379 EXTERN unsigned long ENT_VIA_NODE_ctr INIT(0);
380 EXTERN unsigned long ENT_THK_ctr INIT(0);
381 EXTERN unsigned long ENT_FUN_STD_ctr INIT(0);
382 EXTERN unsigned long ENT_FUN_DIRECT_ctr INIT(0);
383 EXTERN unsigned long ENT_CON_ctr INIT(0);
384 EXTERN unsigned long ENT_IND_ctr INIT(0);
385 EXTERN unsigned long ENT_PAP_ctr INIT(0);
386 EXTERN unsigned long ENT_AP_UPD_ctr INIT(0);
387 EXTERN unsigned long ENT_BH_ctr INIT(0);
389 EXTERN unsigned long RET_NEW_ctr INIT(0);
390 EXTERN unsigned long RET_OLD_ctr INIT(0);
391 EXTERN unsigned long RET_UNBOXED_TUP_ctr INIT(0);
392 EXTERN unsigned long RET_SEMI_BY_DEFAULT_ctr INIT(0);
393 EXTERN unsigned long RET_SEMI_IN_HEAP_ctr INIT(0);
394 EXTERN unsigned long RET_SEMI_FAILED_IND_ctr INIT(0);
395 EXTERN unsigned long RET_SEMI_FAILED_UNEVAL_ctr INIT(0);
397 EXTERN unsigned long VEC_RETURN_ctr INIT(0);
399 EXTERN unsigned long RET_NEW_hst[9]
401 = {0,0,0,0,0,0,0,0,0}
404 EXTERN unsigned long RET_OLD_hst[9]
406 = {0,0,0,0,0,0,0,0,0}
409 EXTERN unsigned long RET_UNBOXED_TUP_hst[9]
411 = {0,0,0,0,0,0,0,0,0}
414 EXTERN unsigned long RET_SEMI_IN_HEAP_hst[9]
416 = {0,0,0,0,0,0,0,0,0}
419 EXTERN unsigned long RET_VEC_RETURN_hst[9]
421 = {0,0,0,0,0,0,0,0,0}
425 EXTERN unsigned long RET_SEMI_loads_avoided INIT(0);
427 EXTERN unsigned long UPDF_OMITTED_ctr INIT(0);
428 EXTERN unsigned long UPDF_PUSHED_ctr INIT(0);
429 EXTERN unsigned long SEQF_PUSHED_ctr INIT(0);
430 EXTERN unsigned long CATCHF_PUSHED_ctr INIT(0);
431 EXTERN unsigned long UPDF_RCC_PUSHED_ctr INIT(0);
432 EXTERN unsigned long UPDF_RCC_OMITTED_ctr INIT(0);
434 EXTERN unsigned long UPD_EXISTING_ctr INIT(0);
435 EXTERN unsigned long UPD_SQUEEZED_ctr INIT(0);
436 EXTERN unsigned long UPD_CON_IN_NEW_ctr INIT(0);
437 EXTERN unsigned long UPD_PAP_IN_NEW_ctr INIT(0);
438 EXTERN unsigned long UPD_PAP_IN_PLACE_ctr INIT(0);
440 EXTERN unsigned long UPD_CON_IN_NEW_hst[9]
442 = {0,0,0,0,0,0,0,0,0}
445 EXTERN unsigned long UPD_PAP_IN_NEW_hst[9]
447 = {0,0,0,0,0,0,0,0,0}
451 EXTERN unsigned long UPD_NEW_IND_ctr INIT(0);
452 EXTERN unsigned long UPD_OLD_IND_ctr INIT(0);
454 EXTERN unsigned long GC_SEL_ABANDONED_ctr INIT(0);
455 EXTERN unsigned long GC_SEL_MINOR_ctr INIT(0);
456 EXTERN unsigned long GC_SEL_MAJOR_ctr INIT(0);
458 EXTERN unsigned long GC_FAILED_PROMOTION_ctr INIT(0);
463 /* -----------------------------------------------------------------------------
464 Just stubs if no ticky-ticky profiling
465 -------------------------------------------------------------------------- */
467 #else /* !TICKY_TICKY */
469 #define TICK_ALLOC_HEAP(words)
471 #define TICK_ALLOC_FUN(g,s)
472 #define TICK_ALLOC_THK(g,s)
473 #define TICK_ALLOC_CON(g,s)
474 #define TICK_ALLOC_TUP(g,s)
475 #define TICK_ALLOC_BH(g,s)
476 #define TICK_ALLOC_UPD_PAP(g,s)
477 #define TICK_ALLOC_TSO(g,s)
478 #define TICK_ALLOC_FMBQ(a,g,s)
479 #define TICK_ALLOC_FME(a,g,s)
480 #define TICK_ALLOC_BF(a,g,s)
481 #define TICK_ALLOC_PRIM(a,g,s)
482 #define TICK_ALLOC_PRIM2(w)
484 #define TICK_ENT_VIA_NODE()
486 #define TICK_ENT_THK()
487 #define TICK_ENT_FUN_STD()
488 #define TICK_ENT_FUN_DIRECT(n)
490 #define TICK_ENT_CON(n)
491 #define TICK_ENT_IND(n)
492 #define TICK_ENT_PAP(n)
493 #define TICK_ENT_AP_UPD(n)
494 #define TICK_ENT_BH()
496 #define TICK_RET_NEW(n)
497 #define TICK_RET_OLD(n)
498 #define TICK_RET_UNBOXED_TUP(n)
499 #define TICK_RET_SEMI(n)
500 #define TICK_RET_SEMI_BY_DEFAULT()
501 #define TICK_RET_SEMI_FAILED(tag)
502 #define TICK_VEC_RETURN(n)
504 #define TICK_UPDF_OMITTED()
505 #define TICK_UPDF_PUSHED()
506 #define TICK_SEQF_PUSHED()
507 #define TICK_CATCHF_PUSHED()
508 #define TICK_UPDF_RCC_PUSHED()
509 #define TICK_UPDF_RCC_OMITTED()
511 #define TICK_UPD_EXISTING()
512 #define TICK_UPD_SQUEEZED()
513 #define TICK_UPD_CON_IN_NEW(n)
514 #define TICK_UPD_PAP_IN_NEW(n)
515 #define TICK_UPD_PAP_IN_PLACE()
517 #define TICK_UPD_NEW_IND()
518 #define TICK_UPD_OLD_IND()
520 #define TICK_GC_SEL_ABANDONED()
521 #define TICK_GC_SEL_MINOR()
522 #define TICK_GC_SEL_MAJOR()
524 #define TICK_GC_FAILED_PROMOTION()
526 #endif /* !TICKY_TICKY */