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