2 * Copyright (C) 1995-2010 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"
33 * Control flow optimization.
35 * Removes empty blocks doing if simplifications and loop simplifications.
36 * A block is empty if it contains only a Jmp node and Phi nodes.
37 * Merges single entry single exit blocks with their predecessor
38 * and propagates dead control flow by calling equivalent_node().
39 * Independent of compiler flag it removes Tuples from cf edges,
40 * Bad predecessors from Blocks and Phis, and unnecessary predecessors of End.
41 * Destroys backedge information.
43 * @bug Chokes on Id nodes if called in a certain order with other
44 * optimizations. Call local_optimize_graph() before to remove
47 FIRM_API void optimize_cf(ir_graph *irg);
50 * Creates an ir_graph pass for optimize_cf().
52 * @param name the name of this pass or NULL
54 * @return the newly created ir_graph pass
56 FIRM_API ir_graph_pass_t *optimize_cf_pass(const char *name);
59 * Perform path-sensitive jump threading on the given graph.
61 * @param irg the graph
63 FIRM_API void opt_jumpthreading(ir_graph* irg);
66 * Creates an ir_graph pass for opt_jumpthreading().
68 * @param name the name of this pass or NULL
70 * @return the newly created ir_graph pass
72 FIRM_API ir_graph_pass_t *opt_jumpthreading_pass(const char *name);
75 * Try to simplify boolean expression in the given ir graph.
76 * eg. x < 5 && x < 6 becomes x < 5
78 * @param irg the graph
80 FIRM_API void opt_bool(ir_graph *irg);
83 * Creates an ir_graph pass for opt_bool().
85 * @param name the name of this pass or NULL
87 * @return the newly created ir_graph pass
89 FIRM_API ir_graph_pass_t *opt_bool_pass(const char *name);
92 * Try to reduce the number of conv nodes in the given ir graph.
94 * @param irg the graph
96 * @return non-zero if the optimization could be applied, 0 else
98 FIRM_API int conv_opt(ir_graph *irg);
101 * Creates an ir_graph pass for conv_opt().
103 * @param name the name of this pass or NULL
105 * @return the newly created ir_graph pass
107 FIRM_API ir_graph_pass_t *conv_opt_pass(const char *name);
110 * A callback that checks whether a entity is an allocation
113 typedef int (*check_alloc_entity_func)(ir_entity *ent);
116 * Do simple and fast escape analysis for one graph.
118 * @param irg the graph
119 * @param callback a callback function to check whether a
120 * given entity is a allocation call
122 FIRM_API void escape_enalysis_irg(ir_graph *irg,
123 check_alloc_entity_func callback);
126 * Do simple and fast escape analysis for all graphs.
128 * This optimization implements a simple and fast but inexact
129 * escape analysis. Some addresses might be marked as 'escaped' even
131 * The advantage is a low memory footprint and fast speed.
133 * @param run_scalar_replace if this flag in non-zero, scalar
134 * replacement optimization is run on graphs with removed
136 * @param callback a callback function to check whether a
137 * given entity is a allocation call
139 * This optimization removes allocation which are not used (rare) and replace
140 * allocation that can be proved dead at the end of the graph which stack variables.
142 * The creation of stack variable allows scalar replacement to be run only
143 * on those graphs that have been changed.
145 * This is most effective on Java where no other stack variables exists.
147 FIRM_API void escape_analysis(int run_scalar_replace,
148 check_alloc_entity_func callback);
151 * Optimize function calls by handling const functions.
153 * This optimization first detects all "const functions", i.e.,
154 * IR graphs that neither read nor write memory (and hence did
155 * not create exceptions, as these use memory in Firm).
157 * The result of calls to such functions depends only on its
158 * arguments, hence those calls are no more pinned.
160 * This is a rather strong criteria, so do not expect that a
161 * lot of functions will be found. Moreover, all of them might
162 * already be inlined if inlining is activated.
163 * Anyway, it might be good for handling builtin's
164 * even if the later read/write memory (but we know how).
166 * This optimizations read the irg_const_function property of
167 * entities and and sets the irg_const_function property of
170 * If callee information is valid, we also optimize polymorphic Calls.
172 FIRM_API void optimize_funccalls(void);
175 * Creates an ir_prog pass for optimize_funccalls().
177 * @param name the name of this pass or NULL
178 * @param force_run if non-zero, an optimization run is started even
179 * if no const function graph was detected.
180 * Else calls are only optimized if at least one
181 * const function graph was detected.
182 * @param callback a callback function to check whether a
183 * given entity is a allocation call
185 * @return the newly created ir_prog pass
187 FIRM_API ir_prog_pass_t *optimize_funccalls_pass(const char *name);
190 * Does Partial Redundancy Elimination combined with
191 * Global Value Numbering.
192 * Can be used to replace place_code() completely.
194 * Based on VanDrunen and Hosking 2004.
196 * @param irg the graph
198 FIRM_API void do_gvn_pre(ir_graph *irg);
201 * Creates an ir_graph pass for do_gvn_pre().
203 * @param name the name of this pass or NULL
205 * @return the newly created ir_graph pass
207 FIRM_API ir_graph_pass_t *do_gvn_pre_pass(const char *name);
210 * This function is called to evaluate, if a
211 * mux(@p sel, @p mux_false, @p mux_true) should be built for the current
213 * If it returns non-zero, a mux is created, else the code
215 * @param sel A selector of a Cond.
216 * @param phi_list phi node to be converted
217 * @param i First data predecessor involved in if conversion
218 * @param j Second data predecessor involved in if conversion
220 typedef int (*arch_allow_ifconv_func)(ir_node *sel, ir_node *mux_false,
224 * Perform If conversion on a graph.
226 * @param irg The graph.
228 * Cannot handle blocks with Bad control predecessors, so call it after control
231 FIRM_API void opt_if_conv(ir_graph *irg);
234 * Creates an ir_graph pass for opt_if_conv().
236 * @param name the name of this pass or NULL
238 * @return the newly created ir_graph pass
240 FIRM_API ir_graph_pass_t *opt_if_conv_pass(const char *name);
243 * Tries to reduce dependencies for memory nodes where possible by parallelizing
244 * them and synchronizing with Sync nodes
245 * @param irg the graph where memory operations should be parallelized
247 FIRM_API void opt_parallelize_mem(ir_graph *irg);
250 * Creates an ir_graph pass for opt_sync().
252 * @param name the name of this pass or NULL
254 * @return the newly created ir_graph pass
256 FIRM_API ir_graph_pass_t *opt_parallelize_mem_pass(const char *name);
259 * Check if we can replace the load by a given const from
260 * the const code irg.
262 * @param load the load to replace
263 * @param c the constant
265 * @return in the modes match or can be transformed using a reinterpret cast
266 * returns a copy of the constant (possibly Conv'ed) on the
269 FIRM_API ir_node *can_replace_load_by_const(const ir_node *load, ir_node *c);
272 * Load/Store optimization.
274 * Removes redundant non-volatile Loads and Stores.
275 * May introduce Bad nodes if exceptional control flow
276 * is removed. The following cases are optimized:
278 * Load without result: A Load which has only a memory use
281 * Load after Store: A Load after a Store is removed, if
282 * the Load doesn't have an exception handler OR is in
283 * the same block as the Store.
285 * Load after Load: A Load after a Load is removed, if the
286 * Load doesn't have an exception handler OR is in the
287 * same block as the previous Load.
289 * Store before Store: A Store immediately before another
290 * Store in the same block is removed, if the Store doesn't
291 * have an exception handler.
293 * Store after Load: A Store after a Load is removed, if the
294 * Store doesn't have an exception handler.
296 * @return non-zero if the optimization could be applied, 0 else
298 FIRM_API int optimize_load_store(ir_graph *irg);
301 * Creates an ir_graph pass for optimize_load_store().
303 * @param name the name of this pass or NULL
305 * @return the newly created ir_graph pass
307 FIRM_API ir_graph_pass_t *optimize_load_store_pass(const char *name);
310 * New experimental alternative to optimize_load_store.
311 * Based on a dataflow analysis, so load/stores are moved out of loops
314 FIRM_API int opt_ldst(ir_graph *irg);
317 * Creates an ir_graph pass for opt_ldst().
319 * @param name the name of this pass or NULL
321 * @return the newly created ir_graph pass
323 FIRM_API ir_graph_pass_t *opt_ldst_pass(const char *name);
326 * Optimize loops by peeling or unrolling them if beneficial.
328 * @param irg The graph whose loops will be processed
330 * This function did not change the graph, only its frame type.
331 * The layout state of the frame type will be set to layout_undefined
332 * if entities were removed.
334 FIRM_API void loop_optimization(ir_graph *irg);
337 * Optimize the frame type of an irg by removing
338 * never touched entities.
340 * @param irg The graph whose frame type will be optimized
342 * This function did not change the graph, only its frame type.
343 * The layout state of the frame type will be set to layout_undefined
344 * if entities were removed.
346 FIRM_API void opt_frame_irg(ir_graph *irg);
349 * Creates an ir_graph pass for opt_frame_irg().
351 * @param name the name of this pass or NULL
353 * @return the newly created ir_graph pass
355 FIRM_API ir_graph_pass_t *opt_frame_irg_pass(const char *name);
357 /** Possible flags for the Operator Scalar Replacement. */
358 typedef enum osr_flags {
359 osr_flag_none = 0, /**< no additional flags */
360 osr_flag_lftr_with_ov_check = 1, /**< do linear function test replacement
361 only if no overflow can occur. */
362 osr_flag_ignore_x86_shift = 2, /**< ignore Multiplications by 2, 4, 8 */
363 osr_flag_keep_reg_pressure = 4 /**< do NOT increase register pressure by introducing new
364 induction variables. */
367 /* FirmJNI cannot handle identical enum values... */
369 /** default setting */
370 #define osr_flag_default osr_flag_lftr_with_ov_check
373 * Do the Operator Scalar Replacement optimization and linear
374 * function test replacement for loop control.
375 * Can be switched off using the set_opt_strength_red() flag.
376 * In that case, only remove_phi_cycles() is executed.
378 * @param irg the graph which should be optimized
379 * @param flags set of osr_flags
381 * The linear function replacement test is controlled by the flags.
382 * If the osr_flag_lftr_with_ov_check is set, the replacement is only
383 * done if do overflow can occur.
384 * Otherwise it is ALWAYS done which might be insecure.
388 * for (i = 0; i < 100; ++i)
390 * might be replaced by
392 * for (i = 0; i < 400; i += 4)
396 * for (i = 0; i < 0x7FFFFFFF; ++i)
398 * will not be replaced by
400 * for (i = 0; i < 0xFFFFFFFC; i += 4)
402 * because of overflow.
406 * for (i = 0; i <= 0xF; ++i)
408 * will NOT be transformed into
410 * for (i = 0xFFFFFFF0; i <= 0xFFFFFFFF; ++i)
412 * although here is no direct overflow. The OV occurs when the ++i
413 * is executed (and would created an endless loop here!).
415 * For the same reason, a loop
417 * for (i = 0; i <= 9; i += x)
419 * will NOT be transformed because we cannot estimate whether an overflow
420 * might happen adding x.
422 * Note that i < a + 400 is also not possible with the current implementation
423 * although this might be allowed by other compilers...
425 * Note further that tests for equality can be handled some simpler (but are not
428 * This algorithm destroys the link field of nodes.
430 FIRM_API void opt_osr(ir_graph *irg, unsigned flags);
433 * Creates an ir_graph pass for remove_phi_cycles().
435 * @param name the name of this pass or NULL
436 * @param flags set of osr_flags
438 * @return the newly created ir_graph pass
440 FIRM_API ir_graph_pass_t *opt_osr_pass(const char *name, unsigned flags);
443 * Removes useless Phi cycles, i.e cycles of Phi nodes with only one
445 * This is automatically done in opt_osr(), so there is no need to call it
448 * @param irg the graph which should be optimized
450 * This algorithm destroys the link field of nodes.
452 FIRM_API void remove_phi_cycles(ir_graph *irg);
455 * Creates an ir_graph pass for remove_phi_cycles().
457 * @param name the name of this pass or NULL
459 * @return the newly created ir_graph pass
461 FIRM_API ir_graph_pass_t *remove_phi_cycles_pass(const char *name);
464 /** A default threshold. */
465 #define DEFAULT_CLONE_THRESHOLD 20
468 * Do procedure cloning. Evaluate a heuristic weight for every
469 * Call(..., Const, ...). If the weight is bigger than threshold,
470 * clone the entity and fix the calls.
472 * @param threshold the threshold for cloning
474 * The threshold is an estimation of how many instructions are saved
475 * when executing a cloned method. If threshold is 0.0, every possible
478 FIRM_API void proc_cloning(float threshold);
481 * Creates an ir_prog pass for proc_cloning().
483 * @param name the name of this pass or NULL
484 * @param threshold the threshold for cloning
486 * @return the newly created ir_prog pass
488 FIRM_API ir_prog_pass_t *proc_cloning_pass(const char *name, float threshold);
493 * Applies Reassociation rules to integer expressions.
494 * Beware: Works only if integer overflow might be ignored, as for C, Java
495 * and for address expression.
496 * Works only if Constant folding is activated.
498 * Uses loop information to detect loop-invariant (i.e. contant
499 * inside the loop) values.
501 * See Muchnik 12.3.1 Algebraic Simplification and Reassociation of
502 * Addressing Expressions.
504 * @return non-zero if the optimization could be applied, 0 else
506 FIRM_API int optimize_reassociation(ir_graph *irg);
509 * Creates an ir_graph pass for optimize_reassociation().
511 * @param name the name of this pass or NULL
513 * @return the newly created ir_graph pass
515 FIRM_API ir_graph_pass_t *optimize_reassociation_pass(const char *name);
518 * Normalize the Returns of a graph by creating a new End block
519 * with One Return(Phi).
520 * This is the preferred input for the if-conversion.
522 * In pseudocode, it means:
529 * is transformed into
537 FIRM_API void normalize_one_return(ir_graph *irg);
540 * Creates an ir_graph pass for normalize_one_return().
542 * @param name the name of this pass or NULL
544 * @return the newly created ir_graph pass
546 FIRM_API ir_graph_pass_t *normalize_one_return_pass(const char *name);
549 * Normalize the Returns of a graph by moving
550 * the Returns upwards as much as possible.
551 * This might be preferred for code generation.
553 * In pseudocode, it means:
561 * is transformed into
568 FIRM_API void normalize_n_returns(ir_graph *irg);
571 * Creates an ir_graph pass for normalize_n_returns().
573 * @param name the name of this pass or NULL
575 * @return the newly created ir_graph pass
577 FIRM_API ir_graph_pass_t *normalize_n_returns_pass(const char *name);
580 * Do the scalar replacement optimization.
581 * Replace local compound entities (like structures and arrays)
582 * with atomic values if possible. Does not handle classes yet.
584 * @param irg the graph which should be optimized
586 * @return non-zero, if at least one entity was replaced
588 FIRM_API int scalar_replacement_opt(ir_graph *irg);
591 * Creates an ir_graph pass for scalar_replacement_opt().
593 * @param name the name of this pass or NULL
595 * @return the newly created ir_graph pass
597 FIRM_API ir_graph_pass_t *scalar_replacement_opt_pass(const char *name);
600 * Optimizes tail-recursion calls by converting them into loops.
601 * Depends on the flag opt_tail_recursion.
602 * Currently supports the following forms:
604 * - return x + func();
605 * - return func() - x;
606 * - return x * func();
609 * Does not work for Calls that use the exception stuff.
611 * @param irg the graph to be optimized
613 * @return non-zero if the optimization could be applied, 0 else
615 FIRM_API int opt_tail_rec_irg(ir_graph *irg);
618 * Creates an ir_graph pass for opt_tail_rec_irg().
620 * @param name the name of this pass or NULL
622 * @return the newly created ir_graph pass
624 FIRM_API ir_graph_pass_t *opt_tail_rec_irg_pass(const char *name);
627 * Optimize tail-recursion calls for all IR-Graphs.
628 * Can currently handle:
629 * - direct return value, i.e. return func().
630 * - additive return value, i.e. return x +/- func()
631 * - multiplicative return value, i.e. return x * func() or return -func()
633 * The current implementation must be run before optimize_funccalls(),
634 * because it expects the memory edges pointing to calls, which might be
635 * removed by optimize_funccalls().
637 FIRM_API void opt_tail_recursion(void);
640 * Creates an ir_prog pass for opt_tail_recursion().
642 * @param name the name of this pass or NULL
644 * @return the newly created ir_prog pass
646 FIRM_API ir_prog_pass_t *opt_tail_recursion_pass(const char *name);
648 /** This is the type for a method, that returns a pointer type to
649 * tp. This is needed in the normalization. */
650 typedef ir_type *(*gen_pointer_type_to_func)(ir_type *tp);
652 /** Insert Casts so that class type casts conform exactly with the type hierarchy.
654 * Formulated in Java, this achieves the following:
656 * For a class hierarchy
658 * class B extends A {}
659 * class C extends B {}
660 * we transforms a cast
665 * The algorithm works for Casts with class types, but also for Casts
666 * with all pointer types that point (over several indirections,
667 * i.e. ***A) to a class type. Normalizes all graphs. Computes type
668 * information (@see irtypeinfo.h) if not available.
669 * Invalidates trout information as new casts are generated.
671 * @param gppt_fct A function that returns a pointer type that points
672 * to the type given as argument. If this parameter is NULL, a default
673 * function is used that either uses trout information or performs a O(n)
674 * search to find an existing pointer type. If it can not find a type,
675 * generates a pointer type with mode_P_mach and suffix "cc_ptr_tp".
677 FIRM_API void normalize_irp_class_casts(gen_pointer_type_to_func gppt_fct);
679 /** Insert Casts so that class type casts conform exactly with the type hierarchy
682 * For more details see normalize_irp_class_casts().
684 * This transformation requires that type information is computed. @see irtypeinfo.h.
686 FIRM_API void normalize_irg_class_casts(ir_graph *irg,
687 gen_pointer_type_to_func gppt_fct);
689 /** Optimize casting between class types.
692 * class B extends A { }
693 * class C extends B {}
694 * Performs the following transformations:
695 * C c = (C)(B)(A)(B)new C() --> C c = (C)(B)newC() --> C c = new C()
696 * (Optimizing downcasts as A a = (A)(B)(new A()) --> A a = new A() can
697 * be suppressed by setting the flag opt_suppress_downcast_optimization.
698 * Downcasting A to B might cause an exception. It is not clear
699 * whether this is modeled by the Firm Cast node, as it has no exception
701 * If there is inh_m() that overwrites m() in B:
702 * ((A) new B()).m() --> (new B()).inh_m()
703 * Phi((A)x, (A)y) --> (A) Phi (x, y) if (A) is an upcast.
705 * Computes type information if not available. @see irtypeinfo.h.
706 * Typeinformation is valid after optimization.
707 * Invalidates trout information.
709 FIRM_API void optimize_class_casts(void);
712 * CLiff Click's combo algorithm from
713 * "Combining Analyses, combining Optimizations".
715 * Does conditional constant propagation, unreachable code elimination and
716 * optimistic global value numbering at once.
718 * @param irg the graph to run on
720 FIRM_API void combo(ir_graph *irg);
723 * Creates an ir_graph pass for combo.
725 * @param name the name of this pass or NULL
727 * @return the newly created ir_graph pass
729 FIRM_API ir_graph_pass_t *combo_pass(const char *name);
732 * Inlines all small methods at call sites where the called address comes
733 * from a SymConst node that references the entity representing the called
736 * @param irg the graph
737 * @param size maximum function size
739 * The size argument is a rough measure for the code size of the method:
740 * Methods where the obstack containing the firm graph is smaller than
741 * size are inlined. Further only a limited number of calls are inlined.
742 * If the method contains more than 1024 inlineable calls none will be
744 * Inlining is only performed if flags `optimize' and `inlining' are set.
745 * The graph may not be in state phase_building.
746 * It is recommended to call local_optimize_graph() after inlining as this
747 * function leaves a set of obscure Tuple nodes, e.g. a Proj-Tuple-Jmp
748 * combination as control flow operation.
750 FIRM_API void inline_small_irgs(ir_graph *irg, int size);
753 * Creates an ir_graph pass for inline_small_irgs().
755 * @param name the name of this pass or NULL
756 * @param size maximum function size
758 * @return the newly created ir_graph pass
760 FIRM_API ir_graph_pass_t *inline_small_irgs_pass(const char *name, int size);
763 * Inlineing with a different heuristic than inline_small_irgs().
765 * Inlines leave functions. If inlining creates new leave
766 * function inlines these, too. (If g calls f, and f calls leave h,
767 * h is first inlined in f and then f in g.)
769 * Then inlines all small functions (this is not recursive).
771 * For a heuristic this inlining uses firm node counts. It does
772 * not count auxiliary nodes as Proj, Tuple, End, Start, Id, Sync.
773 * If the ignore_runtime flag is set, calls to functions marked with the
774 * mtp_property_runtime property are ignored.
776 * @param maxsize Do not inline any calls if a method has more than
777 * maxsize firm nodes. It may reach this limit by
779 * @param leavesize Inline leave functions if they have less than leavesize
781 * @param size Inline all function smaller than size.
782 * @param ignore_runtime count a function only calling runtime functions as
785 FIRM_API void inline_leave_functions(unsigned maxsize, unsigned leavesize,
786 unsigned size, int ignore_runtime);
789 * Creates an ir_prog pass for inline_leave_functions().
791 * @param name the name of this pass or NULL
792 * @param maxsize Do not inline any calls if a method has more than
793 * maxsize firm nodes. It may reach this limit by
795 * @param leavesize Inline leave functions if they have less than leavesize
797 * @param size Inline all function smaller than size.
798 * @param ignore_runtime count a function only calling runtime functions as
801 * @return the newly created ir_prog pass
803 FIRM_API ir_prog_pass_t *inline_leave_functions_pass(const char *name,
804 unsigned maxsize, unsigned leavesize, unsigned size,
807 typedef void (*opt_ptr)(ir_graph *irg);
810 * Heuristic inliner. Calculates a benefice value for every call and inlines
811 * those calls with a value higher than the threshold.
813 * @param maxsize Do not inline any calls if a method has more than
814 * maxsize firm nodes. It may reach this limit by
816 * @param inline_threshold inlining threshold
817 * @param after_inline_opt optimizations performed immediately after inlining
820 FIRM_API void inline_functions(unsigned maxsize, int inline_threshold,
821 opt_ptr after_inline_opt);
824 * Creates an ir_prog pass for inline_functions().
826 * @param name the name of this pass or NULL
827 * @param maxsize Do not inline any calls if a method has more than
828 * maxsize firm nodes. It may reach this limit by
830 * @param inline_threshold inlining threshold
831 * @param after_inline_opt a function that is called after inlining a
832 * procedure. You should run fast local optimisations
833 * here which cleanup the graph before further
836 * @return the newly created ir_prog pass
838 FIRM_API ir_prog_pass_t *inline_functions_pass(const char *name,
839 unsigned maxsize, int inline_threshold, opt_ptr after_inline_opt);
842 * Combines congruent blocks into one.
844 * @param irg The IR-graph to optimize.
846 * @return non-zero if the graph was transformed
848 FIRM_API int shape_blocks(ir_graph *irg);
851 * Creates an ir_graph pass for shape_blocks().
853 * @param name the name of this pass or NULL
855 * @return the newly created ir_graph pass
857 FIRM_API ir_graph_pass_t *shape_blocks_pass(const char *name);
860 * Perform loop inversion on a given graph.
861 * Loop inversion transforms a head controlled loop (like while(...) {} and
862 * for(...) {}) into a foot controlled loop (do {} while(...)).
864 FIRM_API void do_loop_inversion(ir_graph *irg);
867 * Perform loop unrolling on a given graph.
868 * Loop unrolling multiplies the number loop completely by a number found
869 * through a heuristic.
871 FIRM_API void do_loop_unrolling(ir_graph *irg);
874 * Perform loop peeling on a given graph.
876 FIRM_API void do_loop_peeling(ir_graph *irg);
879 * Creates an ir_graph pass for loop inversion.
881 * @param name the name of this pass or NULL
883 * @return the newly created ir_graph pass
885 FIRM_API ir_graph_pass_t *loop_inversion_pass(const char *name);
888 * Creates an ir_graph pass for loop unrolling.
890 * @param name the name of this pass or NULL
892 * @return the newly created ir_graph pass
894 FIRM_API ir_graph_pass_t *loop_unroll_pass(const char *name);
897 * Creates an ir_graph pass for loop peeling.
899 * @param name the name of this pass or NULL
901 * @return the newly created ir_graph pass
903 FIRM_API ir_graph_pass_t *loop_peeling_pass(const char *name);
905 typedef ir_type *(*get_Alloc_func)(ir_node *n);
906 /** Set a new get_Alloc_func and returns the old one. */
907 FIRM_API get_Alloc_func firm_set_Alloc_func(get_Alloc_func newf);
910 * Creates an ir_graph pass for set_vrp_data()
912 * @param name The name of this pass or NULL
914 * @return the newly created ir_graph pass
916 FIRM_API ir_graph_pass_t *set_vrp_pass(const char *name);
919 * Removes all entities which are unused.
921 * Unused entities have ir_visibility_local and are not used directly or
922 * indirectly through entities/code visible outside the compilation unit.
923 * This is usually conservative than gc_irgs, but does not respect properties
924 * of object-oriented programs.
926 FIRM_API void garbage_collect_entities(void);
928 /** Pass for garbage_collect_entities */
929 FIRM_API ir_prog_pass_t *garbage_collect_entities_pass(const char *name);
932 * Performs dead node elimination by copying the ir graph to a new obstack.
934 * The major intention of this pass is to free memory occupied by
935 * dead nodes and outdated analyzes information. Further this
936 * function removes Bad predecessors from Blocks and the corresponding
937 * inputs to Phi nodes. This opens optimization potential for other
938 * optimizations. Further this phase reduces dead Block<->Jmp
939 * self-cycles to Bad nodes.
941 * Dead_node_elimination is only performed if options `optimize' and
942 * `opt_dead_node_elimination' are set. The graph may
943 * not be in state phase_building. The outs datastructure is freed,
944 * the outs state set to outs_none. Backedge information is conserved.
945 * Removes old attributes of nodes. Sets link field to NULL.
946 * Callee information must be freed (irg_callee_info_none).
948 * @param irg The graph to be optimized.
950 FIRM_API void dead_node_elimination(ir_graph *irg);
953 * Creates an ir_graph pass for dead_node_elimination().
955 * @param name the name of this pass or NULL
957 * @return the newly created ir_graph pass
959 FIRM_API ir_graph_pass_t *dead_node_elimination_pass(const char *name);
962 * Inlines a method at the given call site.
964 * Removes the call node and splits the basic block the call node
965 * belongs to. Inserts a copy of the called graph between these nodes.
966 * Assumes that call is a Call node in current_ir_graph and that
967 * the type in the Call nodes type attribute is the same as the
968 * type of the called graph.
969 * Further it assumes that all Phi nodes in a block of current_ir_graph
970 * are assembled in a "link" list in the link field of the corresponding
971 * block nodes. Further assumes that all Proj nodes are in a "link" list
972 * in the nodes producing the tuple. (This is only an optical feature
973 * for the graph.) Conserves this feature for the old
974 * nodes of the graph. This precondition can be established by a call to
975 * collect_phisprojs(), see irgmod.h.
976 * As dead_node_elimination this function reduces dead Block<->Jmp
977 * self-cycles to Bad nodes.
979 * Called_graph must be unequal to current_ir_graph. Will not inline
981 * Sets visited masterflag in current_ir_graph to the max of the flag in
982 * current and called graph.
983 * Assumes that both, the called and the calling graph are in state
984 * "op_pin_state_pinned".
985 * It is recommended to call local_optimize_graph() after inlining as this
986 * function leaves a set of obscure Tuple nodes, e.g. a Proj-Tuple-Jmp
987 * combination as control flow operation.
989 * @param call the call node that should be inlined
990 * @param called_graph the IR-graph that is called at call
992 * @return zero if method could not be inlined (recursion for instance),
993 * non-zero if all went ok
995 FIRM_API int inline_method(ir_node *call, ir_graph *called_graph);
1000 * Pins all floating nodes to a block where they
1001 * will be executed only if needed. Depends on the flag opt_global_cse.
1002 * Graph may not be in phase_building. Does not schedule control dead
1003 * code. Uses dominator information which it computes if the irg is not
1004 * in state dom_consistent. Destroys the out information as it moves nodes
1005 * to other blocks. Optimizes Tuples in Control edges.
1007 * Call remove_critical_cf_edges() before place_code(). This normalizes
1008 * the control flow graph so that for all operations a basic block exists
1009 * where they can be optimally placed.
1011 FIRM_API void place_code(ir_graph *irg);
1014 * Creates an ir_graph pass for place_code().
1015 * This pass enables GCSE, runs optimize_graph_df() and finally
1018 * @param name the name of this pass or NULL
1020 * @return the newly created ir_graph pass
1022 FIRM_API ir_graph_pass_t *place_code_pass(const char *name);
1025 * Determine information about the values of nodes and perform simplifications
1026 * using this information. This optimization performs a data-flow analysis to
1027 * find the minimal fixpoint.
1029 FIRM_API void fixpoint_vrp(ir_graph*);
1032 * Creates an ir_graph pass for fixpoint_vrp().
1033 * This pass dDetermines information about the values of nodes
1034 * and perform simplifications using this information.
1035 * This optimization performs a data-flow analysis to
1036 * find the minimal fixpoint.
1038 * @param name the name of this pass or NULL
1040 * @return the newly created ir_graph pass
1042 FIRM_API ir_graph_pass_t *fixpoint_vrp_irg_pass(const char *name);
1045 * Check, if the value of a node is != 0.
1047 * This is a often needed case, so we handle here Confirm
1050 * @param n a node representing the value
1051 * @param confirm if n is confirmed to be != 0, returns
1052 * the the Confirm-node, else NULL
1054 FIRM_API int value_not_zero(const ir_node *n, ir_node_cnst_ptr *confirm);
1057 * Check, if the value of a node cannot represent a NULL pointer.
1059 * - If option sel_based_null_check_elim is enabled, all
1060 * Sel nodes can be skipped.
1061 * - A SymConst(entity) is NEVER a NULL pointer
1062 * - A Const != NULL is NEVER a NULL pointer
1063 * - Confirms are evaluated
1065 * @param n a node representing the value
1066 * @param confirm if n is confirmed to be != NULL, returns
1067 * the the Confirm-node, else NULL
1069 FIRM_API int value_not_null(const ir_node *n, ir_node_cnst_ptr *confirm);
1072 * Check, if the value of a node can be confirmed >= 0 or <= 0,
1073 * If the mode of the value did not honor signed zeros, else
1074 * check for >= 0 or < 0.
1076 * @param n a node representing the value
1078 FIRM_API ir_value_classify_sign classify_value_sign(ir_node *n);
1081 * Return the value of a Cmp if one or both predecessors
1082 * are Confirm nodes.
1084 * @param cmp the compare node that will be evaluated
1085 * @param left the left operand of the Cmp
1086 * @param right the right operand of the Cmp
1087 * @param relation the compare relation
1089 FIRM_API ir_tarval *computed_value_Cmp_Confirm(
1090 const ir_node *cmp, ir_node *left, ir_node *right, ir_relation relation);