8327495: Print more warning with -Xshare:auto when CDS fails to use archive #24889

calvinccheung · 2025-04-25T21:43:19Z

Before this change, if the -Xshare:auto is specified with a CDS archive, the user won't see the following error message when the archive has failed to load:
An error has occurred while processing the the shared archive file.
This change will print the above error message if the -Xshare:auto is specified and the archive is not the default one.
Several existing log_ino(cds)() calls have been changed to calling the new function MetaspaceShared::report_loading_error(). Also modified couple of tests to check the above error message is printed.

Passed tiers 1 - 3 testing.

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-8327495: Print more warning with -Xshare:auto when CDS fails to use archive (Enhancement - P4)

Reviewers

Ioi Lam (@iklam - Reviewer)
Matias Saavedra Silva (@matias9927 - Reviewer)

Reviewing

Using git

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

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

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 24889

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

Using diff file

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

Using Webrev

Link to Webrev Comment

…rchive

bridgekeeper · 2025-04-25T21:43:53Z

👋 Welcome back ccheung! 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 · 2025-04-25T21:44:23Z

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

8327495: Print more warning with -Xshare:auto when CDS fails to use archive

Reviewed-by: iklam, matsaave

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

c8bbcaf: 8348638: Performance regression in Math.tanh
84f570c: 8355445: [java.nio] Use @requires tag instead of exiting based on "os.name" property value
4826a91: 8355443: [java.io] Use @requires tag instead of exiting based on File.separatorChar value
... and 367 more: https://git.openjdk.org/jdk/compare/83c7d3bbe860656ee403fa29df6a9e0aae962839...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.

openjdk · 2025-04-25T21:44:51Z

@calvinccheung The following label will be automatically applied to this pull request:

hotspot-runtime

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-04-25T21:48:21Z

Webrevs

iklam · 2025-04-27T06:04:57Z

src/hotspot/share/cds/metaspaceShared.cpp

+void MetaspaceShared::report_loading_error(const char* message) {
+
+  if (SharedArchiveFile != nullptr) {
+    log_error(cds)("An error has occurred while processing the %s.", CDSConfig::type_of_archive_being_loaded());
+    if (message != nullptr) {
+      log_error(cds)("%s", message);
+    }
+  } else {
+    log_info(cds)("An error has occurred while processing the %s.", CDSConfig::type_of_archive_being_loaded());
+    if (message != nullptr) {
+      log_info(cds)("%s", message);
+    }
+  }
+}
+


The AOT workflow doesn't use the SharedArchiveFile flag. I think to detect that we are not using the default archive, we should do this:

bool CDSConfig::is_using_only_default_archive() { return is_using_archive() && input_static_archive_path() != nullptr && default_archive_path() != nullptr && strcmp(input_static_archive_path(), default_archive_path()) == 0 && input_dynamic_archive_path() == nullptr; }

I think the printing can be simplified like this to avoid duplication:

// If the user doesn't specify any CDS options, we will try to load the default CDS archive, which // may fail due to incompatible VM options. Print at the info level to avoid excessive verbosity. // However, if the user has specified a CDS archive (or AOT cache), they would be interested in // knowing that the loading fails, so we print at the error level. Log(cds) log; LogStream ls_error(log.error()); LogStream ls_info(log.warning()); LogStream& ls = CDSConfig::is_using_only_default_archive() ? ls_info : ls_error; ls.print_cr("An error has occurred while processing the %s.", CDSConfig::type_of_archive_being_loaded()); if (message != nullptr) { ls_print(cds)("%s", message); }

Thanks. I've incorporated your suggestion with some slight adjustment. For the CDSConfig::is_using_only_default_archive(), it needs to account for dumping a classlist during JDK build time.

iklam · 2025-04-28T23:58:21Z

src/hotspot/share/cds/cdsConfig.cpp

+  if (!is_using_archive()) {
+    // During JDK build when dumping a classlist (DumpLoadedClassList), exclude error
+    // message from the classlist as it interferes with the default CDS archive creation.
+    return true;
+  }


I check the Makefiles, and the situation you are trying to avoid is this part in make/GenerateLinkOptData.gmk:

