Pass mono_install_handler_block_guard in the eh callback table
[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_SIMD_INTRINSICS 1
78 #define MONO_ARCH_SUPPORT_TASKLETS 1
79
80 #ifndef DISABLE_SIMD
81 #define MONO_ARCH_SIMD_INTRINSICS 1
82 #define MONO_ARCH_NEED_SIMD_BANK 1
83 #endif
84
85 /* we should lower this size and make sure we don't call heavy stack users in the segv handler */
86 #define MONO_ARCH_SIGNAL_STACK_SIZE (16 * 1024)
87 #define MONO_ARCH_HAVE_RESTORE_STACK_SUPPORT 1
88
89 #define MONO_ARCH_CPU_SPEC x86_desc
90
91 #define MONO_MAX_IREGS 8
92 #define MONO_MAX_FREGS 8
93 #define MONO_MAX_XREGS 8
94
95 /* Parameters used by the register allocator */
96 #define MONO_ARCH_CALLEE_REGS X86_CALLEE_REGS
97 #define MONO_ARCH_CALLEE_SAVED_REGS X86_CALLER_REGS
98
99 #define MONO_ARCH_CALLEE_FREGS (0xff & ~(regmask (MONO_ARCH_FPSTACK_SIZE)))
100 #define MONO_ARCH_CALLEE_SAVED_FREGS 0
101
102 /* All registers are clobered by a call */
103 #define MONO_ARCH_CALLEE_XREGS (0xff & ~(regmask (MONO_MAX_XREGS)))
104 #define MONO_ARCH_CALLEE_SAVED_XREGS 0
105
106 #define MONO_ARCH_USE_FPSTACK TRUE
107 #define MONO_ARCH_FPSTACK_SIZE 6
108
109 #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)))))
110
111 #define MONO_ARCH_INST_FIXED_MASK(desc) ((desc == 'y') ? (X86_BYTE_REGS) : 0)
112
113 /* RDX is clobbered by the opcode implementation before accessing sreg2 */
114 /* 
115  * Originally this contained X86_EDX for div/rem opcodes, but that led to unsolvable 
116  * situations since there are only 3 usable registers for local register allocation.
117  * Instead, we handle the sreg2==edx case in the opcodes.
118  */
119 #define MONO_ARCH_INST_SREG2_MASK(ins) 0
120
121 /*
122  * L is a generic register pair, while l means eax:rdx
123  */
124 #define MONO_ARCH_INST_IS_REGPAIR(desc) (desc == 'l' || desc == 'L')
125 #define MONO_ARCH_INST_REGPAIR_REG2(desc,hreg1) (desc == 'l' ? X86_EDX : -1)
126
127 /* must be at a power of 2 and >= 8 */
128 #define MONO_ARCH_FRAME_ALIGNMENT 16
129
130 /* fixme: align to 16byte instead of 32byte (we align to 32byte to get 
131  * reproduceable results for benchmarks */
132 #define MONO_ARCH_CODE_ALIGNMENT 32
133
134 #define MONO_ARCH_RETREG1 X86_EAX
135 #define MONO_ARCH_RETREG2 X86_EDX
136
137 /*This is the max size of the locals area of a given frame. I think 1MB is a safe default for now*/
138 #define MONO_ARCH_MAX_FRAME_SIZE 0x100000
139
140 /*This is how much a try block must be extended when is is preceeded by a Monitor.Enter() call.
141 It's 4 bytes as this is how many bytes + 1 that 'add 0x10, %esp' takes. It is used to pop the arguments from
142 the monitor.enter call and must be already protected.*/
143 #define MONO_ARCH_MONITOR_ENTER_ADJUSTMENT 4
144
145 struct MonoLMF {
146         /* 
147          * If the lowest bit is set to 1, then this is a trampoline LMF frame.
148          * If the second lowest bit is set to 1, then this is a MonoLMFExt structure, and
149          * the other fields are not valid.
150          */
151         guint32    previous_lmf;
152         gpointer    lmf_addr;
153         /* Only set in trampoline LMF frames */
154         MonoMethod *method;
155         /* Only set in trampoline LMF frames */
156         guint32     esp;
157         guint32     ebx;
158         guint32     edi;
159         guint32     esi;
160         guint32     ebp;
161         guint32     eip;
162 };
163
164 typedef struct {
165         gboolean need_stack_frame_inited;
166         gboolean need_stack_frame;
167 } MonoCompileArch;
168
169 #define MONO_CONTEXT_SET_LLVM_EXC_REG(ctx, exc) do { (ctx)->eax = (gsize)exc; } while (0)
170
171 #ifdef _MSC_VER
172
173 #define MONO_INIT_CONTEXT_FROM_FUNC(ctx, start_func) do { \
174     unsigned int stackptr; \
175         mono_arch_flush_register_windows (); \
176     { \
177            __asm mov stackptr, ebp \
178     } \
179         MONO_CONTEXT_SET_IP ((ctx), (start_func)); \
180         MONO_CONTEXT_SET_BP ((ctx), stackptr); \
181         MONO_CONTEXT_SET_SP ((ctx), stackptr); \
182 } while (0)
183
184 #else
185
186 #define MONO_INIT_CONTEXT_FROM_FUNC(ctx,start_func) do {        \
187                 mono_arch_flush_register_windows ();    \
188                 MONO_CONTEXT_SET_IP ((ctx), (start_func));      \
189                 MONO_CONTEXT_SET_BP ((ctx), __builtin_frame_address (0));       \
190                 MONO_CONTEXT_SET_SP ((ctx), __builtin_frame_address (0));       \
191         } while (0)
192
193 #endif
194
195 #define MONO_ARCH_INIT_TOP_LMF_ENTRY(lmf) do { (lmf)->ebp = -1; } while (0)
196
197 /* Enables OP_LSHL, OP_LSHL_IMM, OP_LSHR, OP_LSHR_IMM, OP_LSHR_UN, OP_LSHR_UN_IMM */
198 #define MONO_ARCH_NO_EMULATE_LONG_SHIFT_OPS
199
200 #define MONO_ARCH_BIGMUL_INTRINS 1
201 #define MONO_ARCH_NEED_DIV_CHECK 1
202 #define MONO_ARCH_HAVE_IS_INT_OVERFLOW 1
203 #define MONO_ARCH_HAVE_INVALIDATE_METHOD 1
204 #define MONO_ARCH_NEED_GOT_VAR 1
205 #if !defined(__APPLE__)
206 #define MONO_ARCH_ENABLE_MONO_LMF_VAR 1
207 #endif
208 #define MONO_ARCH_HAVE_CREATE_DELEGATE_TRAMPOLINE 1
209 #define MONO_ARCH_HAVE_ATOMIC_ADD 1
210 #define MONO_ARCH_HAVE_ATOMIC_EXCHANGE 1
211 #define MONO_ARCH_HAVE_ATOMIC_CAS 1
212 #define MONO_ARCH_HAVE_IMT 1
213 #define MONO_ARCH_HAVE_TLS_GET (mono_x86_have_tls_get ())
214 #define MONO_ARCH_IMT_REG X86_EDX
215 #define MONO_ARCH_VTABLE_REG X86_EDX
216 #define MONO_ARCH_RGCTX_REG X86_EDX
217 #define MONO_ARCH_HAVE_GENERALIZED_IMT_THUNK 1
218 #define MONO_ARCH_HAVE_LIVERANGE_OPS 1
219 #define MONO_ARCH_HAVE_XP_UNWIND 1
220 #define MONO_ARCH_HAVE_SIGCTX_TO_MONOCTX 1
221 #if defined(__linux__) || defined (__APPLE__)
222 #define MONO_ARCH_MONITOR_OBJECT_REG X86_EAX
223 #endif
224 #define MONO_ARCH_HAVE_STATIC_RGCTX_TRAMPOLINE 1
225 #if !defined (__APPLE__) || defined(__native_client_codegen__)
226 #define MONO_ARCH_HAVE_FULL_AOT_TRAMPOLINES 1
227 #endif
228 #define MONO_ARCH_GOT_REG X86_EBX
229 #define MONO_ARCH_HAVE_GET_TRAMPOLINES 1
230
231 #define MONO_ARCH_HAVE_CMOV_OPS 1
232
233 #ifdef MONO_ARCH_SIMD_INTRINSICS
234 #define MONO_ARCH_HAVE_DECOMPOSE_OPTS 1
235 #endif
236
237 #define MONO_ARCH_HAVE_DECOMPOSE_LONG_OPTS 1
238
239 #define MONO_ARCH_AOT_SUPPORTED 1
240
241 #define MONO_ARCH_ENABLE_MONITOR_IL_FASTPATH 1
242
243 #define MONO_ARCH_GSHARED_SUPPORTED 1
244 #define MONO_ARCH_HAVE_LLVM_IMT_TRAMPOLINE 1
245 #define MONO_ARCH_LLVM_SUPPORTED 1
246 #define MONO_ARCH_THIS_AS_FIRST_ARG 1
247
248 #if defined(MONO_ARCH_USE_SIGACTION) || defined(TARGET_WIN32)
249 #define MONO_ARCH_SOFT_DEBUG_SUPPORTED 1
250 #endif
251
252 #define MONO_ARCH_HAVE_EXCEPTIONS_INIT 1
253 #define MONO_ARCH_HAVE_HANDLER_BLOCK_GUARD 1
254
255 #define MONO_ARCH_HAVE_CARD_TABLE_WBARRIER 1
256 #define MONO_ARCH_HAVE_SETUP_RESUME_FROM_SIGNAL_HANDLER_CTX 1
257 #define MONO_ARCH_GC_MAPS_SUPPORTED 1
258 #define MONO_ARCH_HAVE_CONTEXT_SET_INT_REG 1
259 #define MONO_ARCH_HAVE_SETUP_ASYNC_CALLBACK 1
260
261 gboolean
262 mono_x86_tail_call_supported (MonoMethodSignature *caller_sig, MonoMethodSignature *callee_sig) MONO_INTERNAL;
263
264 #define MONO_ARCH_USE_OP_TAIL_CALL(caller_sig, callee_sig) mono_x86_tail_call_supported (caller_sig, callee_sig)
265
266 /* Used for optimization, not complete */
267 #define MONO_ARCH_IS_OP_MEMBASE(opcode) ((opcode) == OP_X86_PUSH_MEMBASE)
268
269 #define MONO_ARCH_EMIT_BOUNDS_CHECK(cfg, array_reg, offset, index_reg) do { \
270             MonoInst *inst; \
271             MONO_INST_NEW ((cfg), inst, OP_X86_COMPARE_MEMBASE_REG); \
272             inst->inst_basereg = array_reg; \
273             inst->inst_offset = offset; \
274             inst->sreg2 = index_reg; \
275             MONO_ADD_INS ((cfg)->cbb, inst); \
276                         MONO_EMIT_NEW_COND_EXC (cfg, LE_UN, "IndexOutOfRangeException"); \
277         } while (0)
278
279 typedef struct {
280         guint8 *address;
281         guint8 saved_byte;
282 } MonoBreakpointInfo;
283
284 extern MonoBreakpointInfo mono_breakpoint_info [MONO_BREAKPOINT_ARRAY_SIZE];
285
286 guint8*
287 mono_x86_emit_tls_get (guint8* code, int dreg, int tls_offset) MONO_INTERNAL;
288
289 guint32
290 mono_x86_get_this_arg_offset (MonoGenericSharingContext *gsctx, MonoMethodSignature *sig) MONO_INTERNAL;
291
292 gboolean
293 mono_x86_have_tls_get (void) MONO_INTERNAL;
294
295 void
296 mono_x86_throw_exception (mgreg_t *regs, MonoObject *exc, 
297                                                   mgreg_t eip, gboolean rethrow) MONO_INTERNAL;
298
299 void
300 mono_x86_throw_corlib_exception (mgreg_t *regs, guint32 ex_token_index, 
301                                                                  mgreg_t eip, gint32 pc_offset) MONO_INTERNAL;
302
303 void 
304 mono_x86_patch (unsigned char* code, gpointer target) MONO_INTERNAL;
305
306 #endif /* __MONO_MINI_X86_H__ */  
307