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 (* MonoW32ExceptionHandler) (int _dummy, EXCEPTION_POINTERS *info, void *context);
  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 #define MONO_ARCH_HAVE_RESTORE_STACK_SUPPORT 1
  82
  83 #define MONO_ARCH_CPU_SPEC mono_x86_desc
  84
  85 #define MONO_MAX_IREGS 8
  86 #define MONO_MAX_FREGS 8
  87 #define MONO_MAX_XREGS 8
  88
  89 /* Parameters used by the register allocator */
  90 #define MONO_ARCH_CALLEE_REGS X86_CALLEE_REGS
  91 #define MONO_ARCH_CALLEE_SAVED_REGS X86_CALLER_REGS
  92
  93 #define MONO_ARCH_CALLEE_FREGS (0xff & ~(regmask (MONO_ARCH_FPSTACK_SIZE)))
  94 #define MONO_ARCH_CALLEE_SAVED_FREGS 0
  95
  96 /* All registers are clobered by a call */
  97 #define MONO_ARCH_CALLEE_XREGS (0xff & ~(regmask (MONO_MAX_XREGS)))
  98 #define MONO_ARCH_CALLEE_SAVED_XREGS 0
  99
 100 #define MONO_ARCH_USE_FPSTACK TRUE
 101 #define MONO_ARCH_FPSTACK_SIZE 6
 102
 103 #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)))))
 104
 105 #define MONO_ARCH_INST_FIXED_MASK(desc) ((desc == 'y') ? (X86_BYTE_REGS) : 0)
 106
 107 /* RDX is clobbered by the opcode implementation before accessing sreg2 */
 108 /*
 109  * Originally this contained X86_EDX for div/rem opcodes, but that led to unsolvable
 110  * situations since there are only 3 usable registers for local register allocation.
 111  * Instead, we handle the sreg2==edx case in the opcodes.
 112  */
 113 #define MONO_ARCH_INST_SREG2_MASK(ins) 0
 114
 115 /*
 116  * L is a generic register pair, while l means eax:rdx
 117  */
 118 #define MONO_ARCH_INST_IS_REGPAIR(desc) (desc == 'l' || desc == 'L')
 119 #define MONO_ARCH_INST_REGPAIR_REG2(desc,hreg1) (desc == 'l' ? X86_EDX : -1)
 120
 121 /* must be at a power of 2 and >= 8 */
 122 #define MONO_ARCH_FRAME_ALIGNMENT 16
 123
 124 /* fixme: align to 16byte instead of 32byte (we align to 32byte to get
 125  * reproduceable results for benchmarks */
 126 #define MONO_ARCH_CODE_ALIGNMENT 32
 127
 128 /*This is the max size of the locals area of a given frame. I think 1MB is a safe default for now*/
 129 #define MONO_ARCH_MAX_FRAME_SIZE 0x100000
 130
 131 /*This is how much a try block must be extended when is is preceeded by a Monitor.Enter() call.
 132 It's 4 bytes as this is how many bytes + 1 that 'add 0x10, %esp' takes. It is used to pop the arguments from
 133 the monitor.enter call and must be already protected.*/
 134 #define MONO_ARCH_MONITOR_ENTER_ADJUSTMENT 4
 135
 136 struct MonoLMF {
 137         /*
 138          * If the lowest bit is set to 1, then this is a trampoline LMF frame.
 139          * If the second lowest bit is set to 1, then this is a MonoLMFExt structure, and
 140          * the other fields are not valid.
 141          */
 142         guint32    previous_lmf;
 143         gpointer    lmf_addr;
 144         /* Only set in trampoline LMF frames */
 145         MonoMethod *method;
 146         /* Only set in trampoline LMF frames */
 147         guint32     esp;
 148         guint32     ebx;
 149         guint32     edi;
 150         guint32     esi;
 151         guint32     ebp;
 152         guint32     eip;
 153 };
 154
 155 typedef struct {
 156         gboolean need_stack_frame_inited;
 157         gboolean need_stack_frame;
 158         int sp_fp_offset, param_area_size;
 159         gpointer cinfo;
 160         gpointer ss_tramp_var;
 161         gpointer bp_tramp_var;
 162 } MonoCompileArch;
 163
 164 #define MONO_CONTEXT_SET_LLVM_EXC_REG(ctx, exc) do { (ctx)->eax = (gsize)exc; } while (0)
 165
 166 #ifdef _MSC_VER
 167
 168 #define MONO_INIT_CONTEXT_FROM_FUNC(ctx, start_func) do { \
 169     unsigned int stackptr; \
 170         mono_arch_flush_register_windows (); \
 171     { \
 172            __asm mov stackptr, ebp \
 173     } \
 174         MONO_CONTEXT_SET_IP ((ctx), (start_func)); \
 175         MONO_CONTEXT_SET_BP ((ctx), stackptr); \
 176         MONO_CONTEXT_SET_SP ((ctx), stackptr); \
 177 } while (0)
 178
 179 #else
 180
 181 #define MONO_INIT_CONTEXT_FROM_FUNC(ctx,start_func) do {        \
 182                 mono_arch_flush_register_windows ();    \
 183                 MONO_CONTEXT_SET_IP ((ctx), (start_func));      \
 184                 MONO_CONTEXT_SET_BP ((ctx), __builtin_frame_address (0));       \
 185                 MONO_CONTEXT_SET_SP ((ctx), __builtin_frame_address (0));       \
 186         } while (0)
 187
 188 #endif
 189
 190 #define MONO_ARCH_INIT_TOP_LMF_ENTRY(lmf) do { (lmf)->ebp = -1; } while (0)
 191
 192 /* Enables OP_LSHL, OP_LSHL_IMM, OP_LSHR, OP_LSHR_IMM, OP_LSHR_UN, OP_LSHR_UN_IMM */
 193 #define MONO_ARCH_NO_EMULATE_LONG_SHIFT_OPS
 194
 195 #define MONO_ARCH_NEED_DIV_CHECK 1
 196 #define MONO_ARCH_HAVE_IS_INT_OVERFLOW 1
 197 #define MONO_ARCH_HAVE_INVALIDATE_METHOD 1
 198 #define MONO_ARCH_NEED_GOT_VAR 1
 199 #define MONO_ARCH_IMT_REG X86_EDX
 200 #define MONO_ARCH_VTABLE_REG X86_EDX
 201 #define MONO_ARCH_RGCTX_REG MONO_ARCH_IMT_REG
 202 #define MONO_ARCH_EXC_REG X86_EAX
 203 #define MONO_ARCH_HAVE_GENERALIZED_IMT_TRAMPOLINE 1
 204 #define MONO_ARCH_HAVE_LIVERANGE_OPS 1
 205 #define MONO_ARCH_HAVE_SIGCTX_TO_MONOCTX 1
 206 #define MONO_ARCH_HAVE_FULL_AOT_TRAMPOLINES 1
 207 #define MONO_ARCH_GOT_REG X86_EBX
 208 #define MONO_ARCH_HAVE_GET_TRAMPOLINES 1
 209 #define MONO_ARCH_HAVE_GENERAL_RGCTX_LAZY_FETCH_TRAMPOLINE 1
 210
 211 #define MONO_ARCH_HAVE_CMOV_OPS 1
 212
 213 #ifdef MONO_ARCH_SIMD_INTRINSICS
 214 #define MONO_ARCH_HAVE_DECOMPOSE_OPTS 1
 215 #endif
 216
 217 #define MONO_ARCH_HAVE_DECOMPOSE_LONG_OPTS 1
 218
 219 #define MONO_ARCH_AOT_SUPPORTED 1
 220
 221 #define MONO_ARCH_GSHARED_SUPPORTED 1
 222 #define MONO_ARCH_LLVM_SUPPORTED 1
 223
 224 #define MONO_ARCH_SOFT_DEBUG_SUPPORTED 1
 225
 226 #define MONO_ARCH_HAVE_EXCEPTIONS_INIT 1
 227 #define MONO_ARCH_HAVE_HANDLER_BLOCK_GUARD 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_TAIL_CALL 1
 236 #define MONO_ARCH_HAVE_TRANSLATE_TLS_OFFSET 1
 237 #define MONO_ARCH_HAVE_DUMMY_INIT 1
 238 #define MONO_ARCH_HAVE_SDB_TRAMPOLINES 1
 239 #define MONO_ARCH_HAVE_PATCH_CODE_NEW 1
 240 #define MONO_ARCH_HAVE_INIT_LMF_EXT 1
 241
 242 /* Used for optimization, not complete */
 243 #define MONO_ARCH_IS_OP_MEMBASE(opcode) ((opcode) == OP_X86_PUSH_MEMBASE)
 244
 245 #define MONO_ARCH_EMIT_BOUNDS_CHECK(cfg, array_reg, offset, index_reg) do { \
 246             MonoInst *inst; \
 247             MONO_INST_NEW ((cfg), inst, OP_X86_COMPARE_MEMBASE_REG); \
 248             inst->inst_basereg = array_reg; \
 249             inst->inst_offset = offset; \
 250             inst->sreg2 = index_reg; \
 251             MONO_ADD_INS ((cfg)->cbb, inst); \
 252                         MONO_EMIT_NEW_COND_EXC (cfg, LE_UN, "IndexOutOfRangeException"); \
 253         } while (0)
 254
 255 /* Return value marshalling for calls between gsharedvt and normal code */
 256 typedef enum {
 257         GSHAREDVT_RET_NONE = 0,
 258         GSHAREDVT_RET_IREGS = 1,
 259         GSHAREDVT_RET_DOUBLE_FPSTACK = 2,
 260         GSHAREDVT_RET_FLOAT_FPSTACK = 3,
 261         GSHAREDVT_RET_STACK_POP = 4,
 262         GSHAREDVT_RET_I1 = 5,
 263         GSHAREDVT_RET_U1 = 6,
 264         GSHAREDVT_RET_I2 = 7,
 265         GSHAREDVT_RET_U2 = 8,
 266         GSHAREDVT_RET_IREG = 9
 267 } GSharedVtRetMarshal;
 268
 269 typedef struct {
 270         /* Method address to call */
 271         gpointer addr;
 272         /* The trampoline reads this, so keep the size explicit */
 273         int ret_marshal;
 274         /* If ret_marshal != NONE, this is the stack slot of the vret arg, else -1 */
 275         int vret_arg_slot;
 276         /* The stack slot where the return value will be stored */
 277         int vret_slot;
 278         int stack_usage, map_count;
 279         /* If not -1, then make a virtual call using this vtable offset */
 280         int vcall_offset;
 281         /* If 1, make an indirect call to the address in the rgctx reg */
 282         int calli;
 283         /* Whenever this is a in or an out call */
 284         int gsharedvt_in;
 285         int map [MONO_ZERO_LEN_ARRAY];
 286 } GSharedVtCallInfo;
 287
 288 typedef enum {
 289         ArgInIReg,
 290         ArgInFloatSSEReg,
 291         ArgInDoubleSSEReg,
 292         ArgOnStack,
 293         ArgValuetypeInReg,
 294         ArgOnFloatFpStack,
 295         ArgOnDoubleFpStack,
 296         /* gsharedvt argument passed by addr */
 297         ArgGSharedVt,
 298         ArgNone
 299 } ArgStorage;
 300
 301 typedef struct {
 302         gint16 offset;
 303         gint8  reg;
 304         ArgStorage storage;
 305         int nslots;
 306         gboolean is_pair;
 307
 308         /* Only if storage == ArgValuetypeInReg */
 309         ArgStorage pair_storage [2];
 310         gint8 pair_regs [2];
 311         guint8 pass_empty_struct : 1; // Set in scenarios when empty structs needs to be represented as argument.
 312 } ArgInfo;
 313
 314 typedef struct {
 315         int nargs;
 316         guint32 stack_usage;
 317         guint32 reg_usage;
 318         guint32 freg_usage;
 319         gboolean need_stack_align;
 320         guint32 stack_align_amount;
 321         gboolean vtype_retaddr;
 322         /* The index of the vret arg in the argument list */
 323         int vret_arg_index;
 324         int vret_arg_offset;
 325         /* Argument space popped by the callee */
 326         int callee_stack_pop;
 327         ArgInfo ret;
 328         ArgInfo sig_cookie;
 329         ArgInfo args [1];
 330 } CallInfo;
 331
 332 guint32
 333 mono_x86_get_this_arg_offset (MonoMethodSignature *sig);
 334
 335 void
 336 mono_x86_throw_exception (mgreg_t *regs, MonoObject *exc,
 337                                                   mgreg_t eip, gboolean rethrow);
 338
 339 void
 340 mono_x86_throw_corlib_exception (mgreg_t *regs, guint32 ex_token_index,
 341                                                                  mgreg_t eip, gint32 pc_offset);
 342
 343 void
 344 mono_x86_patch (unsigned char* code, gpointer target);
 345
 346 gpointer
 347 mono_x86_start_gsharedvt_call (GSharedVtCallInfo *info, gpointer *caller, gpointer *callee, gpointer mrgctx_reg);
 348
 349 CallInfo*
 350 mono_arch_get_call_info (MonoMemPool *mp, MonoMethodSignature *sig);
 351
 352 #endif /* __MONO_MINI_X86_H__ */
 353