we don't need no stinking selfs
[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         mark_irn_visited(new_node);
150         hook_dead_node_elim_subst(current_ir_graph, node, new_node);
151         return new_node;
152 }
153
154 /**
155  * enqueue all inputs into the transform queue.
156  */
157 void be_enqueue_preds(ir_node *node) {
158         int i, arity;
159
160         /* put the preds in the worklist */
161         arity = get_irn_arity(node);
162         for (i = 0; i < arity; ++i) {
163                 ir_node *pred = get_irn_n(node, i);
164                 pdeq_putr(env.worklist, pred);
165         }
166 }
167
168 /**
169  * Rewire nodes which are potential loops (like Phis) to avoid endless loops.
170  */
171 static void fix_loops(ir_node *node) {
172         int i, arity;
173         int changed;
174
175         assert(node_is_in_irgs_storage(env.irg, node));
176
177         if (irn_visited(node))
178                 return;
179
180         mark_irn_visited(node);
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 ir_node *be_get_old_anchor(int anchor)
242 {
243         return get_irn_n(env.old_anchor, anchor);
244 }
245
246 static void pre_transform_anchor(int anchor)
247 {
248         ir_node *old_anchor_node = get_irn_n(env.old_anchor, anchor);
249         ir_node *transformed     = be_transform_node(old_anchor_node);
250         set_irg_anchor(current_ir_graph, anchor, transformed);
251 }
252
253 static void kill_unused_anchor(int anchor)
254 {
255         ir_node *old_anchor_node = get_irn_n(env.old_anchor, anchor);
256         ir_node *old_bad         = get_irn_n(env.old_anchor, anchor_bad);
257         if(old_anchor_node != NULL && get_irn_n_edges(old_anchor_node) <= 1) {
258                 set_irn_n(env.old_anchor, anchor, old_bad);
259         }
260 }
261
262 /**
263  * Transforms all nodes. Deletes the old obstack and creates a new one.
264  */
265 static void transform_nodes(ir_graph *irg, arch_pretrans_nodes *pre_transform,
266                             void *cg)
267 {
268         int       i;
269         ir_node  *old_end, *new_anchor;
270
271         hook_dead_node_elim(irg, 1);
272
273         inc_irg_visited(irg);
274
275         env.irg         = irg;
276         env.visited     = get_irg_visited(irg);
277         env.worklist    = new_waitq();
278         env.old_anchor  = irg->anchor;
279
280         old_end = get_irg_end(irg);
281
282         /* put all anchor nodes in the worklist */
283         for (i = get_irg_n_anchors(irg) - 1; i >= 0; --i) {
284                 ir_node *anchor = get_irg_anchor(irg, i);
285
286                 if (anchor == NULL)
287                         continue;
288                 waitq_put(env.worklist, anchor);
289         }
290
291         new_anchor  = new_Anchor(irg);
292         irg->anchor = new_anchor;
293
294         /* pre transform some anchors (so they are available in the other transform
295          * functions) */
296         pre_transform_anchor(anchor_bad);
297         pre_transform_anchor(anchor_no_mem);
298         pre_transform_anchor(anchor_start_block);
299         pre_transform_anchor(anchor_start);
300         pre_transform_anchor(anchor_frame);
301         kill_unused_anchor(anchor_tls);
302
303         if (pre_transform)
304                 (*pre_transform)(cg);
305
306         /* process worklist (this should transform all nodes in the graph) */
307         while (! waitq_empty(env.worklist)) {
308                 ir_node *node = waitq_get(env.worklist);
309                 be_transform_node(node);
310         }
311
312         /* fix loops and set new anchors*/
313         inc_irg_visited(irg);
314         for (i = get_irg_n_anchors(irg) - 1; i >= 0; --i) {
315                 ir_node *anchor = get_irn_n(env.old_anchor, i);
316
317                 if (anchor == NULL)
318                         continue;
319
320                 anchor = get_irn_link(anchor);
321                 fix_loops(anchor);
322                 set_irn_n(new_anchor, i, anchor);
323         }
324         set_nodes_block(new_anchor, get_irg_anchor(irg, anchor_end_block));
325
326         del_waitq(env.worklist);
327         free_End(old_end);
328         hook_dead_node_elim(irg, 0);
329 }
330
331 /**
332  * Transform helper for blocks.
333  */
334 static ir_node *gen_Block(ir_node *node) {
335         ir_graph *irg             = current_ir_graph;
336         dbg_info *dbgi            = get_irn_dbg_info(node);
337         ir_node  *old_start_block = get_irn_n(env.old_anchor, anchor_start_block);
338         ir_node  *macroblock      = get_Block_MacroBlock(node);
339         ir_node  *block;
340
341         /*
342          * We replace the ProjX from the start node with a jump,
343          * so the startblock has no preds anymore now
344          */
345         if (node == old_start_block) {
346                 return new_rd_Block(dbgi, irg, 0, NULL);
347         }
348
349         /* we use the old blocks for now, because jumps allow cycles in the graph
350          * we have to fix this later */
351         block = new_ir_node(dbgi, irg, NULL, get_irn_op(node), get_irn_mode(node),
352                             get_irn_arity(node), get_irn_in(node) + 1);
353         copy_node_attr(node, block);
354 #ifdef DEBUG_libfirm
355         block->node_nr = node->node_nr;
356 #endif
357         if (node == macroblock) {
358                 /* this node is a macroblock header */
359                 set_Block_MacroBlock(block, block);
360         } else {
361                 macroblock = be_transform_node(macroblock);
362                 set_Block_MacroBlock(block, macroblock);
363         }
364
365         be_set_transformed_node(node, block);
366
367         /* put the preds in the worklist */
368         be_enqueue_preds(node);
369
370         return block;
371 }
372
373 static ir_node *gen_End(ir_node *node) {
374         /* end has to be duplicated manually because we need a dynamic in array */
375         ir_graph *irg   = current_ir_graph;
376         dbg_info *dbgi  = get_irn_dbg_info(node);
377         ir_node  *block = be_transform_node(get_nodes_block(node));
378         int      i, arity;
379         ir_node  *new_end;
380
381         new_end = new_ir_node(dbgi, irg, block, op_End, mode_X, -1, NULL);
382         copy_node_attr(node, new_end);
383         be_duplicate_deps(node, new_end);
384
385         set_irg_end(irg, new_end);
386         be_set_transformed_node(new_end, new_end);
387
388         /* transform preds */
389         arity = get_irn_arity(node);
390         for (i = 0; i < arity; ++i) {
391                 ir_node *in     = get_irn_n(node, i);
392                 ir_node *new_in = be_transform_node(in);
393
394                 add_End_keepalive(new_end, new_in);
395         }
396
397         return new_end;
398 }
399
400 void be_transform_graph(be_irg_t *birg, arch_pretrans_nodes *func, void *cg)
401 {
402         ir_graph *irg = birg->irg;
403         ir_graph *old_current_ir_graph = current_ir_graph;
404         struct obstack *old_obst = NULL;
405         struct obstack *new_obst = NULL;
406
407         current_ir_graph = irg;
408
409         /* create a new obstack */
410         old_obst = irg->obst;
411         new_obst = xmalloc(sizeof(*new_obst));
412         obstack_init(new_obst);
413         irg->obst = new_obst;
414         irg->last_node_idx = 0;
415
416         /* create new value table for CSE */
417         del_identities(irg->value_table);
418         irg->value_table = new_identities();
419
420         /* enter special helper */
421         op_Block->ops.generic = (op_func)gen_Block;
422         op_End->ops.generic   = (op_func)gen_End;
423
424         /* do the main transformation */
425         transform_nodes(irg, func, cg);
426
427         /* free the old obstack */
428         obstack_free(old_obst, 0);
429         xfree(old_obst);
430
431         /* restore state */
432         current_ir_graph = old_current_ir_graph;
433
434         /* most analysis info is wrong after transformation */
435         free_callee_info(irg);
436         free_irg_outs(irg);
437         free_trouts();
438         free_loop_information(irg);
439         set_irg_doms_inconsistent(irg);
440
441         be_liveness_invalidate(be_get_birg_liveness(birg));
442         /* Hack for now, something is buggy with invalidate liveness... */
443         birg->lv = NULL;
444         be_invalidate_dom_front(birg);
445
446         /* recalculate edges */
447         edges_deactivate(irg);
448         edges_activate(irg);
449
450         if (birg->lv) {
451                 be_liveness_free(birg->lv);
452                 birg->lv = be_liveness(birg);
453         }
454 }