simplify/rework lower_calls interface and code
[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
47 #include "bearch_TEMPLATE_t.h"
48
49 #include "TEMPLATE_new_nodes.h"
50 #include "gen_TEMPLATE_regalloc_if.h"
51 #include "TEMPLATE_transform.h"
52 #include "TEMPLATE_emitter.h"
53
54 DEBUG_ONLY(static firm_dbg_module_t *dbg = NULL;)
55
56 static arch_irn_class_t TEMPLATE_classify(const ir_node *irn)
57 {
58         (void) irn;
59         return arch_irn_class_none;
60 }
61
62 static ir_entity *TEMPLATE_get_frame_entity(const ir_node *node)
63 {
64         (void) node;
65         /* TODO: return the ir_entity assigned to the frame */
66         return NULL;
67 }
68
69 /**
70  * This function is called by the generic backend to correct offsets for
71  * nodes accessing the stack.
72  */
73 static void TEMPLATE_set_frame_offset(ir_node *irn, int offset)
74 {
75         (void) irn;
76         (void) offset;
77         /* TODO: correct offset if irn accesses the stack */
78 }
79
80 static int TEMPLATE_get_sp_bias(const ir_node *irn)
81 {
82         (void) irn;
83         return 0;
84 }
85
86 /* fill register allocator interface */
87
88 static const arch_irn_ops_t TEMPLATE_irn_ops = {
89         TEMPLATE_classify,
90         TEMPLATE_get_frame_entity,
91         TEMPLATE_set_frame_offset,
92         TEMPLATE_get_sp_bias,
93         NULL,    /* get_inverse             */
94         NULL,    /* get_op_estimated_cost   */
95         NULL,    /* possible_memory_operand */
96         NULL,    /* perform_memory_operand  */
97 };
98
99
100
101 /**
102  * Transforms the standard firm graph into
103  * a TEMLPATE firm graph
104  */
105 static void TEMPLATE_prepare_graph(ir_graph *irg)
106 {
107         /* transform nodes into assembler instructions */
108         TEMPLATE_transform_graph(irg);
109 }
110
111
112
113 /**
114  * Called immediatly before emit phase.
115  */
116 static void TEMPLATE_finish_irg(ir_graph *irg)
117 {
118         (void) irg;
119 }
120
121
122 static void TEMPLATE_before_ra(ir_graph *irg)
123 {
124         (void) irg;
125         /* Some stuff you need to do after scheduling but before register allocation */
126 }
127
128 static void TEMPLATE_after_ra(ir_graph *irg)
129 {
130         (void) irg;
131         /* Some stuff you need to do immediatly after register allocation */
132 }
133
134 static void TEMPLATE_init_graph(ir_graph *irg)
135 {
136         (void) irg;
137 }
138
139
140
141 extern const arch_isa_if_t TEMPLATE_isa_if;
142 static TEMPLATE_isa_t TEMPLATE_isa_template = {
143         {
144                 &TEMPLATE_isa_if,             /* isa interface implementation */
145                 N_TEMPLATE_REGISTERS,
146                 TEMPLATE_registers,
147                 N_TEMPLATE_CLASSES,
148                 TEMPLATE_reg_classes,
149                 &TEMPLATE_registers[REG_SP],  /* stack pointer register */
150                 &TEMPLATE_registers[REG_BP],  /* base pointer register */
151                 &TEMPLATE_reg_classes[CLASS_TEMPLATE_gp],  /* link pointer register class */
152                 2,                           /* power of two stack alignment for calls, 2^2 == 4 */
153                 NULL,                        /* main environment */
154                 7,                           /* costs for a spill instruction */
155                 5,                           /* costs for a reload instruction */
156                 false,                       /* no custom abi handling */
157         },
158 };
159
160 /**
161  * Initializes the backend ISA
162  */
163 static arch_env_t *TEMPLATE_init(FILE *outfile)
164 {
165         TEMPLATE_isa_t *isa = XMALLOC(TEMPLATE_isa_t);
166         *isa = TEMPLATE_isa_template;
167
168         be_emit_init(outfile);
169
170         TEMPLATE_register_init();
171         TEMPLATE_create_opcodes(&TEMPLATE_irn_ops);
172
173         return &isa->base;
174 }
175
176 /**
177  * Closes the output file and frees the ISA structure.
178  */
179 static void TEMPLATE_done(void *self)
180 {
181         TEMPLATE_isa_t *isa = (TEMPLATE_isa_t*)self;
182
183         /* emit now all global declarations */
184         be_gas_emit_decls(isa->base.main_env);
185
186         be_emit_exit();
187         free(self);
188 }
189
190 /**
191  * Get the register class which shall be used to store a value of a given mode.
192  * @param self The this pointer.
193  * @param mode The mode in question.
194  * @return A register class which can hold values of the given mode.
195  */
196 static const arch_register_class_t *TEMPLATE_get_reg_class_for_mode(const ir_mode *mode)
197 {
198         if (mode_is_float(mode))
199                 return &TEMPLATE_reg_classes[CLASS_TEMPLATE_fp];
200         else
201                 return &TEMPLATE_reg_classes[CLASS_TEMPLATE_gp];
202 }
203
204 /**
205  * Get the between type for that call.
206  * @param self The callback object.
207  * @return The between type of for that call.
208  */
209 static ir_type *TEMPLATE_get_between_type(ir_graph *irg)
210 {
211         static ir_type *between_type = NULL;
212         static ir_entity *old_bp_ent = NULL;
213         (void) irg;
214
215         if (!between_type) {
216                 ir_entity *ret_addr_ent;
217                 ir_type *ret_addr_type = new_type_primitive(mode_P);
218                 ir_type *old_bp_type   = new_type_primitive(mode_P);
219
220                 between_type           = new_type_class(new_id_from_str("TEMPLATE_between_type"));
221                 old_bp_ent             = new_entity(between_type, new_id_from_str("old_bp"), old_bp_type);
222                 ret_addr_ent           = new_entity(between_type, new_id_from_str("old_bp"), ret_addr_type);
223
224                 set_entity_offset(old_bp_ent, 0);
225                 set_entity_offset(ret_addr_ent, get_type_size_bytes(old_bp_type));
226                 set_type_size_bytes(between_type, get_type_size_bytes(old_bp_type) + get_type_size_bytes(ret_addr_type));
227         }
228
229         return between_type;
230 }
231
232 static const be_abi_callbacks_t TEMPLATE_abi_callbacks = {
233         TEMPLATE_get_between_type,
234 };
235
236 /**
237  * Get the ABI restrictions for procedure calls.
238  * @param self        The this pointer.
239  * @param method_type The type of the method (procedure) in question.
240  * @param abi         The abi object to be modified
241  */
242 static void TEMPLATE_get_call_abi(const void *self, ir_type *method_type,
243                                   be_abi_call_t *abi)
244 {
245         ir_type  *tp;
246         ir_mode  *mode;
247         int       i, n = get_method_n_params(method_type);
248         be_abi_call_flags_t call_flags;
249         (void) self;
250
251         /* set abi flags for calls */
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 compound param handling */
294         lower_calls_with_compounds(LF_RETURN_HIDDEN);
295 }
296
297 static int TEMPLATE_is_mux_allowed(ir_node *sel, ir_node *mux_false,
298                                    ir_node *mux_true)
299 {
300         (void) sel;
301         (void) mux_false;
302         (void) mux_true;
303         return false;
304 }
305
306 /**
307  * Returns the libFirm configuration parameter for this backend.
308  */
309 static const backend_params *TEMPLATE_get_backend_params(void)
310 {
311         static backend_params p = {
312                 0,     /* no inline assembly */
313                 0,     /* no support for Rotl nodes */
314                 0,     /* 0: little-endian, 1: big-endian */
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                 0,     /* size of long double */
320                 0,     /* no trampoline support: size 0 */
321                 0,     /* no trampoline support: align 0 */
322                 NULL,  /* no trampoline support: no trampoline builder */
323                 4      /* alignment of stack parameter: typically 4 (32bit) or 8 (64bit) */
324         };
325         return &p;
326 }
327
328 static ir_graph **TEMPLATE_get_backend_irg_list(const void *self,
329                                                 ir_graph ***irgs)
330 {
331         (void) self;
332         (void) irgs;
333         return NULL;
334 }
335
336 static asm_constraint_flags_t TEMPLATE_parse_asm_constraint(const char **c)
337 {
338         (void) c;
339         return ASM_CONSTRAINT_FLAG_INVALID;
340 }
341
342 static int TEMPLATE_is_valid_clobber(const char *clobber)
343 {
344         (void) clobber;
345         return 0;
346 }
347
348 /**
349  * Check if the given register is callee or caller save.
350  */
351 static int TEMPLATE_register_saved_by(const arch_register_t *reg, int callee)
352 {
353         if (callee) {
354                 /* check for callee saved */
355                 if (reg->reg_class == &TEMPLATE_reg_classes[CLASS_TEMPLATE_gp]) {
356                         switch (reg->index) {
357                         case REG_GP_R7:
358                         case REG_GP_R8:
359                         case REG_GP_R9:
360                         case REG_GP_R10:
361                         case REG_GP_R11:
362                         case REG_GP_R12:
363                         case REG_GP_R13:
364                                 return 1;
365                         default:
366                                 return 0;
367                         }
368                 }
369         } else {
370                 /* check for caller saved */
371                 if (reg->reg_class == &TEMPLATE_reg_classes[CLASS_TEMPLATE_gp]) {
372                         switch (reg->index) {
373                         case REG_GP_R0:
374                         case REG_GP_R1:
375                         case REG_GP_R2:
376                         case REG_GP_R3:
377                         case REG_GP_R4:
378                         case REG_GP_R5:
379                         case REG_GP_R6:
380                                 return 1;
381                         default:
382                                 return 0;
383                         }
384                 } else if (reg->reg_class == &TEMPLATE_reg_classes[CLASS_TEMPLATE_fp]) {
385                         /* all FP registers are caller save */
386                         return 1;
387                 }
388         }
389         return 0;
390 }
391
392 const arch_isa_if_t TEMPLATE_isa_if = {
393         TEMPLATE_init,
394         TEMPLATE_lower_for_target,
395         TEMPLATE_done,
396         NULL,                /* handle intrinsics */
397         TEMPLATE_get_reg_class_for_mode,
398         TEMPLATE_get_call_abi,
399         TEMPLATE_get_reg_class_alignment,
400     TEMPLATE_get_backend_params,
401         TEMPLATE_get_backend_irg_list,
402         NULL,                    /* mark remat */
403         TEMPLATE_parse_asm_constraint,
404         TEMPLATE_is_valid_clobber,
405
406         TEMPLATE_init_graph,
407         NULL,   /* get_pic_base */
408         NULL,   /* before_abi */
409         TEMPLATE_prepare_graph,
410         TEMPLATE_before_ra,
411         TEMPLATE_after_ra,
412         TEMPLATE_finish_irg,
413         TEMPLATE_emit_routine,
414         TEMPLATE_register_saved_by,
415 };
416
417 BE_REGISTER_MODULE_CONSTRUCTOR(be_init_arch_TEMPLATE)
418 void be_init_arch_TEMPLATE(void)
419 {
420         be_register_isa_if("TEMPLATE", &TEMPLATE_isa_if);
421         FIRM_DBG_REGISTER(dbg, "firm.be.TEMPLATE.cg");
422         TEMPLATE_init_transform();
423 }