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