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