2 * mono-error.c: Error handling code
5 * Rodrigo Kumpera (rkumpera@novell.com)
6 * Copyright 2009 Novell, Inc (http://www.novell.com)
7 * Licensed under the MIT license. See LICENSE file in the project root for full license information.
11 #include "mono-error.h"
12 #include "mono-error-internals.h"
14 #include <mono/metadata/exception.h>
15 #include <mono/metadata/debug-helpers.h>
16 #include <mono/metadata/object-internals.h>
18 #define set_error_messagev() do { \
19 if (!(error->full_message = g_strdup_vprintf (msg_format, args))) \
20 error->flags |= MONO_ERROR_INCOMPLETE; \
23 #define set_error_message() do { \
25 va_start (args, msg_format); \
26 set_error_messagev(); \
31 mono_error_set_generic_errorv (MonoError *oerror, const char *name_space, const char *name, const char *msg_format, va_list args);
34 is_managed_exception (MonoErrorInternal *error)
36 return (error->error_code == MONO_ERROR_EXCEPTION_INSTANCE);
40 mono_error_prepare (MonoErrorInternal *error)
42 /* mono_error_set_* after a mono_error_cleanup without an intervening init */
43 g_assert (error->error_code != MONO_ERROR_CLEANUP_CALLED_SENTINEL);
44 if (error->error_code != MONO_ERROR_NONE)
47 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;
48 error->exn.klass = NULL;
52 get_class (MonoErrorInternal *error)
54 MonoClass *klass = NULL;
55 if (is_managed_exception (error))
56 klass = mono_object_class (mono_gchandle_get_target (error->exn.instance_handle));
58 klass = error->exn.klass;
63 get_type_name (MonoErrorInternal *error)
66 return error->type_name;
67 MonoClass *klass = get_class (error);
70 return "<unknown type>";
74 get_assembly_name (MonoErrorInternal *error)
76 if (error->assembly_name)
77 return error->assembly_name;
78 MonoClass *klass = get_class (error);
79 if (klass && klass->image)
80 return klass->image->name;
81 return "<unknown assembly>";
85 mono_error_init_flags (MonoError *oerror, unsigned short flags)
87 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
88 g_assert (sizeof (MonoError) == sizeof (MonoErrorInternal));
90 error->error_code = MONO_ERROR_NONE;
96 * @error: Pointer to MonoError struct to initialize
98 * Any function which takes a MonoError for purposes of reporting an error
99 * is required to call either this or mono_error_init_flags on entry.
102 mono_error_init (MonoError *error)
104 mono_error_init_flags (error, 0);
108 mono_error_cleanup (MonoError *oerror)
110 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
111 short int orig_error_code = error->error_code;
112 gboolean free_strings = error->flags & MONO_ERROR_FREE_STRINGS;
113 gboolean has_instance_handle = is_managed_exception (error);
115 /* Two cleanups in a row without an intervening init. */
116 g_assert (orig_error_code != MONO_ERROR_CLEANUP_CALLED_SENTINEL);
118 /* Mark it as cleaned up. */
119 error->error_code = MONO_ERROR_CLEANUP_CALLED_SENTINEL;
122 if (orig_error_code == MONO_ERROR_NONE)
126 if (has_instance_handle)
127 mono_gchandle_free (error->exn.instance_handle);
130 g_free ((char*)error->full_message);
131 g_free ((char*)error->full_message_with_fields);
132 error->full_message = NULL;
133 error->full_message_with_fields = NULL;
134 if (!free_strings) //no memory was allocated
137 g_free ((char*)error->type_name);
138 g_free ((char*)error->assembly_name);
139 g_free ((char*)error->member_name);
140 g_free ((char*)error->exception_name_space);
141 g_free ((char*)error->exception_name);
142 g_free ((char*)error->first_argument);
143 error->type_name = error->assembly_name = error->member_name = error->exception_name_space = error->exception_name = error->first_argument = NULL;
144 error->exn.klass = NULL;
149 mono_error_ok (MonoError *error)
151 return error->error_code == MONO_ERROR_NONE;
155 mono_error_assert_ok_pos (MonoError *error, const char* filename, int lineno)
157 if (mono_error_ok (error))
160 g_error ("%s:%d: %s\n", filename, lineno, mono_error_get_message (error));
164 mono_error_get_error_code (MonoError *error)
166 return error->error_code;
169 /*Return a pointer to the internal error message, might be NULL.
170 Caller should not release it.*/
172 mono_error_get_message (MonoError *oerror)
174 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
175 if (error->error_code == MONO_ERROR_NONE)
177 if (error->full_message_with_fields)
178 return error->full_message_with_fields;
180 error->full_message_with_fields = g_strdup_printf ("%s assembly:%s type:%s member:%s",
182 get_assembly_name (error),
183 get_type_name (error),
184 error->member_name ? error->member_name : "<none>");
186 return error->full_message_with_fields ? error->full_message_with_fields : error->full_message;
190 * Inform that this error has heap allocated strings.
191 * The strings will be duplicated if @dup_strings is TRUE
192 * otherwise they will just be free'd in mono_error_cleanup.
195 mono_error_dup_strings (MonoError *oerror, gboolean dup_strings)
197 #define DUP_STR(field) do { if (error->field) {\
198 if (!(error->field = g_strdup (error->field))) \
199 error->flags |= MONO_ERROR_INCOMPLETE; \
202 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
203 error->flags |= MONO_ERROR_FREE_STRINGS;
207 DUP_STR (assembly_name);
208 DUP_STR (member_name);
209 DUP_STR (exception_name_space);
210 DUP_STR (exception_name);
211 DUP_STR (first_argument);
217 mono_error_set_error (MonoError *oerror, int error_code, const char *msg_format, ...)
219 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
220 mono_error_prepare (error);
222 error->error_code = error_code;
223 set_error_message ();
227 mono_error_set_assembly_name (MonoError *oerror, const char *assembly_name)
229 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
230 g_assert (error->error_code != MONO_ERROR_NONE);
232 error->assembly_name = assembly_name;
236 mono_error_set_member_name (MonoError *oerror, const char *member_name)
238 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
240 error->member_name = member_name;
244 mono_error_set_type_name (MonoError *oerror, const char *type_name)
246 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
248 error->type_name = type_name;
252 mono_error_set_class (MonoError *oerror, MonoClass *klass)
254 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
256 if (is_managed_exception (error))
258 error->exn.klass = klass;
262 mono_error_set_corlib_exception (MonoError *oerror, const char *name_space, const char *name)
264 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
266 error->exception_name_space = name_space;
267 error->exception_name = name;
272 mono_error_set_assembly_load (MonoError *oerror, const char *assembly_name, const char *msg_format, ...)
274 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
275 mono_error_prepare (error);
277 error->error_code = MONO_ERROR_FILE_NOT_FOUND;
278 mono_error_set_assembly_name (oerror, assembly_name);
280 set_error_message ();
285 mono_error_set_assembly_load_simple (MonoError *oerror, const char *assembly_name, gboolean refection_only)
288 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.");
290 mono_error_set_assembly_load (oerror, assembly_name, "Could not load file or assembly or one of its dependencies.");
294 mono_error_set_type_load_class (MonoError *oerror, MonoClass *klass, const char *msg_format, ...)
296 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
297 mono_error_prepare (error);
299 error->error_code = MONO_ERROR_TYPE_LOAD;
300 mono_error_set_class (oerror, klass);
301 set_error_message ();
305 * Different than other functions, this one here assumes that type_name and assembly_name to have been allocated just for us.
306 * Which means mono_error_cleanup will free them.
309 mono_error_set_type_load_name (MonoError *oerror, const char *type_name, const char *assembly_name, const char *msg_format, ...)
311 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
312 mono_error_prepare (error);
314 error->error_code = MONO_ERROR_TYPE_LOAD;
315 mono_error_set_type_name (oerror, type_name);
316 mono_error_set_assembly_name (oerror, assembly_name);
317 mono_error_dup_strings (oerror, FALSE);
318 set_error_message ();
322 mono_error_set_method_load (MonoError *oerror, MonoClass *klass, const char *method_name, const char *msg_format, ...)
324 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
325 mono_error_prepare (error);
327 error->error_code = MONO_ERROR_MISSING_METHOD;
328 mono_error_set_class (oerror, klass);
329 mono_error_set_member_name (oerror, method_name);
330 set_error_message ();
334 mono_error_set_field_load (MonoError *oerror, MonoClass *klass, const char *field_name, const char *msg_format, ...)
336 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
337 mono_error_prepare (error);
339 error->error_code = MONO_ERROR_MISSING_FIELD;
340 mono_error_set_class (oerror, klass);
341 mono_error_set_member_name (oerror, field_name);
342 set_error_message ();
346 mono_error_set_bad_image_name (MonoError *oerror, const char *assembly_name, const char *msg_format, ...)
348 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
349 mono_error_prepare (error);
351 error->error_code = MONO_ERROR_BAD_IMAGE;
352 mono_error_set_assembly_name (oerror, assembly_name);
353 set_error_message ();
357 mono_error_set_bad_image (MonoError *oerror, MonoImage *image, const char *msg_format, ...)
359 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
360 mono_error_prepare (error);
362 error->error_code = MONO_ERROR_BAD_IMAGE;
363 error->assembly_name = image ? mono_image_get_name (image) : "<no_image>";
364 set_error_message ();
368 mono_error_set_generic_errorv (MonoError *oerror, const char *name_space, const char *name, const char *msg_format, va_list args)
370 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
371 mono_error_prepare (error);
373 error->error_code = MONO_ERROR_GENERIC;
374 mono_error_set_corlib_exception (oerror, name_space, name);
375 set_error_messagev ();
379 mono_error_set_generic_error (MonoError *oerror, const char * name_space, const char *name, const char *msg_format, ...)
382 va_start (args, msg_format);
383 mono_error_set_generic_errorv (oerror, name_space, name, msg_format, args);
388 * mono_error_set_not_implemented:
390 * System.NotImplementedException
393 mono_error_set_not_implemented (MonoError *oerror, const char *msg_format, ...)
396 va_start (args, msg_format);
397 mono_error_set_generic_errorv (oerror, "System", "NotImplementedException", msg_format, args);
402 * mono_error_set_execution_engine:
404 * System.ExecutionEngineException
407 mono_error_set_execution_engine (MonoError *oerror, const char *msg_format, ...)
410 va_start (args, msg_format);
411 mono_error_set_generic_errorv (oerror, "System", "ExecutionEngineException", msg_format, args);
416 * mono_error_set_not_supported:
418 * System.NotSupportedException
421 mono_error_set_not_supported (MonoError *oerror, const char *msg_format, ...)
424 va_start (args, msg_format);
425 mono_error_set_generic_errorv (oerror, "System", "NotSupportedException", msg_format, args);
430 * mono_error_set_invalid_operation:
432 * System.InvalidOperationException
435 mono_error_set_invalid_operation (MonoError *oerror, const char *msg_format, ...)
438 va_start (args, msg_format);
439 mono_error_set_generic_errorv (oerror, "System", "InvalidOperationException", msg_format, args);
444 mono_error_set_invalid_program (MonoError *oerror, const char *msg_format, ...)
446 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
448 mono_error_prepare (error);
449 error->error_code = MONO_ERROR_INVALID_PROGRAM;
451 set_error_message ();
455 mono_error_set_exception_instance (MonoError *oerror, MonoException *exc)
457 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
459 mono_error_prepare (error);
460 error->error_code = MONO_ERROR_EXCEPTION_INSTANCE;
461 error->exn.instance_handle = mono_gchandle_new (exc ? &exc->object : NULL, FALSE);
465 mono_error_set_out_of_memory (MonoError *oerror, const char *msg_format, ...)
467 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
468 mono_error_prepare (error);
470 error->error_code = MONO_ERROR_OUT_OF_MEMORY;
472 set_error_message ();
476 mono_error_set_argument (MonoError *oerror, const char *argument, const char *msg_format, ...)
478 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
479 mono_error_prepare (error);
481 error->error_code = MONO_ERROR_ARGUMENT;
482 error->first_argument = argument;
484 set_error_message ();
488 mono_error_set_argument_null (MonoError *oerror, const char *argument, const char *msg_format, ...)
490 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
491 mono_error_prepare (error);
493 error->error_code = MONO_ERROR_ARGUMENT_NULL;
494 error->first_argument = argument;
496 set_error_message ();
500 mono_error_set_not_verifiable (MonoError *oerror, MonoMethod *method, const char *msg_format, ...)
502 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
503 mono_error_prepare (error);
505 error->error_code = MONO_ERROR_NOT_VERIFIABLE;
507 mono_error_set_class (oerror, method->klass);
508 mono_error_set_member_name (oerror, mono_method_full_name (method, 1));
511 set_error_message ();
516 get_type_name_as_mono_string (MonoErrorInternal *error, MonoDomain *domain, MonoError *error_out)
518 MonoString* res = NULL;
520 if (error->type_name) {
521 res = mono_string_new (domain, error->type_name);
524 MonoClass *klass = get_class (error);
526 char *name = mono_type_full_name (&klass->byval_arg);
528 res = mono_string_new (domain, name);
534 mono_error_set_out_of_memory (error_out, "Could not allocate type name");
539 set_message_on_exception (MonoException *exception, MonoErrorInternal *error, MonoError *error_out)
541 MonoString *msg = mono_string_new (mono_domain_get (), error->full_message);
543 MONO_OBJECT_SETREF (exception, message, msg);
545 mono_error_set_out_of_memory (error_out, "Could not allocate exception object");
548 /*Can fail with out-of-memory*/
550 mono_error_prepare_exception (MonoError *oerror, MonoError *error_out)
552 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
554 MonoException* exception = NULL;
555 MonoString *assembly_name = NULL, *type_name = NULL, *method_name = NULL, *field_name = NULL, *msg = NULL;
556 MonoDomain *domain = mono_domain_get ();
558 mono_error_init (error_out);
560 switch (error->error_code) {
561 case MONO_ERROR_NONE:
564 case MONO_ERROR_MISSING_METHOD:
565 if ((error->type_name || error->exn.klass) && error->member_name) {
566 type_name = get_type_name_as_mono_string (error, domain, error_out);
567 if (!mono_error_ok (error_out))
570 method_name = mono_string_new (domain, error->member_name);
572 mono_error_set_out_of_memory (error_out, "Could not allocate method name");
576 exception = mono_exception_from_name_two_strings (mono_defaults.corlib, "System", "MissingMethodException", type_name, method_name);
578 set_message_on_exception (exception, error, error_out);
580 exception = mono_exception_from_name_msg (mono_defaults.corlib, "System", "MissingMethodException", error->full_message);
584 case MONO_ERROR_MISSING_FIELD:
585 if ((error->type_name || error->exn.klass) && error->member_name) {
586 type_name = get_type_name_as_mono_string (error, domain, error_out);
587 if (!mono_error_ok (error_out))
590 field_name = mono_string_new (domain, error->member_name);
592 mono_error_set_out_of_memory (error_out, "Could not allocate field name");
596 exception = mono_exception_from_name_two_strings (mono_defaults.corlib, "System", "MissingFieldException", type_name, field_name);
598 set_message_on_exception (exception, error, error_out);
600 exception = mono_exception_from_name_msg (mono_defaults.corlib, "System", "MissingFieldException", error->full_message);
604 case MONO_ERROR_TYPE_LOAD:
605 if ((error->type_name && error->assembly_name) || error->exn.klass) {
606 type_name = get_type_name_as_mono_string (error, domain, error_out);
607 if (!mono_error_ok (error_out))
610 if (error->assembly_name) {
611 assembly_name = mono_string_new (domain, error->assembly_name);
612 if (!assembly_name) {
613 mono_error_set_out_of_memory (error_out, "Could not allocate assembly name");
618 exception = mono_exception_from_name_two_strings (mono_get_corlib (), "System", "TypeLoadException", type_name, assembly_name);
620 set_message_on_exception (exception, error, error_out);
622 exception = mono_exception_from_name_msg (mono_defaults.corlib, "System", "TypeLoadException", error->full_message);
626 case MONO_ERROR_FILE_NOT_FOUND:
627 case MONO_ERROR_BAD_IMAGE:
628 if (error->assembly_name) {
629 msg = mono_string_new (domain, error->full_message);
631 mono_error_set_out_of_memory (error_out, "Could not allocate message");
635 if (error->assembly_name) {
636 assembly_name = mono_string_new (domain, error->assembly_name);
637 if (!assembly_name) {
638 mono_error_set_out_of_memory (error_out, "Could not allocate assembly name");
643 if (error->error_code == MONO_ERROR_FILE_NOT_FOUND)
644 exception = mono_exception_from_name_two_strings (mono_get_corlib (), "System.IO", "FileNotFoundException", msg, assembly_name);
646 exception = mono_exception_from_name_two_strings (mono_defaults.corlib, "System", "BadImageFormatException", msg, assembly_name);
648 if (error->error_code == MONO_ERROR_FILE_NOT_FOUND)
649 exception = mono_exception_from_name_msg (mono_get_corlib (), "System.IO", "FileNotFoundException", error->full_message);
651 exception = mono_exception_from_name_msg (mono_defaults.corlib, "System", "BadImageFormatException", error->full_message);
655 case MONO_ERROR_OUT_OF_MEMORY:
656 exception = mono_get_exception_out_of_memory ();
659 case MONO_ERROR_ARGUMENT:
660 exception = mono_get_exception_argument (error->first_argument, error->full_message);
663 case MONO_ERROR_ARGUMENT_NULL:
664 exception = mono_get_exception_argument_null (error->first_argument);
667 case MONO_ERROR_NOT_VERIFIABLE: {
668 char *type_name = NULL, *message;
669 if (error->exn.klass) {
670 type_name = mono_type_get_full_name (error->exn.klass);
672 mono_error_set_out_of_memory (error_out, "Could not allocate message");
676 message = g_strdup_printf ("Error in %s:%s %s", type_name, error->member_name, error->full_message);
679 mono_error_set_out_of_memory (error_out, "Could not allocate message");
682 exception = mono_exception_from_name_msg (mono_defaults.corlib, "System.Security", "VerificationException", message);
687 case MONO_ERROR_GENERIC:
688 if (!error->exception_name_space || !error->exception_name)
689 mono_error_set_execution_engine (error_out, "MonoError with generic error but no exception name was supplied");
691 exception = mono_exception_from_name_msg (mono_defaults.corlib, error->exception_name_space, error->exception_name, error->full_message);
694 case MONO_ERROR_EXCEPTION_INSTANCE:
695 exception = (MonoException*) mono_gchandle_get_target (error->exn.instance_handle);
698 case MONO_ERROR_CLEANUP_CALLED_SENTINEL:
699 mono_error_set_execution_engine (error_out, "MonoError reused after mono_error_cleanup");
702 case MONO_ERROR_INVALID_PROGRAM: {
703 gboolean lacks_message = error->flags & MONO_ERROR_INCOMPLETE;
705 return mono_exception_from_name_msg (mono_defaults.corlib, "System", "InvalidProgramException", "");
707 return mono_exception_from_name_msg (mono_defaults.corlib, "System", "InvalidProgramException", error->full_message);
710 mono_error_set_execution_engine (error_out, "Invalid error-code %d", error->error_code);
713 if (!mono_error_ok (error_out))
716 mono_error_set_out_of_memory (error_out, "Could not allocate exception object");
721 Convert this MonoError to an exception if it's faulty or return NULL.
722 The error object is cleant after.
726 mono_error_convert_to_exception (MonoError *target_error)
731 if (mono_error_ok (target_error))
734 ex = mono_error_prepare_exception (target_error, &error);
735 if (!mono_error_ok (&error)) {
736 MonoError second_chance;
737 /*Try to produce the exception for the second error. FIXME maybe we should log about the original one*/
738 ex = mono_error_prepare_exception (&error, &second_chance);
740 g_assert (mono_error_ok (&second_chance)); /*We can't reasonable handle double faults, maybe later.*/
741 mono_error_cleanup (&error);
743 mono_error_cleanup (target_error);
748 mono_error_move (MonoError *dest, MonoError *src)
750 memcpy (dest, src, sizeof (MonoErrorInternal));
751 mono_error_init (src);