betranshlp: cleanup, pretransform end node so keep_alive works in transformers
[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 "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 i;
82         int deps = get_irn_deps(old_node);
83
84         for (i = 0; i < deps; ++i) {
85                 ir_node *dep     = get_irn_dep(old_node, i);
86                 ir_node *new_dep = be_transform_node(dep);
87
88                 add_irn_dep(new_node, new_dep);
89         }
90 }
91
92 void be_set_transform_function(ir_op *op, be_transform_func func)
93 {
94         /* shouldn't be assigned twice (except for exchanging the default
95          * be_duplicate_node entries) */
96         assert(op->ops.generic == NULL
97                         || op->ops.generic == (op_func) be_duplicate_node);
98         op->ops.generic = (op_func) func;
99 }
100
101 /**
102  * Transform helper for blocks.
103  */
104 static ir_node *transform_block(ir_node *node)
105 {
106         ir_graph *irg             = current_ir_graph;
107         dbg_info *dbgi            = get_irn_dbg_info(node);
108         ir_node  *block;
109
110         block = new_ir_node(dbgi, irg, NULL, get_irn_op(node), get_irn_mode(node),
111                             get_irn_arity(node), get_irn_in(node) + 1);
112         copy_node_attr(irg, node, block);
113         block->node_nr = node->node_nr;
114
115         /* put the preds in the worklist */
116         be_enqueue_preds(node);
117
118         return block;
119 }
120
121 static ir_node *transform_end(ir_node *node)
122 {
123         /* end has to be duplicated manually because we need a dynamic in array */
124         ir_graph *irg   = current_ir_graph;
125         dbg_info *dbgi  = get_irn_dbg_info(node);
126         ir_node  *block = be_transform_node(get_nodes_block(node));
127         int      i, arity;
128         ir_node  *new_end;
129
130         new_end = new_ir_node(dbgi, irg, block, op_End, mode_X, -1, NULL);
131         copy_node_attr(irg, node, new_end);
132         be_duplicate_deps(node, new_end);
133
134         set_irg_end(irg, new_end);
135
136         /* do not transform predecessors yet to keep the pre-transform
137          * phase from visiting all the graph */
138         arity = get_irn_arity(node);
139         for (i = 0; i < arity; ++i) {
140                 ir_node *in = get_irn_n(node, i);
141                 add_End_keepalive(new_end, in);
142         }
143         be_enqueue_preds(node);
144
145         return new_end;
146 }
147
148 void be_start_transform_setup(void)
149 {
150         clear_irp_opcodes_generic_func();
151
152         be_set_transform_function(op_Bad,         be_duplicate_node);
153         be_set_transform_function(op_be_Copy,     be_duplicate_node);
154         be_set_transform_function(op_be_CopyKeep, be_duplicate_node);
155         be_set_transform_function(op_be_IncSP,    be_duplicate_node);
156         be_set_transform_function(op_be_Keep,     be_duplicate_node);
157         be_set_transform_function(op_be_Return,   be_duplicate_node);
158         be_set_transform_function(op_be_Start,    be_duplicate_node);
159         be_set_transform_function(op_Block,       transform_block);
160         be_set_transform_function(op_End,         transform_end);
161         be_set_transform_function(op_NoMem,       be_duplicate_node);
162         be_set_transform_function(op_Pin,         be_duplicate_node);
163         be_set_transform_function(op_Start,       be_duplicate_node);
164         be_set_transform_function(op_Sync,        be_duplicate_node);
165 }
166
167 ir_node *be_duplicate_node(ir_node *node)
168 {
169         ir_node  *block = be_transform_node(get_nodes_block(node));
170         ir_graph *irg   = env.irg;
171         dbg_info *dbgi  = get_irn_dbg_info(node);
172         ir_mode  *mode  = get_irn_mode(node);
173         ir_op    *op    = get_irn_op(node);
174         ir_node  *new_node;
175         int      i, arity;
176
177         arity = get_irn_arity(node);
178         if (op->opar == oparity_dynamic) {
179                 new_node = new_ir_node(dbgi, irg, block, op, mode, -1, NULL);
180                 for (i = 0; i < arity; ++i) {
181                         ir_node *in = get_irn_n(node, i);
182                         in = be_transform_node(in);
183                         add_irn_n(new_node, in);
184                 }
185         } else {
186                 ir_node **ins = ALLOCAN(ir_node*, arity);
187                 for (i = 0; i < arity; ++i) {
188                         ir_node *in = get_irn_n(node, i);
189                         ins[i] = be_transform_node(in);
190                 }
191
192                 new_node = new_ir_node(dbgi, irg, block, op, mode, arity, ins);
193         }
194
195         copy_node_attr(irg, node, new_node);
196         be_duplicate_deps(node, new_node);
197
198         new_node->node_nr = node->node_nr;
199         return new_node;
200 }
201
202 ir_node *be_transform_node(ir_node *node)
203 {
204         ir_op             *op;
205         ir_node           *new_node = be_get_transformed_node(node);
206         be_transform_func *transform;
207
208         if (new_node != NULL)
209                 return new_node;
210
211         DEBUG_ONLY(be_set_transformed_node(node, NULL));
212
213         op = get_irn_op(node);
214         if (op->ops.generic == NULL) {
215                 panic("No transform function registered for node %+F.", node);
216         }
217         transform = (be_transform_func *)op->ops.generic;
218
219         new_node = transform(node);
220         assert(new_node != NULL);
221
222         be_set_transformed_node(node, new_node);
223         hook_dead_node_elim_subst(current_ir_graph, node, new_node);
224         return new_node;
225 }
226
227 void be_enqueue_preds(ir_node *node)
228 {
229         int i, arity;
230
231         /* put the preds in the worklist */
232         arity = get_irn_arity(node);
233         for (i = 0; i < arity; ++i) {
234                 ir_node *pred = get_irn_n(node, i);
235                 pdeq_putr(env.worklist, pred);
236         }
237 }
238
239 /**
240  * Rewire nodes which are potential loops (like Phis) to avoid endless loops.
241  */
242 static void fix_loops(ir_node *node)
243 {
244         int i, arity;
245         int changed;
246
247         assert(node_is_in_irgs_storage(env.irg, node));
248
249         if (irn_visited_else_mark(node))
250                 return;
251
252         changed = 0;
253         if (! is_Block(node)) {
254                 ir_node *block     = get_nodes_block(node);
255                 ir_node *new_block = (ir_node*)get_irn_link(block);
256
257                 if (new_block != NULL) {
258                         set_nodes_block(node, new_block);
259                         block = new_block;
260                         changed = 1;
261                 }
262
263                 fix_loops(block);
264         }
265
266         arity = get_irn_arity(node);
267         for (i = 0; i < arity; ++i) {
268                 ir_node *in = get_irn_n(node, i);
269                 ir_node *nw = (ir_node*)get_irn_link(in);
270
271                 if (nw != NULL && nw != in) {
272                         set_irn_n(node, i, nw);
273                         in = nw;
274                         changed = 1;
275                 }
276
277                 fix_loops(in);
278         }
279         /* fix proj block */
280         if (is_Proj(node)) {
281                 set_nodes_block(node, get_nodes_block(get_Proj_pred(node)));
282                 changed = 1;
283         }
284
285         arity = get_irn_deps(node);
286         for (i = 0; i < arity; ++i) {
287                 ir_node *in = get_irn_dep(node, i);
288                 ir_node *nw = (ir_node*)get_irn_link(in);
289
290                 if (nw != NULL && nw != in) {
291                         set_irn_dep(node, i, nw);
292                         in = nw;
293                         changed = 1;
294                 }
295
296                 fix_loops(in);
297         }
298
299         if (changed) {
300                 identify_remember(node);
301         }
302 }
303
304 ir_node *be_pre_transform_node(ir_node *place)
305 {
306         if (place == NULL)
307                 return NULL;
308
309         return be_transform_node(place);
310 }
311
312 static void pre_transform_anchor(int anchor)
313 {
314         ir_node *old_anchor_node = get_irn_n(env.old_anchor, anchor);
315         ir_node *transformed     = be_transform_node(old_anchor_node);
316         set_irg_anchor(current_ir_graph, anchor, transformed);
317 }
318
319 static void kill_unused_anchor(int anchor)
320 {
321         ir_node *old_anchor_node = get_irn_n(env.old_anchor, anchor);
322         ir_node *old_bad         = get_irn_n(env.old_anchor, anchor_bad);
323         if (old_anchor_node != NULL && get_irn_n_edges(old_anchor_node) <= 1) {
324                 set_irn_n(env.old_anchor, anchor, old_bad);
325         }
326 }
327
328 /**
329  * Transforms all nodes. Deletes the old obstack and creates a new one.
330  */
331 static void transform_nodes(ir_graph *irg, arch_pretrans_nodes *pre_transform)
332 {
333         int       i;
334         ir_node  *old_end, *new_anchor;
335
336         hook_dead_node_elim(irg, 1);
337
338         inc_irg_visited(irg);
339
340         env.irg        = irg;
341         env.worklist   = new_waitq();
342         env.old_anchor = irg->anchor;
343
344         old_end = get_irg_end(irg);
345
346         /* put all anchor nodes in the worklist */
347         for (i = get_irg_n_anchors(irg) - 1; i >= 0; --i) {
348                 ir_node *anchor = get_irg_anchor(irg, i);
349
350                 if (anchor == NULL)
351                         continue;
352                 waitq_put(env.worklist, anchor);
353         }
354
355         new_anchor  = new_r_Anchor(irg);
356         irg->anchor = new_anchor;
357
358         /* pre transform some anchors (so they are available in the other transform
359          * functions) */
360         pre_transform_anchor(anchor_bad);
361         pre_transform_anchor(anchor_no_mem);
362         pre_transform_anchor(anchor_end_block);
363         pre_transform_anchor(anchor_end);
364         pre_transform_anchor(anchor_start_block);
365         pre_transform_anchor(anchor_start);
366         pre_transform_anchor(anchor_frame);
367         kill_unused_anchor(anchor_tls);
368
369         if (pre_transform)
370                 pre_transform();
371
372         /* process worklist (this should transform all nodes in the graph) */
373         while (! waitq_empty(env.worklist)) {
374                 ir_node *node = (ir_node*)waitq_get(env.worklist);
375                 be_transform_node(node);
376         }
377
378         /* let beabi grab new nodes */
379         be_abi_transform_fixup(irg);
380         assert(waitq_empty(env.worklist)); // let's hope this didn't trigger new transforms
381
382         /* fix loops and set new anchors*/
383         inc_irg_visited(irg);
384         for (i = get_irg_n_anchors(irg) - 1; i >= 0; --i) {
385                 ir_node *anchor = get_irn_n(env.old_anchor, i);
386
387                 if (anchor == NULL)
388                         continue;
389
390                 anchor = (ir_node*)get_irn_link(anchor);
391                 fix_loops(anchor);
392                 set_irn_n(new_anchor, i, anchor);
393         }
394
395         del_waitq(env.worklist);
396         free_End(old_end);
397         hook_dead_node_elim(irg, 0);
398 }
399
400 void be_transform_graph(ir_graph *irg, arch_pretrans_nodes *func)
401 {
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         new_identities(irg);
422
423         /* do the main transformation */
424         transform_nodes(irg, func);
425
426         /* free the old obstack */
427         obstack_free(old_obst, 0);
428         xfree(old_obst);
429
430         /* restore state */
431         current_ir_graph = old_current_ir_graph;
432
433         /* most analysis info is wrong after transformation */
434         free_callee_info(irg);
435         free_irg_outs(irg);
436         free_trouts();
437         free_loop_information(irg);
438         set_irg_doms_inconsistent(irg);
439
440         be_liveness_invalidate(be_get_irg_liveness(irg));
441         /* Hack for now, something is buggy with invalidate liveness... */
442         be_birg_from_irg(irg)->lv = NULL;
443         be_invalidate_dom_front(irg);
444
445         /* recalculate edges */
446         edges_deactivate(irg);
447         edges_activate(irg);
448 }
449
450 int be_mux_is_abs(ir_node *sel, ir_node *mux_true, ir_node *mux_false)
451 {
452         ir_node    *cmp_left;
453         ir_node    *cmp_right;
454         ir_mode    *mode;
455         ir_relation relation;
456
457         if (!is_Cmp(sel))
458                 return 0;
459
460         /**
461          * Note further that these optimization work even for floating point
462          * with NaN's because -NaN == NaN.
463          * However, if +0 and -0 is handled differently, we cannot use the Abs/-Abs
464          * transformations.
465          */
466         mode = get_irn_mode(mux_true);
467         if (mode_honor_signed_zeros(mode))
468                 return 0;
469
470         /* must be <, <=, >=, > */
471         relation = get_Cmp_relation(sel);
472         if ((relation & ir_relation_less_greater) == 0)
473                 return 0;
474
475         if (!ir_is_negated_value(mux_true, mux_false))
476                 return 0;
477
478         /* must be x cmp 0 */
479         cmp_right = get_Cmp_right(sel);
480         if (!is_Const(cmp_right) || !is_Const_null(cmp_right))
481                 return 0;
482
483         cmp_left = get_Cmp_left(sel);
484         if (cmp_left == mux_false) {
485                 if (relation & ir_relation_less) {
486                         return 1;
487                 } else {
488                         assert(relation & ir_relation_greater);
489                         return -1;
490                 }
491         } else if (cmp_left == mux_true) {
492                 if (relation & ir_relation_less) {
493                         return -1;
494                 } else {
495                         assert(relation & ir_relation_greater);
496                         return 1;
497                 }
498         }
499
500         return 0;
501 }
502
503 ir_node *be_get_abs_op(ir_node *sel)
504 {
505         ir_node *cmp_left = get_Cmp_left(sel);
506         return cmp_left;
507 }