Extend the NOT+ADC-trick (sic) for SUB to SBB.
[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_common_transform.h"
45 #include "ia32_transform.h"
46 #include "ia32_dbg_stat.h"
47 #include "ia32_optimize.h"
48 #include "gen_ia32_regalloc_if.h"
49
50 DEBUG_ONLY(static firm_dbg_module_t *dbg = NULL;)
51
52 /**
53  * Transforms a Sub or xSub into Neg--Add iff OUT_REG != SRC1_REG && OUT_REG == SRC2_REG.
54  * THIS FUNCTIONS MUST BE CALLED AFTER REGISTER ALLOCATION.
55  */
56 static void ia32_transform_sub_to_neg_add(ir_node *irn)
57 {
58         ir_graph *irg;
59         ir_node *in1, *in2, *noreg, *nomem, *res;
60         ir_node *noreg_fp, *block;
61         dbg_info *dbgi;
62         const arch_register_t *in1_reg, *in2_reg, *out_reg;
63
64         /* fix_am will solve this for AddressMode variants */
65         if (get_ia32_op_type(irn) != ia32_Normal)
66                 return;
67
68         irg      = get_irn_irg(irn);
69         noreg    = ia32_new_NoReg_gp(irg);
70         noreg_fp = ia32_new_NoReg_xmm(irg);
71         nomem    = get_irg_no_mem(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(in1);
75         in2_reg  = arch_get_irn_register(in2);
76         out_reg  = arch_irn_get_register(irn, 0);
77
78         if (out_reg == in1_reg)
79                 return;
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         block = get_nodes_block(irn);
86         dbgi   = get_irn_dbg_info(irn);
87
88         /* generate the neg src2 */
89         if (is_ia32_xSub(irn)) {
90                 int size;
91                 ir_entity *entity;
92                 ir_mode *op_mode = get_ia32_ls_mode(irn);
93
94                 assert(get_irn_mode(irn) != mode_T);
95
96                 res = new_bd_ia32_xXor(dbgi, block, noreg, noreg, nomem, in2, noreg_fp);
97                 size = get_mode_size_bits(op_mode);
98                 entity = ia32_gen_fp_known_const(size == 32 ? ia32_SSIGN : ia32_DSIGN);
99                 set_ia32_am_sc(res, entity);
100                 set_ia32_op_type(res, ia32_AddrModeS);
101                 set_ia32_ls_mode(res, op_mode);
102
103                 arch_set_irn_register(res, in2_reg);
104
105                 /* add to schedule */
106                 sched_add_before(irn, res);
107
108                 /* generate the add */
109                 res = new_bd_ia32_xAdd(dbgi, block, noreg, noreg, nomem, res, in1);
110                 set_ia32_ls_mode(res, get_ia32_ls_mode(irn));
111
112                 /* exchange the add and the sub */
113                 edges_reroute(irn, res);
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                 ir_node         *carry;
121                 const ir_edge_t *edge;
122
123                 if (get_irn_mode(irn) == mode_T) {
124                         /* collect the Proj uses */
125                         assert(pn_ia32_Sub_res   == pn_ia32_Sbb_res);
126                         assert(pn_ia32_Sub_flags == pn_ia32_Sbb_flags);
127                         foreach_out_edge(irn, edge) {
128                                 ir_node *proj = get_edge_src_irn(edge);
129                                 long     pn   = get_Proj_proj(proj);
130                                 if (pn == pn_ia32_Sub_res) {
131                                         assert(res_proj == NULL);
132                                         res_proj = proj;
133                                 } else {
134                                         assert(pn == pn_ia32_Sub_flags);
135                                         assert(flags_proj == NULL);
136                                         flags_proj = proj;
137                                 }
138                         }
139                 }
140
141                 if (is_ia32_Sbb(irn)) {
142                         /* Feed borrow (in CF) as carry (via CMC) into NOT+ADC. */
143                         carry = get_irn_n(irn, n_ia32_Sbb_eflags);
144                         carry = new_bd_ia32_Cmc(dbgi, block, carry);
145                         goto carry;
146                 } else if (flags_proj != 0) {
147                         /*
148                          * ARG, the above technique does NOT set the flags right.
149                          * So, we must produce the following code:
150                          * t1 = ~b
151                          * t2 = a + ~b + Carry
152                          * Complement Carry
153                          *
154                          * a + -b = a + (~b + 1)  would set the carry flag wrong IFF both a and b are zero.
155                          */
156                         ir_node *cmc;
157                         ir_node *nnot;
158                         ir_node *adc;
159                         ir_node *adc_flags;
160
161                         carry = new_bd_ia32_Stc(dbgi, block);
162
163 carry:
164                         nnot = new_bd_ia32_Not(dbgi, block, in2);
165                         arch_set_irn_register(nnot, in2_reg);
166                         sched_add_before(irn, nnot);
167
168                         arch_set_irn_register(carry, &ia32_registers[REG_EFLAGS]);
169                         sched_add_before(irn, carry);
170
171                         adc = new_bd_ia32_Adc(dbgi, block, noreg, noreg, nomem, nnot, in1, carry);
172                         arch_set_irn_register(adc, out_reg);
173                         sched_add_before(irn, adc);
174
175                         set_irn_mode(adc, mode_T);
176                         adc_flags = new_r_Proj(adc, mode_Iu, pn_ia32_Adc_flags);
177                         arch_set_irn_register(adc_flags, &ia32_registers[REG_EFLAGS]);
178
179                         if (flags_proj != NULL) {
180                                 cmc = new_bd_ia32_Cmc(dbgi, block, adc_flags);
181                                 arch_set_irn_register(cmc, &ia32_registers[REG_EFLAGS]);
182                                 sched_add_before(irn, cmc);
183                                 exchange(flags_proj, cmc);
184                         }
185
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                 } else {
193                         res = new_bd_ia32_Neg(dbgi, block, in2);
194                         arch_set_irn_register(res, in2_reg);
195
196                         /* add to schedule */
197                         sched_add_before(irn, res);
198
199                         /* generate the add */
200                         res = new_bd_ia32_Add(dbgi, block, noreg, noreg, nomem, res, in1);
201                         arch_set_irn_register(res, out_reg);
202                         set_ia32_commutative(res);
203
204                         /* exchange the add and the sub */
205                         edges_reroute(irn, res);
206
207                         /* add to schedule */
208                         sched_add_before(irn, res);
209                 }
210         }
211
212         set_irn_mode(res, get_irn_mode(irn));
213
214         SET_IA32_ORIG_NODE(res, irn);
215
216         /* remove the old sub */
217         sched_remove(irn);
218         kill_node(irn);
219
220         DBG_OPT_SUB2NEGADD(irn, res);
221 }
222
223 static inline int need_constraint_copy(ir_node *irn)
224 {
225         /* TODO this should be determined from the node specification */
226         switch (get_ia32_irn_opcode(irn)) {
227                 case iro_ia32_IMul: {
228                         /* the 3 operand form of IMul needs no constraint copy */
229                         ir_node *right = get_irn_n(irn, n_ia32_IMul_right);
230                         return !is_ia32_Immediate(right);
231                 }
232
233                 case iro_ia32_Lea:
234                 case iro_ia32_Conv_I2I:
235                 case iro_ia32_Conv_I2I8Bit:
236                 case iro_ia32_CMovcc:
237                         return 0;
238
239                 default:
240                         return 1;
241         }
242 }
243
244 /**
245  * Returns the index of the "same" register.
246  * On the x86, we should have only one.
247  */
248 static int get_first_same(const arch_register_req_t* req)
249 {
250         const unsigned other = req->other_same;
251         int i;
252
253         for (i = 0; i < 32; ++i) {
254                 if (other & (1U << i)) return i;
255         }
256         panic("same position not found");
257 }
258
259 /**
260  * Insert copies for all ia32 nodes where the should_be_same requirement
261  * is not fulfilled.
262  * Transform Sub into Neg -- Add if IN2 == OUT
263  */
264 static void assure_should_be_same_requirements(ir_node *node)
265 {
266         const arch_register_t      *out_reg, *in_reg;
267         int                         n_res, i;
268         ir_node                    *in_node, *block;
269
270         n_res = arch_irn_get_n_outs(node);
271         block = get_nodes_block(node);
272
273         /* check all OUT requirements, if there is a should_be_same */
274         for (i = 0; i < n_res; i++) {
275                 int                          i2, arity;
276                 int                          same_pos;
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                 cls = arch_register_get_class(in_reg);
296                 assert(cls == arch_register_get_class(out_reg));
297
298                 /* check if any other input operands uses the out register */
299                 arity = get_irn_arity(node);
300                 uses_out_reg     = NULL;
301                 uses_out_reg_pos = -1;
302                 for (i2 = 0; i2 < arity; ++i2) {
303                         ir_node               *in     = get_irn_n(node, i2);
304                         const arch_register_t *other_in_reg;
305
306                         if (!mode_is_data(get_irn_mode(in)))
307                                 continue;
308
309                         other_in_reg = arch_get_irn_register(in);
310
311                         if (other_in_reg != out_reg)
312                                 continue;
313
314                         if (uses_out_reg != NULL && in != uses_out_reg) {
315                                 panic("invalid register allocation");
316                         }
317                         uses_out_reg = in;
318                         if (uses_out_reg_pos >= 0)
319                                 uses_out_reg_pos = -1; /* multiple inputs... */
320                         else
321                                 uses_out_reg_pos = i2;
322                 }
323
324                 /* no-one else is using the out reg, we can simply copy it
325                  * (the register can't be live since the operation will override it
326                  *  anyway) */
327                 if (uses_out_reg == NULL) {
328                         ir_node *copy = be_new_Copy(cls, block, in_node);
329                         DBG_OPT_2ADDRCPY(copy);
330
331                         /* destination is the out register */
332                         arch_set_irn_register(copy, out_reg);
333
334                         /* insert copy before the node into the schedule */
335                         sched_add_before(node, copy);
336
337                         /* set copy as in */
338                         set_irn_n(node, same_pos, copy);
339
340                         DBG((dbg, LEVEL_1,
341                                 "created copy %+F for should be same argument at input %d of %+F\n",
342                                 copy, same_pos, node));
343                         continue;
344                 }
345
346                 /* for commutative nodes we can simply swap the left/right */
347                 if (uses_out_reg_pos == n_ia32_binary_right && is_ia32_commutative(node)) {
348                         ia32_swap_left_right(node);
349                         DBG((dbg, LEVEL_1,
350                                 "swapped left/right input of %+F to resolve should be same constraint\n",
351                                 node));
352                         continue;
353                 }
354
355                 panic("Unresolved should_be_same constraint");
356         }
357 }
358
359 /**
360  * Following Problem:
361  * We have a source address mode node with base or index register equal to
362  * result register and unfulfilled should_be_same requirement. The constraint
363  * handler will insert a copy from the remaining input operand to the result
364  * register -> base or index is broken then.
365  * Solution: Turn back this address mode into explicit Load + Operation.
366  */
367 static void fix_am_source(ir_node *irn)
368 {
369         int                         n_res, i;
370
371         /* check only ia32 nodes with source address mode */
372         if (!is_ia32_irn(irn) || get_ia32_op_type(irn) != ia32_AddrModeS)
373                 return;
374         /* only need to fix binary operations */
375         if (get_ia32_am_support(irn) != ia32_am_binary)
376                 return;
377
378         n_res = arch_irn_get_n_outs(irn);
379
380         for (i = 0; i < n_res; i++) {
381                 const arch_register_req_t *req = arch_get_out_register_req(irn, i);
382                 const arch_register_t     *out_reg;
383                 int                        same_pos;
384                 ir_node                   *same_node;
385                 const arch_register_t     *same_reg;
386                 ir_node                   *load_res;
387
388                 if (!arch_register_req_is(req, should_be_same))
389                         continue;
390
391                 /* get in and out register */
392                 out_reg   = arch_irn_get_register(irn, i);
393                 same_pos  = get_first_same(req);
394                 same_node = get_irn_n(irn, same_pos);
395                 same_reg  = arch_get_irn_register(same_node);
396
397                 /* should_be same constraint is fullfilled, nothing to do */
398                 if (out_reg == same_reg)
399                         continue;
400
401                 /* we only need to do something if the out reg is the same as base
402                          or index register */
403                 if (out_reg != arch_get_irn_register(get_irn_n(irn, n_ia32_base)) &&
404                                 out_reg != arch_get_irn_register(get_irn_n(irn, n_ia32_index)))
405                         continue;
406
407                 load_res = ia32_turn_back_am(irn);
408                 arch_set_irn_register(load_res, out_reg);
409
410                 DBG((dbg, LEVEL_3,
411                         "irg %+F: build back AM source for node %+F, inserted load %+F\n",
412                         get_irn_irg(irn), irn, get_Proj_pred(load_res)));
413                 break;
414         }
415 }
416
417 /**
418  * Block walker: finishes a block
419  */
420 static void ia32_finish_irg_walker(ir_node *block, void *env)
421 {
422         ir_node *irn, *next;
423         (void) env;
424
425         /* first: turn back AM source if necessary */
426         for (irn = sched_first(block); ! sched_is_end(irn); irn = next) {
427                 next = sched_next(irn);
428                 fix_am_source(irn);
429         }
430
431         for (irn = sched_first(block); ! sched_is_end(irn); irn = next) {
432                 next = sched_next(irn);
433
434                 /* check if there is a sub which need to be transformed */
435                 if (is_ia32_Sub(irn) || is_ia32_Sbb(irn) || is_ia32_xSub(irn)) {
436                         ia32_transform_sub_to_neg_add(irn);
437                 }
438         }
439
440         /* second: insert copies and finish irg */
441         for (irn = sched_first(block); ! sched_is_end(irn); irn = next) {
442                 next = sched_next(irn);
443                 if (is_ia32_irn(irn)) {
444                         /* some nodes are just a bit less efficient, but need no fixing if the
445                          * should be same requirement is not fulfilled */
446                         if (need_constraint_copy(irn))
447                                 assure_should_be_same_requirements(irn);
448                 }
449         }
450 }
451
452 /**
453  * Block walker: pushes all blocks on a wait queue
454  */
455 static void ia32_push_on_queue_walker(ir_node *block, void *env)
456 {
457         waitq *wq = (waitq*)env;
458         waitq_put(wq, block);
459 }
460
461
462 /**
463  * Add Copy nodes for not fulfilled should_be_equal constraints
464  */
465 void ia32_finish_irg(ir_graph *irg)
466 {
467         waitq *wq = new_waitq();
468
469         /* Push the blocks on the waitq because ia32_finish_irg_walker starts more walks ... */
470         irg_block_walk_graph(irg, NULL, ia32_push_on_queue_walker, wq);
471
472         while (! waitq_empty(wq)) {
473                 ir_node *block = (ir_node*)waitq_get(wq);
474                 ia32_finish_irg_walker(block, NULL);
475         }
476         del_waitq(wq);
477 }
478
479 void ia32_init_finish(void)
480 {
481         FIRM_DBG_REGISTER(dbg, "firm.be.ia32.finish");
482 }