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