2 * Copyright (C) 1995-2008 University of Karlsruhe. All right reserved.
4 * This file is part of libFirm.
6 * This file may be distributed and/or modified under the terms of the
7 * GNU General Public License version 2 as published by the Free Software
8 * Foundation and appearing in the file LICENSE.GPL included in the
9 * packaging of this file.
11 * Licensees holding valid libFirm Professional Edition licenses may use
12 * this file in accordance with the libFirm Commercial License.
13 * Agreement provided with the Software.
15 * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
16 * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22 * @brief Statistics for Firm. Internal data structures.
23 * @author Michael Beck
26 #ifndef FIRM_STAT_FIRMSTAT_T_H
27 #define FIRM_STAT_FIRMSTAT_T_H
33 #include "irgraph_t.h"
41 /* some useful macro. */
42 #define ARR_SIZE(a) (sizeof(a)/sizeof((a)[0]))
45 * just be make some things clear :-), the
48 #define HASH_MAP(type) hmap_##type
50 typedef pset hmap_node_entry_t;
51 typedef pset hmap_graph_entry_t;
52 typedef pset hmap_opt_entry_t;
53 typedef pset hmap_block_entry_t;
54 typedef pset hmap_be_block_entry_t;
55 typedef pset hmap_reg_pressure_entry_t;
56 typedef pset hmap_perm_stat_entry_t;
57 typedef pset hmap_perm_class_entry_t;
58 typedef pset hmap_ir_op;
59 typedef pset hmap_distrib_entry_t;
62 * An entry in a distribution table
64 typedef struct _distrib_entry_t {
65 counter_t cnt; /**< the current count */
66 const void *object; /**< the object which is counted */
69 /** The type of the hash function for objects in distribution tables. */
70 typedef unsigned (*distrib_hash_fun)(const void *object);
73 * The distribution table.
75 typedef struct _distrib_tbl_t {
76 struct obstack cnts; /**< obstack containing the distrib_entry_t entries */
77 HASH_MAP(distrib_entry_t) *hash_map; /**< the hash map containing the distribution */
78 distrib_hash_fun hash_func; /**< the hash function for object in this distribution */
79 unsigned int_dist; /**< non-zero, if it's a integer distribution */
83 * possible address marker values
86 MARK_ADDRESS_CALC = 1, /**< the node is an address expression */
87 MARK_REF_ADR = 2, /**< the node is referenced by an address expression */
88 MARK_REF_NON_ADR = 4, /**< the node is referenced by a non-address expression */
92 * An entry in the address_mark set
94 typedef struct _address_mark_entry_t {
95 ir_node *node; /**< the node which this entry belongs to, needed for compare */
96 unsigned mark; /**< the mark, a bitmask of enum adr_marker_t */
97 } address_mark_entry_t;
100 * An entry for ir_nodes, used in ir_graph statistics.
102 typedef struct _node_entry_t {
103 counter_t cnt_alive; /**< amount of nodes in this entry */
104 counter_t new_node; /**< amount of new nodes for this entry */
105 counter_t into_Id; /**< amount of nodes that turned into Id's for this entry */
106 const ir_op *op; /**< the op for this entry */
109 enum leaf_call_state_t {
110 LCS_UNKNOWN = 0, /**< state is unknown yet */
111 LCS_LEAF_CALL = 1, /**< only leaf functions will be called */
112 LCS_NON_LEAF_CALL = 2, /**< at least one non-leaf function will be called or indetermined */
116 * Graph counter indexes. The first one are accumulated once, the other are always deleted before an
119 enum graph_counter_names {
120 gcnt_acc_walked, /**< walker walked over the graph, accumulated */
121 gcnt_acc_walked_blocks, /**< walker walked over the graph blocks, accumulated */
122 gcnt_acc_was_inlined, /**< number of times other graph were inlined, accumulated */
123 gcnt_acc_got_inlined, /**< number of times this graph was inlined, accumulated */
124 gcnt_acc_strength_red, /**< number of times strength reduction was successful on this graph, accumulated */
125 gcnt_acc_real_func_call, /**< number real function call optimization, accumulated */
127 /* --- non-accumulated values from here */
128 _gcnt_non_acc, /**< first non-accumulated counter */
130 gcnt_edges = _gcnt_non_acc, /**< number of DF edges in this graph */
131 gcnt_all_calls, /**< number of all calls */
132 gcnt_call_with_cnst_arg, /**< number of calls with const args */
133 gcnt_call_with_all_cnst_arg, /**< number of calls with all const args */
134 gcnt_call_with_local_adr, /**< number of calls with address of local var args */
135 gcnt_indirect_calls, /**< number of indirect calls */
136 gcnt_external_calls, /**< number of external calls */
137 gcnt_pure_adr_ops, /**< number of pure address operation */
138 gcnt_all_adr_ops, /**< number of all address operation */
139 gcnt_global_adr, /**< number of global load/store addresses. */
140 gcnt_local_adr, /**< number of local load/store addresses. */
141 gcnt_param_adr, /**< number of parameter load/store addresses. */
142 gcnt_this_adr, /**< number of this load/store addresses. */
143 gcnt_other_adr, /**< number of other load/store addresses. */
144 gcnt_if_conv, /**< number of if conversions */
146 /* --- must be the last enum constant --- */
147 _gcnt_last = gcnt_if_conv + IF_RESULT_LAST /**< number of counters */
151 * An entry for ir_graphs. These numbers are calculated for every IR graph.
153 typedef struct _graph_entry_t {
154 struct obstack recalc_cnts; /**< obstack containing the counters that are recalculated */
155 HASH_MAP(node_entry_t) *opcode_hash; /**< hash map containing the opcode counter */
156 HASH_MAP(block_entry_t) *block_hash; /**< hash map containing the block counter */
157 HASH_MAP(block_entry_t) *extbb_hash; /**< hash map containing the extended block counter */
158 HASH_MAP(be_block_entry_t) *be_block_hash; /**< hash map containing backend block information */
159 counter_t cnt[_gcnt_last]; /**< counter */
160 unsigned num_tail_recursion; /**< number of tail recursion optimizations */
161 HASH_MAP(opt_entry_t) *opt_hash[FS_OPT_MAX]; /**< hash maps containing opcode counter for optimizations */
162 ir_graph *irg; /**< the graph of this object */
163 ir_entity *ent; /**< the entity of this graph if one exists */
164 set *address_mark; /**< a set containing the address marks of the nodes */
165 unsigned is_deleted:1; /**< set if this irg was deleted */
166 unsigned is_leaf:1; /**< set, if this irg is a leaf function */
167 unsigned is_leaf_call:2; /**< set, if this irg calls only leaf functions */
168 unsigned is_recursive:1; /**< set, if this irg has recursive calls */
169 unsigned is_chain_call:1; /**< set, if this irg is a chain call */
170 unsigned is_analyzed:1; /**< helper: set, if this irg was already analysed */
174 * An entry for optimized ir_nodes
176 typedef struct _opt_entry_t {
177 counter_t count; /**< optimization counter */
178 const ir_op *op; /**< the op for this entry */
182 * An entry for register pressure.
184 typedef struct _reg_pressure_entry_t {
185 const char *class_name; /**< name of the register class */
186 int pressure; /**< the register pressure for this class */
187 } reg_pressure_entry_t;
190 * An entry for permutation statistics.
192 typedef struct _perm_stat_entry_t {
193 ir_node *perm; /**< the perm node */
194 int size; /**< complete size */
195 int real_size; /**< number of pairs with different registers */
196 int n_copies; /**< number of copies created for lowering */
197 int n_exchg; /**< number of exchanges created for lowering */
198 distrib_tbl_t *cycles; /**< distribution of cycle lengths */
199 distrib_tbl_t *chains; /**< distribution of chain lengths */
203 * An entry for permutation statistics per class.
205 typedef struct _perm_class_entry_t {
206 const char *class_name; /**< name of the register class */
207 int n_regs; /**< number of register in this class */
208 HASH_MAP(perm_stat_entry_t) *perm_stat; /**< statistics about all perm nodes of this class */
209 } perm_class_entry_t;
212 * An entry for a block or extended block in a ir-graph
214 typedef struct _be_block_entry_t {
215 long block_nr; /**< block nr */
216 distrib_tbl_t *sched_ready; /**< distribution of ready nodes per block */
217 /**< the highest register pressures for this block for each register class */
218 HASH_MAP(reg_pressure_entry_t) *reg_pressure;
219 HASH_MAP(perm_class_entry_t) *perm_class_stat; /**< statistics about perm nodes for each register class */
223 * Block counter indexes. The first one are accumulated once, the other are always deleted before an
226 enum block_counter_names {
227 bcnt_nodes, /**< the counter of nodes in this block */
228 bcnt_edges, /**< the counter of edges in this block */
229 bcnt_in_edges, /**< the counter of edges incoming from other blocks to this block */
230 bcnt_out_edges, /**< the counter of edges outgoing from this block to other blocks */
231 bcnt_phi_data, /**< the counter of data Phi nodes in this block */
233 /* --- must be the last enum constant --- */
234 _bcnt_last /**< number of counters */
238 * An entry for a block or extended block in a ir-graph
240 typedef struct _block_entry_t {
241 counter_t cnt[_bcnt_last]; /**< counter */
242 long block_nr; /**< block nr */
243 unsigned is_start:1; /**< set, if it's the Start block. */
244 unsigned is_end:1; /**< set, if it's the End block. */
247 /** An entry for an extended block in a ir-graph */
248 typedef block_entry_t extbb_entry_t;
251 * Some potential interesting float values
253 typedef enum _float_classify_t {
254 STAT_FC_0, /**< the float value 0.0 */
255 STAT_FC_1, /**< the float value 1.0 */
256 STAT_FC_2, /**< the float value 2.0 */
257 STAT_FC_0_5, /**< the float value 0.5 */
258 STAT_FC_POWER_OF_TWO, /**< another 2^x value */
259 STAT_FC_OTHER, /**< all other values */
260 STAT_FC_MAX /**< last value */
266 typedef struct _constant_info_t {
267 counter_t int_bits_count[32]; /**< distribution of bit sizes of integer constants */
268 counter_t floats[STAT_FC_MAX]; /**< floating point constants */
269 counter_t others; /**< all other constants */
273 typedef struct _dumper_t dumper_t;
276 * handler for dumping an IRG
278 * @param dmp the dumper
279 * @param entry the IR-graph hash map entry
281 typedef void (*dump_graph_FUNC)(dumper_t *dmp, graph_entry_t *entry);
284 * handler for dumper a constant info table
286 * @param dmp the dumper
288 typedef void (*dump_const_table_FUNC)(dumper_t *dmp, const constant_info_t *tbl);
291 * dumps the parameter distribution table
293 typedef void (*dump_param_tbl_FUNC)(dumper_t *dmp, const distrib_tbl_t *tbl, graph_entry_t *global);
296 * dumps the optimizations counter
298 typedef void (*dump_opt_cnt_FUNC)(dumper_t *dumper, const counter_t *tbl, unsigned len);
301 * handler for dumper init
303 * @param dmp the dumper
304 * @param name name of the file to dump to
306 typedef void (*dump_init_FUNC)(dumper_t *dmp, const char *name);
309 * handler for dumper finish
311 * @param dmp the dumper
313 typedef void (*dump_finish_FUNC)(dumper_t *dmp);
318 typedef struct _statistic_info_t {
319 unsigned stat_options; /**< statistic options: field must be first */
320 struct obstack cnts; /**< obstack containing the counters that are incremented */
321 struct obstack be_data; /**< obstack containing backend statistics data */
322 HASH_MAP(graph_entry_t) *irg_hash; /**< hash map containing the counter for irgs */
323 HASH_MAP(ir_op) *ir_op_hash; /**< hash map containing all ir_ops (accessible by op_codes) */
324 pdeq *wait_q; /**< wait queue for leaf call decision */
325 unsigned recursive:1; /**< flag for detecting recursive hook calls */
326 unsigned in_dead_node_elim:1; /**< flag for dead node elimination runs */
327 ir_op *op_Phi0; /**< pseudo op for Phi0 */
328 ir_op *op_PhiM; /**< pseudo op for memory Phi */
329 ir_op *op_ProjM; /**< pseudo op for memory Proj */
330 ir_op *op_MulC; /**< pseudo op for multiplication by const */
331 ir_op *op_DivC; /**< pseudo op for division by const */
332 ir_op *op_ModC; /**< pseudo op for modulo by const */
333 ir_op *op_DivModC; /**< pseudo op for DivMod by const */
334 ir_op *op_QuotC; /**< pseudo op for floating point division by const */
335 ir_op *op_SelSel; /**< pseudo op for Sel(Sel) */
336 ir_op *op_SelSelSel; /**< pseudo op for Sel(Sel(Sel)) */
337 dumper_t *dumper; /**< list of dumper */
338 int reassoc_run; /**< if set, reassociation is running */
339 constant_info_t const_info; /**< statistic info for constants */
340 distrib_tbl_t *dist_param_cnt; /**< distribution table for call parameters */
342 counter_t num_opts[FS_OPT_MAX];/**< count optimizations */
346 * a dumper description
349 dump_graph_FUNC dump_graph; /**< handler for dumping an irg */
350 dump_const_table_FUNC dump_const_tbl; /**< handler for dumping a const table */
351 dump_param_tbl_FUNC dump_param_tbl; /**< handler for dumping the Call parameter table */
352 dump_opt_cnt_FUNC dump_opt_cnt; /**< handler for dumping the optimization table. */
353 dump_init_FUNC init; /**< handler for init */
354 dump_finish_FUNC finish; /**< handler for finish */
355 FILE *f; /**< the file to dump to */
356 stat_info_t *status; /**< access to the global status */
357 dumper_t *next; /**< link to the next dumper */
358 pset *func_map; /**< pset containing all registered functions */
359 unsigned tag; /**< the id tag of the dumper */
363 * helper: get an ir_op from an opcode
365 ir_op *stat_get_op_from_opcode(ir_opcode code);
367 /* API for distribution tables */
370 * creates a new distribution table.
372 * @param cmp_func Compare function for objects in the distribution
373 * @param hash_func Hash function for objects in the distribution
375 distrib_tbl_t *stat_new_distrib_tbl(pset_cmp_fun cmp_func, distrib_hash_fun hash_func);
378 * creates a new distribution table for an integer distribution.
380 distrib_tbl_t *stat_new_int_distrib_tbl(void);
383 * destroys a distribution table.
385 void stat_delete_distrib_tbl(distrib_tbl_t *tbl);
388 * adds a new object count into the distribution table.
390 void stat_add_distrib_tbl(distrib_tbl_t *tbl, const void *object, const counter_t *cnt);
393 * adds a new key count into the integer distribution table.
395 void stat_add_int_distrib_tbl(distrib_tbl_t *tbl, int key, const counter_t *cnt);
398 * increases object count by one
400 void stat_inc_distrib_tbl(distrib_tbl_t *tbl, const void *object);
403 * increases key count by one
405 void stat_inc_int_distrib_tbl(distrib_tbl_t *tbl, int key);
408 * inserts a new object with count 0 into the distribution table
409 * if object is already present, nothing happens
411 void stat_insert_distrib_tbl(distrib_tbl_t *tbl, const void *object);
414 * inserts a new key with count 0 into the integer distribution table
415 * if key is already present, nothing happens
417 void stat_insert_int_distrib_tbl(distrib_tbl_t *tbl, int key);
420 * returns the sum over all counters in a distribution table
422 int stat_get_count_distrib_tbl(distrib_tbl_t *tbl);
425 * calculates the mean value of a distribution.
427 double stat_calc_mean_distrib_tbl(distrib_tbl_t *tbl);
430 * calculates the average value of a distribution
432 double stat_calc_avg_distrib_tbl(distrib_tbl_t *tbl);
434 /** evaluates each entry of a distribution table. */
435 typedef void (*eval_distrib_entry_fun)(const distrib_entry_t *entry, void *env);
438 * iterates over all entries in a distribution table
440 void stat_iterate_distrib_tbl(const distrib_tbl_t *tbl, eval_distrib_entry_fun eval, void *env);
443 * update info on Consts.
445 * @param node The Const node
446 * @param graph The graph entry containing the call
448 void stat_update_const(stat_info_t *status, ir_node *node, graph_entry_t *graph);
451 * clears the const statistics for a new snapshot.
453 void stat_const_clear(stat_info_t *status);
456 * initialize the Const statistic.
458 void stat_init_const_cnt(stat_info_t *status);
461 * return a human readable name for an float classification
463 const char *stat_fc_name(float_classify_t classification);
466 * Update the register pressure of a block
468 * @param irg the irg containing the block
469 * @param block the block for which the reg pressure should be set
470 * @param pressure the pressure
471 * @param class_name the name of the register class
473 void stat_be_block_regpressure(ir_graph *irg, ir_node *block, int pressure, const char *class_name);
476 * Update the distribution of ready nodes of a block
478 * @param irg the irg containing the block
479 * @param block the block for which the reg pressure should be set
480 * @param num_ready the number of ready nodes
482 void stat_be_block_sched_ready(ir_graph *irg, ir_node *block, int num_ready);
485 * Update the permutation statistic of a block
487 * @param class_name the name of the register class
488 * @param perm the perm node
489 * @param block the block containing the perm
490 * @param size the size of the perm
491 * @param real_size number of pairs with different registers
493 void stat_be_block_stat_perm(const char *class_name, int n_regs, ir_node *perm, ir_node *block,
494 int size, int real_size);
497 * Update the permutation statistic of a single perm
499 * @param class_name the name of the register class
500 * @param perm the perm node
501 * @param block the block containing the perm
502 * @param is_chain 1 if chain, 0 if cycle
503 * @param size length of the cycle/chain
504 * @param n_ops the number of ops representing this cycle/chain after lowering
506 void stat_be_block_stat_permcycle(const char *class_name, ir_node *perm, ir_node *block,
507 int is_chain, int size, int n_ops);
510 * Register an additional function for all dumper. This function
511 * is called in dump_snapshot once for each graph_entry and dumper.
513 * @param func the dump function to register
515 void stat_register_dumper_func(dump_graph_FUNC func);
517 #endif /* FIRM_STAT_FIRMSTAT_T_H */