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
  20 #include <mono/arch/mips/mips-codegen.h>
  21 #include <mono/metadata/appdomain.h>
  22 #include <mono/metadata/tabledefs.h>
  23 #include <mono/metadata/threads.h>
  24 #include <mono/metadata/debug-helpers.h>
  25 #include <mono/metadata/exception.h>
  26 #include <mono/metadata/mono-debug.h>
  27
  28 #include "mini.h"
  29 #include "mini-mips.h"
  30
  31 #define GENERIC_EXCEPTION_SIZE 256
  32
  33 /*
  34  * mono_arch_get_restore_context:
  35  *
  36  * Returns a pointer to a method which restores a previously saved MonoContext.
  37  * The first argument in a0 is the pointer to the MonoContext.
  38  */
  39 gpointer
  40 mono_arch_get_restore_context (MonoTrampInfo **info, gboolean aot)
  41 {
  42         int i;
  43         guint8 *code;
  44         static guint8 start [512];
  45         static int inited = 0;
  46         guint32 iregs_to_restore;
  47
  48         g_assert (!aot);
  49         if (info)
  50                 *info = NULL;
  51
  52         if (inited)
  53                 return start;
  54         inited = 1;
  55         code = start;
  56
  57         mips_move (code, mips_at, mips_a0);
  58
  59         iregs_to_restore = (MONO_ARCH_CALLEE_SAVED_REGS \
  60                             | (1 << mips_sp) | (1 << mips_ra));
  61         for (i = 0; i < MONO_SAVED_GREGS; ++i) {
  62                 //if (iregs_to_restore & (1 << i)) {
  63                 if (i != mips_zero && i != mips_at) {
  64                         MIPS_LW (code, i, mips_at, G_STRUCT_OFFSET (MonoContext, sc_regs[i]));
  65                 }
  66         }
  67
  68         /* Get the address to return to */
  69         mips_lw (code, mips_t9, mips_at, G_STRUCT_OFFSET (MonoContext, sc_pc));
  70
  71         /* jump to the saved IP */
  72         mips_jr (code, mips_t9);
  73         mips_nop (code);
  74
  75         /* never reached */
  76         mips_break (code, 0xff);
  77
  78         g_assert ((code - start) < sizeof(start));
  79         mono_arch_flush_icache (start, code - start);
  80         mono_profiler_code_buffer_new (start, code - start, MONO_PROFILER_CODE_BUFFER_EXCEPTION_HANDLING, NULL);
  81         return start;
  82 }
  83
  84 /*
  85  * mono_arch_get_call_filter:
  86  *
  87  * Returns a pointer to a method which calls an exception filter. We
  88  * also use this function to call finally handlers (we pass NULL as
  89  * @exc object in this case).
  90  *
  91  * This function is invoked as
  92  *      call_handler (MonoContext *ctx, handler)
  93  *
  94  * Where 'handler' is a function to be invoked as:
  95  *      handler (void)
  96  */
  97 gpointer
  98 mono_arch_get_call_filter (MonoTrampInfo **info, gboolean aot)
  99 {
 100         static guint8 start [320];
 101         static int inited = 0;
 102         guint8 *code;
 103         int alloc_size;
 104         int offset;
 105
 106         g_assert (!aot);
 107         if (info)
 108                 *info = NULL;
 109
 110         if (inited)
 111                 return start;
 112
 113         inited = 1;
 114         code = start;
 115
 116         alloc_size = 64;
 117         g_assert ((alloc_size & (MIPS_STACK_ALIGNMENT-1)) == 0);
 118
 119         mips_addiu (code, mips_sp, mips_sp, -alloc_size);
 120         mips_sw (code, mips_ra, mips_sp, alloc_size + MIPS_RET_ADDR_OFFSET);
 121
 122         /* Save global registers on stack (s0 - s7) */
 123         offset = 16;
 124         MIPS_SW (code, mips_s0, mips_sp, offset); offset += IREG_SIZE;
 125         MIPS_SW (code, mips_s1, mips_sp, offset); offset += IREG_SIZE;
 126         MIPS_SW (code, mips_s2, mips_sp, offset); offset += IREG_SIZE;
 127         MIPS_SW (code, mips_s3, mips_sp, offset); offset += IREG_SIZE;
 128         MIPS_SW (code, mips_s4, mips_sp, offset); offset += IREG_SIZE;
 129         MIPS_SW (code, mips_s5, mips_sp, offset); offset += IREG_SIZE;
 130         MIPS_SW (code, mips_s6, mips_sp, offset); offset += IREG_SIZE;
 131         MIPS_SW (code, mips_s7, mips_sp, offset); offset += IREG_SIZE;
 132         MIPS_SW (code, mips_fp, mips_sp, offset); offset += IREG_SIZE;
 133
 134         /* Restore global registers from MonoContext, including the frame pointer */
 135         MIPS_LW (code, mips_s0, mips_a0, G_STRUCT_OFFSET (MonoContext, sc_regs[mips_s0]));
 136         MIPS_LW (code, mips_s1, mips_a0, G_STRUCT_OFFSET (MonoContext, sc_regs[mips_s1]));
 137         MIPS_LW (code, mips_s2, mips_a0, G_STRUCT_OFFSET (MonoContext, sc_regs[mips_s2]));
 138         MIPS_LW (code, mips_s3, mips_a0, G_STRUCT_OFFSET (MonoContext, sc_regs[mips_s3]));
 139         MIPS_LW (code, mips_s4, mips_a0, G_STRUCT_OFFSET (MonoContext, sc_regs[mips_s4]));
 140         MIPS_LW (code, mips_s5, mips_a0, G_STRUCT_OFFSET (MonoContext, sc_regs[mips_s5]));
 141         MIPS_LW (code, mips_s6, mips_a0, G_STRUCT_OFFSET (MonoContext, sc_regs[mips_s6]));
 142         MIPS_LW (code, mips_s7, mips_a0, G_STRUCT_OFFSET (MonoContext, sc_regs[mips_s7]));
 143         MIPS_LW (code, mips_fp, mips_a0, G_STRUCT_OFFSET (MonoContext, sc_regs[mips_fp]));
 144
 145         /* a1 is the handler to call */
 146         mips_move (code, mips_t9, mips_a1);
 147
 148         /* jump to the saved IP */
 149         mips_jalr (code, mips_t9, mips_ra);
 150         mips_nop (code);
 151
 152         /* restore all regs from the stack */
 153         offset = 16;
 154         MIPS_LW (code, mips_s0, mips_sp, offset); offset += IREG_SIZE;
 155         MIPS_LW (code, mips_s1, mips_sp, offset); offset += IREG_SIZE;
 156         MIPS_LW (code, mips_s2, mips_sp, offset); offset += IREG_SIZE;
 157         MIPS_LW (code, mips_s3, mips_sp, offset); offset += IREG_SIZE;
 158         MIPS_LW (code, mips_s4, mips_sp, offset); offset += IREG_SIZE;
 159         MIPS_LW (code, mips_s5, mips_sp, offset); offset += IREG_SIZE;
 160         MIPS_LW (code, mips_s6, mips_sp, offset); offset += IREG_SIZE;
 161         MIPS_LW (code, mips_s7, mips_sp, offset); offset += IREG_SIZE;
 162         MIPS_LW (code, mips_fp, mips_sp, offset); offset += IREG_SIZE;
 163
 164         /* epilog */
 165         mips_lw (code, mips_ra, mips_sp, alloc_size + MIPS_RET_ADDR_OFFSET);
 166         mips_addiu (code, mips_sp, mips_sp, alloc_size);
 167         mips_jr (code, mips_ra);
 168         mips_nop (code);
 169
 170         g_assert ((code - start) < sizeof(start));
 171         mono_arch_flush_icache (start, code - start);
 172         mono_profiler_code_buffer_new (start, code - start, MONO_PROFILER_CODE_BUFFER_EXCEPTION_HANDLING, NULL);
 173         return start;
 174 }
 175
 176 static void
 177 throw_exception (MonoObject *exc, unsigned long eip, unsigned long esp, gboolean rethrow)
 178 {
 179         MonoContext ctx;
 180
 181 #ifdef DEBUG_EXCEPTIONS
 182         g_print ("throw_exception: exc=%p eip=%p esp=%p rethrow=%d\n",
 183                  exc, (void *)eip, (void *) esp, rethrow);
 184 #endif
 185
 186         /* adjust eip so that it point into the call instruction */
 187         eip -= 8;
 188
 189         memset (&ctx, 0, sizeof (MonoContext));
 190
 191         /*g_print  ("stack in throw: %p\n", esp);*/
 192         memcpy (&ctx.sc_regs, (void *)(esp + MIPS_STACK_PARAM_OFFSET),
 193                 sizeof (gulong) * MONO_SAVED_GREGS);
 194         memset (&ctx.sc_fpregs, 0, sizeof (mips_freg) * MONO_SAVED_FREGS);
 195         MONO_CONTEXT_SET_IP (&ctx, eip);
 196
 197         if (mono_object_isinst (exc, mono_defaults.exception_class)) {
 198                 MonoException *mono_ex = (MonoException*)exc;
 199                 if (!rethrow) {
 200                         mono_ex->stack_trace = NULL;
 201                         mono_ex->trace_ips = NULL;
 202                 }
 203         }
 204         mono_handle_exception (&ctx, exc);
 205 #ifdef DEBUG_EXCEPTIONS
 206         g_print ("throw_exception: restore to pc=%p sp=%p fp=%p ctx=%p\n",
 207                  (void *) ctx.sc_pc, (void *) ctx.sc_regs[mips_sp],
 208                  (void *) ctx.sc_regs[mips_fp], &ctx);
 209 #endif
 210         mono_restore_context (&ctx);
 211
 212         g_assert_not_reached ();
 213 }
 214
 215 /**
 216  * arch_get_throw_exception_generic:
 217  *
 218  * Returns a function pointer which can be used to raise
 219  * exceptions. The returned function has the following
 220  * signature: void (*func) (MonoException *exc); or
 221  * void (*func) (char *exc_name);
 222  *
 223  */
 224 static gpointer
 225 mono_arch_get_throw_exception_generic (guint8 *start, int size, int corlib, gboolean rethrow)
 226 {
 227         guint8 *code;
 228         int alloc_size, pos, i;
 229
 230         code = start;
 231
 232         //g_print ("mono_arch_get_throw_exception_generic: code=%p\n", code);
 233
 234         pos = 0;
 235         /* XXX - save all the FP regs on the stack ? */
 236
 237         pos += MONO_MAX_IREGS * sizeof(guint32);
 238
 239         alloc_size = MIPS_MINIMAL_STACK_SIZE + pos + 64;
 240         // align to MIPS_STACK_ALIGNMENT bytes
 241         alloc_size += MIPS_STACK_ALIGNMENT - 1;
 242         alloc_size &= ~(MIPS_STACK_ALIGNMENT - 1);
 243
 244         g_assert ((alloc_size & (MIPS_STACK_ALIGNMENT-1)) == 0);
 245         mips_addiu (code, mips_sp, mips_sp, -alloc_size);
 246         mips_sw (code, mips_ra, mips_sp, alloc_size + MIPS_RET_ADDR_OFFSET);
 247
 248         /* Save all the regs on the stack */
 249         for (i = 0; i < MONO_MAX_IREGS; i++) {
 250                 if (i != mips_sp)
 251                         MIPS_SW (code, i, mips_sp, i*IREG_SIZE + MIPS_STACK_PARAM_OFFSET);
 252                 else {
 253                         mips_addiu (code, mips_at, mips_sp, alloc_size);
 254                         MIPS_SW (code, mips_at, mips_sp, i*IREG_SIZE + MIPS_STACK_PARAM_OFFSET);
 255                 }
 256         }
 257
 258         if (corlib) {
 259                 mips_move (code, mips_a1, mips_a0);
 260                 mips_load (code, mips_a0, mono_defaults.corlib);
 261                 mips_load (code, mips_t9, mono_exception_from_token);
 262                 mips_jalr (code, mips_t9, mips_ra);
 263                 mips_nop (code);
 264                 mips_move (code, mips_a0, mips_v0);
 265         }
 266         /* call throw_exception (exc, ip, sp, rethrow) */
 267
 268         /* exc is already in place in a0 */
 269
 270         /* pointer to ip */
 271         if (corlib)
 272                 mips_lw (code, mips_a1, mips_sp, alloc_size + MIPS_RET_ADDR_OFFSET);
 273         else
 274                 mips_move (code, mips_a1, mips_ra);
 275
 276         /* current sp & rethrow */
 277         mips_move (code, mips_a2, mips_sp);
 278         mips_addiu (code, mips_a3, mips_zero, rethrow);
 279
 280         mips_load (code, mips_t9, throw_exception);
 281         mips_jr (code, mips_t9);
 282         mips_nop (code);
 283         /* we should never reach this breakpoint */
 284         mips_break (code, 0xfe);
 285
 286         g_assert ((code - start) < size);
 287         mono_arch_flush_icache (start, code - start);
 288         mono_profiler_code_buffer_new (start, code - start, MONO_PROFILER_CODE_BUFFER_EXCEPTION_HANDLING, NULL);
 289         return start;
 290 }
 291
 292 /**
 293  * mono_arch_get_rethrow_exception:
 294  *
 295  * Returns a function pointer which can be used to rethrow
 296  * exceptions. The returned function has the following
 297  * signature: void (*func) (MonoException *exc);
 298  *
 299  */
 300 gpointer
 301 mono_arch_get_rethrow_exception (MonoTrampInfo **info, gboolean aot)
 302 {
 303         static guint8 start [GENERIC_EXCEPTION_SIZE];
 304         static int inited = 0;
 305
 306         g_assert (!aot);
 307         if (info)
 308                 *info = NULL;
 309
 310         if (inited)
 311                 return start;
 312         mono_arch_get_throw_exception_generic (start, sizeof (start), FALSE, TRUE);
 313         inited = 1;
 314         return start;
 315 }
 316
 317 /**
 318  * arch_get_throw_exception:
 319  *
 320  * Returns a function pointer which can be used to raise
 321  * exceptions. The returned function has the following
 322  * signature: void (*func) (MonoException *exc);
 323  * For example to raise an arithmetic exception you can use:
 324  *
 325  * x86_push_imm (code, mono_get_exception_arithmetic ());
 326  * x86_call_code (code, arch_get_throw_exception ());
 327  *
 328  */
 329 gpointer
 330 mono_arch_get_throw_exception (MonoTrampInfo **info, gboolean aot)
 331 {
 332         static guint8 start [GENERIC_EXCEPTION_SIZE];
 333         static int inited = 0;
 334
 335         g_assert (!aot);
 336         if (info)
 337                 *info = NULL;
 338
 339         if (inited)
 340                 return start;
 341         mono_arch_get_throw_exception_generic (start, sizeof (start), FALSE, FALSE);
 342         inited = 1;
 343         return start;
 344 }
 345
 346 gpointer
 347 mono_arch_get_throw_exception_by_name (void)
 348 {
 349         guint8 *start, *code;
 350         int size = 64;
 351
 352         /* Not used on MIPS */
 353         start = code = mono_global_codeman_reserve (size);
 354         mips_break (code, 0xfd);
 355         mono_arch_flush_icache (start, code - start);
 356         mono_profiler_code_buffer_new (start, code - start, MONO_PROFILER_CODE_BUFFER_EXCEPTION_HANDLING, NULL);
 357         return start;
 358 }
 359
 360 /**
 361  * mono_arch_get_throw_corlib_exception:
 362  *
 363  * Returns a function pointer which can be used to raise
 364  * corlib exceptions. The returned function has the following
 365  * signature: void (*func) (guint32 ex_token, guint32 offset);
 366  * On MIPS, the offset argument is missing.
 367  */
 368 gpointer
 369 mono_arch_get_throw_corlib_exception (MonoTrampInfo **info, gboolean aot)
 370 {
 371         static guint8 start [GENERIC_EXCEPTION_SIZE];
 372         static int inited = 0;
 373
 374         g_assert (!aot);
 375         if (info)
 376                 *info = NULL;
 377
 378         if (inited)
 379                 return start;
 380         mono_arch_get_throw_exception_generic (start, sizeof (start), TRUE, FALSE);
 381         inited = 1;
 382         return start;
 383 }
 384
 385 /*
 386  * mono_arch_find_jit_info:
 387  *
 388  * This function is used to gather information from @ctx, and store it in @frame_info.
 389  * It unwinds one stack frame, and stores the resulting context into @new_ctx. @lmf
 390  * is modified if needed.
 391  * Returns TRUE on success, FALSE otherwise.
 392  */
 393 gboolean
 394 mono_arch_find_jit_info (MonoDomain *domain, MonoJitTlsData *jit_tls,
 395                                                          MonoJitInfo *ji, MonoContext *ctx,
 396                                                          MonoContext *new_ctx, MonoLMF **lmf,
 397                                                          mgreg_t **save_locations,
 398                                                          StackFrameInfo *frame)
 399 {
 400         memset (frame, 0, sizeof (StackFrameInfo));
 401         frame->ji = ji;
 402
 403         *new_ctx = *ctx;
 404
 405         if (ji != NULL) {
 406                 int i;
 407                 gpointer ip = MONO_CONTEXT_GET_IP (ctx);
 408                 mgreg_t regs [MONO_MAX_IREGS + 1];
 409                 guint8 *cfa;
 410                 guint32 unwind_info_len;
 411                 guint8 *unwind_info;
 412
 413                 frame->type = FRAME_TYPE_MANAGED;
 414
 415                 unwind_info = mono_jinfo_get_unwind_info (ji, &unwind_info_len);
 416
 417                 for (i = 0; i < MONO_MAX_IREGS; ++i)
 418                         regs [i] = new_ctx->sc_regs [i];
 419
 420                 mono_unwind_frame (unwind_info, unwind_info_len, ji->code_start,
 421                                                    (guint8*)ji->code_start + ji->code_size,
 422                                                    ip, NULL, regs, MONO_MAX_IREGS,
 423                                                    save_locations, MONO_MAX_IREGS, &cfa);
 424
 425                 for (i = 0; i < MONO_MAX_IREGS; ++i)
 426                         new_ctx->sc_regs [i] = regs [i];
 427                 new_ctx->sc_pc = regs [mips_ra];
 428                 new_ctx->sc_regs [mips_sp] = (mgreg_t)cfa;
 429
 430                 /* we substract 8, so that the IP points into the call instruction */
 431                 MONO_CONTEXT_SET_IP (new_ctx, new_ctx->sc_pc - 8);
 432
 433                 /* Sanity check -- we should have made progress here */
 434                 g_assert (MONO_CONTEXT_GET_SP (new_ctx) != MONO_CONTEXT_GET_SP (ctx));
 435                 return TRUE;
 436         } else if (*lmf) {
 437
 438                 if (((mgreg_t)(*lmf)->previous_lmf) & 2) {
 439                         /*
 440                          * This LMF entry is created by the soft debug code to mark transitions to
 441                          * managed code done during invokes.
 442                          */
 443                         MonoLMFExt *ext = (MonoLMFExt*)(*lmf);
 444
 445                         g_assert (ext->debugger_invoke);
 446
 447                         memcpy (new_ctx, &ext->ctx, sizeof (MonoContext));
 448
 449                         *lmf = (gpointer)(((gsize)(*lmf)->previous_lmf) & ~3);
 450
 451                         frame->type = FRAME_TYPE_DEBUGGER_INVOKE;
 452
 453                         return TRUE;
 454                 }
 455
 456                 if (!(*lmf)->method) {
 457 #ifdef DEBUG_EXCEPTIONS
 458                         g_print ("mono_arch_find_jit_info: bad lmf @ %p\n", (void *) *lmf);
 459 #endif
 460                         return FALSE;
 461                 }
 462                 g_assert (((*lmf)->magic == MIPS_LMF_MAGIC1) || ((*lmf)->magic == MIPS_LMF_MAGIC2));
 463
 464                 ji = mini_jit_info_table_find (domain, (gpointer)(*lmf)->eip, NULL);
 465                 if (!ji) {
 466                         // FIXME: This can happen with multiple appdomains (bug #444383)
 467                         return FALSE;
 468                 }
 469
 470                 frame->ji = ji;
 471                 frame->type = FRAME_TYPE_MANAGED_TO_NATIVE;
 472
 473                 memcpy (&new_ctx->sc_regs, (*lmf)->iregs, sizeof (gulong) * MONO_SAVED_GREGS);
 474                 memcpy (&new_ctx->sc_fpregs, (*lmf)->fregs, sizeof (float) * MONO_SAVED_FREGS);
 475                 MONO_CONTEXT_SET_IP (new_ctx, (*lmf)->eip);
 476                 /* ensure that we've made progress */
 477                 g_assert (new_ctx->sc_pc != ctx->sc_pc);
 478
 479                 *lmf = (gpointer)(((gsize)(*lmf)->previous_lmf) & ~3);
 480
 481                 return TRUE;
 482         }
 483
 484         return FALSE;
 485 }
 486
 487 gpointer
 488 mono_arch_ip_from_context (void *sigctx)
 489 {
 490         return (gpointer)(gsize)UCONTEXT_REG_PC (sigctx);
 491 }
 492
 493 /*
 494  * handle_exception:
 495  *
 496  *   Called by resuming from a signal handler.
 497  */
 498 static void
 499 handle_signal_exception (gpointer obj)
 500 {
 501         MonoJitTlsData *jit_tls = mono_native_tls_get_value (mono_jit_tls_id);
 502         MonoContext ctx;
 503
 504         memcpy (&ctx, &jit_tls->ex_ctx, sizeof (MonoContext));
 505
 506         mono_handle_exception (&ctx, obj);
 507
 508         mono_restore_context (&ctx);
 509 }
 510
 511 /*
 512  * This is the function called from the signal handler
 513  */
 514 gboolean
 515 mono_arch_handle_exception (void *ctx, gpointer obj)
 516 {
 517 #if defined(MONO_CROSS_COMPILE)
 518         g_assert_not_reached ();
 519 #elif defined(MONO_ARCH_USE_SIGACTION)
 520         void *sigctx = ctx;
 521
 522         /*
 523          * Handling the exception in the signal handler is problematic, since the original
 524          * signal is disabled, and we could run arbitrary code though the debugger. So
 525          * resume into the normal stack and do most work there if possible.
 526          */
 527         MonoJitTlsData *jit_tls = mono_native_tls_get_value (mono_jit_tls_id);
 528         guint64 sp = UCONTEXT_GREGS (sigctx) [mips_sp];
 529
 530         /* Pass the ctx parameter in TLS */
 531         mono_sigctx_to_monoctx (sigctx, &jit_tls->ex_ctx);
 532         /* The others in registers */
 533         UCONTEXT_GREGS (sigctx)[mips_a0] = (gsize)obj;
 534
 535         /* Allocate a stack frame */
 536         sp -= 256;
 537         UCONTEXT_GREGS (sigctx)[mips_sp] = sp;
 538
 539         UCONTEXT_REG_PC (sigctx) = (gsize)handle_signal_exception;
 540
 541         return TRUE;
 542 #else
 543         MonoContext mctx;
 544         gboolean result;
 545
 546         mono_sigctx_to_monoctx (ctx, &mctx);
 547
 548         result = mono_handle_exception (&mctx, obj);
 549         /* restore the context so that returning from the signal handler will invoke
 550          * the catch clause
 551          */
 552         mono_monoctx_to_sigctx (&mctx, ctx);
 553         return result;
 554 #endif
 555 }
 556
 557 /*
 558  * mono_arch_setup_resume_sighandler_ctx:
 559  *
 560  *   Setup CTX so execution continues at FUNC.
 561  */
 562 void
 563 mono_arch_setup_resume_sighandler_ctx (MonoContext *ctx, gpointer func)
 564 {
 565         MONO_CONTEXT_SET_IP (ctx,func);
 566 }