we don't need no stinking selfs
[libfirm] / ir / be / bestat.c
1 /*
2  * Copyright (C) 1995-2008 University of Karlsruhe.  All right reserved.
3  *
4  * This file is part of libFirm.
5  *
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.
10  *
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.
14  *
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
17  * PURPOSE.
18  */
19
20 /**
21  * @file
22  * @brief       Provides several statistic functions for the backend.
23  * @author      Christian Wuerdig
24  * @version     $Id$
25  */
26 #ifdef HAVE_CONFIG_H
27 #include "config.h"
28 #endif
29
30 #include <time.h>
31
32 #include "irnode_t.h"
33 #include "irprintf.h"
34 #include "irgwalk.h"
35 #include "irhooks.h"
36 #include "execfreq.h"
37 #include "dbginfo_t.h"
38 #include "firmstat_t.h"
39 #include "irtools.h"
40 #include "pset.h"
41 #include "statev.h"
42
43 #include "bearch_t.h"
44 #include "bestat.h"
45 #include "belive_t.h"
46 #include "besched.h"
47 #include "benode_t.h"
48
49 #ifdef FIRM_STATISTICS
50
51 typedef struct _be_stat_irg_t {
52         ir_graph         *irg;       /**< the irg, the statistic is about */
53         pset             *phases;    /**< node statistics for each phase  */
54         struct obstack   obst;       /**< the obstack containing the information */
55         const arch_env_t *arch_env;  /**< the current arch env */
56 } be_stat_irg_t;
57
58 typedef struct _be_stat_phase_t {
59         const arch_env_t *arch_env;  /**< the current arch env */
60         const char       *phase;     /**< the name of the phase the statistic is about */
61         unsigned long    num_nodes;  /**< overall number of reachable nodes in the irg */
62         unsigned long    num_data;   /**< number of data nodes ((mode_datab && ! Proj && ! Phi)  || mode_T) */
63         unsigned long    num_proj;   /**< number of Projs */
64         unsigned long    num_phi;    /**< number of Phis */
65         unsigned long    num_load;   /**< number of Loads */
66         unsigned long    num_store;  /**< number of Stores */
67         unsigned long    num_spill;  /**< number of Spills */
68         unsigned long    num_reload; /**< number of Reloads */
69 } be_stat_phase_t;
70
71 static set *be_stat_data = NULL;
72
73 static int cmp_stat_phase(const void *a, const void *b) {
74         const be_stat_phase_t *p1 = a;
75         const be_stat_phase_t *p2 = b;
76
77         return p1->phase != p2->phase;
78 }
79
80 static int cmp_stat_data(const void *a, const void *b, size_t len) {
81         const be_stat_irg_t *p1 = a;
82         const be_stat_irg_t *p2 = b;
83         (void) len;
84
85         return p1->irg != p2->irg;
86 }
87
88 static be_stat_irg_t *find_stat_irg_entry(ir_graph *irg) {
89         be_stat_irg_t *entry, key;
90
91         if (! be_stat_data)
92                 return NULL;
93
94         key.irg = irg;
95         entry   = set_find(be_stat_data, &key, sizeof(key), HASH_PTR(irg));
96
97         return entry;
98 }
99
100 static be_stat_irg_t *get_stat_irg_entry(ir_graph *irg) {
101         be_stat_irg_t *entry, key;
102
103         if (! be_stat_data)
104                 return NULL;
105
106         entry = find_stat_irg_entry(irg);
107
108         if (! entry) {
109                 key.irg = irg;
110                 entry   = set_insert(be_stat_data, &key, sizeof(key), HASH_PTR(irg));
111         }
112
113         return entry;
114 }
115
116 typedef struct pressure_walker_env_t pressure_walker_env_t;
117 struct pressure_walker_env_t {
118         be_irg_t *birg;
119         be_lv_t  *lv;
120         double    insn_count;
121         double    regpressure;
122         int       max_pressure;
123         const arch_register_class_t *cls;
124 };
125
126 static void check_reg_pressure_class(pressure_walker_env_t *env,
127                                      ir_node *block,
128                                      const arch_register_class_t *cls)
129 {
130         be_irg_t         *birg = env->birg;
131         ir_graph         *irg  = be_get_birg_irg(birg);
132         const arch_env_t *aenv = be_get_birg_arch_env(birg);
133         ir_node          *irn;
134         ir_nodeset_t      live_nodes;
135         int               max_live;
136
137         ir_nodeset_init(&live_nodes);
138         be_liveness_end_of_block(env->lv, aenv, cls, block, &live_nodes);
139         max_live = ir_nodeset_size(&live_nodes);
140         env->regpressure += max_live;
141
142         sched_foreach_reverse(block, irn) {
143                 int cnt;
144
145                 if(is_Phi(irn))
146                         break;
147
148                 be_liveness_transfer(aenv, cls, irn, &live_nodes);
149                 cnt      = ir_nodeset_size(&live_nodes);
150                 max_live = cnt < max_live ? max_live : cnt;
151                 env->regpressure += cnt;
152                 env->insn_count++;
153         }
154
155         if(max_live > env->max_pressure)
156                 env->max_pressure = max_live;
157
158         stat_be_block_regpressure(irg, block, max_live, cls->name);
159         ir_nodeset_destroy(&live_nodes);
160 }
161
162 /**
163  * Collect reg pressure statistics per block and per class.
164  */
165 static void stat_reg_pressure_block(ir_node *block, void *data) {
166         pressure_walker_env_t *env = data;
167
168         if(env->cls != NULL) {
169                 check_reg_pressure_class(env, block, env->cls);
170         } else {
171                 const arch_env_t *arch_env = be_get_birg_arch_env(env->birg);
172                 int i, n;
173
174                 n = arch_isa_get_n_reg_class(arch_env->isa);
175                 for (i = 0; i < n; i++) {
176                         const arch_register_class_t *cls
177                                 = arch_isa_get_reg_class(arch_env->isa, i);
178
179                         check_reg_pressure_class(env, block, cls);
180                 }
181         }
182 }
183
184 void be_do_stat_reg_pressure(be_irg_t *birg) {
185         pressure_walker_env_t  env;
186         ir_graph              *irg = be_get_birg_irg(birg);
187         double                 average_pressure;
188
189         env.birg         = birg;
190         env.insn_count   = 0;
191         env.max_pressure = 0;
192         env.regpressure  = 0;
193         be_liveness_assure_sets(be_assure_liveness(birg));
194         env.lv           = be_get_birg_liveness(birg);
195
196         // hack for now, TODO: remove me later
197 #if 0
198         env.cls          = NULL;
199 #else
200         env.cls          = arch_isa_get_reg_class(
201                         be_get_birg_arch_env(birg)->isa, 2);
202 #endif
203
204         /* Collect register pressure information for each block */
205         irg_block_walk_graph(irg, stat_reg_pressure_block, NULL, &env);
206
207         average_pressure = env.regpressure / env.insn_count;
208         stat_ev_emit("average_register_pressure", average_pressure);
209         stat_ev_emit("maximum_register_pressure", env.max_pressure);
210 }
211
212 /**
213  * Notify statistic module about amount of ready nodes.
214  */
215 void be_do_stat_sched_ready(ir_node *block, const ir_nodeset_t *ready_set) {
216         if (stat_is_active()) {
217                 stat_be_block_sched_ready(get_irn_irg(block), block, MIN(ir_nodeset_size(ready_set), 5));
218         }
219 }
220
221 /**
222  * Pass information about a perm to the statistic module.
223  */
224 void be_do_stat_perm(const char *class_name, int n_regs, ir_node *perm, ir_node *block, int n, int real_size) {
225         if (stat_is_active()) {
226                 stat_be_block_stat_perm(class_name, n_regs, perm, block, n, real_size);
227         }
228 }
229
230 /**
231  * Pass information about a cycle or chain in a perm to the statistic module.
232  */
233 void be_do_stat_permcycle(const char *class_name, ir_node *perm, ir_node *block, int is_chain, int n_elems, int n_ops) {
234         if (stat_is_active()) {
235                 stat_be_block_stat_permcycle(class_name, perm, block, is_chain, n_elems, n_ops);
236         }
237 }
238
239 /**
240  * Updates nodes statistics.
241  */
242 static void do_nodes_stat(ir_node *irn, void *env) {
243         be_stat_phase_t  *phase = env;
244         ir_mode          *mode;
245         ir_opcode        opc;
246         arch_irn_class_t irn_class;
247
248         if (is_Block(irn))
249                 return;
250
251         mode = get_irn_mode(irn);
252         opc  = get_irn_opcode(irn);
253
254         phase->num_nodes++;
255
256         /* check for nodes we want to ignore */
257         if (be_is_Keep(irn)     ||
258                 be_is_CopyKeep(irn) ||
259                 opc == iro_Start    ||
260                 opc == iro_End)
261                 return;
262
263         if (is_Proj(irn) && (mode != mode_X)) {
264                 phase->num_proj++;
265                 return;
266         }
267         else if (is_Phi(irn)) {
268                 phase->num_phi++;
269                 return;
270         }
271         else if (mode_is_datab(mode) || ((mode == mode_T) && ! is_be_node(irn)) || (is_Proj(irn) && (mode == mode_X)))
272                 phase->num_data++;
273
274         if (opc == iro_Load)
275                 phase->num_load++;
276         else if (opc == iro_Store)
277                 phase->num_store++;
278
279         irn_class = arch_irn_classify(phase->arch_env, irn);
280         if (irn_class & arch_irn_class_spill)
281                 phase->num_spill++;
282         else if (irn_class & arch_irn_class_reload)
283                 phase->num_reload++;
284         else if (irn_class & arch_irn_class_stackparam)
285                 phase->num_load++;
286         else if (irn_class & arch_irn_class_load)
287                 phase->num_load++;
288         else if (irn_class & arch_irn_class_store)
289                 phase->num_store++;
290 }
291
292 /**
293  * Collects node statistics.
294  *
295  * @param irg      the to do statistics for
296  * @param phase    the phase to collect the statistic for
297  */
298 void be_do_stat_nodes(ir_graph *irg, const char *phase) {
299         be_stat_irg_t   *irg_entry;
300         be_stat_phase_t *phase_entry, phase_key;
301
302         irg_entry = find_stat_irg_entry(irg);
303
304         if (! irg_entry)
305                 return;
306
307         phase_key.phase = phase;
308         phase_entry     = pset_find_ptr(irg_entry->phases, &phase_key);
309
310         if (! phase_entry) {
311                 phase_entry = obstack_alloc(&irg_entry->obst, sizeof(*phase_entry));
312                 phase_entry = pset_insert(irg_entry->phases, phase_entry, HASH_PTR(phase));
313         }
314         memset(phase_entry, 0, sizeof(*phase_entry));
315
316         phase_entry->phase    = phase;
317         phase_entry->arch_env = irg_entry->arch_env;
318
319         irg_walk_blkwise_graph(irg_entry->irg, NULL, do_nodes_stat, phase_entry);
320 }
321
322 /**
323  * Dumps statistics about nodes (called from dump_snapshot)
324  */
325 static void be_dump_node_stat(dumper_t *dmp, graph_entry_t *entry) {
326         be_stat_irg_t   *stat_irg = find_stat_irg_entry(entry->irg);
327         be_stat_phase_t *phase;
328
329         if (! stat_irg || ! stat_irg->phases)
330                 return;
331
332         fprintf(dmp->f, "===> BE NODE STATISTIC BEGIN <===\n");
333
334         foreach_pset(stat_irg->phases, phase) {
335                 fprintf(dmp->f, "--> Phase: %s\n", phase->phase);
336                 fprintf(dmp->f, "# nodes:      %ld\n", phase->num_nodes);
337                 fprintf(dmp->f, "# data nodes: %ld\n", phase->num_data);
338                 fprintf(dmp->f, "# Proj:       %ld\n", phase->num_proj);
339                 fprintf(dmp->f, "# Phi:        %ld\n", phase->num_phi);
340                 fprintf(dmp->f, "# Load:       %ld\n", phase->num_load);
341                 fprintf(dmp->f, "# Store:      %ld\n", phase->num_store);
342                 fprintf(dmp->f, "# Spill:      %ld\n", phase->num_spill);
343                 fprintf(dmp->f, "# Reload:     %ld\n", phase->num_reload);
344         }
345
346         fprintf(dmp->f, "===> BE NODE STATISTIC END <===\n");
347 }
348
349 /**
350  * Returns a be statistic object for the given irg.
351  */
352 void be_stat_init_irg(const arch_env_t *arch_env, ir_graph *irg) {
353         static int reg_func  = 1;
354
355         if (stat_is_active()) {
356                 be_stat_irg_t *stat_irg;
357
358                 if (! be_stat_data)
359                         be_stat_data = new_set(cmp_stat_data, 8);
360
361                 stat_irg           = get_stat_irg_entry(irg);
362                 stat_irg->irg      = irg;
363                 stat_irg->phases   = new_pset(cmp_stat_phase, 8);
364                 stat_irg->arch_env = arch_env;
365                 obstack_init(&stat_irg->obst);
366
367                 if (reg_func) {
368                         /* first init: register dumper */
369                         stat_register_dumper_func(be_dump_node_stat);
370                         reg_func = 0;
371                 }
372         }
373 }
374 #endif /* FIRM_STATISTICS */
375
376 typedef struct _estimate_irg_costs_env_t {
377         const arch_env_t *arch_env;
378         ir_exec_freq     *execfreqs;
379         double           costs;
380 } estimate_irg_costs_env_t;
381
382 static void estimate_block_costs(ir_node *block, void *data)
383 {
384         estimate_irg_costs_env_t *env = data;
385         ir_node *node;
386         double  costs = 0.0;
387
388         sched_foreach(block, node) {
389                 costs += arch_get_op_estimated_cost(env->arch_env, node);
390         }
391
392         env->costs += costs * get_block_execfreq(env->execfreqs, block);
393 }
394
395 double be_estimate_irg_costs(ir_graph *irg, const arch_env_t *arch_env, ir_exec_freq *execfreqs)
396 {
397         estimate_irg_costs_env_t env;
398
399         env.arch_env  = arch_env;
400         env.execfreqs = execfreqs;
401         env.costs     = 0.0;
402
403         irg_block_walk_graph(irg, estimate_block_costs, NULL, &env);
404
405         return env.costs;
406 }
407
408 #ifdef FIRM_STATISTICS
409
410
411 #else /* FIRM_STATISTICS */
412
413 void (be_stat_init_irg)(const arch_env_t *arch_env, ir_graph *irg) {}
414 void (be_do_stat_nodes)(ir_graph *irg, const char *phase) {}
415 void (be_do_stat_reg_pressure)(be_irg_t *birg) {}
416 void (be_do_stat_sched_ready)(ir_node *block, ir_nodeset_t *ready_set) {}
417 void (be_do_stat_perm)(const char *class_name, int n_regs, ir_node *perm, ir_node *block, int n, int real_size) {}
418
419 #endif /* FIRM_STATISTICS */