Skip to content

Commit

Permalink
[GR-27034] Making static analysis deterministic.
Browse files Browse the repository at this point in the history 
PullRequest: graal/13943
  • Loading branch information
Maja Skoko committed Apr 16, 2023
2 parents 52226e9 + 6787b6a commit e03ab4a
Show file tree
Hide file tree
Showing 6 changed files with 93 additions and 42 deletions.
4 changes: 2 additions & 2 deletions ...tevm/src/com.oracle.graal.pointsto/src/com/oracle/graal/pointsto/meta/AnalysisMethod.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -553,7 +553,7 @@ public String getName() {

@Override
public WrappedSignature getSignature() {
return getUniverse().lookup(wrapped.getSignature(), getDeclaringClass().getWrappedWithResolve());
return getUniverse().lookup(wrapped.getSignature(), wrapped.getDeclaringClass());
}

@Override
Expand Down Expand Up @@ -669,7 +669,7 @@ public ProfilingInfo getProfilingInfo(boolean includeNormal, boolean includeOSR)

@Override
public ConstantPool getConstantPool() {
return getUniverse().lookup(wrapped.getConstantPool(), getDeclaringClass().getWrappedWithResolve());
return getUniverse().lookup(wrapped.getConstantPool(), wrapped.getDeclaringClass());
}

@Override
Expand Down
15 changes: 14 additions & 1 deletion .../src/com.oracle.graal.pointsto/src/com/oracle/graal/pointsto/reports/CallTreePrinter.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,7 @@ static class MethodNodeReference implements Node {
public String format() {
return methodNode.method.format(METHOD_FORMAT) + " id-ref=" + methodNode.id;
}

}

static class MethodNode implements Node {
Expand Down Expand Up @@ -193,11 +194,16 @@ public void buildCallTree() {
}
}
}

roots.sort(methodComparator);
for (AnalysisMethod m : roots) {
methodToNode.put(m, new MethodNode(m, true));
}
/* Walk the call graph starting from the roots, do a breadth-first tree reduction. */

/*
* Walk the call graph starting from the roots (deterministically sorted), do a
* breadth-first tree reduction.
*/
ArrayDeque<MethodNode> workList = new ArrayDeque<>(methodToNode.values());

while (!workList.isEmpty()) {
Expand All @@ -210,10 +216,17 @@ public void buildCallTree() {
for (var invokeInfo : node.method.getInvokes()) {
invokeInfos.add(invokeInfo);
}

/*
* In order to have deterministic order of invokes we sort them by position and names.
* In case of Lambda names we avoid the non-deterministic hash part while sorting.
*/
invokeInfos.sort(invokeInfoComparator);

for (var invokeInfo : invokeInfos) {
processInvoke(invokeInfo, node, workList);
}

}
}

