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