3f32e717de7cf3325120779d89396063dda809b1
[libfirm] / ir / stat / statev.h
1 /*
2  * Copyright (C) 1995-2008 University of Karlsruhe.  All right reserved.
3  *
4  * This file is part of libFirm.
5  *
6  * This file may be distributed and/or modified under the terms of the
7  * GNU General Public License version 2 as published by the Free Software
8  * Foundation and appearing in the file LICENSE.GPL included in the
9  * packaging of this file.
10  *
11  * Licensees holding valid libFirm Professional Edition licenses may use
12  * this file in accordance with the libFirm Commercial License.
13  * Agreement provided with the Software.
14  *
15  * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
16  * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
17  * PURPOSE.
18  */
19
20 /**
21  * @file
22  * @brief       Statistic events.
23  * @author      Sebastian Hack
24  * @date        17.06.2007
25  * @version     $Id$
26  */
27
28 #ifndef FIRM_STATEVENT_H
29 #define FIRM_STATEVENT_H
30
31 #ifndef FIRM_STATISTICS
32
33 #define stat_ev_do(expr)
34 #define stat_ev_if                  if (0)
35 #define stat_ev_dbl(name, val)
36 #define stat_ev_int(name, val)
37 #define stat_ev(name)
38
39 #define stat_ev_cnt_decl(var)
40 #define stat_ev_cnt_inc(var)
41 #define stat_ev_cnt_done(name, var)
42 #define stat_ev_tim_push()
43 #define stat_ev_tim_pop(name)
44
45 #define stat_ev_ctx_push(key)
46 #define stat_ev_ctx_push_str(key, str)
47 #define stat_ev_ctx_push_fmt(key, fmt, value)
48 #define stat_ev_ctx_push_fobj(key, firm_object)
49 #define stat_ev_ctx_pop(key)
50 #define stat_ev_flush()
51
52 #else
53
54 #include <stdio.h>
55 #include "stat_timing.h"
56
57 extern void               stat_ev_printf(char ev_type, const char *key, const char *fmt, ...);
58
59 extern int                stat_ev_enabled;
60 extern int                stat_ev_timer_sp;
61 extern timing_ticks_t     stat_ev_timer_elapsed[];
62 extern timing_ticks_t     stat_ev_timer_start[];
63 extern timing_sched_env_t stat_ev_sched_rt;
64 extern timing_sched_env_t stat_ev_sched_normal;
65
66 static INLINE __attribute__((unused)) void stat_ev_tim_push(void) {
67         timing_ticks_t temp;
68         int sp = stat_ev_timer_sp++;
69         timing_ticks(temp);
70         if (sp == 0)
71                 timing_sched_set(&stat_ev_sched_rt);
72         else {
73                 timing_ticks_sub(temp, stat_ev_timer_start[sp - 1]);
74                 timing_ticks_add(stat_ev_timer_elapsed[sp - 1], temp);
75         }
76         timing_ticks_init(stat_ev_timer_elapsed[sp]);
77         timing_ticks(stat_ev_timer_start[sp]);
78 }
79
80 static INLINE __attribute__((unused)) void stat_ev_tim_pop(const char *name) {
81         int sp;
82         timing_ticks_t temp;
83         timing_ticks(temp);
84         sp = --stat_ev_timer_sp;
85         timing_ticks_sub(temp, stat_ev_timer_start[sp]);
86         timing_ticks_add(stat_ev_timer_elapsed[sp], temp);
87         if (name != NULL && stat_ev_enabled)
88                 stat_ev_printf('E', name, "%g", timing_ticks_dbl(stat_ev_timer_elapsed[sp]));
89         if (sp == 0)
90                 timing_sched_set(&stat_ev_sched_normal);
91         else
92                 timing_ticks(stat_ev_timer_start[sp - 1]);
93 }
94
95 #define stat_ev_ctx_push_fmt(key, fmt, value) \
96         do { \
97                 if (stat_ev_enabled) { \
98                         stat_ev_tim_push(); \
99                         stat_ev_printf('P', key, fmt, (value)); \
100                         stat_ev_tim_pop(NULL); \
101                 } \
102         } while(0)
103
104 #define stat_ev_ctx_pop(key) \
105         do { \
106                 if (stat_ev_enabled) { \
107                         stat_ev_tim_push(); \
108                         stat_ev_printf('O', key, NULL); \
109                         stat_ev_tim_pop(NULL); \
110                 } \
111         } while(0)
112
113 #define stat_ev_emit(name, value) \
114         do { \
115                 if (stat_ev_enabled) { \
116                         stat_ev_tim_push(); \
117                         stat_ev_printf('E', name, "%g", (double) (value)); \
118                         stat_ev_tim_pop(NULL); \
119                 } \
120         } while(0)
121
122 #define stat_ev_ctx_push_fobj(key, firm_object) stat_ev_ctx_push_fmt((key), "%+F", (firm_object))
123 #define stat_ev_ctx_push_str(key, str)          stat_ev_ctx_push_fmt((key), "%s", (str))
124 #define stat_ev_ctx_push(key)                   stat_ev_ctx_push_fmt((key), "X", NULL)
125
126 #define stat_ev_dbl(name, val)      stat_ev_emit((name), (val))
127 #define stat_ev_int(name, val)      stat_ev_dbl((name), (double) (val))
128 #define stat_ev(name)               stat_ev_emit((name), 0.0)
129
130 #define stat_ev_cnt_decl(var)       int stat_ev_cnt_var_ ## var = 0
131 #define stat_ev_cnt_inc(var)        do { ++stat_ev_cnt_var_ ## var; } while(0)
132 #define stat_ev_cnt_done(var, name) stat_ev_emit((name), stat_ev_cnt_var_ ## var)
133
134 #define stat_ev_do(expr)            (stat_ev_enabled ? ((expr), 1) : 0)
135 #define stat_ev_if                  if (stat_ev_enabled)
136
137 /**
138  * Initialize the stat ev machinery.
139  * @param filename_prefix  The prefix of the filename (.ev or .ev.gz will be appended).
140  * @param filter           All pushes, pops and events will be filtered by this.
141  *                         If we have regex support, you can give an extended regex here.
142  *                         If not, each key will be matched against this.
143  *                         Matched means, we look if the key starts with @p filter.
144  *                         If NULL is given, each key passes, ie thefilter is always TRUE.
145  */
146 void stat_ev_begin(const char *filename_prefix, const char *filter);
147 void stat_ev_end(void);
148
149 #define stat_ev_flush()             do { if (stat_ev_enabled) fflush(stat_ev_enabled); } while(0)
150
151 #endif
152
153 #endif /* FIRM_STATEVENT_H */