- BugFix:
[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 sat 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                         adc_flags = new_r_Proj(irg, block, adc, mode_Iu, pn_ia32_Adc_flags);
181
182                         cmc = new_rd_ia32_Cmc(dbg, irg, block, adc_flags);
183                         sched_add_before(irn, cmc);
184
185                         exchange(flags_proj, cmc);
186                         if(res_proj != NULL) {
187                                 set_Proj_pred(res_proj, adc);
188                                 set_Proj_proj(res_proj, pn_ia32_Adc_res);
189                         }
190
191                         res = adc;
192                 }
193         }
194
195         SET_IA32_ORIG_NODE(res, ia32_get_old_node_name(cg, irn));
196
197         /* remove the old sub */
198         sched_remove(irn);
199         be_kill_node(irn);
200
201         DBG_OPT_SUB2NEGADD(irn, res);
202 }
203
204 static INLINE int need_constraint_copy(ir_node *irn) {
205         /* the 3 operand form of IMul needs no constraint copy */
206         if(is_ia32_IMul(irn)) {
207                 ir_node *right = get_irn_n(irn, n_ia32_IMul_right);
208                 if(is_ia32_Immediate(right))
209                         return 0;
210         }
211
212         return  ! is_ia32_Lea(irn)      &&
213                 ! is_ia32_Conv_I2I(irn)     &&
214                 ! is_ia32_Conv_I2I8Bit(irn) &&
215                 ! is_ia32_CMov(irn);
216 }
217
218 /**
219  * Returns the index of the "same" register.
220  * On the x86, we should have only one.
221  */
222 static int get_first_same(const arch_register_req_t* req)
223 {
224         const unsigned other = req->other_same;
225         int i;
226
227         for (i = 0; i < 32; ++i) {
228                 if (other & (1U << i)) return i;
229         }
230         assert(! "same position not found");
231         return 32;
232 }
233
234 /**
235  * Insert copies for all ia32 nodes where the should_be_same requirement
236  * is not fulfilled.
237  * Transform Sub into Neg -- Add if IN2 == OUT
238  */
239 static void assure_should_be_same_requirements(ia32_code_gen_t *cg,
240                                                ir_node *node)
241 {
242         ir_graph                   *irg      = cg->irg;
243         const arch_env_t           *arch_env = cg->arch_env;
244         const arch_register_req_t **reqs;
245         const arch_register_t      *out_reg, *in_reg;
246         int                         n_res, i;
247         ir_node                    *in_node, *block;
248
249         reqs  = get_ia32_out_req_all(node);
250         n_res = get_ia32_n_res(node);
251         block = get_nodes_block(node);
252
253         /* check all OUT requirements, if there is a should_be_same */
254         for (i = 0; i < n_res; i++) {
255                 int                          i2, arity;
256                 int                          same_pos;
257                 ir_node                     *perm;
258                 ir_node                     *in[2];
259                 ir_node                     *perm_proj0;
260                 ir_node                     *perm_proj1;
261                 ir_node                     *uses_out_reg;
262                 const arch_register_req_t   *req = reqs[i];
263                 const arch_register_class_t *class;
264                 int                         uses_out_reg_pos;
265
266                 if (!arch_register_req_is(req, should_be_same))
267                         continue;
268
269                 same_pos = get_first_same(req);
270
271                 /* get in and out register */
272                 out_reg  = get_ia32_out_reg(node, i);
273                 in_node  = get_irn_n(node, same_pos);
274                 in_reg   = arch_get_irn_register(arch_env, in_node);
275
276                 /* requirement already fulfilled? */
277                 if (in_reg == out_reg)
278                         continue;
279                 /* unknowns can be changed to any register we want on emitting */
280                 if (is_unknown_reg(in_reg))
281                         continue;
282                 class = arch_register_get_class(in_reg);
283                 assert(class == arch_register_get_class(out_reg));
284
285                 /* check if any other input operands uses the out register */
286                 arity = get_irn_arity(node);
287                 uses_out_reg     = NULL;
288                 uses_out_reg_pos = -1;
289                 for(i2 = 0; i2 < arity; ++i2) {
290                         ir_node               *in     = get_irn_n(node, i2);
291                         const arch_register_t *in_reg;
292
293                         if(!mode_is_data(get_irn_mode(in)))
294                                 continue;
295
296                         in_reg = arch_get_irn_register(arch_env, in);
297
298                         if(in_reg != out_reg)
299                                 continue;
300
301                         if(uses_out_reg != NULL && in != uses_out_reg) {
302                                 panic("invalid register allocation");
303                         }
304                         uses_out_reg = in;
305                         if(uses_out_reg_pos >= 0)
306                                 uses_out_reg_pos = -1; /* multiple inputs... */
307                         else
308                                 uses_out_reg_pos = i2;
309                 }
310
311                 /* no-one else is using the out reg, we can simply copy it
312                  * (the register can't be live since the operation will override it
313                  *  anyway) */
314                 if(uses_out_reg == NULL) {
315                         ir_node *copy = be_new_Copy(class, irg, block, in_node);
316                         DBG_OPT_2ADDRCPY(copy);
317
318                         /* destination is the out register */
319                         arch_set_irn_register(arch_env, copy, out_reg);
320
321                         /* insert copy before the node into the schedule */
322                         sched_add_before(node, copy);
323
324                         /* set copy as in */
325                         set_irn_n(node, same_pos, copy);
326
327                         DBG((dbg, LEVEL_1, "created copy %+F for should be same argument "
328                              "at input %d of %+F\n", copy, same_pos, node));
329                         continue;
330                 }
331
332                 /* for commutative nodes we can simply swap the left/right */
333                 if (uses_out_reg_pos == n_ia32_binary_right && is_ia32_commutative(node)) {
334                         ia32_swap_left_right(node);
335                         DBG((dbg, LEVEL_1, "swapped left/right input of %+F to resolve "
336                              "should be same constraint\n", node));
337                         continue;
338                 }
339
340 #ifdef DEBUG_libfirm
341                 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);
342 #endif
343                 /* the out reg is used as node input: we need to permutate our input
344                  * and the other (this is allowed, since the other node can't be live
345                  * after! the operation as we will override the register. */
346                 in[0] = in_node;
347                 in[1] = uses_out_reg;
348                 perm  = be_new_Perm(class, irg, block, 2, in);
349
350                 perm_proj0 = new_r_Proj(irg, block, perm, get_irn_mode(in[0]), 0);
351                 perm_proj1 = new_r_Proj(irg, block, perm, get_irn_mode(in[1]), 1);
352
353                 arch_set_irn_register(arch_env, perm_proj0, out_reg);
354                 arch_set_irn_register(arch_env, perm_proj1, in_reg);
355
356                 sched_add_before(node, perm);
357
358                 DBG((dbg, LEVEL_1, "created perm %+F for should be same argument "
359                      "at input %d of %+F (need permutate with %+F)\n", perm, same_pos,
360                      node, uses_out_reg));
361
362                 /* use the perm results */
363                 for(i2 = 0; i2 < arity; ++i2) {
364                         ir_node *in = get_irn_n(node, i2);
365
366                         if(in == in_node) {
367                                 set_irn_n(node, i2, perm_proj0);
368                         } else if(in == uses_out_reg) {
369                                 set_irn_n(node, i2, perm_proj1);
370                         }
371                 }
372         }
373 }
374
375 /**
376  * Following Problem:
377  * We have a source address mode node with base or index register equal to
378  * result register and unfulfilled should_be_same requirement. The constraint
379  * handler will insert a copy from the remaining input operand to the result
380  * register -> base or index is broken then.
381  * Solution: Turn back this address mode into explicit Load + Operation.
382  */
383 static void fix_am_source(ir_node *irn, void *env) {
384         ia32_code_gen_t            *cg = env;
385         const arch_env_t           *arch_env = cg->arch_env;
386         ir_node                    *base;
387         ir_node                    *index;
388         ir_node                    *noreg;
389         const arch_register_t      *reg_base;
390         const arch_register_t      *reg_index;
391         const arch_register_req_t **reqs;
392         int                         n_res, i;
393
394         /* check only ia32 nodes with source address mode */
395         if (! is_ia32_irn(irn) || get_ia32_op_type(irn) != ia32_AddrModeS)
396                 return;
397         /* only need to fix binary operations */
398         if (get_ia32_am_arity(irn) != ia32_am_binary)
399                 return;
400
401         base  = get_irn_n(irn, 0);
402         index = get_irn_n(irn, 1);
403
404         reg_base  = arch_get_irn_register(arch_env, base);
405         reg_index = arch_get_irn_register(arch_env, index);
406         reqs      = get_ia32_out_req_all(irn);
407
408         noreg = ia32_new_NoReg_gp(cg);
409
410         n_res = get_ia32_n_res(irn);
411
412         for (i = 0; i < n_res; i++) {
413                 if (arch_register_req_is(reqs[i], should_be_same)) {
414                         /* get in and out register */
415                         const arch_register_t *out_reg   = get_ia32_out_reg(irn, i);
416                         int                    same_pos  = get_first_same(reqs[i]);
417                         ir_node               *same_node = get_irn_n(irn, same_pos);
418                         const arch_register_t *same_reg
419                                 = arch_get_irn_register(arch_env, same_node);
420                         const arch_register_class_t *same_cls;
421                         ir_graph              *irg   = cg->irg;
422                         dbg_info              *dbgi  = get_irn_dbg_info(irn);
423                         ir_node               *block = get_nodes_block(irn);
424                         ir_mode               *proj_mode;
425                         ir_node               *load;
426                         ir_node               *load_res;
427                         ir_node               *mem;
428                         int                    pnres;
429
430                         /* should_be same constraint is fullfilled, nothing to do */
431                         if(out_reg == same_reg)
432                                 continue;
433
434                         /* we only need to do something if the out reg is the same as base
435                            or index register */
436                         if (out_reg != reg_base && out_reg != reg_index)
437                                 continue;
438
439                         /* turn back address mode */
440                         same_cls = arch_register_get_class(same_reg);
441                         mem = get_irn_n(irn, n_ia32_mem);
442                         assert(get_irn_mode(mem) == mode_M);
443                         if (same_cls == &ia32_reg_classes[CLASS_ia32_gp]) {
444                                 load      = new_rd_ia32_Load(dbgi, irg, block, base, index, mem);
445                                 pnres     = pn_ia32_Load_res;
446                                 proj_mode = mode_Iu;
447                         } else if (same_cls == &ia32_reg_classes[CLASS_ia32_xmm]) {
448                                 load      = new_rd_ia32_xLoad(dbgi, irg, block, base, index, mem,
449                                                               get_ia32_ls_mode(irn));
450                                 pnres     = pn_ia32_xLoad_res;
451                                 proj_mode = mode_E;
452                         } else {
453                                 panic("cannot turn back address mode for this register class");
454                         }
455
456                         /* copy address mode information to load */
457                         set_ia32_op_type(load, ia32_AddrModeS);
458                         ia32_copy_am_attrs(load, irn);
459
460                         /* insert the load into schedule */
461                         sched_add_before(irn, load);
462
463                         DBG((dbg, LEVEL_3, "irg %+F: build back AM source for node %+F, inserted load %+F\n", cg->irg, irn, load));
464
465                         load_res = new_r_Proj(cg->irg, block, load, proj_mode, pnres);
466                         arch_set_irn_register(cg->arch_env, load_res, out_reg);
467
468                         /* set the new input operand */
469                         set_irn_n(irn, n_ia32_binary_right, load_res);
470                         if(get_irn_mode(irn) == mode_T) {
471                                 const ir_edge_t *edge, *next;
472                                 foreach_out_edge_safe(irn, edge, next) {
473                                         ir_node *node = get_edge_src_irn(edge);
474                                         int      pn   = get_Proj_proj(node);
475                                         if(pn == 0) {
476                                                 exchange(node, irn);
477                                         } else {
478                                                 assert(pn == 1);
479                                                 set_Proj_pred(node, load);
480                                         }
481                                 }
482                                 set_irn_mode(irn, mode_Iu);
483                         }
484
485                         /* this is a normal node now */
486                         set_irn_n(irn, n_ia32_base,  noreg);
487                         set_irn_n(irn, n_ia32_index, noreg);
488                         set_ia32_op_type(irn, ia32_Normal);
489                         break;
490                 }
491         }
492 }
493
494 /**
495  * Block walker: finishes a block
496  */
497 static void ia32_finish_irg_walker(ir_node *block, void *env) {
498         ia32_code_gen_t *cg = env;
499         ir_node *irn, *next;
500
501         /* first: turn back AM source if necessary */
502         for (irn = sched_first(block); ! sched_is_end(irn); irn = next) {
503                 next = sched_next(irn);
504                 fix_am_source(irn, env);
505         }
506
507         for (irn = sched_first(block); ! sched_is_end(irn); irn = next) {
508                 ia32_code_gen_t *cg = env;
509
510                 next = sched_next(irn);
511
512                 /* check if there is a sub which need to be transformed */
513                 if (is_ia32_Sub(irn) || is_ia32_xSub(irn)) {
514                         ia32_transform_sub_to_neg_add(irn, cg);
515                 }
516         }
517
518         /* second: insert copies and finish irg */
519         for (irn = sched_first(block); ! sched_is_end(irn); irn = next) {
520                 next = sched_next(irn);
521                 if (is_ia32_irn(irn)) {
522                         /* some nodes are just a bit less efficient, but need no fixing if the
523                          * should be same requirement is not fulfilled */
524                         if (need_constraint_copy(irn))
525                                 assure_should_be_same_requirements(cg, irn);
526                 }
527         }
528 }
529
530 /**
531  * Block walker: pushes all blocks on a wait queue
532  */
533 static void ia32_push_on_queue_walker(ir_node *block, void *env) {
534         waitq *wq = env;
535         waitq_put(wq, block);
536 }
537
538
539 /**
540  * Add Copy nodes for not fulfilled should_be_equal constraints
541  */
542 void ia32_finish_irg(ir_graph *irg, ia32_code_gen_t *cg) {
543         waitq *wq = new_waitq();
544
545         /* Push the blocks on the waitq because ia32_finish_irg_walker starts more walks ... */
546         irg_block_walk_graph(irg, NULL, ia32_push_on_queue_walker, wq);
547
548         while (! waitq_empty(wq)) {
549                 ir_node *block = waitq_get(wq);
550                 ia32_finish_irg_walker(block, cg);
551         }
552         del_waitq(wq);
553 }
554
555 void ia32_init_finish(void)
556 {
557         FIRM_DBG_REGISTER(dbg, "firm.be.ia32.finish");
558 }