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 * Perform If conversion on a graph.
260 * @param irg The graph.
262 * Cannot handle blocks with Bad control predecessors, so call it after control
265 FIRM_API void opt_if_conv(ir_graph *irg);
268 * Creates an ir_graph pass for opt_if_conv().
270 * @param name the name of this pass or NULL
272 * @return the newly created ir_graph pass
274 FIRM_API ir_graph_pass_t *opt_if_conv_pass(const char *name);
277 * Tries to reduce dependencies for memory nodes where possible by parllelizing
278 * them and synchronising with Sync nodes
279 * @param irg the graph where memory operations should be parallelised
281 FIRM_API void opt_parallelize_mem(ir_graph *irg);
284 * Creates an ir_graph pass for opt_sync().
286 * @param name the name of this pass or NULL
288 * @return the newly created ir_graph pass
290 FIRM_API ir_graph_pass_t *opt_parallelize_mem_pass(const char *name);
293 * Check if we can replace the load by a given const from
294 * the const code irg.
296 * @param load the load to replace
297 * @param c the constant
299 * @return in the modes match or can be transformed using a reinterpret cast
300 * returns a copy of the constant (possibly Conv'ed) on the
303 FIRM_API ir_node *can_replace_load_by_const(const ir_node *load, ir_node *c);
306 * Load/Store optimization.
308 * Removes redundant non-volatile Loads and Stores.
309 * May introduce Bad nodes if exceptional control flow
310 * is removed. The following cases are optimized:
312 * Load without result: A Load which has only a memory use
315 * Load after Store: A Load after a Store is removed, if
316 * the Load doesn't have an exception handler OR is in
317 * the same block as the Store.
319 * Load after Load: A Load after a Load is removed, if the
320 * Load doesn't have an exception handler OR is in the
321 * same block as the previous Load.
323 * Store before Store: A Store immediately before another
324 * Store in the same block is removed, if the Store doesn't
325 * have an exception handler.
327 * Store after Load: A Store after a Load is removed, if the
328 * Store doesn't have an exception handler.
330 * @return non-zero if the optimization could be applied, 0 else
332 FIRM_API int optimize_load_store(ir_graph *irg);
335 * Creates an ir_graph pass for optimize_load_store().
337 * @param name the name of this pass or NULL
339 * @return the newly created ir_graph pass
341 FIRM_API ir_graph_pass_t *optimize_load_store_pass(const char *name);
344 * New experimental alternative to optimize_load_store.
345 * Based on a dataflow analysis, so load/stores are moved out of loops
348 FIRM_API int opt_ldst(ir_graph *irg);
351 * Creates an ir_graph pass for opt_ldst().
353 * @param name the name of this pass or NULL
355 * @return the newly created ir_graph pass
357 FIRM_API ir_graph_pass_t *opt_ldst_pass(const char *name);
360 * Optimize loops by peeling or unrolling them if beneficial.
362 * @param irg The graph whose loops will be processed
364 * This function did not change the graph, only it's frame type.
365 * The layout state of the frame type will be set to layout_undefined
366 * if entities were removed.
368 FIRM_API void loop_optimization(ir_graph *irg);
371 * Optimize the frame type of an irg by removing
372 * never touched entities.
374 * @param irg The graph whose frame type will be optimized
376 * This function did not change the graph, only it's frame type.
377 * The layout state of the frame type will be set to layout_undefined
378 * if entities were removed.
380 FIRM_API void opt_frame_irg(ir_graph *irg);
383 * Creates an ir_graph pass for opt_frame_irg().
385 * @param name the name of this pass or NULL
387 * @return the newly created ir_graph pass
389 FIRM_API ir_graph_pass_t *opt_frame_irg_pass(const char *name);
391 /** Possible flags for the Operator Scalar Replacement. */
392 typedef enum osr_flags {
393 osr_flag_none = 0, /**< no additional flags */
394 osr_flag_lftr_with_ov_check = 1, /**< do linear function test replacement
395 only if no overflow can occur. */
396 osr_flag_ignore_x86_shift = 2, /**< ignore Multiplications by 2, 4, 8 */
397 osr_flag_keep_reg_pressure = 4 /**< do NOT increase register pressure by introducing new
398 induction variables. */
401 /* FirmJNI cannot handle identical enum values... */
403 /** default setting */
404 #define osr_flag_default osr_flag_lftr_with_ov_check
407 * Do the Operator Scalar Replacement optimization and linear
408 * function test replacement for loop control.
409 * Can be switched off using the set_opt_strength_red() flag.
410 * In that case, only remove_phi_cycles() is executed.
412 * @param irg the graph which should be optimized
413 * @param flags set of osr_flags
415 * The linear function replacement test is controlled by the flags.
416 * If the osr_flag_lftr_with_ov_check is set, the replacement is only
417 * done if do overflow can occur.
418 * Otherwise it is ALWAYS done which might be insecure.
422 * for (i = 0; i < 100; ++i)
424 * might be replaced by
426 * for (i = 0; i < 400; i += 4)
430 * for (i = 0; i < 0x7FFFFFFF; ++i)
432 * will not be replaced by
434 * for (i = 0; i < 0xFFFFFFFC; i += 4)
436 * because of overflow.
440 * for (i = 0; i <= 0xF; ++i)
442 * will NOT be transformed into
444 * for (i = 0xFFFFFFF0; i <= 0xFFFFFFFF; ++i)
446 * although here is no direct overflow. The OV occurs when the ++i
447 * is executed (and would created an endless loop here!).
449 * For the same reason, a loop
451 * for (i = 0; i <= 9; i += x)
453 * will NOT be transformed because we cannot estimate whether an overflow
454 * might happen adding x.
456 * Note that i < a + 400 is also not possible with the current implementation
457 * although this might be allowed by other compilers...
459 * Note further that tests for equality can be handled some simpler (but are not
462 * This algorithm destroys the link field of nodes.
464 FIRM_API void opt_osr(ir_graph *irg, unsigned flags);
467 * Creates an ir_graph pass for remove_phi_cycles().
469 * @param name the name of this pass or NULL
470 * @param flags set of osr_flags
472 * @return the newly created ir_graph pass
474 FIRM_API ir_graph_pass_t *opt_osr_pass(const char *name, unsigned flags);
477 * Removes useless Phi cycles, i.e cycles of Phi nodes with only one
479 * This is automatically done in opt_osr(), so there is no need to call it
482 * @param irg the graph which should be optimized
484 * This algorithm destroys the link field of nodes.
486 FIRM_API void remove_phi_cycles(ir_graph *irg);
489 * Creates an ir_graph pass for remove_phi_cycles().
491 * @param name the name of this pass or NULL
493 * @return the newly created ir_graph pass
495 FIRM_API ir_graph_pass_t *remove_phi_cycles_pass(const char *name);
498 /** A default threshold. */
499 #define DEFAULT_CLONE_THRESHOLD 20
502 * Do procedure cloning. Evaluate a heuristic weight for every
503 * Call(..., Const, ...). If the weight is bigger than threshold,
504 * clone the entity and fix the calls.
506 * @param threshold the threshold for cloning
508 * The threshold is an estimation of how many instructions are saved
509 * when executing a cloned method. If threshold is 0.0, every possible
512 FIRM_API void proc_cloning(float threshold);
515 * Creates an ir_prog pass for proc_cloning().
517 * @param name the name of this pass or NULL
518 * @param threshold the threshold for cloning
520 * @return the newly created ir_prog pass
522 FIRM_API ir_prog_pass_t *proc_cloning_pass(const char *name, float threshold);
527 * Applies Reassociation rules to integer expressions.
528 * Beware: Works only if integer overflow might be ignored, as for C, Java
529 * and for address expression.
530 * Works only if Constant folding is activated.
532 * Uses loop information to detect loop-invariant (ie contant
533 * inside the loop) values.
535 * See Muchnik 12.3.1 Algebraic Simplification and Reassociation of
536 * Addressing Expressions.
538 * @return non-zero if the optimization could be applied, 0 else
540 FIRM_API int optimize_reassociation(ir_graph *irg);
543 * Creates an ir_graph pass for optimize_reassociation().
545 * @param name the name of this pass or NULL
547 * @return the newly created ir_graph pass
549 FIRM_API ir_graph_pass_t *optimize_reassociation_pass(const char *name);
552 * Normalize the Returns of a graph by creating a new End block
553 * with One Return(Phi).
554 * This is the preferred input for the if-conversion.
556 * In pseudocode, it means:
563 * is transformed into
571 FIRM_API void normalize_one_return(ir_graph *irg);
574 * Creates an ir_graph pass for normalize_one_return().
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 *normalize_one_return_pass(const char *name);
583 * Normalize the Returns of a graph by moving
584 * the Returns upwards as much as possible.
585 * This might be preferred for code generation.
587 * In pseudocode, it means:
595 * is transformed into
602 FIRM_API void normalize_n_returns(ir_graph *irg);
605 * Creates an ir_graph pass for normalize_n_returns().
607 * @param name the name of this pass or NULL
609 * @return the newly created ir_graph pass
611 FIRM_API ir_graph_pass_t *normalize_n_returns_pass(const char *name);
614 * Do the scalar replacement optimization.
615 * Replace local compound entities (like structures and arrays)
616 * with atomic values if possible. Does not handle classes yet.
618 * @param irg the graph which should be optimized
620 * @return non-zero, if at least one entity was replaced
622 FIRM_API int scalar_replacement_opt(ir_graph *irg);
625 * Creates an ir_graph pass for scalar_replacement_opt().
627 * @param name the name of this pass or NULL
629 * @return the newly created ir_graph pass
631 FIRM_API ir_graph_pass_t *scalar_replacement_opt_pass(const char *name);
633 /** Performs strength reduction for the passed graph. */
634 FIRM_API void reduce_strength(ir_graph *irg);
637 * Optimizes tail-recursion calls by converting them into loops.
638 * Depends on the flag opt_tail_recursion.
639 * Currently supports the following forms:
641 * - return x + func();
642 * - return func() - x;
643 * - return x * func();
646 * Does not work for Calls that use the exception stuff.
648 * @param irg the graph to be optimized
650 * @return non-zero if the optimization could be applied, 0 else
652 FIRM_API int opt_tail_rec_irg(ir_graph *irg);
655 * Creates an ir_graph pass for opt_tail_rec_irg().
657 * @param name the name of this pass or NULL
659 * @return the newly created ir_graph pass
661 FIRM_API ir_graph_pass_t *opt_tail_rec_irg_pass(const char *name);
664 * Optimize tail-recursion calls for all IR-Graphs.
665 * Can currently handle:
666 * - direct return value, i.e. return func().
667 * - additive return value, i.e. return x +/- func()
668 * - multiplicative return value, i.e. return x * func() or return -func()
670 * The current implementation must be run before optimize_funccalls(),
671 * because it expects the memory edges pointing to calls, which might be
672 * removed by optimize_funccalls().
674 FIRM_API void opt_tail_recursion(void);
677 * Creates an ir_prog pass for opt_tail_recursion().
679 * @param name the name of this pass or NULL
681 * @return the newly created ir_prog pass
683 FIRM_API ir_prog_pass_t *opt_tail_recursion_pass(const char *name);
685 /** This is the type for a method, that returns a pointer type to
686 * tp. This is needed in the normalization. */
687 typedef ir_type *(*gen_pointer_type_to_func)(ir_type *tp);
689 /** Insert Casts so that class type casts conform exactly with the type hierarchy.
691 * Formulated in Java, this achieves the following:
693 * For a class hierarchy
695 * class B extends A {}
696 * class C extends B {}
697 * we transforms a cast
702 * The algorithm works for Casts with class types, but also for Casts
703 * with all pointer types that point (over several indirections,
704 * i.e. ***A) to a class type. Normalizes all graphs. Computes type
705 * information (@see irtypeinfo.h) if not available.
706 * Invalidates trout information as new casts are generated.
708 * @param gppt_fct A function that returns a pointer type that points
709 * to the type given as argument. If this parameter is NULL, a default
710 * function is used that either uses trout information or performs a O(n)
711 * search to find an existing pointer type. If it can not find a type,
712 * generates a pointer type with mode_P_mach and suffix "cc_ptr_tp".
714 FIRM_API void normalize_irp_class_casts(gen_pointer_type_to_func gppt_fct);
716 /** Insert Casts so that class type casts conform exactly with the type hierarchy
719 * For more details see normalize_irp_class_casts().
721 * This transformation requires that type information is computed. @see irtypeinfo.h.
723 FIRM_API void normalize_irg_class_casts(ir_graph *irg,
724 gen_pointer_type_to_func gppt_fct);
726 /** Optimize casting between class types.
729 * class B extends A { }
730 * class C extends B {}
731 * Performs the following transformations:
732 * C c = (C)(B)(A)(B)new C() --> C c = (C)(B)newC() --> C c = new C()
733 * (Optimizing downcasts as A a = (A)(B)(new A()) --> A a = new A() can
734 * be suppressed by setting the flag opt_suppress_downcast_optimization.
735 * Downcasting A to B might cause an exception. It is not clear
736 * whether this is modeled by the Firm Cast node, as it has no exception
738 * If there is inh_m() that overwrites m() in B:
739 * ((A) new B()).m() --> (new B()).inh_m()
740 * Phi((A)x, (A)y) --> (A) Phi (x, y) if (A) is an upcast.
742 * Computes type information if not available. @see irtypeinfo.h.
743 * Typeinformation is valid after optimization.
744 * Invalidates trout information.
746 FIRM_API void optimize_class_casts(void);
749 * CLiff Click's combo algorithm from
750 * "Combining Analyses, combining Optimizations".
752 * Does conditional constant propagation, unreachable code elimination and
753 * optimistic global value numbering at once.
755 * @param irg the graph to run on
757 FIRM_API void combo(ir_graph *irg);
760 * Creates an ir_graph pass for combo.
762 * @param name the name of this pass or NULL
764 * @return the newly created ir_graph pass
766 FIRM_API ir_graph_pass_t *combo_pass(const char *name);
769 * Inlines all small methods at call sites where the called address comes
770 * from a SymConst node that references the entity representing the called
773 * @param irg the graph
774 * @param size maximum function size
776 * The size argument is a rough measure for the code size of the method:
777 * Methods where the obstack containing the firm graph is smaller than
778 * size are inlined. Further only a limited number of calls are inlined.
779 * If the method contains more than 1024 inlineable calls none will be
781 * Inlining is only performed if flags `optimize' and `inlineing' are set.
782 * The graph may not be in state phase_building.
783 * It is recommended to call local_optimize_graph() after inlining as this
784 * function leaves a set of obscure Tuple nodes, e.g. a Proj-Tuple-Jmp
785 * combination as control flow operation.
787 FIRM_API void inline_small_irgs(ir_graph *irg, int size);
790 * Creates an ir_graph pass for inline_small_irgs().
792 * @param name the name of this pass or NULL
793 * @param size maximum function size
795 * @return the newly created ir_graph pass
797 FIRM_API ir_graph_pass_t *inline_small_irgs_pass(const char *name, int size);
800 * Inlineing with a different heuristic than inline_small_irgs().
802 * Inlines leave functions. If inlinening creates new leave
803 * function inlines these, too. (If g calls f, and f calls leave h,
804 * h is first inlined in f and then f in g.)
806 * Then inlines all small functions (this is not recursive).
808 * For a heuristic this inlineing uses firm node counts. It does
809 * not count auxiliary nodes as Proj, Tuple, End, Start, Id, Sync.
810 * If the ignore_runtime flag is set, calls to functions marked with the
811 * mtp_property_runtime property are ignored.
813 * @param maxsize Do not inline any calls if a method has more than
814 * maxsize firm nodes. It may reach this limit by
816 * @param leavesize Inline leave functions if they have less than leavesize
818 * @param size Inline all function smaller than size.
819 * @param ignore_runtime count a function only calling runtime functions as
822 FIRM_API void inline_leave_functions(unsigned maxsize, unsigned leavesize,
823 unsigned size, int ignore_runtime);
826 * Creates an ir_prog pass for inline_leave_functions().
828 * @param name the name of this pass or NULL
829 * @param maxsize Do not inline any calls if a method has more than
830 * maxsize firm nodes. It may reach this limit by
832 * @param leavesize Inline leave functions if they have less than leavesize
834 * @param size Inline all function smaller than size.
835 * @param ignore_runtime count a function only calling runtime functions as
838 * @return the newly created ir_prog pass
840 FIRM_API ir_prog_pass_t *inline_leave_functions_pass(const char *name,
841 unsigned maxsize, unsigned leavesize, unsigned size,
844 typedef void (*opt_ptr)(ir_graph *irg);
847 * Heuristic inliner. Calculates a benefice value for every call and inlines
848 * those calls with a value higher than the threshold.
850 * @param maxsize Do not inline any calls if a method has more than
851 * maxsize firm nodes. It may reach this limit by
853 * @param inline_threshold inlining threshold
854 * @param after_inline_opt optimizations performed immediately after inlining
857 FIRM_API void inline_functions(unsigned maxsize, int inline_threshold,
858 opt_ptr after_inline_opt);
861 * Creates an ir_prog pass for inline_functions().
863 * @param name the name of this pass or NULL
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 a function that is called after inlining a
869 * procedure. You should run fast local optimisations
870 * here which cleanup the graph before further
873 * @return the newly created ir_prog pass
875 FIRM_API ir_prog_pass_t *inline_functions_pass(const char *name,
876 unsigned maxsize, int inline_threshold, opt_ptr after_inline_opt);
879 * Combines congruent blocks into one.
881 * @param irg The IR-graph to optimize.
883 * @return non-zero if the graph was transformed
885 FIRM_API int shape_blocks(ir_graph *irg);
888 * Creates an ir_graph pass for shape_blocks().
890 * @param name the name of this pass or NULL
892 * @return the newly created ir_graph pass
894 FIRM_API ir_graph_pass_t *shape_blocks_pass(const char *name);
897 * Perform loop inversion on a given graph.
898 * Loop inversion transforms a head controlled loop (like while(...) {} and
899 * for(...) {}) into a foot controlled loop (do {} while(...)).
901 FIRM_API void do_loop_inversion(ir_graph *irg);
904 * Perform loop unrolling on a given graph.
905 * Loop unrolling multiplies the number loop completely by a number found
906 * through a heuristic.
908 FIRM_API void do_loop_unrolling(ir_graph *irg);
911 * Perform loop peeling on a given graph.
913 FIRM_API void do_loop_peeling(ir_graph *irg);
916 * Creates an ir_graph pass for loop inversion.
918 * @param name the name of this pass or NULL
920 * @return the newly created ir_graph pass
922 FIRM_API ir_graph_pass_t *loop_inversion_pass(const char *name);
925 * Creates an ir_graph pass for loop unrolling.
927 * @param name the name of this pass or NULL
929 * @return the newly created ir_graph pass
931 FIRM_API ir_graph_pass_t *loop_unroll_pass(const char *name);
934 * Creates an ir_graph pass for loop peeling.
936 * @param name the name of this pass or NULL
938 * @return the newly created ir_graph pass
940 FIRM_API ir_graph_pass_t *loop_peeling_pass(const char *name);
942 typedef ir_type *(*get_Alloc_func)(ir_node *n);
943 /** Set a new get_Alloc_func and returns the old one. */
944 FIRM_API get_Alloc_func firm_set_Alloc_func(get_Alloc_func newf);
947 * Creates an ir_graph pass for set_vrp_data()
949 * @param name The name of this pass or NULL
951 * @return the newly created ir_graph pass
953 FIRM_API ir_graph_pass_t *set_vrp_pass(const char *name);
956 * Removes all entities which are unused.
958 * Unused entities have ir_visibility_local and are not used directly or
959 * indirectly through entities/code visible outside the compilation unit.
960 * This is usually conservative than gc_irgs, but does not respect properties
961 * of object-oriented programs.
963 FIRM_API void garbage_collect_entities(void);
965 /** Pass for garbage_collect_entities */
966 FIRM_API ir_prog_pass_t *garbage_collect_entities_pass(const char *name);
969 * Performs dead node elimination by copying the ir graph to a new obstack.
971 * The major intention of this pass is to free memory occupied by
972 * dead nodes and outdated analyzes information. Further this
973 * function removes Bad predecessors from Blocks and the corresponding
974 * inputs to Phi nodes. This opens optimization potential for other
975 * optimizations. Further this phase reduces dead Block<->Jmp
976 * self-cycles to Bad nodes.
978 * Dead_node_elimination is only performed if options `optimize' and
979 * `opt_dead_node_elimination' are set. The graph may
980 * not be in state phase_building. The outs datasturcture is freed,
981 * the outs state set to outs_none. Backedge information is conserved.
982 * Removes old attributes of nodes. Sets link field to NULL.
983 * Callee information must be freed (irg_callee_info_none).
985 * @param irg The graph to be optimized.
987 FIRM_API void dead_node_elimination(ir_graph *irg);
990 * Creates an ir_graph pass for dead_node_elimination().
992 * @param name the name of this pass or NULL
994 * @return the newly created ir_graph pass
996 FIRM_API ir_graph_pass_t *dead_node_elimination_pass(const char *name);
999 * Inlines a method at the given call site.
1001 * Removes the call node and splits the basic block the call node
1002 * belongs to. Inserts a copy of the called graph between these nodes.
1003 * Assumes that call is a Call node in current_ir_graph and that
1004 * the type in the Call nodes type attribute is the same as the
1005 * type of the called graph.
1006 * Further it assumes that all Phi nodes in a block of current_ir_graph
1007 * are assembled in a "link" list in the link field of the corresponding
1008 * block nodes. Further assumes that all Proj nodes are in a "link" list
1009 * in the nodes producing the tuple. (This is only an optical feature
1010 * for the graph.) Conserves this feature for the old
1011 * nodes of the graph. This precondition can be established by a call to
1012 * collect_phisprojs(), see irgmod.h.
1013 * As dead_node_elimination this function reduces dead Block<->Jmp
1014 * self-cycles to Bad nodes.
1016 * Called_graph must be unequal to current_ir_graph. Will not inline
1017 * if they are equal.
1018 * Sets visited masterflag in current_ir_graph to the max of the flag in
1019 * current and called graph.
1020 * Assumes that both, the called and the calling graph are in state
1021 * "op_pin_state_pinned".
1022 * It is recommended to call local_optimize_graph() after inlining as this
1023 * function leaves a set of obscure Tuple nodes, e.g. a Proj-Tuple-Jmp
1024 * combination as control flow operation.
1026 * @param call the call node that should be inlined
1027 * @param called_graph the IR-graph that is called at call
1029 * @return zero if method could not be inlined (recursion for instance),
1030 * non-zero if all went ok
1032 FIRM_API int inline_method(ir_node *call, ir_graph *called_graph);
1037 * Pins all floating nodes to a block where they
1038 * will be executed only if needed. Depends on the flag opt_global_cse.
1039 * Graph may not be in phase_building. Does not schedule control dead
1040 * code. Uses dominator information which it computes if the irg is not
1041 * in state dom_consistent. Destroys the out information as it moves nodes
1042 * to other blocks. Optimizes Tuples in Control edges.
1044 * Call remove_critical_cf_edges() before place_code(). This normalizes
1045 * the control flow graph so that for all operations a basic block exists
1046 * where they can be optimally placed.
1048 FIRM_API void place_code(ir_graph *irg);
1051 * Creates an ir_graph pass for place_code().
1052 * This pass enables GCSE, runs optimize_graph_df() and finally
1055 * @param name the name of this pass or NULL
1057 * @return the newly created ir_graph pass
1059 FIRM_API ir_graph_pass_t *place_code_pass(const char *name);
1062 * Determine information about the values of nodes and perform simplications
1063 * using this information. This optimization performs a data-flow analysis to
1064 * find the minimal fixpoint.
1066 FIRM_API void fixpoint_vrp(ir_graph*);
1069 * Creates an ir_graph pass for fixpoint_vrp().
1070 * This pass dDetermines information about the values of nodes
1071 * and perform simplications using this information.
1072 * This optimization performs a data-flow analysis to
1073 * find the minimal fixpoint.
1075 * @param name the name of this pass or NULL
1077 * @return the newly created ir_graph pass
1079 FIRM_API ir_graph_pass_t *fixpoint_vrp_irg_pass(const char *name);