2 * Copyright (C) 1995-2007 University of Karlsruhe. All right reserved.
4 * This file is part of libFirm.
6 * This file may be distributed and/or modified under the terms of the
7 * GNU General Public License version 2 as published by the Free Software
8 * Foundation and appearing in the file LICENSE.GPL included in the
9 * packaging of this file.
11 * Licensees holding valid libFirm Professional Edition licenses may use
12 * this file in accordance with the libFirm Commercial License.
13 * Agreement provided with the Software.
15 * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
16 * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22 * @brief Available Optimisations of libFirm.
23 * @version $Id: cfopt.h 13543 2007-04-29 19:29:02Z beck $
25 #ifndef FIRM_IROPTIMIZE_H
26 #define FIRM_IROPTIMIZE_H
28 #include "firm_types.h"
31 * Control flow optimization.
33 * Removes empty blocks doing if simplifications and loop simplifications.
34 * A block is empty if it contains only a Jmp node and Phi nodes.
35 * Merges single entry single exit blocks with their predecessor
36 * and propagates dead control flow by calling equivalent_node().
37 * Independent of compiler flag it removes Tuples from cf edges,
38 * Bad predecessors from Blocks and Phis, and unnecessary predecessors of End.
40 * @bug So far destroys backedge information.
41 * @bug Chokes on Id nodes if called in a certain order with other
42 * optimizations. Call local_optimize_graph() before to remove
45 void optimize_cf(ir_graph *irg);
48 * Perform partial conditional evaluation on the given graph.
50 * @param irg the graph
52 void opt_cond_eval(ir_graph* irg);
55 * Try to simplify boolean expression in the given ir graph.
56 * eg. x < 5 && x < 6 becomes x < 5
58 * @param irg the graph
60 void opt_bool(ir_graph *irg);
63 * Try to reduce the number of conv nodes in the given ir graph.
65 * @param irg the graph
67 void conv_opt(ir_graph *irg);
70 * Do the scalar replacement optimization.
71 * Make a date flow analyze and split the
74 * @param irg the graph which should be optimized
76 void data_flow_scalar_replacement_opt(ir_graph *irg);
79 * A callback that checks whether a entity is an allocation
82 typedef int (*check_alloc_entity_func)(ir_entity *ent);
85 * Do simple and fast escape analysis for one graph.
87 * @param irg the graph
88 * @param callback a callback function to check whether a
89 * given entity is a allocation call
91 void escape_enalysis_irg(ir_graph *irg, check_alloc_entity_func callback);
94 * Do simple and fast escape analysis for all graphs.
96 * This optimization implements a simple and fast but inexact
97 * escape analysis. Some addresses might be marked as 'escaped' even
99 * The advantage is a low memory footprint and fast speed.
101 * @param run_scalar_replace if this flag in non-zero, scalar
102 * replacement optimization is run on graphs with removed
104 * @param callback a callback function to check whether a
105 * given entity is a allocation call
107 * This optimization removes allocation which are not used (rare) and replace
108 * allocation that can be proved dead at the end of the graph which stack variables.
110 * The creation of stack variable allows scalar replacement to be run only
111 * on those graphs that have been changed.
113 * This is most effective on Java where no other stack variables exists.
115 void escape_analysis(int run_scalar_replace, check_alloc_entity_func callback);
118 * Optimize function calls by handling const functions.
120 * This optimization first detects all "const functions", i.e.,
121 * IR graphs that neither read nor write memory (and hence did
122 * not create exceptions, as these use memory in Firm).
124 * The result of calls to such functions depends only on its
125 * arguments, hence those calls are no more pinned.
127 * This is a rather strong criteria, so do not expect that a
128 * lot of functions will be found. Moreover, all of them might
129 * already be inlined if inlining is activated.
130 * Anyway, it might be good for handling builtin's or pseudo-graphs,
131 * even if the later read/write memory (but we know how).
133 * This optimizations read the irg_const_function property of
134 * entities and and sets the irg_const_function property of
137 * If callee information is valid, we also optimize polymorphic Calls.
139 * @param force_run if non-zero, an optimization run is started even
140 * if no const function graph was detected.
141 * Else calls are only optimized if at least one
142 * const function graph was detected.
144 * If the fontend created external entities with the irg_const_function
145 * property set, the force_run parameter should be set, else
148 * @note This optimization destroys the link fields of nodes.
150 void optimize_funccalls(int force_run);
153 * Does Partial Redundancy Elimination combined with
154 * Global Value Numbering.
155 * Can be used to replace place_code() completely.
157 * Based on VanDrunen and Hosking 2004.
159 * @param irg the graph
162 * Currently completely broken because the used sets do NOT
163 * preserve the topological sort of its elements.
165 void do_gvn_pre(ir_graph *irg);
168 * This function is called to evaluate, if a mux can build
169 * of the current architecture.
170 * If it returns non-zero, a mux is created, else the code
172 * @param sel A selector of a Cond.
173 * @param phi_list List of Phi nodes about to be converted (linked via link field)
174 * @param i First data predecessor involved in if conversion
175 * @param j Second data predecessor involved in if conversion
177 typedef int (*arch_allow_ifconv_func)(ir_node *sel, ir_node* phi_list, int i, int j);
180 * The parameters structure.
182 struct ir_settings_if_conv_t {
183 int max_depth; /**< The maximum depth up to which expressions
184 are examined when it has to be decided if they
185 can be placed into another block. */
186 arch_allow_ifconv_func allow_ifconv; /**< Evaluator function, if not set all possible Psi
187 nodes will be created. */
191 * Perform If conversion on a graph.
193 * @param irg The graph.
194 * @param params The parameters for the if conversion.
196 * Cannot handle blocks with Bad control predecessors, so call it after control
199 void opt_if_conv(ir_graph *irg, const ir_settings_if_conv_t *params);
201 void opt_ldst2(ir_graph *irg);
204 * Load/Store optimization.
206 * Removes redundant non-volatile Loads and Stores.
207 * May introduce Bad nodes if exceptional control flow
208 * is removed. The following cases are optimized:
210 * Load without result: A Load which has only a memory use
213 * Load after Store: A Load after a Store is removed, if
214 * the Load doesn't have an exception handler OR is in
215 * the same block as the Store.
217 * Load after Load: A Load after a Load is removed, if the
218 * Load doesn't have an exception handler OR is in the
219 * same block as the previous Load.
221 * Store before Store: A Store immediately before another
222 * Store in the same block is removed, if the Store doesn't
223 * have an exception handler.
225 * Store after Load: A Store after a Load is removed, if the
226 * Store doesn't have an exception handler.
228 void optimize_load_store(ir_graph *irg);
231 * Do Loop unrolling in the given graph.
233 void optimize_loop_unrolling(ir_graph *irg);
236 * Optimize the frame type of an irg by removing
237 * never touched entities.
239 * @param irg The graph whose frame type will be optimized
241 * This function did not change the graph, only it's frame type.
242 * The layout state of the frame type will be set to layout_undefined
243 * if entities were removed.
245 void opt_frame_irg(ir_graph *irg);
247 /** Possible flags for the Operator Scalar Replacement. */
248 typedef enum osr_flags {
249 osr_flag_none = 0, /**< no additional flags */
250 osr_flag_lftr_with_ov_check = 1, /**< do linear function test replacement
251 only if no overflow can occur. */
252 osr_flag_ignore_x86_shift = 2 /**< ignore Multiplications by 2, 4, 8 */
255 /* FirmJNI cannot handle identical enum values... */
257 /** default setting */
258 #define osr_flag_default osr_flag_lftr_with_ov_check
261 * Do the Operator Scalar Replacement optimization and linear
262 * function test replacement for loop control.
263 * Can be switched off using the set_opt_strength_red() flag.
264 * In that case, only remove_phi_cycles() is executed.
266 * @param irg the graph which should be optimized
267 * @param flags set of osr_flags
269 * The linear function replacement test is controlled by the flags.
270 * If the osr_flag_lftr_with_ov_check is set, the replacement is only
271 * done if do overflow can occur.
272 * Otherwise it is ALWAYS done which might be insecure.
276 * for (i = 0; i < 100; ++i)
278 * might be replaced by
280 * for (i = 0; i < 400; i += 4)
284 * for (i = 0; i < 0x7FFFFFFF; ++i)
286 * will not be replaced by
288 * for (i = 0; i < 0xFFFFFFFC; i += 4)
290 * because of overflow.
294 * for (i = 0; i <= 0xF; ++i)
296 * will NOT be transformed into
298 * for (i = 0xFFFFFFF0; i <= 0xFFFFFFFF; ++i)
300 * although here is no direct overflow. The OV occurs when the ++i
301 * is executed (and would created an endless loop here!).
303 * For the same reason, a loop
305 * for (i = 0; i <= 9; i += x)
307 * will NOT be transformed because we cannot estimate whether an overflow
308 * might happen adding x.
310 * Note that i < a + 400 is also not possible with the current implementation
311 * although this might be allowed by other compilers...
313 * Note further that tests for equality can be handled some simpler (but are not
316 * This algorithm destroys the link field of nodes.
318 void opt_osr(ir_graph *irg, unsigned flags);
321 * Removes useless Phi cycles, i.e cycles of Phi nodes with only one
323 * This is automatically done in opt_osr(), so there is no need to call it
326 * @param irg the graph which should be optimized
328 * This algorithm destroys the link field of nodes.
330 void remove_phi_cycles(ir_graph *irg);
332 /** A default threshold. */
333 #define DEFAULT_CLONE_THRESHOLD 300
336 * Do procedure cloning. Evaluate a heuristic weight for every
337 * Call(..., Const, ...). If the weight is bigger than threshold,
338 * clone the entity and fix the calls.
340 * @param threshold the threshold for cloning
342 * The threshold is an estimation of how many instructions are saved
343 * when executing a cloned method. If threshold is 0.0, every possible
346 void proc_cloning(float threshold);
351 * Applies Reassociation rules to integer expressions.
352 * Beware: Works only if integer overflow might be ignored, as for C, Java
353 * and for address expression.
354 * Works only if Constant folding is activated.
356 * Uses loop information to detect loop-invariant (ie contant
357 * inside the loop) values.
359 * See Muchnik 12.3.1 Algebraic Simplification and Reassociation of
360 * Addressing Expressions.
364 void optimize_reassociation(ir_graph *irg);
367 * Normalize the Returns of a graph by creating a new End block
368 * with One Return(Phi).
369 * This is the preferred input for the if-conversion.
371 * In pseudocode, it means:
378 * is transformed into
386 void normalize_one_return(ir_graph *irg);
389 * Normalize the Returns of a graph by moving
390 * the Returns upwards as much as possible.
391 * This might be preferred for code generation.
393 * In pseudocode, it means:
401 * is transformed into
408 void normalize_n_returns(ir_graph *irg);
411 * Do the scalar replacement optimization.
412 * Replace local compound entities (like structures and arrays)
413 * with atomic values if possible. Does not handle classes yet.
415 * @param irg the graph which should be optimized
417 void scalar_replacement_opt(ir_graph *irg);
419 /** Performs strength reduction for the passed graph. */
420 void reduce_strength(ir_graph *irg);
423 * Optimizes simple tail-recursion calls by
424 * converting them into loops. Depends on the flag opt_tail_recursion.
426 * Does not work for Calls that use the exception stuff.
428 * @param irg the graph to be optimized
430 * @return non-zero if the optimization could be applied, 0 else
432 int opt_tail_rec_irg(ir_graph *irg);
435 * Optimize tail-recursion calls for all IR-Graphs.
436 * Depends on the flag opt_tail_recursion.
438 void opt_tail_recursion(void);
440 /** This is the type for a method, that returns a pointer type to
441 * tp. This is needed in the normalization. */
442 typedef ir_type *(*gen_pointer_type_to_func)(ir_type *tp);
444 /** Insert Casts so that class type casts conform exactly with the type hierarchy.
446 * Formulated in Java, this achieves the following:
448 * For a class hierarchy
450 * class B extends A {}
451 * class C extends B {}
452 * we transforms a cast
457 * The algorithm works for Casts with class types, but also for Casts
458 * with all pointer types that point (over several indirections,
459 * i.e. ***A) to a class type. Normalizes all graphs. Computes type
460 * information (@see irtypeinfo.h) if not available.
461 * Invalidates trout information as new casts are generated.
463 * @param gppt_fct A function that returns a pointer type that points
464 * to the type given as argument. If this parameter is NULL, a default
465 * function is used that either uses trout information or performs a O(n)
466 * search to find an existing pointer type. If it can not find a type,
467 * generates a pointer type with mode_P_mach and suffix "cc_ptr_tp".
469 void normalize_irp_class_casts(gen_pointer_type_to_func gppt_fct);
472 /** Insert Casts so that class type casts conform exactly with the type hierarchy
475 * For more details see normalize_irp_class_casts().
477 * This transformation requires that type information is computed. @see irtypeinfo.h.
479 void normalize_irg_class_casts(ir_graph *irg, gen_pointer_type_to_func gppt_fct);
482 /** Optimize casting between class types.
485 * class B extends A { }
486 * class C extends B {}
487 * Performs the following transformations:
488 * C c = (C)(B)(A)(B)new C() --> C c = (C)(B)newC() --> C c = new C()
489 * (Optimizing downcasts as A a = (A)(B)(new A()) --> A a = new A() can
490 * be suppressed by setting the flag opt_suppress_downcast_optimization.
491 * Downcasting A to B might cause an exception. It is not clear
492 * whether this is modeled by the Firm Cast node, as it has no exception
494 * If there is inh_m() that overwrites m() in B:
495 * ((A) new B()).m() --> (new B()).inh_m()
496 * Phi((A)x, (A)y) --> (A) Phi (x, y) if (A) is an upcast.
498 * Computes type information if not available. @see irtypeinfo.h.
499 * Typeinformation is valid after optimization.
500 * Invalidates trout information.
502 void optimize_class_casts(void);