Thu Nov 23 20:01:12 CET 2006 Paolo Molaro <lupus@ximian.com>
[mono.git] / mono / monograph / monograph.c
index 710d17fd152224384ce8a859bc45a390d59c31d2..6c30820b8f9d0c3e1dd1f2bf19c8e88aee90c16a 100644 (file)
@@ -1,6 +1,7 @@
 #include <glib.h>
 #include <string.h>
-#include "mono/metadata/class.h"
+#include <math.h>
+#include "mono/metadata/class-internals.h"
 #include "mono/metadata/assembly.h"
 #include "mono/metadata/tokentype.h"
 #include "mono/metadata/opcodes.h"
@@ -8,6 +9,7 @@
 #include "mono/metadata/mono-endian.h"
 #include "mono/metadata/appdomain.h" /* mono_init */
 #include "mono/metadata/debug-helpers.h"
+#include "mono/utils/mono-compiler.h"
 
 static FILE *output;
 static int include_namespace = 0;
@@ -26,20 +28,20 @@ output_type_edge (MonoClass *first, MonoClass *second) {
 static void
 print_subtypes (MonoImage *image, MonoClass *class, int depth) {
        int i, token;
-       MonoTableInfo *t;
+       const MonoTableInfo *t;
        MonoClass *child;
 
        if (depth++ > max_depth)
                return;
 
-       t = &image->tables [MONO_TABLE_TYPEDEF];
+       t = mono_image_get_table_info (image, MONO_TABLE_TYPEDEF);
        
        token = mono_metadata_token_index (class->type_token);
-       token <<= TYPEDEFORREF_BITS;
-       token |= TYPEDEFORREF_TYPEDEF;
+       token <<= MONO_TYPEDEFORREF_BITS;
+       token |= MONO_TYPEDEFORREF_TYPEDEF;
 
        /* use a subgraph? */
-       for (i = 0; i < t->rows; ++i) {
+       for (i = 0; i < mono_table_info_get_rows (t); ++i) {
                if (token == mono_metadata_decode_row_col (t, i, MONO_TYPEDEF_EXTENDS)) {
                        child = mono_class_get (image, MONO_TOKEN_TYPE_DEF | (i + 1));
                        output_type_edge (class, child);
@@ -91,7 +93,7 @@ interface_graph (MonoImage *image, const char* cname) {
        char *p;
        guint32 cols [MONO_INTERFACEIMPL_SIZE];
        guint32 token, i, count = 0;
-       MonoTableInfo *intf = &image->tables [MONO_TABLE_INTERFACEIMPL];
+       const MonoTableInfo *intf = mono_image_get_table_info (image, MONO_TABLE_INTERFACEIMPL);
 
        cname = g_strdup (cname);
        p = strrchr (cname, '.');
@@ -112,9 +114,9 @@ interface_graph (MonoImage *image, const char* cname) {
        fprintf (output, "%s", graph_properties);
        /* TODO: handle inetrface defined in one image and class defined in another. */
        token = mono_metadata_token_index (class->type_token);
-       token <<= TYPEDEFORREF_BITS;
-       token |= TYPEDEFORREF_TYPEDEF;
-       for (i = 0; i < intf->rows; ++i) {
+       token <<= MONO_TYPEDEFORREF_BITS;
+       token |= MONO_TYPEDEFORREF_TYPEDEF;
+       for (i = 0; i < mono_table_info_get_rows (intf); ++i) {
                mono_metadata_decode_row (intf, i, cols, MONO_INTERFACEIMPL_SIZE);
                /*g_print ("index: %d [%d implements %d]\n", index, cols [MONO_INTERFACEIMPL_CLASS], cols [MONO_INTERFACEIMPL_INTERFACE]);*/
                if (token == cols [MONO_INTERFACEIMPL_INTERFACE]) {
@@ -168,13 +170,15 @@ static int cast_sealed = 0;
 static int cast_iface = 0;
 static int total_cast = 0;
 static int nonvirt_callvirt = 0;
+static int iface_callvirt = 0;
 static int total_callvirt = 0;
 
 static void
 method_stats (MonoMethod *method) {
        const MonoOpcode *opcode;
        MonoMethodHeader *header;
-       const unsigned char *ip;
+       MonoMethodSignature *sig;
+       const unsigned char *ip, *il_code_end;
        int i, n;
        int local_branch = 0, local_condbranch = 0, local_throw = 0, local_calls = 0;
        gint64 l;
@@ -184,25 +188,30 @@ method_stats (MonoMethod *method) {
        if (method->flags & (METHOD_ATTRIBUTE_PINVOKE_IMPL | METHOD_ATTRIBUTE_ABSTRACT))
                return;
 
-       header = ((MonoMethodNormal *)method)->header;
-       if (header->num_clauses)
+       header = mono_method_get_header (method);
+       n = mono_method_header_get_num_clauses (header);
+       if (n)
                has_exceptions++;
-       num_exceptions += header->num_clauses;
-       if (max_exceptions < header->num_clauses)
-               max_exceptions = header->num_clauses;
-       if (header->num_locals)
+       num_exceptions += n;
+       if (max_exceptions < n)
+               max_exceptions = n;
+       mono_method_header_get_locals (header, &n, NULL);
+       if (n)
                has_locals++;
-       num_locals += header->num_locals;
-       if (max_locals < header->num_locals)
-               max_locals = header->num_locals;
-
-       if (max_maxstack < header->max_stack)
-               max_maxstack = header->max_stack;
-       num_maxstack += header->max_stack;
-       if (header->max_stack != 8) /* just a guess */
+       num_locals += n;
+       if (max_locals < n)
+               max_locals = n;
+
+       ip = mono_method_header_get_code (header, &n, &i);
+       il_code_end = ip + n;
+       if (max_maxstack < i)
+               max_maxstack = i;
+       num_maxstack += i;
+       if (i != 8) /* just a guess */
                has_maxstack++;
 
-       n = method->signature->hasthis + method->signature->param_count;
+       sig = mono_method_signature (method);
+       n = sig->hasthis + sig->param_count;
        if (max_args < n)
                max_args = n;
        num_args += n;
@@ -210,13 +219,11 @@ method_stats (MonoMethod *method) {
                has_args++;
 
        has_code++;
-       if (max_code < header->code_size)
-               max_code = header->code_size;
-       num_code += header->code_size;
+       if (max_code < il_code_end - ip)
+               max_code = il_code_end - ip;
+       num_code += il_code_end - ip;
 
-       ip = header->code;
-
-       while (ip < (header->code + header->code_size)) {
+       while (ip < il_code_end) {
                if (*ip == 0xfe) {
                        ++ip;
                        i = *ip + 256;
@@ -236,10 +243,10 @@ method_stats (MonoMethod *method) {
                        n = read32 (ip + 1);
                        if (n >= -1 && n <= 8) {
                                int_waste += 4;
-                               g_print ("%s %d\n", mono_opcode_names [i], n);
+                               g_print ("%s %d\n", mono_opcode_name (i), n);
                        } else if (n < 128 && n >= -128) {
                                int_waste += 3;
-                               g_print ("%s %d\n", mono_opcode_names [i], n);
+                               g_print ("%s %d\n", mono_opcode_name (i), n);
                        }
                        ip += 5;
                        break;
@@ -280,16 +287,16 @@ method_stats (MonoMethod *method) {
                                        case MONO_CEE_LDLOC:
                                        case MONO_CEE_STLOC:
                                                var_waste += 3;
-                                               g_print ("%s %d\n", mono_opcode_names [i], n);
+                                               /*g_print ("%s %d\n", mono_opcode_name (i), n);*/
                                                break;
                                        default:
                                                var_waste += 2;
-                                               g_print ("%s %d\n", mono_opcode_names [i], n);
+                                               /*g_print ("%s %d\n", mono_opcode_name (i), n);*/
                                                break;
                                        }
                                } else {
                                        var_waste += 2;
-                                       g_print ("%s %d\n", mono_opcode_names [i], n);
+                                       /*g_print ("%s %d\n", mono_opcode_name (i), n);*/
                                }
                        }
                        ip += 3;
@@ -301,7 +308,7 @@ method_stats (MonoMethod *method) {
                                case MONO_CEE_LDLOC_S:
                                case MONO_CEE_STLOC_S:
                                        var_waste++;
-                                       g_print ("%s %d\n", mono_opcode_names [i], (signed char)ip [1]);
+                                       /*g_print ("%s %d\n", mono_opcode_name (i), (signed char)ip [1]);*/
                                        break;
                                default:
                                        break;
@@ -311,7 +318,7 @@ method_stats (MonoMethod *method) {
                        break;
                case MonoShortInlineI:
                        if ((signed char)ip [1] <= 8 && (signed char)ip [1] >= -1) {
-                               g_print ("%s %d\n", mono_opcode_names [i], (signed char)ip [1]);
+                               /*g_print ("%s %d\n", mono_opcode_name (i), (signed char)ip [1]);*/
                                int_waste ++;
                        }
                        ip += 2;
@@ -351,6 +358,8 @@ method_stats (MonoMethod *method) {
                                MonoMethod *cm = mono_get_method (method->klass->image, read32 (ip + 1), NULL);
                                if (cm && !(cm->flags & METHOD_ATTRIBUTE_VIRTUAL))
                                        nonvirt_callvirt++;
+                               if (cm && (cm->klass->flags & TYPE_ATTRIBUTE_INTERFACE))
+                                       iface_callvirt++;
                                total_callvirt++;
                        }
                        ip += 5;
@@ -404,12 +413,16 @@ method_stats (MonoMethod *method) {
 
 static int num_pdepth = 0;
 static int max_pdepth = 0;
+static int num_pdepth_ovf = 0;
 static int num_ifaces = 0;
+static int *pdepth_array = NULL;
+static int pdepth_array_size = 0;
+static int pdepth_array_next = 0;
 
 static void
 type_stats (MonoClass *klass) {
        MonoClass *parent;
-       int depth = 0;
+       int depth = 1;
 
        if (klass->flags & TYPE_ATTRIBUTE_INTERFACE) {
                num_ifaces++;
@@ -420,9 +433,20 @@ type_stats (MonoClass *klass) {
                depth++;
                parent = parent->parent;
        }
+       if (pdepth_array_next >= pdepth_array_size) {
+               pdepth_array_size *= 2;
+               if (!pdepth_array_size)
+                       pdepth_array_size = 128;
+               pdepth_array = g_realloc (pdepth_array, pdepth_array_size * sizeof (int));
+       }
+       pdepth_array [pdepth_array_next++] = depth;
        num_pdepth += depth;
        if (max_pdepth < depth)
                max_pdepth = depth;
+       if (depth > MONO_DEFAULT_SUPERTABLE_SIZE) {
+               /*g_print ("overflow parent depth: %s.%s\n", klass->name_space, klass->name);*/
+               num_pdepth_ovf++;
+       }
 }
 
 static void
@@ -431,16 +455,16 @@ stats (MonoImage *image, const char *name) {
        MonoMethod *method;
        MonoClass *klass;
        
-       for (i = 0; i < image->tables [MONO_TABLE_METHOD].rows; ++i) {
+       num_methods = mono_image_get_table_rows (image, MONO_TABLE_METHOD);
+       for (i = 0; i < num_methods; ++i) {
                method = mono_get_method (image, MONO_TOKEN_METHOD_DEF | (i + 1), NULL);
                method_stats (method);
        }
-       num_methods = image->tables [MONO_TABLE_METHOD].rows;
-       for (i = 0; i < image->tables [MONO_TABLE_TYPEDEF].rows; ++i) {
+       num_types = mono_image_get_table_rows (image, MONO_TABLE_TYPEDEF);
+       for (i = 0; i < num_types; ++i) {
                klass = mono_class_get (image, MONO_TOKEN_TYPE_DEF | (i + 1));
                type_stats (klass);
        }
-       num_types = image->tables [MONO_TABLE_TYPEDEF].rows;
 
        g_print ("Methods and code stats:\n");
        g_print ("back branch waste: %d\n", back_branch_waste);
@@ -461,10 +485,23 @@ stats (MonoImage *image, const char *name) {
        g_print ("sealed type cast: %d/%d\n", cast_sealed, total_cast);
        g_print ("interface type cast: %d/%d\n", cast_iface, total_cast);
        g_print ("non virtual callvirt: %d/%d\n", nonvirt_callvirt, total_callvirt);
+       g_print ("interface callvirt: %d/%d\n", iface_callvirt, total_callvirt);
        
        g_print ("\nType stats:\n");
        g_print ("interface types: %d/%d\n", num_ifaces, num_types);
-       g_print ("parent depth: max: %d, mean: %d\n", max_pdepth, num_pdepth/(num_types - num_ifaces));
+       {
+               double mean = 0;
+               double stddev = 0;
+               if (pdepth_array_next) {
+                       int i;
+                       mean = (double)num_pdepth/pdepth_array_next;
+                       for (i = 0; i < pdepth_array_next; ++i) {
+                               stddev += (pdepth_array [i] - mean) * (pdepth_array [i] - mean);
+                       }
+                       stddev = sqrt (stddev/pdepth_array_next);
+               }
+               g_print ("parent depth: max: %d, mean: %f, sttdev: %f, overflowing: %d\n", max_pdepth, mean, stddev, num_pdepth_ovf);
+       }
 }
 
 static char *
@@ -481,7 +518,7 @@ get_signature (MonoMethod *method) {
        res = g_string_new ("");
        if (include_namespace && *(method->klass->name_space))
                g_string_sprintfa (res, "%s.", method->klass->name_space);
-       result = mono_signature_get_desc (method->signature, include_namespace);
+       result = mono_signature_get_desc (mono_method_signature (method), include_namespace);
        g_string_sprintfa (res, "%s:%s(%s)", method->klass->name, method->name, result);
        g_free (result);
        g_hash_table_insert (hash, method, res->str);
@@ -514,26 +551,33 @@ print_method (MonoMethod *method, int depth) {
        const MonoOpcode *opcode;
        MonoMethodHeader *header;
        GHashTable *hash;
-       const unsigned char *ip;
+       static GHashTable *visited = NULL;
+       const unsigned char *ip, *il_code_end;
        int i;
 
        if (depth++ > max_depth)
                return;
-       if (method->info) /* avoid recursion */
+       
+       if (! visited)
+               visited = g_hash_table_new (NULL, NULL);
+       
+       if (g_hash_table_lookup (visited, method))
                return;
-       method->info = method;
+       
+       g_hash_table_insert (visited, method, method);
 
        if (method->iflags & (METHOD_IMPL_ATTRIBUTE_INTERNAL_CALL | METHOD_IMPL_ATTRIBUTE_RUNTIME))
                return;
        if (method->flags & (METHOD_ATTRIBUTE_PINVOKE_IMPL | METHOD_ATTRIBUTE_ABSTRACT))
                return;
 
-       header = ((MonoMethodNormal *)method)->header;
-       ip = header->code;
+       header = mono_method_get_header (method);
+       ip = mono_method_header_get_code (header, &i, NULL);
+       il_code_end = ip + i;
 
        hash = g_hash_table_new (g_direct_hash, g_direct_equal);
        
-       while (ip < (header->code + header->code_size)) {
+       while (ip < il_code_end) {
                if (*ip == 0xfe) {
                        ++ip;
                        i = *ip + 256;
@@ -608,7 +652,7 @@ method_graph (MonoImage *image, const char *name) {
        if (!name) {
                guint32 token = mono_image_get_entry_point (image);
                if (!token || !(method = mono_get_method (image, token, NULL))) {
-                       g_print ("Cannot find entry point in %s: specify an explict method name.\n", image->name);
+                       g_print ("Cannot find entry point in %s: specify an explict method name.\n", mono_image_get_filename (image));
                        exit (1);
                }
        } else {
@@ -673,8 +717,8 @@ mono_method_find_bblocks (MonoMethodHeader *header)
        GHashTable *table = g_hash_table_new (g_direct_hash, g_direct_equal);
        MonoBasicBlock *entry_bb, *end_bb, *bb, *target;
 
-       ip = header->code;
-       end = ip + header->code_size;
+       ip = mono_method_header_get_code (header, &i, NULL);
+       end = ip + i;
        debug_start = ip;
 
        entry_bb = g_new0 (MonoBasicBlock, 1);
@@ -824,7 +868,7 @@ mono_method_find_bblocks (MonoMethodHeader *header)
                target = bb;
                /*fprintf (stderr, "bblock %d at IL_%04x:\n", i, bb->cil_code - header->code);*/
        }
-       bb->cil_length = header->code + header->code_size - bb->cil_code;
+       bb->cil_length = end - bb->cil_code;
        return result;
 }
 
@@ -873,8 +917,10 @@ print_method_cfg (MonoMethod *method) {
        MonoMethodHeader *header;
        int i, dfn;
        char *code;
+       const unsigned char *il_code;
 
-       header = ((MonoMethodNormal*)method)->header;
+       header = mono_method_get_header (method);
+       il_code = mono_method_header_get_code (header, NULL, NULL);
        bblocks = mono_method_find_bblocks (header);
        for (i = 0; i < bblocks->len; ++i) {
                bb = (MonoBasicBlock*)g_ptr_array_index (bblocks, i);
@@ -884,7 +930,7 @@ print_method_cfg (MonoMethod *method) {
                        fprintf (output, "\tB%p [shape=record,label=\"end\"]\n", bb);
                else {
                        code = mono_disasm_code (&graph_dh, method, bb->cil_code, bb->cil_code + bb->cil_length);
-                       fprintf (output, "\tB%p [shape=record,label=\"IL_%04x\\n%s\"]\n", bb, bb->cil_code - header->code, code);
+                       fprintf (output, "\tB%p [shape=record,label=\"IL_%04x\\n%s\"]\n", bb, bb->cil_code - il_code, code);
                        g_free (code);
                }
        }
@@ -903,7 +949,7 @@ print_method_cfg (MonoMethod *method) {
        dfn = 0;
        for (i = 0; i < bblocks->len; ++i) {
                bb = (MonoBasicBlock*)g_ptr_array_index (bblocks, i);
-               df_visit (bb, &dfn, header->code);
+               df_visit (bb, &dfn, il_code);
        }
 #endif
 }
@@ -919,7 +965,7 @@ method_cfg (MonoImage *image, const char *name) {
        if (!name) {
                guint32 token = mono_image_get_entry_point (image);
                if (!token || !(method = mono_get_method (image, token, NULL))) {
-                       g_print ("Cannot find entry point in %s: specify an explict method name.\n", image->name);
+                       g_print ("Cannot find entry point in %s: specify an explict method name.\n", mono_image_get_filename (image));
                        exit (1);
                }
        } else {
@@ -949,7 +995,7 @@ static void
 usage (void) {
        printf ("monograph 0.2 Copyright (c) 2002 Ximian, Inc\n");
        printf ("Create call graph or type hierarchy information from CIL assemblies.\n");
-       printf ("Usage: monograph [options] [assembly [typename|methodname]]\n");
+       printf ("Usage: monograph [options] [assembly [typename|methodname]]\n\n");
        printf ("Valid options are:\n");
        printf ("\t-c|--call             output call graph instead of type hierarchy\n");
        printf ("\t-C|--control-flow     output control flow of methodname\n");
@@ -958,14 +1004,16 @@ usage (void) {
        printf ("\t-o|--output filename  write graph to file filename (default: stdout)\n");
        printf ("\t-f|--fullname         include namespace in type and method names\n");
        printf ("\t-n|--neato            invoke neato directly\n");
-       printf ("\t-v|--verbose          verbose operation\n");
-       printf ("The default assembly is corlib.dll. The default method for\n");
-       printf ("the --call and --control-flow options is the entrypoint.\n");
+       printf ("\t-v|--verbose          verbose operation\n\n");
+       printf ("The default assembly is mscorlib.dll. The default method for\n");
+       printf ("the --call and --control-flow options is the entrypoint.\n\n");
        printf ("When the --neato option is used the output type info is taken\n");
-       printf ("from the output filename extension. You need the graphviz package installed\n");
-       printf ("to be able to use this option.\n");
+       printf ("from the output filename extension. You need the graphviz package\n");
+       printf ("installed to be able to use this option and build bitmap files.\n");
+       printf ("Without --neato, monograph will create .dot files, a description\n");
+       printf ("file for a graph.\n\n");
        printf ("Sample runs:\n");
-       printf ("\tmonograph -n -o vt.png corlib.dll System.ValueType\n");
+       printf ("\tmonograph -n -o vt.png mscorlib.dll System.ValueType\n");
        printf ("\tmonograph -n -o expr.png mcs.exe Mono.CSharp.Expression\n");
        printf ("\tmonograph -n -o cfg.png -C mcs.exe Driver:Main\n");
        printf ("\tmonograph -d 3 -n -o callgraph.png -c mis.exe\n");
@@ -997,6 +1045,7 @@ enum {
 int
 main (int argc, char *argv[]) {
        MonoAssembly *assembly;
+       MonoImage *image;
        const char *cname = NULL;
        const char *aname = NULL;
        char *outputfile = NULL;
@@ -1004,7 +1053,6 @@ main (int argc, char *argv[]) {
        int callneato = 0;
        int i;
        
-       mono_init (argv [0]);
        output = stdout;
 
        for (i = 1; i < argc; ++i) {
@@ -1041,12 +1089,16 @@ main (int argc, char *argv[]) {
                aname = argv [i];
        if (argc > i + 1)
                cname = argv [i + 1];
-       if (!aname)
-               aname = "corlib.dll";
+       if (aname) {
+               mono_init_from_assembly (argv [0], aname);
+               assembly = mono_assembly_open (aname, NULL);
+       } else {
+               mono_init (argv [0]);
+               assembly = mono_image_get_assembly (mono_get_corlib ());
+       }
        if (!cname && (graphtype == GRAPH_TYPES))
                cname = "System.Object";
 
-       assembly = mono_assembly_open (aname, NULL);
        if (!assembly) {
                g_print ("cannot open assembly %s\n", aname);
                exit (1);
@@ -1078,21 +1130,22 @@ main (int argc, char *argv[]) {
        if (cname && strchr (cname, ':') && graphtype == GRAPH_TYPES)
                graphtype = GRAPH_CALL;
 
+       image = mono_assembly_get_image (assembly);
        switch (graphtype) {
        case GRAPH_TYPES:
-               type_graph (assembly->image, cname);
+               type_graph (image, cname);
                break;
        case GRAPH_CALL:
-               method_graph (assembly->image, cname);
+               method_graph (image, cname);
                break;
        case GRAPH_INTERFACE:
-               interface_graph (assembly->image, cname);
+               interface_graph (image, cname);
                break;
        case GRAPH_CONTROL_FLOW:
-               method_cfg (assembly->image, cname);
+               method_cfg (image, cname);
                break;
        case GRAPH_STATS:
-               stats (assembly->image, cname);
+               stats (image, cname);
                break;
        default:
                g_error ("wrong graph type");