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