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