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"
39 #include "bechordal_t.h"
44 #include "besched_t.h"
48 #include "beifg_impl.h"
50 #include "bespillbelady.h"
51 #include "bespillmorgan.h"
55 #include "bespillremat.h"
58 #include "becopystat.h"
59 #include "becopyopt.h"
60 #include "bessadestr.h"
63 void be_ra_chordal_check(be_chordal_env_t *chordal_env) {
64 const arch_env_t *arch_env = chordal_env->birg->main_env->arch_env;
67 ir_node **nodes, *n1, *n2;
69 DEBUG_ONLY(firm_dbg_module_t *dbg = chordal_env->dbg;)
71 /* Collect all irns */
73 pmap_foreach(chordal_env->border_heads, pme) {
75 struct list_head *head = pme->value;
76 list_for_each_entry(border_t, curr, head, list)
77 if (curr->is_def && curr->is_real)
78 if (arch_get_irn_reg_class(arch_env, curr->irn, -1) == chordal_env->cls)
79 obstack_ptr_grow(&ob, curr->irn);
81 obstack_ptr_grow(&ob, NULL);
82 nodes = (ir_node **) obstack_finish(&ob);
85 for (i = 0, n1 = nodes[i]; n1; n1 = nodes[++i]) {
86 const arch_register_t *n1_reg, *n2_reg;
88 n1_reg = arch_get_irn_register(arch_env, n1);
89 if (!arch_reg_is_allocatable(arch_env, n1, -1, n1_reg)) {
90 DBG((dbg, 0, "Register %s assigned to %+F is not allowed\n", n1_reg->name, n1));
91 assert(0 && "Register constraint does not hold");
93 for (o = i+1, n2 = nodes[o]; n2; n2 = nodes[++o]) {
94 n2_reg = arch_get_irn_register(arch_env, n2);
95 if (values_interfere(n1, n2) && n1_reg == n2_reg) {
96 DBG((dbg, 0, "Values %+F and %+F interfere and have the same register assigned: %s\n", n1, n2, n1_reg->name));
97 assert(0 && "Interfering values have the same color!");
101 obstack_free(&ob, NULL);
104 int nodes_interfere(const be_chordal_env_t *env, const ir_node *a, const ir_node *b)
107 return be_ifg_connected(env->ifg, a, b);
109 return values_interfere(a, b);
113 static be_ra_chordal_opts_t options = {
118 BE_CH_LOWER_PERM_SWAP,
122 static be_ra_timer_t ra_timer = {
136 static const lc_opt_enum_int_items_t spill_items[] = {
137 { "morgan", BE_CH_SPILL_MORGAN },
138 { "belady", BE_CH_SPILL_BELADY },
140 { "remat", BE_CH_SPILL_REMAT },
141 #endif /* WITH_ILP */
145 static const lc_opt_enum_int_items_t copymin_items[] = {
146 { "none", BE_CH_COPYMIN_NONE },
147 { "heur1", BE_CH_COPYMIN_HEUR1 },
148 { "heur2", BE_CH_COPYMIN_HEUR2 },
149 { "stat", BE_CH_COPYMIN_STAT },
150 { "park", BE_CH_COPYMIN_PARK_MOON },
152 { "ilp1", BE_CH_COPYMIN_ILP1 },
153 { "ilp2", BE_CH_COPYMIN_ILP2 },
154 #endif /* WITH_ILP */
158 static const lc_opt_enum_int_items_t ifg_flavor_items[] = {
159 { "std", BE_CH_IFG_STD },
160 { "fast", BE_CH_IFG_FAST },
161 { "clique", BE_CH_IFG_CLIQUE },
162 { "pointer", BE_CH_IFG_POINTER },
163 { "list", BE_CH_IFG_LIST },
164 { "check", BE_CH_IFG_CHECK },
168 static const lc_opt_enum_int_items_t lower_perm_items[] = {
169 { "copy", BE_CH_LOWER_PERM_COPY },
170 { "swap", BE_CH_LOWER_PERM_SWAP },
174 static const lc_opt_enum_int_items_t lower_perm_stat_items[] = {
178 static const lc_opt_enum_int_items_t dump_items[] = {
179 { "spill", BE_CH_DUMP_SPILL },
180 { "live", BE_CH_DUMP_LIVE },
181 { "color", BE_CH_DUMP_COLOR },
182 { "copymin", BE_CH_DUMP_COPYMIN },
183 { "ssadestr", BE_CH_DUMP_SSADESTR },
184 { "tree", BE_CH_DUMP_TREE_INTV },
185 { "constr", BE_CH_DUMP_CONSTR },
186 { "lower", BE_CH_DUMP_LOWER },
187 { "all", BE_CH_DUMP_ALL },
191 static const lc_opt_enum_int_items_t be_ch_vrfy_items[] = {
192 { "off", BE_CH_VRFY_OFF },
193 { "warn", BE_CH_VRFY_WARN },
194 { "assert", BE_CH_VRFY_ASSERT },
198 static lc_opt_enum_int_var_t spill_var = {
199 &options.spill_method, spill_items
202 static lc_opt_enum_int_var_t copymin_var = {
203 &options.copymin_method, copymin_items
206 static lc_opt_enum_int_var_t ifg_flavor_var = {
207 &options.ifg_flavor, ifg_flavor_items
210 static lc_opt_enum_int_var_t lower_perm_var = {
211 &options.lower_perm_opt, lower_perm_items
214 static lc_opt_enum_int_var_t dump_var = {
215 &options.dump_flags, dump_items
218 static lc_opt_enum_int_var_t be_ch_vrfy_var = {
219 &options.vrfy_option, be_ch_vrfy_items
222 static int be_copymin_stats = 0;
224 /** Assumed loop iteration count for execution frequency estimation. */
225 static int be_loop_weight = 9;
227 static const lc_opt_table_entry_t be_chordal_options[] = {
228 LC_OPT_ENT_ENUM_INT ("spill", "spill method (belady, morgan or remat)", &spill_var),
229 LC_OPT_ENT_ENUM_PTR ("copymin", "copymin method (none, heur1, heur2, ilp1, ilp2 or stat)", ©min_var),
230 LC_OPT_ENT_ENUM_PTR ("ifg", "interference graph flavour (std, fast, clique, pointer, list, check)", &ifg_flavor_var),
231 LC_OPT_ENT_ENUM_PTR ("perm", "perm lowering options (copy or swap)", &lower_perm_var),
232 LC_OPT_ENT_ENUM_MASK("dump", "select dump phases", &dump_var),
233 LC_OPT_ENT_ENUM_PTR ("vrfy", "verify options (off, warn, assert)", &be_ch_vrfy_var),
234 LC_OPT_ENT_BOOL ("copymin_stats", "dump statistics of copy minimization", &be_copymin_stats),
235 LC_OPT_ENT_INT ("loop_weight", "assumed amount of loop iterations for guessing the execution frequency", &be_loop_weight),
239 static void be_ra_chordal_register_options(lc_opt_entry_t *grp)
241 static int run_once = 0;
242 lc_opt_entry_t *chordal_grp;
246 chordal_grp = lc_opt_get_grp(grp, "chordal");
248 lc_opt_add_table(chordal_grp, be_chordal_options);
251 co_register_options(chordal_grp);
253 #endif /* WITH_LIBCORE */
255 static void dump(unsigned mask, ir_graph *irg,
256 const arch_register_class_t *cls,
258 void (*dump_func)(ir_graph *, const char *))
260 if((options.dump_flags & mask) == mask) {
263 snprintf(buf, sizeof(buf), "-%s%s", cls->name, suffix);
264 be_dump(irg, buf, dump_func);
267 be_dump(irg, suffix, dump_func);
271 static void put_ignore_colors(be_chordal_env_t *chordal_env)
273 int n_colors = chordal_env->cls->n_regs;
276 bitset_clear_all(chordal_env->ignore_colors);
277 be_abi_put_ignore_regs(chordal_env->birg->abi, chordal_env->cls, chordal_env->ignore_colors);
278 for(i = 0; i < n_colors; ++i)
279 if(arch_register_type_is(&chordal_env->cls->regs[i], ignore))
280 bitset_set(chordal_env->ignore_colors, i);
283 FILE *be_chordal_open(const be_chordal_env_t *env, const char *prefix, const char *suffix)
287 ir_snprintf(buf, sizeof(buf), "%s%F_%s.%s", prefix, env->irg, env->cls->name, suffix);
288 return fopen(buf, "wt");
291 void check_ifg_implementations(be_chordal_env_t *chordal_env)
295 f = be_chordal_open(chordal_env, "std", "log");
296 chordal_env->ifg = be_ifg_std_new(chordal_env);
297 be_ifg_check_sorted_to_file(chordal_env->ifg, f);
300 f = be_chordal_open(chordal_env, "list", "log");
301 be_ifg_free(chordal_env->ifg);
302 chordal_env->ifg = be_ifg_list_new(chordal_env);
303 be_ifg_check_sorted_to_file(chordal_env->ifg, f);
306 f = be_chordal_open(chordal_env, "clique", "log");
307 be_ifg_free(chordal_env->ifg);
308 chordal_env->ifg = be_ifg_clique_new(chordal_env);
309 be_ifg_check_sorted_to_file(chordal_env->ifg, f);
312 f = be_chordal_open(chordal_env, "pointer", "log");
313 be_ifg_free(chordal_env->ifg);
314 chordal_env->ifg = be_ifg_pointer_new(chordal_env);
315 be_ifg_check_sorted_to_file(chordal_env->ifg, f);
318 chordal_env->ifg = NULL;
321 static be_ra_timer_t *be_ra_chordal_main(const be_irg_t *bi)
323 const be_main_env_t *main_env = bi->main_env;
324 const arch_isa_t *isa = arch_env_get_isa(main_env->arch_env);
325 ir_graph *irg = bi->irg;
326 be_options_t *main_opts = main_env->options;
330 be_chordal_env_t chordal_env;
332 if (main_opts->timing == BE_TIME_ON) {
333 ra_timer.t_prolog = lc_timer_register("ra_prolog", "regalloc prolog");
334 ra_timer.t_epilog = lc_timer_register("ra_epilog", "regalloc epilog");
335 ra_timer.t_live = lc_timer_register("ra_liveness", "be liveness");
336 ra_timer.t_spill = lc_timer_register("ra_spill", "spiller");
337 ra_timer.t_color = lc_timer_register("ra_color", "graph coloring");
338 ra_timer.t_ifg = lc_timer_register("ra_ifg", "interference graph");
339 ra_timer.t_copymin = lc_timer_register("ra_copymin", "copy minimization");
340 ra_timer.t_ssa = lc_timer_register("ra_ssadestr", "ssa destruction");
341 ra_timer.t_verify = lc_timer_register("ra_verify", "graph verification");
342 ra_timer.t_other = lc_timer_register("ra_other", "other time");
344 LC_STOP_AND_RESET_TIMER(ra_timer.t_prolog);
345 LC_STOP_AND_RESET_TIMER(ra_timer.t_epilog);
346 LC_STOP_AND_RESET_TIMER(ra_timer.t_live);
347 LC_STOP_AND_RESET_TIMER(ra_timer.t_spill);
348 LC_STOP_AND_RESET_TIMER(ra_timer.t_color);
349 LC_STOP_AND_RESET_TIMER(ra_timer.t_ifg);
350 LC_STOP_AND_RESET_TIMER(ra_timer.t_copymin);
351 LC_STOP_AND_RESET_TIMER(ra_timer.t_ssa);
352 LC_STOP_AND_RESET_TIMER(ra_timer.t_verify);
353 LC_STOP_AND_RESET_TIMER(ra_timer.t_other);
356 #define BE_TIMER_PUSH(timer) \
357 if (main_opts->timing == BE_TIME_ON) { \
358 int res = lc_timer_push(timer); \
359 if (options.vrfy_option == BE_CH_VRFY_ASSERT) \
360 assert(res && "Timer already on stack, cannot be pushed twice."); \
361 else if (options.vrfy_option == BE_CH_VRFY_WARN && ! res) \
362 fprintf(stderr, "Timer %s already on stack, cannot be pushed twice.\n", \
363 lc_timer_get_name(timer)); \
365 #define BE_TIMER_POP(timer) \
366 if (main_opts->timing == BE_TIME_ON) { \
367 lc_timer_t *tmp = lc_timer_pop(); \
368 if (options.vrfy_option == BE_CH_VRFY_ASSERT) \
369 assert(tmp == timer && "Attempt to pop wrong timer."); \
370 else if (options.vrfy_option == BE_CH_VRFY_WARN && tmp != timer) \
371 fprintf(stderr, "Attempt to pop wrong timer. %s is on stack, trying to pop %s.\n", \
372 lc_timer_get_name(tmp), lc_timer_get_name(timer)); \
376 BE_TIMER_PUSH(ra_timer.t_other);
377 BE_TIMER_PUSH(ra_timer.t_prolog);
381 chordal_env.opts = &options;
382 chordal_env.irg = irg;
383 chordal_env.birg = bi;
384 chordal_env.dom_front = be_compute_dominance_frontiers(irg);
385 chordal_env.exec_freq = compute_execfreq(irg, be_loop_weight);
386 FIRM_DBG_REGISTER(chordal_env.dbg, "firm.be.chordal");
388 obstack_init(&chordal_env.obst);
390 BE_TIMER_POP(ra_timer.t_prolog);
392 /* Perform the following for each register class. */
393 for(j = 0, m = arch_isa_get_n_reg_class(isa); j < m; ++j) {
395 chordal_env.cls = arch_isa_get_reg_class(isa, j);
396 chordal_env.border_heads = pmap_create();
397 chordal_env.ignore_colors = bitset_malloc(chordal_env.cls->n_regs);
399 BE_TIMER_PUSH(ra_timer.t_live);
401 /* put all ignore registers into the ignore register set. */
402 put_ignore_colors(&chordal_env);
406 BE_TIMER_POP(ra_timer.t_live);
408 dump(BE_CH_DUMP_LIVE, irg, chordal_env.cls, "-live", dump_ir_block_graph_sched);
410 BE_TIMER_PUSH(ra_timer.t_spill);
413 switch(options.spill_method) {
414 case BE_CH_SPILL_MORGAN:
415 be_spill_morgan(&chordal_env);
417 case BE_CH_SPILL_BELADY:
418 be_spill_belady(&chordal_env);
421 case BE_CH_SPILL_REMAT:
422 be_spill_remat(&chordal_env);
424 #endif /* WITH_ILP */
426 fprintf(stderr, "no valid spiller selected. falling back to belady\n");
427 be_spill_belady(&chordal_env);
430 BE_TIMER_POP(ra_timer.t_spill);
432 dump(BE_CH_DUMP_SPILL, irg, chordal_env.cls, "-spill", dump_ir_block_graph_sched);
433 be_abi_fix_stack_nodes(bi->abi);
435 BE_TIMER_PUSH(ra_timer.t_verify);
437 /* verify schedule and register pressure */
438 if (options.vrfy_option == BE_CH_VRFY_WARN) {
439 be_verify_schedule(irg);
440 be_verify_register_pressure(chordal_env.birg->main_env->arch_env, chordal_env.cls, irg);
442 else if (options.vrfy_option == BE_CH_VRFY_ASSERT) {
443 assert(be_verify_schedule(irg) && "Schedule verification failed");
444 assert(be_verify_register_pressure(chordal_env.birg->main_env->arch_env, chordal_env.cls, irg)
445 && "Register pressure verification failed");
448 BE_TIMER_POP(ra_timer.t_verify);
449 BE_TIMER_PUSH(ra_timer.t_live);
451 BE_TIMER_POP(ra_timer.t_live);
452 BE_TIMER_PUSH(ra_timer.t_color);
454 /* Color the graph. */
455 be_ra_chordal_color(&chordal_env);
457 BE_TIMER_POP(ra_timer.t_color);
459 dump(BE_CH_DUMP_CONSTR, irg, chordal_env.cls, "-color", dump_ir_block_graph_sched);
461 BE_TIMER_PUSH(ra_timer.t_ifg);
463 /* Create the ifg with the selected flavor */
464 switch (options.ifg_flavor) {
466 fprintf(stderr, "no valid ifg flavour selected. falling back to std\n");
469 chordal_env.ifg = be_ifg_std_new(&chordal_env);
471 case BE_CH_IFG_CLIQUE:
472 chordal_env.ifg = be_ifg_clique_new(&chordal_env);
474 case BE_CH_IFG_POINTER:
475 chordal_env.ifg = be_ifg_pointer_new(&chordal_env);
478 chordal_env.ifg = be_ifg_list_new(&chordal_env);
480 case BE_CH_IFG_CHECK:
481 check_ifg_implementations(&chordal_env);
482 /* Build the interference graph. */
483 chordal_env.ifg = be_ifg_std_new(&chordal_env);
490 be_ifg_t *std = be_ifg_std_new(&chordal_env);
491 f = be_chordal_open(&chordal_env, "std", "csv");
492 be_ifg_check_sorted_to_file(std, f);
497 f = be_chordal_open(&chordal_env, "clique", "csv");
498 be_ifg_check_sorted_to_file(chordal_env.ifg, f);
501 BE_TIMER_POP(ra_timer.t_ifg);
503 BE_TIMER_PUSH(ra_timer.t_verify);
505 if (options.vrfy_option != BE_CH_VRFY_OFF)
506 be_ra_chordal_check(&chordal_env);
508 // be_ifg_check_sorted(chordal_env.ifg);
509 BE_TIMER_POP(ra_timer.t_verify);
510 BE_TIMER_PUSH(ra_timer.t_copymin);
512 /* copy minimization */
514 if (options.copymin_method != BE_CH_COPYMIN_NONE && options.copymin_method != BE_CH_COPYMIN_STAT) {
516 co = new_copy_opt(&chordal_env, co_get_costs_loop_depth);
517 co_build_ou_structure(co);
518 co_build_graph_structure(co);
519 if(be_copymin_stats) {
520 ir_printf("%40F %20s\n", current_ir_graph, chordal_env.cls->name);
521 printf("max copy costs: %d\n", co_get_max_copy_costs(co));
522 printf("init copy costs: %d\n", co_get_copy_costs(co));
523 printf("inevit copy costs: %d\n", co_get_inevit_copy_costs(co));
524 printf("copy costs lower bound: %d\n", co_get_lower_bound(co));
528 f = be_chordal_open(&chordal_env, "appel-", "apl");
529 co_dump_appel_graph(co, f);
531 f = be_chordal_open(&chordal_env, "appel-clique-", "p");
532 co_dump_appel_graph_cliques(co, f);
537 switch(options.copymin_method) {
538 case BE_CH_COPYMIN_HEUR1:
539 co_solve_heuristic(co);
541 case BE_CH_COPYMIN_HEUR2:
542 co_solve_heuristic_new(co);
544 case BE_CH_COPYMIN_PARK_MOON:
545 co_solve_park_moon(co);
547 case BE_CH_COPYMIN_STAT:
548 co_compare_solvers(&chordal_env);
551 case BE_CH_COPYMIN_ILP1:
552 printf("FIXME: %s:%d ILP1 not yet implemented!\n", __FILE__, __LINE__);
553 co_solve_ilp1(co, 60.0);
555 case BE_CH_COPYMIN_ILP2:
556 co_solve_ilp2(co, 60.0);
558 #endif /* WITH_ILP */
559 case BE_CH_COPYMIN_NONE:
565 if(be_copymin_stats) {
566 printf("final copy costs : %d\n", co_get_copy_costs(co));
568 co_free_graph_structure(co);
569 co_free_ou_structure(co);
573 BE_TIMER_POP(ra_timer.t_copymin);
575 dump(BE_CH_DUMP_COPYMIN, irg, chordal_env.cls, "-copymin", dump_ir_block_graph_sched);
577 BE_TIMER_PUSH(ra_timer.t_verify);
579 if (options.vrfy_option != BE_CH_VRFY_OFF)
580 be_ra_chordal_check(&chordal_env);
582 BE_TIMER_POP(ra_timer.t_verify);
583 BE_TIMER_PUSH(ra_timer.t_ssa);
585 /* ssa destruction */
586 be_ssa_destruction(&chordal_env);
588 BE_TIMER_POP(ra_timer.t_ssa);
590 dump(BE_CH_DUMP_SSADESTR, irg, chordal_env.cls, "-ssadestr", dump_ir_block_graph_sched);
592 BE_TIMER_PUSH(ra_timer.t_verify);
593 if (options.vrfy_option != BE_CH_VRFY_OFF) {
594 be_ssa_destruction_check(&chordal_env);
595 be_ra_chordal_check(&chordal_env);
597 BE_TIMER_POP(ra_timer.t_verify);
599 if (options.copymin_method == BE_CH_COPYMIN_STAT)
602 be_ifg_free(chordal_env.ifg);
603 pmap_destroy(chordal_env.border_heads);
604 bitset_free(chordal_env.ignore_colors);
607 BE_TIMER_PUSH(ra_timer.t_epilog);
609 be_compute_spill_offsets(&chordal_env);
611 dump(BE_CH_DUMP_LOWER, irg, NULL, "-spilloff", dump_ir_block_graph_sched);
613 lower_nodes_after_ra(&chordal_env, options.lower_perm_opt & BE_CH_LOWER_PERM_COPY ? 1 : 0);
614 dump(BE_CH_DUMP_LOWER, irg, NULL, "-belower-after-ra", dump_ir_block_graph_sched);
616 obstack_free(&chordal_env.obst, NULL);
617 be_free_dominance_frontiers(chordal_env.dom_front);
618 free_execfreq(chordal_env.exec_freq);
620 BE_TIMER_POP(ra_timer.t_epilog);
621 BE_TIMER_POP(ra_timer.t_other);
626 return main_opts->timing == BE_TIME_ON ? &ra_timer : NULL;
629 const be_ra_t be_ra_chordal_allocator = {
631 be_ra_chordal_register_options,