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