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 * @param force_run if non-zero, an optimization run is started even
173 * if no const function graph was detected.
174 * Else calls are only optimized if at least one
175 * const function graph was detected.
176 * @param callback a callback function to check whether a
177 * given entity is a allocation call
179 * If the frontend created external entities with the irg_const_function
180 * property set, the force_run parameter should be set, else
183 * @note This optimization destroys the link fields of nodes.
185 FIRM_API void optimize_funccalls(int force_run,
186 check_alloc_entity_func callback);
189 * Creates an ir_prog pass for optimize_funccalls().
191 * @param name the name of this pass or NULL
192 * @param force_run if non-zero, an optimization run is started even
193 * if no const function graph was detected.
194 * Else calls are only optimized if at least one
195 * const function graph was detected.
196 * @param callback a callback function to check whether a
197 * given entity is a allocation call
199 * @return the newly created ir_prog pass
201 FIRM_API ir_prog_pass_t *optimize_funccalls_pass(const char *name,
203 check_alloc_entity_func callback);
206 * Does Partial Redundancy Elimination combined with
207 * Global Value Numbering.
208 * Can be used to replace place_code() completely.
210 * Based on VanDrunen and Hosking 2004.
212 * @param irg the graph
214 FIRM_API void do_gvn_pre(ir_graph *irg);
217 * Creates an ir_graph pass for do_gvn_pre().
219 * @param name the name of this pass or NULL
221 * @return the newly created ir_graph pass
223 FIRM_API ir_graph_pass_t *do_gvn_pre_pass(const char *name);
226 * This function is called to evaluate, if a
227 * mux(@p sel, @p mux_false, @p mux_true) should be built for the current
229 * If it returns non-zero, a mux is created, else the code
231 * @param sel A selector of a Cond.
232 * @param phi_list phi node to be converted
233 * @param i First data predecessor involved in if conversion
234 * @param j Second data predecessor involved in if conversion
236 typedef int (*arch_allow_ifconv_func)(ir_node *sel, ir_node *mux_false,
240 * Perform If conversion on a graph.
242 * @param irg The graph.
244 * Cannot handle blocks with Bad control predecessors, so call it after control
247 FIRM_API void opt_if_conv(ir_graph *irg);
250 * Creates an ir_graph pass for opt_if_conv().
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_if_conv_pass(const char *name);
259 * Tries to reduce dependencies for memory nodes where possible by parallelizing
260 * them and synchronizing with Sync nodes
261 * @param irg the graph where memory operations should be parallelized
263 FIRM_API void opt_parallelize_mem(ir_graph *irg);
266 * Creates an ir_graph pass for opt_sync().
268 * @param name the name of this pass or NULL
270 * @return the newly created ir_graph pass
272 FIRM_API ir_graph_pass_t *opt_parallelize_mem_pass(const char *name);
275 * Check if we can replace the load by a given const from
276 * the const code irg.
278 * @param load the load to replace
279 * @param c the constant
281 * @return in the modes match or can be transformed using a reinterpret cast
282 * returns a copy of the constant (possibly Conv'ed) on the
285 FIRM_API ir_node *can_replace_load_by_const(const ir_node *load, ir_node *c);
288 * Load/Store optimization.
290 * Removes redundant non-volatile Loads and Stores.
291 * May introduce Bad nodes if exceptional control flow
292 * is removed. The following cases are optimized:
294 * Load without result: A Load which has only a memory use
297 * Load after Store: A Load after a Store is removed, if
298 * the Load doesn't have an exception handler OR is in
299 * the same block as the Store.
301 * Load after Load: A Load after a Load is removed, if the
302 * Load doesn't have an exception handler OR is in the
303 * same block as the previous Load.
305 * Store before Store: A Store immediately before another
306 * Store in the same block is removed, if the Store doesn't
307 * have an exception handler.
309 * Store after Load: A Store after a Load is removed, if the
310 * Store doesn't have an exception handler.
312 * @return non-zero if the optimization could be applied, 0 else
314 FIRM_API int optimize_load_store(ir_graph *irg);
317 * Creates an ir_graph pass for optimize_load_store().
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 *optimize_load_store_pass(const char *name);
326 * New experimental alternative to optimize_load_store.
327 * Based on a dataflow analysis, so load/stores are moved out of loops
330 FIRM_API int opt_ldst(ir_graph *irg);
333 * Creates an ir_graph pass for opt_ldst().
335 * @param name the name of this pass or NULL
337 * @return the newly created ir_graph pass
339 FIRM_API ir_graph_pass_t *opt_ldst_pass(const char *name);
342 * Optimize loops by peeling or unrolling them if beneficial.
344 * @param irg The graph whose loops will be processed
346 * This function did not change the graph, only it's frame type.
347 * The layout state of the frame type will be set to layout_undefined
348 * if entities were removed.
350 FIRM_API void loop_optimization(ir_graph *irg);
353 * Optimize the frame type of an irg by removing
354 * never touched entities.
356 * @param irg The graph whose frame type will be optimized
358 * This function did not change the graph, only it's frame type.
359 * The layout state of the frame type will be set to layout_undefined
360 * if entities were removed.
362 FIRM_API void opt_frame_irg(ir_graph *irg);
365 * Creates an ir_graph pass for opt_frame_irg().
367 * @param name the name of this pass or NULL
369 * @return the newly created ir_graph pass
371 FIRM_API ir_graph_pass_t *opt_frame_irg_pass(const char *name);
373 /** Possible flags for the Operator Scalar Replacement. */
374 typedef enum osr_flags {
375 osr_flag_none = 0, /**< no additional flags */
376 osr_flag_lftr_with_ov_check = 1, /**< do linear function test replacement
377 only if no overflow can occur. */
378 osr_flag_ignore_x86_shift = 2, /**< ignore Multiplications by 2, 4, 8 */
379 osr_flag_keep_reg_pressure = 4 /**< do NOT increase register pressure by introducing new
380 induction variables. */
383 /* FirmJNI cannot handle identical enum values... */
385 /** default setting */
386 #define osr_flag_default osr_flag_lftr_with_ov_check
389 * Do the Operator Scalar Replacement optimization and linear
390 * function test replacement for loop control.
391 * Can be switched off using the set_opt_strength_red() flag.
392 * In that case, only remove_phi_cycles() is executed.
394 * @param irg the graph which should be optimized
395 * @param flags set of osr_flags
397 * The linear function replacement test is controlled by the flags.
398 * If the osr_flag_lftr_with_ov_check is set, the replacement is only
399 * done if do overflow can occur.
400 * Otherwise it is ALWAYS done which might be insecure.
404 * for (i = 0; i < 100; ++i)
406 * might be replaced by
408 * for (i = 0; i < 400; i += 4)
412 * for (i = 0; i < 0x7FFFFFFF; ++i)
414 * will not be replaced by
416 * for (i = 0; i < 0xFFFFFFFC; i += 4)
418 * because of overflow.
422 * for (i = 0; i <= 0xF; ++i)
424 * will NOT be transformed into
426 * for (i = 0xFFFFFFF0; i <= 0xFFFFFFFF; ++i)
428 * although here is no direct overflow. The OV occurs when the ++i
429 * is executed (and would created an endless loop here!).
431 * For the same reason, a loop
433 * for (i = 0; i <= 9; i += x)
435 * will NOT be transformed because we cannot estimate whether an overflow
436 * might happen adding x.
438 * Note that i < a + 400 is also not possible with the current implementation
439 * although this might be allowed by other compilers...
441 * Note further that tests for equality can be handled some simpler (but are not
444 * This algorithm destroys the link field of nodes.
446 FIRM_API void opt_osr(ir_graph *irg, unsigned flags);
449 * Creates an ir_graph pass for remove_phi_cycles().
451 * @param name the name of this pass or NULL
452 * @param flags set of osr_flags
454 * @return the newly created ir_graph pass
456 FIRM_API ir_graph_pass_t *opt_osr_pass(const char *name, unsigned flags);
459 * Removes useless Phi cycles, i.e cycles of Phi nodes with only one
461 * This is automatically done in opt_osr(), so there is no need to call it
464 * @param irg the graph which should be optimized
466 * This algorithm destroys the link field of nodes.
468 FIRM_API void remove_phi_cycles(ir_graph *irg);
471 * Creates an ir_graph pass for remove_phi_cycles().
473 * @param name the name of this pass or NULL
475 * @return the newly created ir_graph pass
477 FIRM_API ir_graph_pass_t *remove_phi_cycles_pass(const char *name);
480 /** A default threshold. */
481 #define DEFAULT_CLONE_THRESHOLD 20
484 * Do procedure cloning. Evaluate a heuristic weight for every
485 * Call(..., Const, ...). If the weight is bigger than threshold,
486 * clone the entity and fix the calls.
488 * @param threshold the threshold for cloning
490 * The threshold is an estimation of how many instructions are saved
491 * when executing a cloned method. If threshold is 0.0, every possible
494 FIRM_API void proc_cloning(float threshold);
497 * Creates an ir_prog pass for proc_cloning().
499 * @param name the name of this pass or NULL
500 * @param threshold the threshold for cloning
502 * @return the newly created ir_prog pass
504 FIRM_API ir_prog_pass_t *proc_cloning_pass(const char *name, float threshold);
509 * Applies Reassociation rules to integer expressions.
510 * Beware: Works only if integer overflow might be ignored, as for C, Java
511 * and for address expression.
512 * Works only if Constant folding is activated.
514 * Uses loop information to detect loop-invariant (i.e. contant
515 * inside the loop) values.
517 * See Muchnik 12.3.1 Algebraic Simplification and Reassociation of
518 * Addressing Expressions.
520 * @return non-zero if the optimization could be applied, 0 else
522 FIRM_API int optimize_reassociation(ir_graph *irg);
525 * Creates an ir_graph pass for optimize_reassociation().
527 * @param name the name of this pass or NULL
529 * @return the newly created ir_graph pass
531 FIRM_API ir_graph_pass_t *optimize_reassociation_pass(const char *name);
534 * Normalize the Returns of a graph by creating a new End block
535 * with One Return(Phi).
536 * This is the preferred input for the if-conversion.
538 * In pseudocode, it means:
545 * is transformed into
553 FIRM_API void normalize_one_return(ir_graph *irg);
556 * Creates an ir_graph pass for normalize_one_return().
558 * @param name the name of this pass or NULL
560 * @return the newly created ir_graph pass
562 FIRM_API ir_graph_pass_t *normalize_one_return_pass(const char *name);
565 * Normalize the Returns of a graph by moving
566 * the Returns upwards as much as possible.
567 * This might be preferred for code generation.
569 * In pseudocode, it means:
577 * is transformed into
584 FIRM_API void normalize_n_returns(ir_graph *irg);
587 * Creates an ir_graph pass for normalize_n_returns().
589 * @param name the name of this pass or NULL
591 * @return the newly created ir_graph pass
593 FIRM_API ir_graph_pass_t *normalize_n_returns_pass(const char *name);
596 * Do the scalar replacement optimization.
597 * Replace local compound entities (like structures and arrays)
598 * with atomic values if possible. Does not handle classes yet.
600 * @param irg the graph which should be optimized
602 * @return non-zero, if at least one entity was replaced
604 FIRM_API int scalar_replacement_opt(ir_graph *irg);
607 * Creates an ir_graph pass for scalar_replacement_opt().
609 * @param name the name of this pass or NULL
611 * @return the newly created ir_graph pass
613 FIRM_API ir_graph_pass_t *scalar_replacement_opt_pass(const char *name);
616 * Optimizes tail-recursion calls by converting them into loops.
617 * Depends on the flag opt_tail_recursion.
618 * Currently supports the following forms:
620 * - return x + func();
621 * - return func() - x;
622 * - return x * func();
625 * Does not work for Calls that use the exception stuff.
627 * @param irg the graph to be optimized
629 * @return non-zero if the optimization could be applied, 0 else
631 FIRM_API int opt_tail_rec_irg(ir_graph *irg);
634 * Creates an ir_graph pass for opt_tail_rec_irg().
636 * @param name the name of this pass or NULL
638 * @return the newly created ir_graph pass
640 FIRM_API ir_graph_pass_t *opt_tail_rec_irg_pass(const char *name);
643 * Optimize tail-recursion calls for all IR-Graphs.
644 * Can currently handle:
645 * - direct return value, i.e. return func().
646 * - additive return value, i.e. return x +/- func()
647 * - multiplicative return value, i.e. return x * func() or return -func()
649 * The current implementation must be run before optimize_funccalls(),
650 * because it expects the memory edges pointing to calls, which might be
651 * removed by optimize_funccalls().
653 FIRM_API void opt_tail_recursion(void);
656 * Creates an ir_prog pass for opt_tail_recursion().
658 * @param name the name of this pass or NULL
660 * @return the newly created ir_prog pass
662 FIRM_API ir_prog_pass_t *opt_tail_recursion_pass(const char *name);
664 /** This is the type for a method, that returns a pointer type to
665 * tp. This is needed in the normalization. */
666 typedef ir_type *(*gen_pointer_type_to_func)(ir_type *tp);
668 /** Insert Casts so that class type casts conform exactly with the type hierarchy.
670 * Formulated in Java, this achieves the following:
672 * For a class hierarchy
674 * class B extends A {}
675 * class C extends B {}
676 * we transforms a cast
681 * The algorithm works for Casts with class types, but also for Casts
682 * with all pointer types that point (over several indirections,
683 * i.e. ***A) to a class type. Normalizes all graphs. Computes type
684 * information (@see irtypeinfo.h) if not available.
685 * Invalidates trout information as new casts are generated.
687 * @param gppt_fct A function that returns a pointer type that points
688 * to the type given as argument. If this parameter is NULL, a default
689 * function is used that either uses trout information or performs a O(n)
690 * search to find an existing pointer type. If it can not find a type,
691 * generates a pointer type with mode_P_mach and suffix "cc_ptr_tp".
693 FIRM_API void normalize_irp_class_casts(gen_pointer_type_to_func gppt_fct);
695 /** Insert Casts so that class type casts conform exactly with the type hierarchy
698 * For more details see normalize_irp_class_casts().
700 * This transformation requires that type information is computed. @see irtypeinfo.h.
702 FIRM_API void normalize_irg_class_casts(ir_graph *irg,
703 gen_pointer_type_to_func gppt_fct);
705 /** Optimize casting between class types.
708 * class B extends A { }
709 * class C extends B {}
710 * Performs the following transformations:
711 * C c = (C)(B)(A)(B)new C() --> C c = (C)(B)newC() --> C c = new C()
712 * (Optimizing downcasts as A a = (A)(B)(new A()) --> A a = new A() can
713 * be suppressed by setting the flag opt_suppress_downcast_optimization.
714 * Downcasting A to B might cause an exception. It is not clear
715 * whether this is modeled by the Firm Cast node, as it has no exception
717 * If there is inh_m() that overwrites m() in B:
718 * ((A) new B()).m() --> (new B()).inh_m()
719 * Phi((A)x, (A)y) --> (A) Phi (x, y) if (A) is an upcast.
721 * Computes type information if not available. @see irtypeinfo.h.
722 * Typeinformation is valid after optimization.
723 * Invalidates trout information.
725 FIRM_API void optimize_class_casts(void);
728 * CLiff Click's combo algorithm from
729 * "Combining Analyses, combining Optimizations".
731 * Does conditional constant propagation, unreachable code elimination and
732 * optimistic global value numbering at once.
734 * @param irg the graph to run on
736 FIRM_API void combo(ir_graph *irg);
739 * Creates an ir_graph pass for combo.
741 * @param name the name of this pass or NULL
743 * @return the newly created ir_graph pass
745 FIRM_API ir_graph_pass_t *combo_pass(const char *name);
748 * Inlines all small methods at call sites where the called address comes
749 * from a SymConst node that references the entity representing the called
752 * @param irg the graph
753 * @param size maximum function size
755 * The size argument is a rough measure for the code size of the method:
756 * Methods where the obstack containing the firm graph is smaller than
757 * size are inlined. Further only a limited number of calls are inlined.
758 * If the method contains more than 1024 inlineable calls none will be
760 * Inlining is only performed if flags `optimize' and `inlining' are set.
761 * The graph may not be in state phase_building.
762 * It is recommended to call local_optimize_graph() after inlining as this
763 * function leaves a set of obscure Tuple nodes, e.g. a Proj-Tuple-Jmp
764 * combination as control flow operation.
766 FIRM_API void inline_small_irgs(ir_graph *irg, int size);
769 * Creates an ir_graph pass for inline_small_irgs().
771 * @param name the name of this pass or NULL
772 * @param size maximum function size
774 * @return the newly created ir_graph pass
776 FIRM_API ir_graph_pass_t *inline_small_irgs_pass(const char *name, int size);
779 * Inlineing with a different heuristic than inline_small_irgs().
781 * Inlines leave functions. If inlining creates new leave
782 * function inlines these, too. (If g calls f, and f calls leave h,
783 * h is first inlined in f and then f in g.)
785 * Then inlines all small functions (this is not recursive).
787 * For a heuristic this inlining uses firm node counts. It does
788 * not count auxiliary nodes as Proj, Tuple, End, Start, Id, Sync.
789 * If the ignore_runtime flag is set, calls to functions marked with the
790 * mtp_property_runtime property are ignored.
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 FIRM_API void inline_leave_functions(unsigned maxsize, unsigned leavesize,
802 unsigned size, int ignore_runtime);
805 * Creates an ir_prog pass for inline_leave_functions().
807 * @param name the name of this pass or NULL
808 * @param maxsize Do not inline any calls if a method has more than
809 * maxsize firm nodes. It may reach this limit by
811 * @param leavesize Inline leave functions if they have less than leavesize
813 * @param size Inline all function smaller than size.
814 * @param ignore_runtime count a function only calling runtime functions as
817 * @return the newly created ir_prog pass
819 FIRM_API ir_prog_pass_t *inline_leave_functions_pass(const char *name,
820 unsigned maxsize, unsigned leavesize, unsigned size,
823 typedef void (*opt_ptr)(ir_graph *irg);
826 * Heuristic inliner. Calculates a benefice value for every call and inlines
827 * those calls with a value higher than the threshold.
829 * @param maxsize Do not inline any calls if a method has more than
830 * maxsize firm nodes. It may reach this limit by
832 * @param inline_threshold inlining threshold
833 * @param after_inline_opt optimizations performed immediately after inlining
836 FIRM_API void inline_functions(unsigned maxsize, int inline_threshold,
837 opt_ptr after_inline_opt);
840 * Creates an ir_prog pass for inline_functions().
842 * @param name the name of this pass or NULL
843 * @param maxsize Do not inline any calls if a method has more than
844 * maxsize firm nodes. It may reach this limit by
846 * @param inline_threshold inlining threshold
847 * @param after_inline_opt a function that is called after inlining a
848 * procedure. You should run fast local optimisations
849 * here which cleanup the graph before further
852 * @return the newly created ir_prog pass
854 FIRM_API ir_prog_pass_t *inline_functions_pass(const char *name,
855 unsigned maxsize, int inline_threshold, opt_ptr after_inline_opt);
858 * Combines congruent blocks into one.
860 * @param irg The IR-graph to optimize.
862 * @return non-zero if the graph was transformed
864 FIRM_API int shape_blocks(ir_graph *irg);
867 * Creates an ir_graph pass for shape_blocks().
869 * @param name the name of this pass or NULL
871 * @return the newly created ir_graph pass
873 FIRM_API ir_graph_pass_t *shape_blocks_pass(const char *name);
876 * Perform loop inversion on a given graph.
877 * Loop inversion transforms a head controlled loop (like while(...) {} and
878 * for(...) {}) into a foot controlled loop (do {} while(...)).
880 FIRM_API void do_loop_inversion(ir_graph *irg);
883 * Perform loop unrolling on a given graph.
884 * Loop unrolling multiplies the number loop completely by a number found
885 * through a heuristic.
887 FIRM_API void do_loop_unrolling(ir_graph *irg);
890 * Perform loop peeling on a given graph.
892 FIRM_API void do_loop_peeling(ir_graph *irg);
895 * Creates an ir_graph pass for loop inversion.
897 * @param name the name of this pass or NULL
899 * @return the newly created ir_graph pass
901 FIRM_API ir_graph_pass_t *loop_inversion_pass(const char *name);
904 * Creates an ir_graph pass for loop unrolling.
906 * @param name the name of this pass or NULL
908 * @return the newly created ir_graph pass
910 FIRM_API ir_graph_pass_t *loop_unroll_pass(const char *name);
913 * Creates an ir_graph pass for loop peeling.
915 * @param name the name of this pass or NULL
917 * @return the newly created ir_graph pass
919 FIRM_API ir_graph_pass_t *loop_peeling_pass(const char *name);
921 typedef ir_type *(*get_Alloc_func)(ir_node *n);
922 /** Set a new get_Alloc_func and returns the old one. */
923 FIRM_API get_Alloc_func firm_set_Alloc_func(get_Alloc_func newf);
926 * Creates an ir_graph pass for set_vrp_data()
928 * @param name The name of this pass or NULL
930 * @return the newly created ir_graph pass
932 FIRM_API ir_graph_pass_t *set_vrp_pass(const char *name);
935 * Removes all entities which are unused.
937 * Unused entities have ir_visibility_local and are not used directly or
938 * indirectly through entities/code visible outside the compilation unit.
939 * This is usually conservative than gc_irgs, but does not respect properties
940 * of object-oriented programs.
942 FIRM_API void garbage_collect_entities(void);
944 /** Pass for garbage_collect_entities */
945 FIRM_API ir_prog_pass_t *garbage_collect_entities_pass(const char *name);
948 * Performs dead node elimination by copying the ir graph to a new obstack.
950 * The major intention of this pass is to free memory occupied by
951 * dead nodes and outdated analyzes information. Further this
952 * function removes Bad predecessors from Blocks and the corresponding
953 * inputs to Phi nodes. This opens optimization potential for other
954 * optimizations. Further this phase reduces dead Block<->Jmp
955 * self-cycles to Bad nodes.
957 * Dead_node_elimination is only performed if options `optimize' and
958 * `opt_dead_node_elimination' are set. The graph may
959 * not be in state phase_building. The outs datastructure is freed,
960 * the outs state set to outs_none. Backedge information is conserved.
961 * Removes old attributes of nodes. Sets link field to NULL.
962 * Callee information must be freed (irg_callee_info_none).
964 * @param irg The graph to be optimized.
966 FIRM_API void dead_node_elimination(ir_graph *irg);
969 * Creates an ir_graph pass for dead_node_elimination().
971 * @param name the name of this pass or NULL
973 * @return the newly created ir_graph pass
975 FIRM_API ir_graph_pass_t *dead_node_elimination_pass(const char *name);
978 * Inlines a method at the given call site.
980 * Removes the call node and splits the basic block the call node
981 * belongs to. Inserts a copy of the called graph between these nodes.
982 * Assumes that call is a Call node in current_ir_graph and that
983 * the type in the Call nodes type attribute is the same as the
984 * type of the called graph.
985 * Further it assumes that all Phi nodes in a block of current_ir_graph
986 * are assembled in a "link" list in the link field of the corresponding
987 * block nodes. Further assumes that all Proj nodes are in a "link" list
988 * in the nodes producing the tuple. (This is only an optical feature
989 * for the graph.) Conserves this feature for the old
990 * nodes of the graph. This precondition can be established by a call to
991 * collect_phisprojs(), see irgmod.h.
992 * As dead_node_elimination this function reduces dead Block<->Jmp
993 * self-cycles to Bad nodes.
995 * Called_graph must be unequal to current_ir_graph. Will not inline
997 * Sets visited masterflag in current_ir_graph to the max of the flag in
998 * current and called graph.
999 * Assumes that both, the called and the calling graph are in state
1000 * "op_pin_state_pinned".
1001 * It is recommended to call local_optimize_graph() after inlining as this
1002 * function leaves a set of obscure Tuple nodes, e.g. a Proj-Tuple-Jmp
1003 * combination as control flow operation.
1005 * @param call the call node that should be inlined
1006 * @param called_graph the IR-graph that is called at call
1008 * @return zero if method could not be inlined (recursion for instance),
1009 * non-zero if all went ok
1011 FIRM_API int inline_method(ir_node *call, ir_graph *called_graph);
1016 * Pins all floating nodes to a block where they
1017 * will be executed only if needed. Depends on the flag opt_global_cse.
1018 * Graph may not be in phase_building. Does not schedule control dead
1019 * code. Uses dominator information which it computes if the irg is not
1020 * in state dom_consistent. Destroys the out information as it moves nodes
1021 * to other blocks. Optimizes Tuples in Control edges.
1023 * Call remove_critical_cf_edges() before place_code(). This normalizes
1024 * the control flow graph so that for all operations a basic block exists
1025 * where they can be optimally placed.
1027 FIRM_API void place_code(ir_graph *irg);
1030 * Creates an ir_graph pass for place_code().
1031 * This pass enables GCSE, runs optimize_graph_df() and finally
1034 * @param name the name of this pass or NULL
1036 * @return the newly created ir_graph pass
1038 FIRM_API ir_graph_pass_t *place_code_pass(const char *name);
1041 * Determine information about the values of nodes and perform simplifications
1042 * using this information. This optimization performs a data-flow analysis to
1043 * find the minimal fixpoint.
1045 FIRM_API void fixpoint_vrp(ir_graph*);
1048 * Creates an ir_graph pass for fixpoint_vrp().
1049 * This pass dDetermines information about the values of nodes
1050 * and perform simplifications using this information.
1051 * This optimization performs a data-flow analysis to
1052 * find the minimal fixpoint.
1054 * @param name the name of this pass or NULL
1056 * @return the newly created ir_graph pass
1058 FIRM_API ir_graph_pass_t *fixpoint_vrp_irg_pass(const char *name);
1061 * Check, if the value of a node is != 0.
1063 * This is a often needed case, so we handle here Confirm
1066 * @param n a node representing the value
1067 * @param confirm if n is confirmed to be != 0, returns
1068 * the the Confirm-node, else NULL
1070 FIRM_API int value_not_zero(const ir_node *n, ir_node_cnst_ptr *confirm);
1073 * Check, if the value of a node cannot represent a NULL pointer.
1075 * - If option sel_based_null_check_elim is enabled, all
1076 * Sel nodes can be skipped.
1077 * - A SymConst(entity) is NEVER a NULL pointer
1078 * - A Const != NULL is NEVER a NULL pointer
1079 * - Confirms are evaluated
1081 * @param n a node representing the value
1082 * @param confirm if n is confirmed to be != NULL, returns
1083 * the the Confirm-node, else NULL
1085 FIRM_API int value_not_null(const ir_node *n, ir_node_cnst_ptr *confirm);
1088 * Check, if the value of a node can be confirmed >= 0 or <= 0,
1089 * If the mode of the value did not honor signed zeros, else
1090 * check for >= 0 or < 0.
1092 * @param n a node representing the value
1094 FIRM_API ir_value_classify_sign classify_value_sign(ir_node *n);
1097 * Return the value of a Cmp if one or both predecessors
1098 * are Confirm nodes.
1100 * @param cmp the compare node that will be evaluated
1101 * @param left the left operand of the Cmp
1102 * @param right the right operand of the Cmp
1103 * @param pnc the compare relation
1105 FIRM_API ir_tarval *computed_value_Cmp_Confirm(
1106 ir_node *cmp, ir_node *left, ir_node *right, pn_Cmp pnc);