Expand Down
21 changes: 18 additions & 3 deletions ...tevm/src/com.oracle.graal.pointsto/src/com/oracle/graal/pointsto/reports/ReportUtils.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -58,12 +58,27 @@ public class ReportUtils {
static final String CHILD = "\u251c\u2500\u2500 "; // "|-- "
static final String LAST_CHILD = "\u2514\u2500\u2500 "; // "`-- "

public static final Comparator<ResolvedJavaMethod> methodComparator = Comparator.comparing(m -> m.format("%H.%n(%p)"));
public static final Comparator<ResolvedJavaMethod> methodComparator = Comparator.comparing(m -> m.format("%H.%n(%P):%R"));
static final Comparator<AnalysisField> fieldComparator = Comparator.comparing(f -> f.format("%H.%n"));
static final Comparator<InvokeInfo> invokeInfoComparator = Comparator.comparing(i -> i.getTargetMethod().format("%H.%n(%p)"));
static final Comparator<BytecodePosition> positionMethodComparator = Comparator.comparing(pos -> pos.getMethod().format("%H.%n(%p)"));
static final Comparator<InvokeInfo> invokeInfoBCIComparator = Comparator.comparing(i -> i.getPosition().getBCI());
static final Comparator<InvokeInfo> invokeInfoComparator = invokeInfoBCIComparator.thenComparing(i -> comparingMethodNames(i.getTargetMethod()));
static final Comparator<BytecodePosition> positionMethodComparator = Comparator.comparing(pos -> pos.getMethod().format("%H.%n(%P):%R"));
static final Comparator<BytecodePosition> positionComparator = positionMethodComparator.thenComparing(pos -> pos.getBCI());

/**
*
* Lambda function names are still not completely deterministic e.g. in name
* Lambda$7ad16f47b695d909/0x00000007c0b4c630.accept(java.lang.Object):void hash part is not
* deterministic yet. In order to avoid comparing based on that part, we need to eliminate hash
* part from name of lambda function. To read more about Lambda names check GH issue
* https://github.com/openjdk/jdk/pull/10024/.
*
*/
private static String comparingMethodNames(AnalysisMethod method) {
String methodName = method.format("%H.%n(%P):%R");
return methodName.contains("$$Lambda$") ? methodName.replaceAll("/[0-9a-fA-Fx]*\\.", ".") : methodName;
}

public static Path report(String description, String path, String name, String extension, Consumer<PrintWriter> reporter) {
return report(description, path, name, extension, reporter, true);
}
Expand Down
66 changes: 38 additions & 28 deletions substratevm/src/com.oracle.svm.hosted/src/com/oracle/svm/hosted/NativeImageGenerator.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@
import static org.graalvm.compiler.replacements.StandardGraphBuilderPlugins.registerInvocationPlugins;

import java.io.IOException;
import java.io.PrintWriter;
import java.lang.annotation.Annotation;
import java.lang.reflect.Method;
import java.lang.reflect.Modifier;
Expand All @@ -55,6 +56,7 @@
import java.util.concurrent.atomic.AtomicBoolean;
import java.util.function.BooleanSupplier;

import com.oracle.graal.pointsto.reports.ReportUtils;
import org.graalvm.collections.EconomicMap;
import org.graalvm.collections.EconomicSet;
import org.graalvm.collections.MapCursor;
Expand Down Expand Up @@ -1735,63 +1737,70 @@ public Map<ArtifactType, List<Path>> getBuildArtifacts() {
}

private void printTypes() {
String reportsPath = SubstrateOptions.reportsPath();
ReportUtils.report("print types", reportsPath, "universe_analysis", "txt",
writer -> printTypes(writer));
}

private void printTypes(PrintWriter writer) {

for (HostedType type : hUniverse.getTypes()) {
System.out.format("%8d %s ", type.getTypeID(), type.toJavaName(true));
writer.format("%8d %s ", type.getTypeID(), type.toJavaName(true));
if (type.getSuperclass() != null) {
System.out.format("extends %d %s ", type.getSuperclass().getTypeID(), type.getSuperclass().toJavaName(false));
writer.format("extends %d %s ", type.getSuperclass().getTypeID(), type.getSuperclass().toJavaName(false));
}
if (type.getInterfaces().length > 0) {
System.out.print("implements ");
writer.print("implements ");
String sep = "";
for (HostedInterface interf : type.getInterfaces()) {
System.out.format("%s%d %s", sep, interf.getTypeID(), interf.toJavaName(false));
writer.format("%s%d %s", sep, interf.getTypeID(), interf.toJavaName(false));
sep = ", ";
}
System.out.print(" ");
writer.print(" ");
}

if (type.getWrapped().isInstantiated()) {
System.out.print("instantiated ");
writer.print("instantiated ");
}
if (type.getWrapped().isReachable()) {
System.out.print("reachable ");
writer.print("reachable ");
}

System.out.format("type check start %d range %d slot # %d ", type.getTypeCheckStart(), type.getTypeCheckRange(), type.getTypeCheckSlot());
System.out.format("type check slots %s ", slotsToString(type.getTypeCheckSlots()));
writer.format("type check start %d range %d slot # %d ", type.getTypeCheckStart(), type.getTypeCheckRange(), type.getTypeCheckSlot());
writer.format("type check slots %s ", slotsToString(type.getTypeCheckSlots()));
// if (type.findLeafConcreteSubtype() != null) {
// System.out.format("unique %d %s ", type.findLeafConcreteSubtype().getTypeID(),
// writer.format("unique %d %s ", type.findLeafConcreteSubtype().getTypeID(),
// type.findLeafConcreteSubtype().toJavaName(false));
// }

int le = type.getHub().getLayoutEncoding();
if (LayoutEncoding.isPrimitive(le)) {
System.out.print("primitive ");
writer.print("primitive ");
} else if (LayoutEncoding.isInterface(le)) {
System.out.print("interface ");
writer.print("interface ");
} else if (LayoutEncoding.isAbstract(le)) {
System.out.print("abstract ");
writer.print("abstract ");
} else if (LayoutEncoding.isPureInstance(le)) {
System.out.format("instance size %d ", LayoutEncoding.getPureInstanceAllocationSize(le).rawValue());
writer.format("instance size %d ", LayoutEncoding.getPureInstanceAllocationSize(le).rawValue());
} else if (LayoutEncoding.isArrayLike(le)) {
String arrayType = LayoutEncoding.isHybrid(le) ? "hybrid" : "array";
String elements = LayoutEncoding.isArrayLikeWithPrimitiveElements(le) ? "primitives" : "objects";
System.out.format("%s containing %s, base %d shift %d scale %d ", arrayType, elements, LayoutEncoding.getArrayBaseOffset(le).rawValue(), LayoutEncoding.getArrayIndexShift(le),
writer.format("%s containing %s, base %d shift %d scale %d ", arrayType, elements, LayoutEncoding.getArrayBaseOffset(le).rawValue(), LayoutEncoding.getArrayIndexShift(le),
LayoutEncoding.getArrayIndexScale(le));

} else {
throw VMError.shouldNotReachHereUnexpectedInput(le); // ExcludeFromJacocoGeneratedReport
}

System.out.println();
writer.println();

for (HostedType sub : type.getSubTypes()) {
System.out.format(" s %d %s%n", sub.getTypeID(), sub.toJavaName(false));
writer.format(" s %d %s%n", sub.getTypeID(), sub.toJavaName(false));
}
if (type.isInterface()) {
for (HostedMethod method : hUniverse.getMethods()) {
if (method.getDeclaringClass().equals(type)) {
printMethod(method, -1);
printMethod(writer, method, -1);
}
}

Expand All @@ -1801,41 +1810,42 @@ private void printTypes() {
fields = Arrays.copyOf(fields, fields.length);
Arrays.sort(fields, Comparator.comparing(HostedField::toString));
for (HostedField field : fields) {
System.out.println(" f " + field.getLocation() + ": " + field.format("%T %n"));
writer.println(" f " + field.getLocation() + ": " + field.format("%T %n"));
}
HostedMethod[] vtable = type.getVTable();
for (int i = 0; i < vtable.length; i++) {
if (vtable[i] != null) {
printMethod(vtable[i], i);
printMethod(writer, vtable[i], i);
}
}
for (HostedMethod method : hUniverse.getMethods()) {
if (method.getDeclaringClass().equals(type) && !method.hasVTableIndex()) {
printMethod(method, -1);
printMethod(writer, method, -1);
}
}
}
}

}

private static void printMethod(HostedMethod method, int vtableIndex) {
private static void printMethod(PrintWriter writer, HostedMethod method, int vtableIndex) {
if (vtableIndex != -1) {
System.out.print(" v " + vtableIndex + " ");
writer.print(" v " + vtableIndex + " ");
} else {
System.out.print(" m ");
writer.print(" m ");
}
if (method.hasVTableIndex()) {
System.out.print(method.getVTableIndex() + " ");
writer.print(method.getVTableIndex() + " ");
}
System.out.print(method.format("%r %n(%p)") + ": " + method.getImplementations().length + " [");
writer.print(method.format("%r %n(%p)") + ": " + method.getImplementations().length + " [");
if (method.getImplementations().length <= 10) {
String sep = "";
for (HostedMethod impl : method.getImplementations()) {
System.out.print(sep + impl.getDeclaringClass().toJavaName(false));
writer.print(sep + impl.getDeclaringClass().toJavaName(false));
sep = ", ";
}
}
System.out.println("]");
writer.println("]");
}

private static String slotsToString(short[] slots) {
Expand Down
21 changes: 16 additions & 5 deletions ...atevm/src/com.oracle.svm.hosted/src/com/oracle/svm/hosted/image/NativeImageCodeCache.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@
import static com.oracle.svm.core.util.VMError.shouldNotReachHere;
import static com.oracle.svm.core.util.VMError.shouldNotReachHereUnexpectedInput;

import java.io.PrintWriter;
import java.lang.reflect.AccessibleObject;
import java.lang.reflect.Executable;
import java.lang.reflect.Field;
Expand All @@ -48,6 +49,7 @@
import java.util.concurrent.ForkJoinPool;
import java.util.stream.Collectors;

import com.oracle.graal.pointsto.reports.ReportUtils;
import org.graalvm.collections.Pair;
import org.graalvm.compiler.api.replacements.SnippetReflectionProvider;
import org.graalvm.compiler.code.CompilationResult;
Expand Down Expand Up @@ -165,7 +167,8 @@ public Pair<HostedMethod, CompilationResult> getLastCompilation() {
}

protected List<Pair<HostedMethod, CompilationResult>> computeCompilationOrder(Map<HostedMethod, CompilationResult> compilationMap) {
return compilationMap.entrySet().stream().map(e -> Pair.create(e.getKey(), e.getValue())).collect(Collectors.toList());
return compilationMap.entrySet().stream().map(e -> Pair.create(e.getKey(), e.getValue())).sorted(Comparator.comparing(o -> o.getLeft().wrapped.format("%H.%n(%P):%R")))
.collect(Collectors.toList());
}

public List<Pair<HostedMethod, CompilationResult>> getOrderedCompilations() {
Expand Down Expand Up @@ -587,24 +590,32 @@ public Path[] getCCInputFiles(Path tempDirectory, String imageName) {
public abstract List<ObjectFile.Symbol> getSymbols(ObjectFile objectFile);

public void printCompilationResults() {
System.out.println("--- compiled methods");
String reportsPath = SubstrateOptions.reportsPath();
ReportUtils.report("compilation results", reportsPath, "universe_compilation", "txt",
writer -> printCompilationResults(writer));
}

private void printCompilationResults(PrintWriter writer) {

writer.println("--- compiled methods");
for (Pair<HostedMethod, CompilationResult> pair : getOrderedCompilations()) {
HostedMethod method = pair.getLeft();
CompilationResult result = pair.getRight();
System.out.format("%8d %5d %s: frame %d%n", method.getCodeAddressOffset(), result.getTargetCodeSize(), method.format("%H.%n(%p)"), result.getTotalFrameSize());
writer.format("%8d %5d %s: frame %d%n", method.getCodeAddressOffset(), result.getTargetCodeSize(), method.format("%H.%n(%p)"), result.getTotalFrameSize());
}
System.out.println("--- vtables:");
writer.println("--- vtables:");
for (HostedType type : imageHeap.getUniverse().getTypes()) {
for (int i = 0; i < type.getVTable().length; i++) {
HostedMethod method = type.getVTable()[i];
if (method != null) {
CompilationResult comp = compilationResultFor(type.getVTable()[i]);
if (comp != null) {
System.out.format("%d %s @ %d: %s = 0x%x%n", type.getTypeID(), type.toJavaName(false), i, method.format("%r %n(%p)"), method.getCodeAddressOffset());
writer.format("%d %s @ %d: %s = 0x%x%n", type.getTypeID(), type.toJavaName(false), i, method.format("%r %n(%p)"), method.getCodeAddressOffset());
}
}
}
}

}

private static class HostedFrameInfoCustomization extends FrameInfoEncoder.SourceFieldsFromMethod {
Expand Down
8 changes: 5 additions & 3 deletions substratevm/src/com.oracle.svm.hosted/src/com/oracle/svm/hosted/meta/TypeCheckBuilder.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -174,7 +174,8 @@ private static short getShortValue(int intValue) {

/**
* Calculating a sorted list based on the height of each node. This allows one to compute many
* graph traits in one iteration of the nodes.
* graph traits in one iteration of the nodes. When height are same, elements of list are sorted
* by name.
*/
private static List<HostedType> generateHeightOrder(List<HostedType> roots, Map<HostedType, List<HostedType>> subtypeMap) {

Expand All @@ -188,8 +189,9 @@ private static List<HostedType> generateHeightOrder(List<HostedType> roots, Map<
generateHeightOrderHelper(0, root, subtypeMap, heightMap, allTypes);
}

/* Now create a sorted array from this information. */
return allTypes.stream().sorted(Comparator.comparingInt(heightMap::get)).collect(Collectors.toList());
/* Create a sorted array from this information. */
Comparator<HostedType> comparator = Comparator.<HostedType> comparingInt(heightMap::get).thenComparing(HostedUniverse.TYPE_COMPARATOR);
return allTypes.stream().sorted(comparator).collect(Collectors.toList());
}

/**
Expand Down

0 comments on commit e03ab4a

Please sign in to comment.