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