mono/mini/mini-x86.h

   1 /**
   2  * \file
   3  */
   4
   5 #ifndef __MONO_MINI_X86_H__
   6 #define __MONO_MINI_X86_H__
   7
   8 #include <mono/arch/x86/x86-codegen.h>
   9 #include <mono/utils/mono-sigcontext.h>
  10 #include <mono/utils/mono-context.h>
  11
  12 #ifdef HOST_WIN32
  13 #include <windows.h>
  14 #include <signal.h>
  15
  16 typedef void MONO_SIG_HANDLER_SIGNATURE ((*MonoW32ExceptionHandler));
  17
  18 void win32_seh_init(void);
  19 void win32_seh_cleanup(void);
  20 void win32_seh_set_handler(int type, MonoW32ExceptionHandler handler);
  21
  22 #ifndef SIGFPE
  23 #define SIGFPE 4
  24 #endif
  25
  26 #ifndef SIGILL
  27 #define SIGILL 8
  28 #endif
  29
  30 #ifndef SIGSEGV
  31 #define SIGSEGV 11
  32 #endif
  33
  34 LONG CALLBACK seh_handler(EXCEPTION_POINTERS* ep);
  35
  36 #endif /* HOST_WIN32 */
  37
  38 #if defined( __linux__) || defined(__sun) || defined(__APPLE__) || defined(__NetBSD__) || \
  39        defined(__FreeBSD__) || defined(__FreeBSD_kernel__) || defined(__OpenBSD__)
  40 #define MONO_ARCH_USE_SIGACTION
  41 #endif
  42
  43 #if defined(HOST_WATCHOS)
  44 #undef MONO_ARCH_USE_SIGACTION
  45 #endif
  46
  47 #ifndef HOST_WIN32
  48
  49 #ifdef HAVE_WORKING_SIGALTSTACK
  50 /*
  51  * solaris doesn't have pthread_getattr_np () needed by the sigaltstack setup
  52  * code.
  53  */
  54 #ifndef __sun
  55 #define MONO_ARCH_SIGSEGV_ON_ALTSTACK
  56 #endif
  57 /* Haiku doesn't have SA_SIGINFO */
  58 #ifndef __HAIKU__
  59 #define MONO_ARCH_USE_SIGACTION
  60 #endif /* __HAIKU__ */
  61
  62 #endif /* HAVE_WORKING_SIGALTSTACK */
  63 #endif /* !HOST_WIN32 */
  64
  65 #define MONO_ARCH_SUPPORT_TASKLETS 1
  66
  67 #ifndef DISABLE_SIMD
  68 #ifndef ENABLE_NETCORE
  69 #define MONO_ARCH_SIMD_INTRINSICS 1
  70 #define MONO_ARCH_NEED_SIMD_BANK 1
  71 #endif
  72 #endif
  73
  74 /* we should lower this size and make sure we don't call heavy stack users in the segv handler */
  75 #if defined(__APPLE__)
  76 #define MONO_ARCH_SIGNAL_STACK_SIZE MINSIGSTKSZ
  77 #else
  78 #define MONO_ARCH_SIGNAL_STACK_SIZE (16 * 1024)
  79 #endif
  80
  81 #define MONO_ARCH_CPU_SPEC mono_x86_desc
  82
  83 #define MONO_MAX_IREGS 8
  84 #define MONO_MAX_FREGS 8
  85 #define MONO_MAX_XREGS 8
  86
  87 /* Parameters used by the register allocator */
  88 #define MONO_ARCH_CALLEE_REGS X86_CALLEE_REGS
  89 #define MONO_ARCH_CALLEE_SAVED_REGS X86_CALLER_REGS
  90
  91 #define MONO_ARCH_CALLEE_FREGS (0xff & ~(regmask (MONO_ARCH_FPSTACK_SIZE)))
  92 #define MONO_ARCH_CALLEE_SAVED_FREGS 0
  93
  94 /* All registers are clobered by a call */
  95 #define MONO_ARCH_CALLEE_XREGS (0xff & ~(regmask (MONO_MAX_XREGS)))
  96 #define MONO_ARCH_CALLEE_SAVED_XREGS 0
  97
  98 #define MONO_ARCH_USE_FPSTACK TRUE
  99 #define MONO_ARCH_FPSTACK_SIZE 6
 100
 101 #define MONO_ARCH_INST_FIXED_REG(desc) (((desc == ' ') || (desc == 'i')) ? -1 : ((desc == 's') ? X86_ECX : ((desc == 'a') ? X86_EAX : ((desc == 'd') ? X86_EDX : ((desc == 'l') ? X86_EAX : -1)))))
 102
 103 #define MONO_ARCH_INST_FIXED_MASK(desc) ((desc == 'y') ? (X86_BYTE_REGS) : 0)
 104
 105 /* RDX is clobbered by the opcode implementation before accessing sreg2 */
 106 /*
 107  * Originally this contained X86_EDX for div/rem opcodes, but that led to unsolvable
 108  * situations since there are only 3 usable registers for local register allocation.
 109  * Instead, we handle the sreg2==edx case in the opcodes.
 110  */
 111 #define MONO_ARCH_INST_SREG2_MASK(ins) 0
 112
 113 /*
 114  * L is a generic register pair, while l means eax:rdx
 115  */
 116 #define MONO_ARCH_INST_IS_REGPAIR(desc) (desc == 'l' || desc == 'L')
 117 #define MONO_ARCH_INST_REGPAIR_REG2(desc,hreg1) (desc == 'l' ? X86_EDX : -1)
 118
 119 /* must be at a power of 2 and >= 8 */
 120 #define MONO_ARCH_FRAME_ALIGNMENT 16
 121
 122 /* fixme: align to 16byte instead of 32byte (we align to 32byte to get
 123  * reproduceable results for benchmarks */
 124 #define MONO_ARCH_CODE_ALIGNMENT 32
 125
 126 /*This is the max size of the locals area of a given frame. I think 1MB is a safe default for now*/
 127 #define MONO_ARCH_MAX_FRAME_SIZE 0x100000
 128
 129 /*This is how much a try block must be extended when is is preceeded by a Monitor.Enter() call.
 130 It's 4 bytes as this is how many bytes + 1 that 'add 0x10, %esp' takes. It is used to pop the arguments from
 131 the monitor.enter call and must be already protected.*/
 132 #define MONO_ARCH_MONITOR_ENTER_ADJUSTMENT 4
 133
 134 struct MonoLMF {
 135         /*
 136          * If the lowest bit is set to 1, then this is a trampoline LMF frame.
 137          * If the second lowest bit is set to 1, then this is a MonoLMFExt structure, and
 138          * the other fields are not valid.
 139          */
 140         gpointer    previous_lmf;
 141         gpointer    lmf_addr;
 142         /* Only set in trampoline LMF frames */
 143         MonoMethod *method;
 144         /* Only set in trampoline LMF frames */
 145         guint32     esp;
 146         guint32     ebx;
 147         guint32     edi;
 148         guint32     esi;
 149         guint32     ebp;
 150         guint32     eip;
 151 };
 152
 153 typedef struct {
 154         gboolean need_stack_frame_inited;
 155         gboolean need_stack_frame;
 156         int sp_fp_offset, param_area_size;
 157         CallInfo *cinfo;
 158         MonoInst *ss_tramp_var;
 159         MonoInst *bp_tramp_var;
 160 } MonoCompileArch;
 161
 162 #define MONO_CONTEXT_SET_LLVM_EXC_REG(ctx, exc) do { (ctx)->eax = (gsize)exc; } while (0)
 163
 164 #ifdef _MSC_VER
 165
 166 #define MONO_INIT_CONTEXT_FROM_FUNC(ctx, start_func) do { \
 167     unsigned int stackptr; \
 168     { \
 169            __asm mov stackptr, ebp \
 170     } \
 171         MONO_CONTEXT_SET_IP ((ctx), (start_func)); \
 172         MONO_CONTEXT_SET_BP ((ctx), stackptr); \
 173         MONO_CONTEXT_SET_SP ((ctx), stackptr); \
 174 } while (0)
 175
 176 #else
 177
 178 #define MONO_INIT_CONTEXT_FROM_FUNC(ctx,start_func) do {        \
 179                 MONO_CONTEXT_SET_IP ((ctx), (start_func));      \
 180                 MONO_CONTEXT_SET_BP ((ctx), __builtin_frame_address (0));       \
 181                 MONO_CONTEXT_SET_SP ((ctx), __builtin_frame_address (0));       \
 182         } while (0)
 183
 184 #endif
 185
 186 #define MONO_ARCH_INIT_TOP_LMF_ENTRY(lmf) do { (lmf)->ebp = -1; } while (0)
 187
 188 /* Enables OP_LSHL, OP_LSHL_IMM, OP_LSHR, OP_LSHR_IMM, OP_LSHR_UN, OP_LSHR_UN_IMM */
 189 #define MONO_ARCH_NO_EMULATE_LONG_SHIFT_OPS
 190
 191 #define MONO_ARCH_EMULATE_FCONV_TO_U8 1
 192 #define MONO_ARCH_EMULATE_FCONV_TO_U4 1
 193
 194 #define MONO_ARCH_NEED_DIV_CHECK 1
 195 #define MONO_ARCH_HAVE_IS_INT_OVERFLOW 1
 196 #define MONO_ARCH_HAVE_INVALIDATE_METHOD 1
 197 #define MONO_ARCH_NEED_GOT_VAR 1
 198 #define MONO_ARCH_IMT_REG X86_EDX
 199 #define MONO_ARCH_VTABLE_REG X86_EDX
 200 #define MONO_ARCH_RGCTX_REG MONO_ARCH_IMT_REG
 201 #define MONO_ARCH_HAVE_GENERALIZED_IMT_TRAMPOLINE 1
 202 #define MONO_ARCH_HAVE_FULL_AOT_TRAMPOLINES 1
 203 #define MONO_ARCH_GOT_REG X86_EBX
 204 #define MONO_ARCH_HAVE_GET_TRAMPOLINES 1
 205 #define MONO_ARCH_HAVE_GENERAL_RGCTX_LAZY_FETCH_TRAMPOLINE 1
 206
 207 #define MONO_ARCH_HAVE_CMOV_OPS 1
 208
 209 #ifdef MONO_ARCH_SIMD_INTRINSICS
 210 #define MONO_ARCH_HAVE_DECOMPOSE_OPTS 1
 211 #endif
 212
 213 #define MONO_ARCH_HAVE_DECOMPOSE_LONG_OPTS 1
 214
 215 #define MONO_ARCH_AOT_SUPPORTED 1
 216
 217 #define MONO_ARCH_GSHARED_SUPPORTED 1
 218
 219 #define MONO_ARCH_LLVM_SUPPORTED 1
 220 #if defined(HOST_WIN32) && defined(TARGET_WIN32)
 221 // Only supported for Windows cross compiler builds, host == Win32, target != Win32.
 222 #undef MONO_ARCH_LLVM_SUPPORTED
 223 #endif
 224
 225 #define MONO_ARCH_SOFT_DEBUG_SUPPORTED 1
 226
 227 #define MONO_ARCH_HAVE_EXCEPTIONS_INIT 1
 228
 229 #define MONO_ARCH_HAVE_CARD_TABLE_WBARRIER 1
 230 #define MONO_ARCH_HAVE_SETUP_RESUME_FROM_SIGNAL_HANDLER_CTX 1
 231 #define MONO_ARCH_GC_MAPS_SUPPORTED 1
 232 #define MONO_ARCH_HAVE_CONTEXT_SET_INT_REG 1
 233 #define MONO_ARCH_HAVE_SETUP_ASYNC_CALLBACK 1
 234 #define MONO_ARCH_GSHAREDVT_SUPPORTED 1
 235 #define MONO_ARCH_HAVE_OP_TAILCALL_MEMBASE 1
 236 #define MONO_ARCH_HAVE_OP_TAILCALL_REG 1
 237 #define MONO_ARCH_HAVE_SDB_TRAMPOLINES 1
 238 #define MONO_ARCH_HAVE_PATCH_CODE_NEW 1
 239 #define MONO_ARCH_LLVM_TARGET_LAYOUT "e-p:32:32-n32-S128"
 240
 241 /* Used for optimization, not complete */
 242 #define MONO_ARCH_IS_OP_MEMBASE(opcode) ((opcode) == OP_X86_PUSH_MEMBASE)
 243
 244 #define MONO_ARCH_EMIT_BOUNDS_CHECK(cfg, array_reg, offset, index_reg, ex_name) do { \
 245             MonoInst *inst; \
 246             MONO_INST_NEW ((cfg), inst, OP_X86_COMPARE_MEMBASE_REG); \
 247             inst->inst_basereg = array_reg; \
 248             inst->inst_offset = offset; \
 249             inst->sreg2 = index_reg; \
 250             MONO_ADD_INS ((cfg)->cbb, inst); \
 251                         MONO_EMIT_NEW_COND_EXC (cfg, LE_UN, ex_name); \
 252         } while (0)
 253
 254 // Does the ABI have a volatile non-parameter register, so tailcall
 255 // can pass context to generics or interfaces?
 256 #define MONO_ARCH_HAVE_VOLATILE_NON_PARAM_REGISTER 1
 257
 258 /* Return value marshalling for calls between gsharedvt and normal code */
 259 typedef enum {
 260         GSHAREDVT_RET_NONE = 0,
 261         GSHAREDVT_RET_IREGS = 1,
 262         GSHAREDVT_RET_DOUBLE_FPSTACK = 2,
 263         GSHAREDVT_RET_FLOAT_FPSTACK = 3,
 264         GSHAREDVT_RET_STACK_POP = 4,
 265         GSHAREDVT_RET_I1 = 5,
 266         GSHAREDVT_RET_U1 = 6,
 267         GSHAREDVT_RET_I2 = 7,
 268         GSHAREDVT_RET_U2 = 8,
 269         GSHAREDVT_RET_IREG = 9
 270 } GSharedVtRetMarshal;
 271
 272 typedef struct {
 273         /* Method address to call */
 274         gpointer addr;
 275         /* The trampoline reads this, so keep the size explicit */
 276         int ret_marshal;
 277         /* If ret_marshal != NONE, this is the stack slot of the vret arg, else -1 */
 278         int vret_arg_slot;
 279         /* The stack slot where the return value will be stored */
 280         int vret_slot;
 281         int stack_usage, map_count;
 282         /* If not -1, then make a virtual call using this vtable offset */
 283         int vcall_offset;
 284         /* If 1, make an indirect call to the address in the rgctx reg */
 285         int calli;
 286         /* Whenever this is a in or an out call */
 287         int gsharedvt_in;
 288         int map [MONO_ZERO_LEN_ARRAY];
 289 } GSharedVtCallInfo;
 290
 291 typedef enum {
 292         ArgInIReg,
 293         ArgInFloatSSEReg,
 294         ArgInDoubleSSEReg,
 295         ArgOnStack,
 296         ArgValuetypeInReg,
 297         ArgOnFloatFpStack,
 298         ArgOnDoubleFpStack,
 299         /* gsharedvt argument passed by addr */
 300         ArgGSharedVt,
 301         ArgNone
 302 } ArgStorage;
 303
 304 typedef struct {
 305         gint16 offset;
 306         gint8  reg;
 307         ArgStorage storage;
 308         int nslots;
 309         gboolean is_pair;
 310
 311         /* Only if storage == ArgValuetypeInReg */
 312         ArgStorage pair_storage [2];
 313         gint8 pair_regs [2];
 314         guint8 pass_empty_struct : 1; // Set in scenarios when empty structs needs to be represented as argument.
 315 } ArgInfo;
 316
 317 struct CallInfo {
 318         int nargs;
 319         guint32 stack_usage;
 320         guint32 reg_usage;
 321         guint32 freg_usage;
 322         gboolean need_stack_align;
 323         guint32 stack_align_amount;
 324         gboolean vtype_retaddr;
 325         /* The index of the vret arg in the argument list */
 326         int vret_arg_index;
 327         int vret_arg_offset;
 328         /* Argument space popped by the callee */
 329         int callee_stack_pop;
 330         ArgInfo ret;
 331         ArgInfo sig_cookie;
 332         ArgInfo args [1];
 333 };
 334
 335 guint32
 336 mono_x86_get_this_arg_offset (MonoMethodSignature *sig);
 337
 338 void
 339 mono_x86_throw_exception (host_mgreg_t *regs, MonoObject *exc,
 340                                                   host_mgreg_t eip, gboolean rethrow, gboolean preserve_ips);
 341
 342 void
 343 mono_x86_throw_corlib_exception (host_mgreg_t *regs, guint32 ex_token_index,
 344                                                                  host_mgreg_t eip, gint32 pc_offset);
 345
 346 void
 347 mono_x86_patch (unsigned char* code, gpointer target);
 348
 349 gpointer
 350 mono_x86_start_gsharedvt_call (GSharedVtCallInfo *info, gpointer *caller, gpointer *callee, gpointer mrgctx_reg);
 351
 352 CallInfo*
 353 mono_arch_get_call_info (MonoMemPool *mp, MonoMethodSignature *sig);
 354
 355 #endif /* __MONO_MINI_X86_H__ */
 356