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