|
| 1 | +/* |
| 2 | + * Copyright (c) 2025, 2025, Oracle and/or its affiliates. All rights reserved. |
| 3 | + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
| 4 | + * |
| 5 | + * This code is free software; you can redistribute it and/or modify it |
| 6 | + * under the terms of the GNU General Public License version 2 only, as |
| 7 | + * published by the Free Software Foundation. Oracle designates this |
| 8 | + * particular file as subject to the "Classpath" exception as provided |
| 9 | + * by Oracle in the LICENSE file that accompanied this code. |
| 10 | + * |
| 11 | + * This code is distributed in the hope that it will be useful, but WITHOUT |
| 12 | + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
| 13 | + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
| 14 | + * version 2 for more details (a copy is included in the LICENSE file that |
| 15 | + * accompanied this code). |
| 16 | + * |
| 17 | + * You should have received a copy of the GNU General Public License version |
| 18 | + * 2 along with this work; if not, write to the Free Software Foundation, |
| 19 | + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
| 20 | + * |
| 21 | + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
| 22 | + * or visit www.oracle.com if you need additional information or have any |
| 23 | + * questions. |
| 24 | + */ |
| 25 | +package com.oracle.svm.hosted; |
| 26 | + |
| 27 | +import com.oracle.svm.core.BuildArtifacts; |
| 28 | +import com.oracle.svm.core.feature.AutomaticallyRegisteredFeature; |
| 29 | +import com.oracle.svm.core.feature.InternalFeature; |
| 30 | +import com.oracle.svm.core.option.AccumulatingLocatableMultiOptionValue; |
| 31 | +import com.oracle.svm.core.option.HostedOptionKey; |
| 32 | +import com.oracle.svm.core.option.HostedOptionValues; |
| 33 | +import com.oracle.svm.core.util.UserError; |
| 34 | +import com.oracle.svm.hosted.phases.DynamicAccessDetectionPhase; |
| 35 | +import jdk.graal.compiler.options.Option; |
| 36 | +import jdk.graal.compiler.util.json.JsonBuilder; |
| 37 | +import jdk.graal.compiler.util.json.JsonPrettyWriter; |
| 38 | +import jdk.vm.ci.meta.ResolvedJavaMethod; |
| 39 | +import org.graalvm.nativeimage.ImageSingletons; |
| 40 | + |
| 41 | +import java.io.IOException; |
| 42 | +import java.nio.file.Files; |
| 43 | +import java.nio.file.NoSuchFileException; |
| 44 | +import java.nio.file.Path; |
| 45 | +import java.util.ArrayList; |
| 46 | +import java.util.Locale; |
| 47 | +import java.util.Objects; |
| 48 | +import java.util.Set; |
| 49 | +import java.util.TreeMap; |
| 50 | +import java.util.List; |
| 51 | +import java.util.Map; |
| 52 | +import java.util.concurrent.ConcurrentHashMap; |
| 53 | +import java.util.concurrent.ConcurrentSkipListMap; |
| 54 | + |
| 55 | +/** |
| 56 | + * This is a support class that keeps track of dynamic access calls requiring metadata usage |
| 57 | + * detected during {@link DynamicAccessDetectionPhase} and outputs them to the image-build output. |
| 58 | + */ |
| 59 | +@AutomaticallyRegisteredFeature |
| 60 | +public final class DynamicAccessDetectionFeature implements InternalFeature { |
| 61 | + |
| 62 | + public static class Options { |
| 63 | + @Option(help = "Output all metadata requiring dynamic access call usages in the reached parts of the project, limited to the provided comma-separated list of class path or module path entries.")// |
| 64 | + public static final HostedOptionKey<AccumulatingLocatableMultiOptionValue.Strings> TrackDynamicAccess = new HostedOptionKey<>( |
| 65 | + AccumulatingLocatableMultiOptionValue.Strings.buildWithCommaDelimiter()); |
| 66 | + } |
| 67 | + |
| 68 | + private record MethodsByType(Map<String, CallLocationsByMethod> methodsByType) { |
| 69 | + MethodsByType() { |
| 70 | + this(new TreeMap<>()); |
| 71 | + } |
| 72 | + |
| 73 | + public Set<String> getMethodTypes() { |
| 74 | + return methodsByType.keySet(); |
| 75 | + } |
| 76 | + |
| 77 | + public CallLocationsByMethod getCallLocationsByMethod(String methodType) { |
| 78 | + return methodsByType.getOrDefault(methodType, new CallLocationsByMethod()); |
| 79 | + } |
| 80 | + } |
| 81 | + |
| 82 | + private record CallLocationsByMethod(Map<String, List<String>> callLocationsByMethod) { |
| 83 | + CallLocationsByMethod() { |
| 84 | + this(new TreeMap<>()); |
| 85 | + } |
| 86 | + |
| 87 | + public Set<String> getMethods() { |
| 88 | + return callLocationsByMethod.keySet(); |
| 89 | + } |
| 90 | + |
| 91 | + public List<String> getMethodCallLocations(String methodName) { |
| 92 | + return callLocationsByMethod.getOrDefault(methodName, new ArrayList<>()); |
| 93 | + } |
| 94 | + } |
| 95 | + |
| 96 | + private static final String OUTPUT_DIR_NAME = "dynamic-access"; |
| 97 | + |
| 98 | + private final Set<String> pathEntries; // Class or module path entries |
| 99 | + private final Map<String, MethodsByType> callsByPathEntry; |
| 100 | + private final Set<FoldEntry> foldEntries = ConcurrentHashMap.newKeySet(); |
| 101 | + |
| 102 | + public DynamicAccessDetectionFeature() { |
| 103 | + this.callsByPathEntry = new ConcurrentSkipListMap<>(); |
| 104 | + this.pathEntries = Set.copyOf(Options.TrackDynamicAccess.getValue().values().stream().map(entry -> { |
| 105 | + if (entry.endsWith("/")) { |
| 106 | + return entry.substring(0, entry.length() - 1); |
| 107 | + } |
| 108 | + return entry; |
| 109 | + }).toList()); |
| 110 | + } |
| 111 | + |
| 112 | + public static DynamicAccessDetectionFeature instance() { |
| 113 | + return ImageSingletons.lookup(DynamicAccessDetectionFeature.class); |
| 114 | + } |
| 115 | + |
| 116 | + public void addCall(String entry, String methodType, String call, String callLocation) { |
| 117 | + MethodsByType entryContent = this.callsByPathEntry.computeIfAbsent(entry, k -> new MethodsByType()); |
| 118 | + CallLocationsByMethod methodCallLocations = entryContent.methodsByType().computeIfAbsent(methodType, k -> new CallLocationsByMethod()); |
| 119 | + List<String> callLocations = methodCallLocations.callLocationsByMethod().computeIfAbsent(call, k -> new ArrayList<>()); |
| 120 | + callLocations.add(callLocation); |
| 121 | + } |
| 122 | + |
| 123 | + public MethodsByType getMethodsByType(String entry) { |
| 124 | + return this.callsByPathEntry.getOrDefault(entry, new MethodsByType()); |
| 125 | + } |
| 126 | + |
| 127 | + public Set<String> getPathEntries() { |
| 128 | + return pathEntries; |
| 129 | + } |
| 130 | + |
| 131 | + public static String getEntryName(String path) { |
| 132 | + String fileName = path.substring(path.lastIndexOf("/") + 1); |
| 133 | + if (fileName.endsWith(".jar")) { |
| 134 | + fileName = fileName.substring(0, fileName.lastIndexOf('.')); |
| 135 | + } |
| 136 | + return fileName; |
| 137 | + } |
| 138 | + |
| 139 | + private void printReportForEntry(String entry) { |
| 140 | + System.out.println("Dynamic method usage detected in " + entry + ":"); |
| 141 | + MethodsByType methodsByType = getMethodsByType(entry); |
| 142 | + for (String methodType : methodsByType.getMethodTypes()) { |
| 143 | + System.out.println(" " + methodType.substring(0, 1).toUpperCase(Locale.ROOT) + methodType.substring(1) + " calls detected:"); |
| 144 | + CallLocationsByMethod methodCallLocations = methodsByType.getCallLocationsByMethod(methodType); |
| 145 | + for (String call : methodCallLocations.getMethods()) { |
| 146 | + System.out.println(" " + call + ":"); |
| 147 | + for (String callLocation : methodCallLocations.getMethodCallLocations(call)) { |
| 148 | + System.out.println(" at " + callLocation); |
| 149 | + } |
| 150 | + } |
| 151 | + } |
| 152 | + } |
| 153 | + |
| 154 | + public static Path getOrCreateDirectory(Path directory) throws IOException { |
| 155 | + if (Files.exists(directory)) { |
| 156 | + if (!Files.isDirectory(directory)) { |
| 157 | + throw new NoSuchFileException(directory.toString(), null, |
| 158 | + "Failed to retrieve directory: The path exists but is not a directory."); |
| 159 | + } |
| 160 | + } else { |
| 161 | + try { |
| 162 | + Files.createDirectory(directory); |
| 163 | + } catch (IOException e) { |
| 164 | + throw new IOException("Failed to create directory: " + directory, e); |
| 165 | + } |
| 166 | + } |
| 167 | + return directory; |
| 168 | + } |
| 169 | + |
| 170 | + private void dumpReportForEntry(String entry) { |
| 171 | + try { |
| 172 | + Path reportDirectory = getOrCreateDirectory(NativeImageGenerator.generatedFiles(HostedOptionValues.singleton()).resolve(OUTPUT_DIR_NAME)); |
| 173 | + MethodsByType methodsByType = getMethodsByType(entry); |
| 174 | + for (String methodType : methodsByType.getMethodTypes()) { |
| 175 | + Path entryDirectory = getOrCreateDirectory(reportDirectory.resolve(getEntryName(entry))); |
| 176 | + Path targetPath = entryDirectory.resolve(methodType + "_calls.json"); |
| 177 | + try (var writer = new JsonPrettyWriter(targetPath)) { |
| 178 | + try (JsonBuilder.ObjectBuilder dynamicAccessBuilder = writer.objectBuilder()) { |
| 179 | + for (String methodName : methodsByType.getCallLocationsByMethod(methodType).getMethods()) { |
| 180 | + try (JsonBuilder.ArrayBuilder methodCallLocationBuilder = dynamicAccessBuilder.append(methodName).array()) { |
| 181 | + for (String methodLocation : methodsByType.getCallLocationsByMethod(methodType).getMethodCallLocations(methodName)) { |
| 182 | + methodCallLocationBuilder.append(methodLocation); |
| 183 | + } |
| 184 | + } |
| 185 | + } |
| 186 | + } |
| 187 | + BuildArtifacts.singleton().add(BuildArtifacts.ArtifactType.BUILD_INFO, targetPath); |
| 188 | + } |
| 189 | + } |
| 190 | + } catch (IOException e) { |
| 191 | + UserError.abort("Failed to dump report for entry %s:", entry); |
| 192 | + } |
| 193 | + } |
| 194 | + |
| 195 | + public void reportDynamicAccess() { |
| 196 | + for (String entry : pathEntries) { |
| 197 | + if (callsByPathEntry.containsKey(entry)) { |
| 198 | + printReportForEntry(entry); |
| 199 | + dumpReportForEntry(entry); |
| 200 | + } |
| 201 | + } |
| 202 | + } |
| 203 | + |
| 204 | + /* |
| 205 | + * Support data structure used to keep track of calls which don't require metadata, but can't be |
| 206 | + * folded. |
| 207 | + */ |
| 208 | + public static class FoldEntry { |
| 209 | + private final int bci; |
| 210 | + private final ResolvedJavaMethod method; |
| 211 | + |
| 212 | + public FoldEntry(int bci, ResolvedJavaMethod method) { |
| 213 | + this.bci = bci; |
| 214 | + this.method = method; |
| 215 | + } |
| 216 | + |
| 217 | + @Override |
| 218 | + public boolean equals(Object obj) { |
| 219 | + if (this == obj) { |
| 220 | + return true; |
| 221 | + } |
| 222 | + if (obj == null || getClass() != obj.getClass()) { |
| 223 | + return false; |
| 224 | + } |
| 225 | + FoldEntry other = (FoldEntry) obj; |
| 226 | + return bci == other.bci && Objects.equals(method, other.method); |
| 227 | + } |
| 228 | + |
| 229 | + @Override |
| 230 | + public int hashCode() { |
| 231 | + return Objects.hash(bci, method); |
| 232 | + } |
| 233 | + } |
| 234 | + |
| 235 | + public void addFoldEntry(int bci, ResolvedJavaMethod method) { |
| 236 | + this.foldEntries.add(new FoldEntry(bci, method)); |
| 237 | + } |
| 238 | + |
| 239 | + /* |
| 240 | + * If a fold entry exists for the given method, the method should be ignored by the analysis |
| 241 | + * phase. |
| 242 | + */ |
| 243 | + public boolean containsFoldEntry(int bci, ResolvedJavaMethod method) { |
| 244 | + return this.foldEntries.contains(new FoldEntry(bci, method)); |
| 245 | + } |
| 246 | + |
| 247 | + @Override |
| 248 | + public void beforeCompilation(BeforeCompilationAccess access) { |
| 249 | + DynamicAccessDetectionFeature.instance().reportDynamicAccess(); |
| 250 | + } |
| 251 | +} |
0 commit comments