forbid calls of new_XXX and new_d_XXX when not in phase_building (only new_r_XXX...
[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 0;
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_irn_generic_attr_const(node);
68                 return attr->entity;
69
70         } else if (is_amd64_Store(node)) {
71                 const amd64_SymConst_attr_t *attr = get_irn_generic_attr_const(node);
72                 return attr->entity;
73
74         } else if (is_amd64_Load(node)) {
75                 const amd64_SymConst_attr_t *attr = get_irn_generic_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_irn_generic_attr(irn);
92                 attr->fp_offset += offset;
93
94         } else if (is_amd64_Store(irn)) {
95                 amd64_SymConst_attr_t *attr = get_irn_generic_attr(irn);
96                 attr->fp_offset += offset;
97
98         } else if (is_amd64_Load(irn)) {
99                 amd64_SymConst_attr_t *attr = get_irn_generic_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_after_ra(ir_graph *irg)
220 {
221         be_coalesce_spillslots(irg);
222
223         irg_block_walk_graph(irg, NULL, amd64_after_ra_walker, NULL);
224 }
225
226 /**
227  * Initializes the code generator.
228  */
229 static void amd64_init_graph(ir_graph *irg)
230 {
231         struct obstack   *obst     = be_get_be_obst(irg);
232         amd64_irg_data_t *irg_data = OALLOCZ(obst, amd64_irg_data_t);
233         irg_data->dump = (be_get_irg_options(irg)->dump_flags & DUMP_BE) ? 1 : 0;
234
235         be_birg_from_irg(irg)->isa_link = irg_data;
236 }
237
238
239 typedef ir_node *(*create_const_node_func) (dbg_info *dbg, ir_node *block);
240
241 /**
242  * Used to create per-graph unique pseudo nodes.
243  */
244 static inline ir_node *create_const(ir_graph *irg, ir_node **place,
245                                     create_const_node_func func,
246                                     const arch_register_t* reg)
247 {
248         ir_node *block, *res;
249
250         if (*place != NULL)
251                 return *place;
252
253         block = get_irg_start_block(irg);
254         res = func(NULL, block);
255         arch_set_irn_register(res, reg);
256         *place = res;
257
258         return res;
259 }
260
261 const arch_isa_if_t amd64_isa_if;
262 static amd64_isa_t amd64_isa_template = {
263         {
264                 &amd64_isa_if,             /* isa interface implementation */
265                 &amd64_gp_regs[REG_RSP],  /* stack pointer register */
266                 &amd64_gp_regs[REG_RBP],  /* base pointer register */
267                 &amd64_reg_classes[CLASS_amd64_gp],  /* link pointer register class */
268                 -1,                          /* stack direction */
269                 3,                           /* power of two stack alignment for calls, 2^2 == 4 */
270                 NULL,                        /* main environment */
271                 7,                           /* costs for a spill instruction */
272                 5,                           /* costs for a reload instruction */
273                 false,                       /* no custom abi handling */
274         },
275 };
276
277 /**
278  * Initializes the backend ISA
279  */
280 static arch_env_t *amd64_init(FILE *outfile)
281 {
282         static int run_once = 0;
283         amd64_isa_t *isa;
284
285         if(run_once)
286                 return NULL;
287         run_once = 1;
288
289         isa = XMALLOC(amd64_isa_t);
290         memcpy(isa, &amd64_isa_template, sizeof(*isa));
291
292         be_emit_init(outfile);
293
294         amd64_register_init();
295         amd64_create_opcodes(&amd64_irn_ops);
296
297         return &isa->base;
298 }
299
300
301
302 /**
303  * Closes the output file and frees the ISA structure.
304  */
305 static void amd64_done(void *self)
306 {
307         amd64_isa_t *isa = self;
308
309         /* emit now all global declarations */
310         be_gas_emit_decls(isa->base.main_env);
311
312         be_emit_exit();
313         free(self);
314 }
315
316
317 static unsigned amd64_get_n_reg_class(void)
318 {
319         return N_CLASSES;
320 }
321
322 static const arch_register_class_t *amd64_get_reg_class(unsigned i)
323 {
324         assert(i < N_CLASSES);
325         return &amd64_reg_classes[i];
326 }
327
328
329
330 /**
331  * Get the register class which shall be used to store a value of a given mode.
332  * @param self The this pointer.
333  * @param mode The mode in question.
334  * @return A register class which can hold values of the given mode.
335  */
336 static const arch_register_class_t *amd64_get_reg_class_for_mode(const ir_mode *mode)
337 {
338         assert(!mode_is_float(mode));
339         return &amd64_reg_classes[CLASS_amd64_gp];
340 }
341
342
343
344 typedef struct {
345         be_abi_call_flags_bits_t flags;
346         ir_graph *irg;
347 } amd64_abi_env_t;
348
349 static void *amd64_abi_init(const be_abi_call_t *call, ir_graph *irg)
350 {
351         amd64_abi_env_t *env = XMALLOC(amd64_abi_env_t);
352         be_abi_call_flags_t fl = be_abi_call_get_flags(call);
353         env->flags    = fl.bits;
354         env->irg      = irg;
355         return env;
356 }
357
358 /**
359  * Get the between type for that call.
360  * @param self The callback object.
361  * @return The between type of for that call.
362  */
363 static ir_type *amd64_get_between_type(void *self)
364 {
365         static ir_type *between_type = NULL;
366         static ir_entity *old_bp_ent = NULL;
367         (void) self;
368
369         if(!between_type) {
370                 ir_entity *ret_addr_ent;
371                 ir_type *ret_addr_type = new_type_primitive(mode_P);
372                 ir_type *old_bp_type   = new_type_primitive(mode_P);
373
374                 between_type           = new_type_class(new_id_from_str("amd64_between_type"));
375                 old_bp_ent             = new_entity(between_type, new_id_from_str("old_bp"), old_bp_type);
376                 ret_addr_ent           = new_entity(between_type, new_id_from_str("old_bp"), ret_addr_type);
377
378                 set_entity_offset(old_bp_ent, 0);
379                 set_entity_offset(ret_addr_ent, get_type_size_bytes(old_bp_type));
380                 set_type_size_bytes(between_type, get_type_size_bytes(old_bp_type) + get_type_size_bytes(ret_addr_type));
381         }
382
383         return between_type;
384 }
385
386 /**
387  * Build the prolog, return the BASE POINTER register
388  */
389 static const arch_register_t *amd64_abi_prologue(void *self, ir_node **mem,
390                                                     pmap *reg_map, int *stack_bias)
391 {
392         amd64_abi_env_t  *env  = self;
393         const arch_env_t *aenv = be_get_irg_arch_env(env->irg);
394         (void) mem;
395         (void) stack_bias;
396         (void) aenv;
397         (void) reg_map;
398
399         if (!env->flags.try_omit_fp) {
400                 /* FIXME: maybe later here should be some code to generate
401                  * the usual abi prologue */
402                 return aenv->bp;
403         }
404
405         return aenv->sp;
406 }
407
408 /* Build the epilog */
409 static void amd64_abi_epilogue(void *self, ir_node *bl, ir_node **mem,
410                                pmap *reg_map)
411 {
412         amd64_abi_env_t  *env  = self;
413         const arch_env_t *aenv = be_get_irg_arch_env(env->irg);
414         ir_node          *curr_sp  = be_abi_reg_map_get(reg_map, aenv->sp);
415         ir_node          *curr_bp  = be_abi_reg_map_get(reg_map, aenv->bp);
416         (void) bl;
417         (void) mem;
418
419         if (env->flags.try_omit_fp) {
420                 curr_sp = be_new_IncSP(aenv->sp, bl, curr_sp, BE_STACK_FRAME_SIZE_SHRINK, 0);
421         }
422
423         be_abi_reg_map_set(reg_map, aenv->sp, curr_sp);
424         be_abi_reg_map_set(reg_map, aenv->bp, curr_bp);
425 }
426
427 static const be_abi_callbacks_t amd64_abi_callbacks = {
428         amd64_abi_init,
429         free,
430         amd64_get_between_type,
431         amd64_abi_prologue,
432         amd64_abi_epilogue,
433 };
434
435 static const arch_register_t *gpreg_param_reg_std[] = {
436         &amd64_gp_regs[REG_RDI],
437         &amd64_gp_regs[REG_RSI],
438         &amd64_gp_regs[REG_RDX],
439         &amd64_gp_regs[REG_RCX],
440         &amd64_gp_regs[REG_R8],
441         &amd64_gp_regs[REG_R9],
442 };
443
444 static const arch_register_t *amd64_get_RegParam_reg(int n)
445 {
446         assert(n < 6 && n >=0 && "register param > 6 requested");
447         return gpreg_param_reg_std[n];
448 }
449
450 /**
451  * Get the ABI restrictions for procedure calls.
452  * @param self        The this pointer.
453  * @param method_type The type of the method (procedure) in question.
454  * @param abi         The abi object to be modified
455  */
456 static void amd64_get_call_abi(const void *self, ir_type *method_type,
457                            be_abi_call_t *abi)
458 {
459         ir_type  *tp;
460         ir_mode  *mode;
461         int       i, n = get_method_n_params(method_type);
462         be_abi_call_flags_t call_flags;
463         int no_reg = 0;
464
465         (void) self;
466
467         /* set abi flags for calls */
468         call_flags.bits.left_to_right         = 0;
469         call_flags.bits.store_args_sequential = 0;
470         call_flags.bits.try_omit_fp           = 1;
471         call_flags.bits.fp_free               = 0;
472         call_flags.bits.call_has_imm          = 1;
473
474         /* set stack parameter passing style */
475         be_abi_call_set_flags(abi, call_flags, &amd64_abi_callbacks);
476
477         for (i = 0; i < n; i++) {
478                 tp   = get_method_param_type(method_type, i);
479                 mode = get_type_mode(tp);
480                 //d// printf ("MODE %p %p XX %d\n", mode, mode_Iu, i);
481
482                 if (!no_reg && i < 6 && mode_is_data (mode)) {
483                         //d// printf("TEST%d\n", i);
484                         be_abi_call_param_reg(abi, i, amd64_get_RegParam_reg (i),
485                                               ABI_CONTEXT_BOTH);
486                 /* default: all parameters on stack */
487                 } else {
488                         no_reg = 1;
489                         be_abi_call_param_stack(abi, i, mode, 8, 0, 0, ABI_CONTEXT_BOTH);
490                 }
491         }
492
493         /* TODO: set correct return register */
494         /* default: return value is in R0 resp. F0 */
495         if (get_method_n_ress(method_type) > 0) {
496                 tp   = get_method_res_type(method_type, 0);
497                 mode = get_type_mode(tp);
498
499                 /* FIXME: No floating point yet */
500                 /* be_abi_call_res_reg(abi, 0,
501                         mode_is_float(mode) ? &amd64_fp_regs[REG_F0] : &amd64_gp_regs[REG_R0], ABI_CONTEXT_BOTH) */;
502
503                 be_abi_call_res_reg(abi, 0,
504                         &amd64_gp_regs[REG_RAX], ABI_CONTEXT_BOTH);
505         }
506 }
507
508 /**
509  * Returns the necessary byte alignment for storing a register of given class.
510  */
511 static int amd64_get_reg_class_alignment(const arch_register_class_t *cls)
512 {
513         ir_mode *mode = arch_register_class_mode(cls);
514         return get_mode_size_bytes(mode);
515 }
516
517 static void amd64_lower_for_target(void)
518 {
519 }
520
521 static int amd64_is_mux_allowed(ir_node *sel, ir_node *mux_false,
522                                 ir_node *mux_true)
523 {
524         (void) sel;
525         (void) mux_false;
526         (void) mux_true;
527         return false;
528 }
529
530 /**
531  * Returns the libFirm configuration parameter for this backend.
532  */
533 static const backend_params *amd64_get_backend_params(void) {
534         static backend_params p = {
535                 0,     /* no inline assembly */
536                 1,     /* support Rotl nodes */
537                 0,     /* little endian */
538                 amd64_lower_for_target,  /* lowering callback */
539                 NULL,  /* will be set later */
540                 amd64_is_mux_allowed,  /* parameter for if conversion */
541                 NULL,  /* float arithmetic mode */
542                 0,     /* no trampoline support: size 0 */
543                 0,     /* no trampoline support: align 0 */
544                 NULL,  /* no trampoline support: no trampoline builder */
545                 8      /* alignment of stack parameter: typically 4 (32bit) or 8 (64bit) */
546         };
547         return &p;
548 }
549
550 static ir_graph **amd64_get_backend_irg_list(const void *self,
551                                                 ir_graph ***irgs)
552 {
553         (void) self;
554         (void) irgs;
555         return NULL;
556 }
557
558 static asm_constraint_flags_t amd64_parse_asm_constraint(const char **c)
559 {
560         (void) c;
561         return ASM_CONSTRAINT_FLAG_INVALID;
562 }
563
564 static int amd64_is_valid_clobber(const char *clobber)
565 {
566         (void) clobber;
567         return 0;
568 }
569
570 const arch_isa_if_t amd64_isa_if = {
571         amd64_init,
572         amd64_done,
573         NULL,                /* handle intrinsics */
574         amd64_get_n_reg_class,
575         amd64_get_reg_class,
576         amd64_get_reg_class_for_mode,
577         amd64_get_call_abi,
578         amd64_get_reg_class_alignment,
579     amd64_get_backend_params,
580         amd64_get_backend_irg_list,
581         NULL,                    /* mark remat */
582         amd64_parse_asm_constraint,
583         amd64_is_valid_clobber,
584
585         amd64_init_graph,
586         NULL,              /* get_pic_base */
587         NULL,              /* before_abi */
588         amd64_prepare_graph,
589         amd64_before_ra,
590         amd64_after_ra,
591         amd64_finish_irg,
592         amd64_gen_routine,
593 };
594
595 BE_REGISTER_MODULE_CONSTRUCTOR(be_init_arch_amd64);
596 void be_init_arch_amd64(void)
597 {
598         be_register_isa_if("amd64", &amd64_isa_if);
599         FIRM_DBG_REGISTER(dbg, "firm.be.amd64.cg");
600         amd64_init_transform();
601 }