mono/utils/mono-error.c

   1 /*
   2  * mono-error.c: Error handling code
   3  *
   4  * Authors:
   5  *      Rodrigo Kumpera    (rkumpera@novell.com)
   6  * Copyright 2009 Novell, Inc (http://www.novell.com)
   7  */
   8 #include <glib.h>
   9
  10 #include "mono-error.h"
  11 #include "mono-error-internals.h"
  12
  13 #include <mono/metadata/exception.h>
  14 #include <mono/metadata/object-internals.h>
  15 #include <mono/metadata/class-internals.h>
  16 #include <mono/metadata/debug-helpers.h>
  17
  18 #define mono_internal_error_get_message(E) ((E)->full_message ? (E)->full_message : (E)->message)
  19
  20 #define set_error_message() do { \
  21         va_list args; \
  22         va_start (args, msg_format); \
  23         if (g_vsnprintf (error->message, sizeof (error->message), msg_format, args) >= sizeof (error->message)) {\
  24                 va_end (args); \
  25                 va_start (args, msg_format); \
  26                 if (!(error->full_message = g_strdup_vprintf (msg_format, args))) \
  27                         error->flags |= MONO_ERROR_INCOMPLETE; \
  28         } \
  29         va_end (args); \
  30 } while (0)
  31
  32 static void
  33 mono_error_prepare (MonoErrorInternal *error)
  34 {
  35         if (error->error_code != MONO_ERROR_NONE)
  36                 return;
  37
  38         error->type_name = error->assembly_name = error->member_name = error->full_message = error->exception_name_space = error->exception_name = NULL;
  39         error->klass = NULL;
  40         error->message [0] = 0;
  41 }
  42
  43 void
  44 mono_error_init_flags (MonoError *oerror, unsigned short flags)
  45 {
  46         MonoErrorInternal *error = (MonoErrorInternal*)oerror;
  47         g_assert (sizeof (MonoError) == sizeof (MonoErrorInternal));
  48
  49         error->error_code = MONO_ERROR_NONE;
  50         error->flags = flags;
  51 }
  52
  53 void
  54 mono_error_init (MonoError *error)
  55 {
  56         mono_error_init_flags (error, 0);
  57 }
  58
  59 void
  60 mono_error_cleanup (MonoError *oerror)
  61 {
  62         MonoErrorInternal *error = (MonoErrorInternal*)oerror;
  63         if (error->error_code == MONO_ERROR_NONE)
  64                 return;
  65
  66         g_free ((char*)error->full_message);
  67         if (!(error->flags & MONO_ERROR_FREE_STRINGS)) //no memory was allocated
  68                 return;
  69
  70         g_free ((char*)error->type_name);
  71         g_free ((char*)error->assembly_name);
  72         g_free ((char*)error->member_name);
  73         g_free ((char*)error->exception_name_space);
  74         g_free ((char*)error->exception_name);
  75 }
  76
  77 gboolean
  78 mono_error_ok (MonoError *error)
  79 {
  80         return error->error_code == MONO_ERROR_NONE;
  81 }
  82
  83 unsigned short
  84 mono_error_get_error_code (MonoError *error)
  85 {
  86         return error->error_code;
  87 }
  88
  89 /*Return a pointer to the internal error message, might be NULL.
  90 Caller should not release it.*/
  91 const char*
  92 mono_error_get_message (MonoError *oerror)
  93 {
  94         MonoErrorInternal *error = (MonoErrorInternal*)oerror;
  95         if (error->error_code == MONO_ERROR_NONE)
  96                 return NULL;
  97         return mono_internal_error_get_message (error);
  98 }
  99
 100 /*
 101  * Inform that this error has heap allocated strings.
 102  * The strings will be duplicated if @dup_strings is TRUE
 103  * otherwise they will just be free'd in mono_error_cleanup.
 104  */
 105 void
 106 mono_error_dup_strings (MonoError *oerror, gboolean dup_strings)
 107 {
 108 #define DUP_STR(field) do { if (error->field) {\
 109         if (!(error->field = g_strdup (error->field))) \
 110                 error->flags |= MONO_ERROR_INCOMPLETE; \
 111         }} while (0);
 112
 113         MonoErrorInternal *error = (MonoErrorInternal*)oerror;
 114         error->flags |= MONO_ERROR_FREE_STRINGS;
 115
 116         if (dup_strings) {
 117                 DUP_STR (type_name);
 118                 DUP_STR (assembly_name);
 119                 DUP_STR (member_name);
 120                 DUP_STR (exception_name_space);
 121                 DUP_STR (exception_name);
 122         }
 123 #undef DUP_STR
 124 }
 125
 126 void
 127 mono_error_set_error (MonoError *oerror, int error_code, const char *msg_format, ...)
 128 {
 129         MonoErrorInternal *error = (MonoErrorInternal*)oerror;
 130         mono_error_prepare (error);
 131
 132         error->error_code = error_code;
 133         set_error_message ();
 134 }
 135
 136 static void
 137 mono_error_set_assembly_name (MonoError *oerror, const char *assembly_name)
 138 {
 139         MonoErrorInternal *error = (MonoErrorInternal*)oerror;
 140         g_assert (error->error_code != MONO_ERROR_NONE);
 141
 142         error->assembly_name = assembly_name;
 143 }
 144
 145 static void
 146 mono_error_set_member_name (MonoError *oerror, const char *member_name)
 147 {
 148         MonoErrorInternal *error = (MonoErrorInternal*)oerror;
 149
 150         error->member_name = member_name;
 151 }
 152
 153 static void
 154 mono_error_set_type_name (MonoError *oerror, const char *type_name)
 155 {
 156         MonoErrorInternal *error = (MonoErrorInternal*)oerror;
 157
 158         error->type_name = type_name;
 159 }
 160
 161 static void
 162 mono_error_set_class (MonoError *oerror, MonoClass *klass)
 163 {
 164         MonoErrorInternal *error = (MonoErrorInternal*)oerror;
 165
 166         error->klass = klass;
 167 }
 168
 169 static void
 170 mono_error_set_corlib_exception (MonoError *oerror, const char *name_space, const char *name)
 171 {
 172         MonoErrorInternal *error = (MonoErrorInternal*)oerror;
 173
 174         error->exception_name_space = name_space;
 175         error->exception_name = name;
 176 }
 177
 178
 179 void
 180 mono_error_set_assembly_load (MonoError *oerror, const char *assembly_name, const char *msg_format, ...)
 181 {
 182         MonoErrorInternal *error = (MonoErrorInternal*)oerror;
 183         mono_error_prepare (error);
 184
 185         error->error_code = MONO_ERROR_FILE_NOT_FOUND;
 186         mono_error_set_assembly_name (oerror, assembly_name);
 187
 188         set_error_message ();
 189 }
 190
 191 void
 192 mono_error_set_type_load_class (MonoError *oerror, MonoClass *klass, const char *msg_format, ...)
 193 {
 194         MonoErrorInternal *error = (MonoErrorInternal*)oerror;
 195         mono_error_prepare (error);
 196
 197         error->error_code = MONO_ERROR_TYPE_LOAD;
 198         mono_error_set_class (oerror, klass);
 199         set_error_message ();
 200 }
 201
 202 void
 203 mono_error_set_type_load_name (MonoError *oerror, const char *type_name, const char *assembly_name, const char *msg_format, ...)
 204 {
 205         MonoErrorInternal *error = (MonoErrorInternal*)oerror;
 206         mono_error_prepare (error);
 207
 208         error->error_code = MONO_ERROR_TYPE_LOAD;
 209         mono_error_set_type_name (oerror, type_name);
 210         mono_error_set_assembly_name (oerror, assembly_name);
 211         set_error_message ();
 212 }
 213
 214 void
 215 mono_error_set_method_load (MonoError *oerror, MonoClass *klass, const char *method_name, const char *msg_format, ...)
 216 {
 217         MonoErrorInternal *error = (MonoErrorInternal*)oerror;
 218         mono_error_prepare (error);
 219
 220         error->error_code = MONO_ERROR_MISSING_METHOD;
 221         mono_error_set_class (oerror, klass);
 222         mono_error_set_member_name (oerror, method_name);
 223         set_error_message ();
 224 }
 225
 226 void
 227 mono_error_set_field_load (MonoError *oerror, MonoClass *klass, const char *field_name, const char *msg_format, ...)
 228 {
 229         MonoErrorInternal *error = (MonoErrorInternal*)oerror;
 230         mono_error_prepare (error);
 231
 232         error->error_code = MONO_ERROR_MISSING_FIELD;
 233         mono_error_set_class (oerror, klass);
 234         mono_error_set_member_name (oerror, field_name);
 235         set_error_message ();
 236 }
 237
 238 void
 239 mono_error_set_bad_image_name (MonoError *oerror, const char *assembly_name, const char *msg_format, ...)
 240 {
 241         MonoErrorInternal *error = (MonoErrorInternal*)oerror;
 242         mono_error_prepare (error);
 243
 244         error->error_code = MONO_ERROR_BAD_IMAGE;
 245         mono_error_set_assembly_name (oerror, assembly_name);
 246         set_error_message ();
 247 }
 248
 249 void
 250 mono_error_set_bad_image (MonoError *oerror, MonoImage *image, const char *msg_format, ...)
 251 {
 252         MonoErrorInternal *error = (MonoErrorInternal*)oerror;
 253         mono_error_prepare (error);
 254
 255         error->error_code = MONO_ERROR_BAD_IMAGE;
 256         error->assembly_name = image ? mono_image_get_name (image) : "<no_image>";
 257         set_error_message ();
 258 }
 259
 260 void
 261 mono_error_set_generic_error (MonoError *oerror, const char * name_space, const char *name, const char *msg_format, ...)
 262 {
 263         MonoErrorInternal *error = (MonoErrorInternal*)oerror;
 264         mono_error_prepare (error);
 265
 266         error->error_code = MONO_ERROR_GENERIC;
 267         mono_error_set_corlib_exception (oerror, name_space, name);
 268         set_error_message ();
 269 }
 270
 271 void
 272 mono_error_set_from_loader_error (MonoError *oerror)
 273 {
 274         MonoLoaderError *loader_error = mono_loader_get_last_error ();
 275         MonoErrorInternal *error = (MonoErrorInternal*)oerror;
 276
 277         mono_error_prepare (error);
 278
 279
 280         if (!loader_error) {
 281                 mono_error_set_generic_error (oerror, "System", "ExecutionEngineException", "Runtime tried to produce a mono-error from an empty loader-error");
 282                 return;
 283         }
 284
 285         switch (loader_error->exception_type) {
 286         case MONO_EXCEPTION_NONE:
 287                 mono_error_set_generic_error (oerror, "System", "ExecutionEngineException", "Runtime tried to produce a mono-error from a non-error loader-error");
 288                 break;
 289         case MONO_EXCEPTION_SECURITY_LINKDEMAND:
 290         case MONO_EXCEPTION_SECURITY_INHERITANCEDEMAND:
 291                 mono_error_set_generic_error (oerror, "System.Security", "SecurityException", "Failed for unknown reasons.");
 292                 break;
 293
 294         case MONO_EXCEPTION_INVALID_PROGRAM:
 295                 mono_error_set_generic_error (oerror, "System", "InvalidProgramException", "Failed for unknown reasons.");
 296                 break;
 297
 298         case MONO_EXCEPTION_UNVERIFIABLE_IL:
 299                 mono_error_set_generic_error (oerror, "System.Security", "VerificationException", "Failed for unknown reasons.");
 300                 break;
 301
 302         case MONO_EXCEPTION_MISSING_METHOD:
 303                 error->error_code = MONO_ERROR_MISSING_METHOD;
 304                 mono_error_set_type_name (oerror, loader_error->class_name);
 305                 mono_error_set_member_name (oerror, loader_error->member_name);
 306                 g_snprintf (error->message, sizeof (error->message), "Failed for unknown reasons.");
 307                 break;
 308
 309         case MONO_EXCEPTION_MISSING_FIELD:
 310                 mono_error_set_field_load (oerror, loader_error->klass, loader_error->member_name, "Failed for unknown reasons.");
 311                 break;
 312
 313         case MONO_EXCEPTION_TYPE_LOAD:
 314                 mono_error_set_type_load_name (oerror, loader_error->class_name, loader_error->assembly_name, "Failed for unknown reasons.");
 315                 break;
 316
 317         case MONO_EXCEPTION_FILE_NOT_FOUND:
 318                 if (loader_error->ref_only)
 319                         mono_error_set_assembly_load (oerror, loader_error->assembly_name, "Cannot resolve dependency to assembly because it has not been preloaded. When using the ReflectionOnly APIs, dependent assemblies must be pre-loaded or loaded on demand through the ReflectionOnlyAssemblyResolve event.");
 320                 else
 321                         mono_error_set_assembly_load (oerror, loader_error->assembly_name, "Could not load file or assembly or one of its dependencies.");
 322                 break;
 323
 324         case MONO_EXCEPTION_METHOD_ACCESS:
 325                 mono_error_set_generic_error (oerror, "System", "MethodAccessException", "Failed for unknown reasons.");
 326                 break;
 327
 328         case MONO_EXCEPTION_FIELD_ACCESS:
 329                 mono_error_set_generic_error (oerror, "System", "FieldAccessException", "Failed for unknown reasons.");
 330                 break;
 331
 332         case MONO_EXCEPTION_OBJECT_SUPPLIED:
 333         case MONO_EXCEPTION_GENERIC_SHARING_FAILED:
 334                 mono_error_set_generic_error (oerror, "System", "ExecutionEngineException", "Runtime tried to produce a mono-error from JIT internal error %d", loader_error->exception_type);
 335                 break;
 336
 337         case MONO_EXCEPTION_BAD_IMAGE:
 338                 mono_error_set_bad_image_name (oerror, "<unknown>", "%s", loader_error->msg);
 339                 break;
 340
 341         case MONO_EXCEPTION_OUT_OF_MEMORY:
 342                 mono_error_set_out_of_memory (oerror, "Failed for unknown reasons.");
 343                 break;
 344
 345         default:
 346                 mono_error_set_generic_error (oerror, "System", "ExecutionEngineException", "Runtime tried to produce an unknown loader-error %d", loader_error->exception_type);
 347                 break;
 348         }
 349
 350         mono_error_dup_strings (oerror, TRUE);
 351         mono_loader_clear_error ();
 352 }
 353
 354 void
 355 mono_error_set_out_of_memory (MonoError *oerror, const char *msg_format, ...)
 356 {
 357         MonoErrorInternal *error = (MonoErrorInternal*)oerror;
 358         va_list args;
 359         mono_error_prepare (error);
 360
 361         error->error_code = MONO_ERROR_OUT_OF_MEMORY;
 362         va_start (args, msg_format);
 363         g_vsnprintf (error->message, sizeof (error->message), msg_format, args);
 364         va_end (args);
 365 }
 366
 367 void
 368 mono_error_set_argument (MonoError *oerror, const char *argument, const char *msg_format, ...)
 369 {
 370         MonoErrorInternal *error = (MonoErrorInternal*)oerror;
 371         mono_error_prepare (error);
 372
 373         error->error_code = MONO_ERROR_ARGUMENT;
 374         error->type_name = argument; /*use the first available string slot*/
 375
 376         set_error_message ();
 377 }
 378
 379 void
 380 mono_error_set_not_verifiable (MonoError *oerror, MonoMethod *method, const char *msg_format, ...)
 381 {
 382         MonoErrorInternal *error = (MonoErrorInternal*)oerror;
 383         mono_error_prepare (error);
 384
 385         error->error_code = MONO_ERROR_NOT_VERIFIABLE;
 386         mono_error_set_class (oerror, method->klass);
 387         if (method)
 388                 mono_error_set_member_name (oerror, mono_method_full_name (method, 1));
 389
 390         set_error_message ();
 391 }
 392
 393
 394 static MonoString*
 395 get_type_name_as_mono_string (MonoErrorInternal *error, MonoDomain *domain, MonoError *error_out)
 396 {
 397         MonoString* res = NULL;
 398
 399         if (error->type_name) {
 400                 res = mono_string_new (domain, error->type_name);
 401
 402         } else if (error->klass) {
 403                 char *name = mono_type_full_name (&error->klass->byval_arg);
 404                 if (name) {
 405                         res = mono_string_new (domain, name);
 406                         g_free (name);
 407                 }
 408         }
 409         if (!res)
 410                 mono_error_set_out_of_memory (error_out, "Could not allocate type name");
 411         return res;
 412 }
 413
 414 static void
 415 set_message_on_exception (MonoException *exception, MonoErrorInternal *error, MonoError *error_out)
 416 {
 417         MonoString *msg = mono_string_new (mono_domain_get (), mono_internal_error_get_message (error));
 418         if (msg)
 419                 MONO_OBJECT_SETREF (exception, message, msg);
 420         else
 421                 mono_error_set_out_of_memory (error_out, "Could not allocate exception object");
 422 }
 423
 424 /*Can fail with out-of-memory*/
 425 MonoException*
 426 mono_error_prepare_exception (MonoError *oerror, MonoError *error_out)
 427 {
 428         MonoErrorInternal *error = (MonoErrorInternal*)oerror;
 429
 430         MonoException* exception = NULL;
 431         MonoString *assembly_name = NULL, *type_name = NULL, *method_name = NULL, *field_name = NULL, *msg = NULL;
 432         MonoDomain *domain = mono_domain_get ();
 433
 434         mono_error_init (error_out);
 435
 436         switch (error->error_code) {
 437         case MONO_ERROR_NONE:
 438                 return NULL;
 439
 440         case MONO_ERROR_MISSING_METHOD:
 441                 if ((error->type_name || error->klass) && error->member_name) {
 442                         type_name = get_type_name_as_mono_string (error, domain, error_out);
 443                         if (!mono_error_ok (error_out))
 444                                 break;
 445
 446                         method_name = mono_string_new (domain, error->member_name);
 447                         if (!method_name) {
 448                                 mono_error_set_out_of_memory (error_out, "Could not allocate method name");
 449                                 break;
 450                         }
 451
 452                         exception = mono_exception_from_name_two_strings (mono_defaults.corlib, "System", "MissingMethodException", type_name, method_name);
 453                         if (exception)
 454                                 set_message_on_exception (exception, error, error_out);
 455                 } else {
 456                         exception = mono_exception_from_name_msg (mono_defaults.corlib, "System", "MissingMethodException", mono_internal_error_get_message (error));
 457                 }
 458                 break;
 459
 460         case MONO_ERROR_MISSING_FIELD:
 461                 if ((error->type_name || error->klass) && error->member_name) {
 462                         type_name = get_type_name_as_mono_string (error, domain, error_out);
 463                         if (!mono_error_ok (error_out))
 464                                 break;
 465
 466                         field_name = mono_string_new (domain, error->member_name);
 467                         if (!field_name) {
 468                                 mono_error_set_out_of_memory (error_out, "Could not allocate field name");
 469                                 break;
 470                         }
 471
 472                         exception = mono_exception_from_name_two_strings (mono_defaults.corlib, "System", "MissingFieldException", type_name, field_name);
 473                         if (exception)
 474                                 set_message_on_exception (exception, error, error_out);
 475                 } else {
 476                         exception = mono_exception_from_name_msg (mono_defaults.corlib, "System", "MissingFieldException", mono_internal_error_get_message (error));
 477                 }
 478                 break;
 479
 480         case MONO_ERROR_TYPE_LOAD:
 481                 if (error->type_name || error->assembly_name) {
 482                         type_name = get_type_name_as_mono_string (error, domain, error_out);
 483                         if (!mono_error_ok (error_out))
 484                                 break;
 485
 486                         if (error->assembly_name) {
 487                                 assembly_name = mono_string_new (domain, error->assembly_name);
 488                                 if (!assembly_name) {
 489                                         mono_error_set_out_of_memory (error_out, "Could not allocate assembly name");
 490                                         break;
 491                                 }
 492                         }
 493
 494                         exception = mono_exception_from_name_two_strings (mono_get_corlib (), "System", "TypeLoadException", type_name, assembly_name);
 495                         if (exception)
 496                                 set_message_on_exception (exception, error, error_out);
 497                 } else {
 498                         exception = mono_exception_from_name_msg (mono_defaults.corlib, "System", "TypeLoadException", mono_internal_error_get_message (error));
 499                 }
 500                 break;
 501
 502         case MONO_ERROR_FILE_NOT_FOUND:
 503         case MONO_ERROR_BAD_IMAGE:
 504                 if (error->assembly_name) {
 505                         msg = mono_string_new (domain, mono_internal_error_get_message (error));
 506                         if (!msg) {
 507                                 mono_error_set_out_of_memory (error_out, "Could not allocate message");
 508                                 break;
 509                         }
 510
 511                         if (error->assembly_name) {
 512                                 assembly_name = mono_string_new (domain, error->assembly_name);
 513                                 if (!assembly_name) {
 514                                         mono_error_set_out_of_memory (error_out, "Could not allocate assembly name");
 515                                         break;
 516                                 }
 517                         }
 518
 519                         if (error->error_code == MONO_ERROR_FILE_NOT_FOUND)
 520                                 exception = mono_exception_from_name_two_strings (mono_get_corlib (), "System.IO", "FileNotFoundException", msg, assembly_name);
 521                         else
 522                                 exception = mono_exception_from_name_two_strings (mono_defaults.corlib, "System", "BadImageFormatException", msg, assembly_name);
 523                 } else {
 524                         if (error->error_code == MONO_ERROR_FILE_NOT_FOUND)
 525                                 exception = mono_exception_from_name_msg (mono_get_corlib (), "System.IO", "FileNotFoundException", mono_internal_error_get_message (error));
 526                         else
 527                                 exception = mono_exception_from_name_msg (mono_defaults.corlib, "System", "BadImageFormatException", mono_internal_error_get_message (error));
 528                 }
 529                 break;
 530
 531         case MONO_ERROR_OUT_OF_MEMORY:
 532                 exception = mono_get_exception_out_of_memory ();
 533                 break;
 534
 535         case MONO_ERROR_ARGUMENT:
 536                 exception = mono_get_exception_argument (error->type_name, mono_internal_error_get_message (error));
 537                 break;
 538
 539         case MONO_ERROR_NOT_VERIFIABLE: {
 540                 char *type_name = NULL, *message;
 541                 if (error->klass) {
 542                         type_name = mono_type_get_full_name (error->klass);
 543                         if (!type_name) {
 544                                 mono_error_set_out_of_memory (error_out, "Could not allocate message");
 545                                 break;
 546                         }
 547                 }
 548                 message = g_strdup_printf ("Error in %s:%s %s", type_name, error->member_name, mono_internal_error_get_message (error));
 549                 if (!message) {
 550                         g_free (type_name);
 551                         mono_error_set_out_of_memory (error_out, "Could not allocate message");
 552                         break;
 553                 }
 554                 exception = mono_exception_from_name_msg (mono_defaults.corlib, "System.Security", "VerificationException", message);
 555                 g_free (message);
 556                 g_free (type_name);
 557                 break;
 558         }
 559         case MONO_ERROR_GENERIC:
 560                 if (!error->exception_name_space || !error->exception_name)
 561                         mono_error_set_generic_error (error_out, "System", "ExecutionEngineException", "MonoError with generic error but no exception name was supplied");
 562                 else
 563                         exception = mono_exception_from_name_msg (mono_defaults.corlib, error->exception_name_space, error->exception_name, mono_internal_error_get_message (error));
 564                 break;
 565
 566         default:
 567                 mono_error_set_generic_error (error_out, "System", "ExecutionEngineException", "Invalid error-code %d", error->error_code);
 568         }
 569
 570         if (!mono_error_ok (error_out))
 571                 return NULL;
 572         if (!exception)
 573                 mono_error_set_out_of_memory (error_out, "Could not allocate exception object");
 574         return exception;
 575 }
 576
 577 /*
 578 Raises the exception of @error.
 579 Does nothing if @error has a success error code.
 580 Aborts in case of a double fault. This happens when it can't recover from an error caused by trying
 581 to construct the first exception object.
 582 The error object @error is cleaned up.
 583 */
 584 void
 585 mono_error_raise_exception (MonoError *target_error)
 586 {
 587         MonoError error;
 588         MonoException *ex;
 589
 590         if (mono_error_ok (target_error))
 591                 return;
 592
 593         ex = mono_error_prepare_exception (target_error, &error);
 594         if (!mono_error_ok (&error)) {
 595                 MonoError second_chance;
 596                 /*Try to produce the exception for the second error. FIXME maybe we should log about the original one*/
 597                 ex = mono_error_prepare_exception (&error, &second_chance);
 598
 599                 g_assert (mono_error_ok (&second_chance)); /*We can't reasonable handle double faults, maybe later.*/
 600                 mono_error_cleanup (&error);
 601         }
 602         mono_error_cleanup (target_error);
 603
 604         mono_raise_exception (ex);
 605 }