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