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 #define MONO_ARCH_HAS_MONO_CONTEXT 1
 125
 126 #elif defined(__x86_64__) /* defined(__i386__) */
 127
 128
 129 #if !defined( HOST_WIN32 ) && !defined(__native_client__) && !defined(__native_client_codegen__)
 130
 131 #define MONO_SIGNAL_USE_SIGACTION 1
 132
 133 #endif
 134
 135 typedef struct {
 136         mgreg_t rax;
 137         mgreg_t rbx;
 138         mgreg_t rcx;
 139         mgreg_t rdx;
 140         mgreg_t rbp;
 141         mgreg_t rsp;
 142     mgreg_t rsi;
 143         mgreg_t rdi;
 144         mgreg_t r8;
 145         mgreg_t r9;
 146         mgreg_t r10;
 147         mgreg_t r11;
 148         mgreg_t r12;
 149         mgreg_t r13;
 150         mgreg_t r14;
 151         mgreg_t r15;
 152         mgreg_t rip;
 153 } MonoContext;
 154
 155 #define MONO_CONTEXT_SET_IP(ctx,ip) do { (ctx)->rip = (mgreg_t)(ip); } while (0);
 156 #define MONO_CONTEXT_SET_BP(ctx,bp) do { (ctx)->rbp = (mgreg_t)(bp); } while (0);
 157 #define MONO_CONTEXT_SET_SP(ctx,esp) do { (ctx)->rsp = (mgreg_t)(esp); } while (0);
 158
 159 #define MONO_CONTEXT_GET_IP(ctx) ((gpointer)((ctx)->rip))
 160 #define MONO_CONTEXT_GET_BP(ctx) ((gpointer)((ctx)->rbp))
 161 #define MONO_CONTEXT_GET_SP(ctx) ((gpointer)((ctx)->rsp))
 162
 163 #define MONO_CONTEXT_GET_CURRENT(ctx)   \
 164         __asm__ __volatile__(   \
 165                 "movq $0x0,  0x00(%0)\n"        \
 166                 "movq %%rbx, 0x08(%0)\n"        \
 167                 "movq %%rcx, 0x10(%0)\n"        \
 168                 "movq %%rdx, 0x18(%0)\n"        \
 169                 "movq %%rbp, 0x20(%0)\n"        \
 170                 "movq %%rsp, 0x28(%0)\n"        \
 171                 "movq %%rsi, 0x30(%0)\n"        \
 172                 "movq %%rdi, 0x38(%0)\n"        \
 173                 "movq %%r8,  0x40(%0)\n"        \
 174                 "movq %%r9,  0x48(%0)\n"        \
 175                 "movq %%r10, 0x50(%0)\n"        \
 176                 "movq %%r11, 0x58(%0)\n"        \
 177                 "movq %%r12, 0x60(%0)\n"        \
 178                 "movq %%r13, 0x68(%0)\n"        \
 179                 "movq %%r14, 0x70(%0)\n"        \
 180                 "movq %%r15, 0x78(%0)\n"        \
 181                 "leaq (%%rip), %%rdx\n" \
 182                 "movq %%rdx, 0x80(%0)\n"        \
 183                 :       \
 184                 : "a" (&(ctx))  \
 185                 : "rdx", "memory")
 186
 187 #define MONO_ARCH_HAS_MONO_CONTEXT 1
 188
 189 #elif defined(__arm__) /* defined(__x86_64__) */
 190
 191 typedef struct {
 192         gulong eip;          // pc
 193         gulong esp;          // sp
 194         gulong regs [16];
 195         double fregs [8];
 196 } MonoContext;
 197
 198 /* we have the stack pointer, not the base pointer in sigcontext */
 199 #define MONO_CONTEXT_SET_IP(ctx,ip) do { (ctx)->eip = (int)ip; } while (0);
 200 #define MONO_CONTEXT_SET_BP(ctx,bp) do { (ctx)->regs [ARMREG_FP] = (int)bp; } while (0);
 201 #define MONO_CONTEXT_SET_SP(ctx,bp) do { (ctx)->esp = (int)bp; } while (0);
 202
 203 #define MONO_CONTEXT_GET_IP(ctx) ((gpointer)((ctx)->eip))
 204 #define MONO_CONTEXT_GET_BP(ctx) ((gpointer)((ctx)->regs [ARMREG_FP]))
 205 #define MONO_CONTEXT_GET_SP(ctx) ((gpointer)((ctx)->esp))
 206
 207 // FIXME:
 208 #define MONO_CONTEXT_GET_CURRENT(ctx)   do {    \
 209         g_assert_not_reached (); \
 210 } while (0)
 211
 212 #elif defined(__mono_ppc__) /* defined(__arm__) */
 213
 214 /* we define our own structure and we'll copy the data
 215  * from sigcontext/ucontext/mach when we need it.
 216  * This also makes us save stack space and time when copying
 217  * We might also want to add an additional field to propagate
 218  * the original context from the signal handler.
 219  */
 220 typedef struct {
 221         gulong sc_ir;          // pc
 222         gulong sc_sp;          // r1
 223         mgreg_t regs [19]; /*FIXME, this must be changed to 32 for sgen*/
 224         double fregs [18];
 225 } MonoContext;
 226
 227 /* we have the stack pointer, not the base pointer in sigcontext */
 228 #define MONO_CONTEXT_SET_IP(ctx,ip) do { (ctx)->sc_ir = (gulong)ip; } while (0);
 229 /* FIXME: should be called SET_SP */
 230 #define MONO_CONTEXT_SET_BP(ctx,bp) do { (ctx)->sc_sp = (gulong)bp; } while (0);
 231 #define MONO_CONTEXT_SET_SP(ctx,sp) do { (ctx)->sc_sp = (gulong)sp; } while (0);
 232
 233 #define MONO_CONTEXT_GET_IP(ctx) ((gpointer)((ctx)->sc_ir))
 234 #define MONO_CONTEXT_GET_BP(ctx) ((gpointer)((ctx)->regs [ppc_r31-13]))
 235 #define MONO_CONTEXT_GET_SP(ctx) ((gpointer)((ctx)->sc_sp))
 236
 237 #elif defined(__sparc__) || defined(sparc) /* defined(__mono_ppc__) */
 238
 239 typedef struct MonoContext {
 240         guint8 *ip;
 241         gpointer *sp;
 242         gpointer *fp;
 243 } MonoContext;
 244
 245 #define MONO_CONTEXT_SET_IP(ctx,eip) do { (ctx)->ip = (gpointer)(eip); } while (0);
 246 #define MONO_CONTEXT_SET_BP(ctx,ebp) do { (ctx)->fp = (gpointer*)(ebp); } while (0);
 247 #define MONO_CONTEXT_SET_SP(ctx,esp) do { (ctx)->sp = (gpointer*)(esp); } while (0);
 248
 249 #define MONO_CONTEXT_GET_IP(ctx) ((gpointer)((ctx)->ip))
 250 #define MONO_CONTEXT_GET_BP(ctx) ((gpointer)((ctx)->fp))
 251 #define MONO_CONTEXT_GET_SP(ctx) ((gpointer)((ctx)->sp))
 252
 253 #elif defined(__ia64__) /*defined(__sparc__) || defined(sparc) */
 254
 255 #ifndef UNW_LOCAL_ONLY
 256
 257 #define UNW_LOCAL_ONLY
 258 #include <libunwind.h>
 259
 260 #endif
 261
 262 typedef struct MonoContext {
 263         unw_cursor_t cursor;
 264         /* Whenever the ip in 'cursor' points to the ip where the exception happened */
 265         /* This is true for the initial context for exceptions thrown from signal handlers */
 266         gboolean precise_ip;
 267 } MonoContext;
 268
 269 /*XXX SET_BP is missing*/
 270 #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)
 271 #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)
 272
 273 #define MONO_CONTEXT_GET_IP(ctx) ((gpointer)(mono_ia64_context_get_ip ((ctx))))
 274 #define MONO_CONTEXT_GET_BP(ctx) ((gpointer)(mono_ia64_context_get_fp ((ctx))))
 275 #define MONO_CONTEXT_GET_SP(ctx) ((gpointer)(mono_ia64_context_get_sp ((ctx))))
 276
 277 static inline unw_word_t
 278 mono_ia64_context_get_ip (MonoContext *ctx)
 279 {
 280         unw_word_t ip;
 281         int err;
 282
 283         err = unw_get_reg (&ctx->cursor, UNW_IA64_IP, &ip);
 284         g_assert (err == 0);
 285
 286         if (ctx->precise_ip) {
 287                 return ip;
 288         } else {
 289                 /* Subtrack 1 so ip points into the actual instruction */
 290                 return ip - 1;
 291         }
 292 }
 293
 294 static inline unw_word_t
 295 mono_ia64_context_get_sp (MonoContext *ctx)
 296 {
 297         unw_word_t sp;
 298         int err;
 299
 300         err = unw_get_reg (&ctx->cursor, UNW_IA64_SP, &sp);
 301         g_assert (err == 0);
 302
 303         return sp;
 304 }
 305
 306 static inline unw_word_t
 307 mono_ia64_context_get_fp (MonoContext *ctx)
 308 {
 309         unw_cursor_t new_cursor;
 310         unw_word_t fp;
 311         int err;
 312
 313         {
 314                 unw_word_t ip, sp;
 315
 316                 err = unw_get_reg (&ctx->cursor, UNW_IA64_SP, &sp);
 317                 g_assert (err == 0);
 318
 319                 err = unw_get_reg (&ctx->cursor, UNW_IA64_IP, &ip);
 320                 g_assert (err == 0);
 321         }
 322
 323         /* fp is the SP of the parent frame */
 324         new_cursor = ctx->cursor;
 325
 326         err = unw_step (&new_cursor);
 327         g_assert (err >= 0);
 328
 329         err = unw_get_reg (&new_cursor, UNW_IA64_SP, &fp);
 330         g_assert (err == 0);
 331
 332         return fp;
 333 }
 334
 335 #elif defined(__mips__) && SIZEOF_REGISTER == 4 /* defined(__ia64__) */
 336
 337 /* we define our own structure and we'll copy the data
 338  * from sigcontext/ucontext/mach when we need it.
 339  * This also makes us save stack space and time when copying
 340  * We might also want to add an additional field to propagate
 341  * the original context from the signal handler.
 342  */
 343 typedef struct {
 344         gpointer        sc_pc;
 345         guint32         sc_regs [32];
 346         gfloat          sc_fpregs [32];
 347 } MonoContext;
 348
 349 /* we have the stack pointer, not the base pointer in sigcontext */
 350 #define MONO_CONTEXT_SET_IP(ctx,ip) do { (ctx)->sc_pc = (int)(ip); } while (0);
 351 #define MONO_CONTEXT_SET_BP(ctx,bp) do { (ctx)->sc_regs[mips_fp] = (int)(bp); } while (0);
 352 #define MONO_CONTEXT_SET_SP(ctx,sp) do { (ctx)->sc_regs[mips_sp] = (int)(sp); } while (0);
 353
 354 #define MONO_CONTEXT_GET_IP(ctx) ((gpointer)((ctx)->sc_pc))
 355 #define MONO_CONTEXT_GET_BP(ctx) ((gpointer)((ctx)->sc_regs[mips_fp]))
 356 #define MONO_CONTEXT_GET_SP(ctx) ((gpointer)((ctx)->sc_regs[mips_sp]))
 357
 358 #elif defined(__s390x__)
 359
 360 #define MONO_ARCH_HAS_MONO_CONTEXT 1
 361
 362 typedef struct ucontext MonoContext;
 363
 364 #define MONO_CONTEXT_SET_IP(ctx,ip)                                     \
 365         do {                                                            \
 366                 (ctx)->uc_mcontext.gregs[14] = (unsigned long)ip;       \
 367                 (ctx)->uc_mcontext.psw.addr = (unsigned long)ip;        \
 368         } while (0);
 369
 370 #define MONO_CONTEXT_SET_SP(ctx,bp) MONO_CONTEXT_SET_BP((ctx),(bp))
 371 #define MONO_CONTEXT_SET_BP(ctx,bp)                                     \
 372         do {                                                            \
 373                 (ctx)->uc_mcontext.gregs[15] = (unsigned long)bp;       \
 374                 (ctx)->uc_stack.ss_sp        = (void*)bp;               \
 375         } while (0)
 376
 377 #define MONO_CONTEXT_GET_IP(ctx) (gpointer) (ctx)->uc_mcontext.psw.addr
 378 #define MONO_CONTEXT_GET_BP(ctx) MONO_CONTEXT_GET_SP((ctx))
 379 #define MONO_CONTEXT_GET_SP(ctx) ((gpointer)((ctx)->uc_mcontext.gregs[15]))
 380
 381 #define MONO_CONTEXT_GET_CURRENT(ctx)   \
 382         __asm__ __volatile__(   \
 383                 "stmg   %%r0,%%r15,0(%0)\n"     \
 384                 : : "r" (&(ctx).uc_mcontext.gregs[0])   \
 385                 : "memory"                      \
 386         )
 387
 388 #else
 389
 390 #error "Implement mono-context for the current arch"
 391
 392 #endif
 393
 394 void mono_sigctx_to_monoctx (void *sigctx, MonoContext *mctx) MONO_INTERNAL;
 395 void mono_monoctx_to_sigctx (MonoContext *mctx, void *sigctx) MONO_INTERNAL;
 396
 397 #endif /* __MONO_MONO_CONTEXT_H__ */