$(FIXPATH) $(INTERIM_IMAGE_DIR)/bin/java \ -cp $(SUPPORT_OUTPUTDIR)/classlist.jar \ build.tools.classlist.SortClasslist [email protected] > $@

After adding -Xlog:cds=/tmp/foo.txt to the above command, I get the following in the log file:

[0.004s][info][cds] trying to map /jdk3/bld/tin/support/interim-image/lib/server/classes.jsa [0.004s][info][cds] Specified shared archive file not found (/jdk3/bld/tin/support/interim-image/lib/server/classes.jsa) [0.004s][info][cds] An error has occurred while processing the shared archive file. [0.004s][info][cds] Loading static archive failed. [0.004s][error][cds] An error has occurred while processing the shared archive file. [0.004s][error][cds] Unable to map shared spaces

I think the !is_using_archive() shouldn't be in this function. Instead it should be in MetaspaceShared::report_loading_error():

LogStream& ls = (!CDSConfig::is_using_archive()) || CDSConfig::is_using_only_default_archive() ? ls_info : ls_error;

I found that with AOT class linking, we need better diagnostics. E.g.:

$ java -cp HelloWorld.jar -XX:AOTMode=record -XX:AOTConfiguration=hw.aotconfig HelloWorld Hello World AOTConfiguration recorded: hw.aotconfig $ java -cp HelloWorld.jar -XX:AOTMode=create -XX:AOTCache=hw.aot -XX:AOTConfiguration=hw.aotconfig Reading AOTConfiguration hw.aotconfig and writing AOTCache hw.aot AOTCache creation is complete: hw.aot 9682944 bytes $ java --add-modules=java.base -cp HelloWorld.jar -XX:AOTMode=on -XX:AOTCache=hw.aot HelloWorld [0.005s][error][cds] CDS archive has aot-linked classes. It cannot be used when archived full module graph is not used. Error occurred during initialization of VM Unable to use AOT cache.

It's not clear why "full module graph is not used". I added the following patch on to of your PR:

iklam@a2ca2c0

Now there's a better explanation:

$ java --add-modules=java.base -cp HelloWorld.jar -XX:AOTMode=on -XX:AOTCache=hw.aot HelloWorld [0.017s][error][cds] An error has occurred while processing the AOT cache. Run with -Xlog:cds for details. [0.017s][error][cds] Mismatched values for property jdk.module.addmods: java.base specified during runtime but not during dump time [0.017s][error][cds] Disabling optimized module handling [0.017s][error][cds] CDS archive has aot-linked classes. It cannot be used when archived full module graph is not used. Error occurred during initialization of VM Unable to use AOT cache.

Could you check other cases where the FMG is disabled and change their error reporting to use MetaspaceShared::report_loading_error()

Also, we have a few messages that says: "CDS archive has aot-linked classes ...". I think these should be changed to use CDSConfig::type_of_archive_being_loaded().

Could you check other cases where the FMG is disabled and change their error reporting to use MetaspaceShared::report_loading_error()

I changed additional two error reporting in metaspaceShared.cpp to MetaspaceShared::report_loading_error().

Also, we have a few messages that says: "CDS archive has aot-linked classes ...". I think these should be changed to use CDSConfig::type_of_archive_being_loaded().

As a result of the above change, a few tests need to be adjusted for the expected output.

…ort_loading_error(); use CDSConfig::type_of_archive_being_loaded() instead of 'CDS archive'; adjust some tests

iklam

LGTM.

matias9927

LGTM!

calvinccheung · 2025-05-05T19:35:48Z

Thanks @iklam and @matias9927 for the review.

/integrate

openjdk · 2025-05-05T19:36:29Z

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

6bcbc3b: 8353489: Increase timeout and improve Windows compatibility in test/jdk/java/lang/ProcessBuilder/Basic.java
65f188f: 8354334: Remove @valuebased from ProcessHandle
cc34135: 8343158: [JVMCI] ZGC should deoptimize on old gen allocation
... and 390 more: https://git.openjdk.org/jdk/compare/83c7d3bbe860656ee403fa29df6a9e0aae962839...master

