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