Merge pull request #1099 from jsportaro/master
[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 /* Argument marshallings for calls between gsharedvt and normal code */
128 typedef enum {
129         GSHAREDVT_ARG_NONE = 0,
130         GSHAREDVT_ARG_BYVAL_TO_BYREF = 1,
131         GSHAREDVT_ARG_BYREF_TO_BYVAL = 2,
132         GSHAREDVT_ARG_BYREF_TO_BYVAL_I1 = 3,
133         GSHAREDVT_ARG_BYREF_TO_BYVAL_I2 = 4,
134         GSHAREDVT_ARG_BYREF_TO_BYVAL_U1 = 5,
135         GSHAREDVT_ARG_BYREF_TO_BYVAL_U2 = 6
136 } GSharedVtArgMarshal;
137
138 /* Return value marshalling for calls between gsharedvt and normal code */
139 typedef enum {
140         GSHAREDVT_RET_NONE = 0,
141         GSHAREDVT_RET_IREG = 1,
142         GSHAREDVT_RET_IREGS = 2,
143         GSHAREDVT_RET_I1 = 3,
144         GSHAREDVT_RET_U1 = 4,
145         GSHAREDVT_RET_I2 = 5,
146         GSHAREDVT_RET_U2 = 6
147 } GSharedVtRetMarshal;
148
149 typedef struct {
150         /* Method address to call */
151         gpointer addr;
152         /* The trampoline reads this, so keep the size explicit */
153         int ret_marshal;
154         /* If ret_marshal != NONE, this is the reg of the vret arg, else -1 */
155         int vret_arg_reg;
156         /* The stack slot where the return value will be stored */
157         int vret_slot;
158         int stack_usage, map_count;
159         /* If not -1, then make a virtual call using this vtable offset */
160         int vcall_offset;
161         /* If 1, make an indirect call to the address in the rgctx reg */
162         int calli;
163         /* Whenever this is a in or an out call */
164         int gsharedvt_in;
165         /* Maps stack slots/registers in the caller to the stack slots/registers in the callee */
166         /* A negative value means a register, i.e. -1=r0, -2=r1 etc. */
167         int map [MONO_ZERO_LEN_ARRAY];
168 } GSharedVtCallInfo;
169
170 void arm_patch (guchar *code, const guchar *target);
171 guint8* mono_arm_emit_load_imm (guint8 *code, int dreg, guint32 val);
172 int mono_arm_is_rotated_imm8 (guint32 val, gint *rot_amount);
173
174 void
175 mono_arm_throw_exception_by_token (guint32 type_token, mgreg_t pc, mgreg_t sp, mgreg_t *int_regs, gdouble *fp_regs);
176
177 gpointer
178 mono_arm_start_gsharedvt_call (GSharedVtCallInfo *info, gpointer *caller, gpointer *callee, gpointer mrgctx_reg) MONO_INTERNAL;
179
180 typedef enum {
181         MONO_ARM_FPU_NONE = 0,
182         MONO_ARM_FPU_VFP = 1,
183         MONO_ARM_FPU_VFP_HARD = 2
184 } MonoArmFPU;
185
186 /* keep the size of the structure a multiple of 8 */
187 struct MonoLMF {
188         /* 
189          * If the second lowest bit is set to 1, then this is a MonoLMFExt structure, and
190          * the other fields are not valid.
191          */
192         gpointer    previous_lmf;
193         gpointer    lmf_addr;
194         /* This is only set in trampoline LMF frames */
195         MonoMethod *method;
196         mgreg_t    sp;
197         mgreg_t    ip;
198         mgreg_t    fp;
199         /* Currently only used in trampolines on armhf to hold d0-d15. We don't really
200          * need to put d0-d7 in the LMF, but it simplifies the trampoline code.
201          */
202         double     fregs [16];
203         /* all but sp and pc: matches the PUSH instruction layout in the trampolines
204          * 0-4 should be considered undefined (execpt in the magic tramp)
205          * sp is saved at IP.
206          */
207         mgreg_t    iregs [14];
208 };
209
210 typedef struct MonoCompileArch {
211         gpointer seq_point_info_var, ss_trigger_page_var;
212         gpointer seq_point_read_var, seq_point_ss_method_var;
213         gpointer seq_point_bp_method_var;
214         gboolean omit_fp, omit_fp_computed;
215         gpointer cinfo;
216         gpointer *vfp_scratch_slots [2];
217         int atomic_tmp_offset;
218 } MonoCompileArch;
219
220 #define MONO_ARCH_EMULATE_FCONV_TO_I8 1
221 #define MONO_ARCH_EMULATE_LCONV_TO_R8 1
222 #define MONO_ARCH_EMULATE_LCONV_TO_R4 1
223 #define MONO_ARCH_EMULATE_LCONV_TO_R8_UN 1
224 #define MONO_ARCH_EMULATE_FREM 1
225 #define MONO_ARCH_EMULATE_DIV 1
226 #define MONO_ARCH_EMULATE_CONV_R8_UN 1
227 #define MONO_ARCH_EMULATE_MUL_OVF 1
228 //#define MONO_ARCH_BIGMUL_INTRINS 1
229
230 #define ARM_FIRST_ARG_REG 0
231 #define ARM_LAST_ARG_REG 3
232
233 #define MONO_ARCH_USE_SIGACTION 1
234
235 #if defined(__native_client__)
236 #undef MONO_ARCH_USE_SIGACTION
237 #endif
238
239 #define MONO_ARCH_NEED_DIV_CHECK 1
240
241 #define MONO_ARCH_HAVE_CREATE_DELEGATE_TRAMPOLINE
242 #define MONO_ARCH_HAVE_XP_UNWIND 1
243 #define MONO_ARCH_HAVE_GENERALIZED_IMT_THUNK 1
244
245 #define ARM_NUM_REG_ARGS (ARM_LAST_ARG_REG-ARM_FIRST_ARG_REG+1)
246 #define ARM_NUM_REG_FPARGS 0
247
248 #define MONO_ARCH_HAVE_FULL_AOT_TRAMPOLINES 1
249 #define MONO_ARCH_HAVE_IMT 1
250 #define MONO_ARCH_HAVE_DECOMPOSE_LONG_OPTS 1
251
252 #define MONO_ARCH_AOT_SUPPORTED 1
253 #define MONO_ARCH_LLVM_SUPPORTED 1
254 #define MONO_ARCH_THIS_AS_FIRST_ARG 1
255
256 #define MONO_ARCH_GSHARED_SUPPORTED 1
257 #define MONO_ARCH_DYN_CALL_SUPPORTED 1
258 #define MONO_ARCH_DYN_CALL_PARAM_AREA 24
259
260 #define MONO_ARCH_SOFT_DEBUG_SUPPORTED 1
261 #define MONO_ARCH_HAVE_EXCEPTIONS_INIT 1
262 #define MONO_ARCH_HAVE_GET_TRAMPOLINES 1
263 #define MONO_ARCH_HAVE_CONTEXT_SET_INT_REG 1
264 #define MONO_ARCH_HAVE_SIGCTX_TO_MONOCTX 1
265 #define MONO_ARCH_GC_MAPS_SUPPORTED 1
266 #define MONO_ARCH_HAVE_SETUP_ASYNC_CALLBACK 1
267 #define MONO_ARCH_HAVE_CONTEXT_SET_INT_REG 1
268 #define MONO_ARCH_HAVE_SETUP_RESUME_FROM_SIGNAL_HANDLER_CTX 1
269 #define MONO_ARCH_GSHAREDVT_SUPPORTED 1
270 #define MONO_ARCH_HAVE_GENERAL_RGCTX_LAZY_FETCH_TRAMPOLINE 1
271 #define MONO_ARCH_HAVE_OPCODE_NEEDS_EMULATION 1
272 #define MONO_ARCH_HAVE_OBJC_GET_SELECTOR 1
273 #ifdef __linux__
274 #define MONO_ARCH_HAVE_OP_TAIL_CALL 1
275 #endif
276 #define MONO_ARCH_HAVE_DUMMY_INIT 1
277 #define MONO_ARCH_HAVE_OPCODE_SUPPORTED 1
278 #define MONO_ARCH_HAVE_ATOMIC_EXCHANGE 1
279 #define MONO_ARCH_HAVE_ATOMIC_CAS 1
280 #define MONO_ARCH_HAVE_ATOMIC_ADD 1
281
282 #if defined(__native_client__)
283 #undef MONO_ARCH_SOFT_DEBUG_SUPPORTED
284 #undef MONO_ARCH_HAVE_SIGCTX_TO_MONOCTX
285 #undef MONO_ARCH_HAVE_CONTEXT_SET_INT_REG
286 #endif
287
288 /* Matches the HAVE_AEABI_READ_TP define in mini-arm.c */
289 #if defined(__ARM_EABI__) && defined(__linux__) && !defined(TARGET_ANDROID) && !defined(__native_client__)
290 #define MONO_ARCH_HAVE_TLS_GET 1
291 #endif
292
293 /* ARM doesn't have too many registers, so we have to use a callee saved one */
294 #define MONO_ARCH_RGCTX_REG ARMREG_V5
295 /* First argument reg */
296 #define MONO_ARCH_VTABLE_REG ARMREG_R0
297
298 #define MONO_CONTEXT_SET_LLVM_EXC_REG(ctx, exc) do { (ctx)->regs [0] = (gsize)exc; } while (0)
299
300 #define MONO_INIT_CONTEXT_FROM_FUNC(ctx,func) do {      \
301                 MONO_CONTEXT_SET_BP ((ctx), __builtin_frame_address (0));       \
302                 MONO_CONTEXT_SET_SP ((ctx), __builtin_frame_address (0));       \
303                 MONO_CONTEXT_SET_IP ((ctx), (func));    \
304         } while (0)
305
306 #define MONO_ARCH_INIT_TOP_LMF_ENTRY(lmf)
307
308 void
309 mono_arm_throw_exception (MonoObject *exc, mgreg_t pc, mgreg_t sp, mgreg_t *int_regs, gdouble *fp_regs);
310
311 void
312 mono_arm_throw_exception_by_token (guint32 type_token, mgreg_t pc, mgreg_t sp, mgreg_t *int_regs, gdouble *fp_regs);
313
314 void
315 mono_arm_resume_unwind (guint32 dummy1, mgreg_t pc, mgreg_t sp, mgreg_t *int_regs, gdouble *fp_regs);
316
317 gboolean
318 mono_arm_thumb_supported (void);
319
320 GSList*
321 mono_arm_get_exception_trampolines (gboolean aot) MONO_INTERNAL;
322
323 guint8*
324 mono_arm_get_thumb_plt_entry (guint8 *code) MONO_INTERNAL;
325
326 guint8*
327 mono_arm_patchable_b (guint8 *code, int cond);
328
329 guint8*
330 mono_arm_patchable_bl (guint8 *code, int cond);
331
332 #ifdef USE_JUMP_TABLES
333 guint8*
334 mono_arm_load_jumptable_entry_addr (guint8 *code, gpointer *jte, ARMReg reg) MONO_INTERNAL;
335
336 guint8*
337 mono_arm_load_jumptable_entry (guint8 *code, gpointer *jte, ARMReg reg) MONO_INTERNAL;
338 #endif
339
340 gboolean
341 mono_arm_is_hard_float (void) MONO_INTERNAL;
342
343 #endif /* __MONO_MINI_ARM_H__ */