[elfabi] Add support for reading DT_SONAME from binaries

This change gives the llvm-elfabi tool the ability to read DT_SONAME from a binary ELF file into an ELFStub.

Added:

 - DynamicEntries struct for storing dynamic entries that are relevant to elfabi.
 - terminatedSubstr() retrieves a null-terminated substring from a StringRef.
 - appendToError() appends a string to an error, allowing more specific error messages.

Differential Revision: https://reviews.llvm.org/D55629

llvm-svn: 351361
diff --git a/llvm/test/tools/llvm-elfabi/binary-read-add-soname.test b/llvm/test/tools/llvm-elfabi/binary-read-add-soname.test
new file mode 100644
index 0000000..dbc5a00
--- /dev/null
+++ b/llvm/test/tools/llvm-elfabi/binary-read-add-soname.test
@@ -0,0 +1,48 @@
+# RUN: yaml2obj %s > %t
+# RUN: llvm-elfabi --elf %t --emit-tbe=- --soname=best.so | FileCheck %s
+
+!ELF
+FileHeader:
+  Class:           ELFCLASS64
+  Data:            ELFDATA2LSB
+  Type:            ET_DYN
+  Machine:         EM_AARCH64
+Sections:
+  - Name:            .dynstr
+    Type:            SHT_STRTAB
+    Flags:           [ SHF_ALLOC ]
+    Address:         0x0000
+    Content:         "00"
+  - Name:            .dynamic
+    Type:            SHT_DYNAMIC
+    Flags:           [ SHF_ALLOC ]
+    Address:         0x0008
+    AddressAlign:    8
+    Content:         "0a0000000000000001000000000000000500000000000000000000000000000000000000000000000000000000000000"
+      # DT_STRSZ      1 (0x1)
+      # DT_STRTAB     0x0
+      # DT_NULL       0x0
+    Size:            48
+    Link:            .dynstr
+ProgramHeaders:
+  - Type: PT_LOAD
+    Flags: [ PF_R ]
+    VAddr: 0x0000
+    PAddr: 0x0000
+    Align: 8
+    Sections:
+      - Section: .dynstr
+      - Section: .dynamic
+  - Type: PT_DYNAMIC
+    Flags: [ PF_X, PF_R ]
+    VAddr: 0x0008
+    PAddr: 0x0008
+    Sections:
+      - Section: .dynamic
+
+# CHECK:      --- !tapi-tbe
+# CHECK-NEXT: TbeVersion: {{[1-9]\d*\.(0|([1-9]\d*))}}
+# CHECK-NEXT: SoName: best.so{{$}}
+# CHECK-NEXT: Arch: AArch64
+# CHECK-NEXT: Symbols: {}
+# CHECK-NEXT: ...
diff --git a/llvm/test/tools/llvm-elfabi/binary-read-arch.test b/llvm/test/tools/llvm-elfabi/binary-read-arch.test
index ecb2fb8..f2c2d8b 100644
--- a/llvm/test/tools/llvm-elfabi/binary-read-arch.test
+++ b/llvm/test/tools/llvm-elfabi/binary-read-arch.test
@@ -1,5 +1,5 @@
 # RUN: yaml2obj %s > %t
-# RUN: llvm-elfabi %t --emit-tbe=- | FileCheck %s
+# RUN: llvm-elfabi --elf %t --emit-tbe=- | FileCheck %s
 
 !ELF
 FileHeader:
@@ -7,6 +7,38 @@
   Data:            ELFDATA2LSB
   Type:            ET_DYN
   Machine:         EM_X86_64
+Sections:
+  - Name:            .dynstr
+    Type:            SHT_STRTAB
+    Flags:           [ SHF_ALLOC ]
+    Address:         0x0000
+    Content:         "00"
+  - Name:            .dynamic
+    Type:            SHT_DYNAMIC
+    Flags:           [ SHF_ALLOC ]
+    Address:         0x0008
+    AddressAlign:    8
+    Content:         "0a0000000000000001000000000000000500000000000000000000000000000000000000000000000000000000000000"
+      # DT_STRSZ      1 (0x1)
+      # DT_STRTAB     0x0
+      # DT_NULL       0x0
+    Size:            48
+    Link:            .dynstr
+ProgramHeaders:
+  - Type: PT_LOAD
+    Flags: [ PF_R ]
+    VAddr: 0x0000
+    PAddr: 0x0000
+    Align: 8
+    Sections:
+      - Section: .dynstr
+      - Section: .dynamic
+  - Type: PT_DYNAMIC
+    Flags: [ PF_X, PF_R ]
+    VAddr: 0x0008
+    PAddr: 0x0008
+    Sections:
+      - Section: .dynamic
 
 # CHECK:      --- !tapi-tbe
 # CHECK-NEXT: TbeVersion: {{[1-9]\d*\.(0|([1-9]\d*))}}
