cleanup: Remove unnecessary #include "beirg.h".
[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(const be_main_env_t *env)
161 {
162         TEMPLATE_isa_t *isa = XMALLOC(TEMPLATE_isa_t);
163         *isa = TEMPLATE_isa_template;
164
165         be_emit_init(env->file_handle);
166         be_gas_begin_compilation_unit(env);
167
168         return &isa->base;
169 }
170
171 /**
172  * Closes the output file and frees the ISA structure.
173  */
174 static void TEMPLATE_end_codegeneration(void *self)
175 {
176         TEMPLATE_isa_t *isa = (TEMPLATE_isa_t*)self;
177
178         /* emit now all global declarations */
179         be_gas_end_compilation_unit(isa->base.main_env);
180
181         be_emit_exit();
182         free(self);
183 }
184
185 /**
186  * Get the between type for that call.
187  * @param self The callback object.
188  * @return The between type of for that call.
189  */
190 static ir_type *TEMPLATE_get_between_type(ir_graph *irg)
191 {
192         static ir_type *between_type = NULL;
193         static ir_entity *old_bp_ent = NULL;
194         (void) irg;
195
196         if (!between_type) {
197                 ir_entity *ret_addr_ent;
198                 ir_type *ret_addr_type = new_type_primitive(mode_P);
199                 ir_type *old_bp_type   = new_type_primitive(mode_P);
200
201                 between_type           = new_type_class(new_id_from_str("TEMPLATE_between_type"));
202                 old_bp_ent             = new_entity(between_type, new_id_from_str("old_bp"), old_bp_type);
203                 ret_addr_ent           = new_entity(between_type, new_id_from_str("old_bp"), ret_addr_type);
204
205                 set_entity_offset(old_bp_ent, 0);
206                 set_entity_offset(ret_addr_ent, get_type_size_bytes(old_bp_type));
207                 set_type_size_bytes(between_type, get_type_size_bytes(old_bp_type) + get_type_size_bytes(ret_addr_type));
208         }
209
210         return between_type;
211 }
212
213 static const be_abi_callbacks_t TEMPLATE_abi_callbacks = {
214         TEMPLATE_get_between_type,
215 };
216
217 /**
218  * Get the ABI restrictions for procedure calls.
219  * @param self        The this pointer.
220  * @param method_type The type of the method (procedure) in question.
221  * @param abi         The abi object to be modified
222  */
223 static void TEMPLATE_get_call_abi(ir_type *method_type, be_abi_call_t *abi)
224 {
225         ir_type  *tp;
226         ir_mode  *mode;
227         int       i, n = get_method_n_params(method_type);
228
229         /* set abi flags for calls */
230         be_abi_call_flags_t call_flags = be_abi_call_get_flags(abi);
231         call_flags.call_has_imm = true;
232         be_abi_call_set_flags(abi, call_flags, &TEMPLATE_abi_callbacks);
233
234         for (i = 0; i < n; i++) {
235                 /* TODO: implement register parameter: */
236                 /* reg = get reg for param i;          */
237                 /* be_abi_call_param_reg(abi, i, reg, ABI_CONTEXT_BOTH); */
238
239                 /* default: all parameters on stack */
240                 tp   = get_method_param_type(method_type, i);
241                 mode = get_type_mode(tp);
242                 be_abi_call_param_stack(abi, i, mode, 4, 0, 0, ABI_CONTEXT_BOTH);
243         }
244
245         /* TODO: set correct return register */
246         /* default: return value is in R0 resp. F0 */
247         if (get_method_n_ress(method_type) > 0) {
248                 tp   = get_method_res_type(method_type, 0);
249                 mode = get_type_mode(tp);
250
251                 be_abi_call_res_reg(abi, 0,
252                         mode_is_float(mode) ? &TEMPLATE_registers[REG_F0] : &TEMPLATE_registers[REG_R0], ABI_CONTEXT_BOTH);
253         }
254 }
255
256 static void TEMPLATE_lower_for_target(void)
257 {
258         lower_builtins(0, NULL);
259
260         /* lower compound param handling */
261         lower_calls_with_compounds(LF_RETURN_HIDDEN);
262 }
263
264 static int TEMPLATE_is_mux_allowed(ir_node *sel, ir_node *mux_false,
265                                    ir_node *mux_true)
266 {
267         (void) sel;
268         (void) mux_false;
269         (void) mux_true;
270         return false;
271 }
272
273 /**
274  * Returns the libFirm configuration parameter for this backend.
275  */
276 static const backend_params *TEMPLATE_get_backend_params(void)
277 {
278         static backend_params p = {
279                 0,     /* no inline assembly */
280                 0,     /* no support for Rotl nodes */
281                 0,     /* 0: little-endian, 1: big-endian */
282                 1,     /* modulo shift efficient */
283                 0,     /* non-modulo shift efficient */
284                 NULL,  /* architecture dependent settings, will be set later */
285                 TEMPLATE_is_mux_allowed,  /* parameter for if conversion */
286                 32,    /* machine size - a 32bit CPU */
287                 NULL,  /* float arithmetic mode */
288                 NULL,  /* long long type */
289                 NULL,  /* unsigned long long type */
290                 NULL,  /* long double type */
291                 0,     /* no trampoline support: size 0 */
292                 0,     /* no trampoline support: align 0 */
293                 NULL,  /* no trampoline support: no trampoline builder */
294                 4      /* alignment of stack parameter: typically 4 (32bit) or 8 (64bit) */
295         };
296         return &p;
297 }
298
299 static asm_constraint_flags_t TEMPLATE_parse_asm_constraint(const char **c)
300 {
301         (void) c;
302         return ASM_CONSTRAINT_FLAG_INVALID;
303 }
304
305 static int TEMPLATE_is_valid_clobber(const char *clobber)
306 {
307         (void) clobber;
308         return 0;
309 }
310
311 /**
312  * Check if the given register is callee or caller save.
313  */
314 static int TEMPLATE_register_saved_by(const arch_register_t *reg, int callee)
315 {
316         if (callee) {
317                 /* check for callee saved */
318                 if (reg->reg_class == &TEMPLATE_reg_classes[CLASS_TEMPLATE_gp]) {
319                         switch (reg->index) {
320                         case REG_GP_R7:
321                         case REG_GP_R8:
322                         case REG_GP_R9:
323                         case REG_GP_R10:
324                         case REG_GP_R11:
325                         case REG_GP_R12:
326                         case REG_GP_R13:
327                                 return 1;
328                         default:
329                                 return 0;
330                         }
331                 }
332         } else {
333                 /* check for caller saved */
334                 if (reg->reg_class == &TEMPLATE_reg_classes[CLASS_TEMPLATE_gp]) {
335                         switch (reg->index) {
336                         case REG_GP_R0:
337                         case REG_GP_R1:
338                         case REG_GP_R2:
339                         case REG_GP_R3:
340                         case REG_GP_R4:
341                         case REG_GP_R5:
342                         case REG_GP_R6:
343                                 return 1;
344                         default:
345                                 return 0;
346                         }
347                 } else if (reg->reg_class == &TEMPLATE_reg_classes[CLASS_TEMPLATE_fp]) {
348                         /* all FP registers are caller save */
349                         return 1;
350                 }
351         }
352         return 0;
353 }
354
355 const arch_isa_if_t TEMPLATE_isa_if = {
356         TEMPLATE_init,
357         TEMPLATE_finish,
358     TEMPLATE_get_backend_params,
359         TEMPLATE_lower_for_target,
360         TEMPLATE_parse_asm_constraint,
361         TEMPLATE_is_valid_clobber,
362
363         TEMPLATE_begin_codegeneration,
364         TEMPLATE_end_codegeneration,
365         TEMPLATE_init_graph,
366         TEMPLATE_get_call_abi,
367         NULL, /* mark remat */
368         NULL, /* get_pic_base */
369         be_new_spill,
370         be_new_reload,
371         TEMPLATE_register_saved_by,
372
373         NULL, /* handle intrinsics */
374         NULL, /* before_abi */
375         TEMPLATE_prepare_graph,
376         TEMPLATE_before_ra,
377         TEMPLATE_finish_irg,
378         TEMPLATE_emit_routine,
379 };
380
381 BE_REGISTER_MODULE_CONSTRUCTOR(be_init_arch_TEMPLATE)
382 void be_init_arch_TEMPLATE(void)
383 {
384         be_register_isa_if("TEMPLATE", &TEMPLATE_isa_if);
385         FIRM_DBG_REGISTER(dbg, "firm.be.TEMPLATE.cg");
386         TEMPLATE_init_transform();
387 }