Skip to content

8356865: C2: Unreasonable values for debug flag FastAllocateSizeLimit can lead to left-shift-overflow, which is UB #25834

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

Closed
wants to merge 6 commits into from

Conversation

benoitmaillard
Copy link
Contributor

@benoitmaillard benoitmaillard commented Jun 16, 2025

This PR adds a range constraint for the -XX:FastAllocateSizeLimit debug flag. This prevents undefined behavior caused by left-shift overflow of the flag value in GraphKit::new_array.

Testing

  • GitHub Actions
  • tier1-3, plus some internal testing
  • Manual testing with values known to previously cause undefined behavior

Thanks!


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-8356865: C2: Unreasonable values for debug flag FastAllocateSizeLimit can lead to left-shift-overflow, which is UB (Bug - P4)

Reviewers

Reviewing

Using git

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

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

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 25834

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

Using diff file

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

Using Webrev

Link to Webrev Comment

@bridgekeeper
Copy link

bridgekeeper bot commented Jun 16, 2025

👋 Welcome back bmaillard! 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 Jun 16, 2025

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

8356865: C2: Unreasonable values for debug flag FastAllocateSizeLimit can lead to left-shift-overflow, which is UB

Reviewed-by: epeter, mhaessig

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 64 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.

As you do not have Committer status in this project an existing Committer must agree to sponsor your change. Possible candidates are the reviewers of this PR (@eme64) but any other Committer may sponsor as well.

➡️ To flag this PR as ready for integration with the above commit message, type /integrate in a new comment. (Afterwards, your sponsor types /sponsor in a new comment to perform the integration).

@openjdk openjdk bot changed the title 8356865 8356865: C2: Unreasonable values for debug flag FastAllocateSizeLimit can lead to left-shift-overflow, which is UB Jun 16, 2025
@openjdk
Copy link

openjdk bot commented Jun 16, 2025

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

@benoitmaillard benoitmaillard marked this pull request as ready for review June 16, 2025 14:58
@openjdk openjdk bot added the rfr Pull request is ready for review label Jun 16, 2025
@mlbridge
Copy link

mlbridge bot commented Jun 16, 2025

Webrevs

@benoitmaillard
Copy link
Contributor Author

/label add hotspot-compiler

@openjdk
Copy link

openjdk bot commented Jun 17, 2025

@benoitmaillard
The hotspot-compiler label was successfully added.

Copy link
Contributor

@mhaessig mhaessig left a comment

Choose a reason for hiding this comment

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

Thank you for working on this, @benoitmaillard. This looks good to me.

@@ -3804,6 +3804,7 @@ Node* GraphKit::new_array(Node* klass_node, // array klass (maybe variable)
// Increase the size limit if we have exact knowledge of array type.
int log2_esize = Klass::layout_helper_log2_element_size(layout_con);
fast_size_limit <<= (LogBytesPerLong - log2_esize);
assert (fast_size_limit > 0, "increasing the size limit should not produce negative values");
Copy link
Member

Choose a reason for hiding this comment

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

Prior C++14 left shit producing a negative value is undefined behavior: https://www.open-std.org/jtc1/sc22/wg14/www/docs/n2161.pdf

Do we compile c++ source specifying the C++ standard?

Copy link
Member

Choose a reason for hiding this comment

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

Yes we use -std=c++14, but creating a negative value in this way still feels like a kind of overflow to me.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks for the comments!

I added the assert because the issue in the JBS mentioned a specific case where we ended up with negative values.

Should I leave it like this, or rather convert it to a more specific check (ie. making sure that the LogBytesPerLong - log2_esize most significant bits are not used before shifting)?

Copy link
Member

Choose a reason for hiding this comment

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

IMO your assert is obfuscating the overflow problem.
I think the assert should be before doing the shift.
It can be like:

assert((fast_size_limit == 0) || (count_leading_zeros(fast_size_limit) > (LogBytesPerLong - log2_esize), "fast_size_limit (%d) overflow when shifted left by %d", fast_size_limit, (LogBytesPerLong - log2_esize));

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks for the tip, I made the requested changes!

Copy link
Contributor

@eme64 eme64 left a comment

Choose a reason for hiding this comment

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

Thanks for the updates! Nice work :)

@openjdk openjdk bot added the ready Pull request is ready to be integrated label Jun 23, 2025
@benoitmaillard
Copy link
Contributor Author

/integrate

@openjdk openjdk bot added the sponsor Pull request is ready to be sponsored label Jun 23, 2025
@openjdk
Copy link

openjdk bot commented Jun 23, 2025

@benoitmaillard
Your change (at version 8241b21) is now ready to be sponsored by a Committer.

@eme64
Copy link
Contributor

eme64 commented Jun 23, 2025

/sponsor

@openjdk
Copy link

openjdk bot commented Jun 23, 2025

Going to push as commit c220b13.
Since your change was applied there have been 65 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 Jun 23, 2025
@openjdk openjdk bot closed this Jun 23, 2025
@openjdk openjdk bot removed the ready Pull request is ready to be integrated label Jun 23, 2025
@openjdk openjdk bot removed rfr Pull request is ready for review sponsor Pull request is ready to be sponsored labels Jun 23, 2025
@openjdk
Copy link

openjdk bot commented Jun 23, 2025

@eme64 @benoitmaillard Pushed as commit c220b13.

💡 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
Development

Successfully merging this pull request may close these issues.

5 participants