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