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