Windows debug information prototype

substratevm/DEBUGINFO_WINDOWS.md

@@ -0,0 +1,35 @@
+Using the prototype debug info feature on windows.
+--------------------------------------
+
+To add debug info to a generated native image add flag
+-H:GenerateDebugInfo=<N> to the native image command line (where N is
+a positive integer value -- the default value 0 means generate no
+debug info). For example,
+
+    $ javac Hello.java
+    $ mx native-image -H:GenerateDebugInfo=1 Hello
+
+The resulting image should contain CodeView4 debug records in a
+format Visual Studio understands. 
+
+Please read the standard DEBUGINFO file; this file only documents differences.
+
+Because of limitations in the linker, function names are mangled into the equivalent of
+ _package.class.Function_999_, where '999' is a hash of the function arguments.  The exception is the first main() function encountered,
+ which is mangled to _package.class.main_, with no argument hash.
+
+As an experimental feature, the Windows debug info ignores inlined Graal code.
+This is currently a Graal compile-time flag in CVConstants.java: _skipGraalIntrinsics_.
+
+To enable Visual Studio to access the cached sources, right click on the solution
+in the "Solution Explorer", and select "Properties", then "Debug Source Files".
+in the Debug Source Files plane, add the cache directories to the source directory list.
+
+___Unimplemented functionality___
+
+- Currently stack frames are not properly expressed in the debug info.
+The stack frame display may have extraneous information in it, and "Step Out", may work incorrectly.
+
+- Currently there is no type information in the debug info.
+
+- Currently variables and members do not appear in the type information.

substratevm/src/com.oracle.objectfile/src/com/oracle/objectfile/ObjectFile.java

