[llvm-objdump][test] Reorganize ELF --syms tests

[MaskRay]

Summary

Merge symbol-table-elf.test and common-symbol-elf.test, and add some
more tests (SHN_UNDEF, SHN_ABS, SHN_COMMON, STB_GNU_UNIQUE,
STT_GNU_IFUNC) to test/llvm-objdump/ELF/symbol-table.test

The naming follows test/llvm-{readobj,objcopy}/ELF .

Some discrepancy from GNU objdump:

• STT_COMMON: can be produced with ld.bfd -r -z common, but it almost never exists in practice
• STT_GNU_IFUNC: will be fixed by D75793
• STB_GNU_UNIQUE: will be fixed by D75797
• STT_TLS: GNU objdump does not print 'O'
• unknown binding: GNU objdump does not print 'g'. This probably does

not matter.

• A reserved symbol index is displayed as *ABS* in GNU objdump. It is not clear what we should print.

[grimar]

llvm/test/tools/llvm-objdump/ELF/symbol-table.test

7

Add a file/test comment?

41

https://reviews.llvm.org/D75793#inline-690488

69

I'd replace %08x with words. I.e. "we print addresses as 32 bit values" or alike.
(It is not really important how exactly this logic is implemented, with %08x or something different).

[MaskRay]

Address comments

[jhenderson]

You should probably extend the test case to enumerate the possible section types supported by LLVM + 1 other unknown value. Similarly, an unknown binding value might be good to test. Testing more section index values might be wise too, i.e. values >= SHN_LORESERVE that don't correspond to a special value, and SHN_XINDEX, where the real section index is stored elsewhere.

What does llvm-objdump do if you specify an invalid section index? That should be tested too, I guess. Ditto an invalid name?

Finally, what about non-zero st_other values? Does llvm-objdump print those at all?

[MaskRay]

Add SHN_LOPROC/SHN_LOOS/reserved tests

We need a SHN_XINDEX test, but that can be done a in subsequent patch.
(The corresponding llvm-readobj tests are not trivial.)

[MaskRay]

Fix test

[jhenderson]

In D75796#1912527, @MaskRay wrote:

Add SHN_LOPROC/SHN_LOOS/reserved tests

We need a SHN_XINDEX test, but that can be done a in subsequent patch.
(The corresponding llvm-readobj tests are not trivial.)

Deferring SHN_XINDEX is probably fine. What about the other STT_* types and an unknown binding as suggested?

[MaskRay]

Improve tests

[MaskRay]

Does this patch look good now?

[grimar]

LGTM with 2 nits, please wait to see if @jhenderson is happy too.

llvm/test/tools/llvm-objdump/ELF/symbol-table.test

41

nit: I think you can remove empty "Name".

98

nit: missing the 64-bit version.

105

Perhaps it can be

#      ADDR:SYMBOL TABLE:
# ADDR-NEXT:[[NULL]]         *UND*  [[NULL]] sym

> FileCheck -D NULL=00000000 ...
> FileCheck -D NULL=0000000000000000 ....

(I am not sure we want it. It has its pros and cons)

[jhenderson]

Still looks like you're missing some cases:

STT_NOTYPE, STT_COMMON, STT_LOPROC/STT_LOOS values.

STT_ and STB_ values outside recognised or reserved ranges.

[MaskRay]

Add STT_COMMON, STT_HIOS and STT_LOPROC

[MaskRay]

Address comments

llvm/test/tools/llvm-objdump/ELF/symbol-table.test

105

With --match-full-lines --strict-whitespace, may be fine keeping the original literal form...

[MaskRay]

More tests

llvm/test/tools/llvm-objdump/ELF/symbol-table.test

