Remove the unused parameter const arch_env_t *env from arch_set_irn_register().
[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 ((
277                 flags & ASM_CONSTRAINT_FLAG_MODIFIER_WRITE &&
278                 flags & ASM_CONSTRAINT_FLAG_MODIFIER_NO_WRITE
279             ) || (
280                 flags & ASM_CONSTRAINT_FLAG_MODIFIER_READ &&
281                 flags & ASM_CONSTRAINT_FLAG_MODIFIER_NO_READ
282             )) {
283                 flags |= ASM_CONSTRAINT_FLAG_INVALID;
284         }
285         if (!(flags & (ASM_CONSTRAINT_FLAG_MODIFIER_READ     |
286                        ASM_CONSTRAINT_FLAG_MODIFIER_WRITE    |
287                        ASM_CONSTRAINT_FLAG_MODIFIER_NO_WRITE |
288                        ASM_CONSTRAINT_FLAG_MODIFIER_NO_READ)
289             )) {
290                 flags |= ASM_CONSTRAINT_FLAG_MODIFIER_READ;
291         }
292
293         return flags;
294 }
295
296 int be_is_valid_clobber(const char *clobber)
297 {
298         /* memory is a valid clobber. (the frontend has to detect this case too,
299          * because it has to add memory edges to the asm) */
300         if (strcmp(clobber, "memory") == 0)
301                 return 1;
302         /* cc (condition code) is always valid */
303         if (strcmp(clobber, "cc") == 0)
304                 return 1;
305
306         return isa_if->is_valid_clobber(isa_if, clobber);
307 }
308
309 void be_register_isa_if(const char *name, const arch_isa_if_t *isa)
310 {
311         if (isa_if == NULL)
312                 isa_if = isa;
313
314         be_add_module_to_list(&isa_ifs, name, (void*) isa);
315 }
316
317 void be_opt_register(void)
318 {
319         lc_opt_entry_t *be_grp;
320         static int run_once = 0;
321
322         if (run_once) {
323                 return;
324         }
325         run_once     = 1;
326
327         be_init_modules();
328
329         be_grp = lc_opt_get_grp(firm_opt_get_root(), "be");
330         lc_opt_add_table(be_grp, be_main_options);
331
332         be_add_module_list_opt(be_grp, "isa", "the instruction set architecture",
333                                &isa_ifs, (void**) &isa_if);
334 }
335
336 /* Parse one argument. */
337 int be_parse_arg(const char *arg) {
338         lc_opt_entry_t *be_grp = lc_opt_get_grp(firm_opt_get_root(), "be");
339         if (strcmp(arg, "help") == 0 || (arg[0] == '?' && arg[1] == '\0')) {
340                 lc_opt_print_help(be_grp, stdout);
341                 return -1;
342         }
343         return lc_opt_from_single_arg(be_grp, NULL, arg, NULL);
344 }
345
346 /** The be parameters returned by default, all off. */
347 static const backend_params be_params = {
348         0,    /* need dword lowering */
349         0,    /* don't support inline assembler yet */
350         0,     /* no immediate floating point mode. */
351         NULL, /* no additional opcodes */
352         NULL, /* will be set later */
353         NULL, /* but yet no creator function */
354         NULL, /* context for create_intrinsic_fkt */
355         NULL, /* no if conversion settings */
356         NULL   /* no immediate fp mode */
357 };
358
359 /* Perform schedule verification if requested. */
360 static void be_sched_vrfy(be_irg_t *birg, int vrfy_opt) {
361         if (vrfy_opt == BE_VRFY_WARN) {
362                 be_verify_schedule(birg);
363         } else if (vrfy_opt == BE_VRFY_ASSERT) {
364                 assert(be_verify_schedule(birg) && "Schedule verification failed.");
365         }
366 }
367
368 /* Initialize the Firm backend. Must be run first in init_firm()! */
369 void firm_be_init(void)
370 {
371         be_opt_register();
372         be_init_modules();
373 }
374
375 /* Finalize the Firm backend. */
376 void firm_be_finish(void)
377 {
378         be_quit_modules();
379 }
380
381 /* Returns the backend parameter */
382 const backend_params *be_get_backend_param(void)
383 {
384         if (isa_if->get_params)
385                 return isa_if->get_params();
386         return &be_params;
387 }
388
389 /**
390  * Initializes the main environment for the backend.
391  *
392  * @param env          an empty environment
393  * @param file_handle  the file handle where the output will be written to
394  */
395 static be_main_env_t *be_init_env(be_main_env_t *env, FILE *file_handle)
396 {
397         memset(env, 0, sizeof(*env));
398         env->options              = &be_options;
399         env->ent_trampoline_map   = pmap_create();
400         env->pic_trampolines_type = new_type_class(NEW_ID("$PIC_TRAMPOLINE_TYPE"));
401         env->ent_pic_symbol_map   = pmap_create();
402         env->pic_symbols_type     = new_type_struct(NEW_ID("$PIC_SYMBOLS_TYPE"));
403
404         remove_irp_type(env->pic_trampolines_type);
405         remove_irp_type(env->pic_symbols_type);
406         set_class_final(env->pic_trampolines_type, 1);
407
408         memset(asm_constraint_flags, 0, sizeof(asm_constraint_flags));
409         env->arch_env = arch_env_init(isa_if, file_handle, env);
410
411         be_phi_handler_new(env);
412
413         be_dbg_open();
414         return env;
415 }
416
417 /**
418  * Called when the be_main_env_t can be destroyed.
419  */
420 static void be_done_env(be_main_env_t *env)
421 {
422         arch_env_done(env->arch_env);
423         be_dbg_close();
424         be_phi_handler_free();
425
426         pmap_destroy(env->ent_trampoline_map);
427         pmap_destroy(env->ent_pic_symbol_map);
428         free_type(env->pic_trampolines_type);
429         free_type(env->pic_symbols_type);
430 }
431
432 /**
433  * A wrapper around a firm dumper. Dumps only, if
434  * flags are enabled.
435  *
436  * @param mask    a bitmask containing the reason what will be dumped
437  * @param irg     the IR graph to dump
438  * @param suffix  the suffix for the dumper
439  * @param dumper  the dumper to be called
440  */
441 static void dump(int mask, ir_graph *irg, const char *suffix,
442                  void (*dumper)(ir_graph *, const char *))
443 {
444         if(be_options.dump_flags & mask)
445                 be_dump(irg, suffix, dumper);
446 }
447
448 /**
449  * Prepare a backend graph for code generation and initialize its birg
450  */
451 static void initialize_birg(be_irg_t *birg, ir_graph *irg, be_main_env_t *env)
452 {
453         memset(birg, 0, sizeof(*birg));
454         birg->irg = irg;
455         birg->main_env = env;
456
457         edges_deactivate_kind(irg, EDGE_KIND_DEP);
458         edges_activate_kind(irg, EDGE_KIND_DEP);
459
460         dump(DUMP_INITIAL, irg, "-begin", dump_ir_block_graph);
461
462         /* set the current graph (this is important for several firm functions) */
463         current_ir_graph = irg;
464
465         /* Normalize proj nodes. */
466         normalize_proj_nodes(irg);
467
468         /* we do this before critical edge split. As this produces less returns,
469            because sometimes (= 164.gzip) multiple returns are slower */
470         normalize_n_returns(irg);
471
472         /* Remove critical edges */
473         remove_critical_cf_edges_ex(irg, /*ignore_exception_edges=*/0);
474
475         /* Ensure, that the ir_edges are computed. */
476         edges_assure(irg);
477
478         set_irg_phase_state(irg, phase_backend);
479
480         dump(DUMP_INITIAL, irg, "-prepared", dump_ir_block_graph);
481 }
482
483 #define BE_TIMER_ONLY(code)   do { if (be_timing) { code; } } while(0)
484
485 int be_timing;
486 ir_timer_t *t_abi;
487 ir_timer_t *t_codegen;
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         int i;
520         be_main_env_t env;
521         char prof_filename[256];
522         static const char suffix[] = ".prof";
523         be_irg_t *birgs;
524         int num_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_sched      = ir_timer_register("bemain_time_sched",       "scheduling");
534                 t_constr     = ir_timer_register("bemain_time_constr",      "assure constraints");
535                 t_finish     = ir_timer_register("bemain_time_finish",      "graph finish");
536                 t_emit       = ir_timer_register("bemain_time_emiter",      "code emiter");
537                 t_verify     = ir_timer_register("bemain_time_verify",      "graph verification");
538                 t_other      = ir_timer_register("bemain_time_other",       "other");
539                 t_heights    = ir_timer_register("bemain_time_heights",     "heights");
540                 t_live       = ir_timer_register("bemain_time_liveness",    "be liveness");
541                 t_execfreq   = ir_timer_register("bemain_time_execfreq",    "execfreq");
542                 t_ssa_constr = ir_timer_register("bemain_time_ssa_constr",  "ssa reconstruction");
543                 t_ra_prolog  = ir_timer_register("bemain_time_ra_prolog",   "regalloc prolog");
544                 t_ra_epilog  = ir_timer_register("bemain_time_ra_epilog",   "regalloc epilog");
545                 t_ra_constr  = ir_timer_register("bemain_time_ra_constr",   "regalloc constraints");
546                 t_ra_spill   = ir_timer_register("bemain_time_ra_spill",    "spiller");
547                 t_ra_spill_apply
548                         = ir_timer_register("bemain_time_ra_spill_apply", "apply spills");
549                 t_ra_color   = ir_timer_register("bemain_time_ra_color",    "graph coloring");
550                 t_ra_ifg     = ir_timer_register("bemain_time_ra_ifg",      "interference graph");
551                 t_ra_copymin = ir_timer_register("bemain_time_ra_copymin",  "copy minimization");
552                 t_ra_ssa     = ir_timer_register("bemain_time_ra_ssadestr", "ssa destruction");
553                 t_ra_other   = ir_timer_register("bemain_time_ra_other",    "regalloc other");
554         }
555
556         be_init_env(&env, file_handle);
557         env.cup_name = cup_name;
558
559         be_dbg_so(cup_name);
560         be_dbg_types();
561
562         arch_env = env.arch_env;
563
564         /* backend may provide an ordered list of irgs where code should be
565          * generated for */
566         irg_list         = NEW_ARR_F(ir_graph *, 0);
567         backend_irg_list = arch_env_get_backend_irg_list(arch_env, &irg_list);
568
569         /* we might need 1 birg more for instrumentation constructor */
570         num_birgs = backend_irg_list ? ARR_LEN(backend_irg_list) : get_irp_n_irgs();
571         birgs     = alloca(sizeof(birgs[0]) * (num_birgs + 1));
572
573         /* First: initialize all birgs */
574         for(i = 0; i < num_birgs; ++i) {
575                 ir_graph *irg = backend_irg_list ? backend_irg_list[i] : get_irp_irg(i);
576                 initialize_birg(&birgs[i], irg, &env);
577         }
578         DEL_ARR_F(irg_list);
579
580         /*
581                 Get the filename for the profiling data.
582                 Beware: '\0' is already included in sizeof(suffix)
583         */
584         memset(prof_filename, 0, sizeof(prof_filename));
585         strncpy(prof_filename, cup_name, sizeof(prof_filename) - sizeof(suffix));
586         strcat(prof_filename, suffix);
587
588         /*
589                 Next: Either instruments all irgs with profiling code
590                 or try to read in profile data for current translation unit.
591         */
592         if (be_options.opt_profile) {
593                 ir_graph *prof_init_irg = ir_profile_instrument(prof_filename, profile_default);
594                 initialize_birg(&birgs[num_birgs], prof_init_irg, &env);
595                 num_birgs++;
596         } else {
597                 ir_profile_read(prof_filename);
598         }
599
600         /* For all graphs */
601         for (i = 0; i < num_birgs; ++i) {
602                 be_irg_t *birg = &birgs[i];
603                 ir_graph *irg  = birg->irg;
604                 optimization_state_t state;
605                 const arch_code_generator_if_t *cg_if;
606
607                 /* set the current graph (this is important for several firm functions) */
608                 current_ir_graph = irg;
609
610                 be_sched_init_phase(irg);
611
612                 /* reset the phi handler. */
613                 be_phi_handler_reset();
614
615                 stat_ev_if {
616                         stat_ev_ctx_push_fobj("bemain_irg", irg);
617                         be_stat_ev("bemain_insns_start", be_count_insns(irg));
618                         be_stat_ev("bemain_blocks_start", be_count_blocks(irg));
619                 }
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
651                 if (be_options.vrfy_option == BE_VRFY_WARN) {
652                         be_check_dominance(irg);
653                         be_verify_out_edges(irg);
654                 } else if (be_options.vrfy_option == BE_VRFY_ASSERT) {
655                         assert(be_verify_out_edges(irg));
656                         assert(be_check_dominance(irg) && "Dominance verification failed");
657                 }
658
659                 /* generate code */
660                 BE_TIMER_PUSH(t_codegen);
661                 arch_code_generator_prepare_graph(birg->cg);
662                 BE_TIMER_POP(t_codegen);
663
664                 /* reset the phi handler. */
665                 be_phi_handler_reset();
666
667                 dump(DUMP_PREPARED, irg, "-prepared", dump_ir_block_graph);
668
669                 if (be_options.vrfy_option == BE_VRFY_WARN) {
670                         be_check_dominance(irg);
671                         be_verify_out_edges(irg);
672                 } else if (be_options.vrfy_option == BE_VRFY_ASSERT) {
673                         assert(be_verify_out_edges(irg));
674                         assert(be_check_dominance(irg) && "Dominance verification failed");
675                 }
676
677                 BE_TIMER_PUSH(t_execfreq);
678                 /**
679                  * Create execution frequencies from profile data or estimate some
680                  */
681                 if (ir_profile_has_data())
682                         birg->exec_freq = ir_create_execfreqs_from_profile(irg);
683                 else {
684                         /* TODO: edges are corrupt for EDGE_KIND_BLOCK after the local
685                          * optimize graph phase merges blocks in the x86 backend */
686                         edges_deactivate(irg);
687                         birg->exec_freq = compute_execfreq(irg, 10);
688                 }
689                 BE_TIMER_POP(t_execfreq);
690
691
692                 /* disabled for now, fails for EmptyFor.c and XXEndless.c */
693                 /* be_live_chk_compare(birg); */
694
695                 /* let backend prepare scheduling */
696                 BE_TIMER_PUSH(t_codegen);
697                 arch_code_generator_before_sched(birg->cg);
698                 BE_TIMER_POP(t_codegen);
699
700                 /* schedule the irg */
701                 BE_TIMER_PUSH(t_sched);
702                 switch (be_options.scheduler) {
703                         default:
704                                 fprintf(stderr, "Warning: invalid scheduler (%d) selected, falling back to list scheduler.\n", be_options.scheduler);
705                         case BE_SCHED_LIST:
706                                 list_sched(birg, &be_options);
707                                 break;
708 #ifdef WITH_ILP
709                         case BE_SCHED_ILP:
710                                 be_ilp_sched(birg, &be_options);
711                                 break;
712 #endif /* WITH_ILP */
713                 };
714                 BE_TIMER_POP(t_sched);
715
716                 dump(DUMP_SCHED, irg, "-sched", dump_ir_block_graph_sched);
717
718                 /* check schedule */
719                 BE_TIMER_PUSH(t_verify);
720                 be_sched_vrfy(birg, be_options.vrfy_option);
721                 BE_TIMER_POP(t_verify);
722
723                 /* introduce patterns to assure constraints */
724                 BE_TIMER_PUSH(t_constr);
725                 /* we switch off optimizations here, because they might cause trouble */
726                 save_optimization_state(&state);
727                 set_optimize(0);
728                 set_opt_normalize(0);
729                 set_opt_cse(0);
730
731                 /* add Keeps for should_be_different constrained nodes  */
732                 /* beware: needs schedule due to usage of be_ssa_constr */
733                 assure_constraints(birg);
734                 BE_TIMER_POP(t_constr);
735
736                 dump(DUMP_SCHED, irg, "-assured", dump_ir_block_graph_sched);
737
738                 /* stuff needs to be done after scheduling but before register allocation */
739                 BE_TIMER_PUSH(t_codegen);
740                 arch_code_generator_before_ra(birg->cg);
741                 BE_TIMER_POP(t_codegen);
742
743                 /* connect all stack modifying nodes together (see beabi.c) */
744                 BE_TIMER_PUSH(t_abi);
745                 be_abi_fix_stack_nodes(birg->abi);
746                 BE_TIMER_POP(t_abi);
747
748                 dump(DUMP_SCHED, irg, "-fix_stack", dump_ir_block_graph_sched);
749
750                 /* check schedule */
751                 BE_TIMER_PUSH(t_verify);
752                 be_sched_vrfy(birg, be_options.vrfy_option);
753                 BE_TIMER_POP(t_verify);
754
755                 stat_ev_if {
756                         stat_ev_dbl("bemain_costs_before_ra",
757                                         be_estimate_irg_costs(irg, arch_env, birg->exec_freq));
758                         be_stat_ev("bemain_insns_before_ra", be_count_insns(irg));
759                         be_stat_ev("bemain_blocks_before_ra", be_count_blocks(irg));
760                 }
761
762                 /* Do register allocation */
763                 be_allocate_registers(birg);
764
765 #ifdef FIRM_STATISTICS
766                 stat_ev_dbl("bemain_costs_before_ra", be_estimate_irg_costs(irg, arch_env, birg->exec_freq));
767 #endif
768
769                 dump(DUMP_RA, irg, "-ra", dump_ir_block_graph_sched);
770
771                 /* let the code generator prepare the graph for emitter */
772                 BE_TIMER_PUSH(t_finish);
773                 arch_code_generator_after_ra(birg->cg);
774                 BE_TIMER_POP(t_finish);
775
776                 /* fix stack offsets */
777                 BE_TIMER_PUSH(t_abi);
778                 be_abi_fix_stack_nodes(birg->abi);
779                 be_remove_dead_nodes_from_schedule(birg);
780                 be_abi_fix_stack_bias(birg->abi);
781                 BE_TIMER_POP(t_abi);
782
783                 dump(DUMP_SCHED, irg, "-fix_stack_after_ra", dump_ir_block_graph_sched);
784
785                 BE_TIMER_PUSH(t_finish);
786                 arch_code_generator_finish(birg->cg);
787                 BE_TIMER_POP(t_finish);
788
789                 dump(DUMP_FINAL, irg, "-finish", dump_ir_block_graph_sched);
790
791                 stat_ev_if {
792                         be_stat_ev("bemain_insns_finish", be_count_insns(irg));
793                         be_stat_ev("bemain_blocks_finish", be_count_blocks(irg));
794                 }
795
796                 /* check schedule and register allocation */
797                 BE_TIMER_PUSH(t_verify);
798                 if (be_options.vrfy_option == BE_VRFY_WARN) {
799                         irg_verify(irg, VRFY_ENFORCE_SSA);
800                         be_check_dominance(irg);
801                         be_verify_out_edges(irg);
802                         be_verify_schedule(birg);
803                         be_verify_register_allocation(birg);
804                 } else if (be_options.vrfy_option == BE_VRFY_ASSERT) {
805                         assert(irg_verify(irg, VRFY_ENFORCE_SSA) && "irg verification failed");
806                         assert(be_verify_out_edges(irg) && "out edge verification failed");
807                         assert(be_check_dominance(irg) && "Dominance verification failed");
808                         assert(be_verify_schedule(birg) && "Schedule verification failed");
809                         assert(be_verify_register_allocation(birg)
810                                && "register allocation verification failed");
811
812                 }
813                 BE_TIMER_POP(t_verify);
814
815                 /* emit assembler code */
816                 BE_TIMER_PUSH(t_emit);
817                 arch_code_generator_done(birg->cg);
818                 BE_TIMER_POP(t_emit);
819
820                 dump(DUMP_FINAL, irg, "-end", dump_ir_block_graph_sched);
821
822                 BE_TIMER_PUSH(t_abi);
823                 be_abi_free(birg->abi);
824                 BE_TIMER_POP(t_abi);
825
826                 restore_optimization_state(&state);
827
828                 BE_TIMER_POP(t_other);
829
830 #define STOP_AND_RESET_TIMER(timer) do { ir_timer_stop(timer); ir_timer_reset(timer); } while(0)
831
832 #define LC_EMIT(timer)  \
833                 stat_ev_if {    \
834                         stat_ev_dbl(ir_timer_get_name(timer), ir_timer_elapsed_msec(timer));  \
835                 } else { \
836                         printf("%-20s: %8.3lf msec\n", ir_timer_get_description(timer), (double)ir_timer_elapsed_usec(timer) / 1000.0); \
837                 } \
838                 STOP_AND_RESET_TIMER(timer);
839
840                 BE_TIMER_ONLY(
841                         stat_ev_if {
842                         } else {
843                                 printf("==>> IRG %s <<==\n", get_entity_name(get_irg_entity(irg)));
844                         }
845                         LC_EMIT(t_abi);
846                         LC_EMIT(t_codegen);
847                         LC_EMIT(t_sched);
848                         LC_EMIT(t_live);
849                         LC_EMIT(t_heights);
850                         LC_EMIT(t_ssa_constr);
851                         LC_EMIT(t_constr);
852                         LC_EMIT(t_execfreq);
853                         LC_EMIT(t_ra_prolog);
854                         LC_EMIT(t_ra_spill);
855                         LC_EMIT(t_ra_spill_apply);
856                         LC_EMIT(t_ra_constr);
857                         LC_EMIT(t_ra_color);
858                         LC_EMIT(t_ra_ifg);
859                         LC_EMIT(t_ra_copymin);
860                         LC_EMIT(t_ra_ssa);
861                         LC_EMIT(t_ra_epilog);
862                         LC_EMIT(t_ra_other);
863                         LC_EMIT(t_finish);
864                         LC_EMIT(t_emit);
865                         LC_EMIT(t_verify);
866                         LC_EMIT(t_other);
867                 );
868 #undef LC_EMIT
869
870                 be_sched_free_phase(irg);
871
872                 be_free_birg(birg);
873                 stat_ev_ctx_pop("bemain_irg");
874         }
875         ir_profile_free();
876         be_done_env(&env);
877 }
878
879 /* Main interface to the frontend. */
880 void be_main(FILE *file_handle, const char *cup_name)
881 {
882         ir_timer_t *t = NULL;
883
884         /* The user specified another config file to read. do that now. */
885         if (config_file[0] != '\0') {
886                 FILE *f;
887
888                 if ((f = fopen(config_file, "rt")) != NULL) {
889                         lc_opt_from_file(config_file, f, NULL);
890                         fclose(f);
891                 }
892         }
893
894         if (be_options.timing == BE_TIME_ON) {
895                 t = ir_timer_register("bemain", "measure complete bemain loop");
896
897                 if (ir_timer_enter_high_priority()) {
898                         fprintf(stderr, "Warning: Could not enter high priority mode.\n");
899                 }
900
901                 ir_timer_reset_and_start(t);
902         }
903
904 #ifdef FIRM_STATISTICS
905         if (be_options.statev) {
906                 const char *dot = strrchr(cup_name, '.');
907                 const char *pos = dot ? dot : cup_name + strlen(cup_name);
908                 char       *buf = alloca(pos - cup_name + 1);
909                 strncpy(buf, cup_name, pos - cup_name);
910                 buf[pos - cup_name] = '\0';
911
912                 be_options.statev = 1;
913                 stat_ev_begin(buf, be_options.filtev);
914                 stat_ev_ctx_push_str("bemain_compilation_unit", cup_name);
915         }
916 #endif
917
918         /* never build code for pseudo irgs */
919         set_visit_pseudo_irgs(0);
920
921         be_node_init();
922
923         be_main_loop(file_handle, cup_name);
924
925         if (be_options.timing == BE_TIME_ON) {
926                 ir_timer_stop(t);
927                 ir_timer_leave_high_priority();
928                 stat_ev_if {
929                         stat_ev_dbl("bemain_backend_time", ir_timer_elapsed_msec(t));
930                 } else {
931                         printf("%-20s: %lu msec\n", "BEMAINLOOP", ir_timer_elapsed_msec(t));
932                 }
933         }
934
935 #ifdef FIRM_STATISTICS
936         if (be_options.statev) {
937                 stat_ev_ctx_pop("bemain_compilation_unit");
938                 stat_ev_end();
939         }
940 #endif
941 }
942
943 unsigned be_put_ignore_regs(const be_irg_t *birg, const arch_register_class_t *cls, bitset_t *bs)
944 {
945         if (bs == NULL)
946                 bs = bitset_alloca(cls->n_regs);
947         else
948                 bitset_clear_all(bs);
949
950         assert(bitset_size(bs) == (unsigned)cls->n_regs);
951         arch_put_non_ignore_regs(cls, bs);
952         bitset_flip_all(bs);
953         be_abi_put_ignore_regs(birg->abi, cls, bs);
954
955         return bitset_popcnt(bs);
956 }