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