Add a new 'MONO_DEBUGGER_EVENT_TRAMPOLINE' notification for the debugger which also...
[mono.git] / mono / metadata / pedump.c
index e57c5dcab0963d857d0031cc25f572aef4465f6e..dda3efe0db6cfdd7ad39f744cb2ca17b6b64ead4 100644 (file)
@@ -4,7 +4,8 @@
  * Author:
  *   Miguel de Icaza (miguel@ximian.com)
  *
- * (C) 2001 Ximian, Inc.
+ * Copyright 2001-2003 Ximian, Inc (http://www.ximian.com)
+ * Copyright 2004-2009 Novell, Inc (http://www.novell.com)
  */
 #include <config.h>
 #include <stdio.h>
 #include "image.h"
 #include <glib.h>
 #include "cil-coff.h"
-#include "private.h"
 #include "mono-endian.h"
+#include "verify.h"
 #include <mono/metadata/class.h>
+#include <mono/metadata/debug-helpers.h>
+#include <mono/metadata/tokentype.h>
+#include <mono/metadata/appdomain.h>
+#include <mono/metadata/assembly.h>
+#include <mono/metadata/metadata-internals.h>
+#include <mono/metadata/class-internals.h>
+#include <mono/metadata/verify-internals.h>
+#include <mono/metadata/marshal.h>
+#include "mono/utils/mono-digest.h"
+#include <mono/utils/mono-mmap.h>
+#include <sys/types.h>
+#include <sys/stat.h>
+#ifdef HAVE_UNISTD_H
+#include <unistd.h>
+#endif
 
 gboolean dump_data = TRUE;
-gboolean dump_tables = FALSE;
+gboolean verify_pe = FALSE;
+gboolean verify_metadata = FALSE;
+gboolean verify_code = FALSE;
 
+/* unused
 static void
-hex_dump (char *buffer, int base, int count)
+hex_dump (const char *buffer, int base, int count)
 {
        int i;
        
@@ -32,21 +51,22 @@ hex_dump (char *buffer, int base, int count)
                printf ("%02x ", (unsigned char) (buffer [i]));
        }
 }
+*/
 
 static void
-hex8 (char *label, unsigned char x)
+hex8 (const char *label, unsigned char x)
 {
        printf ("\t%s: 0x%02x\n", label, (unsigned char) x);
 }
 
 static void
-hex16 (char *label, guint16 x)
+hex16 (const char *label, guint16 x)
 {
        printf ("\t%s: 0x%04x\n", label, x);
 }
 
 static void
-hex32 (char *label, guint32 x)
+hex32 (const char *label, guint32 x)
 {
        printf ("\t%s: 0x%08x\n", label, x);
 }
@@ -115,6 +135,45 @@ dent (const char *label, MonoPEDirEntry de)
        printf ("\t%s: 0x%08x [0x%08x]\n", label, de.rva, de.size);
 }
 
+static void
+dump_blob (const char *desc, const char* p, guint32 size)
+{
+       int i;
+
+       printf ("%s", desc);
+       if (!p) {
+               printf (" none\n");
+               return;
+       }
+
+       for (i = 0; i < size; ++i) {
+               if (!(i % 16))
+                       printf ("\n\t");
+               printf (" %02X", p [i] & 0xFF);
+       }
+       printf ("\n");
+}
+
+static void
+dump_public_key (MonoImage *m)
+{
+       guint32 size;
+       const char *p;
+
+       p = mono_image_get_public_key (m, &size);
+       dump_blob ("\nPublic key:", p, size);
+}
+
+static void
+dump_strong_name (MonoImage *m)
+{
+       guint32 size;
+       const char *p;
+
+       p = mono_image_get_strong_name (m, &size);
+       dump_blob ("\nStrong name:", p, size);
+}
+
 static void
 dump_datadir (MonoPEDatadir *dd)
 {
@@ -189,10 +248,11 @@ dump_cli_header (MonoCLIHeader *ch)
        printf ("\n");
        printf ("          CLI header size: %d\n", ch->ch_size);
        printf ("         Runtime required: %d.%d\n", ch->ch_runtime_major, ch->ch_runtime_minor);
-       printf ("                    Flags: %s, %s, %s\n",
+       printf ("                    Flags: %s, %s, %s, %s\n",
                (ch->ch_flags & CLI_FLAGS_ILONLY ? "ilonly" : "contains native"),
                (ch->ch_flags & CLI_FLAGS_32BITREQUIRED ? "32bits" : "32/64"),
-               (ch->ch_flags & CLI_FLAGS_ILONLY ? "trackdebug" : "no-trackdebug"));
+               (ch->ch_flags & CLI_FLAGS_TRACKDEBUGDATA ? "trackdebug" : "no-trackdebug"),
+               (ch->ch_flags & CLI_FLAGS_STRONGNAMESIGNED ? "strongnamesigned" : "notsigned"));
        dent   ("         Metadata", ch->ch_metadata);
        hex32  ("Entry Point Token", ch->ch_entry_point);
        dent   ("     Resources at", ch->ch_resources);
@@ -203,57 +263,59 @@ dump_cli_header (MonoCLIHeader *ch)
 }      
 
 static void
-dsh (char *label, MonoStreamHeader *sh)
+dsh (const char *label, MonoImage *meta, MonoStreamHeader *sh)
 {
        printf ("%s: 0x%08x - 0x%08x [%d == 0x%08x]\n",
                label,
-               sh->offset, sh->offset + sh->size,
+               (int)(sh->data - meta->raw_metadata), (int)(sh->data + sh->size - meta->raw_metadata),
                sh->size, sh->size);
 }
 
 static void
-dump_metadata_ptrs (MonoMetadata *meta)
+dump_metadata_header (MonoImage *meta)
 {
-       printf ("\nMetadata pointers:\n");
-       dsh ("\tTables (#~)", &meta->heap_tables);
-       dsh ("\t    Strings", &meta->heap_strings);
-       dsh ("\t       Blob", &meta->heap_blob);
-       dsh ("\tUser string", &meta->heap_us);
-       dsh ("\t       GUID", &meta->heap_guid);
+       printf ("\nMetadata header:\n");
+       printf ("           Version: %d.%d\n", meta->md_version_major, meta->md_version_minor);
+       printf ("    Version string: %s\n", meta->version);
 }
 
 static void
-dump_table (MonoMetadata *meta, int table)
+dump_metadata_ptrs (MonoImage *meta)
 {
-       
+       printf ("\nMetadata pointers:\n");
+       dsh ("\tTables (#~)", meta, &meta->heap_tables);
+       dsh ("\t    Strings", meta, &meta->heap_strings);
+       dsh ("\t       Blob", meta, &meta->heap_blob);
+       dsh ("\tUser string", meta, &meta->heap_us);
+       dsh ("\t       GUID", meta, &meta->heap_guid);
 }
 
 static void
-dump_metadata (MonoMetadata *meta)
+dump_metadata (MonoImage *meta)
 {
        int table;
-       
+
+       dump_metadata_header (meta);
+
        dump_metadata_ptrs (meta);
 
        printf ("Rows:\n");
-       for (table = 0; table < 64; table++){
+       for (table = 0; table < MONO_TABLE_NUM; table++){
                if (meta->tables [table].rows == 0)
                        continue;
-               printf ("Table %s: %d records (%d bytes, at %p)\n",
+               printf ("Table %s: %d records (%d bytes, at %x)\n",
                        mono_meta_table_name (table),
                        meta->tables [table].rows,
                        meta->tables [table].row_size,
-                       meta->tables [table].base
+                       (unsigned int)(meta->tables [table].base - meta->raw_data)
                        );
-               if (dump_tables)
-                       dump_table (meta, table);
        }
 }
 
 static void
-dump_methoddef (MonoMetadata *metadata, guint32 token)
+dump_methoddef (MonoImage *metadata, guint32 token)
 {
-       char *loc;
+       const char *loc;
 
        if (!token)
                return;
@@ -270,50 +332,400 @@ dump_dotnet_iinfo (MonoImage *image)
        dump_dotnet_header (&iinfo->cli_header);
        dump_sections (iinfo);
        dump_cli_header (&iinfo->cli_cli_header);
+       dump_strong_name (image);
+       dump_public_key (image);
        dump_metadata (image);
 
        dump_methoddef (image, iinfo->cli_cli_header.ch_entry_point);
 }
 
+static int
+dump_verify_info (MonoImage *image, int flags)
+{
+       GSList *errors, *tmp;
+       int count = 0, verifiable = 0;
+       const char* desc [] = {
+               "Ok", "Error", "Warning", NULL, "CLS", NULL, NULL, NULL, "Not Verifiable"
+       };
+
+       if (verify_metadata) {
+               errors = mono_image_verify_tables (image, flags);
+       
+               for (tmp = errors; tmp; tmp = tmp->next) {
+                       MonoVerifyInfo *info = tmp->data;
+                       g_print ("%s: %s\n", desc [info->status], info->message);
+                       if (info->status == MONO_VERIFY_ERROR)
+                               count++;
+               }
+               mono_free_verify_list (errors);
+       }
+
+       if (verify_code) { /* verify code */
+               int i;
+               MonoTableInfo *m = &image->tables [MONO_TABLE_METHOD];
+
+               for (i = 0; i < m->rows; ++i) {
+                       MonoMethod *method;
+                       method = mono_get_method (image, MONO_TOKEN_METHOD_DEF | (i+1), NULL);
+                       if (!method) {
+                               g_print ("Warning: Cannot lookup method with token 0x%08x\n", i + 1);
+                               continue;
+                       }
+                       errors = mono_method_verify (method, flags);
+                       if (errors) {
+                               MonoClass *klass = mono_method_get_class (method);
+                               char *name = mono_type_full_name (&klass->byval_arg);
+                               if (mono_method_signature (method) == NULL) {
+                                       g_print ("In method: %s::%s(ERROR)\n", name, mono_method_get_name (method));
+                               } else {
+                                       char *sig;
+                                       sig = mono_signature_get_desc (mono_method_signature (method), FALSE);  
+                                       g_print ("In method: %s::%s(%s)\n", name, mono_method_get_name (method), sig);
+                                       g_free (sig);
+                               }
+                               g_free (name);
+                       }
+
+                       for (tmp = errors; tmp; tmp = tmp->next) {
+                               MonoVerifyInfo *info = tmp->data;
+                               g_print ("%s: %s\n", desc [info->status], info->message);
+                               if (info->status == MONO_VERIFY_ERROR) {
+                                       count++;
+                                       verifiable = 3;
+                               }
+                               if(info->status == MONO_VERIFY_NOT_VERIFIABLE) {
+                                       if (verifiable < 2)
+                                               verifiable = 2; 
+                               }
+                       }
+                       mono_free_verify_list (errors);
+               }
+       }
+
+       if (count)
+               g_print ("Error count: %d\n", count);
+       return verifiable;
+}
+
 static void
 usage (void)
 {
-       printf ("Usage is: pedump [--tables] file.exe\n");
+       printf ("Usage is: pedump [--verify error,warn,cls,all,code,fail-on-verifiable,non-strict,valid-only,metadata] file.exe\n");
        exit (1);
 }
 
+static int
+verify_image_file (const char *fname)
+{
+       GSList *errors = NULL, *tmp;
+       MonoImage *image;
+       MonoTableInfo *table;
+       MonoAssembly *assembly;
+       MonoImageOpenStatus status;
+       int i, count = 0;
+       const char* desc [] = {
+               "Ok", "Error", "Warning", NULL, "CLS", NULL, NULL, NULL, "Not Verifiable"
+       };
+
+       image = mono_image_open_raw (fname, &status);
+       if (!image) {
+               printf ("Could not open %s\n", fname);
+               return 1;
+       }
+
+       if (!mono_verifier_verify_pe_data (image, &errors))
+               goto invalid_image;
+
+       if (!mono_image_load_pe_data (image)) {
+               printf ("Could not load pe data for assembly %s\n", fname);
+               return 1;
+       }
+
+       if (!mono_verifier_verify_cli_data (image, &errors))
+               goto invalid_image;
+
+       if (!mono_image_load_cli_data (image)) {
+               printf ("Could not load cli data for assembly %s\n", fname);
+               return 1;
+       }
+
+       if (!mono_verifier_verify_table_data (image, &errors))
+               goto invalid_image;
+
+       mono_image_load_names (image);
+
+       if (!mono_verifier_verify_full_table_data (image, &errors))
+               goto invalid_image;
+
+
+       /*fake an assembly for class loading to work*/
+       assembly = g_new0 (MonoAssembly, 1);
+       assembly->in_gac = FALSE;
+       assembly->image = image;
+       image->assembly = assembly;
+
+       table = &image->tables [MONO_TABLE_TYPEDEF];
+       for (i = 1; i <= table->rows; ++i) {
+               guint32 token = i | MONO_TOKEN_TYPE_DEF;
+               MonoClass *class = mono_class_get (image, token);
+               if (!class) {
+                       printf ("Could not load class with token %x\n", token);
+                       continue;
+               }
+               mono_class_init (class);
+               if (class->exception_type != MONO_EXCEPTION_NONE || mono_loader_get_last_error ()) {
+                       printf ("Error verifying class(0x%08x) %s.%s a type load error happened\n", token, class->name_space, class->name);
+                       mono_loader_clear_error ();
+                       ++count;
+               }
+       }
+       if (count)
+               return 1;
+       return 0;
+
+invalid_image:
+       for (tmp = errors; tmp; tmp = tmp->next) {
+               MonoVerifyInfo *info = tmp->data;
+               g_print ("%s: %s\n", desc [info->status], info->message);
+               if (info->status == MONO_VERIFY_ERROR)
+                       count++;
+       }
+       mono_free_verify_list (errors);
+       if (count)
+               g_print ("Error count: %d\n", count);
+       return 1;
+}
+
+static gboolean
+try_load_from (MonoAssembly **assembly, const gchar *path1, const gchar *path2,
+                                       const gchar *path3, const gchar *path4, gboolean refonly)
+{
+       gchar *fullpath;
+
+       *assembly = NULL;
+       fullpath = g_build_filename (path1, path2, path3, path4, NULL);
+       if (g_file_test (fullpath, G_FILE_TEST_IS_REGULAR))
+               *assembly = mono_assembly_open_full (fullpath, NULL, refonly);
+
+       g_free (fullpath);
+       return (*assembly != NULL);
+}
+
+static MonoAssembly *
+real_load (gchar **search_path, const gchar *culture, const gchar *name, gboolean refonly)
+{
+       MonoAssembly *result = NULL;
+       gchar **path;
+       gchar *filename;
+       const gchar *local_culture;
+       gint len;
+
+       if (!culture || *culture == '\0') {
+               local_culture = "";
+       } else {
+               local_culture = culture;
+       }
+
+       filename =  g_strconcat (name, ".dll", NULL);
+       len = strlen (filename);
+
+       for (path = search_path; *path; path++) {
+               if (**path == '\0')
+                       continue; /* Ignore empty ApplicationBase */
+
+               /* See test cases in bug #58992 and bug #57710 */
+               /* 1st try: [culture]/[name].dll (culture may be empty) */
+               strcpy (filename + len - 4, ".dll");
+               if (try_load_from (&result, *path, local_culture, "", filename, refonly))
+                       break;
+
+               /* 2nd try: [culture]/[name].exe (culture may be empty) */
+               strcpy (filename + len - 4, ".exe");
+               if (try_load_from (&result, *path, local_culture, "", filename, refonly))
+                       break;
+
+               /* 3rd try: [culture]/[name]/[name].dll (culture may be empty) */
+               strcpy (filename + len - 4, ".dll");
+               if (try_load_from (&result, *path, local_culture, name, filename, refonly))
+                       break;
+
+               /* 4th try: [culture]/[name]/[name].exe (culture may be empty) */
+               strcpy (filename + len - 4, ".exe");
+               if (try_load_from (&result, *path, local_culture, name, filename, refonly))
+                       break;
+       }
+
+       g_free (filename);
+       return result;
+}
+
+/*
+ * Try to load referenced assemblies from assemblies_path.
+ */
+static MonoAssembly *
+pedump_preload (MonoAssemblyName *aname,
+                                gchar **assemblies_path,
+                                gpointer user_data)
+{
+       MonoAssembly *result = NULL;
+       gboolean refonly = GPOINTER_TO_UINT (user_data);
+
+       if (assemblies_path && assemblies_path [0] != NULL) {
+               result = real_load (assemblies_path, aname->culture, aname->name, refonly);
+       }
+
+       return result;
+}
+
+static GList *loaded_assemblies = NULL;
+
+static void
+pedump_assembly_load_hook (MonoAssembly *assembly, gpointer user_data)
+{
+       loaded_assemblies = g_list_prepend (loaded_assemblies, assembly);
+}
+
+static MonoAssembly *
+pedump_assembly_search_hook (MonoAssemblyName *aname, gpointer user_data)
+{
+        GList *tmp;
+
+       for (tmp = loaded_assemblies; tmp; tmp = tmp->next) {
+               MonoAssembly *ass = tmp->data;
+               if (mono_assembly_names_equal (aname, &ass->aname))
+                      return ass;
+       }
+       return NULL;
+}
+
+#define VALID_ONLY_FLAG 0x08000000
+#define VERIFY_CODE_ONLY MONO_VERIFY_ALL + 1 
+#define VERIFY_METADATA_ONLY VERIFY_CODE_ONLY + 1
+
 int
 main (int argc, char *argv [])
 {
        MonoImage *image;
        char *file = NULL;
-       int i;
+       char *flags = NULL;
+       MiniVerifierMode verifier_mode = MONO_VERIFIER_MODE_VERIFIABLE;
+       const char *flag_desc [] = {"error", "warn", "cls", "all", "code", "fail-on-verifiable", "non-strict", "valid-only", "metadata", NULL};
+       guint flag_vals [] = {MONO_VERIFY_ERROR, MONO_VERIFY_WARNING, MONO_VERIFY_CLS, MONO_VERIFY_ALL, VERIFY_CODE_ONLY, MONO_VERIFY_FAIL_FAST, MONO_VERIFY_NON_STRICT, VALID_ONLY_FLAG, VERIFY_METADATA_ONLY, 0};
+       int i, verify_flags = MONO_VERIFY_REPORT_ALL_ERRORS, run_new_metadata_verifier = 0;
        
        for (i = 1; i < argc; i++){
                if (argv [i][0] != '-'){
-                       file = argv [1];
+                       file = argv [i];
                        continue;
                }
 
                if (strcmp (argv [i], "--help") == 0)
                        usage ();
-               if (strcmp (argv [i], "--tables") == 0)
-                       dump_tables = 1;
+               else if (strcmp (argv [i], "--verify") == 0) {
+                       verify_pe = 1;
+                       dump_data = 0;
+                       ++i;
+                       flags = argv [i];
+               } else {
+                       usage ();
+               }
        }
        
        if (!file)
                usage ();
 
+       mono_perfcounters_init ();
+       mono_metadata_init ();
+       mono_images_init ();
+       mono_assemblies_init ();
+       mono_loader_init ();
+       if (verify_pe) {
+               char *tok = strtok (flags, ",");
+
+               verify_metadata = 1;
+               verify_code = 0;
+               while (tok) {
+                       for (i = 0; flag_desc [i]; ++i) {
+                               if (strcmp (tok, flag_desc [i]) == 0) {
+                                       if (flag_vals [i] == VERIFY_CODE_ONLY) {
+                                               verify_metadata = 0;
+                                               verify_code = 1;
+                                       } else if(flag_vals [i] == MONO_VERIFY_ALL) {
+                                               verify_code = 1;
+                                       } else if(flag_vals [i] == VERIFY_METADATA_ONLY) {
+                                               verify_metadata = 0;
+                                               run_new_metadata_verifier = 1;
+                                       }
+                                       if (flag_vals [i] == VALID_ONLY_FLAG)
+                                               verifier_mode = MONO_VERIFIER_MODE_VALID;
+                                       else
+                                               verify_flags |= flag_vals [i];
+                                       break;
+                               }
+                       }
+                       if (!flag_desc [i])
+                               g_print ("Unknown verify flag %s\n", tok);
+                       tok = strtok (NULL, ",");
+               }
+
+               mono_verifier_set_mode (verifier_mode);
+               /**/
+       }
+
+       if (verify_pe || run_new_metadata_verifier) {
+               mono_install_assembly_load_hook (pedump_assembly_load_hook, NULL);
+               mono_install_assembly_search_hook (pedump_assembly_search_hook, NULL);
+
+               mono_init_version ("pedump", "v2.0.50727");
+
+               mono_install_assembly_preload_hook (pedump_preload, GUINT_TO_POINTER (FALSE));
+
+               mono_marshal_init ();
+               run_new_metadata_verifier = 1;
+       }
+       
+       if (run_new_metadata_verifier) {
+               int res;
+               mono_verifier_set_mode (MONO_VERIFIER_MODE_VERIFIABLE);
+
+               res = verify_image_file (file);
+               if (res || !verify_code)
+                       return res;
+       }
+
        image = mono_image_open (file, NULL);
        if (!image){
-               fprintf (stderr, "Can not open image %s\n", file);
+               fprintf (stderr, "Cannot open image %s\n", file);
                exit (1);
        }
 
        if (dump_data)
                dump_dotnet_iinfo (image);
-       
-       mono_image_close (image);
+       if (verify_pe) {
+               MonoAssembly *assembly;
+               MonoImage *image;
+               MonoImageOpenStatus status;
+
+               mono_verifier_set_mode (verifier_mode);
+
+               assembly = mono_assembly_open (file, NULL);
+               /*fake an assembly for netmodules so the verifier works*/
+               if (!assembly && (image = mono_image_open (file, &status)) && image->tables [MONO_TABLE_ASSEMBLY].rows == 0) {
+                       assembly = g_new0 (MonoAssembly, 1);
+                       assembly->in_gac = FALSE;
+                       assembly->image = image;
+                       image->assembly = assembly;
+               }
+
+               if (!assembly) {
+                       g_print ("Could not open assembly %s\n", file);
+                       return 4;
+               }
+
+               return dump_verify_info (assembly->image, verify_flags);
+       } else
+               mono_image_close (image);
        
        return 0;
 }