[GR-31487] Fix CE debuginfo for substituted methods/fields.

PullRequest: graal/8979

Author: olpaw

substratevm/mx.substratevm/suite.py

@@ -588,6 +588,7 @@
             "dependencies": [
                 "mx:JUNIT_TOOL",
                 "sdk:GRAAL_SDK",
+                "SVM",
             ],
             "checkstyle": "com.oracle.svm.core",
             "workingSets": "SVM",
@@ -1322,6 +1323,7 @@
           "distDependencies": [
             "mx:JUNIT_TOOL",
             "sdk:GRAAL_SDK",
+            "SVM",
             "SVM_CONFIGURE",
           ],
           "testDistribution" : True,

substratevm/mx.substratevm/testhello.py

@@ -263,6 +263,32 @@ def test():
                           r"%s = 1000"%(wildcard_pattern))
         checker.check(exec_string, skip_fails=False)
 
+
+    # set a break point at hello.Hello$DefaultGreeter::greet
+    # expect "Breakpoint 2 at 0x[0-9a-f]+: file hello/Target_Hello_DefaultGreeter.java, line [0-9]+."
+    exec_string = execute("break hello.Hello$DefaultGreeter::greet")
+    rexp = r"Breakpoint 2 at %s: file hello/Target_hello_Hello_DefaultGreeter\.java, line %s\."%(address_pattern, digits_pattern)
+    checker = Checker("break on substituted method", rexp)
+    checker.check(exec_string, skip_fails=False)
+
+    # look up greet methods
+    # expect "All functions matching regular expression "greet":"
+    # expect ""
+    # expect "File hello/Hello.java:"
+    # expect "      ....greeter(...);"
+    # expect "      hello.Hello$NamedGreeter *hello.Hello$Greeter::greet();"
+    # expect ""
+    # expect "File hello/target_hello_Hello_DefaultGreeter.java:"
+    # expect "      hello.Hello$DefaultGreeter *hello.Hello$Greeter::greet();"
+    exec_string = execute("info func greet")
+    rexp = [r'All functions matching regular expression "greet":',
+            r"File hello/Hello\.java:",
+            r"%svoid hello.Hello\$NamedGreeter::greet\(void\);"%maybe_spaces_pattern,
+            r"File hello/Target_hello_Hello_DefaultGreeter\.java:",
+            r"%svoid hello.Hello\$DefaultGreeter::greet\(void\);"%maybe_spaces_pattern]
+    checker = Checker("info func greet", rexp)
+    checker.check(exec_string, skip_fails=True)
+
     # look up PrintStream.println methods
     # expect "All functions matching regular expression "java.io.PrintStream.println":"
     # expect ""
@@ -282,9 +308,9 @@ def test():
     checker.check(exec_string)
 
     # set a break point at PrintStream.println(String)
-    # expect "Breakpoint 2 at 0x[0-9a-f]+: java.base/java/io/PrintStream.java, line [0-9]+."
+    # expect "Breakpoint 3 at 0x[0-9a-f]+: java.base/java/io/PrintStream.java, line [0-9]+."
     exec_string = execute("break java.io.PrintStream::println(java.lang.String *)")
-    rexp = r"Breakpoint 2 at %s: file .*java/io/PrintStream\.java, line %s\."%(address_pattern, digits_pattern)
+    rexp = r"Breakpoint 3 at %s: file .*java/io/PrintStream\.java, line %s\."%(address_pattern, digits_pattern)
     checker = Checker('break println', rexp)
     checker.check(exec_string, skip_fails=False)
 
@@ -400,7 +426,8 @@ def test():
         print(checker)
         sys.exit(1)
 
-    # continue to next breakpoint
+    # continue to next 2 breakpoints
+    execute("continue")
     execute("continue")
 
     # run backtrace to check we are in java.io.PrintStream::println(java.lang.String)

substratevm/src/com.oracle.objectfile/src/com/oracle/objectfile/elf/dwarf/DwarfInfoSectionImpl.java

