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