[runtime] Updates comments.
[mono.git] / mono / mini / mini-amd64.h
1 #ifndef __MONO_MINI_AMD64_H__
2 #define __MONO_MINI_AMD64_H__
3
4 #include <mono/arch/amd64/amd64-codegen.h>
5 #include <mono/utils/mono-sigcontext.h>
6 #include <mono/utils/mono-context.h>
7 #include <glib.h>
8
9 #ifdef __native_client_codegen__
10 #define kNaClAlignmentAMD64 32
11 #define kNaClAlignmentMaskAMD64 (kNaClAlignmentAMD64 - 1)
12
13 /* TODO: use kamd64NaClLengthOfCallImm    */
14 /* temporarily using kNaClAlignmentAMD64 so padding in */
15 /* image-writer.c doesn't happen                       */
16 #define kNaClLengthOfCallImm kNaClAlignmentAMD64
17
18 int is_nacl_call_reg_sequence (guint8* code);
19 void amd64_nacl_clear_legacy_prefix_tag ();
20 void amd64_nacl_tag_legacy_prefix (guint8* code);
21 void amd64_nacl_tag_rex (guint8* code);
22 guint8* amd64_nacl_get_legacy_prefix_tag ();
23 guint8* amd64_nacl_get_rex_tag ();
24 void amd64_nacl_instruction_pre ();
25 void amd64_nacl_instruction_post (guint8 **start, guint8 **end);
26 void amd64_nacl_membase_handler (guint8** code, gint8 basereg, gint32 offset, gint8 dreg);
27 #endif
28
29 #ifdef HOST_WIN32
30 #include <windows.h>
31 /* use SIG* defines if possible */
32 #ifdef HAVE_SIGNAL_H
33 #include <signal.h>
34 #endif
35
36 #if !defined(_MSC_VER)
37 /* sigcontext surrogate */
38 struct sigcontext {
39         guint64 eax;
40         guint64 ebx;
41         guint64 ecx;
42         guint64 edx;
43         guint64 ebp;
44         guint64 esp;
45     guint64 esi;
46         guint64 edi;
47         guint64 eip;
48 };
49 #endif
50
51 typedef void (* MonoW32ExceptionHandler) (int _dummy, EXCEPTION_POINTERS *info, void *context);
52 void win32_seh_init(void);
53 void win32_seh_cleanup(void);
54 void win32_seh_set_handler(int type, MonoW32ExceptionHandler handler);
55
56 #ifndef SIGFPE
57 #define SIGFPE 4
58 #endif
59
60 #ifndef SIGILL
61 #define SIGILL 8
62 #endif
63
64 #ifndef SIGSEGV
65 #define SIGSEGV 11
66 #endif
67
68 LONG CALLBACK seh_handler(EXCEPTION_POINTERS* ep);
69
70 #endif /* HOST_WIN32 */
71
72 #ifdef sun    // Solaris x86
73 #  undef SIGSEGV_ON_ALTSTACK
74 #  define MONO_ARCH_NOMAP32BIT
75
76 struct sigcontext {
77         unsigned short gs, __gsh;
78         unsigned short fs, __fsh;
79         unsigned short es, __esh;
80         unsigned short ds, __dsh;
81         unsigned long edi;
82         unsigned long esi;
83         unsigned long ebp;
84         unsigned long esp;
85         unsigned long ebx;
86         unsigned long edx;
87         unsigned long ecx;
88         unsigned long eax;
89         unsigned long trapno;
90         unsigned long err;
91         unsigned long eip;
92         unsigned short cs, __csh;
93         unsigned long eflags;
94         unsigned long esp_at_signal;
95         unsigned short ss, __ssh;
96         unsigned long fpstate[95];
97       unsigned long filler[5];
98 };
99 #endif  // sun, Solaris x86
100
101 #ifndef DISABLE_SIMD
102 #define MONO_ARCH_SIMD_INTRINSICS 1
103 #define MONO_ARCH_NEED_SIMD_BANK 1
104 #define MONO_ARCH_USE_SHARED_FP_SIMD_BANK 1
105 #endif
106
107
108
109 #if defined(__APPLE__)
110 #define MONO_ARCH_SIGNAL_STACK_SIZE MINSIGSTKSZ
111 #else
112 #define MONO_ARCH_SIGNAL_STACK_SIZE (16 * 1024)
113 #endif
114
115 #define MONO_ARCH_HAVE_RESTORE_STACK_SUPPORT 1
116
117 #define MONO_ARCH_CPU_SPEC amd64_desc
118
119 #define MONO_MAX_IREGS 16
120
121 #define MONO_MAX_FREGS AMD64_XMM_NREG
122
123 #define MONO_ARCH_FP_RETURN_REG AMD64_XMM0
124
125 #ifdef TARGET_WIN32
126 /* xmm5 is used as a scratch register */
127 #define MONO_ARCH_CALLEE_FREGS 0x1f
128 /* xmm6:xmm15 */
129 #define MONO_ARCH_CALLEE_SAVED_FREGS (0xffff - 0x3f)
130 #define MONO_ARCH_FP_SCRATCH_REG AMD64_XMM5
131 #else
132 /* xmm15 is used as a scratch register */
133 #define MONO_ARCH_CALLEE_FREGS 0x7fff
134 #define MONO_ARCH_CALLEE_SAVED_FREGS 0
135 #define MONO_ARCH_FP_SCRATCH_REG AMD64_XMM15
136 #endif
137
138 #define MONO_MAX_XREGS MONO_MAX_FREGS
139
140 #define MONO_ARCH_CALLEE_XREGS MONO_ARCH_CALLEE_FREGS
141 #define MONO_ARCH_CALLEE_SAVED_XREGS MONO_ARCH_CALLEE_SAVED_FREGS
142
143
144 #define MONO_ARCH_CALLEE_REGS AMD64_CALLEE_REGS
145 #define MONO_ARCH_CALLEE_SAVED_REGS AMD64_CALLEE_SAVED_REGS
146
147 #define MONO_ARCH_USE_FPSTACK FALSE
148 #define MONO_ARCH_FPSTACK_SIZE 0
149
150 #define MONO_ARCH_INST_FIXED_REG(desc) ((desc == '\0') ? -1 : ((desc == 'i' ? -1 : ((desc == 'a') ? AMD64_RAX : ((desc == 's') ? AMD64_RCX : ((desc == 'd') ? AMD64_RDX : -1))))))
151
152 /* RDX is clobbered by the opcode implementation before accessing sreg2 */
153 #define MONO_ARCH_INST_SREG2_MASK(ins) (((ins [MONO_INST_CLOB] == 'a') || (ins [MONO_INST_CLOB] == 'd')) ? (1 << AMD64_RDX) : 0)
154
155 #define MONO_ARCH_INST_IS_REGPAIR(desc) FALSE
156 #define MONO_ARCH_INST_REGPAIR_REG2(desc,hreg1) (-1)
157
158 #define MONO_ARCH_FRAME_ALIGNMENT 16
159
160 /* fixme: align to 16byte instead of 32byte (we align to 32byte to get 
161  * reproduceable results for benchmarks */
162 #define MONO_ARCH_CODE_ALIGNMENT 32
163
164 /*This is the max size of the locals area of a given frame. I think 1MB is a safe default for now*/
165 #define MONO_ARCH_MAX_FRAME_SIZE 0x100000
166
167 struct MonoLMF {
168         /* 
169          * If the lowest bit is set, then this LMF has the rip field set. Otherwise,
170          * the rip field is not set, and the rsp field points to the stack location where
171          * the caller ip is saved.
172          * If the second lowest bit is set, then this is a MonoLMFExt structure, and
173          * the other fields are not valid.
174          * If the third lowest bit is set, then this is a MonoLMFTramp structure.
175          */
176         gpointer    previous_lmf;
177 #if defined(__default_codegen__) || defined(HOST_WIN32)
178         guint64     rip;
179 #elif defined(__native_client_codegen__)
180         /* On 64-bit compilers, default alignment is 8 for this field, */
181         /* this allows the structure to match for 32-bit compilers.    */
182         guint64     rip __attribute__ ((aligned(8)));
183 #endif
184         guint64     rbp;
185         guint64     rsp;
186 };
187
188 /* LMF structure used by the JIT trampolines */
189 typedef struct {
190         struct MonoLMF lmf;
191         guint64 *regs;
192         gpointer lmf_addr;
193 } MonoLMFTramp;
194
195 typedef struct MonoCompileArch {
196         gint32 localloc_offset;
197         gint32 reg_save_area_offset;
198         gint32 stack_alloc_size;
199         gint32 sp_fp_offset;
200         guint32 saved_iregs;
201         gboolean omit_fp, omit_fp_computed;
202         gpointer cinfo;
203         gint32 async_point_count;
204         gpointer vret_addr_loc;
205 #ifdef HOST_WIN32
206         gpointer        unwindinfo;
207 #endif
208         gpointer seq_point_info_var;
209         gpointer ss_trigger_page_var;
210         gpointer lmf_var;
211 } MonoCompileArch;
212
213
214
215 #ifdef HOST_WIN32
216 #define PARAM_REGS 4
217 #else
218 #define PARAM_REGS 6
219 #endif
220
221 /* Structure used by the sequence points in AOTed code */
222 typedef struct {
223         gpointer ss_trigger_page;
224         gpointer bp_trigger_page;
225         gpointer bp_addrs [MONO_ZERO_LEN_ARRAY];
226 } SeqPointInfo;
227
228 typedef struct {
229         mgreg_t regs [PARAM_REGS];
230         mgreg_t res;
231         guint8 *ret;
232 } DynCallArgs;
233
234
235 #define MONO_CONTEXT_SET_LLVM_EXC_REG(ctx, exc) do { (ctx)->rax = (gsize)exc; } while (0)
236
237 #define MONO_ARCH_INIT_TOP_LMF_ENTRY(lmf)
238
239 #ifdef _MSC_VER
240
241 #define MONO_INIT_CONTEXT_FROM_FUNC(ctx, start_func) do { \
242     guint64 stackptr; \
243         mono_arch_flush_register_windows (); \
244         stackptr = ((guint64)_AddressOfReturnAddress () - sizeof (void*));\
245         MONO_CONTEXT_SET_IP ((ctx), (start_func)); \
246         MONO_CONTEXT_SET_BP ((ctx), stackptr); \
247         MONO_CONTEXT_SET_SP ((ctx), stackptr); \
248 } while (0)
249
250 #else
251
252 /* 
253  * __builtin_frame_address () is broken on some older gcc versions in the presence of
254  * frame pointer elimination, see bug #82095.
255  */
256 #define MONO_INIT_CONTEXT_FROM_FUNC(ctx,start_func) do {        \
257         int tmp; \
258         guint64 stackptr = (guint64)&tmp; \
259                 mono_arch_flush_register_windows ();    \
260                 MONO_CONTEXT_SET_IP ((ctx), (start_func));      \
261                 MONO_CONTEXT_SET_BP ((ctx), stackptr);  \
262                 MONO_CONTEXT_SET_SP ((ctx), stackptr);  \
263         } while (0)
264
265 #endif
266
267 /*
268  * some icalls like mono_array_new_va needs to be called using a different 
269  * calling convention.
270  */
271 #define MONO_ARCH_VARARG_ICALLS 1
272
273 #if (!defined( HOST_WIN32 ) && !defined(__native_client__) && !defined(__native_client_codegen__)) && defined (HAVE_SIGACTION)
274
275 #define MONO_ARCH_USE_SIGACTION 1
276
277 #ifdef HAVE_WORKING_SIGALTSTACK
278
279 #define MONO_ARCH_SIGSEGV_ON_ALTSTACK
280
281 #endif
282
283 #endif /* !HOST_WIN32 && !__native_client__ */
284
285 #if !defined(__linux__)
286 #define MONO_ARCH_NOMAP32BIT 1
287 #endif
288
289 #ifdef HOST_WIN32
290 #define MONO_AMD64_ARG_REG1 AMD64_RCX
291 #define MONO_AMD64_ARG_REG2 AMD64_RDX
292 #define MONO_AMD64_ARG_REG3 AMD64_R8
293 #define MONO_AMD64_ARG_REG4 AMD64_R9
294 #else
295 #define MONO_AMD64_ARG_REG1 AMD64_RDI
296 #define MONO_AMD64_ARG_REG2 AMD64_RSI
297 #define MONO_AMD64_ARG_REG3 AMD64_RDX
298 #define MONO_AMD64_ARG_REG4 AMD64_RCX
299 #endif
300
301 #define MONO_ARCH_NO_EMULATE_LONG_SHIFT_OPS
302 #define MONO_ARCH_NO_EMULATE_LONG_MUL_OPTS
303
304 #define MONO_ARCH_EMULATE_CONV_R8_UN    1
305 #define MONO_ARCH_EMULATE_FREM 1
306 #define MONO_ARCH_HAVE_IS_INT_OVERFLOW 1
307
308 #define MONO_ARCH_ENABLE_MONO_LMF_VAR 1
309 #define MONO_ARCH_HAVE_INVALIDATE_METHOD 1
310 #define MONO_ARCH_HAVE_CREATE_DELEGATE_TRAMPOLINE 1
311 #define MONO_ARCH_HAVE_FULL_AOT_TRAMPOLINES 1
312 #define MONO_ARCH_HAVE_TLS_GET (mono_amd64_have_tls_get ())
313 #define MONO_ARCH_IMT_REG AMD64_R10
314 #define MONO_ARCH_IMT_SCRATCH_REG AMD64_R11
315 #define MONO_ARCH_VTABLE_REG MONO_AMD64_ARG_REG1
316 /*
317  * We use r10 for the imt/rgctx register rather than r11 because r11 is
318  * used by the trampoline as a scratch register and hence might be
319  * clobbered across method call boundaries.
320  */
321 #define MONO_ARCH_RGCTX_REG MONO_ARCH_IMT_REG
322 #define MONO_ARCH_HAVE_CMOV_OPS 1
323 #define MONO_ARCH_HAVE_NOTIFY_PENDING_EXC 1
324 #define MONO_ARCH_HAVE_EXCEPTIONS_INIT 1
325 #define MONO_ARCH_ENABLE_GLOBAL_RA 1
326 #define MONO_ARCH_HAVE_GENERALIZED_IMT_THUNK 1
327 #define MONO_ARCH_HAVE_LIVERANGE_OPS 1
328 #define MONO_ARCH_HAVE_SIGCTX_TO_MONOCTX 1
329 #define MONO_ARCH_MONITOR_OBJECT_REG MONO_AMD64_ARG_REG1
330 #define MONO_ARCH_MONITOR_LOCK_TAKEN_REG MONO_AMD64_ARG_REG2
331 #define MONO_ARCH_HAVE_GET_TRAMPOLINES 1
332
333 #define MONO_ARCH_AOT_SUPPORTED 1
334 #if !defined( __native_client__ )
335 #define MONO_ARCH_SOFT_DEBUG_SUPPORTED 1
336 #endif
337
338 #define MONO_ARCH_SUPPORT_TASKLETS 1
339
340 #define MONO_ARCH_GSHARED_SUPPORTED 1
341 #define MONO_ARCH_DYN_CALL_SUPPORTED 1
342 #define MONO_ARCH_DYN_CALL_PARAM_AREA 0
343
344 #define MONO_ARCH_HAVE_LLVM_IMT_TRAMPOLINE 1
345 #define MONO_ARCH_LLVM_SUPPORTED 1
346 #define MONO_ARCH_HAVE_HANDLER_BLOCK_GUARD 1
347 #define MONO_ARCH_HAVE_CARD_TABLE_WBARRIER 1
348 #define MONO_ARCH_HAVE_SETUP_RESUME_FROM_SIGNAL_HANDLER_CTX 1
349 #define MONO_ARCH_GC_MAPS_SUPPORTED 1
350 #define MONO_ARCH_HAVE_CONTEXT_SET_INT_REG 1
351 #define MONO_ARCH_HAVE_SETUP_ASYNC_CALLBACK 1
352 #define MONO_ARCH_HAVE_CREATE_LLVM_NATIVE_THUNK 1
353 #define MONO_ARCH_HAVE_OP_TAIL_CALL 1
354 #define MONO_ARCH_HAVE_TRANSLATE_TLS_OFFSET 1
355 #define MONO_ARCH_HAVE_DUMMY_INIT 1
356
357 #if defined(TARGET_OSX) || defined(__linux__)
358 #define MONO_ARCH_HAVE_TLS_GET_REG 1
359 #endif
360
361 /* Used for optimization, not complete */
362 #define MONO_ARCH_IS_OP_MEMBASE(opcode) ((opcode) == OP_X86_PUSH_MEMBASE)
363
364 #define MONO_ARCH_EMIT_BOUNDS_CHECK(cfg, array_reg, offset, index_reg) do { \
365             MonoInst *inst; \
366             MONO_INST_NEW ((cfg), inst, OP_AMD64_ICOMPARE_MEMBASE_REG); \
367             inst->inst_basereg = array_reg; \
368             inst->inst_offset = offset; \
369             inst->sreg2 = index_reg; \
370             MONO_ADD_INS ((cfg)->cbb, inst); \
371             MONO_EMIT_NEW_COND_EXC (cfg, LE_UN, "IndexOutOfRangeException"); \
372        } while (0)
373
374 void 
375 mono_amd64_patch (unsigned char* code, gpointer target);
376
377 void
378 mono_amd64_throw_exception (guint64 dummy1, guint64 dummy2, guint64 dummy3, guint64 dummy4,
379                                                         guint64 dummy5, guint64 dummy6,
380                                                         mgreg_t *regs, mgreg_t rip,
381                                                         MonoObject *exc, gboolean rethrow);
382
383 void
384 mono_amd64_throw_corlib_exception (guint64 dummy1, guint64 dummy2, guint64 dummy3, guint64 dummy4,
385                                                                    guint64 dummy5, guint64 dummy6,
386                                                                    mgreg_t *regs, mgreg_t rip,
387                                                                    guint32 ex_token_index, gint64 pc_offset);
388
389 guint64
390 mono_amd64_get_original_ip (void);
391
392 guint8*
393 mono_amd64_emit_tls_get (guint8* code, int dreg, int tls_offset);
394
395 gboolean
396 mono_amd64_have_tls_get (void);
397
398 GSList*
399 mono_amd64_get_exception_trampolines (gboolean aot);
400
401 int
402 mono_amd64_get_tls_gs_offset (void) MONO_LLVM_INTERNAL;
403
404 typedef struct {
405         guint8 *address;
406         guint8 saved_byte;
407 } MonoBreakpointInfo;
408
409 extern MonoBreakpointInfo mono_breakpoint_info [MONO_BREAKPOINT_ARRAY_SIZE];
410
411 #ifdef HOST_WIN32
412
413 void mono_arch_unwindinfo_add_push_nonvol (gpointer* monoui, gpointer codebegin, gpointer nextip, guchar reg );
414 void mono_arch_unwindinfo_add_set_fpreg (gpointer* monoui, gpointer codebegin, gpointer nextip, guchar reg );
415 void mono_arch_unwindinfo_add_alloc_stack (gpointer* monoui, gpointer codebegin, gpointer nextip, guint size );
416 guint mono_arch_unwindinfo_get_size (gpointer monoui);
417 void mono_arch_unwindinfo_install_unwind_info (gpointer* monoui, gpointer code, guint code_size);
418
419 #define MONO_ARCH_HAVE_UNWIND_TABLE 1
420 #endif
421
422 #endif /* __MONO_MINI_AMD64_H__ */  
423