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