mono/mini/mini-arm.h

   1 /*
   2  * Copyright 2011 Xamarin Inc
   3  * Licensed under the MIT license. See LICENSE file in the project root for full license information.
   4  */
   5
   6 #ifndef __MONO_MINI_ARM_H__
   7 #define __MONO_MINI_ARM_H__
   8
   9 #include <mono/arch/arm/arm-codegen.h>
  10 #include <mono/utils/mono-context.h>
  11 #include <glib.h>
  12
  13 #ifdef __native_client_codegen__
  14 #define kNaClAlignmentARM 16
  15 #define kNaClAlignmentMaskARM (kNaClAlignmentARM - 1)
  16 #define kNaClLengthOfCallImm 4
  17 #endif
  18
  19 #if defined(ARM_FPU_NONE)
  20 #define MONO_ARCH_SOFT_FLOAT_FALLBACK 1
  21 #endif
  22
  23 #if defined(__ARM_EABI__)
  24 #if G_BYTE_ORDER == G_LITTLE_ENDIAN
  25 #define ARM_ARCHITECTURE "armel"
  26 #else
  27 #define ARM_ARCHITECTURE "armeb"
  28 #endif
  29 #else
  30 #define ARM_ARCHITECTURE "arm"
  31 #endif
  32
  33 #if defined(ARM_FPU_VFP)
  34 #define ARM_FP_MODEL "vfp"
  35 #elif defined(ARM_FPU_NONE)
  36 #define ARM_FP_MODEL "vfp+fallback"
  37 #elif defined(ARM_FPU_VFP_HARD)
  38 #define ARM_FP_MODEL "vfp+hard"
  39 #else
  40 #error "At least one of ARM_FPU_NONE, ARM_FPU_VFP or ARM_FPU_VFP_HARD must be defined."
  41 #endif
  42
  43 #define MONO_ARCH_ARCHITECTURE ARM_ARCHITECTURE "," ARM_FP_MODEL
  44
  45 #define MONO_ARCH_CPU_SPEC mono_arm_cpu_desc
  46
  47 #if G_BYTE_ORDER == G_LITTLE_ENDIAN
  48 #define ARM_LSW_REG ARMREG_R0
  49 #define ARM_MSW_REG ARMREG_R1
  50 #else
  51 #define ARM_LSW_REG ARMREG_R1
  52 #define ARM_MSW_REG ARMREG_R0
  53 #endif
  54
  55 #define MONO_MAX_IREGS 16
  56
  57 #define MONO_SAVED_GREGS 10 /* r4-r11, ip, lr */
  58
  59 /* r4-r11, ip, lr: registers saved in the LMF  */
  60 #define MONO_ARM_REGSAVE_MASK 0x5ff0
  61 #define MONO_ARM_FIRST_SAVED_REG ARMREG_R4
  62 #define MONO_ARM_NUM_SAVED_REGS 10
  63
  64 /* Parameters used by the register allocator */
  65
  66 #define MONO_ARCH_CALLEE_REGS ((1<<ARMREG_R0) | (1<<ARMREG_R1) | (1<<ARMREG_R2) | (1<<ARMREG_R3) | (1<<ARMREG_IP))
  67 #define MONO_ARCH_CALLEE_SAVED_REGS ((1<<ARMREG_V1) | (1<<ARMREG_V2) | (1<<ARMREG_V3) | (1<<ARMREG_V4) | (1<<ARMREG_V5) | (1<<ARMREG_V6) | (1<<ARMREG_V7))
  68
  69 /*
  70  * TODO: Make use of VFP v3 registers d16-d31.
  71  */
  72
  73 /*
  74  * TODO: We can't use registers d8-d15 in hard float mode because the
  75  * register allocator doesn't allocate floating point registers globally.
  76  */
  77
  78 #if defined(ARM_FPU_VFP_HARD)
  79 #define MONO_SAVED_FREGS 16
  80 #define MONO_MAX_FREGS 32
  81
  82 /*
  83  * d8-d15 must be preserved across function calls. We use d14-d15 as
  84  * scratch registers in the JIT. The rest have no meaning tied to them.
  85  */
  86 #define MONO_ARCH_CALLEE_FREGS 0x00005555
  87 #define MONO_ARCH_CALLEE_SAVED_FREGS 0x55550000
  88 #else
  89 #define MONO_SAVED_FREGS 8
  90 #define MONO_MAX_FREGS 16
  91
  92 /*
  93  * No registers need to be preserved across function calls. We use d0-d1
  94  * as scratch registers in the JIT. The rest have no meaning tied to them.
  95  */
  96 #define MONO_ARCH_CALLEE_FREGS 0x55555550
  97 #define MONO_ARCH_CALLEE_SAVED_FREGS 0x00000000
  98 #endif
  99
 100 #define MONO_ARCH_USE_FPSTACK FALSE
 101 #define MONO_ARCH_FPSTACK_SIZE 0
 102
 103 #define MONO_ARCH_INST_SREG2_MASK(ins) (0)
 104
 105 #define MONO_ARCH_INST_FIXED_REG(desc) \
 106         (mono_arch_is_soft_float () ? \
 107         ((desc) == 'l' || (desc) == 'f' || (desc) == 'g' ? ARM_LSW_REG : (desc) == 'a' ? ARMREG_R0 : -1) : \
 108         ((desc) == 'l' ? ARM_LSW_REG : (desc) == 'a' ? ARMREG_R0 : -1))
 109
 110 #define MONO_ARCH_INST_IS_REGPAIR(desc) \
 111         (mono_arch_is_soft_float () ? \
 112         ((desc) == 'l' || (desc) == 'L' || (desc) == 'f' || (desc) == 'g') : \
 113         ((desc) == 'l' || (desc) == 'L'))
 114
 115 #define MONO_ARCH_INST_IS_FLOAT(desc) \
 116         (mono_arch_is_soft_float () ? \
 117         (FALSE) : \
 118         ((desc) == 'f' || (desc) == 'g'))
 119
 120 #define MONO_ARCH_INST_REGPAIR_REG2(desc,hreg1) ((desc) == 'l' || (desc) == 'f' || (desc) == 'g' ? ARM_MSW_REG : -1)
 121
 122 #ifdef TARGET_WATCHOS
 123 #define MONO_ARCH_FRAME_ALIGNMENT 16
 124 #else
 125 #define MONO_ARCH_FRAME_ALIGNMENT 8
 126 #endif
 127
 128 /* fixme: align to 16byte instead of 32byte (we align to 32byte to get
 129  * reproduceable results for benchmarks */
 130 #define MONO_ARCH_CODE_ALIGNMENT 32
 131
 132 /* This needs to hold both a 32 bit int and a 64 bit double */
 133 #define mono_unwind_reg_t guint64
 134
 135 /* Argument marshallings for calls between gsharedvt and normal code */
 136 typedef enum {
 137         GSHAREDVT_ARG_NONE = 0,
 138         GSHAREDVT_ARG_BYVAL_TO_BYREF = 1,
 139         GSHAREDVT_ARG_BYREF_TO_BYVAL = 2,
 140         GSHAREDVT_ARG_BYREF_TO_BYVAL_I1 = 3,
 141         GSHAREDVT_ARG_BYREF_TO_BYVAL_I2 = 4,
 142         GSHAREDVT_ARG_BYREF_TO_BYVAL_U1 = 5,
 143         GSHAREDVT_ARG_BYREF_TO_BYVAL_U2 = 6
 144 } GSharedVtArgMarshal;
 145
 146 /* Return value marshalling for calls between gsharedvt and normal code */
 147 typedef enum {
 148         GSHAREDVT_RET_NONE = 0,
 149         GSHAREDVT_RET_IREG = 1,
 150         GSHAREDVT_RET_IREGS = 2,
 151         GSHAREDVT_RET_I1 = 3,
 152         GSHAREDVT_RET_U1 = 4,
 153         GSHAREDVT_RET_I2 = 5,
 154         GSHAREDVT_RET_U2 = 6
 155 } GSharedVtRetMarshal;
 156
 157 typedef struct {
 158         /* Method address to call */
 159         gpointer addr;
 160         /* The trampoline reads this, so keep the size explicit */
 161         int ret_marshal;
 162         /* If ret_marshal != NONE, this is the reg of the vret arg, else -1 */
 163         int vret_arg_reg;
 164         /* The stack slot where the return value will be stored */
 165         int vret_slot;
 166         int stack_usage, map_count;
 167         /* If not -1, then make a virtual call using this vtable offset */
 168         int vcall_offset;
 169         /* If 1, make an indirect call to the address in the rgctx reg */
 170         int calli;
 171         /* Whenever this is a in or an out call */
 172         int gsharedvt_in;
 173         /* Maps stack slots/registers in the caller to the stack slots/registers in the callee */
 174         /* A negative value means a register, i.e. -1=r0, -2=r1 etc. */
 175         int map [MONO_ZERO_LEN_ARRAY];
 176 } GSharedVtCallInfo;
 177
 178
 179 typedef enum {
 180         RegTypeNone,
 181         /* Passed/returned in an ireg */
 182         RegTypeGeneral,
 183         /* Passed/returned in a pair of iregs */
 184         RegTypeIRegPair,
 185         /* Passed on the stack */
 186         RegTypeBase,
 187         /* First word in r3, second word on the stack */
 188         RegTypeBaseGen,
 189         /* FP value passed in either an ireg or a vfp reg */
 190         RegTypeFP,
 191         RegTypeStructByVal,
 192         RegTypeStructByAddr,
 193         /* gsharedvt argument passed by addr in greg */
 194         RegTypeGSharedVtInReg,
 195         /* gsharedvt argument passed by addr on stack */
 196         RegTypeGSharedVtOnStack,
 197         RegTypeHFA
 198 } ArgStorage;
 199
 200 typedef struct {
 201         gint32  offset;
 202         guint16 vtsize; /* in param area */
 203         /* RegTypeHFA */
 204         int esize;
 205         /* RegTypeHFA */
 206         int nregs;
 207         guint8  reg;
 208         ArgStorage  storage;
 209         gint32  struct_size;
 210         guint8  size    : 4; /* 1, 2, 4, 8, or regs used by RegTypeStructByVal */
 211 } ArgInfo;
 212
 213 typedef struct {
 214         int nargs;
 215         guint32 stack_usage;
 216         /* The index of the vret arg in the argument list for RegTypeStructByAddr */
 217         int vret_arg_index;
 218         ArgInfo ret;
 219         ArgInfo sig_cookie;
 220         ArgInfo args [1];
 221 } CallInfo;
 222
 223 /* Structure used by the sequence points in AOTed code */
 224 typedef struct {
 225         gpointer ss_trigger_page;
 226         gpointer bp_trigger_page;
 227         guint8* bp_addrs [MONO_ZERO_LEN_ARRAY];
 228 } SeqPointInfo;
 229
 230
 231 #define PARAM_REGS 4
 232 #define DYN_CALL_STACK_ARGS 10
 233
 234 typedef struct {
 235         mgreg_t regs [PARAM_REGS + DYN_CALL_STACK_ARGS];
 236         mgreg_t res, res2;
 237         guint8 *ret;
 238 } DynCallArgs;
 239
 240 void arm_patch (guchar *code, const guchar *target);
 241 guint8* mono_arm_emit_load_imm (guint8 *code, int dreg, guint32 val);
 242 int mono_arm_is_rotated_imm8 (guint32 val, gint *rot_amount);
 243
 244 void
 245 mono_arm_throw_exception_by_token (guint32 type_token, mgreg_t pc, mgreg_t sp, mgreg_t *int_regs, gdouble *fp_regs);
 246
 247 gpointer
 248 mono_arm_start_gsharedvt_call (GSharedVtCallInfo *info, gpointer *caller, gpointer *callee, gpointer mrgctx_reg);
 249
 250 typedef enum {
 251         MONO_ARM_FPU_NONE = 0,
 252         MONO_ARM_FPU_VFP = 1,
 253         MONO_ARM_FPU_VFP_HARD = 2
 254 } MonoArmFPU;
 255
 256 /* keep the size of the structure a multiple of 8 */
 257 struct MonoLMF {
 258         /*
 259          * If the second lowest bit is set to 1, then this is a MonoLMFExt structure, and
 260          * the other fields are not valid.
 261          */
 262         gpointer    previous_lmf;
 263         gpointer    lmf_addr;
 264         /* This is only set in trampoline LMF frames */
 265         MonoMethod *method;
 266         mgreg_t    sp;
 267         mgreg_t    ip;
 268         mgreg_t    fp;
 269         /* Currently only used in trampolines on armhf to hold d0-d15. We don't really
 270          * need to put d0-d7 in the LMF, but it simplifies the trampoline code.
 271          */
 272         double     fregs [16];
 273         /* all but sp and pc: matches the PUSH instruction layout in the trampolines
 274          * 0-4 should be considered undefined (execpt in the magic tramp)
 275          * sp is saved at IP.
 276          */
 277         mgreg_t    iregs [14];
 278 };
 279
 280 typedef struct MonoCompileArch {
 281         gpointer seq_point_info_var, ss_trigger_page_var;
 282         gpointer seq_point_ss_method_var;
 283         gpointer seq_point_bp_method_var;
 284         gpointer vret_addr_loc;
 285         gboolean omit_fp, omit_fp_computed;
 286         gpointer cinfo;
 287         gpointer *vfp_scratch_slots [2];
 288         int atomic_tmp_offset;
 289         guint8 *thunks;
 290         int thunks_size;
 291 } MonoCompileArch;
 292
 293 #define MONO_ARCH_EMULATE_FCONV_TO_I8 1
 294 #define MONO_ARCH_EMULATE_LCONV_TO_R8 1
 295 #define MONO_ARCH_EMULATE_LCONV_TO_R4 1
 296 #define MONO_ARCH_EMULATE_LCONV_TO_R8_UN 1
 297 #define MONO_ARCH_EMULATE_FREM 1
 298 #define MONO_ARCH_EMULATE_DIV 1
 299 #define MONO_ARCH_EMULATE_CONV_R8_UN 1
 300 #define MONO_ARCH_EMULATE_MUL_OVF 1
 301
 302 #define ARM_FIRST_ARG_REG 0
 303 #define ARM_LAST_ARG_REG 3
 304
 305 #define MONO_ARCH_USE_SIGACTION 1
 306
 307 #if defined(__native_client__) || defined(HOST_WATCHOS)
 308 #undef MONO_ARCH_USE_SIGACTION
 309 #endif
 310
 311 #define MONO_ARCH_NEED_DIV_CHECK 1
 312
 313 #define MONO_ARCH_HAVE_GENERALIZED_IMT_THUNK 1
 314
 315 #define MONO_ARCH_HAVE_FULL_AOT_TRAMPOLINES 1
 316 #define MONO_ARCH_HAVE_DECOMPOSE_LONG_OPTS 1
 317
 318 #define MONO_ARCH_AOT_SUPPORTED 1
 319 #define MONO_ARCH_LLVM_SUPPORTED 1
 320
 321 #define MONO_ARCH_GSHARED_SUPPORTED 1
 322 #define MONO_ARCH_DYN_CALL_SUPPORTED 1
 323 #define MONO_ARCH_DYN_CALL_PARAM_AREA (DYN_CALL_STACK_ARGS * sizeof (mgreg_t))
 324
 325 #ifndef MONO_CROSS_COMPILE
 326 #define MONO_ARCH_SOFT_DEBUG_SUPPORTED 1
 327 #endif
 328
 329 #define MONO_ARCH_HAVE_EXCEPTIONS_INIT 1
 330 #define MONO_ARCH_HAVE_GET_TRAMPOLINES 1
 331 #define MONO_ARCH_HAVE_CONTEXT_SET_INT_REG 1
 332 #define MONO_ARCH_HAVE_SIGCTX_TO_MONOCTX 1
 333 #define MONO_ARCH_GC_MAPS_SUPPORTED 1
 334 #define MONO_ARCH_HAVE_SETUP_ASYNC_CALLBACK 1
 335 #define MONO_ARCH_HAVE_CONTEXT_SET_INT_REG 1
 336 #define MONO_ARCH_HAVE_HANDLER_BLOCK_GUARD 1
 337 #define MONO_ARCH_HAVE_SETUP_RESUME_FROM_SIGNAL_HANDLER_CTX 1
 338 #define MONO_ARCH_GSHAREDVT_SUPPORTED 1
 339 #define MONO_ARCH_HAVE_GENERAL_RGCTX_LAZY_FETCH_TRAMPOLINE 1
 340 #define MONO_ARCH_HAVE_OPCODE_NEEDS_EMULATION 1
 341 #define MONO_ARCH_HAVE_OBJC_GET_SELECTOR 1
 342 #define MONO_ARCH_HAVE_OP_TAIL_CALL 1
 343 #define MONO_ARCH_HAVE_DUMMY_INIT 1
 344 #define MONO_ARCH_HAVE_SDB_TRAMPOLINES 1
 345 #define MONO_ARCH_HAVE_PATCH_CODE_NEW 1
 346 #define MONO_ARCH_HAVE_OP_GENERIC_CLASS_INIT 1
 347
 348 #if defined(__native_client__)
 349 #undef MONO_ARCH_SOFT_DEBUG_SUPPORTED
 350 #undef MONO_ARCH_HAVE_SIGCTX_TO_MONOCTX
 351 #undef MONO_ARCH_HAVE_CONTEXT_SET_INT_REG
 352 #endif
 353
 354 #define MONO_ARCH_HAVE_TLS_GET (mono_arm_have_tls_get ())
 355 #define MONO_ARCH_HAVE_TLS_GET_REG 1
 356
 357 /* ARM doesn't have too many registers, so we have to use a callee saved one */
 358 #define MONO_ARCH_RGCTX_REG ARMREG_V5
 359 #define MONO_ARCH_IMT_REG MONO_ARCH_RGCTX_REG
 360 /* First argument reg */
 361 #define MONO_ARCH_VTABLE_REG ARMREG_R0
 362 #define MONO_ARCH_EXC_REG ARMREG_R0
 363
 364 #define MONO_CONTEXT_SET_LLVM_EXC_REG(ctx, exc) do { (ctx)->regs [0] = (gsize)exc; } while (0)
 365
 366 #define MONO_INIT_CONTEXT_FROM_FUNC(ctx,func) do {      \
 367                 MONO_CONTEXT_SET_BP ((ctx), __builtin_frame_address (0));       \
 368                 MONO_CONTEXT_SET_SP ((ctx), __builtin_frame_address (0));       \
 369                 MONO_CONTEXT_SET_IP ((ctx), (func));    \
 370         } while (0)
 371
 372 #define MONO_ARCH_INIT_TOP_LMF_ENTRY(lmf)
 373
 374 void
 375 mono_arm_throw_exception (MonoObject *exc, mgreg_t pc, mgreg_t sp, mgreg_t *int_regs, gdouble *fp_regs);
 376
 377 void
 378 mono_arm_throw_exception_by_token (guint32 type_token, mgreg_t pc, mgreg_t sp, mgreg_t *int_regs, gdouble *fp_regs);
 379
 380 void
 381 mono_arm_resume_unwind (guint32 dummy1, mgreg_t pc, mgreg_t sp, mgreg_t *int_regs, gdouble *fp_regs);
 382
 383 gboolean
 384 mono_arm_thumb_supported (void);
 385
 386 GSList*
 387 mono_arm_get_exception_trampolines (gboolean aot);
 388
 389 guint8*
 390 mono_arm_get_thumb_plt_entry (guint8 *code);
 391
 392 guint8*
 393 mono_arm_patchable_b (guint8 *code, int cond);
 394
 395 guint8*
 396 mono_arm_patchable_bl (guint8 *code, int cond);
 397
 398 #ifdef USE_JUMP_TABLES
 399 guint8*
 400 mono_arm_load_jumptable_entry_addr (guint8 *code, gpointer *jte, ARMReg reg);
 401
 402 guint8*
 403 mono_arm_load_jumptable_entry (guint8 *code, gpointer *jte, ARMReg reg);
 404 #endif
 405
 406 gboolean
 407 mono_arm_is_hard_float (void);
 408
 409 gboolean
 410 mono_arm_have_tls_get (void);
 411
 412 void
 413 mono_arm_unaligned_stack (MonoMethod *method);
 414
 415 CallInfo*
 416 mono_arch_get_call_info (MonoMemPool *mp, MonoMethodSignature *sig);
 417
 418 #endif /* __MONO_MINI_ARM_H__ */