cleanup and rewrite dumper interface
[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 "pseudo_irg.h"
28 #include "irgwalk.h"
29 #include "irprog.h"
30 #include "irprintf.h"
31 #include "ircons.h"
32 #include "irgmod.h"
33 #include "irdump.h"
34
35 #include "bitset.h"
36 #include "debug.h"
37
38 #include "be.h"
39 #include "../bearch.h"
40 #include "../benode.h"
41 #include "../belower.h"
42 #include "../besched.h"
43 #include "../beabi.h"
44 #include "../bemodule.h"
45 #include "../begnuas.h"
46 #include "../belistsched.h"
47
48 #include "bearch_amd64_t.h"
49
50 #include "amd64_new_nodes.h"
51 #include "gen_amd64_regalloc_if.h"
52 #include "amd64_transform.h"
53 #include "amd64_emitter.h"
54
55 DEBUG_ONLY(static firm_dbg_module_t *dbg = NULL;)
56
57 static arch_irn_class_t amd64_classify(const ir_node *irn)
58 {
59         (void) irn;
60         return 0;
61 }
62
63 static ir_entity *amd64_get_frame_entity(const ir_node *node)
64 {
65         (void) node;
66         /* TODO: return the ir_entity assigned to the frame */
67         return NULL;
68 }
69
70 static void amd64_set_frame_entity(ir_node *node, ir_entity *ent)
71 {
72         (void) node;
73         (void) ent;
74         /* TODO: set the ir_entity assigned to the frame */
75 }
76
77 /**
78  * This function is called by the generic backend to correct offsets for
79  * nodes accessing the stack.
80  */
81 static void amd64_set_frame_offset(ir_node *irn, int offset)
82 {
83         (void) irn;
84         (void) offset;
85         /* TODO: correct offset if irn accesses the stack */
86 }
87
88 static int amd64_get_sp_bias(const ir_node *irn)
89 {
90         (void) irn;
91         return 0;
92 }
93
94 /* fill register allocator interface */
95
96 static const arch_irn_ops_t amd64_irn_ops = {
97         get_amd64_in_req,
98         amd64_classify,
99         amd64_get_frame_entity,
100         amd64_set_frame_entity,
101         amd64_set_frame_offset,
102         amd64_get_sp_bias,
103         NULL,    /* get_inverse             */
104         NULL,    /* get_op_estimated_cost   */
105         NULL,    /* possible_memory_operand */
106         NULL,    /* perform_memory_operand  */
107 };
108
109
110
111 /**
112  * Transforms the standard firm graph into
113  * a amd64 firm graph
114  */
115 static void amd64_prepare_graph(void *self)
116 {
117         amd64_code_gen_t *cg = self;
118
119         amd64_transform_graph (cg);
120
121         if (cg->dump)
122                 dump_ir_graph(cg->irg, "transformed");
123 }
124
125
126
127 /**
128  * Called immediatly before emit phase.
129  */
130 static void amd64_finish_irg(void *self)
131 {
132         amd64_code_gen_t *cg = self;
133         ir_graph         *irg = cg->irg;
134
135         dump_ir_graph(irg, "amd64-finished");
136 }
137
138
139 static void amd64_before_ra(void *self)
140 {
141         (void) self;
142         /* Some stuff you need to do after scheduling but before register allocation */
143 }
144
145 static void amd64_after_ra(void *self)
146 {
147         (void) self;
148         /* Some stuff you need to do immediatly after register allocation */
149 }
150
151
152
153 /**
154  * Emits the code, closes the output file and frees
155  * the code generator interface.
156  */
157 static void amd64_emit_and_done(void *self)
158 {
159         amd64_code_gen_t *cg  = self;
160         ir_graph         *irg = cg->irg;
161
162         amd64_gen_routine(cg, irg);
163
164         /* de-allocate code generator */
165         free(cg);
166 }
167
168 static void *amd64_cg_init(be_irg_t *birg);
169
170 static const arch_code_generator_if_t amd64_code_gen_if = {
171         amd64_cg_init,
172         NULL,                    /* get_pic_base hook */
173         NULL,                    /* before abi introduce hook */
174         amd64_prepare_graph,
175         NULL,                    /* spill hook */
176         amd64_before_ra,      /* before register allocation hook */
177         amd64_after_ra,       /* after register allocation hook */
178         amd64_finish_irg,
179         amd64_emit_and_done
180 };
181
182 /**
183  * Initializes the code generator.
184  */
185 static void *amd64_cg_init(be_irg_t *birg)
186 {
187         const arch_env_t    *arch_env = be_get_birg_arch_env(birg);
188         amd64_isa_t      *isa      = (amd64_isa_t *) arch_env;
189         amd64_code_gen_t *cg       = XMALLOC(amd64_code_gen_t);
190
191         cg->impl     = &amd64_code_gen_if;
192         cg->irg      = be_get_birg_irg(birg);
193         cg->isa      = isa;
194         cg->birg     = birg;
195         cg->dump     = (birg->main_env->options->dump_flags & DUMP_BE) ? 1 : 0;
196
197         return (arch_code_generator_t *)cg;
198 }
199
200
201
202 const arch_isa_if_t amd64_isa_if;
203 static amd64_isa_t amd64_isa_template = {
204         {
205                 &amd64_isa_if,             /* isa interface implementation */
206                 &amd64_gp_regs[REG_RSP],  /* stack pointer register */
207                 &amd64_gp_regs[REG_RBP],  /* base pointer register */
208                 &amd64_reg_classes[CLASS_amd64_gp],  /* link pointer register class */
209                 -1,                          /* stack direction */
210                 2,                           /* power of two stack alignment for calls, 2^2 == 4 */
211                 NULL,                        /* main environment */
212                 7,                           /* costs for a spill instruction */
213                 5,                           /* costs for a reload instruction */
214         },
215 };
216
217 /**
218  * Initializes the backend ISA
219  */
220 static arch_env_t *amd64_init(FILE *outfile)
221 {
222         static int run_once = 0;
223         amd64_isa_t *isa;
224
225         if(run_once)
226                 return NULL;
227         run_once = 1;
228
229         isa = XMALLOC(amd64_isa_t);
230         memcpy(isa, &amd64_isa_template, sizeof(*isa));
231
232         be_emit_init(outfile);
233
234         amd64_register_init();
235         amd64_create_opcodes(&amd64_irn_ops);
236
237         return &isa->arch_env;
238 }
239
240
241
242 /**
243  * Closes the output file and frees the ISA structure.
244  */
245 static void amd64_done(void *self)
246 {
247         amd64_isa_t *isa = self;
248
249         /* emit now all global declarations */
250         be_gas_emit_decls(isa->arch_env.main_env);
251
252         be_emit_exit();
253         free(self);
254 }
255
256
257 static unsigned amd64_get_n_reg_class(void)
258 {
259         return N_CLASSES;
260 }
261
262 static const arch_register_class_t *amd64_get_reg_class(unsigned i)
263 {
264         assert(i < N_CLASSES);
265         return &amd64_reg_classes[i];
266 }
267
268
269
270 /**
271  * Get the register class which shall be used to store a value of a given mode.
272  * @param self The this pointer.
273  * @param mode The mode in question.
274  * @return A register class which can hold values of the given mode.
275  */
276 static const arch_register_class_t *amd64_get_reg_class_for_mode(const ir_mode *mode)
277 {
278         if (mode_is_float(mode))
279                 return &amd64_reg_classes[CLASS_amd64_fp];
280         else
281                 return &amd64_reg_classes[CLASS_amd64_gp];
282 }
283
284
285
286 typedef struct {
287         be_abi_call_flags_bits_t flags;
288         const arch_env_t *arch_env;
289         ir_graph *irg;
290 } amd64_abi_env_t;
291
292 static void *amd64_abi_init(const be_abi_call_t *call, const arch_env_t *arch_env, ir_graph *irg)
293 {
294         amd64_abi_env_t *env = XMALLOC(amd64_abi_env_t);
295         be_abi_call_flags_t fl = be_abi_call_get_flags(call);
296         env->flags    = fl.bits;
297         env->irg      = irg;
298         env->arch_env = arch_env;
299         return env;
300 }
301
302 /**
303  * Get the between type for that call.
304  * @param self The callback object.
305  * @return The between type of for that call.
306  */
307 static ir_type *amd64_get_between_type(void *self)
308 {
309         static ir_type *between_type = NULL;
310         static ir_entity *old_bp_ent = NULL;
311         (void) self;
312
313         if(!between_type) {
314                 ir_entity *ret_addr_ent;
315                 ir_type *ret_addr_type = new_type_primitive(mode_P);
316                 ir_type *old_bp_type   = new_type_primitive(mode_P);
317
318                 between_type           = new_type_class(new_id_from_str("amd64_between_type"));
319                 old_bp_ent             = new_entity(between_type, new_id_from_str("old_bp"), old_bp_type);
320                 ret_addr_ent           = new_entity(between_type, new_id_from_str("old_bp"), ret_addr_type);
321
322                 set_entity_offset(old_bp_ent, 0);
323                 set_entity_offset(ret_addr_ent, get_type_size_bytes(old_bp_type));
324                 set_type_size_bytes(between_type, get_type_size_bytes(old_bp_type) + get_type_size_bytes(ret_addr_type));
325         }
326
327         return between_type;
328 }
329
330 /**
331  * Build the prolog, return the BASE POINTER register
332  */
333 static const arch_register_t *amd64_abi_prologue(void *self, ir_node **mem,
334                                                     pmap *reg_map, int *stack_bias)
335 {
336         amd64_abi_env_t  *env  = self;
337         const arch_env_t *aenv = env->arch_env;
338         (void) mem;
339         (void) stack_bias;
340         (void) aenv;
341         (void) reg_map;
342
343         if (!env->flags.try_omit_fp) {
344                 /* FIXME: maybe later here should be some code to generate
345                  * the usual abi prologue */
346                 return env->arch_env->bp;
347         }
348
349         return env->arch_env->sp;
350 }
351
352 /* Build the epilog */
353 static void amd64_abi_epilogue(void *self, ir_node *bl, ir_node **mem,
354                                pmap *reg_map)
355 {
356         amd64_abi_env_t  *env  = self;
357         const arch_env_t *aenv = env->arch_env;
358         ir_node          *curr_sp  = be_abi_reg_map_get(reg_map, aenv->sp);
359         ir_node          *curr_bp  = be_abi_reg_map_get(reg_map, aenv->bp);
360         (void) bl;
361         (void) mem;
362
363         if (env->flags.try_omit_fp) {
364                 curr_sp = be_new_IncSP(aenv->sp, bl, curr_sp, BE_STACK_FRAME_SIZE_SHRINK, 0);
365         }
366
367         be_abi_reg_map_set(reg_map, aenv->sp, curr_sp);
368         be_abi_reg_map_set(reg_map, aenv->bp, curr_bp);
369 }
370
371 static const be_abi_callbacks_t amd64_abi_callbacks = {
372         amd64_abi_init,
373         free,
374         amd64_get_between_type,
375         amd64_abi_prologue,
376         amd64_abi_epilogue,
377 };
378
379 /**
380  * Get the ABI restrictions for procedure calls.
381  * @param self        The this pointer.
382  * @param method_type The type of the method (procedure) in question.
383  * @param abi         The abi object to be modified
384  */
385 static void amd64_get_call_abi(const void *self, ir_type *method_type,
386                            be_abi_call_t *abi)
387 {
388         ir_type  *tp;
389         ir_mode  *mode;
390         int       i, n = get_method_n_params(method_type);
391         be_abi_call_flags_t call_flags;
392         int no_reg = 0;
393
394         (void) self;
395
396         /* set abi flags for calls */
397         call_flags.bits.left_to_right         = 0;
398         call_flags.bits.store_args_sequential = 1;
399         call_flags.bits.try_omit_fp           = 1;
400         call_flags.bits.fp_free               = 0;
401         call_flags.bits.call_has_imm          = 1;
402
403         /* set stack parameter passing style */
404         be_abi_call_set_flags(abi, call_flags, &amd64_abi_callbacks);
405
406         for (i = 0; i < n; i++) {
407                 tp   = get_method_param_type(method_type, i);
408                 mode = get_type_mode(tp);
409                 printf ("MODE %p %p XX %d\n", mode, mode_Iu, i);
410
411                 if (!no_reg && (i == 0 || i == 1) && mode == mode_Iu) {
412                         printf("TEST%d\n", i);
413                         be_abi_call_param_reg(abi, i,
414                                               i == 0 ? &amd64_gp_regs[REG_RDI]
415                                                      : &amd64_gp_regs[REG_RSI],
416                                               ABI_CONTEXT_BOTH);
417                 /* default: all parameters on stack */
418                 } else {
419                         no_reg = 1;
420                         be_abi_call_param_stack(abi, i, mode, 4, 0, 0, ABI_CONTEXT_BOTH);
421                 }
422         }
423
424         /* TODO: set correct return register */
425         /* default: return value is in R0 resp. F0 */
426         if (get_method_n_ress(method_type) > 0) {
427                 tp   = get_method_res_type(method_type, 0);
428                 mode = get_type_mode(tp);
429
430                 /* FIXME: No floating point yet */
431                 /* be_abi_call_res_reg(abi, 0,
432                         mode_is_float(mode) ? &amd64_fp_regs[REG_F0] : &amd64_gp_regs[REG_R0], ABI_CONTEXT_BOTH) */;
433
434                 be_abi_call_res_reg(abi, 0,
435                         &amd64_gp_regs[REG_RAX], ABI_CONTEXT_BOTH);
436         }
437 }
438
439 static int amd64_to_appear_in_schedule(void *block_env, const ir_node *irn)
440 {
441         (void) block_env;
442
443         if(!is_amd64_irn(irn))
444                 return -1;
445
446         return 1;
447 }
448
449 /**
450  * Initializes the code generator interface.
451  */
452 static const arch_code_generator_if_t *amd64_get_code_generator_if(
453                 void *self)
454 {
455         (void) self;
456         return &amd64_code_gen_if;
457 }
458
459 list_sched_selector_t amd64_sched_selector;
460
461 /**
462  * Returns the reg_pressure scheduler with to_appear_in_schedule() overloaded
463  */
464 static const list_sched_selector_t *amd64_get_list_sched_selector(
465                 const void *self, list_sched_selector_t *selector)
466 {
467         (void) self;
468         (void) selector;
469
470         amd64_sched_selector = trivial_selector;
471         amd64_sched_selector.to_appear_in_schedule = amd64_to_appear_in_schedule;
472         return &amd64_sched_selector;
473 }
474
475 static const ilp_sched_selector_t *amd64_get_ilp_sched_selector(
476                 const void *self)
477 {
478         (void) self;
479         return NULL;
480 }
481
482 /**
483  * Returns the necessary byte alignment for storing a register of given class.
484  */
485 static int amd64_get_reg_class_alignment(const arch_register_class_t *cls)
486 {
487         ir_mode *mode = arch_register_class_mode(cls);
488         return get_mode_size_bytes(mode);
489 }
490
491 /**
492  * Returns the libFirm configuration parameter for this backend.
493  */
494 static const backend_params *amd64_get_backend_params(void) {
495         static backend_params p = {
496                 0,     /* no dword lowering */
497                 0,     /* no inline assembly */
498                 NULL,  /* will be set later */
499                 NULL,  /* no creator function */
500                 NULL,  /* context for create_intrinsic_fkt */
501                 NULL,  /* parameter for if conversion */
502                 NULL,  /* float arithmetic mode */
503                 0,     /* no trampoline support: size 0 */
504                 0,     /* no trampoline support: align 0 */
505                 NULL,  /* no trampoline support: no trampoline builder */
506                 4      /* alignment of stack parameter: typically 4 (32bit) or 8 (64bit) */
507         };
508         return &p;
509 }
510
511 static const be_execution_unit_t ***amd64_get_allowed_execution_units(
512                 const ir_node *irn)
513 {
514         (void) irn;
515         /* TODO */
516         assert(0);
517         return NULL;
518 }
519
520 static const be_machine_t *amd64_get_machine(const void *self)
521 {
522         (void) self;
523         /* TODO */
524         assert(0);
525         return NULL;
526 }
527
528 static ir_graph **amd64_get_backend_irg_list(const void *self,
529                                                 ir_graph ***irgs)
530 {
531         (void) self;
532         (void) irgs;
533         return NULL;
534 }
535
536 static asm_constraint_flags_t amd64_parse_asm_constraint(const char **c)
537 {
538         (void) c;
539         return ASM_CONSTRAINT_FLAG_INVALID;
540 }
541
542 static int amd64_is_valid_clobber(const char *clobber)
543 {
544         (void) clobber;
545         return 0;
546 }
547
548 const arch_isa_if_t amd64_isa_if = {
549         amd64_init,
550         amd64_done,
551         NULL,                /* handle intrinsics */
552         amd64_get_n_reg_class,
553         amd64_get_reg_class,
554         amd64_get_reg_class_for_mode,
555         amd64_get_call_abi,
556         amd64_get_code_generator_if,
557         amd64_get_list_sched_selector,
558         amd64_get_ilp_sched_selector,
559         amd64_get_reg_class_alignment,
560     amd64_get_backend_params,
561         amd64_get_allowed_execution_units,
562         amd64_get_machine,
563         amd64_get_backend_irg_list,
564         NULL,                    /* mark remat */
565         amd64_parse_asm_constraint,
566         amd64_is_valid_clobber
567 };
568
569 BE_REGISTER_MODULE_CONSTRUCTOR(be_init_arch_amd64);
570 void be_init_arch_amd64(void)
571 {
572         be_register_isa_if("amd64", &amd64_isa_if);
573         FIRM_DBG_REGISTER(dbg, "firm.be.amd64.cg");
574         amd64_init_transform();
575 }