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