initaler checkin SPARC backend
[libfirm] / ir / be / sparc / sparc_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 SPARC FIRM)
23  * @version $Id: TEMPLATE_transform.c 26673 2009-10-01 16:43:13Z matze $
24  */
25
26 #include "config.h"
27
28 #include "irnode_t.h"
29 #include "irgraph_t.h"
30 #include "irmode_t.h"
31 #include "irgmod.h"
32 #include "iredges.h"
33 #include "irvrfy.h"
34 #include "ircons.h"
35 #include "irprintf.h"
36 #include "dbginfo.h"
37 #include "iropt_t.h"
38 #include "debug.h"
39 #include "error.h"
40
41 #include "../benode.h"
42 #include "../beirg.h"
43 #include "../beutil.h"
44 #include "../betranshlp.h"
45 #include "bearch_sparc_t.h"
46
47 #include "sparc_nodes_attr.h"
48 #include "sparc_transform.h"
49 #include "sparc_new_nodes.h"
50 #include "gen_sparc_new_nodes.h"
51
52 #include "gen_sparc_regalloc_if.h"
53
54 #include <limits.h>
55
56 DEBUG_ONLY(static firm_dbg_module_t *dbg = NULL;)
57
58 static sparc_code_gen_t *env_cg;
59
60 static inline int mode_needs_gp_reg(ir_mode *mode)
61 {
62         return mode_is_int(mode) || mode_is_reference(mode);
63 }
64
65 /**
66  * Creates a possible DAG for a constant.
67  */
68 static ir_node *create_const_graph_value(dbg_info *dbgi, ir_node *block,
69                                 long value)
70 {
71         ir_node *result;
72
73         // TODO: find a better solution for this
74         if (value < -4096 || value > 4096) {
75                 panic("FIXME: immediate value exceeds max. size of simm13 (13 bits signed)");
76         }
77
78         result = new_bd_sparc_Mov_imm(dbgi, block, (int) value);
79         return result;
80 }
81
82
83 /**
84  * Create a DAG constructing a given Const.
85  *
86  * @param irn  a Firm const
87  */
88 static ir_node *create_const_graph(ir_node *irn, ir_node *block)
89 {
90         tarval  *tv = get_Const_tarval(irn);
91         ir_mode *mode = get_tarval_mode(tv);
92         long value;
93
94         if (mode_is_reference(mode)) {
95                 /* SPARC V8 is 32bit, so we can safely convert a reference tarval into Iu */
96                 assert(get_mode_size_bits(mode) == get_mode_size_bits(mode_Iu));
97                 tv = tarval_convert_to(tv, mode_Iu);
98         }
99         value = get_tarval_long(tv);
100         return create_const_graph_value(get_irn_dbg_info(irn), block, value);
101 }
102
103
104 typedef enum {
105         MATCH_NONE         = 0,
106         MATCH_COMMUTATIVE  = 1 << 0,
107         MATCH_SIZE_NEUTRAL = 1 << 1,
108 } match_flags_t;
109
110 typedef ir_node* (*new_binop_reg_func) (dbg_info *dbgi, ir_node *block, ir_node *op1, ir_node *op2);
111 typedef ir_node* (*new_binop_imm_func) (dbg_info *dbgi, ir_node *block, ir_node *op1, int simm13);
112
113 /**
114  * checks wether a node's value can be encoded as a immediate
115  * TODO: pass a result pointer to fetch the encoded immediate
116  *
117  */
118 static bool is_imm_encodeable(const ir_node *node)
119 {
120         long val;
121
122         if (!is_Const(node))
123                 return false;
124
125         val = get_tarval_long(get_Const_tarval(node));
126
127         return !(val < -4096 || val > 4096);
128 }
129
130 /**
131  * helper function for binop operations
132  *
133  * @param new_binop_reg_func register generation function ptr
134  * @param new_binop_imm_func immediate generation function ptr
135  */
136 static ir_node *gen_helper_binop(ir_node *node, match_flags_t flags,
137                                 new_binop_reg_func new_reg, new_binop_imm_func new_imm)
138 {
139         ir_node  *block   = be_transform_node(get_nodes_block(node));
140         ir_node  *op1     = get_binop_left(node);
141         ir_node  *new_op1;
142         ir_node  *op2     = get_binop_right(node);
143         ir_node  *new_op2;
144         dbg_info *dbgi    = get_irn_dbg_info(node);
145
146 /*
147     if (flags & MATCH_SIZE_NEUTRAL) {
148         op1 = arm_skip_downconv(op1);
149         op2 = arm_skip_downconv(op2);
150     } else {
151         assert(get_mode_size_bits(get_irn_mode(node)) == 32);
152     }
153 */
154         if (is_imm_encodeable(op2)) {
155                 ir_node *new_op1 = be_transform_node(op1);
156                 return new_imm(dbgi, block, new_op1, get_tarval_long(get_Const_tarval(node)));
157         }
158
159         new_op2 = be_transform_node(op2);
160
161         if ((flags & MATCH_COMMUTATIVE) && is_imm_encodeable(op1)) {
162                 return new_imm(dbgi, block, new_op2, get_tarval_long(get_Const_tarval(op1)) );
163         }
164
165         new_op1 = be_transform_node(op1);
166
167         return new_reg(dbgi, block, new_op1, new_op2);
168 }
169
170 /**
171  * Creates an sparc Add.
172  *
173  * @param node   FIRM node
174  * @return the created sparc Add node
175  */
176 static ir_node *gen_Add(ir_node *node)
177 {
178         ir_mode  *mode    = get_irn_mode(node);
179         ir_node  *block   = be_transform_node(get_nodes_block(node));
180         ir_node  *op1     = get_Add_left(node);
181         ir_node  *op2     = get_Add_right(node);
182         dbg_info *dbgi    = get_irn_dbg_info(node);
183         ir_node  *new_op1 = be_transform_node(op1);
184         ir_node  *new_op2 = be_transform_node(op2);
185
186         (void) new_op1;
187         (void) new_op2;
188         (void) block;
189         (void) dbgi;
190
191         if (mode_is_float(mode))
192                 panic("FP not implemented yet");
193
194         return gen_helper_binop(node, MATCH_COMMUTATIVE | MATCH_SIZE_NEUTRAL, new_bd_sparc_Add_reg, new_bd_sparc_Add_imm);
195 }
196
197
198 /**
199  * Creates an sparc Sub.
200  *
201  * @param node       FIRM node
202  * @return the created sparc Sub node
203  */
204 static ir_node *gen_Sub(ir_node *node)
205 {
206         ir_mode  *mode    = get_irn_mode(node);
207         ir_node  *block   = be_transform_node(get_nodes_block(node));
208         ir_node  *op1     = get_Add_left(node);
209         ir_node  *op2     = get_Add_right(node);
210         dbg_info *dbgi    = get_irn_dbg_info(node);
211         ir_node  *new_op1 = be_transform_node(op1);
212         ir_node  *new_op2 = be_transform_node(op2);
213
214         (void) new_op1;
215     (void) new_op2;
216     (void) block;
217     (void) dbgi;
218
219         if (mode_is_float(mode))
220                 panic("FP not implemented yet");
221
222         return gen_helper_binop(node, MATCH_SIZE_NEUTRAL, new_bd_sparc_Sub_reg, new_bd_sparc_Sub_imm);
223 }
224
225
226 /**
227  * Transforms a Load.
228  *
229  * @param node    the ir Load node
230  * @return the created sparc Load node
231  */
232 static ir_node *gen_Load(ir_node *node)
233 {
234
235         if (mode_is_float(get_irn_mode(node)))
236                 panic("SPARC: no fp implementation yet");
237
238         ir_mode  *mode     = get_Load_mode(node);
239         ir_node  *block    = be_transform_node(get_nodes_block(node));
240         ir_node  *ptr      = get_Load_ptr(node);
241         ir_node  *new_ptr  = be_transform_node(ptr);
242         ir_node  *mem      = get_Load_mem(node);
243         ir_node  *new_mem  = be_transform_node(mem);
244         dbg_info *dbgi      = get_irn_dbg_info(node);
245         ir_node  *new_load = NULL;
246
247         new_load = new_bd_sparc_Load(dbgi, block, new_ptr, new_mem, mode, NULL, 0, 0, false);
248         return new_load;
249 }
250
251
252
253 /**
254  * Transforms a Store.
255  *
256  * @param node    the ir Store node
257  * @return the created sparc Store node
258  */
259 static ir_node *gen_Store(ir_node *node)
260 {
261         if (mode_is_float(get_irn_mode(node)))
262                 panic("SPARC: no fp implmentation yet");
263
264         ir_node  *block    = be_transform_node(get_nodes_block(node));
265         ir_node  *ptr      = get_Store_ptr(node);
266         ir_node  *new_ptr  = be_transform_node(ptr);
267         ir_node  *mem      = get_Store_mem(node);
268         ir_node  *new_mem  = be_transform_node(mem);
269         ir_node  *val      = get_Store_value(node);
270         ir_node  *new_val  = be_transform_node(val);
271         ir_mode  *mode     = get_irn_mode(val);
272         dbg_info *dbgi     = get_irn_dbg_info(node);
273         ir_node *new_store = NULL;
274
275         new_store = new_bd_sparc_Store(dbgi, block, new_ptr, new_val, new_mem, mode, NULL, 0, 0, false);
276
277         return new_store;
278 }
279
280
281
282 /****** TRANSFORM GENERAL BACKEND NODES ********/
283
284 /**
285  * Transforms a Const node.
286  *
287  * @param node    the ir Store node
288  * @return The transformed sparc node.
289  */
290 static ir_node *gen_Const(ir_node *node) {
291         ir_node  *block = be_transform_node(get_nodes_block(node));
292         ir_mode *mode = get_irn_mode(node);
293         dbg_info *dbg = get_irn_dbg_info(node);
294
295         (void) dbg;
296
297         if (mode_is_float(mode)) {
298                 panic("FP not supported yet");
299         }
300         return create_const_graph(node, block);
301 }
302
303 /**
304  * AddSP
305  * @param node the ir AddSP node
306  * @return transformed sparc SAVE node
307  */
308 static ir_node *gen_be_AddSP(ir_node *node)
309 {
310         ir_node  *block  = be_transform_node(get_nodes_block(node));
311         ir_node  *sz     = get_irn_n(node, be_pos_AddSP_size);
312         ir_node  *new_sz = be_transform_node(sz);
313         ir_node  *sp     = get_irn_n(node, be_pos_AddSP_old_sp);
314         ir_node  *new_sp = be_transform_node(sp);
315         dbg_info *dbgi   = get_irn_dbg_info(node);
316         ir_node  *nomem  = new_NoMem();
317         ir_node  *new_op;
318
319         /* SPARC stack grows in reverse direction */
320         new_op = new_bd_sparc_AddSP(dbgi, block, new_sp, new_sz, nomem);
321
322         return new_op;
323 }
324
325
326 /**
327  * SubSP
328  * @param node the ir SubSP node
329  * @return transformed sparc SAVE node
330  */
331 static ir_node *gen_be_SubSP(ir_node *node)
332 {
333         ir_node  *block  = be_transform_node(get_nodes_block(node));
334         ir_node  *sz     = get_irn_n(node, be_pos_SubSP_size);
335         ir_node  *new_sz = be_transform_node(sz);
336         ir_node  *sp     = get_irn_n(node, be_pos_SubSP_old_sp);
337         ir_node  *new_sp = be_transform_node(sp);
338         dbg_info *dbgi   = get_irn_dbg_info(node);
339         ir_node  *nomem  = new_NoMem();
340         ir_node  *new_op;
341
342         /* SPARC stack grows in reverse direction */
343         new_op = new_bd_sparc_SubSP(dbgi, block, new_sp, new_sz, nomem);
344         return new_op;
345 }
346
347 /**
348  * transform FrameAddr
349  */
350 static ir_node *gen_be_FrameAddr(ir_node *node)
351 {
352         ir_node   *block  = be_transform_node(get_nodes_block(node));
353         ir_entity *ent    = be_get_frame_entity(node);
354         ir_node   *fp     = be_get_FrameAddr_frame(node);
355         ir_node   *new_fp = be_transform_node(fp);
356         dbg_info  *dbgi   = get_irn_dbg_info(node);
357         ir_node   *new_node;
358         new_node = new_bd_sparc_FrameAddr(dbgi, block, new_fp, ent);
359         return new_node;
360 }
361
362 /**
363  * Transform a be_Copy.
364  */
365 static ir_node *gen_be_Copy(ir_node *node) {
366         ir_node *result = be_duplicate_node(node);
367         ir_mode *mode   = get_irn_mode(result);
368
369         if (mode_needs_gp_reg(mode)) {
370                 set_irn_mode(node, mode_Iu);
371         }
372
373         return result;
374 }
375
376 /**
377  * Transform a Call
378  */
379 static ir_node *gen_be_Call(ir_node *node)
380 {
381         ir_node *res = be_duplicate_node(node);
382         arch_irn_add_flags(res, arch_irn_flags_modify_flags);
383         return res;
384 }
385
386 static ir_node *gen_SwitchJmp(ir_node *node)
387 {
388         panic("TODO: not implemented yet");
389 }
390
391 /**
392  * Transform Cond nodes
393  */
394 static ir_node *gen_Cond(ir_node *node)
395 {
396         ir_node  *selector = get_Cond_selector(node);
397         ir_mode  *mode     = get_irn_mode(selector);
398         ir_node  *block;
399         ir_node  *flag_node;
400         dbg_info *dbgi;
401
402         // switch/case jumps
403         if (mode != mode_b) {
404                 //return gen_SwitchJmp(node);
405                 panic("TODO: switchJmp not implemented yet");
406                 return node;
407         }
408
409         // regular if/else jumps
410         assert(is_Proj(selector));
411
412         block     = be_transform_node(get_nodes_block(node));
413         dbgi      = get_irn_dbg_info(node);
414         flag_node = be_transform_node(get_Proj_pred(selector));
415         return new_bd_sparc_Branch(dbgi, block, flag_node, get_Proj_proj(selector));
416 }
417
418 /**
419  * transform Cmp
420  */
421 static ir_node *gen_Cmp(ir_node *node)
422 {
423         ir_node  *block    = be_transform_node(get_nodes_block(node));
424         ir_node  *op1      = get_Cmp_left(node);
425         ir_node  *op2      = get_Cmp_right(node);
426         ir_mode  *cmp_mode = get_irn_mode(op1);
427         dbg_info *dbgi     = get_irn_dbg_info(node);
428         ir_node  *new_op1;
429         ir_node  *new_op2;
430         bool      is_unsigned;
431
432         if (mode_is_float(cmp_mode)) {
433                 panic("FloatCmp not implemented");
434         }
435
436         if (get_mode_size_bits(cmp_mode) != 32) {
437                 panic("CmpMode != 32bit not supported yet");
438         }
439
440         assert(get_irn_mode(op2) == cmp_mode);
441         is_unsigned = !mode_is_signed(cmp_mode);
442
443         /* compare with 0 can be done with Tst */
444         if (is_Const(op2) && tarval_is_null(get_Const_tarval(op2))) {
445                 new_op1 = be_transform_node(op1);
446                 //new_op1 = gen_extension(dbgi, block, new_op1, cmp_mode);
447                 //panic("TODO: implement Tst instruction");
448                 return new_bd_sparc_Tst(dbgi, block, new_op1, false,
449                                           is_unsigned);
450         }
451
452         if (is_Const(op1) && tarval_is_null(get_Const_tarval(op1))) {
453                 new_op2 = be_transform_node(op2);
454                 //new_op2 = gen_extension(dbgi, block, new_op2, cmp_mode);
455                 //panic("TODO: implement Tst instruction");
456                 return new_bd_sparc_Tst(dbgi, block, new_op2, true,
457                                           is_unsigned);
458         }
459
460         /* integer compare */
461         new_op1 = be_transform_node(op1);
462         //new_op1 = gen_extension(dbgi, block, new_op1, cmp_mode);
463         new_op2 = be_transform_node(op2);
464         //new_op2 = gen_extension(dbgi, block, new_op2, cmp_mode);
465         return new_bd_sparc_Cmp_reg(dbgi, block, new_op1, new_op2, false, is_unsigned);
466 }
467
468 /**
469  * Transforms a SymConst node.
470  */
471 static ir_node *gen_SymConst(ir_node *node)
472 {
473         ir_node   *block  = be_transform_node(get_nodes_block(node));
474         ir_entity *entity = get_SymConst_entity(node);
475         dbg_info  *dbgi   = get_irn_dbg_info(node);
476         ir_node   *new_node;
477
478         new_node = new_bd_sparc_SymConst(dbgi, block, entity);
479         be_dep_on_frame(new_node);
480         return new_node;
481 }
482
483 /**
484  * Transform some Phi nodes
485  */
486 static ir_node *gen_Phi(ir_node *node)
487 {
488         const arch_register_req_t *req;
489         ir_node  *block = be_transform_node(get_nodes_block(node));
490         ir_graph *irg   = current_ir_graph;
491         dbg_info *dbgi  = get_irn_dbg_info(node);
492         ir_mode  *mode  = get_irn_mode(node);
493         ir_node  *phi;
494
495         if (mode_needs_gp_reg(mode)) {
496                 /* we shouldn't have any 64bit stuff around anymore */
497                 assert(get_mode_size_bits(mode) <= 32);
498                 /* all integer operations are on 32bit registers now */
499                 mode = mode_Iu;
500                 req  = sparc_reg_classes[CLASS_sparc_gp].class_req;
501         } else {
502                 req = arch_no_register_req;
503         }
504
505         /* phi nodes allow loops, so we use the old arguments for now
506          * and fix this later */
507         phi = new_ir_node(dbgi, irg, block, op_Phi, mode, get_irn_arity(node),
508         get_irn_in(node) + 1);
509         copy_node_attr(node, phi);
510         be_duplicate_deps(node, phi);
511         arch_set_out_register_req(phi, 0, req);
512         be_enqueue_preds(node);
513         return phi;
514 }
515
516 /**
517  * the BAD transformer.
518  */
519 static ir_node *bad_transform(ir_node *irn)
520 {
521         panic("SPARC backend: Not implemented: %+F", irn);
522 }
523
524 /**
525  * Set a node emitter. Make it a bit more type safe.
526  */
527 static void set_transformer(ir_op *op, be_transform_func sparc_transform_func)
528 {
529         op->ops.generic = (op_func)sparc_transform_func;
530 }
531
532 /**
533  * configure transformation callbacks
534  */
535 void sparc_register_transformers(void)
536 {
537         clear_irp_opcodes_generic_func();
538         set_transformer(op_Add,                         gen_Add);
539         set_transformer(op_Store,                       gen_Store);
540         set_transformer(op_Const,                       gen_Const);
541         set_transformer(op_Load,                        gen_Load);
542         set_transformer(op_Sub,                         gen_Sub);
543
544         set_transformer(op_be_AddSP,     gen_be_AddSP);
545         set_transformer(op_be_SubSP,     gen_be_SubSP);
546         set_transformer(op_be_Copy,      gen_be_Copy);
547         set_transformer(op_be_Call,      gen_be_Call);
548         set_transformer(op_be_FrameAddr, gen_be_FrameAddr);
549
550         set_transformer(op_Cond,         gen_Cond);
551         set_transformer(op_Cmp,          gen_Cmp);
552
553         set_transformer(op_SymConst,     gen_SymConst);
554
555         set_transformer(op_Phi,          gen_Phi);
556
557         /* node list */
558         /*
559         set_transformer(op_Abs,          gen_Abs);
560         set_transformer(op_Add,          gen_Add);
561         set_transformer(op_And,          gen_And);
562         set_transformer(op_Const,        gen_Const);
563         set_transformer(op_Conv,         gen_Conv);
564         set_transformer(op_CopyB,        gen_CopyB);
565         set_transformer(op_Eor,          gen_Eor);
566         set_transformer(op_Jmp,          gen_Jmp);
567         set_transformer(op_Load,         gen_Load);
568         set_transformer(op_Minus,        gen_Minus);
569         set_transformer(op_Mul,          gen_Mul);
570         set_transformer(op_Not,          gen_Not);
571         set_transformer(op_Or,           gen_Or);
572         set_transformer(op_Proj,         gen_Proj);
573         set_transformer(op_Quot,         gen_Quot);
574         set_transformer(op_Rotl,         gen_Rotl);
575         set_transformer(op_Shl,          gen_Shl);
576         set_transformer(op_Shr,          gen_Shr);
577         set_transformer(op_Shrs,         gen_Shrs);
578         set_transformer(op_Store,        gen_Store);
579         set_transformer(op_Sub,          gen_Sub);
580         set_transformer(op_Unknown,      gen_Unknown);
581         */
582
583         set_transformer(op_ASM,       bad_transform);
584         set_transformer(op_Builtin,   bad_transform);
585         set_transformer(op_CallBegin, bad_transform);
586         set_transformer(op_Cast,      bad_transform);
587         set_transformer(op_Confirm,   bad_transform);
588         set_transformer(op_DivMod,    bad_transform);
589         set_transformer(op_EndExcept, bad_transform);
590         set_transformer(op_EndReg,    bad_transform);
591         set_transformer(op_Filter,    bad_transform);
592         set_transformer(op_Free,      bad_transform);
593         set_transformer(op_Id,        bad_transform);
594         set_transformer(op_InstOf,    bad_transform);
595         set_transformer(op_Mulh,      bad_transform);
596         set_transformer(op_Mux,       bad_transform);
597         set_transformer(op_Raise,     bad_transform);
598         set_transformer(op_Sel,       bad_transform);
599         set_transformer(op_Tuple,     bad_transform);
600 }
601
602
603 /**
604   * Pre-transform all unknown nodes.
605   */
606 static void sparc_pretransform_node(void)
607 {
608         sparc_code_gen_t *cg = env_cg;
609         (void) cg;
610         //cg->unknown_gp  = be_pre_transform_node(cg->unknown_gp);
611         //cg->unknown_fpa = be_pre_transform_node(cg->unknown_fpa);
612 }
613
614 /**
615  * Transform a Firm graph into a SPARC graph.
616  */
617 void sparc_transform_graph(sparc_code_gen_t *cg)
618 {
619         sparc_register_transformers();
620         env_cg = cg;
621         be_transform_graph(cg->birg, sparc_pretransform_node);
622 }
623
624 void sparc_init_transform(void)
625 {
626         FIRM_DBG_REGISTER(dbg, "firm.be.sparc.transform");
627 }