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