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