Remove the unused macro co_gs_nodes_break().
[libfirm] / ir / be / betranshlp.c
1 /*
2  * Copyright (C) 1995-2010 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       be transform helper extracted from the ia32 backend.
23  * @author      Matthias Braun, Michael Beck
24  * @date        14.06.2007
25  */
26 #include "config.h"
27
28 #include "pdeq.h"
29 #include "irop_t.h"
30 #include "iropt_t.h"
31 #include "irnode_t.h"
32 #include "irgraph_t.h"
33 #include "ircons_t.h"
34 #include "irhooks.h"
35 #include "iredges.h"
36 #include "irouts.h"
37 #include "trouts.h"
38 #include "cgana.h"
39 #include "debug.h"
40
41 #include "beirg.h"
42 #include "beabi.h"
43 #include "betranshlp.h"
44 #include "belive.h"
45 #include "benode.h"
46
47 typedef struct be_transform_env_t {
48         ir_graph *irg;         /**< The irg, the node should be created in */
49         waitq    *worklist;    /**< worklist of nodes that still need to be
50                                     transformed */
51         ir_node  *old_anchor;  /**< the old anchor node in the old irg */
52 } be_transform_env_t;
53
54
55 static be_transform_env_t env;
56
57 void be_set_transformed_node(ir_node *old_node, ir_node *new_node)
58 {
59         ir_graph *irg = get_irn_irg(old_node);
60
61         set_irn_link(old_node, new_node);
62         mark_irn_visited(old_node);
63         hook_dead_node_elim_subst(irg, old_node, new_node);
64 }
65
66 int be_is_transformed(const ir_node *node)
67 {
68         return irn_visited(node);
69 }
70
71 static inline ir_node *be_get_transformed_node(ir_node *old_node)
72 {
73         if (irn_visited(old_node)) {
74                 ir_node *new_node = (ir_node*)get_irn_link(old_node);
75                 assert(new_node != NULL);
76                 return new_node;
77         }
78         return NULL;
79 }
80
81 void be_duplicate_deps(ir_node *old_node, ir_node *new_node)
82 {
83         int i;
84         int deps = get_irn_deps(old_node);
85
86         for (i = 0; i < deps; ++i) {
87                 ir_node *dep     = get_irn_dep(old_node, i);
88                 ir_node *new_dep = be_transform_node(dep);
89
90                 add_irn_dep(new_node, new_dep);
91         }
92 }
93
94 void be_set_transform_function(ir_op *op, be_transform_func func)
95 {
96         /* shouldn't be assigned twice (except for exchanging the default
97          * be_duplicate_node entries) */
98         assert(op->ops.generic == NULL
99                         || op->ops.generic == (op_func) be_duplicate_node);
100         op->ops.generic = (op_func) func;
101 }
102
103 /**
104  * Transform helper for blocks.
105  */
106 static ir_node *transform_block(ir_node *node)
107 {
108         ir_graph *irg  = get_irn_irg(node);
109         dbg_info *dbgi = get_irn_dbg_info(node);
110         ir_node  *block;
111
112         block = new_ir_node(dbgi, irg, NULL, get_irn_op(node), get_irn_mode(node),
113                             get_irn_arity(node), get_irn_in(node) + 1);
114         copy_node_attr(irg, node, block);
115         block->node_nr = node->node_nr;
116
117         /* put the preds in the worklist */
118         be_enqueue_preds(node);
119
120         return block;
121 }
122
123 static ir_node *transform_end(ir_node *node)
124 {
125         /* end has to be duplicated manually because we need a dynamic in array */
126         ir_graph *irg   = get_irn_irg(node);
127         dbg_info *dbgi  = get_irn_dbg_info(node);
128         ir_node  *block = be_transform_node(get_nodes_block(node));
129         int      i, arity;
130         ir_node  *new_end;
131
132         new_end = new_ir_node(dbgi, irg, block, op_End, mode_X, -1, NULL);
133         copy_node_attr(irg, node, new_end);
134         be_duplicate_deps(node, new_end);
135
136         set_irg_end(irg, new_end);
137
138         /* do not transform predecessors yet to keep the pre-transform
139          * phase from visiting all the graph */
140         arity = get_irn_arity(node);
141         for (i = 0; i < arity; ++i) {
142                 ir_node *in = get_irn_n(node, i);
143                 add_End_keepalive(new_end, in);
144         }
145         be_enqueue_preds(node);
146
147         return new_end;
148 }
149
150 void be_start_transform_setup(void)
151 {
152         ir_clear_opcodes_generic_func();
153
154         be_set_transform_function(op_Bad,         be_duplicate_node);
155         be_set_transform_function(op_be_Copy,     be_duplicate_node);
156         be_set_transform_function(op_be_CopyKeep, be_duplicate_node);
157         be_set_transform_function(op_be_IncSP,    be_duplicate_node);
158         be_set_transform_function(op_be_Keep,     be_duplicate_node);
159         be_set_transform_function(op_be_Return,   be_duplicate_node);
160         be_set_transform_function(op_be_Start,    be_duplicate_node);
161         be_set_transform_function(op_Block,       transform_block);
162         be_set_transform_function(op_End,         transform_end);
163         be_set_transform_function(op_NoMem,       be_duplicate_node);
164         be_set_transform_function(op_Pin,         be_duplicate_node);
165         be_set_transform_function(op_Start,       be_duplicate_node);
166         be_set_transform_function(op_Sync,        be_duplicate_node);
167 }
168
169 ir_node *be_duplicate_node(ir_node *node)
170 {
171         ir_node  *block = be_transform_node(get_nodes_block(node));
172         ir_graph *irg   = env.irg;
173         dbg_info *dbgi  = get_irn_dbg_info(node);
174         ir_mode  *mode  = get_irn_mode(node);
175         ir_op    *op    = get_irn_op(node);
176         ir_node  *new_node;
177         int      i, arity;
178
179         arity = get_irn_arity(node);
180         if (op->opar == oparity_dynamic) {
181                 new_node = new_ir_node(dbgi, irg, block, op, mode, -1, NULL);
182                 for (i = 0; i < arity; ++i) {
183                         ir_node *in = get_irn_n(node, i);
184                         in = be_transform_node(in);
185                         add_irn_n(new_node, in);
186                 }
187         } else {
188                 ir_node **ins = ALLOCAN(ir_node*, arity);
189                 for (i = 0; i < arity; ++i) {
190                         ir_node *in = get_irn_n(node, i);
191                         ins[i] = be_transform_node(in);
192                 }
193
194                 new_node = new_ir_node(dbgi, irg, block, op, mode, arity, ins);
195         }
196
197         copy_node_attr(irg, node, new_node);
198         be_duplicate_deps(node, new_node);
199
200         new_node->node_nr = node->node_nr;
201         return new_node;
202 }
203
204 ir_node *be_transform_node(ir_node *node)
205 {
206         ir_op             *op;
207         ir_node           *new_node = be_get_transformed_node(node);
208         be_transform_func *transform;
209
210         if (new_node != NULL)
211                 return new_node;
212
213         DEBUG_ONLY(be_set_transformed_node(node, NULL);)
214
215         op = get_irn_op(node);
216         if (op->ops.generic == NULL) {
217                 panic("No transform function registered for node %+F.", node);
218         }
219         transform = (be_transform_func *)op->ops.generic;
220
221         new_node = transform(node);
222         assert(new_node != NULL);
223
224         be_set_transformed_node(node, new_node);
225         return new_node;
226 }
227
228 void be_enqueue_preds(ir_node *node)
229 {
230         int i, arity;
231
232         /* put the preds in the worklist */
233         arity = get_irn_arity(node);
234         for (i = 0; i < arity; ++i) {
235                 ir_node *pred = get_irn_n(node, i);
236                 pdeq_putr(env.worklist, pred);
237         }
238 }
239
240 /**
241  * Rewire nodes which are potential loops (like Phis) to avoid endless loops.
242  */
243 static void fix_loops(ir_node *node)
244 {
245         int i, arity;
246         int changed;
247
248         assert(node_is_in_irgs_storage(env.irg, node));
249
250         if (irn_visited_else_mark(node))
251                 return;
252
253         changed = 0;
254         if (! is_Block(node)) {
255                 ir_node *block     = get_nodes_block(node);
256                 ir_node *new_block = (ir_node*)get_irn_link(block);
257
258                 if (new_block != NULL) {
259                         set_nodes_block(node, new_block);
260                         block = new_block;
261                         changed = 1;
262                 }
263
264                 fix_loops(block);
265         }
266
267         arity = get_irn_arity(node);
268         for (i = 0; i < arity; ++i) {
269                 ir_node *in = get_irn_n(node, i);
270                 ir_node *nw = (ir_node*)get_irn_link(in);
271
272                 if (nw != NULL && nw != in) {
273                         set_irn_n(node, i, nw);
274                         in = nw;
275                         changed = 1;
276                 }
277
278                 fix_loops(in);
279         }
280         /* fix proj block */
281         if (is_Proj(node)) {
282                 set_nodes_block(node, get_nodes_block(get_Proj_pred(node)));
283                 changed = 1;
284         }
285
286         arity = get_irn_deps(node);
287         for (i = 0; i < arity; ++i) {
288                 ir_node *in = get_irn_dep(node, i);
289                 ir_node *nw = (ir_node*)get_irn_link(in);
290
291                 if (nw != NULL && nw != in) {
292                         set_irn_dep(node, i, nw);
293                         in = nw;
294                         changed = 1;
295                 }
296
297                 fix_loops(in);
298         }
299
300         if (changed) {
301                 identify_remember(node);
302         }
303 }
304
305 ir_node *be_pre_transform_node(ir_node *place)
306 {
307         if (place == NULL)
308                 return NULL;
309
310         return be_transform_node(place);
311 }
312
313 static void pre_transform_anchor(ir_graph *irg, int anchor)
314 {
315         ir_node *old_anchor_node = get_irn_n(env.old_anchor, anchor);
316         ir_node *transformed     = be_transform_node(old_anchor_node);
317         set_irg_anchor(irg, anchor, transformed);
318 }
319
320 /**
321  * Transforms all nodes. Deletes the old obstack and creates a new one.
322  */
323 static void transform_nodes(ir_graph *irg, arch_pretrans_nodes *pre_transform)
324 {
325         int       i;
326         ir_node  *old_end, *new_anchor;
327
328         hook_dead_node_elim(irg, 1);
329
330         inc_irg_visited(irg);
331
332         env.irg        = irg;
333         env.worklist   = new_waitq();
334         env.old_anchor = irg->anchor;
335
336         old_end = get_irg_end(irg);
337
338         /* put all anchor nodes in the worklist */
339         for (i = get_irg_n_anchors(irg) - 1; i >= 0; --i) {
340                 ir_node *anchor = get_irg_anchor(irg, i);
341
342                 if (anchor == NULL)
343                         continue;
344                 waitq_put(env.worklist, anchor);
345         }
346
347         new_anchor  = new_r_Anchor(irg);
348         irg->anchor = new_anchor;
349
350         /* pre transform some anchors (so they are available in the other transform
351          * functions) */
352         pre_transform_anchor(irg, anchor_no_mem);
353         pre_transform_anchor(irg, anchor_end_block);
354         pre_transform_anchor(irg, anchor_end);
355         pre_transform_anchor(irg, anchor_start_block);
356         pre_transform_anchor(irg, anchor_start);
357         pre_transform_anchor(irg, anchor_frame);
358
359         if (pre_transform)
360                 pre_transform();
361
362         /* process worklist (this should transform all nodes in the graph) */
363         while (! waitq_empty(env.worklist)) {
364                 ir_node *node = (ir_node*)waitq_get(env.worklist);
365                 be_transform_node(node);
366         }
367
368         /* fix loops and set new anchors*/
369         inc_irg_visited(irg);
370         for (i = get_irg_n_anchors(irg) - 1; i >= 0; --i) {
371                 ir_node *anchor = get_irn_n(env.old_anchor, i);
372
373                 if (anchor == NULL)
374                         continue;
375
376                 anchor = (ir_node*)get_irn_link(anchor);
377                 fix_loops(anchor);
378                 set_irn_n(new_anchor, i, anchor);
379         }
380
381         del_waitq(env.worklist);
382         free_End(old_end);
383         hook_dead_node_elim(irg, 0);
384 }
385
386 void be_transform_graph(ir_graph *irg, arch_pretrans_nodes *func)
387 {
388         ir_graph *old_current_ir_graph = current_ir_graph;
389         struct obstack *old_obst = NULL;
390         struct obstack *new_obst = NULL;
391
392         current_ir_graph = irg;
393
394         /* create a new obstack */
395         old_obst = irg->obst;
396         new_obst = XMALLOC(struct obstack);
397         obstack_init(new_obst);
398         irg->obst = new_obst;
399         irg->last_node_idx = 0;
400
401         free_vrp_data(irg);
402
403         /* create new value table for CSE */
404         new_identities(irg);
405
406         /* do the main transformation */
407         transform_nodes(irg, func);
408
409         /* free the old obstack */
410         obstack_free(old_obst, 0);
411         xfree(old_obst);
412
413         /* restore state */
414         current_ir_graph = old_current_ir_graph;
415
416         /* most analysis info is wrong after transformation */
417         be_invalidate_live_chk(irg);
418         confirm_irg_properties(irg, IR_GRAPH_PROPERTIES_NONE);
419
420         /* recalculate edges */
421         edges_activate(irg);
422 }