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