2 * Copyright (C) 1995-2008 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"
32 * Control flow optimization.
34 * Removes empty blocks doing if simplifications and loop simplifications.
35 * A block is empty if it contains only a Jmp node and Phi nodes.
36 * Merges single entry single exit blocks with their predecessor
37 * and propagates dead control flow by calling equivalent_node().
38 * Independent of compiler flag it removes Tuples from cf edges,
39 * Bad predecessors from Blocks and Phis, and unnecessary predecessors of End.
40 * Destroys backedge information.
42 * @bug Chokes on Id nodes if called in a certain order with other
43 * optimizations. Call local_optimize_graph() before to remove
46 FIRM_API void optimize_cf(ir_graph *irg);
49 * Creates an ir_graph pass for optimize_cf().
51 * @param name the name of this pass or NULL
53 * @return the newly created ir_graph pass
55 FIRM_API ir_graph_pass_t *optimize_cf_pass(const char *name);
58 * Perform path-sensitive jump threading on the given graph.
60 * @param irg the graph
62 FIRM_API void opt_jumpthreading(ir_graph* irg);
65 * Creates an ir_graph pass for opt_jumpthreading().
67 * @param name the name of this pass or NULL
69 * @return the newly created ir_graph pass
71 FIRM_API ir_graph_pass_t *opt_jumpthreading_pass(const char *name);
74 * Creates an ir_graph pass for opt_loopunroll().
76 * @param name the name of this pass or NULL
78 * @return the newly created ir_graph pass
80 FIRM_API ir_graph_pass_t *opt_loopunroll_pass(const char *name);
84 * Try to simplify boolean expression in the given ir graph.
85 * eg. x < 5 && x < 6 becomes x < 5
87 * @param irg the graph
89 FIRM_API void opt_bool(ir_graph *irg);
92 * Creates an ir_graph pass for opt_bool().
94 * @param name the name of this pass or NULL
96 * @return the newly created ir_graph pass
98 FIRM_API ir_graph_pass_t *opt_bool_pass(const char *name);
101 * Try to reduce the number of conv nodes in the given ir graph.
103 * @param irg the graph
105 * @return non-zero if the optimization could be applied, 0 else
107 FIRM_API int conv_opt(ir_graph *irg);
110 * Creates an ir_graph pass for conv_opt().
112 * @param name the name of this pass or NULL
114 * @return the newly created ir_graph pass
116 FIRM_API ir_graph_pass_t *conv_opt_pass(const char *name);
119 * Do the scalar replacement optimization.
120 * Make a date flow analyze and split the
123 * @param irg the graph which should be optimized
125 FIRM_API void data_flow_scalar_replacement_opt(ir_graph *irg);
128 * A callback that checks whether a entity is an allocation
131 typedef int (*check_alloc_entity_func)(ir_entity *ent);
134 * Do simple and fast escape analysis for one graph.
136 * @param irg the graph
137 * @param callback a callback function to check whether a
138 * given entity is a allocation call
140 FIRM_API void escape_enalysis_irg(ir_graph *irg,
141 check_alloc_entity_func callback);
144 * Do simple and fast escape analysis for all graphs.
146 * This optimization implements a simple and fast but inexact
147 * escape analysis. Some addresses might be marked as 'escaped' even
149 * The advantage is a low memory footprint and fast speed.
151 * @param run_scalar_replace if this flag in non-zero, scalar
152 * replacement optimization is run on graphs with removed
154 * @param callback a callback function to check whether a
155 * given entity is a allocation call
157 * This optimization removes allocation which are not used (rare) and replace
158 * allocation that can be proved dead at the end of the graph which stack variables.
160 * The creation of stack variable allows scalar replacement to be run only
161 * on those graphs that have been changed.
163 * This is most effective on Java where no other stack variables exists.
165 FIRM_API void escape_analysis(int run_scalar_replace,
166 check_alloc_entity_func callback);
169 * Optimize function calls by handling const functions.
171 * This optimization first detects all "const functions", i.e.,
172 * IR graphs that neither read nor write memory (and hence did
173 * not create exceptions, as these use memory in Firm).
175 * The result of calls to such functions depends only on its
176 * arguments, hence those calls are no more pinned.
178 * This is a rather strong criteria, so do not expect that a
179 * lot of functions will be found. Moreover, all of them might
180 * already be inlined if inlining is activated.
181 * Anyway, it might be good for handling builtin's
182 * even if the later read/write memory (but we know how).
184 * This optimizations read the irg_const_function property of
185 * entities and and sets the irg_const_function property of
188 * If callee information is valid, we also optimize polymorphic Calls.
190 * @param force_run if non-zero, an optimization run is started even
191 * if no const function graph was detected.
192 * Else calls are only optimized if at least one
193 * const function graph was detected.
194 * @param callback a callback function to check whether a
195 * given entity is a allocation call
197 * If the frontend created external entities with the irg_const_function
198 * property set, the force_run parameter should be set, else
201 * @note This optimization destroys the link fields of nodes.
203 FIRM_API void optimize_funccalls(int force_run,
204 check_alloc_entity_func callback);
207 * Creates an ir_prog pass for optimize_funccalls().
209 * @param name the name of this pass or NULL
210 * @param force_run if non-zero, an optimization run is started even
211 * if no const function graph was detected.
212 * Else calls are only optimized if at least one
213 * const function graph was detected.
214 * @param callback a callback function to check whether a
215 * given entity is a allocation call
217 * @return the newly created ir_prog pass
219 FIRM_API ir_prog_pass_t *optimize_funccalls_pass(const char *name,
221 check_alloc_entity_func callback);
224 * Does Partial Redundancy Elimination combined with
225 * Global Value Numbering.
226 * Can be used to replace place_code() completely.
228 * Based on VanDrunen and Hosking 2004.
230 * @param irg the graph
232 FIRM_API void do_gvn_pre(ir_graph *irg);
235 * Creates an ir_graph pass for do_gvn_pre().
237 * @param name the name of this pass or NULL
239 * @return the newly created ir_graph pass
241 FIRM_API ir_graph_pass_t *do_gvn_pre_pass(const char *name);
244 * This function is called to evaluate, if a
245 * mux(@p sel, @p mux_false, @p mux_true) should be built for the current
247 * If it returns non-zero, a mux is created, else the code
249 * @param sel A selector of a Cond.
250 * @param phi_list phi node to be converted
251 * @param i First data predecessor involved in if conversion
252 * @param j Second data predecessor involved in if conversion
254 typedef int (*arch_allow_ifconv_func)(ir_node *sel, ir_node *mux_false,
258 * The parameters structure.
260 struct ir_settings_if_conv_t {
261 int max_depth; /**< The maximum depth up to which expressions
262 are examined when it has to be decided if they
263 can be placed into another block. */
264 arch_allow_ifconv_func allow_ifconv; /**< Evaluator function, if not set all possible Psi
265 nodes will be created. */
269 * Perform If conversion on a graph.
271 * @param irg The graph.
272 * @param params The parameters for the if conversion.
274 * Cannot handle blocks with Bad control predecessors, so call it after control
277 FIRM_API void opt_if_conv(ir_graph *irg, const ir_settings_if_conv_t *params);
280 * Creates an ir_graph pass for opt_if_conv().
282 * @param name the name of this pass or NULL
283 * @param params The parameters for the if conversion.
285 * @return the newly created ir_graph pass
287 FIRM_API ir_graph_pass_t *opt_if_conv_pass(
288 const char *name, const ir_settings_if_conv_t *params);
291 * Tries to reduce dependencies for memory nodes where possible by parllelizing
292 * them and synchronising with Sync nodes
293 * @param irg the graph where memory operations should be parallelised
295 FIRM_API void opt_parallelize_mem(ir_graph *irg);
298 * Creates an ir_graph pass for opt_sync().
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 *opt_parallelize_mem_pass(const char *name);
307 * Check if we can replace the load by a given const from
308 * the const code irg.
310 * @param load the load to replace
311 * @param c the constant
313 * @return in the modes match or can be transformed using a reinterpret cast
314 * returns a copy of the constant (possibly Conv'ed) on the
317 FIRM_API ir_node *can_replace_load_by_const(const ir_node *load, ir_node *c);
320 * Load/Store optimization.
322 * Removes redundant non-volatile Loads and Stores.
323 * May introduce Bad nodes if exceptional control flow
324 * is removed. The following cases are optimized:
326 * Load without result: A Load which has only a memory use
329 * Load after Store: A Load after a Store is removed, if
330 * the Load doesn't have an exception handler OR is in
331 * the same block as the Store.
333 * Load after Load: A Load after a Load is removed, if the
334 * Load doesn't have an exception handler OR is in the
335 * same block as the previous Load.
337 * Store before Store: A Store immediately before another
338 * Store in the same block is removed, if the Store doesn't
339 * have an exception handler.
341 * Store after Load: A Store after a Load is removed, if the
342 * Store doesn't have an exception handler.
344 * @return non-zero if the optimization could be applied, 0 else
346 FIRM_API int optimize_load_store(ir_graph *irg);
349 * Creates an ir_graph pass for optimize_load_store().
351 * @param name the name of this pass or NULL
353 * @return the newly created ir_graph pass
355 FIRM_API ir_graph_pass_t *optimize_load_store_pass(const char *name);
358 * New experimental alternative to optimize_load_store.
359 * Based on a dataflow analysis, so load/stores are moved out of loops
362 FIRM_API int opt_ldst(ir_graph *irg);
365 * Creates an ir_graph pass for opt_ldst().
367 * @param name the name of this pass or NULL
369 * @return the newly created ir_graph pass
371 FIRM_API ir_graph_pass_t *opt_ldst_pass(const char *name);
374 * Optimize loops by peeling or unrolling them if beneficial.
376 * @param irg The graph whose loops will be processed
378 * This function did not change the graph, only it's frame type.
379 * The layout state of the frame type will be set to layout_undefined
380 * if entities were removed.
382 FIRM_API void loop_optimization(ir_graph *irg);
385 * Optimize the frame type of an irg by removing
386 * never touched entities.
388 * @param irg The graph whose frame type will be optimized
390 * This function did not change the graph, only it's frame type.
391 * The layout state of the frame type will be set to layout_undefined
392 * if entities were removed.
394 FIRM_API void opt_frame_irg(ir_graph *irg);
397 * Creates an ir_graph pass for opt_frame_irg().
399 * @param name the name of this pass or NULL
401 * @return the newly created ir_graph pass
403 FIRM_API ir_graph_pass_t *opt_frame_irg_pass(const char *name);
405 /** Possible flags for the Operator Scalar Replacement. */
406 typedef enum osr_flags {
407 osr_flag_none = 0, /**< no additional flags */
408 osr_flag_lftr_with_ov_check = 1, /**< do linear function test replacement
409 only if no overflow can occur. */
410 osr_flag_ignore_x86_shift = 2, /**< ignore Multiplications by 2, 4, 8 */
411 osr_flag_keep_reg_pressure = 4 /**< do NOT increase register pressure by introducing new
412 induction variables. */
415 /* FirmJNI cannot handle identical enum values... */
417 /** default setting */
418 #define osr_flag_default osr_flag_lftr_with_ov_check
421 * Do the Operator Scalar Replacement optimization and linear
422 * function test replacement for loop control.
423 * Can be switched off using the set_opt_strength_red() flag.
424 * In that case, only remove_phi_cycles() is executed.
426 * @param irg the graph which should be optimized
427 * @param flags set of osr_flags
429 * The linear function replacement test is controlled by the flags.
430 * If the osr_flag_lftr_with_ov_check is set, the replacement is only
431 * done if do overflow can occur.
432 * Otherwise it is ALWAYS done which might be insecure.
436 * for (i = 0; i < 100; ++i)
438 * might be replaced by
440 * for (i = 0; i < 400; i += 4)
444 * for (i = 0; i < 0x7FFFFFFF; ++i)
446 * will not be replaced by
448 * for (i = 0; i < 0xFFFFFFFC; i += 4)
450 * because of overflow.
454 * for (i = 0; i <= 0xF; ++i)
456 * will NOT be transformed into
458 * for (i = 0xFFFFFFF0; i <= 0xFFFFFFFF; ++i)
460 * although here is no direct overflow. The OV occurs when the ++i
461 * is executed (and would created an endless loop here!).
463 * For the same reason, a loop
465 * for (i = 0; i <= 9; i += x)
467 * will NOT be transformed because we cannot estimate whether an overflow
468 * might happen adding x.
470 * Note that i < a + 400 is also not possible with the current implementation
471 * although this might be allowed by other compilers...
473 * Note further that tests for equality can be handled some simpler (but are not
476 * This algorithm destroys the link field of nodes.
478 FIRM_API void opt_osr(ir_graph *irg, unsigned flags);
481 * Creates an ir_graph pass for remove_phi_cycles().
483 * @param name the name of this pass or NULL
484 * @param flags set of osr_flags
486 * @return the newly created ir_graph pass
488 FIRM_API ir_graph_pass_t *opt_osr_pass(const char *name, unsigned flags);
491 * Removes useless Phi cycles, i.e cycles of Phi nodes with only one
493 * This is automatically done in opt_osr(), so there is no need to call it
496 * @param irg the graph which should be optimized
498 * This algorithm destroys the link field of nodes.
500 FIRM_API void remove_phi_cycles(ir_graph *irg);
503 * Creates an ir_graph pass for remove_phi_cycles().
505 * @param name the name of this pass or NULL
507 * @return the newly created ir_graph pass
509 FIRM_API ir_graph_pass_t *remove_phi_cycles_pass(const char *name);
512 /** A default threshold. */
513 #define DEFAULT_CLONE_THRESHOLD 20
516 * Do procedure cloning. Evaluate a heuristic weight for every
517 * Call(..., Const, ...). If the weight is bigger than threshold,
518 * clone the entity and fix the calls.
520 * @param threshold the threshold for cloning
522 * The threshold is an estimation of how many instructions are saved
523 * when executing a cloned method. If threshold is 0.0, every possible
526 FIRM_API void proc_cloning(float threshold);
529 * Creates an ir_prog pass for proc_cloning().
531 * @param name the name of this pass or NULL
532 * @param threshold the threshold for cloning
534 * @return the newly created ir_prog pass
536 FIRM_API ir_prog_pass_t *proc_cloning_pass(const char *name, float threshold);
541 * Applies Reassociation rules to integer expressions.
542 * Beware: Works only if integer overflow might be ignored, as for C, Java
543 * and for address expression.
544 * Works only if Constant folding is activated.
546 * Uses loop information to detect loop-invariant (ie contant
547 * inside the loop) values.
549 * See Muchnik 12.3.1 Algebraic Simplification and Reassociation of
550 * Addressing Expressions.
552 * @return non-zero if the optimization could be applied, 0 else
554 FIRM_API int optimize_reassociation(ir_graph *irg);
557 * Creates an ir_graph pass for optimize_reassociation().
559 * @param name the name of this pass or NULL
561 * @return the newly created ir_graph pass
563 FIRM_API ir_graph_pass_t *optimize_reassociation_pass(const char *name);
566 * Normalize the Returns of a graph by creating a new End block
567 * with One Return(Phi).
568 * This is the preferred input for the if-conversion.
570 * In pseudocode, it means:
577 * is transformed into
585 FIRM_API void normalize_one_return(ir_graph *irg);
588 * Creates an ir_graph pass for normalize_one_return().
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 *normalize_one_return_pass(const char *name);
597 * Normalize the Returns of a graph by moving
598 * the Returns upwards as much as possible.
599 * This might be preferred for code generation.
601 * In pseudocode, it means:
609 * is transformed into
616 FIRM_API void normalize_n_returns(ir_graph *irg);
619 * Creates an ir_graph pass for normalize_n_returns().
621 * @param name the name of this pass or NULL
623 * @return the newly created ir_graph pass
625 FIRM_API ir_graph_pass_t *normalize_n_returns_pass(const char *name);
628 * Do the scalar replacement optimization.
629 * Replace local compound entities (like structures and arrays)
630 * with atomic values if possible. Does not handle classes yet.
632 * @param irg the graph which should be optimized
634 * @return non-zero, if at least one entity was replaced
636 FIRM_API int scalar_replacement_opt(ir_graph *irg);
639 * Creates an ir_graph pass for scalar_replacement_opt().
641 * @param name the name of this pass or NULL
643 * @return the newly created ir_graph pass
645 FIRM_API ir_graph_pass_t *scalar_replacement_opt_pass(const char *name);
647 /** Performs strength reduction for the passed graph. */
648 FIRM_API void reduce_strength(ir_graph *irg);
651 * Optimizes tail-recursion calls by converting them into loops.
652 * Depends on the flag opt_tail_recursion.
653 * Currently supports the following forms:
655 * - return x + func();
656 * - return func() - x;
657 * - return x * func();
660 * Does not work for Calls that use the exception stuff.
662 * @param irg the graph to be optimized
664 * @return non-zero if the optimization could be applied, 0 else
666 FIRM_API int opt_tail_rec_irg(ir_graph *irg);
669 * Creates an ir_graph pass for opt_tail_rec_irg().
671 * @param name the name of this pass or NULL
673 * @return the newly created ir_graph pass
675 FIRM_API ir_graph_pass_t *opt_tail_rec_irg_pass(const char *name);
678 * Optimize tail-recursion calls for all IR-Graphs.
679 * Can currently handle:
680 * - direct return value, i.e. return func().
681 * - additive return value, i.e. return x +/- func()
682 * - multiplicative return value, i.e. return x * func() or return -func()
684 * The current implementation must be run before optimize_funccalls(),
685 * because it expects the memory edges pointing to calls, which might be
686 * removed by optimize_funccalls().
688 FIRM_API void opt_tail_recursion(void);
691 * Creates an ir_prog pass for opt_tail_recursion().
693 * @param name the name of this pass or NULL
695 * @return the newly created ir_prog pass
697 FIRM_API ir_prog_pass_t *opt_tail_recursion_pass(const char *name);
699 /** This is the type for a method, that returns a pointer type to
700 * tp. This is needed in the normalization. */
701 typedef ir_type *(*gen_pointer_type_to_func)(ir_type *tp);
703 /** Insert Casts so that class type casts conform exactly with the type hierarchy.
705 * Formulated in Java, this achieves the following:
707 * For a class hierarchy
709 * class B extends A {}
710 * class C extends B {}
711 * we transforms a cast
716 * The algorithm works for Casts with class types, but also for Casts
717 * with all pointer types that point (over several indirections,
718 * i.e. ***A) to a class type. Normalizes all graphs. Computes type
719 * information (@see irtypeinfo.h) if not available.
720 * Invalidates trout information as new casts are generated.
722 * @param gppt_fct A function that returns a pointer type that points
723 * to the type given as argument. If this parameter is NULL, a default
724 * function is used that either uses trout information or performs a O(n)
725 * search to find an existing pointer type. If it can not find a type,
726 * generates a pointer type with mode_P_mach and suffix "cc_ptr_tp".
728 FIRM_API void normalize_irp_class_casts(gen_pointer_type_to_func gppt_fct);
730 /** Insert Casts so that class type casts conform exactly with the type hierarchy
733 * For more details see normalize_irp_class_casts().
735 * This transformation requires that type information is computed. @see irtypeinfo.h.
737 FIRM_API void normalize_irg_class_casts(ir_graph *irg,
738 gen_pointer_type_to_func gppt_fct);
740 /** Optimize casting between class types.
743 * class B extends A { }
744 * class C extends B {}
745 * Performs the following transformations:
746 * C c = (C)(B)(A)(B)new C() --> C c = (C)(B)newC() --> C c = new C()
747 * (Optimizing downcasts as A a = (A)(B)(new A()) --> A a = new A() can
748 * be suppressed by setting the flag opt_suppress_downcast_optimization.
749 * Downcasting A to B might cause an exception. It is not clear
750 * whether this is modeled by the Firm Cast node, as it has no exception
752 * If there is inh_m() that overwrites m() in B:
753 * ((A) new B()).m() --> (new B()).inh_m()
754 * Phi((A)x, (A)y) --> (A) Phi (x, y) if (A) is an upcast.
756 * Computes type information if not available. @see irtypeinfo.h.
757 * Typeinformation is valid after optimization.
758 * Invalidates trout information.
760 FIRM_API void optimize_class_casts(void);
763 * CLiff Click's combo algorithm from
764 * "Combining Analyses, combining Optimizations".
766 * Does conditional constant propagation, unreachable code elimination and
767 * optimistic global value numbering at once.
769 * @param irg the graph to run on
771 FIRM_API void combo(ir_graph *irg);
774 * Creates an ir_graph pass for combo.
776 * @param name the name of this pass or NULL
778 * @return the newly created ir_graph pass
780 FIRM_API ir_graph_pass_t *combo_pass(const char *name);
783 * Inlines all small methods at call sites where the called address comes
784 * from a SymConst node that references the entity representing the called
787 * @param irg the graph
788 * @param size maximum function size
790 * The size argument is a rough measure for the code size of the method:
791 * Methods where the obstack containing the firm graph is smaller than
792 * size are inlined. Further only a limited number of calls are inlined.
793 * If the method contains more than 1024 inlineable calls none will be
795 * Inlining is only performed if flags `optimize' and `inlineing' are set.
796 * The graph may not be in state phase_building.
797 * It is recommended to call local_optimize_graph() after inlining as this
798 * function leaves a set of obscure Tuple nodes, e.g. a Proj-Tuple-Jmp
799 * combination as control flow operation.
801 FIRM_API void inline_small_irgs(ir_graph *irg, int size);
804 * Creates an ir_graph pass for inline_small_irgs().
806 * @param name the name of this pass or NULL
807 * @param size maximum function size
809 * @return the newly created ir_graph pass
811 FIRM_API ir_graph_pass_t *inline_small_irgs_pass(const char *name, int size);
814 * Inlineing with a different heuristic than inline_small_irgs().
816 * Inlines leave functions. If inlinening creates new leave
817 * function inlines these, too. (If g calls f, and f calls leave h,
818 * h is first inlined in f and then f in g.)
820 * Then inlines all small functions (this is not recursive).
822 * For a heuristic this inlineing uses firm node counts. It does
823 * not count auxiliary nodes as Proj, Tuple, End, Start, Id, Sync.
824 * If the ignore_runtime flag is set, calls to functions marked with the
825 * mtp_property_runtime property are ignored.
827 * @param maxsize Do not inline any calls if a method has more than
828 * maxsize firm nodes. It may reach this limit by
830 * @param leavesize Inline leave functions if they have less than leavesize
832 * @param size Inline all function smaller than size.
833 * @param ignore_runtime count a function only calling runtime functions as
836 FIRM_API void inline_leave_functions(unsigned maxsize, unsigned leavesize,
837 unsigned size, int ignore_runtime);
840 * Creates an ir_prog pass for inline_leave_functions().
842 * @param name the name of this pass or NULL
843 * @param maxsize Do not inline any calls if a method has more than
844 * maxsize firm nodes. It may reach this limit by
846 * @param leavesize Inline leave functions if they have less than leavesize
848 * @param size Inline all function smaller than size.
849 * @param ignore_runtime count a function only calling runtime functions as
852 * @return the newly created ir_prog pass
854 FIRM_API ir_prog_pass_t *inline_leave_functions_pass(const char *name,
855 unsigned maxsize, unsigned leavesize, unsigned size,
858 typedef void (*opt_ptr)(ir_graph *irg);
861 * Heuristic inliner. Calculates a benefice value for every call and inlines
862 * those calls with a value higher than the threshold.
864 * @param maxsize Do not inline any calls if a method has more than
865 * maxsize firm nodes. It may reach this limit by
867 * @param inline_threshold inlining threshold
868 * @param after_inline_opt optimizations performed immediately after inlining
871 FIRM_API void inline_functions(unsigned maxsize, int inline_threshold,
872 opt_ptr after_inline_opt);
875 * Creates an ir_prog pass for inline_functions().
877 * @param name the name of this pass or NULL
878 * @param maxsize Do not inline any calls if a method has more than
879 * maxsize firm nodes. It may reach this limit by
881 * @param inline_threshold inlining threshold
882 * @param after_inline_opt a function that is called after inlining a
883 * procedure. You should run fast local optimisations
884 * here which cleanup the graph before further
887 * @return the newly created ir_prog pass
889 FIRM_API ir_prog_pass_t *inline_functions_pass(const char *name,
890 unsigned maxsize, int inline_threshold, opt_ptr after_inline_opt);
893 * Combines congruent blocks into one.
895 * @param irg The IR-graph to optimize.
897 * @return non-zero if the graph was transformed
899 FIRM_API int shape_blocks(ir_graph *irg);
902 * Creates an ir_graph pass for shape_blocks().
904 * @param name the name of this pass or NULL
906 * @return the newly created ir_graph pass
908 FIRM_API ir_graph_pass_t *shape_blocks_pass(const char *name);
911 * Perform loop inversion on a given graph.
912 * Loop inversion transforms a head controlled loop (like while(...) {} and
913 * for(...) {}) into a foot controlled loop (do {} while(...)).
915 FIRM_API void do_loop_inversion(ir_graph *irg);
918 * Perform loop unrolling on a given graph.
919 * Loop unrolling multiplies the number loop completely by a number found
920 * through a heuristic.
922 FIRM_API void do_loop_unrolling(ir_graph *irg);
925 * Perform loop peeling on a given graph.
927 FIRM_API void do_loop_peeling(ir_graph *irg);
930 * Creates an ir_graph pass for loop inversion.
932 * @param name the name of this pass or NULL
934 * @return the newly created ir_graph pass
936 FIRM_API ir_graph_pass_t *loop_inversion_pass(const char *name);
939 * Creates an ir_graph pass for loop unrolling.
941 * @param name the name of this pass or NULL
943 * @return the newly created ir_graph pass
945 FIRM_API ir_graph_pass_t *loop_unroll_pass(const char *name);
948 * Creates an ir_graph pass for loop peeling.
950 * @param name the name of this pass or NULL
952 * @return the newly created ir_graph pass
954 FIRM_API ir_graph_pass_t *loop_peeling_pass(const char *name);
956 typedef ir_type *(*get_Alloc_func)(ir_node *n);
957 /** Set a new get_Alloc_func and returns the old one. */
958 FIRM_API get_Alloc_func firm_set_Alloc_func(get_Alloc_func newf);
961 * Creates an ir_graph pass for set_vrp_data()
963 * @param name The name of this pass or NULL
965 * @return the newly created ir_graph pass
967 FIRM_API ir_graph_pass_t *set_vrp_pass(const char *name);
970 * Removes all entities which are unused.
972 * Unused entities have ir_visibility_local and are not used directly or
973 * indirectly through entities/code visible outside the compilation unit.
974 * This is usually conservative than gc_irgs, but does not respect properties
975 * of object-oriented programs.
977 FIRM_API void garbage_collect_entities(void);
979 /** Pass for garbage_collect_entities */
980 FIRM_API ir_prog_pass_t *garbage_collect_entities_pass(const char *name);
983 * Performs dead node elimination by copying the ir graph to a new obstack.
985 * The major intention of this pass is to free memory occupied by
986 * dead nodes and outdated analyzes information. Further this
987 * function removes Bad predecessors from Blocks and the corresponding
988 * inputs to Phi nodes. This opens optimization potential for other
989 * optimizations. Further this phase reduces dead Block<->Jmp
990 * self-cycles to Bad nodes.
992 * Dead_node_elimination is only performed if options `optimize' and
993 * `opt_dead_node_elimination' are set. The graph may
994 * not be in state phase_building. The outs datasturcture is freed,
995 * the outs state set to outs_none. Backedge information is conserved.
996 * Removes old attributes of nodes. Sets link field to NULL.
997 * Callee information must be freed (irg_callee_info_none).
999 * @param irg The graph to be optimized.
1001 FIRM_API void dead_node_elimination(ir_graph *irg);
1004 * Creates an ir_graph pass for dead_node_elimination().
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 *dead_node_elimination_pass(const char *name);
1013 * Inlines a method at the given call site.
1015 * Removes the call node and splits the basic block the call node
1016 * belongs to. Inserts a copy of the called graph between these nodes.
1017 * Assumes that call is a Call node in current_ir_graph and that
1018 * the type in the Call nodes type attribute is the same as the
1019 * type of the called graph.
1020 * Further it assumes that all Phi nodes in a block of current_ir_graph
1021 * are assembled in a "link" list in the link field of the corresponding
1022 * block nodes. Further assumes that all Proj nodes are in a "link" list
1023 * in the nodes producing the tuple. (This is only an optical feature
1024 * for the graph.) Conserves this feature for the old
1025 * nodes of the graph. This precondition can be established by a call to
1026 * collect_phisprojs(), see irgmod.h.
1027 * As dead_node_elimination this function reduces dead Block<->Jmp
1028 * self-cycles to Bad nodes.
1030 * Called_graph must be unequal to current_ir_graph. Will not inline
1031 * if they are equal.
1032 * Sets visited masterflag in current_ir_graph to the max of the flag in
1033 * current and called graph.
1034 * Assumes that both, the called and the calling graph are in state
1035 * "op_pin_state_pinned".
1036 * It is recommended to call local_optimize_graph() after inlining as this
1037 * function leaves a set of obscure Tuple nodes, e.g. a Proj-Tuple-Jmp
1038 * combination as control flow operation.
1040 * @param call the call node that should be inlined
1041 * @param called_graph the IR-graph that is called at call
1043 * @return zero if method could not be inlined (recursion for instance),
1044 * non-zero if all went ok
1046 FIRM_API int inline_method(ir_node *call, ir_graph *called_graph);
1051 * Pins all floating nodes to a block where they
1052 * will be executed only if needed. Depends on the flag opt_global_cse.
1053 * Graph may not be in phase_building. Does not schedule control dead
1054 * code. Uses dominator information which it computes if the irg is not
1055 * in state dom_consistent. Destroys the out information as it moves nodes
1056 * to other blocks. Optimizes Tuples in Control edges.
1058 * Call remove_critical_cf_edges() before place_code(). This normalizes
1059 * the control flow graph so that for all operations a basic block exists
1060 * where they can be optimally placed.
1062 FIRM_API void place_code(ir_graph *irg);
1065 * Creates an ir_graph pass for place_code().
1066 * This pass enables GCSE, runs optimize_graph_df() and finally
1069 * @param name the name of this pass or NULL
1071 * @return the newly created ir_graph pass
1073 FIRM_API ir_graph_pass_t *place_code_pass(const char *name);
1076 * Determine information about the values of nodes and perform simplications
1077 * using this information. This optimization performs a data-flow analysis to
1078 * find the minimal fixpoint.
1080 FIRM_API void fixpoint_vrp(ir_graph*);
1083 * Creates an ir_graph pass for fixpoint_vrp().
1084 * This pass dDetermines information about the values of nodes
1085 * and perform simplications using this information.
1086 * This optimization performs a data-flow analysis to
1087 * find the minimal fixpoint.
1089 * @param name the name of this pass or NULL
1091 * @return the newly created ir_graph pass
1093 FIRM_API ir_graph_pass_t *fixpoint_vrp_irg_pass(const char *name);