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