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