8371591: VerifyJimage tool incorrectly skips all tests when comparing directory structure #28265
Conversation
|
👋 Welcome back david-beaumont! A progress list of the required criteria for merging this PR into |
|
❗ This change is not yet ready to be integrated. |
|
@david-beaumont The following label will be automatically applied to this pull request:
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. |
Webrevs
|
| boolean shouldVerify(Path path) { | ||
| // Use the entry name because we know it uses the '/' separator. | ||
| String entryName = getEntryName(path); | ||
| return Files.isRegularFile(path) |
There was a problem hiding this comment.
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.
| static final class ClassLoadingVerifier extends VerifyJimage { | ||
| private static final String CLASS_SUFFIX = ".class"; | ||
|
|
||
| static class JImageReader extends BasicImageReader { |
There was a problem hiding this comment.
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.
| static final class ClassLoadingVerifier extends VerifyJimage { | ||
| private static final String CLASS_SUFFIX = ".class"; | ||
|
|
||
| static class JImageReader extends BasicImageReader { |
There was a problem hiding this comment.
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.
|
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 |
| } | ||
| } catch (IOException e) { | ||
| throw new UncheckedIOException(e); | ||
| System.out.println("Loading " + cn); |
There was a problem hiding this comment.
Printing the successful class names isn't very useful, (even if it was previously).
2 participants
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
Issue
Reviewing
Using
gitCheckout this PR locally:
$ git fetch https://git.openjdk.org/jdk.git pull/28265/head:pull/28265$ git checkout pull/28265Update a local copy of the PR:
$ git checkout pull/28265$ git pull https://git.openjdk.org/jdk.git pull/28265/headUsing Skara CLI tools
Checkout this PR locally:
$ git pr checkout 28265View PR using the GUI difftool:
$ git pr show -t 28265Using diff file
Download this PR as a diff file:
https://git.openjdk.org/jdk/pull/28265.diff
Using Webrev
Link to Webrev Comment