values may die at every use
[libfirm] / ir / be / bemain.c
1 /**
2  * Backend driver.
3  * @author Sebastian Hack
4  * @date   25.11.2004
5  * @cvsid  $Id$
6  */
7 #ifdef HAVE_CONFIG_H
8 #include "config.h"
9 #endif
10
11 #include <stdarg.h>
12
13 #ifdef WITH_LIBCORE
14 #include <libcore/lc_opts.h>
15 #include <libcore/lc_opts_enum.h>
16 #include <libcore/lc_timing.h>
17 #endif /* WITH_LIBCORE */
18
19 #include "obst.h"
20 #include "bitset.h"
21
22 #include "irprog.h"
23 #include "irgopt.h"
24 #include "irgraph.h"
25 #include "irdump.h"
26 #include "phiclass.h"
27 #include "irdom_t.h"
28 #include "iredges_t.h"
29 #include "irloop_t.h"
30 #include "irtools.h"
31 #include "return.h"
32
33 #include "bearch.h"
34 #include "firm/bearch_firm.h"
35 #include "ia32/bearch_ia32.h"
36 #include "arm/bearch_arm.h"
37 #include "ppc32/bearch_ppc32.h"
38 #include "mips/bearch_mips.h"
39
40 #include "be_t.h"
41 #include "benumb_t.h"
42 #include "beutil.h"
43 #include "benode_t.h"
44 #include "beirgmod.h"
45 #include "besched_t.h"
46 #include "belistsched.h"
47 #include "belive_t.h"
48 #include "bespillilp.h"
49 #include "bespillbelady.h"
50 #include "bera.h"
51 #include "beraextern.h"
52 #include "bechordal_t.h"
53 #include "beifg.h"
54 #include "beifg_impl.h"
55 #include "becopyopt.h"
56 #include "becopystat.h"
57 #include "bessadestr.h"
58 #include "beabi.h"
59 #include "belower.h"
60 #include "beschedmris.h"
61 #include "bestat.h"
62 #include "beverify.h"
63
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 */
70 };
71
72 /* dump flags */
73 static unsigned dump_flags = 0;
74
75 /* verify options */
76 static unsigned vrfy_option = BE_VRFY_WARN;
77
78 /* register allocator to use. */
79 static const be_ra_t *ra = &be_ra_chordal_allocator;
80
81 /* back end instruction set architecture to use */
82 static const arch_isa_if_t *isa_if = &ia32_isa_if;
83
84 /* mris option */
85 static int be_enable_mris = 0;
86
87 #ifdef WITH_LIBCORE
88
89 static lc_opt_entry_t *be_grp_root = NULL;
90
91 /* possible dumping options */
92 static const lc_opt_enum_mask_items_t dump_items[] = {
93         { "none",       DUMP_NONE },
94         { "initial",    DUMP_INITIAL },
95         { "abi",        DUMP_ABI    },
96         { "sched",      DUMP_SCHED  },
97         { "prepared",   DUMP_PREPARED },
98         { "regalloc",   DUMP_RA },
99         { "final",      DUMP_FINAL },
100         { "be",         DUMP_BE },
101         { "all",        2 * DUMP_BE - 1 },
102         { NULL,         0 }
103 };
104
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 },
109         { NULL,      NULL }
110 };
111
112 /* instruction set architectures. */
113 static const lc_opt_enum_const_ptr_items_t isa_items[] = {
114         { "ia32",    &ia32_isa_if },
115 #if 0
116         { "arm",     &arm_isa_if },
117         { "ppc32",   &ppc32_isa_if },
118         { "mips",    &mips_isa_if },
119 #endif
120         { NULL,      NULL }
121 };
122
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 },
128         { NULL,     0 }
129 };
130
131 static lc_opt_enum_mask_var_t dump_var = {
132         &dump_flags, dump_items
133 };
134
135 static lc_opt_enum_const_ptr_var_t ra_var = {
136         (const void **) &ra, ra_items
137 };
138
139 static lc_opt_enum_const_ptr_var_t isa_var = {
140         (const void **) &isa_if, isa_items
141 };
142
143 static lc_opt_enum_int_var_t vrfy_var = {
144         &vrfy_option, vrfy_items
145 };
146
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),
155
156 #ifdef WITH_ILP
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 */
160         { NULL }
161 };
162
163 #endif /* WITH_LIBCORE */
164
165 void be_opt_register(void)
166 {
167 #ifdef WITH_LIBCORE
168         int i;
169         lc_opt_entry_t *be_grp_ra;
170         static int run_once = 0;
171
172         if (! run_once) {
173                 run_once    = 1;
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");
176
177                 lc_opt_add_table(be_grp_root, be_main_options);
178
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);
183                 }
184
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);
189                 }
190         }
191 #endif /* WITH_LIBCORE */
192 }
193
194 /* Parse one argument. */
195 int be_parse_arg(const char *arg) {
196 #ifdef WITH_LIBCORE
197         if (strcmp(arg, "help") == 0 || (arg[0] == '?' && arg[1] == '\0')) {
198                 lc_opt_print_help(be_grp_root, stdout);
199                 return -1;
200         }
201         return lc_opt_from_single_arg(be_grp_root, NULL, arg, NULL);
202 #else
203         return 0;
204 #endif /* WITH_LIBCORE */
205 }
206
207 /** The be parameters returned by default, all off. */
208 const static backend_params be_params = {
209         NULL,
210         NULL,
211         0,
212         NULL,
213 };
214
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);
219         }
220         else if (vrfy_opt == BE_VRFY_ASSERT) {
221                 assert(be_verify_schedule(irg) && "Schedule verification failed.");
222         }
223 }
224
225 /* Initialize the Firm backend. Must be run BEFORE init_firm()! */
226 const backend_params *be_init(void)
227 {
228         be_opt_register();
229
230         be_sched_init();
231         be_liveness_init();
232         be_numbering_init();
233         be_copy_opt_init();
234         copystat_init();
235         phi_class_init();
236
237         if (isa_if->get_params)
238                 return isa_if->get_params();
239         return &be_params;
240 }
241
242 /**
243  * Initializes the main environment for the backend.
244  *
245  * @param env          an empty environment
246  * @param file_handle  the file handle where the output will be written to
247  */
248 static be_main_env_t *be_init_env(be_main_env_t *env, FILE *file_handle)
249 {
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");
256
257         arch_env_init(env->arch_env, isa_if, file_handle);
258
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));
262
263         /*
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.
267          */
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);
271
272         return env;
273 }
274
275 static void be_done_env(be_main_env_t *env)
276 {
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);
280 }
281
282 /**
283  * A wrapper around a firm dumper. Dumps only, if
284  * flags are enabled.
285  *
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
290  */
291 static void dump(int mask, ir_graph *irg, const char *suffix,
292                  void (*dumper)(ir_graph *, const char *))
293 {
294         if(dump_flags & mask)
295                 be_dump(irg, suffix, dumper);
296 }
297
298 /**
299  * Prepare a backend graph for code generation.
300  */
301 static void prepare_graph(be_irg_t *birg)
302 {
303         ir_graph *irg = birg->irg;
304
305         /* Normalize proj nodes. */
306         normalize_proj_nodes(irg);
307
308         /* Make just one return node. */
309         normalize_one_return(irg);
310
311         /* Remove critical edges */
312         remove_critical_cf_edges(irg);
313
314         /* Compute the dominance information. */
315         free_dom(irg);
316         compute_doms(irg);
317
318         /* Ensure, that the ir_edges are computed. */
319         edges_activate(irg);
320
321         /* check, if the dominance property is fulfilled. */
322         be_check_dominance(irg);
323
324         /* reset the phi handler. */
325         be_phi_handler_reset(birg->main_env->phi_handler);
326 }
327
328 /**
329  * The Firm backend main loop.
330  * Do architecture specific lowering for all graphs
331  * and call the architecture specific code generator.
332  *
333  * @param file_handle   the file handle the output will be written to
334  */
335 static void be_main_loop(FILE *file_handle)
336 {
337         int i, n;
338         arch_isa_t *isa;
339         be_main_env_t env;
340         unsigned num_nodes_b = 0;
341         unsigned num_nodes_a = 0;
342         unsigned num_nodes_r = 0;
343         unsigned ra_prolog   = 0;
344         unsigned ra_epilog   = 0;
345         unsigned ra_live     = 0;
346         unsigned ra_spill    = 0;
347         unsigned ra_color    = 0;
348         unsigned ra_ifg      = 0;
349         unsigned ra_copymin  = 0;
350         unsigned ra_ssa      = 0;
351         lc_timer_t *t_prolog, *t_abi, *t_codegen, *t_sched, *t_constr, *t_regalloc, *t_finish, *t_emit;
352         be_ra_timer_t *ra_timer;
353
354         if (be_options.timing == BE_TIME_ON) {
355                 t_prolog   = lc_timer_register("prolog",   "prolog");
356                 t_abi      = lc_timer_register("beabi",    "be abi introduction");
357                 t_codegen  = lc_timer_register("codegen",  "codegeneration");
358                 t_sched    = lc_timer_register("sched",    "scheduling");
359                 t_constr   = lc_timer_register("constr",   "assure constraints");
360                 t_regalloc = lc_timer_register("regalloc", "register allocation");
361                 t_finish   = lc_timer_register("finish",   "graph finish");
362                 t_emit     = lc_timer_register("emiter",   "code emiter");
363         }
364
365         be_init_env(&env, file_handle);
366
367         isa = arch_env_get_isa(env.arch_env);
368
369         /* for debugging, anchors helps */
370         // dump_all_anchors(1);
371
372 #define BE_TIME_START(timer) if (be_options.timing == BE_TIME_ON) lc_timer_start(timer);
373 #define BE_TIME_STOP(timer)  if (be_options.timing == BE_TIME_ON) lc_timer_stop(timer);
374 #define BE_TIME_ONLY(code)   if (be_options.timing == BE_TIME_ON) { code; }
375
376         /* For all graphs */
377         for (i = 0, n = get_irp_n_irgs(); i < n; ++i) {
378                 ir_graph *irg = get_irp_irg(i);
379                 const arch_code_generator_if_t *cg_if;
380                 be_irg_t birg;
381                 optimization_state_t state;
382
383                 /* stop and reset timers */
384                 if (be_options.timing == BE_TIME_ON) {
385                         LC_STOP_AND_RESET_TIMER(t_prolog);
386                         LC_STOP_AND_RESET_TIMER(t_abi);
387                         LC_STOP_AND_RESET_TIMER(t_codegen);
388                         LC_STOP_AND_RESET_TIMER(t_sched);
389                         LC_STOP_AND_RESET_TIMER(t_constr);
390                         LC_STOP_AND_RESET_TIMER(t_regalloc);
391                         LC_STOP_AND_RESET_TIMER(t_finish);
392                         LC_STOP_AND_RESET_TIMER(t_emit);
393                 }
394
395                 BE_TIME_ONLY(num_nodes_b = get_num_reachable_nodes(irg));
396
397                 birg.irg      = irg;
398                 birg.main_env = &env;
399
400                 BE_TIME_START(t_prolog);
401
402                 DBG((env.dbg, LEVEL_2, "====> IRG: %F\n", irg));
403                 dump(DUMP_INITIAL, irg, "-begin", dump_ir_block_graph);
404
405                 be_stat_init_irg(env.arch_env, irg);
406                 be_do_stat_nodes(irg, "01 Begin");
407
408                 /* set the current graph (this is important for several firm functions) */
409                 current_ir_graph = birg.irg;
410
411                 /* Get the code generator interface. */
412                 cg_if = isa->impl->get_code_generator_if(isa);
413
414                 /* get a code generator for this graph. */
415                 birg.cg = cg_if->init(&birg);
416
417                 /* create the code generator and generate code. */
418                 prepare_graph(&birg);
419
420                 /* some transformations need to be done before abi introduce */
421                 arch_code_generator_before_abi(birg.cg);
422
423                 BE_TIME_STOP(t_prolog);
424                 BE_TIME_START(t_abi);
425
426                 /* implement the ABI conventions. */
427                 birg.abi = be_abi_introduce(&birg);
428                 dump(DUMP_ABI, irg, "-abi", dump_ir_block_graph);
429
430                 be_do_stat_nodes(irg, "02 Abi");
431
432                 BE_TIME_STOP(t_abi);
433                 BE_TIME_START(t_codegen);
434
435                 /* generate code */
436                 arch_code_generator_prepare_graph(birg.cg);
437
438                 be_do_stat_nodes(irg, "03 Prepare");
439
440                 /*
441                  * Since the code generator made a lot of new nodes and skipped
442                  * a lot of old ones, we should do dead node elimination here.
443                  * Note that this requires disabling the edges here.
444                  */
445                 edges_deactivate(irg);
446                 //dead_node_elimination(irg);
447                 edges_activate(irg);
448
449                 /* Compute loop nesting information (for weighting copies) */
450                 construct_cf_backedges(irg);
451
452                 dump(DUMP_PREPARED, irg, "-prepared", dump_ir_block_graph);
453
454                 BE_TIME_STOP(t_codegen);
455                 BE_TIME_ONLY(num_nodes_r = get_num_reachable_nodes(irg));
456                 BE_TIME_START(t_sched);
457
458                 /* Schedule the graphs. */
459                 arch_code_generator_before_sched(birg.cg);
460                 list_sched(&birg, be_enable_mris);
461                 dump(DUMP_SCHED, irg, "-sched", dump_ir_block_graph_sched);
462
463                 /* check schedule */
464                 be_sched_vrfy(birg.irg, vrfy_option);
465
466                 be_do_stat_nodes(irg, "04 Schedule");
467
468                 BE_TIME_STOP(t_sched);
469                 BE_TIME_START(t_constr);
470
471                 /* we switch off optimizations here, because they might cause trouble */
472                 save_optimization_state(&state);
473                 set_optimize(0);
474                 set_opt_normalize(0);
475
476                 /* add Keeps for should_be_different constrained nodes  */
477                 /* beware: needs schedule due to usage of be_ssa_constr */
478                 assure_constraints(&birg);
479                 dump(DUMP_SCHED, irg, "-assured", dump_ir_block_graph_sched);
480
481                 be_do_stat_nodes(irg, "05 Constraints");
482
483                 /* connect all stack modifying nodes together (see beabi.c) */
484                 be_abi_fix_stack_nodes(birg.abi);
485                 dump(DUMP_SCHED, irg, "-fix_stack", dump_ir_block_graph_sched);
486
487                 /* check schedule */
488                 be_sched_vrfy(birg.irg, vrfy_option);
489
490                 /* do some statistics */
491                 be_do_stat_reg_pressure(&birg);
492
493                 /* stuff needs to bo done after scheduling but before register allocation */
494                 arch_code_generator_before_ra(birg.cg);
495
496                 BE_TIME_STOP(t_constr);
497                 BE_TIME_START(t_regalloc);
498
499                 /* Do register allocation */
500                 ra_timer = ra->allocate(&birg);
501                 dump(DUMP_RA, irg, "-ra", dump_ir_block_graph_sched);
502
503                 if (be_options.timing == BE_TIME_ON && ra_timer) {
504                         ra_prolog  = lc_timer_elapsed_msec(ra_timer->t_prolog);
505                         ra_epilog  = lc_timer_elapsed_msec(ra_timer->t_epilog);
506                         ra_live    = lc_timer_elapsed_msec(ra_timer->t_live);
507                         ra_spill   = lc_timer_elapsed_msec(ra_timer->t_spill);
508                         ra_color   = lc_timer_elapsed_msec(ra_timer->t_color);
509                         ra_copymin = lc_timer_elapsed_msec(ra_timer->t_copymin);
510                         ra_ssa     = lc_timer_elapsed_msec(ra_timer->t_ssa);
511                         ra_ifg     = lc_timer_elapsed_msec(ra_timer->t_ifg);
512                 }
513
514                 be_do_stat_nodes(irg, "06 Register Allocation");
515
516                 BE_TIME_STOP(t_regalloc);
517                 BE_TIME_START(t_finish);
518
519                 arch_code_generator_after_ra(birg.cg);
520                 be_abi_fix_stack_bias(birg.abi);
521
522                 /* check schedule */
523                 be_sched_vrfy(birg.irg, vrfy_option);
524
525                 BE_TIME_STOP(t_finish);
526                 BE_TIME_START(t_emit);
527
528                 arch_code_generator_done(birg.cg);
529                 dump(DUMP_FINAL, irg, "-end", dump_ir_extblock_graph_sched);
530                 be_abi_free(birg.abi);
531
532                 be_do_stat_nodes(irg, "07 Final");
533
534                 BE_TIME_STOP(t_emit);
535
536                 restore_optimization_state(&state);
537
538                 BE_TIME_ONLY(num_nodes_a = get_num_reachable_nodes(irg));
539
540                 /* switched off due to statistics (statistic module needs all irgs) */
541                 //              free_ir_graph(irg);
542 #define LC_EMIT(timer)     printf("%10s: %u msec\n", lc_timer_get_name(timer), lc_timer_elapsed_msec(timer))
543 #define EMIT_RA_TIME(n, t) printf("%20s: %u msec\n", n, t)
544                 if (be_options.timing == BE_TIME_ON) {
545                         printf("==>> IRG %s <<==\n", get_entity_name(get_irg_entity(irg)));
546                         printf("# nodes at begin:  %u\n", num_nodes_b);
547                         printf("# nodes before ra: %u\n", num_nodes_r);
548                         printf("# nodes at end:    %u\n\n", num_nodes_a);
549                         LC_EMIT(t_prolog);
550                         LC_EMIT(t_abi);
551                         LC_EMIT(t_codegen);
552                         LC_EMIT(t_sched);
553                         LC_EMIT(t_constr);
554                         LC_EMIT(t_regalloc);
555                         EMIT_RA_TIME("prolog",    ra_prolog);
556                         EMIT_RA_TIME("liveness",  ra_live);
557                         EMIT_RA_TIME("spilling",  ra_spill);
558                         EMIT_RA_TIME("coloring",  ra_color);
559                         EMIT_RA_TIME("ifg build", ra_ifg);
560                         EMIT_RA_TIME("copymin",   ra_copymin);
561                         EMIT_RA_TIME("ssa destr", ra_ssa);
562                         EMIT_RA_TIME("epilog",    ra_epilog);
563                         LC_EMIT(t_finish);
564                         LC_EMIT(t_emit);
565                 }
566 #undef LC_EMIT
567         }
568         be_done_env(&env);
569
570 #undef BE_TIME_START
571 #undef BE_TIME_STOP
572 #undef BE_TIME_ONLY
573 }
574
575 /* Main interface to the frontend. */
576 void be_main(FILE *file_handle)
577 {
578 #ifdef WITH_LIBCORE
579         lc_timer_t *t;
580
581         if (be_options.timing == BE_TIME_ON) {
582                 t = lc_timer_register("bemain", "measure complete bemain loop");
583
584                 if (lc_timer_enter_high_priority()) {
585                         fprintf(stderr, "Warning: Could not enter high priority mode.\n");
586                 }
587
588                 lc_timer_reset_and_start(t);
589         }
590 #endif /* WITH_LIBCORE */
591
592         /* never build code for pseudo irgs */
593         set_visit_pseudo_irgs(0);
594
595         be_node_init();
596         be_main_loop(file_handle);
597
598 #ifdef WITH_LIBCORE
599         if (be_options.timing == BE_TIME_ON) {
600                 lc_timer_stop(t);
601                 lc_timer_leave_high_priority();
602                 printf("BEMAINLOOP: %lu msec\n", lc_timer_elapsed_msec(t));
603         }
604 #endif /* WITH_LIBCORE */
605 }
606
607 /** The debug info retriever function. */
608 static retrieve_dbg_func retrieve_dbg = NULL;
609
610 /* Sets a debug info retriever. */
611 void be_set_debug_retrieve(retrieve_dbg_func func) {
612         retrieve_dbg = func;
613 }
614
615 /* Retrieve the debug info. */
616 const char *be_retrieve_dbg_info(const dbg_info *dbg, unsigned *line) {
617         if (retrieve_dbg)
618                 return retrieve_dbg(dbg, line);
619         *line = 0;
620         return NULL;
621 }