2008-12-12 Mark Mason <mmason@upwardaccess.com>
[mono.git] / mono / mini / exceptions-mips.c
1 /*
2  * exceptions-mips.c: exception support for MIPS
3  *
4  * Authors:
5  *   Mark Mason (mason@broadcom.com)
6  *
7  * Based on exceptions-ppc.c by:
8  *   Dietmar Maurer (dietmar@ximian.com)
9  *   Paolo Molaro (lupus@ximian.com)
10  *
11  * (C) 2006 Broadcom
12  * (C) 2001 Ximian, Inc.
13  */
14
15 #include <config.h>
16 #include <glib.h>
17 #include <signal.h>
18 #include <string.h>
19 #include <ucontext.h>
20
21 #include <mono/arch/mips/mips-codegen.h>
22 #include <mono/metadata/appdomain.h>
23 #include <mono/metadata/tabledefs.h>
24 #include <mono/metadata/threads.h>
25 #include <mono/metadata/debug-helpers.h>
26 #include <mono/metadata/exception.h>
27 #include <mono/metadata/mono-debug.h>
28
29 #include "mini.h"
30 #include "mini-mips.h"
31
32 #define GENERIC_EXCEPTION_SIZE 256
33
34 /* XXX */
35 #if 1
36 #define restore_regs_from_context(ctx_reg,ip_reg,tmp_reg) do {  \
37         } while (0)
38 #else
39 #define restore_regs_from_context(ctx_reg,pc,tmp_reg) do {      \
40                 int reg;        \
41                 ppc_lwz (code, pc, G_STRUCT_OFFSET (MonoContext, sc_pc), ctx_reg);      \
42                 ppc_lmw (code, ppc_r13, ctx_reg, G_STRUCT_OFFSET (MonoContext, sc_regs));       \
43                 for (reg = 0; reg < MONO_SAVED_FREGS; ++reg) {  \
44                         ppc_lfd (code, (14 + reg), G_STRUCT_OFFSET(MonoLMF, sc_fpregs) + reg * sizeof (gdouble), ctx_reg);      \
45                 }       \
46         } while (0)
47 #endif
48
49 /* nothing to do */
50 #define setup_context(ctx) do { \
51                 memset ((ctx), 0, sizeof(*(ctx)));      \
52         } while (0);
53
54 /*
55  * mono_arch_get_restore_context:
56  *
57  * Returns a pointer to a method which restores a previously saved MonoContext.
58  * The first argument in a0 is the pointer to the MonoContext.
59  */
60 gpointer
61 mono_arch_get_restore_context (void)
62 {
63         int i;
64         guint8 *code;
65         static guint8 start [128];
66         static int inited = 0;
67         guint32 iregs_to_restore;
68
69         if (inited)
70                 return start;
71         inited = 1;
72         code = start;
73
74         iregs_to_restore = (MONO_ARCH_CALLEE_SAVED_REGS \
75                             | (1 << mips_sp) | (1 << mips_ra));
76         for (i = 0; i < MONO_SAVED_GREGS; ++i) {
77                 if (iregs_to_restore & (1 << i)) {
78                         MIPS_LW (code, i, mips_a0, G_STRUCT_OFFSET (MonoContext, sc_regs[i]));
79                 }
80         }
81
82         /* Get the address to return to */
83         mips_lw (code, mips_t9, mips_a0, G_STRUCT_OFFSET (MonoContext, sc_pc));
84
85         /* jump to the saved IP */
86         mips_jr (code, mips_t9);
87         mips_nop (code);
88
89         /* never reached */
90         mips_break (code, 0xff);
91
92         g_assert ((code - start) < sizeof(start));
93         mono_arch_flush_icache (start, code - start);
94         return start;
95 }
96
97 /*
98  * mono_arch_get_call_filter:
99  *
100  * Returns a pointer to a method which calls an exception filter. We
101  * also use this function to call finally handlers (we pass NULL as 
102  * @exc object in this case).
103  *
104  * This function is invoked as
105  *      call_handler (MonoContext *ctx, handler)
106  *
107  * Where 'handler' is a function to be invoked as:
108  *      handler (void)
109  */
110 gpointer
111 mono_arch_get_call_filter (void)
112 {
113         static guint8 start [320];
114         static int inited = 0;
115         guint8 *code;
116         int alloc_size;
117         int offset;
118
119         if (inited)
120                 return start;
121
122         inited = 1;
123         code = start;
124
125         alloc_size = 64;
126         g_assert ((alloc_size & (MIPS_STACK_ALIGNMENT-1)) == 0);
127
128         mips_addiu (code, mips_sp, mips_sp, -alloc_size);
129         mips_sw (code, mips_ra, mips_sp, alloc_size + MIPS_RET_ADDR_OFFSET);
130
131         /* Save global registers on stack (s0 - s7) */
132         offset = 16;
133         MIPS_SW (code, mips_s0, mips_sp, offset); offset += IREG_SIZE;
134         MIPS_SW (code, mips_s1, mips_sp, offset); offset += IREG_SIZE;
135         MIPS_SW (code, mips_s2, mips_sp, offset); offset += IREG_SIZE;
136         MIPS_SW (code, mips_s3, mips_sp, offset); offset += IREG_SIZE;
137         MIPS_SW (code, mips_s4, mips_sp, offset); offset += IREG_SIZE;
138         MIPS_SW (code, mips_s5, mips_sp, offset); offset += IREG_SIZE;
139         MIPS_SW (code, mips_s6, mips_sp, offset); offset += IREG_SIZE;
140         MIPS_SW (code, mips_s7, mips_sp, offset); offset += IREG_SIZE;
141         MIPS_SW (code, mips_fp, mips_sp, offset); offset += IREG_SIZE;
142
143         /* Restore global registers from MonoContext, including the frame pointer */
144         MIPS_LW (code, mips_s0, mips_a0, G_STRUCT_OFFSET (MonoContext, sc_regs[mips_s0]));
145         MIPS_LW (code, mips_s1, mips_a0, G_STRUCT_OFFSET (MonoContext, sc_regs[mips_s1]));
146         MIPS_LW (code, mips_s2, mips_a0, G_STRUCT_OFFSET (MonoContext, sc_regs[mips_s2]));
147         MIPS_LW (code, mips_s3, mips_a0, G_STRUCT_OFFSET (MonoContext, sc_regs[mips_s3]));
148         MIPS_LW (code, mips_s4, mips_a0, G_STRUCT_OFFSET (MonoContext, sc_regs[mips_s4]));
149         MIPS_LW (code, mips_s5, mips_a0, G_STRUCT_OFFSET (MonoContext, sc_regs[mips_s5]));
150         MIPS_LW (code, mips_s6, mips_a0, G_STRUCT_OFFSET (MonoContext, sc_regs[mips_s6]));
151         MIPS_LW (code, mips_s7, mips_a0, G_STRUCT_OFFSET (MonoContext, sc_regs[mips_s7]));
152         MIPS_LW (code, mips_fp, mips_a0, G_STRUCT_OFFSET (MonoContext, sc_regs[mips_fp]));
153
154         /* a1 is the handler to call */
155         mips_move (code, mips_t9, mips_a1);
156
157         /* jump to the saved IP */
158         mips_jalr (code, mips_t9, mips_ra);
159         mips_nop (code);
160
161         /* restore all regs from the stack */
162         offset = 16;
163         MIPS_LW (code, mips_s0, mips_sp, offset); offset += IREG_SIZE;
164         MIPS_LW (code, mips_s1, mips_sp, offset); offset += IREG_SIZE;
165         MIPS_LW (code, mips_s2, mips_sp, offset); offset += IREG_SIZE;
166         MIPS_LW (code, mips_s3, mips_sp, offset); offset += IREG_SIZE;
167         MIPS_LW (code, mips_s4, mips_sp, offset); offset += IREG_SIZE;
168         MIPS_LW (code, mips_s5, mips_sp, offset); offset += IREG_SIZE;
169         MIPS_LW (code, mips_s6, mips_sp, offset); offset += IREG_SIZE;
170         MIPS_LW (code, mips_s7, mips_sp, offset); offset += IREG_SIZE;
171         MIPS_LW (code, mips_fp, mips_sp, offset); offset += IREG_SIZE;
172
173         /* epilog */
174         mips_lw (code, mips_ra, mips_sp, alloc_size + MIPS_RET_ADDR_OFFSET);
175         mips_addiu (code, mips_sp, mips_sp, alloc_size);
176         mips_jr (code, mips_ra);
177         mips_nop (code);
178
179         g_assert ((code - start) < sizeof(start));
180         mono_arch_flush_icache (start, code - start);
181         return start;
182 }
183
184 static void
185 throw_exception (MonoObject *exc, unsigned long eip, unsigned long esp, gboolean rethrow)
186 {
187         static void (*restore_context) (MonoContext *);
188         MonoContext ctx;
189
190 #ifdef DEBUG_EXCEPTIONS
191         g_print ("throw_exception: exc=%p eip=%p esp=%p rethrow=%d\n",
192                  exc, (void *)eip, (void *) esp, rethrow);
193 #endif
194
195         if (!restore_context)
196                 restore_context = mono_arch_get_restore_context ();
197
198         /* adjust eip so that it point into the call instruction */
199         eip -= 8;
200
201         setup_context (&ctx);
202
203         /*g_print  ("stack in throw: %p\n", esp);*/
204         memcpy (&ctx.sc_regs, (void *)(esp + MIPS_STACK_PARAM_OFFSET),
205                 sizeof (gulong) * MONO_SAVED_GREGS);
206         memset (&ctx.sc_fpregs, 0, sizeof (mips_freg) * MONO_SAVED_FREGS);
207         MONO_CONTEXT_SET_IP (&ctx, eip);
208
209         if (mono_object_isinst (exc, mono_defaults.exception_class)) {
210                 MonoException *mono_ex = (MonoException*)exc;
211                 if (!rethrow)
212                         mono_ex->stack_trace = NULL;
213         }
214         mono_handle_exception (&ctx, exc, (void *)eip, FALSE);
215 #ifdef DEBUG_EXCEPTIONS
216         g_print ("throw_exception: restore to pc=%p sp=%p fp=%p ctx=%p\n",
217                  (void *) ctx.sc_pc, (void *) ctx.sc_regs[mips_sp],
218                  (void *) ctx.sc_regs[mips_fp], &ctx);
219 #endif
220         restore_context (&ctx);
221
222         g_assert_not_reached ();
223 }
224
225 /**
226  * arch_get_throw_exception_generic:
227  *
228  * Returns a function pointer which can be used to raise 
229  * exceptions. The returned function has the following 
230  * signature: void (*func) (MonoException *exc); or
231  * void (*func) (char *exc_name);
232  *
233  */
234 static gpointer 
235 mono_arch_get_throw_exception_generic (guint8 *start, int size, int by_name, gboolean rethrow)
236 {
237         guint8 *code;
238         int alloc_size, pos, i;
239
240         code = start;
241
242         //g_print ("mono_arch_get_throw_exception_generic: code=%p\n", code);
243
244         pos = 0;
245         /* XXX - save all the FP regs on the stack ? */
246
247         pos += MONO_MAX_IREGS * sizeof(guint32);
248
249         alloc_size = MIPS_MINIMAL_STACK_SIZE + pos + 64;
250         // align to MIPS_STACK_ALIGNMENT bytes
251         alloc_size += MIPS_STACK_ALIGNMENT - 1;
252         alloc_size &= ~(MIPS_STACK_ALIGNMENT - 1);
253
254         g_assert ((alloc_size & (MIPS_STACK_ALIGNMENT-1)) == 0);
255         mips_addiu (code, mips_sp, mips_sp, -alloc_size);
256         mips_sw (code, mips_ra, mips_sp, alloc_size + MIPS_RET_ADDR_OFFSET);
257
258         /* Save all the regs on the stack */
259         for (i = 0; i < MONO_MAX_IREGS; i++) {
260                 if (i != mips_sp)
261                         MIPS_SW (code, i, mips_sp, i*IREG_SIZE + MIPS_STACK_PARAM_OFFSET);
262                 else {
263                         mips_addiu (code, mips_at, mips_sp, alloc_size);
264                         MIPS_SW (code, mips_at, mips_sp, i*IREG_SIZE + MIPS_STACK_PARAM_OFFSET);
265                 }
266         }
267
268         if (by_name) {
269                 mips_move (code, mips_a2, mips_a0);
270                 mips_load (code, mips_a0, mono_defaults.corlib);
271                 mips_load (code, mips_a1, "System");
272                 mips_load (code, mips_t9, mono_exception_from_name);
273                 mips_jalr (code, mips_t9, mips_ra);
274                 mips_nop (code);
275                 mips_move (code, mips_a0, mips_v0);
276         }
277         /* call throw_exception (exc, ip, sp, rethrow) */
278
279         /* exc is already in place in a0 */
280
281         /* pointer to ip */
282         if (by_name)
283                 mips_lw (code, mips_a1, mips_sp, alloc_size + MIPS_RET_ADDR_OFFSET);
284         else
285                 mips_move (code, mips_a1, mips_ra);
286
287         /* current sp & rethrow */
288         mips_move (code, mips_a2, mips_sp);
289         mips_addiu (code, mips_a3, mips_zero, rethrow);
290
291         mips_load (code, mips_t9, throw_exception);
292         mips_jr (code, mips_t9);
293         mips_nop (code);
294         /* we should never reach this breakpoint */
295         mips_break (code, 0xfe);
296
297         g_assert ((code - start) < size);
298         mono_arch_flush_icache (start, code - start);
299         return start;
300 }
301
302 /**
303  * mono_arch_get_rethrow_exception:
304  *
305  * Returns a function pointer which can be used to rethrow 
306  * exceptions. The returned function has the following 
307  * signature: void (*func) (MonoException *exc); 
308  *
309  */
310 gpointer
311 mono_arch_get_rethrow_exception (void)
312 {
313         static guint8 start [GENERIC_EXCEPTION_SIZE];
314         static int inited = 0;
315
316         if (inited)
317                 return start;
318         mono_arch_get_throw_exception_generic (start, sizeof (start), FALSE, TRUE);
319         inited = 1;
320         return start;
321 }
322
323 /**
324  * arch_get_throw_exception:
325  *
326  * Returns a function pointer which can be used to raise 
327  * exceptions. The returned function has the following 
328  * signature: void (*func) (MonoException *exc); 
329  * For example to raise an arithmetic exception you can use:
330  *
331  * x86_push_imm (code, mono_get_exception_arithmetic ()); 
332  * x86_call_code (code, arch_get_throw_exception ()); 
333  *
334  */
335 gpointer 
336 mono_arch_get_throw_exception (void)
337 {
338         static guint8 start [GENERIC_EXCEPTION_SIZE];
339         static int inited = 0;
340
341         if (inited)
342                 return start;
343         mono_arch_get_throw_exception_generic (start, sizeof (start), FALSE, FALSE);
344         inited = 1;
345         return start;
346 }
347
348 /**
349  * arch_get_throw_exception_by_name:
350  *
351  * Returns a function pointer which can be used to raise 
352  * corlib exceptions. The returned function has the following 
353  * signature: void (*func) (char *exc_name); 
354  * For example to raise an arithmetic exception you can use:
355  *
356  * x86_push_imm (code, "ArithmeticException"); 
357  * x86_call_code (code, arch_get_throw_exception_by_name ()); 
358  *
359  */
360 gpointer 
361 mono_arch_get_throw_exception_by_name (void)
362 {
363         static guint8 start [GENERIC_EXCEPTION_SIZE];
364         static int inited = 0;
365
366         if (inited)
367                 return start;
368         mono_arch_get_throw_exception_generic (start, sizeof (start), TRUE, FALSE);
369         inited = 1;
370         return start;
371 }       
372
373 static MonoArray *
374 glist_to_array (GList *list, MonoClass *eclass) 
375 {
376         MonoDomain *domain = mono_domain_get ();
377         MonoArray *res;
378         int len, i;
379
380         if (!list)
381                 return NULL;
382
383         len = g_list_length (list);
384         res = mono_array_new (domain, eclass, len);
385
386         for (i = 0; list; list = list->next, i++)
387                 mono_array_set (res, gpointer, i, list->data);
388
389         return res;
390 }
391
392 /* mono_arch_find_jit_info:
393  *
394  * This function is used to gather information from @ctx. It returns the 
395  * MonoJitInfo of the corresponding function, unwinds one stack frame and
396  * stores the resulting context into @new_ctx. It also stores a string 
397  * describing the stack location into @trace (if not NULL), and modifies
398  * the @lmf if necessary. @native_offset return the IP offset from the 
399  * start of the function or -1 if that info is not available.
400  */
401 MonoJitInfo *
402 mono_arch_find_jit_info (MonoDomain *domain, MonoJitTlsData *jit_tls,
403                          MonoJitInfo *res, MonoJitInfo *prev_ji,
404                          MonoContext *ctx, MonoContext *new_ctx,
405                          MonoLMF **lmf, gboolean *managed)
406 {
407         MonoJitInfo *ji;
408         gpointer ip = MONO_CONTEXT_GET_IP (ctx);
409         gpointer fp = MONO_CONTEXT_GET_BP (ctx);
410         guint32 sp;
411
412         /* Avoid costly table lookup during stack overflow */
413         if (prev_ji && (ip > prev_ji->code_start && ((guint8*)ip < ((guint8*)prev_ji->code_start) + prev_ji->code_size)))
414                 ji = prev_ji;
415         else
416                 ji = mono_jit_info_table_find (domain, ip);
417
418         if (managed)
419                 *managed = FALSE;
420
421         memcpy (new_ctx, ctx, sizeof (MonoContext));
422
423         if (ji != NULL) {
424                 int i;
425                 gint32 address;
426                 int offset = 0;
427
428                 if (*lmf && (MONO_CONTEXT_GET_BP (ctx) >= (gpointer)(*lmf)->ebp)) {
429                         /* remove any unused lmf */
430                         *lmf = (*lmf)->previous_lmf;
431                 }
432
433                 address = (char *)ip - (char *)ji->code_start;
434
435                 if (managed)
436                         if (!ji->method->wrapper_type)
437                                 *managed = TRUE;
438
439                 /* My stack frame */
440                 fp = MONO_CONTEXT_GET_BP (ctx);
441
442                 /* Compute the previous stack frame */
443                 sp = (guint32)(fp) - (short)(*(guint32 *)(ji->code_start));
444
445                 /* Sanity check the frame */
446                 if (!sp || (sp == 0xffffffff)
447                     || (sp & 0x07) || (sp < 64*1024)) {
448 #ifdef DEBUG_EXCEPTIONS
449                         g_print ("mono_arch_find_jit_info: bad stack sp=%p\n", (void *) sp);
450 #endif
451                         return (gpointer)-1;
452                 }
453
454                 if (ji->method->save_lmf && 0) {
455                         /* only enable this when prologue stops emitting
456                          * normal save of s-regs when save_lmf is true.
457                          * Will have to sync with prologue code at that point.
458                          */
459                         memcpy (&new_ctx->sc_fpregs,
460                                 (char*)sp - sizeof (float) * MONO_SAVED_FREGS,
461                                 sizeof (float) * MONO_SAVED_FREGS);
462                         memcpy (&new_ctx->sc_regs,
463                                 (char*)sp - sizeof (float) * MONO_SAVED_FREGS - sizeof (gulong) * MONO_SAVED_GREGS,
464                                 sizeof (gulong) * MONO_SAVED_GREGS);
465                 } else if (ji->used_regs) {
466                         guint32 *insn;
467                         guint32 mask = ji->used_regs;
468
469                         /* these all happen before adjustment of fp */
470                         /* Look for sw ??, ????(sp) */
471                         insn = ((guint32 *)ji->code_start) + 1;
472                         while (!*insn || (*insn & 0xffe00000) == 0xafa00000) {
473                                 int reg = (*insn >> 16) & 0x1f;
474                                 mask &= ~(1 << reg);
475                                 new_ctx->sc_regs [reg] = *(guint32 *)(((guint32)fp) + (short)(*insn & 0x0000ffff));
476                                 insn++;
477                         }
478                         MONO_CONTEXT_SET_SP (new_ctx, sp);
479                         MONO_CONTEXT_SET_BP (new_ctx, sp);
480                         /* assert that we found all registers we were supposed to */
481                         g_assert (!mask);
482                 }
483                 /* we substract 8, so that the IP points into the call instruction */
484                 MONO_CONTEXT_SET_IP (new_ctx, new_ctx->sc_regs[mips_ra] - 8);
485
486                 /* Sanity check -- we should have made progress here */
487                 g_assert (new_ctx->sc_pc != ctx->sc_pc);
488                 return ji;
489         } else if (*lmf) {
490                 if (!(*lmf)->method) {
491 #ifdef DEBUG_EXCEPTIONS
492                         g_print ("mono_arch_find_jit_info: bad lmf @ %p\n", (void *) *lmf);
493 #endif
494                         return (gpointer)-1;
495                 }
496                 g_assert (((*lmf)->magic == MIPS_LMF_MAGIC1) || ((*lmf)->magic == MIPS_LMF_MAGIC2));
497
498                 if ((ji = mono_jit_info_table_find (domain, (gpointer)(*lmf)->eip))) {
499                 } else {
500                         memset (res, 0, sizeof (MonoJitInfo));
501                         res->method = (*lmf)->method;
502                 }
503                 memcpy (&new_ctx->sc_regs, (*lmf)->iregs, sizeof (gulong) * MONO_SAVED_GREGS);
504                 memcpy (&new_ctx->sc_fpregs, (*lmf)->fregs, sizeof (float) * MONO_SAVED_FREGS);
505                 MONO_CONTEXT_SET_IP (new_ctx, (*lmf)->eip);
506                 /* ensure that we've made progress */
507                 g_assert (new_ctx->sc_pc != ctx->sc_pc);
508                 *lmf = (*lmf)->previous_lmf;
509
510                 return ji ? ji : res;
511         }
512
513         return NULL;
514 }
515
516 void
517 mono_arch_sigctx_to_monoctx (void *sigctx, MonoContext *mctx)
518 {
519         int i;
520         struct sigcontext *ctx = (struct sigcontext *)sigctx;
521
522         mctx->sc_pc = ctx->sc_pc;
523         for (i = 0; i < 32; ++i) {
524                 mctx->sc_regs[i] = ctx->sc_regs[i];
525                 mctx->sc_fpregs[i] = ctx->sc_fpregs[i];
526         }
527 }
528
529 void
530 mono_arch_monoctx_to_sigctx (MonoContext *mctx, void *sigctx)
531 {
532         int i;
533         struct sigcontext *ctx = (struct sigcontext *)sigctx;
534
535         ctx->sc_pc = mctx->sc_pc;
536         for (i = 0; i < 32; ++i) {
537                 ctx->sc_regs[i] = mctx->sc_regs[i];
538                 ctx->sc_fpregs[i] = mctx->sc_fpregs[i];
539         }
540 }       
541
542 gpointer
543 mono_arch_ip_from_context (void *sigctx)
544 {
545         struct sigcontext *ctx = (struct sigcontext *)sigctx;
546         return (gpointer)(guint32)ctx->sc_pc;
547 }
548
549 /*
550  * This is the function called from the signal handler
551  */
552 gboolean
553 mono_arch_handle_exception (void *ctx, gpointer obj, gboolean test_only)
554 {
555         MonoContext mctx;
556         gboolean result;
557         
558         mono_arch_sigctx_to_monoctx (ctx, &mctx);
559 #ifdef DEBUG_EXCEPTIONS
560         g_print ("mono_arch_handle_exception: pc=%p\n", (void *) mctx.sc_pc);
561 #endif
562         mono_handle_exception (&mctx, obj, (gpointer)mctx.sc_pc, test_only);
563         result = TRUE;
564
565 #ifdef DEBUG_EXCEPTIONS
566         g_print ("mono_arch_handle_exception: restore pc=%p\n", (void *)mctx.sc_pc);
567 #endif
568         /* restore the context so that returning from the signal handler
569          * will invoke the catch clause 
570          */
571         mono_arch_monoctx_to_sigctx (&mctx, ctx);
572
573         return result;
574 }
575
576
577 gboolean
578 mono_arch_has_unwind_info (gconstpointer addr)
579 {
580         return FALSE;
581 }
582