- fix a conceptual bug in peephole, we need a callback before and after
[libfirm] / ir / be / ia32 / ia32_finish.c
1 /*
2  * Copyright (C) 1995-2007 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 #ifdef HAVE_CONFIG_H
27 #include "config.h"
28 #endif
29
30 #include "irnode.h"
31 #include "ircons.h"
32 #include "irgmod.h"
33 #include "irgwalk.h"
34 #include "iredges.h"
35 #include "irprintf.h"
36 #include "pdeq.h"
37 #include "error.h"
38
39 #include "../bearch_t.h"
40 #include "../besched_t.h"
41 #include "../benode_t.h"
42
43 #include "bearch_ia32_t.h"
44 #include "ia32_finish.h"
45 #include "ia32_new_nodes.h"
46 #include "ia32_map_regs.h"
47 #include "ia32_transform.h"
48 #include "ia32_dbg_stat.h"
49 #include "ia32_optimize.h"
50 #include "gen_ia32_regalloc_if.h"
51
52 DEBUG_ONLY(static firm_dbg_module_t *dbg = NULL;)
53
54 /**
55  * Transforms a Sub or xSub into Neg--Add iff OUT_REG == SRC2_REG.
56  * THIS FUNCTIONS MUST BE CALLED AFTER REGISTER ALLOCATION.
57  */
58 static void ia32_transform_sub_to_neg_add(ir_node *irn, ia32_code_gen_t *cg) {
59         ir_graph *irg;
60         ir_node *in1, *in2, *noreg, *nomem, *res;
61         ir_node *noreg_fp, *block;
62         ir_mode *mode = get_irn_mode(irn);
63         dbg_info *dbg = get_irn_dbg_info(irn);
64         const arch_register_t *in1_reg, *in2_reg, *out_reg, **slots;
65         int i, arity;
66
67         /* Return if not a Sub or xSub */
68         if (!is_ia32_Sub(irn) && !is_ia32_xSub(irn))
69                 return;
70         /* fix_am will solve this for AddressMode variants */
71         if(get_ia32_op_type(irn) != ia32_Normal)
72                 return;
73
74         noreg   = ia32_new_NoReg_gp(cg);
75         noreg_fp = ia32_new_NoReg_fp(cg);
76         nomem   = new_rd_NoMem(cg->irg);
77         in1     = get_irn_n(irn, n_ia32_binary_left);
78         in2     = get_irn_n(irn, n_ia32_binary_right);
79         in1_reg = arch_get_irn_register(cg->arch_env, in1);
80         in2_reg = arch_get_irn_register(cg->arch_env, in2);
81         out_reg = get_ia32_out_reg(irn, 0);
82
83         assert(get_irn_mode(irn) != mode_T);
84
85         irg     = cg->irg;
86         block   = get_nodes_block(irn);
87
88         /* in case of sub and OUT == SRC2 we can transform the sequence into neg src2 -- add */
89         if (out_reg != in2_reg)
90                 return;
91
92         /* generate the neg src2 */
93         if(mode_is_float(mode)) {
94                 int size;
95                 ir_entity *entity;
96                 ir_mode *op_mode = get_ia32_ls_mode(irn);
97
98                 res = new_rd_ia32_xXor(dbg, irg, block, noreg, noreg, nomem, in2, noreg_fp);
99                 size = get_mode_size_bits(op_mode);
100                 entity = ia32_gen_fp_known_const(size == 32 ? ia32_SSIGN : ia32_DSIGN);
101                 set_ia32_am_sc(res, entity);
102                 set_ia32_op_type(res, ia32_AddrModeS);
103                 set_ia32_ls_mode(res, op_mode);
104         } else {
105                 res = new_rd_ia32_Neg(dbg, irg, block, in2);
106         }
107         arch_set_irn_register(cg->arch_env, res, in2_reg);
108
109         /* add to schedule */
110         sched_add_before(irn, res);
111
112         /* generate the add */
113         if (mode_is_float(mode)) {
114                 res = new_rd_ia32_xAdd(dbg, irg, block, noreg, noreg, nomem, res, in1);
115                 set_ia32_am_support(res, ia32_am_Source, ia32_am_binary);
116                 set_ia32_ls_mode(res, get_ia32_ls_mode(irn));
117         } else {
118                 res = new_rd_ia32_Add(dbg, irg, block, noreg, noreg, nomem, res, in1);
119                 set_ia32_am_support(res, ia32_am_Full, ia32_am_binary);
120                 set_ia32_commutative(res);
121         }
122
123         SET_IA32_ORIG_NODE(res, ia32_get_old_node_name(cg, irn));
124         /* copy register */
125         slots    = get_ia32_slots(res);
126         slots[0] = in2_reg;
127
128         /* exchange the add and the sub */
129         edges_reroute(irn, res, irg);
130
131         /* add to schedule */
132         sched_add_before(irn, res);
133
134         /* remove the old sub */
135         sched_remove(irn);
136         arity = get_irn_arity(irn);
137         for(i = 0; i < arity; ++i) {
138                 set_irn_n(irn, i, new_Bad());
139         }
140
141         DBG_OPT_SUB2NEGADD(irn, res);
142 }
143
144 static INLINE int need_constraint_copy(ir_node *irn) {
145         /* the 3 operand form of IMul needs no constraint copy */
146         if(is_ia32_IMul(irn)) {
147                 ir_node *right = get_irn_n(irn, n_ia32_IMul_right);
148                 if(is_ia32_Immediate(right))
149                         return 0;
150         }
151
152         return  ! is_ia32_Lea(irn)      &&
153                 ! is_ia32_Conv_I2I(irn)     &&
154                 ! is_ia32_Conv_I2I8Bit(irn) &&
155                 ! is_ia32_CMov(irn);
156 }
157
158 /**
159  * Insert copies for all ia32 nodes where the should_be_same requirement
160  * is not fulfilled.
161  * Transform Sub into Neg -- Add if IN2 == OUT
162  */
163 static void assure_should_be_same_requirements(ia32_code_gen_t *cg,
164                                                ir_node *node)
165 {
166         ir_graph                   *irg      = cg->irg;
167         const arch_env_t           *arch_env = cg->arch_env;
168         const arch_register_req_t **reqs;
169         const arch_register_t      *out_reg, *in_reg;
170         int                         n_res, i;
171         ir_node                    *in_node, *block;
172         ia32_op_type_t              op_tp;
173
174         if(!is_ia32_irn(node))
175                 return;
176
177         /* some nodes are just a bit less efficient, but need no fixing if the
178          * should be same requirement is not fulfilled */
179         if(!need_constraint_copy(node))
180                 return;
181
182         op_tp = get_ia32_op_type(node);
183         reqs  = get_ia32_out_req_all(node);
184         n_res = get_ia32_n_res(node);
185         block = get_nodes_block(node);
186
187         /* check all OUT requirements, if there is a should_be_same */
188         for (i = 0; i < n_res; i++) {
189                 int                          i2, arity;
190                 int                          same_pos;
191                 ir_node                     *perm;
192                 ir_node                     *in[2];
193                 ir_node                     *perm_proj0;
194                 ir_node                     *perm_proj1;
195                 ir_node                     *uses_out_reg;
196                 const arch_register_req_t   *req = reqs[i];
197                 const arch_register_class_t *class;
198                 int                         uses_out_reg_pos;
199
200                 if (!arch_register_req_is(req, should_be_same))
201                         continue;
202
203                 same_pos = req->other_same[0];
204
205                 /* get in and out register */
206                 out_reg  = get_ia32_out_reg(node, i);
207                 in_node  = get_irn_n(node, same_pos);
208                 in_reg   = arch_get_irn_register(arch_env, in_node);
209
210                 /* requirement already fulfilled? */
211                 if (in_reg == out_reg)
212                         continue;
213                 /* unknowns can be changed to any register we want on emitting */
214                 if (is_unknown_reg(in_reg))
215                         continue;
216                 class = arch_register_get_class(in_reg);
217                 assert(class == arch_register_get_class(out_reg));
218
219                 /* check if any other input operands uses the out register */
220                 arity = get_irn_arity(node);
221                 uses_out_reg     = NULL;
222                 uses_out_reg_pos = -1;
223                 for(i2 = 0; i2 < arity; ++i2) {
224                         ir_node               *in     = get_irn_n(node, i2);
225                         const arch_register_t *in_reg;
226
227                         if(!mode_is_data(get_irn_mode(in)))
228                                 continue;
229
230                         in_reg = arch_get_irn_register(arch_env, in);
231
232                         if(in_reg != out_reg)
233                                 continue;
234
235                         if(uses_out_reg != NULL && in != uses_out_reg) {
236                                 panic("invalid register allocation");
237                         }
238                         uses_out_reg = in;
239                         if(uses_out_reg_pos >= 0)
240                                 uses_out_reg_pos = -1; /* multiple inputs... */
241                         else
242                                 uses_out_reg_pos = i2;
243                 }
244
245                 /* no-one else is using the out reg, we can simply copy it
246                  * (the register can't be live since the operation will override it
247                  *  anyway) */
248                 if(uses_out_reg == NULL) {
249                         ir_node *copy = be_new_Copy(class, irg, block, in_node);
250                         DBG_OPT_2ADDRCPY(copy);
251
252                         /* destination is the out register */
253                         arch_set_irn_register(arch_env, copy, out_reg);
254
255                         /* insert copy before the node into the schedule */
256                         sched_add_before(node, copy);
257
258                         /* set copy as in */
259                         set_irn_n(node, same_pos, copy);
260
261                         DBG((dbg, LEVEL_1, "created copy %+F for should be same argument "
262                              "at input %d of %+F\n", copy, same_pos, node));
263                         continue;
264                 }
265
266                 /* for commutative nodes we can simply swap the left/right */
267                 if(is_ia32_commutative(node) && uses_out_reg_pos == n_ia32_binary_right) {
268                         ia32_swap_left_right(node);
269                         DBG((dbg, LEVEL_1, "swapped left/right input of %+F to resolve "
270                              "should be same constraint\n", node));
271                         continue;
272                 }
273
274 #ifdef DEBUG_libfirm
275                 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);
276 #endif
277                 /* the out reg is used as node input: we need to permutate our input
278                  * and the other (this is allowed, since the other node can't be live
279                  * after! the operation as we will override the register. */
280                 in[0] = in_node;
281                 in[1] = uses_out_reg;
282                 perm  = be_new_Perm(class, irg, block, 2, in);
283
284                 perm_proj0 = new_r_Proj(irg, block, perm, get_irn_mode(in[0]), 0);
285                 perm_proj1 = new_r_Proj(irg, block, perm, get_irn_mode(in[1]), 1);
286
287                 arch_set_irn_register(arch_env, perm_proj0, out_reg);
288                 arch_set_irn_register(arch_env, perm_proj1, in_reg);
289
290                 sched_add_before(node, perm);
291
292                 DBG((dbg, LEVEL_1, "created perm %+F for should be same argument "
293                      "at input %d of %+F (need permutate with %+F)\n", perm, same_pos,
294                      node, uses_out_reg));
295
296                 /* use the perm results */
297                 for(i2 = 0; i2 < arity; ++i2) {
298                         ir_node *in = get_irn_n(node, i2);
299
300                         if(in == in_node) {
301                                 set_irn_n(node, i2, perm_proj0);
302                         } else if(in == uses_out_reg) {
303                                 set_irn_n(node, i2, perm_proj1);
304                         }
305                 }
306         }
307 }
308
309 /**
310  * Following Problem:
311  * We have a source address mode node with base or index register equal to
312  * result register and unfulfilled should_be_same requirement. The constraint
313  * handler will insert a copy from the remaining input operand to the result
314  * register -> base or index is broken then.
315  * Solution: Turn back this address mode into explicit Load + Operation.
316  */
317 static void fix_am_source(ir_node *irn, void *env) {
318         ia32_code_gen_t            *cg = env;
319         const arch_env_t           *arch_env = cg->arch_env;
320         ir_node                    *base;
321         ir_node                    *index;
322         ir_node                    *noreg;
323         const arch_register_t      *reg_base;
324         const arch_register_t      *reg_index;
325         const arch_register_req_t **reqs;
326         int                         n_res, i;
327
328         /* check only ia32 nodes with source address mode */
329         if (! is_ia32_irn(irn) || get_ia32_op_type(irn) != ia32_AddrModeS)
330                 return;
331         /* only need to fix binary operations */
332         if (get_ia32_am_arity(irn) != ia32_am_binary)
333                 return;
334
335         base  = get_irn_n(irn, 0);
336         index = get_irn_n(irn, 1);
337
338         reg_base  = arch_get_irn_register(arch_env, base);
339         reg_index = arch_get_irn_register(arch_env, index);
340         reqs      = get_ia32_out_req_all(irn);
341
342         noreg = ia32_new_NoReg_gp(cg);
343
344         n_res = get_ia32_n_res(irn);
345
346         for (i = 0; i < n_res; i++) {
347                 if (arch_register_req_is(reqs[i], should_be_same)) {
348                         /* get in and out register */
349                         const arch_register_t *out_reg   = get_ia32_out_reg(irn, i);
350                         int                    same_pos  = reqs[i]->other_same[0];
351                         ir_node               *same_node = get_irn_n(irn, same_pos);
352                         const arch_register_t *same_reg
353                                 = arch_get_irn_register(arch_env, same_node);
354                         const arch_register_class_t *same_cls;
355                         ir_graph              *irg   = cg->irg;
356                         dbg_info              *dbgi  = get_irn_dbg_info(irn);
357                         ir_node               *block = get_nodes_block(irn);
358                         ir_mode               *proj_mode;
359                         ir_node               *load;
360                         ir_node               *load_res;
361                         ir_node               *mem;
362                         int                    pnres;
363
364                         /* should_be same constraint is fullfilled, nothing to do */
365                         if(out_reg == same_reg)
366                                 continue;
367
368                         /* we only need to do something if the out reg is the same as base
369                            or index register */
370                         if (out_reg != reg_base && out_reg != reg_index)
371                                 continue;
372
373                         /* turn back address mode */
374                         same_cls = arch_register_get_class(same_reg);
375                         mem = get_irn_n(irn, n_ia32_mem);
376                         assert(get_irn_mode(mem) == mode_M);
377                         if (same_cls == &ia32_reg_classes[CLASS_ia32_gp]) {
378                                 load      = new_rd_ia32_Load(dbgi, irg, block, base, index, mem);
379                                 pnres     = pn_ia32_Load_res;
380                                 proj_mode = mode_Iu;
381                         } else if (same_cls == &ia32_reg_classes[CLASS_ia32_xmm]) {
382                                 load      = new_rd_ia32_xLoad(dbgi, irg, block, base, index, mem,
383                                                               get_ia32_ls_mode(irn));
384                                 pnres     = pn_ia32_xLoad_res;
385                                 proj_mode = mode_E;
386                         } else {
387                                 panic("cannot turn back address mode for this register class");
388                         }
389
390                         /* copy address mode information to load */
391                         set_ia32_op_type(load, ia32_AddrModeS);
392                         ia32_copy_am_attrs(load, irn);
393
394                         /* insert the load into schedule */
395                         sched_add_before(irn, load);
396
397                         DBG((dbg, LEVEL_3, "irg %+F: build back AM source for node %+F, inserted load %+F\n", cg->irg, irn, load));
398
399                         load_res = new_r_Proj(cg->irg, block, load, proj_mode, pnres);
400                         arch_set_irn_register(cg->arch_env, load_res, out_reg);
401
402                         /* set the new input operand */
403                         set_irn_n(irn, n_ia32_binary_right, load_res);
404                         if(get_irn_mode(irn) == mode_T) {
405                                 const ir_edge_t *edge, *next;
406                                 foreach_out_edge_safe(irn, edge, next) {
407                                         ir_node *node = get_edge_src_irn(edge);
408                                         int      pn   = get_Proj_proj(node);
409                                         if(pn == 0) {
410                                                 exchange(node, irn);
411                                         } else {
412                                                 assert(pn == 1);
413                                                 set_Proj_pred(node, load);
414                                         }
415                                 }
416                                 set_irn_mode(irn, mode_Iu);
417                         }
418
419                         /* this is a normal node now */
420                         set_irn_n(irn, n_ia32_base,  noreg);
421                         set_irn_n(irn, n_ia32_index, noreg);
422                         set_ia32_op_type(irn, ia32_Normal);
423                         break;
424                 }
425         }
426 }
427
428 /**
429  * Block walker: finishes a block
430  */
431 static void ia32_finish_irg_walker(ir_node *block, void *env) {
432         ia32_code_gen_t *cg = env;
433         ir_node *irn, *next;
434
435         /* first: turn back AM source if necessary */
436         for (irn = sched_first(block); ! sched_is_end(irn); irn = next) {
437                 next = sched_next(irn);
438                 fix_am_source(irn, env);
439         }
440
441         for (irn = sched_first(block); ! sched_is_end(irn); irn = next) {
442                 ia32_code_gen_t *cg = env;
443
444                 next = sched_next(irn);
445
446                 /* check if there is a sub which need to be transformed */
447                 ia32_transform_sub_to_neg_add(irn, cg);
448         }
449
450         /* second: insert copies and finish irg */
451         for (irn = sched_first(block); ! sched_is_end(irn); irn = next) {
452                 next = sched_next(irn);
453                 assure_should_be_same_requirements(cg, irn);
454         }
455 }
456
457 /**
458  * Block walker: pushes all blocks on a wait queue
459  */
460 static void ia32_push_on_queue_walker(ir_node *block, void *env) {
461         waitq *wq = env;
462         waitq_put(wq, block);
463 }
464
465
466 /**
467  * Add Copy nodes for not fulfilled should_be_equal constraints
468  */
469 void ia32_finish_irg(ir_graph *irg, ia32_code_gen_t *cg) {
470         waitq *wq = new_waitq();
471
472         /* Push the blocks on the waitq because ia32_finish_irg_walker starts more walks ... */
473         irg_block_walk_graph(irg, NULL, ia32_push_on_queue_walker, wq);
474
475         while (! waitq_empty(wq)) {
476                 ir_node *block = waitq_get(wq);
477                 ia32_finish_irg_walker(block, cg);
478         }
479         del_waitq(wq);
480 }
481
482 void ia32_init_finish(void)
483 {
484         FIRM_DBG_REGISTER(dbg, "firm.be.ia32.finish");
485 }