8300590: [JVMCI] BytecodeFrame.equals is broken

[dougxc]

BytecodeFrame.equals returns true even when the frames are found to be not equal:

jdk/src/jdk.internal.vm.ci/share/classes/jdk.vm.ci.code/src/jdk/vm/ci/code/BytecodeFrame.java

Line 375 in 7bf0d14

return true;

This PR fixes that, adds a test and improves both BytecodeFrame.hashCode and BytecodeFrame.equals to take all fields into account.

Given the nature of the bug in BytecodeFrame.equals that this PR fixes, it's pretty clear that BytecodeFrame has never been (reliably) used as a key in a map.

---

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-8300590: [JVMCI] BytecodeFrame.equals is broken

Reviewers

• Andrew Dinn (@adinn - Reviewer) ⚠️ Review applies to 4674af35
• Dean Long (@dean-long - Reviewer)

Reviewing

Using git

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

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

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 12084

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

Using diff file

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

[bridgekeeper]

👋 Welcome back dnsimon! 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]

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

• hotspot-compiler

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]

Webrevs

• 02: Full - Incremental (2e95375d)
• 01: Full - Incremental (3b3a9d53)
• 00: Full (4674af35)

[adinn]

Thanks for fixing this Doug!

[openjdk]

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

8300590: [JVMCI] BytecodeFrame.equals is broken

Reviewed-by: adinn, dlong

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

• 5784eb7: 8300721: Cleanup ProblemList-svc-vthread.txt
• 9d44dd0: 8297972: Poly1305 Endianness on ByteBuffer not enforced
• facd415: 8297757: VarHandles.getStaticFieldFromBaseAndOffset should get the receiver type from VarHandle
• e803855: 8299863: URLFromURITest.java should import org.junit.jupiter.api.Test
• 92d8326: 8299827: Add resolved IP address in connection exception for sockets
• c6d5600: 8038146: Clarify Map.Entry's connection to the underlying map
• b2d3622: 8299896: Reduce enum values of HtmlLinkInfo.Kind
• 623ba5b: 8300653: G1EvacInfo should use common naming scheme for collection set
• 97c611d: 8289748: C2 compiled code crashes with SIGFPE with -XX:+StressLCM and -XX:+StressGCM
• 4562b40: 8300682: InstanceKlassMiscStatus is a bad name
• ... and 53 more: https://git.openjdk.org/jdk/compare/ba899b42ce2b4b11cd45f8e7795479331d59a1be...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.

[dean-long]

Is this comparison better/faster than instanceof, and allows the compiler to avoid repeating the same check on the checkcast below?

[dougxc]

It's what Eclipse auto-generates for equals. I can confirm that Graal eliminates the check cast but don't think it's worth worrying about if not all compilers will.

[dean-long]

Looks good.

[dougxc]

/integrate

[openjdk]

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

• 5331a3e: 8298908: Instrument Metaspace for ASan
• e1ee672: 8300725: Improve performance of ColorConvertOp for default destinations with alpha
• 7c2f77a: 8300584: Accelerate AVX-512 CRC32C for small buffers
• 5784eb7: 8300721: Cleanup ProblemList-svc-vthread.txt
• 9d44dd0: 8297972: Poly1305 Endianness on ByteBuffer not enforced
• facd415: 8297757: VarHandles.getStaticFieldFromBaseAndOffset should get the receiver type from VarHandle
• e803855: 8299863: URLFromURITest.java should import org.junit.jupiter.api.Test
• 92d8326: 8299827: Add resolved IP address in connection exception for sockets
• c6d5600: 8038146: Clarify Map.Entry's connection to the underlying map
• b2d3622: 8299896: Reduce enum values of HtmlLinkInfo.Kind
• ... and 56 more: https://git.openjdk.org/jdk/compare/ba899b42ce2b4b11cd45f8e7795479331d59a1be...master

Your commit was automatically rebased without conflicts.

[openjdk]

@dougxc Pushed as commit 06394ee.

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