dcbc5302fce3b5dada10dd32849a5c4ed5c0e361
[libfirm] / ir / stat / firmstat.h
1 /*
2  * Project:     libFIRM
3  * File name:   ir/stat/firmstat.h
4  * Purpose:     Statistics for Firm.
5  * Author:      Michael Beck
6  * Created:
7  * CVS-ID:      $Id$
8  * Copyright:   (c) 2004 Universität Karlsruhe
9  * Licence:     This file protected by GPL -  GNU GENERAL PUBLIC LICENSE.
10  */
11 #ifndef _FIRMSTAT_H_
12 #define _FIRMSTAT_H_
13
14 /**
15  * @file firmstat.h
16  */
17 #include "irop.h"
18 #include "irnode.h"
19 #include "irgraph.h"
20
21 /**
22  * Statistic options, can be or'ed.
23  */
24 enum firmstat_options_t {
25   FIRMSTAT_ENABLED         = 0x00000001,        /**< enable statistics */
26   FIRMSTAT_PATTERN_ENABLED = 0x00000002,        /**< enable pattern calculation */
27   FIRMSTAT_COUNT_STRONG_OP = 0x00000004,        /**< if set, count Mul/Div/Mod/DivMod by constant */
28 };
29
30 /**
31  * Finish the statistics.
32  * Never called from libFirm should be called from user.
33  *
34  * @param name   basename of the statistic output file
35  */
36 void stat_finish(const char *name);
37
38 #ifdef FIRM_STATISTICS
39
40 typedef enum {
41   STAT_OPT_STG,                 /**< straightening optimization */
42   STAT_OPT_IFSIM,               /**< if simplification */
43   STAT_OPT_ALGSIM,              /**< algebraic simplification */
44   STAT_OPT_PHI,                 /**< Phi optmization */
45   STAT_OPT_WAW,                 /**< Write-After-Write optimization */
46   STAT_OPT_WAR,                 /**< Write-After-Read optimization */
47   STAT_OPT_RAW,                 /**< Read-After-Write optimization */
48   STAT_OPT_RAR,                 /**< Read-After-Read optimization */
49   STAT_OPT_TUPLE,               /**< Tuple optimization */
50   STAT_OPT_ID,                  /**< ID optimization */
51   STAT_OPT_CONST_EVAL,          /**< constant evaluation */
52   STAT_OPT_CSE,                 /**< common subexpression elimination */
53   STAT_OPT_STRENGTH_RED,        /**< strenght reduction */
54   STAT_OPT_ARCH_DEP,            /**< architecture dependant optimization */
55   STAT_OPT_REASSOC,             /**< reassociation */
56   STAT_LOWERED,                 /**< lowered */
57
58   STAT_OPT_MAX
59 } stat_opt_kind;
60
61 /**
62  * initialize the statistics module.
63  *
64  * @param enable_options  Bitmask containing the statistic options
65  */
66 void init_stat(unsigned enable_options);
67
68 /**
69  * A new IR op is registered.
70  */
71 void stat_new_ir_op(const ir_op *op);
72
73 /**
74  * An IR op is freed.
75  */
76 void stat_free_ir_op(const ir_op *op);
77
78 /**
79  * A new node is created.
80  */
81 void stat_new_node(ir_node *node);
82
83 /**
84  * A node is changed into a Id node
85  */
86 void stat_turn_into_id(ir_node *node);
87
88 /**
89  * A new graph was created
90  */
91 void stat_new_graph(ir_graph *irg, entity *ent);
92
93 /**
94  * A graph was deleted
95  */
96 void stat_free_graph(ir_graph *irg);
97
98 /**
99  * A walk over a graph is initiated
100  */
101 void stat_irg_walk(ir_graph *irg, void *pre, void *post);
102
103 /**
104  * A walk over a graph in block-wise order is initiated
105  */
106 void stat_irg_walk_blkwise(ir_graph *irg, void *pre, void *post);
107
108 /**
109  * A walk over the graph's blocks is initiated
110  */
111 void stat_irg_block_walk(ir_graph *irg, const ir_node *node, void *pre, void *post);
112
113 /**
114  * Some nodes were optimized into some others due to an optimization
115  */
116 void stat_merge_nodes(
117     ir_node **new_node_array, int new_num_entries,
118     ir_node **old_node_array, int old_num_entries,
119     stat_opt_kind opt);
120
121 /**
122  * Reassociation of nodes started/stopped.
123  */
124 void stat_reassociate(int start);
125
126 /**
127  * A node was lowered into other nodes
128  */
129 void stat_lower(ir_node *node);
130
131 /**
132  * A graph was inlined
133  */
134 void stat_inline(ir_node *call, ir_graph *irg);
135
136 /**
137  * A graph with tail-recursions was optimized.
138  */
139 void stat_tail_rec(ir_graph *irg);
140
141 /**
142  * Strength reduction was performed on an iteration variable.
143  */
144 void stat_strength_red(ir_graph *irg, ir_node *strong, ir_node *cmp);
145
146 /**
147  * Start the dead node elimination.
148  */
149 void stat_dead_node_elim_start(ir_graph *irg);
150
151 /**
152  * Stops the dead node elimination.
153  */
154 void stat_dead_node_elim_stop(ir_graph *irg);
155
156 /**
157  * A multiply was replaced by a series of Shifts/Adds/Subs
158  */
159 void stat_arch_dep_replace_mul_with_shifts(ir_node *mul);
160
161 /**
162  * A division was replaced by a series of Shifts/Muls
163  */
164 void stat_arch_dep_replace_div_by_const(ir_node *div);
165
166 /**
167  * A modulo was replaced by a series of Shifts/Muls
168  */
169 void stat_arch_dep_replace_mod_by_const(ir_node *mod);
170
171 /**
172  * A Divod was replaced by a series of Shifts/Muls
173  */
174 void stat_arch_dep_replace_DivMod_by_const(ir_node *divmod);
175
176 /**
177  * helper: get an ir_op from an opcode
178  *
179  * @param code  the opcode
180  *
181  * @return  The associated ir_op or NULL if the opcode could not be found.
182  */
183 ir_op *stat_get_op_from_opcode(opcode code);
184
185 #else
186
187 #define init_stat(enable_options)
188 #define stat_finish(name)
189 #define stat_new_ir_op(op)
190 #define stat_free_ir_op(op)
191 #define stat_new_node(node)
192 #define stat_turn_into_id(node)
193 #define stat_new_graph(irg, ent)
194 #define stat_free_graph(irg)
195 #define stat_irg_walk(irg, pre, post)
196 #define stat_irg_walk_blkwise(irg, pre, post)
197 #define stat_irg_block_walk(irg, node, pre, post)
198 #define stat_merge_nodes(new_node_array, new_num_entries, old_node_array, old_num_entries, opt)
199 #define stat_reassociate(start)
200 #define stat_lower(node)
201 #define stat_inline(call, irg)
202 #define stat_tail_rec(irg)
203 #define stat_strength_red(irg, strong, cmp)
204 #define stat_dead_node_elim_start(irg)
205 #define stat_dead_node_elim_stop(irg)
206 #define stat_arch_dep_replace_mul_with_shifts(irn)
207 #define stat_arch_dep_replace_div_by_const(irn)
208 #define stat_arch_dep_replace_mod_by_const(irn)
209 #define stat_arch_dep_replace_DivMod_by_const(irn)
210
211 #endif
212
213 #endif /* _FIRMSTAT_H_ */