[llvm-objdump] Print the DEBUG type under `--section-headers`.

[Esme]

Summary

Under the option --section-headers, we can only print the section types of TEXT, DATA, and BSS for now. This patch adds the DEBUG type.

[Higuoxing]

llvm/test/tools/llvm-objdump/ELF/PowerPC/section-headers-debug.test

30 ↗

(On Diff #345798)

You can specify the 'Size' field of the section rather than the 'Content' field, e.g.,

- Name:   .data
  Type:   SHT_PROGBITS
  Flags:  [ SHF_WRITE, SHF_ALLOC ]
  Size:   0x10

43 ↗

(On Diff #345798)

Nit: remove the blank line.

llvm/tools/llvm-objdump/llvm-objdump.cpp

2192

I think we need some tests to check the output when the section has multiple types, e.g., 'DATA' and 'DEBUG'.

[jhenderson]

llvm/test/tools/llvm-objdump/ELF/PowerPC/section-headers-debug.test

1 ↗

(On Diff #345798)

Rather than having a test dedicated to a specific type field, it would make more sense to have a test that tests all type fields, probably as part of a generic --section-headers test. As such, before you add the DEBUG type, I'd recommend writing a new test/expanding an existing test for --section-headers, to test that option thoroughly (a quick skim of test/tools/llvm-objdump suggests there is no such test there, but there is objdump-sectionheaders.test in llvm/test/Object, which should probably be moved). This would be a separate patch, prior to this one.

Another point: the behaviour is not specific to PowerPC, and the test doesn't rely on the PowerPC target being available, so move the test into the ELF directory.

llvm/test/tools/llvm-objdump/XCOFF/xcoff-section-headers-debug.test

1 ↗

(On Diff #345798)

Similar comments as above. Don't have a dedicated test for the DEBUG type. Just expand the existing test.

Also, it would be preferable to use yaml2obj for this testing in the first place, rather than a canned binary, so rebase this patch on top of the related patches and wait for those to land.

llvm/tools/llvm-objdump/llvm-objdump.cpp

2192

+1 - also I think this code is actually slightly incompatible with GNU output, which uses comma separators. It should be fixed to match.

[Esme]

Address comments.

[Esme]

This comment was removed by Esme.

llvm/test/tools/llvm-objdump/ELF/PowerPC/section-headers-debug.test

1 ↗

(On Diff #345798)

There is generic test, llvm/test/tools/llvm-objdump/section-headers.test, so I just expanding it with adding the test for type fields.

[Esme]

Format.

[Higuoxing]

llvm/test/tools/llvm-objdump/XCOFF/section-headers.test

1–5

It looks that xcoff-section-headers.o and xcoff-long-sec-names.o are useless after this change. Can we remove them?

9–17

Please insert a blank space between # and TYPE-NEXT.

[Esme]

Address comment.

llvm/test/tools/llvm-objdump/XCOFF/section-headers.test

1–5

xcoff-long-sec-names.o is useless, but xcoff-section-headers.o is used by other tests. Those tests may be replaced by yaml-docs in the future, which should be another work.

[jhenderson]

Seems to me like this is two separate patches now: 1) adding generic DEBUG printing support to llvm-objdump, then 2) adding XCOFF recognition of debug section types.

llvm/test/tools/llvm-objdump/XCOFF/section-headers-truncate.test

3

You can avoid a new canned binary here by using python to truncate another file. See for example llvm/test/tools/llvm-objcopy/ELF/invalid-e_phoff.test for an example of how to do this.

llvm/test/tools/llvm-objdump/XCOFF/section-headers.test

24

We probably need to add addresses to some of these too. If memory serves correctly, ELF yaml2obj auto-increments addresses for allocatable sections, if an adderss is not explicitly specified. Perhaps a similar feature could be added to XCOFF yaml2obj in a separate patch? What do you think? In the meantime, the addresses can presumably be done manually here.

llvm/test/tools/llvm-objdump/section-headers.test

145–146

I don't think we need an entirely new dedicated test case here. I think you would be better off expanding the first yaml doc in this file to cover the new DEBUG type and a case with multiple types (to pick up the separator change), and then just updating the first set of checks.

[Esme]

In D102603#2778965, @jhenderson wrote:

Seems to me like this is two separate patches now: 1) adding generic DEBUG printing support to llvm-objdump, then 2) adding XCOFF recognition of debug section types.

Split the patch and will post the second patch for XCOFF soon.

llvm/test/tools/llvm-objdump/XCOFF/section-headers.test

24

Perhaps a similar feature could be added to XCOFF yaml2obj in a separate patch?

Sounds good to me. I will implement the feature for XCOFF yaml2obj in a follow-up work.

[jhenderson]

LGTM, thanks!

llvm/include/llvm/Object/XCOFFObjectFile.h

public:
   uint64_t getSectionSize(DataRefImpl Sec) const override;
   Expected<ArrayRef<uint8_t>>
   getSectionContents(DataRefImpl Sec) const override;
   uint64_t getSectionAlignment(DataRefImpl Sec) const override;
   bool isSectionCompressed(DataRefImpl Sec) const override;
   bool isSectionText(DataRefImpl Sec) const override;
   bool isSectionData(DataRefImpl Sec) const override;
   bool isSectionBSS(DataRefImpl Sec) const override;
+  bool isDebugSection(DataRefImpl Sec) const override;
 
   bool isSectionVirtual(DataRefImpl Sec) const override;
   relocation_iterator section_rel_begin(DataRefImpl Sec) const override;
   relocation_iterator section_rel_end(DataRefImpl Sec) const override;
 
   void moveRelocationNext(DataRefImpl &Rel) const override;
 
   /// \returns the relocation offset with the base address of the containing

llvm/lib/Object/XCOFFObjectFile.cpp

bool XCOFFObjectFile::isSectionData(DataRefImpl Sec) const {
   return Flags & (XCOFF::STYP_DATA | XCOFF::STYP_TDATA);
 }
 
 bool XCOFFObjectFile::isSectionBSS(DataRefImpl Sec) const {
   uint32_t Flags = getSectionFlags(Sec);
   return Flags & (XCOFF::STYP_BSS | XCOFF::STYP_TBSS);
 }
 
+bool XCOFFObjectFile::isDebugSection(DataRefImpl Sec) const {
+  uint32_t Flags = getSectionFlags(Sec);
+  return Flags & (XCOFF::STYP_DEBUG | XCOFF::STYP_DWARF);
+}
+
 bool XCOFFObjectFile::isSectionVirtual(DataRefImpl Sec) const {
   return is64Bit() ? toSection64(Sec)->FileOffsetToRawData == 0
                    : toSection32(Sec)->FileOffsetToRawData == 0;
 }
 
 relocation_iterator XCOFFObjectFile::section_rel_begin(DataRefImpl Sec) const {
   if (is64Bit())
     report_fatal_error("64-bit support not implemented yet");

llvm/test/tools/llvm-objdump/XCOFF/section-headers-truncate.test

+# RUN: not llvm-objdump --section-headers 2>&1 \
+# RUN: %p/Inputs/xcoff-section-headers-truncate.o | FileCheck \
+# RUN: --check-prefix=ERROR %s
+
+# ERROR: The end of the file was unexpectedly encountered

llvm/test/tools/llvm-objdump/XCOFF/section-headers.test

-# RUN: llvm-objdump --section-headers %p/Inputs/xcoff-section-headers.o | \
-# RUN: FileCheck %s
+## Test various details of llvm-objdump -h/--section-headers for XCOFF.
 
-# RUN: llvm-objdump --section-headers %p/Inputs/xcoff-long-sec-names.o | \
-# RUN: FileCheck --check-prefix=LONG %s
+## Check the `--section-headers/-h` option can print the 
+## type of sections correctly.
 
-# RUN: not llvm-objdump --section-headers 2>&1 \
-# RUN: %p/Inputs/xcoff-section-headers-truncate.o | FileCheck \
-# RUN: --check-prefix=ERROR %s
-
-# ERROR: The end of the file was unexpectedly encountered
-
-# CHECK: xcoff-section-headers.o:      file format aixcoff-rs6000
-# CHECK: Sections:
-# CHECK: Idx Name          Size     VMA      Type
-# CHECK:   0 .text         00000080 00000000 TEXT
-# CHECK:   1 .data         00000024 00000080 DATA
-# CHECK:   2 .bss          00000004 000000a4 BSS
-# CHECK:   3 .tdata        00000008 00000000 DATA
-# CHECK:   4 .tbss         00000004 00000008 BSS
-
-# xcoff-section-headers.o Compiled with IBM XL C/C++ for AIX, V16.1.0
-# test.c:
-# int a;
-# int b = 12345;
-# __thread int c;
-# __thread double d = 3.14159;
-#
-# int func(void)  {
-#   return a;
-# }
+# RUN: yaml2obj %s --docnum=1 -o %t-type.o
+# RUN: llvm-objdump --section-headers %t-type.o \
+# RUN:   | FileCheck %s --check-prefix=TYPE
+
+#TYPE:      Sections:
+#TYPE-NEXT: Idx Name          Size     VMA      Type
+#TYPE-NEXT:   0 .text         00000008 00000000 TEXT
+#TYPE-NEXT:   1 .data         00000004 00000000 DATA
+#TYPE-NEXT:   2 .bss          00000000 00000000 BSS
+#TYPE-NEXT:   3 .tdata        00000004 00000000 DATA
+#TYPE-NEXT:   4 .tbss         00000000 00000000 BSS
+#TYPE-NEXT:   5 .dwline       00000046 00000000 DEBUG
+#TYPE-NEXT:   6 .dwinfo       00000046 00000000 DEBUG
+
+--- !XCOFF
+FileHeader:
+  MagicNumber:          0x1DF
+Sections:
+  - Name:               .text
+    Size:               0x8
+    Flags:              [ STYP_TEXT ]
+  - Name:               .data
+    Size:               0x4
+    Flags:              [ STYP_DATA ]
+  - Name:               .bss
+    Size:               0x0
+    Flags:              [ STYP_BSS ]
+  - Name:               .tdata
+    Size:               0x4
+    Flags:              [ STYP_TDATA ]
+  - Name:               .tbss
+    Size:               0x0
+    Flags:              [ STYP_TBSS ]
+  - Name:               .dwline
+    Size:               0x46
+    Flags:              [ STYP_DWARF ]
+  - Name:               .dwinfo
+    Size:               0x46
+    Flags:              [ STYP_DEBUG ]
+
+## Check the `--section-headers/-h` option can print the 
+## long section names.
+
+# RUN: yaml2obj %s --docnum=2 -o %t-type.o
+# RUN: llvm-objdump --section-headers %t-type.o \
+# RUN:   | FileCheck %s --check-prefix=LONG
 
-# LONG: xcoff-long-sec-names.o:      file format aixcoff-rs6000
-# LONG: Sections:
-# LONG: Idx Name          Size     VMA      Type
-# LONG:   0 .dwarnge      00000004 00000000
-# LONG:   1 .dwpbnms      00000004 00000000
-# LONG:   2 .dwpbtyp      00000004 00000000
-
-# xcoff-long-sec-names.o was generated by assembling the following .s file:
-#  .dwsect 0x30000 # .dwpbnms section
-#  .dwsect 0x40000 # .dwpbtyp section
-#  .dwsect 0x50000 # .dwarnge section
+# LONG:      Sections:
+# LONG-NEXT: Idx Name          Size     VMA      Type
+# LONG-NEXT:   0 .dwarnge      00000004 00000000 
+# LONG-NEXT:   1 .dwpbnms      00000004 00000000 
+# LONG-NEXT:   2 .dwpbtyp      00000004 00000000 
+
+--- !XCOFF
+FileHeader:
+  MagicNumber:          0x1DF
+Sections:
+  - Name:               .dwarnge
+    Size:               0x4
+    Flags:              [ STYP_PAD ]
+  - Name:               .dwpbnms
+    Size:               0x4
+    Flags:              [ STYP_PAD ]
+  - Name:               .dwpbtyp
+    Size:               0x4
+    Flags:              [ STYP_PAD ]

llvm/test/tools/llvm-objdump/section-headers.test

FileHeader:
   Data:    ELFDATA2LSB
   Type:    ET_EXEC
   Machine: EM_386
 Sections:
   - Name:    .foo
     Type:    SHT_PROGBITS
     Flags:   [SHF_ALLOC, SHF_EXECINSTR]
     Address: 0x400
+
+## Check that the `--section-headers/-h` option prints the types of 
+## section headers correctly.
+
+# RUN: yaml2obj %s --docnum=5 -o %t-sectiontypes.o
+# RUN: llvm-objdump --section-headers %t-sectiontypes.o \
+# RUN:   | FileCheck %s --check-prefix=TYPE
+
+# TYPE:      Sections:
+# TYPE-NEXT: Idx Name          Size     VMA              Type
+# TYPE-NEXT:   0               00000000 0000000000000000 
+# TYPE-NEXT:   1 .text         00000026 0000000000000000 TEXT
+# TYPE-NEXT:   2 .data         00000010 0000000000000026 DATA
+# TYPE-NEXT:   3 .bss          00000000 0000000000000036 BSS
+# TYPE-NEXT:   4 .debug_abbrev 0000000a 0000000000000000 DEBUG
+# TYPE-NEXT:   5 .debug_info   0000000a 0000000000000040 DATA, DEBUG
+# TYPE-NEXT:   6 .strtab       00000001 0000000000000000 
+# TYPE-NEXT:   7 .shstrtab     0000003e 0000000000000000 
+
+--- !ELF
+FileHeader:
+  Class:           ELFCLASS64
+  Data:            ELFDATA2LSB
+  Type:            ET_EXEC
+  Machine:         EM_PPC64
+Sections:
+  - Name:          .text
+    Type:          SHT_PROGBITS
+    Flags:         [ SHF_ALLOC, SHF_EXECINSTR ]
+    Size:          0x26
+  - Name:          .data
+    Type:          SHT_PROGBITS
+    Flags:         [ SHF_WRITE, SHF_ALLOC ]
+    Size:          0x10
+  - Name:          .bss
+    Type:          SHT_NOBITS
+    Flags:         [ SHF_WRITE, SHF_ALLOC ]
+  - Name:          .debug_abbrev
+    Type:          SHT_PROGBITS
+    Size:          0xa
+  - Name:          .debug_info
+    Type:          SHT_PROGBITS
+    Flags:         [ SHF_WRITE, SHF_ALLOC ]
+    Size:          0xa

llvm/tools/llvm-objdump/llvm-objdump.cpp

for (const SectionRef &Section : ToolSectionFilter(*Obj, &Idx)) {
     uint64_t VMA = Section.getAddress();
     if (shouldAdjustVA(Section))
       VMA += AdjustVMA;
 
     uint64_t Size = Section.getSize();
 
     std::string Type = Section.isText() ? "TEXT" : "";
     if (Section.isData())
-      Type += Type.empty() ? "DATA" : " DATA";
+      Type += Type.empty() ? "DATA" : ", DATA";
     if (Section.isBSS())
-      Type += Type.empty() ? "BSS" : " BSS";
+      Type += Type.empty() ? "BSS" : ", BSS";
+    if (Section.isDebugSection())
+      Type += Type.empty() ? "DEBUG" : ", DEBUG";
 
     if (HasLMAColumn)
       outs() << format("%3" PRIu64 " %-*s %08" PRIx64 " ", Idx, NameWidth,
                        Name.str().c_str(), Size)
              << format_hex_no_prefix(VMA, AddressWidth) << " "
              << format_hex_no_prefix(getELFSectionLMA(Section), AddressWidth)
              << " " << Type << "\n";
     else