Remove the unused attribute const arch_env_t *arch_env from struct phi_handler and...
[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 "phiclass.h"
43 #include "irdom_t.h"
44 #include "iredges_t.h"
45 #include "irloop_t.h"
46 #include "irtools.h"
47 #include "irvrfy.h"
48 #include "irprintf.h"
49 #include "iroptimize.h"
50 #include "firmstat.h"
51 #include "execfreq.h"
52 #include "irprofile.h"
53
54 #include "bearch_t.h"
55 #include "be_t.h"
56 #include "bemodule.h"
57 #include "beutil.h"
58 #include "benode_t.h"
59 #include "beirgmod.h"
60 #include "besched_t.h"
61 #include "belistsched.h"
62 #include "belive_t.h"
63 #include "bera.h"
64 #include "bechordal_t.h"
65 #include "beifg.h"
66 #include "beifg_impl.h"
67 #include "becopyopt.h"
68 #include "becopystat.h"
69 #include "bessadestr.h"
70 #include "beabi.h"
71 #include "belower.h"
72 #include "beschedmris.h"
73 #include "bestat.h"
74 #include "beverify.h"
75 #include "be_dbgout.h"
76 #include "beirg_t.h"
77
78 #define NEW_ID(s) new_id_from_chars(s, sizeof(s) - 1)
79
80 #ifdef WITH_ILP
81 #include "beilpsched.h"
82 #endif /* WITH_ILP */
83
84 /* options visible for anyone */
85 static be_options_t be_options = {
86         DUMP_NONE,                         /* dump flags */
87         BE_TIME_OFF,                       /* no timing */
88         0,                                 /* no opt profile */
89         0,                                 /* try to omit frame pointer */
90         0,                                 /* try to omit leaf frame pointer */
91         0,                                 /* create PIC code */
92         0,                                 /* create gprof compatible profiling code */
93         BE_VRFY_WARN,                      /* verification level: warn */
94         BE_SCHED_LIST,                     /* scheduler: list scheduler */
95         "linux",                           /* target OS name */
96         "i44pc52.info.uni-karlsruhe.de",   /* ilp server */
97         "cplex",                           /* ilp solver */
98         0,                                 /* enable statistic event dumping */
99         "",                                /* print stat events */
100 };
101
102 /* config file. */
103 static char config_file[256] = { 0 };
104
105 /* back end instruction set architecture to use */
106 static const arch_isa_if_t *isa_if = NULL;
107
108 /* possible dumping options */
109 static const lc_opt_enum_mask_items_t dump_items[] = {
110         { "none",       DUMP_NONE },
111         { "initial",    DUMP_INITIAL },
112         { "abi",        DUMP_ABI    },
113         { "sched",      DUMP_SCHED  },
114         { "prepared",   DUMP_PREPARED },
115         { "regalloc",   DUMP_RA },
116         { "final",      DUMP_FINAL },
117         { "be",         DUMP_BE },
118         { "all",        2 * DUMP_BE - 1 },
119         { NULL,         0 }
120 };
121
122 /* verify options. */
123 static const lc_opt_enum_int_items_t vrfy_items[] = {
124         { "off",    BE_VRFY_OFF    },
125         { "warn",   BE_VRFY_WARN   },
126         { "assert", BE_VRFY_ASSERT },
127         { NULL,     0 }
128 };
129
130 /* scheduling options. */
131 static const lc_opt_enum_int_items_t sched_items[] = {
132         { "list", BE_SCHED_LIST },
133 #ifdef WITH_ILP
134         { "ilp",  BE_SCHED_ILP  },
135 #endif /* WITH_ILP */
136         { NULL,   0 }
137 };
138
139 static lc_opt_enum_mask_var_t dump_var = {
140         &be_options.dump_flags, dump_items
141 };
142
143 static lc_opt_enum_int_var_t vrfy_var = {
144         &be_options.vrfy_option, vrfy_items
145 };
146
147 static lc_opt_enum_int_var_t sched_var = {
148         &be_options.scheduler, sched_items
149 };
150
151 static const lc_opt_table_entry_t be_main_options[] = {
152         LC_OPT_ENT_STR      ("config",     "read another config file containing backend options", config_file, sizeof(config_file)),
153         LC_OPT_ENT_ENUM_MASK("dump",       "dump irg on several occasions",                       &dump_var),
154         LC_OPT_ENT_BOOL     ("omitfp",     "omit frame pointer",                                  &be_options.omit_fp),
155         LC_OPT_ENT_BOOL     ("omitleaffp", "omit frame pointer in leaf routines",                 &be_options.omit_leaf_fp),
156         LC_OPT_ENT_BOOL     ("pic",        "create PIC code",                                     &be_options.pic),
157         LC_OPT_ENT_BOOL     ("gprof",      "create gprof profiling code",                         &be_options.gprof),
158         LC_OPT_ENT_ENUM_PTR ("vrfy",       "verify the backend irg",                              &vrfy_var),
159         LC_OPT_ENT_BOOL     ("time",       "get backend timing statistics",                       &be_options.timing),
160         LC_OPT_ENT_BOOL     ("profile",    "instrument the code for execution count profiling",   &be_options.opt_profile),
161         LC_OPT_ENT_ENUM_PTR ("sched",      "select a scheduler",                                  &sched_var),
162         LC_OPT_ENT_STR      ("os",         "specify target operating system",                     &be_options.target_os, sizeof(be_options.target_os)),
163 #ifdef FIRM_STATISTICS
164         LC_OPT_ENT_BOOL     ("statev",     "dump statistic events",                               &be_options.statev),
165         LC_OPT_ENT_STR      ("filtev",     "filter for stat events (regex if support is active",  &be_options.filtev, sizeof(be_options.filtev)),
166 #endif
167
168 #ifdef WITH_ILP
169         LC_OPT_ENT_STR ("ilp.server", "the ilp server name", be_options.ilp_server, sizeof(be_options.ilp_server)),
170         LC_OPT_ENT_STR ("ilp.solver", "the ilp solver name", be_options.ilp_solver, sizeof(be_options.ilp_solver)),
171 #endif /* WITH_ILP */
172         LC_OPT_LAST
173 };
174
175 static be_module_list_entry_t *isa_ifs = NULL;
176
177
178 unsigned short asm_constraint_flags[256];
179
180 void be_init_default_asm_constraint_flags(void)
181 {
182         asm_constraint_flags['?'] = ASM_CONSTRAINT_FLAG_NO_SUPPORT;
183         asm_constraint_flags['!'] = ASM_CONSTRAINT_FLAG_NO_SUPPORT;
184         asm_constraint_flags['&'] = ASM_CONSTRAINT_FLAG_NO_SUPPORT
185                 | ASM_CONSTRAINT_FLAG_MODIFIER_EARLYCLOBBER;
186         asm_constraint_flags['%'] = ASM_CONSTRAINT_FLAG_NO_SUPPORT
187                 | ASM_CONSTRAINT_FLAG_MODIFIER_COMMUTATIVE;
188         asm_constraint_flags['!'] = ASM_CONSTRAINT_FLAG_NO_SUPPORT;
189
190         asm_constraint_flags['='] = ASM_CONSTRAINT_FLAG_MODIFIER_WRITE
191                 | ASM_CONSTRAINT_FLAG_MODIFIER_NO_READ;
192         asm_constraint_flags['+'] = ASM_CONSTRAINT_FLAG_MODIFIER_READ
193                 | ASM_CONSTRAINT_FLAG_MODIFIER_WRITE;
194
195         asm_constraint_flags['i'] = ASM_CONSTRAINT_FLAG_SUPPORTS_IMMEDIATE;
196         asm_constraint_flags['s'] = ASM_CONSTRAINT_FLAG_SUPPORTS_IMMEDIATE;
197         asm_constraint_flags['E'] = ASM_CONSTRAINT_FLAG_SUPPORTS_IMMEDIATE;
198         asm_constraint_flags['F'] = ASM_CONSTRAINT_FLAG_SUPPORTS_IMMEDIATE;
199         asm_constraint_flags['G'] = ASM_CONSTRAINT_FLAG_SUPPORTS_IMMEDIATE;
200         asm_constraint_flags['H'] = ASM_CONSTRAINT_FLAG_SUPPORTS_IMMEDIATE;
201         asm_constraint_flags['I'] = ASM_CONSTRAINT_FLAG_SUPPORTS_IMMEDIATE;
202         asm_constraint_flags['J'] = ASM_CONSTRAINT_FLAG_SUPPORTS_IMMEDIATE;
203         asm_constraint_flags['K'] = ASM_CONSTRAINT_FLAG_SUPPORTS_IMMEDIATE;
204         asm_constraint_flags['L'] = ASM_CONSTRAINT_FLAG_SUPPORTS_IMMEDIATE;
205         asm_constraint_flags['M'] = ASM_CONSTRAINT_FLAG_SUPPORTS_IMMEDIATE;
206         asm_constraint_flags['N'] = ASM_CONSTRAINT_FLAG_SUPPORTS_IMMEDIATE;
207         asm_constraint_flags['O'] = ASM_CONSTRAINT_FLAG_SUPPORTS_IMMEDIATE;
208         asm_constraint_flags['P'] = ASM_CONSTRAINT_FLAG_SUPPORTS_IMMEDIATE;
209
210         asm_constraint_flags['m'] = ASM_CONSTRAINT_FLAG_SUPPORTS_MEMOP;
211         asm_constraint_flags['o'] = ASM_CONSTRAINT_FLAG_SUPPORTS_MEMOP;
212         asm_constraint_flags['V'] = ASM_CONSTRAINT_FLAG_SUPPORTS_MEMOP;
213         asm_constraint_flags['<'] = ASM_CONSTRAINT_FLAG_SUPPORTS_MEMOP;
214         asm_constraint_flags['>'] = ASM_CONSTRAINT_FLAG_SUPPORTS_MEMOP;
215
216         asm_constraint_flags['p'] = ASM_CONSTRAINT_FLAG_SUPPORTS_REGISTER;
217         asm_constraint_flags['0'] = ASM_CONSTRAINT_FLAG_SUPPORTS_REGISTER;
218         asm_constraint_flags['1'] = ASM_CONSTRAINT_FLAG_SUPPORTS_REGISTER;
219         asm_constraint_flags['2'] = ASM_CONSTRAINT_FLAG_SUPPORTS_REGISTER;
220         asm_constraint_flags['3'] = ASM_CONSTRAINT_FLAG_SUPPORTS_REGISTER;
221         asm_constraint_flags['4'] = ASM_CONSTRAINT_FLAG_SUPPORTS_REGISTER;
222         asm_constraint_flags['5'] = ASM_CONSTRAINT_FLAG_SUPPORTS_REGISTER;
223         asm_constraint_flags['6'] = ASM_CONSTRAINT_FLAG_SUPPORTS_REGISTER;
224         asm_constraint_flags['7'] = ASM_CONSTRAINT_FLAG_SUPPORTS_REGISTER;
225         asm_constraint_flags['8'] = ASM_CONSTRAINT_FLAG_SUPPORTS_REGISTER;
226         asm_constraint_flags['9'] = ASM_CONSTRAINT_FLAG_SUPPORTS_REGISTER;
227
228         asm_constraint_flags['X'] = ASM_CONSTRAINT_FLAG_SUPPORTS_REGISTER
229                 | ASM_CONSTRAINT_FLAG_SUPPORTS_MEMOP
230                 | ASM_CONSTRAINT_FLAG_SUPPORTS_IMMEDIATE;
231
232         /* these should have been catched by the parsing code already */
233         asm_constraint_flags['#']  = ASM_CONSTRAINT_FLAG_NO_SUPPORT;
234         asm_constraint_flags['*']  = ASM_CONSTRAINT_FLAG_NO_SUPPORT;
235         asm_constraint_flags[' ']  = ASM_CONSTRAINT_FLAG_NO_SUPPORT;
236         asm_constraint_flags['\t'] = ASM_CONSTRAINT_FLAG_NO_SUPPORT;
237         asm_constraint_flags['\n'] = ASM_CONSTRAINT_FLAG_NO_SUPPORT;
238         asm_constraint_flags['\r'] = ASM_CONSTRAINT_FLAG_NO_SUPPORT;
239 }
240
241 asm_constraint_flags_t be_parse_asm_constraints(const char *constraint)
242 {
243         asm_constraint_flags_t  flags = 0;
244         const char             *c;
245         asm_constraint_flags_t  tflags;
246
247         for (c = constraint; *c != '\0'; ++c) {
248                 switch (*c) {
249                 case '#':
250                         /* 'comment' stuff */
251                         while(*c != 0 && *c != ',')
252                                 ++c;
253                         break;
254                 case '*':
255                         /* 'comment' character */
256                         ++c;
257                         break;
258                 case ' ':
259                 case '\t':
260                 case '\n':
261                 case '\r':
262                         break;
263                 default:
264                         tflags = asm_constraint_flags[(int) *c];
265                         if (tflags != 0) {
266                                 flags |= tflags;
267                         } else {
268                                 flags |= isa_if->parse_asm_constraint(isa_if, &c);
269                         }
270                         break;
271                 }
272         }
273
274         if ((
275                 flags & ASM_CONSTRAINT_FLAG_MODIFIER_WRITE &&
276                 flags & ASM_CONSTRAINT_FLAG_MODIFIER_NO_WRITE
277             ) || (
278                 flags & ASM_CONSTRAINT_FLAG_MODIFIER_READ &&
279                 flags & ASM_CONSTRAINT_FLAG_MODIFIER_NO_READ
280             )) {
281                 flags |= ASM_CONSTRAINT_FLAG_INVALID;
282         }
283         if (!(flags & (ASM_CONSTRAINT_FLAG_MODIFIER_READ     |
284                        ASM_CONSTRAINT_FLAG_MODIFIER_WRITE    |
285                        ASM_CONSTRAINT_FLAG_MODIFIER_NO_WRITE |
286                        ASM_CONSTRAINT_FLAG_MODIFIER_NO_READ)
287             )) {
288                 flags |= ASM_CONSTRAINT_FLAG_MODIFIER_READ;
289         }
290
291         return flags;
292 }
293
294 int be_is_valid_clobber(const char *clobber)
295 {
296         /* memory is a valid clobber. (the frontend has to detect this case too,
297          * because it has to add memory edges to the asm) */
298         if (strcmp(clobber, "memory") == 0)
299                 return 1;
300         /* cc (condition code) is always valid */
301         if (strcmp(clobber, "cc") == 0)
302                 return 1;
303
304         return isa_if->is_valid_clobber(isa_if, clobber);
305 }
306
307 void be_register_isa_if(const char *name, const arch_isa_if_t *isa)
308 {
309         if (isa_if == NULL)
310                 isa_if = isa;
311
312         be_add_module_to_list(&isa_ifs, name, (void*) isa);
313 }
314
315 void be_opt_register(void)
316 {
317         lc_opt_entry_t *be_grp;
318         static int run_once = 0;
319
320         if (run_once) {
321                 return;
322         }
323         run_once     = 1;
324
325         be_init_modules();
326
327         be_grp = lc_opt_get_grp(firm_opt_get_root(), "be");
328         lc_opt_add_table(be_grp, be_main_options);
329
330         be_add_module_list_opt(be_grp, "isa", "the instruction set architecture",
331                                &isa_ifs, (void**) &isa_if);
332 }
333
334 /* Parse one argument. */
335 int be_parse_arg(const char *arg) {
336         lc_opt_entry_t *be_grp = lc_opt_get_grp(firm_opt_get_root(), "be");
337         if (strcmp(arg, "help") == 0 || (arg[0] == '?' && arg[1] == '\0')) {
338                 lc_opt_print_help(be_grp, stdout);
339                 return -1;
340         }
341         return lc_opt_from_single_arg(be_grp, NULL, arg, NULL);
342 }
343
344 /** The be parameters returned by default, all off. */
345 static const backend_params be_params = {
346         0,    /* need dword lowering */
347         0,    /* don't support inline assembler yet */
348         0,     /* no immediate floating point mode. */
349         NULL, /* no additional opcodes */
350         NULL, /* will be set later */
351         NULL, /* but yet no creator function */
352         NULL, /* context for create_intrinsic_fkt */
353         NULL, /* no if conversion settings */
354         NULL   /* no immediate fp mode */
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_phi_handler_new();
410
411         be_dbg_open();
412         return env;
413 }
414
415 /**
416  * Called when the be_main_env_t can be destroyed.
417  */
418 static void be_done_env(be_main_env_t *env)
419 {
420         arch_env_done(env->arch_env);
421         be_dbg_close();
422         be_phi_handler_free();
423
424         pmap_destroy(env->ent_trampoline_map);
425         pmap_destroy(env->ent_pic_symbol_map);
426         free_type(env->pic_trampolines_type);
427         free_type(env->pic_symbols_type);
428 }
429
430 /**
431  * A wrapper around a firm dumper. Dumps only, if
432  * flags are enabled.
433  *
434  * @param mask    a bitmask containing the reason what will be dumped
435  * @param irg     the IR graph to dump
436  * @param suffix  the suffix for the dumper
437  * @param dumper  the dumper to be called
438  */
439 static void dump(int mask, ir_graph *irg, const char *suffix,
440                  void (*dumper)(ir_graph *, const char *))
441 {
442         if(be_options.dump_flags & mask)
443                 be_dump(irg, suffix, dumper);
444 }
445
446 /**
447  * Prepare a backend graph for code generation and initialize its birg
448  */
449 static void initialize_birg(be_irg_t *birg, ir_graph *irg, be_main_env_t *env)
450 {
451         memset(birg, 0, sizeof(*birg));
452         birg->irg = irg;
453         birg->main_env = env;
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
478         dump(DUMP_INITIAL, irg, "-prepared", dump_ir_block_graph);
479 }
480
481 #define BE_TIMER_ONLY(code)   do { if (be_timing) { code; } } while(0)
482
483 int be_timing;
484 ir_timer_t *t_abi;
485 ir_timer_t *t_codegen;
486 ir_timer_t *t_sched;
487 ir_timer_t *t_constr;
488 ir_timer_t *t_finish;
489 ir_timer_t *t_emit;
490 ir_timer_t *t_other;
491 ir_timer_t *t_verify;
492 ir_timer_t *t_heights;
493 ir_timer_t *t_live;
494 ir_timer_t *t_execfreq;
495 ir_timer_t *t_ssa_constr;
496 ir_timer_t *t_ra_constr;
497 ir_timer_t *t_ra_prolog;
498 ir_timer_t *t_ra_epilog;
499 ir_timer_t *t_ra_spill;
500 ir_timer_t *t_ra_spill_apply;
501 ir_timer_t *t_ra_color;
502 ir_timer_t *t_ra_ifg;
503 ir_timer_t *t_ra_copymin;
504 ir_timer_t *t_ra_ssa;
505 ir_timer_t *t_ra_other;
506
507 /**
508  * The Firm backend main loop.
509  * Do architecture specific lowering for all graphs
510  * and call the architecture specific code generator.
511  *
512  * @param file_handle   the file handle the output will be written to
513  * @param cup_name      name of the compilation unit
514  */
515 static void be_main_loop(FILE *file_handle, const char *cup_name)
516 {
517         int i;
518         be_main_env_t env;
519         char prof_filename[256];
520         static const char suffix[] = ".prof";
521         be_irg_t *birgs;
522         int num_birgs;
523         ir_graph **irg_list, **backend_irg_list;
524         arch_env_t *arch_env;
525
526         be_timing = (be_options.timing == BE_TIME_ON);
527
528         if (be_timing) {
529                 t_abi        = ir_timer_register("bemain_time_beabi",       "be abi introduction");
530                 t_codegen    = ir_timer_register("bemain_time_codegen",     "codegeneration");
531                 t_sched      = ir_timer_register("bemain_time_sched",       "scheduling");
532                 t_constr     = ir_timer_register("bemain_time_constr",      "assure constraints");
533                 t_finish     = ir_timer_register("bemain_time_finish",      "graph finish");
534                 t_emit       = ir_timer_register("bemain_time_emiter",      "code emiter");
535                 t_verify     = ir_timer_register("bemain_time_verify",      "graph verification");
536                 t_other      = ir_timer_register("bemain_time_other",       "other");
537                 t_heights    = ir_timer_register("bemain_time_heights",     "heights");
538                 t_live       = ir_timer_register("bemain_time_liveness",    "be liveness");
539                 t_execfreq   = ir_timer_register("bemain_time_execfreq",    "execfreq");
540                 t_ssa_constr = ir_timer_register("bemain_time_ssa_constr",  "ssa reconstruction");
541                 t_ra_prolog  = ir_timer_register("bemain_time_ra_prolog",   "regalloc prolog");
542                 t_ra_epilog  = ir_timer_register("bemain_time_ra_epilog",   "regalloc epilog");
543                 t_ra_constr  = ir_timer_register("bemain_time_ra_constr",   "regalloc constraints");
544                 t_ra_spill   = ir_timer_register("bemain_time_ra_spill",    "spiller");
545                 t_ra_spill_apply
546                         = ir_timer_register("bemain_time_ra_spill_apply", "apply spills");
547                 t_ra_color   = ir_timer_register("bemain_time_ra_color",    "graph coloring");
548                 t_ra_ifg     = ir_timer_register("bemain_time_ra_ifg",      "interference graph");
549                 t_ra_copymin = ir_timer_register("bemain_time_ra_copymin",  "copy minimization");
550                 t_ra_ssa     = ir_timer_register("bemain_time_ra_ssadestr", "ssa destruction");
551                 t_ra_other   = ir_timer_register("bemain_time_ra_other",    "regalloc other");
552         }
553
554         be_init_env(&env, file_handle);
555         env.cup_name = cup_name;
556
557         be_dbg_so(cup_name);
558         be_dbg_types();
559
560         arch_env = env.arch_env;
561
562         /* backend may provide an ordered list of irgs where code should be
563          * 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                 be_sched_init_phase(irg);
609
610                 /* reset the phi handler. */
611                 be_phi_handler_reset();
612
613                 stat_ev_if {
614                         stat_ev_ctx_push_fobj("bemain_irg", irg);
615                         be_stat_ev("bemain_insns_start", be_count_insns(irg));
616                         be_stat_ev("bemain_blocks_start", be_count_blocks(irg));
617                 }
618
619                 /* stop and reset timers */
620                 BE_TIMER_PUSH(t_other);   /* t_other */
621
622                 /* Verify the initial graph */
623                 BE_TIMER_PUSH(t_verify);
624                 if (be_options.vrfy_option == BE_VRFY_WARN) {
625                         irg_verify(irg, VRFY_ENFORCE_SSA);
626                         be_check_dominance(irg);
627                 } else if (be_options.vrfy_option == BE_VRFY_ASSERT) {
628                         assert(irg_verify(irg, VRFY_ENFORCE_SSA) && "irg verification failed");
629                         assert(be_check_dominance(irg) && "Dominance verification failed");
630                 }
631                 BE_TIMER_POP(t_verify);
632
633                 /* Get the code generator interface. */
634                 cg_if = arch_env_get_code_generator_if(arch_env);
635
636                 /* get a code generator for this graph. */
637                 birg->cg = cg_if->init(birg);
638
639                 /* some transformations need to be done before abi introduce */
640                 arch_code_generator_before_abi(birg->cg);
641
642                 /* implement the ABI conventions. */
643                 BE_TIMER_PUSH(t_abi);
644                 birg->abi = be_abi_introduce(birg);
645                 BE_TIMER_POP(t_abi);
646
647                 dump(DUMP_ABI, irg, "-abi", dump_ir_block_graph);
648
649                 if (be_options.vrfy_option == BE_VRFY_WARN) {
650                         be_check_dominance(irg);
651                         be_verify_out_edges(irg);
652                 } else if (be_options.vrfy_option == BE_VRFY_ASSERT) {
653                         assert(be_verify_out_edges(irg));
654                         assert(be_check_dominance(irg) && "Dominance verification failed");
655                 }
656
657                 /* generate code */
658                 BE_TIMER_PUSH(t_codegen);
659                 arch_code_generator_prepare_graph(birg->cg);
660                 BE_TIMER_POP(t_codegen);
661
662                 /* reset the phi handler. */
663                 be_phi_handler_reset();
664
665                 dump(DUMP_PREPARED, irg, "-prepared", dump_ir_block_graph);
666
667                 if (be_options.vrfy_option == BE_VRFY_WARN) {
668                         be_check_dominance(irg);
669                         be_verify_out_edges(irg);
670                 } else if (be_options.vrfy_option == BE_VRFY_ASSERT) {
671                         assert(be_verify_out_edges(irg));
672                         assert(be_check_dominance(irg) && "Dominance verification failed");
673                 }
674
675                 BE_TIMER_PUSH(t_execfreq);
676                 /**
677                  * Create execution frequencies from profile data or estimate some
678                  */
679                 if (ir_profile_has_data())
680                         birg->exec_freq = ir_create_execfreqs_from_profile(irg);
681                 else {
682                         /* TODO: edges are corrupt for EDGE_KIND_BLOCK after the local
683                          * optimize graph phase merges blocks in the x86 backend */
684                         edges_deactivate(irg);
685                         birg->exec_freq = compute_execfreq(irg, 10);
686                 }
687                 BE_TIMER_POP(t_execfreq);
688
689
690                 /* disabled for now, fails for EmptyFor.c and XXEndless.c */
691                 /* be_live_chk_compare(birg); */
692
693                 /* let backend prepare scheduling */
694                 BE_TIMER_PUSH(t_codegen);
695                 arch_code_generator_before_sched(birg->cg);
696                 BE_TIMER_POP(t_codegen);
697
698                 /* schedule the irg */
699                 BE_TIMER_PUSH(t_sched);
700                 switch (be_options.scheduler) {
701                         default:
702                                 fprintf(stderr, "Warning: invalid scheduler (%d) selected, falling back to list scheduler.\n", be_options.scheduler);
703                         case BE_SCHED_LIST:
704                                 list_sched(birg, &be_options);
705                                 break;
706 #ifdef WITH_ILP
707                         case BE_SCHED_ILP:
708                                 be_ilp_sched(birg, &be_options);
709                                 break;
710 #endif /* WITH_ILP */
711                 };
712                 BE_TIMER_POP(t_sched);
713
714                 dump(DUMP_SCHED, irg, "-sched", dump_ir_block_graph_sched);
715
716                 /* check schedule */
717                 BE_TIMER_PUSH(t_verify);
718                 be_sched_vrfy(birg, be_options.vrfy_option);
719                 BE_TIMER_POP(t_verify);
720
721                 /* introduce patterns to assure constraints */
722                 BE_TIMER_PUSH(t_constr);
723                 /* we switch off optimizations here, because they might cause trouble */
724                 save_optimization_state(&state);
725                 set_optimize(0);
726                 set_opt_normalize(0);
727                 set_opt_cse(0);
728
729                 /* add Keeps for should_be_different constrained nodes  */
730                 /* beware: needs schedule due to usage of be_ssa_constr */
731                 assure_constraints(birg);
732                 BE_TIMER_POP(t_constr);
733
734                 dump(DUMP_SCHED, irg, "-assured", dump_ir_block_graph_sched);
735
736                 /* stuff needs to be done after scheduling but before register allocation */
737                 BE_TIMER_PUSH(t_codegen);
738                 arch_code_generator_before_ra(birg->cg);
739                 BE_TIMER_POP(t_codegen);
740
741                 /* connect all stack modifying nodes together (see beabi.c) */
742                 BE_TIMER_PUSH(t_abi);
743                 be_abi_fix_stack_nodes(birg->abi);
744                 BE_TIMER_POP(t_abi);
745
746                 dump(DUMP_SCHED, irg, "-fix_stack", dump_ir_block_graph_sched);
747
748                 /* check schedule */
749                 BE_TIMER_PUSH(t_verify);
750                 be_sched_vrfy(birg, be_options.vrfy_option);
751                 BE_TIMER_POP(t_verify);
752
753                 stat_ev_if {
754                         stat_ev_dbl("bemain_costs_before_ra",
755                                         be_estimate_irg_costs(irg, birg->exec_freq));
756                         be_stat_ev("bemain_insns_before_ra", be_count_insns(irg));
757                         be_stat_ev("bemain_blocks_before_ra", be_count_blocks(irg));
758                 }
759
760                 /* Do register allocation */
761                 be_allocate_registers(birg);
762
763 #ifdef FIRM_STATISTICS
764                 stat_ev_dbl("bemain_costs_before_ra", be_estimate_irg_costs(irg, birg->exec_freq));
765 #endif
766
767                 dump(DUMP_RA, irg, "-ra", dump_ir_block_graph_sched);
768
769                 /* let the code generator prepare the graph for emitter */
770                 BE_TIMER_PUSH(t_finish);
771                 arch_code_generator_after_ra(birg->cg);
772                 BE_TIMER_POP(t_finish);
773
774                 /* fix stack offsets */
775                 BE_TIMER_PUSH(t_abi);
776                 be_abi_fix_stack_nodes(birg->abi);
777                 be_remove_dead_nodes_from_schedule(birg);
778                 be_abi_fix_stack_bias(birg->abi);
779                 BE_TIMER_POP(t_abi);
780
781                 dump(DUMP_SCHED, irg, "-fix_stack_after_ra", dump_ir_block_graph_sched);
782
783                 BE_TIMER_PUSH(t_finish);
784                 arch_code_generator_finish(birg->cg);
785                 BE_TIMER_POP(t_finish);
786
787                 dump(DUMP_FINAL, irg, "-finish", dump_ir_block_graph_sched);
788
789                 stat_ev_if {
790                         be_stat_ev("bemain_insns_finish", be_count_insns(irg));
791                         be_stat_ev("bemain_blocks_finish", be_count_blocks(irg));
792                 }
793
794                 /* check schedule and register allocation */
795                 BE_TIMER_PUSH(t_verify);
796                 if (be_options.vrfy_option == BE_VRFY_WARN) {
797                         irg_verify(irg, VRFY_ENFORCE_SSA);
798                         be_check_dominance(irg);
799                         be_verify_out_edges(irg);
800                         be_verify_schedule(birg);
801                         be_verify_register_allocation(birg);
802                 } else if (be_options.vrfy_option == BE_VRFY_ASSERT) {
803                         assert(irg_verify(irg, VRFY_ENFORCE_SSA) && "irg verification failed");
804                         assert(be_verify_out_edges(irg) && "out edge verification failed");
805                         assert(be_check_dominance(irg) && "Dominance verification failed");
806                         assert(be_verify_schedule(birg) && "Schedule verification failed");
807                         assert(be_verify_register_allocation(birg)
808                                && "register allocation verification failed");
809
810                 }
811                 BE_TIMER_POP(t_verify);
812
813                 /* emit assembler code */
814                 BE_TIMER_PUSH(t_emit);
815                 arch_code_generator_done(birg->cg);
816                 BE_TIMER_POP(t_emit);
817
818                 dump(DUMP_FINAL, irg, "-end", dump_ir_block_graph_sched);
819
820                 BE_TIMER_PUSH(t_abi);
821                 be_abi_free(birg->abi);
822                 BE_TIMER_POP(t_abi);
823
824                 restore_optimization_state(&state);
825
826                 BE_TIMER_POP(t_other);
827
828 #define STOP_AND_RESET_TIMER(timer) do { ir_timer_stop(timer); ir_timer_reset(timer); } while(0)
829
830 #define LC_EMIT(timer)  \
831                 stat_ev_if {    \
832                         stat_ev_dbl(ir_timer_get_name(timer), ir_timer_elapsed_msec(timer));  \
833                 } else { \
834                         printf("%-20s: %8.3lf msec\n", ir_timer_get_description(timer), (double)ir_timer_elapsed_usec(timer) / 1000.0); \
835                 } \
836                 STOP_AND_RESET_TIMER(timer);
837
838                 BE_TIMER_ONLY(
839                         stat_ev_if {
840                         } else {
841                                 printf("==>> IRG %s <<==\n", get_entity_name(get_irg_entity(irg)));
842                         }
843                         LC_EMIT(t_abi);
844                         LC_EMIT(t_codegen);
845                         LC_EMIT(t_sched);
846                         LC_EMIT(t_live);
847                         LC_EMIT(t_heights);
848                         LC_EMIT(t_ssa_constr);
849                         LC_EMIT(t_constr);
850                         LC_EMIT(t_execfreq);
851                         LC_EMIT(t_ra_prolog);
852                         LC_EMIT(t_ra_spill);
853                         LC_EMIT(t_ra_spill_apply);
854                         LC_EMIT(t_ra_constr);
855                         LC_EMIT(t_ra_color);
856                         LC_EMIT(t_ra_ifg);
857                         LC_EMIT(t_ra_copymin);
858                         LC_EMIT(t_ra_ssa);
859                         LC_EMIT(t_ra_epilog);
860                         LC_EMIT(t_ra_other);
861                         LC_EMIT(t_finish);
862                         LC_EMIT(t_emit);
863                         LC_EMIT(t_verify);
864                         LC_EMIT(t_other);
865                 );
866 #undef LC_EMIT
867
868                 be_sched_free_phase(irg);
869
870                 be_free_birg(birg);
871                 stat_ev_ctx_pop("bemain_irg");
872         }
873         ir_profile_free();
874         be_done_env(&env);
875 }
876
877 /* Main interface to the frontend. */
878 void be_main(FILE *file_handle, const char *cup_name)
879 {
880         ir_timer_t *t = NULL;
881
882         /* The user specified another config file to read. do that now. */
883         if (config_file[0] != '\0') {
884                 FILE *f;
885
886                 if ((f = fopen(config_file, "rt")) != NULL) {
887                         lc_opt_from_file(config_file, f, NULL);
888                         fclose(f);
889                 }
890         }
891
892         if (be_options.timing == BE_TIME_ON) {
893                 t = ir_timer_register("bemain", "measure complete bemain loop");
894
895                 if (ir_timer_enter_high_priority()) {
896                         fprintf(stderr, "Warning: Could not enter high priority mode.\n");
897                 }
898
899                 ir_timer_reset_and_start(t);
900         }
901
902 #ifdef FIRM_STATISTICS
903         if (be_options.statev) {
904                 const char *dot = strrchr(cup_name, '.');
905                 const char *pos = dot ? dot : cup_name + strlen(cup_name);
906                 char       *buf = alloca(pos - cup_name + 1);
907                 strncpy(buf, cup_name, pos - cup_name);
908                 buf[pos - cup_name] = '\0';
909
910                 be_options.statev = 1;
911                 stat_ev_begin(buf, be_options.filtev);
912                 stat_ev_ctx_push_str("bemain_compilation_unit", cup_name);
913         }
914 #endif
915
916         /* never build code for pseudo irgs */
917         set_visit_pseudo_irgs(0);
918
919         be_node_init();
920
921         be_main_loop(file_handle, cup_name);
922
923         if (be_options.timing == BE_TIME_ON) {
924                 ir_timer_stop(t);
925                 ir_timer_leave_high_priority();
926                 stat_ev_if {
927                         stat_ev_dbl("bemain_backend_time", ir_timer_elapsed_msec(t));
928                 } else {
929                         printf("%-20s: %lu msec\n", "BEMAINLOOP", ir_timer_elapsed_msec(t));
930                 }
931         }
932
933 #ifdef FIRM_STATISTICS
934         if (be_options.statev) {
935                 stat_ev_ctx_pop("bemain_compilation_unit");
936                 stat_ev_end();
937         }
938 #endif
939 }
940
941 unsigned be_put_ignore_regs(const be_irg_t *birg, const arch_register_class_t *cls, bitset_t *bs)
942 {
943         if (bs == NULL)
944                 bs = bitset_alloca(cls->n_regs);
945         else
946                 bitset_clear_all(bs);
947
948         assert(bitset_size(bs) == (unsigned)cls->n_regs);
949         arch_put_non_ignore_regs(cls, bs);
950         bitset_flip_all(bs);
951         be_abi_put_ignore_regs(birg->abi, cls, bs);
952
953         return bitset_popcnt(bs);
954 }