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