mono/utils/mono-context.h

   1 /*
   2  * mono-context.h: plat independent machine state definitions
   3  *
   4  *
   5  * Copyright (c) 2011 Novell, Inc (http://www.novell.com)
   6  */
   7
   8
   9 #ifndef __MONO_MONO_CONTEXT_H__
  10 #define __MONO_MONO_CONTEXT_H__
  11
  12 #include "mono-compiler.h"
  13 #include "mono-sigcontext.h"
  14 #include "mono-machine.h"
  15
  16 #ifdef HAVE_SIGNAL_H
  17 #include <signal.h>
  18 #endif
  19
  20 /*
  21  * General notes about mono-context.
  22  * Each arch defines a MonoContext struct with all GPR regs + IP/PC.
  23  * IP/PC should be the last element of the struct (this is a mild sgen constraint we could drop if needed)
  24  * Macros to get/set BP, SP and IP are defined too.
  25  * MONO_CONTEXT_GET_CURRENT captures the current context as close as possible. One reg might be clobbered
  26  *  to hold the address of the target MonoContext. It will be a caller save one, so should not be a problem.
  27  */
  28 #if defined(__i386__)
  29
  30 /*HACK, move this to an eventual mono-signal.c*/
  31 #if defined( __linux__) || defined(__sun) || defined(__APPLE__) || defined(__NetBSD__) || \
  32        defined(__FreeBSD__) || defined(__OpenBSD__)
  33 #define MONO_SIGNAL_USE_SIGACTION
  34 #endif
  35
  36 #if defined(__native_client__)
  37 #undef MONO_SIGNAL_USE_SIGACTION
  38 #endif
  39
  40 #ifdef HOST_WIN32
  41 /* sigcontext surrogate */
  42 struct sigcontext {
  43         unsigned int eax;
  44         unsigned int ebx;
  45         unsigned int ecx;
  46         unsigned int edx;
  47         unsigned int ebp;
  48         unsigned int esp;
  49         unsigned int esi;
  50         unsigned int edi;
  51         unsigned int eip;
  52 };
  53 #endif
  54
  55 #if defined(__FreeBSD__) || defined(__NetBSD__) || defined(__OpenBSD__) || defined(__APPLE__)
  56 # define SC_EAX sc_eax
  57 # define SC_EBX sc_ebx
  58 # define SC_ECX sc_ecx
  59 # define SC_EDX sc_edx
  60 # define SC_EBP sc_ebp
  61 # define SC_EIP sc_eip
  62 # define SC_ESP sc_esp
  63 # define SC_EDI sc_edi
  64 # define SC_ESI sc_esi
  65 #elif defined(__HAIKU__)
  66 # define SC_EAX regs.eax
  67 # define SC_EBX regs._reserved_2[2]
  68 # define SC_ECX regs.ecx
  69 # define SC_EDX regs.edx
  70 # define SC_EBP regs.ebp
  71 # define SC_EIP regs.eip
  72 # define SC_ESP regs.esp
  73 # define SC_EDI regs._reserved_2[0]
  74 # define SC_ESI regs._reserved_2[1]
  75 #else
  76 # define SC_EAX eax
  77 # define SC_EBX ebx
  78 # define SC_ECX ecx
  79 # define SC_EDX edx
  80 # define SC_EBP ebp
  81 # define SC_EIP eip
  82 # define SC_ESP esp
  83 # define SC_EDI edi
  84 # define SC_ESI esi
  85 #endif
  86
  87 typedef struct {
  88         mgreg_t eax;
  89         mgreg_t ebx;
  90         mgreg_t ecx;
  91         mgreg_t edx;
  92         mgreg_t ebp;
  93         mgreg_t esp;
  94         mgreg_t esi;
  95         mgreg_t edi;
  96         mgreg_t eip;
  97 } MonoContext;
  98
  99 #define MONO_CONTEXT_SET_IP(ctx,ip) do { (ctx)->eip = (mgreg_t)(ip); } while (0);
 100 #define MONO_CONTEXT_SET_BP(ctx,bp) do { (ctx)->ebp = (mgreg_t)(bp); } while (0);
 101 #define MONO_CONTEXT_SET_SP(ctx,sp) do { (ctx)->esp = (mgreg_t)(sp); } while (0);
 102
 103 #define MONO_CONTEXT_GET_IP(ctx) ((gpointer)((ctx)->eip))
 104 #define MONO_CONTEXT_GET_BP(ctx) ((gpointer)((ctx)->ebp))
 105 #define MONO_CONTEXT_GET_SP(ctx) ((gpointer)((ctx)->esp))
 106
 107 /*We set EAX to zero since we are clobering it anyway*/
 108 #define MONO_CONTEXT_GET_CURRENT(ctx) \
 109         __asm__ __volatile__(   \
 110         "movl $0x0, 0x00(%0)\n" \
 111         "mov %%ebx, 0x04(%0)\n" \
 112         "mov %%ecx, 0x08(%0)\n" \
 113         "mov %%edx, 0x0c(%0)\n" \
 114         "mov %%ebp, 0x10(%0)\n" \
 115         "mov %%esp, 0x14(%0)\n" \
 116         "mov %%esi, 0x18(%0)\n" \
 117         "mov %%edi, 0x1c(%0)\n" \
 118         "call 1f\n"     \
 119         "1: pop 0x20(%0)\n"     \
 120         :       \
 121         : "a" (&(ctx))  \
 122         : "memory")
 123
 124 #if !defined(HOST_WIN32)
 125 #define MONO_ARCH_HAS_MONO_CONTEXT 1
 126 #endif
 127
 128 #elif defined(__x86_64__) /* defined(__i386__) */
 129
 130
 131 #if !defined( HOST_WIN32 ) && !defined(__native_client__) && !defined(__native_client_codegen__)
 132
 133 #define MONO_SIGNAL_USE_SIGACTION 1
 134
 135 #endif
 136
 137 typedef struct {
 138         mgreg_t rax;
 139         mgreg_t rbx;
 140         mgreg_t rcx;
 141         mgreg_t rdx;
 142         mgreg_t rbp;
 143         mgreg_t rsp;
 144     mgreg_t rsi;
 145         mgreg_t rdi;
 146         mgreg_t r8;
 147         mgreg_t r9;
 148         mgreg_t r10;
 149         mgreg_t r11;
 150         mgreg_t r12;
 151         mgreg_t r13;
 152         mgreg_t r14;
 153         mgreg_t r15;
 154         mgreg_t rip;
 155 } MonoContext;
 156
 157 #define MONO_CONTEXT_SET_IP(ctx,ip) do { (ctx)->rip = (mgreg_t)(ip); } while (0);
 158 #define MONO_CONTEXT_SET_BP(ctx,bp) do { (ctx)->rbp = (mgreg_t)(bp); } while (0);
 159 #define MONO_CONTEXT_SET_SP(ctx,esp) do { (ctx)->rsp = (mgreg_t)(esp); } while (0);
 160
 161 #define MONO_CONTEXT_GET_IP(ctx) ((gpointer)((ctx)->rip))
 162 #define MONO_CONTEXT_GET_BP(ctx) ((gpointer)((ctx)->rbp))
 163 #define MONO_CONTEXT_GET_SP(ctx) ((gpointer)((ctx)->rsp))
 164
 165 #define MONO_CONTEXT_GET_CURRENT(ctx)   \
 166         __asm__ __volatile__(   \
 167                 "movq $0x0,  0x00(%0)\n"        \
 168                 "movq %%rbx, 0x08(%0)\n"        \
 169                 "movq %%rcx, 0x10(%0)\n"        \
 170                 "movq %%rdx, 0x18(%0)\n"        \
 171                 "movq %%rbp, 0x20(%0)\n"        \
 172                 "movq %%rsp, 0x28(%0)\n"        \
 173                 "movq %%rsi, 0x30(%0)\n"        \
 174                 "movq %%rdi, 0x38(%0)\n"        \
 175                 "movq %%r8,  0x40(%0)\n"        \
 176                 "movq %%r9,  0x48(%0)\n"        \
 177                 "movq %%r10, 0x50(%0)\n"        \
 178                 "movq %%r11, 0x58(%0)\n"        \
 179                 "movq %%r12, 0x60(%0)\n"        \
 180                 "movq %%r13, 0x68(%0)\n"        \
 181                 "movq %%r14, 0x70(%0)\n"        \
 182                 "movq %%r15, 0x78(%0)\n"        \
 183                 "leaq (%%rip), %%rdx\n" \
 184                 "movq %%rdx, 0x80(%0)\n"        \
 185                 :       \
 186                 : "a" (&(ctx))  \
 187                 : "rdx", "memory")
 188
 189 #if !defined(HOST_WIN32)
 190 #define MONO_ARCH_HAS_MONO_CONTEXT 1
 191 #endif
 192
 193 #elif defined(__arm__) /* defined(__x86_64__) */
 194
 195 typedef struct {
 196         gulong eip;          // pc
 197         gulong esp;          // sp
 198         gulong regs [16];
 199         double fregs [8];
 200 } MonoContext;
 201
 202 /* we have the stack pointer, not the base pointer in sigcontext */
 203 #define MONO_CONTEXT_SET_IP(ctx,ip) do { (ctx)->eip = (int)ip; } while (0);
 204 #define MONO_CONTEXT_SET_BP(ctx,bp) do { (ctx)->regs [ARMREG_FP] = (int)bp; } while (0);
 205 #define MONO_CONTEXT_SET_SP(ctx,bp) do { (ctx)->esp = (int)bp; } while (0);
 206
 207 #define MONO_CONTEXT_GET_IP(ctx) ((gpointer)((ctx)->eip))
 208 #define MONO_CONTEXT_GET_BP(ctx) ((gpointer)((ctx)->regs [ARMREG_FP]))
 209 #define MONO_CONTEXT_GET_SP(ctx) ((gpointer)((ctx)->esp))
 210
 211 // FIXME:
 212 #define MONO_CONTEXT_GET_CURRENT(ctx)   do {    \
 213         g_assert_not_reached (); \
 214 } while (0)
 215
 216 #elif defined(__mono_ppc__) /* defined(__arm__) */
 217
 218 /* we define our own structure and we'll copy the data
 219  * from sigcontext/ucontext/mach when we need it.
 220  * This also makes us save stack space and time when copying
 221  * We might also want to add an additional field to propagate
 222  * the original context from the signal handler.
 223  */
 224 typedef struct {
 225         gulong sc_ir;          // pc
 226         gulong sc_sp;          // r1
 227         mgreg_t regs [19]; /*FIXME, this must be changed to 32 for sgen*/
 228         double fregs [18];
 229 } MonoContext;
 230
 231 /* we have the stack pointer, not the base pointer in sigcontext */
 232 #define MONO_CONTEXT_SET_IP(ctx,ip) do { (ctx)->sc_ir = (gulong)ip; } while (0);
 233 /* FIXME: should be called SET_SP */
 234 #define MONO_CONTEXT_SET_BP(ctx,bp) do { (ctx)->sc_sp = (gulong)bp; } while (0);
 235 #define MONO_CONTEXT_SET_SP(ctx,sp) do { (ctx)->sc_sp = (gulong)sp; } while (0);
 236
 237 #define MONO_CONTEXT_GET_IP(ctx) ((gpointer)((ctx)->sc_ir))
 238 #define MONO_CONTEXT_GET_BP(ctx) ((gpointer)((ctx)->regs [ppc_r31-13]))
 239 #define MONO_CONTEXT_GET_SP(ctx) ((gpointer)((ctx)->sc_sp))
 240
 241 #elif defined(__sparc__) || defined(sparc) /* defined(__mono_ppc__) */
 242
 243 typedef struct MonoContext {
 244         guint8 *ip;
 245         gpointer *sp;
 246         gpointer *fp;
 247 } MonoContext;
 248
 249 #define MONO_CONTEXT_SET_IP(ctx,eip) do { (ctx)->ip = (gpointer)(eip); } while (0);
 250 #define MONO_CONTEXT_SET_BP(ctx,ebp) do { (ctx)->fp = (gpointer*)(ebp); } while (0);
 251 #define MONO_CONTEXT_SET_SP(ctx,esp) do { (ctx)->sp = (gpointer*)(esp); } while (0);
 252
 253 #define MONO_CONTEXT_GET_IP(ctx) ((gpointer)((ctx)->ip))
 254 #define MONO_CONTEXT_GET_BP(ctx) ((gpointer)((ctx)->fp))
 255 #define MONO_CONTEXT_GET_SP(ctx) ((gpointer)((ctx)->sp))
 256
 257 #elif defined(__ia64__) /*defined(__sparc__) || defined(sparc) */
 258
 259 #ifndef UNW_LOCAL_ONLY
 260
 261 #define UNW_LOCAL_ONLY
 262 #include <libunwind.h>
 263
 264 #endif
 265
 266 typedef struct MonoContext {
 267         unw_cursor_t cursor;
 268         /* Whenever the ip in 'cursor' points to the ip where the exception happened */
 269         /* This is true for the initial context for exceptions thrown from signal handlers */
 270         gboolean precise_ip;
 271 } MonoContext;
 272
 273 /*XXX SET_BP is missing*/
 274 #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)
 275 #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)
 276
 277 #define MONO_CONTEXT_GET_IP(ctx) ((gpointer)(mono_ia64_context_get_ip ((ctx))))
 278 #define MONO_CONTEXT_GET_BP(ctx) ((gpointer)(mono_ia64_context_get_fp ((ctx))))
 279 #define MONO_CONTEXT_GET_SP(ctx) ((gpointer)(mono_ia64_context_get_sp ((ctx))))
 280
 281 static inline unw_word_t
 282 mono_ia64_context_get_ip (MonoContext *ctx)
 283 {
 284         unw_word_t ip;
 285         int err;
 286
 287         err = unw_get_reg (&ctx->cursor, UNW_IA64_IP, &ip);
 288         g_assert (err == 0);
 289
 290         if (ctx->precise_ip) {
 291                 return ip;
 292         } else {
 293                 /* Subtrack 1 so ip points into the actual instruction */
 294                 return ip - 1;
 295         }
 296 }
 297
 298 static inline unw_word_t
 299 mono_ia64_context_get_sp (MonoContext *ctx)
 300 {
 301         unw_word_t sp;
 302         int err;
 303
 304         err = unw_get_reg (&ctx->cursor, UNW_IA64_SP, &sp);
 305         g_assert (err == 0);
 306
 307         return sp;
 308 }
 309
 310 static inline unw_word_t
 311 mono_ia64_context_get_fp (MonoContext *ctx)
 312 {
 313         unw_cursor_t new_cursor;
 314         unw_word_t fp;
 315         int err;
 316
 317         {
 318                 unw_word_t ip, sp;
 319
 320                 err = unw_get_reg (&ctx->cursor, UNW_IA64_SP, &sp);
 321                 g_assert (err == 0);
 322
 323                 err = unw_get_reg (&ctx->cursor, UNW_IA64_IP, &ip);
 324                 g_assert (err == 0);
 325         }
 326
 327         /* fp is the SP of the parent frame */
 328         new_cursor = ctx->cursor;
 329
 330         err = unw_step (&new_cursor);
 331         g_assert (err >= 0);
 332
 333         err = unw_get_reg (&new_cursor, UNW_IA64_SP, &fp);
 334         g_assert (err == 0);
 335
 336         return fp;
 337 }
 338
 339 #elif defined(__mips__) && SIZEOF_REGISTER == 4 /* defined(__ia64__) */
 340
 341 /* we define our own structure and we'll copy the data
 342  * from sigcontext/ucontext/mach when we need it.
 343  * This also makes us save stack space and time when copying
 344  * We might also want to add an additional field to propagate
 345  * the original context from the signal handler.
 346  */
 347 typedef struct {
 348         gpointer        sc_pc;
 349         guint32         sc_regs [32];
 350         gfloat          sc_fpregs [32];
 351 } MonoContext;
 352
 353 /* we have the stack pointer, not the base pointer in sigcontext */
 354 #define MONO_CONTEXT_SET_IP(ctx,ip) do { (ctx)->sc_pc = (int)(ip); } while (0);
 355 #define MONO_CONTEXT_SET_BP(ctx,bp) do { (ctx)->sc_regs[mips_fp] = (int)(bp); } while (0);
 356 #define MONO_CONTEXT_SET_SP(ctx,sp) do { (ctx)->sc_regs[mips_sp] = (int)(sp); } while (0);
 357
 358 #define MONO_CONTEXT_GET_IP(ctx) ((gpointer)((ctx)->sc_pc))
 359 #define MONO_CONTEXT_GET_BP(ctx) ((gpointer)((ctx)->sc_regs[mips_fp]))
 360 #define MONO_CONTEXT_GET_SP(ctx) ((gpointer)((ctx)->sc_regs[mips_sp]))
 361
 362 #elif defined(__s390x__)
 363
 364 #define MONO_ARCH_HAS_MONO_CONTEXT 1
 365
 366 typedef struct ucontext MonoContext;
 367
 368 #define MONO_CONTEXT_SET_IP(ctx,ip)                                     \
 369         do {                                                            \
 370                 (ctx)->uc_mcontext.gregs[14] = (unsigned long)ip;       \
 371                 (ctx)->uc_mcontext.psw.addr = (unsigned long)ip;        \
 372         } while (0);
 373
 374 #define MONO_CONTEXT_SET_SP(ctx,bp) MONO_CONTEXT_SET_BP((ctx),(bp))
 375 #define MONO_CONTEXT_SET_BP(ctx,bp)                                     \
 376         do {                                                            \
 377                 (ctx)->uc_mcontext.gregs[15] = (unsigned long)bp;       \
 378                 (ctx)->uc_stack.ss_sp        = (void*)bp;               \
 379         } while (0)
 380
 381 #define MONO_CONTEXT_GET_IP(ctx) (gpointer) (ctx)->uc_mcontext.psw.addr
 382 #define MONO_CONTEXT_GET_BP(ctx) MONO_CONTEXT_GET_SP((ctx))
 383 #define MONO_CONTEXT_GET_SP(ctx) ((gpointer)((ctx)->uc_mcontext.gregs[15]))
 384
 385 #define MONO_CONTEXT_GET_CURRENT(ctx)   \
 386         __asm__ __volatile__(   \
 387                 "stmg   %%r0,%%r15,0(%0)\n"     \
 388                 : : "r" (&(ctx).uc_mcontext.gregs[0])   \
 389                 : "memory"                      \
 390         )
 391
 392 #else
 393
 394 #error "Implement mono-context for the current arch"
 395
 396 #endif
 397
 398 void mono_sigctx_to_monoctx (void *sigctx, MonoContext *mctx) MONO_INTERNAL;
 399 void mono_monoctx_to_sigctx (MonoContext *mctx, void *sigctx) MONO_INTERNAL;
 400
 401 #endif /* __MONO_MONO_CONTEXT_H__ */