Add container support for executable bundles

Author: dominikmascherbauer

substratevm/src/com.oracle.svm.driver.launcher/src/com/oracle/svm/driver/launcher/BundleLauncher.java

@@ -47,6 +47,8 @@
 import java.util.jar.JarFile;
 import java.util.stream.Stream;
 
+import static com.oracle.svm.driver.launcher.ContainerSupport.CONTAINER_GRAAL_VM_HOME;
+
 
 public class BundleLauncher {
 
@@ -63,6 +65,9 @@ public class BundleLauncher {
     public static final String IMAGE_PATH_OUTPUT_DIR_NAME = "default";
     public static final String AUXILIARY_OUTPUT_DIR_NAME = "other";
 
+    private static Path rootDir;
+    private static Path inputDir;
+    private static Path outputDir;
     private static Path stageDir;
     private static Path classPathDir;
     private static Path modulePathDir;
@@ -76,6 +81,8 @@ public class BundleLauncher {
 
     public static boolean verbose = false;
 
+    public static ContainerSupport containerSupport;
+
 
     public static void main(String[] args) {
         bundleFilePath = Paths.get(BundleLauncher.class.getProtectionDomain().getCodeSource().getLocation().getPath());
@@ -93,16 +100,32 @@ public static void main(String[] args) {
         ProcessBuilder pb = new ProcessBuilder(command);
 
         Path environmentFile = stageDir.resolve("environment.json");
+        Map<String, String> launcherEnvironment = new HashMap<>();
         if (Files.isReadable(environmentFile)) {
             try (Reader reader = Files.newBufferedReader(environmentFile)) {
-                Map<String, String> launcherEnvironment = new HashMap<>();
                 new BundleEnvironmentParser(launcherEnvironment).parseAndRegister(reader);
                 pb.environment().putAll(launcherEnvironment);
             } catch (IOException e) {
                 throw new RuntimeException("Failed to read bundle-file " + environmentFile, e);
             }
         }
 
+        if (useContainer()) {
+            Path javaHome = getJavaExecutable().getParent().getParent();
+            ContainerSupport.replaceContainerPaths(command, javaHome, rootDir);
+
+            // TODO also mount agentDir if necessary
+
+            Map<Path, ContainerSupport.TargetPath> mountMapping = new HashMap<>();
+            Path containerRoot = Paths.get("/");
+            mountMapping.put(javaHome, new ContainerSupport.TargetPath(containerRoot.resolve(CONTAINER_GRAAL_VM_HOME),true));
+            mountMapping.put(inputDir, new ContainerSupport.TargetPath(containerRoot.resolve(INPUT_DIR_NAME),true));
+            mountMapping.put(outputDir, new ContainerSupport.TargetPath(containerRoot.resolve(OUTPUT_DIR_NAME),false));
+
+            containerSupport.initializeContainerImage();
+            command.addAll(0, containerSupport.createContainerCommand(launcherEnvironment, mountMapping));
+        }
+
         if (verbose) {
             List<String> environmentList = pb.environment()
                     .entrySet()
@@ -136,6 +159,10 @@ public static void main(String[] args) {
         System.exit(exitCode);
     }
 
+    public static boolean useContainer() {
+        return containerSupport != null;
+    }
+
     private static List<String> createLaunchCommand(String[] args) {
         List<String> command = new ArrayList<>();
 
@@ -247,13 +274,43 @@ private static List<String> parseBundleLauncherArgs(String[] args, List<String>
                 } catch (IOException e) {
                     System.out.println("Failed to create native image agent output dir");
                 }
-            } else if (arg.equals("--verbose")) {
-                verbose = true;
-            } else if (arg.equals("--")) {
-                applicationArgs.addAll(argQueue);
-                argQueue.clear();
+            } else if (arg.startsWith("--container")) {
+                if (useContainer()) {
+                    throw new RuntimeException("native-image bundle allows option container to be specified only once.");
+                }
+                Path dockerfile;
+                if (arg.indexOf(',') != -1) {
+                    String option = arg.substring(arg.indexOf(',') + 1);
+                    arg = arg.substring(0, arg.indexOf(','));
+
+                    if (option.startsWith("dockerfile")) {
+                        if (option.indexOf('=') != -1) {
+                            dockerfile = Paths.get(option.substring(option.indexOf('=') + 1));
+                            if (!Files.isReadable(dockerfile)) {
+                                throw new Error(String.format("Dockerfile '%s' is not readable", dockerfile.toAbsolutePath()));
+                            }
+                        } else {
+                            throw new Error("container option dockerfile requires a dockerfile argument. E.g. dockerfile=path/to/Dockerfile.");
+                        }
+                    } else {
+                        throw new Error(String.format("Unknown option %s. Valid option is: dockerfile=path/to/Dockerfile.", option));
+                    }
+                } else {
+                    dockerfile = stageDir.resolve("Dockerfile");
+                }
+                containerSupport = new ContainerSupport(dockerfile, stageDir);
+                if (arg.indexOf('=') != -1) {
+                    containerSupport.containerTool = arg.substring(arg.indexOf('=') + 1);
+                }
             } else {
-                applicationArgs.add(arg);
+                switch (arg) {
+                    case "--verbose" -> verbose = true;
+                    case "--" -> {
+                        applicationArgs.addAll(argQueue);
+                        argQueue.clear();
+                    }
+                    default -> applicationArgs.add(arg);
+                }
             }
         }
 
@@ -334,9 +391,8 @@ private static void deleteAllFiles(Path toDelete) {
     }
 
     private static void unpackBundle(Path bundleFilePath) {
-        Path inputDir;
         try {
-            Path rootDir = createBundleRootDir();
+            rootDir = createBundleRootDir();
             inputDir = rootDir.resolve(INPUT_DIR_NAME);
 
             try (JarFile archive = new JarFile(bundleFilePath.toFile())) {
@@ -369,6 +425,7 @@ private static void unpackBundle(Path bundleFilePath) {
             Path classesDir = inputDir.resolve(CLASSES_DIR_NAME);
             classPathDir = Files.createDirectories(classesDir.resolve(CLASSPATH_DIR_NAME));
             modulePathDir = Files.createDirectories(classesDir.resolve(MODULE_PATH_DIR_NAME));
+            outputDir = Files.createDirectories(rootDir.resolve(OUTPUT_DIR_NAME));
         } catch (IOException e) {
             throw new RuntimeException("Unable to create bundle directory layout", e);
         }

substratevm/src/com.oracle.svm.driver.launcher/src/com/oracle/svm/driver/launcher/BundleLauncherUtil.java

@@ -0,0 +1,65 @@
+/*
+ * Copyright (c) 2023, 2023, Oracle and/or its affiliates. All rights reserved.
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * This code is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License version 2 only, as
+ * published by the Free Software Foundation.  Oracle designates this
+ * particular file as subject to the "Classpath" exception as provided
+ * by Oracle in the LICENSE file that accompanied this code.
+ *
+ * This code is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
+ * version 2 for more details (a copy is included in the LICENSE file that
+ * accompanied this code).
+ *
+ * You should have received a copy of the GNU General Public License version
+ * 2 along with this work; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
+ * or visit www.oracle.com if you need additional information or have any
+ * questions.
+ */
+package com.oracle.svm.driver.launcher;
+
+import java.nio.charset.StandardCharsets;
+import java.security.MessageDigest;
+import java.security.NoSuchAlgorithmException;
+import java.util.regex.Matcher;
+import java.util.regex.Pattern;
+
+public class BundleLauncherUtil {
+
+    private static final char[] HEX = "0123456789abcdef".toCharArray();
+    public static String digest(String value) {
+        try {
+            MessageDigest md = MessageDigest.getInstance("SHA-1");
+            md.update(value.getBytes(StandardCharsets.UTF_8));
+            return toHex(md.digest());
+        } catch (NoSuchAlgorithmException ex) {
+            throw new Error(ex);
+        }
+    }
+    public static String toHex(byte[] data) {
+        StringBuilder r = new StringBuilder(data.length * 2);
+        for (byte b : data) {
+            r.append(HEX[(b >> 4) & 0xf]);
+            r.append(HEX[b & 0xf]);
+        }
+        return r.toString();
+    }
+
+    private static final Pattern SAFE_SHELL_ARG = Pattern.compile("[A-Za-z0-9@%_\\-+=:,./]+");
+    public static String quoteShellArg(String arg) {
+        if (arg.isEmpty()) {
+            return "''";
+        }
+        Matcher m = SAFE_SHELL_ARG.matcher(arg);
+        if (m.matches()) {
+            return arg;
+        }
+        return "'" + arg.replace("'", "'\"'\"'") + "'";
+    }
+}