[llvm-readobj] Match GNU output for DT_RPATH and DT_RUNPATH when dumping dynamic symbol table.

[ychen]

Summary

follow up on
https://reviews.llvm.org/D63084

[ychen]

• remove extra bracket

Thank you for the review, @MaskRay. Could you help me to commit this?

[jhenderson]

LGTM too. I'll leave @MaskRay to commit, unless he wants someone else to look.

lld/test/ELF/new-dtags.test

 # REQUIRES: x86
 // RUN: llvm-mc -filetype=obj -triple=x86_64-pc-linux %s -o %t.o
 // RUN: ld.lld %t.o -rpath=/somepath -shared --disable-new-dtags -o %t
 // RUN: llvm-readobj --dynamic-table %t | FileCheck --check-prefix=DISABLE %s
 
 // RUN: ld.lld %t.o -rpath=/somepath -shared --enable-new-dtags -o %t2
 // RUN: llvm-readobj --dynamic-table %t2 | FileCheck --check-prefix=ENABLE %s
 
 // RUN: ld.lld %t.o -rpath=/somepath -shared --disable-new-dtags --enable-new-dtags -o %t2
 // RUN: llvm-readobj --dynamic-table %t2 | FileCheck --check-prefix=ENABLE %s
 
 // DISABLE: DynamicSection [
-// DISABLE:   0x000000000000000F RPATH                /somepath
+// DISABLE:   0x000000000000000F RPATH    Library rpath: [/somepath]
 // DISABLE-NOT: RUNPATH
 // DISABLE: ]
 
 // ENABLE: DynamicSection [
-// ENABLE:   0x000000000000001D RUNPATH              /somepath
+// ENABLE:   0x000000000000001D RUNPATH   Library runpath: [/somepath]
 // ENABLE-NOT: RPATH
 // ENABLE: ]

lld/test/ELF/shared-ppc64.s

 // CHECK-NEXT: Size: [[RELSIZE:.*]]
 // CHECK-NEXT: Link:
 // CHECK-NEXT: Info:
 // CHECK-NEXT: AddressAlignment:
 // CHECK-NEXT: EntrySize: [[RELENT:.*]]
 
 // CHECK:      DynamicSection [
 // CHECK-NEXT:   Tag                Type                 Name/Value
-// CHECK-NEXT:   0x000000000000001D RUNPATH              foo:bar
+// CHECK-NEXT:   0x000000000000001D RUNPATH              Library runpath: [foo:bar]
 // CHECK-NEXT:   0x0000000000000001 NEEDED               Shared library: [{{.*}}2.so]
 // CHECK-NEXT:   0x0000000000000015 DEBUG                0x0
 // CHECK-NEXT:   0x0000000000000007 RELA                 [[RELADDR]]
 // CHECK-NEXT:   0x0000000000000008 RELASZ               [[RELSIZE]] (bytes)
 // CHECK-NEXT:   0x0000000000000009 RELAENT              [[RELENT]] (bytes)
 // CHECK:        0x0000000000000000 NULL                 0x0
 // CHECK-NEXT: ]
 
 .global _start
 _start:
 .data
 .long bar
 .long zed
 

lld/test/ELF/shared.s

 // DONT_EXPORT-NEXT:     Type: None
 // DONT_EXPORT-NEXT:     Other: 0
 // DONT_EXPORT-NEXT:     Section: Undefined
 // DONT_EXPORT-NEXT:   }
 // DONT_EXPORT-NEXT: ]
 
 // CHECK:      DynamicSection [
 // CHECK-NEXT:   Tag        Type                 Name/Value
