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"
35 #include "firm/bearch_firm.h"
36 #include "ia32/bearch_ia32.h"
37 #include "arm/bearch_arm.h"
38 #include "ppc32/bearch_ppc32.h"
39 #include "mips/bearch_mips.h"
46 #include "besched_t.h"
47 #include "belistsched.h"
49 #include "bespillbelady.h"
51 #include "beraextern.h"
52 #include "bechordal_t.h"
54 #include "beifg_impl.h"
55 #include "becopyopt.h"
56 #include "becopystat.h"
57 #include "bessadestr.h"
60 #include "beschedmris.h"
64 /* options visible for anyone */
65 static be_options_t be_options = {
66 DUMP_NONE, /* dump options */
67 BE_TIME_OFF, /* no timing */
68 "i44pc52.info.uni-karlsruhe.de", /* ilp server */
69 "cplex" /* ilp solver */
73 static unsigned dump_flags = 0;
76 static unsigned vrfy_option = BE_VRFY_WARN;
78 /* register allocator to use. */
79 static const be_ra_t *ra = &be_ra_chordal_allocator;
81 /* back end instruction set architecture to use */
82 static const arch_isa_if_t *isa_if = &ia32_isa_if;
85 static int be_enable_mris = 0;
89 static lc_opt_entry_t *be_grp_root = NULL;
91 /* possible dumping options */
92 static const lc_opt_enum_mask_items_t dump_items[] = {
93 { "none", DUMP_NONE },
94 { "initial", DUMP_INITIAL },
96 { "sched", DUMP_SCHED },
97 { "prepared", DUMP_PREPARED },
98 { "regalloc", DUMP_RA },
99 { "final", DUMP_FINAL },
101 { "all", 2 * DUMP_BE - 1 },
105 /* register allocators */
106 static const lc_opt_enum_const_ptr_items_t ra_items[] = {
107 { "chordal", &be_ra_chordal_allocator },
108 { "external", &be_ra_external_allocator },
112 /* instruction set architectures. */
113 static const lc_opt_enum_const_ptr_items_t isa_items[] = {
114 { "ia32", &ia32_isa_if },
116 { "arm", &arm_isa_if },
117 { "ppc32", &ppc32_isa_if },
118 { "mips", &mips_isa_if },
123 /* verify options. */
124 static const lc_opt_enum_int_items_t vrfy_items[] = {
125 { "off", BE_VRFY_OFF },
126 { "warn", BE_VRFY_WARN },
127 { "assert", BE_VRFY_ASSERT },
131 static lc_opt_enum_mask_var_t dump_var = {
132 &dump_flags, dump_items
135 static lc_opt_enum_const_ptr_var_t ra_var = {
136 (const void **) &ra, ra_items
139 static lc_opt_enum_const_ptr_var_t isa_var = {
140 (const void **) &isa_if, isa_items
143 static lc_opt_enum_int_var_t vrfy_var = {
144 &vrfy_option, vrfy_items
147 static const lc_opt_table_entry_t be_main_options[] = {
148 LC_OPT_ENT_ENUM_MASK("dump", "dump irg on several occasions", &dump_var),
149 LC_OPT_ENT_ENUM_PTR ("ra", "register allocator", &ra_var),
150 LC_OPT_ENT_ENUM_PTR ("isa", "the instruction set architecture", &isa_var),
151 LC_OPT_ENT_NEGBOOL ("noomitfp", "do not omit frame pointer", &be_omit_fp),
152 LC_OPT_ENT_BOOL ("mris", "enable mris schedule preparation", &be_enable_mris),
153 LC_OPT_ENT_ENUM_PTR ("vrfy", "verify the backend irg (off, warn, assert)", &vrfy_var),
154 LC_OPT_ENT_BOOL ("time", "get backend timing statistics", &be_options.timing),
157 LC_OPT_ENT_STR ("ilp.server", "the ilp server name", be_options.ilp_server, sizeof(be_options.ilp_server)),
158 LC_OPT_ENT_STR ("ilp.solver", "the ilp solver name", be_options.ilp_solver, sizeof(be_options.ilp_solver)),
159 #endif /* WITH_ILP */
163 #endif /* WITH_LIBCORE */
165 void be_opt_register(void)
169 lc_opt_entry_t *be_grp_ra;
170 static int run_once = 0;
174 be_grp_root = lc_opt_get_grp(firm_opt_get_root(), "be");
175 be_grp_ra = lc_opt_get_grp(be_grp_root, "ra");
177 lc_opt_add_table(be_grp_root, be_main_options);
179 /* register allocator options */
180 for(i = 0; ra_items[i].name != NULL; ++i) {
181 const be_ra_t *ra = ra_items[i].value;
182 ra->register_options(be_grp_ra);
185 /* register isa options */
186 for(i = 0; isa_items[i].name != NULL; ++i) {
187 const arch_isa_if_t *isa = isa_items[i].value;
188 isa->register_options(be_grp_root);
191 #endif /* WITH_LIBCORE */
194 /* Parse one argument. */
195 int be_parse_arg(const char *arg) {
197 if (strcmp(arg, "help") == 0 || (arg[0] == '?' && arg[1] == '\0')) {
198 lc_opt_print_help(be_grp_root, stdout);
201 return lc_opt_from_single_arg(be_grp_root, NULL, arg, NULL);
204 #endif /* WITH_LIBCORE */
207 /** The be parameters returned by default, all off. */
208 const static backend_params be_params = {
215 /* Perform schedule verification if requested. */
216 static void be_sched_vrfy(ir_graph *irg, int vrfy_opt) {
217 if (vrfy_opt == BE_VRFY_WARN) {
218 be_verify_schedule(irg);
220 else if (vrfy_opt == BE_VRFY_ASSERT) {
221 assert(be_verify_schedule(irg) && "Schedule verification failed.");
225 /* Initialize the Firm backend. Must be run BEFORE init_firm()! */
226 const backend_params *be_init(void)
237 if (isa_if->get_params)
238 return isa_if->get_params();
243 * Initializes the main environment for the backend.
245 * @param env an empty environment
246 * @param file_handle the file handle where the output will be written to
248 static be_main_env_t *be_init_env(be_main_env_t *env, FILE *file_handle)
250 memset(env, 0, sizeof(*env));
251 obstack_init(&env->obst);
252 env->arch_env = obstack_alloc(&env->obst, sizeof(env->arch_env[0]));
253 env->options = &be_options;
254 env->options->dump_flags = dump_flags;
255 FIRM_DBG_REGISTER(env->dbg, "be.main");
257 arch_env_init(env->arch_env, isa_if, file_handle);
259 /* Register the irn handler of the architecture */
260 if (arch_isa_get_irn_handler(env->arch_env->isa))
261 arch_env_push_irn_handler(env->arch_env, arch_isa_get_irn_handler(env->arch_env->isa));
264 * Register the node handler of the back end infrastructure.
265 * This irn handler takes care of the platform independent
266 * spill, reload and perm nodes.
268 arch_env_push_irn_handler(env->arch_env, &be_node_irn_handler);
269 env->phi_handler = be_phi_handler_new(env->arch_env);
270 arch_env_push_irn_handler(env->arch_env, env->phi_handler);
275 static void be_done_env(be_main_env_t *env)
277 env->arch_env->isa->impl->done(env->arch_env->isa);
278 be_phi_handler_free(env->phi_handler);
279 obstack_free(&env->obst, NULL);
283 * A wrapper around a firm dumper. Dumps only, if
286 * @param mask a bitmask containing the reason what will be dumped
287 * @param irg the IR graph to dump
288 * @param suffix the suffix for the dumper
289 * @param dumper the dumper to be called
291 static void dump(int mask, ir_graph *irg, const char *suffix,
292 void (*dumper)(ir_graph *, const char *))
294 if(dump_flags & mask)
295 be_dump(irg, suffix, dumper);
299 * Prepare a backend graph for code generation.
301 static void prepare_graph(be_irg_t *birg)
303 ir_graph *irg = birg->irg;
305 /* Normalize proj nodes. */
306 normalize_proj_nodes(irg);
308 /* Make just one return node. */
309 normalize_one_return(irg);
311 /* Remove critical edges */
312 remove_critical_cf_edges(irg);
314 /* Compute the dominance information. */
318 /* Ensure, that the ir_edges are computed. */
321 /* check, if the dominance property is fulfilled. */
322 be_check_dominance(irg);
324 /* reset the phi handler. */
325 be_phi_handler_reset(birg->main_env->phi_handler);
329 * The Firm backend main loop.
330 * Do architecture specific lowering for all graphs
331 * and call the architecture specific code generator.
333 * @param file_handle the file handle the output will be written to
335 static void be_main_loop(FILE *file_handle)
340 unsigned num_nodes_b = 0;
341 unsigned num_nodes_a = 0;
342 unsigned num_nodes_r = 0;
343 lc_timer_t *t_prolog, *t_abi, *t_codegen, *t_sched, *t_constr, *t_regalloc, *t_finish, *t_emit, *t_other, *t_verify;
344 be_ra_timer_t *ra_timer;
346 if (be_options.timing == BE_TIME_ON) {
347 t_prolog = lc_timer_register("prolog", "prolog");
348 t_abi = lc_timer_register("beabi", "be abi introduction");
349 t_codegen = lc_timer_register("codegen", "codegeneration");
350 t_sched = lc_timer_register("sched", "scheduling");
351 t_constr = lc_timer_register("constr", "assure constraints");
352 t_regalloc = lc_timer_register("regalloc", "register allocation");
353 t_finish = lc_timer_register("finish", "graph finish");
354 t_emit = lc_timer_register("emiter", "code emiter");
355 t_verify = lc_timer_register("verify", "graph verification");
356 t_other = lc_timer_register("other", "other");
359 be_init_env(&env, file_handle);
361 isa = arch_env_get_isa(env.arch_env);
363 /* for debugging, anchors helps */
364 // dump_all_anchors(1);
366 #define BE_TIMER_PUSH(timer) \
367 if (be_options.timing == BE_TIME_ON) { \
368 int res = lc_timer_push(timer); \
369 if (vrfy_option == BE_VRFY_ASSERT) \
370 assert(res && "Timer already on stack, cannot be pushed twice."); \
371 else if (vrfy_option == BE_VRFY_WARN && ! res) \
372 fprintf(stderr, "Timer %s already on stack, cannot be pushed twice.\n", \
373 lc_timer_get_name(timer)); \
375 #define BE_TIMER_POP(timer) \
376 if (be_options.timing == BE_TIME_ON) { \
377 lc_timer_t *tmp = lc_timer_pop(); \
378 if (vrfy_option == BE_VRFY_ASSERT) \
379 assert(tmp == timer && "Attempt to pop wrong timer."); \
380 else if (vrfy_option == BE_VRFY_WARN && tmp != timer) \
381 fprintf(stderr, "Attempt to pop wrong timer. %s is on stack, trying to pop %s.\n", \
382 lc_timer_get_name(tmp), lc_timer_get_name(timer)); \
386 #define BE_TIMER_ONLY(code) if (be_options.timing == BE_TIME_ON) do { code; } while(0)
389 for (i = 0, n = get_irp_n_irgs(); i < n; ++i) {
390 ir_graph *irg = get_irp_irg(i);
391 const arch_code_generator_if_t *cg_if;
393 optimization_state_t state;
395 /* stop and reset timers */
396 if (be_options.timing == BE_TIME_ON) {
397 LC_STOP_AND_RESET_TIMER(t_prolog);
398 LC_STOP_AND_RESET_TIMER(t_abi);
399 LC_STOP_AND_RESET_TIMER(t_codegen);
400 LC_STOP_AND_RESET_TIMER(t_sched);
401 LC_STOP_AND_RESET_TIMER(t_constr);
402 LC_STOP_AND_RESET_TIMER(t_regalloc);
403 LC_STOP_AND_RESET_TIMER(t_finish);
404 LC_STOP_AND_RESET_TIMER(t_emit);
405 LC_STOP_AND_RESET_TIMER(t_verify);
406 LC_STOP_AND_RESET_TIMER(t_other);
408 BE_TIMER_PUSH(t_other); /* t_other */
410 BE_TIMER_ONLY(num_nodes_b = get_num_reachable_nodes(irg));
413 birg.main_env = &env;
415 DBG((env.dbg, LEVEL_2, "====> IRG: %F\n", irg));
416 dump(DUMP_INITIAL, irg, "-begin", dump_ir_block_graph);
418 BE_TIMER_PUSH(t_prolog);
420 be_stat_init_irg(env.arch_env, irg);
421 be_do_stat_nodes(irg, "01 Begin");
423 /* set the current graph (this is important for several firm functions) */
424 current_ir_graph = birg.irg;
426 /* Get the code generator interface. */
427 cg_if = isa->impl->get_code_generator_if(isa);
429 /* get a code generator for this graph. */
430 birg.cg = cg_if->init(&birg);
432 /* create the code generator and generate code. */
433 prepare_graph(&birg);
435 BE_TIMER_POP(t_prolog);
437 /* some transformations need to be done before abi introduce */
438 BE_TIMER_PUSH(t_codegen);
439 arch_code_generator_before_abi(birg.cg);
440 BE_TIMER_POP(t_codegen);
442 /* implement the ABI conventions. */
443 BE_TIMER_PUSH(t_abi);
444 birg.abi = be_abi_introduce(&birg);
447 dump(DUMP_ABI, irg, "-abi", dump_ir_block_graph);
448 be_do_stat_nodes(irg, "02 Abi");
451 BE_TIMER_PUSH(t_codegen);
452 arch_code_generator_prepare_graph(birg.cg);
453 BE_TIMER_POP(t_codegen);
455 be_do_stat_nodes(irg, "03 Prepare");
458 * Since the code generator made a lot of new nodes and skipped
459 * a lot of old ones, we should do dead node elimination here.
460 * Note that this requires disabling the edges here.
462 edges_deactivate(irg);
463 //dead_node_elimination(irg);
466 /* Compute loop nesting information (for weighting copies) */
467 construct_cf_backedges(irg);
468 dump(DUMP_PREPARED, irg, "-prepared", dump_ir_block_graph);
469 BE_TIMER_ONLY(num_nodes_r = get_num_reachable_nodes(irg));
471 /* let backend prepare scheduling */
472 BE_TIMER_PUSH(t_codegen);
473 arch_code_generator_before_sched(birg.cg);
474 BE_TIMER_POP(t_codegen);
476 /* schedule the irg */
477 BE_TIMER_PUSH(t_sched);
478 list_sched(&birg, be_enable_mris);
479 BE_TIMER_POP(t_sched);
481 dump(DUMP_SCHED, irg, "-sched", dump_ir_block_graph_sched);
484 BE_TIMER_PUSH(t_verify);
485 be_sched_vrfy(birg.irg, vrfy_option);
486 BE_TIMER_POP(t_verify);
488 be_do_stat_nodes(irg, "04 Schedule");
490 /* introduce patterns to assure constraints */
491 BE_TIMER_PUSH(t_constr);
492 /* we switch off optimizations here, because they might cause trouble */
493 save_optimization_state(&state);
495 set_opt_normalize(0);
497 /* add Keeps for should_be_different constrained nodes */
498 /* beware: needs schedule due to usage of be_ssa_constr */
499 assure_constraints(&birg);
500 BE_TIMER_POP(t_constr);
502 dump(DUMP_SCHED, irg, "-assured", dump_ir_block_graph_sched);
503 be_do_stat_nodes(irg, "05 Constraints");
505 /* connect all stack modifying nodes together (see beabi.c) */
506 BE_TIMER_PUSH(t_abi);
507 be_abi_fix_stack_nodes(birg.abi);
510 dump(DUMP_SCHED, irg, "-fix_stack", dump_ir_block_graph_sched);
513 BE_TIMER_PUSH(t_verify);
514 be_sched_vrfy(birg.irg, vrfy_option);
515 BE_TIMER_POP(t_verify);
517 /* do some statistics */
518 be_do_stat_reg_pressure(&birg);
520 /* stuff needs to be done after scheduling but before register allocation */
521 BE_TIMER_PUSH(t_codegen);
522 arch_code_generator_before_ra(birg.cg);
523 BE_TIMER_POP(t_codegen);
525 /* Do register allocation */
526 BE_TIMER_ONLY(lc_timer_start(t_regalloc));
527 ra_timer = ra->allocate(&birg);
528 BE_TIMER_ONLY(lc_timer_stop(t_regalloc));
530 dump(DUMP_RA, irg, "-ra", dump_ir_block_graph_sched);
531 be_do_stat_nodes(irg, "06 Register Allocation");
533 /* let the codegenerator prepare the graph for emitter */
534 BE_TIMER_PUSH(t_finish);
535 arch_code_generator_after_ra(birg.cg);
536 BE_TIMER_POP(t_finish);
538 /* fix stack offsets */
539 BE_TIMER_PUSH(t_abi);
540 be_abi_fix_stack_bias(birg.abi);
544 BE_TIMER_PUSH(t_verify);
545 be_sched_vrfy(birg.irg, vrfy_option);
546 BE_TIMER_POP(t_verify);
548 /* emit assembler code */
549 BE_TIMER_PUSH(t_emit);
550 arch_code_generator_done(birg.cg);
551 BE_TIMER_POP(t_emit);
553 dump(DUMP_FINAL, irg, "-end", dump_ir_extblock_graph_sched);
555 BE_TIMER_PUSH(t_abi);
556 be_abi_free(birg.abi);
559 be_do_stat_nodes(irg, "07 Final");
560 restore_optimization_state(&state);
562 BE_TIMER_ONLY(num_nodes_a = get_num_reachable_nodes(irg));
564 /* switched off due to statistics (statistic module needs all irgs) */
565 if (! stat_is_active())
568 BE_TIMER_POP(t_other);
570 #define LC_EMIT(timer) printf("%-20s: %.3lf msec\n", lc_timer_get_description(timer), (double)lc_timer_elapsed_usec(timer) / 1000.0)
571 #define LC_EMIT_RA(timer) printf("\t%-20s: %.3lf msec\n", lc_timer_get_description(timer), (double)lc_timer_elapsed_usec(timer) / 1000.0)
572 if (be_options.timing == BE_TIME_ON) {
573 printf("==>> IRG %s <<==\n", get_entity_name(get_irg_entity(irg)));
574 printf("# nodes at begin: %u\n", num_nodes_b);
575 printf("# nodes before ra: %u\n", num_nodes_r);
576 printf("# nodes at end: %u\n\n", num_nodes_a);
583 LC_EMIT_RA(ra_timer->t_prolog);
584 LC_EMIT_RA(ra_timer->t_live);
585 LC_EMIT_RA(ra_timer->t_spill);
586 LC_EMIT_RA(ra_timer->t_color);
587 LC_EMIT_RA(ra_timer->t_ifg);
588 LC_EMIT_RA(ra_timer->t_copymin);
589 LC_EMIT_RA(ra_timer->t_ssa);
590 LC_EMIT_RA(ra_timer->t_epilog);
591 LC_EMIT_RA(ra_timer->t_verify);
592 LC_EMIT_RA(ra_timer->t_other);
607 /* Main interface to the frontend. */
608 void be_main(FILE *file_handle)
613 if (be_options.timing == BE_TIME_ON) {
614 t = lc_timer_register("bemain", "measure complete bemain loop");
616 if (lc_timer_enter_high_priority()) {
617 fprintf(stderr, "Warning: Could not enter high priority mode.\n");
620 lc_timer_reset_and_start(t);
622 #endif /* WITH_LIBCORE */
624 /* never build code for pseudo irgs */
625 set_visit_pseudo_irgs(0);
628 be_main_loop(file_handle);
631 if (be_options.timing == BE_TIME_ON) {
633 lc_timer_leave_high_priority();
634 printf("%-20s: %lu msec\n", "BEMAINLOOP", lc_timer_elapsed_msec(t));
636 #endif /* WITH_LIBCORE */
639 /** The debug info retriever function. */
640 static retrieve_dbg_func retrieve_dbg = NULL;
642 /* Sets a debug info retriever. */
643 void be_set_debug_retrieve(retrieve_dbg_func func) {
647 /* Retrieve the debug info. */
648 const char *be_retrieve_dbg_info(const dbg_info *dbg, unsigned *line) {
650 return retrieve_dbg(dbg, line);