Wed Feb 22 10:31:25 CET 2006 Paolo Molaro <lupus@ximian.com>
[mono.git] / 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 {
81                 printf ("Invalid trampoline sequence: %x %x %x %x %x %x %x\n", code [0], code [1], code [2], code [3],
82                                 code [4], code [5], code [6]);
83                 g_assert_not_reached ();
84         }
85 }
86
87 void
88 mono_arch_nullify_class_init_trampoline (guint8 *code, gssize *regs)
89 {
90         code -= 5;
91         if (code [0] == 0xe8) {
92                 if (!mono_running_on_valgrind ()) {
93                         guint32 ops;
94                         /*
95                          * Thread safe code patching using the algorithm from the paper
96                          * 'Practicing JUDO: Java Under Dynamic Optimizations'
97                          */
98                         /* 
99                          * First atomically change the the first 2 bytes of the call to a
100                          * spinning jump.
101                          */
102                         ops = 0xfeeb;
103                         InterlockedExchange ((gint32*)code, ops);
104
105                         /* Then change the other bytes to a nop */
106                         code [2] = 0x90;
107                         code [3] = 0x90;
108                         code [4] = 0x90;
109
110                         /* Then atomically change the first 4 bytes to a nop as well */
111                         ops = 0x90909090;
112                         InterlockedExchange ((gint32*)code, ops);
113 #ifdef HAVE_VALGRIND_MEMCHECK_H
114                         /* FIXME: the calltree skin trips on the self modifying code above */
115
116                         /* Tell valgrind to recompile the patched code */
117                         //VALGRIND_DISCARD_TRANSLATIONS (code, code + 8);
118 #endif
119                 }
120         } else if (code [0] == 0x90 || code [0] == 0xeb) {
121                 /* Already changed by another thread */
122                 ;
123         } else if ((code [-1] == 0xff) && (x86_modrm_reg (code [0]) == 0x2)) {
124                 /* call *<OFFSET>(<REG>) -> Call made from AOT code */
125                 gpointer *vtable_slot;
126
127                 vtable_slot = mono_arch_get_vcall_slot_addr (code + 5, (gpointer*)regs);
128                 g_assert (vtable_slot);
129
130                 *vtable_slot = nullified_class_init_trampoline;
131         } else {
132                         printf ("Invalid trampoline sequence: %x %x %x %x %x %x %x\n", code [0], code [1], code [2], code [3],
133                                 code [4], code [5], code [6]);
134                         g_assert_not_reached ();
135                 }
136 }
137
138 void
139 mono_arch_patch_delegate_trampoline (guint8 *code, guint8 *tramp, gssize *regs, guint8 *addr)
140 {
141         guint32 reg;
142         guint32 disp;
143
144         if ((code [-3] == 0xff) && (x86_modrm_reg (code [-2]) == 0x2) && (x86_modrm_mod (code [-2]) == 0x1)) {
145                 /* call *[reg+disp8] */
146                 reg = x86_modrm_rm (code [-2]);
147                 disp = *(guint8*)(code - 1);
148                 //printf ("B: [%%r%d+0x%x]\n", reg, disp);
149         }
150         else {
151                 int i;
152
153                 for (i = -16; i < 0; ++i)
154                         printf ("%d ", code [i]);
155                 printf ("\n");
156                 g_assert_not_reached ();
157         }
158
159         *(gpointer*)(((guint32)(regs [reg])) + disp) = addr;
160 }
161
162 guchar*
163 mono_arch_create_trampoline_code (MonoTrampolineType tramp_type)
164 {
165         guint8 *buf, *code;
166
167         code = buf = mono_global_codeman_reserve (256);
168
169         /* Put all registers into an array on the stack */
170         x86_push_reg (buf, X86_EDI);
171         x86_push_reg (buf, X86_ESI);
172         x86_push_reg (buf, X86_EBP);
173         x86_push_reg (buf, X86_ESP);
174         x86_push_reg (buf, X86_EBX);
175         x86_push_reg (buf, X86_EDX);
176         x86_push_reg (buf, X86_ECX);
177         x86_push_reg (buf, X86_EAX);
178
179         /* save LMF begin */
180
181         /* save the IP (caller ip) */
182         if (tramp_type == MONO_TRAMPOLINE_JUMP)
183                 x86_push_imm (buf, 0);
184         else
185                 x86_push_membase (buf, X86_ESP, 8 * 4 + 4);
186
187         x86_push_reg (buf, X86_EBP);
188         x86_push_reg (buf, X86_ESI);
189         x86_push_reg (buf, X86_EDI);
190         x86_push_reg (buf, X86_EBX);
191
192         /* save method info */
193         x86_push_membase (buf, X86_ESP, 13 * 4);
194         /* get the address of lmf for the current thread */
195         x86_call_code (buf, mono_get_lmf_addr);
196         /* push lmf */
197         x86_push_reg (buf, X86_EAX); 
198         /* push *lfm (previous_lmf) */
199         x86_push_membase (buf, X86_EAX, 0);
200         /* *(lmf) = ESP */
201         x86_mov_membase_reg (buf, X86_EAX, 0, X86_ESP, 4);
202         /* save LFM end */
203
204         /* FIXME: Push the trampoline address */
205         x86_push_imm (buf, 0);
206
207         /* push the method info */
208         x86_push_membase (buf, X86_ESP, 17 * 4);
209         /* push the return address onto the stack */
210         if (tramp_type == MONO_TRAMPOLINE_JUMP)
211                 x86_push_imm (buf, 0);
212         else
213                 x86_push_membase (buf, X86_ESP, 18 * 4 + 4);
214         /* push the address of the register array */
215         x86_lea_membase (buf, X86_EAX, X86_ESP, 11 * 4);
216         x86_push_reg (buf, X86_EAX);
217
218         if (tramp_type == MONO_TRAMPOLINE_CLASS_INIT)
219                 x86_call_code (buf, mono_class_init_trampoline);
220         else if (tramp_type == MONO_TRAMPOLINE_AOT)
221                 x86_call_code (buf, mono_aot_trampoline);
222         else if (tramp_type == MONO_TRAMPOLINE_DELEGATE)
223                 x86_call_code (buf, mono_delegate_trampoline);
224         else
225                 x86_call_code (buf, mono_magic_trampoline);
226         x86_alu_reg_imm (buf, X86_ADD, X86_ESP, 4*4);
227
228         /* restore LMF start */
229         /* ebx = previous_lmf */
230         x86_pop_reg (buf, X86_EBX);
231         /* edi = lmf */
232         x86_pop_reg (buf, X86_EDI);
233         /* *(lmf) = previous_lmf */
234         x86_mov_membase_reg (buf, X86_EDI, 0, X86_EBX, 4);
235         /* discard method info */
236         x86_pop_reg (buf, X86_ESI);
237         /* restore caller saved regs */
238         x86_pop_reg (buf, X86_EBX);
239         x86_pop_reg (buf, X86_EDI);
240         x86_pop_reg (buf, X86_ESI);
241         x86_pop_reg (buf, X86_EBP);
242
243         /* discard save IP */
244         x86_alu_reg_imm (buf, X86_ADD, X86_ESP, 4);             
245         /* restore LMF end */
246
247         /* Restore caller saved registers */
248         x86_mov_reg_membase (buf, X86_ECX, X86_ESP, 1 * 4, 4);
249         x86_mov_reg_membase (buf, X86_EDX, X86_ESP, 2 * 4, 4);
250
251         /* Pop saved reg array + method ptr */
252         x86_alu_reg_imm (buf, X86_ADD, X86_ESP, 9 * 4);
253
254         if (tramp_type == MONO_TRAMPOLINE_CLASS_INIT)
255                 x86_ret (buf);
256         else
257                 /* call the compiled method */
258                 x86_jump_reg (buf, X86_EAX);
259
260         g_assert ((buf - code) <= 256);
261
262         if (tramp_type == MONO_TRAMPOLINE_CLASS_INIT) {
263                 /* Initialize the nullified class init trampoline used in the AOT case */
264                 nullified_class_init_trampoline = buf = mono_global_codeman_reserve (16);
265                 x86_ret (buf);
266         }
267
268         return code;
269 }
270
271 #define TRAMPOLINE_SIZE 10
272
273 gpointer
274 mono_arch_create_specific_trampoline (gpointer arg1, MonoTrampolineType tramp_type, MonoDomain *domain, guint32 *code_len)
275 {
276         guint8 *code, *buf, *tramp;
277         
278         tramp = mono_get_trampoline_code (tramp_type);
279
280         mono_domain_lock (domain);
281         code = buf = mono_code_manager_reserve (domain->code_mp, TRAMPOLINE_SIZE);
282         mono_domain_unlock (domain);
283
284         x86_push_imm (buf, arg1);
285         x86_jump_code (buf, tramp);
286         g_assert ((buf - code) <= TRAMPOLINE_SIZE);
287
288         mono_arch_flush_icache (code, buf - code);
289
290         mono_jit_stats.method_trampolines++;
291
292         if (code_len)
293                 *code_len = buf - code;
294
295         return code;
296 }
297
298 void
299 mono_arch_invalidate_method (MonoJitInfo *ji, void *func, gpointer func_arg)
300 {
301         /* FIXME: This is not thread safe */
302         guint8 *code = ji->code_start;
303
304         x86_push_imm (code, func_arg);
305         x86_call_code (code, (guint8*)func);
306 }
307
308 /*
309  * This method is only called when running in the Mono Debugger.
310  */
311 void
312 mono_debugger_create_notification_function (gpointer notification_address)
313 {
314         guint8 *buf = notification_address;
315
316         x86_breakpoint (buf);
317         x86_ret (buf);
318 }