agent/doc/clhsdb.html

Sat, 01 Dec 2007 00:00:00 +0000

author
duke
date
Sat, 01 Dec 2007 00:00:00 +0000
changeset 435
a61af66fc99e
child 4037
da91efe96a93
permissions
-rw-r--r--

Initial load

duke@435 1 <html>
duke@435 2 <head>
duke@435 3 <title>
duke@435 4 Command line HSDB
duke@435 5 </title>
duke@435 6 </head>
duke@435 7 <body>
duke@435 8
duke@435 9 <h1>Command line HSDB</h1>
duke@435 10 <p>
duke@435 11 When debugging remote core dumps it is easier to work with command line tools instead of
duke@435 12 GUI tools. Command line HSDB (CLHSDB) tool is alternative to SA GUI tool HSDB.
duke@435 13 </p>
duke@435 14
duke@435 15 <p>
duke@435 16 There is also JavaScript based SA command line interface called <a href="jsdb.html">jsdb</a>.
duke@435 17 But, CLHSDB supports Unix shell-like (or dbx/gdb-like) command line interface with
duke@435 18 support for output redirection/appending (familiar >, >>), command history and so on.
duke@435 19 Each CLHSDB command can have zero or more arguments and optionally end with output redirection
duke@435 20 (or append) to a file. Commands may be stored in a file and run using <b>source</b> command.
duke@435 21 <b>help</b> command prints usage message for all supported commands (or a specific command)
duke@435 22 </p>
duke@435 23
duke@435 24 <h3>Shell/batch scripts to run command line HSDB</h3>
duke@435 25
duke@435 26 <ul>
duke@435 27 <li>clhsdbproc.sh
duke@435 28 <li>clhsdbproc64.sh
duke@435 29 <li>clhsdbwindbg.bat
duke@435 30 <li>clhsdbwindbg64.bat
duke@435 31 </ul>
duke@435 32
duke@435 33 <h3>Annotated output of CLHSDB help command</h3>
duke@435 34
duke@435 35 <pre>
duke@435 36 <code>
duke@435 37 Available commands:
duke@435 38 assert true | false <font color="red">turn on/off asserts in SA code</font>
duke@435 39 attach pid | exec core <font color="red">attach SA to a process or core</font>
duke@435 40 class name <font color="red">find a Java class from debuggee and print oop</font>
duke@435 41 classes <font color="red">print all loaded Java classes with klassOop</font>
duke@435 42 detach <font color="red">detach SA from current target</font>
duke@435 43 dis address [ length ] <font color="red">disassemble (sparc/x86) specified number of instructions from given address</font>
duke@435 44 dumpclass { address | name } [ directory ] <font color="red">dump .class file for given klassOop or class name</font>
duke@435 45 dumpheap [ file ] <font color="red">dump heap in hprof binary format</font>
duke@435 46 echo [ true | false ] <font color="red">turn on/off command echo mode</font>
duke@435 47 examine [ address/count ] | [ address,address] <font color="red">show contents of memory from given address</font>
duke@435 48 field [ type [ name fieldtype isStatic offset address ] ] <font color="red">print info about a field of HotSpot type</font>
duke@435 49 findpc address <font color="red">print info. about pointer location</font>
duke@435 50 flags [ flag ] <font color="red">show all -XX flag name value pairs. or just show given flag</font>
duke@435 51 help [ command ] <font color="red">print help message for all commands or just given command</font>
duke@435 52 history <font color="red">show command history. usual !command-number syntax works.</font>
duke@435 53 inspect expression <font color="red">inspect a given oop</font>
duke@435 54 jdis address <font color="red">show bytecode disassembly of a given methodOop</font>
duke@435 55 jhisto <font color="red">show Java heap histogram</font>
duke@435 56 jseval script <font color="red">evaluate a given string as JavaScript code</font>
duke@435 57 jsload file <font color="red">load and evaluate a JavaScript file</font>
duke@435 58 jstack [-v] <font color="red">show Java stack trace of all Java threads. -v is verbose mode</font>
duke@435 59 livenmethods <font color="red">show all live nmethods</font>
duke@435 60 mem address [ length ] <font color="red">show contents of memory -- also shows closest ELF/COFF symbol if found</font>
duke@435 61 pmap <font color="red">show Solaris pmap-like output</font>
duke@435 62 print expression <font color="red">print given klassOop, methodOop or arbitrary address</font>
duke@435 63 printas type expression <font color="red">print given address as given HotSpot type. eg. print JavaThread &lt;address&gt;</font>
duke@435 64 printstatics [ type ] <font color="red">print static fields of given HotSpot type (or all types if none specified)</font>
duke@435 65 pstack [-v] <font color="red">show mixed mode stack trace for all Java, non-Java threads. -v is verbose mode</font>
duke@435 66 quit <font color="red">quit CLHSDB tool</font>
duke@435 67 reattach <font color="red">detach and re-attach SA to current target</font>
duke@435 68 scanoops start end [ type ] <font color="red">scan a Oop from given start to end address</font>
duke@435 69 search [ heap | codecache | threads ] value <font color="red">search a value in heap or codecache or threads</font>
duke@435 70 source filename <font color="red">load and execute CLHSDB commands from given file</font>
duke@435 71 symbol name <font color="red">show address of a given ELF/COFF symbol</font>
duke@435 72 sysprops <font color="red">show all Java System properties</font>
duke@435 73 threads <font color="red">show all Java threads</font>
duke@435 74 tokenize ...
duke@435 75 type [ type [ name super isOop isInteger isUnsigned size ] ] <font color="red">show info. on HotSpot type</font>
duke@435 76 universe <font color="red">print gc universe</font>
duke@435 77 verbose true | false <font color="red">turn on/off verbose mode</font>
duke@435 78 versioncheck [ true | false ] <font color="red">turn on/off debuggee VM version check</font>
duke@435 79 whatis address <font color="red">print info about any arbitrary address</font>
duke@435 80 where { -a | id } <font color="red">print Java stack trace of given Java thread or all Java threads (-a)</font>
duke@435 81 </code>
duke@435 82 </pre>
duke@435 83
duke@435 84 <h3>JavaScript integration</h3>
duke@435 85
duke@435 86 <p>Few CLHSDB commands are already implemented in JavaScript. It is possible to extend CLHSDB command set
duke@435 87 by implementing more commands in a JavaScript file and by loading it by <b>jsload</b> command. <b>jseval</b>
duke@435 88 command may be used to evaluate arbitrary JavaScript expression from a string. Any JavaScript function
duke@435 89 may be exposed as a CLHSDB command by registering it using JavaScript <b><code>registerCommand</code></b>
duke@435 90 function. This function accepts command name, usage and name of the JavaScript implementation function
duke@435 91 as arguments.
duke@435 92 </p>
duke@435 93
duke@435 94 <h3>Simple CLHSDB command implemented in JavaScript</h3>
duke@435 95
duke@435 96 <b>File: test.js</b>
duke@435 97 <pre>
duke@435 98 <code>
duke@435 99 function helloImpl(name) {
duke@435 100 println("hello, " + name);
duke@435 101 }
duke@435 102
duke@435 103 // register the above JavaScript function as CLHSDB command
duke@435 104 registerCommand("hello", "hello name", "helloImpl");
duke@435 105 </code>
duke@435 106 </pre>
duke@435 107 ---------<br>
duke@435 108
duke@435 109 "test.js" can be loaded in CLHSDB prompt using <b>jsload</b> command using
duke@435 110
duke@435 111 <pre>
duke@435 112 <code>
duke@435 113 hsdb&gt; jsload test.js
duke@435 114 </code>
duke@435 115 </pre>
duke@435 116
duke@435 117 </body>
duke@435 118 </html>

mercurial