Generate GraalVM native image config #5005

trustin · 2023-07-03T14:52:43Z

Motivation:

Armeria and its dependencies (e.g. Netty, JCTools and Caffeine) use
fair amount of reflections, JNI and other advanced features of JVM,
which require explicit configuration when building a native image with
GraalVM. We should provide native image configuration in our artifacts
so that a user can easily build a native image out of the box.

Modifications:

Added a new project flag native. For a project with native flag,
we add a task nativeImageTrace that runs select test cases annotated
with a GenerateNativeImageTrace to collect the trace files generated
by native-image-agent.
- See https://www.graalvm.org/22.0/reference-manual/native-image/Agent/
Added a new project :native-image-config, which:
- aggregates all traces into native image config; and
- cleans up the noise from the generated native image config
Added the initial version of native image config to
META-INF/native-image/com.linecorp.armeria/armeria.
Renamed and relocated some test classes so that they are not included
in the native image config

Result:

A user can now easily build a native image of an Armeria application.
Future works:
- Configure our build pipieline to generate native image config for
  different platforms automatically (macOS, Linux epoll, Linux io_uring
  and Windows).
- Use annotation processors rather than reflection for scanning
  annotations.
- Add entries for Windows and Linux io_uring.

codecov · 2023-08-11T10:54:54Z

Codecov Report

Patch coverage has no change and project coverage change: +0.01% 🎉

Comparison is base (5da5ea4) 74.30% compared to head (53d496d) 74.32%.
Report is 2 commits behind head on main.

Additional details and impacted files

@@             Coverage Diff              @@
##               main    #5005      +/-   ##
============================================
+ Coverage     74.30%   74.32%   +0.01%     
- Complexity    19598    19605       +7     
============================================
  Files          1682     1682              
  Lines         72252    72252              
  Branches       9241     9241              
============================================
+ Hits          53690    53703      +13     
+ Misses        14221    14216       -5     
+ Partials       4341     4333       -8

see 19 files with indirect coverage changes

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

jrhee17

Left some questions but looks good overall. Thanks @trustin 🙇 👍 🚀

jrhee17 · 2023-08-14T05:56:13Z

build.gradle

