b14f8dbff13cda366181bc5dca97430bab9c6641
[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 };
28
29 /**
30  * Finish the statistics.
31  * Never called from libFirm should be called from user.
32  *
33  * @param name   basename of the statistic output file
34  */
35 void stat_finish(const char *name);
36
37 #ifdef FIRM_STATISTICS
38
39 typedef enum {
40   STAT_OPT_STG,                 /**< straightening optimization */
41   STAT_OPT_IFSIM,               /**< if simplification */
42   STAT_OPT_ALGSIM,              /**< algebraic simplification */
43   STAT_OPT_PHI,                 /**< Phi optmization */
44   STAT_OPT_WAW,                 /**< Write-After-Write optimization */
45   STAT_OPT_WAR,                 /**< Write-After-Read optimization */
46   STAT_OPT_RAW,                 /**< Read-After-Write optimization */
47   STAT_OPT_RAR,                 /**< Read-After-Read optimization */
48   STAT_OPT_TUPLE,               /**< Tuple optimization */
49   STAT_OPT_ID,                  /**< ID optimization */
50   STAT_OPT_CONST_EVAL,          /**< constant evaluation */
51   STAT_OPT_STRENGTH_RED,        /**< strenght reduction */
52   STAT_LOWERED,                 /**< lowered */
53
54   STAT_OPT_MAX
55 } stat_opt_kind;
56
57 /**
58  * initialize the statistics module.
59  *
60  * @param enable_options  Bitmask containing the statistic options
61  */
62 void init_stat(unsigned enable_options);
63
64 /**
65  * A new IR op is registered.
66  */
67 void stat_new_ir_op(const ir_op *op);
68
69 /**
70  * An IR op is freed.
71  */
72 void stat_free_ir_op(const ir_op *op);
73
74 /**
75  * A new node is created.
76  */
77 void stat_new_node(const ir_node *node);
78
79 /**
80  * A node is changed into a Id node
81  */
82 void stat_turn_into_id(const ir_node *node);
83
84 /**
85  * A new graph was created
86  */
87 void stat_new_graph(ir_graph *irg, entity *ent);
88
89 /**
90  * A graph was deleted
91  */
92 void stat_free_graph(ir_graph *irg);
93
94 /**
95  * A walk over a graph is initiated
96  */
97 void stat_irg_walk(ir_graph *irg, void *pre, void *post);
98
99 /**
100  * A walk over a graph in block-wise order is initiated
101  */
102 void stat_irg_walk_blkwise(ir_graph *irg, void *pre, void *post);
103
104 /**
105  * A walk over the graph's blocks is initiated
106  */
107 void stat_irg_block_walk(ir_graph *irg, const ir_node *node, void *pre, void *post);
108
109 /**
110  * Some nodes were optimized into some others due to an optimization
111  */
112 void stat_merge_nodes(
113     ir_node **new_node_array, int new_num_entries,
114     ir_node **old_node_array, int old_num_entries,
115     stat_opt_kind opt);
116
117 /**
118  * A node was lowered into other nodes
119  */
120 void stat_lower(ir_node *node);
121
122 /**
123  * A graph was inlined
124  */
125 void stat_inline(ir_node *call, ir_graph *irg);
126
127 /**
128  * A graph with tail-recursions was optimized.
129  */
130 void stat_tail_rec(ir_graph *irg);
131
132 /**
133  * Strength reduction was performed on an iteration variable.
134  */
135 void stat_strength_red(ir_graph *irg, ir_node *strong, ir_node *cmp);
136
137 /**
138  * Start the dead node elimination.
139  */
140 void stat_dead_node_elim_start(ir_graph *irg);
141
142 /**
143  * Stops the dead node elimination.
144  */
145 void stat_dead_node_elim_stop(ir_graph *irg);
146
147 /**
148  * helper: get an ir_op from an opcode
149  *
150  * @param code  the opcode
151  *
152  * @return  The associated ir_op or NULL if the opcode could not be found.
153  */
154 ir_op *stat_get_op_from_opcode(opcode code);
155
156 #else
157
158 #define init_stat(enable_options)
159 #define stat_finish(name)
160 #define stat_new_ir_op(op)
161 #define stat_free_ir_op(op)
162 #define stat_new_node(node)
163 #define stat_turn_into_id(node)
164 #define stat_new_graph(irg, ent)
165 #define stat_free_graph(irg)
166 #define stat_irg_walk(irg, pre, post)
167 #define stat_irg_walk_blkwise(irg, pre, post)
168 #define stat_irg_block_walk(irg, node, pre, post)
169 #define stat_merge_nodes(new_node_array, new_num_entries, old_node_array, old_num_entries, opt)
170 #define stat_lower(node)
171 #define stat_inline(call, irg)
172 #define stat_tail_rec(irg)
173 #define stat_strength_red(irg, strong, cmp)
174 #define stat_dead_node_elim_start(irg)
175 #define stat_dead_node_elim_stop(irg)
176
177 #endif
178
179 #endif /* _FIRMSTAT_H_ */