Skip to content
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

Introduce new JPMS exports to allow running native-image on module-path #25986

Merged
merged 3 commits into from
Jun 16, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
package io.quarkus.deployment.builditem.nativeimage;

import java.util.Objects;

import io.quarkus.builder.item.MultiBuildItem;

/**
Expand All @@ -22,4 +24,21 @@ public String getPackage() {
public String getModule() {
return moduleName;
}

@Override
public boolean equals(Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
JPMSExportBuildItem that = (JPMSExportBuildItem) o;
return moduleName.equals(that.moduleName) && packageName.equals(that.packageName);
}

@Override
public int hashCode() {
return Objects.hash(moduleName, packageName);
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Objects;
Expand All @@ -23,6 +24,7 @@
import org.jboss.logging.Logger;

import io.quarkus.bootstrap.util.IoUtils;
import io.quarkus.deployment.annotations.BuildProducer;
import io.quarkus.deployment.annotations.BuildStep;
import io.quarkus.deployment.builditem.nativeimage.ExcludeConfigBuildItem;
import io.quarkus.deployment.builditem.nativeimage.JPMSExportBuildItem;
Expand Down Expand Up @@ -73,6 +75,12 @@ public class NativeImageBuildStep {
private static final String MOVED_TRUST_STORE_NAME = "trustStore";
public static final String APP_SOURCES = "app-sources";

@BuildStep(onlyIf = NativeOrNativeSourcesBuildGraal22_2OrLater.class)
void addExportsToNativeImage(BuildProducer<JPMSExportBuildItem> exports) {
// Needed by io.quarkus.runtime.ResourceHelper.registerResources
exports.produce(new JPMSExportBuildItem("org.graalvm.nativeimage.builder", "com.oracle.svm.core.jdk"));
}

@BuildStep(onlyIf = NativeBuild.class)
ArtifactResultBuildItem result(NativeImageBuildItem image) {
NativeImageBuildItem.GraalVMVersion graalVMVersion = image.getGraalVMInfo();
Expand Down Expand Up @@ -807,7 +815,8 @@ public NativeImageInvokerInfo build() {
}

if (jpmsExports != null) {
for (JPMSExportBuildItem jpmsExport : jpmsExports) {
HashSet<JPMSExportBuildItem> deduplicatedJpmsExport = new HashSet<>(jpmsExports);
for (JPMSExportBuildItem jpmsExport : deduplicatedJpmsExport) {
nativeImageArgs.add(
"-J--add-exports=" + jpmsExport.getModule() + "/" + jpmsExport.getPackage() + "=ALL-UNNAMED");
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,4 +22,5 @@ public boolean getAsBoolean() {
return packageConfig.type.equalsIgnoreCase(PackageConfig.NATIVE)
|| packageConfig.type.equalsIgnoreCase(PackageConfig.NATIVE_SOURCES);
}

}
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
package io.quarkus.deployment.pkg.steps;

import java.util.function.BooleanSupplier;

import org.graalvm.home.Version;

import io.quarkus.deployment.pkg.PackageConfig;

/**
* Supplier that can be used to only run build steps in the
* native or native sources builds when using Graal >= 22.2.
* Most build steps that need to be run conditionally should use this instead of {@link NativeBuild}.
*/
public class NativeOrNativeSourcesBuildGraal22_2OrLater implements BooleanSupplier {

private final PackageConfig packageConfig;

NativeOrNativeSourcesBuildGraal22_2OrLater(PackageConfig packageConfig) {
this.packageConfig = packageConfig;
}

@Override
public boolean getAsBoolean() {
return (packageConfig.type.equalsIgnoreCase(PackageConfig.NATIVE)
|| packageConfig.type.equalsIgnoreCase(PackageConfig.NATIVE_SOURCES))
&& (Version.getCurrent().isSnapshot() || Version.getCurrent().compareTo(22, 2) >= 0);
}

}
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@
import io.quarkus.deployment.builditem.GeneratedNativeImageClassBuildItem;
import io.quarkus.deployment.builditem.GeneratedResourceBuildItem;
import io.quarkus.deployment.builditem.nativeimage.ForceNonWeakReflectiveClassBuildItem;
import io.quarkus.deployment.builditem.nativeimage.JPMSExportBuildItem;
import io.quarkus.deployment.builditem.nativeimage.JniRuntimeAccessBuildItem;
import io.quarkus.deployment.builditem.nativeimage.LambdaCapturingTypeBuildItem;
import io.quarkus.deployment.builditem.nativeimage.NativeImageProxyDefinitionBuildItem;
Expand All @@ -40,6 +41,7 @@
import io.quarkus.deployment.builditem.nativeimage.RuntimeReinitializedClassBuildItem;
import io.quarkus.deployment.builditem.nativeimage.ServiceProviderBuildItem;
import io.quarkus.deployment.builditem.nativeimage.UnsafeAccessedFieldBuildItem;
import io.quarkus.deployment.pkg.steps.NativeOrNativeSourcesBuildGraal22_2OrLater;
import io.quarkus.gizmo.AssignableResultHandle;
import io.quarkus.gizmo.CatchBlockCreator;
import io.quarkus.gizmo.ClassCreator;
Expand Down Expand Up @@ -116,8 +118,22 @@ GeneratedResourceBuildItem generateNativeResourcesList(List<NativeImageResourceB
sb.toString().getBytes(StandardCharsets.UTF_8));
}

