Merge pull request #2542 from akoeplinger/remove-changelog
[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 mono_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 : ((desc == 'A') ? MONO_AMD64_ARG_REG1 : -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, and
175          * the 'rbp' field is not valid.
176          */
177         gpointer    previous_lmf;
178 #if defined(__default_codegen__) || defined(HOST_WIN32)
179         guint64     rip;
180 #elif defined(__native_client_codegen__)
181         /* On 64-bit compilers, default alignment is 8 for this field, */
182         /* this allows the structure to match for 32-bit compilers.    */
183         guint64     rip __attribute__ ((aligned(8)));
184 #endif
185         guint64     rbp;
186         guint64     rsp;
187 };
188
189 /* LMF structure used by the JIT trampolines */
190 typedef struct {
191         struct MonoLMF lmf;
192         MonoContext *ctx;
193         gpointer lmf_addr;
194 } MonoLMFTramp;
195
196 typedef struct MonoCompileArch {
197         gint32 localloc_offset;
198         gint32 reg_save_area_offset;
199         gint32 stack_alloc_size;
200         gint32 sp_fp_offset;
201         guint32 saved_iregs;
202         gboolean omit_fp, omit_fp_computed;
203         gpointer cinfo;
204         gint32 async_point_count;
205         gpointer vret_addr_loc;
206 #ifdef HOST_WIN32
207         gpointer        unwindinfo;
208 #endif
209         gpointer seq_point_info_var;
210         gpointer ss_trigger_page_var;
211         gpointer ss_tramp_var;
212         gpointer bp_tramp_var;
213         gpointer lmf_var;
214 } MonoCompileArch;
215
216 #ifdef TARGET_WIN32
217 #define PARAM_REGS 4
218 #else
219 #define PARAM_REGS 6
220 #endif
221
222 typedef struct {
223         /* Method address to call */
224         gpointer addr;
225         /* The trampoline reads this, so keep the size explicit */
226         int ret_marshal;
227         /* If ret_marshal != NONE, this is the reg of the vret arg, else -1 */
228         int vret_arg_reg;
229         /* The stack slot where the return value will be stored */
230         int vret_slot;
231         int stack_usage, map_count;
232         /* If not -1, then make a virtual call using this vtable offset */
233         int vcall_offset;
234         /* If 1, make an indirect call to the address in the rgctx reg */
235         int calli;
236         /* Whenever this is a in or an out call */
237         int gsharedvt_in;
238         /* Maps stack slots/registers in the caller to the stack slots/registers in the callee */
239         int map [MONO_ZERO_LEN_ARRAY];
240 } GSharedVtCallInfo;
241
242 /* Structure used by the sequence points in AOTed code */
243 typedef struct {
244         gpointer ss_tramp_addr;
245         gpointer bp_addrs [MONO_ZERO_LEN_ARRAY];
246 } SeqPointInfo;
247
248 typedef struct {
249         mgreg_t regs [PARAM_REGS];
250         mgreg_t res;
251         guint8 *ret;
252         double fregs [8];
253         mgreg_t has_fp;
254         guint8 buffer [256];
255 } DynCallArgs;
256
257 #define MONO_CONTEXT_SET_LLVM_EXC_REG(ctx, exc) do { (ctx)->gregs [AMD64_RAX] = (gsize)exc; } while (0)
258 #define MONO_CONTEXT_SET_LLVM_EH_SELECTOR_REG(ctx, sel) do { (ctx)->gregs [AMD64_RDX] = (gsize)(sel); } while (0)
259
260 #define MONO_ARCH_INIT_TOP_LMF_ENTRY(lmf)
261
262 #ifdef _MSC_VER
263
264 #define MONO_INIT_CONTEXT_FROM_FUNC(ctx, start_func) do { \
265     guint64 stackptr; \
266         mono_arch_flush_register_windows (); \
267         stackptr = ((guint64)_AddressOfReturnAddress () - sizeof (void*));\
268         MONO_CONTEXT_SET_IP ((ctx), (start_func)); \
269         MONO_CONTEXT_SET_BP ((ctx), stackptr); \
270         MONO_CONTEXT_SET_SP ((ctx), stackptr); \
271 } while (0)
272
273 #else
274
275 /* 
276  * __builtin_frame_address () is broken on some older gcc versions in the presence of
277  * frame pointer elimination, see bug #82095.
278  */
279 #define MONO_INIT_CONTEXT_FROM_FUNC(ctx,start_func) do {        \
280         int tmp; \
281         guint64 stackptr = (guint64)&tmp; \
282                 mono_arch_flush_register_windows ();    \
283                 MONO_CONTEXT_SET_IP ((ctx), (start_func));      \
284                 MONO_CONTEXT_SET_BP ((ctx), stackptr);  \
285                 MONO_CONTEXT_SET_SP ((ctx), stackptr);  \
286         } while (0)
287
288 #endif
289
290 /*
291  * some icalls like mono_array_new_va needs to be called using a different 
292  * calling convention.
293  */
294 #define MONO_ARCH_VARARG_ICALLS 1
295
296 #if (!defined( HOST_WIN32 ) && !defined(__native_client__) && !defined(__native_client_codegen__)) && defined (HAVE_SIGACTION)
297
298 #define MONO_ARCH_USE_SIGACTION 1
299
300 #ifdef HAVE_WORKING_SIGALTSTACK
301
302 #define MONO_ARCH_SIGSEGV_ON_ALTSTACK
303
304 #endif
305
306 #endif /* !HOST_WIN32 && !__native_client__ */
307
308 #if !defined(__linux__)
309 #define MONO_ARCH_NOMAP32BIT 1
310 #endif
311
312 #ifdef TARGET_WIN32
313 #define MONO_AMD64_ARG_REG1 AMD64_RCX
314 #define MONO_AMD64_ARG_REG2 AMD64_RDX
315 #define MONO_AMD64_ARG_REG3 AMD64_R8
316 #define MONO_AMD64_ARG_REG4 AMD64_R9
317 #else
318 #define MONO_AMD64_ARG_REG1 AMD64_RDI
319 #define MONO_AMD64_ARG_REG2 AMD64_RSI
320 #define MONO_AMD64_ARG_REG3 AMD64_RDX
321 #define MONO_AMD64_ARG_REG4 AMD64_RCX
322 #endif
323
324 #define MONO_ARCH_NO_EMULATE_LONG_SHIFT_OPS
325 #define MONO_ARCH_NO_EMULATE_LONG_MUL_OPTS
326
327 #define MONO_ARCH_EMULATE_CONV_R8_UN    1
328 #define MONO_ARCH_EMULATE_FREM 1
329 #define MONO_ARCH_HAVE_IS_INT_OVERFLOW 1
330
331 #define MONO_ARCH_ENABLE_MONO_LMF_VAR 1
332 #define MONO_ARCH_HAVE_INVALIDATE_METHOD 1
333 #define MONO_ARCH_HAVE_FULL_AOT_TRAMPOLINES 1
334 #define MONO_ARCH_HAVE_TLS_GET (mono_amd64_have_tls_get ())
335 #define MONO_ARCH_IMT_REG AMD64_R10
336 #define MONO_ARCH_IMT_SCRATCH_REG AMD64_R11
337 #define MONO_ARCH_VTABLE_REG MONO_AMD64_ARG_REG1
338 /*
339  * We use r10 for the imt/rgctx register rather than r11 because r11 is
340  * used by the trampoline as a scratch register and hence might be
341  * clobbered across method call boundaries.
342  */
343 #define MONO_ARCH_RGCTX_REG MONO_ARCH_IMT_REG
344 #define MONO_ARCH_EXC_REG AMD64_RAX
345 #define MONO_ARCH_HAVE_CMOV_OPS 1
346 #define MONO_ARCH_HAVE_EXCEPTIONS_INIT 1
347 #define MONO_ARCH_HAVE_GENERALIZED_IMT_THUNK 1
348 #define MONO_ARCH_HAVE_LIVERANGE_OPS 1
349 #define MONO_ARCH_HAVE_SIGCTX_TO_MONOCTX 1
350 #define MONO_ARCH_HAVE_GET_TRAMPOLINES 1
351
352 #define MONO_ARCH_AOT_SUPPORTED 1
353 #if !defined( __native_client__ )
354 #define MONO_ARCH_SOFT_DEBUG_SUPPORTED 1
355 #endif
356
357 #define MONO_ARCH_SUPPORT_TASKLETS 1
358
359 #define MONO_ARCH_GSHARED_SUPPORTED 1
360 #define MONO_ARCH_DYN_CALL_SUPPORTED 1
361 #define MONO_ARCH_DYN_CALL_PARAM_AREA 0
362
363 #define MONO_ARCH_LLVM_SUPPORTED 1
364 #define MONO_ARCH_HAVE_HANDLER_BLOCK_GUARD 1
365 #define MONO_ARCH_HAVE_CARD_TABLE_WBARRIER 1
366 #define MONO_ARCH_HAVE_SETUP_RESUME_FROM_SIGNAL_HANDLER_CTX 1
367 #define MONO_ARCH_GC_MAPS_SUPPORTED 1
368 #define MONO_ARCH_HAVE_CONTEXT_SET_INT_REG 1
369 #define MONO_ARCH_HAVE_SETUP_ASYNC_CALLBACK 1
370 #define MONO_ARCH_HAVE_CREATE_LLVM_NATIVE_THUNK 1
371 #define MONO_ARCH_GSHAREDVT_SUPPORTED 1
372 #define MONO_ARCH_HAVE_OP_TAIL_CALL 1
373 #define MONO_ARCH_HAVE_TRANSLATE_TLS_OFFSET 1
374 #define MONO_ARCH_HAVE_DUMMY_INIT 1
375 #define MONO_ARCH_HAVE_SDB_TRAMPOLINES 1
376 #define MONO_ARCH_HAVE_PATCH_CODE_NEW 1
377 #define MONO_ARCH_HAVE_OP_GENERIC_CLASS_INIT 1
378
379 #if defined(TARGET_OSX) || defined(__linux__)
380 #define MONO_ARCH_HAVE_UNWIND_BACKTRACE 1
381 #endif
382
383 #if defined(TARGET_OSX) || defined(__linux__)
384 #define MONO_ARCH_HAVE_TLS_GET_REG 1
385 #endif
386
387 #if defined(TARGET_APPLETVOS)
388 /* No signals */
389 #define MONO_ARCH_NEED_DIV_CHECK 1
390 #endif
391
392 /* Used for optimization, not complete */
393 #define MONO_ARCH_IS_OP_MEMBASE(opcode) ((opcode) == OP_X86_PUSH_MEMBASE)
394
395 #define MONO_ARCH_EMIT_BOUNDS_CHECK(cfg, array_reg, offset, index_reg) do { \
396             MonoInst *inst; \
397             MONO_INST_NEW ((cfg), inst, OP_AMD64_ICOMPARE_MEMBASE_REG); \
398             inst->inst_basereg = array_reg; \
399             inst->inst_offset = offset; \
400             inst->sreg2 = index_reg; \
401             MONO_ADD_INS ((cfg)->cbb, inst); \
402             MONO_EMIT_NEW_COND_EXC (cfg, LE_UN, "IndexOutOfRangeException"); \
403        } while (0)
404
405 void 
406 mono_amd64_patch (unsigned char* code, gpointer target);
407
408 void
409 mono_amd64_throw_exception (guint64 dummy1, guint64 dummy2, guint64 dummy3, guint64 dummy4,
410                                                         guint64 dummy5, guint64 dummy6,
411                                                         MonoContext *mctx, MonoObject *exc, gboolean rethrow);
412
413 void
414 mono_amd64_throw_corlib_exception (guint64 dummy1, guint64 dummy2, guint64 dummy3, guint64 dummy4,
415                                                                    guint64 dummy5, guint64 dummy6,
416                                                                    MonoContext *mctx, guint32 ex_token_index, gint64 pc_offset);
417
418 void
419 mono_amd64_resume_unwind (guint64 dummy1, guint64 dummy2, guint64 dummy3, guint64 dummy4,
420                                                   guint64 dummy5, guint64 dummy6,
421                                                   MonoContext *mctx, guint32 dummy7, gint64 dummy8);
422
423 gpointer
424 mono_amd64_start_gsharedvt_call (GSharedVtCallInfo *info, gpointer *caller, gpointer *callee, gpointer mrgctx_reg);
425
426 guint64
427 mono_amd64_get_original_ip (void);
428
429 guint8*
430 mono_amd64_emit_tls_get (guint8* code, int dreg, int tls_offset);
431
432 gboolean
433 mono_amd64_have_tls_get (void);
434
435 GSList*
436 mono_amd64_get_exception_trampolines (gboolean aot);
437
438 int
439 mono_amd64_get_tls_gs_offset (void) MONO_LLVM_INTERNAL;
440
441 #ifdef TARGET_WIN32
442
443 void mono_arch_unwindinfo_add_push_nonvol (gpointer* monoui, gpointer codebegin, gpointer nextip, guchar reg );
444 void mono_arch_unwindinfo_add_set_fpreg (gpointer* monoui, gpointer codebegin, gpointer nextip, guchar reg );
445 void mono_arch_unwindinfo_add_alloc_stack (gpointer* monoui, gpointer codebegin, gpointer nextip, guint size );
446 guint mono_arch_unwindinfo_get_size (gpointer monoui);
447 void mono_arch_unwindinfo_install_unwind_info (gpointer* monoui, gpointer code, guint code_size);
448
449 #define MONO_ARCH_HAVE_UNWIND_TABLE 1
450 #endif
451
452 #endif /* __MONO_MINI_AMD64_H__ */  
453