update copyright message
[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         assert(irn_visited(old_node));
69         return (ir_node*) get_irn_link(old_node);
70 }
71
72 void be_duplicate_deps(ir_node *old_node, ir_node *new_node) {
73         int i;
74         int deps = get_irn_deps(old_node);
75
76         for (i = 0; i < deps; ++i) {
77                 ir_node *dep     = get_irn_dep(old_node, i);
78                 ir_node *new_dep = be_transform_node(dep);
79
80                 add_irn_dep(new_node, new_dep);
81         }
82 }
83
84 ir_node *be_duplicate_node(ir_node *node) {
85         ir_node  *block = be_transform_node(get_nodes_block(node));
86         ir_graph *irg   = env.irg;
87         dbg_info *dbgi  = get_irn_dbg_info(node);
88         ir_mode  *mode  = get_irn_mode(node);
89         ir_op    *op    = get_irn_op(node);
90         ir_node  *new_node;
91         int      i, arity;
92
93         arity = get_irn_arity(node);
94         if (op->opar == oparity_dynamic) {
95                 new_node = new_ir_node(dbgi, irg, block, op, mode, -1, NULL);
96                 for (i = 0; i < arity; ++i) {
97                         ir_node *in = get_irn_n(node, i);
98                         in = be_transform_node(in);
99                         add_irn_n(new_node, in);
100                 }
101         } else {
102                 ir_node **ins = alloca(arity * sizeof(ins[0]));
103                 for (i = 0; i < arity; ++i) {
104                         ir_node *in = get_irn_n(node, i);
105                         ins[i] = be_transform_node(in);
106                 }
107
108                 new_node = new_ir_node(dbgi, irg, block, op, mode, arity, ins);
109         }
110
111         copy_node_attr(node, new_node);
112         be_duplicate_deps(node, new_node);
113
114 #ifdef DEBUG_libfirm
115         new_node->node_nr = node->node_nr;
116 #endif
117
118         return new_node;
119 }
120
121 /**
122  * Calls transformation function for given node and marks it visited.
123  */
124 ir_node *be_transform_node(ir_node *node) {
125         ir_node *new_node;
126         ir_op   *op;
127
128         if (irn_visited(node)) {
129                 new_node = be_get_transformed_node(node);
130                 assert(new_node != NULL);
131                 return new_node;
132         }
133
134         mark_irn_visited(node);
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         mark_irn_visited(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(node))
177                 return;
178
179         mark_irn_visited(node);
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 ir_node *be_get_old_anchor(int anchor)
241 {
242         return get_irn_n(env.old_anchor, anchor);
243 }
244
245 static void pre_transform_anchor(int anchor)
246 {
247         ir_node *old_anchor_node = get_irn_n(env.old_anchor, anchor);
248         ir_node *transformed     = be_transform_node(old_anchor_node);
249         set_irg_anchor(current_ir_graph, anchor, transformed);
250 }
251
252 static void kill_unused_anchor(int anchor)
253 {
254         ir_node *old_anchor_node = get_irn_n(env.old_anchor, anchor);
255         ir_node *old_bad         = get_irn_n(env.old_anchor, anchor_bad);
256         if(old_anchor_node != NULL && get_irn_n_edges(old_anchor_node) <= 1) {
257                 set_irn_n(env.old_anchor, anchor, old_bad);
258         }
259 }
260
261 /**
262  * Transforms all nodes. Deletes the old obstack and creates a new one.
263  */
264 static void transform_nodes(ir_graph *irg, arch_pretrans_nodes *pre_transform,
265                             void *cg)
266 {
267         int       i;
268         ir_node  *old_end, *new_anchor;
269
270         hook_dead_node_elim(irg, 1);
271
272         inc_irg_visited(irg);
273
274         env.irg         = irg;
275         env.visited     = get_irg_visited(irg);
276         env.worklist    = new_waitq();
277         env.old_anchor  = irg->anchor;
278
279         old_end = get_irg_end(irg);
280
281         /* put all anchor nodes in the worklist */
282         for (i = get_irg_n_anchors(irg) - 1; i >= 0; --i) {
283                 ir_node *anchor = get_irg_anchor(irg, i);
284
285                 if (anchor == NULL)
286                         continue;
287                 waitq_put(env.worklist, anchor);
288         }
289
290         new_anchor  = new_Anchor(irg);
291         irg->anchor = new_anchor;
292
293         /* pre transform some anchors (so they are available in the other transform
294          * functions) */
295         pre_transform_anchor(anchor_bad);
296         pre_transform_anchor(anchor_no_mem);
297         pre_transform_anchor(anchor_start_block);
298         pre_transform_anchor(anchor_start);
299         pre_transform_anchor(anchor_frame);
300         kill_unused_anchor(anchor_tls);
301
302         if (pre_transform)
303                 (*pre_transform)(cg);
304
305         /* process worklist (this should transform all nodes in the graph) */
306         while (! waitq_empty(env.worklist)) {
307                 ir_node *node = waitq_get(env.worklist);
308                 be_transform_node(node);
309         }
310
311         /* fix loops and set new anchors*/
312         inc_irg_visited(irg);
313         for (i = get_irg_n_anchors(irg) - 1; i >= 0; --i) {
314                 ir_node *anchor = get_irn_n(env.old_anchor, i);
315
316                 if (anchor == NULL)
317                         continue;
318
319                 anchor = get_irn_link(anchor);
320                 fix_loops(anchor);
321                 set_irn_n(new_anchor, i, anchor);
322         }
323         set_irn_n(new_anchor, -1, get_irg_anchor(irg, anchor_end_block));
324
325         del_waitq(env.worklist);
326         free_End(old_end);
327         hook_dead_node_elim(irg, 0);
328 }
329
330 /**
331  * Transform helper for blocks.
332  */
333 static ir_node *gen_Block(ir_node *node) {
334         ir_graph *irg             = current_ir_graph;
335         dbg_info *dbgi            = get_irn_dbg_info(node);
336         ir_node  *old_start_block = get_irn_n(env.old_anchor, anchor_start_block);
337         ir_node  *macroblock      = get_Block_MacroBlock(node);
338         ir_node  *block;
339
340         /*
341          * We replace the ProjX from the start node with a jump,
342          * so the startblock has no preds anymore now
343          */
344         if (node == old_start_block) {
345                 return new_rd_Block(dbgi, irg, 0, NULL);
346         }
347
348         /* we use the old blocks for now, because jumps allow cycles in the graph
349          * we have to fix this later */
350         block = new_ir_node(dbgi, irg, NULL, get_irn_op(node), get_irn_mode(node),
351                             get_irn_arity(node), get_irn_in(node) + 1);
352         copy_node_attr(node, block);
353 #ifdef DEBUG_libfirm
354         block->node_nr = node->node_nr;
355 #endif
356         if (node == macroblock) {
357                 /* this node is a macroblock header */
358                 set_irn_n(block, -1, block);
359         } else {
360                 macroblock = be_transform_node(macroblock);
361                 set_irn_n(block, -1, macroblock);
362         }
363
364         be_set_transformed_node(node, block);
365
366         /* put the preds in the worklist */
367         be_enqueue_preds(node);
368
369         return block;
370 }
371
372 static ir_node *gen_End(ir_node *node) {
373         /* end has to be duplicated manually because we need a dynamic in array */
374         ir_graph *irg   = current_ir_graph;
375         dbg_info *dbgi  = get_irn_dbg_info(node);
376         ir_node  *block = be_transform_node(get_nodes_block(node));
377         int      i, arity;
378         ir_node  *new_end;
379
380         new_end = new_ir_node(dbgi, irg, block, op_End, mode_X, -1, NULL);
381         copy_node_attr(node, new_end);
382         be_duplicate_deps(node, new_end);
383
384         set_irg_end(irg, new_end);
385         be_set_transformed_node(new_end, new_end);
386
387         /* transform preds */
388         arity = get_irn_arity(node);
389         for (i = 0; i < arity; ++i) {
390                 ir_node *in     = get_irn_n(node, i);
391                 ir_node *new_in = be_transform_node(in);
392
393                 add_End_keepalive(new_end, new_in);
394         }
395
396         return new_end;
397 }
398
399 void be_transform_graph(be_irg_t *birg, arch_pretrans_nodes *func, void *cg)
400 {
401         ir_graph *irg = birg->irg;
402         ir_graph *old_current_ir_graph = current_ir_graph;
403         struct obstack *old_obst = NULL;
404         struct obstack *new_obst = NULL;
405
406         current_ir_graph = irg;
407
408         /* create a new obstack */
409         old_obst = irg->obst;
410         new_obst = xmalloc(sizeof(*new_obst));
411         obstack_init(new_obst);
412         irg->obst = new_obst;
413         irg->last_node_idx = 0;
414
415         /* create new value table for CSE */
416         del_identities(irg->value_table);
417         irg->value_table = new_identities();
418
419         /* enter special helper */
420         op_Block->ops.generic = (op_func)gen_Block;
421         op_End->ops.generic   = (op_func)gen_End;
422
423         /* do the main transformation */
424         transform_nodes(irg, func, cg);
425
426         /* we don't want the globals anchor anymore */
427         set_irg_globals(irg, new_r_Bad(irg));
428
429         /* free the old obstack */
430         obstack_free(old_obst, 0);
431         xfree(old_obst);
432
433         /* restore state */
434         current_ir_graph = old_current_ir_graph;
435
436         /* most analysis info is wrong after transformation */
437         free_callee_info(irg);
438         free_irg_outs(irg);
439         free_trouts();
440         free_loop_information(irg);
441         set_irg_doms_inconsistent(irg);
442
443         be_liveness_invalidate(be_get_birg_liveness(birg));
444         /* Hack for now, something is buggy with invalidate liveness... */
445         birg->lv = NULL;
446         be_invalidate_dom_front(birg);
447
448         /* recalculate edges */
449         edges_deactivate(irg);
450         edges_activate(irg);
451
452         if (birg->lv) {
453                 be_liveness_free(birg->lv);
454                 birg->lv = be_liveness(birg);
455         }
456 }