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