simplify and speedup belady/loopana a bit
[libfirm] / ir / be / bechordal_main.c
1 /*
2  * Copyright (C) 1995-2008 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       Driver for the chordal register allocator.
23  * @author      Sebastian Hack
24  * @date        29.11.2005
25  * @version     $Id$
26  */
27 #ifdef HAVE_CONFIG_H
28 #include "config.h"
29 #endif
30
31 #include <stdlib.h>
32 #include <time.h>
33
34 #include "obst.h"
35 #include "pset.h"
36 #include "list.h"
37 #include "bitset.h"
38 #include "iterator.h"
39 #include "firm_config.h"
40
41 #include "lc_opts.h"
42 #include "lc_opts_enum.h"
43
44 #include "ircons_t.h"
45 #include "irmode_t.h"
46 #include "irgraph_t.h"
47 #include "irprintf_t.h"
48 #include "irgwalk.h"
49 #include "ircons.h"
50 #include "irdump.h"
51 #include "irdom.h"
52 #include "ircons.h"
53 #include "irbitset.h"
54 #include "irnode.h"
55 #include "ircons.h"
56 #include "debug.h"
57 #include "xmalloc.h"
58 #include "execfreq.h"
59 #include "iredges_t.h"
60
61 #include "bechordal_t.h"
62 #include "beabi.h"
63 #include "bejavacoal.h"
64 #include "beutil.h"
65 #include "besched.h"
66 #include "besched_t.h"
67 #include "belive_t.h"
68 #include "bearch_t.h"
69 #include "beifg_t.h"
70 #include "beifg_impl.h"
71 #include "benode_t.h"
72 #include "bestatevent.h"
73 #include "bestat.h"
74 #include "bemodule.h"
75 #include "be_t.h"
76 #include "bera.h"
77 #include "beirg_t.h"
78
79 #include "bespillslots.h"
80 #include "bespilloptions.h"
81 #include "belower.h"
82
83 #ifdef WITH_ILP
84 #include "bespillremat.h"
85 #endif /* WITH_ILP */
86
87 #include "bejavacoal.h"
88 #include "becopystat.h"
89 #include "becopyopt.h"
90 #include "bessadestr.h"
91 #include "beverify.h"
92 #include "benode_t.h"
93
94 static be_ra_chordal_opts_t options = {
95         BE_CH_DUMP_NONE,
96         BE_CH_LOWER_PERM_SWAP,
97         BE_CH_VRFY_WARN,
98         "",
99         ""
100 };
101
102 typedef struct _post_spill_env_t {
103         be_chordal_env_t            cenv;
104         be_irg_t                    *birg;
105         const arch_register_class_t *cls;
106         double                      pre_spill_cost;
107 } post_spill_env_t;
108
109 static be_options_t  *main_opts;
110
111 static const lc_opt_enum_int_items_t lower_perm_items[] = {
112         { "copy", BE_CH_LOWER_PERM_COPY },
113         { "swap", BE_CH_LOWER_PERM_SWAP },
114         { NULL, 0 }
115 };
116
117 static const lc_opt_enum_int_items_t lower_perm_stat_items[] = {
118         { NULL, 0 }
119 };
120
121 static const lc_opt_enum_int_items_t dump_items[] = {
122         { "none",       BE_CH_DUMP_NONE       },
123         { "spill",      BE_CH_DUMP_SPILL      },
124         { "live",       BE_CH_DUMP_LIVE       },
125         { "color",      BE_CH_DUMP_COLOR      },
126         { "copymin",    BE_CH_DUMP_COPYMIN    },
127         { "ssadestr",   BE_CH_DUMP_SSADESTR   },
128         { "tree",       BE_CH_DUMP_TREE_INTV  },
129         { "constr",     BE_CH_DUMP_CONSTR     },
130         { "lower",      BE_CH_DUMP_LOWER      },
131         { "spillslots", BE_CH_DUMP_SPILLSLOTS },
132         { "appel",      BE_CH_DUMP_APPEL      },
133         { "all",        BE_CH_DUMP_ALL        },
134         { NULL, 0 }
135 };
136
137 static const lc_opt_enum_int_items_t be_ch_vrfy_items[] = {
138         { "off",    BE_CH_VRFY_OFF    },
139         { "warn",   BE_CH_VRFY_WARN   },
140         { "assert", BE_CH_VRFY_ASSERT },
141         { NULL, 0 }
142 };
143
144 static lc_opt_enum_int_var_t lower_perm_var = {
145         &options.lower_perm_opt, lower_perm_items
146 };
147
148 static lc_opt_enum_int_var_t dump_var = {
149         &options.dump_flags, dump_items
150 };
151
152 static lc_opt_enum_int_var_t be_ch_vrfy_var = {
153         &options.vrfy_option, be_ch_vrfy_items
154 };
155
156 static const lc_opt_table_entry_t be_chordal_options[] = {
157         LC_OPT_ENT_ENUM_PTR ("perm",          "perm lowering options", &lower_perm_var),
158         LC_OPT_ENT_ENUM_MASK("dump",          "select dump phases", &dump_var),
159         LC_OPT_ENT_ENUM_PTR ("vrfy",          "verify options", &be_ch_vrfy_var),
160         LC_OPT_LAST
161 };
162
163 static void dump(unsigned mask, ir_graph *irg,
164                                  const arch_register_class_t *cls,
165                                  const char *suffix,
166                                  void (*dump_func)(ir_graph *, const char *))
167 {
168         if((options.dump_flags & mask) == mask) {
169                 if (cls) {
170                         char buf[256];
171                         snprintf(buf, sizeof(buf), "-%s%s", cls->name, suffix);
172                         be_dump(irg, buf, dump_func);
173                 }
174                 else
175                         be_dump(irg, suffix, dump_func);
176         }
177 }
178
179 /**
180  * Checks for every reload if it's user can perform the load on itself.
181  */
182 static void memory_operand_walker(ir_node *irn, void *env) {
183         be_chordal_env_t *cenv = env;
184         const arch_env_t *aenv = cenv->birg->main_env->arch_env;
185         const ir_edge_t  *edge, *ne;
186         ir_node          *block;
187         ir_node          *spill;
188
189         if (! be_is_Reload(irn))
190                 return;
191
192         /* only use memory operands, if the reload is only used by 1 node */
193         if(get_irn_n_edges(irn) > 1)
194                 return;
195
196         spill = be_get_Reload_mem(irn);
197         block = get_nodes_block(irn);
198
199         foreach_out_edge_safe(irn, edge, ne) {
200                 ir_node *src = get_edge_src_irn(edge);
201                 int     pos  = get_edge_src_pos(edge);
202
203                 assert(src && "outedges broken!");
204
205                 if (get_nodes_block(src) == block && arch_possible_memory_operand(aenv, src, pos)) {
206                         arch_perform_memory_operand(aenv, src, spill, pos);
207                 }
208         }
209
210         /* kill the Reload */
211         if (get_irn_n_edges(irn) == 0) {
212                 sched_remove(irn);
213                 set_irn_n(irn, be_pos_Reload_mem, new_Bad());
214                 set_irn_n(irn, be_pos_Reload_frame, new_Bad());
215         }
216 }
217
218 /**
219  * Starts a walk for memory operands if supported by the backend.
220  */
221 static INLINE void check_for_memory_operands(be_chordal_env_t *chordal_env) {
222         irg_walk_graph(chordal_env->irg, NULL, memory_operand_walker, chordal_env);
223 }
224
225
226 static be_node_stats_t last_node_stats;
227
228 /**
229  * Perform things which need to be done per register class before spilling.
230  */
231 static void pre_spill(post_spill_env_t *pse, const arch_register_class_t *cls)
232 {
233         be_chordal_env_t    *chordal_env = &pse->cenv;
234         be_irg_t            *birg        = pse->birg;
235         ir_graph            *irg         = be_get_birg_irg(birg);
236         const be_main_env_t *main_env    = birg->main_env;
237
238         pse->cls                   = cls;
239         chordal_env->cls           = cls;
240         chordal_env->border_heads  = pmap_create();
241         chordal_env->ignore_colors = bitset_malloc(chordal_env->cls->n_regs);
242
243         be_assure_liveness(birg);
244         be_liveness_assure_chk(be_get_birg_liveness(birg));
245
246         stat_ev_do(pse->pre_spill_cost = be_estimate_irg_costs(irg, main_env->arch_env, birg->exec_freq));
247
248         /* put all ignore registers into the ignore register set. */
249         be_put_ignore_regs(birg, pse->cls, chordal_env->ignore_colors);
250
251         BE_TIMER_PUSH(t_ra_constr);
252         be_pre_spill_prepare_constr(chordal_env);
253         BE_TIMER_POP(t_ra_constr);
254
255         dump(BE_CH_DUMP_CONSTR, birg->irg, pse->cls, "-constr-pre", dump_ir_block_graph_sched);
256 }
257
258 /**
259  * Perform things which need to be done per register class after spilling.
260  */
261 static void post_spill(post_spill_env_t *pse, int iteration) {
262         be_chordal_env_t    *chordal_env = &pse->cenv;
263         be_irg_t            *birg        = pse->birg;
264         ir_graph            *irg         = birg->irg;
265         const be_main_env_t *main_env    = birg->main_env;
266         int                  colors_n     = arch_register_class_n_regs(chordal_env->cls);
267         int             allocatable_regs = colors_n - be_put_ignore_regs(birg, chordal_env->cls, NULL);
268
269         /* some special classes contain only ignore regs, no work to be done */
270         if (allocatable_regs > 0) {
271                 stat_ev_dbl("bechordal_spillcosts", be_estimate_irg_costs(irg, main_env->arch_env, birg->exec_freq) - pse->pre_spill_cost);
272
273                 /*
274                         If we have a backend provided spiller, post spill is
275                         called in a loop after spilling for each register class.
276                         But we only need to fix stack nodes once in this case.
277                 */
278                 BE_TIMER_PUSH(t_ra_spill_apply);
279                 check_for_memory_operands(chordal_env);
280                 if (iteration == 0) {
281                         be_abi_fix_stack_nodes(birg->abi);
282                 }
283                 BE_TIMER_POP(t_ra_spill_apply);
284
285                 BE_TIMER_PUSH(t_verify);
286
287                 /* verify schedule and register pressure */
288                 if (chordal_env->opts->vrfy_option == BE_CH_VRFY_WARN) {
289                         be_verify_schedule(birg);
290                         be_verify_register_pressure(birg, pse->cls, irg);
291                 } else if (chordal_env->opts->vrfy_option == BE_CH_VRFY_ASSERT) {
292                         assert(be_verify_schedule(birg) && "Schedule verification failed");
293                         assert(be_verify_register_pressure(birg, pse->cls, irg)
294                                 && "Register pressure verification failed");
295                 }
296                 BE_TIMER_POP(t_verify);
297
298                 /* Color the graph. */
299                 BE_TIMER_PUSH(t_ra_color);
300                 be_ra_chordal_color(chordal_env);
301                 BE_TIMER_POP(t_ra_color);
302
303                 dump(BE_CH_DUMP_CONSTR, irg, pse->cls, "-color", dump_ir_block_graph_sched);
304
305                 /* Create the ifg with the selected flavor */
306                 BE_TIMER_PUSH(t_ra_ifg);
307                 chordal_env->ifg = be_create_ifg(chordal_env);
308                 BE_TIMER_POP(t_ra_ifg);
309
310                 stat_ev_if {
311                         be_ifg_stat_t   stat;
312                         be_node_stats_t node_stats;
313
314                         be_ifg_stat(birg, chordal_env->ifg, &stat);
315                         stat_ev_dbl("bechordal_ifg_nodes", stat.n_nodes);
316                         stat_ev_dbl("bechordal_ifg_edges", stat.n_edges);
317                         stat_ev_dbl("bechordal_ifg_comps", stat.n_comps);
318
319                         be_collect_node_stats(&node_stats, birg);
320                         be_subtract_node_stats(&node_stats, &last_node_stats);
321
322                         stat_ev_dbl("bechordal_perms_before_coal",
323                                         node_stats[BE_STAT_PERMS]);
324                         stat_ev_dbl("bechordal_copies_before_coal",
325                                         node_stats[BE_STAT_COPIES]);
326                 }
327
328                 /* copy minimization */
329                 BE_TIMER_PUSH(t_ra_copymin);
330                 co_driver(chordal_env);
331                 BE_TIMER_POP(t_ra_copymin);
332
333                 dump(BE_CH_DUMP_COPYMIN, irg, pse->cls, "-copymin", dump_ir_block_graph_sched);
334
335
336                 /* ssa destruction */
337                 BE_TIMER_PUSH(t_ra_ssa);
338                 be_ssa_destruction(chordal_env);
339                 BE_TIMER_POP(t_ra_ssa);
340
341                 dump(BE_CH_DUMP_SSADESTR, irg, pse->cls, "-ssadestr", dump_ir_block_graph_sched);
342
343                 if (chordal_env->opts->vrfy_option != BE_CH_VRFY_OFF) {
344                         BE_TIMER_PUSH(t_verify);
345                         be_ssa_destruction_check(chordal_env);
346                         BE_TIMER_POP(t_verify);
347                 }
348
349                 /* the ifg exists only if there are allocatable regs */
350                 be_ifg_free(chordal_env->ifg);
351         }
352
353         /* free some always allocated data structures */
354         pmap_destroy(chordal_env->border_heads);
355         bitset_free(chordal_env->ignore_colors);
356 }
357
358 /**
359  * Performs chordal register allocation for each register class on given irg.
360  *
361  * @param birg  Backend irg object
362  * @return Structure containing timer for the single phases or NULL if no timing requested.
363  */
364 static void be_ra_chordal_main(be_irg_t *birg)
365 {
366         const be_main_env_t *main_env = birg->main_env;
367         const arch_env_t    *arch_env = main_env->arch_env;
368         ir_graph            *irg      = birg->irg;
369         int                 j, m;
370         be_chordal_env_t    chordal_env;
371         struct obstack      obst;
372
373         main_opts = main_env->options;
374
375         BE_TIMER_PUSH(t_ra_other);
376
377         BE_TIMER_PUSH(t_ra_prolog);
378
379         be_assure_liveness(birg);
380
381         chordal_env.obst          = &obst;
382         chordal_env.opts          = &options;
383         chordal_env.irg           = irg;
384         chordal_env.birg          = birg;
385         chordal_env.border_heads  = NULL;
386         chordal_env.ifg           = NULL;
387         chordal_env.ignore_colors = NULL;
388
389         obstack_init(&obst);
390
391         BE_TIMER_POP(t_ra_prolog);
392
393         stat_ev_if {
394                 be_collect_node_stats(&last_node_stats, birg);
395         }
396
397         if (! arch_code_generator_has_spiller(birg->cg)) {
398                 /* use one of the generic spiller */
399
400                 /* Perform the following for each register class. */
401                 for (j = 0, m = arch_env_get_n_reg_class(arch_env); j < m; ++j) {
402                         post_spill_env_t pse;
403                         const arch_register_class_t *cls
404                                 = arch_env_get_reg_class(arch_env, j);
405
406                         if(arch_register_class_flags(cls) & arch_register_class_flag_manual_ra)
407                                 continue;
408
409
410                         stat_ev_ctx_push_str("bechordal_cls", cls->name);
411
412                         stat_ev_if {
413                                 be_do_stat_reg_pressure(birg, cls);
414                         }
415
416                         memcpy(&pse.cenv, &chordal_env, sizeof(chordal_env));
417                         pse.birg = birg;
418                         pre_spill(&pse, cls);
419
420                         BE_TIMER_PUSH(t_ra_spill);
421                         be_do_spill(birg, cls);
422                         BE_TIMER_POP(t_ra_spill);
423
424                         dump(BE_CH_DUMP_SPILL, irg, pse.cls, "-spill",
425                              dump_ir_block_graph_sched);
426
427                         post_spill(&pse, 0);
428
429                         stat_ev_if {
430                                 be_node_stats_t node_stats;
431
432                                 be_collect_node_stats(&node_stats, birg);
433                                 be_subtract_node_stats(&node_stats, &last_node_stats);
434                                 be_emit_node_stats(&node_stats, "bechordal_");
435
436                                 be_copy_node_stats(&last_node_stats, &node_stats);
437                                 stat_ev_ctx_pop("bechordal_cls");
438                         }
439                 }
440         } else {
441                 post_spill_env_t *pse;
442
443                 /* the backend has its own spiller */
444                 m = arch_env_get_n_reg_class(arch_env);
445
446                 pse = alloca(m * sizeof(pse[0]));
447
448                 for (j = 0; j < m; ++j) {
449                         memcpy(&pse[j].cenv, &chordal_env, sizeof(chordal_env));
450                         pse[j].birg = birg;
451                         pre_spill(&pse[j], pse[j].cls);
452                 }
453
454                 BE_TIMER_PUSH(t_ra_spill);
455                 arch_code_generator_spill(birg->cg, birg);
456                 BE_TIMER_POP(t_ra_spill);
457                 dump(BE_CH_DUMP_SPILL, irg, NULL, "-spill", dump_ir_block_graph_sched);
458
459                 for (j = 0; j < m; ++j) {
460                         post_spill(&pse[j], j);
461                 }
462         }
463
464         BE_TIMER_PUSH(t_verify);
465         be_verify_register_allocation(birg);
466         BE_TIMER_POP(t_verify);
467
468         BE_TIMER_PUSH(t_ra_epilog);
469         lower_nodes_after_ra(birg, options.lower_perm_opt & BE_CH_LOWER_PERM_COPY ? 1 : 0);
470         dump(BE_CH_DUMP_LOWER, irg, NULL, "-belower-after-ra", dump_ir_block_graph_sched);
471
472         obstack_free(&obst, NULL);
473         be_liveness_invalidate(be_get_birg_liveness(birg));
474         BE_TIMER_POP(t_ra_epilog);
475
476         BE_TIMER_POP(t_ra_other);
477 }
478
479 static be_ra_t be_ra_chordal_allocator = {
480         be_ra_chordal_main,
481 };
482
483 void be_init_chordal_main(void)
484 {
485         lc_opt_entry_t *be_grp = lc_opt_get_grp(firm_opt_get_root(), "be");
486         lc_opt_entry_t *ra_grp = lc_opt_get_grp(be_grp, "ra");
487         lc_opt_entry_t *chordal_grp = lc_opt_get_grp(ra_grp, "chordal");
488
489         lc_opt_add_table(chordal_grp, be_chordal_options);
490
491         be_register_allocator("chordal", &be_ra_chordal_allocator);
492 }
493
494 BE_REGISTER_MODULE_CONSTRUCTOR(be_init_chordal_main);