Windows x64 full AOT support for mono/mini regression tests.
[mono.git] / mono / mini / mini-x86.h
1 #ifndef __MONO_MINI_X86_H__
2 #define __MONO_MINI_X86_H__
3
4 #include <mono/arch/x86/x86-codegen.h>
5 #include <mono/utils/mono-sigcontext.h>
6 #include <mono/utils/mono-context.h>
7
8 #ifdef __native_client_codegen__
9 #define kNaClAlignmentX86 32
10 #define kNaClAlignmentMaskX86 (kNaClAlignmentX86 - 1)
11
12 #define kNaClLengthOfCallImm kx86NaClLengthOfCallImm
13 #endif
14
15 #ifdef HOST_WIN32
16 #include <windows.h>
17 /* use SIG* defines if possible */
18 #ifdef HAVE_SIGNAL_H
19 #include <signal.h>
20 #endif
21
22 typedef void (* MonoW32ExceptionHandler) (int _dummy, EXCEPTION_POINTERS *info, void *context);
23
24 void win32_seh_init(void);
25 void win32_seh_cleanup(void);
26 void win32_seh_set_handler(int type, MonoW32ExceptionHandler handler);
27
28 #ifndef SIGFPE
29 #define SIGFPE 4
30 #endif
31
32 #ifndef SIGILL
33 #define SIGILL 8
34 #endif
35
36 #ifndef SIGSEGV
37 #define SIGSEGV 11
38 #endif
39
40 LONG CALLBACK seh_handler(EXCEPTION_POINTERS* ep);
41
42 #endif /* HOST_WIN32 */
43
44 #ifdef __HAIKU__
45 struct sigcontext {
46         vregs regs;
47 };
48 #endif /* __HAIKU__ */
49
50 #if defined( __linux__) || defined(__sun) || defined(__APPLE__) || defined(__NetBSD__) || \
51        defined(__FreeBSD__) || defined(__FreeBSD_kernel__) || defined(__OpenBSD__)
52 #define MONO_ARCH_USE_SIGACTION
53 #endif
54
55 #if defined(__native_client__) || defined(HOST_WATCHOS)
56 #undef MONO_ARCH_USE_SIGACTION
57 #endif
58
59 #ifndef HOST_WIN32
60
61 #ifdef HAVE_WORKING_SIGALTSTACK
62 /* 
63  * solaris doesn't have pthread_getattr_np () needed by the sigaltstack setup
64  * code.
65  */
66 #ifndef __sun
67 #define MONO_ARCH_SIGSEGV_ON_ALTSTACK
68 #endif
69 /* Haiku doesn't have SA_SIGINFO */
70 #ifndef __HAIKU__
71 #define MONO_ARCH_USE_SIGACTION
72 #endif /* __HAIKU__ */
73
74 #endif /* HAVE_WORKING_SIGALTSTACK */
75 #endif /* !HOST_WIN32 */
76
77 #define MONO_ARCH_SUPPORT_TASKLETS 1
78
79 #ifndef DISABLE_SIMD
80 #define MONO_ARCH_SIMD_INTRINSICS 1
81 #define MONO_ARCH_NEED_SIMD_BANK 1
82 #endif
83
84 /* we should lower this size and make sure we don't call heavy stack users in the segv handler */
85 #if defined(__APPLE__)
86 #define MONO_ARCH_SIGNAL_STACK_SIZE MINSIGSTKSZ
87 #else
88 #define MONO_ARCH_SIGNAL_STACK_SIZE (16 * 1024)
89 #endif
90 #define MONO_ARCH_HAVE_RESTORE_STACK_SUPPORT 1
91
92 #define MONO_ARCH_CPU_SPEC mono_x86_desc
93
94 #define MONO_MAX_IREGS 8
95 #define MONO_MAX_FREGS 8
96 #define MONO_MAX_XREGS 8
97
98 /* Parameters used by the register allocator */
99 #define MONO_ARCH_CALLEE_REGS X86_CALLEE_REGS
100 #define MONO_ARCH_CALLEE_SAVED_REGS X86_CALLER_REGS
101
102 #define MONO_ARCH_CALLEE_FREGS (0xff & ~(regmask (MONO_ARCH_FPSTACK_SIZE)))
103 #define MONO_ARCH_CALLEE_SAVED_FREGS 0
104
105 /* All registers are clobered by a call */
106 #define MONO_ARCH_CALLEE_XREGS (0xff & ~(regmask (MONO_MAX_XREGS)))
107 #define MONO_ARCH_CALLEE_SAVED_XREGS 0
108
109 #define MONO_ARCH_USE_FPSTACK TRUE
110 #define MONO_ARCH_FPSTACK_SIZE 6
111
112 #define MONO_ARCH_INST_FIXED_REG(desc) (((desc == ' ') || (desc == 'i')) ? -1 : ((desc == 's') ? X86_ECX : ((desc == 'a') ? X86_EAX : ((desc == 'd') ? X86_EDX : ((desc == 'l') ? X86_EAX : -1)))))
113
114 #define MONO_ARCH_INST_FIXED_MASK(desc) ((desc == 'y') ? (X86_BYTE_REGS) : 0)
115
116 /* RDX is clobbered by the opcode implementation before accessing sreg2 */
117 /* 
118  * Originally this contained X86_EDX for div/rem opcodes, but that led to unsolvable 
119  * situations since there are only 3 usable registers for local register allocation.
120  * Instead, we handle the sreg2==edx case in the opcodes.
121  */
122 #define MONO_ARCH_INST_SREG2_MASK(ins) 0
123
124 /*
125  * L is a generic register pair, while l means eax:rdx
126  */
127 #define MONO_ARCH_INST_IS_REGPAIR(desc) (desc == 'l' || desc == 'L')
128 #define MONO_ARCH_INST_REGPAIR_REG2(desc,hreg1) (desc == 'l' ? X86_EDX : -1)
129
130 /* must be at a power of 2 and >= 8 */
131 #define MONO_ARCH_FRAME_ALIGNMENT 16
132
133 /* fixme: align to 16byte instead of 32byte (we align to 32byte to get 
134  * reproduceable results for benchmarks */
135 #define MONO_ARCH_CODE_ALIGNMENT 32
136
137 /*This is the max size of the locals area of a given frame. I think 1MB is a safe default for now*/
138 #define MONO_ARCH_MAX_FRAME_SIZE 0x100000
139
140 /*This is how much a try block must be extended when is is preceeded by a Monitor.Enter() call.
141 It's 4 bytes as this is how many bytes + 1 that 'add 0x10, %esp' takes. It is used to pop the arguments from
142 the monitor.enter call and must be already protected.*/
143 #define MONO_ARCH_MONITOR_ENTER_ADJUSTMENT 4
144
145 struct MonoLMF {
146         /* 
147          * If the lowest bit is set to 1, then this is a trampoline LMF frame.
148          * If the second lowest bit is set to 1, then this is a MonoLMFExt structure, and
149          * the other fields are not valid.
150          */
151         guint32    previous_lmf;
152         gpointer    lmf_addr;
153         /* Only set in trampoline LMF frames */
154         MonoMethod *method;
155         /* Only set in trampoline LMF frames */
156         guint32     esp;
157         guint32     ebx;
158         guint32     edi;
159         guint32     esi;
160         guint32     ebp;
161         guint32     eip;
162 };
163
164 typedef struct {
165         gboolean need_stack_frame_inited;
166         gboolean need_stack_frame;
167         int sp_fp_offset, param_area_size;
168         gpointer cinfo;
169         gpointer ss_tramp_var;
170         gpointer bp_tramp_var;
171 } MonoCompileArch;
172
173 #define MONO_CONTEXT_SET_LLVM_EXC_REG(ctx, exc) do { (ctx)->eax = (gsize)exc; } while (0)
174
175 #ifdef _MSC_VER
176
177 #define MONO_INIT_CONTEXT_FROM_FUNC(ctx, start_func) do { \
178     unsigned int stackptr; \
179         mono_arch_flush_register_windows (); \
180     { \
181            __asm mov stackptr, ebp \
182     } \
183         MONO_CONTEXT_SET_IP ((ctx), (start_func)); \
184         MONO_CONTEXT_SET_BP ((ctx), stackptr); \
185         MONO_CONTEXT_SET_SP ((ctx), stackptr); \
186 } while (0)
187
188 #else
189
190 #define MONO_INIT_CONTEXT_FROM_FUNC(ctx,start_func) do {        \
191                 mono_arch_flush_register_windows ();    \
192                 MONO_CONTEXT_SET_IP ((ctx), (start_func));      \
193                 MONO_CONTEXT_SET_BP ((ctx), __builtin_frame_address (0));       \
194                 MONO_CONTEXT_SET_SP ((ctx), __builtin_frame_address (0));       \
195         } while (0)
196
197 #endif
198
199 #define MONO_ARCH_INIT_TOP_LMF_ENTRY(lmf) do { (lmf)->ebp = -1; } while (0)
200
201 /* Enables OP_LSHL, OP_LSHL_IMM, OP_LSHR, OP_LSHR_IMM, OP_LSHR_UN, OP_LSHR_UN_IMM */
202 #define MONO_ARCH_NO_EMULATE_LONG_SHIFT_OPS
203
204 #define MONO_ARCH_NEED_DIV_CHECK 1
205 #define MONO_ARCH_HAVE_IS_INT_OVERFLOW 1
206 #define MONO_ARCH_HAVE_INVALIDATE_METHOD 1
207 #define MONO_ARCH_NEED_GOT_VAR 1
208 #ifndef HOST_WIN32
209 /* X86 uses jit_tls->lmf (See emit_push_lmf ()) */
210 #define MONO_ARCH_ENABLE_MONO_LMF_VAR 1
211 #endif
212 #define MONO_ARCH_HAVE_TLS_GET (mono_x86_have_tls_get ())
213 #define MONO_ARCH_IMT_REG X86_EDX
214 #define MONO_ARCH_VTABLE_REG X86_EDX
215 #define MONO_ARCH_RGCTX_REG MONO_ARCH_IMT_REG
216 #define MONO_ARCH_EXC_REG X86_EAX
217 #define MONO_ARCH_HAVE_GENERALIZED_IMT_THUNK 1
218 #define MONO_ARCH_HAVE_LIVERANGE_OPS 1
219 #define MONO_ARCH_HAVE_SIGCTX_TO_MONOCTX 1
220 #if !defined(__native_client_codegen__)
221 #define MONO_ARCH_HAVE_FULL_AOT_TRAMPOLINES 1
222 #endif
223 #define MONO_ARCH_GOT_REG X86_EBX
224 #define MONO_ARCH_HAVE_GET_TRAMPOLINES 1
225 #define MONO_ARCH_HAVE_GENERAL_RGCTX_LAZY_FETCH_TRAMPOLINE 1
226
227 #define MONO_ARCH_HAVE_CMOV_OPS 1
228
229 #ifdef MONO_ARCH_SIMD_INTRINSICS
230 #define MONO_ARCH_HAVE_DECOMPOSE_OPTS 1
231 #endif
232
233 #define MONO_ARCH_HAVE_DECOMPOSE_LONG_OPTS 1
234
235 #define MONO_ARCH_AOT_SUPPORTED 1
236
237 #define MONO_ARCH_GSHARED_SUPPORTED 1
238 #define MONO_ARCH_LLVM_SUPPORTED 1
239
240 #define MONO_ARCH_SOFT_DEBUG_SUPPORTED 1
241
242 #define MONO_ARCH_HAVE_EXCEPTIONS_INIT 1
243 #define MONO_ARCH_HAVE_HANDLER_BLOCK_GUARD 1
244
245 #define MONO_ARCH_HAVE_CARD_TABLE_WBARRIER 1
246 #define MONO_ARCH_HAVE_SETUP_RESUME_FROM_SIGNAL_HANDLER_CTX 1
247 #define MONO_ARCH_GC_MAPS_SUPPORTED 1
248 #define MONO_ARCH_HAVE_CONTEXT_SET_INT_REG 1
249 #define MONO_ARCH_HAVE_SETUP_ASYNC_CALLBACK 1
250 #define MONO_ARCH_GSHAREDVT_SUPPORTED 1
251 #define MONO_ARCH_HAVE_OP_TAIL_CALL 1
252 #define MONO_ARCH_HAVE_TRANSLATE_TLS_OFFSET 1
253 #define MONO_ARCH_HAVE_TLS_GET_REG 1
254 #define MONO_ARCH_HAVE_DUMMY_INIT 1
255 #define MONO_ARCH_HAVE_SDB_TRAMPOLINES 1
256 #define MONO_ARCH_HAVE_PATCH_CODE_NEW 1
257
258 /* Used for optimization, not complete */
259 #define MONO_ARCH_IS_OP_MEMBASE(opcode) ((opcode) == OP_X86_PUSH_MEMBASE)
260
261 #define MONO_ARCH_EMIT_BOUNDS_CHECK(cfg, array_reg, offset, index_reg) do { \
262             MonoInst *inst; \
263             MONO_INST_NEW ((cfg), inst, OP_X86_COMPARE_MEMBASE_REG); \
264             inst->inst_basereg = array_reg; \
265             inst->inst_offset = offset; \
266             inst->sreg2 = index_reg; \
267             MONO_ADD_INS ((cfg)->cbb, inst); \
268                         MONO_EMIT_NEW_COND_EXC (cfg, LE_UN, "IndexOutOfRangeException"); \
269         } while (0)
270
271 /* Return value marshalling for calls between gsharedvt and normal code */
272 typedef enum {
273         GSHAREDVT_RET_NONE = 0,
274         GSHAREDVT_RET_IREGS = 1,
275         GSHAREDVT_RET_DOUBLE_FPSTACK = 2,
276         GSHAREDVT_RET_FLOAT_FPSTACK = 3,
277         GSHAREDVT_RET_STACK_POP = 4,
278         GSHAREDVT_RET_I1 = 5,
279         GSHAREDVT_RET_U1 = 6,
280         GSHAREDVT_RET_I2 = 7,
281         GSHAREDVT_RET_U2 = 8,
282         GSHAREDVT_RET_IREG = 9
283 } GSharedVtRetMarshal;
284
285 typedef struct {
286         /* Method address to call */
287         gpointer addr;
288         /* The trampoline reads this, so keep the size explicit */
289         int ret_marshal;
290         /* If ret_marshal != NONE, this is the stack slot of the vret arg, else -1 */
291         int vret_arg_slot;
292         /* The stack slot where the return value will be stored */
293         int vret_slot;
294         int stack_usage, map_count;
295         /* If not -1, then make a virtual call using this vtable offset */
296         int vcall_offset;
297         /* If 1, make an indirect call to the address in the rgctx reg */
298         int calli;
299         /* Whenever this is a in or an out call */
300         int gsharedvt_in;
301         int map [MONO_ZERO_LEN_ARRAY];
302 } GSharedVtCallInfo;
303
304 typedef enum {
305         ArgInIReg,
306         ArgInFloatSSEReg,
307         ArgInDoubleSSEReg,
308         ArgOnStack,
309         ArgValuetypeInReg,
310         ArgOnFloatFpStack,
311         ArgOnDoubleFpStack,
312         /* gsharedvt argument passed by addr */
313         ArgGSharedVt,
314         ArgNone
315 } ArgStorage;
316
317 typedef struct {
318         gint16 offset;
319         gint8  reg;
320         ArgStorage storage;
321         int nslots;
322         gboolean is_pair;
323
324         /* Only if storage == ArgValuetypeInReg */
325         ArgStorage pair_storage [2];
326         gint8 pair_regs [2];
327 } ArgInfo;
328
329 typedef struct {
330         int nargs;
331         guint32 stack_usage;
332         guint32 reg_usage;
333         guint32 freg_usage;
334         gboolean need_stack_align;
335         guint32 stack_align_amount;
336         gboolean vtype_retaddr;
337         /* The index of the vret arg in the argument list */
338         int vret_arg_index;
339         int vret_arg_offset;
340         /* Argument space popped by the callee */
341         int callee_stack_pop;
342         ArgInfo ret;
343         ArgInfo sig_cookie;
344         ArgInfo args [1];
345 } CallInfo;
346
347 guint8*
348 mono_x86_emit_tls_get (guint8* code, int dreg, int tls_offset);
349
350 guint8*
351 mono_x86_emit_tls_get_reg (guint8* code, int dreg, int offset_reg);
352
353 guint32
354 mono_x86_get_this_arg_offset (MonoMethodSignature *sig);
355
356 gboolean
357 mono_x86_have_tls_get (void);
358
359 void
360 mono_x86_throw_exception (mgreg_t *regs, MonoObject *exc, 
361                                                   mgreg_t eip, gboolean rethrow);
362
363 void
364 mono_x86_throw_corlib_exception (mgreg_t *regs, guint32 ex_token_index, 
365                                                                  mgreg_t eip, gint32 pc_offset);
366
367 void 
368 mono_x86_patch (unsigned char* code, gpointer target);
369
370 gpointer
371 mono_x86_start_gsharedvt_call (GSharedVtCallInfo *info, gpointer *caller, gpointer *callee, gpointer mrgctx_reg);
372
373 CallInfo*
374 mono_arch_get_call_info (MonoMemPool *mp, MonoMethodSignature *sig);
375
376 #endif /* __MONO_MINI_X86_H__ */  
377