@BuildStep(onlyIf = NativeOrNativeSourcesBuildGraal22_2OrLater.class)
JPMSExportBuildItem addExportsToNativeImage(List<JniRuntimeAccessBuildItem> jniRuntimeAccessibleClasses) {
// required in order to access com.oracle.svm.core.jni.JNIRuntimeAccess
if (jniRuntimeAccessibleClasses != null && !jniRuntimeAccessibleClasses.isEmpty()) {
return new JPMSExportBuildItem("org.graalvm.nativeimage.builder", "com.oracle.svm.core.jni");
}
return null;
}

private boolean graalVM22_2OrLater() {
return Version.getCurrent().isSnapshot() || Version.getCurrent().compareTo(22, 2) >= 0;
}

@BuildStep
void generateFeature(BuildProducer<GeneratedNativeImageClassBuildItem> nativeImageClass,
BuildProducer<JPMSExportBuildItem> exports,
List<RuntimeInitializedClassBuildItem> runtimeInitializedClassBuildItems,
List<RuntimeInitializedPackageBuildItem> runtimeInitializedPackageBuildItems,
List<RuntimeReinitializedClassBuildItem> runtimeReinitializedClassBuildItems,
Expand Down Expand Up @@ -239,6 +255,11 @@ public void write(String s, byte[] bytes) {
}

if (!proxies.isEmpty()) {
if (graalVM22_2OrLater()) {
// Needed to access DYNAMIC_PROXY_REGISTRY
exports.produce(new JPMSExportBuildItem("org.graalvm.nativeimage.builder", "com.oracle.svm.core.jdk.proxy"));
}

ResultHandle proxySupportClass = overallCatch.loadClassFromTCCL(DYNAMIC_PROXY_REGISTRY);
ResultHandle proxySupport = overallCatch.invokeStaticMethod(
IMAGE_SINGLETONS_LOOKUP,
Expand All @@ -259,6 +280,11 @@ public void write(String s, byte[] bytes) {

/* Resource includes and excludes */
if (!resourcePatterns.isEmpty()) {
if (graalVM22_2OrLater()) {
// Needed to access LOOKUP_METHOD
exports.produce(new JPMSExportBuildItem("org.graalvm.nativeimage.base", "com.oracle.svm.util"));
}

ResultHandle resourcesRegistrySingleton = overallCatch.invokeStaticMethod(IMAGE_SINGLETONS_LOOKUP,
overallCatch.loadClassFromTCCL("com.oracle.svm.core.configure.ResourcesRegistry"));
TryBlock tc = overallCatch.tryBlock();
Expand Down Expand Up @@ -316,6 +342,12 @@ public void write(String s, byte[] bytes) {
}

if (!resourceBundles.isEmpty()) {
if (graalVM22_2OrLater()) {
// Needed to access LOCALIZATION_FEATURE
exports.produce(
new JPMSExportBuildItem("org.graalvm.nativeimage.builder", "com.oracle.svm.core.jdk.localization"));
}

AssignableResultHandle registerMethod = overallCatch.createVariable(Method.class);
AssignableResultHandle locClass = overallCatch.createVariable(Class.class);
TryBlock locTryBlock = overallCatch.tryBlock();
Expand Down Expand Up @@ -474,6 +506,10 @@ public void write(String s, byte[] bytes) {

if (entry.getValue().serialization) {
if (registerSerializationMethod == null) {
if (graalVM22_2OrLater()) {
// Needed by createRegisterSerializationForClassMethod to access LOOKUP_METHOD
exports.produce(new JPMSExportBuildItem("org.graalvm.nativeimage.base", "com.oracle.svm.util"));
}
registerSerializationMethod = createRegisterSerializationForClassMethod(file);
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -170,7 +170,6 @@ JniRuntimeAccessBuildItem setupJava2DClasses() {
"sun.java2d.loops.FillRect",
"sun.java2d.loops.FillSpans",
"sun.java2d.loops.GraphicsPrimitive",
"sun.java2d.loops.GraphicsPrimitive[]",
"sun.java2d.loops.GraphicsPrimitiveMgr",
"sun.java2d.loops.MaskBlit",
"sun.java2d.loops.MaskFill",
Expand Down