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