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