8290036: Define and specify Runtime shutdown sequence #9437

stuart-marks · 2022-07-08T23:00:15Z

The concept of the shutdown sequence needs to be specified more clearly. This PR adds text for this into the class specification of java.lang.Runtime. Also includes adjustments to related areas in addShutdownHook, halt, and in the System and Thread classes. The changes here should coordinate with similar changes to JLS 12.8, JVMS 5.7, and the Invocation API chapter of the JNI Specification.

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
Change requires a CSR request to be approved

Issues

JDK-8290036: Define and specify Runtime shutdown sequence
JDK-8294817: Define and specify Runtime shutdown sequence (CSR)

Reviewers

David Holmes (@dholmes-ora - Reviewer) ⚠️ Review applies to ca369058
Alan Bateman (@AlanBateman - Reviewer) ⚠️ Review applies to ca369058

Reviewing

Using git

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

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

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 9437

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

Using diff file

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

bridgekeeper · 2022-07-08T23:01:32Z

👋 Welcome back smarks! 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 · 2022-07-08T23:04:40Z

@stuart-marks The following label will be automatically applied to this pull request:

core-libs

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.

src/java.base/share/classes/java/lang/Runtime.java

dholmes-ora

Hi Stuart,

There's nothing I would consider harmful in these changes, but I also don't see them as necessary.

Cheers.

src/java.base/share/classes/java/lang/Runtime.java

stuart-marks · 2022-07-13T16:31:14Z

Sorry David I should have clarified this a bit. The changes currently in this draft PR are merely what occurred to Alex and me while we were working on JLS 12.8. There are a bunch of other issues that need to be covered or at clarified clarified here, or possibly in the Runtime class specification. I'll add them to the bug report, and eventually we'll update this PR with further changes.

stuart-marks · 2022-07-15T21:50:20Z

Discussion of the changes in this PR are taking place in the bug report:

https://bugs.openjdk.org/browse/JDK-8290036

stuart-marks · 2022-08-03T00:51:36Z

/csr

openjdk · 2022-08-03T00:53:29Z

@stuart-marks has indicated that a compatibility and specification (CSR) request is needed for this pull request.

@stuart-marks please create a CSR request for issue JDK-8290036 with the correct fix version. This pull request cannot be integrated until the CSR request is approved.

mlbridge · 2022-08-03T00:54:48Z

Webrevs

src/java.base/share/classes/java/lang/Runtime.java

- specify that starting a shutdown hook explicitly has an unspecified effect on the shutdown sequence - link Thread class doc to shutdown sequence - link to Thread.UncaughtExceptionHandler - clarify that only live non-daemon threads are significant - use "thread termination" to conform to the text in the Thread class - adjust line breaks and whitespace

src/java.base/share/classes/java/lang/Thread.java

src/java.base/share/classes/java/lang/System.java

src/java.base/share/classes/java/lang/Thread.java

dholmes-ora

Hi Stuart,

Looking good overall. A few minor comments and one more substantive one regarding DestroyJavaVM.

Thanks,
David

src/java.base/share/classes/java/lang/Runtime.java

src/java.base/share/classes/java/lang/Thread.java

src/java.base/share/classes/java/lang/Runtime.java

src/java.base/share/classes/java/lang/Thread.java

src/java.base/share/classes/java/lang/Runtime.java

stuart-marks · 2022-09-30T21:51:13Z

OK, I finally got back to this. I incorporated most suggested edits. Please re-review.

AlanBateman

The updates in ca36905 look okay to me, I don't have any more comments/issues.

dholmes-ora

Looks good! Noting further from me. Thanks @stuart-marks !

stuart-marks · 2022-10-05T04:10:02Z

CSR drafted, please review:

https://bugs.openjdk.org/browse/JDK-8294817

stuart-marks · 2022-10-05T23:29:47Z

/integrate

openjdk · 2022-10-05T23:31:16Z

@stuart-marks This pull request has not yet been marked as ready for integration.

openjdk · 2022-10-05T23:33:53Z

@stuart-marks 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:

8290036: Define and specify Runtime shutdown sequence

Reviewed-by: dholmes, alanb

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 17 new commits pushed to the master branch:

0ec1838: 8294869: Correct failure of RemovedJDKInternals.java after JDK-8294618
87acfee: 8294397: Replace StringBuffer with StringBuilder within java.text
f2c5718: 8294734: Redundant override in AES implementation
536c9a5: 8294618: Update openjdk.java.net => openjdk.org
f531dae: 8294840: langtools OptionalDependencyTest.java use File.pathSeparator
ee6c391: 8289925: Shared code shouldn't reference the platform specific method frame::interpreter_frame_last_sp()
bd90c4c: 8282900: runtime/stringtable/StringTableCleaningTest.java verify unavailable at this moment
979efd4: 8289004: investigate if SharedRuntime::get_java_tid parameter should be a JavaThread*
b9eeec2: 8294310: compare.sh fails on macos after JDK-8293550
13a5000: 8294151: JFR: Unclear exception message when dumping stopped in memory recording
... and 7 more: https://git.openjdk.org/jdk/compare/1dafbe3f944fdb3027df38a886fd15abc3b476a7...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.

stuart-marks · 2022-10-05T23:41:42Z

I guess I got into a race with the bot and lost. Retrying.

/integrate

openjdk · 2022-10-05T23:43:13Z

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

0ec1838: 8294869: Correct failure of RemovedJDKInternals.java after JDK-8294618
87acfee: 8294397: Replace StringBuffer with StringBuilder within java.text
f2c5718: 8294734: Redundant override in AES implementation
536c9a5: 8294618: Update openjdk.java.net => openjdk.org
f531dae: 8294840: langtools OptionalDependencyTest.java use File.pathSeparator
ee6c391: 8289925: Shared code shouldn't reference the platform specific method frame::interpreter_frame_last_sp()
bd90c4c: 8282900: runtime/stringtable/StringTableCleaningTest.java verify unavailable at this moment
979efd4: 8289004: investigate if SharedRuntime::get_java_tid parameter should be a JavaThread*
b9eeec2: 8294310: compare.sh fails on macos after JDK-8293550
13a5000: 8294151: JFR: Unclear exception message when dumping stopped in memory recording
... and 7 more: https://git.openjdk.org/jdk/compare/1dafbe3f944fdb3027df38a886fd15abc3b476a7...master

Your commit was automatically rebased without conflicts.

openjdk · 2022-10-05T23:43:33Z

@stuart-marks Pushed as commit d4142d8.

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

Initial edits to addShutdownHook from Alex

9df8685

openjdk bot added the core-libs core-libs-dev@openjdk.org label Jul 8, 2022

dholmes-ora reviewed Jul 13, 2022

View reviewed changes

src/java.base/share/classes/java/lang/Runtime.java Outdated Show resolved Hide resolved

dholmes-ora reviewed Jul 13, 2022

View reviewed changes

src/java.base/share/classes/java/lang/Runtime.java Outdated Show resolved Hide resolved

stuart-marks added 3 commits July 14, 2022 22:16

First cut at new shutdown sequence text.

83087e5

Merge branch 'master' into JDK-8290036-Runtime-addShutdownHook-spec

23ecb17

Updates to Runtime class spec, exit, halt, and System.exit

9bec54e

stuart-marks added 2 commits July 18, 2022 14:30

HTML fixups; updates in response to review comments.

156cec8

Additional wording changes to Runtime specs.

4d7d6f7

stuart-marks marked this pull request as ready for review August 3, 2022 00:47

openjdk bot added rfr Pull request is ready for review csr Pull request needs approved CSR before integration labels Aug 3, 2022

AlanBateman reviewed Aug 3, 2022

View reviewed changes

stuart-marks changed the title ~~8290036: adjustments to specification of Runtime::addShutdownHook~~ 8290036: Define and specify Runtime shutdown sequence Aug 4, 2022

AlanBateman reviewed Aug 4, 2022

View reviewed changes

src/java.base/share/classes/java/lang/Thread.java Outdated Show resolved Hide resolved

stuart-marks added 2 commits August 5, 2022 13:38

More updates after discussion with Alex.

5a16ea3

More edits from Alex's suggestions.

d348cca

AlanBateman reviewed Aug 6, 2022

View reviewed changes

src/java.base/share/classes/java/lang/System.java Outdated Show resolved Hide resolved

src/java.base/share/classes/java/lang/Thread.java Outdated Show resolved Hide resolved