diff --git a/llvm/test/tools/llvm-elfabi/binary-read-bad-soname.test b/llvm/test/tools/llvm-elfabi/binary-read-bad-soname.test
new file mode 100644
index 0000000..cc7205b
--- /dev/null
+++ b/llvm/test/tools/llvm-elfabi/binary-read-bad-soname.test
@@ -0,0 +1,44 @@
+# RUN: yaml2obj %s > %t
+# RUN: not llvm-elfabi --elf %t --emit-tbe=%t.tbe 2>&1 | FileCheck %s
+
+!ELF
+FileHeader:
+  Class:           ELFCLASS64
+  Data:            ELFDATA2LSB
+  Type:            ET_DYN
+  Machine:         EM_X86_64
+Sections:
+  - Name:            .dynstr
+    Type:            SHT_STRTAB
+    Flags:           [ SHF_ALLOC ]
+    Address:         0x0000
+    Content:         "00"
+  - Name:            .dynamic
+    Type:            SHT_DYNAMIC
+    Flags:           [ SHF_ALLOC ]
+    Address:         0x0008
+    AddressAlign:    8
+    Content:         "0e000000000000000d000000000000000a0000000000000001000000000000000500000000000000000000000000000000000000000000000000000000000000"
+      # DT_SONAME     13 (0x0d)
+      # DT_STRSZ      1 (0x01)
+      # DT_STRTAB     0x0
+      # DT_NULL       0x0
+    Size:            64
+    Link:            .dynstr
+ProgramHeaders:
+  - Type: PT_LOAD
+    Flags: [ PF_R ]
+    VAddr: 0x0000
+    PAddr: 0x0000
+    Align: 8
+    Sections:
+      - Section: .dynstr
+      - Section: .dynamic
+  - Type: PT_DYNAMIC
+    Flags: [ PF_X, PF_R ]
+    VAddr: 0x0008
+    PAddr: 0x0008
+    Sections:
+      - Section: .dynamic
+
+# CHECK: DT_SONAME string offset (0x000000000000000d) outside of dynamic string table
diff --git a/llvm/test/tools/llvm-elfabi/binary-read-bad-vaddr.test b/llvm/test/tools/llvm-elfabi/binary-read-bad-vaddr.test
new file mode 100644
index 0000000..5dc96df
--- /dev/null
+++ b/llvm/test/tools/llvm-elfabi/binary-read-bad-vaddr.test
@@ -0,0 +1,44 @@
+# RUN: yaml2obj %s > %t
+# RUN: not llvm-elfabi --elf %t --emit-tbe=%t.tbe 2>&1 | FileCheck %s
+
+!ELF
+FileHeader:
+  Class:           ELFCLASS64
+  Data:            ELFDATA2LSB
+  Type:            ET_DYN
+  Machine:         EM_X86_64
+Sections:
+  - Name:            .dynstr
+    Type:            SHT_STRTAB
+    Flags:           [ SHF_ALLOC ]
+    Address:         0x1000
+    Content:         "00"
+  - Name:            .dynamic
+    Type:            SHT_DYNAMIC
+    Flags:           [ SHF_ALLOC ]
+    Address:         0x1008
+    AddressAlign:    8
+    Content:         "0e0000000000000000000000000000000a0000000000000001000000000000000500000000000000600200000000000000000000000000000000000000000000"
+      # DT_SONAME     0
+      # DT_STRSZ      1
+      # DT_STRTAB     0x0260 # Bad vaddr (no PT_LOAD for 0x0000 to 0x0FFF)
+      # DT_NULL       0x0
+    Size:            64
+    Link:            .dynstr
+ProgramHeaders:
+  - Type: PT_LOAD
+    Flags: [ PF_R ]
+    VAddr: 0x1000
+    PAddr: 0x1000
+    Align: 8
+    Sections:
+      - Section: .dynstr
+      - Section: .dynamic
+  - Type: PT_DYNAMIC
+    Flags: [ PF_X, PF_R ]
+    VAddr: 0x1008
+    PAddr: 0x1008
+    Sections:
+      - Section: .dynamic
+
+# CHECK: Virtual address is not in any segment when locating .dynstr section contents
diff --git a/llvm/test/tools/llvm-elfabi/binary-read-no-dt-strsz.test b/llvm/test/tools/llvm-elfabi/binary-read-no-dt-strsz.test
new file mode 100644
index 0000000..09e514a
--- /dev/null
+++ b/llvm/test/tools/llvm-elfabi/binary-read-no-dt-strsz.test
@@ -0,0 +1,43 @@
+# RUN: yaml2obj %s > %t
+# RUN: not llvm-elfabi --elf %t --emit-tbe=%t.tbe 2>&1 | FileCheck %s
+
+!ELF
+FileHeader:
+  Class:           ELFCLASS64
+  Data:            ELFDATA2LSB
+  Type:            ET_DYN
+  Machine:         EM_X86_64
+Sections:
+  - Name:            .dynstr
+    Type:            SHT_STRTAB
+    Flags:           [ SHF_ALLOC ]
+    Address:         0x0000
+#                     \0 b a z\0
+    Content:         "0062617a00"
+  - Name:            .dynamic
+    Type:            SHT_DYNAMIC
+    Flags:           [ SHF_ALLOC ]
+    Address:         0x0008
+    AddressAlign:    8
+    Content:         "0500000000000000000000000000000000000000000000000000000000000000"
+      # DT_STRTAB     0x0
+      # DT_NULL       0x0
+    Size:            32
+    Link:            .dynstr
+ProgramHeaders:
+  - Type: PT_LOAD
+    Flags: [ PF_R ]
+    VAddr: 0x0000
+    PAddr: 0x0000
+    Align: 8
+    Sections:
+      - Section: .dynstr
+      - Section: .dynamic
+  - Type: PT_DYNAMIC
+    Flags: [ PF_X, PF_R ]
+    VAddr: 0x0008
+    PAddr: 0x0008
+    Sections:
+      - Section: .dynamic
+
+# CHECK: Couldn't determine dynamic string table size (no DT_STRSZ entry)
diff --git a/llvm/test/tools/llvm-elfabi/binary-read-no-dt-strtab.test b/llvm/test/tools/llvm-elfabi/binary-read-no-dt-strtab.test
new file mode 100644
index 0000000..25fcbdc
--- /dev/null
+++ b/llvm/test/tools/llvm-elfabi/binary-read-no-dt-strtab.test
@@ -0,0 +1,42 @@
+# RUN: yaml2obj %s > %t
+# RUN: not llvm-elfabi --elf %t --emit-tbe=%t.tbe 2>&1 | FileCheck %s
+
+!ELF
+FileHeader:
+  Class:           ELFCLASS64
+  Data:            ELFDATA2LSB
+  Type:            ET_DYN
+  Machine:         EM_X86_64
+Sections:
+  - Name:            .dynstr
+    Type:            SHT_STRTAB
+    Flags:           [ SHF_ALLOC ]
+    Address:         0x0000
+    Content:         "00"
+  - Name:            .dynamic
+    Type:            SHT_DYNAMIC
+    Flags:           [ SHF_ALLOC ]
+    Address:         0x0008
+    AddressAlign:    8
+    Content:         "0a00000000000000010000000000000000000000000000000000000000000000"
+      # DT_STRSZ      1 (0x1)
+      # DT_NULL       0x0
+    Size:            32
+    Link:            .dynstr
+ProgramHeaders:
+  - Type: PT_LOAD
+    Flags: [ PF_R ]
+    VAddr: 0x0000
+    PAddr: 0x0000
+    Align: 8
+    Sections:
+      - Section: .dynstr
+      - Section: .dynamic
+  - Type: PT_DYNAMIC
+    Flags: [ PF_X, PF_R ]
+    VAddr: 0x0008
+    PAddr: 0x0008
+    Sections:
+      - Section: .dynamic
+
+# CHECK: Couldn't locate dynamic string table (no DT_STRTAB entry)
diff --git a/llvm/test/tools/llvm-elfabi/binary-read-no-dynamic.test b/llvm/test/tools/llvm-elfabi/binary-read-no-dynamic.test
new file mode 100644
index 0000000..475d7bf
--- /dev/null
+++ b/llvm/test/tools/llvm-elfabi/binary-read-no-dynamic.test
@@ -0,0 +1,11 @@
+# RUN: yaml2obj %s > %t
+# RUN: not llvm-elfabi --elf %t --emit-tbe=%t.tbe 2>&1 | FileCheck %s
+
+!ELF
+FileHeader:
+  Class:           ELFCLASS64
+  Data:            ELFDATA2LSB
+  Type:            ET_DYN
+  Machine:         EM_X86_64
+
+# CHECK: No .dynamic section found
diff --git a/llvm/test/tools/llvm-elfabi/binary-read-replace-soname.test b/llvm/test/tools/llvm-elfabi/binary-read-replace-soname.test
new file mode 100644
index 0000000..23f0ba3
--- /dev/null
+++ b/llvm/test/tools/llvm-elfabi/binary-read-replace-soname.test
@@ -0,0 +1,48 @@
+# RUN: yaml2obj %s > %t
+# RUN: llvm-elfabi --elf %t --emit-tbe=- | FileCheck %s --check-prefix=ORIGINAL
+# RUN: llvm-elfabi --elf %t --emit-tbe=- --soname=libbest.so | FileCheck %s --check-prefix=REPLACED
+
+!ELF
+FileHeader:
+  Class:           ELFCLASS64
+  Data:            ELFDATA2LSB
+  Type:            ET_DYN
+  Machine:         EM_X86_64
+Sections:
+  - Name:            .dynstr
+    Type:            SHT_STRTAB
+    Flags:           [ SHF_ALLOC ]
+    Address:         0x1000
+#                     \0 b a z\0 s o m e l i b . s o\0 f o o\0
+    Content:         "0062617a00736f6d656c69622e736f00666f6f00"
+  - Name:            .dynamic
+    Type:            SHT_DYNAMIC
+    Flags:           [ SHF_ALLOC ]
+    Address:         0x1018
+    AddressAlign:    8
+    Content:         "0e0000000000000005000000000000000a0000000000000014000000000000000500000000000000001000000000000000000000000000000000000000000000"
+      # DT_SONAME     5 (0x05)
+      # DT_STRSZ      20 (0x14)
+      # DT_STRTAB     0x1000
+      # DT_NULL       0x0
+    Size:            64
+    Link:            .dynstr
+ProgramHeaders:
+  - Type: PT_LOAD
+    Flags: [ PF_R ]
+    VAddr: 0x1000
+    PAddr: 0x1000
+    Align: 8
+    Sections:
+      - Section: .dynstr
+      - Section: .dynamic
+  - Type: PT_DYNAMIC
+    Flags: [ PF_X, PF_R ]
+    VAddr: 0x1018
+    PAddr: 0x1018
+    Sections:
+      - Section: .dynamic
+
+# ORIGINAL: SoName: somelib.so{{$}}
+
+# REPLACED: SoName: libbest.so{{$}}
diff --git a/llvm/test/tools/llvm-elfabi/binary-read-soname-no-null.test b/llvm/test/tools/llvm-elfabi/binary-read-soname-no-null.test
new file mode 100644
index 0000000..224407d
--- /dev/null
+++ b/llvm/test/tools/llvm-elfabi/binary-read-soname-no-null.test
@@ -0,0 +1,45 @@
+# RUN: yaml2obj %s > %t
+# RUN: not llvm-elfabi --elf %t --emit-tbe=%t.tbe 2>&1 | FileCheck %s
+
+!ELF
+FileHeader:
+  Class:           ELFCLASS64
+  Data:            ELFDATA2LSB
+  Type:            ET_DYN
+  Machine:         EM_X86_64
+Sections:
+  - Name:            .dynstr
+    Type:            SHT_STRTAB
+    Flags:           [ SHF_ALLOC ]
+    Address:         0x1000
+#                     \0 b a z\0 s o m e l i b . s o z z z
+    Content:         "0062617a00736f6d656c69622e736f7a7a7a"
+  - Name:            .dynamic
+    Type:            SHT_DYNAMIC
+    Flags:           [ SHF_ALLOC ]
+    Address:         0x1018
+    AddressAlign:    8
+    Content:         "0e0000000000000005000000000000000a000000000000000f000000000000000500000000000000001000000000000000000000000000000000000000000000"
+      # DT_SONAME     5 (0x05)
+      # DT_STRSZ      15 (0x0F)
+      # DT_STRTAB     0x1000
+      # DT_NULL       0x0
+    Size:            64
+    Link:            .dynstr
+ProgramHeaders:
+  - Type: PT_LOAD
+    Flags: [ PF_R ]
+    VAddr: 0x1000
+    PAddr: 0x1000
+    Align: 8
+    Sections:
+      - Section: .dynstr
+      - Section: .dynamic
+  - Type: PT_DYNAMIC
+    Flags: [ PF_X, PF_R ]
+    VAddr: 0x1018
+    PAddr: 0x1018
+    Sections:
+      - Section: .dynamic
+
+# CHECK: String overran bounds of string table (no null terminator) when reading DT_SONAME
diff --git a/llvm/test/tools/llvm-elfabi/binary-read-soname.test b/llvm/test/tools/llvm-elfabi/binary-read-soname.test
new file mode 100644
index 0000000..b6877c6
--- /dev/null
+++ b/llvm/test/tools/llvm-elfabi/binary-read-soname.test
@@ -0,0 +1,50 @@
+# RUN: yaml2obj %s > %t
+# RUN: llvm-elfabi --elf %t --emit-tbe=- | FileCheck %s
+
+!ELF
+FileHeader:
+  Class:           ELFCLASS64
+  Data:            ELFDATA2LSB
+  Type:            ET_DYN
+  Machine:         EM_X86_64
+Sections:
+  - Name:            .dynstr
+    Type:            SHT_STRTAB
+    Flags:           [ SHF_ALLOC ]
+    Address:         0x1000
+#                     \0 b a z\0 s o m e l i b . s o\0 f o o\0
+    Content:         "0062617a00736f6d656c69622e736f00666f6f00"
+  - Name:            .dynamic
+    Type:            SHT_DYNAMIC
+    Flags:           [ SHF_ALLOC ]
+    Address:         0x1018
+    AddressAlign:    8
+    Content:         "0e0000000000000005000000000000000a0000000000000014000000000000000500000000000000001000000000000000000000000000000000000000000000"
+      # DT_SONAME     5 (0x05)
+      # DT_STRSZ      20 (0x14)
+      # DT_STRTAB     0x1000
+      # DT_NULL       0x0
+    Size:            64
+    Link:            .dynstr
+ProgramHeaders:
+  - Type: PT_LOAD
+    Flags: [ PF_R ]
+    VAddr: 0x1000
+    PAddr: 0x1000
+    Align: 8
+    Sections:
+      - Section: .dynstr
+      - Section: .dynamic
+  - Type: PT_DYNAMIC
+    Flags: [ PF_X, PF_R ]
+    VAddr: 0x1018
+    PAddr: 0x1018
+    Sections:
+      - Section: .dynamic
+
+# CHECK:      --- !tapi-tbe
+# CHECK-NEXT: TbeVersion: {{[1-9]\d*\.(0|([1-9]\d*))}}
+# CHECK-NEXT: SoName: somelib.so{{$}}
+# CHECK-NEXT: Arch: x86_64
+# CHECK-NEXT: Symbols: {}
+# CHECK-NEXT: ...
diff --git a/llvm/test/tools/llvm-elfabi/replace-soname-tbe.test b/llvm/test/tools/llvm-elfabi/replace-soname-tbe.test
deleted file mode 100644
index 71d50a8..0000000
--- a/llvm/test/tools/llvm-elfabi/replace-soname-tbe.test
+++ /dev/null
@@ -1,16 +0,0 @@
-# RUN: yaml2obj %s > %t
-# RUN: llvm-elfabi %t --emit-tbe=- --soname=best.so | FileCheck %s
-
-!ELF
-FileHeader:
-  Class:           ELFCLASS64
-  Data:            ELFDATA2LSB
-  Type:            ET_DYN
-  Machine:         EM_AARCH64
-
-# CHECK:      --- !tapi-tbe
-# CHECK-NEXT: TbeVersion: {{[1-9]\d*\.(0|([1-9]\d*))}}
-# CHECK-NEXT: SoName: best.so
-# CHECK-NEXT: Arch: AArch64
-# CHECK-NEXT: Symbols: {}
-# CHECK-NEXT: ...