4 * Runtime and assembly configuration file support routines.
6 * Author: Paolo Molaro (lupus@ximian.com)
8 * Copyright 2002-2003 Ximian, Inc (http://www.ximian.com)
9 * Copyright 2004-2009 Novell, Inc (http://www.novell.com)
15 #include "mono/metadata/assembly.h"
16 #include "mono/metadata/loader.h"
17 #include "mono/metadata/mono-config.h"
18 #include "mono/metadata/metadata-internals.h"
19 #include "mono/metadata/object-internals.h"
20 #include "mono/utils/mono-logger-internal.h"
22 #if defined(TARGET_PS3)
23 #define CONFIG_OS "CellOS"
24 #elif defined(__linux__)
25 #define CONFIG_OS "linux"
26 #elif defined(__APPLE__)
27 #define CONFIG_OS "osx"
29 #define CONFIG_OS "solaris"
30 #elif defined(__FreeBSD__)
31 #define CONFIG_OS "freebsd"
32 #elif defined(__NetBSD__)
33 #define CONFIG_OS "netbsd"
34 #elif defined(__OpenBSD__)
35 #define CONFIG_OS "openbsd"
36 #elif defined(__WIN32__)
37 #define CONFIG_OS "windows"
39 #define CONFIG_OS "aix"
41 #define CONFIG_OS "hpux"
42 #elif defined(__HAIKU__)
43 #define CONFIG_OS "haiku"
45 #warning Unknown operating system
46 #define CONFIG_OS "unknownOS"
51 #define CONFIG_CPU "x86"
52 #define CONFIG_WORDSIZE "32"
53 #elif defined(__x86_64__)
54 #define CONFIG_CPU "x86-64"
55 #define CONFIG_WORDSIZE "64"
56 #elif defined(sparc) || defined(__sparc__)
57 #define CONFIG_CPU "sparc"
58 #define CONFIG_WORDSIZE "32"
59 #elif defined(__ppc64__) || defined(__powerpc64__) || defined(TARGET_POWERPC)
60 #define CONFIG_WORDSIZE "64"
61 #ifdef __mono_ppc_ilp32__
62 # define CONFIG_CPU "ppc64ilp32"
64 # define CONFIG_CPU "ppc64"
66 #elif defined(__ppc__) || defined(__powerpc__)
67 #define CONFIG_CPU "ppc"
68 #define CONFIG_WORDSIZE "32"
69 #elif defined(__s390x__)
70 #define CONFIG_CPU "s390x"
71 #define CONFIG_WORDSIZE "64"
72 #elif defined(__s390__)
73 #define CONFIG_CPU "s390"
74 #define CONFIG_WORDSIZE "32"
75 #elif defined(__arm__)
76 #define CONFIG_CPU "arm"
77 #define CONFIG_WORDSIZE "32"
78 #elif defined(__ia64__)
79 #define CONFIG_CPU "ia64"
80 #define CONFIG_WORDSIZE "64"
81 #elif defined(__alpha__)
82 #define CONFIG_CPU "alpha"
83 #define CONFIG_WORDSIZE "64"
84 #elif defined(hppa) || defined(__hppa__)
85 #define CONFIG_CPU "hppa"
86 #define CONFIG_WORDSIZE "32"
87 #elif defined(mips) || defined(__mips) || defined(_mips)
88 #define CONFIG_CPU "mips"
89 #define CONFIG_WORDSIZE "32"
92 #define CONFIG_CPU "unknownCPU"
96 static void start_element (GMarkupParseContext *context,
97 const gchar *element_name,
98 const gchar **attribute_names,
99 const gchar **attribute_values,
103 static void end_element (GMarkupParseContext *context,
104 const gchar *element_name,
108 static void parse_text (GMarkupParseContext *context,
114 static void passthrough (GMarkupParseContext *context,
120 static void parse_error (GMarkupParseContext *context,
124 static const GMarkupParser
133 static GHashTable *config_handlers;
135 /* when this interface is stable, export it. */
136 typedef struct MonoParseHandler MonoParseHandler;
138 struct MonoParseHandler {
139 const char *element_name;
140 void*(*init) (MonoImage *assembly);
141 void (*start) (gpointer user_data, const gchar *name,
142 const gchar **attributes,
143 const gchar **values);
144 void (*text) (gpointer user_data, const char *text, gsize test_len);
145 void (*end) (gpointer user_data, const char *name);
146 void (*finish) (gpointer user_data);
150 MonoAssemblyBindingInfo *info;
151 void (*info_parsed)(MonoAssemblyBindingInfo *info, void *user_data);
156 MonoParseHandler *current;
162 static void start_element (GMarkupParseContext *context,
163 const gchar *element_name,
164 const gchar **attribute_names,
165 const gchar **attribute_values,
169 ParseState *state = user_data;
170 if (!state->current) {
171 state->current = g_hash_table_lookup (config_handlers, element_name);
172 if (state->current && state->current->init)
173 state->user_data = state->current->init (state->assembly);
175 if (state->current && state->current->start)
176 state->current->start (state->user_data, element_name, attribute_names, attribute_values);
179 static void end_element (GMarkupParseContext *context,
180 const gchar *element_name,
184 ParseState *state = user_data;
185 if (state->current) {
186 if (state->current->end)
187 state->current->end (state->user_data, element_name);
188 if (strcmp (state->current->element_name, element_name) == 0) {
189 if (state->current->finish)
190 state->current->finish (state->user_data);
191 state->current = NULL;
192 state->user_data = NULL;
197 static void parse_text (GMarkupParseContext *context,
203 ParseState *state = user_data;
204 if (state->current && state->current->text)
205 state->current->text (state->user_data, text, text_len);
208 static void passthrough (GMarkupParseContext *context,
217 static void parse_error (GMarkupParseContext *context,
221 ParseState *state = user_data;
223 const gchar *filename;
225 filename = state && state->user_data ? (gchar *) state->user_data : "<unknown>";
226 msg = error && error->message ? error->message : "";
227 g_warning ("Error parsing %s: %s", filename, msg);
231 arch_matches (const char* arch, const char *value)
233 char **splitted, **p;
235 if (value [0] == '!')
236 return !arch_matches (arch, value + 1);
237 p = splitted = g_strsplit (value, ",", 0);
239 if (strcmp (arch, *p) == 0) {
245 g_strfreev (splitted);
257 dllmap_init (MonoImage *assembly) {
258 DllInfo *info = g_new0 (DllInfo, 1);
259 info->assembly = assembly;
264 dllmap_start (gpointer user_data,
265 const gchar *element_name,
266 const gchar **attribute_names,
267 const gchar **attribute_values)
270 DllInfo *info = user_data;
272 if (strcmp (element_name, "dllmap") == 0) {
274 g_free (info->target);
275 info->dll = info->target = NULL;
276 info->ignore = FALSE;
277 for (i = 0; attribute_names [i]; ++i) {
278 if (strcmp (attribute_names [i], "dll") == 0)
279 info->dll = g_strdup (attribute_values [i]);
280 else if (strcmp (attribute_names [i], "target") == 0)
281 info->target = g_strdup (attribute_values [i]);
282 else if (strcmp (attribute_names [i], "os") == 0 && !arch_matches (CONFIG_OS, attribute_values [i]))
284 else if (strcmp (attribute_names [i], "cpu") == 0 && !arch_matches (CONFIG_CPU, attribute_values [i]))
286 else if (strcmp (attribute_names [i], "wordsize") == 0 && !arch_matches (CONFIG_WORDSIZE, attribute_values [i]))
290 mono_dllmap_insert (info->assembly, info->dll, NULL, info->target, NULL);
291 } else if (strcmp (element_name, "dllentry") == 0) {
292 const char *name = NULL, *target = NULL, *dll = NULL;
294 for (i = 0; attribute_names [i]; ++i) {
295 if (strcmp (attribute_names [i], "dll") == 0)
296 dll = attribute_values [i];
297 else if (strcmp (attribute_names [i], "target") == 0)
298 target = attribute_values [i];
299 else if (strcmp (attribute_names [i], "name") == 0)
300 name = attribute_values [i];
301 else if (strcmp (attribute_names [i], "os") == 0 && !arch_matches (CONFIG_OS, attribute_values [i]))
303 else if (strcmp (attribute_names [i], "cpu") == 0 && !arch_matches (CONFIG_CPU, attribute_values [i]))
305 else if (strcmp (attribute_names [i], "wordsize") == 0 && !arch_matches (CONFIG_WORDSIZE, attribute_values [i]))
310 if (!info->ignore && !ignore)
311 mono_dllmap_insert (info->assembly, info->dll, name, dll, target);
316 dllmap_finish (gpointer user_data)
318 DllInfo *info = user_data;
321 g_free (info->target);
325 static const MonoParseHandler
336 legacyUEP_start (gpointer user_data,
337 const gchar *element_name,
338 const gchar **attribute_names,
339 const gchar **attribute_values) {
340 if ((strcmp (element_name, "legacyUnhandledExceptionPolicy") == 0) &&
341 (attribute_names [0] != NULL) &&
342 (strcmp (attribute_names [0], "enabled") == 0)) {
343 if ((strcmp (attribute_values [0], "1") == 0) ||
344 (g_ascii_strcasecmp (attribute_values [0], "true") == 0)) {
345 mono_runtime_unhandled_exception_policy_set (MONO_UNHANDLED_POLICY_LEGACY);
350 static const MonoParseHandler
351 legacyUEP_handler = {
352 "legacyUnhandledExceptionPolicy",
360 static int inited = 0;
363 mono_config_init (void)
366 config_handlers = g_hash_table_new (g_str_hash, g_str_equal);
367 g_hash_table_insert (config_handlers, (gpointer) dllmap_handler.element_name, (gpointer) &dllmap_handler);
368 g_hash_table_insert (config_handlers, (gpointer) legacyUEP_handler.element_name, (gpointer) &legacyUEP_handler);
371 /* FIXME: error handling */
374 mono_config_parse_xml_with_context (ParseState *state, const char *text, gsize len)
376 GMarkupParseContext *context;
381 context = g_markup_parse_context_new (&mono_parser, 0, state, NULL);
382 if (g_markup_parse_context_parse (context, text, len, NULL)) {
383 g_markup_parse_context_end_parse (context, NULL);
385 g_markup_parse_context_free (context);
388 /* If assembly is NULL, parse in the global context */
390 mono_config_parse_file_with_context (ParseState *state, const char *filename)
396 mono_trace (G_LOG_LEVEL_INFO, MONO_TRACE_CONFIG,
397 "Config attempting to parse: '%s'.", filename);
399 if (!g_file_get_contents (filename, &text, &len, NULL))
404 if (len > 3 && text [0] == '\xef' && text [1] == (gchar) '\xbb' && text [2] == '\xbf')
405 offset = 3; /* Skip UTF-8 BOM */
406 if (state->user_data == NULL)
407 state->user_data = (gpointer) filename;
408 mono_config_parse_xml_with_context (state, text + offset, len - offset);
414 * mono_config_parse_memory:
415 * @buffer: a pointer to an string XML representation of the configuration
417 * Parses the configuration from a buffer
420 mono_config_parse_memory (const char *buffer)
422 ParseState state = {NULL};
424 state.user_data = (gpointer) "<buffer>";
425 mono_config_parse_xml_with_context (&state, buffer, strlen (buffer));
429 mono_config_parse_file (const char *filename)
431 ParseState state = {NULL};
432 state.user_data = (gpointer) filename;
433 mono_config_parse_file_with_context (&state, filename);
437 * use the equivalent lookup code from the GAC when available.
438 * Depending on state, this should give something like:
439 * aname/version-pubtoken/
444 get_assembly_filename (MonoImage *image, int state)
448 return g_strdup (mono_image_get_name (image));
454 typedef struct _BundledConfig BundledConfig;
456 struct _BundledConfig {
459 const char* config_xml;
462 static BundledConfig *bundled_configs = NULL;
464 static const char *bundled_machine_config = NULL;
467 mono_register_config_for_assembly (const char* assembly_name, const char* config_xml)
469 BundledConfig *bconfig;
471 bconfig = g_new0 (BundledConfig, 1);
472 bconfig->aname = assembly_name;
473 bconfig->config_xml = config_xml;
474 bconfig->next = bundled_configs;
475 bundled_configs = bconfig;
479 mono_config_string_for_assembly_file (const char *filename)
481 BundledConfig *bconfig;
483 for (bconfig = bundled_configs; bconfig; bconfig = bconfig->next) {
484 if (bconfig->aname && strcmp (bconfig->aname, filename) == 0)
485 return bconfig->config_xml;
491 mono_config_for_assembly (MonoImage *assembly)
493 ParseState state = {NULL};
495 char *aname, *cfg, *cfg_name;
496 const char *bundled_config;
499 state.assembly = assembly;
501 bundled_config = mono_config_string_for_assembly_file (assembly->module_name);
502 if (bundled_config) {
503 state.user_data = (gpointer) "<bundled>";
504 mono_config_parse_xml_with_context (&state, bundled_config, strlen (bundled_config));
507 cfg_name = g_strdup_printf ("%s.config", mono_image_get_filename (assembly));
508 mono_config_parse_file_with_context (&state, cfg_name);
511 cfg_name = g_strdup_printf ("%s.config", mono_image_get_name (assembly));
513 home = g_get_home_dir ();
515 for (i = 0; (aname = get_assembly_filename (assembly, i)) != NULL; ++i) {
516 cfg = g_build_filename (mono_get_config_dir (), "mono", "assemblies", aname, cfg_name, NULL);
517 got_it += mono_config_parse_file_with_context (&state, cfg);
521 cfg = g_build_filename (home, ".mono", "assemblies", aname, cfg_name, NULL);
522 got_it += mono_config_parse_file_with_context (&state, cfg);
534 * @filename: the filename to load the configuration variables from.
536 * Pass a NULL filename to parse the default config files
537 * (or the file in the MONO_CONFIG env var).
540 mono_config_parse (const char *filename) {
548 mono_config_parse_file (filename);
552 home = g_getenv ("MONO_CONFIG");
554 mono_config_parse_file (home);
558 mono_cfg = g_build_filename (mono_get_config_dir (), "mono", "config", NULL);
559 mono_config_parse_file (mono_cfg);
563 home = g_get_home_dir ();
564 user_cfg = g_strconcat (home, G_DIR_SEPARATOR_S, ".mono/config", NULL);
565 mono_config_parse_file (user_cfg);
570 static const char *mono_cfg_dir = NULL;
572 /* Invoked during startup */
574 mono_set_config_dir (const char *dir)
576 /* If this variable is set, overrides the directory computed */
577 mono_cfg_dir = g_getenv ("MONO_CFG_DIR");
578 if (mono_cfg_dir == NULL)
579 mono_cfg_dir = g_strdup (dir);
583 mono_get_config_dir (void)
585 if (mono_cfg_dir == NULL)
586 mono_set_dirs (NULL, NULL);
592 mono_register_machine_config (const char *config_xml)
594 bundled_machine_config = config_xml;
598 mono_get_machine_config (void)
600 return bundled_machine_config;
604 assembly_binding_end (gpointer user_data, const char *element_name)
606 ParserUserData *pud = user_data;
608 if (!strcmp (element_name, "dependentAssembly")) {
609 if (pud->info_parsed && pud->info) {
610 pud->info_parsed (pud->info, pud->user_data);
611 g_free (pud->info->name);
612 g_free (pud->info->culture);
618 publisher_policy_start (gpointer user_data,
619 const gchar *element_name,
620 const gchar **attribute_names,
621 const gchar **attribute_values)
624 MonoAssemblyBindingInfo *info;
629 if (!strcmp (element_name, "dependentAssembly")) {
631 info->culture = NULL;
632 info->has_old_version_bottom = FALSE;
633 info->has_old_version_top = FALSE;
634 info->has_new_version = FALSE;
635 info->is_valid = FALSE;
636 memset (&info->old_version_bottom, 0, sizeof (info->old_version_bottom));
637 memset (&info->old_version_top, 0, sizeof (info->old_version_top));
638 memset (&info->new_version, 0, sizeof (info->new_version));
639 } if (!strcmp (element_name, "assemblyIdentity")) {
640 for (n = 0; attribute_names [n]; n++) {
641 const gchar *attribute_name = attribute_names [n];
643 if (!strcmp (attribute_name, "name"))
644 info->name = g_strdup (attribute_values [n]);
645 else if (!strcmp (attribute_name, "publicKeyToken")) {
646 if (strlen (attribute_values [n]) == MONO_PUBLIC_KEY_TOKEN_LENGTH - 1)
647 g_strlcpy ((char *) info->public_key_token, attribute_values [n], MONO_PUBLIC_KEY_TOKEN_LENGTH);
648 } else if (!strcmp (attribute_name, "culture")) {
649 if (!strcmp (attribute_values [n], "neutral"))
650 info->culture = g_strdup ("");
652 info->culture = g_strdup (attribute_values [n]);
655 } else if (!strcmp (element_name, "bindingRedirect")) {
656 for (n = 0; attribute_names [n]; n++) {
657 const gchar *attribute_name = attribute_names [n];
659 if (!strcmp (attribute_name, "oldVersion")) {
660 gchar **numbers, **version, **versions;
661 gint major, minor, build, revision;
664 if (!strcmp (attribute_values [n], ""))
667 versions = g_strsplit (attribute_values [n], "-", 2);
668 version = g_strsplit (*versions, ".", 4);
670 /* We assign the values to gint vars to do the checks */
672 major = *numbers ? atoi (*numbers++) : -1;
673 minor = *numbers ? atoi (*numbers++) : -1;
674 build = *numbers ? atoi (*numbers++) : -1;
675 revision = *numbers ? atoi (*numbers) : -1;
676 g_strfreev (version);
677 if (major < 0 || minor < 0 || build < 0 || revision < 0) {
678 g_strfreev (versions);
682 info->old_version_bottom.major = major;
683 info->old_version_bottom.minor = minor;
684 info->old_version_bottom.build = build;
685 info->old_version_bottom.revision = revision;
686 info->has_old_version_bottom = TRUE;
688 if (!*(versions + 1)) {
689 g_strfreev (versions);
693 numbers = version = g_strsplit (*(versions + 1), ".", 4);
694 major = *numbers ? atoi (*numbers++) : -1;
695 minor = *numbers ? atoi (*numbers++) : -1;
696 build = *numbers ? atoi (*numbers++) : -1;
697 revision = *numbers ? atoi (*numbers) : 1;
698 g_strfreev (version);
699 if (major < 0 || minor < 0 || build < 0 || revision < 0) {
700 g_strfreev (versions);
704 info->old_version_top.major = major;
705 info->old_version_top.minor = minor;
706 info->old_version_top.build = build;
707 info->old_version_top.revision = revision;
708 info->has_old_version_top = TRUE;
710 g_strfreev (versions);
711 } else if (!strcmp (attribute_name, "newVersion")) {
712 gchar **numbers, **version;
715 if (!strcmp (attribute_values [n], ""))
718 numbers = version = g_strsplit (attribute_values [n], ".", 4);
719 info->new_version.major = *numbers ? atoi (*numbers++) : -1;
720 info->new_version.minor = *numbers ? atoi (*numbers++) : -1;
721 info->new_version.build = *numbers ? atoi (*numbers++) : -1;
722 info->new_version.revision = *numbers ? atoi (*numbers) : -1;
723 info->has_new_version = TRUE;
724 g_strfreev (version);
730 static MonoParseHandler
731 publisher_policy_parser = {
732 "", /* We don't need to use declare an xml element */
734 publisher_policy_start,
741 mono_config_parse_publisher_policy (const gchar *filename, MonoAssemblyBindingInfo *info)
743 ParserUserData user_data = {
749 &publisher_policy_parser, /* MonoParseHandler */
750 &user_data, /* user_data */
751 NULL, /* MonoImage (we don't need it right now)*/
752 TRUE /* We are already inited */
755 mono_config_parse_file_with_context (&state, filename);
758 static MonoParseHandler
759 config_assemblybinding_parser = {
760 "", /* We don't need to use declare an xml element */
762 publisher_policy_start,
764 assembly_binding_end,
769 mono_config_parse_assembly_bindings (const char *filename, int amajor, int aminor, void *user_data, void (*infocb)(MonoAssemblyBindingInfo *info, void *user_data))
771 MonoAssemblyBindingInfo info;
779 pud.info_parsed = infocb;
780 pud.user_data = user_data;
782 state.current = &config_assemblybinding_parser; /* MonoParseHandler */
783 state.user_data = &pud;
784 state.assembly = NULL; /* MonoImage (we don't need it right now)*/
785 state.inited = TRUE; /* We are already inited */
787 mono_config_parse_file_with_context (&state, filename);