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.
30 void local_optimize_node(ir_node *n);
32 /** Applies local optimizations (see iropt.h) to all nodes in the graph.
34 * @param irg The graph to be optimized.
36 * After appliying local_optimize_graph() to a IR-graph, Bad nodes
37 * only occure as predecessor of Block and Phi nodes.
39 void local_optimize_graph (ir_graph *irg);
41 /** Performs dead node elimination by copying the ir graph to a new obstack.
43 * The major intention of this pass is to free memory occupied by
44 * dead nodes and outdated analyses information. Further this
45 * function removes Bad predecesors from Blocks and the corresponding
46 * inputs to Phi nodes. This opens optmization potential for other
47 * optimizations. Further this phase reduces dead Block<->Jmp
48 * self-cycles to Bad nodes.
50 * Dead_node_elimination is only performed if options `optimize' and
51 * `opt_dead_node_elimination' are set. The graph may
52 * not be in state phase_building. The outs datasturcture is freed,
53 * the outs state set to outs_none. Backedge information is conserved.
54 * Removes old attributes of nodes. Sets link field to NULL.
55 * Callee information must be freed (irg_callee_info_none).
57 * Attention: the numbers assigned to nodes if the library is compiled for
58 * development/debugging are not conserved by copying.
60 * @param irg The graph to be optimized.
62 void dead_node_elimination(ir_graph *irg);
64 /** Cleans the control flow from Bad predecesors.
66 * Removes Bad predecesors from Blocks and the corresponding
67 * inputs to Phi nodes as in dead_node_elimination but without
70 * Conserves loop information.
72 * @param irg The graph to be optimized.
74 void remove_bad_predecessors(ir_graph *irg);
76 /** Inlines a method at the given call site.
78 * Removes the call node and splits the basic block the call node
79 * belongs to. Inserts a copy of the called graph between these nodes.
80 * Assumes that call is a Call node in current_ir_graph and that
81 * the type in the Call nodes type attribute is the same as the
82 * type of the called graph.
83 * Further it assumes that all Phi nodes in a block of current_ir_graph
84 * are assembled in a "link" list in the link field of the corresponding
85 * block nodes. Further assumes that all Proj nodes are in a "link" list
86 * in the nodes producing the tuple. (This is only an optical feature
87 * for the graph.) Conserves this feature for the old
88 * nodes of the graph. This precondition can be established by a call to
89 * collect_phisprojs(), see irgmod.h.
90 * As dead_node_elimination this function reduces dead Block<->Jmp
91 * self-cycles to Bad nodes.
93 * Called_graph must be unequal to current_ir_graph. Will not inline
95 * Sets visited masterflag in current_ir_graph to the max of the flag in
96 * current and called graph.
97 * Assumes that both, the called and the calling graph are in state
98 * "op_pin_state_pinned".
99 * It is recommended to call local_optimize_graph() after inlining as this
100 * function leaves a set of obscure Tuple nodes, e.g. a Proj-Tuple-Jmp
101 * combination as control flow operation.
103 * @param call the call node that should be inlined
104 * @param called_graph the IR-graph that is called at call
106 * @return zero if method could not be inlined (recursion for instance),
107 * non-zero if all went ok
109 int inline_method(ir_node *call, ir_graph *called_graph);
111 /** Inlines all small methods at call sites where the called address comes
112 * from a SymConst node that references the entity representing the called
115 * The size argument is a rough measure for the code size of the method:
116 * Methods where the obstack containing the firm graph is smaller than
117 * size are inlined. Further only a limited number of calls are inlined.
118 * If the method contains more than 1024 inlineable calls none will be
120 * Inlining is only performed if flags `optimize' and `inlineing' are set.
121 * The graph may not be in state phase_building.
122 * It is recommended to call local_optimize_graph() after inlining as this
123 * function leaves a set of obscure Tuple nodes, e.g. a Proj-Tuple-Jmp
124 * combination as control flow operation.
126 void inline_small_irgs(ir_graph *irg, int size);
129 /** Inlineing with a different heuristic than inline_small_irgs().
131 * Inlines leave functions. If inlinening creates new leave
132 * function inlines these, too. (If g calls f, and f calls leave h,
133 * h is first inlined in f and then f in g.)
135 * Then inlines all small functions (this is not recursive).
137 * For a heuristic this inlineing uses firm node counts. It does
138 * not count auxiliary nodes as Proj, Tuple, End, Start, Id, Sync.
140 * @param maxsize Do not inline any calls if a method has more than
141 * maxsize firm nodes. It may reach this limit by
143 * @param leavesize Inline leave functions if they have less than leavesize
145 * @param size Inline all function smaller than size.
147 void inline_leave_functions(int maxsize, int leavesize, int size);
151 * Pinns all floating nodes to a block where they
152 * will be executed only if needed. Depends on the flag opt_global_cse.
153 * Graph may not be in phase_building. Does not schedule control dead
154 * code. Uses dominator information which it computes if the irg is not
155 * in state dom_consistent. Destroys the out information as it moves nodes
156 * to other blocks. Optimizes Tuples in Control edges.
157 * @todo This is not tested!
159 * Call remove_critical_cf_edges() before place_code(). This normalizes
160 * the control flow graph so that for all operations a basic block exists
161 * where they can be optimally placed.
163 * @todo A more powerful code placement would move operations past Phi nodes
166 void place_code(ir_graph *irg);
168 /** Places an empty basic block on critical control flow edges thereby
171 * A critical control flow edge is an edge from a block with several
172 * control exits to a block with several control entries (See Muchnic
174 * Is only executed if flag set_opt_critical_edges() is set.
176 * @param irg IR Graph
178 void remove_critical_cf_edges(ir_graph *irg);
180 # endif /* _IRGOPT_H_ */