reuse is_switch_Cond function
[libfirm] / ir / ir / irgmod.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    Support for ir graph modification.
23  * @author   Martin Trapp, Christian Schaefer, Goetz Lindenmaier
24  * @version  $Id$
25  */
26 #include "config.h"
27
28 #include "irflag_t.h"
29 #include "irgwalk.h"
30 #include "irnode_t.h"
31 #include "irgraph_t.h"
32 #include "irgmod.h"
33 #include "array.h"
34 #include "ircons.h"
35 #include "irhooks.h"
36 #include "iredges_t.h"
37 #include "irtools.h"
38 #include "error.h"
39
40 /**
41  * Turns a node into a "useless" Tuple.  The Tuple just forms a tuple
42  * from several inputs.
43  * This is useful if a node returning a tuple is removed, but the Projs
44  * extracting values from the tuple are not available.
45  */
46 void turn_into_tuple(ir_node *node, int arity)
47 {
48         ir_graph *irg = get_irn_irg(node);
49         ir_node **in  = ALLOCAN(ir_node*, arity);
50         ir_node  *bad = new_r_Bad(irg, mode_ANY);
51         int       i;
52
53         /* construct a new in array, with every input being bad */
54         for (i = 0; i < arity; ++i) {
55                 in[i] = bad;
56         }
57         set_irn_in(node, arity, in);
58         set_irn_op(node, op_Tuple);
59 }
60
61 /**
62  * Insert irnode `new' in place of irnode `old'
63  * Since `new' may be bigger than `old' replace `old'
64  * by an op_Id which is smaller than everything.
65  */
66 void exchange(ir_node *old, ir_node *nw)
67 {
68         ir_graph *irg;
69
70         assert(old && nw);
71         assert(old != nw && "Exchanging node with itself is not allowed");
72
73         irg = get_irn_irg(old);
74         assert(irg == get_irn_irg(nw) && "New node must be in same irg as old node");
75
76         hook_replace(old, nw);
77
78         /*
79          * If new outs are on, we can skip the id node creation and reroute
80          * the edges from the old node to the new directly.
81          */
82         if (edges_activated(irg)) {
83                 /* copy all dependencies from old to new */
84                 add_irn_deps(nw, old);
85
86                 edges_reroute(old, nw);
87                 edges_reroute_kind(old, nw, EDGE_KIND_DEP);
88                 edges_node_deleted(old);
89                 /* noone is allowed to reference this node anymore */
90                 set_irn_op(old, op_Deleted);
91         } else {
92                 /* Else, do it the old-fashioned way. */
93                 ir_node *block;
94
95                 hook_turn_into_id(old);
96
97                 block = old->in[0];
98                 if (! block) {
99                         block = is_Block(nw) ? nw : get_nodes_block(nw);
100
101                         if (! block) {
102                                 panic("cannot find legal block for id");
103                         }
104                 }
105
106                 if (get_irn_op(old)->opar == oparity_dynamic) {
107                         DEL_ARR_F(get_irn_in(old));
108                 }
109
110                 old->op    = op_Id;
111                 old->in    = NEW_ARR_D (ir_node *, irg->obst, 2);
112                 old->in[0] = block;
113                 old->in[1] = nw;
114         }
115
116         /* update irg flags */
117         set_irg_outs_inconsistent(irg);
118         set_irg_loopinfo_inconsistent(irg);
119 }
120
121 /*--------------------------------------------------------------------*/
122 /*  Functionality for collect_phis                                    */
123 /*--------------------------------------------------------------------*/
124
125 /**
126  * Walker: links all Phi nodes to their Blocks lists,
127  *         all Proj nodes to there predecessors.
128  */
129 static void collect_phiprojs_walker(ir_node *n, void *env)
130 {
131         ir_node *pred;
132         (void) env;
133
134         if (is_Phi(n)) {
135                 ir_node *block = get_nodes_block(n);
136                 add_Block_phi(block, n);
137         } else if (is_Proj(n)) {
138                 pred = n;
139                 do {
140                         pred = get_Proj_pred(pred);
141                 } while (is_Proj(pred));
142
143                 set_irn_link(n, get_irn_link(pred));
144                 set_irn_link(pred, n);
145         }
146 }
147
148 void collect_phiprojs(ir_graph *irg)
149 {
150         assert((ir_resources_reserved(irg) & (IR_RESOURCE_IRN_LINK|IR_RESOURCE_PHI_LIST)) ==
151                 (IR_RESOURCE_IRN_LINK|IR_RESOURCE_PHI_LIST));
152         irg_walk_graph(irg, firm_clear_node_and_phi_links, collect_phiprojs_walker, NULL);
153 }
154
155 /*--------------------------------------------------------------------*/
156 /*  Functionality for part_block                                      */
157 /*--------------------------------------------------------------------*/
158
159 /**
160  * Moves node and all predecessors of node from from_bl to to_bl.
161  * Does not move predecessors of Phi nodes (or block nodes).
162  */
163 static void move(ir_node *node, ir_node *from_bl, ir_node *to_bl)
164 {
165         int i, arity;
166
167         /* move this node */
168         set_nodes_block(node, to_bl);
169
170         /* move its Projs */
171         if (get_irn_mode(node) == mode_T) {
172                 ir_node *proj = (ir_node*)get_irn_link(node);
173                 while (proj) {
174                         if (get_nodes_block(proj) == from_bl)
175                                 set_nodes_block(proj, to_bl);
176                         proj = (ir_node*)get_irn_link(proj);
177                 }
178         }
179
180         if (is_Phi(node))
181                 return;
182
183         /* recursion ... */
184         arity = get_irn_arity(node);
185         for (i = 0; i < arity; i++) {
186                 ir_node *pred = get_irn_n(node, i);
187                 if (get_nodes_block(pred) == from_bl)
188                         move(pred, from_bl, to_bl);
189         }
190 }
191
192 /**
193  * Moves node and all predecessors of node from from_bl to to_bl.
194  * Does not move predecessors of Phi nodes (or block nodes).
195  */
196 static void move_edges(ir_node *node, ir_node *from_bl, ir_node *to_bl)
197 {
198         int i, arity;
199
200         /* move this node */
201         set_nodes_block(node, to_bl);
202
203         /* move its Projs */
204         if (get_irn_mode(node) == mode_T) {
205                 const ir_edge_t *edge;
206                 foreach_out_edge(node, edge) {
207                         ir_node *proj = get_edge_src_irn(edge);
208                         set_nodes_block(proj, to_bl);
209                 }
210         }
211
212         /* We must not move predecessors of Phi nodes, even if they are in
213          * from_bl. (because these are values from an earlier loop iteration
214          * which are not predecessors of node here)
215          */
216         if (is_Phi(node))
217                 return;
218
219         /* recursion ... */
220         arity = get_irn_arity(node);
221         for (i = 0; i < arity; i++) {
222                 ir_node *pred = get_irn_n(node, i);
223                 if (get_nodes_block(pred) == from_bl)
224                         move_edges(pred, from_bl, to_bl);
225         }
226 }
227
228 void part_block(ir_node *node)
229 {
230         ir_graph *irg = get_irn_irg(node);
231         ir_node  *new_block, *old_block;
232         ir_node  *phi, *jmp;
233
234         /* Turn off optimizations so that blocks are not merged again. */
235         int rem_opt = get_opt_optimize();
236         set_optimize(0);
237
238         /* Transform the control flow */
239         old_block = get_nodes_block(node);
240         new_block = new_r_Block(irg, get_Block_n_cfgpreds(old_block),
241                                 get_Block_cfgpred_arr(old_block));
242
243         /* create a jump from new_block to old_block, which is now the lower one */
244         jmp = new_r_Jmp(new_block);
245         set_irn_in(old_block, 1, &jmp);
246
247         /* move node and its predecessors to new_block */
248         move(node, old_block, new_block);
249
250         /* move Phi nodes to new_block */
251         phi = get_Block_phis(old_block);
252         set_Block_phis(new_block, phi);
253         set_Block_phis(old_block, NULL);
254         while (phi) {
255                 set_nodes_block(phi, new_block);
256                 phi = get_Phi_next(phi);
257         }
258
259         set_optimize(rem_opt);
260 }
261
262 ir_node *part_block_edges(ir_node *node)
263 {
264         ir_graph        *irg       = get_irn_irg(node);
265         ir_node         *old_block = get_nodes_block(node);
266         ir_node         *new_block = new_r_Block(irg,
267                                                  get_Block_n_cfgpreds(old_block),
268                                                  get_Block_cfgpred_arr(old_block));
269         const ir_edge_t *edge;
270         const ir_edge_t *next;
271
272         /* old_block has no predecessors anymore for now */
273         set_irn_in(old_block, 0, NULL);
274
275         /* move node and its predecessors to new_block */
276         move_edges(node, old_block, new_block);
277
278         /* move Phi nodes to new_block */
279         foreach_out_edge_safe(old_block, edge, next) {
280                 ir_node *phi = get_edge_src_irn(edge);
281                 if (!is_Phi(phi))
282                         continue;
283                 set_nodes_block(phi, new_block);
284         }
285
286         return old_block;
287 }
288
289 void kill_node(ir_node *node)
290 {
291         ir_graph *irg = get_irn_irg(node);
292
293         if (edges_activated(irg)) {
294                 edges_node_deleted(node);
295         }
296         /* noone is allowed to reference this node anymore */
297         set_irn_op(node, op_Deleted);
298 }