- BugFix: fixed effect of r22470: Immediate is always the RIGHT operand
[libfirm] / ir / be / ia32 / ia32_finish.c
1 /*
2  * Copyright (C) 1995-2008 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   This file implements functions to finalize the irg for emit.
23  * @author  Christian Wuerdig
24  * @version $Id$
25  */
26 #ifdef HAVE_CONFIG_H
27 #include "config.h"
28 #endif
29
30 #include "irnode.h"
31 #include "ircons.h"
32 #include "irgmod.h"
33 #include "irgwalk.h"
34 #include "iredges.h"
35 #include "irprintf.h"
36 #include "pdeq.h"
37 #include "error.h"
38
39 #include "../bearch_t.h"
40 #include "../besched_t.h"
41 #include "../benode_t.h"
42
43 #include "bearch_ia32_t.h"
44 #include "ia32_finish.h"
45 #include "ia32_new_nodes.h"
46 #include "ia32_map_regs.h"
47 #include "ia32_common_transform.h"
48 #include "ia32_transform.h"
49 #include "ia32_dbg_stat.h"
50 #include "ia32_optimize.h"
51 #include "gen_ia32_regalloc_if.h"
52
53 DEBUG_ONLY(static firm_dbg_module_t *dbg = NULL;)
54
55 /**
56  * Transforms a Sub or xSub into Neg--Add iff OUT_REG == SRC2_REG.
57  * THIS FUNCTIONS MUST BE CALLED AFTER REGISTER ALLOCATION.
58  */
59 static void ia32_transform_sub_to_neg_add(ir_node *irn, ia32_code_gen_t *cg) {
60         ir_graph *irg;
61         ir_node *in1, *in2, *noreg, *nomem, *res;
62         ir_node *noreg_fp, *block;
63         dbg_info *dbg;
64         const arch_register_t *in1_reg, *in2_reg, *out_reg;
65
66         /* fix_am will solve this for AddressMode variants */
67         if (get_ia32_op_type(irn) != ia32_Normal)
68                 return;
69
70         noreg    = ia32_new_NoReg_gp(cg);
71         noreg_fp = ia32_new_NoReg_xmm(cg);
72         nomem    = new_rd_NoMem(cg->irg);
73         in1      = get_irn_n(irn, n_ia32_binary_left);
74         in2      = get_irn_n(irn, n_ia32_binary_right);
75         in1_reg  = arch_get_irn_register(cg->arch_env, in1);
76         in2_reg  = arch_get_irn_register(cg->arch_env, in2);
77         out_reg  = get_ia32_out_reg(irn, 0);
78
79         irg     = cg->irg;
80         block   = get_nodes_block(irn);
81
82         /* in case of sub and OUT == SRC2 we can transform the sequence into neg src2 -- add */
83         if (out_reg != in2_reg)
84                 return;
85
86         dbg = get_irn_dbg_info(irn);
87
88         /* generate the neg src2 */
89         if (is_ia32_xSub(irn)) {
90                 int size;
91                 ir_entity *entity;
92                 ir_mode *op_mode = get_ia32_ls_mode(irn);
93
94                 assert(get_irn_mode(irn) != mode_T);
95
96                 res = new_rd_ia32_xXor(dbg, irg, block, noreg, noreg, nomem, in2, noreg_fp);
97                 size = get_mode_size_bits(op_mode);
98                 entity = ia32_gen_fp_known_const(size == 32 ? ia32_SSIGN : ia32_DSIGN);
99                 set_ia32_am_sc(res, entity);
100                 set_ia32_op_type(res, ia32_AddrModeS);
101                 set_ia32_ls_mode(res, op_mode);
102
103                 arch_set_irn_register(cg->arch_env, res, in2_reg);
104
105                 /* add to schedule */
106                 sched_add_before(irn, res);
107
108                 /* generate the add */
109                 res = new_rd_ia32_xAdd(dbg, irg, block, noreg, noreg, nomem, res, in1);
110                 set_ia32_ls_mode(res, get_ia32_ls_mode(irn));
111
112                 /* exchange the add and the sub */
113                 edges_reroute(irn, res, irg);
114
115                 /* add to schedule */
116                 sched_add_before(irn, res);
117         } else {
118                 ir_node         *res_proj   = NULL;
119                 ir_node         *flags_proj = NULL;
120                 const ir_edge_t *edge;
121
122                 if (get_irn_mode(irn) == mode_T) {
123                         /* collect the Proj uses */
124                         foreach_out_edge(irn, edge) {
125                                 ir_node *proj = get_edge_src_irn(edge);
126                                 long     pn   = get_Proj_proj(proj);
127                                 if(pn == pn_ia32_Sub_res) {
128                                         assert(res_proj == NULL);
129                                         res_proj = proj;
130                                 } else {
131                                         assert(pn == pn_ia32_Sub_flags);
132                                         assert(flags_proj == NULL);
133                                         flags_proj = proj;
134                                 }
135                         }
136                 }
137
138                 if (flags_proj == NULL) {
139                         res = new_rd_ia32_Neg(dbg, irg, block, in2);
140                         arch_set_irn_register(cg->arch_env, res, in2_reg);
141
142                         /* add to schedule */
143                         sched_add_before(irn, res);
144
145                         /* generate the add */
146                         res = new_rd_ia32_Add(dbg, irg, block, noreg, noreg, nomem, res, in1);
147                         arch_set_irn_register(cg->arch_env, res, out_reg);
148                         set_ia32_commutative(res);
149
150                         /* exchange the add and the sub */
151                         edges_reroute(irn, res, irg);
152
153                         /* add to schedule */
154                         sched_add_before(irn, res);
155                 } else {
156                         ir_node *stc, *cmc, *not, *adc;
157                         ir_node *adc_flags;
158
159                         /*
160                          * ARG, the above technique does NOT set the flags right.
161                          * So, we must produce the following code:
162                          * t1 = ~b
163                          * t2 = a + ~b + Carry
164                          * Complement Carry
165                          *
166                          * a + -b = a + (~b + 1)  would set the carry flag IF a == b ...
167                          */
168                         not = new_rd_ia32_Not(dbg, irg, block, in2);
169                         arch_set_irn_register(cg->arch_env, not, in2_reg);
170                         sched_add_before(irn, not);
171
172                         stc = new_rd_ia32_Stc(dbg, irg, block);
173                         arch_set_irn_register(cg->arch_env, stc,
174                                               &ia32_flags_regs[REG_EFLAGS]);
175                         sched_add_before(irn, stc);
176
177                         adc = new_rd_ia32_Adc(dbg, irg, block, noreg, noreg, nomem, not,
178                                               in1, stc);
179                         arch_set_irn_register(cg->arch_env, adc, out_reg);
180                         sched_add_before(irn, adc);
181
182                         set_irn_mode(adc, mode_T);
183                         adc_flags = new_r_Proj(irg, block, adc, mode_Iu, pn_ia32_Adc_flags);
184                         arch_set_irn_register(cg->arch_env, adc_flags,
185                                               &ia32_flags_regs[REG_EFLAGS]);
186
187                         cmc = new_rd_ia32_Cmc(dbg, irg, block, adc_flags);
188                         arch_set_irn_register(cg->arch_env, cmc,
189                                               &ia32_flags_regs[REG_EFLAGS]);
190                         sched_add_before(irn, cmc);
191
192                         exchange(flags_proj, cmc);
193                         if (res_proj != NULL) {
194                                 set_Proj_pred(res_proj, adc);
195                                 set_Proj_proj(res_proj, pn_ia32_Adc_res);
196                         }
197
198                         res = adc;
199                 }
200         }
201
202         SET_IA32_ORIG_NODE(res, ia32_get_old_node_name(cg, irn));
203
204         /* remove the old sub */
205         sched_remove(irn);
206         kill_node(irn);
207
208         DBG_OPT_SUB2NEGADD(irn, res);
209 }
210
211 static INLINE int need_constraint_copy(ir_node *irn) {
212         /* the 3 operand form of IMul needs no constraint copy */
213         if(is_ia32_IMul(irn)) {
214                 ir_node *right = get_irn_n(irn, n_ia32_IMul_right);
215                 if(is_ia32_Immediate(right))
216                         return 0;
217         }
218
219         return  ! is_ia32_Lea(irn)      &&
220                 ! is_ia32_Conv_I2I(irn)     &&
221                 ! is_ia32_Conv_I2I8Bit(irn) &&
222                 ! is_ia32_CMov(irn);
223 }
224
225 /**
226  * Returns the index of the "same" register.
227  * On the x86, we should have only one.
228  */
229 static int get_first_same(const arch_register_req_t* req)
230 {
231         const unsigned other = req->other_same;
232         int i;
233
234         for (i = 0; i < 32; ++i) {
235                 if (other & (1U << i)) return i;
236         }
237         assert(! "same position not found");
238         return 32;
239 }
240
241 /**
242  * Insert copies for all ia32 nodes where the should_be_same requirement
243  * is not fulfilled.
244  * Transform Sub into Neg -- Add if IN2 == OUT
245  */
246 static void assure_should_be_same_requirements(ia32_code_gen_t *cg,
247                                                ir_node *node)
248 {
249         ir_graph                   *irg      = cg->irg;
250         const arch_env_t           *arch_env = cg->arch_env;
251         const arch_register_req_t **reqs;
252         const arch_register_t      *out_reg, *in_reg;
253         int                         n_res, i;
254         ir_node                    *in_node, *block;
255
256         reqs  = get_ia32_out_req_all(node);
257         n_res = get_ia32_n_res(node);
258         block = get_nodes_block(node);
259
260         /* check all OUT requirements, if there is a should_be_same */
261         for (i = 0; i < n_res; i++) {
262                 int                          i2, arity;
263                 int                          same_pos;
264                 ir_node                     *perm;
265                 ir_node                     *in[2];
266                 ir_node                     *perm_proj0;
267                 ir_node                     *perm_proj1;
268                 ir_node                     *uses_out_reg;
269                 const arch_register_req_t   *req = reqs[i];
270                 const arch_register_class_t *cls;
271                 int                         uses_out_reg_pos;
272
273                 if (!arch_register_req_is(req, should_be_same))
274                         continue;
275
276                 same_pos = get_first_same(req);
277
278                 /* get in and out register */
279                 out_reg  = get_ia32_out_reg(node, i);
280                 in_node  = get_irn_n(node, same_pos);
281                 in_reg   = arch_get_irn_register(arch_env, in_node);
282
283                 /* requirement already fulfilled? */
284                 if (in_reg == out_reg)
285                         continue;
286                 /* unknowns can be changed to any register we want on emitting */
287                 if (is_unknown_reg(in_reg))
288                         continue;
289                 cls = arch_register_get_class(in_reg);
290                 assert(cls == arch_register_get_class(out_reg));
291
292                 /* check if any other input operands uses the out register */
293                 arity = get_irn_arity(node);
294                 uses_out_reg     = NULL;
295                 uses_out_reg_pos = -1;
296                 for(i2 = 0; i2 < arity; ++i2) {
297                         ir_node               *in     = get_irn_n(node, i2);
298                         const arch_register_t *in_reg;
299
300                         if(!mode_is_data(get_irn_mode(in)))
301                                 continue;
302
303                         in_reg = arch_get_irn_register(arch_env, in);
304
305                         if(in_reg != out_reg)
306                                 continue;
307
308                         if(uses_out_reg != NULL && in != uses_out_reg) {
309                                 panic("invalid register allocation");
310                         }
311                         uses_out_reg = in;
312                         if(uses_out_reg_pos >= 0)
313                                 uses_out_reg_pos = -1; /* multiple inputs... */
314                         else
315                                 uses_out_reg_pos = i2;
316                 }
317
318                 /* no-one else is using the out reg, we can simply copy it
319                  * (the register can't be live since the operation will override it
320                  *  anyway) */
321                 if(uses_out_reg == NULL) {
322                         ir_node *copy = be_new_Copy(cls, irg, block, in_node);
323                         DBG_OPT_2ADDRCPY(copy);
324
325                         /* destination is the out register */
326                         arch_set_irn_register(arch_env, copy, out_reg);
327
328                         /* insert copy before the node into the schedule */
329                         sched_add_before(node, copy);
330
331                         /* set copy as in */
332                         set_irn_n(node, same_pos, copy);
333
334                         DBG((dbg, LEVEL_1, "created copy %+F for should be same argument "
335                              "at input %d of %+F\n", copy, same_pos, node));
336                         continue;
337                 }
338
339                 /* for commutative nodes we can simply swap the left/right */
340                 if (uses_out_reg_pos == n_ia32_binary_right && is_ia32_commutative(node)) {
341                         ia32_swap_left_right(node);
342                         DBG((dbg, LEVEL_1, "swapped left/right input of %+F to resolve "
343                              "should be same constraint\n", node));
344                         continue;
345                 }
346
347 #ifdef DEBUG_libfirm
348                 ir_fprintf(stderr, "Note: need perm to resolve should_be_same constraint at %+F (this is unsafe and should not happen in theory...)\n", node);
349 #endif
350                 /* the out reg is used as node input: we need to permutate our input
351                  * and the other (this is allowed, since the other node can't be live
352                  * after! the operation as we will override the register. */
353                 in[0] = in_node;
354                 in[1] = uses_out_reg;
355                 perm  = be_new_Perm(cls, irg, block, 2, in);
356
357                 perm_proj0 = new_r_Proj(irg, block, perm, get_irn_mode(in[0]), 0);
358                 perm_proj1 = new_r_Proj(irg, block, perm, get_irn_mode(in[1]), 1);
359
360                 arch_set_irn_register(arch_env, perm_proj0, out_reg);
361                 arch_set_irn_register(arch_env, perm_proj1, in_reg);
362
363                 sched_add_before(node, perm);
364
365                 DBG((dbg, LEVEL_1, "created perm %+F for should be same argument "
366                      "at input %d of %+F (need permutate with %+F)\n", perm, same_pos,
367                      node, uses_out_reg));
368
369                 /* use the perm results */
370                 for(i2 = 0; i2 < arity; ++i2) {
371                         ir_node *in = get_irn_n(node, i2);
372
373                         if(in == in_node) {
374                                 set_irn_n(node, i2, perm_proj0);
375                         } else if(in == uses_out_reg) {
376                                 set_irn_n(node, i2, perm_proj1);
377                         }
378                 }
379         }
380 }
381
382 /**
383  * Following Problem:
384  * We have a source address mode node with base or index register equal to
385  * result register and unfulfilled should_be_same requirement. The constraint
386  * handler will insert a copy from the remaining input operand to the result
387  * register -> base or index is broken then.
388  * Solution: Turn back this address mode into explicit Load + Operation.
389  */
390 static void fix_am_source(ir_node *irn, void *env)
391 {
392         ia32_code_gen_t            *cg = env;
393         const arch_env_t           *arch_env = cg->arch_env;
394         ir_node                    *base;
395         ir_node                    *index;
396         ir_node                    *noreg;
397         const arch_register_t      *reg_base;
398         const arch_register_t      *reg_index;
399         const arch_register_req_t **reqs;
400         int                         n_res, i;
401
402         /* check only ia32 nodes with source address mode */
403         if (! is_ia32_irn(irn) || get_ia32_op_type(irn) != ia32_AddrModeS)
404                 return;
405         /* only need to fix binary operations */
406         if (get_ia32_am_support(irn) != ia32_am_binary)
407                 return;
408
409         base  = get_irn_n(irn, n_ia32_base);
410         index = get_irn_n(irn, n_ia32_index);
411
412         reg_base  = arch_get_irn_register(arch_env, base);
413         reg_index = arch_get_irn_register(arch_env, index);
414         reqs      = get_ia32_out_req_all(irn);
415
416         noreg = ia32_new_NoReg_gp(cg);
417
418         n_res = get_ia32_n_res(irn);
419
420         for (i = 0; i < n_res; i++) {
421                 if (arch_register_req_is(reqs[i], should_be_same)) {
422                         /* get in and out register */
423                         const arch_register_t *out_reg   = get_ia32_out_reg(irn, i);
424                         int                    same_pos  = get_first_same(reqs[i]);
425                         ir_node               *same_node = get_irn_n(irn, same_pos);
426                         const arch_register_t *same_reg
427                                 = arch_get_irn_register(arch_env, same_node);
428                         const arch_register_class_t *same_cls;
429                         ir_graph              *irg   = cg->irg;
430                         dbg_info              *dbgi  = get_irn_dbg_info(irn);
431                         ir_node               *block = get_nodes_block(irn);
432                         ir_mode               *proj_mode;
433                         ir_node               *load;
434                         ir_node               *load_res;
435                         ir_node               *mem;
436                         int                    pnres;
437                         int                    pnmem;
438
439                         /* should_be same constraint is fullfilled, nothing to do */
440                         if(out_reg == same_reg)
441                                 continue;
442
443                         /* we only need to do something if the out reg is the same as base
444                            or index register */
445                         if (out_reg != reg_base && out_reg != reg_index)
446                                 continue;
447
448                         /* turn back address mode */
449                         same_cls = arch_register_get_class(same_reg);
450                         mem = get_irn_n(irn, n_ia32_mem);
451                         assert(get_irn_mode(mem) == mode_M);
452                         if (same_cls == &ia32_reg_classes[CLASS_ia32_gp]) {
453                                 load      = new_rd_ia32_Load(dbgi, irg, block, base, index, mem);
454                                 pnres     = pn_ia32_Load_res;
455                                 pnmem     = pn_ia32_Load_M;
456                                 proj_mode = mode_Iu;
457                         } else if (same_cls == &ia32_reg_classes[CLASS_ia32_xmm]) {
458                                 load      = new_rd_ia32_xLoad(dbgi, irg, block, base, index, mem,
459                                                               get_ia32_ls_mode(irn));
460                                 pnres     = pn_ia32_xLoad_res;
461                                 pnmem     = pn_ia32_xLoad_M;
462                                 proj_mode = mode_E;
463                         } else {
464                                 panic("cannot turn back address mode for this register class");
465                         }
466
467                         /* copy address mode information to load */
468                         set_ia32_op_type(load, ia32_AddrModeS);
469                         ia32_copy_am_attrs(load, irn);
470                         if (is_ia32_is_reload(irn))
471                                 set_ia32_is_reload(load);
472
473                         /* insert the load into schedule */
474                         sched_add_before(irn, load);
475
476                         DBG((dbg, LEVEL_3, "irg %+F: build back AM source for node %+F, inserted load %+F\n", cg->irg, irn, load));
477
478                         load_res = new_r_Proj(cg->irg, block, load, proj_mode, pnres);
479                         arch_set_irn_register(cg->arch_env, load_res, out_reg);
480
481                         /* set the new input operand */
482                         if (is_ia32_Immediate(get_irn_n(irn, n_ia32_binary_right)))
483                                 set_irn_n(irn, n_ia32_binary_left, load_res);
484                         else
485                                 set_irn_n(irn, n_ia32_binary_right, load_res);
486                         if (get_irn_mode(irn) == mode_T) {
487                                 const ir_edge_t *edge, *next;
488                                 foreach_out_edge_safe(irn, edge, next) {
489                                         ir_node *node = get_edge_src_irn(edge);
490                                         int      pn   = get_Proj_proj(node);
491                                         if (pn == pn_ia32_res) {
492                                                 exchange(node, irn);
493                                         } else if (pn == pn_ia32_mem) {
494                                                 set_Proj_pred(node, load);
495                                                 set_Proj_proj(node, pnmem);
496                                         } else {
497                                                 panic("Unexpected Proj");
498                                         }
499                                 }
500                                 set_irn_mode(irn, mode_Iu);
501                         }
502
503                         /* this is a normal node now */
504                         set_irn_n(irn, n_ia32_base,  noreg);
505                         set_irn_n(irn, n_ia32_index, noreg);
506                         set_ia32_op_type(irn, ia32_Normal);
507                         break;
508                 }
509         }
510 }
511
512 /**
513  * Block walker: finishes a block
514  */
515 static void ia32_finish_irg_walker(ir_node *block, void *env) {
516         ia32_code_gen_t *cg = env;
517         ir_node *irn, *next;
518
519         /* first: turn back AM source if necessary */
520         for (irn = sched_first(block); ! sched_is_end(irn); irn = next) {
521                 next = sched_next(irn);
522                 fix_am_source(irn, env);
523         }
524
525         for (irn = sched_first(block); ! sched_is_end(irn); irn = next) {
526                 ia32_code_gen_t *cg = env;
527
528                 next = sched_next(irn);
529
530                 /* check if there is a sub which need to be transformed */
531                 if (is_ia32_Sub(irn) || is_ia32_xSub(irn)) {
532                         ia32_transform_sub_to_neg_add(irn, cg);
533                 }
534         }
535
536         /* second: insert copies and finish irg */
537         for (irn = sched_first(block); ! sched_is_end(irn); irn = next) {
538                 next = sched_next(irn);
539                 if (is_ia32_irn(irn)) {
540                         /* some nodes are just a bit less efficient, but need no fixing if the
541                          * should be same requirement is not fulfilled */
542                         if (need_constraint_copy(irn))
543                                 assure_should_be_same_requirements(cg, irn);
544                 }
545         }
546 }
547
548 /**
549  * Block walker: pushes all blocks on a wait queue
550  */
551 static void ia32_push_on_queue_walker(ir_node *block, void *env) {
552         waitq *wq = env;
553         waitq_put(wq, block);
554 }
555
556
557 /**
558  * Add Copy nodes for not fulfilled should_be_equal constraints
559  */
560 void ia32_finish_irg(ir_graph *irg, ia32_code_gen_t *cg) {
561         waitq *wq = new_waitq();
562
563         /* Push the blocks on the waitq because ia32_finish_irg_walker starts more walks ... */
564         irg_block_walk_graph(irg, NULL, ia32_push_on_queue_walker, wq);
565
566         while (! waitq_empty(wq)) {
567                 ir_node *block = waitq_get(wq);
568                 ia32_finish_irg_walker(block, cg);
569         }
570         del_waitq(wq);
571 }
572
573 void ia32_init_finish(void)
574 {
575         FIRM_DBG_REGISTER(dbg, "firm.be.ia32.finish");
576 }