Added CSE debug option
[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_STRENGTH_RED,        /**< strenght reduction */
53   STAT_OPT_ARCH_DEP,            /**< architecture dependant optimization */
54   STAT_LOWERED,                 /**< lowered */
55
56   STAT_OPT_MAX
57 } stat_opt_kind;
58
59 /**
60  * initialize the statistics module.
61  *
62  * @param enable_options  Bitmask containing the statistic options
63  */
64 void init_stat(unsigned enable_options);
65
66 /**
67  * A new IR op is registered.
68  */
69 void stat_new_ir_op(const ir_op *op);
70
71 /**
72  * An IR op is freed.
73  */
74 void stat_free_ir_op(const ir_op *op);
75
76 /**
77  * A new node is created.
78  */
79 void stat_new_node(ir_node *node);
80
81 /**
82  * A node is changed into a Id node
83  */
84 void stat_turn_into_id(ir_node *node);
85
86 /**
87  * A new graph was created
88  */
89 void stat_new_graph(ir_graph *irg, entity *ent);
90
91 /**
92  * A graph was deleted
93  */
94 void stat_free_graph(ir_graph *irg);
95
96 /**
97  * A walk over a graph is initiated
98  */
99 void stat_irg_walk(ir_graph *irg, void *pre, void *post);
100
101 /**
102  * A walk over a graph in block-wise order is initiated
103  */
104 void stat_irg_walk_blkwise(ir_graph *irg, void *pre, void *post);
105
106 /**
107  * A walk over the graph's blocks is initiated
108  */
109 void stat_irg_block_walk(ir_graph *irg, const ir_node *node, void *pre, void *post);
110
111 /**
112  * Some nodes were optimized into some others due to an optimization
113  */
114 void stat_merge_nodes(
115     ir_node **new_node_array, int new_num_entries,
116     ir_node **old_node_array, int old_num_entries,
117     stat_opt_kind opt);
118
119 /**
120  * A node was lowered into other nodes
121  */
122 void stat_lower(ir_node *node);
123
124 /**
125  * A graph was inlined
126  */
127 void stat_inline(ir_node *call, ir_graph *irg);
128
129 /**
130  * A graph with tail-recursions was optimized.
131  */
132 void stat_tail_rec(ir_graph *irg);
133
134 /**
135  * Strength reduction was performed on an iteration variable.
136  */
137 void stat_strength_red(ir_graph *irg, ir_node *strong, ir_node *cmp);
138
139 /**
140  * Start the dead node elimination.
141  */
142 void stat_dead_node_elim_start(ir_graph *irg);
143
144 /**
145  * Stops the dead node elimination.
146  */
147 void stat_dead_node_elim_stop(ir_graph *irg);
148
149 /**
150  * A multiply was replaced by a series of Shifts/Adds/Subs
151  */
152 void stat_arch_dep_replace_mul_with_shifts(ir_node *mul);
153
154 /**
155  * helper: get an ir_op from an opcode
156  *
157  * @param code  the opcode
158  *
159  * @return  The associated ir_op or NULL if the opcode could not be found.
160  */
161 ir_op *stat_get_op_from_opcode(opcode code);
162
163 #else
164
165 #define init_stat(enable_options)
166 #define stat_finish(name)
167 #define stat_new_ir_op(op)
168 #define stat_free_ir_op(op)
169 #define stat_new_node(node)
170 #define stat_turn_into_id(node)
171 #define stat_new_graph(irg, ent)
172 #define stat_free_graph(irg)
173 #define stat_irg_walk(irg, pre, post)
174 #define stat_irg_walk_blkwise(irg, pre, post)
175 #define stat_irg_block_walk(irg, node, pre, post)
176 #define stat_merge_nodes(new_node_array, new_num_entries, old_node_array, old_num_entries, opt)
177 #define stat_lower(node)
178 #define stat_inline(call, irg)
179 #define stat_tail_rec(irg)
180 #define stat_strength_red(irg, strong, cmp)
181 #define stat_dead_node_elim_start(irg)
182 #define stat_dead_node_elim_stop(irg)
183 #define stat_arch_dep_replace_mul_with_shifts(irn)
184
185 #endif
186
187 #endif /* _FIRMSTAT_H_ */