3 * @author Sebastian Hack
14 #include <libcore/lc_opts.h>
15 #include <libcore/lc_opts_enum.h>
16 #include <libcore/lc_timing.h>
17 #endif /* WITH_LIBCORE */
28 #include "iredges_t.h"
36 #include "firm/bearch_firm.h"
37 #include "ia32/bearch_ia32.h"
38 #include "arm/bearch_arm.h"
39 #include "ppc32/bearch_ppc32.h"
40 #include "mips/bearch_mips.h"
47 #include "besched_t.h"
48 #include "belistsched.h"
50 #include "bespillbelady.h"
52 #include "beraextern.h"
53 #include "bechordal_t.h"
55 #include "beifg_impl.h"
56 #include "becopyopt.h"
57 #include "becopystat.h"
58 #include "bessadestr.h"
61 #include "beschedmris.h"
64 #include "beprofile.h"
66 /* options visible for anyone */
67 static be_options_t be_options = {
68 DUMP_NONE, /* dump flags */
69 BE_TIME_OFF, /* no timing */
70 BE_SCHED_SELECT_HEUR, /* mueller heuristic selector */
71 0, /* no opt profile */
73 1, /* try to omit frame pointer */
74 BE_VRFY_WARN, /* verification level: warn */
75 "i44pc52.info.uni-karlsruhe.de", /* ilp server */
76 "cplex" /* ilp solver */
80 static char config_file[256] = { 0 };
82 /* register allocator to use. */
83 static const be_ra_t *ra = &be_ra_chordal_allocator;
85 /* back end instruction set architecture to use */
86 static const arch_isa_if_t *isa_if = &ia32_isa_if;
90 static lc_opt_entry_t *be_grp_root = NULL;
92 /* possible dumping options */
93 static const lc_opt_enum_mask_items_t dump_items[] = {
94 { "none", DUMP_NONE },
95 { "initial", DUMP_INITIAL },
97 { "sched", DUMP_SCHED },
98 { "prepared", DUMP_PREPARED },
99 { "regalloc", DUMP_RA },
100 { "final", DUMP_FINAL },
102 { "all", 2 * DUMP_BE - 1 },
106 /* register allocators */
107 static const lc_opt_enum_const_ptr_items_t ra_items[] = {
108 { "chordal", &be_ra_chordal_allocator },
109 { "external", &be_ra_external_allocator },
113 /* instruction set architectures. */
114 static const lc_opt_enum_const_ptr_items_t isa_items[] = {
115 { "ia32", &ia32_isa_if },
117 { "arm", &arm_isa_if },
118 { "ppc32", &ppc32_isa_if },
119 { "mips", &mips_isa_if },
124 /* verify options. */
125 static const lc_opt_enum_int_items_t vrfy_items[] = {
126 { "off", BE_VRFY_OFF },
127 { "warn", BE_VRFY_WARN },
128 { "assert", BE_VRFY_ASSERT },
132 /* schedule selector options. */
133 static const lc_opt_enum_int_items_t sched_select_items[] = {
134 { "trivial", BE_SCHED_SELECT_TRIVIAL },
135 { "regpress", BE_SCHED_SELECT_REGPRESS },
136 { "muchnik", BE_SCHED_SELECT_MUCHNIK },
137 { "heur", BE_SCHED_SELECT_HEUR },
138 { "hmuchnik", BE_SCHED_SELECT_HMUCHNIK },
142 static lc_opt_enum_mask_var_t dump_var = {
143 &be_options.dump_flags, dump_items
146 static lc_opt_enum_const_ptr_var_t ra_var = {
147 (const void **) &ra, ra_items
150 static lc_opt_enum_const_ptr_var_t isa_var = {
151 (const void **) &isa_if, isa_items
154 static lc_opt_enum_int_var_t vrfy_var = {
155 &be_options.vrfy_option, vrfy_items
158 static lc_opt_enum_int_var_t sched_select_var = {
159 &be_options.sched_select, sched_select_items
162 static const lc_opt_table_entry_t be_main_options[] = {
163 LC_OPT_ENT_STR ("config", "read another config file containing backend options", config_file, sizeof(config_file)),
164 LC_OPT_ENT_ENUM_MASK("dump", "dump irg on several occasions", &dump_var),
165 LC_OPT_ENT_ENUM_PTR ("ra", "register allocator", &ra_var),
166 LC_OPT_ENT_ENUM_PTR ("isa", "the instruction set architecture", &isa_var),
167 LC_OPT_ENT_NEGBOOL ("noomitfp", "do not omit frame pointer", &be_options.omit_fp),
168 LC_OPT_ENT_ENUM_PTR ("vrfy", "verify the backend irg (off, warn, assert)", &vrfy_var),
169 LC_OPT_ENT_BOOL ("time", "get backend timing statistics", &be_options.timing),
170 LC_OPT_ENT_BOOL ("profile", "instrument the code for execution count profiling", &be_options.opt_profile),
171 LC_OPT_ENT_BOOL ("sched.mris", "enable mris schedule preparation", &be_options.mris),
172 LC_OPT_ENT_ENUM_PTR ("sched.select", "schedule node selector (trivial, regpress, muchnik, heur, hmuchnik)", &sched_select_var),
175 LC_OPT_ENT_STR ("ilp.server", "the ilp server name", be_options.ilp_server, sizeof(be_options.ilp_server)),
176 LC_OPT_ENT_STR ("ilp.solver", "the ilp solver name", be_options.ilp_solver, sizeof(be_options.ilp_solver)),
177 #endif /* WITH_ILP */
181 #endif /* WITH_LIBCORE */
183 void be_opt_register(void)
187 lc_opt_entry_t *be_grp_ra;
188 static int run_once = 0;
192 be_grp_root = lc_opt_get_grp(firm_opt_get_root(), "be");
193 be_grp_ra = lc_opt_get_grp(be_grp_root, "ra");
195 lc_opt_add_table(be_grp_root, be_main_options);
197 /* register allocator options */
198 for(i = 0; ra_items[i].name != NULL; ++i) {
199 const be_ra_t *ra = ra_items[i].value;
200 ra->register_options(be_grp_ra);
203 /* register isa options */
204 for(i = 0; isa_items[i].name != NULL; ++i) {
205 const arch_isa_if_t *isa = isa_items[i].value;
206 isa->register_options(be_grp_root);
209 #endif /* WITH_LIBCORE */
212 /* Parse one argument. */
213 int be_parse_arg(const char *arg) {
215 if (strcmp(arg, "help") == 0 || (arg[0] == '?' && arg[1] == '\0')) {
216 lc_opt_print_help(be_grp_root, stdout);
219 return lc_opt_from_single_arg(be_grp_root, NULL, arg, NULL);
222 #endif /* WITH_LIBCORE */
225 /** The be parameters returned by default, all off. */
226 const static backend_params be_params = {
233 /* Perform schedule verification if requested. */
234 static void be_sched_vrfy(ir_graph *irg, int vrfy_opt) {
235 if (vrfy_opt == BE_VRFY_WARN) {
236 be_verify_schedule(irg);
238 else if (vrfy_opt == BE_VRFY_ASSERT) {
239 assert(be_verify_schedule(irg) && "Schedule verification failed.");
243 /* Initialize the Firm backend. Must be run BEFORE init_firm()! */
244 const backend_params *be_init(void)
254 if (isa_if->get_params)
255 return isa_if->get_params();
260 * Initializes the main environment for the backend.
262 * @param env an empty environment
263 * @param file_handle the file handle where the output will be written to
265 static be_main_env_t *be_init_env(be_main_env_t *env, FILE *file_handle)
267 memset(env, 0, sizeof(*env));
268 obstack_init(&env->obst);
269 env->arch_env = obstack_alloc(&env->obst, sizeof(env->arch_env[0]));
270 env->arch_env->constructor_entities = pset_new_ptr(5);
271 env->options = &be_options;
272 FIRM_DBG_REGISTER(env->dbg, "be.main");
274 arch_env_init(env->arch_env, isa_if, file_handle);
276 /* Register the irn handler of the architecture */
277 if (arch_isa_get_irn_handler(env->arch_env->isa))
278 arch_env_push_irn_handler(env->arch_env, arch_isa_get_irn_handler(env->arch_env->isa));
281 * Register the node handler of the back end infrastructure.
282 * This irn handler takes care of the platform independent
283 * spill, reload and perm nodes.
285 arch_env_push_irn_handler(env->arch_env, &be_node_irn_handler);
286 env->phi_handler = be_phi_handler_new(env->arch_env);
287 arch_env_push_irn_handler(env->arch_env, env->phi_handler);
292 static void be_done_env(be_main_env_t *env)
294 env->arch_env->isa->impl->done(env->arch_env->isa);
295 be_phi_handler_free(env->phi_handler);
296 obstack_free(&env->obst, NULL);
300 * A wrapper around a firm dumper. Dumps only, if
303 * @param mask a bitmask containing the reason what will be dumped
304 * @param irg the IR graph to dump
305 * @param suffix the suffix for the dumper
306 * @param dumper the dumper to be called
308 static void dump(int mask, ir_graph *irg, const char *suffix,
309 void (*dumper)(ir_graph *, const char *))
311 if(be_options.dump_flags & mask)
312 be_dump(irg, suffix, dumper);
316 * Prepare a backend graph for code generation.
318 static void prepare_graph(be_irg_t *birg)
320 ir_graph *irg = birg->irg;
322 /* Normalize proj nodes. */
323 normalize_proj_nodes(irg);
325 /* Make just one return node. */
326 normalize_one_return(irg);
328 /* Remove critical edges */
329 remove_critical_cf_edges(irg);
331 /* Compute the dominance information. */
335 /* Ensure, that the ir_edges are computed. */
338 /* check, if the dominance property is fulfilled. */
339 be_check_dominance(irg);
341 /* reset the phi handler. */
342 be_phi_handler_reset(birg->main_env->phi_handler);
347 #define BE_TIMER_PUSH(timer) \
348 if (be_options.timing == BE_TIME_ON) { \
349 int res = lc_timer_push(timer); \
350 if (be_options.vrfy_option == BE_VRFY_ASSERT) \
351 assert(res && "Timer already on stack, cannot be pushed twice."); \
352 else if (be_options.vrfy_option == BE_VRFY_WARN && ! res) \
353 fprintf(stderr, "Timer %s already on stack, cannot be pushed twice.\n", \
354 lc_timer_get_name(timer)); \
356 #define BE_TIMER_POP(timer) \
357 if (be_options.timing == BE_TIME_ON) { \
358 lc_timer_t *tmp = lc_timer_pop(); \
359 if (be_options.vrfy_option == BE_VRFY_ASSERT) \
360 assert(tmp == timer && "Attempt to pop wrong timer."); \
361 else if (be_options.vrfy_option == BE_VRFY_WARN && tmp != timer) \
362 fprintf(stderr, "Attempt to pop wrong timer. %s is on stack, trying to pop %s.\n", \
363 lc_timer_get_name(tmp), lc_timer_get_name(timer)); \
367 #define BE_TIMER_ONLY(code) do { if (be_options.timing == BE_TIME_ON) { code; } } while(0)
371 #define BE_TIMER_PUSH(timer)
372 #define BE_TIMER_POP(timer)
373 #define BE_TIMER_ONLY(code)
375 #endif /* WITH_LIBCORE */
379 * The Firm backend main loop.
380 * Do architecture specific lowering for all graphs
381 * and call the architecture specific code generator.
383 * @param file_handle the file handle the output will be written to
385 static void be_main_loop(FILE *file_handle)
390 unsigned num_nodes_b = 0;
391 unsigned num_nodes_a = 0;
392 unsigned num_nodes_r = 0;
395 lc_timer_t *t_prolog, *t_abi, *t_codegen, *t_sched, *t_constr, *t_regalloc, *t_finish, *t_emit, *t_other, *t_verify;
396 be_ra_timer_t *ra_timer;
398 if (be_options.timing == BE_TIME_ON) {
399 t_prolog = lc_timer_register("prolog", "prolog");
400 t_abi = lc_timer_register("beabi", "be abi introduction");
401 t_codegen = lc_timer_register("codegen", "codegeneration");
402 t_sched = lc_timer_register("sched", "scheduling");
403 t_constr = lc_timer_register("constr", "assure constraints");
404 t_regalloc = lc_timer_register("regalloc", "register allocation");
405 t_finish = lc_timer_register("finish", "graph finish");
406 t_emit = lc_timer_register("emiter", "code emiter");
407 t_verify = lc_timer_register("verify", "graph verification");
408 t_other = lc_timer_register("other", "other");
410 #endif /* WITH_LIBCORE */
412 be_init_env(&env, file_handle);
414 isa = arch_env_get_isa(env.arch_env);
416 /* for debugging, anchors helps */
417 // dump_all_anchors(1);
419 if(be_options.opt_profile) {
420 ir_graph *prof_init_irg = be_profile_instrument();
421 pset_insert_ptr(env.arch_env->constructor_entities, get_irg_entity(prof_init_irg));
423 be_profile_read("test.c"); //FIXME
426 for (i = 0, n = get_irp_n_irgs(); i < n; ++i) {
427 ir_graph *irg = get_irp_irg(i);
428 const arch_code_generator_if_t *cg_if;
430 optimization_state_t state;
432 /* stop and reset timers */
434 LC_STOP_AND_RESET_TIMER(t_prolog);
435 LC_STOP_AND_RESET_TIMER(t_abi);
436 LC_STOP_AND_RESET_TIMER(t_codegen);
437 LC_STOP_AND_RESET_TIMER(t_sched);
438 LC_STOP_AND_RESET_TIMER(t_constr);
439 LC_STOP_AND_RESET_TIMER(t_regalloc);
440 LC_STOP_AND_RESET_TIMER(t_finish);
441 LC_STOP_AND_RESET_TIMER(t_emit);
442 LC_STOP_AND_RESET_TIMER(t_verify);
443 LC_STOP_AND_RESET_TIMER(t_other);
445 BE_TIMER_PUSH(t_other); /* t_other */
447 BE_TIMER_ONLY(num_nodes_b = get_num_reachable_nodes(irg));
450 birg.main_env = &env;
452 edges_deactivate_kind(irg, EDGE_KIND_DEP);
453 edges_activate_kind(irg, EDGE_KIND_DEP);
455 DBG((env.dbg, LEVEL_2, "====> IRG: %F\n", irg));
456 dump(DUMP_INITIAL, irg, "-begin", dump_ir_block_graph);
458 BE_TIMER_PUSH(t_prolog);
460 be_stat_init_irg(env.arch_env, irg);
461 be_do_stat_nodes(irg, "01 Begin");
463 /* set the current graph (this is important for several firm functions) */
464 current_ir_graph = birg.irg;
466 /* Get the code generator interface. */
467 cg_if = isa->impl->get_code_generator_if(isa);
469 /* get a code generator for this graph. */
470 birg.cg = cg_if->init(&birg);
472 /* create the code generator and generate code. */
473 prepare_graph(&birg);
475 BE_TIMER_POP(t_prolog);
477 /* some transformations need to be done before abi introduce */
478 BE_TIMER_PUSH(t_codegen);
479 arch_code_generator_before_abi(birg.cg);
480 BE_TIMER_POP(t_codegen);
482 /* implement the ABI conventions. */
483 BE_TIMER_PUSH(t_abi);
484 birg.abi = be_abi_introduce(&birg);
487 dump(DUMP_ABI, irg, "-abi", dump_ir_block_graph);
488 be_do_stat_nodes(irg, "02 Abi");
491 BE_TIMER_PUSH(t_codegen);
492 arch_code_generator_prepare_graph(birg.cg);
493 BE_TIMER_POP(t_codegen);
495 be_do_stat_nodes(irg, "03 Prepare");
498 * Since the code generator made a lot of new nodes and skipped
499 * a lot of old ones, we should do dead node elimination here.
500 * Note that this requires disabling the edges here.
502 edges_deactivate(irg);
503 //dead_node_elimination(irg);
506 /* Compute loop nesting information (for weighting copies) */
507 construct_cf_backedges(irg);
508 dump(DUMP_PREPARED, irg, "-prepared", dump_ir_block_graph);
509 BE_TIMER_ONLY(num_nodes_r = get_num_reachable_nodes(irg));
511 /* let backend prepare scheduling */
512 BE_TIMER_PUSH(t_codegen);
513 arch_code_generator_before_sched(birg.cg);
514 BE_TIMER_POP(t_codegen);
516 /* schedule the irg */
517 BE_TIMER_PUSH(t_sched);
518 list_sched(&birg, &be_options);
519 BE_TIMER_POP(t_sched);
521 dump(DUMP_SCHED, irg, "-sched", dump_ir_block_graph_sched);
524 BE_TIMER_PUSH(t_verify);
525 be_sched_vrfy(birg.irg, be_options.vrfy_option);
526 BE_TIMER_POP(t_verify);
528 be_do_stat_nodes(irg, "04 Schedule");
530 /* introduce patterns to assure constraints */
531 BE_TIMER_PUSH(t_constr);
532 /* we switch off optimizations here, because they might cause trouble */
533 save_optimization_state(&state);
535 set_opt_normalize(0);
537 /* add Keeps for should_be_different constrained nodes */
538 /* beware: needs schedule due to usage of be_ssa_constr */
539 assure_constraints(&birg);
540 BE_TIMER_POP(t_constr);
542 dump(DUMP_SCHED, irg, "-assured", dump_ir_block_graph_sched);
543 be_do_stat_nodes(irg, "05 Constraints");
545 /* connect all stack modifying nodes together (see beabi.c) */
546 BE_TIMER_PUSH(t_abi);
547 be_abi_fix_stack_nodes(birg.abi, NULL);
550 dump(DUMP_SCHED, irg, "-fix_stack", dump_ir_block_graph_sched);
553 BE_TIMER_PUSH(t_verify);
554 be_sched_vrfy(birg.irg, be_options.vrfy_option);
555 BE_TIMER_POP(t_verify);
557 /* do some statistics */
558 be_do_stat_reg_pressure(&birg);
560 /* stuff needs to be done after scheduling but before register allocation */
561 BE_TIMER_PUSH(t_codegen);
562 arch_code_generator_before_ra(birg.cg);
563 BE_TIMER_POP(t_codegen);
565 /* Do register allocation */
566 BE_TIMER_PUSH(t_regalloc);
567 ra_timer = ra->allocate(&birg);
568 BE_TIMER_POP(t_regalloc);
570 dump(DUMP_RA, irg, "-ra", dump_ir_block_graph_sched);
571 be_do_stat_nodes(irg, "06 Register Allocation");
573 /* let the codegenerator prepare the graph for emitter */
574 BE_TIMER_PUSH(t_finish);
575 arch_code_generator_after_ra(birg.cg);
576 BE_TIMER_POP(t_finish);
578 /* fix stack offsets */
579 BE_TIMER_PUSH(t_abi);
580 be_abi_fix_stack_nodes(birg.abi, NULL);
581 be_remove_dead_nodes_from_schedule(birg.irg);
582 be_abi_fix_stack_bias(birg.abi);
585 BE_TIMER_PUSH(t_finish);
586 arch_code_generator_finish(birg.cg);
587 BE_TIMER_POP(t_finish);
589 dump(DUMP_FINAL, irg, "-finish", dump_ir_block_graph_sched);
591 /* check schedule and register allocation */
592 BE_TIMER_PUSH(t_verify);
593 if (be_options.vrfy_option == BE_VRFY_WARN) {
594 //irg_verify(birg.irg, VRFY_ENFORCE_SSA);
595 be_check_dominance(birg.irg);
596 be_verify_out_edges(birg.irg);
597 be_verify_schedule(birg.irg);
598 be_verify_register_allocation(env.arch_env, birg.irg);
600 else if (be_options.vrfy_option == BE_VRFY_ASSERT) {
601 //assert(irg_verify(birg.irg, VRFY_ENFORCE_SSA) && "irg verification failed");
602 assert(be_verify_out_edges(birg.irg));
603 assert(be_check_dominance(birg.irg) && "Dominance verification failed");
604 assert(be_verify_schedule(birg.irg) && "Schedule verification failed");
605 assert(be_verify_register_allocation(env.arch_env, birg.irg)
606 && "register allocation verification failed");
608 BE_TIMER_POP(t_verify);
610 /* emit assembler code */
611 BE_TIMER_PUSH(t_emit);
612 arch_code_generator_done(birg.cg);
613 BE_TIMER_POP(t_emit);
615 dump(DUMP_FINAL, irg, "-end", dump_ir_extblock_graph_sched);
617 BE_TIMER_PUSH(t_abi);
618 be_abi_free(birg.abi);
621 be_do_stat_nodes(irg, "07 Final");
622 restore_optimization_state(&state);
624 BE_TIMER_ONLY(num_nodes_a = get_num_reachable_nodes(irg));
625 BE_TIMER_POP(t_other);
627 #define LC_EMIT(timer) printf("%-20s: %.3lf msec\n", lc_timer_get_description(timer), (double)lc_timer_elapsed_usec(timer) / 1000.0)
628 #define LC_EMIT_RA(timer) printf("\t%-20s: %.3lf msec\n", lc_timer_get_description(timer), (double)lc_timer_elapsed_usec(timer) / 1000.0)
630 printf("==>> IRG %s <<==\n", get_entity_name(get_irg_entity(irg)));
631 printf("# nodes at begin: %u\n", num_nodes_b);
632 printf("# nodes before ra: %u\n", num_nodes_r);
633 printf("# nodes at end: %u\n\n", num_nodes_a);
640 LC_EMIT_RA(ra_timer->t_prolog);
641 LC_EMIT_RA(ra_timer->t_live);
642 LC_EMIT_RA(ra_timer->t_spill);
643 LC_EMIT_RA(ra_timer->t_spillslots);
644 LC_EMIT_RA(ra_timer->t_color);
645 LC_EMIT_RA(ra_timer->t_ifg);
646 LC_EMIT_RA(ra_timer->t_copymin);
647 LC_EMIT_RA(ra_timer->t_ssa);
648 LC_EMIT_RA(ra_timer->t_epilog);
649 LC_EMIT_RA(ra_timer->t_verify);
650 LC_EMIT_RA(ra_timer->t_other);
659 /* switched off due to statistics (statistic module needs all irgs) */
660 if (! stat_is_active())
672 /* Main interface to the frontend. */
673 void be_main(FILE *file_handle)
677 #endif /* WITH_LIBCORE */
680 /* The user specified another config file to read. do that now. */
681 if(strlen(config_file) > 0) {
684 if((f = fopen(config_file, "rt")) != NULL) {
685 lc_opt_from_file(config_file, f, NULL);
690 if (be_options.timing == BE_TIME_ON) {
691 t = lc_timer_register("bemain", "measure complete bemain loop");
693 if (lc_timer_enter_high_priority()) {
694 fprintf(stderr, "Warning: Could not enter high priority mode.\n");
697 lc_timer_reset_and_start(t);
699 #endif /* WITH_LIBCORE */
701 /* never build code for pseudo irgs */
702 set_visit_pseudo_irgs(0);
705 be_main_loop(file_handle);
708 if (be_options.timing == BE_TIME_ON) {
710 lc_timer_leave_high_priority();
711 printf("%-20s: %lu msec\n", "BEMAINLOOP", lc_timer_elapsed_msec(t));
713 #endif /* WITH_LIBCORE */
716 /** The debug info retriever function. */
717 static retrieve_dbg_func retrieve_dbg = NULL;
719 /* Sets a debug info retriever. */
720 void be_set_debug_retrieve(retrieve_dbg_func func) {
724 /* Retrieve the debug info. */
725 const char *be_retrieve_dbg_info(const dbg_info *dbg, unsigned *line) {
727 return retrieve_dbg(dbg, line);
732 int be_put_ignore_regs(const be_irg_t *birg, const arch_register_class_t *cls, bitset_t *bs)
735 bs = bitset_alloca(cls->n_regs);
737 bitset_clear_all(bs);
739 assert(bitset_size(bs) == (unsigned) cls->n_regs);
740 arch_put_non_ignore_regs(birg->main_env->arch_env, cls, bs);
742 be_abi_put_ignore_regs(birg->abi, cls, bs);
743 return bitset_popcnt(bs);