mono/mini/tramp-x86.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/metadata-internals.h>
  15 #include <mono/metadata/marshal.h>
  16 #include <mono/metadata/tabledefs.h>
  17 #include <mono/metadata/mono-debug.h>
  18 #include <mono/metadata/mono-debug-debugger.h>
  19 #include <mono/arch/x86/x86-codegen.h>
  20
  21 #ifdef HAVE_VALGRIND_MEMCHECK_H
  22 #include <valgrind/memcheck.h>
  23 #endif
  24
  25 #include "mini.h"
  26 #include "mini-x86.h"
  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_pos = 4;
  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_pos = 8;
  48
  49         mono_domain_lock (domain);
  50         start = code = mono_code_manager_reserve (domain->code_mp, 16);
  51         mono_domain_unlock (domain);
  52
  53         x86_alu_membase_imm (code, X86_ADD, X86_ESP, this_pos, sizeof (MonoObject));
  54         x86_jump_code (code, addr);
  55         g_assert ((code - start) < 16);
  56
  57         return start;
  58 }
  59
  60 void
  61 mono_arch_patch_callsite (guint8 *code, guint8 *addr)
  62 {
  63         /* go to the start of the call instruction
  64          *
  65          * address_byte = (m << 6) | (o << 3) | reg
  66          * call opcode: 0xff address_byte displacement
  67          * 0xff m=1,o=2 imm8
  68          * 0xff m=2,o=2 imm32
  69          */
  70         code -= 6;
  71         if ((code [1] == 0xe8)) {
  72                 if (!mono_running_on_valgrind ()) {
  73                         InterlockedExchange ((gint32*)(code + 2), (guint)addr - ((guint)code + 1) - 5);
  74
  75 #ifdef HAVE_VALGRIND_MEMCHECK_H
  76                                 /* Tell valgrind to recompile the patched code */
  77                                 //VALGRIND_DISCARD_TRANSLATIONS (code + 2, code + 6);
  78 #endif
  79                 }
  80         } else if (code [1] == 0xe9) {
  81                 /* A PLT entry: jmp <DISP> */
  82                 if (!mono_running_on_valgrind ())
  83                         InterlockedExchange ((gint32*)(code + 2), (guint)addr - ((guint)code + 1) - 5);
  84         } else {
  85                 printf ("Invalid trampoline sequence: %x %x %x %x %x %x %x\n", code [0], code [1], code [2], code [3],
  86                                 code [4], code [5], code [6]);
  87                 g_assert_not_reached ();
  88         }
  89 }
  90
  91 void
  92 mono_arch_patch_plt_entry (guint8 *code, guint8 *addr)
  93 {
  94         /* A PLT entry: jmp <DISP> */
  95         g_assert (code [0] == 0xe9);
  96
  97         if (!mono_running_on_valgrind ())
  98                 InterlockedExchange ((gint32*)(code + 1), (guint)addr - (guint)code - 5);
  99 }
 100
 101 void
 102 mono_arch_nullify_class_init_trampoline (guint8 *code, gssize *regs)
 103 {
 104         code -= 5;
 105         if (code [0] == 0xe8) {
 106                 if (!mono_running_on_valgrind ()) {
 107                         guint32 ops;
 108                         /*
 109                          * Thread safe code patching using the algorithm from the paper
 110                          * 'Practicing JUDO: Java Under Dynamic Optimizations'
 111                          */
 112                         /*
 113                          * First atomically change the the first 2 bytes of the call to a
 114                          * spinning jump.
 115                          */
 116                         ops = 0xfeeb;
 117                         InterlockedExchange ((gint32*)code, ops);
 118
 119                         /* Then change the other bytes to a nop */
 120                         code [2] = 0x90;
 121                         code [3] = 0x90;
 122                         code [4] = 0x90;
 123
 124                         /* Then atomically change the first 4 bytes to a nop as well */
 125                         ops = 0x90909090;
 126                         InterlockedExchange ((gint32*)code, ops);
 127 #ifdef HAVE_VALGRIND_MEMCHECK_H
 128                         /* FIXME: the calltree skin trips on the self modifying code above */
 129
 130                         /* Tell valgrind to recompile the patched code */
 131                         //VALGRIND_DISCARD_TRANSLATIONS (code, code + 8);
 132 #endif
 133                 }
 134         } else if (code [0] == 0x90 || code [0] == 0xeb) {
 135                 /* Already changed by another thread */
 136                 ;
 137         } else if ((code [-1] == 0xff) && (x86_modrm_reg (code [0]) == 0x2)) {
 138                 /* call *<OFFSET>(<REG>) -> Call made from AOT code */
 139                 gpointer *vtable_slot;
 140
 141                 vtable_slot = mono_arch_get_vcall_slot_addr (code + 5, (gpointer*)regs);
 142                 g_assert (vtable_slot);
 143
 144                 *vtable_slot = nullified_class_init_trampoline;
 145         } else {
 146                         printf ("Invalid trampoline sequence: %x %x %x %x %x %x %x\n", code [0], code [1], code [2], code [3],
 147                                 code [4], code [5], code [6]);
 148                         g_assert_not_reached ();
 149                 }
 150 }
 151
 152 void
 153 mono_arch_nullify_plt_entry (guint8 *code)
 154 {
 155         if (!mono_running_on_valgrind ()) {
 156                 guint32 ops;
 157
 158                 ops = 0xfeeb;
 159                 InterlockedExchange ((gint32*)code, ops);
 160
 161                 /* Then change the other bytes to a nop */
 162                 code [2] = 0x90;
 163                 code [3] = 0x90;
 164                 code [4] = 0x90;
 165
 166                 /* Change the first byte to a nop */
 167                 ops = 0xc3;
 168                 InterlockedExchange ((gint32*)code, ops);
 169         }
 170 }
 171
 172 void
 173 mono_arch_patch_delegate_trampoline (guint8 *code, guint8 *tramp, gssize *regs, guint8 *addr)
 174 {
 175         guint32 reg;
 176         guint32 disp;
 177
 178         if ((code [-3] == 0xff) && (x86_modrm_reg (code [-2]) == 0x2) && (x86_modrm_mod (code [-2]) == 0x1)) {
 179                 /* call *[reg+disp8] */
 180                 reg = x86_modrm_rm (code [-2]);
 181                 disp = *(guint8*)(code - 1);
 182                 //printf ("B: [%%r%d+0x%x]\n", reg, disp);
 183         }
 184         else {
 185                 int i;
 186
 187                 for (i = -16; i < 0; ++i)
 188                         printf ("%d ", code [i]);
 189                 printf ("\n");
 190                 g_assert_not_reached ();
 191         }
 192
 193         *(gpointer*)(((guint32)(regs [reg])) + disp) = addr;
 194 }
 195
 196 guchar*
 197 mono_arch_create_trampoline_code (MonoTrampolineType tramp_type)
 198 {
 199         guint8 *buf, *code;
 200         int pushed_args;
 201
 202         code = buf = mono_global_codeman_reserve (256);
 203
 204         /* Note that there is a single argument to the trampoline
 205          * and it is stored at: esp + pushed_args * sizeof (gpointer)
 206          * the ret address is at: esp + (pushed_args + 1) * sizeof (gpointer)
 207          */
 208         /* Put all registers into an array on the stack */
 209         x86_push_reg (buf, X86_EDI);
 210         x86_push_reg (buf, X86_ESI);
 211         x86_push_reg (buf, X86_EBP);
 212         x86_push_reg (buf, X86_ESP);
 213         x86_push_reg (buf, X86_EBX);
 214         x86_push_reg (buf, X86_EDX);
 215         x86_push_reg (buf, X86_ECX);
 216         x86_push_reg (buf, X86_EAX);
 217
 218         pushed_args = 8;
 219
 220         /* save LMF begin */
 221
 222         /* save the IP (caller ip) */
 223         if (tramp_type == MONO_TRAMPOLINE_JUMP)
 224                 x86_push_imm (buf, 0);
 225         else
 226                 x86_push_membase (buf, X86_ESP, (pushed_args + 1) * sizeof (gpointer));
 227
 228         pushed_args++;
 229
 230         x86_push_reg (buf, X86_EBP);
 231         x86_push_reg (buf, X86_ESI);
 232         x86_push_reg (buf, X86_EDI);
 233         x86_push_reg (buf, X86_EBX);
 234
 235         pushed_args += 4;
 236
 237         /* save method info */
 238         x86_push_membase (buf, X86_ESP, pushed_args * sizeof (gpointer));
 239
 240         pushed_args++;
 241
 242         /* the stack is correctly aligned to 16 bytes because pushed_args is 14
 243          * and there is the extra trampoline arg + the return ip pushed by call
 244          * FIXME: Note that if an exception happens while some args are pushed
 245          * on the stack, the stack will be misaligned.
 246          */
 247 #ifdef __APPLE__
 248         g_assert (pushed_args == 14);
 249 #endif
 250         /* get the address of lmf for the current thread */
 251         x86_call_code (buf, mono_get_lmf_addr);
 252         /* push lmf */
 253         x86_push_reg (buf, X86_EAX);
 254         /* push *lfm (previous_lmf) */
 255         x86_push_membase (buf, X86_EAX, 0);
 256         /* *(lmf) = ESP */
 257         x86_mov_membase_reg (buf, X86_EAX, 0, X86_ESP, 4);
 258         /* save LFM end */
 259
 260         pushed_args += 2;
 261
 262         /* starting the call sequence */
 263 #ifdef __APPLE__
 264         /* changing esp to keep the stack aligned */
 265         x86_alu_reg_imm (buf, X86_SUB, X86_ESP, 8);
 266         pushed_args += 2;
 267 #endif
 268
 269         /* FIXME: Push the trampoline address */
 270         x86_push_imm (buf, 0);
 271
 272         pushed_args++;
 273
 274         /* push the method info */
 275         x86_push_membase (buf, X86_ESP, pushed_args * sizeof (gpointer));
 276
 277         pushed_args++;
 278
 279         /* push the return address onto the stack */
 280         if (tramp_type == MONO_TRAMPOLINE_JUMP)
 281                 x86_push_imm (buf, 0);
 282         else
 283                 x86_push_membase (buf, X86_ESP, (pushed_args + 1) * sizeof (gpointer));
 284         pushed_args++;
 285         /* push the address of the register array */
 286         x86_lea_membase (buf, X86_EAX, X86_ESP, (pushed_args - 8) * sizeof (gpointer));
 287         x86_push_reg (buf, X86_EAX);
 288
 289         pushed_args++;
 290
 291 #ifdef __APPLE__
 292         /* check the stack is aligned after the ret ip is pushed */
 293         /*x86_mov_reg_reg (buf, X86_EDX, X86_ESP, 4);
 294         x86_alu_reg_imm (buf, X86_AND, X86_EDX, 15);
 295         x86_alu_reg_imm (buf, X86_CMP, X86_EDX, 0);
 296         x86_branch_disp (buf, X86_CC_Z, 3, FALSE);
 297         x86_breakpoint (buf);*/
 298 #endif
 299
 300         if (tramp_type == MONO_TRAMPOLINE_CLASS_INIT)
 301                 x86_call_code (buf, mono_class_init_trampoline);
 302         else if (tramp_type == MONO_TRAMPOLINE_AOT)
 303                 x86_call_code (buf, mono_aot_trampoline);
 304         else if (tramp_type == MONO_TRAMPOLINE_AOT_PLT)
 305                 x86_call_code (buf, mono_aot_plt_trampoline);
 306         else if (tramp_type == MONO_TRAMPOLINE_DELEGATE)
 307                 x86_call_code (buf, mono_delegate_trampoline);
 308         else
 309                 x86_call_code (buf, mono_magic_trampoline);
 310
 311 #ifdef __APPLE__
 312         /* account for the alignment above */
 313         x86_alu_reg_imm (buf, X86_ADD, X86_ESP, 6*4);
 314 #else
 315         x86_alu_reg_imm (buf, X86_ADD, X86_ESP, 4*4);
 316 #endif
 317
 318         /* restore LMF start */
 319         /* ebx = previous_lmf */
 320         x86_pop_reg (buf, X86_EBX);
 321         /* edi = lmf */
 322         x86_pop_reg (buf, X86_EDI);
 323         /* *(lmf) = previous_lmf */
 324         x86_mov_membase_reg (buf, X86_EDI, 0, X86_EBX, 4);
 325         /* discard method info */
 326         x86_pop_reg (buf, X86_ESI);
 327         /* restore caller saved regs */
 328         x86_pop_reg (buf, X86_EBX);
 329         x86_pop_reg (buf, X86_EDI);
 330         x86_pop_reg (buf, X86_ESI);
 331         x86_pop_reg (buf, X86_EBP);
 332
 333         /* discard save IP */
 334         x86_alu_reg_imm (buf, X86_ADD, X86_ESP, 4);
 335         /* restore LMF end */
 336
 337         /* Restore caller saved registers */
 338         x86_mov_reg_membase (buf, X86_ECX, X86_ESP, 1 * 4, 4);
 339         x86_mov_reg_membase (buf, X86_EDX, X86_ESP, 2 * 4, 4);
 340
 341         /* Pop saved reg array + method ptr */
 342         x86_alu_reg_imm (buf, X86_ADD, X86_ESP, 9 * 4);
 343
 344         if (tramp_type == MONO_TRAMPOLINE_CLASS_INIT)
 345                 x86_ret (buf);
 346         else
 347                 /* call the compiled method */
 348                 x86_jump_reg (buf, X86_EAX);
 349
 350         g_assert ((buf - code) <= 256);
 351
 352         if (tramp_type == MONO_TRAMPOLINE_CLASS_INIT) {
 353                 /* Initialize the nullified class init trampoline used in the AOT case */
 354                 nullified_class_init_trampoline = buf = mono_global_codeman_reserve (16);
 355                 x86_ret (buf);
 356         }
 357
 358         return code;
 359 }
 360
 361 #define TRAMPOLINE_SIZE 10
 362
 363 gpointer
 364 mono_arch_create_specific_trampoline (gpointer arg1, MonoTrampolineType tramp_type, MonoDomain *domain, guint32 *code_len)
 365 {
 366         guint8 *code, *buf, *tramp;
 367
 368         tramp = mono_get_trampoline_code (tramp_type);
 369
 370         mono_domain_lock (domain);
 371         code = buf = mono_code_manager_reserve (domain->code_mp, TRAMPOLINE_SIZE);
 372         mono_domain_unlock (domain);
 373
 374         x86_push_imm (buf, arg1);
 375         x86_jump_code (buf, tramp);
 376         g_assert ((buf - code) <= TRAMPOLINE_SIZE);
 377
 378         mono_arch_flush_icache (code, buf - code);
 379
 380         if (code_len)
 381                 *code_len = buf - code;
 382
 383         return code;
 384 }
 385
 386 void
 387 mono_arch_invalidate_method (MonoJitInfo *ji, void *func, gpointer func_arg)
 388 {
 389         /* FIXME: This is not thread safe */
 390         guint8 *code = ji->code_start;
 391
 392         x86_push_imm (code, func_arg);
 393         x86_call_code (code, (guint8*)func);
 394 }
 395
 396 /*
 397  * This method is only called when running in the Mono Debugger.
 398  */
 399 guint8 *
 400 mono_debugger_create_notification_function (MonoCodeManager *codeman)
 401 {
 402         guint8 *buf, *code;
 403
 404         code = buf = mono_code_manager_reserve (codeman, 2);
 405         x86_breakpoint (buf);
 406         x86_ret (buf);
 407         return code;
 408 }