backend_marked was a buggy/wrong concept, removed it
[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         /* enter the current code generator */
336         isa->cg = cg;
337
338         return (arch_code_generator_t *)cg;
339 }
340
341
342
343 const arch_isa_if_t sparc_isa_if;
344 static sparc_isa_t sparc_isa_template = {
345         {
346                 &sparc_isa_if,             /* isa interface implementation */
347                 &sparc_gp_regs[REG_SP],  /* stack pointer register */
348                 &sparc_gp_regs[REG_FP],  /* base pointer register */
349                 &sparc_reg_classes[CLASS_sparc_gp],  /* link pointer register class */
350                 -1,                          /* stack direction */
351                 1,                           /* power of two stack alignment for calls, 2^2 == 4 */
352                 NULL,                        /* main environment */
353                 7,                           /* costs for a spill instruction */
354                 5,                           /* costs for a reload instruction */
355         },
356         NULL                                            /* current code generator */
357 };
358
359 /**
360  * Initializes the backend ISA
361  */
362 static arch_env_t *sparc_init(FILE *outfile)
363 {
364         static int run_once = 0;
365         sparc_isa_t *isa;
366
367         if(run_once)
368                 return NULL;
369         run_once = 1;
370
371         isa = XMALLOC(sparc_isa_t);
372         memcpy(isa, &sparc_isa_template, sizeof(*isa));
373
374         be_emit_init(outfile);
375
376         sparc_register_init();
377         sparc_create_opcodes(&sparc_irn_ops);
378
379         return &isa->arch_env;
380 }
381
382
383
384 /**
385  * Closes the output file and frees the ISA structure.
386  */
387 static void sparc_done(void *self)
388 {
389         sparc_isa_t *isa = self;
390
391         /* emit now all global declarations */
392         be_gas_emit_decls(isa->arch_env.main_env);
393
394         be_emit_exit();
395         free(self);
396 }
397
398
399 static unsigned sparc_get_n_reg_class(void)
400 {
401         return N_CLASSES;
402 }
403
404 static const arch_register_class_t *sparc_get_reg_class(unsigned i)
405 {
406         assert(i < N_CLASSES);
407         return &sparc_reg_classes[i];
408 }
409
410
411
412 /**
413  * Get the register class which shall be used to store a value of a given mode.
414  * @param self The this pointer.
415  * @param mode The mode in question.
416  * @return A register class which can hold values of the given mode.
417  */
418 const arch_register_class_t *sparc_get_reg_class_for_mode(const ir_mode *mode)
419 {
420         if (mode_is_float(mode))
421                 return &sparc_reg_classes[CLASS_sparc_fp];
422         else
423                 return &sparc_reg_classes[CLASS_sparc_gp];
424 }
425
426
427
428 typedef struct {
429         be_abi_call_flags_bits_t flags;
430         const arch_env_t *arch_env;
431         ir_graph *irg;
432 } sparc_abi_env_t;
433
434 static void *sparc_abi_init(const be_abi_call_t *call, const arch_env_t *arch_env, ir_graph *irg)
435 {
436         sparc_abi_env_t *env = XMALLOC(sparc_abi_env_t);
437         be_abi_call_flags_t fl = be_abi_call_get_flags(call);
438         env->flags    = fl.bits;
439         env->irg      = irg;
440         env->arch_env = arch_env;
441         return env;
442 }
443
444 /**
445  * Get the between type for that call.
446  * @param self The callback object.
447  * @return The between type of for that call.
448  */
449 static ir_type *sparc_get_between_type(void *self)
450 {
451         static ir_type *between_type = NULL;
452         (void) self;
453
454         if (between_type == NULL) {
455                 between_type = new_type_class(new_id_from_str("sparc_between_type"));
456                 set_type_size_bytes(between_type, 0);
457         }
458
459         return between_type;
460 }
461
462 /**
463  * Build the prolog, return the BASE POINTER register
464  */
465 static const arch_register_t *sparc_abi_prologue(void *self, ir_node **mem,
466                                                     pmap *reg_map, int *stack_bias)
467 {
468         sparc_abi_env_t *env = self;
469         (void) reg_map;
470         (void) mem;
471         (void) stack_bias;
472
473         if(env->flags.try_omit_fp)
474                 return env->arch_env->sp;
475
476         //panic("framepointer not implemented yet");
477         return env->arch_env->bp;
478 }
479
480 /* Build the epilog */
481 static void sparc_abi_epilogue(void *self, ir_node *bl, ir_node **mem,
482                                   pmap *reg_map)
483 {
484         (void) self;
485         (void) bl;
486         (void) mem;
487         (void) reg_map;
488 }
489
490 static const be_abi_callbacks_t sparc_abi_callbacks = {
491         sparc_abi_init,
492         free,
493         sparc_get_between_type,
494         sparc_abi_prologue,
495         sparc_abi_epilogue,
496 };
497
498 /**
499  * Get the ABI restrictions for procedure calls.
500  * @param self        The this pointer.
501  * @param method_type The type of the method (procedure) in question.
502  * @param abi         The abi object to be modified
503  */
504 void sparc_get_call_abi(const void *self, ir_type *method_type,
505                            be_abi_call_t *abi)
506 {
507         ir_type  *tp;
508         ir_mode  *mode;
509         int       i, n = get_method_n_params(method_type);
510         be_abi_call_flags_t call_flags;
511         (void) self;
512
513         /* set abi flags for calls */
514         call_flags.bits.left_to_right         = 0;
515         call_flags.bits.store_args_sequential = 1;
516         call_flags.bits.try_omit_fp           = 1;
517         call_flags.bits.fp_free               = 0;
518         call_flags.bits.call_has_imm          = 1;
519
520         /* set stack parameter passing style */
521         be_abi_call_set_flags(abi, call_flags, &sparc_abi_callbacks);
522
523         for (i = 0; i < n; i++) {
524                 /* reg = get reg for param i;          */
525                 /* be_abi_call_param_reg(abi, i, reg); */
526
527                 /* pass args 0-5 via registers, remaining via stack */
528                 if (i < 6) {
529                         be_abi_call_param_reg(abi, i, sparc_get_RegParam_reg(i));
530                 } else {
531                         tp   = get_method_param_type(method_type, i);
532                         mode = get_type_mode(tp);
533                         be_abi_call_param_stack(abi, i, mode, 4, 0, 0);
534                 }
535         }
536
537         /* TODO: set correct return register */
538         /* default: return value is in O0 resp. F0 */
539         if (get_method_n_ress(method_type) > 0) {
540                 tp   = get_method_res_type(method_type, 0);
541                 mode = get_type_mode(tp);
542
543                 be_abi_call_res_reg(abi, 0,
544                         mode_is_float(mode) ? &sparc_fp_regs[REG_F0] : &sparc_gp_regs[REG_O0]);
545         }
546 }
547
548 int sparc_to_appear_in_schedule(void *block_env, const ir_node *irn)
549 {
550         (void) block_env;
551
552         if(!is_sparc_irn(irn))
553                 return -1;
554
555         return 1;
556 }
557
558 /**
559  * Initializes the code generator interface.
560  */
561 static const arch_code_generator_if_t *sparc_get_code_generator_if(
562                 void *self)
563 {
564         (void) self;
565         return &sparc_code_gen_if;
566 }
567
568 list_sched_selector_t sparc_sched_selector;
569
570 /**
571  * Returns the reg_pressure scheduler with to_appear_in_schedule() overloaded
572  */
573 static const list_sched_selector_t *sparc_get_list_sched_selector(
574                 const void *self, list_sched_selector_t *selector)
575 {
576         (void) self;
577         (void) selector;
578
579         sparc_sched_selector = trivial_selector;
580         sparc_sched_selector.to_appear_in_schedule = sparc_to_appear_in_schedule;
581         return &sparc_sched_selector;
582 }
583
584 static const ilp_sched_selector_t *sparc_get_ilp_sched_selector(
585                 const void *self)
586 {
587         (void) self;
588         return NULL;
589 }
590
591 /**
592  * Returns the necessary byte alignment for storing a register of given class.
593  */
594 static int sparc_get_reg_class_alignment(const arch_register_class_t *cls)
595 {
596         ir_mode *mode = arch_register_class_mode(cls);
597         return get_mode_size_bytes(mode);
598 }
599
600 /**
601  * Returns the libFirm configuration parameter for this backend.
602  */
603 static const backend_params *sparc_get_backend_params(void) {
604         static backend_params p = {
605                 0,     /* no dword lowering */
606                 0,     /* no inline assembly */
607                 NULL,  /* will be set later */
608                 NULL,  /* no creator function */
609                 NULL,  /* context for create_intrinsic_fkt */
610                 NULL,  /* parameter for if conversion */
611                 NULL,  /* float arithmetic mode */
612                 0,     /* no trampoline support: size 0 */
613                 0,     /* no trampoline support: align 0 */
614                 NULL,  /* no trampoline support: no trampoline builder */
615                 4      /* alignment of stack parameter: typically 4 (32bit) or 8 (64bit) */
616         };
617         return &p;
618 }
619
620 static const be_execution_unit_t ***sparc_get_allowed_execution_units(
621                 const ir_node *irn)
622 {
623         (void) irn;
624         /* TODO */
625         assert(0);
626         return NULL;
627 }
628
629 static const be_machine_t *sparc_get_machine(const void *self)
630 {
631         (void) self;
632         /* TODO */
633         assert(0);
634         return NULL;
635 }
636
637 static ir_graph **sparc_get_backend_irg_list(const void *self,
638                                                 ir_graph ***irgs)
639 {
640         (void) self;
641         (void) irgs;
642         return NULL;
643 }
644
645 static asm_constraint_flags_t sparc_parse_asm_constraint(const char **c)
646 {
647         (void) c;
648         return ASM_CONSTRAINT_FLAG_INVALID;
649 }
650
651 static int sparc_is_valid_clobber(const char *clobber)
652 {
653         (void) clobber;
654         return 0;
655 }
656
657 const arch_isa_if_t sparc_isa_if = {
658         sparc_init,
659         sparc_done,
660         NULL,                /* handle intrinsics */
661         sparc_get_n_reg_class,
662         sparc_get_reg_class,
663         sparc_get_reg_class_for_mode,
664         sparc_get_call_abi,
665         sparc_get_code_generator_if,
666         sparc_get_list_sched_selector,
667         sparc_get_ilp_sched_selector,
668         sparc_get_reg_class_alignment,
669     sparc_get_backend_params,
670         sparc_get_allowed_execution_units,
671         sparc_get_machine,
672         sparc_get_backend_irg_list,
673         NULL,                    /* mark remat */
674         sparc_parse_asm_constraint,
675         sparc_is_valid_clobber
676 };
677
678 void be_init_arch_sparc(void)
679 {
680         be_register_isa_if("sparc", &sparc_isa_if);
681         FIRM_DBG_REGISTER(dbg, "firm.be.sparc.cg");
682         sparc_init_transform();
683         sparc_init_emitter();
684 }
685 BE_REGISTER_MODULE_CONSTRUCTOR(be_init_arch_sparc);