bearch: Remove the write-only attribute link_class from struct arch_env_t.
[libfirm] / ir / be / arm / bearch_arm.c
1 /*
2  * Copyright (C) 1995-2008 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 arm backend driver file.
23  * @author  Matthias Braun, Oliver Richter, Tobias Gneist
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 "irdump.h"
38 #include "lower_calls.h"
39 #include "error.h"
40
41 #include "bitset.h"
42 #include "debug.h"
43 #include "array_t.h"
44 #include "irtools.h"
45
46 #include "bearch.h"
47 #include "benode.h"
48 #include "belower.h"
49 #include "besched.h"
50 #include "be.h"
51 #include "bemodule.h"
52 #include "beirg.h"
53 #include "bespillslots.h"
54 #include "bespillutil.h"
55 #include "begnuas.h"
56 #include "belistsched.h"
57 #include "beflags.h"
58 #include "bestack.h"
59
60 #include "bearch_arm_t.h"
61
62 #include "arm_new_nodes.h"
63 #include "gen_arm_regalloc_if.h"
64 #include "arm_transform.h"
65 #include "arm_optimize.h"
66 #include "arm_emitter.h"
67 #include "arm_map_regs.h"
68
69 static ir_entity *arm_get_frame_entity(const ir_node *irn)
70 {
71         const arm_attr_t *attr = get_arm_attr_const(irn);
72
73         if (is_arm_FrameAddr(irn)) {
74                 const arm_SymConst_attr_t *frame_attr = get_arm_SymConst_attr_const(irn);
75                 return frame_attr->entity;
76         }
77         if (attr->is_load_store) {
78                 const arm_load_store_attr_t *load_store_attr
79                         = get_arm_load_store_attr_const(irn);
80                 if (load_store_attr->is_frame_entity) {
81                         return load_store_attr->entity;
82                 }
83         }
84         return NULL;
85 }
86
87 /**
88  * This function is called by the generic backend to correct offsets for
89  * nodes accessing the stack.
90  */
91 static void arm_set_stack_bias(ir_node *irn, int bias)
92 {
93         if (is_arm_FrameAddr(irn)) {
94                 arm_SymConst_attr_t *attr = get_arm_SymConst_attr(irn);
95                 attr->fp_offset += bias;
96         } else {
97                 arm_load_store_attr_t *attr = get_arm_load_store_attr(irn);
98                 assert(attr->base.is_load_store);
99                 attr->offset += bias;
100         }
101 }
102
103 static int arm_get_sp_bias(const ir_node *irn)
104 {
105         /* We don't have any nodes changing the stack pointer.
106            We probably want to support post-/pre increment/decrement later */
107         (void) irn;
108         return 0;
109 }
110
111 /* fill register allocator interface */
112
113 static const arch_irn_ops_t arm_irn_ops = {
114         arm_get_frame_entity,
115         arm_set_stack_bias,
116         arm_get_sp_bias,
117         NULL,    /* get_inverse             */
118         NULL,    /* get_op_estimated_cost   */
119         NULL,    /* possible_memory_operand */
120         NULL,    /* perform_memory_operand  */
121 };
122
123 /**
124  * Transforms the standard Firm graph into
125  * a ARM firm graph.
126  */
127 static void arm_prepare_graph(ir_graph *irg)
128 {
129         /* transform nodes into assembler instructions */
130         arm_transform_graph(irg);
131
132         /* do local optimizations (mainly CSE) */
133         local_optimize_graph(irg);
134
135         /* do code placement, to optimize the position of constants */
136         place_code(irg);
137 }
138
139 static void arm_collect_frame_entity_nodes(ir_node *node, void *data)
140 {
141         be_fec_env_t  *env = (be_fec_env_t*)data;
142         const ir_mode *mode;
143         int            align;
144         ir_entity     *entity;
145         const arm_load_store_attr_t *attr;
146
147         if (be_is_Reload(node) && be_get_frame_entity(node) == NULL) {
148                 mode  = get_irn_mode(node);
149                 align = get_mode_size_bytes(mode);
150                 be_node_needs_frame_entity(env, node, mode, align);
151                 return;
152         }
153
154         switch (get_arm_irn_opcode(node)) {
155         case iro_arm_Ldf:
156         case iro_arm_Ldr:
157                 break;
158         default:
159                 return;
160         }
161
162         attr   = get_arm_load_store_attr_const(node);
163         entity = attr->entity;
164         mode   = attr->load_store_mode;
165         align  = get_mode_size_bytes(mode);
166         if (entity != NULL)
167                 return;
168         if (!attr->is_frame_entity)
169                 return;
170         be_node_needs_frame_entity(env, node, mode, align);
171 }
172
173 static void arm_set_frame_entity(ir_node *node, ir_entity *entity)
174 {
175         if (is_be_node(node)) {
176                 be_node_set_frame_entity(node, entity);
177         } else {
178                 arm_load_store_attr_t *attr = get_arm_load_store_attr(node);
179                 attr->entity = entity;
180         }
181 }
182
183 static void transform_Reload(ir_node *node)
184 {
185         ir_node   *block  = get_nodes_block(node);
186         dbg_info  *dbgi   = get_irn_dbg_info(node);
187         ir_node   *ptr    = get_irn_n(node, n_be_Reload_frame);
188         ir_node   *mem    = get_irn_n(node, n_be_Reload_mem);
189         ir_mode   *mode   = get_irn_mode(node);
190         ir_entity *entity = be_get_frame_entity(node);
191         const arch_register_t *reg;
192         ir_node   *proj;
193         ir_node   *load;
194
195         ir_node  *sched_point = sched_prev(node);
196
197         load = new_bd_arm_Ldr(dbgi, block, ptr, mem, mode, entity, false, 0, true);
198         sched_add_after(sched_point, load);
199         sched_remove(node);
200
201         proj = new_rd_Proj(dbgi, load, mode, pn_arm_Ldr_res);
202
203         reg = arch_get_irn_register(node);
204         arch_set_irn_register(proj, reg);
205
206         exchange(node, proj);
207 }
208
209 static void transform_Spill(ir_node *node)
210 {
211         ir_node   *block  = get_nodes_block(node);
212         dbg_info  *dbgi   = get_irn_dbg_info(node);
213         ir_node   *ptr    = get_irn_n(node, n_be_Spill_frame);
214         ir_graph  *irg    = get_irn_irg(node);
215         ir_node   *mem    = get_irg_no_mem(irg);
216         ir_node   *val    = get_irn_n(node, n_be_Spill_val);
217         ir_mode   *mode   = get_irn_mode(val);
218         ir_entity *entity = be_get_frame_entity(node);
219         ir_node   *sched_point;
220         ir_node   *store;
221
222         sched_point = sched_prev(node);
223         store = new_bd_arm_Str(dbgi, block, ptr, val, mem, mode, entity, false, 0,
224                                true);
225
226         sched_remove(node);
227         sched_add_after(sched_point, store);
228
229         exchange(node, store);
230 }
231
232 static void arm_after_ra_walker(ir_node *block, void *data)
233 {
234         ir_node *node, *prev;
235         (void) data;
236
237         for (node = sched_last(block); !sched_is_begin(node); node = prev) {
238                 prev = sched_prev(node);
239
240                 if (be_is_Reload(node)) {
241                         transform_Reload(node);
242                 } else if (be_is_Spill(node)) {
243                         transform_Spill(node);
244                 }
245         }
246 }
247
248 /**
249  * Called immediately before emit phase.
250  */
251 static void arm_finish_irg(ir_graph *irg)
252 {
253         be_stack_layout_t *stack_layout = be_get_irg_stack_layout(irg);
254         bool               at_begin     = stack_layout->sp_relative ? true : false;
255         be_fec_env_t      *fec_env      = be_new_frame_entity_coalescer(irg);
256
257         irg_walk_graph(irg, NULL, arm_collect_frame_entity_nodes, fec_env);
258         be_assign_entities(fec_env, arm_set_frame_entity, at_begin);
259         be_free_frame_entity_coalescer(fec_env);
260
261         irg_block_walk_graph(irg, NULL, arm_after_ra_walker, NULL);
262
263         /* fix stack entity offsets */
264         be_abi_fix_stack_nodes(irg);
265         be_abi_fix_stack_bias(irg);
266
267         /* do peephole optimizations and fix stack offsets */
268         arm_peephole_optimization(irg);
269 }
270
271 static void arm_before_ra(ir_graph *irg)
272 {
273         be_sched_fix_flags(irg, &arm_reg_classes[CLASS_arm_flags], NULL, NULL);
274 }
275
276 /**
277  * Maps all intrinsic calls that the backend support
278  * and map all instructions the backend did not support
279  * to runtime calls.
280  */
281 static void arm_handle_intrinsics(void)
282 {
283         ir_type *tp, *int_tp, *uint_tp;
284         i_record records[8];
285         int n_records = 0;
286
287         runtime_rt rt_iDiv, rt_uDiv, rt_iMod, rt_uMod;
288
289 #define ID(x) new_id_from_chars(x, sizeof(x)-1)
290
291         int_tp  = get_type_for_mode(mode_Is);
292         uint_tp = get_type_for_mode(mode_Iu);
293
294         /* ARM has neither a signed div instruction ... */
295         {
296                 i_instr_record *map_Div = &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_iDiv.ent             = new_entity(get_glob_type(), ID("__divsi3"), tp);
304                 set_entity_ld_ident(rt_iDiv.ent, ID("__divsi3"));
305                 rt_iDiv.mode            = mode_T;
306                 rt_iDiv.res_mode        = mode_Is;
307                 rt_iDiv.mem_proj_nr     = pn_Div_M;
308                 rt_iDiv.regular_proj_nr = pn_Div_X_regular;
309                 rt_iDiv.exc_proj_nr     = pn_Div_X_except;
310                 rt_iDiv.res_proj_nr     = pn_Div_res;
311
312                 add_entity_linkage(rt_iDiv.ent, IR_LINKAGE_CONSTANT);
313                 set_entity_visibility(rt_iDiv.ent, ir_visibility_external);
314
315                 map_Div->kind     = INTRINSIC_INSTR;
316                 map_Div->op       = op_Div;
317                 map_Div->i_mapper = (i_mapper_func)i_mapper_RuntimeCall;
318                 map_Div->ctx      = &rt_iDiv;
319         }
320         /* ... nor an unsigned div instruction ... */
321         {
322                 i_instr_record *map_Div = &records[n_records++].i_instr;
323
324                 tp = new_type_method(2, 1);
325                 set_method_param_type(tp, 0, uint_tp);
326                 set_method_param_type(tp, 1, uint_tp);
327                 set_method_res_type(tp, 0, uint_tp);
328
329                 rt_uDiv.ent             = new_entity(get_glob_type(), ID("__udivsi3"), tp);
330                 set_entity_ld_ident(rt_uDiv.ent, ID("__udivsi3"));
331                 rt_uDiv.mode            = mode_T;
332                 rt_uDiv.res_mode        = mode_Iu;
333                 rt_uDiv.mem_proj_nr     = pn_Div_M;
334                 rt_uDiv.regular_proj_nr = pn_Div_X_regular;
335                 rt_uDiv.exc_proj_nr     = pn_Div_X_except;
336                 rt_uDiv.res_proj_nr     = pn_Div_res;
337
338                 set_entity_visibility(rt_uDiv.ent, ir_visibility_external);
339
340                 map_Div->kind     = INTRINSIC_INSTR;
341                 map_Div->op       = op_Div;
342                 map_Div->i_mapper = (i_mapper_func)i_mapper_RuntimeCall;
343                 map_Div->ctx      = &rt_uDiv;
344         }
345         /* ... nor a signed mod instruction ... */
346         {
347                 i_instr_record *map_Mod = &records[n_records++].i_instr;
348
349                 tp = new_type_method(2, 1);
350                 set_method_param_type(tp, 0, int_tp);
351                 set_method_param_type(tp, 1, int_tp);
352                 set_method_res_type(tp, 0, int_tp);
353
354                 rt_iMod.ent             = new_entity(get_glob_type(), ID("__modsi3"), tp);
355                 set_entity_ld_ident(rt_iMod.ent, ID("__modsi3"));
356                 rt_iMod.mode            = mode_T;
357                 rt_iMod.res_mode        = mode_Is;
358                 rt_iMod.mem_proj_nr     = pn_Mod_M;
359                 rt_iMod.regular_proj_nr = pn_Mod_X_regular;
360                 rt_iMod.exc_proj_nr     = pn_Mod_X_except;
361                 rt_iMod.res_proj_nr     = pn_Mod_res;
362
363                 set_entity_visibility(rt_iMod.ent, ir_visibility_external);
364
365                 map_Mod->kind     = INTRINSIC_INSTR;
366                 map_Mod->op       = op_Mod;
367                 map_Mod->i_mapper = (i_mapper_func)i_mapper_RuntimeCall;
368                 map_Mod->ctx      = &rt_iMod;
369         }
370         /* ... nor an unsigned mod. */
371         {
372                 i_instr_record *map_Mod = &records[n_records++].i_instr;
373
374                 tp = new_type_method(2, 1);
375                 set_method_param_type(tp, 0, uint_tp);
376                 set_method_param_type(tp, 1, uint_tp);
377                 set_method_res_type(tp, 0, uint_tp);
378
379                 rt_uMod.ent             = new_entity(get_glob_type(), ID("__umodsi3"), tp);
380                 set_entity_ld_ident(rt_uMod.ent, ID("__umodsi3"));
381                 rt_uMod.mode            = mode_T;
382                 rt_uMod.res_mode        = mode_Iu;
383                 rt_uMod.mem_proj_nr     = pn_Mod_M;
384                 rt_uMod.regular_proj_nr = pn_Mod_X_regular;
385                 rt_uMod.exc_proj_nr     = pn_Mod_X_except;
386                 rt_uMod.res_proj_nr     = pn_Mod_res;
387
388                 set_entity_visibility(rt_uMod.ent, ir_visibility_external);
389
390                 map_Mod->kind     = INTRINSIC_INSTR;
391                 map_Mod->op       = op_Mod;
392                 map_Mod->i_mapper = (i_mapper_func)i_mapper_RuntimeCall;
393                 map_Mod->ctx      = &rt_uMod;
394         }
395
396         if (n_records > 0)
397                 lower_intrinsics(records, n_records, /*part_block_used=*/0);
398 }
399
400 extern const arch_isa_if_t arm_isa_if;
401 static arm_isa_t arm_isa_template = {
402         {
403                 &arm_isa_if,             /* isa interface */
404                 N_ARM_REGISTERS,
405                 arm_registers,
406                 N_ARM_CLASSES,
407                 arm_reg_classes,
408                 &arm_registers[REG_SP],  /* stack pointer */
409                 &arm_registers[REG_R11], /* base pointer */
410                 2,                       /* power of two stack alignment for calls, 2^2 == 4 */
411                 NULL,                    /* main environment */
412                 7,                       /* spill costs */
413                 5,                       /* reload costs */
414                 true,                    /* we do have custom abi handling */
415         },
416         ARM_FPU_ARCH_FPE,          /* FPU architecture */
417 };
418
419 static void arm_init(void)
420 {
421         arm_register_init();
422
423         arm_create_opcodes(&arm_irn_ops);
424 }
425
426 static void arm_finish(void)
427 {
428         arm_free_opcodes();
429 }
430
431 static arch_env_t *arm_begin_codegeneration(const be_main_env_t *env)
432 {
433         arm_isa_t *isa = XMALLOC(arm_isa_t);
434         *isa = arm_isa_template;
435
436         be_gas_emit_types = false;
437
438         be_emit_init(env->file_handle);
439         be_gas_begin_compilation_unit(env);
440
441         return &isa->base;
442 }
443
444 /**
445  * Closes the output file and frees the ISA structure.
446  */
447 static void arm_end_codegeneration(void *self)
448 {
449         arm_isa_t *isa = (arm_isa_t*)self;
450
451         be_gas_end_compilation_unit(isa->base.main_env);
452
453         be_emit_exit();
454         free(self);
455 }
456
457 /**
458  * Allows or disallows the creation of Psi nodes for the given Phi nodes.
459  * @return 1 if allowed, 0 otherwise
460  */
461 static int arm_is_mux_allowed(ir_node *sel, ir_node *mux_false,
462                               ir_node *mux_true)
463 {
464         (void) sel;
465         (void) mux_false;
466         (void) mux_true;
467         return false;
468 }
469
470 static asm_constraint_flags_t arm_parse_asm_constraint(const char **c)
471 {
472         /* asm not supported */
473         (void) c;
474         return ASM_CONSTRAINT_FLAG_INVALID;
475 }
476
477 static int arm_is_valid_clobber(const char *clobber)
478 {
479         (void) clobber;
480         return 0;
481 }
482
483 static void arm_lower_for_target(void)
484 {
485         ir_mode *mode_gp = arm_reg_classes[CLASS_arm_gp].mode;
486         size_t i, n_irgs = get_irp_n_irgs();
487
488         /* lower compound param handling */
489         lower_calls_with_compounds(LF_RETURN_HIDDEN);
490
491         for (i = 0; i < n_irgs; ++i) {
492                 ir_graph *irg = get_irp_irg(i);
493                 lower_switch(irg, 4, 256, mode_gp);
494         }
495
496         for (i = 0; i < n_irgs; ++i) {
497                 ir_graph *irg = get_irp_irg(i);
498                 /* Turn all small CopyBs into loads/stores and all bigger CopyBs into
499                  * memcpy calls.
500                  * TODO:  These constants need arm-specific tuning. */
501                 lower_CopyB(irg, 31, 32, false);
502         }
503 }
504
505 /**
506  * Returns the libFirm configuration parameter for this backend.
507  */
508 static const backend_params *arm_get_libfirm_params(void)
509 {
510         static ir_settings_arch_dep_t ad = {
511                 1,    /* allow subs */
512                 1,    /* Muls are fast enough on ARM but ... */
513                 31,   /* ... one shift would be possible better */
514                 NULL, /* no evaluator function */
515                 0,    /* SMUL is needed, only in Arch M */
516                 0,    /* UMUL is needed, only in Arch M */
517                 32,   /* SMUL & UMUL available for 32 bit */
518         };
519         static backend_params p = {
520                 0,     /* don't support inline assembler yet */
521                 1,     /* support Rotl nodes */
522                 1,     /* big endian */
523                 1,     /* modulo shift efficient */
524                 0,     /* non-modulo shift not efficient */
525                 &ad,   /* will be set later */
526                 arm_is_mux_allowed, /* allow_ifconv function */
527                 32,    /* machine size */
528                 NULL,  /* float arithmetic mode (TODO) */
529                 NULL,  /* long long type */
530                 NULL,  /* unsigned long long type */
531                 NULL,  /* long double type */
532                 0,     /* no trampoline support: size 0 */
533                 0,     /* no trampoline support: align 0 */
534                 NULL,  /* no trampoline support: no trampoline builder */
535                 4      /* alignment of stack parameter */
536         };
537
538         return &p;
539 }
540
541 /* fpu set architectures. */
542 static const lc_opt_enum_int_items_t arm_fpu_items[] = {
543         { "softfloat", ARM_FPU_ARCH_SOFTFLOAT },
544         { "fpe",       ARM_FPU_ARCH_FPE },
545         { "fpa",       ARM_FPU_ARCH_FPA },
546         { "vfp1xd",    ARM_FPU_ARCH_VFP_V1xD },
547         { "vfp1",      ARM_FPU_ARCH_VFP_V1 },
548         { "vfp2",      ARM_FPU_ARCH_VFP_V2 },
549         { NULL,        0 }
550 };
551
552 static lc_opt_enum_int_var_t arch_fpu_var = {
553         &arm_isa_template.fpu_arch, arm_fpu_items
554 };
555
556 static const lc_opt_table_entry_t arm_options[] = {
557         LC_OPT_ENT_ENUM_INT("fpunit",    "select the floating point unit", &arch_fpu_var),
558         LC_OPT_LAST
559 };
560
561 const arch_isa_if_t arm_isa_if = {
562         arm_init,
563         arm_finish,
564         arm_get_libfirm_params,
565         arm_lower_for_target,
566         arm_parse_asm_constraint,
567         arm_is_valid_clobber,
568
569         arm_begin_codegeneration,
570         arm_end_codegeneration,
571         NULL,
572         NULL,  /* get call abi */
573         NULL,  /* mark remat */
574         NULL,  /* get_pic_base */
575         be_new_spill,
576         be_new_reload,
577         NULL,  /* register_saved_by */
578
579         arm_handle_intrinsics, /* handle_intrinsics */
580         NULL,  /* before_abi */
581         arm_prepare_graph,
582         arm_before_ra,
583         arm_finish_irg,
584         arm_gen_routine,
585 };
586
587 BE_REGISTER_MODULE_CONSTRUCTOR(be_init_arch_arm)
588 void be_init_arch_arm(void)
589 {
590         lc_opt_entry_t *be_grp = lc_opt_get_grp(firm_opt_get_root(), "be");
591         lc_opt_entry_t *arm_grp = lc_opt_get_grp(be_grp, "arm");
592
593         lc_opt_add_table(arm_grp, arm_options);
594
595         be_register_isa_if("arm", &arm_isa_if);
596
597         arm_init_transform();
598         arm_init_emitter();
599 }