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