8263709: Cleanup THREAD/TRAPS/CHECK usage in JRT_ENTRY routines #3394

dholmes-ora · 2021-04-08T06:52:15Z

The existing JRT_ENTRY (and related) macros require the function to which they are applied to declare a parameter "JavaThread* thread" which represents the current thread. These functions are all implicitly "traps" functions as they can result in exceptions, but they are not declared with TRAPS because the only caller of these functions is the runtime itself (via call_VM) and no callers need to be aware to use CHECK; further they need a JavaThread. So the macro declares the THREAD variable for use with other exception-producing functions and assigns it from "thread".

The majority of this change replaces the parameter name "thread" with "current" so that it is clear that we are always dealing with the current thread. This affects the entry functions as well as the functions called therefrom.

We can then also replace the use of "THREAD" with "current", in contexts that are not related to exception processing.

Some methods called by entry functions were declared to have both a "thread" parameter and a "TRAPS" parameter - with nothing to tell you these are always the same, current, thread. So the "thread" parameter is removed and replaced with a local variable "current" obtained from THREAD->as_Java_thread().

Some missing CHECK_ uses were added.

Testing:

tiers 1-3

Thanks,
David

Progress

Change must not contain extraneous whitespace
Commit message must refer to an issue
Change must be properly reviewed

Issue

JDK-8263709: Cleanup THREAD/TRAPS/CHECK usage in JRT_ENTRY routines

Reviewers

Coleen Phillimore (@coleenp - Reviewer) ⚠️ Review applies to 1adf0fd
Harold Seigel (@hseigel - Reviewer) ⚠️ Review applies to 9cfc43c
Ioi Lam (@iklam - Reviewer) ⚠️ Review applies to 9cfc43c
Vladimir Kozlov (@vnkozlov - Reviewer) ⚠️ Review applies to 9cfc43c

Reviewing

Using git

Checkout this PR locally:
$ git fetch https://git.openjdk.java.net/jdk pull/3394/head:pull/3394
$ git checkout pull/3394

Update a local copy of the PR:
$ git checkout pull/3394
$ git pull https://git.openjdk.java.net/jdk pull/3394/head

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 3394

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

Using diff file

Download this PR as a diff file:
https://git.openjdk.java.net/jdk/pull/3394.diff

bridgekeeper · 2021-04-08T06:53:33Z

👋 Welcome back dholmes! 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.

dholmes-ora · 2021-04-08T06:56:27Z

/cc hotspot-runtime
/cc hotspot-compiler
/cc remove hotspot

openjdk · 2021-04-08T07:17:03Z

@dholmes-ora
The hotspot-runtime label was successfully added.

mlbridge · 2021-04-08T07:39:26Z

Webrevs

openjdk · 2021-04-08T08:10:11Z

@dholmes-ora
The hotspot-compiler label was successfully added.

openjdk · 2021-04-08T08:12:13Z

@dholmes-ora The hotspot label was not set.

coleenp

I think substituting "JavaThread* thread" for "JavaThread* current" is a good change and convention that makes the code more clear, so worth the dull code review and diffs.

src/hotspot/share/c1/c1_Runtime1.cpp

src/hotspot/share/interpreter/interpreterRuntime.cpp

openjdk · 2021-04-08T13:01:46Z

@dholmes-ora 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:

8263709: Cleanup THREAD/TRAPS/CHECK usage in JRT_ENTRY routines

Reviewed-by: coleenp, hseigel, iklam, kvn

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 no new commits pushed to the master branch. If another commit should be pushed before you perform the /integrate command, your PR will be automatically rebased. If you prefer to avoid any potential 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.

src/hotspot/share/interpreter/interpreterRuntime.cpp

dholmes-ora · 2021-04-08T13:13:42Z

Looks like I missed some definitions that aren't included in our test builds but have been found via GHA builds. I will rectify those and update.

…Runtime.cpp

…n it can be passed in

hseigel

Nice big cleanup! LGTM
Harold

iklam

LGTM

dholmes-ora · 2021-04-12T21:53:14Z

Thanks for the reviews @coleenp , @hseigel and @iklam .

Can someone from compiler team please take a look and give the okay? (I know things are a bit busy at the moment.)

Thanks,
David

dholmes-ora · 2021-04-14T02:29:10Z

Repeating this as the bots failed to send out an email.

Thanks for the reviews @coleenp , @hseigel and @iklam .

Can someone from compiler team please take a look and give the okay? (I know things are a bit busy at the moment.)

Thanks,
David

vnkozlov

Why you kept JavaThread *thread parameter in some methods and renamed in others in deoptimization.* files.

vnkozlov · 2021-04-14T23:33:58Z

