Skip to content

Conversation

@iklam
Copy link
Member

@iklam iklam commented Oct 17, 2025

By annotating SharedSecrets as @AOTSafeClassInitializer, we can avoid using the @AOTRuntimeSetup annotations in a few JDK core classes. This simplifies the implementation. It also brings us closer to the goal of making the AOT cache as a true snapshot of the JVM state that just needs to be resumed in the production run.


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-8368199: Add @AOTSafeClassInitializer to jdk.internal.access.SharedSecrets (Enhancement - P4)

Reviewers

Reviewing

Using git

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

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

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 27880

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

Using diff file

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

Using Webrev

Link to Webrev Comment

@bridgekeeper
Copy link

bridgekeeper bot commented Oct 17, 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 Oct 17, 2025

@iklam This change is no longer ready for integration - check the PR body for details.

@openjdk
Copy link

openjdk bot commented Oct 17, 2025

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

  • core-libs
  • hotspot-runtime
  • net
  • security

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.

@openjdk openjdk bot added the rfr Pull request is ready for review label Oct 17, 2025
@mlbridge
Copy link

mlbridge bot commented Oct 17, 2025

Webrevs

@AOTSafeClassInitializer
public class SharedSecrets {
// This field is not necessarily stable
private static JavaAWTFontAccess javaAWTFontAccess;
Copy link
Member

Choose a reason for hiding this comment

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

Does aot initialization work with this field?

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 think this field is safe. There are two places that could set it, but they will always set it to an instance of JavaAWTFontAccessImpl, which is stateless.

if (SharedSecrets.getJavaAWTFontAccess() == null) {
SharedSecrets.setJavaAWTFontAccess(new JavaAWTFontAccessImpl());

if (SharedSecrets.getJavaAWTFontAccess() == null) {
SharedSecrets.setJavaAWTFontAccess(new JavaAWTFontAccessImpl());

Copy link
Member

@liach liach left a comment

Choose a reason for hiding this comment

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

Archiving the accessors should be fine.

@openjdk openjdk bot added the ready Pull request is ready to be integrated label Oct 18, 2025
*/

// Static fields in this class are stateless, so the values initialized in the
// AOT assembly phase can be safely cached.
Copy link
Contributor

Choose a reason for hiding this comment

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

Looking through the implementations of the Access classes, and I have concerns about:
setJavaObjectInputFilterAccess as it is implemented using a lambda:

SharedSecrets.setJavaObjectInputFilterAccess(Config::createFilter2);

Correct me if I'm wrong, but I believe that will cause the Config class to be AOTInitialized as well?

Config has a couple of system properties (-Djdk.serialFilter= for one) that we may not want to initialize during the assembly phase.

Copy link
Contributor

Choose a reason for hiding this comment

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

There may be a similar issue with ObjectInputStream as well as I think this forces the class to be AOTInitialized.

        SharedSecrets.setJavaObjectInputStreamAccess(ObjectInputStream::checkArray);
        SharedSecrets.setJavaObjectInputStreamReadString(ObjectInputStream::readString);

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 two accessors are currently not used in the AOT assembly phase. Maybe we can add an assert that the corresponding fields are null, and abort the AOT assembly otherwise?

Copy link
Contributor

Choose a reason for hiding this comment

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

Is there a particular subset of the SharedSecrets accessors that we want to allow to be set during the assembly phase?

Is there a way we can mark the fields in SharedSecrets as allowed to be assembly initialized vs those that must be null?

The unfortunate thing is that if these fields didn't use Lambdas, they would also be fine to assembly-time initialize as it's the side-effect of the lambda forcing init that's the problem

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 looked at all the calls of the pattern SharedSecrets.set.*::

java/io/ObjectInputFilter.java: SharedSecrets.setJavaObjectInputFilterAccess(Config::createFilter2);
java/io/ObjectInputStream.java: SharedSecrets.setJavaObjectInputStreamAccess(ObjectInputStream::checkArray);
java/io/ObjectInputStream.java: SharedSecrets.setJavaObjectInputStreamReadString(ObjectInputStream::readString);
javax/crypto/SealedObject.java: SharedSecrets.setJavaxCryptoSealedObjectAccess(SealedObject::getExtObjectInputStream);

These calls are all done inside a <clinit>. In the four cases, only the first class (java.io.ObjectInputFilter.Config) has environment-dependent code inside its <clinit>.

Maybe we should mark the java.io.ObjectInputFilter.Config class with a new annotation AOTUnsafeClassInitializer (the opposite of the existing AOTSafeClassInitializer). If this class is initialized in the assembly phase, the VM will exit.

I think we can leave the other 3 cases alone.

An alternative is to rewrite the first case from:

SharedSecrets.setJavaObjectInputFilterAccess(Config::createFilter2);

to

SharedSecrets.setJavaObjectInputFilterAccess(new JavaObjectInputFilterAccess() {
    ObjectInputFilter createFilter2(String pattern) {
        return Config.createFilter2(pattern);
    }
});

Choose a reason for hiding this comment

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

The ObjectInputStreamReadString interface should just be merged into ObjectInputStreamAccess:

SharedSecrets.setJavaObjectInputStreamAccess(new ObjectInputStreamAccess() {
	public void checkArray(ObjectInputStream ois, Class<?> arrayType, int arrayLength) throws ObjectStreamException {
		ois.checkArray(arrayType, arrayLength);
	}

	public String readString(ObjectInputStream ois) throws IOException {
		return ois.readString();
	}
});

Copy link
Member Author

Choose a reason for hiding this comment

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

The ObjectInputStreamReadString interface should just be merged into ObjectInputStreamAccess.

I agree. This seems better than using two separate Access interfaces with two separate lambdas. Maybe this should be done in a separate RFE?

Copy link
Member Author

Choose a reason for hiding this comment

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

Is there a particular subset of the SharedSecrets accessors that we want to allow to be set during the assembly phase?

@DanHeidinga , I updated the code to disallow any AOT-initialized accessors that are not stateless. See CDSHeapVerifier::SharedSecretsAccessorFinder::do_field(). This check should cover all existing use of Lambdas in setting the accessors, as well as future changes in the core lib that might add other types of states in the accessors.

// This object carries no state and we can create a new one in the production run.
if (fd->signature()->starts_with("Ljdk/internal/access/") &&
fd->signature()->ends_with("Access;")) {
// The jdk/internal/access/*Access classes carry no states so they can be safely
Copy link
Contributor

@minborg minborg Oct 27, 2025

Choose a reason for hiding this comment

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

This might be true for the time being, but adding such an assumption is a constraint for the future and should be documented. Perhaps we should have an interface Access that the various access classes implement, and where we could document this and other constraints of the access classes.

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 removed this hard-coded check and instead added CDSHeapVerifier::add_shared_secret_accessors(), which requires all AOT-initialized accessors to be stateless.

I also added a negative test case for SharedSecrets::javaObjectInputFilterAccess, which is not stateless so it cannot be initialized in the AOT assembly phase.

@openjdk openjdk bot added hotspot [email protected] and removed ready Pull request is ready to be integrated labels Oct 28, 2025
@openjdk
Copy link

openjdk bot commented Oct 28, 2025

@iklam hotspot has been added to this pull request based on files touched in new commit(s).

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.

5 participants