Graal native-image no longer fails with graal-build-time

Because the Graal team has deprecated use of global
--initalize-at-build-time for native-image, we want
to switch to using clj-easy/graal-build-time.

After attempting this switch, our Windows native-image
builds started to consistently to fail.

The resolution turned out to be simple and has allowed
us to re-apply clj-easy/graal-build-time.

Details:

The native-image -H:Name option is used to specify a
target executable.

It seems that on Windows, some components of native-image
recognize that -H:Name can include a path and others do not.
And/or some components understand a forward slash path
separator in -H:Name and others do not.

We do not need to work out the nuances of what paths
and syntax work for -H:Name because we now instead
specify our target path via -H:Path.

We can assume that switching away from a global
--initialize-at-build-time evokes different components
in GraalVM native-image. It might be interesting to
explore why someday, but that is out of scope for this
issue.

Closes #165

Author: lread

deps.edn

@@ -95,16 +95,17 @@
            ;; Running tests under Graal
            ;;
            ;; We have two main Graal scenarios:
-           ;; sci-test - interpret tests via sci over natively compiled rewrite-clj
-           ;; native-test - natively compile src and tests and run
+           ;; graal:sci-test - interpret tests via sci over natively compiled rewrite-clj
+           ;; graal:native-test - natively compile src and tests and run
 
-           :sci-test {:override-deps {org.clojure/clojure {:mvn/version "1.10.3"}}
-                      :extra-paths ["target/generated/sci-test/src"]
+           :graal {:override-deps {org.clojure/clojure {:mvn/version "1.10.3"}}
+                   :extra-deps {com.github.clj-easy/graal-build-time {:mvn/version "0.1.4"}}}
+
+           :sci-test {:extra-paths ["target/generated/sci-test/src"]
                       :extra-deps {lread/sci-test {:git/url "https://github.com/lread/sci-test.git"
                                                    :sha "2af0994d7b4554be08c38f166400fc79f1c28b3e"}}}
 
-           :native-test {:override-deps {org.clojure/clojure {:mvn/version "1.10.3"}}
-                         :extra-paths ["target/generated/graal"]}
+           :native-test {:extra-paths ["target/generated/graal"]}
 
            ;; usage -M:sci-test:gen-reflection
            :gen-reflection {:main-opts ["-m" "sci-test.generate-reflection-file"]}

script/helper/graal.clj

@@ -73,18 +73,18 @@
     classpath))
 
 (defn run-native-image [{:keys [:graal-native-image :graal-reflection-fname
-                                :target-exe :classpath :native-image-xmx
+                                :target-path :target-exe :classpath :native-image-xmx
                                 :entry-class]}]
   (status/line :head "Graal native-image compile AOT")
   (fs/delete-file-recursively target-exe true)
   (let [native-image-cmd (->> [graal-native-image
+                               (str "-H:Path=" target-path)
                                (str "-H:Name=" target-exe)
                                "-H:+ReportExceptionStackTraces"
                                "-J-Dclojure.spec.skip-macros=true"
                                "-J-Dclojure.compiler.direct-linking=true"
                                (when graal-reflection-fname
                                  (str "-H:ReflectionConfigurationFiles=" graal-reflection-fname))
-                               "--initialize-at-build-time"
                                "-H:Log=registerResource:"
                                "-H:EnableURLProtocols=http,https,jar"
                                "--verbose"

script/test_native.clj

@@ -19,7 +19,9 @@
 (defn -main [& args]
   (when (main/doc-arg-opt args)
     (let [native-image-xmx "6g"
-          target-exe "target/rewrite-clj-test"]
+          target-path "target"
+          target-exe "rewrite-clj-test"
+          full-target-exe (str (io/file target-path target-exe))]
       (status/line :head "Creating native image for test")
       (status/line :detail "java -version")
       (shell/command "java -version")
@@ -28,17 +30,18 @@
             test-runner-dir "target/generated/graal"]
         (graal/clean)
         (generate-test-runner test-runner-dir)
-        (let [classpath (graal/compute-classpath "test-common:native-test")]
+        (let [classpath (graal/compute-classpath "test-common:graal:native-test")]
           (graal/aot-compile-sources classpath "clj-graal.test-runner")
           (graal/run-native-image {:graal-native-image graal-native-image
+                                   :target-path target-path
                                    :target-exe target-exe
                                    :classpath classpath
                                    :native-image-xmx native-image-xmx
                                    :entry-class "clj_graal.test_runner"})))
       (status/line :head "Native image built")
-      (status/line :detail "built: %s, %d bytes" target-exe (.length (io/file target-exe)))
+      (status/line :detail "built: %s, %d bytes" full-target-exe (.length (io/file full-target-exe)))
       (status/line :head "Running tests natively")
-      (shell/command target-exe)))
+      (shell/command full-target-exe)))
   nil)
 
 (main/when-invoked-as-script

script/test_native_sci.clj

@@ -31,25 +31,28 @@
   (when (main/doc-arg-opt args)
     (let [native-image-xmx "6g"
           graal-reflection-fname "target/native-image/reflection.json"
-          target-exe "target/sci-test-rewrite-clj"]
+          target-path "target"
+          target-exe "sci-test-rewrite-clj"
+          full-target-exe (str (io/file target-path target-exe))]
       (status/line :head "Creating native image for testing via sci")
       (status/line :detail "java -version")
       (shell/command "java -version")
       (status/line :detail (str "\nnative-image max memory: " native-image-xmx))
       (let [graal-native-image (graal/find-graal-native-image)]
         (graal/clean)
         (expose-api-to-sci)
-        (let [classpath (graal/compute-classpath "sci-test")]
+        (let [classpath (graal/compute-classpath "graal:sci-test")]
           (graal/aot-compile-sources classpath "sci-test.main")
           (generate-reflection-file graal-reflection-fname)
           (graal/run-native-image {:graal-native-image graal-native-image
                                    :graal-reflection-fname graal-reflection-fname
+                                   :target-path target-path
                                    :target-exe target-exe
                                    :classpath classpath
                                    :native-image-xmx native-image-xmx
                                    :entry-class "sci_test.main"})))
       (status/line :head "build done")
-      (status/line :detail "built: %s, %d bytes" target-exe (.length (io/file target-exe)))
+      (status/line :detail "built: %s, %d bytes" full-target-exe (.length (io/file full-target-exe)))
       (interpret-tests)))
   nil)