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 ();
192 mono_error_set_type_load_class (MonoError *oerror, MonoClass *klass, const char *msg_format, ...)
194 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
195 mono_error_prepare (error);
197 error->error_code = MONO_ERROR_TYPE_LOAD;
198 mono_error_set_class (oerror, klass);
199 set_error_message ();
203 * Different than other functions, this one here assumes that type_name and assembly_name to have been allocated just for us.
204 * Which means mono_error_cleanup will free them.
207 mono_error_set_type_load_name (MonoError *oerror, const char *type_name, const char *assembly_name, const char *msg_format, ...)
209 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
210 mono_error_prepare (error);
212 error->error_code = MONO_ERROR_TYPE_LOAD;
213 mono_error_set_type_name (oerror, type_name);
214 mono_error_set_assembly_name (oerror, assembly_name);
215 mono_error_dup_strings (oerror, FALSE);
216 set_error_message ();
220 mono_error_set_method_load (MonoError *oerror, MonoClass *klass, const char *method_name, const char *msg_format, ...)
222 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
223 mono_error_prepare (error);
225 error->error_code = MONO_ERROR_MISSING_METHOD;
226 mono_error_set_class (oerror, klass);
227 mono_error_set_member_name (oerror, method_name);
228 set_error_message ();
232 mono_error_set_field_load (MonoError *oerror, MonoClass *klass, const char *field_name, const char *msg_format, ...)
234 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
235 mono_error_prepare (error);
237 error->error_code = MONO_ERROR_MISSING_FIELD;
238 mono_error_set_class (oerror, klass);
239 mono_error_set_member_name (oerror, field_name);
240 set_error_message ();
244 mono_error_set_bad_image_name (MonoError *oerror, const char *assembly_name, const char *msg_format, ...)
246 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
247 mono_error_prepare (error);
249 error->error_code = MONO_ERROR_BAD_IMAGE;
250 mono_error_set_assembly_name (oerror, assembly_name);
251 set_error_message ();
255 mono_error_set_bad_image (MonoError *oerror, MonoImage *image, const char *msg_format, ...)
257 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
258 mono_error_prepare (error);
260 error->error_code = MONO_ERROR_BAD_IMAGE;
261 error->assembly_name = image ? mono_image_get_name (image) : "<no_image>";
262 set_error_message ();
266 mono_error_set_generic_error (MonoError *oerror, const char * name_space, const char *name, const char *msg_format, ...)
268 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
269 mono_error_prepare (error);
271 error->error_code = MONO_ERROR_GENERIC;
272 mono_error_set_corlib_exception (oerror, name_space, name);
273 set_error_message ();
277 mono_error_set_from_loader_error (MonoError *oerror)
279 MonoLoaderError *loader_error = mono_loader_get_last_error ();
280 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
281 gboolean dup_strings = TRUE;
283 mono_error_prepare (error);
286 mono_error_set_generic_error (oerror, "System", "ExecutionEngineException", "Runtime tried to produce a mono-error from an empty loader-error");
290 switch (loader_error->exception_type) {
291 case MONO_EXCEPTION_NONE:
292 mono_error_set_generic_error (oerror, "System", "ExecutionEngineException", "Runtime tried to produce a mono-error from a non-error loader-error");
294 case MONO_EXCEPTION_SECURITY_LINKDEMAND:
295 case MONO_EXCEPTION_SECURITY_INHERITANCEDEMAND:
296 mono_error_set_generic_error (oerror, "System.Security", "SecurityException", "Failed for unknown reasons.");
299 case MONO_EXCEPTION_INVALID_PROGRAM:
300 mono_error_set_generic_error (oerror, "System", "InvalidProgramException", "Failed for unknown reasons.");
303 case MONO_EXCEPTION_UNVERIFIABLE_IL:
304 mono_error_set_generic_error (oerror, "System.Security", "VerificationException", "Failed for unknown reasons.");
307 case MONO_EXCEPTION_MISSING_METHOD:
308 error->error_code = MONO_ERROR_MISSING_METHOD;
309 mono_error_set_type_name (oerror, loader_error->class_name);
310 mono_error_set_member_name (oerror, loader_error->member_name);
311 g_snprintf (error->message, sizeof (error->message), "Failed for unknown reasons.");
314 case MONO_EXCEPTION_MISSING_FIELD:
315 mono_error_set_field_load (oerror, loader_error->klass, loader_error->member_name, "Failed for unknown reasons.");
318 case MONO_EXCEPTION_TYPE_LOAD:
319 mono_error_set_type_load_name (oerror, g_strdup (loader_error->class_name), g_strdup (loader_error->assembly_name), "Failed for unknown reasons.");
323 case MONO_EXCEPTION_FILE_NOT_FOUND:
324 if (loader_error->ref_only)
325 mono_error_set_assembly_load (oerror, loader_error->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.");
327 mono_error_set_assembly_load (oerror, loader_error->assembly_name, "Could not load file or assembly or one of its dependencies.");
330 case MONO_EXCEPTION_METHOD_ACCESS:
331 mono_error_set_generic_error (oerror, "System", "MethodAccessException", "Failed for unknown reasons.");
334 case MONO_EXCEPTION_FIELD_ACCESS:
335 mono_error_set_generic_error (oerror, "System", "FieldAccessException", "Failed for unknown reasons.");
338 case MONO_EXCEPTION_OBJECT_SUPPLIED:
339 case MONO_EXCEPTION_GENERIC_SHARING_FAILED:
340 mono_error_set_generic_error (oerror, "System", "ExecutionEngineException", "Runtime tried to produce a mono-error from JIT internal error %d", loader_error->exception_type);
343 case MONO_EXCEPTION_BAD_IMAGE:
344 mono_error_set_bad_image_name (oerror, "<unknown>", "%s", loader_error->msg);
347 case MONO_EXCEPTION_OUT_OF_MEMORY:
348 mono_error_set_out_of_memory (oerror, "Failed for unknown reasons.");
352 mono_error_set_generic_error (oerror, "System", "ExecutionEngineException", "Runtime tried to produce an unknown loader-error %d", loader_error->exception_type);
356 mono_error_dup_strings (oerror, dup_strings);
357 mono_loader_clear_error ();
361 get_type_name (MonoErrorInternal *error)
363 if (error->type_name)
364 return error->type_name;
366 return error->klass->name;
367 return "<unknown type>";
371 get_assembly_name (MonoErrorInternal *error)
373 if (error->assembly_name)
374 return error->assembly_name;
375 if (error->klass && error->klass->image)
376 return error->klass->image->name;
377 return "<unknown assembly>";
381 mono_loader_set_error_from_mono_error (MonoError *oerror)
383 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
385 switch (error->error_code) {
386 case MONO_ERROR_MISSING_METHOD:
387 mono_loader_set_error_method_load (get_type_name (error), error->member_name);
389 case MONO_ERROR_MISSING_FIELD:
390 mono_loader_set_error_field_load (error->klass, error->member_name);
392 case MONO_ERROR_TYPE_LOAD:
393 mono_loader_set_error_type_load (get_type_name (error), get_assembly_name (error));
395 case MONO_ERROR_FILE_NOT_FOUND:
396 /* XXX can't recover if it's ref only or not */
397 mono_loader_set_error_assembly_load (get_assembly_name (error), FALSE);
399 case MONO_ERROR_BAD_IMAGE:
400 mono_loader_set_error_bad_image (g_strdup (mono_internal_error_get_message (error)));
403 mono_loader_set_error_bad_image (g_strdup_printf ("Non translatable error: %s", mono_internal_error_get_message (error)));
408 mono_error_set_out_of_memory (MonoError *oerror, const char *msg_format, ...)
410 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
412 mono_error_prepare (error);
414 error->error_code = MONO_ERROR_OUT_OF_MEMORY;
415 va_start (args, msg_format);
416 g_vsnprintf (error->message, sizeof (error->message), msg_format, args);
421 mono_error_set_argument (MonoError *oerror, const char *argument, const char *msg_format, ...)
423 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
424 mono_error_prepare (error);
426 error->error_code = MONO_ERROR_ARGUMENT;
427 error->type_name = argument; /*use the first available string slot*/
429 set_error_message ();
433 mono_error_set_not_verifiable (MonoError *oerror, MonoMethod *method, const char *msg_format, ...)
435 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
436 mono_error_prepare (error);
438 error->error_code = MONO_ERROR_NOT_VERIFIABLE;
440 mono_error_set_class (oerror, method->klass);
441 mono_error_set_member_name (oerror, mono_method_full_name (method, 1));
444 set_error_message ();
449 get_type_name_as_mono_string (MonoErrorInternal *error, MonoDomain *domain, MonoError *error_out)
451 MonoString* res = NULL;
453 if (error->type_name) {
454 res = mono_string_new (domain, error->type_name);
456 } else if (error->klass) {
457 char *name = mono_type_full_name (&error->klass->byval_arg);
459 res = mono_string_new (domain, name);
464 mono_error_set_out_of_memory (error_out, "Could not allocate type name");
469 set_message_on_exception (MonoException *exception, MonoErrorInternal *error, MonoError *error_out)
471 MonoString *msg = mono_string_new (mono_domain_get (), mono_internal_error_get_message (error));
473 MONO_OBJECT_SETREF (exception, message, msg);
475 mono_error_set_out_of_memory (error_out, "Could not allocate exception object");
478 /*Can fail with out-of-memory*/
480 mono_error_prepare_exception (MonoError *oerror, MonoError *error_out)
482 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
484 MonoException* exception = NULL;
485 MonoString *assembly_name = NULL, *type_name = NULL, *method_name = NULL, *field_name = NULL, *msg = NULL;
486 MonoDomain *domain = mono_domain_get ();
488 mono_error_init (error_out);
490 switch (error->error_code) {
491 case MONO_ERROR_NONE:
494 case MONO_ERROR_MISSING_METHOD:
495 if ((error->type_name || error->klass) && error->member_name) {
496 type_name = get_type_name_as_mono_string (error, domain, error_out);
497 if (!mono_error_ok (error_out))
500 method_name = mono_string_new (domain, error->member_name);
502 mono_error_set_out_of_memory (error_out, "Could not allocate method name");
506 exception = mono_exception_from_name_two_strings (mono_defaults.corlib, "System", "MissingMethodException", type_name, method_name);
508 set_message_on_exception (exception, error, error_out);
510 exception = mono_exception_from_name_msg (mono_defaults.corlib, "System", "MissingMethodException", mono_internal_error_get_message (error));
514 case MONO_ERROR_MISSING_FIELD:
515 if ((error->type_name || error->klass) && error->member_name) {
516 type_name = get_type_name_as_mono_string (error, domain, error_out);
517 if (!mono_error_ok (error_out))
520 field_name = mono_string_new (domain, error->member_name);
522 mono_error_set_out_of_memory (error_out, "Could not allocate field name");
526 exception = mono_exception_from_name_two_strings (mono_defaults.corlib, "System", "MissingFieldException", type_name, field_name);
528 set_message_on_exception (exception, error, error_out);
530 exception = mono_exception_from_name_msg (mono_defaults.corlib, "System", "MissingFieldException", mono_internal_error_get_message (error));
534 case MONO_ERROR_TYPE_LOAD:
535 if (error->type_name || error->assembly_name) {
536 type_name = get_type_name_as_mono_string (error, domain, error_out);
537 if (!mono_error_ok (error_out))
540 if (error->assembly_name) {
541 assembly_name = mono_string_new (domain, error->assembly_name);
542 if (!assembly_name) {
543 mono_error_set_out_of_memory (error_out, "Could not allocate assembly name");
548 exception = mono_exception_from_name_two_strings (mono_get_corlib (), "System", "TypeLoadException", type_name, assembly_name);
550 set_message_on_exception (exception, error, error_out);
552 exception = mono_exception_from_name_msg (mono_defaults.corlib, "System", "TypeLoadException", mono_internal_error_get_message (error));
556 case MONO_ERROR_FILE_NOT_FOUND:
557 case MONO_ERROR_BAD_IMAGE:
558 if (error->assembly_name) {
559 msg = mono_string_new (domain, mono_internal_error_get_message (error));
561 mono_error_set_out_of_memory (error_out, "Could not allocate message");
565 if (error->assembly_name) {
566 assembly_name = mono_string_new (domain, error->assembly_name);
567 if (!assembly_name) {
568 mono_error_set_out_of_memory (error_out, "Could not allocate assembly name");
573 if (error->error_code == MONO_ERROR_FILE_NOT_FOUND)
574 exception = mono_exception_from_name_two_strings (mono_get_corlib (), "System.IO", "FileNotFoundException", msg, assembly_name);
576 exception = mono_exception_from_name_two_strings (mono_defaults.corlib, "System", "BadImageFormatException", msg, assembly_name);
578 if (error->error_code == MONO_ERROR_FILE_NOT_FOUND)
579 exception = mono_exception_from_name_msg (mono_get_corlib (), "System.IO", "FileNotFoundException", mono_internal_error_get_message (error));
581 exception = mono_exception_from_name_msg (mono_defaults.corlib, "System", "BadImageFormatException", mono_internal_error_get_message (error));
585 case MONO_ERROR_OUT_OF_MEMORY:
586 exception = mono_get_exception_out_of_memory ();
589 case MONO_ERROR_ARGUMENT:
590 exception = mono_get_exception_argument (error->type_name, mono_internal_error_get_message (error));
593 case MONO_ERROR_NOT_VERIFIABLE: {
594 char *type_name = NULL, *message;
596 type_name = mono_type_get_full_name (error->klass);
598 mono_error_set_out_of_memory (error_out, "Could not allocate message");
602 message = g_strdup_printf ("Error in %s:%s %s", type_name, error->member_name, mono_internal_error_get_message (error));
605 mono_error_set_out_of_memory (error_out, "Could not allocate message");
608 exception = mono_exception_from_name_msg (mono_defaults.corlib, "System.Security", "VerificationException", message);
613 case MONO_ERROR_GENERIC:
614 if (!error->exception_name_space || !error->exception_name)
615 mono_error_set_generic_error (error_out, "System", "ExecutionEngineException", "MonoError with generic error but no exception name was supplied");
617 exception = mono_exception_from_name_msg (mono_defaults.corlib, error->exception_name_space, error->exception_name, mono_internal_error_get_message (error));
621 mono_error_set_generic_error (error_out, "System", "ExecutionEngineException", "Invalid error-code %d", error->error_code);
624 if (!mono_error_ok (error_out))
627 mono_error_set_out_of_memory (error_out, "Could not allocate exception object");
632 Raises the exception of @error.
633 Does nothing if @error has a success error code.
634 Aborts in case of a double fault. This happens when it can't recover from an error caused by trying
635 to construct the first exception object.
636 The error object @error is cleaned up.
639 mono_error_raise_exception (MonoError *target_error)
644 if (mono_error_ok (target_error))
647 ex = mono_error_prepare_exception (target_error, &error);
648 if (!mono_error_ok (&error)) {
649 MonoError second_chance;
650 /*Try to produce the exception for the second error. FIXME maybe we should log about the original one*/
651 ex = mono_error_prepare_exception (&error, &second_chance);
653 g_assert (mono_error_ok (&second_chance)); /*We can't reasonable handle double faults, maybe later.*/
654 mono_error_cleanup (&error);
656 mono_error_cleanup (target_error);
658 mono_raise_exception (ex);