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