2 * Copyright (C) 1995-2010 University of Karlsruhe. All right reserved.
4 * This file is part of libFirm.
6 * This file may be distributed and/or modified under the terms of the
7 * GNU General Public License version 2 as published by the Free Software
8 * Foundation and appearing in the file LICENSE.GPL included in the
9 * packaging of this file.
11 * Licensees holding valid libFirm Professional Edition licenses may use
12 * this file in accordance with the libFirm Commercial License.
13 * Agreement provided with the Software.
15 * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
16 * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22 * @brief Available Optimisations of libFirm.
24 #ifndef FIRM_IROPTIMIZE_H
25 #define FIRM_IROPTIMIZE_H
27 #include "firm_types.h"
32 * @defgroup iroptimize Transformations and Optimisations
37 * Control flow optimization.
39 * Removes empty blocks doing if simplifications and loop simplifications.
40 * A block is empty if it contains only a Jmp node and Phi nodes.
41 * Merges single entry single exit blocks with their predecessor
42 * and propagates dead control flow by calling equivalent_node().
43 * Independent of compiler flag it removes Tuples from cf edges,
44 * Bad predecessors from Blocks and Phis, and unnecessary predecessors of End.
45 * Destroys backedge information.
47 FIRM_API void optimize_cf(ir_graph *irg);
50 * Creates an ir_graph pass for optimize_cf().
52 * @param name the name of this pass or NULL
54 * @return the newly created ir_graph pass
56 FIRM_API ir_graph_pass_t *optimize_cf_pass(const char *name);
59 * Perform path-sensitive jump threading on the given graph.
61 * @param irg the graph
63 FIRM_API void opt_jumpthreading(ir_graph* irg);
66 * Creates an ir_graph pass for opt_jumpthreading().
68 * @param name the name of this pass or NULL
70 * @return the newly created ir_graph pass
72 FIRM_API ir_graph_pass_t *opt_jumpthreading_pass(const char *name);
75 * Simplifies boolean expression in the given ir graph.
76 * eg. x < 5 && x < 6 becomes x < 5
78 * @param irg the graph
80 FIRM_API void opt_bool(ir_graph *irg);
83 * Creates an ir_graph pass for opt_bool().
85 * @param name the name of this pass or NULL
87 * @return the newly created ir_graph pass
89 FIRM_API ir_graph_pass_t *opt_bool_pass(const char *name);
92 * Reduces the number of Conv nodes in the given ir graph.
94 * @param irg the graph
96 FIRM_API void conv_opt(ir_graph *irg);
99 * Creates an ir_graph pass for conv_opt().
101 * @param name the name of this pass or NULL
103 * @return the newly created ir_graph pass
105 FIRM_API ir_graph_pass_t *conv_opt_pass(const char *name);
108 * A callback that checks whether a entity is an allocation
111 typedef int (*check_alloc_entity_func)(ir_entity *ent);
114 * Performs simple and fast escape analysis for one graph.
116 * @param irg the graph
117 * @param callback a callback function to check whether a
118 * given entity is a allocation call
120 FIRM_API void escape_enalysis_irg(ir_graph *irg,
121 check_alloc_entity_func callback);
124 * Performs simple and fast escape analysis for all graphs.
126 * This optimization implements a simple and fast but inexact
127 * escape analysis. Some addresses might be marked as 'escaped' even
129 * The advantage is a low memory footprint and fast speed.
131 * @param run_scalar_replace if this flag in non-zero, scalar
132 * replacement optimization is run on graphs with removed
134 * @param callback a callback function to check whether a
135 * given entity is a allocation call
137 * This optimization removes allocation which are not used (rare) and replace
138 * allocation that can be proved dead at the end of the graph which stack variables.
140 * The creation of stack variable allows scalar replacement to be run only
141 * on those graphs that have been changed.
143 * This is most effective on Java where no other stack variables exists.
145 FIRM_API void escape_analysis(int run_scalar_replace,
146 check_alloc_entity_func callback);
149 * Optimize function calls by handling const functions.
151 * This optimization first detects all "const functions", i.e.,
152 * IR graphs that neither read nor write memory (and hence did
153 * not create exceptions, as these use memory in Firm).
155 * The result of calls to such functions depends only on its
156 * arguments, hence those calls are no more pinned.
158 * This is a rather strong criteria, so do not expect that a
159 * lot of functions will be found. Moreover, all of them might
160 * already be inlined if inlining is activated.
161 * Anyway, it might be good for handling builtin's
162 * even if the later read/write memory (but we know how).
164 * This optimizations read the irg_const_function property of
165 * entities and and sets the irg_const_function property of
168 * If callee information is valid, we also optimize polymorphic Calls.
170 FIRM_API void optimize_funccalls(void);
173 * Creates an ir_prog pass for optimize_funccalls().
175 * @param name the name of this pass or NULL
176 * @return the newly created ir_prog pass
178 FIRM_API ir_prog_pass_t *optimize_funccalls_pass(const char *name);
181 * Does Partial Redundancy Elimination combined with
182 * Global Value Numbering.
183 * Can be used to replace place_code() completely.
185 * Based on VanDrunen and Hosking 2004.
187 * @param irg the graph
189 FIRM_API void do_gvn_pre(ir_graph *irg);
192 * Creates an ir_graph pass for do_gvn_pre().
194 * @param name the name of this pass or NULL
196 * @return the newly created ir_graph pass
198 FIRM_API ir_graph_pass_t *do_gvn_pre_pass(const char *name);
201 * This function is called to evaluate, if a
202 * mux(@p sel, @p mux_false, @p mux_true) should be built for the current
204 * If it returns non-zero, a mux is created, else the code
206 * @param sel A selector of a Cond.
207 * @param phi_list phi node to be converted
208 * @param i First data predecessor involved in if conversion
209 * @param j Second data predecessor involved in if conversion
211 typedef int (*arch_allow_ifconv_func)(ir_node *sel, ir_node *mux_false,
215 * Perform If conversion on a graph.
217 * @param irg The graph.
219 * Cannot handle blocks with Bad control predecessors, so call it after control
222 FIRM_API void opt_if_conv(ir_graph *irg);
225 * Creates an ir_graph pass for opt_if_conv().
227 * @param name the name of this pass or NULL
229 * @return the newly created ir_graph pass
231 FIRM_API ir_graph_pass_t *opt_if_conv_pass(const char *name);
234 * Tries to reduce dependencies for memory nodes where possible by parallelizing
235 * them and synchronizing with Sync nodes
236 * @param irg the graph where memory operations should be parallelized
238 FIRM_API void opt_parallelize_mem(ir_graph *irg);
241 * Creates an ir_graph pass for opt_sync().
243 * @param name the name of this pass or NULL
245 * @return the newly created ir_graph pass
247 FIRM_API ir_graph_pass_t *opt_parallelize_mem_pass(const char *name);
250 * Check if we can replace the load by a given const from
251 * the const code irg.
253 * @param load the load to replace
254 * @param c the constant
256 * @return in the modes match or can be transformed using a reinterpret cast
257 * returns a copy of the constant (possibly Conv'ed) on the
260 FIRM_API ir_node *can_replace_load_by_const(const ir_node *load, ir_node *c);
263 * Load/Store optimization.
265 * Removes redundant non-volatile Loads and Stores.
266 * May introduce Bad nodes if exceptional control flow
267 * is removed. The following cases are optimized:
269 * Load without result: A Load which has only a memory use
272 * Load after Store: A Load after a Store is removed, if
273 * the Load doesn't have an exception handler OR is in
274 * the same block as the Store.
276 * Load after Load: A Load after a Load is removed, if the
277 * Load doesn't have an exception handler OR is in the
278 * same block as the previous Load.
280 * Store before Store: A Store immediately before another
281 * Store in the same block is removed, if the Store doesn't
282 * have an exception handler.
284 * Store after Load: A Store after a Load is removed, if the
285 * Store doesn't have an exception handler.
287 FIRM_API void optimize_load_store(ir_graph *irg);
290 * Creates an ir_graph pass for optimize_load_store().
292 * @param name the name of this pass or NULL
294 * @return the newly created ir_graph pass
296 FIRM_API ir_graph_pass_t *optimize_load_store_pass(const char *name);
299 * New experimental alternative to optimize_load_store.
300 * Based on a dataflow analysis, so load/stores are moved out of loops
303 FIRM_API void opt_ldst(ir_graph *irg);
306 * Creates an ir_graph pass for opt_ldst().
308 * @param name the name of this pass or NULL
310 * @return the newly created ir_graph pass
312 FIRM_API ir_graph_pass_t *opt_ldst_pass(const char *name);
315 * Optimize loops by peeling or unrolling them if beneficial.
317 * @param irg The graph whose loops will be processed
319 * This function did not change the graph, only its frame type.
320 * The layout state of the frame type will be set to layout_undefined
321 * if entities were removed.
323 FIRM_API void loop_optimization(ir_graph *irg);
326 * Optimize the frame type of an irg by removing
327 * never touched entities.
329 * @param irg The graph whose frame type will be optimized
331 * This function did not change the graph, only its frame type.
332 * The layout state of the frame type will be set to layout_undefined
333 * if entities were removed.
335 FIRM_API void opt_frame_irg(ir_graph *irg);
338 * Creates an ir_graph pass for opt_frame_irg().
340 * @param name the name of this pass or NULL
342 * @return the newly created ir_graph pass
344 FIRM_API ir_graph_pass_t *opt_frame_irg_pass(const char *name);
346 /** Possible flags for the Operator Scalar Replacement. */
347 typedef enum osr_flags {
348 osr_flag_none = 0, /**< no additional flags */
349 osr_flag_lftr_with_ov_check = 1, /**< do linear function test replacement
350 only if no overflow can occur. */
351 osr_flag_ignore_x86_shift = 2, /**< ignore Multiplications by 2, 4, 8 */
352 osr_flag_keep_reg_pressure = 4 /**< do NOT increase register pressure by introducing new
353 induction variables. */
356 /** default setting */
357 #define osr_flag_default osr_flag_lftr_with_ov_check
360 * Performs the Operator Scalar Replacement optimization and linear
361 * function test replacement for loop control.
362 * Can be switched off using the set_opt_strength_red() flag.
363 * In that case, only remove_phi_cycles() is executed.
365 * @param irg the graph which should be optimized
366 * @param flags set of osr_flags
368 * The linear function replacement test is controlled by the flags.
369 * If the osr_flag_lftr_with_ov_check is set, the replacement is only
370 * done if do overflow can occur.
371 * Otherwise it is ALWAYS done which might be insecure.
375 * for (i = 0; i < 100; ++i)
377 * might be replaced by
379 * for (i = 0; i < 400; i += 4)
383 * for (i = 0; i < 0x7FFFFFFF; ++i)
385 * will not be replaced by
387 * for (i = 0; i < 0xFFFFFFFC; i += 4)
389 * because of overflow.
393 * for (i = 0; i <= 0xF; ++i)
395 * will NOT be transformed into
397 * for (i = 0xFFFFFFF0; i <= 0xFFFFFFFF; ++i)
399 * although here is no direct overflow. The OV occurs when the ++i
400 * is executed (and would created an endless loop here!).
402 * For the same reason, a loop
404 * for (i = 0; i <= 9; i += x)
406 * will NOT be transformed because we cannot estimate whether an overflow
407 * might happen adding x.
409 * Note that i < a + 400 is also not possible with the current implementation
410 * although this might be allowed by other compilers...
412 * Note further that tests for equality can be handled some simpler (but are not
415 * This algorithm destroys the link field of nodes.
417 FIRM_API void opt_osr(ir_graph *irg, unsigned flags);
420 * Creates an ir_graph pass for remove_phi_cycles().
422 * @param name the name of this pass or NULL
423 * @param flags set of osr_flags
425 * @return the newly created ir_graph pass
427 FIRM_API ir_graph_pass_t *opt_osr_pass(const char *name, unsigned flags);
430 * Removes useless Phi cycles, i.e cycles of Phi nodes with only one
432 * This is automatically done in opt_osr(), so there is no need to call it
435 * @param irg the graph which should be optimized
437 * This algorithm destroys the link field of nodes.
439 FIRM_API void remove_phi_cycles(ir_graph *irg);
442 * Creates an ir_graph pass for remove_phi_cycles().
444 * @param name the name of this pass or NULL
446 * @return the newly created ir_graph pass
448 FIRM_API ir_graph_pass_t *remove_phi_cycles_pass(const char *name);
451 /** A default threshold. */
452 #define DEFAULT_CLONE_THRESHOLD 20
455 * Performs procedure cloning. Evaluate a heuristic weight for every
456 * Call(..., Const, ...). If the weight is bigger than threshold,
457 * clone the entity and fix the calls.
459 * @param threshold the threshold for cloning
461 * The threshold is an estimation of how many instructions are saved
462 * when executing a cloned method. If threshold is 0.0, every possible
465 FIRM_API void proc_cloning(float threshold);
468 * Creates an ir_prog pass for proc_cloning().
470 * @param name the name of this pass or NULL
471 * @param threshold the threshold for cloning
473 * @return the newly created ir_prog pass
475 FIRM_API ir_prog_pass_t *proc_cloning_pass(const char *name, float threshold);
480 * Applies Reassociation rules to integer expressions.
481 * Beware: Works only if integer overflow might be ignored, as for C, Java
482 * and for address expression.
483 * Works only if Constant folding is activated.
485 * Uses loop information to detect loop-invariant (i.e. contant
486 * inside the loop) values.
488 * See Muchnik 12.3.1 Algebraic Simplification and Reassociation of
489 * Addressing Expressions.
491 FIRM_API void optimize_reassociation(ir_graph *irg);
494 * Creates an ir_graph pass for optimize_reassociation().
496 * @param name the name of this pass or NULL
498 * @return the newly created ir_graph pass
500 FIRM_API ir_graph_pass_t *optimize_reassociation_pass(const char *name);
503 * Normalize the Returns of a graph by creating a new End block
504 * with One Return(Phi).
505 * This is the preferred input for the if-conversion.
507 * In pseudocode, it means:
514 * is transformed into
522 FIRM_API void normalize_one_return(ir_graph *irg);
525 * Creates an ir_graph pass for normalize_one_return().
527 * @param name the name of this pass or NULL
529 * @return the newly created ir_graph pass
531 FIRM_API ir_graph_pass_t *normalize_one_return_pass(const char *name);
534 * Normalize the Returns of a graph by moving
535 * the Returns upwards as much as possible.
536 * This might be preferred for code generation.
538 * In pseudocode, it means:
546 * is transformed into
553 FIRM_API void normalize_n_returns(ir_graph *irg);
556 * Creates an ir_graph pass for normalize_n_returns().
558 * @param name the name of this pass or NULL
560 * @return the newly created ir_graph pass
562 FIRM_API ir_graph_pass_t *normalize_n_returns_pass(const char *name);
565 * Performs the scalar replacement optimization.
566 * Replaces local compound entities (like structures and arrays)
567 * with atomic values if possible. Does not handle classes yet.
569 * @param irg the graph which should be optimized
571 FIRM_API void scalar_replacement_opt(ir_graph *irg);
574 * Creates an ir_graph pass for scalar_replacement_opt().
576 * @param name the name of this pass or NULL
578 * @return the newly created ir_graph pass
580 FIRM_API ir_graph_pass_t *scalar_replacement_opt_pass(const char *name);
583 * Optimizes tail-recursion calls by converting them into loops.
584 * Depends on the flag opt_tail_recursion.
585 * Currently supports the following forms:
587 * - return x + func();
588 * - return func() - x;
589 * - return x * func();
592 * Does not work for Calls that use the exception stuff.
594 * @param irg the graph to be optimized
596 FIRM_API void opt_tail_rec_irg(ir_graph *irg);
599 * Creates an ir_graph pass for opt_tail_rec_irg().
601 * @param name the name of this pass or NULL
603 * @return the newly created ir_graph pass
605 FIRM_API ir_graph_pass_t *opt_tail_rec_irg_pass(const char *name);
608 * Optimize tail-recursion calls for all IR-Graphs.
609 * Can currently handle:
610 * - direct return value, i.e. return func().
611 * - additive return value, i.e. return x +/- func()
612 * - multiplicative return value, i.e. return x * func() or return -func()
614 * The current implementation must be run before optimize_funccalls(),
615 * because it expects the memory edges pointing to calls, which might be
616 * removed by optimize_funccalls().
618 FIRM_API void opt_tail_recursion(void);
621 * Creates an ir_prog pass for opt_tail_recursion().
623 * @param name the name of this pass or NULL
625 * @return the newly created ir_prog pass
627 FIRM_API ir_prog_pass_t *opt_tail_recursion_pass(const char *name);
629 /** This is the type for a method, that returns a pointer type to
630 * tp. This is needed in the normalization. */
631 typedef ir_type *(*gen_pointer_type_to_func)(ir_type *tp);
633 /** Insert Casts so that class type casts conform exactly with the type hierarchy.
635 * Formulated in Java, this achieves the following:
637 * For a class hierarchy
639 * class B extends A {}
640 * class C extends B {}
641 * we transforms a cast
646 * The algorithm works for Casts with class types, but also for Casts
647 * with all pointer types that point (over several indirections,
648 * i.e. ***A) to a class type. Normalizes all graphs. Computes type
649 * information (@see irtypeinfo.h) if not available.
650 * Invalidates trout information as new casts are generated.
652 * @param gppt_fct A function that returns a pointer type that points
653 * to the type given as argument. If this parameter is NULL, a default
654 * function is used that either uses trout information or performs a O(n)
655 * search to find an existing pointer type. If it can not find a type,
656 * generates a pointer type with mode_P_mach and suffix "cc_ptr_tp".
658 FIRM_API void normalize_irp_class_casts(gen_pointer_type_to_func gppt_fct);
660 /** Insert Casts so that class type casts conform exactly with the type hierarchy
663 * For more details see normalize_irp_class_casts().
665 * This transformation requires that type information is computed. @see irtypeinfo.h.
667 FIRM_API void normalize_irg_class_casts(ir_graph *irg,
668 gen_pointer_type_to_func gppt_fct);
670 /** Optimize casting between class types.
673 * class B extends A { }
674 * class C extends B {}
675 * Performs the following transformations:
676 * C c = (C)(B)(A)(B)new C() --> C c = (C)(B)newC() --> C c = new C()
677 * (Optimizing downcasts as A a = (A)(B)(new A()) --> A a = new A() can
678 * be suppressed by setting the flag opt_suppress_downcast_optimization.
679 * Downcasting A to B might cause an exception. It is not clear
680 * whether this is modeled by the Firm Cast node, as it has no exception
682 * If there is inh_m() that overwrites m() in B:
683 * ((A) new B()).m() --> (new B()).inh_m()
684 * Phi((A)x, (A)y) --> (A) Phi (x, y) if (A) is an upcast.
686 * Computes type information if not available. @see irtypeinfo.h.
687 * Typeinformation is valid after optimization.
688 * Invalidates trout information.
690 FIRM_API void optimize_class_casts(void);
693 * CLiff Click's combo algorithm from
694 * "Combining Analyses, combining Optimizations".
696 * Does conditional constant propagation, unreachable code elimination and
697 * optimistic global value numbering at once.
699 * @param irg the graph to run on
701 FIRM_API void combo(ir_graph *irg);
704 * Creates an ir_graph pass for combo.
706 * @param name the name of this pass or NULL
708 * @return the newly created ir_graph pass
710 FIRM_API ir_graph_pass_t *combo_pass(const char *name);
713 * Inlines all small methods at call sites where the called address comes
714 * from a SymConst node that references the entity representing the called
717 * @param irg the graph
718 * @param size maximum function size
720 * The size argument is a rough measure for the code size of the method:
721 * Methods where the obstack containing the firm graph is smaller than
722 * size are inlined. Further only a limited number of calls are inlined.
723 * If the method contains more than 1024 inlineable calls none will be
725 * Inlining is only performed if flags `optimize' and `inlining' are set.
726 * The graph may not be in state phase_building.
727 * It is recommended to call local_optimize_graph() after inlining as this
728 * function leaves a set of obscure Tuple nodes, e.g. a Proj-Tuple-Jmp
729 * combination as control flow operation.
731 FIRM_API void inline_small_irgs(ir_graph *irg, int size);
734 * Creates an ir_graph pass for inline_small_irgs().
736 * @param name the name of this pass or NULL
737 * @param size maximum function size
739 * @return the newly created ir_graph pass
741 FIRM_API ir_graph_pass_t *inline_small_irgs_pass(const char *name, int size);
744 * Inlineing with a different heuristic than inline_small_irgs().
746 * Inlines leaf functions. If inlining creates new leafs
747 * function inlines these, too. (If g calls f, and f calls leaf h,
748 * h is first inlined in f and then f in g.)
750 * Then inlines all small functions (this is not recursive).
752 * For a heuristic this inlining uses firm node counts. It does
753 * not count auxiliary nodes as Proj, Tuple, End, Start, Id, Sync.
754 * If the ignore_runtime flag is set, calls to functions marked with the
755 * mtp_property_runtime property are ignored.
757 * @param maxsize Do not inline any calls if a method has more than
758 * maxsize firm nodes. It may reach this limit by
760 * @param leafsize Inline leaf functions if they have less than leafsize
762 * @param size Inline all function smaller than size.
763 * @param ignore_runtime count a function only calling runtime functions as
766 FIRM_API void inline_leaf_functions(unsigned maxsize, unsigned leafsize,
767 unsigned size, int ignore_runtime);
770 * Creates an ir_prog pass for inline_leaf_functions().
772 * @param name the name of this pass or NULL
773 * @param maxsize Do not inline any calls if a method has more than
774 * maxsize firm nodes. It may reach this limit by
776 * @param leafsize Inline leaf functions if they have less than leafsize
778 * @param size Inline all function smaller than size.
779 * @param ignore_runtime count a function only calling runtime functions as
782 * @return the newly created ir_prog pass
784 FIRM_API ir_prog_pass_t *inline_leaf_functions_pass(const char *name,
785 unsigned maxsize, unsigned leafsize, unsigned size,
788 /** pointer to an optimization function */
789 typedef void (*opt_ptr)(ir_graph *irg);
792 * Heuristic inliner. Calculates a benefice value for every call and inlines
793 * those calls with a value higher than the threshold.
795 * @param maxsize Do not inline any calls if a method has more than
796 * maxsize firm nodes. It may reach this limit by
798 * @param inline_threshold inlining threshold
799 * @param after_inline_opt optimizations performed immediately after inlining
802 FIRM_API void inline_functions(unsigned maxsize, int inline_threshold,
803 opt_ptr after_inline_opt);
806 * Creates an ir_prog pass for inline_functions().
808 * @param name the name of this pass or NULL
809 * @param maxsize Do not inline any calls if a method has more than
810 * maxsize firm nodes. It may reach this limit by
812 * @param inline_threshold inlining threshold
813 * @param after_inline_opt a function that is called after inlining a
814 * procedure. You should run fast local optimisations
815 * here which cleanup the graph before further
818 * @return the newly created ir_prog pass
820 FIRM_API ir_prog_pass_t *inline_functions_pass(const char *name,
821 unsigned maxsize, int inline_threshold, opt_ptr after_inline_opt);
824 * Combines congruent blocks into one.
826 * @param irg The IR-graph to optimize.
828 FIRM_API void shape_blocks(ir_graph *irg);
831 * Creates an ir_graph pass for shape_blocks().
833 * @param name the name of this pass or NULL
835 * @return the newly created ir_graph pass
837 FIRM_API ir_graph_pass_t *shape_blocks_pass(const char *name);
840 * Perform loop inversion on a given graph.
841 * Loop inversion transforms a head controlled loop (like while(...) {} and
842 * for(...) {}) into a foot controlled loop (do {} while(...)).
844 FIRM_API void do_loop_inversion(ir_graph *irg);
847 * Perform loop unrolling on a given graph.
848 * Loop unrolling multiplies the number loop completely by a number found
849 * through a heuristic.
851 FIRM_API void do_loop_unrolling(ir_graph *irg);
854 * Perform loop peeling on a given graph.
856 FIRM_API void do_loop_peeling(ir_graph *irg);
859 * Creates an ir_graph pass for loop inversion.
861 * @param name the name of this pass or NULL
863 * @return the newly created ir_graph pass
865 FIRM_API ir_graph_pass_t *loop_inversion_pass(const char *name);
868 * Creates an ir_graph pass for loop unrolling.
870 * @param name the name of this pass or NULL
872 * @return the newly created ir_graph pass
874 FIRM_API ir_graph_pass_t *loop_unroll_pass(const char *name);
877 * Creates an ir_graph pass for loop peeling.
879 * @param name the name of this pass or NULL
881 * @return the newly created ir_graph pass
883 FIRM_API ir_graph_pass_t *loop_peeling_pass(const char *name);
886 * Creates an ir_graph pass for set_vrp_data()
888 * @param name The name of this pass or NULL
890 * @return the newly created ir_graph pass
892 FIRM_API ir_graph_pass_t *set_vrp_pass(const char *name);
895 * Removes all entities which are unused.
897 * Unused entities have ir_visibility_local and are not used directly or
898 * indirectly through entities/code visible outside the compilation unit.
899 * This is usually conservative than gc_irgs, but does not respect properties
900 * of object-oriented programs.
902 FIRM_API void garbage_collect_entities(void);
904 /** Pass for garbage_collect_entities */
905 FIRM_API ir_prog_pass_t *garbage_collect_entities_pass(const char *name);
908 * Performs dead node elimination by copying the ir graph to a new obstack.
910 * The major intention of this pass is to free memory occupied by
911 * dead nodes and outdated analyzes information. Further this
912 * function removes Bad predecessors from Blocks and the corresponding
913 * inputs to Phi nodes. This opens optimization potential for other
914 * optimizations. Further this phase reduces dead Block<->Jmp
915 * self-cycles to Bad nodes.
917 * Dead_node_elimination is only performed if options `optimize' and
918 * `opt_dead_node_elimination' are set. The graph may
919 * not be in state phase_building. The outs datastructure is freed,
920 * the outs state set to outs_none. Backedge information is conserved.
921 * Removes old attributes of nodes. Sets link field to NULL.
922 * Callee information must be freed (irg_callee_info_none).
924 * @param irg The graph to be optimized.
926 FIRM_API void dead_node_elimination(ir_graph *irg);
929 * Creates an ir_graph pass for dead_node_elimination().
931 * @param name the name of this pass or NULL
933 * @return the newly created ir_graph pass
935 FIRM_API ir_graph_pass_t *dead_node_elimination_pass(const char *name);
938 * Inlines a method at the given call site.
940 * Removes the call node and splits the basic block the call node
941 * belongs to. Inserts a copy of the called graph between these nodes.
942 * Assumes that call is a Call node in current_ir_graph and that
943 * the type in the Call nodes type attribute is the same as the
944 * type of the called graph.
945 * Further it assumes that all Phi nodes in a block of current_ir_graph
946 * are assembled in a "link" list in the link field of the corresponding
947 * block nodes. Further assumes that all Proj nodes are in a "link" list
948 * in the nodes producing the tuple. (This is only an optical feature
949 * for the graph.) Conserves this feature for the old
950 * nodes of the graph. This precondition can be established by a call to
951 * collect_phisprojs(), see irgmod.h.
952 * As dead_node_elimination this function reduces dead Block<->Jmp
953 * self-cycles to Bad nodes.
955 * Called_graph must be unequal to current_ir_graph. Will not inline
957 * Sets visited masterflag in current_ir_graph to the max of the flag in
958 * current and called graph.
959 * Assumes that both, the called and the calling graph are in state
960 * "op_pin_state_pinned".
961 * It is recommended to call local_optimize_graph() after inlining as this
962 * function leaves a set of obscure Tuple nodes, e.g. a Proj-Tuple-Jmp
963 * combination as control flow operation.
965 * @param call the call node that should be inlined
966 * @param called_graph the IR-graph that is called at call
968 * @return zero if method could not be inlined (recursion for instance),
969 * non-zero if all went ok
971 FIRM_API int inline_method(ir_node *call, ir_graph *called_graph);
976 * Pins all floating nodes to a block where they
977 * will be executed only if needed. Depends on the flag opt_global_cse.
978 * Graph may not be in phase_building. Does not schedule control dead
979 * code. Uses dominator information which it computes if the irg is not
980 * in state dom_consistent. Destroys the out information as it moves nodes
981 * to other blocks. Optimizes Tuples in Control edges.
983 * Call remove_critical_cf_edges() before place_code(). This normalizes
984 * the control flow graph so that for all operations a basic block exists
985 * where they can be optimally placed.
987 FIRM_API void place_code(ir_graph *irg);
990 * Creates an ir_graph pass for place_code().
991 * This pass enables GCSE, runs optimize_graph_df() and finally
994 * @param name the name of this pass or NULL
996 * @return the newly created ir_graph pass
998 FIRM_API ir_graph_pass_t *place_code_pass(const char *name);
1001 * Determines information about the values of nodes and perform simplifications
1002 * using this information. This optimization performs a data-flow analysis to
1003 * find the minimal fixpoint.
1005 FIRM_API void fixpoint_vrp(ir_graph*);
1008 * Creates an ir_graph pass for fixpoint_vrp().
1009 * This pass dDetermines information about the values of nodes
1010 * and perform simplifications using this information.
1011 * This optimization performs a data-flow analysis to
1012 * find the minimal fixpoint.
1014 * @param name the name of this pass or NULL
1016 * @return the newly created ir_graph pass
1018 FIRM_API ir_graph_pass_t *fixpoint_vrp_irg_pass(const char *name);
1021 * Checks if the value of a node is != 0.
1023 * This is a often needed case, so we handle here Confirm
1026 * @param n a node representing the value
1027 * @param confirm if n is confirmed to be != 0, returns
1028 * the the Confirm-node, else NULL
1030 FIRM_API int value_not_zero(const ir_node *n, const ir_node **confirm);
1033 * Checks if the value of a node cannot represent a NULL pointer.
1035 * - If option sel_based_null_check_elim is enabled, all
1036 * Sel nodes can be skipped.
1037 * - A SymConst(entity) is NEVER a NULL pointer
1038 * - A Const != NULL is NEVER a NULL pointer
1039 * - Confirms are evaluated
1041 * @param n a node representing the value
1042 * @param confirm if n is confirmed to be != NULL, returns
1043 * the the Confirm-node, else NULL
1045 FIRM_API int value_not_null(const ir_node *n, const ir_node **confirm);
1048 * Checks if the value of a node can be confirmed >= 0 or <= 0,
1049 * If the mode of the value did not honor signed zeros, else
1050 * check for >= 0 or < 0.
1052 * @param n a node representing the value
1054 FIRM_API ir_value_classify_sign classify_value_sign(ir_node *n);
1057 * Returns the value of a Cmp if one or both predecessors are Confirm nodes.
1059 * @param cmp the compare node that will be evaluated
1060 * @param left the left operand of the Cmp
1061 * @param right the right operand of the Cmp
1062 * @param relation the compare relation
1064 FIRM_API ir_tarval *computed_value_Cmp_Confirm(
1065 const ir_node *cmp, ir_node *left, ir_node *right, ir_relation relation);
1067 /** Type of callbacks for creating entities of the compiler library */
1068 typedef ir_entity *(*compilerlib_entity_creator_t)(ident *id, ir_type *mt);
1071 * Sets the compilerlib entity creation callback that is used to create
1072 * compilerlib function entities.
1074 * @param cb the new compilerlib entity creation callback
1076 FIRM_API void set_compilerlib_entity_creator(compilerlib_entity_creator_t cb);
1078 /** Returns the compilerlib entity creation callback. */
1079 FIRM_API compilerlib_entity_creator_t get_compilerlib_entity_creator(void);
1082 * Constructs the entity for a given function using the current compilerlib
1083 * entity creation callback.
1085 * @param id the identifier of the compilerlib function
1086 * @param mt the method type of the compilerlib function
1088 FIRM_API ir_entity *create_compilerlib_entity(ident *id, ir_type *mt);