mono/mini/tramp-s390x.c

   1 /*------------------------------------------------------------------*/
   2 /*                                                                  */
   3 /* Name        - tramp-s390.c                                       */
   4 /*                                                                  */
   5 /* Function    - JIT trampoline code for S/390.                     */
   6 /*                                                                  */
   7 /* Name        - Neale Ferguson (Neale.Ferguson@SoftwareAG-usa.com) */
   8 /*                                                                  */
   9 /* Date        - January, 2004                                      */
  10 /*                                                                  */
  11 /* Derivation  - From exceptions-x86 & exceptions-ppc               */
  12 /*               Paolo Molaro (lupus@ximian.com)                    */
  13 /*               Dietmar Maurer (dietmar@ximian.com)                */
  14 /*                                                                  */
  15 /* Copyright   - 2001 Ximian, Inc.                                  */
  16 /*                                                                  */
  17 /*------------------------------------------------------------------*/
  18
  19 /*------------------------------------------------------------------*/
  20 /*                 D e f i n e s                                    */
  21 /*------------------------------------------------------------------*/
  22
  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
  31 /*------------------------------------------------------------------*/
  32 /* Method-specific trampoline code fragment sizes                   */
  33 /*------------------------------------------------------------------*/
  34 #define SPECIFIC_TRAMPOLINE_SIZE        96
  35
  36 /*========================= End of Defines =========================*/
  37
  38 /*------------------------------------------------------------------*/
  39 /*                 I n c l u d e s                                  */
  40 /*------------------------------------------------------------------*/
  41
  42 #include <config.h>
  43 #include <glib.h>
  44 #include <string.h>
  45
  46 #include <mono/metadata/appdomain.h>
  47 #include <mono/metadata/marshal.h>
  48 #include <mono/metadata/tabledefs.h>
  49 #include <mono/arch/s390x/s390x-codegen.h>
  50
  51 #include "mini.h"
  52 #include "mini-s390x.h"
  53
  54 /*========================= End of Includes ========================*/
  55
  56 /*------------------------------------------------------------------*/
  57 /*                 T y p e d e f s                                  */
  58 /*------------------------------------------------------------------*/
  59
  60 /*========================= End of Typedefs ========================*/
  61
  62 /*------------------------------------------------------------------*/
  63 /*                   P r o t o t y p e s                            */
  64 /*------------------------------------------------------------------*/
  65
  66 /*========================= End of Prototypes ======================*/
  67
  68 /*------------------------------------------------------------------*/
  69 /*                 G l o b a l   V a r i a b l e s                  */
  70 /*------------------------------------------------------------------*/
  71
  72
  73 /*====================== End of Global Variables ===================*/
  74
  75 /*------------------------------------------------------------------*/
  76 /*                                                                  */
  77 /* Name         - mono_arch_get_unbox_trampoline                    */
  78 /*                                                                  */
  79 /* Function     - Return a pointer to a trampoline which does the   */
  80 /*                unboxing before calling the method.               */
  81 /*                                                                  */
  82 /*                When value type methods are called through the    */
  83 /*                vtable we need to unbox the 'this' argument.      */
  84 /*                                                                  */
  85 /* Parameters   - gsctx  - Generic sharing context                  */
  86 /*                method - Methd pointer                            */
  87 /*                addr   - Pointer to native code for method        */
  88 /*                                                                  */
  89 /*------------------------------------------------------------------*/
  90
  91 gpointer
  92 mono_arch_get_unbox_trampoline (MonoGenericSharingContext *gsctx, MonoMethod *method, gpointer addr)
  93 {
  94         guint8 *code, *start;
  95         int this_pos = s390_r2;
  96         MonoDomain *domain = mono_domain_get ();
  97
  98         start = code = mono_domain_code_reserve (domain, 28);
  99
 100         s390_basr (code, s390_r1, 0);
 101         s390_j    (code, 6);
 102         s390_llong(code, addr);
 103         s390_lg   (code, s390_r1, 0, s390_r1, 4);
 104         s390_aghi (code, this_pos, sizeof(MonoObject));
 105         s390_br   (code, s390_r1);
 106
 107         g_assert ((code - start) <= 28);
 108
 109         mono_arch_flush_icache (start, code - start);
 110
 111         return start;
 112 }
 113
 114 /*========================= End of Function ========================*/
 115
 116 /*------------------------------------------------------------------*/
 117 /*                                                                  */
 118 /* Name         - mono_arch_patch_callsite                          */
 119 /*                                                                  */
 120 /* Function     - Patch a non-virtual callsite so it calls @addr.   */
 121 /*                                                                  */
 122 /*------------------------------------------------------------------*/
 123
 124 void
 125 mono_arch_patch_callsite (guint8 *method_start, guint8 *orig_code, guint8 *addr)
 126 {
 127         gint32 displace;
 128         unsigned short opcode;
 129
 130         opcode = *((unsigned short *) (orig_code - 6));
 131         if (opcode == 0xc0e5) {
 132                 /* This is the 'brasl' instruction */
 133                 orig_code    -= 4;
 134                 displace = ((gssize) addr - (gssize) (orig_code - 2)) / 2;
 135                 s390_patch_rel (orig_code, displace);
 136                 mono_arch_flush_icache (orig_code, 4);
 137         } else {
 138                 /* This should be a 'lg %r14,4(%r13)' then a 'basr r14, r14' instruction */
 139                 g_assert (orig_code [-8] == 0xe3);
 140                 g_assert (orig_code [-7] == 0xe0);
 141                 g_assert (orig_code [-6] == 0xd0);
 142                 g_assert (orig_code [-5] == 0x04);
 143                 g_assert (orig_code [-4] == 0x00);
 144                 g_assert (orig_code [-3] == 0x04);
 145                 opcode = *((unsigned short*) (orig_code - 2));
 146                 g_assert (opcode == 0x0dee);
 147
 148                 /* The call address is stored in the 8 bytes preceeding the basr instruction */
 149                 s390_patch_addr(orig_code - 16, (gssize)addr);
 150                 mono_arch_flush_icache (orig_code - 16, 8);
 151         }
 152 }
 153
 154 /*========================= End of Function ========================*/
 155
 156 /*------------------------------------------------------------------*/
 157 /*                                                                  */
 158 /* Name         - mono_arch_patch_plt_entry.                        */
 159 /*                                                                  */
 160 /* Function     - Patch a PLT entry - unused as yet.                */
 161 /*                                                                  */
 162 /*------------------------------------------------------------------*/
 163
 164 void
 165 mono_arch_patch_plt_entry (guint8 *code, gpointer *got, mgreg_t *regs, guint8 *addr)
 166 {
 167         g_assert_not_reached ();
 168 }
 169
 170 /*========================= End of Function ========================*/
 171
 172 /*------------------------------------------------------------------*/
 173 /*                                                                  */
 174 /* Name         - mono_arch_nullify_class_init_trampoline           */
 175 /*                                                                  */
 176 /* Function     - Nullify a call which calls a class init trampoline*/
 177 /*                                                                  */
 178 /*------------------------------------------------------------------*/
 179
 180 void
 181 mono_arch_nullify_class_init_trampoline (guint8 *code, mgreg_t *regs)
 182 {
 183         char patch[2] = {0x07, 0x00};
 184
 185         code = code - 2;
 186
 187         memcpy(code, patch, sizeof(patch));
 188 }
 189
 190 /*========================= End of Function ========================*/
 191
 192 /*------------------------------------------------------------------*/
 193 /*                                                                  */
 194 /* Name         - mono_arch_nullify_plt_entry                       */
 195 /*                                                                  */
 196 /* Function     - Nullify a PLT entry call.                         */
 197 /*                                                                  */
 198 /*------------------------------------------------------------------*/
 199
 200 void
 201 mono_arch_nullify_plt_entry (guint8 *code, mgreg_t *regs)
 202 {
 203         g_assert_not_reached ();
 204 }
 205
 206 /*========================= End of Function ========================*/
 207
 208 /*------------------------------------------------------------------*/
 209 /*                                                                  */
 210 /* Name         - mono_arch_get_vcall_slot                          */
 211 /*                                                                  */
 212 /* Function     - This method is called by the arch independent     */
 213 /*            trampoline code to determine the vtable slot used by  */
 214 /*            the call which invoked the trampoline.                */
 215 /*                                                                  */
 216 /* Parameters   - code   - Pointer into caller code                 */
 217 /*                regs   - Register state at the point of the call  */
 218 /*                displacement - Out parameter which will receive   */
 219 /*                the displacement of the vtable slot               */
 220 /*                                                                  */
 221 /*------------------------------------------------------------------*/
 222
 223 gpointer
 224 mono_arch_get_vcall_slot (guint8 *code, mgreg_t *regs, int *displacement)
 225 {
 226         /* Not used on s390x */
 227         g_assert_not_reached ();
 228         return NULL;
 229 }
 230
 231 /*========================= End of Function ========================*/
 232
 233 /*------------------------------------------------------------------*/
 234 /*                                                                  */
 235 /* Name         - mono_arch_create_trampoline_code                  */
 236 /*                                                                  */
 237 /* Function     - Create the designated type of trampoline according*/
 238 /*                to the 'tramp_type' parameter.                    */
 239 /*                                                                  */
 240 /*------------------------------------------------------------------*/
 241
 242 guchar*
 243 mono_arch_create_generic_trampoline (MonoTrampolineType tramp_type, MonoTrampInfo **info, gboolean aot)
 244 {
 245         guint8 *buf, *tramp, *code;
 246         int i, offset, lmfOffset;
 247
 248         g_assert (!aot);
 249         if (info)
 250                 *info = NULL;
 251
 252         /* Now we'll create in 'buf' the S/390 trampoline code. This
 253            is the trampoline code common to all methods  */
 254
 255         code = buf = mono_global_codeman_reserve(512);
 256
 257         /*-----------------------------------------------------------
 258           STEP 0: First create a non-standard function prologue with a
 259           stack size big enough to save our registers.
 260           -----------------------------------------------------------*/
 261
 262         s390_stmg (buf, s390_r6, s390_r15, STK_BASE, S390_REG_SAVE_OFFSET);
 263         s390_lgr  (buf, s390_r11, s390_r15);
 264         s390_aghi (buf, STK_BASE, -CREATE_STACK_SIZE);
 265         s390_stg  (buf, s390_r11, 0, STK_BASE, 0);
 266         s390_stg  (buf, s390_r1, 0, STK_BASE, METHOD_SAVE_OFFSET);
 267         s390_stmg (buf, s390_r2, s390_r5, STK_BASE, CREATE_GR_OFFSET);
 268
 269         /* Save the FP registers */
 270         offset = CREATE_FP_OFFSET;
 271         for (i = s390_f0; i <= s390_f15; ++i) {
 272                 s390_std  (buf, i, 0, STK_BASE, offset);
 273                 offset += 8;
 274         }
 275
 276         /*----------------------------------------------------------
 277           STEP 1: call 'mono_get_lmf_addr()' to get the address of our
 278           LMF. We'll need to restore it after the call to
 279           's390_magic_trampoline' and before the call to the native
 280           method.
 281           ----------------------------------------------------------*/
 282
 283         s390_basr (buf, s390_r13, 0);
 284         s390_j    (buf, 6);
 285         s390_llong(buf, mono_get_lmf_addr);
 286         s390_lg   (buf, s390_r1, 0, s390_r13, 4);
 287         s390_basr (buf, s390_r14, s390_r1);
 288
 289         /*---------------------------------------------------------------*/
 290         /* we build the MonoLMF structure on the stack - see mini-s390.h */
 291         /* Keep in sync with the code in mono_arch_emit_prolog           */
 292         /*---------------------------------------------------------------*/
 293         lmfOffset = CREATE_STACK_SIZE - sizeof(MonoLMF);
 294
 295         s390_lgr   (buf, s390_r13, STK_BASE);
 296         s390_aghi  (buf, s390_r13, lmfOffset);
 297
 298         /*---------------------------------------------------------------*/
 299         /* Set lmf.lmf_addr = jit_tls->lmf                               */
 300         /*---------------------------------------------------------------*/
 301         s390_stg   (buf, s390_r2, 0, s390_r13,
 302                             G_STRUCT_OFFSET(MonoLMF, lmf_addr));
 303
 304         /*---------------------------------------------------------------*/
 305         /* Get current lmf                                               */
 306         /*---------------------------------------------------------------*/
 307         s390_lg    (buf, s390_r0, 0, s390_r2, 0);
 308
 309         /*---------------------------------------------------------------*/
 310         /* Set our lmf as the current lmf                                */
 311         /*---------------------------------------------------------------*/
 312         s390_stg   (buf, s390_r13, 0, s390_r2, 0);
 313
 314         /*---------------------------------------------------------------*/
 315         /* Have our lmf.previous_lmf point to the last lmf               */
 316         /*---------------------------------------------------------------*/
 317         s390_stg   (buf, s390_r0, 0, s390_r13,
 318                             G_STRUCT_OFFSET(MonoLMF, previous_lmf));
 319
 320         /*---------------------------------------------------------------*/
 321         /* save method info                                              */
 322         /*---------------------------------------------------------------*/
 323         s390_lg    (buf, s390_r1, 0, STK_BASE, METHOD_SAVE_OFFSET);
 324         s390_stg   (buf, s390_r1, 0, s390_r13,
 325                             G_STRUCT_OFFSET(MonoLMF, method));
 326
 327         /*---------------------------------------------------------------*/
 328         /* save the current SP                                           */
 329         /*---------------------------------------------------------------*/
 330         s390_lg    (buf, s390_r1, 0, STK_BASE, 0);
 331         s390_stg   (buf, s390_r1, 0, s390_r13, G_STRUCT_OFFSET(MonoLMF, ebp));
 332
 333         /*---------------------------------------------------------------*/
 334         /* save the current IP                                           */
 335         /*---------------------------------------------------------------*/
 336         if (tramp_type == MONO_TRAMPOLINE_JUMP) {
 337                 s390_lghi  (buf, s390_r1, 0);
 338         } else {
 339                 s390_lg    (buf, s390_r1, 0, s390_r1, S390_RET_ADDR_OFFSET);
 340                 //                      s390_la    (buf, s390_r1, 0, s390_r1, 0);
 341         }
 342         s390_stg   (buf, s390_r1, 0, s390_r13, G_STRUCT_OFFSET(MonoLMF, eip));
 343
 344         /*---------------------------------------------------------------*/
 345         /* Save general and floating point registers                     */
 346         /*---------------------------------------------------------------*/
 347         s390_mvc   (buf, 4*sizeof(gulong), s390_r13, G_STRUCT_OFFSET(MonoLMF, gregs[2]),
 348                     STK_BASE, CREATE_GR_OFFSET);
 349         s390_mvc   (buf, 10*sizeof(gulong), s390_r13, G_STRUCT_OFFSET(MonoLMF, gregs[6]),
 350                     s390_r11, S390_REG_SAVE_OFFSET);
 351
 352         /* Simply copy fpregs already saved above                        */
 353         s390_mvc   (buf, 16*sizeof(double), s390_r13, G_STRUCT_OFFSET(MonoLMF, fregs[0]),
 354                     STK_BASE, CREATE_FP_OFFSET);
 355
 356         /*---------------------------------------------------------------*/
 357         /* STEP 2: call the C trampoline function                        */
 358         /*---------------------------------------------------------------*/
 359
 360         /* Set arguments */
 361
 362         /* Arg 1: mgreg_t *regs. We pass sp instead */
 363         s390_la  (buf, s390_r2, 0, STK_BASE, CREATE_STACK_SIZE);
 364
 365         /* Arg 2: code (next address to the instruction that called us) */
 366         if (tramp_type == MONO_TRAMPOLINE_JUMP) {
 367                 s390_lghi (buf, s390_r3, 0);
 368         } else {
 369                 s390_lg   (buf, s390_r3, 0, s390_r11, S390_RET_ADDR_OFFSET);
 370         }
 371
 372         /* Arg 3: MonoMethod *method. It was put in r1 by the
 373            method-specific trampoline code, and then saved before the call
 374            to mono_get_lmf_addr()'. */
 375         s390_lg  (buf, s390_r4, 0, STK_BASE, METHOD_SAVE_OFFSET);
 376
 377         /* Arg 4: trampoline address. Ignore for now */
 378
 379         /* Calculate call address and call the C trampoline. Return value will be in r2 */
 380         s390_basr (buf, s390_r13, 0);
 381         s390_j    (buf, 6);
 382         tramp = (guint8*)mono_get_trampoline_func (tramp_type);
 383         s390_llong (buf, tramp);
 384         s390_lg   (buf, s390_r1, 0, s390_r13, 4);
 385         s390_basr (buf, s390_r14, s390_r1);
 386
 387         /* OK, code address is now on r2. Move it to r1, so that we
 388            can restore r2 and use it from r1 later */
 389         s390_lgr  (buf, s390_r1, s390_r2);
 390
 391         /*----------------------------------------------------------
 392           STEP 3: Restore the LMF
 393           ----------------------------------------------------------*/
 394         restoreLMF(buf, STK_BASE, CREATE_STACK_SIZE);
 395
 396         /*----------------------------------------------------------
 397           STEP 4: call the compiled method
 398           ----------------------------------------------------------*/
 399
 400         /* Restore registers */
 401
 402         s390_lmg  (buf, s390_r2, s390_r5, STK_BASE, CREATE_GR_OFFSET);
 403
 404         /* Restore the FP registers */
 405         offset = CREATE_FP_OFFSET;
 406         for (i = s390_f0; i <= s390_f15; ++i) {
 407                 s390_ld  (buf, i, 0, STK_BASE, offset);
 408                 offset += 8;
 409         }
 410
 411         /* Restore stack pointer and jump to the code -
 412            R14 contains the return address to our caller */
 413         s390_lgr  (buf, STK_BASE, s390_r11);
 414         s390_lmg  (buf, s390_r6, s390_r14, STK_BASE, S390_REG_SAVE_OFFSET);
 415
 416         if (tramp_type == MONO_TRAMPOLINE_CLASS_INIT || tramp_type == MONO_TRAMPOLINE_GENERIC_CLASS_INIT)
 417                 s390_br (buf, s390_r14);
 418         else
 419                 s390_br (buf, s390_r1);
 420
 421         /* Flush instruction cache, since we've generated code */
 422         mono_arch_flush_icache (code, buf - code);
 423
 424         /* Sanity check */
 425         g_assert ((buf - code) <= 512);
 426
 427         return code;
 428 }
 429
 430 /*========================= End of Function ========================*/
 431
 432 /*------------------------------------------------------------------*/
 433 /*                                                                  */
 434 /* Name         - mono_arch_create_specific_trampoline              */
 435 /*                                                                  */
 436 /* Function     - Creates the given kind of specific trampoline     */
 437 /*                                                                  */
 438 /*------------------------------------------------------------------*/
 439
 440 gpointer
 441 mono_arch_create_specific_trampoline (gpointer arg1, MonoTrampolineType tramp_type, MonoDomain *domain, guint32 *code_len)
 442 {
 443         guint8 *code, *buf, *tramp;
 444         gint32 displace;
 445
 446         tramp = mono_get_trampoline_code (tramp_type);
 447
 448         /*----------------------------------------------------------*/
 449         /* This is the method-specific part of the trampoline. Its  */
 450         /* purpose is to provide the generic part with the          */
 451         /* MonoMethod *method pointer. We'll use r1 to keep it.     */
 452         /*----------------------------------------------------------*/
 453         code = buf = mono_domain_code_reserve (domain, SPECIFIC_TRAMPOLINE_SIZE);
 454
 455         s390_basr (buf, s390_r1, 0);
 456         s390_j    (buf, 6);
 457         s390_llong(buf, arg1);
 458         s390_lg   (buf, s390_r1, 0, s390_r1, 4);
 459         displace = (tramp - buf) / 2;
 460         s390_jcl  (buf, S390_CC_UN, displace);
 461
 462         /* Flush instruction cache, since we've generated code */
 463         mono_arch_flush_icache (code, buf - code);
 464
 465         /* Sanity check */
 466         g_assert ((buf - code) <= SPECIFIC_TRAMPOLINE_SIZE);
 467
 468         if (code_len)
 469                 *code_len = buf - code;
 470
 471         return code;
 472 }
 473
 474 /*========================= End of Function ========================*/
 475
 476 /*------------------------------------------------------------------*/
 477 /*                                                                  */
 478 /* Name         - mono_arch_create_rgctx_lazy_fetch_trampoline      */
 479 /*                                                                  */
 480 /* Function     -                                                   */
 481 /*                                                                  */
 482 /*------------------------------------------------------------------*/
 483
 484 gpointer
 485 mono_arch_create_rgctx_lazy_fetch_trampoline (guint32 slot, MonoTrampInfo **info, gboolean aot)
 486 {
 487         /* FIXME: implement! */
 488         g_assert_not_reached ();
 489         return NULL;
 490 }
 491
 492 /*========================= End of Function ========================*/