2006-04-16 Zoltan Varga <vargaz@gmail.com>
[mono.git] / mono / mini / tramp-x86.c
index b23039b37697d752c51a4486098d8c0d7e248f4e..f2904793225970a2b2209930a8541689f27c317b 100644 (file)
@@ -14,8 +14,9 @@
 #include <mono/metadata/metadata-internals.h>
 #include <mono/metadata/marshal.h>
 #include <mono/metadata/tabledefs.h>
-#include <mono/arch/x86/x86-codegen.h>
+#include <mono/metadata/mono-debug.h>
 #include <mono/metadata/mono-debug-debugger.h>
+#include <mono/arch/x86/x86-codegen.h>
 
 #ifdef HAVE_VALGRIND_MEMCHECK_H
 #include <valgrind/memcheck.h>
 #include "mini.h"
 #include "mini-x86.h"
 
+static guint8* nullified_class_init_trampoline;
+
 /*
- * get_unbox_trampoline:
+ * mono_arch_get_unbox_trampoline:
  * @m: method pointer
  * @addr: pointer to native code for @m
  *
@@ -33,8 +36,8 @@
  * this argument. This method returns a pointer to a trampoline which does
  * unboxing before calling the method
  */
-static gpointer
-get_unbox_trampoline (MonoMethod *m, gpointer addr)
+gpointer
+mono_arch_get_unbox_trampoline (MonoMethod *m, gpointer addr)
 {
        guint8 *code, *start;
        int this_pos = 4;
@@ -54,161 +57,36 @@ get_unbox_trampoline (MonoMethod *m, gpointer addr)
        return start;
 }
 