src/java.base/share/classes/java/lang/Thread.java Outdated Show resolved Hide resolved

dholmes-ora suggested changes Aug 8, 2022

View reviewed changes

Updates from Alan, David, and Alex.

c8b331f

AlanBateman approved these changes Aug 9, 2022

View reviewed changes

Revise Implementation Note discussing JNI Invocation API.

783b3b5

dholmes-ora reviewed Aug 11, 2022

View reviewed changes

dfuch reviewed Aug 11, 2022

View reviewed changes

src/java.base/share/classes/java/lang/Runtime.java Outdated Show resolved Hide resolved

Minor adjustments

9796557

AlanBateman reviewed Aug 27, 2022

View reviewed changes

src/java.base/share/classes/java/lang/Thread.java Outdated Show resolved Hide resolved

dholmes-ora reviewed Aug 28, 2022

View reviewed changes

src/java.base/share/classes/java/lang/Runtime.java Outdated Show resolved Hide resolved

stuart-marks added 2 commits September 27, 2022 14:47

Merge branch 'master' into JDK-8290036-Runtime-addShutdownHook-spec

6b559c4

Additional edits to Runtime and Thread specs.

ca36905

AlanBateman approved these changes Oct 1, 2022

View reviewed changes

dholmes-ora approved these changes Oct 4, 2022

View reviewed changes

Merge branch 'master' into JDK-8290036-Runtime-addShutdownHook-spec

9fa2950

openjdk bot removed the csr Pull request needs approved CSR before integration label Oct 5, 2022

openjdk bot added the ready Pull request is ready to be integrated label Oct 5, 2022

openjdk bot added the integrated Pull request has been integrated label Oct 5, 2022

openjdk bot closed this Oct 5, 2022

openjdk bot removed ready Pull request is ready to be integrated rfr Pull request is ready for review labels Oct 5, 2022

8290036: Define and specify Runtime shutdown sequence #9437

8290036: Define and specify Runtime shutdown sequence #9437

stuart-marks commented Jul 8, 2022 •

edited by openjdk bot

bridgekeeper bot commented Jul 8, 2022

openjdk bot commented Jul 8, 2022

dholmes-ora left a comment

stuart-marks commented Jul 13, 2022

stuart-marks commented Jul 15, 2022

stuart-marks commented Aug 3, 2022

openjdk bot commented Aug 3, 2022

mlbridge bot commented Aug 3, 2022 •

edited

dholmes-ora left a comment

stuart-marks commented Sep 30, 2022

AlanBateman left a comment

dholmes-ora left a comment

stuart-marks commented Oct 5, 2022

stuart-marks commented Oct 5, 2022

openjdk bot commented Oct 5, 2022

openjdk bot commented Oct 5, 2022

stuart-marks commented Oct 5, 2022

openjdk bot commented Oct 5, 2022

openjdk bot commented Oct 5, 2022

8290036: Define and specify Runtime shutdown sequence #9437

8290036: Define and specify Runtime shutdown sequence #9437

Conversation

stuart-marks commented Jul 8, 2022 • edited by openjdk bot

Progress

Issues

Reviewers

Reviewing

bridgekeeper bot commented Jul 8, 2022

openjdk bot commented Jul 8, 2022

dholmes-ora left a comment

Choose a reason for hiding this comment

stuart-marks commented Jul 13, 2022

stuart-marks commented Jul 15, 2022

stuart-marks commented Aug 3, 2022

openjdk bot commented Aug 3, 2022

mlbridge bot commented Aug 3, 2022 • edited

Webrevs

dholmes-ora left a comment

Choose a reason for hiding this comment

stuart-marks commented Sep 30, 2022

AlanBateman left a comment

Choose a reason for hiding this comment

dholmes-ora left a comment

Choose a reason for hiding this comment

stuart-marks commented Oct 5, 2022

stuart-marks commented Oct 5, 2022

openjdk bot commented Oct 5, 2022

openjdk bot commented Oct 5, 2022

stuart-marks commented Oct 5, 2022

openjdk bot commented Oct 5, 2022

openjdk bot commented Oct 5, 2022

stuart-marks commented Jul 8, 2022 •

edited by openjdk bot

mlbridge bot commented Aug 3, 2022 •

edited