514cc49faf58a2418f9f9cd9d44b82cb0ba9c5c4
[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 }
119
120 /*--------------------------------------------------------------------*/
121 /*  Functionality for collect_phis                                    */
122 /*--------------------------------------------------------------------*/
123
124 /**
125  * Walker: links all Phi nodes to their Blocks lists,
126  *         all Proj nodes to there predecessors.
127  */
128 static void collect_phiprojs_walker(ir_node *n, void *env)
129 {
130         ir_node *pred;
131         (void) env;
132
133         if (is_Phi(n)) {
134                 ir_node *block = get_nodes_block(n);
135                 add_Block_phi(block, n);
136         } else if (is_Proj(n)) {
137                 pred = n;
138                 do {
139                         pred = get_Proj_pred(pred);
140                 } while (is_Proj(pred));
141
142                 set_irn_link(n, get_irn_link(pred));
143                 set_irn_link(pred, n);
144         }
145 }
146
147 void collect_phiprojs(ir_graph *irg)
148 {
149         assert((ir_resources_reserved(irg) & (IR_RESOURCE_IRN_LINK|IR_RESOURCE_PHI_LIST)) ==
150                 (IR_RESOURCE_IRN_LINK|IR_RESOURCE_PHI_LIST));
151         irg_walk_graph(irg, firm_clear_node_and_phi_links, collect_phiprojs_walker, NULL);
152 }
153
154 /*--------------------------------------------------------------------*/
155 /*  Functionality for part_block                                      */
156 /*--------------------------------------------------------------------*/
157
158 /**
159  * Moves node and all predecessors of node from from_bl to to_bl.
160  * Does not move predecessors of Phi nodes (or block nodes).
161  */
162 static void move(ir_node *node, ir_node *from_bl, ir_node *to_bl)
163 {
164         int i, arity;
165
166         /* move this node */
167         set_nodes_block(node, to_bl);
168
169         /* move its Projs */
170         if (get_irn_mode(node) == mode_T) {
171                 ir_node *proj = (ir_node*)get_irn_link(node);
172                 while (proj) {
173                         if (get_nodes_block(proj) == from_bl)
174                                 set_nodes_block(proj, to_bl);
175                         proj = (ir_node*)get_irn_link(proj);
176                 }
177         }
178
179         if (is_Phi(node))
180                 return;
181
182         /* recursion ... */
183         arity = get_irn_arity(node);
184         for (i = 0; i < arity; i++) {
185                 ir_node *pred = get_irn_n(node, i);
186                 if (get_nodes_block(pred) == from_bl)
187                         move(pred, from_bl, to_bl);
188         }
189 }
190
191 /**
192  * Moves node and all predecessors of node from from_bl to to_bl.
193  * Does not move predecessors of Phi nodes (or block nodes).
194  */
195 static void move_edges(ir_node *node, ir_node *from_bl, ir_node *to_bl)
196 {
197         int i, arity;
198
199         /* move this node */
200         set_nodes_block(node, to_bl);
201
202         /* move its Projs */
203         if (get_irn_mode(node) == mode_T) {
204                 const ir_edge_t *edge;
205                 foreach_out_edge(node, edge) {
206                         ir_node *proj = get_edge_src_irn(edge);
207                         set_nodes_block(proj, to_bl);
208                 }
209         }
210
211         /* We must not move predecessors of Phi nodes, even if they are in
212          * from_bl. (because these are values from an earlier loop iteration
213          * which are not predecessors of node here)
214          */
215         if (is_Phi(node))
216                 return;
217
218         /* recursion ... */
219         arity = get_irn_arity(node);
220         for (i = 0; i < arity; i++) {
221                 ir_node *pred = get_irn_n(node, i);
222                 if (get_nodes_block(pred) == from_bl)
223                         move_edges(pred, from_bl, to_bl);
224         }
225 }
226
227 void part_block(ir_node *node)
228 {
229         ir_graph *irg = get_irn_irg(node);
230         ir_node  *new_block, *old_block;
231         ir_node  *phi, *jmp;
232
233         /* Turn off optimizations so that blocks are not merged again. */
234         int rem_opt = get_opt_optimize();
235         set_optimize(0);
236
237         /* Transform the control flow */
238         old_block = get_nodes_block(node);
239         new_block = new_r_Block(irg, get_Block_n_cfgpreds(old_block),
240                                 get_Block_cfgpred_arr(old_block));
241
242         /* create a jump from new_block to old_block, which is now the lower one */
243         jmp = new_r_Jmp(new_block);
244         set_irn_in(old_block, 1, &jmp);
245
246         /* move node and its predecessors to new_block */
247         move(node, old_block, new_block);
248
249         /* move Phi nodes to new_block */
250         phi = get_Block_phis(old_block);
251         set_Block_phis(new_block, phi);
252         set_Block_phis(old_block, NULL);
253         while (phi) {
254                 set_nodes_block(phi, new_block);
255                 phi = get_Phi_next(phi);
256         }
257
258         set_optimize(rem_opt);
259 }
260
261 ir_node *part_block_edges(ir_node *node)
262 {
263         ir_graph        *irg       = get_irn_irg(node);
264         ir_node         *old_block = get_nodes_block(node);
265         ir_node         *new_block = new_r_Block(irg,
266                                                  get_Block_n_cfgpreds(old_block),
267                                                  get_Block_cfgpred_arr(old_block));
268         const ir_edge_t *edge;
269         const ir_edge_t *next;
270
271         /* old_block has no predecessors anymore for now */
272         set_irn_in(old_block, 0, NULL);
273
274         /* move node and its predecessors to new_block */
275         move_edges(node, old_block, new_block);
276
277         /* move Phi nodes to new_block */
278         foreach_out_edge_safe(old_block, edge, next) {
279                 ir_node *phi = get_edge_src_irn(edge);
280                 if (!is_Phi(phi))
281                         continue;
282                 set_nodes_block(phi, new_block);
283         }
284
285         return old_block;
286 }
287
288 void kill_node(ir_node *node)
289 {
290         ir_graph *irg = get_irn_irg(node);
291
292         if (edges_activated(irg)) {
293                 edges_node_deleted(node);
294         }
295         /* noone is allowed to reference this node anymore */
296         set_irn_op(node, op_Deleted);
297 }