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