86df6f8410c3e55073abd764856448899eca5bca
[libfirm] / ir / stat / firmstat_t.h
1 /*
2  * Project:     libFIRM
3  * File name:   ir/stat/firmstat_t.h
4  * Purpose:     Statistics for Firm. Internal data structures.
5  * Author:      Michael Beck
6  * Created:
7  * CVS-ID:      $Id$
8  * Copyright:   (c) 2004 Universität Karlsruhe
9  * Licence:     This file protected by GPL -  GNU GENERAL PUBLIC LICENSE.
10  */
11 #ifndef _FIRMSTAT_T_H_
12 #define _FIRMSTAT_T_H_
13
14 /**
15  * @file firmstat_t.h
16  */
17 #include "firmstat.h"
18
19 #include "irop_t.h"
20 #include "irnode_t.h"
21 #include "irgraph_t.h"
22 #include "pset.h"
23 #include "irprog.h"
24 #include "irgwalk.h"
25 #include "counter.h"
26
27 /*
28  * just be make some things clear :-), the
29  * poor man "generics"
30  */
31 #define HASH_MAP(type) hmap_##type
32
33 typedef pset hmap_node_entry_t;
34 typedef pset hmap_graph_entry_t;
35 typedef pset hmap_opt_entry_t;
36 typedef pset hmap_block_entry_t;
37 typedef pset hmap_ir_op;
38 typedef pset hmap_distrib_entry_t;
39
40
41 /**
42  * An entry for ir_nodes, used in ir_graph statistics.
43  */
44 typedef struct _node_entry_t {
45   counter_t   cnt_alive;                /**< amount of nodes in this entry */
46   counter_t   new_node;                 /**< amount of new nodes for this entry */
47   counter_t   into_Id;                  /**< amount of nodes that turned into Id's for this entry */
48   const ir_op *op;                      /**< the op for this entry */
49 } node_entry_t;
50
51 /**
52  * An entry for ir_graphs
53  */
54 typedef struct _graph_entry_t {
55   HASH_MAP(node_entry_t)  *opcode_hash;                 /**< hash map containing the opcode counter */
56   HASH_MAP(block_entry_t) *block_hash;                  /**< hash map countaining the block counter */
57   counter_t               cnt_walked;                   /**< walker walked over the graph */
58   counter_t               cnt_walked_blocks;            /**< walker walked over the graph blocks */
59   counter_t               cnt_was_inlined;              /**< number of times other graph were inlined */
60   counter_t               cnt_got_inlined;              /**< number of times this graph was inlined */
61   counter_t               cnt_strength_red;             /**< number of times strength reduction was successful on this graph */
62   counter_t               cnt_edges;                    /**< number of DF edges in this graph */
63   counter_t               cnt_all_calls;                /**< number of all calls */
64   counter_t               cnt_indirect_calls;           /**< number of indirect calls */
65   HASH_MAP(opt_entry_t)   *opt_hash[STAT_OPT_MAX];      /**< hash maps containing opcode counter for optimizations */
66   ir_graph                *irg;                         /**< the graph of this object */
67   entity                  *ent;                         /**< the entity of this graph if one exists */
68   unsigned                is_deleted:1;                 /**< set if this irg was deleted */
69   unsigned                is_leaf:1;                    /**< set, if this irg is a leaf function */
70   unsigned                is_recursive:1;               /**< set, if this irg has recursive calls */
71   unsigned                is_chain_call:1;              /**< set, if this irg is a chain call */
72 } graph_entry_t;
73
74 /**
75  * An entry for optimized ir_nodes
76  */
77 typedef struct _opt_entry_t {
78   counter_t   count;                    /**< optimization counter */
79   const ir_op *op;                      /**< the op for this entry */
80 } opt_entry_t;
81
82 /**
83  * An entry for a block in a ir-graph
84  */
85 typedef struct _block_entry_t {
86   counter_t  cnt_nodes;                 /**< the counter of nodes in this block */
87   counter_t  cnt_edges;                 /**< the counter of edges in this block */
88   counter_t  cnt_in_edges;              /**< the counter of edges incoming from other blocks to this block */
89   counter_t  cnt_out_edges;             /**< the counter of edges outgoing from this block to other blocks */
90   long       block_nr;                  /**< block nr */
91 } block_entry_t;
92
93 /** forward */
94 typedef struct _dumper_t dumper_t;
95
96 /**
97  * handler for dumping an IRG
98  *
99  * @param dmp   the dumper
100  * @param entry the IR-graph hash map entry
101  */
102 typedef void (*dump_graph_FUNC)(dumper_t *dmp, graph_entry_t *entry);
103
104 /**
105  * handler for dumper init
106  *
107  * @param dmp   the dumper
108  * @param name  name of the file to dump to
109  */
110 typedef void (*dump_init_FUNC)(dumper_t *dmp, const char *name);
111
112 /**
113  * handler for dumper finish
114  *
115  * @param dmp   the dumper
116  */
117 typedef void (*dump_finish_FUNC)(dumper_t *dmp);
118
119
120 /**
121  * a dumper description
122  */
123 struct _dumper_t {
124   dump_graph_FUNC         dump_graph;           /**< handler for dumping an irg */
125   dump_init_FUNC          init;                 /**< handler for init */
126   dump_finish_FUNC        finish;               /**< handler for finish */
127   FILE                    *f;                   /**< the file to dump to */
128   dumper_t                *next;                /**< link to the next dumper */
129 };
130
131 /**
132  * statistics info
133  */
134 typedef struct _statistic_info_t {
135   struct obstack          cnts;                 /**< obstack containing the counters */
136   HASH_MAP(graph_entry_t) *irg_hash;            /**< hash map containing the counter for irgs */
137   HASH_MAP(ir_op)         *ir_op_hash;          /**< hash map containing all ir_ops (accessible by op_codes) */
138   int                     recursive;            /**< flag for detecting recursive hook calls */
139   int                     in_dead_node_elim;    /**< set, if dead node elimination runs */
140   ir_op                   *op_Phi0;             /**< pseudo op for Phi0 */
141   ir_op                   *op_PhiM;             /**< pseudo op for memory Phi */
142   ir_op                   *op_MulC;             /**< pseudo op for multiplication by const */
143   ir_op                   *op_DivC;             /**< pseudo op for division by const */
144   ir_op                   *op_ModC;             /**< pseudo op for modulo by const */
145   ir_op                   *op_DivModC;          /**< pseudo op for DivMod by const */
146   dumper_t                *dumper;              /**< list of dumper */
147   int                     reassoc_run;          /**< if set, reassociation is running */
148   int                     enable;               /**< if set, statistic is enabled */
149 } stat_info_t;
150
151 /**
152  * An entry in a distribution table
153  */
154 typedef struct _distrib_entry_t {
155   counter_t     cnt;            /**< the current count */
156   const void    *object;        /**< the object which is counted */
157 } distrib_entry_t;
158
159 /** The type of the hash function for objects in distribution tables. */
160 typedef unsigned (*distrib_hash_fun)(const void *object);
161
162 /**
163  * The distribution table.
164  */
165 typedef struct _distrib_tbl_t {
166   struct obstack                cnts;           /**< obstack containing the distrib_entry_t entries */
167   HASH_MAP(distrib_entry_t)     *hash_map;      /**< the hash map containing the distribution */
168   distrib_hash_fun              hash_func;      /**< the hash function for object in this distribution */
169   unsigned                      int_dist;       /**< non-zero, if it's a integer distribution */
170 } distrib_tbl_t;
171
172 /* API for distribution tables */
173
174 /**
175  * creates a new distribution table
176  *
177  * @param cmp_func   Compare function for objects in the distribution
178  * @param hash_func  Hash function for objects in the distribution
179  */
180 distrib_tbl_t *stat_new_distrib_tbl(pset_cmp_fun cmp_func, distrib_hash_fun hash_func);
181
182 /**
183  * creates a new distribution table for an integer distribution
184  */
185 distrib_tbl_t *stat_new_int_distrib_tbl(void);
186
187 /**
188  * destroys a distribution table
189  */
190 void stat_delete_distrib_tbl(distrib_tbl_t *tbl);
191
192 /**
193  * adds a new object count into the distribution table
194  */
195 void stat_add_distrib_tbl(distrib_tbl_t *tbl, const void *object, const counter_t *cnt);
196
197 /**
198  * adds a new key count into the integer distribution table
199  */
200 void stat_add_int_distrib_tbl(distrib_tbl_t *tbl, int key, const counter_t *cnt);
201
202 /**
203  * calculates the mean value of a distribution
204  */
205 double stat_calc_mean_distrib_tbl(distrib_tbl_t *tbl);
206
207 /** evaluates each entry of a distribution table */
208 typedef void (*eval_distrib_entry_fun)(const distrib_entry_t *entry);
209
210 /**
211  * iterates over all entries in a distribution table
212  */
213 void stat_iterate_distrib_tbl(distrib_tbl_t *tbl, eval_distrib_entry_fun eval);
214
215 #endif /* _FIRMSTAT_T_H_ */