mono/mini/mini-arm.h

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