hotspot/src/share/tools/IdealGraphVisualizer/README
author mchung
Wed, 10 Feb 2010 17:51:07 -0800
changeset 4917 c98da2209f8c
parent 1497 cd3234c89e59
permissions -rw-r--r--
6915413: Module build: building of specified jdk components instead of all Summary: Define new SUBDIRS_* variables for specifying components for one group Reviewed-by: ohair
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
768
d0bebc7eefc2 6718676: putback for 6604014 is incomplete
never
parents:
diff changeset
     1
The Ideal Graph Visualizer is a tool developed to help examine the
d0bebc7eefc2 6718676: putback for 6604014 is incomplete
never
parents:
diff changeset
     2
intermediate representation of C2 which is commonly referred to as the
d0bebc7eefc2 6718676: putback for 6604014 is incomplete
never
parents:
diff changeset
     3
"ideal graph".  It was developed in collaboration with the University
d0bebc7eefc2 6718676: putback for 6604014 is incomplete
never
parents:
diff changeset
     4
of Linz in Austria and has been included as part of hotspot since that
d0bebc7eefc2 6718676: putback for 6604014 is incomplete
never
parents:
diff changeset
     5
was the primary target of the tool.  The tool itself is fairly general
d0bebc7eefc2 6718676: putback for 6604014 is incomplete
never
parents:
diff changeset
     6
with only a few modules that contain C2 specific elements.
d0bebc7eefc2 6718676: putback for 6604014 is incomplete
never
parents:
diff changeset
     7
1497
cd3234c89e59 6764622: IdealGraphVisualizer fixes
never
parents: 768
diff changeset
     8
The tool is built on top of the NetBeans 6.1 rich client
768
d0bebc7eefc2 6718676: putback for 6604014 is incomplete
never
parents:
diff changeset
     9
infrastructure and so requires NetBeans to build.  It currently
d0bebc7eefc2 6718676: putback for 6604014 is incomplete
never
parents:
diff changeset
    10
requires Java 6 to run as it needs support for JavaScript for its
d0bebc7eefc2 6718676: putback for 6604014 is incomplete
never
parents:
diff changeset
    11
filtering mechanism and assumes it's built into the platform.  It
1497
cd3234c89e59 6764622: IdealGraphVisualizer fixes
never
parents: 768
diff changeset
    12
should build out of the box with NetBeans 6.1 and Java 6 or later.
cd3234c89e59 6764622: IdealGraphVisualizer fixes
never
parents: 768
diff changeset
    13
It's possible to run it on 1.5 by including Rhino on the classpath
cd3234c89e59 6764622: IdealGraphVisualizer fixes
never
parents: 768
diff changeset
    14
though that currently isn't working correctly.  Support for exporting
cd3234c89e59 6764622: IdealGraphVisualizer fixes
never
parents: 768
diff changeset
    15
graphs as SVG can be enabled by adding batik to the classpath which
cd3234c89e59 6764622: IdealGraphVisualizer fixes
never
parents: 768
diff changeset
    16
isn't included by default.  It can be built on top of NetBeans 6.0 if
cd3234c89e59 6764622: IdealGraphVisualizer fixes
never
parents: 768
diff changeset
    17
you change the required modules to be platform7 instead of platform8.
768
d0bebc7eefc2 6718676: putback for 6604014 is incomplete
never
parents:
diff changeset
    18
d0bebc7eefc2 6718676: putback for 6604014 is incomplete
never
parents:
diff changeset
    19
The JVM support is controlled by the flag -XX:PrintIdealGraphLevel=#
d0bebc7eefc2 6718676: putback for 6604014 is incomplete
never
parents:
diff changeset
    20
where # is:
d0bebc7eefc2 6718676: putback for 6604014 is incomplete
never
parents:
diff changeset
    21
d0bebc7eefc2 6718676: putback for 6604014 is incomplete
never
parents:
diff changeset
    22
  0: no output, the default
d0bebc7eefc2 6718676: putback for 6604014 is incomplete
never
parents:
diff changeset
    23
  1: dumps graph after parsing, before matching, and final code.
d0bebc7eefc2 6718676: putback for 6604014 is incomplete
never
parents:
diff changeset
    24
     also dumps graph for failed compiles, if available
d0bebc7eefc2 6718676: putback for 6604014 is incomplete
never
parents:
diff changeset
    25
  2: more detail, including after loop opts
d0bebc7eefc2 6718676: putback for 6604014 is incomplete
never
parents:
diff changeset
    26
  3: even more detail
d0bebc7eefc2 6718676: putback for 6604014 is incomplete
never
parents:
diff changeset
    27
  4: prints graph after parsing every bytecode (very slow)
d0bebc7eefc2 6718676: putback for 6604014 is incomplete
never
parents:
diff changeset
    28
d0bebc7eefc2 6718676: putback for 6604014 is incomplete
never
parents:
diff changeset
    29
By default the JVM expects that it will connect to a visualizer on the
d0bebc7eefc2 6718676: putback for 6604014 is incomplete
never
parents:
diff changeset
    30
local host on port 4444.  This can be configured using the options
d0bebc7eefc2 6718676: putback for 6604014 is incomplete
never
parents:
diff changeset
    31
-XX:PrintIdealGraphAddress= and -XX:PrintIdealGraphPort=.
d0bebc7eefc2 6718676: putback for 6604014 is incomplete
never
parents:
diff changeset
    32
PrintIdealGraphAddress can actually be a hostname.
d0bebc7eefc2 6718676: putback for 6604014 is incomplete
never
parents:
diff changeset
    33
d0bebc7eefc2 6718676: putback for 6604014 is incomplete
never
parents:
diff changeset
    34
Alternatively the output can be sent to a file using
d0bebc7eefc2 6718676: putback for 6604014 is incomplete
never
parents:
diff changeset
    35
-XX:PrintIdealGraphFile=filename.  Each compiler thread will get it's
d0bebc7eefc2 6718676: putback for 6604014 is incomplete
never
parents:
diff changeset
    36
own file with unique names being generated by adding a number onto the
d0bebc7eefc2 6718676: putback for 6604014 is incomplete
never
parents:
diff changeset
    37
provided file name.
d0bebc7eefc2 6718676: putback for 6604014 is incomplete
never
parents:
diff changeset
    38
d0bebc7eefc2 6718676: putback for 6604014 is incomplete
never
parents:
diff changeset
    39
More information about the tool is available at
d0bebc7eefc2 6718676: putback for 6604014 is incomplete
never
parents:
diff changeset
    40
http://wikis.sun.com/display/HotSpotInternals/IdealGraphVisualizer.