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__) || defined(TARGET_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"
50 #if defined(__i386__) || defined(TARGET_X86)
51 #define CONFIG_CPU "x86"
52 #define CONFIG_WORDSIZE "32"
53 #elif defined(__x86_64__) || defined(TARGET_AMD64)
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(__aarch64__)
79 #define CONFIG_CPU "armv8"
80 #define CONFIG_WORDSIZE "64"
81 #elif defined(__ia64__)
82 #define CONFIG_CPU "ia64"
83 #define CONFIG_WORDSIZE "64"
84 #elif defined(mips) || defined(__mips) || defined(_mips)
85 #define CONFIG_CPU "mips"
86 #define CONFIG_WORDSIZE "32"
89 #define CONFIG_CPU "unknownCPU"
93 static void start_element (GMarkupParseContext *context,
94 const gchar *element_name,
95 const gchar **attribute_names,
96 const gchar **attribute_values,
100 static void end_element (GMarkupParseContext *context,
101 const gchar *element_name,
105 static void parse_text (GMarkupParseContext *context,
111 static void passthrough (GMarkupParseContext *context,
117 static void parse_error (GMarkupParseContext *context,
121 static const GMarkupParser
130 static GHashTable *config_handlers;
132 static const char *mono_cfg_dir = NULL;
133 static char *mono_cfg_dir_allocated = NULL;
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 char *match = strstr (attribute_values [i], "$mono_libdir");
283 /* substitude $mono_libdir */
284 const char *libdir = mono_assembly_getrootdir ();
285 const int libdir_len = strlen (libdir);
286 const int varname_len = strlen ("$mono_libdir");
287 const int pre_len = match - attribute_values [i];
288 const int post_len = strlen (match) - varname_len + 3;
290 char *result = g_malloc (pre_len + libdir_len + post_len + 1);
291 g_strlcpy (result, attribute_values [i], pre_len);
292 strncat (result, libdir, libdir_len);
293 strncat (result, match + varname_len, post_len);
294 info->target = result;
296 info->target = g_strdup (attribute_values [i]);
297 } else if (strcmp (attribute_names [i], "os") == 0 && !arch_matches (CONFIG_OS, attribute_values [i]))
299 else if (strcmp (attribute_names [i], "cpu") == 0 && !arch_matches (CONFIG_CPU, attribute_values [i]))
301 else if (strcmp (attribute_names [i], "wordsize") == 0 && !arch_matches (CONFIG_WORDSIZE, attribute_values [i]))
305 mono_dllmap_insert (info->assembly, info->dll, NULL, info->target, NULL);
306 } else if (strcmp (element_name, "dllentry") == 0) {
307 const char *name = NULL, *target = NULL, *dll = NULL;
309 for (i = 0; attribute_names [i]; ++i) {
310 if (strcmp (attribute_names [i], "dll") == 0)
311 dll = attribute_values [i];
312 else if (strcmp (attribute_names [i], "target") == 0)
313 target = attribute_values [i];
314 else if (strcmp (attribute_names [i], "name") == 0)
315 name = attribute_values [i];
316 else if (strcmp (attribute_names [i], "os") == 0 && !arch_matches (CONFIG_OS, attribute_values [i]))
318 else if (strcmp (attribute_names [i], "cpu") == 0 && !arch_matches (CONFIG_CPU, attribute_values [i]))
320 else if (strcmp (attribute_names [i], "wordsize") == 0 && !arch_matches (CONFIG_WORDSIZE, attribute_values [i]))
325 if (!info->ignore && !ignore)
326 mono_dllmap_insert (info->assembly, info->dll, name, dll, target);
331 dllmap_finish (gpointer user_data)
333 DllInfo *info = user_data;
336 g_free (info->target);
340 static const MonoParseHandler
351 legacyUEP_start (gpointer user_data,
352 const gchar *element_name,
353 const gchar **attribute_names,
354 const gchar **attribute_values) {
355 if ((strcmp (element_name, "legacyUnhandledExceptionPolicy") == 0) &&
356 (attribute_names [0] != NULL) &&
357 (strcmp (attribute_names [0], "enabled") == 0)) {
358 if ((strcmp (attribute_values [0], "1") == 0) ||
359 (g_ascii_strcasecmp (attribute_values [0], "true") == 0)) {
360 mono_runtime_unhandled_exception_policy_set (MONO_UNHANDLED_POLICY_LEGACY);
365 static const MonoParseHandler
366 legacyUEP_handler = {
367 "legacyUnhandledExceptionPolicy",
376 aot_cache_start (gpointer user_data,
377 const gchar *element_name,
378 const gchar **attribute_names,
379 const gchar **attribute_values)
382 MonoAotCacheConfig *config;
384 if (strcmp (element_name, "aotcache") != 0)
387 config = mono_get_aot_cache_config ();
389 /* Per-app configuration */
390 for (i = 0; attribute_names [i]; ++i) {
391 if (!strcmp (attribute_names [i], "app")) {
392 config->apps = g_slist_prepend (config->apps, g_strdup (attribute_values [i]));
396 /* Global configuration */
397 for (i = 0; attribute_names [i]; ++i) {
398 if (!strcmp (attribute_names [i], "assemblies")) {
402 parts = g_strsplit (attribute_values [i], " ", -1);
403 for (ptr = parts; ptr && *ptr; ptr ++) {
405 config->assemblies = g_slist_prepend (config->assemblies, g_strdup (part));
408 } else if (!strcmp (attribute_names [i], "options")) {
409 config->aot_options = g_strdup (attribute_values [i]);
414 static const MonoParseHandler
415 aot_cache_handler = {
424 static int inited = 0;
427 mono_config_init (void)
430 config_handlers = g_hash_table_new (g_str_hash, g_str_equal);
431 g_hash_table_insert (config_handlers, (gpointer) dllmap_handler.element_name, (gpointer) &dllmap_handler);
432 g_hash_table_insert (config_handlers, (gpointer) legacyUEP_handler.element_name, (gpointer) &legacyUEP_handler);
433 g_hash_table_insert (config_handlers, (gpointer) aot_cache_handler.element_name, (gpointer) &aot_cache_handler);
437 mono_config_cleanup (void)
440 g_hash_table_destroy (config_handlers);
441 g_free (mono_cfg_dir_allocated);
444 /* FIXME: error handling */
447 mono_config_parse_xml_with_context (ParseState *state, const char *text, gsize len)
449 GMarkupParseContext *context;
454 context = g_markup_parse_context_new (&mono_parser, 0, state, NULL);
455 if (g_markup_parse_context_parse (context, text, len, NULL)) {
456 g_markup_parse_context_end_parse (context, NULL);
458 g_markup_parse_context_free (context);
461 /* If assembly is NULL, parse in the global context */
463 mono_config_parse_file_with_context (ParseState *state, const char *filename)
469 mono_trace (G_LOG_LEVEL_INFO, MONO_TRACE_CONFIG,
470 "Config attempting to parse: '%s'.", filename);
472 if (!g_file_get_contents (filename, &text, &len, NULL))
476 if (len > 3 && text [0] == '\xef' && text [1] == (gchar) '\xbb' && text [2] == '\xbf')
477 offset = 3; /* Skip UTF-8 BOM */
478 if (state->user_data == NULL)
479 state->user_data = (gpointer) filename;
480 mono_config_parse_xml_with_context (state, text + offset, len - offset);
486 * mono_config_parse_memory:
487 * @buffer: a pointer to an string XML representation of the configuration
489 * Parses the configuration from a buffer
492 mono_config_parse_memory (const char *buffer)
494 ParseState state = {NULL};
496 state.user_data = (gpointer) "<buffer>";
497 mono_config_parse_xml_with_context (&state, buffer, strlen (buffer));
501 mono_config_parse_file (const char *filename)
503 ParseState state = {NULL};
504 state.user_data = (gpointer) filename;
505 mono_config_parse_file_with_context (&state, filename);
509 * use the equivalent lookup code from the GAC when available.
510 * Depending on state, this should give something like:
511 * aname/version-pubtoken/
516 get_assembly_filename (MonoImage *image, int state)
520 return g_strdup (mono_image_get_name (image));
526 typedef struct _BundledConfig BundledConfig;
528 struct _BundledConfig {
531 const char* config_xml;
534 static BundledConfig *bundled_configs = NULL;
536 static const char *bundled_machine_config = NULL;
539 mono_register_config_for_assembly (const char* assembly_name, const char* config_xml)
541 BundledConfig *bconfig;
543 bconfig = g_new0 (BundledConfig, 1);
544 bconfig->aname = assembly_name;
545 bconfig->config_xml = config_xml;
546 bconfig->next = bundled_configs;
547 bundled_configs = bconfig;
551 mono_config_string_for_assembly_file (const char *filename)
553 BundledConfig *bconfig;
555 for (bconfig = bundled_configs; bconfig; bconfig = bconfig->next) {
556 if (bconfig->aname && strcmp (bconfig->aname, filename) == 0)
557 return bconfig->config_xml;
563 mono_config_for_assembly (MonoImage *assembly)
565 ParseState state = {NULL};
567 char *aname, *cfg, *cfg_name;
568 const char *bundled_config;
570 state.assembly = assembly;
572 bundled_config = mono_config_string_for_assembly_file (assembly->module_name);
573 if (bundled_config) {
574 state.user_data = (gpointer) "<bundled>";
575 mono_config_parse_xml_with_context (&state, bundled_config, strlen (bundled_config));
578 cfg_name = g_strdup_printf ("%s.config", mono_image_get_filename (assembly));
579 mono_config_parse_file_with_context (&state, cfg_name);
582 cfg_name = g_strdup_printf ("%s.config", mono_image_get_name (assembly));
584 for (i = 0; (aname = get_assembly_filename (assembly, i)) != NULL; ++i) {
585 cfg = g_build_filename (mono_get_config_dir (), "mono", "assemblies", aname, cfg_name, NULL);
586 got_it += mono_config_parse_file_with_context (&state, cfg);
590 const char *home = g_get_home_dir ();
591 cfg = g_build_filename (home, ".mono", "assemblies", aname, cfg_name, NULL);
592 got_it += mono_config_parse_file_with_context (&state, cfg);
604 * @filename: the filename to load the configuration variables from.
606 * Pass a NULL filename to parse the default config files
607 * (or the file in the MONO_CONFIG env var).
610 mono_config_parse (const char *filename) {
618 mono_config_parse_file (filename);
622 home = g_getenv ("MONO_CONFIG");
624 mono_config_parse_file (home);
628 mono_cfg = g_build_filename (mono_get_config_dir (), "mono", "config", NULL);
629 mono_config_parse_file (mono_cfg);
632 #if !defined(TARGET_WIN32) && !defined(__native_client__)
633 home = g_get_home_dir ();
634 user_cfg = g_strconcat (home, G_DIR_SEPARATOR_S, ".mono/config", NULL);
635 mono_config_parse_file (user_cfg);
640 /* Invoked during startup */
642 mono_set_config_dir (const char *dir)
644 /* If this variable is set, overrides the directory computed */
645 mono_cfg_dir = g_getenv ("MONO_CFG_DIR");
646 if (mono_cfg_dir == NULL)
647 mono_cfg_dir = mono_cfg_dir_allocated = g_strdup (dir);
651 mono_get_config_dir (void)
653 if (mono_cfg_dir == NULL)
654 mono_set_dirs (NULL, NULL);
660 mono_register_machine_config (const char *config_xml)
662 bundled_machine_config = config_xml;
666 mono_get_machine_config (void)
668 return bundled_machine_config;
672 assembly_binding_end (gpointer user_data, const char *element_name)
674 ParserUserData *pud = user_data;
676 if (!strcmp (element_name, "dependentAssembly")) {
677 if (pud->info_parsed && pud->info) {
678 pud->info_parsed (pud->info, pud->user_data);
679 g_free (pud->info->name);
680 g_free (pud->info->culture);
686 publisher_policy_start (gpointer user_data,
687 const gchar *element_name,
688 const gchar **attribute_names,
689 const gchar **attribute_values)
692 MonoAssemblyBindingInfo *info;
697 if (!strcmp (element_name, "dependentAssembly")) {
699 info->culture = NULL;
700 info->has_old_version_bottom = FALSE;
701 info->has_old_version_top = FALSE;
702 info->has_new_version = FALSE;
703 info->is_valid = FALSE;
704 memset (&info->old_version_bottom, 0, sizeof (info->old_version_bottom));
705 memset (&info->old_version_top, 0, sizeof (info->old_version_top));
706 memset (&info->new_version, 0, sizeof (info->new_version));
707 } if (!strcmp (element_name, "assemblyIdentity")) {
708 for (n = 0; attribute_names [n]; n++) {
709 const gchar *attribute_name = attribute_names [n];
711 if (!strcmp (attribute_name, "name"))
712 info->name = g_strdup (attribute_values [n]);
713 else if (!strcmp (attribute_name, "publicKeyToken")) {
714 if (strlen (attribute_values [n]) == MONO_PUBLIC_KEY_TOKEN_LENGTH - 1)
715 g_strlcpy ((char *) info->public_key_token, attribute_values [n], MONO_PUBLIC_KEY_TOKEN_LENGTH);
716 } else if (!strcmp (attribute_name, "culture")) {
717 if (!strcmp (attribute_values [n], "neutral"))
718 info->culture = g_strdup ("");
720 info->culture = g_strdup (attribute_values [n]);
723 } else if (!strcmp (element_name, "bindingRedirect")) {
724 for (n = 0; attribute_names [n]; n++) {
725 const gchar *attribute_name = attribute_names [n];
727 if (!strcmp (attribute_name, "oldVersion")) {
728 gchar **numbers, **version, **versions;
729 gint major, minor, build, revision;
732 if (!strcmp (attribute_values [n], ""))
735 versions = g_strsplit (attribute_values [n], "-", 2);
736 version = g_strsplit (*versions, ".", 4);
738 /* We assign the values to gint vars to do the checks */
740 major = *numbers ? atoi (*numbers++) : -1;
741 minor = *numbers ? atoi (*numbers++) : -1;
742 build = *numbers ? atoi (*numbers++) : -1;
743 revision = *numbers ? atoi (*numbers) : -1;
744 g_strfreev (version);
745 if (major < 0 || minor < 0 || build < 0 || revision < 0) {
746 g_strfreev (versions);
750 info->old_version_bottom.major = major;
751 info->old_version_bottom.minor = minor;
752 info->old_version_bottom.build = build;
753 info->old_version_bottom.revision = revision;
754 info->has_old_version_bottom = TRUE;
756 if (!*(versions + 1)) {
757 g_strfreev (versions);
761 numbers = version = g_strsplit (*(versions + 1), ".", 4);
762 major = *numbers ? atoi (*numbers++) : -1;
763 minor = *numbers ? atoi (*numbers++) : -1;
764 build = *numbers ? atoi (*numbers++) : -1;
765 revision = *numbers ? atoi (*numbers) : 1;
766 g_strfreev (version);
767 if (major < 0 || minor < 0 || build < 0 || revision < 0) {
768 g_strfreev (versions);
772 info->old_version_top.major = major;
773 info->old_version_top.minor = minor;
774 info->old_version_top.build = build;
775 info->old_version_top.revision = revision;
776 info->has_old_version_top = TRUE;
778 g_strfreev (versions);
779 } else if (!strcmp (attribute_name, "newVersion")) {
780 gchar **numbers, **version;
783 if (!strcmp (attribute_values [n], ""))
786 numbers = version = g_strsplit (attribute_values [n], ".", 4);
787 info->new_version.major = *numbers ? atoi (*numbers++) : -1;
788 info->new_version.minor = *numbers ? atoi (*numbers++) : -1;
789 info->new_version.build = *numbers ? atoi (*numbers++) : -1;
790 info->new_version.revision = *numbers ? atoi (*numbers) : -1;
791 info->has_new_version = TRUE;
792 g_strfreev (version);
798 static MonoParseHandler
799 publisher_policy_parser = {
800 "", /* We don't need to use declare an xml element */
802 publisher_policy_start,
809 mono_config_parse_publisher_policy (const gchar *filename, MonoAssemblyBindingInfo *info)
811 ParserUserData user_data = {
817 &publisher_policy_parser, /* MonoParseHandler */
818 &user_data, /* user_data */
819 NULL, /* MonoImage (we don't need it right now)*/
820 TRUE /* We are already inited */
823 mono_config_parse_file_with_context (&state, filename);
826 static MonoParseHandler
827 config_assemblybinding_parser = {
828 "", /* We don't need to use declare an xml element */
830 publisher_policy_start,
832 assembly_binding_end,
837 mono_config_parse_assembly_bindings (const char *filename, int amajor, int aminor, void *user_data, void (*infocb)(MonoAssemblyBindingInfo *info, void *user_data))
839 MonoAssemblyBindingInfo info;
847 pud.info_parsed = infocb;
848 pud.user_data = user_data;
850 state.current = &config_assemblybinding_parser; /* MonoParseHandler */
851 state.user_data = &pud;
852 state.assembly = NULL; /* MonoImage (we don't need it right now)*/
853 state.inited = TRUE; /* We are already inited */
855 mono_config_parse_file_with_context (&state, filename);
858 static mono_bool mono_server_mode = FALSE;
861 mono_config_set_server_mode (mono_bool server_mode)
863 mono_server_mode = server_mode;
867 mono_config_is_server_mode (void)
869 return mono_server_mode;