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