ia32: Inline get_ia32_orig_node() into its only caller.
[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  */
25 #include "config.h"
26
27 #include "irnode.h"
28 #include "ircons.h"
29 #include "irgmod.h"
30 #include "irgwalk.h"
31 #include "iredges.h"
32 #include "irprintf.h"
33 #include "pdeq.h"
34 #include "error.h"
35 #include "firmstat_t.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_get_irn_register_out(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         } else {
112                 ir_node *flags_proj = NULL;
113                 ir_node *carry;
114
115                 if (get_irn_mode(irn) == mode_T) {
116                         /* collect the Proj uses */
117                         foreach_out_edge(irn, edge) {
118                                 ir_node *proj = get_edge_src_irn(edge);
119                                 long     pn   = get_Proj_proj(proj);
120                                 if (pn == pn_ia32_flags) {
121                                         assert(flags_proj == NULL);
122                                         flags_proj = proj;
123                                         break;
124                                 }
125                         }
126                 }
127
128                 if (is_ia32_Sbb(irn)) {
129                         /* Feed borrow (in CF) as carry (via CMC) into NOT+ADC. */
130                         carry = get_irn_n(irn, n_ia32_Sbb_eflags);
131                         carry = new_bd_ia32_Cmc(dbgi, block, carry);
132                         goto carry;
133                 } else if (flags_proj != 0) {
134                         /*
135                          * ARG, the above technique does NOT set the flags right.
136                          * So, we must produce the following code:
137                          * t1 = ~b
138                          * t2 = a + ~b + Carry
139                          * Complement Carry
140                          *
141                          * a + -b = a + (~b + 1)  would set the carry flag wrong IFF both a and b are zero.
142                          */
143                         ir_node *cmc;
144                         ir_node *nnot;
145                         ir_node *adc;
146                         ir_node *adc_flags;
147
148                         carry = new_bd_ia32_Stc(dbgi, block);
149
150 carry:
151                         nnot = new_bd_ia32_Not(dbgi, block, in2);
152                         arch_set_irn_register(nnot, in2_reg);
153                         sched_add_before(irn, nnot);
154
155                         arch_set_irn_register(carry, &ia32_registers[REG_EFLAGS]);
156                         sched_add_before(irn, carry);
157
158                         adc = new_bd_ia32_Adc(dbgi, block, noreg, noreg, nomem, nnot, in1, carry);
159                         arch_set_irn_register(adc, out_reg);
160                         set_ia32_commutative(adc);
161
162                         if (flags_proj != NULL) {
163                                 set_irn_mode(adc, mode_T);
164                                 adc_flags = new_r_Proj(adc, mode_Iu, pn_ia32_Adc_flags);
165                                 arch_set_irn_register(adc_flags, &ia32_registers[REG_EFLAGS]);
166
167                                 cmc = new_bd_ia32_Cmc(dbgi, block, adc_flags);
168                                 arch_set_irn_register(cmc, &ia32_registers[REG_EFLAGS]);
169                                 sched_add_after(irn, cmc);
170                                 exchange(flags_proj, cmc);
171                         }
172
173                         res = adc;
174                 } else {
175                         res = new_bd_ia32_Neg(dbgi, block, in2);
176                         arch_set_irn_register(res, in2_reg);
177
178                         /* add to schedule */
179                         sched_add_before(irn, res);
180
181                         /* generate the add */
182                         res = new_bd_ia32_Add(dbgi, block, noreg, noreg, nomem, res, in1);
183                         arch_set_irn_register(res, out_reg);
184                         set_ia32_commutative(res);
185                 }
186         }
187
188         /* exchange the add and the sub */
189         edges_reroute(irn, res);
190         sched_add_before(irn, res);
191
192         set_irn_mode(res, get_irn_mode(irn));
193
194         SET_IA32_ORIG_NODE(res, irn);
195
196         /* remove the old sub */
197         sched_remove(irn);
198         kill_node(irn);
199
200         DBG_OPT_SUB2NEGADD(irn, res);
201 }
202
203 static inline int need_constraint_copy(ir_node *irn)
204 {
205         /* TODO this should be determined from the node specification */
206         switch (get_ia32_irn_opcode(irn)) {
207                 case iro_ia32_IMul: {
208                         /* the 3 operand form of IMul needs no constraint copy */
209                         ir_node *right = get_irn_n(irn, n_ia32_IMul_right);
210                         return !is_ia32_Immediate(right);
211                 }
212
213                 case iro_ia32_Lea:
214                 case iro_ia32_Conv_I2I:
215                 case iro_ia32_Conv_I2I8Bit:
216                 case iro_ia32_CMovcc:
217                 case iro_ia32_Minus64Bit:
218                         return 0;
219
220                 default:
221                         return 1;
222         }
223 }
224
225 /**
226  * Returns the index of the "same" register.
227  * On the x86, we should have only one.
228  */
229 static int get_first_same(const arch_register_req_t* req)
230 {
231         const unsigned other = req->other_same;
232         int i;
233
234         for (i = 0; i < 32; ++i) {
235                 if (other & (1U << i)) return i;
236         }
237         panic("same position not found");
238 }
239
240 /**
241  * Insert copies for all ia32 nodes where the should_be_same requirement
242  * is not fulfilled.
243  * Transform Sub into Neg -- Add if IN2 == OUT
244  */
245 static void assure_should_be_same_requirements(ir_node *node)
246 {
247         const arch_register_t      *out_reg, *in_reg;
248         int                         n_res, i;
249         ir_node                    *in_node, *block;
250
251         n_res = arch_get_irn_n_outs(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                     *uses_out_reg;
259                 const arch_register_req_t   *req = arch_get_irn_register_req_out(node, i);
260                 int                         uses_out_reg_pos;
261
262                 if (!arch_register_req_is(req, should_be_same))
263                         continue;
264
265                 same_pos = get_first_same(req);
266
267                 /* get in and out register */
268                 out_reg = arch_get_irn_register_out(node, i);
269                 in_node = get_irn_n(node, same_pos);
270                 in_reg  = arch_get_irn_register(in_node);
271
272                 /* requirement already fulfilled? */
273                 if (in_reg == out_reg)
274                         continue;
275                 assert(in_reg->reg_class == out_reg->reg_class);
276
277                 /* check if any other input operands uses the out register */
278                 arity = get_irn_arity(node);
279                 uses_out_reg     = NULL;
280                 uses_out_reg_pos = -1;
281                 for (i2 = 0; i2 < arity; ++i2) {
282                         ir_node               *in     = get_irn_n(node, i2);
283                         const arch_register_t *other_in_reg;
284
285                         if (!mode_is_data(get_irn_mode(in)))
286                                 continue;
287
288                         other_in_reg = arch_get_irn_register(in);
289
290                         if (other_in_reg != out_reg)
291                                 continue;
292
293                         if (uses_out_reg != NULL && in != uses_out_reg) {
294                                 panic("invalid register allocation");
295                         }
296                         uses_out_reg = in;
297                         if (uses_out_reg_pos >= 0)
298                                 uses_out_reg_pos = -1; /* multiple inputs... */
299                         else
300                                 uses_out_reg_pos = i2;
301                 }
302
303                 /* no-one else is using the out reg, we can simply copy it
304                  * (the register can't be live since the operation will override it
305                  *  anyway) */
306                 if (uses_out_reg == NULL) {
307                         ir_node *copy = be_new_Copy(block, in_node);
308                         DBG_OPT_2ADDRCPY(copy);
309
310                         /* destination is the out register */
311                         arch_set_irn_register(copy, out_reg);
312
313                         /* insert copy before the node into the schedule */
314                         sched_add_before(node, copy);
315
316                         /* set copy as in */
317                         set_irn_n(node, same_pos, copy);
318
319                         DBG((dbg, LEVEL_1,
320                                 "created copy %+F for should be same argument at input %d of %+F\n",
321                                 copy, same_pos, node));
322                         continue;
323                 }
324
325                 /* for commutative nodes we can simply swap the left/right */
326                 if (uses_out_reg_pos == n_ia32_binary_right && is_ia32_commutative(node)) {
327                         ia32_swap_left_right(node);
328                         DBG((dbg, LEVEL_1,
329                                 "swapped left/right input of %+F to resolve should be same constraint\n",
330                                 node));
331                         continue;
332                 }
333
334                 panic("Unresolved should_be_same constraint");
335         }
336 }
337
338 /**
339  * Following Problem:
340  * We have a source address mode node with base or index register equal to
341  * result register and unfulfilled should_be_same requirement. The constraint
342  * handler will insert a copy from the remaining input operand to the result
343  * register -> base or index is broken then.
344  * Solution: Turn back this address mode into explicit Load + Operation.
345  */
346 static void fix_am_source(ir_node *irn)
347 {
348         int                         n_res, i;
349
350         /* check only ia32 nodes with source address mode */
351         if (!is_ia32_irn(irn) || get_ia32_op_type(irn) != ia32_AddrModeS)
352                 return;
353         /* only need to fix binary operations */
354         if (get_ia32_am_support(irn) != ia32_am_binary)
355                 return;
356
357         n_res = arch_get_irn_n_outs(irn);
358
359         for (i = 0; i < n_res; i++) {
360                 const arch_register_req_t *req = arch_get_irn_register_req_out(irn, i);
361                 const arch_register_t     *out_reg;
362                 int                        same_pos;
363                 ir_node                   *same_node;
364                 const arch_register_t     *same_reg;
365                 ir_node                   *load_res;
366
367                 if (!arch_register_req_is(req, should_be_same))
368                         continue;
369
370                 /* get in and out register */
371                 out_reg   = arch_get_irn_register_out(irn, i);
372                 same_pos  = get_first_same(req);
373                 same_node = get_irn_n(irn, same_pos);
374                 same_reg  = arch_get_irn_register(same_node);
375
376                 /* should_be same constraint is fullfilled, nothing to do */
377                 if (out_reg == same_reg)
378                         continue;
379
380                 /* we only need to do something if the out reg is the same as base
381                          or index register */
382                 if (out_reg != arch_get_irn_register(get_irn_n(irn, n_ia32_base)) &&
383                                 out_reg != arch_get_irn_register(get_irn_n(irn, n_ia32_index)))
384                         continue;
385
386                 load_res = ia32_turn_back_am(irn);
387                 arch_set_irn_register(load_res, out_reg);
388
389                 DBG((dbg, LEVEL_3,
390                         "irg %+F: build back AM source for node %+F, inserted load %+F\n",
391                         get_irn_irg(irn), irn, get_Proj_pred(load_res)));
392                 break;
393         }
394 }
395
396 /**
397  * Block walker: finishes a block
398  */
399 static void ia32_finish_irg_walker(ir_node *block, void *env)
400 {
401         ir_node *irn, *next;
402         (void) env;
403
404         /* first: turn back AM source if necessary */
405         for (irn = sched_first(block); ! sched_is_end(irn); irn = next) {
406                 next = sched_next(irn);
407                 fix_am_source(irn);
408         }
409
410         for (irn = sched_first(block); ! sched_is_end(irn); irn = next) {
411                 next = sched_next(irn);
412
413                 /* check if there is a sub which need to be transformed */
414                 if (is_ia32_Sub(irn) || is_ia32_Sbb(irn) || is_ia32_xSub(irn)) {
415                         ia32_transform_sub_to_neg_add(irn);
416                 }
417         }
418
419         /* second: insert copies and finish irg */
420         for (irn = sched_first(block); ! sched_is_end(irn); irn = next) {
421                 next = sched_next(irn);
422                 if (is_ia32_irn(irn)) {
423                         /* some nodes are just a bit less efficient, but need no fixing if the
424                          * should be same requirement is not fulfilled */
425                         if (need_constraint_copy(irn))
426                                 assure_should_be_same_requirements(irn);
427                 }
428         }
429 }
430
431 /**
432  * Block walker: pushes all blocks on a wait queue
433  */
434 static void ia32_push_on_queue_walker(ir_node *block, void *env)
435 {
436         waitq *wq = (waitq*)env;
437         waitq_put(wq, block);
438 }
439
440
441 /**
442  * Add Copy nodes for not fulfilled should_be_equal constraints
443  */
444 void ia32_finish_irg(ir_graph *irg)
445 {
446         waitq *wq = new_waitq();
447
448         /* Push the blocks on the waitq because ia32_finish_irg_walker starts more walks ... */
449         irg_block_walk_graph(irg, NULL, ia32_push_on_queue_walker, wq);
450
451         while (! waitq_empty(wq)) {
452                 ir_node *block = (ir_node*)waitq_get(wq);
453                 ia32_finish_irg_walker(block, NULL);
454         }
455         del_waitq(wq);
456 }
457
458 void ia32_init_finish(void)
459 {
460         FIRM_DBG_REGISTER(dbg, "firm.be.ia32.finish");
461 }