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