src/hotspot/share/c1/c1_Runtime1.cpp

-    RegisterMap reg_map(thread, false);
-    frame runtime_frame = thread->last_frame();
+static void deopt_caller(JavaThread* current) {
+  if ( !caller_is_deopted(current)) {


Can you remove space after ( ?

vnkozlov · 2021-04-15T00:03:22Z

I also don't see changes in src/hotspot/share/ci/. Is code there okay?

mlbridge · 2021-04-15T00:18:15Z

Mailing list message from David Holmes on hotspot-runtime-dev:

Hi Vladimir,

Thanks for looking at this.

On 15/04/2021 9:52 am, Vladimir Kozlov wrote:

On Fri, 9 Apr 2021 05:08:37 GMT, David Holmes <dholmes at openjdk.org> wrote:

The existing JRT_ENTRY (and related) macros require the function to which they are applied to declare a parameter "JavaThread* thread" which represents the current thread. These functions are all implicitly "traps" functions as they can result in exceptions, but they are not declared with TRAPS because the only caller of these functions is the runtime itself (via call_VM) and no callers need to be aware to use CHECK; further they need a JavaThread. So the macro declares the THREAD variable for use with other exception-producing functions and assigns it from "thread".

The majority of this change replaces the parameter name "thread" with "current" so that it is clear that we are always dealing with the current thread. This affects the entry functions as well as the functions called therefrom.

We can then also replace the use of "THREAD" with "current", in contexts that are not related to exception processing.

Some methods called by entry functions were declared to have both a "thread" parameter and a "TRAPS" parameter - with nothing to tell you these are always the same, current, thread. So the "thread" parameter is removed and replaced with a local variable "current" obtained from THREAD->as_Java_thread().

Some missing CHECK_ uses were added.

Testing:
- tiers 1-3

Thanks,
David

David Holmes has updated the pull request incrementally with one additional commit since the last revision:

Fix search&replace mistake

Why you kept `JavaThread *thread` parameter in some methods and renamed in others in deoptimization.* files.

I only changed those parameters involved with JRT_* routines, as those
can obviously be seen to be the current thread. For other code in that
file it probably deals with the current thread, but that isn't
necessarily obvious and would need more rigorous checking. That is
beyond the scope of the current set of changes and would need a future RFE.

Similarly for the lack of changes in the ci files - if they weren't
affected by the JRT changes they weren't changed.

src/hotspot/share/c1/c1_Runtime1.cpp line 178:

176: // Stress deoptimization
177: static void deopt_caller(JavaThread* current) {
178: if ( !caller_is_deopted(current)) {

Can you remove space after `( `?

Sure. :)

Thanks,
David
-----

mlbridge · 2021-04-15T00:18:16Z

Mailing list message from David Holmes on hotspot-runtime-dev:

Hi Vladimir,

Thanks for looking at this.

On 15/04/2021 9:52 am, Vladimir Kozlov wrote:

On Fri, 9 Apr 2021 05:08:37 GMT, David Holmes <dholmes at openjdk.org> wrote:

The existing JRT_ENTRY (and related) macros require the function to which they are applied to declare a parameter "JavaThread* thread" which represents the current thread. These functions are all implicitly "traps" functions as they can result in exceptions, but they are not declared with TRAPS because the only caller of these functions is the runtime itself (via call_VM) and no callers need to be aware to use CHECK; further they need a JavaThread. So the macro declares the THREAD variable for use with other exception-producing functions and assigns it from "thread".

The majority of this change replaces the parameter name "thread" with "current" so that it is clear that we are always dealing with the current thread. This affects the entry functions as well as the functions called therefrom.

We can then also replace the use of "THREAD" with "current", in contexts that are not related to exception processing.

Some methods called by entry functions were declared to have both a "thread" parameter and a "TRAPS" parameter - with nothing to tell you these are always the same, current, thread. So the "thread" parameter is removed and replaced with a local variable "current" obtained from THREAD->as_Java_thread().

Some missing CHECK_ uses were added.

Testing:
- tiers 1-3

Thanks,
David

David Holmes has updated the pull request incrementally with one additional commit since the last revision:

Fix search&replace mistake

Why you kept `JavaThread *thread` parameter in some methods and renamed in others in deoptimization.* files.

I only changed those parameters involved with JRT_* routines, as those
can obviously be seen to be the current thread. For other code in that
file it probably deals with the current thread, but that isn't
necessarily obvious and would need more rigorous checking. That is
beyond the scope of the current set of changes and would need a future RFE.

Similarly for the lack of changes in the ci files - if they weren't
affected by the JRT changes they weren't changed.

src/hotspot/share/c1/c1_Runtime1.cpp line 178:

176: // Stress deoptimization
177: static void deopt_caller(JavaThread* current) {
178: if ( !caller_is_deopted(current)) {

Can you remove space after `( `?

Sure. :)

Thanks,
David
-----

vnkozlov

Okay.

dholmes-ora · 2021-04-15T02:19:39Z

Thanks for the review @vnkozlov !

David

dholmes-ora · 2021-04-15T02:19:50Z

/integrate

openjdk · 2021-04-15T02:20:52Z

@dholmes-ora Pushed as commit 79bff21.

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

8263709: Cleanup THREAD/TRAPS/CHECK usage in JRT_ENTRY routines

78298e5

dholmes-ora marked this pull request as ready for review April 8, 2021 06:58

openjdk bot added rfr Pull request is ready for review hotspot-runtime hotspot-runtime-dev@openjdk.org labels Apr 8, 2021

openjdk bot added the hotspot-compiler hotspot-compiler-dev@openjdk.org label Apr 8, 2021

Fixed CHECK on return statement.

1adf0fd

coleenp approved these changes Apr 8, 2021

View reviewed changes

openjdk bot added the ready Pull request is ready to be integrated label Apr 8, 2021

hseigel reviewed Apr 8, 2021

View reviewed changes

src/hotspot/share/interpreter/interpreterRuntime.cpp Outdated Show resolved Hide resolved

dholmes-ora added 4 commits April 8, 2021 19:13

Added in missed JRT_BLOCK_ENTRY methods in AOT-related jvmci/compiler…

e550efb

…Runtime.cpp

@coleenp review comment - Avoid manifesting JavaThread::current() whe…

1a64d68

…n it can be passed in

Fix minor nits reported by @coleenp and @hseigel

041d7ef

Fix search&replace mistake

9cfc43c

hseigel approved these changes Apr 9, 2021

View reviewed changes

Merge branch 'master' into jrt_entry_v2

e3328f0

iklam approved these changes Apr 12, 2021

View reviewed changes

vnkozlov reviewed Apr 14, 2021

View reviewed changes

vnkozlov approved these changes Apr 15, 2021

View reviewed changes

dholmes-ora added 2 commits April 14, 2021 22:15

Fix style nit for kvn

7e177d5

Merge branch 'master' into jrt_entry_v2

166c7fe

openjdk bot closed this Apr 15, 2021

openjdk bot added integrated Pull request has been integrated and removed ready Pull request is ready to be integrated rfr Pull request is ready for review labels Apr 15, 2021

dholmes-ora deleted the 8263709 branch April 15, 2021 02:22

8263709: Cleanup THREAD/TRAPS/CHECK usage in JRT_ENTRY routines #3394

8263709: Cleanup THREAD/TRAPS/CHECK usage in JRT_ENTRY routines #3394

Uh oh!

Conversation

dholmes-ora commented Apr 8, 2021 • edited by openjdk bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Progress

Issue

Reviewers

Reviewing

Uh oh!

bridgekeeper bot commented Apr 8, 2021

Uh oh!

dholmes-ora commented Apr 8, 2021

Uh oh!

openjdk bot commented Apr 8, 2021

Uh oh!

mlbridge bot commented Apr 8, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Webrevs

Uh oh!

openjdk bot commented Apr 8, 2021

Uh oh!

openjdk bot commented Apr 8, 2021

Uh oh!

coleenp left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

openjdk bot commented Apr 8, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

dholmes-ora commented Apr 8, 2021

Uh oh!

hseigel left a comment

Choose a reason for hiding this comment

Uh oh!

iklam left a comment

Choose a reason for hiding this comment

Uh oh!

dholmes-ora commented Apr 12, 2021

Uh oh!

dholmes-ora commented Apr 14, 2021

Uh oh!

vnkozlov left a comment

Choose a reason for hiding this comment

Uh oh!

vnkozlov Apr 14, 2021

Choose a reason for hiding this comment

Uh oh!

vnkozlov commented Apr 15, 2021

Uh oh!

mlbridge bot commented Apr 15, 2021

Uh oh!

mlbridge bot commented Apr 15, 2021

Uh oh!

vnkozlov left a comment

Choose a reason for hiding this comment

Uh oh!

dholmes-ora commented Apr 15, 2021

Uh oh!

dholmes-ora commented Apr 15, 2021

Uh oh!

openjdk bot commented Apr 15, 2021

Uh oh!

Uh oh!

dholmes-ora commented Apr 8, 2021 •

edited by openjdk bot

Loading

mlbridge bot commented Apr 8, 2021 •

edited

Loading

openjdk bot commented Apr 8, 2021 •

edited

Loading