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