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/abi-details.h>
50 #include <mono/metadata/appdomain.h>
51 #include <mono/metadata/marshal.h>
52 #include <mono/metadata/tabledefs.h>
53 #include <mono/arch/s390x/s390x-codegen.h>
56 #include "mini-s390x.h"
57 #include "support-s390x.h"
59 /*========================= End of Includes ========================*/
61 /*------------------------------------------------------------------*/
63 /*------------------------------------------------------------------*/
65 /*========================= End of Typedefs ========================*/
67 /*------------------------------------------------------------------*/
68 /* P r o t o t y p e s */
69 /*------------------------------------------------------------------*/
71 /*========================= End of Prototypes ======================*/
73 /*------------------------------------------------------------------*/
74 /* G l o b a l V a r i a b l e s */
75 /*------------------------------------------------------------------*/
78 /*====================== End of Global Variables ===================*/
80 /*------------------------------------------------------------------*/
82 /* Name - mono_arch_get_unbox_trampoline */
84 /* Function - Return a pointer to a trampoline which does the */
85 /* unboxing before calling the method. */
87 /* When value type methods are called through the */
88 /* vtable we need to unbox the 'this' argument. */
90 /* Parameters - method - Methd pointer */
91 /* addr - Pointer to native code for method */
93 /*------------------------------------------------------------------*/
96 mono_arch_get_unbox_trampoline (MonoMethod *method, gpointer addr)
99 int this_pos = s390_r2;
100 MonoDomain *domain = mono_domain_get ();
102 start = code = mono_domain_code_reserve (domain, 28);
104 S390_SET (code, s390_r1, addr);
105 s390_aghi (code, this_pos, sizeof(MonoObject));
106 s390_br (code, s390_r1);
108 g_assert ((code - start) <= 28);
110 mono_arch_flush_icache (start, code - start);
115 /*========================= End of Function ========================*/
117 /*------------------------------------------------------------------*/
119 /* Name - mono_arch_patch_callsite */
121 /* Function - Patch a non-virtual callsite so it calls @addr. */
123 /*------------------------------------------------------------------*/
126 mono_arch_patch_callsite (guint8 *method_start, guint8 *orig_code, guint8 *addr)
129 unsigned short opcode;
131 opcode = *((unsigned short *) (orig_code - 2));
132 if (opcode == 0x0dee) {
133 /* This should be a 'iihf/iilf' sequence */
134 S390_EMIT_CALL((orig_code - 14), addr);
135 mono_arch_flush_icache (orig_code - 14, 12);
137 fprintf(stderr, "%p %02x %02x %02x %02x\n",
138 &orig_code[-14], orig_code[-12], orig_code[-11], orig_code[-6], orig_code[-5]);
140 /* This is the 'brasl' instruction */
142 displace = ((gssize) addr - (gssize) (orig_code - 2)) / 2;
143 s390_patch_rel (orig_code, displace);
144 mono_arch_flush_icache (orig_code, 4);
148 /*========================= End of Function ========================*/
150 /*------------------------------------------------------------------*/
152 /* Name - mono_arch_patch_plt_entry. */
154 /* Function - Patch a PLT entry - unused as yet. */
156 /*------------------------------------------------------------------*/
159 mono_arch_patch_plt_entry (guint8 *code, gpointer *got, mgreg_t *regs, guint8 *addr)
161 g_assert_not_reached ();
164 /*========================= End of Function ========================*/
166 /*------------------------------------------------------------------*/
168 /* Name - mono_arch_nullify_class_init_trampoline */
170 /* Function - Nullify a call which calls a class init trampoline*/
172 /*------------------------------------------------------------------*/
175 mono_arch_nullify_class_init_trampoline (guint8 *code, mgreg_t *regs)
177 char patch[2] = {0x07, 0x00};
181 memcpy(code, patch, sizeof(patch));
184 /*========================= End of Function ========================*/
186 /*------------------------------------------------------------------*/
188 /* Name - mono_arch_get_nullified_class_init */
190 /* Function - Nullify a PLT entry call. */
192 /*------------------------------------------------------------------*/
195 mono_arch_get_nullified_class_init_trampoline (MonoTrampInfo **info)
199 code = buf = mono_global_codeman_reserve (16);
201 s390_br (code, s390_r14);
204 *info = mono_tramp_info_create ("nullified_class_init_trampoline",
205 buf, code - buf, NULL, NULL);
210 /*========================= End of Function ========================*/
212 /*------------------------------------------------------------------*/
214 /* Name - mono_arch_create_trampoline_code */
216 /* Function - Create the designated type of trampoline according*/
217 /* to the 'tramp_type' parameter. */
219 /*------------------------------------------------------------------*/
222 mono_arch_create_generic_trampoline (MonoTrampolineType tramp_type, MonoTrampInfo **info, gboolean aot)
225 guint8 *buf, *tramp, *code;
226 int i, offset, lmfOffset, has_caller;
227 GSList *unwind_ops = NULL;
228 MonoJumpInfo *ji = NULL;
232 /* Now we'll create in 'buf' the S/390 trampoline code. This
233 is the trampoline code common to all methods */
235 code = buf = mono_global_codeman_reserve(512);
237 if ((tramp_type == MONO_TRAMPOLINE_JUMP) ||
238 (tramp_type == MONO_TRAMPOLINE_HANDLER_BLOCK_GUARD))
243 /*-----------------------------------------------------------
244 STEP 0: First create a non-standard function prologue with a
245 stack size big enough to save our registers.
246 -----------------------------------------------------------*/
248 s390_stmg (buf, s390_r6, s390_r15, STK_BASE, S390_REG_SAVE_OFFSET);
249 s390_lgr (buf, s390_r11, s390_r15);
250 s390_aghi (buf, STK_BASE, -CREATE_STACK_SIZE);
251 s390_stg (buf, s390_r11, 0, STK_BASE, 0);
252 s390_stg (buf, s390_r1, 0, STK_BASE, METHOD_SAVE_OFFSET);
253 s390_stmg (buf, s390_r2, s390_r5, STK_BASE, CREATE_GR_OFFSET);
255 /* Save the FP registers */
256 offset = CREATE_FP_OFFSET;
257 for (i = s390_f0; i <= s390_f15; ++i) {
258 s390_std (buf, i, 0, STK_BASE, offset);
262 /*----------------------------------------------------------
263 STEP 1: call 'mono_get_lmf_addr()' to get the address of our
264 LMF. We'll need to restore it after the call to
265 's390_magic_trampoline' and before the call to the native
267 ----------------------------------------------------------*/
269 S390_SET (buf, s390_r1, mono_get_lmf_addr);
270 s390_basr (buf, s390_r14, s390_r1);
272 /*---------------------------------------------------------------*/
273 /* we build the MonoLMF structure on the stack - see mini-s390.h */
274 /* Keep in sync with the code in mono_arch_emit_prolog */
275 /*---------------------------------------------------------------*/
276 lmfOffset = CREATE_STACK_SIZE - sizeof(MonoLMF);
278 s390_lgr (buf, s390_r13, STK_BASE);
279 s390_aghi (buf, s390_r13, lmfOffset);
281 /*---------------------------------------------------------------*/
282 /* Set lmf.lmf_addr = jit_tls->lmf */
283 /*---------------------------------------------------------------*/
284 s390_stg (buf, s390_r2, 0, s390_r13,
285 G_STRUCT_OFFSET(MonoLMF, lmf_addr));
287 /*---------------------------------------------------------------*/
288 /* Get current lmf */
289 /*---------------------------------------------------------------*/
290 s390_lg (buf, s390_r0, 0, s390_r2, 0);
292 /*---------------------------------------------------------------*/
293 /* Set our lmf as the current lmf */
294 /*---------------------------------------------------------------*/
295 s390_stg (buf, s390_r13, 0, s390_r2, 0);
297 /*---------------------------------------------------------------*/
298 /* Have our lmf.previous_lmf point to the last lmf */
299 /*---------------------------------------------------------------*/
300 s390_stg (buf, s390_r0, 0, s390_r13,
301 G_STRUCT_OFFSET(MonoLMF, previous_lmf));
303 /*---------------------------------------------------------------*/
304 /* save method info */
305 /*---------------------------------------------------------------*/
306 s390_lg (buf, s390_r1, 0, STK_BASE, METHOD_SAVE_OFFSET);
307 s390_stg (buf, s390_r1, 0, s390_r13,
308 G_STRUCT_OFFSET(MonoLMF, method));
310 /*---------------------------------------------------------------*/
311 /* save the current SP */
312 /*---------------------------------------------------------------*/
313 s390_lg (buf, s390_r1, 0, STK_BASE, 0);
314 s390_stg (buf, s390_r1, 0, s390_r13, G_STRUCT_OFFSET(MonoLMF, ebp));
316 /*---------------------------------------------------------------*/
317 /* save the current IP */
318 /*---------------------------------------------------------------*/
320 s390_lg (buf, s390_r1, 0, s390_r1, S390_RET_ADDR_OFFSET);
322 s390_lghi (buf, s390_r1, 0);
324 s390_stg (buf, s390_r1, 0, s390_r13, G_STRUCT_OFFSET(MonoLMF, eip));
326 /*---------------------------------------------------------------*/
327 /* Save general and floating point registers */
328 /*---------------------------------------------------------------*/
329 s390_mvc (buf, 4*sizeof(gulong), s390_r13, G_STRUCT_OFFSET(MonoLMF, gregs[2]),
330 STK_BASE, CREATE_GR_OFFSET);
331 s390_mvc (buf, 10*sizeof(gulong), s390_r13, G_STRUCT_OFFSET(MonoLMF, gregs[6]),
332 s390_r11, S390_REG_SAVE_OFFSET);
334 /* Simply copy fpregs already saved above */
335 s390_mvc (buf, 16*sizeof(double), s390_r13, G_STRUCT_OFFSET(MonoLMF, fregs[0]),
336 STK_BASE, CREATE_FP_OFFSET);
338 /*---------------------------------------------------------------*/
339 /* STEP 2: call the C trampoline function */
340 /*---------------------------------------------------------------*/
344 /* Arg 1: mgreg_t *regs. We pass sp instead */
345 s390_la (buf, s390_r2, 0, STK_BASE, CREATE_STACK_SIZE);
347 /* Arg 2: code (next address to the instruction that called us) */
349 s390_lg (buf, s390_r3, 0, s390_r11, S390_RET_ADDR_OFFSET);
351 s390_lghi (buf, s390_r3, 0);
354 /* Arg 3: Trampoline argument */
355 if (tramp_type == MONO_TRAMPOLINE_GENERIC_CLASS_INIT)
356 s390_lg (buf, s390_r4, 0, STK_BASE, GENERIC_REG_OFFSET);
358 s390_lg (buf, s390_r4, 0, STK_BASE, METHOD_SAVE_OFFSET);
360 /* Arg 4: trampoline address. Ignore for now */
362 /* Calculate call address and call the C trampoline. Return value will be in r2 */
363 tramp = (guint8*)mono_get_trampoline_func (tramp_type);
364 S390_SET (buf, s390_r1, tramp);
365 s390_basr (buf, s390_r14, s390_r1);
367 /* OK, code address is now on r2. Move it to r1, so that we
368 can restore r2 and use it from r1 later */
369 s390_lgr (buf, s390_r1, s390_r2);
371 /*----------------------------------------------------------
372 STEP 3: Restore the LMF
373 ----------------------------------------------------------*/
374 restoreLMF(buf, STK_BASE, CREATE_STACK_SIZE);
376 /*----------------------------------------------------------
377 STEP 4: call the compiled method
378 ----------------------------------------------------------*/
380 /* Restore registers */
382 s390_lmg (buf, s390_r2, s390_r5, STK_BASE, CREATE_GR_OFFSET);
384 /* Restore the FP registers */
385 offset = CREATE_FP_OFFSET;
386 for (i = s390_f0; i <= s390_f15; ++i) {
387 s390_ld (buf, i, 0, STK_BASE, offset);
391 /* Restore stack pointer and jump to the code -
392 R14 contains the return address to our caller */
393 s390_lgr (buf, STK_BASE, s390_r11);
394 s390_lmg (buf, s390_r6, s390_r14, STK_BASE, S390_REG_SAVE_OFFSET);
396 if (MONO_TRAMPOLINE_TYPE_MUST_RETURN(tramp_type)) {
397 s390_lgr (buf, s390_r2, s390_r1);
398 s390_br (buf, s390_r14);
400 s390_br (buf, s390_r1);
403 /* Flush instruction cache, since we've generated code */
404 mono_arch_flush_icache (code, buf - code);
407 tramp_name = mono_get_generic_trampoline_name (tramp_type);
408 *info = mono_tramp_info_create (tramp_name, buf, buf - code, ji, unwind_ops);
413 g_assert ((buf - code) <= 512);
418 /*========================= End of Function ========================*/
420 /*------------------------------------------------------------------*/
422 /* Name - mono_arch_invalidate_method */
426 /*------------------------------------------------------------------*/
429 mono_arch_invalidate_method (MonoJitInfo *ji, void *func, gpointer func_arg)
431 /* FIXME: This is not thread safe */
432 guint8 *code = ji->code_start;
434 S390_SET (code, s390_r1, func);
435 S390_SET (code, s390_r2, func_arg);
436 s390_br (code, s390_r1);
440 /*========================= End of Function ========================*/
442 /*------------------------------------------------------------------*/
444 /* Name - mono_arch_create_specific_trampoline */
446 /* Function - Creates the given kind of specific trampoline */
448 /*------------------------------------------------------------------*/
451 mono_arch_create_specific_trampoline (gpointer arg1, MonoTrampolineType tramp_type, MonoDomain *domain, guint32 *code_len)
453 guint8 *code, *buf, *tramp;
456 tramp = mono_get_trampoline_code (tramp_type);
458 /*----------------------------------------------------------*/
459 /* This is the method-specific part of the trampoline. Its */
460 /* purpose is to provide the generic part with the */
461 /* MonoMethod *method pointer. We'll use r1 to keep it. */
462 /*----------------------------------------------------------*/
463 code = buf = mono_domain_code_reserve (domain, SPECIFIC_TRAMPOLINE_SIZE);
465 S390_SET (buf, s390_r1, arg1);
466 displace = (tramp - buf) / 2;
467 s390_jg (buf, displace);
469 /* Flush instruction cache, since we've generated code */
470 mono_arch_flush_icache (code, buf - code);
473 g_assert ((buf - code) <= SPECIFIC_TRAMPOLINE_SIZE);
476 *code_len = buf - code;
481 /*========================= End of Function ========================*/
483 /*------------------------------------------------------------------*/
485 /* Name - mono_arch_create_rgctx_lazy_fetch_trampoline */
489 /*------------------------------------------------------------------*/
492 mono_arch_create_rgctx_lazy_fetch_trampoline (guint32 slot, MonoTrampInfo **info, gboolean aot)
494 #ifdef MONO_ARCH_VTABLE_REG
497 guint8 **rgctx_null_jumps;
505 MonoJumpInfo *ji = NULL;
506 GSList *unwind_ops = NULL;
508 mrgctx = MONO_RGCTX_SLOT_IS_MRGCTX (slot);
509 index = MONO_RGCTX_SLOT_INDEX (slot);
511 index += MONO_SIZEOF_METHOD_RUNTIME_GENERIC_CONTEXT / sizeof (gpointer);
512 for (depth = 0; ; ++depth) {
513 int size = mono_class_rgctx_get_array_size (depth, mrgctx);
515 if (index < size - 1)
520 tramp_size = 48 + 16 * depth;
526 code = buf = mono_global_codeman_reserve (tramp_size);
528 unwind_ops = mono_arch_get_cie_program ();
530 rgctx_null_jumps = g_malloc (sizeof (guint8*) * (depth + 2));
534 s390_lgr (code, s390_r1, s390_r2);
536 /* load rgctx ptr from vtable */
537 s390_lg (code, s390_r1, 0, s390_r2, MONO_STRUCT_OFFSET(MonoVTable, runtime_generic_context));
538 /* is the rgctx ptr null? */
539 s390_ltgr (code, s390_r1, s390_r1);
540 /* if yes, jump to actual trampoline */
541 rgctx_null_jumps [iPatch++] = code;
545 for (i = 0; i < depth; ++i) {
546 /* load ptr to next array */
547 if (mrgctx && i == 0)
548 s390_lg (code, s390_r1, 0, s390_r1, MONO_SIZEOF_METHOD_RUNTIME_GENERIC_CONTEXT);
550 s390_lg (code, s390_r1, 0, s390_r1, 0);
551 s390_ltgr (code, s390_r1, s390_r1);
552 /* if the ptr is null then jump to actual trampoline */
553 rgctx_null_jumps [iPatch++] = code;
558 s390_lg (code, s390_r1, 0, s390_r1, (sizeof (gpointer) * (index + 1)));
559 /* is the slot null? */
560 s390_ltgr (code, s390_r1, s390_r1);
561 /* if yes, jump to actual trampoline */
562 rgctx_null_jumps [iPatch++] = code;
564 /* otherwise return r1 */
565 s390_lgr (code, s390_r2, s390_r1);
566 s390_br (code, s390_r14);
568 for (i = 0; i < iPatch; i++) {
569 displace = ((uintptr_t) code - (uintptr_t) rgctx_null_jumps[i]) / 2;
570 s390_patch_rel ((rgctx_null_jumps [i] + 2), displace);
573 g_free (rgctx_null_jumps);
575 /* move the rgctx pointer to the VTABLE register */
576 s390_lgr (code, MONO_ARCH_VTABLE_REG, s390_r2);
578 tramp = mono_arch_create_specific_trampoline (GUINT_TO_POINTER (slot),
579 MONO_TRAMPOLINE_RGCTX_LAZY_FETCH, mono_get_root_domain (), NULL);
581 /* jump to the actual trampoline */
582 displace = (tramp - code) / 2;
583 s390_jg (code, displace);
585 mono_arch_flush_icache (buf, code - buf);
587 g_assert (code - buf <= tramp_size);
590 char *name = mono_get_rgctx_fetch_trampoline_name (slot);
591 *info = mono_tramp_info_create (name, buf, code - buf, ji, unwind_ops);
597 g_assert_not_reached ();
602 /*========================= End of Function ========================*/
604 /*------------------------------------------------------------------*/
606 /* Name - mono_arch_get_static_rgctx_trampoline */
608 /* Function - Create a trampoline which sets RGCTX_REG to MRGCTX*/
609 /* then jumps to ADDR. */
611 /*------------------------------------------------------------------*/
614 mono_arch_get_static_rgctx_trampoline (MonoMethod *m,
615 MonoMethodRuntimeGenericContext *mrgctx,
618 guint8 *code, *start;
622 MonoDomain *domain = mono_domain_get ();
626 start = code = mono_domain_code_reserve (domain, buf_len);
628 S390_SET (code, MONO_ARCH_RGCTX_REG, mrgctx);
629 displace = ((uintptr_t) addr - (uintptr_t) code) / 2;
630 s390_jg (code, displace);
631 g_assert ((code - start) < buf_len);
633 mono_arch_flush_icache (start, code - start);
638 /*========================= End of Function ========================*/
640 /*------------------------------------------------------------------*/
642 /* Name - handler_block_trampoline_helper */
646 /*------------------------------------------------------------------*/
649 handler_block_trampoline_helper (gpointer *ptr)
651 MonoJitTlsData *jit_tls = mono_native_tls_get_value (mono_jit_tls_id);
652 *ptr = jit_tls->handler_block_return_address;
655 /*========================= End of Function ========================*/
657 /*------------------------------------------------------------------*/
659 /* Name - mono_arch_create_handler_block_trampoline */
663 /*------------------------------------------------------------------*/
666 mono_arch_create_handler_block_trampoline (MonoTrampInfo **info, gboolean aot)
668 guint8 *tramp = mono_get_trampoline_code (MONO_TRAMPOLINE_HANDLER_BLOCK_GUARD);
671 MonoJumpInfo *ji = NULL;
672 GSList *unwind_ops = NULL;
676 code = buf = mono_global_codeman_reserve (tramp_size);
679 * This trampoline restore the call chain of the handler block
680 * then jumps into the code that deals with it.
683 if (mono_get_jit_tls_offset () != -1) {
684 s390_ear (code, s390_r1, 0);
685 s390_sllg (code, s390_r1, s390_r1, 0, 32);
686 s390_ear (code, s390_r1, 1);
687 S390_SET (code, s390_r14, mono_get_jit_tls_offset());
688 s390_lg (code, s390_r14, s390_r1, 0, G_STRUCT_OFFSET(MonoJitTlsData, handler_block_return_address));
692 S390_SET (code, s390_r1, tramp);
693 s390_br (code, s390_r1);
696 * Slow path uses a C helper
698 S390_SET (code, s390_r2, tramp);
699 S390_SET (code, s390_r1, handler_block_trampoline_helper);
700 s390_br (code, s390_r1);
703 mono_arch_flush_icache (buf, code - buf);
704 g_assert (code - buf <= tramp_size);
707 *info = mono_tramp_info_create ("handler_block_trampoline", buf, code - buf, ji, unwind_ops);
712 /*========================= End of Function ========================*/
714 /*------------------------------------------------------------------*/
716 /* Name - mono_arch_create_generic_class_init_trampoline */
720 /*------------------------------------------------------------------*/
723 mono_arch_create_generic_class_init_trampoline (MonoTrampInfo **info, gboolean aot)
727 static int byte_offset = -1;
728 static guint8 bitmask;
731 GSList *unwind_ops = NULL;
732 MonoJumpInfo *ji = NULL;
736 code = buf = mono_global_codeman_reserve (tramp_size);
738 unwind_ops = mono_arch_get_cie_program ();
741 mono_marshal_find_bitfield_offset (MonoVTable, initialized, &byte_offset, &bitmask);
743 s390_llgc(code, s390_r0, 0, MONO_ARCH_VTABLE_REG, byte_offset);
744 s390_nill(code, s390_r0, bitmask);
745 s390_bnzr(code, s390_r14);
747 tramp = mono_arch_create_specific_trampoline (NULL, MONO_TRAMPOLINE_GENERIC_CLASS_INIT,
748 mono_get_root_domain (), NULL);
750 /* jump to the actual trampoline */
751 displace = (tramp - code) / 2;
752 s390_jg (code, displace);
754 mono_arch_flush_icache (buf, code - buf);
756 g_assert (code - buf <= tramp_size);
759 *info = mono_tramp_info_create ("generic_class_init_trampoline", buf, code - buf, ji, unwind_ops);
764 /*========================= End of Function ========================*/