f5a6d65ee83cfbb89934c21ea6b56dbaa48dd6a5
[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(irg, 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 ir_node *be_transform_node(ir_node *node)
134 {
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 void be_enqueue_preds(ir_node *node)
159 {
160         int i, arity;
161
162         /* put the preds in the worklist */
163         arity = get_irn_arity(node);
164         for (i = 0; i < arity; ++i) {
165                 ir_node *pred = get_irn_n(node, i);
166                 pdeq_putr(env.worklist, pred);
167         }
168 }
169
170 /**
171  * Rewire nodes which are potential loops (like Phis) to avoid endless loops.
172  */
173 static void fix_loops(ir_node *node)
174 {
175         int i, arity;
176         int changed;
177
178         assert(node_is_in_irgs_storage(env.irg, node));
179
180         if (irn_visited_else_mark(node))
181                 return;
182
183         changed = 0;
184         if (! is_Block(node)) {
185                 ir_node *block     = get_nodes_block(node);
186                 ir_node *new_block = get_irn_link(block);
187
188                 if (new_block != NULL) {
189                         set_nodes_block(node, new_block);
190                         block = new_block;
191                         changed = 1;
192                 }
193
194                 fix_loops(block);
195         }
196
197         arity = get_irn_arity(node);
198         for (i = 0; i < arity; ++i) {
199                 ir_node *in = get_irn_n(node, i);
200                 ir_node *nw = get_irn_link(in);
201
202                 if (nw != NULL && nw != in) {
203                         set_irn_n(node, i, nw);
204                         in = nw;
205                         changed = 1;
206                 }
207
208                 fix_loops(in);
209         }
210         /* fix proj block */
211         if (is_Proj(node)) {
212                 set_nodes_block(node, get_nodes_block(get_Proj_pred(node)));
213                 changed = 1;
214         }
215
216         arity = get_irn_deps(node);
217         for (i = 0; i < arity; ++i) {
218                 ir_node *in = get_irn_dep(node, i);
219                 ir_node *nw = get_irn_link(in);
220
221                 if (nw != NULL && nw != in) {
222                         set_irn_dep(node, i, nw);
223                         in = nw;
224                         changed = 1;
225                 }
226
227                 fix_loops(in);
228         }
229
230         if (changed) {
231                 identify_remember(current_ir_graph->value_table, node);
232         }
233 }
234
235 ir_node *be_pre_transform_node(ir_node *place)
236 {
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 static ir_node *new_be_Anchor(ir_graph *irg)
260 {
261         struct obstack *obst = be_get_birg_obst(irg);
262         backend_info_t *info;
263         ir_node        *new_anchor;
264
265         /* Hack: some places in the code ask the Anchor for its register
266            requirements */
267         new_anchor = new_Anchor(irg);
268         info = be_get_info(new_anchor);
269         info->out_infos = NEW_ARR_D(reg_out_info_t, obst, 1);
270         memset(info->out_infos, 0, 1 * sizeof(info->out_infos[0]));
271         info->out_infos[0].req = arch_no_register_req;
272
273         return new_anchor;
274 }
275
276 /**
277  * Transforms all nodes. Deletes the old obstack and creates a new one.
278  */
279 static void transform_nodes(ir_graph *irg, arch_pretrans_nodes *pre_transform)
280 {
281         int       i;
282         ir_node  *old_end, *new_anchor;
283
284         hook_dead_node_elim(irg, 1);
285
286         inc_irg_visited(irg);
287
288         env.irg         = irg;
289         env.worklist    = new_waitq();
290         env.old_anchor  = irg->anchor;
291
292         old_end = get_irg_end(irg);
293
294         /* put all anchor nodes in the worklist */
295         for (i = get_irg_n_anchors(irg) - 1; i >= 0; --i) {
296                 ir_node *anchor = get_irg_anchor(irg, i);
297
298                 if (anchor == NULL)
299                         continue;
300                 waitq_put(env.worklist, anchor);
301         }
302
303         new_anchor  = new_be_Anchor(irg);
304         irg->anchor = new_anchor;
305
306         /* pre transform some anchors (so they are available in the other transform
307          * functions) */
308         pre_transform_anchor(anchor_bad);
309         pre_transform_anchor(anchor_no_mem);
310         pre_transform_anchor(anchor_start_block);
311         pre_transform_anchor(anchor_start);
312         pre_transform_anchor(anchor_frame);
313         kill_unused_anchor(anchor_tls);
314
315         if (pre_transform)
316                 pre_transform();
317
318         /* process worklist (this should transform all nodes in the graph) */
319         while (! waitq_empty(env.worklist)) {
320                 ir_node *node = waitq_get(env.worklist);
321                 be_transform_node(node);
322         }
323
324         /* fix loops and set new anchors*/
325         inc_irg_visited(irg);
326         for (i = get_irg_n_anchors(irg) - 1; i >= 0; --i) {
327                 ir_node *anchor = get_irn_n(env.old_anchor, i);
328
329                 if (anchor == NULL)
330                         continue;
331
332                 anchor = get_irn_link(anchor);
333                 fix_loops(anchor);
334                 set_irn_n(new_anchor, i, anchor);
335         }
336         set_nodes_block(new_anchor, get_irg_anchor(irg, anchor_end_block));
337
338         del_waitq(env.worklist);
339         free_End(old_end);
340         hook_dead_node_elim(irg, 0);
341 }
342
343 /**
344  * Transform helper for blocks.
345  */
346 static ir_node *gen_Block(ir_node *node)
347 {
348         ir_graph *irg             = current_ir_graph;
349         dbg_info *dbgi            = get_irn_dbg_info(node);
350         ir_node  *macroblock      = get_Block_MacroBlock(node);
351         ir_node  *block;
352
353         block = new_ir_node(dbgi, irg, NULL, get_irn_op(node), get_irn_mode(node),
354                             get_irn_arity(node), get_irn_in(node) + 1);
355         copy_node_attr(irg, node, block);
356         block->node_nr = node->node_nr;
357
358         if (node == macroblock) {
359                 /* this node is a macroblock header */
360                 set_Block_MacroBlock(block, block);
361         } else {
362                 macroblock = be_transform_node(macroblock);
363                 set_Block_MacroBlock(block, macroblock);
364         }
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 {
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(irg, node, new_end);
383         be_duplicate_deps(node, new_end);
384
385         set_irg_end(irg, 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)
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(struct obstack);
411         obstack_init(new_obst);
412         irg->obst = new_obst;
413         irg->last_node_idx = 0;
414
415         /* invalidate phase info as (at least vrp info) is used inside the
416          * equivalent/compute_value functions and might replace our newly
417          * created nodes with middleend nodes */
418         irg_invalidate_phases(irg);
419
420         /* create new value table for CSE */
421         del_identities(irg->value_table);
422         irg->value_table = new_identities();
423
424         /* enter special helper */
425         op_Block->ops.generic = (op_func)gen_Block;
426         op_End->ops.generic   = (op_func)gen_End;
427
428         /* do the main transformation */
429         transform_nodes(irg, func);
430
431         /* free the old obstack */
432         obstack_free(old_obst, 0);
433         xfree(old_obst);
434
435         /* restore state */
436         current_ir_graph = old_current_ir_graph;
437
438         /* most analysis info is wrong after transformation */
439         free_callee_info(irg);
440         free_irg_outs(irg);
441         free_trouts();
442         free_loop_information(irg);
443         set_irg_doms_inconsistent(irg);
444
445         be_liveness_invalidate(be_get_birg_liveness(birg));
446         /* Hack for now, something is buggy with invalidate liveness... */
447         birg->lv = NULL;
448         be_invalidate_dom_front(birg);
449
450         /* recalculate edges */
451         edges_deactivate(irg);
452         edges_activate(irg);
453
454         if (birg->lv) {
455                 be_liveness_free(birg->lv);
456                 birg->lv = be_liveness(irg);
457         }
458 }