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.
24 #ifndef FIRM_IROPTIMIZE_H
25 #define FIRM_IROPTIMIZE_H
27 #include "firm_types.h"
32 * @defgroup iroptimize Transformations and Optimisations
37 * Control flow optimization.
39 * Removes empty blocks doing if simplifications and loop simplifications.
40 * A block is empty if it contains only a Jmp node and Phi nodes.
41 * Merges single entry single exit blocks with their predecessor
42 * and propagates dead control flow by calling equivalent_node().
43 * Independent of compiler flag it removes Tuples from cf edges,
44 * Bad predecessors from Blocks and Phis, and unnecessary predecessors of End.
45 * Destroys backedge information.
47 * @bug Chokes on Id nodes if called in a certain order with other
48 * optimizations. Call local_optimize_graph() before to remove
51 FIRM_API void optimize_cf(ir_graph *irg);
54 * Creates an ir_graph pass for optimize_cf().
56 * @param name the name of this pass or NULL
58 * @return the newly created ir_graph pass
60 FIRM_API ir_graph_pass_t *optimize_cf_pass(const char *name);
63 * Perform path-sensitive jump threading on the given graph.
65 * @param irg the graph
67 FIRM_API void opt_jumpthreading(ir_graph* irg);
70 * Creates an ir_graph pass for opt_jumpthreading().
72 * @param name the name of this pass or NULL
74 * @return the newly created ir_graph pass
76 FIRM_API ir_graph_pass_t *opt_jumpthreading_pass(const char *name);
79 * Try to simplify boolean expression in the given ir graph.
80 * eg. x < 5 && x < 6 becomes x < 5
82 * @param irg the graph
84 FIRM_API void opt_bool(ir_graph *irg);
87 * Creates an ir_graph pass for opt_bool().
89 * @param name the name of this pass or NULL
91 * @return the newly created ir_graph pass
93 FIRM_API ir_graph_pass_t *opt_bool_pass(const char *name);
96 * Try to reduce the number of conv nodes in the given ir graph.
98 * @param irg the graph
100 * @return non-zero if the optimization could be applied, 0 else
102 FIRM_API int conv_opt(ir_graph *irg);
105 * Creates an ir_graph pass for conv_opt().
107 * @param name the name of this pass or NULL
109 * @return the newly created ir_graph pass
111 FIRM_API ir_graph_pass_t *conv_opt_pass(const char *name);
114 * A callback that checks whether a entity is an allocation
117 typedef int (*check_alloc_entity_func)(ir_entity *ent);
120 * Do simple and fast escape analysis for one graph.
122 * @param irg the graph
123 * @param callback a callback function to check whether a
124 * given entity is a allocation call
126 FIRM_API void escape_enalysis_irg(ir_graph *irg,
127 check_alloc_entity_func callback);
130 * Do simple and fast escape analysis for all graphs.
132 * This optimization implements a simple and fast but inexact
133 * escape analysis. Some addresses might be marked as 'escaped' even
135 * The advantage is a low memory footprint and fast speed.
137 * @param run_scalar_replace if this flag in non-zero, scalar
138 * replacement optimization is run on graphs with removed
140 * @param callback a callback function to check whether a
141 * given entity is a allocation call
143 * This optimization removes allocation which are not used (rare) and replace
144 * allocation that can be proved dead at the end of the graph which stack variables.
146 * The creation of stack variable allows scalar replacement to be run only
147 * on those graphs that have been changed.
149 * This is most effective on Java where no other stack variables exists.
151 FIRM_API void escape_analysis(int run_scalar_replace,
152 check_alloc_entity_func callback);
155 * Optimize function calls by handling const functions.
157 * This optimization first detects all "const functions", i.e.,
158 * IR graphs that neither read nor write memory (and hence did
159 * not create exceptions, as these use memory in Firm).
161 * The result of calls to such functions depends only on its
162 * arguments, hence those calls are no more pinned.
164 * This is a rather strong criteria, so do not expect that a
165 * lot of functions will be found. Moreover, all of them might
166 * already be inlined if inlining is activated.
167 * Anyway, it might be good for handling builtin's
168 * even if the later read/write memory (but we know how).
170 * This optimizations read the irg_const_function property of
171 * entities and and sets the irg_const_function property of
174 * If callee information is valid, we also optimize polymorphic Calls.
176 FIRM_API void optimize_funccalls(void);
179 * Creates an ir_prog pass for optimize_funccalls().
181 * @param name the name of this pass or NULL
182 * @return the newly created ir_prog pass
184 FIRM_API ir_prog_pass_t *optimize_funccalls_pass(const char *name);
187 * Does Partial Redundancy Elimination combined with
188 * Global Value Numbering.
189 * Can be used to replace place_code() completely.
191 * Based on VanDrunen and Hosking 2004.
193 * @param irg the graph
195 FIRM_API void do_gvn_pre(ir_graph *irg);
198 * Creates an ir_graph pass for do_gvn_pre().
200 * @param name the name of this pass or NULL
202 * @return the newly created ir_graph pass
204 FIRM_API ir_graph_pass_t *do_gvn_pre_pass(const char *name);
207 * This function is called to evaluate, if a
208 * mux(@p sel, @p mux_false, @p mux_true) should be built for the current
210 * If it returns non-zero, a mux is created, else the code
212 * @param sel A selector of a Cond.
213 * @param phi_list phi node to be converted
214 * @param i First data predecessor involved in if conversion
215 * @param j Second data predecessor involved in if conversion
217 typedef int (*arch_allow_ifconv_func)(ir_node *sel, ir_node *mux_false,
221 * Perform If conversion on a graph.
223 * @param irg The graph.
225 * Cannot handle blocks with Bad control predecessors, so call it after control
228 FIRM_API void opt_if_conv(ir_graph *irg);
231 * Creates an ir_graph pass for opt_if_conv().
233 * @param name the name of this pass or NULL
235 * @return the newly created ir_graph pass
237 FIRM_API ir_graph_pass_t *opt_if_conv_pass(const char *name);
240 * Tries to reduce dependencies for memory nodes where possible by parallelizing
241 * them and synchronizing with Sync nodes
242 * @param irg the graph where memory operations should be parallelized
244 FIRM_API void opt_parallelize_mem(ir_graph *irg);
247 * Creates an ir_graph pass for opt_sync().
249 * @param name the name of this pass or NULL
251 * @return the newly created ir_graph pass
253 FIRM_API ir_graph_pass_t *opt_parallelize_mem_pass(const char *name);
256 * Check if we can replace the load by a given const from
257 * the const code irg.
259 * @param load the load to replace
260 * @param c the constant
262 * @return in the modes match or can be transformed using a reinterpret cast
263 * returns a copy of the constant (possibly Conv'ed) on the
266 FIRM_API ir_node *can_replace_load_by_const(const ir_node *load, ir_node *c);
269 * Load/Store optimization.
271 * Removes redundant non-volatile Loads and Stores.
272 * May introduce Bad nodes if exceptional control flow
273 * is removed. The following cases are optimized:
275 * Load without result: A Load which has only a memory use
278 * Load after Store: A Load after a Store is removed, if
279 * the Load doesn't have an exception handler OR is in
280 * the same block as the Store.
282 * Load after Load: A Load after a Load is removed, if the
283 * Load doesn't have an exception handler OR is in the
284 * same block as the previous Load.
286 * Store before Store: A Store immediately before another
287 * Store in the same block is removed, if the Store doesn't
288 * have an exception handler.
290 * Store after Load: A Store after a Load is removed, if the
291 * Store doesn't have an exception handler.
293 * @return non-zero if the optimization could be applied, 0 else
295 FIRM_API int optimize_load_store(ir_graph *irg);
298 * Creates an ir_graph pass for optimize_load_store().
300 * @param name the name of this pass or NULL
302 * @return the newly created ir_graph pass
304 FIRM_API ir_graph_pass_t *optimize_load_store_pass(const char *name);
307 * New experimental alternative to optimize_load_store.
308 * Based on a dataflow analysis, so load/stores are moved out of loops
311 FIRM_API int opt_ldst(ir_graph *irg);
314 * Creates an ir_graph pass for opt_ldst().
316 * @param name the name of this pass or NULL
318 * @return the newly created ir_graph pass
320 FIRM_API ir_graph_pass_t *opt_ldst_pass(const char *name);
323 * Optimize loops by peeling or unrolling them if beneficial.
325 * @param irg The graph whose loops will be processed
327 * This function did not change the graph, only its frame type.
328 * The layout state of the frame type will be set to layout_undefined
329 * if entities were removed.
331 FIRM_API void loop_optimization(ir_graph *irg);
334 * Optimize the frame type of an irg by removing
335 * never touched entities.
337 * @param irg The graph whose frame type will be optimized
339 * This function did not change the graph, only its frame type.
340 * The layout state of the frame type will be set to layout_undefined
341 * if entities were removed.
343 FIRM_API void opt_frame_irg(ir_graph *irg);
346 * Creates an ir_graph pass for opt_frame_irg().
348 * @param name the name of this pass or NULL
350 * @return the newly created ir_graph pass
352 FIRM_API ir_graph_pass_t *opt_frame_irg_pass(const char *name);
354 /** Possible flags for the Operator Scalar Replacement. */
355 typedef enum osr_flags {
356 osr_flag_none = 0, /**< no additional flags */
357 osr_flag_lftr_with_ov_check = 1, /**< do linear function test replacement
358 only if no overflow can occur. */
359 osr_flag_ignore_x86_shift = 2, /**< ignore Multiplications by 2, 4, 8 */
360 osr_flag_keep_reg_pressure = 4 /**< do NOT increase register pressure by introducing new
361 induction variables. */
364 /* FirmJNI cannot handle identical enum values... */
366 /** default setting */
367 #define osr_flag_default osr_flag_lftr_with_ov_check
370 * Do the Operator Scalar Replacement optimization and linear
371 * function test replacement for loop control.
372 * Can be switched off using the set_opt_strength_red() flag.
373 * In that case, only remove_phi_cycles() is executed.
375 * @param irg the graph which should be optimized
376 * @param flags set of osr_flags
378 * The linear function replacement test is controlled by the flags.
379 * If the osr_flag_lftr_with_ov_check is set, the replacement is only
380 * done if do overflow can occur.
381 * Otherwise it is ALWAYS done which might be insecure.
385 * for (i = 0; i < 100; ++i)
387 * might be replaced by
389 * for (i = 0; i < 400; i += 4)
393 * for (i = 0; i < 0x7FFFFFFF; ++i)
395 * will not be replaced by
397 * for (i = 0; i < 0xFFFFFFFC; i += 4)
399 * because of overflow.
403 * for (i = 0; i <= 0xF; ++i)
405 * will NOT be transformed into
407 * for (i = 0xFFFFFFF0; i <= 0xFFFFFFFF; ++i)
409 * although here is no direct overflow. The OV occurs when the ++i
410 * is executed (and would created an endless loop here!).
412 * For the same reason, a loop
414 * for (i = 0; i <= 9; i += x)
416 * will NOT be transformed because we cannot estimate whether an overflow
417 * might happen adding x.
419 * Note that i < a + 400 is also not possible with the current implementation
420 * although this might be allowed by other compilers...
422 * Note further that tests for equality can be handled some simpler (but are not
425 * This algorithm destroys the link field of nodes.
427 FIRM_API void opt_osr(ir_graph *irg, unsigned flags);
430 * Creates an ir_graph pass for remove_phi_cycles().
432 * @param name the name of this pass or NULL
433 * @param flags set of osr_flags
435 * @return the newly created ir_graph pass
437 FIRM_API ir_graph_pass_t *opt_osr_pass(const char *name, unsigned flags);
440 * Removes useless Phi cycles, i.e cycles of Phi nodes with only one
442 * This is automatically done in opt_osr(), so there is no need to call it
445 * @param irg the graph which should be optimized
447 * This algorithm destroys the link field of nodes.
449 FIRM_API void remove_phi_cycles(ir_graph *irg);
452 * Creates an ir_graph pass for remove_phi_cycles().
454 * @param name the name of this pass or NULL
456 * @return the newly created ir_graph pass
458 FIRM_API ir_graph_pass_t *remove_phi_cycles_pass(const char *name);
461 /** A default threshold. */
462 #define DEFAULT_CLONE_THRESHOLD 20
465 * Do procedure cloning. Evaluate a heuristic weight for every
466 * Call(..., Const, ...). If the weight is bigger than threshold,
467 * clone the entity and fix the calls.
469 * @param threshold the threshold for cloning
471 * The threshold is an estimation of how many instructions are saved
472 * when executing a cloned method. If threshold is 0.0, every possible
475 FIRM_API void proc_cloning(float threshold);
478 * Creates an ir_prog pass for proc_cloning().
480 * @param name the name of this pass or NULL
481 * @param threshold the threshold for cloning
483 * @return the newly created ir_prog pass
485 FIRM_API ir_prog_pass_t *proc_cloning_pass(const char *name, float threshold);
490 * Applies Reassociation rules to integer expressions.
491 * Beware: Works only if integer overflow might be ignored, as for C, Java
492 * and for address expression.
493 * Works only if Constant folding is activated.
495 * Uses loop information to detect loop-invariant (i.e. contant
496 * inside the loop) values.
498 * See Muchnik 12.3.1 Algebraic Simplification and Reassociation of
499 * Addressing Expressions.
501 * @return non-zero if the optimization could be applied, 0 else
503 FIRM_API int optimize_reassociation(ir_graph *irg);
506 * Creates an ir_graph pass for optimize_reassociation().
508 * @param name the name of this pass or NULL
510 * @return the newly created ir_graph pass
512 FIRM_API ir_graph_pass_t *optimize_reassociation_pass(const char *name);
515 * Normalize the Returns of a graph by creating a new End block
516 * with One Return(Phi).
517 * This is the preferred input for the if-conversion.
519 * In pseudocode, it means:
526 * is transformed into
534 FIRM_API void normalize_one_return(ir_graph *irg);
537 * Creates an ir_graph pass for normalize_one_return().
539 * @param name the name of this pass or NULL
541 * @return the newly created ir_graph pass
543 FIRM_API ir_graph_pass_t *normalize_one_return_pass(const char *name);
546 * Normalize the Returns of a graph by moving
547 * the Returns upwards as much as possible.
548 * This might be preferred for code generation.
550 * In pseudocode, it means:
558 * is transformed into
565 FIRM_API void normalize_n_returns(ir_graph *irg);
568 * Creates an ir_graph pass for normalize_n_returns().
570 * @param name the name of this pass or NULL
572 * @return the newly created ir_graph pass
574 FIRM_API ir_graph_pass_t *normalize_n_returns_pass(const char *name);
577 * Do the scalar replacement optimization.
578 * Replace local compound entities (like structures and arrays)
579 * with atomic values if possible. Does not handle classes yet.
581 * @param irg the graph which should be optimized
583 * @return non-zero, if at least one entity was replaced
585 FIRM_API int scalar_replacement_opt(ir_graph *irg);
588 * Creates an ir_graph pass for scalar_replacement_opt().
590 * @param name the name of this pass or NULL
592 * @return the newly created ir_graph pass
594 FIRM_API ir_graph_pass_t *scalar_replacement_opt_pass(const char *name);
597 * Optimizes tail-recursion calls by converting them into loops.
598 * Depends on the flag opt_tail_recursion.
599 * Currently supports the following forms:
601 * - return x + func();
602 * - return func() - x;
603 * - return x * func();
606 * Does not work for Calls that use the exception stuff.
608 * @param irg the graph to be optimized
610 * @return non-zero if the optimization could be applied, 0 else
612 FIRM_API int opt_tail_rec_irg(ir_graph *irg);
615 * Creates an ir_graph pass for opt_tail_rec_irg().
617 * @param name the name of this pass or NULL
619 * @return the newly created ir_graph pass
621 FIRM_API ir_graph_pass_t *opt_tail_rec_irg_pass(const char *name);
624 * Optimize tail-recursion calls for all IR-Graphs.
625 * Can currently handle:
626 * - direct return value, i.e. return func().
627 * - additive return value, i.e. return x +/- func()
628 * - multiplicative return value, i.e. return x * func() or return -func()
630 * The current implementation must be run before optimize_funccalls(),
631 * because it expects the memory edges pointing to calls, which might be
632 * removed by optimize_funccalls().
634 FIRM_API void opt_tail_recursion(void);
637 * Creates an ir_prog pass for opt_tail_recursion().
639 * @param name the name of this pass or NULL
641 * @return the newly created ir_prog pass
643 FIRM_API ir_prog_pass_t *opt_tail_recursion_pass(const char *name);
645 /** This is the type for a method, that returns a pointer type to
646 * tp. This is needed in the normalization. */
647 typedef ir_type *(*gen_pointer_type_to_func)(ir_type *tp);
649 /** Insert Casts so that class type casts conform exactly with the type hierarchy.
651 * Formulated in Java, this achieves the following:
653 * For a class hierarchy
655 * class B extends A {}
656 * class C extends B {}
657 * we transforms a cast
662 * The algorithm works for Casts with class types, but also for Casts
663 * with all pointer types that point (over several indirections,
664 * i.e. ***A) to a class type. Normalizes all graphs. Computes type
665 * information (@see irtypeinfo.h) if not available.
666 * Invalidates trout information as new casts are generated.
668 * @param gppt_fct A function that returns a pointer type that points
669 * to the type given as argument. If this parameter is NULL, a default
670 * function is used that either uses trout information or performs a O(n)
671 * search to find an existing pointer type. If it can not find a type,
672 * generates a pointer type with mode_P_mach and suffix "cc_ptr_tp".
674 FIRM_API void normalize_irp_class_casts(gen_pointer_type_to_func gppt_fct);
676 /** Insert Casts so that class type casts conform exactly with the type hierarchy
679 * For more details see normalize_irp_class_casts().
681 * This transformation requires that type information is computed. @see irtypeinfo.h.
683 FIRM_API void normalize_irg_class_casts(ir_graph *irg,
684 gen_pointer_type_to_func gppt_fct);
686 /** Optimize casting between class types.
689 * class B extends A { }
690 * class C extends B {}
691 * Performs the following transformations:
692 * C c = (C)(B)(A)(B)new C() --> C c = (C)(B)newC() --> C c = new C()
693 * (Optimizing downcasts as A a = (A)(B)(new A()) --> A a = new A() can
694 * be suppressed by setting the flag opt_suppress_downcast_optimization.
695 * Downcasting A to B might cause an exception. It is not clear
696 * whether this is modeled by the Firm Cast node, as it has no exception
698 * If there is inh_m() that overwrites m() in B:
699 * ((A) new B()).m() --> (new B()).inh_m()
700 * Phi((A)x, (A)y) --> (A) Phi (x, y) if (A) is an upcast.
702 * Computes type information if not available. @see irtypeinfo.h.
703 * Typeinformation is valid after optimization.
704 * Invalidates trout information.
706 FIRM_API void optimize_class_casts(void);
709 * CLiff Click's combo algorithm from
710 * "Combining Analyses, combining Optimizations".
712 * Does conditional constant propagation, unreachable code elimination and
713 * optimistic global value numbering at once.
715 * @param irg the graph to run on
717 FIRM_API void combo(ir_graph *irg);
720 * Creates an ir_graph pass for combo.
722 * @param name the name of this pass or NULL
724 * @return the newly created ir_graph pass
726 FIRM_API ir_graph_pass_t *combo_pass(const char *name);
729 * Inlines all small methods at call sites where the called address comes
730 * from a SymConst node that references the entity representing the called
733 * @param irg the graph
734 * @param size maximum function size
736 * The size argument is a rough measure for the code size of the method:
737 * Methods where the obstack containing the firm graph is smaller than
738 * size are inlined. Further only a limited number of calls are inlined.
739 * If the method contains more than 1024 inlineable calls none will be
741 * Inlining is only performed if flags `optimize' and `inlining' are set.
742 * The graph may not be in state phase_building.
743 * It is recommended to call local_optimize_graph() after inlining as this
744 * function leaves a set of obscure Tuple nodes, e.g. a Proj-Tuple-Jmp
745 * combination as control flow operation.
747 FIRM_API void inline_small_irgs(ir_graph *irg, int size);
750 * Creates an ir_graph pass for inline_small_irgs().
752 * @param name the name of this pass or NULL
753 * @param size maximum function size
755 * @return the newly created ir_graph pass
757 FIRM_API ir_graph_pass_t *inline_small_irgs_pass(const char *name, int size);
760 * Inlineing with a different heuristic than inline_small_irgs().
762 * Inlines leave functions. If inlining creates new leave
763 * function inlines these, too. (If g calls f, and f calls leave h,
764 * h is first inlined in f and then f in g.)
766 * Then inlines all small functions (this is not recursive).
768 * For a heuristic this inlining uses firm node counts. It does
769 * not count auxiliary nodes as Proj, Tuple, End, Start, Id, Sync.
770 * If the ignore_runtime flag is set, calls to functions marked with the
771 * mtp_property_runtime property are ignored.
773 * @param maxsize Do not inline any calls if a method has more than
774 * maxsize firm nodes. It may reach this limit by
776 * @param leavesize Inline leave functions if they have less than leavesize
778 * @param size Inline all function smaller than size.
779 * @param ignore_runtime count a function only calling runtime functions as
782 FIRM_API void inline_leave_functions(unsigned maxsize, unsigned leavesize,
783 unsigned size, int ignore_runtime);
786 * Creates an ir_prog pass for inline_leave_functions().
788 * @param name the name of this pass or NULL
789 * @param maxsize Do not inline any calls if a method has more than
790 * maxsize firm nodes. It may reach this limit by
792 * @param leavesize Inline leave functions if they have less than leavesize
794 * @param size Inline all function smaller than size.
795 * @param ignore_runtime count a function only calling runtime functions as
798 * @return the newly created ir_prog pass
800 FIRM_API ir_prog_pass_t *inline_leave_functions_pass(const char *name,
801 unsigned maxsize, unsigned leavesize, unsigned size,
804 typedef void (*opt_ptr)(ir_graph *irg);
807 * Heuristic inliner. Calculates a benefice value for every call and inlines
808 * those calls with a value higher than the threshold.
810 * @param maxsize Do not inline any calls if a method has more than
811 * maxsize firm nodes. It may reach this limit by
813 * @param inline_threshold inlining threshold
814 * @param after_inline_opt optimizations performed immediately after inlining
817 FIRM_API void inline_functions(unsigned maxsize, int inline_threshold,
818 opt_ptr after_inline_opt);
821 * Creates an ir_prog pass for inline_functions().
823 * @param name the name of this pass or NULL
824 * @param maxsize Do not inline any calls if a method has more than
825 * maxsize firm nodes. It may reach this limit by
827 * @param inline_threshold inlining threshold
828 * @param after_inline_opt a function that is called after inlining a
829 * procedure. You should run fast local optimisations
830 * here which cleanup the graph before further
833 * @return the newly created ir_prog pass
835 FIRM_API ir_prog_pass_t *inline_functions_pass(const char *name,
836 unsigned maxsize, int inline_threshold, opt_ptr after_inline_opt);
839 * Combines congruent blocks into one.
841 * @param irg The IR-graph to optimize.
843 * @return non-zero if the graph was transformed
845 FIRM_API int shape_blocks(ir_graph *irg);
848 * Creates an ir_graph pass for shape_blocks().
850 * @param name the name of this pass or NULL
852 * @return the newly created ir_graph pass
854 FIRM_API ir_graph_pass_t *shape_blocks_pass(const char *name);
857 * Perform loop inversion on a given graph.
858 * Loop inversion transforms a head controlled loop (like while(...) {} and
859 * for(...) {}) into a foot controlled loop (do {} while(...)).
861 FIRM_API void do_loop_inversion(ir_graph *irg);
864 * Perform loop unrolling on a given graph.
865 * Loop unrolling multiplies the number loop completely by a number found
866 * through a heuristic.
868 FIRM_API void do_loop_unrolling(ir_graph *irg);
871 * Perform loop peeling on a given graph.
873 FIRM_API void do_loop_peeling(ir_graph *irg);
876 * Creates an ir_graph pass for loop inversion.
878 * @param name the name of this pass or NULL
880 * @return the newly created ir_graph pass
882 FIRM_API ir_graph_pass_t *loop_inversion_pass(const char *name);
885 * Creates an ir_graph pass for loop unrolling.
887 * @param name the name of this pass or NULL
889 * @return the newly created ir_graph pass
891 FIRM_API ir_graph_pass_t *loop_unroll_pass(const char *name);
894 * Creates an ir_graph pass for loop peeling.
896 * @param name the name of this pass or NULL
898 * @return the newly created ir_graph pass
900 FIRM_API ir_graph_pass_t *loop_peeling_pass(const char *name);
902 typedef ir_type *(*get_Alloc_func)(ir_node *n);
903 /** Set a new get_Alloc_func and returns the old one. */
904 FIRM_API get_Alloc_func firm_set_Alloc_func(get_Alloc_func newf);
907 * Creates an ir_graph pass for set_vrp_data()
909 * @param name The name of this pass or NULL
911 * @return the newly created ir_graph pass
913 FIRM_API ir_graph_pass_t *set_vrp_pass(const char *name);
916 * Removes all entities which are unused.
918 * Unused entities have ir_visibility_local and are not used directly or
919 * indirectly through entities/code visible outside the compilation unit.
920 * This is usually conservative than gc_irgs, but does not respect properties
921 * of object-oriented programs.
923 FIRM_API void garbage_collect_entities(void);
925 /** Pass for garbage_collect_entities */
926 FIRM_API ir_prog_pass_t *garbage_collect_entities_pass(const char *name);
929 * Performs dead node elimination by copying the ir graph to a new obstack.
931 * The major intention of this pass is to free memory occupied by
932 * dead nodes and outdated analyzes information. Further this
933 * function removes Bad predecessors from Blocks and the corresponding
934 * inputs to Phi nodes. This opens optimization potential for other
935 * optimizations. Further this phase reduces dead Block<->Jmp
936 * self-cycles to Bad nodes.
938 * Dead_node_elimination is only performed if options `optimize' and
939 * `opt_dead_node_elimination' are set. The graph may
940 * not be in state phase_building. The outs datastructure is freed,
941 * the outs state set to outs_none. Backedge information is conserved.
942 * Removes old attributes of nodes. Sets link field to NULL.
943 * Callee information must be freed (irg_callee_info_none).
945 * @param irg The graph to be optimized.
947 FIRM_API void dead_node_elimination(ir_graph *irg);
950 * Creates an ir_graph pass for dead_node_elimination().
952 * @param name the name of this pass or NULL
954 * @return the newly created ir_graph pass
956 FIRM_API ir_graph_pass_t *dead_node_elimination_pass(const char *name);
959 * Inlines a method at the given call site.
961 * Removes the call node and splits the basic block the call node
962 * belongs to. Inserts a copy of the called graph between these nodes.
963 * Assumes that call is a Call node in current_ir_graph and that
964 * the type in the Call nodes type attribute is the same as the
965 * type of the called graph.
966 * Further it assumes that all Phi nodes in a block of current_ir_graph
967 * are assembled in a "link" list in the link field of the corresponding
968 * block nodes. Further assumes that all Proj nodes are in a "link" list
969 * in the nodes producing the tuple. (This is only an optical feature
970 * for the graph.) Conserves this feature for the old
971 * nodes of the graph. This precondition can be established by a call to
972 * collect_phisprojs(), see irgmod.h.
973 * As dead_node_elimination this function reduces dead Block<->Jmp
974 * self-cycles to Bad nodes.
976 * Called_graph must be unequal to current_ir_graph. Will not inline
978 * Sets visited masterflag in current_ir_graph to the max of the flag in
979 * current and called graph.
980 * Assumes that both, the called and the calling graph are in state
981 * "op_pin_state_pinned".
982 * It is recommended to call local_optimize_graph() after inlining as this
983 * function leaves a set of obscure Tuple nodes, e.g. a Proj-Tuple-Jmp
984 * combination as control flow operation.
986 * @param call the call node that should be inlined
987 * @param called_graph the IR-graph that is called at call
989 * @return zero if method could not be inlined (recursion for instance),
990 * non-zero if all went ok
992 FIRM_API int inline_method(ir_node *call, ir_graph *called_graph);
997 * Pins all floating nodes to a block where they
998 * will be executed only if needed. Depends on the flag opt_global_cse.
999 * Graph may not be in phase_building. Does not schedule control dead
1000 * code. Uses dominator information which it computes if the irg is not
1001 * in state dom_consistent. Destroys the out information as it moves nodes
1002 * to other blocks. Optimizes Tuples in Control edges.
1004 * Call remove_critical_cf_edges() before place_code(). This normalizes
1005 * the control flow graph so that for all operations a basic block exists
1006 * where they can be optimally placed.
1008 FIRM_API void place_code(ir_graph *irg);
1011 * Creates an ir_graph pass for place_code().
1012 * This pass enables GCSE, runs optimize_graph_df() and finally
1015 * @param name the name of this pass or NULL
1017 * @return the newly created ir_graph pass
1019 FIRM_API ir_graph_pass_t *place_code_pass(const char *name);
1022 * Determine information about the values of nodes and perform simplifications
1023 * using this information. This optimization performs a data-flow analysis to
1024 * find the minimal fixpoint.
1026 FIRM_API void fixpoint_vrp(ir_graph*);
1029 * Creates an ir_graph pass for fixpoint_vrp().
1030 * This pass dDetermines information about the values of nodes
1031 * and perform simplifications using this information.
1032 * This optimization performs a data-flow analysis to
1033 * find the minimal fixpoint.
1035 * @param name the name of this pass or NULL
1037 * @return the newly created ir_graph pass
1039 FIRM_API ir_graph_pass_t *fixpoint_vrp_irg_pass(const char *name);
1042 * Check, if the value of a node is != 0.
1044 * This is a often needed case, so we handle here Confirm
1047 * @param n a node representing the value
1048 * @param confirm if n is confirmed to be != 0, returns
1049 * the the Confirm-node, else NULL
1051 FIRM_API int value_not_zero(const ir_node *n, ir_node_cnst_ptr *confirm);
1054 * Check, if the value of a node cannot represent a NULL pointer.
1056 * - If option sel_based_null_check_elim is enabled, all
1057 * Sel nodes can be skipped.
1058 * - A SymConst(entity) is NEVER a NULL pointer
1059 * - A Const != NULL is NEVER a NULL pointer
1060 * - Confirms are evaluated
1062 * @param n a node representing the value
1063 * @param confirm if n is confirmed to be != NULL, returns
1064 * the the Confirm-node, else NULL
1066 FIRM_API int value_not_null(const ir_node *n, ir_node_cnst_ptr *confirm);
1069 * Check, if the value of a node can be confirmed >= 0 or <= 0,
1070 * If the mode of the value did not honor signed zeros, else
1071 * check for >= 0 or < 0.
1073 * @param n a node representing the value
1075 FIRM_API ir_value_classify_sign classify_value_sign(ir_node *n);
1078 * Return the value of a Cmp if one or both predecessors
1079 * are Confirm nodes.
1081 * @param cmp the compare node that will be evaluated
1082 * @param left the left operand of the Cmp
1083 * @param right the right operand of the Cmp
1084 * @param relation the compare relation
1086 FIRM_API ir_tarval *computed_value_Cmp_Confirm(
1087 const ir_node *cmp, ir_node *left, ir_node *right, ir_relation relation);
1089 typedef ir_entity *(*compilerlib_entity_creator_t)(ident *id, ir_type *mt);
1091 * Set the compilerlib entity creation callback that is used to create
1092 * compilerlib function entities.
1094 * @param cb the new compilerlib entity creation callback
1096 FIRM_API void set_compilerlib_entity_creator(compilerlib_entity_creator_t cb);
1099 * Get the compilerlib entity creation callback.
1101 FIRM_API compilerlib_entity_creator_t get_compilerlib_entity_creator(void);
1104 * Construct the entity for a given function using the current compilerlib
1105 * entity creation callback.
1107 * @param id the identifier of the compilerlib function
1108 * @param mt the method type of the compilerlib function
1110 FIRM_API ir_entity *create_compilerlib_entity(ident *id, ir_type *mt);