6a81fa16f372397d4b6f2eae92b82dd0df3c1cbc
[libfirm] / ir / be / betranshlp.c
1 /*
2  * Copyright (C) 1995-2007 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.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_anchors;/**< the list of anchors nodes 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 static INLINE ir_node *be_get_transformed_node(ir_node *old_node) {
64         assert(irn_visited(old_node));
65         return (ir_node*) get_irn_link(old_node);
66 }
67
68 ir_node *be_get_old_anchor(unsigned anchor) {
69         return env.old_anchors[anchor];
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
173         if (irn_visited(node))
174                 return;
175
176         mark_irn_visited(node);
177
178         assert(node_is_in_irgs_storage(env.irg, node));
179
180         if (! is_Block(node)) {
181                 ir_node *block     = get_nodes_block(node);
182                 ir_node *new_block = get_irn_link(block);
183
184                 if (new_block != NULL) {
185                         set_nodes_block(node, new_block);
186                         block = new_block;
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                 }
201
202                 fix_loops(in);
203         }
204
205         arity = get_irn_deps(node);
206         for (i = 0; i < arity; ++i) {
207                 ir_node *in = get_irn_dep(node, i);
208                 ir_node *nw = get_irn_link(in);
209
210                 if (nw != NULL && nw != in) {
211                         set_irn_dep(node, i, nw);
212                         in = nw;
213                 }
214
215                 fix_loops(in);
216         }
217 }
218
219 ir_node *be_pre_transform_node(ir_node *place) {
220         if (place == NULL)
221                 return NULL;
222
223         return be_transform_node(place);
224 }
225
226 /**
227  * Transforms all nodes. Deletes the old obstack and creates a new one.
228  */
229 static void transform_nodes(ir_graph *irg, arch_pretrans_nodes *pre_transform, void *cg) {
230         int      i;
231         ir_node  *old_end;
232
233         hook_dead_node_elim(irg, 1);
234
235         inc_irg_visited(irg);
236
237         env.irg         = irg;
238         env.visited     = get_irg_visited(irg);
239         env.worklist    = new_waitq();
240         env.old_anchors = alloca(anchor_max * sizeof(env.old_anchors[0]));
241
242         old_end = get_irg_end(irg);
243
244         /* put all anchor nodes in the worklist */
245         for (i = 0; i < anchor_max; ++i) {
246                 ir_node *anchor = irg->anchors[i];
247
248                 if (anchor == NULL)
249                         continue;
250                 waitq_put(env.worklist, anchor);
251
252                 /* remember anchor */
253                 env.old_anchors[i] = anchor;
254                 /* and set it to NULL to make sure we don't accidently use it */
255                 irg->anchors[i] = NULL;
256         }
257
258         /* pre transform some anchors (so they are available in the other transform
259          * functions) */
260         set_irg_bad(irg, be_transform_node(env.old_anchors[anchor_bad]));
261         set_irg_no_mem(irg, be_transform_node(env.old_anchors[anchor_no_mem]));
262         set_irg_start_block(irg, be_transform_node(env.old_anchors[anchor_start_block]));
263         set_irg_start(irg, be_transform_node(env.old_anchors[anchor_start]));
264         set_irg_frame(irg, be_transform_node(env.old_anchors[anchor_frame]));
265
266         if (pre_transform)
267                 (*pre_transform)(cg);
268
269         /* process worklist (this should transform all nodes in the graph) */
270         while (! waitq_empty(env.worklist)) {
271                 ir_node *node = waitq_get(env.worklist);
272                 be_transform_node(node);
273         }
274
275         /* fix loops and set new anchors*/
276         inc_irg_visited(irg);
277         for (i = 0; i < anchor_max; ++i) {
278                 ir_node *anchor = env.old_anchors[i];
279
280                 if (anchor == NULL)
281                         continue;
282
283                 anchor = get_irn_link(anchor);
284                 fix_loops(anchor);
285                 assert(irg->anchors[i] == NULL || irg->anchors[i] == anchor);
286                 irg->anchors[i] = anchor;
287         }
288
289         del_waitq(env.worklist);
290         free_End(old_end);
291         hook_dead_node_elim(irg, 0);
292 }
293
294 /**
295  * Transform helper for blocks.
296  */
297 static ir_node *gen_Block(ir_node *node) {
298         ir_graph *irg         = current_ir_graph;
299         dbg_info *dbgi        = get_irn_dbg_info(node);
300         ir_node  *start_block = be_get_old_anchor(anchor_start_block);
301         ir_node  *block;
302
303         /*
304          * We replace the ProjX from the start node with a jump,
305          * so the startblock has no preds anymore now
306          */
307         if (node == start_block) {
308                 return new_rd_Block(dbgi, irg, 0, NULL);
309         }
310
311         /* we use the old blocks for now, because jumps allow cycles in the graph
312          * we have to fix this later */
313         block = new_ir_node(dbgi, irg, NULL, get_irn_op(node), get_irn_mode(node),
314                             get_irn_arity(node), get_irn_in(node) + 1);
315         copy_node_attr(node, block);
316
317 #ifdef DEBUG_libfirm
318         block->node_nr = node->node_nr;
319 #endif
320         be_set_transformed_node(node, block);
321
322         /* put the preds in the worklist */
323         be_enqueue_preds(node);
324
325         return block;
326 }
327
328 static ir_node *gen_End(ir_node *node) {
329         /* end has to be duplicated manually because we need a dynamic in array */
330         ir_graph *irg   = current_ir_graph;
331         dbg_info *dbgi  = get_irn_dbg_info(node);
332         ir_node  *block = be_transform_node(get_nodes_block(node));
333         int      i, arity;
334         ir_node  *new_end;
335
336         new_end = new_ir_node(dbgi, irg, block, op_End, mode_X, -1, NULL);
337         copy_node_attr(node, new_end);
338         be_duplicate_deps(node, new_end);
339
340         set_irg_end(irg, new_end);
341         be_set_transformed_node(new_end, new_end);
342
343         /* transform preds */
344         arity = get_irn_arity(node);
345         for (i = 0; i < arity; ++i) {
346                 ir_node *in     = get_irn_n(node, i);
347                 ir_node *new_in = be_transform_node(in);
348
349                 add_End_keepalive(new_end, new_in);
350         }
351
352         return new_end;
353 }
354
355 void be_transform_graph(be_irg_t *birg, arch_pretrans_nodes *func, void *cg)
356 {
357         ir_graph *irg = birg->irg;
358         ir_graph *old_current_ir_graph = current_ir_graph;
359         int old_interprocedural_view = get_interprocedural_view();
360         struct obstack *old_obst = NULL;
361         struct obstack *new_obst = NULL;
362
363         current_ir_graph = irg;
364         set_interprocedural_view(0);
365
366         /* most analysis info is wrong after transformation */
367         free_callee_info(irg);
368         free_irg_outs(irg);
369         free_trouts();
370         free_loop_information(irg);
371         set_irg_doms_inconsistent(irg);
372
373         be_liveness_invalidate(be_get_birg_liveness(birg));
374         be_invalidate_dom_front(birg);
375
376         /* create a new obstack */
377         old_obst = irg->obst;
378         new_obst = xmalloc(sizeof(*new_obst));
379         obstack_init(new_obst);
380         irg->obst = new_obst;
381         irg->last_node_idx = 0;
382
383         /* create new value table for CSE */
384         del_identities(irg->value_table);
385         irg->value_table = new_identities();
386
387         /* enter special helper */
388         op_Block->ops.generic = (op_func)gen_Block;
389         op_End->ops.generic   = (op_func)gen_End;
390
391         /* do the main transformation */
392         transform_nodes(irg, func, cg);
393
394         /* we don't want the globals anchor anymore */
395         set_irg_globals(irg, new_r_Bad(irg));
396
397         /* free the old obstack */
398         obstack_free(old_obst, 0);
399         xfree(old_obst);
400
401         /* restore state */
402         current_ir_graph = old_current_ir_graph;
403         set_interprocedural_view(old_interprocedural_view);
404
405         /* recalculate edges */
406         edges_deactivate(irg);
407         edges_activate(irg);
408 }