remove #ifdef HAVE_CONFIG_Hs
[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_t.h"
38 #include "../besched_t.h"
39 #include "../benode_t.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_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(in1);
75         in2_reg  = arch_get_irn_register(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(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_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_rd_ia32_Neg(dbg, irg, 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_rd_ia32_Add(dbg, irg, 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_rd_ia32_Not(dbg, irg, block, in2);
168                         arch_set_irn_register(not, in2_reg);
169                         sched_add_before(irn, not);
170
171                         stc = new_rd_ia32_Stc(dbg, irg, block);
172                         arch_set_irn_register(stc, &ia32_flags_regs[REG_EFLAGS]);
173                         sched_add_before(irn, stc);
174
175                         adc = new_rd_ia32_Adc(dbg, irg, block, noreg, noreg, nomem, not,
176                                               in1, stc);
177                         arch_set_irn_register(adc, out_reg);
178                         sched_add_before(irn, adc);
179
180                         set_irn_mode(adc, mode_T);
181                         adc_flags = new_r_Proj(irg, block, adc, mode_Iu, pn_ia32_Adc_flags);
182                         arch_set_irn_register(adc_flags, &ia32_flags_regs[REG_EFLAGS]);
183
184                         cmc = new_rd_ia32_Cmc(dbg, irg, block, adc_flags);
185                         arch_set_irn_register(cmc, &ia32_flags_regs[REG_EFLAGS]);
186                         sched_add_before(irn, cmc);
187
188                         exchange(flags_proj, cmc);
189                         if (res_proj != NULL) {
190                                 set_Proj_pred(res_proj, adc);
191                                 set_Proj_proj(res_proj, pn_ia32_Adc_res);
192                         }
193
194                         res = adc;
195                 }
196         }
197
198         SET_IA32_ORIG_NODE(res, ia32_get_old_node_name(cg, irn));
199
200         /* remove the old sub */
201         sched_remove(irn);
202         kill_node(irn);
203
204         DBG_OPT_SUB2NEGADD(irn, res);
205 }
206
207 static INLINE int need_constraint_copy(ir_node *irn)
208 {
209         /* TODO this should be determined from the node specification */
210         switch (get_ia32_irn_opcode(irn)) {
211                 case iro_ia32_IMul: {
212                         /* the 3 operand form of IMul needs no constraint copy */
213                         ir_node *right = get_irn_n(irn, n_ia32_IMul_right);
214                         return !is_ia32_Immediate(right);
215                 }
216
217                 case iro_ia32_Lea:
218                 case iro_ia32_Conv_I2I:
219                 case iro_ia32_Conv_I2I8Bit:
220                 case iro_ia32_CMov:
221                         return 0;
222
223                 default:
224                         return 1;
225         }
226 }
227
228 /**
229  * Returns the index of the "same" register.
230  * On the x86, we should have only one.
231  */
232 static int get_first_same(const arch_register_req_t* req)
233 {
234         const unsigned other = req->other_same;
235         int i;
236
237         for (i = 0; i < 32; ++i) {
238                 if (other & (1U << i)) return i;
239         }
240         assert(! "same position not found");
241         return 32;
242 }
243
244 /**
245  * Insert copies for all ia32 nodes where the should_be_same requirement
246  * is not fulfilled.
247  * Transform Sub into Neg -- Add if IN2 == OUT
248  */
249 static void assure_should_be_same_requirements(ia32_code_gen_t *cg,
250                                                ir_node *node)
251 {
252         ir_graph                   *irg      = cg->irg;
253         const arch_register_req_t **reqs;
254         const arch_register_t      *out_reg, *in_reg;
255         int                         n_res, i;
256         ir_node                    *in_node, *block;
257
258         reqs  = get_ia32_out_req_all(node);
259         n_res = get_ia32_n_res(node);
260         block = get_nodes_block(node);
261
262         /* check all OUT requirements, if there is a should_be_same */
263         for (i = 0; i < n_res; i++) {
264                 int                          i2, arity;
265                 int                          same_pos;
266                 ir_node                     *perm;
267                 ir_node                     *in[2];
268                 ir_node                     *perm_proj0;
269                 ir_node                     *perm_proj1;
270                 ir_node                     *uses_out_reg;
271                 const arch_register_req_t   *req = reqs[i];
272                 const arch_register_class_t *cls;
273                 int                         uses_out_reg_pos;
274
275                 if (!arch_register_req_is(req, should_be_same))
276                         continue;
277
278                 same_pos = get_first_same(req);
279
280                 /* get in and out register */
281                 out_reg  = get_ia32_out_reg(node, i);
282                 in_node  = get_irn_n(node, same_pos);
283                 in_reg   = arch_get_irn_register(in_node);
284
285                 /* requirement already fulfilled? */
286                 if (in_reg == out_reg)
287                         continue;
288                 /* unknowns can be changed to any register we want on emitting */
289                 if (is_unknown_reg(in_reg))
290                         continue;
291                 cls = arch_register_get_class(in_reg);
292                 assert(cls == arch_register_get_class(out_reg));
293
294                 /* check if any other input operands uses the out register */
295                 arity = get_irn_arity(node);
296                 uses_out_reg     = NULL;
297                 uses_out_reg_pos = -1;
298                 for (i2 = 0; i2 < arity; ++i2) {
299                         ir_node               *in     = get_irn_n(node, i2);
300                         const arch_register_t *in_reg;
301
302                         if (!mode_is_data(get_irn_mode(in)))
303                                 continue;
304
305                         in_reg = arch_get_irn_register(in);
306
307                         if (in_reg != out_reg)
308                                 continue;
309
310                         if (uses_out_reg != NULL && in != uses_out_reg) {
311                                 panic("invalid register allocation");
312                         }
313                         uses_out_reg = in;
314                         if (uses_out_reg_pos >= 0)
315                                 uses_out_reg_pos = -1; /* multiple inputs... */
316                         else
317                                 uses_out_reg_pos = i2;
318                 }
319
320                 /* no-one else is using the out reg, we can simply copy it
321                  * (the register can't be live since the operation will override it
322                  *  anyway) */
323                 if (uses_out_reg == NULL) {
324                         ir_node *copy = be_new_Copy(cls, irg, block, in_node);
325                         DBG_OPT_2ADDRCPY(copy);
326
327                         /* destination is the out register */
328                         arch_set_irn_register(copy, out_reg);
329
330                         /* insert copy before the node into the schedule */
331                         sched_add_before(node, copy);
332
333                         /* set copy as in */
334                         set_irn_n(node, same_pos, copy);
335
336                         DBG((dbg, LEVEL_1,
337                                 "created copy %+F for should be same argument at input %d of %+F\n",
338                                 copy, same_pos, node));
339                         continue;
340                 }
341
342                 /* for commutative nodes we can simply swap the left/right */
343                 if (uses_out_reg_pos == n_ia32_binary_right && is_ia32_commutative(node)) {
344                         ia32_swap_left_right(node);
345                         DBG((dbg, LEVEL_1,
346                                 "swapped left/right input of %+F to resolve should be same constraint\n",
347                                 node));
348                         continue;
349                 }
350
351 #ifdef DEBUG_libfirm
352                 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);
353 #endif
354                 /* the out reg is used as node input: we need to permutate our input
355                  * and the other (this is allowed, since the other node can't be live
356                  * after! the operation as we will override the register. */
357                 in[0] = in_node;
358                 in[1] = uses_out_reg;
359                 perm  = be_new_Perm(cls, irg, block, 2, in);
360
361                 perm_proj0 = new_r_Proj(irg, block, perm, get_irn_mode(in[0]), 0);
362                 perm_proj1 = new_r_Proj(irg, block, perm, get_irn_mode(in[1]), 1);
363
364                 arch_set_irn_register(perm_proj0, out_reg);
365                 arch_set_irn_register(perm_proj1, in_reg);
366
367                 sched_add_before(node, perm);
368
369                 DBG((dbg, LEVEL_1,
370                         "created perm %+F for should be same argument at input %d of %+F (need permutate with %+F)\n",
371                         perm, same_pos, node, uses_out_reg));
372
373                 /* use the perm results */
374                 for (i2 = 0; i2 < arity; ++i2) {
375                         ir_node *in = get_irn_n(node, i2);
376
377                         if (in == in_node) {
378                                 set_irn_n(node, i2, perm_proj0);
379                         } else if (in == uses_out_reg) {
380                                 set_irn_n(node, i2, perm_proj1);
381                         }
382                 }
383         }
384 }
385
386 /**
387  * Following Problem:
388  * We have a source address mode node with base or index register equal to
389  * result register and unfulfilled should_be_same requirement. The constraint
390  * handler will insert a copy from the remaining input operand to the result
391  * register -> base or index is broken then.
392  * Solution: Turn back this address mode into explicit Load + Operation.
393  */
394 static void fix_am_source(ir_node *irn)
395 {
396         const arch_register_req_t **reqs;
397         int                         n_res, i;
398
399         /* check only ia32 nodes with source address mode */
400         if (!is_ia32_irn(irn) || get_ia32_op_type(irn) != ia32_AddrModeS)
401                 return;
402         /* only need to fix binary operations */
403         if (get_ia32_am_support(irn) != ia32_am_binary)
404                 return;
405
406         reqs  = get_ia32_out_req_all(irn);
407         n_res = get_ia32_n_res(irn);
408
409         for (i = 0; i < n_res; i++) {
410                 const arch_register_t *out_reg;
411                 int                    same_pos;
412                 ir_node               *same_node;
413                 const arch_register_t *same_reg;
414                 ir_node               *load_res;
415
416                 if (!arch_register_req_is(reqs[i], should_be_same))
417                         continue;
418
419                 /* get in and out register */
420                 out_reg   = get_ia32_out_reg(irn, i);
421                 same_pos  = get_first_same(reqs[i]);
422                 same_node = get_irn_n(irn, same_pos);
423                 same_reg  = arch_get_irn_register(same_node);
424
425                 /* should_be same constraint is fullfilled, nothing to do */
426                 if (out_reg == same_reg)
427                         continue;
428
429                 /* we only need to do something if the out reg is the same as base
430                          or index register */
431                 if (out_reg != arch_get_irn_register(get_irn_n(irn, n_ia32_base)) &&
432                                 out_reg != arch_get_irn_register(get_irn_n(irn, n_ia32_index)))
433                         continue;
434
435                 load_res = turn_back_am(irn);
436                 arch_set_irn_register(load_res, out_reg);
437
438                 DBG((dbg, LEVEL_3,
439                         "irg %+F: build back AM source for node %+F, inserted load %+F\n",
440                         get_irn_irg(irn), irn, get_Proj_pred(load_res)));
441                 break;
442         }
443 }
444
445 /**
446  * Block walker: finishes a block
447  */
448 static void ia32_finish_irg_walker(ir_node *block, void *env)
449 {
450         ia32_code_gen_t *cg = env;
451         ir_node *irn, *next;
452
453         /* first: turn back AM source if necessary */
454         for (irn = sched_first(block); ! sched_is_end(irn); irn = next) {
455                 next = sched_next(irn);
456                 fix_am_source(irn);
457         }
458
459         for (irn = sched_first(block); ! sched_is_end(irn); irn = next) {
460                 ia32_code_gen_t *cg = env;
461
462                 next = sched_next(irn);
463
464                 /* check if there is a sub which need to be transformed */
465                 if (is_ia32_Sub(irn) || is_ia32_xSub(irn)) {
466                         ia32_transform_sub_to_neg_add(irn, cg);
467                 }
468         }
469
470         /* second: insert copies and finish irg */
471         for (irn = sched_first(block); ! sched_is_end(irn); irn = next) {
472                 next = sched_next(irn);
473                 if (is_ia32_irn(irn)) {
474                         /* some nodes are just a bit less efficient, but need no fixing if the
475                          * should be same requirement is not fulfilled */
476                         if (need_constraint_copy(irn))
477                                 assure_should_be_same_requirements(cg, irn);
478                 }
479         }
480 }
481
482 /**
483  * Block walker: pushes all blocks on a wait queue
484  */
485 static void ia32_push_on_queue_walker(ir_node *block, void *env)
486 {
487         waitq *wq = env;
488         waitq_put(wq, block);
489 }
490
491
492 /**
493  * Add Copy nodes for not fulfilled should_be_equal constraints
494  */
495 void ia32_finish_irg(ir_graph *irg, ia32_code_gen_t *cg)
496 {
497         waitq *wq = new_waitq();
498
499         /* Push the blocks on the waitq because ia32_finish_irg_walker starts more walks ... */
500         irg_block_walk_graph(irg, NULL, ia32_push_on_queue_walker, wq);
501
502         while (! waitq_empty(wq)) {
503                 ir_node *block = waitq_get(wq);
504                 ia32_finish_irg_walker(block, cg);
505         }
506         del_waitq(wq);
507 }
508
509 void ia32_init_finish(void)
510 {
511         FIRM_DBG_REGISTER(dbg, "firm.be.ia32.finish");
512 }