remove these largish/noisy headers
[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  * @version $Id$
25  */
26 #include "config.h"
27
28 #include "lc_opts.h"
29 #include "lc_opts_enum.h"
30
31 #include "pseudo_irg.h"
32 #include "irgwalk.h"
33 #include "irprog.h"
34 #include "irprintf.h"
35 #include "ircons.h"
36 #include "irgmod.h"
37 #include "irgopt.h"
38 #include "iroptimize.h"
39 #include "irdump.h"
40 #include "lowering.h"
41 #include "error.h"
42
43 #include "bitset.h"
44 #include "debug.h"
45 #include "array_t.h"
46 #include "irtools.h"
47
48 #include "../bearch.h"
49 #include "../benode.h"
50 #include "../belower.h"
51 #include "../besched.h"
52 #include "be.h"
53 #include "../beabi.h"
54 #include "../bemachine.h"
55 #include "../beilpsched.h"
56 #include "../bemodule.h"
57 #include "../beirg.h"
58 #include "../bespillslots.h"
59 #include "../begnuas.h"
60 #include "../belistsched.h"
61 #include "../beflags.h"
62
63 #include "bearch_arm_t.h"
64
65 #include "arm_new_nodes.h"
66 #include "gen_arm_regalloc_if.h"
67 #include "arm_transform.h"
68 #include "arm_optimize.h"
69 #include "arm_emitter.h"
70 #include "arm_map_regs.h"
71
72 static arch_irn_class_t arm_classify(const ir_node *irn)
73 {
74         (void) irn;
75         return 0;
76 }
77
78 static ir_entity *arm_get_frame_entity(const ir_node *irn)
79 {
80         const arm_attr_t *attr = get_arm_attr_const(irn);
81
82         if (is_arm_FrameAddr(irn)) {
83                 const arm_SymConst_attr_t *attr = get_irn_generic_attr_const(irn);
84                 return attr->entity;
85         }
86         if (attr->is_load_store) {
87                 const arm_load_store_attr_t *load_store_attr
88                         = get_arm_load_store_attr_const(irn);
89                 if (load_store_attr->is_frame_entity) {
90                         return load_store_attr->entity;
91                 }
92         }
93         return NULL;
94 }
95
96 static void arm_set_frame_entity(ir_node *irn, ir_entity *ent)
97 {
98         (void) irn;
99         (void) ent;
100         panic("arm_set_frame_entity() called. This should not happen.");
101 }
102
103 /**
104  * This function is called by the generic backend to correct offsets for
105  * nodes accessing the stack.
106  */
107 static void arm_set_stack_bias(ir_node *irn, int bias)
108 {
109         if (is_arm_FrameAddr(irn)) {
110                 arm_SymConst_attr_t *attr = get_irn_generic_attr(irn);
111                 attr->fp_offset += bias;
112         } else {
113                 arm_load_store_attr_t *attr = get_arm_load_store_attr(irn);
114                 assert(attr->base.is_load_store);
115                 attr->offset += bias;
116         }
117 }
118
119 static int arm_get_sp_bias(const ir_node *irn)
120 {
121         /* We don't have any nodes changing the stack pointer.
122                 TODO: we probably want to support post-/pre increment/decrement later */
123         (void) irn;
124         return 0;
125 }
126
127 /* fill register allocator interface */
128
129 static const arch_irn_ops_t arm_irn_ops = {
130         get_arm_in_req,
131         arm_classify,
132         arm_get_frame_entity,
133         arm_set_frame_entity,
134         arm_set_stack_bias,
135         arm_get_sp_bias,
136         NULL,    /* get_inverse             */
137         NULL,    /* get_op_estimated_cost   */
138         NULL,    /* possible_memory_operand */
139         NULL,    /* perform_memory_operand  */
140 };
141
142 /**
143  * Transforms the standard Firm graph into
144  * a ARM firm graph.
145  */
146 static void arm_prepare_graph(void *self)
147 {
148         arm_code_gen_t *cg = self;
149
150         /* transform nodes into assembler instructions */
151         arm_transform_graph(cg);
152
153         /* do local optimizations (mainly CSE) */
154         local_optimize_graph(cg->irg);
155
156         if (cg->dump)
157                 dump_ir_graph(cg->irg, "transformed");
158
159         /* do code placement, to optimize the position of constants */
160         place_code(cg->irg);
161
162         if (cg->dump)
163                 dump_ir_graph(cg->irg, "place");
164 }
165
166 /**
167  * Called immediately before emit phase.
168  */
169 static void arm_finish_irg(void *self)
170 {
171         arm_code_gen_t *cg = self;
172
173         /* do peephole optimizations and fix stack offsets */
174         arm_peephole_optimization(cg);
175 }
176
177 static ir_node *arm_flags_remat(ir_node *node, ir_node *after)
178 {
179         ir_node *block;
180         ir_node *copy;
181
182         if (is_Block(after)) {
183                 block = after;
184         } else {
185                 block = get_nodes_block(after);
186         }
187         copy = exact_copy(node);
188         set_nodes_block(copy, block);
189         sched_add_after(after, copy);
190         return copy;
191 }
192
193 static void arm_before_ra(void *self)
194 {
195         arm_code_gen_t *cg = self;
196
197         be_sched_fix_flags(cg->irg, &arm_reg_classes[CLASS_arm_flags],
198                            &arm_flags_remat);
199 }
200
201 static void transform_Reload(ir_node *node)
202 {
203         ir_graph  *irg    = get_irn_irg(node);
204         ir_node   *block  = get_nodes_block(node);
205         dbg_info  *dbgi   = get_irn_dbg_info(node);
206         ir_node   *ptr    = get_irg_frame(irg);
207         ir_node   *mem    = get_irn_n(node, be_pos_Reload_mem);
208         ir_mode   *mode   = get_irn_mode(node);
209         ir_entity *entity = be_get_frame_entity(node);
210         const arch_register_t *reg;
211         ir_node   *proj;
212         ir_node   *load;
213
214         ir_node  *sched_point = sched_prev(node);
215
216         load = new_bd_arm_Ldr(dbgi, block, ptr, mem, mode, entity, false, 0, true);
217         sched_add_after(sched_point, load);
218         sched_remove(node);
219
220         proj = new_rd_Proj(dbgi, load, mode, pn_arm_Ldr_res);
221
222         reg = arch_get_irn_register(node);
223         arch_set_irn_register(proj, reg);
224
225         exchange(node, proj);
226 }
227
228 static void transform_Spill(ir_node *node)
229 {
230         ir_graph  *irg    = get_irn_irg(node);
231         ir_node   *block  = get_nodes_block(node);
232         dbg_info  *dbgi   = get_irn_dbg_info(node);
233         ir_node   *ptr    = get_irg_frame(irg);
234         ir_node   *mem    = new_NoMem();
235         ir_node   *val    = get_irn_n(node, be_pos_Spill_val);
236         ir_mode   *mode   = get_irn_mode(val);
237         ir_entity *entity = be_get_frame_entity(node);
238         ir_node   *sched_point;
239         ir_node   *store;
240
241         sched_point = sched_prev(node);
242         store = new_bd_arm_Str(dbgi, block, ptr, val, mem, mode, entity, false, 0,
243                                true);
244
245         sched_remove(node);
246         sched_add_after(sched_point, store);
247
248         exchange(node, store);
249 }
250
251 static void arm_after_ra_walker(ir_node *block, void *data)
252 {
253         ir_node *node, *prev;
254         (void) data;
255
256         for (node = sched_last(block); !sched_is_begin(node); node = prev) {
257                 prev = sched_prev(node);
258
259                 if (be_is_Reload(node)) {
260                         transform_Reload(node);
261                 } else if (be_is_Spill(node)) {
262                         transform_Spill(node);
263                 }
264         }
265 }
266
267 static void arm_after_ra(void *self)
268 {
269         arm_code_gen_t *cg = self;
270         be_coalesce_spillslots(cg->irg);
271
272         irg_block_walk_graph(cg->irg, NULL, arm_after_ra_walker, NULL);
273 }
274
275 /**
276  * Emits the code, closes the output file and frees
277  * the code generator interface.
278  */
279 static void arm_emit_and_done(void *self)
280 {
281         arm_code_gen_t *cg = self;
282         ir_graph       *irg = cg->irg;
283
284         arm_gen_routine(cg, irg);
285
286         /* de-allocate code generator */
287         del_set(cg->reg_set);
288         free(self);
289 }
290
291 /**
292  * Move a double floating point value into an integer register.
293  * Place the move operation into block bl.
294  *
295  * Handle some special cases here:
296  * 1.) A constant: simply split into two
297  * 2.) A load: simply split into two
298  */
299 static ir_node *convert_dbl_to_int(ir_node *bl, ir_node *arg, ir_node *mem,
300                                    ir_node **resH, ir_node **resL)
301 {
302         if (is_Const(arg)) {
303                 tarval *tv = get_Const_tarval(arg);
304                 unsigned v;
305
306                 /* get the upper 32 bits */
307                 v =            get_tarval_sub_bits(tv, 7);
308                 v = (v << 8) | get_tarval_sub_bits(tv, 6);
309                 v = (v << 8) | get_tarval_sub_bits(tv, 5);
310                 v = (v << 8) | get_tarval_sub_bits(tv, 4);
311                 *resH = new_Const_long(mode_Is, v);
312
313                 /* get the lower 32 bits */
314                 v =            get_tarval_sub_bits(tv, 3);
315                 v = (v << 8) | get_tarval_sub_bits(tv, 2);
316                 v = (v << 8) | get_tarval_sub_bits(tv, 1);
317                 v = (v << 8) | get_tarval_sub_bits(tv, 0);
318                 *resL = new_Const_long(mode_Is, v);
319         } else if (is_Load(skip_Proj(arg))) {
320                 /* FIXME: handling of low/high depends on LE/BE here */
321                 panic("Unimplemented convert_dbl_to_int() case");
322         }
323         else {
324                 ir_node *conv;
325
326                 conv = new_bd_arm_fpaDbl2GP(NULL, bl, arg, mem);
327                 /* move high/low */
328                 *resL = new_r_Proj(conv, mode_Is, pn_arm_fpaDbl2GP_low);
329                 *resH = new_r_Proj(conv, mode_Is, pn_arm_fpaDbl2GP_high);
330                 mem   = new_r_Proj(conv, mode_M,  pn_arm_fpaDbl2GP_M);
331         }
332         return mem;
333 }
334
335 /**
336  * Move a single floating point value into an integer register.
337  * Place the move operation into block bl.
338  *
339  * Handle some special cases here:
340  * 1.) A constant: simply move
341  * 2.) A load: simply load
342  */
343 static ir_node *convert_sng_to_int(ir_node *bl, ir_node *arg)
344 {
345         (void) bl;
346
347         if (is_Const(arg)) {
348                 tarval *tv = get_Const_tarval(arg);
349                 unsigned v;
350
351                 /* get the lower 32 bits */
352                 v =            get_tarval_sub_bits(tv, 3);
353                 v = (v << 8) | get_tarval_sub_bits(tv, 2);
354                 v = (v << 8) | get_tarval_sub_bits(tv, 1);
355                 v = (v << 8) | get_tarval_sub_bits(tv, 0);
356                 return new_Const_long(mode_Is, v);
357         }
358         panic("Unimplemented convert_sng_to_int() case");
359 }
360
361 /**
362  * Convert the arguments of a call to support the
363  * ARM calling convention of general purpose AND floating
364  * point arguments.
365  */
366 static void handle_calls(ir_node *call, void *env)
367 {
368         arm_code_gen_t *cg = env;
369         int i, j, n, size, idx, flag, n_param, n_res, first_variadic;
370         ir_type *mtp, *new_mtd, *new_tp[5];
371         ir_node *new_in[5], **in;
372         ir_node *bl;
373
374         if (! is_Call(call))
375                 return;
376
377         /* check, if we need conversions */
378         n = get_Call_n_params(call);
379         mtp = get_Call_type(call);
380         assert(get_method_n_params(mtp) == n);
381
382         /* it's always enough to handle the first 4 parameters */
383         if (n > 4)
384                 n = 4;
385         flag = size = idx = 0;
386         bl = get_nodes_block(call);
387         for (i = 0; i < n; ++i) {
388                 ir_type *param_tp = get_method_param_type(mtp, i);
389
390                 if (is_compound_type(param_tp)) {
391                         /* an aggregate parameter: bad case */
392                         assert(0);
393                 }
394                 else {
395                         /* a primitive parameter */
396                         ir_mode *mode = get_type_mode(param_tp);
397
398                         if (mode_is_float(mode)) {
399                                 if (get_mode_size_bits(mode) > 32) {
400                                         ir_node *mem = get_Call_mem(call);
401
402                                         /* Beware: ARM wants the high part first */
403                                         size += 2 * 4;
404                                         new_tp[idx]   = cg->int_tp;
405                                         new_tp[idx+1] = cg->int_tp;
406                                         mem = convert_dbl_to_int(bl, get_Call_param(call, i), mem, &new_in[idx], &new_in[idx+1]);
407                                         idx += 2;
408                                         set_Call_mem(call, mem);
409                                 }
410                                 else {
411                                         size += 4;
412                                         new_tp[idx] = cg->int_tp;
413                                         new_in[idx] = convert_sng_to_int(bl, get_Call_param(call, i));
414                                         ++idx;
415                                 }
416                                 flag = 1;
417                         }
418                         else {
419                                 size += 4;
420                                 new_tp[idx] = param_tp;
421                                 new_in[idx] = get_Call_param(call, i);
422                                 ++idx;
423                         }
424                 }
425
426                 if (size >= 16)
427                         break;
428         }
429
430         /* if flag is NOT set, no need to translate the method type */
431         if (! flag)
432                 return;
433
434         /* construct a new method type */
435         n       = i;
436         n_param = get_method_n_params(mtp) - n + idx;
437         n_res   = get_method_n_ress(mtp);
438         new_mtd = new_d_type_method(n_param, n_res, get_type_dbg_info(mtp));
439
440         for (i = 0; i < idx; ++i)
441                 set_method_param_type(new_mtd, i, new_tp[i]);
442         for (i = n, j = idx; i < get_method_n_params(mtp); ++i)
443                 set_method_param_type(new_mtd, j++, get_method_param_type(mtp, i));
444         for (i = 0; i < n_res; ++i)
445                 set_method_res_type(new_mtd, i, get_method_res_type(mtp, i));
446
447         set_method_calling_convention(new_mtd, get_method_calling_convention(mtp));
448         first_variadic = get_method_first_variadic_param_index(mtp);
449         if (first_variadic >= 0)
450                 set_method_first_variadic_param_index(new_mtd, first_variadic);
451
452         if (is_lowered_type(mtp)) {
453                 mtp = get_associated_type(mtp);
454         }
455         set_lowered_type(mtp, new_mtd);
456
457         set_Call_type(call, new_mtd);
458
459         /* calculate new in array of the Call */
460         NEW_ARR_A(ir_node *, in, n_param + 2);
461         for (i = 0; i < idx; ++i)
462                 in[2 + i] = new_in[i];
463         for (i = n, j = idx; i < get_method_n_params(mtp); ++i)
464                 in[2 + j++] = get_Call_param(call, i);
465
466         in[0] = get_Call_mem(call);
467         in[1] = get_Call_ptr(call);
468
469         /* finally, change the call inputs */
470         set_irn_in(call, n_param + 2, in);
471 }
472
473 /**
474  * Handle graph transformations before the abi converter does its work.
475  */
476 static void arm_before_abi(void *self)
477 {
478         arm_code_gen_t *cg = self;
479
480         irg_walk_graph(cg->irg, NULL, handle_calls, cg);
481 }
482
483 /* forward */
484 static void *arm_cg_init(ir_graph *irg);
485
486 static const arch_code_generator_if_t arm_code_gen_if = {
487         arm_cg_init,
488         NULL,               /* get_pic_base */
489         arm_before_abi,     /* before abi introduce */
490         arm_prepare_graph,
491         NULL,               /* spill */
492         arm_before_ra,      /* before register allocation hook */
493         arm_after_ra,
494         arm_finish_irg,
495         arm_emit_and_done,
496 };
497
498 /**
499  * Initializes the code generator.
500  */
501 static void *arm_cg_init(ir_graph *irg)
502 {
503         static ir_type *int_tp = NULL;
504         arm_isa_t      *isa = (arm_isa_t *) be_get_irg_arch_env(irg);
505         arm_code_gen_t *cg;
506
507         if (! int_tp) {
508                 /* create an integer type with machine size */
509                 int_tp = new_type_primitive(mode_Is);
510         }
511
512         cg = XMALLOC(arm_code_gen_t);
513         cg->impl         = &arm_code_gen_if;
514         cg->irg          = irg;
515         cg->reg_set      = new_set(arm_cmp_irn_reg_assoc, 1024);
516         cg->isa          = isa;
517         cg->int_tp       = int_tp;
518         cg->have_fp_insn = 0;
519         cg->dump         = (be_get_irg_options(irg)->dump_flags & DUMP_BE) ? 1 : 0;
520
521         FIRM_DBG_REGISTER(cg->mod, "firm.be.arm.cg");
522
523         /* enter the current code generator */
524         isa->cg = cg;
525
526         return (arch_code_generator_t *)cg;
527 }
528
529
530 /**
531  * Maps all intrinsic calls that the backend support
532  * and map all instructions the backend did not support
533  * to runtime calls.
534  */
535 static void arm_handle_intrinsics(void)
536 {
537         ir_type *tp, *int_tp, *uint_tp;
538         i_record records[8];
539         int n_records = 0;
540
541         runtime_rt rt_iDiv, rt_uDiv, rt_iMod, rt_uMod;
542
543 #define ID(x) new_id_from_chars(x, sizeof(x)-1)
544
545         int_tp  = new_type_primitive(mode_Is);
546         uint_tp = new_type_primitive(mode_Iu);
547
548         /* ARM has neither a signed div instruction ... */
549         {
550                 i_instr_record *map_Div = &records[n_records++].i_instr;
551
552                 tp = new_type_method(2, 1);
553                 set_method_param_type(tp, 0, int_tp);
554                 set_method_param_type(tp, 1, int_tp);
555                 set_method_res_type(tp, 0, int_tp);
556
557                 rt_iDiv.ent             = new_entity(get_glob_type(), ID("__divsi3"), tp);
558                 set_entity_ld_ident(rt_iDiv.ent, ID("__divsi3"));
559                 rt_iDiv.mode            = mode_T;
560                 rt_iDiv.res_mode        = mode_Is;
561                 rt_iDiv.mem_proj_nr     = pn_Div_M;
562                 rt_iDiv.regular_proj_nr = pn_Div_X_regular;
563                 rt_iDiv.exc_proj_nr     = pn_Div_X_except;
564                 rt_iDiv.exc_mem_proj_nr = pn_Div_M;
565                 rt_iDiv.res_proj_nr     = pn_Div_res;
566
567                 add_entity_linkage(rt_iDiv.ent, IR_LINKAGE_CONSTANT);
568                 set_entity_visibility(rt_iDiv.ent, ir_visibility_external);
569
570                 map_Div->kind     = INTRINSIC_INSTR;
571                 map_Div->op       = op_Div;
572                 map_Div->i_mapper = (i_mapper_func)i_mapper_RuntimeCall;
573                 map_Div->ctx      = &rt_iDiv;
574         }
575         /* ... nor an unsigned div instruction ... */
576         {
577                 i_instr_record *map_Div = &records[n_records++].i_instr;
578
579                 tp = new_type_method(2, 1);
580                 set_method_param_type(tp, 0, uint_tp);
581                 set_method_param_type(tp, 1, uint_tp);
582                 set_method_res_type(tp, 0, uint_tp);
583
584                 rt_uDiv.ent             = new_entity(get_glob_type(), ID("__udivsi3"), tp);
585                 set_entity_ld_ident(rt_uDiv.ent, ID("__udivsi3"));
586                 rt_uDiv.mode            = mode_T;
587                 rt_uDiv.res_mode        = mode_Iu;
588                 rt_uDiv.mem_proj_nr     = pn_Div_M;
589                 rt_uDiv.regular_proj_nr = pn_Div_X_regular;
590                 rt_uDiv.exc_proj_nr     = pn_Div_X_except;
591                 rt_uDiv.exc_mem_proj_nr = pn_Div_M;
592                 rt_uDiv.res_proj_nr     = pn_Div_res;
593
594                 set_entity_visibility(rt_uDiv.ent, ir_visibility_external);
595
596                 map_Div->kind     = INTRINSIC_INSTR;
597                 map_Div->op       = op_Div;
598                 map_Div->i_mapper = (i_mapper_func)i_mapper_RuntimeCall;
599                 map_Div->ctx      = &rt_uDiv;
600         }
601         /* ... nor a signed mod instruction ... */
602         {
603                 i_instr_record *map_Mod = &records[n_records++].i_instr;
604
605                 tp = new_type_method(2, 1);
606                 set_method_param_type(tp, 0, int_tp);
607                 set_method_param_type(tp, 1, int_tp);
608                 set_method_res_type(tp, 0, int_tp);
609
610                 rt_iMod.ent             = new_entity(get_glob_type(), ID("__modsi3"), tp);
611                 set_entity_ld_ident(rt_iMod.ent, ID("__modsi3"));
612                 rt_iMod.mode            = mode_T;
613                 rt_iMod.res_mode        = mode_Is;
614                 rt_iMod.mem_proj_nr     = pn_Mod_M;
615                 rt_iMod.regular_proj_nr = pn_Mod_X_regular;
616                 rt_iMod.exc_proj_nr     = pn_Mod_X_except;
617                 rt_iMod.exc_mem_proj_nr = pn_Mod_M;
618                 rt_iMod.res_proj_nr     = pn_Mod_res;
619
620                 set_entity_visibility(rt_iMod.ent, ir_visibility_external);
621
622                 map_Mod->kind     = INTRINSIC_INSTR;
623                 map_Mod->op       = op_Mod;
624                 map_Mod->i_mapper = (i_mapper_func)i_mapper_RuntimeCall;
625                 map_Mod->ctx      = &rt_iMod;
626         }
627         /* ... nor an unsigned mod. */
628         {
629                 i_instr_record *map_Mod = &records[n_records++].i_instr;
630
631                 tp = new_type_method(2, 1);
632                 set_method_param_type(tp, 0, uint_tp);
633                 set_method_param_type(tp, 1, uint_tp);
634                 set_method_res_type(tp, 0, uint_tp);
635
636                 rt_uMod.ent             = new_entity(get_glob_type(), ID("__umodsi3"), tp);
637                 set_entity_ld_ident(rt_uMod.ent, ID("__umodsi3"));
638                 rt_uMod.mode            = mode_T;
639                 rt_uMod.res_mode        = mode_Iu;
640                 rt_uMod.mem_proj_nr     = pn_Mod_M;
641                 rt_uMod.regular_proj_nr = pn_Mod_X_regular;
642                 rt_uMod.exc_proj_nr     = pn_Mod_X_except;
643                 rt_uMod.exc_mem_proj_nr = pn_Mod_M;
644                 rt_uMod.res_proj_nr     = pn_Mod_res;
645
646                 set_entity_visibility(rt_uMod.ent, ir_visibility_external);
647
648                 map_Mod->kind     = INTRINSIC_INSTR;
649                 map_Mod->op       = op_Mod;
650                 map_Mod->i_mapper = (i_mapper_func)i_mapper_RuntimeCall;
651                 map_Mod->ctx      = &rt_uMod;
652         }
653
654         if (n_records > 0)
655                 lower_intrinsics(records, n_records, /*part_block_used=*/0);
656 }
657
658
659 static arm_isa_t arm_isa_template = {
660         {
661                 &arm_isa_if,           /* isa interface */
662                 &arm_gp_regs[REG_SP],  /* stack pointer */
663                 &arm_gp_regs[REG_R11], /* base pointer */
664                 &arm_reg_classes[CLASS_arm_gp],  /* static link pointer class */
665                 -1,                    /* stack direction */
666                 2,                     /* power of two stack alignment for calls, 2^2 == 4 */
667                 NULL,                  /* main environment */
668                 7,                     /* spill costs */
669                 5,                     /* reload costs */
670         },
671         0,                     /* use generic register names instead of SP, LR, PC */
672         ARM_FPU_ARCH_FPE,      /* FPU architecture */
673         NULL,                  /* current code generator */
674 };
675
676 /**
677  * Initializes the backend ISA and opens the output file.
678  */
679 static arch_env_t *arm_init(FILE *file_handle)
680 {
681         static int inited = 0;
682         arm_isa_t *isa;
683
684         if (inited)
685                 return NULL;
686
687         isa = XMALLOC(arm_isa_t);
688         memcpy(isa, &arm_isa_template, sizeof(*isa));
689
690         arm_register_init();
691
692         isa->cg  = NULL;
693         be_emit_init(file_handle);
694
695         arm_create_opcodes(&arm_irn_ops);
696         arm_handle_intrinsics();
697
698         be_gas_emit_types = false;
699
700         /* needed for the debug support */
701         be_gas_emit_switch_section(GAS_SECTION_TEXT);
702         be_emit_irprintf("%stext0:\n", be_gas_get_private_prefix());
703         be_emit_write_line();
704
705         inited = 1;
706         return &isa->arch_env;
707 }
708
709
710
711 /**
712  * Closes the output file and frees the ISA structure.
713  */
714 static void arm_done(void *self)
715 {
716         arm_isa_t *isa = self;
717
718         be_gas_emit_decls(isa->arch_env.main_env);
719
720         be_emit_exit();
721         free(self);
722 }
723
724
725 /**
726  * Report the number of register classes.
727  * If we don't have fp instructions, report only GP
728  * here to speed up register allocation (and makes dumps
729  * smaller and more readable).
730  */
731 static unsigned arm_get_n_reg_class(void)
732 {
733         return N_CLASSES;
734 }
735
736 /**
737  * Return the register class with requested index.
738  */
739 static const arch_register_class_t *arm_get_reg_class(unsigned i)
740 {
741         assert(i < N_CLASSES);
742         return &arm_reg_classes[i];
743 }
744
745 /**
746  * Get the register class which shall be used to store a value of a given mode.
747  * @param self The this pointer.
748  * @param mode The mode in question.
749  * @return A register class which can hold values of the given mode.
750  */
751 static const arch_register_class_t *arm_get_reg_class_for_mode(const ir_mode *mode)
752 {
753         if (mode_is_float(mode))
754                 return &arm_reg_classes[CLASS_arm_fpa];
755         else
756                 return &arm_reg_classes[CLASS_arm_gp];
757 }
758
759 /**
760  * Produces the type which sits between the stack args and the locals on the stack.
761  * it will contain the return address and space to store the old base pointer.
762  * @return The Firm type modeling the ABI between type.
763  */
764 static ir_type *arm_get_between_type(void *self)
765 {
766         static ir_type *between_type = NULL;
767         (void) self;
768
769         if (between_type == NULL) {
770                 between_type = new_type_class(new_id_from_str("arm_between_type"));
771                 set_type_size_bytes(between_type, 0);
772         }
773
774         return between_type;
775 }
776
777
778 typedef struct {
779         be_abi_call_flags_bits_t flags;
780         const arch_env_t *arch_env;
781         ir_graph *irg;
782 } arm_abi_env_t;
783
784 static void *arm_abi_init(const be_abi_call_t *call, const arch_env_t *arch_env, ir_graph *irg)
785 {
786         arm_abi_env_t       *env = XMALLOC(arm_abi_env_t);
787         be_abi_call_flags_t  fl  = be_abi_call_get_flags(call);
788         env->flags    = fl.bits;
789         env->irg      = irg;
790         env->arch_env = arch_env;
791         return env;
792 }
793
794 /**
795  * Generate the routine prologue.
796  *
797  * @param self       The callback object.
798  * @param mem        A pointer to the mem node. Update this if you define new memory.
799  * @param reg_map    A map mapping all callee_save/ignore/parameter registers to their defining nodes.
800  * @param stack_bias Points to the current stack bias, can be modified if needed.
801  *
802  * @return        The register which shall be used as a stack frame base.
803  *
804  * All nodes which define registers in @p reg_map must keep @p reg_map current.
805  */
806 static const arch_register_t *arm_abi_prologue(void *self, ir_node **mem, pmap *reg_map, int *stack_bias)
807 {
808         arm_abi_env_t         *env = self;
809         ir_node               *store;
810         ir_graph              *irg;
811         ir_node               *block;
812         arch_register_class_t *gp;
813
814         ir_node               *fp, *ip, *lr, *pc;
815         ir_node               *sp = be_abi_reg_map_get(reg_map, env->arch_env->sp);
816
817         (void) stack_bias;
818
819         if (env->flags.try_omit_fp)
820                 return env->arch_env->sp;
821
822         fp = be_abi_reg_map_get(reg_map, env->arch_env->bp);
823         ip = be_abi_reg_map_get(reg_map, &arm_gp_regs[REG_R12]);
824         lr = be_abi_reg_map_get(reg_map, &arm_gp_regs[REG_LR]);
825         pc = be_abi_reg_map_get(reg_map, &arm_gp_regs[REG_PC]);
826
827         gp    = &arm_reg_classes[CLASS_arm_gp];
828         irg   = env->irg;
829         block = get_irg_start_block(irg);
830
831         /* mark bp register as ignore */
832         be_set_constr_single_reg_out(get_Proj_pred(fp),
833                                      get_Proj_proj(fp), env->arch_env->bp,
834                                      arch_register_req_type_ignore);
835
836         /* copy SP to IP (so we can spill it */
837         ip = be_new_Copy(gp, block, sp);
838         be_set_constr_single_reg_out(ip, 0, &arm_gp_regs[REG_R12], 0);
839
840         /* spill stuff */
841         store = new_bd_arm_StoreStackM4Inc(NULL, block, sp, fp, ip, lr, pc, *mem);
842
843         sp = new_r_Proj(store, env->arch_env->sp->reg_class->mode, pn_arm_StoreStackM4Inc_ptr);
844         arch_set_irn_register(sp, env->arch_env->sp);
845         *mem = new_r_Proj(store, mode_M, pn_arm_StoreStackM4Inc_M);
846
847         /* frame pointer is ip-4 (because ip is our old sp value) */
848         fp = new_bd_arm_Sub_imm(NULL, block, ip, 4, 0);
849         arch_set_irn_register(fp, env->arch_env->bp);
850
851         /* beware: we change the fp but the StoreStackM4Inc above wants the old
852          * fp value. We are not allowed to spill or anything in the prolog, so we
853          * have to enforce some order here. (scheduler/regalloc are too stupid
854          * to extract this order from register requirements) */
855         add_irn_dep(fp, store);
856
857         fp = be_new_Copy(gp, block, fp); // XXX Gammelfix: only be_ have custom register requirements
858         be_set_constr_single_reg_out(fp, 0, env->arch_env->bp,
859                                      arch_register_req_type_ignore);
860         arch_set_irn_register(fp, env->arch_env->bp);
861
862         be_abi_reg_map_set(reg_map, env->arch_env->bp, fp);
863         be_abi_reg_map_set(reg_map, &arm_gp_regs[REG_R12], ip);
864         be_abi_reg_map_set(reg_map, env->arch_env->sp, sp);
865         be_abi_reg_map_set(reg_map, &arm_gp_regs[REG_LR], lr);
866         be_abi_reg_map_set(reg_map, &arm_gp_regs[REG_PC], pc);
867
868         return env->arch_env->bp;
869 }
870
871 /**
872  * Builds the ARM epilogue
873  */
874 static void arm_abi_epilogue(void *self, ir_node *bl, ir_node **mem, pmap *reg_map)
875 {
876         arm_abi_env_t *env = self;
877         ir_node *curr_sp = be_abi_reg_map_get(reg_map, env->arch_env->sp);
878         ir_node *curr_bp = be_abi_reg_map_get(reg_map, env->arch_env->bp);
879         ir_node *curr_pc = be_abi_reg_map_get(reg_map, &arm_gp_regs[REG_PC]);
880         ir_node *curr_lr = be_abi_reg_map_get(reg_map, &arm_gp_regs[REG_LR]);
881
882         // TODO: Activate Omit fp in epilogue
883         if (env->flags.try_omit_fp) {
884                 ir_node *incsp = be_new_IncSP(env->arch_env->sp, bl, curr_sp, BE_STACK_FRAME_SIZE_SHRINK, 0);
885                 curr_sp = incsp;
886         } else {
887                 ir_node *load_node;
888
889                 load_node = new_bd_arm_LoadStackM3Epilogue(NULL, bl, curr_bp, *mem);
890
891                 curr_bp = new_r_Proj(load_node, env->arch_env->bp->reg_class->mode, pn_arm_LoadStackM3Epilogue_res0);
892                 curr_sp = new_r_Proj(load_node, env->arch_env->sp->reg_class->mode, pn_arm_LoadStackM3Epilogue_res1);
893                 curr_pc = new_r_Proj(load_node, mode_Iu, pn_arm_LoadStackM3Epilogue_res2);
894                 *mem    = new_r_Proj(load_node, mode_M, pn_arm_LoadStackM3Epilogue_M);
895                 arch_set_irn_register(curr_bp, env->arch_env->bp);
896                 arch_set_irn_register(curr_sp, env->arch_env->sp);
897                 arch_set_irn_register(curr_pc, &arm_gp_regs[REG_PC]);
898         }
899         be_abi_reg_map_set(reg_map, env->arch_env->sp, curr_sp);
900         be_abi_reg_map_set(reg_map, env->arch_env->bp, curr_bp);
901         be_abi_reg_map_set(reg_map, &arm_gp_regs[REG_LR], curr_lr);
902         be_abi_reg_map_set(reg_map, &arm_gp_regs[REG_PC], curr_pc);
903 }
904
905 static const be_abi_callbacks_t arm_abi_callbacks = {
906         arm_abi_init,
907         free,
908         arm_get_between_type,
909         arm_abi_prologue,
910         arm_abi_epilogue,
911 };
912
913
914 /**
915  * Get the ABI restrictions for procedure calls.
916  * @param self        The this pointer.
917  * @param method_type The type of the method (procedure) in question.
918  * @param abi         The abi object to be modified
919  */
920 static void arm_get_call_abi(const void *self, ir_type *method_type, be_abi_call_t *abi)
921 {
922         ir_type  *tp;
923         ir_mode  *mode;
924         int       i;
925         int       n = get_method_n_params(method_type);
926         be_abi_call_flags_t call_flags = be_abi_call_get_flags(abi);
927         (void) self;
928
929         /* set abi flags for calls */
930         call_flags.bits.left_to_right         = 0;
931         call_flags.bits.store_args_sequential = 0;
932         /* call_flags.bits.try_omit_fp     don't change this we can handle both */
933         call_flags.bits.fp_free               = 0;
934         call_flags.bits.call_has_imm          = 1;  /* IA32 calls can have immediate address */
935
936         /* set stack parameter passing style */
937         be_abi_call_set_flags(abi, call_flags, &arm_abi_callbacks);
938
939         for (i = 0; i < n; i++) {
940                 /* reg = get reg for param i;          */
941                 /* be_abi_call_param_reg(abi, i, reg); */
942                 if (i < 4) {
943                         be_abi_call_param_reg(abi, i, arm_get_RegParam_reg(i), ABI_CONTEXT_BOTH);
944                 } else {
945                         tp   = get_method_param_type(method_type, i);
946                         mode = get_type_mode(tp);
947                         be_abi_call_param_stack(abi, i, mode, 4, 0, 0, ABI_CONTEXT_BOTH);
948                 }
949         }
950
951         /* set return registers */
952         n = get_method_n_ress(method_type);
953
954         assert(n <= 2 && "more than two results not supported");
955
956         /* In case of 64bit returns, we will have two 32bit values */
957         if (n == 2) {
958                 tp   = get_method_res_type(method_type, 0);
959                 mode = get_type_mode(tp);
960
961                 assert(!mode_is_float(mode) && "two FP results not supported");
962
963                 tp   = get_method_res_type(method_type, 1);
964                 mode = get_type_mode(tp);
965
966                 assert(!mode_is_float(mode) && "mixed INT, FP results not supported");
967
968                 be_abi_call_res_reg(abi, 0, &arm_gp_regs[REG_R0], ABI_CONTEXT_BOTH);
969                 be_abi_call_res_reg(abi, 1, &arm_gp_regs[REG_R1], ABI_CONTEXT_BOTH);
970         } else if (n == 1) {
971                 const arch_register_t *reg;
972
973                 tp   = get_method_res_type(method_type, 0);
974                 assert(is_atomic_type(tp));
975                 mode = get_type_mode(tp);
976
977                 reg = mode_is_float(mode) ? &arm_fpa_regs[REG_F0] : &arm_gp_regs[REG_R0];
978                 be_abi_call_res_reg(abi, 0, reg, ABI_CONTEXT_BOTH);
979         }
980 }
981
982 static int arm_to_appear_in_schedule(void *block_env, const ir_node *irn)
983 {
984         (void) block_env;
985         if (!is_arm_irn(irn))
986                 return -1;
987
988         return 1;
989 }
990
991 /**
992  * Initializes the code generator interface.
993  */
994 static const arch_code_generator_if_t *arm_get_code_generator_if(void *self)
995 {
996         (void) self;
997         return &arm_code_gen_if;
998 }
999
1000 list_sched_selector_t arm_sched_selector;
1001
1002 /**
1003  * Returns the reg_pressure scheduler with to_appear_in_schedule() over\loaded
1004  */
1005 static const list_sched_selector_t *arm_get_list_sched_selector(const void *self, list_sched_selector_t *selector)
1006 {
1007         (void) self;
1008         memcpy(&arm_sched_selector, selector, sizeof(arm_sched_selector));
1009         /* arm_sched_selector.exectime              = arm_sched_exectime; */
1010         arm_sched_selector.to_appear_in_schedule = arm_to_appear_in_schedule;
1011         return &arm_sched_selector;
1012
1013 }
1014
1015 static const ilp_sched_selector_t *arm_get_ilp_sched_selector(const void *self)
1016 {
1017         (void) self;
1018         return NULL;
1019 }
1020
1021 /**
1022  * Returns the necessary byte alignment for storing a register of given class.
1023  */
1024 static int arm_get_reg_class_alignment(const arch_register_class_t *cls)
1025 {
1026         (void) cls;
1027         /* ARM is a 32 bit CPU, no need for other alignment */
1028         return 4;
1029 }
1030
1031 static const be_execution_unit_t ***arm_get_allowed_execution_units(const ir_node *irn)
1032 {
1033         (void) irn;
1034         /* TODO */
1035         panic("Unimplemented arm_get_allowed_execution_units()");
1036 }
1037
1038 static const be_machine_t *arm_get_machine(const void *self)
1039 {
1040         (void) self;
1041         /* TODO */
1042         panic("Unimplemented arm_get_machine()");
1043 }
1044
1045 /**
1046  * Return irp irgs in the desired order.
1047  */
1048 static ir_graph **arm_get_irg_list(const void *self, ir_graph ***irg_list)
1049 {
1050         (void) self;
1051         (void) irg_list;
1052         return NULL;
1053 }
1054
1055 /**
1056  * Allows or disallows the creation of Psi nodes for the given Phi nodes.
1057  * @return 1 if allowed, 0 otherwise
1058  */
1059 static int arm_is_mux_allowed(ir_node *sel, ir_node *mux_false,
1060                               ir_node *mux_true)
1061 {
1062         (void) sel;
1063         (void) mux_false;
1064         (void) mux_true;
1065
1066         return 0;
1067 }
1068
1069 static asm_constraint_flags_t arm_parse_asm_constraint(const char **c)
1070 {
1071         /* asm not supported */
1072         (void) c;
1073         return ASM_CONSTRAINT_FLAG_INVALID;
1074 }
1075
1076 static int arm_is_valid_clobber(const char *clobber)
1077 {
1078         (void) clobber;
1079         return 0;
1080 }
1081
1082 /**
1083  * Returns the libFirm configuration parameter for this backend.
1084  */
1085 static const backend_params *arm_get_libfirm_params(void)
1086 {
1087         static const ir_settings_if_conv_t ifconv = {
1088                 4,                    /* maxdepth, doesn't matter for Psi-conversion */
1089                 arm_is_mux_allowed   /* allows or disallows Mux creation for given selector */
1090         };
1091         static ir_settings_arch_dep_t ad = {
1092                 1,    /* allow subs */
1093                 1,        /* Muls are fast enough on ARM but ... */
1094                 31,   /* ... one shift would be possible better */
1095                 NULL, /* no evaluator function */
1096                 0,    /* SMUL is needed, only in Arch M */
1097                 0,    /* UMUL is needed, only in Arch M */
1098                 32,   /* SMUL & UMUL available for 32 bit */
1099         };
1100         static backend_params p = {
1101                 1,     /* need dword lowering */
1102                 0,     /* don't support inline assembler yet */
1103                 NULL,  /* will be set later */
1104                 NULL,  /* but yet no creator function */
1105                 NULL,  /* context for create_intrinsic_fkt */
1106                 NULL,  /* ifconv_info will be set below */
1107                 NULL,  /* float arithmetic mode (TODO) */
1108                 0,     /* no trampoline support: size 0 */
1109                 0,     /* no trampoline support: align 0 */
1110                 NULL,  /* no trampoline support: no trampoline builder */
1111                 4      /* alignment of stack parameter */
1112         };
1113
1114         p.dep_param    = &ad;
1115         p.if_conv_info = &ifconv;
1116         return &p;
1117 }
1118
1119 /* fpu set architectures. */
1120 static const lc_opt_enum_int_items_t arm_fpu_items[] = {
1121         { "softfloat", ARM_FPU_ARCH_SOFTFLOAT },
1122         { "fpe",       ARM_FPU_ARCH_FPE },
1123         { "fpa",       ARM_FPU_ARCH_FPA },
1124         { "vfp1xd",    ARM_FPU_ARCH_VFP_V1xD },
1125         { "vfp1",      ARM_FPU_ARCH_VFP_V1 },
1126         { "vfp2",      ARM_FPU_ARCH_VFP_V2 },
1127         { NULL,        0 }
1128 };
1129
1130 static lc_opt_enum_int_var_t arch_fpu_var = {
1131         &arm_isa_template.fpu_arch, arm_fpu_items
1132 };
1133
1134 static const lc_opt_table_entry_t arm_options[] = {
1135         LC_OPT_ENT_ENUM_INT("fpunit",    "select the floating point unit", &arch_fpu_var),
1136         LC_OPT_ENT_BOOL("gen_reg_names", "use generic register names", &arm_isa_template.gen_reg_names),
1137         LC_OPT_LAST
1138 };
1139
1140 const arch_isa_if_t arm_isa_if = {
1141         arm_init,
1142         arm_done,
1143         NULL,  /* handle_intrinsics */
1144         arm_get_n_reg_class,
1145         arm_get_reg_class,
1146         arm_get_reg_class_for_mode,
1147         arm_get_call_abi,
1148         arm_get_code_generator_if,
1149         arm_get_list_sched_selector,
1150         arm_get_ilp_sched_selector,
1151         arm_get_reg_class_alignment,
1152         arm_get_libfirm_params,
1153         arm_get_allowed_execution_units,
1154         arm_get_machine,
1155         arm_get_irg_list,
1156         NULL,               /* mark remat */
1157         arm_parse_asm_constraint,
1158         arm_is_valid_clobber
1159 };
1160
1161 BE_REGISTER_MODULE_CONSTRUCTOR(be_init_arch_arm);
1162 void be_init_arch_arm(void)
1163 {
1164         lc_opt_entry_t *be_grp = lc_opt_get_grp(firm_opt_get_root(), "be");
1165         lc_opt_entry_t *arm_grp = lc_opt_get_grp(be_grp, "arm");
1166
1167         lc_opt_add_table(arm_grp, arm_options);
1168
1169         be_register_isa_if("arm", &arm_isa_if);
1170
1171         arm_init_transform();
1172         arm_init_emitter();
1173 }