Your commit was automatically rebased without conflicts.

openjdk · 2025-05-05T19:36:36Z

@calvinccheung Pushed as commit 620f816.

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

8327495: Print more warning with -Xshare:auto when CDS fails to use a…

97a75d6

…rchive

calvinccheung marked this pull request as ready for review April 25, 2025 21:43

openjdk bot added the rfr Pull request is ready for review label Apr 25, 2025

openjdk bot added the hotspot-runtime [email protected] label Apr 25, 2025

revert one of the changes in filemap.cpp

4d2aa07

iklam reviewed Apr 27, 2025

View reviewed changes

@iklam comment

75c3165

iklam reviewed Apr 28, 2025

View reviewed changes

calvinccheung added 2 commits April 29, 2025 23:38

@iklam patch; change more error reporting to use MetaspaceShared::rep…

f108bc5

…ort_loading_error(); use CDSConfig::type_of_archive_being_loaded() instead of 'CDS archive'; adjust some tests

fix build errors on macosx platforms

5c1446e

iklam approved these changes Apr 30, 2025

View reviewed changes

openjdk bot added the ready Pull request is ready to be integrated label Apr 30, 2025

matias9927 approved these changes May 2, 2025

View reviewed changes

openjdk bot added the integrated Pull request has been integrated label May 5, 2025

openjdk bot closed this May 5, 2025

openjdk bot removed ready Pull request is ready to be integrated rfr Pull request is ready for review labels May 5, 2025

calvinccheung deleted the 8327495-more-CDS-warning branch May 5, 2025 20:07

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

8327495: Print more warning with -Xshare:auto when CDS fails to use archive #24889

8327495: Print more warning with -Xshare:auto when CDS fails to use archive #24889

Uh oh!

calvinccheung commented Apr 25, 2025 •

edited by openjdk bot

Loading

Uh oh!

bridgekeeper bot commented Apr 25, 2025

Uh oh!

openjdk bot commented Apr 25, 2025 •

edited

Loading

Uh oh!

openjdk bot commented Apr 25, 2025

Uh oh!

mlbridge bot commented Apr 25, 2025 •

edited

Loading

Uh oh!

iklam Apr 27, 2025

Uh oh!

calvinccheung Apr 28, 2025

Uh oh!

iklam Apr 28, 2025

Uh oh!

iklam Apr 29, 2025

Uh oh!

calvinccheung Apr 29, 2025

Uh oh!

iklam left a comment

Uh oh!

matias9927 left a comment

Uh oh!

calvinccheung commented May 5, 2025

Uh oh!

openjdk bot commented May 5, 2025

Uh oh!

openjdk bot commented May 5, 2025

Uh oh!

Uh oh!

8327495: Print more warning with -Xshare:auto when CDS fails to use archive #24889

8327495: Print more warning with -Xshare:auto when CDS fails to use archive #24889

Uh oh!

Conversation

calvinccheung commented Apr 25, 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 Apr 25, 2025

Uh oh!

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

Uh oh!

Uh oh!

openjdk bot commented Apr 25, 2025

Uh oh!

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

Uh oh!

Webrevs

Uh oh!

iklam Apr 27, 2025

Choose a reason for hiding this comment

Uh oh!

calvinccheung Apr 28, 2025

Choose a reason for hiding this comment

Uh oh!

iklam Apr 28, 2025

Choose a reason for hiding this comment

Uh oh!

iklam Apr 29, 2025

Choose a reason for hiding this comment

Uh oh!

calvinccheung Apr 29, 2025

Choose a reason for hiding this comment

Uh oh!

iklam left a comment

Choose a reason for hiding this comment

Uh oh!

matias9927 left a comment

Choose a reason for hiding this comment

Uh oh!

calvinccheung commented May 5, 2025

Uh oh!

openjdk bot commented May 5, 2025

Uh oh!

openjdk bot commented May 5, 2025

Uh oh!

Uh oh!

calvinccheung commented Apr 25, 2025 •

edited by openjdk bot

Loading

openjdk bot commented Apr 25, 2025 •

edited

Loading

mlbridge bot commented Apr 25, 2025 •

edited

Loading