6afd229096b463efd858ff4f8d9089dd2a3e7106
[libfirm] / ir / ir / irgopt.c
1 /*
2  * Copyright (C) 1995-2008 University of Karlsruhe.  All right reserved.
3  *
4  * This file is part of libFirm.
5  *
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.
10  *
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.
14  *
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
17  * PURPOSE.
18  */
19
20 /**
21  * @file
22  * @brief    Optimizations for a whole ir graph, i.e., a procedure.
23  * @author   Christian Schaefer, Goetz Lindenmaier, Sebastian Felis,
24  *           Michael Beck
25  * @version  $Id$
26  */
27 #include "config.h"
28
29 #include <assert.h>
30
31 #include "irnode_t.h"
32 #include "irgraph_t.h"
33
34 #include "iroptimize.h"
35 #include "iropt_t.h"
36 #include "irgopt.h"
37 #include "irgmod.h"
38 #include "irgwalk.h"
39
40 #include "adt/pdeq.h"
41
42 #include "irpass_t.h"
43 #include "irflag_t.h"
44 #include "iredges_t.h"
45 #include "irtools.h"
46
47 /*------------------------------------------------------------------*/
48 /* apply optimizations of iropt to all nodes.                       */
49 /*------------------------------------------------------------------*/
50
51 /**
52  * A wrapper around optimize_inplace_2() to be called from a walker.
53  */
54 static void optimize_in_place_wrapper(ir_node *n, void *env)
55 {
56         ir_node *optimized = optimize_in_place_2(n);
57         (void) env;
58
59         if (optimized != n) {
60                 exchange(n, optimized);
61         }
62 }
63
64 /**
65  * Do local optimizations for a node.
66  *
67  * @param n  the IR-node where to start. Typically the End node
68  *           of a graph
69  *
70  * @note current_ir_graph must be set
71  */
72 static inline void do_local_optimize(ir_node *n)
73 {
74         ir_graph *irg = get_irn_irg(n);
75
76         /* Handle graph state */
77         assert(get_irg_phase_state(irg) != phase_building);
78
79         if (get_opt_global_cse())
80                 set_irg_pinned(irg, op_pin_state_floats);
81         set_irg_doms_inconsistent(irg);
82         set_irg_loopinfo_inconsistent(irg);
83
84         /* Clean the value_table in irg for the CSE. */
85         new_identities(irg);
86
87         /* walk over the graph */
88         irg_walk(n, firm_clear_link, optimize_in_place_wrapper, NULL);
89 }
90
91 /* Applies local optimizations (see iropt.h) to all nodes reachable from node n */
92 void local_optimize_node(ir_node *n)
93 {
94         ir_graph *rem = current_ir_graph;
95         current_ir_graph = get_irn_irg(n);
96
97         do_local_optimize(n);
98
99         current_ir_graph = rem;
100 }
101
102 /**
103  * Enqueue all users of a node to a wait queue.
104  * Handles mode_T nodes.
105  */
106 static void enqueue_users(ir_node *n, pdeq *waitq)
107 {
108         const ir_edge_t *edge;
109
110         foreach_out_edge(n, edge) {
111                 ir_node *succ = get_edge_src_irn(edge);
112
113                 if (get_irn_link(succ) != waitq) {
114                         pdeq_putr(waitq, succ);
115                         set_irn_link(succ, waitq);
116                 }
117                 if (get_irn_mode(succ) == mode_T) {
118                 /* A mode_T node has Proj's. Because most optimizations
119                         run on the Proj's we have to enqueue them also. */
120                         enqueue_users(succ, waitq);
121                 }
122         }
123 }
124
125 /**
126  * Block-Walker: uses dominance depth to mark dead blocks.
127  */
128 static void kill_dead_blocks(ir_node *block, void *env)
129 {
130         pdeq *waitq = (pdeq*) env;
131
132         if (get_Block_dom_depth(block) < 0) {
133                 /*
134                  * Note that the new dominance code correctly handles
135                  * the End block, i.e. it is always reachable from Start
136                  */
137                 ir_graph *irg = get_irn_irg(block);
138                 enqueue_users(block, waitq);
139                 exchange(block, new_r_Bad(irg, mode_BB));
140         }
141 }
142
143 /* Applies local optimizations (see iropt.h) to all nodes reachable from node n. */
144 void local_optimize_graph(ir_graph *irg)
145 {
146         ir_graph *rem = current_ir_graph;
147         current_ir_graph = irg;
148
149         do_local_optimize(get_irg_end(irg));
150
151         current_ir_graph = rem;
152 }
153
154 /**
155  * Data flow optimization walker.
156  * Optimizes all nodes and enqueue its users
157  * if done.
158  */
159 static void opt_walker(ir_node *n, void *env)
160 {
161         pdeq *waitq = (pdeq*)env;
162         ir_node *optimized;
163
164         optimized = optimize_in_place_2(n);
165         set_irn_link(optimized, NULL);
166
167         if (optimized != n) {
168                 enqueue_users(n, waitq);
169                 exchange(n, optimized);
170         }
171 }
172
173 static void clear_block_phis(ir_node *node, void *env) {
174         (void) env;
175         if (is_Block(node)) {
176                 set_Block_phis(node, NULL);
177         }
178 }
179
180 static void collect_block_phis(ir_node *node, void *env) {
181         (void) env;
182         if (is_Phi(node)) {
183                 add_Block_phi(get_nodes_block(node), node);
184         }
185 }
186
187 static int count_non_bads(ir_node *node) {
188         int arity = get_irn_arity(node);
189         int count = 0;
190         int i;
191         for (i=0; i<arity; ++i) {
192                 if (!is_Bad(get_irn_n(node, i)))
193                         count++;
194         }
195         return count;
196 }
197
198 static void block_remove_bads(ir_node *block, int *changed) {
199         int i, j;
200         ir_node **new_in;
201         const int max = get_irn_arity(block);
202         const int new_max = count_non_bads(block);
203         assert (max >= new_max);
204
205         if (is_Bad(block) || max == new_max) return;
206
207         new_in = ALLOCAN(ir_node*, new_max);
208         *changed = 1;
209
210         assert (get_Block_dom_depth(block) >= 0);
211
212         /* 1. Create a new block without Bad inputs */
213         j = 0;
214         for (i = 0; i < max; ++i) {
215                 ir_node *block_pred = get_irn_n(block, i);
216                 if (!is_Bad(block_pred)) {
217                         new_in[j++] = block_pred;
218                 }
219         }
220         assert (j == new_max);
221
222         /* If the end block is unreachable, it might have zero predecessors. */
223         ir_node *end_block = get_irg_end_block(get_irn_irg(block));
224         if (new_max == 0 && block == end_block) {
225                 set_irn_in(block, new_max, new_in);
226                 return;
227         }
228
229         ir_node *new_block =  new_r_Block(get_irn_irg(block), new_max, new_in);
230
231         /* 2. Remove inputs on Phis, where the block input is Bad. */
232         ir_node *phi = get_Block_phis(block);
233         if (phi != NULL) {
234                 do {
235                         ir_node* next = get_Phi_next(phi);
236                         if (get_irn_arity(phi) != new_max) {
237                                 j = 0;
238                                 for (i = 0; i < max; ++i) {
239                                         ir_node *block_pred = get_irn_n(block, i);
240
241                                         if (!is_Bad(block_pred)) {
242                                                 ir_node *pred = get_irn_n(phi, i);
243                                                 new_in[j++] = pred;
244                                         }
245                                 }
246                                 assert (j == new_max);
247
248                                 ir_node *new_phi = new_r_Phi(new_block, new_max, new_in, get_irn_mode(phi));
249                                 exchange(phi, new_phi);
250                         }
251                         phi = next;
252                 } while (phi != NULL);
253         }
254
255         exchange(block, new_block);
256 }
257
258 /* Remove Bad nodes from Phi and Block inputs.
259  *
260  * Precondition: No unreachable code.
261  * Postcondition: No Bad nodes.
262  */
263 static int remove_Bads(ir_graph *irg) {
264         int changed = 0;
265         /* build phi list per block */
266         irg_walk_graph(irg, clear_block_phis, collect_block_phis, NULL);
267
268         /* actually remove Bads */
269         irg_block_walk_graph(irg, NULL, (void (*)(struct ir_node *, void *)) block_remove_bads, &changed);
270
271         return changed;
272 }
273
274 /* Applies local optimizations to all nodes in the graph until fixpoint. */
275 int optimize_graph_df(ir_graph *irg)
276 {
277         pdeq     *waitq = new_pdeq();
278         ir_graph *rem = current_ir_graph;
279         ir_node  *end;
280         int      state, changed;
281
282         current_ir_graph = irg;
283
284         state = edges_assure(irg);
285
286         /* Clean the value_table in irg for the CSE. */
287         new_identities(irg);
288
289         if (get_opt_global_cse()) {
290                 set_irg_pinned(irg, op_pin_state_floats);
291         }
292
293         /* The following enables unreachable code elimination (=Blocks may be
294          * Bad). */
295         set_irg_state(irg, IR_GRAPH_STATE_BAD_BLOCK);
296
297         /* invalidate info */
298         set_irg_doms_inconsistent(irg);
299         set_irg_loopinfo_inconsistent(irg);
300
301         ir_reserve_resources(irg, IR_RESOURCE_IRN_LINK);
302
303         /* walk over the graph, but don't touch keep-alives */
304         irg_walk_graph(irg, NULL, opt_walker, waitq);
305
306         /* any optimized nodes are stored in the wait queue,
307          * so if it's not empty, the graph has been changed */
308         changed = !pdeq_empty(waitq);
309
310         do {
311                 /* finish the wait queue */
312                 while (! pdeq_empty(waitq)) {
313                         ir_node *n = (ir_node*)pdeq_getl(waitq);
314                         opt_walker(n, waitq);
315                 }
316                 /* kill newly generated unreachable code */
317                 compute_doms(irg);
318                 irg_block_walk_graph(irg, NULL, kill_dead_blocks, waitq);
319         } while (! pdeq_empty(waitq));
320
321         del_pdeq(waitq);
322
323         ir_free_resources(irg, IR_RESOURCE_IRN_LINK);
324
325         if (! state)
326                 edges_deactivate(irg);
327
328         /* Finally kill BAD and doublets from the keep alives.
329            Doing this AFTER edges where deactivated saves cycles */
330         end = get_irg_end(irg);
331         remove_End_Bads_and_doublets(end);
332
333         if (remove_Bads(irg)) {
334                 edges_deactivate(irg);
335         }
336
337         clear_irg_state(irg, IR_GRAPH_STATE_BAD_BLOCK);
338
339         current_ir_graph = rem;
340         return changed;
341 }
342
343 /* Creates an ir_graph pass for optimize_graph_df. */
344 ir_graph_pass_t *optimize_graph_df_pass(const char *name)
345 {
346         return def_graph_pass_ret(name ? name : "optimize_graph_df", optimize_graph_df);
347 }  /* optimize_graph_df_pass */