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 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 * Simplifies 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 * Reduces 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 * Performs 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 * Performs 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 * @return the newly created ir_prog pass
180 FIRM_API ir_prog_pass_t *optimize_funccalls_pass(const char *name);
183 * Does Partial Redundancy Elimination combined with
184 * Global Value Numbering.
185 * Can be used to replace place_code() completely.
187 * Based on VanDrunen and Hosking 2004.
189 * @param irg the graph
191 FIRM_API void do_gvn_pre(ir_graph *irg);
194 * Creates an ir_graph pass for do_gvn_pre().
196 * @param name the name of this pass or NULL
198 * @return the newly created ir_graph pass
200 FIRM_API ir_graph_pass_t *do_gvn_pre_pass(const char *name);
203 * This function is called to evaluate, if a
204 * mux(@p sel, @p mux_false, @p mux_true) should be built for the current
206 * If it returns non-zero, a mux is created, else the code
208 * @param sel A selector of a Cond.
209 * @param phi_list phi node to be converted
210 * @param i First data predecessor involved in if conversion
211 * @param j Second data predecessor involved in if conversion
213 typedef int (*arch_allow_ifconv_func)(ir_node *sel, ir_node *mux_false,
217 * Perform If conversion on a graph.
219 * @param irg The graph.
221 * Cannot handle blocks with Bad control predecessors, so call it after control
224 FIRM_API void opt_if_conv(ir_graph *irg);
227 * Creates an ir_graph pass for opt_if_conv().
229 * @param name the name of this pass or NULL
231 * @return the newly created ir_graph pass
233 FIRM_API ir_graph_pass_t *opt_if_conv_pass(const char *name);
236 * Tries to reduce dependencies for memory nodes where possible by parallelizing
237 * them and synchronizing with Sync nodes
238 * @param irg the graph where memory operations should be parallelized
240 FIRM_API void opt_parallelize_mem(ir_graph *irg);
243 * Creates an ir_graph pass for opt_sync().
245 * @param name the name of this pass or NULL
247 * @return the newly created ir_graph pass
249 FIRM_API ir_graph_pass_t *opt_parallelize_mem_pass(const char *name);
252 * Check if we can replace the load by a given const from
253 * the const code irg.
255 * @param load the load to replace
256 * @param c the constant
258 * @return in the modes match or can be transformed using a reinterpret cast
259 * returns a copy of the constant (possibly Conv'ed) on the
262 FIRM_API ir_node *can_replace_load_by_const(const ir_node *load, ir_node *c);
265 * Load/Store optimization.
267 * Removes redundant non-volatile Loads and Stores.
268 * May introduce Bad nodes if exceptional control flow
269 * is removed. The following cases are optimized:
271 * Load without result: A Load which has only a memory use
274 * Load after Store: A Load after a Store is removed, if
275 * the Load doesn't have an exception handler OR is in
276 * the same block as the Store.
278 * Load after Load: A Load after a Load is removed, if the
279 * Load doesn't have an exception handler OR is in the
280 * same block as the previous Load.
282 * Store before Store: A Store immediately before another
283 * Store in the same block is removed, if the Store doesn't
284 * have an exception handler.
286 * Store after Load: A Store after a Load is removed, if the
287 * Store doesn't have an exception handler.
289 * @return non-zero if the optimization could be applied, 0 else
291 FIRM_API int optimize_load_store(ir_graph *irg);
294 * Creates an ir_graph pass for optimize_load_store().
296 * @param name the name of this pass or NULL
298 * @return the newly created ir_graph pass
300 FIRM_API ir_graph_pass_t *optimize_load_store_pass(const char *name);
303 * New experimental alternative to optimize_load_store.
304 * Based on a dataflow analysis, so load/stores are moved out of loops
307 FIRM_API int opt_ldst(ir_graph *irg);
310 * Creates an ir_graph pass for opt_ldst().
312 * @param name the name of this pass or NULL
314 * @return the newly created ir_graph pass
316 FIRM_API ir_graph_pass_t *opt_ldst_pass(const char *name);
319 * Optimize loops by peeling or unrolling them if beneficial.
321 * @param irg The graph whose loops will be processed
323 * This function did not change the graph, only its frame type.
324 * The layout state of the frame type will be set to layout_undefined
325 * if entities were removed.
327 FIRM_API void loop_optimization(ir_graph *irg);
330 * Optimize the frame type of an irg by removing
331 * never touched entities.
333 * @param irg The graph whose frame type will be optimized
335 * This function did not change the graph, only its frame type.
336 * The layout state of the frame type will be set to layout_undefined
337 * if entities were removed.
339 FIRM_API void opt_frame_irg(ir_graph *irg);
342 * Creates an ir_graph pass for opt_frame_irg().
344 * @param name the name of this pass or NULL
346 * @return the newly created ir_graph pass
348 FIRM_API ir_graph_pass_t *opt_frame_irg_pass(const char *name);
350 /** Possible flags for the Operator Scalar Replacement. */
351 typedef enum osr_flags {
352 osr_flag_none = 0, /**< no additional flags */
353 osr_flag_lftr_with_ov_check = 1, /**< do linear function test replacement
354 only if no overflow can occur. */
355 osr_flag_ignore_x86_shift = 2, /**< ignore Multiplications by 2, 4, 8 */
356 osr_flag_keep_reg_pressure = 4 /**< do NOT increase register pressure by introducing new
357 induction variables. */
360 /** default setting */
361 #define osr_flag_default osr_flag_lftr_with_ov_check
364 * Performs the Operator Scalar Replacement optimization and linear
365 * function test replacement for loop control.
366 * Can be switched off using the set_opt_strength_red() flag.
367 * In that case, only remove_phi_cycles() is executed.
369 * @param irg the graph which should be optimized
370 * @param flags set of osr_flags
372 * The linear function replacement test is controlled by the flags.
373 * If the osr_flag_lftr_with_ov_check is set, the replacement is only
374 * done if do overflow can occur.
375 * Otherwise it is ALWAYS done which might be insecure.
379 * for (i = 0; i < 100; ++i)
381 * might be replaced by
383 * for (i = 0; i < 400; i += 4)
387 * for (i = 0; i < 0x7FFFFFFF; ++i)
389 * will not be replaced by
391 * for (i = 0; i < 0xFFFFFFFC; i += 4)
393 * because of overflow.
397 * for (i = 0; i <= 0xF; ++i)
399 * will NOT be transformed into
401 * for (i = 0xFFFFFFF0; i <= 0xFFFFFFFF; ++i)
403 * although here is no direct overflow. The OV occurs when the ++i
404 * is executed (and would created an endless loop here!).
406 * For the same reason, a loop
408 * for (i = 0; i <= 9; i += x)
410 * will NOT be transformed because we cannot estimate whether an overflow
411 * might happen adding x.
413 * Note that i < a + 400 is also not possible with the current implementation
414 * although this might be allowed by other compilers...
416 * Note further that tests for equality can be handled some simpler (but are not
419 * This algorithm destroys the link field of nodes.
421 FIRM_API void opt_osr(ir_graph *irg, unsigned flags);
424 * Creates an ir_graph pass for remove_phi_cycles().
426 * @param name the name of this pass or NULL
427 * @param flags set of osr_flags
429 * @return the newly created ir_graph pass
431 FIRM_API ir_graph_pass_t *opt_osr_pass(const char *name, unsigned flags);
434 * Removes useless Phi cycles, i.e cycles of Phi nodes with only one
436 * This is automatically done in opt_osr(), so there is no need to call it
439 * @param irg the graph which should be optimized
441 * This algorithm destroys the link field of nodes.
443 FIRM_API void remove_phi_cycles(ir_graph *irg);
446 * Creates an ir_graph pass for remove_phi_cycles().
448 * @param name the name of this pass or NULL
450 * @return the newly created ir_graph pass
452 FIRM_API ir_graph_pass_t *remove_phi_cycles_pass(const char *name);
455 /** A default threshold. */
456 #define DEFAULT_CLONE_THRESHOLD 20
459 * Performs procedure cloning. Evaluate a heuristic weight for every
460 * Call(..., Const, ...). If the weight is bigger than threshold,
461 * clone the entity and fix the calls.
463 * @param threshold the threshold for cloning
465 * The threshold is an estimation of how many instructions are saved
466 * when executing a cloned method. If threshold is 0.0, every possible
469 FIRM_API void proc_cloning(float threshold);
472 * Creates an ir_prog pass for proc_cloning().
474 * @param name the name of this pass or NULL
475 * @param threshold the threshold for cloning
477 * @return the newly created ir_prog pass
479 FIRM_API ir_prog_pass_t *proc_cloning_pass(const char *name, float threshold);
484 * Applies Reassociation rules to integer expressions.
485 * Beware: Works only if integer overflow might be ignored, as for C, Java
486 * and for address expression.
487 * Works only if Constant folding is activated.
489 * Uses loop information to detect loop-invariant (i.e. contant
490 * inside the loop) values.
492 * See Muchnik 12.3.1 Algebraic Simplification and Reassociation of
493 * Addressing Expressions.
495 * @return non-zero if the optimization could be applied, 0 else
497 FIRM_API int optimize_reassociation(ir_graph *irg);
500 * Creates an ir_graph pass for optimize_reassociation().
502 * @param name the name of this pass or NULL
504 * @return the newly created ir_graph pass
506 FIRM_API ir_graph_pass_t *optimize_reassociation_pass(const char *name);
509 * Normalize the Returns of a graph by creating a new End block
510 * with One Return(Phi).
511 * This is the preferred input for the if-conversion.
513 * In pseudocode, it means:
520 * is transformed into
528 FIRM_API void normalize_one_return(ir_graph *irg);
531 * Creates an ir_graph pass for normalize_one_return().
533 * @param name the name of this pass or NULL
535 * @return the newly created ir_graph pass
537 FIRM_API ir_graph_pass_t *normalize_one_return_pass(const char *name);
540 * Normalize the Returns of a graph by moving
541 * the Returns upwards as much as possible.
542 * This might be preferred for code generation.
544 * In pseudocode, it means:
552 * is transformed into
559 FIRM_API void normalize_n_returns(ir_graph *irg);
562 * Creates an ir_graph pass for normalize_n_returns().
564 * @param name the name of this pass or NULL
566 * @return the newly created ir_graph pass
568 FIRM_API ir_graph_pass_t *normalize_n_returns_pass(const char *name);
571 * Performs the scalar replacement optimization.
572 * Replaces local compound entities (like structures and arrays)
573 * with atomic values if possible. Does not handle classes yet.
575 * @param irg the graph which should be optimized
577 * @return non-zero, if at least one entity was replaced
579 FIRM_API int scalar_replacement_opt(ir_graph *irg);
582 * Creates an ir_graph pass for scalar_replacement_opt().
584 * @param name the name of this pass or NULL
586 * @return the newly created ir_graph pass
588 FIRM_API ir_graph_pass_t *scalar_replacement_opt_pass(const char *name);
591 * Optimizes tail-recursion calls by converting them into loops.
592 * Depends on the flag opt_tail_recursion.
593 * Currently supports the following forms:
595 * - return x + func();
596 * - return func() - x;
597 * - return x * func();
600 * Does not work for Calls that use the exception stuff.
602 * @param irg the graph to be optimized
604 * @return non-zero if the optimization could be applied, 0 else
606 FIRM_API int opt_tail_rec_irg(ir_graph *irg);
609 * Creates an ir_graph pass for opt_tail_rec_irg().
611 * @param name the name of this pass or NULL
613 * @return the newly created ir_graph pass
615 FIRM_API ir_graph_pass_t *opt_tail_rec_irg_pass(const char *name);
618 * Optimize tail-recursion calls for all IR-Graphs.
619 * Can currently handle:
620 * - direct return value, i.e. return func().
621 * - additive return value, i.e. return x +/- func()
622 * - multiplicative return value, i.e. return x * func() or return -func()
624 * The current implementation must be run before optimize_funccalls(),
625 * because it expects the memory edges pointing to calls, which might be
626 * removed by optimize_funccalls().
628 FIRM_API void opt_tail_recursion(void);
631 * Creates an ir_prog pass for opt_tail_recursion().
633 * @param name the name of this pass or NULL
635 * @return the newly created ir_prog pass
637 FIRM_API ir_prog_pass_t *opt_tail_recursion_pass(const char *name);
639 /** This is the type for a method, that returns a pointer type to
640 * tp. This is needed in the normalization. */
641 typedef ir_type *(*gen_pointer_type_to_func)(ir_type *tp);
643 /** Insert Casts so that class type casts conform exactly with the type hierarchy.
645 * Formulated in Java, this achieves the following:
647 * For a class hierarchy
649 * class B extends A {}
650 * class C extends B {}
651 * we transforms a cast
656 * The algorithm works for Casts with class types, but also for Casts
657 * with all pointer types that point (over several indirections,
658 * i.e. ***A) to a class type. Normalizes all graphs. Computes type
659 * information (@see irtypeinfo.h) if not available.
660 * Invalidates trout information as new casts are generated.
662 * @param gppt_fct A function that returns a pointer type that points
663 * to the type given as argument. If this parameter is NULL, a default
664 * function is used that either uses trout information or performs a O(n)
665 * search to find an existing pointer type. If it can not find a type,
666 * generates a pointer type with mode_P_mach and suffix "cc_ptr_tp".
668 FIRM_API void normalize_irp_class_casts(gen_pointer_type_to_func gppt_fct);
670 /** Insert Casts so that class type casts conform exactly with the type hierarchy
673 * For more details see normalize_irp_class_casts().
675 * This transformation requires that type information is computed. @see irtypeinfo.h.
677 FIRM_API void normalize_irg_class_casts(ir_graph *irg,
678 gen_pointer_type_to_func gppt_fct);
680 /** Optimize casting between class types.
683 * class B extends A { }
684 * class C extends B {}
685 * Performs the following transformations:
686 * C c = (C)(B)(A)(B)new C() --> C c = (C)(B)newC() --> C c = new C()
687 * (Optimizing downcasts as A a = (A)(B)(new A()) --> A a = new A() can
688 * be suppressed by setting the flag opt_suppress_downcast_optimization.
689 * Downcasting A to B might cause an exception. It is not clear
690 * whether this is modeled by the Firm Cast node, as it has no exception
692 * If there is inh_m() that overwrites m() in B:
693 * ((A) new B()).m() --> (new B()).inh_m()
694 * Phi((A)x, (A)y) --> (A) Phi (x, y) if (A) is an upcast.
696 * Computes type information if not available. @see irtypeinfo.h.
697 * Typeinformation is valid after optimization.
698 * Invalidates trout information.
700 FIRM_API void optimize_class_casts(void);
703 * CLiff Click's combo algorithm from
704 * "Combining Analyses, combining Optimizations".
706 * Does conditional constant propagation, unreachable code elimination and
707 * optimistic global value numbering at once.
709 * @param irg the graph to run on
711 FIRM_API void combo(ir_graph *irg);
714 * Creates an ir_graph pass for combo.
716 * @param name the name of this pass or NULL
718 * @return the newly created ir_graph pass
720 FIRM_API ir_graph_pass_t *combo_pass(const char *name);
723 * Inlines all small methods at call sites where the called address comes
724 * from a SymConst node that references the entity representing the called
727 * @param irg the graph
728 * @param size maximum function size
730 * The size argument is a rough measure for the code size of the method:
731 * Methods where the obstack containing the firm graph is smaller than
732 * size are inlined. Further only a limited number of calls are inlined.
733 * If the method contains more than 1024 inlineable calls none will be
735 * Inlining is only performed if flags `optimize' and `inlining' are set.
736 * The graph may not be in state phase_building.
737 * It is recommended to call local_optimize_graph() after inlining as this
738 * function leaves a set of obscure Tuple nodes, e.g. a Proj-Tuple-Jmp
739 * combination as control flow operation.
741 FIRM_API void inline_small_irgs(ir_graph *irg, int size);
744 * Creates an ir_graph pass for inline_small_irgs().
746 * @param name the name of this pass or NULL
747 * @param size maximum function size
749 * @return the newly created ir_graph pass
751 FIRM_API ir_graph_pass_t *inline_small_irgs_pass(const char *name, int size);
754 * Inlineing with a different heuristic than inline_small_irgs().
756 * Inlines leave functions. If inlining creates new leave
757 * function inlines these, too. (If g calls f, and f calls leave h,
758 * h is first inlined in f and then f in g.)
760 * Then inlines all small functions (this is not recursive).
762 * For a heuristic this inlining uses firm node counts. It does
763 * not count auxiliary nodes as Proj, Tuple, End, Start, Id, Sync.
764 * If the ignore_runtime flag is set, calls to functions marked with the
765 * mtp_property_runtime property are ignored.
767 * @param maxsize Do not inline any calls if a method has more than
768 * maxsize firm nodes. It may reach this limit by
770 * @param leavesize Inline leave functions if they have less than leavesize
772 * @param size Inline all function smaller than size.
773 * @param ignore_runtime count a function only calling runtime functions as
776 FIRM_API void inline_leave_functions(unsigned maxsize, unsigned leavesize,
777 unsigned size, int ignore_runtime);
780 * Creates an ir_prog pass for inline_leave_functions().
782 * @param name the name of this pass or NULL
783 * @param maxsize Do not inline any calls if a method has more than
784 * maxsize firm nodes. It may reach this limit by
786 * @param leavesize Inline leave functions if they have less than leavesize
788 * @param size Inline all function smaller than size.
789 * @param ignore_runtime count a function only calling runtime functions as
792 * @return the newly created ir_prog pass
794 FIRM_API ir_prog_pass_t *inline_leave_functions_pass(const char *name,
795 unsigned maxsize, unsigned leavesize, unsigned size,
798 /** pointer to an optimization function */
799 typedef void (*opt_ptr)(ir_graph *irg);
802 * Heuristic inliner. Calculates a benefice value for every call and inlines
803 * those calls with a value higher than the threshold.
805 * @param maxsize Do not inline any calls if a method has more than
806 * maxsize firm nodes. It may reach this limit by
808 * @param inline_threshold inlining threshold
809 * @param after_inline_opt optimizations performed immediately after inlining
812 FIRM_API void inline_functions(unsigned maxsize, int inline_threshold,
813 opt_ptr after_inline_opt);
816 * Creates an ir_prog pass for inline_functions().
818 * @param name the name of this pass or NULL
819 * @param maxsize Do not inline any calls if a method has more than
820 * maxsize firm nodes. It may reach this limit by
822 * @param inline_threshold inlining threshold
823 * @param after_inline_opt a function that is called after inlining a
824 * procedure. You should run fast local optimisations
825 * here which cleanup the graph before further
828 * @return the newly created ir_prog pass
830 FIRM_API ir_prog_pass_t *inline_functions_pass(const char *name,
831 unsigned maxsize, int inline_threshold, opt_ptr after_inline_opt);
834 * Combines congruent blocks into one.
836 * @param irg The IR-graph to optimize.
838 * @return non-zero if the graph was transformed
840 FIRM_API int shape_blocks(ir_graph *irg);
843 * Creates an ir_graph pass for shape_blocks().
845 * @param name the name of this pass or NULL
847 * @return the newly created ir_graph pass
849 FIRM_API ir_graph_pass_t *shape_blocks_pass(const char *name);
852 * Perform loop inversion on a given graph.
853 * Loop inversion transforms a head controlled loop (like while(...) {} and
854 * for(...) {}) into a foot controlled loop (do {} while(...)).
856 FIRM_API void do_loop_inversion(ir_graph *irg);
859 * Perform loop unrolling on a given graph.
860 * Loop unrolling multiplies the number loop completely by a number found
861 * through a heuristic.
863 FIRM_API void do_loop_unrolling(ir_graph *irg);
866 * Perform loop peeling on a given graph.
868 FIRM_API void do_loop_peeling(ir_graph *irg);
871 * Creates an ir_graph pass for loop inversion.
873 * @param name the name of this pass or NULL
875 * @return the newly created ir_graph pass
877 FIRM_API ir_graph_pass_t *loop_inversion_pass(const char *name);
880 * Creates an ir_graph pass for loop unrolling.
882 * @param name the name of this pass or NULL
884 * @return the newly created ir_graph pass
886 FIRM_API ir_graph_pass_t *loop_unroll_pass(const char *name);
889 * Creates an ir_graph pass for loop peeling.
891 * @param name the name of this pass or NULL
893 * @return the newly created ir_graph pass
895 FIRM_API ir_graph_pass_t *loop_peeling_pass(const char *name);
898 * Creates an ir_graph pass for set_vrp_data()
900 * @param name The name of this pass or NULL
902 * @return the newly created ir_graph pass
904 FIRM_API ir_graph_pass_t *set_vrp_pass(const char *name);
907 * Removes all entities which are unused.
909 * Unused entities have ir_visibility_local and are not used directly or
910 * indirectly through entities/code visible outside the compilation unit.
911 * This is usually conservative than gc_irgs, but does not respect properties
912 * of object-oriented programs.
914 FIRM_API void garbage_collect_entities(void);
916 /** Pass for garbage_collect_entities */
917 FIRM_API ir_prog_pass_t *garbage_collect_entities_pass(const char *name);
920 * Performs dead node elimination by copying the ir graph to a new obstack.
922 * The major intention of this pass is to free memory occupied by
923 * dead nodes and outdated analyzes information. Further this
924 * function removes Bad predecessors from Blocks and the corresponding
925 * inputs to Phi nodes. This opens optimization potential for other
926 * optimizations. Further this phase reduces dead Block<->Jmp
927 * self-cycles to Bad nodes.
929 * Dead_node_elimination is only performed if options `optimize' and
930 * `opt_dead_node_elimination' are set. The graph may
931 * not be in state phase_building. The outs datastructure is freed,
932 * the outs state set to outs_none. Backedge information is conserved.
933 * Removes old attributes of nodes. Sets link field to NULL.
934 * Callee information must be freed (irg_callee_info_none).
936 * @param irg The graph to be optimized.
938 FIRM_API void dead_node_elimination(ir_graph *irg);
941 * Creates an ir_graph pass for dead_node_elimination().
943 * @param name the name of this pass or NULL
945 * @return the newly created ir_graph pass
947 FIRM_API ir_graph_pass_t *dead_node_elimination_pass(const char *name);
950 * Inlines a method at the given call site.
952 * Removes the call node and splits the basic block the call node
953 * belongs to. Inserts a copy of the called graph between these nodes.
954 * Assumes that call is a Call node in current_ir_graph and that
955 * the type in the Call nodes type attribute is the same as the
956 * type of the called graph.
957 * Further it assumes that all Phi nodes in a block of current_ir_graph
958 * are assembled in a "link" list in the link field of the corresponding
959 * block nodes. Further assumes that all Proj nodes are in a "link" list
960 * in the nodes producing the tuple. (This is only an optical feature
961 * for the graph.) Conserves this feature for the old
962 * nodes of the graph. This precondition can be established by a call to
963 * collect_phisprojs(), see irgmod.h.
964 * As dead_node_elimination this function reduces dead Block<->Jmp
965 * self-cycles to Bad nodes.
967 * Called_graph must be unequal to current_ir_graph. Will not inline
969 * Sets visited masterflag in current_ir_graph to the max of the flag in
970 * current and called graph.
971 * Assumes that both, the called and the calling graph are in state
972 * "op_pin_state_pinned".
973 * It is recommended to call local_optimize_graph() after inlining as this
974 * function leaves a set of obscure Tuple nodes, e.g. a Proj-Tuple-Jmp
975 * combination as control flow operation.
977 * @param call the call node that should be inlined
978 * @param called_graph the IR-graph that is called at call
980 * @return zero if method could not be inlined (recursion for instance),
981 * non-zero if all went ok
983 FIRM_API int inline_method(ir_node *call, ir_graph *called_graph);
988 * Pins all floating nodes to a block where they
989 * will be executed only if needed. Depends on the flag opt_global_cse.
990 * Graph may not be in phase_building. Does not schedule control dead
991 * code. Uses dominator information which it computes if the irg is not
992 * in state dom_consistent. Destroys the out information as it moves nodes
993 * to other blocks. Optimizes Tuples in Control edges.
995 * Call remove_critical_cf_edges() before place_code(). This normalizes
996 * the control flow graph so that for all operations a basic block exists
997 * where they can be optimally placed.
999 FIRM_API void place_code(ir_graph *irg);
1002 * Creates an ir_graph pass for place_code().
1003 * This pass enables GCSE, runs optimize_graph_df() and finally
1006 * @param name the name of this pass or NULL
1008 * @return the newly created ir_graph pass
1010 FIRM_API ir_graph_pass_t *place_code_pass(const char *name);
1013 * Determines information about the values of nodes and perform simplifications
1014 * using this information. This optimization performs a data-flow analysis to
1015 * find the minimal fixpoint.
1017 FIRM_API void fixpoint_vrp(ir_graph*);
1020 * Creates an ir_graph pass for fixpoint_vrp().
1021 * This pass dDetermines information about the values of nodes
1022 * and perform simplifications using this information.
1023 * This optimization performs a data-flow analysis to
1024 * find the minimal fixpoint.
1026 * @param name the name of this pass or NULL
1028 * @return the newly created ir_graph pass
1030 FIRM_API ir_graph_pass_t *fixpoint_vrp_irg_pass(const char *name);
1033 * Checks if the value of a node is != 0.
1035 * This is a often needed case, so we handle here Confirm
1038 * @param n a node representing the value
1039 * @param confirm if n is confirmed to be != 0, returns
1040 * the the Confirm-node, else NULL
1042 FIRM_API int value_not_zero(const ir_node *n, const ir_node **confirm);
1045 * Checks if the value of a node cannot represent a NULL pointer.
1047 * - If option sel_based_null_check_elim is enabled, all
1048 * Sel nodes can be skipped.
1049 * - A SymConst(entity) is NEVER a NULL pointer
1050 * - A Const != NULL is NEVER a NULL pointer
1051 * - Confirms are evaluated
1053 * @param n a node representing the value
1054 * @param confirm if n is confirmed to be != NULL, returns
1055 * the the Confirm-node, else NULL
1057 FIRM_API int value_not_null(const ir_node *n, const ir_node **confirm);
1060 * Checks if the value of a node can be confirmed >= 0 or <= 0,
1061 * If the mode of the value did not honor signed zeros, else
1062 * check for >= 0 or < 0.
1064 * @param n a node representing the value
1066 FIRM_API ir_value_classify_sign classify_value_sign(ir_node *n);
1069 * Returns the value of a Cmp if one or both predecessors are Confirm nodes.
1071 * @param cmp the compare node that will be evaluated
1072 * @param left the left operand of the Cmp
1073 * @param right the right operand of the Cmp
1074 * @param relation the compare relation
1076 FIRM_API ir_tarval *computed_value_Cmp_Confirm(
1077 const ir_node *cmp, ir_node *left, ir_node *right, ir_relation relation);
1079 /** Type of callbacks for createing entities of the compiler library */
1080 typedef ir_entity *(*compilerlib_entity_creator_t)(ident *id, ir_type *mt);
1083 * Sets the compilerlib entity creation callback that is used to create
1084 * compilerlib function entities.
1086 * @param cb the new compilerlib entity creation callback
1088 FIRM_API void set_compilerlib_entity_creator(compilerlib_entity_creator_t cb);
1090 /** Returns the compilerlib entity creation callback. */
1091 FIRM_API compilerlib_entity_creator_t get_compilerlib_entity_creator(void);
1094 * Constructs the entity for a given function using the current compilerlib
1095 * entity creation callback.
1097 * @param id the identifier of the compilerlib function
1098 * @param mt the method type of the compilerlib function
1100 FIRM_API ir_entity *create_compilerlib_entity(ident *id, ir_type *mt);