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