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 if (error->error_code != MONO_ERROR_NONE)
45 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;
46 error->exn.klass = NULL;
50 get_class (MonoErrorInternal *error)
52 MonoClass *klass = NULL;
53 if (is_managed_exception (error))
54 klass = mono_object_class (mono_gchandle_get_target (error->exn.instance_handle));
56 klass = error->exn.klass;
61 get_type_name (MonoErrorInternal *error)
64 return error->type_name;
65 MonoClass *klass = get_class (error);
68 return "<unknown type>";
72 get_assembly_name (MonoErrorInternal *error)
74 if (error->assembly_name)
75 return error->assembly_name;
76 MonoClass *klass = get_class (error);
77 if (klass && klass->image)
78 return klass->image->name;
79 return "<unknown assembly>";
83 mono_error_init_flags (MonoError *oerror, unsigned short flags)
85 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
86 g_assert (sizeof (MonoError) == sizeof (MonoErrorInternal));
88 error->error_code = MONO_ERROR_NONE;
93 mono_error_init (MonoError *error)
95 mono_error_init_flags (error, 0);
99 mono_error_cleanup (MonoError *oerror)
101 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
102 if (error->error_code == MONO_ERROR_NONE)
105 if (is_managed_exception (error))
106 mono_gchandle_free (error->exn.instance_handle);
108 g_free ((char*)error->full_message);
109 g_free ((char*)error->full_message_with_fields);
110 if (!(error->flags & MONO_ERROR_FREE_STRINGS)) //no memory was allocated
113 g_free ((char*)error->type_name);
114 g_free ((char*)error->assembly_name);
115 g_free ((char*)error->member_name);
116 g_free ((char*)error->exception_name_space);
117 g_free ((char*)error->exception_name);
118 g_free ((char*)error->first_argument);
122 mono_error_ok (MonoError *error)
124 return error->error_code == MONO_ERROR_NONE;
128 mono_error_assert_ok_pos (MonoError *error, const char* filename, int lineno)
130 if (mono_error_ok (error))
133 g_error ("%s:%d: %s\n", filename, lineno, mono_error_get_message (error));
137 mono_error_get_error_code (MonoError *error)
139 return error->error_code;
142 /*Return a pointer to the internal error message, might be NULL.
143 Caller should not release it.*/
145 mono_error_get_message (MonoError *oerror)
147 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
148 if (error->error_code == MONO_ERROR_NONE)
150 if (error->full_message_with_fields)
151 return error->full_message_with_fields;
153 error->full_message_with_fields = g_strdup_printf ("%s assembly:%s type:%s member:%s",
155 get_assembly_name (error),
156 get_type_name (error),
157 error->member_name ? error->member_name : "<none>");
159 return error->full_message_with_fields ? error->full_message_with_fields : error->full_message;
163 * Inform that this error has heap allocated strings.
164 * The strings will be duplicated if @dup_strings is TRUE
165 * otherwise they will just be free'd in mono_error_cleanup.
168 mono_error_dup_strings (MonoError *oerror, gboolean dup_strings)
170 #define DUP_STR(field) do { if (error->field) {\
171 if (!(error->field = g_strdup (error->field))) \
172 error->flags |= MONO_ERROR_INCOMPLETE; \
175 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
176 error->flags |= MONO_ERROR_FREE_STRINGS;
180 DUP_STR (assembly_name);
181 DUP_STR (member_name);
182 DUP_STR (exception_name_space);
183 DUP_STR (exception_name);
184 DUP_STR (first_argument);
190 mono_error_set_error (MonoError *oerror, int error_code, const char *msg_format, ...)
192 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
193 mono_error_prepare (error);
195 error->error_code = error_code;
196 set_error_message ();
200 mono_error_set_assembly_name (MonoError *oerror, const char *assembly_name)
202 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
203 g_assert (error->error_code != MONO_ERROR_NONE);
205 error->assembly_name = assembly_name;
209 mono_error_set_member_name (MonoError *oerror, const char *member_name)
211 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
213 error->member_name = member_name;
217 mono_error_set_type_name (MonoError *oerror, const char *type_name)
219 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
221 error->type_name = type_name;
225 mono_error_set_class (MonoError *oerror, MonoClass *klass)
227 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
229 if (is_managed_exception (error))
231 error->exn.klass = klass;
235 mono_error_set_corlib_exception (MonoError *oerror, const char *name_space, const char *name)
237 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
239 error->exception_name_space = name_space;
240 error->exception_name = name;
245 mono_error_set_assembly_load (MonoError *oerror, const char *assembly_name, const char *msg_format, ...)
247 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
248 mono_error_prepare (error);
250 error->error_code = MONO_ERROR_FILE_NOT_FOUND;
251 mono_error_set_assembly_name (oerror, assembly_name);
253 set_error_message ();
258 mono_error_set_assembly_load_simple (MonoError *oerror, const char *assembly_name, gboolean refection_only)
261 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.");
263 mono_error_set_assembly_load (oerror, assembly_name, "Could not load file or assembly or one of its dependencies.");
267 mono_error_set_type_load_class (MonoError *oerror, MonoClass *klass, const char *msg_format, ...)
269 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
270 mono_error_prepare (error);
272 error->error_code = MONO_ERROR_TYPE_LOAD;
273 mono_error_set_class (oerror, klass);
274 set_error_message ();
278 * Different than other functions, this one here assumes that type_name and assembly_name to have been allocated just for us.
279 * Which means mono_error_cleanup will free them.
282 mono_error_set_type_load_name (MonoError *oerror, const char *type_name, const char *assembly_name, const char *msg_format, ...)
284 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
285 mono_error_prepare (error);
287 error->error_code = MONO_ERROR_TYPE_LOAD;
288 mono_error_set_type_name (oerror, type_name);
289 mono_error_set_assembly_name (oerror, assembly_name);
290 mono_error_dup_strings (oerror, FALSE);
291 set_error_message ();
295 mono_error_set_method_load (MonoError *oerror, MonoClass *klass, const char *method_name, const char *msg_format, ...)
297 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
298 mono_error_prepare (error);
300 error->error_code = MONO_ERROR_MISSING_METHOD;
301 mono_error_set_class (oerror, klass);
302 mono_error_set_member_name (oerror, method_name);
303 set_error_message ();
307 mono_error_set_field_load (MonoError *oerror, MonoClass *klass, const char *field_name, const char *msg_format, ...)
309 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
310 mono_error_prepare (error);
312 error->error_code = MONO_ERROR_MISSING_FIELD;
313 mono_error_set_class (oerror, klass);
314 mono_error_set_member_name (oerror, field_name);
315 set_error_message ();
319 mono_error_set_bad_image_name (MonoError *oerror, const char *assembly_name, const char *msg_format, ...)
321 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
322 mono_error_prepare (error);
324 error->error_code = MONO_ERROR_BAD_IMAGE;
325 mono_error_set_assembly_name (oerror, assembly_name);
326 set_error_message ();
330 mono_error_set_bad_image (MonoError *oerror, MonoImage *image, const char *msg_format, ...)
332 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
333 mono_error_prepare (error);
335 error->error_code = MONO_ERROR_BAD_IMAGE;
336 error->assembly_name = image ? mono_image_get_name (image) : "<no_image>";
337 set_error_message ();
341 mono_error_set_generic_errorv (MonoError *oerror, const char *name_space, const char *name, const char *msg_format, va_list args)
343 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
344 mono_error_prepare (error);
346 error->error_code = MONO_ERROR_GENERIC;
347 mono_error_set_corlib_exception (oerror, name_space, name);
348 set_error_messagev ();
352 mono_error_set_generic_error (MonoError *oerror, const char * name_space, const char *name, const char *msg_format, ...)
355 va_start (args, msg_format);
356 mono_error_set_generic_errorv (oerror, name_space, name, msg_format, args);
361 * mono_error_set_not_implemented:
363 * System.NotImplementedException
366 mono_error_set_not_implemented (MonoError *oerror, const char *msg_format, ...)
369 va_start (args, msg_format);
370 mono_error_set_generic_errorv (oerror, "System", "NotImplementedException", msg_format, args);
375 * mono_error_set_execution_engine:
377 * System.ExecutionEngineException
380 mono_error_set_execution_engine (MonoError *oerror, const char *msg_format, ...)
383 va_start (args, msg_format);
384 mono_error_set_generic_errorv (oerror, "System", "ExecutionEngineException", msg_format, args);
389 * mono_error_set_execution_engine:
391 * System.NotSupportedException
394 mono_error_set_not_supported (MonoError *oerror, const char *msg_format, ...)
397 va_start (args, msg_format);
398 mono_error_set_generic_errorv (oerror, "System", "NotSupportedException", msg_format, args);
403 mono_error_set_exception_instance (MonoError *oerror, MonoException *exc)
405 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
407 mono_error_prepare (error);
408 error->error_code = MONO_ERROR_EXCEPTION_INSTANCE;
409 error->exn.instance_handle = mono_gchandle_new (exc ? &exc->object : NULL, FALSE);
413 mono_error_set_out_of_memory (MonoError *oerror, const char *msg_format, ...)
415 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
416 mono_error_prepare (error);
418 error->error_code = MONO_ERROR_OUT_OF_MEMORY;
420 set_error_message ();
424 mono_error_set_argument (MonoError *oerror, const char *argument, const char *msg_format, ...)
426 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
427 mono_error_prepare (error);
429 error->error_code = MONO_ERROR_ARGUMENT;
430 error->first_argument = argument;
432 set_error_message ();
436 mono_error_set_argument_null (MonoError *oerror, const char *argument, const char *msg_format, ...)
438 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
439 mono_error_prepare (error);
441 error->error_code = MONO_ERROR_ARGUMENT_NULL;
442 error->first_argument = argument;
444 set_error_message ();
448 mono_error_set_not_verifiable (MonoError *oerror, MonoMethod *method, const char *msg_format, ...)
450 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
451 mono_error_prepare (error);
453 error->error_code = MONO_ERROR_NOT_VERIFIABLE;
455 mono_error_set_class (oerror, method->klass);
456 mono_error_set_member_name (oerror, mono_method_full_name (method, 1));
459 set_error_message ();
464 get_type_name_as_mono_string (MonoErrorInternal *error, MonoDomain *domain, MonoError *error_out)
466 MonoString* res = NULL;
468 if (error->type_name) {
469 res = mono_string_new (domain, error->type_name);
472 MonoClass *klass = get_class (error);
474 char *name = mono_type_full_name (&klass->byval_arg);
476 res = mono_string_new (domain, name);
482 mono_error_set_out_of_memory (error_out, "Could not allocate type name");
487 set_message_on_exception (MonoException *exception, MonoErrorInternal *error, MonoError *error_out)
489 MonoString *msg = mono_string_new (mono_domain_get (), error->full_message);
491 MONO_OBJECT_SETREF (exception, message, msg);
493 mono_error_set_out_of_memory (error_out, "Could not allocate exception object");
496 /*Can fail with out-of-memory*/
498 mono_error_prepare_exception (MonoError *oerror, MonoError *error_out)
500 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
502 MonoException* exception = NULL;
503 MonoString *assembly_name = NULL, *type_name = NULL, *method_name = NULL, *field_name = NULL, *msg = NULL;
504 MonoDomain *domain = mono_domain_get ();
506 mono_error_init (error_out);
508 switch (error->error_code) {
509 case MONO_ERROR_NONE:
512 case MONO_ERROR_MISSING_METHOD:
513 if ((error->type_name || error->exn.klass) && error->member_name) {
514 type_name = get_type_name_as_mono_string (error, domain, error_out);
515 if (!mono_error_ok (error_out))
518 method_name = mono_string_new (domain, error->member_name);
520 mono_error_set_out_of_memory (error_out, "Could not allocate method name");
524 exception = mono_exception_from_name_two_strings (mono_defaults.corlib, "System", "MissingMethodException", type_name, method_name);
526 set_message_on_exception (exception, error, error_out);
528 exception = mono_exception_from_name_msg (mono_defaults.corlib, "System", "MissingMethodException", error->full_message);
532 case MONO_ERROR_MISSING_FIELD:
533 if ((error->type_name || error->exn.klass) && error->member_name) {
534 type_name = get_type_name_as_mono_string (error, domain, error_out);
535 if (!mono_error_ok (error_out))
538 field_name = mono_string_new (domain, error->member_name);
540 mono_error_set_out_of_memory (error_out, "Could not allocate field name");
544 exception = mono_exception_from_name_two_strings (mono_defaults.corlib, "System", "MissingFieldException", type_name, field_name);
546 set_message_on_exception (exception, error, error_out);
548 exception = mono_exception_from_name_msg (mono_defaults.corlib, "System", "MissingFieldException", error->full_message);
552 case MONO_ERROR_TYPE_LOAD:
553 if ((error->type_name && error->assembly_name) || error->exn.klass) {
554 type_name = get_type_name_as_mono_string (error, domain, error_out);
555 if (!mono_error_ok (error_out))
558 if (error->assembly_name) {
559 assembly_name = mono_string_new (domain, error->assembly_name);
560 if (!assembly_name) {
561 mono_error_set_out_of_memory (error_out, "Could not allocate assembly name");
566 exception = mono_exception_from_name_two_strings (mono_get_corlib (), "System", "TypeLoadException", type_name, assembly_name);
568 set_message_on_exception (exception, error, error_out);
570 exception = mono_exception_from_name_msg (mono_defaults.corlib, "System", "TypeLoadException", error->full_message);
574 case MONO_ERROR_FILE_NOT_FOUND:
575 case MONO_ERROR_BAD_IMAGE:
576 if (error->assembly_name) {
577 msg = mono_string_new (domain, error->full_message);
579 mono_error_set_out_of_memory (error_out, "Could not allocate message");
583 if (error->assembly_name) {
584 assembly_name = mono_string_new (domain, error->assembly_name);
585 if (!assembly_name) {
586 mono_error_set_out_of_memory (error_out, "Could not allocate assembly name");
591 if (error->error_code == MONO_ERROR_FILE_NOT_FOUND)
592 exception = mono_exception_from_name_two_strings (mono_get_corlib (), "System.IO", "FileNotFoundException", msg, assembly_name);
594 exception = mono_exception_from_name_two_strings (mono_defaults.corlib, "System", "BadImageFormatException", msg, assembly_name);
596 if (error->error_code == MONO_ERROR_FILE_NOT_FOUND)
597 exception = mono_exception_from_name_msg (mono_get_corlib (), "System.IO", "FileNotFoundException", error->full_message);
599 exception = mono_exception_from_name_msg (mono_defaults.corlib, "System", "BadImageFormatException", error->full_message);
603 case MONO_ERROR_OUT_OF_MEMORY:
604 exception = mono_get_exception_out_of_memory ();
607 case MONO_ERROR_ARGUMENT:
608 exception = mono_get_exception_argument (error->first_argument, error->full_message);
611 case MONO_ERROR_ARGUMENT_NULL:
612 exception = mono_get_exception_argument_null (error->first_argument);
615 case MONO_ERROR_NOT_VERIFIABLE: {
616 char *type_name = NULL, *message;
617 if (error->exn.klass) {
618 type_name = mono_type_get_full_name (error->exn.klass);
620 mono_error_set_out_of_memory (error_out, "Could not allocate message");
624 message = g_strdup_printf ("Error in %s:%s %s", type_name, error->member_name, error->full_message);
627 mono_error_set_out_of_memory (error_out, "Could not allocate message");
630 exception = mono_exception_from_name_msg (mono_defaults.corlib, "System.Security", "VerificationException", message);
635 case MONO_ERROR_GENERIC:
636 if (!error->exception_name_space || !error->exception_name)
637 mono_error_set_execution_engine (error_out, "MonoError with generic error but no exception name was supplied");
639 exception = mono_exception_from_name_msg (mono_defaults.corlib, error->exception_name_space, error->exception_name, error->full_message);
642 case MONO_ERROR_EXCEPTION_INSTANCE:
643 exception = (MonoException*) mono_gchandle_get_target (error->exn.instance_handle);
647 mono_error_set_execution_engine (error_out, "Invalid error-code %d", error->error_code);
650 if (!mono_error_ok (error_out))
653 mono_error_set_out_of_memory (error_out, "Could not allocate exception object");
658 Convert this MonoError to an exception if it's faulty or return NULL.
659 The error object is cleant after.
663 mono_error_convert_to_exception (MonoError *target_error)
668 if (mono_error_ok (target_error))
671 ex = mono_error_prepare_exception (target_error, &error);
672 if (!mono_error_ok (&error)) {
673 MonoError second_chance;
674 /*Try to produce the exception for the second error. FIXME maybe we should log about the original one*/
675 ex = mono_error_prepare_exception (&error, &second_chance);
677 g_assert (mono_error_ok (&second_chance)); /*We can't reasonable handle double faults, maybe later.*/
678 mono_error_cleanup (&error);
680 mono_error_cleanup (target_error);
685 mono_error_move (MonoError *dest, MonoError *src)
687 memcpy (dest, src, sizeof (MonoErrorInternal));
688 mono_error_init (src);