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