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/object-internals.h>
15 #include <mono/metadata/class-internals.h>
16 #include <mono/metadata/debug-helpers.h>
18 #define mono_internal_error_get_message(E) ((E)->full_message ? (E)->full_message : (E)->message)
20 #define set_error_message() do { \
22 va_start (args, msg_format); \
23 if (g_vsnprintf (error->message, sizeof (error->message), msg_format, args) >= sizeof (error->message)) {\
25 va_start (args, msg_format); \
26 if (!(error->full_message = g_strdup_vprintf (msg_format, args))) \
27 error->flags |= MONO_ERROR_INCOMPLETE; \
33 mono_error_prepare (MonoErrorInternal *error)
35 if (error->error_code != MONO_ERROR_NONE)
38 error->type_name = error->assembly_name = error->member_name = error->full_message = error->exception_name_space = error->exception_name = NULL;
40 error->message [0] = 0;
44 mono_error_init_flags (MonoError *oerror, unsigned short flags)
46 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
47 g_assert (sizeof (MonoError) == sizeof (MonoErrorInternal));
49 error->error_code = MONO_ERROR_NONE;
54 mono_error_init (MonoError *error)
56 mono_error_init_flags (error, 0);
60 mono_error_cleanup (MonoError *oerror)
62 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
63 if (error->error_code == MONO_ERROR_NONE)
66 g_free ((char*)error->full_message);
67 if (!(error->flags & MONO_ERROR_FREE_STRINGS)) //no memory was allocated
70 g_free ((char*)error->type_name);
71 g_free ((char*)error->assembly_name);
72 g_free ((char*)error->member_name);
73 g_free ((char*)error->exception_name_space);
74 g_free ((char*)error->exception_name);
78 mono_error_ok (MonoError *error)
80 return error->error_code == MONO_ERROR_NONE;
84 mono_error_get_error_code (MonoError *error)
86 return error->error_code;
89 /*Return a pointer to the internal error message, might be NULL.
90 Caller should not release it.*/
92 mono_error_get_message (MonoError *oerror)
94 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
95 if (error->error_code == MONO_ERROR_NONE)
97 return mono_internal_error_get_message (error);
101 * Inform that this error has heap allocated strings.
102 * The strings will be duplicated if @dup_strings is TRUE
103 * otherwise they will just be free'd in mono_error_cleanup.
106 mono_error_dup_strings (MonoError *oerror, gboolean dup_strings)
108 #define DUP_STR(field) do { if (error->field) {\
109 if (!(error->field = g_strdup (error->field))) \
110 error->flags |= MONO_ERROR_INCOMPLETE; \
113 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
114 error->flags |= MONO_ERROR_FREE_STRINGS;
118 DUP_STR (assembly_name);
119 DUP_STR (member_name);
120 DUP_STR (exception_name_space);
121 DUP_STR (exception_name);
127 mono_error_set_error (MonoError *oerror, int error_code, const char *msg_format, ...)
129 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
130 mono_error_prepare (error);
132 error->error_code = error_code;
133 set_error_message ();
137 mono_error_set_assembly_name (MonoError *oerror, const char *assembly_name)
139 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
140 g_assert (error->error_code != MONO_ERROR_NONE);
142 error->assembly_name = assembly_name;
146 mono_error_set_member_name (MonoError *oerror, const char *member_name)
148 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
150 error->member_name = member_name;
154 mono_error_set_type_name (MonoError *oerror, const char *type_name)
156 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
158 error->type_name = type_name;
162 mono_error_set_class (MonoError *oerror, MonoClass *klass)
164 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
166 error->klass = klass;
170 mono_error_set_corlib_exception (MonoError *oerror, const char *name_space, const char *name)
172 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
174 error->exception_name_space = name_space;
175 error->exception_name = name;
180 mono_error_set_assembly_load (MonoError *oerror, const char *assembly_name, const char *msg_format, ...)
182 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
183 mono_error_prepare (error);
185 error->error_code = MONO_ERROR_FILE_NOT_FOUND;
186 mono_error_set_assembly_name (oerror, assembly_name);
188 set_error_message ();
193 mono_error_set_assembly_load_simple (MonoError *oerror, const char *assembly_name, gboolean refection_only)
196 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.");
198 mono_error_set_assembly_load (oerror, assembly_name, "Could not load file or assembly or one of its dependencies.");
202 mono_error_set_type_load_class (MonoError *oerror, MonoClass *klass, const char *msg_format, ...)
204 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
205 mono_error_prepare (error);
207 error->error_code = MONO_ERROR_TYPE_LOAD;
208 mono_error_set_class (oerror, klass);
209 set_error_message ();
213 * Different than other functions, this one here assumes that type_name and assembly_name to have been allocated just for us.
214 * Which means mono_error_cleanup will free them.
217 mono_error_set_type_load_name (MonoError *oerror, const char *type_name, const char *assembly_name, const char *msg_format, ...)
219 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
220 mono_error_prepare (error);
222 error->error_code = MONO_ERROR_TYPE_LOAD;
223 mono_error_set_type_name (oerror, type_name);
224 mono_error_set_assembly_name (oerror, assembly_name);
225 mono_error_dup_strings (oerror, FALSE);
226 set_error_message ();
230 mono_error_set_method_load (MonoError *oerror, MonoClass *klass, const char *method_name, const char *msg_format, ...)
232 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
233 mono_error_prepare (error);
235 error->error_code = MONO_ERROR_MISSING_METHOD;
236 mono_error_set_class (oerror, klass);
237 mono_error_set_member_name (oerror, method_name);
238 set_error_message ();
242 mono_error_set_field_load (MonoError *oerror, MonoClass *klass, const char *field_name, const char *msg_format, ...)
244 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
245 mono_error_prepare (error);
247 error->error_code = MONO_ERROR_MISSING_FIELD;
248 mono_error_set_class (oerror, klass);
249 mono_error_set_member_name (oerror, field_name);
250 set_error_message ();
254 mono_error_set_bad_image_name (MonoError *oerror, const char *assembly_name, const char *msg_format, ...)
256 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
257 mono_error_prepare (error);
259 error->error_code = MONO_ERROR_BAD_IMAGE;
260 mono_error_set_assembly_name (oerror, assembly_name);
261 set_error_message ();
265 mono_error_set_bad_image (MonoError *oerror, MonoImage *image, const char *msg_format, ...)
267 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
268 mono_error_prepare (error);
270 error->error_code = MONO_ERROR_BAD_IMAGE;
271 error->assembly_name = image ? mono_image_get_name (image) : "<no_image>";
272 set_error_message ();
276 mono_error_set_generic_error (MonoError *oerror, const char * name_space, const char *name, const char *msg_format, ...)
278 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
279 mono_error_prepare (error);
281 error->error_code = MONO_ERROR_GENERIC;
282 mono_error_set_corlib_exception (oerror, name_space, name);
283 set_error_message ();
287 mono_error_set_from_loader_error (MonoError *oerror)
289 MonoLoaderError *loader_error = mono_loader_get_last_error ();
290 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
291 gboolean dup_strings = TRUE;
293 mono_error_prepare (error);
296 mono_error_set_generic_error (oerror, "System", "ExecutionEngineException", "Runtime tried to produce a mono-error from an empty loader-error");
300 switch (loader_error->exception_type) {
301 case MONO_EXCEPTION_NONE:
302 mono_error_set_generic_error (oerror, "System", "ExecutionEngineException", "Runtime tried to produce a mono-error from a non-error loader-error");
304 case MONO_EXCEPTION_SECURITY_LINKDEMAND:
305 case MONO_EXCEPTION_SECURITY_INHERITANCEDEMAND:
306 mono_error_set_generic_error (oerror, "System.Security", "SecurityException", "Failed for unknown reasons.");
309 case MONO_EXCEPTION_INVALID_PROGRAM:
310 mono_error_set_generic_error (oerror, "System", "InvalidProgramException", "Failed for unknown reasons.");
313 case MONO_EXCEPTION_UNVERIFIABLE_IL:
314 mono_error_set_generic_error (oerror, "System.Security", "VerificationException", "Failed for unknown reasons.");
317 case MONO_EXCEPTION_MISSING_METHOD:
318 error->error_code = MONO_ERROR_MISSING_METHOD;
319 mono_error_set_type_name (oerror, loader_error->class_name);
320 mono_error_set_member_name (oerror, loader_error->member_name);
321 g_snprintf (error->message, sizeof (error->message), "Failed for unknown reasons.");
324 case MONO_EXCEPTION_MISSING_FIELD:
325 mono_error_set_field_load (oerror, loader_error->klass, loader_error->member_name, "Failed for unknown reasons.");
328 case MONO_EXCEPTION_TYPE_LOAD:
329 mono_error_set_type_load_name (oerror, g_strdup (loader_error->class_name), g_strdup (loader_error->assembly_name), "Failed for unknown reasons.");
333 case MONO_EXCEPTION_FILE_NOT_FOUND:
334 mono_error_set_assembly_load_simple (oerror, loader_error->assembly_name, loader_error->ref_only);
337 case MONO_EXCEPTION_METHOD_ACCESS:
338 mono_error_set_generic_error (oerror, "System", "MethodAccessException", "Failed for unknown reasons.");
341 case MONO_EXCEPTION_FIELD_ACCESS:
342 mono_error_set_generic_error (oerror, "System", "FieldAccessException", "Failed for unknown reasons.");
345 case MONO_EXCEPTION_OBJECT_SUPPLIED:
346 case MONO_EXCEPTION_GENERIC_SHARING_FAILED:
347 mono_error_set_generic_error (oerror, "System", "ExecutionEngineException", "Runtime tried to produce a mono-error from JIT internal error %d", loader_error->exception_type);
350 case MONO_EXCEPTION_BAD_IMAGE:
351 mono_error_set_bad_image_name (oerror, "<unknown>", "%s", loader_error->msg);
354 case MONO_EXCEPTION_OUT_OF_MEMORY:
355 mono_error_set_out_of_memory (oerror, "Failed for unknown reasons.");
359 mono_error_set_generic_error (oerror, "System", "ExecutionEngineException", "Runtime tried to produce an unknown loader-error %d", loader_error->exception_type);
363 mono_error_dup_strings (oerror, dup_strings);
364 mono_loader_clear_error ();
368 get_type_name (MonoErrorInternal *error)
370 if (error->type_name)
371 return error->type_name;
373 return error->klass->name;
374 return "<unknown type>";
378 get_assembly_name (MonoErrorInternal *error)
380 if (error->assembly_name)
381 return error->assembly_name;
382 if (error->klass && error->klass->image)
383 return error->klass->image->name;
384 return "<unknown assembly>";
388 mono_loader_set_error_from_mono_error (MonoError *oerror)
390 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
392 switch (error->error_code) {
393 case MONO_ERROR_MISSING_METHOD:
394 mono_loader_set_error_method_load (get_type_name (error), error->member_name);
396 case MONO_ERROR_MISSING_FIELD:
397 mono_loader_set_error_field_load (error->klass, error->member_name);
399 case MONO_ERROR_TYPE_LOAD:
400 mono_loader_set_error_type_load (get_type_name (error), get_assembly_name (error));
402 case MONO_ERROR_FILE_NOT_FOUND:
403 /* XXX can't recover if it's ref only or not */
404 mono_loader_set_error_assembly_load (get_assembly_name (error), FALSE);
406 case MONO_ERROR_BAD_IMAGE:
407 mono_loader_set_error_bad_image (g_strdup (mono_internal_error_get_message (error)));
410 mono_loader_set_error_bad_image (g_strdup_printf ("Non translatable error: %s", mono_internal_error_get_message (error)));
415 mono_error_set_out_of_memory (MonoError *oerror, const char *msg_format, ...)
417 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
419 mono_error_prepare (error);
421 error->error_code = MONO_ERROR_OUT_OF_MEMORY;
422 va_start (args, msg_format);
423 g_vsnprintf (error->message, sizeof (error->message), msg_format, args);
428 mono_error_set_argument (MonoError *oerror, const char *argument, const char *msg_format, ...)
430 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
431 mono_error_prepare (error);
433 error->error_code = MONO_ERROR_ARGUMENT;
434 error->type_name = argument; /*use the first available string slot*/
436 set_error_message ();
440 mono_error_set_not_verifiable (MonoError *oerror, MonoMethod *method, const char *msg_format, ...)
442 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
443 mono_error_prepare (error);
445 error->error_code = MONO_ERROR_NOT_VERIFIABLE;
447 mono_error_set_class (oerror, method->klass);
448 mono_error_set_member_name (oerror, mono_method_full_name (method, 1));
451 set_error_message ();
456 get_type_name_as_mono_string (MonoErrorInternal *error, MonoDomain *domain, MonoError *error_out)
458 MonoString* res = NULL;
460 if (error->type_name) {
461 res = mono_string_new (domain, error->type_name);
463 } else if (error->klass) {
464 char *name = mono_type_full_name (&error->klass->byval_arg);
466 res = mono_string_new (domain, name);
471 mono_error_set_out_of_memory (error_out, "Could not allocate type name");
476 set_message_on_exception (MonoException *exception, MonoErrorInternal *error, MonoError *error_out)
478 MonoString *msg = mono_string_new (mono_domain_get (), mono_internal_error_get_message (error));
480 MONO_OBJECT_SETREF (exception, message, msg);
482 mono_error_set_out_of_memory (error_out, "Could not allocate exception object");
485 /*Can fail with out-of-memory*/
487 mono_error_prepare_exception (MonoError *oerror, MonoError *error_out)
489 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
491 MonoException* exception = NULL;
492 MonoString *assembly_name = NULL, *type_name = NULL, *method_name = NULL, *field_name = NULL, *msg = NULL;
493 MonoDomain *domain = mono_domain_get ();
495 mono_error_init (error_out);
497 switch (error->error_code) {
498 case MONO_ERROR_NONE:
501 case MONO_ERROR_MISSING_METHOD:
502 if ((error->type_name || error->klass) && error->member_name) {
503 type_name = get_type_name_as_mono_string (error, domain, error_out);
504 if (!mono_error_ok (error_out))
507 method_name = mono_string_new (domain, error->member_name);
509 mono_error_set_out_of_memory (error_out, "Could not allocate method name");
513 exception = mono_exception_from_name_two_strings (mono_defaults.corlib, "System", "MissingMethodException", type_name, method_name);
515 set_message_on_exception (exception, error, error_out);
517 exception = mono_exception_from_name_msg (mono_defaults.corlib, "System", "MissingMethodException", mono_internal_error_get_message (error));
521 case MONO_ERROR_MISSING_FIELD:
522 if ((error->type_name || error->klass) && error->member_name) {
523 type_name = get_type_name_as_mono_string (error, domain, error_out);
524 if (!mono_error_ok (error_out))
527 field_name = mono_string_new (domain, error->member_name);
529 mono_error_set_out_of_memory (error_out, "Could not allocate field name");
533 exception = mono_exception_from_name_two_strings (mono_defaults.corlib, "System", "MissingFieldException", type_name, field_name);
535 set_message_on_exception (exception, error, error_out);
537 exception = mono_exception_from_name_msg (mono_defaults.corlib, "System", "MissingFieldException", mono_internal_error_get_message (error));
541 case MONO_ERROR_TYPE_LOAD:
542 if (error->type_name || error->assembly_name) {
543 type_name = get_type_name_as_mono_string (error, domain, error_out);
544 if (!mono_error_ok (error_out))
547 if (error->assembly_name) {
548 assembly_name = mono_string_new (domain, error->assembly_name);
549 if (!assembly_name) {
550 mono_error_set_out_of_memory (error_out, "Could not allocate assembly name");
555 exception = mono_exception_from_name_two_strings (mono_get_corlib (), "System", "TypeLoadException", type_name, assembly_name);
557 set_message_on_exception (exception, error, error_out);
559 exception = mono_exception_from_name_msg (mono_defaults.corlib, "System", "TypeLoadException", mono_internal_error_get_message (error));
563 case MONO_ERROR_FILE_NOT_FOUND:
564 case MONO_ERROR_BAD_IMAGE:
565 if (error->assembly_name) {
566 msg = mono_string_new (domain, mono_internal_error_get_message (error));
568 mono_error_set_out_of_memory (error_out, "Could not allocate message");
572 if (error->assembly_name) {
573 assembly_name = mono_string_new (domain, error->assembly_name);
574 if (!assembly_name) {
575 mono_error_set_out_of_memory (error_out, "Could not allocate assembly name");
580 if (error->error_code == MONO_ERROR_FILE_NOT_FOUND)
581 exception = mono_exception_from_name_two_strings (mono_get_corlib (), "System.IO", "FileNotFoundException", msg, assembly_name);
583 exception = mono_exception_from_name_two_strings (mono_defaults.corlib, "System", "BadImageFormatException", msg, assembly_name);
585 if (error->error_code == MONO_ERROR_FILE_NOT_FOUND)
586 exception = mono_exception_from_name_msg (mono_get_corlib (), "System.IO", "FileNotFoundException", mono_internal_error_get_message (error));
588 exception = mono_exception_from_name_msg (mono_defaults.corlib, "System", "BadImageFormatException", mono_internal_error_get_message (error));
592 case MONO_ERROR_OUT_OF_MEMORY:
593 exception = mono_get_exception_out_of_memory ();
596 case MONO_ERROR_ARGUMENT:
597 exception = mono_get_exception_argument (error->type_name, mono_internal_error_get_message (error));
600 case MONO_ERROR_NOT_VERIFIABLE: {
601 char *type_name = NULL, *message;
603 type_name = mono_type_get_full_name (error->klass);
605 mono_error_set_out_of_memory (error_out, "Could not allocate message");
609 message = g_strdup_printf ("Error in %s:%s %s", type_name, error->member_name, mono_internal_error_get_message (error));
612 mono_error_set_out_of_memory (error_out, "Could not allocate message");
615 exception = mono_exception_from_name_msg (mono_defaults.corlib, "System.Security", "VerificationException", message);
620 case MONO_ERROR_GENERIC:
621 if (!error->exception_name_space || !error->exception_name)
622 mono_error_set_generic_error (error_out, "System", "ExecutionEngineException", "MonoError with generic error but no exception name was supplied");
624 exception = mono_exception_from_name_msg (mono_defaults.corlib, error->exception_name_space, error->exception_name, mono_internal_error_get_message (error));
628 mono_error_set_generic_error (error_out, "System", "ExecutionEngineException", "Invalid error-code %d", error->error_code);
631 if (!mono_error_ok (error_out))
634 mono_error_set_out_of_memory (error_out, "Could not allocate exception object");
639 Convert this MonoError to an exception if it's faulty or return NULL.
640 The error object is cleant after.
644 mono_error_convert_to_exception (MonoError *target_error)
649 if (mono_error_ok (target_error))
652 ex = mono_error_prepare_exception (target_error, &error);
653 if (!mono_error_ok (&error)) {
654 MonoError second_chance;
655 /*Try to produce the exception for the second error. FIXME maybe we should log about the original one*/
656 ex = mono_error_prepare_exception (&error, &second_chance);
658 g_assert (mono_error_ok (&second_chance)); /*We can't reasonable handle double faults, maybe later.*/
659 mono_error_cleanup (&error);
661 mono_error_cleanup (target_error);
667 Raises the exception of @error.
668 Does nothing if @error has a success error code.
669 Aborts in case of a double fault. This happens when it can't recover from an error caused by trying
670 to construct the first exception object.
671 The error object @error is cleaned up.
674 mono_error_raise_exception (MonoError *target_error)
676 MonoException *ex = mono_error_convert_to_exception (target_error);
678 mono_raise_exception (ex);