2 * Copyright (C) 1995-2010 University of Karlsruhe. All right reserved.
4 * This file is part of libFirm.
6 * This file may be distributed and/or modified under the terms of the
7 * GNU General Public License version 2 as published by the Free Software
8 * Foundation and appearing in the file LICENSE.GPL included in the
9 * packaging of this file.
11 * Licensees holding valid libFirm Professional Edition licenses may use
12 * this file in accordance with the libFirm Commercial License.
13 * Agreement provided with the Software.
15 * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
16 * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22 * @brief Available Optimisations of libFirm.
25 #ifndef FIRM_IROPTIMIZE_H
26 #define FIRM_IROPTIMIZE_H
28 #include "firm_types.h"
33 * Control flow optimization.
35 * Removes empty blocks doing if simplifications and loop simplifications.
36 * A block is empty if it contains only a Jmp node and Phi nodes.
37 * Merges single entry single exit blocks with their predecessor
38 * and propagates dead control flow by calling equivalent_node().
39 * Independent of compiler flag it removes Tuples from cf edges,
40 * Bad predecessors from Blocks and Phis, and unnecessary predecessors of End.
41 * Destroys backedge information.
43 * @bug Chokes on Id nodes if called in a certain order with other
44 * optimizations. Call local_optimize_graph() before to remove
47 FIRM_API void optimize_cf(ir_graph *irg);
50 * Creates an ir_graph pass for optimize_cf().
52 * @param name the name of this pass or NULL
54 * @return the newly created ir_graph pass
56 FIRM_API ir_graph_pass_t *optimize_cf_pass(const char *name);
59 * Perform path-sensitive jump threading on the given graph.
61 * @param irg the graph
63 FIRM_API void opt_jumpthreading(ir_graph* irg);
66 * Creates an ir_graph pass for opt_jumpthreading().
68 * @param name the name of this pass or NULL
70 * @return the newly created ir_graph pass
72 FIRM_API ir_graph_pass_t *opt_jumpthreading_pass(const char *name);
75 * Try to simplify boolean expression in the given ir graph.
76 * eg. x < 5 && x < 6 becomes x < 5
78 * @param irg the graph
80 FIRM_API void opt_bool(ir_graph *irg);
83 * Creates an ir_graph pass for opt_bool().
85 * @param name the name of this pass or NULL
87 * @return the newly created ir_graph pass
89 FIRM_API ir_graph_pass_t *opt_bool_pass(const char *name);
92 * Try to reduce the number of conv nodes in the given ir graph.
94 * @param irg the graph
96 * @return non-zero if the optimization could be applied, 0 else
98 FIRM_API int conv_opt(ir_graph *irg);
101 * Creates an ir_graph pass for conv_opt().
103 * @param name the name of this pass or NULL
105 * @return the newly created ir_graph pass
107 FIRM_API ir_graph_pass_t *conv_opt_pass(const char *name);
110 * A callback that checks whether a entity is an allocation
113 typedef int (*check_alloc_entity_func)(ir_entity *ent);
116 * Do simple and fast escape analysis for one graph.
118 * @param irg the graph
119 * @param callback a callback function to check whether a
120 * given entity is a allocation call
122 FIRM_API void escape_enalysis_irg(ir_graph *irg,
123 check_alloc_entity_func callback);
126 * Do simple and fast escape analysis for all graphs.
128 * This optimization implements a simple and fast but inexact
129 * escape analysis. Some addresses might be marked as 'escaped' even
131 * The advantage is a low memory footprint and fast speed.
133 * @param run_scalar_replace if this flag in non-zero, scalar
134 * replacement optimization is run on graphs with removed
136 * @param callback a callback function to check whether a
137 * given entity is a allocation call
139 * This optimization removes allocation which are not used (rare) and replace
140 * allocation that can be proved dead at the end of the graph which stack variables.
142 * The creation of stack variable allows scalar replacement to be run only
143 * on those graphs that have been changed.
145 * This is most effective on Java where no other stack variables exists.
147 FIRM_API void escape_analysis(int run_scalar_replace,
148 check_alloc_entity_func callback);
151 * Optimize function calls by handling const functions.
153 * This optimization first detects all "const functions", i.e.,
154 * IR graphs that neither read nor write memory (and hence did
155 * not create exceptions, as these use memory in Firm).
157 * The result of calls to such functions depends only on its
158 * arguments, hence those calls are no more pinned.
160 * This is a rather strong criteria, so do not expect that a
161 * lot of functions will be found. Moreover, all of them might
162 * already be inlined if inlining is activated.
163 * Anyway, it might be good for handling builtin's
164 * even if the later read/write memory (but we know how).
166 * This optimizations read the irg_const_function property of
167 * entities and and sets the irg_const_function property of
170 * If callee information is valid, we also optimize polymorphic Calls.
172 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 /* FirmJNI cannot handle identical enum values... */
362 /** default setting */
363 #define osr_flag_default osr_flag_lftr_with_ov_check
366 * Do the Operator Scalar Replacement optimization and linear
367 * function test replacement for loop control.
368 * Can be switched off using the set_opt_strength_red() flag.
369 * In that case, only remove_phi_cycles() is executed.
371 * @param irg the graph which should be optimized
372 * @param flags set of osr_flags
374 * The linear function replacement test is controlled by the flags.
375 * If the osr_flag_lftr_with_ov_check is set, the replacement is only
376 * done if do overflow can occur.
377 * Otherwise it is ALWAYS done which might be insecure.
381 * for (i = 0; i < 100; ++i)
383 * might be replaced by
385 * for (i = 0; i < 400; i += 4)
389 * for (i = 0; i < 0x7FFFFFFF; ++i)
391 * will not be replaced by
393 * for (i = 0; i < 0xFFFFFFFC; i += 4)
395 * because of overflow.
399 * for (i = 0; i <= 0xF; ++i)
401 * will NOT be transformed into
403 * for (i = 0xFFFFFFF0; i <= 0xFFFFFFFF; ++i)
405 * although here is no direct overflow. The OV occurs when the ++i
406 * is executed (and would created an endless loop here!).
408 * For the same reason, a loop
410 * for (i = 0; i <= 9; i += x)
412 * will NOT be transformed because we cannot estimate whether an overflow
413 * might happen adding x.
415 * Note that i < a + 400 is also not possible with the current implementation
416 * although this might be allowed by other compilers...
418 * Note further that tests for equality can be handled some simpler (but are not
421 * This algorithm destroys the link field of nodes.
423 FIRM_API void opt_osr(ir_graph *irg, unsigned flags);
426 * Creates an ir_graph pass for remove_phi_cycles().
428 * @param name the name of this pass or NULL
429 * @param flags set of osr_flags
431 * @return the newly created ir_graph pass
433 FIRM_API ir_graph_pass_t *opt_osr_pass(const char *name, unsigned flags);
436 * Removes useless Phi cycles, i.e cycles of Phi nodes with only one
438 * This is automatically done in opt_osr(), so there is no need to call it
441 * @param irg the graph which should be optimized
443 * This algorithm destroys the link field of nodes.
445 FIRM_API void remove_phi_cycles(ir_graph *irg);
448 * Creates an ir_graph pass for remove_phi_cycles().
450 * @param name the name of this pass or NULL
452 * @return the newly created ir_graph pass
454 FIRM_API ir_graph_pass_t *remove_phi_cycles_pass(const char *name);
457 /** A default threshold. */
458 #define DEFAULT_CLONE_THRESHOLD 20
461 * Do procedure cloning. Evaluate a heuristic weight for every
462 * Call(..., Const, ...). If the weight is bigger than threshold,
463 * clone the entity and fix the calls.
465 * @param threshold the threshold for cloning
467 * The threshold is an estimation of how many instructions are saved
468 * when executing a cloned method. If threshold is 0.0, every possible
471 FIRM_API void proc_cloning(float threshold);
474 * Creates an ir_prog pass for proc_cloning().
476 * @param name the name of this pass or NULL
477 * @param threshold the threshold for cloning
479 * @return the newly created ir_prog pass
481 FIRM_API ir_prog_pass_t *proc_cloning_pass(const char *name, float threshold);
486 * Applies Reassociation rules to integer expressions.
487 * Beware: Works only if integer overflow might be ignored, as for C, Java
488 * and for address expression.
489 * Works only if Constant folding is activated.
491 * Uses loop information to detect loop-invariant (i.e. contant
492 * inside the loop) values.
494 * See Muchnik 12.3.1 Algebraic Simplification and Reassociation of
495 * Addressing Expressions.
497 * @return non-zero if the optimization could be applied, 0 else
499 FIRM_API int optimize_reassociation(ir_graph *irg);
502 * Creates an ir_graph pass for optimize_reassociation().
504 * @param name the name of this pass or NULL
506 * @return the newly created ir_graph pass
508 FIRM_API ir_graph_pass_t *optimize_reassociation_pass(const char *name);
511 * Normalize the Returns of a graph by creating a new End block
512 * with One Return(Phi).
513 * This is the preferred input for the if-conversion.
515 * In pseudocode, it means:
522 * is transformed into
530 FIRM_API void normalize_one_return(ir_graph *irg);
533 * Creates an ir_graph pass for normalize_one_return().
535 * @param name the name of this pass or NULL
537 * @return the newly created ir_graph pass
539 FIRM_API ir_graph_pass_t *normalize_one_return_pass(const char *name);
542 * Normalize the Returns of a graph by moving
543 * the Returns upwards as much as possible.
544 * This might be preferred for code generation.
546 * In pseudocode, it means:
554 * is transformed into
561 FIRM_API void normalize_n_returns(ir_graph *irg);
564 * Creates an ir_graph pass for normalize_n_returns().
566 * @param name the name of this pass or NULL
568 * @return the newly created ir_graph pass
570 FIRM_API ir_graph_pass_t *normalize_n_returns_pass(const char *name);
573 * Do the scalar replacement optimization.
574 * Replace local compound entities (like structures and arrays)
575 * with atomic values if possible. Does not handle classes yet.
577 * @param irg the graph which should be optimized
579 * @return non-zero, if at least one entity was replaced
581 FIRM_API int scalar_replacement_opt(ir_graph *irg);
584 * Creates an ir_graph pass for scalar_replacement_opt().
586 * @param name the name of this pass or NULL
588 * @return the newly created ir_graph pass
590 FIRM_API ir_graph_pass_t *scalar_replacement_opt_pass(const char *name);
593 * Optimizes tail-recursion calls by converting them into loops.
594 * Depends on the flag opt_tail_recursion.
595 * Currently supports the following forms:
597 * - return x + func();
598 * - return func() - x;
599 * - return x * func();
602 * Does not work for Calls that use the exception stuff.
604 * @param irg the graph to be optimized
606 * @return non-zero if the optimization could be applied, 0 else
608 FIRM_API int opt_tail_rec_irg(ir_graph *irg);
611 * Creates an ir_graph pass for opt_tail_rec_irg().
613 * @param name the name of this pass or NULL
615 * @return the newly created ir_graph pass
617 FIRM_API ir_graph_pass_t *opt_tail_rec_irg_pass(const char *name);
620 * Optimize tail-recursion calls for all IR-Graphs.
621 * Can currently handle:
622 * - direct return value, i.e. return func().
623 * - additive return value, i.e. return x +/- func()
624 * - multiplicative return value, i.e. return x * func() or return -func()
626 * The current implementation must be run before optimize_funccalls(),
627 * because it expects the memory edges pointing to calls, which might be
628 * removed by optimize_funccalls().
630 FIRM_API void opt_tail_recursion(void);
633 * Creates an ir_prog pass for opt_tail_recursion().
635 * @param name the name of this pass or NULL
637 * @return the newly created ir_prog pass
639 FIRM_API ir_prog_pass_t *opt_tail_recursion_pass(const char *name);
641 /** This is the type for a method, that returns a pointer type to
642 * tp. This is needed in the normalization. */
643 typedef ir_type *(*gen_pointer_type_to_func)(ir_type *tp);
645 /** Insert Casts so that class type casts conform exactly with the type hierarchy.
647 * Formulated in Java, this achieves the following:
649 * For a class hierarchy
651 * class B extends A {}
652 * class C extends B {}
653 * we transforms a cast
658 * The algorithm works for Casts with class types, but also for Casts
659 * with all pointer types that point (over several indirections,
660 * i.e. ***A) to a class type. Normalizes all graphs. Computes type
661 * information (@see irtypeinfo.h) if not available.
662 * Invalidates trout information as new casts are generated.
664 * @param gppt_fct A function that returns a pointer type that points
665 * to the type given as argument. If this parameter is NULL, a default
666 * function is used that either uses trout information or performs a O(n)
667 * search to find an existing pointer type. If it can not find a type,
668 * generates a pointer type with mode_P_mach and suffix "cc_ptr_tp".
670 FIRM_API void normalize_irp_class_casts(gen_pointer_type_to_func gppt_fct);
672 /** Insert Casts so that class type casts conform exactly with the type hierarchy
675 * For more details see normalize_irp_class_casts().
677 * This transformation requires that type information is computed. @see irtypeinfo.h.
679 FIRM_API void normalize_irg_class_casts(ir_graph *irg,
680 gen_pointer_type_to_func gppt_fct);
682 /** Optimize casting between class types.
685 * class B extends A { }
686 * class C extends B {}
687 * Performs the following transformations:
688 * C c = (C)(B)(A)(B)new C() --> C c = (C)(B)newC() --> C c = new C()
689 * (Optimizing downcasts as A a = (A)(B)(new A()) --> A a = new A() can
690 * be suppressed by setting the flag opt_suppress_downcast_optimization.
691 * Downcasting A to B might cause an exception. It is not clear
692 * whether this is modeled by the Firm Cast node, as it has no exception
694 * If there is inh_m() that overwrites m() in B:
695 * ((A) new B()).m() --> (new B()).inh_m()
696 * Phi((A)x, (A)y) --> (A) Phi (x, y) if (A) is an upcast.
698 * Computes type information if not available. @see irtypeinfo.h.
699 * Typeinformation is valid after optimization.
700 * Invalidates trout information.
702 FIRM_API void optimize_class_casts(void);
705 * CLiff Click's combo algorithm from
706 * "Combining Analyses, combining Optimizations".
708 * Does conditional constant propagation, unreachable code elimination and
709 * optimistic global value numbering at once.
711 * @param irg the graph to run on
713 FIRM_API void combo(ir_graph *irg);
716 * Creates an ir_graph pass for combo.
718 * @param name the name of this pass or NULL
720 * @return the newly created ir_graph pass
722 FIRM_API ir_graph_pass_t *combo_pass(const char *name);
725 * Inlines all small methods at call sites where the called address comes
726 * from a SymConst node that references the entity representing the called
729 * @param irg the graph
730 * @param size maximum function size
732 * The size argument is a rough measure for the code size of the method:
733 * Methods where the obstack containing the firm graph is smaller than
734 * size are inlined. Further only a limited number of calls are inlined.
735 * If the method contains more than 1024 inlineable calls none will be
737 * Inlining is only performed if flags `optimize' and `inlining' are set.
738 * The graph may not be in state phase_building.
739 * It is recommended to call local_optimize_graph() after inlining as this
740 * function leaves a set of obscure Tuple nodes, e.g. a Proj-Tuple-Jmp
741 * combination as control flow operation.
743 FIRM_API void inline_small_irgs(ir_graph *irg, int size);
746 * Creates an ir_graph pass for inline_small_irgs().
748 * @param name the name of this pass or NULL
749 * @param size maximum function size
751 * @return the newly created ir_graph pass
753 FIRM_API ir_graph_pass_t *inline_small_irgs_pass(const char *name, int size);
756 * Inlineing with a different heuristic than inline_small_irgs().
758 * Inlines leave functions. If inlining creates new leave
759 * function inlines these, too. (If g calls f, and f calls leave h,
760 * h is first inlined in f and then f in g.)
762 * Then inlines all small functions (this is not recursive).
764 * For a heuristic this inlining uses firm node counts. It does
765 * not count auxiliary nodes as Proj, Tuple, End, Start, Id, Sync.
766 * If the ignore_runtime flag is set, calls to functions marked with the
767 * mtp_property_runtime property are ignored.
769 * @param maxsize Do not inline any calls if a method has more than
770 * maxsize firm nodes. It may reach this limit by
772 * @param leavesize Inline leave functions if they have less than leavesize
774 * @param size Inline all function smaller than size.
775 * @param ignore_runtime count a function only calling runtime functions as
778 FIRM_API void inline_leave_functions(unsigned maxsize, unsigned leavesize,
779 unsigned size, int ignore_runtime);
782 * Creates an ir_prog pass for inline_leave_functions().
784 * @param name the name of this pass or NULL
785 * @param maxsize Do not inline any calls if a method has more than
786 * maxsize firm nodes. It may reach this limit by
788 * @param leavesize Inline leave functions if they have less than leavesize
790 * @param size Inline all function smaller than size.
791 * @param ignore_runtime count a function only calling runtime functions as
794 * @return the newly created ir_prog pass
796 FIRM_API ir_prog_pass_t *inline_leave_functions_pass(const char *name,
797 unsigned maxsize, unsigned leavesize, unsigned size,
800 typedef void (*opt_ptr)(ir_graph *irg);
803 * Heuristic inliner. Calculates a benefice value for every call and inlines
804 * those calls with a value higher than the threshold.
806 * @param maxsize Do not inline any calls if a method has more than
807 * maxsize firm nodes. It may reach this limit by
809 * @param inline_threshold inlining threshold
810 * @param after_inline_opt optimizations performed immediately after inlining
813 FIRM_API void inline_functions(unsigned maxsize, int inline_threshold,
814 opt_ptr after_inline_opt);
817 * Creates an ir_prog pass for inline_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 inline_threshold inlining threshold
824 * @param after_inline_opt a function that is called after inlining a
825 * procedure. You should run fast local optimisations
826 * here which cleanup the graph before further
829 * @return the newly created ir_prog pass
831 FIRM_API ir_prog_pass_t *inline_functions_pass(const char *name,
832 unsigned maxsize, int inline_threshold, opt_ptr after_inline_opt);
835 * Combines congruent blocks into one.
837 * @param irg The IR-graph to optimize.
839 * @return non-zero if the graph was transformed
841 FIRM_API int shape_blocks(ir_graph *irg);
844 * Creates an ir_graph pass for shape_blocks().
846 * @param name the name of this pass or NULL
848 * @return the newly created ir_graph pass
850 FIRM_API ir_graph_pass_t *shape_blocks_pass(const char *name);
853 * Perform loop inversion on a given graph.
854 * Loop inversion transforms a head controlled loop (like while(...) {} and
855 * for(...) {}) into a foot controlled loop (do {} while(...)).
857 FIRM_API void do_loop_inversion(ir_graph *irg);
860 * Perform loop unrolling on a given graph.
861 * Loop unrolling multiplies the number loop completely by a number found
862 * through a heuristic.
864 FIRM_API void do_loop_unrolling(ir_graph *irg);
867 * Perform loop peeling on a given graph.
869 FIRM_API void do_loop_peeling(ir_graph *irg);
872 * Creates an ir_graph pass for loop inversion.
874 * @param name the name of this pass or NULL
876 * @return the newly created ir_graph pass
878 FIRM_API ir_graph_pass_t *loop_inversion_pass(const char *name);
881 * Creates an ir_graph pass for loop unrolling.
883 * @param name the name of this pass or NULL
885 * @return the newly created ir_graph pass
887 FIRM_API ir_graph_pass_t *loop_unroll_pass(const char *name);
890 * Creates an ir_graph pass for loop peeling.
892 * @param name the name of this pass or NULL
894 * @return the newly created ir_graph pass
896 FIRM_API ir_graph_pass_t *loop_peeling_pass(const char *name);
898 typedef ir_type *(*get_Alloc_func)(ir_node *n);
899 /** Set a new get_Alloc_func and returns the old one. */
900 FIRM_API get_Alloc_func firm_set_Alloc_func(get_Alloc_func newf);
903 * Creates an ir_graph pass for set_vrp_data()
905 * @param name The name of this pass or NULL
907 * @return the newly created ir_graph pass
909 FIRM_API ir_graph_pass_t *set_vrp_pass(const char *name);
912 * Removes all entities which are unused.
914 * Unused entities have ir_visibility_local and are not used directly or
915 * indirectly through entities/code visible outside the compilation unit.
916 * This is usually conservative than gc_irgs, but does not respect properties
917 * of object-oriented programs.
919 FIRM_API void garbage_collect_entities(void);
921 /** Pass for garbage_collect_entities */
922 FIRM_API ir_prog_pass_t *garbage_collect_entities_pass(const char *name);
925 * Performs dead node elimination by copying the ir graph to a new obstack.
927 * The major intention of this pass is to free memory occupied by
928 * dead nodes and outdated analyzes information. Further this
929 * function removes Bad predecessors from Blocks and the corresponding
930 * inputs to Phi nodes. This opens optimization potential for other
931 * optimizations. Further this phase reduces dead Block<->Jmp
932 * self-cycles to Bad nodes.
934 * Dead_node_elimination is only performed if options `optimize' and
935 * `opt_dead_node_elimination' are set. The graph may
936 * not be in state phase_building. The outs datastructure is freed,
937 * the outs state set to outs_none. Backedge information is conserved.
938 * Removes old attributes of nodes. Sets link field to NULL.
939 * Callee information must be freed (irg_callee_info_none).
941 * @param irg The graph to be optimized.
943 FIRM_API void dead_node_elimination(ir_graph *irg);
946 * Creates an ir_graph pass for dead_node_elimination().
948 * @param name the name of this pass or NULL
950 * @return the newly created ir_graph pass
952 FIRM_API ir_graph_pass_t *dead_node_elimination_pass(const char *name);
955 * Inlines a method at the given call site.
957 * Removes the call node and splits the basic block the call node
958 * belongs to. Inserts a copy of the called graph between these nodes.
959 * Assumes that call is a Call node in current_ir_graph and that
960 * the type in the Call nodes type attribute is the same as the
961 * type of the called graph.
962 * Further it assumes that all Phi nodes in a block of current_ir_graph
963 * are assembled in a "link" list in the link field of the corresponding
964 * block nodes. Further assumes that all Proj nodes are in a "link" list
965 * in the nodes producing the tuple. (This is only an optical feature
966 * for the graph.) Conserves this feature for the old
967 * nodes of the graph. This precondition can be established by a call to
968 * collect_phisprojs(), see irgmod.h.
969 * As dead_node_elimination this function reduces dead Block<->Jmp
970 * self-cycles to Bad nodes.
972 * Called_graph must be unequal to current_ir_graph. Will not inline
974 * Sets visited masterflag in current_ir_graph to the max of the flag in
975 * current and called graph.
976 * Assumes that both, the called and the calling graph are in state
977 * "op_pin_state_pinned".
978 * It is recommended to call local_optimize_graph() after inlining as this
979 * function leaves a set of obscure Tuple nodes, e.g. a Proj-Tuple-Jmp
980 * combination as control flow operation.
982 * @param call the call node that should be inlined
983 * @param called_graph the IR-graph that is called at call
985 * @return zero if method could not be inlined (recursion for instance),
986 * non-zero if all went ok
988 FIRM_API int inline_method(ir_node *call, ir_graph *called_graph);
993 * Pins all floating nodes to a block where they
994 * will be executed only if needed. Depends on the flag opt_global_cse.
995 * Graph may not be in phase_building. Does not schedule control dead
996 * code. Uses dominator information which it computes if the irg is not
997 * in state dom_consistent. Destroys the out information as it moves nodes
998 * to other blocks. Optimizes Tuples in Control edges.
1000 * Call remove_critical_cf_edges() before place_code(). This normalizes
1001 * the control flow graph so that for all operations a basic block exists
1002 * where they can be optimally placed.
1004 FIRM_API void place_code(ir_graph *irg);
1007 * Creates an ir_graph pass for place_code().
1008 * This pass enables GCSE, runs optimize_graph_df() and finally
1011 * @param name the name of this pass or NULL
1013 * @return the newly created ir_graph pass
1015 FIRM_API ir_graph_pass_t *place_code_pass(const char *name);
1018 * Determine information about the values of nodes and perform simplifications
1019 * using this information. This optimization performs a data-flow analysis to
1020 * find the minimal fixpoint.
1022 FIRM_API void fixpoint_vrp(ir_graph*);
1025 * Creates an ir_graph pass for fixpoint_vrp().
1026 * This pass dDetermines information about the values of nodes
1027 * and perform simplifications using this information.
1028 * This optimization performs a data-flow analysis to
1029 * find the minimal fixpoint.
1031 * @param name the name of this pass or NULL
1033 * @return the newly created ir_graph pass
1035 FIRM_API ir_graph_pass_t *fixpoint_vrp_irg_pass(const char *name);
1038 * Check, if the value of a node is != 0.
1040 * This is a often needed case, so we handle here Confirm
1043 * @param n a node representing the value
1044 * @param confirm if n is confirmed to be != 0, returns
1045 * the the Confirm-node, else NULL
1047 FIRM_API int value_not_zero(const ir_node *n, ir_node_cnst_ptr *confirm);
1050 * Check, if the value of a node cannot represent a NULL pointer.
1052 * - If option sel_based_null_check_elim is enabled, all
1053 * Sel nodes can be skipped.
1054 * - A SymConst(entity) is NEVER a NULL pointer
1055 * - A Const != NULL is NEVER a NULL pointer
1056 * - Confirms are evaluated
1058 * @param n a node representing the value
1059 * @param confirm if n is confirmed to be != NULL, returns
1060 * the the Confirm-node, else NULL
1062 FIRM_API int value_not_null(const ir_node *n, ir_node_cnst_ptr *confirm);
1065 * Check, if the value of a node can be confirmed >= 0 or <= 0,
1066 * If the mode of the value did not honor signed zeros, else
1067 * check for >= 0 or < 0.
1069 * @param n a node representing the value
1071 FIRM_API ir_value_classify_sign classify_value_sign(ir_node *n);
1074 * Return the value of a Cmp if one or both predecessors
1075 * are Confirm nodes.
1077 * @param cmp the compare node that will be evaluated
1078 * @param left the left operand of the Cmp
1079 * @param right the right operand of the Cmp
1080 * @param relation the compare relation
1082 FIRM_API ir_tarval *computed_value_Cmp_Confirm(
1083 const ir_node *cmp, ir_node *left, ir_node *right, ir_relation relation);
1085 typedef ir_entity *(*compilerlib_entity_creator_t)(ident *id, ir_type *mt);
1087 * Set the compilerlib entity creation callback that is used to create
1088 * compilerlib function entities.
1090 * @param cb the new compilerlib entity creation callback
1092 FIRM_API void set_compilerlib_entity_creator(compilerlib_entity_creator_t c);
1095 * Get the compilerlib entity creation callback.
1097 FIRM_API compilerlib_entity_creator_t get_compilerlib_entity_creator(void);
1100 * Construct the entity for a given function using the current compilerlib
1101 * entity creation callback.
1103 * @param id the identifier of the compilerlib function
1104 * @param mt the method type of the compilerlib function
1106 FIRM_API ir_entity *create_compilerlib_entity(ident *id, ir_type *mt);