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