8307480: Improve SA "transported core" documentation for windows

Reviewed-by: sspitsyn, kevinw, poonam
This commit is contained in:
Chris Plummer 2023-05-12 20:36:38 +00:00
parent 9842ff4129
commit 38838b344a

View File

@ -76,9 +76,9 @@ installed on the debugger machine.
is setup: is setup:
</p> </p>
<p> <code>
set PATH=%JAVA_HOME%\bin;%JAVA_HOME%\bin\server;%PATH% set PATH=%JAVA_HOME%\bin;%JAVA_HOME%\bin\server;%PATH%
</p> </code>
<p> <p>
You can also include user JNI libraries in <b>PATH</b>. You can also include user JNI libraries in <b>PATH</b>.
@ -86,6 +86,25 @@ If the windows libraries are not identical, then they may also need to be copied
to the debugger machine and included in <b>PATH</b>. to the debugger machine and included in <b>PATH</b>.
</p> </p>
<p>
By default symbols are also located using <b>PATH</b>. However, there are also Java properties that can be used to specify both the location of the binaries, and also separately the location of symbols. Use <b>sun.jvm.hotspot.debugger.windbg.imagePath</b> for the location of binaries, and use <b>sun.jvm.hotspot.debugger.windbg.symbolPath</b> for the location of symbols. <b>imagePath</b> defaults to <b>PATH</b> if not set, and <b>symbolPath</b> defaults to <b>imagePath</b>. The advantage of using these propeties is that you don't need to change your <b>PATH</b> setting, and they allow for binaries to be located separately from symbols.
</p>
<p>
How you set these properties will depend on the SA tool being used. The following example demonstrates how to set one of the properties when launching the clhsdb tool:
</p>
<code>
jhsdb -J-Dsun.jvm.hotspot.debugger.windbg.imagePath="%PATH%;D:\SomePath" clhsdb
</code>
<p>If you are not seeing symbols for Windows libraries, try setting <b>sun.jvm.hotspot.debugger.windbg.symbolPath</b> to include "<b>srv*https://msdl.microsoft.com/download/symbols</b>". Also include <b>PATH</b> so SA will still find your JVM and JNI symbols. For example:
</p>
<code>
jhsdb -J-Dsun.jvm.hotspot.debugger.windbg.symbolPath="%PATH%;srv*https://msdl.microsoft.com/download/symbol" clhsdb
</code>
<h3>Using transported core dumps on macOS</h3> <h3>Using transported core dumps on macOS</h3>
<p> <p>
SA normally uses the path to the specified java executable to locate the JDK libraries. It will look SA normally uses the path to the specified java executable to locate the JDK libraries. It will look