@@ -252,6 +252,16 @@ public enum RelocationKind {
          * The relocation's symbol provides high fixup bytes.
          */
         DIRECT_HI,
+        /**
+         * The index of the object file section containing the relocation's symbol supplies the
+         * fixup bytes. (used in CodeView debug information)
+         */
+        SECTION,
+        /**
+         * The address of the object file section containing the relocation's symbol (+addend(
+         * supplies the fixup bytes. (used in CodeView debug information)
+         */
+        SECREL,
         /**
          * The relocation's symbol provides low fixup bytes.
          */
@@ -1092,7 +1102,7 @@ protected boolean elementsCanSharePage(Element s1, Element s2, int offset1, int
     /**
      * API method provided to allow a native image generator to provide details of types, code and
      * heap data inserted into a native image.
-     * 
+     *
      * @param debugInfoProvider an implementation of the provider interface that communicates
      *            details of the relevant types, code and heap data.
      */
@@ -1750,7 +1760,7 @@ public final SymbolTable getOrCreateSymbolTable() {
      * Allows a task to be executed with a debug context in a named subscope bound to the object
      * file and accessible to code executed during the lifetime of the task. Invoked code may obtain
      * access to the debug context using method {@link #debugContext}.
-     * 
+     *
      * @param context a context to be bound to the object file for the duration of the task
      *            execution.
      * @param scopeName a name to be used to define a subscope current while the task is being
@@ -1772,7 +1782,7 @@ public void withDebugContext(DebugContext context, String scopeName, Runnable ta
     /**
      * Allows a consumer to retrieve the debug context currently bound to this object file. This
      * method must only called underneath an invocation of method {@link #withDebugContext}.
-     * 
+     *
      * @param scopeName a name to be used to define a subscope current while the consumer is active.
      * @param action an action parameterised by the debug context.
      */

substratevm/src/com.oracle.objectfile/src/com/oracle/objectfile/SectionName.java

@@ -94,11 +94,14 @@ public String getFormatDependentName(Format f) {
     public static final SectionName APPLE_NAMESPACE = new ProgbitsSectionName("apple_namespac");
     public static final SectionName APPLE_OBJC = new ProgbitsSectionName("apple_objc");
     public static final SectionName LLVM_STACKMAPS = new ProgbitsSectionName("llvm_stackmaps");
+    // Windows PECOFF CodeView 4 debug sections
+    public static final SectionName CV4_DEBUG_SYMBOLS = new ProgbitsSectionName("debug$S");
+    public static final SectionName CV4_DEBUG_TYPES = new ProgbitsSectionName("debug$T");
 
     private static final SectionName[] myValues;
 
     static {
-        myValues = new SectionName[]{DATA, RODATA, TEXT, BSS, APPLE_NAMES, APPLE_TYPES, APPLE_NAMESPACE, APPLE_OBJC, LLVM_STACKMAPS};
+        myValues = new SectionName[]{DATA, RODATA, TEXT, BSS, APPLE_NAMES, APPLE_TYPES, APPLE_NAMESPACE, APPLE_OBJC, LLVM_STACKMAPS, CV4_DEBUG_SYMBOLS, CV4_DEBUG_TYPES};
     }
 
     private static String getFormatPrefix(ObjectFile.Format f) {

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

@@ -59,4 +59,14 @@ public String getFullName() {
     public DirEntry getDirEntry() {
         return dirEntry;
     }
+
+    @Override
+    public String toString() {
+        if (getDirEntry() == null) {
+            return getFileName() == null ? "-" : getFileName();
+        } else if (getFileName() == null) {
+            return "--";
+        }
+        return String.format("FileEntry(%s)", getFullName());
+    }
 }

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

@@ -36,6 +36,10 @@
  */
 
 public class Range {
+
+    /* Use '.' for PECOFF files */
+    private static final String CLASS_DELIMITER = System.getProperty("os.name").toLowerCase().contains("windows") ? "." : "::";
+
     private String fileName;
     private Path filePath;
     private String className;
@@ -79,6 +83,25 @@ public Range(String fileName, Path filePath, String className, String methodName
         this.primary = primary;
     }
 
+    /*
+     * Create a slightly different copy of a previously constructed range. Because the previous
+     * range was constructed by one of the other constructors, a valid assumption is that all the
+     * strings have previously been inserted int he stringTable, and we can avoid doing that again.
+     */
+    public Range(Range other, int lo, int hi) {
+        this.fileName = other.fileName;
+        this.filePath = other.filePath;
+        this.className = other.className;
+        this.methodName = other.methodName;
+        this.paramNames = other.paramNames;
+        this.returnTypeName = other.returnTypeName;
+        this.fullMethodName = other.fullMethodName;
+        this.lo = lo;
+        this.hi = hi;
+        this.line = other.line;
+        this.primary = other.primary;
+    }
+
     public boolean contains(Range other) {
         return (lo <= other.lo && hi >= other.hi);
     }
@@ -133,6 +156,19 @@ public String getFullMethodName() {
         return fullMethodName;
     }
 
+    public String getParamNames() {
+        return paramNames;
+    }
+
+    public String getClassAndMethodName() {
+        StringBuilder builder = new StringBuilder();
+        if (className != null) {
+            builder.append(className).append(CLASS_DELIMITER);
+        }
+        builder.append(methodName);
+        return builder.toString();
+    }
+
     private String getExtendedMethodName(boolean includeParams, boolean includeReturnType) {
         StringBuilder builder = new StringBuilder();
         if (includeReturnType && returnTypeName.length() > 0) {
@@ -141,7 +177,7 @@ private String getExtendedMethodName(boolean includeParams, boolean includeRetur
         }
         if (className != null) {
             builder.append(className);
-            builder.append("::");
+            builder.append(CLASS_DELIMITER);
         }
         builder.append(methodName);
         if (includeParams && !paramNames.isEmpty()) {
@@ -155,4 +191,9 @@ private String getExtendedMethodName(boolean includeParams, boolean includeRetur
     private String constructClassAndMethodNameWithParams() {
         return getExtendedMethodName(true, false);
     }
+
+    @Override
+    public String toString() {
+        return String.format("Range(lo=0x%05x hi=0x%05x %s %s:%d)", lo, hi, constructClassAndMethodNameWithParams(), getFileAsPath(), line);
+    }
 }

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

@@ -46,7 +46,7 @@ public StringTable() {
      * Ensures a unique instance of a string exists in the table, inserting the supplied String if
      * no equivalent String is already present. This should only be called before the string section
      * has been written.
-     * 
+     *
      * @param string the string to be included in the table
      * @return the unique instance of the String
      */
@@ -58,7 +58,7 @@ public String uniqueString(String string) {
      * Ensures a unique instance of a string exists in the table and is marked for inclusion in the
      * debug_str section, inserting the supplied String if no equivalent String is already present.
      * This should only be called before the string section has been written.
-     * 
+     *
      * @param string the string to be included in the table and marked for inclusion in the
      *            debug_str section
      * @return the unique instance of the String
@@ -82,7 +82,7 @@ private String ensureString(String string, boolean addToStrSection) {
     /**
      * Retrieves the offset at which a given string was written into the debug_str section. This
      * should only be called after the string section has been written.
-     * 
+     *
      * @param string the strng whose offset is to be retrieved
      * @return the offset or -1 if the string does not define an entry or the entry has not been
      *         written to the debug_str section

substratevm/src/com.oracle.objectfile/src/com/oracle/objectfile/pecoff/PECoff.java

@@ -124,6 +124,7 @@ enum IMAGE_SECTION_HEADER {
 
         static final int IMAGE_SCN_LNK_NRELOC_OVFL        = 0x01000000;
 
+        static final int IMAGE_SCN_MEM_DISCARDABLE        = 0x02000000;
         static final int IMAGE_SCN_MEM_SHARED             = 0x10000000;
         static final int IMAGE_SCN_MEM_EXECUTE            = 0x20000000;
         static final int IMAGE_SCN_MEM_READ               = 0x40000000;
@@ -202,7 +203,8 @@ enum IMAGE_RELOCATION {
         static final int IMAGE_REL_AMD64_REL32_3  = 0x7;
         static final int IMAGE_REL_AMD64_REL32_4  = 0x8;
         static final int IMAGE_REL_AMD64_REL32_5  = 0x9;
-
+        static final int IMAGE_REL_AMD64_SECTION  = 0xa;
+        static final int IMAGE_REL_AMD64_SECREL   = 0xb;
     }
     //@formatter:on
     // Checkstyle: resume

substratevm/src/com.oracle.objectfile/src/com/oracle/objectfile/pecoff/PECoffMachine.java

@@ -56,6 +56,8 @@ public static PECoffRelocationMethod getRelocation(PECoffMachine m, RelocationKi
                 switch (k) {
                     case DIRECT:
                         switch (sizeInBytes) {
+                            case 4:
+                                return PECoffX86_64Relocation.ADDR32;
                             case 8:
                                 return PECoffX86_64Relocation.ADDR64;
                             default:
@@ -68,6 +70,20 @@ public static PECoffRelocationMethod getRelocation(PECoffMachine m, RelocationKi
                             default:
                                 throw new IllegalArgumentException("unsupported relocation type: " + k + " size: " + sizeInBytes);
                         }
+                    case SECTION:
+                        switch (sizeInBytes) {
+                            case 2:
+                                return PECoffX86_64Relocation.SECTION;
+                            default:
+                                throw new IllegalArgumentException("unsupported relocation type: " + k + " size: " + sizeInBytes);
+                        }
+                    case SECREL:
+                        switch (sizeInBytes) {
+                            case 4:
+                                return PECoffX86_64Relocation.SECREL;
+                            default:
+                                throw new IllegalArgumentException("unsupported relocation type: " + k + " size: " + sizeInBytes);
+                        }
                     default:
                     case UNKNOWN:
                         throw new IllegalArgumentException("cannot map unknown relocation kind to an PECoff x86-64 relocation type");
@@ -176,6 +192,54 @@ public long toLong() {
             return IMAGE_RELOCATION.IMAGE_REL_AMD64_ADDR64;
         }
     },
+    ADDR32 {
+        @Override
+        public RelocationKind getKind() {
+            return RelocationKind.DIRECT;
+        }
+
+        @Override
+        public int getRelocatedByteSize() {
+            return 4;
+        }
+
+        @Override
+        public long toLong() {
+            return IMAGE_RELOCATION.IMAGE_REL_AMD64_ADDR32;
+        }
+    },
+    SECREL {
+        @Override
+        public RelocationKind getKind() {
+            return RelocationKind.DIRECT;
+        }
+
+        @Override
+        public int getRelocatedByteSize() {
+            return 4;
+        }
+
+        @Override
+        public long toLong() {
+            return IMAGE_RELOCATION.IMAGE_REL_AMD64_SECREL;
+        }
+    },
+    SECTION {
+        @Override
+        public RelocationKind getKind() {
+            return RelocationKind.DIRECT;
+        }
+
+        @Override
+        public int getRelocatedByteSize() {
+            return 2;
+        }
+
+        @Override
+        public long toLong() {
+            return IMAGE_RELOCATION.IMAGE_REL_AMD64_SECTION;
+        }
+    },
     REL32 {
         @Override
         public RelocationKind getKind() {

substratevm/src/com.oracle.objectfile/src/com/oracle/objectfile/pecoff/PECoffObjectFile.java

@@ -39,10 +39,14 @@
 import com.oracle.objectfile.LayoutDecisionMap;
 import com.oracle.objectfile.ObjectFile;
 import com.oracle.objectfile.SymbolTable;
+import com.oracle.objectfile.debuginfo.DebugInfoProvider;
 import com.oracle.objectfile.io.AssemblyBuffer;
 import com.oracle.objectfile.io.OutputAssembler;
 import com.oracle.objectfile.pecoff.PECoff.IMAGE_FILE_HEADER;
 import com.oracle.objectfile.pecoff.PECoff.IMAGE_SECTION_HEADER;
+import com.oracle.objectfile.pecoff.cv.CVDebugInfo;
+import com.oracle.objectfile.pecoff.cv.CVSymbolSectionImpl;
+import com.oracle.objectfile.pecoff.cv.CVTypeSectionImpl;
 
 /**
  * Represents a PECoff object file.
@@ -379,6 +383,7 @@ public enum PECoffSectionFlag implements ValueEnum {
         READ(IMAGE_SECTION_HEADER.IMAGE_SCN_MEM_READ),
         WRITE(IMAGE_SECTION_HEADER.IMAGE_SCN_MEM_WRITE),
         EXECUTE(IMAGE_SECTION_HEADER.IMAGE_SCN_MEM_EXECUTE),
+        DISCARDABLE(IMAGE_SECTION_HEADER.IMAGE_SCN_MEM_DISCARDABLE),
         LINKER(IMAGE_SECTION_HEADER.IMAGE_SCN_LNK_INFO | IMAGE_SECTION_HEADER.IMAGE_SCN_LNK_REMOVE);
 
         private final int value;
@@ -683,4 +688,42 @@ public PECoffRelocationTable getRelocationTable() {
     protected int getMinimumFileSize() {
         return 0;
     }
+
+    @Override
+    public Section newDebugSection(String name, ElementImpl impl) {
+        PECoffSection coffSection = (PECoffSection) super.newDebugSection(name, impl);
+        coffSection.getFlags().add(PECoffSectionFlag.DISCARDABLE);
+        coffSection.getFlags().add(PECoffSectionFlag.READ);
+        coffSection.getFlags().add(PECoffSectionFlag.INITIALIZED_DATA);
+        impl.setElement(coffSection);
+        return coffSection;
+    }
+
+    @Override
+    public void installDebugInfo(DebugInfoProvider debugInfoProvider) {
+        CVDebugInfo cvDebugInfo = new CVDebugInfo(getMachine(), getByteOrder());
+
+        // we need an implementation for each section
+        CVSymbolSectionImpl cvSymbolSectionImpl = cvDebugInfo.getCVSymbolSection();
+        CVTypeSectionImpl cvTypeSectionImpl = cvDebugInfo.getCVTypeSection();
+
+        // now we can create the section elements with empty content
+        newDebugSection(cvSymbolSectionImpl.getSectionName(), cvSymbolSectionImpl);
+        newDebugSection(cvTypeSectionImpl.getSectionName(), cvTypeSectionImpl);
+
+        // the byte[] for each implementation's content are created and
+        // written under getOrDecideContent. doing that ensures that all
+        // dependent sections are filled in and then sized according to the
+        // declared dependencies. however, if we leave it at that then
+        // associated reloc sections only get created when the first reloc
+        // is inserted during content write that's too late for them to have
+        // layout constraints included in the layout decision set and causes
+        // an NPE during reloc section write. so we need to create the relevant
+        // reloc sections here in advance
+        cvSymbolSectionImpl.getOrCreateRelocationElement(false);
+        cvTypeSectionImpl.getOrCreateRelocationElement(false);
+
+        // ok now we can populate the implementations
+        cvDebugInfo.installDebugInfo(debugInfoProvider);
+    }
 }