[llvm-readelf] Print "File: lib.a(file.o)" info when dumping archive files.

[ychen]

Summary

Match GNU readelf.

https://bugs.llvm.org/show_bug.cgi?id=35351

[MaskRay]

llvm/test/tools/llvm-readobj/macho-universal-x86_64.i386.test

151 ↗

(On Diff #208479)

There was one empty line between } and File: , now there are two, due to the Writer.startLine() << "\n"; change.

llvm/tools/llvm-readobj/llvm-readobj.cpp

604 ↗

(On Diff #208479)

This will give us a trailing empty line. I think in a few other places, we do:

if (not first)
  print a new line

This pattern will not have a trailing empty line.

I think these probably don't matter but it'd be great if we can be consistent in the future..

[ychen]

• update

[ychen]

Thank you for capturing that. The added new line in the previous revision is for GNU output. I should have done what LLVM output did: add a prefixing new line.

[MaskRay]

llvm/test/tools/llvm-readobj/macho-universal-x86_64.i386.test

167 ↗

(On Diff #208572)

Add a MULTIHEADER-ARCHIVE-EMPTY: and change this line to:
MULTIHEADER-ARCHIVE-NEXT: File: [[ARFILE]](foo.o)
to capture the newline issue.

[ychen]

• update

[MaskRay]

llvm/test/tools/llvm-readobj/macho-universal-x86_64.i386.test

167 ↗

(On Diff #208572)

For consistency other File: should receive the same treatment..

[grimar]

LGTM

[jhenderson]

Looks good aside from a couple of minor points.

llvm/test/tools/llvm-readobj/archive.test

5 ↗

(On Diff #208589)

Nit: I don't think it matters too much, but -D is a single-letter option, so would normally only have one dash before it.

8 ↗

(On Diff #208589)

I think in this test particularly, you should check that there are the right number of new lines before and after "File: ..." using appropriate CHECK-NEXT/EMPTY markers.

llvm/test/tools/llvm-readobj/thin-archive-paths.test

11 ↗

(On Diff #208589)

nit --DARFILE -> -DARFILE

[ychen]

• update

[jhenderson]

LGTM.

llvm/trunk/test/tools/llvm-readobj/archive.test

 # Show that dumping operations apply to all members in an archive.
 
 # RUN: rm -f %t.a
 # RUN: llvm-ar rc %t.a %p/Inputs/trivial.obj.elf-x86-64 %p/Inputs/trivial.obj.elf-i386 %p/Inputs/trivial.obj.coff-arm
-# RUN: llvm-readobj --all %t.a | FileCheck %s --check-prefixes=LLVM,COFF
-# RUN: llvm-readelf --all %t.a | FileCheck %s --check-prefixes=GNU,COFF
+# RUN: llvm-readobj --all %t.a | FileCheck %s -DARFILE="%t.a" --check-prefixes=HEADER,LLVM,COFF
+# RUN: llvm-readelf --all %t.a | FileCheck %s -DARFILE="%t.a" --check-prefixes=HEADER,GNU,COFF
 
-# LLVM: File: trivial.obj.elf-x86-64
+# LLVM: {{^$}}
+# LLVM-NEXT: File: [[ARFILE]](trivial.obj.elf-x86-64)
 # LLVM: Format: ELF64-x86-64
 # LLVM: ElfHeader {
 # LLVM:   Machine: EM_X86_64
 # LLVM: Sections [
 # LLVM: Relocations [
 # LLVM: Symbols [
+# LLVM: Notes [
+# LLVM: ]
 
+# GNU: {{^$}}
+# GNU-NEXT: File: [[ARFILE]](trivial.obj.elf-x86-64)
 # GNU: ELF Header:
 # GNU:   Machine: Advanced Micro Devices X86-64
 # GNU: Section Headers:
 # GNU: Relocation section '.rela.text'
 # GNU: Symbol table '.symtab'
+# GNU: There are no section groups in this file.
 
-# LLVM: File: trivial.obj.elf-i386
+# LLVM-EMPTY:
+# LLVM-NEXT: File: [[ARFILE]](trivial.obj.elf-i386)
 # LLVM: Format: ELF32-i386
 # LLVM: ElfHeader {
 # LLVM:   Machine: EM_386
 # LLVM: Sections [
 # LLVM: Relocations [
 # LLVM: Symbols [
+# LLVM: Notes [
+# LLVM: ]
 
+# GNU-EMPTY:
+# GNU-NEXT: File: [[ARFILE]](trivial.obj.elf-i386)
 # GNU: ELF Header:
 # GNU:   Machine: Intel 80386
 # GNU: Section Headers:
 # GNU: Relocation section '.rel.text'
 # GNU: Symbol table '.symtab'
+# GNU: There are no section groups in this file.
 
-# LLVM: File: trivial.obj.coff-arm
+# LLVM-EMPTY:
+# LLVM-NEXT: File: [[ARFILE]](trivial.obj.coff-arm)
 # LLVM: Format: COFF-ARM
+# GNU-EMPTY:
+# GNU-NEXT: File: [[ARFILE]](trivial.obj.coff-arm)
 # COFF: ImageFileHeader {
 # COFF:   Machine: IMAGE_FILE_MACHINE_ARMNT
 # COFF: Sections [
 # COFF: Relocations [
 # COFF: Symbols [

llvm/trunk/test/tools/llvm-readobj/elf-dynamic-malformed.test

 # WARN:      ]
 # WARN-EMPTY:
 ## A warning is printed at the place where a normal dynamic table should be. 
 # WARN-NEXT: warning: invalid section size (4) or entity size (16)
 # WARN-NEXT: ProgramHeaders [
 
 # WARN-GNU-NOT:  warning
 # WARN-GNU:      warning: invalid section size (4) or entity size (16)
+# WARN-GNU-EMPTY:
 # WARN-GNU-NEXT: ELF Header:
 # WARN-GNU:      Symbol table '.symtab' contains 1 entries:
 # WARN-GNU:        0:
 # WARN-GNU-EMPTY:
 ## A warning is printed at the place where a normal dynamic table should be. 
 # WARN-GNU:      warning: invalid section size (4) or entity size (16)
 # WARN-GNU-EMPTY:
 

llvm/trunk/test/tools/llvm-readobj/macho-universal-x86_64.i386.test

 RUN: llvm-readobj -h %p/Inputs/macho-universal.x86_64.i386 \
 RUN: | FileCheck %s -check-prefix MULTIHEADER
 
 RUN: llvm-readobj --sections %p/Inputs/macho-universal.x86_64.i386 \
 RUN: | FileCheck %s -check-prefix MULTISECTIONS
 
 RUN: llvm-readobj -h %p/Inputs/macho-universal-archive.x86_64.i386 \
-RUN: | FileCheck %s -check-prefix MULTIHEADER-ARCHIVE
+RUN: | FileCheck %s -check-prefix MULTIHEADER-ARCHIVE \
+RUN:                -DARFILE="%p/Inputs/macho-universal-archive.x86_64.i386"
 
 RUN: llvm-readobj --sections %p/Inputs/macho-universal-archive.x86_64.i386 \
-RUN: | FileCheck %s -check-prefix MULTISECTIONS-ARCHIVE
+RUN: | FileCheck %s -check-prefix MULTISECTIONS-ARCHIVE \
+RUN:                -DARFILE="%p/Inputs/macho-universal-archive.x86_64.i386"
 
 MULTIHEADER: Format: Mach-O 64-bit x86-64
 MULTIHEADER: Arch: x86_64
 MULTIHEADER: AddressSize: 64bit
 MULTIHEADER: MachHeader {
 MULTIHEADER:   Magic: Magic64 (0xFEEDFACF)
 MULTIHEADER:   CpuType: X86-64 (0x1000007)
 MULTIHEADER:   CpuSubType: CPU_SUBTYPE_X86_64_ALL (0x3)

 MULTISECTIONS:     Type: 0x0
 MULTISECTIONS:     Attributes [ (0x0)
 MULTISECTIONS:     ]
 MULTISECTIONS:     Reserved1: 0x0
 MULTISECTIONS:     Reserved2: 0x0
 MULTISECTIONS:   }
 MULTISECTIONS: ]
 
-MULTIHEADER-ARCHIVE: File: hello.o
+MULTIHEADER-ARCHIVE: {{^$}}
+MULTIHEADER-ARCHIVE-NEXT: File: [[ARFILE]](hello.o)
 MULTIHEADER-ARCHIVE: Format: Mach-O 64-bit x86-64
 MULTIHEADER-ARCHIVE: Arch: x86_64
 MULTIHEADER-ARCHIVE: AddressSize: 64bit
 MULTIHEADER-ARCHIVE: MachHeader {
 MULTIHEADER-ARCHIVE:   Magic: Magic64 (0xFEEDFACF)
 MULTIHEADER-ARCHIVE:   CpuType: X86-64 (0x1000007)
 MULTIHEADER-ARCHIVE:   CpuSubType: CPU_SUBTYPE_X86_64_ALL (0x3)
 MULTIHEADER-ARCHIVE:   FileType: Relocatable (0x1)
 MULTIHEADER-ARCHIVE:   NumOfLoadCommands: 3
 MULTIHEADER-ARCHIVE:   SizeOfLoadCommands: 496
 MULTIHEADER-ARCHIVE:   Flags [ (0x2000)
 MULTIHEADER-ARCHIVE:     MH_SUBSECTIONS_VIA_SYMBOLS (0x2000)
 MULTIHEADER-ARCHIVE:   ]
 MULTIHEADER-ARCHIVE:   Reserved: 0x0
 MULTIHEADER-ARCHIVE: }
-MULTIHEADER-ARCHIVE: File: foo.o
+MULTIHEADER-ARCHIVE-EMPTY:
+MULTIHEADER-ARCHIVE-NEXT: File: [[ARFILE]](foo.o)
 MULTIHEADER-ARCHIVE: Format: Mach-O 32-bit i386
 MULTIHEADER-ARCHIVE: Arch: i386
 MULTIHEADER-ARCHIVE: AddressSize: 32bit
 MULTIHEADER-ARCHIVE: MachHeader {
 MULTIHEADER-ARCHIVE:   Magic: Magic (0xFEEDFACE)
 MULTIHEADER-ARCHIVE:   CpuType: X86 (0x7)
 MULTIHEADER-ARCHIVE:   CpuSubType: CPU_SUBTYPE_I386_ALL (0x3)
 MULTIHEADER-ARCHIVE:   FileType: Relocatable (0x1)
 MULTIHEADER-ARCHIVE:   NumOfLoadCommands: 3
 MULTIHEADER-ARCHIVE:   SizeOfLoadCommands: 296
 MULTIHEADER-ARCHIVE:   Flags [ (0x2000)
 MULTIHEADER-ARCHIVE:     MH_SUBSECTIONS_VIA_SYMBOLS (0x2000)
 MULTIHEADER-ARCHIVE:   ]
 MULTIHEADER-ARCHIVE: }
 
-MULTISECTIONS-ARCHIVE: File: hello.o
+MULTISECTIONS-ARCHIVE: {{^$}}
+MULTISECTIONS-ARCHIVE-NEXT: File: [[ARFILE]](hello.o)
 MULTISECTIONS-ARCHIVE: Format: Mach-O 64-bit x86-64
 MULTISECTIONS-ARCHIVE: Arch: x86_64
 MULTISECTIONS-ARCHIVE: AddressSize: 64bit
 MULTISECTIONS-ARCHIVE: Sections [
 MULTISECTIONS-ARCHIVE:   Section {
 MULTISECTIONS-ARCHIVE:     Index: 0
 MULTISECTIONS-ARCHIVE:     Name: __text (5F 5F 74 65 78 74 00 00 00 00 00 00 00 00 00 00)
 MULTISECTIONS-ARCHIVE:     Segment: __TEXT (5F 5F 54 45 58 54 00 00 00 00 00 00 00 00 00 00)

 MULTISECTIONS-ARCHIVE:       LiveSupport (0x80000)
 MULTISECTIONS-ARCHIVE:       NoTOC (0x400000)
 MULTISECTIONS-ARCHIVE:       StripStaticSyms (0x200000)
 MULTISECTIONS-ARCHIVE:     ]
 MULTISECTIONS-ARCHIVE:     Reserved1: 0x0
 MULTISECTIONS-ARCHIVE:     Reserved2: 0x0
 MULTISECTIONS-ARCHIVE:   }
 MULTISECTIONS-ARCHIVE: ]
-MULTISECTIONS-ARCHIVE: File: foo.o
+MULTISECTIONS-ARCHIVE-EMPTY:
+MULTISECTIONS-ARCHIVE-NEXT: File: [[ARFILE]](foo.o)
 MULTISECTIONS-ARCHIVE: Format: Mach-O 32-bit i386
 MULTISECTIONS-ARCHIVE: Arch: i386
 MULTISECTIONS-ARCHIVE: AddressSize: 32bit
 MULTISECTIONS-ARCHIVE: Sections [
 MULTISECTIONS-ARCHIVE:   Section {
 MULTISECTIONS-ARCHIVE:     Index: 0
 MULTISECTIONS-ARCHIVE:     Name: __text (5F 5F 74 65 78 74 00 00 00 00 00 00 00 00 00 00)
 MULTISECTIONS-ARCHIVE:     Segment: __TEXT (5F 5F 54 45 58 54 00 00 00 00 00 00 00 00 00 00)

llvm/trunk/test/tools/llvm-readobj/thin-archive-paths.test

 # RUN: rm -rf %t
 # RUN: mkdir -p %t/a/b
 # RUN: cd %t
 # RUN: cp %p/Inputs/trivial.obj.elf-x86-64 a/b/1.o
 # The archive is deliberately in a different directory to the cwd, to show that
 # the member paths printed are exactly what's in the archive and not relative
 # to the cwd.
 # RUN: llvm-ar rcT a/relative.a a/b/1.o
 
 # Show that relative paths in the file header printing look sensible.
-# RUN: llvm-readobj --file-headers a/relative.a | FileCheck %s --check-prefix=REL
-# REL: File: b/1.o
+# RUN: llvm-readobj --file-headers a/relative.a | FileCheck %s -DARFILE="a/relative.a" --check-prefix=REL
+# REL: File: [[ARFILE]](b/1.o)
 
 # Show that relative paths in an error message for both archive and member look
 # sensible.
 # RUN: rm a/b/1.o
 # RUN: not llvm-readobj --file-headers a/relative.a 2>&1 | FileCheck %s --check-prefix=ERR1
 # RUN: not llvm-readelf --file-headers a/relative.a 2>&1 | FileCheck %s --check-prefix=ERR1
 # ERR1: error: 'a/relative.a': 'b/1.o': {{[Nn]}}o such file or directory
 
 # RUN: mkdir -p %t/c
 # RUN: cp %p/Inputs/trivial.obj.elf-x86-64 a/b/1.o
 # RUN: llvm-ar rcT c/absolute.a %t/a/b/1.o
 
 # Show that absolute paths in the file header printing are correct.
-# RUN: llvm-readobj --file-headers c/absolute.a | FileCheck %s --check-prefix=ABS -DDIR=%/t
-# ABS: File: [[DIR]]/a/b/1.o
+# RUN: llvm-readobj --file-headers c/absolute.a | FileCheck %s --check-prefix=ABS -DARFILE="c/absolute.a" -DDIR=%/t
+# ABS: File: [[ARFILE]]([[DIR]]/a/b/1.o)
 
 # Show that absolute paths in an error message for both archive and member are correct.
 # RUN: rm a/b/1.o
 # RUN: not llvm-readobj --file-headers %/t/c/absolute.a 2>&1 | FileCheck %s --check-prefix=ERR2 -DDIR=%/t
 # RUN: not llvm-readelf --file-headers %/t/c/absolute.a 2>&1 | FileCheck %s --check-prefix=ERR2 -DDIR=%/t
 # ERR2: error: '[[DIR]]/c/absolute.a': '[[DIR]]/a/b/1.o': {{[Nn]}}o such file or directory

llvm/trunk/tools/llvm-readobj/llvm-readobj.cpp

if (Obj->isWasm())
     return createWasmDumper(Obj, Writer, Result);
   if (Obj->isXCOFF())
     return createXCOFFDumper(Obj, Writer, Result);
 
   return readobj_error::unsupported_obj_file_format;
 }
 
 /// Dumps the specified object file.
-static void dumpObject(const ObjectFile *Obj, ScopedPrinter &Writer) {
+static void dumpObject(const ObjectFile *Obj, ScopedPrinter &Writer,
+                       const Archive *A = nullptr) {
+  std::string FileStr =
+          A ? Twine(A->getFileName() + "(" + Obj->getFileName() + ")").str()
+            : Obj->getFileName().str();
+
   std::unique_ptr<ObjDumper> Dumper;
   if (std::error_code EC = createDumper(Obj, Writer, Dumper))
-    reportError(Obj->getFileName(), EC);
+    reportError(FileStr, EC);
 
-  if (opts::Output == opts::LLVM) {
-    Writer.startLine() << "\n";
-    Writer.printString("File", Obj->getFileName());
+  if (opts::Output == opts::LLVM) {
+    Writer.printString("File", FileStr);
     Writer.printString("Format", Obj->getFileFormatName());
     Writer.printString("Arch", Triple::getArchTypeName(
                                    (llvm::Triple::ArchType)Obj->getArch()));
     Writer.printString("AddressSize",
                        formatv("{0}bit", 8 * Obj->getBytesInAddress()));
     Dumper->printLoadName();
+  } else if (opts::Output == opts::GNU && A) {
+    Writer.printString("File", FileStr);
   }
 
   if (opts::FileHeaders)
     Dumper->printFileHeaders();
   if (opts::SectionHeaders)
     Dumper->printSectionHeaders();
   if (opts::Relocations)
     Dumper->printRelocations();
for (auto &Child : Arc->children(Err)) {
     Expected<std::unique_ptr<Binary>> ChildOrErr = Child.getAsBinary();
     if (!ChildOrErr) {
       if (auto E = isNotObjectErrorInvalidFileType(ChildOrErr.takeError())) {
         reportError(Arc->getFileName(), std::move(E));
       }
       continue;
     }
     if (ObjectFile *Obj = dyn_cast<ObjectFile>(&*ChildOrErr.get()))
-      dumpObject(Obj, Writer);
+      dumpObject(Obj, Writer, Arc);
     else if (COFFImportFile *Imp = dyn_cast<COFFImportFile>(&*ChildOrErr.get()))
       dumpCOFFImportFile(Imp, Writer);
     else
       reportError(Arc->getFileName(), readobj_error::unrecognized_file_format);
   }
   if (Err)
     reportError(Arc->getFileName(), std::move(Err));
 }