Skip to content

8352001: AOT cache should not contain classes injected into built-in class loaders #24046

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Conversation

iklam
Copy link
Member

@iklam iklam commented Mar 14, 2025

During an application's training run, it's possible to inject classes into the built-in platform/app class loaders with reflection calls.

  • Before JDK-8348426, only the names of these classes were recorded in the AOT config file. When the AOT cache is generated, these classes are automatically filtered out.
  • Since JDK-8348426, these classes are stored as parsed InstanceKlasses in the AOT config file, and will be transferred into the AOT cache. This new behavior may cause some applications to fail, as they may inject bytecodes that have environment dependencies.

For safety, this PR filters out such injected classes from the AOT config file.


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-8352001: AOT cache should not contain classes injected into built-in class loaders (Bug - P3)

Reviewers

Reviewing

Using git

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

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

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 24046

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

Using diff file

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

Using Webrev

Link to Webrev Comment

@bridgekeeper
Copy link

bridgekeeper bot commented Mar 14, 2025

👋 Welcome back iklam! 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
Copy link

openjdk bot commented Mar 14, 2025

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

8352001: AOT cache should not contain classes injected into built-in class loaders

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

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 openjdk bot added the rfr Pull request is ready for review label Mar 14, 2025
@openjdk
Copy link

openjdk bot commented Mar 14, 2025

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

  • core-libs
  • hotspot

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.

@mlbridge
Copy link

mlbridge bot commented Mar 14, 2025

Webrevs

@bridgekeeper
Copy link

bridgekeeper bot commented Apr 11, 2025

@iklam This pull request has been inactive for more than 4 weeks and will be automatically closed if another 4 weeks passes without any activity. To avoid this, simply add a new comment to the pull request. Feel free to ask for assistance if you need help with progressing this pull request towards integration!

Copy link
Contributor

@matias9927 matias9927 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good! Just one nit

const char* const file_name = ClassLoader::file_name_for_class_name(class_name,
ik->name()->utf8_length());
if (!zip->has_entry(current, file_name)) {
log_warning(cds)("class %s cannot be archived because it was not define from %s as claimed",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Typo: define -> defined


// Define a class using Lookup.defineClass(). The ClassFileParser should see "__JVM_DefineClass__"
// as the source location, so this class will be excluded, as the location is not supported.
static void testWithLookup() throws Exception {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this test capture some kind of output or exception?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These classes are still loadable (just not from the CDS archive), so there aren't exceptions printed here. These lines check that the classes are not loaded from CDS:

        public void checkExecution(OutputAnalyzer out, RunMode runMode) throws Exception {
            if (isDumping(runMode)) {
                out.shouldMatch("cds,class.* FakeCodeLocationApp");
                out.shouldNotMatch("cds,class.* ClassNotInJar1");
                out.shouldNotMatch("cds,class.* ClassNotInJar2");
            }

            if (runMode.isProductionRun()) {
                out.shouldMatch("class,load.* FakeCodeLocationApp .*source: shared objects file");
                out.shouldNotMatch("class,load.* ClassNotInJar1 .*source: shared objects file");
                out.shouldNotMatch("class,load.* ClassNotInJar2 .*source: shared objects file");
            }
        }

@openjdk openjdk bot added the ready Pull request is ready to be integrated label Apr 15, 2025
Copy link
Member

@calvinccheung calvinccheung left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good overall. I have a question in classLoaderExt.cpp.

@@ -100,4 +100,8 @@ void ClassLoaderExt::record_result(const s2 classpath_index, InstanceKlass* resu
CDSConfig::disable_heap_dumping();
}
#endif // INCLUDE_CDS_JAVA_HEAP

if (CDSConfig::is_dumping_preimage_static_archive() || CDSConfig::is_dumping_dynamic_archive()) {
AOTClassLocationConfig::dumptime()->check_invalid_classpath_index(classpath_index, result);
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In case the classpath_index is invalid, I don't think we should call AOTClassLocationConfig::dumptime_update_max_used_index(). Maybe the check_invalid_classpath_index() function should return a bool and have ClassLoaderExt::record_result() update the classpath index and max used index.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed.

@openjdk openjdk bot removed the ready Pull request is ready to be integrated label Apr 16, 2025
Copy link
Member

@calvinccheung calvinccheung left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the update. Just one minor comment.

@@ -23,6 +23,7 @@
*/

#include "cds/aotClassLinker.hpp"
#include "cds/aotClassLocation.hpp"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this include needed?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I added it by mistake. I've removed it. Could you re-approve?

@openjdk openjdk bot added the ready Pull request is ready to be integrated label Apr 16, 2025
@openjdk openjdk bot removed the ready Pull request is ready to be integrated label Apr 16, 2025
@openjdk openjdk bot added the ready Pull request is ready to be integrated label Apr 16, 2025
@iklam
Copy link
Member Author

iklam commented Apr 16, 2025

Thanks @calvinccheung @calvinccheung for the review
/integrate

@openjdk
Copy link

openjdk bot commented Apr 16, 2025

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

Your commit was automatically rebased without conflicts.

@openjdk openjdk bot added the integrated Pull request has been integrated label Apr 16, 2025
@openjdk openjdk bot closed this Apr 16, 2025
@openjdk openjdk bot removed ready Pull request is ready to be integrated rfr Pull request is ready for review labels Apr 16, 2025
@openjdk
Copy link

openjdk bot commented Apr 16, 2025

@iklam Pushed as commit e433fa2.

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

Successfully merging this pull request may close these issues.

3 participants