8371591: VerifyJimage test incorrectly skips all tests when comparing directory structure #28265

david-beaumont · 2025-11-12T12:00:00Z

Rewrite of VerifyJimage test to fix several severe issues.

This test runs in two modes, one of which is completely broken (but claims to pass) and the other which currently works but must be made compatible with up-coming preview mode changes from Valhalla.

Issue 1: Broken file comparison

This is a mode not currently run by default, but very very broken if it is run manually. It creates incorrect entry names for looking into the jimage and then ignores non existent entries without raising a failure. This code must have been broken since the introduction of BasicImageReader and the modules system.

This is the larger part of the VerifyJimage code, and it was never going to be worth keeping much of the existing code, so I wrote a new nested class (DirectoryContentVerifier) to encapsulate it.

Importantly, this version now checks false positives and false negatives for file comparison, ensuring that "true failure" cannot be silently ignored. The set of entries in the jimage which have been handled is recorded, and a check is made that all entries have either been tested or explicitly ignored.

Issue 2: Use of BasicImageReader for class file reading

A relative small part of the original code, this mode was reading class names via BasicImageReader and attempting to load them. This approach works now, but will fail when preview mode is introduced since preview versions of classes must be loaded when the JVM is run in preview mode.

The best way to get "the current set of classes in the jimage" is to enumerate the jrt:/ file-system for the runtime image (which will account for preview mode when it's introduced). So the new code in ClassLoadingVerifier does this.

Issue 3: File comparison mode was never run by default

This is likely why the broken file comparison mode wasn't discovered for years. I added two test stanzas to VerifyJimage, so that both modes are run (if possible). Some care is needed because in CI testing there are no module directories for the file comparison mode, and this should not cause a test failure.

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-8371591: VerifyJimage test incorrectly skips all tests when comparing directory structure (Bug - P3)

Reviewers

Roger Riggs (@RogerRiggs - Reviewer)

Reviewing

Using git

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

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

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 28265

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

Using diff file

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

Using Webrev

Link to Webrev Comment

bridgekeeper · 2025-11-12T12:02:01Z

👋 Welcome back david-beaumont! A progress list of the required criteria for merging this PR into pr/28263 will be added to the body of your pull request. There are additional pull request commands available for use with this pull request.

openjdk · 2025-11-12T12:02:04Z

@david-beaumont 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:

8371591: VerifyJimage test incorrectly skips all tests when comparing directory structure

Reviewed-by: rriggs

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

10f262a: 8371804: C2: Tighten up LoadNode::Value comments after JDK-8346184
466cb38: 8371885: Mark UseCompressedClassPointers as obsolete for JDK 27
36daa26: 8371860: Make non-public methods in java_lang_Class private
... and 14 more: https://git.openjdk.org/jdk/compare/6322aaba63b235cb6c73d23a932210af318404ec...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 (@RogerRiggs) 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 · 2025-11-12T12:02:47Z

@david-beaumont 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 · 2025-11-12T12:06:34Z

Webrevs

david-beaumont · 2025-11-12T12:19:58Z

test/jdk/tools/jimage/VerifyJimage.java

+            boolean shouldVerify(Path path) {
+                // Use the entry name because we know it uses the '/' separator.
+                String entryName = getEntryName(path);
+                return Files.isRegularFile(path)


I have no idea if there's a better definition of "what is a marker file", but this logic was sufficient to prevent issues. Same for the other two predicates. I started by letting everything through and added sensible looking clauses until it passed.

david-beaumont · 2025-11-12T15:23:01Z

test/jdk/tools/jimage/VerifyJimage.java

+    static final class ClassLoadingVerifier extends VerifyJimage {
+        private static final String CLASS_SUFFIX = ".class";

-    static class JImageReader extends BasicImageReader {


This being a subclass of BasicImageReader means it was reading the "raw" unmapped entries, meaning that in preview mode it will try and load the non-preview version of the class from the reader in a VM that's using preview mode classes. Using JRT file system, which is preview mode aware for the current runtime, always gives you the "right" choice of class bytes for class loading.

david-beaumont · 2025-11-12T15:24:41Z

test/jdk/tools/jimage/VerifyJimage.java

+    static final class ClassLoadingVerifier extends VerifyJimage {
+        private static final String CLASS_SUFFIX = ".class";

-    static class JImageReader extends BasicImageReader {


This being a subclass of BasicImageReader means it was reading the "raw" unmapped entries, meaning that in preview mode it will try and load the non-preview version of the class from the reader in a VM that's using preview mode classes. Using JRT file system, which is preview mode aware for the current runtime, always gives you the "right" choice of class bytes for class loading.

openjdk-notifier · 2025-11-12T15:52:06Z

The parent pull request that this pull request depends on has now been integrated and the target branch of this pull request has been updated. This means that changes from the dependent pull request can start to show up as belonging to this pull request, which may be confusing for reviewers. To remedy this situation, simply merge the latest changes from the new target branch into this pull request by running commands similar to these in the local repository for your personal fork:

git checkout jdk_8371591_verify
git fetch https://git.openjdk.org/jdk.git master
git merge FETCH_HEAD
# if there are conflicts, follow the instructions given by git merge
git commit -m "Merge master"
git push

RogerRiggs · 2025-11-13T20:15:52Z

test/jdk/tools/jimage/VerifyJimage.java

-                }
-            } catch (IOException e) {
-                throw new UncheckedIOException(e);
+                System.out.println("Loading " + cn);


Printing the successful class names isn't very useful, (even if it was previously).

Fair point, will remove that.

RogerRiggs

Looks good.

david-beaumont · 2025-11-14T12:47:19Z

/integrate

openjdk · 2025-11-14T12:49:41Z

@david-beaumont This pull request has not yet been marked as ready for integration.

RogerRiggs

Still looks good.

david-beaumont · 2025-11-14T16:01:41Z

/integrate

openjdk · 2025-11-14T16:03:49Z

@david-beaumont This pull request has not yet been marked as ready for integration.

kevinrushforth · 2025-11-14T16:20:50Z

@david-beaumont Alan modified the title of the JBS bug. Update the PR title to match, then Skara will mark it as ready.

david-beaumont · 2025-11-14T16:53:12Z

/integrate

openjdk · 2025-11-14T16:54:07Z

@david-beaumont
Your change (at version 6a4cb62) is now ready to be sponsored by a Committer.

RogerRiggs · 2025-11-14T18:22:10Z

/sponsor

openjdk · 2025-11-14T18:24:07Z

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

10f262a: 8371804: C2: Tighten up LoadNode::Value comments after JDK-8346184
466cb38: 8371885: Mark UseCompressedClassPointers as obsolete for JDK 27
36daa26: 8371860: Make non-public methods in java_lang_Class private
... and 14 more: https://git.openjdk.org/jdk/compare/6322aaba63b235cb6c73d23a932210af318404ec...master

Your commit was automatically rebased without conflicts.

openjdk · 2025-11-14T18:24:21Z

@RogerRiggs @david-beaumont Pushed as commit 6e7eaf4.

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

david-beaumont added 2 commits November 12, 2025 12:14

Make entry name reading idempotent

0d30902

Fix very broken test and make it compatible with preview mode

034af05

openjdk bot added the core-libs core-libs-dev@openjdk.org label Nov 12, 2025

openjdk bot added the rfr Pull request is ready for review label Nov 12, 2025

Tweaked path to class name handling for clarity

1ad6e93

david-beaumont commented Nov 12, 2025

View reviewed changes

openjdk-notifier bot changed the base branch from pr/28263 to master November 12, 2025 15:52

RogerRiggs reviewed Nov 13, 2025

View reviewed changes

david-beaumont added 2 commits November 13, 2025 22:12

Remove unhelpful output

6652b48

Merge branch 'master' into jdk_8371591_verify/squashed

6a4cb62

RogerRiggs approved these changes Nov 14, 2025

View reviewed changes

openjdk bot added ready Pull request is ready to be integrated and removed ready Pull request is ready to be integrated labels Nov 14, 2025

david-beaumont changed the title ~~8371591: VerifyJimage tool incorrectly skips all tests when comparing directory structure~~ 8371591: VerifyJimage test incorrectly skips all tests when comparing directory structure Nov 14, 2025

openjdk bot added the ready Pull request is ready to be integrated label Nov 14, 2025

david-beaumont mentioned this pull request Nov 14, 2025

8371897: [lworld] CLONE - VerifyJimage test incorrectly skips all tests when comparing directory structure openjdk/valhalla#1737

Open

3 tasks

openjdk bot added the sponsor Pull request is ready to be sponsored label Nov 14, 2025

openjdk bot added the integrated Pull request has been integrated label Nov 14, 2025

openjdk bot closed this Nov 14, 2025

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 Nov 14, 2025

8371591: VerifyJimage test incorrectly skips all tests when comparing directory structure #28265

8371591: VerifyJimage test incorrectly skips all tests when comparing directory structure #28265

Conversation

david-beaumont commented Nov 12, 2025 • edited by openjdk bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Progress

Issue

Reviewers

Reviewing

Uh oh!

bridgekeeper bot commented Nov 12, 2025

Uh oh!

openjdk bot commented Nov 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

openjdk bot commented Nov 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mlbridge bot commented Nov 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Webrevs

Uh oh!

david-beaumont Nov 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

david-beaumont Nov 12, 2025

Choose a reason for hiding this comment

Uh oh!

david-beaumont Nov 12, 2025

Choose a reason for hiding this comment

Uh oh!

openjdk-notifier bot commented Nov 12, 2025

Uh oh!

RogerRiggs Nov 13, 2025

Choose a reason for hiding this comment

Uh oh!

david-beaumont Nov 13, 2025

Choose a reason for hiding this comment

Uh oh!

RogerRiggs left a comment

Choose a reason for hiding this comment

Uh oh!

david-beaumont commented Nov 14, 2025

Uh oh!

openjdk bot commented Nov 14, 2025

Uh oh!

RogerRiggs left a comment

Choose a reason for hiding this comment

Uh oh!

david-beaumont commented Nov 14, 2025

Uh oh!

openjdk bot commented Nov 14, 2025

Uh oh!

kevinrushforth commented Nov 14, 2025

Uh oh!

david-beaumont commented Nov 14, 2025

Uh oh!

openjdk bot commented Nov 14, 2025

Uh oh!

RogerRiggs commented Nov 14, 2025

Uh oh!

openjdk bot commented Nov 14, 2025

Uh oh!

openjdk bot commented Nov 14, 2025

Uh oh!

Reviewers

Assignees

Labels

Milestone

Development

Uh oh!

3 participants

david-beaumont commented Nov 12, 2025 •

edited by openjdk bot

Loading

openjdk bot commented Nov 12, 2025 •

edited

Loading

openjdk bot commented Nov 12, 2025 •

edited

Loading

mlbridge bot commented Nov 12, 2025 •

edited

Loading

david-beaumont Nov 12, 2025 •

edited

Loading