Merge pull request #901 from Blewzman/FixAggregateExceptionGetBaseException
[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 #ifdef __native_client_codegen__
13 #define kNaClAlignmentARM 16
14 #define kNaClAlignmentMaskARM (kNaClAlignmentARM - 1)
15 #define kNaClLengthOfCallImm 4
16 #endif
17
18 #if defined(ARM_FPU_NONE)
19 #define MONO_ARCH_SOFT_FLOAT_FALLBACK 1
20 #endif
21
22 #if defined(__ARM_EABI__)
23 #if G_BYTE_ORDER == G_LITTLE_ENDIAN
24 #define ARM_ARCHITECTURE "armel"
25 #else
26 #define ARM_ARCHITECTURE "armeb"
27 #endif
28 #else
29 #define ARM_ARCHITECTURE "arm"
30 #endif
31
32 #if defined(ARM_FPU_VFP)
33 #define ARM_FP_MODEL "vfp"
34 #elif defined(ARM_FPU_NONE)
35 #define ARM_FP_MODEL "vfp+fallback"
36 #elif defined(ARM_FPU_VFP_HARD)
37 #define ARM_FP_MODEL "vfp+hard"
38 #else
39 #error "At least one of ARM_FPU_NONE, 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
56 #define MONO_SAVED_GREGS 10 /* r4-r11, ip, lr */
57
58 /* r4-r11, ip, lr: registers saved in the LMF  */
59 #define MONO_ARM_REGSAVE_MASK 0x5ff0
60 #define MONO_ARM_FIRST_SAVED_REG ARMREG_R4
61 #define MONO_ARM_NUM_SAVED_REGS 10
62
63 /* Parameters used by the register allocator */
64
65 #define MONO_ARCH_CALLEE_REGS ((1<<ARMREG_R0) | (1<<ARMREG_R1) | (1<<ARMREG_R2) | (1<<ARMREG_R3) | (1<<ARMREG_IP))
66 #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))
67
68 /*
69  * TODO: Make use of VFP v3 registers d16-d31.
70  */
71
72 /*
73  * TODO: We can't use registers d8-d15 in hard float mode because the
74  * register allocator doesn't allocate floating point registers globally.
75  */
76
77 #if defined(ARM_FPU_VFP_HARD)
78 #define MONO_SAVED_FREGS 16
79 #define MONO_MAX_FREGS 32
80
81 /*
82  * d8-d15 must be preserved across function calls. We use d14-d15 as
83  * scratch registers in the JIT. The rest have no meaning tied to them.
84  */
85 #define MONO_ARCH_CALLEE_FREGS 0x00005555
86 #define MONO_ARCH_CALLEE_SAVED_FREGS 0x55550000
87 #else
88 #define MONO_SAVED_FREGS 8
89 #define MONO_MAX_FREGS 16
90
91 /*
92  * No registers need to be preserved across function calls. We use d0-d1
93  * as scratch registers in the JIT. The rest have no meaning tied to them.
94  */
95 #define MONO_ARCH_CALLEE_FREGS 0x55555550
96 #define MONO_ARCH_CALLEE_SAVED_FREGS 0x00000000
97 #endif
98
99 #define MONO_ARCH_USE_FPSTACK FALSE
100 #define MONO_ARCH_FPSTACK_SIZE 0
101
102 #define MONO_ARCH_INST_SREG2_MASK(ins) (0)
103
104 #define MONO_ARCH_INST_FIXED_REG(desc) \
105         (mono_arch_is_soft_float () ? \
106         ((desc) == 'l' || (desc) == 'f' || (desc) == 'g' ? ARM_LSW_REG : (desc) == 'a' ? ARMREG_R0 : -1) : \
107         ((desc) == 'l' ? ARM_LSW_REG : (desc) == 'a' ? ARMREG_R0 : -1))
108
109 #define MONO_ARCH_INST_IS_REGPAIR(desc) \
110         (mono_arch_is_soft_float () ? \
111         ((desc) == 'l' || (desc) == 'L' || (desc) == 'f' || (desc) == 'g') : \
112         ((desc) == 'l' || (desc) == 'L'))
113
114 #define MONO_ARCH_INST_IS_FLOAT(desc) \
115         (mono_arch_is_soft_float () ? \
116         (FALSE) : \
117         ((desc) == 'f' || (desc) == 'g'))
118
119 #define MONO_ARCH_INST_REGPAIR_REG2(desc,hreg1) ((desc) == 'l' || (desc) == 'f' || (desc) == 'g' ? ARM_MSW_REG : -1)
120
121 #define MONO_ARCH_FRAME_ALIGNMENT 8
122
123 /* fixme: align to 16byte instead of 32byte (we align to 32byte to get 
124  * reproduceable results for benchmarks */
125 #define MONO_ARCH_CODE_ALIGNMENT 32
126
127 /* Return value marshalling for calls between gsharedvt and normal code */
128 typedef enum {
129         GSHAREDVT_RET_NONE = 0,
130         GSHAREDVT_RET_IREG = 1,
131         GSHAREDVT_RET_IREGS = 2,
132         GSHAREDVT_RET_I1 = 3,
133         GSHAREDVT_RET_U1 = 4,
134         GSHAREDVT_RET_I2 = 5,
135         GSHAREDVT_RET_U2 = 6
136 } GSharedVtRetMarshal;
137
138 typedef struct {
139         /* Method address to call */
140         gpointer addr;
141         /* The trampoline reads this, so keep the size explicit */
142         int ret_marshal;
143         /* If ret_marshal != NONE, this is the reg of the vret arg, else -1 */
144         int vret_arg_reg;
145         /* The stack slot where the return value will be stored */
146         int vret_slot;
147         int stack_usage, map_count;
148         /* If not -1, then make a virtual call using this vtable offset */
149         int vcall_offset;
150         /* If 1, make an indirect call to the address in the rgctx reg */
151         int calli;
152         /* Whenever this is a in or an out call */
153         int gsharedvt_in;
154         /* Maps stack slots/registers in the caller to the stack slots/registers in the callee */
155         /* A negative value means a register, i.e. -1=r0, -2=r1 etc. */
156         int map [MONO_ZERO_LEN_ARRAY];
157 } GSharedVtCallInfo;
158
159 void arm_patch (guchar *code, const guchar *target);
160 guint8* mono_arm_emit_load_imm (guint8 *code, int dreg, guint32 val);
161 int mono_arm_is_rotated_imm8 (guint32 val, gint *rot_amount);
162
163 void
164 mono_arm_throw_exception_by_token (guint32 type_token, mgreg_t pc, mgreg_t sp, mgreg_t *int_regs, gdouble *fp_regs);
165
166 gpointer
167 mono_arm_start_gsharedvt_call (GSharedVtCallInfo *info, gpointer *caller, gpointer *callee, gpointer mrgctx_reg) MONO_INTERNAL;
168
169 typedef enum {
170         MONO_ARM_FPU_NONE = 0,
171         MONO_ARM_FPU_VFP = 1,
172         MONO_ARM_FPU_VFP_HARD = 2
173 } MonoArmFPU;
174
175 /* keep the size of the structure a multiple of 8 */
176 struct MonoLMF {
177         /* 
178          * If the second lowest bit is set to 1, then this is a MonoLMFExt structure, and
179          * the other fields are not valid.
180          */
181         gpointer    previous_lmf;
182         gpointer    lmf_addr;
183         /* This is only set in trampoline LMF frames */
184         MonoMethod *method;
185         mgreg_t    sp;
186         mgreg_t    ip;
187         mgreg_t    fp;
188         /* Currently only used in trampolines on armhf to hold d0-d15. We don't really
189          * need to put d0-d7 in the LMF, but it simplifies the trampoline code.
190          */
191         double     fregs [16];
192         /* all but sp and pc: matches the PUSH instruction layout in the trampolines
193          * 0-4 should be considered undefined (execpt in the magic tramp)
194          * sp is saved at IP.
195          */
196         mgreg_t    iregs [14];
197 };
198
199 typedef struct MonoCompileArch {
200         gpointer seq_point_info_var, ss_trigger_page_var;
201         gpointer seq_point_read_var, seq_point_ss_method_var;
202         gpointer seq_point_bp_method_var;
203         gboolean omit_fp, omit_fp_computed;
204         gpointer cinfo;
205 } MonoCompileArch;
206
207 #define MONO_ARCH_EMULATE_FCONV_TO_I8 1
208 #define MONO_ARCH_EMULATE_LCONV_TO_R8 1
209 #define MONO_ARCH_EMULATE_LCONV_TO_R4 1
210 #define MONO_ARCH_EMULATE_LCONV_TO_R8_UN 1
211 #define MONO_ARCH_EMULATE_FREM 1
212 #define MONO_ARCH_EMULATE_DIV 1
213 #define MONO_ARCH_EMULATE_CONV_R8_UN 1
214 #define MONO_ARCH_EMULATE_MUL_OVF 1
215 //#define MONO_ARCH_BIGMUL_INTRINS 1
216
217 #define ARM_FIRST_ARG_REG 0
218 #define ARM_LAST_ARG_REG 3
219
220 #define MONO_ARCH_USE_SIGACTION 1
221
222 #if defined(__native_client__)
223 #undef MONO_ARCH_USE_SIGACTION
224 #endif
225
226 #define MONO_ARCH_NEED_DIV_CHECK 1
227
228 #define MONO_ARCH_HAVE_CREATE_DELEGATE_TRAMPOLINE
229 #define MONO_ARCH_HAVE_XP_UNWIND 1
230 #define MONO_ARCH_HAVE_GENERALIZED_IMT_THUNK 1
231
232 #define ARM_NUM_REG_ARGS (ARM_LAST_ARG_REG-ARM_FIRST_ARG_REG+1)
233 #define ARM_NUM_REG_FPARGS 0
234
235 #define MONO_ARCH_HAVE_FULL_AOT_TRAMPOLINES 1
236 #define MONO_ARCH_HAVE_IMT 1
237 #define MONO_ARCH_HAVE_DECOMPOSE_LONG_OPTS 1
238
239 #define MONO_ARCH_AOT_SUPPORTED 1
240 #define MONO_ARCH_LLVM_SUPPORTED 1
241 #define MONO_ARCH_THIS_AS_FIRST_ARG 1
242
243 #define MONO_ARCH_GSHARED_SUPPORTED 1
244 #define MONO_ARCH_DYN_CALL_SUPPORTED 1
245 #define MONO_ARCH_DYN_CALL_PARAM_AREA 24
246
247 #define MONO_ARCH_SOFT_DEBUG_SUPPORTED 1
248 #define MONO_ARCH_HAVE_EXCEPTIONS_INIT 1
249 #define MONO_ARCH_HAVE_GET_TRAMPOLINES 1
250 #define MONO_ARCH_HAVE_CONTEXT_SET_INT_REG 1
251 #define MONO_ARCH_HAVE_SIGCTX_TO_MONOCTX 1
252 #define MONO_ARCH_GC_MAPS_SUPPORTED 1
253 #define MONO_ARCH_HAVE_SETUP_ASYNC_CALLBACK 1
254 #define MONO_ARCH_HAVE_CONTEXT_SET_INT_REG 1
255 #define MONO_ARCH_HAVE_SETUP_RESUME_FROM_SIGNAL_HANDLER_CTX 1
256 #define MONO_ARCH_GSHAREDVT_SUPPORTED 1
257 #define MONO_ARCH_HAVE_GENERAL_RGCTX_LAZY_FETCH_TRAMPOLINE 1
258 #define MONO_ARCH_HAVE_OPCODE_NEEDS_EMULATION 1
259 #define MONO_ARCH_HAVE_OBJC_GET_SELECTOR 1
260
261 #if defined(__native_client__)
262 #undef MONO_ARCH_SOFT_DEBUG_SUPPORTED
263 #undef MONO_ARCH_HAVE_SIGCTX_TO_MONOCTX
264 #undef MONO_ARCH_HAVE_CONTEXT_SET_INT_REG
265 #endif
266
267 /* Matches the HAVE_AEABI_READ_TP define in mini-arm.c */
268 #if defined(__ARM_EABI__) && defined(__linux__) && !defined(TARGET_ANDROID) && !defined(__native_client__)
269 #define MONO_ARCH_HAVE_TLS_GET 1
270 #endif
271
272 /* ARM doesn't have too many registers, so we have to use a callee saved one */
273 #define MONO_ARCH_RGCTX_REG ARMREG_V5
274 /* First argument reg */
275 #define MONO_ARCH_VTABLE_REG ARMREG_R0
276
277 #define MONO_CONTEXT_SET_LLVM_EXC_REG(ctx, exc) do { (ctx)->regs [0] = (gsize)exc; } while (0)
278
279 #define MONO_INIT_CONTEXT_FROM_FUNC(ctx,func) do {      \
280                 MONO_CONTEXT_SET_BP ((ctx), __builtin_frame_address (0));       \
281                 MONO_CONTEXT_SET_SP ((ctx), __builtin_frame_address (0));       \
282                 MONO_CONTEXT_SET_IP ((ctx), (func));    \
283         } while (0)
284
285 #define MONO_ARCH_INIT_TOP_LMF_ENTRY(lmf)
286
287 void
288 mono_arm_throw_exception (MonoObject *exc, mgreg_t pc, mgreg_t sp, mgreg_t *int_regs, gdouble *fp_regs);
289
290 void
291 mono_arm_throw_exception_by_token (guint32 type_token, mgreg_t pc, mgreg_t sp, mgreg_t *int_regs, gdouble *fp_regs);
292
293 void
294 mono_arm_resume_unwind (guint32 dummy1, mgreg_t pc, mgreg_t sp, mgreg_t *int_regs, gdouble *fp_regs);
295
296 gboolean
297 mono_arm_thumb_supported (void);
298
299 GSList*
300 mono_arm_get_exception_trampolines (gboolean aot) MONO_INTERNAL;
301
302 guint8*
303 mono_arm_get_thumb_plt_entry (guint8 *code) MONO_INTERNAL;
304
305 guint8*
306 mono_arm_patchable_b (guint8 *code, int cond);
307
308 guint8*
309 mono_arm_patchable_bl (guint8 *code, int cond);
310
311 #ifdef USE_JUMP_TABLES
312 guint8*
313 mono_arm_load_jumptable_entry_addr (guint8 *code, gpointer *jte, ARMReg reg) MONO_INTERNAL;
314
315 guint8*
316 mono_arm_load_jumptable_entry (guint8 *code, gpointer *jte, ARMReg reg) MONO_INTERNAL;
317 #endif
318
319 gboolean
320 mono_arm_is_hard_float (void) MONO_INTERNAL;
321
322 #endif /* __MONO_MINI_ARM_H__ */