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