Merge remote branch 'upstream/master'
[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 <glib.h>
7
8 #ifdef __native_client_codegen__
9 #define kNaClAlignmentAMD64 32
10 #define kNaClAlignmentMaskAMD64 (kNaClAlignmentAMD64 - 1)
11
12 /* TODO: use kamd64NaClLengthOfCallImm    */
13 /* temporarily using kNaClAlignmentAMD64 so padding in */
14 /* image-writer.c doesn't happen                       */
15 #define kNaClLengthOfCallImm kNaClAlignmentAMD64
16
17 int is_nacl_call_reg_sequence(guint8* code);
18 #endif
19
20 #ifdef HOST_WIN32
21 #include <windows.h>
22 /* use SIG* defines if possible */
23 #ifdef HAVE_SIGNAL_H
24 #include <signal.h>
25 #endif
26
27
28 /* sigcontext surrogate */
29 struct sigcontext {
30         guint64 eax;
31         guint64 ebx;
32         guint64 ecx;
33         guint64 edx;
34         guint64 ebp;
35         guint64 esp;
36     guint64 esi;
37         guint64 edi;
38         guint64 eip;
39 };
40
41 typedef void (* MonoW32ExceptionHandler) (int _dummy, EXCEPTION_RECORD *info, void *context);
42 void win32_seh_init(void);
43 void win32_seh_cleanup(void);
44 void win32_seh_set_handler(int type, MonoW32ExceptionHandler handler);
45
46 #ifndef SIGFPE
47 #define SIGFPE 4
48 #endif
49
50 #ifndef SIGILL
51 #define SIGILL 8
52 #endif
53
54 #ifndef SIGSEGV
55 #define SIGSEGV 11
56 #endif
57
58 LONG CALLBACK seh_handler(EXCEPTION_POINTERS* ep);
59
60 #endif /* HOST_WIN32 */
61
62 #ifdef sun    // Solaris x86
63 #  undef SIGSEGV_ON_ALTSTACK
64 #  define MONO_ARCH_NOMAP32BIT
65
66 struct sigcontext {
67         unsigned short gs, __gsh;
68         unsigned short fs, __fsh;
69         unsigned short es, __esh;
70         unsigned short ds, __dsh;
71         unsigned long edi;
72         unsigned long esi;
73         unsigned long ebp;
74         unsigned long esp;
75         unsigned long ebx;
76         unsigned long edx;
77         unsigned long ecx;
78         unsigned long eax;
79         unsigned long trapno;
80         unsigned long err;
81         unsigned long eip;
82         unsigned short cs, __csh;
83         unsigned long eflags;
84         unsigned long esp_at_signal;
85         unsigned short ss, __ssh;
86         unsigned long fpstate[95];
87       unsigned long filler[5];
88 };
89 #endif  // sun, Solaris x86
90
91 #define MONO_ARCH_SUPPORT_SIMD_INTRINSICS 1
92
93 #ifndef DISABLE_SIMD
94 #define MONO_ARCH_SIMD_INTRINSICS 1
95 #define MONO_ARCH_NEED_SIMD_BANK 1
96 #define MONO_ARCH_USE_SHARED_FP_SIMD_BANK 1
97 #endif
98
99
100
101 #define MONO_ARCH_SIGNAL_STACK_SIZE (16 * 1024)
102
103 #define MONO_ARCH_HAVE_RESTORE_STACK_SUPPORT 1
104
105 #define MONO_ARCH_CPU_SPEC amd64_desc
106
107 #define MONO_MAX_IREGS 16
108
109 #define MONO_MAX_FREGS AMD64_XMM_NREG
110
111 #define MONO_ARCH_FP_RETURN_REG AMD64_XMM0
112
113 /* xmm15 is reserved for use by some opcodes */
114 #define MONO_ARCH_CALLEE_FREGS 0x7fff
115 #define MONO_ARCH_CALLEE_SAVED_FREGS 0
116
117 #define MONO_MAX_XREGS MONO_MAX_FREGS
118
119 #define MONO_ARCH_CALLEE_XREGS 0x7fff
120 #define MONO_ARCH_CALLEE_SAVED_XREGS 0
121
122
123 #define MONO_ARCH_CALLEE_REGS AMD64_CALLEE_REGS
124 #define MONO_ARCH_CALLEE_SAVED_REGS AMD64_CALLEE_SAVED_REGS
125
126 #define MONO_ARCH_USE_FPSTACK FALSE
127 #define MONO_ARCH_FPSTACK_SIZE 0
128
129 #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 : -1))))))
130
131 /* RDX is clobbered by the opcode implementation before accessing sreg2 */
132 #define MONO_ARCH_INST_SREG2_MASK(ins) (((ins [MONO_INST_CLOB] == 'a') || (ins [MONO_INST_CLOB] == 'd')) ? (1 << AMD64_RDX) : 0)
133
134 #define MONO_ARCH_INST_IS_REGPAIR(desc) FALSE
135 #define MONO_ARCH_INST_REGPAIR_REG2(desc,hreg1) (-1)
136
137 #define MONO_ARCH_FRAME_ALIGNMENT 16
138
139 /* fixme: align to 16byte instead of 32byte (we align to 32byte to get 
140  * reproduceable results for benchmarks */
141 #define MONO_ARCH_CODE_ALIGNMENT 32
142
143 #define MONO_ARCH_RETREG1 X86_EAX
144 #define MONO_ARCH_RETREG2 X86_EDX
145
146 /*This is the max size of the locals area of a given frame. I think 1MB is a safe default for now*/
147 #define MONO_ARCH_MAX_FRAME_SIZE 0x100000
148
149 struct MonoLMF {
150         /* 
151          * If the lowest bit is set to 1, then this LMF has the rip field set. Otherwise,
152          * the rip field is not set, and the rsp field points to the stack location where
153          * the caller ip is saved.
154          * If the second lowest bit is set to 1, then this is a MonoLMFExt structure, and
155          * the other fields are not valid.
156          */
157         gpointer    previous_lmf;
158         gpointer    lmf_addr;
159         /* This is only set in trampoline LMF frames */
160         MonoMethod *method;
161 #if defined(__default_codegen__) || defined(HOST_WIN32)
162         guint64     rip;
163 #elif defined(__native_client_codegen__)
164         /* On 64-bit compilers, default alignment is 8 for this field, */
165         /* this allows the structure to match for 32-bit compilers.    */
166         guint64     rip __attribute__ ((aligned(8)));
167 #endif
168         guint64     rbx;
169         guint64     rbp;
170         guint64     rsp;
171         guint64     r12;
172         guint64     r13;
173         guint64     r14;
174         guint64     r15;
175 #ifdef HOST_WIN32
176         guint64     rdi;
177         guint64     rsi;
178 #endif
179 };
180
181 typedef struct MonoCompileArch {
182         gint32 lmf_offset;
183         gint32 localloc_offset;
184         gint32 reg_save_area_offset;
185         gint32 stack_alloc_size;
186         gint32 sp_fp_offset;
187         gboolean omit_fp, omit_fp_computed, no_pushes;
188         gpointer cinfo;
189         gint32 async_point_count;
190         gpointer vret_addr_loc;
191 #ifdef HOST_WIN32
192         gpointer        unwindinfo;
193 #endif
194         gpointer ss_trigger_page_var;
195 } MonoCompileArch;
196
197 typedef struct {
198         guint64 rax;
199         guint64 rbx;
200         guint64 rcx;
201         guint64 rdx;
202         guint64 rbp;
203         guint64 rsp;
204     guint64 rsi;
205         guint64 rdi;
206         guint64 rip;
207         guint64 r12;
208         guint64 r13;
209         guint64 r14;
210         guint64 r15;
211 } MonoContext;
212
213 #define MONO_CONTEXT_SET_IP(ctx,ip) do { (ctx)->rip = (guint64)(ip); } while (0); 
214 #define MONO_CONTEXT_SET_BP(ctx,bp) do { (ctx)->rbp = (guint64)(bp); } while (0); 
215 #define MONO_CONTEXT_SET_SP(ctx,esp) do { (ctx)->rsp = (guint64)(esp); } while (0); 
216
217 #define MONO_CONTEXT_GET_IP(ctx) ((gpointer)((ctx)->rip))
218 #define MONO_CONTEXT_GET_BP(ctx) ((gpointer)((ctx)->rbp))
219 #define MONO_CONTEXT_GET_SP(ctx) ((gpointer)((ctx)->rsp))
220
221 #define MONO_CONTEXT_SET_LLVM_EXC_REG(ctx, exc) do { (ctx)->rax = (gsize)exc; } while (0)
222
223 #define MONO_ARCH_INIT_TOP_LMF_ENTRY(lmf)
224
225 #ifdef _MSC_VER
226
227 #define MONO_INIT_CONTEXT_FROM_FUNC(ctx, start_func) do { \
228     guint64 stackptr; \
229         mono_arch_flush_register_windows (); \
230         stackptr = ((guint64)_AddressOfReturnAddress () - sizeof (void*));\
231         MONO_CONTEXT_SET_IP ((ctx), (start_func)); \
232         MONO_CONTEXT_SET_BP ((ctx), stackptr); \
233         MONO_CONTEXT_SET_SP ((ctx), stackptr); \
234 } while (0)
235
236 #else
237
238 /* 
239  * __builtin_frame_address () is broken on some older gcc versions in the presence of
240  * frame pointer elimination, see bug #82095.
241  */
242 #define MONO_INIT_CONTEXT_FROM_FUNC(ctx,start_func) do {        \
243         int tmp; \
244         guint64 stackptr = (guint64)&tmp; \
245                 mono_arch_flush_register_windows ();    \
246                 MONO_CONTEXT_SET_IP ((ctx), (start_func));      \
247                 MONO_CONTEXT_SET_BP ((ctx), stackptr);  \
248                 MONO_CONTEXT_SET_SP ((ctx), stackptr);  \
249         } while (0)
250
251 #endif
252
253 /*
254  * some icalls like mono_array_new_va needs to be called using a different 
255  * calling convention.
256  */
257 #define MONO_ARCH_VARARG_ICALLS 1
258
259 #if !defined( HOST_WIN32 ) && !defined(__native_client__) && !defined(__native_client_codegen__)
260
261 #define MONO_ARCH_USE_SIGACTION 1
262
263 #ifdef HAVE_WORKING_SIGALTSTACK
264
265 #define MONO_ARCH_SIGSEGV_ON_ALTSTACK
266
267 #endif
268
269 #endif /* !HOST_WIN32 && !__native_client__ */
270
271 #if defined (__APPLE__)
272
273 #define MONO_ARCH_NOMAP32BIT
274
275 #elif defined (__NetBSD__)
276
277 #define REG_RAX 14
278 #define REG_RCX 3
279 #define REG_RDX 2
280 #define REG_RBX 13
281 #define REG_RSP 24
282 #define REG_RBP 12
283 #define REG_RSI 1
284 #define REG_RDI 0
285 #define REG_R8 4
286 #define REG_R9 5
287 #define REG_R10 6
288 #define REG_R11 7
289 #define REG_R12 8
290 #define REG_R13 9
291 #define REG_R14 10
292 #define REG_R15 11
293 #define REG_RIP 21
294
295 #define MONO_ARCH_NOMAP32BIT
296
297 #elif defined (__OpenBSD__)
298
299 #define MONO_ARCH_NOMAP32BIT
300
301 #elif defined (__FreeBSD__)
302
303 #define REG_RAX 7
304 #define REG_RCX 4
305 #define REG_RDX 3
306 #define REG_RBX 8
307 #define REG_RSP 23
308 #define REG_RBP 9
309 #define REG_RSI 2
310 #define REG_RDI 1
311 #define REG_R8  5
312 #define REG_R9  6
313 #define REG_R10 10
314 #define REG_R11 11
315 #define REG_R12 12
316 #define REG_R13 13
317 #define REG_R14 14
318 #define REG_R15 15
319 #define REG_RIP 20
320
321 /* 
322  * FreeBSD does not have MAP_32BIT, so code allocated by the code manager might not have a
323  * 32 bit address.
324  */
325 #define MONO_ARCH_NOMAP32BIT
326
327 #endif /* __FreeBSD__ */
328
329 #ifdef HOST_WIN32
330 #define MONO_AMD64_ARG_REG1 AMD64_RCX
331 #define MONO_AMD64_ARG_REG2 AMD64_RDX
332 #else
333 #define MONO_AMD64_ARG_REG1 AMD64_RDI
334 #define MONO_AMD64_ARG_REG2 AMD64_RSI
335 #endif
336
337 #define MONO_ARCH_NO_EMULATE_LONG_SHIFT_OPS
338 #define MONO_ARCH_NO_EMULATE_LONG_MUL_OPTS
339
340 #define MONO_ARCH_EMULATE_CONV_R8_UN    1
341 #define MONO_ARCH_EMULATE_FREM 1
342 #define MONO_ARCH_HAVE_IS_INT_OVERFLOW 1
343
344 #define MONO_ARCH_ENABLE_REGALLOC_IN_EH_BLOCKS 1
345 #define MONO_ARCH_ENABLE_MONO_LMF_VAR 1
346 #define MONO_ARCH_HAVE_INVALIDATE_METHOD 1
347 #define MONO_ARCH_HAVE_CREATE_DELEGATE_TRAMPOLINE 1
348 #define MONO_ARCH_HAVE_ATOMIC_ADD 1
349 #define MONO_ARCH_HAVE_ATOMIC_EXCHANGE 1
350 #define MONO_ARCH_HAVE_ATOMIC_CAS 1
351 #define MONO_ARCH_HAVE_FULL_AOT_TRAMPOLINES 1
352 #define MONO_ARCH_HAVE_FULL_AOT_TRAMPOLINES_2 1
353 #define MONO_ARCH_HAVE_IMT 1
354 #define MONO_ARCH_HAVE_TLS_GET 1
355 #define MONO_ARCH_IMT_REG AMD64_R10
356 #define MONO_ARCH_IMT_SCRATCH_REG AMD64_R11
357 #define MONO_ARCH_VTABLE_REG MONO_AMD64_ARG_REG1
358 /*
359  * We use r10 for the imt/rgctx register rather than r11 because r11 is
360  * used by the trampoline as a scratch register and hence might be
361  * clobbered across method call boundaries.
362  */
363 #define MONO_ARCH_RGCTX_REG AMD64_R10
364 #define MONO_ARCH_HAVE_CMOV_OPS 1
365 #define MONO_ARCH_HAVE_NOTIFY_PENDING_EXC 1
366 #define MONO_ARCH_HAVE_EXCEPTIONS_INIT 1
367 #define MONO_ARCH_ENABLE_GLOBAL_RA 1
368 #define MONO_ARCH_HAVE_GENERALIZED_IMT_THUNK 1
369 #define MONO_ARCH_HAVE_LIVERANGE_OPS 1
370 #define MONO_ARCH_HAVE_XP_UNWIND 1
371 #define MONO_ARCH_HAVE_SIGCTX_TO_MONOCTX 1
372 #if !defined(HOST_WIN32)
373 #define MONO_ARCH_MONITOR_OBJECT_REG MONO_AMD64_ARG_REG1
374 #endif
375 #define MONO_ARCH_HAVE_STATIC_RGCTX_TRAMPOLINE 1
376 #define MONO_ARCH_HAVE_GET_TRAMPOLINES 1
377
378 #define MONO_ARCH_AOT_SUPPORTED 1
379 #if !defined( HOST_WIN32 ) && !defined( __native_client__ )
380 #define MONO_ARCH_SOFT_DEBUG_SUPPORTED 1
381 #else
382 #define DISABLE_DEBUGGER_AGENT 1
383 #endif
384
385 #if !defined(HOST_WIN32) || defined(__sun)
386 #define MONO_ARCH_ENABLE_MONITOR_IL_FASTPATH 1
387 #endif
388
389 #define MONO_ARCH_SUPPORT_TASKLETS 1
390
391 #ifndef HOST_WIN32
392 #define MONO_AMD64_NO_PUSHES 1
393 #endif
394
395 #define MONO_ARCH_GSHARED_SUPPORTED 1
396 #define MONO_ARCH_DYN_CALL_SUPPORTED 1
397 #define MONO_ARCH_DYN_CALL_PARAM_AREA 0
398
399 #define MONO_ARCH_HAVE_LLVM_IMT_TRAMPOLINE 1
400 #define MONO_ARCH_LLVM_SUPPORTED 1
401 #define MONO_ARCH_THIS_AS_FIRST_ARG 1
402 #define MONO_ARCH_HAVE_HANDLER_BLOCK_GUARD 1
403 #define MONO_ARCH_HAVE_CARD_TABLE_WBARRIER 1
404 #define MONO_ARCH_HAVE_SETUP_RESUME_FROM_SIGNAL_HANDLER_CTX 1
405 #define MONO_ARCH_GC_MAPS_SUPPORTED 1
406
407 gboolean
408 mono_amd64_tail_call_supported (MonoMethodSignature *caller_sig, MonoMethodSignature *callee_sig) MONO_INTERNAL;
409
410 #define MONO_ARCH_USE_OP_TAIL_CALL(caller_sig, callee_sig) mono_amd64_tail_call_supported (caller_sig, callee_sig)
411
412 /* Used for optimization, not complete */
413 #define MONO_ARCH_IS_OP_MEMBASE(opcode) ((opcode) == OP_X86_PUSH_MEMBASE)
414
415 #define MONO_ARCH_EMIT_BOUNDS_CHECK(cfg, array_reg, offset, index_reg) do { \
416             MonoInst *inst; \
417             MONO_INST_NEW ((cfg), inst, OP_AMD64_ICOMPARE_MEMBASE_REG); \
418             inst->inst_basereg = array_reg; \
419             inst->inst_offset = offset; \
420             inst->sreg2 = index_reg; \
421             MONO_ADD_INS ((cfg)->cbb, inst); \
422             MONO_EMIT_NEW_COND_EXC (cfg, LE_UN, "IndexOutOfRangeException"); \
423        } while (0)
424
425 void 
426 mono_amd64_patch (unsigned char* code, gpointer target) MONO_INTERNAL;
427
428 void
429 mono_amd64_throw_exception (guint64 dummy1, guint64 dummy2, guint64 dummy3, guint64 dummy4,
430                                                         guint64 dummy5, guint64 dummy6,
431                                                         mgreg_t *regs, mgreg_t rip,
432                                                         MonoObject *exc, gboolean rethrow) MONO_INTERNAL;
433
434 void
435 mono_amd64_throw_corlib_exception (guint64 dummy1, guint64 dummy2, guint64 dummy3, guint64 dummy4,
436                                                                    guint64 dummy5, guint64 dummy6,
437                                                                    mgreg_t *regs, mgreg_t rip,
438                                                                    guint32 ex_token_index, gint64 pc_offset) MONO_INTERNAL;
439
440 guint64
441 mono_amd64_get_original_ip (void) MONO_INTERNAL;
442
443 guint8*
444 mono_amd64_emit_tls_get (guint8* code, int dreg, int tls_offset) MONO_INTERNAL;
445
446 GSList*
447 mono_amd64_get_exception_trampolines (gboolean aot) MONO_INTERNAL;
448
449 typedef struct {
450         guint8 *address;
451         guint8 saved_byte;
452 } MonoBreakpointInfo;
453
454 extern MonoBreakpointInfo mono_breakpoint_info [MONO_BREAKPOINT_ARRAY_SIZE];
455
456 #ifdef HOST_WIN32
457
458 void mono_arch_unwindinfo_add_push_nonvol (gpointer* monoui, gpointer codebegin, gpointer nextip, guchar reg );
459 void mono_arch_unwindinfo_add_set_fpreg (gpointer* monoui, gpointer codebegin, gpointer nextip, guchar reg );
460 void mono_arch_unwindinfo_add_alloc_stack (gpointer* monoui, gpointer codebegin, gpointer nextip, guint size );
461 guint mono_arch_unwindinfo_get_size (gpointer monoui);
462 void mono_arch_unwindinfo_install_unwind_info (gpointer* monoui, gpointer code, guint code_size);
463
464 #define MONO_ARCH_HAVE_UNWIND_TABLE 1
465 #endif
466
467 #endif /* __MONO_MINI_AMD64_H__ */  
468