2 * mono-error.c: Error handling code
5 * Rodrigo Kumpera (rkumpera@novell.com)
6 * Copyright 2009 Novell, Inc (http://www.novell.com)
10 #include "mono-error.h"
11 #include "mono-error-internals.h"
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>
18 #define mono_internal_error_get_message(E) ((E)->full_message ? (E)->full_message : (E)->message)
20 #define set_error_message() do { \
22 va_start (args, msg_format); \
23 if (g_vsnprintf (error->message, sizeof (error->message), msg_format, args) >= sizeof (error->message)) {\
25 va_start (args, msg_format); \
26 if (!(error->full_message = g_strdup_vprintf (msg_format, args))) \
27 error->flags |= MONO_ERROR_INCOMPLETE; \
33 mono_error_prepare (MonoErrorInternal *error)
35 if (error->error_code != MONO_ERROR_NONE)
38 error->type_name = error->assembly_name = error->member_name = error->full_message = error->exception_name_space = error->exception_name = error->full_message_with_fields = NULL;
40 error->message [0] = 0;
44 get_type_name (MonoErrorInternal *error)
47 return error->type_name;
49 return error->klass->name;
50 return "<unknown type>";
54 get_assembly_name (MonoErrorInternal *error)
56 if (error->assembly_name)
57 return error->assembly_name;
58 if (error->klass && error->klass->image)
59 return error->klass->image->name;
60 return "<unknown assembly>";
64 mono_error_init_flags (MonoError *oerror, unsigned short flags)
66 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
67 g_assert (sizeof (MonoError) == sizeof (MonoErrorInternal));
69 error->error_code = MONO_ERROR_NONE;
74 mono_error_init (MonoError *error)
76 mono_error_init_flags (error, 0);
80 mono_error_cleanup (MonoError *oerror)
82 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
83 if (error->error_code == MONO_ERROR_NONE)
86 g_free ((char*)error->full_message);
87 g_free ((char*)error->full_message_with_fields);
88 if (!(error->flags & MONO_ERROR_FREE_STRINGS)) //no memory was allocated
91 g_free ((char*)error->type_name);
92 g_free ((char*)error->assembly_name);
93 g_free ((char*)error->member_name);
94 g_free ((char*)error->exception_name_space);
95 g_free ((char*)error->exception_name);
99 mono_error_ok (MonoError *error)
101 return error->error_code == MONO_ERROR_NONE;
105 mono_error_get_error_code (MonoError *error)
107 return error->error_code;
110 /*Return a pointer to the internal error message, might be NULL.
111 Caller should not release it.*/
113 mono_error_get_message (MonoError *oerror)
115 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
116 if (error->error_code == MONO_ERROR_NONE)
118 if (error->full_message_with_fields)
119 return error->full_message_with_fields;
121 error->full_message_with_fields = g_strdup_printf ("%s assembly:%s type:%s member:%s",
122 mono_internal_error_get_message (error),
123 get_assembly_name (error),
124 get_type_name (error),
125 error->member_name ? error->member_name : "<none>");
127 return error->full_message_with_fields ? error->full_message_with_fields : mono_internal_error_get_message (error);
131 * Inform that this error has heap allocated strings.
132 * The strings will be duplicated if @dup_strings is TRUE
133 * otherwise they will just be free'd in mono_error_cleanup.
136 mono_error_dup_strings (MonoError *oerror, gboolean dup_strings)
138 #define DUP_STR(field) do { if (error->field) {\
139 if (!(error->field = g_strdup (error->field))) \
140 error->flags |= MONO_ERROR_INCOMPLETE; \
143 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
144 error->flags |= MONO_ERROR_FREE_STRINGS;
148 DUP_STR (assembly_name);
149 DUP_STR (member_name);
150 DUP_STR (exception_name_space);
151 DUP_STR (exception_name);
157 mono_error_set_error (MonoError *oerror, int error_code, const char *msg_format, ...)
159 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
160 mono_error_prepare (error);
162 error->error_code = error_code;
163 set_error_message ();
167 mono_error_set_assembly_name (MonoError *oerror, const char *assembly_name)
169 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
170 g_assert (error->error_code != MONO_ERROR_NONE);
172 error->assembly_name = assembly_name;
176 mono_error_set_member_name (MonoError *oerror, const char *member_name)
178 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
180 error->member_name = member_name;
184 mono_error_set_type_name (MonoError *oerror, const char *type_name)
186 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
188 error->type_name = type_name;
192 mono_error_set_class (MonoError *oerror, MonoClass *klass)
194 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
196 error->klass = klass;
200 mono_error_set_corlib_exception (MonoError *oerror, const char *name_space, const char *name)
202 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
204 error->exception_name_space = name_space;
205 error->exception_name = name;
210 mono_error_set_assembly_load (MonoError *oerror, const char *assembly_name, const char *msg_format, ...)
212 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
213 mono_error_prepare (error);
215 error->error_code = MONO_ERROR_FILE_NOT_FOUND;
216 mono_error_set_assembly_name (oerror, assembly_name);
218 set_error_message ();
223 mono_error_set_assembly_load_simple (MonoError *oerror, const char *assembly_name, gboolean refection_only)
226 mono_error_set_assembly_load (oerror, 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.");
228 mono_error_set_assembly_load (oerror, assembly_name, "Could not load file or assembly or one of its dependencies.");
232 mono_error_set_type_load_class (MonoError *oerror, MonoClass *klass, const char *msg_format, ...)
234 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
235 mono_error_prepare (error);
237 error->error_code = MONO_ERROR_TYPE_LOAD;
238 mono_error_set_class (oerror, klass);
239 set_error_message ();
243 * Different than other functions, this one here assumes that type_name and assembly_name to have been allocated just for us.
244 * Which means mono_error_cleanup will free them.
247 mono_error_set_type_load_name (MonoError *oerror, const char *type_name, const char *assembly_name, const char *msg_format, ...)
249 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
250 mono_error_prepare (error);
252 error->error_code = MONO_ERROR_TYPE_LOAD;
253 mono_error_set_type_name (oerror, type_name);
254 mono_error_set_assembly_name (oerror, assembly_name);
255 mono_error_dup_strings (oerror, FALSE);
256 set_error_message ();
260 mono_error_set_method_load (MonoError *oerror, MonoClass *klass, const char *method_name, const char *msg_format, ...)
262 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
263 mono_error_prepare (error);
265 error->error_code = MONO_ERROR_MISSING_METHOD;
266 mono_error_set_class (oerror, klass);
267 mono_error_set_member_name (oerror, method_name);
268 set_error_message ();
272 mono_error_set_field_load (MonoError *oerror, MonoClass *klass, const char *field_name, const char *msg_format, ...)
274 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
275 mono_error_prepare (error);
277 error->error_code = MONO_ERROR_MISSING_FIELD;
278 mono_error_set_class (oerror, klass);
279 mono_error_set_member_name (oerror, field_name);
280 set_error_message ();
284 mono_error_set_bad_image_name (MonoError *oerror, const char *assembly_name, const char *msg_format, ...)
286 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
287 mono_error_prepare (error);
289 error->error_code = MONO_ERROR_BAD_IMAGE;
290 mono_error_set_assembly_name (oerror, assembly_name);
291 set_error_message ();
295 mono_error_set_bad_image (MonoError *oerror, MonoImage *image, const char *msg_format, ...)
297 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
298 mono_error_prepare (error);
300 error->error_code = MONO_ERROR_BAD_IMAGE;
301 error->assembly_name = image ? mono_image_get_name (image) : "<no_image>";
302 set_error_message ();
306 mono_error_set_generic_error (MonoError *oerror, const char * name_space, const char *name, const char *msg_format, ...)
308 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
309 mono_error_prepare (error);
311 error->error_code = MONO_ERROR_GENERIC;
312 mono_error_set_corlib_exception (oerror, name_space, name);
313 set_error_message ();
317 mono_error_set_from_loader_error (MonoError *oerror)
319 MonoLoaderError *loader_error = mono_loader_get_last_error ();
320 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
321 gboolean dup_strings = TRUE;
323 mono_error_prepare (error);
326 mono_error_set_generic_error (oerror, "System", "ExecutionEngineException", "Runtime tried to produce a mono-error from an empty loader-error");
330 switch (loader_error->exception_type) {
331 case MONO_EXCEPTION_NONE:
332 mono_error_set_generic_error (oerror, "System", "ExecutionEngineException", "Runtime tried to produce a mono-error from a non-error loader-error");
334 case MONO_EXCEPTION_SECURITY_LINKDEMAND:
335 case MONO_EXCEPTION_SECURITY_INHERITANCEDEMAND:
336 mono_error_set_generic_error (oerror, "System.Security", "SecurityException", "Failed for unknown reasons.");
339 case MONO_EXCEPTION_INVALID_PROGRAM:
340 mono_error_set_generic_error (oerror, "System", "InvalidProgramException", "Failed for unknown reasons.");
343 case MONO_EXCEPTION_UNVERIFIABLE_IL:
344 mono_error_set_generic_error (oerror, "System.Security", "VerificationException", "Failed for unknown reasons.");
347 case MONO_EXCEPTION_MISSING_METHOD:
348 error->error_code = MONO_ERROR_MISSING_METHOD;
349 mono_error_set_type_name (oerror, loader_error->class_name);
350 mono_error_set_member_name (oerror, loader_error->member_name);
351 g_snprintf (error->message, sizeof (error->message), "Failed for unknown reasons.");
354 case MONO_EXCEPTION_MISSING_FIELD:
355 mono_error_set_field_load (oerror, loader_error->klass, loader_error->member_name, "Failed for unknown reasons.");
358 case MONO_EXCEPTION_TYPE_LOAD:
359 mono_error_set_type_load_name (oerror, g_strdup (loader_error->class_name), g_strdup (loader_error->assembly_name), "Failed for unknown reasons.");
363 case MONO_EXCEPTION_FILE_NOT_FOUND:
364 mono_error_set_assembly_load_simple (oerror, loader_error->assembly_name, loader_error->ref_only);
367 case MONO_EXCEPTION_METHOD_ACCESS:
368 mono_error_set_generic_error (oerror, "System", "MethodAccessException", "Failed for unknown reasons.");
371 case MONO_EXCEPTION_FIELD_ACCESS:
372 mono_error_set_generic_error (oerror, "System", "FieldAccessException", "Failed for unknown reasons.");
375 case MONO_EXCEPTION_OBJECT_SUPPLIED:
376 case MONO_EXCEPTION_GENERIC_SHARING_FAILED:
377 mono_error_set_generic_error (oerror, "System", "ExecutionEngineException", "Runtime tried to produce a mono-error from JIT internal error %d", loader_error->exception_type);
380 case MONO_EXCEPTION_BAD_IMAGE:
381 mono_error_set_bad_image_name (oerror, "<unknown>", "%s", loader_error->msg);
384 case MONO_EXCEPTION_OUT_OF_MEMORY:
385 mono_error_set_out_of_memory (oerror, "Failed for unknown reasons.");
389 mono_error_set_generic_error (oerror, "System", "ExecutionEngineException", "Runtime tried to produce an unknown loader-error %d", loader_error->exception_type);
393 mono_error_dup_strings (oerror, dup_strings);
394 mono_loader_clear_error ();
398 mono_loader_set_error_from_mono_error (MonoError *oerror)
400 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
402 switch (error->error_code) {
403 case MONO_ERROR_MISSING_METHOD:
404 mono_loader_set_error_method_load (get_type_name (error), error->member_name);
406 case MONO_ERROR_MISSING_FIELD:
407 mono_loader_set_error_field_load (error->klass, error->member_name);
409 case MONO_ERROR_TYPE_LOAD:
410 mono_loader_set_error_type_load (get_type_name (error), get_assembly_name (error));
412 case MONO_ERROR_FILE_NOT_FOUND:
413 /* XXX can't recover if it's ref only or not */
414 mono_loader_set_error_assembly_load (get_assembly_name (error), FALSE);
416 case MONO_ERROR_BAD_IMAGE:
417 mono_loader_set_error_bad_image (g_strdup (mono_internal_error_get_message (error)));
420 mono_loader_set_error_bad_image (g_strdup_printf ("Non translatable error: %s", mono_internal_error_get_message (error)));
425 mono_error_set_out_of_memory (MonoError *oerror, const char *msg_format, ...)
427 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
429 mono_error_prepare (error);
431 error->error_code = MONO_ERROR_OUT_OF_MEMORY;
432 va_start (args, msg_format);
433 g_vsnprintf (error->message, sizeof (error->message), msg_format, args);
438 mono_error_set_argument (MonoError *oerror, const char *argument, const char *msg_format, ...)
440 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
441 mono_error_prepare (error);
443 error->error_code = MONO_ERROR_ARGUMENT;
444 error->type_name = argument; /*use the first available string slot*/
446 set_error_message ();
450 mono_error_set_not_verifiable (MonoError *oerror, MonoMethod *method, const char *msg_format, ...)
452 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
453 mono_error_prepare (error);
455 error->error_code = MONO_ERROR_NOT_VERIFIABLE;
457 mono_error_set_class (oerror, method->klass);
458 mono_error_set_member_name (oerror, mono_method_full_name (method, 1));
461 set_error_message ();
466 get_type_name_as_mono_string (MonoErrorInternal *error, MonoDomain *domain, MonoError *error_out)
468 MonoString* res = NULL;
470 if (error->type_name) {
471 res = mono_string_new (domain, error->type_name);
473 } else if (error->klass) {
474 char *name = mono_type_full_name (&error->klass->byval_arg);
476 res = mono_string_new (domain, name);
481 mono_error_set_out_of_memory (error_out, "Could not allocate type name");
486 set_message_on_exception (MonoException *exception, MonoErrorInternal *error, MonoError *error_out)
488 MonoString *msg = mono_string_new (mono_domain_get (), mono_internal_error_get_message (error));
490 MONO_OBJECT_SETREF (exception, message, msg);
492 mono_error_set_out_of_memory (error_out, "Could not allocate exception object");
495 /*Can fail with out-of-memory*/
497 mono_error_prepare_exception (MonoError *oerror, MonoError *error_out)
499 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
501 MonoException* exception = NULL;
502 MonoString *assembly_name = NULL, *type_name = NULL, *method_name = NULL, *field_name = NULL, *msg = NULL;
503 MonoDomain *domain = mono_domain_get ();
505 mono_error_init (error_out);
507 switch (error->error_code) {
508 case MONO_ERROR_NONE:
511 case MONO_ERROR_MISSING_METHOD:
512 if ((error->type_name || error->klass) && error->member_name) {
513 type_name = get_type_name_as_mono_string (error, domain, error_out);
514 if (!mono_error_ok (error_out))
517 method_name = mono_string_new (domain, error->member_name);
519 mono_error_set_out_of_memory (error_out, "Could not allocate method name");
523 exception = mono_exception_from_name_two_strings (mono_defaults.corlib, "System", "MissingMethodException", type_name, method_name);
525 set_message_on_exception (exception, error, error_out);
527 exception = mono_exception_from_name_msg (mono_defaults.corlib, "System", "MissingMethodException", mono_internal_error_get_message (error));
531 case MONO_ERROR_MISSING_FIELD:
532 if ((error->type_name || error->klass) && error->member_name) {
533 type_name = get_type_name_as_mono_string (error, domain, error_out);
534 if (!mono_error_ok (error_out))
537 field_name = mono_string_new (domain, error->member_name);
539 mono_error_set_out_of_memory (error_out, "Could not allocate field name");
543 exception = mono_exception_from_name_two_strings (mono_defaults.corlib, "System", "MissingFieldException", type_name, field_name);
545 set_message_on_exception (exception, error, error_out);
547 exception = mono_exception_from_name_msg (mono_defaults.corlib, "System", "MissingFieldException", mono_internal_error_get_message (error));
551 case MONO_ERROR_TYPE_LOAD:
552 if (error->type_name || error->assembly_name) {
553 type_name = get_type_name_as_mono_string (error, domain, error_out);
554 if (!mono_error_ok (error_out))
557 if (error->assembly_name) {
558 assembly_name = mono_string_new (domain, error->assembly_name);
559 if (!assembly_name) {
560 mono_error_set_out_of_memory (error_out, "Could not allocate assembly name");
565 exception = mono_exception_from_name_two_strings (mono_get_corlib (), "System", "TypeLoadException", type_name, assembly_name);
567 set_message_on_exception (exception, error, error_out);
569 exception = mono_exception_from_name_msg (mono_defaults.corlib, "System", "TypeLoadException", mono_internal_error_get_message (error));
573 case MONO_ERROR_FILE_NOT_FOUND:
574 case MONO_ERROR_BAD_IMAGE:
575 if (error->assembly_name) {
576 msg = mono_string_new (domain, mono_internal_error_get_message (error));
578 mono_error_set_out_of_memory (error_out, "Could not allocate message");
582 if (error->assembly_name) {
583 assembly_name = mono_string_new (domain, error->assembly_name);
584 if (!assembly_name) {
585 mono_error_set_out_of_memory (error_out, "Could not allocate assembly name");
590 if (error->error_code == MONO_ERROR_FILE_NOT_FOUND)
591 exception = mono_exception_from_name_two_strings (mono_get_corlib (), "System.IO", "FileNotFoundException", msg, assembly_name);
593 exception = mono_exception_from_name_two_strings (mono_defaults.corlib, "System", "BadImageFormatException", msg, assembly_name);
595 if (error->error_code == MONO_ERROR_FILE_NOT_FOUND)
596 exception = mono_exception_from_name_msg (mono_get_corlib (), "System.IO", "FileNotFoundException", mono_internal_error_get_message (error));
598 exception = mono_exception_from_name_msg (mono_defaults.corlib, "System", "BadImageFormatException", mono_internal_error_get_message (error));
602 case MONO_ERROR_OUT_OF_MEMORY:
603 exception = mono_get_exception_out_of_memory ();
606 case MONO_ERROR_ARGUMENT:
607 exception = mono_get_exception_argument (error->type_name, mono_internal_error_get_message (error));
610 case MONO_ERROR_NOT_VERIFIABLE: {
611 char *type_name = NULL, *message;
613 type_name = mono_type_get_full_name (error->klass);
615 mono_error_set_out_of_memory (error_out, "Could not allocate message");
619 message = g_strdup_printf ("Error in %s:%s %s", type_name, error->member_name, mono_internal_error_get_message (error));
622 mono_error_set_out_of_memory (error_out, "Could not allocate message");
625 exception = mono_exception_from_name_msg (mono_defaults.corlib, "System.Security", "VerificationException", message);
630 case MONO_ERROR_GENERIC:
631 if (!error->exception_name_space || !error->exception_name)
632 mono_error_set_generic_error (error_out, "System", "ExecutionEngineException", "MonoError with generic error but no exception name was supplied");
634 exception = mono_exception_from_name_msg (mono_defaults.corlib, error->exception_name_space, error->exception_name, mono_internal_error_get_message (error));
638 mono_error_set_generic_error (error_out, "System", "ExecutionEngineException", "Invalid error-code %d", error->error_code);
641 if (!mono_error_ok (error_out))
644 mono_error_set_out_of_memory (error_out, "Could not allocate exception object");
649 Convert this MonoError to an exception if it's faulty or return NULL.
650 The error object is cleant after.
654 mono_error_convert_to_exception (MonoError *target_error)
659 if (mono_error_ok (target_error))
662 ex = mono_error_prepare_exception (target_error, &error);
663 if (!mono_error_ok (&error)) {
664 MonoError second_chance;
665 /*Try to produce the exception for the second error. FIXME maybe we should log about the original one*/
666 ex = mono_error_prepare_exception (&error, &second_chance);
668 g_assert (mono_error_ok (&second_chance)); /*We can't reasonable handle double faults, maybe later.*/
669 mono_error_cleanup (&error);
671 mono_error_cleanup (target_error);
677 Raises the exception of @error.
678 Does nothing if @error has a success error code.
679 Aborts in case of a double fault. This happens when it can't recover from an error caused by trying
680 to construct the first exception object.
681 The error object @error is cleaned up.
684 mono_error_raise_exception (MonoError *target_error)
686 MonoException *ex = mono_error_convert_to_exception (target_error);
688 mono_raise_exception (ex);