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