c7cd1fb1262f4f40dc91cf98e148f5f1f61fd03c
[mono.git] / mono / mini / mini-arm64.h
1 /**
2  * \file
3  *
4  * Copyright 2013 Xamarin Inc
5  *
6  * Based on mini-arm.h:
7  *
8  * Copyright 2011 Xamarin Inc
9  * Licensed under the MIT license. See LICENSE file in the project root for full license information.
10  */
11
12 #ifndef __MONO_MINI_ARM64_H__
13 #define __MONO_MINI_ARM64_H__
14
15 #include <mono/arch/arm64/arm64-codegen.h>
16 #include <mono/mini/mini-arm64-gsharedvt.h>
17
18 #define MONO_ARCH_CPU_SPEC mono_arm64_cpu_desc
19
20 #define MONO_MAX_IREGS 32
21 #define MONO_MAX_FREGS 32
22
23 #define MONO_CONTEXT_SET_LLVM_EXC_REG(ctx, exc) do { (ctx)->regs [0] = (gsize)exc; } while (0)
24
25 #define MONO_INIT_CONTEXT_FROM_FUNC(ctx,func) do {      \
26                 MONO_CONTEXT_SET_BP ((ctx), __builtin_frame_address (0));       \
27                 MONO_CONTEXT_SET_SP ((ctx), __builtin_frame_address (0));       \
28                 MONO_CONTEXT_SET_IP ((ctx), (func));    \
29         } while (0)
30
31 #define MONO_ARCH_INIT_TOP_LMF_ENTRY(lmf)
32
33 /* Parameters used by the register allocator */
34 /* r0..r7, r9..r14 (r15 is the imt/rgctx reg) */
35 #define MONO_ARCH_CALLEE_REGS 0xfeff
36 /* r19..r28 */
37 #define MONO_ARCH_CALLEE_SAVED_REGS (0x3ff << 19)
38
39 /* v16/v17 is reserved for a scratch reg */
40 #define MONO_ARCH_CALLEE_FREGS 0xfffc00ff
41 /* v8..v15 */
42 #define MONO_ARCH_CALLEE_SAVED_FREGS 0xff00
43
44 #define MONO_ARCH_USE_FPSTACK FALSE
45 #define MONO_ARCH_FPSTACK_SIZE 0
46
47 #define MONO_ARCH_INST_SREG2_MASK(ins) (0)
48
49 #define MONO_ARCH_INST_FIXED_REG(desc) ((desc) == 'a' ? ARMREG_R0 : -1)
50
51 #define MONO_ARCH_INST_IS_REGPAIR(desc) (0)
52
53 #define MONO_ARCH_INST_IS_FLOAT(desc) ((desc) == 'f')
54
55 #define MONO_ARCH_INST_REGPAIR_REG2(desc,hreg1) (-1)
56
57 #define MONO_ARCH_USE_FPSTACK FALSE
58
59 #define MONO_ARCH_FRAME_ALIGNMENT 16
60
61 #define MONO_ARCH_CODE_ALIGNMENT 32
62
63 /* callee saved regs + fp + sp */
64 #define MONO_ARCH_LMF_REGS ((0x3ff << 19) | (1 << ARMREG_FP) | (1 << ARMREG_SP))
65 #define MONO_ARCH_NUM_LMF_REGS (10 + 2)
66 #define MONO_ARCH_FIRST_LMF_REG ARMREG_R19
67 #define MONO_ARCH_LMF_REG_FP 10
68 #define MONO_ARCH_LMF_REG_SP 11
69
70 struct MonoLMF {
71         /* 
72          * If the second lowest bit is set to 1, then this is a MonoLMFExt structure, and
73          * the other fields are not valid.
74          */
75         gpointer    previous_lmf;
76         gpointer    lmf_addr;
77         mgreg_t    pc;
78         mgreg_t    gregs [MONO_ARCH_NUM_LMF_REGS];
79 };
80
81 /* Structure used by the sequence points in AOTed code */
82 typedef struct {
83         gpointer ss_trigger_page;
84         gpointer bp_trigger_page;
85         gpointer ss_tramp_addr;
86         guint8* bp_addrs [MONO_ZERO_LEN_ARRAY];
87 } SeqPointInfo;
88
89 #define PARAM_REGS 8
90 #define FP_PARAM_REGS 8
91
92 #define DYN_CALL_STACK_ARGS 6
93
94 typedef struct {
95         /* The +1 is for r8 */
96         mgreg_t regs [PARAM_REGS + 1 + DYN_CALL_STACK_ARGS];
97         mgreg_t res, res2;
98         guint8 *ret;
99         double fpregs [FP_PARAM_REGS];
100         int n_fpargs, n_fpret;
101         guint8 buffer [256];
102 } DynCallArgs;
103
104 typedef struct {
105         gpointer cinfo;
106         int saved_gregs_offset;
107         /* Points to arguments received on the stack */
108         int args_reg;
109         gboolean cond_branch_islands;
110         gpointer vret_addr_loc;
111         gpointer seq_point_info_var;
112         gpointer ss_tramp_var;
113         gpointer bp_tramp_var;
114         guint8 *thunks;
115         int thunks_size;
116 } MonoCompileArch;
117
118 #define MONO_ARCH_EMULATE_FREM 1
119 #define MONO_ARCH_NO_EMULATE_LONG_MUL_OPTS 1
120 #define MONO_ARCH_EMULATE_LONG_MUL_OVF_OPTS 1
121 #define MONO_ARCH_NO_EMULATE_LONG_SHIFT_OPS 1
122 #define MONO_ARCH_NEED_DIV_CHECK 1
123 #define MONO_ARCH_EMULATE_MUL_OVF 1
124 #define MONO_ARCH_HAVE_IMT 1
125 #define MONO_ARCH_HAVE_OP_TAIL_CALL 1
126 #define MONO_ARCH_THIS_AS_FIRST_ARG 1
127 #define MONO_ARCH_RGCTX_REG ARMREG_R15
128 #define MONO_ARCH_IMT_REG MONO_ARCH_RGCTX_REG
129 #define MONO_ARCH_VTABLE_REG ARMREG_R0
130 #define MONO_ARCH_EXC_REG ARMREG_R0
131 #define MONO_ARCH_HAVE_XP_UNWIND 1
132 #define MONO_ARCH_HAVE_CREATE_DELEGATE_TRAMPOLINE 1
133 #define MONO_ARCH_HAVE_GENERALIZED_IMT_TRAMPOLINE 1
134 #define MONO_ARCH_USE_SIGACTION 1
135 #define MONO_ARCH_HAVE_SIGCTX_TO_MONOCTX 1
136 #define MONO_ARCH_HAVE_CONTEXT_SET_INT_REG 1
137 #define MONO_ARCH_GSHARED_SUPPORTED 1
138 #define MONO_ARCH_AOT_SUPPORTED 1
139 #define MONO_ARCH_LLVM_SUPPORTED 1
140 #define MONO_ARCH_HAVE_FULL_AOT_TRAMPOLINES 1
141 #define MONO_ARCH_HAVE_EXCEPTIONS_INIT 1
142 #define MONO_ARCH_HAVE_GET_TRAMPOLINES 1
143 #define MONO_ARCH_DYN_CALL_SUPPORTED 1
144 #define MONO_ARCH_DYN_CALL_PARAM_AREA (DYN_CALL_STACK_ARGS * 8)
145 #define MONO_ARCH_SOFT_DEBUG_SUPPORTED 1
146 #define MONO_ARCH_GSHAREDVT_SUPPORTED 1
147 #define MONO_ARCH_HAVE_SETUP_RESUME_FROM_SIGNAL_HANDLER_CTX 1
148 #define MONO_ARCH_HAVE_SETUP_ASYNC_CALLBACK 1
149 #define MONO_ARCH_HAVE_GENERAL_RGCTX_LAZY_FETCH_TRAMPOLINE 1
150 #define MONO_ARCH_HAVE_OP_GET_EX_OBJ 1
151 #define MONO_ARCH_HAVE_OBJC_GET_SELECTOR 1
152 #define MONO_ARCH_HAVE_SDB_TRAMPOLINES 1
153 #define MONO_ARCH_HAVE_PATCH_CODE_NEW 1
154 #define MONO_ARCH_HAVE_OP_GENERIC_CLASS_INIT 1
155 #define MONO_ARCH_HAVE_OPCODE_NEEDS_EMULATION 1
156 #define MONO_ARCH_HAVE_DECOMPOSE_LONG_OPTS 1
157 #define MONO_ARCH_HAVE_HANDLER_BLOCK_GUARD 1
158 #define MONO_ARCH_HAVE_INIT_LMF_EXT 1
159 #ifndef TARGET_IOS
160 #define MONO_ARCH_HAVE_HANDLER_BLOCK_GUARD_AOT 1
161 #endif
162
163 #ifdef TARGET_IOS
164
165 #define MONO_ARCH_REDZONE_SIZE 128
166
167 #else
168
169 #define MONO_ARCH_REDZONE_SIZE 0
170
171 #endif
172
173 #if defined(TARGET_APPLETVOS) || defined(TARGET_IOS)
174 #define MONO_ARCH_HAVE_UNWIND_BACKTRACE 1
175 #endif
176
177 /* Relocations */
178 #define MONO_R_ARM64_B 1
179 #define MONO_R_ARM64_BCC 2
180 #define MONO_R_ARM64_IMM 3
181 #define MONO_R_ARM64_BL 4
182 #define MONO_R_ARM64_BL_SHORT 5
183 #define MONO_R_ARM64_CBZ 6
184
185
186 typedef enum {
187         ArgInIReg,
188         ArgInFReg,
189         ArgInFRegR4,
190         ArgOnStack,
191         ArgOnStackR8,
192         ArgOnStackR4,
193         /*
194          * Vtype passed in consecutive int registers.
195          * ainfo->reg is the firs register,
196          * ainfo->nregs is the number of registers,
197          * ainfo->size is the size of the structure.
198          */
199         ArgVtypeInIRegs,
200         ArgVtypeByRef,
201         ArgVtypeByRefOnStack,
202         ArgVtypeOnStack,
203         ArgHFA,
204         ArgNone
205 } ArgStorage;
206
207 typedef struct {
208         ArgStorage storage;
209         int reg;
210         /* ArgOnStack */
211         int offset;
212         /* ArgVtypeInIRegs/ArgHFA */
213         int nregs, size;
214         /* ArgHFA */
215         int esize;
216         /* ArgHFA */
217         /* The offsets of the float values inside the arg */
218         guint16 foffsets [4];
219         /* ArgOnStack */
220         int slot_size;
221         /* hfa */
222         int nfregs_to_skip;
223         gboolean sign;
224         gboolean gsharedvt;
225         gboolean hfa;
226 } ArgInfo;
227
228 typedef struct {
229         int nargs;
230         int gr, fr, stack_usage;
231         gboolean pinvoke;
232         ArgInfo ret;
233         ArgInfo sig_cookie;
234         ArgInfo args [1];
235 } CallInfo;
236
237
238 guint8* mono_arm_emit_imm64 (guint8 *code, int dreg, gint64 imm);
239
240 guint8* mono_arm_emit_ldrx (guint8 *code, int rt, int rn, int imm);
241
242 guint8* mono_arm_emit_destroy_frame (guint8 *code, int stack_offset, guint64 temp_regs);
243
244 guint8* mono_arm_emit_store_regset (guint8 *code, guint64 regs, int basereg, int offset);
245
246 guint8* mono_arm_emit_store_regarray (guint8 *code, guint64 regs, int basereg, int offset);
247
248 guint8* mono_arm_emit_load_regarray (guint8 *code, guint64 regs, int basereg, int offset);
249
250 /* MonoJumpInfo **ji */
251 guint8* mono_arm_emit_aotconst (gpointer ji, guint8 *code, guint8 *code_start, int dreg, guint32 patch_type, gconstpointer data);
252
253 void mono_arm_patch (guint8 *code, guint8 *target, int relocation);
254
255 void mono_arm_throw_exception (gpointer arg, mgreg_t pc, mgreg_t *int_regs, gdouble *fp_regs, gboolean corlib, gboolean rethrow);
256
257 void mono_arm_gsharedvt_init (void);
258
259 GSList* mono_arm_get_exception_trampolines (gboolean aot);
260
261 void mono_arm_resume_unwind (gpointer arg, mgreg_t pc, mgreg_t *int_regs, gdouble *fp_regs, gboolean corlib, gboolean rethrow);
262
263 gpointer mono_arm_handler_block_trampoline_helper (gpointer *ptr);
264
265 CallInfo* mono_arch_get_call_info (MonoMemPool *mp, MonoMethodSignature *sig);
266
267 #endif /* __MONO_MINI_ARM64_H__ */