2005-07-07 Atsushi Enomoto <atsushi@ximian.com>
[mono.git] / mono / mini / tramp-x86.c
index 817b81258104668468628fc145e887874447e9b7..454fa396778e68657218ee93f2e89fdfd6f04db2 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * trampoline.c: JIT trampoline code
+ * tramp-x86.c: JIT trampoline code for x86
  *
  * Authors:
  *   Dietmar Maurer (dietmar@ximian.com)
@@ -11,6 +11,7 @@
 #include <glib.h>
 
 #include <mono/metadata/appdomain.h>
+#include <mono/metadata/metadata-internals.h>
 #include <mono/metadata/marshal.h>
 #include <mono/metadata/tabledefs.h>
 #include <mono/arch/x86/x86-codegen.h>
 #include "mini.h"
 #include "mini-x86.h"
 
-typedef enum {
-       MONO_TRAMPOLINE_GENERIC,
-       MONO_TRAMPOLINE_JUMP,
-       MONO_TRAMPOLINE_CLASS_INIT
-} MonoTrampolineType;
-
-/* adapt to mini later... */
-#define mono_jit_share_code (1)
-
-/*
- * Address of the x86 trampoline code.  This is used by the debugger to check
- * whether a method is a trampoline.
- */
-guint8 *mono_generic_trampoline_code = NULL;
+static guint8* nullified_class_init_trampoline;
 
 /*
  * get_unbox_trampoline:
@@ -52,11 +40,14 @@ get_unbox_trampoline (MonoMethod *m, gpointer addr)
 {
        guint8 *code, *start;
        int this_pos = 4;
+       MonoDomain *domain = mono_domain_get ();
 
-       if (!m->signature->ret->byref && MONO_TYPE_ISSTRUCT (m->signature->ret))
+       if (!mono_method_signature (m)->ret->byref && MONO_TYPE_ISSTRUCT (mono_method_signature (m)->ret))
                this_pos = 8;
            
-       start = code = g_malloc (16);
+       mono_domain_lock (domain);
+       start = code = mono_code_manager_reserve (domain->code_mp, 16);
+       mono_domain_unlock (domain);
 
        x86_alu_membase_imm (code, X86_ADD, X86_ESP, this_pos, sizeof (MonoObject));
        x86_jump_code (code, addr);
@@ -89,10 +80,9 @@ static gpointer
 x86_magic_trampoline (int eax, int ecx, int edx, int esi, int edi, 
                      int ebx, guint8 *code, MonoMethod *m)
 {
-       guint8 reg;
-       gint32 disp;
-       char *o;
        gpointer addr;
+       gpointer *vtable_slot;
+       int regs [X86_NREG];
 
        addr = mono_compile_method (m);
        g_assert (addr);
@@ -101,44 +91,40 @@ x86_magic_trampoline (int eax, int ecx, int edx, int esi, int edi,
        if (!code)
                return addr;
 
-       /* go to the start of the call instruction
-        *
-        * address_byte = (m << 6) | (o << 3) | reg
-        * call opcode: 0xff address_byte displacement
-        * 0xff m=1,o=2 imm8
-        * 0xff m=2,o=2 imm32
-        */
-       code -= 6;
-       if ((code [1] != 0xe8) && (code [3] == 0xff) && ((code [4] & 0x18) == 0x10) && ((code [4] >> 6) == 1)) {
-               reg = code [4] & 0x07;
-               disp = (signed char)code [5];
-       } else {
-               if ((code [0] == 0xff) && ((code [1] & 0x18) == 0x10) && ((code [1] >> 6) == 2)) {
-                       reg = code [1] & 0x07;
-                       disp = *((gint32*)(code + 2));
-               } else if ((code [1] == 0xe8)) {
-                       MonoJitInfo *ji = 
-                               mono_jit_info_table_find (mono_domain_get (), code);
-                       MonoJitInfo *target_ji = 
-                               mono_jit_info_table_find (mono_domain_get (), addr);
-
-                       /* m->addr means pinvoke or icall */
-                       if (m->addr || mono_method_same_domain (ji, target_ji)) {
-                               *((guint32*)(code + 2)) = (guint)addr - ((guint)code + 1) - 5;
+       regs [X86_EAX] = eax;
+       regs [X86_ECX] = ecx;
+       regs [X86_EDX] = edx;
+       regs [X86_ESI] = esi;
+       regs [X86_EDI] = edi;
+       regs [X86_EBX] = ebx;
+
+       vtable_slot = mono_arch_get_vcall_slot_addr (code, (gpointer*)regs);
+       if (!vtable_slot) {
+               /* go to the start of the call instruction
+                *
+                * address_byte = (m << 6) | (o << 3) | reg
+                * call opcode: 0xff address_byte displacement
+                * 0xff m=1,o=2 imm8
+                * 0xff m=2,o=2 imm32
+                */
+               code -= 6;
+               if ((code [1] == 0xe8)) {
+                       if (!mono_running_on_valgrind ()) {
+                               MonoJitInfo *ji = 
+                                       mono_jit_info_table_find (mono_domain_get (), (char*)code);
+                               MonoJitInfo *target_ji = 
+                                       mono_jit_info_table_find (mono_domain_get (), addr);
+
+                               if (mono_method_same_domain (ji, target_ji)) {
+                                       InterlockedExchange ((gint32*)(code + 2), (guint)addr - ((guint)code + 1) - 5);
+
 #ifdef HAVE_VALGRIND_MEMCHECK_H
-                               /* Tell valgrind to recompile the patched code */
-                               VALGRIND_DISCARD_TRANSLATIONS (code + 2, code + 6);
+                                       /* Tell valgrind to recompile the patched code */
+                                       //VALGRIND_DISCARD_TRANSLATIONS (code + 2, code + 6);
 #endif
+                               }
                        }
                        return addr;
-               } else if ((code [4] == 0xff) && (((code [5] >> 6) & 0x3) == 0) && (((code [5] >> 3) & 0x7) == 2)) {
-                       /*
-                        * This is a interface call: should check the above code can't catch it earlier 
-                        * 8b 40 30   mov    0x30(%eax),%eax
-                        * ff 10      call   *(%eax)
-                        */
-                       disp = 0;
-                       reg = code [5] & 0x07;
                } else {
                        printf ("Invalid trampoline sequence: %x %x %x %x %x %x %x\n", code [0], code [1], code [2], code [3],
                                code [4], code [5], code [6]);
@@ -146,38 +132,75 @@ x86_magic_trampoline (int eax, int ecx, int edx, int esi, int edi,
                }
        }
 
-       switch (reg) {
-       case X86_EAX:
-               o = (gpointer)eax;
-               break;
-       case X86_EDX:
-               o = (gpointer)edx;
-               break;
-       case X86_ECX:
-               o = (gpointer)ecx;
-               break;
-       case X86_ESI:
-               o = (gpointer)esi;
-               break;
-       case X86_EDI:
-               o = (gpointer)edi;
-               break;
-       case X86_EBX:
-               o = (gpointer)ebx;
-               break;
-       default:
-               g_assert_not_reached ();
+       if (m->klass->valuetype && !mono_aot_is_got_entry (code, (guint8*)vtable_slot))
+               addr = get_unbox_trampoline (m, addr);
+
+       if (mono_aot_is_got_entry (code, (guint8*)vtable_slot) || mono_domain_owns_vtable_slot (mono_domain_get (), vtable_slot))
+               *vtable_slot = addr;
+
+       return addr;
+}
+
+/*
+ * x86_aot_trampoline:
+ *
+ *   This trampoline handles calls made from AOT code. We try to bypass the 
+ * normal JIT compilation logic to avoid loading the metadata for the method.
+ */
+static gpointer
+x86_aot_trampoline (int eax, int ecx, int edx, int esi, int edi, 
+                                       int ebx, guint8 *code, guint8 *token_info)
+{
+       MonoImage *image;
+       guint32 token;
+       MonoMethod *method = NULL;
+       gpointer addr;
+       gpointer *vtable_slot;
+       int regs [X86_NREG];
+       gboolean is_got_entry;
+
+       image = *(gpointer*)token_info;
+       token_info += sizeof (gpointer);
+       token = *(guint32*)token_info;
+
+       addr = mono_aot_get_method_from_token (mono_domain_get (), image, token);
+       if (!addr) {
+               method = mono_get_method (image, token, NULL);
+               g_assert (method);
+
+               //printf ("F: %s\n", mono_method_full_name (method, TRUE));
+
+               if (method->iflags & METHOD_IMPL_ATTRIBUTE_SYNCHRONIZED)
+                       method = mono_marshal_get_synchronized_wrapper (method);
+
+               addr = mono_compile_method (method);
+               g_assert (addr);
        }
 
-       o += disp;
+       regs [X86_EAX] = eax;
+       regs [X86_ECX] = ecx;
+       regs [X86_EDX] = edx;
+       regs [X86_ESI] = esi;
+       regs [X86_EDI] = edi;
+       regs [X86_EBX] = ebx;
 
-       if (m->klass->valuetype)
-               addr = get_unbox_trampoline (m, addr);
+       vtable_slot = mono_arch_get_vcall_slot_addr (code, (gpointer*)regs);
+       g_assert (vtable_slot);
 
-       *((gpointer *)o) = addr;
+       is_got_entry = mono_aot_is_got_entry (code, (guint8*)vtable_slot);
+
+       if (!is_got_entry) {
+               if (!method)
+                       method = mono_get_method (image, token, NULL);
+               if (method->klass->valuetype)
+                       addr = get_unbox_trampoline (method, addr);
+       }
+
+       if (is_got_entry || mono_domain_owns_vtable_slot (mono_domain_get (), vtable_slot))
+               *vtable_slot = addr;
 
        return addr;
-}
+}      
 
 /**
  * x86_class_init_trampoline:
@@ -197,59 +220,71 @@ static void
 x86_class_init_trampoline (int eax, int ecx, int edx, int esi, int edi, 
                                                   int ebx, guint8 *code, MonoVTable *vtable)
 {
-       int i;
-
        mono_runtime_class_init (vtable);
 
        code -= 5;
        if (code [0] == 0xe8) {
-               /* 
-                * FIXME: This is not thread safe, since another thread might execute
-                * the partially changed code.
-                */
-               for (i = 0; i < 5; ++i)
-                       x86_nop (code);
+               if (!mono_running_on_valgrind ()) {
+                       guint32 ops;
+                       /*
+                        * Thread safe code patching using the algorithm from the paper
+                        * 'Practicing JUDO: Java Under Dynamic Optimizations'
+                        */
+                       /* 
+                        * First atomically change the the first 2 bytes of the call to a
+                        * spinning jump.
+                        */
+                       ops = 0xfeeb;
+                       InterlockedExchange ((gint32*)code, ops);
+
+                       /* Then change the other bytes to a nop */
+                       code [2] = 0x90;
+                       code [3] = 0x90;
+                       code [4] = 0x90;
+
+                       /* Then atomically change the first 4 bytes to a nop as well */
+                       ops = 0x90909090;
+                       InterlockedExchange ((gint32*)code, ops);
 #ifdef HAVE_VALGRIND_MEMCHECK_H
-               /* FIXME: the calltree skin trips on the self modifying code above */
+                       /* FIXME: the calltree skin trips on the self modifying code above */
 
-               /* Tell valgrind to recompile the patched code */
-               VALGRIND_DISCARD_TRANSLATIONS (code, code + 8);
+                       /* Tell valgrind to recompile the patched code */
+                       //VALGRIND_DISCARD_TRANSLATIONS (code, code + 8);
 #endif
-       }
-       else
-               if (code [0] == 0x90)
-                       /* Already changed by another thread */
-                       ;
-               else {
+               }
+       } else if (code [0] == 0x90 || code [0] == 0xeb) {
+               /* Already changed by another thread */
+               ;
+       } else if ((code [-1] == 0xff) && (x86_modrm_reg (code [0]) == 0x2)) {
+               /* call *<OFFSET>(<REG>) -> Call made from AOT code */
+               int regs [X86_NREG];
+               gpointer *vtable_slot;
+
+               regs [X86_EAX] = eax;
+               regs [X86_ECX] = ecx;
+               regs [X86_EDX] = edx;
+               regs [X86_ESI] = esi;
+               regs [X86_EDI] = edi;
+               regs [X86_EBX] = ebx;
+
+               vtable_slot = mono_arch_get_vcall_slot_addr (code + 5, (gpointer*)regs);
+               g_assert (vtable_slot);
+
+               *vtable_slot = nullified_class_init_trampoline;
+       } else {
                        printf ("Invalid trampoline sequence: %x %x %x %x %x %x %x\n", code [0], code [1], code [2], code [3],
                                code [4], code [5], code [6]);
                        g_assert_not_reached ();
                }
 }
 
-static guchar*
-create_trampoline_code (MonoTrampolineType tramp_type)
+guchar*
+mono_arch_create_trampoline_code (MonoTrampolineType tramp_type)
 {
        guint8 *buf, *code;
-       static guint8* generic_jump_trampoline = NULL;
-       static guint8 *generic_class_init_trampoline = NULL;
-
-       switch (tramp_type) {
-       case MONO_TRAMPOLINE_GENERIC:
-               if (mono_generic_trampoline_code)
-                       return mono_generic_trampoline_code;
-               break;
-       case MONO_TRAMPOLINE_JUMP:
-               if (generic_jump_trampoline)
-                       return generic_jump_trampoline;
-               break;
-       case MONO_TRAMPOLINE_CLASS_INIT:
-               if (generic_class_init_trampoline)
-                       return generic_class_init_trampoline;
-               break;
-       }
 
-       code = buf = g_malloc (256);
+       code = buf = mono_global_codeman_reserve (256);
+
        /* save caller save regs because we need to do a call */ 
        x86_push_reg (buf, X86_EDX);
        x86_push_reg (buf, X86_EAX);
@@ -263,10 +298,10 @@ create_trampoline_code (MonoTrampolineType tramp_type)
        else
                x86_push_membase (buf, X86_ESP, 16);
 
-       x86_push_reg (buf, X86_EBX);
-       x86_push_reg (buf, X86_EDI);
-       x86_push_reg (buf, X86_ESI);
        x86_push_reg (buf, X86_EBP);
+       x86_push_reg (buf, X86_ESI);
+       x86_push_reg (buf, X86_EDI);
+       x86_push_reg (buf, X86_EBX);
 
        /* save method info */
        x86_push_membase (buf, X86_ESP, 32);
@@ -298,6 +333,8 @@ create_trampoline_code (MonoTrampolineType tramp_type)
 
        if (tramp_type == MONO_TRAMPOLINE_CLASS_INIT)
                x86_call_code (buf, x86_class_init_trampoline);
+       else if (tramp_type == MONO_TRAMPOLINE_AOT)
+               x86_call_code (buf, x86_aot_trampoline);
        else
                x86_call_code (buf, x86_magic_trampoline);
        x86_alu_reg_imm (buf, X86_ADD, X86_ESP, 8*4);
@@ -312,10 +349,11 @@ create_trampoline_code (MonoTrampolineType tramp_type)
        /* discard method info */
        x86_pop_reg (buf, X86_ESI);
        /* restore caller saved regs */
-       x86_pop_reg (buf, X86_EBP);
-       x86_pop_reg (buf, X86_ESI);
-       x86_pop_reg (buf, X86_EDI);
        x86_pop_reg (buf, X86_EBX);
+       x86_pop_reg (buf, X86_EDI);
+       x86_pop_reg (buf, X86_ESI);
+       x86_pop_reg (buf, X86_EBP);
+
        /* discard save IP */
        x86_alu_reg_imm (buf, X86_ADD, X86_ESP, 4);             
        /* restore LMF end */
@@ -330,16 +368,10 @@ create_trampoline_code (MonoTrampolineType tramp_type)
 
        g_assert ((buf - code) <= 256);
 
-       switch (tramp_type) {
-       case MONO_TRAMPOLINE_GENERIC:
-               mono_generic_trampoline_code = code;
-               break;
-       case MONO_TRAMPOLINE_JUMP:
-               generic_jump_trampoline = code;
-               break;
-       case MONO_TRAMPOLINE_CLASS_INIT:
-               generic_class_init_trampoline = code;
-               break;
+       if (tramp_type == MONO_TRAMPOLINE_CLASS_INIT) {
+               /* Initialize the nullified class init trampoline used in the AOT case */
+               nullified_class_init_trampoline = buf = mono_global_codeman_reserve (16);
+               x86_ret (buf);
        }
 
        return code;
@@ -347,48 +379,46 @@ create_trampoline_code (MonoTrampolineType tramp_type)
 
 #define TRAMPOLINE_SIZE 10
 
-gpointer
-mono_arch_create_jump_trampoline (MonoMethod *method)
+static gpointer
+create_specific_trampoline (gpointer arg1, MonoTrampolineType tramp_type, MonoDomain *domain, guint32 *code_len)
 {
        guint8 *code, *buf, *tramp;
-
-       if (method->iflags & METHOD_IMPL_ATTRIBUTE_SYNCHRONIZED)
-               return mono_arch_create_jump_trampoline (mono_marshal_get_synchronized_wrapper (method));
-
-       /* icalls use method->addr */
-       if ((method->iflags & METHOD_IMPL_ATTRIBUTE_INTERNAL_CALL) ||
-           (method->flags & METHOD_ATTRIBUTE_PINVOKE_IMPL)) {
-               MonoMethod *nm;
-               
-               if (!method->addr) {
-                       if (method->iflags & METHOD_IMPL_ATTRIBUTE_INTERNAL_CALL)
-                               method->addr = mono_lookup_internal_call (method);
-                       if (method->flags & METHOD_ATTRIBUTE_PINVOKE_IMPL)
-                               mono_lookup_pinvoke_call (method);
-               }
-#ifdef MONO_USE_EXC_TABLES
-               if (mono_method_blittable (method)) {
-                       return method->addr;
-               } else {
-#endif
-                       nm = mono_marshal_get_native_wrapper (method);
-                       return mono_compile_method (nm);
-#ifdef MONO_USE_EXC_TABLES
-               }
-#endif
-       }
        
-       tramp = create_trampoline_code (MONO_TRAMPOLINE_JUMP);
+       tramp = mono_get_trampoline_code (tramp_type);
 
-       code = buf = g_malloc (TRAMPOLINE_SIZE);
-       x86_push_imm (buf, method);
+       mono_domain_lock (domain);
+       code = buf = mono_code_manager_reserve (domain->code_mp, TRAMPOLINE_SIZE);
+       mono_domain_unlock (domain);
+
+       x86_push_imm (buf, arg1);
        x86_jump_code (buf, tramp);
        g_assert ((buf - code) <= TRAMPOLINE_SIZE);
 
+       mono_arch_flush_icache (code, buf - code);
+
        mono_jit_stats.method_trampolines++;
 
+       if (code_len)
+               *code_len = buf - code;
+
        return code;
+}
+
+MonoJitInfo*
+mono_arch_create_jump_trampoline (MonoMethod *method)
+{
+       MonoJitInfo *ji;
+       gpointer code;
+       guint32 code_size;
+
+       code = create_specific_trampoline (method, MONO_TRAMPOLINE_JUMP, mono_domain_get (), &code_size);
 
+       ji = g_new0 (MonoJitInfo, 1);
+       ji->code_start = code;
+       ji->code_size = code_size;
+       ji->method = method;
+
+       return ji;
 }
 
 /**
@@ -405,28 +435,24 @@ mono_arch_create_jump_trampoline (MonoMethod *method)
 gpointer
 mono_arch_create_jit_trampoline (MonoMethod *method)
 {
-       guint8 *code, *buf, *tramp;
-
-       /* previously created trampoline code */
-       if (method->info)
-               return method->info;
-
-       if (method->iflags & METHOD_IMPL_ATTRIBUTE_SYNCHRONIZED)
-               return mono_arch_create_jit_trampoline (mono_marshal_get_synchronized_wrapper (method));
-
-       tramp = create_trampoline_code (MONO_TRAMPOLINE_GENERIC);
+       return create_specific_trampoline (method, MONO_TRAMPOLINE_GENERIC, mono_domain_get (), NULL);
+}
 
-       code = buf = g_malloc (TRAMPOLINE_SIZE);
-       x86_push_imm (buf, method);
-       x86_jump_code (buf, tramp);
-       g_assert ((buf - code) <= TRAMPOLINE_SIZE);
+gpointer
+mono_arch_create_jit_trampoline_from_token (MonoImage *image, guint32 token)
+{
+       MonoDomain *domain = mono_domain_get ();
+       guint8 *buf, *start;
 
-       /* store trampoline address */
-       method->info = code;
+       mono_domain_lock (domain);
+       buf = start = mono_code_manager_reserve (domain->code_mp, 2 * sizeof (gpointer));
+       mono_domain_unlock (domain);
 
-       mono_jit_stats.method_trampolines++;
+       *(gpointer*)buf = image;
+       buf += sizeof (gpointer);
+       *(guint32*)buf = token;
 
-       return code;
+       return create_specific_trampoline (start, MONO_TRAMPOLINE_AOT, domain, NULL);
 }
 
 /**
@@ -443,18 +469,17 @@ mono_arch_create_jit_trampoline (MonoMethod *method)
 gpointer
 mono_arch_create_class_init_trampoline (MonoVTable *vtable)
 {
-       guint8 *code, *buf, *tramp;
-
-       tramp = create_trampoline_code (MONO_TRAMPOLINE_CLASS_INIT);
-
-       code = buf = g_malloc (TRAMPOLINE_SIZE);
-       x86_push_imm (buf, vtable);
-       x86_jump_code (buf, tramp);
-       g_assert ((buf - code) <= TRAMPOLINE_SIZE);
+       return create_specific_trampoline (vtable, MONO_TRAMPOLINE_CLASS_INIT, vtable->domain, NULL);
+}
 
-       mono_jit_stats.method_trampolines++;
+void
+mono_arch_invalidate_method (MonoJitInfo *ji, void *func, gpointer func_arg)
+{
+       /* FIXME: This is not thread safe */
+       guint8 *code = ji->code_start;
 
-       return code;
+       x86_push_imm (code, func_arg);
+       x86_call_code (code, (guint8*)func);
 }
 
 /*
@@ -465,7 +490,8 @@ mono_debugger_create_notification_function (gpointer *notification_address)
 {
        guint8 *ptr, *buf;
 
-       ptr = buf = g_malloc0 (16);
+       ptr = buf = mono_global_codeman_reserve (16);
+
        x86_breakpoint (buf);
        if (notification_address)
                *notification_address = buf;
@@ -473,4 +499,3 @@ mono_debugger_create_notification_function (gpointer *notification_address)
 
        return ptr;
 }
-