[GR-44985] Extract breakdown providers from ProgressReporter.

PullRequest: graal/15130

Author: fniephaus

docs/reference-manual/native-image/BuildOutput.md

@@ -200,7 +200,8 @@ The total size of all `byte[]` objects that are neither used for `java.lang.Stri
 Therefore, this can also include `byte[]` objects from application code.
 
 ##### <a name="glossary-embedded-resources"></a>Embedded Resources Stored in `byte[]`
-The total size of all `byte[]` objects used for storing resources (for example, files accessed via `Class.getResource()`) within the native binary. The number of resources is shown in the [Heap](#glossary-image-heap) section.
+The total size of all `byte[]` objects used for storing resources (for example, files accessed via `Class.getResource()`) within the native binary.
+The number of resources is shown in the [Heap](#glossary-image-heap) section.
 
 ##### <a name="glossary-code-metadata"></a>Code Metadata Stored in `byte[]`
 The total size of all `byte[]` objects used for metadata for the [code area](#glossary-code-area).
@@ -215,6 +216,11 @@ The total size of all `byte[]` objects used for graph encodings.
 These encodings are a result of [runtime compiled methods](#glossary-runtime-methods).
 Therefore, reducing the number of such methods also reduces the size of corresponding graph encodings.
 
+##### <a name="glossary-heap-alignment"></a>Heap Alignment
+Additional space reserved to align the heap for the [selected garbage collector](#glossary-gc).
+The heap alignment may also contain GC-specific data structures.
+Its size can therefore only be influenced by switching to a different garbage collector.
+
 #### <a name="glossary-debug-info"></a>Debug Info
 The total size of generated debug information (if enabled).
 

substratevm/src/com.oracle.svm.core/src/com/oracle/svm/core/code/ImageCodeInfo.java

@@ -24,6 +24,8 @@
  */
 package com.oracle.svm.core.code;
 
+import java.util.List;
+
 import org.graalvm.compiler.word.Word;
 import org.graalvm.nativeimage.ImageSingletons;
 import org.graalvm.nativeimage.Platform;
@@ -131,8 +133,8 @@ public HostedImageCodeInfo getHostedImageCodeInfo() {
         return hostedImageCodeInfo;
     }
 
-    public long getTotalByteArraySize() {
-        return codeInfoIndex.length + codeInfoEncodings.length + referenceMapEncoding.length + frameInfoEncodings.length;
+    public List<Integer> getTotalByteArrayLengths() {
+        return List.of(codeInfoIndex.length, codeInfoEncodings.length, referenceMapEncoding.length, frameInfoEncodings.length);
     }
 
     /**

substratevm/src/com.oracle.svm.core/src/com/oracle/svm/core/reflect/ReflectionMetadataDecoder.java

@@ -63,7 +63,7 @@ public interface ReflectionMetadataDecoder {
 
     boolean isNegative(int modifiers);
 
-    long getMetadataByteLength();
+    int getMetadataByteLength();
 
     class ElementDescriptor {
         private final Class<?> declaringClass;

substratevm/src/com.oracle.svm.core/src/com/oracle/svm/core/reflect/target/ReflectionMetadataDecoderImpl.java

@@ -245,7 +245,7 @@ public boolean isNegative(int modifiers) {
     }
 
     @Override
-    public long getMetadataByteLength() {
+    public int getMetadataByteLength() {
         return ImageSingletons.lookup(ReflectionMetadataEncoding.class).getEncoding().length;
     }
 
@@ -307,7 +307,7 @@ private static <T extends Throwable> void decodeAndThrowError(int index) throws
      *     StringIndex name
      * }
      * </pre>
-     * 
+     *
      * Negative query field encoding.
      *
      * <pre>
@@ -466,7 +466,7 @@ private static Object decodeField(UnsafeArrayTypeReader buf, Class<?> declaringC
      *     ClassIndex[] parameterTypes
      * }
      * </pre>
-     * 
+     *
      * Negative query constructor encoding.
      *
      * <pre>

substratevm/src/com.oracle.svm.graal/src/com/oracle/svm/graal/hosted/LegacyRuntimeCompilationFeature.java

@@ -81,7 +81,7 @@
 import com.oracle.svm.graal.GraalSupport;
 import com.oracle.svm.graal.meta.SubstrateMethod;
 import com.oracle.svm.hosted.FeatureImpl;
-import com.oracle.svm.hosted.ProgressReporter;
+import com.oracle.svm.hosted.HeapBreakdownProvider;
 import com.oracle.svm.hosted.code.DeoptimizationUtils;
 import com.oracle.svm.hosted.code.SubstrateCompilationDirectives;
 import com.oracle.svm.hosted.meta.HostedMethod;
@@ -489,7 +489,7 @@ public void beforeCompilation(BeforeCompilationAccess c) {
             }
         }
 
-        ProgressReporter.singleton().setGraphEncodingByteLength(graphEncoder.getEncoding().length);
+        HeapBreakdownProvider.singleton().setGraphEncodingByteLength(graphEncoder.getEncoding().length);
         GraalSupport.setGraphEncoding(config, graphEncoder.getEncoding(), graphEncoder.getObjects(), graphEncoder.getNodeClasses());
 
         objectReplacer.setMethodsImplementations();

substratevm/src/com.oracle.svm.graal/src/com/oracle/svm/graal/hosted/ParseOnceRuntimeCompilationFeature.java

@@ -109,7 +109,7 @@
 import com.oracle.svm.graal.GraalSupport;
 import com.oracle.svm.graal.meta.SubstrateMethod;
 import com.oracle.svm.hosted.FeatureImpl;
-import com.oracle.svm.hosted.ProgressReporter;
+import com.oracle.svm.hosted.HeapBreakdownProvider;
 import com.oracle.svm.hosted.RuntimeCompilationSupport;
 import com.oracle.svm.hosted.SVMHost;
 import com.oracle.svm.hosted.analysis.SVMParsingSupport;
@@ -630,7 +630,7 @@ private void encodeRuntimeCompiledMethods() {
             }
         }
 
-        ProgressReporter.singleton().setGraphEncodingByteLength(graphEncoder.getEncoding().length);
+        HeapBreakdownProvider.singleton().setGraphEncodingByteLength(graphEncoder.getEncoding().length);
         GraalSupport.setGraphEncoding(null, graphEncoder.getEncoding(), graphEncoder.getObjects(), graphEncoder.getNodeClasses());
 
         objectReplacer.setMethodsImplementations();

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

@@ -0,0 +1,87 @@
+/*
+ * 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.hosted;
+
+import java.security.CodeSource;
+import java.util.Collection;
+import java.util.Collections;
+import java.util.HashMap;
+import java.util.Map;
+
+import org.graalvm.nativeimage.ImageSingletons;
+
+import com.oracle.svm.hosted.code.CompileQueue.CompileTask;
+import com.oracle.svm.hosted.meta.HostedMethod;
+
+class CodeBreakdownProvider {
+    private final Map<String, Long> codeBreakdown;
+
+    CodeBreakdownProvider(Collection<CompileTask> compilationTasks) {
+        Map<String, Long> nameToSizeMap = new HashMap<>();
+        for (CompileTask task : compilationTasks) {
+            String key = null;
+            Class<?> javaClass = task.method.getDeclaringClass().getJavaClass();
+            Module module = javaClass.getModule();
+            if (module.isNamed()) {
+                key = module.getName();
+                if ("org.graalvm.nativeimage.builder".equals(key)) {
+                    key = "svm.jar (Native Image)";
+                }
+            } else {
+                key = findJARFile(javaClass);
+                if (key == null) {
+                    key = findPackageOrClassName(task.method);
+                }
+            }
+            nameToSizeMap.merge(key, (long) task.result.getTargetCodeSize(), Long::sum);
+        }
+        codeBreakdown = Collections.unmodifiableMap(nameToSizeMap);
+    }
+
+    public static Map<String, Long> get() {
+        return ImageSingletons.lookup(CodeBreakdownProvider.class).codeBreakdown;
+    }
+
+    private static String findJARFile(Class<?> javaClass) {
+        CodeSource codeSource = javaClass.getProtectionDomain().getCodeSource();
+        if (codeSource != null && codeSource.getLocation() != null) {
+            String path = codeSource.getLocation().getPath();
+            if (path.endsWith(".jar")) {
+                // Use String API to determine basename of path to handle both / and \.
+                return path.substring(Math.max(path.lastIndexOf('/') + 1, path.lastIndexOf('\\') + 1));
+            }
+        }
+        return null;
+    }
+
+    private static String findPackageOrClassName(HostedMethod method) {
+        String qualifier = method.format("%H");
+        int lastDotIndex = qualifier.lastIndexOf('.');
+        if (lastDotIndex > 0) {
+            qualifier = qualifier.substring(0, lastDotIndex);
+        }
+        return qualifier;
+    }
+}