remove old spillslot coalescing API
[libfirm] / ir / be / amd64 / bearch_amd64.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 amd64 backend driver file.
23  * @version  $Id: bearch_amd64.c 26909 2010-01-05 15:56:54Z matze $
24  */
25 #include "config.h"
26
27 #include "irgwalk.h"
28 #include "irprog.h"
29 #include "irprintf.h"
30 #include "ircons.h"
31 #include "irgmod.h"
32 #include "irdump.h"
33
34 #include "bitset.h"
35 #include "debug.h"
36
37 #include "be.h"
38 #include "../bearch.h"
39 #include "../benode.h"
40 #include "../belower.h"
41 #include "../besched.h"
42 #include "../beabi.h"
43 #include "../bemodule.h"
44 #include "../begnuas.h"
45 #include "../belistsched.h"
46 #include "../beflags.h"
47 #include "../bespillslots.h"
48
49 #include "bearch_amd64_t.h"
50
51 #include "amd64_new_nodes.h"
52 #include "gen_amd64_regalloc_if.h"
53 #include "amd64_transform.h"
54 #include "amd64_emitter.h"
55
56 DEBUG_ONLY(static firm_dbg_module_t *dbg = NULL;)
57
58 static arch_irn_class_t amd64_classify(const ir_node *irn)
59 {
60         (void) irn;
61         return arch_irn_class_none;
62 }
63
64 static ir_entity *amd64_get_frame_entity(const ir_node *node)
65 {
66         if (is_amd64_FrameAddr(node)) {
67                 const amd64_SymConst_attr_t *attr = get_amd64_SymConst_attr_const(node);
68                 return attr->entity;
69
70         } else if (is_amd64_Store(node)) {
71                 const amd64_SymConst_attr_t *attr = get_amd64_SymConst_attr_const(node);
72                 return attr->entity;
73
74         } else if (is_amd64_Load(node)) {
75                 const amd64_SymConst_attr_t *attr = get_amd64_SymConst_attr_const(node);
76                 return attr->entity;
77         }
78
79         (void) node;
80         /* TODO: return the ir_entity assigned to the frame */
81         return NULL;
82 }
83
84 /**
85  * This function is called by the generic backend to correct offsets for
86  * nodes accessing the stack.
87  */
88 static void amd64_set_frame_offset(ir_node *irn, int offset)
89 {
90         if (is_amd64_FrameAddr(irn)) {
91                 amd64_SymConst_attr_t *attr = get_amd64_SymConst_attr(irn);
92                 attr->fp_offset += offset;
93
94         } else if (is_amd64_Store(irn)) {
95                 amd64_SymConst_attr_t *attr = get_amd64_SymConst_attr(irn);
96                 attr->fp_offset += offset;
97
98         } else if (is_amd64_Load(irn)) {
99                 amd64_SymConst_attr_t *attr = get_amd64_SymConst_attr(irn);
100                 attr->fp_offset += offset;
101
102         }
103 }
104
105 static int amd64_get_sp_bias(const ir_node *irn)
106 {
107         (void) irn;
108         return 0;
109 }
110
111 /* fill register allocator interface */
112
113 static const arch_irn_ops_t amd64_irn_ops = {
114         amd64_classify,
115         amd64_get_frame_entity,
116         amd64_set_frame_offset,
117         amd64_get_sp_bias,
118         NULL,    /* get_inverse             */
119         NULL,    /* get_op_estimated_cost   */
120         NULL,    /* possible_memory_operand */
121         NULL,    /* perform_memory_operand  */
122 };
123
124
125
126 /**
127  * Transforms the standard firm graph into
128  * a amd64 firm graph
129  */
130 static void amd64_prepare_graph(ir_graph *irg)
131 {
132         amd64_irg_data_t *irg_data = amd64_get_irg_data(irg);
133         amd64_transform_graph(irg);
134
135         if (irg_data->dump)
136                 dump_ir_graph(irg, "transformed");
137 }
138
139
140 /**
141  * Called immediatly before emit phase.
142  */
143 static void amd64_finish_irg(ir_graph *irg)
144 {
145         (void) irg;
146 }
147
148 static void amd64_before_ra(ir_graph *irg)
149 {
150         be_sched_fix_flags(irg, &amd64_reg_classes[CLASS_amd64_flags], NULL, NULL);
151 }
152
153
154 static void transform_Reload(ir_node *node)
155 {
156         ir_graph  *irg    = get_irn_irg(node);
157         ir_node   *block  = get_nodes_block(node);
158         dbg_info  *dbgi   = get_irn_dbg_info(node);
159         ir_node   *ptr    = get_irg_frame(irg);
160         ir_node   *mem    = get_irn_n(node, be_pos_Reload_mem);
161         ir_mode   *mode   = get_irn_mode(node);
162         ir_entity *entity = be_get_frame_entity(node);
163         const arch_register_t *reg;
164         ir_node   *proj;
165         ir_node   *load;
166
167         ir_node  *sched_point = sched_prev(node);
168
169         load = new_bd_amd64_Load(dbgi, block, ptr, mem, entity);
170         sched_add_after(sched_point, load);
171         sched_remove(node);
172
173         proj = new_rd_Proj(dbgi, load, mode, pn_amd64_Load_res);
174
175         reg = arch_get_irn_register(node);
176         arch_set_irn_register(proj, reg);
177
178         exchange(node, proj);
179 }
180
181 static void transform_Spill(ir_node *node)
182 {
183         ir_graph  *irg    = get_irn_irg(node);
184         ir_node   *block  = get_nodes_block(node);
185         dbg_info  *dbgi   = get_irn_dbg_info(node);
186         ir_node   *ptr    = get_irg_frame(irg);
187         ir_node   *mem    = new_r_NoMem(irg);
188         ir_node   *val    = get_irn_n(node, be_pos_Spill_val);
189         //ir_mode   *mode   = get_irn_mode(val);
190         ir_entity *entity = be_get_frame_entity(node);
191         ir_node   *sched_point;
192         ir_node   *store;
193
194         sched_point = sched_prev(node);
195         store = new_bd_amd64_Store(dbgi, block, ptr, val, mem, entity);
196
197         sched_remove(node);
198         sched_add_after(sched_point, store);
199
200         exchange(node, store);
201 }
202
203 static void amd64_after_ra_walker(ir_node *block, void *data)
204 {
205         ir_node *node, *prev;
206         (void) data;
207
208         for (node = sched_last(block); !sched_is_begin(node); node = prev) {
209                 prev = sched_prev(node);
210
211                 if (be_is_Reload(node)) {
212                         transform_Reload(node);
213                 } else if (be_is_Spill(node)) {
214                         transform_Spill(node);
215                 }
216         }
217 }
218
219 static void amd64_set_frame_entity(ir_node *node, ir_entity *entity)
220 {
221         assert(be_is_Reload(node));
222         be_node_set_frame_entity(node, entity);
223 }
224
225 /**
226  * Collects nodes that need frame entities assigned.
227  */
228 static void amd64_collect_frame_entity_nodes(ir_node *node, void *data)
229 {
230         if (be_is_Reload(node) && be_get_frame_entity(node) == NULL) {
231                 be_fec_env_t  *env   = (be_fec_env_t*)data;
232                 const ir_mode *mode  = get_irn_mode(node);
233                 int            align = get_mode_size_bytes(mode);
234                 be_node_needs_frame_entity(env, node, mode, align);
235         }
236 }
237
238 static void amd64_after_ra(ir_graph *irg)
239 {
240         be_fec_env_t *fec_env = be_new_frame_entity_coalescer(irg);
241
242         /* create and coalesce frame entities */
243         irg_walk_graph(irg, NULL, amd64_collect_frame_entity_nodes, fec_env);
244         be_assign_entities(fec_env, amd64_set_frame_entity);
245         be_free_frame_entity_coalescer(fec_env);
246
247         irg_block_walk_graph(irg, NULL, amd64_after_ra_walker, NULL);
248 }
249
250 /**
251  * Initializes the code generator.
252  */
253 static void amd64_init_graph(ir_graph *irg)
254 {
255         struct obstack   *obst     = be_get_be_obst(irg);
256         amd64_irg_data_t *irg_data = OALLOCZ(obst, amd64_irg_data_t);
257         irg_data->dump = (be_get_irg_options(irg)->dump_flags & DUMP_BE) ? 1 : 0;
258
259         be_birg_from_irg(irg)->isa_link = irg_data;
260 }
261
262
263 typedef ir_node *(*create_const_node_func) (dbg_info *dbg, ir_node *block);
264
265 /**
266  * Used to create per-graph unique pseudo nodes.
267  */
268 static inline ir_node *create_const(ir_graph *irg, ir_node **place,
269                                     create_const_node_func func,
270                                     const arch_register_t* reg)
271 {
272         ir_node *block, *res;
273
274         if (*place != NULL)
275                 return *place;
276
277         block = get_irg_start_block(irg);
278         res = func(NULL, block);
279         arch_set_irn_register(res, reg);
280         *place = res;
281
282         return res;
283 }
284
285 extern const arch_isa_if_t amd64_isa_if;
286 static amd64_isa_t amd64_isa_template = {
287         {
288                 &amd64_isa_if,             /* isa interface implementation */
289                 N_AMD64_REGISTERS,
290                 amd64_registers,
291                 N_AMD64_CLASSES,
292                 amd64_reg_classes,
293                 &amd64_registers[REG_RSP],  /* stack pointer register */
294                 &amd64_registers[REG_RBP],  /* base pointer register */
295                 &amd64_reg_classes[CLASS_amd64_gp],  /* link pointer register class */
296                 -1,                          /* stack direction */
297                 3,                           /* power of two stack alignment for calls, 2^2 == 4 */
298                 NULL,                        /* main environment */
299                 7,                           /* costs for a spill instruction */
300                 5,                           /* costs for a reload instruction */
301                 false,                       /* no custom abi handling */
302         },
303 };
304
305 /**
306  * Initializes the backend ISA
307  */
308 static arch_env_t *amd64_init(FILE *outfile)
309 {
310         amd64_isa_t *isa = XMALLOC(amd64_isa_t);
311         memcpy(isa, &amd64_isa_template, sizeof(*isa));
312
313         be_emit_init(outfile);
314
315         amd64_register_init();
316         amd64_create_opcodes(&amd64_irn_ops);
317
318         return &isa->base;
319 }
320
321
322
323 /**
324  * Closes the output file and frees the ISA structure.
325  */
326 static void amd64_done(void *self)
327 {
328         amd64_isa_t *isa = (amd64_isa_t*)self;
329
330         /* emit now all global declarations */
331         be_gas_emit_decls(isa->base.main_env);
332
333         be_emit_exit();
334         free(self);
335 }
336
337
338 /**
339  * Get the register class which shall be used to store a value of a given mode.
340  * @param self The this pointer.
341  * @param mode The mode in question.
342  * @return A register class which can hold values of the given mode.
343  */
344 static const arch_register_class_t *amd64_get_reg_class_for_mode(const ir_mode *mode)
345 {
346         assert(!mode_is_float(mode));
347         return &amd64_reg_classes[CLASS_amd64_gp];
348 }
349
350
351
352 typedef struct {
353         be_abi_call_flags_bits_t flags;
354         ir_graph *irg;
355 } amd64_abi_env_t;
356
357 static void *amd64_abi_init(const be_abi_call_t *call, ir_graph *irg)
358 {
359         amd64_abi_env_t *env = XMALLOC(amd64_abi_env_t);
360         be_abi_call_flags_t fl = be_abi_call_get_flags(call);
361         env->flags    = fl.bits;
362         env->irg      = irg;
363         return env;
364 }
365
366 /**
367  * Get the between type for that call.
368  * @param self The callback object.
369  * @return The between type of for that call.
370  */
371 static ir_type *amd64_get_between_type(void *self)
372 {
373         static ir_type *between_type = NULL;
374         static ir_entity *old_bp_ent = NULL;
375         (void) self;
376
377         if(!between_type) {
378                 ir_entity *ret_addr_ent;
379                 ir_type *ret_addr_type = new_type_primitive(mode_P);
380                 ir_type *old_bp_type   = new_type_primitive(mode_P);
381
382                 between_type           = new_type_class(new_id_from_str("amd64_between_type"));
383                 old_bp_ent             = new_entity(between_type, new_id_from_str("old_bp"), old_bp_type);
384                 ret_addr_ent           = new_entity(between_type, new_id_from_str("old_bp"), ret_addr_type);
385
386                 set_entity_offset(old_bp_ent, 0);
387                 set_entity_offset(ret_addr_ent, get_type_size_bytes(old_bp_type));
388                 set_type_size_bytes(between_type, get_type_size_bytes(old_bp_type) + get_type_size_bytes(ret_addr_type));
389         }
390
391         return between_type;
392 }
393
394 /**
395  * Build the prolog, return the BASE POINTER register
396  */
397 static const arch_register_t *amd64_abi_prologue(void *self, ir_node **mem,
398                                                     pmap *reg_map, int *stack_bias)
399 {
400         amd64_abi_env_t  *env  = (amd64_abi_env_t*)self;
401         const arch_env_t *aenv = be_get_irg_arch_env(env->irg);
402         (void) mem;
403         (void) stack_bias;
404         (void) aenv;
405         (void) reg_map;
406
407         if (!env->flags.try_omit_fp) {
408                 /* FIXME: maybe later here should be some code to generate
409                  * the usual abi prologue */
410                 return aenv->bp;
411         }
412
413         return aenv->sp;
414 }
415
416 /* Build the epilog */
417 static void amd64_abi_epilogue(void *self, ir_node *bl, ir_node **mem,
418                                pmap *reg_map)
419 {
420         amd64_abi_env_t  *env  = (amd64_abi_env_t*)self;
421         const arch_env_t *aenv = be_get_irg_arch_env(env->irg);
422         ir_node          *curr_sp  = be_abi_reg_map_get(reg_map, aenv->sp);
423         ir_node          *curr_bp  = be_abi_reg_map_get(reg_map, aenv->bp);
424         (void) bl;
425         (void) mem;
426
427         if (env->flags.try_omit_fp) {
428                 curr_sp = be_new_IncSP(aenv->sp, bl, curr_sp, BE_STACK_FRAME_SIZE_SHRINK, 0);
429         }
430
431         be_abi_reg_map_set(reg_map, aenv->sp, curr_sp);
432         be_abi_reg_map_set(reg_map, aenv->bp, curr_bp);
433 }
434
435 static const be_abi_callbacks_t amd64_abi_callbacks = {
436         amd64_abi_init,
437         free,
438         amd64_get_between_type,
439         amd64_abi_prologue,
440         amd64_abi_epilogue,
441 };
442
443 static const arch_register_t *gpreg_param_reg_std[] = {
444         &amd64_registers[REG_RDI],
445         &amd64_registers[REG_RSI],
446         &amd64_registers[REG_RDX],
447         &amd64_registers[REG_RCX],
448         &amd64_registers[REG_R8],
449         &amd64_registers[REG_R9],
450 };
451
452 static const arch_register_t *amd64_get_RegParam_reg(int n)
453 {
454         assert(n < 6 && n >=0 && "register param > 6 requested");
455         return gpreg_param_reg_std[n];
456 }
457
458 /**
459  * Get the ABI restrictions for procedure calls.
460  * @param self        The this pointer.
461  * @param method_type The type of the method (procedure) in question.
462  * @param abi         The abi object to be modified
463  */
464 static void amd64_get_call_abi(const void *self, ir_type *method_type,
465                            be_abi_call_t *abi)
466 {
467         ir_type  *tp;
468         ir_mode  *mode;
469         int       i, n = get_method_n_params(method_type);
470         be_abi_call_flags_t call_flags;
471         int no_reg = 0;
472
473         (void) self;
474
475         /* set abi flags for calls */
476         call_flags.bits.left_to_right         = 0;
477         call_flags.bits.store_args_sequential = 0;
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         /* set stack parameter passing style */
483         be_abi_call_set_flags(abi, call_flags, &amd64_abi_callbacks);
484
485         for (i = 0; i < n; i++) {
486                 tp   = get_method_param_type(method_type, i);
487                 mode = get_type_mode(tp);
488                 //d// printf ("MODE %p %p XX %d\n", mode, mode_Iu, i);
489
490                 if (!no_reg && i < 6 && mode_is_data (mode)) {
491                         //d// printf("TEST%d\n", i);
492                         be_abi_call_param_reg(abi, i, amd64_get_RegParam_reg (i),
493                                               ABI_CONTEXT_BOTH);
494                 /* default: all parameters on stack */
495                 } else {
496                         no_reg = 1;
497                         be_abi_call_param_stack(abi, i, mode, 8, 0, 0, ABI_CONTEXT_BOTH);
498                 }
499         }
500
501         /* TODO: set correct return register */
502         /* default: return value is in R0 resp. F0 */
503         if (get_method_n_ress(method_type) > 0) {
504                 tp   = get_method_res_type(method_type, 0);
505                 mode = get_type_mode(tp);
506
507                 /* FIXME: No floating point yet */
508                 /* be_abi_call_res_reg(abi, 0,
509                         mode_is_float(mode) ? &amd64_fp_regs[REG_F0] : &amd64_registers[REG_R0], ABI_CONTEXT_BOTH) */;
510
511                 be_abi_call_res_reg(abi, 0,
512                         &amd64_registers[REG_RAX], ABI_CONTEXT_BOTH);
513         }
514 }
515
516 /**
517  * Returns the necessary byte alignment for storing a register of given class.
518  */
519 static int amd64_get_reg_class_alignment(const arch_register_class_t *cls)
520 {
521         ir_mode *mode = arch_register_class_mode(cls);
522         return get_mode_size_bytes(mode);
523 }
524
525 static void amd64_lower_for_target(void)
526 {
527         lower_params_t params = {
528                 4,                                     /* def_ptr_alignment */
529                 LF_COMPOUND_RETURN | LF_RETURN_HIDDEN, /* flags */
530                 ADD_HIDDEN_ALWAYS_IN_FRONT,            /* hidden_params */
531                 NULL,                                  /* find pointer type */
532                 NULL,                                  /* ret_compound_in_regs */
533         };
534
535         /* lower compound param handling */
536         lower_calls_with_compounds(&params);
537 }
538
539 static int amd64_is_mux_allowed(ir_node *sel, ir_node *mux_false,
540                                 ir_node *mux_true)
541 {
542         (void) sel;
543         (void) mux_false;
544         (void) mux_true;
545         return false;
546 }
547
548 /**
549  * Returns the libFirm configuration parameter for this backend.
550  */
551 static const backend_params *amd64_get_backend_params(void) {
552         static backend_params p = {
553                 0,     /* no inline assembly */
554                 1,     /* support Rotl nodes */
555                 0,     /* little endian */
556                 NULL,  /* will be set later */
557                 amd64_is_mux_allowed,  /* parameter for if conversion */
558                 NULL,  /* float arithmetic mode */
559                 0,     /* no trampoline support: size 0 */
560                 0,     /* no trampoline support: align 0 */
561                 NULL,  /* no trampoline support: no trampoline builder */
562                 8      /* alignment of stack parameter: typically 4 (32bit) or 8 (64bit) */
563         };
564         return &p;
565 }
566
567 static ir_graph **amd64_get_backend_irg_list(const void *self,
568                                                 ir_graph ***irgs)
569 {
570         (void) self;
571         (void) irgs;
572         return NULL;
573 }
574
575 static asm_constraint_flags_t amd64_parse_asm_constraint(const char **c)
576 {
577         (void) c;
578         return ASM_CONSTRAINT_FLAG_INVALID;
579 }
580
581 static int amd64_is_valid_clobber(const char *clobber)
582 {
583         (void) clobber;
584         return 0;
585 }
586
587 const arch_isa_if_t amd64_isa_if = {
588         amd64_init,
589         amd64_lower_for_target,
590         amd64_done,
591         NULL,                /* handle intrinsics */
592         amd64_get_reg_class_for_mode,
593         amd64_get_call_abi,
594         amd64_get_reg_class_alignment,
595     amd64_get_backend_params,
596         amd64_get_backend_irg_list,
597         NULL,                    /* mark remat */
598         amd64_parse_asm_constraint,
599         amd64_is_valid_clobber,
600
601         amd64_init_graph,
602         NULL,              /* get_pic_base */
603         NULL,              /* before_abi */
604         amd64_prepare_graph,
605         amd64_before_ra,
606         amd64_after_ra,
607         amd64_finish_irg,
608         amd64_gen_routine,
609 };
610
611 BE_REGISTER_MODULE_CONSTRUCTOR(be_init_arch_amd64);
612 void be_init_arch_amd64(void)
613 {
614         be_register_isa_if("amd64", &amd64_isa_if);
615         FIRM_DBG_REGISTER(dbg, "firm.be.amd64.cg");
616         amd64_init_transform();
617 }