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>
16 #include <mono/metadata/object.h>
17 #include <mono/metadata/object-internals.h>
19 #define set_error_message() do { \
21 va_start (args, msg_format); \
22 if (!(error->full_message = g_strdup_vprintf (msg_format, args))) \
23 error->flags |= MONO_ERROR_INCOMPLETE; \
28 is_managed_exception (MonoErrorInternal *error)
30 return (error->error_code == MONO_ERROR_EXCEPTION_INSTANCE);
34 mono_error_prepare (MonoErrorInternal *error)
36 if (error->error_code != MONO_ERROR_NONE)
39 error->type_name = error->assembly_name = error->member_name = error->full_message = error->exception_name_space = error->exception_name = error->full_message_with_fields = error->first_argument = NULL;
40 error->exn.klass = NULL;
44 get_class (MonoErrorInternal *error)
46 MonoClass *klass = NULL;
47 if (is_managed_exception (error))
48 klass = mono_object_class (mono_gchandle_get_target (error->exn.instance_handle));
50 klass = error->exn.klass;
55 get_type_name (MonoErrorInternal *error)
58 return error->type_name;
59 MonoClass *klass = get_class (error);
62 return "<unknown type>";
66 get_assembly_name (MonoErrorInternal *error)
68 if (error->assembly_name)
69 return error->assembly_name;
70 MonoClass *klass = get_class (error);
71 if (klass && klass->image)
72 return klass->image->name;
73 return "<unknown assembly>";
77 mono_error_init_flags (MonoError *oerror, unsigned short flags)
79 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
80 g_assert (sizeof (MonoError) == sizeof (MonoErrorInternal));
82 error->error_code = MONO_ERROR_NONE;
87 mono_error_init (MonoError *error)
89 mono_error_init_flags (error, 0);
93 mono_error_cleanup (MonoError *oerror)
95 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
96 if (error->error_code == MONO_ERROR_NONE)
99 if (is_managed_exception (error))
100 mono_gchandle_free (error->exn.instance_handle);
102 g_free ((char*)error->full_message);
103 g_free ((char*)error->full_message_with_fields);
104 if (!(error->flags & MONO_ERROR_FREE_STRINGS)) //no memory was allocated
107 g_free ((char*)error->type_name);
108 g_free ((char*)error->assembly_name);
109 g_free ((char*)error->member_name);
110 g_free ((char*)error->exception_name_space);
111 g_free ((char*)error->exception_name);
112 g_free ((char*)error->first_argument);
116 mono_error_ok (MonoError *error)
118 return error->error_code == MONO_ERROR_NONE;
122 mono_error_assert_ok (MonoError *error)
124 if (mono_error_ok (error))
127 g_error ("%s\n", mono_error_get_message (error));
131 mono_error_get_error_code (MonoError *error)
133 return error->error_code;
136 /*Return a pointer to the internal error message, might be NULL.
137 Caller should not release it.*/
139 mono_error_get_message (MonoError *oerror)
141 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
142 if (error->error_code == MONO_ERROR_NONE)
144 if (error->full_message_with_fields)
145 return error->full_message_with_fields;
147 error->full_message_with_fields = g_strdup_printf ("%s assembly:%s type:%s member:%s",
149 get_assembly_name (error),
150 get_type_name (error),
151 error->member_name ? error->member_name : "<none>");
153 return error->full_message_with_fields ? error->full_message_with_fields : error->full_message;
157 * Inform that this error has heap allocated strings.
158 * The strings will be duplicated if @dup_strings is TRUE
159 * otherwise they will just be free'd in mono_error_cleanup.
162 mono_error_dup_strings (MonoError *oerror, gboolean dup_strings)
164 #define DUP_STR(field) do { if (error->field) {\
165 if (!(error->field = g_strdup (error->field))) \
166 error->flags |= MONO_ERROR_INCOMPLETE; \
169 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
170 error->flags |= MONO_ERROR_FREE_STRINGS;
174 DUP_STR (assembly_name);
175 DUP_STR (member_name);
176 DUP_STR (exception_name_space);
177 DUP_STR (exception_name);
178 DUP_STR (first_argument);
184 mono_error_set_error (MonoError *oerror, int error_code, const char *msg_format, ...)
186 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
187 mono_error_prepare (error);
189 error->error_code = error_code;
190 set_error_message ();
194 mono_error_set_assembly_name (MonoError *oerror, const char *assembly_name)
196 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
197 g_assert (error->error_code != MONO_ERROR_NONE);
199 error->assembly_name = assembly_name;
203 mono_error_set_member_name (MonoError *oerror, const char *member_name)
205 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
207 error->member_name = member_name;
211 mono_error_set_type_name (MonoError *oerror, const char *type_name)
213 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
215 error->type_name = type_name;
219 mono_error_set_class (MonoError *oerror, MonoClass *klass)
221 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
223 if (is_managed_exception (error))
225 error->exn.klass = klass;
229 mono_error_set_corlib_exception (MonoError *oerror, const char *name_space, const char *name)
231 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
233 error->exception_name_space = name_space;
234 error->exception_name = name;
239 mono_error_set_assembly_load (MonoError *oerror, const char *assembly_name, const char *msg_format, ...)
241 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
242 mono_error_prepare (error);
244 error->error_code = MONO_ERROR_FILE_NOT_FOUND;
245 mono_error_set_assembly_name (oerror, assembly_name);
247 set_error_message ();
252 mono_error_set_assembly_load_simple (MonoError *oerror, const char *assembly_name, gboolean refection_only)
255 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.");
257 mono_error_set_assembly_load (oerror, assembly_name, "Could not load file or assembly or one of its dependencies.");
261 mono_error_set_type_load_class (MonoError *oerror, MonoClass *klass, const char *msg_format, ...)
263 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
264 mono_error_prepare (error);
266 error->error_code = MONO_ERROR_TYPE_LOAD;
267 mono_error_set_class (oerror, klass);
268 set_error_message ();
272 * Different than other functions, this one here assumes that type_name and assembly_name to have been allocated just for us.
273 * Which means mono_error_cleanup will free them.
276 mono_error_set_type_load_name (MonoError *oerror, const char *type_name, const char *assembly_name, const char *msg_format, ...)
278 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
279 mono_error_prepare (error);
281 error->error_code = MONO_ERROR_TYPE_LOAD;
282 mono_error_set_type_name (oerror, type_name);
283 mono_error_set_assembly_name (oerror, assembly_name);
284 mono_error_dup_strings (oerror, FALSE);
285 set_error_message ();
289 mono_error_set_method_load (MonoError *oerror, MonoClass *klass, const char *method_name, const char *msg_format, ...)
291 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
292 mono_error_prepare (error);
294 error->error_code = MONO_ERROR_MISSING_METHOD;
295 mono_error_set_class (oerror, klass);
296 mono_error_set_member_name (oerror, method_name);
297 set_error_message ();
301 mono_error_set_field_load (MonoError *oerror, MonoClass *klass, const char *field_name, const char *msg_format, ...)
303 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
304 mono_error_prepare (error);
306 error->error_code = MONO_ERROR_MISSING_FIELD;
307 mono_error_set_class (oerror, klass);
308 mono_error_set_member_name (oerror, field_name);
309 set_error_message ();
313 mono_error_set_bad_image_name (MonoError *oerror, const char *assembly_name, const char *msg_format, ...)
315 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
316 mono_error_prepare (error);
318 error->error_code = MONO_ERROR_BAD_IMAGE;
319 mono_error_set_assembly_name (oerror, assembly_name);
320 set_error_message ();
324 mono_error_set_bad_image (MonoError *oerror, MonoImage *image, const char *msg_format, ...)
326 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
327 mono_error_prepare (error);
329 error->error_code = MONO_ERROR_BAD_IMAGE;
330 error->assembly_name = image ? mono_image_get_name (image) : "<no_image>";
331 set_error_message ();
335 mono_error_set_generic_error (MonoError *oerror, const char * name_space, const char *name, const char *msg_format, ...)
337 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
338 mono_error_prepare (error);
340 error->error_code = MONO_ERROR_GENERIC;
341 mono_error_set_corlib_exception (oerror, name_space, name);
342 set_error_message ();
346 mono_error_set_exception_instance (MonoError *oerror, MonoException *exc)
348 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
350 error->error_code = MONO_ERROR_EXCEPTION_INSTANCE;
351 error->exn.instance_handle = mono_gchandle_new (exc ? &exc->object : NULL, FALSE);
355 mono_error_set_from_loader_error (MonoError *oerror)
357 MonoLoaderError *loader_error = mono_loader_get_last_error ();
358 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
359 gboolean dup_strings = TRUE;
361 mono_error_prepare (error);
364 mono_error_set_generic_error (oerror, "System", "ExecutionEngineException", "Runtime tried to produce a mono-error from an empty loader-error");
368 switch (loader_error->exception_type) {
369 case MONO_EXCEPTION_NONE:
370 mono_error_set_generic_error (oerror, "System", "ExecutionEngineException", "Runtime tried to produce a mono-error from a non-error loader-error");
373 case MONO_EXCEPTION_INVALID_PROGRAM:
374 mono_error_set_generic_error (oerror, "System", "InvalidProgramException", "Failed for unknown reasons.");
377 case MONO_EXCEPTION_UNVERIFIABLE_IL:
378 mono_error_set_generic_error (oerror, "System.Security", "VerificationException", "Failed for unknown reasons.");
381 case MONO_EXCEPTION_MISSING_METHOD:
382 error->error_code = MONO_ERROR_MISSING_METHOD;
383 mono_error_set_type_name (oerror, loader_error->class_name);
384 mono_error_set_member_name (oerror, loader_error->member_name);
385 error->full_message = g_strdup ("Failed for unknown reasons.");
388 case MONO_EXCEPTION_MISSING_FIELD:
389 mono_error_set_field_load (oerror, loader_error->klass, loader_error->member_name, "Failed for unknown reasons.");
392 case MONO_EXCEPTION_TYPE_LOAD:
393 mono_error_set_type_load_name (oerror, g_strdup (loader_error->class_name), g_strdup (loader_error->assembly_name), "Failed for unknown reasons.");
397 case MONO_EXCEPTION_FILE_NOT_FOUND:
398 mono_error_set_assembly_load_simple (oerror, loader_error->assembly_name, loader_error->ref_only);
401 case MONO_EXCEPTION_METHOD_ACCESS:
402 mono_error_set_generic_error (oerror, "System", "MethodAccessException", "Failed for unknown reasons.");
405 case MONO_EXCEPTION_FIELD_ACCESS:
406 mono_error_set_generic_error (oerror, "System", "FieldAccessException", "Failed for unknown reasons.");
409 case MONO_EXCEPTION_OBJECT_SUPPLIED:
410 case MONO_EXCEPTION_GENERIC_SHARING_FAILED:
411 mono_error_set_generic_error (oerror, "System", "ExecutionEngineException", "Runtime tried to produce a mono-error from JIT internal error %d", loader_error->exception_type);
414 case MONO_EXCEPTION_BAD_IMAGE:
415 mono_error_set_bad_image_name (oerror, "<unknown>", "%s", loader_error->msg);
418 case MONO_EXCEPTION_OUT_OF_MEMORY:
419 mono_error_set_out_of_memory (oerror, "Failed for unknown reasons.");
423 mono_error_set_generic_error (oerror, "System", "ExecutionEngineException", "Runtime tried to produce an unknown loader-error %d", loader_error->exception_type);
427 mono_error_dup_strings (oerror, dup_strings);
428 mono_loader_clear_error ();
432 mono_loader_set_error_from_mono_error (MonoError *oerror)
434 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
436 switch (error->error_code) {
437 case MONO_ERROR_MISSING_METHOD:
438 mono_loader_set_error_method_load (get_type_name (error), error->member_name);
440 case MONO_ERROR_MISSING_FIELD:
441 mono_loader_set_error_field_load (error->exn.klass, error->member_name);
443 case MONO_ERROR_TYPE_LOAD:
444 mono_loader_set_error_type_load (get_type_name (error), get_assembly_name (error));
446 case MONO_ERROR_FILE_NOT_FOUND:
447 /* XXX can't recover if it's ref only or not */
448 mono_loader_set_error_assembly_load (get_assembly_name (error), FALSE);
450 case MONO_ERROR_BAD_IMAGE:
451 mono_loader_set_error_bad_image (g_strdup (error->full_message));
453 case MONO_ERROR_EXCEPTION_INSTANCE:
454 mono_loader_set_error_bad_image (g_strdup_printf ("Non translatable error"));
456 mono_loader_set_error_bad_image (g_strdup_printf ("Non translatable error: %s", error->full_message));
461 mono_error_set_out_of_memory (MonoError *oerror, const char *msg_format, ...)
463 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
464 mono_error_prepare (error);
466 error->error_code = MONO_ERROR_OUT_OF_MEMORY;
468 set_error_message ();
472 mono_error_set_argument (MonoError *oerror, const char *argument, const char *msg_format, ...)
474 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
475 mono_error_prepare (error);
477 error->error_code = MONO_ERROR_ARGUMENT;
478 error->first_argument = argument;
480 set_error_message ();
484 mono_error_set_not_verifiable (MonoError *oerror, MonoMethod *method, const char *msg_format, ...)
486 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
487 mono_error_prepare (error);
489 error->error_code = MONO_ERROR_NOT_VERIFIABLE;
491 mono_error_set_class (oerror, method->klass);
492 mono_error_set_member_name (oerror, mono_method_full_name (method, 1));
495 set_error_message ();
500 get_type_name_as_mono_string (MonoErrorInternal *error, MonoDomain *domain, MonoError *error_out)
502 MonoString* res = NULL;
504 if (error->type_name) {
505 res = mono_string_new (domain, error->type_name);
508 MonoClass *klass = get_class (error);
510 char *name = mono_type_full_name (&klass->byval_arg);
512 res = mono_string_new (domain, name);
518 mono_error_set_out_of_memory (error_out, "Could not allocate type name");
523 set_message_on_exception (MonoException *exception, MonoErrorInternal *error, MonoError *error_out)
525 MonoString *msg = mono_string_new (mono_domain_get (), error->full_message);
527 MONO_OBJECT_SETREF (exception, message, msg);
529 mono_error_set_out_of_memory (error_out, "Could not allocate exception object");
532 /*Can fail with out-of-memory*/
534 mono_error_prepare_exception (MonoError *oerror, MonoError *error_out)
536 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
538 MonoException* exception = NULL;
539 MonoString *assembly_name = NULL, *type_name = NULL, *method_name = NULL, *field_name = NULL, *msg = NULL;
540 MonoDomain *domain = mono_domain_get ();
542 mono_error_init (error_out);
544 switch (error->error_code) {
545 case MONO_ERROR_NONE:
548 case MONO_ERROR_MISSING_METHOD:
549 if ((error->type_name || error->exn.klass) && error->member_name) {
550 type_name = get_type_name_as_mono_string (error, domain, error_out);
551 if (!mono_error_ok (error_out))
554 method_name = mono_string_new (domain, error->member_name);
556 mono_error_set_out_of_memory (error_out, "Could not allocate method name");
560 exception = mono_exception_from_name_two_strings (mono_defaults.corlib, "System", "MissingMethodException", type_name, method_name);
562 set_message_on_exception (exception, error, error_out);
564 exception = mono_exception_from_name_msg (mono_defaults.corlib, "System", "MissingMethodException", error->full_message);
568 case MONO_ERROR_MISSING_FIELD:
569 if ((error->type_name || error->exn.klass) && error->member_name) {
570 type_name = get_type_name_as_mono_string (error, domain, error_out);
571 if (!mono_error_ok (error_out))
574 field_name = mono_string_new (domain, error->member_name);
576 mono_error_set_out_of_memory (error_out, "Could not allocate field name");
580 exception = mono_exception_from_name_two_strings (mono_defaults.corlib, "System", "MissingFieldException", type_name, field_name);
582 set_message_on_exception (exception, error, error_out);
584 exception = mono_exception_from_name_msg (mono_defaults.corlib, "System", "MissingFieldException", error->full_message);
588 case MONO_ERROR_TYPE_LOAD:
589 if (error->type_name || error->assembly_name) {
590 type_name = get_type_name_as_mono_string (error, domain, error_out);
591 if (!mono_error_ok (error_out))
594 if (error->assembly_name) {
595 assembly_name = mono_string_new (domain, error->assembly_name);
596 if (!assembly_name) {
597 mono_error_set_out_of_memory (error_out, "Could not allocate assembly name");
602 exception = mono_exception_from_name_two_strings (mono_get_corlib (), "System", "TypeLoadException", type_name, assembly_name);
604 set_message_on_exception (exception, error, error_out);
606 exception = mono_exception_from_name_msg (mono_defaults.corlib, "System", "TypeLoadException", error->full_message);
610 case MONO_ERROR_FILE_NOT_FOUND:
611 case MONO_ERROR_BAD_IMAGE:
612 if (error->assembly_name) {
613 msg = mono_string_new (domain, error->full_message);
615 mono_error_set_out_of_memory (error_out, "Could not allocate message");
619 if (error->assembly_name) {
620 assembly_name = mono_string_new (domain, error->assembly_name);
621 if (!assembly_name) {
622 mono_error_set_out_of_memory (error_out, "Could not allocate assembly name");
627 if (error->error_code == MONO_ERROR_FILE_NOT_FOUND)
628 exception = mono_exception_from_name_two_strings (mono_get_corlib (), "System.IO", "FileNotFoundException", msg, assembly_name);
630 exception = mono_exception_from_name_two_strings (mono_defaults.corlib, "System", "BadImageFormatException", msg, assembly_name);
632 if (error->error_code == MONO_ERROR_FILE_NOT_FOUND)
633 exception = mono_exception_from_name_msg (mono_get_corlib (), "System.IO", "FileNotFoundException", error->full_message);
635 exception = mono_exception_from_name_msg (mono_defaults.corlib, "System", "BadImageFormatException", error->full_message);
639 case MONO_ERROR_OUT_OF_MEMORY:
640 exception = mono_get_exception_out_of_memory ();
643 case MONO_ERROR_ARGUMENT:
644 exception = mono_get_exception_argument (error->first_argument, error->full_message);
647 case MONO_ERROR_NOT_VERIFIABLE: {
648 char *type_name = NULL, *message;
649 if (error->exn.klass) {
650 type_name = mono_type_get_full_name (error->exn.klass);
652 mono_error_set_out_of_memory (error_out, "Could not allocate message");
656 message = g_strdup_printf ("Error in %s:%s %s", type_name, error->member_name, error->full_message);
659 mono_error_set_out_of_memory (error_out, "Could not allocate message");
662 exception = mono_exception_from_name_msg (mono_defaults.corlib, "System.Security", "VerificationException", message);
667 case MONO_ERROR_GENERIC:
668 if (!error->exception_name_space || !error->exception_name)
669 mono_error_set_generic_error (error_out, "System", "ExecutionEngineException", "MonoError with generic error but no exception name was supplied");
671 exception = mono_exception_from_name_msg (mono_defaults.corlib, error->exception_name_space, error->exception_name, error->full_message);
674 case MONO_ERROR_EXCEPTION_INSTANCE:
675 exception = (MonoException*) mono_gchandle_get_target (error->exn.instance_handle);
679 mono_error_set_generic_error (error_out, "System", "ExecutionEngineException", "Invalid error-code %d", error->error_code);
682 if (!mono_error_ok (error_out))
685 mono_error_set_out_of_memory (error_out, "Could not allocate exception object");
690 Convert this MonoError to an exception if it's faulty or return NULL.
691 The error object is cleant after.
695 mono_error_convert_to_exception (MonoError *target_error)
700 if (mono_error_ok (target_error))
703 ex = mono_error_prepare_exception (target_error, &error);
704 if (!mono_error_ok (&error)) {
705 MonoError second_chance;
706 /*Try to produce the exception for the second error. FIXME maybe we should log about the original one*/
707 ex = mono_error_prepare_exception (&error, &second_chance);
709 g_assert (mono_error_ok (&second_chance)); /*We can't reasonable handle double faults, maybe later.*/
710 mono_error_cleanup (&error);
712 mono_error_cleanup (target_error);