485b87f6d4b520af2d6c8e1705cb776de5a1877d
[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 #include <stdio.h>
13
14 #ifdef WITH_LIBCORE
15 #include <libcore/lc_opts.h>
16 #include <libcore/lc_opts_enum.h>
17 #include <libcore/lc_timing.h>
18 #endif /* WITH_LIBCORE */
19
20 #include "obst.h"
21 #include "bitset.h"
22
23 #include "irprog.h"
24 #include "irgopt.h"
25 #include "irgraph.h"
26 #include "irdump.h"
27 #include "phiclass.h"
28 #include "irdom_t.h"
29 #include "iredges_t.h"
30 #include "irloop_t.h"
31 #include "irtools.h"
32 #include "irvrfy.h"
33 #include "irprintf.h"
34 #include "return.h"
35 #include "firmstat.h"
36 #include "cfopt.h"
37 #include "execfreq.h"
38
39 #include "bearch.h"
40 #include "firm/bearch_firm.h"
41 #include "ia32/bearch_ia32.h"
42 #include "arm/bearch_arm.h"
43 #include "ppc32/bearch_ppc32.h"
44 #include "mips/bearch_mips.h"
45 // #include "sta/bearch_sta.h"
46
47 #include "be_t.h"
48 #include "benumb_t.h"
49 #include "beutil.h"
50 #include "benode_t.h"
51 #include "beirgmod.h"
52 #include "besched_t.h"
53 #include "belistsched.h"
54 #include "belive_t.h"
55 #include "bespillbelady.h"
56 #include "bera.h"
57 #include "beraextern.h"
58 #include "bechordal_t.h"
59 #include "beifg.h"
60 #include "beifg_impl.h"
61 #include "becopyopt.h"
62 #include "becopystat.h"
63 #include "bessadestr.h"
64 #include "beabi.h"
65 #include "belower.h"
66 #include "beschedmris.h"
67 #include "bestat.h"
68 #include "beverify.h"
69 #include "beprofile.h"
70 #include "beblocksched.h"
71 #include "be_dbgout.h"
72
73 #ifdef WITH_ILP
74 #include "beilpsched.h"
75 #endif /* WITH_ILP */
76
77 /* options visible for anyone */
78 static be_options_t be_options = {
79         DUMP_NONE,                         /* dump flags */
80         BE_TIME_OFF,                       /* no timing */
81         0,                                 /* no opt profile */
82         1,                                 /* try to omit frame pointer */
83         0,                                 /* always stabs debugging output */
84         BE_VRFY_WARN,                      /* verification level: warn */
85         BE_SCHED_LIST,                     /* scheduler: list scheduler */
86         "i44pc52.info.uni-karlsruhe.de",   /* ilp server */
87         "cplex"                            /* ilp solver */
88 };
89
90 /* config file. */
91 static char config_file[256] = { 0 };
92
93 /* register allocator to use. */
94 static const be_ra_t *ra = &be_ra_chordal_allocator;
95
96 /* back end instruction set architecture to use */
97 static const arch_isa_if_t *isa_if = &ia32_isa_if;
98
99 #ifdef WITH_LIBCORE
100
101 static lc_opt_entry_t *be_grp_root = NULL;
102
103 /* possible dumping options */
104 static const lc_opt_enum_mask_items_t dump_items[] = {
105         { "none",       DUMP_NONE },
106         { "initial",    DUMP_INITIAL },
107         { "abi",        DUMP_ABI    },
108         { "sched",      DUMP_SCHED  },
109         { "prepared",   DUMP_PREPARED },
110         { "regalloc",   DUMP_RA },
111         { "final",      DUMP_FINAL },
112         { "be",         DUMP_BE },
113         { "all",        2 * DUMP_BE - 1 },
114         { NULL,         0 }
115 };
116
117 /* register allocators */
118 static const lc_opt_enum_const_ptr_items_t ra_items[] = {
119         { "chordal",  &be_ra_chordal_allocator },
120         { "external", &be_ra_external_allocator },
121         { NULL,      NULL }
122 };
123
124 /* instruction set architectures. */
125 static const lc_opt_enum_const_ptr_items_t isa_items[] = {
126         { "ia32",    &ia32_isa_if },
127 #if 0
128         { "sta",     &sta_isa_if },
129         { "arm",     &arm_isa_if },
130         { "ppc32",   &ppc32_isa_if },
131         { "mips",    &mips_isa_if },
132 #endif
133         { NULL,      NULL }
134 };
135
136 /* verify options. */
137 static const lc_opt_enum_int_items_t vrfy_items[] = {
138         { "off",    BE_VRFY_OFF    },
139         { "warn",   BE_VRFY_WARN   },
140         { "assert", BE_VRFY_ASSERT },
141         { NULL,     0 }
142 };
143
144 /* scheduling options. */
145 static const lc_opt_enum_int_items_t sched_items[] = {
146         { "list", BE_SCHED_LIST },
147 #ifdef WITH_ILP
148         { "ilp",  BE_SCHED_ILP  },
149 #endif /* WITH_ILP */
150         { NULL,   0 }
151 };
152
153 static lc_opt_enum_mask_var_t dump_var = {
154         &be_options.dump_flags, dump_items
155 };
156
157 static lc_opt_enum_const_ptr_var_t ra_var = {
158         (const void **) &ra, ra_items
159 };
160
161 static lc_opt_enum_const_ptr_var_t isa_var = {
162         (const void **) &isa_if, isa_items
163 };
164
165 static lc_opt_enum_int_var_t vrfy_var = {
166         &be_options.vrfy_option, vrfy_items
167 };
168
169 static lc_opt_enum_int_var_t sched_var = {
170         &be_options.scheduler, sched_items
171 };
172
173 static const lc_opt_table_entry_t be_main_options[] = {
174         LC_OPT_ENT_STR      ("config",   "read another config file containing backend options", config_file, sizeof(config_file)),
175         LC_OPT_ENT_ENUM_MASK("dump",     "dump irg on several occasions",                       &dump_var),
176         LC_OPT_ENT_ENUM_PTR ("ra",       "register allocator",                                  &ra_var),
177         LC_OPT_ENT_ENUM_PTR ("isa",      "the instruction set architecture",                    &isa_var),
178         LC_OPT_ENT_NEGBOOL  ("noomitfp", "do not omit frame pointer",                           &be_options.omit_fp),
179         LC_OPT_ENT_BOOL     ("stabs",    "enable stabs debug support",                          &be_options.stabs_debug_support),
180         LC_OPT_ENT_ENUM_PTR ("vrfy",     "verify the backend irg",                              &vrfy_var),
181         LC_OPT_ENT_BOOL     ("time",     "get backend timing statistics",                       &be_options.timing),
182         LC_OPT_ENT_BOOL     ("profile",  "instrument the code for execution count profiling",   &be_options.opt_profile),
183         LC_OPT_ENT_ENUM_PTR ("sched",    "select a scheduler",                                  &sched_var),
184         LC_OPT_ENT_STR      ("statfile", "append statistics to file statfile", &be_options.stat_file_name, sizeof(be_options.stat_file_name)),
185
186 #ifdef WITH_ILP
187         LC_OPT_ENT_STR ("ilp.server", "the ilp server name", be_options.ilp_server, sizeof(be_options.ilp_server)),
188         LC_OPT_ENT_STR ("ilp.solver", "the ilp solver name", be_options.ilp_solver, sizeof(be_options.ilp_solver)),
189 #endif /* WITH_ILP */
190         { NULL }
191 };
192
193 #endif /* WITH_LIBCORE */
194
195 void be_opt_register(void)
196 {
197 #ifdef WITH_LIBCORE
198         int i;
199         lc_opt_entry_t *be_grp_ra;
200         static int run_once = 0;
201
202         if (! run_once) {
203                 run_once     = 1;
204                 be_grp_root  = lc_opt_get_grp(firm_opt_get_root(), "be");
205                 be_grp_ra    = lc_opt_get_grp(be_grp_root, "ra");
206
207                 lc_opt_add_table(be_grp_root, be_main_options);
208
209                 /* register allocator options */
210                 for(i = 0; ra_items[i].name != NULL; ++i) {
211                         const be_ra_t *ra = ra_items[i].value;
212                         ra->register_options(be_grp_ra);
213                 }
214
215                 /* register isa options */
216                 for(i = 0; isa_items[i].name != NULL; ++i) {
217                         const arch_isa_if_t *isa = isa_items[i].value;
218                         isa->register_options(be_grp_root);
219                 }
220
221                 /* list scheduler register options */
222                 list_sched_register_options(be_grp_root);
223
224 #ifdef WITH_ILP
225                 /* ilp scheduler register options */
226                 ilpsched_register_options(be_grp_root);
227 #endif /* WITH_ILP */
228
229                 be_block_schedule_register_options(be_grp_root);
230         }
231 #endif /* WITH_LIBCORE */
232 }
233
234 /* Parse one argument. */
235 int be_parse_arg(const char *arg) {
236 #ifdef WITH_LIBCORE
237         if (strcmp(arg, "help") == 0 || (arg[0] == '?' && arg[1] == '\0')) {
238                 lc_opt_print_help(be_grp_root, stdout);
239                 return -1;
240         }
241         return lc_opt_from_single_arg(be_grp_root, NULL, arg, NULL);
242 #else
243         return 0;
244 #endif /* WITH_LIBCORE */
245 }
246
247 /** The be parameters returned by default, all off. */
248 const static backend_params be_params = {
249         NULL,
250         NULL,
251         0,
252         NULL,
253 };
254
255 /* Perform schedule verification if requested. */
256 static void be_sched_vrfy(ir_graph *irg, int vrfy_opt) {
257         if (vrfy_opt == BE_VRFY_WARN) {
258                 be_verify_schedule(irg);
259         }
260         else if (vrfy_opt == BE_VRFY_ASSERT) {
261                 assert(be_verify_schedule(irg) && "Schedule verification failed.");
262         }
263 }
264
265 /* Initialize the Firm backend. Must be run BEFORE init_firm()! */
266 const backend_params *be_init(void)
267 {
268         be_opt_register();
269
270         be_sched_init();
271         be_numbering_init();
272         be_copy_opt_init();
273         copystat_init();
274         phi_class_init();
275
276         if (isa_if->get_params)
277                 return isa_if->get_params();
278         return &be_params;
279 }
280
281 /**
282  * Initializes the main environment for the backend.
283  *
284  * @param env          an empty environment
285  * @param file_handle  the file handle where the output will be written to
286  */
287 static be_main_env_t *be_init_env(be_main_env_t *env, FILE *file_handle)
288 {
289         memset(env, 0, sizeof(*env));
290         obstack_init(&env->obst);
291         env->arch_env = obstack_alloc(&env->obst, sizeof(env->arch_env[0]));
292         env->options  = &be_options;
293         FIRM_DBG_REGISTER(env->dbg, "be.main");
294
295         arch_env_init(env->arch_env, isa_if, file_handle, env);
296
297         /* Register the irn handler of the architecture */
298         if (arch_isa_get_irn_handler(env->arch_env->isa))
299                 arch_env_push_irn_handler(env->arch_env, arch_isa_get_irn_handler(env->arch_env->isa));
300
301         /*
302          * Register the node handler of the back end infrastructure.
303          * This irn handler takes care of the platform independent
304          * spill, reload and perm nodes.
305          */
306         arch_env_push_irn_handler(env->arch_env, &be_node_irn_handler);
307         env->phi_handler = be_phi_handler_new(env->arch_env);
308         arch_env_push_irn_handler(env->arch_env, env->phi_handler);
309
310         env->db_handle = be_options.stabs_debug_support ? be_stabs_open(file_handle) : be_nulldbg_open();
311         return env;
312 }
313
314 static void be_done_env(be_main_env_t *env)
315 {
316         env->arch_env->isa->impl->done(env->arch_env->isa);
317         be_dbg_close(env->db_handle);
318         be_phi_handler_free(env->phi_handler);
319         obstack_free(&env->obst, NULL);
320 }
321
322 /**
323  * A wrapper around a firm dumper. Dumps only, if
324  * flags are enabled.
325  *
326  * @param mask    a bitmask containing the reason what will be dumped
327  * @param irg     the IR graph to dump
328  * @param suffix  the suffix for the dumper
329  * @param dumper  the dumper to be called
330  */
331 static void dump(int mask, ir_graph *irg, const char *suffix,
332                  void (*dumper)(ir_graph *, const char *))
333 {
334         if(be_options.dump_flags & mask)
335                 be_dump(irg, suffix, dumper);
336 }
337
338 /**
339  * Prepare a backend graph for code generation and initialize its birg
340  */
341 static void initialize_birg(be_irg_t *birg, ir_graph *irg, be_main_env_t *env)
342 {
343         memset(birg, 0, sizeof(*birg));
344         birg->irg = irg;
345         birg->main_env = env;
346
347         edges_deactivate_kind(irg, EDGE_KIND_DEP);
348         edges_activate_kind(irg, EDGE_KIND_DEP);
349
350         DBG((env->dbg, LEVEL_2, "====> IRG: %F\n", irg));
351         dump(DUMP_INITIAL, irg, "-begin", dump_ir_block_graph);
352
353         be_stat_init_irg(env->arch_env, irg);
354         be_do_stat_nodes(irg, "01 Begin");
355
356         /* set the current graph (this is important for several firm functions) */
357         current_ir_graph = irg;
358
359         /* Normalize proj nodes. */
360         normalize_proj_nodes(irg);
361
362         /* Make just one return node. */
363         normalize_one_return(irg);
364
365         /* Remove critical edges */
366         remove_critical_cf_edges(irg);
367
368         /* Ensure, that the ir_edges are computed. */
369         edges_assure(irg);
370
371         /* reset the phi handler. */
372         be_phi_handler_reset(env->phi_handler);
373 }
374
375 #ifdef WITH_LIBCORE
376
377 #define BE_TIMER_PUSH(timer)                                                        \
378         if (be_options.timing == BE_TIME_ON) {                                          \
379                 int res = lc_timer_push(timer);                                             \
380                 if (be_options.vrfy_option == BE_VRFY_ASSERT)                               \
381                         assert(res && "Timer already on stack, cannot be pushed twice.");       \
382                 else if (be_options.vrfy_option == BE_VRFY_WARN && ! res)                   \
383                         fprintf(stderr, "Timer %s already on stack, cannot be pushed twice.\n", \
384                                 lc_timer_get_name(timer));                                          \
385         }
386 #define BE_TIMER_POP(timer)                                                                    \
387         if (be_options.timing == BE_TIME_ON) {                                                     \
388                 lc_timer_t *tmp = lc_timer_pop();                                                      \
389                 if (be_options.vrfy_option == BE_VRFY_ASSERT)                                          \
390                         assert(tmp == timer && "Attempt to pop wrong timer.");                             \
391                 else if (be_options.vrfy_option == BE_VRFY_WARN && tmp != timer)                       \
392                         fprintf(stderr, "Attempt to pop wrong timer. %s is on stack, trying to pop %s.\n", \
393                                 lc_timer_get_name(tmp), lc_timer_get_name(timer));                             \
394                 timer = tmp;                                                                           \
395         }
396
397 #define BE_TIMER_ONLY(code)   do { if (be_options.timing == BE_TIME_ON) { code; } } while(0)
398
399 #else
400
401 #define BE_TIMER_PUSH(timer)
402 #define BE_TIMER_POP(timer)
403 #define BE_TIMER_ONLY(code)
404
405 #endif /* WITH_LIBCORE */
406
407
408 /**
409  * The Firm backend main loop.
410  * Do architecture specific lowering for all graphs
411  * and call the architecture specific code generator.
412  *
413  * @param file_handle   the file handle the output will be written to
414  * @param cup_name      name of the compilation unit
415  */
416 static void be_main_loop(FILE *file_handle, const char *cup_name)
417 {
418         int i;
419         arch_isa_t *isa;
420         be_main_env_t env;
421         unsigned num_nodes_b = 0;
422         unsigned num_nodes_a = 0;
423         unsigned num_nodes_r = 0;
424         char prof_filename[256];
425         static const char suffix[] = ".prof";
426         be_irg_t *birgs;
427         unsigned num_birgs;
428
429         be_ra_timer_t *ra_timer;
430
431 #ifdef WITH_LIBCORE
432         lc_timer_t *t_abi      = NULL;
433         lc_timer_t *t_codegen  = NULL;
434         lc_timer_t *t_sched    = NULL;
435         lc_timer_t *t_constr   = NULL;
436         lc_timer_t *t_regalloc = NULL;
437         lc_timer_t *t_finish   = NULL;
438         lc_timer_t *t_emit     = NULL;
439         lc_timer_t *t_other    = NULL;
440         lc_timer_t *t_verify   = NULL;
441
442         if (be_options.timing == BE_TIME_ON) {
443                 t_abi      = lc_timer_register("beabi",    "be abi introduction");
444                 t_codegen  = lc_timer_register("codegen",  "codegeneration");
445                 t_sched    = lc_timer_register("sched",    "scheduling");
446                 t_constr   = lc_timer_register("constr",   "assure constraints");
447                 t_regalloc = lc_timer_register("regalloc", "register allocation");
448                 t_finish   = lc_timer_register("finish",   "graph finish");
449                 t_emit     = lc_timer_register("emiter",   "code emiter");
450                 t_verify   = lc_timer_register("verify",   "graph verification");
451                 t_other    = lc_timer_register("other",    "other");
452         }
453 #endif /* WITH_LIBCORE */
454
455         be_init_env(&env, file_handle);
456
457         isa = arch_env_get_isa(env.arch_env);
458
459         be_dbg_so(env.db_handle, cup_name);
460         be_dbg_types(env.db_handle);
461
462         /* we might need 1 birg more for instrumentation constructor */
463         num_birgs = get_irp_n_irgs();
464         birgs     = alloca(sizeof(birgs[0]) * (num_birgs + 1));
465
466         /* First: initialize all birgs */
467         for(i = 0; i < get_irp_n_irgs(); ++i) {
468                 ir_graph *irg = get_irp_irg(i);
469
470                 initialize_birg(&birgs[i], irg, &env);
471         }
472
473         /*
474                 Get the filename for the profiling data.
475                 Beware: '\0' is already included in sizeof(suffix)
476         */
477         memset(prof_filename, 0, sizeof(prof_filename));
478         strncpy(prof_filename, cup_name, sizeof(prof_filename) - sizeof(suffix));
479         strcat(prof_filename, suffix);
480
481         /*
482                 Next: Either instruments all irgs with profiling code
483                 or try to read in profile data for current translation unit.
484         */
485         if (be_options.opt_profile) {
486                 ir_graph *prof_init_irg = be_profile_instrument(prof_filename, profile_default);
487                 initialize_birg(&birgs[num_birgs], prof_init_irg, &env);
488                 num_birgs++;
489                 set_method_img_section(get_irg_entity(prof_init_irg), section_constructors);
490         }
491         else {
492                 be_profile_read(prof_filename);
493         }
494
495         /* For all graphs */
496         for (i = 0; i < num_birgs; ++i) {
497                 be_irg_t *birg = & birgs[i];
498                 ir_graph *irg  = birg->irg;
499                 optimization_state_t state;
500                 const arch_code_generator_if_t *cg_if;
501                 char irg_name[128];
502
503                 /* set the current graph (this is important for several firm functions) */
504                 current_ir_graph = irg;
505
506 #ifdef FIRM_STATISTICS
507                 if(be_stat_ev_is_active()) {
508                         ir_snprintf(irg_name, sizeof(irg_name), "%F", irg);
509                         be_stat_tags[STAT_TAG_CLS] = "<all>";
510                         be_stat_tags[STAT_TAG_IRG] = irg_name;
511                         be_stat_ev_push(be_stat_tags, STAT_TAG_LAST, be_stat_file);
512                 }
513 #endif
514
515                 /* stop and reset timers */
516                 BE_TIMER_ONLY(
517                         LC_STOP_AND_RESET_TIMER(t_abi);
518                         LC_STOP_AND_RESET_TIMER(t_codegen);
519                         LC_STOP_AND_RESET_TIMER(t_sched);
520                         LC_STOP_AND_RESET_TIMER(t_constr);
521                         LC_STOP_AND_RESET_TIMER(t_regalloc);
522                         LC_STOP_AND_RESET_TIMER(t_finish);
523                         LC_STOP_AND_RESET_TIMER(t_emit);
524                         LC_STOP_AND_RESET_TIMER(t_verify);
525                         LC_STOP_AND_RESET_TIMER(t_other);
526                 );
527                 BE_TIMER_PUSH(t_other);   /* t_other */
528
529                 /* Verify the initial graph */
530                 BE_TIMER_PUSH(t_verify);
531                 if (be_options.vrfy_option == BE_VRFY_WARN) {
532                         irg_verify(irg, VRFY_ENFORCE_SSA);
533                         be_check_dominance(irg);
534                 } else if (be_options.vrfy_option == BE_VRFY_ASSERT) {
535                         assert(irg_verify(irg, VRFY_ENFORCE_SSA) && "irg verification failed");
536                         assert(be_check_dominance(irg) && "Dominance verification failed");
537                 }
538                 BE_TIMER_POP(t_verify);
539
540                 /**
541                  * Create execution frequencies from profile data or estimate some
542                  */
543                 if (be_profile_has_data()) {
544                         birg->exec_freq = be_create_execfreqs_from_profile(irg);
545                 } else {
546                         birg->exec_freq = compute_execfreq(irg, 10);
547                 }
548
549                 BE_TIMER_ONLY(num_nodes_b = get_num_reachable_nodes(irg));
550
551                 /* Get the code generator interface. */
552                 cg_if = isa->impl->get_code_generator_if(isa);
553
554                 /* get a code generator for this graph. */
555                 birg->cg = cg_if->init(birg);
556
557                 /* some transformations need to be done before abi introduce */
558                 arch_code_generator_before_abi(birg->cg);
559
560                 /* reset the phi handler. */
561                 be_phi_handler_reset(env.phi_handler);
562
563                 /* implement the ABI conventions. */
564                 BE_TIMER_PUSH(t_abi);
565                 birg->abi = be_abi_introduce(birg);
566                 BE_TIMER_POP(t_abi);
567
568                 dump(DUMP_ABI, irg, "-abi", dump_ir_block_graph);
569                 be_do_stat_nodes(irg, "02 Abi");
570
571                 /* generate code */
572                 BE_TIMER_PUSH(t_codegen);
573                 arch_code_generator_prepare_graph(birg->cg);
574                 BE_TIMER_POP(t_codegen);
575
576                 be_do_stat_nodes(irg, "03 Prepare");
577
578                 /*
579                         Since the code generator made a lot of new nodes and skipped
580                         a lot of old ones, we should do dead node elimination here.
581                         Note that this requires disabling the edges here.
582                 */
583                 edges_deactivate(irg);
584                 //dead_node_elimination(irg);
585                 edges_activate(irg);
586
587                 /* Compute loop nesting information (for weighting copies) */
588                 construct_cf_backedges(irg);
589                 dump(DUMP_PREPARED, irg, "-prepared", dump_ir_block_graph);
590                 BE_TIMER_ONLY(num_nodes_r = get_num_reachable_nodes(irg));
591
592                 /* let backend prepare scheduling */
593                 BE_TIMER_PUSH(t_codegen);
594                 arch_code_generator_before_sched(birg->cg);
595                 BE_TIMER_POP(t_codegen);
596
597                 /* schedule the irg */
598                 BE_TIMER_PUSH(t_sched);
599                 switch (be_options.scheduler) {
600                         default:
601                                 fprintf(stderr, "Warning: invalid scheduler (%d) selected, falling back to list scheduler.\n", be_options.scheduler);
602                         case BE_SCHED_LIST:
603                                 list_sched(birg, &be_options);
604                                 break;
605 #ifdef WITH_ILP
606                         case BE_SCHED_ILP:
607                                 be_ilp_sched(birg);
608                                 //fprintf(stderr, "Warning: ILP scheduler not yet fully implemented, falling back to list scheduler.\n");
609                                 //list_sched(birg, &be_options);
610                                 break;
611 #endif /* WITH_ILP */
612                 };
613                 BE_TIMER_POP(t_sched);
614
615                 dump(DUMP_SCHED, irg, "-sched", dump_ir_block_graph_sched);
616
617                 /* check schedule */
618                 BE_TIMER_PUSH(t_verify);
619                 be_sched_vrfy(irg, be_options.vrfy_option);
620                 BE_TIMER_POP(t_verify);
621
622                 be_do_stat_nodes(irg, "04 Schedule");
623
624                 /* introduce patterns to assure constraints */
625                 BE_TIMER_PUSH(t_constr);
626                 /* we switch off optimizations here, because they might cause trouble */
627                 save_optimization_state(&state);
628                 set_optimize(0);
629                 set_opt_normalize(0);
630
631                 /* add Keeps for should_be_different constrained nodes  */
632                 /* beware: needs schedule due to usage of be_ssa_constr */
633                 assure_constraints(birg);
634                 BE_TIMER_POP(t_constr);
635
636                 dump(DUMP_SCHED, irg, "-assured", dump_ir_block_graph_sched);
637                 be_do_stat_nodes(irg, "05 Constraints");
638
639                 /* connect all stack modifying nodes together (see beabi.c) */
640                 BE_TIMER_PUSH(t_abi);
641                 be_abi_fix_stack_nodes(birg->abi, NULL);
642                 BE_TIMER_POP(t_abi);
643
644                 dump(DUMP_SCHED, irg, "-fix_stack", dump_ir_block_graph_sched);
645
646                 /* check schedule */
647                 BE_TIMER_PUSH(t_verify);
648                 be_sched_vrfy(irg, be_options.vrfy_option);
649                 BE_TIMER_POP(t_verify);
650
651                 /* do some statistics */
652                 be_do_stat_reg_pressure(birg);
653
654                 /* stuff needs to be done after scheduling but before register allocation */
655                 BE_TIMER_PUSH(t_codegen);
656                 arch_code_generator_before_ra(birg->cg);
657                 BE_TIMER_POP(t_codegen);
658
659 #ifdef FIRM_STATISTICS
660                 if(be_stat_ev_is_active()) {
661                         be_stat_ev_l("costs_before_ra",
662                                         (long) be_estimate_irg_costs(irg, env.arch_env, birg->exec_freq));
663                 }
664 #endif
665
666                 /* Do register allocation */
667                 BE_TIMER_PUSH(t_regalloc);
668                 ra_timer = ra->allocate(birg);
669                 BE_TIMER_POP(t_regalloc);
670
671 #ifdef FIRM_STATISTICS
672                 if(be_stat_ev_is_active()) {
673                         be_stat_ev_l("costs_after_ra",
674                                         (long) be_estimate_irg_costs(irg, env.arch_env, birg->exec_freq));
675                 }
676 #endif
677
678                 dump(DUMP_RA, irg, "-ra", dump_ir_block_graph_sched);
679                 be_do_stat_nodes(irg, "06 Register Allocation");
680
681                 /* let the code generator prepare the graph for emitter */
682                 BE_TIMER_PUSH(t_finish);
683                 arch_code_generator_after_ra(birg->cg);
684                 BE_TIMER_POP(t_finish);
685
686                 /* fix stack offsets */
687                 BE_TIMER_PUSH(t_abi);
688                 be_abi_fix_stack_nodes(birg->abi, NULL);
689                 be_remove_dead_nodes_from_schedule(irg);
690                 be_abi_fix_stack_bias(birg->abi);
691                 BE_TIMER_POP(t_abi);
692
693                 BE_TIMER_PUSH(t_finish);
694                 arch_code_generator_finish(birg->cg);
695                 BE_TIMER_POP(t_finish);
696
697                 dump(DUMP_FINAL, irg, "-finish", dump_ir_block_graph_sched);
698
699                 /* check schedule and register allocation */
700                 BE_TIMER_PUSH(t_verify);
701                 if (be_options.vrfy_option == BE_VRFY_WARN) {
702                         //irg_verify(irg, VRFY_ENFORCE_SSA);
703                         be_check_dominance(irg);
704                         be_verify_out_edges(irg);
705                         be_verify_schedule(irg);
706                         be_verify_register_allocation(env.arch_env, irg);
707                 }
708                 else if (be_options.vrfy_option == BE_VRFY_ASSERT) {
709                         //assert(irg_verify(irg, VRFY_ENFORCE_SSA) && "irg verification failed");
710                         assert(be_verify_out_edges(irg));
711                         assert(be_check_dominance(irg) && "Dominance verification failed");
712                         assert(be_verify_schedule(irg) && "Schedule verification failed");
713                         assert(be_verify_register_allocation(env.arch_env, irg)
714                                && "register allocation verification failed");
715                 }
716                 BE_TIMER_POP(t_verify);
717
718                 /* emit assembler code */
719                 BE_TIMER_PUSH(t_emit);
720                 arch_code_generator_done(birg->cg);
721                 BE_TIMER_POP(t_emit);
722
723                 dump(DUMP_FINAL, irg, "-end", dump_ir_extblock_graph_sched);
724
725                 BE_TIMER_PUSH(t_abi);
726                 be_abi_free(birg->abi);
727                 BE_TIMER_POP(t_abi);
728
729                 be_do_stat_nodes(irg, "07 Final");
730                 restore_optimization_state(&state);
731
732                 BE_TIMER_ONLY(num_nodes_a = get_num_reachable_nodes(irg));
733                 BE_TIMER_POP(t_other);
734
735 #define LC_EMIT(timer)  \
736         if(!be_stat_ev_is_active()) { \
737                 printf("%-20s: %.3lf msec\n", lc_timer_get_description(timer), (double)lc_timer_elapsed_usec(timer) / 1000.0); \
738         } else { \
739                 be_stat_ev_l(lc_timer_get_name(timer), lc_timer_elapsed_msec(timer)); \
740         }
741 #define LC_EMIT_RA(timer) \
742         if(!be_stat_ev_is_active()) { \
743                 printf("\t%-20s: %.3lf msec\n", lc_timer_get_description(timer), (double)lc_timer_elapsed_usec(timer) / 1000.0); \
744         } else { \
745                 be_stat_ev_l(lc_timer_get_name(timer), lc_timer_elapsed_msec(timer)); \
746         }
747                 BE_TIMER_ONLY(
748                         if(!be_stat_ev_is_active()) {
749                                 printf("==>> IRG %s <<==\n", get_entity_name(get_irg_entity(irg)));
750                                 printf("# nodes at begin:  %u\n", num_nodes_b);
751                                 printf("# nodes before ra: %u\n", num_nodes_r);
752                                 printf("# nodes at end:    %u\n\n", num_nodes_a);
753                         }
754                         LC_EMIT(t_abi);
755                         LC_EMIT(t_codegen);
756                         LC_EMIT(t_sched);
757                         LC_EMIT(t_constr);
758                         LC_EMIT(t_regalloc);
759                         LC_EMIT_RA(ra_timer->t_prolog);
760                         LC_EMIT_RA(ra_timer->t_live);
761                         LC_EMIT_RA(ra_timer->t_spill);
762                         LC_EMIT_RA(ra_timer->t_spillslots);
763                         LC_EMIT_RA(ra_timer->t_color);
764                         LC_EMIT_RA(ra_timer->t_ifg);
765                         LC_EMIT_RA(ra_timer->t_copymin);
766                         LC_EMIT_RA(ra_timer->t_ssa);
767                         LC_EMIT_RA(ra_timer->t_epilog);
768                         LC_EMIT_RA(ra_timer->t_verify);
769                         LC_EMIT_RA(ra_timer->t_other);
770                         LC_EMIT(t_finish);
771                         LC_EMIT(t_emit);
772                         LC_EMIT(t_verify);
773                         LC_EMIT(t_other);
774                 );
775 #undef LC_EMIT_RA
776 #undef LC_EMIT
777
778                 free_execfreq(birg->exec_freq);
779                 birg->exec_freq = NULL;
780
781                 if(birg->dom_front != NULL) {
782                         be_free_dominance_frontiers(birg->dom_front);
783                         birg->dom_front = NULL;
784                 }
785                 if(birg->lv != NULL) {
786                         be_liveness_free(birg->lv);
787                         birg->lv = NULL;
788                 }
789
790         /* switched off due to statistics (statistic module needs all irgs) */
791 #ifdef FIRM_STATISTICS
792                 if (! stat_is_active())
793 #endif
794                         free_ir_graph(irg);
795
796                 if(be_stat_ev_is_active()) {
797                         be_stat_ev_pop();
798                 }
799         }
800         be_profile_free();
801         be_done_env(&env);
802
803 #undef BE_TIMER_POP
804 #undef BE_TIMER_PUSH
805 #undef BE_TIMER_ONLY
806 }
807
808 /* Main interface to the frontend. */
809 void be_main(FILE *file_handle, const char *cup_name)
810 {
811 #ifdef WITH_LIBCORE
812         lc_timer_t *t = NULL;
813
814         /* The user specified another config file to read. do that now. */
815         if(strlen(config_file) > 0) {
816                 FILE *f;
817
818                 if((f = fopen(config_file, "rt")) != NULL) {
819                         lc_opt_from_file(config_file, f, NULL);
820                         fclose(f);
821                 }
822         }
823
824         if (be_options.timing == BE_TIME_ON) {
825                 t = lc_timer_register("bemain", "measure complete bemain loop");
826
827                 if (lc_timer_enter_high_priority()) {
828                         fprintf(stderr, "Warning: Could not enter high priority mode.\n");
829                 }
830
831                 lc_timer_reset_and_start(t);
832         }
833
834 #ifdef FIRM_STATISTICS
835         be_init_stat_file(be_options.stat_file_name, cup_name);
836 #endif
837 #endif /* WITH_LIBCORE */
838
839         /* never build code for pseudo irgs */
840         set_visit_pseudo_irgs(0);
841
842         be_node_init();
843
844         be_main_loop(file_handle, cup_name);
845
846 #ifdef WITH_LIBCORE
847         if (be_options.timing == BE_TIME_ON) {
848                 lc_timer_stop(t);
849                 lc_timer_leave_high_priority();
850                 if(be_stat_ev_is_active()) {
851                         be_stat_ev_l("backend_time", lc_timer_elapsed_msec(t));
852                 } else {
853                         printf("%-20s: %lu msec\n", "BEMAINLOOP", lc_timer_elapsed_msec(t));
854                 }
855         }
856
857 #ifdef FIRM_STATISTICS
858         be_close_stat_file();
859 #endif
860 #endif /* WITH_LIBCORE */
861 }
862
863 /** The debug info retriever function. */
864 static retrieve_dbg_func retrieve_dbg = NULL;
865
866 /* Sets a debug info retriever. */
867 void be_set_debug_retrieve(retrieve_dbg_func func) {
868         retrieve_dbg = func;
869 }
870
871 /* Retrieve the debug info. */
872 const char *be_retrieve_dbg_info(const dbg_info *dbg, unsigned *line) {
873         if (retrieve_dbg)
874                 return retrieve_dbg(dbg, line);
875
876         *line = 0;
877         return NULL;
878 }
879
880 int be_put_ignore_regs(const be_irg_t *birg, const arch_register_class_t *cls, bitset_t *bs)
881 {
882         if(bs == NULL)
883                 bs = bitset_alloca(cls->n_regs);
884         else
885                 bitset_clear_all(bs);
886
887         assert(bitset_size(bs) == (unsigned) cls->n_regs);
888         arch_put_non_ignore_regs(birg->main_env->arch_env, cls, bs);
889         bitset_flip_all(bs);
890         be_abi_put_ignore_regs(birg->abi, cls, bs);
891
892         return bitset_popcnt(bs);
893 }
894
895 void be_assure_liveness(be_irg_t *birg)
896 {
897         if(birg->lv != NULL)
898                 return;
899
900         birg->lv = be_liveness(birg->irg);
901 }
902
903 void be_invalidate_liveness(be_irg_t *birg)
904 {
905         if(birg->lv == NULL)
906                 return;
907
908         be_liveness_free(birg->lv);
909         birg->lv = NULL;
910 }
911
912 void be_assure_dom_front(be_irg_t *birg)
913 {
914         if(birg->dom_front != NULL)
915                 return;
916
917         birg->dom_front = be_compute_dominance_frontiers(birg->irg);
918 }
919
920 void be_invalidate_dom_front(be_irg_t *birg)
921 {
922         if(birg->dom_front == NULL)
923                 return;
924
925         be_free_dominance_frontiers(birg->dom_front);
926         birg->dom_front = NULL;
927 }