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 * just be make some things clear :-), the
33 #define HASH_MAP(type) hmap_##type
35 typedef pset hmap_node_entry_t;
36 typedef pset hmap_graph_entry_t;
37 typedef pset hmap_opt_entry_t;
38 typedef pset hmap_block_entry_t;
39 typedef pset hmap_ir_op;
40 typedef pset hmap_distrib_entry_t;
43 * possible address marker values
46 MARK_ADDRESS_CALC = 1, /**< the node is an address expression */
47 MARK_REF_ADR = 2, /**< the node is referenced by an address expression */
48 MARK_REF_NON_ADR = 4, /**< the node is referenced by a non-address expression */
52 * An entry in the address_mark set
54 typedef struct _address_mark_entry_t {
55 ir_node *node; /**< the node which this entry belongs to, needed for compare */
56 unsigned mark; /**< the mark, a bitmask of enum adr_marker_t */
57 } address_mark_entry_t;
60 * An entry for ir_nodes, used in ir_graph statistics.
62 typedef struct _node_entry_t {
63 counter_t cnt_alive; /**< amount of nodes in this entry */
64 counter_t new_node; /**< amount of new nodes for this entry */
65 counter_t into_Id; /**< amount of nodes that turned into Id's for this entry */
66 const ir_op *op; /**< the op for this entry */
69 enum leaf_call_state_t {
70 LCS_UNKNOWN = 0, /**< state is unknown yet */
71 LCS_LEAF_CALL = 1, /**< only leaf functions will be called */
72 LCS_NON_LEAF_CALL = 2, /**< at least one non-leaf function will be called or indetermined */
76 * An entry for ir_graphs. These numbers are calculated for every IR graph.
78 typedef struct _graph_entry_t {
79 HASH_MAP(node_entry_t) *opcode_hash; /**< hash map containing the opcode counter */
80 HASH_MAP(block_entry_t) *block_hash; /**< hash map containing the block counter */
81 counter_t cnt_walked; /**< walker walked over the graph */
82 counter_t cnt_walked_blocks; /**< walker walked over the graph blocks */
83 counter_t cnt_was_inlined; /**< number of times other graph were inlined */
84 counter_t cnt_got_inlined; /**< number of times this graph was inlined */
85 counter_t cnt_strength_red; /**< number of times strength reduction was successful on this graph */
86 counter_t cnt_edges; /**< number of DF edges in this graph */
87 counter_t cnt_all_calls; /**< number of all calls */
88 counter_t cnt_call_with_cnst_arg; /**< number of calls with const args */
89 counter_t cnt_indirect_calls; /**< number of indirect calls */
90 counter_t cnt_if_conv[IF_RESULT_LAST]; /**< number of if conversions */
91 counter_t cnt_real_func_call; /**< number real function call optimization */
92 unsigned num_tail_recursion; /**< number of tail recursion optimizations */
93 HASH_MAP(opt_entry_t) *opt_hash[HOOK_OPT_LAST]; /**< hash maps containing opcode counter for optimizations */
94 ir_graph *irg; /**< the graph of this object */
95 entity *ent; /**< the entity of this graph if one exists */
96 set *address_mark; /**< a set containing the address marks of the nodes */
97 unsigned is_deleted:1; /**< set if this irg was deleted */
98 unsigned is_leaf:1; /**< set, if this irg is a leaf function */
99 unsigned is_leaf_call:2; /**< set, if this irg calls only leaf functions */
100 unsigned is_recursive:1; /**< set, if this irg has recursive calls */
101 unsigned is_chain_call:1; /**< set, if this irg is a chain call */
102 unsigned is_analyzed:1; /**< helper: set, if this irg was already analysed */
106 * An entry for optimized ir_nodes
108 typedef struct _opt_entry_t {
109 counter_t count; /**< optimization counter */
110 const ir_op *op; /**< the op for this entry */
114 * An entry for a block in a ir-graph
116 typedef struct _block_entry_t {
117 counter_t cnt_nodes; /**< the counter of nodes in this block */
118 counter_t cnt_edges; /**< the counter of edges in this block */
119 counter_t cnt_in_edges; /**< the counter of edges incoming from other blocks to this block */
120 counter_t cnt_out_edges; /**< the counter of edges outgoing from this block to other blocks */
121 counter_t cnt_phi_data; /**< the counter of data Phi nodes in this block */
122 long block_nr; /**< block nr */
126 typedef struct _dumper_t dumper_t;
129 * handler for dumping an IRG
131 * @param dmp the dumper
132 * @param entry the IR-graph hash map entry
134 typedef void (*dump_graph_FUNC)(dumper_t *dmp, graph_entry_t *entry);
137 * handler for dumper init
139 * @param dmp the dumper
140 * @param name name of the file to dump to
142 typedef void (*dump_init_FUNC)(dumper_t *dmp, const char *name);
145 * handler for dumper finish
147 * @param dmp the dumper
149 typedef void (*dump_finish_FUNC)(dumper_t *dmp);
155 typedef struct _statistic_info_t {
156 struct obstack cnts; /**< obstack containing the counters */
157 HASH_MAP(graph_entry_t) *irg_hash; /**< hash map containing the counter for irgs */
158 HASH_MAP(ir_op) *ir_op_hash; /**< hash map containing all ir_ops (accessible by op_codes) */
159 pdeq *wait_q; /**< wait queue for leaf call decision */
160 int recursive; /**< flag for detecting recursive hook calls */
161 int in_dead_node_elim; /**< set, if dead node elimination runs */
162 ir_op *op_Phi0; /**< pseudo op for Phi0 */
163 ir_op *op_PhiM; /**< pseudo op for memory Phi */
164 ir_op *op_ProjM; /**< pseudo op for memory Proj */
165 ir_op *op_MulC; /**< pseudo op for multiplication by const */
166 ir_op *op_DivC; /**< pseudo op for division by const */
167 ir_op *op_ModC; /**< pseudo op for modulo by const */
168 ir_op *op_DivModC; /**< pseudo op for DivMod by const */
169 dumper_t *dumper; /**< list of dumper */
170 int reassoc_run; /**< if set, reassociation is running */
171 int stat_options; /**< statistic options */
175 * a dumper description
178 dump_graph_FUNC dump_graph; /**< handler for dumping an irg */
179 dump_init_FUNC init; /**< handler for init */
180 dump_finish_FUNC finish; /**< handler for finish */
181 FILE *f; /**< the file to dump to */
182 stat_info_t *status; /**< access to the global status */
183 dumper_t *next; /**< link to the next dumper */
187 * helper: get an ir_op from an opcode
189 ir_op *stat_get_op_from_opcode(opcode code);
192 * An entry in a distribution table
194 typedef struct _distrib_entry_t {
195 counter_t cnt; /**< the current count */
196 const void *object; /**< the object which is counted */
199 /** The type of the hash function for objects in distribution tables. */
200 typedef unsigned (*distrib_hash_fun)(const void *object);
203 * The distribution table.
205 typedef struct _distrib_tbl_t {
206 struct obstack cnts; /**< obstack containing the distrib_entry_t entries */
207 HASH_MAP(distrib_entry_t) *hash_map; /**< the hash map containing the distribution */
208 distrib_hash_fun hash_func; /**< the hash function for object in this distribution */
209 unsigned int_dist; /**< non-zero, if it's a integer distribution */
212 /* API for distribution tables */
215 * creates a new distribution table
217 * @param cmp_func Compare function for objects in the distribution
218 * @param hash_func Hash function for objects in the distribution
220 distrib_tbl_t *stat_new_distrib_tbl(pset_cmp_fun cmp_func, distrib_hash_fun hash_func);
223 * creates a new distribution table for an integer distribution
225 distrib_tbl_t *stat_new_int_distrib_tbl(void);
228 * destroys a distribution table
230 void stat_delete_distrib_tbl(distrib_tbl_t *tbl);
233 * adds a new object count into the distribution table
235 void stat_add_distrib_tbl(distrib_tbl_t *tbl, const void *object, const counter_t *cnt);
238 * adds a new key count into the integer distribution table
240 void stat_add_int_distrib_tbl(distrib_tbl_t *tbl, int key, const counter_t *cnt);
243 * calculates the mean value of a distribution
245 double stat_calc_mean_distrib_tbl(distrib_tbl_t *tbl);
247 /** evaluates each entry of a distribution table */
248 typedef void (*eval_distrib_entry_fun)(const distrib_entry_t *entry);
251 * iterates over all entries in a distribution table
253 void stat_iterate_distrib_tbl(distrib_tbl_t *tbl, eval_distrib_entry_fun eval);
255 #endif /* _FIRMSTAT_T_H_ */