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