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