/*
- * trampoline.c: JIT trampoline code
+ * tramp-x86.c: JIT trampoline code for x86
*
* Authors:
* Dietmar Maurer (dietmar@ximian.com)
#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 <mono/metadata/mono-debug-debugger.h>
+
+#ifdef HAVE_VALGRIND_MEMCHECK_H
+#include <valgrind/memcheck.h>
+#endif
#include "mini.h"
#include "mini-x86.h"
-/*
- * define for the (broken) debugger breakpoint interface:
- * The debugger should use the hw registers to set the breakpoints.
- */
-#define mono_method_has_breakpoint(a,b) (0)
-#define mono_remove_breakpoint(a)
-
-/* adapt to mini later... */
-#define mono_jit_share_code (1)
+static guint8* nullified_class_init_trampoline;
/*
- * 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;
-
-/*
- * Address of a special breakpoint trampoline code for the debugger.
- */
-guint8 *mono_breakpoint_trampoline_code = NULL;
-
-/*
- * get_unbox_trampoline:
+ * mono_arch_get_unbox_trampoline:
* @m: method pointer
* @addr: pointer to native code for @m
*
* 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;
+ 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);
return start;
}
-/*
- * get_breakpoint_trampoline:
- * @m: method pointer
- * @addr: pointer to native code for @m
- *
- * creates a special trampoline for the debugger which is used to get
- * a breakpoint after compiling a method.
- */
-static gpointer
-get_breakpoint_trampoline (MonoMethod *m, guint32 breakpoint_id, gpointer addr)
-{
- guint8 *code, *start, *buf;
-
- if (!mono_breakpoint_trampoline_code) {
- mono_breakpoint_trampoline_code = buf = g_malloc (8);
-
- x86_breakpoint (buf);
- x86_alu_reg_imm (buf, X86_ADD, X86_ESP, 8);
- x86_ret (buf);
-
- g_assert ((buf - mono_breakpoint_trampoline_code) <= 8);
- }
-
- start = code = g_malloc (22);
- x86_push_imm (code, addr);
- x86_push_imm (code, breakpoint_id);
- x86_push_imm (code, m);
- x86_jump_code (code, mono_breakpoint_trampoline_code);
- g_assert ((code - start) <= 22);
-
- 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)
{
- guint8 reg;
- gint32 disp;
- char *o;
- guint32 breakpoint_id;
- gpointer addr, trampoline;
-
- EnterCriticalSection (metadata_section);
- addr = mono_compile_method (m);
- LeaveCriticalSection (metadata_section);
- g_assert (addr);
-
/* go to the start of the call instruction
*
* address_byte = (m << 6) | (o << 3) | reg
* 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];
+ 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);
+#endif
+ }
} 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)) {
- breakpoint_id = mono_method_has_breakpoint (m, TRUE);
- if (breakpoint_id) {
- mono_remove_breakpoint (breakpoint_id);
- trampoline = get_breakpoint_trampoline (m, breakpoint_id, addr);
- } else
- trampoline = addr;
- *((guint32*)(code + 2)) = (guint)addr - ((guint)code + 1) - 5;
- return trampoline;
- } else if ((code [4] == 0xff) && (((code [5] >> 6) & 0x3) == 0) && (((code [5] >> 3) & 0x7) == 2)) {
+ 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 ();
+ }
+}
+
+void
+mono_arch_nullify_class_init_trampoline (guint8 *code, gssize *regs)
+{
+ code -= 5;
+ if (code [0] == 0xe8) {
+ if (!mono_running_on_valgrind ()) {
+ guint32 ops;
/*
- * 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)
+ * 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.
*/
- disp = 0;
- reg = code [5] & 0x07;
- } else {
+ 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 */
+
+ /* Tell valgrind to recompile the patched code */
+ //VALGRIND_DISCARD_TRANSLATIONS (code, code + 8);
+#endif
+ }
+ } 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 */
+ 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]);
g_assert_not_reached ();
}
+}
+
+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;
- 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:
+ for (i = -16; i < 0; ++i)
+ printf ("%d ", code [i]);
+ printf ("\n");
g_assert_not_reached ();
}
- o += disp;
+ *(gpointer*)(((guint32)(regs [reg])) + disp) = addr;
+}
- if (m->klass->valuetype) {
- trampoline = *((gpointer *)o) = get_unbox_trampoline (m, addr);
- } else {
- trampoline = *((gpointer *)o) = addr;
- }
+guchar*
+mono_arch_create_trampoline_code (MonoTrampolineType tramp_type)
+{
+ guint8 *buf, *code;
+
+ code = buf = mono_global_codeman_reserve (256);
+
+ /* 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_ECX);
+ x86_push_reg (buf, X86_EAX);
+
+ /* save LMF begin */
+
+ /* save the IP (caller ip) */
+ if (tramp_type == MONO_TRAMPOLINE_JUMP)
+ x86_push_imm (buf, 0);
+ else
+ x86_push_membase (buf, X86_ESP, 8 * 4 + 4);
+
+ 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, 13 * 4);
+ /* get the address of lmf for the current thread */
+ x86_call_code (buf, mono_get_lmf_addr);
+ /* push lmf */
+ x86_push_reg (buf, X86_EAX);
+ /* push *lfm (previous_lmf) */
+ x86_push_membase (buf, X86_EAX, 0);
+ /* *(lmf) = ESP */
+ x86_mov_membase_reg (buf, X86_EAX, 0, X86_ESP, 4);
+ /* save LFM end */
+
+ /* FIXME: Push the trampoline address */
+ x86_push_imm (buf, 0);
+
+ /* push the method info */
+ x86_push_membase (buf, X86_ESP, 17 * 4);
+ /* 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, 18 * 4 + 4);
+ /* push the address of the register array */
+ x86_lea_membase (buf, X86_EAX, X86_ESP, 11 * 4);
+ x86_push_reg (buf, X86_EAX);
+
+ if (tramp_type == MONO_TRAMPOLINE_CLASS_INIT)
+ x86_call_code (buf, mono_class_init_trampoline);
+ else if (tramp_type == MONO_TRAMPOLINE_AOT)
+ 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, mono_magic_trampoline);
+ x86_alu_reg_imm (buf, X86_ADD, X86_ESP, 4*4);
+
+ /* restore LMF start */
+ /* ebx = previous_lmf */
+ x86_pop_reg (buf, X86_EBX);
+ /* edi = lmf */
+ x86_pop_reg (buf, X86_EDI);
+ /* *(lmf) = previous_lmf */
+ x86_mov_membase_reg (buf, X86_EDI, 0, X86_EBX, 4);
+ /* discard method info */
+ x86_pop_reg (buf, X86_ESI);
+ /* restore caller saved regs */
+ 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 */
+
+ /* 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);
+ else
+ /* call the compiled method */
+ x86_jump_reg (buf, X86_EAX);
- breakpoint_id = mono_method_has_breakpoint (m, TRUE);
- if (breakpoint_id) {
- mono_remove_breakpoint (breakpoint_id);
- return get_breakpoint_trampoline (m, breakpoint_id, trampoline);
- } else {
- return trampoline;
+ 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;
}
-/**
- * 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
- */
+#define TRAMPOLINE_SIZE 10
+
gpointer
-mono_arch_create_jit_trampoline (MonoMethod *method)
+mono_arch_create_specific_trampoline (gpointer arg1, MonoTrampolineType tramp_type, MonoDomain *domain, guint32 *code_len)
{
- guint8 *code, *buf;
+ guint8 *code, *buf, *tramp;
+
+ tramp = mono_get_trampoline_code (tramp_type);
- /* previously created trampoline code */
- if (method->info)
- return method->info;
+ mono_domain_lock (domain);
+ code = buf = mono_code_manager_reserve (domain->code_mp, TRAMPOLINE_SIZE);
+ mono_domain_unlock (domain);
- /* we immediately compile runtime provided functions */
- if (method->iflags & METHOD_IMPL_ATTRIBUTE_RUNTIME) {
- method->info = mono_compile_method (method);
- return method->info;
- }
+ x86_push_imm (buf, arg1);
+ x86_jump_code (buf, tramp);
+ g_assert ((buf - code) <= TRAMPOLINE_SIZE);
- /* icalls use method->addr */
- if ((method->iflags & METHOD_IMPL_ATTRIBUTE_INTERNAL_CALL) ||
- (method->flags & METHOD_ATTRIBUTE_PINVOKE_IMPL)) {
- MonoMethod *nm;
-
- if (!method->addr && (method->flags & METHOD_ATTRIBUTE_PINVOKE_IMPL))
- mono_lookup_pinvoke_call (method);
-
-#ifdef MONO_USE_EXC_TABLES
- if (mono_method_blittable (method)) {
- method->info = method->addr;
- } else {
-#endif
- nm = mono_marshal_get_native_wrapper (method);
- method->info = mono_compile_method (nm);
-#ifdef MONO_USE_EXC_TABLES
- }
-#endif
- return method->info;
- }
-
- if (method->iflags & METHOD_IMPL_ATTRIBUTE_SYNCHRONIZED)
- return mono_arch_create_jit_trampoline (mono_marshal_get_synchronized_wrapper (method));
-
- if (!mono_generic_trampoline_code) {
- mono_generic_trampoline_code = buf = g_malloc (256);
- /* save caller save regs because we need to do a call */
- x86_push_reg (buf, X86_EDX);
- x86_push_reg (buf, X86_EAX);
- x86_push_reg (buf, X86_ECX);
-
- /* save LMF begin */
-
- /* save the IP (caller ip) */
- 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);
-
- /* save method info */
- x86_push_membase (buf, X86_ESP, 32);
- /* get the address of lmf for the current thread */
- x86_call_code (buf, mono_get_lmf_addr);
- /* push lmf */
- x86_push_reg (buf, X86_EAX);
- /* push *lfm (previous_lmf) */
- x86_push_membase (buf, X86_EAX, 0);
- /* *(lmf) = ESP */
- x86_mov_membase_reg (buf, X86_EAX, 0, X86_ESP, 4);
- /* save LFM end */
-
- /* push the method info */
- x86_push_membase (buf, X86_ESP, 44);
- /* push the return address onto the stack */
- x86_push_membase (buf, X86_ESP, 52);
-
- /* 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 */
-
- x86_call_code (buf, x86_magic_trampoline);
- x86_alu_reg_imm (buf, X86_ADD, X86_ESP, 8*4);
-
- /* restore LMF start */
- /* ebx = previous_lmf */
- x86_pop_reg (buf, X86_EBX);
- /* edi = lmf */
- x86_pop_reg (buf, X86_EDI);
- /* *(lmf) = previous_lmf */
- x86_mov_membase_reg (buf, X86_EDI, 0, X86_EBX, 4);
- /* 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);
- /* discard save IP */
- x86_alu_reg_imm (buf, X86_ADD, X86_ESP, 4);
- /* restore LMF end */
-
- x86_alu_reg_imm (buf, X86_ADD, X86_ESP, 16);
+ mono_arch_flush_icache (code, buf - code);
- /* call the compiled method */
- x86_jump_reg (buf, X86_EAX);
+ mono_jit_stats.method_trampolines++;
- g_assert ((buf - mono_generic_trampoline_code) <= 256);
- }
+ if (code_len)
+ *code_len = buf - code;
+
+ return code;
+}
- code = buf = g_malloc (16);
- x86_push_imm (buf, method);
- x86_jump_code (buf, mono_generic_trampoline_code);
- g_assert ((buf - code) <= 16);
+void
+mono_arch_invalidate_method (MonoJitInfo *ji, void *func, gpointer func_arg)
+{
+ /* FIXME: This is not thread safe */
+ guint8 *code = ji->code_start;
- /* store trampoline address */
- method->info = code;
+ x86_push_imm (code, func_arg);
+ x86_call_code (code, (guint8*)func);
+}
- mono_jit_stats.method_trampolines++;
+/*
+ * This method is only called when running in the Mono Debugger.
+ */
+gpointer
+mono_debugger_create_notification_function (gpointer *notification_address)
+{
+ guint8 *ptr, *buf;
- return code;
+ ptr = buf = mono_global_codeman_reserve (16);
+
+ x86_breakpoint (buf);
+ if (notification_address)
+ *notification_address = buf;
+ x86_ret (buf);
+
+ return ptr;
}