fix bad input register requirements
[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 ir_node *be_transform_phi(ir_node *node, const arch_register_req_t *req)
91 {
92         ir_node  *block = be_transform_node(get_nodes_block(node));
93         ir_graph *irg   = current_ir_graph;
94         dbg_info *dbgi  = get_irn_dbg_info(node);
95
96         /* phi nodes allow loops, so we use the old arguments for now
97          * and fix this later */
98         ir_node **ins   = get_irn_in(node)+1;
99         int       arity = get_irn_arity(node);
100         ir_mode  *mode  = req->cls != NULL ? req->cls->mode : get_irn_mode(node);
101         ir_node  *phi   = new_ir_node(dbgi, irg, block, op_Phi, mode, arity, ins);
102         copy_node_attr(irg, node, phi);
103         be_duplicate_deps(node, phi);
104
105         backend_info_t *info = be_get_info(phi);
106         struct obstack *obst = be_get_be_obst(irg);
107         info->in_reqs = OALLOCN(obst, const arch_register_req_t*, arity);
108         for (int i = 0; i < arity; ++i) {
109                 info->in_reqs[i] = req;
110         }
111
112         arch_set_irn_register_req_out(phi, 0, req);
113         be_enqueue_preds(node);
114
115         return phi;
116 }
117
118 void be_set_transform_function(ir_op *op, be_transform_func func)
119 {
120         /* shouldn't be assigned twice (except for exchanging the default
121          * be_duplicate_node entries) */
122         assert(op->ops.generic == NULL
123                         || op->ops.generic == (op_func) be_duplicate_node);
124         op->ops.generic = (op_func) func;
125 }
126
127 /**
128  * Transform helper for blocks.
129  */
130 static ir_node *transform_block(ir_node *node)
131 {
132         ir_graph *irg   = get_irn_irg(node);
133         dbg_info *dbgi  = get_irn_dbg_info(node);
134         ir_mode  *mode  = get_irn_mode(node);
135         ir_node  *block = new_ir_node(dbgi, irg, NULL, get_irn_op(node), mode,
136                                       get_irn_arity(node), get_irn_in(node) + 1);
137         copy_node_attr(irg, node, block);
138         block->node_nr = node->node_nr;
139
140         /* transfer execfreq value */
141         double execfreq = get_block_execfreq(node);
142         set_block_execfreq(block, execfreq);
143
144         /* put the preds in the worklist */
145         be_enqueue_preds(node);
146
147         return block;
148 }
149
150 static ir_node *transform_end(ir_node *node)
151 {
152         /* end has to be duplicated manually because we need a dynamic in array */
153         ir_graph *irg     = get_irn_irg(node);
154         dbg_info *dbgi    = get_irn_dbg_info(node);
155         ir_node  *block   = be_transform_node(get_nodes_block(node));
156         ir_node  *new_end = new_ir_node(dbgi, irg, block, op_End, mode_X, -1, NULL);
157         copy_node_attr(irg, node, new_end);
158         be_duplicate_deps(node, new_end);
159
160         set_irg_end(irg, new_end);
161
162         /* do not transform predecessors yet to keep the pre-transform
163          * phase from visiting all the graph */
164         int arity = get_irn_arity(node);
165         for (int i = 0; i < arity; ++i) {
166                 ir_node *in = get_irn_n(node, i);
167                 add_End_keepalive(new_end, in);
168         }
169         be_enqueue_preds(node);
170
171         return new_end;
172 }
173
174 ir_node *be_duplicate_node(ir_node *node)
175 {
176         ir_node  *block = be_transform_node(get_nodes_block(node));
177         ir_graph *irg   = env.irg;
178         dbg_info *dbgi  = get_irn_dbg_info(node);
179         ir_mode  *mode  = get_irn_mode(node);
180         ir_op    *op    = get_irn_op(node);
181
182         ir_node *new_node;
183         int      arity = get_irn_arity(node);
184         if (op->opar == oparity_dynamic) {
185                 new_node = new_ir_node(dbgi, irg, block, op, mode, -1, NULL);
186                 for (int i = 0; i < arity; ++i) {
187                         ir_node *in = get_irn_n(node, i);
188                         in = be_transform_node(in);
189                         add_irn_n(new_node, in);
190                 }
191         } else {
192                 ir_node **ins = ALLOCAN(ir_node*, arity);
193                 for (int i = 0; i < arity; ++i) {
194                         ir_node *in = get_irn_n(node, i);
195                         ins[i] = be_transform_node(in);
196                 }
197
198                 new_node = new_ir_node(dbgi, irg, block, op, mode, arity, ins);
199         }
200
201         copy_node_attr(irg, node, new_node);
202         be_duplicate_deps(node, new_node);
203
204         new_node->node_nr = node->node_nr;
205         return new_node;
206 }
207
208 ir_node *be_transform_node(ir_node *node)
209 {
210         ir_node *new_node = be_get_transformed_node(node);
211         if (new_node != NULL)
212                 return new_node;
213
214         DEBUG_ONLY(be_set_transformed_node(node, NULL);)
215
216         ir_op *op = get_irn_op(node);
217         if (op->ops.generic == NULL) {
218                 panic("No transform function registered for node %+F.", node);
219         }
220         be_transform_func *transform = (be_transform_func *)op->ops.generic;
221
222         new_node = transform(node);
223         assert(new_node != NULL);
224
225         be_set_transformed_node(node, new_node);
226         return new_node;
227 }
228
229 void be_enqueue_preds(ir_node *node)
230 {
231         /* put the preds in the worklist */
232         int arity = get_irn_arity(node);
233         for (int 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         assert(node_is_in_irgs_storage(env.irg, node));
245
246         if (irn_visited_else_mark(node))
247                 return;
248
249         bool changed = false;
250         if (! is_Block(node)) {
251                 ir_node *block     = get_nodes_block(node);
252                 ir_node *new_block = (ir_node*)get_irn_link(block);
253
254                 if (new_block != NULL) {
255                         set_nodes_block(node, new_block);
256                         block = new_block;
257                         changed = true;
258                 }
259
260                 fix_loops(block);
261         }
262
263         int arity = get_irn_arity(node);
264         for (int i = 0; i < arity; ++i) {
265                 ir_node *in = get_irn_n(node, i);
266                 ir_node *nw = (ir_node*)get_irn_link(in);
267
268                 if (nw != NULL && nw != in) {
269                         set_irn_n(node, i, nw);
270                         in = nw;
271                         changed = true;
272                 }
273
274                 fix_loops(in);
275         }
276         /* fix proj block */
277         if (is_Proj(node)) {
278                 set_nodes_block(node, get_nodes_block(get_Proj_pred(node)));
279                 changed = true;
280         }
281
282         arity = get_irn_deps(node);
283         for (int i = 0; i < arity; ++i) {
284                 ir_node *in = get_irn_dep(node, i);
285                 ir_node *nw = (ir_node*)get_irn_link(in);
286
287                 if (nw != NULL && nw != in) {
288                         set_irn_dep(node, i, nw);
289                         in = nw;
290                         changed = true;
291                 }
292
293                 fix_loops(in);
294         }
295
296         if (changed) {
297                 identify_remember(node);
298         }
299 }
300
301 ir_node *be_pre_transform_node(ir_node *place)
302 {
303         if (place == NULL)
304                 return NULL;
305
306         return be_transform_node(place);
307 }
308
309 static void pre_transform_anchor(ir_graph *irg, int anchor)
310 {
311         ir_node *old_anchor_node = get_irn_n(env.old_anchor, anchor);
312         ir_node *transformed     = be_transform_node(old_anchor_node);
313         set_irg_anchor(irg, anchor, transformed);
314 }
315
316 /**
317  * Transforms all nodes. Deletes the old obstack and creates a new one.
318  */
319 static void transform_nodes(ir_graph *irg, arch_pretrans_nodes *pre_transform)
320 {
321         hook_dead_node_elim(irg, 1);
322
323         inc_irg_visited(irg);
324
325         env.irg        = irg;
326         env.worklist   = new_waitq();
327         env.old_anchor = irg->anchor;
328
329         ir_node *old_end = get_irg_end(irg);
330
331         /* put all anchor nodes in the worklist */
332         for (int i = get_irg_n_anchors(irg) - 1; i >= 0; --i) {
333                 ir_node *anchor = get_irg_anchor(irg, i);
334
335                 if (anchor == NULL)
336                         continue;
337                 waitq_put(env.worklist, anchor);
338         }
339
340         ir_node *new_anchor  = new_r_Anchor(irg);
341         irg->anchor = new_anchor;
342
343         /* pre transform some anchors (so they are available in the other transform
344          * functions) */
345         pre_transform_anchor(irg, anchor_no_mem);
346         pre_transform_anchor(irg, anchor_end_block);
347         pre_transform_anchor(irg, anchor_end);
348         pre_transform_anchor(irg, anchor_start_block);
349         pre_transform_anchor(irg, anchor_start);
350         pre_transform_anchor(irg, anchor_frame);
351
352         if (pre_transform)
353                 pre_transform();
354
355         /* process worklist (this should transform all nodes in the graph) */
356         while (! waitq_empty(env.worklist)) {
357                 ir_node *node = (ir_node*)waitq_get(env.worklist);
358                 be_transform_node(node);
359         }
360
361         /* fix loops and set new anchors*/
362         inc_irg_visited(irg);
363         for (int i = get_irg_n_anchors(irg) - 1; i >= 0; --i) {
364                 ir_node *anchor = get_irn_n(env.old_anchor, i);
365
366                 if (anchor == NULL)
367                         continue;
368
369                 anchor = (ir_node*)get_irn_link(anchor);
370                 fix_loops(anchor);
371                 set_irn_n(new_anchor, i, anchor);
372         }
373
374         del_waitq(env.worklist);
375         free_End(old_end);
376         hook_dead_node_elim(irg, 0);
377 }
378
379 void be_transform_graph(ir_graph *irg, arch_pretrans_nodes *func)
380 {
381         ir_graph *old_current_ir_graph = current_ir_graph;
382         current_ir_graph = irg;
383
384         /* create a new obstack */
385         struct obstack *old_obst = irg->obst;
386         struct obstack *new_obst = XMALLOC(struct obstack);
387         obstack_init(new_obst);
388         irg->obst = new_obst;
389         irg->last_node_idx = 0;
390
391         free_vrp_data(irg);
392
393         /* create new value table for CSE */
394         new_identities(irg);
395
396         /* do the main transformation */
397         transform_nodes(irg, func);
398
399         /* free the old obstack */
400         obstack_free(old_obst, 0);
401         xfree(old_obst);
402
403         /* restore state */
404         current_ir_graph = old_current_ir_graph;
405
406         /* most analysis info is wrong after transformation */
407         be_invalidate_live_chk(irg);
408         confirm_irg_properties(irg, IR_GRAPH_PROPERTIES_NONE);
409
410         /* recalculate edges */
411         edges_activate(irg);
412 }
413
414 bool be_upper_bits_clean(const ir_node *node, ir_mode *mode)
415 {
416         ir_op *op = get_irn_op(node);
417         if (op->ops.generic1 == NULL)
418                 return false;
419         upper_bits_clean_func func = (upper_bits_clean_func)op->ops.generic1;
420         return func(node, mode);
421 }
422
423 static bool bit_binop_upper_bits_clean(const ir_node *node, ir_mode *mode)
424 {
425         return be_upper_bits_clean(get_binop_left(node), mode)
426             && be_upper_bits_clean(get_binop_right(node), mode);
427 }
428
429 static bool mux_upper_bits_clean(const ir_node *node, ir_mode *mode)
430 {
431         return be_upper_bits_clean(get_Mux_true(node), mode)
432             && be_upper_bits_clean(get_Mux_false(node), mode);
433 }
434
435 static bool and_upper_bits_clean(const ir_node *node, ir_mode *mode)
436 {
437         if (!mode_is_signed(mode)) {
438                 return be_upper_bits_clean(get_And_left(node), mode)
439                     || be_upper_bits_clean(get_And_right(node), mode);
440         } else {
441                 return bit_binop_upper_bits_clean(node, mode);
442         }
443 }
444
445 static bool shr_upper_bits_clean(const ir_node *node, ir_mode *mode)
446 {
447         if (mode_is_signed(mode)) {
448                 return false;
449         } else {
450                 const ir_node *right = get_Shr_right(node);
451                 if (is_Const(right)) {
452                         ir_tarval *tv  = get_Const_tarval(right);
453                         long       val = get_tarval_long(tv);
454                         if (val >= 32 - (long)get_mode_size_bits(mode))
455                                 return true;
456                 }
457                 return be_upper_bits_clean(get_Shr_left(node), mode);
458         }
459 }
460
461 static bool shrs_upper_bits_clean(const ir_node *node, ir_mode *mode)
462 {
463         return be_upper_bits_clean(get_Shrs_left(node), mode);
464 }
465
466 static bool const_upper_bits_clean(const ir_node *node, ir_mode *mode)
467 {
468         ir_tarval *tv  = get_Const_tarval(node);
469         long       val = get_tarval_long(tv);
470         if (mode_is_signed(mode)) {
471                 long    shifted = val >> (get_mode_size_bits(mode)-1);
472                 return shifted == 0 || shifted == -1;
473         } else {
474                 unsigned long shifted = (unsigned long)val;
475                 shifted >>= get_mode_size_bits(mode)-1;
476                 shifted >>= 1;
477                 return shifted == 0;
478         }
479 }
480
481 static bool conv_upper_bits_clean(const ir_node *node, ir_mode *mode)
482 {
483         ir_mode       *dest_mode = get_irn_mode(node);
484         const ir_node *op        = get_Conv_op(node);
485         ir_mode       *src_mode  = get_irn_mode(op);
486         if (mode_is_float(src_mode))
487                 return true;
488
489         unsigned src_bits  = get_mode_size_bits(src_mode);
490         unsigned dest_bits = get_mode_size_bits(dest_mode);
491         /* downconvs are a nop */
492         if (src_bits >= dest_bits)
493                 return be_upper_bits_clean(op, mode);
494         /* upconvs are fine if src is big enough or if sign matches */
495         if (src_bits <= get_mode_size_bits(mode)
496                 && mode_is_signed(src_mode) == mode_is_signed(mode))
497                 return true;
498         return false;
499 }
500
501 static bool proj_upper_bits_clean(const ir_node *node, ir_mode *mode)
502 {
503         const ir_node *pred = get_Proj_pred(node);
504         switch (get_irn_opcode(pred)) {
505         case iro_Load: {
506                 ir_mode *load_mode = get_Load_mode(pred);
507                 unsigned load_bits = get_mode_size_bits(load_mode);
508                 if (load_bits > get_mode_size_bits(mode))
509                         return false;
510                 if (mode_is_signed(load_mode) != mode_is_signed(mode))
511                         return false;
512                 return true;
513         }
514         default:
515                 break;
516         }
517         return false;
518 }
519
520 void be_set_upper_bits_clean_function(ir_op *op, upper_bits_clean_func func)
521 {
522         op->ops.generic1 = (op_func)func;
523 }
524
525 void be_start_transform_setup(void)
526 {
527         ir_clear_opcodes_generic_func();
528
529         be_set_transform_function(op_Bad,         be_duplicate_node);
530         be_set_transform_function(op_be_Copy,     be_duplicate_node);
531         be_set_transform_function(op_be_CopyKeep, be_duplicate_node);
532         be_set_transform_function(op_be_IncSP,    be_duplicate_node);
533         be_set_transform_function(op_be_Keep,     be_duplicate_node);
534         be_set_transform_function(op_be_Return,   be_duplicate_node);
535         be_set_transform_function(op_be_Start,    be_duplicate_node);
536         be_set_transform_function(op_Block,       transform_block);
537         be_set_transform_function(op_End,         transform_end);
538         be_set_transform_function(op_NoMem,       be_duplicate_node);
539         be_set_transform_function(op_Pin,         be_duplicate_node);
540         be_set_transform_function(op_Start,       be_duplicate_node);
541         be_set_transform_function(op_Sync,        be_duplicate_node);
542
543         be_set_upper_bits_clean_function(op_And,   and_upper_bits_clean);
544         be_set_upper_bits_clean_function(op_Const, const_upper_bits_clean);
545         be_set_upper_bits_clean_function(op_Conv,  conv_upper_bits_clean);
546         be_set_upper_bits_clean_function(op_Eor,   bit_binop_upper_bits_clean);
547         be_set_upper_bits_clean_function(op_Mux,   mux_upper_bits_clean);
548         be_set_upper_bits_clean_function(op_Or,    bit_binop_upper_bits_clean);
549         be_set_upper_bits_clean_function(op_Proj,  proj_upper_bits_clean);
550         be_set_upper_bits_clean_function(op_Shr,   shr_upper_bits_clean);
551         be_set_upper_bits_clean_function(op_Shrs,  shrs_upper_bits_clean);
552 }