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/class-internals.h>
15 #include <mono/metadata/debug-helpers.h>
17 #define mono_internal_error_get_message(E) ((E)->full_message ? (E)->full_message : (E)->message)
19 #define set_error_message() do { \
21 va_start (args, msg_format); \
22 if (g_vsnprintf (error->message, sizeof (error->message), msg_format, args) >= sizeof (error->message)) {\
24 va_start (args, msg_format); \
25 if (!(error->full_message = g_strdup_vprintf (msg_format, args))) \
26 error->flags |= MONO_ERROR_INCOMPLETE; \
32 mono_error_prepare (MonoErrorInternal *error)
34 if (error->error_code != MONO_ERROR_NONE)
37 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;
39 error->message [0] = 0;
43 get_type_name (MonoErrorInternal *error)
46 return error->type_name;
48 return error->klass->name;
49 return "<unknown type>";
53 get_assembly_name (MonoErrorInternal *error)
55 if (error->assembly_name)
56 return error->assembly_name;
57 if (error->klass && error->klass->image)
58 return error->klass->image->name;
59 return "<unknown assembly>";
63 mono_error_init_flags (MonoError *oerror, unsigned short flags)
65 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
66 g_assert (sizeof (MonoError) == sizeof (MonoErrorInternal));
68 error->error_code = MONO_ERROR_NONE;
73 mono_error_init (MonoError *error)
75 mono_error_init_flags (error, 0);
79 mono_error_cleanup (MonoError *oerror)
81 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
82 if (error->error_code == MONO_ERROR_NONE)
85 g_free ((char*)error->full_message);
86 g_free ((char*)error->full_message_with_fields);
87 if (!(error->flags & MONO_ERROR_FREE_STRINGS)) //no memory was allocated
90 g_free ((char*)error->type_name);
91 g_free ((char*)error->assembly_name);
92 g_free ((char*)error->member_name);
93 g_free ((char*)error->exception_name_space);
94 g_free ((char*)error->exception_name);
98 mono_error_ok (MonoError *error)
100 return error->error_code == MONO_ERROR_NONE;
104 mono_error_get_error_code (MonoError *error)
106 return error->error_code;
109 /*Return a pointer to the internal error message, might be NULL.
110 Caller should not release it.*/
112 mono_error_get_message (MonoError *oerror)
114 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
115 if (error->error_code == MONO_ERROR_NONE)
117 if (error->full_message_with_fields)
118 return error->full_message_with_fields;
120 error->full_message_with_fields = g_strdup_printf ("%s assembly:%s type:%s member:%s",
121 mono_internal_error_get_message (error),
122 get_assembly_name (error),
123 get_type_name (error),
124 error->member_name ? error->member_name : "<none>");
126 return error->full_message_with_fields ? error->full_message_with_fields : mono_internal_error_get_message (error);
130 * Inform that this error has heap allocated strings.
131 * The strings will be duplicated if @dup_strings is TRUE
132 * otherwise they will just be free'd in mono_error_cleanup.
135 mono_error_dup_strings (MonoError *oerror, gboolean dup_strings)
137 #define DUP_STR(field) do { if (error->field) {\
138 if (!(error->field = g_strdup (error->field))) \
139 error->flags |= MONO_ERROR_INCOMPLETE; \
142 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
143 error->flags |= MONO_ERROR_FREE_STRINGS;
147 DUP_STR (assembly_name);
148 DUP_STR (member_name);
149 DUP_STR (exception_name_space);
150 DUP_STR (exception_name);
156 mono_error_set_error (MonoError *oerror, int error_code, const char *msg_format, ...)
158 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
159 mono_error_prepare (error);
161 error->error_code = error_code;
162 set_error_message ();
166 mono_error_set_assembly_name (MonoError *oerror, const char *assembly_name)
168 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
169 g_assert (error->error_code != MONO_ERROR_NONE);
171 error->assembly_name = assembly_name;
175 mono_error_set_member_name (MonoError *oerror, const char *member_name)
177 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
179 error->member_name = member_name;
183 mono_error_set_type_name (MonoError *oerror, const char *type_name)
185 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
187 error->type_name = type_name;
191 mono_error_set_class (MonoError *oerror, MonoClass *klass)
193 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
195 error->klass = klass;
199 mono_error_set_corlib_exception (MonoError *oerror, const char *name_space, const char *name)
201 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
203 error->exception_name_space = name_space;
204 error->exception_name = name;
209 mono_error_set_assembly_load (MonoError *oerror, const char *assembly_name, const char *msg_format, ...)
211 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
212 mono_error_prepare (error);
214 error->error_code = MONO_ERROR_FILE_NOT_FOUND;
215 mono_error_set_assembly_name (oerror, assembly_name);
217 set_error_message ();
222 mono_error_set_assembly_load_simple (MonoError *oerror, const char *assembly_name, gboolean refection_only)
225 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.");
227 mono_error_set_assembly_load (oerror, assembly_name, "Could not load file or assembly or one of its dependencies.");
231 mono_error_set_type_load_class (MonoError *oerror, MonoClass *klass, const char *msg_format, ...)
233 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
234 mono_error_prepare (error);
236 error->error_code = MONO_ERROR_TYPE_LOAD;
237 mono_error_set_class (oerror, klass);
238 set_error_message ();
242 * Different than other functions, this one here assumes that type_name and assembly_name to have been allocated just for us.
243 * Which means mono_error_cleanup will free them.
246 mono_error_set_type_load_name (MonoError *oerror, const char *type_name, const char *assembly_name, const char *msg_format, ...)
248 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
249 mono_error_prepare (error);
251 error->error_code = MONO_ERROR_TYPE_LOAD;
252 mono_error_set_type_name (oerror, type_name);
253 mono_error_set_assembly_name (oerror, assembly_name);
254 mono_error_dup_strings (oerror, FALSE);
255 set_error_message ();
259 mono_error_set_method_load (MonoError *oerror, MonoClass *klass, const char *method_name, const char *msg_format, ...)
261 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
262 mono_error_prepare (error);
264 error->error_code = MONO_ERROR_MISSING_METHOD;
265 mono_error_set_class (oerror, klass);
266 mono_error_set_member_name (oerror, method_name);
267 set_error_message ();
271 mono_error_set_field_load (MonoError *oerror, MonoClass *klass, const char *field_name, const char *msg_format, ...)
273 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
274 mono_error_prepare (error);
276 error->error_code = MONO_ERROR_MISSING_FIELD;
277 mono_error_set_class (oerror, klass);
278 mono_error_set_member_name (oerror, field_name);
279 set_error_message ();
283 mono_error_set_bad_image_name (MonoError *oerror, const char *assembly_name, const char *msg_format, ...)
285 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
286 mono_error_prepare (error);
288 error->error_code = MONO_ERROR_BAD_IMAGE;
289 mono_error_set_assembly_name (oerror, assembly_name);
290 set_error_message ();
294 mono_error_set_bad_image (MonoError *oerror, MonoImage *image, const char *msg_format, ...)
296 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
297 mono_error_prepare (error);
299 error->error_code = MONO_ERROR_BAD_IMAGE;
300 error->assembly_name = image ? mono_image_get_name (image) : "<no_image>";
301 set_error_message ();
305 mono_error_set_generic_error (MonoError *oerror, const char * name_space, const char *name, const char *msg_format, ...)
307 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
308 mono_error_prepare (error);
310 error->error_code = MONO_ERROR_GENERIC;
311 mono_error_set_corlib_exception (oerror, name_space, name);
312 set_error_message ();
316 mono_error_set_from_loader_error (MonoError *oerror)
318 MonoLoaderError *loader_error = mono_loader_get_last_error ();
319 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
320 gboolean dup_strings = TRUE;
322 mono_error_prepare (error);
325 mono_error_set_generic_error (oerror, "System", "ExecutionEngineException", "Runtime tried to produce a mono-error from an empty loader-error");
329 switch (loader_error->exception_type) {
330 case MONO_EXCEPTION_NONE:
331 mono_error_set_generic_error (oerror, "System", "ExecutionEngineException", "Runtime tried to produce a mono-error from a non-error loader-error");
333 case MONO_EXCEPTION_SECURITY_LINKDEMAND:
334 case MONO_EXCEPTION_SECURITY_INHERITANCEDEMAND:
335 mono_error_set_generic_error (oerror, "System.Security", "SecurityException", "Failed for unknown reasons.");
338 case MONO_EXCEPTION_INVALID_PROGRAM:
339 mono_error_set_generic_error (oerror, "System", "InvalidProgramException", "Failed for unknown reasons.");
342 case MONO_EXCEPTION_UNVERIFIABLE_IL:
343 mono_error_set_generic_error (oerror, "System.Security", "VerificationException", "Failed for unknown reasons.");
346 case MONO_EXCEPTION_MISSING_METHOD:
347 error->error_code = MONO_ERROR_MISSING_METHOD;
348 mono_error_set_type_name (oerror, loader_error->class_name);
349 mono_error_set_member_name (oerror, loader_error->member_name);
350 g_snprintf (error->message, sizeof (error->message), "Failed for unknown reasons.");
353 case MONO_EXCEPTION_MISSING_FIELD:
354 mono_error_set_field_load (oerror, loader_error->klass, loader_error->member_name, "Failed for unknown reasons.");
357 case MONO_EXCEPTION_TYPE_LOAD:
358 mono_error_set_type_load_name (oerror, g_strdup (loader_error->class_name), g_strdup (loader_error->assembly_name), "Failed for unknown reasons.");
362 case MONO_EXCEPTION_FILE_NOT_FOUND:
363 mono_error_set_assembly_load_simple (oerror, loader_error->assembly_name, loader_error->ref_only);
366 case MONO_EXCEPTION_METHOD_ACCESS:
367 mono_error_set_generic_error (oerror, "System", "MethodAccessException", "Failed for unknown reasons.");
370 case MONO_EXCEPTION_FIELD_ACCESS:
371 mono_error_set_generic_error (oerror, "System", "FieldAccessException", "Failed for unknown reasons.");
374 case MONO_EXCEPTION_OBJECT_SUPPLIED:
375 case MONO_EXCEPTION_GENERIC_SHARING_FAILED:
376 mono_error_set_generic_error (oerror, "System", "ExecutionEngineException", "Runtime tried to produce a mono-error from JIT internal error %d", loader_error->exception_type);
379 case MONO_EXCEPTION_BAD_IMAGE:
380 mono_error_set_bad_image_name (oerror, "<unknown>", "%s", loader_error->msg);
383 case MONO_EXCEPTION_OUT_OF_MEMORY:
384 mono_error_set_out_of_memory (oerror, "Failed for unknown reasons.");
388 mono_error_set_generic_error (oerror, "System", "ExecutionEngineException", "Runtime tried to produce an unknown loader-error %d", loader_error->exception_type);
392 mono_error_dup_strings (oerror, dup_strings);
393 mono_loader_clear_error ();
397 mono_loader_set_error_from_mono_error (MonoError *oerror)
399 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
401 switch (error->error_code) {
402 case MONO_ERROR_MISSING_METHOD:
403 mono_loader_set_error_method_load (get_type_name (error), error->member_name);
405 case MONO_ERROR_MISSING_FIELD:
406 mono_loader_set_error_field_load (error->klass, error->member_name);
408 case MONO_ERROR_TYPE_LOAD:
409 mono_loader_set_error_type_load (get_type_name (error), get_assembly_name (error));
411 case MONO_ERROR_FILE_NOT_FOUND:
412 /* XXX can't recover if it's ref only or not */
413 mono_loader_set_error_assembly_load (get_assembly_name (error), FALSE);
415 case MONO_ERROR_BAD_IMAGE:
416 mono_loader_set_error_bad_image (g_strdup (mono_internal_error_get_message (error)));
419 mono_loader_set_error_bad_image (g_strdup_printf ("Non translatable error: %s", mono_internal_error_get_message (error)));
424 mono_error_set_out_of_memory (MonoError *oerror, const char *msg_format, ...)
426 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
428 mono_error_prepare (error);
430 error->error_code = MONO_ERROR_OUT_OF_MEMORY;
431 va_start (args, msg_format);
432 g_vsnprintf (error->message, sizeof (error->message), msg_format, args);
437 mono_error_set_argument (MonoError *oerror, const char *argument, const char *msg_format, ...)
439 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
440 mono_error_prepare (error);
442 error->error_code = MONO_ERROR_ARGUMENT;
443 error->type_name = argument; /*use the first available string slot*/
445 set_error_message ();
449 mono_error_set_not_verifiable (MonoError *oerror, MonoMethod *method, const char *msg_format, ...)
451 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
452 mono_error_prepare (error);
454 error->error_code = MONO_ERROR_NOT_VERIFIABLE;
456 mono_error_set_class (oerror, method->klass);
457 mono_error_set_member_name (oerror, mono_method_full_name (method, 1));
460 set_error_message ();
465 get_type_name_as_mono_string (MonoErrorInternal *error, MonoDomain *domain, MonoError *error_out)
467 MonoString* res = NULL;
469 if (error->type_name) {
470 res = mono_string_new (domain, error->type_name);
472 } else if (error->klass) {
473 char *name = mono_type_full_name (&error->klass->byval_arg);
475 res = mono_string_new (domain, name);
480 mono_error_set_out_of_memory (error_out, "Could not allocate type name");
485 set_message_on_exception (MonoException *exception, MonoErrorInternal *error, MonoError *error_out)
487 MonoString *msg = mono_string_new (mono_domain_get (), mono_internal_error_get_message (error));
489 MONO_OBJECT_SETREF (exception, message, msg);
491 mono_error_set_out_of_memory (error_out, "Could not allocate exception object");
494 /*Can fail with out-of-memory*/
496 mono_error_prepare_exception (MonoError *oerror, MonoError *error_out)
498 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
500 MonoException* exception = NULL;
501 MonoString *assembly_name = NULL, *type_name = NULL, *method_name = NULL, *field_name = NULL, *msg = NULL;
502 MonoDomain *domain = mono_domain_get ();
504 mono_error_init (error_out);
506 switch (error->error_code) {
507 case MONO_ERROR_NONE:
510 case MONO_ERROR_MISSING_METHOD:
511 if ((error->type_name || error->klass) && error->member_name) {
512 type_name = get_type_name_as_mono_string (error, domain, error_out);
513 if (!mono_error_ok (error_out))
516 method_name = mono_string_new (domain, error->member_name);
518 mono_error_set_out_of_memory (error_out, "Could not allocate method name");
522 exception = mono_exception_from_name_two_strings (mono_defaults.corlib, "System", "MissingMethodException", type_name, method_name);
524 set_message_on_exception (exception, error, error_out);
526 exception = mono_exception_from_name_msg (mono_defaults.corlib, "System", "MissingMethodException", mono_internal_error_get_message (error));
530 case MONO_ERROR_MISSING_FIELD:
531 if ((error->type_name || error->klass) && error->member_name) {
532 type_name = get_type_name_as_mono_string (error, domain, error_out);
533 if (!mono_error_ok (error_out))
536 field_name = mono_string_new (domain, error->member_name);
538 mono_error_set_out_of_memory (error_out, "Could not allocate field name");
542 exception = mono_exception_from_name_two_strings (mono_defaults.corlib, "System", "MissingFieldException", type_name, field_name);
544 set_message_on_exception (exception, error, error_out);
546 exception = mono_exception_from_name_msg (mono_defaults.corlib, "System", "MissingFieldException", mono_internal_error_get_message (error));
550 case MONO_ERROR_TYPE_LOAD:
551 if (error->type_name || error->assembly_name) {
552 type_name = get_type_name_as_mono_string (error, domain, error_out);
553 if (!mono_error_ok (error_out))
556 if (error->assembly_name) {
557 assembly_name = mono_string_new (domain, error->assembly_name);
558 if (!assembly_name) {
559 mono_error_set_out_of_memory (error_out, "Could not allocate assembly name");
564 exception = mono_exception_from_name_two_strings (mono_get_corlib (), "System", "TypeLoadException", type_name, assembly_name);
566 set_message_on_exception (exception, error, error_out);
568 exception = mono_exception_from_name_msg (mono_defaults.corlib, "System", "TypeLoadException", mono_internal_error_get_message (error));
572 case MONO_ERROR_FILE_NOT_FOUND:
573 case MONO_ERROR_BAD_IMAGE:
574 if (error->assembly_name) {
575 msg = mono_string_new (domain, mono_internal_error_get_message (error));
577 mono_error_set_out_of_memory (error_out, "Could not allocate message");
581 if (error->assembly_name) {
582 assembly_name = mono_string_new (domain, error->assembly_name);
583 if (!assembly_name) {
584 mono_error_set_out_of_memory (error_out, "Could not allocate assembly name");
589 if (error->error_code == MONO_ERROR_FILE_NOT_FOUND)
590 exception = mono_exception_from_name_two_strings (mono_get_corlib (), "System.IO", "FileNotFoundException", msg, assembly_name);
592 exception = mono_exception_from_name_two_strings (mono_defaults.corlib, "System", "BadImageFormatException", msg, assembly_name);
594 if (error->error_code == MONO_ERROR_FILE_NOT_FOUND)
595 exception = mono_exception_from_name_msg (mono_get_corlib (), "System.IO", "FileNotFoundException", mono_internal_error_get_message (error));
597 exception = mono_exception_from_name_msg (mono_defaults.corlib, "System", "BadImageFormatException", mono_internal_error_get_message (error));
601 case MONO_ERROR_OUT_OF_MEMORY:
602 exception = mono_get_exception_out_of_memory ();
605 case MONO_ERROR_ARGUMENT:
606 exception = mono_get_exception_argument (error->type_name, mono_internal_error_get_message (error));
609 case MONO_ERROR_NOT_VERIFIABLE: {
610 char *type_name = NULL, *message;
612 type_name = mono_type_get_full_name (error->klass);
614 mono_error_set_out_of_memory (error_out, "Could not allocate message");
618 message = g_strdup_printf ("Error in %s:%s %s", type_name, error->member_name, mono_internal_error_get_message (error));
621 mono_error_set_out_of_memory (error_out, "Could not allocate message");
624 exception = mono_exception_from_name_msg (mono_defaults.corlib, "System.Security", "VerificationException", message);
629 case MONO_ERROR_GENERIC:
630 if (!error->exception_name_space || !error->exception_name)
631 mono_error_set_generic_error (error_out, "System", "ExecutionEngineException", "MonoError with generic error but no exception name was supplied");
633 exception = mono_exception_from_name_msg (mono_defaults.corlib, error->exception_name_space, error->exception_name, mono_internal_error_get_message (error));
637 mono_error_set_generic_error (error_out, "System", "ExecutionEngineException", "Invalid error-code %d", error->error_code);
640 if (!mono_error_ok (error_out))
643 mono_error_set_out_of_memory (error_out, "Could not allocate exception object");
648 Convert this MonoError to an exception if it's faulty or return NULL.
649 The error object is cleant after.
653 mono_error_convert_to_exception (MonoError *target_error)
658 if (mono_error_ok (target_error))
661 ex = mono_error_prepare_exception (target_error, &error);
662 if (!mono_error_ok (&error)) {
663 MonoError second_chance;
664 /*Try to produce the exception for the second error. FIXME maybe we should log about the original one*/
665 ex = mono_error_prepare_exception (&error, &second_chance);
667 g_assert (mono_error_ok (&second_chance)); /*We can't reasonable handle double faults, maybe later.*/
668 mono_error_cleanup (&error);
670 mono_error_cleanup (target_error);