+
+            // Remove 'jetty-alpn-agent' and add 'native-image-agent'.
+            jvmArgs = jvmArgs.stream().filter {
+                !(it.startsWith('-javaagent:') && it.endsWith('jetty-alpn-agent.jar'))


nit; I believe this isn't needed following #5060

jrhee17 · 2023-08-14T07:39:13Z

build.gradle

+            relocatedProjects.each { p ->
+                if (projectsWithNativeImageSupport.contains(p)) {
+                    p.tasks.getByName('nativeImageTrace').configure {
+                        classpath += p.files(p.configurations.getByName('shadedJarTestRuntime').resolve())


I see, I understood we have to add this here in a separate afterEvaluate because the shadedJarTestRuntime configuration itself is evaluated in a afterEvaluate.

native-image-config/README.md

jrhee17 · 2023-08-14T08:26:28Z

native-image-config/build.gradle.kts

+
+    private val resourceRegex = """^(?:[._a-zA-Z0-9:]*)\\Q(.*)\\E$""".toRegex()
+
+    private fun filterResources(fileName: String, obj: JsonNode, baseResourcePatterns: Iterable<Regex>) {


Question) I don't think I understood the intention of baseResourceConfigFile 😅 Wouldn't the file be used eventually in the nativeImageConfig task anyways?

You're correct, but they are meant for being used when our 'user' builds a native image. We just use the same set of rules to filter out irrelevant and/or duplicate resource configurations in our native image config.

jrhee17 · 2023-08-14T08:32:34Z

native-image-config/README.md

+`GenerateNativeImageTrace` with [`native-image-agent`](https://www.graalvm.org/latest/reference-manual/native-image/metadata/AutomaticMetadataCollection/).
+
+```
+$ ../gradlew nativeImageConfig


When running from my local env. I found the following logs:

Warning: Error processing trace entry map(size=5, {(tracer,reflect),(function,getEnclosingMethod),(caller_class,org.awaitility.core.AssertionCondition),(result,false),(args,[])}): java.lang.StringIndexOutOfBoundsException: begin 0, end -1, length 5 at java.base/java.lang.String.checkBoundsBeginEnd(String.java:4606) at java.base/java.lang.String.substring(String.java:2709) at org.graalvm.nativeimage.configure/com.oracle.svm.configure.trace.ReflectionProcessor.addFullyQualifiedDeclaredMethod(ReflectionProcessor.java:293) at org.graalvm.nativeimage.configure/com.oracle.svm.configure.trace.ReflectionProcessor.processEntry(ReflectionProcessor.java:247) at org.graalvm.nativeimage.configure/com.oracle.svm.configure.trace.TraceProcessor.processEntry(TraceProcessor.java:87) at org.graalvm.nativeimage.configure/com.oracle.svm.configure.trace.TraceProcessor.processTrace(TraceProcessor.java:63) at org.graalvm.nativeimage.configure/com.oracle.svm.configure.trace.TraceProcessor.process(TraceProcessor.java:58) at org.graalvm.nativeimage.configure/com.oracle.svm.configure.command.ConfigurationGenerateCommand.generate(ConfigurationGenerateCommand.java:293) at org.graalvm.nativeimage.configure/com.oracle.svm.configure.command.ConfigurationGenerateCommand.apply(ConfigurationGenerateCommand.java:60) at org.graalvm.nativeimage.configure/com.oracle.svm.configure.ConfigurationTool.main(ConfigurationTool.java:84)

Just want to make sure this is normal/expected

It was reported to oracle/graal#6980

They seem to be harmless although they look scary. 😅

ikhoon · 2023-08-11T06:37:33Z

build.gradle

@@ -75,7 +79,7 @@ allprojects {
        // `disallow` in Java 18.
        // - https://openjdk.org/jeps/411
        // - https://bugs.openjdk.org/browse/JDK-8270380
-        if (project.ext.testJavaVersion >= 17) {
+        if (project.ext.testJavaVersion >= 17 || it.name == 'nativeImageTrace') {


Optional) What do you think of setting testJavaVersion of nativeImageTrace to 17?

testJavaVersion is specified on per-project basis rather than on per-task basis, so I guess that's not possible? (nativeImageTrace is a task that is created for each project.) Please correct me if I'm wrong.

build.gradle

ikhoon · 2023-08-14T08:36:08Z

native-image-config/README.md

+`GenerateNativeImageTrace` with [`native-image-agent`](https://www.graalvm.org/latest/reference-manual/native-image/metadata/AutomaticMetadataCollection/).
+
+```
+$ ../gradlew nativeImageConfig


It was reported to oracle/graal#6980

ikhoon · 2023-08-14T09:03:33Z

Side note:

I failed to build our SAML example as a native image due to the following exception:

Exception in thread "main" java.lang.IllegalArgumentException: URI scheme is not "file"
        at java.base@17.0.8/java.io.File.<init>(File.java:423)
        at example.armeria.server.saml.sp.Main.main(Main.java:99)

After digging into the issue, it turned out that the scheme of URI was file: on JVM but resource: on the native image. Consequently, new File(URI) raised IllegalArgumentException for the non-file scheme.
https://github.com/openjdk/jdk/blob/4164693f3bf15a2f3e03dee72e1ca3fb8d82582c/src/java.base/share/classes/java/io/File.java#L422

armeria/examples/saml-service-provider/src/main/java/example/armeria/server/saml/sp/Main.java

Lines 96 to 97 in 5ed3cac

    
           .tls(new File(ClassLoader.getSystemResource("localhost.crt").toURI()), 
        
                new File(ClassLoader.getSystemResource("localhost.key").toURI()))

I was able to run the SAML example after fixing the code to use InputStream.

.tls(Main.class.getClassLoader().getResourceAsStream("localhost.crt"),
     Main.class.getClassLoader().getResourceAsStream("localhost.key"))

Co-authored-by: jrhee17 <guins_j@guins.org>

trustin · 2023-08-16T10:01:20Z

@ikhoon wrote:

I was able to run the SAML example after fixing the code to use InputStream.

Do you think we should update the example, then? 🤔

minwoox

Look great and left a small suggestion. 👍

minwoox · 2023-08-16T10:56:12Z

native-image-config/build.gradle.kts

+        newCommandLine += "generate"
+        nativeImageTraceFiles.forEach {
+            if (Files.exists(it)) {
+                newCommandLine += "--trace-input=$it"


Shouldn't we also add the files to inputs?

Task input must be specified at configuration time, but we only know whether the trace file exists at execution time, so we cannot add every one of them at configuration time. (Gradle will error when we add a missing file as an input unfortunately.) Instead, I added the directory that contains the trace files as an input, so all trace files in the directory are hashed.

minwoox · 2023-08-17T03:49:39Z

native-image-config/build.gradle.kts

+    }
+}
+
+abstract class CleanupNativeImageConfigTask : DefaultTask() {


perhaps FilterAndCopyNativeImageConfigTask?
For me, the word clean in a Gradle task means removing the generated files. 🤔

ikhoon · 2023-08-17T05:51:41Z

@ikhoon wrote:

I was able to run the SAML example after fixing the code to use InputStream.

Do you think we should update the example, then? 🤔

Not today. 😆
Someday, I believe we need a CI to build Armeria examples as native images and run them with minimal setup to verify native image configurations are sensible enough. Let's fix our examples then.

ikhoon

Thanks, @trustin! 🚀🚀

ikhoon

Thanks, @trustin! 🚀🚀

…nst main

native-image-config/README.md

minwoox

Thanks, @trustin! 🚀 👍 💯

trustin · 2023-08-18T06:49:14Z

Let me merge this after the build passes AND I confirm the native image configuration actually works manually.

trustin requested review from ikhoon, jrhee17 and minwoox as code owners July 3, 2023 14:52

trustin marked this pull request as draft July 5, 2023 07:27

trustin force-pushed the generate-native-image-config branch 5 times, most recently from 53e05a3 to f476714 Compare July 12, 2023 12:28

trustin changed the title ~~Generate GraalVM native image config with -PnativeImageConfig~~ Generate GraalVM native image config Jul 12, 2023

trustin force-pushed the generate-native-image-config branch 12 times, most recently from 99a3460 to bead3b3 Compare July 18, 2023 12:53

trustin force-pushed the generate-native-image-config branch 8 times, most recently from 07587ae to 3fc921f Compare July 20, 2023 17:29

trustin force-pushed the generate-native-image-config branch 3 times, most recently from e9449a3 to 5f6cff1 Compare July 21, 2023 10:19

trustin added the new feature label Jul 21, 2023

trustin added this to the 1.25.0 milestone Jul 21, 2023

Initial commit

1087aac

trustin force-pushed the generate-native-image-config branch from 5f6cff1 to 1087aac Compare July 21, 2023 10:32

trustin marked this pull request as ready for review July 21, 2023 10:32

Merge branch 'main' into generate-native-image-config

32211fe

jrhee17 approved these changes Aug 14, 2023

View reviewed changes

Merge branch 'main' into generate-native-image-config

cdf35db

ikhoon reviewed Aug 14, 2023

View reviewed changes

Update native-image-config/README.md

e4f4653

Co-authored-by: jrhee17 <guins_j@guins.org>

minwoox reviewed Aug 17, 2023

View reviewed changes

ikhoon approved these changes Aug 17, 2023

View reviewed changes

trustin added 2 commits August 18, 2023 11:20

Merge branch 'main' into generate-native-image-config

cb65392

Address the comment from @minwoox and update native image config agai…

811fd69

…nst main

minwoox reviewed Aug 18, 2023

View reviewed changes

native-image-config/README.md Outdated Show resolved Hide resolved

trustin added 2 commits August 18, 2023 15:32

Merge branch 'main' into generate-native-image-config

b106f44

Fix README.md

53d496d

minwoox approved these changes Aug 18, 2023

View reviewed changes

trustin merged commit d34cee7 into line:main Aug 18, 2023

trustin deleted the generate-native-image-config branch August 18, 2023 07:26

ikhoon mentioned this pull request Mar 29, 2024

Support GraalVM #3321

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Generate GraalVM native image config #5005

Generate GraalVM native image config #5005

trustin commented Jul 3, 2023 •

edited

Loading

codecov bot commented Aug 11, 2023 •

edited

Loading

jrhee17 left a comment

jrhee17 Aug 14, 2023

jrhee17 Aug 14, 2023

jrhee17 Aug 14, 2023 •

edited

Loading

trustin Aug 16, 2023 •

edited

Loading

jrhee17 Aug 14, 2023

ikhoon Aug 14, 2023

trustin Aug 16, 2023

ikhoon Aug 11, 2023

trustin Aug 16, 2023

ikhoon Aug 14, 2023

ikhoon commented Aug 14, 2023

trustin commented Aug 16, 2023

minwoox left a comment

minwoox Aug 16, 2023

trustin Aug 17, 2023

minwoox Aug 17, 2023

ikhoon commented Aug 17, 2023 •

edited

Loading

ikhoon left a comment

ikhoon left a comment

minwoox left a comment

trustin commented Aug 18, 2023


		private val resourceRegex = """^(?:[._a-zA-Z0-9:])\\Q(.)\\E$""".toRegex()

		private fun filterResources(fileName: String, obj: JsonNode, baseResourcePatterns: Iterable<Regex>) {

Generate GraalVM native image config #5005

Generate GraalVM native image config #5005

Conversation

trustin commented Jul 3, 2023 • edited Loading

codecov bot commented Aug 11, 2023 • edited Loading

Codecov Report

jrhee17 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jrhee17 Aug 14, 2023 • edited Loading

Choose a reason for hiding this comment

trustin Aug 16, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ikhoon commented Aug 14, 2023

trustin commented Aug 16, 2023

minwoox left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ikhoon commented Aug 17, 2023 • edited Loading

ikhoon left a comment

Choose a reason for hiding this comment

ikhoon left a comment

Choose a reason for hiding this comment

minwoox left a comment

Choose a reason for hiding this comment

trustin commented Aug 18, 2023

trustin commented Jul 3, 2023 •

edited

Loading

codecov bot commented Aug 11, 2023 •

edited

Loading

jrhee17 Aug 14, 2023 •

edited

Loading

trustin Aug 16, 2023 •

edited

Loading

ikhoon commented Aug 17, 2023 •

edited

Loading