track the size of files added to a Bundle

Author: wirthi

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

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2022, 2023, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2022, 2025, 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
@@ -64,6 +64,7 @@
 import com.oracle.svm.driver.launcher.configuration.BundleArgsParser;
 import com.oracle.svm.driver.launcher.configuration.BundleEnvironmentParser;
 import com.oracle.svm.driver.launcher.configuration.BundlePathMapParser;
+import com.oracle.svm.hosted.ByteFormattingUtil;
 import com.oracle.svm.util.ClassUtil;
 import com.oracle.svm.util.LogUtils;
 import com.oracle.svm.util.StringUtil;
@@ -112,12 +113,27 @@ final class BundleSupport {
     private static final String DRY_RUN_OPTION = "dry-run";
     private static final String CONTAINER_OPTION = "container";
     private static final String DOCKERFILE_OPTION = "dockerfile";
+    private static final String SIZE_WARNING_FILE_LIMIT_OPTION = "size-warning-file-limit";
+    private static final String SIZE_WARNING_TOTAL_LIMIT_OPTION = "size-warning-total-limit";
     static final String BUNDLE_FILE_EXTENSION = ".nib";
     static final String BUNDLE_ALIAS = "<BUNDLE>";
 
     ContainerSupport containerSupport;
     boolean useContainer;
 
+    private long fileSizeWarningFileLimit = 1024 * 1024 * 50; // 50 MB
+    private long fileSizeWarningTotalLimit = 1024 * 1024 * 500; // 500 MB
+
+    /**
+     * Counter for all the files addd to a bundle (except .nil), to print warnings.
+     */
+    private long cumulativeFileSize = 0;
+
+    /**
+     * Tracks whether a layers file (.nil) is part of the bundle.
+     */
+    private boolean nilFileSeen = false;
+
     private static final String DEFAULT_DOCKERFILE = getDockerfile("Dockerfile");
 
     private static String getDockerfile(String name) {
@@ -249,10 +265,31 @@ private void processExtendedOption(ExtendedOption option) {
                     throw NativeImage.showError(String.format("native-image option %s requires a dockerfile argument. E.g. %s=path/to/Dockerfile.", option.key(), option.key()));
                 }
             }
+            case SIZE_WARNING_FILE_LIMIT_OPTION -> {
+                fileSizeWarningFileLimit = readSizeLimit(option.key(), option.value());
+            }
+            case SIZE_WARNING_TOTAL_LIMIT_OPTION -> {
+                fileSizeWarningTotalLimit = readSizeLimit(option.key(), option.value());
+            }
             default -> throw NativeImage.showError(String.format("Unknown option %s. Use --help-extra for usage instructions.", option.key()));
         }
     }
 
+    private long readSizeLimit(String optionKey, String optionValue) {
+        if (optionValue != null) {
+            try {
+                long limit = Long.parseLong(optionValue);
+                if (limit >= 0) {
+                    return limit * 1024 * 1024;
+                } else if (limit == -1) {
+                    return -1; // no limit
+                }
+            } catch (NumberFormatException ex) {
+            }
+        }
+        throw NativeImage.showError(String.format("native-image option %s requires a size in MiB, or -1 to deactivate.", optionKey));
+    }
+
     private BundleSupport(NativeImage nativeImage) {
         Objects.requireNonNull(nativeImage);
         this.nativeImage = nativeImage;
@@ -556,12 +593,50 @@ private void copyFile(Path sourceFile, Path target, boolean overwrite) {
                 return;
             }
             CopyOption[] options = overwrite ? new CopyOption[]{StandardCopyOption.REPLACE_EXISTING} : new CopyOption[0];
+            if (warnSize()) {
+                trackFileSize(sourceFile);
+            }
             Files.copy(sourceFile, target, options);
         } catch (IOException e) {
             throw NativeImage.showError("Failed to copy " + sourceFile + " to " + target, e);
         }
     }
 
+    /**
+     * Tracks the size of a file added to a bundle. Prints a log warning if the individual size
+     * exceeds a certain limit. Also prints a warning when the cumulative size of all files added so
+     * far exceed a limit, and repeats that at every multiple of that limit (maximum once per file).
+     *
+     * Layers files (.nil) are ignored for individual warnings and don't contribute to the
+     * cumulative limit.
+     *
+     * @param file the file to track the size of
+     * @throws IOException
+     */
+    private void trackFileSize(Path file) throws IOException {
+        if (!warnSize()) {
+            return;
+        }
+        if (file.getFileName().endsWith(".nil")) {
+            nilFileSeen = true;
+        }
+        long fileSize = Files.size(file);
+        if (fileSizeWarningFileLimit >= 0 && fileSize > fileSizeWarningFileLimit) {
+            LogUtils.warning(file + " adds " + ByteFormattingUtil.bytesToHuman(fileSize) + " to the Native Image bundle.");
+        }
+        if (fileSizeWarningTotalLimit >= 0) {
+            long nextLimitMultiple = cumulativeFileSize + fileSizeWarningTotalLimit - (cumulativeFileSize % fileSizeWarningTotalLimit);
+            cumulativeFileSize += fileSize;
+            if (cumulativeFileSize > nextLimitMultiple) {
+                LogUtils.warning("Native Image bundle has grown to " + ByteFormattingUtil.bytesToHuman(cumulativeFileSize) + (nilFileSeen ? " (excluding .nil files)." : "."));
+            }
+        }
+    }
+
+    private boolean warnSize() {
+        return fileSizeWarningFileLimit >= 0 || fileSizeWarningTotalLimit >= 0;
+    }
+
     void complete() {
         boolean writeOutput;
         try (Stream<Path> pathOutputFiles = Files.list(imagePathOutputDir); Stream<Path> auxiliaryOutputFiles = Files.list(auxiliaryOutputDir)) {

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

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2022, 2022, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2022, 2024, 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
@@ -134,6 +134,10 @@ private boolean consume(ArgumentQueue args, String headArg) {
         }
 
         if (headArg.startsWith(BundleSupport.BUNDLE_OPTION)) {
+            // warning should be early, before any other output of the feature
+            if (nativeImage.bundleSupport == null) {
+                LogUtils.warning("Native Image Bundles are an experimental feature.");
+            }
             nativeImage.bundleSupport = BundleSupport.create(nativeImage, args.poll(), args);
             return true;
         }

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

@@ -1732,10 +1732,6 @@ protected int buildImage(List<String> javaArgs, LinkedHashSet<Path> cp, LinkedHa
             arguments.addAll(strings);
         }
 
-        if (useBundle()) {
-            LogUtils.warning("Native Image Bundles are an experimental feature.");
-        }
-
         BiFunction<Path, BundleMember.Role, Path> substituteAuxiliaryPath = useBundle() ? bundleSupport::substituteAuxiliaryPath : (a, b) -> a;
         Function<String, String> imageArgsTransformer = rawArg -> apiOptionHandler.transformBuilderArgument(rawArg, substituteAuxiliaryPath);
         List<String> finalImageArgs = imageArgs.stream().map(imageArgsTransformer).collect(Collectors.toList());

substratevm/src/com.oracle.svm.hosted/src/com/oracle/svm/hosted/ByteFormattingUtil.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2022, 2022, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2022, 2025, 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
@@ -65,5 +65,4 @@ private static String toHuman(long value, Unit unit) {
         assert string.length() <= MAX_WIDTH || value >= 1000L * Unit.GiB.value;
         return string;
     }
-
 }