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