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