86a019690c94249fa3f8be7dea79212d1eb25e8c
[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 #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 struct a_pressure_walker {
117         be_irg_t *birg;
118         be_lv_t *lv;
119 };
120
121 /**
122  * Collect reg pressure statistics per block and per class.
123  */
124 static void stat_reg_pressure_block(ir_node *block, void *data) {
125         struct a_pressure_walker *env = data;
126         be_irg_t         *birg = env->birg;
127         ir_graph         *irg  = be_get_birg_irg(birg);
128         const arch_env_t *aenv = be_get_birg_arch_env(birg);
129         int i, n = arch_isa_get_n_reg_class(aenv->isa);
130
131         for (i = 0; i < n; i++) {
132                 const arch_register_class_t *cls = arch_isa_get_reg_class(aenv->isa, i);
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
141                 sched_foreach_reverse(block, irn) {
142                         int cnt;
143
144                         if(is_Phi(irn))
145                                 break;
146
147                         be_liveness_transfer(aenv, cls, irn, &live_nodes);
148                         cnt        = ir_nodeset_size(&live_nodes);
149                         max_live   = cnt < max_live ? max_live : cnt;
150                 }
151
152                 stat_be_block_regpressure(irg, block, max_live, cls->name);
153                 ir_nodeset_destroy(&live_nodes);
154         }
155 }
156
157 void be_do_stat_reg_pressure(be_irg_t *birg) {
158         ir_graph *irg = be_get_birg_irg(birg);
159
160         if (stat_is_active()) {
161                 struct a_pressure_walker w;
162
163                 w.birg = birg;
164                 w.lv   = be_liveness(birg);
165                 /* Collect register pressure information for each block */
166                 irg_block_walk_graph(irg, stat_reg_pressure_block, NULL, &w);
167                 be_liveness_free(w.lv);
168         }
169 }
170
171 /**
172  * Notify statistic module about amount of ready nodes.
173  */
174 void be_do_stat_sched_ready(ir_node *block, const ir_nodeset_t *ready_set) {
175         if (stat_is_active()) {
176                 stat_be_block_sched_ready(get_irn_irg(block), block, MIN(ir_nodeset_size(ready_set), 5));
177         }
178 }
179
180 /**
181  * Pass information about a perm to the statistic module.
182  */
183 void be_do_stat_perm(const char *class_name, int n_regs, ir_node *perm, ir_node *block, int n, int real_size) {
184         if (stat_is_active()) {
185                 stat_be_block_stat_perm(class_name, n_regs, perm, block, n, real_size);
186         }
187 }
188
189 /**
190  * Pass information about a cycle or chain in a perm to the statistic module.
191  */
192 void be_do_stat_permcycle(const char *class_name, ir_node *perm, ir_node *block, int is_chain, int n_elems, int n_ops) {
193         if (stat_is_active()) {
194                 stat_be_block_stat_permcycle(class_name, perm, block, is_chain, n_elems, n_ops);
195         }
196 }
197
198 /**
199  * Updates nodes statistics.
200  */
201 static void do_nodes_stat(ir_node *irn, void *env) {
202         be_stat_phase_t  *phase = env;
203         ir_mode          *mode;
204         ir_opcode        opc;
205         arch_irn_class_t irn_class;
206
207         if (is_Block(irn))
208                 return;
209
210         mode = get_irn_mode(irn);
211         opc  = get_irn_opcode(irn);
212
213         phase->num_nodes++;
214
215         /* check for nodes we want to ignore */
216         if (be_is_Keep(irn)     ||
217                 be_is_CopyKeep(irn) ||
218                 opc == iro_Start    ||
219                 opc == iro_End)
220                 return;
221
222         if (is_Proj(irn) && (mode != mode_X)) {
223                 phase->num_proj++;
224                 return;
225         }
226         else if (is_Phi(irn)) {
227                 phase->num_phi++;
228                 return;
229         }
230         else if (mode_is_datab(mode) || ((mode == mode_T) && ! is_be_node(irn)) || (is_Proj(irn) && (mode == mode_X)))
231                 phase->num_data++;
232
233         if (opc == iro_Load)
234                 phase->num_load++;
235         else if (opc == iro_Store)
236                 phase->num_store++;
237
238         irn_class = arch_irn_classify(phase->arch_env, irn);
239         if (irn_class & arch_irn_class_spill)
240                 phase->num_spill++;
241         else if (irn_class & arch_irn_class_reload)
242                 phase->num_reload++;
243         else if (irn_class & arch_irn_class_stackparam)
244                 phase->num_load++;
245         else if (irn_class & arch_irn_class_load)
246                 phase->num_load++;
247         else if (irn_class & arch_irn_class_store)
248                 phase->num_store++;
249 }
250
251 /**
252  * Collects node statistics.
253  *
254  * @param irg      the to do statistics for
255  * @param phase    the phase to collect the statistic for
256  */
257 void be_do_stat_nodes(ir_graph *irg, const char *phase) {
258         be_stat_irg_t   *irg_entry;
259         be_stat_phase_t *phase_entry, phase_key;
260
261         irg_entry = find_stat_irg_entry(irg);
262
263         if (! irg_entry)
264                 return;
265
266         phase_key.phase = phase;
267         phase_entry     = pset_find_ptr(irg_entry->phases, &phase_key);
268
269         if (! phase_entry) {
270                 phase_entry = obstack_alloc(&irg_entry->obst, sizeof(*phase_entry));
271                 phase_entry = pset_insert(irg_entry->phases, phase_entry, HASH_PTR(phase));
272         }
273         memset(phase_entry, 0, sizeof(*phase_entry));
274
275         phase_entry->phase    = phase;
276         phase_entry->arch_env = irg_entry->arch_env;
277
278         irg_walk_blkwise_graph(irg_entry->irg, NULL, do_nodes_stat, phase_entry);
279 }
280
281 /**
282  * Dumps statistics about nodes (called from dump_snapshot)
283  */
284 static void be_dump_node_stat(dumper_t *dmp, graph_entry_t *entry) {
285         be_stat_irg_t   *stat_irg = find_stat_irg_entry(entry->irg);
286         be_stat_phase_t *phase;
287
288         if (! stat_irg || ! stat_irg->phases)
289                 return;
290
291         fprintf(dmp->f, "===> BE NODE STATISTIC BEGIN <===\n");
292
293         foreach_pset(stat_irg->phases, phase) {
294                 fprintf(dmp->f, "--> Phase: %s\n", phase->phase);
295                 fprintf(dmp->f, "# nodes:      %ld\n", phase->num_nodes);
296                 fprintf(dmp->f, "# data nodes: %ld\n", phase->num_data);
297                 fprintf(dmp->f, "# Proj:       %ld\n", phase->num_proj);
298                 fprintf(dmp->f, "# Phi:        %ld\n", phase->num_phi);
299                 fprintf(dmp->f, "# Load:       %ld\n", phase->num_load);
300                 fprintf(dmp->f, "# Store:      %ld\n", phase->num_store);
301                 fprintf(dmp->f, "# Spill:      %ld\n", phase->num_spill);
302                 fprintf(dmp->f, "# Reload:     %ld\n", phase->num_reload);
303         }
304
305         fprintf(dmp->f, "===> BE NODE STATISTIC END <===\n");
306 }
307
308 /**
309  * Returns a be statistic object for the given irg.
310  */
311 void be_stat_init_irg(const arch_env_t *arch_env, ir_graph *irg) {
312         static int reg_func  = 1;
313
314         if (stat_is_active()) {
315                 be_stat_irg_t *stat_irg;
316
317                 if (! be_stat_data)
318                         be_stat_data = new_set(cmp_stat_data, 8);
319
320                 stat_irg           = get_stat_irg_entry(irg);
321                 stat_irg->irg      = irg;
322                 stat_irg->phases   = new_pset(cmp_stat_phase, 8);
323                 stat_irg->arch_env = arch_env;
324                 obstack_init(&stat_irg->obst);
325
326                 if (reg_func) {
327                         /* first init: register dumper */
328                         stat_register_dumper_func(be_dump_node_stat);
329                         reg_func = 0;
330                 }
331         }
332 }
333 #endif /* FIRM_STATISTICS */
334
335 typedef struct _estimate_irg_costs_env_t {
336         const arch_env_t *arch_env;
337         ir_exec_freq     *execfreqs;
338         double           costs;
339 } estimate_irg_costs_env_t;
340
341 static void estimate_block_costs(ir_node *block, void *data)
342 {
343         estimate_irg_costs_env_t *env = data;
344         ir_node *node;
345         double  costs = 0.0;
346
347         sched_foreach(block, node) {
348                 costs += arch_get_op_estimated_cost(env->arch_env, node);
349         }
350
351         env->costs += costs * get_block_execfreq(env->execfreqs, block);
352 }
353
354 double be_estimate_irg_costs(ir_graph *irg, const arch_env_t *arch_env, ir_exec_freq *execfreqs)
355 {
356         estimate_irg_costs_env_t env;
357
358         env.arch_env  = arch_env;
359         env.execfreqs = execfreqs;
360         env.costs     = 0.0;
361
362         irg_block_walk_graph(irg, estimate_block_costs, NULL, &env);
363
364         return env.costs;
365 }
366
367 #ifdef FIRM_STATISTICS
368
369
370 #else /* FIRM_STATISTICS */
371
372 void (be_stat_init_irg)(const arch_env_t *arch_env, ir_graph *irg) {}
373 void (be_do_stat_nodes)(ir_graph *irg, const char *phase) {}
374 void (be_do_stat_reg_pressure)(be_irg_t *birg) {}
375 void (be_do_stat_sched_ready)(ir_node *block, ir_nodeset_t *ready_set) {}
376 void (be_do_stat_perm)(const char *class_name, int n_regs, ir_node *perm, ir_node *block, int n, int real_size) {}
377
378 #endif /* FIRM_STATISTICS */