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 set_error_message() do { \
19 va_start (args, msg_format); \
20 if (!(error->full_message = g_strdup_vprintf (msg_format, args))) \
21 error->flags |= MONO_ERROR_INCOMPLETE; \
26 mono_error_prepare (MonoErrorInternal *error)
28 if (error->error_code != MONO_ERROR_NONE)
31 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;
36 get_type_name (MonoErrorInternal *error)
39 return error->type_name;
41 return error->klass->name;
42 return "<unknown type>";
46 get_assembly_name (MonoErrorInternal *error)
48 if (error->assembly_name)
49 return error->assembly_name;
50 if (error->klass && error->klass->image)
51 return error->klass->image->name;
52 return "<unknown assembly>";
56 mono_error_init_flags (MonoError *oerror, unsigned short flags)
58 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
59 g_assert (sizeof (MonoError) == sizeof (MonoErrorInternal));
61 error->error_code = MONO_ERROR_NONE;
66 mono_error_init (MonoError *error)
68 mono_error_init_flags (error, 0);
72 mono_error_cleanup (MonoError *oerror)
74 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
75 if (error->error_code == MONO_ERROR_NONE)
78 g_free ((char*)error->full_message);
79 g_free ((char*)error->full_message_with_fields);
80 if (!(error->flags & MONO_ERROR_FREE_STRINGS)) //no memory was allocated
83 g_free ((char*)error->type_name);
84 g_free ((char*)error->assembly_name);
85 g_free ((char*)error->member_name);
86 g_free ((char*)error->exception_name_space);
87 g_free ((char*)error->exception_name);
88 g_free ((char*)error->first_argument);
92 mono_error_ok (MonoError *error)
94 return error->error_code == MONO_ERROR_NONE;
98 mono_error_assert_ok (MonoError *error)
100 if (mono_error_ok (error))
103 g_error ("%s\n", mono_error_get_message (error));
107 mono_error_get_error_code (MonoError *error)
109 return error->error_code;
112 /*Return a pointer to the internal error message, might be NULL.
113 Caller should not release it.*/
115 mono_error_get_message (MonoError *oerror)
117 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
118 if (error->error_code == MONO_ERROR_NONE)
120 if (error->full_message_with_fields)
121 return error->full_message_with_fields;
123 error->full_message_with_fields = g_strdup_printf ("%s assembly:%s type:%s member:%s",
125 get_assembly_name (error),
126 get_type_name (error),
127 error->member_name ? error->member_name : "<none>");
129 return error->full_message_with_fields ? error->full_message_with_fields : error->full_message;
133 * Inform that this error has heap allocated strings.
134 * The strings will be duplicated if @dup_strings is TRUE
135 * otherwise they will just be free'd in mono_error_cleanup.
138 mono_error_dup_strings (MonoError *oerror, gboolean dup_strings)
140 #define DUP_STR(field) do { if (error->field) {\
141 if (!(error->field = g_strdup (error->field))) \
142 error->flags |= MONO_ERROR_INCOMPLETE; \
145 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
146 error->flags |= MONO_ERROR_FREE_STRINGS;
150 DUP_STR (assembly_name);
151 DUP_STR (member_name);
152 DUP_STR (exception_name_space);
153 DUP_STR (exception_name);
154 DUP_STR (first_argument);
160 mono_error_set_error (MonoError *oerror, int error_code, const char *msg_format, ...)
162 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
163 mono_error_prepare (error);
165 error->error_code = error_code;
166 set_error_message ();
170 mono_error_set_assembly_name (MonoError *oerror, const char *assembly_name)
172 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
173 g_assert (error->error_code != MONO_ERROR_NONE);
175 error->assembly_name = assembly_name;
179 mono_error_set_member_name (MonoError *oerror, const char *member_name)
181 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
183 error->member_name = member_name;
187 mono_error_set_type_name (MonoError *oerror, const char *type_name)
189 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
191 error->type_name = type_name;
195 mono_error_set_class (MonoError *oerror, MonoClass *klass)
197 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
199 error->klass = klass;
203 mono_error_set_corlib_exception (MonoError *oerror, const char *name_space, const char *name)
205 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
207 error->exception_name_space = name_space;
208 error->exception_name = name;
213 mono_error_set_assembly_load (MonoError *oerror, const char *assembly_name, const char *msg_format, ...)
215 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
216 mono_error_prepare (error);
218 error->error_code = MONO_ERROR_FILE_NOT_FOUND;
219 mono_error_set_assembly_name (oerror, assembly_name);
221 set_error_message ();
226 mono_error_set_assembly_load_simple (MonoError *oerror, const char *assembly_name, gboolean refection_only)
229 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.");
231 mono_error_set_assembly_load (oerror, assembly_name, "Could not load file or assembly or one of its dependencies.");
235 mono_error_set_type_load_class (MonoError *oerror, MonoClass *klass, const char *msg_format, ...)
237 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
238 mono_error_prepare (error);
240 error->error_code = MONO_ERROR_TYPE_LOAD;
241 mono_error_set_class (oerror, klass);
242 set_error_message ();
246 * Different than other functions, this one here assumes that type_name and assembly_name to have been allocated just for us.
247 * Which means mono_error_cleanup will free them.
250 mono_error_set_type_load_name (MonoError *oerror, const char *type_name, const char *assembly_name, const char *msg_format, ...)
252 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
253 mono_error_prepare (error);
255 error->error_code = MONO_ERROR_TYPE_LOAD;
256 mono_error_set_type_name (oerror, type_name);
257 mono_error_set_assembly_name (oerror, assembly_name);
258 mono_error_dup_strings (oerror, FALSE);
259 set_error_message ();
263 mono_error_set_method_load (MonoError *oerror, MonoClass *klass, const char *method_name, const char *msg_format, ...)
265 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
266 mono_error_prepare (error);
268 error->error_code = MONO_ERROR_MISSING_METHOD;
269 mono_error_set_class (oerror, klass);
270 mono_error_set_member_name (oerror, method_name);
271 set_error_message ();
275 mono_error_set_field_load (MonoError *oerror, MonoClass *klass, const char *field_name, const char *msg_format, ...)
277 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
278 mono_error_prepare (error);
280 error->error_code = MONO_ERROR_MISSING_FIELD;
281 mono_error_set_class (oerror, klass);
282 mono_error_set_member_name (oerror, field_name);
283 set_error_message ();
287 mono_error_set_bad_image_name (MonoError *oerror, const char *assembly_name, const char *msg_format, ...)
289 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
290 mono_error_prepare (error);
292 error->error_code = MONO_ERROR_BAD_IMAGE;
293 mono_error_set_assembly_name (oerror, assembly_name);
294 set_error_message ();
298 mono_error_set_bad_image (MonoError *oerror, MonoImage *image, const char *msg_format, ...)
300 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
301 mono_error_prepare (error);
303 error->error_code = MONO_ERROR_BAD_IMAGE;
304 error->assembly_name = image ? mono_image_get_name (image) : "<no_image>";
305 set_error_message ();
309 mono_error_set_generic_error (MonoError *oerror, const char * name_space, const char *name, const char *msg_format, ...)
311 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
312 mono_error_prepare (error);
314 error->error_code = MONO_ERROR_GENERIC;
315 mono_error_set_corlib_exception (oerror, name_space, name);
316 set_error_message ();
320 mono_error_set_from_loader_error (MonoError *oerror)
322 MonoLoaderError *loader_error = mono_loader_get_last_error ();
323 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
324 gboolean dup_strings = TRUE;
326 mono_error_prepare (error);
329 mono_error_set_generic_error (oerror, "System", "ExecutionEngineException", "Runtime tried to produce a mono-error from an empty loader-error");
333 switch (loader_error->exception_type) {
334 case MONO_EXCEPTION_NONE:
335 mono_error_set_generic_error (oerror, "System", "ExecutionEngineException", "Runtime tried to produce a mono-error from a non-error loader-error");
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 error->full_message = g_strdup ("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 (error->full_message));
419 mono_loader_set_error_bad_image (g_strdup_printf ("Non translatable error: %s", error->full_message));
424 mono_error_set_out_of_memory (MonoError *oerror, const char *msg_format, ...)
426 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
427 mono_error_prepare (error);
429 error->error_code = MONO_ERROR_OUT_OF_MEMORY;
431 set_error_message ();
435 mono_error_set_argument (MonoError *oerror, const char *argument, const char *msg_format, ...)
437 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
438 mono_error_prepare (error);
440 error->error_code = MONO_ERROR_ARGUMENT;
441 error->first_argument = argument;
443 set_error_message ();
447 mono_error_set_not_verifiable (MonoError *oerror, MonoMethod *method, const char *msg_format, ...)
449 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
450 mono_error_prepare (error);
452 error->error_code = MONO_ERROR_NOT_VERIFIABLE;
454 mono_error_set_class (oerror, method->klass);
455 mono_error_set_member_name (oerror, mono_method_full_name (method, 1));
458 set_error_message ();
463 get_type_name_as_mono_string (MonoErrorInternal *error, MonoDomain *domain, MonoError *error_out)
465 MonoString* res = NULL;
467 if (error->type_name) {
468 res = mono_string_new (domain, error->type_name);
470 } else if (error->klass) {
471 char *name = mono_type_full_name (&error->klass->byval_arg);
473 res = mono_string_new (domain, name);
478 mono_error_set_out_of_memory (error_out, "Could not allocate type name");
483 set_message_on_exception (MonoException *exception, MonoErrorInternal *error, MonoError *error_out)
485 MonoString *msg = mono_string_new (mono_domain_get (), error->full_message);
487 MONO_OBJECT_SETREF (exception, message, msg);
489 mono_error_set_out_of_memory (error_out, "Could not allocate exception object");
492 /*Can fail with out-of-memory*/
494 mono_error_prepare_exception (MonoError *oerror, MonoError *error_out)
496 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
498 MonoException* exception = NULL;
499 MonoString *assembly_name = NULL, *type_name = NULL, *method_name = NULL, *field_name = NULL, *msg = NULL;
500 MonoDomain *domain = mono_domain_get ();
502 mono_error_init (error_out);
504 switch (error->error_code) {
505 case MONO_ERROR_NONE:
508 case MONO_ERROR_MISSING_METHOD:
509 if ((error->type_name || error->klass) && error->member_name) {
510 type_name = get_type_name_as_mono_string (error, domain, error_out);
511 if (!mono_error_ok (error_out))
514 method_name = mono_string_new (domain, error->member_name);
516 mono_error_set_out_of_memory (error_out, "Could not allocate method name");
520 exception = mono_exception_from_name_two_strings (mono_defaults.corlib, "System", "MissingMethodException", type_name, method_name);
522 set_message_on_exception (exception, error, error_out);
524 exception = mono_exception_from_name_msg (mono_defaults.corlib, "System", "MissingMethodException", error->full_message);
528 case MONO_ERROR_MISSING_FIELD:
529 if ((error->type_name || error->klass) && error->member_name) {
530 type_name = get_type_name_as_mono_string (error, domain, error_out);
531 if (!mono_error_ok (error_out))
534 field_name = mono_string_new (domain, error->member_name);
536 mono_error_set_out_of_memory (error_out, "Could not allocate field name");
540 exception = mono_exception_from_name_two_strings (mono_defaults.corlib, "System", "MissingFieldException", type_name, field_name);
542 set_message_on_exception (exception, error, error_out);
544 exception = mono_exception_from_name_msg (mono_defaults.corlib, "System", "MissingFieldException", error->full_message);
548 case MONO_ERROR_TYPE_LOAD:
549 if (error->type_name || error->assembly_name) {
550 type_name = get_type_name_as_mono_string (error, domain, error_out);
551 if (!mono_error_ok (error_out))
554 if (error->assembly_name) {
555 assembly_name = mono_string_new (domain, error->assembly_name);
556 if (!assembly_name) {
557 mono_error_set_out_of_memory (error_out, "Could not allocate assembly name");
562 exception = mono_exception_from_name_two_strings (mono_get_corlib (), "System", "TypeLoadException", type_name, assembly_name);
564 set_message_on_exception (exception, error, error_out);
566 exception = mono_exception_from_name_msg (mono_defaults.corlib, "System", "TypeLoadException", error->full_message);
570 case MONO_ERROR_FILE_NOT_FOUND:
571 case MONO_ERROR_BAD_IMAGE:
572 if (error->assembly_name) {
573 msg = mono_string_new (domain, error->full_message);
575 mono_error_set_out_of_memory (error_out, "Could not allocate message");
579 if (error->assembly_name) {
580 assembly_name = mono_string_new (domain, error->assembly_name);
581 if (!assembly_name) {
582 mono_error_set_out_of_memory (error_out, "Could not allocate assembly name");
587 if (error->error_code == MONO_ERROR_FILE_NOT_FOUND)
588 exception = mono_exception_from_name_two_strings (mono_get_corlib (), "System.IO", "FileNotFoundException", msg, assembly_name);
590 exception = mono_exception_from_name_two_strings (mono_defaults.corlib, "System", "BadImageFormatException", msg, assembly_name);
592 if (error->error_code == MONO_ERROR_FILE_NOT_FOUND)
593 exception = mono_exception_from_name_msg (mono_get_corlib (), "System.IO", "FileNotFoundException", error->full_message);
595 exception = mono_exception_from_name_msg (mono_defaults.corlib, "System", "BadImageFormatException", error->full_message);
599 case MONO_ERROR_OUT_OF_MEMORY:
600 exception = mono_get_exception_out_of_memory ();
603 case MONO_ERROR_ARGUMENT:
604 exception = mono_get_exception_argument (error->first_argument, error->full_message);
607 case MONO_ERROR_NOT_VERIFIABLE: {
608 char *type_name = NULL, *message;
610 type_name = mono_type_get_full_name (error->klass);
612 mono_error_set_out_of_memory (error_out, "Could not allocate message");
616 message = g_strdup_printf ("Error in %s:%s %s", type_name, error->member_name, error->full_message);
619 mono_error_set_out_of_memory (error_out, "Could not allocate message");
622 exception = mono_exception_from_name_msg (mono_defaults.corlib, "System.Security", "VerificationException", message);
627 case MONO_ERROR_GENERIC:
628 if (!error->exception_name_space || !error->exception_name)
629 mono_error_set_generic_error (error_out, "System", "ExecutionEngineException", "MonoError with generic error but no exception name was supplied");
631 exception = mono_exception_from_name_msg (mono_defaults.corlib, error->exception_name_space, error->exception_name, error->full_message);
635 mono_error_set_generic_error (error_out, "System", "ExecutionEngineException", "Invalid error-code %d", error->error_code);
638 if (!mono_error_ok (error_out))
641 mono_error_set_out_of_memory (error_out, "Could not allocate exception object");
646 Convert this MonoError to an exception if it's faulty or return NULL.
647 The error object is cleant after.
651 mono_error_convert_to_exception (MonoError *target_error)
656 if (mono_error_ok (target_error))
659 ex = mono_error_prepare_exception (target_error, &error);
660 if (!mono_error_ok (&error)) {
661 MonoError second_chance;
662 /*Try to produce the exception for the second error. FIXME maybe we should log about the original one*/
663 ex = mono_error_prepare_exception (&error, &second_chance);
665 g_assert (mono_error_ok (&second_chance)); /*We can't reasonable handle double faults, maybe later.*/
666 mono_error_cleanup (&error);
668 mono_error_cleanup (target_error);