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