bearch: remove arch_register_type_joker.
[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  */
25 #include "config.h"
26
27 #include "irnode.h"
28 #include "ircons.h"
29 #include "irgmod.h"
30 #include "irgwalk.h"
31 #include "iredges.h"
32 #include "irprintf.h"
33 #include "pdeq.h"
34 #include "error.h"
35
36 #include "bearch.h"
37 #include "besched.h"
38 #include "benode.h"
39
40 #include "bearch_ia32_t.h"
41 #include "ia32_finish.h"
42 #include "ia32_new_nodes.h"
43 #include "ia32_common_transform.h"
44 #include "ia32_transform.h"
45 #include "ia32_dbg_stat.h"
46 #include "ia32_optimize.h"
47 #include "gen_ia32_regalloc_if.h"
48
49 DEBUG_ONLY(static firm_dbg_module_t *dbg = NULL;)
50
51 /**
52  * Transforms a Sub or xSub into Neg--Add iff OUT_REG != SRC1_REG && OUT_REG == SRC2_REG.
53  * THIS FUNCTIONS MUST BE CALLED AFTER REGISTER ALLOCATION.
54  */
55 static void ia32_transform_sub_to_neg_add(ir_node *irn)
56 {
57         ir_graph *irg;
58         ir_node *in1, *in2, *noreg, *nomem, *res;
59         ir_node *noreg_fp, *block;
60         dbg_info *dbgi;
61         const arch_register_t *in1_reg, *in2_reg, *out_reg;
62
63         /* fix_am will solve this for AddressMode variants */
64         if (get_ia32_op_type(irn) != ia32_Normal)
65                 return;
66
67         irg      = get_irn_irg(irn);
68         noreg    = ia32_new_NoReg_gp(irg);
69         noreg_fp = ia32_new_NoReg_xmm(irg);
70         nomem    = get_irg_no_mem(irg);
71         in1      = get_irn_n(irn, n_ia32_binary_left);
72         in2      = get_irn_n(irn, n_ia32_binary_right);
73         in1_reg  = arch_get_irn_register(in1);
74         in2_reg  = arch_get_irn_register(in2);
75         out_reg  = arch_get_irn_register_out(irn, 0);
76
77         if (out_reg == in1_reg)
78                 return;
79
80         /* in case of sub and OUT == SRC2 we can transform the sequence into neg src2 -- add */
81         if (out_reg != in2_reg)
82                 return;
83
84         block = get_nodes_block(irn);
85         dbgi   = 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_bd_ia32_xXor(dbgi, 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_bd_ia32_xAdd(dbgi, block, noreg, noreg, nomem, res, in1);
109                 set_ia32_ls_mode(res, get_ia32_ls_mode(irn));
110         } else {
111                 ir_node *flags_proj = NULL;
112                 ir_node *carry;
113
114                 if (get_irn_mode(irn) == mode_T) {
115                         /* collect the Proj uses */
116                         foreach_out_edge(irn, edge) {
117                                 ir_node *proj = get_edge_src_irn(edge);
118                                 long     pn   = get_Proj_proj(proj);
119                                 if (pn == pn_ia32_flags) {
120                                         assert(flags_proj == NULL);
121                                         flags_proj = proj;
122                                         break;
123                                 }
124                         }
125                 }
126
127                 if (is_ia32_Sbb(irn)) {
128                         /* Feed borrow (in CF) as carry (via CMC) into NOT+ADC. */
129                         carry = get_irn_n(irn, n_ia32_Sbb_eflags);
130                         carry = new_bd_ia32_Cmc(dbgi, block, carry);
131                         goto carry;
132                 } else if (flags_proj != 0) {
133                         /*
134                          * ARG, the above technique does NOT set the flags right.
135                          * So, we must produce the following code:
136                          * t1 = ~b
137                          * t2 = a + ~b + Carry
138                          * Complement Carry
139                          *
140                          * a + -b = a + (~b + 1)  would set the carry flag wrong IFF both a and b are zero.
141                          */
142                         ir_node *cmc;
143                         ir_node *nnot;
144                         ir_node *adc;
145                         ir_node *adc_flags;
146
147                         carry = new_bd_ia32_Stc(dbgi, block);
148
149 carry:
150                         nnot = new_bd_ia32_Not(dbgi, block, in2);
151                         arch_set_irn_register(nnot, in2_reg);
152                         sched_add_before(irn, nnot);
153
154                         arch_set_irn_register(carry, &ia32_registers[REG_EFLAGS]);
155                         sched_add_before(irn, carry);
156
157                         adc = new_bd_ia32_Adc(dbgi, block, noreg, noreg, nomem, nnot, in1, carry);
158                         arch_set_irn_register(adc, out_reg);
159                         set_ia32_commutative(adc);
160
161                         if (flags_proj != NULL) {
162                                 set_irn_mode(adc, mode_T);
163                                 adc_flags = new_r_Proj(adc, mode_Iu, pn_ia32_Adc_flags);
164                                 arch_set_irn_register(adc_flags, &ia32_registers[REG_EFLAGS]);
165
166                                 cmc = new_bd_ia32_Cmc(dbgi, block, adc_flags);
167                                 arch_set_irn_register(cmc, &ia32_registers[REG_EFLAGS]);
168                                 sched_add_after(irn, cmc);
169                                 exchange(flags_proj, cmc);
170                         }
171
172                         res = adc;
173                 } else {
174                         res = new_bd_ia32_Neg(dbgi, block, in2);
175                         arch_set_irn_register(res, in2_reg);
176
177                         /* add to schedule */
178                         sched_add_before(irn, res);
179
180                         /* generate the add */
181                         res = new_bd_ia32_Add(dbgi, block, noreg, noreg, nomem, res, in1);
182                         arch_set_irn_register(res, out_reg);
183                         set_ia32_commutative(res);
184                 }
185         }
186
187         /* exchange the add and the sub */
188         edges_reroute(irn, res);
189         sched_add_before(irn, res);
190
191         set_irn_mode(res, get_irn_mode(irn));
192
193         SET_IA32_ORIG_NODE(res, irn);
194
195         /* remove the old sub */
196         sched_remove(irn);
197         kill_node(irn);
198
199         DBG_OPT_SUB2NEGADD(irn, res);
200 }
201
202 static inline int need_constraint_copy(ir_node *irn)
203 {
204         /* TODO this should be determined from the node specification */
205         switch (get_ia32_irn_opcode(irn)) {
206                 case iro_ia32_IMul: {
207                         /* the 3 operand form of IMul needs no constraint copy */
208                         ir_node *right = get_irn_n(irn, n_ia32_IMul_right);
209                         return !is_ia32_Immediate(right);
210                 }
211
212                 case iro_ia32_Lea:
213                 case iro_ia32_Conv_I2I:
214                 case iro_ia32_Conv_I2I8Bit:
215                 case iro_ia32_CMovcc:
216                 case iro_ia32_Minus64Bit:
217                         return 0;
218
219                 default:
220                         return 1;
221         }
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         panic("same position not found");
237 }
238
239 /**
240  * Insert copies for all ia32 nodes where the should_be_same requirement
241  * is not fulfilled.
242  * Transform Sub into Neg -- Add if IN2 == OUT
243  */
244 static void assure_should_be_same_requirements(ir_node *node)
245 {
246         const arch_register_t      *out_reg, *in_reg;
247         int                         n_res, i;
248         ir_node                    *in_node, *block;
249
250         n_res = arch_get_irn_n_outs(node);
251         block = get_nodes_block(node);
252
253         /* check all OUT requirements, if there is a should_be_same */
254         for (i = 0; i < n_res; i++) {
255                 int                          i2, arity;
256                 int                          same_pos;
257                 ir_node                     *uses_out_reg;
258                 const arch_register_req_t   *req = arch_get_irn_register_req_out(node, i);
259                 int                         uses_out_reg_pos;
260
261                 if (!arch_register_req_is(req, should_be_same))
262                         continue;
263
264                 same_pos = get_first_same(req);
265
266                 /* get in and out register */
267                 out_reg = arch_get_irn_register_out(node, i);
268                 in_node = get_irn_n(node, same_pos);
269                 in_reg  = arch_get_irn_register(in_node);
270
271                 /* requirement already fulfilled? */
272                 if (in_reg == out_reg)
273                         continue;
274                 assert(in_reg->reg_class == out_reg->reg_class);
275
276                 /* check if any other input operands uses the out register */
277                 arity = get_irn_arity(node);
278                 uses_out_reg     = NULL;
279                 uses_out_reg_pos = -1;
280                 for (i2 = 0; i2 < arity; ++i2) {
281                         ir_node               *in     = get_irn_n(node, i2);
282                         const arch_register_t *other_in_reg;
283
284                         if (!mode_is_data(get_irn_mode(in)))
285                                 continue;
286
287                         other_in_reg = arch_get_irn_register(in);
288
289                         if (other_in_reg != out_reg)
290                                 continue;
291
292                         if (uses_out_reg != NULL && in != uses_out_reg) {
293                                 panic("invalid register allocation");
294                         }
295                         uses_out_reg = in;
296                         if (uses_out_reg_pos >= 0)
297                                 uses_out_reg_pos = -1; /* multiple inputs... */
298                         else
299                                 uses_out_reg_pos = i2;
300                 }
301
302                 /* no-one else is using the out reg, we can simply copy it
303                  * (the register can't be live since the operation will override it
304                  *  anyway) */
305                 if (uses_out_reg == NULL) {
306                         ir_node *copy = be_new_Copy(block, in_node);
307                         DBG_OPT_2ADDRCPY(copy);
308
309                         /* destination is the out register */
310                         arch_set_irn_register(copy, out_reg);
311
312                         /* insert copy before the node into the schedule */
313                         sched_add_before(node, copy);
314
315                         /* set copy as in */
316                         set_irn_n(node, same_pos, copy);
317
318                         DBG((dbg, LEVEL_1,
319                                 "created copy %+F for should be same argument at input %d of %+F\n",
320                                 copy, same_pos, node));
321                         continue;
322                 }
323
324                 /* for commutative nodes we can simply swap the left/right */
325                 if (uses_out_reg_pos == n_ia32_binary_right && is_ia32_commutative(node)) {
326                         ia32_swap_left_right(node);
327                         DBG((dbg, LEVEL_1,
328                                 "swapped left/right input of %+F to resolve should be same constraint\n",
329                                 node));
330                         continue;
331                 }
332
333                 panic("Unresolved should_be_same constraint");
334         }
335 }
336
337 /**
338  * Following Problem:
339  * We have a source address mode node with base or index register equal to
340  * result register and unfulfilled should_be_same requirement. The constraint
341  * handler will insert a copy from the remaining input operand to the result
342  * register -> base or index is broken then.
343  * Solution: Turn back this address mode into explicit Load + Operation.
344  */
345 static void fix_am_source(ir_node *irn)
346 {
347         int                         n_res, i;
348
349         /* check only ia32 nodes with source address mode */
350         if (!is_ia32_irn(irn) || get_ia32_op_type(irn) != ia32_AddrModeS)
351                 return;
352         /* only need to fix binary operations */
353         if (get_ia32_am_support(irn) != ia32_am_binary)
354                 return;
355
356         n_res = arch_get_irn_n_outs(irn);
357
358         for (i = 0; i < n_res; i++) {
359                 const arch_register_req_t *req = arch_get_irn_register_req_out(irn, i);
360                 const arch_register_t     *out_reg;
361                 int                        same_pos;
362                 ir_node                   *same_node;
363                 const arch_register_t     *same_reg;
364                 ir_node                   *load_res;
365
366                 if (!arch_register_req_is(req, should_be_same))
367                         continue;
368
369                 /* get in and out register */
370                 out_reg   = arch_get_irn_register_out(irn, i);
371                 same_pos  = get_first_same(req);
372                 same_node = get_irn_n(irn, same_pos);
373                 same_reg  = arch_get_irn_register(same_node);
374
375                 /* should_be same constraint is fullfilled, nothing to do */
376                 if (out_reg == same_reg)
377                         continue;
378
379                 /* we only need to do something if the out reg is the same as base
380                          or index register */
381                 if (out_reg != arch_get_irn_register(get_irn_n(irn, n_ia32_base)) &&
382                                 out_reg != arch_get_irn_register(get_irn_n(irn, n_ia32_index)))
383                         continue;
384
385                 load_res = ia32_turn_back_am(irn);
386                 arch_set_irn_register(load_res, out_reg);
387
388                 DBG((dbg, LEVEL_3,
389                         "irg %+F: build back AM source for node %+F, inserted load %+F\n",
390                         get_irn_irg(irn), irn, get_Proj_pred(load_res)));
391                 break;
392         }
393 }
394
395 /**
396  * Block walker: finishes a block
397  */
398 static void ia32_finish_irg_walker(ir_node *block, void *env)
399 {
400         ir_node *irn, *next;
401         (void) env;
402
403         /* first: turn back AM source if necessary */
404         for (irn = sched_first(block); ! sched_is_end(irn); irn = next) {
405                 next = sched_next(irn);
406                 fix_am_source(irn);
407         }
408
409         for (irn = sched_first(block); ! sched_is_end(irn); irn = next) {
410                 next = sched_next(irn);
411
412                 /* check if there is a sub which need to be transformed */
413                 if (is_ia32_Sub(irn) || is_ia32_Sbb(irn) || is_ia32_xSub(irn)) {
414                         ia32_transform_sub_to_neg_add(irn);
415                 }
416         }
417
418         /* second: insert copies and finish irg */
419         for (irn = sched_first(block); ! sched_is_end(irn); irn = next) {
420                 next = sched_next(irn);
421                 if (is_ia32_irn(irn)) {
422                         /* some nodes are just a bit less efficient, but need no fixing if the
423                          * should be same requirement is not fulfilled */
424                         if (need_constraint_copy(irn))
425                                 assure_should_be_same_requirements(irn);
426                 }
427         }
428 }
429
430 /**
431  * Block walker: pushes all blocks on a wait queue
432  */
433 static void ia32_push_on_queue_walker(ir_node *block, void *env)
434 {
435         waitq *wq = (waitq*)env;
436         waitq_put(wq, block);
437 }
438
439
440 /**
441  * Add Copy nodes for not fulfilled should_be_equal constraints
442  */
443 void ia32_finish_irg(ir_graph *irg)
444 {
445         waitq *wq = new_waitq();
446
447         /* Push the blocks on the waitq because ia32_finish_irg_walker starts more walks ... */
448         irg_block_walk_graph(irg, NULL, ia32_push_on_queue_walker, wq);
449
450         while (! waitq_empty(wq)) {
451                 ir_node *block = (ir_node*)waitq_get(wq);
452                 ia32_finish_irg_walker(block, NULL);
453         }
454         del_waitq(wq);
455 }
456
457 void ia32_init_finish(void)
458 {
459         FIRM_DBG_REGISTER(dbg, "firm.be.ia32.finish");
460 }