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 mono_internal_error_get_message(E) ((E)->full_message ? (E)->full_message : (E)->message)
19 #define set_error_message() do { \
21 va_start (args, msg_format); \
22 if (g_vsnprintf (error->message, sizeof (error->message), msg_format, args) >= sizeof (error->message)) {\
24 va_start (args, msg_format); \
25 if (!(error->full_message = g_strdup_vprintf (msg_format, args))) \
26 error->flags |= MONO_ERROR_INCOMPLETE; \
32 mono_error_prepare (MonoErrorInternal *error)
34 if (error->error_code != MONO_ERROR_NONE)
37 error->type_name = error->assembly_name = error->member_name = error->full_message = error->exception_name_space = error->exception_name = error->full_message_with_fields = NULL;
39 error->message [0] = 0;
43 get_type_name (MonoErrorInternal *error)
46 return error->type_name;
48 return error->klass->name;
49 return "<unknown type>";
53 get_assembly_name (MonoErrorInternal *error)
55 if (error->assembly_name)
56 return error->assembly_name;
57 if (error->klass && error->klass->image)
58 return error->klass->image->name;
59 return "<unknown assembly>";
63 mono_error_init_flags (MonoError *oerror, unsigned short flags)
65 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
66 g_assert (sizeof (MonoError) == sizeof (MonoErrorInternal));
68 error->error_code = MONO_ERROR_NONE;
73 mono_error_init (MonoError *error)
75 mono_error_init_flags (error, 0);
79 mono_error_cleanup (MonoError *oerror)
81 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
82 if (error->error_code == MONO_ERROR_NONE)
85 g_free ((char*)error->full_message);
86 g_free ((char*)error->full_message_with_fields);
87 if (!(error->flags & MONO_ERROR_FREE_STRINGS)) //no memory was allocated
90 g_free ((char*)error->type_name);
91 g_free ((char*)error->assembly_name);
92 g_free ((char*)error->member_name);
93 g_free ((char*)error->exception_name_space);
94 g_free ((char*)error->exception_name);
98 mono_error_ok (MonoError *error)
100 return error->error_code == MONO_ERROR_NONE;
104 mono_error_assert_ok (MonoError *error)
106 if (mono_error_ok (error))
109 g_error ("%s\n", mono_error_get_message (error));
113 mono_error_get_error_code (MonoError *error)
115 return error->error_code;
118 /*Return a pointer to the internal error message, might be NULL.
119 Caller should not release it.*/
121 mono_error_get_message (MonoError *oerror)
123 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
124 if (error->error_code == MONO_ERROR_NONE)
126 if (error->full_message_with_fields)
127 return error->full_message_with_fields;
129 error->full_message_with_fields = g_strdup_printf ("%s assembly:%s type:%s member:%s",
130 mono_internal_error_get_message (error),
131 get_assembly_name (error),
132 get_type_name (error),
133 error->member_name ? error->member_name : "<none>");
135 return error->full_message_with_fields ? error->full_message_with_fields : mono_internal_error_get_message (error);
139 * Inform that this error has heap allocated strings.
140 * The strings will be duplicated if @dup_strings is TRUE
141 * otherwise they will just be free'd in mono_error_cleanup.
144 mono_error_dup_strings (MonoError *oerror, gboolean dup_strings)
146 #define DUP_STR(field) do { if (error->field) {\
147 if (!(error->field = g_strdup (error->field))) \
148 error->flags |= MONO_ERROR_INCOMPLETE; \
151 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
152 error->flags |= MONO_ERROR_FREE_STRINGS;
156 DUP_STR (assembly_name);
157 DUP_STR (member_name);
158 DUP_STR (exception_name_space);
159 DUP_STR (exception_name);
165 mono_error_set_error (MonoError *oerror, int error_code, const char *msg_format, ...)
167 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
168 mono_error_prepare (error);
170 error->error_code = error_code;
171 set_error_message ();
175 mono_error_set_assembly_name (MonoError *oerror, const char *assembly_name)
177 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
178 g_assert (error->error_code != MONO_ERROR_NONE);
180 error->assembly_name = assembly_name;
184 mono_error_set_member_name (MonoError *oerror, const char *member_name)
186 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
188 error->member_name = member_name;
192 mono_error_set_type_name (MonoError *oerror, const char *type_name)
194 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
196 error->type_name = type_name;
200 mono_error_set_class (MonoError *oerror, MonoClass *klass)
202 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
204 error->klass = klass;
208 mono_error_set_corlib_exception (MonoError *oerror, const char *name_space, const char *name)
210 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
212 error->exception_name_space = name_space;
213 error->exception_name = name;
218 mono_error_set_assembly_load (MonoError *oerror, const char *assembly_name, const char *msg_format, ...)
220 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
221 mono_error_prepare (error);
223 error->error_code = MONO_ERROR_FILE_NOT_FOUND;
224 mono_error_set_assembly_name (oerror, assembly_name);
226 set_error_message ();
231 mono_error_set_assembly_load_simple (MonoError *oerror, const char *assembly_name, gboolean refection_only)
234 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.");
236 mono_error_set_assembly_load (oerror, assembly_name, "Could not load file or assembly or one of its dependencies.");
240 mono_error_set_type_load_class (MonoError *oerror, MonoClass *klass, const char *msg_format, ...)
242 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
243 mono_error_prepare (error);
245 error->error_code = MONO_ERROR_TYPE_LOAD;
246 mono_error_set_class (oerror, klass);
247 set_error_message ();
251 * Different than other functions, this one here assumes that type_name and assembly_name to have been allocated just for us.
252 * Which means mono_error_cleanup will free them.
255 mono_error_set_type_load_name (MonoError *oerror, const char *type_name, const char *assembly_name, const char *msg_format, ...)
257 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
258 mono_error_prepare (error);
260 error->error_code = MONO_ERROR_TYPE_LOAD;
261 mono_error_set_type_name (oerror, type_name);
262 mono_error_set_assembly_name (oerror, assembly_name);
263 mono_error_dup_strings (oerror, FALSE);
264 set_error_message ();
268 mono_error_set_method_load (MonoError *oerror, MonoClass *klass, const char *method_name, const char *msg_format, ...)
270 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
271 mono_error_prepare (error);
273 error->error_code = MONO_ERROR_MISSING_METHOD;
274 mono_error_set_class (oerror, klass);
275 mono_error_set_member_name (oerror, method_name);
276 set_error_message ();
280 mono_error_set_field_load (MonoError *oerror, MonoClass *klass, const char *field_name, const char *msg_format, ...)
282 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
283 mono_error_prepare (error);
285 error->error_code = MONO_ERROR_MISSING_FIELD;
286 mono_error_set_class (oerror, klass);
287 mono_error_set_member_name (oerror, field_name);
288 set_error_message ();
292 mono_error_set_bad_image_name (MonoError *oerror, const char *assembly_name, const char *msg_format, ...)
294 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
295 mono_error_prepare (error);
297 error->error_code = MONO_ERROR_BAD_IMAGE;
298 mono_error_set_assembly_name (oerror, assembly_name);
299 set_error_message ();
303 mono_error_set_bad_image (MonoError *oerror, MonoImage *image, const char *msg_format, ...)
305 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
306 mono_error_prepare (error);
308 error->error_code = MONO_ERROR_BAD_IMAGE;
309 error->assembly_name = image ? mono_image_get_name (image) : "<no_image>";
310 set_error_message ();
314 mono_error_set_generic_error (MonoError *oerror, const char * name_space, const char *name, const char *msg_format, ...)
316 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
317 mono_error_prepare (error);
319 error->error_code = MONO_ERROR_GENERIC;
320 mono_error_set_corlib_exception (oerror, name_space, name);
321 set_error_message ();
325 mono_error_set_from_loader_error (MonoError *oerror)
327 MonoLoaderError *loader_error = mono_loader_get_last_error ();
328 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
329 gboolean dup_strings = TRUE;
331 mono_error_prepare (error);
334 mono_error_set_generic_error (oerror, "System", "ExecutionEngineException", "Runtime tried to produce a mono-error from an empty loader-error");
338 switch (loader_error->exception_type) {
339 case MONO_EXCEPTION_NONE:
340 mono_error_set_generic_error (oerror, "System", "ExecutionEngineException", "Runtime tried to produce a mono-error from a non-error loader-error");
343 case MONO_EXCEPTION_INVALID_PROGRAM:
344 mono_error_set_generic_error (oerror, "System", "InvalidProgramException", "Failed for unknown reasons.");
347 case MONO_EXCEPTION_UNVERIFIABLE_IL:
348 mono_error_set_generic_error (oerror, "System.Security", "VerificationException", "Failed for unknown reasons.");
351 case MONO_EXCEPTION_MISSING_METHOD:
352 error->error_code = MONO_ERROR_MISSING_METHOD;
353 mono_error_set_type_name (oerror, loader_error->class_name);
354 mono_error_set_member_name (oerror, loader_error->member_name);
355 g_snprintf (error->message, sizeof (error->message), "Failed for unknown reasons.");
358 case MONO_EXCEPTION_MISSING_FIELD:
359 mono_error_set_field_load (oerror, loader_error->klass, loader_error->member_name, "Failed for unknown reasons.");
362 case MONO_EXCEPTION_TYPE_LOAD:
363 mono_error_set_type_load_name (oerror, g_strdup (loader_error->class_name), g_strdup (loader_error->assembly_name), "Failed for unknown reasons.");
367 case MONO_EXCEPTION_FILE_NOT_FOUND:
368 mono_error_set_assembly_load_simple (oerror, loader_error->assembly_name, loader_error->ref_only);
371 case MONO_EXCEPTION_METHOD_ACCESS:
372 mono_error_set_generic_error (oerror, "System", "MethodAccessException", "Failed for unknown reasons.");
375 case MONO_EXCEPTION_FIELD_ACCESS:
376 mono_error_set_generic_error (oerror, "System", "FieldAccessException", "Failed for unknown reasons.");
379 case MONO_EXCEPTION_OBJECT_SUPPLIED:
380 case MONO_EXCEPTION_GENERIC_SHARING_FAILED:
381 mono_error_set_generic_error (oerror, "System", "ExecutionEngineException", "Runtime tried to produce a mono-error from JIT internal error %d", loader_error->exception_type);
384 case MONO_EXCEPTION_BAD_IMAGE:
385 mono_error_set_bad_image_name (oerror, "<unknown>", "%s", loader_error->msg);
388 case MONO_EXCEPTION_OUT_OF_MEMORY:
389 mono_error_set_out_of_memory (oerror, "Failed for unknown reasons.");
393 mono_error_set_generic_error (oerror, "System", "ExecutionEngineException", "Runtime tried to produce an unknown loader-error %d", loader_error->exception_type);
397 mono_error_dup_strings (oerror, dup_strings);
398 mono_loader_clear_error ();
402 mono_loader_set_error_from_mono_error (MonoError *oerror)
404 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
406 switch (error->error_code) {
407 case MONO_ERROR_MISSING_METHOD:
408 mono_loader_set_error_method_load (get_type_name (error), error->member_name);
410 case MONO_ERROR_MISSING_FIELD:
411 mono_loader_set_error_field_load (error->klass, error->member_name);
413 case MONO_ERROR_TYPE_LOAD:
414 mono_loader_set_error_type_load (get_type_name (error), get_assembly_name (error));
416 case MONO_ERROR_FILE_NOT_FOUND:
417 /* XXX can't recover if it's ref only or not */
418 mono_loader_set_error_assembly_load (get_assembly_name (error), FALSE);
420 case MONO_ERROR_BAD_IMAGE:
421 mono_loader_set_error_bad_image (g_strdup (mono_internal_error_get_message (error)));
424 mono_loader_set_error_bad_image (g_strdup_printf ("Non translatable error: %s", mono_internal_error_get_message (error)));
429 mono_error_set_out_of_memory (MonoError *oerror, const char *msg_format, ...)
431 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
433 mono_error_prepare (error);
435 error->error_code = MONO_ERROR_OUT_OF_MEMORY;
436 va_start (args, msg_format);
437 g_vsnprintf (error->message, sizeof (error->message), msg_format, args);
442 mono_error_set_argument (MonoError *oerror, const char *argument, const char *msg_format, ...)
444 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
445 mono_error_prepare (error);
447 error->error_code = MONO_ERROR_ARGUMENT;
448 error->type_name = argument; /*use the first available string slot*/
450 set_error_message ();
454 mono_error_set_not_verifiable (MonoError *oerror, MonoMethod *method, const char *msg_format, ...)
456 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
457 mono_error_prepare (error);
459 error->error_code = MONO_ERROR_NOT_VERIFIABLE;
461 mono_error_set_class (oerror, method->klass);
462 mono_error_set_member_name (oerror, mono_method_full_name (method, 1));
465 set_error_message ();
470 get_type_name_as_mono_string (MonoErrorInternal *error, MonoDomain *domain, MonoError *error_out)
472 MonoString* res = NULL;
474 if (error->type_name) {
475 res = mono_string_new (domain, error->type_name);
477 } else if (error->klass) {
478 char *name = mono_type_full_name (&error->klass->byval_arg);
480 res = mono_string_new (domain, name);
485 mono_error_set_out_of_memory (error_out, "Could not allocate type name");
490 set_message_on_exception (MonoException *exception, MonoErrorInternal *error, MonoError *error_out)
492 MonoString *msg = mono_string_new (mono_domain_get (), mono_internal_error_get_message (error));
494 MONO_OBJECT_SETREF (exception, message, msg);
496 mono_error_set_out_of_memory (error_out, "Could not allocate exception object");
499 /*Can fail with out-of-memory*/
501 mono_error_prepare_exception (MonoError *oerror, MonoError *error_out)
503 MonoErrorInternal *error = (MonoErrorInternal*)oerror;
505 MonoException* exception = NULL;
506 MonoString *assembly_name = NULL, *type_name = NULL, *method_name = NULL, *field_name = NULL, *msg = NULL;
507 MonoDomain *domain = mono_domain_get ();
509 mono_error_init (error_out);
511 switch (error->error_code) {
512 case MONO_ERROR_NONE:
515 case MONO_ERROR_MISSING_METHOD:
516 if ((error->type_name || error->klass) && error->member_name) {
517 type_name = get_type_name_as_mono_string (error, domain, error_out);
518 if (!mono_error_ok (error_out))
521 method_name = mono_string_new (domain, error->member_name);
523 mono_error_set_out_of_memory (error_out, "Could not allocate method name");
527 exception = mono_exception_from_name_two_strings (mono_defaults.corlib, "System", "MissingMethodException", type_name, method_name);
529 set_message_on_exception (exception, error, error_out);
531 exception = mono_exception_from_name_msg (mono_defaults.corlib, "System", "MissingMethodException", mono_internal_error_get_message (error));
535 case MONO_ERROR_MISSING_FIELD:
536 if ((error->type_name || error->klass) && error->member_name) {
537 type_name = get_type_name_as_mono_string (error, domain, error_out);
538 if (!mono_error_ok (error_out))
541 field_name = mono_string_new (domain, error->member_name);
543 mono_error_set_out_of_memory (error_out, "Could not allocate field name");
547 exception = mono_exception_from_name_two_strings (mono_defaults.corlib, "System", "MissingFieldException", type_name, field_name);
549 set_message_on_exception (exception, error, error_out);
551 exception = mono_exception_from_name_msg (mono_defaults.corlib, "System", "MissingFieldException", mono_internal_error_get_message (error));
555 case MONO_ERROR_TYPE_LOAD:
556 if (error->type_name || error->assembly_name) {
557 type_name = get_type_name_as_mono_string (error, domain, error_out);
558 if (!mono_error_ok (error_out))
561 if (error->assembly_name) {
562 assembly_name = mono_string_new (domain, error->assembly_name);
563 if (!assembly_name) {
564 mono_error_set_out_of_memory (error_out, "Could not allocate assembly name");
569 exception = mono_exception_from_name_two_strings (mono_get_corlib (), "System", "TypeLoadException", type_name, assembly_name);
571 set_message_on_exception (exception, error, error_out);
573 exception = mono_exception_from_name_msg (mono_defaults.corlib, "System", "TypeLoadException", mono_internal_error_get_message (error));
577 case MONO_ERROR_FILE_NOT_FOUND:
578 case MONO_ERROR_BAD_IMAGE:
579 if (error->assembly_name) {
580 msg = mono_string_new (domain, mono_internal_error_get_message (error));
582 mono_error_set_out_of_memory (error_out, "Could not allocate message");
586 if (error->assembly_name) {
587 assembly_name = mono_string_new (domain, error->assembly_name);
588 if (!assembly_name) {
589 mono_error_set_out_of_memory (error_out, "Could not allocate assembly name");
594 if (error->error_code == MONO_ERROR_FILE_NOT_FOUND)
595 exception = mono_exception_from_name_two_strings (mono_get_corlib (), "System.IO", "FileNotFoundException", msg, assembly_name);
597 exception = mono_exception_from_name_two_strings (mono_defaults.corlib, "System", "BadImageFormatException", msg, assembly_name);
599 if (error->error_code == MONO_ERROR_FILE_NOT_FOUND)
600 exception = mono_exception_from_name_msg (mono_get_corlib (), "System.IO", "FileNotFoundException", mono_internal_error_get_message (error));
602 exception = mono_exception_from_name_msg (mono_defaults.corlib, "System", "BadImageFormatException", mono_internal_error_get_message (error));
606 case MONO_ERROR_OUT_OF_MEMORY:
607 exception = mono_get_exception_out_of_memory ();
610 case MONO_ERROR_ARGUMENT:
611 exception = mono_get_exception_argument (error->type_name, mono_internal_error_get_message (error));
614 case MONO_ERROR_NOT_VERIFIABLE: {
615 char *type_name = NULL, *message;
617 type_name = mono_type_get_full_name (error->klass);
619 mono_error_set_out_of_memory (error_out, "Could not allocate message");
623 message = g_strdup_printf ("Error in %s:%s %s", type_name, error->member_name, mono_internal_error_get_message (error));
626 mono_error_set_out_of_memory (error_out, "Could not allocate message");
629 exception = mono_exception_from_name_msg (mono_defaults.corlib, "System.Security", "VerificationException", message);
634 case MONO_ERROR_GENERIC:
635 if (!error->exception_name_space || !error->exception_name)
636 mono_error_set_generic_error (error_out, "System", "ExecutionEngineException", "MonoError with generic error but no exception name was supplied");
638 exception = mono_exception_from_name_msg (mono_defaults.corlib, error->exception_name_space, error->exception_name, mono_internal_error_get_message (error));
642 mono_error_set_generic_error (error_out, "System", "ExecutionEngineException", "Invalid error-code %d", error->error_code);
645 if (!mono_error_ok (error_out))
648 mono_error_set_out_of_memory (error_out, "Could not allocate exception object");
653 Convert this MonoError to an exception if it's faulty or return NULL.
654 The error object is cleant after.
658 mono_error_convert_to_exception (MonoError *target_error)
663 if (mono_error_ok (target_error))
666 ex = mono_error_prepare_exception (target_error, &error);
667 if (!mono_error_ok (&error)) {
668 MonoError second_chance;
669 /*Try to produce the exception for the second error. FIXME maybe we should log about the original one*/
670 ex = mono_error_prepare_exception (&error, &second_chance);
672 g_assert (mono_error_ok (&second_chance)); /*We can't reasonable handle double faults, maybe later.*/
673 mono_error_cleanup (&error);
675 mono_error_cleanup (target_error);