mono/jit/exception.c

   1 /*
   2  * exception.c: exception support
   3  *
   4  * Authors:
   5  *   Dietmar Maurer (dietmar@ximian.com)
   6  *
   7  * (C) 2001 Ximian, Inc.
   8  */
   9
  10 #include <config.h>
  11 #include <glib.h>
  12
  13 #include <mono/arch/x86/x86-codegen.h>
  14 #include <mono/metadata/appdomain.h>
  15 #include <mono/metadata/tabledefs.h>
  16 #include <mono/metadata/threads.h>
  17 #include <mono/metadata/debug-helpers.h>
  18
  19 #include "jit.h"
  20 #include "codegen.h"
  21 #include "debug.h"
  22
  23 #ifdef __FreeBSD__
  24 # define SC_EAX sc_eax
  25 # define SC_EBX sc_ebx
  26 # define SC_ECX sc_ecx
  27 # define SC_EDX sc_edx
  28 # define SC_EBP sc_ebp
  29 # define SC_EIP sc_eip
  30 # define SC_ESP sc_esp
  31 # define SC_EDI sc_edi
  32 # define SC_ESI sc_esi
  33 #else
  34 # define SC_EAX eax
  35 # define SC_EBX ebx
  36 # define SC_ECX ecx
  37 # define SC_EDX edx
  38 # define SC_EBP ebp
  39 # define SC_EIP eip
  40 # define SC_ESP esp
  41 # define SC_EDI edi
  42 # define SC_ESI esi
  43 #endif
  44
  45 /*
  46  * arch_get_restore_context:
  47  *
  48  * Returns a pointer to a method which restores a previously saved sigcontext.
  49  */
  50 static gpointer
  51 arch_get_restore_context (void)
  52 {
  53         static guint8 *start = NULL;
  54         guint8 *code;
  55
  56         if (start)
  57                 return start;
  58
  59         /* restore_contect (struct sigcontext *ctx) */
  60         /* we do not restore X86_EAX, X86_EDX */
  61
  62         start = code = g_malloc (1024);
  63
  64         /* load ctx */
  65         x86_mov_reg_membase (code, X86_EAX, X86_ESP, 4, 4);
  66
  67         /* get return address, stored in EDX */
  68         x86_mov_reg_membase (code, X86_EDX, X86_EAX,  G_STRUCT_OFFSET (struct sigcontext, SC_EIP), 4);
  69         /* restore EBX */
  70         x86_mov_reg_membase (code, X86_EBX, X86_EAX,  G_STRUCT_OFFSET (struct sigcontext, SC_EBX), 4);
  71         /* restore EDI */
  72         x86_mov_reg_membase (code, X86_EDI, X86_EAX,  G_STRUCT_OFFSET (struct sigcontext, SC_EDI), 4);
  73         /* restore ESI */
  74         x86_mov_reg_membase (code, X86_ESI, X86_EAX,  G_STRUCT_OFFSET (struct sigcontext, SC_ESI), 4);
  75         /* restore ESP */
  76         x86_mov_reg_membase (code, X86_ESP, X86_EAX,  G_STRUCT_OFFSET (struct sigcontext, SC_ESP), 4);
  77         /* restore EBP */
  78         x86_mov_reg_membase (code, X86_EBP, X86_EAX,  G_STRUCT_OFFSET (struct sigcontext, SC_EBP), 4);
  79         /* restore ECX. the exception object is passed here to the catch handler */
  80         x86_mov_reg_membase (code, X86_ECX, X86_EAX,  G_STRUCT_OFFSET (struct sigcontext, SC_ECX), 4);
  81
  82         /* jump to the saved IP */
  83         x86_jump_reg (code, X86_EDX);
  84
  85         return start;
  86 }
  87
  88 /*
  89  * arch_get_call_finally:
  90  *
  91  * Returns a pointer to a method which calls a finally handler.
  92  */
  93 static gpointer
  94 arch_get_call_finally (void)
  95 {
  96         static guint8 start [28];
  97         static int inited = 0;
  98         guint8 *code;
  99
 100         if (inited)
 101                 return start;
 102
 103         inited = 1;
 104         /* call_finally (struct sigcontext *ctx, unsigned long eip) */
 105         code = start;
 106
 107         x86_push_reg (code, X86_EBP);
 108         x86_mov_reg_reg (code, X86_EBP, X86_ESP, 4);
 109         x86_push_reg (code, X86_EBX);
 110         x86_push_reg (code, X86_EDI);
 111         x86_push_reg (code, X86_ESI);
 112
 113         /* load ctx */
 114         x86_mov_reg_membase (code, X86_EAX, X86_EBP, 8, 4);
 115         /* load eip */
 116         x86_mov_reg_membase (code, X86_ECX, X86_EBP, 12, 4);
 117         /* save EBP */
 118         x86_push_reg (code, X86_EBP);
 119         /* set new EBP */
 120         x86_mov_reg_membase (code, X86_EBP, X86_EAX,  G_STRUCT_OFFSET (struct sigcontext, SC_EBP), 4);
 121         /* call the handler */
 122         x86_call_reg (code, X86_ECX);
 123         /* restore EBP */
 124         x86_pop_reg (code, X86_EBP);
 125         /* restore saved regs */
 126         x86_pop_reg (code, X86_ESI);
 127         x86_pop_reg (code, X86_EDI);
 128         x86_pop_reg (code, X86_EBX);
 129         x86_leave (code);
 130         x86_ret (code);
 131
 132         g_assert ((code - start) < 28);
 133         return start;
 134 }
 135
 136 /*
 137  * return TRUE if the exception is catched. It also sets the
 138  * stack_trace String.
 139  */
 140 static gboolean
 141 arch_exc_is_catched (MonoDomain *domain, MonoJitTlsData *jit_tls, gpointer ip,
 142                      gpointer *bp, gpointer obj)
 143 {
 144         MonoJitInfo *ji;
 145         gpointer *end_of_stack;
 146         MonoLMF *lmf = jit_tls->lmf;
 147         MonoMethod *m;
 148         int i;
 149
 150         end_of_stack = jit_tls->end_of_stack;
 151         g_assert (end_of_stack);
 152
 153         while (1) {
 154
 155                 ji = mono_jit_info_table_find (domain, ip);
 156
 157                 if (ji) { /* we are inside managed code */
 158                         m = ji->method;
 159
 160                         if (mono_object_isinst (obj, mono_defaults.exception_class)) {
 161                                 char    *strace = mono_string_to_utf8 (((MonoException*)obj)->stack_trace);
 162                                 char    *tmp, *tmpsig, *source_location, *tmpaddr;
 163                                 gint32   address, iloffset;
 164
 165                                 if (!strcmp (strace, "TODO: implement stack traces")){
 166                                         g_free (strace);
 167                                         strace = g_strdup ("");
 168                                 }
 169
 170                                 address = (char *)ip - (char *)ji->code_start;
 171
 172                                 source_location = mono_debug_source_location_from_address (m, address);
 173                                 iloffset = mono_debug_il_offset_from_address (m, address);
 174
 175                                 if (iloffset < 0)
 176                                         tmpaddr = g_strdup_printf ("<0x%05x>", address);
 177                                 else
 178                                         tmpaddr = g_strdup_printf ("[0x%05x]", iloffset);
 179
 180                                 tmpsig = mono_signature_get_desc(m->signature, TRUE);
 181                                 if (source_location)
 182                                         tmp = g_strdup_printf ("%sin %s (at %s) %s.%s:%s (%s)\n", strace, tmpaddr,
 183                                                                source_location, m->klass->name_space, m->klass->name,
 184                                                                m->name, tmpsig);
 185                                 else
 186                                         tmp = g_strdup_printf ("%sin %s %s.%s:%s (%s)\n", strace, tmpaddr,
 187                                                                m->klass->name_space, m->klass->name, m->name, tmpsig);
 188                                 g_free (source_location);
 189                                 g_free (tmpsig);
 190                                 g_free (strace);
 191
 192                                 ((MonoException*)obj)->stack_trace = mono_string_new (domain, tmp);
 193                                 g_free (tmp);
 194                         }
 195
 196                         if (ji->num_clauses) {
 197
 198                                 g_assert (ji->clauses);
 199
 200                                 for (i = 0; i < ji->num_clauses; i++) {
 201                                         MonoJitExceptionInfo *ei = &ji->clauses [i];
 202
 203                                         if (ei->try_start <= ip && ip <= (ei->try_end)) {
 204                                                 /* catch block */
 205                                                 if (ei->flags == 0 && mono_object_isinst (obj,
 206                                                         mono_class_get (m->klass->image, ei->token_or_filter))) {
 207                                                         return TRUE;
 208                                                 }
 209                                         }
 210                                 }
 211                         }
 212
 213                         /* continue unwinding */
 214
 215                         ip = (gpointer)(*((int *)bp + 1) - 5);
 216                         bp = (gpointer)(*((int *)bp));
 217
 218                         if (bp >= end_of_stack)
 219                                 return FALSE;
 220
 221                 } else {
 222                         if (!lmf)
 223                                 return FALSE;
 224
 225                         bp = (gpointer)lmf->ebp;
 226                         ip = (gpointer)lmf->eip;
 227
 228                         m = lmf->method;
 229
 230                         if (mono_object_isinst (obj, mono_defaults.exception_class)) {
 231                                 char  *strace = mono_string_to_utf8 (((MonoException*)obj)->stack_trace);
 232                                 char  *tmp;
 233
 234                                 if (!strcmp (strace, "TODO: implement stack traces"))
 235                                         strace = g_strdup ("");
 236
 237                                 tmp = g_strdup_printf ("%sin (unmanaged) %s.%s:%s ()\n", strace, m->klass->name_space,
 238                                                        m->klass->name, m->name);
 239
 240                                 g_free (strace);
 241
 242                                 ((MonoException*)obj)->stack_trace = mono_string_new (domain, tmp);
 243                                 g_free (tmp);
 244                         }
 245
 246                         lmf = lmf->previous_lmf;
 247
 248                         if (bp >= end_of_stack)
 249                                 return FALSE;
 250                 }
 251         }
 252
 253         return FALSE;
 254 }
 255
 256 /**
 257  * arch_handle_exception:
 258  * @ctx: saved processor state
 259  * @obj:
 260  */
 261 void
 262 arch_handle_exception (struct sigcontext *ctx, gpointer obj)
 263 {
 264         MonoDomain *domain = mono_domain_get ();
 265         MonoJitInfo *ji;
 266         gpointer ip = (gpointer)ctx->SC_EIP;
 267         static void (*restore_context) (struct sigcontext *);
 268         static void (*call_finally) (struct sigcontext *, unsigned long);
 269         void (*cleanup) (MonoObject *exc);
 270         MonoJitTlsData *jit_tls = TlsGetValue (mono_jit_tls_id);
 271         gpointer end_of_stack;
 272
 273         g_assert (ctx != NULL);
 274
 275         if (!obj) {
 276                 MonoException *ex = mono_get_exception_null_reference ();
 277                 ex->message = mono_string_new (domain,
 278                         "Object reference not set to an instance of an object");
 279                 obj = (MonoObject *)ex;
 280         }
 281
 282         if (!restore_context)
 283                 restore_context = arch_get_restore_context ();
 284
 285         if (!call_finally)
 286                 call_finally = arch_get_call_finally ();
 287
 288         end_of_stack = jit_tls->end_of_stack;
 289         g_assert (end_of_stack);
 290
 291         cleanup = jit_tls->abort_func;
 292
 293         if (!arch_exc_is_catched (domain, jit_tls, ip, (gpointer *)ctx->SC_EBP, obj)) {
 294                 if (mono_debug_format != MONO_DEBUG_FORMAT_NONE) {
 295                         mono_debug_make_symbols ();
 296                         G_BREAKPOINT ();
 297                 }
 298                 mono_unhandled_exception (obj);
 299         }
 300
 301         while (1) {
 302
 303                 ji = mono_jit_info_table_find (domain, ip);
 304
 305                 if (ji) { /* we are inside managed code */
 306                         MonoMethod *m = ji->method;
 307                         int offset;
 308
 309                         if (ji->num_clauses) {
 310                                 int i;
 311
 312                                 g_assert (ji->clauses);
 313
 314                                 for (i = 0; i < ji->num_clauses; i++) {
 315                                         MonoJitExceptionInfo *ei = &ji->clauses [i];
 316
 317                                         if (ei->try_start <= ip && ip <= (ei->try_end)) {
 318                                                 /* catch block */
 319                                                 if (ei->flags == 0 && mono_object_isinst (obj,
 320                                                         mono_class_get (m->klass->image, ei->token_or_filter))) {
 321
 322                                                         ctx->SC_EIP = (unsigned long)ei->handler_start;
 323                                                         ctx->SC_ECX = (unsigned long)obj;
 324                                                         restore_context (ctx);
 325                                                         g_assert_not_reached ();
 326                                                 }
 327                                         }
 328                                 }
 329
 330                                 /* no handler found - we need to call all finally handlers */
 331                                 for (i = 0; i < ji->num_clauses; i++) {
 332                                         MonoJitExceptionInfo *ei = &ji->clauses [i];
 333
 334                                         if (ei->try_start <= ip && ip < (ei->try_end) &&
 335                                             (ei->flags & MONO_EXCEPTION_CLAUSE_FINALLY)) {
 336                                                 call_finally (ctx, (unsigned long)ei->handler_start);
 337                                         }
 338                                 }
 339                         }
 340
 341                         /* continue unwinding */
 342
 343                         offset = -1;
 344                         /* restore caller saved registers */
 345                         if (ji->used_regs & X86_ESI_MASK) {
 346                                 ctx->SC_EBX = *((int *)ctx->SC_EBP + offset);
 347                                 offset--;
 348                         }
 349                         if (ji->used_regs & X86_EDI_MASK) {
 350                                 ctx->SC_EDI = *((int *)ctx->SC_EBP + offset);
 351                                 offset--;
 352                         }
 353                         if (ji->used_regs & X86_EBX_MASK) {
 354                                 ctx->SC_ESI = *((int *)ctx->SC_EBP + offset);
 355                         }
 356
 357                         ctx->SC_ESP = ctx->SC_EBP;
 358                         ctx->SC_EIP = *((int *)ctx->SC_EBP + 1) - 5;
 359                         ctx->SC_EBP = *((int *)ctx->SC_EBP);
 360
 361                         ip = (gpointer)ctx->SC_EIP;
 362
 363                         if (ctx->SC_EBP > (unsigned)end_of_stack) {
 364                                 g_assert (cleanup);
 365                                 cleanup (obj);
 366                                 g_assert_not_reached ();
 367                         }
 368
 369                 } else {
 370                         MonoLMF *lmf = jit_tls->lmf;
 371
 372                         if (!lmf) {
 373                                 g_assert (cleanup);
 374                                 cleanup (obj);
 375                                 g_assert_not_reached ();
 376                         }
 377
 378                         jit_tls->lmf = lmf->previous_lmf;
 379
 380                         ctx->SC_ESI = lmf->esi;
 381                         ctx->SC_EDI = lmf->edi;
 382                         ctx->SC_EBX = lmf->ebx;
 383                         ctx->SC_EBP = lmf->ebp;
 384                         ctx->SC_EIP = lmf->eip;
 385                         ctx->SC_ESP = (unsigned long)&lmf->eip;
 386
 387                         ip = (gpointer)ctx->SC_EIP;
 388
 389                         if (ctx->SC_EBP >= (unsigned)end_of_stack) {
 390                                 g_assert (cleanup);
 391                                 cleanup (obj);
 392                                 g_assert_not_reached ();
 393                         }
 394                 }
 395         }
 396
 397         g_assert_not_reached ();
 398 }
 399
 400 static void
 401 throw_exception (unsigned long eax, unsigned long ecx, unsigned long edx, unsigned long ebx,
 402                  unsigned long esi, unsigned long edi, unsigned long ebp, MonoObject *exc,
 403                  unsigned long eip,  unsigned long esp)
 404 {
 405         struct sigcontext ctx;
 406
 407         /* adjust eip so that it point to the call instruction */
 408         eip -= 5;
 409
 410         ctx.SC_ESP = esp;
 411         ctx.SC_EIP = eip;
 412         ctx.SC_EBP = ebp;
 413         ctx.SC_EDI = edi;
 414         ctx.SC_ESI = esi;
 415         ctx.SC_EBX = ebx;
 416         ctx.SC_EDX = edx;
 417         ctx.SC_ECX = ecx;
 418         ctx.SC_EAX = eax;
 419
 420         arch_handle_exception (&ctx, exc);
 421
 422         g_assert_not_reached ();
 423 }
 424
 425 /**
 426  * arch_get_throw_exception:
 427  *
 428  * Returns a function pointer which can be used to raise
 429  * exceptions. The returned function has the following
 430  * signature: void (*func) (MonoException *exc);
 431  * For example to raise an arithmetic exception you can use:
 432  *
 433  * x86_push_imm (code, mono_get_exception_arithmetic ());
 434  * x86_call_code (code, arch_get_throw_exception ());
 435  *
 436  */
 437 gpointer
 438 arch_get_throw_exception (void)
 439 {
 440         static guint8 start [24];
 441         static int inited = 0;
 442         guint8 *code;
 443
 444         if (inited)
 445                 return start;
 446
 447         inited = 1;
 448         code = start;
 449
 450         x86_push_reg (code, X86_ESP);
 451         x86_push_membase (code, X86_ESP, 4); /* IP */
 452         x86_push_membase (code, X86_ESP, 12); /* exception */
 453         x86_push_reg (code, X86_EBP);
 454         x86_push_reg (code, X86_EDI);
 455         x86_push_reg (code, X86_ESI);
 456         x86_push_reg (code, X86_EBX);
 457         x86_push_reg (code, X86_EDX);
 458         x86_push_reg (code, X86_ECX);
 459         x86_push_reg (code, X86_EAX);
 460         x86_call_code (code, throw_exception);
 461         /* we should never reach this breakpoint */
 462         x86_breakpoint (code);
 463
 464         g_assert ((code - start) < 24);
 465         return start;
 466 }
 467
 468 /**
 469  * arch_get_throw_exception_by_name:
 470  *
 471  * Returns a function pointer which can be used to raise
 472  * corlib exceptions. The returned function has the following
 473  * signature: void (*func) (char *exc_name);
 474  * For example to raise an arithmetic exception you can use:
 475  *
 476  * x86_push_imm (code, "ArithmeticException");
 477  * x86_call_code (code, arch_get_throw_exception ());
 478  *
 479  */
 480 gpointer
 481 arch_get_throw_exception_by_name ()
 482 {
 483         static guint8 start [32];
 484         static int inited = 0;
 485         guint8 *code;
 486
 487         if (inited)
 488                 return start;
 489
 490         inited = 1;
 491         code = start;
 492
 493         /* fixme: we do not save EAX, EDX, ECD - unsure if we need that */
 494
 495         x86_push_membase (code, X86_ESP, 4); /* exception name */
 496         x86_push_imm (code, "System");
 497         x86_push_imm (code, mono_defaults.exception_class->image);
 498         x86_call_code (code, mono_exception_from_name);
 499         x86_alu_reg_imm (code, X86_ADD, X86_ESP, 12);
 500         /* save the newly create object (overwrite exception name)*/
 501         x86_mov_membase_reg (code, X86_ESP, 4, X86_EAX, 4);
 502         x86_jump_code (code, arch_get_throw_exception ());
 503
 504         g_assert ((code - start) < 32);
 505
 506         return start;
 507 }