-// CHECK-NEXT:   0x0000001D RUNPATH              foo:bar
+// CHECK-NEXT:   0x0000001D RUNPATH              Library runpath: [foo:bar]
 // CHECK-NEXT:   0x00000001 NEEDED               Shared library: [{{.*}}2.so]
 // CHECK-NEXT:   0x00000015 DEBUG                0x0
 // CHECK-NEXT:   0x00000011 REL                  [[RELADDR]]
 // CHECK-NEXT:   0x00000012 RELSZ                [[RELSIZE]] (bytes)
 // CHECK-NEXT:   0x00000013 RELENT               [[RELENT]] (bytes)
 // CHECK-NEXT:   0x00000006 SYMTAB               [[DYNSYMADDR]]
 // CHECK-NEXT:   0x0000000B SYMENT               [[SYMENT]] (bytes)
 // CHECK-NEXT:   0x00000005 STRTAB               [[DYNSTRADDR]]

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

 # RUN: llvm-readelf --dynamic-table %t.bad-string | FileCheck %s --check-prefix BAD-STRING-GNU
 
 # BAD-STRING-LLVM: 0x000000000000000A STRSZ         1 (bytes)
 # BAD-STRING-LLVM: 0x0000000000000001 NEEDED        Shared library: <Invalid offset 0x1>
 # BAD-STRING-LLVM: 0x000000007FFFFFFF FILTER        Filter library: <Invalid offset 0x1>
 # BAD-STRING-LLVM: 0x000000007FFFFFFD AUXILIARY     Auxiliary library: <Invalid offset 0x1>
 # BAD-STRING-LLVM: 0x000000007FFFFFFE USED          Not needed object: <Invalid offset 0x1>
 # BAD-STRING-LLVM: 0x000000000000000E SONAME        Library soname: <Invalid offset 0x1>
-# BAD-STRING-LLVM: 0x000000000000000F RPATH         <Invalid offset 0x1>
-# BAD-STRING-LLVM: 0x000000000000001D RUNPATH       <Invalid offset 0x1>
+# BAD-STRING-LLVM: 0x000000000000000F RPATH         Library rpath: <Invalid offset 0x1>
+# BAD-STRING-LLVM: 0x000000000000001D RUNPATH       Library runpath: <Invalid offset 0x1>
 
 # BAD-STRING-GNU:  0x000000000000000a (STRSZ)       1 (bytes)
 # BAD-STRING-GNU:  0x0000000000000001 (NEEDED)      Shared library: <Invalid offset 0x1>
 # BAD-STRING-GNU:  0x000000007fffffff (FILTER)      Filter library: <Invalid offset 0x1>
 # BAD-STRING-GNU:  0x000000007ffffffd (AUXILIARY)   Auxiliary library: <Invalid offset 0x1>
 # BAD-STRING-GNU:  0x000000007ffffffe (USED)        Not needed object: <Invalid offset 0x1>
 # BAD-STRING-GNU:  0x000000000000000e (SONAME)      Library soname: <Invalid offset 0x1>
-# BAD-STRING-GNU:  0x000000000000000f (RPATH)       <Invalid offset 0x1>
-# BAD-STRING-GNU:  0x000000000000001d (RUNPATH)     <Invalid offset 0x1>
+# BAD-STRING-GNU:  0x000000000000000f (RPATH)       Library rpath: <Invalid offset 0x1>
+# BAD-STRING-GNU:  0x000000000000001d (RUNPATH)     Library runpath: <Invalid offset 0x1>
 
 --- !ELF
 FileHeader:
   Class:   ELFCLASS64
   Data:    ELFDATA2LSB
   Type:    ET_EXEC
   Machine: EM_X86_64
 Sections:

llvm/test/tools/llvm-readobj/elf-dynamic-tags.test

 # LLVM-NEXT:   0x0000000000000007 RELA                 0x1000
 # LLVM-NEXT:   0x0000000000000008 RELASZ               16 (bytes)
 # LLVM-NEXT:   0x0000000000000009 RELAENT              1929 (bytes)
 # LLVM-NEXT:   0x000000000000000A STRSZ                16 (bytes)
 # LLVM-NEXT:   0x000000000000000B SYMENT               2439 (bytes)
 # LLVM-NEXT:   0x000000000000000C INIT                 0x1000
 # LLVM-NEXT:   0x000000000000000D FINI                 0x1000
 # LLVM-NEXT:   0x000000000000000E SONAME               Library soname: [U]
-# LLVM-NEXT:   0x000000000000000F RPATH                f
+# LLVM-NEXT:   0x000000000000000F RPATH                Library rpath: [f]
 # LLVM-NEXT:   0x0000000000000010 SYMBOLIC             0x1234567890ABCDEF
 # LLVM-NEXT:   0x0000000000000011 REL                  0x1000
 # LLVM-NEXT:   0x0000000000000012 RELSZ                16 (bytes)
 # LLVM-NEXT:   0x0000000000000013 RELENT               291 (bytes)
 # LLVM-NEXT:   0x0000000000000014 PLTREL               RELA
 # LLVM-NEXT:   0x0000000000000015 DEBUG                0xFEDCBA0987654321
 # LLVM-NEXT:   0x0000000000000016 TEXTREL              0x1122334455667788
 # LLVM-NEXT:   0x0000000000000017 JMPREL               0x1000
 # LLVM-NEXT:   0x0000000000000018 BIND_NOW             0x8877665544332211
 # LLVM-NEXT:   0x0000000000000019 INIT_ARRAY           0x1000
 # LLVM-NEXT:   0x000000000000001A FINI_ARRAY           0x1000
 # LLVM-NEXT:   0x000000000000001B INIT_ARRAYSZ         16 (bytes)
 # LLVM-NEXT:   0x000000000000001C FINI_ARRAYSZ         16 (bytes)
