Do not mark the transformed as visited. It makes no sense at all.
[libfirm] / ir / be / betranshlp.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       be transform helper extracted from the ia32 backend.
23  * @author      Matthias Braun, Michael Beck
24  * @date        14.06.2007
25  * @version     $Id$
26  */
27 #ifdef HAVE_CONFIG_H
28 #include "config.h"
29 #endif
30
31 #include "pdeq.h"
32 #include "irop_t.h"
33 #include "iropt_t.h"
34 #include "irnode_t.h"
35 #include "irgraph_t.h"
36 #include "ircons_t.h"
37 #include "irhooks.h"
38 #include "iredges.h"
39 #include "irouts.h"
40 #include "trouts.h"
41 #include "cgana.h"
42 #include "debug.h"
43
44 #include "beirg_t.h"
45 #include "betranshlp.h"
46
47 typedef struct be_transform_env_t {
48         ir_graph *irg;         /**< The irg, the node should be created in */
49         int      visited;      /**< visited count that indicates whether a
50                                     node is already transformed */
51         waitq    *worklist;    /**< worklist of nodes that still need to be
52                                     transformed */
53         ir_node  *old_anchor;  /**< the old anchor node in the old irg */
54 } be_transform_env_t;
55
56
57 static be_transform_env_t env;
58
59 void be_set_transformed_node(ir_node *old_node, ir_node *new_node) {
60         set_irn_link(old_node, new_node);
61 }
62
63 int be_is_transformed(const ir_node *node) {
64         return irn_visited(node);
65 }
66
67 static INLINE ir_node *be_get_transformed_node(ir_node *old_node) {
68         if (irn_visited(old_node)) {
69                 ir_node *new_node = get_irn_link(old_node);
70                 assert(new_node != NULL);
71                 return new_node;
72         }
73         return NULL;
74 }
75
76 void be_duplicate_deps(ir_node *old_node, ir_node *new_node) {
77         int i;
78         int deps = get_irn_deps(old_node);
79
80         for (i = 0; i < deps; ++i) {
81                 ir_node *dep     = get_irn_dep(old_node, i);
82                 ir_node *new_dep = be_transform_node(dep);
83
84                 add_irn_dep(new_node, new_dep);
85         }
86 }
87
88 ir_node *be_duplicate_node(ir_node *node) {
89         ir_node  *block = be_transform_node(get_nodes_block(node));
90         ir_graph *irg   = env.irg;
91         dbg_info *dbgi  = get_irn_dbg_info(node);
92         ir_mode  *mode  = get_irn_mode(node);
93         ir_op    *op    = get_irn_op(node);
94         ir_node  *new_node;
95         int      i, arity;
96
97         arity = get_irn_arity(node);
98         if (op->opar == oparity_dynamic) {
99                 new_node = new_ir_node(dbgi, irg, block, op, mode, -1, NULL);
100                 for (i = 0; i < arity; ++i) {
101                         ir_node *in = get_irn_n(node, i);
102                         in = be_transform_node(in);
103                         add_irn_n(new_node, in);
104                 }
105         } else {
106                 ir_node **ins = alloca(arity * sizeof(ins[0]));
107                 for (i = 0; i < arity; ++i) {
108                         ir_node *in = get_irn_n(node, i);
109                         ins[i] = be_transform_node(in);
110                 }
111
112                 new_node = new_ir_node(dbgi, irg, block, op, mode, arity, ins);
113         }
114
115         copy_node_attr(node, new_node);
116         be_duplicate_deps(node, new_node);
117
118 #ifdef DEBUG_libfirm
119         new_node->node_nr = node->node_nr;
120 #endif
121
122         return new_node;
123 }
124
125 /**
126  * Calls transformation function for given node and marks it visited.
127  */
128 ir_node *be_transform_node(ir_node *node) {
129         ir_op   *op;
130         ir_node *new_node = be_get_transformed_node(node);
131
132         if (new_node != NULL)
133                 return new_node;
134
135         mark_irn_visited(node);
136         DEBUG_ONLY(be_set_transformed_node(node, NULL));
137
138         op = get_irn_op(node);
139         if (op->ops.generic) {
140                 be_transform_func *transform = (be_transform_func *)op->ops.generic;
141
142                 new_node = transform(node);
143                 assert(new_node != NULL);
144         } else {
145                 new_node = be_duplicate_node(node);
146         }
147
148         be_set_transformed_node(node, new_node);
149         hook_dead_node_elim_subst(current_ir_graph, node, new_node);
150         return new_node;
151 }
152
153 /**
154  * enqueue all inputs into the transform queue.
155  */
156 void be_enqueue_preds(ir_node *node) {
157         int i, arity;
158
159         /* put the preds in the worklist */
160         arity = get_irn_arity(node);
161         for (i = 0; i < arity; ++i) {
162                 ir_node *pred = get_irn_n(node, i);
163                 pdeq_putr(env.worklist, pred);
164         }
165 }
166
167 /**
168  * Rewire nodes which are potential loops (like Phis) to avoid endless loops.
169  */
170 static void fix_loops(ir_node *node) {
171         int i, arity;
172         int changed;
173
174         assert(node_is_in_irgs_storage(env.irg, node));
175
176         if (irn_visited_else_mark(node))
177                 return;
178
179         changed = 0;
180         if (! is_Block(node)) {
181                 ir_node *block     = get_nodes_block(node);
182                 ir_node *new_block = get_irn_link(block);
183
184                 if (new_block != NULL) {
185                         set_nodes_block(node, new_block);
186                         block = new_block;
187                         changed = 1;
188                 }
189
190                 fix_loops(block);
191         }
192
193         arity = get_irn_arity(node);
194         for (i = 0; i < arity; ++i) {
195                 ir_node *in = get_irn_n(node, i);
196                 ir_node *nw = get_irn_link(in);
197
198                 if (nw != NULL && nw != in) {
199                         set_irn_n(node, i, nw);
200                         in = nw;
201                         changed = 1;
202                 }
203
204                 fix_loops(in);
205         }
206         /* fix proj block */
207         if(is_Proj(node)) {
208                 set_nodes_block(node, get_nodes_block(get_Proj_pred(node)));
209                 changed = 1;
210         }
211
212         arity = get_irn_deps(node);
213         for (i = 0; i < arity; ++i) {
214                 ir_node *in = get_irn_dep(node, i);
215                 ir_node *nw = get_irn_link(in);
216
217                 if (nw != NULL && nw != in) {
218                         set_irn_dep(node, i, nw);
219                         in = nw;
220                         changed = 1;
221                 }
222
223                 fix_loops(in);
224         }
225
226         if(changed) {
227                 identify_remember(current_ir_graph->value_table, node);
228         }
229 }
230
231 ir_node *be_pre_transform_node(ir_node *place) {
232         if (place == NULL)
233                 return NULL;
234
235         return be_transform_node(place);
236 }
237
238 ir_node *be_get_old_anchor(int anchor)
239 {
240         return get_irn_n(env.old_anchor, anchor);
241 }
242
243 static void pre_transform_anchor(int anchor)
244 {
245         ir_node *old_anchor_node = get_irn_n(env.old_anchor, anchor);
246         ir_node *transformed     = be_transform_node(old_anchor_node);
247         set_irg_anchor(current_ir_graph, anchor, transformed);
248 }
249
250 static void kill_unused_anchor(int anchor)
251 {
252         ir_node *old_anchor_node = get_irn_n(env.old_anchor, anchor);
253         ir_node *old_bad         = get_irn_n(env.old_anchor, anchor_bad);
254         if(old_anchor_node != NULL && get_irn_n_edges(old_anchor_node) <= 1) {
255                 set_irn_n(env.old_anchor, anchor, old_bad);
256         }
257 }
258
259 /**
260  * Transforms all nodes. Deletes the old obstack and creates a new one.
261  */
262 static void transform_nodes(ir_graph *irg, arch_pretrans_nodes *pre_transform,
263                             void *cg)
264 {
265         int       i;
266         ir_node  *old_end, *new_anchor;
267
268         hook_dead_node_elim(irg, 1);
269
270         inc_irg_visited(irg);
271
272         env.irg         = irg;
273         env.visited     = get_irg_visited(irg);
274         env.worklist    = new_waitq();
275         env.old_anchor  = irg->anchor;
276
277         old_end = get_irg_end(irg);
278
279         /* put all anchor nodes in the worklist */
280         for (i = get_irg_n_anchors(irg) - 1; i >= 0; --i) {
281                 ir_node *anchor = get_irg_anchor(irg, i);
282
283                 if (anchor == NULL)
284                         continue;
285                 waitq_put(env.worklist, anchor);
286         }
287
288         new_anchor  = new_Anchor(irg);
289         irg->anchor = new_anchor;
290
291         /* pre transform some anchors (so they are available in the other transform
292          * functions) */
293         pre_transform_anchor(anchor_bad);
294         pre_transform_anchor(anchor_no_mem);
295         pre_transform_anchor(anchor_start_block);
296         pre_transform_anchor(anchor_start);
297         pre_transform_anchor(anchor_frame);
298         kill_unused_anchor(anchor_tls);
299
300         if (pre_transform)
301                 (*pre_transform)(cg);
302
303         /* process worklist (this should transform all nodes in the graph) */
304         while (! waitq_empty(env.worklist)) {
305                 ir_node *node = waitq_get(env.worklist);
306                 be_transform_node(node);
307         }
308
309         /* fix loops and set new anchors*/
310         inc_irg_visited(irg);
311         for (i = get_irg_n_anchors(irg) - 1; i >= 0; --i) {
312                 ir_node *anchor = get_irn_n(env.old_anchor, i);
313
314                 if (anchor == NULL)
315                         continue;
316
317                 anchor = get_irn_link(anchor);
318                 fix_loops(anchor);
319                 set_irn_n(new_anchor, i, anchor);
320         }
321         set_nodes_block(new_anchor, get_irg_anchor(irg, anchor_end_block));
322
323         del_waitq(env.worklist);
324         free_End(old_end);
325         hook_dead_node_elim(irg, 0);
326 }
327
328 /**
329  * Transform helper for blocks.
330  */
331 static ir_node *gen_Block(ir_node *node) {
332         ir_graph *irg             = current_ir_graph;
333         dbg_info *dbgi            = get_irn_dbg_info(node);
334         ir_node  *old_start_block = get_irn_n(env.old_anchor, anchor_start_block);
335         ir_node  *macroblock      = get_Block_MacroBlock(node);
336         ir_node  *block;
337
338         /*
339          * We replace the ProjX from the start node with a jump,
340          * so the startblock has no preds anymore now
341          */
342         if (node == old_start_block) {
343                 return new_rd_Block(dbgi, irg, 0, NULL);
344         }
345
346         /* we use the old blocks for now, because jumps allow cycles in the graph
347          * we have to fix this later */
348         block = new_ir_node(dbgi, irg, NULL, get_irn_op(node), get_irn_mode(node),
349                             get_irn_arity(node), get_irn_in(node) + 1);
350         copy_node_attr(node, block);
351 #ifdef DEBUG_libfirm
352         block->node_nr = node->node_nr;
353 #endif
354         if (node == macroblock) {
355                 /* this node is a macroblock header */
356                 set_Block_MacroBlock(block, block);
357         } else {
358                 macroblock = be_transform_node(macroblock);
359                 set_Block_MacroBlock(block, macroblock);
360         }
361
362         /* put the preds in the worklist */
363         be_enqueue_preds(node);
364
365         return block;
366 }
367
368 static ir_node *gen_End(ir_node *node) {
369         /* end has to be duplicated manually because we need a dynamic in array */
370         ir_graph *irg   = current_ir_graph;
371         dbg_info *dbgi  = get_irn_dbg_info(node);
372         ir_node  *block = be_transform_node(get_nodes_block(node));
373         int      i, arity;
374         ir_node  *new_end;
375
376         new_end = new_ir_node(dbgi, irg, block, op_End, mode_X, -1, NULL);
377         copy_node_attr(node, new_end);
378         be_duplicate_deps(node, new_end);
379
380         set_irg_end(irg, new_end);
381
382         /* transform preds */
383         arity = get_irn_arity(node);
384         for (i = 0; i < arity; ++i) {
385                 ir_node *in     = get_irn_n(node, i);
386                 ir_node *new_in = be_transform_node(in);
387
388                 add_End_keepalive(new_end, new_in);
389         }
390
391         return new_end;
392 }
393
394 void be_transform_graph(be_irg_t *birg, arch_pretrans_nodes *func, void *cg)
395 {
396         ir_graph *irg = birg->irg;
397         ir_graph *old_current_ir_graph = current_ir_graph;
398         struct obstack *old_obst = NULL;
399         struct obstack *new_obst = NULL;
400
401         current_ir_graph = irg;
402
403         /* create a new obstack */
404         old_obst = irg->obst;
405         new_obst = XMALLOC(struct obstack);
406         obstack_init(new_obst);
407         irg->obst = new_obst;
408         irg->last_node_idx = 0;
409
410         /* create new value table for CSE */
411         del_identities(irg->value_table);
412         irg->value_table = new_identities();
413
414         /* enter special helper */
415         op_Block->ops.generic = (op_func)gen_Block;
416         op_End->ops.generic   = (op_func)gen_End;
417
418         /* do the main transformation */
419         transform_nodes(irg, func, cg);
420
421         /* free the old obstack */
422         obstack_free(old_obst, 0);
423         xfree(old_obst);
424
425         /* restore state */
426         current_ir_graph = old_current_ir_graph;
427
428         /* most analysis info is wrong after transformation */
429         free_callee_info(irg);
430         free_irg_outs(irg);
431         free_trouts();
432         free_loop_information(irg);
433         set_irg_doms_inconsistent(irg);
434
435         be_liveness_invalidate(be_get_birg_liveness(birg));
436         /* Hack for now, something is buggy with invalidate liveness... */
437         birg->lv = NULL;
438         be_invalidate_dom_front(birg);
439
440         /* recalculate edges */
441         edges_deactivate(irg);
442         edges_activate(irg);
443
444         if (birg->lv) {
445                 be_liveness_free(birg->lv);
446                 birg->lv = be_liveness(birg);
447         }
448 }