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