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