sparc: attempt to fix stack alignment/address for omit-fp again
[libfirm] / ir / be / sparc / bearch_sparc.c
1 /*
2  * Copyright (C) 1995-2010 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 sparc backend driver file.
23  * @author   Hannes Rapp, Matthias Braun
24  * @version  $Id$
25  */
26 #include "config.h"
27
28 #include "lc_opts.h"
29 #include "lc_opts_enum.h"
30
31 #include "irgwalk.h"
32 #include "irprog.h"
33 #include "irprintf.h"
34 #include "ircons.h"
35 #include "irgmod.h"
36 #include "irgopt.h"
37 #include "iroptimize.h"
38 #include "irtools.h"
39 #include "irdump.h"
40 #include "iropt_t.h"
41 #include "lowering.h"
42 #include "lower_dw.h"
43 #include "lower_alloc.h"
44 #include "lower_builtins.h"
45 #include "lower_calls.h"
46 #include "lower_mode_b.h"
47 #include "lower_softfloat.h"
48
49 #include "bitset.h"
50 #include "debug.h"
51 #include "array_t.h"
52 #include "error.h"
53 #include "util.h"
54
55 #include "bearch.h"
56 #include "benode.h"
57 #include "belower.h"
58 #include "besched.h"
59 #include "be.h"
60 #include "bemachine.h"
61 #include "bemodule.h"
62 #include "beirg.h"
63 #include "begnuas.h"
64 #include "belistsched.h"
65 #include "beflags.h"
66 #include "beutil.h"
67
68 #include "bearch_sparc_t.h"
69
70 #include "sparc_new_nodes.h"
71 #include "gen_sparc_regalloc_if.h"
72 #include "sparc_transform.h"
73 #include "sparc_emitter.h"
74 #include "sparc_cconv.h"
75
76 DEBUG_ONLY(static firm_dbg_module_t *dbg = NULL;)
77
78 static arch_irn_class_t sparc_classify(const ir_node *node)
79 {
80         (void) node;
81         return arch_irn_class_none;
82 }
83
84 static ir_entity *sparc_get_frame_entity(const ir_node *node)
85 {
86         if (is_sparc_FrameAddr(node)) {
87                 const sparc_attr_t *attr = get_sparc_attr_const(node);
88                 return attr->immediate_value_entity;
89         }
90
91         if (sparc_has_load_store_attr(node)) {
92                 const sparc_load_store_attr_t *load_store_attr
93                         = get_sparc_load_store_attr_const(node);
94                 if (load_store_attr->is_frame_entity) {
95                         return load_store_attr->base.immediate_value_entity;
96                 }
97         }
98
99         return NULL;
100 }
101
102 /**
103  * This function is called by the generic backend to correct offsets for
104  * nodes accessing the stack.
105  */
106 static void sparc_set_frame_offset(ir_node *node, int offset)
107 {
108         sparc_attr_t *attr = get_sparc_attr(node);
109         attr->immediate_value += offset;
110
111         /* must be a FrameAddr or a load/store node with frame_entity */
112         assert(is_sparc_FrameAddr(node) ||
113                         get_sparc_load_store_attr_const(node)->is_frame_entity);
114 }
115
116 static int sparc_get_sp_bias(const ir_node *node)
117 {
118         if (is_sparc_Save(node)) {
119                 const sparc_attr_t *attr = get_sparc_attr_const(node);
120                 if (get_irn_arity(node) == 3)
121                         panic("no support for _reg variant yet");
122
123                 return -attr->immediate_value;
124         } else if (is_sparc_RestoreZero(node)) {
125                 return SP_BIAS_RESET;
126         }
127         return 0;
128 }
129
130 /* fill register allocator interface */
131
132 const arch_irn_ops_t sparc_irn_ops = {
133         sparc_classify,
134         sparc_get_frame_entity,
135         sparc_set_frame_offset,
136         sparc_get_sp_bias,
137         NULL,    /* get_inverse             */
138         NULL,    /* get_op_estimated_cost   */
139         NULL,    /* possible_memory_operand */
140         NULL,    /* perform_memory_operand  */
141 };
142
143 /**
144  * Transforms the standard firm graph into
145  * a SPARC firm graph
146  */
147 static void sparc_prepare_graph(ir_graph *irg)
148 {
149         sparc_transform_graph(irg);
150 }
151
152 static bool sparc_modifies_flags(const ir_node *node)
153 {
154         return arch_get_irn_flags(node) & sparc_arch_irn_flag_modifies_flags;
155 }
156
157 static bool sparc_modifies_fp_flags(const ir_node *node)
158 {
159         return arch_get_irn_flags(node) & sparc_arch_irn_flag_modifies_fp_flags;
160 }
161
162 static void sparc_before_ra(ir_graph *irg)
163 {
164         /* fixup flags register */
165         be_sched_fix_flags(irg, &sparc_reg_classes[CLASS_sparc_flags_class],
166                            NULL, sparc_modifies_flags);
167         be_sched_fix_flags(irg, &sparc_reg_classes[CLASS_sparc_fpflags_class],
168                            NULL, sparc_modifies_fp_flags);
169 }
170
171 static void sparc_init_graph(ir_graph *irg)
172 {
173         (void) irg;
174 }
175
176 extern const arch_isa_if_t sparc_isa_if;
177 static sparc_isa_t sparc_isa_template = {
178         {
179                 &sparc_isa_if,                      /* isa interface implementation */
180                 N_SPARC_REGISTERS,
181                 sparc_registers,
182                 N_SPARC_CLASSES,
183                 sparc_reg_classes,
184                 &sparc_registers[REG_SP],           /* stack pointer register */
185                 &sparc_registers[REG_FRAME_POINTER],/* base pointer register */
186                 &sparc_reg_classes[CLASS_sparc_gp], /* link pointer register class */
187                 3,                                  /* power of two stack alignment
188                                                        for calls */
189                 NULL,                               /* main environment */
190                 7,                                  /* costs for a spill instruction */
191                 5,                                  /* costs for a reload instruction */
192                 true,                               /* custom abi handling */
193         },
194         NULL,               /* constants */
195         SPARC_FPU_ARCH_FPU, /* FPU architecture */
196 };
197
198 /**
199  * rewrite unsigned->float conversion.
200  * Sparc has no instruction for this so instead we do the following:
201  *
202  *   int    signed_x = unsigned_value_x;
203  *   double res      = signed_x;
204  *   if (signed_x < 0)
205  *       res += 4294967296. ;
206  *   return (float) res;
207  */
208 static void rewrite_unsigned_float_Conv(ir_node *node)
209 {
210         ir_graph *irg         = get_irn_irg(node);
211         dbg_info *dbgi        = get_irn_dbg_info(node);
212         ir_node  *lower_block = get_nodes_block(node);
213
214         part_block(node);
215
216         {
217                 ir_node   *block       = get_nodes_block(node);
218                 ir_node   *unsigned_x  = get_Conv_op(node);
219                 ir_mode   *mode_u      = get_irn_mode(unsigned_x);
220                 ir_mode   *mode_s      = find_signed_mode(mode_u);
221                 ir_mode   *mode_d      = mode_D;
222                 ir_node   *signed_x    = new_rd_Conv(dbgi, block, unsigned_x, mode_s);
223                 ir_node   *res         = new_rd_Conv(dbgi, block, signed_x, mode_d);
224                 ir_node   *zero        = new_r_Const(irg, get_mode_null(mode_s));
225                 ir_node   *cmp         = new_rd_Cmp(dbgi, block, signed_x, zero,
226                                                     ir_relation_less);
227                 ir_node   *cond        = new_rd_Cond(dbgi, block, cmp);
228                 ir_node   *proj_true   = new_r_Proj(cond, mode_X, pn_Cond_true);
229                 ir_node   *proj_false  = new_r_Proj(cond, mode_X, pn_Cond_false);
230                 ir_node   *in_true[1]  = { proj_true };
231                 ir_node   *in_false[1] = { proj_false };
232                 ir_node   *true_block  = new_r_Block(irg, ARRAY_SIZE(in_true), in_true);
233                 ir_node   *false_block = new_r_Block(irg, ARRAY_SIZE(in_false),in_false);
234                 ir_node   *true_jmp    = new_r_Jmp(true_block);
235                 ir_node   *false_jmp   = new_r_Jmp(false_block);
236                 ir_tarval *correction  = new_tarval_from_double(4294967296., mode_d);
237                 ir_node   *c_const     = new_r_Const(irg, correction);
238                 ir_node   *fadd        = new_rd_Add(dbgi, true_block, res, c_const,
239                                                    mode_d);
240
241                 ir_node  *lower_in[2] = { true_jmp, false_jmp };
242                 ir_node  *phi_in[2]   = { fadd, res };
243                 ir_mode  *dest_mode   = get_irn_mode(node);
244                 ir_node  *phi;
245                 ir_node  *res_conv;
246
247                 set_irn_in(lower_block, ARRAY_SIZE(lower_in), lower_in);
248                 phi = new_r_Phi(lower_block, ARRAY_SIZE(phi_in), phi_in, mode_d);
249                 assert(get_Block_phis(lower_block) == NULL);
250                 set_Block_phis(lower_block, phi);
251                 set_Phi_next(phi, NULL);
252
253                 res_conv = new_rd_Conv(dbgi, lower_block, phi, dest_mode);
254
255                 exchange(node, res_conv);
256         }
257 }
258
259 static int sparc_rewrite_Conv(ir_node *node, void *ctx)
260 {
261         ir_mode *to_mode   = get_irn_mode(node);
262         ir_node *op        = get_Conv_op(node);
263         ir_mode *from_mode = get_irn_mode(op);
264         (void) ctx;
265
266         if (mode_is_float(to_mode) && mode_is_int(from_mode)
267                         && get_mode_size_bits(from_mode) == 32
268                         && !mode_is_signed(from_mode)) {
269                 rewrite_unsigned_float_Conv(node);
270                 return 1;
271         }
272
273         return 0;
274 }
275
276 static void sparc_handle_intrinsics(void)
277 {
278         ir_type *tp, *int_tp, *uint_tp;
279         i_record records[8];
280         size_t n_records = 0;
281
282         runtime_rt rt_iMod, rt_uMod;
283
284 #define ID(x) new_id_from_chars(x, sizeof(x)-1)
285
286         int_tp  = new_type_primitive(mode_Is);
287         uint_tp = new_type_primitive(mode_Iu);
288
289         /* we need to rewrite some forms of int->float conversions */
290         {
291                 i_instr_record *map_Conv = &records[n_records++].i_instr;
292
293                 map_Conv->kind     = INTRINSIC_INSTR;
294                 map_Conv->op       = op_Conv;
295                 map_Conv->i_mapper = sparc_rewrite_Conv;
296         }
297         /* SPARC has no signed mod instruction ... */
298         {
299                 i_instr_record *map_Mod = &records[n_records++].i_instr;
300
301                 tp = new_type_method(2, 1);
302                 set_method_param_type(tp, 0, int_tp);
303                 set_method_param_type(tp, 1, int_tp);
304                 set_method_res_type(tp, 0, int_tp);
305
306                 rt_iMod.ent             = new_entity(get_glob_type(), ID(".rem"), tp);
307                 set_entity_ld_ident(rt_iMod.ent, ID(".rem"));
308                 rt_iMod.mode            = mode_T;
309                 rt_iMod.res_mode        = mode_Is;
310                 rt_iMod.mem_proj_nr     = pn_Mod_M;
311                 rt_iMod.regular_proj_nr = pn_Mod_X_regular;
312                 rt_iMod.exc_proj_nr     = pn_Mod_X_except;
313                 rt_iMod.res_proj_nr     = pn_Mod_res;
314
315                 set_entity_visibility(rt_iMod.ent, ir_visibility_external);
316
317                 map_Mod->kind     = INTRINSIC_INSTR;
318                 map_Mod->op       = op_Mod;
319                 map_Mod->i_mapper = (i_mapper_func)i_mapper_RuntimeCall;
320                 map_Mod->ctx      = &rt_iMod;
321         }
322         /* ... nor an unsigned mod. */
323         {
324                 i_instr_record *map_Mod = &records[n_records++].i_instr;
325
326                 tp = new_type_method(2, 1);
327                 set_method_param_type(tp, 0, uint_tp);
328                 set_method_param_type(tp, 1, uint_tp);
329                 set_method_res_type(tp, 0, uint_tp);
330
331                 rt_uMod.ent             = new_entity(get_glob_type(), ID(".urem"), tp);
332                 set_entity_ld_ident(rt_uMod.ent, ID(".urem"));
333                 rt_uMod.mode            = mode_T;
334                 rt_uMod.res_mode        = mode_Iu;
335                 rt_uMod.mem_proj_nr     = pn_Mod_M;
336                 rt_uMod.regular_proj_nr = pn_Mod_X_regular;
337                 rt_uMod.exc_proj_nr     = pn_Mod_X_except;
338                 rt_uMod.res_proj_nr     = pn_Mod_res;
339
340                 set_entity_visibility(rt_uMod.ent, ir_visibility_external);
341
342                 map_Mod->kind     = INTRINSIC_INSTR;
343                 map_Mod->op       = op_Mod;
344                 map_Mod->i_mapper = (i_mapper_func)i_mapper_RuntimeCall;
345                 map_Mod->ctx      = &rt_uMod;
346         }
347
348         assert(n_records < ARRAY_SIZE(records));
349         lower_intrinsics(records, n_records, /*part_block_used=*/ true);
350 }
351
352 /**
353  * Initializes the backend ISA
354  */
355 static arch_env_t *sparc_init(FILE *outfile)
356 {
357         sparc_isa_t *isa = XMALLOC(sparc_isa_t);
358         *isa = sparc_isa_template;
359         isa->constants = pmap_create();
360
361         be_gas_elf_type_char      = '#';
362         be_gas_object_file_format = OBJECT_FILE_FORMAT_ELF;
363         be_gas_elf_variant        = ELF_VARIANT_SPARC;
364
365         be_emit_init(outfile);
366
367         sparc_register_init();
368         sparc_create_opcodes(&sparc_irn_ops);
369         sparc_handle_intrinsics();
370         sparc_cconv_init();
371
372         return &isa->base;
373 }
374
375 /**
376  * Closes the output file and frees the ISA structure.
377  */
378 static void sparc_done(void *self)
379 {
380         sparc_isa_t *isa = (sparc_isa_t*)self;
381
382         /* emit now all global declarations */
383         be_gas_emit_decls(isa->base.main_env);
384
385         pmap_destroy(isa->constants);
386         be_emit_exit();
387         free(isa);
388 }
389
390
391 /**
392  * Get the register class which shall be used to store a value of a given mode.
393  * @param self The this pointer.
394  * @param mode The mode in question.
395  * @return A register class which can hold values of the given mode.
396  */
397 static const arch_register_class_t *sparc_get_reg_class_for_mode(const ir_mode *mode)
398 {
399         if (mode_is_float(mode))
400                 return &sparc_reg_classes[CLASS_sparc_fp];
401         else
402                 return &sparc_reg_classes[CLASS_sparc_gp];
403 }
404
405 /**
406  * Returns the necessary byte alignment for storing a register of given class.
407  */
408 static int sparc_get_reg_class_alignment(const arch_register_class_t *cls)
409 {
410         ir_mode *mode = arch_register_class_mode(cls);
411         return get_mode_size_bytes(mode);
412 }
413
414 static ir_node *sparc_create_set(ir_node *cond)
415 {
416         return ir_create_cond_set(cond, mode_Iu);
417 }
418
419 static void sparc_lower_for_target(void)
420 {
421         size_t i, n_irgs = get_irp_n_irgs();
422         lower_mode_b_config_t lower_mode_b_config = {
423                 mode_Iu,
424                 sparc_create_set,
425         };
426
427         lower_calls_with_compounds(LF_RETURN_HIDDEN);
428
429         if (sparc_isa_template.fpu_arch == SPARC_FPU_ARCH_SOFTFLOAT)
430                 lower_floating_point();
431
432         lower_builtins(0, NULL);
433
434         sparc_lower_64bit();
435
436         for (i = 0; i < n_irgs; ++i) {
437                 ir_graph *irg = get_irp_irg(i);
438                 ir_lower_mode_b(irg, &lower_mode_b_config);
439                 lower_switch(irg, 4, 256, false);
440                 lower_alloc(irg, SPARC_STACK_ALIGNMENT, false, -SPARC_MIN_STACKSIZE);
441         }
442
443         for (i = 0; i < n_irgs; ++i) {
444                 ir_graph *irg = get_irp_irg(i);
445                 /* Turn all small CopyBs into loads/stores and all bigger CopyBs into
446                  * memcpy calls. */
447                 lower_CopyB(irg, 31, 32, false);
448         }
449 }
450
451 static int sparc_is_mux_allowed(ir_node *sel, ir_node *mux_false,
452                                 ir_node *mux_true)
453 {
454         return ir_is_optimizable_mux(sel, mux_false, mux_true);
455 }
456
457 /**
458  * Returns the libFirm configuration parameter for this backend.
459  */
460 static const backend_params *sparc_get_backend_params(void)
461 {
462         static const ir_settings_arch_dep_t arch_dep = {
463                 1,     /* also_use_subs */
464                 1,     /* maximum_shifts */
465                 31,    /* highest_shift_amount */
466                 NULL,  /* evaluate_cost_func */
467                 1,     /* allow mulhs */
468                 1,     /* allow mulhu */
469                 32,    /* max_bits_for_mulh */
470         };
471         static backend_params p = {
472                 0,     /* no inline assembly */
473                 0,     /* no support for RotL nodes */
474                 1,     /* big endian */
475                 1,     /* modulo shift efficient */
476                 0,     /* non-modulo shift not efficient */
477                 &arch_dep,              /* will be set later */
478                 sparc_is_mux_allowed,   /* parameter for if conversion */
479                 32,    /* machine size */
480                 NULL,  /* float arithmetic mode */
481                 NULL,  /* long long type */
482                 NULL,  /* usigned long long type */
483                 NULL,  /* long double type */
484                 0,     /* no trampoline support: size 0 */
485                 0,     /* no trampoline support: align 0 */
486                 NULL,  /* no trampoline support: no trampoline builder */
487                 4      /* alignment of stack parameter: typically 4 (32bit) or 8 (64bit) */
488         };
489
490         ir_mode *mode_long_long
491                 = new_ir_mode("long long", irms_int_number, 64, 1, irma_twos_complement,
492                               64);
493         ir_type *type_long_long = new_type_primitive(mode_long_long);
494         ir_mode *mode_unsigned_long_long
495                 = new_ir_mode("unsigned long long", irms_int_number, 64, 0,
496                               irma_twos_complement, 64);
497         ir_type *type_unsigned_long_long
498                 = new_type_primitive(mode_unsigned_long_long);
499
500         p.type_long_long          = type_long_long;
501         p.type_unsigned_long_long = type_unsigned_long_long;
502
503         if (sparc_isa_template.fpu_arch == SPARC_FPU_ARCH_SOFTFLOAT) {
504                 p.mode_float_arithmetic = NULL;
505                 p.type_long_double      = NULL;
506         } else {
507                 ir_mode *mode_long_double
508                         = new_ir_mode("long double", irms_float_number, 128, 1,
509                                                   irma_ieee754, 0);
510                 ir_type *type_long_double = new_type_primitive(mode_long_double);
511
512                 set_type_alignment_bytes(type_long_double, 8);
513                 p.type_long_double        = type_long_double;
514         }
515         return &p;
516 }
517
518 static ir_graph **sparc_get_backend_irg_list(const void *self,
519                                              ir_graph ***irgs)
520 {
521         (void) self;
522         (void) irgs;
523         return NULL;
524 }
525
526 static asm_constraint_flags_t sparc_parse_asm_constraint(const char **c)
527 {
528         (void) c;
529         return ASM_CONSTRAINT_FLAG_INVALID;
530 }
531
532 static int sparc_is_valid_clobber(const char *clobber)
533 {
534         (void) clobber;
535         return 0;
536 }
537
538 /* fpu set architectures. */
539 static const lc_opt_enum_int_items_t sparc_fpu_items[] = {
540         { "fpu",       SPARC_FPU_ARCH_FPU },
541         { "softfloat", SPARC_FPU_ARCH_SOFTFLOAT },
542         { NULL,        0 }
543 };
544
545 static lc_opt_enum_int_var_t arch_fpu_var = {
546         &sparc_isa_template.fpu_arch, sparc_fpu_items
547 };
548
549 static const lc_opt_table_entry_t sparc_options[] = {
550         LC_OPT_ENT_ENUM_INT("fpunit", "select the floating point unit", &arch_fpu_var),
551         LC_OPT_LAST
552 };
553
554 static ir_node *sparc_new_spill(ir_node *value, ir_node *after)
555 {
556         ir_node  *block = get_block(after);
557         ir_graph *irg   = get_irn_irg(value);
558         ir_node  *frame = get_irg_frame(irg);
559         ir_node  *mem   = get_irg_no_mem(irg);
560         ir_mode  *mode  = get_irn_mode(value);
561         ir_node  *store;
562
563         if (mode_is_float(mode)) {
564                 store = create_stf(NULL, block, value, frame, mem, mode, NULL, 0, true);
565         } else {
566                 store = new_bd_sparc_St_imm(NULL, block, value, frame, mem, mode, NULL,
567                                             0, true);
568         }
569         sched_add_after(after, store);
570         return store;
571 }
572
573 static ir_node *sparc_new_reload(ir_node *value, ir_node *spill,
574                                  ir_node *before)
575 {
576         ir_node  *block = get_block(before);
577         ir_graph *irg   = get_irn_irg(value);
578         ir_node  *frame = get_irg_frame(irg);
579         ir_mode  *mode  = get_irn_mode(value);
580         ir_node  *load;
581         ir_node  *res;
582
583         if (mode_is_float(mode)) {
584                 load = create_ldf(NULL, block, frame, spill, mode, NULL, 0, true);
585         } else {
586                 load = new_bd_sparc_Ld_imm(NULL, block, frame, spill, mode, NULL, 0,
587                                            true);
588         }
589         sched_add_before(before, load);
590         assert((long)pn_sparc_Ld_res == (long)pn_sparc_Ldf_res);
591         res = new_r_Proj(load, mode, pn_sparc_Ld_res);
592
593         return res;
594 }
595
596 const arch_isa_if_t sparc_isa_if = {
597         sparc_init,
598         sparc_lower_for_target,
599         sparc_done,
600         NULL,                /* handle intrinsics */
601         sparc_get_reg_class_for_mode,
602         NULL,
603         sparc_get_reg_class_alignment,
604         sparc_get_backend_params,
605         sparc_get_backend_irg_list,
606         NULL,                    /* mark remat */
607         sparc_parse_asm_constraint,
608         sparc_is_valid_clobber,
609
610         sparc_init_graph,
611         NULL, /* get_pic_base */
612         NULL, /* before_abi */
613         sparc_prepare_graph,
614         sparc_before_ra,
615         sparc_finish,
616         sparc_emit_routine,
617         NULL, /* register_saved_by */
618         sparc_new_spill,
619         sparc_new_reload
620 };
621
622 BE_REGISTER_MODULE_CONSTRUCTOR(be_init_arch_sparc)
623 void be_init_arch_sparc(void)
624 {
625         lc_opt_entry_t *be_grp = lc_opt_get_grp(firm_opt_get_root(), "be");
626         lc_opt_entry_t *sparc_grp = lc_opt_get_grp(be_grp, "sparc");
627
628         lc_opt_add_table(sparc_grp, sparc_options);
629
630         be_register_isa_if("sparc", &sparc_isa_if);
631         FIRM_DBG_REGISTER(dbg, "firm.be.sparc.cg");
632         sparc_init_transform();
633         sparc_init_emitter();
634 }