2 * assembly.c: Routines for loading assemblies.
5 * Miguel de Icaza (miguel@ximian.com)
7 * (C) 2001 Ximian, Inc. http://www.ximian.com
10 * Implement big-endian versions of the reading routines.
21 #include "rawbuffer.h"
23 #include "mono-bundle.h"
25 #include <mono/io-layer/io-layer.h>
27 /* the default search path is just MONO_ASSEMBLIES */
34 static char **assemblies_path = NULL;
37 * keeps track of loaded assemblies
39 static GList *loaded_assemblies = NULL;
40 static MonoAssembly *corlib;
42 /* This protects loaded_assemblies and image->references */
43 static CRITICAL_SECTION assemblies_mutex;
45 /* A hastable of thread->assembly list mappings */
46 static GHashTable *assemblies_loading;
51 init_default_path (void)
55 default_path [0] = g_strdup (MONO_ASSEMBLIES);
56 for (i = strlen (MONO_ASSEMBLIES) - 1; i >= 0; i--) {
57 if (default_path [0][i] == '/')
58 ((char*) default_path [0])[i] = '\\';
68 path = getenv ("MONO_PATH");
71 splitted = g_strsplit (path, G_SEARCHPATH_SEPARATOR_S, 1000);
73 g_strfreev (assemblies_path);
74 assemblies_path = splitted;
77 /* assemblies_mutex must be held by the caller */
79 search_loaded (MonoAssemblyName* aname)
85 for (tmp = loaded_assemblies; tmp; tmp = tmp->next) {
89 /* we just compare the name, but later we'll do all the checks */
90 /* g_print ("compare %s %s\n", aname->name, ass->aname.name); */
91 if (strcmp (aname->name, ass->aname.name))
93 /* g_print ("success\n"); */
99 * The assembly might be under load by this thread. In this case, it is
100 * safe to return an incomplete instance to prevent loops.
102 loading = g_hash_table_lookup (assemblies_loading, GetCurrentThread ());
103 for (tmp = loading; tmp; tmp = tmp->next) {
105 if (!ass->aname.name)
107 if (strcmp (aname->name, ass->aname.name))
116 static MonoAssembly *
117 load_in_path (const char *basename, const char** search_path, MonoImageOpenStatus *status)
121 MonoAssembly *result;
123 for (i = 0; search_path [i]; ++i) {
124 fullpath = g_build_filename (search_path [i], basename, NULL);
125 result = mono_assembly_open (fullpath, status);
134 * mono_assembly_setrootdir:
135 * @root_dir: The pathname of the root directory where we will locate assemblies
137 * This routine sets the internal default root directory for looking up
138 * assemblies. This is used by Windows installations to compute dynamically
139 * the place where the Mono assemblies are located.
143 mono_assembly_setrootdir (const char *root_dir)
146 * Override the MONO_ASSEMBLIES directory configured at compile time.
148 /* Leak if called more than once */
149 default_path [0] = g_strdup (root_dir);
153 * mono_assemblies_init:
155 * Initialize global variables used by this module.
158 mono_assemblies_init (void)
160 #ifdef PLATFORM_WIN32
161 init_default_path ();
166 InitializeCriticalSection (&assemblies_mutex);
168 assemblies_loading = g_hash_table_new (NULL, NULL);
172 mono_assembly_fill_assembly_name (MonoImage *image, MonoAssemblyName *aname)
174 MonoTableInfo *t = &image->tables [MONO_TABLE_ASSEMBLY];
175 guint32 cols [MONO_ASSEMBLY_SIZE];
180 mono_metadata_decode_row (t, 0, cols, MONO_ASSEMBLY_SIZE);
183 aname->hash_value = NULL;
184 aname->name = mono_metadata_string_heap (image, cols [MONO_ASSEMBLY_NAME]);
185 aname->culture = mono_metadata_string_heap (image, cols [MONO_ASSEMBLY_CULTURE]);
186 aname->flags = cols [MONO_ASSEMBLY_FLAGS];
187 aname->major = cols [MONO_ASSEMBLY_MAJOR_VERSION];
188 aname->minor = cols [MONO_ASSEMBLY_MINOR_VERSION];
189 aname->build = cols [MONO_ASSEMBLY_BUILD_NUMBER];
190 aname->revision = cols [MONO_ASSEMBLY_REV_NUMBER];
191 aname->hash_alg = cols [MONO_ASSEMBLY_HASH_ALG];
192 if (cols [MONO_ASSEMBLY_PUBLIC_KEY])
193 aname->public_key = mono_metadata_blob_heap (image, cols [MONO_ASSEMBLY_PUBLIC_KEY]);
195 aname->public_key = 0;
201 mono_assembly_load_references (MonoImage *image, MonoImageOpenStatus *status)
204 guint32 cols [MONO_ASSEMBLYREF_SIZE];
208 *status = MONO_IMAGE_OK;
210 if (image->references)
213 t = &image->tables [MONO_TABLE_ASSEMBLYREF];
215 image->references = g_new0 (MonoAssembly *, t->rows + 1);
218 * Load any assemblies this image references
220 for (i = 0; i < t->rows; i++) {
221 MonoAssemblyName aname;
223 mono_metadata_decode_row (t, i, cols, MONO_ASSEMBLYREF_SIZE);
225 hash = mono_metadata_blob_heap (image, cols [MONO_ASSEMBLYREF_HASH_VALUE]);
226 aname.hash_len = mono_metadata_decode_blob_size (hash, &hash);
227 aname.hash_value = hash;
228 aname.name = mono_metadata_string_heap (image, cols [MONO_ASSEMBLYREF_NAME]);
229 aname.culture = mono_metadata_string_heap (image, cols [MONO_ASSEMBLYREF_CULTURE]);
230 aname.flags = cols [MONO_ASSEMBLYREF_FLAGS];
231 aname.major = cols [MONO_ASSEMBLYREF_MAJOR_VERSION];
232 aname.minor = cols [MONO_ASSEMBLYREF_MINOR_VERSION];
233 aname.build = cols [MONO_ASSEMBLYREF_BUILD_NUMBER];
234 aname.revision = cols [MONO_ASSEMBLYREF_REV_NUMBER];
236 image->references [i] = mono_assembly_load (&aname, image->assembly->basedir, status);
238 if (image->references [i] == NULL){
241 for (j = 0; j < i; j++)
242 mono_assembly_close (image->references [j]);
243 g_free (image->references);
245 g_warning ("Could not find assembly %s", aname.name);
246 *status = MONO_IMAGE_MISSING_ASSEMBLYREF;
251 * This check is disabled since lots of people seem to have an older
252 * corlib which triggers this.
255 if (image->references [i]->image == image)
256 g_error ("Error: Assembly %s references itself", image->name);
259 image->references [i] = NULL;
261 /* resolve assembly references for modules */
262 t = &image->tables [MONO_TABLE_MODULEREF];
263 for (i = 0; i < t->rows; i++){
264 if (image->modules [i]) {
265 image->modules [i]->assembly = image->assembly;
266 mono_assembly_load_references (image->modules [i], status);
271 typedef struct AssemblyLoadHook AssemblyLoadHook;
272 struct AssemblyLoadHook {
273 AssemblyLoadHook *next;
274 MonoAssemblyLoadFunc func;
278 AssemblyLoadHook *assembly_load_hook = NULL;
281 mono_assembly_invoke_load_hook (MonoAssembly *ass)
283 AssemblyLoadHook *hook;
285 for (hook = assembly_load_hook; hook; hook = hook->next) {
286 hook->func (ass, hook->user_data);
291 mono_install_assembly_load_hook (MonoAssemblyLoadFunc func, gpointer user_data)
293 AssemblyLoadHook *hook;
295 g_return_if_fail (func != NULL);
297 hook = g_new0 (AssemblyLoadHook, 1);
299 hook->user_data = user_data;
300 hook->next = assembly_load_hook;
301 assembly_load_hook = hook;
304 typedef struct AssemblyPreLoadHook AssemblyPreLoadHook;
305 struct AssemblyPreLoadHook {
306 AssemblyPreLoadHook *next;
307 MonoAssemblyPreLoadFunc func;
311 AssemblyPreLoadHook *assembly_preload_hook = NULL;
313 static MonoAssembly *
314 invoke_assembly_preload_hook (MonoAssemblyName *aname, gchar **assemblies_path)
316 AssemblyPreLoadHook *hook;
317 MonoAssembly *assembly;
319 for (hook = assembly_preload_hook; hook; hook = hook->next) {
320 assembly = hook->func (aname, assemblies_path, hook->user_data);
321 if (assembly != NULL)
329 mono_install_assembly_preload_hook (MonoAssemblyPreLoadFunc func, gpointer user_data)
331 AssemblyPreLoadHook *hook;
333 g_return_if_fail (func != NULL);
335 hook = g_new0 (AssemblyPreLoadHook, 1);
337 hook->user_data = user_data;
338 hook->next = assembly_preload_hook;
339 assembly_preload_hook = hook;
343 absolute_dir (const gchar *filename)
354 if (g_path_is_absolute (filename))
355 return g_path_get_dirname (filename);
357 cwd = g_get_current_dir ();
358 mixed = g_build_filename (cwd, filename, NULL);
359 parts = g_strsplit (mixed, G_DIR_SEPARATOR_S, 0);
364 for (i = 0; (part = parts [i]) != NULL; i++) {
365 if (!strcmp (part, "."))
368 if (!strcmp (part, "..")) {
369 if (list && list->next) /* Don't remove root */
370 list = g_list_delete_link (list, list);
372 list = g_list_prepend (list, part);
376 result = g_string_new ("");
377 list = g_list_reverse (list);
379 /* Ignores last data pointer, which should be the filename */
380 for (tmp = list; tmp && tmp->next != NULL; tmp = tmp->next)
382 g_string_append_printf (result, "%s%c", (char *) tmp->data,
386 g_string_free (result, FALSE);
391 return g_strdup (".");
398 do_mono_assembly_open (const char *filename, MonoImageOpenStatus *status)
400 MonoImage *image = NULL;
403 char *name = g_path_get_basename (filename);
404 char *dot = strrchr (name, '.');
410 if (strcmp (name, "corlib") == 0) {
412 name = g_strdup ("mscorlib");
414 /* we do a very simple search for bundled assemblies: it's not a general
415 * purpose assembly loading mechanism.
417 EnterCriticalSection (&assemblies_mutex);
418 for (tmp = loaded_assemblies; tmp; tmp = tmp->next) {
420 if (!ass->aname.name)
422 if (strcmp (name, ass->aname.name))
427 LeaveCriticalSection (&assemblies_mutex);
428 for (i = 0; !image && bundled_assemblies [i]; ++i) {
429 if (strcmp (bundled_assemblies [i]->name, name) == 0) {
430 image = mono_image_open_from_data ((char*)bundled_assemblies [i]->data, bundled_assemblies [i]->size, FALSE, status);
436 InterlockedIncrement (&image->ref_count);
440 image = mono_image_open (filename, status);
445 * mono_assembly_open:
446 * @filename: Opens the assembly pointed out by this name
447 * @status: where a status code can be returned
449 * mono_assembly_open opens the PE-image pointed by @filename, and
450 * loads any external assemblies referenced by it.
452 * NOTE: we could do lazy loading of the assemblies. Or maybe not worth
456 mono_assembly_open (const char *filename, MonoImageOpenStatus *status)
460 MonoImageOpenStatus def_status;
463 g_return_val_if_fail (filename != NULL, NULL);
466 status = &def_status;
467 *status = MONO_IMAGE_OK;
469 if (strncmp (filename, "file://", 7) == 0) {
470 GError *error = NULL;
471 gchar *uri = (gchar *) filename;
474 * MS allows file://c:/... and fails on file://localhost/c:/...
475 * They also throw an IndexOutOfRangeException if "file://"
478 uri = g_strdup_printf ("file:///%s", uri + 7);
480 fname = g_filename_from_uri (uri, NULL, &error);
485 g_warning ("%s\n", error->message);
486 g_error_free (error);
487 fname = g_strdup (filename);
490 fname = g_strdup (filename);
493 /* g_print ("file loading %s\n", fname); */
494 image = do_mono_assembly_open (fname, status);
497 *status = MONO_IMAGE_ERROR_ERRNO;
502 ass = mono_assembly_load_from (image, fname, status);
510 mono_assembly_load_from (MonoImage *image, const char*fname,
511 MonoImageOpenStatus *status)
513 MonoAssembly *ass, *ass2;
517 #if defined (PLATFORM_WIN32)
522 tmp_fn = g_strdup (fname);
523 for (i = strlen (tmp_fn) - 1; i >= 0; i--) {
524 if (tmp_fn [i] == '/')
528 base_dir = absolute_dir (tmp_fn);
532 base_dir = absolute_dir (fname);
536 * Create assembly struct, and enter it into the assembly cache
538 ass = g_new0 (MonoAssembly, 1);
539 ass->basedir = base_dir;
542 mono_assembly_fill_assembly_name (image, &ass->aname);
545 * Atomically search the loaded list and add ourselves to it if necessary.
547 EnterCriticalSection (&assemblies_mutex);
549 /* avoid loading the same assembly twice for now... */
550 if ((ass2 = search_loaded (&ass->aname))) {
553 mono_image_close (image);
554 *status = MONO_IMAGE_OK;
555 LeaveCriticalSection (&assemblies_mutex);
558 loading = g_hash_table_lookup (assemblies_loading, GetCurrentThread ());
559 loading = g_list_prepend (loading, ass);
560 g_hash_table_insert (assemblies_loading, GetCurrentThread (), loading);
561 LeaveCriticalSection (&assemblies_mutex);
563 image->assembly = ass;
566 * We load referenced assemblies outside the lock to prevent deadlocks
567 * with regards to preload hooks.
569 mono_assembly_load_references (image, status);
571 EnterCriticalSection (&assemblies_mutex);
573 loading = g_hash_table_lookup (assemblies_loading, GetCurrentThread ());
574 loading = g_list_remove (loading, ass);
576 /* Prevent memory leaks */
577 g_hash_table_remove (assemblies_loading, GetCurrentThread ());
579 g_hash_table_insert (assemblies_loading, GetCurrentThread (), loading);
580 if (*status != MONO_IMAGE_OK) {
581 LeaveCriticalSection (&assemblies_mutex);
582 mono_assembly_close (ass);
586 if (ass->aname.name) {
587 ass2 = search_loaded (&ass->aname);
589 /* Somebody else has loaded the assembly before us */
590 LeaveCriticalSection (&assemblies_mutex);
591 mono_assembly_close (ass);
596 loaded_assemblies = g_list_prepend (loaded_assemblies, ass);
597 LeaveCriticalSection (&assemblies_mutex);
599 mono_assembly_invoke_load_hook (ass);
605 mono_assembly_load (MonoAssemblyName *aname, const char *basedir, MonoImageOpenStatus *status)
607 MonoAssembly *result;
608 char *fullpath, *filename;
610 result = invoke_assembly_preload_hook (aname, assemblies_path);
614 /* g_print ("loading %s\n", aname->name); */
615 /* special case corlib */
616 if ((strcmp (aname->name, "mscorlib") == 0) || (strcmp (aname->name, "corlib") == 0)) {
618 /* g_print ("corlib already loaded\n"); */
621 /* g_print ("corlib load\n"); */
622 if (assemblies_path) {
623 corlib = load_in_path ("mscorlib.dll", (const char**)assemblies_path, status);
626 corlib = load_in_path ("corlib.dll", (const char**)assemblies_path, status);
630 corlib = load_in_path ("mscorlib.dll", default_path, status);
632 corlib = load_in_path ("corlib.dll", default_path, status);
635 result = search_loaded (aname);
638 /* g_print ("%s not found in cache\n", aname->name); */
639 if (strstr (aname->name, ".dll"))
640 filename = g_strdup (aname->name);
642 filename = g_strconcat (aname->name, ".dll", NULL);
644 fullpath = g_build_filename (basedir, filename, NULL);
645 result = mono_assembly_open (fullpath, status);
652 if (assemblies_path) {
653 result = load_in_path (filename, (const char**)assemblies_path, status);
659 result = load_in_path (filename, default_path, status);
665 mono_assembly_close (MonoAssembly *assembly)
670 g_return_if_fail (assembly != NULL);
672 EnterCriticalSection (&assemblies_mutex);
673 if (--assembly->ref_count != 0) {
674 LeaveCriticalSection (&assemblies_mutex);
677 loaded_assemblies = g_list_remove (loaded_assemblies, assembly);
678 LeaveCriticalSection (&assemblies_mutex);
679 image = assembly->image;
680 if (image->references) {
681 for (i = 0; image->references [i] != NULL; i++)
682 mono_image_close (image->references [i]->image);
683 g_free (image->references);
686 mono_image_close (assembly->image);
688 g_free (assembly->basedir);
693 mono_assembly_load_module (MonoAssembly *assembly, guint32 idx)
695 MonoImageOpenStatus status;
698 module = mono_image_load_file_for_image (assembly->image, idx);
700 mono_assembly_load_references (module, &status);
706 mono_assembly_foreach (GFunc func, gpointer user_data)
711 * We make a copy of the list to avoid calling the callback inside the
712 * lock, which could lead to deadlocks.
714 EnterCriticalSection (&assemblies_mutex);
715 copy = g_list_copy (loaded_assemblies);
716 LeaveCriticalSection (&assemblies_mutex);
718 g_list_foreach (loaded_assemblies, func, user_data);
723 /* Holds the assembly of the application, for
724 * System.Diagnostics.Process::MainModule
726 static MonoAssembly *main_assembly=NULL;
729 mono_assembly_set_main (MonoAssembly *assembly)
731 main_assembly=assembly;
735 mono_assembly_get_main (void)
737 return(main_assembly);