8ace938a4c8b5918fcdb2c3f996ba2a5c96f4aa9
[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                 -1,                          /* stack direction */
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         memcpy(isa, &TEMPLATE_isa_template, sizeof(*isa));
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
206 typedef struct {
207         be_abi_call_flags_bits_t flags;
208         ir_graph                *irg;
209 } TEMPLATE_abi_env_t;
210
211 static void *TEMPLATE_abi_init(const be_abi_call_t *call, ir_graph *irg)
212 {
213         TEMPLATE_abi_env_t *env = XMALLOC(TEMPLATE_abi_env_t);
214         be_abi_call_flags_t fl = be_abi_call_get_flags(call);
215         env->flags    = fl.bits;
216         env->irg      = irg;
217         return env;
218 }
219
220 /**
221  * Get the between type for that call.
222  * @param self The callback object.
223  * @return The between type of for that call.
224  */
225 static ir_type *TEMPLATE_get_between_type(void *self)
226 {
227         static ir_type *between_type = NULL;
228         static ir_entity *old_bp_ent = NULL;
229         (void) self;
230
231         if (!between_type) {
232                 ir_entity *ret_addr_ent;
233                 ir_type *ret_addr_type = new_type_primitive(mode_P);
234                 ir_type *old_bp_type   = new_type_primitive(mode_P);
235
236                 between_type           = new_type_class(new_id_from_str("TEMPLATE_between_type"));
237                 old_bp_ent             = new_entity(between_type, new_id_from_str("old_bp"), old_bp_type);
238                 ret_addr_ent           = new_entity(between_type, new_id_from_str("old_bp"), ret_addr_type);
239
240                 set_entity_offset(old_bp_ent, 0);
241                 set_entity_offset(ret_addr_ent, get_type_size_bytes(old_bp_type));
242                 set_type_size_bytes(between_type, get_type_size_bytes(old_bp_type) + get_type_size_bytes(ret_addr_type));
243         }
244
245         return between_type;
246 }
247
248 /**
249  * Build the prolog, return the BASE POINTER register
250  */
251 static const arch_register_t *TEMPLATE_abi_prologue(void *self, ir_node **mem,
252                                                     pmap *reg_map, int *stack_bias)
253 {
254         TEMPLATE_abi_env_t *env      = (TEMPLATE_abi_env_t*)self;
255         const arch_env_t   *arch_env = be_get_irg_arch_env(env->irg);
256         (void) reg_map;
257         (void) mem;
258         (void) stack_bias;
259
260         if (env->flags.try_omit_fp)
261                 return arch_env->sp;
262         return arch_env->bp;
263 }
264
265 /* Build the epilog */
266 static void TEMPLATE_abi_epilogue(void *self, ir_node *bl, ir_node **mem,
267                                   pmap *reg_map)
268 {
269         (void) self;
270         (void) bl;
271         (void) mem;
272         (void) reg_map;
273 }
274
275 static const be_abi_callbacks_t TEMPLATE_abi_callbacks = {
276         TEMPLATE_abi_init,
277         free,
278         TEMPLATE_get_between_type,
279         TEMPLATE_abi_prologue,
280         TEMPLATE_abi_epilogue,
281 };
282
283 /**
284  * Get the ABI restrictions for procedure calls.
285  * @param self        The this pointer.
286  * @param method_type The type of the method (procedure) in question.
287  * @param abi         The abi object to be modified
288  */
289 static void TEMPLATE_get_call_abi(const void *self, ir_type *method_type,
290                                   be_abi_call_t *abi)
291 {
292         ir_type  *tp;
293         ir_mode  *mode;
294         int       i, n = get_method_n_params(method_type);
295         be_abi_call_flags_t call_flags;
296         (void) self;
297
298         /* set abi flags for calls */
299         call_flags.bits.left_to_right         = 0;
300         call_flags.bits.store_args_sequential = 1;
301         call_flags.bits.try_omit_fp           = 1;
302         call_flags.bits.fp_free               = 0;
303         call_flags.bits.call_has_imm          = 1;
304
305         /* set stack parameter passing style */
306         be_abi_call_set_flags(abi, call_flags, &TEMPLATE_abi_callbacks);
307
308         for (i = 0; i < n; i++) {
309                 /* TODO: implement register parameter: */
310                 /* reg = get reg for param i;          */
311                 /* be_abi_call_param_reg(abi, i, reg, ABI_CONTEXT_BOTH); */
312
313                 /* default: all parameters on stack */
314                 tp   = get_method_param_type(method_type, i);
315                 mode = get_type_mode(tp);
316                 be_abi_call_param_stack(abi, i, mode, 4, 0, 0, ABI_CONTEXT_BOTH);
317         }
318
319         /* TODO: set correct return register */
320         /* default: return value is in R0 resp. F0 */
321         if (get_method_n_ress(method_type) > 0) {
322                 tp   = get_method_res_type(method_type, 0);
323                 mode = get_type_mode(tp);
324
325                 be_abi_call_res_reg(abi, 0,
326                         mode_is_float(mode) ? &TEMPLATE_registers[REG_F0] : &TEMPLATE_registers[REG_R0], ABI_CONTEXT_BOTH);
327         }
328 }
329
330 /**
331  * Returns the necessary byte alignment for storing a register of given class.
332  */
333 static int TEMPLATE_get_reg_class_alignment(const arch_register_class_t *cls)
334 {
335         ir_mode *mode = arch_register_class_mode(cls);
336         return get_mode_size_bytes(mode);
337 }
338
339 static void TEMPLATE_lower_for_target(void)
340 {
341 }
342
343 static int TEMPLATE_is_mux_allowed(ir_node *sel, ir_node *mux_false,
344                                    ir_node *mux_true)
345 {
346         (void) sel;
347         (void) mux_false;
348         (void) mux_true;
349         return false;
350 }
351
352 /**
353  * Returns the libFirm configuration parameter for this backend.
354  */
355 static const backend_params *TEMPLATE_get_backend_params(void)
356 {
357         static backend_params p = {
358                 0,     /* no inline assembly */
359                 0,     /* no support for Rotl nodes */
360                 0,     /* 0: little-endian, 1: big-endian */
361                 TEMPLATE_lower_for_target,  /* lowering for target */
362                 NULL,  /* architecture dependent settings, will be set later */
363                 TEMPLATE_is_mux_allowed,  /* parameter for if conversion */
364                 NULL,  /* float arithmetic mode */
365                 0,     /* no trampoline support: size 0 */
366                 0,     /* no trampoline support: align 0 */
367                 NULL,  /* no trampoline support: no trampoline builder */
368                 4      /* alignment of stack parameter: typically 4 (32bit) or 8 (64bit) */
369         };
370         return &p;
371 }
372
373 static ir_graph **TEMPLATE_get_backend_irg_list(const void *self,
374                                                 ir_graph ***irgs)
375 {
376         (void) self;
377         (void) irgs;
378         return NULL;
379 }
380
381 static asm_constraint_flags_t TEMPLATE_parse_asm_constraint(const char **c)
382 {
383         (void) c;
384         return ASM_CONSTRAINT_FLAG_INVALID;
385 }
386
387 static int TEMPLATE_is_valid_clobber(const char *clobber)
388 {
389         (void) clobber;
390         return 0;
391 }
392
393 const arch_isa_if_t TEMPLATE_isa_if = {
394         TEMPLATE_init,
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 };
415
416 BE_REGISTER_MODULE_CONSTRUCTOR(be_init_arch_TEMPLATE);
417 void be_init_arch_TEMPLATE(void)
418 {
419         be_register_isa_if("TEMPLATE", &TEMPLATE_isa_if);
420         FIRM_DBG_REGISTER(dbg, "firm.be.TEMPLATE.cg");
421         TEMPLATE_init_transform();
422 }