3 * @author Sebastian Hack
16 #include <libcore/lc_opts.h>
17 #include <libcore/lc_opts_enum.h>
18 #include <libcore/lc_timing.h>
19 #endif /* WITH_LIBCORE */
30 #include "iredges_t.h"
39 #include "firm/bearch_firm.h"
40 #include "ia32/bearch_ia32.h"
41 #include "arm/bearch_arm.h"
42 #include "ppc32/bearch_ppc32.h"
43 #include "mips/bearch_mips.h"
50 #include "besched_t.h"
51 #include "belistsched.h"
53 #include "bespillbelady.h"
55 #include "beraextern.h"
56 #include "bechordal_t.h"
58 #include "beifg_impl.h"
59 #include "becopyopt.h"
60 #include "becopystat.h"
61 #include "bessadestr.h"
64 #include "beschedmris.h"
67 #include "beprofile.h"
69 /* options visible for anyone */
70 static be_options_t be_options = {
71 DUMP_NONE, /* dump flags */
72 BE_TIME_OFF, /* no timing */
73 BE_SCHED_SELECT_HEUR, /* mueller heuristic selector */
74 0, /* no opt profile */
76 1, /* try to omit frame pointer */
77 BE_VRFY_WARN, /* verification level: warn */
78 "i44pc52.info.uni-karlsruhe.de", /* ilp server */
79 "cplex" /* ilp solver */
83 static char config_file[256] = { 0 };
85 /* register allocator to use. */
86 static const be_ra_t *ra = &be_ra_chordal_allocator;
88 /* back end instruction set architecture to use */
89 static const arch_isa_if_t *isa_if = &ia32_isa_if;
93 static lc_opt_entry_t *be_grp_root = NULL;
95 /* possible dumping options */
96 static const lc_opt_enum_mask_items_t dump_items[] = {
97 { "none", DUMP_NONE },
98 { "initial", DUMP_INITIAL },
100 { "sched", DUMP_SCHED },
101 { "prepared", DUMP_PREPARED },
102 { "regalloc", DUMP_RA },
103 { "final", DUMP_FINAL },
105 { "all", 2 * DUMP_BE - 1 },
109 /* register allocators */
110 static const lc_opt_enum_const_ptr_items_t ra_items[] = {
111 { "chordal", &be_ra_chordal_allocator },
112 { "external", &be_ra_external_allocator },
116 /* instruction set architectures. */
117 static const lc_opt_enum_const_ptr_items_t isa_items[] = {
118 { "ia32", &ia32_isa_if },
120 { "arm", &arm_isa_if },
121 { "ppc32", &ppc32_isa_if },
122 { "mips", &mips_isa_if },
127 /* verify options. */
128 static const lc_opt_enum_int_items_t vrfy_items[] = {
129 { "off", BE_VRFY_OFF },
130 { "warn", BE_VRFY_WARN },
131 { "assert", BE_VRFY_ASSERT },
135 /* schedule selector options. */
136 static const lc_opt_enum_int_items_t sched_select_items[] = {
137 { "trivial", BE_SCHED_SELECT_TRIVIAL },
138 { "regpress", BE_SCHED_SELECT_REGPRESS },
139 { "muchnik", BE_SCHED_SELECT_MUCHNIK },
140 { "heur", BE_SCHED_SELECT_HEUR },
141 { "hmuchnik", BE_SCHED_SELECT_HMUCHNIK },
145 static lc_opt_enum_mask_var_t dump_var = {
146 &be_options.dump_flags, dump_items
149 static lc_opt_enum_const_ptr_var_t ra_var = {
150 (const void **) &ra, ra_items
153 static lc_opt_enum_const_ptr_var_t isa_var = {
154 (const void **) &isa_if, isa_items
157 static lc_opt_enum_int_var_t vrfy_var = {
158 &be_options.vrfy_option, vrfy_items
161 static lc_opt_enum_int_var_t sched_select_var = {
162 &be_options.sched_select, sched_select_items
165 static const lc_opt_table_entry_t be_main_options[] = {
166 LC_OPT_ENT_STR ("config", "read another config file containing backend options", config_file, sizeof(config_file)),
167 LC_OPT_ENT_ENUM_MASK("dump", "dump irg on several occasions", &dump_var),
168 LC_OPT_ENT_ENUM_PTR ("ra", "register allocator", &ra_var),
169 LC_OPT_ENT_ENUM_PTR ("isa", "the instruction set architecture", &isa_var),
170 LC_OPT_ENT_NEGBOOL ("noomitfp", "do not omit frame pointer", &be_options.omit_fp),
171 LC_OPT_ENT_ENUM_PTR ("vrfy", "verify the backend irg (off, warn, assert)", &vrfy_var),
172 LC_OPT_ENT_BOOL ("time", "get backend timing statistics", &be_options.timing),
173 LC_OPT_ENT_BOOL ("profile", "instrument the code for execution count profiling", &be_options.opt_profile),
174 LC_OPT_ENT_BOOL ("sched.mris", "enable mris schedule preparation", &be_options.mris),
175 LC_OPT_ENT_ENUM_PTR ("sched.select", "schedule node selector (trivial, regpress, muchnik, heur, hmuchnik)", &sched_select_var),
178 LC_OPT_ENT_STR ("ilp.server", "the ilp server name", be_options.ilp_server, sizeof(be_options.ilp_server)),
179 LC_OPT_ENT_STR ("ilp.solver", "the ilp solver name", be_options.ilp_solver, sizeof(be_options.ilp_solver)),
180 #endif /* WITH_ILP */
184 #endif /* WITH_LIBCORE */
186 void be_opt_register(void)
190 lc_opt_entry_t *be_grp_ra;
191 static int run_once = 0;
195 be_grp_root = lc_opt_get_grp(firm_opt_get_root(), "be");
196 be_grp_ra = lc_opt_get_grp(be_grp_root, "ra");
198 lc_opt_add_table(be_grp_root, be_main_options);
200 /* register allocator options */
201 for(i = 0; ra_items[i].name != NULL; ++i) {
202 const be_ra_t *ra = ra_items[i].value;
203 ra->register_options(be_grp_ra);
206 /* register isa options */
207 for(i = 0; isa_items[i].name != NULL; ++i) {
208 const arch_isa_if_t *isa = isa_items[i].value;
209 isa->register_options(be_grp_root);
212 #endif /* WITH_LIBCORE */
215 /* Parse one argument. */
216 int be_parse_arg(const char *arg) {
218 if (strcmp(arg, "help") == 0 || (arg[0] == '?' && arg[1] == '\0')) {
219 lc_opt_print_help(be_grp_root, stdout);
222 return lc_opt_from_single_arg(be_grp_root, NULL, arg, NULL);
225 #endif /* WITH_LIBCORE */
228 /** The be parameters returned by default, all off. */
229 const static backend_params be_params = {
236 /* Perform schedule verification if requested. */
237 static void be_sched_vrfy(ir_graph *irg, int vrfy_opt) {
238 if (vrfy_opt == BE_VRFY_WARN) {
239 be_verify_schedule(irg);
241 else if (vrfy_opt == BE_VRFY_ASSERT) {
242 assert(be_verify_schedule(irg) && "Schedule verification failed.");
246 /* Initialize the Firm backend. Must be run BEFORE init_firm()! */
247 const backend_params *be_init(void)
257 if (isa_if->get_params)
258 return isa_if->get_params();
263 * Initializes the main environment for the backend.
265 * @param env an empty environment
266 * @param file_handle the file handle where the output will be written to
268 static be_main_env_t *be_init_env(be_main_env_t *env, FILE *file_handle)
270 memset(env, 0, sizeof(*env));
271 obstack_init(&env->obst);
272 env->arch_env = obstack_alloc(&env->obst, sizeof(env->arch_env[0]));
273 env->options = &be_options;
274 FIRM_DBG_REGISTER(env->dbg, "be.main");
276 arch_env_init(env->arch_env, isa_if, file_handle, env);
278 /* Register the irn handler of the architecture */
279 if (arch_isa_get_irn_handler(env->arch_env->isa))
280 arch_env_push_irn_handler(env->arch_env, arch_isa_get_irn_handler(env->arch_env->isa));
283 * Register the node handler of the back end infrastructure.
284 * This irn handler takes care of the platform independent
285 * spill, reload and perm nodes.
287 arch_env_push_irn_handler(env->arch_env, &be_node_irn_handler);
288 env->phi_handler = be_phi_handler_new(env->arch_env);
289 arch_env_push_irn_handler(env->arch_env, env->phi_handler);
294 static void be_done_env(be_main_env_t *env)
296 env->arch_env->isa->impl->done(env->arch_env->isa);
297 be_phi_handler_free(env->phi_handler);
298 obstack_free(&env->obst, NULL);
302 * A wrapper around a firm dumper. Dumps only, if
305 * @param mask a bitmask containing the reason what will be dumped
306 * @param irg the IR graph to dump
307 * @param suffix the suffix for the dumper
308 * @param dumper the dumper to be called
310 static void dump(int mask, ir_graph *irg, const char *suffix,
311 void (*dumper)(ir_graph *, const char *))
313 if(be_options.dump_flags & mask)
314 be_dump(irg, suffix, dumper);
318 * Prepare a backend graph for code generation.
320 static void prepare_graph(be_irg_t *birg)
322 ir_graph *irg = birg->irg;
324 /* Normalize proj nodes. */
325 normalize_proj_nodes(irg);
327 /* Make just one return node. */
328 normalize_one_return(irg);
332 /* Remove critical edges */
333 remove_critical_cf_edges(irg);
335 /* Compute the dominance information. */
339 /* Ensure, that the ir_edges are computed. */
342 /* check, if the dominance property is fulfilled. */
343 be_check_dominance(irg);
345 /* reset the phi handler. */
346 be_phi_handler_reset(birg->main_env->phi_handler);
351 #define BE_TIMER_PUSH(timer) \
352 if (be_options.timing == BE_TIME_ON) { \
353 int res = lc_timer_push(timer); \
354 if (be_options.vrfy_option == BE_VRFY_ASSERT) \
355 assert(res && "Timer already on stack, cannot be pushed twice."); \
356 else if (be_options.vrfy_option == BE_VRFY_WARN && ! res) \
357 fprintf(stderr, "Timer %s already on stack, cannot be pushed twice.\n", \
358 lc_timer_get_name(timer)); \
360 #define BE_TIMER_POP(timer) \
361 if (be_options.timing == BE_TIME_ON) { \
362 lc_timer_t *tmp = lc_timer_pop(); \
363 if (be_options.vrfy_option == BE_VRFY_ASSERT) \
364 assert(tmp == timer && "Attempt to pop wrong timer."); \
365 else if (be_options.vrfy_option == BE_VRFY_WARN && tmp != timer) \
366 fprintf(stderr, "Attempt to pop wrong timer. %s is on stack, trying to pop %s.\n", \
367 lc_timer_get_name(tmp), lc_timer_get_name(timer)); \
371 #define BE_TIMER_ONLY(code) do { if (be_options.timing == BE_TIME_ON) { code; } } while(0)
375 #define BE_TIMER_PUSH(timer)
376 #define BE_TIMER_POP(timer)
377 #define BE_TIMER_ONLY(code)
379 #endif /* WITH_LIBCORE */
383 * The Firm backend main loop.
384 * Do architecture specific lowering for all graphs
385 * and call the architecture specific code generator.
387 * @param file_handle the file handle the output will be written to
389 static void be_main_loop(FILE *file_handle)
394 unsigned num_nodes_b = 0;
395 unsigned num_nodes_a = 0;
396 unsigned num_nodes_r = 0;
397 char prof_filename[256];
401 lc_timer_t *t_prolog = NULL;
402 lc_timer_t *t_abi = NULL;
403 lc_timer_t *t_codegen = NULL;
404 lc_timer_t *t_sched = NULL;
405 lc_timer_t *t_constr = NULL;
406 lc_timer_t *t_regalloc = NULL;
407 lc_timer_t *t_finish = NULL;
408 lc_timer_t *t_emit = NULL;
409 lc_timer_t *t_other = NULL;
410 lc_timer_t *t_verify = NULL;
411 be_ra_timer_t *ra_timer;
413 if (be_options.timing == BE_TIME_ON) {
414 t_prolog = lc_timer_register("prolog", "prolog");
415 t_abi = lc_timer_register("beabi", "be abi introduction");
416 t_codegen = lc_timer_register("codegen", "codegeneration");
417 t_sched = lc_timer_register("sched", "scheduling");
418 t_constr = lc_timer_register("constr", "assure constraints");
419 t_regalloc = lc_timer_register("regalloc", "register allocation");
420 t_finish = lc_timer_register("finish", "graph finish");
421 t_emit = lc_timer_register("emiter", "code emiter");
422 t_verify = lc_timer_register("verify", "graph verification");
423 t_other = lc_timer_register("other", "other");
425 #endif /* WITH_LIBCORE */
427 be_init_env(&env, file_handle);
429 isa = arch_env_get_isa(env.arch_env);
431 /* for debugging, anchors helps */
432 // dump_all_anchors(1);
434 /* please FIXME! I'm a dirty hack. */
435 snprintf(path, 256, "/proc/self/fd/%d", fileno(file_handle));
436 memset(prof_filename, 0, 256);
437 readlink(path, prof_filename, 250);
438 strcat(prof_filename, ".prof");
440 if(be_options.opt_profile) {
441 ir_graph *prof_init_irg = be_profile_instrument(prof_filename);
442 pset_insert_ptr(env.arch_env->constructor_entities, get_irg_entity(prof_init_irg));
444 be_profile_read(prof_filename);
447 for (i = 0, n = get_irp_n_irgs(); i < n; ++i) {
448 ir_graph *irg = get_irp_irg(i);
449 const arch_code_generator_if_t *cg_if;
451 optimization_state_t state;
453 /* stop and reset timers */
455 LC_STOP_AND_RESET_TIMER(t_prolog);
456 LC_STOP_AND_RESET_TIMER(t_abi);
457 LC_STOP_AND_RESET_TIMER(t_codegen);
458 LC_STOP_AND_RESET_TIMER(t_sched);
459 LC_STOP_AND_RESET_TIMER(t_constr);
460 LC_STOP_AND_RESET_TIMER(t_regalloc);
461 LC_STOP_AND_RESET_TIMER(t_finish);
462 LC_STOP_AND_RESET_TIMER(t_emit);
463 LC_STOP_AND_RESET_TIMER(t_verify);
464 LC_STOP_AND_RESET_TIMER(t_other);
466 BE_TIMER_PUSH(t_other); /* t_other */
468 BE_TIMER_ONLY(num_nodes_b = get_num_reachable_nodes(irg));
471 birg.main_env = &env;
473 edges_deactivate_kind(irg, EDGE_KIND_DEP);
474 edges_activate_kind(irg, EDGE_KIND_DEP);
476 DBG((env.dbg, LEVEL_2, "====> IRG: %F\n", irg));
477 dump(DUMP_INITIAL, irg, "-begin", dump_ir_block_graph);
479 BE_TIMER_PUSH(t_prolog);
481 be_stat_init_irg(env.arch_env, irg);
482 be_do_stat_nodes(irg, "01 Begin");
484 /* set the current graph (this is important for several firm functions) */
485 current_ir_graph = birg.irg;
487 /* Get the code generator interface. */
488 cg_if = isa->impl->get_code_generator_if(isa);
490 /* get a code generator for this graph. */
491 birg.cg = cg_if->init(&birg);
493 /* create the code generator and generate code. */
494 prepare_graph(&birg);
496 BE_TIMER_POP(t_prolog);
498 /* some transformations need to be done before abi introduce */
499 BE_TIMER_PUSH(t_codegen);
500 arch_code_generator_before_abi(birg.cg);
501 BE_TIMER_POP(t_codegen);
503 /* implement the ABI conventions. */
504 BE_TIMER_PUSH(t_abi);
505 birg.abi = be_abi_introduce(&birg);
508 dump(DUMP_ABI, irg, "-abi", dump_ir_block_graph);
509 be_do_stat_nodes(irg, "02 Abi");
512 BE_TIMER_PUSH(t_codegen);
513 arch_code_generator_prepare_graph(birg.cg);
514 BE_TIMER_POP(t_codegen);
516 be_do_stat_nodes(irg, "03 Prepare");
519 * Since the code generator made a lot of new nodes and skipped
520 * a lot of old ones, we should do dead node elimination here.
521 * Note that this requires disabling the edges here.
523 edges_deactivate(irg);
524 //dead_node_elimination(irg);
527 /* Compute loop nesting information (for weighting copies) */
528 construct_cf_backedges(irg);
529 dump(DUMP_PREPARED, irg, "-prepared", dump_ir_block_graph);
530 BE_TIMER_ONLY(num_nodes_r = get_num_reachable_nodes(irg));
532 /* let backend prepare scheduling */
533 BE_TIMER_PUSH(t_codegen);
534 arch_code_generator_before_sched(birg.cg);
535 BE_TIMER_POP(t_codegen);
537 /* schedule the irg */
538 BE_TIMER_PUSH(t_sched);
539 list_sched(&birg, &be_options);
540 BE_TIMER_POP(t_sched);
542 dump(DUMP_SCHED, irg, "-sched", dump_ir_block_graph_sched);
545 BE_TIMER_PUSH(t_verify);
546 be_sched_vrfy(birg.irg, be_options.vrfy_option);
547 BE_TIMER_POP(t_verify);
549 be_do_stat_nodes(irg, "04 Schedule");
551 /* introduce patterns to assure constraints */
552 BE_TIMER_PUSH(t_constr);
553 /* we switch off optimizations here, because they might cause trouble */
554 save_optimization_state(&state);
556 set_opt_normalize(0);
558 /* add Keeps for should_be_different constrained nodes */
559 /* beware: needs schedule due to usage of be_ssa_constr */
560 assure_constraints(&birg);
561 BE_TIMER_POP(t_constr);
563 dump(DUMP_SCHED, irg, "-assured", dump_ir_block_graph_sched);
564 be_do_stat_nodes(irg, "05 Constraints");
566 /* connect all stack modifying nodes together (see beabi.c) */
567 BE_TIMER_PUSH(t_abi);
568 be_abi_fix_stack_nodes(birg.abi, NULL);
571 dump(DUMP_SCHED, irg, "-fix_stack", dump_ir_block_graph_sched);
574 BE_TIMER_PUSH(t_verify);
575 be_sched_vrfy(birg.irg, be_options.vrfy_option);
576 BE_TIMER_POP(t_verify);
578 /* do some statistics */
579 be_do_stat_reg_pressure(&birg);
581 /* stuff needs to be done after scheduling but before register allocation */
582 BE_TIMER_PUSH(t_codegen);
583 arch_code_generator_before_ra(birg.cg);
584 BE_TIMER_POP(t_codegen);
586 /* Do register allocation */
587 BE_TIMER_PUSH(t_regalloc);
588 ra_timer = ra->allocate(&birg);
589 BE_TIMER_POP(t_regalloc);
591 dump(DUMP_RA, irg, "-ra", dump_ir_block_graph_sched);
592 be_do_stat_nodes(irg, "06 Register Allocation");
594 /* let the codegenerator prepare the graph for emitter */
595 BE_TIMER_PUSH(t_finish);
596 arch_code_generator_after_ra(birg.cg);
597 BE_TIMER_POP(t_finish);
599 /* fix stack offsets */
600 BE_TIMER_PUSH(t_abi);
601 be_abi_fix_stack_nodes(birg.abi, NULL);
602 be_remove_dead_nodes_from_schedule(birg.irg);
603 be_abi_fix_stack_bias(birg.abi);
606 BE_TIMER_PUSH(t_finish);
607 arch_code_generator_finish(birg.cg);
608 BE_TIMER_POP(t_finish);
610 dump(DUMP_FINAL, irg, "-finish", dump_ir_block_graph_sched);
612 /* check schedule and register allocation */
613 BE_TIMER_PUSH(t_verify);
614 if (be_options.vrfy_option == BE_VRFY_WARN) {
615 //irg_verify(birg.irg, VRFY_ENFORCE_SSA);
616 be_check_dominance(birg.irg);
617 be_verify_out_edges(birg.irg);
618 be_verify_schedule(birg.irg);
619 be_verify_register_allocation(env.arch_env, birg.irg);
621 else if (be_options.vrfy_option == BE_VRFY_ASSERT) {
622 //assert(irg_verify(birg.irg, VRFY_ENFORCE_SSA) && "irg verification failed");
623 assert(be_verify_out_edges(birg.irg));
624 assert(be_check_dominance(birg.irg) && "Dominance verification failed");
625 assert(be_verify_schedule(birg.irg) && "Schedule verification failed");
626 assert(be_verify_register_allocation(env.arch_env, birg.irg)
627 && "register allocation verification failed");
629 BE_TIMER_POP(t_verify);
631 /* emit assembler code */
632 BE_TIMER_PUSH(t_emit);
633 arch_code_generator_done(birg.cg);
634 BE_TIMER_POP(t_emit);
636 dump(DUMP_FINAL, irg, "-end", dump_ir_extblock_graph_sched);
638 BE_TIMER_PUSH(t_abi);
639 be_abi_free(birg.abi);
642 be_do_stat_nodes(irg, "07 Final");
643 restore_optimization_state(&state);
645 BE_TIMER_ONLY(num_nodes_a = get_num_reachable_nodes(irg));
646 BE_TIMER_POP(t_other);
648 #define LC_EMIT(timer) printf("%-20s: %.3lf msec\n", lc_timer_get_description(timer), (double)lc_timer_elapsed_usec(timer) / 1000.0)
649 #define LC_EMIT_RA(timer) printf("\t%-20s: %.3lf msec\n", lc_timer_get_description(timer), (double)lc_timer_elapsed_usec(timer) / 1000.0)
651 printf("==>> IRG %s <<==\n", get_entity_name(get_irg_entity(irg)));
652 printf("# nodes at begin: %u\n", num_nodes_b);
653 printf("# nodes before ra: %u\n", num_nodes_r);
654 printf("# nodes at end: %u\n\n", num_nodes_a);
661 LC_EMIT_RA(ra_timer->t_prolog);
662 LC_EMIT_RA(ra_timer->t_live);
663 LC_EMIT_RA(ra_timer->t_spill);
664 LC_EMIT_RA(ra_timer->t_spillslots);
665 LC_EMIT_RA(ra_timer->t_color);
666 LC_EMIT_RA(ra_timer->t_ifg);
667 LC_EMIT_RA(ra_timer->t_copymin);
668 LC_EMIT_RA(ra_timer->t_ssa);
669 LC_EMIT_RA(ra_timer->t_epilog);
670 LC_EMIT_RA(ra_timer->t_verify);
671 LC_EMIT_RA(ra_timer->t_other);
680 /* switched off due to statistics (statistic module needs all irgs) */
681 if (! stat_is_active())
693 /* Main interface to the frontend. */
694 void be_main(FILE *file_handle)
697 lc_timer_t *t = NULL;
698 #endif /* WITH_LIBCORE */
701 /* The user specified another config file to read. do that now. */
702 if(strlen(config_file) > 0) {
705 if((f = fopen(config_file, "rt")) != NULL) {
706 lc_opt_from_file(config_file, f, NULL);
711 if (be_options.timing == BE_TIME_ON) {
712 t = lc_timer_register("bemain", "measure complete bemain loop");
714 if (lc_timer_enter_high_priority()) {
715 fprintf(stderr, "Warning: Could not enter high priority mode.\n");
718 lc_timer_reset_and_start(t);
720 #endif /* WITH_LIBCORE */
722 /* never build code for pseudo irgs */
723 set_visit_pseudo_irgs(0);
726 be_main_loop(file_handle);
729 if (be_options.timing == BE_TIME_ON) {
731 lc_timer_leave_high_priority();
732 printf("%-20s: %lu msec\n", "BEMAINLOOP", lc_timer_elapsed_msec(t));
734 #endif /* WITH_LIBCORE */
737 /** The debug info retriever function. */
738 static retrieve_dbg_func retrieve_dbg = NULL;
740 /* Sets a debug info retriever. */
741 void be_set_debug_retrieve(retrieve_dbg_func func) {
745 /* Retrieve the debug info. */
746 const char *be_retrieve_dbg_info(const dbg_info *dbg, unsigned *line) {
748 return retrieve_dbg(dbg, line);
753 int be_put_ignore_regs(const be_irg_t *birg, const arch_register_class_t *cls, bitset_t *bs)
756 bs = bitset_alloca(cls->n_regs);
758 bitset_clear_all(bs);
760 assert(bitset_size(bs) == (unsigned) cls->n_regs);
761 arch_put_non_ignore_regs(birg->main_env->arch_env, cls, bs);
763 be_abi_put_ignore_regs(birg->abi, cls, bs);
764 return bitset_popcnt(bs);