2 * mono-context.h: plat independent machine state definitions
5 * Copyright (c) 2011 Novell, Inc (http://www.novell.com)
9 #ifndef __MONO_MONO_CONTEXT_H__
10 #define __MONO_MONO_CONTEXT_H__
12 #include "mono-compiler.h"
13 #include "mono-sigcontext.h"
14 #include "mono-machine.h"
21 #include <libunwind.h>
25 * General notes about mono-context.
26 * Each arch defines a MonoContext struct with all GPR regs + IP/PC.
27 * IP/PC should be the last element of the struct (this is a mild sgen constraint we could drop if needed)
28 * Macros to get/set BP, SP and IP are defined too.
29 * MONO_CONTEXT_GET_CURRENT captures the current context as close as possible. One reg might be clobbered
30 * to hold the address of the target MonoContext. It will be a caller save one, so should not be a problem.
32 #if (defined(__i386__) && !defined(MONO_CROSS_COMPILE)) || (defined(TARGET_X86))
34 /*HACK, move this to an eventual mono-signal.c*/
35 #if defined( __linux__) || defined(__sun) || defined(__APPLE__) || defined(__NetBSD__) || \
36 defined(__FreeBSD__) || defined(__OpenBSD__)
38 #define MONO_SIGNAL_USE_SIGACTION 1
42 #if defined(__native_client__)
43 #undef MONO_SIGNAL_USE_SIGACTION
47 /* sigcontext surrogate */
61 #if defined(__FreeBSD__) || defined(__NetBSD__) || defined(__OpenBSD__) || defined(__APPLE__)
62 # define SC_EAX sc_eax
63 # define SC_EBX sc_ebx
64 # define SC_ECX sc_ecx
65 # define SC_EDX sc_edx
66 # define SC_EBP sc_ebp
67 # define SC_EIP sc_eip
68 # define SC_ESP sc_esp
69 # define SC_EDI sc_edi
70 # define SC_ESI sc_esi
71 #elif defined(__HAIKU__)
72 # define SC_EAX regs.eax
73 # define SC_EBX regs._reserved_2[2]
74 # define SC_ECX regs.ecx
75 # define SC_EDX regs.edx
76 # define SC_EBP regs.ebp
77 # define SC_EIP regs.eip
78 # define SC_ESP regs.esp
79 # define SC_EDI regs._reserved_2[0]
80 # define SC_ESI regs._reserved_2[1]
105 #define MONO_CONTEXT_SET_IP(ctx,ip) do { (ctx)->eip = (mgreg_t)(ip); } while (0);
106 #define MONO_CONTEXT_SET_BP(ctx,bp) do { (ctx)->ebp = (mgreg_t)(bp); } while (0);
107 #define MONO_CONTEXT_SET_SP(ctx,sp) do { (ctx)->esp = (mgreg_t)(sp); } while (0);
109 #define MONO_CONTEXT_GET_IP(ctx) ((gpointer)((ctx)->eip))
110 #define MONO_CONTEXT_GET_BP(ctx) ((gpointer)((ctx)->ebp))
111 #define MONO_CONTEXT_GET_SP(ctx) ((gpointer)((ctx)->esp))
113 /*We set EAX to zero since we are clobering it anyway*/
115 #define MONO_CONTEXT_GET_CURRENT(ctx) do { \
116 void *_ptr = &(ctx); \
118 __asm mov eax, _ptr \
119 __asm mov [eax+0x00], eax \
120 __asm mov [eax+0x04], ebx \
121 __asm mov [eax+0x08], ecx \
122 __asm mov [eax+0x0c], edx \
123 __asm mov [eax+0x10], ebp \
124 __asm mov [eax+0x14], esp \
125 __asm mov [eax+0x18], esi \
126 __asm mov [eax+0x1c], edi \
127 __asm call __mono_context_get_ip \
128 __asm __mono_context_get_ip: \
129 __asm pop dword ptr [eax+0x20] \
133 #define MONO_CONTEXT_GET_CURRENT(ctx) \
134 __asm__ __volatile__( \
135 "movl $0x0, 0x00(%0)\n" \
136 "mov %%ebx, 0x04(%0)\n" \
137 "mov %%ecx, 0x08(%0)\n" \
138 "mov %%edx, 0x0c(%0)\n" \
139 "mov %%ebp, 0x10(%0)\n" \
140 "mov %%esp, 0x14(%0)\n" \
141 "mov %%esi, 0x18(%0)\n" \
142 "mov %%edi, 0x1c(%0)\n" \
144 "1: pop 0x20(%0)\n" \
150 #define MONO_ARCH_HAS_MONO_CONTEXT 1
152 #elif (defined(__x86_64__) && !defined(MONO_CROSS_COMPILE)) || (defined(TARGET_AMD64)) /* defined(__i386__) */
154 #include <mono/arch/amd64/amd64-codegen.h>
156 #if !defined( HOST_WIN32 ) && !defined(__native_client__) && !defined(__native_client_codegen__)
158 #ifdef HAVE_SIGACTION
159 #define MONO_SIGNAL_USE_SIGACTION 1
165 mgreg_t gregs [AMD64_NREG];
166 double fregs [AMD64_XMM_NREG];
169 #define MONO_CONTEXT_SET_IP(ctx,ip) do { (ctx)->gregs [AMD64_RIP] = (mgreg_t)(ip); } while (0);
170 #define MONO_CONTEXT_SET_BP(ctx,bp) do { (ctx)->gregs [AMD64_RBP] = (mgreg_t)(bp); } while (0);
171 #define MONO_CONTEXT_SET_SP(ctx,esp) do { (ctx)->gregs [AMD64_RSP] = (mgreg_t)(esp); } while (0);
173 #define MONO_CONTEXT_GET_IP(ctx) ((gpointer)((ctx)->gregs [AMD64_RIP]))
174 #define MONO_CONTEXT_GET_BP(ctx) ((gpointer)((ctx)->gregs [AMD64_RBP]))
175 #define MONO_CONTEXT_GET_SP(ctx) ((gpointer)((ctx)->gregs [AMD64_RSP]))
177 #if defined (HOST_WIN32) && !defined(__GNUC__)
178 /* msvc doesn't support inline assembly, so have to use a separate .asm file */
179 extern void mono_context_get_current (void *);
180 #define MONO_CONTEXT_GET_CURRENT(ctx) do { mono_context_get_current((void*)&(ctx)); } while (0)
182 #elif defined(__native_client__)
183 #define MONO_CONTEXT_GET_CURRENT(ctx) \
184 __asm__ __volatile__( \
185 "movq $0x0, %%nacl:0x00(%%r15, %0, 1)\n" \
186 "movq %%rbx, %%nacl:0x08(%%r15, %0, 1)\n" \
187 "movq %%rcx, %%nacl:0x10(%%r15, %0, 1)\n" \
188 "movq %%rdx, %%nacl:0x18(%%r15, %0, 1)\n" \
189 "movq %%rbp, %%nacl:0x20(%%r15, %0, 1)\n" \
190 "movq %%rsp, %%nacl:0x28(%%r15, %0, 1)\n" \
191 "movq %%rsi, %%nacl:0x30(%%r15, %0, 1)\n" \
192 "movq %%rdi, %%nacl:0x38(%%r15, %0, 1)\n" \
193 "movq %%r8, %%nacl:0x40(%%r15, %0, 1)\n" \
194 "movq %%r9, %%nacl:0x48(%%r15, %0, 1)\n" \
195 "movq %%r10, %%nacl:0x50(%%r15, %0, 1)\n" \
196 "movq %%r11, %%nacl:0x58(%%r15, %0, 1)\n" \
197 "movq %%r12, %%nacl:0x60(%%r15, %0, 1)\n" \
198 "movq %%r13, %%nacl:0x68(%%r15, %0, 1)\n" \
199 "movq %%r14, %%nacl:0x70(%%r15, %0, 1)\n" \
200 "movq %%r15, %%nacl:0x78(%%r15, %0, 1)\n" \
201 "leaq (%%rip), %%rdx\n" \
202 "movq %%rdx, %%nacl:0x80(%%r15, %0, 1)\n" \
204 : "a" ((int64_t)&(ctx)) \
207 #define MONO_CONTEXT_GET_CURRENT(ctx) \
208 __asm__ __volatile__( \
209 "movq $0x0, 0x00(%0)\n" \
210 "movq %%rbx, 0x08(%0)\n" \
211 "movq %%rcx, 0x10(%0)\n" \
212 "movq %%rdx, 0x18(%0)\n" \
213 "movq %%rbp, 0x20(%0)\n" \
214 "movq %%rsp, 0x28(%0)\n" \
215 "movq %%rsi, 0x30(%0)\n" \
216 "movq %%rdi, 0x38(%0)\n" \
217 "movq %%r8, 0x40(%0)\n" \
218 "movq %%r9, 0x48(%0)\n" \
219 "movq %%r10, 0x50(%0)\n" \
220 "movq %%r11, 0x58(%0)\n" \
221 "movq %%r12, 0x60(%0)\n" \
222 "movq %%r13, 0x68(%0)\n" \
223 "movq %%r14, 0x70(%0)\n" \
224 "movq %%r15, 0x78(%0)\n" \
225 /* "leaq (%%rip), %%rdx\n" is not understood by icc */ \
226 ".byte 0x48, 0x8d, 0x15, 0x00, 0x00, 0x00, 0x00\n" \
227 "movq %%rdx, 0x80(%0)\n" \
233 #define MONO_ARCH_HAS_MONO_CONTEXT 1
235 #elif (defined(__arm__) && !defined(MONO_CROSS_COMPILE)) || (defined(TARGET_ARM)) /* defined(__x86_64__) */
237 #include <mono/arch/arm/arm-codegen.h>
246 /* we have the stack pointer, not the base pointer in sigcontext */
247 #define MONO_CONTEXT_SET_IP(ctx,ip) do { (ctx)->pc = (mgreg_t)ip; } while (0);
248 #define MONO_CONTEXT_SET_BP(ctx,bp) do { (ctx)->regs [ARMREG_FP] = (mgreg_t)bp; } while (0);
249 #define MONO_CONTEXT_SET_SP(ctx,bp) do { (ctx)->regs [ARMREG_SP] = (mgreg_t)bp; } while (0);
251 #define MONO_CONTEXT_GET_IP(ctx) ((gpointer)((ctx)->pc))
252 #define MONO_CONTEXT_GET_BP(ctx) ((gpointer)((ctx)->regs [ARMREG_FP]))
253 #define MONO_CONTEXT_GET_SP(ctx) ((gpointer)((ctx)->regs [ARMREG_SP]))
255 #if defined(HOST_WATCHOS)
257 #define MONO_CONTEXT_GET_CURRENT(ctx) do { \
258 unw_context_t uctx; \
261 g_assert (unw_getcontext (&uctx) == 0); \
262 g_assert (unw_init_local (&c, &uctx) == 0); \
263 for (int reg = 0; reg < 13; ++reg) { \
264 unw_get_reg (&c, (unw_regnum_t) UNW_ARM_R0 + reg, &data); \
265 ctx.regs[reg] = data; \
267 unw_get_reg (&c, UNW_ARM_SP, &data); \
268 ctx.regs[ARMREG_SP] = data; \
269 unw_get_reg (&c, UNW_ARM_LR, &data); \
270 ctx.regs[ARMREG_LR] = data; \
271 unw_get_reg (&c, UNW_ARM_IP, &data); \
272 ctx.regs[ARMREG_PC] = data; \
273 ctx.pc = ctx.regs[ARMREG_PC]; \
274 for (int reg = 0; reg < 16; ++reg) { \
275 unw_get_reg (&c, (unw_regnum_t) UNW_ARM_D0 + reg, &data); \
276 ctx.fregs[reg] = data; \
282 #define MONO_CONTEXT_GET_CURRENT(ctx) do { \
283 __asm__ __volatile__( \
287 "ldr r1, [sp, #4]\n" \
289 "ldr r1, [sp, #0]\n" \
291 "stmia r0!, {r2-r12}\n" \
302 ctx.pc = ctx.regs [15]; \
307 #define MONO_ARCH_HAS_MONO_CONTEXT 1
309 #elif (defined(__aarch64__) && !defined(MONO_CROSS_COMPILE)) || (defined(TARGET_ARM64))
311 #include <mono/arch/arm64/arm64-codegen.h>
319 #define MONO_CONTEXT_SET_IP(ctx,ip) do { (ctx)->pc = (mgreg_t)ip; } while (0)
320 #define MONO_CONTEXT_SET_BP(ctx,bp) do { (ctx)->regs [ARMREG_FP] = (mgreg_t)bp; } while (0);
321 #define MONO_CONTEXT_SET_SP(ctx,bp) do { (ctx)->regs [ARMREG_SP] = (mgreg_t)bp; } while (0);
323 #define MONO_CONTEXT_GET_IP(ctx) (gpointer)((ctx)->pc)
324 #define MONO_CONTEXT_GET_BP(ctx) (gpointer)((ctx)->regs [ARMREG_FP])
325 #define MONO_CONTEXT_GET_SP(ctx) (gpointer)((ctx)->regs [ARMREG_SP])
327 #define MONO_CONTEXT_GET_CURRENT(ctx) do { \
328 __asm__ __volatile__( \
330 "stp x0, x1, [x16], #16\n" \
331 "stp x2, x3, [x16], #16\n" \
332 "stp x4, x5, [x16], #16\n" \
333 "stp x6, x7, [x16], #16\n" \
334 "stp x8, x9, [x16], #16\n" \
335 "stp x10, x11, [x16], #16\n" \
336 "stp x12, x13, [x16], #16\n" \
337 "stp x14, x15, [x16], #16\n" \
338 "stp xzr, x17, [x16], #16\n" \
339 "stp x18, x19, [x16], #16\n" \
340 "stp x20, x21, [x16], #16\n" \
341 "stp x22, x23, [x16], #16\n" \
342 "stp x24, x25, [x16], #16\n" \
343 "stp x26, x27, [x16], #16\n" \
344 "stp x28, x29, [x16], #16\n" \
345 "stp x30, xzr, [x16]\n" \
347 "str x30, [x16, #8]\n" \
352 __asm__ __volatile__( \
361 #define MONO_ARCH_HAS_MONO_CONTEXT 1
363 #elif defined(__mono_ppc__) /* defined(__arm__) */
365 /* we define our own structure and we'll copy the data
366 * from sigcontext/ucontext/mach when we need it.
367 * This also makes us save stack space and time when copying
368 * We might also want to add an additional field to propagate
369 * the original context from the signal handler.
374 mgreg_t regs [19]; /*FIXME, this must be changed to 32 for sgen*/
378 /* we have the stack pointer, not the base pointer in sigcontext */
379 #define MONO_CONTEXT_SET_IP(ctx,ip) do { (ctx)->sc_ir = (gulong)ip; } while (0);
380 /* FIXME: should be called SET_SP */
381 #define MONO_CONTEXT_SET_BP(ctx,bp) do { (ctx)->sc_sp = (gulong)bp; } while (0);
382 #define MONO_CONTEXT_SET_SP(ctx,sp) do { (ctx)->sc_sp = (gulong)sp; } while (0);
384 #define MONO_CONTEXT_GET_IP(ctx) ((gpointer)((ctx)->sc_ir))
385 #define MONO_CONTEXT_GET_BP(ctx) ((gpointer)((ctx)->regs [ppc_r31-13]))
386 #define MONO_CONTEXT_GET_SP(ctx) ((gpointer)((ctx)->sc_sp))
388 #elif defined(__sparc__) || defined(sparc) /* defined(__mono_ppc__) */
390 typedef struct MonoContext {
396 #define MONO_CONTEXT_SET_IP(ctx,eip) do { (ctx)->ip = (gpointer)(eip); } while (0);
397 #define MONO_CONTEXT_SET_BP(ctx,ebp) do { (ctx)->fp = (gpointer*)(ebp); } while (0);
398 #define MONO_CONTEXT_SET_SP(ctx,esp) do { (ctx)->sp = (gpointer*)(esp); } while (0);
400 #define MONO_CONTEXT_GET_IP(ctx) ((gpointer)((ctx)->ip))
401 #define MONO_CONTEXT_GET_BP(ctx) ((gpointer)((ctx)->fp))
402 #define MONO_CONTEXT_GET_SP(ctx) ((gpointer)((ctx)->sp))
404 #elif defined(__ia64__) /*defined(__sparc__) || defined(sparc) */
406 #ifndef UNW_LOCAL_ONLY
408 #define UNW_LOCAL_ONLY
409 #include <libunwind.h>
413 typedef struct MonoContext {
415 /* Whenever the ip in 'cursor' points to the ip where the exception happened */
416 /* This is true for the initial context for exceptions thrown from signal handlers */
420 /*XXX SET_BP is missing*/
421 #define MONO_CONTEXT_SET_IP(ctx,eip) do { int err = unw_set_reg (&(ctx)->cursor, UNW_IA64_IP, (unw_word_t)(eip)); g_assert (err == 0); } while (0)
422 #define MONO_CONTEXT_SET_SP(ctx,esp) do { int err = unw_set_reg (&(ctx)->cursor, UNW_IA64_SP, (unw_word_t)(esp)); g_assert (err == 0); } while (0)
424 #define MONO_CONTEXT_GET_IP(ctx) ((gpointer)(mono_ia64_context_get_ip ((ctx))))
425 #define MONO_CONTEXT_GET_BP(ctx) ((gpointer)(mono_ia64_context_get_fp ((ctx))))
426 #define MONO_CONTEXT_GET_SP(ctx) ((gpointer)(mono_ia64_context_get_sp ((ctx))))
428 static inline unw_word_t
429 mono_ia64_context_get_ip (MonoContext *ctx)
434 err = unw_get_reg (&ctx->cursor, UNW_IA64_IP, &ip);
437 if (ctx->precise_ip) {
440 /* Subtrack 1 so ip points into the actual instruction */
445 static inline unw_word_t
446 mono_ia64_context_get_sp (MonoContext *ctx)
451 err = unw_get_reg (&ctx->cursor, UNW_IA64_SP, &sp);
457 static inline unw_word_t
458 mono_ia64_context_get_fp (MonoContext *ctx)
460 unw_cursor_t new_cursor;
467 err = unw_get_reg (&ctx->cursor, UNW_IA64_SP, &sp);
470 err = unw_get_reg (&ctx->cursor, UNW_IA64_IP, &ip);
474 /* fp is the SP of the parent frame */
475 new_cursor = ctx->cursor;
477 err = unw_step (&new_cursor);
480 err = unw_get_reg (&new_cursor, UNW_IA64_SP, &fp);
486 #elif ((defined(__mips__) && !defined(MONO_CROSS_COMPILE)) || (defined(TARGET_MIPS))) && SIZEOF_REGISTER == 4 /* defined(__ia64__) */
488 #include <mono/arch/mips/mips-codegen.h>
492 mgreg_t sc_regs [32];
493 gfloat sc_fpregs [32];
496 #define MONO_CONTEXT_SET_IP(ctx,ip) do { (ctx)->sc_pc = (mgreg_t)(ip); } while (0);
497 #define MONO_CONTEXT_SET_BP(ctx,bp) do { (ctx)->sc_regs[mips_fp] = (mgreg_t)(bp); } while (0);
498 #define MONO_CONTEXT_SET_SP(ctx,sp) do { (ctx)->sc_regs[mips_sp] = (mgreg_t)(sp); } while (0);
500 #define MONO_CONTEXT_GET_IP(ctx) ((gpointer)((ctx)->sc_pc))
501 #define MONO_CONTEXT_GET_BP(ctx) ((gpointer)((ctx)->sc_regs[mips_fp]))
502 #define MONO_CONTEXT_GET_SP(ctx) ((gpointer)((ctx)->sc_regs[mips_sp]))
504 #define MONO_CONTEXT_GET_CURRENT(ctx) \
505 __asm__ __volatile__( \
516 "sw $10,40(%0)\n\t" \
517 "sw $11,44(%0)\n\t" \
518 "sw $12,48(%0)\n\t" \
519 "sw $13,52(%0)\n\t" \
520 "sw $14,56(%0)\n\t" \
521 "sw $15,60(%0)\n\t" \
522 "sw $16,64(%0)\n\t" \
523 "sw $17,68(%0)\n\t" \
524 "sw $18,72(%0)\n\t" \
525 "sw $19,76(%0)\n\t" \
526 "sw $20,80(%0)\n\t" \
527 "sw $21,84(%0)\n\t" \
528 "sw $22,88(%0)\n\t" \
529 "sw $23,92(%0)\n\t" \
530 "sw $24,96(%0)\n\t" \
531 "sw $25,100(%0)\n\t" \
532 "sw $26,104(%0)\n\t" \
533 "sw $27,108(%0)\n\t" \
534 "sw $28,112(%0)\n\t" \
535 "sw $29,116(%0)\n\t" \
536 "sw $30,120(%0)\n\t" \
537 "sw $31,124(%0)\n\t" \
538 : : "r" (&(ctx).sc_regs [0]) \
542 #elif defined(__s390x__)
544 #define MONO_ARCH_HAS_MONO_CONTEXT 1
546 typedef struct ucontext MonoContext;
548 #define MONO_CONTEXT_SET_IP(ctx,ip) \
550 (ctx)->uc_mcontext.gregs[14] = (unsigned long)ip; \
551 (ctx)->uc_mcontext.psw.addr = (unsigned long)ip; \
554 #define MONO_CONTEXT_SET_SP(ctx,bp) MONO_CONTEXT_SET_BP((ctx),(bp))
555 #define MONO_CONTEXT_SET_BP(ctx,bp) \
557 (ctx)->uc_mcontext.gregs[15] = (unsigned long)bp; \
558 (ctx)->uc_stack.ss_sp = (void*)bp; \
561 #define MONO_CONTEXT_GET_IP(ctx) (gpointer) (ctx)->uc_mcontext.psw.addr
562 #define MONO_CONTEXT_GET_SP(ctx) ((gpointer)((ctx)->uc_mcontext.gregs[15]))
563 #define MONO_CONTEXT_GET_BP(ctx) ((gpointer)((ctx)->uc_mcontext.gregs[11]))
565 #define MONO_CONTEXT_GET_CURRENT(ctx) \
566 __asm__ __volatile__( \
567 "stmg %%r0,%%r15,0(%0)\n" \
568 : : "r" (&(ctx).uc_mcontext.gregs[0]) \
574 #error "Implement mono-context for the current arch"
579 * The naming is misleading, the SIGCTX argument should be the platform's context
580 * structure (ucontext_c on posix, CONTEXT on windows).
582 void mono_sigctx_to_monoctx (void *sigctx, MonoContext *mctx);
585 * This will not completely initialize SIGCTX since MonoContext contains less
586 * information that the system context. The caller should obtain a SIGCTX from
587 * the system, and use this function to override the parts of it which are
588 * also in MonoContext.
590 void mono_monoctx_to_sigctx (MonoContext *mctx, void *sigctx);
592 #endif /* __MONO_MONO_CONTEXT_H__ */