8330694: Rename 'HeapRegion' to 'G1HeapRegion' #18871

LizBing · 2024-04-20T02:04:20Z

follow up 8267941

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-8330694: Rename 'HeapRegion' to 'G1HeapRegion' (Enhancement - P4)

Reviewers

Chris Plummer (@plummercj - Reviewer)
Kim Barrett (@kimbarrett - Reviewer)
Thomas Schatzl (@tschatzl - Reviewer)

Reviewing

Using git

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

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

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 18871

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

Using diff file

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

Webrev

Link to Webrev Comment

bridgekeeper · 2024-04-20T02:04:42Z

👋 Welcome back LizBing! 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 · 2024-04-20T02:05:49Z

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

8330694: Rename 'HeapRegion' to 'G1HeapRegion'

Reviewed-by: cjplummer, kbarrett, tschatzl

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

05f13e7: 8329667: [macos] Issue with JTree related fix for JDK-8317771
7bf1989: 8320575: generic type information lost on mandated parameters of record's compact constructors
253508b: 8332303: Better JMX interoperability with older JDKs, after removing Subject Delegation
ebc520e: 8332841: GenShen: Pull shared members from control thread into common base class
236432d: 8332084: Ensure JdkConsoleImpl.restoreEcho visibility in a shutdown hook
b3b3366: 8332631: Update nsk.share.jpda.BindServer to don't use finalization
f66a586: 8332641: Update nsk.share.jpda.Jdb to don't use finalization
cd3e4c0: 8326734: text-decoration applied to lost when mixed with or

c2cca2a: 8330647: Two CDS tests fail with -UseCompressedOops and UseSerialGC/UseParallelGC

6d2aeb8: 8332745: Method::is_vanilla_constructor is never used

... and 3 more: https://git.openjdk.org/jdk/compare/6a35311468222f9335b43d548df2ecb80746b389...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 (@plummercj, @kimbarrett, @tschatzl) 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 · 2024-04-20T02:06:23Z

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

graal
hotspot
serviceability

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.

LizBing · 2024-04-20T02:08:43Z

/cc hotspot-gc

openjdk · 2024-04-20T02:09:44Z

@LizBing
The hotspot-gc label was successfully added.

mlbridge · 2024-04-20T02:13:50Z

Webrevs

plummercj

Functionally the SA changes look good, but I pointed out a few other places that you might also want to consider doing renames for.

src/jdk.hotspot.agent/share/classes/sun/jvm/hotspot/utilities/PointerFinder.java

src/jdk.hotspot.agent/share/classes/sun/jvm/hotspot/utilities/PointerLocation.java

test/hotspot/jtreg/serviceability/sa/TestG1HeapRegion.java

src/jdk.hotspot.agent/share/classes/sun/jvm/hotspot/utilities/PointerFinder.java

kimbarrett

So much scrolling :)

Looks good. Just a few very minor nits for which I don't need to re-review.

src/hotspot/share/cds/archiveHeapWriter.cpp

src/hotspot/share/gc/g1/g1ConcurrentMark.hpp

src/hotspot/share/gc/g1/g1ConcurrentMarkBitMap.hpp

src/hotspot/share/gc/g1/g1FullGCCompactionPoint.hpp

src/hotspot/share/gc/g1/g1OopClosures.hpp

tschatzl

Indentation issues. I will run the higher tier SA tests just for verification.

src/hotspot/share/gc/g1/g1CollectedHeap.cpp

src/hotspot/share/gc/g1/vmStructs_g1.hpp

src/jdk.hotspot.agent/share/classes/sun/jvm/hotspot/gc/g1/G1HeapRegionTable.java

src/jdk.hotspot.agent/share/classes/sun/jvm/hotspot/tools/HeapSummary.java

tschatzl

There are still more classes related to HeapRegion that need the G1 prefix. Not entirely sure they should be changed with this change (probably not exhaustive) but it would be desirable to change them as well rather sooner than later:

HeapRegionClosure
HeapRegionRange
HeapRegionIndexClosure
HeapRegionRemSet
HeapRegionSetBase
HeapRegionSetChecker
HeapRegionSet
FreeRegionListIterator
FreeRegionList

tschatzl · 2024-04-29T08:14:03Z

mach5 higher tier SA tests are fine.
What are your plans for the remaining SA renames (would highly recommend to add) and the G1HeapRegion related helper classes?

kimbarrett · 2024-04-29T22:54:18Z

mach5 higher tier SA tests are fine. What are your plans for the remaining SA renames (would highly recommend to add) and the G1HeapRegion related helper classes?

I suggest the related helper classes be done in further followups, not make this change even larger.

tschatzl · 2024-04-30T07:11:37Z

mach5 higher tier SA tests are fine. What are your plans for the remaining SA renames (would highly recommend to add) and the G1HeapRegion related helper classes?

I suggest the related helper classes be done in further followups, not make this change even larger.

Fine with me, will file an issue about the helper classes.

plummercj

