02005ebd9901557b466872b7a278f1b46f36fa62
[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 #define MONO_ARCH_SUPPORT_SIMD_INTRINSICS 1
93
94 #ifndef DISABLE_SIMD
95 #define MONO_ARCH_SIMD_INTRINSICS 1
96 #define MONO_ARCH_NEED_SIMD_BANK 1
97 #define MONO_ARCH_USE_SHARED_FP_SIMD_BANK 1
98 #endif
99
100
101
102 #define MONO_ARCH_SIGNAL_STACK_SIZE (16 * 1024)
103
104 #define MONO_ARCH_HAVE_RESTORE_STACK_SUPPORT 1
105
106 #define MONO_ARCH_CPU_SPEC amd64_desc
107
108 #define MONO_MAX_IREGS 16
109
110 #define MONO_MAX_FREGS AMD64_XMM_NREG
111
112 #define MONO_ARCH_FP_RETURN_REG AMD64_XMM0
113
114 /* xmm15 is reserved for use by some opcodes */
115 #define MONO_ARCH_CALLEE_FREGS 0x7fff
116 #define MONO_ARCH_CALLEE_SAVED_FREGS 0
117
118 #define MONO_MAX_XREGS MONO_MAX_FREGS
119
120 #define MONO_ARCH_CALLEE_XREGS 0x7fff
121 #define MONO_ARCH_CALLEE_SAVED_XREGS 0
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 : -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 #define MONO_ARCH_RETREG1 X86_EAX
145 #define MONO_ARCH_RETREG2 X86_EDX
146
147 /*This is the max size of the locals area of a given frame. I think 1MB is a safe default for now*/
148 #define MONO_ARCH_MAX_FRAME_SIZE 0x100000
149
150 struct MonoLMF {
151         /* 
152          * If the lowest bit is set to 1, then this LMF has the rip field set. Otherwise,
153          * the rip field is not set, and the rsp field points to the stack location where
154          * the caller ip is saved.
155          * If the second lowest bit is set to 1, then this is a MonoLMFExt structure, and
156          * the other fields are not valid.
157          */
158         gpointer    previous_lmf;
159         gpointer    lmf_addr;
160         /* This is only set in trampoline LMF frames */
161         MonoMethod *method;
162 #if defined(__default_codegen__) || defined(HOST_WIN32)
163         guint64     rip;
164 #elif defined(__native_client_codegen__)
165         /* On 64-bit compilers, default alignment is 8 for this field, */
166         /* this allows the structure to match for 32-bit compilers.    */
167         guint64     rip __attribute__ ((aligned(8)));
168 #endif
169         guint64     rbx;
170         guint64     rbp;
171         guint64     rsp;
172         guint64     r12;
173         guint64     r13;
174         guint64     r14;
175         guint64     r15;
176 #ifdef HOST_WIN32
177         guint64     rdi;
178         guint64     rsi;
179 #endif
180 };
181
182 typedef struct MonoCompileArch {
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         gpointer lmf_var;
196 } MonoCompileArch;
197
198 #define MONO_CONTEXT_SET_LLVM_EXC_REG(ctx, exc) do { (ctx)->rax = (gsize)exc; } while (0)
199
200 #define MONO_ARCH_INIT_TOP_LMF_ENTRY(lmf)
201
202 #ifdef _MSC_VER
203
204 #define MONO_INIT_CONTEXT_FROM_FUNC(ctx, start_func) do { \
205     guint64 stackptr; \
206         mono_arch_flush_register_windows (); \
207         stackptr = ((guint64)_AddressOfReturnAddress () - sizeof (void*));\
208         MONO_CONTEXT_SET_IP ((ctx), (start_func)); \
209         MONO_CONTEXT_SET_BP ((ctx), stackptr); \
210         MONO_CONTEXT_SET_SP ((ctx), stackptr); \
211 } while (0)
212
213 #else
214
215 /* 
216  * __builtin_frame_address () is broken on some older gcc versions in the presence of
217  * frame pointer elimination, see bug #82095.
218  */
219 #define MONO_INIT_CONTEXT_FROM_FUNC(ctx,start_func) do {        \
220         int tmp; \
221         guint64 stackptr = (guint64)&tmp; \
222                 mono_arch_flush_register_windows ();    \
223                 MONO_CONTEXT_SET_IP ((ctx), (start_func));      \
224                 MONO_CONTEXT_SET_BP ((ctx), stackptr);  \
225                 MONO_CONTEXT_SET_SP ((ctx), stackptr);  \
226         } while (0)
227
228 #endif
229
230 /*
231  * some icalls like mono_array_new_va needs to be called using a different 
232  * calling convention.
233  */
234 #define MONO_ARCH_VARARG_ICALLS 1
235
236 #if !defined( HOST_WIN32 ) && !defined(__native_client__) && !defined(__native_client_codegen__)
237
238 #define MONO_ARCH_USE_SIGACTION 1
239
240 #ifdef HAVE_WORKING_SIGALTSTACK
241
242 #define MONO_ARCH_SIGSEGV_ON_ALTSTACK
243
244 #endif
245
246 #endif /* !HOST_WIN32 && !__native_client__ */
247
248 #if defined (__APPLE__)
249
250 #define MONO_ARCH_NOMAP32BIT
251
252 #elif defined (__NetBSD__)
253
254 #define REG_RAX 14
255 #define REG_RCX 3
256 #define REG_RDX 2
257 #define REG_RBX 13
258 #define REG_RSP 24
259 #define REG_RBP 12
260 #define REG_RSI 1
261 #define REG_RDI 0
262 #define REG_R8 4
263 #define REG_R9 5
264 #define REG_R10 6
265 #define REG_R11 7
266 #define REG_R12 8
267 #define REG_R13 9
268 #define REG_R14 10
269 #define REG_R15 11
270 #define REG_RIP 21
271
272 #define MONO_ARCH_NOMAP32BIT
273
274 #elif defined (__OpenBSD__)
275
276 #define MONO_ARCH_NOMAP32BIT
277
278 #elif defined (__FreeBSD__)
279
280 #define REG_RAX 7
281 #define REG_RCX 4
282 #define REG_RDX 3
283 #define REG_RBX 8
284 #define REG_RSP 23
285 #define REG_RBP 9
286 #define REG_RSI 2
287 #define REG_RDI 1
288 #define REG_R8  5
289 #define REG_R9  6
290 #define REG_R10 10
291 #define REG_R11 11
292 #define REG_R12 12
293 #define REG_R13 13
294 #define REG_R14 14
295 #define REG_R15 15
296 #define REG_RIP 20
297
298 /* 
299  * FreeBSD does not have MAP_32BIT, so code allocated by the code manager might not have a
300  * 32 bit address.
301  */
302 #define MONO_ARCH_NOMAP32BIT
303
304 #endif /* __FreeBSD__ */
305
306 #ifdef HOST_WIN32
307 #define MONO_AMD64_ARG_REG1 AMD64_RCX
308 #define MONO_AMD64_ARG_REG2 AMD64_RDX
309 #else
310 #define MONO_AMD64_ARG_REG1 AMD64_RDI
311 #define MONO_AMD64_ARG_REG2 AMD64_RSI
312 #endif
313
314 #define MONO_ARCH_NO_EMULATE_LONG_SHIFT_OPS
315 #define MONO_ARCH_NO_EMULATE_LONG_MUL_OPTS
316
317 #define MONO_ARCH_EMULATE_CONV_R8_UN    1
318 #define MONO_ARCH_EMULATE_FREM 1
319 #define MONO_ARCH_HAVE_IS_INT_OVERFLOW 1
320
321 #define MONO_ARCH_ENABLE_REGALLOC_IN_EH_BLOCKS 1
322 #define MONO_ARCH_ENABLE_MONO_LMF_VAR 1
323 #define MONO_ARCH_HAVE_INVALIDATE_METHOD 1
324 #define MONO_ARCH_HAVE_CREATE_DELEGATE_TRAMPOLINE 1
325 #define MONO_ARCH_HAVE_ATOMIC_ADD 1
326 #define MONO_ARCH_HAVE_ATOMIC_EXCHANGE 1
327 #define MONO_ARCH_HAVE_ATOMIC_CAS 1
328 #define MONO_ARCH_HAVE_FULL_AOT_TRAMPOLINES 1
329 #define MONO_ARCH_HAVE_IMT 1
330 #define MONO_ARCH_HAVE_TLS_GET (mono_amd64_have_tls_get ())
331 #define MONO_ARCH_IMT_REG AMD64_R10
332 #define MONO_ARCH_IMT_SCRATCH_REG AMD64_R11
333 #define MONO_ARCH_VTABLE_REG MONO_AMD64_ARG_REG1
334 /*
335  * We use r10 for the imt/rgctx register rather than r11 because r11 is
336  * used by the trampoline as a scratch register and hence might be
337  * clobbered across method call boundaries.
338  */
339 #define MONO_ARCH_RGCTX_REG AMD64_R10
340 #define MONO_ARCH_HAVE_CMOV_OPS 1
341 #define MONO_ARCH_HAVE_NOTIFY_PENDING_EXC 1
342 #define MONO_ARCH_HAVE_EXCEPTIONS_INIT 1
343 #define MONO_ARCH_ENABLE_GLOBAL_RA 1
344 #define MONO_ARCH_HAVE_GENERALIZED_IMT_THUNK 1
345 #define MONO_ARCH_HAVE_LIVERANGE_OPS 1
346 #define MONO_ARCH_HAVE_XP_UNWIND 1
347 #define MONO_ARCH_HAVE_SIGCTX_TO_MONOCTX 1
348 #if !defined(HOST_WIN32)
349 #define MONO_ARCH_MONITOR_OBJECT_REG MONO_AMD64_ARG_REG1
350 #endif
351 #define MONO_ARCH_HAVE_STATIC_RGCTX_TRAMPOLINE 1
352 #define MONO_ARCH_HAVE_GET_TRAMPOLINES 1
353
354 #define MONO_ARCH_AOT_SUPPORTED 1
355 #if !defined( HOST_WIN32 ) && !defined( __native_client__ )
356 #define MONO_ARCH_SOFT_DEBUG_SUPPORTED 1
357 #endif
358
359 #if !defined(HOST_WIN32) || defined(__sun)
360 #define MONO_ARCH_ENABLE_MONITOR_IL_FASTPATH 1
361 #endif
362
363 #define MONO_ARCH_SUPPORT_TASKLETS 1
364
365 #ifndef HOST_WIN32
366 #define MONO_AMD64_NO_PUSHES 1
367 #endif
368
369 #define MONO_ARCH_GSHARED_SUPPORTED 1
370 #define MONO_ARCH_DYN_CALL_SUPPORTED 1
371 #define MONO_ARCH_DYN_CALL_PARAM_AREA 0
372
373 #define MONO_ARCH_HAVE_LLVM_IMT_TRAMPOLINE 1
374 #define MONO_ARCH_LLVM_SUPPORTED 1
375 #define MONO_ARCH_THIS_AS_FIRST_ARG 1
376 #define MONO_ARCH_HAVE_HANDLER_BLOCK_GUARD 1
377 #define MONO_ARCH_HAVE_CARD_TABLE_WBARRIER 1
378 #define MONO_ARCH_HAVE_SETUP_RESUME_FROM_SIGNAL_HANDLER_CTX 1
379 #define MONO_ARCH_GC_MAPS_SUPPORTED 1
380 #define MONO_ARCH_HAVE_CONTEXT_SET_INT_REG 1
381
382 gboolean
383 mono_amd64_tail_call_supported (MonoMethodSignature *caller_sig, MonoMethodSignature *callee_sig) MONO_INTERNAL;
384
385 #define MONO_ARCH_USE_OP_TAIL_CALL(caller_sig, callee_sig) mono_amd64_tail_call_supported (caller_sig, callee_sig)
386
387 /* Used for optimization, not complete */
388 #define MONO_ARCH_IS_OP_MEMBASE(opcode) ((opcode) == OP_X86_PUSH_MEMBASE)
389
390 #define MONO_ARCH_EMIT_BOUNDS_CHECK(cfg, array_reg, offset, index_reg) do { \
391             MonoInst *inst; \
392             MONO_INST_NEW ((cfg), inst, OP_AMD64_ICOMPARE_MEMBASE_REG); \
393             inst->inst_basereg = array_reg; \
394             inst->inst_offset = offset; \
395             inst->sreg2 = index_reg; \
396             MONO_ADD_INS ((cfg)->cbb, inst); \
397             MONO_EMIT_NEW_COND_EXC (cfg, LE_UN, "IndexOutOfRangeException"); \
398        } while (0)
399
400 void 
401 mono_amd64_patch (unsigned char* code, gpointer target) MONO_INTERNAL;
402
403 void
404 mono_amd64_throw_exception (guint64 dummy1, guint64 dummy2, guint64 dummy3, guint64 dummy4,
405                                                         guint64 dummy5, guint64 dummy6,
406                                                         mgreg_t *regs, mgreg_t rip,
407                                                         MonoObject *exc, gboolean rethrow) MONO_INTERNAL;
408
409 void
410 mono_amd64_throw_corlib_exception (guint64 dummy1, guint64 dummy2, guint64 dummy3, guint64 dummy4,
411                                                                    guint64 dummy5, guint64 dummy6,
412                                                                    mgreg_t *regs, mgreg_t rip,
413                                                                    guint32 ex_token_index, gint64 pc_offset) MONO_INTERNAL;
414
415 guint64
416 mono_amd64_get_original_ip (void) MONO_INTERNAL;
417
418 guint8*
419 mono_amd64_emit_tls_get (guint8* code, int dreg, int tls_offset) MONO_INTERNAL;
420
421 gboolean
422 mono_amd64_have_tls_get (void) MONO_INTERNAL;
423
424 GSList*
425 mono_amd64_get_exception_trampolines (gboolean aot) MONO_INTERNAL;
426
427 typedef struct {
428         guint8 *address;
429         guint8 saved_byte;
430 } MonoBreakpointInfo;
431
432 extern MonoBreakpointInfo mono_breakpoint_info [MONO_BREAKPOINT_ARRAY_SIZE];
433
434 #ifdef HOST_WIN32
435
436 void mono_arch_unwindinfo_add_push_nonvol (gpointer* monoui, gpointer codebegin, gpointer nextip, guchar reg );
437 void mono_arch_unwindinfo_add_set_fpreg (gpointer* monoui, gpointer codebegin, gpointer nextip, guchar reg );
438 void mono_arch_unwindinfo_add_alloc_stack (gpointer* monoui, gpointer codebegin, gpointer nextip, guint size );
439 guint mono_arch_unwindinfo_get_size (gpointer monoui);
440 void mono_arch_unwindinfo_install_unwind_info (gpointer* monoui, gpointer code, guint code_size);
441
442 #define MONO_ARCH_HAVE_UNWIND_TABLE 1
443 #endif
444
445 #endif /* __MONO_MINI_AMD64_H__ */  
446