+## Test how --syms/-t prints the static symbol table.
+# RUN: yaml2obj --docnum=1 %s -o %t
+# RUN: llvm-objdump --syms %t > %t.txt
+# RUN: llvm-objdump -t %t | cmp - %t.txt
+# RUN: FileCheck %s --input-file=%t.txt --match-full-lines --strict-whitespace
+
+#      CHECK:SYMBOL TABLE:
+# CHECK-NEXT:0000000000000000 l    df *ABS* 0000000000000000 a.c
+# CHECK-NEXT:0000000000000000 l    d  .text 0000000000000000 .text
+# CHECK-NEXT:0000000000002000 l     O .data 0000000000000000 local_object
+# CHECK-NEXT:0000000000001fff l     F .text 0000000000000000 local_func
+# CHECK-NEXT:0000000000000000 l       *ABS* 0000000000000000 local_abs
+# CHECK-NEXT:0000000000000000 g       .data 0000000000000000 notype
+# CHECK-NEXT:0000000000000000 g     O .data 0000000000000010 object
+# CHECK-NEXT:0000000000000000 g     F .text 000000000000000f func
+# CHECK-NEXT:0000000000000000 g     O *COM* 0000000000000000 common
+# CHECK-NEXT:0000000000000000 g     O .data 0000000000000000 tls
+# CHECK-NEXT:0000000000000000 g       .text 0000000000000000 ifunc
+# CHECK-NEXT:0000000000000000 g       .text 0000000000000000 invalid_type
+# CHECK-NEXT:0000000000000000 g       .text 0000000000000000 STT_HIOS
+# CHECK-NEXT:0000000000000000 g       .text 0000000000000000 STT_LOPROC
+# CHECK-NEXT:0000000000000000         *UND* 0000000000000000 undef
+# CHECK-NEXT:0000000000000000         *UND* 0000000000000000 SHN_LOPROC
+# CHECK-NEXT:0000000000000000         *UND* 0000000000000000 SHN_LOOS
+# CHECK-NEXT:0000000000000000         *UND* 0000000000000000 reserve
+# CHECK-NEXT:0000000000000000 g       *ABS* 0000000000000000 abs
+# CHECK-NEXT:0000000000000000         *COM* 0000000000000000 common2
+# CHECK-NEXT:0000000000000000 g     O .data 0000000000000000 gnu_unique
+# CHECK-NEXT:0000000000000000 g       .data 0000000000000000 invalid_binding
+# CHECK-NEXT:0000000000000000 g       .data 0000000000000000 STB_HIOS
+# CHECK-NEXT:0000000000000000 g       .data 0000000000000000 STB_LOPROC
+
+--- !ELF
+FileHeader:
+  Class:   ELFCLASS64
+  Data:    ELFDATA2LSB
+  Type:    ET_EXEC
+  Machine: EM_X86_64
+Sections:
+  - Name:  .text
+    Type:  SHT_PROGBITS
+  - Name:  .data
+    Type:  SHT_PROGBITS
+Symbols:
+  - Name:    "a.c"
+    Type:    STT_FILE
+    Index:   SHN_ABS
+  - Type:    STT_SECTION
+    Section: .text
+  - Name:    local_object
+    Type:    STT_OBJECT
+    Section: .data
+    Value:   0x2000
+  - Name:    local_func
+    Type:    STT_FUNC
+    Section: .text
+    Value:   0x1fff
+  - Name:    local_abs
+    Index:   SHN_ABS
+  - Name:    notype
+    Binding: STB_GLOBAL
+    Section: .data
+  - Name:    object
+    Type:    STT_OBJECT
+    Size:    0x10
+    Binding: STB_GLOBAL
+    Section: .data
+  - Name:    func
+    Type:    STT_FUNC
+    Size:    0xf
+    Binding: STB_GLOBAL
+    Section: .text
+  - Name:    common
+    Type:    STT_COMMON
+    Binding: STB_GLOBAL
+    Section: .data
+  - Name:    tls
+    Type:    STT_TLS
+    Binding: STB_GLOBAL
+    Section: .data
+  - Name:    ifunc
+    Type:    STT_GNU_IFUNC
+    Binding: STB_GLOBAL
+    Section: .text
+  - Name:    invalid_type
+    Type:    7
+    Binding: STB_GLOBAL
+    Section: .text
+  - Name:    STT_HIOS
+    Type:    12
+    Binding: STB_GLOBAL
+    Section: .text
+  - Name:    STT_LOPROC
+    Type:    13
+    Binding: STB_GLOBAL
+    Section: .text
+  - Name:    undef
+    Binding: STB_GLOBAL
+  - Name:    SHN_LOPROC
+    Binding: STB_GLOBAL
+    Index:   0xff00
+  - Name:    SHN_LOOS
+    Binding: STB_GLOBAL
+    Index:   0xff20
+  - Name:    reserve
+    Binding: STB_GLOBAL
+    Index:   0xff40
+  - Name:    abs
+    Index:   SHN_ABS
+    Binding: STB_GLOBAL
+  - Name:    common2
+    Binding: STB_GLOBAL
+    Index:   SHN_COMMON
+  - Name:    gnu_unique
+    Type:    STT_OBJECT
+    Binding: STB_GNU_UNIQUE
+    Section: .data
+  - Name:    invalid_binding
+    Binding: 3
+    Section: .data
+  - Name:    STB_HIOS
+    Binding: 12
+    Section: .data
+  - Name:    STB_LOPROC
+    Binding: 13
+    Section: .data
+
+## For an ELF32 object, print the address and size fields as 32-bit hexadecimals.
+# RUN: yaml2obj --docnum=2 -D BITS=32 %s -o %t.32
+# RUN: llvm-objdump --syms %t.32 | FileCheck --check-prefix=ELF32 %s --match-full-lines --strict-whitespace
+## For an ELF64 object, print the address and size fields as 64-bit hexadecimals.
+# RUN: yaml2obj --docnum=2 -D BITS=64 %s -o %t.64
+# RUN: llvm-objdump --syms %t.64 | FileCheck --check-prefix=ELF64 %s --match-full-lines --strict-whitespace
+
+#      ELF32:SYMBOL TABLE:
+# ELF32-NEXT:00000000         *UND* 00000000 sym
+
+#      ELF64:SYMBOL TABLE:
+# ELF64-NEXT:0000000000000000         *UND* 0000000000000000 sym
+
+--- !ELF
+FileHeader:
+  Class:   ELFCLASS[[BITS]]
+  Data:    ELFDATA2LSB
+  Type:    ET_EXEC
+  Machine: EM_X86_64
+Symbols:
+  - Name: sym

