add debugInfo for MacOS

Author: esytnik

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

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2012, 2020, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2012, 2023, Oracle and/or its affiliates. All rights reserved.
  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
  *
  * This code is free software; you can redistribute it and/or modify it
@@ -528,15 +528,19 @@ public Section newUserDefinedSection(String name, ElementImpl impl) {
         return result;
     }
 
-    public Section newDebugSection(String name, ElementImpl impl) {
-        final Segment segment = getOrCreateSegment(null, name, false, false);
+    public Section newDebugSection(String segmentName, String name, ElementImpl impl) {
+        final Segment segment = getOrCreateSegment(segmentName, name, false, false);
         final int alignment = 1; // debugging information is mostly unaligned; padding can result in
                                  // corrupted data when the linker merges multiple debugging
                                  // sections from different inputs
         final Section result = newUserDefinedSection(segment, name, alignment, impl);
         return result;
     }
 
+    public Section newDebugSection(String name, ElementImpl impl) {
+        return newDebugSection(null, name, impl);
+    }
+
     // Convenience that does not specify a segment name.
     public Section newProgbitsSection(String name, int alignment, boolean writable, boolean executable, ProgbitsSectionImpl impl) {
         assert impl != null;
@@ -1172,6 +1176,10 @@ public void installDebugInfo(@SuppressWarnings("unused") DebugInfoProvider debug
         // do nothing by default
     }
 
+    public List<String> getDebugSectionNames() {
+        return Collections.emptyList();
+    }
+
     protected static Iterable<LayoutDecision> allDecisions(final Map<Element, LayoutDecisionMap> decisions) {
         return () -> StreamSupport.stream(decisions.values().spliterator(), false)
                         .flatMap(layoutDecisionMap -> StreamSupport.stream(layoutDecisionMap.spliterator(), false)).iterator();
@@ -1289,7 +1297,7 @@ public Element getOffsetBootstrapElement() {
 
     private final HashSet<LayoutDecision> allDecisions = new HashSet<>();
     private final Map<Element, LayoutDecisionMap> decisionsByElement = new IdentityHashMap<>();
-    private final Map<Element, LayoutDecisionMap> decisionsTaken = new IdentityHashMap<>();
+    public final Map<Element, LayoutDecisionMap> decisionsTaken = new IdentityHashMap<>();
 
     private final Map<Element, List<BuildDependency>> dependenciesByDependingElement = new IdentityHashMap<>();
     private final Map<Element, List<BuildDependency>> dependenciesByDependedOnElement = new IdentityHashMap<>();
@@ -1303,7 +1311,7 @@ public void write(DebugContext context, Path outputFile) throws IOException {
     }
 
     @SuppressWarnings("try")
-    public final void write(FileChannel outputChannel) {
+    public List<Element> write(FileChannel outputChannel) {
         List<Element> sortedObjectFileElements = new ArrayList<>();
         int totalSize = bake(sortedObjectFileElements);
         try {
@@ -1317,6 +1325,7 @@ public final void write(FileChannel outputChannel) {
         } catch (IOException e) {
             throw new RuntimeException(e);
         }
+        return sortedObjectFileElements;
     }
 
     /*
@@ -1861,4 +1870,8 @@ public void debugContext(String scopeName, Consumer<DebugContext> action) {
             throw debugContext.handle(e);
         }
     }
+
+    public long getCodeBaseAddress() {
+        return 0;
+    }
 }

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

@@ -223,13 +223,17 @@ public int compiledCodeMax() {
         return compiledCodeMax;
     }
 
+    public void installDebugInfo(DebugInfoProvider debugInfoProvider) {
+        installDebugInfo(debugInfoProvider, 0);
+    }
+
     /**
      * Entry point allowing ELFObjectFile to pass on information about types, code and heap data.
      *
      * @param debugInfoProvider provider instance passed by ObjectFile client.
      */
     @SuppressWarnings("try")
-    public void installDebugInfo(DebugInfoProvider debugInfoProvider) {
+    public void installDebugInfo(DebugInfoProvider debugInfoProvider, long debugAddressOffset) {
         /*
          * This will be needed once we add support for type info:
          *
@@ -332,7 +336,7 @@ public void installDebugInfo(DebugInfoProvider debugInfoProvider) {
             /* Search for a method defining this primary range. */
             ClassEntry classEntry = lookupClassEntry(ownerType);
             MethodEntry methodEntry = classEntry.ensureMethodEntryForDebugRangeInfo(debugCodeInfo, this, debugContext);
-            PrimaryRange primaryRange = Range.createPrimary(methodEntry, lo, hi, primaryLine);
+            PrimaryRange primaryRange = Range.createPrimary(methodEntry, lo + debugAddressOffset, hi + debugAddressOffset, primaryLine);
             if (debugContext.isLogEnabled(DebugContext.INFO_LEVEL)) {
                 debugContext.log(DebugContext.INFO_LEVEL, "PrimaryRange %s.%s %s %s:%d [0x%x, 0x%x]", ownerType.toJavaName(), methodName, filePath, fileName, primaryLine, lo, hi);
             }
@@ -780,7 +784,7 @@ private static void collectFilesAndDirs(ClassEntry classEntry) {
     /**
      * Ensure the supplied file entry and associated directory entry are included, but only once, in
      * a class entry's file and dir list.
-     * 
+     *
      * @param classEntry the class entry whose file and dir list may need to be updated
      * @param fileEntry a file entry which may need to be added to the class entry's file list or
      *            whose dir may need adding to the class entry's dir list

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

@@ -80,7 +80,7 @@ public abstract class Range {
     /**
      * Create a primary range representing the root of the subrange tree for a top level compiled
      * method.
-     * 
+     *
      * @param methodEntry the top level compiled method for this primary range.
      * @param lo the lowest address included in the range.
      * @param hi the first address above the highest address in the range.
@@ -94,7 +94,7 @@ public static PrimaryRange createPrimary(MethodEntry methodEntry, long lo, long
     /**
      * Create a subrange representing a segment of the address range for code of a top level or
      * inlined compiled method. The result will either be a call or a leaf range.
-     * 
+     *
      * @param methodEntry the method from which code in the subrange is derived.
      * @param lo the lowest address included in the range.
      * @param hi the first address above the highest address in the range.
@@ -115,7 +115,6 @@ public static SubRange createSubrange(MethodEntry methodEntry, long lo, long hi,
         }
     }
 
-
     protected Range(MethodEntry methodEntry, long lo, long hi, int line, int depth) {
         assert methodEntry != null;
         this.methodEntry = methodEntry;

substratevm/src/com.oracle.objectfile/src/com/oracle/objectfile/macho/MachOObjectFile.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2013, 2017, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2013, 2013, Oracle and/or its affiliates. All rights reserved.
  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
  *
  * This code is free software; you can redistribute it and/or modify it
@@ -24,8 +24,12 @@
  */
 package com.oracle.objectfile.macho;
 
+import java.io.IOException;
 import java.nio.ByteBuffer;
 import java.nio.ByteOrder;
+import java.nio.channels.FileChannel;
+import java.nio.file.Path;
+import java.nio.file.StandardOpenOption;
 import java.util.ArrayList;
 import java.util.Collection;
 import java.util.Collections;
@@ -42,6 +46,10 @@
 import java.util.stream.Collectors;
 import java.util.stream.Stream;
 
+import com.oracle.objectfile.debuginfo.DebugInfoProvider;
+import com.oracle.objectfile.macho.dsym.DSYMDebugInfo;
+import com.oracle.objectfile.macho.dsym.constants.DSYMSectionName;
+import jdk.graal.compiler.debug.DebugContext;
 import org.graalvm.nativeimage.ImageSingletons;
 import org.graalvm.nativeimage.Platform;
 
@@ -56,6 +64,8 @@
 import com.oracle.objectfile.io.AssemblyBuffer;
 import com.oracle.objectfile.io.OutputAssembler;
 
+import sun.nio.ch.DirectBuffer;
+
 /**
  * Models a Mach-O relocatable object file.
  */
@@ -68,6 +78,8 @@ public final class MachOObjectFile extends ObjectFile {
     private static final int MAGIC = 0xfeedfacf;
     private static final int CIGAM = 0xcffaedfe;
 
+    private static final long PAGEZERO_SIZE = 0x100000000L;
+
     private static final ByteOrder nativeOrder = ByteOrder.nativeOrder();
     private static final ByteOrder oppositeOrder = (nativeOrder == ByteOrder.BIG_ENDIAN) ? ByteOrder.LITTLE_ENDIAN : ByteOrder.BIG_ENDIAN;
 
@@ -170,7 +182,7 @@ public int getWordSizeInBytes() {
 
     @Override
     public boolean shouldRecordDebugRelocations() {
-        return false;
+        return true;
     }
 
     @Override
@@ -185,9 +197,13 @@ public Symbol createUndefinedSymbol(String name, int size, boolean isCode) {
         return symtab.newUndefinedEntry(name, isCode);
     }
 
+    private static final String DWARF_TARGET_SEGMENT_NAME = getUnnamedSegmentName();
+    private static final String DWARF_SEGMENT_NAME = "__DWARF";
+
     @Override
     protected Segment64Command getOrCreateSegment(String segmentNameOrNull, String sectionName, boolean writable, boolean executable) {
-        final String segmentName = (segmentNameOrNull != null) ? segmentNameOrNull : getUnnamedSegmentName();
+        String targetSegmentName = DWARF_SEGMENT_NAME.equals(segmentNameOrNull) ? DWARF_TARGET_SEGMENT_NAME : segmentNameOrNull;
+        final String segmentName = (segmentNameOrNull != null) ? targetSegmentName : getUnnamedSegmentName();
         Segment64Command nonNullSegment = (Segment64Command) findSegmentByName(segmentName);
         if (nonNullSegment != null) {
             // we've found it; make sure it has the permission we need
@@ -201,9 +217,14 @@ protected Segment64Command getOrCreateSegment(String segmentNameOrNull, String s
             }
         } else {
             // create a segment
-            nonNullSegment = new Segment64Command(sectionName, segmentName);
+            if (DWARF_SEGMENT_NAME.equals(segmentNameOrNull)) {
+                nonNullSegment = new Segment64Command(DWARF_TARGET_SEGMENT_NAME, targetSegmentName);
+                nonNullSegment.setLoadable(true);
+            } else {
+                nonNullSegment = new Segment64Command(sectionName, segmentName);
+            }
             nonNullSegment.initprot = EnumSet.of(VMProt.READ); // always give read permission
-            if (writable) {
+            if (writable || DWARF_SEGMENT_NAME.equals(segmentNameOrNull)) {
                 nonNullSegment.initprot.add(VMProt.WRITE);
             }
             if (executable) {
@@ -1580,15 +1601,11 @@ public MachOSection(String name, int alignment, Segment64Command segment, Sectio
             if (name.contains("debug")) {
                 destinationSegmentName = "__DWARF";
                 /*
-                 * FIXME: set the DEBUG flag on this section. Unfortunately, this currently breaks
-                 * debugging: on OS X, the linker intentionally strips debug sections because
-                 * debuggers are expected to retrieve them from the original object files or from a
-                 * debug info archive. We should conform to this by creating a debug info archive
-                 * using dsymutil(1), which would also reduce the size of the linked binary.
-                 * However, attempts to implement this as in an extra step after linking has failed,
-                 * which likely means that more other stuff needs to be fixed beforehand.
+                 * Setting debug flag is essential so that linker won't mess with such section and
+                 * won't include it in the final image. There is a transformer in @see
+                 * NativeImageDebugInfoFeature that will put these sections back in the image.
                  */
-                // flags.add(SectionFlag.DEBUG);
+                flags.add(SectionFlag.DEBUG);
             } else if (flags.contains(
                             SectionFlag.SOME_INSTRUCTIONS) /* || name.equals("__rodata") */) {
                 /*
@@ -1822,6 +1839,43 @@ public int bake(List<Element> sortedObjectFileElements) {
         return super.bake(sortedObjectFileElements);
     }
 
+    public void write(DebugContext context, Path outputFile) throws IOException {
+        try (FileChannel channel = FileChannel.open(outputFile, StandardOpenOption.WRITE, StandardOpenOption.READ, StandardOpenOption.TRUNCATE_EXISTING, StandardOpenOption.CREATE)) {
+            withDebugContext(context, "ObjectFile.write", () -> {
+                try {
+                    writeDebugSections(outputFile, write(channel));
+                } catch (IOException e) {
+                    throw new RuntimeException(e);
+                }
+            });
+        }
+    }
+
+    public void writeDebugSections(Path outputFile, List<Element> sortedObjectFileElements) throws IOException {
+        /*
+         * Dump each debug section into temp file so that linker could add them back untouched
+         * during linking stage.
+         *
+         * @see NativeImageDebugInfoFeature for a corresponding LinkInovcation transformer.
+         */
+        for (Element e : sortedObjectFileElements) {
+            if (DSYMSectionName.debugSections.contains(e.getName())) {
+                Path sectionDump = outputFile.resolveSibling(e.getName());
+                try (FileChannel channel = FileChannel.open(sectionDump, StandardOpenOption.WRITE, StandardOpenOption.READ, StandardOpenOption.TRUNCATE_EXISTING, StandardOpenOption.CREATE)) {
+                    ByteBuffer out = channel.map(FileChannel.MapMode.READ_WRITE, 0, (int) decisionsTaken.get(e).getDecidedValue(LayoutDecision.Kind.SIZE));
+                    out.position(0);
+                    byte[] content = (byte[]) decisionsTaken.get(e).getDecidedValue(LayoutDecision.Kind.CONTENT);
+                    try {
+                        out.put(content);
+                    } finally {
+                        // unmap immediately
+                        ((DirectBuffer) out).cleaner().clean();
+                    }
+                }
+            }
+        }
+    }
+
     int segmentVaddrGivenFirstSectionVaddr(int sectionVaddr) {
         /*
          * We round down the minVaddr to the next lower page boundary. And the same for the file
@@ -1847,6 +1901,16 @@ public class Segment64Command extends LoadCommand implements Segment {
                                                                  // protections of this segment
         // int nsects; // number of sections
         int flags;    // flags
+        boolean loadable;
+
+        public void setLoadable(boolean loadable) {
+            this.loadable = loadable;
+        }
+
+        @Override
+        public boolean isLoadable() {
+            return loadable;
+        }
 
         @Override
         public String getName() {
@@ -1872,10 +1936,12 @@ public boolean isWritable() {
 
         List<SectionInfoStruct> readStructs = new ArrayList<>();
 
+        @SuppressWarnings("this-escape")
         public Segment64Command(String name, String segmentName) {
             super(name, LoadCommandKind.SEGMENT_64);
             // creates a new empty segment
             this.segname = segmentName;
+            setLoadable(false);
         }
 
         @Override
@@ -1995,8 +2061,7 @@ protected void writePayload(OutputAssembler db, final Map<Element, LayoutDecisio
                                 ourRelocs = (MachORelocationElement) e;
                                 continue;
                             }
-                            assert false; // i.e. we should not find *another* RelocationElement
-                                          // also containing relevant relocs
+                            throw new IllegalStateException("Shouldn't get here! " + e);
                         }
                     }
                 }
@@ -2006,6 +2071,7 @@ protected void writePayload(OutputAssembler db, final Map<Element, LayoutDecisio
                  * initial value is guessed in the MachOSection constructor.
                  */
                 assert s.destinationSegmentName != null;
+                boolean noRelocs = ourRelocs == null;
 
                 SectionInfoStruct si = new SectionInfoStruct(
                                 s.getName(),
@@ -2014,8 +2080,8 @@ protected void writePayload(OutputAssembler db, final Map<Element, LayoutDecisio
                                 (int) alreadyDecided.get(s).getDecidedValue(LayoutDecision.Kind.SIZE),
                                 (int) alreadyDecided.get(s).getDecidedValue(LayoutDecision.Kind.OFFSET),
                                 logAlignment,
-                                ourRelocs == null ? 0 : (int) alreadyDecided.get(ourRelocs).getDecidedValue(LayoutDecision.Kind.OFFSET) + ourRelocs.startIndexFor(s) * ourRelocs.encodedEntrySize(),
-                                ourRelocs == null ? 0 : ourRelocs.countFor(s),
+                                noRelocs ? 0 : (int) alreadyDecided.get(ourRelocs).getDecidedValue(LayoutDecision.Kind.OFFSET) + ourRelocs.startIndexFor(s) * ourRelocs.encodedEntrySize(),
+                                noRelocs ? 0 : ourRelocs.countFor(s),
                                 (int) ObjectFile.flagSetAsLong(s.flags) | s.type.getValue(),
                                 /* reserved1 */ 0,
                                 /* reserved2 */ 0);
@@ -2219,11 +2285,13 @@ public class LinkEditSegment64Command extends Segment64Command {
         private MachOSymtab symtab;
         private MachOStrtab strtab;
 
+        @SuppressWarnings("this-escape")
         public LinkEditSegment64Command() {
             super("LinkEditSegment", "__LINKEDIT");
             initprot = EnumSet.of(VMProt.READ); // always give read permission
             // native tools give maximum maxprot
             maxprot = EnumSet.of(VMProt.READ, VMProt.WRITE, VMProt.EXECUTE);
+            setLoadable(true);
         }
 
         public MachOSymtab getSymtab() {
@@ -2377,4 +2445,30 @@ protected void writePayload(OutputAssembler out, Map<Element, LayoutDecisionMap>
             }
         };
     }
+
+    @Override
+    public List<String> getDebugSectionNames() {
+        return DSYMSectionName.debugSections;
+    }
+
+    /*
+     * Used to help correctly determine addresses for debug info sections. Also @see
+     * NativeImageDebugInfoFeature.beforeImageWrite method where we construct corresponding linker
+     * option.
+     */
+    @Override
+    public long getCodeBaseAddress() {
+        return PAGEZERO_SIZE;
+    }
+
+    @Override
+    public void installDebugInfo(DebugInfoProvider debugInfoProvider) {
+        new DSYMDebugInfo(
+                        MachOCpuType.from(ImageSingletons.lookup(Platform.class).getArchitecture()),
+                        getByteOrder(),
+                        s -> {
+                            newDebugSection(DWARF_SEGMENT_NAME, s.getSectionName(), s);
+                            createDefinedSymbol(s.getSectionName(), s.getElement(), 0, 0, false, false);
+                        }).installDebugInfo(debugInfoProvider, getCodeBaseAddress() + getPageSize());
+    }
 }