Replace memcpy() by simple assignment.
[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 #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         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(cg->arch_env, in1);
75         in2_reg  = arch_get_irn_register(cg->arch_env, 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(cg->arch_env, 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(cg->arch_env, 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(cg->arch_env, 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(cg->arch_env, not, in2_reg);
169                         sched_add_before(irn, not);
170
171                         stc = new_rd_ia32_Stc(dbg, irg, block);
172                         arch_set_irn_register(cg->arch_env, stc,
173                                               &ia32_flags_regs[REG_EFLAGS]);
174                         sched_add_before(irn, stc);
175
176                         adc = new_rd_ia32_Adc(dbg, irg, block, noreg, noreg, nomem, not,
177                                               in1, stc);
178                         arch_set_irn_register(cg->arch_env, adc, out_reg);
179                         sched_add_before(irn, adc);
180
181                         set_irn_mode(adc, mode_T);
182                         adc_flags = new_r_Proj(irg, block, adc, mode_Iu, pn_ia32_Adc_flags);
183                         arch_set_irn_register(cg->arch_env, adc_flags,
184                                               &ia32_flags_regs[REG_EFLAGS]);
185
186                         cmc = new_rd_ia32_Cmc(dbg, irg, block, adc_flags);
187                         arch_set_irn_register(cg->arch_env, cmc,
188                                               &ia32_flags_regs[REG_EFLAGS]);
189                         sched_add_before(irn, cmc);
190
191                         exchange(flags_proj, cmc);
192                         if (res_proj != NULL) {
193                                 set_Proj_pred(res_proj, adc);
194                                 set_Proj_proj(res_proj, pn_ia32_Adc_res);
195                         }
196
197                         res = adc;
198                 }
199         }
200
201         SET_IA32_ORIG_NODE(res, ia32_get_old_node_name(cg, 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         /* the 3 operand form of IMul needs no constraint copy */
212         if(is_ia32_IMul(irn)) {
213                 ir_node *right = get_irn_n(irn, n_ia32_IMul_right);
214                 if(is_ia32_Immediate(right))
215                         return 0;
216         }
217
218         return  ! is_ia32_Lea(irn)      &&
219                 ! is_ia32_Conv_I2I(irn)     &&
220                 ! is_ia32_Conv_I2I8Bit(irn) &&
221                 ! is_ia32_CMov(irn);
222 }
223
224 /**
225  * Returns the index of the "same" register.
226  * On the x86, we should have only one.
227  */
228 static int get_first_same(const arch_register_req_t* req)
229 {
230         const unsigned other = req->other_same;
231         int i;
232
233         for (i = 0; i < 32; ++i) {
234                 if (other & (1U << i)) return i;
235         }
236         assert(! "same position not found");
237         return 32;
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(ia32_code_gen_t *cg,
246                                                ir_node *node)
247 {
248         ir_graph                   *irg      = cg->irg;
249         const arch_env_t           *arch_env = cg->arch_env;
250         const arch_register_req_t **reqs;
251         const arch_register_t      *out_reg, *in_reg;
252         int                         n_res, i;
253         ir_node                    *in_node, *block;
254
255         reqs  = get_ia32_out_req_all(node);
256         n_res = get_ia32_n_res(node);
257         block = get_nodes_block(node);
258
259         /* check all OUT requirements, if there is a should_be_same */
260         for (i = 0; i < n_res; i++) {
261                 int                          i2, arity;
262                 int                          same_pos;
263                 ir_node                     *perm;
264                 ir_node                     *in[2];
265                 ir_node                     *perm_proj0;
266                 ir_node                     *perm_proj1;
267                 ir_node                     *uses_out_reg;
268                 const arch_register_req_t   *req = reqs[i];
269                 const arch_register_class_t *cls;
270                 int                         uses_out_reg_pos;
271
272                 if (!arch_register_req_is(req, should_be_same))
273                         continue;
274
275                 same_pos = get_first_same(req);
276
277                 /* get in and out register */
278                 out_reg  = get_ia32_out_reg(node, i);
279                 in_node  = get_irn_n(node, same_pos);
280                 in_reg   = arch_get_irn_register(arch_env, in_node);
281
282                 /* requirement already fulfilled? */
283                 if (in_reg == out_reg)
284                         continue;
285                 /* unknowns can be changed to any register we want on emitting */
286                 if (is_unknown_reg(in_reg))
287                         continue;
288                 cls = arch_register_get_class(in_reg);
289                 assert(cls == arch_register_get_class(out_reg));
290
291                 /* check if any other input operands uses the out register */
292                 arity = get_irn_arity(node);
293                 uses_out_reg     = NULL;
294                 uses_out_reg_pos = -1;
295                 for(i2 = 0; i2 < arity; ++i2) {
296                         ir_node               *in     = get_irn_n(node, i2);
297                         const arch_register_t *in_reg;
298
299                         if(!mode_is_data(get_irn_mode(in)))
300                                 continue;
301
302                         in_reg = arch_get_irn_register(arch_env, in);
303
304                         if(in_reg != out_reg)
305                                 continue;
306
307                         if(uses_out_reg != NULL && in != uses_out_reg) {
308                                 panic("invalid register allocation");
309                         }
310                         uses_out_reg = in;
311                         if(uses_out_reg_pos >= 0)
312                                 uses_out_reg_pos = -1; /* multiple inputs... */
313                         else
314                                 uses_out_reg_pos = i2;
315                 }
316
317                 /* no-one else is using the out reg, we can simply copy it
318                  * (the register can't be live since the operation will override it
319                  *  anyway) */
320                 if(uses_out_reg == NULL) {
321                         ir_node *copy = be_new_Copy(cls, irg, block, in_node);
322                         DBG_OPT_2ADDRCPY(copy);
323
324                         /* destination is the out register */
325                         arch_set_irn_register(arch_env, copy, out_reg);
326
327                         /* insert copy before the node into the schedule */
328                         sched_add_before(node, copy);
329
330                         /* set copy as in */
331                         set_irn_n(node, same_pos, copy);
332
333                         DBG((dbg, LEVEL_1, "created copy %+F for should be same argument "
334                              "at input %d of %+F\n", copy, same_pos, node));
335                         continue;
336                 }
337
338                 /* for commutative nodes we can simply swap the left/right */
339                 if (uses_out_reg_pos == n_ia32_binary_right && is_ia32_commutative(node)) {
340                         ia32_swap_left_right(node);
341                         DBG((dbg, LEVEL_1, "swapped left/right input of %+F to resolve "
342                              "should be same constraint\n", node));
343                         continue;
344                 }
345
346 #ifdef DEBUG_libfirm
347                 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);
348 #endif
349                 /* the out reg is used as node input: we need to permutate our input
350                  * and the other (this is allowed, since the other node can't be live
351                  * after! the operation as we will override the register. */
352                 in[0] = in_node;
353                 in[1] = uses_out_reg;
354                 perm  = be_new_Perm(cls, irg, block, 2, in);
355
356                 perm_proj0 = new_r_Proj(irg, block, perm, get_irn_mode(in[0]), 0);
357                 perm_proj1 = new_r_Proj(irg, block, perm, get_irn_mode(in[1]), 1);
358
359                 arch_set_irn_register(arch_env, perm_proj0, out_reg);
360                 arch_set_irn_register(arch_env, perm_proj1, in_reg);
361
362                 sched_add_before(node, perm);
363
364                 DBG((dbg, LEVEL_1, "created perm %+F for should be same argument "
365                      "at input %d of %+F (need permutate with %+F)\n", perm, same_pos,
366                      node, uses_out_reg));
367
368                 /* use the perm results */
369                 for(i2 = 0; i2 < arity; ++i2) {
370                         ir_node *in = get_irn_n(node, i2);
371
372                         if(in == in_node) {
373                                 set_irn_n(node, i2, perm_proj0);
374                         } else if(in == uses_out_reg) {
375                                 set_irn_n(node, i2, perm_proj1);
376                         }
377                 }
378         }
379 }
380
381 /**
382  * Following Problem:
383  * We have a source address mode node with base or index register equal to
384  * result register and unfulfilled should_be_same requirement. The constraint
385  * handler will insert a copy from the remaining input operand to the result
386  * register -> base or index is broken then.
387  * Solution: Turn back this address mode into explicit Load + Operation.
388  */
389 static void fix_am_source(ir_node *irn, void *env) {
390         ia32_code_gen_t            *cg = env;
391         const arch_env_t           *arch_env = cg->arch_env;
392         ir_node                    *base;
393         ir_node                    *index;
394         ir_node                    *noreg;
395         const arch_register_t      *reg_base;
396         const arch_register_t      *reg_index;
397         const arch_register_req_t **reqs;
398         int                         n_res, i;
399
400         /* check only ia32 nodes with source address mode */
401         if (! is_ia32_irn(irn) || get_ia32_op_type(irn) != ia32_AddrModeS)
402                 return;
403         /* only need to fix binary operations */
404         if (get_ia32_am_arity(irn) != ia32_am_binary)
405                 return;
406
407         base  = get_irn_n(irn, 0);
408         index = get_irn_n(irn, 1);
409
410         reg_base  = arch_get_irn_register(arch_env, base);
411         reg_index = arch_get_irn_register(arch_env, index);
412         reqs      = get_ia32_out_req_all(irn);
413
414         noreg = ia32_new_NoReg_gp(cg);
415
416         n_res = get_ia32_n_res(irn);
417
418         for (i = 0; i < n_res; i++) {
419                 if (arch_register_req_is(reqs[i], should_be_same)) {
420                         /* get in and out register */
421                         const arch_register_t *out_reg   = get_ia32_out_reg(irn, i);
422                         int                    same_pos  = get_first_same(reqs[i]);
423                         ir_node               *same_node = get_irn_n(irn, same_pos);
424                         const arch_register_t *same_reg
425                                 = arch_get_irn_register(arch_env, same_node);
426                         const arch_register_class_t *same_cls;
427                         ir_graph              *irg   = cg->irg;
428                         dbg_info              *dbgi  = get_irn_dbg_info(irn);
429                         ir_node               *block = get_nodes_block(irn);
430                         ir_mode               *proj_mode;
431                         ir_node               *load;
432                         ir_node               *load_res;
433                         ir_node               *mem;
434                         int                    pnres;
435                         int                    pnmem;
436
437                         /* should_be same constraint is fullfilled, nothing to do */
438                         if(out_reg == same_reg)
439                                 continue;
440
441                         /* we only need to do something if the out reg is the same as base
442                            or index register */
443                         if (out_reg != reg_base && out_reg != reg_index)
444                                 continue;
445
446                         /* turn back address mode */
447                         same_cls = arch_register_get_class(same_reg);
448                         mem = get_irn_n(irn, n_ia32_mem);
449                         assert(get_irn_mode(mem) == mode_M);
450                         if (same_cls == &ia32_reg_classes[CLASS_ia32_gp]) {
451                                 load      = new_rd_ia32_Load(dbgi, irg, block, base, index, mem);
452                                 pnres     = pn_ia32_Load_res;
453                                 pnmem     = pn_ia32_Load_M;
454                                 proj_mode = mode_Iu;
455                         } else if (same_cls == &ia32_reg_classes[CLASS_ia32_xmm]) {
456                                 load      = new_rd_ia32_xLoad(dbgi, irg, block, base, index, mem,
457                                                               get_ia32_ls_mode(irn));
458                                 pnres     = pn_ia32_xLoad_res;
459                                 pnmem     = pn_ia32_xLoad_M;
460                                 proj_mode = mode_E;
461                         } else {
462                                 panic("cannot turn back address mode for this register class");
463                         }
464
465                         /* copy address mode information to load */
466                         set_ia32_op_type(load, ia32_AddrModeS);
467                         ia32_copy_am_attrs(load, irn);
468
469                         /* insert the load into schedule */
470                         sched_add_before(irn, load);
471
472                         DBG((dbg, LEVEL_3, "irg %+F: build back AM source for node %+F, inserted load %+F\n", cg->irg, irn, load));
473
474                         load_res = new_r_Proj(cg->irg, block, load, proj_mode, pnres);
475                         arch_set_irn_register(cg->arch_env, load_res, out_reg);
476
477                         /* set the new input operand */
478                         set_irn_n(irn, n_ia32_binary_right, load_res);
479                         if(get_irn_mode(irn) == mode_T) {
480                                 const ir_edge_t *edge, *next;
481                                 foreach_out_edge_safe(irn, edge, next) {
482                                         ir_node *node = get_edge_src_irn(edge);
483                                         int      pn   = get_Proj_proj(node);
484                                         if(pn == 0) {
485                                                 exchange(node, irn);
486                                         } else if(pn == pn_ia32_mem) {
487                                                 set_Proj_pred(node, load);
488                                                 set_Proj_proj(node, pnmem);
489                                         }
490                                 }
491                                 set_irn_mode(irn, mode_Iu);
492                         }
493
494                         /* this is a normal node now */
495                         set_irn_n(irn, n_ia32_base,  noreg);
496                         set_irn_n(irn, n_ia32_index, noreg);
497                         set_ia32_op_type(irn, ia32_Normal);
498                         break;
499                 }
500         }
501 }
502
503 /**
504  * Block walker: finishes a block
505  */
506 static void ia32_finish_irg_walker(ir_node *block, void *env) {
507         ia32_code_gen_t *cg = env;
508         ir_node *irn, *next;
509
510         /* first: turn back AM source if necessary */
511         for (irn = sched_first(block); ! sched_is_end(irn); irn = next) {
512                 next = sched_next(irn);
513                 fix_am_source(irn, env);
514         }
515
516         for (irn = sched_first(block); ! sched_is_end(irn); irn = next) {
517                 ia32_code_gen_t *cg = env;
518
519                 next = sched_next(irn);
520
521                 /* check if there is a sub which need to be transformed */
522                 if (is_ia32_Sub(irn) || is_ia32_xSub(irn)) {
523                         ia32_transform_sub_to_neg_add(irn, cg);
524                 }
525         }
526
527         /* second: insert copies and finish irg */
528         for (irn = sched_first(block); ! sched_is_end(irn); irn = next) {
529                 next = sched_next(irn);
530                 if (is_ia32_irn(irn)) {
531                         /* some nodes are just a bit less efficient, but need no fixing if the
532                          * should be same requirement is not fulfilled */
533                         if (need_constraint_copy(irn))
534                                 assure_should_be_same_requirements(cg, irn);
535                 }
536         }
537 }
538
539 /**
540  * Block walker: pushes all blocks on a wait queue
541  */
542 static void ia32_push_on_queue_walker(ir_node *block, void *env) {
543         waitq *wq = env;
544         waitq_put(wq, block);
545 }
546
547
548 /**
549  * Add Copy nodes for not fulfilled should_be_equal constraints
550  */
551 void ia32_finish_irg(ir_graph *irg, ia32_code_gen_t *cg) {
552         waitq *wq = new_waitq();
553
554         /* Push the blocks on the waitq because ia32_finish_irg_walker starts more walks ... */
555         irg_block_walk_graph(irg, NULL, ia32_push_on_queue_walker, wq);
556
557         while (! waitq_empty(wq)) {
558                 ir_node *block = waitq_get(wq);
559                 ia32_finish_irg_walker(block, cg);
560         }
561         del_waitq(wq);
562 }
563
564 void ia32_init_finish(void)
565 {
566         FIRM_DBG_REGISTER(dbg, "firm.be.ia32.finish");
567 }