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