1 /*------------------------------------------------------------------*/
3 /* Name - tramp-s390x.c */
5 /* Function - JIT trampoline code for S/390. */
7 /* Name - Neale Ferguson (Neale.Ferguson@SoftwareAG-usa.com) */
9 /* Date - January, 2004 */
11 /* Derivation - From exceptions-x86 & exceptions-ppc */
12 /* Paolo Molaro (lupus@ximian.com) */
13 /* Dietmar Maurer (dietmar@ximian.com) */
15 /* Copyright - 2001 Ximian, Inc. */
17 /*------------------------------------------------------------------*/
19 /*------------------------------------------------------------------*/
21 /*------------------------------------------------------------------*/
23 #define GR_SAVE_SIZE 4*sizeof(long)
24 #define FP_SAVE_SIZE 16*sizeof(double)
25 #define METHOD_SAVE_OFFSET S390_MINIMAL_STACK_SIZE
26 #define CREATE_GR_OFFSET METHOD_SAVE_OFFSET+8
27 #define CREATE_FP_OFFSET CREATE_GR_OFFSET+GR_SAVE_SIZE
28 #define CREATE_LMF_OFFSET CREATE_FP_OFFSET+FP_SAVE_SIZE
29 #define CREATE_STACK_SIZE (CREATE_LMF_OFFSET+2*sizeof(long)+sizeof(MonoLMF))
30 #define GENERIC_REG_OFFSET CREATE_STACK_SIZE + \
31 S390_REG_SAVE_OFFSET + \
34 /*------------------------------------------------------------------*/
35 /* Method-specific trampoline code fragment sizes */
36 /*------------------------------------------------------------------*/
37 #define SPECIFIC_TRAMPOLINE_SIZE 96
39 /*========================= End of Defines =========================*/
41 /*------------------------------------------------------------------*/
43 /*------------------------------------------------------------------*/
49 #include <mono/metadata/appdomain.h>
50 #include <mono/metadata/marshal.h>
51 #include <mono/metadata/tabledefs.h>
52 #include <mono/arch/s390x/s390x-codegen.h>
55 #include "mini-s390x.h"
57 /*========================= End of Includes ========================*/
59 /*------------------------------------------------------------------*/
61 /*------------------------------------------------------------------*/
63 /*========================= End of Typedefs ========================*/
65 /*------------------------------------------------------------------*/
66 /* P r o t o t y p e s */
67 /*------------------------------------------------------------------*/
69 /*========================= End of Prototypes ======================*/
71 /*------------------------------------------------------------------*/
72 /* G l o b a l V a r i a b l e s */
73 /*------------------------------------------------------------------*/
76 /*====================== End of Global Variables ===================*/
78 /*------------------------------------------------------------------*/
80 /* Name - mono_arch_get_unbox_trampoline */
82 /* Function - Return a pointer to a trampoline which does the */
83 /* unboxing before calling the method. */
85 /* When value type methods are called through the */
86 /* vtable we need to unbox the 'this' argument. */
88 /* Parameters - method - Methd pointer */
89 /* addr - Pointer to native code for method */
91 /*------------------------------------------------------------------*/
94 mono_arch_get_unbox_trampoline (MonoMethod *method, gpointer addr)
97 int this_pos = s390_r2;
98 MonoDomain *domain = mono_domain_get ();
100 start = code = mono_domain_code_reserve (domain, 28);
102 s390_basr (code, s390_r1, 0);
104 s390_llong(code, addr);
105 s390_lg (code, s390_r1, 0, s390_r1, 4);
106 s390_aghi (code, this_pos, sizeof(MonoObject));
107 s390_br (code, s390_r1);
109 g_assert ((code - start) <= 28);
111 mono_arch_flush_icache (start, code - start);
116 /*========================= End of Function ========================*/
118 /*------------------------------------------------------------------*/
120 /* Name - mono_arch_patch_callsite */
122 /* Function - Patch a non-virtual callsite so it calls @addr. */
124 /*------------------------------------------------------------------*/
127 mono_arch_patch_callsite (guint8 *method_start, guint8 *orig_code, guint8 *addr)
130 unsigned short opcode;
132 opcode = *((unsigned short *) (orig_code - 6));
133 if (opcode == 0xc0e5) {
134 /* This is the 'brasl' instruction */
136 displace = ((gssize) addr - (gssize) (orig_code - 2)) / 2;
137 s390_patch_rel (orig_code, displace);
138 mono_arch_flush_icache (orig_code, 4);
140 /* This should be a 'lg %r14,4(%r13)' then a 'basr r14, r14' instruction */
141 g_assert (orig_code [-8] == 0xe3);
142 g_assert (orig_code [-7] == 0xe0);
143 g_assert (orig_code [-6] == 0xd0);
144 g_assert (orig_code [-5] == 0x04);
145 g_assert (orig_code [-4] == 0x00);
146 g_assert (orig_code [-3] == 0x04);
147 opcode = *((unsigned short*) (orig_code - 2));
148 g_assert (opcode == 0x0dee);
150 /* The call address is stored in the 8 bytes preceeding the basr instruction */
151 s390_patch_addr(orig_code - 16, (gssize)addr);
152 mono_arch_flush_icache (orig_code - 16, 8);
156 /*========================= End of Function ========================*/
158 /*------------------------------------------------------------------*/
160 /* Name - mono_arch_patch_plt_entry. */
162 /* Function - Patch a PLT entry - unused as yet. */
164 /*------------------------------------------------------------------*/
167 mono_arch_patch_plt_entry (guint8 *code, gpointer *got, mgreg_t *regs, guint8 *addr)
169 g_assert_not_reached ();
172 /*========================= End of Function ========================*/
174 /*------------------------------------------------------------------*/
176 /* Name - mono_arch_nullify_class_init_trampoline */
178 /* Function - Nullify a call which calls a class init trampoline*/
180 /*------------------------------------------------------------------*/
183 mono_arch_nullify_class_init_trampoline (guint8 *code, mgreg_t *regs)
185 char patch[2] = {0x07, 0x00};
189 memcpy(code, patch, sizeof(patch));
192 /*========================= End of Function ========================*/
194 /*------------------------------------------------------------------*/
196 /* Name - mono_arch_nullify_plt_entry */
198 /* Function - Nullify a PLT entry call. */
200 /*------------------------------------------------------------------*/
203 mono_arch_nullify_plt_entry (guint8 *code, mgreg_t *regs)
205 g_assert_not_reached ();
208 /*========================= End of Function ========================*/
210 /*------------------------------------------------------------------*/
212 /* Name - mono_arch_create_trampoline_code */
214 /* Function - Create the designated type of trampoline according*/
215 /* to the 'tramp_type' parameter. */
217 /*------------------------------------------------------------------*/
220 mono_arch_create_generic_trampoline (MonoTrampolineType tramp_type, MonoTrampInfo **info, gboolean aot)
222 guint8 *buf, *tramp, *code;
223 int i, offset, lmfOffset;
224 GSList *unwind_ops = NULL;
225 MonoJumpInfo *ji = NULL;
229 /* Now we'll create in 'buf' the S/390 trampoline code. This
230 is the trampoline code common to all methods */
232 code = buf = mono_global_codeman_reserve(512);
234 /*-----------------------------------------------------------
235 STEP 0: First create a non-standard function prologue with a
236 stack size big enough to save our registers.
237 -----------------------------------------------------------*/
239 s390_stmg (buf, s390_r6, s390_r15, STK_BASE, S390_REG_SAVE_OFFSET);
240 s390_lgr (buf, s390_r11, s390_r15);
241 s390_aghi (buf, STK_BASE, -CREATE_STACK_SIZE);
242 s390_stg (buf, s390_r11, 0, STK_BASE, 0);
243 s390_stg (buf, s390_r1, 0, STK_BASE, METHOD_SAVE_OFFSET);
244 s390_stmg (buf, s390_r2, s390_r5, STK_BASE, CREATE_GR_OFFSET);
246 /* Save the FP registers */
247 offset = CREATE_FP_OFFSET;
248 for (i = s390_f0; i <= s390_f15; ++i) {
249 s390_std (buf, i, 0, STK_BASE, offset);
253 /*----------------------------------------------------------
254 STEP 1: call 'mono_get_lmf_addr()' to get the address of our
255 LMF. We'll need to restore it after the call to
256 's390_magic_trampoline' and before the call to the native
258 ----------------------------------------------------------*/
260 s390_basr (buf, s390_r13, 0);
262 s390_llong(buf, mono_get_lmf_addr);
263 s390_lg (buf, s390_r1, 0, s390_r13, 4);
264 s390_basr (buf, s390_r14, s390_r1);
266 /*---------------------------------------------------------------*/
267 /* we build the MonoLMF structure on the stack - see mini-s390.h */
268 /* Keep in sync with the code in mono_arch_emit_prolog */
269 /*---------------------------------------------------------------*/
270 lmfOffset = CREATE_STACK_SIZE - sizeof(MonoLMF);
272 s390_lgr (buf, s390_r13, STK_BASE);
273 s390_aghi (buf, s390_r13, lmfOffset);
275 /*---------------------------------------------------------------*/
276 /* Set lmf.lmf_addr = jit_tls->lmf */
277 /*---------------------------------------------------------------*/
278 s390_stg (buf, s390_r2, 0, s390_r13,
279 G_STRUCT_OFFSET(MonoLMF, lmf_addr));
281 /*---------------------------------------------------------------*/
282 /* Get current lmf */
283 /*---------------------------------------------------------------*/
284 s390_lg (buf, s390_r0, 0, s390_r2, 0);
286 /*---------------------------------------------------------------*/
287 /* Set our lmf as the current lmf */
288 /*---------------------------------------------------------------*/
289 s390_stg (buf, s390_r13, 0, s390_r2, 0);
291 /*---------------------------------------------------------------*/
292 /* Have our lmf.previous_lmf point to the last lmf */
293 /*---------------------------------------------------------------*/
294 s390_stg (buf, s390_r0, 0, s390_r13,
295 G_STRUCT_OFFSET(MonoLMF, previous_lmf));
297 /*---------------------------------------------------------------*/
298 /* save method info */
299 /*---------------------------------------------------------------*/
300 s390_lg (buf, s390_r1, 0, STK_BASE, METHOD_SAVE_OFFSET);
301 s390_stg (buf, s390_r1, 0, s390_r13,
302 G_STRUCT_OFFSET(MonoLMF, method));
304 /*---------------------------------------------------------------*/
305 /* save the current SP */
306 /*---------------------------------------------------------------*/
307 s390_lg (buf, s390_r1, 0, STK_BASE, 0);
308 s390_stg (buf, s390_r1, 0, s390_r13, G_STRUCT_OFFSET(MonoLMF, ebp));
310 /*---------------------------------------------------------------*/
311 /* save the current IP */
312 /*---------------------------------------------------------------*/
313 if (tramp_type == MONO_TRAMPOLINE_JUMP) {
314 s390_lghi (buf, s390_r1, 0);
316 s390_lg (buf, s390_r1, 0, s390_r1, S390_RET_ADDR_OFFSET);
317 // s390_la (buf, s390_r1, 0, s390_r1, 0);
319 s390_stg (buf, s390_r1, 0, s390_r13, G_STRUCT_OFFSET(MonoLMF, eip));
321 /*---------------------------------------------------------------*/
322 /* Save general and floating point registers */
323 /*---------------------------------------------------------------*/
324 s390_mvc (buf, 4*sizeof(gulong), s390_r13, G_STRUCT_OFFSET(MonoLMF, gregs[2]),
325 STK_BASE, CREATE_GR_OFFSET);
326 s390_mvc (buf, 10*sizeof(gulong), s390_r13, G_STRUCT_OFFSET(MonoLMF, gregs[6]),
327 s390_r11, S390_REG_SAVE_OFFSET);
329 /* Simply copy fpregs already saved above */
330 s390_mvc (buf, 16*sizeof(double), s390_r13, G_STRUCT_OFFSET(MonoLMF, fregs[0]),
331 STK_BASE, CREATE_FP_OFFSET);
333 /*---------------------------------------------------------------*/
334 /* STEP 2: call the C trampoline function */
335 /*---------------------------------------------------------------*/
339 /* Arg 1: mgreg_t *regs. We pass sp instead */
340 s390_la (buf, s390_r2, 0, STK_BASE, CREATE_STACK_SIZE);
342 /* Arg 2: code (next address to the instruction that called us) */
343 if (tramp_type == MONO_TRAMPOLINE_JUMP) {
344 s390_lghi (buf, s390_r3, 0);
346 s390_lg (buf, s390_r3, 0, s390_r11, S390_RET_ADDR_OFFSET);
349 /* Arg 3: Trampoline argument */
350 if (tramp_type == MONO_TRAMPOLINE_GENERIC_CLASS_INIT)
351 s390_lg (buf, s390_r4, 0, STK_BASE, GENERIC_REG_OFFSET);
353 s390_lg (buf, s390_r4, 0, STK_BASE, METHOD_SAVE_OFFSET);
355 /* Arg 4: trampoline address. Ignore for now */
357 /* Calculate call address and call the C trampoline. Return value will be in r2 */
358 s390_basr (buf, s390_r13, 0);
360 tramp = (guint8*)mono_get_trampoline_func (tramp_type);
361 s390_llong (buf, tramp);
362 s390_lg (buf, s390_r1, 0, s390_r13, 4);
363 s390_basr (buf, s390_r14, s390_r1);
365 /* OK, code address is now on r2. Move it to r1, so that we
366 can restore r2 and use it from r1 later */
367 s390_lgr (buf, s390_r1, s390_r2);
369 /*----------------------------------------------------------
370 STEP 3: Restore the LMF
371 ----------------------------------------------------------*/
372 restoreLMF(buf, STK_BASE, CREATE_STACK_SIZE);
374 /*----------------------------------------------------------
375 STEP 4: call the compiled method
376 ----------------------------------------------------------*/
378 /* Restore registers */
380 s390_lmg (buf, s390_r2, s390_r5, STK_BASE, CREATE_GR_OFFSET);
382 /* Restore the FP registers */
383 offset = CREATE_FP_OFFSET;
384 for (i = s390_f0; i <= s390_f15; ++i) {
385 s390_ld (buf, i, 0, STK_BASE, offset);
389 /* Restore stack pointer and jump to the code -
390 R14 contains the return address to our caller */
391 s390_lgr (buf, STK_BASE, s390_r11);
392 s390_lmg (buf, s390_r6, s390_r14, STK_BASE, S390_REG_SAVE_OFFSET);
394 if (MONO_TRAMPOLINE_TYPE_MUST_RETURN(tramp_type)) {
395 s390_lgr (buf, s390_r2, s390_r1);
396 s390_br (buf, s390_r14);
398 s390_br (buf, s390_r1);
401 /* Flush instruction cache, since we've generated code */
402 mono_arch_flush_icache (code, buf - code);
405 *info = mono_tramp_info_create (mono_get_generic_trampoline_name(tramp_type),
406 buf, buf - code, ji, unwind_ops);
409 g_assert ((buf - code) <= 512);
414 /*========================= End of Function ========================*/
416 /*------------------------------------------------------------------*/
418 /* Name - mono_arch_create_specific_trampoline */
420 /* Function - Creates the given kind of specific trampoline */
422 /*------------------------------------------------------------------*/
425 mono_arch_create_specific_trampoline (gpointer arg1, MonoTrampolineType tramp_type, MonoDomain *domain, guint32 *code_len)
427 guint8 *code, *buf, *tramp;
430 tramp = mono_get_trampoline_code (tramp_type);
432 /*----------------------------------------------------------*/
433 /* This is the method-specific part of the trampoline. Its */
434 /* purpose is to provide the generic part with the */
435 /* MonoMethod *method pointer. We'll use r1 to keep it. */
436 /*----------------------------------------------------------*/
437 code = buf = mono_domain_code_reserve (domain, SPECIFIC_TRAMPOLINE_SIZE);
439 s390_basr (buf, s390_r1, 0);
441 s390_llong(buf, arg1);
442 s390_lg (buf, s390_r1, 0, s390_r1, 4);
443 displace = (tramp - buf) / 2;
444 s390_jg (buf, displace);
446 /* Flush instruction cache, since we've generated code */
447 mono_arch_flush_icache (code, buf - code);
450 g_assert ((buf - code) <= SPECIFIC_TRAMPOLINE_SIZE);
453 *code_len = buf - code;
458 /*========================= End of Function ========================*/
460 /*------------------------------------------------------------------*/
462 /* Name - mono_arch_create_rgctx_lazy_fetch_trampoline */
466 /*------------------------------------------------------------------*/
469 mono_arch_create_rgctx_lazy_fetch_trampoline (guint32 slot, MonoTrampInfo **info, gboolean aot)
471 #ifdef MONO_ARCH_VTABLE_REG
474 guint8 **rgctx_null_jumps;
482 MonoJumpInfo *ji = NULL;
483 GSList *unwind_ops = NULL;
485 mrgctx = MONO_RGCTX_SLOT_IS_MRGCTX (slot);
486 index = MONO_RGCTX_SLOT_INDEX (slot);
488 index += MONO_SIZEOF_METHOD_RUNTIME_GENERIC_CONTEXT / sizeof (gpointer);
489 for (depth = 0; ; ++depth) {
490 int size = mono_class_rgctx_get_array_size (depth, mrgctx);
492 if (index < size - 1)
497 tramp_size = 48 + 16 * depth;
503 code = buf = mono_global_codeman_reserve (tramp_size);
505 unwind_ops = mono_arch_get_cie_program ();
507 rgctx_null_jumps = g_malloc (sizeof (guint8*) * (depth + 2));
511 s390_lgr (code, s390_r1, s390_r2);
513 /* load rgctx ptr from vtable */
514 s390_lg (code, s390_r1, 0, s390_r2, G_STRUCT_OFFSET(MonoVTable, runtime_generic_context));
515 /* is the rgctx ptr null? */
516 s390_ltgr (code, s390_r1, s390_r1);
517 /* if yes, jump to actual trampoline */
518 rgctx_null_jumps [iPatch++] = code;
522 for (i = 0; i < depth; ++i) {
523 /* load ptr to next array */
524 if (mrgctx && i == 0)
525 s390_lg (code, s390_r1, 0, s390_r1, MONO_SIZEOF_METHOD_RUNTIME_GENERIC_CONTEXT);
527 s390_lg (code, s390_r1, 0, s390_r1, 0);
528 s390_ltgr (code, s390_r1, s390_r1);
529 /* if the ptr is null then jump to actual trampoline */
530 rgctx_null_jumps [iPatch++] = code;
535 s390_lg (code, s390_r1, 0, s390_r1, (sizeof (gpointer) * (index + 1)));
536 /* is the slot null? */
537 s390_ltgr (code, s390_r1, s390_r1);
538 /* if yes, jump to actual trampoline */
539 rgctx_null_jumps [iPatch++] = code;
541 /* otherwise return r1 */
542 s390_lgr (code, s390_r2, s390_r1);
543 s390_br (code, s390_r14);
545 for (i = 0; i < iPatch; i++) {
546 displace = ((uintptr_t) code - (uintptr_t) rgctx_null_jumps[i]) / 2;
547 s390_patch_rel ((rgctx_null_jumps [i] + 2), displace);
550 g_free (rgctx_null_jumps);
552 /* move the rgctx pointer to the VTABLE register */
553 s390_lgr (code, MONO_ARCH_VTABLE_REG, s390_r2);
555 tramp = mono_arch_create_specific_trampoline (GUINT_TO_POINTER (slot),
556 MONO_TRAMPOLINE_RGCTX_LAZY_FETCH, mono_get_root_domain (), NULL);
558 /* jump to the actual trampoline */
559 displace = (tramp - code) / 2;
560 s390_jg (code, displace);
562 mono_arch_flush_icache (buf, code - buf);
564 g_assert (code - buf <= tramp_size);
567 char *name = mono_get_rgctx_fetch_trampoline_name (slot);
568 *info = mono_tramp_info_create (name, buf, code - buf, ji, unwind_ops);
574 g_assert_not_reached ();
579 /*========================= End of Function ========================*/
581 /*------------------------------------------------------------------*/
583 /* Name - mono_arch_get_static_rgctx_trampoline */
585 /* Function - Create a trampoline which sets RGCTX_REG to MRGCTX*/
586 /* then jumps to ADDR. */
588 /*------------------------------------------------------------------*/
591 mono_arch_get_static_rgctx_trampoline (MonoMethod *m,
592 MonoMethodRuntimeGenericContext *mrgctx,
595 guint8 *code, *start;
599 MonoDomain *domain = mono_domain_get ();
603 start = code = mono_domain_code_reserve (domain, buf_len);
605 s390_basr (code, s390_r1, 0);
607 s390_llong(code, mrgctx);
608 s390_lg (code, MONO_ARCH_RGCTX_REG, 0, s390_r1, 4);
609 displace = ((uintptr_t) addr - (uintptr_t) code) / 2;
610 s390_jg (code, displace);
611 g_assert ((code - start) < buf_len);
613 mono_arch_flush_icache (start, code - start);
618 /*========================= End of Function ========================*/
620 /*------------------------------------------------------------------*/
622 /* Name - mono_arch_create_generic_class_init_trampoline */
626 /*------------------------------------------------------------------*/
629 mono_arch_create_generic_class_init_trampoline (MonoTrampInfo **info, gboolean aot)
633 static int byte_offset = -1;
634 static guint8 bitmask;
638 GSList *unwind_ops = NULL;
639 MonoJumpInfo *ji = NULL;
643 code = buf = mono_global_codeman_reserve (tramp_size);
645 unwind_ops = mono_arch_get_cie_program ();
648 mono_marshal_find_bitfield_offset (MonoVTable, initialized, &byte_offset, &bitmask);
650 s390_llgc(code, s390_r0, 0, MONO_ARCH_VTABLE_REG, byte_offset);
651 s390_nill(code, s390_r0, bitmask);
652 s390_bnzr(code, s390_r14);
654 tramp = mono_arch_create_specific_trampoline (NULL, MONO_TRAMPOLINE_GENERIC_CLASS_INIT,
655 mono_get_root_domain (), NULL);
657 /* jump to the actual trampoline */
658 displace = (tramp - code) / 2;
659 s390_jg (code, displace);
661 mono_arch_flush_icache (buf, code - buf);
663 g_assert (code - buf <= tramp_size);
666 *info = mono_tramp_info_create ("generic_class_init_trampoline", buf, code - buf, ji, unwind_ops);
671 /*========================= End of Function ========================*/