- fixed: new_r_Proj/new_rd_Proj args changed
[libfirm] / ir / be / sparc / bearch_sparc.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    The main sparc backend driver file.
23  * @version  $Id$
24  */
25
26 #include "config.h"
27
28 #include "lc_opts.h"
29 #include "lc_opts_enum.h"
30
31 #include "pseudo_irg.h"
32 #include "irgwalk.h"
33 #include "irprog.h"
34 #include "irprintf.h"
35 #include "ircons.h"
36 #include "irgmod.h"
37 #include "irgopt.h"
38 #include "iroptimize.h"
39 #include "lowering.h"
40 #include "error.h"
41
42 #include "bitset.h"
43 #include "debug.h"
44 #include "array_t.h"
45 #include "irtools.h"
46
47 #include "../bearch.h"
48 #include "../benode.h"
49 #include "../belower.h"
50 #include "../besched.h"
51 #include "be.h"
52 #include "../beabi.h"
53 #include "../bemachine.h"
54 #include "../beilpsched.h"
55 #include "../bemodule.h"
56 #include "../beirg.h"
57 #include "../bespillslots.h"
58 #include "../begnuas.h"
59 #include "../belistsched.h"
60 #include "../beflags.h"
61
62 #include "bearch_sparc_t.h"
63 #include "bearch_sparc.h"
64
65 #include "sparc_new_nodes.h"
66 #include "gen_sparc_regalloc_if.h"
67 #include "sparc_transform.h"
68 #include "sparc_emitter.h"
69 #include "sparc_map_regs.h"
70
71 DEBUG_ONLY(static firm_dbg_module_t *dbg = NULL;)
72
73 static arch_irn_class_t sparc_classify(const ir_node *irn)
74 {
75         (void) irn;
76         return 0;
77 }
78
79 static ir_entity *sparc_get_frame_entity(const ir_node *irn)
80 {
81         const sparc_attr_t *attr = get_sparc_attr_const(irn);
82
83         if (is_sparc_FrameAddr(irn)) {
84                 const sparc_symconst_attr_t *attr = get_irn_generic_attr_const(irn);
85                 return attr->entity;
86         }
87
88         if (attr->is_load_store) {
89                 const sparc_load_store_attr_t *load_store_attr = get_sparc_load_store_attr_const(irn);
90                 if (load_store_attr->is_frame_entity) {
91                         return load_store_attr->entity;
92                 }
93         }
94
95         return NULL;
96 }
97
98 static void sparc_set_frame_entity(ir_node *node, ir_entity *ent)
99 {
100         (void) node;
101         (void) ent;
102         panic("sparc_set_frame_entity() called. This should not happen.");
103         /* TODO: set the ir_entity assigned to the frame */
104 }
105
106 /**
107  * This function is called by the generic backend to correct offsets for
108  * nodes accessing the stack.
109  */
110 static void sparc_set_frame_offset(ir_node *irn, int offset)
111 {
112         if (is_sparc_FrameAddr(irn)) {
113                 sparc_symconst_attr_t *attr = get_irn_generic_attr(irn);
114                 attr->fp_offset += offset;
115         } else {
116                 sparc_load_store_attr_t *attr = get_sparc_load_store_attr(irn);
117                 assert(attr->base.is_load_store);
118                 attr->offset += offset;
119         }
120 }
121
122 static int sparc_get_sp_bias(const ir_node *irn)
123 {
124         (void) irn;
125         return SPARC_MIN_STACKSIZE;
126 }
127
128 /* fill register allocator interface */
129
130 static const arch_irn_ops_t sparc_irn_ops = {
131         get_sparc_in_req,
132         sparc_classify,
133         sparc_get_frame_entity,
134         sparc_set_frame_entity,
135         sparc_set_frame_offset,
136         sparc_get_sp_bias,
137         NULL,    /* get_inverse             */
138         NULL,    /* get_op_estimated_cost   */
139         NULL,    /* possible_memory_operand */
140         NULL,    /* perform_memory_operand  */
141 };
142
143
144
145 /**
146  * Transforms the standard firm graph into
147  * a SPARC firm graph
148  */
149 static void sparc_prepare_graph(void *self)
150 {
151         sparc_code_gen_t *cg = self;
152
153         /* transform FIRM into SPARC asm nodes */
154         sparc_transform_graph(cg);
155
156         if (cg->dump)
157                 be_dump(cg->irg, "-transformed", dump_ir_block_graph_sched);
158 }
159
160
161
162 static ir_node *sparc_flags_remat(ir_node *node, ir_node *after)
163 {
164         ir_node *block;
165         ir_node *copy;
166
167         if (is_Block(after)) {
168                 block = after;
169         } else {
170                 block = get_nodes_block(after);
171         }
172         copy = exact_copy(node);
173         set_nodes_block(copy, block);
174         sched_add_after(after, copy);
175         return copy;
176 }
177
178 static void sparc_before_ra(void *self)
179 {
180         sparc_code_gen_t *cg = self;
181         /* fixup flags register */
182         be_sched_fix_flags(cg->birg, &sparc_reg_classes[CLASS_sparc_flags], &sparc_flags_remat);
183 }
184
185 /**
186  * transform reload node => load
187  */
188 static void transform_Reload(ir_node *node)
189 {
190         ir_graph  *irg    = get_irn_irg(node);
191         ir_node   *block  = get_nodes_block(node);
192         dbg_info  *dbgi   = get_irn_dbg_info(node);
193         ir_node   *ptr    = get_irg_frame(irg);
194         ir_node   *mem    = get_irn_n(node, be_pos_Reload_mem);
195         ir_mode   *mode   = get_irn_mode(node);
196         ir_entity *entity = be_get_frame_entity(node);
197         const arch_register_t *reg;
198         ir_node   *proj;
199         ir_node   *load;
200
201         ir_node  *sched_point = sched_prev(node);
202
203         load = new_bd_sparc_Load(dbgi, block, ptr, mem, mode, entity, false, 0, true);
204         sched_add_after(sched_point, load);
205         sched_remove(node);
206
207         proj = new_rd_Proj(dbgi, load, mode, pn_sparc_Load_res);
208
209         reg = arch_get_irn_register(node);
210         arch_set_irn_register(proj, reg);
211
212         exchange(node, proj);
213 }
214
215 /**
216  * transform spill node => store
217  */
218 static void transform_Spill(ir_node *node)
219 {
220         ir_graph  *irg    = get_irn_irg(node);
221         ir_node   *block  = get_nodes_block(node);
222         dbg_info  *dbgi   = get_irn_dbg_info(node);
223         ir_node   *ptr    = get_irg_frame(irg);
224         ir_node   *mem    = new_NoMem();
225         ir_node   *val    = get_irn_n(node, be_pos_Spill_val);
226         ir_mode   *mode   = get_irn_mode(val);
227         ir_entity *entity = be_get_frame_entity(node);
228         ir_node   *sched_point;
229         ir_node   *store;
230
231         sched_point = sched_prev(node);
232         store = new_bd_sparc_Store(dbgi, block, ptr, val, mem, mode, entity, false, 0, true);
233         sched_remove(node);
234         sched_add_after(sched_point, store);
235
236         exchange(node, store);
237 }
238
239 /**
240  * walker to transform be_Spill and be_Reload nodes
241  */
242 static void sparc_after_ra_walker(ir_node *block, void *data)
243 {
244         ir_node *node, *prev;
245         (void) data;
246
247         for (node = sched_last(block); !sched_is_begin(node); node = prev) {
248                 prev = sched_prev(node);
249
250                 if (be_is_Reload(node)) {
251                         transform_Reload(node);
252                 } else if (be_is_Spill(node)) {
253                         transform_Spill(node);
254                 }
255         }
256 }
257
258
259 static void sparc_after_ra(void *self)
260 {
261         sparc_code_gen_t *cg = self;
262         be_coalesce_spillslots(cg->birg);
263
264         irg_block_walk_graph(cg->irg, NULL, sparc_after_ra_walker, NULL);
265 }
266
267
268
269 /**
270  * Emits the code, closes the output file and frees
271  * the code generator interface.
272  */
273 static void sparc_emit_and_done(void *self)
274 {
275         sparc_code_gen_t *cg = self;
276         ir_graph           *irg = cg->irg;
277
278         sparc_gen_routine(cg, irg);
279
280         /* de-allocate code generator */
281         free(cg);
282 }
283
284 static void *sparc_cg_init(be_irg_t *birg);
285
286 static const arch_code_generator_if_t sparc_code_gen_if = {
287         sparc_cg_init,
288         NULL,                    /* get_pic_base hook */
289         NULL,                    /* before abi introduce hook */
290         sparc_prepare_graph,
291         NULL,                    /* spill hook */
292         sparc_before_ra,      /* before register allocation hook */
293         sparc_after_ra,       /* after register allocation hook */
294         NULL,
295         sparc_emit_and_done
296 };
297
298 /**
299  * Initializes the code generator.
300  */
301 static void *sparc_cg_init(be_irg_t *birg)
302 {
303         static ir_type *int_tp = NULL;
304         sparc_isa_t      *isa = (sparc_isa_t *)birg->main_env->arch_env;
305         sparc_code_gen_t *cg;
306
307         if (! int_tp) {
308                 /* create an integer type with machine size */
309                 int_tp = new_type_primitive(mode_Is);
310         }
311
312         cg                               = XMALLOC(sparc_code_gen_t);
313         cg->impl                                = &sparc_code_gen_if;
314         cg->irg                         = birg->irg;
315         //cg->reg_set                           = new_set(arm_cmp_irn_reg_assoc, 1024);
316         cg->isa                         = isa;
317         cg->birg                                = birg;
318         //cg->int_tp                            = int_tp;
319         //cg->have_fp_insn      = 0;
320         //cg->unknown_gp                = NULL;
321         //cg->unknown_fpa               = NULL;
322         cg->dump                                = (birg->main_env->options->dump_flags & DUMP_BE) ? 1 : 0;
323
324         /* enter the current code generator */
325         isa->cg = cg;
326
327         return (arch_code_generator_t *)cg;
328 }
329
330
331
332 const arch_isa_if_t sparc_isa_if;
333 static sparc_isa_t sparc_isa_template = {
334         {
335                 &sparc_isa_if,             /* isa interface implementation */
336                 &sparc_gp_regs[REG_SP],  /* stack pointer register */
337                 &sparc_gp_regs[REG_FP],  /* base pointer register */
338                 &sparc_reg_classes[CLASS_sparc_gp],  /* link pointer register class */
339                 -1,                          /* stack direction */
340                 1,                           /* power of two stack alignment for calls, 2^2 == 4 */
341                 NULL,                        /* main environment */
342                 7,                           /* costs for a spill instruction */
343                 5,                           /* costs for a reload instruction */
344         },
345         NULL                                            /* current code generator */
346 };
347
348 /**
349  * Initializes the backend ISA
350  */
351 static arch_env_t *sparc_init(FILE *outfile)
352 {
353         static int run_once = 0;
354         sparc_isa_t *isa;
355
356         if (run_once)
357                 return NULL;
358         run_once = 1;
359
360         isa = XMALLOC(sparc_isa_t);
361         memcpy(isa, &sparc_isa_template, sizeof(*isa));
362
363         be_emit_init(outfile);
364
365         sparc_register_init();
366         sparc_create_opcodes(&sparc_irn_ops);
367
368         return &isa->arch_env;
369 }
370
371
372
373 /**
374  * Closes the output file and frees the ISA structure.
375  */
376 static void sparc_done(void *self)
377 {
378         sparc_isa_t *isa = self;
379
380         /* emit now all global declarations */
381         be_gas_emit_decls(isa->arch_env.main_env);
382
383         be_emit_exit();
384         free(self);
385 }
386
387
388 static unsigned sparc_get_n_reg_class(void)
389 {
390         return N_CLASSES;
391 }
392
393 static const arch_register_class_t *sparc_get_reg_class(unsigned i)
394 {
395         assert(i < N_CLASSES);
396         return &sparc_reg_classes[i];
397 }
398
399
400
401 /**
402  * Get the register class which shall be used to store a value of a given mode.
403  * @param self The this pointer.
404  * @param mode The mode in question.
405  * @return A register class which can hold values of the given mode.
406  */
407 static const arch_register_class_t *sparc_get_reg_class_for_mode(const ir_mode *mode)
408 {
409         if (mode_is_float(mode))
410                 return &sparc_reg_classes[CLASS_sparc_fp];
411         else
412                 return &sparc_reg_classes[CLASS_sparc_gp];
413 }
414
415
416
417 typedef struct {
418         be_abi_call_flags_bits_t flags;
419         const arch_env_t *arch_env;
420         ir_graph *irg;
421 } sparc_abi_env_t;
422
423 static void *sparc_abi_init(const be_abi_call_t *call, const arch_env_t *arch_env, ir_graph *irg)
424 {
425         sparc_abi_env_t *env = XMALLOC(sparc_abi_env_t);
426         be_abi_call_flags_t fl = be_abi_call_get_flags(call);
427         env->flags    = fl.bits;
428         env->irg      = irg;
429         env->arch_env = arch_env;
430         return env;
431 }
432
433 /**
434  * Get the between type for that call.
435  * @param self The callback object.
436  * @return The between type of for that call.
437  */
438 static ir_type *sparc_get_between_type(void *self)
439 {
440         static ir_type *between_type = NULL;
441         (void) self;
442
443         if (between_type == NULL) {
444                 between_type = new_type_class(new_id_from_str("sparc_between_type"));
445                 set_type_size_bytes(between_type, 0);
446         }
447
448         return between_type;
449 }
450
451
452 /**
453  * Build the prolog, return the BASE POINTER register
454  */
455 static const arch_register_t *sparc_abi_prologue(void *self, ir_node **mem,
456                                                     pmap *reg_map, int *stack_bias)
457 {
458         sparc_abi_env_t *env = self;
459         ir_node *block = get_irg_start_block(env->irg);
460         const arch_register_t *fp = &sparc_gp_regs[REG_FP];
461         const arch_register_t *sp = &sparc_gp_regs[REG_SP];
462
463         // sp
464         ir_node *sp_proj = be_abi_reg_map_get(reg_map, sp);
465
466
467         //ir_type *frame_type = get_irg_frame_type(env->irg);
468         //frame_alloc_area(frame_type, reserved_stack_size, 1, 1);
469
470         (void) reg_map;
471         (void) mem;
472         (void) stack_bias;
473
474         // alloc min required stack space
475         // TODO: the min stacksize depends on wether this is a leaf procedure or not
476         ir_node *save = new_bd_sparc_Save(NULL, block, sp_proj, *mem, SPARC_MIN_STACKSIZE);
477
478         *stack_bias -= SPARC_MIN_STACKSIZE;
479         sp_proj = new_r_Proj(save, sp->reg_class->mode, pn_sparc_Save_stack);
480         *mem    = new_r_Proj(save, mode_M, pn_sparc_Save_mem);
481
482         arch_set_irn_register(sp_proj, sp);
483         be_abi_reg_map_set(reg_map, sp, sp_proj);
484
485         // we always have a framepointer
486         return fp;
487 }
488
489 /* Build the epilog */
490 static void sparc_abi_epilogue(void *self, ir_node *bl, ir_node **mem,
491                                   pmap *reg_map)
492 {
493         (void) self;
494         (void) bl;
495         (void) mem;
496         (void) reg_map;
497 }
498
499 static const be_abi_callbacks_t sparc_abi_callbacks = {
500         sparc_abi_init,
501         free,
502         sparc_get_between_type,
503         sparc_abi_prologue,
504         sparc_abi_epilogue,
505 };
506
507 /**
508  * Get the ABI restrictions for procedure calls.
509  * @param self        The this pointer.
510  * @param method_type The type of the method (procedure) in question.
511  * @param abi         The abi object to be modified
512  */
513 static void sparc_get_call_abi(const void *self, ir_type *method_type,
514                                be_abi_call_t *abi)
515 {
516         ir_type  *tp;
517         ir_mode  *mode;
518         int       i, n = get_method_n_params(method_type);
519         be_abi_call_flags_t call_flags;
520         (void) self;
521
522         /* set abi flags for calls */
523         call_flags.bits.left_to_right         = 0;
524         call_flags.bits.store_args_sequential = 1;
525         /* */
526         call_flags.bits.try_omit_fp           = 0;
527         call_flags.bits.fp_free               = 0;
528         call_flags.bits.call_has_imm          = 1;
529
530         /* set stack parameter passing style */
531         be_abi_call_set_flags(abi, call_flags, &sparc_abi_callbacks);
532
533         for (i = 0; i < n; i++) {
534                 /* reg = get reg for param i;          */
535                 /* be_abi_call_param_reg(abi, i, reg); */
536
537                 /* pass outgoing params 0-5 via registers, remaining via stack */
538                 /* on sparc we need to set the ABI context since register names of parameters change to i0-i5 if we are the callee */
539                 if (i < 6) {
540                         be_abi_call_param_reg(abi, i, sparc_get_RegParamOut_reg(i), ABI_CONTEXT_CALLER);
541                         be_abi_call_param_reg(abi, i, sparc_get_RegParamIn_reg(i), ABI_CONTEXT_CALLEE);
542                 } else {
543                         tp   = get_method_param_type(method_type, i);
544                         mode = get_type_mode(tp);
545                         be_abi_call_param_stack(abi, i, mode, 4, 0, 0, ABI_CONTEXT_BOTH); /*< stack args have no special context >*/
546                 }
547         }
548
549         /* set return value register: return value is in i0 resp. f0 */
550         if (get_method_n_ress(method_type) > 0) {
551                 tp   = get_method_res_type(method_type, 0);
552                 mode = get_type_mode(tp);
553
554                 be_abi_call_res_reg(abi, 0,
555                         mode_is_float(mode) ? &sparc_fp_regs[REG_F0] : &sparc_gp_regs[REG_I0], ABI_CONTEXT_CALLEE); /*< return has no special context >*/
556
557                 be_abi_call_res_reg(abi, 0,
558                                         mode_is_float(mode) ? &sparc_fp_regs[REG_F0] : &sparc_gp_regs[REG_O0], ABI_CONTEXT_CALLER); /*< return has no special context >*/
559         }
560 }
561
562 static int sparc_to_appear_in_schedule(void *block_env, const ir_node *irn)
563 {
564         (void) block_env;
565
566         if (!is_sparc_irn(irn))
567                 return -1;
568
569         return 1;
570 }
571
572 /**
573  * Initializes the code generator interface.
574  */
575 static const arch_code_generator_if_t *sparc_get_code_generator_if(
576                 void *self)
577 {
578         (void) self;
579         return &sparc_code_gen_if;
580 }
581
582 list_sched_selector_t sparc_sched_selector;
583
584 /**
585  * Returns the reg_pressure scheduler with to_appear_in_schedule() overloaded
586  */
587 static const list_sched_selector_t *sparc_get_list_sched_selector(
588                 const void *self, list_sched_selector_t *selector)
589 {
590         (void) self;
591         (void) selector;
592
593         sparc_sched_selector = trivial_selector;
594         sparc_sched_selector.to_appear_in_schedule = sparc_to_appear_in_schedule;
595         return &sparc_sched_selector;
596 }
597
598 static const ilp_sched_selector_t *sparc_get_ilp_sched_selector(
599                 const void *self)
600 {
601         (void) self;
602         return NULL;
603 }
604
605 /**
606  * Returns the necessary byte alignment for storing a register of given class.
607  */
608 static int sparc_get_reg_class_alignment(const arch_register_class_t *cls)
609 {
610         ir_mode *mode = arch_register_class_mode(cls);
611         return get_mode_size_bytes(mode);
612 }
613
614 /**
615  * Returns the libFirm configuration parameter for this backend.
616  */
617 static const backend_params *sparc_get_backend_params(void)
618 {
619         static backend_params p = {
620                 0,     /* no dword lowering */
621                 0,     /* no inline assembly */
622                 NULL,  /* will be set later */
623                 NULL,  /* no creator function */
624                 NULL,  /* context for create_intrinsic_fkt */
625                 NULL,  /* parameter for if conversion */
626                 NULL,  /* float arithmetic mode */
627                 0,     /* no trampoline support: size 0 */
628                 0,     /* no trampoline support: align 0 */
629                 NULL,  /* no trampoline support: no trampoline builder */
630                 4      /* alignment of stack parameter: typically 4 (32bit) or 8 (64bit) */
631         };
632         return &p;
633 }
634
635 static const be_execution_unit_t ***sparc_get_allowed_execution_units(
636                 const ir_node *irn)
637 {
638         (void) irn;
639         /* TODO */
640         panic("sparc_get_allowed_execution_units not implemented yet");
641 }
642
643 static const be_machine_t *sparc_get_machine(const void *self)
644 {
645         (void) self;
646         /* TODO */
647         panic("sparc_get_machine not implemented yet");
648 }
649
650 static ir_graph **sparc_get_backend_irg_list(const void *self,
651                                                 ir_graph ***irgs)
652 {
653         (void) self;
654         (void) irgs;
655         return NULL;
656 }
657
658 static asm_constraint_flags_t sparc_parse_asm_constraint(const char **c)
659 {
660         (void) c;
661         return ASM_CONSTRAINT_FLAG_INVALID;
662 }
663
664 static int sparc_is_valid_clobber(const char *clobber)
665 {
666         (void) clobber;
667         return 0;
668 }
669
670 const arch_isa_if_t sparc_isa_if = {
671         sparc_init,
672         sparc_done,
673         NULL,                /* handle intrinsics */
674         sparc_get_n_reg_class,
675         sparc_get_reg_class,
676         sparc_get_reg_class_for_mode,
677         sparc_get_call_abi,
678         sparc_get_code_generator_if,
679         sparc_get_list_sched_selector,
680         sparc_get_ilp_sched_selector,
681         sparc_get_reg_class_alignment,
682     sparc_get_backend_params,
683         sparc_get_allowed_execution_units,
684         sparc_get_machine,
685         sparc_get_backend_irg_list,
686         NULL,                    /* mark remat */
687         sparc_parse_asm_constraint,
688         sparc_is_valid_clobber
689 };
690
691 BE_REGISTER_MODULE_CONSTRUCTOR(be_init_arch_sparc);
692 void be_init_arch_sparc(void)
693 {
694         be_register_isa_if("sparc", &sparc_isa_if);
695         FIRM_DBG_REGISTER(dbg, "firm.be.sparc.cg");
696         sparc_init_transform();
697         sparc_init_emitter();
698 }