3 * File name: ir/stat/firmstat_t.h
4 * Purpose: Statistics for Firm. Internal data structures.
8 * Copyright: (c) 2004 Universität Karlsruhe
9 * Licence: This file protected by GPL - GNU GENERAL PUBLIC LICENSE.
11 #ifndef _FIRMSTAT_T_H_
12 #define _FIRMSTAT_T_H_
21 #include "irgraph_t.h"
29 /* some useful macro. */
30 #define ARR_SIZE(a) (sizeof(a)/sizeof((a)[0]))
33 * just be make some things clear :-), the
36 #define HASH_MAP(type) hmap_##type
38 typedef pset hmap_node_entry_t;
39 typedef pset hmap_graph_entry_t;
40 typedef pset hmap_opt_entry_t;
41 typedef pset hmap_block_entry_t;
42 typedef pset hmap_ir_op;
43 typedef pset hmap_distrib_entry_t;
46 * possible address marker values
49 MARK_ADDRESS_CALC = 1, /**< the node is an address expression */
50 MARK_REF_ADR = 2, /**< the node is referenced by an address expression */
51 MARK_REF_NON_ADR = 4, /**< the node is referenced by a non-address expression */
55 * An entry in the address_mark set
57 typedef struct _address_mark_entry_t {
58 ir_node *node; /**< the node which this entry belongs to, needed for compare */
59 unsigned mark; /**< the mark, a bitmask of enum adr_marker_t */
60 } address_mark_entry_t;
63 * An entry for ir_nodes, used in ir_graph statistics.
65 typedef struct _node_entry_t {
66 counter_t cnt_alive; /**< amount of nodes in this entry */
67 counter_t new_node; /**< amount of new nodes for this entry */
68 counter_t into_Id; /**< amount of nodes that turned into Id's for this entry */
69 const ir_op *op; /**< the op for this entry */
72 enum leaf_call_state_t {
73 LCS_UNKNOWN = 0, /**< state is unknown yet */
74 LCS_LEAF_CALL = 1, /**< only leaf functions will be called */
75 LCS_NON_LEAF_CALL = 2, /**< at least one non-leaf function will be called or indetermined */
79 * An entry for ir_graphs. These numbers are calculated for every IR graph.
81 typedef struct _graph_entry_t {
82 HASH_MAP(node_entry_t) *opcode_hash; /**< hash map containing the opcode counter */
83 HASH_MAP(block_entry_t) *block_hash; /**< hash map containing the block counter */
84 HASH_MAP(block_entry_t) *extbb_hash; /**< hash map containing the extended block counter */
85 counter_t cnt_walked; /**< walker walked over the graph */
86 counter_t cnt_walked_blocks; /**< walker walked over the graph blocks */
87 counter_t cnt_was_inlined; /**< number of times other graph were inlined */
88 counter_t cnt_got_inlined; /**< number of times this graph was inlined */
89 counter_t cnt_strength_red; /**< number of times strength reduction was successful on this graph */
90 counter_t cnt_edges; /**< number of DF edges in this graph */
91 counter_t cnt_all_calls; /**< number of all calls */
92 counter_t cnt_call_with_cnst_arg; /**< number of calls with const args */
93 counter_t cnt_indirect_calls; /**< number of indirect calls */
94 counter_t cnt_if_conv[IF_RESULT_LAST]; /**< number of if conversions */
95 counter_t cnt_real_func_call; /**< number real function call optimization */
96 unsigned num_tail_recursion; /**< number of tail recursion optimizations */
97 HASH_MAP(opt_entry_t) *opt_hash[FS_OPT_MAX]; /**< hash maps containing opcode counter for optimizations */
98 ir_graph *irg; /**< the graph of this object */
99 entity *ent; /**< the entity of this graph if one exists */
100 set *address_mark; /**< a set containing the address marks of the nodes */
101 unsigned is_deleted:1; /**< set if this irg was deleted */
102 unsigned is_leaf:1; /**< set, if this irg is a leaf function */
103 unsigned is_leaf_call:2; /**< set, if this irg calls only leaf functions */
104 unsigned is_recursive:1; /**< set, if this irg has recursive calls */
105 unsigned is_chain_call:1; /**< set, if this irg is a chain call */
106 unsigned is_analyzed:1; /**< helper: set, if this irg was already analysed */
110 * An entry for optimized ir_nodes
112 typedef struct _opt_entry_t {
113 counter_t count; /**< optimization counter */
114 const ir_op *op; /**< the op for this entry */
118 * An entry for a block or extended block in a ir-graph
120 typedef struct _block_entry_t {
121 counter_t cnt_nodes; /**< the counter of nodes in this block */
122 counter_t cnt_edges; /**< the counter of edges in this block */
123 counter_t cnt_in_edges; /**< the counter of edges incoming from other blocks to this block */
124 counter_t cnt_out_edges; /**< the counter of edges outgoing from this block to other blocks */
125 counter_t cnt_phi_data; /**< the counter of data Phi nodes in this block */
126 long block_nr; /**< block nr */
129 /** An entry for an extended block in a ir-graph */
130 typedef block_entry_t extbb_entry_t;
133 * Some potential interesting float values
135 typedef enum _float_classify_t {
136 STAT_FC_0, /**< the float value 0.0 */
137 STAT_FC_1, /**< the float value 1.0 */
138 STAT_FC_2, /**< the float value 2.0 */
139 STAT_FC_0_5, /**< the float value 0.5 */
140 STAT_FC_EXACT, /**< an exact value */
141 STAT_FC_OTHER, /**< all other values */
142 STAT_FC_MAX /**< last value */
148 typedef struct _constant_info_t {
149 counter_t int_bits_count[32]; /**< distribution of bit sizes of integer constants */
150 counter_t floats[STAT_FC_MAX]; /**< floating point constants */
151 counter_t others; /**< all other constants */
155 typedef struct _dumper_t dumper_t;
158 * handler for dumping an IRG
160 * @param dmp the dumper
161 * @param entry the IR-graph hash map entry
163 typedef void (*dump_graph_FUNC)(dumper_t *dmp, graph_entry_t *entry);
166 * handler for dumper init
168 * @param dmp the dumper
169 * @param name name of the file to dump to
171 typedef void (*dump_init_FUNC)(dumper_t *dmp, const char *name);
174 * handler for dumper a constant info table
176 * @param dmp the dumper
178 typedef void (*dump_const_table_FUNC)(dumper_t *dmp, const constant_info_t *tbl);
181 * handler for dumper finish
183 * @param dmp the dumper
185 typedef void (*dump_finish_FUNC)(dumper_t *dmp);
190 typedef struct _statistic_info_t {
191 unsigned stat_options; /**< statistic options: field must be first */
192 struct obstack cnts; /**< obstack containing the counters that are incremented */
193 struct obstack recalc_cnts; /**< obstack containing the counters that are recalculated */
194 HASH_MAP(graph_entry_t) *irg_hash; /**< hash map containing the counter for irgs */
195 HASH_MAP(ir_op) *ir_op_hash; /**< hash map containing all ir_ops (accessible by op_codes) */
196 pdeq *wait_q; /**< wait queue for leaf call decision */
197 int recursive; /**< flag for detecting recursive hook calls */
198 int in_dead_node_elim; /**< set, if dead node elimination runs */
199 ir_op *op_Phi0; /**< pseudo op for Phi0 */
200 ir_op *op_PhiM; /**< pseudo op for memory Phi */
201 ir_op *op_ProjM; /**< pseudo op for memory Proj */
202 ir_op *op_MulC; /**< pseudo op for multiplication by const */
203 ir_op *op_DivC; /**< pseudo op for division by const */
204 ir_op *op_ModC; /**< pseudo op for modulo by const */
205 ir_op *op_DivModC; /**< pseudo op for DivMod by const */
206 ir_op *op_SelSel; /**< pseudo op for Sel(Sel) */
207 ir_op *op_SelSelSel; /**< pseudo op for Sel(Sel(Sel)) */
208 dumper_t *dumper; /**< list of dumper */
209 int reassoc_run; /**< if set, reassociation is running */
210 constant_info_t const_info; /**< statistic info for constants */
214 * a dumper description
217 dump_graph_FUNC dump_graph; /**< handler for dumping an irg */
218 dump_const_table_FUNC dump_const_tbl; /**< handler for dumping a const table */
219 dump_init_FUNC init; /**< handler for init */
220 dump_finish_FUNC finish; /**< handler for finish */
221 FILE *f; /**< the file to dump to */
222 stat_info_t *status; /**< access to the global status */
223 dumper_t *next; /**< link to the next dumper */
227 * helper: get an ir_op from an opcode
229 ir_op *stat_get_op_from_opcode(opcode code);
232 * An entry in a distribution table
234 typedef struct _distrib_entry_t {
235 counter_t cnt; /**< the current count */
236 const void *object; /**< the object which is counted */
239 /** The type of the hash function for objects in distribution tables. */
240 typedef unsigned (*distrib_hash_fun)(const void *object);
243 * The distribution table.
245 typedef struct _distrib_tbl_t {
246 struct obstack cnts; /**< obstack containing the distrib_entry_t entries */
247 HASH_MAP(distrib_entry_t) *hash_map; /**< the hash map containing the distribution */
248 distrib_hash_fun hash_func; /**< the hash function for object in this distribution */
249 unsigned int_dist; /**< non-zero, if it's a integer distribution */
252 /* API for distribution tables */
255 * creates a new distribution table.
257 * @param cmp_func Compare function for objects in the distribution
258 * @param hash_func Hash function for objects in the distribution
260 distrib_tbl_t *stat_new_distrib_tbl(pset_cmp_fun cmp_func, distrib_hash_fun hash_func);
263 * creates a new distribution table for an integer distribution.
265 distrib_tbl_t *stat_new_int_distrib_tbl(void);
268 * destroys a distribution table.
270 void stat_delete_distrib_tbl(distrib_tbl_t *tbl);
273 * adds a new object count into the distribution table.
275 void stat_add_distrib_tbl(distrib_tbl_t *tbl, const void *object, const counter_t *cnt);
278 * adds a new key count into the integer distribution table.
280 void stat_add_int_distrib_tbl(distrib_tbl_t *tbl, int key, const counter_t *cnt);
283 * calculates the mean value of a distribution.
285 double stat_calc_mean_distrib_tbl(distrib_tbl_t *tbl);
287 /** evaluates each entry of a distribution table. */
288 typedef void (*eval_distrib_entry_fun)(const distrib_entry_t *entry);
291 * iterates over all entries in a distribution table
293 void stat_iterate_distrib_tbl(distrib_tbl_t *tbl, eval_distrib_entry_fun eval);
296 * update info on Consts.
298 * @param node The Const node
299 * @param graph The graph entry containing the call
301 void stat_update_const(stat_info_t *status, ir_node *node, graph_entry_t *graph);
304 * clears the const statistics for a new snapshot.
306 void stat_const_clear(stat_info_t *status);
309 * initialize the Const statistic.
311 void stat_init_const_cnt(stat_info_t *status);
314 * return a human readable name for an float classification
316 const char *stat_fc_name(float_classify_t classification);
318 #endif /* _FIRMSTAT_T_H_ */