84409cf1e77d9b0e3dc31d24a0862d342737bd46
[mono.git] / mono / utils / mono-context.h
1 /*
2  * mono-context.h: plat independent machine state definitions
3  *
4  *
5  * Copyright (c) 2011 Novell, Inc (http://www.novell.com)
6  */
7
8
9 #ifndef __MONO_MONO_CONTEXT_H__
10 #define __MONO_MONO_CONTEXT_H__
11
12 #include "mono-compiler.h"
13 #include "mono-sigcontext.h"
14 #include "mono-machine.h"
15
16 #ifdef HAVE_SIGNAL_H
17 #include <signal.h>
18 #endif
19
20 /*
21  * General notes about mono-context.
22  * Each arch defines a MonoContext struct with all GPR regs + IP/PC.
23  * IP/PC should be the last element of the struct (this is a mild sgen constraint we could drop if needed)
24  * Macros to get/set BP, SP and IP are defined too.
25  * MONO_CONTEXT_GET_CURRENT captures the current context as close as possible. One reg might be clobbered
26  *  to hold the address of the target MonoContext. It will be a caller save one, so should not be a problem.
27  */
28 #if (defined(__i386__) && !defined(MONO_CROSS_COMPILE)) || (defined(TARGET_X86))
29
30 /*HACK, move this to an eventual mono-signal.c*/
31 #if defined( __linux__) || defined(__sun) || defined(__APPLE__) || defined(__NetBSD__) || \
32        defined(__FreeBSD__) || defined(__OpenBSD__)
33 #define MONO_SIGNAL_USE_SIGACTION
34 #endif
35
36 #if defined(__native_client__)
37 #undef MONO_SIGNAL_USE_SIGACTION
38 #endif
39
40 #ifdef HOST_WIN32
41 /* sigcontext surrogate */
42 struct sigcontext {
43         unsigned int eax;
44         unsigned int ebx;
45         unsigned int ecx;
46         unsigned int edx;
47         unsigned int ebp;
48         unsigned int esp;
49         unsigned int esi;
50         unsigned int edi;
51         unsigned int eip;
52 };
53 #endif
54
55 #if defined(__FreeBSD__) || defined(__NetBSD__) || defined(__OpenBSD__) || defined(__APPLE__)
56 # define SC_EAX sc_eax
57 # define SC_EBX sc_ebx
58 # define SC_ECX sc_ecx
59 # define SC_EDX sc_edx
60 # define SC_EBP sc_ebp
61 # define SC_EIP sc_eip
62 # define SC_ESP sc_esp
63 # define SC_EDI sc_edi
64 # define SC_ESI sc_esi
65 #elif defined(__HAIKU__)
66 # define SC_EAX regs.eax
67 # define SC_EBX regs._reserved_2[2]
68 # define SC_ECX regs.ecx
69 # define SC_EDX regs.edx
70 # define SC_EBP regs.ebp
71 # define SC_EIP regs.eip
72 # define SC_ESP regs.esp
73 # define SC_EDI regs._reserved_2[0]
74 # define SC_ESI regs._reserved_2[1]
75 #else
76 # define SC_EAX eax
77 # define SC_EBX ebx
78 # define SC_ECX ecx
79 # define SC_EDX edx
80 # define SC_EBP ebp
81 # define SC_EIP eip
82 # define SC_ESP esp
83 # define SC_EDI edi
84 # define SC_ESI esi
85 #endif
86
87 typedef struct {
88         mgreg_t eax;
89         mgreg_t ebx;
90         mgreg_t ecx;
91         mgreg_t edx;
92         mgreg_t ebp;
93         mgreg_t esp;
94         mgreg_t esi;
95         mgreg_t edi;
96         mgreg_t eip;
97 } MonoContext;
98
99 #define MONO_CONTEXT_SET_IP(ctx,ip) do { (ctx)->eip = (mgreg_t)(ip); } while (0); 
100 #define MONO_CONTEXT_SET_BP(ctx,bp) do { (ctx)->ebp = (mgreg_t)(bp); } while (0); 
101 #define MONO_CONTEXT_SET_SP(ctx,sp) do { (ctx)->esp = (mgreg_t)(sp); } while (0); 
102
103 #define MONO_CONTEXT_GET_IP(ctx) ((gpointer)((ctx)->eip))
104 #define MONO_CONTEXT_GET_BP(ctx) ((gpointer)((ctx)->ebp))
105 #define MONO_CONTEXT_GET_SP(ctx) ((gpointer)((ctx)->esp))
106
107 /*We set EAX to zero since we are clobering it anyway*/
108 #ifdef _MSC_VER
109 #define MONO_CONTEXT_GET_CURRENT(ctx) do { \
110         void *_ptr = &(ctx);                                                                                            \
111         __asm {                                                                                                                         \
112          __asm mov eax, _ptr                                                                                            \
113          __asm mov [eax+0x00], eax                                                                                      \
114          __asm mov [eax+0x04], ebx                                                                                      \
115          __asm mov [eax+0x08], ecx                                                                                      \
116          __asm mov [eax+0x0c], edx                                                                                      \
117          __asm mov [eax+0x10], ebp                                                                                      \
118          __asm mov [eax+0x14], esp                                                                                      \
119          __asm mov [eax+0x18], esi                                                                                      \
120          __asm mov [eax+0x1c], edi                                                                                      \
121          __asm call $+5                                                                                                         \
122          __asm pop dword ptr [eax+0x20]                                                                         \
123                  }                                                                                                                              \
124         } while (0)
125 #else
126 #define MONO_CONTEXT_GET_CURRENT(ctx) \
127         __asm__ __volatile__(   \
128         "movl $0x0, 0x00(%0)\n" \
129         "mov %%ebx, 0x04(%0)\n" \
130         "mov %%ecx, 0x08(%0)\n" \
131         "mov %%edx, 0x0c(%0)\n" \
132         "mov %%ebp, 0x10(%0)\n" \
133         "mov %%esp, 0x14(%0)\n" \
134         "mov %%esi, 0x18(%0)\n" \
135         "mov %%edi, 0x1c(%0)\n" \
136         "call 1f\n"     \
137         "1: pop 0x20(%0)\n"     \
138         :       \
139         : "a" (&(ctx))  \
140         : "memory")
141 #endif
142
143 #define MONO_ARCH_HAS_MONO_CONTEXT 1
144
145 #elif (defined(__x86_64__) && !defined(MONO_CROSS_COMPILE)) || (defined(TARGET_AMD64)) /* defined(__i386__) */
146
147
148 #if !defined( HOST_WIN32 ) && !defined(__native_client__) && !defined(__native_client_codegen__)
149
150 #define MONO_SIGNAL_USE_SIGACTION 1
151
152 #endif
153
154 typedef struct {
155         mgreg_t rax;
156         mgreg_t rbx;
157         mgreg_t rcx;
158         mgreg_t rdx;
159         mgreg_t rbp;
160         mgreg_t rsp;
161     mgreg_t rsi;
162         mgreg_t rdi;
163         mgreg_t r8;
164         mgreg_t r9;
165         mgreg_t r10;
166         mgreg_t r11;
167         mgreg_t r12;
168         mgreg_t r13;
169         mgreg_t r14;
170         mgreg_t r15;
171         mgreg_t rip;
172 } MonoContext;
173
174 #define MONO_CONTEXT_SET_IP(ctx,ip) do { (ctx)->rip = (mgreg_t)(ip); } while (0); 
175 #define MONO_CONTEXT_SET_BP(ctx,bp) do { (ctx)->rbp = (mgreg_t)(bp); } while (0); 
176 #define MONO_CONTEXT_SET_SP(ctx,esp) do { (ctx)->rsp = (mgreg_t)(esp); } while (0); 
177
178 #define MONO_CONTEXT_GET_IP(ctx) ((gpointer)((ctx)->rip))
179 #define MONO_CONTEXT_GET_BP(ctx) ((gpointer)((ctx)->rbp))
180 #define MONO_CONTEXT_GET_SP(ctx) ((gpointer)((ctx)->rsp))
181
182 #if defined(__native_client__)
183 #define MONO_CONTEXT_GET_CURRENT(ctx)   \
184         __asm__ __volatile__(   \
185                 "movq $0x0,  %%nacl:0x00(%%r15, %0, 1)\n"       \
186                 "movq %%rbx, %%nacl:0x08(%%r15, %0, 1)\n"       \
187                 "movq %%rcx, %%nacl:0x10(%%r15, %0, 1)\n"       \
188                 "movq %%rdx, %%nacl:0x18(%%r15, %0, 1)\n"       \
189                 "movq %%rbp, %%nacl:0x20(%%r15, %0, 1)\n"       \
190                 "movq %%rsp, %%nacl:0x28(%%r15, %0, 1)\n"       \
191                 "movq %%rsi, %%nacl:0x30(%%r15, %0, 1)\n"       \
192                 "movq %%rdi, %%nacl:0x38(%%r15, %0, 1)\n"       \
193                 "movq %%r8,  %%nacl:0x40(%%r15, %0, 1)\n"       \
194                 "movq %%r9,  %%nacl:0x48(%%r15, %0, 1)\n"       \
195                 "movq %%r10, %%nacl:0x50(%%r15, %0, 1)\n"       \
196                 "movq %%r11, %%nacl:0x58(%%r15, %0, 1)\n"       \
197                 "movq %%r12, %%nacl:0x60(%%r15, %0, 1)\n"       \
198                 "movq %%r13, %%nacl:0x68(%%r15, %0, 1)\n"       \
199                 "movq %%r14, %%nacl:0x70(%%r15, %0, 1)\n"       \
200                 "movq %%r15, %%nacl:0x78(%%r15, %0, 1)\n"       \
201                 "leaq (%%rip), %%rdx\n" \
202                 "movq %%rdx, %%nacl:0x80(%%r15, %0, 1)\n"       \
203                 :       \
204                 : "a" ((int64_t)&(ctx)) \
205                 : "rdx", "memory")
206 #else
207 #define MONO_CONTEXT_GET_CURRENT(ctx)   \
208         __asm__ __volatile__(   \
209                 "movq $0x0,  0x00(%0)\n"        \
210                 "movq %%rbx, 0x08(%0)\n"        \
211                 "movq %%rcx, 0x10(%0)\n"        \
212                 "movq %%rdx, 0x18(%0)\n"        \
213                 "movq %%rbp, 0x20(%0)\n"        \
214                 "movq %%rsp, 0x28(%0)\n"        \
215                 "movq %%rsi, 0x30(%0)\n"        \
216                 "movq %%rdi, 0x38(%0)\n"        \
217                 "movq %%r8,  0x40(%0)\n"        \
218                 "movq %%r9,  0x48(%0)\n"        \
219                 "movq %%r10, 0x50(%0)\n"        \
220                 "movq %%r11, 0x58(%0)\n"        \
221                 "movq %%r12, 0x60(%0)\n"        \
222                 "movq %%r13, 0x68(%0)\n"        \
223                 "movq %%r14, 0x70(%0)\n"        \
224                 "movq %%r15, 0x78(%0)\n"        \
225                 "leaq (%%rip), %%rdx\n" \
226                 "movq %%rdx, 0x80(%0)\n"        \
227                 :       \
228                 : "a" (&(ctx))  \
229                 : "rdx", "memory")
230 #endif
231
232 #if !defined(HOST_WIN32)
233 #define MONO_ARCH_HAS_MONO_CONTEXT 1
234 #endif
235
236 #elif (defined(__arm__) && !defined(MONO_CROSS_COMPILE)) || (defined(TARGET_ARM)) /* defined(__x86_64__) */
237
238 typedef struct {
239         mgreg_t pc;
240         mgreg_t regs [16];
241         double fregs [16];
242         mgreg_t cpsr;
243 } MonoContext;
244
245 /* we have the stack pointer, not the base pointer in sigcontext */
246 #define MONO_CONTEXT_SET_IP(ctx,ip) do { (ctx)->pc = (mgreg_t)ip; } while (0); 
247 #define MONO_CONTEXT_SET_BP(ctx,bp) do { (ctx)->regs [ARMREG_FP] = (mgreg_t)bp; } while (0); 
248 #define MONO_CONTEXT_SET_SP(ctx,bp) do { (ctx)->regs [ARMREG_SP] = (mgreg_t)bp; } while (0); 
249
250 #define MONO_CONTEXT_GET_IP(ctx) ((gpointer)((ctx)->pc))
251 #define MONO_CONTEXT_GET_BP(ctx) ((gpointer)((ctx)->regs [ARMREG_FP]))
252 #define MONO_CONTEXT_GET_SP(ctx) ((gpointer)((ctx)->regs [ARMREG_SP]))
253
254 #define MONO_CONTEXT_GET_CURRENT(ctx)   do {    \
255         __asm__ __volatile__(                   \
256                 "push {r0}\n"                           \
257                 "push {r1}\n"                           \
258                 "mov r0, %0\n"                          \
259                 "ldr r1, [sp, #4]\n"                    \
260                 "str r1, [r0]!\n"                       \
261                 "ldr r1, [sp, #0]\n"                    \
262                 "str r1, [r0]!\n"                       \
263                 "stmia r0!, {r2-r12}\n"         \
264                 "str sp, [r0]!\n"                       \
265                 "str lr, [r0]!\n"                       \
266                 "mov r1, pc\n"                          \
267                 "str r1, [r0]!\n"                       \
268                 "pop {r1}\n"                            \
269                 "pop {r0}\n"                            \
270                 :                                                       \
271                 : "r" (&ctx.regs)                       \
272                 : "memory"                                      \
273         );                                                              \
274         ctx.pc = ctx.regs [15];                 \
275 } while (0)
276
277
278 #elif defined(__mono_ppc__) /* defined(__arm__) */
279
280 /* we define our own structure and we'll copy the data
281  * from sigcontext/ucontext/mach when we need it.
282  * This also makes us save stack space and time when copying
283  * We might also want to add an additional field to propagate
284  * the original context from the signal handler.
285  */
286 typedef struct {
287         gulong sc_ir;          // pc 
288         gulong sc_sp;          // r1
289         mgreg_t regs [19]; /*FIXME, this must be changed to 32 for sgen*/
290         double fregs [18];
291 } MonoContext;
292
293 /* we have the stack pointer, not the base pointer in sigcontext */
294 #define MONO_CONTEXT_SET_IP(ctx,ip) do { (ctx)->sc_ir = (gulong)ip; } while (0);
295 /* FIXME: should be called SET_SP */
296 #define MONO_CONTEXT_SET_BP(ctx,bp) do { (ctx)->sc_sp = (gulong)bp; } while (0);
297 #define MONO_CONTEXT_SET_SP(ctx,sp) do { (ctx)->sc_sp = (gulong)sp; } while (0);
298
299 #define MONO_CONTEXT_GET_IP(ctx) ((gpointer)((ctx)->sc_ir))
300 #define MONO_CONTEXT_GET_BP(ctx) ((gpointer)((ctx)->regs [ppc_r31-13]))
301 #define MONO_CONTEXT_GET_SP(ctx) ((gpointer)((ctx)->sc_sp))
302
303 #elif defined(__sparc__) || defined(sparc) /* defined(__mono_ppc__) */
304
305 typedef struct MonoContext {
306         guint8 *ip;
307         gpointer *sp;
308         gpointer *fp;
309 } MonoContext;
310
311 #define MONO_CONTEXT_SET_IP(ctx,eip) do { (ctx)->ip = (gpointer)(eip); } while (0); 
312 #define MONO_CONTEXT_SET_BP(ctx,ebp) do { (ctx)->fp = (gpointer*)(ebp); } while (0); 
313 #define MONO_CONTEXT_SET_SP(ctx,esp) do { (ctx)->sp = (gpointer*)(esp); } while (0); 
314
315 #define MONO_CONTEXT_GET_IP(ctx) ((gpointer)((ctx)->ip))
316 #define MONO_CONTEXT_GET_BP(ctx) ((gpointer)((ctx)->fp))
317 #define MONO_CONTEXT_GET_SP(ctx) ((gpointer)((ctx)->sp))
318
319 #elif defined(__ia64__) /*defined(__sparc__) || defined(sparc) */
320
321 #ifndef UNW_LOCAL_ONLY
322
323 #define UNW_LOCAL_ONLY
324 #include <libunwind.h>
325
326 #endif
327
328 typedef struct MonoContext {
329         unw_cursor_t cursor;
330         /* Whenever the ip in 'cursor' points to the ip where the exception happened */
331         /* This is true for the initial context for exceptions thrown from signal handlers */
332         gboolean precise_ip;
333 } MonoContext;
334
335 /*XXX SET_BP is missing*/
336 #define MONO_CONTEXT_SET_IP(ctx,eip) do { int err = unw_set_reg (&(ctx)->cursor, UNW_IA64_IP, (unw_word_t)(eip)); g_assert (err == 0); } while (0)
337 #define MONO_CONTEXT_SET_SP(ctx,esp) do { int err = unw_set_reg (&(ctx)->cursor, UNW_IA64_SP, (unw_word_t)(esp)); g_assert (err == 0); } while (0)
338
339 #define MONO_CONTEXT_GET_IP(ctx) ((gpointer)(mono_ia64_context_get_ip ((ctx))))
340 #define MONO_CONTEXT_GET_BP(ctx) ((gpointer)(mono_ia64_context_get_fp ((ctx))))
341 #define MONO_CONTEXT_GET_SP(ctx) ((gpointer)(mono_ia64_context_get_sp ((ctx))))
342
343 static inline unw_word_t
344 mono_ia64_context_get_ip (MonoContext *ctx)
345 {
346         unw_word_t ip;
347         int err;
348
349         err = unw_get_reg (&ctx->cursor, UNW_IA64_IP, &ip);
350         g_assert (err == 0);
351
352         if (ctx->precise_ip) {
353                 return ip;
354         } else {
355                 /* Subtrack 1 so ip points into the actual instruction */
356                 return ip - 1;
357         }
358 }
359
360 static inline unw_word_t
361 mono_ia64_context_get_sp (MonoContext *ctx)
362 {
363         unw_word_t sp;
364         int err;
365
366         err = unw_get_reg (&ctx->cursor, UNW_IA64_SP, &sp);
367         g_assert (err == 0);
368
369         return sp;
370 }
371
372 static inline unw_word_t
373 mono_ia64_context_get_fp (MonoContext *ctx)
374 {
375         unw_cursor_t new_cursor;
376         unw_word_t fp;
377         int err;
378
379         {
380                 unw_word_t ip, sp;
381
382                 err = unw_get_reg (&ctx->cursor, UNW_IA64_SP, &sp);
383                 g_assert (err == 0);
384
385                 err = unw_get_reg (&ctx->cursor, UNW_IA64_IP, &ip);
386                 g_assert (err == 0);
387         }
388
389         /* fp is the SP of the parent frame */
390         new_cursor = ctx->cursor;
391
392         err = unw_step (&new_cursor);
393         g_assert (err >= 0);
394
395         err = unw_get_reg (&new_cursor, UNW_IA64_SP, &fp);
396         g_assert (err == 0);
397
398         return fp;
399 }
400
401 #elif ((defined(__mips__) && !defined(MONO_CROSS_COMPILE)) || (defined(TARGET_MIPS))) && SIZEOF_REGISTER == 4 /* defined(__ia64__) */
402
403 typedef struct {
404         mgreg_t     sc_pc;
405         mgreg_t         sc_regs [32];
406         gfloat          sc_fpregs [32];
407 } MonoContext;
408
409 #define MONO_CONTEXT_SET_IP(ctx,ip) do { (ctx)->sc_pc = (mgreg_t)(ip); } while (0);
410 #define MONO_CONTEXT_SET_BP(ctx,bp) do { (ctx)->sc_regs[mips_fp] = (mgreg_t)(bp); } while (0);
411 #define MONO_CONTEXT_SET_SP(ctx,sp) do { (ctx)->sc_regs[mips_sp] = (mgreg_t)(sp); } while (0);
412
413 #define MONO_CONTEXT_GET_IP(ctx) ((gpointer)((ctx)->sc_pc))
414 #define MONO_CONTEXT_GET_BP(ctx) ((gpointer)((ctx)->sc_regs[mips_fp]))
415 #define MONO_CONTEXT_GET_SP(ctx) ((gpointer)((ctx)->sc_regs[mips_sp]))
416
417 #define MONO_CONTEXT_GET_CURRENT(ctx)   \
418         __asm__ __volatile__(   \
419                 "sw $0,0(%0)\n\t"       \
420                 "sw $1,4(%0)\n\t"       \
421                 "sw $2,8(%0)\n\t"       \
422                 "sw $3,12(%0)\n\t"      \
423                 "sw $4,16(%0)\n\t"      \
424                 "sw $5,20(%0)\n\t"      \
425                 "sw $6,24(%0)\n\t"      \
426                 "sw $7,28(%0)\n\t"      \
427                 "sw $8,32(%0)\n\t"      \
428                 "sw $9,36(%0)\n\t"      \
429                 "sw $10,40(%0)\n\t"     \
430                 "sw $11,44(%0)\n\t"     \
431                 "sw $12,48(%0)\n\t"     \
432                 "sw $13,52(%0)\n\t"     \
433                 "sw $14,56(%0)\n\t"     \
434                 "sw $15,60(%0)\n\t"     \
435                 "sw $16,64(%0)\n\t"     \
436                 "sw $17,68(%0)\n\t"     \
437                 "sw $18,72(%0)\n\t"     \
438                 "sw $19,76(%0)\n\t"     \
439                 "sw $20,80(%0)\n\t"     \
440                 "sw $21,84(%0)\n\t"     \
441                 "sw $22,88(%0)\n\t"     \
442                 "sw $23,92(%0)\n\t"     \
443                 "sw $24,96(%0)\n\t"     \
444                 "sw $25,100(%0)\n\t"    \
445                 "sw $26,104(%0)\n\t"    \
446                 "sw $27,108(%0)\n\t"    \
447                 "sw $28,112(%0)\n\t"    \
448                 "sw $29,116(%0)\n\t"    \
449                 "sw $30,120(%0)\n\t"    \
450                 "sw $31,124(%0)\n\t"    \
451                 : : "r" (&(ctx).sc_regs [0])    \
452                 : "memory"                      \
453         )
454
455 #elif defined(__s390x__)
456
457 #define MONO_ARCH_HAS_MONO_CONTEXT 1
458
459 typedef struct ucontext MonoContext;
460
461 #define MONO_CONTEXT_SET_IP(ctx,ip)                                     \
462         do {                                                            \
463                 (ctx)->uc_mcontext.gregs[14] = (unsigned long)ip;       \
464                 (ctx)->uc_mcontext.psw.addr = (unsigned long)ip;        \
465         } while (0); 
466
467 #define MONO_CONTEXT_SET_SP(ctx,bp) MONO_CONTEXT_SET_BP((ctx),(bp))
468 #define MONO_CONTEXT_SET_BP(ctx,bp)                                     \
469         do {                                                            \
470                 (ctx)->uc_mcontext.gregs[15] = (unsigned long)bp;       \
471                 (ctx)->uc_stack.ss_sp        = (void*)bp;               \
472         } while (0) 
473
474 #define MONO_CONTEXT_GET_IP(ctx) (gpointer) (ctx)->uc_mcontext.psw.addr
475 #define MONO_CONTEXT_GET_SP(ctx) ((gpointer)((ctx)->uc_mcontext.gregs[15]))
476 #define MONO_CONTEXT_GET_BP(ctx) ((gpointer)((ctx)->uc_mcontext.gregs[11]))
477
478 #define MONO_CONTEXT_GET_CURRENT(ctx)   \
479         __asm__ __volatile__(   \
480                 "stmg   %%r0,%%r15,0(%0)\n"     \
481                 : : "r" (&(ctx).uc_mcontext.gregs[0])   \
482                 : "memory"                      \
483         )
484
485 #else
486
487 #error "Implement mono-context for the current arch"
488
489 #endif
490
491 void mono_sigctx_to_monoctx (void *sigctx, MonoContext *mctx) MONO_INTERNAL;
492 void mono_monoctx_to_sigctx (MonoContext *mctx, void *sigctx) MONO_INTERNAL;
493
494 #endif /* __MONO_MONO_CONTEXT_H__ */