-# LLVM-NEXT:   0x000000000000001D RUNPATH              w
+# LLVM-NEXT:   0x000000000000001D RUNPATH              Library runpath: [w]
 # LLVM-NEXT:   0x000000000000001E FLAGS                ORIGIN SYMBOLIC TEXTREL BIND_NOW STATIC_TLS {{$}}
 # LLVM-NEXT:   0x0000000000000020 PREINIT_ARRAY        0x1000
 # LLVM-NEXT:   0x0000000000000021 PREINIT_ARRAYSZ      16 (bytes)
 # LLVM-NEXT:   0x0000000000000022 SYMTAB_SHNDX         0x1000
 # LLVM-NEXT:   0x0000000000000023 RELRSZ               0x10
 # LLVM-NEXT:   0x0000000000000024 RELR                 0x1000
 # LLVM-NEXT:   0x0000000000000025 RELRENT              0x4321
 # LLVM-NEXT:   0x000000006000000F ANDROID_REL          0x1000

 # GNU-NEXT:   0x0000000000000007 (RELA)               0x1000
 # GNU-NEXT:   0x0000000000000008 (RELASZ)             16 (bytes)
 # GNU-NEXT:   0x0000000000000009 (RELAENT)            1929 (bytes)
 # GNU-NEXT:   0x000000000000000a (STRSZ)              16 (bytes)
 # GNU-NEXT:   0x000000000000000b (SYMENT)             2439 (bytes)
 # GNU-NEXT:   0x000000000000000c (INIT)               0x1000
 # GNU-NEXT:   0x000000000000000d (FINI)               0x1000
 # GNU-NEXT:   0x000000000000000e (SONAME)             Library soname: [U]
-# GNU-NEXT:   0x000000000000000f (RPATH)              f
+# GNU-NEXT:   0x000000000000000f (RPATH)              Library rpath: [f]
 # GNU-NEXT:   0x0000000000000010 (SYMBOLIC)           0x1234567890abcdef
 # GNU-NEXT:   0x0000000000000011 (REL)                0x1000
 # GNU-NEXT:   0x0000000000000012 (RELSZ)              16 (bytes)
 # GNU-NEXT:   0x0000000000000013 (RELENT)             291 (bytes)
 # GNU-NEXT:   0x0000000000000014 (PLTREL)             RELA
 # GNU-NEXT:   0x0000000000000015 (DEBUG)              0xfedcba0987654321
 # GNU-NEXT:   0x0000000000000016 (TEXTREL)            0x1122334455667788
 # GNU-NEXT:   0x0000000000000017 (JMPREL)             0x1000
 # GNU-NEXT:   0x0000000000000018 (BIND_NOW)           0x8877665544332211
 # GNU-NEXT:   0x0000000000000019 (INIT_ARRAY)         0x1000
 # GNU-NEXT:   0x000000000000001a (FINI_ARRAY)         0x1000
 # GNU-NEXT:   0x000000000000001b (INIT_ARRAYSZ)       16 (bytes)
 # GNU-NEXT:   0x000000000000001c (FINI_ARRAYSZ)       16 (bytes)
-# GNU-NEXT:   0x000000000000001d (RUNPATH)            w
+# GNU-NEXT:   0x000000000000001d (RUNPATH)            Library runpath: [w]
 # GNU-NEXT:   0x000000000000001e (FLAGS)              ORIGIN SYMBOLIC TEXTREL BIND_NOW STATIC_TLS {{$}}
 # GNU-NEXT:   0x0000000000000020 (PREINIT_ARRAY)      0x1000
 # GNU-NEXT:   0x0000000000000021 (PREINIT_ARRAYSZ)    16 (bytes)
 # GNU-NEXT:   0x0000000000000022 (SYMTAB_SHNDX)       0x1000
 # GNU-NEXT:   0x0000000000000023 (RELRSZ)             0x10
 # GNU-NEXT:   0x0000000000000024 (RELR)               0x1000
 # GNU-NEXT:   0x0000000000000025 (RELRENT)            0x4321
 # GNU-NEXT:   0x000000006000000f (ANDROID_REL)        0x1000

