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