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