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_RDI;
  44         MonoDomain *domain = mono_domain_get ();
  45
  46         if (!mono_method_signature (m)->ret->byref && MONO_TYPE_ISSTRUCT (mono_method_signature (m)->ret))
  47                 this_reg = AMD64_RSI;
  48
  49         mono_domain_lock (domain);
  50         start = code = mono_code_manager_reserve (domain->code_mp, 20);
  51         mono_domain_unlock (domain);
  52
  53         amd64_alu_reg_imm (code, X86_ADD, this_reg, sizeof (MonoObject));
  54         /* FIXME: Optimize this */
  55         amd64_mov_reg_imm (code, AMD64_RAX, addr);
  56         amd64_jump_reg (code, AMD64_RAX);
  57         g_assert ((code - start) < 20);
  58
  59         mono_arch_flush_icache (start, code - start);
  60
  61         return start;
  62 }
  63
  64 void
  65 mono_arch_patch_callsite (guint8 *code, guint8 *addr)
  66 {
  67         if (((code [-13] == 0x49) && (code [-12] == 0xbb)) || (code [-5] == 0xe8)) {
  68                 if (code [-5] != 0xe8)
  69                         InterlockedExchangePointer ((gpointer*)(code - 11), addr);
  70                 else {
  71                         g_assert ((((guint64)(addr)) >> 32) == 0);
  72                         g_assert ((((guint64)(code)) >> 32) == 0);
  73                         InterlockedExchange ((guint32*)(code - 4), ((gint64)addr - (gint64)code));
  74                 }
  75         }
  76         else if ((code [-7] == 0x41) && (code [-6] == 0xff) && (code [-5] == 0x15)) {
  77                 /* call *<OFFSET>(%rip) */
  78                 gpointer *got_entry = (gpointer*)((guint8*)code + (*(guint32*)(code - 4)));
  79                 InterlockedExchangePointer (got_entry, addr);
  80         }
  81 }
  82
  83 void
  84 mono_arch_nullify_class_init_trampoline (guint8 *code, gssize *regs)
  85 {
  86         code -= 3;
  87
  88         /*
  89          * A given byte sequence can match more than case here, so we have to be
  90          * really careful about the ordering of the cases. Longer sequences
  91          * come first.
  92          */
  93         if ((code [-4] == 0x41) && (code [-3] == 0xff) && (code [-2] == 0x15)) {
  94                 gpointer *vtable_slot;
  95
  96                 /* call *<OFFSET>(%rip) */
  97                 vtable_slot = mono_arch_get_vcall_slot_addr (code + 3, (gpointer*)regs);
  98                 g_assert (vtable_slot);
  99
 100                 *vtable_slot = nullified_class_init_trampoline;
 101         } else if (code [-2] == 0xe8) {
 102                 /* call <TARGET> */
 103                 guint8 *buf = code - 2;
 104
 105                 buf [0] = 0x66;
 106                 buf [1] = 0x66;
 107                 buf [2] = 0x90;
 108                 buf [3] = 0x66;
 109                 buf [4] = 0x90;
 110         } else if ((code [0] == 0x49) && (code [1] == 0xff)) {
 111                 /* call <REG> */
 112                 /* amd64_set_reg_template is 10 bytes long */
 113                 guint8* buf = code - 10;
 114
 115                 /* FIXME: Make this thread safe */
 116                 /* Padding code suggested by the AMD64 Opt Manual */
 117                 buf [0] = 0x66;
 118                 buf [1] = 0x66;
 119                 buf [2] = 0x66;
 120                 buf [3] = 0x90;
 121                 buf [4] = 0x66;
 122                 buf [5] = 0x66;
 123                 buf [6] = 0x66;
 124                 buf [7] = 0x90;
 125                 buf [8] = 0x66;
 126                 buf [9] = 0x66;
 127                 buf [10] = 0x90;
 128                 buf [11] = 0x66;
 129                 buf [12] = 0x90;
 130         } else if (code [0] == 0x90 || code [0] == 0xeb || code [0] == 0x66) {
 131                 /* Already changed by another thread */
 132                 ;
 133         } else {
 134                 printf ("Invalid trampoline sequence: %x %x %x %x %x %x %x\n", code [0], code [1], code [2], code [3],
 135                                 code [4], code [5], code [6]);
 136                 g_assert_not_reached ();
 137         }
 138 }
 139
 140 void
 141 mono_arch_patch_delegate_trampoline (guint8 *code, guint8 *tramp, gssize *regs, guint8 *addr)
 142 {
 143         guint8 rex = 0;
 144         guint32 reg;
 145         guint32 disp;
 146
 147         if ((code [-3] == 0xff) && (amd64_modrm_reg (code [-2]) == 0x2) && (amd64_modrm_mod (code [-2]) == 0x1)) {
 148                 /* call *[reg+disp8] */
 149                 if (IS_REX (code [-4]))
 150                         rex = code [-4];
 151                 reg = amd64_modrm_rm (code [-2]);
 152                 disp = *(guint8*)(code - 1);
 153                 //printf ("B: [%%r%d+0x%x]\n", reg, disp);
 154         }
 155         else {
 156                 int i;
 157
 158                 for (i = -16; i < 0; ++i)
 159                         printf ("%d ", code [i]);
 160                 printf ("\n");
 161                 g_assert_not_reached ();
 162         }
 163
 164         reg += amd64_rex_b (rex);
 165
 166         /* R11 is clobbered by the trampoline code */
 167         g_assert (reg != AMD64_R11);
 168
 169         *(gpointer*)(((guint64)(regs [reg])) + disp) = addr;
 170 }
 171
 172 guchar*
 173 mono_arch_create_trampoline_code (MonoTrampolineType tramp_type)
 174 {
 175         guint8 *buf, *code, *tramp;
 176         int i, lmf_offset, offset, method_offset, tramp_offset, saved_regs_offset, saved_fpregs_offset, framesize;
 177         gboolean has_caller;
 178
 179         if (tramp_type == MONO_TRAMPOLINE_JUMP)
 180                 has_caller = FALSE;
 181         else
 182                 has_caller = TRUE;
 183
 184         code = buf = mono_global_codeman_reserve (512);
 185
 186         framesize = 512 + sizeof (MonoLMF);
 187         framesize = (framesize + (MONO_ARCH_FRAME_ALIGNMENT - 1)) & ~ (MONO_ARCH_FRAME_ALIGNMENT - 1);
 188
 189         offset = 0;
 190
 191         /*
 192          * Allocate a new stack frame and transfer the two arguments received on
 193          * the stack to our frame.
 194          */
 195         amd64_alu_reg_imm (code, X86_ADD, AMD64_RSP, 8);
 196         amd64_pop_reg (code, AMD64_R11);
 197
 198         amd64_push_reg (code, AMD64_RBP);
 199         amd64_mov_reg_reg (code, AMD64_RBP, AMD64_RSP, 8);
 200         amd64_alu_reg_imm (code, X86_SUB, AMD64_RSP, framesize);
 201
 202         /*
 203          * The method is at offset -8 from the new RBP, so no need to
 204          * copy it.
 205          */
 206         offset += 8;
 207         method_offset = - offset;
 208
 209         offset += 8;
 210         tramp_offset = - offset;
 211         amd64_mov_membase_reg (code, AMD64_RBP, tramp_offset, AMD64_R11, 8);
 212
 213         /* Save all registers */
 214
 215         offset += AMD64_NREG * 8;
 216         saved_regs_offset = - offset;
 217         for (i = 0; i < AMD64_NREG; ++i)
 218                 amd64_mov_membase_reg (code, AMD64_RBP, saved_regs_offset + (i * 8), i, 8);
 219         offset += 8 * 8;
 220         saved_fpregs_offset = - offset;
 221         for (i = 0; i < 8; ++i)
 222                 amd64_movsd_membase_reg (code, AMD64_RBP, saved_fpregs_offset + (i * 8), i);
 223
 224         /* Save LMF begin */
 225
 226         offset += sizeof (MonoLMF);
 227         lmf_offset = - offset;
 228
 229         /* Save ip */
 230         if (has_caller)
 231                 amd64_mov_reg_membase (code, AMD64_R11, AMD64_RBP, 8, 8);
 232         else
 233                 amd64_mov_reg_imm (code, AMD64_R11, 0);
 234         amd64_mov_membase_reg (code, AMD64_RBP, lmf_offset + G_STRUCT_OFFSET (MonoLMF, rip), AMD64_R11, 8);
 235         /* Save fp */
 236         amd64_mov_reg_membase (code, AMD64_R11, AMD64_RSP, framesize, 8);
 237         amd64_mov_membase_reg (code, AMD64_RBP, lmf_offset + G_STRUCT_OFFSET (MonoLMF, ebp), AMD64_R11, 8);
 238         /* Save sp */
 239         amd64_mov_reg_reg (code, AMD64_R11, AMD64_RSP, 8);
 240         amd64_alu_reg_imm (code, X86_ADD, AMD64_R11, framesize + 16);
 241         amd64_mov_membase_reg (code, AMD64_RBP, lmf_offset + G_STRUCT_OFFSET (MonoLMF, rsp), AMD64_R11, 8);
 242         /* Save method */
 243         amd64_mov_reg_membase (code, AMD64_R11, AMD64_RBP, method_offset, 8);
 244         amd64_mov_membase_reg (code, AMD64_RBP, lmf_offset + G_STRUCT_OFFSET (MonoLMF, method), AMD64_R11, 8);
 245         /* Save callee saved regs */
 246         amd64_mov_membase_reg (code, AMD64_RBP, lmf_offset + G_STRUCT_OFFSET (MonoLMF, rbx), AMD64_RBX, 8);
 247         amd64_mov_membase_reg (code, AMD64_RBP, lmf_offset + G_STRUCT_OFFSET (MonoLMF, r12), AMD64_R12, 8);
 248         amd64_mov_membase_reg (code, AMD64_RBP, lmf_offset + G_STRUCT_OFFSET (MonoLMF, r13), AMD64_R13, 8);
 249         amd64_mov_membase_reg (code, AMD64_RBP, lmf_offset + G_STRUCT_OFFSET (MonoLMF, r14), AMD64_R14, 8);
 250         amd64_mov_membase_reg (code, AMD64_RBP, lmf_offset + G_STRUCT_OFFSET (MonoLMF, r15), AMD64_R15, 8);
 251
 252         amd64_mov_reg_imm (code, AMD64_R11, mono_get_lmf_addr);
 253         amd64_call_reg (code, AMD64_R11);
 254
 255         /* Save lmf_addr */
 256         amd64_mov_membase_reg (code, AMD64_RBP, lmf_offset + G_STRUCT_OFFSET (MonoLMF, lmf_addr), AMD64_RAX, 8);
 257         /* Save previous_lmf */
 258         amd64_mov_reg_membase (code, AMD64_R11, AMD64_RAX, 0, 8);
 259         amd64_mov_membase_reg (code, AMD64_RBP, lmf_offset + G_STRUCT_OFFSET (MonoLMF, previous_lmf), AMD64_R11, 8);
 260         /* Set new lmf */
 261         amd64_lea_membase (code, AMD64_R11, AMD64_RBP, lmf_offset);
 262         amd64_mov_membase_reg (code, AMD64_RAX, 0, AMD64_R11, 8);
 263
 264         /* Save LMF end */
 265
 266         /* Arg1 is the pointer to the saved registers */
 267         amd64_lea_membase (code, AMD64_RDI, AMD64_RBP, saved_regs_offset);
 268
 269         /* Arg2 is the address of the calling code */
 270         if (has_caller)
 271                 amd64_mov_reg_membase (code, AMD64_RSI, AMD64_RBP, 8, 8);
 272         else
 273                 amd64_mov_reg_imm (code, AMD64_RSI, 0);
 274
 275         /* Arg3 is the method/vtable ptr */
 276         amd64_mov_reg_membase (code, AMD64_RDX, AMD64_RBP, method_offset, 8);
 277
 278         /* Arg4 is the trampoline address */
 279         amd64_mov_reg_membase (code, AMD64_RCX, AMD64_RBP, tramp_offset, 8);
 280
 281         if (tramp_type == MONO_TRAMPOLINE_CLASS_INIT)
 282                 tramp = (guint8*)mono_class_init_trampoline;
 283         else if (tramp_type == MONO_TRAMPOLINE_AOT)
 284                 tramp = (guint8*)mono_aot_trampoline;
 285         else if (tramp_type == MONO_TRAMPOLINE_DELEGATE)
 286                 tramp = (guint8*)mono_delegate_trampoline;
 287         else
 288                 tramp = (guint8*)mono_magic_trampoline;
 289
 290         amd64_mov_reg_imm (code, AMD64_RAX, tramp);
 291         amd64_call_reg (code, AMD64_RAX);
 292
 293         /* Restore LMF */
 294
 295         amd64_mov_reg_membase (code, AMD64_RCX, AMD64_RBP, lmf_offset + G_STRUCT_OFFSET (MonoLMF, previous_lmf), 8);
 296         amd64_mov_reg_membase (code, AMD64_R11, AMD64_RBP, lmf_offset + G_STRUCT_OFFSET (MonoLMF, lmf_addr), 8);
 297         amd64_mov_membase_reg (code, AMD64_R11, 0, AMD64_RCX, 8);
 298
 299         /* Restore argument registers */
 300         for (i = 0; i < AMD64_NREG; ++i)
 301                 if (AMD64_IS_ARGUMENT_REG (i))
 302                         amd64_mov_reg_membase (code, i, AMD64_RBP, saved_regs_offset + (i * 8), 8);
 303
 304         for (i = 0; i < 8; ++i)
 305                 amd64_movsd_reg_membase (code, i, AMD64_RBP, saved_fpregs_offset + (i * 8));
 306
 307         /* Restore stack */
 308         amd64_leave (code);
 309
 310         if (tramp_type == MONO_TRAMPOLINE_CLASS_INIT)
 311                 amd64_ret (code);
 312         else
 313                 /* call the compiled method */
 314                 amd64_jump_reg (code, X86_EAX);
 315
 316         g_assert ((code - buf) <= 512);
 317
 318         mono_arch_flush_icache (buf, code - buf);
 319
 320         if (tramp_type == MONO_TRAMPOLINE_CLASS_INIT) {
 321                 /* Initialize the nullified class init trampoline used in the AOT case */
 322                 nullified_class_init_trampoline = code = mono_global_codeman_reserve (16);
 323                 x86_ret (code);
 324         }
 325
 326         return buf;
 327 }
 328
 329 #define TRAMPOLINE_SIZE 34
 330
 331 gpointer
 332 mono_arch_create_specific_trampoline (gpointer arg1, MonoTrampolineType tramp_type, MonoDomain *domain, guint32 *code_len)
 333 {
 334         guint8 *code, *buf, *tramp, *real_code;
 335         int size, jump_offset;
 336
 337         tramp = mono_get_trampoline_code (tramp_type);
 338
 339         code = buf = g_alloca (TRAMPOLINE_SIZE);
 340
 341         /* push trampoline address */
 342         amd64_lea_membase (code, AMD64_R11, AMD64_RIP, -7);
 343         amd64_push_reg (code, AMD64_R11);
 344
 345         /* push argument */
 346         if (amd64_is_imm32 ((gint64)arg1))
 347                 amd64_push_imm (code, (gint64)arg1);
 348         else {
 349                 amd64_mov_reg_imm (code, AMD64_R11, arg1);
 350                 amd64_push_reg (code, AMD64_R11);
 351         }
 352
 353         jump_offset = code - buf;
 354         amd64_jump_disp (code, 0xffffffff);
 355
 356         g_assert ((code - buf) <= TRAMPOLINE_SIZE);
 357
 358         mono_domain_lock (domain);
 359         /*
 360          * FIXME: Changing the size to code - buf causes strange crashes during
 361          * mcs bootstrap.
 362          */
 363         real_code = mono_code_manager_reserve (domain->code_mp, TRAMPOLINE_SIZE);
 364         size = code - buf;
 365         mono_domain_unlock (domain);
 366
 367         memcpy (real_code, buf, size);
 368
 369         /* Fix up jump */
 370         g_assert ((((gint64)tramp) >> 32) == 0);
 371         code = (guint8*)real_code + jump_offset;
 372         amd64_jump_disp (code, tramp - code);
 373
 374         mono_jit_stats.method_trampolines++;
 375
 376         if (code_len)
 377                 *code_len = size;
 378
 379         mono_arch_flush_icache (real_code, size);
 380
 381         return real_code;
 382 }
 383
 384 void
 385 mono_arch_invalidate_method (MonoJitInfo *ji, void *func, gpointer func_arg)
 386 {
 387         /* FIXME: This is not thread safe */
 388         guint8 *code = ji->code_start;
 389
 390         amd64_mov_reg_imm (code, AMD64_RDI, func_arg);
 391         amd64_mov_reg_imm (code, AMD64_R11, func);
 392
 393         x86_push_imm (code, (guint64)func_arg);
 394         amd64_call_reg (code, AMD64_R11);
 395 }
 396
 397 /*
 398  * This method is only called when running in the Mono Debugger.
 399  */
 400 guint8 *
 401 mono_debugger_create_notification_function ()
 402 {
 403         guint8 *buf, *code;
 404
 405         code = buf = mono_global_codeman_reserve (2);
 406         x86_breakpoint (buf);
 407         x86_ret (buf);
 408         return code;
 409 }