8298095: Refine implSpec for SegmentAllocator

[minborg]

This PR suggests refining the @implSpec for the SegmentAllocator::allocate methods as well as clarifying the docs a bit more. Also, a local variable is renamed.

---

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-8298095: Refine implSpec for SegmentAllocator (Enhancement - P3)

Reviewers

• Maurizio Cimadamore (@mcimadamore - Reviewer) ⚠️ Review applies to c7544307

Reviewing

Using git

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

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

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 14997

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

Using diff file

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

Webrev

Link to Webrev Comment

[bridgekeeper]

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

@minborg 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]

Webrevs

• 04: Full - Incremental (f0f80b85)
• 03: Full - Incremental (c7544307)
• 02: Full - Incremental (66b1c8e5)
• 01: Full - Incremental (e4d0a4bc)
• 00: Full (1154344d)

[mcimadamore]

Looks good.

[openjdk]

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

8298095: Refine implSpec for SegmentAllocator

Reviewed-by: mcimadamore

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

• 6dba202: 8313670: Simplify shared lib name handling code in some tests
• 8f28809: 8299790: os::print_hex_dump is racy
• e080a0b: 8311508: ZGC: RAII use of IntelJccErratumAlignment
• 242a2e6: 8308843: Generational ZGC: Remove gc/z/TestHighUsage.java
• c822183: 8313768: Reduce interaction with volatile field in j.u.l.StreamHandler
• cd16158: 8314075: Update JCov version for JDK 22
• c307391: 8307184: Incorrect/inconsistent specification and implementation for Elements.getDocComment
• 593ba2f: 8313693: Introduce an internal utility for the Damerau–Levenshtein distance calculation
• 360f65d: 8314022: Problem-list tests failing with jtreg 7.3
• 0eb0997: 8288936: Wrong lock ordering writing G1HeapRegionTypeChange JFR event
• ... and 25 more: https://git.openjdk.org/jdk/compare/87b08b6e0192d88025c2275c7dd2c4bdecda58e8...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.

[minborg]

/integrate

[openjdk]

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

• 6dba202: 8313670: Simplify shared lib name handling code in some tests
• 8f28809: 8299790: os::print_hex_dump is racy
• e080a0b: 8311508: ZGC: RAII use of IntelJccErratumAlignment
• 242a2e6: 8308843: Generational ZGC: Remove gc/z/TestHighUsage.java
• c822183: 8313768: Reduce interaction with volatile field in j.u.l.StreamHandler
• cd16158: 8314075: Update JCov version for JDK 22
• c307391: 8307184: Incorrect/inconsistent specification and implementation for Elements.getDocComment
• 593ba2f: 8313693: Introduce an internal utility for the Damerau–Levenshtein distance calculation
• 360f65d: 8314022: Problem-list tests failing with jtreg 7.3
• 0eb0997: 8288936: Wrong lock ordering writing G1HeapRegionTypeChange JFR event
• ... and 25 more: https://git.openjdk.org/jdk/compare/87b08b6e0192d88025c2275c7dd2c4bdecda58e8...master

Your commit was automatically rebased without conflicts.

[openjdk]

@minborg Pushed as commit 35b60f9.

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

[minborg]

/backport jdk21

[openjdk]

@minborg the backport was successfully created on the branch minborg-backport-35b60f92 in my personal fork of openjdk/jdk21. To create a pull request with this backport targeting openjdk/jdk21:master, just click the following link:

➡️ Create pull request

The title of the pull request is automatically filled in correctly and below you find a suggestion for the pull request body:

Hi all,

This pull request contains a backport of commit 35b60f92 from the openjdk/jdk repository.

The commit being backported was authored by Per Minborg on 10 Aug 2023 and was reviewed by Maurizio Cimadamore.

Thanks!

If you need to update the source branch of the pull then run the following commands in a local clone of your personal fork of openjdk/jdk21:

$ git fetch https://github.com/openjdk-bots/jdk21.git minborg-backport-35b60f92:minborg-backport-35b60f92
$ git checkout minborg-backport-35b60f92
# make changes
$ git add paths/to/changed/files
$ git commit --message 'Describe additional changes made'
$ git push https://github.com/openjdk-bots/jdk21.git minborg-backport-35b60f92