mono/mini/tramp-arm.c

   1 /*
   2  * tramp-arm.c: JIT trampoline code for ARM
   3  *
   4  * Authors:
   5  *   Paolo Molaro (lupus@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/marshal.h>
  15 #include <mono/metadata/tabledefs.h>
  16 #include <mono/arch/arm/arm-codegen.h>
  17
  18 #include "mini.h"
  19 #include "mini-arm.h"
  20
  21 /*
  22  * Return the instruction to jump from code to target, 0 if not
  23  * reachable with a single instruction
  24  */
  25 static guint32
  26 branch_for_target_reachable (guint8 *branch, guint8 *target)
  27 {
  28         gint diff = target - branch - 8;
  29         g_assert ((diff & 3) == 0);
  30         if (diff >= 0) {
  31                 if (diff <= 33554431)
  32                         return (ARMCOND_AL << ARMCOND_SHIFT) | (ARM_BR_TAG) | (diff >> 2);
  33         } else {
  34                 /* diff between 0 and -33554432 */
  35                 if (diff >= -33554432)
  36                         return (ARMCOND_AL << ARMCOND_SHIFT) | (ARM_BR_TAG) | ((diff >> 2) & ~0xff000000);
  37         }
  38         return 0;
  39 }
  40
  41 /*
  42  * mono_arch_get_unbox_trampoline:
  43  * @m: method pointer
  44  * @addr: pointer to native code for @m
  45  *
  46  * when value type methods are called through the vtable we need to unbox the
  47  * this argument. This method returns a pointer to a trampoline which does
  48  * unboxing before calling the method
  49  */
  50 gpointer
  51 mono_arch_get_unbox_trampoline (MonoMethod *m, gpointer addr)
  52 {
  53         guint8 *code, *start;
  54         int this_pos = 0;
  55         MonoDomain *domain = mono_domain_get ();
  56
  57         if (!mono_method_signature (m)->ret->byref && MONO_TYPE_ISSTRUCT (mono_method_signature (m)->ret))
  58                 this_pos = 1;
  59
  60         mono_domain_lock (domain);
  61         start = code = mono_code_manager_reserve (domain->code_mp, 16);
  62         mono_domain_unlock (domain);
  63
  64         ARM_LDR_IMM (code, ARMREG_IP, ARMREG_PC, 4);
  65         ARM_ADD_REG_IMM8 (code, this_pos, this_pos, sizeof (MonoObject));
  66         ARM_MOV_REG_REG (code, ARMREG_PC, ARMREG_IP);
  67         *(guint32*)code = (guint32)addr;
  68         code += 4;
  69         mono_arch_flush_icache (start, code - start);
  70         g_assert ((code - start) <= 16);
  71         /*g_print ("unbox trampoline at %d for %s:%s\n", this_pos, m->klass->name, m->name);
  72         g_print ("unbox code is at %p for method at %p\n", start, addr);*/
  73
  74         return start;
  75 }
  76
  77 void
  78 mono_arch_patch_callsite (guint8 *method_start, guint8 *code_ptr, guint8 *addr)
  79 {
  80         guint32 *code = (guint32*)code_ptr;
  81
  82         /* This is the 'bl' or the 'mov pc' instruction */
  83         --code;
  84
  85         /*
  86          * Note that methods are called also with the bl opcode.
  87          */
  88         if ((((*code) >> 25)  & 7) == 5) {
  89                 /*g_print ("direct patching\n");*/
  90                 arm_patch ((guint8*)code, addr);
  91                 mono_arch_flush_icache ((guint8*)code, 4);
  92                 return;
  93         }
  94
  95         if ((((*code) >> 20) & 0xFF) == 0x12) {
  96                 /*g_print ("patching bx\n");*/
  97                 arm_patch ((guint8*)code, addr);
  98                 mono_arch_flush_icache ((guint8*)(code - 2), 4);
  99                 return;
 100         }
 101
 102         g_assert_not_reached ();
 103 }
 104
 105 void
 106 mono_arch_patch_plt_entry (guint8 *code, guint8 *addr)
 107 {
 108         guint32 ins = branch_for_target_reachable (code, addr);
 109
 110         if (ins)
 111                 /* Patch the branch */
 112                 ((guint32*)code) [0] = ins;
 113         else
 114                 /* Patch the jump address */
 115                 ((guint32*)code) [1] = (guint32)addr;
 116         mono_arch_flush_icache ((guint8*)code, 4);
 117 }
 118
 119 void
 120 mono_arch_nullify_class_init_trampoline (guint8 *code, gssize *regs)
 121 {
 122         return;
 123 }
 124
 125 void
 126 mono_arch_nullify_plt_entry (guint8 *code)
 127 {
 128         guint8 buf [4];
 129         guint8 *p;
 130
 131         p = buf;
 132         ARM_MOV_REG_REG (p, ARMREG_PC, ARMREG_LR);
 133
 134         ((guint32*)code) [0] = ((guint32*)buf) [0];
 135         mono_arch_flush_icache ((guint8*)code, 4);
 136 }
 137
 138
 139 /* Stack size for trampoline function
 140  */
 141 #define STACK (sizeof (MonoLMF))
 142
 143 /* Method-specific trampoline code fragment size */
 144 #define METHOD_TRAMPOLINE_SIZE 64
 145
 146 /* Jump-specific trampoline code fragment size */
 147 #define JUMP_TRAMPOLINE_SIZE   64
 148
 149 #define GEN_TRAMP_SIZE 192
 150
 151 /*
 152  * Stack frame description when the generic trampoline is called.
 153  * caller frame
 154  * ------------------- old sp
 155  *  MonoLMF
 156  * ------------------- sp
 157  */
 158 guchar*
 159 mono_arch_create_trampoline_code (MonoTrampolineType tramp_type)
 160 {
 161         guint8 *buf, *code = NULL;
 162         guint8 *load_get_lmf_addr, *load_trampoline;
 163         gpointer *constants;
 164
 165         /* Now we'll create in 'buf' the ARM trampoline code. This
 166          is the trampoline code common to all methods  */
 167
 168         code = buf = mono_global_codeman_reserve (GEN_TRAMP_SIZE);
 169
 170         /*
 171          * At this point lr points to the specific arg and sp points to the saved
 172          * regs on the stack (all but PC and SP). The original LR value has been
 173          * saved as sp + LR_OFFSET by the push in the specific trampoline
 174          */
 175 #define LR_OFFSET (sizeof (gpointer) * 13)
 176         ARM_MOV_REG_REG (buf, ARMREG_V1, ARMREG_SP);
 177         ARM_LDR_IMM (buf, ARMREG_V2, ARMREG_LR, 0);
 178         ARM_LDR_IMM (buf, ARMREG_V3, ARMREG_SP, LR_OFFSET);
 179
 180         /* ok, now we can continue with the MonoLMF setup, mostly untouched
 181          * from emit_prolog in mini-arm.c
 182          * This is a sinthetized call to mono_get_lmf_addr ()
 183          */
 184         load_get_lmf_addr = buf;
 185         buf += 4;
 186         ARM_MOV_REG_REG (buf, ARMREG_LR, ARMREG_PC);
 187         ARM_MOV_REG_REG (buf, ARMREG_PC, ARMREG_R0);
 188
 189         /* we build the MonoLMF structure on the stack - see mini-arm.h
 190          * The pointer to the struct is put in r1.
 191          * the iregs array is already allocated on the stack by push.
 192          */
 193         ARM_SUB_REG_IMM8 (buf, ARMREG_SP, ARMREG_SP, sizeof (MonoLMF) - sizeof (guint) * 14);
 194         ARM_ADD_REG_IMM8 (buf, ARMREG_R1, ARMREG_SP, STACK - sizeof (MonoLMF));
 195         /* r0 is the result from mono_get_lmf_addr () */
 196         ARM_STR_IMM (buf, ARMREG_R0, ARMREG_R1, G_STRUCT_OFFSET (MonoLMF, lmf_addr));
 197         /* new_lmf->previous_lmf = *lmf_addr */
 198         ARM_LDR_IMM (buf, ARMREG_R2, ARMREG_R0, G_STRUCT_OFFSET (MonoLMF, previous_lmf));
 199         ARM_STR_IMM (buf, ARMREG_R2, ARMREG_R1, G_STRUCT_OFFSET (MonoLMF, previous_lmf));
 200         /* *(lmf_addr) = r1 */
 201         ARM_STR_IMM (buf, ARMREG_R1, ARMREG_R0, G_STRUCT_OFFSET (MonoLMF, previous_lmf));
 202         /* save method info (it's in v2) */
 203         if ((tramp_type == MONO_TRAMPOLINE_GENERIC) || (tramp_type == MONO_TRAMPOLINE_JUMP))
 204                 ARM_STR_IMM (buf, ARMREG_V2, ARMREG_R1, G_STRUCT_OFFSET (MonoLMF, method));
 205         ARM_STR_IMM (buf, ARMREG_SP, ARMREG_R1, G_STRUCT_OFFSET (MonoLMF, ebp));
 206         /* save the IP (caller ip) */
 207         if (tramp_type == MONO_TRAMPOLINE_JUMP) {
 208                 ARM_MOV_REG_IMM8 (buf, ARMREG_R2, 0);
 209         } else {
 210                 /* assumes STACK == sizeof (MonoLMF) */
 211                 ARM_LDR_IMM (buf, ARMREG_R2, ARMREG_SP, (G_STRUCT_OFFSET (MonoLMF, iregs) + 13*4));
 212         }
 213         ARM_STR_IMM (buf, ARMREG_R2, ARMREG_R1, G_STRUCT_OFFSET (MonoLMF, eip));
 214
 215         /*
 216          * Now we're ready to call xxx_trampoline ().
 217          */
 218         /* Arg 1: the saved registers. It was put in v1 */
 219         ARM_MOV_REG_REG (buf, ARMREG_R0, ARMREG_V1);
 220
 221         /* Arg 2: code (next address to the instruction that called us) */
 222         if (tramp_type == MONO_TRAMPOLINE_JUMP) {
 223                 ARM_MOV_REG_IMM8 (buf, ARMREG_R1, 0);
 224         } else {
 225                 ARM_MOV_REG_REG (buf, ARMREG_R1, ARMREG_V3);
 226         }
 227
 228         /* Arg 3: the specific argument, stored in v2
 229          */
 230         ARM_MOV_REG_REG (buf, ARMREG_R2, ARMREG_V2);
 231
 232         load_trampoline = buf;
 233         buf += 4;
 234
 235         ARM_MOV_REG_REG (buf, ARMREG_LR, ARMREG_PC);
 236         ARM_MOV_REG_REG (buf, ARMREG_PC, ARMREG_IP);
 237
 238         /* OK, code address is now on r0. Move it to the place on the stack
 239          * where IP was saved (it is now no more useful to us and it can be
 240          * clobbered). This way we can just restore all the regs in one inst
 241          * and branch to IP.
 242          */
 243         ARM_STR_IMM (buf, ARMREG_R0, ARMREG_V1, (ARMREG_R12 * 4));
 244
 245         /* Check for thread interruption */
 246         /* This is not perf critical code so no need to check the interrupt flag */
 247         /*
 248          * Have to call the _force_ variant, since there could be a protected wrapper on the top of the stack.
 249          */
 250         ARM_LDR_IMM (buf, ARMREG_IP, ARMREG_PC, 0);
 251         ARM_B (buf, 0);
 252         *(gpointer*)buf = mono_thread_force_interruption_checkpoint;
 253         buf += 4;
 254         ARM_MOV_REG_REG (buf, ARMREG_LR, ARMREG_PC);
 255         ARM_MOV_REG_REG (buf, ARMREG_PC, ARMREG_IP);
 256
 257         /*
 258          * Now we restore the MonoLMF (see emit_epilogue in mini-arm.c)
 259          * and the rest of the registers, so the method called will see
 260          * the same state as before we executed.
 261          * The pointer to MonoLMF is in r2.
 262          */
 263         ARM_MOV_REG_REG (buf, ARMREG_R2, ARMREG_SP);
 264         /* ip = previous_lmf */
 265         ARM_LDR_IMM (buf, ARMREG_IP, ARMREG_R2, G_STRUCT_OFFSET (MonoLMF, previous_lmf));
 266         /* lr = lmf_addr */
 267         ARM_LDR_IMM (buf, ARMREG_LR, ARMREG_R2, G_STRUCT_OFFSET (MonoLMF, lmf_addr));
 268         /* *(lmf_addr) = previous_lmf */
 269         ARM_STR_IMM (buf, ARMREG_IP, ARMREG_LR, G_STRUCT_OFFSET (MonoLMF, previous_lmf));
 270
 271         /* Non-standard function epilogue. Instead of doing a proper
 272          * return, we just jump to the compiled code.
 273          */
 274         /* Restore the registers and jump to the code:
 275          * Note that IP has been conveniently set to the method addr.
 276          */
 277         ARM_ADD_REG_IMM8 (buf, ARMREG_SP, ARMREG_SP, sizeof (MonoLMF) - sizeof (guint) * 14);
 278         ARM_POP_NWB (buf, 0x5fff);
 279         /* do we need to set sp? */
 280         ARM_ADD_REG_IMM8 (buf, ARMREG_SP, ARMREG_SP, (14 * 4));
 281         if (tramp_type == MONO_TRAMPOLINE_CLASS_INIT)
 282                 ARM_MOV_REG_REG (buf, ARMREG_PC, ARMREG_LR);
 283         else
 284                 ARM_MOV_REG_REG (buf, ARMREG_PC, ARMREG_IP);
 285
 286         constants = (gpointer*)buf;
 287         constants [0] = mono_get_lmf_addr;
 288         constants [1] = (gpointer)mono_get_trampoline_func (tramp_type);
 289
 290         /* backpatch by emitting the missing instructions skipped above */
 291         ARM_LDR_IMM (load_get_lmf_addr, ARMREG_R0, ARMREG_PC, (buf - load_get_lmf_addr - 8));
 292         ARM_LDR_IMM (load_trampoline, ARMREG_IP, ARMREG_PC, (buf + 4 - load_trampoline - 8));
 293
 294         buf += 8;
 295
 296         /* Flush instruction cache, since we've generated code */
 297         mono_arch_flush_icache (code, buf - code);
 298
 299         /* Sanity check */
 300         g_assert ((buf - code) <= GEN_TRAMP_SIZE);
 301
 302         return code;
 303 }
 304
 305 #define SPEC_TRAMP_SIZE 24
 306
 307 gpointer
 308 mono_arch_create_specific_trampoline (gpointer arg1, MonoTrampolineType tramp_type, MonoDomain *domain, guint32 *code_len)
 309 {
 310         guint8 *code, *buf, *tramp;
 311         gpointer *constants;
 312         guint32 short_branch, size = SPEC_TRAMP_SIZE;
 313
 314         tramp = mono_get_trampoline_code (tramp_type);
 315
 316         mono_domain_lock (domain);
 317         code = buf = mono_code_manager_reserve_align (domain->code_mp, size, 4);
 318         if ((short_branch = branch_for_target_reachable (code + 8, tramp))) {
 319                 size = 12;
 320                 mono_code_manager_commit (domain->code_mp, code, SPEC_TRAMP_SIZE, size);
 321         }
 322         mono_domain_unlock (domain);
 323
 324         /* we could reduce this to 12 bytes if tramp is within reach:
 325          * ARM_PUSH ()
 326          * ARM_BL ()
 327          * method-literal
 328          * The called code can access method using the lr register
 329          * A 20 byte sequence could be:
 330          * ARM_PUSH ()
 331          * ARM_MOV_REG_REG (lr, pc)
 332          * ARM_LDR_IMM (pc, pc, 0)
 333          * method-literal
 334          * tramp-literal
 335          */
 336         /* We save all the registers, except PC and SP */
 337         ARM_PUSH (buf, 0x5fff);
 338         if (short_branch) {
 339                 constants = (gpointer*)buf;
 340                 constants [0] = GUINT_TO_POINTER (short_branch | (1 << 24));
 341                 constants [1] = arg1;
 342                 buf += 8;
 343         } else {
 344                 ARM_LDR_IMM (buf, ARMREG_R1, ARMREG_PC, 8); /* temp reg */
 345                 ARM_MOV_REG_REG (buf, ARMREG_LR, ARMREG_PC);
 346                 ARM_MOV_REG_REG (buf, ARMREG_PC, ARMREG_R1);
 347
 348                 constants = (gpointer*)buf;
 349                 constants [0] = arg1;
 350                 constants [1] = tramp;
 351                 buf += 8;
 352         }
 353
 354         /* Flush instruction cache, since we've generated code */
 355         mono_arch_flush_icache (code, buf - code);
 356
 357         g_assert ((buf - code) <= size);
 358
 359         if (code_len)
 360                 *code_len = buf - code;
 361
 362         return code;
 363 }
 364
 365 gpointer
 366 mono_arch_create_rgctx_lazy_fetch_trampoline (guint32 encoded_offset)
 367 {
 368         /* FIXME: implement! */
 369         g_assert_not_reached ();
 370         return NULL;
 371 }
 372
 373 guint32
 374 mono_arch_get_rgctx_lazy_fetch_offset (gpointer *regs)
 375 {
 376         /* FIXME: implement! */
 377         g_assert_not_reached ();
 378         return 0;
 379 }