Merge pull request #4169 from evincarofautumn/fix-xmm-scanning-mac-x86
[mono.git] / mono / mini / mini-ppc.h
1 #ifndef __MONO_MINI_PPC_H__
2 #define __MONO_MINI_PPC_H__
3
4 #include <mono/arch/ppc/ppc-codegen.h>
5 #include <mono/utils/mono-sigcontext.h>
6 #include <mono/utils/mono-context.h>
7 #include <mono/metadata/object.h>
8 #include <glib.h>
9
10 #ifdef __mono_ppc64__
11 #define MONO_ARCH_CPU_SPEC mono_ppc64_cpu_desc
12 #else
13 #define MONO_ARCH_CPU_SPEC mono_ppcg4
14 #endif
15
16 #define MONO_MAX_IREGS 32
17 #define MONO_MAX_FREGS 32
18
19 #define MONO_SAVED_GREGS 19
20 #define MONO_SAVED_FREGS 18
21
22 #define MONO_PPC_FIRST_SAVED_GREG ppc_r13
23 #define MONO_PPC_FIRST_SAVED_FREG ppc_f14
24
25 #define MONO_ARCH_FRAME_ALIGNMENT 16
26
27 /* fixme: align to 16byte instead of 32byte (we align to 32byte to get 
28  * reproduceable results for benchmarks */
29 #define MONO_ARCH_CODE_ALIGNMENT 32
30
31 void ppc_patch (guchar *code, const guchar *target);
32 void ppc_patch_full (guchar *code, const guchar *target, gboolean is_fd);
33
34 struct MonoLMF {
35         /*
36          * If the second lowest bit is set to 1, then this is a MonoLMFExt structure, and
37          * the other fields are not valid.
38          */
39         gpointer    previous_lmf;
40         gpointer    lmf_addr;
41         MonoMethod *method;
42         gulong     ebp;
43         gulong     eip;
44         /* Add a dummy field to force iregs to be aligned when cross compiling from x86 */
45         gulong     dummy;
46         mgreg_t    iregs [MONO_SAVED_GREGS]; /* 13..31 */
47         gdouble    fregs [MONO_SAVED_FREGS]; /* 14..31 */
48 };
49
50
51 typedef struct MonoCompileArch {
52         int fp_conv_var_offset;
53 } MonoCompileArch;
54
55 /*
56  * ILP32 uses a version of the ppc64 abi with sizeof(void*)==sizeof(long)==4.
57  * To support this, code needs to follow the following conventions:
58  * - for the size of a pointer use sizeof (gpointer)
59  * - for the size of a register/stack slot use SIZEOF_REGISTER.
60  * - for variables which contain values of registers, use mgreg_t.
61  * - for loading/saving pointers/ints, use the normal ppc_load_reg/ppc_save_reg ()
62  *   macros.
63  * - for loading/saving register sized quantities, use the ppc_ldr/ppc_str 
64  *   macros.
65  * - make sure to not mix the two kinds of macros for the same memory location, 
66  *   since ppc is big endian, so a 8 byte store followed by a 4 byte load will
67  *   load the upper 32 bit of the value.
68  * - use OP_LOADR_MEMBASE/OP_STORER_MEMBASE to load/store register sized
69  *   quantities.
70  */
71
72 #ifdef __mono_ppc64__
73 #define MONO_ARCH_NO_EMULATE_LONG_SHIFT_OPS
74 #define MONO_ARCH_NO_EMULATE_LONG_MUL_OPTS
75
76 /* ELFv2 ABI doesn't use function descriptors.  */
77 #if _CALL_ELF == 2
78 #undef PPC_USES_FUNCTION_DESCRIPTOR
79 #else
80 #define PPC_USES_FUNCTION_DESCRIPTOR
81 #endif
82
83 #else /* must be __mono_ppc__ */
84
85 #define MONO_ARCH_EMULATE_FCONV_TO_I8 1
86 #define MONO_ARCH_EMULATE_LCONV_TO_R8 1
87 #define MONO_ARCH_EMULATE_LCONV_TO_R4 1
88 #endif
89
90 #define MONO_ARCH_EMULATE_LCONV_TO_R8_UN 1
91 #define MONO_ARCH_EMULATE_FREM 1
92 #define MONO_ARCH_GC_MAPS_SUPPORTED 1
93
94 /* Parameters used by the register allocator */
95 #define MONO_ARCH_CALLEE_REGS ((0xff << ppc_r3) | (1 << ppc_r12) | (1 << ppc_r11))
96 #define MONO_ARCH_CALLEE_SAVED_REGS (0xfffff << ppc_r13) /* ppc_13 - ppc_31 */
97
98 #if defined(__APPLE__) || defined(__mono_ppc64__)
99 #define MONO_ARCH_CALLEE_FREGS (0x1fff << ppc_f1)
100 #else
101 #define MONO_ARCH_CALLEE_FREGS (0xff << ppc_f1)
102 #endif
103 #define MONO_ARCH_CALLEE_SAVED_FREGS (~(MONO_ARCH_CALLEE_FREGS | 1))
104
105 #define MONO_ARCH_USE_FPSTACK FALSE
106 #define MONO_ARCH_FPSTACK_SIZE 0
107
108 #ifdef __mono_ppc64__
109 #define MONO_ARCH_INST_FIXED_REG(desc) (((desc) == 'a')? ppc_r3:\
110                                         ((desc) == 'g'? ppc_f1:-1))
111 #define MONO_ARCH_INST_IS_REGPAIR(desc) FALSE
112 #define MONO_ARCH_INST_REGPAIR_REG2(desc,hreg1) (-1)
113 #else
114 #define MONO_ARCH_INST_FIXED_REG(desc) (((desc) == 'a')? ppc_r3:\
115                                         ((desc) == 'l')? ppc_r4:\
116                                         ((desc) == 'g'? ppc_f1:-1))
117 #define MONO_ARCH_INST_IS_REGPAIR(desc) (desc == 'l')
118 #define MONO_ARCH_INST_REGPAIR_REG2(desc,hreg1) (desc == 'l' ? ppc_r3 : -1)
119 #endif
120
121 #define MONO_ARCH_INST_SREG2_MASK(ins) (0)
122
123 #define MONO_ARCH_INST_IS_FLOAT(desc) ((desc == 'f') || (desc == 'g'))
124
125 /* deal with some of the ABI differences here */
126 #ifdef __APPLE__
127 #define PPC_RET_ADDR_OFFSET 8
128 #define PPC_STACK_PARAM_OFFSET 24
129 #define PPC_MINIMAL_STACK_SIZE 24
130 #define PPC_MINIMAL_PARAM_AREA_SIZE 0
131 #define PPC_LARGEST_STRUCT_SIZE_TO_RETURN_VIA_REGISTERS 0
132 #define PPC_MOST_FLOAT_STRUCT_MEMBERS_TO_RETURN_VIA_REGISTERS 0
133 #define PPC_FIRST_ARG_REG ppc_r3
134 #define PPC_LAST_ARG_REG ppc_r10
135 #define PPC_FIRST_FPARG_REG ppc_f1
136 #define PPC_LAST_FPARG_REG ppc_f13
137 #define PPC_PASS_STRUCTS_BY_VALUE 1
138 #define PPC_PASS_SMALL_FLOAT_STRUCTS_IN_FR_REGS 0
139 #define PPC_RETURN_SMALL_FLOAT_STRUCTS_IN_FR_REGS 0
140 #define PPC_RETURN_SMALL_STRUCTS_IN_REGS 0
141 #define MONO_ARCH_HAVE_DECOMPOSE_VTYPE_OPTS 0
142 #define MONO_ARCH_RETURN_CAN_USE_MULTIPLE_REGISTERS 0
143 #else
144 /* Linux */
145 #ifdef __mono_ppc64__
146 #define PPC_RET_ADDR_OFFSET 16
147  // Power LE abvi2
148  #if (_CALL_ELF == 2)
149   #define PPC_STACK_PARAM_OFFSET 32
150   #define PPC_MINIMAL_STACK_SIZE 32
151   #define PPC_LARGEST_STRUCT_SIZE_TO_RETURN_VIA_REGISTERS 16
152   #define PPC_MOST_FLOAT_STRUCT_MEMBERS_TO_RETURN_VIA_REGISTERS 8
153   #define PPC_PASS_SMALL_FLOAT_STRUCTS_IN_FR_REGS 1
154   #define PPC_RETURN_SMALL_FLOAT_STRUCTS_IN_FR_REGS 1
155   #define PPC_RETURN_SMALL_STRUCTS_IN_REGS 1
156   #define MONO_ARCH_HAVE_DECOMPOSE_VTYPE_OPTS 1
157   #define MONO_ARCH_RETURN_CAN_USE_MULTIPLE_REGISTERS 1
158
159 // FIXME: To get the test case  finally_block_ending_in_dead_bb  to work properly define the following
160 // and then implement the fuction mono_arch_create_handler_block_trampoline.
161 //  #define MONO_ARCH_HAVE_HANDLER_BLOCK_GUARD 1
162
163 // Define "DEBUG_ELFABIV2" to allow for debugging output for ELF ABI v2 function call and return codegen
164 //  #define DEBUG_ELFABIV2
165
166   #define MONO_ARCH_LLVM_SUPPORTED 1
167
168  #else
169   #define PPC_STACK_PARAM_OFFSET 48
170   #define PPC_MINIMAL_STACK_SIZE 48
171   #define PPC_LARGEST_STRUCT_SIZE_TO_RETURN_VIA_REGISTERS 0
172   #define PPC_MOST_FLOAT_STRUCT_MEMBERS_TO_RETURN_VIA_REGISTERS 0
173   #define PPC_PASS_SMALL_FLOAT_STRUCTS_IN_FR_REGS 0
174   #define PPC_RETURN_SMALL_FLOAT_STRUCTS_IN_FR_REGS 0
175   #define PPC_RETURN_SMALL_STRUCTS_IN_REGS 0
176   #define MONO_ARCH_HAVE_DECOMPOSE_VTYPE_OPTS 0
177   #define MONO_ARCH_RETURN_CAN_USE_MULTIPLE_REGISTERS 0
178  #endif
179 #define MONO_ARCH_HAVE_SETUP_ASYNC_CALLBACK 1
180 #define PPC_MINIMAL_PARAM_AREA_SIZE 64
181 #define PPC_LAST_FPARG_REG ppc_f13
182 #define PPC_PASS_STRUCTS_BY_VALUE 1
183 #define PPC_THREAD_PTR_REG ppc_r13
184 #else
185 #define PPC_RET_ADDR_OFFSET 4
186 #define PPC_STACK_PARAM_OFFSET 8
187 #define PPC_MINIMAL_STACK_SIZE 8
188 #define PPC_MINIMAL_PARAM_AREA_SIZE 0
189 #define PPC_LAST_FPARG_REG ppc_f8
190 #define PPC_PASS_STRUCTS_BY_VALUE 0
191 #define PPC_LARGEST_STRUCT_SIZE_TO_RETURN_VIA_REGISTERS 0
192 #define PPC_MOST_FLOAT_STRUCT_MEMBERS_TO_RETURN_VIA_REGISTERS 0
193 #define PPC_PASS_SMALL_FLOAT_STRUCTS_IN_FR_REGS 0
194 #define PPC_RETURN_SMALL_FLOAT_STRUCTS_IN_FR_REGS 0
195 #define PPC_RETURN_SMALL_STRUCTS_IN_REGS 0
196 #define MONO_ARCH_HAVE_DECOMPOSE_VTYPE_OPTS 0
197 #define MONO_ARCH_RETURN_CAN_USE_MULTIPLE_REGISTERS 0
198 #define PPC_THREAD_PTR_REG ppc_r2
199 #endif
200 #define MONO_ARCH_HAVE_SIGCTX_TO_MONOCTX 1
201 #define PPC_FIRST_ARG_REG ppc_r3
202 #define PPC_LAST_ARG_REG ppc_r10
203 #define PPC_FIRST_FPARG_REG ppc_f1
204 #endif
205
206 #define PPC_CALL_REG ppc_r12
207
208 #if defined(HAVE_WORKING_SIGALTSTACK) && !defined(__APPLE__)
209 #define MONO_ARCH_SIGSEGV_ON_ALTSTACK 1
210 #define MONO_ARCH_SIGNAL_STACK_SIZE (12 * 1024)
211 #endif /* HAVE_WORKING_SIGALTSTACK */
212
213 #define MONO_ARCH_IMT_REG ppc_r11
214
215 #define MONO_ARCH_VTABLE_REG    ppc_r11
216 #define MONO_ARCH_RGCTX_REG     MONO_ARCH_IMT_REG
217
218 #define MONO_ARCH_NO_IOV_CHECK 1
219 #define MONO_ARCH_HAVE_DECOMPOSE_OPTS 1
220 #define MONO_ARCH_HAVE_DECOMPOSE_LONG_OPTS 1
221
222 #define MONO_ARCH_HAVE_GENERALIZED_IMT_TRAMPOLINE 1
223
224 #define MONO_ARCH_HAVE_FULL_AOT_TRAMPOLINES 1
225
226 #define MONO_ARCH_GSHARED_SUPPORTED 1
227
228 #define MONO_ARCH_NEED_DIV_CHECK 1
229 #define MONO_ARCH_AOT_SUPPORTED 1
230 #define MONO_ARCH_NEED_GOT_VAR 1
231 #if !defined(MONO_CROSS_COMPILE) && !defined(TARGET_PS3)
232 #define MONO_ARCH_SOFT_DEBUG_SUPPORTED 1
233 #endif
234 #define MONO_ARCH_HAVE_OP_TAIL_CALL 1
235
236 #define PPC_NUM_REG_ARGS (PPC_LAST_ARG_REG-PPC_FIRST_ARG_REG+1)
237 #define PPC_NUM_REG_FPARGS (PPC_LAST_FPARG_REG-PPC_FIRST_FPARG_REG+1)
238
239 #ifdef MONO_CROSS_COMPILE
240
241 typedef struct {
242         unsigned long sp;
243         unsigned long unused1;
244         unsigned long lr;
245 } MonoPPCStackFrame;
246
247 #define MONO_INIT_CONTEXT_FROM_FUNC(ctx,start_func) g_assert_not_reached ()
248
249 #elif defined(__APPLE__)
250
251 typedef struct {
252         unsigned long sp;
253         unsigned long unused1;
254         unsigned long lr;
255 } MonoPPCStackFrame;
256
257 #define MONO_INIT_CONTEXT_FROM_FUNC(ctx,start_func) do {        \
258                 gpointer r1;                                    \
259                 __asm__ volatile("mr   %0,r1" : "=r" (r1));     \
260                 MONO_CONTEXT_SET_BP ((ctx), r1);                \
261                 MONO_CONTEXT_SET_IP ((ctx), (start_func));      \
262         } while (0)
263
264 #else
265
266 typedef struct {
267         mgreg_t sp;
268 #ifdef __mono_ppc64__
269         mgreg_t cr;
270 #endif
271         mgreg_t lr;
272 } MonoPPCStackFrame;
273
274 #ifdef G_COMPILER_CODEWARRIOR
275 #define MONO_INIT_CONTEXT_FROM_FUNC(ctx,start_func) do {        \
276                 register gpointer r1_var;                                       \
277                 asm { mr r1_var, r1 };  \
278                 MONO_CONTEXT_SET_BP ((ctx), r1);                \
279                 MONO_CONTEXT_SET_IP ((ctx), (start_func));      \
280         } while (0)
281
282 #else
283 #define MONO_INIT_CONTEXT_FROM_FUNC(ctx,start_func) do {        \
284                 gpointer r1;                                    \
285                 __asm__ volatile("mr   %0,1" : "=r" (r1));      \
286                 MONO_CONTEXT_SET_BP ((ctx), r1);                \
287                 MONO_CONTEXT_SET_IP ((ctx), (start_func));      \
288         } while (0)
289
290 #endif
291 #endif
292
293 #define MONO_ARCH_INIT_TOP_LMF_ENTRY(lmf) do { (lmf)->ebp = -1; } while (0)
294
295 typedef struct {
296         gint8 reg;
297         gint8 size;
298         int vtsize;
299         int offset;
300 } MonoPPCArgInfo;
301
302 #ifdef PPC_USES_FUNCTION_DESCRIPTOR
303 typedef struct {
304         gpointer code;
305         gpointer toc;
306         gpointer env;
307 } MonoPPCFunctionDescriptor;
308
309 #define PPC_FTNPTR_SIZE                 sizeof (MonoPPCFunctionDescriptor)
310 extern guint8* mono_ppc_create_pre_code_ftnptr (guint8 *code);
311 #else
312 #define PPC_FTNPTR_SIZE                 0
313 #define mono_ppc_create_pre_code_ftnptr(c)      c
314 #endif
315
316 #if defined(__linux__)
317 #define MONO_ARCH_USE_SIGACTION 1
318 #elif defined (__APPLE__) && defined (_STRUCT_MCONTEXT)
319 #define MONO_ARCH_USE_SIGACTION 1
320 #elif defined (__APPLE__) && !defined (_STRUCT_MCONTEXT)
321 #define MONO_ARCH_USE_SIGACTION 1
322 #elif defined(__NetBSD__)
323 #define MONO_ARCH_USE_SIGACTION 1
324 #elif defined(__FreeBSD__)
325 #define MONO_ARCH_USE_SIGACTION 1
326 #elif defined(MONO_CROSS_COMPILE)
327         typedef MonoContext ucontext_t;
328 /*      typedef struct {
329                 int dummy;
330         } ucontext_t;*/
331         #define UCONTEXT_REG_Rn(ctx, n)
332         #define UCONTEXT_REG_FPRn(ctx, n)
333         #define UCONTEXT_REG_NIP(ctx)
334         #define UCONTEXT_REG_LNK(ctx)
335
336 #else
337 /* For other operating systems, we pull the definition from an external file */
338 #include "mini-ppc-os.h"
339 #endif
340
341 gboolean
342 mono_ppc_tail_call_supported (MonoMethodSignature *caller_sig, MonoMethodSignature *callee_sig);
343
344 void
345 mono_ppc_patch (guchar *code, const guchar *target);
346
347 void
348 mono_ppc_throw_exception (MonoObject *exc, unsigned long eip, unsigned long esp, mgreg_t *int_regs, gdouble *fp_regs, gboolean rethrow);
349
350 #ifdef __mono_ppc64__
351 #define MONO_PPC_32_64_CASE(c32,c64)    c64
352 extern void mono_ppc_emitted (guint8 *code, gint64 length, const char *format, ...);
353 #else
354 #define MONO_PPC_32_64_CASE(c32,c64)    c32
355 #endif
356
357 gboolean mono_ppc_is_direct_call_sequence (guint32 *code);
358
359 void mono_ppc_patch_plt_entry (guint8 *code, gpointer *got, mgreg_t *regs, guint8 *addr);
360
361 void mono_ppc_set_func_into_sigctx (void *sigctx, void *func);
362
363
364 // Debugging macros for ELF ABI v2
365 #ifdef DEBUG_ELFABIV2
366
367 #define DEBUG_ELFABIV2_printf(a, ...) \
368 {if (getenv("DEBUG_ELFABIV2")) { printf(a, ##__VA_ARGS__); fflush(stdout); } }
369
370 #define DEBUG_ELFABIV2_mono_print_ins(a) \
371 {if (getenv("DEBUG_ELFABIV2")) { if (!a) {printf("null\n");} else {mono_print_ins(a);} fflush(stdout); } }
372
373 extern char* mono_type_full_name (MonoType *type);
374
375 #define DEBUG_ELFABIV2_mono_print_type(a) \
376 {if (getenv("DEBUG_ELFABIV2")) { printf("%s, size: %d\n", mono_type_get_name(a), mini_type_stack_size (a, 0)); fflush(stdout); } }
377
378 #define DEBUG_ELFABIV2_mono_print_class(a) \
379 {if (getenv("DEBUG_ELFABIV2")) { printf("%s\n", mono_type_get_name(&a->byval_arg)); fflush(stdout); } }
380
381 #else
382
383 #define DEBUG_ELFABIV2_printf(a, ...)
384 #define DEBUG_ELFABIV2_mono_print_ins(a)
385 #define DEBUG_ELFABIV2_mono_print_type(a)
386 #define DEBUG_ELFABIV2_mono_print_class(a)
387
388 #endif
389
390 #endif /* __MONO_MINI_PPC_H__ */