1 /* ----------------------------------------------------------------------------
2 * $Id: StgTicky.h,v 1.3 1999/02/05 16:02:30 simonm Exp $
4 * (c) The AQUA project, Glasgow University, 1994-1997
5 * (c) The GHC Team, 1998-1999
7 * Ticky-ticky profiling macros.
9 * -------------------------------------------------------------------------- */
16 /* -----------------------------------------------------------------------------
18 -------------------------------------------------------------------------- */
20 /* How many times we do a heap check and move Hp; comparing this with
21 * the allocations gives an indication of how many things we get per trip
24 #define TICK_ALLOC_HEAP(n) ALLOC_HEAP_ctr++; ALLOC_HEAP_tot += (n)
26 /* We count things every time we allocate something in the dynamic heap.
27 * For each, we count the number of words of (1) ``admin'' (header),
28 * (2) good stuff (useful pointers and data), and (3) ``slop'' (extra
29 * space, to leave room for an old generation indirection for example).
31 * The first five macros are inserted when the compiler generates code
32 * to allocate something; the categories correspond to the @ClosureClass@
33 * datatype (manifest functions, thunks, constructors, big tuples, and
34 * partial applications).
37 #define _HS sizeofW(StgHeader)
39 #define TICK_ALLOC_FUN(g,s) \
40 ALLOC_FUN_ctr++; ALLOC_FUN_adm += _HS; \
41 ALLOC_FUN_gds += (g); ALLOC_FUN_slp += (s); \
42 TICK_ALLOC_HISTO(FUN,_HS,g,s)
44 #define TICK_ALLOC_THK(g,s) \
45 ALLOC_THK_ctr++; ALLOC_THK_adm += _HS; \
46 ALLOC_THK_gds += (g); ALLOC_THK_slp += (s); \
47 TICK_ALLOC_HISTO(THK,_HS,g,s)
49 #define TICK_ALLOC_CON(g,s) \
50 ALLOC_CON_ctr++; ALLOC_CON_adm += _HS; \
51 ALLOC_CON_gds += (g); ALLOC_CON_slp += (s); \
52 TICK_ALLOC_HISTO(CON,_HS,g,s)
54 #define TICK_ALLOC_TUP(g,s) \
55 ALLOC_TUP_ctr++; ALLOC_TUP_adm += _HS; \
56 ALLOC_TUP_gds += (g); ALLOC_TUP_slp += (s); \
57 TICK_ALLOC_HISTO(TUP,_HS,g,s)
59 #define TICK_ALLOC_BH(g,s) \
60 ALLOC_BH_ctr++; ALLOC_BH_adm += _HS; \
61 ALLOC_BH_gds += (g); ALLOC_BH_slp += (s); \
62 TICK_ALLOC_HISTO(BH,_HS,g,s)
64 #define TICK_ALLOC_UPD_PAP(g,s) \
65 ALLOC_UPD_PAP_ctr++; ALLOC_UPD_PAP_adm += sizeofW(StgPAP)-1; \
66 ALLOC_UPD_PAP_gds += (g); ALLOC_UPD_PAP_slp += (s); \
67 TICK_ALLOC_HISTO(UPD_PAP,sizeofW(StgPAP)-1,g,s)
69 #define TICK_ALLOC_TSO(g,s) \
70 ALLOC_TSO_ctr++; ALLOC_TSO_adm += sizeofW(StgTSO); \
71 ALLOC_TSO_gds += (g); ALLOC_TSO_slp += (s); \
72 TICK_ALLOC_HISTO(TSO,sizeofW(StgTSO),g,s)
75 #define TICK_ALLOC_FMBQ(a,g,s) \
76 ALLOC_FMBQ_ctr++; ALLOC_FMBQ_adm += (a); \
77 ALLOC_FMBQ_gds += (g); ALLOC_FMBQ_slp += (s); \
78 TICK_ALLOC_HISTO(FMBQ,a,g,s)
80 #define TICK_ALLOC_FME(a,g,s) \
81 ALLOC_FME_ctr++; ALLOC_FME_adm += (a); \
82 ALLOC_FME_gds += (g); ALLOC_FME_slp += (s); \
83 TICK_ALLOC_HISTO(FME,a,g,s)
85 #define TICK_ALLOC_BF(a,g,s) \
86 ALLOC_BF_ctr++; ALLOC_BF_adm += (a); \
87 ALLOC_BF_gds += (g); ALLOC_BF_slp += (s); \
88 TICK_ALLOC_HISTO(BF,a,g,s)
91 /* The histogrammy bit is fairly straightforward; the -2 is: one for
92 * 0-origin C arrays; the other one because we do no one-word
93 * allocations, so we would never inc that histogram slot; so we shift
94 * everything over by one.
96 #define TICK_ALLOC_HISTO(categ,a,g,s) \
98 __idx = (a) + (g) + (s) - 2; \
99 ALLOC_##categ##_hst[((__idx > 4) ? 4 : __idx)] += 1;}
101 /* Some hard-to-account-for words are allocated by/for primitives,
102 * includes Integer support. ALLOC_PRIM2 tells us about these. We
103 * count everything as ``goods'', which is not strictly correct.
104 * (ALLOC_PRIM is the same sort of stuff, but we know the
105 * admin/goods/slop breakdown.)
107 #define TICK_ALLOC_PRIM(a,g,s) \
108 ALLOC_PRIM_ctr++; ALLOC_PRIM_adm += (a); \
109 ALLOC_PRIM_gds += (g); ALLOC_PRIM_slp += (s); \
110 TICK_ALLOC_HISTO(PRIM,a,g,s)
112 #define TICK_ALLOC_PRIM2(w) ALLOC_PRIM_ctr++; ALLOC_PRIM_gds +=(w); \
113 TICK_ALLOC_HISTO(PRIM,0,w,0)
116 /* -----------------------------------------------------------------------------
118 -------------------------------------------------------------------------- */
120 #define TICK_ENT_VIA_NODE() ENT_VIA_NODE_ctr++
122 #define TICK_ENT_THK() ENT_THK_ctr++ /* thunk */
123 #define TICK_ENT_FUN_STD() ENT_FUN_STD_ctr++ /* std entry pt */
124 #define TICK_ENT_FUN_DIRECT(n) ENT_FUN_DIRECT_ctr++ /* fast entry pt */
126 #define TICK_ENT_CON(n) ENT_CON_ctr++ /* enter constructor */
127 #define TICK_ENT_IND(n) ENT_IND_ctr++ /* enter indirection */
128 #define TICK_ENT_PAP(n) ENT_PAP_ctr++ /* enter PAP */
129 #define TICK_ENT_AP_UPD(n) ENT_AP_UPD_ctr++ /* enter AP_UPD */
130 #define TICK_ENT_BH() ENT_BH_ctr++ /* enter BLACKHOLE */
132 /* -----------------------------------------------------------------------------
134 -------------------------------------------------------------------------- */
136 /* Whenever a ``return'' occurs, it is returning the constituent parts of
137 * a data constructor. The parts can be returned either in registers, or
138 * by allocating some heap to put it in (the TICK_ALLOC_* macros account for
139 * the allocation). The constructor can either be an existing one
140 * *OLD* or we could have {\em just} figured out this stuff
144 #define TICK_RET_HISTO(categ,n) \
147 RET_##categ##_hst[((__idx > 8) ? 8 : __idx)] += 1;}
149 #define TICK_RET_NEW(n) RET_NEW_ctr++; \
150 TICK_RET_HISTO(NEW,n)
152 #define TICK_RET_OLD(n) RET_OLD_ctr++; \
153 TICK_RET_HISTO(OLD,n)
155 #define TICK_RET_UNBOXED_TUP(n) RET_UNBOXED_TUP_ctr++; \
156 TICK_RET_HISTO(UNBOXED_TUP,n)
158 #define TICK_RET_SEMI(n) RET_SEMI_IN_HEAP_ctr++; \
159 TICK_RET_HISTO(SEMI_IN_HEAP,n)
161 #define TICK_RET_SEMI_BY_DEFAULT()/*???*/ RET_SEMI_BY_DEFAULT_ctr++
163 #define TICK_RET_SEMI_FAILED(tag) do { \
164 if ((tag) == INFO_IND_TAG) \
165 RET_SEMI_FAILED_IND_ctr++; \
167 RET_SEMI_FAILED_UNEVAL_ctr++; \
170 #define TICK_VEC_RETURN(n) VEC_RETURN_ctr++; \
171 TICK_RET_HISTO(VEC_RETURN,n)
173 /* -----------------------------------------------------------------------------
177 ------------------ -------------------------------------------
178 TICK_UPDF_PUSHED Update frame pushed
179 TICK_SEQF_PUSHED Seq frame pushed
180 TICK_CATCHF_PUSHED Catch frame pushed
181 TICK_UPDF_OMITTED A thunk decided not to push an update frame
182 TICK_UPDF_RCC_PUSHED Cost Centre restore frame pushed
183 TICK_UPDF_RCC_OMITTED Cost Centres not required -- not pushed
185 -------------------------------------------------------------------------- */
187 #define TICK_UPDF_OMITTED() UPDF_OMITTED_ctr++
188 #define TICK_UPDF_PUSHED() UPDF_PUSHED_ctr++
189 #define TICK_SEQF_PUSHED() SEQF_PUSHED_ctr++
190 #define TICK_CATCHF_PUSHED() CATCHF_PUSHED_ctr++
191 #define TICK_UPDF_RCC_PUSHED() UPDF_RCC_PUSHED_ctr++
192 #define TICK_UPDF_RCC_OMITTED() UPDF_RCC_OMITTED_ctr++
194 /* -----------------------------------------------------------------------------
197 These macros record information when we do an update. We always
198 update either with a data constructor (CON) or a partial application
203 ----------------------- --------------------------------------------
204 TICK_UPD_EXISTING Updating with an indirection to something
206 TICK_UPD_SQUEEZED Same as UPD_EXISTING but because
208 TICK_UPD_CON_IN_NEW Allocating a new CON
209 TICK_UPD_PAP_IN_NEW Allocating a new PAP
210 TICK_UPD_PAP_IN_PLACE Updating with a PAP in place
212 -------------------------------------------------------------------------- */
214 #define TICK_UPD_HISTO(categ,n) \
217 UPD_##categ##_hst[((__idx > 8) ? 8 : __idx)] += 1;}
219 #define TICK_UPD_EXISTING() UPD_EXISTING_ctr++
220 #define TICK_UPD_SQUEEZED() UPD_SQUEEZED_ctr++
222 #define TICK_UPD_CON_IN_NEW(n) UPD_CON_IN_NEW_ctr++ ; \
223 TICK_UPD_HISTO(CON_IN_NEW,n)
225 #define TICK_UPD_PAP_IN_NEW(n) UPD_PAP_IN_NEW_ctr++ ; \
226 TICK_UPD_HISTO(PAP_IN_NEW,n)
228 #define TICK_UPD_PAP_IN_PLACE() UPD_PAP_IN_PLACE_ctr++
230 /* For the generational collector:
232 #define TICK_UPD_NEW_IND() UPD_NEW_IND_ctr++
233 #define TICK_UPD_OLD_IND() UPD_OLD_IND_ctr++
235 /* -----------------------------------------------------------------------------
236 Garbage collection counters
237 -------------------------------------------------------------------------- */
241 * GC_SEL_ABANDONED: we could've done the selection, but we gave up
242 * (e.g., to avoid overflowing the C stack); GC_SEL_MINOR: did a
243 * selection in a minor GC; GC_SEL_MAJOR: ditto, but major GC.
245 #define TICK_GC_SEL_ABANDONED() GC_SEL_ABANDONED_ctr++
246 #define TICK_GC_SEL_MINOR() GC_SEL_MINOR_ctr++
247 #define TICK_GC_SEL_MAJOR() GC_SEL_MAJOR_ctr++
249 /* Failed promotion: we wanted to promote an object early, but
250 * it had already been evacuated to (or resided in) a younger
253 #define TICK_GC_FAILED_PROMOTION() GC_FAILED_PROMOTION_ctr++
255 /* Bytes copied: this is a fairly good measure of GC cost and depends
256 * on all sorts of things like number of generations, aging, eager
257 * promotion, generation sizing policy etc.
259 #define TICK_GC_WORDS_COPIED(n) GC_WORDS_COPIED_ctr+=(n)
261 /* -----------------------------------------------------------------------------
262 The accumulators (extern decls)
263 -------------------------------------------------------------------------- */
266 #define INIT(ializer) = ializer
269 #define INIT(ializer)
270 #define EXTERN extern
273 EXTERN unsigned long ALLOC_HEAP_ctr INIT(0);
274 EXTERN unsigned long ALLOC_HEAP_tot INIT(0);
276 EXTERN unsigned long ALLOC_FUN_ctr INIT(0);
277 EXTERN unsigned long ALLOC_FUN_adm INIT(0);
278 EXTERN unsigned long ALLOC_FUN_gds INIT(0);
279 EXTERN unsigned long ALLOC_FUN_slp INIT(0);
280 EXTERN unsigned long ALLOC_FUN_hst[5]
282 = {0,0,0,0,0} /* urk, can't use INIT macro 'cause of the commas */
286 EXTERN unsigned long ALLOC_THK_ctr INIT(0);
287 EXTERN unsigned long ALLOC_THK_adm INIT(0);
288 EXTERN unsigned long ALLOC_THK_gds INIT(0);
289 EXTERN unsigned long ALLOC_THK_slp INIT(0);
290 EXTERN unsigned long ALLOC_THK_hst[5]
296 EXTERN unsigned long ALLOC_CON_ctr INIT(0);
297 EXTERN unsigned long ALLOC_CON_adm INIT(0);
298 EXTERN unsigned long ALLOC_CON_gds INIT(0);
299 EXTERN unsigned long ALLOC_CON_slp INIT(0);
300 EXTERN unsigned long ALLOC_CON_hst[5]
306 EXTERN unsigned long ALLOC_TUP_ctr INIT(0);
307 EXTERN unsigned long ALLOC_TUP_adm INIT(0);
308 EXTERN unsigned long ALLOC_TUP_gds INIT(0);
309 EXTERN unsigned long ALLOC_TUP_slp INIT(0);
310 EXTERN unsigned long ALLOC_TUP_hst[5]
316 EXTERN unsigned long ALLOC_BH_ctr INIT(0);
317 EXTERN unsigned long ALLOC_BH_adm INIT(0);
318 EXTERN unsigned long ALLOC_BH_gds INIT(0);
319 EXTERN unsigned long ALLOC_BH_slp INIT(0);
320 EXTERN unsigned long ALLOC_BH_hst[5]
326 EXTERN unsigned long ALLOC_PRIM_ctr INIT(0);
327 EXTERN unsigned long ALLOC_PRIM_adm INIT(0);
328 EXTERN unsigned long ALLOC_PRIM_gds INIT(0);
329 EXTERN unsigned long ALLOC_PRIM_slp INIT(0);
330 EXTERN unsigned long ALLOC_PRIM_hst[5]
336 EXTERN unsigned long ALLOC_UPD_PAP_ctr INIT(0);
337 EXTERN unsigned long ALLOC_UPD_PAP_adm INIT(0);
338 EXTERN unsigned long ALLOC_UPD_PAP_gds INIT(0);
339 EXTERN unsigned long ALLOC_UPD_PAP_slp INIT(0);
340 EXTERN unsigned long ALLOC_UPD_PAP_hst[5]
346 EXTERN unsigned long ALLOC_TSO_ctr INIT(0);
347 EXTERN unsigned long ALLOC_TSO_adm INIT(0);
348 EXTERN unsigned long ALLOC_TSO_gds INIT(0);
349 EXTERN unsigned long ALLOC_TSO_slp INIT(0);
350 EXTERN unsigned long ALLOC_TSO_hst[5]
357 EXTERN unsigned long ALLOC_FMBQ_ctr INIT(0);
358 EXTERN unsigned long ALLOC_FMBQ_adm INIT(0);
359 EXTERN unsigned long ALLOC_FMBQ_gds INIT(0);
360 EXTERN unsigned long ALLOC_FMBQ_slp INIT(0);
361 EXTERN unsigned long ALLOC_FMBQ_hst[5]
367 EXTERN unsigned long ALLOC_FME_ctr INIT(0);
368 EXTERN unsigned long ALLOC_FME_adm INIT(0);
369 EXTERN unsigned long ALLOC_FME_gds INIT(0);
370 EXTERN unsigned long ALLOC_FME_slp INIT(0);
371 EXTERN unsigned long ALLOC_FME_hst[5]
377 EXTERN unsigned long ALLOC_BF_ctr INIT(0);
378 EXTERN unsigned long ALLOC_BF_adm INIT(0);
379 EXTERN unsigned long ALLOC_BF_gds INIT(0);
380 EXTERN unsigned long ALLOC_BF_slp INIT(0);
381 EXTERN unsigned long ALLOC_BF_hst[5]
388 EXTERN unsigned long ENT_VIA_NODE_ctr INIT(0);
389 EXTERN unsigned long ENT_THK_ctr INIT(0);
390 EXTERN unsigned long ENT_FUN_STD_ctr INIT(0);
391 EXTERN unsigned long ENT_FUN_DIRECT_ctr INIT(0);
392 EXTERN unsigned long ENT_CON_ctr INIT(0);
393 EXTERN unsigned long ENT_IND_ctr INIT(0);
394 EXTERN unsigned long ENT_PAP_ctr INIT(0);
395 EXTERN unsigned long ENT_AP_UPD_ctr INIT(0);
396 EXTERN unsigned long ENT_BH_ctr INIT(0);
398 EXTERN unsigned long RET_NEW_ctr INIT(0);
399 EXTERN unsigned long RET_OLD_ctr INIT(0);
400 EXTERN unsigned long RET_UNBOXED_TUP_ctr INIT(0);
401 EXTERN unsigned long RET_SEMI_BY_DEFAULT_ctr INIT(0);
402 EXTERN unsigned long RET_SEMI_IN_HEAP_ctr INIT(0);
403 EXTERN unsigned long RET_SEMI_FAILED_IND_ctr INIT(0);
404 EXTERN unsigned long RET_SEMI_FAILED_UNEVAL_ctr INIT(0);
406 EXTERN unsigned long VEC_RETURN_ctr INIT(0);
408 EXTERN unsigned long RET_NEW_hst[9]
410 = {0,0,0,0,0,0,0,0,0}
413 EXTERN unsigned long RET_OLD_hst[9]
415 = {0,0,0,0,0,0,0,0,0}
418 EXTERN unsigned long RET_UNBOXED_TUP_hst[9]
420 = {0,0,0,0,0,0,0,0,0}
423 EXTERN unsigned long RET_SEMI_IN_HEAP_hst[9]
425 = {0,0,0,0,0,0,0,0,0}
428 EXTERN unsigned long RET_VEC_RETURN_hst[9]
430 = {0,0,0,0,0,0,0,0,0}
434 EXTERN unsigned long RET_SEMI_loads_avoided INIT(0);
436 EXTERN unsigned long UPDF_OMITTED_ctr INIT(0);
437 EXTERN unsigned long UPDF_PUSHED_ctr INIT(0);
438 EXTERN unsigned long SEQF_PUSHED_ctr INIT(0);
439 EXTERN unsigned long CATCHF_PUSHED_ctr INIT(0);
440 EXTERN unsigned long UPDF_RCC_PUSHED_ctr INIT(0);
441 EXTERN unsigned long UPDF_RCC_OMITTED_ctr INIT(0);
443 EXTERN unsigned long UPD_EXISTING_ctr INIT(0);
444 EXTERN unsigned long UPD_SQUEEZED_ctr INIT(0);
445 EXTERN unsigned long UPD_CON_IN_NEW_ctr INIT(0);
446 EXTERN unsigned long UPD_PAP_IN_NEW_ctr INIT(0);
447 EXTERN unsigned long UPD_PAP_IN_PLACE_ctr INIT(0);
449 EXTERN unsigned long UPD_CON_IN_NEW_hst[9]
451 = {0,0,0,0,0,0,0,0,0}
454 EXTERN unsigned long UPD_PAP_IN_NEW_hst[9]
456 = {0,0,0,0,0,0,0,0,0}
460 EXTERN unsigned long UPD_NEW_IND_ctr INIT(0);
461 EXTERN unsigned long UPD_OLD_IND_ctr INIT(0);
463 EXTERN unsigned long GC_SEL_ABANDONED_ctr INIT(0);
464 EXTERN unsigned long GC_SEL_MINOR_ctr INIT(0);
465 EXTERN unsigned long GC_SEL_MAJOR_ctr INIT(0);
467 EXTERN unsigned long GC_FAILED_PROMOTION_ctr INIT(0);
469 EXTERN unsigned long GC_WORDS_COPIED_ctr INIT(0);
474 /* -----------------------------------------------------------------------------
475 Just stubs if no ticky-ticky profiling
476 -------------------------------------------------------------------------- */
478 #else /* !TICKY_TICKY */
480 #define TICK_ALLOC_HEAP(words)
482 #define TICK_ALLOC_FUN(g,s)
483 #define TICK_ALLOC_THK(g,s)
484 #define TICK_ALLOC_CON(g,s)
485 #define TICK_ALLOC_TUP(g,s)
486 #define TICK_ALLOC_BH(g,s)
487 #define TICK_ALLOC_UPD_PAP(g,s)
488 #define TICK_ALLOC_TSO(g,s)
489 #define TICK_ALLOC_FMBQ(a,g,s)
490 #define TICK_ALLOC_FME(a,g,s)
491 #define TICK_ALLOC_BF(a,g,s)
492 #define TICK_ALLOC_PRIM(a,g,s)
493 #define TICK_ALLOC_PRIM2(w)
495 #define TICK_ENT_VIA_NODE()
497 #define TICK_ENT_THK()
498 #define TICK_ENT_FUN_STD()
499 #define TICK_ENT_FUN_DIRECT(n)
501 #define TICK_ENT_CON(n)
502 #define TICK_ENT_IND(n)
503 #define TICK_ENT_PAP(n)
504 #define TICK_ENT_AP_UPD(n)
505 #define TICK_ENT_BH()
507 #define TICK_RET_NEW(n)
508 #define TICK_RET_OLD(n)
509 #define TICK_RET_UNBOXED_TUP(n)
510 #define TICK_RET_SEMI(n)
511 #define TICK_RET_SEMI_BY_DEFAULT()
512 #define TICK_RET_SEMI_FAILED(tag)
513 #define TICK_VEC_RETURN(n)
515 #define TICK_UPDF_OMITTED()
516 #define TICK_UPDF_PUSHED()
517 #define TICK_SEQF_PUSHED()
518 #define TICK_CATCHF_PUSHED()
519 #define TICK_UPDF_RCC_PUSHED()
520 #define TICK_UPDF_RCC_OMITTED()
522 #define TICK_UPD_EXISTING()
523 #define TICK_UPD_SQUEEZED()
524 #define TICK_UPD_CON_IN_NEW(n)
525 #define TICK_UPD_PAP_IN_NEW(n)
526 #define TICK_UPD_PAP_IN_PLACE()
528 #define TICK_UPD_NEW_IND()
529 #define TICK_UPD_OLD_IND()
531 #define TICK_GC_SEL_ABANDONED()
532 #define TICK_GC_SEL_MINOR()
533 #define TICK_GC_SEL_MAJOR()
535 #define TICK_GC_FAILED_PROMOTION()
536 #define TICK_GC_WORDS_COPIED(n)
538 #endif /* !TICKY_TICKY */