660c3696a347e7fb6e38a1c7f6eb8670be943837
[mono.git] / mono / mini / mini-arm.h
1 /*
2  * Copyright 2011 Xamarin Inc
3  */
4
5 #ifndef __MONO_MINI_ARM_H__
6 #define __MONO_MINI_ARM_H__
7
8 #include <mono/arch/arm/arm-codegen.h>
9 #include <mono/utils/mono-context.h>
10 #include <glib.h>
11
12 #if defined(ARM_FPU_NONE) || (defined(__ARM_EABI__) && !defined(ARM_FPU_VFP) && !defined(ARM_FPU_VFP_HARD))
13 #define MONO_ARCH_SOFT_FLOAT 1
14 #endif
15
16 #ifdef ARM_FPU_VFP_HARD
17 #error "hardfp-abi not yet supported."
18 #endif
19
20 #if defined(__ARM_EABI__)
21 #if G_BYTE_ORDER == G_LITTLE_ENDIAN
22 #define ARM_ARCHITECTURE "armel"
23 #else
24 #define ARM_ARCHITECTURE "armeb"
25 #endif
26 #else
27 #define ARM_ARCHITECTURE "arm"
28 #endif
29
30 #if defined(ARM_FPU_FPA)
31 #define ARM_FP_MODEL "fpa"
32 #elif defined(ARM_FPU_VFP)
33 #define ARM_FP_MODEL "vfp"
34 #elif defined(ARM_FPU_NONE)
35 #define ARM_FP_MODEL "soft-float"
36 #elif defined(ARM_FPU_VFP_HARD)
37 #define ARM_FP_MODEL "vfp(hardfp-abi)"
38 #else
39 #error "At least one of ARM_FPU_NONE, ARM_FPU_FPA, ARM_FPU_VFP or ARM_FPU_VFP_HARD must be defined."
40 #endif
41
42 #define MONO_ARCH_ARCHITECTURE ARM_ARCHITECTURE "," ARM_FP_MODEL
43
44 #define MONO_ARCH_CPU_SPEC arm_cpu_desc
45
46 #if G_BYTE_ORDER == G_LITTLE_ENDIAN
47 #define ARM_LSW_REG ARMREG_R0
48 #define ARM_MSW_REG ARMREG_R1
49 #else
50 #define ARM_LSW_REG ARMREG_R1
51 #define ARM_MSW_REG ARMREG_R0
52 #endif
53
54 #define MONO_MAX_IREGS 16
55 #define MONO_MAX_FREGS 16
56
57 #define MONO_SAVED_GREGS 10 /* r4-r11, ip, lr */
58 #define MONO_SAVED_FREGS 8
59
60 /* r4-r11, ip, lr: registers saved in the LMF  */
61 #define MONO_ARM_REGSAVE_MASK 0x5ff0
62 #define MONO_ARM_FIRST_SAVED_REG ARMREG_R4
63 #define MONO_ARM_NUM_SAVED_REGS 10
64
65 /* Parameters used by the register allocator */
66
67 #define MONO_ARCH_CALLEE_REGS ((1<<ARMREG_R0) | (1<<ARMREG_R1) | (1<<ARMREG_R2) | (1<<ARMREG_R3) | (1<<ARMREG_IP))
68 #define MONO_ARCH_CALLEE_SAVED_REGS ((1<<ARMREG_V1) | (1<<ARMREG_V2) | (1<<ARMREG_V3) | (1<<ARMREG_V4) | (1<<ARMREG_V5) | (1<<ARMREG_V6) | (1<<ARMREG_V7))
69
70 #if defined(ARM_FPU_VFP) || defined(ARM_FPU_VFP_HARD)
71 /* Every double precision vfp register, d0/d1 is reserved for a scratch reg */
72 #define MONO_ARCH_CALLEE_FREGS 0x55555550
73 #else
74 #define MONO_ARCH_CALLEE_FREGS 0xf
75 #endif
76 #define MONO_ARCH_CALLEE_SAVED_FREGS 0
77
78 #define MONO_ARCH_USE_FPSTACK FALSE
79 #define MONO_ARCH_FPSTACK_SIZE 0
80
81 #define MONO_ARCH_INST_SREG2_MASK(ins) (0)
82
83 #ifdef MONO_ARCH_SOFT_FLOAT
84 #define MONO_ARCH_INST_FIXED_REG(desc) (((desc) == 'l' || (desc == 'f') || (desc == 'g')) ? ARM_LSW_REG: (((desc) == 'a') ? ARMREG_R0 : -1))
85 #define MONO_ARCH_INST_IS_REGPAIR(desc) ((desc) == 'l' || (desc) == 'L' || (desc) == 'f' || (desc) == 'g')
86 #define MONO_ARCH_INST_IS_FLOAT(desc) (FALSE)
87 #else
88 #define MONO_ARCH_INST_FIXED_REG(desc) (((desc) == 'l')? ARM_LSW_REG: (((desc) == 'a') ? ARMREG_R0 : -1))
89 #define MONO_ARCH_INST_IS_REGPAIR(desc) (desc == 'l' || desc == 'L')
90 #define MONO_ARCH_INST_IS_FLOAT(desc) ((desc == 'f') || (desc == 'g'))
91 #endif
92 #define MONO_ARCH_INST_REGPAIR_REG2(desc,hreg1) (desc == 'l'  || (desc == 'f') || (desc == 'g')? ARM_MSW_REG : -1)
93
94 #define MONO_ARCH_FRAME_ALIGNMENT 8
95
96 /* fixme: align to 16byte instead of 32byte (we align to 32byte to get 
97  * reproduceable results for benchmarks */
98 #define MONO_ARCH_CODE_ALIGNMENT 32
99
100
101 /* Return value marshalling for calls between gsharedvt and normal code */
102 typedef enum {
103         GSHAREDVT_RET_NONE = 0,
104         GSHAREDVT_RET_IREGS = 1,
105         GSHAREDVT_RET_I1 = 5,
106         GSHAREDVT_RET_U1 = 6,
107         GSHAREDVT_RET_I2 = 7,
108         GSHAREDVT_RET_U2 = 8
109 } GSharedVtRetMarshal;
110
111 typedef struct {
112         /* Method address to call */
113         gpointer addr;
114         /* The trampoline reads this, so keep the size explicit */
115         int ret_marshal;
116         /* If ret_marshal != NONE, this is the reg of the vret arg, else -1 */
117         int vret_arg_reg;
118         /* The stack slot where the return value will be stored */
119         int vret_slot;
120         int stack_usage, map_count;
121         /* If not -1, then make a virtual call using this vtable offset */
122         int vcall_offset;
123         /* If 1, make an indirect call to the address in the rgctx reg */
124         int calli;
125         /* Whenever this is a in or an out call */
126         int gsharedvt_in;
127         /* Maps stack slots/registers in the caller to the stack slots/registers in the callee */
128         /* A negative value means a register, i.e. -1=r0, -2=r1 etc. */
129         int map [MONO_ZERO_LEN_ARRAY];
130 } GSharedVtCallInfo;
131
132 void arm_patch (guchar *code, const guchar *target);
133 guint8* mono_arm_emit_load_imm (guint8 *code, int dreg, guint32 val);
134 int mono_arm_is_rotated_imm8 (guint32 val, gint *rot_amount);
135
136 void
137 mono_arm_throw_exception_by_token (guint32 type_token, mgreg_t pc, mgreg_t sp, mgreg_t *int_regs, gdouble *fp_regs);
138
139 gpointer
140 mono_arm_start_gsharedvt_call (GSharedVtCallInfo *info, gpointer *caller, gpointer *callee, gpointer *caller_regs, gpointer *callee_regs, gpointer mrgctx_reg) MONO_INTERNAL;
141
142 typedef enum {
143         MONO_ARM_FPU_NONE = 0,
144         MONO_ARM_FPU_FPA = 1,
145         MONO_ARM_FPU_VFP = 2,
146         MONO_ARM_FPU_VFP_HARD = 3
147 } MonoArmFPU;
148
149 /* keep the size of the structure a multiple of 8 */
150 struct MonoLMF {
151         /* 
152          * If the second lowest bit is set to 1, then this is a MonoLMFExt structure, and
153          * the other fields are not valid.
154          */
155         gpointer    previous_lmf;
156         gpointer    lmf_addr;
157         /* This is only set in trampoline LMF frames */
158         MonoMethod *method;
159         mgreg_t    sp;
160         mgreg_t    ip;
161         mgreg_t    fp;
162         /* all but sp and pc: matches the PUSH instruction layout in the trampolines
163          * 0-4 should be considered undefined (execpt in the magic tramp)
164          * sp is saved at IP.
165          */
166         mgreg_t    iregs [14];
167 };
168
169 typedef struct MonoCompileArch {
170         gpointer seq_point_info_var, ss_trigger_page_var;
171         gpointer seq_point_read_var, seq_point_ss_method_var;
172         gpointer seq_point_bp_method_var;
173         gboolean omit_fp, omit_fp_computed;
174         gpointer cinfo;
175 } MonoCompileArch;
176
177 #define MONO_ARCH_EMULATE_FCONV_TO_I8 1
178 #define MONO_ARCH_EMULATE_LCONV_TO_R8 1
179 #define MONO_ARCH_EMULATE_LCONV_TO_R4 1
180 #define MONO_ARCH_EMULATE_LCONV_TO_R8_UN 1
181 #define MONO_ARCH_EMULATE_FREM 1
182 #define MONO_ARCH_EMULATE_DIV 1
183 #define MONO_ARCH_EMULATE_CONV_R8_UN 1
184 #define MONO_ARCH_EMULATE_MUL_OVF 1
185 //#define MONO_ARCH_BIGMUL_INTRINS 1
186
187 #define ARM_FIRST_ARG_REG 0
188 #define ARM_LAST_ARG_REG 3
189
190 #define MONO_ARCH_USE_SIGACTION 1
191 #define MONO_ARCH_NEED_DIV_CHECK 1
192
193 #define MONO_ARCH_HAVE_CREATE_DELEGATE_TRAMPOLINE
194 #define MONO_ARCH_HAVE_XP_UNWIND 1
195 #define MONO_ARCH_HAVE_GENERALIZED_IMT_THUNK 1
196
197 #define ARM_NUM_REG_ARGS (ARM_LAST_ARG_REG-ARM_FIRST_ARG_REG+1)
198 #define ARM_NUM_REG_FPARGS 0
199
200 #define MONO_ARCH_HAVE_FULL_AOT_TRAMPOLINES 1
201 #define MONO_ARCH_HAVE_IMT 1
202 #define MONO_ARCH_HAVE_DECOMPOSE_LONG_OPTS 1
203
204 #define MONO_ARCH_AOT_SUPPORTED 1
205 #define MONO_ARCH_LLVM_SUPPORTED 1
206 #define MONO_ARCH_THIS_AS_FIRST_ARG 1
207
208 #define MONO_ARCH_GSHARED_SUPPORTED 1
209 #define MONO_ARCH_DYN_CALL_SUPPORTED 1
210 #define MONO_ARCH_DYN_CALL_PARAM_AREA 24
211
212 #define MONO_ARCH_SOFT_DEBUG_SUPPORTED 1
213 #define MONO_ARCH_HAVE_EXCEPTIONS_INIT 1
214 #define MONO_ARCH_HAVE_GET_TRAMPOLINES 1
215 #define MONO_ARCH_HAVE_CONTEXT_SET_INT_REG 1
216 #define MONO_ARCH_HAVE_SIGCTX_TO_MONOCTX 1
217 #define MONO_ARCH_GC_MAPS_SUPPORTED 1
218 #define MONO_ARCH_HAVE_SETUP_ASYNC_CALLBACK 1
219 #define MONO_ARCH_HAVE_CONTEXT_SET_INT_REG 1
220 #define MONO_ARCH_HAVE_SETUP_RESUME_FROM_SIGNAL_HANDLER_CTX 1
221 #define MONO_ARCH_GSHAREDVT_SUPPORTED 1
222 #define MONO_ARCH_HAVE_GENERAL_RGCTX_LAZY_FETCH_TRAMPOLINE 1
223
224 /* Matches the HAVE_AEABI_READ_TP define in mini-arm.c */
225 #if defined(__ARM_EABI__) && defined(__linux__) && !defined(TARGET_ANDROID)
226 #define MONO_ARCH_HAVE_TLS_GET 1
227 #endif
228
229 /* ARM doesn't have too many registers, so we have to use a callee saved one */
230 #define MONO_ARCH_RGCTX_REG ARMREG_V5
231 /* First argument reg */
232 #define MONO_ARCH_VTABLE_REG ARMREG_R0
233
234 #define MONO_CONTEXT_SET_LLVM_EXC_REG(ctx, exc) do { (ctx)->regs [0] = (gsize)exc; } while (0)
235
236 #define MONO_INIT_CONTEXT_FROM_FUNC(ctx,func) do {      \
237                 MONO_CONTEXT_SET_BP ((ctx), __builtin_frame_address (0));       \
238                 MONO_CONTEXT_SET_SP ((ctx), __builtin_frame_address (0));       \
239                 MONO_CONTEXT_SET_IP ((ctx), (func));    \
240         } while (0)
241
242 #define MONO_ARCH_INIT_TOP_LMF_ENTRY(lmf)
243
244 void
245 mono_arm_throw_exception (MonoObject *exc, mgreg_t pc, mgreg_t sp, mgreg_t *int_regs, gdouble *fp_regs);
246
247 void
248 mono_arm_throw_exception_by_token (guint32 type_token, mgreg_t pc, mgreg_t sp, mgreg_t *int_regs, gdouble *fp_regs);
249
250 void
251 mono_arm_resume_unwind (guint32 dummy1, mgreg_t pc, mgreg_t sp, mgreg_t *int_regs, gdouble *fp_regs);
252
253 gboolean
254 mono_arm_thumb_supported (void);
255
256 GSList*
257 mono_arm_get_exception_trampolines (gboolean aot) MONO_INTERNAL;
258
259 guint8*
260 mono_arm_get_thumb_plt_entry (guint8 *code) MONO_INTERNAL;
261
262 #endif /* __MONO_MINI_ARM_H__ */
263