backend is responsible for defining what lowering operations need to be performed...
[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         get_TEMPLATE_in_req,
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(void *self)
106 {
107         TEMPLATE_code_gen_t *cg = self;
108
109         /* transform nodes into assembler instructions */
110         TEMPLATE_transform_graph(cg);
111 }
112
113
114
115 /**
116  * Called immediatly before emit phase.
117  */
118 static void TEMPLATE_finish_irg(void *self)
119 {
120         (void) self;
121 }
122
123
124 static void TEMPLATE_before_ra(void *self)
125 {
126         (void) self;
127         /* Some stuff you need to do after scheduling but before register allocation */
128 }
129
130 static void TEMPLATE_after_ra(void *self)
131 {
132         (void) self;
133         /* Some stuff you need to do immediatly after register allocation */
134 }
135
136
137
138 /**
139  * Emits the code, closes the output file and frees
140  * the code generator interface.
141  */
142 static void TEMPLATE_emit_and_done(void *self)
143 {
144         TEMPLATE_code_gen_t *cg = self;
145         ir_graph           *irg = cg->irg;
146
147         TEMPLATE_emit_routine(irg);
148
149         /* de-allocate code generator */
150         free(cg);
151 }
152
153 static void *TEMPLATE_cg_init(ir_graph *irg);
154
155 static const arch_code_generator_if_t TEMPLATE_code_gen_if = {
156         TEMPLATE_cg_init,
157         NULL,                    /* get_pic_base hook */
158         NULL,                    /* before abi introduce hook */
159         TEMPLATE_prepare_graph,
160         NULL,                    /* spill hook */
161         TEMPLATE_before_ra,      /* before register allocation hook */
162         TEMPLATE_after_ra,       /* after register allocation hook */
163         TEMPLATE_finish_irg,
164         TEMPLATE_emit_and_done
165 };
166
167 /**
168  * Initializes the code generator.
169  */
170 static void *TEMPLATE_cg_init(ir_graph *irg)
171 {
172         const arch_env_t    *arch_env = be_get_irg_arch_env(irg);
173         TEMPLATE_isa_t      *isa      = (TEMPLATE_isa_t *) arch_env;
174         TEMPLATE_code_gen_t *cg       = XMALLOC(TEMPLATE_code_gen_t);
175
176         cg->impl = &TEMPLATE_code_gen_if;
177         cg->irg  = irg;
178         cg->isa  = isa;
179
180         return (arch_code_generator_t *)cg;
181 }
182
183
184
185 const arch_isa_if_t TEMPLATE_isa_if;
186 static TEMPLATE_isa_t TEMPLATE_isa_template = {
187         {
188                 &TEMPLATE_isa_if,             /* isa interface implementation */
189                 &TEMPLATE_gp_regs[REG_SP],  /* stack pointer register */
190                 &TEMPLATE_gp_regs[REG_BP],  /* base pointer register */
191                 &TEMPLATE_reg_classes[CLASS_TEMPLATE_gp],  /* link pointer register class */
192                 -1,                          /* stack direction */
193                 2,                           /* power of two stack alignment for calls, 2^2 == 4 */
194                 NULL,                        /* main environment */
195                 7,                           /* costs for a spill instruction */
196                 5,                           /* costs for a reload instruction */
197                 false,                       /* no custom abi handling */
198         },
199 };
200
201 /**
202  * Initializes the backend ISA
203  */
204 static arch_env_t *TEMPLATE_init(FILE *outfile)
205 {
206         static int run_once = 0;
207         TEMPLATE_isa_t *isa;
208
209         if (run_once)
210                 return NULL;
211         run_once = 1;
212
213         isa = XMALLOC(TEMPLATE_isa_t);
214         memcpy(isa, &TEMPLATE_isa_template, sizeof(*isa));
215
216         be_emit_init(outfile);
217
218         TEMPLATE_register_init();
219         TEMPLATE_create_opcodes(&TEMPLATE_irn_ops);
220
221         return &isa->base;
222 }
223
224
225
226 /**
227  * Closes the output file and frees the ISA structure.
228  */
229 static void TEMPLATE_done(void *self)
230 {
231         TEMPLATE_isa_t *isa = self;
232
233         /* emit now all global declarations */
234         be_gas_emit_decls(isa->base.main_env);
235
236         be_emit_exit();
237         free(self);
238 }
239
240
241 static unsigned TEMPLATE_get_n_reg_class(void)
242 {
243         return N_CLASSES;
244 }
245
246 static const arch_register_class_t *TEMPLATE_get_reg_class(unsigned i)
247 {
248         assert(i < N_CLASSES);
249         return &TEMPLATE_reg_classes[i];
250 }
251
252
253
254 /**
255  * Get the register class which shall be used to store a value of a given mode.
256  * @param self The this pointer.
257  * @param mode The mode in question.
258  * @return A register class which can hold values of the given mode.
259  */
260 static const arch_register_class_t *TEMPLATE_get_reg_class_for_mode(const ir_mode *mode)
261 {
262         if (mode_is_float(mode))
263                 return &TEMPLATE_reg_classes[CLASS_TEMPLATE_fp];
264         else
265                 return &TEMPLATE_reg_classes[CLASS_TEMPLATE_gp];
266 }
267
268
269
270 typedef struct {
271         be_abi_call_flags_bits_t flags;
272         ir_graph                *irg;
273 } TEMPLATE_abi_env_t;
274
275 static void *TEMPLATE_abi_init(const be_abi_call_t *call, ir_graph *irg)
276 {
277         TEMPLATE_abi_env_t *env = XMALLOC(TEMPLATE_abi_env_t);
278         be_abi_call_flags_t fl = be_abi_call_get_flags(call);
279         env->flags    = fl.bits;
280         env->irg      = irg;
281         return env;
282 }
283
284 /**
285  * Get the between type for that call.
286  * @param self The callback object.
287  * @return The between type of for that call.
288  */
289 static ir_type *TEMPLATE_get_between_type(void *self)
290 {
291         static ir_type *between_type = NULL;
292         static ir_entity *old_bp_ent = NULL;
293         (void) self;
294
295         if (!between_type) {
296                 ir_entity *ret_addr_ent;
297                 ir_type *ret_addr_type = new_type_primitive(mode_P);
298                 ir_type *old_bp_type   = new_type_primitive(mode_P);
299
300                 between_type           = new_type_class(new_id_from_str("TEMPLATE_between_type"));
301                 old_bp_ent             = new_entity(between_type, new_id_from_str("old_bp"), old_bp_type);
302                 ret_addr_ent           = new_entity(between_type, new_id_from_str("old_bp"), ret_addr_type);
303
304                 set_entity_offset(old_bp_ent, 0);
305                 set_entity_offset(ret_addr_ent, get_type_size_bytes(old_bp_type));
306                 set_type_size_bytes(between_type, get_type_size_bytes(old_bp_type) + get_type_size_bytes(ret_addr_type));
307         }
308
309         return between_type;
310 }
311
312 /**
313  * Build the prolog, return the BASE POINTER register
314  */
315 static const arch_register_t *TEMPLATE_abi_prologue(void *self, ir_node **mem,
316                                                     pmap *reg_map, int *stack_bias)
317 {
318         TEMPLATE_abi_env_t *env      = self;
319         const arch_env_t   *arch_env = be_get_irg_arch_env(env->irg);
320         (void) reg_map;
321         (void) mem;
322         (void) stack_bias;
323
324         if (env->flags.try_omit_fp)
325                 return arch_env->sp;
326         return arch_env->bp;
327 }
328
329 /* Build the epilog */
330 static void TEMPLATE_abi_epilogue(void *self, ir_node *bl, ir_node **mem,
331                                   pmap *reg_map)
332 {
333         (void) self;
334         (void) bl;
335         (void) mem;
336         (void) reg_map;
337 }
338
339 static const be_abi_callbacks_t TEMPLATE_abi_callbacks = {
340         TEMPLATE_abi_init,
341         free,
342         TEMPLATE_get_between_type,
343         TEMPLATE_abi_prologue,
344         TEMPLATE_abi_epilogue,
345 };
346
347 /**
348  * Get the ABI restrictions for procedure calls.
349  * @param self        The this pointer.
350  * @param method_type The type of the method (procedure) in question.
351  * @param abi         The abi object to be modified
352  */
353 static void TEMPLATE_get_call_abi(const void *self, ir_type *method_type,
354                                   be_abi_call_t *abi)
355 {
356         ir_type  *tp;
357         ir_mode  *mode;
358         int       i, n = get_method_n_params(method_type);
359         be_abi_call_flags_t call_flags;
360         (void) self;
361
362         /* set abi flags for calls */
363         call_flags.bits.left_to_right         = 0;
364         call_flags.bits.store_args_sequential = 1;
365         call_flags.bits.try_omit_fp           = 1;
366         call_flags.bits.fp_free               = 0;
367         call_flags.bits.call_has_imm          = 1;
368
369         /* set stack parameter passing style */
370         be_abi_call_set_flags(abi, call_flags, &TEMPLATE_abi_callbacks);
371
372         for (i = 0; i < n; i++) {
373                 /* TODO: implement register parameter: */
374                 /* reg = get reg for param i;          */
375                 /* be_abi_call_param_reg(abi, i, reg, ABI_CONTEXT_BOTH); */
376
377                 /* default: all parameters on stack */
378                 tp   = get_method_param_type(method_type, i);
379                 mode = get_type_mode(tp);
380                 be_abi_call_param_stack(abi, i, mode, 4, 0, 0, ABI_CONTEXT_BOTH);
381         }
382
383         /* TODO: set correct return register */
384         /* default: return value is in R0 resp. F0 */
385         if (get_method_n_ress(method_type) > 0) {
386                 tp   = get_method_res_type(method_type, 0);
387                 mode = get_type_mode(tp);
388
389                 be_abi_call_res_reg(abi, 0,
390                         mode_is_float(mode) ? &TEMPLATE_fp_regs[REG_F0] : &TEMPLATE_gp_regs[REG_R0], ABI_CONTEXT_BOTH);
391         }
392 }
393
394 static int TEMPLATE_to_appear_in_schedule(void *block_env, const ir_node *irn)
395 {
396         (void) block_env;
397
398         if (!is_TEMPLATE_irn(irn))
399                 return -1;
400
401         return 1;
402 }
403
404 /**
405  * Initializes the code generator interface.
406  */
407 static const arch_code_generator_if_t *TEMPLATE_get_code_generator_if(
408                 void *self)
409 {
410         (void) self;
411         return &TEMPLATE_code_gen_if;
412 }
413
414 list_sched_selector_t TEMPLATE_sched_selector;
415
416 /**
417  * Returns the reg_pressure scheduler with to_appear_in_schedule() overloaded
418  */
419 static const list_sched_selector_t *TEMPLATE_get_list_sched_selector(
420                 const void *self, list_sched_selector_t *selector)
421 {
422         (void) self;
423         (void) selector;
424
425         TEMPLATE_sched_selector = trivial_selector;
426         TEMPLATE_sched_selector.to_appear_in_schedule = TEMPLATE_to_appear_in_schedule;
427         return &TEMPLATE_sched_selector;
428 }
429
430 static const ilp_sched_selector_t *TEMPLATE_get_ilp_sched_selector(
431                 const void *self)
432 {
433         (void) self;
434         return NULL;
435 }
436
437 /**
438  * Returns the necessary byte alignment for storing a register of given class.
439  */
440 static int TEMPLATE_get_reg_class_alignment(const arch_register_class_t *cls)
441 {
442         ir_mode *mode = arch_register_class_mode(cls);
443         return get_mode_size_bytes(mode);
444 }
445
446 static void TEMPLATE_lower_for_target(void)
447 {
448 }
449
450 /**
451  * Returns the libFirm configuration parameter for this backend.
452  */
453 static const backend_params *TEMPLATE_get_backend_params(void)
454 {
455         static backend_params p = {
456                 0,     /* no inline assembly */
457                 TEMPLATE_lower_for_target,  /* lowering for target */
458                 NULL,  /* architecture dependent settings, will be set later */
459                 NULL,  /* parameter for if conversion */
460                 NULL,  /* float arithmetic mode */
461                 0,     /* no trampoline support: size 0 */
462                 0,     /* no trampoline support: align 0 */
463                 NULL,  /* no trampoline support: no trampoline builder */
464                 4      /* alignment of stack parameter: typically 4 (32bit) or 8 (64bit) */
465         };
466         return &p;
467 }
468
469 static const be_execution_unit_t ***TEMPLATE_get_allowed_execution_units(
470                 const ir_node *irn)
471 {
472         (void) irn;
473         /* TODO */
474         return NULL;
475 }
476
477 static const be_machine_t *TEMPLATE_get_machine(const void *self)
478 {
479         (void) self;
480         /* TODO */
481         return NULL;
482 }
483
484 static ir_graph **TEMPLATE_get_backend_irg_list(const void *self,
485                                                 ir_graph ***irgs)
486 {
487         (void) self;
488         (void) irgs;
489         return NULL;
490 }
491
492 static asm_constraint_flags_t TEMPLATE_parse_asm_constraint(const char **c)
493 {
494         (void) c;
495         return ASM_CONSTRAINT_FLAG_INVALID;
496 }
497
498 static int TEMPLATE_is_valid_clobber(const char *clobber)
499 {
500         (void) clobber;
501         return 0;
502 }
503
504 const arch_isa_if_t TEMPLATE_isa_if = {
505         TEMPLATE_init,
506         TEMPLATE_done,
507         NULL,                /* handle intrinsics */
508         TEMPLATE_get_n_reg_class,
509         TEMPLATE_get_reg_class,
510         TEMPLATE_get_reg_class_for_mode,
511         TEMPLATE_get_call_abi,
512         TEMPLATE_get_code_generator_if,
513         TEMPLATE_get_list_sched_selector,
514         TEMPLATE_get_ilp_sched_selector,
515         TEMPLATE_get_reg_class_alignment,
516     TEMPLATE_get_backend_params,
517         TEMPLATE_get_allowed_execution_units,
518         TEMPLATE_get_machine,
519         TEMPLATE_get_backend_irg_list,
520         NULL,                    /* mark remat */
521         TEMPLATE_parse_asm_constraint,
522         TEMPLATE_is_valid_clobber
523 };
524
525 BE_REGISTER_MODULE_CONSTRUCTOR(be_init_arch_TEMPLATE);
526 void be_init_arch_TEMPLATE(void)
527 {
528         be_register_isa_if("TEMPLATE", &TEMPLATE_isa_if);
529         FIRM_DBG_REGISTER(dbg, "firm.be.TEMPLATE.cg");
530         TEMPLATE_init_transform();
531 }