66f4713be27a16d8b0cd1a87749e29213d60e4b3
[cparser] / driver / firm_opt.c
1 /**
2  *
3  * @file firm_opt.c -- Firm-generating back end optimizations.
4  *
5  * (C) 2005-2009  Michael Beck   beck@ipd.info.uni-karlsruhe.de
6  *
7  * $Id$
8  */
9
10 #include <config.h>
11
12 #include <stdbool.h>
13 #include <stdlib.h>
14 #include <string.h>
15 #include <stdbool.h>
16 #include <assert.h>
17 #include <libfirm/firm.h>
18
19 #include "firm_opt.h"
20 #include "firm_codegen.h"
21 #include "firm_cmdline.h"
22 #include "firm_timing.h"
23 #include "ast2firm.h"
24
25 #if defined(_DEBUG) || defined(FIRM_DEBUG)
26 #define DBG(x)  dbg_printf x
27 #else
28 #define DBG(x) ((void)0)
29 #endif /* _DEBUG || FIRM_DEBUG */
30
31 static ir_timer_t *t_vcg_dump;
32 static ir_timer_t *t_verify;
33 static ir_timer_t *t_all_opt;
34 static bool do_irg_opt(ir_graph *irg, const char *name);
35
36 /** dump all the graphs depending on cond */
37
38 static void dump_all(const char *suffix) {
39         if (firm_dump.ir_graph) {
40                 timer_push(t_vcg_dump);
41                 if (firm_dump.no_blocks)
42                         dump_all_ir_graphs(dump_ir_graph, suffix);
43                 else if (firm_dump.extbb)
44                         dump_all_ir_graphs(dump_ir_extblock_graph, suffix);
45                 else
46                         dump_all_ir_graphs(dump_ir_block_graph, suffix);
47                 timer_pop(t_vcg_dump);
48         }
49 }
50
51 /* set by the backend parameters */
52 static const ir_settings_arch_dep_t *ad_param              = NULL;
53 static create_intrinsic_fkt         *arch_create_intrinsic = NULL;
54 static void                         *create_intrinsic_ctx  = NULL;
55 static const ir_settings_if_conv_t  *if_conv_info          = NULL;
56
57 /* entities of runtime functions */
58 ir_entity_ptr rts_entities[rts_max];
59
60 /**
61  * factory for setting architecture dependent parameters
62  */
63 static const ir_settings_arch_dep_t *arch_factory(void)
64 {
65         static const ir_settings_arch_dep_t param = {
66                 1,   /* also use subs */
67                 4,   /* maximum shifts */
68                 31,   /* maximum shift amount */
69                 NULL, /* use default evaluator */
70
71                 1, /* allow Mulhs */
72                 1, /* allow Mulus */
73                 32  /* Mulh allowed up to 32 bit */
74         };
75
76         return ad_param ? ad_param : &param;
77 }
78
79 /**
80  * Map runtime functions.
81  */
82 static void rts_map(void) {
83         static const struct {
84                 ir_entity_ptr *ent; /**< address of the rts entity */
85                 i_mapper_func func; /**< mapper function. */
86         } mapper[] = {
87                 /* integer */
88                 { &rts_entities[rts_abs],     i_mapper_abs },
89                 { &rts_entities[rts_labs],    i_mapper_abs },
90                 { &rts_entities[rts_llabs],   i_mapper_abs },
91                 { &rts_entities[rts_imaxabs], i_mapper_abs },
92
93                 /* double -> double */
94                 { &rts_entities[rts_fabs],    i_mapper_abs },
95                 { &rts_entities[rts_sqrt],    i_mapper_sqrt },
96                 { &rts_entities[rts_cbrt],    i_mapper_cbrt },
97                 { &rts_entities[rts_pow],     i_mapper_pow },
98                 { &rts_entities[rts_exp],     i_mapper_exp },
99                 { &rts_entities[rts_exp2],    i_mapper_exp },
100                 { &rts_entities[rts_exp10],   i_mapper_exp },
101                 { &rts_entities[rts_log],     i_mapper_log },
102                 { &rts_entities[rts_log2],    i_mapper_log2 },
103                 { &rts_entities[rts_log10],   i_mapper_log10 },
104                 { &rts_entities[rts_sin],     i_mapper_sin },
105                 { &rts_entities[rts_cos],     i_mapper_cos },
106                 { &rts_entities[rts_tan],     i_mapper_tan },
107                 { &rts_entities[rts_asin],    i_mapper_asin },
108                 { &rts_entities[rts_acos],    i_mapper_acos },
109                 { &rts_entities[rts_atan],    i_mapper_atan },
110                 { &rts_entities[rts_sinh],    i_mapper_sinh },
111                 { &rts_entities[rts_cosh],    i_mapper_cosh },
112                 { &rts_entities[rts_tanh],    i_mapper_tanh },
113
114                 /* float -> float */
115                 { &rts_entities[rts_fabsf],   i_mapper_abs },
116                 { &rts_entities[rts_sqrtf],   i_mapper_sqrt },
117                 { &rts_entities[rts_cbrtf],   i_mapper_cbrt },
118                 { &rts_entities[rts_powf],    i_mapper_pow },
119                 { &rts_entities[rts_expf],    i_mapper_exp },
120                 { &rts_entities[rts_exp2f],   i_mapper_exp },
121                 { &rts_entities[rts_exp10f],  i_mapper_exp },
122                 { &rts_entities[rts_logf],    i_mapper_log },
123                 { &rts_entities[rts_log2f],   i_mapper_log2 },
124                 { &rts_entities[rts_log10f],  i_mapper_log10 },
125                 { &rts_entities[rts_sinf],    i_mapper_sin },
126                 { &rts_entities[rts_cosf],    i_mapper_cos },
127                 { &rts_entities[rts_tanf],    i_mapper_tan },
128                 { &rts_entities[rts_asinf],   i_mapper_asin },
129                 { &rts_entities[rts_acosf],   i_mapper_acos },
130                 { &rts_entities[rts_atanf],   i_mapper_atan },
131                 { &rts_entities[rts_sinhf],   i_mapper_sinh },
132                 { &rts_entities[rts_coshf],   i_mapper_cosh },
133                 { &rts_entities[rts_tanhf],   i_mapper_tanh },
134
135                 /* long double -> long double */
136                 { &rts_entities[rts_fabsl],   i_mapper_abs },
137                 { &rts_entities[rts_sqrtl],   i_mapper_sqrt },
138                 { &rts_entities[rts_cbrtl],   i_mapper_cbrt },
139                 { &rts_entities[rts_powl],    i_mapper_pow },
140                 { &rts_entities[rts_expl],    i_mapper_exp },
141                 { &rts_entities[rts_exp2l],   i_mapper_exp },
142                 { &rts_entities[rts_exp10l],  i_mapper_exp },
143                 { &rts_entities[rts_logl],    i_mapper_log },
144                 { &rts_entities[rts_log2l],   i_mapper_log2 },
145                 { &rts_entities[rts_log10l],  i_mapper_log10 },
146                 { &rts_entities[rts_sinl],    i_mapper_sin },
147                 { &rts_entities[rts_cosl],    i_mapper_cos },
148                 { &rts_entities[rts_tanl],    i_mapper_tan },
149                 { &rts_entities[rts_asinl],   i_mapper_asin },
150                 { &rts_entities[rts_acosl],   i_mapper_acos },
151                 { &rts_entities[rts_atanl],   i_mapper_atan },
152                 { &rts_entities[rts_sinhl],   i_mapper_sinh },
153                 { &rts_entities[rts_coshl],   i_mapper_cosh },
154                 { &rts_entities[rts_tanhl],   i_mapper_tanh },
155
156                 /* string */
157                 { &rts_entities[rts_strcmp],  i_mapper_strcmp },
158                 { &rts_entities[rts_strncmp], i_mapper_strncmp },
159                 { &rts_entities[rts_strcpy],  i_mapper_strcpy },
160                 { &rts_entities[rts_strlen],  i_mapper_strlen },
161                 { &rts_entities[rts_memcpy],  i_mapper_memcpy },
162                 { &rts_entities[rts_mempcpy], i_mapper_mempcpy },
163                 { &rts_entities[rts_memmove], i_mapper_memmove },
164                 { &rts_entities[rts_memset],  i_mapper_memset },
165                 { &rts_entities[rts_memcmp],  i_mapper_memcmp }
166         };
167         i_record rec[sizeof(mapper)/sizeof(mapper[0])];
168         unsigned i, n_map;
169
170         for (i = n_map = 0; i < sizeof(mapper)/sizeof(mapper[0]); ++i) {
171                 if (*mapper[i].ent != NULL) {
172                         rec[n_map].i_call.kind     = INTRINSIC_CALL;
173                         rec[n_map].i_call.i_ent    = *mapper[i].ent;
174                         rec[n_map].i_call.i_mapper = mapper[i].func;
175                         rec[n_map].i_call.ctx      = NULL;
176                         rec[n_map].i_call.link     = NULL;
177                         ++n_map;
178                 }
179         }
180
181         if (n_map > 0)
182                 lower_intrinsics(rec, n_map, /* part_block_used=*/0);
183 }
184
185 static int *irg_dump_no;
186
187 static void dump_graph_count(ir_graph *const irg, const char *const suffix)
188 {
189         char name[64];
190         snprintf(name, sizeof(name), "-%02d_%s", irg_dump_no[get_irg_idx(irg)]++,
191                  suffix);
192
193         timer_push(t_vcg_dump);
194         if (firm_dump.no_blocks)
195                 dump_ir_graph(irg, name);
196         else if (firm_dump.extbb)
197                 dump_ir_extblock_graph(irg, name);
198         else
199                 dump_ir_block_graph(irg, name);
200         timer_pop(t_vcg_dump);
201 }
202
203 static void remove_unused_functions(void)
204 {
205         ir_entity **keep_methods;
206         int         arr_len;
207
208         /* Analysis that finds the free methods,
209            i.e. methods that are dereferenced.
210            Optimizes polymorphic calls :-). */
211         cgana(&arr_len, &keep_methods);
212
213         /* Remove methods that are never called. */
214         gc_irgs(arr_len, keep_methods);
215         free(keep_methods);
216 }
217
218 static int firm_const_exists;
219
220 static void do_optimize_funccalls(void)
221 {
222         optimize_funccalls(firm_const_exists, NULL);
223 }
224
225 static void do_gcse(ir_graph *irg)
226 {
227         set_opt_global_cse(1);
228         optimize_graph_df(irg);
229         place_code(irg);
230         set_opt_global_cse(0);
231 }
232
233 static void do_lower_highlevel(ir_graph *irg)
234 {
235         lower_highlevel_graph(irg, firm_opt.lower_bitfields);
236 }
237
238 static void do_if_conv(ir_graph *irg)
239 {
240         opt_if_conv(irg, if_conv_info);
241 }
242
243 static void do_stred(ir_graph *irg)
244 {
245         opt_osr(irg, osr_flag_default | osr_flag_keep_reg_pressure | osr_flag_ignore_x86_shift);
246 }
247
248 static void after_inline_opt(ir_graph *irg)
249 {
250         do_irg_opt(irg, "scalar-replace");
251         do_irg_opt(irg, "local");
252         do_irg_opt(irg, "control-flow");
253         do_irg_opt(irg, "combo");
254 }
255
256 static void do_inline(void)
257 {
258         inline_functions(firm_opt.inline_maxsize, firm_opt.inline_threshold,
259                          after_inline_opt);
260 }
261
262 static void do_cloning(void)
263 {
264         proc_cloning((float) firm_opt.clone_threshold);
265 }
266
267 static void do_lower_switch(ir_graph *irg)
268 {
269         lower_switch(irg, firm_opt.spare_size);
270 }
271
272 static void do_lower_mux(ir_graph *irg)
273 {
274         lower_mux(irg, NULL);
275 }
276
277 static void do_lower_dw_ops(void)
278 {
279         lwrdw_param_t init = {
280                 1,
281                 1,
282                 get_atomic_mode(ATOMIC_TYPE_LONGLONG),
283                 get_atomic_mode(ATOMIC_TYPE_ULONGLONG),
284                 get_atomic_mode(ATOMIC_TYPE_INT),
285                 get_atomic_mode(ATOMIC_TYPE_UINT),
286                 def_create_intrinsic_fkt,
287                 NULL
288         };
289
290         if (arch_create_intrinsic) {
291                 init.create_intrinsic = arch_create_intrinsic;
292                 init.ctx              = create_intrinsic_ctx;
293         }
294         lower_dw_ops(&init);
295 }
296
297 typedef enum opt_target {
298         OPT_TARGET_IRG, /**< optimization function works on a single graph */
299         OPT_TARGET_IRP  /**< optimization function works on the complete program */
300 } opt_target_t;
301
302 typedef enum opt_flags {
303         OPT_FLAG_NONE         = 0,
304         OPT_FLAG_ENABLED      = 1 << 0, /**< enable the optimization */
305         OPT_FLAG_NO_DUMP      = 1 << 1, /**< don't dump after transformation */
306         OPT_FLAG_NO_VERIFY    = 1 << 2, /**< don't verify after transformation */
307         OPT_FLAG_HIDE_OPTIONS = 1 << 3, /**< do not automatically process
308                                              -foptions for this transformation */
309         OPT_FLAG_ESSENTIAL    = 1 << 4, /**< output won't work without this pass
310                                              so we need it even with -O0 */
311 } opt_flags_t;
312
313 typedef void (*transform_irg_func)(ir_graph *irg);
314 typedef void (*transform_irp_func)(void);
315 typedef void (*func_ptr_t)(void);
316
317 typedef struct {
318         opt_target_t  target;
319         const char   *name;
320         func_ptr_t    func;
321         const char   *description;
322         opt_flags_t   flags;
323 } opt_config_t;
324
325 static opt_config_t opts[] = {
326         { OPT_TARGET_IRP, "rts",             (func_ptr_t) rts_map,                 "optimization of known library functions", OPT_FLAG_HIDE_OPTIONS },
327         { OPT_TARGET_IRG, "combo",           (func_ptr_t) combo,                   "combined CCE, UCE and GVN",               OPT_FLAG_NONE},
328         { OPT_TARGET_IRG, "control-flow",    (func_ptr_t) optimize_cf,             "optimization of control-flow",            OPT_FLAG_HIDE_OPTIONS },
329         { OPT_TARGET_IRG, "local",           (func_ptr_t) optimize_graph_df,       "local graph optimizations",               OPT_FLAG_HIDE_OPTIONS },
330         { OPT_TARGET_IRP, "remove-unused",   (func_ptr_t) remove_unused_functions, "removal of unused functions",             OPT_FLAG_NO_DUMP | OPT_FLAG_NO_VERIFY },
331         { OPT_TARGET_IRP, "opt-tail-rec",    (func_ptr_t) opt_tail_recursion,      "tail-recursion eliminiation",             OPT_FLAG_NONE },
332         { OPT_TARGET_IRP, "opt-func-call",   (func_ptr_t) do_optimize_funccalls,   "function call optimization",              OPT_FLAG_NONE },
333         { OPT_TARGET_IRG, "lower",           (func_ptr_t) do_lower_highlevel,      "lowering",                                OPT_FLAG_HIDE_OPTIONS | OPT_FLAG_ESSENTIAL },
334         { OPT_TARGET_IRP, "lower-const",     (func_ptr_t) lower_const_code,        "lowering of constant code",               OPT_FLAG_HIDE_OPTIONS | OPT_FLAG_NO_DUMP | OPT_FLAG_NO_VERIFY | OPT_FLAG_ESSENTIAL },
335         { OPT_TARGET_IRP, "lower-dw",        (func_ptr_t) do_lower_dw_ops,         "lowering of doubleword operations",       OPT_FLAG_HIDE_OPTIONS | OPT_FLAG_ESSENTIAL },
336         { OPT_TARGET_IRG, "lower-switch",    (func_ptr_t) do_lower_switch,         "switch lowering",                         OPT_FLAG_HIDE_OPTIONS | OPT_FLAG_ESSENTIAL },
337         { OPT_TARGET_IRG, "one-return",      (func_ptr_t) normalize_one_return,    "normalisation to 1 return",               OPT_FLAG_HIDE_OPTIONS | OPT_FLAG_NO_DUMP | OPT_FLAG_NO_VERIFY },
338         { OPT_TARGET_IRG, "scalar-replace",  (func_ptr_t) scalar_replacement_opt,  "scalar replacement",                      OPT_FLAG_NONE },
339         { OPT_TARGET_IRG, "reassociation",   (func_ptr_t) optimize_reassociation,  "reassociation",                           OPT_FLAG_NONE },
340         { OPT_TARGET_IRG, "gcse",            (func_ptr_t) do_gcse,                 "global common subexpression elimination", OPT_FLAG_NONE },
341         { OPT_TARGET_IRG, "place",           (func_ptr_t) place_code,              "code placement",                          OPT_FLAG_NONE },
342         { OPT_TARGET_IRG, "confirm",         (func_ptr_t) construct_confirms,      "confirm optimisation",                    OPT_FLAG_HIDE_OPTIONS },
343         { OPT_TARGET_IRG, "opt-load-store",  (func_ptr_t) optimize_load_store,     "load store optimization",                 OPT_FLAG_NONE },
344         { OPT_TARGET_IRG, "parallelize-mem", (func_ptr_t) opt_parallelize_mem,     "parallelize memory",                      OPT_FLAG_NONE },
345         { OPT_TARGET_IRG, "deconv",          (func_ptr_t) conv_opt,                "conv node elimination",                   OPT_FLAG_NONE },
346         { OPT_TARGET_IRG, "thread-jumps",    (func_ptr_t) opt_jumpthreading,       "path-sensitive jumpthreading",            OPT_FLAG_NONE },
347         { OPT_TARGET_IRG, "remove-confirms", (func_ptr_t) remove_confirms,         "confirm removal",                         OPT_FLAG_HIDE_OPTIONS | OPT_FLAG_NO_DUMP | OPT_FLAG_NO_VERIFY },
348         { OPT_TARGET_IRG, "gvn-pre",         (func_ptr_t) do_gvn_pre,              "global value numbering partial redundancy elimination", OPT_FLAG_NONE },
349         { OPT_TARGET_IRG, "if-conversion",   (func_ptr_t) do_if_conv,              "if-conversion",                           OPT_FLAG_NONE },
350         { OPT_TARGET_IRG, "bool",            (func_ptr_t) opt_bool,                "bool simplification",                     OPT_FLAG_NONE },
351         { OPT_TARGET_IRG, "shape-blocks",    (func_ptr_t) shape_blocks,            "block shaping",                           OPT_FLAG_NONE },
352         { OPT_TARGET_IRG, "ivopts",          (func_ptr_t) do_stred,                "induction variable strength reduction",   OPT_FLAG_NONE },
353         { OPT_TARGET_IRG, "remove-phi-cycles", (func_ptr_t) remove_phi_cycles,     "removal of phi cycles",                   OPT_FLAG_HIDE_OPTIONS },
354         { OPT_TARGET_IRG, "dead",            (func_ptr_t) dead_node_elimination,   "dead node elimination",                   OPT_FLAG_HIDE_OPTIONS | OPT_FLAG_NO_DUMP | OPT_FLAG_NO_VERIFY },
355         { OPT_TARGET_IRP, "inline",          (func_ptr_t) do_inline,               "inlining",                                OPT_FLAG_NONE },
356         { OPT_TARGET_IRP, "opt-proc-clone",  (func_ptr_t) do_cloning,              "procedure cloning",                       OPT_FLAG_NONE },
357         { OPT_TARGET_IRG, "invert-loops",    (func_ptr_t) do_loop_inversion,       "loop inversion",                          OPT_FLAG_NONE },
358         { OPT_TARGET_IRG, "peel-loops",      (func_ptr_t) do_loop_peeling,         "loop peeling",                            OPT_FLAG_NONE },
359         { OPT_TARGET_IRG, "lower-mux",       (func_ptr_t) do_lower_mux,            "mux lowering",                            OPT_FLAG_NONE },
360 };
361 static const int n_opts = sizeof(opts) / sizeof(opts[0]);
362 ir_timer_t *timers[sizeof(opts)/sizeof(opts[0])];
363
364 static opt_config_t *get_opt(const char *name)
365 {
366         int i;
367         for (i = 0; i < n_opts; ++i) {
368                 opt_config_t *config = &opts[i];
369                 if (strcmp(config->name, name) == 0)
370                         return config;
371         }
372
373         return NULL;
374 }
375
376 static void set_opt_enabled(const char *name, bool enabled)
377 {
378         opt_config_t *config = get_opt(name);
379         config->flags = (config->flags & ~OPT_FLAG_ENABLED)
380                 | (enabled ? OPT_FLAG_ENABLED : 0);
381 }
382
383 static bool get_opt_enabled(const char *name)
384 {
385         opt_config_t *config = get_opt(name);
386         return (config->flags & OPT_FLAG_ENABLED) != 0;
387 }
388
389 /**
390  * perform an optimisation on a single graph
391  *
392  * @return  true if something changed, false otherwise
393  */
394 static bool do_irg_opt(ir_graph *irg, const char *name)
395 {
396         transform_irg_func  func;
397         ir_graph           *old_irg;
398         opt_config_t       *config = get_opt(name);
399         size_t              n      = config - opts;
400         assert(config != NULL);
401         assert(config->target == OPT_TARGET_IRG);
402         if (! (config->flags & OPT_FLAG_ENABLED))
403                 return false;
404
405
406         old_irg          = current_ir_graph;
407         current_ir_graph = irg;
408
409         func = (transform_irg_func) config->func;
410
411         timer_push(timers[n]);
412         func(irg);
413         timer_pop(timers[n]);
414
415         if (firm_dump.all_phases && firm_dump.ir_graph) {
416                 dump_graph_count(irg, name);
417         }
418
419         if (firm_opt.check_all) {
420                 timer_push(t_verify);
421                 irg_verify(irg, VRFY_ENFORCE_SSA);
422                 timer_pop(t_verify);
423         }
424
425         current_ir_graph = old_irg;
426         return true;
427 }
428
429 static void do_irp_opt(const char *name)
430 {
431         transform_irp_func  func;
432         opt_config_t       *config = get_opt(name);
433         size_t              n      = config - opts;
434         assert(config->target == OPT_TARGET_IRP);
435         if (! (config->flags & OPT_FLAG_ENABLED))
436                 return;
437
438         func = (transform_irp_func) config->func;
439
440         timer_push(timers[n]);
441         func();
442         timer_pop(timers[n]);
443
444         if (firm_dump.ir_graph && firm_dump.all_phases) {
445                 int i;
446                 for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
447                         ir_graph *irg = get_irp_irg(i);
448                         dump_graph_count(irg, name);
449                 }
450         }
451
452         if (firm_opt.check_all) {
453                 int i;
454                 timer_push(t_verify);
455                 for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
456                         irg_verify(get_irp_irg(i), VRFY_ENFORCE_SSA);
457                 }
458                 timer_pop(t_verify);
459         }
460 }
461
462 /**
463  * Enable transformations which should be always safe (and cheap) to perform
464  */
465 static void enable_safe_defaults(void)
466 {
467         set_opt_enabled("remove-unused", true);
468         set_opt_enabled("opt-tail-rec", true);
469         set_opt_enabled("opt-func-call", true);
470         set_opt_enabled("reassociation", true);
471         set_opt_enabled("control-flow", true);
472         set_opt_enabled("local", true);
473         set_opt_enabled("lower-const", true);
474         set_opt_enabled("scalar-replace", true);
475         set_opt_enabled("place", true);
476         set_opt_enabled("confirm", true);
477         set_opt_enabled("opt-load-store", true);
478         set_opt_enabled("lower", true);
479         set_opt_enabled("deconv", true);
480         set_opt_enabled("remove-confirms", true);
481         set_opt_enabled("ivopts", true);
482         set_opt_enabled("dead", true);
483         set_opt_enabled("lower-switch", true);
484         set_opt_enabled("remove-phi-cycles", true);
485 }
486
487 /**
488  * run all the Firm optimizations
489  *
490  * @param input_filename     the name of the (main) source file
491  */
492 static void do_firm_optimizations(const char *input_filename)
493 {
494         int      i;
495         unsigned aa_opt;
496
497         set_opt_alias_analysis(firm_opt.alias_analysis);
498
499         aa_opt = aa_opt_no_opt;
500         if (firm_opt.strict_alias)
501                 aa_opt |= aa_opt_type_based | aa_opt_byte_type_may_alias;
502         if (firm_opt.no_alias)
503                 aa_opt = aa_opt_no_alias;
504
505         set_irp_memory_disambiguator_options(aa_opt);
506
507         /* parameter passing code should set them directly sometime... */
508         set_opt_enabled("rts", !firm_opt.freestanding);
509         set_opt_enabled("gcse", firm_opt.gcse);
510         set_opt_enabled("place", !firm_opt.gcse);
511         set_opt_enabled("confirm", firm_opt.confirm);
512         set_opt_enabled("remove-confirms", firm_opt.confirm);
513
514         /* osr supersedes remove_phi_cycles */
515         if (get_opt_enabled("ivopts"))
516                 set_opt_enabled("remove-phi-cycles", false);
517
518         timer_start(t_all_opt);
519
520         do_irp_opt("rts");
521
522         /* first step: kill dead code */
523         for (i = 0; i < get_irp_n_irgs(); i++) {
524                 ir_graph *irg = get_irp_irg(i);
525                 do_irg_opt(irg, "combo");
526                 do_irg_opt(irg, "local");
527                 do_irg_opt(irg, "control-flow");
528         }
529
530         do_irp_opt("remove-unused");
531         do_irp_opt("opt-tail-rec");
532         do_irp_opt("opt-func-call");
533         do_irp_opt("lower-const");
534
535         for (i = 0; i < get_irp_n_irgs(); i++) {
536                 ir_graph *irg = get_irp_irg(i);
537
538                 do_irg_opt(irg, "scalar-replace");
539                 do_irg_opt(irg, "invert-loops");
540                 do_irg_opt(irg, "local");
541                 do_irg_opt(irg, "reassociation");
542                 do_irg_opt(irg, "local");
543                 do_irg_opt(irg, "gcse");
544
545                 if (firm_opt.confirm) {
546                         /* Confirm construction currently can only handle blocks with only
547                            one control flow predecessor. Calling optimize_cf here removes
548                            Bad predecessors and help the optimization of switch constructs.
549                          */
550                         do_irg_opt(irg, "control-flow");
551                         do_irg_opt(irg, "confirm");
552                         do_irg_opt(irg, "local");
553                 }
554
555                 do_irg_opt(irg, "control-flow");
556                 do_irg_opt(irg, "opt-load-store");
557                 do_irg_opt(irg, "lower");
558                 do_irg_opt(irg, "deconv");
559                 do_irg_opt(irg, "thread-jumps");
560                 do_irg_opt(irg, "remove-confirms");
561                 do_irg_opt(irg, "gvn-pre");
562                 do_irg_opt(irg, "place");
563                 do_irg_opt(irg, "control-flow");
564
565                 if (do_irg_opt(irg, "if-conversion")) {
566                         do_irg_opt(irg, "local");
567                         do_irg_opt(irg, "control-flow");
568                 }
569                 /* this doesn't make too much sense but tests the mux destruction... */
570                 do_irg_opt(irg, "lower-mux");
571
572                 do_irg_opt(irg, "bool");
573                 do_irg_opt(irg, "shape-blocks");
574                 do_irg_opt(irg, "lower-switch");
575                 do_irg_opt(irg, "ivopts");
576                 do_irg_opt(irg, "local");
577                 do_irg_opt(irg, "dead");
578         }
579
580         do_irp_opt("inline");
581         do_irp_opt("opt-proc-clone");
582
583         for (i = 0; i < get_irp_n_irgs(); i++) {
584                 ir_graph *irg = get_irp_irg(i);
585                 do_irg_opt(irg, "local");
586                 do_irg_opt(irg, "control-flow");
587                 do_irg_opt(irg, "thread-jumps");
588                 do_irg_opt(irg, "local");
589                 do_irg_opt(irg, "control-flow");
590         }
591
592         if (firm_dump.ir_graph) {
593                 /* recompute backedges for nicer dumps */
594                 for (i = 0; i < get_irp_n_irgs(); i++)
595                         construct_cf_backedges(get_irp_irg(i));
596         }
597
598         do_irp_opt("remove-unused");
599
600         dump_all("-opt");
601
602         if (firm_dump.statistic & STAT_AFTER_OPT)
603                 stat_dump_snapshot(input_filename, "opt");
604
605         timer_stop(t_all_opt);
606 }
607
608 /**
609  * compute the size of a type (do implicit lowering)
610  *
611  * @param ty   a Firm type
612  */
613 static int compute_type_size(ir_type *ty)
614 {
615         optimization_state_t state;
616         unsigned             align_all = 1;
617         int                  n, size = 0, set = 0;
618         int                  i, dims, s;
619
620         if (get_type_state(ty) == layout_fixed) {
621                 /* do not layout already layouted types again */
622                 return 1;
623         }
624
625         if (is_Method_type(ty) || ty == get_glob_type()) {
626                 /* no need for size calculation for method types or the global type */
627                 return 1;
628         }
629
630         DBG(("compute type size visiting: %s\n", get_type_name(ty)));
631
632         switch (get_type_tpop_code(ty)) {
633         case tpo_class:
634         case tpo_struct:
635                 for (i = 0, n = get_compound_n_members(ty); i < n; ++i) {
636                         ir_entity *ent  = get_compound_member(ty, i);
637                         ir_type *ent_ty = get_entity_type(ent);
638                         unsigned align, misalign;
639
640                         /* inner functions do not expand the frame */
641                         if (is_Method_type(ent_ty) && is_frame_type(ty))
642                                 continue;
643
644                         /* compute member types */
645                         if (! compute_type_size(ent_ty))
646                                 return 0;
647
648                         align     = get_type_alignment_bytes(ent_ty);
649                         align_all = align > align_all ? align : align_all;
650                         misalign  = (align ? size % align : 0);
651                         size     += (misalign ? align - misalign : 0);
652
653                         set_entity_offset(ent, size);
654                         size += get_type_size_bytes(ent_ty);
655
656                         DBG(("  member %s %s -> (size: %u, align: %u)\n",
657                                                 get_type_name(ent_ty), get_entity_name(ent),
658                                                 get_type_size_bytes(ent_ty), get_type_alignment_bytes(ent_ty)));
659                 }
660                 if (align_all > 0 && size % align_all) {
661                         DBG(("align of the struct member: %u, type size: %d\n", align_all, size));
662                         size += align_all - (size % align_all);
663                         DBG(("correcting type-size to %d\n", size));
664                 }
665                 set_type_alignment_bytes(ty, align_all);
666                 set = 1;
667                 break;
668
669         case tpo_union:
670                 for (i = 0, n = get_union_n_members(ty); i < n; ++i) {
671                         ir_entity *ent = get_union_member(ty, i);
672
673                         if (! compute_type_size(get_entity_type(ent)))
674                                 return 0;
675                         s = get_type_size_bytes(get_entity_type(ent));
676
677                         set_entity_offset(ent, 0);
678                         size = (s > size ? s : size);
679                 }
680                 set = 1;
681                 break;
682
683         case tpo_array:
684                 dims = get_array_n_dimensions(ty);
685
686                 if (! compute_type_size(get_array_element_type(ty)))
687                         return 0;
688
689                 size = 1;
690
691                 save_optimization_state(&state);
692                 set_optimize(1);
693                 set_opt_constant_folding(1);
694                 set_opt_algebraic_simplification(1);
695
696                 for (i = 0; i < dims; ++i) {
697                         ir_node *lower   = get_array_lower_bound(ty, i);
698                         ir_node *upper   = get_array_upper_bound(ty, i);
699                         ir_graph *rem    = current_ir_graph;
700                         tarval  *tv_lower, *tv_upper;
701                         long     val_lower, val_upper;
702
703                         current_ir_graph = get_const_code_irg();
704                         local_optimize_node(lower);
705                         local_optimize_node(upper);
706                         current_ir_graph = rem;
707
708                         tv_lower = computed_value(lower);
709                         tv_upper = computed_value(upper);
710
711                         if (tv_lower == tarval_bad || tv_upper == tarval_bad) {
712                                 /*
713                                  * we cannot calculate the size of this array yet, it
714                                  * even might be unknown until the end, like argv[]
715                                  */
716                                 restore_optimization_state(&state);
717                                 return 0;
718                         }
719
720                         val_upper = get_tarval_long(tv_upper);
721                         val_lower = get_tarval_long(tv_lower);
722                         size     *= val_upper - val_lower;
723                 }
724                 restore_optimization_state(&state);
725
726                 DBG(("array %s -> (elements: %d, element type size: %d)\n",
727                                         get_type_name(ty),
728                                         size, get_type_size_bytes(get_array_element_type(ty))));
729                 size *= get_type_size_bytes(get_array_element_type(ty));
730                 set = 1;
731                 break;
732
733         default:
734                 break;
735         }
736
737         if (set) {
738                 set_type_size_bytes(ty, size);
739                 set_type_state(ty, layout_fixed);
740         }
741
742         DBG(("size: %d\n", get_type_size_bytes(ty)));
743
744         return set;
745 }
746
747 /**
748  * layout all non-frame types of the Firm graph
749  */
750 static void compute_type_sizes(void)
751 {
752         int i;
753         ir_type *tp;
754
755         /* all non-frame other types */
756         for (i = get_irp_n_types() - 1; i >= 0; --i) {
757                 tp = get_irp_type(i);
758                 compute_type_size(tp);
759
760                 if (is_Method_type(tp)) {
761                         tp = get_method_value_res_type(tp);
762
763                         if (tp) {
764                                 /* we have a value result type for this method, lower */
765                                 compute_type_size(tp);
766                         }
767                 }
768         }
769 }
770
771 /**
772  * layout all frame-types of the Firm graph
773  */
774 static void compute_frame_type_sizes(void)
775 {
776         int i;
777         ir_graph *irg;
778
779         /* all frame types */
780         for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
781                 irg = get_irp_irg(i);
782                 /* do not optimize away variables in debug mode */
783                 if (firm_opt.debug_mode == DBG_MODE_NONE)
784                         opt_frame_irg(irg);
785                 compute_type_size(get_irg_frame_type(irg));
786         }
787 }
788
789 /**
790  * do Firm lowering
791  *
792  * @param input_filename  the name of the (main) source file
793  */
794 static void do_firm_lowering(const char *input_filename)
795 {
796         int i;
797
798         do_irp_opt("lower-dw");
799
800         if (firm_dump.statistic & STAT_AFTER_LOWER)
801                 stat_dump_snapshot(input_filename, "low");
802
803         dump_all("-low");
804
805         if (firm_opt.enabled) {
806                 timer_start(t_all_opt);
807
808                 /* run reassociation first on all graphs BEFORE the architecture
809                    dependent optimizations are enabled */
810                 for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
811                         ir_graph *irg = get_irp_irg(i);
812                         do_irg_opt(irg, "reassociation");
813                 }
814
815                 /* enable architecture dependent optimizations */
816                 arch_dep_set_opts((arch_dep_opts_t)
817                                 ((firm_opt.muls ? arch_dep_mul_to_shift : arch_dep_none) |
818                                  (firm_opt.divs ? arch_dep_div_by_const : arch_dep_none) |
819                                  (firm_opt.mods ? arch_dep_mod_by_const : arch_dep_none) ));
820
821                 for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
822                         ir_graph *irg = get_irp_irg(i);
823
824                         current_ir_graph = irg;
825
826                         do_irg_opt(irg, "local");
827                         do_irg_opt(irg, "gcse");
828                         do_irg_opt(irg, "opt-load-store");
829                         do_irg_opt(irg, "local");
830                         do_irg_opt(irg, "control-flow");
831
832                         if (do_irg_opt(irg, "if-conversion")) {
833                                 do_irg_opt(irg, "local");
834                                 do_irg_opt(irg, "control-flow");
835                         }
836
837                         do_irg_opt(irg, "parallelize-mem");
838                 }
839                 timer_stop(t_all_opt);
840
841                 dump_all("-low-opt");
842         }
843
844         if (firm_opt.cc_opt)
845                 mark_private_methods();
846
847         /* set the phase to low */
848         for (i = get_irp_n_irgs() - 1; i >= 0; --i)
849                 set_irg_phase_low(get_irp_irg(i));
850
851         /* all graphs are lowered, set the irp phase to low */
852         set_irp_phase_state(phase_low);
853
854         if (firm_dump.statistic & STAT_FINAL) {
855                 stat_dump_snapshot(input_filename, "final");
856         }
857 }
858
859 /**
860  * Initialize for the Firm-generating back end.
861  */
862 void gen_firm_init(void)
863 {
864         firm_parameter_t params;
865         unsigned         pattern = 0;
866         int              i;
867
868         for (i = 0; i < n_opts; ++i) {
869                 timers[i] = ir_timer_new();
870                 timer_register(timers[i], opts[i].description);
871         }
872         t_verify = ir_timer_new();
873         timer_register(t_verify, "Firm: verify pass");
874         t_vcg_dump = ir_timer_new();
875         timer_register(t_vcg_dump, "Firm: vcg dumping");
876         t_all_opt = ir_timer_new();
877         timer_register(t_all_opt, "Firm: all optimizations");
878
879         if (firm_dump.stat_pattern)
880                 pattern |= FIRMSTAT_PATTERN_ENABLED;
881
882         if (firm_dump.stat_dag)
883                 pattern |= FIRMSTAT_COUNT_DAG;
884
885         memset(&params, 0, sizeof(params));
886         params.size                  = sizeof(params);
887         params.enable_statistics     = firm_dump.statistic == STAT_NONE ? 0 :
888                 FIRMSTAT_ENABLED | FIRMSTAT_COUNT_STRONG_OP | FIRMSTAT_COUNT_CONSTS
889                 | pattern;
890         params.initialize_local_func = uninitialized_local_var;
891         params.cc_mask               = 0; /* no regparam, cdecl */
892
893         ir_init(&params);
894
895         if (firm_be_opt.selection == BE_FIRM_BE) {
896                 const backend_params *be_params = be_get_backend_param();
897
898                 if (be_params->do_dw_lowering)
899                         set_opt_enabled("lower-dw", true);
900
901                 arch_create_intrinsic   = be_params->arch_create_intrinsic_fkt;
902                 create_intrinsic_ctx    = be_params->create_intrinsic_ctx;
903
904                 ad_param                = be_params->dep_param;
905                 if_conv_info            = be_params->if_conv_info;
906         }
907
908         edges_init_dbg(firm_opt.vrfy_edges);
909
910         /* Sel node cannot produce NULL pointers */
911         set_opt_sel_based_null_check_elim(1);
912
913         /* dynamic dispatch works currently only if whole world scenarios */
914         set_opt_dyn_meth_dispatch(0);
915
916         arch_dep_init(arch_factory);
917
918         /* do not run architecture dependent optimizations in building phase */
919         arch_dep_set_opts(arch_dep_none);
920
921         do_node_verification((firm_verification_t) firm_opt.vrfy);
922         if (firm_dump.filter)
923                 only_dump_method_with_name(new_id_from_str(firm_dump.filter));
924
925         if (firm_opt.enabled) {
926                 set_optimize(1);
927                 set_opt_constant_folding(firm_opt.const_folding);
928                 set_opt_algebraic_simplification(firm_opt.const_folding);
929                 set_opt_cse(firm_opt.cse);
930                 set_opt_global_cse(0);
931                 set_opt_unreachable_code(1);
932                 set_opt_control_flow(firm_opt.control_flow);
933                 set_opt_control_flow_weak_simplification(1);
934                 set_opt_control_flow_strong_simplification(1);
935         } else {
936                 set_optimize(0);
937         }
938
939         /* do not dump entity ld names */
940         dump_ld_names(0);
941 }
942
943 /**
944  * Called, after the Firm generation is completed,
945  * do all optimizations and backend call here.
946  *
947  * @param out                a file handle for the output, may be NULL
948  * @param input_filename     the name of the (main) source file
949  * @param c_mode             non-zero if "C" was compiled
950  * @param new_firm_const_exists  non-zero, if the const attribute was used on functions
951  */
952 void gen_firm_finish(FILE *out, const char *input_filename, int c_mode,
953                      int new_firm_const_exists)
954 {
955         int i;
956
957 #if 0
958         if (firm_opt.enable_statev) {
959                 char buf[1024];
960                 snprintf(buf, sizeof(buf), "%s.ev", input_filename);
961                 ir_stat_ev_begin(input_filename, firm_opt.statev_filter);
962                 ir_stat_ev_compilation_unit(input_filename);
963         }
964 #endif
965
966         firm_const_exists = new_firm_const_exists;
967
968         /* the general for dumping option must be set, or the others will not work*/
969         firm_dump.ir_graph
970                 = (a_byte) (firm_dump.ir_graph | firm_dump.all_phases | firm_dump.extbb);
971
972         dump_keepalive_edges(1);
973         dump_consts_local(1);
974         dump_dominator_information(1);
975         dump_loop_information(0);
976
977         if (!firm_dump.edge_labels)
978                 turn_off_edge_labels();
979
980         /* FIXME: cloning might ADD new graphs. */
981         irg_dump_no = calloc(get_irp_last_idx(), sizeof(*irg_dump_no));
982
983         if (firm_dump.all_types) {
984                 dump_all_types("");
985                 if (! c_mode) {
986                         dump_class_hierarchy(0, "");
987                         dump_class_hierarchy(1, "-with-entities");
988                 }
989         }
990
991         /* finalize all graphs */
992         for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
993                 ir_graph *irg = get_irp_irg(i);
994                 irg_finalize_cons(irg);
995         }
996         dump_all("");
997
998         timer_push(t_verify);
999         tr_vrfy();
1000         timer_pop(t_verify);
1001
1002         /* all graphs are finalized, set the irp phase to high */
1003         set_irp_phase_state(phase_high);
1004
1005         /* BEWARE: kill unreachable code before doing compound lowering */
1006         for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
1007                 ir_graph *irg = get_irp_irg(i);
1008                 do_irg_opt(irg, "control-flow");
1009         }
1010
1011         /* lower all compound call return values */
1012         lower_compound_params();
1013
1014         /* computes the sizes of all types that are still not computed */
1015         compute_type_sizes();
1016
1017         /* lower copyb nodes */
1018         for (i = get_irp_n_irgs() - 1; i >= 0; --i) {
1019                 ir_graph *irg = get_irp_irg(i);
1020                 lower_CopyB(irg, 128, 4);
1021         }
1022
1023         if (firm_dump.statistic & STAT_BEFORE_OPT) {
1024                 stat_dump_snapshot(input_filename, "noopt");
1025         }
1026
1027         if (firm_opt.enabled)
1028                 do_firm_optimizations(input_filename);
1029
1030         if (firm_opt.lower)
1031                 do_firm_lowering(input_filename);
1032
1033         /* computes the sizes of all frame types */
1034         compute_frame_type_sizes();
1035
1036         /* set the phase to low */
1037         for (i = get_irp_n_irgs() - 1; i >= 0; --i)
1038                 set_irg_phase_low(get_irp_irg(i));
1039
1040         if (firm_dump.statistic & STAT_FINAL_IR)
1041                 stat_dump_snapshot(input_filename, "final-ir");
1042
1043         /* run the code generator */
1044         if (firm_be_opt.selection != BE_NONE)
1045                 do_codegen(out, input_filename);
1046
1047         if (firm_dump.statistic & STAT_FINAL)
1048                 stat_dump_snapshot(input_filename, "final");
1049 }
1050
1051 void disable_all_opts(void)
1052 {
1053         for (int i = 0; i < n_opts; ++i) {
1054                 opt_config_t *config = &opts[i];
1055                 if (config->flags & OPT_FLAG_ESSENTIAL) {
1056                         config->flags |= OPT_FLAG_ENABLED;
1057                 } else {
1058                         config->flags &= ~OPT_FLAG_ENABLED;
1059                 }
1060         }
1061 }
1062
1063 int firm_opt_option(const char *opt)
1064 {
1065         bool enable = true;
1066         if (strncmp(opt, "no-", 3) == 0) {
1067                 enable = false;
1068                 opt = opt + 3;
1069         }
1070
1071         opt_config_t *config = get_opt(opt);
1072         if (config == NULL || (config->flags & OPT_FLAG_HIDE_OPTIONS))
1073                 return 0;
1074
1075         config->flags &= ~OPT_FLAG_ENABLED;
1076         config->flags |= enable ? OPT_FLAG_ENABLED : 0;
1077         return 1;
1078 }
1079
1080 void firm_opt_option_help(void)
1081 {
1082         int i;
1083
1084         for (i = 0; i < n_opts; ++i) {
1085                 char buf[1024];
1086                 char buf2[1024];
1087
1088                 const opt_config_t *config = &opts[i];
1089                 if (config->flags & OPT_FLAG_HIDE_OPTIONS)
1090                         continue;
1091
1092                 snprintf(buf2, sizeof(buf2), "firm: enable %s", config->description);
1093                 print_option_help(config->name, buf2);
1094                 snprintf(buf, sizeof(buf), "no-%s", config->name);
1095                 snprintf(buf2, sizeof(buf2), "firm: disable %s", config->description);
1096                 print_option_help(buf, buf2);
1097         }
1098 }
1099
1100 /**
1101  * Do very early initializations
1102  */
1103 void firm_early_init(void)
1104 {
1105         /* arg: need this here for command line options */
1106         be_opt_register();
1107
1108         enable_safe_defaults();
1109 }