sparc: cleanup register classes, remove some unused code, try to cleanup Div
[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_class],
159                            NULL, 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 static void sparc_collect_frame_entity_nodes(ir_node *node, void *data)
234 {
235         be_fec_env_t  *env = data;
236         const ir_mode *mode;
237         int            align;
238         ir_entity     *entity;
239         const sparc_load_store_attr_t *attr;
240
241         if (be_is_Reload(node) && be_get_frame_entity(node) == NULL) {
242                 mode  = get_irn_mode(node);
243                 align = get_mode_size_bytes(mode);
244                 be_node_needs_frame_entity(env, node, mode, align);
245                 return;
246         }
247
248         if (!is_sparc_Ld(node) && !is_sparc_Ldf(node))
249                 return;
250
251         attr   = get_sparc_load_store_attr_const(node);
252         entity = attr->entity;
253         mode   = attr->load_store_mode;
254         align  = get_mode_size_bytes(mode);
255         if (entity != NULL)
256                 return;
257         if (!attr->is_frame_entity)
258                 return;
259         be_node_needs_frame_entity(env, node, mode, align);
260 }
261
262 static void sparc_set_frame_entity(ir_node *node, ir_entity *entity)
263 {
264         if (is_be_node(node)) {
265                 be_node_set_frame_entity(node, entity);
266         } else {
267                 /* we only say be_node_needs_frame_entity on nodes with load_store
268                  * attributes, so this should be fine */
269                 sparc_load_store_attr_t *attr = get_sparc_load_store_attr(node);
270                 attr->entity = entity;
271         }
272 }
273
274
275 static void sparc_after_ra(void *self)
276 {
277         sparc_code_gen_t *cg      = self;
278         ir_graph         *irg     = cg->irg;
279         be_fec_env_t     *fec_env = be_new_frame_entity_coalescer(irg);
280
281         irg_walk_graph(irg, NULL, sparc_collect_frame_entity_nodes, fec_env);
282         be_assign_entities(fec_env, sparc_set_frame_entity);
283         be_free_frame_entity_coalescer(fec_env);
284
285         irg_block_walk_graph(cg->irg, NULL, sparc_after_ra_walker, NULL);
286 }
287
288
289
290 /**
291  * Emits the code, closes the output file and frees
292  * the code generator interface.
293  */
294 static void sparc_emit_and_done(void *self)
295 {
296         sparc_code_gen_t *cg = self;
297         ir_graph           *irg = cg->irg;
298
299         sparc_gen_routine(cg, irg);
300
301         /* de-allocate code generator */
302         free(cg);
303 }
304
305 static void *sparc_cg_init(ir_graph *irg);
306
307 static const arch_code_generator_if_t sparc_code_gen_if = {
308         sparc_cg_init,
309         NULL,                 /* get_pic_base hook */
310         NULL,                 /* before abi introduce hook */
311         sparc_prepare_graph,
312         NULL,                 /* spill hook */
313         sparc_before_ra,      /* before register allocation hook */
314         sparc_after_ra,       /* after register allocation hook */
315         NULL,
316         sparc_emit_and_done
317 };
318
319 /**
320  * Initializes the code generator.
321  */
322 static void *sparc_cg_init(ir_graph *irg)
323 {
324         sparc_isa_t      *isa = (sparc_isa_t *) be_get_irg_arch_env(irg);
325         sparc_code_gen_t *cg  = XMALLOCZ(sparc_code_gen_t);
326
327         cg->impl      = &sparc_code_gen_if;
328         cg->irg       = irg;
329         cg->isa       = isa;
330         cg->dump      = (be_get_irg_options(irg)->dump_flags & DUMP_BE) != 0;
331         cg->constants = pmap_create();
332
333         /* enter the current code generator */
334         isa->cg = cg;
335
336         return (arch_code_generator_t*) cg;
337 }
338
339 const arch_isa_if_t sparc_isa_if;
340 static sparc_isa_t sparc_isa_template = {
341         {
342                 &sparc_isa_if,                      /* isa interface implementation */
343                 &sparc_gp_regs[REG_SP],             /* stack pointer register */
344                 &sparc_gp_regs[REG_FRAME_POINTER],  /* base pointer register */
345                 &sparc_reg_classes[CLASS_sparc_gp], /* link pointer register class */
346                 -1,                                 /* stack direction */
347                 3,                                  /* power of two stack alignment
348                                                        for calls */
349                 NULL,                               /* main environment */
350                 7,                                  /* costs for a spill instruction */
351                 5,                                  /* costs for a reload instruction */
352                 true,                               /* custom abi handling */
353         },
354         NULL                                            /* current code generator */
355 };
356
357
358 static void sparc_handle_intrinsics(void)
359 {
360         ir_type *tp, *int_tp, *uint_tp;
361         i_record records[8];
362         int n_records = 0;
363
364         runtime_rt rt_iMod, rt_uMod;
365
366 #define ID(x) new_id_from_chars(x, sizeof(x)-1)
367
368         int_tp  = new_type_primitive(mode_Is);
369         uint_tp = new_type_primitive(mode_Iu);
370
371
372         /* SPARC has no signed mod instruction ... */
373         {
374                 i_instr_record *map_Mod = &records[n_records++].i_instr;
375
376                 tp = new_type_method(2, 1);
377                 set_method_param_type(tp, 0, int_tp);
378                 set_method_param_type(tp, 1, int_tp);
379                 set_method_res_type(tp, 0, int_tp);
380
381                 rt_iMod.ent             = new_entity(get_glob_type(), ID(".rem"), tp);
382                 set_entity_ld_ident(rt_iMod.ent, ID(".rem"));
383                 rt_iMod.mode            = mode_T;
384                 rt_iMod.res_mode        = mode_Is;
385                 rt_iMod.mem_proj_nr     = pn_Mod_M;
386                 rt_iMod.regular_proj_nr = pn_Mod_X_regular;
387                 rt_iMod.exc_proj_nr     = pn_Mod_X_except;
388                 rt_iMod.exc_mem_proj_nr = pn_Mod_M;
389                 rt_iMod.res_proj_nr     = pn_Mod_res;
390
391                 set_entity_visibility(rt_iMod.ent, ir_visibility_external);
392
393                 map_Mod->kind     = INTRINSIC_INSTR;
394                 map_Mod->op       = op_Mod;
395                 map_Mod->i_mapper = (i_mapper_func)i_mapper_RuntimeCall;
396                 map_Mod->ctx      = &rt_iMod;
397         }
398         /* ... nor an unsigned mod. */
399         {
400                 i_instr_record *map_Mod = &records[n_records++].i_instr;
401
402                 tp = new_type_method(2, 1);
403                 set_method_param_type(tp, 0, uint_tp);
404                 set_method_param_type(tp, 1, uint_tp);
405                 set_method_res_type(tp, 0, uint_tp);
406
407                 rt_uMod.ent             = new_entity(get_glob_type(), ID(".urem"), tp);
408                 set_entity_ld_ident(rt_uMod.ent, ID(".urem"));
409                 rt_uMod.mode            = mode_T;
410                 rt_uMod.res_mode        = mode_Iu;
411                 rt_uMod.mem_proj_nr     = pn_Mod_M;
412                 rt_uMod.regular_proj_nr = pn_Mod_X_regular;
413                 rt_uMod.exc_proj_nr     = pn_Mod_X_except;
414                 rt_uMod.exc_mem_proj_nr = pn_Mod_M;
415                 rt_uMod.res_proj_nr     = pn_Mod_res;
416
417                 set_entity_visibility(rt_uMod.ent, ir_visibility_external);
418
419                 map_Mod->kind     = INTRINSIC_INSTR;
420                 map_Mod->op       = op_Mod;
421                 map_Mod->i_mapper = (i_mapper_func)i_mapper_RuntimeCall;
422                 map_Mod->ctx      = &rt_uMod;
423         }
424
425         if (n_records > 0)
426                 lower_intrinsics(records, n_records, /*part_block_used=*/0);
427 }
428
429
430 /**
431  * Initializes the backend ISA
432  */
433 static arch_env_t *sparc_init(FILE *outfile)
434 {
435         static int run_once = 0;
436         sparc_isa_t *isa;
437
438         if (run_once)
439                 return NULL;
440         run_once = 1;
441
442         isa = XMALLOC(sparc_isa_t);
443         memcpy(isa, &sparc_isa_template, sizeof(*isa));
444
445         be_emit_init(outfile);
446
447         sparc_register_init();
448         sparc_create_opcodes(&sparc_irn_ops);
449         sparc_handle_intrinsics();
450
451         return &isa->base;
452 }
453
454
455
456 /**
457  * Closes the output file and frees the ISA structure.
458  */
459 static void sparc_done(void *self)
460 {
461         sparc_isa_t *isa = self;
462
463         /* emit now all global declarations */
464         be_gas_emit_decls(isa->base.main_env);
465
466         be_emit_exit();
467         free(self);
468 }
469
470
471 static unsigned sparc_get_n_reg_class(void)
472 {
473         return N_CLASSES;
474 }
475
476 static const arch_register_class_t *sparc_get_reg_class(unsigned i)
477 {
478         assert(i < N_CLASSES);
479         return &sparc_reg_classes[i];
480 }
481
482
483
484 /**
485  * Get the register class which shall be used to store a value of a given mode.
486  * @param self The this pointer.
487  * @param mode The mode in question.
488  * @return A register class which can hold values of the given mode.
489  */
490 static const arch_register_class_t *sparc_get_reg_class_for_mode(const ir_mode *mode)
491 {
492         if (mode_is_float(mode))
493                 return &sparc_reg_classes[CLASS_sparc_fp];
494         else
495                 return &sparc_reg_classes[CLASS_sparc_gp];
496 }
497
498 static int sparc_to_appear_in_schedule(void *block_env, const ir_node *irn)
499 {
500         (void) block_env;
501
502         if (!is_sparc_irn(irn))
503                 return -1;
504
505         return 1;
506 }
507
508 /**
509  * Initializes the code generator interface.
510  */
511 static const arch_code_generator_if_t *sparc_get_code_generator_if(
512                 void *self)
513 {
514         (void) self;
515         return &sparc_code_gen_if;
516 }
517
518 list_sched_selector_t sparc_sched_selector;
519
520 /**
521  * Returns the reg_pressure scheduler with to_appear_in_schedule() overloaded
522  */
523 static const list_sched_selector_t *sparc_get_list_sched_selector(
524                 const void *self, list_sched_selector_t *selector)
525 {
526         (void) self;
527         (void) selector;
528
529         sparc_sched_selector = trivial_selector;
530         sparc_sched_selector.to_appear_in_schedule = sparc_to_appear_in_schedule;
531         return &sparc_sched_selector;
532 }
533
534 static const ilp_sched_selector_t *sparc_get_ilp_sched_selector(
535                 const void *self)
536 {
537         (void) self;
538         return NULL;
539 }
540
541 /**
542  * Returns the necessary byte alignment for storing a register of given class.
543  */
544 static int sparc_get_reg_class_alignment(const arch_register_class_t *cls)
545 {
546         ir_mode *mode = arch_register_class_mode(cls);
547         return get_mode_size_bytes(mode);
548 }
549
550 /**
551  * Returns the libFirm configuration parameter for this backend.
552  */
553 static const backend_params *sparc_get_backend_params(void)
554 {
555         static backend_params p = {
556                 0,     /* no dword lowering */
557                 0,     /* no inline assembly */
558                 NULL,  /* will be set later */
559                 NULL,  /* no creator function */
560                 NULL,  /* context for create_intrinsic_fkt */
561                 NULL,  /* parameter for if conversion */
562                 NULL,  /* float arithmetic mode */
563                 0,     /* no trampoline support: size 0 */
564                 0,     /* no trampoline support: align 0 */
565                 NULL,  /* no trampoline support: no trampoline builder */
566                 4      /* alignment of stack parameter: typically 4 (32bit) or 8 (64bit) */
567         };
568         return &p;
569 }
570
571 static const be_execution_unit_t ***sparc_get_allowed_execution_units(
572                 const ir_node *irn)
573 {
574         (void) irn;
575         /* TODO */
576         panic("sparc_get_allowed_execution_units not implemented yet");
577 }
578
579 static const be_machine_t *sparc_get_machine(const void *self)
580 {
581         (void) self;
582         /* TODO */
583         panic("sparc_get_machine not implemented yet");
584 }
585
586 static ir_graph **sparc_get_backend_irg_list(const void *self,
587                                              ir_graph ***irgs)
588 {
589         (void) self;
590         (void) irgs;
591         return NULL;
592 }
593
594 static asm_constraint_flags_t sparc_parse_asm_constraint(const char **c)
595 {
596         (void) c;
597         return ASM_CONSTRAINT_FLAG_INVALID;
598 }
599
600 static int sparc_is_valid_clobber(const char *clobber)
601 {
602         (void) clobber;
603         return 0;
604 }
605
606 const arch_isa_if_t sparc_isa_if = {
607         sparc_init,
608         sparc_done,
609         NULL,                /* handle intrinsics */
610         sparc_get_n_reg_class,
611         sparc_get_reg_class,
612         sparc_get_reg_class_for_mode,
613         NULL,
614         sparc_get_code_generator_if,
615         sparc_get_list_sched_selector,
616         sparc_get_ilp_sched_selector,
617         sparc_get_reg_class_alignment,
618         sparc_get_backend_params,
619         sparc_get_allowed_execution_units,
620         sparc_get_machine,
621         sparc_get_backend_irg_list,
622         NULL,                    /* mark remat */
623         sparc_parse_asm_constraint,
624         sparc_is_valid_clobber
625 };
626
627 BE_REGISTER_MODULE_CONSTRUCTOR(be_init_arch_sparc);
628 void be_init_arch_sparc(void)
629 {
630         be_register_isa_if("sparc", &sparc_isa_if);
631         FIRM_DBG_REGISTER(dbg, "firm.be.sparc.cg");
632         sparc_init_transform();
633         sparc_init_emitter();
634 }