5414b734c82db4bb5ebcc72e461e47d080c56494
[libfirm] / ir / be / bemain.c
1 /**
2  * Backend driver.
3  * @author Sebastian Hack
4  * @date 25.11.2004
5  */
6 #ifdef HAVE_CONFIG_H
7 #include "config.h"
8 #endif
9
10 #include <stdarg.h>
11
12 #ifdef WITH_LIBCORE
13 #include <libcore/lc_opts.h>
14 #include <libcore/lc_opts_enum.h>
15 #endif /* WITH_LIBCORE */
16
17 #include "obst.h"
18 #include "bitset.h"
19
20 #include "irprog.h"
21 #include "irgopt.h"
22 #include "irgraph.h"
23 #include "irdump.h"
24 #include "phiclass.h"
25 #include "irdom_t.h"
26 #include "iredges_t.h"
27 #include "irloop_t.h"
28 #include "irtools.h"
29 #include "return.h"
30
31 #include "bearch.h"
32 #include "firm/bearch_firm.h"
33 #include "ia32/bearch_ia32.h"
34 #include "arm/bearch_arm.h"
35 #include "ppc32/bearch_ppc32.h"
36 #include "mips/bearch_mips.h"
37
38 #include "be_t.h"
39 #include "benumb_t.h"
40 #include "beutil.h"
41 #include "benode_t.h"
42 #include "beirgmod.h"
43 #include "besched_t.h"
44 #include "belistsched.h"
45 #include "belive_t.h"
46 #include "bespillilp.h"
47 #include "bespillbelady.h"
48 #include "bera.h"
49 #include "beraextern.h"
50 #include "bechordal_t.h"
51 #include "beifg.h"
52 #include "beifg_impl.h"
53 #include "becopyopt.h"
54 #include "becopystat.h"
55 #include "bessadestr.h"
56 #include "beabi.h"
57 #include "belower.h"
58 #include "beschedmris.h"
59 #include "bestat.h"
60
61 #define DUMP_INITIAL    (1 << 0)
62 #define DUMP_ABI        (1 << 1)
63 #define DUMP_SCHED      (1 << 2)
64 #define DUMP_PREPARED   (1 << 3)
65 #define DUMP_RA         (1 << 4)
66 #define DUMP_FINAL      (1 << 5)
67
68 /* options visible for anyone */
69 static be_options_t be_options = {
70         /* ilp server */
71         "i44pc52.info.uni-karlsruhe.de",
72
73         /* ilp solver */
74         "cplex"
75 };
76
77 /* dump flags */
78 static unsigned dump_flags = 0;
79
80 /* register allocator to use. */
81 static const be_ra_t *ra = &be_ra_chordal_allocator;
82
83 /* back end instruction set architecture to use */
84 static const arch_isa_if_t *isa_if = &ia32_isa_if;
85
86 static int be_disable_mris = 0;
87
88 #ifdef WITH_LIBCORE
89
90 static lc_opt_entry_t *be_grp_root = NULL;
91
92 /* possible dumping options */
93 static const lc_opt_enum_mask_items_t dump_items[] = {
94         { "none",       0 },
95         { "initial",    DUMP_INITIAL },
96         { "abi",        DUMP_ABI    },
97         { "sched",      DUMP_SCHED  },
98         { "prepared",   DUMP_PREPARED },
99         { "regalloc",   DUMP_RA },
100         { "final",      DUMP_FINAL },
101         { "all",        2 * DUMP_FINAL - 1 },
102         { NULL,         0 }
103 };
104
105 /* register allocators */
106 static const lc_opt_enum_const_ptr_items_t ra_items[] = {
107         { "chordal", &be_ra_chordal_allocator },
108         { "external", &be_ra_external_allocator },
109         { NULL,      NULL }
110 };
111
112 /* instruction set architectures. */
113 static const lc_opt_enum_const_ptr_items_t isa_items[] = {
114         { "firm",    &firm_isa },
115         { "ia32",    &ia32_isa_if },
116 #if 0
117         { "arm",     &arm_isa_if },
118         { "ppc32",   &ppc32_isa_if },
119         { "mips",    &mips_isa_if },
120 #endif
121         { NULL,      NULL }
122 };
123
124 static lc_opt_enum_mask_var_t dump_var = {
125         &dump_flags, dump_items
126 };
127
128 static lc_opt_enum_const_ptr_var_t ra_var = {
129         (const void **) &ra, ra_items
130 };
131
132 static lc_opt_enum_const_ptr_var_t isa_var = {
133         (const void **) &isa_if, isa_items
134 };
135
136 static const lc_opt_table_entry_t be_main_options[] = {
137         LC_OPT_ENT_ENUM_MASK("dump",     "dump irg on several occasions",     &dump_var),
138         LC_OPT_ENT_ENUM_PTR ("ra",       "register allocator",                &ra_var),
139         LC_OPT_ENT_ENUM_PTR ("isa",      "the instruction set architecture",  &isa_var),
140         LC_OPT_ENT_NEGBOOL  ("noomitfp", "do not omit frame pointer",         &be_omit_fp),
141         LC_OPT_ENT_NEGBOOL  ("nomris",   "disable mris schedule preparation", &be_disable_mris),
142
143 #ifdef WITH_ILP
144         LC_OPT_ENT_STR ("ilp.server", "the ilp server name", be_options.ilp_server, sizeof(be_options.ilp_server)),
145         LC_OPT_ENT_STR ("ilp.solver", "the ilp solver name", be_options.ilp_solver, sizeof(be_options.ilp_solver)),
146 #endif /* WITH_ILP */
147         { NULL }
148 };
149
150 #endif /* WITH_LIBCORE */
151
152 void be_opt_register(void)
153 {
154 #ifdef WITH_LIBCORE
155         int i;
156         lc_opt_entry_t *be_grp_ra;
157         static int run_once = 0;
158
159         if (! run_once) {
160                 run_once    = 1;
161                 be_grp_root = lc_opt_get_grp(firm_opt_get_root(), "be");
162                 be_grp_ra   = lc_opt_get_grp(be_grp_root, "ra");
163
164                 lc_opt_add_table(be_grp_root, be_main_options);
165
166                 /* register allocator options */
167                 for(i = 0; ra_items[i].name != NULL; ++i) {
168                         const be_ra_t *ra = ra_items[i].value;
169                         ra->register_options(be_grp_ra);
170                 }
171
172                 /* register isa options */
173                 for(i = 0; isa_items[i].name != NULL; ++i) {
174                         const arch_isa_if_t *isa = isa_items[i].value;
175                         isa->register_options(be_grp_root);
176                 }
177         }
178 #endif /* WITH_LIBCORE */
179 }
180
181 /* Parse one argument. */
182 int be_parse_arg(const char *arg) {
183 #ifdef WITH_LIBCORE
184         if (strcmp(arg, "help") == 0 || (arg[0] == '?' && arg[1] == '\0')) {
185                 lc_opt_print_help(be_grp_root, stdout);
186                 return -1;
187         }
188         return lc_opt_from_single_arg(be_grp_root, NULL, arg, NULL);
189 #endif /* WITH_LIBCORE */
190 }
191
192 /** The be parameters returned by default, all off. */
193 const static backend_params be_params = {
194         NULL,
195         NULL,
196         0,
197         NULL,
198 };
199
200 /* Initialize the Firm backend. Must be run BEFORE init_firm()! */
201 const backend_params *be_init(void)
202 {
203         be_opt_register();
204
205         be_sched_init();
206         be_liveness_init();
207         be_numbering_init();
208         be_copy_opt_init();
209         copystat_init();
210         phi_class_init();
211
212         if (isa_if->get_params)
213                 return isa_if->get_params();
214         return &be_params;
215 }
216
217 static be_main_env_t *be_init_env(be_main_env_t *env, FILE *file_handle)
218 {
219         memset(env, 0, sizeof(*env));
220         obstack_init(&env->obst);
221         env->arch_env = obstack_alloc(&env->obst, sizeof(env->arch_env[0]));
222         env->options  = &be_options;
223         FIRM_DBG_REGISTER(env->dbg, "be.main");
224
225         arch_env_init(env->arch_env, isa_if, file_handle);
226
227         /* Register the irn handler of the architecture */
228         if (arch_isa_get_irn_handler(env->arch_env->isa))
229                 arch_env_push_irn_handler(env->arch_env, arch_isa_get_irn_handler(env->arch_env->isa));
230
231         /*
232          * Register the node handler of the back end infrastructure.
233          * This irn handler takes care of the platform independent
234          * spill, reload and perm nodes.
235          */
236         arch_env_push_irn_handler(env->arch_env, &be_node_irn_handler);
237         env->phi_handler = be_phi_handler_new(env->arch_env);
238         arch_env_push_irn_handler(env->arch_env, env->phi_handler);
239
240         return env;
241 }
242
243 static void be_done_env(be_main_env_t *env)
244 {
245         env->arch_env->isa->impl->done(env->arch_env->isa);
246         be_phi_handler_free(env->phi_handler);
247         obstack_free(&env->obst, NULL);
248 }
249
250 static void dump(int mask, ir_graph *irg, const char *suffix,
251                  void (*dumper)(ir_graph *, const char *))
252 {
253         if(dump_flags & mask)
254                 be_dump(irg, suffix, dumper);
255 }
256
257 /**
258  * Prepare a backend graph for code generation.
259  */
260 static void prepare_graph(be_irg_t *birg)
261 {
262         ir_graph *irg = birg->irg;
263
264         /* Normalize proj nodes. */
265         normalize_proj_nodes(irg);
266
267         /* Make just one return node. */
268         normalize_one_return(irg);
269
270         /* Remove critical edges */
271         remove_critical_cf_edges(irg);
272
273         /* Compute the dominance information. */
274         free_dom(irg);
275         compute_doms(irg);
276
277         /* Ensure, that the ir_edges are computed. */
278         edges_activate(irg);
279
280         /* check, if the dominance property is fulfilled. */
281         be_check_dominance(irg);
282
283         /* reset the phi handler. */
284         be_phi_handler_reset(birg->main_env->phi_handler);
285 }
286
287 /**
288  * The Firm backend main loop.
289  * Do architecture specific lowering for all graphs
290  * and call the architecture specific code generator.
291  */
292 static void be_main_loop(FILE *file_handle)
293 {
294         int i, n;
295         arch_isa_t *isa;
296         be_main_env_t env;
297
298         be_init_env(&env, file_handle);
299
300         isa = arch_env_get_isa(env.arch_env);
301
302         // /* for debugging, anchors helps */
303         // dump_all_anchors(1);
304
305         /* For all graphs */
306         for (i = 0, n = get_irp_n_irgs(); i < n; ++i) {
307                 ir_graph *irg = get_irp_irg(i);
308                 const arch_code_generator_if_t *cg_if;
309                 be_irg_t birg;
310
311                 birg.irg      = irg;
312                 birg.main_env = &env;
313
314                 DBG((env.dbg, LEVEL_2, "====> IRG: %F\n", irg));
315                 dump(DUMP_INITIAL, irg, "-begin", dump_ir_block_graph);
316
317                 /* set the current graph (this is important for several firm functions) */
318                 current_ir_graph = birg.irg;
319
320                 /* Get the code generator interface. */
321                 cg_if = isa->impl->get_code_generator_if(isa);
322
323                 /* get a code generator for this graph. */
324                 birg.cg = cg_if->init(&birg);
325
326                 /* create the code generator and generate code. */
327                 prepare_graph(&birg);
328
329                 /* some transformations need to be done before abi introduce */
330                 arch_code_generator_before_abi(birg.cg);
331
332                 /* implement the ABI conventions. */
333                 birg.abi = be_abi_introduce(&birg);
334                 dump(DUMP_ABI, irg, "-abi", dump_ir_block_graph);
335
336                 /* generate code */
337                 arch_code_generator_prepare_graph(birg.cg);
338
339                 /*
340                  * Since the code generator made a lot of new nodes and skipped
341                  * a lot of old ones, we should do dead node elimination here.
342                  * Note that this requires disabling the edges here.
343                  */
344                 edges_deactivate(irg);
345                 //dead_node_elimination(irg);
346                 edges_activate(irg);
347
348                 /* Compute loop nesting information (for weighting copies) */
349                 construct_cf_backedges(irg);
350
351                 dump(DUMP_PREPARED, irg, "-prepared", dump_ir_block_graph);
352
353                 /* Schedule the graphs. */
354                 arch_code_generator_before_sched(birg.cg);
355                 list_sched(&birg, be_disable_mris);
356                 dump(DUMP_SCHED, irg, "-sched", dump_ir_block_graph_sched);
357
358                 /* add Keeps for should_be_different constrained nodes  */
359                 /* beware: needs schedule due to usage of be_ssa_constr */
360                 assure_constraints(&birg);
361                 dump(DUMP_SCHED, irg, "-assured", dump_ir_block_graph_sched);
362
363                 /* connect all stack modifying nodes together (see beabi.c) */
364                 be_abi_fix_stack_nodes(birg.abi);
365                 dump(DUMP_SCHED, irg, "-fix_stack", dump_ir_block_graph_sched);
366
367                 /* Verify the schedule */
368                 assert(sched_verify_irg(irg));
369
370                 /* do some statistics */
371                 be_do_stat_reg_pressure(&birg);
372
373                 /* Do register allocation */
374                 arch_code_generator_before_ra(birg.cg);
375                 ra->allocate(&birg);
376                 dump(DUMP_RA, irg, "-ra", dump_ir_block_graph_sched);
377
378                 arch_code_generator_after_ra(birg.cg);
379                 be_abi_fix_stack_bias(birg.abi);
380
381                 arch_code_generator_done(birg.cg);
382                 dump(DUMP_FINAL, irg, "-end", dump_ir_extblock_graph_sched);
383                 be_abi_free(birg.abi);
384
385 //              free_ir_graph(irg);
386         }
387         be_done_env(&env);
388 }
389
390 /* Main interface to the frontend. */
391 void be_main(FILE *file_handle)
392 {
393         /* never build code for pseudo irgs */
394         set_visit_pseudo_irgs(0);
395
396         be_node_init();
397         be_main_loop(file_handle);
398 }
399
400 /** The debug info retriever function. */
401 static retrieve_dbg_func retrieve_dbg = NULL;
402
403 /* Sets a debug info retriever. */
404 void be_set_debug_retrieve(retrieve_dbg_func func) {
405         retrieve_dbg = func;
406 }
407
408 /* Retrieve the debug info. */
409 const char *be_retrieve_dbg_info(const dbg_info *dbg, unsigned *line) {
410         if (retrieve_dbg)
411                 return retrieve_dbg(dbg, line);
412         *line = 0;
413         return NULL;
414 }