mono/mini/exceptions-amd64.c

   1 /*
   2  * exceptions-amd64.c: exception support for AMD64
   3  *
   4  * Authors:
   5  *   Dietmar Maurer (dietmar@ximian.com)
   6  *
   7  * (C) 2001 Ximian, Inc.
   8  * Copyright 2011 Xamarin, Inc (http://www.xamarin.com)
   9  */
  10
  11 #include <config.h>
  12
  13 #if _WIN32_WINNT < 0x0501
  14 /* Required for Vectored Exception Handling. */
  15 #undef _WIN32_WINNT
  16 #define _WIN32_WINNT 0x0501
  17 #endif /* _WIN32_WINNT < 0x0501 */
  18
  19 #include <glib.h>
  20 #include <signal.h>
  21 #include <string.h>
  22 #ifdef HAVE_UCONTEXT_H
  23 #include <ucontext.h>
  24 #endif
  25
  26 #include <mono/arch/amd64/amd64-codegen.h>
  27 #include <mono/metadata/appdomain.h>
  28 #include <mono/metadata/tabledefs.h>
  29 #include <mono/metadata/threads.h>
  30 #include <mono/metadata/threads-types.h>
  31 #include <mono/metadata/debug-helpers.h>
  32 #include <mono/metadata/exception.h>
  33 #include <mono/metadata/gc-internal.h>
  34 #include <mono/metadata/mono-debug.h>
  35 #include <mono/utils/mono-mmap.h>
  36
  37 #include "mini.h"
  38 #include "mini-amd64.h"
  39 #include "tasklets.h"
  40 #include "debug-mini.h"
  41
  42 #define ALIGN_TO(val,align) (((val) + ((align) - 1)) & ~((align) - 1))
  43
  44 #ifdef TARGET_WIN32
  45 static MonoW32ExceptionHandler fpe_handler;
  46 static MonoW32ExceptionHandler ill_handler;
  47 static MonoW32ExceptionHandler segv_handler;
  48
  49 LPTOP_LEVEL_EXCEPTION_FILTER mono_old_win_toplevel_exception_filter;
  50 guint64 mono_win_vectored_exception_handle;
  51 extern gboolean mono_win_chained_exception_needs_run;
  52
  53 #define W32_SEH_HANDLE_EX(_ex) \
  54         if (_ex##_handler) _ex##_handler(0, ep, sctx)
  55
  56 LONG CALLBACK seh_unhandled_exception_filter(EXCEPTION_POINTERS* ep)
  57 {
  58 #ifndef MONO_CROSS_COMPILE
  59         if (mono_old_win_toplevel_exception_filter) {
  60                 return (*mono_old_win_toplevel_exception_filter)(ep);
  61         }
  62 #endif
  63
  64         mono_handle_native_sigsegv (SIGSEGV, NULL);
  65
  66         return EXCEPTION_CONTINUE_SEARCH;
  67 }
  68
  69 /*
  70  * Unhandled Exception Filter
  71  * Top-level per-process exception handler.
  72  */
  73 LONG CALLBACK seh_vectored_exception_handler(EXCEPTION_POINTERS* ep)
  74 {
  75         EXCEPTION_RECORD* er;
  76         CONTEXT* ctx;
  77         MonoContext* sctx;
  78         LONG res;
  79
  80         mono_win_chained_exception_needs_run = FALSE;
  81         res = EXCEPTION_CONTINUE_EXECUTION;
  82
  83         er = ep->ExceptionRecord;
  84         ctx = ep->ContextRecord;
  85         sctx = g_malloc(sizeof(MonoContext));
  86
  87         /* Copy Win32 context to UNIX style context */
  88         sctx->rax = ctx->Rax;
  89         sctx->rbx = ctx->Rbx;
  90         sctx->rcx = ctx->Rcx;
  91         sctx->rdx = ctx->Rdx;
  92         sctx->rbp = ctx->Rbp;
  93         sctx->rsp = ctx->Rsp;
  94         sctx->rsi = ctx->Rsi;
  95         sctx->rdi = ctx->Rdi;
  96         sctx->rip = ctx->Rip;
  97         sctx->r12 = ctx->R12;
  98         sctx->r13 = ctx->R13;
  99         sctx->r14 = ctx->R14;
 100         sctx->r15 = ctx->R15;
 101
 102         switch (er->ExceptionCode) {
 103         case EXCEPTION_ACCESS_VIOLATION:
 104                 W32_SEH_HANDLE_EX(segv);
 105                 break;
 106         case EXCEPTION_ILLEGAL_INSTRUCTION:
 107                 W32_SEH_HANDLE_EX(ill);
 108                 break;
 109         case EXCEPTION_INT_DIVIDE_BY_ZERO:
 110         case EXCEPTION_INT_OVERFLOW:
 111         case EXCEPTION_FLT_DIVIDE_BY_ZERO:
 112         case EXCEPTION_FLT_OVERFLOW:
 113         case EXCEPTION_FLT_UNDERFLOW:
 114         case EXCEPTION_FLT_INEXACT_RESULT:
 115                 W32_SEH_HANDLE_EX(fpe);
 116                 break;
 117         default:
 118                 break;
 119         }
 120
 121         if (mono_win_chained_exception_needs_run) {
 122                 /* Don't copy context back if we chained exception
 123                 * as the handler may have modfied the EXCEPTION_POINTERS
 124                 * directly. We don't pass sigcontext to chained handlers.
 125                 * Return continue search so the UnhandledExceptionFilter
 126                 * can correctly chain the exception.
 127                 */
 128                 res = EXCEPTION_CONTINUE_SEARCH;
 129         } else {
 130                 /* Copy context back */
 131                 /* Nonvolatile */
 132                 ctx->Rsp = sctx->rsp;
 133                 ctx->Rdi = sctx->rdi;
 134                 ctx->Rsi = sctx->rsi;
 135                 ctx->Rbx = sctx->rbx;
 136                 ctx->Rbp = sctx->rbp;
 137                 ctx->R12 = sctx->r12;
 138                 ctx->R13 = sctx->r13;
 139                 ctx->R14 = sctx->r14;
 140                 ctx->R15 = sctx->r15;
 141                 ctx->Rip = sctx->rip;
 142
 143                 /* Volatile But should not matter?*/
 144                 ctx->Rax = sctx->rax;
 145                 ctx->Rcx = sctx->rcx;
 146                 ctx->Rdx = sctx->rdx;
 147         }
 148
 149         /* TODO: Find right place to free this in stack overflow case */
 150         if (er->ExceptionCode != EXCEPTION_STACK_OVERFLOW)
 151                 g_free (sctx);
 152
 153         return res;
 154 }
 155
 156 void win32_seh_init()
 157 {
 158         mono_old_win_toplevel_exception_filter = SetUnhandledExceptionFilter(seh_unhandled_exception_filter);
 159         mono_win_vectored_exception_handle = AddVectoredExceptionHandler (1, seh_vectored_exception_handler);
 160 }
 161
 162 void win32_seh_cleanup()
 163 {
 164         if (mono_old_win_toplevel_exception_filter) SetUnhandledExceptionFilter(mono_old_win_toplevel_exception_filter);
 165
 166         guint32 ret = 0;
 167
 168         ret = RemoveVectoredExceptionHandler (mono_win_vectored_exception_handle);
 169         g_assert (ret);
 170 }
 171
 172 void win32_seh_set_handler(int type, MonoW32ExceptionHandler handler)
 173 {
 174         switch (type) {
 175         case SIGFPE:
 176                 fpe_handler = handler;
 177                 break;
 178         case SIGILL:
 179                 ill_handler = handler;
 180                 break;
 181         case SIGSEGV:
 182                 segv_handler = handler;
 183                 break;
 184         default:
 185                 break;
 186         }
 187 }
 188
 189 #endif /* TARGET_WIN32 */
 190
 191 /*
 192  * mono_arch_get_restore_context:
 193  *
 194  * Returns a pointer to a method which restores a previously saved sigcontext.
 195  */
 196 gpointer
 197 mono_arch_get_restore_context (MonoTrampInfo **info, gboolean aot)
 198 {
 199         guint8 *start = NULL;
 200         guint8 *code;
 201         MonoJumpInfo *ji = NULL;
 202         GSList *unwind_ops = NULL;
 203
 204         /* restore_contect (MonoContext *ctx) */
 205
 206         start = code = mono_global_codeman_reserve (256);
 207
 208         amd64_mov_reg_reg (code, AMD64_R11, AMD64_ARG_REG1, 8);
 209
 210         /* Restore all registers except %rip and %r11 */
 211         amd64_mov_reg_membase (code, AMD64_RAX, AMD64_R11,  G_STRUCT_OFFSET (MonoContext, rax), 8);
 212         amd64_mov_reg_membase (code, AMD64_RCX, AMD64_R11,  G_STRUCT_OFFSET (MonoContext, rcx), 8);
 213         amd64_mov_reg_membase (code, AMD64_RDX, AMD64_R11,  G_STRUCT_OFFSET (MonoContext, rdx), 8);
 214         amd64_mov_reg_membase (code, AMD64_RBX, AMD64_R11,  G_STRUCT_OFFSET (MonoContext, rbx), 8);
 215         amd64_mov_reg_membase (code, AMD64_RBP, AMD64_R11,  G_STRUCT_OFFSET (MonoContext, rbp), 8);
 216         amd64_mov_reg_membase (code, AMD64_RSI, AMD64_R11,  G_STRUCT_OFFSET (MonoContext, rsi), 8);
 217         amd64_mov_reg_membase (code, AMD64_RDI, AMD64_R11,  G_STRUCT_OFFSET (MonoContext, rdi), 8);
 218         //amd64_mov_reg_membase (code, AMD64_R8, AMD64_R11,  G_STRUCT_OFFSET (MonoContext, r8), 8);
 219         //amd64_mov_reg_membase (code, AMD64_R9, AMD64_R11,  G_STRUCT_OFFSET (MonoContext, r9), 8);
 220         //amd64_mov_reg_membase (code, AMD64_R10, AMD64_R11,  G_STRUCT_OFFSET (MonoContext, r10), 8);
 221         amd64_mov_reg_membase (code, AMD64_R12, AMD64_R11,  G_STRUCT_OFFSET (MonoContext, r12), 8);
 222         amd64_mov_reg_membase (code, AMD64_R13, AMD64_R11,  G_STRUCT_OFFSET (MonoContext, r13), 8);
 223         amd64_mov_reg_membase (code, AMD64_R14, AMD64_R11,  G_STRUCT_OFFSET (MonoContext, r14), 8);
 224 #if !defined(__native_client_codegen__)
 225         amd64_mov_reg_membase (code, AMD64_R15, AMD64_R11,  G_STRUCT_OFFSET (MonoContext, r15), 8);
 226 #endif
 227
 228         /*
 229          * The context resides on the stack, in the stack frame of the
 230          * caller of this function.  The stack pointer that we need to
 231          * restore is potentially many stack frames higher up, so the
 232          * distance between them can easily be more than the red zone
 233          * size.  Hence the stack pointer can be restored only after
 234          * we have finished loading everything from the context.
 235          */
 236         amd64_mov_reg_membase (code, AMD64_R8, AMD64_R11,  G_STRUCT_OFFSET (MonoContext, rsp), 8);
 237         amd64_mov_reg_membase (code, AMD64_R11, AMD64_R11,  G_STRUCT_OFFSET (MonoContext, rip), 8);
 238         amd64_mov_reg_reg (code, AMD64_RSP, AMD64_R8, 8);
 239
 240         /* jump to the saved IP */
 241         amd64_jump_reg (code, AMD64_R11);
 242
 243         nacl_global_codeman_validate(&start, 256, &code);
 244
 245         mono_arch_flush_icache (start, code - start);
 246
 247         if (info)
 248                 *info = mono_tramp_info_create ("restore_context", start, code - start, ji, unwind_ops);
 249
 250         return start;
 251 }
 252
 253 /*
 254  * mono_arch_get_call_filter:
 255  *
 256  * Returns a pointer to a method which calls an exception filter. We
 257  * also use this function to call finally handlers (we pass NULL as
 258  * @exc object in this case).
 259  */
 260 gpointer
 261 mono_arch_get_call_filter (MonoTrampInfo **info, gboolean aot)
 262 {
 263         guint8 *start;
 264         int i;
 265         guint8 *code;
 266         guint32 pos;
 267         MonoJumpInfo *ji = NULL;
 268         GSList *unwind_ops = NULL;
 269         const guint kMaxCodeSize = NACL_SIZE (128, 256);
 270
 271         start = code = mono_global_codeman_reserve (kMaxCodeSize);
 272
 273         /* call_filter (MonoContext *ctx, unsigned long eip) */
 274         code = start;
 275
 276         /* Alloc new frame */
 277         amd64_push_reg (code, AMD64_RBP);
 278         amd64_mov_reg_reg (code, AMD64_RBP, AMD64_RSP, 8);
 279
 280         /* Save callee saved regs */
 281         pos = 0;
 282         for (i = 0; i < AMD64_NREG; ++i)
 283                 if (AMD64_IS_CALLEE_SAVED_REG (i)) {
 284                         amd64_push_reg (code, i);
 285                         pos += 8;
 286                 }
 287
 288         /* Save EBP */
 289         pos += 8;
 290         amd64_push_reg (code, AMD64_RBP);
 291
 292         /* Make stack misaligned, the call will make it aligned again */
 293         if (! (pos & 8))
 294                 amd64_alu_reg_imm (code, X86_SUB, AMD64_RSP, 8);
 295
 296         /* set new EBP */
 297         amd64_mov_reg_membase (code, AMD64_RBP, AMD64_ARG_REG1, G_STRUCT_OFFSET (MonoContext, rbp), 8);
 298         /* load callee saved regs */
 299         amd64_mov_reg_membase (code, AMD64_RBX, AMD64_ARG_REG1, G_STRUCT_OFFSET (MonoContext, rbx), 8);
 300         amd64_mov_reg_membase (code, AMD64_R12, AMD64_ARG_REG1, G_STRUCT_OFFSET (MonoContext, r12), 8);
 301         amd64_mov_reg_membase (code, AMD64_R13, AMD64_ARG_REG1, G_STRUCT_OFFSET (MonoContext, r13), 8);
 302         amd64_mov_reg_membase (code, AMD64_R14, AMD64_ARG_REG1, G_STRUCT_OFFSET (MonoContext, r14), 8);
 303 #if !defined(__native_client_codegen__)
 304         amd64_mov_reg_membase (code, AMD64_R15, AMD64_ARG_REG1, G_STRUCT_OFFSET (MonoContext, r15), 8);
 305 #endif
 306 #ifdef TARGET_WIN32
 307         amd64_mov_reg_membase (code, AMD64_RDI, AMD64_ARG_REG1,  G_STRUCT_OFFSET (MonoContext, rdi), 8);
 308         amd64_mov_reg_membase (code, AMD64_RSI, AMD64_ARG_REG1,  G_STRUCT_OFFSET (MonoContext, rsi), 8);
 309 #endif
 310
 311         /* call the handler */
 312         amd64_call_reg (code, AMD64_ARG_REG2);
 313
 314         if (! (pos & 8))
 315                 amd64_alu_reg_imm (code, X86_ADD, AMD64_RSP, 8);
 316
 317         /* restore RBP */
 318         amd64_pop_reg (code, AMD64_RBP);
 319
 320         /* Restore callee saved regs */
 321         for (i = AMD64_NREG; i >= 0; --i)
 322                 if (AMD64_IS_CALLEE_SAVED_REG (i))
 323                         amd64_pop_reg (code, i);
 324
 325         amd64_leave (code);
 326         amd64_ret (code);
 327
 328         g_assert ((code - start) < kMaxCodeSize);
 329
 330         nacl_global_codeman_validate(&start, kMaxCodeSize, &code);
 331
 332         mono_arch_flush_icache (start, code - start);
 333
 334         if (info)
 335                 *info = mono_tramp_info_create ("call_filter", start, code - start, ji, unwind_ops);
 336
 337         return start;
 338 }
 339
 340 /*
 341  * The first few arguments are dummy, to force the other arguments to be passed on
 342  * the stack, this avoids overwriting the argument registers in the throw trampoline.
 343  */
 344 void
 345 mono_amd64_throw_exception (guint64 dummy1, guint64 dummy2, guint64 dummy3, guint64 dummy4,
 346                                                         guint64 dummy5, guint64 dummy6,
 347                                                         mgreg_t *regs, mgreg_t rip,
 348                                                         MonoObject *exc, gboolean rethrow)
 349 {
 350         static void (*restore_context) (MonoContext *);
 351         MonoContext ctx;
 352
 353         if (!restore_context)
 354                 restore_context = mono_get_restore_context ();
 355
 356         ctx.rsp = regs [AMD64_RSP];
 357         ctx.rip = rip;
 358         ctx.rbx = regs [AMD64_RBX];
 359         ctx.rbp = regs [AMD64_RBP];
 360         ctx.r12 = regs [AMD64_R12];
 361         ctx.r13 = regs [AMD64_R13];
 362         ctx.r14 = regs [AMD64_R14];
 363         ctx.r15 = regs [AMD64_R15];
 364         ctx.rdi = regs [AMD64_RDI];
 365         ctx.rsi = regs [AMD64_RSI];
 366         ctx.rax = regs [AMD64_RAX];
 367         ctx.rcx = regs [AMD64_RCX];
 368         ctx.rdx = regs [AMD64_RDX];
 369
 370         if (mono_object_isinst (exc, mono_defaults.exception_class)) {
 371                 MonoException *mono_ex = (MonoException*)exc;
 372                 if (!rethrow)
 373                         mono_ex->stack_trace = NULL;
 374         }
 375
 376         if (mono_debug_using_mono_debugger ()) {
 377                 guint8 buf [16];
 378
 379                 mono_breakpoint_clean_code (NULL, (gpointer)rip, 8, buf, sizeof (buf));
 380
 381                 if (buf [3] == 0xe8) {
 382                         MonoContext ctx_cp = ctx;
 383                         ctx_cp.rip = rip - 5;
 384
 385                         if (mono_debugger_handle_exception (&ctx_cp, exc)) {
 386                                 restore_context (&ctx_cp);
 387                                 g_assert_not_reached ();
 388                         }
 389                 }
 390         }
 391
 392         /* adjust eip so that it point into the call instruction */
 393         ctx.rip -= 1;
 394
 395         mono_handle_exception (&ctx, exc);
 396         restore_context (&ctx);
 397
 398         g_assert_not_reached ();
 399 }
 400
 401 void
 402 mono_amd64_throw_corlib_exception (guint64 dummy1, guint64 dummy2, guint64 dummy3, guint64 dummy4,
 403                                                                    guint64 dummy5, guint64 dummy6,
 404                                                                    mgreg_t *regs, mgreg_t rip,
 405                                                                    guint32 ex_token_index, gint64 pc_offset)
 406 {
 407         guint32 ex_token = MONO_TOKEN_TYPE_DEF | ex_token_index;
 408         MonoException *ex;
 409
 410         ex = mono_exception_from_token (mono_defaults.exception_class->image, ex_token);
 411
 412         rip -= pc_offset;
 413
 414         /* Negate the ip adjustment done in mono_amd64_throw_exception () */
 415         rip += 1;
 416
 417         mono_amd64_throw_exception (dummy1, dummy2, dummy3, dummy4, dummy5, dummy6, regs, rip, (MonoObject*)ex, FALSE);
 418 }
 419
 420 static void
 421 mono_amd64_resume_unwind (guint64 dummy1, guint64 dummy2, guint64 dummy3, guint64 dummy4,
 422                                                   guint64 dummy5, guint64 dummy6,
 423                                                   mgreg_t *regs, mgreg_t rip,
 424                                                   guint32 dummy7, gint64 dummy8)
 425 {
 426         /* Only the register parameters are valid */
 427         MonoContext ctx;
 428
 429         ctx.rsp = regs [AMD64_RSP];
 430         ctx.rip = rip;
 431         ctx.rbx = regs [AMD64_RBX];
 432         ctx.rbp = regs [AMD64_RBP];
 433         ctx.r12 = regs [AMD64_R12];
 434         ctx.r13 = regs [AMD64_R13];
 435         ctx.r14 = regs [AMD64_R14];
 436         ctx.r15 = regs [AMD64_R15];
 437         ctx.rdi = regs [AMD64_RDI];
 438         ctx.rsi = regs [AMD64_RSI];
 439         ctx.rax = regs [AMD64_RAX];
 440         ctx.rcx = regs [AMD64_RCX];
 441         ctx.rdx = regs [AMD64_RDX];
 442
 443         mono_resume_unwind (&ctx);
 444 }
 445
 446 /*
 447  * get_throw_trampoline:
 448  *
 449  *  Generate a call to mono_amd64_throw_exception/
 450  * mono_amd64_throw_corlib_exception.
 451  */
 452 static gpointer
 453 get_throw_trampoline (MonoTrampInfo **info, gboolean rethrow, gboolean corlib, gboolean llvm_abs, gboolean resume_unwind, const char *tramp_name, gboolean aot)
 454 {
 455         guint8* start;
 456         guint8 *code;
 457         MonoJumpInfo *ji = NULL;
 458         GSList *unwind_ops = NULL;
 459         int i, stack_size, arg_offsets [16], regs_offset, dummy_stack_space;
 460         const guint kMaxCodeSize = NACL_SIZE (256, 512);
 461
 462 #ifdef TARGET_WIN32
 463         dummy_stack_space = 6 * sizeof(mgreg_t);        /* Windows expects stack space allocated for all 6 dummy args. */
 464 #else
 465         dummy_stack_space = 0;
 466 #endif
 467
 468         start = code = mono_global_codeman_reserve (kMaxCodeSize);
 469
 470         /* The stack is unaligned on entry */
 471         stack_size = 192 + 8 + dummy_stack_space;
 472
 473         code = start;
 474
 475         if (info)
 476                 unwind_ops = mono_arch_get_cie_program ();
 477
 478         /* Alloc frame */
 479         amd64_alu_reg_imm (code, X86_SUB, AMD64_RSP, stack_size);
 480         if (info)
 481                 mono_add_unwind_op_def_cfa_offset (unwind_ops, code, start, stack_size + 8);
 482
 483         /*
 484          * To hide linux/windows calling convention differences, we pass all arguments on
 485          * the stack by passing 6 dummy values in registers.
 486          */
 487
 488         arg_offsets [0] = dummy_stack_space + 0;
 489         arg_offsets [1] = dummy_stack_space + sizeof(mgreg_t);
 490         arg_offsets [2] = dummy_stack_space + sizeof(mgreg_t) * 2;
 491         arg_offsets [3] = dummy_stack_space + sizeof(mgreg_t) * 3;
 492         regs_offset = dummy_stack_space + sizeof(mgreg_t) * 4;
 493
 494         /* Save registers */
 495         for (i = 0; i < AMD64_NREG; ++i)
 496                 if (i != AMD64_RSP)
 497                         amd64_mov_membase_reg (code, AMD64_RSP, regs_offset + (i * sizeof(mgreg_t)), i, sizeof(mgreg_t));
 498         /* Save RSP */
 499         amd64_lea_membase (code, AMD64_RAX, AMD64_RSP, stack_size + sizeof(mgreg_t));
 500         amd64_mov_membase_reg (code, AMD64_RSP, regs_offset + (AMD64_RSP * sizeof(mgreg_t)), X86_EAX, sizeof(mgreg_t));
 501         /* Set arg1 == regs */
 502         amd64_lea_membase (code, AMD64_RAX, AMD64_RSP, regs_offset);
 503         amd64_mov_membase_reg (code, AMD64_RSP, arg_offsets [0], AMD64_RAX, sizeof(mgreg_t));
 504         /* Set arg2 == eip */
 505         if (llvm_abs)
 506                 amd64_alu_reg_reg (code, X86_XOR, AMD64_RAX, AMD64_RAX);
 507         else
 508                 amd64_mov_reg_membase (code, AMD64_RAX, AMD64_RSP, stack_size, sizeof(mgreg_t));
 509         amd64_mov_membase_reg (code, AMD64_RSP, arg_offsets [1], AMD64_RAX, sizeof(mgreg_t));
 510         /* Set arg3 == exc/ex_token_index */
 511         if (resume_unwind)
 512                 amd64_mov_membase_imm (code, AMD64_RSP, arg_offsets [2], 0, sizeof(mgreg_t));
 513         else
 514                 amd64_mov_membase_reg (code, AMD64_RSP, arg_offsets [2], AMD64_ARG_REG1, sizeof(mgreg_t));
 515         /* Set arg4 == rethrow/pc offset */
 516         if (resume_unwind) {
 517                 amd64_mov_membase_imm (code, AMD64_RSP, arg_offsets [3], 0, sizeof(mgreg_t));
 518         } else if (corlib) {
 519                 amd64_mov_membase_reg (code, AMD64_RSP, arg_offsets [3], AMD64_ARG_REG2, sizeof(mgreg_t));
 520                 if (llvm_abs)
 521                         /*
 522                          * The caller is LLVM code which passes the absolute address not a pc offset,
 523                          * so compensate by passing 0 as 'rip' and passing the negated abs address as
 524                          * the pc offset.
 525                          */
 526                         amd64_neg_membase (code, AMD64_RSP, arg_offsets [3]);
 527         } else {
 528                 amd64_mov_membase_imm (code, AMD64_RSP, arg_offsets [3], rethrow, sizeof(mgreg_t));
 529         }
 530
 531         if (aot) {
 532                 ji = mono_patch_info_list_prepend (ji, code - start, MONO_PATCH_INFO_JIT_ICALL_ADDR, corlib ? "mono_amd64_throw_corlib_exception" : "mono_amd64_throw_exception");
 533                 amd64_mov_reg_membase (code, AMD64_R11, AMD64_RIP, 0, 8);
 534         } else {
 535                 amd64_mov_reg_imm (code, AMD64_R11, resume_unwind ? ((gpointer)mono_amd64_resume_unwind) : (corlib ? (gpointer)mono_amd64_throw_corlib_exception : (gpointer)mono_amd64_throw_exception));
 536         }
 537         amd64_call_reg (code, AMD64_R11);
 538         amd64_breakpoint (code);
 539
 540         mono_arch_flush_icache (start, code - start);
 541
 542         g_assert ((code - start) < kMaxCodeSize);
 543
 544         nacl_global_codeman_validate(&start, kMaxCodeSize, &code);
 545
 546         if (info)
 547                 *info = mono_tramp_info_create (tramp_name, start, code - start, ji, unwind_ops);
 548
 549         return start;
 550 }
 551
 552 /**
 553  * mono_arch_get_throw_exception:
 554  *
 555  * Returns a function pointer which can be used to raise
 556  * exceptions. The returned function has the following
 557  * signature: void (*func) (MonoException *exc);
 558  *
 559  */
 560 gpointer
 561 mono_arch_get_throw_exception (MonoTrampInfo **info, gboolean aot)
 562 {
 563         return get_throw_trampoline (info, FALSE, FALSE, FALSE, FALSE, "throw_exception", aot);
 564 }
 565
 566 gpointer
 567 mono_arch_get_rethrow_exception (MonoTrampInfo **info, gboolean aot)
 568 {
 569         return get_throw_trampoline (info, TRUE, FALSE, FALSE, FALSE, "rethrow_exception", aot);
 570 }
 571
 572 /**
 573  * mono_arch_get_throw_corlib_exception:
 574  *
 575  * Returns a function pointer which can be used to raise
 576  * corlib exceptions. The returned function has the following
 577  * signature: void (*func) (guint32 ex_token, guint32 offset);
 578  * Here, offset is the offset which needs to be substracted from the caller IP
 579  * to get the IP of the throw. Passing the offset has the advantage that it
 580  * needs no relocations in the caller.
 581  */
 582 gpointer
 583 mono_arch_get_throw_corlib_exception (MonoTrampInfo **info, gboolean aot)
 584 {
 585         return get_throw_trampoline (info, FALSE, TRUE, FALSE, FALSE, "throw_corlib_exception", aot);
 586 }
 587
 588 /*
 589  * mono_arch_find_jit_info:
 590  *
 591  * This function is used to gather information from @ctx, and store it in @frame_info.
 592  * It unwinds one stack frame, and stores the resulting context into @new_ctx. @lmf
 593  * is modified if needed.
 594  * Returns TRUE on success, FALSE otherwise.
 595  */
 596 gboolean
 597 mono_arch_find_jit_info (MonoDomain *domain, MonoJitTlsData *jit_tls,
 598                                                          MonoJitInfo *ji, MonoContext *ctx,
 599                                                          MonoContext *new_ctx, MonoLMF **lmf,
 600                                                          mgreg_t **save_locations,
 601                                                          StackFrameInfo *frame)
 602 {
 603         gpointer ip = MONO_CONTEXT_GET_IP (ctx);
 604
 605         memset (frame, 0, sizeof (StackFrameInfo));
 606         frame->ji = ji;
 607
 608         *new_ctx = *ctx;
 609
 610         if (ji != NULL) {
 611                 mgreg_t regs [MONO_MAX_IREGS + 1];
 612                 guint8 *cfa;
 613                 guint32 unwind_info_len;
 614                 guint8 *unwind_info;
 615
 616                 frame->type = FRAME_TYPE_MANAGED;
 617
 618                 if (ji->from_aot)
 619                         unwind_info = mono_aot_get_unwind_info (ji, &unwind_info_len);
 620                 else
 621                         unwind_info = mono_get_cached_unwind_info (ji->used_regs, &unwind_info_len);
 622
 623                 frame->unwind_info = unwind_info;
 624                 frame->unwind_info_len = unwind_info_len;
 625
 626                 regs [AMD64_RAX] = new_ctx->rax;
 627                 regs [AMD64_RBX] = new_ctx->rbx;
 628                 regs [AMD64_RCX] = new_ctx->rcx;
 629                 regs [AMD64_RDX] = new_ctx->rdx;
 630                 regs [AMD64_RBP] = new_ctx->rbp;
 631                 regs [AMD64_RSP] = new_ctx->rsp;
 632                 regs [AMD64_RSI] = new_ctx->rsi;
 633                 regs [AMD64_RDI] = new_ctx->rdi;
 634                 regs [AMD64_RIP] = new_ctx->rip;
 635                 regs [AMD64_R12] = new_ctx->r12;
 636                 regs [AMD64_R13] = new_ctx->r13;
 637                 regs [AMD64_R14] = new_ctx->r14;
 638                 regs [AMD64_R15] = new_ctx->r15;
 639
 640                 mono_unwind_frame (unwind_info, unwind_info_len, ji->code_start,
 641                                                    (guint8*)ji->code_start + ji->code_size,
 642                                                    ip, regs, MONO_MAX_IREGS + 1,
 643                                                    save_locations, MONO_MAX_IREGS, &cfa);
 644
 645                 new_ctx->rax = regs [AMD64_RAX];
 646                 new_ctx->rbx = regs [AMD64_RBX];
 647                 new_ctx->rcx = regs [AMD64_RCX];
 648                 new_ctx->rdx = regs [AMD64_RDX];
 649                 new_ctx->rbp = regs [AMD64_RBP];
 650                 new_ctx->rsp = regs [AMD64_RSP];
 651                 new_ctx->rsi = regs [AMD64_RSI];
 652                 new_ctx->rdi = regs [AMD64_RDI];
 653                 new_ctx->rip = regs [AMD64_RIP];
 654                 new_ctx->r12 = regs [AMD64_R12];
 655                 new_ctx->r13 = regs [AMD64_R13];
 656                 new_ctx->r14 = regs [AMD64_R14];
 657                 new_ctx->r15 = regs [AMD64_R15];
 658
 659                 /* The CFA becomes the new SP value */
 660                 new_ctx->rsp = (mgreg_t)cfa;
 661
 662                 /* Adjust IP */
 663                 new_ctx->rip --;
 664
 665                 if (*lmf && ((*lmf) != jit_tls->first_lmf) && (MONO_CONTEXT_GET_SP (ctx) >= (gpointer)(*lmf)->rsp)) {
 666                         /* remove any unused lmf */
 667                         *lmf = (gpointer)(((guint64)(*lmf)->previous_lmf) & ~3);
 668                 }
 669
 670 #ifndef MONO_AMD64_NO_PUSHES
 671                 /* Pop arguments off the stack */
 672                 if (ji->has_arch_eh_info)
 673                         new_ctx->rsp += mono_jit_info_get_arch_eh_info (ji)->stack_size;
 674 #endif
 675
 676                 return TRUE;
 677         } else if (*lmf) {
 678                 guint64 rip;
 679
 680                 if (((guint64)(*lmf)->previous_lmf) & 2) {
 681                         /*
 682                          * This LMF entry is created by the soft debug code to mark transitions to
 683                          * managed code done during invokes.
 684                          */
 685                         MonoLMFExt *ext = (MonoLMFExt*)(*lmf);
 686
 687                         g_assert (ext->debugger_invoke);
 688
 689                         memcpy (new_ctx, &ext->ctx, sizeof (MonoContext));
 690
 691                         *lmf = (gpointer)(((guint64)(*lmf)->previous_lmf) & ~3);
 692
 693                         frame->type = FRAME_TYPE_DEBUGGER_INVOKE;
 694
 695                         return TRUE;
 696                 }
 697
 698                 if (((guint64)(*lmf)->previous_lmf) & 1) {
 699                         /* This LMF has the rip field set */
 700                         rip = (*lmf)->rip;
 701                 } else if ((*lmf)->rsp == 0) {
 702                         /* Top LMF entry */
 703                         return FALSE;
 704                 } else {
 705                         /*
 706                          * The rsp field is set just before the call which transitioned to native
 707                          * code. Obtain the rip from the stack.
 708                          */
 709                         rip = *(guint64*)((*lmf)->rsp - sizeof(mgreg_t));
 710                 }
 711
 712                 ji = mini_jit_info_table_find (domain, (gpointer)rip, NULL);
 713                 /*
 714                  * FIXME: ji == NULL can happen when a managed-to-native wrapper is interrupted
 715                  * in the soft debugger suspend code, since (*lmf)->rsp no longer points to the
 716                  * return address.
 717                  */
 718                 //g_assert (ji);
 719                 if (!ji)
 720                         return FALSE;
 721
 722                 /* Adjust IP */
 723                 rip --;
 724
 725                 frame->ji = ji;
 726                 frame->type = FRAME_TYPE_MANAGED_TO_NATIVE;
 727
 728                 new_ctx->rip = rip;
 729                 new_ctx->rbp = (*lmf)->rbp;
 730                 new_ctx->rsp = (*lmf)->rsp;
 731
 732                 new_ctx->rbx = (*lmf)->rbx;
 733                 new_ctx->r12 = (*lmf)->r12;
 734                 new_ctx->r13 = (*lmf)->r13;
 735                 new_ctx->r14 = (*lmf)->r14;
 736                 new_ctx->r15 = (*lmf)->r15;
 737 #ifdef TARGET_WIN32
 738                 new_ctx->rdi = (*lmf)->rdi;
 739                 new_ctx->rsi = (*lmf)->rsi;
 740 #endif
 741
 742                 *lmf = (gpointer)(((guint64)(*lmf)->previous_lmf) & ~3);
 743
 744                 return TRUE;
 745         }
 746
 747         return FALSE;
 748 }
 749
 750 /*
 751  * handle_exception:
 752  *
 753  *   Called by resuming from a signal handler.
 754  */
 755 static void
 756 handle_signal_exception (gpointer obj)
 757 {
 758         MonoJitTlsData *jit_tls = mono_native_tls_get_value (mono_jit_tls_id);
 759         MonoContext ctx;
 760         static void (*restore_context) (MonoContext *);
 761
 762         if (!restore_context)
 763                 restore_context = mono_get_restore_context ();
 764
 765         memcpy (&ctx, &jit_tls->ex_ctx, sizeof (MonoContext));
 766
 767         if (mono_debugger_handle_exception (&ctx, (MonoObject *)obj))
 768                 return;
 769
 770         mono_handle_exception (&ctx, obj);
 771
 772         restore_context (&ctx);
 773 }
 774
 775 void
 776 mono_arch_setup_async_callback (MonoContext *ctx, void (*async_cb)(void *fun), gpointer user_data)
 777 {
 778         guint64 sp = ctx->rsp;
 779
 780         ctx->rdi = (guint64)user_data;
 781
 782         /* Allocate a stack frame below the red zone */
 783         sp -= 128;
 784         /* The stack should be unaligned */
 785         if ((sp % 16) == 0)
 786                 sp -= 8;
 787         ctx->rsp = sp;
 788         ctx->rip = (guint64)async_cb;
 789 }
 790
 791 /**
 792  * mono_arch_handle_exception:
 793  *
 794  * @ctx: saved processor state
 795  * @obj: the exception object
 796  */
 797 gboolean
 798 mono_arch_handle_exception (void *sigctx, gpointer obj)
 799 {
 800 #if defined(MONO_ARCH_USE_SIGACTION)
 801         MonoContext mctx;
 802
 803         /*
 804          * Handling the exception in the signal handler is problematic, since the original
 805          * signal is disabled, and we could run arbitrary code though the debugger. So
 806          * resume into the normal stack and do most work there if possible.
 807          */
 808         MonoJitTlsData *jit_tls = mono_native_tls_get_value (mono_jit_tls_id);
 809
 810         /* Pass the ctx parameter in TLS */
 811         mono_arch_sigctx_to_monoctx (sigctx, &jit_tls->ex_ctx);
 812
 813         mctx = jit_tls->ex_ctx;
 814         mono_arch_setup_async_callback (&mctx, handle_signal_exception, obj);
 815         mono_monoctx_to_sigctx (&mctx, sigctx);
 816
 817         return TRUE;
 818 #else
 819         MonoContext mctx;
 820
 821         mono_arch_sigctx_to_monoctx (sigctx, &mctx);
 822
 823         if (mono_debugger_handle_exception (&mctx, (MonoObject *)obj))
 824                 return TRUE;
 825
 826         mono_handle_exception (&mctx, obj);
 827
 828         mono_arch_monoctx_to_sigctx (&mctx, sigctx);
 829
 830         return TRUE;
 831 #endif
 832 }
 833
 834 void
 835 mono_arch_sigctx_to_monoctx (void *sigctx, MonoContext *mctx)
 836 {
 837         mono_sigctx_to_monoctx (sigctx, mctx);
 838 }
 839
 840 void
 841 mono_arch_monoctx_to_sigctx (MonoContext *mctx, void *sigctx)
 842 {
 843         mono_monoctx_to_sigctx (mctx, sigctx);
 844 }
 845
 846 gpointer
 847 mono_arch_ip_from_context (void *sigctx)
 848 {
 849 #if defined(MONO_ARCH_USE_SIGACTION)
 850         ucontext_t *ctx = (ucontext_t*)sigctx;
 851
 852         return (gpointer)UCONTEXT_REG_RIP (ctx);
 853 #else
 854         MonoContext *ctx = sigctx;
 855         return (gpointer)ctx->rip;
 856 #endif
 857 }
 858
 859 static void
 860 restore_soft_guard_pages (void)
 861 {
 862         MonoJitTlsData *jit_tls = mono_native_tls_get_value (mono_jit_tls_id);
 863         if (jit_tls->stack_ovf_guard_base)
 864                 mono_mprotect (jit_tls->stack_ovf_guard_base, jit_tls->stack_ovf_guard_size, MONO_MMAP_NONE);
 865 }
 866
 867 /*
 868  * this function modifies mctx so that when it is restored, it
 869  * won't execcute starting at mctx.eip, but in a function that
 870  * will restore the protection on the soft-guard pages and return back to
 871  * continue at mctx.eip.
 872  */
 873 static void
 874 prepare_for_guard_pages (MonoContext *mctx)
 875 {
 876         gpointer *sp;
 877         sp = (gpointer)(mctx->rsp);
 878         sp -= 1;
 879         /* the return addr */
 880         sp [0] = (gpointer)(mctx->rip);
 881         mctx->rip = (guint64)restore_soft_guard_pages;
 882         mctx->rsp = (guint64)sp;
 883 }
 884
 885 static void
 886 altstack_handle_and_restore (void *sigctx, gpointer obj, gboolean stack_ovf)
 887 {
 888         void (*restore_context) (MonoContext *);
 889         MonoContext mctx;
 890
 891         restore_context = mono_get_restore_context ();
 892         mono_arch_sigctx_to_monoctx (sigctx, &mctx);
 893
 894         if (mono_debugger_handle_exception (&mctx, (MonoObject *)obj)) {
 895                 if (stack_ovf)
 896                         prepare_for_guard_pages (&mctx);
 897                 restore_context (&mctx);
 898         }
 899
 900         mono_handle_exception (&mctx, obj);
 901         if (stack_ovf)
 902                 prepare_for_guard_pages (&mctx);
 903         restore_context (&mctx);
 904 }
 905
 906 void
 907 mono_arch_handle_altstack_exception (void *sigctx, gpointer fault_addr, gboolean stack_ovf)
 908 {
 909 #if defined(MONO_ARCH_USE_SIGACTION)
 910         MonoException *exc = NULL;
 911         ucontext_t *ctx = (ucontext_t*)sigctx;
 912         MonoJitInfo *ji = mini_jit_info_table_find (mono_domain_get (), (gpointer)UCONTEXT_REG_RIP (sigctx), NULL);
 913         gpointer *sp;
 914         int frame_size;
 915         ucontext_t *copied_ctx;
 916
 917         if (stack_ovf)
 918                 exc = mono_domain_get ()->stack_overflow_ex;
 919         if (!ji)
 920                 mono_handle_native_sigsegv (SIGSEGV, sigctx);
 921
 922         /* setup a call frame on the real stack so that control is returned there
 923          * and exception handling can continue.
 924          * The frame looks like:
 925          *   ucontext struct
 926          *   ...
 927          *   return ip
 928          * 128 is the size of the red zone
 929          */
 930         frame_size = sizeof (ucontext_t) + sizeof (gpointer) * 4 + 128;
 931 #ifdef __APPLE__
 932         frame_size += sizeof (*ctx->uc_mcontext);
 933 #endif
 934         frame_size += 15;
 935         frame_size &= ~15;
 936         sp = (gpointer)(UCONTEXT_REG_RSP (sigctx) & ~15);
 937         sp = (gpointer)((char*)sp - frame_size);
 938         copied_ctx = (ucontext_t*)(sp + 4);
 939         /* the arguments must be aligned */
 940         sp [-1] = (gpointer)UCONTEXT_REG_RIP (sigctx);
 941         /* may need to adjust pointers in the new struct copy, depending on the OS */
 942         memcpy (copied_ctx, ctx, sizeof (ucontext_t));
 943 #ifdef __APPLE__
 944         {
 945                 guint8 * copied_mcontext = (guint8*)copied_ctx + sizeof (ucontext_t);
 946                 /* uc_mcontext is a pointer, so make a copy which is stored after the ctx */
 947                 memcpy (copied_mcontext, ctx->uc_mcontext, sizeof (*ctx->uc_mcontext));
 948                 copied_ctx->uc_mcontext = (void*)copied_mcontext;
 949         }
 950 #endif
 951         /* at the return form the signal handler execution starts in altstack_handle_and_restore() */
 952         UCONTEXT_REG_RIP (sigctx) = (unsigned long)altstack_handle_and_restore;
 953         UCONTEXT_REG_RSP (sigctx) = (unsigned long)(sp - 1);
 954         UCONTEXT_REG_RDI (sigctx) = (unsigned long)(copied_ctx);
 955         UCONTEXT_REG_RSI (sigctx) = (guint64)exc;
 956         UCONTEXT_REG_RDX (sigctx) = stack_ovf;
 957 #endif
 958 }
 959
 960 guint64
 961 mono_amd64_get_original_ip (void)
 962 {
 963         MonoLMF *lmf = mono_get_lmf ();
 964
 965         g_assert (lmf);
 966
 967         /* Reset the change to previous_lmf */
 968         lmf->previous_lmf = (gpointer)((guint64)lmf->previous_lmf & ~1);
 969
 970         return lmf->rip;
 971 }
 972
 973 gpointer
 974 mono_arch_get_throw_pending_exception (MonoTrampInfo **info, gboolean aot)
 975 {
 976         guint8 *code, *start;
 977         guint8 *br[1];
 978         gpointer throw_trampoline;
 979         MonoJumpInfo *ji = NULL;
 980         GSList *unwind_ops = NULL;
 981         const guint kMaxCodeSize = NACL_SIZE (128, 256);
 982
 983         start = code = mono_global_codeman_reserve (kMaxCodeSize);
 984
 985         /* We are in the frame of a managed method after a call */
 986         /*
 987          * We would like to throw the pending exception in such a way that it looks to
 988          * be thrown from the managed method.
 989          */
 990
 991         /* Save registers which might contain the return value of the call */
 992         amd64_push_reg (code, AMD64_RAX);
 993         amd64_push_reg (code, AMD64_RDX);
 994
 995         amd64_alu_reg_imm (code, X86_SUB, AMD64_RSP, 8);
 996         amd64_movsd_membase_reg (code, AMD64_RSP, 0, AMD64_XMM0);
 997
 998         /* Align stack */
 999         amd64_alu_reg_imm (code, X86_SUB, AMD64_RSP, 8);
1000
1001         /* Obtain the pending exception */
1002         if (aot) {
1003                 ji = mono_patch_info_list_prepend (ji, code - start, MONO_PATCH_INFO_JIT_ICALL_ADDR, "mono_thread_get_and_clear_pending_exception");
1004                 amd64_mov_reg_membase (code, AMD64_R11, AMD64_RIP, 0, 8);
1005         } else {
1006                 amd64_mov_reg_imm (code, AMD64_R11, mono_thread_get_and_clear_pending_exception);
1007         }
1008         amd64_call_reg (code, AMD64_R11);
1009
1010         /* Check if it is NULL, and branch */
1011         amd64_alu_reg_imm (code, X86_CMP, AMD64_RAX, 0);
1012         br[0] = code; x86_branch8 (code, X86_CC_EQ, 0, FALSE);
1013
1014         /* exc != NULL branch */
1015
1016         /* Save the exc on the stack */
1017         amd64_push_reg (code, AMD64_RAX);
1018         /* Align stack */
1019         amd64_alu_reg_imm (code, X86_SUB, AMD64_RSP, 8);
1020
1021         /* Obtain the original ip and clear the flag in previous_lmf */
1022         if (aot) {
1023                 ji = mono_patch_info_list_prepend (ji, code - start, MONO_PATCH_INFO_JIT_ICALL_ADDR, "mono_amd64_get_original_ip");
1024                 amd64_mov_reg_membase (code, AMD64_R11, AMD64_RIP, 0, 8);
1025         } else {
1026                 amd64_mov_reg_imm (code, AMD64_R11, mono_amd64_get_original_ip);
1027         }
1028         amd64_call_reg (code, AMD64_R11);
1029
1030         /* Load exc */
1031         amd64_mov_reg_membase (code, AMD64_R11, AMD64_RSP, 8, 8);
1032
1033         /* Pop saved stuff from the stack */
1034         amd64_alu_reg_imm (code, X86_ADD, AMD64_RSP, 6 * 8);
1035
1036         /* Setup arguments for the throw trampoline */
1037         /* Exception */
1038         amd64_mov_reg_reg (code, AMD64_ARG_REG1, AMD64_R11, 8);
1039         /* The trampoline expects the caller ip to be pushed on the stack */
1040         amd64_push_reg (code, AMD64_RAX);
1041
1042         /* Call the throw trampoline */
1043         if (aot) {
1044                 ji = mono_patch_info_list_prepend (ji, code - start, MONO_PATCH_INFO_JIT_ICALL_ADDR, "mono_amd64_throw_exception");
1045                 amd64_mov_reg_membase (code, AMD64_R11, AMD64_RIP, 0, 8);
1046         } else {
1047                 throw_trampoline = mono_get_throw_exception ();
1048                 amd64_mov_reg_imm (code, AMD64_R11, throw_trampoline);
1049         }
1050         /* We use a jump instead of a call so we can push the original ip on the stack */
1051         amd64_jump_reg (code, AMD64_R11);
1052
1053         /* ex == NULL branch */
1054         mono_amd64_patch (br [0], code);
1055
1056         /* Obtain the original ip and clear the flag in previous_lmf */
1057         if (aot) {
1058                 ji = mono_patch_info_list_prepend (ji, code - start, MONO_PATCH_INFO_JIT_ICALL_ADDR, "mono_amd64_get_original_ip");
1059                 amd64_mov_reg_membase (code, AMD64_R11, AMD64_RIP, 0, 8);
1060         } else {
1061                 amd64_mov_reg_imm (code, AMD64_R11, mono_amd64_get_original_ip);
1062         }
1063         amd64_call_reg (code, AMD64_R11);
1064         amd64_mov_reg_reg (code, AMD64_R11, AMD64_RAX, 8);
1065
1066         /* Restore registers */
1067         amd64_alu_reg_imm (code, X86_ADD, AMD64_RSP, 8);
1068         amd64_movsd_reg_membase (code, AMD64_XMM0, AMD64_RSP, 0);
1069         amd64_alu_reg_imm (code, X86_ADD, AMD64_RSP, 8);
1070         amd64_pop_reg (code, AMD64_RDX);
1071         amd64_pop_reg (code, AMD64_RAX);
1072
1073         /* Return to original code */
1074         amd64_jump_reg (code, AMD64_R11);
1075
1076         g_assert ((code - start) < kMaxCodeSize);
1077
1078         nacl_global_codeman_validate(&start, kMaxCodeSize, &code);
1079
1080         if (info)
1081                 *info = mono_tramp_info_create ("throw_pending_exception", start, code - start, ji, unwind_ops);
1082
1083         return start;
1084 }
1085
1086 static gpointer throw_pending_exception;
1087
1088 /*
1089  * Called when a thread receives an async exception while executing unmanaged code.
1090  * Instead of checking for this exception in the managed-to-native wrapper, we hijack
1091  * the return address on the stack to point to a helper routine which throws the
1092  * exception.
1093  */
1094 void
1095 mono_arch_notify_pending_exc (void)
1096 {
1097         MonoLMF *lmf = mono_get_lmf ();
1098
1099         if (!lmf)
1100                 /* Not yet started */
1101                 return;
1102
1103         if (lmf->rsp == 0)
1104                 /* Initial LMF */
1105                 return;
1106
1107         if ((guint64)lmf->previous_lmf & 1)
1108                 /* Already hijacked or trampoline LMF entry */
1109                 return;
1110
1111         /* lmf->rsp is set just before making the call which transitions to unmanaged code */
1112         lmf->rip = *(guint64*)(lmf->rsp - 8);
1113         /* Signal that lmf->rip is set */
1114         lmf->previous_lmf = (gpointer)((guint64)lmf->previous_lmf | 1);
1115
1116         *(gpointer*)(lmf->rsp - 8) = throw_pending_exception;
1117 }
1118
1119 GSList*
1120 mono_amd64_get_exception_trampolines (gboolean aot)
1121 {
1122         MonoTrampInfo *info;
1123         GSList *tramps = NULL;
1124
1125         mono_arch_get_throw_pending_exception (&info, aot);
1126         tramps = g_slist_prepend (tramps, info);
1127
1128         /* LLVM needs different throw trampolines */
1129         get_throw_trampoline (&info, FALSE, TRUE, FALSE, FALSE, "llvm_throw_corlib_exception_trampoline", aot);
1130         tramps = g_slist_prepend (tramps, info);
1131
1132         get_throw_trampoline (&info, FALSE, TRUE, TRUE, FALSE, "llvm_throw_corlib_exception_abs_trampoline", aot);
1133         tramps = g_slist_prepend (tramps, info);
1134
1135         get_throw_trampoline (&info, FALSE, TRUE, TRUE, TRUE, "llvm_resume_unwind_trampoline", FALSE);
1136         tramps = g_slist_prepend (tramps, info);
1137
1138         return tramps;
1139 }
1140
1141 void
1142 mono_arch_exceptions_init (void)
1143 {
1144         GSList *tramps, *l;
1145         gpointer tramp;
1146
1147         if (mono_aot_only) {
1148                 throw_pending_exception = mono_aot_get_trampoline ("throw_pending_exception");
1149                 tramp = mono_aot_get_trampoline ("llvm_throw_corlib_exception_trampoline");
1150                 mono_register_jit_icall (tramp, "llvm_throw_corlib_exception_trampoline", NULL, TRUE);
1151                 tramp = mono_aot_get_trampoline ("llvm_throw_corlib_exception_abs_trampoline");
1152                 mono_register_jit_icall (tramp, "llvm_throw_corlib_exception_abs_trampoline", NULL, TRUE);
1153                 tramp = mono_aot_get_trampoline ("llvm_resume_unwind_trampoline");
1154                 mono_register_jit_icall (tramp, "llvm_resume_unwind_trampoline", NULL, TRUE);
1155         } else {
1156                 /* Call this to avoid initialization races */
1157                 throw_pending_exception = mono_arch_get_throw_pending_exception (NULL, FALSE);
1158
1159                 tramps = mono_amd64_get_exception_trampolines (FALSE);
1160                 for (l = tramps; l; l = l->next) {
1161                         MonoTrampInfo *info = l->data;
1162
1163                         mono_register_jit_icall (info->code, g_strdup (info->name), NULL, TRUE);
1164                         mono_save_trampoline_xdebug_info (info);
1165                         mono_tramp_info_free (info);
1166                 }
1167                 g_slist_free (tramps);
1168         }
1169 }
1170
1171 #ifdef TARGET_WIN32
1172
1173 /*
1174  * The mono_arch_unwindinfo* methods are used to build and add
1175  * function table info for each emitted method from mono.  On Winx64
1176  * the seh handler will not be called if the mono methods are not
1177  * added to the function table.
1178  *
1179  * We should not need to add non-volatile register info to the
1180  * table since mono stores that info elsewhere. (Except for the register
1181  * used for the fp.)
1182  */
1183
1184 #define MONO_MAX_UNWIND_CODES 22
1185
1186 typedef union _UNWIND_CODE {
1187     struct {
1188         guchar CodeOffset;
1189         guchar UnwindOp : 4;
1190         guchar OpInfo   : 4;
1191     };
1192     gushort FrameOffset;
1193 } UNWIND_CODE, *PUNWIND_CODE;
1194
1195 typedef struct _UNWIND_INFO {
1196         guchar Version       : 3;
1197         guchar Flags         : 5;
1198         guchar SizeOfProlog;
1199         guchar CountOfCodes;
1200         guchar FrameRegister : 4;
1201         guchar FrameOffset   : 4;
1202         /* custom size for mono allowing for mono allowing for*/
1203         /*UWOP_PUSH_NONVOL ebp offset = 21*/
1204         /*UWOP_ALLOC_LARGE : requires 2 or 3 offset = 20*/
1205         /*UWOP_SET_FPREG : requires 2 offset = 17*/
1206         /*UWOP_PUSH_NONVOL offset = 15-0*/
1207         UNWIND_CODE UnwindCode[MONO_MAX_UNWIND_CODES];
1208
1209 /*      UNWIND_CODE MoreUnwindCode[((CountOfCodes + 1) & ~1) - 1];
1210  *      union {
1211  *          OPTIONAL ULONG ExceptionHandler;
1212  *          OPTIONAL ULONG FunctionEntry;
1213  *      };
1214  *      OPTIONAL ULONG ExceptionData[]; */
1215 } UNWIND_INFO, *PUNWIND_INFO;
1216
1217 typedef struct
1218 {
1219         RUNTIME_FUNCTION runtimeFunction;
1220         UNWIND_INFO unwindInfo;
1221 } MonoUnwindInfo, *PMonoUnwindInfo;
1222
1223 static void
1224 mono_arch_unwindinfo_create (gpointer* monoui)
1225 {
1226         PMonoUnwindInfo newunwindinfo;
1227         *monoui = newunwindinfo = g_new0 (MonoUnwindInfo, 1);
1228         newunwindinfo->unwindInfo.Version = 1;
1229 }
1230
1231 void
1232 mono_arch_unwindinfo_add_push_nonvol (gpointer* monoui, gpointer codebegin, gpointer nextip, guchar reg )
1233 {
1234         PMonoUnwindInfo unwindinfo;
1235         PUNWIND_CODE unwindcode;
1236         guchar codeindex;
1237         if (!*monoui)
1238                 mono_arch_unwindinfo_create (monoui);
1239
1240         unwindinfo = (MonoUnwindInfo*)*monoui;
1241
1242         if (unwindinfo->unwindInfo.CountOfCodes >= MONO_MAX_UNWIND_CODES)
1243                 g_error ("Larger allocation needed for the unwind information.");
1244
1245         codeindex = MONO_MAX_UNWIND_CODES - (++unwindinfo->unwindInfo.CountOfCodes);
1246         unwindcode = &unwindinfo->unwindInfo.UnwindCode[codeindex];
1247         unwindcode->UnwindOp = 0; /*UWOP_PUSH_NONVOL*/
1248         unwindcode->CodeOffset = (((guchar*)nextip)-((guchar*)codebegin));
1249         unwindcode->OpInfo = reg;
1250
1251         if (unwindinfo->unwindInfo.SizeOfProlog >= unwindcode->CodeOffset)
1252                 g_error ("Adding unwind info in wrong order.");
1253
1254         unwindinfo->unwindInfo.SizeOfProlog = unwindcode->CodeOffset;
1255 }
1256
1257 void
1258 mono_arch_unwindinfo_add_set_fpreg (gpointer* monoui, gpointer codebegin, gpointer nextip, guchar reg )
1259 {
1260         PMonoUnwindInfo unwindinfo;
1261         PUNWIND_CODE unwindcode;
1262         guchar codeindex;
1263         if (!*monoui)
1264                 mono_arch_unwindinfo_create (monoui);
1265
1266         unwindinfo = (MonoUnwindInfo*)*monoui;
1267
1268         if (unwindinfo->unwindInfo.CountOfCodes + 1 >= MONO_MAX_UNWIND_CODES)
1269                 g_error ("Larger allocation needed for the unwind information.");
1270
1271         codeindex = MONO_MAX_UNWIND_CODES - (unwindinfo->unwindInfo.CountOfCodes += 2);
1272         unwindcode = &unwindinfo->unwindInfo.UnwindCode[codeindex];
1273         unwindcode->FrameOffset = 0; /*Assuming no frame pointer offset for mono*/
1274         unwindcode++;
1275         unwindcode->UnwindOp = 3; /*UWOP_SET_FPREG*/
1276         unwindcode->CodeOffset = (((guchar*)nextip)-((guchar*)codebegin));
1277         unwindcode->OpInfo = reg;
1278
1279         unwindinfo->unwindInfo.FrameRegister = reg;
1280
1281         if (unwindinfo->unwindInfo.SizeOfProlog >= unwindcode->CodeOffset)
1282                 g_error ("Adding unwind info in wrong order.");
1283
1284         unwindinfo->unwindInfo.SizeOfProlog = unwindcode->CodeOffset;
1285 }
1286
1287 void
1288 mono_arch_unwindinfo_add_alloc_stack (gpointer* monoui, gpointer codebegin, gpointer nextip, guint size )
1289 {
1290         PMonoUnwindInfo unwindinfo;
1291         PUNWIND_CODE unwindcode;
1292         guchar codeindex;
1293         guchar codesneeded;
1294         if (!*monoui)
1295                 mono_arch_unwindinfo_create (monoui);
1296
1297         unwindinfo = (MonoUnwindInfo*)*monoui;
1298
1299         if (size < 0x8)
1300                 g_error ("Stack allocation must be equal to or greater than 0x8.");
1301
1302         if (size <= 0x80)
1303                 codesneeded = 1;
1304         else if (size <= 0x7FFF8)
1305                 codesneeded = 2;
1306         else
1307                 codesneeded = 3;
1308
1309         if (unwindinfo->unwindInfo.CountOfCodes + codesneeded > MONO_MAX_UNWIND_CODES)
1310                 g_error ("Larger allocation needed for the unwind information.");
1311
1312         codeindex = MONO_MAX_UNWIND_CODES - (unwindinfo->unwindInfo.CountOfCodes += codesneeded);
1313         unwindcode = &unwindinfo->unwindInfo.UnwindCode[codeindex];
1314
1315         if (codesneeded == 1) {
1316                 /*The size of the allocation is
1317                   (the number in the OpInfo member) times 8 plus 8*/
1318                 unwindcode->OpInfo = (size - 8)/8;
1319                 unwindcode->UnwindOp = 2; /*UWOP_ALLOC_SMALL*/
1320         }
1321         else {
1322                 if (codesneeded == 3) {
1323                         /*the unscaled size of the allocation is recorded
1324                           in the next two slots in little-endian format*/
1325                         *((unsigned int*)(&unwindcode->FrameOffset)) = size;
1326                         unwindcode += 2;
1327                         unwindcode->OpInfo = 1;
1328                 }
1329                 else {
1330                         /*the size of the allocation divided by 8
1331                           is recorded in the next slot*/
1332                         unwindcode->FrameOffset = size/8;
1333                         unwindcode++;
1334                         unwindcode->OpInfo = 0;
1335
1336                 }
1337                 unwindcode->UnwindOp = 1; /*UWOP_ALLOC_LARGE*/
1338         }
1339
1340         unwindcode->CodeOffset = (((guchar*)nextip)-((guchar*)codebegin));
1341
1342         if (unwindinfo->unwindInfo.SizeOfProlog >= unwindcode->CodeOffset)
1343                 g_error ("Adding unwind info in wrong order.");
1344
1345         unwindinfo->unwindInfo.SizeOfProlog = unwindcode->CodeOffset;
1346 }
1347
1348 guint
1349 mono_arch_unwindinfo_get_size (gpointer monoui)
1350 {
1351         PMonoUnwindInfo unwindinfo;
1352         if (!monoui)
1353                 return 0;
1354
1355         unwindinfo = (MonoUnwindInfo*)monoui;
1356         return (8 + sizeof (MonoUnwindInfo)) -
1357                 (sizeof (UNWIND_CODE) * (MONO_MAX_UNWIND_CODES - unwindinfo->unwindInfo.CountOfCodes));
1358 }
1359
1360 PRUNTIME_FUNCTION
1361 MONO_GET_RUNTIME_FUNCTION_CALLBACK ( DWORD64 ControlPc, IN PVOID Context )
1362 {
1363         MonoJitInfo *ji;
1364         guint64 pos;
1365         PMonoUnwindInfo targetinfo;
1366         MonoDomain *domain = mono_domain_get ();
1367
1368         ji = mini_jit_info_table_find (domain, (char*)ControlPc, NULL);
1369         if (!ji)
1370                 return 0;
1371
1372         pos = (guint64)(((char*)ji->code_start) + ji->code_size);
1373
1374         targetinfo = (PMonoUnwindInfo)ALIGN_TO (pos, 8);
1375
1376         targetinfo->runtimeFunction.UnwindData = ((DWORD64)&targetinfo->unwindInfo) - ((DWORD64)Context);
1377
1378         return &targetinfo->runtimeFunction;
1379 }
1380
1381 void
1382 mono_arch_unwindinfo_install_unwind_info (gpointer* monoui, gpointer code, guint code_size)
1383 {
1384         PMonoUnwindInfo unwindinfo, targetinfo;
1385         guchar codecount;
1386         guint64 targetlocation;
1387         if (!*monoui)
1388                 return;
1389
1390         unwindinfo = (MonoUnwindInfo*)*monoui;
1391         targetlocation = (guint64)&(((guchar*)code)[code_size]);
1392         targetinfo = (PMonoUnwindInfo) ALIGN_TO(targetlocation, 8);
1393
1394         unwindinfo->runtimeFunction.EndAddress = code_size;
1395         unwindinfo->runtimeFunction.UnwindData = ((guchar*)&targetinfo->unwindInfo) - ((guchar*)code);
1396
1397         memcpy (targetinfo, unwindinfo, sizeof (MonoUnwindInfo) - (sizeof (UNWIND_CODE) * MONO_MAX_UNWIND_CODES));
1398
1399         codecount = unwindinfo->unwindInfo.CountOfCodes;
1400         if (codecount) {
1401                 memcpy (&targetinfo->unwindInfo.UnwindCode[0], &unwindinfo->unwindInfo.UnwindCode[MONO_MAX_UNWIND_CODES-codecount],
1402                         sizeof (UNWIND_CODE) * unwindinfo->unwindInfo.CountOfCodes);
1403         }
1404
1405         g_free (unwindinfo);
1406         *monoui = 0;
1407
1408         RtlInstallFunctionTableCallback (((DWORD64)code) | 0x3, (DWORD64)code, code_size, MONO_GET_RUNTIME_FUNCTION_CALLBACK, code, NULL);
1409 }
1410
1411 #endif
1412
1413 #if MONO_SUPPORT_TASKLETS
1414 MonoContinuationRestore
1415 mono_tasklets_arch_restore (void)
1416 {
1417         static guint8* saved = NULL;
1418         guint8 *code, *start;
1419         int cont_reg = AMD64_R9; /* register usable on both call conventions */
1420         const guint kMaxCodeSize = NACL_SIZE (64, 128);
1421
1422
1423         if (saved)
1424                 return (MonoContinuationRestore)saved;
1425         code = start = mono_global_codeman_reserve (kMaxCodeSize);
1426         /* the signature is: restore (MonoContinuation *cont, int state, MonoLMF **lmf_addr) */
1427         /* cont is in AMD64_ARG_REG1 ($rcx or $rdi)
1428          * state is in AMD64_ARG_REG2 ($rdx or $rsi)
1429          * lmf_addr is in AMD64_ARG_REG3 ($r8 or $rdx)
1430          * We move cont to cont_reg since we need both rcx and rdi for the copy
1431          * state is moved to $rax so it's setup as the return value and we can overwrite $rsi
1432          */
1433         amd64_mov_reg_reg (code, cont_reg, MONO_AMD64_ARG_REG1, 8);
1434         amd64_mov_reg_reg (code, AMD64_RAX, MONO_AMD64_ARG_REG2, 8);
1435         /* setup the copy of the stack */
1436         amd64_mov_reg_membase (code, AMD64_RCX, cont_reg, G_STRUCT_OFFSET (MonoContinuation, stack_used_size), sizeof (int));
1437         amd64_shift_reg_imm (code, X86_SHR, AMD64_RCX, 3);
1438         x86_cld (code);
1439         amd64_mov_reg_membase (code, AMD64_RSI, cont_reg, G_STRUCT_OFFSET (MonoContinuation, saved_stack), sizeof (gpointer));
1440         amd64_mov_reg_membase (code, AMD64_RDI, cont_reg, G_STRUCT_OFFSET (MonoContinuation, return_sp), sizeof (gpointer));
1441         amd64_prefix (code, X86_REP_PREFIX);
1442         amd64_movsl (code);
1443
1444         /* now restore the registers from the LMF */
1445         amd64_mov_reg_membase (code, AMD64_RCX, cont_reg, G_STRUCT_OFFSET (MonoContinuation, lmf), 8);
1446         amd64_mov_reg_membase (code, AMD64_RBX, AMD64_RCX, G_STRUCT_OFFSET (MonoLMF, rbx), 8);
1447         amd64_mov_reg_membase (code, AMD64_RBP, AMD64_RCX, G_STRUCT_OFFSET (MonoLMF, rbp), 8);
1448         amd64_mov_reg_membase (code, AMD64_R12, AMD64_RCX, G_STRUCT_OFFSET (MonoLMF, r12), 8);
1449         amd64_mov_reg_membase (code, AMD64_R13, AMD64_RCX, G_STRUCT_OFFSET (MonoLMF, r13), 8);
1450         amd64_mov_reg_membase (code, AMD64_R14, AMD64_RCX, G_STRUCT_OFFSET (MonoLMF, r14), 8);
1451 #if !defined(__native_client_codegen__)
1452         amd64_mov_reg_membase (code, AMD64_R15, AMD64_RCX, G_STRUCT_OFFSET (MonoLMF, r15), 8);
1453 #endif
1454 #ifdef TARGET_WIN32
1455         amd64_mov_reg_membase (code, AMD64_RDI, AMD64_RCX, G_STRUCT_OFFSET (MonoLMF, rdi), 8);
1456         amd64_mov_reg_membase (code, AMD64_RSI, AMD64_RCX, G_STRUCT_OFFSET (MonoLMF, rsi), 8);
1457 #endif
1458         amd64_mov_reg_membase (code, AMD64_RSP, AMD64_RCX, G_STRUCT_OFFSET (MonoLMF, rsp), 8);
1459
1460         /* restore the lmf chain */
1461         /*x86_mov_reg_membase (code, X86_ECX, X86_ESP, 12, 4);
1462         x86_mov_membase_reg (code, X86_ECX, 0, X86_EDX, 4);*/
1463
1464         /* state is already in rax */
1465         amd64_jump_membase (code, cont_reg, G_STRUCT_OFFSET (MonoContinuation, return_ip));
1466         g_assert ((code - start) <= kMaxCodeSize);
1467
1468         nacl_global_codeman_validate(&start, kMaxCodeSize, &code);
1469
1470         saved = start;
1471         return (MonoContinuationRestore)saved;
1472 }
1473 #endif
1474
1475 /*
1476  * mono_arch_setup_resume_sighandler_ctx:
1477  *
1478  *   Setup CTX so execution continues at FUNC.
1479  */
1480 void
1481 mono_arch_setup_resume_sighandler_ctx (MonoContext *ctx, gpointer func)
1482 {
1483         /*
1484          * When resuming from a signal handler, the stack should be misaligned, just like right after
1485          * a call.
1486          */
1487         if ((((guint64)MONO_CONTEXT_GET_SP (ctx)) % 16) == 0)
1488                 MONO_CONTEXT_SET_SP (ctx, (guint64)MONO_CONTEXT_GET_SP (ctx) - 8);
1489         MONO_CONTEXT_SET_IP (ctx, func);
1490 }