- Fix some more stuff in ir_spec.py
[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 "irvrfy.h"
29 #include "irflag_t.h"
30 #include "irgwalk.h"
31 #include "irnode_t.h"
32 #include "irgraph_t.h"
33 #include "irgmod.h"
34 #include "array.h"
35 #include "ircons.h"
36 #include "irhooks.h"
37 #include "iredges_t.h"
38 #include "irtools.h"
39 #include "error.h"
40
41 /**
42  * Turns a node into a "useless" Tuple.  The Tuple just forms a tuple
43  * from several inputs.
44  * This is useful if a node returning a tuple is removed, but the Projs
45  * extracting values from the tuple are not available.
46  */
47 void turn_into_tuple(ir_node *node, int arity) {
48         assert(node);
49         set_irn_op(node, op_Tuple);
50         if (get_irn_arity(node) == arity) {
51                 /* keep old array */
52         } else {
53                 ir_graph *irg = get_irn_irg(node);
54                 ir_node *block = get_nodes_block(node);
55                 edges_node_deleted(node, irg);
56                 /* Allocate new array, don't free old in_array, it's on the obstack. */
57                 node->in = NEW_ARR_D(ir_node *, irg->obst, arity+1);
58                 /* clear the new in array, else edge_notify tries to delete garbage */
59                 memset(node->in, 0, (arity+1) * sizeof(node->in[0]));
60                 /* set the block back */
61                 set_nodes_block(node, block);
62         }
63 }
64
65 /**
66  * Insert irnode `new' in place of irnode `old'
67  * Since `new' may be bigger than `old' replace `old'
68  * by an op_Id which is smaller than everything.
69  */
70 void exchange(ir_node *old, ir_node *nw) {
71         ir_graph *irg;
72
73         assert(old && nw);
74         assert(old != nw && "Exchanging node with itself is not allowed");
75
76         irg = get_irn_irg(old);
77         assert(irg == get_irn_irg(nw) && "New node must be in same irg as old node");
78
79         hook_replace(old, nw);
80
81         /*
82          * If new outs are on, we can skip the id node creation and reroute
83          * the edges from the old node to the new directly.
84          */
85         if (edges_activated(irg)) {
86                 /* copy all dependencies from old to new */
87                 add_irn_deps(nw, old);
88
89                 edges_reroute(old, nw, irg);
90                 edges_reroute_kind(old, nw, EDGE_KIND_DEP, irg);
91                 edges_node_deleted(old, irg);
92                 old->op = op_Bad;
93         } else {
94                 /* Else, do it the old-fashioned way. */
95                 ir_node *block;
96
97                 hook_turn_into_id(old);
98
99                 block = old->in[0];
100                 if (! block) {
101                         block = is_Block(nw) ? nw : get_nodes_block(nw);
102
103                         if (! block) {
104                                 panic("cannot find legal block for id");
105                         }
106                 }
107
108                 if (get_irn_op(old)->opar == oparity_dynamic) {
109                         DEL_ARR_F(get_irn_in(old));
110                 }
111
112                 old->op    = op_Id;
113                 old->in    = NEW_ARR_D (ir_node *, irg->obst, 2);
114                 old->in[0] = block;
115                 old->in[1] = nw;
116         }
117 }
118
119 /*--------------------------------------------------------------------*/
120 /*  Functionality for collect_phis                                    */
121 /*--------------------------------------------------------------------*/
122
123 /**
124  * Walker: links all Phi nodes to their Blocks lists,
125  *         all Proj nodes to there predecessors and all
126  *         partBlocks to there MacroBlock header.
127  */
128 static void collect_phiprojs_walker(ir_node *n, void *env) {
129         ir_node *pred;
130         (void) env;
131
132         if (is_Phi(n)) {
133                 ir_node *block = get_nodes_block(n);
134                 add_Block_phi(block, n);
135         } else if (is_Proj(n)) {
136                 pred = n;
137                 do {
138                         pred = get_Proj_pred(pred);
139                 } while (is_Proj(pred));
140
141                 set_irn_link(n, get_irn_link(pred));
142                 set_irn_link(pred, n);
143         } else if (is_Block(n)) {
144                 ir_node *mbh = get_Block_MacroBlock(n);
145
146                 if (mbh != n) {
147                         set_irn_link(n, get_irn_link(mbh));
148                         set_irn_link(mbh, n);
149                 }
150         }
151 }
152
153 void collect_phiprojs(ir_graph *irg) {
154         assert((ir_resources_reserved(irg) & (IR_RESOURCE_IRN_LINK|IR_RESOURCE_PHI_LIST)) ==
155                 (IR_RESOURCE_IRN_LINK|IR_RESOURCE_PHI_LIST));
156         irg_walk_graph(irg, firm_clear_node_and_phi_links, collect_phiprojs_walker, NULL);
157 }
158
159 /*--------------------------------------------------------------------*/
160 /*  Functionality for part_block                                      */
161 /*--------------------------------------------------------------------*/
162
163 /**
164  * Moves node and all predecessors of node from from_bl to to_bl.
165  * Does not move predecessors of Phi nodes (or block nodes).
166  */
167 static void move(ir_node *node, ir_node *from_bl, ir_node *to_bl) {
168         int i, arity;
169
170         /* move this node */
171         set_nodes_block(node, to_bl);
172
173         /* move its Projs */
174         if (get_irn_mode(node) == mode_T) {
175                 ir_node *proj = get_irn_link(node);
176                 while (proj) {
177                         if (get_nodes_block(proj) == from_bl)
178                                 set_nodes_block(proj, to_bl);
179                         proj = get_irn_link(proj);
180                 }
181         }
182
183         /* recursion ... */
184         if (is_Phi(node))
185                 return;
186
187         arity = get_irn_arity(node);
188         for (i = 0; i < arity; i++) {
189                 ir_node *pred = get_irn_n(node, i);
190                 if (get_nodes_block(pred) == from_bl)
191                         move(pred, from_bl, to_bl);
192         }
193 }
194
195 void part_block(ir_node *node) {
196         ir_node *new_block;
197         ir_node *old_block;
198         ir_node *phi;
199         ir_node *mbh;
200         ir_node *next, *block;
201
202         /* Turn off optimizations so that blocks are not merged again. */
203         int rem_opt = get_opt_optimize();
204         set_optimize(0);
205
206         /* Transform the control flow */
207         old_block = get_nodes_block(node);
208         mbh       = get_Block_MacroBlock(old_block);
209         new_block = new_Block(get_Block_n_cfgpreds(old_block),
210                               get_Block_cfgpred_arr(old_block));
211
212         if (mbh != old_block) {
213                 /* we splitting a partBlock */
214                 set_Block_MacroBlock(new_block, mbh);
215         } else {
216                 /* we are splitting a header: this creates a new header */
217                 set_Block_MacroBlock(new_block, new_block);
218         }
219         set_irg_current_block(current_ir_graph, new_block);
220         {
221                 ir_node *jmp = new_Jmp();
222                 set_irn_in(old_block, 1, &jmp);
223                 irn_vrfy_irg(old_block, current_ir_graph);
224         }
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         /* rewire partBlocks */
239         if (mbh != old_block) {
240                 ir_node *list = NULL;
241
242                 /* move blocks from mbh to old_block if old_block dominates them */
243                 block = get_irn_link(mbh);
244
245                 set_irn_link(mbh, NULL);
246                 set_Block_MacroBlock(old_block, old_block);
247
248                 /* note that we must splice the list of partBlock here */
249                 for (; block != NULL; block = next) {
250                         ir_node *curr = block;
251                         assert(is_Block(curr));
252
253                         next = get_irn_link(block);
254
255                         if (block == old_block)
256                                 continue;
257
258                         assert(get_Block_MacroBlock(curr) == mbh);
259
260                         for (;;) {
261                                 if (curr == old_block) {
262                                         /* old_block dominates the block, so old_block will be
263                                            the new macro block header */
264                                         set_Block_MacroBlock(block, old_block);
265                                         set_irn_link(block, list);
266                                         list = block;
267                                         break;
268                                 }
269                                 if (curr == mbh) {
270                                         /* leave it in the mbh */
271                                         set_irn_link(block, get_irn_link(mbh));
272                                         set_irn_link(mbh, block);
273                                         break;
274                                 }
275
276                                 assert(get_Block_n_cfgpreds(curr) == 1);
277                                 curr = get_Block_cfgpred_block(curr, 0);
278                         }
279                 }
280                 /* beware: do NOT directly manipulate old_block's list, as old_block is
281                    in mbh's list and this would destroy the list! */
282                 set_irn_link(old_block, list);
283
284                 /* finally add new_block to mbh's list */
285                 set_irn_link(new_block, get_irn_link(mbh));
286                 set_irn_link(mbh, new_block);
287         } else {
288                 /* move blocks from mbh to new_block */
289                 block = get_irn_link(mbh);
290
291                 set_irn_link(mbh, NULL);
292                 set_irn_link(new_block, NULL);
293
294                 for (; block != NULL; block = next) {
295                         next = get_irn_link(block);
296
297                         set_Block_MacroBlock(block, new_block);
298                         set_irn_link(block, get_irn_link(new_block));
299                         set_irn_link(new_block, block);
300                 }
301         }
302
303         set_optimize(rem_opt);
304 }
305
306 /* kill a node by setting its predecessors to Bad and finally exchange the node by Bad itself. */
307 void kill_node(ir_node *node) {
308         ir_graph *irg = get_irn_irg(node);
309         ir_node *bad = get_irg_bad(irg);
310         int i;
311
312         for (i = get_irn_arity(node) - 1; i >= -1; --i) {
313                 set_irn_n(node, i, bad);
314         }
315         exchange(node, bad);
316 }