changed codegen interface
[libfirm] / ir / be / ia32 / bearch_ia32.c
1 #ifdef HAVE_CONFIG_H
2 #include "config.h"
3 #endif
4
5 #ifdef _WIN32
6 #include <malloc.h>
7 #else
8 #include <alloca.h>
9 #endif
10
11 #include "pseudo_irg.h"
12 #include "irgwalk.h"
13 #include "irprog.h"
14 #include "irprintf.h"
15 #include "iredges_t.h"
16 #include "ircons.h"
17 #include "irgmod.h"
18
19 #include "bitset.h"
20 #include "debug.h"
21
22 #include "../beabi.h"                 /* the general register allocator interface */
23 #include "../benode_t.h"
24 #include "../belower.h"
25 #include "../besched_t.h"
26 #include "../be.h"
27 #include "bearch_ia32_t.h"
28
29 #include "ia32_new_nodes.h"           /* ia32 nodes interface */
30 #include "gen_ia32_regalloc_if.h"     /* the generated interface (register type and class defenitions) */
31 #include "ia32_gen_decls.h"           /* interface declaration emitter */
32 #include "ia32_transform.h"
33 #include "ia32_emitter.h"
34 #include "ia32_map_regs.h"
35 #include "ia32_optimize.h"
36
37 #define DEBUG_MODULE "firm.be.ia32.isa"
38
39 /* TODO: ugly */
40 static set *cur_reg_set = NULL;
41
42 #undef is_Start
43 #define is_Start(irn) (get_irn_opcode(irn) == iro_Start)
44
45 ir_node *ia32_new_NoReg_gp(ia32_code_gen_t *cg) {
46         return be_abi_get_callee_save_irn(cg->birg->abi, &ia32_gp_regs[REG_XXX]);
47 }
48
49 ir_node *ia32_new_NoReg_fp(ia32_code_gen_t *cg) {
50         return be_abi_get_callee_save_irn(cg->birg->abi, &ia32_fp_regs[REG_XXXX]);
51 }
52
53 /**************************************************
54  *                         _ _              _  __
55  *                        | | |            (_)/ _|
56  *  _ __ ___  __ _    __ _| | | ___   ___   _| |_
57  * | '__/ _ \/ _` |  / _` | | |/ _ \ / __| | |  _|
58  * | | |  __/ (_| | | (_| | | | (_) | (__  | | |
59  * |_|  \___|\__, |  \__,_|_|_|\___/ \___| |_|_|
60  *            __/ |
61  *           |___/
62  **************************************************/
63
64 static ir_node *my_skip_proj(const ir_node *n) {
65         while (is_Proj(n))
66                 n = get_Proj_pred(n);
67         return (ir_node *)n;
68 }
69
70 /**
71  * Return register requirements for an ia32 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 arch_register_req_t *ia32_get_irn_reg_req(const void *self, arch_register_req_t *req, const ir_node *irn, int pos) {
76         const ia32_register_req_t *irn_req;
77         long                       node_pos = pos == -1 ? 0 : pos;
78         ir_mode                   *mode     = get_irn_mode(irn);
79         firm_dbg_module_t         *mod      = firm_dbg_register(DEBUG_MODULE);
80         const ia32_irn_ops_t      *ops      = self;
81
82         if (mode == mode_T || mode == mode_M) {
83                 DBG((mod, LEVEL_1, "ignoring mode_T, mode_M node %+F\n", irn));
84                 return NULL;
85         }
86
87         DBG((mod, LEVEL_1, "get requirements at pos %d for %+F ... ", pos, irn));
88
89
90         if (is_Proj(irn)) {
91                 if (pos == -1) {
92                         node_pos = ia32_translate_proj_pos(irn);
93                 }
94                 else {
95                         node_pos = pos;
96                 }
97
98                 irn = my_skip_proj(irn);
99
100                 DB((mod, LEVEL_1, "skipping Proj, going to %+F at pos %d ... ", irn, node_pos));
101         }
102
103         if (is_ia32_irn(irn)) {
104                 if (pos >= 0) {
105                         irn_req = get_ia32_in_req(irn, pos);
106                 }
107                 else {
108                         irn_req = get_ia32_out_req(irn, node_pos);
109                 }
110
111                 DB((mod, LEVEL_1, "returning reqs for %+F at pos %d\n", irn, pos));
112
113                 memcpy(req, &(irn_req->req), sizeof(*req));
114
115                 if (arch_register_req_is(&(irn_req->req), should_be_same)) {
116                         assert(irn_req->same_pos >= 0 && "should be same constraint for in -> out NYI");
117                         req->other_same = get_irn_n(irn, irn_req->same_pos);
118                 }
119
120                 if (arch_register_req_is(&(irn_req->req), should_be_different)) {
121                         assert(irn_req->different_pos >= 0 && "should be different constraint for in -> out NYI");
122                         req->other_different = get_irn_n(irn, irn_req->different_pos);
123                 }
124         }
125         else {
126                 /* treat Phi like Const with default requirements */
127                 if (is_Phi(irn)) {
128                         DB((mod, LEVEL_1, "returning standard reqs for %+F\n", irn));
129                         if (mode_is_float(mode))
130                                 memcpy(req, &(ia32_default_req_ia32_fp.req), sizeof(*req));
131                         else if (mode_is_int(mode) || mode_is_reference(mode))
132                                 memcpy(req, &(ia32_default_req_ia32_gp.req), sizeof(*req));
133                         else if (mode == mode_T || mode == mode_M) {
134                                 DBG((mod, LEVEL_1, "ignoring Phi node %+F\n", irn));
135                                 return NULL;
136                         }
137                         else
138                                 assert(0 && "unsupported Phi-Mode");
139                 }
140                 else {
141                         DB((mod, LEVEL_1, "returning NULL for %+F (not ia32)\n", irn));
142                         req = NULL;
143                 }
144         }
145
146         return req;
147 }
148
149 static void ia32_set_irn_reg(const void *self, ir_node *irn, const arch_register_t *reg) {
150         int pos = 0;
151
152         if (is_Proj(irn)) {
153                 pos = ia32_translate_proj_pos(irn);
154                 irn = my_skip_proj(irn);
155         }
156
157         if (is_ia32_irn(irn)) {
158                 const arch_register_t **slots;
159
160                 slots      = get_ia32_slots(irn);
161                 slots[pos] = reg;
162         }
163         else {
164                 ia32_set_firm_reg(irn, reg, cur_reg_set);
165         }
166 }
167
168 static const arch_register_t *ia32_get_irn_reg(const void *self, const ir_node *irn) {
169         int pos = 0;
170         const arch_register_t *reg = NULL;
171
172         if (is_Proj(irn)) {
173                 pos = ia32_translate_proj_pos(irn);
174                 irn = my_skip_proj(irn);
175         }
176
177         if (is_ia32_irn(irn)) {
178                 const arch_register_t **slots;
179                 slots = get_ia32_slots(irn);
180                 reg   = slots[pos];
181         }
182         else {
183                 reg = ia32_get_firm_reg(irn, cur_reg_set);
184         }
185
186         return reg;
187 }
188
189 static arch_irn_class_t ia32_classify(const void *self, const ir_node *irn) {
190         irn = my_skip_proj(irn);
191         if (is_cfop(irn))
192                 return arch_irn_class_branch;
193         else if (is_ia32_Call(irn))
194                 return arch_irn_class_call;
195         else if (is_ia32_irn(irn))
196                 return arch_irn_class_normal;
197         else
198                 return 0;
199 }
200
201 static arch_irn_flags_t ia32_get_flags(const void *self, const ir_node *irn) {
202         irn = my_skip_proj(irn);
203         if (is_ia32_irn(irn))
204                 return get_ia32_flags(irn);
205         else {
206                 return 0;
207         }
208 }
209
210 static void ia32_set_stack_bias(const void *self, ir_node *irn, int bias) {
211         if (get_ia32_use_frame(irn)) {
212                 /* TODO: correct offset */
213         }
214 }
215
216 /* fill register allocator interface */
217
218 static const arch_irn_ops_if_t ia32_irn_ops_if = {
219         ia32_get_irn_reg_req,
220         ia32_set_irn_reg,
221         ia32_get_irn_reg,
222         ia32_classify,
223         ia32_get_flags,
224         ia32_set_stack_bias
225 };
226
227 ia32_irn_ops_t ia32_irn_ops = {
228         &ia32_irn_ops_if,
229         NULL
230 };
231
232
233
234 /**************************************************
235  *                _                         _  __
236  *               | |                       (_)/ _|
237  *   ___ ___   __| | ___  __ _  ___ _ __    _| |_
238  *  / __/ _ \ / _` |/ _ \/ _` |/ _ \ '_ \  | |  _|
239  * | (_| (_) | (_| |  __/ (_| |  __/ | | | | | |
240  *  \___\___/ \__,_|\___|\__, |\___|_| |_| |_|_|
241  *                        __/ |
242  *                       |___/
243  **************************************************/
244
245 /**
246  * Transforms the standard firm graph into
247  * an ia32 firm graph
248  */
249 static void ia32_prepare_graph(void *self) {
250         ia32_code_gen_t *cg = self;
251
252         irg_walk_blkwise_graph(cg->irg, ia32_place_consts, ia32_transform_node, cg);
253         dump_ir_block_graph_sched(cg->irg, "-transformed");
254         edges_deactivate(cg->irg);
255         edges_activate(cg->irg);
256         irg_walk_blkwise_graph(cg->irg, NULL, ia32_optimize_am, cg);
257         dump_ir_block_graph_sched(cg->irg, "-am");
258 }
259
260
261
262 /**
263  * Stack reservation and StackParam lowering.
264  */
265 static void ia32_finish_irg(ir_graph *irg, ia32_code_gen_t *cg) {
266
267 }
268
269
270
271 /**
272  * Dummy functions for hooks we don't need but which must be filled.
273  */
274 static void ia32_before_sched(void *self) {
275 }
276
277 static void ia32_before_ra(void *self) {
278 }
279
280
281 /**
282  * Creates a Store for a Spill
283  */
284 static ir_node *ia32_lower_spill(void *self, ir_node *spill) {
285         ia32_code_gen_t *cg    = self;
286         ir_graph        *irg   = cg->irg;
287         dbg_info        *dbg   = get_irn_dbg_info(spill);
288         ir_node         *block = get_nodes_block(spill);
289         ir_node         *ptr   = get_irg_frame(irg);
290         ir_node         *val   = be_get_Spill_context(spill);
291         ir_node         *mem   = new_rd_NoMem(irg);
292         ir_mode         *mode  = get_irn_mode(spill);
293         entity          *ent   = be_get_spill_entity(spill);
294         unsigned         offs  = get_entity_offset_bytes(ent);
295         ir_node         *noreg, *res;
296         char             buf[64];
297
298         DB((cg->mod, LEVEL_1, "lower_spill: got offset %d for %+F\n", offs, ent));
299
300         if (mode_is_float(mode)) {
301                 noreg = ia32_new_NoReg_fp(cg);
302                 res   = new_rd_ia32_fStore(dbg, irg, block, ptr, noreg, val, mem, mode);
303         }
304         else {
305                 noreg = ia32_new_NoReg_gp(cg);
306                 res   = new_rd_ia32_Store(dbg, irg, block, ptr, noreg, val, mem, mode);
307         }
308
309         snprintf(buf, sizeof(buf), "%d", offs);
310         add_ia32_am_offs(res, buf);
311
312         return res;
313 }
314
315 /**
316  * Create a Load for a Spill
317  */
318 static ir_node *ia32_lower_reload(void *self, ir_node *reload) {
319         ia32_code_gen_t *cg    = self;
320         ir_graph        *irg   = cg->irg;
321         dbg_info        *dbg   = get_irn_dbg_info(reload);
322         ir_node         *block = get_nodes_block(reload);
323         ir_node         *ptr   = get_irg_frame(irg);
324         ir_mode         *mode  = get_irn_mode(reload);
325         ir_node         *pred  = get_irn_n(reload, 0);
326         char             buf[64];
327         char            *ofs;
328         ir_node         *noreg, *res;
329
330         /* Get the offset to Load from. It can either be a Spill or a Store. */
331         if (be_is_Spill(pred)) {
332                 entity   *ent  = be_get_spill_entity(pred);
333                 unsigned  offs = get_entity_offset_bytes(ent);
334                 DB((cg->mod, LEVEL_1, "lower_reload: got offset %d for %+F\n", offs, ent));
335
336                 snprintf(buf, sizeof(buf), "%d", offs);
337         }
338         else if (is_ia32_Store(pred) || is_ia32_fStore(pred)) {
339                 ofs = get_ia32_am_offs(pred);
340                 strncpy(buf, ofs, sizeof(buf));
341                 free(ofs);
342         }
343         else {
344                 assert(0 && "unsupported Reload predecessor");
345         }
346
347         /* Create the Load */
348         if (mode_is_float(mode)) {
349                 noreg = ia32_new_NoReg_fp(cg);
350                 res   = new_rd_ia32_fLoad(dbg, irg, block, ptr, noreg, pred, mode_T);
351         }
352         else {
353                 noreg = ia32_new_NoReg_gp(cg);
354                 res   = new_rd_ia32_Load(dbg, irg, block, ptr, noreg, pred, mode_T);
355         }
356
357         /* Set offset */
358         add_ia32_am_offs(res, buf);
359
360         /* Return the result Proj */
361         return new_rd_Proj(dbg, irg, block, res, mode, 0);
362 }
363
364 /**
365  * Emits the code, closes the output file and frees
366  * the code generator interface.
367  */
368 static void ia32_codegen(void *self) {
369         ia32_code_gen_t *cg = self;
370         ir_graph        *irg = cg->irg;
371         FILE            *out = cg->out;
372
373         if (cg->emit_decls) {
374                 ia32_gen_decls(cg->out);
375                 cg->emit_decls = 0;
376         }
377
378         ia32_finish_irg(irg, cg);
379         //dump_ir_block_graph_sched(irg, "-finished");
380         ia32_gen_routine(out, irg, cg);
381
382         cur_reg_set = NULL;
383
384         pmap_destroy(cg->tv_ent);
385         pmap_destroy(cg->types);
386
387         /* de-allocate code generator */
388         del_set(cg->reg_set);
389         free(self);
390 }
391
392 static void *ia32_cg_init(FILE *F, const be_irg_t *birg);
393
394 static const arch_code_generator_if_t ia32_code_gen_if = {
395         ia32_cg_init,
396         ia32_prepare_graph,
397         ia32_before_sched,   /* before scheduling hook */
398         ia32_before_ra,      /* before register allocation hook */
399         ia32_lower_spill,
400         ia32_lower_reload,
401         ia32_codegen         /* emit && done */
402 };
403
404 /**
405  * Initializes the code generator.
406  */
407 static void *ia32_cg_init(FILE *F, const be_irg_t *birg) {
408         ia32_isa_t      *isa = (ia32_isa_t *)birg->main_env->arch_env->isa;
409         ia32_code_gen_t *cg  = xcalloc(1, sizeof(*cg));
410
411         cg->impl     = &ia32_code_gen_if;
412         cg->irg      = birg->irg;
413         cg->reg_set  = new_set(ia32_cmp_irn_reg_assoc, 1024);
414         cg->mod      = firm_dbg_register("firm.be.ia32.cg");
415         cg->out      = F;
416         cg->arch_env = birg->main_env->arch_env;
417         cg->types    = pmap_create();
418         cg->tv_ent   = pmap_create();
419         cg->birg     = birg;
420
421         isa->num_codegens++;
422
423         if (isa->num_codegens > 1)
424                 cg->emit_decls = 0;
425         else
426                 cg->emit_decls = 1;
427
428         cur_reg_set = cg->reg_set;
429
430         ia32_irn_ops.cg = cg;
431
432         return (arch_code_generator_t *)cg;
433 }
434
435
436
437 /*****************************************************************
438  *  ____             _                  _   _____  _____
439  * |  _ \           | |                | | |_   _|/ ____|  /\
440  * | |_) | __ _  ___| | _____ _ __   __| |   | | | (___   /  \
441  * |  _ < / _` |/ __| |/ / _ \ '_ \ / _` |   | |  \___ \ / /\ \
442  * | |_) | (_| | (__|   <  __/ | | | (_| |  _| |_ ____) / ____ \
443  * |____/ \__,_|\___|_|\_\___|_| |_|\__,_| |_____|_____/_/    \_\
444  *
445  *****************************************************************/
446
447 static ia32_isa_t ia32_isa_template = {
448         &ia32_isa_if,
449         &ia32_gp_regs[REG_ESP],
450         &ia32_gp_regs[REG_EBP],
451         -1,
452         0
453 };
454
455 /**
456  * Initializes the backend ISA.
457  */
458 static void *ia32_init(void) {
459         static int inited = 0;
460         ia32_isa_t *isa;
461
462         if(inited)
463                 return NULL;
464
465         isa = xcalloc(1, sizeof(*isa));
466         memcpy(isa, &ia32_isa_template, sizeof(*isa));
467
468         ia32_register_init(isa);
469         ia32_create_opcodes();
470
471         inited = 1;
472
473         return isa;
474 }
475
476
477
478 /**
479  * Closes the output file and frees the ISA structure.
480  */
481 static void ia32_done(void *self) {
482         free(self);
483 }
484
485
486
487 static int ia32_get_n_reg_class(const void *self) {
488         return N_CLASSES;
489 }
490
491 static const arch_register_class_t *ia32_get_reg_class(const void *self, int i) {
492         assert(i >= 0 && i < N_CLASSES && "Invalid ia32 register class requested.");
493         return &ia32_reg_classes[i];
494 }
495
496 /**
497  * Get the register class which shall be used to store a value of a given mode.
498  * @param self The this pointer.
499  * @param mode The mode in question.
500  * @return A register class which can hold values of the given mode.
501  */
502 const arch_register_class_t *ia32_get_reg_class_for_mode(const void *self, const ir_mode *mode) {
503         if (mode_is_float(mode))
504                 return &ia32_reg_classes[CLASS_ia32_fp];
505         else
506                 return &ia32_reg_classes[CLASS_ia32_gp];
507 }
508
509 /**
510  * Get the ABI restrictions for procedure calls.
511  * @param self        The this pointer.
512  * @param method_type The type of the method (procedure) in question.
513  * @param abi         The abi object to be modified
514  */
515 void ia32_get_call_abi(const void *self, ir_type *method_type, be_abi_call_t *abi) {
516         ir_type  *tp;
517         ir_mode  *mode;
518         unsigned  cc        = get_method_calling_convention(method_type);
519         int       n         = get_method_n_params(method_type);
520         int       biggest_n = -1;
521         int       stack_idx = 0;
522         int       i, ignore;
523         ir_mode **modes;
524         const arch_register_t *reg;
525
526         /* set stack parameter passing style */
527         be_abi_call_set_flags(abi, BE_ABI_FRAME_POINTER_DEDICATED, 4);
528
529         /* collect the mode for each type */
530         modes = alloca(n * sizeof(modes[0]));
531
532         for (i = 0; i < n; i++) {
533                 tp       = get_method_param_type(method_type, i);
534                 modes[i] = get_type_mode(tp);
535         }
536
537         /* set register parameters  */
538         if (cc & cc_reg_param) {
539                 /* determine the number of parameters passed via registers */
540                 biggest_n = ia32_get_n_regparam_class(n, modes, &ignore, &ignore);
541
542                 /* loop over all parameters and set the register requirements */
543                 for (i = 0; i <= biggest_n; i++) {
544                         reg = ia32_get_RegParam_reg(n, modes, i, cc);
545                         assert(reg && "kaputt");
546                         be_abi_call_param_reg(abi, i, reg);
547                 }
548
549                 stack_idx = i;
550         }
551
552
553         /* set stack parameters */
554         for (i = stack_idx; i < n; i++) {
555                 be_abi_call_param_stack(abi, i);
556         }
557
558
559         /* set return registers */
560         n = get_method_n_ress(method_type);
561
562         assert(n <= 2 && "more than two results not supported");
563
564         /* In case of 64bit returns, we will have two 32bit values */
565         if (n == 2) {
566                 tp   = get_method_res_type(method_type, 0);
567                 mode = get_type_mode(tp);
568
569                 assert(!mode_is_float(mode) && "two FP results not supported");
570
571                 tp   = get_method_res_type(method_type, 1);
572                 mode = get_type_mode(tp);
573
574                 assert(!mode_is_float(mode) && "two FP results not supported");
575
576                 be_abi_call_res_reg(abi, 0, &ia32_gp_regs[REG_EAX]);
577                 be_abi_call_res_reg(abi, 1, &ia32_gp_regs[REG_EDX]);
578         }
579         else if (n == 1) {
580                 tp   = get_method_res_type(method_type, 0);
581                 mode = get_type_mode(tp);
582
583                 if (mode_is_float(mode)) {
584                         be_abi_call_res_reg(abi, 1, &ia32_fp_regs[REG_XMM0]);
585                 }
586                 else {
587                         be_abi_call_res_reg(abi, 1, &ia32_gp_regs[REG_EAX]);
588                 }
589         }
590 }
591
592
593 static const void *ia32_get_irn_ops(const arch_irn_handler_t *self, const ir_node *irn) {
594         return &ia32_irn_ops;
595 }
596
597 const arch_irn_handler_t ia32_irn_handler = {
598         ia32_get_irn_ops
599 };
600
601 const arch_irn_handler_t *ia32_get_irn_handler(const void *self) {
602         return &ia32_irn_handler;
603 }
604
605 int ia32_to_appear_in_schedule(void *block_env, const ir_node *irn) {
606         return is_ia32_irn(irn);
607 }
608
609 /**
610  * Initializes the code generator interface.
611  */
612 static const arch_code_generator_if_t *ia32_get_code_generator_if(void *self) {
613         return &ia32_code_gen_if;
614 }
615
616 list_sched_selector_t ia32_sched_selector;
617
618 /**
619  * Returns the reg_pressure scheduler with to_appear_in_schedule() overloaded
620  */
621 static const list_sched_selector_t *ia32_get_list_sched_selector(const void *self) {
622         memcpy(&ia32_sched_selector, trivial_selector, sizeof(list_sched_selector_t));
623         ia32_sched_selector.to_appear_in_schedule = ia32_to_appear_in_schedule;
624         return &ia32_sched_selector;
625 }
626
627 #ifdef WITH_LIBCORE
628 static void ia32_register_options(lc_opt_entry_t *ent)
629 {
630 }
631 #endif /* WITH_LIBCORE */
632
633 const arch_isa_if_t ia32_isa_if = {
634 #ifdef WITH_LIBCORE
635         ia32_register_options,
636 #endif
637         ia32_init,
638         ia32_done,
639         ia32_get_n_reg_class,
640         ia32_get_reg_class,
641         ia32_get_reg_class_for_mode,
642         ia32_get_call_abi,
643         ia32_get_irn_handler,
644         ia32_get_code_generator_if,
645         ia32_get_list_sched_selector
646 };