2 * Copyright (C) 1995-2008 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.
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 * Creates an ir_graph pass for optimize_cf().
50 * @param name the name of this pass or NULL
52 * @return the newly created ir_graph pass
54 ir_graph_pass_t *optimize_cf_pass(const char *name);
57 * Perform path-sensitive jump threading on the given graph.
59 * @param irg the graph
61 void opt_jumpthreading(ir_graph* irg);
64 * Creates an ir_graph pass for opt_jumpthreading().
66 * @param name the name of this pass or NULL
68 * @return the newly created ir_graph pass
70 ir_graph_pass_t *opt_jumpthreading_pass(const char *name);
73 * Creates an ir_graph pass for opt_loopunroll().
75 * @param name the name of this pass or NULL
77 * @return the newly created ir_graph pass
79 ir_graph_pass_t *opt_loopunroll_pass(const char *name);
83 * Try to simplify boolean expression in the given ir graph.
84 * eg. x < 5 && x < 6 becomes x < 5
86 * @param irg the graph
88 void opt_bool(ir_graph *irg);
91 * Creates an ir_graph pass for opt_bool().
93 * @param name the name of this pass or NULL
95 * @return the newly created ir_graph pass
97 ir_graph_pass_t *opt_bool_pass(const char *name);
100 * Try to reduce the number of conv nodes in the given ir graph.
102 * @param irg the graph
104 * @return non-zero if the optimization could be applied, 0 else
106 int conv_opt(ir_graph *irg);
109 * Creates an ir_graph pass for conv_opt().
111 * @param name the name of this pass or NULL
113 * @return the newly created ir_graph pass
115 ir_graph_pass_t *conv_opt_pass(const char *name);
118 * Do the scalar replacement optimization.
119 * Make a date flow analyze and split the
122 * @param irg the graph which should be optimized
124 void data_flow_scalar_replacement_opt(ir_graph *irg);
127 * A callback that checks whether a entity is an allocation
130 typedef int (*check_alloc_entity_func)(ir_entity *ent);
133 * Do simple and fast escape analysis for one graph.
135 * @param irg the graph
136 * @param callback a callback function to check whether a
137 * given entity is a allocation call
139 void escape_enalysis_irg(ir_graph *irg, check_alloc_entity_func callback);
142 * Do simple and fast escape analysis for all graphs.
144 * This optimization implements a simple and fast but inexact
145 * escape analysis. Some addresses might be marked as 'escaped' even
147 * The advantage is a low memory footprint and fast speed.
149 * @param run_scalar_replace if this flag in non-zero, scalar
150 * replacement optimization is run on graphs with removed
152 * @param callback a callback function to check whether a
153 * given entity is a allocation call
155 * This optimization removes allocation which are not used (rare) and replace
156 * allocation that can be proved dead at the end of the graph which stack variables.
158 * The creation of stack variable allows scalar replacement to be run only
159 * on those graphs that have been changed.
161 * This is most effective on Java where no other stack variables exists.
163 void escape_analysis(int run_scalar_replace, check_alloc_entity_func callback);
166 * Optimize function calls by handling const functions.
168 * This optimization first detects all "const functions", i.e.,
169 * IR graphs that neither read nor write memory (and hence did
170 * not create exceptions, as these use memory in Firm).
172 * The result of calls to such functions depends only on its
173 * arguments, hence those calls are no more pinned.
175 * This is a rather strong criteria, so do not expect that a
176 * lot of functions will be found. Moreover, all of them might
177 * already be inlined if inlining is activated.
178 * Anyway, it might be good for handling builtin's or pseudo-graphs,
179 * even if the later read/write memory (but we know how).
181 * This optimizations read the irg_const_function property of
182 * entities and and sets the irg_const_function property of
185 * If callee information is valid, we also optimize polymorphic Calls.
187 * @param force_run if non-zero, an optimization run is started even
188 * if no const function graph was detected.
189 * Else calls are only optimized if at least one
190 * const function graph was detected.
191 * @param callback a callback function to check whether a
192 * given entity is a allocation call
194 * If the frontend created external entities with the irg_const_function
195 * property set, the force_run parameter should be set, else
198 * @note This optimization destroys the link fields of nodes.
200 void optimize_funccalls(int force_run, check_alloc_entity_func callback);
203 * Creates an ir_prog pass for optimize_funccalls().
205 * @param name the name of this pass or NULL
206 * @param force_run if non-zero, an optimization run is started even
207 * if no const function graph was detected.
208 * Else calls are only optimized if at least one
209 * const function graph was detected.
210 * @param callback a callback function to check whether a
211 * given entity is a allocation call
213 * @return the newly created ir_prog pass
215 ir_prog_pass_t *optimize_funccalls_pass(
217 int force_run, check_alloc_entity_func callback);
220 * Does Partial Redundancy Elimination combined with
221 * Global Value Numbering.
222 * Can be used to replace place_code() completely.
224 * Based on VanDrunen and Hosking 2004.
226 * @param irg the graph
228 void do_gvn_pre(ir_graph *irg);
231 * Creates an ir_graph pass for do_gvn_pre().
233 * @param name the name of this pass or NULL
235 * @return the newly created ir_graph pass
237 ir_graph_pass_t *do_gvn_pre_pass(const char *name);
240 * This function is called to evaluate, if a
241 * mux(@p sel, @p mux_false, @p mux_true) should be built for the current
243 * If it returns non-zero, a mux is created, else the code
245 * @param sel A selector of a Cond.
246 * @param phi_list phi node to be converted
247 * @param i First data predecessor involved in if conversion
248 * @param j Second data predecessor involved in if conversion
250 typedef int (*arch_allow_ifconv_func)(ir_node *sel, ir_node *mux_false,
254 * The parameters structure.
256 struct ir_settings_if_conv_t {
257 int max_depth; /**< The maximum depth up to which expressions
258 are examined when it has to be decided if they
259 can be placed into another block. */
260 arch_allow_ifconv_func allow_ifconv; /**< Evaluator function, if not set all possible Psi
261 nodes will be created. */
265 * Perform If conversion on a graph.
267 * @param irg The graph.
268 * @param params The parameters for the if conversion.
270 * Cannot handle blocks with Bad control predecessors, so call it after control
273 void opt_if_conv(ir_graph *irg, const ir_settings_if_conv_t *params);
276 * Creates an ir_graph pass for opt_if_conv().
278 * @param name the name of this pass or NULL
279 * @param params The parameters for the if conversion.
281 * @return the newly created ir_graph pass
283 ir_graph_pass_t *opt_if_conv_pass(
284 const char *name, const ir_settings_if_conv_t *params);
287 * Tries to reduce dependencies for memory nodes where possible by parllelizing
288 * them and synchronising with Sync nodes
289 * @param irg the graph where memory operations should be parallelised
291 void opt_parallelize_mem(ir_graph *irg);
294 * Creates an ir_graph pass for opt_sync().
296 * @param name the name of this pass or NULL
298 * @return the newly created ir_graph pass
300 ir_graph_pass_t *opt_parallelize_mem_pass(const char *name);
303 * Check if we can replace the load by a given const from
304 * the const code irg.
306 * @param load the load to replace
307 * @param c the constant
309 * @return in the modes match or can be transformed using a reinterpret cast
310 * returns a copy of the constant (possibly Conv'ed) on the
313 ir_node *can_replace_load_by_const(const ir_node *load, ir_node *c);
316 * Load/Store optimization.
318 * Removes redundant non-volatile Loads and Stores.
319 * May introduce Bad nodes if exceptional control flow
320 * is removed. The following cases are optimized:
322 * Load without result: A Load which has only a memory use
325 * Load after Store: A Load after a Store is removed, if
326 * the Load doesn't have an exception handler OR is in
327 * the same block as the Store.
329 * Load after Load: A Load after a Load is removed, if the
330 * Load doesn't have an exception handler OR is in the
331 * same block as the previous Load.
333 * Store before Store: A Store immediately before another
334 * Store in the same block is removed, if the Store doesn't
335 * have an exception handler.
337 * Store after Load: A Store after a Load is removed, if the
338 * Store doesn't have an exception handler.
340 * @return non-zero if the optimization could be applied, 0 else
342 int optimize_load_store(ir_graph *irg);
345 * Creates an ir_graph pass for optimize_load_store().
347 * @param name the name of this pass or NULL
349 * @return the newly created ir_graph pass
351 ir_graph_pass_t *optimize_load_store_pass(const char *name);
354 * New experimental alternative to optimize_load_store.
355 * Based on a dataflow analysis, so load/stores are moved out of loops
358 int opt_ldst(ir_graph *irg);
361 * Creates an ir_graph pass for opt_ldst().
363 * @param name the name of this pass or NULL
365 * @return the newly created ir_graph pass
367 ir_graph_pass_t *opt_ldst_pass(const char *name);
370 * Optimize loops by peeling or unrolling them if beneficial.
372 * @param irg The graph whose loops will be processed
374 * This function did not change the graph, only it's frame type.
375 * The layout state of the frame type will be set to layout_undefined
376 * if entities were removed.
378 void loop_optimization(ir_graph *irg);
381 * Optimize the frame type of an irg by removing
382 * never touched entities.
384 * @param irg The graph whose frame type will be optimized
386 * This function did not change the graph, only it's frame type.
387 * The layout state of the frame type will be set to layout_undefined
388 * if entities were removed.
390 void opt_frame_irg(ir_graph *irg);
393 * Creates an ir_graph pass for opt_frame_irg().
395 * @param name the name of this pass or NULL
397 * @return the newly created ir_graph pass
399 ir_graph_pass_t *opt_frame_irg_pass(const char *name);
401 /** Possible flags for the Operator Scalar Replacement. */
402 typedef enum osr_flags {
403 osr_flag_none = 0, /**< no additional flags */
404 osr_flag_lftr_with_ov_check = 1, /**< do linear function test replacement
405 only if no overflow can occur. */
406 osr_flag_ignore_x86_shift = 2, /**< ignore Multiplications by 2, 4, 8 */
407 osr_flag_keep_reg_pressure = 4 /**< do NOT increase register pressure by introducing new
408 induction variables. */
411 /* FirmJNI cannot handle identical enum values... */
413 /** default setting */
414 #define osr_flag_default osr_flag_lftr_with_ov_check
417 * Do the Operator Scalar Replacement optimization and linear
418 * function test replacement for loop control.
419 * Can be switched off using the set_opt_strength_red() flag.
420 * In that case, only remove_phi_cycles() is executed.
422 * @param irg the graph which should be optimized
423 * @param flags set of osr_flags
425 * The linear function replacement test is controlled by the flags.
426 * If the osr_flag_lftr_with_ov_check is set, the replacement is only
427 * done if do overflow can occur.
428 * Otherwise it is ALWAYS done which might be insecure.
432 * for (i = 0; i < 100; ++i)
434 * might be replaced by
436 * for (i = 0; i < 400; i += 4)
440 * for (i = 0; i < 0x7FFFFFFF; ++i)
442 * will not be replaced by
444 * for (i = 0; i < 0xFFFFFFFC; i += 4)
446 * because of overflow.
450 * for (i = 0; i <= 0xF; ++i)
452 * will NOT be transformed into
454 * for (i = 0xFFFFFFF0; i <= 0xFFFFFFFF; ++i)
456 * although here is no direct overflow. The OV occurs when the ++i
457 * is executed (and would created an endless loop here!).
459 * For the same reason, a loop
461 * for (i = 0; i <= 9; i += x)
463 * will NOT be transformed because we cannot estimate whether an overflow
464 * might happen adding x.
466 * Note that i < a + 400 is also not possible with the current implementation
467 * although this might be allowed by other compilers...
469 * Note further that tests for equality can be handled some simpler (but are not
472 * This algorithm destroys the link field of nodes.
474 void opt_osr(ir_graph *irg, unsigned flags);
477 * Creates an ir_graph pass for remove_phi_cycles().
479 * @param name the name of this pass or NULL
480 * @param flags set of osr_flags
482 * @return the newly created ir_graph pass
484 ir_graph_pass_t *opt_osr_pass(const char *name, unsigned flags);
487 * Removes useless Phi cycles, i.e cycles of Phi nodes with only one
489 * This is automatically done in opt_osr(), so there is no need to call it
492 * @param irg the graph which should be optimized
494 * This algorithm destroys the link field of nodes.
496 void remove_phi_cycles(ir_graph *irg);
499 * Creates an ir_graph pass for remove_phi_cycles().
501 * @param name the name of this pass or NULL
503 * @return the newly created ir_graph pass
505 ir_graph_pass_t *remove_phi_cycles_pass(const char *name);
508 /** A default threshold. */
509 #define DEFAULT_CLONE_THRESHOLD 20
512 * Do procedure cloning. Evaluate a heuristic weight for every
513 * Call(..., Const, ...). If the weight is bigger than threshold,
514 * clone the entity and fix the calls.
516 * @param threshold the threshold for cloning
518 * The threshold is an estimation of how many instructions are saved
519 * when executing a cloned method. If threshold is 0.0, every possible
522 void proc_cloning(float threshold);
525 * Creates an ir_prog pass for proc_cloning().
527 * @param name the name of this pass or NULL
528 * @param threshold the threshold for cloning
530 * @return the newly created ir_prog pass
532 ir_prog_pass_t *proc_cloning_pass(const char *name, float threshold);
537 * Applies Reassociation rules to integer expressions.
538 * Beware: Works only if integer overflow might be ignored, as for C, Java
539 * and for address expression.
540 * Works only if Constant folding is activated.
542 * Uses loop information to detect loop-invariant (ie contant
543 * inside the loop) values.
545 * See Muchnik 12.3.1 Algebraic Simplification and Reassociation of
546 * Addressing Expressions.
548 * @return non-zero if the optimization could be applied, 0 else
550 int optimize_reassociation(ir_graph *irg);
553 * Creates an ir_graph pass for optimize_reassociation().
555 * @param name the name of this pass or NULL
557 * @return the newly created ir_graph pass
559 ir_graph_pass_t *optimize_reassociation_pass(const char *name);
562 * Normalize the Returns of a graph by creating a new End block
563 * with One Return(Phi).
564 * This is the preferred input for the if-conversion.
566 * In pseudocode, it means:
573 * is transformed into
581 void normalize_one_return(ir_graph *irg);
584 * Creates an ir_graph pass for normalize_one_return().
586 * @param name the name of this pass or NULL
588 * @return the newly created ir_graph pass
590 ir_graph_pass_t *normalize_one_return_pass(const char *name);
593 * Normalize the Returns of a graph by moving
594 * the Returns upwards as much as possible.
595 * This might be preferred for code generation.
597 * In pseudocode, it means:
605 * is transformed into
612 void normalize_n_returns(ir_graph *irg);
615 * Creates an ir_graph pass for normalize_n_returns().
617 * @param name the name of this pass or NULL
619 * @return the newly created ir_graph pass
621 ir_graph_pass_t *normalize_n_returns_pass(const char *name);
624 * Do the scalar replacement optimization.
625 * Replace local compound entities (like structures and arrays)
626 * with atomic values if possible. Does not handle classes yet.
628 * @param irg the graph which should be optimized
630 * @return non-zero, if at least one entity was replaced
632 int scalar_replacement_opt(ir_graph *irg);
635 * Creates an ir_graph pass for scalar_replacement_opt().
637 * @param name the name of this pass or NULL
639 * @return the newly created ir_graph pass
641 ir_graph_pass_t *scalar_replacement_opt_pass(const char *name);
643 /** Performs strength reduction for the passed graph. */
644 void reduce_strength(ir_graph *irg);
647 * Optimizes tail-recursion calls by converting them into loops.
648 * Depends on the flag opt_tail_recursion.
649 * Currently supports the following forms:
651 * - return x + func();
652 * - return func() - x;
653 * - return x * func();
656 * Does not work for Calls that use the exception stuff.
658 * @param irg the graph to be optimized
660 * @return non-zero if the optimization could be applied, 0 else
662 int opt_tail_rec_irg(ir_graph *irg);
665 * Creates an ir_graph pass for opt_tail_rec_irg().
667 * @param name the name of this pass or NULL
669 * @return the newly created ir_graph pass
671 ir_graph_pass_t *opt_tail_rec_irg_pass(const char *name);
674 * Optimize tail-recursion calls for all IR-Graphs.
675 * Can currently handle:
676 * - direct return value, i.e. return func().
677 * - additive return value, i.e. return x +/- func()
678 * - multiplicative return value, i.e. return x * func() or return -func()
680 * The current implementation must be run before optimize_funccalls(),
681 * because it expects the memory edges pointing to calls, which might be
682 * removed by optimize_funccalls().
684 void opt_tail_recursion(void);
687 * Creates an ir_prog pass for opt_tail_recursion().
689 * @param name the name of this pass or NULL
691 * @return the newly created ir_prog pass
693 ir_prog_pass_t *opt_tail_recursion_pass(const char *name);
695 /** This is the type for a method, that returns a pointer type to
696 * tp. This is needed in the normalization. */
697 typedef ir_type *(*gen_pointer_type_to_func)(ir_type *tp);
699 /** Insert Casts so that class type casts conform exactly with the type hierarchy.
701 * Formulated in Java, this achieves the following:
703 * For a class hierarchy
705 * class B extends A {}
706 * class C extends B {}
707 * we transforms a cast
712 * The algorithm works for Casts with class types, but also for Casts
713 * with all pointer types that point (over several indirections,
714 * i.e. ***A) to a class type. Normalizes all graphs. Computes type
715 * information (@see irtypeinfo.h) if not available.
716 * Invalidates trout information as new casts are generated.
718 * @param gppt_fct A function that returns a pointer type that points
719 * to the type given as argument. If this parameter is NULL, a default
720 * function is used that either uses trout information or performs a O(n)
721 * search to find an existing pointer type. If it can not find a type,
722 * generates a pointer type with mode_P_mach and suffix "cc_ptr_tp".
724 void normalize_irp_class_casts(gen_pointer_type_to_func gppt_fct);
726 /** Insert Casts so that class type casts conform exactly with the type hierarchy
729 * For more details see normalize_irp_class_casts().
731 * This transformation requires that type information is computed. @see irtypeinfo.h.
733 void normalize_irg_class_casts(ir_graph *irg, gen_pointer_type_to_func gppt_fct);
735 /** Optimize casting between class types.
738 * class B extends A { }
739 * class C extends B {}
740 * Performs the following transformations:
741 * C c = (C)(B)(A)(B)new C() --> C c = (C)(B)newC() --> C c = new C()
742 * (Optimizing downcasts as A a = (A)(B)(new A()) --> A a = new A() can
743 * be suppressed by setting the flag opt_suppress_downcast_optimization.
744 * Downcasting A to B might cause an exception. It is not clear
745 * whether this is modeled by the Firm Cast node, as it has no exception
747 * If there is inh_m() that overwrites m() in B:
748 * ((A) new B()).m() --> (new B()).inh_m()
749 * Phi((A)x, (A)y) --> (A) Phi (x, y) if (A) is an upcast.
751 * Computes type information if not available. @see irtypeinfo.h.
752 * Typeinformation is valid after optimization.
753 * Invalidates trout information.
755 void optimize_class_casts(void);
758 * CLiff Click's combo algorithm from
759 * "Combining Analyses, combining Optimizations".
761 * Does conditional constant propagation, unreachable code elimination and
762 * optimistic global value numbering at once.
764 * @param irg the graph to run on
766 void combo(ir_graph *irg);
769 * Creates an ir_graph pass for combo.
771 * @param name the name of this pass or NULL
773 * @return the newly created ir_graph pass
775 ir_graph_pass_t *combo_pass(const char *name);
778 * Inlines all small methods at call sites where the called address comes
779 * from a SymConst node that references the entity representing the called
782 * @param irg the graph
783 * @param size maximum function size
785 * The size argument is a rough measure for the code size of the method:
786 * Methods where the obstack containing the firm graph is smaller than
787 * size are inlined. Further only a limited number of calls are inlined.
788 * If the method contains more than 1024 inlineable calls none will be
790 * Inlining is only performed if flags `optimize' and `inlineing' are set.
791 * The graph may not be in state phase_building.
792 * It is recommended to call local_optimize_graph() after inlining as this
793 * function leaves a set of obscure Tuple nodes, e.g. a Proj-Tuple-Jmp
794 * combination as control flow operation.
796 void inline_small_irgs(ir_graph *irg, int size);
799 * Creates an ir_graph pass for inline_small_irgs().
801 * @param name the name of this pass or NULL
802 * @param size maximum function size
804 * @return the newly created ir_graph pass
806 ir_graph_pass_t *inline_small_irgs_pass(const char *name, int size);
809 * Inlineing with a different heuristic than inline_small_irgs().
811 * Inlines leave functions. If inlinening creates new leave
812 * function inlines these, too. (If g calls f, and f calls leave h,
813 * h is first inlined in f and then f in g.)
815 * Then inlines all small functions (this is not recursive).
817 * For a heuristic this inlineing uses firm node counts. It does
818 * not count auxiliary nodes as Proj, Tuple, End, Start, Id, Sync.
819 * If the ignore_runtime flag is set, calls to functions marked with the
820 * mtp_property_runtime property are ignored.
822 * @param maxsize Do not inline any calls if a method has more than
823 * maxsize firm nodes. It may reach this limit by
825 * @param leavesize Inline leave functions if they have less than leavesize
827 * @param size Inline all function smaller than size.
828 * @param ignore_runtime count a function only calling runtime functions as
831 void inline_leave_functions(unsigned maxsize, unsigned leavesize,
832 unsigned size, int ignore_runtime);
835 * Creates an ir_prog pass for inline_leave_functions().
837 * @param name the name of this pass or NULL
838 * @param maxsize Do not inline any calls if a method has more than
839 * maxsize firm nodes. It may reach this limit by
841 * @param leavesize Inline leave functions if they have less than leavesize
843 * @param size Inline all function smaller than size.
844 * @param ignore_runtime count a function only calling runtime functions as
847 * @return the newly created ir_prog pass
849 ir_prog_pass_t *inline_leave_functions_pass(
850 const char *name, unsigned maxsize, unsigned leavesize,
851 unsigned size, int ignore_runtime);
853 typedef void (*opt_ptr)(ir_graph *irg);
856 * Heuristic inliner. Calculates a benefice value for every call and inlines
857 * those calls with a value higher than the threshold.
859 * @param maxsize Do not inline any calls if a method has more than
860 * maxsize firm nodes. It may reach this limit by
862 * @param inline_threshold inlining threshold
863 * @param after_inline_opt optimizations performed immediately after inlining
866 void inline_functions(unsigned maxsize, int inline_threshold,
867 opt_ptr after_inline_opt);
870 * Creates an ir_prog pass for inline_functions().
872 * @param name the name of this pass or NULL
873 * @param maxsize Do not inline any calls if a method has more than
874 * maxsize firm nodes. It may reach this limit by
876 * @param inline_threshold inlining threshold
877 * @param after_inline_opt a function that is called after inlining a
878 * procedure. You should run fast local optimisations
879 * here which cleanup the graph before further
882 * @return the newly created ir_prog pass
884 ir_prog_pass_t *inline_functions_pass(
885 const char *name, unsigned maxsize, int inline_threshold,
886 opt_ptr after_inline_opt);
889 * Combines congruent blocks into one.
891 * @param irg The IR-graph to optimize.
893 * @return non-zero if the graph was transformed
895 int shape_blocks(ir_graph *irg);
898 * Creates an ir_graph pass for shape_blocks().
900 * @param name the name of this pass or NULL
902 * @return the newly created ir_graph pass
904 ir_graph_pass_t *shape_blocks_pass(const char *name);
907 * Perform loop inversion on a given graph.
908 * Loop inversion transforms a head controlled loop (like while(...) {} and
909 * for(...) {}) into a foot controlled loop (do {} while(...)).
911 void do_loop_inversion(ir_graph *irg);
914 * Perform loop unrolling on a given graph.
915 * Loop unrolling multiplies the number loop completely by a number found
916 * through a heuristic.
918 void do_loop_unrolling(ir_graph *irg);
921 * Perform loop peeling on a given graph.
923 void do_loop_peeling(ir_graph *irg);
926 * Creates an ir_graph pass for loop inversion.
928 * @param name the name of this pass or NULL
930 * @return the newly created ir_graph pass
932 ir_graph_pass_t *loop_inversion_pass(const char *name);
935 * Creates an ir_graph pass for loop unrolling.
937 * @param name the name of this pass or NULL
939 * @return the newly created ir_graph pass
941 ir_graph_pass_t *loop_unroll_pass(const char *name);
944 * Creates an ir_graph pass for loop peeling.
946 * @param name the name of this pass or NULL
948 * @return the newly created ir_graph pass
950 ir_graph_pass_t *loop_peeling_pass(const char *name);
952 typedef ir_type *(*get_Alloc_func)(ir_node *n);
953 /** Set a new get_Alloc_func and returns the old one. */
954 get_Alloc_func firm_set_Alloc_func(get_Alloc_func newf);
957 * sets value ranges through value range propagation
958 * @param irg The IR-graph on which to work
961 void set_vrp_data(ir_graph *irg);
964 * Creates an ir_graph pass for set_vrp_data()
966 * @param name The name of this pass or NULL
968 * @return the newly created ir_graph pass
970 ir_graph_pass_t *set_vrp_pass(const char *name);
973 * Removes all entities which are unused.
975 * Unused entities have ir_visibility_local and are not used directly or
976 * indirectly through entities/code visible outside the compilation unit.
977 * This is usually conservative than gc_irgs, but does not respect properties
978 * of object-oriented programs.
980 void garbage_collect_entities(void);
982 /** Pass for garbage_collect_entities */
983 ir_prog_pass_t *garbage_collect_entities_pass(const char *name);
985 /** Performs dead node elimination by copying the ir graph to a new obstack.
987 * The major intention of this pass is to free memory occupied by
988 * dead nodes and outdated analyzes information. Further this
989 * function removes Bad predecessors from Blocks and the corresponding
990 * inputs to Phi nodes. This opens optimization potential for other
991 * optimizations. Further this phase reduces dead Block<->Jmp
992 * self-cycles to Bad nodes.
994 * Dead_node_elimination is only performed if options `optimize' and
995 * `opt_dead_node_elimination' are set. The graph may
996 * not be in state phase_building. The outs datasturcture is freed,
997 * the outs state set to outs_none. Backedge information is conserved.
998 * Removes old attributes of nodes. Sets link field to NULL.
999 * Callee information must be freed (irg_callee_info_none).
1001 * @param irg The graph to be optimized.
1003 void dead_node_elimination(ir_graph *irg);
1006 * Creates an ir_graph pass for dead_node_elimination().
1008 * @param name the name of this pass or NULL
1010 * @return the newly created ir_graph pass
1012 ir_graph_pass_t *dead_node_elimination_pass(const char *name);
1014 /** Inlines a method at the given call site.
1016 * Removes the call node and splits the basic block the call node
1017 * belongs to. Inserts a copy of the called graph between these nodes.
1018 * Assumes that call is a Call node in current_ir_graph and that
1019 * the type in the Call nodes type attribute is the same as the
1020 * type of the called graph.
1021 * Further it assumes that all Phi nodes in a block of current_ir_graph
1022 * are assembled in a "link" list in the link field of the corresponding
1023 * block nodes. Further assumes that all Proj nodes are in a "link" list
1024 * in the nodes producing the tuple. (This is only an optical feature
1025 * for the graph.) Conserves this feature for the old
1026 * nodes of the graph. This precondition can be established by a call to
1027 * collect_phisprojs(), see irgmod.h.
1028 * As dead_node_elimination this function reduces dead Block<->Jmp
1029 * self-cycles to Bad nodes.
1031 * Called_graph must be unequal to current_ir_graph. Will not inline
1032 * if they are equal.
1033 * Sets visited masterflag in current_ir_graph to the max of the flag in
1034 * current and called graph.
1035 * Assumes that both, the called and the calling graph are in state
1036 * "op_pin_state_pinned".
1037 * It is recommended to call local_optimize_graph() after inlining as this
1038 * function leaves a set of obscure Tuple nodes, e.g. a Proj-Tuple-Jmp
1039 * combination as control flow operation.
1041 * @param call the call node that should be inlined
1042 * @param called_graph the IR-graph that is called at call
1044 * @return zero if method could not be inlined (recursion for instance),
1045 * non-zero if all went ok
1047 int inline_method(ir_node *call, ir_graph *called_graph);
1051 * Pins all floating nodes to a block where they
1052 * will be executed only if needed. Depends on the flag opt_global_cse.
1053 * Graph may not be in phase_building. Does not schedule control dead
1054 * code. Uses dominator information which it computes if the irg is not
1055 * in state dom_consistent. Destroys the out information as it moves nodes
1056 * to other blocks. Optimizes Tuples in Control edges.
1057 * @todo This is not tested!
1059 * Call remove_critical_cf_edges() before place_code(). This normalizes
1060 * the control flow graph so that for all operations a basic block exists
1061 * where they can be optimally placed.
1063 * @todo A more powerful code placement would move operations past Phi nodes
1066 void place_code(ir_graph *irg);
1069 * Creates an ir_graph pass for place_code().
1070 * This pass enables GCSE, runs optimize_graph_df() and finally
1073 * @param name the name of this pass or NULL
1075 * @return the newly created ir_graph pass
1077 ir_graph_pass_t *place_code_pass(const char *name);
1080 * Determine information about the values of nodes and perform simplications
1081 * using this information. This optimization performs a data-flow analysis to
1082 * find the minimal fixpoint.
1084 void fixpoint_vrp(ir_graph*);
1087 * Creates an ir_graph pass for fixpoint_vrp().
1088 * This pass dDetermines information about the values of nodes
1089 * and perform simplications using this information.
1090 * This optimization performs a data-flow analysis to
1091 * find the minimal fixpoint.
1093 * @param name the name of this pass or NULL
1095 * @return the newly created ir_graph pass
1097 ir_graph_pass_t *fixpoint_vrp_irg_pass(const char *name);