-/**
- * x86_magic_trampoline:
- * @eax: saved x86 register 
- * @ecx: saved x86 register 
- * @edx: saved x86 register 
- * @esi: saved x86 register 
- * @edi: saved x86 register 
- * @ebx: saved x86 register
- * @code: pointer into caller code
- * @method: the method to translate
- *
- * This method is called by the trampoline functions for virtual
- * methods. It inspects the caller code to find the address of the
- * vtable slot, then calls the JIT compiler and writes the address
- * of the compiled method back to the vtable. All virtual methods 
- * are called with: x86_call_membase (inst, basereg, disp). We always
- * use 32 bit displacement to ensure that the length of the call 
- * instruction is 6 bytes. We need to get the value of the basereg 
- * and the constant displacement.
- */
-static gpointer
-x86_magic_trampoline (int eax, int ecx, int edx, int esi, int edi, 
-                     int ebx, guint8 *code, MonoMethod *m)
+void
+mono_arch_patch_callsite (guint8 *code, guint8 *addr)
 {
-       gpointer addr;
-       gpointer *vtable_slot;
-       int regs [X86_NREG];
-
-       addr = mono_compile_method (m);
-       g_assert (addr);
-
-       /* the method was jumped to */
-       if (!code)
-               return addr;
-
-       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);
+       /* 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 ()) {
+                       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 {
-                       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 ();
                }
+       } 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 ();
        }
-
-       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;
-       gpointer addr;
-       gpointer *vtable_slot;
-       int regs [X86_NREG];
-
-       image = *(gpointer*)token_info;
-       token_info += sizeof (gpointer);
-       token = *(guint32*)token_info;
-
-       /* Later we could avoid allocating the MonoMethod */
-       method = mono_get_method (image, token, NULL);
-       g_assert (method);
-
-       if (method->iflags & METHOD_IMPL_ATTRIBUTE_SYNCHRONIZED)
-               method = mono_marshal_get_synchronized_wrapper (method);
-
-       addr = mono_compile_method (method);
-       g_assert (addr);
-
-       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);
-       g_assert (vtable_slot);
-
-       if (method->klass->valuetype)
-               addr = get_unbox_trampoline (method, addr);
-
-       if (mono_domain_owns_vtable_slot (mono_domain_get (), vtable_slot))
-               *vtable_slot = addr;
-
-       return addr;
-}      
-
-/**
- * x86_class_init_trampoline:
- * @eax: saved x86 register 
- * @ecx: saved x86 register 
- * @edx: saved x86 register 
- * @esi: saved x86 register 
- * @edi: saved x86 register 
- * @ebx: saved x86 register
- * @code: pointer into caller code
- * @vtable: the type to initialize
- *
- * This method calls mono_runtime_class_init () to run the static constructor
- * for the type, then patches the caller code so it is not called again.
- */
-static void
-x86_class_init_trampoline (int eax, int ecx, int edx, int esi, int edi, 
-                                                  int ebx, guint8 *code, MonoVTable *vtable)
+void
+mono_arch_nullify_class_init_trampoline (guint8 *code, gssize *regs)
 {
-       mono_runtime_class_init (vtable);
-
        code -= 5;
        if (code [0] == 0xe8) {
                if (!mono_running_on_valgrind ()) {
@@ -232,7 +110,6 @@ x86_class_init_trampoline (int eax, int ecx, int edx, int esi, int edi,
                        /* 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 */
 
@@ -245,8 +122,12 @@ x86_class_init_trampoline (int eax, int ecx, int edx, int esi, int edi,
                ;
        } else if ((code [-1] == 0xff) && (x86_modrm_reg (code [0]) == 0x2)) {
                /* call *<OFFSET>(<REG>) -> Call made from AOT code */
-               /* FIXME: Patch up the trampoline */
-               ;
+               gpointer *vtable_slot;
+
+               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]);
@@ -254,17 +135,53 @@ x86_class_init_trampoline (int eax, int ecx, int edx, int esi, int edi,
                }
 }
 
+void
+mono_arch_patch_delegate_trampoline (guint8 *code, guint8 *tramp, gssize *regs, guint8 *addr)
+{
+       guint32 reg;
+       guint32 disp;
+
+       if ((code [-3] == 0xff) && (x86_modrm_reg (code [-2]) == 0x2) && (x86_modrm_mod (code [-2]) == 0x1)) {
+               /* call *[reg+disp8] */
+               reg = x86_modrm_rm (code [-2]);
+               disp = *(guint8*)(code - 1);
+               //printf ("B: [%%r%d+0x%x]\n", reg, disp);
+       }
+       else {
+               int i;
+
+               for (i = -16; i < 0; ++i)
+                       printf ("%d ", code [i]);
+               printf ("\n");
+               g_assert_not_reached ();
+       }
+
+       *(gpointer*)(((guint32)(regs [reg])) + disp) = addr;
+}
+
 guchar*
 mono_arch_create_trampoline_code (MonoTrampolineType tramp_type)
 {
        guint8 *buf, *code;
+       int pushed_args;
 
        code = buf = mono_global_codeman_reserve (256);
 
-       /* save caller save regs because we need to do a call */ 
+       /* Note that there is a single argument to the trampoline
+        * and it is stored at: esp + pushed_args * sizeof (gpointer)
+        * the ret address is at: esp + (pushed_args + 1) * sizeof (gpointer)
+        */
+       /* Put all registers into an array on the stack */
+       x86_push_reg (buf, X86_EDI);
+       x86_push_reg (buf, X86_ESI);
+       x86_push_reg (buf, X86_EBP);
+       x86_push_reg (buf, X86_ESP);
+       x86_push_reg (buf, X86_EBX);
        x86_push_reg (buf, X86_EDX);
-       x86_push_reg (buf, X86_EAX);
        x86_push_reg (buf, X86_ECX);
+       x86_push_reg (buf, X86_EAX);
+
+       pushed_args = 8;
 
        /* save LMF begin */
 
@@ -272,15 +189,30 @@ mono_arch_create_trampoline_code (MonoTrampolineType tramp_type)
        if (tramp_type == MONO_TRAMPOLINE_JUMP)
                x86_push_imm (buf, 0);
        else
-               x86_push_membase (buf, X86_ESP, 16);
+               x86_push_membase (buf, X86_ESP, (pushed_args + 1) * sizeof (gpointer));
+
+       pushed_args++;
 
        x86_push_reg (buf, X86_EBP);
        x86_push_reg (buf, X86_ESI);
        x86_push_reg (buf, X86_EDI);
        x86_push_reg (buf, X86_EBX);
 
+       pushed_args += 4;
+
        /* save method info */
-       x86_push_membase (buf, X86_ESP, 32);
+       x86_push_membase (buf, X86_ESP, pushed_args * sizeof (gpointer));
+
+       pushed_args++;
+
+       /* the stack is correctly aligned to 16 bytes because pushed_args is 14
+        * and there is the extra trampoline arg + the return ip pushed by call
+        * FIXME: Note that if an exception happens while some args are pushed
+        * on the stack, the stack will be misaligned.
+        */
+#ifdef __APPLE__
+       g_assert (pushed_args == 14);
+#endif
        /* get the address of lmf for the current thread */
        x86_call_code (buf, mono_get_lmf_addr);
        /* push lmf */
@@ -291,29 +223,61 @@ mono_arch_create_trampoline_code (MonoTrampolineType tramp_type)
        x86_mov_membase_reg (buf, X86_EAX, 0, X86_ESP, 4);
        /* save LFM end */
 
+       pushed_args += 2;
+
+       /* starting the call sequence */
+#ifdef __APPLE__
+       /* changing esp to keep the stack aligned */
+       x86_alu_reg_imm (buf, X86_SUB, X86_ESP, 8);
+       pushed_args += 2;
+#endif
+
+       /* FIXME: Push the trampoline address */
+       x86_push_imm (buf, 0);
+
+       pushed_args++;
+
        /* push the method info */
-       x86_push_membase (buf, X86_ESP, 44);
+       x86_push_membase (buf, X86_ESP, pushed_args * sizeof (gpointer));
+
+       pushed_args++;
+
        /* push the return address onto the stack */
        if (tramp_type == MONO_TRAMPOLINE_JUMP)
                x86_push_imm (buf, 0);
        else
-               x86_push_membase (buf, X86_ESP, 52);
+               x86_push_membase (buf, X86_ESP, (pushed_args + 1) * sizeof (gpointer));
+       pushed_args++;
+       /* push the address of the register array */
+       x86_lea_membase (buf, X86_EAX, X86_ESP, (pushed_args - 8) * sizeof (gpointer));
+       x86_push_reg (buf, X86_EAX);
 
-       /* save all register values */
-       x86_push_reg (buf, X86_EBX);
-       x86_push_reg (buf, X86_EDI);
-       x86_push_reg (buf, X86_ESI);
-       x86_push_membase (buf, X86_ESP, 64); /* EDX */
-       x86_push_membase (buf, X86_ESP, 64); /* ECX */
-       x86_push_membase (buf, X86_ESP, 64); /* EAX */
+       pushed_args++;
+
+#ifdef __APPLE__
+       /* check the stack is aligned after the ret ip is pushed */
+       /*x86_mov_reg_reg (buf, X86_EDX, X86_ESP, 4);
+       x86_alu_reg_imm (buf, X86_AND, X86_EDX, 15);
+       x86_alu_reg_imm (buf, X86_CMP, X86_EDX, 0);
+       x86_branch_disp (buf, X86_CC_Z, 3, FALSE);
+       x86_breakpoint (buf);*/
+#endif
 
        if (tramp_type == MONO_TRAMPOLINE_CLASS_INIT)
-               x86_call_code (buf, x86_class_init_trampoline);
+               x86_call_code (buf, mono_class_init_trampoline);
        else if (tramp_type == MONO_TRAMPOLINE_AOT)
-               x86_call_code (buf, x86_aot_trampoline);
+               x86_call_code (buf, mono_aot_trampoline);
+       else if (tramp_type == MONO_TRAMPOLINE_DELEGATE)
+               x86_call_code (buf, mono_delegate_trampoline);
        else
-               x86_call_code (buf, x86_magic_trampoline);
-       x86_alu_reg_imm (buf, X86_ADD, X86_ESP, 8*4);
+               x86_call_code (buf, mono_magic_trampoline);
+
+#ifdef __APPLE__
+       /* account for the alignment above */
+       x86_alu_reg_imm (buf, X86_ADD, X86_ESP, 6*4);
+#else
+       x86_alu_reg_imm (buf, X86_ADD, X86_ESP, 4*4);
+#endif
 
        /* restore LMF start */
        /* ebx = previous_lmf */
@@ -334,7 +298,12 @@ mono_arch_create_trampoline_code (MonoTrampolineType tramp_type)
        x86_alu_reg_imm (buf, X86_ADD, X86_ESP, 4);             
        /* restore LMF end */
 
-       x86_alu_reg_imm (buf, X86_ADD, X86_ESP, 16);
+       /* Restore caller saved registers */
+       x86_mov_reg_membase (buf, X86_ECX, X86_ESP, 1 * 4, 4);
+       x86_mov_reg_membase (buf, X86_EDX, X86_ESP, 2 * 4, 4);
+
+       /* Pop saved reg array + method ptr */
+       x86_alu_reg_imm (buf, X86_ADD, X86_ESP, 9 * 4);
 
        if (tramp_type == MONO_TRAMPOLINE_CLASS_INIT)
                x86_ret (buf);
@@ -344,13 +313,19 @@ mono_arch_create_trampoline_code (MonoTrampolineType tramp_type)
 
        g_assert ((buf - code) <= 256);
 
+       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;
 }
 
 #define TRAMPOLINE_SIZE 10
 
-static gpointer
-create_specific_trampoline (gpointer arg1, MonoTrampolineType tramp_type, MonoDomain *domain, guint32 *code_len)
+gpointer
+mono_arch_create_specific_trampoline (gpointer arg1, MonoTrampolineType tramp_type, MonoDomain *domain, guint32 *code_len)
 {
        guint8 *code, *buf, *tramp;
        
@@ -374,74 +349,6 @@ create_specific_trampoline (gpointer arg1, MonoTrampolineType tramp_type, MonoDo
        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;
-}
-
-/**
- * mono_arch_create_jit_trampoline:
- * @method: pointer to the method info
- *
- * Creates a trampoline function for virtual methods. If the created
- * code is called it first starts JIT compilation of method,
- * and then calls the newly created method. I also replaces the
- * corresponding vtable entry (see x86_magic_trampoline).
- * 
- * Returns: a pointer to the newly created code 
- */
-gpointer
-mono_arch_create_jit_trampoline (MonoMethod *method)
-{
-       return create_specific_trampoline (method, MONO_TRAMPOLINE_GENERIC, mono_domain_get (), NULL);
-}
-
-gpointer
-mono_arch_create_jit_trampoline_from_token (MonoImage *image, guint32 token)
-{
-       MonoDomain *domain = mono_domain_get ();
-       guint8 *buf, *start;
-
-       mono_domain_lock (domain);
-       buf = start = mono_code_manager_reserve (domain->code_mp, 2 * sizeof (gpointer));
-       mono_domain_unlock (domain);
-
-       *(gpointer*)buf = image;
-       buf += sizeof (gpointer);
-       *(guint32*)buf = token;
-
-       return create_specific_trampoline (start, MONO_TRAMPOLINE_AOT, domain, NULL);
-}
-
-/**
- * mono_arch_create_class_init_trampoline:
- *  @vtable: the type to initialize
- *
- * Creates a trampoline function to run a type initializer. 
- * If the trampoline is called, it calls mono_runtime_class_init with the
- * given vtable, then patches the caller code so it does not get called any
- * more.
- * 
- * Returns: a pointer to the newly created code 
- */
-gpointer
-mono_arch_create_class_init_trampoline (MonoVTable *vtable)
-{
-       return create_specific_trampoline (vtable, MONO_TRAMPOLINE_CLASS_INIT, vtable->domain, NULL);
-}
-
 void
 mono_arch_invalidate_method (MonoJitInfo *ji, void *func, gpointer func_arg)
 {
@@ -455,17 +362,13 @@ mono_arch_invalidate_method (MonoJitInfo *ji, void *func, gpointer func_arg)
 /*
  * This method is only called when running in the Mono Debugger.
  */
-gpointer
-mono_debugger_create_notification_function (gpointer *notification_address)
+guint8 *
+mono_debugger_create_notification_function ()
 {
-       guint8 *ptr, *buf;
-
-       ptr = buf = mono_global_codeman_reserve (16);
+       guint8 *buf, *code;
 
+       code = buf = mono_global_codeman_reserve (2);
        x86_breakpoint (buf);
-       if (notification_address)
-               *notification_address = buf;
        x86_ret (buf);
-
-       return ptr;
+       return code;
 }