format fixes

Author: adinn

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

@@ -184,14 +184,14 @@ String getDirName() {
     }
 
     public void setCUIndex(int cuIndex) {
-        // should only get set once to a non-negative value
+        // Should only get set once to a non-negative value.
         assert cuIndex >= 0;
         assert this.cuIndex == -1;
         this.cuIndex = cuIndex;
     }
 
     public int getCUIndex() {
-        // should have been set before being read
+        // Should have been set before being read.
         assert cuIndex >= 0;
         return cuIndex;
     }

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

@@ -72,12 +72,12 @@ public PrimaryEntry(Range primary, List<DebugFrameSizeChange> frameSizeInfos, in
 
     public void addSubRange(Range subrange, FileEntry subFileEntry) {
         /*
-         * we should not see a subrange more than once
+         * We should not see a subrange more than once.
          */
         assert !subranges.contains(subrange);
         assert subrangeIndex.get(subrange) == null;
         /*
-         * we need to generate a file table entry for all ranges
+         * We need to generate a file table entry for all ranges.
          */
         subranges.add(subrange);
         subrangeIndex.put(subrange, subFileEntry);

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

@@ -1,6 +1,6 @@
 /*
  * Copyright (c) 2020, 2020, Oracle and/or its affiliates. All rights reserved.
- * Copyright (c) 2020, 2020, Red Hat, Inc. All rights reserved.
+ * Copyright (c) 2020, 2020, Red Hat Inc. 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
@@ -47,24 +47,24 @@ public class Range {
     private int hi;
     private int line;
     /*
-     * this is null for a primary range
+     * This is null for a primary range.
      */
     private Range primary;
 
     /*
-     * create a primary range
+     * Create a primary range.
      */
     public Range(String fileName, Path filePath, String className, String methodName, String paramNames, String returnTypeName, StringTable stringTable, int lo, int hi, int line) {
         this(fileName, filePath, className, methodName, paramNames, returnTypeName, stringTable, lo, hi, line, null);
     }
 
     /*
-     * create a primary or secondary range
+     * Create a primary or secondary range.
      */
     public Range(String fileName, Path filePath, String className, String methodName, String paramNames, String returnTypeName, StringTable stringTable, int lo, int hi, int line, 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
+         * 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.
          */
         this.fileName = (fileName == null ? null : stringTable.uniqueDebugString(fileName));
         this.filePath = filePath;

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

@@ -1,6 +1,6 @@
 /*
  * Copyright (c) 2020, 2020, Oracle and/or its affiliates. All rights reserved.
- * Copyright (c) 2020, 2020, Red Hat, Inc. All rights reserved.
+ * Copyright (c) 2020, 2020, Red Hat Inc. 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

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

@@ -1,6 +1,6 @@
 /*
  * Copyright (c) 2020, 2020, Oracle and/or its affiliates. All rights reserved.
- * Copyright (c) 2020, 2020, Red Hat, Inc. All rights reserved.
+ * Copyright (c) 2020, 2020, Red Hat Inc. 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

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

@@ -39,73 +39,73 @@
  */
 public interface DebugInfoProvider {
     /**
-     * access details of a specific type.
+     * Access details of a specific type.
      */
     interface DebugTypeInfo {
     }
 
     /**
-     * access details of a specific compiled method.
+     * Access details of a specific compiled method.
      */
     interface DebugCodeInfo {
         void debugContext(Consumer<DebugContext> action);
 
         /**
-         * @return the name of the file containing a compiled method excluding any path
+         * @return the name of the file containing a compiled method excluding any path.
          */
         String fileName();
 
         /**
          * @return a relative path to the file containing a compiled method derived from its package
-         *         name or null if the method is in the empty package
+         *         name or null if the method is in the empty package.
          */
         Path filePath();
 
         /**
-         * @return the fully qualified name of the class owning the compiled method
+         * @return the fully qualified name of the class owning the compiled method.
          */
         String className();
 
         /**
-         * @return the name of the compiled method including signature
+         * @return the name of the compiled method including signature.
          */
         String methodName();
 
         /**
          * @return the lowest address containing code generated for the method represented as an
-         *         offset into the code segment
+         *         offset into the code segment.
          */
         int addressLo();
 
         /**
          * @return the first address above the code generated for the method represented as an
-         *         offset into the code segment
+         *         offset into the code segment.
          */
         int addressHi();
 
         /**
-         * @return the starting line number for the method
+         * @return the starting line number for the method.
          */
         int line();
 
         /**
          * @return a stream of records detailing line numbers and addresses within the compiled
-         *         method
+         *         method.
          */
         Stream<DebugLineInfo> lineInfoProvider();
 
         /**
-         * @return a string identifying the method parameters
+         * @return a string identifying the method parameters.
          */
         String paramNames();
 
         /**
-         * @return a string identifying the method return type
+         * @return a string identifying the method return type.
          */
         String returnTypeName();
 
         /**
-         * @return the size of the method frame between prologue and epilogue
+         * @return the size of the method frame between prologue and epilogue.
          */
         int getFrameSize();
 
@@ -117,51 +117,51 @@ interface DebugCodeInfo {
     }
 
     /**
-     * access details of a specific heap object.
+     * Access details of a specific heap object.
      */
     interface DebugDataInfo {
     }
 
     /**
-     * access details of code generated for a specific outer or inlined method at a given line
+     * Access details of code generated for a specific outer or inlined method at a given line
      * number.
      */
     interface DebugLineInfo {
         /**
-         * @return the name of the file containing the outer or inlined method excluding any path
+         * @return the name of the file containing the outer or inlined method excluding any path.
          */
         String fileName();
 
         /**
          * @return a relative path to the file containing the outer or inlined method derived from
-         *         its package name or null if the method is in the empty package
+         *         its package name or null if the method is in the empty package.
          */
         Path filePath();
 
         /**
-         * @return the fully qualified name of the class owning the outer or inlined method
+         * @return the fully qualified name of the class owning the outer or inlined method.
          */
         String className();
 
         /**
-         * @return the name of the outer or inlined method including signature
+         * @return the name of the outer or inlined method including signature.
          */
         String methodName();
 
         /**
          * @return the lowest address containing code generated for an outer or inlined code segment
-         *         reported at this line represented as an offset into the code segment
+         *         reported at this line represented as an offset into the code segment.
          */
         int addressLo();
 
         /**
          * @return the first address above the code generated for an outer or inlined code segment
-         *         reported at this line represented as an offset into the code segment
+         *         reported at this line represented as an offset into the code segment.
          */
         int addressHi();
 
         /**
-         * @return the line number for the outer or inlined segment
+         * @return the line number for the outer or inlined segment.
          */
         int line();
     }

substratevm/src/com.oracle.objectfile/src/com/oracle/objectfile/elf/ELFObjectFile.java

@@ -1168,36 +1168,38 @@ protected int getMinimumFileSize() {
     @Override
     public void installDebugInfo(DebugInfoProvider debugInfoProvider) {
         DwarfSections dwarfSections = new DwarfSections(getMachine(), getByteOrder());
-        // we need an implementation for each section
+        /* We need an implementation for each generated DWARF section. */
         DwarfStrSectionImpl elfStrSectionImpl = dwarfSections.getStrSectionImpl();
         DwarfAbbrevSectionImpl elfAbbrevSectionImpl = dwarfSections.getAbbrevSectionImpl();
         DwarfFrameSectionImpl frameSectionImpl = dwarfSections.getFrameSectionImpl();
         DwarfInfoSectionImpl elfInfoSectionImpl = dwarfSections.getInfoSectionImpl();
         DwarfARangesSectionImpl elfARangesSectionImpl = dwarfSections.getARangesSectionImpl();
         DwarfLineSectionImpl elfLineSectionImpl = dwarfSections.getLineSectionImpl();
-        // now we can create the section elements with empty content
+        /* Now we can create the section elements with empty content. */
         newUserDefinedSection(elfStrSectionImpl.getSectionName(), elfStrSectionImpl);
         newUserDefinedSection(elfAbbrevSectionImpl.getSectionName(), elfAbbrevSectionImpl);
         newUserDefinedSection(frameSectionImpl.getSectionName(), frameSectionImpl);
         newUserDefinedSection(elfInfoSectionImpl.getSectionName(), elfInfoSectionImpl);
         newUserDefinedSection(elfARangesSectionImpl.getSectionName(), elfARangesSectionImpl);
         newUserDefinedSection(elfLineSectionImpl.getSectionName(), elfLineSectionImpl);
-        // 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
+        /*
+         * 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.
+         */
         elfStrSectionImpl.getOrCreateRelocationElement(false);
         elfAbbrevSectionImpl.getOrCreateRelocationElement(false);
         frameSectionImpl.getOrCreateRelocationElement(false);
         elfInfoSectionImpl.getOrCreateRelocationElement(false);
         elfARangesSectionImpl.getOrCreateRelocationElement(false);
         elfLineSectionImpl.getOrCreateRelocationElement(false);
-        // ok now we can populate the implementations
+        /* Ok now we can populate the debug info model. */
         dwarfSections.installDebugInfo(debugInfoProvider);
     }
 }

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

@@ -61,7 +61,7 @@ public String getSectionName() {
     public void createContent() {
         int pos = 0;
         /*
-         * we need an entry for each compilation unit
+         * We need an entry for each compilation unit.
          *
          * <ul>
          *
@@ -77,30 +77,30 @@ public void createContent() {
          *
          * </ul>
          *
-         * i.e. 12 bytes followed by padding aligning up to 2 * address size
+         * That is 12 bytes followed by padding aligning up to 2 * address size.
          *
          * <ul>
          *
          * <li><code>uint8 pad[4]</code>
          *
          * </ul>
          *
-         * followed by N + 1 times
+         * Followed by N + 1 times:
          *
          * <ul> <li><code>uint64 lo ................ lo address of range</code>
          *
          * <li><code>uint64 length ............ number of bytes in range</code>
          *
          * </ul>
          *
-         * where N is the number of ranges belonging to the compilation unit and the last range
-         * contains two zeroes
+         * Where N is the number of ranges belonging to the compilation unit and the last range
+         * contains two zeroes.
          */
 
         for (ClassEntry classEntry : getPrimaryClasses()) {
             pos += DW_AR_HEADER_SIZE;
             /*
-             * align to 2 * address size
+             * Align to 2 * address size.
              */
             pos += DW_AR_HEADER_PAD_SIZE;
             pos += classEntry.getPrimaryEntries().size() * 2 * 8;
@@ -118,8 +118,8 @@ public byte[] getOrDecideContent(Map<ObjectFile.Element, LayoutDecisionMap> alre
             Object valueObj = decisionMap.getDecidedValue(LayoutDecision.Kind.VADDR);
             if (valueObj != null && valueObj instanceof Number) {
                 /*
-                 * this may not be the final vaddr for the text segment but it will be close enough
-                 * to make debug easier i.e. to within a 4k page or two
+                 * This may not be the final vaddr for the text segment but it will be close enough
+                 * to make debug easier i.e. to within a 4k page or two.
                  */
                 debugTextBase = ((Number) valueObj).longValue();
             }
@@ -142,22 +142,22 @@ public void writeContent(DebugContext context) {
             int cuIndex = classEntry.getCUIndex();
             LinkedList<PrimaryEntry> classPrimaryEntries = classEntry.getPrimaryEntries();
             /*
-             * add room for each entry into length count
+             * Add room for each entry into length count.
              */
             length += classPrimaryEntries.size() * 2 * 8;
             length += 2 * 8;
             log(context, "  [0x%08x] %s CU %d length 0x%x", pos, classEntry.getFileName(), cuIndex, length);
             pos = putInt(length, buffer, pos);
-            /* dwarf version is always 2 */
+            /* DWARF version is always 2. */
             pos = putShort(DW_VERSION_2, buffer, pos);
             pos = putInt(cuIndex, buffer, pos);
-            /* address size is always 8 */
+            /* Address size is always 8. */
             pos = putByte((byte) 8, buffer, pos);
-            /* segment size is always 0 */
+            /* Segment size is always 0. */
             pos = putByte((byte) 0, buffer, pos);
             assert (pos - lastpos) == DW_AR_HEADER_SIZE;
             /*
-             * align to 2 * address size
+             * Align to 2 * address size.
              */
             for (int i = 0; i < DW_AR_HEADER_PAD_SIZE; i++) {
                 pos = putByte((byte) 0, buffer, pos);
@@ -177,7 +177,7 @@ public void writeContent(DebugContext context) {
     }
 
     /*
-     * debug_aranges section content depends on debug_info section content and offset
+     * The debug_aranges section content depends on debug_info section content and offset.
      */
     private static final String TARGET_SECTION_NAME = DW_INFO_SECTION_NAME;