cb3bbb714d7479e8595d69a2653fdfb1a37cddf9
[libfirm] / ir / be / bemain.c
1 /*
2  * Copyright (C) 1995-2008 University of Karlsruhe.  All right reserved.
3  *
4  * This file is part of libFirm.
5  *
6  * This file may be distributed and/or modified under the terms of the
7  * GNU General Public License version 2 as published by the Free Software
8  * Foundation and appearing in the file LICENSE.GPL included in the
9  * packaging of this file.
10  *
11  * Licensees holding valid libFirm Professional Edition licenses may use
12  * this file in accordance with the libFirm Commercial License.
13  * Agreement provided with the Software.
14  *
15  * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
16  * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
17  * PURPOSE.
18  */
19
20 /**
21  * @file
22  * @brief       Main Backend driver.
23  * @author      Sebastian Hack
24  * @date        25.11.2004
25  * @version     $Id$
26  */
27 #ifdef HAVE_CONFIG_H
28 #include "config.h"
29 #endif
30
31 #include <stdarg.h>
32 #include <stdio.h>
33
34 #include "lc_opts.h"
35 #include "lc_opts_enum.h"
36
37 #include "obst.h"
38 #include "bitset.h"
39
40 #include "irprog.h"
41 #include "irgopt.h"
42 #include "irgraph.h"
43 #include "irdump.h"
44 #include "phiclass.h"
45 #include "irdom_t.h"
46 #include "iredges_t.h"
47 #include "irloop_t.h"
48 #include "irtools.h"
49 #include "irvrfy.h"
50 #include "irprintf.h"
51 #include "iroptimize.h"
52 #include "firmstat.h"
53 #include "execfreq.h"
54 #include "irprofile.h"
55
56 #include "bearch_t.h"
57 #include "be_t.h"
58 #include "bemodule.h"
59 #include "beutil.h"
60 #include "benode_t.h"
61 #include "beirgmod.h"
62 #include "besched_t.h"
63 #include "belistsched.h"
64 #include "belive_t.h"
65 #include "bera.h"
66 #include "bechordal_t.h"
67 #include "beifg.h"
68 #include "beifg_impl.h"
69 #include "becopyopt.h"
70 #include "becopystat.h"
71 #include "bessadestr.h"
72 #include "beabi.h"
73 #include "belower.h"
74 #include "beschedmris.h"
75 #include "bestat.h"
76 #include "beverify.h"
77 #include "be_dbgout.h"
78 #include "beirg_t.h"
79
80 #define NEW_ID(s) new_id_from_chars(s, sizeof(s) - 1)
81
82 #ifdef WITH_ILP
83 #include "beilpsched.h"
84 #endif /* WITH_ILP */
85
86 /* options visible for anyone */
87 static be_options_t be_options = {
88         DUMP_NONE,                         /* dump flags */
89         BE_TIME_OFF,                       /* no timing */
90         0,                                 /* no opt profile */
91         0,                                 /* try to omit frame pointer */
92         0,                                 /* try to omit leaf frame pointer */
93         0,                                 /* create PIC code */
94         0,                                 /* create gprof compatible profiling code */
95         BE_VRFY_WARN,                      /* verification level: warn */
96         BE_SCHED_LIST,                     /* scheduler: list scheduler */
97         "linux",                           /* target OS name */
98         "i44pc52.info.uni-karlsruhe.de",   /* ilp server */
99         "cplex",                           /* ilp solver */
100         0,                                 /* enable statistic event dumping */
101         "",                                /* print stat events */
102 };
103
104 /* config file. */
105 static char config_file[256] = { 0 };
106
107 /* back end instruction set architecture to use */
108 static const arch_isa_if_t *isa_if = NULL;
109
110 /* possible dumping options */
111 static const lc_opt_enum_mask_items_t dump_items[] = {
112         { "none",       DUMP_NONE },
113         { "initial",    DUMP_INITIAL },
114         { "abi",        DUMP_ABI    },
115         { "sched",      DUMP_SCHED  },
116         { "prepared",   DUMP_PREPARED },
117         { "regalloc",   DUMP_RA },
118         { "final",      DUMP_FINAL },
119         { "be",         DUMP_BE },
120         { "all",        2 * DUMP_BE - 1 },
121         { NULL,         0 }
122 };
123
124 /* verify options. */
125 static const lc_opt_enum_int_items_t vrfy_items[] = {
126         { "off",    BE_VRFY_OFF    },
127         { "warn",   BE_VRFY_WARN   },
128         { "assert", BE_VRFY_ASSERT },
129         { NULL,     0 }
130 };
131
132 /* scheduling options. */
133 static const lc_opt_enum_int_items_t sched_items[] = {
134         { "list", BE_SCHED_LIST },
135 #ifdef WITH_ILP
136         { "ilp",  BE_SCHED_ILP  },
137 #endif /* WITH_ILP */
138         { NULL,   0 }
139 };
140
141 static lc_opt_enum_mask_var_t dump_var = {
142         &be_options.dump_flags, dump_items
143 };
144
145 static lc_opt_enum_int_var_t vrfy_var = {
146         &be_options.vrfy_option, vrfy_items
147 };
148
149 static lc_opt_enum_int_var_t sched_var = {
150         &be_options.scheduler, sched_items
151 };
152
153 static const lc_opt_table_entry_t be_main_options[] = {
154         LC_OPT_ENT_STR      ("config",     "read another config file containing backend options", config_file, sizeof(config_file)),
155         LC_OPT_ENT_ENUM_MASK("dump",       "dump irg on several occasions",                       &dump_var),
156         LC_OPT_ENT_BOOL     ("omitfp",     "omit frame pointer",                                  &be_options.omit_fp),
157         LC_OPT_ENT_BOOL     ("omitleaffp", "omit frame pointer in leaf routines",                 &be_options.omit_leaf_fp),
158         LC_OPT_ENT_BOOL     ("pic",        "create PIC code",                                     &be_options.pic),
159         LC_OPT_ENT_BOOL     ("gprof",      "create gprof profiling code",                         &be_options.gprof),
160         LC_OPT_ENT_ENUM_PTR ("vrfy",       "verify the backend irg",                              &vrfy_var),
161         LC_OPT_ENT_BOOL     ("time",       "get backend timing statistics",                       &be_options.timing),
162         LC_OPT_ENT_BOOL     ("profile",    "instrument the code for execution count profiling",   &be_options.opt_profile),
163         LC_OPT_ENT_ENUM_PTR ("sched",      "select a scheduler",                                  &sched_var),
164         LC_OPT_ENT_STR      ("os",         "specify target operating system",                     &be_options.target_os, sizeof(be_options.target_os)),
165 #ifdef FIRM_STATISTICS
166         LC_OPT_ENT_BOOL     ("statev",     "dump statistic events",                               &be_options.statev),
167         LC_OPT_ENT_STR      ("filtev",     "filter for stat events (regex if support is active",  &be_options.filtev, sizeof(be_options.filtev)),
168 #endif
169
170 #ifdef WITH_ILP
171         LC_OPT_ENT_STR ("ilp.server", "the ilp server name", be_options.ilp_server, sizeof(be_options.ilp_server)),
172         LC_OPT_ENT_STR ("ilp.solver", "the ilp solver name", be_options.ilp_solver, sizeof(be_options.ilp_solver)),
173 #endif /* WITH_ILP */
174         LC_OPT_LAST
175 };
176
177 static be_module_list_entry_t *isa_ifs = NULL;
178
179
180 unsigned short asm_constraint_flags[256];
181
182 void be_init_default_asm_constraint_flags(void)
183 {
184         asm_constraint_flags['?'] = ASM_CONSTRAINT_FLAG_NO_SUPPORT;
185         asm_constraint_flags['!'] = ASM_CONSTRAINT_FLAG_NO_SUPPORT;
186         asm_constraint_flags['&'] = ASM_CONSTRAINT_FLAG_NO_SUPPORT
187                 | ASM_CONSTRAINT_FLAG_MODIFIER_EARLYCLOBBER;
188         asm_constraint_flags['%'] = ASM_CONSTRAINT_FLAG_NO_SUPPORT
189                 | ASM_CONSTRAINT_FLAG_MODIFIER_COMMUTATIVE;
190         asm_constraint_flags['!'] = ASM_CONSTRAINT_FLAG_NO_SUPPORT;
191
192         asm_constraint_flags['='] = ASM_CONSTRAINT_FLAG_MODIFIER_WRITE
193                 | ASM_CONSTRAINT_FLAG_MODIFIER_NO_READ;
194         asm_constraint_flags['+'] = ASM_CONSTRAINT_FLAG_MODIFIER_READ
195                 | ASM_CONSTRAINT_FLAG_MODIFIER_WRITE;
196
197         asm_constraint_flags['i'] = ASM_CONSTRAINT_FLAG_SUPPORTS_IMMEDIATE;
198         asm_constraint_flags['s'] = ASM_CONSTRAINT_FLAG_SUPPORTS_IMMEDIATE;
199         asm_constraint_flags['E'] = ASM_CONSTRAINT_FLAG_SUPPORTS_IMMEDIATE;
200         asm_constraint_flags['F'] = ASM_CONSTRAINT_FLAG_SUPPORTS_IMMEDIATE;
201         asm_constraint_flags['G'] = ASM_CONSTRAINT_FLAG_SUPPORTS_IMMEDIATE;
202         asm_constraint_flags['H'] = ASM_CONSTRAINT_FLAG_SUPPORTS_IMMEDIATE;
203         asm_constraint_flags['I'] = ASM_CONSTRAINT_FLAG_SUPPORTS_IMMEDIATE;
204         asm_constraint_flags['J'] = ASM_CONSTRAINT_FLAG_SUPPORTS_IMMEDIATE;
205         asm_constraint_flags['K'] = ASM_CONSTRAINT_FLAG_SUPPORTS_IMMEDIATE;
206         asm_constraint_flags['L'] = ASM_CONSTRAINT_FLAG_SUPPORTS_IMMEDIATE;
207         asm_constraint_flags['M'] = ASM_CONSTRAINT_FLAG_SUPPORTS_IMMEDIATE;
208         asm_constraint_flags['N'] = ASM_CONSTRAINT_FLAG_SUPPORTS_IMMEDIATE;
209         asm_constraint_flags['O'] = ASM_CONSTRAINT_FLAG_SUPPORTS_IMMEDIATE;
210         asm_constraint_flags['P'] = ASM_CONSTRAINT_FLAG_SUPPORTS_IMMEDIATE;
211
212         asm_constraint_flags['m'] = ASM_CONSTRAINT_FLAG_SUPPORTS_MEMOP;
213         asm_constraint_flags['o'] = ASM_CONSTRAINT_FLAG_SUPPORTS_MEMOP;
214         asm_constraint_flags['V'] = ASM_CONSTRAINT_FLAG_SUPPORTS_MEMOP;
215         asm_constraint_flags['<'] = ASM_CONSTRAINT_FLAG_SUPPORTS_MEMOP;
216         asm_constraint_flags['>'] = ASM_CONSTRAINT_FLAG_SUPPORTS_MEMOP;
217
218         asm_constraint_flags['p'] = ASM_CONSTRAINT_FLAG_SUPPORTS_REGISTER;
219         asm_constraint_flags['0'] = ASM_CONSTRAINT_FLAG_SUPPORTS_REGISTER;
220         asm_constraint_flags['1'] = ASM_CONSTRAINT_FLAG_SUPPORTS_REGISTER;
221         asm_constraint_flags['2'] = ASM_CONSTRAINT_FLAG_SUPPORTS_REGISTER;
222         asm_constraint_flags['3'] = ASM_CONSTRAINT_FLAG_SUPPORTS_REGISTER;
223         asm_constraint_flags['4'] = ASM_CONSTRAINT_FLAG_SUPPORTS_REGISTER;
224         asm_constraint_flags['5'] = ASM_CONSTRAINT_FLAG_SUPPORTS_REGISTER;
225         asm_constraint_flags['6'] = ASM_CONSTRAINT_FLAG_SUPPORTS_REGISTER;
226         asm_constraint_flags['7'] = ASM_CONSTRAINT_FLAG_SUPPORTS_REGISTER;
227         asm_constraint_flags['8'] = ASM_CONSTRAINT_FLAG_SUPPORTS_REGISTER;
228         asm_constraint_flags['9'] = ASM_CONSTRAINT_FLAG_SUPPORTS_REGISTER;
229
230         asm_constraint_flags['X'] = ASM_CONSTRAINT_FLAG_SUPPORTS_REGISTER
231                 | ASM_CONSTRAINT_FLAG_SUPPORTS_MEMOP
232                 | ASM_CONSTRAINT_FLAG_SUPPORTS_IMMEDIATE;
233
234         /* these should have been catched by the parsing code already */
235         asm_constraint_flags['#']  = ASM_CONSTRAINT_FLAG_NO_SUPPORT;
236         asm_constraint_flags['*']  = ASM_CONSTRAINT_FLAG_NO_SUPPORT;
237         asm_constraint_flags[' ']  = ASM_CONSTRAINT_FLAG_NO_SUPPORT;
238         asm_constraint_flags['\t'] = ASM_CONSTRAINT_FLAG_NO_SUPPORT;
239         asm_constraint_flags['\n'] = ASM_CONSTRAINT_FLAG_NO_SUPPORT;
240         asm_constraint_flags['\r'] = ASM_CONSTRAINT_FLAG_NO_SUPPORT;
241 }
242
243 asm_constraint_flags_t parse_asm_constraints(const char *constraint)
244 {
245         const char             *c;
246         asm_constraint_flags_t  flags;
247         asm_constraint_flags_t  tflags;
248
249         for (c = constraint; *c != '\0'; ++c) {
250                 switch (*c) {
251                 case '#':
252                         /* 'comment' stuff */
253                         while(*c != 0 && *c != ',')
254                                 ++c;
255                         break;
256                 case '*':
257                         /* 'comment' character */
258                         ++c;
259                         break;
260                 case ' ':
261                 case '\t':
262                 case '\n':
263                 case '\r':
264                         break;
265                 default:
266                         tflags = asm_constraint_flags[(int) *c];
267                         if (tflags != 0) {
268                                 flags |= tflags;
269                         } else {
270                                 flags |= isa_if->parse_asm_constraint(isa_if, &c);
271                         }
272                         break;
273                 }
274         }
275
276         if ( ((flags & ASM_CONSTRAINT_FLAG_MODIFIER_WRITE)
277                         && (flags & ASM_CONSTRAINT_FLAG_MODIFIER_NO_WRITE))
278                 || ((flags & ASM_CONSTRAINT_FLAG_MODIFIER_READ
279                         && (flags & ASM_CONSTRAINT_FLAG_MODIFIER_NO_READ)))) {
280                 flags |= ASM_CONSTRAINT_FLAG_INVALID;
281         }
282
283         return flags;
284 }
285
286 bool is_valid_clobber(const char *clobber)
287 {
288         /* memory is a valid clobber. (the frontend has to detect this case too,
289          * because it has to add memory edges to the asm) */
290         if (strcmp(clobber, "memory") == 0)
291                 return true;
292
293         return isa_if->is_valid_clobber(isa_if, clobber);
294 }
295
296 void be_register_isa_if(const char *name, const arch_isa_if_t *isa)
297 {
298         if (isa_if == NULL)
299                 isa_if = isa;
300
301         be_add_module_to_list(&isa_ifs, name, (void*) isa);
302 }
303
304 void be_opt_register(void)
305 {
306         lc_opt_entry_t *be_grp;
307         static int run_once = 0;
308
309         if (run_once) {
310                 return;
311         }
312         run_once     = 1;
313
314         be_init_modules();
315
316         be_grp = lc_opt_get_grp(firm_opt_get_root(), "be");
317         lc_opt_add_table(be_grp, be_main_options);
318
319         be_add_module_list_opt(be_grp, "isa", "the instruction set architecture",
320                                &isa_ifs, (void**) &isa_if);
321 }
322
323 /* Parse one argument. */
324 int be_parse_arg(const char *arg) {
325         lc_opt_entry_t *be_grp = lc_opt_get_grp(firm_opt_get_root(), "be");
326         if (strcmp(arg, "help") == 0 || (arg[0] == '?' && arg[1] == '\0')) {
327                 lc_opt_print_help(be_grp, stdout);
328                 return -1;
329         }
330         return lc_opt_from_single_arg(be_grp, NULL, arg, NULL);
331 }
332
333 /** The be parameters returned by default, all off. */
334 static const backend_params be_params = {
335         0,    /* need dword lowering */
336         0,    /* don't support inline assembler yet */
337         0,     /* no immediate floating point mode. */
338         NULL, /* no additional opcodes */
339         NULL, /* will be set later */
340         NULL, /* but yet no creator function */
341         NULL, /* context for create_intrinsic_fkt */
342         NULL, /* no if conversion settings */
343         NULL   /* no immediate fp mode */
344 };
345
346 /* Perform schedule verification if requested. */
347 static void be_sched_vrfy(be_irg_t *birg, int vrfy_opt) {
348         if (vrfy_opt == BE_VRFY_WARN) {
349                 be_verify_schedule(birg);
350         } else if (vrfy_opt == BE_VRFY_ASSERT) {
351                 assert(be_verify_schedule(birg) && "Schedule verification failed.");
352         }
353 }
354
355 /* Initialize the Firm backend. Must be run first in init_firm()! */
356 void firm_be_init(void)
357 {
358         be_opt_register();
359         be_init_modules();
360 }
361
362 /* Returns the backend parameter */
363 const backend_params *be_get_backend_param(void)
364 {
365         if (isa_if->get_params)
366                 return isa_if->get_params();
367         return &be_params;
368 }
369
370 /**
371  * Initializes the main environment for the backend.
372  *
373  * @param env          an empty environment
374  * @param file_handle  the file handle where the output will be written to
375  */
376 static be_main_env_t *be_init_env(be_main_env_t *env, FILE *file_handle)
377 {
378         memset(env, 0, sizeof(*env));
379         env->options              = &be_options;
380         env->ent_trampoline_map   = pmap_create();
381         env->pic_trampolines_type = new_type_class(NEW_ID("$PIC_TRAMPOLINE_TYPE"));
382         env->ent_pic_symbol_map   = pmap_create();
383         env->pic_symbols_type     = new_type_struct(NEW_ID("$PIC_SYMBOLS_TYPE"));
384
385         remove_irp_type(env->pic_trampolines_type);
386         remove_irp_type(env->pic_symbols_type);
387         set_class_final(env->pic_trampolines_type, 1);
388
389         memset(asm_constraint_flags, 0, sizeof(asm_constraint_flags));
390         env->arch_env = arch_env_init(isa_if, file_handle, env);
391
392         be_phi_handler_new(env);
393
394         be_dbg_open();
395         return env;
396 }
397
398 /**
399  * Called when the be_main_env_t can be destroyed.
400  */
401 static void be_done_env(be_main_env_t *env)
402 {
403         arch_env_done(env->arch_env);
404         be_dbg_close();
405         be_phi_handler_free();
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                  void (*dumper)(ir_graph *, const char *))
424 {
425         if(be_options.dump_flags & mask)
426                 be_dump(irg, suffix, dumper);
427 }
428
429 /**
430  * Prepare a backend graph for code generation and initialize its birg
431  */
432 static void initialize_birg(be_irg_t *birg, ir_graph *irg, be_main_env_t *env)
433 {
434         memset(birg, 0, sizeof(*birg));
435         birg->irg = irg;
436         birg->main_env = env;
437
438         edges_deactivate_kind(irg, EDGE_KIND_DEP);
439         edges_activate_kind(irg, EDGE_KIND_DEP);
440
441         dump(DUMP_INITIAL, irg, "-begin", dump_ir_block_graph);
442
443         be_stat_init_irg(env->arch_env, irg);
444         be_do_stat_nodes(irg, "01 Begin");
445
446         /* set the current graph (this is important for several firm functions) */
447         current_ir_graph = irg;
448
449         /* Normalize proj nodes. */
450         normalize_proj_nodes(irg);
451
452         /* we do this before critical edge split. As this produces less returns,
453            because sometimes (= 164.gzip) multiple returns are slower */
454         normalize_n_returns(irg);
455
456         /* Remove critical edges */
457         remove_critical_cf_edges_ex(irg, /*ignore_exception_edges=*/0);
458
459         /* Ensure, that the ir_edges are computed. */
460         edges_assure(irg);
461
462         set_irg_phase_state(irg, phase_backend);
463
464         dump(DUMP_INITIAL, irg, "-prepared", dump_ir_block_graph);
465 }
466
467 #define BE_TIMER_ONLY(code)   do { if (be_timing) { code; } } while(0)
468
469 int be_timing;
470 ir_timer_t *t_abi;
471 ir_timer_t *t_codegen;
472 ir_timer_t *t_sched;
473 ir_timer_t *t_constr;
474 ir_timer_t *t_finish;
475 ir_timer_t *t_emit;
476 ir_timer_t *t_other;
477 ir_timer_t *t_verify;
478 ir_timer_t *t_heights;
479 ir_timer_t *t_live;
480 ir_timer_t *t_execfreq;
481 ir_timer_t *t_ssa_constr;
482 ir_timer_t *t_ra_constr;
483 ir_timer_t *t_ra_prolog;
484 ir_timer_t *t_ra_epilog;
485 ir_timer_t *t_ra_spill;
486 ir_timer_t *t_ra_spill_apply;
487 ir_timer_t *t_ra_color;
488 ir_timer_t *t_ra_ifg;
489 ir_timer_t *t_ra_copymin;
490 ir_timer_t *t_ra_ssa;
491 ir_timer_t *t_ra_other;
492
493 /**
494  * The Firm backend main loop.
495  * Do architecture specific lowering for all graphs
496  * and call the architecture specific code generator.
497  *
498  * @param file_handle   the file handle the output will be written to
499  * @param cup_name      name of the compilation unit
500  */
501 static void be_main_loop(FILE *file_handle, const char *cup_name)
502 {
503         int i;
504         be_main_env_t env;
505         char prof_filename[256];
506         static const char suffix[] = ".prof";
507         be_irg_t *birgs;
508         int num_birgs;
509         ir_graph **irg_list, **backend_irg_list;
510         arch_env_t *arch_env;
511
512         be_timing = (be_options.timing == BE_TIME_ON);
513
514         if (be_timing) {
515                 t_abi        = ir_timer_register("time_beabi",       "be abi introduction");
516                 t_codegen    = ir_timer_register("time_codegen",     "codegeneration");
517                 t_sched      = ir_timer_register("time_sched",       "scheduling");
518                 t_constr     = ir_timer_register("time_constr",      "assure constraints");
519                 t_finish     = ir_timer_register("time_finish",      "graph finish");
520                 t_emit       = ir_timer_register("time_emiter",      "code emiter");
521                 t_verify     = ir_timer_register("time_verify",      "graph verification");
522                 t_other      = ir_timer_register("time_other",       "other");
523                 t_heights    = ir_timer_register("time_heights",     "heights");
524                 t_live       = ir_timer_register("time_liveness",    "be liveness");
525                 t_execfreq   = ir_timer_register("time_execfreq",    "execfreq");
526                 t_ssa_constr = ir_timer_register("time_ssa_constr",  "ssa reconstruction");
527                 t_ra_prolog  = ir_timer_register("time_ra_prolog",   "regalloc prolog");
528                 t_ra_epilog  = ir_timer_register("time_ra_epilog",   "regalloc epilog");
529                 t_ra_constr  = ir_timer_register("time_ra_constr",   "regalloc constraints");
530                 t_ra_spill   = ir_timer_register("time_ra_spill",    "spiller");
531                 t_ra_spill_apply
532                         = ir_timer_register("time_ra_spill_apply", "apply spills");
533                 t_ra_color   = ir_timer_register("time_ra_color",    "graph coloring");
534                 t_ra_ifg     = ir_timer_register("time_ra_ifg",      "interference graph");
535                 t_ra_copymin = ir_timer_register("time_ra_copymin",  "copy minimization");
536                 t_ra_ssa     = ir_timer_register("time_ra_ssadestr", "ssa destruction");
537                 t_ra_other   = ir_timer_register("time_ra_other",    "regalloc other");
538         }
539
540         be_init_env(&env, file_handle);
541         env.cup_name = cup_name;
542
543         be_dbg_so(cup_name);
544         be_dbg_types();
545
546         arch_env = env.arch_env;
547
548         /* backend may provide an ordered list of irgs where code should be generated for */
549         irg_list         = NEW_ARR_F(ir_graph *, 0);
550         backend_irg_list = arch_env_get_backend_irg_list(arch_env, &irg_list);
551
552         /* we might need 1 birg more for instrumentation constructor */
553         num_birgs = backend_irg_list ? ARR_LEN(backend_irg_list) : get_irp_n_irgs();
554         birgs     = alloca(sizeof(birgs[0]) * (num_birgs + 1));
555
556         /* First: initialize all birgs */
557         for(i = 0; i < num_birgs; ++i) {
558                 ir_graph *irg = backend_irg_list ? backend_irg_list[i] : get_irp_irg(i);
559                 initialize_birg(&birgs[i], irg, &env);
560         }
561         DEL_ARR_F(irg_list);
562
563         /*
564                 Get the filename for the profiling data.
565                 Beware: '\0' is already included in sizeof(suffix)
566         */
567         memset(prof_filename, 0, sizeof(prof_filename));
568         strncpy(prof_filename, cup_name, sizeof(prof_filename) - sizeof(suffix));
569         strcat(prof_filename, suffix);
570
571         /*
572                 Next: Either instruments all irgs with profiling code
573                 or try to read in profile data for current translation unit.
574         */
575         if (be_options.opt_profile) {
576                 ir_graph *prof_init_irg = ir_profile_instrument(prof_filename, profile_default);
577                 initialize_birg(&birgs[num_birgs], prof_init_irg, &env);
578                 num_birgs++;
579         } else {
580                 ir_profile_read(prof_filename);
581         }
582
583         /* For all graphs */
584         for (i = 0; i < num_birgs; ++i) {
585                 be_irg_t *birg = &birgs[i];
586                 ir_graph *irg  = birg->irg;
587                 optimization_state_t state;
588                 const arch_code_generator_if_t *cg_if;
589
590                 /* set the current graph (this is important for several firm functions) */
591                 current_ir_graph = irg;
592
593 #if 0
594                 {
595                         unsigned percent = 100*i/num_birgs;
596                         ir_printf("%u.%02u %+F\n", percent/100, percent%100, irg);
597                 }
598 #endif
599                 be_sched_init_phase(irg);
600
601                 /* reset the phi handler. */
602                 be_phi_handler_reset();
603
604                 stat_ev_ctx_push_fobj("bemain_irg", irg);
605
606                 /* stop and reset timers */
607                 BE_TIMER_PUSH(t_other);   /* t_other */
608
609                 /* Verify the initial graph */
610                 BE_TIMER_PUSH(t_verify);
611                 if (be_options.vrfy_option == BE_VRFY_WARN) {
612                         irg_verify(irg, VRFY_ENFORCE_SSA);
613                         be_check_dominance(irg);
614                 } else if (be_options.vrfy_option == BE_VRFY_ASSERT) {
615                         assert(irg_verify(irg, VRFY_ENFORCE_SSA) && "irg verification failed");
616                         assert(be_check_dominance(irg) && "Dominance verification failed");
617                 }
618                 BE_TIMER_POP(t_verify);
619
620                 /* Get the code generator interface. */
621                 cg_if = arch_env_get_code_generator_if(arch_env);
622
623                 /* get a code generator for this graph. */
624                 birg->cg = cg_if->init(birg);
625
626                 /* some transformations need to be done before abi introduce */
627                 arch_code_generator_before_abi(birg->cg);
628
629                 /* implement the ABI conventions. */
630                 BE_TIMER_PUSH(t_abi);
631                 birg->abi = be_abi_introduce(birg);
632                 BE_TIMER_POP(t_abi);
633
634                 dump(DUMP_ABI, irg, "-abi", dump_ir_block_graph);
635                 be_do_stat_nodes(irg, "02 Abi");
636
637                 if (be_options.vrfy_option == BE_VRFY_WARN) {
638                         be_check_dominance(irg);
639                         be_verify_out_edges(irg);
640                 } else if (be_options.vrfy_option == BE_VRFY_ASSERT) {
641                         assert(be_verify_out_edges(irg));
642                         assert(be_check_dominance(irg) && "Dominance verification failed");
643                 }
644
645                 /* generate code */
646                 stat_ev_ctx_push_str("bemain_phase", "prepare");
647                 BE_TIMER_PUSH(t_codegen);
648                 arch_code_generator_prepare_graph(birg->cg);
649                 BE_TIMER_POP(t_codegen);
650                 stat_ev_ctx_pop("bemain_phase");
651
652                 /* reset the phi handler. */
653                 be_phi_handler_reset();
654
655                 be_do_stat_nodes(irg, "03 Prepare");
656
657                 dump(DUMP_PREPARED, irg, "-prepared", dump_ir_block_graph);
658
659                 if (be_options.vrfy_option == BE_VRFY_WARN) {
660                         be_check_dominance(irg);
661                         be_verify_out_edges(irg);
662                 } else if (be_options.vrfy_option == BE_VRFY_ASSERT) {
663                         assert(be_verify_out_edges(irg));
664                         assert(be_check_dominance(irg) && "Dominance verification failed");
665                 }
666
667                 BE_TIMER_PUSH(t_execfreq);
668                 /**
669                  * Create execution frequencies from profile data or estimate some
670                  */
671                 if (ir_profile_has_data())
672                         birg->exec_freq = ir_create_execfreqs_from_profile(irg);
673                 else
674                         birg->exec_freq = compute_execfreq(irg, 10);
675                 BE_TIMER_POP(t_execfreq);
676
677
678                 /* disabled for now, fails for EmptyFor.c and XXEndless.c */
679                 /* be_live_chk_compare(birg); */
680
681                 /* let backend prepare scheduling */
682                 stat_ev_ctx_push_str("bemain_phase", "before_sched");
683                 BE_TIMER_PUSH(t_codegen);
684                 arch_code_generator_before_sched(birg->cg);
685                 BE_TIMER_POP(t_codegen);
686                 stat_ev_ctx_pop("bemain_phase");
687
688                 /* schedule the irg */
689                 BE_TIMER_PUSH(t_sched);
690                 switch (be_options.scheduler) {
691                         default:
692                                 fprintf(stderr, "Warning: invalid scheduler (%d) selected, falling back to list scheduler.\n", be_options.scheduler);
693                         case BE_SCHED_LIST:
694                                 list_sched(birg, &be_options);
695                                 break;
696 #ifdef WITH_ILP
697                         case BE_SCHED_ILP:
698                                 be_ilp_sched(birg, &be_options);
699                                 break;
700 #endif /* WITH_ILP */
701                 };
702                 BE_TIMER_POP(t_sched);
703
704                 dump(DUMP_SCHED, irg, "-sched", dump_ir_block_graph_sched);
705
706                 /* check schedule */
707                 BE_TIMER_PUSH(t_verify);
708                 be_sched_vrfy(birg, be_options.vrfy_option);
709                 BE_TIMER_POP(t_verify);
710
711                 be_do_stat_nodes(irg, "04 Schedule");
712
713                 /* introduce patterns to assure constraints */
714                 BE_TIMER_PUSH(t_constr);
715                 /* we switch off optimizations here, because they might cause trouble */
716                 save_optimization_state(&state);
717                 set_optimize(0);
718                 set_opt_normalize(0);
719                 set_opt_cse(0);
720
721                 assert(!get_opt_cse());
722
723                 /* add Keeps for should_be_different constrained nodes  */
724                 /* beware: needs schedule due to usage of be_ssa_constr */
725                 assure_constraints(birg);
726                 BE_TIMER_POP(t_constr);
727
728                 dump(DUMP_SCHED, irg, "-assured", dump_ir_block_graph_sched);
729                 be_do_stat_nodes(irg, "05 Constraints");
730
731                 /* stuff needs to be done after scheduling but before register allocation */
732                 BE_TIMER_PUSH(t_codegen);
733                 arch_code_generator_before_ra(birg->cg);
734                 BE_TIMER_POP(t_codegen);
735
736                 /* connect all stack modifying nodes together (see beabi.c) */
737                 BE_TIMER_PUSH(t_abi);
738                 be_abi_fix_stack_nodes(birg->abi);
739                 BE_TIMER_POP(t_abi);
740
741                 dump(DUMP_SCHED, irg, "-fix_stack", dump_ir_block_graph_sched);
742
743                 /* check schedule */
744                 BE_TIMER_PUSH(t_verify);
745                 be_sched_vrfy(birg, be_options.vrfy_option);
746                 BE_TIMER_POP(t_verify);
747
748                 /* do some statistics */
749                 //be_do_stat_reg_pressure(birg);
750
751 #ifdef FIRM_STATISTICS
752                 stat_ev_dbl("costs_before_ra", be_estimate_irg_costs(irg, arch_env, birg->exec_freq));
753 #endif
754
755                 /* Do register allocation */
756                 be_allocate_registers(birg);
757
758 #ifdef FIRM_STATISTICS
759                 stat_ev_dbl("costs_before_ra", be_estimate_irg_costs(irg, arch_env, birg->exec_freq));
760 #endif
761
762                 dump(DUMP_RA, irg, "-ra", dump_ir_block_graph_sched);
763                 be_do_stat_nodes(irg, "06 Register Allocation");
764
765                 /* let the code generator prepare the graph for emitter */
766                 BE_TIMER_PUSH(t_finish);
767                 arch_code_generator_after_ra(birg->cg);
768                 BE_TIMER_POP(t_finish);
769
770                 /* fix stack offsets */
771                 BE_TIMER_PUSH(t_abi);
772                 be_abi_fix_stack_nodes(birg->abi);
773                 be_remove_dead_nodes_from_schedule(birg);
774                 be_abi_fix_stack_bias(birg->abi);
775                 BE_TIMER_POP(t_abi);
776
777                 dump(DUMP_SCHED, irg, "-fix_stack_after_ra", dump_ir_block_graph_sched);
778
779                 BE_TIMER_PUSH(t_finish);
780                 arch_code_generator_finish(birg->cg);
781                 BE_TIMER_POP(t_finish);
782
783                 dump(DUMP_FINAL, irg, "-finish", dump_ir_block_graph_sched);
784
785                 /* check schedule and register allocation */
786                 BE_TIMER_PUSH(t_verify);
787                 if (be_options.vrfy_option == BE_VRFY_WARN) {
788                         irg_verify(irg, VRFY_ENFORCE_SSA);
789                         be_check_dominance(irg);
790                         be_verify_out_edges(irg);
791                         be_verify_schedule(birg);
792                         be_verify_register_allocation(birg);
793                 } else if (be_options.vrfy_option == BE_VRFY_ASSERT) {
794                         assert(irg_verify(irg, VRFY_ENFORCE_SSA) && "irg verification failed");
795                         assert(be_verify_out_edges(irg) && "out edge verification failed");
796                         assert(be_check_dominance(irg) && "Dominance verification failed");
797                         assert(be_verify_schedule(birg) && "Schedule verification failed");
798                         assert(be_verify_register_allocation(birg)
799                                && "register allocation verification failed");
800
801                 }
802                 BE_TIMER_POP(t_verify);
803
804                 /* emit assembler code */
805                 BE_TIMER_PUSH(t_emit);
806                 arch_code_generator_done(birg->cg);
807                 BE_TIMER_POP(t_emit);
808
809                 dump(DUMP_FINAL, irg, "-end", dump_ir_block_graph_sched);
810
811                 BE_TIMER_PUSH(t_abi);
812                 be_abi_free(birg->abi);
813                 BE_TIMER_POP(t_abi);
814
815                 be_do_stat_nodes(irg, "07 Final");
816                 restore_optimization_state(&state);
817
818                 BE_TIMER_POP(t_other);
819
820 #define STOP_AND_RESET_TIMER(timer) do { ir_timer_stop(timer); ir_timer_reset(timer); } while(0)
821
822 #define LC_EMIT(timer)  \
823                 stat_ev_if {    \
824                         stat_ev_dbl(ir_timer_get_name(timer), ir_timer_elapsed_msec(timer));  \
825                 } else { \
826                         printf("%-20s: %8.3lf msec\n", ir_timer_get_description(timer), (double)ir_timer_elapsed_usec(timer) / 1000.0); \
827                 } \
828                 STOP_AND_RESET_TIMER(timer);
829
830                 BE_TIMER_ONLY(
831                         stat_ev_if {
832                         } else {
833                                 printf("==>> IRG %s <<==\n", get_entity_name(get_irg_entity(irg)));
834                         }
835                         LC_EMIT(t_abi);
836                         LC_EMIT(t_codegen);
837                         LC_EMIT(t_sched);
838                         LC_EMIT(t_live);
839                         LC_EMIT(t_heights);
840                         LC_EMIT(t_ssa_constr);
841                         LC_EMIT(t_constr);
842                         LC_EMIT(t_execfreq);
843                         LC_EMIT(t_ra_prolog);
844                         LC_EMIT(t_ra_spill);
845                         LC_EMIT(t_ra_spill_apply);
846                         LC_EMIT(t_ra_constr);
847                         LC_EMIT(t_ra_color);
848                         LC_EMIT(t_ra_ifg);
849                         LC_EMIT(t_ra_copymin);
850                         LC_EMIT(t_ra_ssa);
851                         LC_EMIT(t_ra_epilog);
852                         LC_EMIT(t_ra_other);
853                         LC_EMIT(t_finish);
854                         LC_EMIT(t_emit);
855                         LC_EMIT(t_verify);
856                         LC_EMIT(t_other);
857                 );
858 #undef LC_EMIT
859
860                 be_sched_free_phase(irg);
861
862                 be_free_birg(birg);
863
864         /* switched off due to statistics (statistic module needs all irgs) */
865 #if 0   /* STA needs irgs */
866 #ifdef FIRM_STATISTICS
867                 if (! stat_is_active())
868 #endif /* FIRM_STATISTICS */
869                         free_ir_graph(irg);
870 #endif /* if 0 */
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(strlen(config_file) > 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         }
913 #endif
914
915         /* never build code for pseudo irgs */
916         set_visit_pseudo_irgs(0);
917
918         be_node_init();
919
920         be_main_loop(file_handle, cup_name);
921
922         if (be_options.timing == BE_TIME_ON) {
923                 ir_timer_stop(t);
924                 ir_timer_leave_high_priority();
925                 stat_ev_if {
926                         stat_ev_dbl("backend_time", ir_timer_elapsed_msec(t));
927                 } else {
928                         printf("%-20s: %lu msec\n", "BEMAINLOOP", ir_timer_elapsed_msec(t));
929                 }
930         }
931
932 #ifdef FIRM_STATISTICS
933         if (be_options.statev)
934                 stat_ev_end();
935 #endif
936 }
937
938 unsigned be_put_ignore_regs(const be_irg_t *birg, const arch_register_class_t *cls, bitset_t *bs)
939 {
940         if (bs == NULL)
941                 bs = bitset_alloca(cls->n_regs);
942         else
943                 bitset_clear_all(bs);
944
945         assert(bitset_size(bs) == (unsigned)cls->n_regs);
946         arch_put_non_ignore_regs(birg->main_env->arch_env, cls, bs);
947         bitset_flip_all(bs);
948         be_abi_put_ignore_regs(birg->abi, cls, bs);
949
950         return bitset_popcnt(bs);
951 }