refactoring: split stackframe handling completely from beabi struct
[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 "irverify.h"
47 #include "irprintf.h"
48 #include "iroptimize.h"
49 #include "firmstat.h"
50 #include "execfreq.h"
51 #include "irprofile.h"
52 #include "irpass_t.h"
53
54 #include "bearch.h"
55 #include "be_t.h"
56 #include "bemodule.h"
57 #include "beutil.h"
58 #include "benode.h"
59 #include "beirgmod.h"
60 #include "besched.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 "becopyopt.h"
67 #include "becopystat.h"
68 #include "bessadestr.h"
69 #include "beabi.h"
70 #include "belower.h"
71 #include "beschedmris.h"
72 #include "bestat.h"
73 #include "beverify.h"
74 #include "be_dbgout.h"
75 #include "beirg.h"
76 #include "bestack.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_VERIFY_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 verify_items[] = {
124         { "off",    BE_VERIFY_OFF    },
125         { "warn",   BE_VERIFY_WARN   },
126         { "assert", BE_VERIFY_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 verify_var = {
144         &be_options.verify_option, verify_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 ("verify",     "verify the backend irg",                              &verify_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(&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(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         run_once = 1;
323
324         be_grp = lc_opt_get_grp(firm_opt_get_root(), "be");
325         lc_opt_add_table(be_grp, be_main_options);
326
327         be_add_module_list_opt(be_grp, "isa", "the instruction set architecture",
328                                &isa_ifs, (void**) &isa_if);
329
330         be_init_modules();
331 }
332
333 /* Parse one argument. */
334 int be_parse_arg(const char *arg)
335 {
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_for_entry(be_grp, '-', stdout);
339                 return -1;
340         }
341         return lc_opt_from_single_arg(be_grp, NULL, arg, NULL);
342 }
343
344 /* Perform schedule verification if requested. */
345 static void be_sched_verify(ir_graph *irg, int verify_opt)
346 {
347         if (verify_opt == BE_VERIFY_WARN) {
348                 be_verify_schedule(irg);
349         } else if (verify_opt == BE_VERIFY_ASSERT) {
350                 assert(be_verify_schedule(irg) && "Schedule verification failed.");
351         }
352 }
353
354 /* Initialize the Firm backend. Must be run first in init_firm()! */
355 void firm_be_init(void)
356 {
357         be_opt_register();
358         be_init_modules();
359 }
360
361 /* Finalize the Firm backend. */
362 void firm_be_finish(void)
363 {
364         be_quit_modules();
365 }
366
367 /* Returns the backend parameter */
368 const backend_params *be_get_backend_param(void)
369 {
370         return isa_if->get_params();
371 }
372
373 /**
374  * Initializes the main environment for the backend.
375  *
376  * @param env          an empty environment
377  * @param file_handle  the file handle where the output will be written to
378  */
379 static be_main_env_t *be_init_env(be_main_env_t *env, FILE *file_handle)
380 {
381         memset(env, 0, sizeof(*env));
382         env->options              = &be_options;
383         env->ent_trampoline_map   = pmap_create();
384         env->pic_trampolines_type = new_type_class(NEW_ID("$PIC_TRAMPOLINE_TYPE"));
385         env->ent_pic_symbol_map   = pmap_create();
386         env->pic_symbols_type     = new_type_struct(NEW_ID("$PIC_SYMBOLS_TYPE"));
387
388         remove_irp_type(env->pic_trampolines_type);
389         remove_irp_type(env->pic_symbols_type);
390         set_class_final(env->pic_trampolines_type, 1);
391
392         memset(asm_constraint_flags, 0, sizeof(asm_constraint_flags));
393         env->arch_env = arch_env_init(isa_if, file_handle, env);
394
395         be_dbg_open();
396         return env;
397 }
398
399 /**
400  * Called when the be_main_env_t can be destroyed.
401  */
402 static void be_done_env(be_main_env_t *env)
403 {
404         arch_env_done(env->arch_env);
405         be_dbg_close();
406
407         pmap_destroy(env->ent_trampoline_map);
408         pmap_destroy(env->ent_pic_symbol_map);
409         free_type(env->pic_trampolines_type);
410         free_type(env->pic_symbols_type);
411 }
412
413 /**
414  * A wrapper around a firm dumper. Dumps only, if
415  * flags are enabled.
416  *
417  * @param mask    a bitmask containing the reason what will be dumped
418  * @param irg     the IR graph to dump
419  * @param suffix  the suffix for the dumper
420  * @param dumper  the dumper to be called
421  */
422 static void dump(int mask, ir_graph *irg, const char *suffix)
423 {
424         if (be_options.dump_flags & mask)
425                 dump_ir_graph(irg, suffix);
426 }
427
428 /**
429  * Prepare a backend graph for code generation and initialize its irg
430  */
431 static void initialize_birg(be_irg_t *birg, ir_graph *irg, be_main_env_t *env)
432 {
433         /* don't duplicate locals in backend when dumping... */
434         ir_remove_dump_flags(ir_dump_flag_consts_local);
435
436         dump(DUMP_INITIAL, irg, "begin");
437
438         irg->be_data = birg;
439
440         memset(birg, 0, sizeof(*birg));
441         birg->irg = irg;
442         birg->main_env = env;
443         obstack_init(&birg->obst);
444
445         edges_deactivate_kind(irg, EDGE_KIND_DEP);
446         edges_activate_kind(irg, EDGE_KIND_DEP);
447
448         /* set the current graph (this is important for several firm functions) */
449         current_ir_graph = irg;
450
451         /* we do this before critical edge split. As this produces less returns,
452            because sometimes (= 164.gzip) multiple returns are slower */
453         normalize_n_returns(irg);
454
455         /* Remove critical edges */
456         remove_critical_cf_edges_ex(irg, /*ignore_exception_edges=*/0);
457
458         /* Ensure, that the ir_edges are computed. */
459         edges_assure(irg);
460
461         set_irg_phase_state(irg, phase_backend);
462         be_info_init_irg(irg);
463
464         dump(DUMP_INITIAL, irg, "prepared");
465 }
466
467 #define BE_TIMER_ONLY(code)   do { if (be_timing) { code; } } while (0)
468
469 int be_timing;
470
471 static const char *get_timer_name(be_timer_id_t id)
472 {
473         switch (id) {
474         case T_ABI:            return "abi";
475         case T_CODEGEN:        return "codegen";
476         case T_RA_PREPARATION: return "ra_preparation";
477         case T_SCHED:          return "sched";
478         case T_CONSTR:         return "constr";
479         case T_FINISH:         return "finish";
480         case T_EMIT:           return "emit";
481         case T_VERIFY:         return "verify";
482         case T_OTHER:          return "other";
483         case T_HEIGHTS:        return "heights";
484         case T_LIVE:           return "live";
485         case T_EXECFREQ:       return "execfreq";
486         case T_SSA_CONSTR:     return "ssa_constr";
487         case T_RA_PROLOG:      return "ra_prolog";
488         case T_RA_EPILOG:      return "ra_epilog";
489         case T_RA_CONSTR:      return "ra_constr";
490         case T_RA_SPILL:       return "ra_spill";
491         case T_RA_SPILL_APPLY: return "ra_spill_apply";
492         case T_RA_COLOR:       return "ra_color";
493         case T_RA_IFG:         return "ra_ifg";
494         case T_RA_COPYMIN:     return "ra_copymin";
495         case T_RA_SSA:         return "ra_ssa";
496         case T_RA_OTHER:       return "ra_other";
497         }
498         return "unknown";
499 }
500 ir_timer_t *be_timers[T_LAST+1];
501
502 /**
503  * The Firm backend main loop.
504  * Do architecture specific lowering for all graphs
505  * and call the architecture specific code generator.
506  *
507  * @param file_handle   the file handle the output will be written to
508  * @param cup_name      name of the compilation unit
509  */
510 static void be_main_loop(FILE *file_handle, const char *cup_name)
511 {
512         static const char suffix[] = ".prof";
513
514         int           i, num_birgs, stat_active = 0;
515         be_main_env_t env;
516         char          prof_filename[256];
517         be_irg_t      *birgs;
518         ir_graph      **irg_list, **backend_irg_list;
519         arch_env_t    *arch_env;
520
521         be_timing = (be_options.timing == BE_TIME_ON);
522
523         if (be_timing) {
524                 for (i = 0; i < T_LAST+1; ++i) {
525                         be_timers[i] = ir_timer_new();
526                 }
527         }
528
529         be_init_env(&env, file_handle);
530         env.cup_name = cup_name;
531
532         be_dbg_so(cup_name);
533         be_dbg_types();
534
535         arch_env = env.arch_env;
536
537         /* backend may provide an ordered list of irgs where code should be
538          * generated for */
539         irg_list         = NEW_ARR_F(ir_graph *, 0);
540         backend_irg_list = arch_env_get_backend_irg_list(arch_env, &irg_list);
541
542         /* we might need 1 birg more for instrumentation constructor */
543         num_birgs = backend_irg_list ? ARR_LEN(backend_irg_list) : get_irp_n_irgs();
544         birgs     = ALLOCAN(be_irg_t, num_birgs + 1);
545
546         be_info_init();
547
548         /* First: initialize all birgs */
549         for (i = 0; i < num_birgs; ++i) {
550                 ir_graph *irg = backend_irg_list ? backend_irg_list[i] : get_irp_irg(i);
551                 initialize_birg(&birgs[i], irg, &env);
552         }
553         arch_env_handle_intrinsics(arch_env);
554         DEL_ARR_F(irg_list);
555
556         /*
557                 Get the filename for the profiling data.
558                 Beware: '\0' is already included in sizeof(suffix)
559         */
560         memset(prof_filename, 0, sizeof(prof_filename));
561         strncpy(prof_filename, cup_name, sizeof(prof_filename) - sizeof(suffix));
562         strcat(prof_filename, suffix);
563
564         /*
565                 Next: Either instruments all irgs with profiling code
566                 or try to read in profile data for current translation unit.
567         */
568         if (be_options.opt_profile) {
569                 ir_graph *prof_init_irg = ir_profile_instrument(prof_filename, profile_default);
570                 initialize_birg(&birgs[num_birgs], prof_init_irg, &env);
571                 num_birgs++;
572         } else {
573                 ir_profile_read(prof_filename);
574         }
575
576 #ifdef FIRM_STATISTICS
577         stat_active = stat_is_active();
578 #endif /* FIRM_STATISTICS */
579
580         /* For all graphs */
581         for (i = 0; i < num_birgs; ++i) {
582                 be_irg_t *birg = &birgs[i];
583                 ir_graph *irg  = birg->irg;
584                 optimization_state_t state;
585                 const arch_code_generator_if_t *cg_if;
586
587                 /* set the current graph (this is important for several firm functions) */
588                 current_ir_graph = irg;
589
590                 stat_ev_if {
591                         stat_ev_ctx_push_fobj("bemain_irg", irg);
592                         be_stat_ev("bemain_insns_start", be_count_insns(irg));
593                         be_stat_ev("bemain_blocks_start", be_count_blocks(irg));
594                 }
595
596                 /* stop and reset timers */
597                 be_timer_push(T_OTHER);
598
599                 /* Verify the initial graph */
600                 be_timer_push(T_VERIFY);
601                 if (be_options.verify_option == BE_VERIFY_WARN) {
602                         irg_verify(irg, VERIFY_ENFORCE_SSA);
603                         be_check_dominance(irg);
604                 } else if (be_options.verify_option == BE_VERIFY_ASSERT) {
605                         assert(irg_verify(irg, VERIFY_ENFORCE_SSA) && "irg verification failed");
606                         assert(be_check_dominance(irg) && "Dominance verification failed");
607                 }
608                 be_timer_pop(T_VERIFY);
609
610                 /* Get the code generator interface. */
611                 cg_if = arch_env_get_code_generator_if(arch_env);
612
613                 /* get a code generator for this graph. */
614                 birg->cg = cg_if->init(irg);
615
616                 /* some transformations need to be done before abi introduce */
617                 assert(birg->cg->impl->before_abi == NULL || !arch_env->custom_abi);
618                 arch_code_generator_before_abi(birg->cg);
619
620                 /* implement the ABI conventions. */
621                 be_timer_push(T_ABI);
622                 be_abi_introduce(irg);
623                 be_timer_pop(T_ABI);
624
625                 if (!arch_env->custom_abi) {
626                         dump(DUMP_ABI, irg, "abi");
627                 }
628
629                 /* we have to do cfopt+remove_critical_edges as we can't have Bad-blocks
630                  * or critical edges in the backend */
631                 optimize_cf(irg);
632                 remove_critical_cf_edges(irg);
633
634                 /* We often have dead code reachable through out-edges here. So for
635                  * now we rebuild edges (as we need correct user count for code
636                  * selection) */
637                 edges_deactivate(irg);
638                 edges_activate(irg);
639
640                 dump(DUMP_PREPARED, irg, "before-code-selection");
641
642                 if (be_options.verify_option == BE_VERIFY_WARN) {
643                         be_check_dominance(irg);
644                 } else if (be_options.verify_option == BE_VERIFY_ASSERT) {
645                         assert(be_check_dominance(irg) && "Dominance verification failed");
646                 }
647
648                 /* perform codeselection */
649                 be_timer_push(T_CODEGEN);
650                 arch_code_generator_prepare_graph(birg->cg);
651                 be_timer_pop(T_CODEGEN);
652
653                 if (be_options.verify_option == BE_VERIFY_WARN) {
654                         be_check_dominance(irg);
655                 } else if (be_options.verify_option == BE_VERIFY_ASSERT) {
656                         assert(be_check_dominance(irg) && "Dominance verification failed");
657                 }
658
659                 be_timer_push(T_EXECFREQ);
660                 /**
661                  * Create execution frequencies from profile data or estimate some
662                  */
663                 if (ir_profile_has_data())
664                         birg->exec_freq = ir_create_execfreqs_from_profile(irg);
665                 else {
666                         /* TODO: edges are corrupt for EDGE_KIND_BLOCK after the local
667                          * optimize graph phase merges blocks in the x86 backend */
668                         edges_deactivate(irg);
669                         birg->exec_freq = compute_execfreq(irg, 10);
670                 }
671                 be_timer_pop(T_EXECFREQ);
672
673
674                 /* disabled for now, fails for EmptyFor.c and XXEndless.c */
675                 /* be_live_chk_compare(irg); */
676
677                 /* schedule the irg */
678                 be_timer_push(T_SCHED);
679                 switch (be_options.scheduler) {
680                         default:
681                                 fprintf(stderr, "Warning: invalid scheduler (%d) selected, falling back to list scheduler.\n", be_options.scheduler);
682                         case BE_SCHED_LIST:
683                                 list_sched(irg);
684                                 break;
685 #ifdef WITH_ILP
686                         case BE_SCHED_ILP:
687                                 be_ilp_sched(irg);
688                                 break;
689 #endif /* WITH_ILP */
690                 };
691                 be_timer_pop(T_SCHED);
692
693                 dump(DUMP_SCHED, irg, "sched");
694
695                 /* check schedule */
696                 be_timer_push(T_VERIFY);
697                 be_sched_verify(irg, be_options.verify_option);
698                 be_timer_pop(T_VERIFY);
699
700                 /* introduce patterns to assure constraints */
701                 be_timer_push(T_CONSTR);
702                 /* we switch off optimizations here, because they might cause trouble */
703                 save_optimization_state(&state);
704                 set_optimize(0);
705                 set_opt_normalize(0);
706                 set_opt_cse(0);
707
708                 /* add Keeps for should_be_different constrained nodes  */
709                 /* beware: needs schedule due to usage of be_ssa_constr */
710                 assure_constraints(irg);
711                 be_timer_pop(T_CONSTR);
712
713                 dump(DUMP_SCHED, irg, "assured");
714
715                 /* stuff needs to be done after scheduling but before register allocation */
716                 be_timer_push(T_RA_PREPARATION);
717                 arch_code_generator_before_ra(birg->cg);
718                 be_timer_pop(T_RA_PREPARATION);
719
720                 /* connect all stack modifying nodes together (see beabi.c) */
721                 be_timer_push(T_ABI);
722                 be_abi_fix_stack_nodes(irg);
723                 be_timer_pop(T_ABI);
724
725                 dump(DUMP_SCHED, irg, "fix_stack");
726
727                 /* check schedule */
728                 be_timer_push(T_VERIFY);
729                 be_sched_verify(irg, be_options.verify_option);
730                 be_timer_pop(T_VERIFY);
731
732                 stat_ev_if {
733                         stat_ev_dbl("bemain_costs_before_ra",
734                                         be_estimate_irg_costs(irg, birg->exec_freq));
735                         be_stat_ev("bemain_insns_before_ra", be_count_insns(irg));
736                         be_stat_ev("bemain_blocks_before_ra", be_count_blocks(irg));
737                 }
738
739                 /* Do register allocation */
740                 be_allocate_registers(irg);
741
742 #ifdef FIRM_STATISTICS
743                 stat_ev_dbl("bemain_costs_before_ra", be_estimate_irg_costs(irg, birg->exec_freq));
744 #endif
745
746                 dump(DUMP_RA, irg, "ra");
747
748                 /* let the code generator prepare the graph for emitter */
749                 be_timer_push(T_FINISH);
750                 arch_code_generator_after_ra(birg->cg);
751                 be_timer_pop(T_FINISH);
752
753                 /* fix stack offsets */
754                 be_timer_push(T_ABI);
755                 be_abi_fix_stack_nodes(irg);
756                 be_remove_dead_nodes_from_schedule(irg);
757                 be_abi_fix_stack_bias(irg);
758                 be_timer_pop(T_ABI);
759
760                 dump(DUMP_SCHED, irg, "fix_stack_after_ra");
761
762                 be_timer_push(T_FINISH);
763                 arch_code_generator_finish(birg->cg);
764                 be_timer_pop(T_FINISH);
765
766                 dump(DUMP_FINAL, irg, "finish");
767
768                 stat_ev_if {
769                         be_stat_ev("bemain_insns_finish", be_count_insns(irg));
770                         be_stat_ev("bemain_blocks_finish", be_count_blocks(irg));
771                 }
772
773                 /* check schedule and register allocation */
774                 be_timer_push(T_VERIFY);
775                 if (be_options.verify_option == BE_VERIFY_WARN) {
776                         irg_verify(irg, VERIFY_ENFORCE_SSA);
777                         be_check_dominance(irg);
778                         be_verify_schedule(irg);
779                         be_verify_register_allocation(irg);
780                 } else if (be_options.verify_option == BE_VERIFY_ASSERT) {
781                         assert(irg_verify(irg, VERIFY_ENFORCE_SSA) && "irg verification failed");
782                         assert(be_check_dominance(irg) && "Dominance verification failed");
783                         assert(be_verify_schedule(irg) && "Schedule verification failed");
784                         assert(be_verify_register_allocation(irg)
785                                && "register allocation verification failed");
786
787                 }
788                 be_timer_pop(T_VERIFY);
789
790                 /* emit assembler code */
791                 be_timer_push(T_EMIT);
792                 arch_code_generator_done(birg->cg);
793                 be_timer_pop(T_EMIT);
794
795                 dump(DUMP_FINAL, irg, "end");
796
797                 be_timer_push(T_ABI);
798                 be_abi_free(irg);
799                 be_timer_pop(T_ABI);
800
801                 restore_optimization_state(&state);
802
803                 be_timer_pop(T_OTHER);
804
805                 if (be_timing) {
806                         int t;
807                         if (stat_ev_enabled) {
808                                 for (t = 0; t < T_LAST+1; ++t) {
809                                         char buf[128];
810                                         snprintf(buf, sizeof(buf), "bemain_time_%s",
811                                                  get_timer_name(t));
812                                         stat_ev_dbl(buf, ir_timer_elapsed_usec(be_timers[i]));
813                                 }
814                         } else {
815                                 printf("==>> IRG %s <<==\n",
816                                        get_entity_name(get_irg_entity(irg)));
817                                 for (t = 0; t < T_LAST+1; ++t) {
818                                         double val = ir_timer_elapsed_usec(be_timers[t]) / 1000.0;
819                                         printf("%-20s: %8.3lf msec\n", get_timer_name(t), val);
820                                 }
821                         }
822                         for (t = 0; t < T_LAST+1; ++t) {
823                                 ir_timer_stop(be_timers[t]);
824                                 ir_timer_reset(be_timers[t]);
825                         }
826                 }
827
828                 be_free_birg(irg);
829                 stat_ev_ctx_pop("bemain_irg");
830         }
831         ir_profile_free();
832         be_done_env(&env);
833
834         be_info_free();
835 }
836
837 /* Main interface to the frontend. */
838 void be_main(FILE *file_handle, const char *cup_name)
839 {
840         ir_timer_t *t = NULL;
841
842         /* The user specified another config file to read. do that now. */
843         if (config_file[0] != '\0') {
844                 FILE *f = fopen(config_file, "rt");
845
846                 if (f != NULL) {
847                         lc_opt_from_file(config_file, f, NULL);
848                         fclose(f);
849                 } else {
850                         fprintf(stderr, "Warning: Cannot open config file '%s'\n", config_file);
851                 }
852         }
853
854         if (be_options.timing == BE_TIME_ON) {
855                 t = ir_timer_new();
856
857                 if (ir_timer_enter_high_priority()) {
858                         fprintf(stderr, "Warning: Could not enter high priority mode.\n");
859                 }
860
861                 ir_timer_reset_and_start(t);
862         }
863
864 #ifdef FIRM_STATISTICS
865         if (be_options.statev) {
866                 const char *dot = strrchr(cup_name, '.');
867                 const char *pos = dot ? dot : cup_name + strlen(cup_name);
868                 char       *buf = ALLOCAN(char, pos - cup_name + 1);
869                 strncpy(buf, cup_name, pos - cup_name);
870                 buf[pos - cup_name] = '\0';
871
872                 be_options.statev = 1;
873                 stat_ev_begin(buf, be_options.filtev);
874                 stat_ev_ctx_push_str("bemain_compilation_unit", cup_name);
875         }
876 #endif
877
878         be_main_loop(file_handle, cup_name);
879
880         if (be_options.timing == BE_TIME_ON) {
881                 ir_timer_stop(t);
882                 ir_timer_leave_high_priority();
883                 stat_ev_if {
884                         stat_ev_dbl("bemain_backend_time", ir_timer_elapsed_msec(t));
885                 } else {
886                         double val = ir_timer_elapsed_usec(t) / 1000.0;
887                         printf("%-20s: %8.3lf msec\n", "BEMAINLOOP", val);
888                 }
889         }
890
891 #ifdef FIRM_STATISTICS
892         if (be_options.statev) {
893                 stat_ev_ctx_pop("bemain_compilation_unit");
894                 stat_ev_end();
895         }
896 #endif
897 }
898
899 static int do_lower_for_target(ir_prog *irp, void *context)
900 {
901         const backend_params *be_params = be_get_backend_param();
902         be_params->lower_for_target();
903         (void) context;
904         (void) irp;
905         return 0;
906 }
907
908 ir_prog_pass_t *lower_for_target_pass(const char *name)
909 {
910         ir_prog_pass_t *pass = XMALLOCZ(ir_prog_pass_t);
911         return def_prog_pass_constructor(pass,
912                                          name ? name : "lower_for_target",
913                                          do_lower_for_target);
914 }
915
916 unsigned be_put_ignore_regs(const ir_graph *irg,
917                             const arch_register_class_t *cls, bitset_t *bs)
918 {
919         if (bs == NULL)
920                 bs = bitset_alloca(cls->n_regs);
921         else
922                 bitset_clear_all(bs);
923
924         assert(bitset_size(bs) == cls->n_regs);
925         arch_put_non_ignore_regs(cls, bs);
926         bitset_flip_all(bs);
927         be_abi_put_ignore_regs(be_get_irg_abi(irg), cls, bs);
928
929         return bitset_popcount(bs);
930 }