added new compiler optimization flag
[libfirm] / ir / ir / irflag.h
1 /*
2  * Project:     libFIRM
3  * File name:   ir/ir/irflag.h
4  * Purpose:     Flags to control optimizations.
5  * Author:      Christian Schaefer, Goetz Lindenmaier
6  * Modified by:
7  * Created:
8  * CVS-ID:      $Id$
9  * Copyright:   (c) 1999-2003 Universität Karlsruhe
10  * Licence:     This file protected by GPL -  GNU GENERAL PUBLIC LICENSE.
11  */
12
13 /**
14  * @file irflag.h
15  *
16  * Optimization flags.
17  *
18  * @author Christian Schaefer
19  */
20
21 #ifndef _IRFLAG_H_
22 #define _IRFLAG_H_
23
24 /**
25  * A container type to load/restore all optimizations
26  */
27 typedef unsigned optimization_state_t;
28
29 /**
30  * This function enables/disables optimizations globally.
31  *
32  * If optimize == 0 no optimizations are performed at all.
33  * Default: optimize == 1.
34  */
35 void set_optimize (int value);
36 int get_optimize(void);
37
38 /** Enables/Disables constant folding optimization.
39  *
40  *  If opt_constant_folding == 1 perform
41  *  - constant expression evaluation (2 + 5 ==> 7, 3 < 2 ==> false)
42  *  - algebraic simplification  (a * 0 ==> 0, a or a ==> a)
43  *  - simplification of tests   ( !(a < b) ==> (a >= b))
44  *  - refining the memory representation
45  *  - remove store after load
46  * Default: opt_constant_folding == 1.
47  */
48 void set_opt_constant_folding (int value);
49
50 /** Enables/Disables constant subexpression elimination.
51  *
52  * If opt_cse == 1 perform constant subexpression elimination.
53  * Default: opt_cse == 1.
54  */
55 void set_opt_cse (int value);
56
57 /** Enables/Disables global constant subexpression elimination.
58  *
59  * If opt_global_cse == 1 and opt_cse == 1 perform intra procedure
60  * constant subexpression elimination for floating nodes.  Intra
61  * procedure cse gets the graph into state "floating".  It is necessary
62  * to run pre/code motion to get the graph back into state "pinned".
63  * right after a call to local_optimize with global cse turned on.
64  * Default: opt_global_cse == 0.
65  */
66 void set_opt_global_cse (int value);
67
68 /** Enables/Disables unreachable code elimination.
69  *
70  * If opt_unreachable_code == 1 replace nodes (except Block,
71  * Phi and Tuple) with a Bad predecessor by the Bad node.
72  * Default: opt_unreachable_code == 1.
73  */
74 void set_opt_unreachable_code(int value);
75
76 /** Enables/Disables control flow optimizations.
77  *
78  * Performs Straightening, if simplifications and loop simplifications.
79  * Sets all separate control flow flags (control_flow_straightening,
80  * weak_simplification, strong_simplification and critical_edges).
81  */
82 void set_opt_control_flow(int value);
83
84 /** Enables/Disables Straightening. */
85 void set_opt_control_flow_straightening(int value);
86
87 /** Enables/Disables if simplifications in local optimizations. */
88 void set_opt_control_flow_weak_simplification(int value);
89
90 /** Enables/Disables strong if and loop simplification (in optimize_cf). */
91 void set_opt_control_flow_strong_simplification(int value);
92
93 /** Enables/Disables removal of critical control flow edges. */
94 void set_opt_critical_edges(int value);
95
96 /** Enables/Disables reassociation.
97  *
98  * If opt_reassociation == 1 reassociation is performed.
99  * Default: opt_reassociation == 1.
100  */
101 void set_opt_reassociation(int value);
102
103 /** Enables/Disables dead node elimination.
104  *
105  * If opt_dead_node_elimination == 1 deallocate all dead nodes
106  * by copying the firm graph.
107  * Default: opt_dead_node_elimination == 1. */
108 void set_opt_dead_node_elimination (int value);
109
110 /** Enables/Disables dead method elimination.
111  *
112  * If opt_dead_method_elimination == 1 methods never called are
113  * removed.
114  * Default: opt_dead_method_elimination == 1. */
115 void set_opt_dead_method_elimination (int value);
116 void set_opt_dead_method_elimination_verbose (int value);
117
118 /** Enable/Disables inlining.
119  *
120  * If opt_inline == 1 the inlining transformation is performed.
121  */
122 void set_opt_inline (int value);
123
124 /** Enable/Disable optimization of dynamic method dispatch
125  *
126  * This flag enables/disables the optimization of dynamic method dispatch.
127  * If the flag is turned on Sel nodes can be replaced by Const nodes representing
128  * the address of a function.
129  */
130 void set_opt_dyn_meth_dispatch (int value);
131
132 /** Enable/Disable normalizations of the firm representation.
133  *
134  *  This flag guards transformations that normalize the firm representation
135  *  as removing Ids and Tuples, useless Phis, replacing SymConst(id) by
136  *  Const(entity) and others.
137  *  The transformations guarded by this flag are not guarded by flag
138  *  "optimize".
139  *  Many algorithms operating on firm can not deal with constructs in
140  *  the non-normalized representation.
141  *  default: 1
142  *  @@@ ATTENTION: not all such transformations are guarded by a flag.
143  */
144 void set_opt_normalize (int value);
145
146 /** Enable/Disable optimization of tail-recursion calls.
147  *
148  * This flag enables/disables the optimization tail-recursion call.
149  * If the flag is turned on tail-recursion calls are optimized into loops.
150  */
151 void set_opt_tail_recursion(int value);
152
153 /**
154  * Save the current optimization state.
155  */
156 void save_optimization_state(optimization_state_t *state);
157
158 /**
159  * Restore the current optimization state.
160  */
161 void restore_optimization_state(const optimization_state_t *state);
162
163 #endif