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 * Do the scalar replacement optimization.
111 * Make a date flow analyze and split the
114 * @param irg the graph which should be optimized
116 FIRM_API void data_flow_scalar_replacement_opt(ir_graph *irg);
119 * A callback that checks whether a entity is an allocation
122 typedef int (*check_alloc_entity_func)(ir_entity *ent);
125 * Do simple and fast escape analysis for one graph.
127 * @param irg the graph
128 * @param callback a callback function to check whether a
129 * given entity is a allocation call
131 FIRM_API void escape_enalysis_irg(ir_graph *irg,
132 check_alloc_entity_func callback);
135 * Do simple and fast escape analysis for all graphs.
137 * This optimization implements a simple and fast but inexact
138 * escape analysis. Some addresses might be marked as 'escaped' even
140 * The advantage is a low memory footprint and fast speed.
142 * @param run_scalar_replace if this flag in non-zero, scalar
143 * replacement optimization is run on graphs with removed
145 * @param callback a callback function to check whether a
146 * given entity is a allocation call
148 * This optimization removes allocation which are not used (rare) and replace
149 * allocation that can be proved dead at the end of the graph which stack variables.
151 * The creation of stack variable allows scalar replacement to be run only
152 * on those graphs that have been changed.
154 * This is most effective on Java where no other stack variables exists.
156 FIRM_API void escape_analysis(int run_scalar_replace,
157 check_alloc_entity_func callback);
160 * Optimize function calls by handling const functions.
162 * This optimization first detects all "const functions", i.e.,
163 * IR graphs that neither read nor write memory (and hence did
164 * not create exceptions, as these use memory in Firm).
166 * The result of calls to such functions depends only on its
167 * arguments, hence those calls are no more pinned.
169 * This is a rather strong criteria, so do not expect that a
170 * lot of functions will be found. Moreover, all of them might
171 * already be inlined if inlining is activated.
172 * Anyway, it might be good for handling builtin's
173 * even if the later read/write memory (but we know how).
175 * This optimizations read the irg_const_function property of
176 * entities and and sets the irg_const_function property of
179 * If callee information is valid, we also optimize polymorphic Calls.
181 * @param force_run if non-zero, an optimization run is started even
182 * if no const function graph was detected.
183 * Else calls are only optimized if at least one
184 * const function graph was detected.
185 * @param callback a callback function to check whether a
186 * given entity is a allocation call
188 * If the frontend created external entities with the irg_const_function
189 * property set, the force_run parameter should be set, else
192 * @note This optimization destroys the link fields of nodes.
194 FIRM_API void optimize_funccalls(int force_run,
195 check_alloc_entity_func callback);
198 * Creates an ir_prog pass for optimize_funccalls().
200 * @param name the name of this pass or NULL
201 * @param force_run if non-zero, an optimization run is started even
202 * if no const function graph was detected.
203 * Else calls are only optimized if at least one
204 * const function graph was detected.
205 * @param callback a callback function to check whether a
206 * given entity is a allocation call
208 * @return the newly created ir_prog pass
210 FIRM_API ir_prog_pass_t *optimize_funccalls_pass(const char *name,
212 check_alloc_entity_func callback);
215 * Does Partial Redundancy Elimination combined with
216 * Global Value Numbering.
217 * Can be used to replace place_code() completely.
219 * Based on VanDrunen and Hosking 2004.
221 * @param irg the graph
223 FIRM_API void do_gvn_pre(ir_graph *irg);
226 * Creates an ir_graph pass for do_gvn_pre().
228 * @param name the name of this pass or NULL
230 * @return the newly created ir_graph pass
232 FIRM_API ir_graph_pass_t *do_gvn_pre_pass(const char *name);
235 * This function is called to evaluate, if a
236 * mux(@p sel, @p mux_false, @p mux_true) should be built for the current
238 * If it returns non-zero, a mux is created, else the code
240 * @param sel A selector of a Cond.
241 * @param phi_list phi node to be converted
242 * @param i First data predecessor involved in if conversion
243 * @param j Second data predecessor involved in if conversion
245 typedef int (*arch_allow_ifconv_func)(ir_node *sel, ir_node *mux_false,
249 * Perform If conversion on a graph.
251 * @param irg The graph.
253 * Cannot handle blocks with Bad control predecessors, so call it after control
256 FIRM_API void opt_if_conv(ir_graph *irg);
259 * Creates an ir_graph pass for opt_if_conv().
261 * @param name the name of this pass or NULL
263 * @return the newly created ir_graph pass
265 FIRM_API ir_graph_pass_t *opt_if_conv_pass(const char *name);
268 * Tries to reduce dependencies for memory nodes where possible by parallelizing
269 * them and synchronizing with Sync nodes
270 * @param irg the graph where memory operations should be parallelized
272 FIRM_API void opt_parallelize_mem(ir_graph *irg);
275 * Creates an ir_graph pass for opt_sync().
277 * @param name the name of this pass or NULL
279 * @return the newly created ir_graph pass
281 FIRM_API ir_graph_pass_t *opt_parallelize_mem_pass(const char *name);
284 * Check if we can replace the load by a given const from
285 * the const code irg.
287 * @param load the load to replace
288 * @param c the constant
290 * @return in the modes match or can be transformed using a reinterpret cast
291 * returns a copy of the constant (possibly Conv'ed) on the
294 FIRM_API ir_node *can_replace_load_by_const(const ir_node *load, ir_node *c);
297 * Load/Store optimization.
299 * Removes redundant non-volatile Loads and Stores.
300 * May introduce Bad nodes if exceptional control flow
301 * is removed. The following cases are optimized:
303 * Load without result: A Load which has only a memory use
306 * Load after Store: A Load after a Store is removed, if
307 * the Load doesn't have an exception handler OR is in
308 * the same block as the Store.
310 * Load after Load: A Load after a Load is removed, if the
311 * Load doesn't have an exception handler OR is in the
312 * same block as the previous Load.
314 * Store before Store: A Store immediately before another
315 * Store in the same block is removed, if the Store doesn't
316 * have an exception handler.
318 * Store after Load: A Store after a Load is removed, if the
319 * Store doesn't have an exception handler.
321 * @return non-zero if the optimization could be applied, 0 else
323 FIRM_API int optimize_load_store(ir_graph *irg);
326 * Creates an ir_graph pass for optimize_load_store().
328 * @param name the name of this pass or NULL
330 * @return the newly created ir_graph pass
332 FIRM_API ir_graph_pass_t *optimize_load_store_pass(const char *name);
335 * New experimental alternative to optimize_load_store.
336 * Based on a dataflow analysis, so load/stores are moved out of loops
339 FIRM_API int opt_ldst(ir_graph *irg);
342 * Creates an ir_graph pass for opt_ldst().
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_ldst_pass(const char *name);
351 * Optimize loops by peeling or unrolling them if beneficial.
353 * @param irg The graph whose loops will be processed
355 * This function did not change the graph, only it's frame type.
356 * The layout state of the frame type will be set to layout_undefined
357 * if entities were removed.
359 FIRM_API void loop_optimization(ir_graph *irg);
362 * Optimize the frame type of an irg by removing
363 * never touched entities.
365 * @param irg The graph whose frame type will be optimized
367 * This function did not change the graph, only it's frame type.
368 * The layout state of the frame type will be set to layout_undefined
369 * if entities were removed.
371 FIRM_API void opt_frame_irg(ir_graph *irg);
374 * Creates an ir_graph pass for opt_frame_irg().
376 * @param name the name of this pass or NULL
378 * @return the newly created ir_graph pass
380 FIRM_API ir_graph_pass_t *opt_frame_irg_pass(const char *name);
382 /** Possible flags for the Operator Scalar Replacement. */
383 typedef enum osr_flags {
384 osr_flag_none = 0, /**< no additional flags */
385 osr_flag_lftr_with_ov_check = 1, /**< do linear function test replacement
386 only if no overflow can occur. */
387 osr_flag_ignore_x86_shift = 2, /**< ignore Multiplications by 2, 4, 8 */
388 osr_flag_keep_reg_pressure = 4 /**< do NOT increase register pressure by introducing new
389 induction variables. */
392 /* FirmJNI cannot handle identical enum values... */
394 /** default setting */
395 #define osr_flag_default osr_flag_lftr_with_ov_check
398 * Do the Operator Scalar Replacement optimization and linear
399 * function test replacement for loop control.
400 * Can be switched off using the set_opt_strength_red() flag.
401 * In that case, only remove_phi_cycles() is executed.
403 * @param irg the graph which should be optimized
404 * @param flags set of osr_flags
406 * The linear function replacement test is controlled by the flags.
407 * If the osr_flag_lftr_with_ov_check is set, the replacement is only
408 * done if do overflow can occur.
409 * Otherwise it is ALWAYS done which might be insecure.
413 * for (i = 0; i < 100; ++i)
415 * might be replaced by
417 * for (i = 0; i < 400; i += 4)
421 * for (i = 0; i < 0x7FFFFFFF; ++i)
423 * will not be replaced by
425 * for (i = 0; i < 0xFFFFFFFC; i += 4)
427 * because of overflow.
431 * for (i = 0; i <= 0xF; ++i)
433 * will NOT be transformed into
435 * for (i = 0xFFFFFFF0; i <= 0xFFFFFFFF; ++i)
437 * although here is no direct overflow. The OV occurs when the ++i
438 * is executed (and would created an endless loop here!).
440 * For the same reason, a loop
442 * for (i = 0; i <= 9; i += x)
444 * will NOT be transformed because we cannot estimate whether an overflow
445 * might happen adding x.
447 * Note that i < a + 400 is also not possible with the current implementation
448 * although this might be allowed by other compilers...
450 * Note further that tests for equality can be handled some simpler (but are not
453 * This algorithm destroys the link field of nodes.
455 FIRM_API void opt_osr(ir_graph *irg, unsigned flags);
458 * Creates an ir_graph pass for remove_phi_cycles().
460 * @param name the name of this pass or NULL
461 * @param flags set of osr_flags
463 * @return the newly created ir_graph pass
465 FIRM_API ir_graph_pass_t *opt_osr_pass(const char *name, unsigned flags);
468 * Removes useless Phi cycles, i.e cycles of Phi nodes with only one
470 * This is automatically done in opt_osr(), so there is no need to call it
473 * @param irg the graph which should be optimized
475 * This algorithm destroys the link field of nodes.
477 FIRM_API void remove_phi_cycles(ir_graph *irg);
480 * Creates an ir_graph pass for remove_phi_cycles().
482 * @param name the name of this pass or NULL
484 * @return the newly created ir_graph pass
486 FIRM_API ir_graph_pass_t *remove_phi_cycles_pass(const char *name);
489 /** A default threshold. */
490 #define DEFAULT_CLONE_THRESHOLD 20
493 * Do procedure cloning. Evaluate a heuristic weight for every
494 * Call(..., Const, ...). If the weight is bigger than threshold,
495 * clone the entity and fix the calls.
497 * @param threshold the threshold for cloning
499 * The threshold is an estimation of how many instructions are saved
500 * when executing a cloned method. If threshold is 0.0, every possible
503 FIRM_API void proc_cloning(float threshold);
506 * Creates an ir_prog pass for proc_cloning().
508 * @param name the name of this pass or NULL
509 * @param threshold the threshold for cloning
511 * @return the newly created ir_prog pass
513 FIRM_API ir_prog_pass_t *proc_cloning_pass(const char *name, float threshold);
518 * Applies Reassociation rules to integer expressions.
519 * Beware: Works only if integer overflow might be ignored, as for C, Java
520 * and for address expression.
521 * Works only if Constant folding is activated.
523 * Uses loop information to detect loop-invariant (i.e. contant
524 * inside the loop) values.
526 * See Muchnik 12.3.1 Algebraic Simplification and Reassociation of
527 * Addressing Expressions.
529 * @return non-zero if the optimization could be applied, 0 else
531 FIRM_API int optimize_reassociation(ir_graph *irg);
534 * Creates an ir_graph pass for optimize_reassociation().
536 * @param name the name of this pass or NULL
538 * @return the newly created ir_graph pass
540 FIRM_API ir_graph_pass_t *optimize_reassociation_pass(const char *name);
543 * Normalize the Returns of a graph by creating a new End block
544 * with One Return(Phi).
545 * This is the preferred input for the if-conversion.
547 * In pseudocode, it means:
554 * is transformed into
562 FIRM_API void normalize_one_return(ir_graph *irg);
565 * Creates an ir_graph pass for normalize_one_return().
567 * @param name the name of this pass or NULL
569 * @return the newly created ir_graph pass
571 FIRM_API ir_graph_pass_t *normalize_one_return_pass(const char *name);
574 * Normalize the Returns of a graph by moving
575 * the Returns upwards as much as possible.
576 * This might be preferred for code generation.
578 * In pseudocode, it means:
586 * is transformed into
593 FIRM_API void normalize_n_returns(ir_graph *irg);
596 * Creates an ir_graph pass for normalize_n_returns().
598 * @param name the name of this pass or NULL
600 * @return the newly created ir_graph pass
602 FIRM_API ir_graph_pass_t *normalize_n_returns_pass(const char *name);
605 * Do the scalar replacement optimization.
606 * Replace local compound entities (like structures and arrays)
607 * with atomic values if possible. Does not handle classes yet.
609 * @param irg the graph which should be optimized
611 * @return non-zero, if at least one entity was replaced
613 FIRM_API int scalar_replacement_opt(ir_graph *irg);
616 * Creates an ir_graph pass for scalar_replacement_opt().
618 * @param name the name of this pass or NULL
620 * @return the newly created ir_graph pass
622 FIRM_API ir_graph_pass_t *scalar_replacement_opt_pass(const char *name);
624 /** Performs strength reduction for the passed graph. */
625 FIRM_API void reduce_strength(ir_graph *irg);
628 * Optimizes tail-recursion calls by converting them into loops.
629 * Depends on the flag opt_tail_recursion.
630 * Currently supports the following forms:
632 * - return x + func();
633 * - return func() - x;
634 * - return x * func();
637 * Does not work for Calls that use the exception stuff.
639 * @param irg the graph to be optimized
641 * @return non-zero if the optimization could be applied, 0 else
643 FIRM_API int opt_tail_rec_irg(ir_graph *irg);
646 * Creates an ir_graph pass for opt_tail_rec_irg().
648 * @param name the name of this pass or NULL
650 * @return the newly created ir_graph pass
652 FIRM_API ir_graph_pass_t *opt_tail_rec_irg_pass(const char *name);
655 * Optimize tail-recursion calls for all IR-Graphs.
656 * Can currently handle:
657 * - direct return value, i.e. return func().
658 * - additive return value, i.e. return x +/- func()
659 * - multiplicative return value, i.e. return x * func() or return -func()
661 * The current implementation must be run before optimize_funccalls(),
662 * because it expects the memory edges pointing to calls, which might be
663 * removed by optimize_funccalls().
665 FIRM_API void opt_tail_recursion(void);
668 * Creates an ir_prog pass for opt_tail_recursion().
670 * @param name the name of this pass or NULL
672 * @return the newly created ir_prog pass
674 FIRM_API ir_prog_pass_t *opt_tail_recursion_pass(const char *name);
676 /** This is the type for a method, that returns a pointer type to
677 * tp. This is needed in the normalization. */
678 typedef ir_type *(*gen_pointer_type_to_func)(ir_type *tp);
680 /** Insert Casts so that class type casts conform exactly with the type hierarchy.
682 * Formulated in Java, this achieves the following:
684 * For a class hierarchy
686 * class B extends A {}
687 * class C extends B {}
688 * we transforms a cast
693 * The algorithm works for Casts with class types, but also for Casts
694 * with all pointer types that point (over several indirections,
695 * i.e. ***A) to a class type. Normalizes all graphs. Computes type
696 * information (@see irtypeinfo.h) if not available.
697 * Invalidates trout information as new casts are generated.
699 * @param gppt_fct A function that returns a pointer type that points
700 * to the type given as argument. If this parameter is NULL, a default
701 * function is used that either uses trout information or performs a O(n)
702 * search to find an existing pointer type. If it can not find a type,
703 * generates a pointer type with mode_P_mach and suffix "cc_ptr_tp".
705 FIRM_API void normalize_irp_class_casts(gen_pointer_type_to_func gppt_fct);
707 /** Insert Casts so that class type casts conform exactly with the type hierarchy
710 * For more details see normalize_irp_class_casts().
712 * This transformation requires that type information is computed. @see irtypeinfo.h.
714 FIRM_API void normalize_irg_class_casts(ir_graph *irg,
715 gen_pointer_type_to_func gppt_fct);
717 /** Optimize casting between class types.
720 * class B extends A { }
721 * class C extends B {}
722 * Performs the following transformations:
723 * C c = (C)(B)(A)(B)new C() --> C c = (C)(B)newC() --> C c = new C()
724 * (Optimizing downcasts as A a = (A)(B)(new A()) --> A a = new A() can
725 * be suppressed by setting the flag opt_suppress_downcast_optimization.
726 * Downcasting A to B might cause an exception. It is not clear
727 * whether this is modeled by the Firm Cast node, as it has no exception
729 * If there is inh_m() that overwrites m() in B:
730 * ((A) new B()).m() --> (new B()).inh_m()
731 * Phi((A)x, (A)y) --> (A) Phi (x, y) if (A) is an upcast.
733 * Computes type information if not available. @see irtypeinfo.h.
734 * Typeinformation is valid after optimization.
735 * Invalidates trout information.
737 FIRM_API void optimize_class_casts(void);
740 * CLiff Click's combo algorithm from
741 * "Combining Analyses, combining Optimizations".
743 * Does conditional constant propagation, unreachable code elimination and
744 * optimistic global value numbering at once.
746 * @param irg the graph to run on
748 FIRM_API void combo(ir_graph *irg);
751 * Creates an ir_graph pass for combo.
753 * @param name the name of this pass or NULL
755 * @return the newly created ir_graph pass
757 FIRM_API ir_graph_pass_t *combo_pass(const char *name);
760 * Inlines all small methods at call sites where the called address comes
761 * from a SymConst node that references the entity representing the called
764 * @param irg the graph
765 * @param size maximum function size
767 * The size argument is a rough measure for the code size of the method:
768 * Methods where the obstack containing the firm graph is smaller than
769 * size are inlined. Further only a limited number of calls are inlined.
770 * If the method contains more than 1024 inlineable calls none will be
772 * Inlining is only performed if flags `optimize' and `inlining' are set.
773 * The graph may not be in state phase_building.
774 * It is recommended to call local_optimize_graph() after inlining as this
775 * function leaves a set of obscure Tuple nodes, e.g. a Proj-Tuple-Jmp
776 * combination as control flow operation.
778 FIRM_API void inline_small_irgs(ir_graph *irg, int size);
781 * Creates an ir_graph pass for inline_small_irgs().
783 * @param name the name of this pass or NULL
784 * @param size maximum function size
786 * @return the newly created ir_graph pass
788 FIRM_API ir_graph_pass_t *inline_small_irgs_pass(const char *name, int size);
791 * Inlineing with a different heuristic than inline_small_irgs().
793 * Inlines leave functions. If inlining creates new leave
794 * function inlines these, too. (If g calls f, and f calls leave h,
795 * h is first inlined in f and then f in g.)
797 * Then inlines all small functions (this is not recursive).
799 * For a heuristic this inlining uses firm node counts. It does
800 * not count auxiliary nodes as Proj, Tuple, End, Start, Id, Sync.
801 * If the ignore_runtime flag is set, calls to functions marked with the
802 * mtp_property_runtime property are ignored.
804 * @param maxsize Do not inline any calls if a method has more than
805 * maxsize firm nodes. It may reach this limit by
807 * @param leavesize Inline leave functions if they have less than leavesize
809 * @param size Inline all function smaller than size.
810 * @param ignore_runtime count a function only calling runtime functions as
813 FIRM_API void inline_leave_functions(unsigned maxsize, unsigned leavesize,
814 unsigned size, int ignore_runtime);
817 * Creates an ir_prog pass for inline_leave_functions().
819 * @param name the name of this pass or NULL
820 * @param maxsize Do not inline any calls if a method has more than
821 * maxsize firm nodes. It may reach this limit by
823 * @param leavesize Inline leave functions if they have less than leavesize
825 * @param size Inline all function smaller than size.
826 * @param ignore_runtime count a function only calling runtime functions as
829 * @return the newly created ir_prog pass
831 FIRM_API ir_prog_pass_t *inline_leave_functions_pass(const char *name,
832 unsigned maxsize, unsigned leavesize, unsigned size,
835 typedef void (*opt_ptr)(ir_graph *irg);
838 * Heuristic inliner. Calculates a benefice value for every call and inlines
839 * those calls with a value higher than the threshold.
841 * @param maxsize Do not inline any calls if a method has more than
842 * maxsize firm nodes. It may reach this limit by
844 * @param inline_threshold inlining threshold
845 * @param after_inline_opt optimizations performed immediately after inlining
848 FIRM_API void inline_functions(unsigned maxsize, int inline_threshold,
849 opt_ptr after_inline_opt);
852 * Creates an ir_prog pass for inline_functions().
854 * @param name the name of this pass or NULL
855 * @param maxsize Do not inline any calls if a method has more than
856 * maxsize firm nodes. It may reach this limit by
858 * @param inline_threshold inlining threshold
859 * @param after_inline_opt a function that is called after inlining a
860 * procedure. You should run fast local optimisations
861 * here which cleanup the graph before further
864 * @return the newly created ir_prog pass
866 FIRM_API ir_prog_pass_t *inline_functions_pass(const char *name,
867 unsigned maxsize, int inline_threshold, opt_ptr after_inline_opt);
870 * Combines congruent blocks into one.
872 * @param irg The IR-graph to optimize.
874 * @return non-zero if the graph was transformed
876 FIRM_API int shape_blocks(ir_graph *irg);
879 * Creates an ir_graph pass for shape_blocks().
881 * @param name the name of this pass or NULL
883 * @return the newly created ir_graph pass
885 FIRM_API ir_graph_pass_t *shape_blocks_pass(const char *name);
888 * Perform loop inversion on a given graph.
889 * Loop inversion transforms a head controlled loop (like while(...) {} and
890 * for(...) {}) into a foot controlled loop (do {} while(...)).
892 FIRM_API void do_loop_inversion(ir_graph *irg);
895 * Perform loop unrolling on a given graph.
896 * Loop unrolling multiplies the number loop completely by a number found
897 * through a heuristic.
899 FIRM_API void do_loop_unrolling(ir_graph *irg);
902 * Perform loop peeling on a given graph.
904 FIRM_API void do_loop_peeling(ir_graph *irg);
907 * Creates an ir_graph pass for loop inversion.
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 *loop_inversion_pass(const char *name);
916 * Creates an ir_graph pass for loop unrolling.
918 * @param name the name of this pass or NULL
920 * @return the newly created ir_graph pass
922 FIRM_API ir_graph_pass_t *loop_unroll_pass(const char *name);
925 * Creates an ir_graph pass for loop peeling.
927 * @param name the name of this pass or NULL
929 * @return the newly created ir_graph pass
931 FIRM_API ir_graph_pass_t *loop_peeling_pass(const char *name);
933 typedef ir_type *(*get_Alloc_func)(ir_node *n);
934 /** Set a new get_Alloc_func and returns the old one. */
935 FIRM_API get_Alloc_func firm_set_Alloc_func(get_Alloc_func newf);
938 * Creates an ir_graph pass for set_vrp_data()
940 * @param name The name of this pass or NULL
942 * @return the newly created ir_graph pass
944 FIRM_API ir_graph_pass_t *set_vrp_pass(const char *name);
947 * Removes all entities which are unused.
949 * Unused entities have ir_visibility_local and are not used directly or
950 * indirectly through entities/code visible outside the compilation unit.
951 * This is usually conservative than gc_irgs, but does not respect properties
952 * of object-oriented programs.
954 FIRM_API void garbage_collect_entities(void);
956 /** Pass for garbage_collect_entities */
957 FIRM_API ir_prog_pass_t *garbage_collect_entities_pass(const char *name);
960 * Performs dead node elimination by copying the ir graph to a new obstack.
962 * The major intention of this pass is to free memory occupied by
963 * dead nodes and outdated analyzes information. Further this
964 * function removes Bad predecessors from Blocks and the corresponding
965 * inputs to Phi nodes. This opens optimization potential for other
966 * optimizations. Further this phase reduces dead Block<->Jmp
967 * self-cycles to Bad nodes.
969 * Dead_node_elimination is only performed if options `optimize' and
970 * `opt_dead_node_elimination' are set. The graph may
971 * not be in state phase_building. The outs datastructure is freed,
972 * the outs state set to outs_none. Backedge information is conserved.
973 * Removes old attributes of nodes. Sets link field to NULL.
974 * Callee information must be freed (irg_callee_info_none).
976 * @param irg The graph to be optimized.
978 FIRM_API void dead_node_elimination(ir_graph *irg);
981 * Creates an ir_graph pass for dead_node_elimination().
983 * @param name the name of this pass or NULL
985 * @return the newly created ir_graph pass
987 FIRM_API ir_graph_pass_t *dead_node_elimination_pass(const char *name);
990 * Inlines a method at the given call site.
992 * Removes the call node and splits the basic block the call node
993 * belongs to. Inserts a copy of the called graph between these nodes.
994 * Assumes that call is a Call node in current_ir_graph and that
995 * the type in the Call nodes type attribute is the same as the
996 * type of the called graph.
997 * Further it assumes that all Phi nodes in a block of current_ir_graph
998 * are assembled in a "link" list in the link field of the corresponding
999 * block nodes. Further assumes that all Proj nodes are in a "link" list
1000 * in the nodes producing the tuple. (This is only an optical feature
1001 * for the graph.) Conserves this feature for the old
1002 * nodes of the graph. This precondition can be established by a call to
1003 * collect_phisprojs(), see irgmod.h.
1004 * As dead_node_elimination this function reduces dead Block<->Jmp
1005 * self-cycles to Bad nodes.
1007 * Called_graph must be unequal to current_ir_graph. Will not inline
1008 * if they are equal.
1009 * Sets visited masterflag in current_ir_graph to the max of the flag in
1010 * current and called graph.
1011 * Assumes that both, the called and the calling graph are in state
1012 * "op_pin_state_pinned".
1013 * It is recommended to call local_optimize_graph() after inlining as this
1014 * function leaves a set of obscure Tuple nodes, e.g. a Proj-Tuple-Jmp
1015 * combination as control flow operation.
1017 * @param call the call node that should be inlined
1018 * @param called_graph the IR-graph that is called at call
1020 * @return zero if method could not be inlined (recursion for instance),
1021 * non-zero if all went ok
1023 FIRM_API int inline_method(ir_node *call, ir_graph *called_graph);
1028 * Pins all floating nodes to a block where they
1029 * will be executed only if needed. Depends on the flag opt_global_cse.
1030 * Graph may not be in phase_building. Does not schedule control dead
1031 * code. Uses dominator information which it computes if the irg is not
1032 * in state dom_consistent. Destroys the out information as it moves nodes
1033 * to other blocks. Optimizes Tuples in Control edges.
1035 * Call remove_critical_cf_edges() before place_code(). This normalizes
1036 * the control flow graph so that for all operations a basic block exists
1037 * where they can be optimally placed.
1039 FIRM_API void place_code(ir_graph *irg);
1042 * Creates an ir_graph pass for place_code().
1043 * This pass enables GCSE, runs optimize_graph_df() and finally
1046 * @param name the name of this pass or NULL
1048 * @return the newly created ir_graph pass
1050 FIRM_API ir_graph_pass_t *place_code_pass(const char *name);
1053 * Determine information about the values of nodes and perform simplifications
1054 * using this information. This optimization performs a data-flow analysis to
1055 * find the minimal fixpoint.
1057 FIRM_API void fixpoint_vrp(ir_graph*);
1060 * Creates an ir_graph pass for fixpoint_vrp().
1061 * This pass dDetermines information about the values of nodes
1062 * and perform simplifications using this information.
1063 * This optimization performs a data-flow analysis to
1064 * find the minimal fixpoint.
1066 * @param name the name of this pass or NULL
1068 * @return the newly created ir_graph pass
1070 FIRM_API ir_graph_pass_t *fixpoint_vrp_irg_pass(const char *name);
1073 * Check, if the value of a node is != 0.
1075 * This is a often needed case, so we handle here Confirm
1078 * @param n a node representing the value
1079 * @param confirm if n is confirmed to be != 0, returns
1080 * the the Confirm-node, else NULL
1082 FIRM_API int value_not_zero(const ir_node *n, ir_node_cnst_ptr *confirm);
1085 * Check, if the value of a node cannot represent a NULL pointer.
1087 * - If option sel_based_null_check_elim is enabled, all
1088 * Sel nodes can be skipped.
1089 * - A SymConst(entity) is NEVER a NULL pointer
1090 * - A Const != NULL is NEVER a NULL pointer
1091 * - Confirms are evaluated
1093 * @param n a node representing the value
1094 * @param confirm if n is confirmed to be != NULL, returns
1095 * the the Confirm-node, else NULL
1097 FIRM_API int value_not_null(const ir_node *n, ir_node_cnst_ptr *confirm);
1100 * Check, if the value of a node can be confirmed >= 0 or <= 0,
1101 * If the mode of the value did not honor signed zeros, else
1102 * check for >= 0 or < 0.
1104 * @param n a node representing the value
1106 FIRM_API ir_value_classify_sign classify_value_sign(ir_node *n);
1109 * Return the value of a Cmp if one or both predecessors
1110 * are Confirm nodes.
1112 * @param cmp the compare node that will be evaluated
1113 * @param left the left operand of the Cmp
1114 * @param right the right operand of the Cmp
1115 * @param pnc the compare relation
1117 FIRM_API ir_tarval *computed_value_Cmp_Confirm(
1118 ir_node *cmp, ir_node *left, ir_node *right, pn_Cmp pnc);