[llvm-objdump] Map STT_TLS to ST_Other (previously ST_Data)

[MaskRay]

Summary

ST_Data is used to model BFD BFD_OBJECT.
A STT_TLS symbol does not have the BFD_OBJECT flag in BFD.
This makes sense because a STT_TLS symbol is like in a different address space,
normal data/object properties do not apply on them.

With this change, a STT_TLS symbol will not be displayed as 'O'.
This new behavior matches objdump.

I think llvm-objdump is the only affected component by this change.

[jhenderson]

FYI, I'm off tomorrow and Friday, so won't be able to come back to this until Monday next week.

There are some LLD test failures, according to the pre-merge bot. Are they related to this patch? LGTM, assuming they aren't, or if they are all trivial fixes.

[MaskRay]

fix lld tests

lld/test/ELF/mips-mgot.s

 # RUN:         . = 0x10000; .text : { *(.text) } \
 # RUN:         . = 0x70000; .got  : { *(.got)  } \
 # RUN:       }" > %t.script
 # RUN: ld.lld -shared -mips-got-size 52 --script %t.script %t0.o %t1.o %t2.o -o %t.so
 # RUN: llvm-objdump -s --section=.got -t %t.so | FileCheck %s
 # RUN: llvm-readobj -r --dyn-syms -A %t.so | FileCheck -check-prefix=GOT %s
 
 # CHECK: SYMBOL TABLE:
-# CHECK:           00000000 l    O .tdata          00000000 loc0
+# CHECK:           00000000 l      .tdata          00000000 loc0
 # CHECK: [[FOO0:[0-9a-f]+]] g      .text           00000000 foo0
-# CHECK:           00000000 g    O .tdata          00000000 tls0
-# CHECK:           00000004 g    O .tdata          00000000 tls1
+# CHECK:           00000000 g      .tdata          00000000 tls0
+# CHECK:           00000004 g      .tdata          00000000 tls1
 # CHECK: [[FOO2:[0-9a-f]+]] g      .text           00000000 foo2
 
 # CHECK:      Contents of section .got:
 # CHECK-NEXT:  70000 00000000 80000000 [[FOO0]] [[FOO2]]
 # CHECK-NEXT:  70010 00000000 00000004 00010000 00020000
 # CHECK-NEXT:  70020 00030000 00040000 00050000 00060000
 # CHECK-NEXT:  70030 00000000 00000000 00000000 00000000
 # CHECK-NEXT:  70040 00000000 00000000 00000000

lld/test/ELF/mips-tls-64.s

 # RUN:   | FileCheck -check-prefix=DIS %s
 # RUN: llvm-readobj -r -A %t.exe | FileCheck %s
 
 # RUN: ld.lld -shared %t.o %t.so -script %t.script -o %t-out.so
 # RUN: llvm-objdump -d -s -t --no-show-raw-insn %t-out.so \
 # RUN:   | FileCheck -check-prefix=DIS-SO %s
 # RUN: llvm-readobj -r -A %t-out.so | FileCheck -check-prefix=SO %s
 
-# DIS: 0000000000000000 l     O .tdata  0000000000000000 loc
-# DIS: 0000000000000000       O *UND*   0000000000000000 foo
-# DIS: 0000000000000004 g     O .tdata  0000000000000000 bar
+# DIS: 0000000000000000 l       .tdata  0000000000000000 loc
+# DIS: 0000000000000000         *UND*   0000000000000000 foo
+# DIS: 0000000000000004 g       .tdata  0000000000000000 bar
 
 # DIS:      Contents of section .got:
 # DIS-NEXT:  30000 00000000 00000000 80000000 00000000
 # DIS-NEXT:  30010 00000000 00000000 ffffffff ffff9004
 # DIS-NEXT:  30020 00000000 00000000 00000000 00000000
 # DIS-NEXT:  30030 00000000 00000001 00000000 00000000
 # DIS-NEXT:  30040 00000000 00000001 ffffffff ffff8004
 

lld/test/ELF/mips-tls-hilo.s

 # REQUIRES: mips
 # Check MIPS R_MIPS_TLS_DTPREL_HI16/LO16 and R_MIPS_TLS_TPREL_HI16/LO16
 # relocations handling.
 
 # RUN: llvm-mc -filetype=obj -triple=mips-unknown-linux %s -o %t.o
 # RUN: ld.lld %t.o -o %t.exe
 # RUN: llvm-objdump -d -t --no-show-raw-insn %t.exe | FileCheck --check-prefix=DIS %s
 # RUN: llvm-readobj -r -A %t.exe | FileCheck %s
 
 # RUN: not ld.lld %t.o -shared -o /dev/null 2>&1 | FileCheck %s --check-prefix=ERR --implicit-check-not=error:
 
 # ERR: error: relocation R_MIPS_TLS_TPREL_HI16 against loc0 cannot be used with -shared
 # ERR: error: relocation R_MIPS_TLS_TPREL_LO16 against loc0 cannot be used with -shared
 
