2003-04-24 Martin Baulig <martin@ximian.com>
[mono.git] / mono / metadata / assembly.c
index 6c15cd6f1aa285c7ae35778f58a13b0b3ce84f03..5e2fd6386f1e895ba3bdac9773fe93b8378b374e 100644 (file)
 #include <glib.h>
 #include <errno.h>
 #include <string.h>
+#include <stdlib.h>
 #include "assembly.h"
 #include "image.h"
 #include "cil-coff.h"
 #include "rawbuffer.h"
 
-#define CSIZE(x) (sizeof (x) / 4)
+/* the default search path is just MONO_ASSEMBLIES */
+static const char*
+default_path [] = {
+       MONO_ASSEMBLIES,
+       NULL
+};
+
+static char **assemblies_path = NULL;
+static int env_checked = 0;
+
+#ifdef PLATFORM_WIN32
+static gboolean path_inited = FALSE;
+
+static void
+init_default_path (void)
+{
+       int i;
+
+       if (path_inited)
+               return;
+       
+       path_inited = TRUE;
+       default_path [0] = g_strdup (MONO_ASSEMBLIES);
+       for (i = strlen (MONO_ASSEMBLIES) - 1; i >= 0; i--) {
+               if (default_path [0][i] == '/')
+                       default_path [0][i] = '\\';
+       }
+}
+#endif
+
+static void
+check_env (void) {
+       const char *path;
+       char **splitted;
+       
+       if (env_checked)
+               return;
+       env_checked = 1;
+
+       path = getenv ("MONO_PATH");
+       if (!path)
+               return;
+       splitted = g_strsplit (path, G_SEARCHPATH_SEPARATOR_S, 1000);
+       if (assemblies_path)
+               g_strfreev (assemblies_path);
+       assemblies_path = splitted;
+}
 
 /*
  * keeps track of loaded assemblies
  */
-static GHashTable *assemblies;
+static GList *loaded_assemblies = NULL;
+static MonoAssembly *corlib;
+
+static MonoAssembly*
+search_loaded (MonoAssemblyName* aname)
+{
+       GList *tmp;
+       MonoAssembly *ass;
+       
+       for (tmp = loaded_assemblies; tmp; tmp = tmp->next) {
+               ass = tmp->data;
+               if (!ass->aname.name)
+                       continue;
+               /* we just compare the name, but later we'll do all the checks */
+               /* g_print ("compare %s %s\n", aname->name, ass->aname.name); */
+               if (strcmp (aname->name, ass->aname.name))
+                       continue;
+               /* g_print ("success\n"); */
+               return ass;
+       }
+       return NULL;
+}
+
+static MonoAssembly *
+load_in_path (const char *basename, const char** search_path, MonoImageOpenStatus *status)
+{
+       int i;
+       char *fullpath;
+       MonoAssembly *result;
+
+       for (i = 0; search_path [i]; ++i) {
+               fullpath = g_build_filename (search_path [i], basename, NULL);
+               result = mono_assembly_open (fullpath, status);
+               g_free (fullpath);
+               if (result)
+                       return result;
+       }
+       return NULL;
+}
 
 /**
- * g_concat_dir_and_file:
- * @dir:  directory name
- * @file: filename.
+ * mono_assembly_setrootdir:
+ * @root_dir: The pathname of the root directory where we will locate assemblies
+ *
+ * This routine sets the internal default root directory for looking up
+ * assemblies.  This is used by Windows installations to compute dynamically
+ * the place where the Mono assemblies are located.
  *
- * returns a new allocated string that is the concatenation of dir and file,
- * takes care of the exact details for concatenating them.
  */
