aeb2ba63d87cca62fe0ba6b6b6f780fc9f5d3474
[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 "pseudo_irg.h"
28 #include "irgwalk.h"
29 #include "irprog.h"
30 #include "irprintf.h"
31 #include "ircons.h"
32 #include "irgmod.h"
33
34 #include "bitset.h"
35 #include "debug.h"
36
37 #include "be.h"
38 #include "../bearch.h"
39 #include "../benode.h"
40 #include "../belower.h"
41 #include "../besched.h"
42 #include "../beabi.h"
43 #include "../bemodule.h"
44 #include "../begnuas.h"
45 #include "../belistsched.h"
46
47 #include "bearch_TEMPLATE_t.h"
48
49 #include "TEMPLATE_new_nodes.h"
50 #include "gen_TEMPLATE_regalloc_if.h"
51 #include "TEMPLATE_transform.h"
52 #include "TEMPLATE_emitter.h"
53
54 DEBUG_ONLY(static firm_dbg_module_t *dbg = NULL;)
55
56 static arch_irn_class_t TEMPLATE_classify(const ir_node *irn)
57 {
58         (void) irn;
59         return 0;
60 }
61
62 static ir_entity *TEMPLATE_get_frame_entity(const ir_node *node)
63 {
64         (void) node;
65         /* TODO: return the ir_entity assigned to the frame */
66         return NULL;
67 }
68
69 /**
70  * This function is called by the generic backend to correct offsets for
71  * nodes accessing the stack.
72  */
73 static void TEMPLATE_set_frame_offset(ir_node *irn, int offset)
74 {
75         (void) irn;
76         (void) offset;
77         /* TODO: correct offset if irn accesses the stack */
78 }
79
80 static int TEMPLATE_get_sp_bias(const ir_node *irn)
81 {
82         (void) irn;
83         return 0;
84 }
85
86 /* fill register allocator interface */
87
88 static const arch_irn_ops_t TEMPLATE_irn_ops = {
89         get_TEMPLATE_in_req,
90         TEMPLATE_classify,
91         TEMPLATE_get_frame_entity,
92         TEMPLATE_set_frame_offset,
93         TEMPLATE_get_sp_bias,
94         NULL,    /* get_inverse             */
95         NULL,    /* get_op_estimated_cost   */
96         NULL,    /* possible_memory_operand */
97         NULL,    /* perform_memory_operand  */
98 };
99
100
101
102 /**
103  * Transforms the standard firm graph into
104  * a TEMLPATE firm graph
105  */
106 static void TEMPLATE_prepare_graph(void *self)
107 {
108         TEMPLATE_code_gen_t *cg = self;
109
110         /* transform nodes into assembler instructions */
111         TEMPLATE_transform_graph(cg);
112 }
113
114
115
116 /**
117  * Called immediatly before emit phase.
118  */
119 static void TEMPLATE_finish_irg(void *self)
120 {
121         (void) self;
122 }
123
124
125 static void TEMPLATE_before_ra(void *self)
126 {
127         (void) self;
128         /* Some stuff you need to do after scheduling but before register allocation */
129 }
130
131 static void TEMPLATE_after_ra(void *self)
132 {
133         (void) self;
134         /* Some stuff you need to do immediatly after register allocation */
135 }
136
137
138
139 /**
140  * Emits the code, closes the output file and frees
141  * the code generator interface.
142  */
143 static void TEMPLATE_emit_and_done(void *self)
144 {
145         TEMPLATE_code_gen_t *cg = self;
146         ir_graph           *irg = cg->irg;
147
148         TEMPLATE_emit_routine(irg);
149
150         /* de-allocate code generator */
151         free(cg);
152 }
153
154 static void *TEMPLATE_cg_init(ir_graph *irg);
155
156 static const arch_code_generator_if_t TEMPLATE_code_gen_if = {
157         TEMPLATE_cg_init,
158         NULL,                    /* get_pic_base hook */
159         NULL,                    /* before abi introduce hook */
160         TEMPLATE_prepare_graph,
161         NULL,                    /* spill hook */
162         TEMPLATE_before_ra,      /* before register allocation hook */
163         TEMPLATE_after_ra,       /* after register allocation hook */
164         TEMPLATE_finish_irg,
165         TEMPLATE_emit_and_done
166 };
167
168 /**
169  * Initializes the code generator.
170  */
171 static void *TEMPLATE_cg_init(ir_graph *irg)
172 {
173         const arch_env_t    *arch_env = be_get_irg_arch_env(irg);
174         TEMPLATE_isa_t      *isa      = (TEMPLATE_isa_t *) arch_env;
175         TEMPLATE_code_gen_t *cg       = XMALLOC(TEMPLATE_code_gen_t);
176
177         cg->impl = &TEMPLATE_code_gen_if;
178         cg->irg  = irg;
179         cg->isa  = isa;
180
181         return (arch_code_generator_t *)cg;
182 }
183
184
185
186 const arch_isa_if_t TEMPLATE_isa_if;
187 static TEMPLATE_isa_t TEMPLATE_isa_template = {
188         {
189                 &TEMPLATE_isa_if,             /* isa interface implementation */
190                 &TEMPLATE_gp_regs[REG_SP],  /* stack pointer register */
191                 &TEMPLATE_gp_regs[REG_BP],  /* base pointer register */
192                 &TEMPLATE_reg_classes[CLASS_TEMPLATE_gp],  /* link pointer register class */
193                 -1,                          /* stack direction */
194                 2,                           /* power of two stack alignment for calls, 2^2 == 4 */
195                 NULL,                        /* main environment */
196                 7,                           /* costs for a spill instruction */
197                 5,                           /* costs for a reload instruction */
198                 false,                       /* no custom abi handling */
199         },
200 };
201
202 /**
203  * Initializes the backend ISA
204  */
205 static arch_env_t *TEMPLATE_init(FILE *outfile)
206 {
207         static int run_once = 0;
208         TEMPLATE_isa_t *isa;
209
210         if (run_once)
211                 return NULL;
212         run_once = 1;
213
214         isa = XMALLOC(TEMPLATE_isa_t);
215         memcpy(isa, &TEMPLATE_isa_template, sizeof(*isa));
216
217         be_emit_init(outfile);
218
219         TEMPLATE_register_init();
220         TEMPLATE_create_opcodes(&TEMPLATE_irn_ops);
221
222         return &isa->arch_env;
223 }
224
225
226
227 /**
228  * Closes the output file and frees the ISA structure.
229  */
230 static void TEMPLATE_done(void *self)
231 {
232         TEMPLATE_isa_t *isa = self;
233
234         /* emit now all global declarations */
235         be_gas_emit_decls(isa->arch_env.main_env);
236
237         be_emit_exit();
238         free(self);
239 }
240
241
242 static unsigned TEMPLATE_get_n_reg_class(void)
243 {
244         return N_CLASSES;
245 }
246
247 static const arch_register_class_t *TEMPLATE_get_reg_class(unsigned i)
248 {
249         assert(i < N_CLASSES);
250         return &TEMPLATE_reg_classes[i];
251 }
252
253
254
255 /**
256  * Get the register class which shall be used to store a value of a given mode.
257  * @param self The this pointer.
258  * @param mode The mode in question.
259  * @return A register class which can hold values of the given mode.
260  */
261 static const arch_register_class_t *TEMPLATE_get_reg_class_for_mode(const ir_mode *mode)
262 {
263         if (mode_is_float(mode))
264                 return &TEMPLATE_reg_classes[CLASS_TEMPLATE_fp];
265         else
266                 return &TEMPLATE_reg_classes[CLASS_TEMPLATE_gp];
267 }
268
269
270
271 typedef struct {
272         be_abi_call_flags_bits_t flags;
273         const arch_env_t *arch_env;
274         ir_graph *irg;
275 } TEMPLATE_abi_env_t;
276
277 static void *TEMPLATE_abi_init(const be_abi_call_t *call, const arch_env_t *arch_env, ir_graph *irg)
278 {
279         TEMPLATE_abi_env_t *env = XMALLOC(TEMPLATE_abi_env_t);
280         be_abi_call_flags_t fl = be_abi_call_get_flags(call);
281         env->flags    = fl.bits;
282         env->irg      = irg;
283         env->arch_env = arch_env;
284         return env;
285 }
286
287 /**
288  * Get the between type for that call.
289  * @param self The callback object.
290  * @return The between type of for that call.
291  */
292 static ir_type *TEMPLATE_get_between_type(void *self)
293 {
294         static ir_type *between_type = NULL;
295         static ir_entity *old_bp_ent = NULL;
296         (void) self;
297
298         if (!between_type) {
299                 ir_entity *ret_addr_ent;
300                 ir_type *ret_addr_type = new_type_primitive(mode_P);
301                 ir_type *old_bp_type   = new_type_primitive(mode_P);
302
303                 between_type           = new_type_class(new_id_from_str("TEMPLATE_between_type"));
304                 old_bp_ent             = new_entity(between_type, new_id_from_str("old_bp"), old_bp_type);
305                 ret_addr_ent           = new_entity(between_type, new_id_from_str("old_bp"), ret_addr_type);
306
307                 set_entity_offset(old_bp_ent, 0);
308                 set_entity_offset(ret_addr_ent, get_type_size_bytes(old_bp_type));
309                 set_type_size_bytes(between_type, get_type_size_bytes(old_bp_type) + get_type_size_bytes(ret_addr_type));
310         }
311
312         return between_type;
313 }
314
315 /**
316  * Build the prolog, return the BASE POINTER register
317  */
318 static const arch_register_t *TEMPLATE_abi_prologue(void *self, ir_node **mem,
319                                                     pmap *reg_map, int *stack_bias)
320 {
321         TEMPLATE_abi_env_t *env = self;
322         (void) reg_map;
323         (void) mem;
324         (void) stack_bias;
325
326         if (env->flags.try_omit_fp)
327                 return env->arch_env->sp;
328         return env->arch_env->bp;
329 }
330
331 /* Build the epilog */
332 static void TEMPLATE_abi_epilogue(void *self, ir_node *bl, ir_node **mem,
333                                   pmap *reg_map)
334 {
335         (void) self;
336         (void) bl;
337         (void) mem;
338         (void) reg_map;
339 }
340
341 static const be_abi_callbacks_t TEMPLATE_abi_callbacks = {
342         TEMPLATE_abi_init,
343         free,
344         TEMPLATE_get_between_type,
345         TEMPLATE_abi_prologue,
346         TEMPLATE_abi_epilogue,
347 };
348
349 /**
350  * Get the ABI restrictions for procedure calls.
351  * @param self        The this pointer.
352  * @param method_type The type of the method (procedure) in question.
353  * @param abi         The abi object to be modified
354  */
355 static void TEMPLATE_get_call_abi(const void *self, ir_type *method_type,
356                                   be_abi_call_t *abi)
357 {
358         ir_type  *tp;
359         ir_mode  *mode;
360         int       i, n = get_method_n_params(method_type);
361         be_abi_call_flags_t call_flags;
362         (void) self;
363
364         /* set abi flags for calls */
365         call_flags.bits.left_to_right         = 0;
366         call_flags.bits.store_args_sequential = 1;
367         call_flags.bits.try_omit_fp           = 1;
368         call_flags.bits.fp_free               = 0;
369         call_flags.bits.call_has_imm          = 1;
370
371         /* set stack parameter passing style */
372         be_abi_call_set_flags(abi, call_flags, &TEMPLATE_abi_callbacks);
373
374         for (i = 0; i < n; i++) {
375                 /* TODO: implement register parameter: */
376                 /* reg = get reg for param i;          */
377                 /* be_abi_call_param_reg(abi, i, reg, ABI_CONTEXT_BOTH); */
378
379                 /* default: all parameters on stack */
380                 tp   = get_method_param_type(method_type, i);
381                 mode = get_type_mode(tp);
382                 be_abi_call_param_stack(abi, i, mode, 4, 0, 0, ABI_CONTEXT_BOTH);
383         }
384
385         /* TODO: set correct return register */
386         /* default: return value is in R0 resp. F0 */
387         if (get_method_n_ress(method_type) > 0) {
388                 tp   = get_method_res_type(method_type, 0);
389                 mode = get_type_mode(tp);
390
391                 be_abi_call_res_reg(abi, 0,
392                         mode_is_float(mode) ? &TEMPLATE_fp_regs[REG_F0] : &TEMPLATE_gp_regs[REG_R0], ABI_CONTEXT_BOTH);
393         }
394 }
395
396 static int TEMPLATE_to_appear_in_schedule(void *block_env, const ir_node *irn)
397 {
398         (void) block_env;
399
400         if (!is_TEMPLATE_irn(irn))
401                 return -1;
402
403         return 1;
404 }
405
406 /**
407  * Initializes the code generator interface.
408  */
409 static const arch_code_generator_if_t *TEMPLATE_get_code_generator_if(
410                 void *self)
411 {
412         (void) self;
413         return &TEMPLATE_code_gen_if;
414 }
415
416 list_sched_selector_t TEMPLATE_sched_selector;
417
418 /**
419  * Returns the reg_pressure scheduler with to_appear_in_schedule() overloaded
420  */
421 static const list_sched_selector_t *TEMPLATE_get_list_sched_selector(
422                 const void *self, list_sched_selector_t *selector)
423 {
424         (void) self;
425         (void) selector;
426
427         TEMPLATE_sched_selector = trivial_selector;
428         TEMPLATE_sched_selector.to_appear_in_schedule = TEMPLATE_to_appear_in_schedule;
429         return &TEMPLATE_sched_selector;
430 }
431
432 static const ilp_sched_selector_t *TEMPLATE_get_ilp_sched_selector(
433                 const void *self)
434 {
435         (void) self;
436         return NULL;
437 }
438
439 /**
440  * Returns the necessary byte alignment for storing a register of given class.
441  */
442 static int TEMPLATE_get_reg_class_alignment(const arch_register_class_t *cls)
443 {
444         ir_mode *mode = arch_register_class_mode(cls);
445         return get_mode_size_bytes(mode);
446 }
447
448 /**
449  * Returns the libFirm configuration parameter for this backend.
450  */
451 static const backend_params *TEMPLATE_get_backend_params(void)
452 {
453         static backend_params p = {
454                 0,     /* no dword lowering */
455                 0,     /* no inline assembly */
456                 NULL,  /* will be set later */
457                 NULL,  /* no creator function */
458                 NULL,  /* context for create_intrinsic_fkt */
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 }