implement aggregate returns according to sparc ABI
[libfirm] / ir / be / TEMPLATE / bearch_TEMPLATE.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 TEMPLATE backend driver file.
23  * @version  $Id$
24  */
25 #include "config.h"
26
27 #include "irgwalk.h"
28 #include "irprog.h"
29 #include "irprintf.h"
30 #include "ircons.h"
31 #include "irgmod.h"
32 #include "lower_calls.h"
33
34 #include "bitset.h"
35 #include "debug.h"
36
37 #include "be.h"
38 #include "../bearch.h"
39 #include "../benode.h"
40 #include "../belower.h"
41 #include "../besched.h"
42 #include "../beabi.h"
43 #include "../bemodule.h"
44 #include "../begnuas.h"
45 #include "../belistsched.h"
46 #include "../bestack.h"
47
48 #include "bearch_TEMPLATE_t.h"
49
50 #include "TEMPLATE_new_nodes.h"
51 #include "gen_TEMPLATE_regalloc_if.h"
52 #include "TEMPLATE_transform.h"
53 #include "TEMPLATE_emitter.h"
54
55 DEBUG_ONLY(static firm_dbg_module_t *dbg = NULL;)
56
57 static arch_irn_class_t TEMPLATE_classify(const ir_node *irn)
58 {
59         (void) irn;
60         return arch_irn_class_none;
61 }
62
63 static ir_entity *TEMPLATE_get_frame_entity(const ir_node *node)
64 {
65         (void) node;
66         /* TODO: return the ir_entity assigned to the frame */
67         return NULL;
68 }
69
70 /**
71  * This function is called by the generic backend to correct offsets for
72  * nodes accessing the stack.
73  */
74 static void TEMPLATE_set_frame_offset(ir_node *irn, int offset)
75 {
76         (void) irn;
77         (void) offset;
78         /* TODO: correct offset if irn accesses the stack */
79 }
80
81 static int TEMPLATE_get_sp_bias(const ir_node *irn)
82 {
83         (void) irn;
84         return 0;
85 }
86
87 /* fill register allocator interface */
88
89 static const arch_irn_ops_t TEMPLATE_irn_ops = {
90         TEMPLATE_classify,
91         TEMPLATE_get_frame_entity,
92         TEMPLATE_set_frame_offset,
93         TEMPLATE_get_sp_bias,
94         NULL,    /* get_inverse             */
95         NULL,    /* get_op_estimated_cost   */
96         NULL,    /* possible_memory_operand */
97         NULL,    /* perform_memory_operand  */
98 };
99
100
101
102 /**
103  * Transforms the standard firm graph into
104  * a TEMLPATE firm graph
105  */
106 static void TEMPLATE_prepare_graph(ir_graph *irg)
107 {
108         /* transform nodes into assembler instructions */
109         TEMPLATE_transform_graph(irg);
110 }
111
112
113
114 /**
115  * Called immediatly before emit phase.
116  */
117 static void TEMPLATE_finish_irg(ir_graph *irg)
118 {
119         /* fix stack entity offsets */
120         be_abi_fix_stack_nodes(irg);
121         be_abi_fix_stack_bias(irg);
122 }
123
124
125 static void TEMPLATE_before_ra(ir_graph *irg)
126 {
127         (void) irg;
128         /* Some stuff you need to do after scheduling but before register allocation */
129 }
130
131 static void TEMPLATE_init_graph(ir_graph *irg)
132 {
133         (void) irg;
134 }
135
136
137
138 extern const arch_isa_if_t TEMPLATE_isa_if;
139 static TEMPLATE_isa_t TEMPLATE_isa_template = {
140         {
141                 &TEMPLATE_isa_if,             /* isa interface implementation */
142                 N_TEMPLATE_REGISTERS,
143                 TEMPLATE_registers,
144                 N_TEMPLATE_CLASSES,
145                 TEMPLATE_reg_classes,
146                 &TEMPLATE_registers[REG_SP],  /* stack pointer register */
147                 &TEMPLATE_registers[REG_BP],  /* base pointer register */
148                 &TEMPLATE_reg_classes[CLASS_TEMPLATE_gp],  /* link pointer register class */
149                 2,                           /* power of two stack alignment for calls, 2^2 == 4 */
150                 NULL,                        /* main environment */
151                 7,                           /* costs for a spill instruction */
152                 5,                           /* costs for a reload instruction */
153                 false,                       /* no custom abi handling */
154         },
155 };
156
157 /**
158  * Initializes the backend ISA
159  */
160 static arch_env_t *TEMPLATE_init(FILE *outfile)
161 {
162         TEMPLATE_isa_t *isa = XMALLOC(TEMPLATE_isa_t);
163         *isa = TEMPLATE_isa_template;
164
165         be_emit_init(outfile);
166
167         TEMPLATE_register_init();
168         TEMPLATE_create_opcodes(&TEMPLATE_irn_ops);
169
170         return &isa->base;
171 }
172
173 /**
174  * Closes the output file and frees the ISA structure.
175  */
176 static void TEMPLATE_done(void *self)
177 {
178         TEMPLATE_isa_t *isa = (TEMPLATE_isa_t*)self;
179
180         /* emit now all global declarations */
181         be_gas_emit_decls(isa->base.main_env);
182
183         be_emit_exit();
184         free(self);
185 }
186
187 /**
188  * Get the register class which shall be used to store a value of a given mode.
189  * @param self The this pointer.
190  * @param mode The mode in question.
191  * @return A register class which can hold values of the given mode.
192  */
193 static const arch_register_class_t *TEMPLATE_get_reg_class_for_mode(const ir_mode *mode)
194 {
195         if (mode_is_float(mode))
196                 return &TEMPLATE_reg_classes[CLASS_TEMPLATE_fp];
197         else
198                 return &TEMPLATE_reg_classes[CLASS_TEMPLATE_gp];
199 }
200
201 /**
202  * Get the between type for that call.
203  * @param self The callback object.
204  * @return The between type of for that call.
205  */
206 static ir_type *TEMPLATE_get_between_type(ir_graph *irg)
207 {
208         static ir_type *between_type = NULL;
209         static ir_entity *old_bp_ent = NULL;
210         (void) irg;
211
212         if (!between_type) {
213                 ir_entity *ret_addr_ent;
214                 ir_type *ret_addr_type = new_type_primitive(mode_P);
215                 ir_type *old_bp_type   = new_type_primitive(mode_P);
216
217                 between_type           = new_type_class(new_id_from_str("TEMPLATE_between_type"));
218                 old_bp_ent             = new_entity(between_type, new_id_from_str("old_bp"), old_bp_type);
219                 ret_addr_ent           = new_entity(between_type, new_id_from_str("old_bp"), ret_addr_type);
220
221                 set_entity_offset(old_bp_ent, 0);
222                 set_entity_offset(ret_addr_ent, get_type_size_bytes(old_bp_type));
223                 set_type_size_bytes(between_type, get_type_size_bytes(old_bp_type) + get_type_size_bytes(ret_addr_type));
224         }
225
226         return between_type;
227 }
228
229 static const be_abi_callbacks_t TEMPLATE_abi_callbacks = {
230         TEMPLATE_get_between_type,
231 };
232
233 /**
234  * Get the ABI restrictions for procedure calls.
235  * @param self        The this pointer.
236  * @param method_type The type of the method (procedure) in question.
237  * @param abi         The abi object to be modified
238  */
239 static void TEMPLATE_get_call_abi(const void *self, ir_type *method_type,
240                                   be_abi_call_t *abi)
241 {
242         ir_type  *tp;
243         ir_mode  *mode;
244         int       i, n = get_method_n_params(method_type);
245         be_abi_call_flags_t call_flags;
246         (void) self;
247
248         /* set abi flags for calls */
249         call_flags.bits.store_args_sequential = 1;
250         call_flags.bits.try_omit_fp           = 1;
251         call_flags.bits.fp_free               = 0;
252         call_flags.bits.call_has_imm          = 1;
253
254         /* set stack parameter passing style */
255         be_abi_call_set_flags(abi, call_flags, &TEMPLATE_abi_callbacks);
256
257         for (i = 0; i < n; i++) {
258                 /* TODO: implement register parameter: */
259                 /* reg = get reg for param i;          */
260                 /* be_abi_call_param_reg(abi, i, reg, ABI_CONTEXT_BOTH); */
261
262                 /* default: all parameters on stack */
263                 tp   = get_method_param_type(method_type, i);
264                 mode = get_type_mode(tp);
265                 be_abi_call_param_stack(abi, i, mode, 4, 0, 0, ABI_CONTEXT_BOTH);
266         }
267
268         /* TODO: set correct return register */
269         /* default: return value is in R0 resp. F0 */
270         if (get_method_n_ress(method_type) > 0) {
271                 tp   = get_method_res_type(method_type, 0);
272                 mode = get_type_mode(tp);
273
274                 be_abi_call_res_reg(abi, 0,
275                         mode_is_float(mode) ? &TEMPLATE_registers[REG_F0] : &TEMPLATE_registers[REG_R0], ABI_CONTEXT_BOTH);
276         }
277 }
278
279 /**
280  * Returns the necessary byte alignment for storing a register of given class.
281  */
282 static int TEMPLATE_get_reg_class_alignment(const arch_register_class_t *cls)
283 {
284         ir_mode *mode = arch_register_class_mode(cls);
285         return get_mode_size_bytes(mode);
286 }
287
288 static void TEMPLATE_lower_for_target(void)
289 {
290         /* lower compound param handling */
291         lower_calls_with_compounds(LF_RETURN_HIDDEN);
292 }
293
294 static int TEMPLATE_is_mux_allowed(ir_node *sel, ir_node *mux_false,
295                                    ir_node *mux_true)
296 {
297         (void) sel;
298         (void) mux_false;
299         (void) mux_true;
300         return false;
301 }
302
303 /**
304  * Returns the libFirm configuration parameter for this backend.
305  */
306 static const backend_params *TEMPLATE_get_backend_params(void)
307 {
308         static backend_params p = {
309                 0,     /* no inline assembly */
310                 0,     /* no support for Rotl nodes */
311                 0,     /* 0: little-endian, 1: big-endian */
312                 1,     /* modulo shift efficient */
313                 0,     /* non-modulo shift efficient */
314                 NULL,  /* architecture dependent settings, will be set later */
315                 TEMPLATE_is_mux_allowed,  /* parameter for if conversion */
316                 32,    /* machine size - a 32bit CPU */
317                 NULL,  /* float arithmetic mode */
318                 NULL,  /* long long type */
319                 NULL,  /* unsigned long long type */
320                 NULL,  /* long double type */
321                 0,     /* no trampoline support: size 0 */
322                 0,     /* no trampoline support: align 0 */
323                 NULL,  /* no trampoline support: no trampoline builder */
324                 4      /* alignment of stack parameter: typically 4 (32bit) or 8 (64bit) */
325         };
326         return &p;
327 }
328
329 static ir_graph **TEMPLATE_get_backend_irg_list(const void *self,
330                                                 ir_graph ***irgs)
331 {
332         (void) self;
333         (void) irgs;
334         return NULL;
335 }
336
337 static asm_constraint_flags_t TEMPLATE_parse_asm_constraint(const char **c)
338 {
339         (void) c;
340         return ASM_CONSTRAINT_FLAG_INVALID;
341 }
342
343 static int TEMPLATE_is_valid_clobber(const char *clobber)
344 {
345         (void) clobber;
346         return 0;
347 }
348
349 /**
350  * Check if the given register is callee or caller save.
351  */
352 static int TEMPLATE_register_saved_by(const arch_register_t *reg, int callee)
353 {
354         if (callee) {
355                 /* check for callee saved */
356                 if (reg->reg_class == &TEMPLATE_reg_classes[CLASS_TEMPLATE_gp]) {
357                         switch (reg->index) {
358                         case REG_GP_R7:
359                         case REG_GP_R8:
360                         case REG_GP_R9:
361                         case REG_GP_R10:
362                         case REG_GP_R11:
363                         case REG_GP_R12:
364                         case REG_GP_R13:
365                                 return 1;
366                         default:
367                                 return 0;
368                         }
369                 }
370         } else {
371                 /* check for caller saved */
372                 if (reg->reg_class == &TEMPLATE_reg_classes[CLASS_TEMPLATE_gp]) {
373                         switch (reg->index) {
374                         case REG_GP_R0:
375                         case REG_GP_R1:
376                         case REG_GP_R2:
377                         case REG_GP_R3:
378                         case REG_GP_R4:
379                         case REG_GP_R5:
380                         case REG_GP_R6:
381                                 return 1;
382                         default:
383                                 return 0;
384                         }
385                 } else if (reg->reg_class == &TEMPLATE_reg_classes[CLASS_TEMPLATE_fp]) {
386                         /* all FP registers are caller save */
387                         return 1;
388                 }
389         }
390         return 0;
391 }
392
393 const arch_isa_if_t TEMPLATE_isa_if = {
394         TEMPLATE_init,
395         TEMPLATE_lower_for_target,
396         TEMPLATE_done,
397         NULL,                /* handle intrinsics */
398         TEMPLATE_get_reg_class_for_mode,
399         TEMPLATE_get_call_abi,
400         TEMPLATE_get_reg_class_alignment,
401     TEMPLATE_get_backend_params,
402         TEMPLATE_get_backend_irg_list,
403         NULL,                    /* mark remat */
404         TEMPLATE_parse_asm_constraint,
405         TEMPLATE_is_valid_clobber,
406
407         TEMPLATE_init_graph,
408         NULL,   /* get_pic_base */
409         NULL,   /* before_abi */
410         TEMPLATE_prepare_graph,
411         TEMPLATE_before_ra,
412         TEMPLATE_finish_irg,
413         TEMPLATE_emit_routine,
414         TEMPLATE_register_saved_by,
415 };
416
417 BE_REGISTER_MODULE_CONSTRUCTOR(be_init_arch_TEMPLATE)
418 void be_init_arch_TEMPLATE(void)
419 {
420         be_register_isa_if("TEMPLATE", &TEMPLATE_isa_if);
421         FIRM_DBG_REGISTER(dbg, "firm.be.TEMPLATE.cg");
422         TEMPLATE_init_transform();
423 }