-static char *
-g_concat_dir_and_file (const char *dir, const char *file)
+void
+mono_assembly_setrootdir (const char *root_dir)
 {
-       g_return_val_if_fail (dir != NULL, NULL);
-       g_return_val_if_fail (file != NULL, NULL);
+       /*
+        * Override the MONO_ASSEMBLIES directory configured at compile time.
+        */
+       default_path [0] = g_strdup (root_dir);
+#ifdef PLATFORM_WIN32
+       path_inited = TRUE;
+#endif
+}
+
+void
+mono_image_load_references (MonoImage *image, MonoImageOpenStatus *status) {
+       MonoTableInfo *t;
+       guint32 cols [MONO_ASSEMBLYREF_SIZE];
+       const char *hash;
+       int i;
+
+       if (image->references)
+               return;
+
+       t = &image->tables [MONO_TABLE_ASSEMBLYREF];
 
-        /*
-        * If the directory name doesn't have a / on the end, we need
-        * to add one so we get a proper path to the file
+       image->references = g_new0 (MonoAssembly *, t->rows + 1);
+
+       /*
+        * Load any assemblies this image references
         */
-       if (dir [strlen(dir) - 1] != G_DIR_SEPARATOR)
-               return g_strconcat (dir, G_DIR_SEPARATOR_S, file, NULL);
-       else
-               return g_strconcat (dir, file, NULL);
+       for (i = 0; i < t->rows; i++) {
+               MonoAssemblyName aname;
+
+               mono_metadata_decode_row (t, i, cols, MONO_ASSEMBLYREF_SIZE);
+               
+               hash = mono_metadata_blob_heap (image, cols [MONO_ASSEMBLYREF_HASH_VALUE]);
+               aname.hash_len = mono_metadata_decode_blob_size (hash, &hash);
+               aname.hash_value = hash;
+               aname.name = mono_metadata_string_heap (image, cols [MONO_ASSEMBLYREF_NAME]);
+               aname.culture = mono_metadata_string_heap (image, cols [MONO_ASSEMBLYREF_CULTURE]);
+               aname.flags = cols [MONO_ASSEMBLYREF_FLAGS];
+               aname.major = cols [MONO_ASSEMBLYREF_MAJOR_VERSION];
+               aname.minor = cols [MONO_ASSEMBLYREF_MINOR_VERSION];
+               aname.build = cols [MONO_ASSEMBLYREF_BUILD_NUMBER];
+               aname.revision = cols [MONO_ASSEMBLYREF_REV_NUMBER];
+
+               image->references [i] = mono_assembly_load (&aname, image->assembly->basedir, status);
+
+               if (image->references [i] == NULL){
+                       int j;
+                       
+                       for (j = 0; j < i; j++)
+                               mono_assembly_close (image->references [j]);
+                       g_free (image->references);
+                       image->references = NULL;
+
+                       g_warning ("Could not find assembly %s", aname.name);
+                       *status = MONO_IMAGE_MISSING_ASSEMBLYREF;
+                       return;
+               }
+       }
+       image->references [i] = NULL;
+
+}
+
+typedef struct AssemblyLoadHook AssemblyLoadHook;
+struct AssemblyLoadHook {
+       AssemblyLoadHook *next;
+       MonoAssemblyLoadFunc func;
+       gpointer user_data;
+};
+
+AssemblyLoadHook *assembly_load_hook = NULL;
+
+void
+mono_assembly_invoke_load_hook (MonoAssembly *ass)
+{
+       AssemblyLoadHook *hook;
+
+       for (hook = assembly_load_hook; hook; hook = hook->next) {
+               hook->func (ass, hook->user_data);
+       }
 }
 
