annotate hotspot/agent/doc/ReadMe-JavaScript.text @ 29159:7fed45c53518

8074072: Race condition in build since JDK-8072842 can cause failed builds on Solaris Reviewed-by: ihse
author erikj
date Mon, 02 Mar 2015 14:18:01 +0100
parents
children
rev   line source
duke@1 1 The HotSpot Serviceability Agent (SA) is a debugger for hotspot core
duke@1 2 dumps and hung processes. There is a read-only JDI (Java Debugger
duke@1 3 Interface) implementation on top of SA. This is part of JDK product and
duke@1 4 the classes are in $JDK/tools/sa-jdi.jar.
duke@1 5
duke@1 6 In addition, there are few serviceability tools in $JDK/bin, namely,
duke@1 7 jstack (java stack trace tool), jmap (heap tool), jinfo (Java config
duke@1 8 tool) and jsadebugd. The classes for these are also in sa-jdi.jar
duke@1 9 file. sa-jdi.jar file is built along with hotspot (libjvm.so) on Solaris
duke@1 10 and Linux platforms. On Windows platform, SA-JDI is not included and
duke@1 11 serviceability tools do not use SA.
duke@1 12
duke@1 13 Apart from these, HotSpot SA consists of a number of tools that are
duke@1 14 *not* included in JDK product bits.
duke@1 15
duke@1 16 The sources and makefile for all-of-SA (including non-productized stuff)
duke@1 17 are under $HOTSPOT_WS/agent directory. The makefile $HOTSPOT/agent/make
duke@1 18 directory and shell scripts (and batch files) are used to build and run
duke@1 19 SA non-product tools. There is also documentation of SA under
duke@1 20 $HOTSPOT/agent/doc directory.
duke@1 21
duke@1 22 To build complete SA, you need to have Rhino Mozilla jar (js.jar)
duke@1 23 version 1.5R5 under $HOTSPOT/agent/src/share/lib directory. Rhino is
duke@1 24 JavaScript interpreter written in Java. Rhino is used to implement SA
duke@1 25 features such as
duke@1 26
duke@1 27 * SA command line debugger's JavaScript interface
duke@1 28 - refer to $HOTSPOT/agent/doc/clhsdb.html
duke@1 29 - refer to $HOTSPOT/agent/doc/jsdb.html
duke@1 30 * SA simple object query language (SOQL)
duke@1 31 - language to query Java heap.
duke@1 32
duke@1 33 Rhino's "js.jar" is not included in hotspot source bundles. You need to
duke@1 34 download it from http://www.mozilla.org/rhino/download.html.
duke@1 35
duke@1 36 Without js.jar, $HOTSPOT/agent/make/Makefile will fail to build. But,
duke@1 37 note that sa-jdi.jar containing the productized portions of SA will
duke@1 38 still be built when you build hotspot JVM.