b6f5680176764695a58176798af371da55e94e96
[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 *irn)
70 {
71         (void) irn;
72         return 0;
73 }
74
75 static ir_entity *sparc_get_frame_entity(const ir_node *irn)
76 {
77         const sparc_attr_t *attr = get_sparc_attr_const(irn);
78
79         if (is_sparc_FrameAddr(irn)) {
80                 const sparc_symconst_attr_t *attr = get_irn_generic_attr_const(irn);
81                 return attr->entity;
82         }
83
84         if (attr->is_load_store) {
85                 const sparc_load_store_attr_t *load_store_attr = get_sparc_load_store_attr_const(irn);
86                 if (load_store_attr->is_frame_entity) {
87                         return load_store_attr->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 *irn, int offset)
99 {
100         if (is_sparc_FrameAddr(irn)) {
101                 sparc_symconst_attr_t *attr = get_irn_generic_attr(irn);
102                 attr->fp_offset += offset;
103         } else {
104                 sparc_load_store_attr_t *attr = get_sparc_load_store_attr(irn);
105                 assert(attr->base.is_load_store);
106                 attr->offset += offset;
107         }
108 }
109
110 static int sparc_get_sp_bias(const ir_node *node)
111 {
112         if (is_sparc_Save(node)) {
113                 const sparc_save_attr_t *attr = get_sparc_save_attr_const(node);
114                 /* Note we do not retport the change of the SPARC_MIN_STACKSIZE
115                  * size, since we have additional magic in the emitter which
116                  * calculates that! */
117                 assert(attr->initial_stacksize >= SPARC_MIN_STACKSIZE);
118                 return attr->initial_stacksize - SPARC_MIN_STACKSIZE;
119         }
120         return 0;
121 }
122
123 /* fill register allocator interface */
124
125 static const arch_irn_ops_t sparc_irn_ops = {
126         get_sparc_in_req,
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
139 /**
140  * Transforms the standard firm graph into
141  * a SPARC firm graph
142  */
143 static void sparc_prepare_graph(void *self)
144 {
145         sparc_code_gen_t *cg = self;
146
147         /* transform FIRM into SPARC asm nodes */
148         sparc_transform_graph(cg);
149
150         if (cg->dump)
151                 dump_ir_graph(cg->irg, "transformed");
152 }
153
154 static void sparc_before_ra(void *self)
155 {
156         sparc_code_gen_t *cg = self;
157         /* fixup flags register */
158         be_sched_fix_flags(cg->irg, &sparc_reg_classes[CLASS_sparc_flags], NULL,
159                            NULL);
160 }
161
162 /**
163  * transform reload node => load
164  */
165 static void transform_Reload(ir_node *node)
166 {
167         ir_node   *block  = get_nodes_block(node);
168         dbg_info  *dbgi   = get_irn_dbg_info(node);
169         ir_node   *ptr    = get_irn_n(node, be_pos_Spill_frame);
170         ir_node   *mem    = get_irn_n(node, be_pos_Reload_mem);
171         ir_mode   *mode   = get_irn_mode(node);
172         ir_entity *entity = be_get_frame_entity(node);
173         const arch_register_t *reg;
174         ir_node   *proj;
175         ir_node   *load;
176
177         ir_node  *sched_point = sched_prev(node);
178
179         load = new_bd_sparc_Ld(dbgi, block, ptr, mem, mode, entity, false, 0, true);
180         sched_add_after(sched_point, load);
181         sched_remove(node);
182
183         proj = new_rd_Proj(dbgi, load, mode, pn_sparc_Ld_res);
184
185         reg = arch_get_irn_register(node);
186         arch_set_irn_register(proj, reg);
187
188         exchange(node, proj);
189 }
190
191 /**
192  * transform spill node => store
193  */
194 static void transform_Spill(ir_node *node)
195 {
196         ir_node   *block  = get_nodes_block(node);
197         dbg_info  *dbgi   = get_irn_dbg_info(node);
198         ir_node   *ptr    = get_irn_n(node, be_pos_Spill_frame);
199         ir_node   *mem    = new_NoMem();
200         ir_node   *val    = get_irn_n(node, be_pos_Spill_val);
201         ir_mode   *mode   = get_irn_mode(val);
202         ir_entity *entity = be_get_frame_entity(node);
203         ir_node   *sched_point;
204         ir_node   *store;
205
206         sched_point = sched_prev(node);
207         store = new_bd_sparc_St(dbgi, block, ptr, val, mem, mode, entity, false, 0, true);
208         sched_remove(node);
209         sched_add_after(sched_point, store);
210
211         exchange(node, store);
212 }
213
214 /**
215  * walker to transform be_Spill and be_Reload nodes
216  */
217 static void sparc_after_ra_walker(ir_node *block, void *data)
218 {
219         ir_node *node, *prev;
220         (void) data;
221
222         for (node = sched_last(block); !sched_is_begin(node); node = prev) {
223                 prev = sched_prev(node);
224
225                 if (be_is_Reload(node)) {
226                         transform_Reload(node);
227                 } else if (be_is_Spill(node)) {
228                         transform_Spill(node);
229                 }
230         }
231 }
232
233
234 static void sparc_after_ra(void *self)
235 {
236         sparc_code_gen_t *cg = self;
237         be_coalesce_spillslots(cg->irg);
238
239         irg_block_walk_graph(cg->irg, NULL, sparc_after_ra_walker, NULL);
240 }
241
242
243
244 /**
245  * Emits the code, closes the output file and frees
246  * the code generator interface.
247  */
248 static void sparc_emit_and_done(void *self)
249 {
250         sparc_code_gen_t *cg = self;
251         ir_graph           *irg = cg->irg;
252
253         sparc_gen_routine(cg, irg);
254
255         /* de-allocate code generator */
256         free(cg);
257 }
258
259 static void *sparc_cg_init(ir_graph *irg);
260
261 static const arch_code_generator_if_t sparc_code_gen_if = {
262         sparc_cg_init,
263         NULL,                 /* get_pic_base hook */
264         NULL,                 /* before abi introduce hook */
265         sparc_prepare_graph,
266         NULL,                 /* spill hook */
267         sparc_before_ra,      /* before register allocation hook */
268         sparc_after_ra,       /* after register allocation hook */
269         NULL,
270         sparc_emit_and_done
271 };
272
273 /**
274  * Initializes the code generator.
275  */
276 static void *sparc_cg_init(ir_graph *irg)
277 {
278         sparc_isa_t      *isa = (sparc_isa_t *) be_get_irg_arch_env(irg);
279         sparc_code_gen_t *cg  = XMALLOCZ(sparc_code_gen_t);
280
281         cg->impl      = &sparc_code_gen_if;
282         cg->irg       = irg;
283         cg->isa       = isa;
284         cg->dump      = (be_get_irg_options(irg)->dump_flags & DUMP_BE) != 0;
285         cg->constants = pmap_create();
286
287         /* enter the current code generator */
288         isa->cg = cg;
289
290         return (arch_code_generator_t*) cg;
291 }
292
293 const arch_isa_if_t sparc_isa_if;
294 static sparc_isa_t sparc_isa_template = {
295         {
296                 &sparc_isa_if,                      /* isa interface implementation */
297                 &sparc_gp_regs[REG_SP],             /* stack pointer register */
298                 &sparc_gp_regs[REG_FRAME_POINTER],  /* base pointer register */
299                 &sparc_reg_classes[CLASS_sparc_gp], /* link pointer register class */
300                 -1,                                 /* stack direction */
301                 3,                                  /* power of two stack alignment
302                                                        for calls */
303                 NULL,                               /* main environment */
304                 7,                                  /* costs for a spill instruction */
305                 5,                                  /* costs for a reload instruction */
306                 true,                               /* custom abi handling */
307         },
308         NULL                                            /* current code generator */
309 };
310
311
312 static void sparc_handle_intrinsics(void)
313 {
314         ir_type *tp, *int_tp, *uint_tp;
315         i_record records[8];
316         int n_records = 0;
317
318         runtime_rt rt_iMod, rt_uMod;
319
320 #define ID(x) new_id_from_chars(x, sizeof(x)-1)
321
322         int_tp  = new_type_primitive(mode_Is);
323         uint_tp = new_type_primitive(mode_Iu);
324
325
326         /* SPARC has no signed mod instruction ... */
327         {
328                 i_instr_record *map_Mod = &records[n_records++].i_instr;
329
330                 tp = new_type_method(2, 1);
331                 set_method_param_type(tp, 0, int_tp);
332                 set_method_param_type(tp, 1, int_tp);
333                 set_method_res_type(tp, 0, int_tp);
334
335                 rt_iMod.ent             = new_entity(get_glob_type(), ID(".rem"), tp);
336                 set_entity_ld_ident(rt_iMod.ent, ID(".rem"));
337                 rt_iMod.mode            = mode_T;
338                 rt_iMod.res_mode        = mode_Is;
339                 rt_iMod.mem_proj_nr     = pn_Mod_M;
340                 rt_iMod.regular_proj_nr = pn_Mod_X_regular;
341                 rt_iMod.exc_proj_nr     = pn_Mod_X_except;
342                 rt_iMod.exc_mem_proj_nr = pn_Mod_M;
343                 rt_iMod.res_proj_nr     = pn_Mod_res;
344
345                 set_entity_visibility(rt_iMod.ent, ir_visibility_external);
346
347                 map_Mod->kind     = INTRINSIC_INSTR;
348                 map_Mod->op       = op_Mod;
349                 map_Mod->i_mapper = (i_mapper_func)i_mapper_RuntimeCall;
350                 map_Mod->ctx      = &rt_iMod;
351         }
352         /* ... nor an unsigned mod. */
353         {
354                 i_instr_record *map_Mod = &records[n_records++].i_instr;
355
356                 tp = new_type_method(2, 1);
357                 set_method_param_type(tp, 0, uint_tp);
358                 set_method_param_type(tp, 1, uint_tp);
359                 set_method_res_type(tp, 0, uint_tp);
360
361                 rt_uMod.ent             = new_entity(get_glob_type(), ID(".urem"), tp);
362                 set_entity_ld_ident(rt_uMod.ent, ID(".urem"));
363                 rt_uMod.mode            = mode_T;
364                 rt_uMod.res_mode        = mode_Iu;
365                 rt_uMod.mem_proj_nr     = pn_Mod_M;
366                 rt_uMod.regular_proj_nr = pn_Mod_X_regular;
367                 rt_uMod.exc_proj_nr     = pn_Mod_X_except;
368                 rt_uMod.exc_mem_proj_nr = pn_Mod_M;
369                 rt_uMod.res_proj_nr     = pn_Mod_res;
370
371                 set_entity_visibility(rt_uMod.ent, ir_visibility_external);
372
373                 map_Mod->kind     = INTRINSIC_INSTR;
374                 map_Mod->op       = op_Mod;
375                 map_Mod->i_mapper = (i_mapper_func)i_mapper_RuntimeCall;
376                 map_Mod->ctx      = &rt_uMod;
377         }
378
379         if (n_records > 0)
380                 lower_intrinsics(records, n_records, /*part_block_used=*/0);
381 }
382
383
384 /**
385  * Initializes the backend ISA
386  */
387 static arch_env_t *sparc_init(FILE *outfile)
388 {
389         static int run_once = 0;
390         sparc_isa_t *isa;
391
392         if (run_once)
393                 return NULL;
394         run_once = 1;
395
396         isa = XMALLOC(sparc_isa_t);
397         memcpy(isa, &sparc_isa_template, sizeof(*isa));
398
399         be_emit_init(outfile);
400
401         sparc_register_init();
402         sparc_create_opcodes(&sparc_irn_ops);
403         sparc_handle_intrinsics();
404
405         return &isa->base;
406 }
407
408
409
410 /**
411  * Closes the output file and frees the ISA structure.
412  */
413 static void sparc_done(void *self)
414 {
415         sparc_isa_t *isa = self;
416
417         /* emit now all global declarations */
418         be_gas_emit_decls(isa->base.main_env);
419
420         be_emit_exit();
421         free(self);
422 }
423
424
425 static unsigned sparc_get_n_reg_class(void)
426 {
427         return N_CLASSES;
428 }
429
430 static const arch_register_class_t *sparc_get_reg_class(unsigned i)
431 {
432         assert(i < N_CLASSES);
433         return &sparc_reg_classes[i];
434 }
435
436
437
438 /**
439  * Get the register class which shall be used to store a value of a given mode.
440  * @param self The this pointer.
441  * @param mode The mode in question.
442  * @return A register class which can hold values of the given mode.
443  */
444 static const arch_register_class_t *sparc_get_reg_class_for_mode(const ir_mode *mode)
445 {
446         if (mode_is_float(mode))
447                 return &sparc_reg_classes[CLASS_sparc_fp];
448         else
449                 return &sparc_reg_classes[CLASS_sparc_gp];
450 }
451
452 static int sparc_to_appear_in_schedule(void *block_env, const ir_node *irn)
453 {
454         (void) block_env;
455
456         if (!is_sparc_irn(irn))
457                 return -1;
458
459         return 1;
460 }
461
462 /**
463  * Initializes the code generator interface.
464  */
465 static const arch_code_generator_if_t *sparc_get_code_generator_if(
466                 void *self)
467 {
468         (void) self;
469         return &sparc_code_gen_if;
470 }
471
472 list_sched_selector_t sparc_sched_selector;
473
474 /**
475  * Returns the reg_pressure scheduler with to_appear_in_schedule() overloaded
476  */
477 static const list_sched_selector_t *sparc_get_list_sched_selector(
478                 const void *self, list_sched_selector_t *selector)
479 {
480         (void) self;
481         (void) selector;
482
483         sparc_sched_selector = trivial_selector;
484         sparc_sched_selector.to_appear_in_schedule = sparc_to_appear_in_schedule;
485         return &sparc_sched_selector;
486 }
487
488 static const ilp_sched_selector_t *sparc_get_ilp_sched_selector(
489                 const void *self)
490 {
491         (void) self;
492         return NULL;
493 }
494
495 /**
496  * Returns the necessary byte alignment for storing a register of given class.
497  */
498 static int sparc_get_reg_class_alignment(const arch_register_class_t *cls)
499 {
500         ir_mode *mode = arch_register_class_mode(cls);
501         return get_mode_size_bytes(mode);
502 }
503
504 /**
505  * Returns the libFirm configuration parameter for this backend.
506  */
507 static const backend_params *sparc_get_backend_params(void)
508 {
509         static backend_params p = {
510                 0,     /* no dword lowering */
511                 0,     /* no inline assembly */
512                 NULL,  /* will be set later */
513                 NULL,  /* no creator function */
514                 NULL,  /* context for create_intrinsic_fkt */
515                 NULL,  /* parameter for if conversion */
516                 NULL,  /* float arithmetic mode */
517                 0,     /* no trampoline support: size 0 */
518                 0,     /* no trampoline support: align 0 */
519                 NULL,  /* no trampoline support: no trampoline builder */
520                 4      /* alignment of stack parameter: typically 4 (32bit) or 8 (64bit) */
521         };
522         return &p;
523 }
524
525 static const be_execution_unit_t ***sparc_get_allowed_execution_units(
526                 const ir_node *irn)
527 {
528         (void) irn;
529         /* TODO */
530         panic("sparc_get_allowed_execution_units not implemented yet");
531 }
532
533 static const be_machine_t *sparc_get_machine(const void *self)
534 {
535         (void) self;
536         /* TODO */
537         panic("sparc_get_machine not implemented yet");
538 }
539
540 static ir_graph **sparc_get_backend_irg_list(const void *self,
541                                              ir_graph ***irgs)
542 {
543         (void) self;
544         (void) irgs;
545         return NULL;
546 }
547
548 static asm_constraint_flags_t sparc_parse_asm_constraint(const char **c)
549 {
550         (void) c;
551         return ASM_CONSTRAINT_FLAG_INVALID;
552 }
553
554 static int sparc_is_valid_clobber(const char *clobber)
555 {
556         (void) clobber;
557         return 0;
558 }
559
560 const arch_isa_if_t sparc_isa_if = {
561         sparc_init,
562         sparc_done,
563         NULL,                /* handle intrinsics */
564         sparc_get_n_reg_class,
565         sparc_get_reg_class,
566         sparc_get_reg_class_for_mode,
567         NULL,
568         sparc_get_code_generator_if,
569         sparc_get_list_sched_selector,
570         sparc_get_ilp_sched_selector,
571         sparc_get_reg_class_alignment,
572         sparc_get_backend_params,
573         sparc_get_allowed_execution_units,
574         sparc_get_machine,
575         sparc_get_backend_irg_list,
576         NULL,                    /* mark remat */
577         sparc_parse_asm_constraint,
578         sparc_is_valid_clobber
579 };
580
581 BE_REGISTER_MODULE_CONSTRUCTOR(be_init_arch_sparc);
582 void be_init_arch_sparc(void)
583 {
584         be_register_isa_if("sparc", &sparc_isa_if);
585         FIRM_DBG_REGISTER(dbg, "firm.be.sparc.cg");
586         sparc_init_transform();
587         sparc_init_emitter();
588 }