mono/mini/tramp-amd64.c

   1 /*
   2  * tramp-x86.c: JIT trampoline code for x86
   3  *
   4  * Authors:
   5  *   Dietmar Maurer (dietmar@ximian.com)
   6  *
   7  * (C) 2001 Ximian, Inc.
   8  */
   9
  10 #include <config.h>
  11 #include <glib.h>
  12
  13 #include <mono/metadata/appdomain.h>
  14 #include <mono/metadata/marshal.h>
  15 #include <mono/metadata/tabledefs.h>
  16 #include <mono/metadata/mono-debug-debugger.h>
  17 #include <mono/arch/amd64/amd64-codegen.h>
  18
  19 #ifdef HAVE_VALGRIND_MEMCHECK_H
  20 #include <valgrind/memcheck.h>
  21 #endif
  22
  23 #include "mini.h"
  24 #include "mini-amd64.h"
  25
  26 #define IS_REX(inst) (((inst) >= 0x40) && ((inst) <= 0x4f))
  27
  28 static guint8* nullified_class_init_trampoline;
  29
  30 /*
  31  * mono_arch_get_unbox_trampoline:
  32  * @m: method pointer
  33  * @addr: pointer to native code for @m
  34  *
  35  * when value type methods are called through the vtable we need to unbox the
  36  * this argument. This method returns a pointer to a trampoline which does
  37  * unboxing before calling the method
  38  */
  39 gpointer
  40 mono_arch_get_unbox_trampoline (MonoMethod *m, gpointer addr)
  41 {
  42         guint8 *code, *start;
  43         int this_reg = AMD64_ARG_REG1;
  44
  45         MonoDomain *domain = mono_domain_get ();
  46
  47         if (!mono_method_signature (m)->ret->byref && MONO_TYPE_ISSTRUCT (mono_method_signature (m)->ret))
  48                 this_reg = AMD64_ARG_REG2;
  49
  50         mono_domain_lock (domain);
  51         start = code = mono_code_manager_reserve (domain->code_mp, 20);
  52         mono_domain_unlock (domain);
  53
  54         amd64_alu_reg_imm (code, X86_ADD, this_reg, sizeof (MonoObject));
  55         /* FIXME: Optimize this */
  56         amd64_mov_reg_imm (code, AMD64_RAX, addr);
  57         amd64_jump_reg (code, AMD64_RAX);
  58         g_assert ((code - start) < 20);
  59
  60         mono_arch_flush_icache (start, code - start);
  61
  62         return start;
  63 }
  64
  65 /*
  66  * mono_arch_patch_callsite:
  67  *
  68  *   Patch the callsite whose address is given by ORIG_CODE so it calls ADDR. ORIG_CODE
  69  * points to the pc right after the call.
  70  */
  71 void
  72 mono_arch_patch_callsite (guint8 *orig_code, guint8 *addr)
  73 {
  74         guint8 *code;
  75         guint8 buf [16];
  76         gboolean can_write = mono_breakpoint_clean_code (orig_code - 14, buf, sizeof (buf));
  77
  78         code = buf + 14;
  79
  80         if (((code [-13] == 0x49) && (code [-12] == 0xbb)) || (code [-5] == 0xe8)) {
  81                 if (code [-5] != 0xe8) {
  82                         if (can_write)
  83                                 InterlockedExchangePointer ((gpointer*)(orig_code - 11), addr);
  84                 } else {
  85                         if ((((guint64)(addr)) >> 32) != 0) {
  86                                 /* Print some diagnostics */
  87                                 MonoJitInfo *ji = mono_jit_info_table_find (mono_domain_get (), (char*)orig_code);
  88                                 if (ji) {
  89                                         fprintf (stderr, "At %s, offset 0x%zx\n", mono_method_full_name (ji->method, TRUE), (guint8*)orig_code - (guint8*)ji->code_start);
  90                                 }
  91                                 fprintf (stderr, "Addr: %p\n", addr);
  92                                 g_assert_not_reached ();
  93                         }
  94                         g_assert ((((guint64)(orig_code)) >> 32) == 0);
  95                         if (can_write)
  96                                 InterlockedExchange ((gint32*)(orig_code - 4), ((gint64)addr - (gint64)orig_code));
  97                 }
  98         }
  99         else if ((code [-7] == 0x41) && (code [-6] == 0xff) && (code [-5] == 0x15)) {
 100                 /* call *<OFFSET>(%rip) */
 101                 gpointer *got_entry = (gpointer*)((guint8*)orig_code + (*(guint32*)(orig_code - 4)));
 102                 if (can_write)
 103                         InterlockedExchangePointer (got_entry, addr);
 104         }
 105 }
 106
 107 void
 108 mono_arch_patch_plt_entry (guint8 *code, guint8 *addr)
 109 {
 110         gint32 disp;
 111         gpointer *plt_jump_table_entry;
 112
 113         /* A PLT entry: jmp *<DISP>(%rip) */
 114         g_assert (code [0] == 0xff);
 115         g_assert (code [1] == 0x25);
 116
 117         disp = *(gint32*)(code + 2);
 118
 119         plt_jump_table_entry = (gpointer*)(code + 6 + disp);
 120
 121         InterlockedExchangePointer (plt_jump_table_entry, addr);
 122 }
 123
 124 void
 125 mono_arch_nullify_class_init_trampoline (guint8 *code, gssize *regs)
 126 {
 127         code -= 3;
 128
 129         /*
 130          * A given byte sequence can match more than case here, so we have to be
 131          * really careful about the ordering of the cases. Longer sequences
 132          * come first.
 133          */
 134         if ((code [-4] == 0x41) && (code [-3] == 0xff) && (code [-2] == 0x15)) {
 135                 gpointer *vtable_slot;
 136
 137                 /* call *<OFFSET>(%rip) */
 138                 vtable_slot = mono_arch_get_vcall_slot_addr (code + 3, (gpointer*)regs);
 139                 g_assert (vtable_slot);
 140
 141                 *vtable_slot = nullified_class_init_trampoline;
 142         } else if (code [-2] == 0xe8) {
 143                 /* call <TARGET> */
 144                 guint8 *buf = code - 2;
 145
 146                 buf [0] = 0x66;
 147                 buf [1] = 0x66;
 148                 buf [2] = 0x90;
 149                 buf [3] = 0x66;
 150                 buf [4] = 0x90;
 151         } else if ((code [0] == 0x41) && (code [1] == 0xff)) {
 152                 /* call <REG> */
 153                 /* happens on machines without MAP_32BIT like freebsd */
 154                 /* amd64_set_reg_template is 10 bytes long */
 155                 guint8* buf = code - 10;
 156
 157                 /* FIXME: Make this thread safe */
 158                 /* Padding code suggested by the AMD64 Opt Manual */
 159                 buf [0] = 0x66;
 160                 buf [1] = 0x66;
 161                 buf [2] = 0x66;
 162                 buf [3] = 0x90;
 163                 buf [4] = 0x66;
 164                 buf [5] = 0x66;
 165                 buf [6] = 0x66;
 166                 buf [7] = 0x90;
 167                 buf [8] = 0x66;
 168                 buf [9] = 0x66;
 169                 buf [10] = 0x90;
 170                 buf [11] = 0x66;
 171                 buf [12] = 0x90;
 172         } else if (code [0] == 0x90 || code [0] == 0xeb || code [0] == 0x66) {
 173                 /* Already changed by another thread */
 174                 ;
 175         } else {
 176                 printf ("Invalid trampoline sequence: %x %x %x %x %x %x %x\n", code [0], code [1], code [2], code [3],
 177                                 code [4], code [5], code [6]);
 178                 g_assert_not_reached ();
 179         }
 180 }
 181
 182 void
 183 mono_arch_nullify_plt_entry (guint8 *code)
 184 {
 185         mono_arch_patch_plt_entry (code, nullified_class_init_trampoline);
 186 }
 187
 188 guchar*
 189 mono_arch_create_trampoline_code (MonoTrampolineType tramp_type)
 190 {
 191         guint8 *buf, *code, *tramp, *br [2];
 192         int i, lmf_offset, offset, res_offset, arg_offset, tramp_offset, saved_regs_offset, saved_fpregs_offset, framesize;
 193         gboolean has_caller;
 194
 195         if (tramp_type == MONO_TRAMPOLINE_JUMP)
 196                 has_caller = FALSE;
 197         else
 198                 has_caller = TRUE;
 199
 200         code = buf = mono_global_codeman_reserve (512);
 201
 202         framesize = 512 + sizeof (MonoLMF);
 203         framesize = (framesize + (MONO_ARCH_FRAME_ALIGNMENT - 1)) & ~ (MONO_ARCH_FRAME_ALIGNMENT - 1);
 204
 205         offset = 0;
 206
 207         /*
 208          * The generic class init trampoline is called directly by JITted code, there is no
 209          * specific trampoline.
 210          */
 211         if (tramp_type != MONO_TRAMPOLINE_GENERIC_CLASS_INIT) {
 212                 /* Pop the return address off the stack */
 213                 amd64_pop_reg (code, AMD64_R11);
 214         }
 215
 216         /*
 217          * Allocate a new stack frame
 218          */
 219         amd64_push_reg (code, AMD64_RBP);
 220         amd64_mov_reg_reg (code, AMD64_RBP, AMD64_RSP, 8);
 221         amd64_alu_reg_imm (code, X86_SUB, AMD64_RSP, framesize);
 222
 223         offset += 8;
 224         tramp_offset = - offset;
 225
 226         offset += 8;
 227         arg_offset = - offset;
 228
 229         if (tramp_type != MONO_TRAMPOLINE_GENERIC_CLASS_INIT) {
 230                 /* Compute the trampoline address from the return address */
 231                 /* 5 = length of amd64_call_membase () */
 232                 amd64_alu_reg_imm (code, X86_SUB, AMD64_R11, 5);
 233                 amd64_mov_membase_reg (code, AMD64_RBP, tramp_offset, AMD64_R11, 8);
 234         } else {
 235                 amd64_mov_membase_imm (code, AMD64_RBP, tramp_offset, 0, 8);
 236         }
 237
 238         offset += 8;
 239         res_offset = - offset;
 240
 241         /* Save all registers */
 242
 243         offset += AMD64_NREG * 8;
 244         saved_regs_offset = - offset;
 245         for (i = 0; i < AMD64_NREG; ++i)
 246                 amd64_mov_membase_reg (code, AMD64_RBP, saved_regs_offset + (i * 8), i, 8);
 247         offset += 8 * 8;
 248         saved_fpregs_offset = - offset;
 249         for (i = 0; i < 8; ++i)
 250                 amd64_movsd_membase_reg (code, AMD64_RBP, saved_fpregs_offset + (i * 8), i);
 251
 252         if (tramp_type != MONO_TRAMPOLINE_GENERIC_CLASS_INIT) {
 253                 /* Obtain the trampoline argument which is encoded in the instruction stream */
 254                 amd64_mov_reg_membase (code, AMD64_R11, AMD64_RBP, tramp_offset, 8);
 255                 amd64_mov_reg_membase (code, AMD64_RAX, AMD64_R11, 5, 1);
 256                 amd64_widen_reg (code, AMD64_RAX, AMD64_RAX, TRUE, FALSE);
 257                 amd64_alu_reg_imm_size (code, X86_CMP, AMD64_RAX, 4, 1);
 258                 br [0] = code;
 259                 x86_branch8 (code, X86_CC_NE, 6, FALSE);
 260                 /* 32 bit immediate */
 261                 amd64_mov_reg_membase (code, AMD64_R11, AMD64_R11, 6, 4);
 262                 br [1] = code;
 263                 x86_jump8 (code, 10);
 264                 /* 64 bit immediate */
 265                 mono_amd64_patch (br [0], code);
 266                 amd64_mov_reg_membase (code, AMD64_R11, AMD64_R11, 6, 8);
 267                 mono_amd64_patch (br [1], code);
 268                 amd64_mov_membase_reg (code, AMD64_RBP, arg_offset, AMD64_R11, 8);
 269         } else {
 270                 amd64_mov_membase_reg (code, AMD64_RBP, arg_offset, MONO_ARCH_VTABLE_REG, 8);
 271         }
 272
 273         /* Save LMF begin */
 274
 275         offset += sizeof (MonoLMF);
 276         lmf_offset = - offset;
 277
 278         /* Save ip */
 279         if (has_caller)
 280                 amd64_mov_reg_membase (code, AMD64_R11, AMD64_RBP, 8, 8);
 281         else
 282                 amd64_mov_reg_imm (code, AMD64_R11, 0);
 283         amd64_mov_membase_reg (code, AMD64_RBP, lmf_offset + G_STRUCT_OFFSET (MonoLMF, rip), AMD64_R11, 8);
 284         /* Save fp */
 285         amd64_mov_reg_membase (code, AMD64_R11, AMD64_RSP, framesize, 8);
 286         amd64_mov_membase_reg (code, AMD64_RBP, lmf_offset + G_STRUCT_OFFSET (MonoLMF, rbp), AMD64_R11, 8);
 287         /* Save sp */
 288         amd64_mov_reg_reg (code, AMD64_R11, AMD64_RSP, 8);
 289         amd64_alu_reg_imm (code, X86_ADD, AMD64_R11, framesize + 16);
 290         amd64_mov_membase_reg (code, AMD64_RBP, lmf_offset + G_STRUCT_OFFSET (MonoLMF, rsp), AMD64_R11, 8);
 291         /* Save method */
 292         if (tramp_type == MONO_TRAMPOLINE_GENERIC || tramp_type == MONO_TRAMPOLINE_JUMP) {
 293                 amd64_mov_reg_membase (code, AMD64_R11, AMD64_RBP, arg_offset, 8);
 294                 amd64_mov_membase_reg (code, AMD64_RBP, lmf_offset + G_STRUCT_OFFSET (MonoLMF, method), AMD64_R11, 8);
 295         } else {
 296                 amd64_mov_membase_imm (code, AMD64_RBP, lmf_offset + G_STRUCT_OFFSET (MonoLMF, method), 0, 8);
 297         }
 298         /* Save callee saved regs */
 299 #ifdef PLATFORM_WIN32
 300         amd64_mov_membase_reg (code, AMD64_RBP, lmf_offset + G_STRUCT_OFFSET (MonoLMF, rdi), AMD64_RDI, 8);
 301         amd64_mov_membase_reg (code, AMD64_RBP, lmf_offset + G_STRUCT_OFFSET (MonoLMF, rsi), AMD64_RSI, 8);
 302 #endif
 303         amd64_mov_membase_reg (code, AMD64_RBP, lmf_offset + G_STRUCT_OFFSET (MonoLMF, rbx), AMD64_RBX, 8);
 304         amd64_mov_membase_reg (code, AMD64_RBP, lmf_offset + G_STRUCT_OFFSET (MonoLMF, r12), AMD64_R12, 8);
 305         amd64_mov_membase_reg (code, AMD64_RBP, lmf_offset + G_STRUCT_OFFSET (MonoLMF, r13), AMD64_R13, 8);
 306         amd64_mov_membase_reg (code, AMD64_RBP, lmf_offset + G_STRUCT_OFFSET (MonoLMF, r14), AMD64_R14, 8);
 307         amd64_mov_membase_reg (code, AMD64_RBP, lmf_offset + G_STRUCT_OFFSET (MonoLMF, r15), AMD64_R15, 8);
 308
 309         amd64_mov_reg_imm (code, AMD64_R11, mono_get_lmf_addr);
 310         amd64_call_reg (code, AMD64_R11);
 311
 312         /* Save lmf_addr */
 313         amd64_mov_membase_reg (code, AMD64_RBP, lmf_offset + G_STRUCT_OFFSET (MonoLMF, lmf_addr), AMD64_RAX, 8);
 314         /* Save previous_lmf */
 315         /* Set the lowest bit to 1 to signal that this LMF has the ip field set */
 316         amd64_mov_reg_membase (code, AMD64_R11, AMD64_RAX, 0, 8);
 317         amd64_alu_reg_imm_size (code, X86_ADD, AMD64_R11, 1, 8);
 318         amd64_mov_membase_reg (code, AMD64_RBP, lmf_offset + G_STRUCT_OFFSET (MonoLMF, previous_lmf), AMD64_R11, 8);
 319         /* Set new lmf */
 320         amd64_lea_membase (code, AMD64_R11, AMD64_RBP, lmf_offset);
 321         amd64_mov_membase_reg (code, AMD64_RAX, 0, AMD64_R11, 8);
 322
 323         /* Save LMF end */
 324
 325         /* Arg1 is the pointer to the saved registers */
 326         amd64_lea_membase (code, AMD64_ARG_REG1, AMD64_RBP, saved_regs_offset);
 327
 328         /* Arg2 is the address of the calling code */
 329         if (has_caller)
 330                 amd64_mov_reg_membase (code, AMD64_ARG_REG2, AMD64_RBP, 8, 8);
 331         else
 332                 amd64_mov_reg_imm (code, AMD64_ARG_REG2, 0);
 333
 334         /* Arg3 is the method/vtable ptr */
 335         amd64_mov_reg_membase (code, AMD64_ARG_REG3, AMD64_RBP, arg_offset, 8);
 336
 337         /* Arg4 is the trampoline address */
 338         amd64_mov_reg_membase (code, AMD64_ARG_REG4, AMD64_RBP, tramp_offset, 8);
 339
 340         tramp = (guint8*)mono_get_trampoline_func (tramp_type);
 341         amd64_mov_reg_imm (code, AMD64_RAX, tramp);
 342         amd64_call_reg (code, AMD64_RAX);
 343
 344         /* Check for thread interruption */
 345         /* This is not perf critical code so no need to check the interrupt flag */
 346         amd64_mov_membase_reg (code, AMD64_RBP, res_offset, AMD64_RAX, 8);
 347         amd64_mov_reg_imm (code, AMD64_RAX, (guint8*)mono_thread_interruption_checkpoint);
 348         amd64_call_reg (code, AMD64_RAX);
 349         amd64_mov_reg_membase (code, AMD64_RAX, AMD64_RBP, res_offset, 8);
 350
 351         /* Restore LMF */
 352
 353         amd64_mov_reg_membase (code, AMD64_RCX, AMD64_RBP, lmf_offset + G_STRUCT_OFFSET (MonoLMF, previous_lmf), 8);
 354         amd64_alu_reg_imm_size (code, X86_SUB, AMD64_RCX, 1, 8);
 355         amd64_mov_reg_membase (code, AMD64_R11, AMD64_RBP, lmf_offset + G_STRUCT_OFFSET (MonoLMF, lmf_addr), 8);
 356         amd64_mov_membase_reg (code, AMD64_R11, 0, AMD64_RCX, 8);
 357
 358         /* Restore argument registers */
 359         for (i = 0; i < AMD64_NREG; ++i)
 360                 if (AMD64_IS_ARGUMENT_REG (i))
 361                         amd64_mov_reg_membase (code, i, AMD64_RBP, saved_regs_offset + (i * 8), 8);
 362
 363         for (i = 0; i < 8; ++i)
 364                 amd64_movsd_reg_membase (code, i, AMD64_RBP, saved_fpregs_offset + (i * 8));
 365
 366         /* Restore stack */
 367         amd64_leave (code);
 368
 369         if (tramp_type == MONO_TRAMPOLINE_CLASS_INIT || tramp_type == MONO_TRAMPOLINE_GENERIC_CLASS_INIT)
 370                 amd64_ret (code);
 371         else
 372                 /* call the compiled method */
 373                 amd64_jump_reg (code, X86_EAX);
 374
 375         g_assert ((code - buf) <= 512);
 376
 377         mono_arch_flush_icache (buf, code - buf);
 378
 379         if (tramp_type == MONO_TRAMPOLINE_CLASS_INIT) {
 380                 /* Initialize the nullified class init trampoline used in the AOT case */
 381                 nullified_class_init_trampoline = code = mono_global_codeman_reserve (16);
 382                 x86_ret (code);
 383         }
 384
 385         return buf;
 386 }
 387
 388 gpointer
 389 mono_arch_create_specific_trampoline (gpointer arg1, MonoTrampolineType tramp_type, MonoDomain *domain, guint32 *code_len)
 390 {
 391         guint8 *code, *buf, *tramp;
 392         int size;
 393
 394         tramp = mono_get_trampoline_code (tramp_type);
 395
 396         if ((((guint64)arg1) >> 32) == 0)
 397                 size = 5 + 1 + 4;
 398         else
 399                 size = 5 + 1 + 8;
 400
 401         mono_domain_lock (domain);
 402         code = buf = mono_code_manager_reserve_align (domain->code_mp, size, 1);
 403         mono_domain_unlock (domain);
 404
 405         amd64_call_code (code, tramp);
 406         /* The trampoline code will obtain the argument from the instruction stream */
 407         if ((((guint64)arg1) >> 32) == 0) {
 408                 *code = 0x4;
 409                 *(guint32*)(code + 1) = (gint64)arg1;
 410                 code += 5;
 411         } else {
 412                 *code = 0x8;
 413                 *(guint64*)(code + 1) = (gint64)arg1;
 414                 code += 9;
 415         }
 416
 417         g_assert ((code - buf) <= size);
 418
 419         if (code_len)
 420                 *code_len = size;
 421
 422         mono_arch_flush_icache (buf, size);
 423
 424         return buf;
 425 }
 426
 427 void
 428 mono_arch_invalidate_method (MonoJitInfo *ji, void *func, gpointer func_arg)
 429 {
 430         /* FIXME: This is not thread safe */
 431         guint8 *code = ji->code_start;
 432
 433         amd64_mov_reg_imm (code, AMD64_ARG_REG1, func_arg);
 434         amd64_mov_reg_imm (code, AMD64_R11, func);
 435
 436         x86_push_imm (code, (guint64)func_arg);
 437         amd64_call_reg (code, AMD64_R11);
 438 }
 439
 440 /*
 441  * This method is only called when running in the Mono Debugger.
 442  */
 443 gpointer
 444 mono_debugger_create_notification_function (void)
 445 {
 446         guint8 *buf, *code;
 447
 448         code = buf = mono_global_codeman_reserve (2);
 449         x86_breakpoint (buf);
 450         x86_ret (buf);
 451         return code;
 452 }