8307480: Improve SA "transported core" documentation for windows #13849

plummercj · 2023-05-05T23:53:47Z

The SA document transported_core.html contains some tips on getting core files to work when debugging it on a machine other than the one that produced it. There are a few improvements that can be made based on information provided in JDK-8306437 and in the #13530 review (which was eventually pulled as not necessary).

Updates to the document include the use of sun.jvm.hotspot.debugger.windbg.imagePath and sun.jvm.hotspot.debugger.windbg.symbolPath properties, and adding "srv*https://msdl.microsoft.com/download/symbols" to symbolPath.

The rendered html file with these changes can be found here:
https://htmlpreview.github.io/?https://raw.githubusercontent.com/openjdk/jdk/75b10f672a461d3742c51db06ec2625605e45cf0/src/jdk.hotspot.agent/doc/transported_core.html

Progress

Change must be properly reviewed (1 review required, with at least 1 Reviewer)
Change must not contain extraneous whitespace
Commit message must refer to an issue

Issue

JDK-8307480: Improve SA "transported core" documentation for windows

Reviewers

Serguei Spitsyn (@sspitsyn - Reviewer) ⚠️ Review applies to 7f6345fd
Kevin Walls (@kevinjwalls - Committer)
Poonam Bajaj (@poonamparhar - Committer)

Reviewing

Using git

Checkout this PR locally:
$ git fetch https://git.openjdk.org/jdk.git pull/13849/head:pull/13849
$ git checkout pull/13849

Update a local copy of the PR:
$ git checkout pull/13849
$ git pull https://git.openjdk.org/jdk.git pull/13849/head

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 13849

View PR using the GUI difftool:
$ git pr show -t 13849

Using diff file

Download this PR as a diff file:
https://git.openjdk.org/jdk/pull/13849.diff

Webrev

Link to Webrev Comment

bridgekeeper · 2023-05-05T23:54:48Z

👋 Welcome back cjplummer! A progress list of the required criteria for merging this PR into master will be added to the body of your pull request. There are additional pull request commands available for use with this pull request.

openjdk · 2023-05-06T01:17:53Z

@plummercj The following label will be automatically applied to this pull request:

serviceability

When this pull request is ready to be reviewed, an "RFR" email will be sent to the corresponding mailing list. If you would like to change these labels, use the /label pull request command.

mlbridge · 2023-05-06T01:22:29Z

Webrevs

sspitsyn · 2023-05-06T09:45:07Z

src/jdk.hotspot.agent/doc/transported_core.html

+</p>
+
+<p>
+How you set these properties will depend on the SA tool being used. The following in an example of when launching the clhsdb tool:


Typo?: The following in an example of when launching... => The following is an example of launching....

Yes, or maybe "for launching". It's somewhat of a clumsy sentence, but the only fix for that I've come up with for that makes it kind of wordy: "The following example demonstrates how to set one of the properties when launching the clhsdb tool:"

sspitsyn

Looks good.
Posted one comment about a potential typo.
Thanks,
Serguei

openjdk · 2023-05-06T09:49:32Z

@plummercj This change now passes all automated pre-integration checks.

ℹ️ This project also has non-automated pre-integration requirements. Please see the file CONTRIBUTING.md for details.

After integration, the commit message for the final commit will be:

8307480: Improve SA "transported core" documentation for windows

Reviewed-by: sspitsyn, kevinw, poonam

You can use pull request commands such as /summary, /contributor and /issue to adjust it as needed.

At the time when this comment was updated there had been 105 new commits pushed to the master branch:

2bf7ac5: 8297657: name demangling intermittently fails
d20034b: 8307058: Implementation of Generational ZGC
0cbfbc4: 8307813: [JVMCI] Export markWord::lock_mask_in_place to JVMCI compilers.
ba9714d: 8307610: Linker::nativeLinker should not be restricted (mainline)
ecc1d85: 8307869: Remove unnecessary log statements from arm32 fastlocking code
08fa269: 8307349: Support xlc17 clang toolchain on AIX
8ac7186: 8305416: runtime/Thread/TestAlwaysPreTouchStacks.java failed with "Did not find expected NMT output"
984fbbb: 8307810: Consistently use LockingMode instead of UseHeavyMonitors
39f4e4d: 8307758: RISC-V: Improve bit test code introduced by JDK-8291555
3cb606e: 8306965: osThread allocation failures should not abort the VM
... and 95 more: https://git.openjdk.org/jdk/compare/1b143ba78712e7ac98ca9873c50989b3fba07394...master

As there are no conflicts, your changes will automatically be rebased on top of these commits when integrating. If you prefer to avoid this automatic rebasing, please check the documentation for the /integrate command for further details.

➡️ To integrate this PR with the above commit message to the master branch, type /integrate in a new comment.

plummercj · 2023-05-08T23:56:38Z

@apavlyutkin Can you review this?

src/jdk.hotspot.agent/doc/transported_core.html

apavlyutkin · 2023-05-09T15:04:02Z

Lgtm

src/jdk.hotspot.agent/doc/transported_core.html

poonamparhar · 2023-05-11T16:03:54Z

src/jdk.hotspot.agent/doc/transported_core.html


 <p>
 You can also include user JNI libraries in <b>PATH</b>.
 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>.
 </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.


Is "also" needed here? The sentence makes more sense without it.

The "also" is in reference to the previous paragraph mentioning that binaries are located using PATH. In other words, PATH is by default used to locate binaries and also to locate symbols.

