1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/agent/doc/ReadMe-JavaScript.text Wed Apr 27 01:25:04 2016 +0800
1.3 @@ -0,0 +1,38 @@
1.4 +The HotSpot Serviceability Agent (SA) is a debugger for hotspot core
1.5 +dumps and hung processes. There is a read-only JDI (Java Debugger
1.6 +Interface) implementation on top of SA. This is part of JDK product and
1.7 +the classes are in $JDK/tools/sa-jdi.jar.
1.8 +
1.9 +In addition, there are few serviceability tools in $JDK/bin, namely,
1.10 +jstack (java stack trace tool), jmap (heap tool), jinfo (Java config
1.11 +tool) and jsadebugd. The classes for these are also in sa-jdi.jar
1.12 +file. sa-jdi.jar file is built along with hotspot (libjvm.so) on Solaris
1.13 +and Linux platforms. On Windows platform, SA-JDI is not included and
1.14 +serviceability tools do not use SA.
1.15 +
1.16 +Apart from these, HotSpot SA consists of a number of tools that are
1.17 +*not* included in JDK product bits.
1.18 +
1.19 +The sources and makefile for all-of-SA (including non-productized stuff)
1.20 +are under $HOTSPOT_WS/agent directory. The makefile $HOTSPOT/agent/make
1.21 +directory and shell scripts (and batch files) are used to build and run
1.22 +SA non-product tools. There is also documentation of SA under
1.23 +$HOTSPOT/agent/doc directory.
1.24 +
1.25 +To build complete SA, you need to have Rhino Mozilla jar (js.jar)
1.26 +version 1.5R5 under $HOTSPOT/agent/src/share/lib directory. Rhino is
1.27 +JavaScript interpreter written in Java. Rhino is used to implement SA
1.28 +features such as
1.29 +
1.30 +* SA command line debugger's JavaScript interface
1.31 + - refer to $HOTSPOT/agent/doc/clhsdb.html
1.32 + - refer to $HOTSPOT/agent/doc/jsdb.html
1.33 +* SA simple object query language (SOQL)
1.34 + - language to query Java heap.
1.35 +
1.36 +Rhino's "js.jar" is not included in hotspot source bundles. You need to
1.37 +download it from http://www.mozilla.org/rhino/download.html.
1.38 +
1.39 +Without js.jar, $HOTSPOT/agent/make/Makefile will fail to build. But,
1.40 +note that sa-jdi.jar containing the productized portions of SA will
1.41 +still be built when you build hotspot JVM.
