a5150da22131e09fb60f9dddf9b2a8346dac1fa0
[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
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(const void *self, ir_node *irn, const arch_register_t *reg) {
118         int pos = 0;
119
120         if (is_Proj(irn)) {
121                 pos = TEMPLATE_translate_proj_pos(irn);
122                 irn = skip_Proj(irn);
123         }
124
125         if (is_TEMPLATE_irn(irn)) {
126                 const arch_register_t **slots;
127
128                 slots      = get_TEMPLATE_slots(irn);
129                 slots[pos] = reg;
130         }
131         else {
132                 /* here we set the registers for the Phi nodes */
133                 TEMPLATE_set_firm_reg(irn, reg, cur_reg_set);
134         }
135 }
136
137 static
138 const arch_register_t *TEMPLATE_get_irn_reg(const void *self,
139                                             const ir_node *irn) {
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 void *self, const ir_node *irn) {
161         irn = skip_Proj_const(irn);
162
163         if (is_cfop(irn)) {
164                 return arch_irn_class_branch;
165         }
166         else if (is_TEMPLATE_irn(irn)) {
167                 return arch_irn_class_normal;
168         }
169
170         return 0;
171 }
172
173 static arch_irn_flags_t TEMPLATE_get_flags(const void *self, const ir_node *irn) {
174         irn = skip_Proj_const(irn);
175
176         if (is_TEMPLATE_irn(irn)) {
177                 return get_TEMPLATE_flags(irn);
178         }
179         else if (is_Unknown(irn)) {
180                 return arch_irn_flags_ignore;
181         }
182
183         return 0;
184 }
185
186 static ir_entity *TEMPLATE_get_frame_entity(const void *self, const ir_node *node) {
187         /* TODO: return the ir_entity assigned to the frame */
188         return NULL;
189 }
190
191 static void TEMPLATE_set_frame_entity(const void *self, ir_node *node, ir_entity *ent) {
192         /* TODO: set the ir_entity assigned to the frame */
193 }
194
195 /**
196  * This function is called by the generic backend to correct offsets for
197  * nodes accessing the stack.
198  */
199 static void TEMPLATE_set_frame_offset(const void *self, ir_node *irn, int offset) {
200         /* TODO: correct offset if irn accesses the stack */
201 }
202
203 static int TEMPLATE_get_sp_bias(const void *self, const ir_node *irn) {
204         return 0;
205 }
206
207 /* fill register allocator interface */
208
209 static const arch_irn_ops_if_t TEMPLATE_irn_ops_if = {
210         TEMPLATE_get_irn_reg_req,
211         TEMPLATE_set_irn_reg,
212         TEMPLATE_get_irn_reg,
213         TEMPLATE_classify,
214         TEMPLATE_get_flags,
215         TEMPLATE_get_frame_entity,
216         TEMPLATE_set_frame_entity,
217         TEMPLATE_set_frame_offset,
218         TEMPLATE_get_sp_bias,
219         NULL,    /* get_inverse             */
220         NULL,    /* get_op_estimated_cost   */
221         NULL,    /* possible_memory_operand */
222         NULL,    /* perform_memory_operand  */
223 };
224
225 TEMPLATE_irn_ops_t TEMPLATE_irn_ops = {
226         &TEMPLATE_irn_ops_if,
227         NULL
228 };
229
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         /* Some stuff you need to do after scheduling but before register allocation */
271 }
272
273 static void TEMPLATE_before_ra(void *self) {
274         /* Some stuff you need to do after scheduling but before register allocation */
275 }
276
277 static void TEMPLATE_after_ra(void *self) {
278         /* Some stuff you need to do immediatly after register allocation */
279 }
280
281
282
283 /**
284  * Emits the code, closes the output file and frees
285  * the code generator interface.
286  */
287 static void TEMPLATE_emit_and_done(void *self) {
288         TEMPLATE_code_gen_t *cg = self;
289         ir_graph           *irg = cg->irg;
290
291         TEMPLATE_gen_routine(cg, irg);
292
293         cur_reg_set = NULL;
294
295         /* de-allocate code generator */
296         del_set(cg->reg_set);
297         free(cg);
298 }
299
300 static void *TEMPLATE_cg_init(be_irg_t *birg);
301
302 static const arch_code_generator_if_t TEMPLATE_code_gen_if = {
303         TEMPLATE_cg_init,
304         NULL,                    /* before abi introduce hook */
305         TEMPLATE_prepare_graph,
306         NULL,                    /* spill hook */
307         TEMPLATE_before_sched,   /* before scheduling hook */
308         TEMPLATE_before_ra,      /* before register allocation hook */
309         TEMPLATE_after_ra,       /* after register allocation hook */
310         TEMPLATE_finish_irg,
311         TEMPLATE_emit_and_done
312 };
313
314 /**
315  * Initializes the code generator.
316  */
317 static void *TEMPLATE_cg_init(be_irg_t *birg) {
318         const arch_env_t    *arch_env = be_get_birg_arch_env(birg);
319         TEMPLATE_isa_t      *isa      = (TEMPLATE_isa_t *) arch_env->isa;
320         TEMPLATE_code_gen_t *cg       = xmalloc(sizeof(*cg));
321
322         cg->impl     = &TEMPLATE_code_gen_if;
323         cg->irg      = be_get_birg_irg(birg);
324         cg->reg_set  = new_set(TEMPLATE_cmp_irn_reg_assoc, 1024);
325         cg->arch_env = arch_env;
326         cg->isa      = isa;
327         cg->birg     = birg;
328         FIRM_DBG_REGISTER(cg->mod, "firm.be.TEMPLATE.cg");
329
330         cur_reg_set = cg->reg_set;
331
332         TEMPLATE_irn_ops.cg = cg;
333
334         return (arch_code_generator_t *)cg;
335 }
336
337
338
339 /*****************************************************************
340  *  ____             _                  _   _____  _____
341  * |  _ \           | |                | | |_   _|/ ____|  /\
342  * | |_) | __ _  ___| | _____ _ __   __| |   | | | (___   /  \
343  * |  _ < / _` |/ __| |/ / _ \ '_ \ / _` |   | |  \___ \ / /\ \
344  * | |_) | (_| | (__|   <  __/ | | | (_| |  _| |_ ____) / ____ \
345  * |____/ \__,_|\___|_|\_\___|_| |_|\__,_| |_____|_____/_/    \_\
346  *
347  *****************************************************************/
348
349 static TEMPLATE_isa_t TEMPLATE_isa_template = {
350         {
351                 &TEMPLATE_isa_if,             /* isa interface implementation */
352                 &TEMPLATE_general_purpose_regs[REG_SP],  /* stack pointer register */
353                 &TEMPLATE_general_purpose_regs[REG_BP],  /* base pointer register */
354                 -1,                          /* stack direction */
355                 NULL,                        /* main environment */
356                 7,                           /* costs for a spill instruction */
357                 5,                           /* costs for a reload instruction */
358         },
359         { NULL, },                       /* emitter environment */
360 };
361
362 /**
363  * Initializes the backend ISA and opens the output file.
364  */
365 static void *TEMPLATE_init(FILE *outfile) {
366         static int run_once = 0;
367         TEMPLATE_isa_t *isa;
368
369         if(run_once)
370                 return NULL;
371         run_once = 1;
372
373         isa = xcalloc(1, sizeof(*isa));
374         memcpy(isa, &TEMPLATE_isa_template, sizeof(*isa));
375
376         be_emit_init_env(&isa->emit, outfile);
377
378         TEMPLATE_register_init(isa);
379         TEMPLATE_create_opcodes();
380
381         return isa;
382 }
383
384
385
386 /**
387  * Closes the output file and frees the ISA structure.
388  */
389 static void TEMPLATE_done(void *self) {
390         TEMPLATE_isa_t *isa = self;
391
392         /* emit now all global declarations */
393         be_gas_emit_decls(&isa->emit, isa->arch_isa.main_env, 0);
394
395         be_emit_destroy_env(&isa->emit);
396         free(self);
397 }
398
399
400
401 static int TEMPLATE_get_n_reg_class(const void *self) {
402         return N_CLASSES;
403 }
404
405 static const arch_register_class_t *TEMPLATE_get_reg_class(const void *self, int i) {
406         assert(i >= 0 && i < N_CLASSES && "Invalid TEMPLATE register class requested.");
407         return &TEMPLATE_reg_classes[i];
408 }
409
410
411
412 /**
413  * Get the register class which shall be used to store a value of a given mode.
414  * @param self The this pointer.
415  * @param mode The mode in question.
416  * @return A register class which can hold values of the given mode.
417  */
418 const arch_register_class_t *TEMPLATE_get_reg_class_for_mode(const void *self, const ir_mode *mode) {
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         const arch_isa_t *isa;
431         ir_graph *irg;
432 } TEMPLATE_abi_env_t;
433
434 static void *TEMPLATE_abi_init(const be_abi_call_t *call, const arch_env_t *arch_env, ir_graph *irg)
435 {
436         TEMPLATE_abi_env_t *env = xmalloc(sizeof(env[0]));
437         be_abi_call_flags_t fl = be_abi_call_get_flags(call);
438         env->flags    = fl.bits;
439         env->irg      = irg;
440         env->arch_env = arch_env;
441         env->isa      = arch_env->isa;
442         return env;
443 }
444
445 /**
446  * Get the between type for that call.
447  * @param self The callback object.
448  * @return The between type of for that call.
449  */
450 static ir_type *TEMPLATE_get_between_type(void *self) {
451         //TEMPLATE_abi_env_t *env = self;
452         static ir_type *between_type = NULL;
453         static ir_entity *old_bp_ent    = NULL;
454
455         if(!between_type) {
456                 ir_entity *ret_addr_ent;
457                 ir_type *ret_addr_type = new_type_primitive(new_id_from_str("return_addr"), mode_P);
458                 ir_type *old_bp_type   = new_type_primitive(new_id_from_str("bp"), mode_P);
459
460                 between_type           = new_type_class(new_id_from_str("TEMPLATE_between_type"));
461                 old_bp_ent             = new_entity(between_type, new_id_from_str("old_bp"), old_bp_type);
462                 ret_addr_ent           = new_entity(between_type, new_id_from_str("old_bp"), ret_addr_type);
463
464                 set_entity_offset(old_bp_ent, 0);
465                 set_entity_offset(ret_addr_ent, get_type_size_bytes(old_bp_type));
466                 set_type_size_bytes(between_type, get_type_size_bytes(old_bp_type) + get_type_size_bytes(ret_addr_type));
467         }
468
469         return between_type;
470 }
471
472 static void TEMPLATE_abi_dont_save_regs(void *self, pset *s)
473 {
474         TEMPLATE_abi_env_t *env = self;
475         if (env->flags.try_omit_fp) {
476                 /* insert the BP register into the ignore set */
477                 pset_insert_ptr(s, env->isa->bp);
478         }
479 }
480
481 /**
482  * Build the prolog, return the BASE POINTER register
483  */
484 static const arch_register_t *TEMPLATE_abi_prologue(void *self, ir_node **mem, pmap *reg_map) {
485         TEMPLATE_abi_env_t *env = self;
486
487         if(env->flags.try_omit_fp)
488                 return env->isa->sp;
489         return env->isa->bp;
490 }
491
492 /* Build the epilog */
493 static void TEMPLATE_abi_epilogue(void *self, ir_node *bl, ir_node **mem, pmap *reg_map) {
494         //TEMPLATE_abi_env_t *env = self;
495 }
496
497 static const be_abi_callbacks_t TEMPLATE_abi_callbacks = {
498         TEMPLATE_abi_init,
499         free,
500         TEMPLATE_get_between_type,
501         TEMPLATE_abi_dont_save_regs,
502         TEMPLATE_abi_prologue,
503         TEMPLATE_abi_epilogue,
504 };
505
506 /**
507  * Get the ABI restrictions for procedure calls.
508  * @param self        The this pointer.
509  * @param method_type The type of the method (procedure) in question.
510  * @param abi         The abi object to be modified
511  */
512 void TEMPLATE_get_call_abi(const void *self, ir_type *method_type, be_abi_call_t *abi) {
513         ir_type  *tp;
514         ir_mode  *mode;
515         int       i, n = get_method_n_params(method_type);
516         be_abi_call_flags_t call_flags;
517
518         /* set abi flags for calls */
519         call_flags.bits.left_to_right         = 0;
520         call_flags.bits.store_args_sequential = 1;
521         call_flags.bits.try_omit_fp           = 1;
522         call_flags.bits.fp_free               = 0;
523         call_flags.bits.call_has_imm          = 1;
524
525         /* set stack parameter passing style */
526         be_abi_call_set_flags(abi, call_flags, &TEMPLATE_abi_callbacks);
527
528         for (i = 0; i < n; i++) {
529                 /* TODO: implement register parameter: */
530                 /* reg = get reg for param i;          */
531                 /* be_abi_call_param_reg(abi, i, reg); */
532
533                 /* default: all parameters on stack */
534                 be_abi_call_param_stack(abi, i, 4, 0, 0);
535         }
536
537         /* TODO: set correct return register */
538         /* default: return value is in R0 resp. F0 */
539         if (get_method_n_ress(method_type) > 0) {
540                 tp   = get_method_res_type(method_type, 0);
541                 mode = get_type_mode(tp);
542
543                 be_abi_call_res_reg(abi, 0,
544                         mode_is_float(mode) ? &TEMPLATE_floating_point_regs[REG_F0] : &TEMPLATE_general_purpose_regs[REG_R0]);
545         }
546 }
547
548 static const void *TEMPLATE_get_irn_ops(const arch_irn_handler_t *self, const ir_node *irn) {
549         return &TEMPLATE_irn_ops;
550 }
551
552 const arch_irn_handler_t TEMPLATE_irn_handler = {
553         TEMPLATE_get_irn_ops
554 };
555
556 const arch_irn_handler_t *TEMPLATE_get_irn_handler(const void *self) {
557         return &TEMPLATE_irn_handler;
558 }
559
560 int TEMPLATE_to_appear_in_schedule(void *block_env, const ir_node *irn) {
561         if(!is_TEMPLATE_irn(irn))
562                 return -1;
563
564         return 1;
565 }
566
567 /**
568  * Initializes the code generator interface.
569  */
570 static const arch_code_generator_if_t *TEMPLATE_get_code_generator_if(void *self) {
571         return &TEMPLATE_code_gen_if;
572 }
573
574 list_sched_selector_t TEMPLATE_sched_selector;
575
576 /**
577  * Returns the reg_pressure scheduler with to_appear_in_schedule() overloaded
578  */
579 static const list_sched_selector_t *TEMPLATE_get_list_sched_selector(const void *self, list_sched_selector_t *selector) {
580         memcpy(&TEMPLATE_sched_selector, trivial_selector, sizeof(list_sched_selector_t));
581         TEMPLATE_sched_selector.to_appear_in_schedule = TEMPLATE_to_appear_in_schedule;
582         return &TEMPLATE_sched_selector;
583 }
584
585 static const ilp_sched_selector_t *TEMPLATE_get_ilp_sched_selector(const void *self) {
586         return NULL;
587 }
588
589 /**
590  * Returns the necessary byte alignment for storing a register of given class.
591  */
592 static int TEMPLATE_get_reg_class_alignment(const void *self, const arch_register_class_t *cls) {
593         ir_mode *mode = arch_register_class_mode(cls);
594         return get_mode_size_bytes(mode);
595 }
596
597 /**
598  * Returns the libFirm configuration parameter for this backend.
599  */
600 static const backend_params *TEMPLATE_get_backend_params(void) {
601         static arch_dep_params_t ad = {
602                 1,  /* allow subs */
603                 0,  /* Muls are fast enough on Firm */
604                 31, /* shift would be ok */
605                 0,  /* no Mulhs */
606                 0,  /* no Mulhu */
607                 0,  /* no Mulh */
608         };
609         static backend_params p = {
610                 0,     /* no dword lowering */
611                 0,     /* no inline assembly */
612                 NULL,  /* no additional opcodes */
613                 NULL,  /* will be set later */
614                 NULL,  /* no creator function */
615                 NULL,  /* context for create_intrinsic_fkt */
616                 NULL,
617                 NULL,
618         };
619
620         p.dep_param = &ad;
621         return &p;
622 }
623
624 static const be_execution_unit_t ***TEMPLATE_get_allowed_execution_units(const void *self, const ir_node *irn) {
625         /* TODO */
626         assert(0);
627         return NULL;
628 }
629
630 static const be_machine_t *TEMPLATE_get_machine(const void *self) {
631         /* TODO */
632         assert(0);
633         return NULL;
634 }
635
636 static ir_graph **TEMPLATE_get_backend_irg_list(const void *self, ir_graph ***irgs) {
637         return NULL;
638 }
639
640
641 const arch_isa_if_t TEMPLATE_isa_if = {
642         TEMPLATE_init,
643         TEMPLATE_done,
644         TEMPLATE_get_n_reg_class,
645         TEMPLATE_get_reg_class,
646         TEMPLATE_get_reg_class_for_mode,
647         TEMPLATE_get_call_abi,
648         TEMPLATE_get_irn_handler,
649         TEMPLATE_get_code_generator_if,
650         TEMPLATE_get_list_sched_selector,
651         TEMPLATE_get_ilp_sched_selector,
652         TEMPLATE_get_reg_class_alignment,
653     TEMPLATE_get_backend_params,
654         TEMPLATE_get_allowed_execution_units,
655         TEMPLATE_get_machine,
656         TEMPLATE_get_backend_irg_list
657 };
658
659 void be_init_arch_TEMPLATE(void)
660 {
661         be_register_isa_if("TEMPLATE", &TEMPLATE_isa_if);
662 }
663
664 BE_REGISTER_MODULE_CONSTRUCTOR(be_init_arch_TEMPLATE);