allow_ifconv callback may not be NULL anymore
[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 0;
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 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                 &TEMPLATE_gp_regs[REG_SP],  /* stack pointer register */
145                 &TEMPLATE_gp_regs[REG_BP],  /* base pointer register */
146                 &TEMPLATE_reg_classes[CLASS_TEMPLATE_gp],  /* link pointer register class */
147                 -1,                          /* stack direction */
148                 2,                           /* power of two stack alignment for calls, 2^2 == 4 */
149                 NULL,                        /* main environment */
150                 7,                           /* costs for a spill instruction */
151                 5,                           /* costs for a reload instruction */
152                 false,                       /* no custom abi handling */
153         },
154 };
155
156 /**
157  * Initializes the backend ISA
158  */
159 static arch_env_t *TEMPLATE_init(FILE *outfile)
160 {
161         static int run_once = 0;
162         TEMPLATE_isa_t *isa;
163
164         if (run_once)
165                 return NULL;
166         run_once = 1;
167
168         isa = XMALLOC(TEMPLATE_isa_t);
169         memcpy(isa, &TEMPLATE_isa_template, sizeof(*isa));
170
171         be_emit_init(outfile);
172
173         TEMPLATE_register_init();
174         TEMPLATE_create_opcodes(&TEMPLATE_irn_ops);
175
176         return &isa->base;
177 }
178
179
180
181 /**
182  * Closes the output file and frees the ISA structure.
183  */
184 static void TEMPLATE_done(void *self)
185 {
186         TEMPLATE_isa_t *isa = self;
187
188         /* emit now all global declarations */
189         be_gas_emit_decls(isa->base.main_env);
190
191         be_emit_exit();
192         free(self);
193 }
194
195
196 static unsigned TEMPLATE_get_n_reg_class(void)
197 {
198         return N_CLASSES;
199 }
200
201 static const arch_register_class_t *TEMPLATE_get_reg_class(unsigned i)
202 {
203         assert(i < N_CLASSES);
204         return &TEMPLATE_reg_classes[i];
205 }
206
207
208
209 /**
210  * Get the register class which shall be used to store a value of a given mode.
211  * @param self The this pointer.
212  * @param mode The mode in question.
213  * @return A register class which can hold values of the given mode.
214  */
215 static const arch_register_class_t *TEMPLATE_get_reg_class_for_mode(const ir_mode *mode)
216 {
217         if (mode_is_float(mode))
218                 return &TEMPLATE_reg_classes[CLASS_TEMPLATE_fp];
219         else
220                 return &TEMPLATE_reg_classes[CLASS_TEMPLATE_gp];
221 }
222
223
224
225 typedef struct {
226         be_abi_call_flags_bits_t flags;
227         ir_graph                *irg;
228 } TEMPLATE_abi_env_t;
229
230 static void *TEMPLATE_abi_init(const be_abi_call_t *call, ir_graph *irg)
231 {
232         TEMPLATE_abi_env_t *env = XMALLOC(TEMPLATE_abi_env_t);
233         be_abi_call_flags_t fl = be_abi_call_get_flags(call);
234         env->flags    = fl.bits;
235         env->irg      = irg;
236         return env;
237 }
238
239 /**
240  * Get the between type for that call.
241  * @param self The callback object.
242  * @return The between type of for that call.
243  */
244 static ir_type *TEMPLATE_get_between_type(void *self)
245 {
246         static ir_type *between_type = NULL;
247         static ir_entity *old_bp_ent = NULL;
248         (void) self;
249
250         if (!between_type) {
251                 ir_entity *ret_addr_ent;
252                 ir_type *ret_addr_type = new_type_primitive(mode_P);
253                 ir_type *old_bp_type   = new_type_primitive(mode_P);
254
255                 between_type           = new_type_class(new_id_from_str("TEMPLATE_between_type"));
256                 old_bp_ent             = new_entity(between_type, new_id_from_str("old_bp"), old_bp_type);
257                 ret_addr_ent           = new_entity(between_type, new_id_from_str("old_bp"), ret_addr_type);
258
259                 set_entity_offset(old_bp_ent, 0);
260                 set_entity_offset(ret_addr_ent, get_type_size_bytes(old_bp_type));
261                 set_type_size_bytes(between_type, get_type_size_bytes(old_bp_type) + get_type_size_bytes(ret_addr_type));
262         }
263
264         return between_type;
265 }
266
267 /**
268  * Build the prolog, return the BASE POINTER register
269  */
270 static const arch_register_t *TEMPLATE_abi_prologue(void *self, ir_node **mem,
271                                                     pmap *reg_map, int *stack_bias)
272 {
273         TEMPLATE_abi_env_t *env      = self;
274         const arch_env_t   *arch_env = be_get_irg_arch_env(env->irg);
275         (void) reg_map;
276         (void) mem;
277         (void) stack_bias;
278
279         if (env->flags.try_omit_fp)
280                 return arch_env->sp;
281         return arch_env->bp;
282 }
283
284 /* Build the epilog */
285 static void TEMPLATE_abi_epilogue(void *self, ir_node *bl, ir_node **mem,
286                                   pmap *reg_map)
287 {
288         (void) self;
289         (void) bl;
290         (void) mem;
291         (void) reg_map;
292 }
293
294 static const be_abi_callbacks_t TEMPLATE_abi_callbacks = {
295         TEMPLATE_abi_init,
296         free,
297         TEMPLATE_get_between_type,
298         TEMPLATE_abi_prologue,
299         TEMPLATE_abi_epilogue,
300 };
301
302 /**
303  * Get the ABI restrictions for procedure calls.
304  * @param self        The this pointer.
305  * @param method_type The type of the method (procedure) in question.
306  * @param abi         The abi object to be modified
307  */
308 static void TEMPLATE_get_call_abi(const void *self, ir_type *method_type,
309                                   be_abi_call_t *abi)
310 {
311         ir_type  *tp;
312         ir_mode  *mode;
313         int       i, n = get_method_n_params(method_type);
314         be_abi_call_flags_t call_flags;
315         (void) self;
316
317         /* set abi flags for calls */
318         call_flags.bits.left_to_right         = 0;
319         call_flags.bits.store_args_sequential = 1;
320         call_flags.bits.try_omit_fp           = 1;
321         call_flags.bits.fp_free               = 0;
322         call_flags.bits.call_has_imm          = 1;
323
324         /* set stack parameter passing style */
325         be_abi_call_set_flags(abi, call_flags, &TEMPLATE_abi_callbacks);
326
327         for (i = 0; i < n; i++) {
328                 /* TODO: implement register parameter: */
329                 /* reg = get reg for param i;          */
330                 /* be_abi_call_param_reg(abi, i, reg, ABI_CONTEXT_BOTH); */
331
332                 /* default: all parameters on stack */
333                 tp   = get_method_param_type(method_type, i);
334                 mode = get_type_mode(tp);
335                 be_abi_call_param_stack(abi, i, mode, 4, 0, 0, ABI_CONTEXT_BOTH);
336         }
337
338         /* TODO: set correct return register */
339         /* default: return value is in R0 resp. F0 */
340         if (get_method_n_ress(method_type) > 0) {
341                 tp   = get_method_res_type(method_type, 0);
342                 mode = get_type_mode(tp);
343
344                 be_abi_call_res_reg(abi, 0,
345                         mode_is_float(mode) ? &TEMPLATE_fp_regs[REG_F0] : &TEMPLATE_gp_regs[REG_R0], ABI_CONTEXT_BOTH);
346         }
347 }
348
349 /**
350  * Returns the necessary byte alignment for storing a register of given class.
351  */
352 static int TEMPLATE_get_reg_class_alignment(const arch_register_class_t *cls)
353 {
354         ir_mode *mode = arch_register_class_mode(cls);
355         return get_mode_size_bytes(mode);
356 }
357
358 static void TEMPLATE_lower_for_target(void)
359 {
360 }
361
362 static int TEMPLATE_is_mux_allowed(ir_node *sel, ir_node *mux_false,
363                                    ir_node *mux_true)
364 {
365         (void) sel;
366         (void) mux_false;
367         (void) mux_true;
368         return false;
369 }
370
371 /**
372  * Returns the libFirm configuration parameter for this backend.
373  */
374 static const backend_params *TEMPLATE_get_backend_params(void)
375 {
376         static backend_params p = {
377                 0,     /* no inline assembly */
378                 0,     /* no support for Rotl nodes */
379                 0,     /* 0: little-endian, 1: big-endian */
380                 TEMPLATE_lower_for_target,  /* lowering for target */
381                 NULL,  /* architecture dependent settings, will be set later */
382                 TEMPLATE_is_mux_allowed,  /* parameter for if conversion */
383                 NULL,  /* float arithmetic mode */
384                 0,     /* no trampoline support: size 0 */
385                 0,     /* no trampoline support: align 0 */
386                 NULL,  /* no trampoline support: no trampoline builder */
387                 4      /* alignment of stack parameter: typically 4 (32bit) or 8 (64bit) */
388         };
389         return &p;
390 }
391
392 static ir_graph **TEMPLATE_get_backend_irg_list(const void *self,
393                                                 ir_graph ***irgs)
394 {
395         (void) self;
396         (void) irgs;
397         return NULL;
398 }
399
400 static asm_constraint_flags_t TEMPLATE_parse_asm_constraint(const char **c)
401 {
402         (void) c;
403         return ASM_CONSTRAINT_FLAG_INVALID;
404 }
405
406 static int TEMPLATE_is_valid_clobber(const char *clobber)
407 {
408         (void) clobber;
409         return 0;
410 }
411
412 const arch_isa_if_t TEMPLATE_isa_if = {
413         TEMPLATE_init,
414         TEMPLATE_done,
415         NULL,                /* handle intrinsics */
416         TEMPLATE_get_n_reg_class,
417         TEMPLATE_get_reg_class,
418         TEMPLATE_get_reg_class_for_mode,
419         TEMPLATE_get_call_abi,
420         TEMPLATE_get_reg_class_alignment,
421     TEMPLATE_get_backend_params,
422         TEMPLATE_get_backend_irg_list,
423         NULL,                    /* mark remat */
424         TEMPLATE_parse_asm_constraint,
425         TEMPLATE_is_valid_clobber,
426
427         TEMPLATE_init_graph,
428         NULL,   /* get_pic_base */
429         NULL,   /* before_abi */
430         TEMPLATE_prepare_graph,
431         TEMPLATE_before_ra,
432         TEMPLATE_after_ra,
433         TEMPLATE_finish_irg,
434         TEMPLATE_emit_routine,
435 };
436
437 BE_REGISTER_MODULE_CONSTRUCTOR(be_init_arch_TEMPLATE);
438 void be_init_arch_TEMPLATE(void)
439 {
440         be_register_isa_if("TEMPLATE", &TEMPLATE_isa_if);
441         FIRM_DBG_REGISTER(dbg, "firm.be.TEMPLATE.cg");
442         TEMPLATE_init_transform();
443 }