avoid querying End/Anchor for register requirements
[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  */
24 #include "config.h"
25
26 #include "irgwalk.h"
27 #include "irprog.h"
28 #include "irprintf.h"
29 #include "ircons.h"
30 #include "irgmod.h"
31 #include "irdump.h"
32 #include "lower_calls.h"
33
34 #include "bitset.h"
35 #include "debug.h"
36 #include "error.h"
37
38 #include "be_t.h"
39 #include "bearch.h"
40 #include "beirg.h"
41 #include "benode.h"
42 #include "belower.h"
43 #include "besched.h"
44 #include "beabi.h"
45 #include "bemodule.h"
46 #include "begnuas.h"
47 #include "belistsched.h"
48 #include "beflags.h"
49 #include "bespillslots.h"
50 #include "bespillutil.h"
51 #include "bestack.h"
52
53 #include "bearch_amd64_t.h"
54
55 #include "amd64_new_nodes.h"
56 #include "gen_amd64_regalloc_if.h"
57 #include "amd64_transform.h"
58 #include "amd64_emitter.h"
59
60 DEBUG_ONLY(static firm_dbg_module_t *dbg = NULL;)
61
62 static ir_entity *amd64_get_frame_entity(const ir_node *node)
63 {
64         if (is_amd64_FrameAddr(node)) {
65                 const amd64_SymConst_attr_t *attr = get_amd64_SymConst_attr_const(node);
66                 return attr->entity;
67
68         } else if (is_amd64_Store(node)) {
69                 const amd64_SymConst_attr_t *attr = get_amd64_SymConst_attr_const(node);
70                 return attr->entity;
71
72         } else if (is_amd64_Load(node)) {
73                 const amd64_SymConst_attr_t *attr = get_amd64_SymConst_attr_const(node);
74                 return attr->entity;
75         }
76
77         (void) node;
78         /* TODO: return the ir_entity assigned to the frame */
79         return NULL;
80 }
81
82 /**
83  * This function is called by the generic backend to correct offsets for
84  * nodes accessing the stack.
85  */
86 static void amd64_set_frame_offset(ir_node *irn, int offset)
87 {
88         if (is_amd64_FrameAddr(irn)) {
89                 amd64_SymConst_attr_t *attr = get_amd64_SymConst_attr(irn);
90                 attr->fp_offset += offset;
91
92         } else if (is_amd64_Store(irn)) {
93                 amd64_SymConst_attr_t *attr = get_amd64_SymConst_attr(irn);
94                 attr->fp_offset += offset;
95
96         } else if (is_amd64_Load(irn)) {
97                 amd64_SymConst_attr_t *attr = get_amd64_SymConst_attr(irn);
98                 attr->fp_offset += offset;
99
100         }
101 }
102
103 static int amd64_get_sp_bias(const ir_node *irn)
104 {
105         (void) irn;
106         return 0;
107 }
108
109 /* fill register allocator interface */
110
111 static const arch_irn_ops_t amd64_irn_ops = {
112         amd64_get_frame_entity,
113         amd64_set_frame_offset,
114         amd64_get_sp_bias,
115         NULL,    /* get_op_estimated_cost   */
116         NULL,    /* possible_memory_operand */
117         NULL,    /* perform_memory_operand  */
118 };
119
120
121
122 /**
123  * Transforms the standard firm graph into
124  * a amd64 firm graph
125  */
126 static void amd64_prepare_graph(ir_graph *irg)
127 {
128         amd64_transform_graph(irg);
129
130         if (be_options.dump_flags & DUMP_BE)
131                 dump_ir_graph(irg, "transformed");
132 }
133
134 static void amd64_before_ra(ir_graph *irg)
135 {
136         be_sched_fix_flags(irg, &amd64_reg_classes[CLASS_amd64_flags], NULL, NULL);
137 }
138
139 static void transform_Reload(ir_node *node)
140 {
141         ir_graph  *irg    = get_irn_irg(node);
142         ir_node   *block  = get_nodes_block(node);
143         dbg_info  *dbgi   = get_irn_dbg_info(node);
144         ir_node   *ptr    = get_irg_frame(irg);
145         ir_node   *mem    = get_irn_n(node, n_be_Reload_mem);
146         ir_mode   *mode   = get_irn_mode(node);
147         ir_entity *entity = be_get_frame_entity(node);
148         const arch_register_t *reg;
149         ir_node   *proj;
150         ir_node   *load;
151
152         ir_node  *sched_point = sched_prev(node);
153
154         load = new_bd_amd64_Load(dbgi, block, ptr, mem, entity);
155         sched_add_after(sched_point, load);
156         sched_remove(node);
157
158         proj = new_rd_Proj(dbgi, load, mode, pn_amd64_Load_res);
159
160         reg = arch_get_irn_register(node);
161         arch_set_irn_register(proj, reg);
162
163         exchange(node, proj);
164 }
165
166 static void transform_Spill(ir_node *node)
167 {
168         ir_graph  *irg    = get_irn_irg(node);
169         ir_node   *block  = get_nodes_block(node);
170         dbg_info  *dbgi   = get_irn_dbg_info(node);
171         ir_node   *ptr    = get_irg_frame(irg);
172         ir_node   *mem    = get_irg_no_mem(irg);
173         ir_node   *val    = get_irn_n(node, n_be_Spill_val);
174         //ir_mode   *mode   = get_irn_mode(val);
175         ir_entity *entity = be_get_frame_entity(node);
176         ir_node   *sched_point;
177         ir_node   *store;
178
179         sched_point = sched_prev(node);
180         store = new_bd_amd64_Store(dbgi, block, ptr, val, mem, entity);
181
182         sched_remove(node);
183         sched_add_after(sched_point, store);
184
185         exchange(node, store);
186 }
187
188 static void amd64_after_ra_walker(ir_node *block, void *data)
189 {
190         ir_node *node, *prev;
191         (void) data;
192
193         for (node = sched_last(block); !sched_is_begin(node); node = prev) {
194                 prev = sched_prev(node);
195
196                 if (be_is_Reload(node)) {
197                         transform_Reload(node);
198                 } else if (be_is_Spill(node)) {
199                         transform_Spill(node);
200                 }
201         }
202 }
203
204 static void amd64_set_frame_entity(ir_node *node, ir_entity *entity)
205 {
206         assert(be_is_Reload(node) || be_is_Spill(node));
207         be_node_set_frame_entity(node, entity);
208 }
209
210 /**
211  * Collects nodes that need frame entities assigned.
212  */
213 static void amd64_collect_frame_entity_nodes(ir_node *node, void *data)
214 {
215         if (be_is_Reload(node) && be_get_frame_entity(node) == NULL) {
216                 be_fec_env_t  *env   = (be_fec_env_t*)data;
217                 const ir_mode *mode  = get_irn_mode(node);
218                 int            align = get_mode_size_bytes(mode);
219                 be_node_needs_frame_entity(env, node, mode, align);
220         }
221 }
222
223 /**
224  * Called immediatly before emit phase.
225  */
226 static void amd64_finish_irg(ir_graph *irg)
227 {
228         be_stack_layout_t *stack_layout = be_get_irg_stack_layout(irg);
229         bool               at_begin     = stack_layout->sp_relative ? true : false;
230         be_fec_env_t      *fec_env      = be_new_frame_entity_coalescer(irg);
231
232         /* create and coalesce frame entities */
233         irg_walk_graph(irg, NULL, amd64_collect_frame_entity_nodes, fec_env);
234         be_assign_entities(fec_env, amd64_set_frame_entity, at_begin);
235         be_free_frame_entity_coalescer(fec_env);
236
237         irg_block_walk_graph(irg, NULL, amd64_after_ra_walker, NULL);
238
239         /* fix stack entity offsets */
240         be_abi_fix_stack_nodes(irg);
241         be_abi_fix_stack_bias(irg);
242 }
243
244 extern const arch_isa_if_t amd64_isa_if;
245 static amd64_isa_t amd64_isa_template = {
246         {
247                 &amd64_isa_if,             /* isa interface implementation */
248                 N_AMD64_REGISTERS,
249                 amd64_registers,
250                 N_AMD64_CLASSES,
251                 amd64_reg_classes,
252                 &amd64_registers[REG_RSP], /* stack pointer register */
253                 &amd64_registers[REG_RBP], /* base pointer register */
254                 3,                         /* power of two stack alignment for calls, 2^2 == 4 */
255                 NULL,                      /* main environment */
256                 7,                         /* costs for a spill instruction */
257                 5,                         /* costs for a reload instruction */
258                 false,                     /* no custom abi handling */
259         },
260 };
261
262 static void amd64_init(void)
263 {
264         amd64_register_init();
265         amd64_create_opcodes(&amd64_irn_ops);
266 }
267
268 static void amd64_finish(void)
269 {
270         amd64_free_opcodes();
271 }
272
273 static arch_env_t *amd64_begin_codegeneration(const be_main_env_t *env)
274 {
275         amd64_isa_t *isa = XMALLOC(amd64_isa_t);
276         *isa = amd64_isa_template;
277
278         be_emit_init(env->file_handle);
279         be_gas_begin_compilation_unit(env);
280
281         return &isa->base;
282 }
283
284 /**
285  * Closes the output file and frees the ISA structure.
286  */
287 static void amd64_end_codegeneration(void *self)
288 {
289         amd64_isa_t *isa = (amd64_isa_t*)self;
290
291         /* emit now all global declarations */
292         be_gas_end_compilation_unit(isa->base.main_env);
293
294         be_emit_exit();
295         free(self);
296 }
297
298 /**
299  * Get the between type for that call.
300  * @param self The callback object.
301  * @return The between type of for that call.
302  */
303 static ir_type *amd64_get_between_type(ir_graph *irg)
304 {
305         static ir_type *between_type = NULL;
306         static ir_entity *old_bp_ent = NULL;
307         (void) irg;
308
309         if(!between_type) {
310                 ir_entity *ret_addr_ent;
311                 ir_type *ret_addr_type = new_type_primitive(mode_P);
312                 ir_type *old_bp_type   = new_type_primitive(mode_P);
313
314                 between_type           = new_type_class(new_id_from_str("amd64_between_type"));
315                 old_bp_ent             = new_entity(between_type, new_id_from_str("old_bp"), old_bp_type);
316                 ret_addr_ent           = new_entity(between_type, new_id_from_str("old_bp"), ret_addr_type);
317
318                 set_entity_offset(old_bp_ent, 0);
319                 set_entity_offset(ret_addr_ent, get_type_size_bytes(old_bp_type));
320                 set_type_size_bytes(between_type, get_type_size_bytes(old_bp_type) + get_type_size_bytes(ret_addr_type));
321         }
322
323         return between_type;
324 }
325
326 static const be_abi_callbacks_t amd64_abi_callbacks = {
327         amd64_get_between_type,
328 };
329
330 static const arch_register_t *gpreg_param_reg_std[] = {
331         &amd64_registers[REG_RDI],
332         &amd64_registers[REG_RSI],
333         &amd64_registers[REG_RDX],
334         &amd64_registers[REG_RCX],
335         &amd64_registers[REG_R8],
336         &amd64_registers[REG_R9],
337 };
338
339 static const arch_register_t *amd64_get_RegParam_reg(int n)
340 {
341         assert(n < 6 && n >=0 && "register param > 6 requested");
342         return gpreg_param_reg_std[n];
343 }
344
345 /**
346  * Get the ABI restrictions for procedure calls.
347  * @param self        The this pointer.
348  * @param method_type The type of the method (procedure) in question.
349  * @param abi         The abi object to be modified
350  */
351 static void amd64_get_call_abi(ir_type *method_type, be_abi_call_t *abi)
352 {
353         ir_type  *tp;
354         ir_mode  *mode;
355         int       i, n = get_method_n_params(method_type);
356         int no_reg = 0;
357
358         /* set abi flags for calls */
359         be_abi_call_flags_t call_flags = be_abi_call_get_flags(abi);
360         call_flags.call_has_imm = true;
361         be_abi_call_set_flags(abi, call_flags, &amd64_abi_callbacks);
362
363         for (i = 0; i < n; i++) {
364                 tp   = get_method_param_type(method_type, i);
365                 mode = get_type_mode(tp);
366                 //d// printf ("MODE %p %p XX %d\n", mode, mode_Iu, i);
367
368                 if (!no_reg && i < 6 && mode_is_data (mode)) {
369                         //d// printf("TEST%d\n", i);
370                         be_abi_call_param_reg(abi, i, amd64_get_RegParam_reg (i),
371                                               ABI_CONTEXT_BOTH);
372                 /* default: all parameters on stack */
373                 } else {
374                         no_reg = 1;
375                         be_abi_call_param_stack(abi, i, mode, 8, 0, 0, ABI_CONTEXT_BOTH);
376                 }
377         }
378
379         /* TODO: set correct return register */
380         /* default: return value is in R0 resp. F0 */
381         if (get_method_n_ress(method_type) > 0) {
382                 tp   = get_method_res_type(method_type, 0);
383                 mode = get_type_mode(tp);
384
385                 if (mode_is_float(mode))
386                         panic("float not supported yet");
387
388                 be_abi_call_res_reg(abi, 0,
389                         &amd64_registers[REG_RAX], ABI_CONTEXT_BOTH);
390         }
391 }
392
393 static void amd64_lower_for_target(void)
394 {
395         size_t i, n_irgs = get_irp_n_irgs();
396
397         /* lower compound param handling */
398         lower_calls_with_compounds(LF_RETURN_HIDDEN);
399
400         for (i = 0; i < n_irgs; ++i) {
401                 ir_graph *irg = get_irp_irg(i);
402                 /* Turn all small CopyBs into loads/stores, and turn all bigger
403                  * CopyBs into memcpy calls, because we cannot handle CopyB nodes
404                  * during code generation yet.
405                  * TODO:  Adapt this once custom CopyB handling is implemented. */
406                 lower_CopyB(irg, 64, 65, true);
407         }
408 }
409
410 static int amd64_is_mux_allowed(ir_node *sel, ir_node *mux_false,
411                                 ir_node *mux_true)
412 {
413         (void) sel;
414         (void) mux_false;
415         (void) mux_true;
416         return false;
417 }
418
419 /**
420  * Returns the libFirm configuration parameter for this backend.
421  */
422 static const backend_params *amd64_get_backend_params(void) {
423         static backend_params p = {
424                 0,     /* no inline assembly */
425                 1,     /* support Rotl nodes */
426                 0,     /* little endian */
427                 1,     /* modulo shift is efficient */
428                 0,     /* non-modulo shift is not efficient */
429                 NULL,  /* will be set later */
430                 amd64_is_mux_allowed,  /* parameter for if conversion */
431                 64,    /* machine size */
432                 NULL,  /* float arithmetic mode */
433                 NULL,  /* long long type */
434                 NULL,  /* unsigned long long type */
435                 NULL,  /* long double type (not supported yet) */
436                 0,     /* no trampoline support: size 0 */
437                 0,     /* no trampoline support: align 0 */
438                 NULL,  /* no trampoline support: no trampoline builder */
439                 8      /* alignment of stack parameter: typically 4 (32bit) or 8 (64bit) */
440         };
441         return &p;
442 }
443
444 static asm_constraint_flags_t amd64_parse_asm_constraint(const char **c)
445 {
446         (void) c;
447         return ASM_CONSTRAINT_FLAG_INVALID;
448 }
449
450 static int amd64_is_valid_clobber(const char *clobber)
451 {
452         (void) clobber;
453         return 0;
454 }
455
456 static int amd64_register_saved_by(const arch_register_t *reg, int callee)
457 {
458         if (callee) {
459                 /* check for callee saved */
460                 if (reg->reg_class == &amd64_reg_classes[CLASS_amd64_gp]) {
461                         switch (reg->index) {
462                         case REG_GP_RBX:
463                         case REG_GP_RBP:
464                         case REG_GP_R12:
465                         case REG_GP_R13:
466                         case REG_GP_R14:
467                         case REG_GP_R15:
468                                 return 1;
469                         default:
470                                 return 0;
471                         }
472                 }
473         } else {
474                 /* check for caller saved */
475                 if (reg->reg_class == &amd64_reg_classes[CLASS_amd64_gp]) {
476                         switch (reg->index) {
477                         case REG_GP_RAX:
478                         case REG_GP_RCX:
479                         case REG_GP_RDX:
480                         case REG_GP_RSI:
481                         case REG_GP_RDI:
482                         case REG_GP_R8:
483                         case REG_GP_R9:
484                         case REG_GP_R10:
485                         case REG_GP_R11:
486                                 return 1;
487                         default:
488                                 return 0;
489                         }
490                 }
491         }
492         return 0;
493 }
494
495 const arch_isa_if_t amd64_isa_if = {
496         amd64_init,
497         amd64_finish,
498     amd64_get_backend_params,
499         amd64_lower_for_target,
500         amd64_parse_asm_constraint,
501         amd64_is_valid_clobber,
502
503         amd64_begin_codegeneration,
504         amd64_end_codegeneration,
505         NULL,
506         amd64_get_call_abi,
507         NULL,              /* mark remat */
508         NULL,              /* get_pic_base */
509         be_new_spill,
510         be_new_reload,
511         amd64_register_saved_by,
512
513         NULL,              /* handle intrinsics */
514         NULL,              /* before_abi */
515         amd64_prepare_graph,
516         amd64_before_ra,
517         amd64_finish_irg,
518         amd64_gen_routine,
519 };
520
521 BE_REGISTER_MODULE_CONSTRUCTOR(be_init_arch_amd64)
522 void be_init_arch_amd64(void)
523 {
524         be_register_isa_if("amd64", &amd64_isa_if);
525         FIRM_DBG_REGISTER(dbg, "firm.be.amd64.cg");
526         amd64_init_transform();
527 }