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