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