2 * @file bechordal_main.c
4 * @author Sebastian Hack
7 * Copyright (C) 2005 Universitaet Karlsruhe
8 * Released under the GPL
10 * Driver for the chordal register allocator.
21 #include "firm_config.h"
24 #include <libcore/lc_opts.h>
25 #include <libcore/lc_opts_enum.h>
26 #include <libcore/lc_timing.h>
27 #endif /* WITH_LIBCORE */
30 #include "irgraph_t.h"
31 #include "irprintf_t.h"
44 #include "bechordal_t.h"
46 #include "bejavacoal.h"
50 #include "besched_t.h"
54 #include "beifg_impl.h"
57 #include "bespillbelady.h"
58 #include "bespillmorgan.h"
59 #include "bespillslots.h"
63 #include "bespillremat.h"
66 #include "bejavacoal.h"
67 #include "becopystat.h"
68 #include "becopyopt.h"
69 #include "bessadestr.h"
71 #include "bespillcost.h"
74 void be_ra_chordal_check(be_chordal_env_t *chordal_env) {
75 const arch_env_t *arch_env = chordal_env->birg->main_env->arch_env;
78 ir_node **nodes, *n1, *n2;
80 DEBUG_ONLY(firm_dbg_module_t *dbg = chordal_env->dbg;)
82 /* Collect all irns */
84 pmap_foreach(chordal_env->border_heads, pme) {
86 struct list_head *head = pme->value;
87 list_for_each_entry(border_t, curr, head, list)
88 if (curr->is_def && curr->is_real)
89 if (arch_get_irn_reg_class(arch_env, curr->irn, -1) == chordal_env->cls)
90 obstack_ptr_grow(&ob, curr->irn);
92 obstack_ptr_grow(&ob, NULL);
93 nodes = (ir_node **) obstack_finish(&ob);
96 for (i = 0, n1 = nodes[i]; n1; n1 = nodes[++i]) {
97 const arch_register_t *n1_reg, *n2_reg;
99 n1_reg = arch_get_irn_register(arch_env, n1);
100 if (!arch_reg_is_allocatable(arch_env, n1, -1, n1_reg)) {
101 DBG((dbg, 0, "Register %s assigned to %+F is not allowed\n", n1_reg->name, n1));
102 assert(0 && "Register constraint does not hold");
104 for (o = i+1, n2 = nodes[o]; n2; n2 = nodes[++o]) {
105 n2_reg = arch_get_irn_register(arch_env, n2);
106 if (values_interfere(chordal_env->lv, n1, n2) && n1_reg == n2_reg) {
107 DBG((dbg, 0, "Values %+F and %+F interfere and have the same register assigned: %s\n", n1, n2, n1_reg->name));
108 assert(0 && "Interfering values have the same color!");
112 obstack_free(&ob, NULL);
115 int nodes_interfere(const be_chordal_env_t *env, const ir_node *a, const ir_node *b)
118 return be_ifg_connected(env->ifg, a, b);
120 return values_interfere(env->lv, a, b);
124 static be_ra_chordal_opts_t options = {
128 BE_CH_LOWER_PERM_SWAP,
132 static be_ra_timer_t ra_timer = {
146 static const lc_opt_enum_int_items_t spill_items[] = {
147 { "morgan", BE_CH_SPILL_MORGAN },
148 { "belady", BE_CH_SPILL_BELADY },
150 { "remat", BE_CH_SPILL_REMAT },
151 #endif /* WITH_ILP */
155 static const lc_opt_enum_int_items_t ifg_flavor_items[] = {
156 { "std", BE_CH_IFG_STD },
157 { "fast", BE_CH_IFG_FAST },
158 { "clique", BE_CH_IFG_CLIQUE },
159 { "pointer", BE_CH_IFG_POINTER },
160 { "list", BE_CH_IFG_LIST },
161 { "check", BE_CH_IFG_CHECK },
165 static const lc_opt_enum_int_items_t lower_perm_items[] = {
166 { "copy", BE_CH_LOWER_PERM_COPY },
167 { "swap", BE_CH_LOWER_PERM_SWAP },
171 static const lc_opt_enum_int_items_t lower_perm_stat_items[] = {
175 static const lc_opt_enum_int_items_t dump_items[] = {
176 { "spill", BE_CH_DUMP_SPILL },
177 { "live", BE_CH_DUMP_LIVE },
178 { "color", BE_CH_DUMP_COLOR },
179 { "copymin", BE_CH_DUMP_COPYMIN },
180 { "ssadestr", BE_CH_DUMP_SSADESTR },
181 { "tree", BE_CH_DUMP_TREE_INTV },
182 { "constr", BE_CH_DUMP_CONSTR },
183 { "lower", BE_CH_DUMP_LOWER },
184 { "spillslots", BE_CH_DUMP_SPILLSLOTS },
185 { "appel", BE_CH_DUMP_APPEL },
186 { "all", BE_CH_DUMP_ALL },
190 static const lc_opt_enum_int_items_t be_ch_vrfy_items[] = {
191 { "off", BE_CH_VRFY_OFF },
192 { "warn", BE_CH_VRFY_WARN },
193 { "assert", BE_CH_VRFY_ASSERT },
197 static lc_opt_enum_int_var_t spill_var = {
198 &options.spill_method, spill_items
201 static lc_opt_enum_int_var_t ifg_flavor_var = {
202 &options.ifg_flavor, ifg_flavor_items
205 static lc_opt_enum_int_var_t lower_perm_var = {
206 &options.lower_perm_opt, lower_perm_items
209 static lc_opt_enum_int_var_t dump_var = {
210 &options.dump_flags, dump_items
213 static lc_opt_enum_int_var_t be_ch_vrfy_var = {
214 &options.vrfy_option, be_ch_vrfy_items
217 /** Enable extreme live range splitting. */
218 static int be_elr_split = 0;
220 /** Assumed loop iteration count for execution frequency estimation. */
221 static int be_loop_weight = 9;
223 static const lc_opt_table_entry_t be_chordal_options[] = {
224 LC_OPT_ENT_ENUM_INT ("spill", "spill method (belady, morgan or remat)", &spill_var),
225 LC_OPT_ENT_ENUM_PTR ("ifg", "interference graph flavour (std, fast, clique, pointer, list, check)", &ifg_flavor_var),
226 LC_OPT_ENT_ENUM_PTR ("perm", "perm lowering options (copy or swap)", &lower_perm_var),
227 LC_OPT_ENT_ENUM_MASK("dump", "select dump phases", &dump_var),
228 LC_OPT_ENT_ENUM_PTR ("vrfy", "verify options (off, warn, assert)", &be_ch_vrfy_var),
229 LC_OPT_ENT_BOOL ("elrsplit", "enable extreme live range splitting", &be_elr_split),
230 LC_OPT_ENT_INT ("loop_weight", "assumed amount of loop iterations for guessing the execution frequency", &be_loop_weight),
234 static void be_ra_chordal_register_options(lc_opt_entry_t *grp)
236 static int run_once = 0;
237 lc_opt_entry_t *chordal_grp;
241 chordal_grp = lc_opt_get_grp(grp, "chordal");
243 lc_opt_add_table(chordal_grp, be_chordal_options);
246 co_register_options(chordal_grp);
247 be_java_coal_register_options(chordal_grp);
249 #endif /* WITH_LIBCORE */
251 static void dump(unsigned mask, ir_graph *irg,
252 const arch_register_class_t *cls,
254 void (*dump_func)(ir_graph *, const char *))
256 if((options.dump_flags & mask) == mask) {
259 snprintf(buf, sizeof(buf), "-%s%s", cls->name, suffix);
260 be_dump(irg, buf, dump_func);
263 be_dump(irg, suffix, dump_func);
267 static void put_ignore_colors(be_chordal_env_t *chordal_env)
269 int n_colors = chordal_env->cls->n_regs;
272 bitset_clear_all(chordal_env->ignore_colors);
273 be_abi_put_ignore_regs(chordal_env->birg->abi, chordal_env->cls, chordal_env->ignore_colors);
274 for(i = 0; i < n_colors; ++i)
275 if(arch_register_type_is(&chordal_env->cls->regs[i], ignore))
276 bitset_set(chordal_env->ignore_colors, i);
279 FILE *be_chordal_open(const be_chordal_env_t *env, const char *prefix, const char *suffix)
283 ir_snprintf(buf, sizeof(buf), "%s%F_%s%s", prefix, env->irg, env->cls->name, suffix);
284 return fopen(buf, "wt");
287 void check_ifg_implementations(be_chordal_env_t *chordal_env)
291 f = be_chordal_open(chordal_env, "std", ".log");
292 chordal_env->ifg = be_ifg_std_new(chordal_env);
293 be_ifg_check_sorted_to_file(chordal_env->ifg, f);
296 f = be_chordal_open(chordal_env, "list", ".log");
297 be_ifg_free(chordal_env->ifg);
298 chordal_env->ifg = be_ifg_list_new(chordal_env);
299 be_ifg_check_sorted_to_file(chordal_env->ifg, f);
302 f = be_chordal_open(chordal_env, "clique", ".log");
303 be_ifg_free(chordal_env->ifg);
304 chordal_env->ifg = be_ifg_clique_new(chordal_env);
305 be_ifg_check_sorted_to_file(chordal_env->ifg, f);
308 f = be_chordal_open(chordal_env, "pointer", ".log");
309 be_ifg_free(chordal_env->ifg);
310 chordal_env->ifg = be_ifg_pointer_new(chordal_env);
311 be_ifg_check_sorted_to_file(chordal_env->ifg, f);
314 chordal_env->ifg = NULL;
318 * Checks for every reload if it's user can perform the load on itself.
320 static void memory_operand_walker(ir_node *irn, void *env) {
321 be_chordal_env_t *cenv = env;
322 const arch_env_t *aenv = cenv->birg->main_env->arch_env;
323 const ir_edge_t *edge, *ne;
326 if (! be_is_Reload(irn))
329 block = get_nodes_block(irn);
331 foreach_out_edge_safe(irn, edge, ne) {
332 ir_node *src = get_edge_src_irn(edge);
333 int pos = get_edge_src_pos(edge);
338 if (get_nodes_block(src) == block && arch_possible_memory_operand(aenv, src, pos)) {
339 DBG((cenv->dbg, LEVEL_3, "performing memory operand %+F at %+F\n", irn, src));
340 arch_perform_memory_operand(aenv, src, irn, pos);
344 /* kill the Reload */
345 if (get_irn_n_edges(irn) == 0) {
347 set_irn_n(irn, 0, new_Bad());
348 set_irn_n(irn, 1, new_Bad());
353 * Starts a walk for memory operands if supported by the backend.
355 static INLINE void check_for_memory_operands(be_chordal_env_t *chordal_env) {
356 irg_walk_graph(chordal_env->irg, NULL, memory_operand_walker, chordal_env);
360 * Performs chordal register allocation for each register class on given irg.
362 * @param bi Backend irg object
363 * @return Structure containing timer for the single phases or NULL if no timing requested.
365 static be_ra_timer_t *be_ra_chordal_main(const be_irg_t *bi)
367 const be_main_env_t *main_env = bi->main_env;
368 const arch_isa_t *isa = arch_env_get_isa(main_env->arch_env);
369 ir_graph *irg = bi->irg;
370 be_options_t *main_opts = main_env->options;
374 be_chordal_env_t chordal_env;
376 if (main_opts->timing == BE_TIME_ON) {
377 ra_timer.t_prolog = lc_timer_register("ra_prolog", "regalloc prolog");
378 ra_timer.t_epilog = lc_timer_register("ra_epilog", "regalloc epilog");
379 ra_timer.t_live = lc_timer_register("ra_liveness", "be liveness");
380 ra_timer.t_spill = lc_timer_register("ra_spill", "spiller");
381 ra_timer.t_color = lc_timer_register("ra_color", "graph coloring");
382 ra_timer.t_ifg = lc_timer_register("ra_ifg", "interference graph");
383 ra_timer.t_copymin = lc_timer_register("ra_copymin", "copy minimization");
384 ra_timer.t_ssa = lc_timer_register("ra_ssadestr", "ssa destruction");
385 ra_timer.t_verify = lc_timer_register("ra_verify", "graph verification");
386 ra_timer.t_other = lc_timer_register("ra_other", "other time");
388 LC_STOP_AND_RESET_TIMER(ra_timer.t_prolog);
389 LC_STOP_AND_RESET_TIMER(ra_timer.t_epilog);
390 LC_STOP_AND_RESET_TIMER(ra_timer.t_live);
391 LC_STOP_AND_RESET_TIMER(ra_timer.t_spill);
392 LC_STOP_AND_RESET_TIMER(ra_timer.t_color);
393 LC_STOP_AND_RESET_TIMER(ra_timer.t_ifg);
394 LC_STOP_AND_RESET_TIMER(ra_timer.t_copymin);
395 LC_STOP_AND_RESET_TIMER(ra_timer.t_ssa);
396 LC_STOP_AND_RESET_TIMER(ra_timer.t_verify);
397 LC_STOP_AND_RESET_TIMER(ra_timer.t_other);
400 #define BE_TIMER_PUSH(timer) \
401 if (main_opts->timing == BE_TIME_ON) { \
402 int res = lc_timer_push(timer); \
403 if (options.vrfy_option == BE_CH_VRFY_ASSERT) \
404 assert(res && "Timer already on stack, cannot be pushed twice."); \
405 else if (options.vrfy_option == BE_CH_VRFY_WARN && ! res) \
406 fprintf(stderr, "Timer %s already on stack, cannot be pushed twice.\n", \
407 lc_timer_get_name(timer)); \
409 #define BE_TIMER_POP(timer) \
410 if (main_opts->timing == BE_TIME_ON) { \
411 lc_timer_t *tmp = lc_timer_pop(); \
412 if (options.vrfy_option == BE_CH_VRFY_ASSERT) \
413 assert(tmp == timer && "Attempt to pop wrong timer."); \
414 else if (options.vrfy_option == BE_CH_VRFY_WARN && tmp != timer) \
415 fprintf(stderr, "Attempt to pop wrong timer. %s is on stack, trying to pop %s.\n", \
416 lc_timer_get_name(tmp), lc_timer_get_name(timer)); \
420 BE_TIMER_PUSH(ra_timer.t_other);
421 BE_TIMER_PUSH(ra_timer.t_prolog);
425 chordal_env.opts = &options;
426 chordal_env.irg = irg;
427 chordal_env.birg = bi;
428 chordal_env.dom_front = be_compute_dominance_frontiers(irg);
429 chordal_env.exec_freq = compute_execfreq(irg, be_loop_weight);
430 chordal_env.lv = be_liveness(irg);
431 FIRM_DBG_REGISTER(chordal_env.dbg, "firm.be.chordal");
433 obstack_init(&chordal_env.obst);
435 BE_TIMER_POP(ra_timer.t_prolog);
437 /* Perform the following for each register class. */
438 for (j = 0, m = arch_isa_get_n_reg_class(isa); j < m; ++j) {
439 chordal_env.cls = arch_isa_get_reg_class(isa, j);
440 chordal_env.border_heads = pmap_create();
441 chordal_env.ignore_colors = bitset_malloc(chordal_env.cls->n_regs);
443 /* put all ignore registers into the ignore register set. */
444 put_ignore_colors(&chordal_env);
446 BE_TIMER_PUSH(ra_timer.t_live);
447 be_liveness_recompute(chordal_env.lv);
448 BE_TIMER_POP(ra_timer.t_live);
449 dump(BE_CH_DUMP_LIVE, irg, chordal_env.cls, "-live", dump_ir_block_graph_sched);
451 be_pre_spill_prepare_constr(&chordal_env);
452 dump(BE_CH_DUMP_CONSTR, irg, chordal_env.cls, "-constr-pre", dump_ir_block_graph_sched);
454 BE_TIMER_PUSH(ra_timer.t_spill);
457 switch(options.spill_method) {
458 case BE_CH_SPILL_MORGAN:
459 be_spill_morgan(&chordal_env);
461 case BE_CH_SPILL_BELADY:
462 be_spill_belady(&chordal_env);
465 case BE_CH_SPILL_REMAT:
466 be_spill_remat(&chordal_env);
468 #endif /* WITH_ILP */
470 fprintf(stderr, "no valid spiller selected. falling back to belady\n");
471 be_spill_belady(&chordal_env);
474 BE_TIMER_POP(ra_timer.t_spill);
476 DBG((chordal_env.dbg, LEVEL_1, "spill costs for %+F in regclass %s: %g\n",
478 chordal_env.cls->name,
479 get_irg_spill_cost(&chordal_env))
482 dump(BE_CH_DUMP_SPILL, irg, chordal_env.cls, "-spill", dump_ir_block_graph_sched);
483 check_for_memory_operands(&chordal_env);
484 be_abi_fix_stack_nodes(bi->abi, chordal_env.lv);
486 BE_TIMER_PUSH(ra_timer.t_verify);
488 /* verify schedule and register pressure */
489 if (options.vrfy_option == BE_CH_VRFY_WARN) {
490 be_verify_schedule(irg);
491 be_verify_register_pressure(chordal_env.birg->main_env->arch_env, chordal_env.cls, irg);
493 else if (options.vrfy_option == BE_CH_VRFY_ASSERT) {
494 assert(be_verify_schedule(irg) && "Schedule verification failed");
495 assert(be_verify_register_pressure(chordal_env.birg->main_env->arch_env, chordal_env.cls, irg)
496 && "Register pressure verification failed");
498 BE_TIMER_POP(ra_timer.t_verify);
500 if (be_elr_split && ! splitted) {
501 extreme_liverange_splitting(&chordal_env);
506 /* Color the graph. */
507 BE_TIMER_PUSH(ra_timer.t_color);
508 be_ra_chordal_color(&chordal_env);
509 BE_TIMER_POP(ra_timer.t_color);
511 dump(BE_CH_DUMP_CONSTR, irg, chordal_env.cls, "-color", dump_ir_block_graph_sched);
513 /* Create the ifg with the selected flavor */
514 BE_TIMER_PUSH(ra_timer.t_ifg);
515 switch (options.ifg_flavor) {
517 fprintf(stderr, "no valid ifg flavour selected. falling back to std\n");
520 chordal_env.ifg = be_ifg_std_new(&chordal_env);
522 case BE_CH_IFG_CLIQUE:
523 chordal_env.ifg = be_ifg_clique_new(&chordal_env);
525 case BE_CH_IFG_POINTER:
526 chordal_env.ifg = be_ifg_pointer_new(&chordal_env);
529 chordal_env.ifg = be_ifg_list_new(&chordal_env);
531 case BE_CH_IFG_CHECK:
532 check_ifg_implementations(&chordal_env);
533 /* Build the interference graph. */
534 chordal_env.ifg = be_ifg_std_new(&chordal_env);
537 BE_TIMER_POP(ra_timer.t_ifg);
539 BE_TIMER_PUSH(ra_timer.t_verify);
540 if (options.vrfy_option != BE_CH_VRFY_OFF)
541 be_ra_chordal_check(&chordal_env);
543 BE_TIMER_POP(ra_timer.t_verify);
545 /* copy minimization */
546 BE_TIMER_PUSH(ra_timer.t_copymin);
547 co_driver(&chordal_env);
548 BE_TIMER_POP(ra_timer.t_copymin);
549 dump(BE_CH_DUMP_COPYMIN, irg, chordal_env.cls, "-copymin", dump_ir_block_graph_sched);
551 BE_TIMER_PUSH(ra_timer.t_verify);
553 if (options.vrfy_option != BE_CH_VRFY_OFF)
554 be_ra_chordal_check(&chordal_env);
556 BE_TIMER_POP(ra_timer.t_verify);
557 BE_TIMER_PUSH(ra_timer.t_ssa);
559 /* ssa destruction */
560 be_ssa_destruction(&chordal_env);
562 BE_TIMER_POP(ra_timer.t_ssa);
564 dump(BE_CH_DUMP_SSADESTR, irg, chordal_env.cls, "-ssadestr", dump_ir_block_graph_sched);
566 BE_TIMER_PUSH(ra_timer.t_verify);
567 if (options.vrfy_option != BE_CH_VRFY_OFF) {
568 be_ssa_destruction_check(&chordal_env);
569 be_ra_chordal_check(&chordal_env);
571 BE_TIMER_POP(ra_timer.t_verify);
573 be_ifg_free(chordal_env.ifg);
574 pmap_destroy(chordal_env.border_heads);
575 bitset_free(chordal_env.ignore_colors);
578 be_coalesce_spillslots(&chordal_env);
579 dump(BE_CH_DUMP_SPILLSLOTS, irg, NULL, "-spillslots", dump_ir_block_graph_sched);
581 BE_TIMER_PUSH(ra_timer.t_epilog);
583 dump(BE_CH_DUMP_LOWER, irg, NULL, "-spilloff", dump_ir_block_graph_sched);
585 lower_nodes_after_ra(&chordal_env, options.lower_perm_opt & BE_CH_LOWER_PERM_COPY ? 1 : 0);
586 dump(BE_CH_DUMP_LOWER, irg, NULL, "-belower-after-ra", dump_ir_block_graph_sched);
588 obstack_free(&chordal_env.obst, NULL);
589 be_free_dominance_frontiers(chordal_env.dom_front);
590 be_liveness_free(chordal_env.lv);
591 free_execfreq(chordal_env.exec_freq);
593 BE_TIMER_POP(ra_timer.t_epilog);
594 BE_TIMER_POP(ra_timer.t_other);
599 return main_opts->timing == BE_TIME_ON ? &ra_timer : NULL;
602 const be_ra_t be_ra_chordal_allocator = {
604 be_ra_chordal_register_options,