2 * @file bechordal_main.c
4 * @author Sebastian Hack
6 * Copyright (C) 2005 Universitaet Karlsruhe
7 * Released under the GPL
9 * Driver for the chordal register allocator.
20 #include "firm_config.h"
23 #include <libcore/lc_opts.h>
24 #include <libcore/lc_opts_enum.h>
25 #include <libcore/lc_timing.h>
26 #endif /* WITH_LIBCORE */
29 #include "irgraph_t.h"
30 #include "irprintf_t.h"
38 #include "bechordal_t.h"
43 #include "besched_t.h"
47 #include "beifg_impl.h"
49 #include "bespillbelady.h"
50 #include "bespillmorgan.h"
54 #include "bespillilp.h"
55 #include "bespillremat.h"
56 #include "bespillappel.h"
59 #include "becopystat.h"
60 #include "becopyopt.h"
61 #include "bessadestr.h"
65 void be_ra_chordal_check(be_chordal_env_t *chordal_env) {
66 const arch_env_t *arch_env = chordal_env->birg->main_env->arch_env;
69 ir_node **nodes, *n1, *n2;
71 DEBUG_ONLY(firm_dbg_module_t *dbg = chordal_env->dbg;)
73 /* Collect all irns */
75 pmap_foreach(chordal_env->border_heads, pme) {
77 struct list_head *head = pme->value;
78 list_for_each_entry(border_t, curr, head, list)
79 if (curr->is_def && curr->is_real)
80 if (arch_get_irn_reg_class(arch_env, curr->irn, -1) == chordal_env->cls)
81 obstack_ptr_grow(&ob, curr->irn);
83 obstack_ptr_grow(&ob, NULL);
84 nodes = (ir_node **) obstack_finish(&ob);
87 for (i = 0, n1 = nodes[i]; n1; n1 = nodes[++i]) {
88 const arch_register_t *n1_reg, *n2_reg;
90 n1_reg = arch_get_irn_register(arch_env, n1);
91 if (!arch_reg_is_allocatable(arch_env, n1, -1, n1_reg)) {
92 DBG((dbg, 0, "Register %s assigned to %+F is not allowed\n", n1_reg->name, n1));
93 assert(0 && "Register constraint does not hold");
95 for (o = i+1, n2 = nodes[o]; n2; n2 = nodes[++o]) {
96 n2_reg = arch_get_irn_register(arch_env, n2);
97 if (values_interfere(n1, n2) && n1_reg == n2_reg) {
98 DBG((dbg, 0, "Values %+F and %+F interfere and have the same register assigned: %s\n", n1, n2, n1_reg->name));
99 assert(0 && "Interfering values have the same color!");
103 obstack_free(&ob, NULL);
106 int nodes_interfere(const be_chordal_env_t *env, const ir_node *a, const ir_node *b)
109 return be_ifg_connected(env->ifg, a, b);
111 return values_interfere(a, b);
115 static be_ra_chordal_opts_t options = {
120 BE_CH_LOWER_PERM_SWAP,
124 static be_ra_timer_t ra_timer = {
145 static const lc_opt_enum_int_items_t spill_items[] = {
146 { "morgan", BE_CH_SPILL_MORGAN },
147 { "belady", BE_CH_SPILL_BELADY },
149 { "ilp", BE_CH_SPILL_ILP },
150 { "remat", BE_CH_SPILL_REMAT },
151 { "appel", BE_CH_SPILL_APPEL },
152 #endif /* WITH_ILP */
156 static const lc_opt_enum_int_items_t copymin_items[] = {
157 { "none", BE_CH_COPYMIN_NONE },
158 { "heur1", BE_CH_COPYMIN_HEUR1 },
159 { "heur2", BE_CH_COPYMIN_HEUR2 },
160 { "stat", BE_CH_COPYMIN_STAT },
161 { "park", BE_CH_COPYMIN_PARK_MOON },
163 { "ilp1", BE_CH_COPYMIN_ILP1 },
164 { "ilp2", BE_CH_COPYMIN_ILP2 },
165 #endif /* WITH_ILP */
169 static const lc_opt_enum_int_items_t ifg_flavor_items[] = {
170 { "std", BE_CH_IFG_STD },
171 { "fast", BE_CH_IFG_FAST },
172 { "clique", BE_CH_IFG_CLIQUE },
173 { "pointer", BE_CH_IFG_POINTER },
174 { "list", BE_CH_IFG_LIST },
175 { "check", BE_CH_IFG_CHECK },
179 static const lc_opt_enum_int_items_t lower_perm_items[] = {
180 { "copy", BE_CH_LOWER_PERM_COPY },
181 { "swap", BE_CH_LOWER_PERM_SWAP },
185 static const lc_opt_enum_int_items_t lower_perm_stat_items[] = {
189 static const lc_opt_enum_int_items_t dump_items[] = {
190 { "spill", BE_CH_DUMP_SPILL },
191 { "live", BE_CH_DUMP_LIVE },
192 { "color", BE_CH_DUMP_COLOR },
193 { "copymin", BE_CH_DUMP_COPYMIN },
194 { "ssadestr", BE_CH_DUMP_SSADESTR },
195 { "tree", BE_CH_DUMP_TREE_INTV },
196 { "constr", BE_CH_DUMP_CONSTR },
197 { "lower", BE_CH_DUMP_LOWER },
198 { "all", BE_CH_DUMP_ALL },
202 static const lc_opt_enum_int_items_t be_ch_vrfy_items[] = {
203 { "off", BE_CH_VRFY_OFF },
204 { "warn", BE_CH_VRFY_WARN },
205 { "assert", BE_CH_VRFY_ASSERT },
209 static lc_opt_enum_int_var_t spill_var = {
210 &options.spill_method, spill_items
213 static lc_opt_enum_int_var_t copymin_var = {
214 &options.copymin_method, copymin_items
217 static lc_opt_enum_int_var_t ifg_flavor_var = {
218 &options.ifg_flavor, ifg_flavor_items
221 static lc_opt_enum_int_var_t lower_perm_var = {
222 &options.lower_perm_opt, lower_perm_items
225 static lc_opt_enum_int_var_t dump_var = {
226 &options.dump_flags, dump_items
229 static lc_opt_enum_int_var_t be_ch_vrfy_var = {
230 &options.vrfy_option, be_ch_vrfy_items
233 static const lc_opt_table_entry_t be_chordal_options[] = {
234 LC_OPT_ENT_ENUM_MASK("spill", "spill method (belady, ilp, remat or appel)", &spill_var),
235 LC_OPT_ENT_ENUM_PTR ("copymin", "copymin method (none, heur1, heur2, ilp1, ilp2 or stat)", ©min_var),
236 LC_OPT_ENT_ENUM_PTR ("ifg", "interference graph flavour (std, fast, clique, pointer, list, check)", &ifg_flavor_var),
237 LC_OPT_ENT_ENUM_PTR ("perm", "perm lowering options (copy or swap)", &lower_perm_var),
238 LC_OPT_ENT_ENUM_MASK("dump", "select dump phases", &dump_var),
239 LC_OPT_ENT_ENUM_PTR ("vrfy", "verify options (off, warn, assert)", &be_ch_vrfy_var),
243 static void be_ra_chordal_register_options(lc_opt_entry_t *grp)
245 static int run_once = 0;
246 lc_opt_entry_t *chordal_grp;
250 chordal_grp = lc_opt_get_grp(grp, "chordal");
252 lc_opt_add_table(chordal_grp, be_chordal_options);
255 co_register_options(chordal_grp);
257 #endif /* WITH_LIBCORE */
259 static void dump(unsigned mask, ir_graph *irg,
260 const arch_register_class_t *cls,
262 void (*dump_func)(ir_graph *, const char *))
264 if((options.dump_flags & mask) == mask) {
267 snprintf(buf, sizeof(buf), "-%s%s", cls->name, suffix);
268 be_dump(irg, buf, dump_func);
271 be_dump(irg, suffix, dump_func);
275 static void put_ignore_colors(be_chordal_env_t *chordal_env)
277 int n_colors = chordal_env->cls->n_regs;
280 bitset_clear_all(chordal_env->ignore_colors);
281 be_abi_put_ignore_regs(chordal_env->birg->abi, chordal_env->cls, chordal_env->ignore_colors);
282 for(i = 0; i < n_colors; ++i)
283 if(arch_register_type_is(&chordal_env->cls->regs[i], ignore))
284 bitset_set(chordal_env->ignore_colors, i);
287 FILE *be_chordal_open(const be_chordal_env_t *env, const char *prefix, const char *suffix)
291 ir_snprintf(buf, sizeof(buf), "%s%F_%s.%s", prefix, env->irg, env->cls->name, suffix);
292 return fopen(buf, "wt");
295 void check_ifg_implementations(be_chordal_env_t *chordal_env)
299 f = be_chordal_open(chordal_env, "std", "log");
300 chordal_env->ifg = be_ifg_std_new(chordal_env);
301 be_ifg_check_sorted_to_file(chordal_env->ifg, f);
304 f = be_chordal_open(chordal_env, "list", "log");
305 be_ifg_free(chordal_env->ifg);
306 chordal_env->ifg = be_ifg_list_new(chordal_env);
307 be_ifg_check_sorted_to_file(chordal_env->ifg, f);
310 f = be_chordal_open(chordal_env, "clique", "log");
311 be_ifg_free(chordal_env->ifg);
312 chordal_env->ifg = be_ifg_clique_new(chordal_env);
313 be_ifg_check_sorted_to_file(chordal_env->ifg, f);
316 f = be_chordal_open(chordal_env, "pointer", "log");
317 be_ifg_free(chordal_env->ifg);
318 chordal_env->ifg = be_ifg_pointer_new(chordal_env);
319 be_ifg_check_sorted_to_file(chordal_env->ifg, f);
322 chordal_env->ifg = NULL;
325 static be_ra_timer_t *be_ra_chordal_main(const be_irg_t *bi)
327 const be_main_env_t *main_env = bi->main_env;
328 const arch_isa_t *isa = arch_env_get_isa(main_env->arch_env);
329 ir_graph *irg = bi->irg;
330 be_options_t *main_opts = main_env->options;
334 be_chordal_env_t chordal_env;
336 if (main_opts->timing == BE_TIME_ON) {
337 ra_timer.t_prolog = lc_timer_register("prolog", "regalloc prolog");
338 ra_timer.t_epilog = lc_timer_register("epilog", "regalloc epilog");
339 ra_timer.t_live = lc_timer_register("liveness", "be liveness");
340 ra_timer.t_spill = lc_timer_register("spill", "spiller");
341 ra_timer.t_color = lc_timer_register("color", "graph coloring");
342 ra_timer.t_ifg = lc_timer_register("ifg", "build interference graph");
343 ra_timer.t_copymin = lc_timer_register("copymin", "copy minimization");
344 ra_timer.t_ssa = lc_timer_register("ssadestr", "ssa destruction");
346 LC_STOP_AND_RESET_TIMER(ra_timer.t_prolog);
347 LC_STOP_AND_RESET_TIMER(ra_timer.t_epilog);
348 LC_STOP_AND_RESET_TIMER(ra_timer.t_live);
349 LC_STOP_AND_RESET_TIMER(ra_timer.t_spill);
350 LC_STOP_AND_RESET_TIMER(ra_timer.t_color);
351 LC_STOP_AND_RESET_TIMER(ra_timer.t_ifg);
352 LC_STOP_AND_RESET_TIMER(ra_timer.t_copymin);
353 LC_STOP_AND_RESET_TIMER(ra_timer.t_ssa);
356 #define BE_TIME_START(timer) if (main_opts->timing == BE_TIME_ON) lc_timer_start(timer)
357 #define BE_TIME_STOP(timer) if (main_opts->timing == BE_TIME_ON) lc_timer_stop(timer)
359 BE_TIME_START(ra_timer.t_prolog);
363 chordal_env.opts = &options;
364 chordal_env.irg = irg;
365 chordal_env.birg = bi;
366 chordal_env.dom_front = be_compute_dominance_frontiers(irg);
367 FIRM_DBG_REGISTER(chordal_env.dbg, "firm.be.chordal");
369 obstack_init(&chordal_env.obst);
371 BE_TIME_STOP(ra_timer.t_prolog);
373 /* Perform the following for each register class. */
374 for(j = 0, m = arch_isa_get_n_reg_class(isa); j < m; ++j) {
376 chordal_env.cls = arch_isa_get_reg_class(isa, j);
377 chordal_env.border_heads = pmap_create();
378 chordal_env.ignore_colors = bitset_malloc(chordal_env.cls->n_regs);
380 BE_TIME_START(ra_timer.t_live);
382 /* put all ignore registers into the ignore register set. */
383 put_ignore_colors(&chordal_env);
386 dump(BE_CH_DUMP_LIVE, irg, chordal_env.cls, "-live", dump_ir_block_graph_sched);
388 BE_TIME_STOP(ra_timer.t_live);
389 BE_TIME_START(ra_timer.t_spill);
392 switch(options.spill_method) {
393 case BE_CH_SPILL_MORGAN:
394 be_spill_morgan(&chordal_env);
396 case BE_CH_SPILL_BELADY:
397 be_spill_belady(&chordal_env);
400 case BE_CH_SPILL_ILP:
401 be_spill_ilp(&chordal_env);
403 case BE_CH_SPILL_REMAT:
404 be_spill_remat(&chordal_env);
406 case BE_CH_SPILL_APPEL:
407 be_spill_appel(&chordal_env);
409 #endif /* WITH_ILP */
411 fprintf(stderr, "no valid spiller selected. falling back to belady\n");
412 be_spill_belady(&chordal_env);
414 dump(BE_CH_DUMP_SPILL, irg, chordal_env.cls, "-spill", dump_ir_block_graph_sched);
415 be_abi_fix_stack_nodes(bi->abi);
417 /* verify schedule and register pressure */
418 if (options.vrfy_option == BE_CH_VRFY_WARN) {
419 be_verify_schedule(irg);
420 be_verify_register_pressure(chordal_env.birg->main_env->arch_env, chordal_env.cls, irg);
422 else if (options.vrfy_option == BE_CH_VRFY_ASSERT) {
423 assert(be_verify_schedule(irg) && "Schedule verification failed");
424 assert(be_verify_register_pressure(chordal_env.birg->main_env->arch_env, chordal_env.cls, irg)
425 && "Register pressure verification failed");
428 BE_TIME_STOP(ra_timer.t_spill);
429 BE_TIME_START(ra_timer.t_live);
431 BE_TIME_STOP(ra_timer.t_live);
433 /* Color the graph. */
434 BE_TIME_START(ra_timer.t_color);
435 be_ra_chordal_color(&chordal_env);
436 dump(BE_CH_DUMP_CONSTR, irg, chordal_env.cls, "-color", dump_ir_block_graph_sched);
438 BE_TIME_STOP(ra_timer.t_color);
439 BE_TIME_START(ra_timer.t_ifg);
440 //be_ifg_check_performance(&chordal_env);
442 /* Create the ifg with the selected flavor */
443 switch (options.ifg_flavor) {
445 fprintf(stderr, "no valid ifg flavour selected. falling back to std\n");
448 chordal_env.ifg = be_ifg_std_new(&chordal_env);
450 case BE_CH_IFG_CLIQUE:
451 chordal_env.ifg = be_ifg_clique_new(&chordal_env);
453 case BE_CH_IFG_POINTER:
454 chordal_env.ifg = be_ifg_pointer_new(&chordal_env);
457 chordal_env.ifg = be_ifg_list_new(&chordal_env);
459 case BE_CH_IFG_CHECK:
460 check_ifg_implementations(&chordal_env);
461 /* Build the interference graph. */
462 chordal_env.ifg = be_ifg_std_new(&chordal_env);
463 //be_ifg_check(chordal_env.ifg);
464 //be_ifg_check_sorted(chordal_env.ifg);
471 be_ifg_t *std = be_ifg_std_new(&chordal_env);
472 f = be_chordal_open(&chordal_env, "std", "csv");
473 be_ifg_check_sorted_to_file(std, f);
478 f = be_chordal_open(&chordal_env, "clique", "csv");
479 be_ifg_check_sorted_to_file(chordal_env.ifg, f);
482 if (options.vrfy_option != BE_CH_VRFY_OFF)
483 be_ra_chordal_check(&chordal_env);
485 // be_ifg_check_sorted(chordal_env.ifg);
487 BE_TIME_STOP(ra_timer.t_ifg);
488 BE_TIME_START(ra_timer.t_copymin);
490 /* copy minimization */
492 if (options.copymin_method != BE_CH_COPYMIN_NONE && options.copymin_method != BE_CH_COPYMIN_STAT) {
493 co = new_copy_opt(&chordal_env, co_get_costs_loop_depth);
494 co_build_ou_structure(co);
495 co_build_graph_structure(co);
498 switch(options.copymin_method) {
499 case BE_CH_COPYMIN_HEUR1:
500 co_solve_heuristic(co);
502 case BE_CH_COPYMIN_HEUR2:
503 co_solve_heuristic_new(co);
505 case BE_CH_COPYMIN_PARK_MOON:
506 co_solve_park_moon(co);
508 case BE_CH_COPYMIN_STAT:
509 co_compare_solvers(&chordal_env);
512 case BE_CH_COPYMIN_ILP1:
513 printf("FIXME: %s:%d ILP1 not yet implemented!\n", __FILE__, __LINE__);
514 co_solve_ilp1(co, 60.0);
516 case BE_CH_COPYMIN_ILP2:
517 co_solve_ilp2(co, 60.0);
519 #endif /* WITH_ILP */
520 case BE_CH_COPYMIN_NONE:
526 co_free_graph_structure(co);
527 co_free_ou_structure(co);
531 dump(BE_CH_DUMP_COPYMIN, irg, chordal_env.cls, "-copymin", dump_ir_block_graph_sched);
532 if (options.vrfy_option != BE_CH_VRFY_OFF)
533 be_ra_chordal_check(&chordal_env);
535 BE_TIME_STOP(ra_timer.t_copymin);
536 BE_TIME_START(ra_timer.t_ssa);
538 /* ssa destruction */
539 be_ssa_destruction(&chordal_env);
540 dump(BE_CH_DUMP_SSADESTR, irg, chordal_env.cls, "-ssadestr", dump_ir_block_graph_sched);
541 if (options.vrfy_option != BE_CH_VRFY_OFF) {
542 be_ssa_destruction_check(&chordal_env);
543 be_ra_chordal_check(&chordal_env);
546 if (options.copymin_method == BE_CH_COPYMIN_STAT)
549 be_ifg_free(chordal_env.ifg);
550 pmap_destroy(chordal_env.border_heads);
551 bitset_free(chordal_env.ignore_colors);
553 BE_TIME_STOP(ra_timer.t_ssa);
556 BE_TIME_START(ra_timer.t_epilog);
558 be_compute_spill_offsets(&chordal_env);
560 dump(BE_CH_DUMP_LOWER, irg, NULL, "-spilloff", dump_ir_block_graph_sched);
562 lower_nodes_after_ra(&chordal_env, options.lower_perm_opt & BE_CH_LOWER_PERM_COPY ? 1 : 0);
563 dump(BE_CH_DUMP_LOWER, irg, NULL, "-belower-after-ra", dump_ir_block_graph_sched);
565 obstack_free(&chordal_env.obst, NULL);
566 be_free_dominance_frontiers(chordal_env.dom_front);
568 BE_TIME_STOP(ra_timer.t_epilog);
570 if (main_opts->timing == BE_TIME_ON)
576 const be_ra_t be_ra_chordal_allocator = {
578 be_ra_chordal_register_options,