-static char *
-default_assembly_name_resolver (const char *name)
+void
+mono_install_assembly_load_hook (MonoAssemblyLoadFunc func, gpointer user_data)
 {
-       char *file, *path;
+       AssemblyLoadHook *hook;
        
-       if ((strcmp (name, "mscorlib") == 0) ||
-                       (strcmp (name, "mscorlib.dll") == 0) ||
-                       (strcmp (name, "corlib.dll") == 0) ||
-                       (strcmp (name, "corlib") == 0))
-               return g_concat_dir_and_file (MONO_ASSEMBLIES, CORLIB_NAME);
+       g_return_if_fail (func != NULL);
+
+       hook = g_new0 (AssemblyLoadHook, 1);
+       hook->func = func;
+       hook->user_data = user_data;
+       hook->next = assembly_load_hook;
+       assembly_load_hook = hook;
+}
+
+typedef struct AssemblyPreLoadHook AssemblyPreLoadHook;
+struct AssemblyPreLoadHook {
+       AssemblyPreLoadHook *next;
+       MonoAssemblyPreLoadFunc func;
+       gpointer user_data;
+};
 
-       if (g_file_test (name, G_FILE_TEST_EXISTS))
-               return g_strdup (name);
-       path = g_concat_dir_and_file (MONO_ASSEMBLIES, name);
-       if (g_file_test (path, G_FILE_TEST_EXISTS))
-               return g_strdup (path);
-       g_free (path);
-       file = g_strconcat (name, ".dll", NULL);
-       path = g_concat_dir_and_file (MONO_ASSEMBLIES, file);
-       g_free (file);
+AssemblyPreLoadHook *assembly_preload_hook = NULL;
+
+static MonoAssembly *
+invoke_assembly_preload_hook (MonoAssemblyName *aname, gchar **assemblies_path)
+{
+       AssemblyPreLoadHook *hook;
+       MonoAssembly *assembly;
+
+       for (hook = assembly_preload_hook; hook; hook = hook->next) {
+               assembly = hook->func (aname, assemblies_path, hook->user_data);
+               if (assembly != NULL)
+                       return assembly;
+       }
+
+       return NULL;
+}
+
+void
+mono_install_assembly_preload_hook (MonoAssemblyPreLoadFunc func, gpointer user_data)
+{
+       AssemblyPreLoadHook *hook;
+       
+       g_return_if_fail (func != NULL);
 
-       return path;
+       hook = g_new0 (AssemblyPreLoadHook, 1);
+       hook->func = func;
+       hook->user_data = user_data;
+       hook->next = assembly_preload_hook;
+       assembly_preload_hook = hook;
+}
+
+static gchar *
+absolute_dir (const gchar *filename)
+{
+       gchar *cwd;
+       gchar *mixed;
+       gchar **parts;
+       gchar *part;
+       GSList *list, *tmp;
+       GString *result;
+       gchar *res;
+       gint i;
+
+       if (g_path_is_absolute (filename))
+               return g_path_get_dirname (filename);
+
+       cwd = g_get_current_dir ();
+       mixed = g_build_filename (cwd, filename, NULL);
+       parts = g_strsplit (mixed, G_DIR_SEPARATOR_S, 0);
+       g_free (mixed);
+       g_free (cwd);
+
+       list = NULL;
+       for (i = 0; (part = parts [i]) != NULL; i++) {
+               if (!strcmp (part, "."))
+                       continue;
+
+               if (!strcmp (part, "..")) {
+                       if (list && list->next) /* Don't remove root */
+                               list = g_slist_delete_link (list, list);
+               } else {
+                       list = g_slist_prepend (list, part);
+               }
+       }
+
+       result = g_string_new ("");
+       list = g_slist_reverse (list);
+
+       /* Ignores last data pointer, which should be the filename */
+       for (tmp = list; tmp && tmp->next != NULL; tmp = tmp->next)
+               if (tmp->data)
+                       g_string_append_printf (result, "%s%c", (char *) tmp->data,
+                                                               G_DIR_SEPARATOR);
+       
+       res = result->str;
+       g_string_free (result, FALSE);
+       g_slist_free (list);
+       g_strfreev (parts);
+       if (*res == '\0') {
+               g_free (res);
+               return g_strdup (".");
+       }
+
+       return res;
 }
 
 /**
  * mono_assembly_open:
  * @filename: Opens the assembly pointed out by this name
- * @resolver: A user provided function to resolve assembly references
  * @status: where a status code can be returned
  *
  * mono_assembly_open opens the PE-image pointed by @filename, and
@@ -87,111 +322,208 @@ default_assembly_name_resolver (const char *name)
  * it. 
  */
 MonoAssembly *
