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