cleanup: Remove pointless assert(is_${NODE}(x)) just before get_${NODE}_${FOO}(x...
[libfirm] / ir / be / amd64 / amd64_transform.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   code selection (transform FIRM into amd64 FIRM)
23  */
24 #include "config.h"
25
26 #include "irnode_t.h"
27 #include "irgraph_t.h"
28 #include "irmode_t.h"
29 #include "irgmod.h"
30 #include "iredges.h"
31 #include "ircons.h"
32 #include "iropt_t.h"
33 #include "error.h"
34 #include "debug.h"
35
36 #include "benode.h"
37 #include "betranshlp.h"
38 #include "beutil.h"
39 #include "bearch_amd64_t.h"
40
41 #include "amd64_nodes_attr.h"
42 #include "amd64_transform.h"
43 #include "amd64_new_nodes.h"
44
45 #include "gen_amd64_regalloc_if.h"
46
47 DEBUG_ONLY(static firm_dbg_module_t *dbg = NULL;)
48
49 /* Some support functions: */
50
51 static inline int mode_needs_gp_reg(ir_mode *mode)
52 {
53         return mode_is_int(mode) || mode_is_reference(mode);
54 }
55
56 /**
57  * Create a DAG constructing a given Const.
58  *
59  * @param irn  a Firm const
60  */
61 static ir_node *create_const_graph(ir_node *irn, ir_node *block)
62 {
63         ir_tarval *tv   = get_Const_tarval(irn);
64         ir_mode   *mode = get_tarval_mode(tv);
65         dbg_info  *dbgi = get_irn_dbg_info(irn);
66         unsigned   value;
67
68         if (mode_is_reference(mode)) {
69                 /* AMD64 is 64bit, so we can safely convert a reference tarval into Iu */
70                 assert(get_mode_size_bits(mode) == get_mode_size_bits(mode_Lu));
71                 tv = tarval_convert_to(tv, mode_Lu);
72         }
73
74         value = get_tarval_long(tv);
75         //d// printf ("TEST GENERATE %d\n", value);
76
77         return new_bd_amd64_Immediate(dbgi, block, value);
78 }
79
80 /* Op transformers: */
81
82 /**
83  * Transforms a Const node.
84  *
85  * @return The transformed AMD64 node.
86  */
87 static ir_node *gen_Const(ir_node *node) {
88         ir_node  *block = be_transform_node(get_nodes_block(node));
89         ir_mode  *mode  = get_irn_mode(node);
90         ir_node *res = create_const_graph(node, block);
91         (void) mode;
92
93         return res;
94 }
95
96 /**
97  * Transforms a SymConst node.
98  *
99  * @return The transformed ARM node.
100  */
101 static ir_node *gen_SymConst(ir_node *node)
102 {
103         ir_node   *block  = be_transform_node(get_nodes_block(node));
104         ir_entity *entity = get_SymConst_entity(node);
105         dbg_info  *dbgi   = get_irn_dbg_info(node);
106         ir_node   *new_node;
107
108         new_node = new_bd_amd64_SymConst(dbgi, block, entity);
109         return new_node;
110 }
111
112 /**
113  * Transforms an Add node.
114  *
115  * @return The transformed AMD64 node.
116  */
117 static ir_node *gen_Add(ir_node *node) {
118         ir_node  *block = be_transform_node(get_nodes_block(node));
119         /* ir_mode  *mode  = get_irn_mode(node); */
120         ir_node  *op1   = get_Add_left(node);
121         ir_node  *op2   = get_Add_right(node);
122         dbg_info *dbgi  = get_irn_dbg_info(node);
123         ir_node  *new_op1 = be_transform_node(op1);
124         ir_node  *new_op2 = be_transform_node(op2);
125
126         ir_node *res = new_bd_amd64_Add(dbgi, block, new_op1, new_op2);
127         return res;
128 }
129
130 /**
131  * Transforms an Sub node.
132  *
133  * @return The transformed AMD64 node.
134  */
135 static ir_node *gen_Sub(ir_node *node) {
136         ir_node  *block = be_transform_node(get_nodes_block(node));
137         /* ir_mode  *mode  = get_irn_mode(node); */
138         ir_node  *op1   = get_Sub_left(node);
139         ir_node  *op2   = get_Sub_right(node);
140         dbg_info *dbgi  = get_irn_dbg_info(node);
141         ir_node  *new_op1 = be_transform_node(op1);
142         ir_node  *new_op2 = be_transform_node(op2);
143
144         ir_node *res = new_bd_amd64_Sub(dbgi, block, new_op1, new_op2);
145         return res;
146 }
147
148 static ir_node *gen_Mul(ir_node *node) {
149         ir_node  *block = be_transform_node(get_nodes_block(node));
150         /* ir_mode  *mode  = get_irn_mode(node); */
151         ir_node  *op1   = get_Mul_left(node);
152         ir_node  *op2   = get_Mul_right(node);
153         dbg_info *dbgi  = get_irn_dbg_info(node);
154         ir_node  *new_op1 = be_transform_node(op1);
155         ir_node  *new_op2 = be_transform_node(op2);
156
157         ir_node *res = new_bd_amd64_Mul(dbgi, block, new_op1, new_op2);
158         return res;
159 }
160
161 static ir_node *gen_Minus(ir_node *node)
162 {
163         ir_node  *block    = be_transform_node(get_nodes_block(node));
164         ir_node  *val      = be_transform_node(get_Minus_op(node));
165         dbg_info *dbgi     = get_irn_dbg_info(node);
166
167         return new_bd_amd64_Neg(dbgi, block, val);
168 }
169
170 static ir_node *gen_Jmp(ir_node *node)
171 {
172         ir_node  *block     = get_nodes_block(node);
173         ir_node  *new_block = be_transform_node(block);
174         dbg_info *dbgi      = get_irn_dbg_info(node);
175
176         return new_bd_amd64_Jmp(dbgi, new_block);
177 }
178
179 static ir_node *gen_be_Call(ir_node *node)
180 {
181         ir_node *res = be_duplicate_node(node);
182         arch_add_irn_flags(res, arch_irn_flags_modify_flags);
183
184         return res;
185 }
186
187 static ir_node *gen_Cmp(ir_node *node)
188 {
189         ir_node  *block    = be_transform_node(get_nodes_block(node));
190         ir_node  *op1      = get_Cmp_left(node);
191         ir_node  *op2      = get_Cmp_right(node);
192         ir_mode  *cmp_mode = get_irn_mode(op1);
193         dbg_info *dbgi     = get_irn_dbg_info(node);
194         ir_node  *new_op1;
195         ir_node  *new_op2;
196         bool      is_unsigned;
197
198         if (mode_is_float(cmp_mode)) {
199                 panic("Floating point not implemented yet!");
200         }
201
202         assert(get_irn_mode(op2) == cmp_mode);
203         is_unsigned = !mode_is_signed(cmp_mode);
204
205         new_op1 = be_transform_node(op1);
206         /* new_op1 = gen_extension(dbgi, block, new_op1, cmp_mode); */
207         new_op2 = be_transform_node(op2);
208         /* new_op2 = gen_extension(dbgi, block, new_op2, cmp_mode); */
209         return new_bd_amd64_Cmp(dbgi, block, new_op1, new_op2, false,
210                                 is_unsigned);
211 }
212
213 /**
214  * Transforms a Cond.
215  *
216  * @return the created ARM Cond node
217  */
218 static ir_node *gen_Cond(ir_node *node)
219 {
220         ir_node    *selector = get_Cond_selector(node);
221         ir_mode    *mode     = get_irn_mode(selector);
222
223         if (mode != mode_b) {
224                 panic ("create_Switch not implemented yet!");
225                 // return gen_SwitchJmp(node);
226         }
227
228         ir_node    *const block     = be_transform_node(get_nodes_block(node));
229         dbg_info   *const dbgi      = get_irn_dbg_info(node);
230         ir_node    *const flag_node = be_transform_node(selector);
231         ir_relation const relation  = get_Cmp_relation(selector);
232         return new_bd_amd64_Jcc(dbgi, block, flag_node, relation);
233 }
234
235 #if 0
236 /**
237  * Create an And that will zero out upper bits.
238  *
239  * @param dbgi     debug info
240  * @param block    the basic block
241  * @param op       the original node
242  * param src_bits  number of lower bits that will remain
243  */
244 static ir_node *gen_zero_extension(dbg_info *dbgi, ir_node *block, ir_node *op,
245                                    int src_bits)
246 {
247         if (src_bits == 8) {
248                 return new_bd_arm_And_imm(dbgi, block, op, 0xFF, 0);
249         } else if (src_bits == 16) {
250                 ir_node *lshift = new_bd_arm_Mov_reg_shift_imm(dbgi, block, op, ARM_SHF_LSL_IMM, 16);
251                 ir_node *rshift = new_bd_arm_Mov_reg_shift_imm(dbgi, block, lshift, ARM_SHF_LSR_IMM, 16);
252                 return rshift;
253         } else {
254                 panic("zero extension only supported for 8 and 16 bits");
255         }
256 }
257
258 /**
259  * Generate code for a sign extension.
260  */
261 static ir_node *gen_sign_extension(dbg_info *dbgi, ir_node *block, ir_node *op,
262                                    int src_bits)
263 {
264         int shift_width = 32 - src_bits;
265         ir_node *lshift_node = new_bd_arm_Mov_reg_shift_imm(dbgi, block, op, ARM_SHF_LSL_IMM, shift_width);
266         ir_node *rshift_node = new_bd_arm_Mov_reg_shift_imm(dbgi, block, lshift_node, ARM_SHF_ASR_IMM, shift_width);
267         return rshift_node;
268 }
269
270 static ir_node *gen_extension(dbg_info *dbgi, ir_node *block, ir_node *op,
271                               ir_mode *orig_mode)
272 {
273         int bits = get_mode_size_bits(orig_mode);
274         if (bits == 32)
275                 return op;
276
277         if (mode_is_signed(orig_mode)) {
278                 return gen_sign_extension(dbgi, block, op, bits);
279         } else {
280                 return gen_zero_extension(dbgi, block, op, bits);
281         }
282 }
283
284 /**
285  * returns true if it is assured, that the upper bits of a node are "clean"
286  * which means for a 16 or 8 bit value, that the upper bits in the register
287  * are 0 for unsigned and a copy of the last significant bit for signed
288  * numbers.
289  */
290 static bool upper_bits_clean(ir_node *transformed_node, ir_mode *mode)
291 {
292         (void) transformed_node;
293         (void) mode;
294         /* TODO */
295         return false;
296 }
297 #endif
298
299 static ir_node *gen_Phi(ir_node *node)
300 {
301         ir_mode                   *mode = get_irn_mode(node);
302         const arch_register_req_t *req;
303         if (mode_needs_gp_reg(mode)) {
304                 /* all integer operations are on 64bit registers now */
305                 mode = mode_Lu;
306                 req  = amd64_reg_classes[CLASS_amd64_gp].class_req;
307         } else {
308                 req = arch_no_register_req;
309         }
310
311         return be_transform_phi(node, req);
312 }
313
314 /**
315  * Transforms a Conv node.
316  *
317  * @return The created ia32 Conv node
318  */
319 static ir_node *gen_Conv(ir_node *node)
320 {
321         ir_node  *block    = be_transform_node(get_nodes_block(node));
322         ir_node  *op       = get_Conv_op(node);
323         ir_node  *new_op   = be_transform_node(op);
324         ir_mode  *src_mode = get_irn_mode(op);
325         ir_mode  *dst_mode = get_irn_mode(node);
326         dbg_info *dbgi     = get_irn_dbg_info(node);
327
328         if (src_mode == dst_mode)
329                 return new_op;
330
331         if (mode_is_float(src_mode) || mode_is_float(dst_mode)) {
332                 panic("float not supported yet");
333         } else { /* complete in gp registers */
334                 int src_bits = get_mode_size_bits(src_mode);
335                 int dst_bits = get_mode_size_bits(dst_mode);
336                 ir_mode *min_mode;
337
338                 if (src_bits == dst_bits) {
339                         /* kill unnecessary conv */
340                         return new_op;
341                 }
342
343                 if (src_bits < dst_bits) {
344                         min_mode = src_mode;
345                 } else {
346                         min_mode = dst_mode;
347                 }
348
349
350                 return new_bd_amd64_Conv(dbgi, block, new_op, min_mode);
351
352 #if 0
353                 if (upper_bits_clean(new_op, min_mode)) {
354                         return new_op;
355                 }
356
357                 if (mode_is_signed(min_mode)) {
358                         return gen_sign_extension(dbg, block, new_op, min_bits);
359                 } else {
360                         return gen_zero_extension(dbg, block, new_op, min_bits);
361                 }
362 #endif
363         }
364 }
365
366 /**
367  * Transforms a Store.
368  *
369  * @return the created AMD64 Store node
370  */
371 static ir_node *gen_Store(ir_node *node)
372 {
373         ir_node  *block    = be_transform_node(get_nodes_block(node));
374         ir_node  *ptr      = get_Store_ptr(node);
375         ir_node  *new_ptr  = be_transform_node(ptr);
376         ir_node  *mem      = get_Store_mem(node);
377         ir_node  *new_mem  = be_transform_node(mem);
378         ir_node  *val      = get_Store_value(node);
379         ir_node  *new_val  = be_transform_node(val);
380         ir_mode  *mode     = get_irn_mode(val);
381         dbg_info *dbgi     = get_irn_dbg_info(node);
382         ir_node *new_store = NULL;
383
384         if (mode_is_float(mode)) {
385                 panic("Float not supported yet");
386         } else {
387                 assert(mode_is_data(mode) && "unsupported mode for Store");
388                 new_store = new_bd_amd64_Store(dbgi, block, new_ptr, new_val, new_mem, 0);
389         }
390         set_irn_pinned(new_store, get_irn_pinned(node));
391         return new_store;
392 }
393
394 /**
395  * Transforms a Load.
396  *
397  * @return the created AMD64 Load node
398  */
399 static ir_node *gen_Load(ir_node *node)
400 {
401         ir_node  *block    = be_transform_node(get_nodes_block(node));
402         ir_node  *ptr      = get_Load_ptr(node);
403         ir_node  *new_ptr  = be_transform_node(ptr);
404         ir_node  *mem      = get_Load_mem(node);
405         ir_node  *new_mem  = be_transform_node(mem);
406         ir_mode  *mode     = get_Load_mode(node);
407         dbg_info *dbgi     = get_irn_dbg_info(node);
408         ir_node  *new_load = NULL;
409
410         if (mode_is_float(mode)) {
411                 panic("Float not supported yet");
412         } else {
413                 assert(mode_is_data(mode) && "unsupported mode for Load");
414                 new_load = new_bd_amd64_Load(dbgi, block, new_ptr, new_mem, 0);
415         }
416         set_irn_pinned(new_load, get_irn_pinned(node));
417
418 #if 0
419         /* check for special case: the loaded value might not be used */
420         if (be_get_Proj_for_pn(node, pn_Load_res) == NULL) {
421                 /* add a result proj and a Keep to produce a pseudo use */
422                 ir_node *proj = new_r_Proj(new_load, mode_Iu, pn_amd64_Load_res);
423                 be_new_Keep(block, 1, &proj);
424         }
425 #endif
426
427         return new_load;
428 }
429
430 /**
431  * Transform a Proj from a Load.
432  */
433 static ir_node *gen_Proj_Load(ir_node *node)
434 {
435         ir_node  *load     = get_Proj_pred(node);
436         ir_node  *new_load = be_transform_node(load);
437         dbg_info *dbgi     = get_irn_dbg_info(node);
438         long     proj      = get_Proj_proj(node);
439
440         /* renumber the proj */
441         switch (get_amd64_irn_opcode(new_load)) {
442                 case iro_amd64_Load:
443                         /* handle all gp loads equal: they have the same proj numbers. */
444                         if (proj == pn_Load_res) {
445                                 return new_rd_Proj(dbgi, new_load, mode_Lu, pn_amd64_Load_res);
446                         } else if (proj == pn_Load_M) {
447                                 return new_rd_Proj(dbgi, new_load, mode_M, pn_amd64_Load_M);
448                         }
449                 break;
450         /*
451                 case iro_sparc_fpaLoad:
452                         panic("FP not implemented yet");
453                 break;
454         */
455                 default:
456                         panic("Unsupported Proj from Load");
457         }
458
459     return be_duplicate_node(node);
460 }
461
462 /**
463  * Transform a Proj node.
464  */
465 static ir_node *gen_Proj(ir_node *node)
466 {
467         dbg_info *dbgi = get_irn_dbg_info(node);
468         ir_node  *pred = get_Proj_pred(node);
469         long     proj  = get_Proj_proj(node);
470
471     (void) dbgi;
472
473         if (is_Store(pred)) {
474                 if (proj == pn_Store_M) {
475                         return be_transform_node(pred);
476                 } else {
477                         panic("Unsupported Proj from Store");
478                 }
479         } else if (is_Load(pred)) {
480                 return gen_Proj_Load(node);
481 #if 0
482         } else if (be_is_SubSP(pred)) {
483                 //panic("gen_Proj not implemented for SubSP");
484                 return gen_Proj_be_SubSP(node);
485         } else if (be_is_AddSP(pred)) {
486                 //panic("gen_Proj not implemented for AddSP");
487                 return gen_Proj_be_AddSP(node);
488         } else if (is_Div(pred)) {
489                 return gen_Proj_Div(node);
490 #endif
491         } else if (is_Start(pred)) {
492 #if 0
493                 ir_graph *const irg = get_irn_irg(node);
494                 if (node == get_irg_anchor(irg, anchor_tls)) {
495                         return gen_Proj_tls(node);
496                 }
497         } else {
498                 ir_node *new_pred = be_transform_node(pred);
499                 ir_mode *mode     = get_irn_mode(node);
500                 if (mode_needs_gp_reg(mode)) {
501                         ir_node *new_proj = new_r_Proj(new_pred, mode_Iu, get_Proj_proj(node));
502                         new_proj->node_nr = node->node_nr;
503                         return new_proj;
504                 }
505 #endif
506         }
507
508     return be_duplicate_node(node);
509 }
510
511 /**
512  * Transforms a FrameAddr into an AMD64 Add.
513  */
514 static ir_node *gen_be_FrameAddr(ir_node *node)
515 {
516         ir_node   *block  = be_transform_node(get_nodes_block(node));
517         ir_entity *ent    = be_get_frame_entity(node);
518         ir_node   *fp     = be_get_FrameAddr_frame(node);
519         ir_node   *new_fp = be_transform_node(fp);
520         dbg_info  *dbgi   = get_irn_dbg_info(node);
521         ir_node   *new_node;
522
523         new_node = new_bd_amd64_FrameAddr(dbgi, block, new_fp, ent);
524         return new_node;
525 }
526
527 /* Boilerplate code for transformation: */
528
529 static void amd64_register_transformers(void)
530 {
531         be_start_transform_setup();
532
533         be_set_transform_function(op_Const,        gen_Const);
534         be_set_transform_function(op_SymConst,     gen_SymConst);
535         be_set_transform_function(op_Add,          gen_Add);
536         be_set_transform_function(op_Sub,          gen_Sub);
537         be_set_transform_function(op_Mul,          gen_Mul);
538         be_set_transform_function(op_be_Call,      gen_be_Call);
539         be_set_transform_function(op_be_FrameAddr, gen_be_FrameAddr);
540         be_set_transform_function(op_Conv,         gen_Conv);
541         be_set_transform_function(op_Jmp,          gen_Jmp);
542         be_set_transform_function(op_Cmp,          gen_Cmp);
543         be_set_transform_function(op_Cond,         gen_Cond);
544         be_set_transform_function(op_Phi,          gen_Phi);
545         be_set_transform_function(op_Load,         gen_Load);
546         be_set_transform_function(op_Store,        gen_Store);
547         be_set_transform_function(op_Proj,         gen_Proj);
548         be_set_transform_function(op_Minus,        gen_Minus);
549 }
550
551 void amd64_transform_graph(ir_graph *irg)
552 {
553         amd64_register_transformers();
554         be_transform_graph(irg, NULL);
555 }
556
557 void amd64_init_transform(void)
558 {
559         FIRM_DBG_REGISTER(dbg, "firm.be.amd64.transform");
560 }