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