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