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