remove unused dead_node_elim_subst hook
[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  */
26 #include "config.h"
27
28 #include "pdeq.h"
29 #include "irop_t.h"
30 #include "iropt_t.h"
31 #include "irnode_t.h"
32 #include "irgraph_t.h"
33 #include "ircons_t.h"
34 #include "irhooks.h"
35 #include "iredges.h"
36 #include "irouts.h"
37 #include "trouts.h"
38 #include "cgana.h"
39 #include "debug.h"
40 #include "execfreq_t.h"
41
42 #include "beirg.h"
43 #include "beabi.h"
44 #include "betranshlp.h"
45 #include "belive.h"
46 #include "benode.h"
47
48 typedef struct be_transform_env_t {
49         ir_graph *irg;         /**< The irg, the node should be created in */
50         waitq    *worklist;    /**< worklist of nodes that still need to be
51                                     transformed */
52         ir_node  *old_anchor;  /**< the old anchor node in the old irg */
53 } be_transform_env_t;
54
55
56 static be_transform_env_t env;
57
58 void be_set_transformed_node(ir_node *old_node, ir_node *new_node)
59 {
60         set_irn_link(old_node, new_node);
61         mark_irn_visited(old_node);
62 }
63
64 int be_is_transformed(const ir_node *node)
65 {
66         return irn_visited(node);
67 }
68
69 static inline ir_node *be_get_transformed_node(ir_node *old_node)
70 {
71         if (irn_visited(old_node)) {
72                 ir_node *new_node = (ir_node*)get_irn_link(old_node);
73                 assert(new_node != NULL);
74                 return new_node;
75         }
76         return NULL;
77 }
78
79 void be_duplicate_deps(ir_node *old_node, ir_node *new_node)
80 {
81         int deps = get_irn_deps(old_node);
82         for (int 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_set_transform_function(ir_op *op, be_transform_func func)
91 {
92         /* shouldn't be assigned twice (except for exchanging the default
93          * be_duplicate_node entries) */
94         assert(op->ops.generic == NULL
95                         || op->ops.generic == (op_func) be_duplicate_node);
96         op->ops.generic = (op_func) func;
97 }
98
99 /**
100  * Transform helper for blocks.
101  */
102 static ir_node *transform_block(ir_node *node)
103 {
104         ir_graph *irg   = get_irn_irg(node);
105         dbg_info *dbgi  = get_irn_dbg_info(node);
106         ir_mode  *mode  = get_irn_mode(node);
107         ir_node  *block = new_ir_node(dbgi, irg, NULL, get_irn_op(node), mode,
108                                       get_irn_arity(node), get_irn_in(node) + 1);
109         copy_node_attr(irg, node, block);
110         block->node_nr = node->node_nr;
111
112         /* transfer execfreq value */
113         double execfreq = get_block_execfreq(node);
114         set_block_execfreq(block, execfreq);
115
116         /* put the preds in the worklist */
117         be_enqueue_preds(node);
118
119         return block;
120 }
121
122 static ir_node *transform_end(ir_node *node)
123 {
124         /* end has to be duplicated manually because we need a dynamic in array */
125         ir_graph *irg     = get_irn_irg(node);
126         dbg_info *dbgi    = get_irn_dbg_info(node);
127         ir_node  *block   = be_transform_node(get_nodes_block(node));
128         ir_node  *new_end = new_ir_node(dbgi, irg, block, op_End, mode_X, -1, NULL);
129         copy_node_attr(irg, node, new_end);
130         be_duplicate_deps(node, new_end);
131
132         set_irg_end(irg, new_end);
133
134         /* do not transform predecessors yet to keep the pre-transform
135          * phase from visiting all the graph */
136         int arity = get_irn_arity(node);
137         for (int i = 0; i < arity; ++i) {
138                 ir_node *in = get_irn_n(node, i);
139                 add_End_keepalive(new_end, in);
140         }
141         be_enqueue_preds(node);
142
143         return new_end;
144 }
145
146 void be_start_transform_setup(void)
147 {
148         ir_clear_opcodes_generic_func();
149
150         be_set_transform_function(op_Bad,         be_duplicate_node);
151         be_set_transform_function(op_be_Copy,     be_duplicate_node);
152         be_set_transform_function(op_be_CopyKeep, be_duplicate_node);
153         be_set_transform_function(op_be_IncSP,    be_duplicate_node);
154         be_set_transform_function(op_be_Keep,     be_duplicate_node);
155         be_set_transform_function(op_be_Return,   be_duplicate_node);
156         be_set_transform_function(op_be_Start,    be_duplicate_node);
157         be_set_transform_function(op_Block,       transform_block);
158         be_set_transform_function(op_End,         transform_end);
159         be_set_transform_function(op_NoMem,       be_duplicate_node);
160         be_set_transform_function(op_Pin,         be_duplicate_node);
161         be_set_transform_function(op_Start,       be_duplicate_node);
162         be_set_transform_function(op_Sync,        be_duplicate_node);
163 }
164
165 ir_node *be_duplicate_node(ir_node *node)
166 {
167         ir_node  *block = be_transform_node(get_nodes_block(node));
168         ir_graph *irg   = env.irg;
169         dbg_info *dbgi  = get_irn_dbg_info(node);
170         ir_mode  *mode  = get_irn_mode(node);
171         ir_op    *op    = get_irn_op(node);
172
173         ir_node *new_node;
174         int      arity = get_irn_arity(node);
175         if (op->opar == oparity_dynamic) {
176                 new_node = new_ir_node(dbgi, irg, block, op, mode, -1, NULL);
177                 for (int i = 0; i < arity; ++i) {
178                         ir_node *in = get_irn_n(node, i);
179                         in = be_transform_node(in);
180                         add_irn_n(new_node, in);
181                 }
182         } else {
183                 ir_node **ins = ALLOCAN(ir_node*, arity);
184                 for (int i = 0; i < arity; ++i) {
185                         ir_node *in = get_irn_n(node, i);
186                         ins[i] = be_transform_node(in);
187                 }
188
189                 new_node = new_ir_node(dbgi, irg, block, op, mode, arity, ins);
190         }
191
192         copy_node_attr(irg, node, new_node);
193         be_duplicate_deps(node, new_node);
194
195         new_node->node_nr = node->node_nr;
196         return new_node;
197 }
198
199 ir_node *be_transform_node(ir_node *node)
200 {
201         ir_node *new_node = be_get_transformed_node(node);
202         if (new_node != NULL)
203                 return new_node;
204
205         DEBUG_ONLY(be_set_transformed_node(node, NULL);)
206
207         ir_op *op = get_irn_op(node);
208         if (op->ops.generic == NULL) {
209                 panic("No transform function registered for node %+F.", node);
210         }
211         be_transform_func *transform = (be_transform_func *)op->ops.generic;
212
213         new_node = transform(node);
214         assert(new_node != NULL);
215
216         be_set_transformed_node(node, new_node);
217         return new_node;
218 }
219
220 void be_enqueue_preds(ir_node *node)
221 {
222         /* put the preds in the worklist */
223         int arity = get_irn_arity(node);
224         for (int i = 0; i < arity; ++i) {
225                 ir_node *pred = get_irn_n(node, i);
226                 pdeq_putr(env.worklist, pred);
227         }
228 }
229
230 /**
231  * Rewire nodes which are potential loops (like Phis) to avoid endless loops.
232  */
233 static void fix_loops(ir_node *node)
234 {
235         assert(node_is_in_irgs_storage(env.irg, node));
236
237         if (irn_visited_else_mark(node))
238                 return;
239
240         bool changed = false;
241         if (! is_Block(node)) {
242                 ir_node *block     = get_nodes_block(node);
243                 ir_node *new_block = (ir_node*)get_irn_link(block);
244
245                 if (new_block != NULL) {
246                         set_nodes_block(node, new_block);
247                         block = new_block;
248                         changed = true;
249                 }
250
251                 fix_loops(block);
252         }
253
254         int arity = get_irn_arity(node);
255         for (int i = 0; i < arity; ++i) {
256                 ir_node *in = get_irn_n(node, i);
257                 ir_node *nw = (ir_node*)get_irn_link(in);
258
259                 if (nw != NULL && nw != in) {
260                         set_irn_n(node, i, nw);
261                         in = nw;
262                         changed = true;
263                 }
264
265                 fix_loops(in);
266         }
267         /* fix proj block */
268         if (is_Proj(node)) {
269                 set_nodes_block(node, get_nodes_block(get_Proj_pred(node)));
270                 changed = true;
271         }
272
273         arity = get_irn_deps(node);
274         for (int i = 0; i < arity; ++i) {
275                 ir_node *in = get_irn_dep(node, i);
276                 ir_node *nw = (ir_node*)get_irn_link(in);
277
278                 if (nw != NULL && nw != in) {
279                         set_irn_dep(node, i, nw);
280                         in = nw;
281                         changed = true;
282                 }
283
284                 fix_loops(in);
285         }
286
287         if (changed) {
288                 identify_remember(node);
289         }
290 }
291
292 ir_node *be_pre_transform_node(ir_node *place)
293 {
294         if (place == NULL)
295                 return NULL;
296
297         return be_transform_node(place);
298 }
299
300 static void pre_transform_anchor(ir_graph *irg, int anchor)
301 {
302         ir_node *old_anchor_node = get_irn_n(env.old_anchor, anchor);
303         ir_node *transformed     = be_transform_node(old_anchor_node);
304         set_irg_anchor(irg, anchor, transformed);
305 }
306
307 /**
308  * Transforms all nodes. Deletes the old obstack and creates a new one.
309  */
310 static void transform_nodes(ir_graph *irg, arch_pretrans_nodes *pre_transform)
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         ir_node *old_end = get_irg_end(irg);
321
322         /* put all anchor nodes in the worklist */
323         for (int 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         ir_node *new_anchor  = new_r_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(irg, anchor_no_mem);
337         pre_transform_anchor(irg, anchor_end_block);
338         pre_transform_anchor(irg, anchor_end);
339         pre_transform_anchor(irg, anchor_start_block);
340         pre_transform_anchor(irg, anchor_start);
341         pre_transform_anchor(irg, anchor_frame);
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 = (ir_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 (int 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 = (ir_node*)get_irn_link(anchor);
361                 fix_loops(anchor);
362                 set_irn_n(new_anchor, i, anchor);
363         }
364
365         del_waitq(env.worklist);
366         free_End(old_end);
367         hook_dead_node_elim(irg, 0);
368 }
369
370 void be_transform_graph(ir_graph *irg, arch_pretrans_nodes *func)
371 {
372         ir_graph *old_current_ir_graph = current_ir_graph;
373         current_ir_graph = irg;
374
375         /* create a new obstack */
376         struct obstack *old_obst = irg->obst;
377         struct obstack *new_obst = XMALLOC(struct obstack);
378         obstack_init(new_obst);
379         irg->obst = new_obst;
380         irg->last_node_idx = 0;
381
382         free_vrp_data(irg);
383
384         /* create new value table for CSE */
385         new_identities(irg);
386
387         /* do the main transformation */
388         transform_nodes(irg, func);
389
390         /* free the old obstack */
391         obstack_free(old_obst, 0);
392         xfree(old_obst);
393
394         /* restore state */
395         current_ir_graph = old_current_ir_graph;
396
397         /* most analysis info is wrong after transformation */
398         be_invalidate_live_chk(irg);
399         confirm_irg_properties(irg, IR_GRAPH_PROPERTIES_NONE);
400
401         /* recalculate edges */
402         edges_activate(irg);
403 }