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