d110e0ceffcf95f57e74ee1ae45cb7da754b18e5
[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  * @version  $Id$
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 "lowering.h"
40
41 #include "bitset.h"
42 #include "debug.h"
43 #include "array_t.h"
44 #include "error.h"
45
46 #include "../bearch.h"
47 #include "../benode.h"
48 #include "../belower.h"
49 #include "../besched.h"
50 #include "be.h"
51 #include "../bemachine.h"
52 #include "../beilpsched.h"
53 #include "../bemodule.h"
54 #include "../beirg.h"
55 #include "../bespillslots.h"
56 #include "../begnuas.h"
57 #include "../belistsched.h"
58 #include "../beflags.h"
59
60 #include "bearch_sparc_t.h"
61
62 #include "sparc_new_nodes.h"
63 #include "gen_sparc_regalloc_if.h"
64 #include "sparc_transform.h"
65 #include "sparc_emitter.h"
66
67 DEBUG_ONLY(static firm_dbg_module_t *dbg = NULL;)
68
69 static arch_irn_class_t sparc_classify(const ir_node *node)
70 {
71         (void) node;
72         return 0;
73 }
74
75 static ir_entity *sparc_get_frame_entity(const ir_node *node)
76 {
77         if (is_sparc_FrameAddr(node)) {
78                 const sparc_attr_t *attr = get_sparc_attr_const(node);
79                 return attr->immediate_value_entity;
80         }
81
82         if (sparc_has_load_store_attr(node)) {
83                 const sparc_load_store_attr_t *load_store_attr
84                         = get_sparc_load_store_attr_const(node);
85                 if (load_store_attr->is_frame_entity) {
86                         return load_store_attr->base.immediate_value_entity;
87                 }
88         }
89
90         return NULL;
91 }
92
93 /**
94  * This function is called by the generic backend to correct offsets for
95  * nodes accessing the stack.
96  */
97 static void sparc_set_frame_offset(ir_node *node, int offset)
98 {
99         sparc_attr_t *attr = get_sparc_attr(node);
100         attr->immediate_value += offset;
101
102         /* must be a FrameAddr or a load/store node with frame_entity */
103         assert(is_sparc_FrameAddr(node) ||
104                         get_sparc_load_store_attr_const(node)->is_frame_entity);
105 }
106
107 static int sparc_get_sp_bias(const ir_node *node)
108 {
109         if (is_sparc_Save(node)) {
110                 const sparc_save_attr_t *attr = get_sparc_save_attr_const(node);
111                 /* Note we do not retport the change of the SPARC_MIN_STACKSIZE
112                  * size, since we have additional magic in the emitter which
113                  * calculates that! */
114                 assert(attr->initial_stacksize >= SPARC_MIN_STACKSIZE);
115                 return attr->initial_stacksize - SPARC_MIN_STACKSIZE;
116         }
117         return 0;
118 }
119
120 /* fill register allocator interface */
121
122 static const arch_irn_ops_t sparc_irn_ops = {
123         get_sparc_in_req,
124         sparc_classify,
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(void *self)
139 {
140         sparc_code_gen_t *cg = self;
141
142         /* transform FIRM into SPARC asm nodes */
143         sparc_transform_graph(cg);
144
145         if (cg->dump)
146                 dump_ir_graph(cg->irg, "transformed");
147 }
148
149 static bool sparc_modifies_flags(const ir_node *node)
150 {
151         return arch_irn_get_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_irn_get_flags(node) & sparc_arch_irn_flag_modifies_fp_flags;
157 }
158
159 static void sparc_before_ra(void *self)
160 {
161         sparc_code_gen_t *cg = self;
162         /* fixup flags register */
163         be_sched_fix_flags(cg->irg, &sparc_reg_classes[CLASS_sparc_flags_class],
164                            NULL, sparc_modifies_flags);
165         be_sched_fix_flags(cg->irg, &sparc_reg_classes[CLASS_sparc_fpflags_class],
166                            NULL, sparc_modifies_fp_flags);
167 }
168
169 /**
170  * transform reload node => load
171  */
172 static void transform_Reload(ir_node *node)
173 {
174         ir_node   *block  = get_nodes_block(node);
175         dbg_info  *dbgi   = get_irn_dbg_info(node);
176         ir_node   *ptr    = get_irn_n(node, be_pos_Spill_frame);
177         ir_node   *mem    = get_irn_n(node, be_pos_Reload_mem);
178         ir_mode   *mode   = get_irn_mode(node);
179         ir_entity *entity = be_get_frame_entity(node);
180         const arch_register_t *reg;
181         ir_node   *proj;
182         ir_node   *load;
183
184         ir_node  *sched_point = sched_prev(node);
185
186         load = new_bd_sparc_Ld_imm(dbgi, block, ptr, mem, mode, entity, 0, true);
187         sched_add_after(sched_point, load);
188         sched_remove(node);
189
190         proj = new_rd_Proj(dbgi, load, mode, pn_sparc_Ld_res);
191
192         reg = arch_get_irn_register(node);
193         arch_set_irn_register(proj, reg);
194
195         exchange(node, proj);
196 }
197
198 /**
199  * transform spill node => store
200  */
201 static void transform_Spill(ir_node *node)
202 {
203         ir_node   *block  = get_nodes_block(node);
204         dbg_info  *dbgi   = get_irn_dbg_info(node);
205         ir_node   *ptr    = get_irn_n(node, be_pos_Spill_frame);
206         ir_node   *mem    = new_NoMem();
207         ir_node   *val    = get_irn_n(node, be_pos_Spill_val);
208         ir_mode   *mode   = get_irn_mode(val);
209         ir_entity *entity = be_get_frame_entity(node);
210         ir_node   *sched_point;
211         ir_node   *store;
212
213         sched_point = sched_prev(node);
214         store = new_bd_sparc_St_imm(dbgi, block, val, ptr, mem, mode, entity, 0, true);
215         sched_remove(node);
216         sched_add_after(sched_point, store);
217
218         exchange(node, store);
219 }
220
221 /**
222  * walker to transform be_Spill and be_Reload nodes
223  */
224 static void sparc_after_ra_walker(ir_node *block, void *data)
225 {
226         ir_node *node, *prev;
227         (void) data;
228
229         for (node = sched_last(block); !sched_is_begin(node); node = prev) {
230                 prev = sched_prev(node);
231
232                 if (be_is_Reload(node)) {
233                         transform_Reload(node);
234                 } else if (be_is_Spill(node)) {
235                         transform_Spill(node);
236                 }
237         }
238 }
239
240 static void sparc_collect_frame_entity_nodes(ir_node *node, void *data)
241 {
242         be_fec_env_t  *env = data;
243         const ir_mode *mode;
244         int            align;
245         ir_entity     *entity;
246         const sparc_load_store_attr_t *attr;
247
248         if (be_is_Reload(node) && be_get_frame_entity(node) == NULL) {
249                 mode  = get_irn_mode(node);
250                 align = get_mode_size_bytes(mode);
251                 be_node_needs_frame_entity(env, node, mode, align);
252                 return;
253         }
254
255         if (!is_sparc_Ld(node) && !is_sparc_Ldf(node))
256                 return;
257
258         attr   = get_sparc_load_store_attr_const(node);
259         entity = attr->base.immediate_value_entity;
260         mode   = attr->load_store_mode;
261         if (entity != NULL)
262                 return;
263         if (!attr->is_frame_entity)
264                 return;
265         if (arch_irn_get_flags(node) & sparc_arch_irn_flag_needs_64bit_spillslot)
266                 mode = mode_Lu;
267         align  = get_mode_size_bytes(mode);
268         be_node_needs_frame_entity(env, node, mode, align);
269 }
270
271 static void sparc_set_frame_entity(ir_node *node, ir_entity *entity)
272 {
273         if (is_be_node(node)) {
274                 be_node_set_frame_entity(node, entity);
275         } else {
276                 /* we only say be_node_needs_frame_entity on nodes with load_store
277                  * attributes, so this should be fine */
278                 sparc_load_store_attr_t *attr = get_sparc_load_store_attr(node);
279                 assert(attr->is_frame_entity);
280                 assert(attr->base.immediate_value_entity == NULL);
281                 attr->base.immediate_value_entity = entity;
282         }
283 }
284
285 static void sparc_after_ra(void *self)
286 {
287         sparc_code_gen_t *cg      = self;
288         ir_graph         *irg     = cg->irg;
289         be_fec_env_t     *fec_env = be_new_frame_entity_coalescer(irg);
290
291         irg_walk_graph(irg, NULL, sparc_collect_frame_entity_nodes, fec_env);
292         be_assign_entities(fec_env, sparc_set_frame_entity);
293         be_free_frame_entity_coalescer(fec_env);
294
295         irg_block_walk_graph(cg->irg, NULL, sparc_after_ra_walker, NULL);
296 }
297
298 /**
299  * Emits the code, closes the output file and frees
300  * the code generator interface.
301  */
302 static void sparc_emit_and_done(void *self)
303 {
304         sparc_code_gen_t *cg  = self;
305         ir_graph         *irg = cg->irg;
306
307         sparc_emit_routine(irg);
308
309         /* de-allocate code generator */
310         free(cg);
311 }
312
313 static void *sparc_cg_init(ir_graph *irg);
314
315 static const arch_code_generator_if_t sparc_code_gen_if = {
316         sparc_cg_init,
317         NULL,                 /* get_pic_base hook */
318         NULL,                 /* before abi introduce hook */
319         sparc_prepare_graph,
320         NULL,                 /* spill hook */
321         sparc_before_ra,      /* before register allocation hook */
322         sparc_after_ra,       /* after register allocation hook */
323         NULL,
324         sparc_emit_and_done
325 };
326
327 /**
328  * Initializes the code generator.
329  */
330 static void *sparc_cg_init(ir_graph *irg)
331 {
332         sparc_isa_t      *isa = (sparc_isa_t *) be_get_irg_arch_env(irg);
333         sparc_code_gen_t *cg  = XMALLOCZ(sparc_code_gen_t);
334
335         cg->impl      = &sparc_code_gen_if;
336         cg->irg       = irg;
337         cg->isa       = isa;
338         cg->dump      = (be_get_irg_options(irg)->dump_flags & DUMP_BE) != 0;
339         cg->constants = pmap_create();
340
341         /* enter the current code generator */
342         isa->cg = cg;
343
344         return (arch_code_generator_t*) cg;
345 }
346
347 const arch_isa_if_t sparc_isa_if;
348 static sparc_isa_t sparc_isa_template = {
349         {
350                 &sparc_isa_if,                      /* isa interface implementation */
351                 &sparc_gp_regs[REG_SP],             /* stack pointer register */
352                 &sparc_gp_regs[REG_FRAME_POINTER],  /* base pointer register */
353                 &sparc_reg_classes[CLASS_sparc_gp], /* link pointer register class */
354                 -1,                                 /* stack direction */
355                 3,                                  /* power of two stack alignment
356                                                        for calls */
357                 NULL,                               /* main environment */
358                 7,                                  /* costs for a spill instruction */
359                 5,                                  /* costs for a reload instruction */
360                 true,                               /* custom abi handling */
361         },
362         NULL                                            /* current code generator */
363 };
364
365 static void sparc_handle_intrinsics(void)
366 {
367         ir_type *tp, *int_tp, *uint_tp;
368         i_record records[8];
369         int n_records = 0;
370
371         runtime_rt rt_iMod, rt_uMod;
372
373 #define ID(x) new_id_from_chars(x, sizeof(x)-1)
374
375         int_tp  = new_type_primitive(mode_Is);
376         uint_tp = new_type_primitive(mode_Iu);
377
378
379         /* SPARC has no signed mod instruction ... */
380         {
381                 i_instr_record *map_Mod = &records[n_records++].i_instr;
382
383                 tp = new_type_method(2, 1);
384                 set_method_param_type(tp, 0, int_tp);
385                 set_method_param_type(tp, 1, int_tp);
386                 set_method_res_type(tp, 0, int_tp);
387
388                 rt_iMod.ent             = new_entity(get_glob_type(), ID(".rem"), tp);
389                 set_entity_ld_ident(rt_iMod.ent, ID(".rem"));
390                 rt_iMod.mode            = mode_T;
391                 rt_iMod.res_mode        = mode_Is;
392                 rt_iMod.mem_proj_nr     = pn_Mod_M;
393                 rt_iMod.regular_proj_nr = pn_Mod_X_regular;
394                 rt_iMod.exc_proj_nr     = pn_Mod_X_except;
395                 rt_iMod.exc_mem_proj_nr = pn_Mod_M;
396                 rt_iMod.res_proj_nr     = pn_Mod_res;
397
398                 set_entity_visibility(rt_iMod.ent, ir_visibility_external);
399
400                 map_Mod->kind     = INTRINSIC_INSTR;
401                 map_Mod->op       = op_Mod;
402                 map_Mod->i_mapper = (i_mapper_func)i_mapper_RuntimeCall;
403                 map_Mod->ctx      = &rt_iMod;
404         }
405         /* ... nor an unsigned mod. */
406         {
407                 i_instr_record *map_Mod = &records[n_records++].i_instr;
408
409                 tp = new_type_method(2, 1);
410                 set_method_param_type(tp, 0, uint_tp);
411                 set_method_param_type(tp, 1, uint_tp);
412                 set_method_res_type(tp, 0, uint_tp);
413
414                 rt_uMod.ent             = new_entity(get_glob_type(), ID(".urem"), tp);
415                 set_entity_ld_ident(rt_uMod.ent, ID(".urem"));
416                 rt_uMod.mode            = mode_T;
417                 rt_uMod.res_mode        = mode_Iu;
418                 rt_uMod.mem_proj_nr     = pn_Mod_M;
419                 rt_uMod.regular_proj_nr = pn_Mod_X_regular;
420                 rt_uMod.exc_proj_nr     = pn_Mod_X_except;
421                 rt_uMod.exc_mem_proj_nr = pn_Mod_M;
422                 rt_uMod.res_proj_nr     = pn_Mod_res;
423
424                 set_entity_visibility(rt_uMod.ent, ir_visibility_external);
425
426                 map_Mod->kind     = INTRINSIC_INSTR;
427                 map_Mod->op       = op_Mod;
428                 map_Mod->i_mapper = (i_mapper_func)i_mapper_RuntimeCall;
429                 map_Mod->ctx      = &rt_uMod;
430         }
431
432         if (n_records > 0)
433                 lower_intrinsics(records, n_records, /*part_block_used=*/0);
434 }
435
436 /**
437  * Initializes the backend ISA
438  */
439 static arch_env_t *sparc_init(FILE *outfile)
440 {
441         static int run_once = 0;
442         sparc_isa_t *isa;
443
444         if (run_once)
445                 return NULL;
446         run_once = 1;
447
448         isa = XMALLOC(sparc_isa_t);
449         memcpy(isa, &sparc_isa_template, sizeof(*isa));
450
451         be_emit_init(outfile);
452
453         sparc_register_init();
454         sparc_create_opcodes(&sparc_irn_ops);
455         sparc_handle_intrinsics();
456
457         return &isa->base;
458 }
459
460 /**
461  * Closes the output file and frees the ISA structure.
462  */
463 static void sparc_done(void *self)
464 {
465         sparc_isa_t *isa = self;
466
467         /* emit now all global declarations */
468         be_gas_emit_decls(isa->base.main_env);
469
470         be_emit_exit();
471         free(self);
472 }
473
474 static unsigned sparc_get_n_reg_class(void)
475 {
476         return N_CLASSES;
477 }
478
479 static const arch_register_class_t *sparc_get_reg_class(unsigned i)
480 {
481         assert(i < N_CLASSES);
482         return &sparc_reg_classes[i];
483 }
484
485
486
487 /**
488  * Get the register class which shall be used to store a value of a given mode.
489  * @param self The this pointer.
490  * @param mode The mode in question.
491  * @return A register class which can hold values of the given mode.
492  */
493 static const arch_register_class_t *sparc_get_reg_class_for_mode(const ir_mode *mode)
494 {
495         if (mode_is_float(mode))
496                 return &sparc_reg_classes[CLASS_sparc_fp];
497         else
498                 return &sparc_reg_classes[CLASS_sparc_gp];
499 }
500
501 static int sparc_to_appear_in_schedule(void *block_env, const ir_node *irn)
502 {
503         (void) block_env;
504
505         if (!is_sparc_irn(irn))
506                 return -1;
507
508         return 1;
509 }
510
511 /**
512  * Initializes the code generator interface.
513  */
514 static const arch_code_generator_if_t *sparc_get_code_generator_if(
515                 void *self)
516 {
517         (void) self;
518         return &sparc_code_gen_if;
519 }
520
521 list_sched_selector_t sparc_sched_selector;
522
523 /**
524  * Returns the reg_pressure scheduler with to_appear_in_schedule() overloaded
525  */
526 static const list_sched_selector_t *sparc_get_list_sched_selector(
527                 const void *self, list_sched_selector_t *selector)
528 {
529         (void) self;
530         (void) selector;
531
532         sparc_sched_selector = trivial_selector;
533         sparc_sched_selector.to_appear_in_schedule = sparc_to_appear_in_schedule;
534         return &sparc_sched_selector;
535 }
536
537 static const ilp_sched_selector_t *sparc_get_ilp_sched_selector(
538                 const void *self)
539 {
540         (void) self;
541         return NULL;
542 }
543
544 /**
545  * Returns the necessary byte alignment for storing a register of given class.
546  */
547 static int sparc_get_reg_class_alignment(const arch_register_class_t *cls)
548 {
549         ir_mode *mode = arch_register_class_mode(cls);
550         return get_mode_size_bytes(mode);
551 }
552
553 static void sparc_lower_for_target(void)
554 {
555         /* TODO, doubleword lowering and others */
556 }
557
558 /**
559  * Returns the libFirm configuration parameter for this backend.
560  */
561 static const backend_params *sparc_get_backend_params(void)
562 {
563         static const ir_settings_arch_dep_t arch_dep = {
564                 1,     /* also_use_subs */
565                 1,     /* maximum_shifts */
566                 31,    /* highest_shift_amount */
567                 NULL,  /* evaluate_cost_func */
568                 1,     /* allow mulhs */
569                 1,     /* allow mulhu */
570                 32,    /* max_bits_for_mulh */
571         };
572         static backend_params p = {
573                 0,     /* no inline assembly */
574                 0,     /* no support for RotL nodes */
575                 sparc_lower_for_target, /* lowering callback */
576                 &arch_dep,              /* will be set later */
577                 NULL,  /* parameter for if conversion */
578                 NULL,  /* float arithmetic mode */
579                 0,     /* no trampoline support: size 0 */
580                 0,     /* no trampoline support: align 0 */
581                 NULL,  /* no trampoline support: no trampoline builder */
582                 4      /* alignment of stack parameter: typically 4 (32bit) or 8 (64bit) */
583         };
584         return &p;
585 }
586
587 static const be_execution_unit_t ***sparc_get_allowed_execution_units(
588                 const ir_node *irn)
589 {
590         (void) irn;
591         /* TODO */
592         panic("sparc_get_allowed_execution_units not implemented yet");
593 }
594
595 static const be_machine_t *sparc_get_machine(const void *self)
596 {
597         (void) self;
598         /* TODO */
599         panic("sparc_get_machine not implemented yet");
600 }
601
602 static ir_graph **sparc_get_backend_irg_list(const void *self,
603                                              ir_graph ***irgs)
604 {
605         (void) self;
606         (void) irgs;
607         return NULL;
608 }
609
610 static asm_constraint_flags_t sparc_parse_asm_constraint(const char **c)
611 {
612         (void) c;
613         return ASM_CONSTRAINT_FLAG_INVALID;
614 }
615
616 static int sparc_is_valid_clobber(const char *clobber)
617 {
618         (void) clobber;
619         return 0;
620 }
621
622 const arch_isa_if_t sparc_isa_if = {
623         sparc_init,
624         sparc_done,
625         NULL,                /* handle intrinsics */
626         sparc_get_n_reg_class,
627         sparc_get_reg_class,
628         sparc_get_reg_class_for_mode,
629         NULL,
630         sparc_get_code_generator_if,
631         sparc_get_list_sched_selector,
632         sparc_get_ilp_sched_selector,
633         sparc_get_reg_class_alignment,
634         sparc_get_backend_params,
635         sparc_get_allowed_execution_units,
636         sparc_get_machine,
637         sparc_get_backend_irg_list,
638         NULL,                    /* mark remat */
639         sparc_parse_asm_constraint,
640         sparc_is_valid_clobber
641 };
642
643 BE_REGISTER_MODULE_CONSTRUCTOR(be_init_arch_sparc);
644 void be_init_arch_sparc(void)
645 {
646         be_register_isa_if("sparc", &sparc_isa_if);
647         FIRM_DBG_REGISTER(dbg, "firm.be.sparc.cg");
648         sparc_init_transform();
649         sparc_init_emitter();
650 }