2010-03-30 Rodrigo Kumpera <rkumpera@novell.com>
[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 #ifdef HOST_WIN32
7 #include <windows.h>
8 /* use SIG* defines if possible */
9 #ifdef HAVE_SIGNAL_H
10 #include <signal.h>
11 #endif
12
13 /* sigcontext surrogate */
14 struct sigcontext {
15         unsigned int eax;
16         unsigned int ebx;
17         unsigned int ecx;
18         unsigned int edx;
19         unsigned int ebp;
20         unsigned int esp;
21         unsigned int esi;
22         unsigned int edi;
23         unsigned int eip;
24 };
25
26 typedef void (* MonoW32ExceptionHandler) (int _dummy, EXCEPTION_RECORD *info, void *context);
27 void win32_seh_init(void);
28 void win32_seh_cleanup(void);
29 void win32_seh_set_handler(int type, MonoW32ExceptionHandler handler);
30
31 #ifndef SIGFPE
32 #define SIGFPE 4
33 #endif
34
35 #ifndef SIGILL
36 #define SIGILL 8
37 #endif
38
39 #ifndef SIGSEGV
40 #define SIGSEGV 11
41 #endif
42
43 LONG CALLBACK seh_handler(EXCEPTION_POINTERS* ep);
44
45 #endif /* HOST_WIN32 */
46
47 #if defined( __linux__) || defined(__sun) || defined(__APPLE__) || defined(__NetBSD__) || \
48        defined(__FreeBSD__) || defined(__OpenBSD__)
49 #define MONO_ARCH_USE_SIGACTION
50 #endif
51
52 #ifndef HOST_WIN32
53
54 #ifdef HAVE_WORKING_SIGALTSTACK
55 /* 
56  * solaris doesn't have pthread_getattr_np () needed by the sigaltstack setup
57  * code.
58  */
59 #ifndef __sun
60 #define MONO_ARCH_SIGSEGV_ON_ALTSTACK
61 #endif
62 #define MONO_ARCH_USE_SIGACTION
63
64 #endif /* HAVE_WORKING_SIGALTSTACK */
65 #endif /* !HOST_WIN32 */
66
67 #define MONO_ARCH_SUPPORT_SIMD_INTRINSICS 1
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 #define MONO_ARCH_SIGNAL_STACK_SIZE (16 * 1024)
77 #define MONO_ARCH_HAVE_RESTORE_STACK_SUPPORT 1
78
79 #define MONO_ARCH_CPU_SPEC x86_desc
80
81 #define MONO_MAX_IREGS 8
82 #define MONO_MAX_FREGS 8
83 #define MONO_MAX_XREGS 8
84
85 /* Parameters used by the register allocator */
86 #define MONO_ARCH_CALLEE_REGS X86_CALLEE_REGS
87 #define MONO_ARCH_CALLEE_SAVED_REGS X86_CALLER_REGS
88
89 #define MONO_ARCH_CALLEE_FREGS (0xff & ~(regmask (MONO_ARCH_FPSTACK_SIZE)))
90 #define MONO_ARCH_CALLEE_SAVED_FREGS 0
91
92 /* All registers are clobered by a call */
93 #define MONO_ARCH_CALLEE_XREGS (0xff & ~(regmask (MONO_MAX_XREGS)))
94 #define MONO_ARCH_CALLEE_SAVED_XREGS 0
95
96 #define MONO_ARCH_USE_FPSTACK TRUE
97 #define MONO_ARCH_FPSTACK_SIZE 6
98
99 #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)))))
100
101 #define MONO_ARCH_INST_FIXED_MASK(desc) ((desc == 'y') ? (X86_BYTE_REGS) : 0)
102
103 /* RDX is clobbered by the opcode implementation before accessing sreg2 */
104 /* 
105  * Originally this contained X86_EDX for div/rem opcodes, but that led to unsolvable 
106  * situations since there are only 3 usable registers for local register allocation.
107  * Instead, we handle the sreg2==edx case in the opcodes.
108  */
109 #define MONO_ARCH_INST_SREG2_MASK(ins) 0
110
111 /*
112  * L is a generic register pair, while l means eax:rdx
113  */
114 #define MONO_ARCH_INST_IS_REGPAIR(desc) (desc == 'l' || desc == 'L')
115 #define MONO_ARCH_INST_REGPAIR_REG2(desc,hreg1) (desc == 'l' ? X86_EDX : -1)
116
117 /* must be at a power of 2 and >= 8 */
118 #define MONO_ARCH_FRAME_ALIGNMENT 16
119
120 /* fixme: align to 16byte instead of 32byte (we align to 32byte to get 
121  * reproduceable results for benchmarks */
122 #define MONO_ARCH_CODE_ALIGNMENT 32
123
124 #define MONO_ARCH_RETREG1 X86_EAX
125 #define MONO_ARCH_RETREG2 X86_EDX
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 struct MonoLMF {
131         /* 
132          * If the lowest bit is set to 1, then this is a trampoline LMF frame.
133          * If the second lowest bit is set to 1, then this is a MonoLMFExt structure, and
134          * the other fields are not valid.
135          */
136         guint32    previous_lmf;
137         gpointer    lmf_addr;
138         /* Only set in trampoline LMF frames */
139         MonoMethod *method;
140         /* Only set in trampoline LMF frames */
141         guint32     esp;
142         guint32     ebx;
143         guint32     edi;
144         guint32     esi;
145         guint32     ebp;
146         guint32     eip;
147 };
148
149 typedef struct {
150         gboolean need_stack_frame_inited;
151         gboolean need_stack_frame;
152 } MonoCompileArch;
153
154 #if defined(__FreeBSD__) || defined(__NetBSD__) || defined(__OpenBSD__) || defined(__APPLE__)
155 # define SC_EAX sc_eax
156 # define SC_EBX sc_ebx
157 # define SC_ECX sc_ecx
158 # define SC_EDX sc_edx
159 # define SC_EBP sc_ebp
160 # define SC_EIP sc_eip
161 # define SC_ESP sc_esp
162 # define SC_EDI sc_edi
163 # define SC_ESI sc_esi
164 #else
165 # define SC_EAX eax
166 # define SC_EBX ebx
167 # define SC_ECX ecx
168 # define SC_EDX edx
169 # define SC_EBP ebp
170 # define SC_EIP eip
171 # define SC_ESP esp
172 # define SC_EDI edi
173 # define SC_ESI esi
174 #endif
175
176 typedef struct {
177         guint32 eax;
178         guint32 ebx;
179         guint32 ecx;
180         guint32 edx;
181         guint32 ebp;
182         guint32 esp;
183     guint32 esi;
184         guint32 edi;
185         guint32 eip;
186 } MonoContext;
187
188 #define MONO_CONTEXT_SET_IP(ctx,ip) do { (ctx)->eip = (long)(ip); } while (0); 
189 #define MONO_CONTEXT_SET_BP(ctx,bp) do { (ctx)->ebp = (long)(bp); } while (0); 
190 #define MONO_CONTEXT_SET_SP(ctx,sp) do { (ctx)->esp = (long)(sp); } while (0); 
191
192 #define MONO_CONTEXT_GET_IP(ctx) ((gpointer)((ctx)->eip))
193 #define MONO_CONTEXT_GET_BP(ctx) ((gpointer)((ctx)->ebp))
194 #define MONO_CONTEXT_GET_SP(ctx) ((gpointer)((ctx)->esp))
195
196 #define MONO_CONTEXT_SET_LLVM_EXC_REG(ctx, exc) do { (ctx)->eax = (gsize)exc; } while (0)
197
198 #ifdef _MSC_VER
199
200 #define MONO_INIT_CONTEXT_FROM_FUNC(ctx, start_func) do { \
201     unsigned int stackptr; \
202         mono_arch_flush_register_windows (); \
203     { \
204            __asm mov stackptr, ebp \
205     } \
206         MONO_CONTEXT_SET_IP ((ctx), (start_func)); \
207         MONO_CONTEXT_SET_BP ((ctx), stackptr); \
208         MONO_CONTEXT_SET_SP ((ctx), stackptr); \
209 } while (0)
210
211 #else
212
213 #define MONO_INIT_CONTEXT_FROM_FUNC(ctx,start_func) do {        \
214                 mono_arch_flush_register_windows ();    \
215                 MONO_CONTEXT_SET_IP ((ctx), (start_func));      \
216                 MONO_CONTEXT_SET_BP ((ctx), __builtin_frame_address (0));       \
217                 MONO_CONTEXT_SET_SP ((ctx), __builtin_frame_address (0));       \
218         } while (0)
219
220 #endif
221
222 /*
223  * This structure is an extension of MonoLMF and contains extra information.
224  */
225 typedef struct {
226         struct MonoLMF lmf;
227         gboolean debugger_invoke;
228         MonoContext ctx; /* if debugger_invoke is TRUE */
229 } MonoLMFExt;
230
231 /* Enables OP_LSHL, OP_LSHL_IMM, OP_LSHR, OP_LSHR_IMM, OP_LSHR_UN, OP_LSHR_UN_IMM */
232 #define MONO_ARCH_NO_EMULATE_LONG_SHIFT_OPS
233
234 #define MONO_ARCH_BIGMUL_INTRINS 1
235 #define MONO_ARCH_NEED_DIV_CHECK 1
236 #define MONO_ARCH_HAVE_IS_INT_OVERFLOW 1
237 #define MONO_ARCH_HAVE_INVALIDATE_METHOD 1
238 #define MONO_ARCH_NEED_GOT_VAR 1
239 #define MONO_ARCH_HAVE_THROW_CORLIB_EXCEPTION 1
240 #define MONO_ARCH_ENABLE_MONO_LMF_VAR 1
241 #define MONO_ARCH_HAVE_CREATE_DELEGATE_TRAMPOLINE 1
242 #define MONO_ARCH_HAVE_ATOMIC_ADD 1
243 #define MONO_ARCH_HAVE_ATOMIC_EXCHANGE 1
244 #define MONO_ARCH_HAVE_ATOMIC_CAS 1
245 #define MONO_ARCH_HAVE_IMT 1
246 #define MONO_ARCH_HAVE_TLS_GET (mono_x86_have_tls_get ())
247 #define MONO_ARCH_IMT_REG X86_EDX
248 #define MONO_ARCH_VTABLE_REG X86_EDX
249 #define MONO_ARCH_RGCTX_REG X86_EDX
250 #define MONO_ARCH_HAVE_GENERALIZED_IMT_THUNK 1
251 #define MONO_ARCH_HAVE_LIVERANGE_OPS 1
252 #define MONO_ARCH_HAVE_XP_UNWIND 1
253 #define MONO_ARCH_HAVE_SIGCTX_TO_MONOCTX 1
254 #if defined(__linux__) && !defined(HAVE_MOVING_COLLECTOR)
255 #define MONO_ARCH_MONITOR_OBJECT_REG X86_EAX
256 #endif
257 #define MONO_ARCH_HAVE_STATIC_RGCTX_TRAMPOLINE 1
258
259 #define MONO_ARCH_HAVE_CMOV_OPS 1
260
261 #ifdef MONO_ARCH_SIMD_INTRINSICS
262 #define MONO_ARCH_HAVE_DECOMPOSE_OPTS 1
263 #endif
264
265 #define MONO_ARCH_HAVE_DECOMPOSE_LONG_OPTS 1
266
267 #if !defined(__APPLE__)
268 #define MONO_ARCH_AOT_SUPPORTED 1
269 #endif
270
271 #if defined(__linux__) || defined(__sun)
272 #define MONO_ARCH_ENABLE_MONITOR_IL_FASTPATH 1
273 #endif
274
275 #define MONO_ARCH_GSHARED_SUPPORTED 1
276 #define MONO_ARCH_HAVE_LLVM_IMT_TRAMPOLINE 1
277 #define MONO_ARCH_LLVM_SUPPORTED 1
278 #define MONO_ARCH_SOFT_DEBUG_SUPPORTED 1
279 #define MONO_ARCH_HAVE_FIND_JIT_INFO_EXT 1
280 #define MONO_ARCH_HAVE_EXCEPTIONS_INIT 1
281 #define MONO_ARCH_HAVE_HANDLER_BLOCK_GUARD 1
282
283 /* Used for optimization, not complete */
284 #define MONO_ARCH_IS_OP_MEMBASE(opcode) ((opcode) == OP_X86_PUSH_MEMBASE)
285
286 #define MONO_ARCH_EMIT_BOUNDS_CHECK(cfg, array_reg, offset, index_reg) do { \
287             MonoInst *inst; \
288             MONO_INST_NEW ((cfg), inst, OP_X86_COMPARE_MEMBASE_REG); \
289             inst->inst_basereg = array_reg; \
290             inst->inst_offset = offset; \
291             inst->sreg2 = index_reg; \
292             MONO_ADD_INS ((cfg)->cbb, inst); \
293                         MONO_EMIT_NEW_COND_EXC (cfg, LE_UN, "IndexOutOfRangeException"); \
294         } while (0)
295
296 typedef struct {
297         guint8 *address;
298         guint8 saved_byte;
299 } MonoBreakpointInfo;
300
301 extern MonoBreakpointInfo mono_breakpoint_info [MONO_BREAKPOINT_ARRAY_SIZE];
302
303 guint8*
304 mono_x86_emit_tls_get (guint8* code, int dreg, int tls_offset) MONO_INTERNAL;
305
306 guint32
307 mono_x86_get_this_arg_offset (MonoGenericSharingContext *gsctx, MonoMethodSignature *sig) MONO_INTERNAL;
308
309 gboolean
310 mono_x86_have_tls_get (void) MONO_INTERNAL;
311
312 #endif /* __MONO_MINI_X86_H__ */  
313