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