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"
30 /* some useful macro. */
31 #define ARR_SIZE(a) (sizeof(a)/sizeof((a)[0]))
34 * just be make some things clear :-), the
37 #define HASH_MAP(type) hmap_##type
39 typedef pset hmap_node_entry_t;
40 typedef pset hmap_graph_entry_t;
41 typedef pset hmap_opt_entry_t;
42 typedef pset hmap_block_entry_t;
43 typedef pset hmap_be_block_entry_t;
44 typedef pset hmap_reg_pressure_entry_t;
45 typedef pset hmap_perm_stat_entry_t;
46 typedef pset hmap_perm_class_entry_t;
47 typedef pset hmap_ir_op;
48 typedef pset hmap_distrib_entry_t;
51 * An entry in a distribution table
53 typedef struct _distrib_entry_t {
54 counter_t cnt; /**< the current count */
55 const void *object; /**< the object which is counted */
58 /** The type of the hash function for objects in distribution tables. */
59 typedef unsigned (*distrib_hash_fun)(const void *object);
62 * The distribution table.
64 typedef struct _distrib_tbl_t {
65 struct obstack cnts; /**< obstack containing the distrib_entry_t entries */
66 HASH_MAP(distrib_entry_t) *hash_map; /**< the hash map containing the distribution */
67 distrib_hash_fun hash_func; /**< the hash function for object in this distribution */
68 unsigned int_dist; /**< non-zero, if it's a integer distribution */
72 * possible address marker values
75 MARK_ADDRESS_CALC = 1, /**< the node is an address expression */
76 MARK_REF_ADR = 2, /**< the node is referenced by an address expression */
77 MARK_REF_NON_ADR = 4, /**< the node is referenced by a non-address expression */
81 * An entry in the address_mark set
83 typedef struct _address_mark_entry_t {
84 ir_node *node; /**< the node which this entry belongs to, needed for compare */
85 unsigned mark; /**< the mark, a bitmask of enum adr_marker_t */
86 } address_mark_entry_t;
89 * An entry for ir_nodes, used in ir_graph statistics.
91 typedef struct _node_entry_t {
92 counter_t cnt_alive; /**< amount of nodes in this entry */
93 counter_t new_node; /**< amount of new nodes for this entry */
94 counter_t into_Id; /**< amount of nodes that turned into Id's for this entry */
95 const ir_op *op; /**< the op for this entry */
98 enum leaf_call_state_t {
99 LCS_UNKNOWN = 0, /**< state is unknown yet */
100 LCS_LEAF_CALL = 1, /**< only leaf functions will be called */
101 LCS_NON_LEAF_CALL = 2, /**< at least one non-leaf function will be called or indetermined */
105 * An entry for ir_graphs. These numbers are calculated for every IR graph.
107 typedef struct _graph_entry_t {
108 struct obstack recalc_cnts; /**< obstack containing the counters that are recalculated */
109 HASH_MAP(node_entry_t) *opcode_hash; /**< hash map containing the opcode counter */
110 HASH_MAP(block_entry_t) *block_hash; /**< hash map containing the block counter */
111 HASH_MAP(block_entry_t) *extbb_hash; /**< hash map containing the extended block counter */
112 HASH_MAP(be_block_entry_t) *be_block_hash; /**< hash map containing backend block information */
113 counter_t cnt_walked; /**< walker walked over the graph */
114 counter_t cnt_walked_blocks; /**< walker walked over the graph blocks */
115 counter_t cnt_was_inlined; /**< number of times other graph were inlined */
116 counter_t cnt_got_inlined; /**< number of times this graph was inlined */
117 counter_t cnt_strength_red; /**< number of times strength reduction was successful on this graph */
118 counter_t cnt_edges; /**< number of DF edges in this graph */
119 counter_t cnt_all_calls; /**< number of all calls */
120 counter_t cnt_call_with_cnst_arg; /**< number of calls with const args */
121 counter_t cnt_indirect_calls; /**< number of indirect calls */
122 counter_t cnt_if_conv[IF_RESULT_LAST]; /**< number of if conversions */
123 counter_t cnt_real_func_call; /**< number real function call optimization */
124 unsigned num_tail_recursion; /**< number of tail recursion optimizations */
125 HASH_MAP(opt_entry_t) *opt_hash[FS_OPT_MAX]; /**< hash maps containing opcode counter for optimizations */
126 ir_graph *irg; /**< the graph of this object */
127 entity *ent; /**< the entity of this graph if one exists */
128 set *address_mark; /**< a set containing the address marks of the nodes */
129 unsigned is_deleted:1; /**< set if this irg was deleted */
130 unsigned is_leaf:1; /**< set, if this irg is a leaf function */
131 unsigned is_leaf_call:2; /**< set, if this irg calls only leaf functions */
132 unsigned is_recursive:1; /**< set, if this irg has recursive calls */
133 unsigned is_chain_call:1; /**< set, if this irg is a chain call */
134 unsigned is_analyzed:1; /**< helper: set, if this irg was already analysed */
138 * An entry for optimized ir_nodes
140 typedef struct _opt_entry_t {
141 counter_t count; /**< optimization counter */
142 const ir_op *op; /**< the op for this entry */
146 * An entry for register pressure.
148 typedef struct _reg_pressure_entry_t {
149 ident *id_name; /**< name of the register class */
150 int pressure; /**< the register pressure for this class */
151 } reg_pressure_entry_t;
154 * An entry for permutation statistics.
156 typedef struct _perm_stat_entry_t {
157 ir_node *perm; /**< the perm node */
158 int size; /**< complete size */
159 int real_size; /**< number of pairs with different registers */
160 int n_copies; /**< number of copies created for lowering */
161 int n_exchg; /**< number of exchanges created for lowering */
162 distrib_tbl_t *cycles; /**< distribution of cycle lengths */
163 distrib_tbl_t *chains; /**< distribution of chain lengths */
167 * An entry for permutation statistics per class.
169 typedef struct _perm_class_entry_t {
170 ident *id_name; /**< name of the register class */
171 int n_regs; /**< number of register in this class */
172 HASH_MAP(perm_stat_entry_t) *perm_stat; /**< statistics about all perm nodes of this class */
173 } perm_class_entry_t;
176 * An entry for a block or extended block in a ir-graph
178 typedef struct _be_block_entry_t {
179 long block_nr; /**< block nr */
180 distrib_tbl_t *sched_ready; /**< distribution of ready nodes per block */
181 /**< the highest register pressures for this block for each register class */
182 HASH_MAP(reg_pressure_entry_t) *reg_pressure;
183 HASH_MAP(perm_class_entry_t) *perm_class_stat; /**< statistics about perm nodes for each register class */
187 * An entry for a block or extended block in a ir-graph
189 typedef struct _block_entry_t {
190 counter_t cnt_nodes; /**< the counter of nodes in this block */
191 counter_t cnt_edges; /**< the counter of edges in this block */
192 counter_t cnt_in_edges; /**< the counter of edges incoming from other blocks to this block */
193 counter_t cnt_out_edges; /**< the counter of edges outgoing from this block to other blocks */
194 counter_t cnt_phi_data; /**< the counter of data Phi nodes in this block */
195 long block_nr; /**< block nr */
198 /** An entry for an extended block in a ir-graph */
199 typedef block_entry_t extbb_entry_t;
202 * Some potential interesting float values
204 typedef enum _float_classify_t {
205 STAT_FC_0, /**< the float value 0.0 */
206 STAT_FC_1, /**< the float value 1.0 */
207 STAT_FC_2, /**< the float value 2.0 */
208 STAT_FC_0_5, /**< the float value 0.5 */
209 STAT_FC_EXACT, /**< an exact value */
210 STAT_FC_OTHER, /**< all other values */
211 STAT_FC_MAX /**< last value */
217 typedef struct _constant_info_t {
218 counter_t int_bits_count[32]; /**< distribution of bit sizes of integer constants */
219 counter_t floats[STAT_FC_MAX]; /**< floating point constants */
220 counter_t others; /**< all other constants */
224 typedef struct _dumper_t dumper_t;
227 * handler for dumping an IRG
229 * @param dmp the dumper
230 * @param entry the IR-graph hash map entry
232 typedef void (*dump_graph_FUNC)(dumper_t *dmp, graph_entry_t *entry);
235 * handler for dumper init
237 * @param dmp the dumper
238 * @param name name of the file to dump to
240 typedef void (*dump_init_FUNC)(dumper_t *dmp, const char *name);
243 * handler for dumper a constant info table
245 * @param dmp the dumper
247 typedef void (*dump_const_table_FUNC)(dumper_t *dmp, const constant_info_t *tbl);
250 * handler for dumper finish
252 * @param dmp the dumper
254 typedef void (*dump_finish_FUNC)(dumper_t *dmp);
259 typedef struct _statistic_info_t {
260 unsigned stat_options; /**< statistic options: field must be first */
261 struct obstack cnts; /**< obstack containing the counters that are incremented */
262 struct obstack be_data; /**< obstack containing backend statistics data */
263 HASH_MAP(graph_entry_t) *irg_hash; /**< hash map containing the counter for irgs */
264 HASH_MAP(ir_op) *ir_op_hash; /**< hash map containing all ir_ops (accessible by op_codes) */
265 pdeq *wait_q; /**< wait queue for leaf call decision */
266 int recursive; /**< flag for detecting recursive hook calls */
267 int in_dead_node_elim; /**< set, if dead node elimination runs */
268 ir_op *op_Phi0; /**< pseudo op for Phi0 */
269 ir_op *op_PhiM; /**< pseudo op for memory Phi */
270 ir_op *op_ProjM; /**< pseudo op for memory Proj */
271 ir_op *op_MulC; /**< pseudo op for multiplication by const */
272 ir_op *op_DivC; /**< pseudo op for division by const */
273 ir_op *op_ModC; /**< pseudo op for modulo by const */
274 ir_op *op_DivModC; /**< pseudo op for DivMod by const */
275 ir_op *op_SelSel; /**< pseudo op for Sel(Sel) */
276 ir_op *op_SelSelSel; /**< pseudo op for Sel(Sel(Sel)) */
277 dumper_t *dumper; /**< list of dumper */
278 int reassoc_run; /**< if set, reassociation is running */
279 constant_info_t const_info; /**< statistic info for constants */
283 * a dumper description
286 dump_graph_FUNC dump_graph; /**< handler for dumping an irg */
287 dump_const_table_FUNC dump_const_tbl; /**< handler for dumping a const table */
288 dump_init_FUNC init; /**< handler for init */
289 dump_finish_FUNC finish; /**< handler for finish */
290 FILE *f; /**< the file to dump to */
291 stat_info_t *status; /**< access to the global status */
292 dumper_t *next; /**< link to the next dumper */
296 * helper: get an ir_op from an opcode
298 ir_op *stat_get_op_from_opcode(opcode code);
300 /* API for distribution tables */
303 * creates a new distribution table.
305 * @param cmp_func Compare function for objects in the distribution
306 * @param hash_func Hash function for objects in the distribution
308 distrib_tbl_t *stat_new_distrib_tbl(pset_cmp_fun cmp_func, distrib_hash_fun hash_func);
311 * creates a new distribution table for an integer distribution.
313 distrib_tbl_t *stat_new_int_distrib_tbl(void);
316 * destroys a distribution table.
318 void stat_delete_distrib_tbl(distrib_tbl_t *tbl);
321 * adds a new object count into the distribution table.
323 void stat_add_distrib_tbl(distrib_tbl_t *tbl, const void *object, const counter_t *cnt);
326 * adds a new key count into the integer distribution table.
328 void stat_add_int_distrib_tbl(distrib_tbl_t *tbl, int key, const counter_t *cnt);
331 * calculates the mean value of a distribution.
333 double stat_calc_mean_distrib_tbl(distrib_tbl_t *tbl);
336 * calculates the average value of a distribution
338 double stat_calc_avg_distrib_tbl(distrib_tbl_t *tbl);
340 /** evaluates each entry of a distribution table. */
341 typedef void (*eval_distrib_entry_fun)(const distrib_entry_t *entry, void *env);
344 * iterates over all entries in a distribution table
346 void stat_iterate_distrib_tbl(distrib_tbl_t *tbl, eval_distrib_entry_fun eval, void *env);
349 * update info on Consts.
351 * @param node The Const node
352 * @param graph The graph entry containing the call
354 void stat_update_const(stat_info_t *status, ir_node *node, graph_entry_t *graph);
357 * clears the const statistics for a new snapshot.
359 void stat_const_clear(stat_info_t *status);
362 * initialize the Const statistic.
364 void stat_init_const_cnt(stat_info_t *status);
367 * return a human readable name for an float classification
369 const char *stat_fc_name(float_classify_t classification);
371 #endif /* _FIRMSTAT_T_H_ */