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_be_block_entry_t;
43 typedef pset hmap_reg_pressure_entry_t;
44 typedef pset hmap_perm_stat_entry_t;
45 typedef pset hmap_perm_class_entry_t;
46 typedef pset hmap_ir_op;
47 typedef pset hmap_distrib_entry_t;
50 * An entry in a distribution table
52 typedef struct _distrib_entry_t {
53 counter_t cnt; /**< the current count */
54 const void *object; /**< the object which is counted */
57 /** The type of the hash function for objects in distribution tables. */
58 typedef unsigned (*distrib_hash_fun)(const void *object);
61 * The distribution table.
63 typedef struct _distrib_tbl_t {
64 struct obstack cnts; /**< obstack containing the distrib_entry_t entries */
65 HASH_MAP(distrib_entry_t) *hash_map; /**< the hash map containing the distribution */
66 distrib_hash_fun hash_func; /**< the hash function for object in this distribution */
67 unsigned int_dist; /**< non-zero, if it's a integer distribution */
71 * possible address marker values
74 MARK_ADDRESS_CALC = 1, /**< the node is an address expression */
75 MARK_REF_ADR = 2, /**< the node is referenced by an address expression */
76 MARK_REF_NON_ADR = 4, /**< the node is referenced by a non-address expression */
80 * An entry in the address_mark set
82 typedef struct _address_mark_entry_t {
83 ir_node *node; /**< the node which this entry belongs to, needed for compare */
84 unsigned mark; /**< the mark, a bitmask of enum adr_marker_t */
85 } address_mark_entry_t;
88 * An entry for ir_nodes, used in ir_graph statistics.
90 typedef struct _node_entry_t {
91 counter_t cnt_alive; /**< amount of nodes in this entry */
92 counter_t new_node; /**< amount of new nodes for this entry */
93 counter_t into_Id; /**< amount of nodes that turned into Id's for this entry */
94 const ir_op *op; /**< the op for this entry */
97 enum leaf_call_state_t {
98 LCS_UNKNOWN = 0, /**< state is unknown yet */
99 LCS_LEAF_CALL = 1, /**< only leaf functions will be called */
100 LCS_NON_LEAF_CALL = 2, /**< at least one non-leaf function will be called or indetermined */
104 * Graph counter indexes. The first one are accumulated once, the other are always deleted before an
107 enum graph_counter_names {
108 gcnt_acc_walked, /**< walker walked over the graph, accumulated */
109 gcnt_acc_walked_blocks, /**< walker walked over the graph blocks, accumulated */
110 gcnt_acc_was_inlined, /**< number of times other graph were inlined, accumulated */
111 gcnt_acc_got_inlined, /**< number of times this graph was inlined, accumulated */
112 gcnt_acc_strength_red, /**< number of times strength reduction was successful on this graph, accumulated */
113 gcnt_acc_real_func_call, /**< number real function call optimization, accumulated */
115 /* --- non-accumulated values from here */
116 _gcnt_non_acc, /**< first non-accumulated counter */
118 gcnt_edges = _gcnt_non_acc, /**< number of DF edges in this graph */
119 gcnt_all_calls, /**< number of all calls */
120 gcnt_call_with_cnst_arg, /**< number of calls with const args */
121 gcnt_call_with_all_cnst_arg, /**< number of calls with all const args */
122 gcnt_call_with_local_adr, /**< number of calls with address of local var args */
123 gcnt_indirect_calls, /**< number of indirect calls */
124 gcnt_pure_adr_ops, /**< number of pure address operation */
125 gcnt_all_adr_ops, /**< number of all address operation */
126 gcnt_global_adr, /**< number of global load/store addresses. */
127 gcnt_local_adr, /**< number of local load/store addresses. */
128 gcnt_param_adr, /**< number of parameter load/store addresses. */
129 gcnt_this_adr, /**< number of this load/store addresses. */
130 gcnt_other_adr, /**< number of other load/store addresses. */
131 gcnt_if_conv, /**< number of if conversions */
133 /* --- must be the last enum constant --- */
134 _gcnt_last = gcnt_if_conv + IF_RESULT_LAST /**< number of counters */
138 * An entry for ir_graphs. These numbers are calculated for every IR graph.
140 typedef struct _graph_entry_t {
141 struct obstack recalc_cnts; /**< obstack containing the counters that are recalculated */
142 HASH_MAP(node_entry_t) *opcode_hash; /**< hash map containing the opcode counter */
143 HASH_MAP(block_entry_t) *block_hash; /**< hash map containing the block counter */
144 HASH_MAP(block_entry_t) *extbb_hash; /**< hash map containing the extended block counter */
145 HASH_MAP(be_block_entry_t) *be_block_hash; /**< hash map containing backend block information */
146 counter_t cnt[_gcnt_last]; /**< counter */
147 unsigned num_tail_recursion; /**< number of tail recursion optimizations */
148 HASH_MAP(opt_entry_t) *opt_hash[FS_OPT_MAX]; /**< hash maps containing opcode counter for optimizations */
149 ir_graph *irg; /**< the graph of this object */
150 ir_entity *ent; /**< the entity of this graph if one exists */
151 set *address_mark; /**< a set containing the address marks of the nodes */
152 unsigned is_deleted:1; /**< set if this irg was deleted */
153 unsigned is_leaf:1; /**< set, if this irg is a leaf function */
154 unsigned is_leaf_call:2; /**< set, if this irg calls only leaf functions */
155 unsigned is_recursive:1; /**< set, if this irg has recursive calls */
156 unsigned is_chain_call:1; /**< set, if this irg is a chain call */
157 unsigned is_analyzed:1; /**< helper: set, if this irg was already analysed */
161 * An entry for optimized ir_nodes
163 typedef struct _opt_entry_t {
164 counter_t count; /**< optimization counter */
165 const ir_op *op; /**< the op for this entry */
169 * An entry for register pressure.
171 typedef struct _reg_pressure_entry_t {
172 const char *class_name; /**< name of the register class */
173 int pressure; /**< the register pressure for this class */
174 } reg_pressure_entry_t;
177 * An entry for permutation statistics.
179 typedef struct _perm_stat_entry_t {
180 ir_node *perm; /**< the perm node */
181 int size; /**< complete size */
182 int real_size; /**< number of pairs with different registers */
183 int n_copies; /**< number of copies created for lowering */
184 int n_exchg; /**< number of exchanges created for lowering */
185 distrib_tbl_t *cycles; /**< distribution of cycle lengths */
186 distrib_tbl_t *chains; /**< distribution of chain lengths */
190 * An entry for permutation statistics per class.
192 typedef struct _perm_class_entry_t {
193 const char *class_name; /**< name of the register class */
194 int n_regs; /**< number of register in this class */
195 HASH_MAP(perm_stat_entry_t) *perm_stat; /**< statistics about all perm nodes of this class */
196 } perm_class_entry_t;
199 * An entry for a block or extended block in a ir-graph
201 typedef struct _be_block_entry_t {
202 long block_nr; /**< block nr */
203 distrib_tbl_t *sched_ready; /**< distribution of ready nodes per block */
204 /**< the highest register pressures for this block for each register class */
205 HASH_MAP(reg_pressure_entry_t) *reg_pressure;
206 HASH_MAP(perm_class_entry_t) *perm_class_stat; /**< statistics about perm nodes for each register class */
210 * Block counter indexes. The first one are accumulated once, the other are always deleted before an
213 enum block_counter_names {
214 bcnt_nodes, /**< the counter of nodes in this block */
215 bcnt_edges, /**< the counter of edges in this block */
216 bcnt_in_edges, /**< the counter of edges incoming from other blocks to this block */
217 bcnt_out_edges, /**< the counter of edges outgoing from this block to other blocks */
218 bcnt_phi_data, /**< the counter of data Phi nodes in this block */
220 /* --- must be the last enum constant --- */
221 _bcnt_last /**< number of counters */
225 * An entry for a block or extended block in a ir-graph
227 typedef struct _block_entry_t {
228 counter_t cnt[_bcnt_last]; /**< counter */
229 long block_nr; /**< block nr */
232 /** An entry for an extended block in a ir-graph */
233 typedef block_entry_t extbb_entry_t;
236 * Some potential interesting float values
238 typedef enum _float_classify_t {
239 STAT_FC_0, /**< the float value 0.0 */
240 STAT_FC_1, /**< the float value 1.0 */
241 STAT_FC_2, /**< the float value 2.0 */
242 STAT_FC_0_5, /**< the float value 0.5 */
243 STAT_FC_EXACT, /**< an exact value */
244 STAT_FC_OTHER, /**< all other values */
245 STAT_FC_MAX /**< last value */
251 typedef struct _constant_info_t {
252 counter_t int_bits_count[32]; /**< distribution of bit sizes of integer constants */
253 counter_t floats[STAT_FC_MAX]; /**< floating point constants */
254 counter_t others; /**< all other constants */
258 typedef struct _dumper_t dumper_t;
261 * handler for dumping an IRG
263 * @param dmp the dumper
264 * @param entry the IR-graph hash map entry
266 typedef void (*dump_graph_FUNC)(dumper_t *dmp, graph_entry_t *entry);
269 * handler for dumper a constant info table
271 * @param dmp the dumper
273 typedef void (*dump_const_table_FUNC)(dumper_t *dmp, const constant_info_t *tbl);
276 * dumps the parameter distribution table
278 typedef void (*dump_param_tbl_FUNC)(dumper_t *dmp, const distrib_tbl_t *tbl, graph_entry_t *global);
281 * handler for dumper init
283 * @param dmp the dumper
284 * @param name name of the file to dump to
286 typedef void (*dump_init_FUNC)(dumper_t *dmp, const char *name);
289 * handler for dumper finish
291 * @param dmp the dumper
293 typedef void (*dump_finish_FUNC)(dumper_t *dmp);
298 typedef struct _statistic_info_t {
299 unsigned stat_options; /**< statistic options: field must be first */
300 struct obstack cnts; /**< obstack containing the counters that are incremented */
301 struct obstack be_data; /**< obstack containing backend statistics data */
302 HASH_MAP(graph_entry_t) *irg_hash; /**< hash map containing the counter for irgs */
303 HASH_MAP(ir_op) *ir_op_hash; /**< hash map containing all ir_ops (accessible by op_codes) */
304 pdeq *wait_q; /**< wait queue for leaf call decision */
305 unsigned recursive:1; /**< flag for detecting recursive hook calls */
306 unsigned in_dead_node_elim:1; /**< flag for dead node elimination runs */
307 ir_op *op_Phi0; /**< pseudo op for Phi0 */
308 ir_op *op_PhiM; /**< pseudo op for memory Phi */
309 ir_op *op_ProjM; /**< pseudo op for memory Proj */
310 ir_op *op_MulC; /**< pseudo op for multiplication by const */
311 ir_op *op_DivC; /**< pseudo op for division by const */
312 ir_op *op_ModC; /**< pseudo op for modulo by const */
313 ir_op *op_DivModC; /**< pseudo op for DivMod by const */
314 ir_op *op_SelSel; /**< pseudo op for Sel(Sel) */
315 ir_op *op_SelSelSel; /**< pseudo op for Sel(Sel(Sel)) */
316 dumper_t *dumper; /**< list of dumper */
317 int reassoc_run; /**< if set, reassociation is running */
318 constant_info_t const_info; /**< statistic info for constants */
319 distrib_tbl_t *dist_param_cnt; /**< distributation table for call parameters */
323 * a dumper description
326 dump_graph_FUNC dump_graph; /**< handler for dumping an irg */
327 dump_const_table_FUNC dump_const_tbl; /**< handler for dumping a const table */
328 dump_param_tbl_FUNC dump_param_tbl; /**< handler for dumper the Call parameter table */
329 dump_init_FUNC init; /**< handler for init */
330 dump_finish_FUNC finish; /**< handler for finish */
331 FILE *f; /**< the file to dump to */
332 stat_info_t *status; /**< access to the global status */
333 dumper_t *next; /**< link to the next dumper */
334 pset *func_map; /**< pset containing all registered functions */
335 unsigned tag; /**< the id tag of the dumper */
339 * helper: get an ir_op from an opcode
341 ir_op *stat_get_op_from_opcode(ir_opcode code);
343 /* API for distribution tables */
346 * creates a new distribution table.
348 * @param cmp_func Compare function for objects in the distribution
349 * @param hash_func Hash function for objects in the distribution
351 distrib_tbl_t *stat_new_distrib_tbl(pset_cmp_fun cmp_func, distrib_hash_fun hash_func);
354 * creates a new distribution table for an integer distribution.
356 distrib_tbl_t *stat_new_int_distrib_tbl(void);
359 * destroys a distribution table.
361 void stat_delete_distrib_tbl(distrib_tbl_t *tbl);
364 * adds a new object count into the distribution table.
366 void stat_add_distrib_tbl(distrib_tbl_t *tbl, const void *object, const counter_t *cnt);
369 * adds a new key count into the integer distribution table.
371 void stat_add_int_distrib_tbl(distrib_tbl_t *tbl, int key, const counter_t *cnt);
374 * increases object count by one
376 void stat_inc_distrib_tbl(distrib_tbl_t *tbl, const void *object);
379 * increases key count by one
381 void stat_inc_int_distrib_tbl(distrib_tbl_t *tbl, int key);
384 * inserts a new object with count 0 into the distribution table
385 * if object is already present, nothing happens
387 void stat_insert_distrib_tbl(distrib_tbl_t *tbl, const void *object);
390 * inserts a new key with count 0 into the integer distribution table
391 * if key is already present, nothing happens
393 void stat_insert_int_distrib_tbl(distrib_tbl_t *tbl, int key);
396 * returns the sum over all counters in a distribution table
398 int stat_get_count_distrib_tbl(distrib_tbl_t *tbl);
401 * calculates the mean value of a distribution.
403 double stat_calc_mean_distrib_tbl(distrib_tbl_t *tbl);
406 * calculates the average value of a distribution
408 double stat_calc_avg_distrib_tbl(distrib_tbl_t *tbl);
410 /** evaluates each entry of a distribution table. */
411 typedef void (*eval_distrib_entry_fun)(const distrib_entry_t *entry, void *env);
414 * iterates over all entries in a distribution table
416 void stat_iterate_distrib_tbl(const distrib_tbl_t *tbl, eval_distrib_entry_fun eval, void *env);
419 * update info on Consts.
421 * @param node The Const node
422 * @param graph The graph entry containing the call
424 void stat_update_const(stat_info_t *status, ir_node *node, graph_entry_t *graph);
427 * clears the const statistics for a new snapshot.
429 void stat_const_clear(stat_info_t *status);
432 * initialize the Const statistic.
434 void stat_init_const_cnt(stat_info_t *status);
437 * return a human readable name for an float classification
439 const char *stat_fc_name(float_classify_t classification);
442 * Update the register pressure of a block
444 * @param irg the irg containing the block
445 * @param block the block for which the reg pressure should be set
446 * @param pressure the pressure
447 * @param class_name the name of the register class
449 void stat_be_block_regpressure(ir_graph *irg, ir_node *block, int pressure, const char *class_name);
452 * Update the distribution of ready nodes of a block
454 * @param irg the irg containing the block
455 * @param block the block for which the reg pressure should be set
456 * @param num_ready the number of ready nodes
458 void stat_be_block_sched_ready(ir_graph *irg, ir_node *block, int num_ready);
461 * Update the permutation statistic of a block
463 * @param class_name the name of the register class
464 * @param perm the perm node
465 * @param block the block containing the perm
466 * @param size the size of the perm
467 * @param real_size number of pairs with different registers
469 void stat_be_block_stat_perm(const char *class_name, int n_regs, ir_node *perm, ir_node *block,
470 int size, int real_size);
473 * Update the permutation statistic of a single perm
475 * @param class_name the name of the register class
476 * @param perm the perm node
477 * @param block the block containing the perm
478 * @param is_chain 1 if chain, 0 if cycle
479 * @param size length of the cycle/chain
480 * @param n_ops the number of ops representing this cycle/chain after lowering
482 void stat_be_block_stat_permcycle(const char *class_name, ir_node *perm, ir_node *block,
483 int is_chain, int size, int n_ops);
486 * Register an additional function for all dumper. This function
487 * is called in dump_snapshot once for each graph_entry and dumper.
489 * @param func the dump function to register
491 void stat_register_dumper_func(dump_graph_FUNC func);
493 #endif /* _FIRMSTAT_T_H_ */