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