Merge pull request #2311 from mlancione/master
[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 #ifndef __mono_ilp32__
81 #define MONO_ARCH_HAVE_TLS_GET 1
82 #endif
83
84 #else /* must be __mono_ppc__ */
85
86 #define MONO_ARCH_HAVE_TLS_GET 1
87 #define MONO_ARCH_EMULATE_FCONV_TO_I8 1
88 #define MONO_ARCH_EMULATE_LCONV_TO_R8 1
89 #define MONO_ARCH_EMULATE_LCONV_TO_R4 1
90 #endif
91
92 #define MONO_ARCH_EMULATE_LCONV_TO_R8_UN 1
93 #define MONO_ARCH_EMULATE_FREM 1
94 #define MONO_ARCH_GC_MAPS_SUPPORTED 1
95
96 /* Parameters used by the register allocator */
97 #define MONO_ARCH_CALLEE_REGS ((0xff << ppc_r3) | (1 << ppc_r12) | (1 << ppc_r11))
98 #define MONO_ARCH_CALLEE_SAVED_REGS (0xfffff << ppc_r13) /* ppc_13 - ppc_31 */
99
100 #if defined(__APPLE__) || defined(__mono_ppc64__)
101 #define MONO_ARCH_CALLEE_FREGS (0x1fff << ppc_f1)
102 #else
103 #define MONO_ARCH_CALLEE_FREGS (0xff << ppc_f1)
104 #endif
105 #define MONO_ARCH_CALLEE_SAVED_FREGS (~(MONO_ARCH_CALLEE_FREGS | 1))
106
107 #define MONO_ARCH_USE_FPSTACK FALSE
108 #define MONO_ARCH_FPSTACK_SIZE 0
109
110 #ifdef __mono_ppc64__
111 #define MONO_ARCH_INST_FIXED_REG(desc) (((desc) == 'a')? ppc_r3:\
112                                         ((desc) == 'g'? ppc_f1:-1))
113 #define MONO_ARCH_INST_IS_REGPAIR(desc) FALSE
114 #define MONO_ARCH_INST_REGPAIR_REG2(desc,hreg1) (-1)
115 #else
116 #define MONO_ARCH_INST_FIXED_REG(desc) (((desc) == 'a')? ppc_r3:\
117                                         ((desc) == 'l')? ppc_r4:\
118                                         ((desc) == 'g'? ppc_f1:-1))
119 #define MONO_ARCH_INST_IS_REGPAIR(desc) (desc == 'l')
120 #define MONO_ARCH_INST_REGPAIR_REG2(desc,hreg1) (desc == 'l' ? ppc_r3 : -1)
121 #endif
122
123 #define MONO_ARCH_INST_SREG2_MASK(ins) (0)
124
125 #define MONO_ARCH_INST_IS_FLOAT(desc) ((desc == 'f') || (desc == 'g'))
126
127 /* deal with some of the ABI differences here */
128 #ifdef __APPLE__
129 #define PPC_RET_ADDR_OFFSET 8
130 #define PPC_STACK_PARAM_OFFSET 24
131 #define PPC_MINIMAL_STACK_SIZE 24
132 #define PPC_MINIMAL_PARAM_AREA_SIZE 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 MONO_ARCH_HAVE_DECOMPOSE_VTYPE_OPTS 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_PASS_SMALL_FLOAT_STRUCTS_IN_FR_REGS 1
149   #define MONO_ARCH_HAVE_DECOMPOSE_VTYPE_OPTS 1
150 // FIXME: To get the test case  finally_block_ending_in_dead_bb  to work properly we need to define the following
151 // and then implement the fuction mono_arch_create_handler_block_trampoline.
152 //  #define MONO_ARCH_HAVE_HANDLER_BLOCK_GUARD 1
153
154 //  #define DEBUG_ELFABIV2
155
156   #define MONO_ARCH_LLVM_SUPPORTED 1
157
158  #else
159   #define PPC_STACK_PARAM_OFFSET 48
160   #define PPC_MINIMAL_STACK_SIZE 48
161   #define PPC_PASS_SMALL_FLOAT_STRUCTS_IN_FR_REGS 0
162   #define MONO_ARCH_HAVE_DECOMPOSE_VTYPE_OPTS 0
163  #endif
164 #define MONO_ARCH_HAVE_SETUP_ASYNC_CALLBACK 1
165 #define PPC_MINIMAL_PARAM_AREA_SIZE 64
166 #define PPC_LAST_FPARG_REG ppc_f13
167 #define PPC_PASS_STRUCTS_BY_VALUE 1
168 #define PPC_THREAD_PTR_REG ppc_r13
169 #define MONO_ARCH_HAVE_SIGCTX_TO_MONOCTX 1
170 #else
171 #define PPC_RET_ADDR_OFFSET 4
172 #define PPC_STACK_PARAM_OFFSET 8
173 #define PPC_MINIMAL_STACK_SIZE 8
174 #define PPC_MINIMAL_PARAM_AREA_SIZE 0
175 #define PPC_LAST_FPARG_REG ppc_f8
176 #define PPC_PASS_STRUCTS_BY_VALUE 0
177 #define PPC_LARGEST_STRUCT_SIZE_TO_RETURN_VIA_REGISTERS 0
178 #define PPC_MOST_FLOAT_STRUCT_MEMBERS_TO_RETURN_VIA_REGISTERS 0
179 #define PPC_PASS_SMALL_FLOAT_STRUCTS_IN_FR_REGS 0
180 #define PPC_RETURN_SMALL_FLOAT_STRUCTS_IN_FR_REGS 0
181 #define PPC_RETURN_SMALL_STRUCTS_IN_REGS 0
182 #define MONO_ARCH_HAVE_DECOMPOSE_VTYPE_OPTS 0
183 #define MONO_ARCH_RETURN_CAN_USE_MULTIPLE_REGISTERS 0
184 #define PPC_THREAD_PTR_REG ppc_r2
185 #endif
186 #define PPC_FIRST_ARG_REG ppc_r3
187 #define PPC_LAST_ARG_REG ppc_r10
188 #define PPC_FIRST_FPARG_REG ppc_f1
189 #endif
190
191 #define PPC_CALL_REG ppc_r12
192
193 #if defined(HAVE_WORKING_SIGALTSTACK) && !defined(__APPLE__)
194 #define MONO_ARCH_SIGSEGV_ON_ALTSTACK 1
195 #define MONO_ARCH_SIGNAL_STACK_SIZE (12 * 1024)
196 #endif /* HAVE_WORKING_SIGALTSTACK */
197
198 #define MONO_ARCH_IMT_REG ppc_r11
199
200 #define MONO_ARCH_VTABLE_REG    ppc_r11
201 #define MONO_ARCH_RGCTX_REG     MONO_ARCH_IMT_REG
202
203 #define MONO_ARCH_NO_IOV_CHECK 1
204 #define MONO_ARCH_HAVE_DECOMPOSE_OPTS 1
205 #define MONO_ARCH_HAVE_DECOMPOSE_LONG_OPTS 1
206
207 #define MONO_ARCH_HAVE_GENERALIZED_IMT_THUNK 1
208
209 #define MONO_ARCH_HAVE_FULL_AOT_TRAMPOLINES 1
210
211 #define MONO_ARCH_GSHARED_SUPPORTED 1
212
213 #define MONO_ARCH_NEED_DIV_CHECK 1
214 #define MONO_ARCH_AOT_SUPPORTED 1
215 #define MONO_ARCH_NEED_GOT_VAR 1
216 #if !defined(MONO_CROSS_COMPILE) && !defined(TARGET_PS3)
217 #define MONO_ARCH_SOFT_DEBUG_SUPPORTED 1
218 #endif
219 #define MONO_ARCH_HAVE_OP_TAIL_CALL 1
220
221 #define PPC_NUM_REG_ARGS (PPC_LAST_ARG_REG-PPC_FIRST_ARG_REG+1)
222 #define PPC_NUM_REG_FPARGS (PPC_LAST_FPARG_REG-PPC_FIRST_FPARG_REG+1)
223
224 #ifdef MONO_CROSS_COMPILE
225
226 typedef struct {
227         unsigned long sp;
228         unsigned long unused1;
229         unsigned long lr;
230 } MonoPPCStackFrame;
231
232 #define MONO_INIT_CONTEXT_FROM_FUNC(ctx,start_func) g_assert_not_reached ()
233
234 #elif defined(__APPLE__)
235
236 typedef struct {
237         unsigned long sp;
238         unsigned long unused1;
239         unsigned long lr;
240 } MonoPPCStackFrame;
241
242 #define MONO_INIT_CONTEXT_FROM_FUNC(ctx,start_func) do {        \
243                 gpointer r1;                                    \
244                 __asm__ volatile("mr   %0,r1" : "=r" (r1));     \
245                 MONO_CONTEXT_SET_BP ((ctx), r1);                \
246                 MONO_CONTEXT_SET_IP ((ctx), (start_func));      \
247         } while (0)
248
249 #else
250
251 typedef struct {
252         mgreg_t sp;
253 #ifdef __mono_ppc64__
254         mgreg_t cr;
255 #endif
256         mgreg_t lr;
257 } MonoPPCStackFrame;
258
259 #ifdef G_COMPILER_CODEWARRIOR
260 #define MONO_INIT_CONTEXT_FROM_FUNC(ctx,start_func) do {        \
261                 register gpointer r1_var;                                       \
262                 asm { mr r1_var, r1 };  \
263                 MONO_CONTEXT_SET_BP ((ctx), r1);                \
264                 MONO_CONTEXT_SET_IP ((ctx), (start_func));      \
265         } while (0)
266
267 #else
268 #define MONO_INIT_CONTEXT_FROM_FUNC(ctx,start_func) do {        \
269                 gpointer r1;                                    \
270                 __asm__ volatile("mr   %0,1" : "=r" (r1));      \
271                 MONO_CONTEXT_SET_BP ((ctx), r1);                \
272                 MONO_CONTEXT_SET_IP ((ctx), (start_func));      \
273         } while (0)
274
275 #endif
276 #endif
277
278 #define MONO_ARCH_INIT_TOP_LMF_ENTRY(lmf) do { (lmf)->ebp = -1; } while (0)
279
280 typedef struct {
281         gint8 reg;
282         gint8 size;
283         int vtsize;
284         int offset;
285 } MonoPPCArgInfo;
286
287 #ifdef PPC_USES_FUNCTION_DESCRIPTOR
288 typedef struct {
289         gpointer code;
290         gpointer toc;
291         gpointer env;
292 } MonoPPCFunctionDescriptor;
293
294 #define PPC_FTNPTR_SIZE                 sizeof (MonoPPCFunctionDescriptor)
295 extern guint8* mono_ppc_create_pre_code_ftnptr (guint8 *code);
296 #else
297 #define PPC_FTNPTR_SIZE                 0
298 #define mono_ppc_create_pre_code_ftnptr(c)      c
299 #endif
300
301 #if defined(__linux__)
302 #define MONO_ARCH_USE_SIGACTION 1
303 #elif defined (__APPLE__) && defined (_STRUCT_MCONTEXT)
304 #define MONO_ARCH_USE_SIGACTION 1
305 #elif defined (__APPLE__) && !defined (_STRUCT_MCONTEXT)
306 #define MONO_ARCH_USE_SIGACTION 1
307 #elif defined(__NetBSD__)
308 #define MONO_ARCH_USE_SIGACTION 1
309 #elif defined(__FreeBSD__)
310 #define MONO_ARCH_USE_SIGACTION 1
311 #elif defined(MONO_CROSS_COMPILE)
312         typedef MonoContext ucontext_t;
313 /*      typedef struct {
314                 int dummy;
315         } ucontext_t;*/
316         #define UCONTEXT_REG_Rn(ctx, n)
317         #define UCONTEXT_REG_FPRn(ctx, n)
318         #define UCONTEXT_REG_NIP(ctx)
319         #define UCONTEXT_REG_LNK(ctx)
320
321 #else
322 /* For other operating systems, we pull the definition from an external file */
323 #include "mini-ppc-os.h"
324 #endif
325
326 gboolean
327 mono_ppc_tail_call_supported (MonoMethodSignature *caller_sig, MonoMethodSignature *callee_sig);
328
329 void
330 mono_ppc_patch (guchar *code, const guchar *target);
331
332 void
333 mono_ppc_throw_exception (MonoObject *exc, unsigned long eip, unsigned long esp, mgreg_t *int_regs, gdouble *fp_regs, gboolean rethrow);
334
335 #ifdef __mono_ppc64__
336 #define MONO_PPC_32_64_CASE(c32,c64)    c64
337 extern void mono_ppc_emitted (guint8 *code, gint64 length, const char *format, ...);
338 #else
339 #define MONO_PPC_32_64_CASE(c32,c64)    c32
340 #endif
341
342 gboolean mono_ppc_is_direct_call_sequence (guint32 *code);
343
344 void mono_ppc_patch_plt_entry (guint8 *code, gpointer *got, mgreg_t *regs, guint8 *addr);
345
346 void mono_ppc_set_func_into_sigctx (void *sigctx, void *func);
347
348
349 // Debugging macros for ELF ABI v2
350 #ifdef DEBUG_ELFABIV2
351
352 #define DEBUG_ELFABIV2_printf(a, ...) \
353 {if (getenv("DEBUG_ELFABIV2")) { printf(a, ##__VA_ARGS__); fflush(stdout); } }
354
355 #define DEBUG_ELFABIV2_mono_print_ins(a) \
356 {if (getenv("DEBUG_ELFABIV2")) { if (!a) {printf("null\n");} else {mono_print_ins(a);} fflush(stdout); } }
357
358 extern char* mono_type_full_name (MonoType *type);
359
360 #define DEBUG_ELFABIV2_mono_print_type(a) \
361 {if (getenv("DEBUG_ELFABIV2")) { printf("%s, size: %d\n", mono_type_get_name(&a->klass->byval_arg), mini_type_stack_size (NULL, a, 0)); fflush(stdout); } }
362
363 #define DEBUG_ELFABIV2_mono_print_class(a) \
364 {if (getenv("DEBUG_ELFABIV2")) { printf("%s\n", mono_type_get_name(&a->byval_arg)); fflush(stdout); } }
365
366 #else
367
368 #define DEBUG_ELFABIV2_printf(a, ...)
369 #define DEBUG_ELFABIV2_mono_print_ins(a)
370 #define DEBUG_ELFABIV2_mono_print_type(a)
371 #define DEBUG_ELFABIV2_mono_print_class(a)
372
373 #endif
374
375 #endif /* __MONO_MINI_PPC_H__ */