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