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)
10 * Licensed under the MIT license. See LICENSE file in the project root for full license information.
16 #include "mono/metadata/assembly.h"
17 #include "mono/metadata/loader.h"
18 #include "mono/metadata/mono-config.h"
19 #include "mono/metadata/metadata-internals.h"
20 #include "mono/metadata/object-internals.h"
21 #include "mono/utils/mono-logger-internals.h"
23 #if defined(TARGET_PS3)
24 #define CONFIG_OS "CellOS"
25 #elif defined(__linux__)
26 #define CONFIG_OS "linux"
27 #elif defined(__APPLE__)
28 #define CONFIG_OS "osx"
30 #define CONFIG_OS "solaris"
31 #elif defined(__FreeBSD__)
32 #define CONFIG_OS "freebsd"
33 #elif defined(__NetBSD__)
34 #define CONFIG_OS "netbsd"
35 #elif defined(__OpenBSD__)
36 #define CONFIG_OS "openbsd"
37 #elif defined(__WIN32__) || defined(TARGET_WIN32)
38 #define CONFIG_OS "windows"
40 #define CONFIG_OS "aix"
42 #define CONFIG_OS "hpux"
43 #elif defined(__HAIKU__)
44 #define CONFIG_OS "haiku"
46 #warning Unknown operating system
47 #define CONFIG_OS "unknownOS"
51 #if defined(__i386__) || defined(TARGET_X86)
52 #define CONFIG_CPU "x86"
53 #define CONFIG_WORDSIZE "32"
54 #elif defined(__x86_64__) || defined(TARGET_AMD64)
55 #define CONFIG_CPU "x86-64"
56 #define CONFIG_WORDSIZE "64"
57 #elif defined(sparc) || defined(__sparc__)
58 #define CONFIG_CPU "sparc"
59 #define CONFIG_WORDSIZE "32"
60 #elif defined(__ppc64__) || defined(__powerpc64__) || defined(TARGET_POWERPC)
61 #define CONFIG_WORDSIZE "64"
62 #ifdef __mono_ppc_ilp32__
63 # define CONFIG_CPU "ppc64ilp32"
65 # define CONFIG_CPU "ppc64"
67 #elif defined(__ppc__) || defined(__powerpc__)
68 #define CONFIG_CPU "ppc"
69 #define CONFIG_WORDSIZE "32"
70 #elif defined(__s390x__)
71 #define CONFIG_CPU "s390x"
72 #define CONFIG_WORDSIZE "64"
73 #elif defined(__s390__)
74 #define CONFIG_CPU "s390"
75 #define CONFIG_WORDSIZE "32"
76 #elif defined(__arm__)
77 #define CONFIG_CPU "arm"
78 #define CONFIG_WORDSIZE "32"
79 #elif defined(__aarch64__)
80 #define CONFIG_CPU "armv8"
81 #define CONFIG_WORDSIZE "64"
82 #elif defined(__ia64__)
83 #define CONFIG_CPU "ia64"
84 #define CONFIG_WORDSIZE "64"
85 #elif defined(mips) || defined(__mips) || defined(_mips)
86 #define CONFIG_CPU "mips"
87 #define CONFIG_WORDSIZE "32"
90 #define CONFIG_CPU "unknownCPU"
97 * Returns the operating system that Mono is running on, as used for dllmap entries.
100 mono_config_get_os (void)
106 * mono_config_get_cpu:
108 * Returns the architecture that Mono is running on, as used for dllmap entries.
111 mono_config_get_cpu (void)
117 * mono_config_get_wordsize:
119 * Returns the word size that Mono is running on, as used for dllmap entries.
122 mono_config_get_wordsize (void)
124 return CONFIG_WORDSIZE;
127 static void start_element (GMarkupParseContext *context,
128 const gchar *element_name,
129 const gchar **attribute_names,
130 const gchar **attribute_values,
134 static void end_element (GMarkupParseContext *context,
135 const gchar *element_name,
139 static void parse_text (GMarkupParseContext *context,
145 static void passthrough (GMarkupParseContext *context,
151 static void parse_error (GMarkupParseContext *context,
155 static const GMarkupParser
164 static GHashTable *config_handlers;
166 static char *mono_cfg_dir = NULL;
168 /* when this interface is stable, export it. */
169 typedef struct MonoParseHandler MonoParseHandler;
171 struct MonoParseHandler {
172 const char *element_name;
173 void*(*init) (MonoImage *assembly);
174 void (*start) (gpointer user_data, const gchar *name,
175 const gchar **attributes,
176 const gchar **values);
177 void (*text) (gpointer user_data, const char *text, gsize test_len);
178 void (*end) (gpointer user_data, const char *name);
179 void (*finish) (gpointer user_data);
183 MonoAssemblyBindingInfo *info;
184 void (*info_parsed)(MonoAssemblyBindingInfo *info, void *user_data);
189 MonoParseHandler *current;
195 static void start_element (GMarkupParseContext *context,
196 const gchar *element_name,
197 const gchar **attribute_names,
198 const gchar **attribute_values,
202 ParseState *state = (ParseState *)user_data;
203 if (!state->current) {
204 state->current = (MonoParseHandler *)g_hash_table_lookup (config_handlers, element_name);
205 if (state->current && state->current->init)
206 state->user_data = state->current->init (state->assembly);
208 if (state->current && state->current->start)
209 state->current->start (state->user_data, element_name, attribute_names, attribute_values);
212 static void end_element (GMarkupParseContext *context,
213 const gchar *element_name,
217 ParseState *state = (ParseState *)user_data;
218 if (state->current) {
219 if (state->current->end)
220 state->current->end (state->user_data, element_name);
221 if (strcmp (state->current->element_name, element_name) == 0) {
222 if (state->current->finish)
223 state->current->finish (state->user_data);
224 state->current = NULL;
225 state->user_data = NULL;
230 static void parse_text (GMarkupParseContext *context,
236 ParseState *state = (ParseState *)user_data;
237 if (state->current && state->current->text)
238 state->current->text (state->user_data, text, text_len);
241 static void passthrough (GMarkupParseContext *context,
250 static void parse_error (GMarkupParseContext *context,
254 ParseState *state = (ParseState *)user_data;
256 const gchar *filename;
258 filename = state && state->user_data ? (gchar *) state->user_data : "<unknown>";
259 msg = error && error->message ? error->message : "";
260 g_warning ("Error parsing %s: %s", filename, msg);
264 arch_matches (const char* arch, const char *value)
266 char **splitted, **p;
268 if (value [0] == '!')
269 return !arch_matches (arch, value + 1);
270 p = splitted = g_strsplit (value, ",", 0);
272 if (strcmp (arch, *p) == 0) {
278 g_strfreev (splitted);
290 dllmap_init (MonoImage *assembly) {
291 DllInfo *info = g_new0 (DllInfo, 1);
292 info->assembly = assembly;
297 dllmap_start (gpointer user_data,
298 const gchar *element_name,
299 const gchar **attribute_names,
300 const gchar **attribute_values)
303 DllInfo *info = (DllInfo *)user_data;
305 if (strcmp (element_name, "dllmap") == 0) {
307 g_free (info->target);
308 info->dll = info->target = NULL;
309 info->ignore = FALSE;
310 for (i = 0; attribute_names [i]; ++i) {
311 if (strcmp (attribute_names [i], "dll") == 0)
312 info->dll = g_strdup (attribute_values [i]);
313 else if (strcmp (attribute_names [i], "target") == 0){
314 char *p = strstr (attribute_values [i], "$mono_libdir");
316 char *libdir = mono_native_getrootdir ();
317 size_t libdir_len = strlen (libdir);
320 result = (char *)g_malloc (libdir_len-strlen("$mono_libdir")+strlen(attribute_values[i])+1);
321 strncpy (result, attribute_values[i], p-attribute_values[i]);
322 strcpy (result+(p-attribute_values[i]), libdir);
324 strcat (result, p+strlen("$mono_libdir"));
325 info->target = result;
327 info->target = g_strdup (attribute_values [i]);
328 } else if (strcmp (attribute_names [i], "os") == 0 && !arch_matches (CONFIG_OS, attribute_values [i]))
330 else if (strcmp (attribute_names [i], "cpu") == 0 && !arch_matches (CONFIG_CPU, attribute_values [i]))
332 else if (strcmp (attribute_names [i], "wordsize") == 0 && !arch_matches (CONFIG_WORDSIZE, attribute_values [i]))
336 mono_dllmap_insert (info->assembly, info->dll, NULL, info->target, NULL);
337 } else if (strcmp (element_name, "dllentry") == 0) {
338 const char *name = NULL, *target = NULL, *dll = NULL;
340 for (i = 0; attribute_names [i]; ++i) {
341 if (strcmp (attribute_names [i], "dll") == 0)
342 dll = attribute_values [i];
343 else if (strcmp (attribute_names [i], "target") == 0)
344 target = attribute_values [i];
345 else if (strcmp (attribute_names [i], "name") == 0)
346 name = attribute_values [i];
347 else if (strcmp (attribute_names [i], "os") == 0 && !arch_matches (CONFIG_OS, attribute_values [i]))
349 else if (strcmp (attribute_names [i], "cpu") == 0 && !arch_matches (CONFIG_CPU, attribute_values [i]))
351 else if (strcmp (attribute_names [i], "wordsize") == 0 && !arch_matches (CONFIG_WORDSIZE, attribute_values [i]))
356 if (!info->ignore && !ignore)
357 mono_dllmap_insert (info->assembly, info->dll, name, dll, target);
362 dllmap_finish (gpointer user_data)
364 DllInfo *info = (DllInfo *)user_data;
367 g_free (info->target);
371 static const MonoParseHandler
382 legacyUEP_start (gpointer user_data,
383 const gchar *element_name,
384 const gchar **attribute_names,
385 const gchar **attribute_values) {
386 if ((strcmp (element_name, "legacyUnhandledExceptionPolicy") == 0) &&
387 (attribute_names [0] != NULL) &&
388 (strcmp (attribute_names [0], "enabled") == 0)) {
389 if ((strcmp (attribute_values [0], "1") == 0) ||
390 (g_ascii_strcasecmp (attribute_values [0], "true") == 0)) {
391 mono_runtime_unhandled_exception_policy_set (MONO_UNHANDLED_POLICY_LEGACY);
396 static const MonoParseHandler
397 legacyUEP_handler = {
398 "legacyUnhandledExceptionPolicy",
407 aot_cache_start (gpointer user_data,
408 const gchar *element_name,
409 const gchar **attribute_names,
410 const gchar **attribute_values)
413 MonoAotCacheConfig *config;
415 if (strcmp (element_name, "aotcache") != 0)
418 config = mono_get_aot_cache_config ();
420 /* Per-app configuration */
421 for (i = 0; attribute_names [i]; ++i) {
422 if (!strcmp (attribute_names [i], "app")) {
423 config->apps = g_slist_prepend (config->apps, g_strdup (attribute_values [i]));
427 /* Global configuration */
428 for (i = 0; attribute_names [i]; ++i) {
429 if (!strcmp (attribute_names [i], "assemblies")) {
433 parts = g_strsplit (attribute_values [i], " ", -1);
434 for (ptr = parts; ptr && *ptr; ptr ++) {
436 config->assemblies = g_slist_prepend (config->assemblies, g_strdup (part));
439 } else if (!strcmp (attribute_names [i], "options")) {
440 config->aot_options = g_strdup (attribute_values [i]);
445 static const MonoParseHandler
446 aot_cache_handler = {
455 static int inited = 0;
458 mono_config_init (void)
461 config_handlers = g_hash_table_new (g_str_hash, g_str_equal);
462 g_hash_table_insert (config_handlers, (gpointer) dllmap_handler.element_name, (gpointer) &dllmap_handler);
463 g_hash_table_insert (config_handlers, (gpointer) legacyUEP_handler.element_name, (gpointer) &legacyUEP_handler);
464 g_hash_table_insert (config_handlers, (gpointer) aot_cache_handler.element_name, (gpointer) &aot_cache_handler);
468 * mono_config_cleanup:
471 mono_config_cleanup (void)
474 g_hash_table_destroy (config_handlers);
475 g_free (mono_cfg_dir);
478 /* FIXME: error handling */
481 mono_config_parse_xml_with_context (ParseState *state, const char *text, gsize len)
483 GMarkupParseContext *context;
488 context = g_markup_parse_context_new (&mono_parser, (GMarkupParseFlags)0, state, NULL);
489 if (g_markup_parse_context_parse (context, text, len, NULL)) {
490 g_markup_parse_context_end_parse (context, NULL);
492 g_markup_parse_context_free (context);
495 /* If assembly is NULL, parse in the global context */
497 mono_config_parse_file_with_context (ParseState *state, const char *filename)
503 mono_trace (G_LOG_LEVEL_INFO, MONO_TRACE_CONFIG,
504 "Config attempting to parse: '%s'.", filename);
506 if (!g_file_get_contents (filename, &text, &len, NULL))
510 if (len > 3 && text [0] == '\xef' && text [1] == (gchar) '\xbb' && text [2] == '\xbf')
511 offset = 3; /* Skip UTF-8 BOM */
512 if (state->user_data == NULL)
513 state->user_data = (gpointer) filename;
514 mono_config_parse_xml_with_context (state, text + offset, len - offset);
520 * mono_config_parse_memory:
521 * \param buffer a pointer to an string XML representation of the configuration
522 * Parses the configuration from a buffer
525 mono_config_parse_memory (const char *buffer)
527 ParseState state = {NULL};
529 state.user_data = (gpointer) "<buffer>";
530 mono_config_parse_xml_with_context (&state, buffer, strlen (buffer));
534 mono_config_parse_file (const char *filename)
536 ParseState state = {NULL};
537 state.user_data = (gpointer) filename;
538 mono_config_parse_file_with_context (&state, filename);
542 * use the equivalent lookup code from the GAC when available.
543 * Depending on state, this should give something like:
544 * aname/version-pubtoken/
549 get_assembly_filename (MonoImage *image, int state)
553 return g_strdup (mono_image_get_name (image));
559 typedef struct _BundledConfig BundledConfig;
561 struct _BundledConfig {
564 const char* config_xml;
567 static BundledConfig *bundled_configs = NULL;
569 static const char *bundled_machine_config = NULL;
572 * mono_register_config_for_assembly:
575 mono_register_config_for_assembly (const char* assembly_name, const char* config_xml)
577 BundledConfig *bconfig;
579 bconfig = g_new0 (BundledConfig, 1);
580 bconfig->aname = assembly_name;
581 bconfig->config_xml = config_xml;
582 bconfig->next = bundled_configs;
583 bundled_configs = bconfig;
587 * mono_config_string_for_assembly_file:
590 mono_config_string_for_assembly_file (const char *filename)
592 BundledConfig *bconfig;
594 for (bconfig = bundled_configs; bconfig; bconfig = bconfig->next) {
595 if (bconfig->aname && strcmp (bconfig->aname, filename) == 0)
596 return bconfig->config_xml;
602 * mono_config_for_assembly:
605 mono_config_for_assembly (MonoImage *assembly)
607 ParseState state = {NULL};
609 char *aname, *cfg, *cfg_name;
610 const char *bundled_config;
612 state.assembly = assembly;
614 bundled_config = mono_config_string_for_assembly_file (assembly->module_name);
615 if (bundled_config) {
616 state.user_data = (gpointer) "<bundled>";
617 mono_config_parse_xml_with_context (&state, bundled_config, strlen (bundled_config));
620 cfg_name = g_strdup_printf ("%s.config", mono_image_get_filename (assembly));
621 mono_config_parse_file_with_context (&state, cfg_name);
624 cfg_name = g_strdup_printf ("%s.config", mono_image_get_name (assembly));
626 for (i = 0; (aname = get_assembly_filename (assembly, i)) != NULL; ++i) {
627 cfg = g_build_filename (mono_get_config_dir (), "mono", "assemblies", aname, cfg_name, NULL);
628 got_it += mono_config_parse_file_with_context (&state, cfg);
632 const char *home = g_get_home_dir ();
633 cfg = g_build_filename (home, ".mono", "assemblies", aname, cfg_name, NULL);
634 got_it += mono_config_parse_file_with_context (&state, cfg);
646 * \param filename the filename to load the configuration variables from.
647 * Pass a NULL filename to parse the default config files
648 * (or the file in the \c MONO_CONFIG env var).
651 mono_config_parse (const char *filename) {
659 mono_config_parse_file (filename);
663 // FIXME: leak, do we store any references to home
664 char *env_home = g_getenv ("MONO_CONFIG");
666 mono_config_parse_file (env_home);
670 mono_cfg = g_build_filename (mono_get_config_dir (), "mono", "config", NULL);
671 mono_config_parse_file (mono_cfg);
674 #if !defined(TARGET_WIN32) && !defined(__native_client__)
675 home = g_get_home_dir ();
676 user_cfg = g_strconcat (home, G_DIR_SEPARATOR_S, ".mono/config", NULL);
677 mono_config_parse_file (user_cfg);
683 * mono_set_config_dir:
684 * Invoked during startup
687 mono_set_config_dir (const char *dir)
689 /* If this environment variable is set, overrides the directory computed */
690 char *env_mono_cfg_dir = g_getenv ("MONO_CFG_DIR");
691 if (env_mono_cfg_dir == NULL && dir != NULL)
692 env_mono_cfg_dir = strdup (dir);
694 mono_cfg_dir = env_mono_cfg_dir;
698 * mono_get_config_dir:
701 mono_get_config_dir (void)
703 if (mono_cfg_dir == NULL)
704 mono_set_dirs (NULL, NULL);
710 * mono_register_machine_config:
713 mono_register_machine_config (const char *config_xml)
715 bundled_machine_config = config_xml;
719 * mono_get_machine_config:
722 mono_get_machine_config (void)
724 return bundled_machine_config;
728 assembly_binding_end (gpointer user_data, const char *element_name)
730 ParserUserData *pud = (ParserUserData *)user_data;
732 if (!strcmp (element_name, "dependentAssembly")) {
733 if (pud->info_parsed && pud->info) {
734 pud->info_parsed (pud->info, pud->user_data);
735 g_free (pud->info->name);
736 g_free (pud->info->culture);
742 publisher_policy_start (gpointer user_data,
743 const gchar *element_name,
744 const gchar **attribute_names,
745 const gchar **attribute_values)
748 MonoAssemblyBindingInfo *info;
751 pud = (ParserUserData *)user_data;
753 if (!strcmp (element_name, "dependentAssembly")) {
755 info->culture = NULL;
756 info->has_old_version_bottom = FALSE;
757 info->has_old_version_top = FALSE;
758 info->has_new_version = FALSE;
759 info->is_valid = FALSE;
760 memset (&info->old_version_bottom, 0, sizeof (info->old_version_bottom));
761 memset (&info->old_version_top, 0, sizeof (info->old_version_top));
762 memset (&info->new_version, 0, sizeof (info->new_version));
763 } else if (!strcmp (element_name, "assemblyIdentity")) {
764 for (n = 0; attribute_names [n]; n++) {
765 const gchar *attribute_name = attribute_names [n];
767 if (!strcmp (attribute_name, "name"))
768 info->name = g_strdup (attribute_values [n]);
769 else if (!strcmp (attribute_name, "publicKeyToken")) {
770 if (strlen (attribute_values [n]) == MONO_PUBLIC_KEY_TOKEN_LENGTH - 1)
771 g_strlcpy ((char *) info->public_key_token, attribute_values [n], MONO_PUBLIC_KEY_TOKEN_LENGTH);
772 } else if (!strcmp (attribute_name, "culture")) {
773 if (!strcmp (attribute_values [n], "neutral"))
774 info->culture = g_strdup ("");
776 info->culture = g_strdup (attribute_values [n]);
779 } else if (!strcmp (element_name, "bindingRedirect")) {
780 for (n = 0; attribute_names [n]; n++) {
781 const gchar *attribute_name = attribute_names [n];
783 if (!strcmp (attribute_name, "oldVersion")) {
784 gchar **numbers, **version, **versions;
785 gint major, minor, build, revision;
788 if (!strcmp (attribute_values [n], ""))
791 versions = g_strsplit (attribute_values [n], "-", 2);
792 version = g_strsplit (*versions, ".", 4);
794 /* We assign the values to gint vars to do the checks */
796 major = *numbers ? atoi (*numbers++) : -1;
797 minor = *numbers ? atoi (*numbers++) : -1;
798 build = *numbers ? atoi (*numbers++) : -1;
799 revision = *numbers ? atoi (*numbers) : -1;
800 g_strfreev (version);
801 if (major < 0 || minor < 0 || build < 0 || revision < 0) {
802 g_strfreev (versions);
806 info->old_version_bottom.major = major;
807 info->old_version_bottom.minor = minor;
808 info->old_version_bottom.build = build;
809 info->old_version_bottom.revision = revision;
810 info->has_old_version_bottom = TRUE;
812 if (!*(versions + 1)) {
813 g_strfreev (versions);
817 numbers = version = g_strsplit (*(versions + 1), ".", 4);
818 major = *numbers ? atoi (*numbers++) : -1;
819 minor = *numbers ? atoi (*numbers++) : -1;
820 build = *numbers ? atoi (*numbers++) : -1;
821 revision = *numbers ? atoi (*numbers) : 1;
822 g_strfreev (version);
823 if (major < 0 || minor < 0 || build < 0 || revision < 0) {
824 g_strfreev (versions);
828 info->old_version_top.major = major;
829 info->old_version_top.minor = minor;
830 info->old_version_top.build = build;
831 info->old_version_top.revision = revision;
832 info->has_old_version_top = TRUE;
834 g_strfreev (versions);
835 } else if (!strcmp (attribute_name, "newVersion")) {
836 gchar **numbers, **version;
839 if (!strcmp (attribute_values [n], ""))
842 numbers = version = g_strsplit (attribute_values [n], ".", 4);
843 info->new_version.major = *numbers ? atoi (*numbers++) : -1;
844 info->new_version.minor = *numbers ? atoi (*numbers++) : -1;
845 info->new_version.build = *numbers ? atoi (*numbers++) : -1;
846 info->new_version.revision = *numbers ? atoi (*numbers) : -1;
847 info->has_new_version = TRUE;
848 g_strfreev (version);
854 static MonoParseHandler
855 publisher_policy_parser = {
856 "", /* We don't need to use declare an xml element */
858 publisher_policy_start,
865 mono_config_parse_publisher_policy (const gchar *filename, MonoAssemblyBindingInfo *info)
867 ParserUserData user_data = {
873 &publisher_policy_parser, /* MonoParseHandler */
874 &user_data, /* user_data */
875 NULL, /* MonoImage (we don't need it right now)*/
876 TRUE /* We are already inited */
879 mono_config_parse_file_with_context (&state, filename);
882 static MonoParseHandler
883 config_assemblybinding_parser = {
884 "", /* We don't need to use declare an xml element */
886 publisher_policy_start,
888 assembly_binding_end,
893 mono_config_parse_assembly_bindings (const char *filename, int amajor, int aminor, void *user_data, void (*infocb)(MonoAssemblyBindingInfo *info, void *user_data))
895 MonoAssemblyBindingInfo info;
903 pud.info_parsed = infocb;
904 pud.user_data = user_data;
906 state.current = &config_assemblybinding_parser; /* MonoParseHandler */
907 state.user_data = &pud;
908 state.assembly = NULL; /* MonoImage (we don't need it right now)*/
909 state.inited = TRUE; /* We are already inited */
911 mono_config_parse_file_with_context (&state, filename);
914 static mono_bool mono_server_mode = FALSE;
917 * mono_config_set_server_mode:
920 mono_config_set_server_mode (mono_bool server_mode)
922 mono_server_mode = server_mode;
926 * mono_config_is_server_mode:
929 mono_config_is_server_mode (void)
931 return mono_server_mode;