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