8353197: Document preconditions for JavaLangAccess methods

[vy]

Document preconditions on certain JavaLangAccess methods that use operations either unsafe and/or without range checks.

---

Progress

• Change must not contain extraneous whitespace
• Commit message must refer to an issue
• Change must be properly reviewed (2 reviews required, with at least 1 Reviewer, 1 Author)

Issue

• JDK-8353197: Document preconditions for JavaLangAccess methods (Enhancement - P3)

Reviewers

• Per Minborg (@minborg - Reviewer)
• Chen Liang (@liach - Reviewer)

Reviewing

Using git

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

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

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 24982

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

Using diff file

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

Using Webrev

Link to Webrev Comment

[bridgekeeper]

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

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

8353197: Document preconditions for JavaLangAccess methods

Reviewed-by: pminborg, liach

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

• 5cb2317: 8351568: Improve source code documentation for PhaseCFG::insert_anti_dependences
• 1d36f17: 8351232: NPE: Cannot invoke "getDeclarationAttributes" because "sym" is null
• 883e52a: 8353237: [AArch64] Incorrect result of VectorizedHashCode intrinsic on Cortex-A53
• ... and 68 more: https://git.openjdk.org/jdk/compare/45dfc2c6d6d6b2b0749347b0150bb22d49f12767...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.

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 (@minborg, @liach) 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]

@vy The following labels will be automatically applied to this pull request:

• core-libs
• security

When this pull request is ready to be reviewed, an "RFR" email will be sent to the corresponding mailing lists. If you would like to change these labels, use the /label pull request command.

[mlbridge]

Webrevs

• 06: Full - Incremental (0e06ce1d)
• 05: Full - Incremental (0ac2101a)
• 04: Full - Incremental (5da9465c)
• 03: Full - Incremental (121005ee)
• 02: Full - Incremental (4d237efa)
• 01: Full - Incremental (f0623258)
• 00: Full (ef88b10a)

[jaikiran]

Hello Volkan, I checked with others on how to make it prominent, when reading code and when reviewing changes to code, that the usage of these methods needs extra careful attention.

In addition to updating the javadoc of these methods, we came to an agreement that each of these methods should be updated to have unchecked as the prefix in their method names. For example, renaming countPositives(...) to uncheckedCountPositives(...). Even though it means a few additional characters to the method names, this should help catch attention wherever these methods get used.

[minborg]

/reviewers 2

[minborg]

LGTM

[openjdk]

@minborg
The total number of required reviews for this PR (including the jcheck configuration and the last /reviewers command) is now set to 2 (with at least 1 Reviewer, 1 Author).

[liach]

Reviewed missing copyright updates. Only files with comments need copyright year updates.

[liach]

Let's re-approve after copyright fix.

[vy]

@liach, @minborg, I've fixed the copyright years. I'd appreciate it if you can approve one last time.

This last copyright year fiasco made me do this:

alias git-license-year-violations='git diff --name-only upstream/master...HEAD | { y=$(date +%Y); while read f; do grep -qE "Copyright \\(c\\)( [0-9]{4},)? $y, Oracle" $f || echo $f; done; }'

[minborg]

Latest changes look good.

[minborg]

So, I think we are ready to go with the latest version.

[vy]

Green tier1,2 results are attached to ticket.

/integrate

[openjdk]

@vy
Your change (at version 0e06ce1) is now ready to be sponsored by a Committer.

[liach]

/sponsor

Thanks!

[openjdk]

Going to push as commit 8fcfddb.
Since your change was applied there have been 74 commits pushed to the master branch:

• 3df8ca1: 8356678: (fs) Files.readAttributes should map ENOTDIR to NoSuchFileException where possible (unix)
• 073af3b: 8356892: runtime/jni/CalleeSavedRegisters/FPRegs.java fails on static-jdk
• 81e8e67: 8351347: HttpClient Improve logging of response headers
• ... and 71 more: https://git.openjdk.org/jdk/compare/45dfc2c6d6d6b2b0749347b0150bb22d49f12767...master

Your commit was automatically rebased without conflicts.

[openjdk]

@liach @vy Pushed as commit 8fcfddb.

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