-# DIS: 00000000 l    O .tdata          00000000 loc0
+# DIS: 00000000 l      .tdata          00000000 loc0
 
 # DIS:      <__start>:
 # DIS-NEXT:    addiu   $2, $3, 0
 #                              ^-- %hi(loc0 - .tdata - 0x8000)
 # DIS-NEXT:    addiu   $2, $3, -32768
 #                              ^-- %lo(loc0 - .tdata - 0x8000)
 # DIS-NEXT:    addiu   $2, $3, 0
 #                              ^-- %hi(loc0 - .tdata - 0x7000)

lld/test/ELF/mips-tls-static-64.s

 # REQUIRES: mips
 # Check handling TLS related relocations and symbols when linking
 # a 64-bit static executable.
 
 # RUN: llvm-mc -filetype=obj -triple=mips64-unknown-linux %s -o %t
 # RUN: ld.lld -static %t -o %t.exe
 # RUN: llvm-objdump -s -t %t.exe | FileCheck %s
 
 # CHECK: SYMBOL TABLE:
 # CHECK: [[TGA:[0-9a-f]{8}]] g      .text  0000000000000000 __tls_get_addr
-# CHECK:    0000000000000000 g    O .tdata 0000000000000000 tls1
+# CHECK:    0000000000000000 g      .tdata 0000000000000000 tls1
 #
 # CHECK:      Contents of section .data:
 # CHECK-NEXT:  {{.*}} [[TGA]] ffffffff ffff8004 ffffffff
 # CHECK-NEXT:  {{.*}} ffff9004
 
   .text
   .global __start
 __start:

lld/test/ELF/mips-tls-static.s

 # REQUIRES: mips
 # Check handling TLS related relocations and symbols when linking
 # a static executable.
 
 # RUN: llvm-mc -filetype=obj -triple=mips-unknown-linux %s -o %t
 # RUN: ld.lld -static %t -o %t.exe
 # RUN: llvm-objdump -s -t %t.exe | FileCheck %s
 
 # CHECK: SYMBOL TABLE:
-# CHECK:           00000000 g    O .tdata          00000000 tls1
+# CHECK:           00000000 g      .tdata          00000000 tls1
 # CHECK:  [[TGA:[0-9a-f]+]] g      .text           00000000 __tls_get_addr
 #
 # CHECK:      Contents of section .data:
 # CHECK-NEXT:  {{.*}} [[TGA]] ffff8004 ffff9004
 # CHECK:      Contents of section .got:
 # CHECK-NEXT:  {{.*}} 00000000 80000000 ffff9000 00000001
 # CHECK-NEXT:  {{.*}} ffff8000 00000001 00000000
 

lld/test/ELF/mips-tls.s

 # RUN:   | FileCheck -check-prefix=DIS %s
 # RUN: llvm-readobj -r -A %t.exe | FileCheck %s
 
 # RUN: ld.lld -shared %t.o %t.so -script %t.script -o %t-out.so
 # RUN: llvm-objdump -d -s -t --no-show-raw-insn %t-out.so \
 # RUN:   | FileCheck -check-prefix=DIS-SO %s
 # RUN: llvm-readobj -r -A %t-out.so | FileCheck -check-prefix=SO %s
 
-# DIS: 00000000 l    O .tdata          00000000 loc
-# DIS: 00000000      O *UND*           00000000 foo
-# DIS: 00000004 g    O .tdata          00000000 bar
+# DIS: 00000000 l      .tdata          00000000 loc
+# DIS: 00000000        *UND*           00000000 foo
+# DIS: 00000004 g      .tdata          00000000 bar
 
 # DIS:      Contents of section .got:
 # DIS-NEXT:  30000 00000000 80000000 00000000 ffff9004
 # DIS-NEXT:  30010 00000000 00000000 00000001 00000000
 # DIS-NEXT:  30020 00000001 ffff8004
 
 # DIS:      <__start>:
 # DIS-NEXT:    addiu   $2, $3, -32736

llvm/include/llvm/Object/ELFObjectFile.h

ELFObjectFile<ELFT>::getSymbolType(DataRefImpl Symb) const {
   case ELF::STT_SECTION:
     return SymbolRef::ST_Debug;
   case ELF::STT_FILE:
     return SymbolRef::ST_File;
   case ELF::STT_FUNC:
     return SymbolRef::ST_Function;
   case ELF::STT_OBJECT:
   case ELF::STT_COMMON:
-  case ELF::STT_TLS:
     return SymbolRef::ST_Data;
+  case ELF::STT_TLS:
   default:
     return SymbolRef::ST_Other;
   }
 }
 
 template <class ELFT>
 Expected<uint32_t> ELFObjectFile<ELFT>::getSymbolFlags(DataRefImpl Sym) const {
   Expected<const Elf_Sym *> SymOrErr = getSymbol(Sym);

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       .data 0000000000000000 tls
 # CHECK-NEXT:0000000000000000 g   i   .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