Enhance MethodEntries creation and verification

Following Andrew Dinn's recommendation in
#3304 (comment), this
patch creates the necessary `MethodEntry`s for each `ClassEntry` using
the methodInfoProvider, It then sorts the methods list to ensure faster
lookups in the phase of linking `Range`s to `MethodEntry`s.

It also adds assertions to ensure that the methods list is sorted and
that there are no duplicate entries in it. Furthermore, it adds
assertions to ensure that each Range can be mapped to a MethodEntry
created by info provided through the methodInfoProvider.

Author: zakkak

substratevm/src/com.oracle.objectfile/src/com/oracle/objectfile/debugentry/ClassEntry.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2020, 2020, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2020, 2021, Oracle and/or its affiliates. All rights reserved.
  * Copyright (c) 2020, 2020, Red Hat Inc. All rights reserved.
  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
  *
@@ -135,7 +135,9 @@ public void addDebugInfo(DebugInfoBase debugInfoBase, DebugTypeInfo debugTypeInf
         /* Add details of fields and field types */
         debugInstanceTypeInfo.fieldInfoProvider().forEach(debugFieldInfo -> this.processField(debugFieldInfo, debugInfoBase, debugContext));
         /* Add details of methods and method types */
-        debugInstanceTypeInfo.methodInfoProvider().forEach(methodFieldInfo -> this.ensureMethodEntry(methodFieldInfo, debugInfoBase, debugContext));
+        debugInstanceTypeInfo.methodInfoProvider().forEach(methodFieldInfo -> this.processMethod(methodFieldInfo, debugInfoBase, debugContext));
+        /* Sort methods to improve lookup speed */
+        this.methods.sort(MethodEntry::compareTo);
     }
 
     public void indexPrimary(Range primary, List<DebugFrameSizeChange> frameSizeInfos, int frameSize) {
@@ -268,7 +270,7 @@ private void processInterface(String interfaceName, DebugInfoBase debugInfoBase,
         interfaceClassEntry.addImplementor(this, debugContext);
     }
 
-    protected MethodEntry processMethod(DebugMethodInfo debugMethodInfo, DebugInfoBase debugInfoBase, DebugContext debugContext) {
+    protected void processMethod(DebugMethodInfo debugMethodInfo, DebugInfoBase debugInfoBase, DebugContext debugContext) {
         String methodName = debugInfoBase.uniqueDebugString(debugMethodInfo.name());
         String resultTypeName = TypeEntry.canonicalize(debugMethodInfo.valueType());
         int modifiers = debugMethodInfo.modifiers();
@@ -295,7 +297,8 @@ protected MethodEntry processMethod(DebugMethodInfo debugMethodInfo, DebugInfoBa
          * substitution
          */
         FileEntry methodFileEntry = debugInfoBase.ensureFileEntry(fileName, filePath, cachePath);
-        return new MethodEntry(methodFileEntry, methodName, this, resultType, paramTypeArray, paramNameArray, modifiers, debugMethodInfo.isDeoptTarget());
+        final MethodEntry methodEntry = new MethodEntry(methodFileEntry, methodName, this, resultType, paramTypeArray, paramNameArray, modifiers, debugMethodInfo.isDeoptTarget());
+        methods.add(methodEntry);
     }
 
     @Override
@@ -345,29 +348,40 @@ public Range makePrimaryRange(String symbolName, StringTable stringTable, Method
         return new Range(symbolName, stringTable, method, fileEntryToUse, lo, hi, primaryLine);
     }
 
-    public MethodEntry ensureMethodEntry(DebugMethodInfo debugMethodInfo, DebugInfoBase debugInfoBase, DebugContext debugContext) {
+    public MethodEntry getMethodEntry(DebugMethodInfo debugMethodInfo, DebugInfoBase debugInfoBase) {
+        assert listIsSorted(methods);
         String methodName = debugInfoBase.uniqueDebugString(debugMethodInfo.name());
         String paramSignature = debugMethodInfo.paramSignature();
         String returnTypeName = debugMethodInfo.valueType();
         final ListIterator<MethodEntry> methodIterator = methods.listIterator();
-        while (true) {
-            if (!methodIterator.hasNext()) {
-                return addMethodEntry(methodIterator, debugMethodInfo, debugInfoBase, debugContext);
-            }
+        while (methodIterator.hasNext()) {
             final MethodEntry methodEntry = methodIterator.next();
             final int comparisonResult = methodEntry.compareTo(methodName, paramSignature, returnTypeName);
             if (comparisonResult == 0) {
                 return methodEntry;
-            } else if (comparisonResult > 0) {
-                methodIterator.previous();
-                return addMethodEntry(methodIterator, debugMethodInfo, debugInfoBase, debugContext);
             }
+            assert comparisonResult < 0 : "Method " + returnTypeName + " " + methodName + "(" + paramSignature + ") not found in CLassEntry of " + getTypeName();
         }
+        assert false : "Method " + returnTypeName + " " + methodName + "(" + paramSignature + ") not found in CLassEntry of " + getTypeName();
+        return null;
     }
 
-    private MethodEntry addMethodEntry(ListIterator<MethodEntry> methodIterator, DebugMethodInfo debugMethodInfo, DebugInfoBase debugInfoBase, DebugContext debugContext) {
-        MethodEntry newMethodEntry = processMethod(debugMethodInfo, debugInfoBase, debugContext);
-        methodIterator.add(newMethodEntry);
-        return newMethodEntry;
+    private boolean listIsSorted(List<MethodEntry> list) {
+        ListIterator<MethodEntry> iterator = list.listIterator();
+        if (!iterator.hasNext()) {
+            return true;
+        }
+        MethodEntry current = iterator.next();
+        MethodEntry previous;
+        while (iterator.hasNext()) {
+            previous = current;
+            current = iterator.next();
+            final int result = previous.compareTo(current);
+            assert result != 0 : "Method " + current.valueType.getTypeName() + " " + current.methodName() + "(" + current.paramTypes.toString() + ") found twice in CLassEntry of " + getTypeName();
+            if (result >= 0) {
+                return false;
+            }
+        }
+        return true;
     }
 }

substratevm/src/com.oracle.objectfile/src/com/oracle/objectfile/debugentry/DebugInfoBase.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2020, 2020, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2020, 2021, Oracle and/or its affiliates. All rights reserved.
  * Copyright (c) 2020, 2020, Red Hat Inc. All rights reserved.
  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
  *
@@ -245,7 +245,7 @@ public void installDebugInfo(DebugInfoProvider debugInfoProvider) {
 
             /* Search for a method defining this primary range. */
             ClassEntry classEntry = ensureClassEntry(className);
-            MethodEntry methodEntry = classEntry.ensureMethodEntry(debugCodeInfo, this, debugContext);
+            MethodEntry methodEntry = classEntry.getMethodEntry(debugCodeInfo, this);
             Range primaryRange = classEntry.makePrimaryRange(symbolName, stringTable, methodEntry, lo, hi, primaryLine);
             debugContext.log(DebugContext.INFO_LEVEL, "PrimaryRange %s.%s %s %s:%d [0x%x, 0x%x]", className, methodName, filePath, fileName, primaryLine, lo, hi);
             classEntry.indexPrimary(primaryRange, debugCodeInfo.getFrameSizeChanges(), debugCodeInfo.getFrameSize());
@@ -263,7 +263,7 @@ public void installDebugInfo(DebugInfoProvider debugInfoProvider) {
                  * symbol for them and don't see a break in the address range.
                  */
                 ClassEntry subClassEntry = ensureClassEntry(classNameAtLine);
-                MethodEntry subMethodEntry = subClassEntry.ensureMethodEntry(debugLineInfo, this, debugContext);
+                MethodEntry subMethodEntry = subClassEntry.getMethodEntry(debugLineInfo, this);
                 Range subRange = new Range(symbolNameAtLine, stringTable, subMethodEntry, loAtLine, hiAtLine, line, primaryRange);
                 classEntry.indexSubRange(subRange);
                 try (DebugContext.Scope s = debugContext.scope("Subranges")) {

substratevm/src/com.oracle.objectfile/src/com/oracle/objectfile/debugentry/MethodEntry.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2020, 2020, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2020, 2021, Oracle and/or its affiliates. All rights reserved.
  * Copyright (c) 2020, 2020, Red Hat Inc. All rights reserved.
  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
  *
@@ -26,7 +26,7 @@
 
 package com.oracle.objectfile.debugentry;
 
-public class MethodEntry extends MemberEntry {
+public class MethodEntry extends MemberEntry implements Comparable {
     final TypeEntry[] paramTypes;
     final String[] paramNames;
     final boolean isDeoptTarget;
@@ -100,4 +100,27 @@ public int compareTo(String methodName, String paramSignature, String returnType
     public boolean isDeoptTarget() {
         return isDeoptTarget;
     }
+
+    @Override
+    public int compareTo(Object o) {
+        assert o != null;
+        assert o instanceof MethodEntry;
+        MethodEntry other = (MethodEntry) o;
+        int result = methodName().compareTo(other.methodName());
+        if (result == 0) {
+            result = valueType.getTypeName().compareTo(other.valueType.getTypeName());
+        }
+        if (result == 0) {
+            result = getParamCount() - other.getParamCount();
+        }
+        if (result == 0) {
+            for (int i = 0; i < getParamCount(); i++) {
+                result = getParamTypeName(i).compareTo(other.getParamTypeName(i));
+                if (result != 0) {
+                    break;
+                }
+            }
+        }
+        return result;
+    }
 }