8267509: Improve IllegalAccessException message to include the cause of the exception #15698

mlchung · 2023-09-13T01:12:52Z

This PR improves IllegalAccessException message thrown by Lookup::findXXX APIs if the method's variable arity modifier bit is set and asVarargsCollector fails. It will include the exception message thrown by asVarargsCollector`.

The exception message looks like this:

java.lang.IllegalAccessException: cannot make variable arity: MyClass.m(Object[],int)void/invokeStatic does not have a trailing array parameter

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-8267509: Improve IllegalAccessException message to include the cause of the exception (Enhancement - P4)

Reviewers

Chen Liang (@liach - Author)
Naoto Sato (@naotoj - Reviewer)

Reviewing

Using git

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

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

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 15698

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

Using diff file

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

Webrev

Link to Webrev Comment

…of the exception

bridgekeeper · 2023-09-13T01:13:45Z

👋 Welcome back mchung! 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-09-13T01:16:02Z

@mlchung 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.

mlbridge · 2023-09-13T01:20:21Z

Webrevs

liach · 2023-09-13T05:08:58Z

src/java.base/share/classes/java/lang/invoke/MethodHandle.java

@@ -1719,7 +1719,7 @@ MethodHandle setVarargs(MemberName member) throws IllegalAccessException {
        try {
            return this.withVarargs(true);
        } catch (IllegalArgumentException ex) {
-            throw member.makeAccessException("cannot make variable arity", null);
+            throw new IllegalAccessException("cannot make variable arity: " + this + " because " + ex.getMessage());


This now drops the member information (owner and name) from the message. Is that intended?

In addition, the original message appears to include the method type, which can be used to diagnose why varargs is not possible (not an array for trailing parameter). I fail to see what extra information this patch offers that actually makes debugging easier as claimed in the JBS issue.

Good catch. It's not intended. Fixed.

I think in general it would be useful to make it clear in the exception message of the reason especially for those who are new in using method handles. Looking it again, it can simply hardcode the message (more friendly than IAE exception message):

java.lang.IllegalAccessException: cannot make variable arity: MyClass.m(Object[],int)void/invokeStatic because not an array type: int vs java.lang.IllegalAccessException: cannot make variable arity: trailing parameter type is not an array type: MyClass.m(Object[],int)void/invokeStatic or java.lang.IllegalAccessException: cannot make variable arity: MyClass.m(Object[],int)void/invokeStatic does not have a trailing array parameter

naotoj · 2023-10-04T18:08:40Z

Would it be helpful if we call IllegalAccessException.initCause(IllegalArgumentException) before throwing it?

mlchung · 2023-10-04T18:27:38Z

It's a user error. The exception message makes it clear for the users what's wrong with the requested method. The cause's stacktrace is less relevant to them.

openjdk · 2023-10-04T18:30:25Z

@mlchung 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:

8267509: Improve IllegalAccessException message to include the cause of the exception

Reviewed-by: liach, naoto

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

ddacf92: 8305765: CompressedClassPointers.java is unreliable due to ASLR
4195246: 8317354: Serial: Move DirtyCardToOopClosure to gc/serial folder
0a3a925: 8316414: C2: large byte array clone triggers "failed: malformed control flow" assertion failure on linux-x86
b0d6c84: 8316396: Endless loop in C2 compilation triggered by AddNode::IdealIL
a8549b6: 8280120: [IR Framework] Add attribute to @ir to enable/disable IR matching based on the architecture
9718f49: 8317452: [JVMCI] Export symbols used by lightweight locking to JVMCI compilers.
0d4de8a: 8316971: Add Lint warning for restricted method calls
d4c904d: 8317294: Classloading throws exceptions over already pending exceptions
48f1a92: 8316679: C2 SuperWord: wrong result, load should not be moved before store if not comparable
0b0f8b5: 8219652: [aix] Tests failing with JNI attach problems.
... and 306 more: https://git.openjdk.org/jdk/compare/a9679acd5c85b88afe827dc55dbe9a78b00c8918...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.

mlchung · 2023-10-04T18:36:27Z

/integrate

openjdk · 2023-10-04T18:39:29Z

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

ddacf92: 8305765: CompressedClassPointers.java is unreliable due to ASLR
4195246: 8317354: Serial: Move DirtyCardToOopClosure to gc/serial folder
0a3a925: 8316414: C2: large byte array clone triggers "failed: malformed control flow" assertion failure on linux-x86
b0d6c84: 8316396: Endless loop in C2 compilation triggered by AddNode::IdealIL
a8549b6: 8280120: [IR Framework] Add attribute to @ir to enable/disable IR matching based on the architecture
9718f49: 8317452: [JVMCI] Export symbols used by lightweight locking to JVMCI compilers.
0d4de8a: 8316971: Add Lint warning for restricted method calls
d4c904d: 8317294: Classloading throws exceptions over already pending exceptions
48f1a92: 8316679: C2 SuperWord: wrong result, load should not be moved before store if not comparable
0b0f8b5: 8219652: [aix] Tests failing with JNI attach problems.
... and 306 more: https://git.openjdk.org/jdk/compare/a9679acd5c85b88afe827dc55dbe9a78b00c8918...master

Your commit was automatically rebased without conflicts.

openjdk · 2023-10-04T18:39:40Z

@mlchung Pushed as commit 36314a9.

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

8267509: Improve IllegalAccessException message to include the cause …

8d5f1b1

…of the exception

openjdk bot added the rfr Pull request is ready for review label Sep 13, 2023

openjdk bot added the core-libs core-libs-dev@openjdk.org label Sep 13, 2023

liach reviewed Sep 13, 2023

View reviewed changes

mlchung added 2 commits September 13, 2023 09:15

use member (not method handle)

921f139

revised message

9cdd1f3

liach approved these changes Sep 21, 2023

View reviewed changes

naotoj approved these changes Oct 4, 2023

View reviewed changes

openjdk bot added the ready Pull request is ready to be integrated label Oct 4, 2023

openjdk bot added the integrated Pull request has been integrated label Oct 4, 2023

openjdk bot closed this Oct 4, 2023

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

mlchung deleted the JDK-8267509 branch October 4, 2023 21:07

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

8267509: Improve IllegalAccessException message to include the cause of the exception #15698

8267509: Improve IllegalAccessException message to include the cause of the exception #15698

Uh oh!

mlchung commented Sep 13, 2023 •

edited by openjdk bot

Loading

Uh oh!

bridgekeeper bot commented Sep 13, 2023

Uh oh!

openjdk bot commented Sep 13, 2023

Uh oh!

mlbridge bot commented Sep 13, 2023 •

edited

Loading

Uh oh!

liach Sep 13, 2023

Uh oh!

mlchung Sep 13, 2023 •

edited

Loading

Uh oh!

naotoj commented Oct 4, 2023

Uh oh!

mlchung commented Oct 4, 2023

Uh oh!

openjdk bot commented Oct 4, 2023

Uh oh!

mlchung commented Oct 4, 2023

Uh oh!

openjdk bot commented Oct 4, 2023

Uh oh!

openjdk bot commented Oct 4, 2023

Uh oh!

Uh oh!

8267509: Improve IllegalAccessException message to include the cause of the exception #15698

8267509: Improve IllegalAccessException message to include the cause of the exception #15698

Uh oh!

Conversation

mlchung commented Sep 13, 2023 • edited by openjdk bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Progress

Issue

Reviewers

Reviewing

Webrev

Uh oh!

bridgekeeper bot commented Sep 13, 2023

Uh oh!

openjdk bot commented Sep 13, 2023

Uh oh!

mlbridge bot commented Sep 13, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Webrevs

Uh oh!

liach Sep 13, 2023

Choose a reason for hiding this comment

Uh oh!

mlchung Sep 13, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

naotoj commented Oct 4, 2023

Uh oh!

mlchung commented Oct 4, 2023

Uh oh!

openjdk bot commented Oct 4, 2023

Uh oh!

mlchung commented Oct 4, 2023

Uh oh!

openjdk bot commented Oct 4, 2023

Uh oh!

openjdk bot commented Oct 4, 2023

Uh oh!

Uh oh!

mlchung commented Sep 13, 2023 •

edited by openjdk bot

Loading

mlbridge bot commented Sep 13, 2023 •

edited

Loading

mlchung Sep 13, 2023 •

edited

Loading