Do not pass the cg to transform_nodes().
[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         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         set_irn_link(old_node, new_node);
60         mark_irn_visited(old_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         DEBUG_ONLY(be_set_transformed_node(node, NULL));
136
137         op = get_irn_op(node);
138         if (op->ops.generic) {
139                 be_transform_func *transform = (be_transform_func *)op->ops.generic;
140
141                 new_node = transform(node);
142                 assert(new_node != NULL);
143         } else {
144                 new_node = be_duplicate_node(node);
145         }
146
147         be_set_transformed_node(node, new_node);
148         hook_dead_node_elim_subst(current_ir_graph, node, new_node);
149         return new_node;
150 }
151
152 /**
153  * enqueue all inputs into the transform queue.
154  */
155 void be_enqueue_preds(ir_node *node) {
156         int i, arity;
157
158         /* put the preds in the worklist */
159         arity = get_irn_arity(node);
160         for (i = 0; i < arity; ++i) {
161                 ir_node *pred = get_irn_n(node, i);
162                 pdeq_putr(env.worklist, pred);
163         }
164 }
165
166 /**
167  * Rewire nodes which are potential loops (like Phis) to avoid endless loops.
168  */
169 static void fix_loops(ir_node *node) {
170         int i, arity;
171         int changed;
172
173         assert(node_is_in_irgs_storage(env.irg, node));
174
175         if (irn_visited_else_mark(node))
176                 return;
177
178         changed = 0;
179         if (! is_Block(node)) {
180                 ir_node *block     = get_nodes_block(node);
181                 ir_node *new_block = get_irn_link(block);
182
183                 if (new_block != NULL) {
184                         set_nodes_block(node, new_block);
185                         block = new_block;
186                         changed = 1;
187                 }
188
189                 fix_loops(block);
190         }
191
192         arity = get_irn_arity(node);
193         for (i = 0; i < arity; ++i) {
194                 ir_node *in = get_irn_n(node, i);
195                 ir_node *nw = get_irn_link(in);
196
197                 if (nw != NULL && nw != in) {
198                         set_irn_n(node, i, nw);
199                         in = nw;
200                         changed = 1;
201                 }
202
203                 fix_loops(in);
204         }
205         /* fix proj block */
206         if(is_Proj(node)) {
207                 set_nodes_block(node, get_nodes_block(get_Proj_pred(node)));
208                 changed = 1;
209         }
210
211         arity = get_irn_deps(node);
212         for (i = 0; i < arity; ++i) {
213                 ir_node *in = get_irn_dep(node, i);
214                 ir_node *nw = get_irn_link(in);
215
216                 if (nw != NULL && nw != in) {
217                         set_irn_dep(node, i, nw);
218                         in = nw;
219                         changed = 1;
220                 }
221
222                 fix_loops(in);
223         }
224
225         if(changed) {
226                 identify_remember(current_ir_graph->value_table, node);
227         }
228 }
229
230 ir_node *be_pre_transform_node(ir_node *place) {
231         if (place == NULL)
232                 return NULL;
233
234         return be_transform_node(place);
235 }
236
237 static void pre_transform_anchor(int anchor)
238 {
239         ir_node *old_anchor_node = get_irn_n(env.old_anchor, anchor);
240         ir_node *transformed     = be_transform_node(old_anchor_node);
241         set_irg_anchor(current_ir_graph, anchor, transformed);
242 }
243
244 static void kill_unused_anchor(int anchor)
245 {
246         ir_node *old_anchor_node = get_irn_n(env.old_anchor, anchor);
247         ir_node *old_bad         = get_irn_n(env.old_anchor, anchor_bad);
248         if(old_anchor_node != NULL && get_irn_n_edges(old_anchor_node) <= 1) {
249                 set_irn_n(env.old_anchor, anchor, old_bad);
250         }
251 }
252
253 /**
254  * Transforms all nodes. Deletes the old obstack and creates a new one.
255  */
256 static void transform_nodes(ir_graph *irg, arch_pretrans_nodes *pre_transform)
257 {
258         int       i;
259         ir_node  *old_end, *new_anchor;
260
261         hook_dead_node_elim(irg, 1);
262
263         inc_irg_visited(irg);
264
265         env.irg         = irg;
266         env.worklist    = new_waitq();
267         env.old_anchor  = irg->anchor;
268
269         old_end = get_irg_end(irg);
270
271         /* put all anchor nodes in the worklist */
272         for (i = get_irg_n_anchors(irg) - 1; i >= 0; --i) {
273                 ir_node *anchor = get_irg_anchor(irg, i);
274
275                 if (anchor == NULL)
276                         continue;
277                 waitq_put(env.worklist, anchor);
278         }
279
280         new_anchor  = new_Anchor(irg);
281         irg->anchor = new_anchor;
282
283         /* pre transform some anchors (so they are available in the other transform
284          * functions) */
285         pre_transform_anchor(anchor_bad);
286         pre_transform_anchor(anchor_no_mem);
287         pre_transform_anchor(anchor_start_block);
288         pre_transform_anchor(anchor_start);
289         pre_transform_anchor(anchor_frame);
290         kill_unused_anchor(anchor_tls);
291
292         if (pre_transform)
293                 pre_transform();
294
295         /* process worklist (this should transform all nodes in the graph) */
296         while (! waitq_empty(env.worklist)) {
297                 ir_node *node = waitq_get(env.worklist);
298                 be_transform_node(node);
299         }
300
301         /* fix loops and set new anchors*/
302         inc_irg_visited(irg);
303         for (i = get_irg_n_anchors(irg) - 1; i >= 0; --i) {
304                 ir_node *anchor = get_irn_n(env.old_anchor, i);
305
306                 if (anchor == NULL)
307                         continue;
308
309                 anchor = get_irn_link(anchor);
310                 fix_loops(anchor);
311                 set_irn_n(new_anchor, i, anchor);
312         }
313         set_nodes_block(new_anchor, get_irg_anchor(irg, anchor_end_block));
314
315         del_waitq(env.worklist);
316         free_End(old_end);
317         hook_dead_node_elim(irg, 0);
318 }
319
320 /**
321  * Transform helper for blocks.
322  */
323 static ir_node *gen_Block(ir_node *node) {
324         ir_graph *irg             = current_ir_graph;
325         dbg_info *dbgi            = get_irn_dbg_info(node);
326         ir_node  *old_start_block = get_irn_n(env.old_anchor, anchor_start_block);
327         ir_node  *macroblock      = get_Block_MacroBlock(node);
328         ir_node  *block;
329
330         /*
331          * We replace the ProjX from the start node with a jump,
332          * so the startblock has no preds anymore now
333          */
334         if (node == old_start_block) {
335                 return new_rd_Block(dbgi, irg, 0, NULL);
336         }
337
338         /* we use the old blocks for now, because jumps allow cycles in the graph
339          * we have to fix this later */
340         block = new_ir_node(dbgi, irg, NULL, get_irn_op(node), get_irn_mode(node),
341                             get_irn_arity(node), get_irn_in(node) + 1);
342         copy_node_attr(node, block);
343 #ifdef DEBUG_libfirm
344         block->node_nr = node->node_nr;
345 #endif
346         if (node == macroblock) {
347                 /* this node is a macroblock header */
348                 set_Block_MacroBlock(block, block);
349         } else {
350                 macroblock = be_transform_node(macroblock);
351                 set_Block_MacroBlock(block, macroblock);
352         }
353
354         /* put the preds in the worklist */
355         be_enqueue_preds(node);
356
357         return block;
358 }
359
360 static ir_node *gen_End(ir_node *node) {
361         /* end has to be duplicated manually because we need a dynamic in array */
362         ir_graph *irg   = current_ir_graph;
363         dbg_info *dbgi  = get_irn_dbg_info(node);
364         ir_node  *block = be_transform_node(get_nodes_block(node));
365         int      i, arity;
366         ir_node  *new_end;
367
368         new_end = new_ir_node(dbgi, irg, block, op_End, mode_X, -1, NULL);
369         copy_node_attr(node, new_end);
370         be_duplicate_deps(node, new_end);
371
372         set_irg_end(irg, new_end);
373
374         /* transform preds */
375         arity = get_irn_arity(node);
376         for (i = 0; i < arity; ++i) {
377                 ir_node *in     = get_irn_n(node, i);
378                 ir_node *new_in = be_transform_node(in);
379
380                 add_End_keepalive(new_end, new_in);
381         }
382
383         return new_end;
384 }
385
386 void be_transform_graph(be_irg_t *birg, arch_pretrans_nodes *func)
387 {
388         ir_graph *irg = birg->irg;
389         ir_graph *old_current_ir_graph = current_ir_graph;
390         struct obstack *old_obst = NULL;
391         struct obstack *new_obst = NULL;
392
393         current_ir_graph = irg;
394
395         /* create a new obstack */
396         old_obst = irg->obst;
397         new_obst = XMALLOC(struct obstack);
398         obstack_init(new_obst);
399         irg->obst = new_obst;
400         irg->last_node_idx = 0;
401
402         /* create new value table for CSE */
403         del_identities(irg->value_table);
404         irg->value_table = new_identities();
405
406         /* enter special helper */
407         op_Block->ops.generic = (op_func)gen_Block;
408         op_End->ops.generic   = (op_func)gen_End;
409
410         /* do the main transformation */
411         transform_nodes(irg, func);
412
413         /* free the old obstack */
414         obstack_free(old_obst, 0);
415         xfree(old_obst);
416
417         /* restore state */
418         current_ir_graph = old_current_ir_graph;
419
420         /* most analysis info is wrong after transformation */
421         free_callee_info(irg);
422         free_irg_outs(irg);
423         free_trouts();
424         free_loop_information(irg);
425         set_irg_doms_inconsistent(irg);
426
427         be_liveness_invalidate(be_get_birg_liveness(birg));
428         /* Hack for now, something is buggy with invalidate liveness... */
429         birg->lv = NULL;
430         be_invalidate_dom_front(birg);
431
432         /* recalculate edges */
433         edges_deactivate(irg);
434         edges_activate(irg);
435
436         if (birg->lv) {
437                 be_liveness_free(birg->lv);
438                 birg->lv = be_liveness(birg);
439         }
440 }