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