llvm/test/tools/llvm-objdump/common-symbol-elf.test

-// RUN: llvm-objdump -t %p/Inputs/common-symbol-elf | FileCheck %s
-
-CHECK: 00000400       O *COM*  00000008 common_symbol

llvm/test/tools/llvm-objdump/symbol-table-elf.test

-# RUN: yaml2obj -D BITS=32 %s -o %t.32
-# RUN: llvm-objdump --syms %t.32 > %t.32.txt
-# RUN: llvm-objdump -t %t.32 | cmp - %t.32.txt
-# RUN: FileCheck --check-prefix=ELF32 %s --input-file=%t.32.txt
-
-# RUN: yaml2obj -D BITS=64 %s -o %t.64
-# RUN: llvm-objdump --syms %t.64 | FileCheck --check-prefix=ELF64 %s
-
-# ELF32:      SYMBOL TABLE:
-# ELF32-NEXT: 00001004 l     F .text     00000000 lfoo
-# ELF32-NEXT: 00001008 l     O .text     00000000 lbar
-# ELF32-NEXT: 00001004 g     F .text     00000000 foo
-# ELF32-NEXT: 00001008 g     O .text     00000000 bar
-
-# ELF64:      SYMBOL TABLE:
-# ELF64-NEXT: 0000000000001004 l     F .text     0000000000000000 lfoo
-# ELF64-NEXT: 0000000000001008 l     O .text     0000000000000000 lbar
-# ELF64-NEXT: 0000000000001004 g     F .text     0000000000000000 foo
-# ELF64-NEXT: 0000000000001008 g     O .text     0000000000000000 bar
-
-!ELF
-FileHeader:
-  Class:           ELFCLASS[[BITS]]
-  Data:            ELFDATA2LSB
-  Type:            ET_EXEC
-  Machine:         EM_X86_64
-Sections:
-  - Name:            .bss
-    Type:            SHT_NOBITS
-    Flags:           [ SHF_ALLOC ]
-    AddressAlign:    0x0000000000000010
-    Size:            64
-  - Name:            .text
-    Type:            SHT_PROGBITS
-    Flags:           [ SHF_ALLOC, SHF_EXECINSTR ]
-    AddressAlign:    0x0000000000000010
-    Content:         "00000000"
-Symbols:
-  - Name:     lfoo
-    Type:     STT_FUNC
-    Section:  .text
-    Value:    0x1004
-  - Name:     lbar
-    Type:     STT_OBJECT
-    Section:  .text
-    Value:    0x1008
-  - Name:     foo
-    Type:     STT_FUNC
-    Section:  .text
-    Value:    0x1004
-    Binding:  STB_GLOBAL
-  - Name:     bar
-    Type:     STT_OBJECT
-    Section:  .text
-    Value:    0x1008
-    Binding:  STB_GLOBAL
-