5fd675368dfa86f8ac99712c732215e66b6b1ae4
[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 /**
267  * These are some hooks which must be filled but are probably not needed.
268  */
269 static void TEMPLATE_before_sched(void *self) {
270         (void) self;
271         /* Some stuff you need to do after scheduling but before register allocation */
272 }
273
274 static void TEMPLATE_before_ra(void *self) {
275         (void) self;
276         /* Some stuff you need to do after scheduling but before register allocation */
277 }
278
279 static void TEMPLATE_after_ra(void *self) {
280         (void) self;
281         /* Some stuff you need to do immediatly after register allocation */
282 }
283
284
285
286 /**
287  * Emits the code, closes the output file and frees
288  * the code generator interface.
289  */
290 static void TEMPLATE_emit_and_done(void *self) {
291         TEMPLATE_code_gen_t *cg = self;
292         ir_graph           *irg = cg->irg;
293
294         TEMPLATE_gen_routine(cg, irg);
295
296         cur_reg_set = NULL;
297
298         /* de-allocate code generator */
299         del_set(cg->reg_set);
300         free(cg);
301 }
302
303 static void *TEMPLATE_cg_init(be_irg_t *birg);
304
305 static const arch_code_generator_if_t TEMPLATE_code_gen_if = {
306         TEMPLATE_cg_init,
307         NULL,                    /* get_pic_base hook */
308         NULL,                    /* before abi introduce hook */
309         TEMPLATE_prepare_graph,
310         NULL,                    /* spill hook */
311         TEMPLATE_before_sched,   /* before scheduling hook */
312         TEMPLATE_before_ra,      /* before register allocation hook */
313         TEMPLATE_after_ra,       /* after register allocation hook */
314         TEMPLATE_finish_irg,
315         TEMPLATE_emit_and_done
316 };
317
318 /**
319  * Initializes the code generator.
320  */
321 static void *TEMPLATE_cg_init(be_irg_t *birg) {
322         const arch_env_t    *arch_env = be_get_birg_arch_env(birg);
323         TEMPLATE_isa_t      *isa      = (TEMPLATE_isa_t *) arch_env;
324         TEMPLATE_code_gen_t *cg       = XMALLOC(TEMPLATE_code_gen_t);
325
326         cg->impl     = &TEMPLATE_code_gen_if;
327         cg->irg      = be_get_birg_irg(birg);
328         cg->reg_set  = new_set(TEMPLATE_cmp_irn_reg_assoc, 1024);
329         cg->arch_env = arch_env;
330         cg->isa      = isa;
331         cg->birg     = birg;
332         FIRM_DBG_REGISTER(cg->mod, "firm.be.TEMPLATE.cg");
333
334         cur_reg_set = cg->reg_set;
335
336         return (arch_code_generator_t *)cg;
337 }
338
339
340
341 /*****************************************************************
342  *  ____             _                  _   _____  _____
343  * |  _ \           | |                | | |_   _|/ ____|  /\
344  * | |_) | __ _  ___| | _____ _ __   __| |   | | | (___   /  \
345  * |  _ < / _` |/ __| |/ / _ \ '_ \ / _` |   | |  \___ \ / /\ \
346  * | |_) | (_| | (__|   <  __/ | | | (_| |  _| |_ ____) / ____ \
347  * |____/ \__,_|\___|_|\_\___|_| |_|\__,_| |_____|_____/_/    \_\
348  *
349  *****************************************************************/
350
351 static TEMPLATE_isa_t TEMPLATE_isa_template = {
352         {
353                 &TEMPLATE_isa_if,             /* isa interface implementation */
354                 &TEMPLATE_general_purpose_regs[REG_SP],  /* stack pointer register */
355                 &TEMPLATE_general_purpose_regs[REG_BP],  /* base pointer register */
356                 -1,                          /* stack direction */
357                 2,                           /* power of two stack alignment for calls, 2^2 == 4 */
358                 NULL,                        /* main environment */
359                 7,                           /* costs for a spill instruction */
360                 5,                           /* costs for a reload instruction */
361         },
362 };
363
364 /**
365  * Initializes the backend ISA and opens the output file.
366  */
367 static arch_env_t *TEMPLATE_init(FILE *outfile) {
368         static int run_once = 0;
369         TEMPLATE_isa_t *isa;
370
371         if(run_once)
372                 return NULL;
373         run_once = 1;
374
375         isa = XMALLOC(TEMPLATE_isa_t);
376         memcpy(isa, &TEMPLATE_isa_template, sizeof(*isa));
377
378         be_emit_init(outfile);
379
380         TEMPLATE_register_init();
381         TEMPLATE_create_opcodes(&TEMPLATE_irn_ops);
382
383         return &isa->arch_env;
384 }
385
386
387
388 /**
389  * Closes the output file and frees the ISA structure.
390  */
391 static void TEMPLATE_done(void *self) {
392         TEMPLATE_isa_t *isa = self;
393
394         /* emit now all global declarations */
395         be_gas_emit_decls(isa->arch_env.main_env, 0);
396
397         be_emit_exit();
398         free(self);
399 }
400
401
402
403 static unsigned TEMPLATE_get_n_reg_class(const void *self)
404 {
405         (void) self;
406         return N_CLASSES;
407 }
408
409 static const arch_register_class_t *TEMPLATE_get_reg_class(const void *self,
410                                                            unsigned i)
411 {
412         (void) self;
413         assert(i < N_CLASSES);
414         return &TEMPLATE_reg_classes[i];
415 }
416
417
418
419 /**
420  * Get the register class which shall be used to store a value of a given mode.
421  * @param self The this pointer.
422  * @param mode The mode in question.
423  * @return A register class which can hold values of the given mode.
424  */
425 const arch_register_class_t *TEMPLATE_get_reg_class_for_mode(const void *self,
426                 const ir_mode *mode)
427 {
428         (void) self;
429         if (mode_is_float(mode))
430                 return &TEMPLATE_reg_classes[CLASS_TEMPLATE_floating_point];
431         else
432                 return &TEMPLATE_reg_classes[CLASS_TEMPLATE_general_purpose];
433 }
434
435
436
437 typedef struct {
438         be_abi_call_flags_bits_t flags;
439         const arch_env_t *arch_env;
440         ir_graph *irg;
441 } TEMPLATE_abi_env_t;
442
443 static void *TEMPLATE_abi_init(const be_abi_call_t *call, const arch_env_t *arch_env, ir_graph *irg)
444 {
445         TEMPLATE_abi_env_t *env = XMALLOC(TEMPLATE_abi_env_t);
446         be_abi_call_flags_t fl = be_abi_call_get_flags(call);
447         env->flags    = fl.bits;
448         env->irg      = irg;
449         env->arch_env = arch_env;
450         return env;
451 }
452
453 /**
454  * Get the between type for that call.
455  * @param self The callback object.
456  * @return The between type of for that call.
457  */
458 static ir_type *TEMPLATE_get_between_type(void *self)
459 {
460         static ir_type *between_type = NULL;
461         static ir_entity *old_bp_ent = NULL;
462         (void) self;
463
464         if(!between_type) {
465                 ir_entity *ret_addr_ent;
466                 ir_type *ret_addr_type = new_type_primitive(new_id_from_str("return_addr"), mode_P);
467                 ir_type *old_bp_type   = new_type_primitive(new_id_from_str("bp"), mode_P);
468
469                 between_type           = new_type_class(new_id_from_str("TEMPLATE_between_type"));
470                 old_bp_ent             = new_entity(between_type, new_id_from_str("old_bp"), old_bp_type);
471                 ret_addr_ent           = new_entity(between_type, new_id_from_str("old_bp"), ret_addr_type);
472
473                 set_entity_offset(old_bp_ent, 0);
474                 set_entity_offset(ret_addr_ent, get_type_size_bytes(old_bp_type));
475                 set_type_size_bytes(between_type, get_type_size_bytes(old_bp_type) + get_type_size_bytes(ret_addr_type));
476         }
477
478         return between_type;
479 }
480
481 static void TEMPLATE_abi_dont_save_regs(void *self, pset *s)
482 {
483         TEMPLATE_abi_env_t *env = self;
484         if (env->flags.try_omit_fp) {
485                 /* insert the BP register into the ignore set */
486                 pset_insert_ptr(s, env->arch_env->bp);
487         }
488 }
489
490 /**
491  * Build the prolog, return the BASE POINTER register
492  */
493 static const arch_register_t *TEMPLATE_abi_prologue(void *self, ir_node **mem,
494                                                     pmap *reg_map, int *stack_bias)
495 {
496         TEMPLATE_abi_env_t *env = self;
497         (void) reg_map;
498         (void) mem;
499         (void) stack_bias;
500
501         if(env->flags.try_omit_fp)
502                 return env->arch_env->sp;
503         return env->arch_env->bp;
504 }
505
506 /* Build the epilog */
507 static void TEMPLATE_abi_epilogue(void *self, ir_node *bl, ir_node **mem,
508                                   pmap *reg_map)
509 {
510         (void) self;
511         (void) bl;
512         (void) mem;
513         (void) reg_map;
514 }
515
516 static const be_abi_callbacks_t TEMPLATE_abi_callbacks = {
517         TEMPLATE_abi_init,
518         free,
519         TEMPLATE_get_between_type,
520         TEMPLATE_abi_dont_save_regs,
521         TEMPLATE_abi_prologue,
522         TEMPLATE_abi_epilogue,
523 };
524
525 /**
526  * Get the ABI restrictions for procedure calls.
527  * @param self        The this pointer.
528  * @param method_type The type of the method (procedure) in question.
529  * @param abi         The abi object to be modified
530  */
531 void TEMPLATE_get_call_abi(const void *self, ir_type *method_type,
532                            be_abi_call_t *abi)
533 {
534         ir_type  *tp;
535         ir_mode  *mode;
536         int       i, n = get_method_n_params(method_type);
537         be_abi_call_flags_t call_flags;
538         (void) self;
539
540         /* set abi flags for calls */
541         call_flags.bits.left_to_right         = 0;
542         call_flags.bits.store_args_sequential = 1;
543         call_flags.bits.try_omit_fp           = 1;
544         call_flags.bits.fp_free               = 0;
545         call_flags.bits.call_has_imm          = 1;
546
547         /* set stack parameter passing style */
548         be_abi_call_set_flags(abi, call_flags, &TEMPLATE_abi_callbacks);
549
550         for (i = 0; i < n; i++) {
551                 /* TODO: implement register parameter: */
552                 /* reg = get reg for param i;          */
553                 /* be_abi_call_param_reg(abi, i, reg); */
554
555                 /* default: all parameters on stack */
556                 tp   = get_method_param_type(method_type, i);
557                 mode = get_type_mode(tp);
558                 be_abi_call_param_stack(abi, i, mode, 4, 0, 0);
559         }
560
561         /* TODO: set correct return register */
562         /* default: return value is in R0 resp. F0 */
563         if (get_method_n_ress(method_type) > 0) {
564                 tp   = get_method_res_type(method_type, 0);
565                 mode = get_type_mode(tp);
566
567                 be_abi_call_res_reg(abi, 0,
568                         mode_is_float(mode) ? &TEMPLATE_floating_point_regs[REG_F0] : &TEMPLATE_general_purpose_regs[REG_R0]);
569         }
570 }
571
572 int TEMPLATE_to_appear_in_schedule(void *block_env, const ir_node *irn)
573 {
574         (void) block_env;
575
576         if(!is_TEMPLATE_irn(irn))
577                 return -1;
578
579         return 1;
580 }
581
582 /**
583  * Initializes the code generator interface.
584  */
585 static const arch_code_generator_if_t *TEMPLATE_get_code_generator_if(
586                 void *self)
587 {
588         (void) self;
589         return &TEMPLATE_code_gen_if;
590 }
591
592 list_sched_selector_t TEMPLATE_sched_selector;
593
594 /**
595  * Returns the reg_pressure scheduler with to_appear_in_schedule() overloaded
596  */
597 static const list_sched_selector_t *TEMPLATE_get_list_sched_selector(
598                 const void *self, list_sched_selector_t *selector)
599 {
600         (void) self;
601         (void) selector;
602
603         TEMPLATE_sched_selector = trivial_selector;
604         TEMPLATE_sched_selector.to_appear_in_schedule = TEMPLATE_to_appear_in_schedule;
605         return &TEMPLATE_sched_selector;
606 }
607
608 static const ilp_sched_selector_t *TEMPLATE_get_ilp_sched_selector(
609                 const void *self)
610 {
611         (void) self;
612         return NULL;
613 }
614
615 /**
616  * Returns the necessary byte alignment for storing a register of given class.
617  */
618 static int TEMPLATE_get_reg_class_alignment(const void *self,
619                                             const arch_register_class_t *cls) {
620         ir_mode *mode = arch_register_class_mode(cls);
621         (void) self;
622         return get_mode_size_bytes(mode);
623 }
624
625 /**
626  * Returns the libFirm configuration parameter for this backend.
627  */
628 static const backend_params *TEMPLATE_get_backend_params(void) {
629         static backend_params p = {
630                 0,     /* no dword lowering */
631                 0,     /* no inline assembly */
632                 0,     /* no immediate floating point mode. */
633                 NULL,  /* no additional opcodes */
634                 NULL,  /* will be set later */
635                 NULL,  /* no creator function */
636                 NULL,  /* context for create_intrinsic_fkt */
637                 NULL,  /* parameter for if conversion */
638                 NULL   /* no immediate fp mode */
639         };
640         return &p;
641 }
642
643 static const be_execution_unit_t ***TEMPLATE_get_allowed_execution_units(
644                 const void *self, const ir_node *irn)
645 {
646         (void) self;
647         (void) irn;
648         /* TODO */
649         assert(0);
650         return NULL;
651 }
652
653 static const be_machine_t *TEMPLATE_get_machine(const void *self)
654 {
655         (void) self;
656         /* TODO */
657         assert(0);
658         return NULL;
659 }
660
661 static ir_graph **TEMPLATE_get_backend_irg_list(const void *self,
662                                                 ir_graph ***irgs)
663 {
664         (void) self;
665         (void) irgs;
666         return NULL;
667 }
668
669 static asm_constraint_flags_t TEMPLATE_parse_asm_constraint(const void *self,
670                                                             const char **c)
671 {
672         (void) self;
673         (void) c;
674         return ASM_CONSTRAINT_FLAG_INVALID;
675 }
676
677 static int TEMPLATE_is_valid_clobber(const void *self, const char *clobber)
678 {
679         (void) self;
680         (void) clobber;
681         return 0;
682 }
683
684 const arch_isa_if_t TEMPLATE_isa_if = {
685         TEMPLATE_init,
686         TEMPLATE_done,
687         TEMPLATE_get_n_reg_class,
688         TEMPLATE_get_reg_class,
689         TEMPLATE_get_reg_class_for_mode,
690         TEMPLATE_get_call_abi,
691         TEMPLATE_get_code_generator_if,
692         TEMPLATE_get_list_sched_selector,
693         TEMPLATE_get_ilp_sched_selector,
694         TEMPLATE_get_reg_class_alignment,
695     TEMPLATE_get_backend_params,
696         TEMPLATE_get_allowed_execution_units,
697         TEMPLATE_get_machine,
698         TEMPLATE_get_backend_irg_list,
699         NULL,                    /* mark remat */
700         TEMPLATE_parse_asm_constraint,
701         TEMPLATE_is_valid_clobber
702 };
703
704 void be_init_arch_TEMPLATE(void)
705 {
706         be_register_isa_if("TEMPLATE", &TEMPLATE_isa_if);
707 }
708
709 BE_REGISTER_MODULE_CONSTRUCTOR(be_init_arch_TEMPLATE);