Generate dynamic access metadata and provide it to the classpath when passing "--emit build-report" as a build argument #795

jormundur00 · 2025-11-10T10:45:39Z

In this PR we add the Maven mojo and Gradle task for generating and providing to the native image build classpath a dynamic-access-metadata.json file, when emitting a Build Report (when the --emit build-report build argument is present) and the used release of the graalvm-reachability-metadata repository contains the library-and-framework-list.json file.

The generated JSON file maps all of the artifacts present on the classpath that exist in the library-and-framework-list.json to the list of their transitive dependencies (as they are marked as "metadata provided-for" by the parent artifact). It is later used by the dynamic access tab of the native image Build Report to mark these "provided-for" dependencies as being covered by native image and not "needing investigation". The JSON file follows the schema at: https://github.com/oracle/graal/blob/master/docs/reference-manual/native-image/assets/dynamic-access-metadata-schema-v1.0.0.json.

Both the Maven mojo and the Gradle task can be ran standalone, but will automatically run when emitting a Build Report and running the native image build mojo/task.

Fixes: #801.

…ugin

…mit build-report"

…mpile-no-fork while emitting a Build Report

…adle plugins add the generated file to the classpath instead of a new option

… the maven and gradle plugins

… is given a path

… the classpath

oracle-contributor-agreement · 2025-11-10T10:45:43Z

Thank you for your pull request and welcome to our community! To contribute, please sign the Oracle Contributor Agreement (OCA).
The following contributors of this PR have not signed the OCA:

PR author: jormundur00

To sign the OCA, please create an Oracle account and sign the OCA in Oracle's Contributor Agreement Application.

When signing the OCA, please provide your GitHub username. After signing the OCA and getting an OCA approval from Oracle, this PR will be automatically updated.

If you are an Oracle employee, please make sure that you are a member of the main Oracle GitHub organization, and your membership in this organization is public.

melix · 2025-11-10T10:50:15Z

...src/main/java/org/graalvm/buildtools/gradle/internal/GraalVMReachabilityMetadataService.java

        });
    }
