Properly quote arguments passed via argument files

NativeImage passes some arguments via the @file feature of the
JDK launcher. When some arguments, separated by new lines, contain
whitespace *and* aren't properly quoted, the JDK launcher code fails
to parse the argument file and the native image generator class is
never launched.

Shell-quoting arguments before writing them to an @argument file
avoids this issue. However, this is further complicated by the fact
that on Windows, argument files may contain paths including '\'.
Yet, '\' is also an escape character in argument files. Therefore,
windows path entries in argument files need to be properly escaped
as they they are also going to be quoted.

Closes #3769

Author: jerboaa

substratevm/src/com.oracle.svm.driver/src/com/oracle/svm/driver/NativeImage.java

@@ -50,6 +50,7 @@
 import java.util.Map;
 import java.util.Optional;
 import java.util.Properties;
+import java.util.StringJoiner;
 import java.util.function.BiConsumer;
 import java.util.function.BiFunction;
 import java.util.function.Consumer;
@@ -996,7 +997,7 @@ private int completeImageBuild() {
         if (config.useJavaModules()) {
             config.getBuilderModulePath().forEach(this::addImageBuilderModulePath);
             String upgradeModulePath = config.getBuilderUpgradeModulePath().stream()
-                            .map(p -> canonicalize(p).toString())
+                            .map(p -> shellPath(canonicalize(p)))
                             .collect(Collectors.joining(File.pathSeparator));
             if (!upgradeModulePath.isEmpty()) {
                 addImageBuilderJavaArgs(Arrays.asList("--upgrade-module-path", upgradeModulePath));
@@ -1005,7 +1006,7 @@ private int completeImageBuild() {
             config.getBuilderJVMCIClasspath().forEach((Consumer<? super Path>) this::addImageBuilderClasspath);
             if (!config.getBuilderJVMCIClasspathAppend().isEmpty()) {
                 String builderJavaArg = config.getBuilderJVMCIClasspathAppend()
-                                .stream().map(path -> canonicalize(path).toString())
+                                .stream().map(path -> shellPath(canonicalize(path)))
                                 .collect(Collectors.joining(File.pathSeparator, "-Djvmci.class.path.append=", ""));
                 addImageBuilderJavaArgs(builderJavaArg);
             }
@@ -1019,7 +1020,7 @@ private int completeImageBuild() {
 
         String clibrariesPath = (targetPlatform != null) ? targetPlatform : platform;
         String clibrariesBuilderArg = config.getBuilderCLibrariesPaths().stream()
-                        .map(path -> canonicalize(path.resolve(clibrariesPath)).toString())
+                        .map(path -> shellPath(canonicalize(path.resolve(clibrariesPath))))
                         .collect(Collectors.joining(",", oHCLibraryPath, ""));
         addPlainImageBuilderArg(clibrariesBuilderArg);
 
@@ -1235,7 +1236,7 @@ private List<String> getAgentArguments() {
         if (!agentOptions.isEmpty()) {
             args.add("-agentlib:native-image-diagnostics-agent=" + agentOptions);
         }
-        args.add("-javaagent:" + config.getAgentJAR().toAbsolutePath() + (agentOptions.isEmpty() ? "" : "=" + agentOptions));
+        args.add("-javaagent:" + shellPath(config.getAgentJAR()) + (agentOptions.isEmpty() ? "" : "=" + agentOptions));
         return args;
     }
 
@@ -1301,7 +1302,14 @@ protected static List<String> createImageBuilderArgs(ArrayList<String> imageArgs
     protected static String createVMInvocationArgumentFile(List<String> arguments) {
         try {
             Path argsFile = Files.createTempFile("vminvocation", ".args");
-            String joinedOptions = String.join("\n", arguments);
+            StringJoiner joiner = new StringJoiner("\n");
+            for (String arg : arguments) {
+                // Options in @argfile need to be properly quoted as
+                // this relies on the JDK's @argfile parsing when the
+                // native image generator is being launched.
+                joiner.add(SubstrateUtil.quoteShellArg(arg));
+            }
+            String joinedOptions = joiner.toString();
             Files.write(argsFile, joinedOptions.getBytes());
             argsFile.toFile().deleteOnExit();
             return "@" + argsFile;
@@ -1327,14 +1335,14 @@ protected int buildImage(List<String> javaArgs, LinkedHashSet<Path> bcp, LinkedH
         List<String> arguments = new ArrayList<>();
         arguments.addAll(javaArgs);
         if (!bcp.isEmpty()) {
-            arguments.add(bcp.stream().map(Path::toString).collect(Collectors.joining(File.pathSeparator, "-Xbootclasspath/a:", "")));
+            arguments.add(bcp.stream().map(NativeImage::shellPath).collect(Collectors.joining(File.pathSeparator, "-Xbootclasspath/a:", "")));
         }
 
         if (!cp.isEmpty()) {
-            arguments.addAll(Arrays.asList("-cp", cp.stream().map(Path::toString).collect(Collectors.joining(File.pathSeparator))));
+            arguments.addAll(Arrays.asList("-cp", cp.stream().map(NativeImage::shellPath).collect(Collectors.joining(File.pathSeparator))));
         }
         if (!mp.isEmpty()) {
-            List<String> strings = Arrays.asList("--module-path", mp.stream().map(Path::toString).collect(Collectors.joining(File.pathSeparator)));
+            List<String> strings = Arrays.asList("--module-path", mp.stream().map(NativeImage::shellPath).collect(Collectors.joining(File.pathSeparator)));
             arguments.addAll(strings);
         }
 
@@ -1399,6 +1407,17 @@ protected int buildImage(List<String> javaArgs, LinkedHashSet<Path> bcp, LinkedH
         return exitStatus;
     }
 
+    // Since path variables get used in @argumenet files and '\' is an unsafe shell
+    // character, be sure to escape backslashes in paths so they can get interpreted correctly
+    // in @argument files when they are quoted. I.e. 'C:\foo\bar' => 'C:\\foo\\bar'
+    private static String shellPath(Path path) {
+        String retval = path.toString();
+        if (OS.getCurrent() == OS.WINDOWS) {
+            return retval.replace("\\", "\\\\");
+        }
+        return retval;
+    }
+
     private static final Function<BuildConfiguration, NativeImage> defaultNativeImageProvider = config -> new NativeImage(config);
 
     public static void main(String[] args) {