-mono_assembly_open (const char *filename, MonoAssemblyResolverFn resolver,
-                   enum MonoImageOpenStatus *status)
+mono_assembly_open (const char *filename, MonoImageOpenStatus *status)
 {
-       MonoAssembly *ass;
+       MonoAssembly *ass, *ass2;
        MonoImage *image;
        MonoTableInfo *t;
+       guint32 cols [MONO_ASSEMBLY_SIZE];
        int i;
-       char *fullname;
-       const char *base_name = strrchr (filename, G_DIR_SEPARATOR);
-       static MonoAssembly *corlib;
+       char *base_dir, *aot_name;
+       MonoImageOpenStatus def_status;
+       gchar *fname;
        
        g_return_val_if_fail (filename != NULL, NULL);
 
-       if (assemblies == NULL)
-               assemblies = g_hash_table_new (g_str_hash, g_str_equal);
+       if (!status)
+               status = &def_status;
+       *status = MONO_IMAGE_OK;
 
-       if ((ass = g_hash_table_lookup (assemblies, filename)) != NULL){
-               ass->ref_count++;
-               return ass;
-       }
-       
-       if (base_name == NULL)
-               base_name = filename;
-       else
-               base_name++;
+       if (strncmp (filename, "file://", 7) == 0) {
+               GError *error = NULL;
+               gchar *uri = (gchar *) filename;
 
-       if (resolver == NULL)
-               resolver = default_assembly_name_resolver;
+               /*
+                * MS allows file://c:/... and fails on file://localhost/c:/... 
+                * They also throw an IndexOutOfRangeException if "file://"
+                */
+               if (uri [7] != '/')
+                       uri = g_strdup_printf ("file:///%s", uri + 7);
+               
+               fname = g_filename_from_uri (uri, NULL, &error);
+               if (uri != filename)
+                       g_free (uri);
 
+               if (error != NULL) {
+                       g_warning ("%s\n", error->message);
+                       g_error_free (error);
+                       fname = g_strdup (filename);
+               }
+       } else {
+               fname = g_strdup (filename);
+       }
 
-       fullname = resolver (filename);
-       image = mono_image_open (fullname, status);
+       /* g_print ("file loading %s\n", fname); */
+       image = mono_image_open (fname, status);
 
        if (!image){
-               if (status)
-                       *status = MONO_IMAGE_ERROR_ERRNO;
-               g_free (fullname);
+               *status = MONO_IMAGE_ERROR_ERRNO;
+               g_free (fname);
                return NULL;
        }
 
-       t = &image->tables [MONO_TABLE_ASSEMBLYREF];
+#if defined (PLATFORM_WIN32)
+       {
+               gchar *tmp_fn;
+               tmp_fn = g_strdup (fname);
+               for (i = strlen (tmp_fn) - 1; i >= 0; i--) {
+                       if (tmp_fn [i] == '/')
+                               tmp_fn [i] = '\\';
+               }
 
-       image->references = g_new0 (MonoAssembly *, t->rows + 1);
+               base_dir = absolute_dir (tmp_fn);
+               g_free (tmp_fn);
+       }
+#else
+       base_dir = absolute_dir (fname);
+#endif
 
        /*
         * Create assembly struct, and enter it into the assembly cache
         */
-       ass = g_new (MonoAssembly, 1);
-       ass->name = fullname;
+       ass = g_new0 (MonoAssembly, 1);
+       ass->basedir = base_dir;
        ass->image = image;
 
-       g_hash_table_insert (assemblies, image->name, ass);
-       g_hash_table_insert (assemblies, ass->name, ass);
-       
-       /*
-        * Load any assemblies this image references
-        */
-       for (i = 0; i < t->rows; i++){
-               char *assembly_ref;
-               const char *name;
-               guint32 cols [MONO_ASSEMBLYREF_SIZE];
+       /* load aot compiled module */
+       aot_name = g_strdup_printf ("%s.so", fname);
+       g_free (fname);
+       ass->aot_module = g_module_open (aot_name, G_MODULE_BIND_LAZY);
+       g_free (aot_name);
 
-               mono_metadata_decode_row (t, i, cols, CSIZE (cols));
-               name = mono_metadata_string_heap (image, cols [MONO_ASSEMBLYREF_NAME]);
+       if (ass->aot_module) {
+               char *saved_guid = NULL;
+               g_module_symbol (ass->aot_module, "mono_assembly_guid", (gpointer *) &saved_guid);
 
-               /*
-                * Special case until we have a passable corlib:
-                *
-                * ie, references to mscorlib from corlib.dll are ignored 
-                * and we do not load corlib twice.
-                */
-               if (strcmp (base_name, CORLIB_NAME) == 0){
-                       if (corlib == NULL)
-                               corlib = ass;
-                       
-                       if (strcmp (name, "mscorlib") == 0)
-                               continue;
+               if (!saved_guid || strcmp (image->guid, saved_guid)) {
+                       g_module_close (ass->aot_module);
+                       ass->aot_module = NULL;
                }
+       }
+
+       t = &image->tables [MONO_TABLE_ASSEMBLY];
+       if (t->rows) {
+               mono_metadata_decode_row (t, 0, cols, MONO_ASSEMBLY_SIZE);
                
-               assembly_ref = (*resolver) (name);
+               ass->aname.hash_len = 0;
+               ass->aname.hash_value = NULL;
+               ass->aname.name = mono_metadata_string_heap (image, cols [MONO_ASSEMBLY_NAME]);
+               ass->aname.culture = mono_metadata_string_heap (image, cols [MONO_ASSEMBLY_CULTURE]);
+               ass->aname.flags = cols [MONO_ASSEMBLY_FLAGS];
+               ass->aname.major = cols [MONO_ASSEMBLY_MAJOR_VERSION];
+               ass->aname.minor = cols [MONO_ASSEMBLY_MINOR_VERSION];
+               ass->aname.build = cols [MONO_ASSEMBLY_BUILD_NUMBER];
+               ass->aname.revision = cols [MONO_ASSEMBLY_REV_NUMBER];
 
-               image->references [i] = mono_assembly_open (assembly_ref, resolver, status);
+               /* avoid loading the same assembly twice for now... */
+               if ((ass2 = search_loaded (&ass->aname))) {
+                       g_free (ass);
+                       g_free (base_dir);
+                       *status = MONO_IMAGE_OK;
+                       return ass2;
+               }
+       }
 
-               if (image->references [i] == NULL){
-                       int j;
-                       
-                       for (j = 0; j < i; j++)
-                               mono_assembly_close (image->references [j]);
-                       g_free (image->references);
-                       mono_image_close (image);
+       image->assembly = ass;
 
-                       g_warning ("Could not find assembly %s %s", name, assembly_ref);
-                       g_free (assembly_ref);
-                       if (status)
-                               *status = MONO_IMAGE_MISSING_ASSEMBLYREF;
-                       g_free (ass);
-                       return NULL;
+       /* register right away to prevent loops */
+       loaded_assemblies = g_list_prepend (loaded_assemblies, ass);
+
+       mono_image_load_references (image, status);
+       if (*status != MONO_IMAGE_OK) {
+               mono_assembly_close (ass);
+               return NULL;
+       }
+
+       /* resolve assembly references for modules */
+       t = &image->tables [MONO_TABLE_MODULEREF];
+       for (i = 0; i < t->rows; i++){
+               if (image->modules [i]) {
+                       image->modules [i]->assembly = ass;
+                       mono_image_load_references (image->modules [i], status);
                }
-               g_free (assembly_ref);
+               /* 
+                * FIXME: what do we do here? it could be a native dll...
+                * We should probably do lazy-loading of modules.
+                */
+               *status = MONO_IMAGE_OK;
        }
-       image->references [i] = NULL;
+
+       mono_assembly_invoke_load_hook (ass);
 
        return ass;
 }
 
+MonoAssembly*
+mono_assembly_load (MonoAssemblyName *aname, const char *basedir, MonoImageOpenStatus *status)
+{
+       MonoAssembly *result;
+       char *fullpath, *filename;
+
+#ifdef PLATFORM_WIN32
+       init_default_path ();
+#endif
+       check_env ();
+
+       result = invoke_assembly_preload_hook (aname, assemblies_path);
+       if (result)
+               return result;
+
+       /* g_print ("loading %s\n", aname->name); */
+       /* special case corlib */
+       if ((strcmp (aname->name, "mscorlib") == 0) || (strcmp (aname->name, "corlib") == 0)) {
+               if (corlib) {
+                       /* g_print ("corlib already loaded\n"); */
+                       return corlib;
+               }
+               /* g_print ("corlib load\n"); */
+               if (assemblies_path) {
+                       corlib = load_in_path (CORLIB_NAME, (const char**)assemblies_path, status);
+                       if (corlib)
+                               return corlib;
+               }
+               corlib = load_in_path (CORLIB_NAME, default_path, status);
+               return corlib;
+       }
+       result = search_loaded (aname);
+       if (result)
+               return result;
+       /* g_print ("%s not found in cache\n", aname->name); */
+       if (strstr (aname->name, ".dll"))
+               filename = g_strdup (aname->name);
+       else
+               filename = g_strconcat (aname->name, ".dll", NULL);
+       if (basedir) {
+               fullpath = g_build_filename (basedir, filename, NULL);
+               result = mono_assembly_open (fullpath, status);
+               g_free (fullpath);
+               if (result) {
+                       g_free (filename);
+                       return result;
+               }
+       }
+       if (assemblies_path) {
+               result = load_in_path (filename, (const char**)assemblies_path, status);
+               if (result) {
+                       g_free (filename);
+                       return result;
+               }
+       }
+       result = load_in_path (filename, default_path, status);
+       g_free (filename);
+       return result;
+}
+
 void
 mono_assembly_close (MonoAssembly *assembly)
 {
@@ -203,24 +535,41 @@ mono_assembly_close (MonoAssembly *assembly)
        if (--assembly->ref_count != 0)
                return;
        
+       loaded_assemblies = g_list_remove (loaded_assemblies, assembly);
        image = assembly->image;
-       for (i = 0; image->references [i] != NULL; i++)
-               mono_image_close (image->references [i]->image);
-       g_free (image->references);
+       if (image->references) {
+               for (i = 0; image->references [i] != NULL; i++)
+                       mono_image_close (image->references [i]->image);
+               g_free (image->references);
+       }
             
        mono_image_close (assembly->image);
 
-       g_hash_table_remove (assemblies, assembly->name);
-                            
-       g_free (assembly->name);
+       g_free (assembly->basedir);
        g_free (assembly);
 }
 
-/*
- * Temporary hack until we get AppDomains
+void
+mono_assembly_foreach (GFunc func, gpointer user_data)
+{
+       /* In the future this can do locking of loaded_assemblies */
+
+       g_list_foreach (loaded_assemblies, func, user_data);
+}
+
+/* Holds the assembly of the application, for
+ * System.Diagnostics.Process::MainModule
  */
-GHashTable *
-mono_get_assemblies ()
+static MonoAssembly *main_assembly=NULL;
+
+void
+mono_assembly_set_main (MonoAssembly *assembly)
+{
+       main_assembly=assembly;
+}
+
+MonoAssembly *
+mono_assembly_get_main (void)
 {
-       return assemblies;
+       return(main_assembly);
 }