+
+    public Path getRepositoryDirectory() {


❌ Should probably return Optional<Path> instead, so that we don't have to figure out if null is expected or not.

melix · 2025-11-10T10:52:09Z

...-plugin/src/main/java/org/graalvm/buildtools/gradle/tasks/GenerateDynamicAccessMetadata.java

+    private static final String PROVIDES_FOR = "providesFor";
+
+    @Internal
+    public abstract Property<Configuration> getRuntimeClasspath();


❌ This is not compatible with Gradle's configuration cache. We shouldn't use Configuration as input (probably a Property<ResolvedComponentResult>).

I've since moved to the usage of Property<ResolvedComponentResult> and SetProperty<ResolvedArtifactResult> (trying to follow the pattern you used when setting properties for the CollectReachabilityMetadata task to be safe).

melix · 2025-11-10T10:52:47Z

...-plugin/src/main/java/org/graalvm/buildtools/gradle/tasks/GenerateDynamicAccessMetadata.java

+            Set<File> classpathEntries = runtimeClasspathConfig.getFiles();
+
+            Map<String, Set<String>> exportMap = buildExportMap(
+                    runtimeClasspathConfig.getResolvedConfiguration().getFirstLevelModuleDependencies(),


❌ You should use a dependency graph as input instead. This isn't compatible with the configuration cache.

melix · 2025-11-10T10:53:41Z

...-plugin/src/main/java/org/graalvm/buildtools/gradle/tasks/GenerateDynamicAccessMetadata.java

+     * entry in the {@value #LIBRARY_AND_FRAMEWORK_LIST} file.
+     */
+    private Set<String> readArtifacts(File inputFile) throws IOException {
+        Set<String> artifacts = new HashSet<>();


Should probably use a LinkedHashSet so that the result is consistent across invocations.

melix · 2025-11-10T10:56:03Z

native-gradle-plugin/src/main/java/org/graalvm/buildtools/gradle/NativeImagePlugin.java

+                tasks,
+                deriveTaskName(binaryName, "generate", "DynamicAccessMetadata"));
+            imageBuilder.configure(buildImageTask -> {
+                if (buildImageTask.getOptions().get().getBuildArgs().get().stream()


❌ This is likely to fail, because you are reading the build arguments during configuration of a task, which is non deterministic (depends on when the build args are changed in a script). Either the reasoning has to be deferred to execution time, based on the actual arguments, or it should use a non eager transformation (not use .get() but .map).

melix · 2025-11-10T10:57:03Z

native-gradle-plugin/build.gradle

 }

 dependencies {
+    implementation libs.openjson


❌ The Gradle plugin shouldn't have a direct dependency on openjson. The common utils should have one, but there's no reason the Gradle plugin should directly depend on it.

I've created a separate DynamicAccessMetadataUtils class where I do this serialization and JSON parsing (which I left in the commons.utils package), so now I don't add this direct dependency on openjson here anymore.

FYI: Not sure if the same applies for the native-maven-plugin, but in the build.gradle.kts for it, we already depend on both libs.utils and libs.openjson.

… invocations

… emitted

…tResult> instead of relying on Property<Configuration>

…class, that is used by both the Maven and Gradle plugin

jormundur00 · 2025-11-26T07:40:38Z

Hey @melix, I've refactored the code to align with your requested changes, so please take another look when you have the time.

melix · 2025-11-27T12:53:25Z

...-plugin/src/main/java/org/graalvm/buildtools/gradle/tasks/GenerateDynamicAccessMetadata.java

+    }
+
+    @Internal
+    public abstract Property<ResolvedComponentResult> getRuntimeClasspathGraph();


I don't think these are really internal, right? Internal means used internally but without influencing the inputs. If the graph changes, I assume that this has to be taken into account?

melix · 2025-11-28T07:56:01Z

I was thinking that maybe instead of complicated logic to figure out if --emit-build-report is used, this should be the other way around: add a DSL argument Property<Boolean> emitBuildReport and simply use that. That would be the idiomatic Gradle way I think: a DSL flag determines what behavior to expect and the build tool generates the proper arguments. If the feature is not directly related to emitting a build report, maybe we should have a generateDynamicAccessMetadata which, if enabled, makes sure that --emit-build-report is added. In general in Gradle we want to avoid explicit arguments: buildArgs should be restricted to "unusual" args or things we can't figure out.

jormundur00 added 16 commits October 21, 2025 14:07

Add generateDynamicAccessMetadata gradle task to the native-gradle-pl…

c6d1038

…ugin

Implement dynamic access generator on the native-maven-plugin

17d00f7

Touch-up maven plugin

7b37e44

Relax exception catches and be more specific with exceptions

f17e327

Make GenerateDynamicAccessMetadata contingent on the presence of "--e…

1f4148e

…mit build-report"

Cleanup both plugins and make them more consistent with eachother

ea322e5

Hotfix private method being public

0c73931

Make the generateDynamicAccessMetadata mojo execute when executing co…

f033acf

…mpile-no-fork while emitting a Build Report

Add EOF newlines

fc0acfb

Make the dynamic access metadata generation parts of the maven and gr…

fe588bc

…adle plugins add the generated file to the classpath instead of a new option

Add documentation for the dynamic access metadata generation parts of…

3ba7d33

… the maven and gradle plugins

Make --emit build-report detection cover cases where the build report…

5f0b4c5

… is given a path

Move away from "JAR" usage, as different formats can be also found on…

05a2271

… the classpath

Make the JSON output format more verbose for the native-gradle-plugin

564ef46

Make the JSON output format more verbose for the native-maven-plugin

da047df

Update docs

6b9ccb8

oracle-contributor-agreement bot added the OCA Required At least one contributor does not have an approved Oracle Contributor Agreement. label Nov 10, 2025

melix requested changes Nov 10, 2025

View reviewed changes

Make GraalVMReachabilityMetadataService#getRepositoryDirectory optional

7655aca

jormundur00 changed the title ~~Generate dynamic access metadata and provide it to the classpath when emitting a Build Report~~ Generate dynamic access metadata and provide it to the classpath when emitting a Build Report (passing "--emit build-report" as a build argument)) Nov 10, 2025

oracle-contributor-agreement bot added OCA Verified All contributors have signed the Oracle Contributor Agreement. and removed OCA Required At least one contributor does not have an approved Oracle Contributor Agreement. labels Nov 10, 2025

jormundur00 added 5 commits November 10, 2025 15:28

Migrate to the use of LinkedHashSet to have consistent results across…

1c497ea

… invocations

Use non-eager transformation when checking if a build report is being…

e948593

… emitted

Use Property<ResolvedComponentResult> and PropertySet<ResolvedArtifac…

d001a47

…tResult> instead of relying on Property<Configuration>

Move JSON generation and parsing to a new DynamicAccessMetadataUtils …

f04d7e2

…class, that is used by both the Maven and Gradle plugin

Update and move serialization documentation to the util class

e2d7aeb

jormundur00 requested a review from melix November 13, 2025 11:36

jormundur00 requested a review from vjovanov November 20, 2025 13:24

melix reviewed Nov 27, 2025

View reviewed changes

Refactor @internal properties to @input

7d13364

jormundur00 force-pushed the jvukicev/dynamic-access-metadata branch from d4b8af7 to 7d13364 Compare November 27, 2025 14:12

melix approved these changes Nov 27, 2025

View reviewed changes

vjovanov approved these changes Nov 27, 2025

View reviewed changes

jormundur00 merged commit 54db68c into graalvm:master Nov 28, 2025
190 checks passed

Generate dynamic access metadata and provide it to the classpath when passing "--emit build-report" as a build argument #795

Generate dynamic access metadata and provide it to the classpath when passing "--emit build-report" as a build argument #795

Conversation

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

Uh oh!

Uh oh!

oracle-contributor-agreement bot commented Nov 10, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jormundur00 commented Nov 26, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

melix commented Nov 28, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

jormundur00 commented Nov 10, 2025 •

edited

Loading