replace unsupported builtins with library calls
[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 #include "lower_builtins.h"
34
35 #include "bitset.h"
36 #include "debug.h"
37
38 #include "be.h"
39 #include "../bearch.h"
40 #include "../benode.h"
41 #include "../belower.h"
42 #include "../besched.h"
43 #include "../beabi.h"
44 #include "../bemodule.h"
45 #include "../begnuas.h"
46 #include "../belistsched.h"
47 #include "../bestack.h"
48 #include "../bespillutil.h"
49
50 #include "bearch_TEMPLATE_t.h"
51
52 #include "TEMPLATE_new_nodes.h"
53 #include "gen_TEMPLATE_regalloc_if.h"
54 #include "TEMPLATE_transform.h"
55 #include "TEMPLATE_emitter.h"
56
57 DEBUG_ONLY(static firm_dbg_module_t *dbg = NULL;)
58
59 static arch_irn_class_t TEMPLATE_classify(const ir_node *irn)
60 {
61         (void) irn;
62         return arch_irn_class_none;
63 }
64
65 static ir_entity *TEMPLATE_get_frame_entity(const ir_node *node)
66 {
67         (void) node;
68         /* TODO: return the ir_entity assigned to the frame */
69         return NULL;
70 }
71
72 /**
73  * This function is called by the generic backend to correct offsets for
74  * nodes accessing the stack.
75  */
76 static void TEMPLATE_set_frame_offset(ir_node *irn, int offset)
77 {
78         (void) irn;
79         (void) offset;
80         /* TODO: correct offset if irn accesses the stack */
81 }
82
83 static int TEMPLATE_get_sp_bias(const ir_node *irn)
84 {
85         (void) irn;
86         return 0;
87 }
88
89 /* fill register allocator interface */
90
91 static const arch_irn_ops_t TEMPLATE_irn_ops = {
92         TEMPLATE_classify,
93         TEMPLATE_get_frame_entity,
94         TEMPLATE_set_frame_offset,
95         TEMPLATE_get_sp_bias,
96         NULL,    /* get_inverse             */
97         NULL,    /* get_op_estimated_cost   */
98         NULL,    /* possible_memory_operand */
99         NULL,    /* perform_memory_operand  */
100 };
101
102
103
104 /**
105  * Transforms the standard firm graph into
106  * a TEMLPATE firm graph
107  */
108 static void TEMPLATE_prepare_graph(ir_graph *irg)
109 {
110         /* transform nodes into assembler instructions */
111         TEMPLATE_transform_graph(irg);
112 }
113
114
115
116 /**
117  * Called immediatly before emit phase.
118  */
119 static void TEMPLATE_finish_irg(ir_graph *irg)
120 {
121         /* fix stack entity offsets */
122         be_abi_fix_stack_nodes(irg);
123         be_abi_fix_stack_bias(irg);
124 }
125
126
127 static void TEMPLATE_before_ra(ir_graph *irg)
128 {
129         (void) irg;
130         /* Some stuff you need to do after scheduling but before 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.store_args_sequential = 1;
252         call_flags.bits.try_omit_fp           = 1;
253         call_flags.bits.fp_free               = 0;
254         call_flags.bits.call_has_imm          = 1;
255
256         /* set stack parameter passing style */
257         be_abi_call_set_flags(abi, call_flags, &TEMPLATE_abi_callbacks);
258
259         for (i = 0; i < n; i++) {
260                 /* TODO: implement register parameter: */
261                 /* reg = get reg for param i;          */
262                 /* be_abi_call_param_reg(abi, i, reg, ABI_CONTEXT_BOTH); */
263
264                 /* default: all parameters on stack */
265                 tp   = get_method_param_type(method_type, i);
266                 mode = get_type_mode(tp);
267                 be_abi_call_param_stack(abi, i, mode, 4, 0, 0, ABI_CONTEXT_BOTH);
268         }
269
270         /* TODO: set correct return register */
271         /* default: return value is in R0 resp. F0 */
272         if (get_method_n_ress(method_type) > 0) {
273                 tp   = get_method_res_type(method_type, 0);
274                 mode = get_type_mode(tp);
275
276                 be_abi_call_res_reg(abi, 0,
277                         mode_is_float(mode) ? &TEMPLATE_registers[REG_F0] : &TEMPLATE_registers[REG_R0], ABI_CONTEXT_BOTH);
278         }
279 }
280
281 /**
282  * Returns the necessary byte alignment for storing a register of given class.
283  */
284 static int TEMPLATE_get_reg_class_alignment(const arch_register_class_t *cls)
285 {
286         ir_mode *mode = arch_register_class_mode(cls);
287         return get_mode_size_bytes(mode);
288 }
289
290 static void TEMPLATE_lower_for_target(void)
291 {
292         lower_builtins(0, NULL);
293
294         /* lower compound param handling */
295         lower_calls_with_compounds(LF_RETURN_HIDDEN);
296 }
297
298 static int TEMPLATE_is_mux_allowed(ir_node *sel, ir_node *mux_false,
299                                    ir_node *mux_true)
300 {
301         (void) sel;
302         (void) mux_false;
303         (void) mux_true;
304         return false;
305 }
306
307 /**
308  * Returns the libFirm configuration parameter for this backend.
309  */
310 static const backend_params *TEMPLATE_get_backend_params(void)
311 {
312         static backend_params p = {
313                 0,     /* no inline assembly */
314                 0,     /* no support for Rotl nodes */
315                 0,     /* 0: little-endian, 1: big-endian */
316                 1,     /* modulo shift efficient */
317                 0,     /* non-modulo shift efficient */
318                 NULL,  /* architecture dependent settings, will be set later */
319                 TEMPLATE_is_mux_allowed,  /* parameter for if conversion */
320                 32,    /* machine size - a 32bit CPU */
321                 NULL,  /* float arithmetic mode */
322                 NULL,  /* long long type */
323                 NULL,  /* unsigned long long type */
324                 NULL,  /* long double type */
325                 0,     /* no trampoline support: size 0 */
326                 0,     /* no trampoline support: align 0 */
327                 NULL,  /* no trampoline support: no trampoline builder */
328                 4      /* alignment of stack parameter: typically 4 (32bit) or 8 (64bit) */
329         };
330         return &p;
331 }
332
333 static ir_graph **TEMPLATE_get_backend_irg_list(const void *self,
334                                                 ir_graph ***irgs)
335 {
336         (void) self;
337         (void) irgs;
338         return NULL;
339 }
340
341 static asm_constraint_flags_t TEMPLATE_parse_asm_constraint(const char **c)
342 {
343         (void) c;
344         return ASM_CONSTRAINT_FLAG_INVALID;
345 }
346
347 static int TEMPLATE_is_valid_clobber(const char *clobber)
348 {
349         (void) clobber;
350         return 0;
351 }
352
353 /**
354  * Check if the given register is callee or caller save.
355  */
356 static int TEMPLATE_register_saved_by(const arch_register_t *reg, int callee)
357 {
358         if (callee) {
359                 /* check for callee saved */
360                 if (reg->reg_class == &TEMPLATE_reg_classes[CLASS_TEMPLATE_gp]) {
361                         switch (reg->index) {
362                         case REG_GP_R7:
363                         case REG_GP_R8:
364                         case REG_GP_R9:
365                         case REG_GP_R10:
366                         case REG_GP_R11:
367                         case REG_GP_R12:
368                         case REG_GP_R13:
369                                 return 1;
370                         default:
371                                 return 0;
372                         }
373                 }
374         } else {
375                 /* check for caller saved */
376                 if (reg->reg_class == &TEMPLATE_reg_classes[CLASS_TEMPLATE_gp]) {
377                         switch (reg->index) {
378                         case REG_GP_R0:
379                         case REG_GP_R1:
380                         case REG_GP_R2:
381                         case REG_GP_R3:
382                         case REG_GP_R4:
383                         case REG_GP_R5:
384                         case REG_GP_R6:
385                                 return 1;
386                         default:
387                                 return 0;
388                         }
389                 } else if (reg->reg_class == &TEMPLATE_reg_classes[CLASS_TEMPLATE_fp]) {
390                         /* all FP registers are caller save */
391                         return 1;
392                 }
393         }
394         return 0;
395 }
396
397 const arch_isa_if_t TEMPLATE_isa_if = {
398         TEMPLATE_init,
399         TEMPLATE_lower_for_target,
400         TEMPLATE_done,
401         NULL,                /* handle intrinsics */
402         TEMPLATE_get_reg_class_for_mode,
403         TEMPLATE_get_call_abi,
404         TEMPLATE_get_reg_class_alignment,
405     TEMPLATE_get_backend_params,
406         TEMPLATE_get_backend_irg_list,
407         NULL,                    /* mark remat */
408         TEMPLATE_parse_asm_constraint,
409         TEMPLATE_is_valid_clobber,
410
411         TEMPLATE_init_graph,
412         NULL,   /* get_pic_base */
413         NULL,   /* before_abi */
414         TEMPLATE_prepare_graph,
415         TEMPLATE_before_ra,
416         TEMPLATE_finish_irg,
417         TEMPLATE_emit_routine,
418         TEMPLATE_register_saved_by,
419         be_new_spill,
420         be_new_reload,
421 };
422
423 BE_REGISTER_MODULE_CONSTRUCTOR(be_init_arch_TEMPLATE)
424 void be_init_arch_TEMPLATE(void)
425 {
426         be_register_isa_if("TEMPLATE", &TEMPLATE_isa_if);
427         FIRM_DBG_REGISTER(dbg, "firm.be.TEMPLATE.cg");
428         TEMPLATE_init_transform();
429 }