llvm/test/tools/llvm-readobj/rpath.test

 RUN: llvm-readobj --dynamic-table %p/Inputs/rpath.exe.elf-x86_64 \
 RUN:   | FileCheck %s
 
-CHECK: 0x000000000000000F RPATH /usr/local/lib
+CHECK: 0x000000000000000F RPATH  Library rpath: [/usr/local/lib]

llvm/tools/llvm-readobj/ELFDumper.cpp

private:
   DynRegionInfo createDRIFrom(const Elf_Shdr *S) {
     return checkDRI(
         {ObjF->getELFFile()->base() + S->sh_offset, S->sh_size, S->sh_entsize});
   }
 
   void loadDynamicTable(const ELFFile<ELFT> *Obj);
   void parseDynamicTable();
 
-  void printDynamicString(uint64_t Offset, raw_ostream &OS,
-                          bool WithBracket = true) const;
   StringRef getSymbolVersion(StringRef StrTab, const Elf_Sym *symb,
                              bool &IsDefault) const;
   void LoadVersionMap() const;
   void LoadVersionNeeds(const Elf_Shdr *ec) const;
   void LoadVersionDefs(const Elf_Shdr *sec) const;
 
   const object::ELFObjectFile<ELFT> *ObjF;
   DynRegionInfo DynRelRegion;
void printFlags(T Value, ArrayRef<EnumEntry<TFlag>> Flags, raw_ostream &OS) {
   }
 
   for (const auto &Flag : SetFlags) {
     OS << Flag.Name << " ";
   }
 }
 
 template <class ELFT>
-void ELFDumper<ELFT>::printDynamicString(uint64_t Value,
-                                         raw_ostream &OS,
-                                         bool WithBracket) const {
-  if (DynamicStringTable.empty())
-    OS << "<String table is empty or was not found> ";
-  else if (Value < DynamicStringTable.size()) {
-    if (WithBracket)
-      OS << "[";
-    OS << StringRef(DynamicStringTable.data() + Value);
-    if (WithBracket)
-      OS << "]";
-  } else
-    OS << "<Invalid offset 0x" << utohexstr(Value) << ">";
-}
-
-template <class ELFT>
 void ELFDumper<ELFT>::printDynamicEntry(raw_ostream &OS, uint64_t Type,
                                         uint64_t Value) const {
   const char *ConvChar =
       (opts::Output == opts::GNU) ? "0x%" PRIx64 : "0x%" PRIX64;
 
   // Handle custom printing of architecture specific tags
   switch (ObjF->getELFFile()->getHeader()->e_machine) {
   case EM_AARCH64:
void ELFDumper<ELFT>::printDynamicEntry(raw_ostream &OS, uint64_t Type,
   case DT_ANDROID_RELSZ:
   case DT_ANDROID_RELASZ:
     OS << Value << " (bytes)";
     break;
   case DT_NEEDED:
   case DT_SONAME:
   case DT_AUXILIARY:
   case DT_USED:
-  case DT_FILTER: {
+  case DT_FILTER:
+  case DT_RPATH:
+  case DT_RUNPATH: {
     const std::map<uint64_t, const char*> TagNames = {
       {DT_NEEDED,    "Shared library"},
       {DT_SONAME,    "Library soname"},
       {DT_AUXILIARY, "Auxiliary library"},
       {DT_USED,      "Not needed object"},
       {DT_FILTER,    "Filter library"},
+      {DT_RPATH,     "Library rpath"},
+      {DT_RUNPATH,   "Library runpath"},
     };
     OS << TagNames.at(Type) << ": ";
-    printDynamicString(Value, OS);
+    if (DynamicStringTable.empty())
+      OS << "<String table is empty or was not found> ";
+    else if (Value < DynamicStringTable.size()) {
+      OS << "[" << StringRef(DynamicStringTable.data() + Value) << "]";
+    } else
+      OS << "<Invalid offset 0x" << utohexstr(Value) << ">";
     break;
   }
-  case DT_RPATH:
-  case DT_RUNPATH:
-    printDynamicString(Value, OS, false);
-    break;
   case DT_FLAGS:
     printFlags(Value, makeArrayRef(ElfDynamicDTFlags), OS);
     break;
   case DT_FLAGS_1:
     printFlags(Value, makeArrayRef(ElfDynamicDTFlags1), OS);
     break;
   default:
     OS << format(ConvChar, Value);