Let matrix_foreach(), matrix_foreach_in_col() and matrix_foreach_in_row() declare...
[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  */
26 #include "config.h"
27
28 #include <assert.h>
29
30 #include "irnode_t.h"
31 #include "irgraph_t.h"
32
33 #include "iroptimize.h"
34 #include "iropt_t.h"
35 #include "irgopt.h"
36 #include "irgmod.h"
37 #include "irgwalk.h"
38 #include "ircons.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  * A wrapper around optimize_inplace_2() to be called from a walker.
49  */
50 static void optimize_in_place_wrapper(ir_node *n, void *env)
51 {
52         ir_node *optimized = optimize_in_place_2(n);
53         (void) env;
54
55         if (optimized != n) {
56                 exchange(n, optimized);
57         }
58 }
59
60 /**
61  * Do local optimizations for a node.
62  *
63  * @param n  the IR-node where to start. Typically the End node
64  *           of a graph
65  *
66  * @note current_ir_graph must be set
67  */
68 static inline void do_local_optimize(ir_node *n)
69 {
70         ir_graph *irg = get_irn_irg(n);
71
72         /* Handle graph state */
73         assert(get_irg_phase_state(irg) != phase_building);
74
75         if (get_opt_global_cse())
76                 set_irg_pinned(irg, op_pin_state_floats);
77         clear_irg_properties(irg, IR_GRAPH_PROPERTY_CONSISTENT_DOMINANCE);
78
79         /* Clean the value_table in irg for the CSE. */
80         new_identities(irg);
81
82         /* walk over the graph */
83         irg_walk(n, firm_clear_link, optimize_in_place_wrapper, NULL);
84 }
85
86 void local_optimize_node(ir_node *n)
87 {
88         ir_graph *rem = current_ir_graph;
89         current_ir_graph = get_irn_irg(n);
90
91         do_local_optimize(n);
92
93         current_ir_graph = rem;
94 }
95
96 static void enqueue_node(ir_node *node, pdeq *waitq)
97 {
98         if (get_irn_link(node) == waitq)
99                 return;
100         pdeq_putr(waitq, node);
101         set_irn_link(node, waitq);
102 }
103
104 /**
105  * Enqueue all users of a node to a wait queue.
106  * Handles mode_T nodes.
107  */
108 static void enqueue_users(ir_node *n, pdeq *waitq)
109 {
110         foreach_out_edge(n, edge) {
111                 ir_node *succ  = get_edge_src_irn(edge);
112
113                 enqueue_node(succ, waitq);
114
115                 /* Also enqueue Phis to prevent inconsistencies. */
116                 if (is_Block(succ)) {
117                         foreach_out_edge(succ, edge2) {
118                                 ir_node *succ2 = get_edge_src_irn(edge2);
119
120                                 if (is_Phi(succ2)) {
121                                         enqueue_node(succ2, waitq);
122                                 }
123                         }
124                 } else if (get_irn_mode(succ) == mode_T) {
125                 /* A mode_T node has Proj's. Because most optimizations
126                         run on the Proj's we have to enqueue them also. */
127                         enqueue_users(succ, waitq);
128                 }
129         }
130 }
131
132 /**
133  * Block-Walker: uses dominance depth to mark dead blocks.
134  */
135 static void find_unreachable_blocks(ir_node *block, void *env)
136 {
137         pdeq *waitq = (pdeq*) env;
138
139         if (get_Block_dom_depth(block) < 0) {
140                 ir_graph *irg = get_irn_irg(block);
141                 ir_node  *end = get_irg_end(irg);
142
143                 foreach_block_succ(block, edge) {
144                         ir_node *succ_block = get_edge_src_irn(edge);
145                         enqueue_node(succ_block, waitq);
146                         foreach_out_edge(succ_block, edge2) {
147                                 ir_node *succ = get_edge_src_irn(edge2);
148                                 if (is_Phi(succ))
149                                         enqueue_node(succ, waitq);
150                         }
151                 }
152                 enqueue_node(end, waitq);
153         }
154 }
155
156 void local_optimize_graph(ir_graph *irg)
157 {
158         ir_graph *rem = current_ir_graph;
159         current_ir_graph = irg;
160
161         do_local_optimize(get_irg_end(irg));
162
163         current_ir_graph = rem;
164 }
165
166 /**
167  * Data flow optimization walker.
168  * Optimizes all nodes and enqueue its users
169  * if done.
170  */
171 static void opt_walker(ir_node *n, void *env)
172 {
173         pdeq *waitq = (pdeq*)env;
174         ir_node *optimized;
175
176         optimized = optimize_in_place_2(n);
177         set_irn_link(optimized, NULL);
178
179         if (optimized != n) {
180                 enqueue_users(n, waitq);
181                 exchange(n, optimized);
182         }
183 }
184
185 int optimize_graph_df(ir_graph *irg)
186 {
187         pdeq     *waitq = new_pdeq();
188         ir_graph *rem = current_ir_graph;
189         ir_node  *end;
190
191         current_ir_graph = irg;
192
193         if (get_opt_global_cse())
194                 set_irg_pinned(irg, op_pin_state_floats);
195
196         /* enable unreachable code elimination */
197         assert(!irg_is_constrained(irg, IR_GRAPH_CONSTRAINT_OPTIMIZE_UNREACHABLE_CODE));
198         add_irg_constraints(irg, IR_GRAPH_CONSTRAINT_OPTIMIZE_UNREACHABLE_CODE);
199
200         new_identities(irg);
201         assure_edges(irg);
202         assure_doms(irg);
203
204
205         ir_reserve_resources(irg, IR_RESOURCE_IRN_LINK);
206         irg_walk_graph(irg, NULL, opt_walker, waitq);
207
208         /* any optimized nodes are stored in the wait queue,
209          * so if it's not empty, the graph has been changed */
210         while (!pdeq_empty(waitq)) {
211                 /* finish the wait queue */
212                 while (! pdeq_empty(waitq)) {
213                         ir_node *n = (ir_node*)pdeq_getl(waitq);
214                         opt_walker(n, waitq);
215                 }
216                 /* Calculate dominance so we can kill unreachable code
217                  * We want this intertwined with localopts for better optimization (phase coupling) */
218                 compute_doms(irg);
219                 irg_block_walk_graph(irg, NULL, find_unreachable_blocks, waitq);
220         }
221         del_pdeq(waitq);
222         ir_free_resources(irg, IR_RESOURCE_IRN_LINK);
223
224         /* disable unreachable code elimination */
225         clear_irg_constraints(irg, IR_GRAPH_CONSTRAINT_OPTIMIZE_UNREACHABLE_CODE);
226         add_irg_properties(irg, IR_GRAPH_PROPERTY_NO_UNREACHABLE_CODE);
227
228         /* invalidate infos */
229         clear_irg_properties(irg, IR_GRAPH_PROPERTY_CONSISTENT_DOMINANCE);
230         clear_irg_properties(irg, IR_GRAPH_PROPERTY_CONSISTENT_LOOPINFO);
231         edges_deactivate(irg);
232
233         /* Finally kill BAD and doublets from the keep alives.
234          * Doing this AFTER edges where deactivated saves cycles */
235         end = get_irg_end(irg);
236         remove_End_Bads_and_doublets(end);
237
238         current_ir_graph = rem;
239
240         /* Note we do not have a reliable way to detect changes, since some
241          * localopt rules change the inputs of a node and do not return a new
242          * node, so we conservatively say true here */
243         return true;
244 }
245
246 ir_graph_pass_t *optimize_graph_df_pass(const char *name)
247 {
248         return def_graph_pass_ret(name ? name : "optimize_graph_df", optimize_graph_df);
249 }