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