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