poonamparhar · 2023-05-11T16:12:59Z

Looks good.

plummercj · 2023-05-12T20:34:52Z

Thanks for all the reviews!

/integrate

openjdk · 2023-05-12T20:36:44Z

Going to push as commit 38838b3.
Since your change was applied there have been 141 commits pushed to the master branch:

9842ff4: 8306607: Apply 80-column output to javac supported version output
d809823: 8306471: Add virtual threads support to JDWP ThreadReference.Stop and JDI ThreadReference.stop()
4441a23: 6714245: [Col] Collator - Faster Comparison for identical strings.
a284920: 8168469: Memory leak in JceSecurity
7455bb2: 8308015: Syntax of "import static" is incorrect in com.sun.source.tree.ImportTree.java
6ebea89: 8307911: javadoc for MemorySegment::reinterpret has duplicate restricted method paragraph
3c68c35: 8307535: java.util.logging.Handlers should be more VirtualThread friendly
9fa8b9a: 8307409: Refactor usage examples to use @snippet in the java.nio packages
e512a20: 8306541: Refactor collection set candidate handling to prepare for JDK-8140326
4b0f421: 8307855: update for deprecated sprintf for src/utils
... and 131 more: https://git.openjdk.org/jdk/compare/1b143ba78712e7ac98ca9873c50989b3fba07394...master

Your commit was automatically rebased without conflicts.

openjdk · 2023-05-12T20:36:55Z

@plummercj Pushed as commit 38838b3.

💡 You may see a message that your pull request was closed with unmerged commits. This can be safely ignored.

improve windows info

baa6b36

openjdk bot changed the title ~~8307480~~ 8307480: Improve SA "transported core" documentation for windows May 5, 2023

openjdk bot added the rfr Pull request is ready for review label May 6, 2023

openjdk bot added the serviceability serviceability-dev@openjdk.org label May 6, 2023

sspitsyn reviewed May 6, 2023

View reviewed changes

sspitsyn approved these changes May 6, 2023

View reviewed changes

openjdk bot added the ready Pull request is ready to be integrated label May 6, 2023

minor rewording

7f6345f

sspitsyn approved these changes May 9, 2023

View reviewed changes

kevinjwalls reviewed May 9, 2023

View reviewed changes

src/jdk.hotspot.agent/doc/transported_core.html Outdated Show resolved Hide resolved

kevinjwalls approved these changes May 9, 2023

View reviewed changes

src/jdk.hotspot.agent/doc/transported_core.html Show resolved Hide resolved

openjdk bot removed the ready Pull request is ready to be integrated label May 9, 2023

use backslash for directory separator. some additional clarifications.

75b10f6

openjdk bot added the ready Pull request is ready to be integrated label May 9, 2023

kevinjwalls approved these changes May 10, 2023

View reviewed changes

openjdk bot added ready Pull request is ready to be integrated and removed ready Pull request is ready to be integrated labels May 10, 2023

poonamparhar reviewed May 11, 2023

View reviewed changes

poonamparhar approved these changes May 11, 2023

View reviewed changes

openjdk bot added the integrated Pull request has been integrated label May 12, 2023

openjdk bot closed this May 12, 2023

openjdk bot removed ready Pull request is ready to be integrated rfr Pull request is ready for review labels May 12, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

8307480: Improve SA "transported core" documentation for windows #13849

8307480: Improve SA "transported core" documentation for windows #13849

plummercj commented May 5, 2023 •

edited by openjdk bot

Loading

bridgekeeper bot commented May 5, 2023

openjdk bot commented May 6, 2023

mlbridge bot commented May 6, 2023 •

edited

Loading

sspitsyn May 6, 2023

plummercj May 8, 2023

sspitsyn left a comment

openjdk bot commented May 6, 2023 •

edited

Loading

plummercj commented May 8, 2023

apavlyutkin commented May 9, 2023

poonamparhar May 11, 2023

plummercj May 11, 2023

poonamparhar commented May 11, 2023

plummercj commented May 12, 2023

openjdk bot commented May 12, 2023

openjdk bot commented May 12, 2023

8307480: Improve SA "transported core" documentation for windows #13849

8307480: Improve SA "transported core" documentation for windows #13849

Conversation

plummercj commented May 5, 2023 • edited by openjdk bot Loading

Progress

Issue

Reviewers

Reviewing

Webrev

bridgekeeper bot commented May 5, 2023

openjdk bot commented May 6, 2023

mlbridge bot commented May 6, 2023 • edited Loading

Webrevs

sspitsyn May 6, 2023

Choose a reason for hiding this comment

plummercj May 8, 2023

Choose a reason for hiding this comment

sspitsyn left a comment

Choose a reason for hiding this comment

openjdk bot commented May 6, 2023 • edited Loading

plummercj commented May 8, 2023

apavlyutkin commented May 9, 2023

poonamparhar May 11, 2023

Choose a reason for hiding this comment

plummercj May 11, 2023

Choose a reason for hiding this comment

poonamparhar commented May 11, 2023

plummercj commented May 12, 2023

openjdk bot commented May 12, 2023

openjdk bot commented May 12, 2023

plummercj commented May 5, 2023 •

edited by openjdk bot

Loading

mlbridge bot commented May 6, 2023 •

edited

Loading

openjdk bot commented May 6, 2023 •

edited

Loading