DebugInfo: Augment Range with originalClassName

Till now Range included className which would return the original class
name for substitution methods. E.g. if Foo.m was substituing Bar.n a
range corresponding to Foo.m would return Bar as the className. This
patch makes originalClassName return Bar and changes className to return
Foo.

OriginalClassName is used to produce the extended method name, e.g.
Bar::m(argA) while the className is used to map classes to FileEntries.

This change will essentially allow us to create Compilation Units for
Substitution classes as well. Those Compilation Units will contain
entries for the substitution methods, while the Compilation Units of the
original class will contain the original methods.

Author: zakkak

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

@@ -132,6 +132,7 @@ public void installDebugInfo(DebugInfoProvider debugInfoProvider) {
             Path cachePath = debugCodeInfo.cachePath();
             // switch '$' in class names for '.'
             String className = debugCodeInfo.className().replaceAll("\\$", ".");
+            String originalClassName = debugCodeInfo.originalClassName().replaceAll("\\$", ".");
             String methodName = debugCodeInfo.methodName();
             String paramNames = debugCodeInfo.paramNames();
             String returnTypeName = debugCodeInfo.returnTypeName();
@@ -140,14 +141,15 @@ public void installDebugInfo(DebugInfoProvider debugInfoProvider) {
             int primaryLine = debugCodeInfo.line();
             boolean isDeoptTarget = debugCodeInfo.isDeoptTarget();
 
-            Range primaryRange = new Range(fileName, filePath, cachePath, className, methodName, paramNames, returnTypeName, stringTable, lo, hi, primaryLine, isDeoptTarget);
+            Range primaryRange = new Range(fileName, filePath, cachePath, className, originalClassName, methodName, paramNames, returnTypeName, stringTable, lo, hi, primaryLine, isDeoptTarget);
             debugContext.log(DebugContext.INFO_LEVEL, "PrimaryRange %s.%s %s %s:%d [0x%x, 0x%x]", className, methodName, filePath, fileName, primaryLine, lo, hi);
             addRange(primaryRange, debugCodeInfo.getFrameSizeChanges(), debugCodeInfo.getFrameSize());
             debugCodeInfo.lineInfoProvider().forEach(debugLineInfo -> {
                 String fileNameAtLine = debugLineInfo.fileName();
                 Path filePathAtLine = debugLineInfo.filePath();
                 // Switch '$' in class names for '.'
                 String classNameAtLine = debugLineInfo.className().replaceAll("\\$", ".");
+                String originalClassNameAtLine = debugLineInfo.originalClassName().replaceAll("\\$", ".");
                 String methodNameAtLine = debugLineInfo.methodName();
                 int loAtLine = lo + debugLineInfo.addressLo();
                 int hiAtLine = lo + debugLineInfo.addressHi();
@@ -157,7 +159,8 @@ public void installDebugInfo(DebugInfoProvider debugInfoProvider) {
                  * Record all subranges even if they have no line or file so we at least get a
                  * symbol for them.
                  */
-                Range subRange = new Range(fileNameAtLine, filePathAtLine, cachePathAtLine, classNameAtLine, methodNameAtLine, "", "", stringTable, loAtLine, hiAtLine, line, primaryRange);
+                Range subRange = new Range(fileNameAtLine, filePathAtLine, cachePathAtLine, classNameAtLine, originalClassNameAtLine, methodNameAtLine, "", "", stringTable, loAtLine, hiAtLine, line,
+                                primaryRange);
                 addSubRange(primaryRange, subRange);
                 try (DebugContext.Scope s = debugContext.scope("Subranges")) {
                     debugContext.log(DebugContext.VERBOSE_LEVEL, "SubRange %s.%s %s %s:%d 0x%x, 0x%x]", classNameAtLine, methodNameAtLine, filePathAtLine, fileNameAtLine, line, loAtLine, hiAtLine);

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

@@ -40,6 +40,7 @@ public class Range {
     private String fileName;
     private Path filePath;
     private String className;
+    private String originalClassName;
     private String methodName;
     private String paramNames;
     private String returnTypeName;
@@ -56,24 +57,24 @@ public class Range {
     /*
      * Create a primary range.
      */
-    public Range(String fileName, Path filePath, Path cachePath, String className, String methodName, String paramNames, String returnTypeName, StringTable stringTable, int lo, int hi, int line,
-                    boolean isDeoptTarget) {
-        this(fileName, filePath, cachePath, className, methodName, paramNames, returnTypeName, stringTable, lo, hi, line, isDeoptTarget, null);
+    public Range(String fileName, Path filePath, Path cachePath, String className, String originalClassName, String methodName, String paramNames, String returnTypeName, StringTable stringTable,
+                    int lo, int hi, int line, boolean isDeoptTarget) {
+        this(fileName, filePath, cachePath, className, originalClassName, methodName, paramNames, returnTypeName, stringTable, lo, hi, line, isDeoptTarget, null);
     }
 
     /*
      * Create a secondary range.
      */
-    public Range(String fileName, Path filePath, Path cachePath, String className, String methodName, String paramNames, String returnTypeName, StringTable stringTable, int lo, int hi, int line,
-                    Range primary) {
-        this(fileName, filePath, cachePath, className, methodName, paramNames, returnTypeName, stringTable, lo, hi, line, false, primary);
+    public Range(String fileName, Path filePath, Path cachePath, String className, String originalClassName, String methodName, String paramNames, String returnTypeName, StringTable stringTable,
+                    int lo, int hi, int line, Range primary) {
+        this(fileName, filePath, cachePath, className, originalClassName, methodName, paramNames, returnTypeName, stringTable, lo, hi, line, false, primary);
     }
 
     /*
      * Create a primary or secondary range.
      */
-    private Range(String fileName, Path filePath, Path cachePath, String className, String methodName, String paramNames, String returnTypeName, StringTable stringTable, int lo, int hi, int line,
-                    boolean isDeoptTarget, Range primary) {
+    private Range(String fileName, Path filePath, Path cachePath, String className, String originalClassName, String methodName, String paramNames, String returnTypeName, StringTable stringTable,
+                    int lo, int hi, int line, boolean isDeoptTarget, Range primary) {
         /*
          * Currently file name and full method name need to go into the debug_str section other
          * strings just need to be deduplicated to save space.
@@ -82,6 +83,7 @@ private Range(String fileName, Path filePath, Path cachePath, String className,
         this.filePath = filePath;
         this.cachePath = (cachePath == null ? "" : stringTable.uniqueDebugString(cachePath.toString()));
         this.className = stringTable.uniqueString(className);
+        this.originalClassName = stringTable.uniqueString(originalClassName);
         this.methodName = stringTable.uniqueString(methodName);
         this.paramNames = stringTable.uniqueString(paramNames);
         this.returnTypeName = stringTable.uniqueString(returnTypeName);
@@ -157,8 +159,8 @@ private String getExtendedMethodName(boolean includeParams, boolean includeRetur
             builder.append(returnTypeName);
             builder.append(' ');
         }
-        if (className != null) {
-            builder.append(className);
+        if (originalClassName != null) {
+            builder.append(originalClassName);
             builder.append("::");
         }
         builder.append(methodName);

substratevm/src/com.oracle.objectfile/src/com/oracle/objectfile/debuginfo/DebugInfoProvider.java

@@ -72,6 +72,13 @@ interface DebugCodeInfo {
          */
         String className();
 
+        /**
+         * @return the fully qualified name of the original class owning the compiled method. For
+         *         code segments not originating from substituted methods this should be identical
+         *         to {@link DebugCodeInfo#className()}.
+         */
+        String originalClassName();
+
         /**
          * @return the name of the compiled method including signature.
          */
@@ -160,6 +167,13 @@ interface DebugLineInfo {
          */
         String className();
 
+        /**
+         * @return the fully qualified name of the original class owning the compiled method. For
+         *         code segments not originating from substituted methods this should be identical
+         *         to {@link DebugLineInfo#className()}.
+         */
+        String originalClassName();
+
         /**
          * @return the name of the outer or inlined method including signature.
          */

substratevm/src/com.oracle.svm.hosted/src/com/oracle/svm/hosted/image/NativeImageDebugInfoProvider.java

@@ -152,6 +152,11 @@ public Path cachePath() {
 
         @Override
         public String className() {
+            return getDeclaringClass(method).getName();
+        }
+
+        @Override
+        public String originalClassName() {
             return javaType.toClassName();
         }
 
@@ -281,6 +286,11 @@ public Path cachePath() {
 
         @Override
         public String className() {
+            return getDeclaringClass(method).getName();
+        }
+
+        @Override
+        public String originalClassName() {
             return method.format("%H");
         }