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