@@ -682,7 +682,8 @@ private int writeMethodDeclaration(DebugContext context, ClassEntry classEntry,
         String name = uniqueDebugString(range.getMethodName());
         log(context, "  [0x%08x]     name 0x%x (%s)", pos, debugStringIndex(name), name);
         pos = writeAttrStrp(name, buffer, pos);
-        int fileIdx = classEntry.localFilesIdx();
+        FileEntry fileEntry = range.getFileEntry();
+        int fileIdx = (fileEntry != null ? classEntry.localFilesIdx(fileEntry) : classEntry.localFilesIdx());
         log(context, "  [0x%08x]     file 0x%x (%s)", pos, fileIdx, range.getFileEntry().getFullName());
         pos = writeAttrData2((short) fileIdx, buffer, pos);
         String returnTypeName = range.getMethodReturnTypeName();

substratevm/src/com.oracle.objectfile/src/com/oracle/objectfile/elf/dwarf/DwarfLineSectionImpl.java

@@ -425,24 +425,31 @@ private int writeFileTable(DebugContext context, ClassEntry classEntry, byte[] b
 
     private int writeLineNumberTable(DebugContext context, ClassEntry classEntry, byte[] buffer, int p) {
         int pos = p;
-        FileEntry fileEntry = classEntry.getFileEntry();
-        if (fileEntry == null) {
+        // if the class has no associated file then don't generate line info
+        if (classEntry.getFileEntry() == null) {
             return pos;
         }
         /*
-         * The primary file entry should always be first in the local files list.
+         * The class file entry should always be first in the local files list.
          */
         assert classEntry.localFilesIdx() == 1;
         String primaryClassName = classEntry.getTypeName();
         String primaryFileName = classEntry.getFileName();
-        String file = primaryFileName;
-        int fileIdx = 1;
         log(context, "  [0x%08x] primary class %s", pos, primaryClassName);
-        log(context, "  [0x%08x] primary file %s", pos, primaryFileName);
+        log(context, "  [0x%08x] primary class file %s", pos, primaryFileName);
         for (PrimaryEntry primaryEntry : classEntry.getPrimaryEntries()) {
             Range primaryRange = primaryEntry.getPrimary();
+            // the primary method might be a substitution and not in the primary class file
+            FileEntry fileEntry = primaryRange.getFileEntry();
+            if (fileEntry == null) {
+                log(context, "  [0x%08x] primary range [0x%08x, 0x%08x] skipped (no file) %s", pos, debugTextBase + primaryRange.getLo(), debugTextBase + primaryRange.getHi(),
+                                primaryRange.getFullMethodNameWithParams());
+                continue;
+            }
+            String file = fileEntry.getFileName();
+            int fileIdx = classEntry.localFilesIdx(fileEntry);
             /*
-             * Each primary represents a method i.e. a contiguous sequence of subranges. we assume
+             * Each primary represents a method i.e. a contiguous sequence of subranges. we write
              * the default state at the start of each sequence because we always post an
              * end_sequence when we finish all the subranges in the method.
              */
@@ -458,8 +465,9 @@ private int writeLineNumberTable(DebugContext context, ClassEntry classEntry, by
             /*
              * Set state for primary.
              */
-            log(context, "  [0x%08x] primary range [0x%08x, 0x%08x] %s:%d", pos, debugTextBase + primaryRange.getLo(), debugTextBase + primaryRange.getHi(), primaryRange.getFullMethodNameWithParams(),
-                            primaryRange.getLine());
+            log(context, "  [0x%08x] primary range [0x%08x, 0x%08x] %s %s:%d", pos, debugTextBase + primaryRange.getLo(), debugTextBase + primaryRange.getHi(),
+                            primaryRange.getFullMethodNameWithParams(),
+                            file, primaryRange.getLine());
 
             /*
              * Initialize and write a row for the start of the primary method.
@@ -520,7 +528,8 @@ private int writeLineNumberTable(DebugContext context, ClassEntry classEntry, by
                 long subLine = subrange.getLine();
                 long subAddressLo = subrange.getLo();
                 long subAddressHi = subrange.getHi();
-                log(context, "  [0x%08x] sub range [0x%08x, 0x%08x] %s:%d", pos, debugTextBase + subAddressLo, debugTextBase + subAddressHi, subrange.getFullMethodNameWithParams(), subLine);
+                log(context, "  [0x%08x] sub range [0x%08x, 0x%08x] %s %s:%d", pos, debugTextBase + subAddressLo, debugTextBase + subAddressHi, subrange.getFullMethodNameWithParams(), subfile,
+                                subLine);
                 if (subLine < 0) {
                     /*
                      * No line info so stay at previous file:line.
@@ -629,7 +638,7 @@ private int writeLineNumberTable(DebugContext context, ClassEntry classEntry, by
             }
             pos = writeEndSequenceOp(context, buffer, pos);
         }
-        log(context, "  [0x%08x] primary file processed %s", pos, primaryFileName);
+        log(context, "  [0x%08x] primary class processed %s", pos, primaryClassName);
 
         return pos;
     }