09858aa536604a8548584bc9e84c0b2d5103bc9c
[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 #include "config.h"
27
28 #include "irnode.h"
29 #include "ircons.h"
30 #include "irgmod.h"
31 #include "irgwalk.h"
32 #include "iredges.h"
33 #include "irprintf.h"
34 #include "pdeq.h"
35 #include "error.h"
36
37 #include "../bearch.h"
38 #include "../besched.h"
39 #include "../benode.h"
40
41 #include "bearch_ia32_t.h"
42 #include "ia32_finish.h"
43 #include "ia32_new_nodes.h"
44 #include "ia32_map_regs.h"
45 #include "ia32_common_transform.h"
46 #include "ia32_transform.h"
47 #include "ia32_dbg_stat.h"
48 #include "ia32_optimize.h"
49 #include "gen_ia32_regalloc_if.h"
50
51 DEBUG_ONLY(static firm_dbg_module_t *dbg = NULL;)
52
53 /**
54  * Transforms a Sub or xSub into Neg--Add iff OUT_REG == SRC2_REG.
55  * THIS FUNCTIONS MUST BE CALLED AFTER REGISTER ALLOCATION.
56  */
57 static void ia32_transform_sub_to_neg_add(ir_node *irn, ia32_code_gen_t *cg)
58 {
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_NoMem();
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(in1);
75         in2_reg  = arch_get_irn_register(in2);
76         out_reg  = arch_irn_get_register(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_bd_ia32_xXor(dbg, 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(res, in2_reg);
103
104                 /* add to schedule */
105                 sched_add_before(irn, res);
106
107                 /* generate the add */
108                 res = new_bd_ia32_xAdd(dbg, 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_bd_ia32_Neg(dbg, block, in2);
139                         arch_set_irn_register(res, in2_reg);
140
141                         /* add to schedule */
142                         sched_add_before(irn, res);
143
144                         /* generate the add */
145                         res = new_bd_ia32_Add(dbg, block, noreg, noreg, nomem, res, in1);
146                         arch_set_irn_register(res, out_reg);
147                         set_ia32_commutative(res);
148
149                         /* exchange the add and the sub */
150                         edges_reroute(irn, res, irg);
151
152                         /* add to schedule */
153                         sched_add_before(irn, res);
154                 } else {
155                         ir_node *stc, *cmc, *not, *adc;
156                         ir_node *adc_flags;
157
158                         /*
159                          * ARG, the above technique does NOT set the flags right.
160                          * So, we must produce the following code:
161                          * t1 = ~b
162                          * t2 = a + ~b + Carry
163                          * Complement Carry
164                          *
165                          * a + -b = a + (~b + 1)  would set the carry flag IF a == b ...
166                          */
167                         not = new_bd_ia32_Not(dbg, block, in2);
168                         arch_set_irn_register(not, in2_reg);
169                         sched_add_before(irn, not);
170
171                         stc = new_bd_ia32_Stc(dbg, block);
172                         arch_set_irn_register(stc, &ia32_flags_regs[REG_EFLAGS]);
173                         sched_add_before(irn, stc);
174
175                         adc = new_bd_ia32_Adc(dbg, block, noreg, noreg, nomem, not, in1, stc);
176                         arch_set_irn_register(adc, out_reg);
177                         sched_add_before(irn, adc);
178
179                         set_irn_mode(adc, mode_T);
180                         adc_flags = new_r_Proj(adc, mode_Iu, pn_ia32_Adc_flags);
181                         arch_set_irn_register(adc_flags, &ia32_flags_regs[REG_EFLAGS]);
182
183                         cmc = new_bd_ia32_Cmc(dbg, block, adc_flags);
184                         arch_set_irn_register(cmc, &ia32_flags_regs[REG_EFLAGS]);
185                         sched_add_before(irn, cmc);
186
187                         exchange(flags_proj, cmc);
188                         if (res_proj != NULL) {
189                                 set_Proj_pred(res_proj, adc);
190                                 set_Proj_proj(res_proj, pn_ia32_Adc_res);
191                         }
192
193                         res = adc;
194                 }
195         }
196
197         set_irn_mode(res, get_irn_mode(irn));
198
199         SET_IA32_ORIG_NODE(res, irn);
200
201         /* remove the old sub */
202         sched_remove(irn);
203         kill_node(irn);
204
205         DBG_OPT_SUB2NEGADD(irn, res);
206 }
207
208 static inline int need_constraint_copy(ir_node *irn)
209 {
210         /* TODO this should be determined from the node specification */
211         switch (get_ia32_irn_opcode(irn)) {
212                 case iro_ia32_IMul: {
213                         /* the 3 operand form of IMul needs no constraint copy */
214                         ir_node *right = get_irn_n(irn, n_ia32_IMul_right);
215                         return !is_ia32_Immediate(right);
216                 }
217
218                 case iro_ia32_Lea:
219                 case iro_ia32_Conv_I2I:
220                 case iro_ia32_Conv_I2I8Bit:
221                 case iro_ia32_CMovcc:
222                         return 0;
223
224                 default:
225                         return 1;
226         }
227 }
228
229 /**
230  * Returns the index of the "same" register.
231  * On the x86, we should have only one.
232  */
233 static int get_first_same(const arch_register_req_t* req)
234 {
235         const unsigned other = req->other_same;
236         int i;
237
238         for (i = 0; i < 32; ++i) {
239                 if (other & (1U << i)) return i;
240         }
241         assert(! "same position not found");
242         return 32;
243 }
244
245 static inline bool is_unknown_reg(const arch_register_t *reg)
246 {
247         if (reg == &ia32_gp_regs[REG_GP_UKNWN]
248                         || reg == &ia32_xmm_regs[REG_XMM_UKNWN]
249                         || reg == &ia32_vfp_regs[REG_VFP_UKNWN])
250                 return true;
251
252         return false;
253 }
254
255 /**
256  * Insert copies for all ia32 nodes where the should_be_same requirement
257  * is not fulfilled.
258  * Transform Sub into Neg -- Add if IN2 == OUT
259  */
260 static void assure_should_be_same_requirements(ir_node *node)
261 {
262         const arch_register_t      *out_reg, *in_reg;
263         int                         n_res, i;
264         ir_node                    *in_node, *block;
265
266         n_res = arch_irn_get_n_outs(node);
267         block = get_nodes_block(node);
268
269         /* check all OUT requirements, if there is a should_be_same */
270         for (i = 0; i < n_res; i++) {
271                 int                          i2, arity;
272                 int                          same_pos;
273                 ir_node                     *perm;
274                 ir_node                     *in[2];
275                 ir_node                     *perm_proj0;
276                 ir_node                     *perm_proj1;
277                 ir_node                     *uses_out_reg;
278                 const arch_register_req_t   *req = arch_get_out_register_req(node, i);
279                 const arch_register_class_t *cls;
280                 int                         uses_out_reg_pos;
281
282                 if (!arch_register_req_is(req, should_be_same))
283                         continue;
284
285                 same_pos = get_first_same(req);
286
287                 /* get in and out register */
288                 out_reg = arch_irn_get_register(node, i);
289                 in_node = get_irn_n(node, same_pos);
290                 in_reg  = arch_get_irn_register(in_node);
291
292                 /* requirement already fulfilled? */
293                 if (in_reg == out_reg)
294                         continue;
295                 /* unknowns can be changed to any register we want on emitting */
296                 if (is_unknown_reg(in_reg))
297                         continue;
298                 cls = arch_register_get_class(in_reg);
299                 assert(cls == arch_register_get_class(out_reg));
300
301                 /* check if any other input operands uses the out register */
302                 arity = get_irn_arity(node);
303                 uses_out_reg     = NULL;
304                 uses_out_reg_pos = -1;
305                 for (i2 = 0; i2 < arity; ++i2) {
306                         ir_node               *in     = get_irn_n(node, i2);
307                         const arch_register_t *in_reg;
308
309                         if (!mode_is_data(get_irn_mode(in)))
310                                 continue;
311
312                         in_reg = arch_get_irn_register(in);
313
314                         if (in_reg != out_reg)
315                                 continue;
316
317                         if (uses_out_reg != NULL && in != uses_out_reg) {
318                                 panic("invalid register allocation");
319                         }
320                         uses_out_reg = in;
321                         if (uses_out_reg_pos >= 0)
322                                 uses_out_reg_pos = -1; /* multiple inputs... */
323                         else
324                                 uses_out_reg_pos = i2;
325                 }
326
327                 /* no-one else is using the out reg, we can simply copy it
328                  * (the register can't be live since the operation will override it
329                  *  anyway) */
330                 if (uses_out_reg == NULL) {
331                         ir_node *copy = be_new_Copy(cls, block, in_node);
332                         DBG_OPT_2ADDRCPY(copy);
333
334                         /* destination is the out register */
335                         arch_set_irn_register(copy, out_reg);
336
337                         /* insert copy before the node into the schedule */
338                         sched_add_before(node, copy);
339
340                         /* set copy as in */
341                         set_irn_n(node, same_pos, copy);
342
343                         DBG((dbg, LEVEL_1,
344                                 "created copy %+F for should be same argument at input %d of %+F\n",
345                                 copy, same_pos, node));
346                         continue;
347                 }
348
349                 /* for commutative nodes we can simply swap the left/right */
350                 if (uses_out_reg_pos == n_ia32_binary_right && is_ia32_commutative(node)) {
351                         ia32_swap_left_right(node);
352                         DBG((dbg, LEVEL_1,
353                                 "swapped left/right input of %+F to resolve should be same constraint\n",
354                                 node));
355                         continue;
356                 }
357
358 #ifdef DEBUG_libfirm
359                 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);
360 #endif
361                 /* the out reg is used as node input: we need to permutate our input
362                  * and the other (this is allowed, since the other node can't be live
363                  * after! the operation as we will override the register. */
364                 in[0] = in_node;
365                 in[1] = uses_out_reg;
366                 perm  = be_new_Perm(cls, block, 2, in);
367
368                 perm_proj0 = new_r_Proj(perm, get_irn_mode(in[0]), 0);
369                 perm_proj1 = new_r_Proj(perm, get_irn_mode(in[1]), 1);
370
371                 arch_set_irn_register(perm_proj0, out_reg);
372                 arch_set_irn_register(perm_proj1, in_reg);
373
374                 sched_add_before(node, perm);
375
376                 DBG((dbg, LEVEL_1,
377                         "created perm %+F for should be same argument at input %d of %+F (need permutate with %+F)\n",
378                         perm, same_pos, node, uses_out_reg));
379
380                 /* use the perm results */
381                 for (i2 = 0; i2 < arity; ++i2) {
382                         ir_node *in = get_irn_n(node, i2);
383
384                         if (in == in_node) {
385                                 set_irn_n(node, i2, perm_proj0);
386                         } else if (in == uses_out_reg) {
387                                 set_irn_n(node, i2, perm_proj1);
388                         }
389                 }
390         }
391 }
392
393 /**
394  * Following Problem:
395  * We have a source address mode node with base or index register equal to
396  * result register and unfulfilled should_be_same requirement. The constraint
397  * handler will insert a copy from the remaining input operand to the result
398  * register -> base or index is broken then.
399  * Solution: Turn back this address mode into explicit Load + Operation.
400  */
401 static void fix_am_source(ir_node *irn)
402 {
403         int                         n_res, i;
404
405         /* check only ia32 nodes with source address mode */
406         if (!is_ia32_irn(irn) || get_ia32_op_type(irn) != ia32_AddrModeS)
407                 return;
408         /* only need to fix binary operations */
409         if (get_ia32_am_support(irn) != ia32_am_binary)
410                 return;
411
412         n_res = arch_irn_get_n_outs(irn);
413
414         for (i = 0; i < n_res; i++) {
415                 const arch_register_req_t *req = arch_get_out_register_req(irn, i);
416                 const arch_register_t     *out_reg;
417                 int                        same_pos;
418                 ir_node                   *same_node;
419                 const arch_register_t     *same_reg;
420                 ir_node                   *load_res;
421
422                 if (!arch_register_req_is(req, should_be_same))
423                         continue;
424
425                 /* get in and out register */
426                 out_reg   = arch_irn_get_register(irn, i);
427                 same_pos  = get_first_same(req);
428                 same_node = get_irn_n(irn, same_pos);
429                 same_reg  = arch_get_irn_register(same_node);
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 != arch_get_irn_register(get_irn_n(irn, n_ia32_base)) &&
438                                 out_reg != arch_get_irn_register(get_irn_n(irn, n_ia32_index)))
439                         continue;
440
441                 load_res = turn_back_am(irn);
442                 arch_set_irn_register(load_res, out_reg);
443
444                 DBG((dbg, LEVEL_3,
445                         "irg %+F: build back AM source for node %+F, inserted load %+F\n",
446                         get_irn_irg(irn), irn, get_Proj_pred(load_res)));
447                 break;
448         }
449 }
450
451 /**
452  * Block walker: finishes a block
453  */
454 static void ia32_finish_irg_walker(ir_node *block, void *env)
455 {
456         ia32_code_gen_t *cg = env;
457         ir_node *irn, *next;
458
459         /* first: turn back AM source if necessary */
460         for (irn = sched_first(block); ! sched_is_end(irn); irn = next) {
461                 next = sched_next(irn);
462                 fix_am_source(irn);
463         }
464
465         for (irn = sched_first(block); ! sched_is_end(irn); irn = next) {
466                 next = sched_next(irn);
467
468                 /* check if there is a sub which need to be transformed */
469                 if (is_ia32_Sub(irn) || is_ia32_xSub(irn)) {
470                         ia32_transform_sub_to_neg_add(irn, cg);
471                 }
472         }
473
474         /* second: insert copies and finish irg */
475         for (irn = sched_first(block); ! sched_is_end(irn); irn = next) {
476                 next = sched_next(irn);
477                 if (is_ia32_irn(irn)) {
478                         /* some nodes are just a bit less efficient, but need no fixing if the
479                          * should be same requirement is not fulfilled */
480                         if (need_constraint_copy(irn))
481                                 assure_should_be_same_requirements(irn);
482                 }
483         }
484 }
485
486 /**
487  * Block walker: pushes all blocks on a wait queue
488  */
489 static void ia32_push_on_queue_walker(ir_node *block, void *env)
490 {
491         waitq *wq = env;
492         waitq_put(wq, block);
493 }
494
495
496 /**
497  * Add Copy nodes for not fulfilled should_be_equal constraints
498  */
499 void ia32_finish_irg(ir_graph *irg, ia32_code_gen_t *cg)
500 {
501         waitq *wq = new_waitq();
502
503         /* Push the blocks on the waitq because ia32_finish_irg_walker starts more walks ... */
504         irg_block_walk_graph(irg, NULL, ia32_push_on_queue_walker, wq);
505
506         while (! waitq_empty(wq)) {
507                 ir_node *block = waitq_get(wq);
508                 ia32_finish_irg_walker(block, cg);
509         }
510         del_waitq(wq);
511 }
512
513 void ia32_init_finish(void)
514 {
515         FIRM_DBG_REGISTER(dbg, "firm.be.ia32.finish");
516 }