JDK-8325255 jdk.internal.util.ReferencedKeySet::add using wrong test

[JimLaskey]

Currently, add is returning intern(e) == null which will always be false. The correct test is intern(e) == e , that is, true when element is newly added.

---

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-8325255: jdk.internal.util.ReferencedKeySet::add using wrong test (Bug - P3)

Reviewers

• Roger Riggs (@RogerRiggs - Reviewer)
• Chen Liang (@liach - Author)

Reviewing

Using git

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

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

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 17732

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

Using diff file

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

Webrev

Link to Webrev Comment

[bridgekeeper]

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

@JimLaskey 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

• 03: Full - Incremental (72859919)
• 02: Full - Incremental (51cf3e4a)
• 01: Full - Incremental (b8d2d97d)
• 00: Full (d119fb97)

[RogerRiggs]

LGTM

[openjdk]

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

8325255: jdk.internal.util.ReferencedKeySet::add using wrong test

Reviewed-by: rriggs, 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 353 new commits pushed to the master branch:

• a7280d1: 8311002: missing @SInCE info in 21 files in jdk.security.auth
• 721bfee: 8326891: Prefer RPATH over RUNPATH for $ORIGIN rpaths in internal JDK binaries
• 809995b: 8174269: Remove COMPAT locale data provider from JDK
• c6641c7: 8326831: Clarify test harness control variables in make help
• 3d106cb: 8325139: JFR SwapSpace event - add free swap space information on Linux when running in a container environment
• c00c939: 8327364: Parallel: Remove unused ParallelCompactData::add_obj
• 98f0b86: 8319690: [AArch64] C2 compilation hits offset_ok_for_immed: assert "c2 compiler bug"
• 2372aba: 8326172: Dubious claim on long[]/double[] alignment in MemorySegment javadoc
• c653e67: 8327225: Revert DataInputStream.readUTF to static final
• a089ed2: 8326936: RISC-V: Shenandoah GC crashes due to incorrect atomic memory operations
• ... and 343 more: https://git.openjdk.org/jdk/compare/d1c82156ba6ede4b798ac15f935289cfcc99d1a0...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.

[liach]

With the current code, if we have code like:

var s = "test failed";
add(s);
add(s);

The last 2 calls will both return true, right? We should add a test for consecutively adding the same items too.

[JimLaskey]

@liach I can agree to that. Updated.

[ExE-Boss]

#14684 (comment)

While intern(e) == e is (mostly) sufficient, it will return a false positive when add(e) is called and e is already present in the map, the correctest implementation would be some internal API in ReferencedKeyMap for implementing ReferencedKeySet::add.

[JimLaskey]

Updated

[RogerRiggs]

LGTM

[JimLaskey]

/integrate

[openjdk]

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

• 2bdd387: 8327286: Obsolete unused NUMAPageScanRate product option
• 992104d: 8327239: Obsolete unused GCLockerEdenExpansionPercent product option
• fbb422e: 8327201: C2: Uninitialized VLoop::_pre_loop_end after JDK-8324890
• 7d53559: 8319932: [JVMCI] class unloading related tests can fail on libgraal
• bee50cd: 8294961: Convert java.base/java.lang.reflect.ProxyGenerator to use the Classfile API to generate proxy classes
• 96bfe61: 8326458: Menu mnemonics don't toggle in Windows LAF when F10 is pressed
• fcf48ab: 8327391: Add SipHash attribution file
• b665fe3: 6801704: ChoiceFormat::applyPattern inconsistency for invalid patterns
• a7280d1: 8311002: missing @SInCE info in 21 files in jdk.security.auth
• 721bfee: 8326891: Prefer RPATH over RUNPATH for $ORIGIN rpaths in internal JDK binaries
• ... and 351 more: https://git.openjdk.org/jdk/compare/d1c82156ba6ede4b798ac15f935289cfcc99d1a0...master

Your commit was automatically rebased without conflicts.

[openjdk]

@JimLaskey Pushed as commit a7461de.

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

[ExE-Boss]

Should this be backported to JDK 22, as that was when jdk.internal.util.ReferencedKeySet was introduced?

[liach]

ReferencedKeySet.add isn't used anywhere and this set implementation is not exposed to users at all. If this is backported, it will most likely become part of JDK 22 updates instead of JDK 22.

[mlbridge]

Mailing list message from Jim Laskey on core-libs-dev:

The class is used in java.lang.invoke.MethodType but add is not used.

?