3 * File name: ir/ir/irgopt.h
4 * Purpose: Optimizations for a whole ir graph, i.e., a procedure.
5 * Author: Christian Schaefer, Goetz Lindenmaier
6 * Modified by: Sebastian Felis
9 * Copyright: (c) 1998-2003 Universität Karlsruhe
10 * Licence: This file protected by GPL - GNU GENERAL PUBLIC LICENSE.
16 * Optimizations for a whole ir graph, i.e., a procedure.
18 * @author Christian Schaefer, Goetz Lindenmaier
26 /** Applies local optimizations (see iropt.h) to all nodes reachable from node n.
28 * @param n The node to be optimized. */
29 void local_optimize_node(ir_node *n);
31 /** Applies local optimizations (see iropt.h) to all nodes in the graph.
33 * @param irg The graph to be optimized. */
34 void local_optimize_graph (ir_graph *irg);
36 /** Performs dead node elimination by copying the ir graph to a new obstack.
38 * The major intention of this pass is to free memory occupied by
39 * dead nodes and outdated analyses information. Further this
40 * function removes Bad predecesors from Blocks and the corresponding
41 * inputs to Phi nodes. This opens optmization potential for other
42 * optimizations. Further this phase reduces dead Block<->Jmp
43 * self-cycles to Bad nodes.
45 * Dead_node_elimination is only performed if options `optimize' and
46 * `opt_dead_node_elimination' are set. The graph may
47 * not be in state phase_building. The outs datasturcture is freed,
48 * the outs state set to no_outs. Backedge information is conserved.
49 * Removes old attributes of nodes. Sets link field to NULL.
50 * Callee information must be freed (irg_callee_info_none).
52 * Attention: the numbers assigned to nodes if the library is compiled for
53 * development/debugging are not conserved by copying.
55 * @param irg The graph to be optimized. */
56 void dead_node_elimination(ir_graph *irg);
58 /** Cleans the control flow from Bad predecesors.
60 * Removes Bad predecesors from Blocks and the corresponding
61 * inputs to Phi nodes as in dead_node_elimination but without
64 * @param irg The graph to be optimized.
66 void remove_bad_predecessors(ir_graph *irg);
68 /** Inlines a method at the given call site.
70 * Removes the call node and splits the basic block the call node
71 * belongs to. Inserts a copy of the called graph between these nodes.
72 * Assumes that call is a Call node in current_ir_graph and that
73 * the type in the Call nodes type attribute is the same as the
74 * type of the called graph.
75 * Further it assumes that all Phi nodes in a block of current_ir_graph
76 * are assembled in a "link" list in the link field of the corresponding
77 * block nodes. Further assumes that all Proj nodes are in a "link" list
78 * in the nodes producing the tuple. (This is only an optical feature
79 * for the graph.) Conserves this feature for the old
80 * nodes of the graph. This precondition can be established by a call to
81 * collect_phisprojs(), see irgmod.h.
82 * As dead_node_elimination this function reduces dead Block<->Jmp
83 * self-cycles to Bad nodes.
85 * Called_graph must be unequal to current_ir_graph. Will not inline
87 * Sets visited masterflag in current_ir_graph to the max of the flag in
88 * current and called graph.
89 * Assumes that both, the called and the calling graph are in state
91 * It is recommended to call local_optimize_graph after inlining as this
92 * function leaves a set of obscure Tuple nodes, e.g. a Proj-Tuple-Jmp
93 * combination as control flow operation.
95 * @param call the call node that should be inlined
96 * @param called_graph the IR-graph that is called at call
98 * @return zero if method could not be inlined (recursion for instance),
99 * non-zero if all went ok
101 int inline_method(ir_node *call, ir_graph *called_graph);
103 /** Inlines all small methods at call sites where the called address comes
104 * from a Const node that references the entity representing the called
106 * The size argument is a rough measure for the code size of the method:
107 * Methods where the obstack containing the firm graph is smaller than
108 * size are inlined. Further only a limited number of calls are inlined.
109 * If the method contains more than 1024 inlineable calls none will be
111 * Inlining is only performed if flags `optimize' and `inlineing' are set.
112 * The graph may not be in state phase_building.
113 * It is recommended to call local_optimize_graph after inlining as this
114 * function leaves a set of obscure Tuple nodes, e.g. a Proj-Tuple-Jmp
115 * combination as control flow operation. */
116 void inline_small_irgs(ir_graph *irg, int size);
119 /** Inlineing with a different heuristic than inline_small_irgs.
121 * Inlines leave functions. If inlinening creates new leave
122 * function inlines these, too. (If g calls f, and f calls leave h,
123 * h is first inlined in f and then f in g.)
125 * Then inlines all small functions (this is not recursive).
127 * For a heuristic this inlineing uses firm node counts. It does
128 * not count auxiliary nodes as Proj, Tuple, End, Start, Id, Sync.
130 * @param maxsize Do not inline any calls if a method has more than
131 * maxsize firm nodes. It may reach this limit by
133 * @param leavesize Inline leave functions if they have less than leavesize
135 * @param size Inline all function smaller than size.
137 void inline_leave_functions(int maxsize, int leavesize, int size);
139 /** Code Placement. Pinns all floating nodes to a block where they
140 will be executed only if needed. Depends on the flag opt_global_cse.
141 Graph may not be in phase_building. Does not schedule control dead
142 code. Uses dominator information which it computes if the irg is not
143 in state dom_consistent. Destroys the out information as it moves nodes
144 to other blocks. Optimizes Tuples in Control edges.
145 @todo This is not tested!
147 Call remove_critical_cf_edges() before place_code(). This normalizes
148 the control flow graph so that for all operations a basic block exists
149 where they can be optimally placed.
151 @todo A more powerful code placement would move operations past Phi nodes
153 void place_code(ir_graph *irg);
155 /** Control flow optimization.
156 * Removes empty blocks doing if simplifications and loop simplifications.
157 * A block is empty if it contains only a Jmp node and Phi nodes.
158 * Merges single entry single exit blocks with their predecessor
159 * and propagates dead control flow by calling equivalent_node.
160 * Independent of compiler flag it removes Tuples from cf edges,
161 * Bad predecessors form blocks and unnecessary predecessors of End.
163 * @bug So far destroys backedge information.
164 * @bug Chokes on Id nodes if called in a certain order with other
165 * optimizations. Call local_optimize_graph before to remove
168 void optimize_cf(ir_graph *irg);
171 /** Places an empty basic block on critical control flow edges thereby
173 A critical control flow edge is an edge from a block with several
174 control exits to a block with several control entries (See Muchnic
176 Is only executed if flag set_opt_critical_edges() is set.
179 void remove_critical_cf_edges(ir_graph *irg);
181 # endif /* _IRGOPT_H_ */