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