In SA I see references to heapRegionIterate() that possibly should be renamed.

I noticed that the HeapRegionManager and HeapRegionClosure classes were not renamed (in the hotspot source). Is this intentional or an oversite?

LizBing · 2024-05-11T11:12:44Z

In SA I see references to heapRegionIterate() that possibly should be renamed.

I noticed that the HeapRegionManager and HeapRegionClosure classes were not renamed (in the hotspot source). Is this intentional or an oversite?

OK, I will do all the SA part here. However, I do think that the other classes named 'HeapRegion*' in the hotspot source should be dealt with in follow-up PRs.

LizBing

Should we also rename 'HeapRegionType' to 'G1HeapRegionType', then rename the current 'G1HeapRegionType' to 'G1 HeapRegionTypeEnum'?

LizBing · 2024-05-12T03:03:16Z

src/jdk.hotspot.agent/share/classes/sun/jvm/hotspot/gc/g1/G1CollectedHeap.java


-    private Iterator<HeapRegion> heapRegionIterator() {
+    private Iterator<G1HeapRegion> heapRegionIterator() {
        return hrm().heapRegionIterator();
    }

-    public void heapRegionIterate(HeapRegionClosure hrcl) {
-        Iterator<HeapRegion> iter = heapRegionIterator();
+    public void heapRegionIterate(G1HeapRegionClosure hrcl) {
+        Iterator<G1HeapRegion> iter = heapRegionIterator();
        while (iter.hasNext()) {
-            HeapRegion hr = iter.next();
+            G1HeapRegion hr = iter.next();
            hrcl.doHeapRegion(hr);
        }
    }

-    public HeapRegion heapRegionForAddress(Address addr) {
-        Iterator<HeapRegion> iter = heapRegionIterator();
+    public G1HeapRegion heapRegionForAddress(Address addr) {
+        Iterator<G1HeapRegion> iter = heapRegionIterator();
        while (iter.hasNext()) {
-            HeapRegion hr = iter.next();
+            G1HeapRegion hr = iter.next();
            if (hr.isInRegion(addr)) {
                return hr;
            }


Since these three methods are G1 specific, I'd prefer not to add the 'g1' prefix.

tschatzl

I'm good with leaving the heapRegionIterator() method name as is, but please make sure that @plummercj is good with this too.

plummercj · 2024-05-13T17:27:34Z

I noticed that the HeapRegionManager and HeapRegionClosure classes were not renamed (in the hotspot source). Is this intentional or an oversite?

OK, I will do all the SA part here. However, I do think that the other classes named 'HeapRegion*' in the hotspot source should be dealt with in follow-up PRs.

I think there was a misunderstanding here. I was not asking you to rename these in SA. I was asking why they were not renamed in hotspot. If you want to do them in a follow-up then that is ok, but both hotspot and SA should be done together. So that means either undoing the most recent SA change or applying the same rename change to hotspot.

plummercj · 2024-05-13T17:32:51Z

Should we also rename 'HeapRegionType' to 'G1HeapRegionType', then rename the current 'G1HeapRegionType' to 'G1 HeapRegionTypeEnum'?

For this PR the SA renames should match the hotspot renames. It looks like you have not renamed this in hotspot yet so it should not be renamed in SA either.

openjdk · 2024-05-18T09:04:00Z

@LizBing Please do not rebase or force-push to an active PR as it invalidates existing review comments. Note for future reference, the bots always squash all changes into a single commit automatically as part of the integration. See OpenJDK Developers’ Guide for more information.

plummercj · 2024-05-21T06:08:54Z

test/hotspot/jtreg/runtime/cds/appcds/sharedStrings/SharedStringsHumongous.java

        // before dumping the string table. That means the heap should contain no
        // humongous regions.
-        dumpOutput.shouldNotMatch("gc,region,cds. HeapRegion 0x[0-9a-f]* HUM");
+        dumpOutput.shouldNotMatch("gc,region,cds. G1HeapRegion 0x[0-9a-f]* HUM");


Just a minor nit. I noticed a pre-existing typo on line 87 above. It says "kelp" instead of "kept". Can you fix it?

tschatzl

Still good imo

LizBing · 2024-05-24T15:52:36Z

thanks for the review!
/integrate

openjdk · 2024-05-24T15:53:43Z

@LizBing
Your change (at version 01f06d4) is now ready to be sponsored by a Committer.

kimbarrett

Still looks good.

kimbarrett · 2024-05-25T02:09:20Z

/sponsor

openjdk · 2024-05-25T02:10:07Z

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

05f13e7: 8329667: [macos] Issue with JTree related fix for JDK-8317771
7bf1989: 8320575: generic type information lost on mandated parameters of record's compact constructors
253508b: 8332303: Better JMX interoperability with older JDKs, after removing Subject Delegation
ebc520e: 8332841: GenShen: Pull shared members from control thread into common base class
236432d: 8332084: Ensure JdkConsoleImpl.restoreEcho visibility in a shutdown hook
b3b3366: 8332631: Update nsk.share.jpda.BindServer to don't use finalization
f66a586: 8332641: Update nsk.share.jpda.Jdb to don't use finalization
cd3e4c0: 8326734: text-decoration applied to lost when mixed with or

c2cca2a: 8330647: Two CDS tests fail with -UseCompressedOops and UseSerialGC/UseParallelGC

6d2aeb8: 8332745: Method::is_vanilla_constructor is never used

... and 3 more: https://git.openjdk.org/jdk/compare/6a35311468222f9335b43d548df2ecb80746b389...master

~~Your commit was automatically rebased without conflicts.~~

openjdk · 2024-05-25T02:10:15Z

@kimbarrett @LizBing Pushed as commit 985b9ce.

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

rename

4fe5bad

openjdk bot changed the title ~~8330694~~ 8330694: Rename 'HeapRegion' to 'G1HeapRegion' Apr 20, 2024

openjdk bot added the rfr Pull request is ready for review label Apr 20, 2024

openjdk bot added graal graal-dev@openjdk.org serviceability serviceability-dev@openjdk.org hotspot hotspot-dev@openjdk.org labels Apr 20, 2024

openjdk bot added the hotspot-gc hotspot-gc-dev@openjdk.org label Apr 20, 2024

plummercj reviewed Apr 20, 2024

View reviewed changes

kimbarrett approved these changes Apr 20, 2024

View reviewed changes

openjdk bot added the ready Pull request is ready to be integrated label Apr 20, 2024

LizBing added 2 commits April 20, 2024 14:17

tidy up

cae3efd

also tidy up

f02334f

tschatzl suggested changes Apr 22, 2024

View reviewed changes

tschatzl reviewed Apr 22, 2024

View reviewed changes

fix indentation

a76a71d

LizBing added 3 commits May 2, 2024 22:28

Merge branch 'master' into JDK-8330694

f4e066c

review

92d0df4

Merge branch 'master' of https://git.openjdk.org/jdk into JDK-8330694

fa3d82b

plummercj reviewed May 6, 2024

View reviewed changes

LizBing commented May 12, 2024

View reviewed changes

tschatzl approved these changes May 13, 2024

View reviewed changes

restore

c240897

LizBing force-pushed the JDK-8330694 branch from dafdc77 to c240897 Compare May 18, 2024 09:02

plummercj suggested changes May 21, 2024

View reviewed changes

LizBing added 2 commits May 24, 2024 20:58

Merge branch 'master' of https://git.openjdk.org/jdk into JDK-8330694

3c3ca86

review

01f06d4

tschatzl approved these changes May 24, 2024

View reviewed changes

plummercj approved these changes May 24, 2024

View reviewed changes

openjdk bot added the sponsor Pull request is ready to be sponsored label May 24, 2024

kimbarrett approved these changes May 25, 2024

View reviewed changes

openjdk bot added the integrated Pull request has been integrated label May 25, 2024

openjdk bot closed this May 25, 2024

openjdk bot removed ready Pull request is ready to be integrated rfr Pull request is ready for review sponsor Pull request is ready to be sponsored labels May 25, 2024

graalvmbot mentioned this pull request Jun 3, 2024

[GR-54361] Update labsjdk to 23+25-jvmci-b01 oracle/graal#9022

Merged

8330694: Rename 'HeapRegion' to 'G1HeapRegion' #18871

8330694: Rename 'HeapRegion' to 'G1HeapRegion' #18871

Uh oh!

Conversation

LizBing commented Apr 20, 2024 • edited by openjdk bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Progress

Issue

Reviewers

Reviewing

Webrev

Uh oh!

bridgekeeper bot commented Apr 20, 2024

Uh oh!

openjdk bot commented Apr 20, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

openjdk bot commented Apr 20, 2024

Uh oh!

LizBing commented Apr 20, 2024

Uh oh!

openjdk bot commented Apr 20, 2024

Uh oh!

mlbridge bot commented Apr 20, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Webrevs

Uh oh!

plummercj left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

kimbarrett left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

tschatzl left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

tschatzl left a comment

Choose a reason for hiding this comment

Uh oh!

tschatzl commented Apr 29, 2024

Uh oh!

kimbarrett commented Apr 29, 2024

Uh oh!

tschatzl commented Apr 30, 2024

Uh oh!

plummercj left a comment

Choose a reason for hiding this comment

Uh oh!

LizBing commented May 11, 2024

Uh oh!

LizBing left a comment

Choose a reason for hiding this comment

Uh oh!

LizBing May 12, 2024

Choose a reason for hiding this comment

Uh oh!

tschatzl left a comment

Choose a reason for hiding this comment

Uh oh!

plummercj commented May 13, 2024

Uh oh!

LizBing commented Apr 20, 2024 •

edited by openjdk bot

Loading

openjdk bot commented Apr 20, 2024 •

edited

Loading

mlbridge bot commented Apr 20, 2024 •

edited

Loading