54aee99c18fe00a145cb66b32725a026e75f3416
[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
30 #include "bearch.h"
31 #include "firm/bearch_firm.h"
32 #include "ia32/bearch_ia32.h"
33
34 #include "be_t.h"
35 #include "benumb_t.h"
36 #include "beutil.h"
37 #include "benode_t.h"
38 #include "beirgmod.h"
39 #include "besched_t.h"
40 #include "belistsched.h"
41 #include "belive_t.h"
42 #include "bespillilp.h"
43 #include "bespillbelady.h"
44 #include "bera.h"
45 #include "beraextern.h"
46 #include "bechordal_t.h"
47 #include "beifg.h"
48 #include "beifg_impl.h"
49 #include "becopyopt.h"
50 #include "becopystat.h"
51 #include "bessadestr.h"
52 #include "beabi.h"
53 #include "belower.h"
54
55 #define DUMP_INITIAL            (1 << 0)
56 #define DUMP_ABI                (1 << 1)
57 #define DUMP_SCHED                      (1 << 2)
58 #define DUMP_PREPARED           (1 << 3)
59 #define DUMP_RA                         (1 << 4)
60 #define DUMP_FINAL                      (1 << 5)
61
62 /* options visible for anyone */
63 be_options_t be_options = {
64         /* ilp server */
65         "i44pc52.info.uni-karlsruhe.de",
66
67         /* ilp solver */
68         "cplex"
69 };
70
71 /* dump flags */
72 static unsigned dump_flags = 2 * DUMP_FINAL - 1;
73
74 /* register allocator to use. */
75 static const be_ra_t *ra = &be_ra_chordal_allocator;
76
77 /* back end instruction set architecture to use */
78 static const arch_isa_if_t *isa_if = &ia32_isa_if;
79 #ifdef WITH_LIBCORE
80
81 static lc_opt_entry_t *be_grp_root = NULL;
82
83 /* possible dumping options */
84 static const lc_opt_enum_mask_items_t dump_items[] = {
85         { "none",       0 },
86         { "initial",    DUMP_INITIAL },
87         { "abi",        DUMP_ABI    },
88         { "sched",      DUMP_SCHED  },
89         { "prepared",   DUMP_PREPARED },
90         { "regalloc",   DUMP_RA },
91         { "final",      DUMP_FINAL },
92         { "all",        2 * DUMP_FINAL - 1 },
93         { NULL,         0 }
94 };
95
96 /* register allocators */
97 static const lc_opt_enum_const_ptr_items_t ra_items[] = {
98         { "chordal", &be_ra_chordal_allocator },
99         { "external", &be_ra_external_allocator },
100         { NULL,      NULL }
101 };
102
103 /* instruction set architectures. */
104 static const lc_opt_enum_const_ptr_items_t isa_items[] = {
105         { "firm",    &firm_isa },
106         { "ia32",    &ia32_isa_if },
107         { NULL,      NULL }
108 };
109
110 static lc_opt_enum_mask_var_t dump_var = {
111         &dump_flags, dump_items
112 };
113
114 static lc_opt_enum_const_ptr_var_t ra_var = {
115         (const void **) &ra, ra_items
116 };
117
118 static lc_opt_enum_const_ptr_var_t isa_var = {
119         (const void **) &isa_if, isa_items
120 };
121
122 static const lc_opt_table_entry_t be_main_options[] = {
123         LC_OPT_ENT_ENUM_MASK("dump", "dump irg on several occasions", &dump_var),
124         LC_OPT_ENT_ENUM_PTR("ra", "register allocator", &ra_var),
125         LC_OPT_ENT_ENUM_PTR("isa", "the instruction set architecture", &isa_var),
126
127 #ifdef WITH_ILP
128         LC_OPT_ENT_STR ("ilp.server", "the ilp server name", be_options.ilp_server, sizeof(be_options.ilp_server)),
129         LC_OPT_ENT_STR ("ilp.solver", "the ilp solver name", be_options.ilp_solver, sizeof(be_options.ilp_solver)),
130 #endif /* WITH_ILP */
131         { NULL }
132 };
133
134 #endif /* WITH_LIBCORE */
135
136 void be_opt_register(void)
137 {
138 #ifdef WITH_LIBCORE
139         int i;
140         lc_opt_entry_t *be_grp_ra;
141
142         be_grp_root = lc_opt_get_grp(firm_opt_get_root(), "be");
143         be_grp_ra   = lc_opt_get_grp(be_grp_root, "ra");
144
145         lc_opt_add_table(be_grp_root, be_main_options);
146
147         /* register allocator options */
148         for(i = 0; ra_items[i].name != NULL; ++i) {
149                 const be_ra_t *ra = ra_items[i].value;
150                 ra->register_options(be_grp_ra);
151         }
152
153         /* register isa options */
154         for(i = 0; isa_items[i].name != NULL; ++i) {
155                 const arch_isa_if_t *isa = isa_items[i].value;
156                 isa->register_options(be_grp_root);
157         }
158 #endif /* WITH_LIBCORE */
159 }
160
161
162 void be_init(void)
163 {
164         be_opt_register();
165
166         be_sched_init();
167         be_liveness_init();
168         be_numbering_init();
169         be_copy_opt_init();
170         copystat_init();
171         phi_class_init();
172 }
173
174 static be_main_env_t *be_init_env(be_main_env_t *env)
175 {
176         memset(env, 0, sizeof(*env));
177         obstack_init(&env->obst);
178         env->dbg = firm_dbg_register("be.main");
179
180         env->arch_env = obstack_alloc(&env->obst, sizeof(env->arch_env[0]));
181         arch_env_init(env->arch_env, isa_if);
182
183         /* Register the irn handler of the architecture */
184         if (arch_isa_get_irn_handler(env->arch_env->isa))
185                 arch_env_push_irn_handler(env->arch_env, arch_isa_get_irn_handler(env->arch_env->isa));
186
187         /*
188          * Register the node handler of the back end infrastructure.
189          * This irn handler takes care of the platform independent
190          * spill, reload and perm nodes.
191          */
192         arch_env_push_irn_handler(env->arch_env, &be_node_irn_handler);
193
194         return env;
195 }
196
197 static void be_done_env(be_main_env_t *env)
198 {
199         env->arch_env->isa->impl->done(env->arch_env->isa);
200         obstack_free(&env->obst, NULL);
201 }
202
203 static void dump(int mask, ir_graph *irg, const char *suffix,
204                                  void (*dumper)(ir_graph *, const char *))
205 {
206         if(dump_flags & mask)
207                 be_dump(irg, suffix, dumper);
208 }
209
210 /**
211  * Prepare a backend graph for code generation.
212  */
213 static void prepare_graph(be_irg_t *birg)
214 {
215         ir_graph *irg = birg->irg;
216
217         /* Normalize proj nodes. */
218         normalize_proj_nodes(irg);
219
220         /* Make just one return node. */
221         // normalize_one_return(irg);
222
223         /* Remove critical edges */
224         remove_critical_cf_edges(irg);
225
226         /* Compute the dominance information. */
227         free_dom(irg);
228         compute_doms(irg);
229
230         /* Ensure, that the ir_edges are computed. */
231         edges_activate(irg);
232
233         /* check, if the dominance property is fulfilled. */
234         be_check_dominance(irg);
235 }
236
237 /**
238  * The Firm backend main loop.
239  * Do architecture specific lowering for all graphs
240  * and call the architecture specific code generator.
241  */
242 static void be_main_loop(FILE *file_handle)
243 {
244         int i, n;
245         arch_isa_t *isa;
246         be_main_env_t env;
247
248         be_init_env(&env);
249
250         isa = arch_env_get_isa(env.arch_env);
251
252         /* For all graphs */
253         for(i = 0, n = get_irp_n_irgs(); i < n; ++i) {
254                 ir_graph *irg = get_irp_irg(i);
255                 const arch_code_generator_if_t *cg_if;
256                 be_irg_t birg;
257
258                 birg.irg      = irg;
259                 birg.main_env = &env;
260
261                 DBG((env.dbg, LEVEL_2, "====> IRG: %F\n", irg));
262                 dump(DUMP_INITIAL, irg, "-begin", dump_ir_block_graph);
263
264                 /* set the current graph (this is important for several firm functions) */
265                 current_ir_graph = birg.irg;
266
267                 /* Get the code generator interface. */
268                 cg_if = isa->impl->get_code_generator_if(isa);
269
270                 /* get a code generator for this graph. */
271                 birg.cg = cg_if->init(file_handle, &birg);
272
273                 /* create the code generator and generate code. */
274                 prepare_graph(&birg);
275
276                 /* some transformations need to be done before abi introduce */
277                 arch_code_generator_before_abi(birg.cg);
278
279                 /* implement the ABI conventions. */
280                 birg.abi = be_abi_introduce(&birg);
281                 dump(DUMP_ABI, irg, "-abi", dump_ir_block_graph);
282
283                 /* generate code */
284                 arch_code_generator_prepare_graph(birg.cg);
285
286                 /*
287                  * Since the code generator made a lot of new nodes and skipped
288                  * a lot of old ones, we should do dead node elimination here.
289                  * Note that this requires disabling the edges here.
290                  */
291                 edges_deactivate(irg);
292                 dead_node_elimination(irg);
293                 edges_activate(irg);
294
295                 /* Compute loop nesting information (for weighting copies) */
296                 construct_cf_backedges(irg);
297
298                 dump(DUMP_PREPARED, irg, "-prepared", dump_ir_block_graph);
299
300                 /* add Keeps for should_be_different constrained nodes */
301                 assure_constraints(&birg);
302
303                 dump(DUMP_PREPARED, irg, "-assured", dump_ir_block_graph);
304
305                 /* Schedule the graphs. */
306                 arch_code_generator_before_sched(birg.cg);
307                 list_sched(env.arch_env, irg);
308
309                 /* connect all stack modifying nodes together (see beabi.c) */
310                 be_abi_fix_stack_nodes(birg.abi);
311                 dump(DUMP_SCHED, irg, "-sched", dump_ir_block_graph_sched);
312
313                 /* Verify the schedule */
314                 sched_verify_irg(irg);
315
316                 /* Do register allocation */
317                 arch_code_generator_before_ra(birg.cg);
318                 ra->allocate(&birg);
319                 dump(DUMP_RA, irg, "-ra", dump_ir_block_graph_sched);
320
321                 arch_code_generator_after_ra(birg.cg);
322                 be_abi_fix_stack_bias(birg.abi);
323
324                 arch_code_generator_done(birg.cg);
325                 dump(DUMP_FINAL, irg, "-end", dump_ir_block_graph_sched);
326                 be_abi_free(birg.abi);
327         }
328
329         be_done_env(&env);
330 }
331
332 void be_main(FILE *file_handle)
333 {
334         /* never build code for pseudo irgs */
335         set_visit_pseudo_irgs(0);
336
337         be_node_init();
338         be_main_loop(file_handle);
339 }