- change #include <config.h> back to "config.h"
[libfirm] / ir / be / TEMPLATE / bearch_TEMPLATE.c
1 /* The main TEMPLATE backend driver file. */
2 /* $Id$ */
3 #ifdef HAVE_CONFIG_H
4 #include "config.h"
5 #endif
6
7 #include "pseudo_irg.h"
8 #include "irgwalk.h"
9 #include "irprog.h"
10 #include "irprintf.h"
11 #include "ircons.h"
12 #include "irgmod.h"
13
14 #include "bitset.h"
15 #include "debug.h"
16
17 #include "../bearch.h"                /* the general register allocator interface */
18 #include "../benode_t.h"
19 #include "../belower.h"
20 #include "../besched_t.h"
21 #include "../be.h"
22 #include "../beabi.h"
23 #include "../bemodule.h"
24 #include "../begnuas.h"
25
26 #include "bearch_TEMPLATE_t.h"
27
28 #include "TEMPLATE_new_nodes.h"           /* TEMPLATE nodes interface */
29 #include "gen_TEMPLATE_regalloc_if.h"     /* the generated interface (register type and class defenitions) */
30 #include "TEMPLATE_transform.h"
31 #include "TEMPLATE_emitter.h"
32 #include "TEMPLATE_map_regs.h"
33
34 /* TODO: ugly, but we need it to get access to the registers assigned to Phi nodes */
35 static set *cur_reg_set = NULL;
36
37 /**************************************************
38  *                         _ _              _  __
39  *                        | | |            (_)/ _|
40  *  _ __ ___  __ _    __ _| | | ___   ___   _| |_
41  * | '__/ _ \/ _` |  / _` | | |/ _ \ / __| | |  _|
42  * | | |  __/ (_| | | (_| | | | (_) | (__  | | |
43  * |_|  \___|\__, |  \__,_|_|_|\___/ \___| |_|_|
44  *            __/ |
45  *           |___/
46  **************************************************/
47
48 /**
49  * Return register requirements for a TEMPLATE node.
50  * If the node returns a tuple (mode_T) then the proj's
51  * will be asked for this information.
52  */
53 static const
54 arch_register_req_t *TEMPLATE_get_irn_reg_req(const void *self,
55                                               const ir_node *node, int pos) {
56         long               node_pos = pos == -1 ? 0 : pos;
57         ir_mode           *mode     = get_irn_mode(node);
58
59         if (mode == mode_T || mode == mode_M) {
60                 return arch_no_register_req;
61         }
62
63         if (is_Proj(node)) {
64                 /* in case of a proj, we need to get the correct OUT slot */
65                 /* of the node corresponding to the proj number */
66                 if (pos == -1) {
67                         node_pos = TEMPLATE_translate_proj_pos(node);
68                 } else {
69                         node_pos = pos;
70                 }
71
72                 node = skip_Proj_const(node);
73         }
74
75         /* get requirements for our own nodes */
76         if (is_TEMPLATE_irn(node)) {
77                 const arch_register_req_t *req;
78                 if (pos >= 0) {
79                         req = get_TEMPLATE_in_req(node, pos);
80                 } else {
81                         req = get_TEMPLATE_out_req(node, node_pos);
82                 }
83
84                 assert(req != NULL);
85
86                 return req;
87         }
88
89         /* unknowns should be transformed already */
90         assert(!is_Unknown(node));
91
92         return arch_no_register_req;
93 }
94
95 static void TEMPLATE_set_irn_reg(const void *self, ir_node *irn, const arch_register_t *reg) {
96         int pos = 0;
97
98         if (is_Proj(irn)) {
99                 pos = TEMPLATE_translate_proj_pos(irn);
100                 irn = skip_Proj(irn);
101         }
102
103         if (is_TEMPLATE_irn(irn)) {
104                 const arch_register_t **slots;
105
106                 slots      = get_TEMPLATE_slots(irn);
107                 slots[pos] = reg;
108         }
109         else {
110                 /* here we set the registers for the Phi nodes */
111                 TEMPLATE_set_firm_reg(irn, reg, cur_reg_set);
112         }
113 }
114
115 static const arch_register_t *TEMPLATE_get_irn_reg(const void *self, const ir_node *irn) {
116         int pos = 0;
117         const arch_register_t *reg = NULL;
118
119         if (is_Proj(irn)) {
120                 pos = TEMPLATE_translate_proj_pos(irn);
121                 irn = skip_Proj_const(irn);
122         }
123
124         if (is_TEMPLATE_irn(irn)) {
125                 const arch_register_t **slots;
126                 slots = get_TEMPLATE_slots(irn);
127                 reg   = slots[pos];
128         }
129         else {
130                 reg = TEMPLATE_get_firm_reg(irn, cur_reg_set);
131         }
132
133         return reg;
134 }
135
136 static arch_irn_class_t TEMPLATE_classify(const void *self, const ir_node *irn) {
137         irn = skip_Proj_const(irn);
138
139         if (is_cfop(irn)) {
140                 return arch_irn_class_branch;
141         }
142         else if (is_TEMPLATE_irn(irn)) {
143                 return arch_irn_class_normal;
144         }
145
146         return 0;
147 }
148
149 static arch_irn_flags_t TEMPLATE_get_flags(const void *self, const ir_node *irn) {
150         irn = skip_Proj_const(irn);
151
152         if (is_TEMPLATE_irn(irn)) {
153                 return get_TEMPLATE_flags(irn);
154         }
155         else if (is_Unknown(irn)) {
156                 return arch_irn_flags_ignore;
157         }
158
159         return 0;
160 }
161
162 static ir_entity *TEMPLATE_get_frame_entity(const void *self, const ir_node *node) {
163         /* TODO: return the ir_entity assigned to the frame */
164         return NULL;
165 }
166
167 static void TEMPLATE_set_frame_entity(const void *self, ir_node *node, ir_entity *ent) {
168         /* TODO: set the ir_entity assigned to the frame */
169 }
170
171 /**
172  * This function is called by the generic backend to correct offsets for
173  * nodes accessing the stack.
174  */
175 static void TEMPLATE_set_frame_offset(const void *self, ir_node *irn, int offset) {
176         /* TODO: correct offset if irn accesses the stack */
177 }
178
179 static int TEMPLATE_get_sp_bias(const void *self, const ir_node *irn) {
180         return 0;
181 }
182
183 /* fill register allocator interface */
184
185 static const arch_irn_ops_if_t TEMPLATE_irn_ops_if = {
186         TEMPLATE_get_irn_reg_req,
187         TEMPLATE_set_irn_reg,
188         TEMPLATE_get_irn_reg,
189         TEMPLATE_classify,
190         TEMPLATE_get_flags,
191         TEMPLATE_get_frame_entity,
192         TEMPLATE_set_frame_entity,
193         TEMPLATE_set_frame_offset,
194         TEMPLATE_get_sp_bias,
195         NULL,    /* get_inverse             */
196         NULL,    /* get_op_estimated_cost   */
197         NULL,    /* possible_memory_operand */
198         NULL,    /* perform_memory_operand  */
199 };
200
201 TEMPLATE_irn_ops_t TEMPLATE_irn_ops = {
202         &TEMPLATE_irn_ops_if,
203         NULL
204 };
205
206
207
208 /**************************************************
209  *                _                         _  __
210  *               | |                       (_)/ _|
211  *   ___ ___   __| | ___  __ _  ___ _ __    _| |_
212  *  / __/ _ \ / _` |/ _ \/ _` |/ _ \ '_ \  | |  _|
213  * | (_| (_) | (_| |  __/ (_| |  __/ | | | | | |
214  *  \___\___/ \__,_|\___|\__, |\___|_| |_| |_|_|
215  *                        __/ |
216  *                       |___/
217  **************************************************/
218
219 /**
220  * Transforms the standard firm graph into
221  * a TEMLPATE firm graph
222  */
223 static void TEMPLATE_prepare_graph(void *self) {
224         TEMPLATE_code_gen_t *cg = self;
225
226         irg_walk_blkwise_graph(cg->irg, NULL, TEMPLATE_transform_node, cg);
227 }
228
229
230
231 /**
232  * Called immediatly before emit phase.
233  */
234 static void TEMPLATE_finish_irg(void *self) {
235         TEMPLATE_code_gen_t *cg = self;
236         ir_graph            *irg = cg->irg;
237
238         dump_ir_block_graph_sched(irg, "-TEMPLATE-finished");
239 }
240
241
242 /**
243  * These are some hooks which must be filled but are probably not needed.
244  */
245 static void TEMPLATE_before_sched(void *self) {
246         /* Some stuff you need to do after scheduling but before register allocation */
247 }
248
249 static void TEMPLATE_before_ra(void *self) {
250         /* Some stuff you need to do after scheduling but before register allocation */
251 }
252
253 static void TEMPLATE_after_ra(void *self) {
254         /* Some stuff you need to do immediatly after register allocation */
255 }
256
257
258
259 /**
260  * Emits the code, closes the output file and frees
261  * the code generator interface.
262  */
263 static void TEMPLATE_emit_and_done(void *self) {
264         TEMPLATE_code_gen_t *cg = self;
265         ir_graph           *irg = cg->irg;
266
267         TEMPLATE_gen_routine(cg, irg);
268
269         cur_reg_set = NULL;
270
271         /* de-allocate code generator */
272         del_set(cg->reg_set);
273         free(self);
274 }
275
276 static void *TEMPLATE_cg_init(be_irg_t *birg);
277
278 static const arch_code_generator_if_t TEMPLATE_code_gen_if = {
279         TEMPLATE_cg_init,
280         NULL,                    /* before abi introduce hook */
281         TEMPLATE_prepare_graph,
282         NULL,                    /* spill hook */
283         TEMPLATE_before_sched,   /* before scheduling hook */
284         TEMPLATE_before_ra,      /* before register allocation hook */
285         TEMPLATE_after_ra,       /* after register allocation hook */
286         TEMPLATE_finish_irg,
287         TEMPLATE_emit_and_done
288 };
289
290 /**
291  * Initializes the code generator.
292  */
293 static void *TEMPLATE_cg_init(be_irg_t *birg) {
294         TEMPLATE_isa_t      *isa = (TEMPLATE_isa_t *)birg->main_env->arch_env->isa;
295         TEMPLATE_code_gen_t *cg  = xmalloc(sizeof(*cg));
296
297         cg->impl     = &TEMPLATE_code_gen_if;
298         cg->irg      = birg->irg;
299         cg->reg_set  = new_set(TEMPLATE_cmp_irn_reg_assoc, 1024);
300         cg->arch_env = birg->main_env->arch_env;
301         cg->isa      = isa;
302         cg->birg     = birg;
303         FIRM_DBG_REGISTER(cg->mod, "firm.be.TEMPLATE.cg");
304
305         cur_reg_set = cg->reg_set;
306
307         TEMPLATE_irn_ops.cg = cg;
308
309         return (arch_code_generator_t *)cg;
310 }
311
312
313
314 /*****************************************************************
315  *  ____             _                  _   _____  _____
316  * |  _ \           | |                | | |_   _|/ ____|  /\
317  * | |_) | __ _  ___| | _____ _ __   __| |   | | | (___   /  \
318  * |  _ < / _` |/ __| |/ / _ \ '_ \ / _` |   | |  \___ \ / /\ \
319  * | |_) | (_| | (__|   <  __/ | | | (_| |  _| |_ ____) / ____ \
320  * |____/ \__,_|\___|_|\_\___|_| |_|\__,_| |_____|_____/_/    \_\
321  *
322  *****************************************************************/
323
324 static TEMPLATE_isa_t TEMPLATE_isa_template = {
325         {
326                 &TEMPLATE_isa_if,             /* isa interface implementation */
327                 &TEMPLATE_general_purpose_regs[REG_SP],  /* stack pointer register */
328                 &TEMPLATE_general_purpose_regs[REG_BP],  /* base pointer register */
329                 -1,                          /* stack direction */
330                 NULL,                        /* main environment */
331         },
332         {},                              /* emitter environment */
333 };
334
335 /**
336  * Initializes the backend ISA and opens the output file.
337  */
338 static void *TEMPLATE_init(FILE *outfile) {
339         static int run_once = 0;
340         TEMPLATE_isa_t *isa;
341
342         if(run_once)
343                 return NULL;
344         run_once = 1;
345
346         isa = xcalloc(1, sizeof(*isa));
347         memcpy(isa, &TEMPLATE_isa_template, sizeof(*isa));
348
349         be_emit_init_env(&isa->emit, outfile);
350
351         TEMPLATE_register_init(isa);
352         TEMPLATE_create_opcodes();
353
354         return isa;
355 }
356
357
358
359 /**
360  * Closes the output file and frees the ISA structure.
361  */
362 static void TEMPLATE_done(void *self) {
363         TEMPLATE_isa_t *isa = self;
364
365         /* emit now all global declarations */
366         be_gas_emit_decls(&isa->emit, isa->arch_isa.main_env);
367
368         be_emit_destroy_env(&isa->emit);
369         free(self);
370 }
371
372
373
374 static int TEMPLATE_get_n_reg_class(const void *self) {
375         return N_CLASSES;
376 }
377
378 static const arch_register_class_t *TEMPLATE_get_reg_class(const void *self, int i) {
379         assert(i >= 0 && i < N_CLASSES && "Invalid TEMPLATE register class requested.");
380         return &TEMPLATE_reg_classes[i];
381 }
382
383
384
385 /**
386  * Get the register class which shall be used to store a value of a given mode.
387  * @param self The this pointer.
388  * @param mode The mode in question.
389  * @return A register class which can hold values of the given mode.
390  */
391 const arch_register_class_t *TEMPLATE_get_reg_class_for_mode(const void *self, const ir_mode *mode) {
392         if (mode_is_float(mode))
393                 return &TEMPLATE_reg_classes[CLASS_TEMPLATE_floating_point];
394         else
395                 return &TEMPLATE_reg_classes[CLASS_TEMPLATE_general_purpose];
396 }
397
398
399
400 typedef struct {
401         be_abi_call_flags_bits_t flags;
402         const arch_env_t *arch_env;
403         const arch_isa_t *isa;
404         ir_graph *irg;
405 } TEMPLATE_abi_env_t;
406
407 static void *TEMPLATE_abi_init(const be_abi_call_t *call, const arch_env_t *arch_env, ir_graph *irg)
408 {
409         TEMPLATE_abi_env_t *env = xmalloc(sizeof(env[0]));
410         be_abi_call_flags_t fl = be_abi_call_get_flags(call);
411         env->flags    = fl.bits;
412         env->irg      = irg;
413         env->arch_env = arch_env;
414         env->isa      = arch_env->isa;
415         return env;
416 }
417
418 /**
419  * Get the between type for that call.
420  * @param self The callback object.
421  * @return The between type of for that call.
422  */
423 static ir_type *TEMPLATE_get_between_type(void *self) {
424         //TEMPLATE_abi_env_t *env = self;
425         static ir_type *between_type = NULL;
426         static ir_entity *old_bp_ent    = NULL;
427
428         if(!between_type) {
429                 ir_entity *ret_addr_ent;
430                 ir_type *ret_addr_type = new_type_primitive(new_id_from_str("return_addr"), mode_P);
431                 ir_type *old_bp_type   = new_type_primitive(new_id_from_str("bp"), mode_P);
432
433                 between_type           = new_type_class(new_id_from_str("TEMPLATE_between_type"));
434                 old_bp_ent             = new_entity(between_type, new_id_from_str("old_bp"), old_bp_type);
435                 ret_addr_ent           = new_entity(between_type, new_id_from_str("old_bp"), ret_addr_type);
436
437                 set_entity_offset(old_bp_ent, 0);
438                 set_entity_offset(ret_addr_ent, get_type_size_bytes(old_bp_type));
439                 set_type_size_bytes(between_type, get_type_size_bytes(old_bp_type) + get_type_size_bytes(ret_addr_type));
440         }
441
442         return between_type;
443 }
444
445 static void TEMPLATE_abi_dont_save_regs(void *self, pset *s)
446 {
447         TEMPLATE_abi_env_t *env = self;
448         if (env->flags.try_omit_fp) {
449                 /* insert the BP register into the ignore set */
450                 pset_insert_ptr(s, env->isa->bp);
451         }
452 }
453
454 /**
455  * Build the prolog, return the BASE POINTER register
456  */
457 static const arch_register_t *TEMPLATE_abi_prologue(void *self, ir_node **mem, pmap *reg_map) {
458         TEMPLATE_abi_env_t *env = self;
459
460         if(env->flags.try_omit_fp)
461                 return env->isa->sp;
462         return env->isa->bp;
463 }
464
465 /* Build the epilog */
466 static void TEMPLATE_abi_epilogue(void *self, ir_node *bl, ir_node **mem, pmap *reg_map) {
467         //TEMPLATE_abi_env_t *env = self;
468 }
469
470 static const be_abi_callbacks_t TEMPLATE_abi_callbacks = {
471         TEMPLATE_abi_init,
472         free,
473         TEMPLATE_get_between_type,
474         TEMPLATE_abi_dont_save_regs,
475         TEMPLATE_abi_prologue,
476         TEMPLATE_abi_epilogue,
477 };
478
479 /**
480  * Get the ABI restrictions for procedure calls.
481  * @param self        The this pointer.
482  * @param method_type The type of the method (procedure) in question.
483  * @param abi         The abi object to be modified
484  */
485 void TEMPLATE_get_call_abi(const void *self, ir_type *method_type, be_abi_call_t *abi) {
486         ir_type  *tp;
487         ir_mode  *mode;
488         int       i, n = get_method_n_params(method_type);
489         be_abi_call_flags_t call_flags;
490
491         /* set abi flags for calls */
492         call_flags.bits.left_to_right         = 0;
493         call_flags.bits.store_args_sequential = 1;
494         call_flags.bits.try_omit_fp           = 1;
495         call_flags.bits.fp_free               = 0;
496         call_flags.bits.call_has_imm          = 1;
497
498         /* set stack parameter passing style */
499         be_abi_call_set_flags(abi, call_flags, &TEMPLATE_abi_callbacks);
500
501         for (i = 0; i < n; i++) {
502                 /* TODO: implement register parameter: */
503                 /* reg = get reg for param i;          */
504                 /* be_abi_call_param_reg(abi, i, reg); */
505
506                 /* default: all parameters on stack */
507                 be_abi_call_param_stack(abi, i, 4, 0, 0);
508         }
509
510         /* TODO: set correct return register */
511         /* default: return value is in R0 resp. F0 */
512         if (get_method_n_ress(method_type) > 0) {
513                 tp   = get_method_res_type(method_type, 0);
514                 mode = get_type_mode(tp);
515
516                 be_abi_call_res_reg(abi, 0,
517                         mode_is_float(mode) ? &TEMPLATE_floating_point_regs[REG_F0] : &TEMPLATE_general_purpose_regs[REG_R0]);
518         }
519 }
520
521 static const void *TEMPLATE_get_irn_ops(const arch_irn_handler_t *self, const ir_node *irn) {
522         return &TEMPLATE_irn_ops;
523 }
524
525 const arch_irn_handler_t TEMPLATE_irn_handler = {
526         TEMPLATE_get_irn_ops
527 };
528
529 const arch_irn_handler_t *TEMPLATE_get_irn_handler(const void *self) {
530         return &TEMPLATE_irn_handler;
531 }
532
533 int TEMPLATE_to_appear_in_schedule(void *block_env, const ir_node *irn) {
534         return is_TEMPLATE_irn(irn);
535 }
536
537 /**
538  * Initializes the code generator interface.
539  */
540 static const arch_code_generator_if_t *TEMPLATE_get_code_generator_if(void *self) {
541         return &TEMPLATE_code_gen_if;
542 }
543
544 list_sched_selector_t TEMPLATE_sched_selector;
545
546 /**
547  * Returns the reg_pressure scheduler with to_appear_in_schedule() overloaded
548  */
549 static const list_sched_selector_t *TEMPLATE_get_list_sched_selector(const void *self, list_sched_selector_t *selector) {
550         memcpy(&TEMPLATE_sched_selector, trivial_selector, sizeof(list_sched_selector_t));
551         TEMPLATE_sched_selector.to_appear_in_schedule = TEMPLATE_to_appear_in_schedule;
552         return &TEMPLATE_sched_selector;
553 }
554
555 static const ilp_sched_selector_t *TEMPLATE_get_ilp_sched_selector(const void *self) {
556         return NULL;
557 }
558
559 /**
560  * Returns the necessary byte alignment for storing a register of given class.
561  */
562 static int TEMPLATE_get_reg_class_alignment(const void *self, const arch_register_class_t *cls) {
563         ir_mode *mode = arch_register_class_mode(cls);
564         return get_mode_size_bytes(mode);
565 }
566
567 /**
568  * Returns the libFirm configuration parameter for this backend.
569  */
570 static const backend_params *TEMPLATE_get_libfirm_params(void) {
571         static arch_dep_params_t ad = {
572                 1,  /* allow subs */
573                 0,  /* Muls are fast enough on Firm */
574                 31, /* shift would be ok */
575                 0,  /* no Mulhs */
576                 0,  /* no Mulhu */
577                 0,  /* no Mulh */
578         };
579         static backend_params p = {
580                 NULL,  /* no additional opcodes */
581                 NULL,  /* will be set later */
582                 0,     /* no dword lowering */
583                 NULL,  /* no creator function */
584                 NULL,  /* context for create_intrinsic_fkt */
585         };
586
587         p.dep_param = &ad;
588         return &p;
589 }
590
591 static const be_execution_unit_t ***TEMPLATE_get_allowed_execution_units(const void *self, const ir_node *irn) {
592         /* TODO */
593         assert(0);
594         return NULL;
595 }
596
597 static const be_machine_t *TEMPLATE_get_machine(const void *self) {
598         /* TODO */
599         assert(0);
600         return NULL;
601 }
602
603
604 const arch_isa_if_t TEMPLATE_isa_if = {
605         TEMPLATE_init,
606         TEMPLATE_done,
607         TEMPLATE_get_n_reg_class,
608         TEMPLATE_get_reg_class,
609         TEMPLATE_get_reg_class_for_mode,
610         TEMPLATE_get_call_abi,
611         TEMPLATE_get_irn_handler,
612         TEMPLATE_get_code_generator_if,
613         TEMPLATE_get_list_sched_selector,
614         TEMPLATE_get_ilp_sched_selector,
615         TEMPLATE_get_reg_class_alignment,
616     TEMPLATE_get_libfirm_params,
617         TEMPLATE_get_allowed_execution_units,
618         TEMPLATE_get_machine
619 };
620
621 void be_init_arch_TEMPLATE(void)
622 {
623         be_register_isa_if("TEMPLATE", &TEMPLATE_isa_if);
624 }
625
626 BE_REGISTER_MODULE_CONSTRUCTOR(be_init_arch_TEMPLATE);