s/\<\(LC_\)\?INLINE\>/inline/.
[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 /**
154  * clear all links, including the Phi list of blocks and Phi nodes.
155  */
156 static void clear_node_and_phis_links(ir_node *n, void *env) {
157         (void) env;
158
159         set_irn_link(n, NULL);
160         if (is_Block(n))
161                 set_Block_phis(n, NULL);
162         else if (is_Phi(n))
163                 set_Phi_next(n, NULL);
164 }
165
166 void collect_phiprojs(ir_graph *irg) {
167         irg_walk_graph(irg, clear_node_and_phis_links, collect_phiprojs_walker, NULL);
168 }
169
170 /*--------------------------------------------------------------------*/
171 /*  Functionality for part_block                                      */
172 /*--------------------------------------------------------------------*/
173
174 /**
175  * Moves node and all predecessors of node from from_bl to to_bl.
176  * Does not move predecessors of Phi nodes (or block nodes).
177  */
178 static void move(ir_node *node, ir_node *from_bl, ir_node *to_bl) {
179         int i, arity;
180
181         /* move this node */
182         set_nodes_block(node, to_bl);
183
184         /* move its Projs */
185         if (get_irn_mode(node) == mode_T) {
186                 ir_node *proj = get_irn_link(node);
187                 while (proj) {
188                         if (get_nodes_block(proj) == from_bl)
189                                 set_nodes_block(proj, to_bl);
190                         proj = get_irn_link(proj);
191                 }
192         }
193
194         /* recursion ... */
195         if (is_Phi(node))
196                 return;
197
198         arity = get_irn_arity(node);
199         for (i = 0; i < arity; i++) {
200                 ir_node *pred = get_irn_n(node, i);
201                 if (get_nodes_block(pred) == from_bl)
202                         move(pred, from_bl, to_bl);
203         }
204 }
205
206 void part_block(ir_node *node) {
207         ir_node *new_block;
208         ir_node *old_block;
209         ir_node *phi;
210         ir_node *mbh;
211         ir_node *next, *block;
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         mbh       = get_Block_MacroBlock(old_block);
220         new_block = new_Block(get_Block_n_cfgpreds(old_block),
221                               get_Block_cfgpred_arr(old_block));
222
223         if (mbh != old_block) {
224                 /* we splitting a partBlock */
225                 set_Block_MacroBlock(new_block, mbh);
226         } else {
227                 /* we are splitting a header: this creates a new header */
228                 set_Block_MacroBlock(new_block, new_block);
229         }
230         set_irg_current_block(current_ir_graph, new_block);
231         {
232                 ir_node *jmp = new_Jmp();
233                 set_irn_in(old_block, 1, &jmp);
234                 irn_vrfy_irg(old_block, current_ir_graph);
235         }
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         /* rewire partBlocks */
250         if (mbh != old_block) {
251                 ir_node *list = NULL;
252
253                 /* move blocks from mbh to old_block if old_block dominates them */
254                 block = get_irn_link(mbh);
255
256                 set_irn_link(mbh, NULL);
257                 set_Block_MacroBlock(old_block, old_block);
258
259                 /* note that we must splice the list of partBlock here */
260                 for (; block != NULL; block = next) {
261                         ir_node *curr = block;
262                         assert(is_Block(curr));
263
264                         next = get_irn_link(block);
265
266                         if (block == old_block)
267                                 continue;
268
269                         assert(get_Block_MacroBlock(curr) == mbh);
270
271                         for (;;) {
272                                 if (curr == old_block) {
273                                         /* old_block dominates the block, so old_block will be
274                                            the new macro block header */
275                                         set_Block_MacroBlock(block, old_block);
276                                         set_irn_link(block, list);
277                                         list = block;
278                                         break;
279                                 }
280                                 if (curr == mbh) {
281                                         /* leave it in the mbh */
282                                         set_irn_link(block, get_irn_link(mbh));
283                                         set_irn_link(mbh, block);
284                                         break;
285                                 }
286
287                                 assert(get_Block_n_cfgpreds(curr) == 1);
288                                 curr = get_Block_cfgpred_block(curr, 0);
289                         }
290                 }
291                 /* beware: do NOT directly manipulate old_block's list, as old_block is
292                    in mbh's list and this would destroy the list! */
293                 set_irn_link(old_block, list);
294
295                 /* finally add new_block to mbh's list */
296                 set_irn_link(new_block, get_irn_link(mbh));
297                 set_irn_link(mbh, new_block);
298         } else {
299                 /* move blocks from mbh to new_block */
300                 block = get_irn_link(mbh);
301
302                 set_irn_link(mbh, NULL);
303                 set_irn_link(new_block, NULL);
304
305                 for (; block != NULL; block = next) {
306                         next = get_irn_link(block);
307
308                         set_Block_MacroBlock(block, new_block);
309                         set_irn_link(block, get_irn_link(new_block));
310                         set_irn_link(new_block, block);
311                 }
312         }
313
314         set_optimize(rem_opt);
315 }
316
317 /* kill a node by setting its predecessors to Bad and finally exchange the node by Bad itself. */
318 void kill_node(ir_node *node) {
319         ir_graph *irg = get_irn_irg(node);
320         ir_node *bad = get_irg_bad(irg);
321         int i;
322
323         for (i = get_irn_arity(node) - 1; i >= -1; --i) {
324                 set_irn_n(node, i, bad);
325         }
326         exchange(node, bad);
327 }