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