[llvm-objdump] Fix llvm-objdump --all-headers output order

[justice_adams]

Summary

Made llvm-objdump --all-headers output match the order of GNU objdump for compatibility reasons.

Old order of the headers output:

• file header
• section header table
• symbol table
• program header table
• dynamic section

New order of the headers output (GNU compatible):

• file header information
• program header table
• dynamic section
• section header table
• symbol table

I've ensured all lit tests pass on Windows and Linux with the following changes

[justice_adams]

Relevant BugZilla Bug: https://bugs.llvm.org/show_bug.cgi?id=41830

[ychen]

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

11 ↗

(On Diff #219362)

This probably still needs to be checked.

I would expect:

# CHECK-EMPTY:
# CHECK-NEXT: Program Header:
# CHECK: Dynamic Section:
# CHECK: Sections:
# CHECK: SYMBOL TABLE:

[justice_adams]

Restored check-empty check as suggested by @ychen

[grimar]

Please reupload the patch with context so that reviewers could see lines around your changes (https://llvm.org/docs/Phabricator.html#id4).

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

14 ↗

(On Diff #219619)

nit: excessive space.

[MaskRay]

Looks reasonable. Verified that check-lld (a heavy llvm-objdump user) also passed.

[jhenderson]

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

12 ↗

(On Diff #219619)

I think this still needs to be CHECK-NEXT to show that there is exactly one line between start address: and Program Header:

[justice_adams]

@grimar my apologies. I reuploaded the patch with more context according to the documentation you linked! Also, made the changes suggested via the comments above

[jhenderson]

LGTM.

[grimar]

LGTM. Thanks!

[justice_adams]

Thanks for the review all. I don't have commit access, @grimar could you commit this for me?

llvm/trunk/test/tools/llvm-objdump/all-headers.test

 # RUN: yaml2obj %s > %t
 # RUN: llvm-objdump --all-headers %t | FileCheck %s
 
 ## Check we print file format, architecture and start address followed by the
 ## other data when using --all-headers.
 
 # CHECK:       file format ELF64-x86-64
 # CHECK-EMPTY:
 # CHECK-NEXT:  architecture: x86_64
 # CHECK-NEXT:  start address: 0x0000000000000000
 # CHECK-EMPTY:
-# CHECK-NEXT:  Sections:
-# CHECK: SYMBOL TABLE:
-# CHECK: Program Header:
+# CHECK-NEXT: Program Header:
 # CHECK: Dynamic Section:
+# CHECK: Sections:
+# CHECK: SYMBOL TABLE:
 
 ## Check how we dump the archives.
 ## Check we dump the appropriate headers for each file in the archive.
 
 # RUN: cp %t %t2
 # RUN: rm -f %t.a
 # RUN: llvm-ar rcs %t.a %t %t2
 # RUN: llvm-objdump --all-headers %t.a | FileCheck %s --check-prefix=ARCHIVE
 
 # ARCHIVE: {{.*}}.a({{.*}}):   file format ELF64-x86-64
 # ARCHIVE: architecture: x86_64
 # ARCHIVE: start address: 0x0000000000000000
 # ARCHIVE: rw-r--r--
-# ARCHIVE: Sections:
-# ARCHIVE: SYMBOL TABLE:
 # ARCHIVE: Program Header:
 # ARCHIVE: Dynamic Section:
+# ARCHIVE: Sections:
+# ARCHIVE: SYMBOL TABLE:
 # ARCHIVE: {{.*}}.a({{.*}}2):   file format ELF64-x86-64
 # ARCHIVE: architecture: x86_64
 # ARCHIVE: start address: 0x0000000000000000
 # ARCHIVE: rw-r--r--
-# ARCHIVE: Sections:
-# ARCHIVE: SYMBOL TABLE:
 # ARCHIVE: Program Header:
 # ARCHIVE: Dynamic Section:
+# ARCHIVE: Sections:
+# ARCHIVE: SYMBOL TABLE:
 
 !ELF
 FileHeader:
   Class:           ELFCLASS64
   Data:            ELFDATA2LSB
   Type:            ET_EXEC
   Machine:         EM_X86_64
 Sections:

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

static void dumpObject(ObjectFile *O, const Archive *A = nullptr,
   if (ArchiveHeaders && !MachOOpt && C)
     printArchiveChild(ArchiveName, *C);
   if (Disassemble)
     disassembleObject(O, Relocations);
   if (Relocations && !Disassemble)
     printRelocations(O);
   if (DynamicRelocations)
     printDynamicRelocations(O);
+  if (PrivateHeaders || FirstPrivateHeader)
+    printPrivateFileHeaders(O, FirstPrivateHeader);
   if (SectionHeaders)
     printSectionHeaders(O);
   if (SectionContents)
     printSectionContents(O);
   if (SymbolTable)
     printSymbolTable(O, ArchiveName);
   if (UnwindInfo)
     printUnwindInfo(O);
-  if (PrivateHeaders || FirstPrivateHeader)
-    printPrivateFileHeaders(O, FirstPrivateHeader);
   if (ExportsTrie)
     printExportsTrie(O);
   if (Rebase)
     printRebaseTable(O);
   if (Bind)
     printBindTable(O);
   if (LazyBind)
     printLazyBindTable(O);