Added function firm_be_finish.
[libfirm] / ir / be / bemain.c
1 /*
2  * Copyright (C) 1995-2008 University of Karlsruhe.  All right reserved.
3  *
4  * This file is part of libFirm.
5  *
6  * This file may be distributed and/or modified under the terms of the
7  * GNU General Public License version 2 as published by the Free Software
8  * Foundation and appearing in the file LICENSE.GPL included in the
9  * packaging of this file.
10  *
11  * Licensees holding valid libFirm Professional Edition licenses may use
12  * this file in accordance with the libFirm Commercial License.
13  * Agreement provided with the Software.
14  *
15  * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
16  * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
17  * PURPOSE.
18  */
19
20 /**
21  * @file
22  * @brief       Main Backend driver.
23  * @author      Sebastian Hack
24  * @date        25.11.2004
25  * @version     $Id$
26  */
27 #ifdef HAVE_CONFIG_H
28 #include "config.h"
29 #endif
30
31 #include <stdarg.h>
32 #include <stdio.h>
33
34 #include "lc_opts.h"
35 #include "lc_opts_enum.h"
36
37 #include "obst.h"
38 #include "bitset.h"
39
40 #include "irprog.h"
41 #include "irgopt.h"
42 #include "irgraph.h"
43 #include "irdump.h"
44 #include "phiclass.h"
45 #include "irdom_t.h"
46 #include "iredges_t.h"
47 #include "irloop_t.h"
48 #include "irtools.h"
49 #include "irvrfy.h"
50 #include "irprintf.h"
51 #include "iroptimize.h"
52 #include "firmstat.h"
53 #include "execfreq.h"
54 #include "irprofile.h"
55
56 #include "bearch_t.h"
57 #include "be_t.h"
58 #include "bemodule.h"
59 #include "beutil.h"
60 #include "benode_t.h"
61 #include "beirgmod.h"
62 #include "besched_t.h"
63 #include "belistsched.h"
64 #include "belive_t.h"
65 #include "bera.h"
66 #include "bechordal_t.h"
67 #include "beifg.h"
68 #include "beifg_impl.h"
69 #include "becopyopt.h"
70 #include "becopystat.h"
71 #include "bessadestr.h"
72 #include "beabi.h"
73 #include "belower.h"
74 #include "beschedmris.h"
75 #include "bestat.h"
76 #include "beverify.h"
77 #include "be_dbgout.h"
78 #include "beirg_t.h"
79
80 #define NEW_ID(s) new_id_from_chars(s, sizeof(s) - 1)
81
82 #ifdef WITH_ILP
83 #include "beilpsched.h"
84 #endif /* WITH_ILP */
85
86 /* options visible for anyone */
87 static be_options_t be_options = {
88         DUMP_NONE,                         /* dump flags */
89         BE_TIME_OFF,                       /* no timing */
90         0,                                 /* no opt profile */
91         0,                                 /* try to omit frame pointer */
92         0,                                 /* try to omit leaf frame pointer */
93         0,                                 /* create PIC code */
94         0,                                 /* create gprof compatible profiling code */
95         BE_VRFY_WARN,                      /* verification level: warn */
96         BE_SCHED_LIST,                     /* scheduler: list scheduler */
97         "linux",                           /* target OS name */
98         "i44pc52.info.uni-karlsruhe.de",   /* ilp server */
99         "cplex",                           /* ilp solver */
100         0,                                 /* enable statistic event dumping */
101         "",                                /* print stat events */
102 };
103
104 /* config file. */
105 static char config_file[256] = { 0 };
106
107 /* back end instruction set architecture to use */
108 static const arch_isa_if_t *isa_if = NULL;
109
110 /* possible dumping options */
111 static const lc_opt_enum_mask_items_t dump_items[] = {
112         { "none",       DUMP_NONE },
113         { "initial",    DUMP_INITIAL },
114         { "abi",        DUMP_ABI    },
115         { "sched",      DUMP_SCHED  },
116         { "prepared",   DUMP_PREPARED },
117         { "regalloc",   DUMP_RA },
118         { "final",      DUMP_FINAL },
119         { "be",         DUMP_BE },
120         { "all",        2 * DUMP_BE - 1 },
121         { NULL,         0 }
122 };
123
124 /* verify options. */
125 static const lc_opt_enum_int_items_t vrfy_items[] = {
126         { "off",    BE_VRFY_OFF    },
127         { "warn",   BE_VRFY_WARN   },
128         { "assert", BE_VRFY_ASSERT },
129         { NULL,     0 }
130 };
131
132 /* scheduling options. */
133 static const lc_opt_enum_int_items_t sched_items[] = {
134         { "list", BE_SCHED_LIST },
135 #ifdef WITH_ILP
136         { "ilp",  BE_SCHED_ILP  },
137 #endif /* WITH_ILP */
138         { NULL,   0 }
139 };
140
141 static lc_opt_enum_mask_var_t dump_var = {
142         &be_options.dump_flags, dump_items
143 };
144
145 static lc_opt_enum_int_var_t vrfy_var = {
146         &be_options.vrfy_option, vrfy_items
147 };
148
149 static lc_opt_enum_int_var_t sched_var = {
150         &be_options.scheduler, sched_items
151 };
152
153 static const lc_opt_table_entry_t be_main_options[] = {
154         LC_OPT_ENT_STR      ("config",     "read another config file containing backend options", config_file, sizeof(config_file)),
155         LC_OPT_ENT_ENUM_MASK("dump",       "dump irg on several occasions",                       &dump_var),
156         LC_OPT_ENT_BOOL     ("omitfp",     "omit frame pointer",                                  &be_options.omit_fp),
157         LC_OPT_ENT_BOOL     ("omitleaffp", "omit frame pointer in leaf routines",                 &be_options.omit_leaf_fp),
158         LC_OPT_ENT_BOOL     ("pic",        "create PIC code",                                     &be_options.pic),
159         LC_OPT_ENT_BOOL     ("gprof",      "create gprof profiling code",                         &be_options.gprof),
160         LC_OPT_ENT_ENUM_PTR ("vrfy",       "verify the backend irg",                              &vrfy_var),
161         LC_OPT_ENT_BOOL     ("time",       "get backend timing statistics",                       &be_options.timing),
162         LC_OPT_ENT_BOOL     ("profile",    "instrument the code for execution count profiling",   &be_options.opt_profile),
163         LC_OPT_ENT_ENUM_PTR ("sched",      "select a scheduler",                                  &sched_var),
164         LC_OPT_ENT_STR      ("os",         "specify target operating system",                     &be_options.target_os, sizeof(be_options.target_os)),
165 #ifdef FIRM_STATISTICS
166         LC_OPT_ENT_BOOL     ("statev",     "dump statistic events",                               &be_options.statev),
167         LC_OPT_ENT_STR      ("filtev",     "filter for stat events (regex if support is active",  &be_options.filtev, sizeof(be_options.filtev)),
168 #endif
169
170 #ifdef WITH_ILP
171         LC_OPT_ENT_STR ("ilp.server", "the ilp server name", be_options.ilp_server, sizeof(be_options.ilp_server)),
172         LC_OPT_ENT_STR ("ilp.solver", "the ilp solver name", be_options.ilp_solver, sizeof(be_options.ilp_solver)),
173 #endif /* WITH_ILP */
174         LC_OPT_LAST
175 };
176
177 static be_module_list_entry_t *isa_ifs = NULL;
178
179
180 unsigned short asm_constraint_flags[256];
181
182 void be_init_default_asm_constraint_flags(void)
183 {
184         asm_constraint_flags['?'] = ASM_CONSTRAINT_FLAG_NO_SUPPORT;
185         asm_constraint_flags['!'] = ASM_CONSTRAINT_FLAG_NO_SUPPORT;
186         asm_constraint_flags['&'] = ASM_CONSTRAINT_FLAG_NO_SUPPORT
187                 | ASM_CONSTRAINT_FLAG_MODIFIER_EARLYCLOBBER;
188         asm_constraint_flags['%'] = ASM_CONSTRAINT_FLAG_NO_SUPPORT
189                 | ASM_CONSTRAINT_FLAG_MODIFIER_COMMUTATIVE;
190         asm_constraint_flags['!'] = ASM_CONSTRAINT_FLAG_NO_SUPPORT;
191
192         asm_constraint_flags['='] = ASM_CONSTRAINT_FLAG_MODIFIER_WRITE
193                 | ASM_CONSTRAINT_FLAG_MODIFIER_NO_READ;
194         asm_constraint_flags['+'] = ASM_CONSTRAINT_FLAG_MODIFIER_READ
195                 | ASM_CONSTRAINT_FLAG_MODIFIER_WRITE;
196
197         asm_constraint_flags['i'] = ASM_CONSTRAINT_FLAG_SUPPORTS_IMMEDIATE;
198         asm_constraint_flags['s'] = ASM_CONSTRAINT_FLAG_SUPPORTS_IMMEDIATE;
199         asm_constraint_flags['E'] = ASM_CONSTRAINT_FLAG_SUPPORTS_IMMEDIATE;
200         asm_constraint_flags['F'] = ASM_CONSTRAINT_FLAG_SUPPORTS_IMMEDIATE;
201         asm_constraint_flags['G'] = ASM_CONSTRAINT_FLAG_SUPPORTS_IMMEDIATE;
202         asm_constraint_flags['H'] = ASM_CONSTRAINT_FLAG_SUPPORTS_IMMEDIATE;
203         asm_constraint_flags['I'] = ASM_CONSTRAINT_FLAG_SUPPORTS_IMMEDIATE;
204         asm_constraint_flags['J'] = ASM_CONSTRAINT_FLAG_SUPPORTS_IMMEDIATE;
205         asm_constraint_flags['K'] = ASM_CONSTRAINT_FLAG_SUPPORTS_IMMEDIATE;
206         asm_constraint_flags['L'] = ASM_CONSTRAINT_FLAG_SUPPORTS_IMMEDIATE;
207         asm_constraint_flags['M'] = ASM_CONSTRAINT_FLAG_SUPPORTS_IMMEDIATE;
208         asm_constraint_flags['N'] = ASM_CONSTRAINT_FLAG_SUPPORTS_IMMEDIATE;
209         asm_constraint_flags['O'] = ASM_CONSTRAINT_FLAG_SUPPORTS_IMMEDIATE;
210         asm_constraint_flags['P'] = ASM_CONSTRAINT_FLAG_SUPPORTS_IMMEDIATE;
211
212         asm_constraint_flags['m'] = ASM_CONSTRAINT_FLAG_SUPPORTS_MEMOP;
213         asm_constraint_flags['o'] = ASM_CONSTRAINT_FLAG_SUPPORTS_MEMOP;
214         asm_constraint_flags['V'] = ASM_CONSTRAINT_FLAG_SUPPORTS_MEMOP;
215         asm_constraint_flags['<'] = ASM_CONSTRAINT_FLAG_SUPPORTS_MEMOP;
216         asm_constraint_flags['>'] = ASM_CONSTRAINT_FLAG_SUPPORTS_MEMOP;
217
218         asm_constraint_flags['p'] = ASM_CONSTRAINT_FLAG_SUPPORTS_REGISTER;
219         asm_constraint_flags['0'] = ASM_CONSTRAINT_FLAG_SUPPORTS_REGISTER;
220         asm_constraint_flags['1'] = ASM_CONSTRAINT_FLAG_SUPPORTS_REGISTER;
221         asm_constraint_flags['2'] = ASM_CONSTRAINT_FLAG_SUPPORTS_REGISTER;
222         asm_constraint_flags['3'] = ASM_CONSTRAINT_FLAG_SUPPORTS_REGISTER;
223         asm_constraint_flags['4'] = ASM_CONSTRAINT_FLAG_SUPPORTS_REGISTER;
224         asm_constraint_flags['5'] = ASM_CONSTRAINT_FLAG_SUPPORTS_REGISTER;
225         asm_constraint_flags['6'] = ASM_CONSTRAINT_FLAG_SUPPORTS_REGISTER;
226         asm_constraint_flags['7'] = ASM_CONSTRAINT_FLAG_SUPPORTS_REGISTER;
227         asm_constraint_flags['8'] = ASM_CONSTRAINT_FLAG_SUPPORTS_REGISTER;
228         asm_constraint_flags['9'] = ASM_CONSTRAINT_FLAG_SUPPORTS_REGISTER;
229
230         asm_constraint_flags['X'] = ASM_CONSTRAINT_FLAG_SUPPORTS_REGISTER
231                 | ASM_CONSTRAINT_FLAG_SUPPORTS_MEMOP
232                 | ASM_CONSTRAINT_FLAG_SUPPORTS_IMMEDIATE;
233
234         /* these should have been catched by the parsing code already */
235         asm_constraint_flags['#']  = ASM_CONSTRAINT_FLAG_NO_SUPPORT;
236         asm_constraint_flags['*']  = ASM_CONSTRAINT_FLAG_NO_SUPPORT;
237         asm_constraint_flags[' ']  = ASM_CONSTRAINT_FLAG_NO_SUPPORT;
238         asm_constraint_flags['\t'] = ASM_CONSTRAINT_FLAG_NO_SUPPORT;
239         asm_constraint_flags['\n'] = ASM_CONSTRAINT_FLAG_NO_SUPPORT;
240         asm_constraint_flags['\r'] = ASM_CONSTRAINT_FLAG_NO_SUPPORT;
241 }
242
243 asm_constraint_flags_t be_parse_asm_constraints(const char *constraint)
244 {
245         asm_constraint_flags_t  flags = 0;
246         const char             *c;
247         asm_constraint_flags_t  tflags;
248
249         for (c = constraint; *c != '\0'; ++c) {
250                 switch (*c) {
251                 case '#':
252                         /* 'comment' stuff */
253                         while(*c != 0 && *c != ',')
254                                 ++c;
255                         break;
256                 case '*':
257                         /* 'comment' character */
258                         ++c;
259                         break;
260                 case ' ':
261                 case '\t':
262                 case '\n':
263                 case '\r':
264                         break;
265                 default:
266                         tflags = asm_constraint_flags[(int) *c];
267                         if (tflags != 0) {
268                                 flags |= tflags;
269                         } else {
270                                 flags |= isa_if->parse_asm_constraint(isa_if, &c);
271                         }
272                         break;
273                 }
274         }
275
276         if ( ((flags & ASM_CONSTRAINT_FLAG_MODIFIER_WRITE)
277                         && (flags & ASM_CONSTRAINT_FLAG_MODIFIER_NO_WRITE))
278                 || ((flags & ASM_CONSTRAINT_FLAG_MODIFIER_READ
279                         && (flags & ASM_CONSTRAINT_FLAG_MODIFIER_NO_READ)))) {
280                 flags |= ASM_CONSTRAINT_FLAG_INVALID;
281         }
282         if (! (flags & (ASM_CONSTRAINT_FLAG_MODIFIER_READ
283                                         | ASM_CONSTRAINT_FLAG_MODIFIER_WRITE
284                                         | ASM_CONSTRAINT_FLAG_MODIFIER_NO_WRITE
285                                         | ASM_CONSTRAINT_FLAG_MODIFIER_NO_READ))) {
286                 flags |= ASM_CONSTRAINT_FLAG_MODIFIER_READ;
287         }
288
289         return flags;
290 }
291
292 bool be_is_valid_clobber(const char *clobber)
293 {
294         /* memory is a valid clobber. (the frontend has to detect this case too,
295          * because it has to add memory edges to the asm) */
296         if (strcmp(clobber, "memory") == 0)
297                 return true;
298         /* cc (condition code) is always valid */
299         if (strcmp(clobber, "cc") == 0)
300                 return true;
301
302         return isa_if->is_valid_clobber(isa_if, clobber);
303 }
304
305 void be_register_isa_if(const char *name, const arch_isa_if_t *isa)
306 {
307         if (isa_if == NULL)
308                 isa_if = isa;
309
310         be_add_module_to_list(&isa_ifs, name, (void*) isa);
311 }
312
313 void be_opt_register(void)
314 {
315         lc_opt_entry_t *be_grp;
316         static int run_once = 0;
317
318         if (run_once) {
319                 return;
320         }
321         run_once     = 1;
322
323         be_init_modules();
324
325         be_grp = lc_opt_get_grp(firm_opt_get_root(), "be");
326         lc_opt_add_table(be_grp, be_main_options);
327
328         be_add_module_list_opt(be_grp, "isa", "the instruction set architecture",
329                                &isa_ifs, (void**) &isa_if);
330 }
331
332 /* Parse one argument. */
333 int be_parse_arg(const char *arg) {
334         lc_opt_entry_t *be_grp = lc_opt_get_grp(firm_opt_get_root(), "be");
335         if (strcmp(arg, "help") == 0 || (arg[0] == '?' && arg[1] == '\0')) {
336                 lc_opt_print_help(be_grp, stdout);
337                 return -1;
338         }
339         return lc_opt_from_single_arg(be_grp, NULL, arg, NULL);
340 }
341
342 /** The be parameters returned by default, all off. */
343 static const backend_params be_params = {
344         0,    /* need dword lowering */
345         0,    /* don't support inline assembler yet */
346         0,     /* no immediate floating point mode. */
347         NULL, /* no additional opcodes */
348         NULL, /* will be set later */
349         NULL, /* but yet no creator function */
350         NULL, /* context for create_intrinsic_fkt */
351         NULL, /* no if conversion settings */
352         NULL   /* no immediate fp mode */
353 };
354
355 /* Perform schedule verification if requested. */
356 static void be_sched_vrfy(be_irg_t *birg, int vrfy_opt) {
357         if (vrfy_opt == BE_VRFY_WARN) {
358                 be_verify_schedule(birg);
359         } else if (vrfy_opt == BE_VRFY_ASSERT) {
360                 assert(be_verify_schedule(birg) && "Schedule verification failed.");
361         }
362 }
363
364 /* Initialize the Firm backend. Must be run first in init_firm()! */
365 void firm_be_init(void)
366 {
367         be_opt_register();
368         be_init_modules();
369 }
370
371 /* Finalize the Firm backend. */
372 void firm_be_finish(void)
373 {
374         be_quit_modules();
375 }
376
377 /* Returns the backend parameter */
378 const backend_params *be_get_backend_param(void)
379 {
380         if (isa_if->get_params)
381                 return isa_if->get_params();
382         return &be_params;
383 }
384
385 /**
386  * Initializes the main environment for the backend.
387  *
388  * @param env          an empty environment
389  * @param file_handle  the file handle where the output will be written to
390  */
391 static be_main_env_t *be_init_env(be_main_env_t *env, FILE *file_handle)
392 {
393         memset(env, 0, sizeof(*env));
394         env->options              = &be_options;
395         env->ent_trampoline_map   = pmap_create();
396         env->pic_trampolines_type = new_type_class(NEW_ID("$PIC_TRAMPOLINE_TYPE"));
397         env->ent_pic_symbol_map   = pmap_create();
398         env->pic_symbols_type     = new_type_struct(NEW_ID("$PIC_SYMBOLS_TYPE"));
399
400         remove_irp_type(env->pic_trampolines_type);
401         remove_irp_type(env->pic_symbols_type);
402         set_class_final(env->pic_trampolines_type, 1);
403
404         memset(asm_constraint_flags, 0, sizeof(asm_constraint_flags));
405         env->arch_env = arch_env_init(isa_if, file_handle, env);
406
407         be_phi_handler_new(env);
408
409         be_dbg_open();
410         return env;
411 }
412
413 /**
414  * Called when the be_main_env_t can be destroyed.
415  */
416 static void be_done_env(be_main_env_t *env)
417 {
418         arch_env_done(env->arch_env);
419         be_dbg_close();
420         be_phi_handler_free();
421
422         pmap_destroy(env->ent_trampoline_map);
423         pmap_destroy(env->ent_pic_symbol_map);
424         free_type(env->pic_trampolines_type);
425         free_type(env->pic_symbols_type);
426 }
427
428 /**
429  * A wrapper around a firm dumper. Dumps only, if
430  * flags are enabled.
431  *
432  * @param mask    a bitmask containing the reason what will be dumped
433  * @param irg     the IR graph to dump
434  * @param suffix  the suffix for the dumper
435  * @param dumper  the dumper to be called
436  */
437 static void dump(int mask, ir_graph *irg, const char *suffix,
438                  void (*dumper)(ir_graph *, const char *))
439 {
440         if(be_options.dump_flags & mask)
441                 be_dump(irg, suffix, dumper);
442 }
443
444 /**
445  * Prepare a backend graph for code generation and initialize its birg
446  */
447 static void initialize_birg(be_irg_t *birg, ir_graph *irg, be_main_env_t *env)
448 {
449         memset(birg, 0, sizeof(*birg));
450         birg->irg = irg;
451         birg->main_env = env;
452
453         edges_deactivate_kind(irg, EDGE_KIND_DEP);
454         edges_activate_kind(irg, EDGE_KIND_DEP);
455
456         dump(DUMP_INITIAL, irg, "-begin", dump_ir_block_graph);
457
458         be_stat_init_irg(env->arch_env, irg);
459         be_do_stat_nodes(irg, "01 Begin");
460
461         /* set the current graph (this is important for several firm functions) */
462         current_ir_graph = irg;
463
464         /* Normalize proj nodes. */
465         normalize_proj_nodes(irg);
466
467         /* we do this before critical edge split. As this produces less returns,
468            because sometimes (= 164.gzip) multiple returns are slower */
469         normalize_n_returns(irg);
470
471         /* Remove critical edges */
472         remove_critical_cf_edges_ex(irg, /*ignore_exception_edges=*/0);
473
474         /* Ensure, that the ir_edges are computed. */
475         edges_assure(irg);
476
477         set_irg_phase_state(irg, phase_backend);
478
479         dump(DUMP_INITIAL, irg, "-prepared", dump_ir_block_graph);
480 }
481
482 #define BE_TIMER_ONLY(code)   do { if (be_timing) { code; } } while(0)
483
484 int be_timing;
485 ir_timer_t *t_abi;
486 ir_timer_t *t_codegen;
487 ir_timer_t *t_sched;
488 ir_timer_t *t_constr;
489 ir_timer_t *t_finish;
490 ir_timer_t *t_emit;
491 ir_timer_t *t_other;
492 ir_timer_t *t_verify;
493 ir_timer_t *t_heights;
494 ir_timer_t *t_live;
495 ir_timer_t *t_execfreq;
496 ir_timer_t *t_ssa_constr;
497 ir_timer_t *t_ra_constr;
498 ir_timer_t *t_ra_prolog;
499 ir_timer_t *t_ra_epilog;
500 ir_timer_t *t_ra_spill;
501 ir_timer_t *t_ra_spill_apply;
502 ir_timer_t *t_ra_color;
503 ir_timer_t *t_ra_ifg;
504 ir_timer_t *t_ra_copymin;
505 ir_timer_t *t_ra_ssa;
506 ir_timer_t *t_ra_other;
507
508 /**
509  * The Firm backend main loop.
510  * Do architecture specific lowering for all graphs
511  * and call the architecture specific code generator.
512  *
513  * @param file_handle   the file handle the output will be written to
514  * @param cup_name      name of the compilation unit
515  */
516 static void be_main_loop(FILE *file_handle, const char *cup_name)
517 {
518         int i;
519         be_main_env_t env;
520         char prof_filename[256];
521         static const char suffix[] = ".prof";
522         be_irg_t *birgs;
523         int num_birgs;
524         ir_graph **irg_list, **backend_irg_list;
525         arch_env_t *arch_env;
526
527         be_timing = (be_options.timing == BE_TIME_ON);
528
529         if (be_timing) {
530                 t_abi        = ir_timer_register("time_beabi",       "be abi introduction");
531                 t_codegen    = ir_timer_register("time_codegen",     "codegeneration");
532                 t_sched      = ir_timer_register("time_sched",       "scheduling");
533                 t_constr     = ir_timer_register("time_constr",      "assure constraints");
534                 t_finish     = ir_timer_register("time_finish",      "graph finish");
535                 t_emit       = ir_timer_register("time_emiter",      "code emiter");
536                 t_verify     = ir_timer_register("time_verify",      "graph verification");
537                 t_other      = ir_timer_register("time_other",       "other");
538                 t_heights    = ir_timer_register("time_heights",     "heights");
539                 t_live       = ir_timer_register("time_liveness",    "be liveness");
540                 t_execfreq   = ir_timer_register("time_execfreq",    "execfreq");
541                 t_ssa_constr = ir_timer_register("time_ssa_constr",  "ssa reconstruction");
542                 t_ra_prolog  = ir_timer_register("time_ra_prolog",   "regalloc prolog");
543                 t_ra_epilog  = ir_timer_register("time_ra_epilog",   "regalloc epilog");
544                 t_ra_constr  = ir_timer_register("time_ra_constr",   "regalloc constraints");
545                 t_ra_spill   = ir_timer_register("time_ra_spill",    "spiller");
546                 t_ra_spill_apply
547                         = ir_timer_register("time_ra_spill_apply", "apply spills");
548                 t_ra_color   = ir_timer_register("time_ra_color",    "graph coloring");
549                 t_ra_ifg     = ir_timer_register("time_ra_ifg",      "interference graph");
550                 t_ra_copymin = ir_timer_register("time_ra_copymin",  "copy minimization");
551                 t_ra_ssa     = ir_timer_register("time_ra_ssadestr", "ssa destruction");
552                 t_ra_other   = ir_timer_register("time_ra_other",    "regalloc other");
553         }
554
555         be_init_env(&env, file_handle);
556         env.cup_name = cup_name;
557
558         be_dbg_so(cup_name);
559         be_dbg_types();
560
561         arch_env = env.arch_env;
562
563         /* backend may provide an ordered list of irgs where code should be generated for */
564         irg_list         = NEW_ARR_F(ir_graph *, 0);
565         backend_irg_list = arch_env_get_backend_irg_list(arch_env, &irg_list);
566
567         /* we might need 1 birg more for instrumentation constructor */
568         num_birgs = backend_irg_list ? ARR_LEN(backend_irg_list) : get_irp_n_irgs();
569         birgs     = alloca(sizeof(birgs[0]) * (num_birgs + 1));
570
571         /* First: initialize all birgs */
572         for(i = 0; i < num_birgs; ++i) {
573                 ir_graph *irg = backend_irg_list ? backend_irg_list[i] : get_irp_irg(i);
574                 initialize_birg(&birgs[i], irg, &env);
575         }
576         DEL_ARR_F(irg_list);
577
578         /*
579                 Get the filename for the profiling data.
580                 Beware: '\0' is already included in sizeof(suffix)
581         */
582         memset(prof_filename, 0, sizeof(prof_filename));
583         strncpy(prof_filename, cup_name, sizeof(prof_filename) - sizeof(suffix));
584         strcat(prof_filename, suffix);
585
586         /*
587                 Next: Either instruments all irgs with profiling code
588                 or try to read in profile data for current translation unit.
589         */
590         if (be_options.opt_profile) {
591                 ir_graph *prof_init_irg = ir_profile_instrument(prof_filename, profile_default);
592                 initialize_birg(&birgs[num_birgs], prof_init_irg, &env);
593                 num_birgs++;
594         } else {
595                 ir_profile_read(prof_filename);
596         }
597
598         /* For all graphs */
599         for (i = 0; i < num_birgs; ++i) {
600                 be_irg_t *birg = &birgs[i];
601                 ir_graph *irg  = birg->irg;
602                 optimization_state_t state;
603                 const arch_code_generator_if_t *cg_if;
604
605                 /* set the current graph (this is important for several firm functions) */
606                 current_ir_graph = irg;
607
608 #if 0
609                 {
610                         unsigned percent = 100*i/num_birgs;
611                         ir_printf("%u.%02u %+F\n", percent/100, percent%100, irg);
612                 }
613 #endif
614                 be_sched_init_phase(irg);
615
616                 /* reset the phi handler. */
617                 be_phi_handler_reset();
618
619                 stat_ev_ctx_push_fobj("bemain_irg", irg);
620
621                 /* stop and reset timers */
622                 BE_TIMER_PUSH(t_other);   /* t_other */
623
624                 /* Verify the initial graph */
625                 BE_TIMER_PUSH(t_verify);
626                 if (be_options.vrfy_option == BE_VRFY_WARN) {
627                         irg_verify(irg, VRFY_ENFORCE_SSA);
628                         be_check_dominance(irg);
629                 } else if (be_options.vrfy_option == BE_VRFY_ASSERT) {
630                         assert(irg_verify(irg, VRFY_ENFORCE_SSA) && "irg verification failed");
631                         assert(be_check_dominance(irg) && "Dominance verification failed");
632                 }
633                 BE_TIMER_POP(t_verify);
634
635                 /* Get the code generator interface. */
636                 cg_if = arch_env_get_code_generator_if(arch_env);
637
638                 /* get a code generator for this graph. */
639                 birg->cg = cg_if->init(birg);
640
641                 /* some transformations need to be done before abi introduce */
642                 arch_code_generator_before_abi(birg->cg);
643
644                 /* implement the ABI conventions. */
645                 BE_TIMER_PUSH(t_abi);
646                 birg->abi = be_abi_introduce(birg);
647                 BE_TIMER_POP(t_abi);
648
649                 dump(DUMP_ABI, irg, "-abi", dump_ir_block_graph);
650                 be_do_stat_nodes(irg, "02 Abi");
651
652                 if (be_options.vrfy_option == BE_VRFY_WARN) {
653                         be_check_dominance(irg);
654                         be_verify_out_edges(irg);
655                 } else if (be_options.vrfy_option == BE_VRFY_ASSERT) {
656                         assert(be_verify_out_edges(irg));
657                         assert(be_check_dominance(irg) && "Dominance verification failed");
658                 }
659
660                 /* generate code */
661                 stat_ev_ctx_push_str("bemain_phase", "prepare");
662                 BE_TIMER_PUSH(t_codegen);
663                 arch_code_generator_prepare_graph(birg->cg);
664                 BE_TIMER_POP(t_codegen);
665                 stat_ev_ctx_pop("bemain_phase");
666
667                 /* reset the phi handler. */
668                 be_phi_handler_reset();
669
670                 be_do_stat_nodes(irg, "03 Prepare");
671
672                 dump(DUMP_PREPARED, irg, "-prepared", dump_ir_block_graph);
673
674                 if (be_options.vrfy_option == BE_VRFY_WARN) {
675                         be_check_dominance(irg);
676                         be_verify_out_edges(irg);
677                 } else if (be_options.vrfy_option == BE_VRFY_ASSERT) {
678                         assert(be_verify_out_edges(irg));
679                         assert(be_check_dominance(irg) && "Dominance verification failed");
680                 }
681
682                 BE_TIMER_PUSH(t_execfreq);
683                 /**
684                  * Create execution frequencies from profile data or estimate some
685                  */
686                 if (ir_profile_has_data())
687                         birg->exec_freq = ir_create_execfreqs_from_profile(irg);
688                 else
689                         birg->exec_freq = compute_execfreq(irg, 10);
690                 BE_TIMER_POP(t_execfreq);
691
692
693                 /* disabled for now, fails for EmptyFor.c and XXEndless.c */
694                 /* be_live_chk_compare(birg); */
695
696                 /* let backend prepare scheduling */
697                 stat_ev_ctx_push_str("bemain_phase", "before_sched");
698                 BE_TIMER_PUSH(t_codegen);
699                 arch_code_generator_before_sched(birg->cg);
700                 BE_TIMER_POP(t_codegen);
701                 stat_ev_ctx_pop("bemain_phase");
702
703                 /* schedule the irg */
704                 BE_TIMER_PUSH(t_sched);
705                 switch (be_options.scheduler) {
706                         default:
707                                 fprintf(stderr, "Warning: invalid scheduler (%d) selected, falling back to list scheduler.\n", be_options.scheduler);
708                         case BE_SCHED_LIST:
709                                 list_sched(birg, &be_options);
710                                 break;
711 #ifdef WITH_ILP
712                         case BE_SCHED_ILP:
713                                 be_ilp_sched(birg, &be_options);
714                                 break;
715 #endif /* WITH_ILP */
716                 };
717                 BE_TIMER_POP(t_sched);
718
719                 dump(DUMP_SCHED, irg, "-sched", dump_ir_block_graph_sched);
720
721                 /* check schedule */
722                 BE_TIMER_PUSH(t_verify);
723                 be_sched_vrfy(birg, be_options.vrfy_option);
724                 BE_TIMER_POP(t_verify);
725
726                 be_do_stat_nodes(irg, "04 Schedule");
727
728                 /* introduce patterns to assure constraints */
729                 BE_TIMER_PUSH(t_constr);
730                 /* we switch off optimizations here, because they might cause trouble */
731                 save_optimization_state(&state);
732                 set_optimize(0);
733                 set_opt_normalize(0);
734                 set_opt_cse(0);
735
736                 assert(!get_opt_cse());
737
738                 /* add Keeps for should_be_different constrained nodes  */
739                 /* beware: needs schedule due to usage of be_ssa_constr */
740                 assure_constraints(birg);
741                 BE_TIMER_POP(t_constr);
742
743                 dump(DUMP_SCHED, irg, "-assured", dump_ir_block_graph_sched);
744                 be_do_stat_nodes(irg, "05 Constraints");
745
746                 /* stuff needs to be done after scheduling but before register allocation */
747                 BE_TIMER_PUSH(t_codegen);
748                 arch_code_generator_before_ra(birg->cg);
749                 BE_TIMER_POP(t_codegen);
750
751                 /* connect all stack modifying nodes together (see beabi.c) */
752                 BE_TIMER_PUSH(t_abi);
753                 be_abi_fix_stack_nodes(birg->abi);
754                 BE_TIMER_POP(t_abi);
755
756                 dump(DUMP_SCHED, irg, "-fix_stack", dump_ir_block_graph_sched);
757
758                 /* check schedule */
759                 BE_TIMER_PUSH(t_verify);
760                 be_sched_vrfy(birg, be_options.vrfy_option);
761                 BE_TIMER_POP(t_verify);
762
763                 /* do some statistics */
764                 //be_do_stat_reg_pressure(birg);
765
766 #ifdef FIRM_STATISTICS
767                 stat_ev_dbl("costs_before_ra", be_estimate_irg_costs(irg, arch_env, birg->exec_freq));
768 #endif
769
770                 /* Do register allocation */
771                 be_allocate_registers(birg);
772
773 #ifdef FIRM_STATISTICS
774                 stat_ev_dbl("costs_before_ra", be_estimate_irg_costs(irg, arch_env, birg->exec_freq));
775 #endif
776
777                 dump(DUMP_RA, irg, "-ra", dump_ir_block_graph_sched);
778                 be_do_stat_nodes(irg, "06 Register Allocation");
779
780                 /* let the code generator prepare the graph for emitter */
781                 BE_TIMER_PUSH(t_finish);
782                 arch_code_generator_after_ra(birg->cg);
783                 BE_TIMER_POP(t_finish);
784
785                 /* fix stack offsets */
786                 BE_TIMER_PUSH(t_abi);
787                 be_abi_fix_stack_nodes(birg->abi);
788                 be_remove_dead_nodes_from_schedule(birg);
789                 be_abi_fix_stack_bias(birg->abi);
790                 BE_TIMER_POP(t_abi);
791
792                 dump(DUMP_SCHED, irg, "-fix_stack_after_ra", dump_ir_block_graph_sched);
793
794                 BE_TIMER_PUSH(t_finish);
795                 arch_code_generator_finish(birg->cg);
796                 BE_TIMER_POP(t_finish);
797
798                 dump(DUMP_FINAL, irg, "-finish", dump_ir_block_graph_sched);
799
800                 /* check schedule and register allocation */
801                 BE_TIMER_PUSH(t_verify);
802                 if (be_options.vrfy_option == BE_VRFY_WARN) {
803                         irg_verify(irg, VRFY_ENFORCE_SSA);
804                         be_check_dominance(irg);
805                         be_verify_out_edges(irg);
806                         be_verify_schedule(birg);
807                         be_verify_register_allocation(birg);
808                 } else if (be_options.vrfy_option == BE_VRFY_ASSERT) {
809                         assert(irg_verify(irg, VRFY_ENFORCE_SSA) && "irg verification failed");
810                         assert(be_verify_out_edges(irg) && "out edge verification failed");
811                         assert(be_check_dominance(irg) && "Dominance verification failed");
812                         assert(be_verify_schedule(birg) && "Schedule verification failed");
813                         assert(be_verify_register_allocation(birg)
814                                && "register allocation verification failed");
815
816                 }
817                 BE_TIMER_POP(t_verify);
818
819                 /* emit assembler code */
820                 BE_TIMER_PUSH(t_emit);
821                 arch_code_generator_done(birg->cg);
822                 BE_TIMER_POP(t_emit);
823
824                 dump(DUMP_FINAL, irg, "-end", dump_ir_block_graph_sched);
825
826                 BE_TIMER_PUSH(t_abi);
827                 be_abi_free(birg->abi);
828                 BE_TIMER_POP(t_abi);
829
830                 be_do_stat_nodes(irg, "07 Final");
831                 restore_optimization_state(&state);
832
833                 BE_TIMER_POP(t_other);
834
835 #define STOP_AND_RESET_TIMER(timer) do { ir_timer_stop(timer); ir_timer_reset(timer); } while(0)
836
837 #define LC_EMIT(timer)  \
838                 stat_ev_if {    \
839                         stat_ev_dbl(ir_timer_get_name(timer), ir_timer_elapsed_msec(timer));  \
840                 } else { \
841                         printf("%-20s: %8.3lf msec\n", ir_timer_get_description(timer), (double)ir_timer_elapsed_usec(timer) / 1000.0); \
842                 } \
843                 STOP_AND_RESET_TIMER(timer);
844
845                 BE_TIMER_ONLY(
846                         stat_ev_if {
847                         } else {
848                                 printf("==>> IRG %s <<==\n", get_entity_name(get_irg_entity(irg)));
849                         }
850                         LC_EMIT(t_abi);
851                         LC_EMIT(t_codegen);
852                         LC_EMIT(t_sched);
853                         LC_EMIT(t_live);
854                         LC_EMIT(t_heights);
855                         LC_EMIT(t_ssa_constr);
856                         LC_EMIT(t_constr);
857                         LC_EMIT(t_execfreq);
858                         LC_EMIT(t_ra_prolog);
859                         LC_EMIT(t_ra_spill);
860                         LC_EMIT(t_ra_spill_apply);
861                         LC_EMIT(t_ra_constr);
862                         LC_EMIT(t_ra_color);
863                         LC_EMIT(t_ra_ifg);
864                         LC_EMIT(t_ra_copymin);
865                         LC_EMIT(t_ra_ssa);
866                         LC_EMIT(t_ra_epilog);
867                         LC_EMIT(t_ra_other);
868                         LC_EMIT(t_finish);
869                         LC_EMIT(t_emit);
870                         LC_EMIT(t_verify);
871                         LC_EMIT(t_other);
872                 );
873 #undef LC_EMIT
874
875                 be_sched_free_phase(irg);
876
877                 be_free_birg(birg);
878
879         /* switched off due to statistics (statistic module needs all irgs) */
880 #if 0   /* STA needs irgs */
881 #ifdef FIRM_STATISTICS
882                 if (! stat_is_active())
883 #endif /* FIRM_STATISTICS */
884                         free_ir_graph(irg);
885 #endif /* if 0 */
886                 stat_ev_ctx_pop("bemain_irg");
887         }
888         ir_profile_free();
889         be_done_env(&env);
890 }
891
892 /* Main interface to the frontend. */
893 void be_main(FILE *file_handle, const char *cup_name)
894 {
895         ir_timer_t *t = NULL;
896
897         /* The user specified another config file to read. do that now. */
898         if(strlen(config_file) > 0) {
899                 FILE *f;
900
901                 if((f = fopen(config_file, "rt")) != NULL) {
902                         lc_opt_from_file(config_file, f, NULL);
903                         fclose(f);
904                 }
905         }
906
907         if (be_options.timing == BE_TIME_ON) {
908                 t = ir_timer_register("bemain", "measure complete bemain loop");
909
910                 if (ir_timer_enter_high_priority()) {
911                         fprintf(stderr, "Warning: Could not enter high priority mode.\n");
912                 }
913
914                 ir_timer_reset_and_start(t);
915         }
916
917 #ifdef FIRM_STATISTICS
918         if (be_options.statev) {
919                 const char *dot = strrchr(cup_name, '.');
920                 const char *pos = dot ? dot : cup_name + strlen(cup_name);
921                 char       *buf = alloca(pos - cup_name + 1);
922                 strncpy(buf, cup_name, pos - cup_name);
923                 buf[pos - cup_name] = '\0';
924
925                 be_options.statev = 1;
926                 stat_ev_begin(buf, be_options.filtev);
927         }
928 #endif
929
930         /* never build code for pseudo irgs */
931         set_visit_pseudo_irgs(0);
932
933         be_node_init();
934
935         be_main_loop(file_handle, cup_name);
936
937         if (be_options.timing == BE_TIME_ON) {
938                 ir_timer_stop(t);
939                 ir_timer_leave_high_priority();
940                 stat_ev_if {
941                         stat_ev_dbl("backend_time", ir_timer_elapsed_msec(t));
942                 } else {
943                         printf("%-20s: %lu msec\n", "BEMAINLOOP", ir_timer_elapsed_msec(t));
944                 }
945         }
946
947 #ifdef FIRM_STATISTICS
948         if (be_options.statev)
949                 stat_ev_end();
950 #endif
951 }
952
953 unsigned be_put_ignore_regs(const be_irg_t *birg, const arch_register_class_t *cls, bitset_t *bs)
954 {
955         if (bs == NULL)
956                 bs = bitset_alloca(cls->n_regs);
957         else
958                 bitset_clear_all(bs);
959
960         assert(bitset_size(bs) == (unsigned)cls->n_regs);
961         arch_put_non_ignore_regs(birg->main_env->arch_env, cls, bs);
962         bitset_flip_all(bs);
963         be_abi_put_ignore_regs(birg->abi, cls, bs);
964
965         return bitset_popcnt(bs);
966 }