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