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