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