2008-10-03 Mark Probst <mark.probst@gmail.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 #ifdef PLATFORM_WIN32
6 #include <windows.h>
7 /* use SIG* defines if possible */
8 #ifdef HAVE_SIGNAL_H
9 #include <signal.h>
10 #endif
11
12 /* sigcontext surrogate */
13 struct sigcontext {
14         unsigned int eax;
15         unsigned int ebx;
16         unsigned int ecx;
17         unsigned int edx;
18         unsigned int ebp;
19         unsigned int esp;
20         unsigned int esi;
21         unsigned int edi;
22         unsigned int eip;
23 };
24
25 typedef void (* MonoW32ExceptionHandler) (int);
26 void win32_seh_init(void);
27 void win32_seh_cleanup(void);
28 void win32_seh_set_handler(int type, MonoW32ExceptionHandler handler);
29
30 #ifndef SIGFPE
31 #define SIGFPE 4
32 #endif
33
34 #ifndef SIGILL
35 #define SIGILL 8
36 #endif
37
38 #ifndef SIGSEGV
39 #define SIGSEGV 11
40 #endif
41
42 LONG CALLBACK seh_handler(EXCEPTION_POINTERS* ep);
43
44 #endif /* PLATFORM_WIN32 */
45
46 #if defined( __linux__) || defined(__sun) || defined(__APPLE__) || defined(__NetBSD__)
47 #define MONO_ARCH_USE_SIGACTION
48 #endif
49
50 #ifndef PLATFORM_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 #define MONO_ARCH_USE_SIGACTION
61
62 #endif /* HAVE_WORKING_SIGALTSTACK */
63 #endif /* !PLATFORM_WIN32 */
64
65 #define MONO_ARCH_SUPPORT_SIMD_INTRINSICS 1
66
67 #ifndef DISABLE_SIMD
68 #define MONO_ARCH_SIMD_INTRINSICS 1
69 #define MONO_ARCH_NEED_SIMD_BANK 1
70 #endif
71
72 /* we should lower this size and make sure we don't call heavy stack users in the segv handler */
73 #define MONO_ARCH_SIGNAL_STACK_SIZE (16 * 1024)
74 #define MONO_ARCH_HAVE_RESTORE_STACK_SUPPORT 1
75
76 #define MONO_ARCH_CPU_SPEC x86_desc
77
78 #define MONO_MAX_IREGS 8
79 #define MONO_MAX_FREGS 8
80 #define MONO_MAX_XREGS 8
81
82 /* Parameters used by the register allocator */
83 #define MONO_ARCH_CALLEE_REGS X86_CALLEE_REGS
84 #define MONO_ARCH_CALLEE_SAVED_REGS X86_CALLER_REGS
85
86 #define MONO_ARCH_CALLEE_FREGS (0xff & ~(regmask (MONO_ARCH_FPSTACK_SIZE)))
87 #define MONO_ARCH_CALLEE_SAVED_FREGS 0
88
89 /* All registers are clobered by a call */
90 #define MONO_ARCH_CALLEE_XREGS (0xff & ~(regmask (MONO_MAX_XREGS)))
91 #define MONO_ARCH_CALLEE_SAVED_XREGS 0
92
93 #define MONO_ARCH_USE_FPSTACK TRUE
94 #define MONO_ARCH_FPSTACK_SIZE 6
95
96 #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)))))
97
98 #define MONO_ARCH_INST_FIXED_MASK(desc) ((desc == 'y') ? (X86_BYTE_REGS) : 0)
99
100 /* RDX is clobbered by the opcode implementation before accessing sreg2 */
101 /* 
102  * Originally this contained X86_EDX for div/rem opcodes, but that led to unsolvable 
103  * situations since there are only 3 usable registers for local register allocation.
104  * Instead, we handle the sreg2==edx case in the opcodes.
105  */
106 #define MONO_ARCH_INST_SREG2_MASK(ins) 0
107
108 /*
109  * L is a generic register pair, while l means eax:rdx
110  */
111 #define MONO_ARCH_INST_IS_REGPAIR(desc) (desc == 'l' || desc == 'L')
112 #define MONO_ARCH_INST_REGPAIR_REG2(desc,hreg1) (desc == 'l' ? X86_EDX : -1)
113
114 #if __APPLE__
115 #define MONO_ARCH_FRAME_ALIGNMENT 16
116 #else
117 /* For storing doubles on the stack */
118 #define MONO_ARCH_FRAME_ALIGNMENT 8
119 #endif
120
121 /* fixme: align to 16byte instead of 32byte (we align to 32byte to get 
122  * reproduceable results for benchmarks */
123 #define MONO_ARCH_CODE_ALIGNMENT 32
124
125 #define MONO_ARCH_BASEREG X86_EBP
126 #define MONO_ARCH_RETREG1 X86_EAX
127 #define MONO_ARCH_RETREG2 X86_EDX
128
129 #define MONO_ARCH_ENCODE_LREG(r1,r2) (r1 | (r2<<3))
130
131 #define inst_dreg_low dreg&7 
132 #define inst_dreg_high dreg>>3
133 #define inst_sreg1_low sreg1&7 
134 #define inst_sreg1_high sreg1>>3
135 #define inst_sreg2_low sreg2&7 
136 #define inst_sreg2_high sreg2>>3
137
138 struct MonoLMF {
139         /* Offset by 1 if this is a trampoline LMF frame */
140         guint32    previous_lmf;
141         gpointer    lmf_addr;
142         /* Only set in trampoline LMF frames */
143         MonoMethod *method;
144         /* Only set in trampoline LMF frames */
145         guint32     esp;
146         guint32     ebx;
147         guint32     edi;
148         guint32     esi;
149         guint32     ebp;
150         guint32     eip;
151 };
152
153 typedef void* MonoCompileArch;
154
155 #if defined(__FreeBSD__) || defined(__APPLE__)
156 #include <ucontext.h>
157 #endif 
158
159 #if defined(__FreeBSD__)
160         #define UCONTEXT_REG_EAX(ctx) ((ctx)->uc_mcontext.mc_eax)
161         #define UCONTEXT_REG_EBX(ctx) ((ctx)->uc_mcontext.mc_ebx)
162         #define UCONTEXT_REG_ECX(ctx) ((ctx)->uc_mcontext.mc_ecx)
163         #define UCONTEXT_REG_EDX(ctx) ((ctx)->uc_mcontext.mc_edx)
164         #define UCONTEXT_REG_EBP(ctx) ((ctx)->uc_mcontext.mc_ebp)
165         #define UCONTEXT_REG_ESP(ctx) ((ctx)->uc_mcontext.mc_esp)
166         #define UCONTEXT_REG_ESI(ctx) ((ctx)->uc_mcontext.mc_esi)
167         #define UCONTEXT_REG_EDI(ctx) ((ctx)->uc_mcontext.mc_edi)
168         #define UCONTEXT_REG_EIP(ctx) ((ctx)->uc_mcontext.mc_eip)
169 #elif defined(__APPLE__) && defined(_STRUCT_MCONTEXT)
170         #define UCONTEXT_REG_EAX(ctx) ((ctx)->uc_mcontext->__ss.__eax)
171         #define UCONTEXT_REG_EBX(ctx) ((ctx)->uc_mcontext->__ss.__ebx)
172         #define UCONTEXT_REG_ECX(ctx) ((ctx)->uc_mcontext->__ss.__ecx)
173         #define UCONTEXT_REG_EDX(ctx) ((ctx)->uc_mcontext->__ss.__edx)
174         #define UCONTEXT_REG_EBP(ctx) ((ctx)->uc_mcontext->__ss.__ebp)
175         #define UCONTEXT_REG_ESP(ctx) ((ctx)->uc_mcontext->__ss.__esp)
176         #define UCONTEXT_REG_ESI(ctx) ((ctx)->uc_mcontext->__ss.__esi)
177         #define UCONTEXT_REG_EDI(ctx) ((ctx)->uc_mcontext->__ss.__edi)
178         #define UCONTEXT_REG_EIP(ctx) ((ctx)->uc_mcontext->__ss.__eip)
179 #elif defined(__APPLE__) && !defined(_STRUCT_MCONTEXT)
180         #define UCONTEXT_REG_EAX(ctx) ((ctx)->uc_mcontext->ss.eax)
181         #define UCONTEXT_REG_EBX(ctx) ((ctx)->uc_mcontext->ss.ebx)
182         #define UCONTEXT_REG_ECX(ctx) ((ctx)->uc_mcontext->ss.ecx)
183         #define UCONTEXT_REG_EDX(ctx) ((ctx)->uc_mcontext->ss.edx)
184         #define UCONTEXT_REG_EBP(ctx) ((ctx)->uc_mcontext->ss.ebp)
185         #define UCONTEXT_REG_ESP(ctx) ((ctx)->uc_mcontext->ss.esp)
186         #define UCONTEXT_REG_ESI(ctx) ((ctx)->uc_mcontext->ss.esi)
187         #define UCONTEXT_REG_EDI(ctx) ((ctx)->uc_mcontext->ss.edi)
188         #define UCONTEXT_REG_EIP(ctx) ((ctx)->uc_mcontext->ss.eip)
189 #elif defined(__NetBSD__)
190         #define UCONTEXT_REG_EAX(ctx) ((ctx)->uc_mcontext.__gregs [_REG_EAX])
191         #define UCONTEXT_REG_EBX(ctx) ((ctx)->uc_mcontext.__gregs [_REG_EBX])
192         #define UCONTEXT_REG_ECX(ctx) ((ctx)->uc_mcontext.__gregs [_REG_ECX])
193         #define UCONTEXT_REG_EDX(ctx) ((ctx)->uc_mcontext.__gregs [_REG_EDX])
194         #define UCONTEXT_REG_EBP(ctx) ((ctx)->uc_mcontext.__gregs [_REG_EBP])
195         #define UCONTEXT_REG_ESP(ctx) ((ctx)->uc_mcontext.__gregs [_REG_ESP])
196         #define UCONTEXT_REG_ESI(ctx) ((ctx)->uc_mcontext.__gregs [_REG_ESI])
197         #define UCONTEXT_REG_EDI(ctx) ((ctx)->uc_mcontext.__gregs [_REG_EDI])
198         #define UCONTEXT_REG_EIP(ctx) ((ctx)->uc_mcontext.__gregs [_REG_EIP])
199 #else
200         #define UCONTEXT_REG_EAX(ctx) ((ctx)->uc_mcontext.gregs [REG_EAX])
201         #define UCONTEXT_REG_EBX(ctx) ((ctx)->uc_mcontext.gregs [REG_EBX])
202         #define UCONTEXT_REG_ECX(ctx) ((ctx)->uc_mcontext.gregs [REG_ECX])
203         #define UCONTEXT_REG_EDX(ctx) ((ctx)->uc_mcontext.gregs [REG_EDX])
204         #define UCONTEXT_REG_EBP(ctx) ((ctx)->uc_mcontext.gregs [REG_EBP])
205         #define UCONTEXT_REG_ESP(ctx) ((ctx)->uc_mcontext.gregs [REG_ESP])
206         #define UCONTEXT_REG_ESI(ctx) ((ctx)->uc_mcontext.gregs [REG_ESI])
207         #define UCONTEXT_REG_EDI(ctx) ((ctx)->uc_mcontext.gregs [REG_EDI])
208         #define UCONTEXT_REG_EIP(ctx) ((ctx)->uc_mcontext.gregs [REG_EIP])
209 #endif
210
211 #if defined(__FreeBSD__) || defined(__NetBSD__) || defined(__OpenBSD__) || defined(__APPLE__)
212 # define SC_EAX sc_eax
213 # define SC_EBX sc_ebx
214 # define SC_ECX sc_ecx
215 # define SC_EDX sc_edx
216 # define SC_EBP sc_ebp
217 # define SC_EIP sc_eip
218 # define SC_ESP sc_esp
219 # define SC_EDI sc_edi
220 # define SC_ESI sc_esi
221 #else
222 # define SC_EAX eax
223 # define SC_EBX ebx
224 # define SC_ECX ecx
225 # define SC_EDX edx
226 # define SC_EBP ebp
227 # define SC_EIP eip
228 # define SC_ESP esp
229 # define SC_EDI edi
230 # define SC_ESI esi
231 #endif
232
233 typedef struct {
234         guint32 eax;
235         guint32 ebx;
236         guint32 ecx;
237         guint32 edx;
238         guint32 ebp;
239         guint32 esp;
240     guint32 esi;
241         guint32 edi;
242         guint32 eip;
243 } MonoContext;
244
245 #define MONO_CONTEXT_SET_IP(ctx,ip) do { (ctx)->eip = (long)(ip); } while (0); 
246 #define MONO_CONTEXT_SET_BP(ctx,bp) do { (ctx)->ebp = (long)(bp); } while (0); 
247 #define MONO_CONTEXT_SET_SP(ctx,sp) do { (ctx)->esp = (long)(sp); } while (0); 
248
249 #define MONO_CONTEXT_GET_IP(ctx) ((gpointer)((ctx)->eip))
250 #define MONO_CONTEXT_GET_BP(ctx) ((gpointer)((ctx)->ebp))
251 #define MONO_CONTEXT_GET_SP(ctx) ((gpointer)((ctx)->esp))
252
253 #ifdef _MSC_VER
254
255 #define MONO_INIT_CONTEXT_FROM_FUNC(ctx, start_func) do { \
256     unsigned int stackptr; \
257         mono_arch_flush_register_windows (); \
258     { \
259            __asm mov stackptr, ebp \
260     } \
261         MONO_CONTEXT_SET_IP ((ctx), (start_func)); \
262         MONO_CONTEXT_SET_BP ((ctx), stackptr); \
263         MONO_CONTEXT_SET_SP ((ctx), stackptr); \
264 } while (0)
265
266 #else
267
268 #define MONO_INIT_CONTEXT_FROM_FUNC(ctx,start_func) do {        \
269                 mono_arch_flush_register_windows ();    \
270                 MONO_CONTEXT_SET_IP ((ctx), (start_func));      \
271                 MONO_CONTEXT_SET_BP ((ctx), __builtin_frame_address (0));       \
272                 MONO_CONTEXT_SET_SP ((ctx), __builtin_frame_address (0));       \
273         } while (0)
274
275 #endif
276
277 /* Enables OP_LSHL, OP_LSHL_IMM, OP_LSHR, OP_LSHR_IMM, OP_LSHR_UN, OP_LSHR_UN_IMM */
278 #define MONO_ARCH_NO_EMULATE_LONG_SHIFT_OPS
279
280 #define MONO_ARCH_BIGMUL_INTRINS 1
281 #define MONO_ARCH_NEED_DIV_CHECK 1
282 #define MONO_ARCH_HAVE_IS_INT_OVERFLOW 1
283 #define MONO_ARCH_HAVE_INVALIDATE_METHOD 1
284 #define MONO_ARCH_NEED_GOT_VAR 1
285 #define MONO_ARCH_HAVE_THROW_CORLIB_EXCEPTION 1
286 #define MONO_ARCH_ENABLE_EMIT_STATE_OPT 1
287 #define MONO_ARCH_ENABLE_MONO_LMF_VAR 1
288 #define MONO_ARCH_HAVE_CREATE_TRAMPOLINE_FROM_TOKEN 1
289 #define MONO_ARCH_HAVE_CREATE_DELEGATE_TRAMPOLINE 1
290 #define MONO_ARCH_HAVE_ATOMIC_ADD 1
291 #define MONO_ARCH_HAVE_ATOMIC_EXCHANGE 1
292 #define MONO_ARCH_HAVE_ATOMIC_CAS_IMM 1
293 #define MONO_ARCH_HAVE_IMT 1
294 #define MONO_ARCH_HAVE_TLS_GET 1
295 #define MONO_ARCH_IMT_REG X86_EDX
296 #define MONO_ARCH_VTABLE_REG X86_EDX
297 #define MONO_ARCH_COMMON_VTABLE_TRAMPOLINE 1
298 #define MONO_ARCH_RGCTX_REG X86_EDX
299 #define MONO_ARCH_ENABLE_NORMALIZE_OPCODES 1
300 #define MONO_ARCH_HAVE_GENERALIZED_IMT_THUNK 1
301
302 #define MONO_ARCH_HAVE_CMOV_OPS 1
303
304 #if !defined(__APPLE__)
305 #define MONO_ARCH_AOT_SUPPORTED 1
306 #endif
307
308 /* Used for optimization, not complete */
309 #define MONO_ARCH_IS_OP_MEMBASE(opcode) ((opcode) == OP_X86_PUSH_MEMBASE)
310
311 #define MONO_ARCH_EMIT_BOUNDS_CHECK(cfg, array_reg, offset, index_reg) do { \
312             MonoInst *inst; \
313             MONO_INST_NEW ((cfg), inst, OP_X86_COMPARE_MEMBASE_REG); \
314             inst->inst_basereg = array_reg; \
315             inst->inst_offset = offset; \
316             inst->sreg2 = index_reg; \
317             MONO_ADD_INS ((cfg)->cbb, inst); \
318                         MONO_EMIT_NEW_COND_EXC (cfg, LE_UN, "IndexOutOfRangeException"); \
319         } while (0)
320
321 typedef struct {
322         guint8 *address;
323         guint8 saved_byte;
324 } MonoBreakpointInfo;
325
326 extern MonoBreakpointInfo mono_breakpoint_info [MONO_BREAKPOINT_ARRAY_SIZE];
327
328 #endif /* __MONO_MINI_X86_H__ */  
329