mono/mini/tramp-x86.c

   1 /*
   2  * trampoline.c: JIT trampoline code
   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/x86/x86-codegen.h>
  17 #include <mono/metadata/mono-debug-debugger.h>
  18
  19 #ifdef HAVE_VALGRIND_MEMCHECK_H
  20 #include <valgrind/memcheck.h>
  21 #endif
  22
  23 #include "mini.h"
  24 #include "mini-x86.h"
  25
  26 typedef enum {
  27         MONO_TRAMPOLINE_GENERIC,
  28         MONO_TRAMPOLINE_JUMP,
  29         MONO_TRAMPOLINE_CLASS_INIT
  30 } MonoTrampolineType;
  31
  32 /* adapt to mini later... */
  33 #define mono_jit_share_code (1)
  34
  35 /*
  36  * Address of the x86 trampoline code.  This is used by the debugger to check
  37  * whether a method is a trampoline.
  38  */
  39 guint8 *mono_generic_trampoline_code = NULL;
  40
  41 /*
  42  * get_unbox_trampoline:
  43  * @m: method pointer
  44  * @addr: pointer to native code for @m
  45  *
  46  * when value type methods are called through the vtable we need to unbox the
  47  * this argument. This method returns a pointer to a trampoline which does
  48  * unboxing before calling the method
  49  */
  50 static gpointer
  51 get_unbox_trampoline (MonoMethod *m, gpointer addr)
  52 {
  53         guint8 *code, *start;
  54         int this_pos = 4;
  55
  56         if (!m->signature->ret->byref && MONO_TYPE_ISSTRUCT (m->signature->ret))
  57                 this_pos = 8;
  58
  59         start = code = g_malloc (16);
  60
  61         x86_alu_membase_imm (code, X86_ADD, X86_ESP, this_pos, sizeof (MonoObject));
  62         x86_jump_code (code, addr);
  63         g_assert ((code - start) < 16);
  64
  65         return start;
  66 }
  67
  68 /**
  69  * x86_magic_trampoline:
  70  * @eax: saved x86 register
  71  * @ecx: saved x86 register
  72  * @edx: saved x86 register
  73  * @esi: saved x86 register
  74  * @edi: saved x86 register
  75  * @ebx: saved x86 register
  76  * @code: pointer into caller code
  77  * @method: the method to translate
  78  *
  79  * This method is called by the trampoline functions for virtual
  80  * methods. It inspects the caller code to find the address of the
  81  * vtable slot, then calls the JIT compiler and writes the address
  82  * of the compiled method back to the vtable. All virtual methods
  83  * are called with: x86_call_membase (inst, basereg, disp). We always
  84  * use 32 bit displacement to ensure that the length of the call
  85  * instruction is 6 bytes. We need to get the value of the basereg
  86  * and the constant displacement.
  87  */
  88 static gpointer
  89 x86_magic_trampoline (int eax, int ecx, int edx, int esi, int edi,
  90                       int ebx, guint8 *code, MonoMethod *m)
  91 {
  92         guint8 reg;
  93         gint32 disp;
  94         char *o;
  95         gpointer addr;
  96
  97         addr = mono_compile_method (m);
  98         g_assert (addr);
  99
 100         /* the method was jumped to */
 101         if (!code)
 102                 return addr;
 103
 104         /* go to the start of the call instruction
 105          *
 106          * address_byte = (m << 6) | (o << 3) | reg
 107          * call opcode: 0xff address_byte displacement
 108          * 0xff m=1,o=2 imm8
 109          * 0xff m=2,o=2 imm32
 110          */
 111         code -= 6;
 112         if ((code [1] != 0xe8) && (code [3] == 0xff) && ((code [4] & 0x18) == 0x10) && ((code [4] >> 6) == 1)) {
 113                 reg = code [4] & 0x07;
 114                 disp = (signed char)code [5];
 115         } else {
 116                 if ((code [0] == 0xff) && ((code [1] & 0x18) == 0x10) && ((code [1] >> 6) == 2)) {
 117                         reg = code [1] & 0x07;
 118                         disp = *((gint32*)(code + 2));
 119                 } else if ((code [1] == 0xe8)) {
 120                         MonoJitInfo *ji =
 121                                 mono_jit_info_table_find (mono_domain_get (), code);
 122                         MonoJitInfo *target_ji =
 123                                 mono_jit_info_table_find (mono_domain_get (), addr);
 124
 125                         /* m->addr means pinvoke or icall */
 126                         if (m->addr || mono_method_same_domain (ji, target_ji)) {
 127                                 *((guint32*)(code + 2)) = (guint)addr - ((guint)code + 1) - 5;
 128 #ifdef HAVE_VALGRIND_MEMCHECK_H
 129                                 /* Tell valgrind to recompile the patched code */
 130                                 VALGRIND_DISCARD_TRANSLATIONS (code + 2, code + 6);
 131 #endif
 132                         }
 133                         return addr;
 134                 } else if ((code [4] == 0xff) && (((code [5] >> 6) & 0x3) == 0) && (((code [5] >> 3) & 0x7) == 2)) {
 135                         /*
 136                          * This is a interface call: should check the above code can't catch it earlier
 137                          * 8b 40 30   mov    0x30(%eax),%eax
 138                          * ff 10      call   *(%eax)
 139                          */
 140                         disp = 0;
 141                         reg = code [5] & 0x07;
 142                 } else {
 143                         printf ("Invalid trampoline sequence: %x %x %x %x %x %x %x\n", code [0], code [1], code [2], code [3],
 144                                 code [4], code [5], code [6]);
 145                         g_assert_not_reached ();
 146                 }
 147         }
 148
 149         switch (reg) {
 150         case X86_EAX:
 151                 o = (gpointer)eax;
 152                 break;
 153         case X86_EDX:
 154                 o = (gpointer)edx;
 155                 break;
 156         case X86_ECX:
 157                 o = (gpointer)ecx;
 158                 break;
 159         case X86_ESI:
 160                 o = (gpointer)esi;
 161                 break;
 162         case X86_EDI:
 163                 o = (gpointer)edi;
 164                 break;
 165         case X86_EBX:
 166                 o = (gpointer)ebx;
 167                 break;
 168         default:
 169                 g_assert_not_reached ();
 170         }
 171
 172         o += disp;
 173
 174         if (m->klass->valuetype)
 175                 addr = get_unbox_trampoline (m, addr);
 176
 177         *((gpointer *)o) = addr;
 178
 179         return addr;
 180 }
 181
 182 /**
 183  * x86_class_init_trampoline:
 184  * @eax: saved x86 register
 185  * @ecx: saved x86 register
 186  * @edx: saved x86 register
 187  * @esi: saved x86 register
 188  * @edi: saved x86 register
 189  * @ebx: saved x86 register
 190  * @code: pointer into caller code
 191  * @vtable: the type to initialize
 192  *
 193  * This method calls mono_runtime_class_init () to run the static constructor
 194  * for the type, then patches the caller code so it is not called again.
 195  */
 196 static void
 197 x86_class_init_trampoline (int eax, int ecx, int edx, int esi, int edi,
 198                                                    int ebx, guint8 *code, MonoVTable *vtable)
 199 {
 200         int i;
 201
 202         mono_runtime_class_init (vtable);
 203
 204         code -= 5;
 205         if (code [0] == 0xe8) {
 206                 /*
 207                  * FIXME: This is not thread safe, since another thread might execute
 208                  * the partially changed code.
 209                  */
 210                 for (i = 0; i < 5; ++i)
 211                         x86_nop (code);
 212 #ifdef HAVE_VALGRIND_MEMCHECK_H
 213                 /* FIXME: the calltree skin trips on the self modifying code above */
 214
 215                 /* Tell valgrind to recompile the patched code */
 216                 VALGRIND_DISCARD_TRANSLATIONS (code, code + 8);
 217 #endif
 218         }
 219         else
 220                 if (code [0] == 0x90)
 221                         /* Already changed by another thread */
 222                         ;
 223                 else {
 224                         printf ("Invalid trampoline sequence: %x %x %x %x %x %x %x\n", code [0], code [1], code [2], code [3],
 225                                 code [4], code [5], code [6]);
 226                         g_assert_not_reached ();
 227                 }
 228 }
 229
 230 static guchar*
 231 create_trampoline_code (MonoTrampolineType tramp_type)
 232 {
 233         guint8 *buf, *code;
 234         static guint8* generic_jump_trampoline = NULL;
 235         static guint8 *generic_class_init_trampoline = NULL;
 236
 237         switch (tramp_type) {
 238         case MONO_TRAMPOLINE_GENERIC:
 239                 if (mono_generic_trampoline_code)
 240                         return mono_generic_trampoline_code;
 241                 break;
 242         case MONO_TRAMPOLINE_JUMP:
 243                 if (generic_jump_trampoline)
 244                         return generic_jump_trampoline;
 245                 break;
 246         case MONO_TRAMPOLINE_CLASS_INIT:
 247                 if (generic_class_init_trampoline)
 248                         return generic_class_init_trampoline;
 249                 break;
 250         }
 251
 252         code = buf = g_malloc (256);
 253         /* save caller save regs because we need to do a call */
 254         x86_push_reg (buf, X86_EDX);
 255         x86_push_reg (buf, X86_EAX);
 256         x86_push_reg (buf, X86_ECX);
 257
 258         /* save LMF begin */
 259
 260         /* save the IP (caller ip) */
 261         if (tramp_type == MONO_TRAMPOLINE_JUMP)
 262                 x86_push_imm (buf, 0);
 263         else
 264                 x86_push_membase (buf, X86_ESP, 16);
 265
 266         x86_push_reg (buf, X86_EBX);
 267         x86_push_reg (buf, X86_EDI);
 268         x86_push_reg (buf, X86_ESI);
 269         x86_push_reg (buf, X86_EBP);
 270
 271         /* save method info */
 272         x86_push_membase (buf, X86_ESP, 32);
 273         /* get the address of lmf for the current thread */
 274         x86_call_code (buf, mono_get_lmf_addr);
 275         /* push lmf */
 276         x86_push_reg (buf, X86_EAX);
 277         /* push *lfm (previous_lmf) */
 278         x86_push_membase (buf, X86_EAX, 0);
 279         /* *(lmf) = ESP */
 280         x86_mov_membase_reg (buf, X86_EAX, 0, X86_ESP, 4);
 281         /* save LFM end */
 282
 283         /* push the method info */
 284         x86_push_membase (buf, X86_ESP, 44);
 285         /* push the return address onto the stack */
 286         if (tramp_type == MONO_TRAMPOLINE_JUMP)
 287                 x86_push_imm (buf, 0);
 288         else
 289                 x86_push_membase (buf, X86_ESP, 52);
 290
 291         /* save all register values */
 292         x86_push_reg (buf, X86_EBX);
 293         x86_push_reg (buf, X86_EDI);
 294         x86_push_reg (buf, X86_ESI);
 295         x86_push_membase (buf, X86_ESP, 64); /* EDX */
 296         x86_push_membase (buf, X86_ESP, 64); /* ECX */
 297         x86_push_membase (buf, X86_ESP, 64); /* EAX */
 298
 299         if (tramp_type == MONO_TRAMPOLINE_CLASS_INIT)
 300                 x86_call_code (buf, x86_class_init_trampoline);
 301         else
 302                 x86_call_code (buf, x86_magic_trampoline);
 303         x86_alu_reg_imm (buf, X86_ADD, X86_ESP, 8*4);
 304
 305         /* restore LMF start */
 306         /* ebx = previous_lmf */
 307         x86_pop_reg (buf, X86_EBX);
 308         /* edi = lmf */
 309         x86_pop_reg (buf, X86_EDI);
 310         /* *(lmf) = previous_lmf */
 311         x86_mov_membase_reg (buf, X86_EDI, 0, X86_EBX, 4);
 312         /* discard method info */
 313         x86_pop_reg (buf, X86_ESI);
 314         /* restore caller saved regs */
 315         x86_pop_reg (buf, X86_EBP);
 316         x86_pop_reg (buf, X86_ESI);
 317         x86_pop_reg (buf, X86_EDI);
 318         x86_pop_reg (buf, X86_EBX);
 319         /* discard save IP */
 320         x86_alu_reg_imm (buf, X86_ADD, X86_ESP, 4);
 321         /* restore LMF end */
 322
 323         x86_alu_reg_imm (buf, X86_ADD, X86_ESP, 16);
 324
 325         if (tramp_type == MONO_TRAMPOLINE_CLASS_INIT)
 326                 x86_ret (buf);
 327         else
 328                 /* call the compiled method */
 329                 x86_jump_reg (buf, X86_EAX);
 330
 331         g_assert ((buf - code) <= 256);
 332
 333         switch (tramp_type) {
 334         case MONO_TRAMPOLINE_GENERIC:
 335                 mono_generic_trampoline_code = code;
 336                 break;
 337         case MONO_TRAMPOLINE_JUMP:
 338                 generic_jump_trampoline = code;
 339                 break;
 340         case MONO_TRAMPOLINE_CLASS_INIT:
 341                 generic_class_init_trampoline = code;
 342                 break;
 343         }
 344
 345         return code;
 346 }
 347
 348 #define TRAMPOLINE_SIZE 10
 349
 350 gpointer
 351 mono_arch_create_jump_trampoline (MonoMethod *method)
 352 {
 353         guint8 *code, *buf, *tramp;
 354
 355         if (method->iflags & METHOD_IMPL_ATTRIBUTE_SYNCHRONIZED)
 356                 return mono_arch_create_jump_trampoline (mono_marshal_get_synchronized_wrapper (method));
 357
 358         /* icalls use method->addr */
 359         if ((method->iflags & METHOD_IMPL_ATTRIBUTE_INTERNAL_CALL) ||
 360             (method->flags & METHOD_ATTRIBUTE_PINVOKE_IMPL)) {
 361                 MonoMethod *nm;
 362
 363                 if (!method->addr) {
 364                         if (method->iflags & METHOD_IMPL_ATTRIBUTE_INTERNAL_CALL)
 365                                 method->addr = mono_lookup_internal_call (method);
 366                         if (method->flags & METHOD_ATTRIBUTE_PINVOKE_IMPL)
 367                                 mono_lookup_pinvoke_call (method);
 368                 }
 369 #ifdef MONO_USE_EXC_TABLES
 370                 if (mono_method_blittable (method)) {
 371                         return method->addr;
 372                 } else {
 373 #endif
 374                         nm = mono_marshal_get_native_wrapper (method);
 375                         return mono_compile_method (nm);
 376 #ifdef MONO_USE_EXC_TABLES
 377                 }
 378 #endif
 379         }
 380
 381         tramp = create_trampoline_code (MONO_TRAMPOLINE_JUMP);
 382
 383         code = buf = g_malloc (TRAMPOLINE_SIZE);
 384         x86_push_imm (buf, method);
 385         x86_jump_code (buf, tramp);
 386         g_assert ((buf - code) <= TRAMPOLINE_SIZE);
 387
 388         mono_jit_stats.method_trampolines++;
 389
 390         return code;
 391
 392 }
 393
 394 /**
 395  * mono_arch_create_jit_trampoline:
 396  * @method: pointer to the method info
 397  *
 398  * Creates a trampoline function for virtual methods. If the created
 399  * code is called it first starts JIT compilation of method,
 400  * and then calls the newly created method. I also replaces the
 401  * corresponding vtable entry (see x86_magic_trampoline).
 402  *
 403  * Returns: a pointer to the newly created code
 404  */
 405 gpointer
 406 mono_arch_create_jit_trampoline (MonoMethod *method)
 407 {
 408         guint8 *code, *buf, *tramp;
 409
 410         /* previously created trampoline code */
 411         if (method->info)
 412                 return method->info;
 413
 414         if (method->iflags & METHOD_IMPL_ATTRIBUTE_SYNCHRONIZED)
 415                 return mono_arch_create_jit_trampoline (mono_marshal_get_synchronized_wrapper (method));
 416
 417         tramp = create_trampoline_code (MONO_TRAMPOLINE_GENERIC);
 418
 419         code = buf = g_malloc (TRAMPOLINE_SIZE);
 420         x86_push_imm (buf, method);
 421         x86_jump_code (buf, tramp);
 422         g_assert ((buf - code) <= TRAMPOLINE_SIZE);
 423
 424         /* store trampoline address */
 425         method->info = code;
 426
 427         mono_jit_stats.method_trampolines++;
 428
 429         return code;
 430 }
 431
 432 /**
 433  * mono_arch_create_class_init_trampoline:
 434  *  @vtable: the type to initialize
 435  *
 436  * Creates a trampoline function to run a type initializer.
 437  * If the trampoline is called, it calls mono_runtime_class_init with the
 438  * given vtable, then patches the caller code so it does not get called any
 439  * more.
 440  *
 441  * Returns: a pointer to the newly created code
 442  */
 443 gpointer
 444 mono_arch_create_class_init_trampoline (MonoVTable *vtable)
 445 {
 446         guint8 *code, *buf, *tramp;
 447
 448         tramp = create_trampoline_code (MONO_TRAMPOLINE_CLASS_INIT);
 449
 450         code = buf = g_malloc (TRAMPOLINE_SIZE);
 451         x86_push_imm (buf, vtable);
 452         x86_jump_code (buf, tramp);
 453         g_assert ((buf - code) <= TRAMPOLINE_SIZE);
 454
 455         mono_jit_stats.method_trampolines++;
 456
 457         return code;
 458 }
 459
 460 /*
 461  * This method is only called when running in the Mono Debugger.
 462  */
 463 gpointer
 464 mono_debugger_create_notification_function (gpointer *notification_address)
 465 {
 466         guint8 *ptr, *buf;
 467
 468         ptr = buf = g_malloc0 (16);
 469         x86_breakpoint (buf);
 470         if (notification_address)
 471                 *notification_address = buf;
 472         x86_ret (buf);
 473
 474         return ptr;
 475 }
 476