Merge branch 'master' into mono4-continuations_fix
[mono.git] / mono / mini / mini-amd64.h
1 #ifndef __MONO_MINI_AMD64_H__
2 #define __MONO_MINI_AMD64_H__
3
4 #include <mono/arch/amd64/amd64-codegen.h>
5 #include <mono/utils/mono-sigcontext.h>
6 #include <mono/utils/mono-context.h>
7 #include <glib.h>
8
9 #ifdef HOST_WIN32
10 #include <windows.h>
11 /* use SIG* defines if possible */
12 #ifdef HAVE_SIGNAL_H
13 #include <signal.h>
14 #endif
15
16 #if !defined(_MSC_VER)
17 /* sigcontext surrogate */
18 struct sigcontext {
19         guint64 eax;
20         guint64 ebx;
21         guint64 ecx;
22         guint64 edx;
23         guint64 ebp;
24         guint64 esp;
25     guint64 esi;
26         guint64 edi;
27         guint64 eip;
28 };
29 #endif
30
31 typedef void (* MonoW32ExceptionHandler) (int _dummy, EXCEPTION_POINTERS *info, void *context);
32 void win32_seh_init(void);
33 void win32_seh_cleanup(void);
34 void win32_seh_set_handler(int type, MonoW32ExceptionHandler handler);
35
36 #ifndef SIGFPE
37 #define SIGFPE 4
38 #endif
39
40 #ifndef SIGILL
41 #define SIGILL 8
42 #endif
43
44 #ifndef SIGSEGV
45 #define SIGSEGV 11
46 #endif
47
48 LONG CALLBACK seh_handler(EXCEPTION_POINTERS* ep);
49
50 #endif /* HOST_WIN32 */
51
52 #ifdef sun    // Solaris x86
53 #  undef SIGSEGV_ON_ALTSTACK
54 #  define MONO_ARCH_NOMAP32BIT
55
56 struct sigcontext {
57         unsigned short gs, __gsh;
58         unsigned short fs, __fsh;
59         unsigned short es, __esh;
60         unsigned short ds, __dsh;
61         unsigned long edi;
62         unsigned long esi;
63         unsigned long ebp;
64         unsigned long esp;
65         unsigned long ebx;
66         unsigned long edx;
67         unsigned long ecx;
68         unsigned long eax;
69         unsigned long trapno;
70         unsigned long err;
71         unsigned long eip;
72         unsigned short cs, __csh;
73         unsigned long eflags;
74         unsigned long esp_at_signal;
75         unsigned short ss, __ssh;
76         unsigned long fpstate[95];
77       unsigned long filler[5];
78 };
79 #endif  // sun, Solaris x86
80
81 #ifndef DISABLE_SIMD
82 #define MONO_ARCH_SIMD_INTRINSICS 1
83 #define MONO_ARCH_NEED_SIMD_BANK 1
84 #define MONO_ARCH_USE_SHARED_FP_SIMD_BANK 1
85 #endif
86
87
88
89 #if defined(__APPLE__)
90 #define MONO_ARCH_SIGNAL_STACK_SIZE MINSIGSTKSZ
91 #else
92 #define MONO_ARCH_SIGNAL_STACK_SIZE (16 * 1024)
93 #endif
94
95 #define MONO_ARCH_HAVE_RESTORE_STACK_SUPPORT 1
96
97 #define MONO_ARCH_CPU_SPEC mono_amd64_desc
98
99 #define MONO_MAX_IREGS 16
100
101 #define MONO_MAX_FREGS AMD64_XMM_NREG
102
103 #define MONO_ARCH_FP_RETURN_REG AMD64_XMM0
104
105 #ifdef TARGET_WIN32
106 /* xmm5 is used as a scratch register */
107 #define MONO_ARCH_CALLEE_FREGS 0x1f
108 /* xmm6:xmm15 */
109 #define MONO_ARCH_CALLEE_SAVED_FREGS (0xffff - 0x3f)
110 #define MONO_ARCH_FP_SCRATCH_REG AMD64_XMM5
111 #else
112 /* xmm15 is used as a scratch register */
113 #define MONO_ARCH_CALLEE_FREGS 0x7fff
114 #define MONO_ARCH_CALLEE_SAVED_FREGS 0
115 #define MONO_ARCH_FP_SCRATCH_REG AMD64_XMM15
116 #endif
117
118 #define MONO_MAX_XREGS MONO_MAX_FREGS
119
120 #define MONO_ARCH_CALLEE_XREGS MONO_ARCH_CALLEE_FREGS
121 #define MONO_ARCH_CALLEE_SAVED_XREGS MONO_ARCH_CALLEE_SAVED_FREGS
122
123
124 #define MONO_ARCH_CALLEE_REGS AMD64_CALLEE_REGS
125 #define MONO_ARCH_CALLEE_SAVED_REGS AMD64_CALLEE_SAVED_REGS
126
127 #define MONO_ARCH_USE_FPSTACK FALSE
128 #define MONO_ARCH_FPSTACK_SIZE 0
129
130 #define MONO_ARCH_INST_FIXED_REG(desc) ((desc == '\0') ? -1 : ((desc == 'i' ? -1 : ((desc == 'a') ? AMD64_RAX : ((desc == 's') ? AMD64_RCX : ((desc == 'd') ? AMD64_RDX : ((desc == 'A') ? MONO_AMD64_ARG_REG1 : -1)))))))
131
132 /* RDX is clobbered by the opcode implementation before accessing sreg2 */
133 #define MONO_ARCH_INST_SREG2_MASK(ins) (((ins [MONO_INST_CLOB] == 'a') || (ins [MONO_INST_CLOB] == 'd')) ? (1 << AMD64_RDX) : 0)
134
135 #define MONO_ARCH_INST_IS_REGPAIR(desc) FALSE
136 #define MONO_ARCH_INST_REGPAIR_REG2(desc,hreg1) (-1)
137
138 #define MONO_ARCH_FRAME_ALIGNMENT 16
139
140 /* fixme: align to 16byte instead of 32byte (we align to 32byte to get 
141  * reproduceable results for benchmarks */
142 #define MONO_ARCH_CODE_ALIGNMENT 32
143
144 /*This is the max size of the locals area of a given frame. I think 1MB is a safe default for now*/
145 #define MONO_ARCH_MAX_FRAME_SIZE 0x100000
146
147 struct MonoLMF {
148         /* 
149          * If the lowest bit is set, then this LMF has the rip field set. Otherwise,
150          * the rip field is not set, and the rsp field points to the stack location where
151          * the caller ip is saved.
152          * If the second lowest bit is set, then this is a MonoLMFExt structure, and
153          * the other fields are not valid.
154          * If the third lowest bit is set, then this is a MonoLMFTramp structure, and
155          * the 'rbp' field is not valid.
156          */
157         gpointer    previous_lmf;
158         guint64     rip;
159         guint64     rbp;
160         guint64     rsp;
161 };
162
163 /* LMF structure used by the JIT trampolines */
164 typedef struct {
165         struct MonoLMF lmf;
166         MonoContext *ctx;
167         gpointer lmf_addr;
168 } MonoLMFTramp;
169
170 typedef struct MonoCompileArch {
171         gint32 localloc_offset;
172         gint32 reg_save_area_offset;
173         gint32 stack_alloc_size;
174         gint32 sp_fp_offset;
175         guint32 saved_iregs;
176         gboolean omit_fp, omit_fp_computed;
177         gpointer cinfo;
178         gint32 async_point_count;
179         gpointer vret_addr_loc;
180 #ifdef HOST_WIN32
181         gpointer        unwindinfo;
182 #endif
183         gpointer seq_point_info_var;
184         gpointer ss_trigger_page_var;
185         gpointer ss_tramp_var;
186         gpointer bp_tramp_var;
187         gpointer lmf_var;
188 } MonoCompileArch;
189
190 #ifdef TARGET_WIN32
191 #define PARAM_REGS 4
192 #define FLOAT_PARAM_REGS 4
193
194 static AMD64_Reg_No param_regs [] = { AMD64_RCX, AMD64_RDX, AMD64_R8, AMD64_R9 };
195
196 static AMD64_Reg_No return_regs [] = { AMD64_RAX, AMD64_RDX };
197 #else
198 #define PARAM_REGS 6
199 #define FLOAT_PARAM_REGS 8
200
201 static AMD64_Reg_No param_regs [] = { AMD64_RDI, AMD64_RSI, AMD64_RDX, AMD64_RCX, AMD64_R8, AMD64_R9 };
202
203 static AMD64_Reg_No return_regs [] = { AMD64_RAX, AMD64_RDX };
204 #endif
205
206 typedef struct {
207         /* Method address to call */
208         gpointer addr;
209         /* The trampoline reads this, so keep the size explicit */
210         int ret_marshal;
211         /* If ret_marshal != NONE, this is the reg of the vret arg, else -1 (used in out case) */
212         /* Equivalent of vret_arg_slot in the x86 implementation. */
213         int vret_arg_reg;
214         /* The stack slot where the return value will be stored (used in in case) */
215         int vret_slot;
216         int stack_usage, map_count;
217         /* If not -1, then make a virtual call using this vtable offset */
218         int vcall_offset;
219         /* If 1, make an indirect call to the address in the rgctx reg */
220         int calli;
221         /* Whenever this is a in or an out call */
222         int gsharedvt_in;
223         /* Maps stack slots/registers in the caller to the stack slots/registers in the callee */
224         int map [MONO_ZERO_LEN_ARRAY];
225 } GSharedVtCallInfo;
226
227 /* Structure used by the sequence points in AOTed code */
228 typedef struct {
229         gpointer ss_tramp_addr;
230         gpointer bp_addrs [MONO_ZERO_LEN_ARRAY];
231 } SeqPointInfo;
232
233 #define DYN_CALL_STACK_ARGS 6
234
235 typedef struct {
236         mgreg_t regs [PARAM_REGS + DYN_CALL_STACK_ARGS];
237         mgreg_t res;
238         guint8 *ret;
239         double fregs [8];
240         mgreg_t has_fp;
241         guint8 buffer [256];
242 } DynCallArgs;
243
244 typedef enum {
245         ArgInIReg,
246         ArgInFloatSSEReg,
247         ArgInDoubleSSEReg,
248         ArgOnStack,
249         ArgValuetypeInReg,
250         ArgValuetypeAddrInIReg,
251         /* gsharedvt argument passed by addr */
252         ArgGSharedVtInReg,
253         ArgGSharedVtOnStack,
254         /* Variable sized gsharedvt argument passed/returned by addr */
255         ArgGsharedvtVariableInReg,
256         ArgNone /* only in pair_storage */
257 } ArgStorage;
258
259 typedef struct {
260         gint16 offset;
261         gint8  reg;
262         ArgStorage storage : 8;
263
264         /* Only if storage == ArgValuetypeInReg */
265         ArgStorage pair_storage [2];
266         gint8 pair_regs [2];
267         /* The size of each pair (bytes) */
268         int pair_size [2];
269         int nregs;
270         /* Only if storage == ArgOnStack */
271         int arg_size; // Bytes, will always be rounded up/aligned to 8 byte boundary
272         gboolean pass_empty_struct; // Set in scenarios when empty structs needs to be represented as argument.
273 } ArgInfo;
274
275 typedef struct {
276         int nargs;
277         guint32 stack_usage;
278         guint32 reg_usage;
279         guint32 freg_usage;
280         gboolean need_stack_align;
281         gboolean gsharedvt;
282         /* The index of the vret arg in the argument list */
283         int vret_arg_index;
284         ArgInfo ret;
285         ArgInfo sig_cookie;
286         ArgInfo args [1];
287 } CallInfo;
288
289
290 #define MONO_CONTEXT_SET_LLVM_EXC_REG(ctx, exc) do { (ctx)->gregs [AMD64_RAX] = (gsize)exc; } while (0)
291 #define MONO_CONTEXT_SET_LLVM_EH_SELECTOR_REG(ctx, sel) do { (ctx)->gregs [AMD64_RDX] = (gsize)(sel); } while (0)
292
293 #define MONO_ARCH_INIT_TOP_LMF_ENTRY(lmf)
294
295 #ifdef _MSC_VER
296
297 #define MONO_INIT_CONTEXT_FROM_FUNC(ctx, start_func) do { \
298     guint64 stackptr; \
299         mono_arch_flush_register_windows (); \
300         stackptr = ((guint64)_AddressOfReturnAddress () - sizeof (void*));\
301         MONO_CONTEXT_SET_IP ((ctx), (start_func)); \
302         MONO_CONTEXT_SET_BP ((ctx), stackptr); \
303         MONO_CONTEXT_SET_SP ((ctx), stackptr); \
304 } while (0)
305
306 #else
307
308 /* 
309  * __builtin_frame_address () is broken on some older gcc versions in the presence of
310  * frame pointer elimination, see bug #82095.
311  */
312 #define MONO_INIT_CONTEXT_FROM_FUNC(ctx,start_func) do {        \
313         int tmp; \
314         guint64 stackptr = (guint64)&tmp; \
315                 mono_arch_flush_register_windows ();    \
316                 MONO_CONTEXT_SET_IP ((ctx), (start_func));      \
317                 MONO_CONTEXT_SET_BP ((ctx), stackptr);  \
318                 MONO_CONTEXT_SET_SP ((ctx), stackptr);  \
319         } while (0)
320
321 #endif
322
323 /*
324  * some icalls like mono_array_new_va needs to be called using a different 
325  * calling convention.
326  */
327 #define MONO_ARCH_VARARG_ICALLS 1
328
329 #if !defined( HOST_WIN32 ) && defined (HAVE_SIGACTION)
330
331 #define MONO_ARCH_USE_SIGACTION 1
332
333 #ifdef HAVE_WORKING_SIGALTSTACK
334
335 #define MONO_ARCH_SIGSEGV_ON_ALTSTACK
336
337 #endif
338
339 #endif /* !HOST_WIN32 */
340
341 #if !defined(__linux__)
342 #define MONO_ARCH_NOMAP32BIT 1
343 #endif
344
345 #ifdef TARGET_WIN32
346 #define MONO_AMD64_ARG_REG1 AMD64_RCX
347 #define MONO_AMD64_ARG_REG2 AMD64_RDX
348 #define MONO_AMD64_ARG_REG3 AMD64_R8
349 #define MONO_AMD64_ARG_REG4 AMD64_R9
350 #else
351 #define MONO_AMD64_ARG_REG1 AMD64_RDI
352 #define MONO_AMD64_ARG_REG2 AMD64_RSI
353 #define MONO_AMD64_ARG_REG3 AMD64_RDX
354 #define MONO_AMD64_ARG_REG4 AMD64_RCX
355 #endif
356
357 #define MONO_ARCH_NO_EMULATE_LONG_SHIFT_OPS
358 #define MONO_ARCH_NO_EMULATE_LONG_MUL_OPTS
359
360 #define MONO_ARCH_EMULATE_CONV_R8_UN    1
361 #define MONO_ARCH_EMULATE_FREM 1
362 #define MONO_ARCH_HAVE_IS_INT_OVERFLOW 1
363
364 #define MONO_ARCH_ENABLE_MONO_LMF_VAR 1
365 #define MONO_ARCH_HAVE_INVALIDATE_METHOD 1
366 #define MONO_ARCH_HAVE_FULL_AOT_TRAMPOLINES 1
367 #define MONO_ARCH_HAVE_TLS_GET (mono_amd64_have_tls_get ())
368 #define MONO_ARCH_IMT_REG AMD64_R10
369 #define MONO_ARCH_IMT_SCRATCH_REG AMD64_R11
370 #define MONO_ARCH_VTABLE_REG MONO_AMD64_ARG_REG1
371 /*
372  * We use r10 for the imt/rgctx register rather than r11 because r11 is
373  * used by the trampoline as a scratch register and hence might be
374  * clobbered across method call boundaries.
375  */
376 #define MONO_ARCH_RGCTX_REG MONO_ARCH_IMT_REG
377 #define MONO_ARCH_EXC_REG AMD64_RAX
378 #define MONO_ARCH_HAVE_CMOV_OPS 1
379 #define MONO_ARCH_HAVE_EXCEPTIONS_INIT 1
380 #define MONO_ARCH_HAVE_GENERALIZED_IMT_THUNK 1
381 #define MONO_ARCH_HAVE_LIVERANGE_OPS 1
382 #define MONO_ARCH_HAVE_SIGCTX_TO_MONOCTX 1
383 #define MONO_ARCH_HAVE_GET_TRAMPOLINES 1
384
385 #define MONO_ARCH_AOT_SUPPORTED 1
386 #define MONO_ARCH_SOFT_DEBUG_SUPPORTED 1
387
388 #define MONO_ARCH_SUPPORT_TASKLETS 1
389
390 #define MONO_ARCH_GSHARED_SUPPORTED 1
391 #define MONO_ARCH_DYN_CALL_SUPPORTED 1
392 #define MONO_ARCH_DYN_CALL_PARAM_AREA (DYN_CALL_STACK_ARGS * 8)
393
394 #define MONO_ARCH_LLVM_SUPPORTED 1
395 #define MONO_ARCH_HAVE_HANDLER_BLOCK_GUARD 1
396 #define MONO_ARCH_HAVE_CARD_TABLE_WBARRIER 1
397 #define MONO_ARCH_HAVE_SETUP_RESUME_FROM_SIGNAL_HANDLER_CTX 1
398 #define MONO_ARCH_GC_MAPS_SUPPORTED 1
399 #define MONO_ARCH_HAVE_CONTEXT_SET_INT_REG 1
400 #define MONO_ARCH_HAVE_SETUP_ASYNC_CALLBACK 1
401 #define MONO_ARCH_HAVE_CREATE_LLVM_NATIVE_THUNK 1
402 #define MONO_ARCH_HAVE_OP_TAIL_CALL 1
403 #define MONO_ARCH_HAVE_TRANSLATE_TLS_OFFSET 1
404 #define MONO_ARCH_HAVE_DUMMY_INIT 1
405 #define MONO_ARCH_HAVE_SDB_TRAMPOLINES 1
406 #define MONO_ARCH_HAVE_PATCH_CODE_NEW 1
407 #define MONO_ARCH_HAVE_OP_GENERIC_CLASS_INIT 1
408 #define MONO_ARCH_HAVE_GENERAL_RGCTX_LAZY_FETCH_TRAMPOLINE 1
409
410 #if defined(TARGET_OSX) || defined(__linux__)
411 #define MONO_ARCH_HAVE_UNWIND_BACKTRACE 1
412 #endif
413
414 #if defined(TARGET_OSX) || defined(__linux__) || defined(TARGET_WIN32)
415 #define MONO_ARCH_HAVE_TLS_GET_REG 1
416 #endif
417
418 #define MONO_ARCH_GSHAREDVT_SUPPORTED 1
419
420
421 #if defined(TARGET_APPLETVOS)
422 /* No signals */
423 #define MONO_ARCH_NEED_DIV_CHECK 1
424 #endif
425
426 /* Used for optimization, not complete */
427 #define MONO_ARCH_IS_OP_MEMBASE(opcode) ((opcode) == OP_X86_PUSH_MEMBASE)
428
429 #define MONO_ARCH_EMIT_BOUNDS_CHECK(cfg, array_reg, offset, index_reg) do { \
430             MonoInst *inst; \
431             MONO_INST_NEW ((cfg), inst, OP_AMD64_ICOMPARE_MEMBASE_REG); \
432             inst->inst_basereg = array_reg; \
433             inst->inst_offset = offset; \
434             inst->sreg2 = index_reg; \
435             MONO_ADD_INS ((cfg)->cbb, inst); \
436             MONO_EMIT_NEW_COND_EXC (cfg, LE_UN, "IndexOutOfRangeException"); \
437        } while (0)
438
439 void 
440 mono_amd64_patch (unsigned char* code, gpointer target);
441
442 void
443 mono_amd64_throw_exception (guint64 dummy1, guint64 dummy2, guint64 dummy3, guint64 dummy4,
444                                                         guint64 dummy5, guint64 dummy6,
445                                                         MonoContext *mctx, MonoObject *exc, gboolean rethrow);
446
447 void
448 mono_amd64_throw_corlib_exception (guint64 dummy1, guint64 dummy2, guint64 dummy3, guint64 dummy4,
449                                                                    guint64 dummy5, guint64 dummy6,
450                                                                    MonoContext *mctx, guint32 ex_token_index, gint64 pc_offset);
451
452 void
453 mono_amd64_resume_unwind (guint64 dummy1, guint64 dummy2, guint64 dummy3, guint64 dummy4,
454                                                   guint64 dummy5, guint64 dummy6,
455                                                   MonoContext *mctx, guint32 dummy7, gint64 dummy8);
456
457 gpointer
458 mono_amd64_start_gsharedvt_call (GSharedVtCallInfo *info, gpointer *caller, gpointer *callee, gpointer mrgctx_reg);
459
460 guint64
461 mono_amd64_get_original_ip (void);
462
463 guint8*
464 mono_amd64_emit_tls_get (guint8* code, int dreg, int tls_offset);
465
466 gboolean
467 mono_amd64_have_tls_get (void);
468
469 GSList*
470 mono_amd64_get_exception_trampolines (gboolean aot);
471
472 int
473 mono_amd64_get_tls_gs_offset (void) MONO_LLVM_INTERNAL;
474
475 #ifdef TARGET_WIN32
476
477 void mono_arch_unwindinfo_add_push_nonvol (gpointer* monoui, gpointer codebegin, gpointer nextip, guchar reg );
478 void mono_arch_unwindinfo_add_set_fpreg (gpointer* monoui, gpointer codebegin, gpointer nextip, guchar reg );
479 void mono_arch_unwindinfo_add_alloc_stack (gpointer* monoui, gpointer codebegin, gpointer nextip, guint size );
480 guint mono_arch_unwindinfo_get_size (gpointer monoui);
481 void mono_arch_unwindinfo_install_unwind_info (gpointer* monoui, gpointer code, guint code_size);
482
483 #define MONO_ARCH_HAVE_UNWIND_TABLE 1
484 #endif
485
486 CallInfo* mono_arch_get_call_info (MonoMemPool *mp, MonoMethodSignature *sig);
487
488 #endif /* __MONO_MINI_AMD64_H__ */  
489