Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

JDK-8320382: Remove CompressedKlassPointers::is_valid_base() #16727

Conversation

tstuefe
Copy link
Member

@tstuefe tstuefe commented Nov 20, 2023

CompressedKlassPointers::is_valid_base(addr) abstracts away platform-specific requirements that may limit the use of an address as narrow Klass encoding base. It only ever mattered on aarch64, where we cannot use any arbitrary address as 64-bit immediate for the base.

Experience shows that this is a case where the abstraction does not help much. Hiding a very CPU-specific limitation under a generic function made arguing about it difficult. We therefore decided to scrap that function.

It is only used for two things:

  • asserts at runtime; those are unnecessary since we have an assert in macroAssembler_aarch64.cpp that will fire if the base is not correct. Both asserts fire at VM initialization; neither of these asserts is much clearer than the other, so no reason to keep asserting for is_valid_base()
  • the one legitimate use case is checking the user input for -XX:SharedBaseAddress at dump time. We can just express the aarch64 requirement directly, which is clearer to understand.

Note that the function has also been incorrect, since it ignored aarch64 EOR mode, and required 32GB alignment for addresses beyond 32GB. However, we can make any 4GB aligned address to work with movk, so the requirement can be simplified to "is 4GB-aligned".

(this is a preparatory patch for JDK-8320368 and further Lilliput-related changes)


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-8320382: Remove CompressedKlassPointers::is_valid_base() (Enhancement - P4)

Reviewers

Reviewing

Using git

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

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

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 16727

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

Using diff file

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

Webrev

Link to Webrev Comment

@bridgekeeper
Copy link

bridgekeeper bot commented Nov 20, 2023

👋 Welcome back stuefe! 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
Copy link

openjdk bot commented Nov 20, 2023

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

  • hotspot

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.

@openjdk openjdk bot added the hotspot hotspot-dev@openjdk.org label Nov 20, 2023
@tstuefe
Copy link
Member Author

tstuefe commented Nov 20, 2023

arm breakage unrelated, see because of #15455

@tstuefe tstuefe marked this pull request as ready for review November 20, 2023 10:06
@openjdk openjdk bot added the rfr Pull request is ready for review label Nov 20, 2023
@tstuefe
Copy link
Member Author

tstuefe commented Nov 20, 2023

Ping @theRealAph

@mlbridge
Copy link

mlbridge bot commented Nov 20, 2023

Webrevs

Copy link
Contributor

@rkennke rkennke left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it's ok.
I think there is an advantage in checking the base early instead of somewhere deep in MA, at which point I'd probably wonder where the base came from. Maybe there is a way to achieve the simplification that you had in mind while also retaining those checks?

@openjdk
Copy link

openjdk bot commented Nov 21, 2023

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

8320382: Remove CompressedKlassPointers::is_valid_base()

Reviewed-by: rkennke, aph

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

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.

@openjdk openjdk bot added the ready Pull request is ready to be integrated label Nov 21, 2023
@tstuefe
Copy link
Member Author

tstuefe commented Nov 22, 2023

I think it's ok. I think there is an advantage in checking the base early instead of somewhere deep in MA, at which point I'd probably wonder where the base came from. Maybe there is a way to achieve the simplification that you had in mind while also retaining those checks?

Honestly, none that is worth the complexity. These asserts usually fired as a result of metaspace reservation - which is an automatic process - coming up with unsuitable reservation addresses. An assert at that point is every bit as baffling to the end user as the later assert in MA. The only point where an early clear warning makes sense is when we check the user input for SharedBaseAddress, which we do (and, the new message is even better than the old one).

@tstuefe
Copy link
Member Author

tstuefe commented Nov 22, 2023

Thanks @theRealAph and @rkennke !

/integrate

@openjdk
Copy link

openjdk bot commented Nov 22, 2023

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

Your commit was automatically rebased without conflicts.

@openjdk openjdk bot added the integrated Pull request has been integrated label Nov 22, 2023
@openjdk openjdk bot closed this Nov 22, 2023
@openjdk openjdk bot removed ready Pull request is ready to be integrated rfr Pull request is ready for review labels Nov 22, 2023
@openjdk
Copy link

openjdk bot commented Nov 22, 2023

@tstuefe Pushed as commit 98edb03.

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
hotspot hotspot-dev@openjdk.org integrated Pull request has been integrated
Development

Successfully merging this pull request may close these issues.

3 participants