[llvm-readobj] Decode st_other symbol's flags

[atanasyan]

Summary

The patch supports common STV_xxx visibility flags and MIPS specific STO_MIPS_xxx flags.

[• rafael]

LGTM

Thanks!

[atanasyan]

Thanks for review

test/MC/Mips/elf_st_other.s

 .type f2, @function
 .set nomicromips
 f2:
   nop
 
 // CHECK-LABEL: Name: d1
 // CHECK:       Other: 0
 // CHECK-LABEL: Name: f1
-// CHECK:       Other: 128
+// CHECK:       Other [ (0x80)
 // CHECK-LABEL: Name: f2
 // CHECK:       Other: 0

test/MC/Mips/insn-directive.s

 
 # ASM: .insn
 
 # OBJ: Symbols [
 # OBJ: Name: foo
 # OBJ: Other: 0
 
 # OBJ: Name: f_mm_insn_data
-# OBJ: Other: 128
+# OBJ: Other [ (0x80)
 
 # OBJ: Name: f_mm_insn_instr
-# OBJ: Other: 128
+# OBJ: Other [ (0x80)
 
 # OBJ: Name: f_normal_insn_data
 # OBJ: Other: 0
 
 # OBJ: Name: f_normal_insn_instr
 # OBJ: Other: 0
 
 # OBJ: Name: o_mm_insn_data
-# OBJ: Other: 128
+# OBJ: Other [ (0x80)
 
 # OBJ: Name: o_mm_insn_instr
-# OBJ: Other: 128
+# OBJ: Other [ (0x80)
 
 # OBJ: Name: o_normal_insn_data
 # OBJ: Other: 0
 
 # OBJ: Name: o_normal_insn_instr
 # OBJ: Other: 0
 # OBJ: ]

test/MC/Mips/micromips-alias.s

 # RUN: llvm-mc -filetype=obj -triple mipsel-unknown-linux -mcpu=mips32 %s -o - \
 # RUN:   | llvm-readobj -t | FileCheck %s
 
 # Symbol bar must be marked as micromips.
 # CHECK: Name: bar
-# CHECK: Other: 128
+# CHECK: Other [ (0x80)
   .align 2
   .type  f,@function
   .set   nomips16
   .set   micromips
 f:
   nop
   .set   nomicromips
   nop
   .globl bar
 bar = f
 
 # CHECK: Name: foo
-# CHECK: Other: 128
+# CHECK: Other [ (0x80)
   .type  o,@object
   .set   micromips
 o:
   .insn
   .word 0x00000000
   .set   nomicromips
 
   .globl foo
 foo = o

test/MC/Mips/micromips-label-test-sections.s

 # RUN: llvm-mc %s -triple=mipsel-unknown-linux -mcpu=mips32r2 \
 # RUN:   -mattr=+micromips -filetype=obj -o - | llvm-readobj -t | FileCheck %s
   .text
   .set micromips
 f:
   nop
 g:
   .section .text
 h:
   nop
 
 # CHECK: Symbols [
 # CHECK:   Symbol {
 # CHECK:     Name: f
 # CHECK:     Binding: Local
 # CHECK:     Type: None
-# CHECK:     Other: 128
+# CHECK:     Other [ (0x80)
+# CHECK:       STO_MIPS_MICROMIPS
+# CHECK:     ]
 # CHECK:     Section: .text
 # CHECK:   }
 # CHECK:   Symbol {
 # CHECK:     Name: g
 # CHECK:     Binding: Local
 # CHECK:     Type: None
 # CHECK:     Other: 0
 # CHECK:     Section: .text
 # CHECK:   }
 # CHECK:   Symbol {
 # CHECK:     Name: h
 # CHECK:     Binding: Local
 # CHECK:     Type: None
-# CHECK:     Other: 128
+# CHECK:     Other [ (0x80)
+# CHECK:       STO_MIPS_MICROMIPS
+# CHECK:     ]
 # CHECK:     Section: .text
 # CHECK:   }
 # CHECK: ]
 

test/MC/Mips/micromips-label-test.s

 # CHECK:     Type: None
 # CHECK:     Other: 0
 # CHECK:     Section: .text
 # CHECK:   }
 # CHECK:   Symbol {
 # CHECK:     Name: g
 # CHECK:     Binding: Local
 # CHECK:     Type: None
-# CHECK:     Other: 128
+# CHECK:     Other [ (0x80)
+# CHECK:       STO_MIPS_MICROMIPS
+# CHECK:     ]
 # CHECK:     Section: .text
 # CHECK:   }
 # CHECK:   Symbol {
 # CHECK:     Name: h
 # CHECK:     Binding: Local
 # CHECK:     Type: None
 # CHECK:     Other: 0
 # CHECK:     Section: .text
 # CHECK:   }
 # CHECK:   Symbol {
 # CHECK:     Name: i
 # CHECK:     Binding: Local
 # CHECK:     Type: None
-# CHECK:     Other: 128
+# CHECK:     Other [ (0x80)
+# CHECK:       STO_MIPS_MICROMIPS
+# CHECK:     ]
 # CHECK:     Section: .text
 # CHECK:   }
 # CHECK:   Symbol {
 # CHECK:     Name: j
 # CHECK:     Binding: Local
 # CHECK:     Type: None
 # CHECK:     Other: 0
 # CHECK:     Section: .text
 # CHECK:   }
 # CHECK: ]
 

test/MC/PowerPC/ppc64-localentry.s

 
 # Verify that .localentry is encoded in the Other field.
 # CHECK: Symbols [
 # CHECK:       Name: callee1
 # CHECK-NEXT:  Value:
 # CHECK-NEXT:  Size: 16
 # CHECK-NEXT:  Binding: Local
 # CHECK-NEXT:  Type: Function
-# CHECK-NEXT:  Other: 96
+# CHECK-NEXT:  Other [ (0x60)
+# CHECK-NEXT:  ]
 # CHECK-NEXT:  Section: .text
 # CHECK:       Name: callee2
 # CHECK-NEXT:  Value:
 # CHECK-NEXT:  Size: 8
 # CHECK-NEXT:  Binding: Local
 # CHECK-NEXT:  Type: Function
 # CHECK-NEXT:  Other: 0
 # CHECK-NEXT:  Section: .text
 
 # Verify that symbol assignment copies the Other bits.
 # CHECK:       Name: copy1
 # CHECK-NEXT:  Value:
 # CHECK-NEXT:  Size: 16
 # CHECK-NEXT:  Binding: Local
 # CHECK-NEXT:  Type: Function
-# CHECK-NEXT:  Other: 96
+# CHECK-NEXT:  Other [ (0x60)
+# CHECK-NEXT:  ]
 # CHECK-NEXT:  Section: .text
 # CHECK:       Name: copy2
 # CHECK-NEXT:  Value:
 # CHECK-NEXT:  Size: 8
 # CHECK-NEXT:  Binding: Local
 # CHECK-NEXT:  Type: Function
 # CHECK-NEXT:  Other: 0
 # CHECK-NEXT:  Section: .text
 

test/MC/PowerPC/st-other-crash.s

 // RUN: llvm-mc < %s -filetype=obj -triple powerpc64le-pc-linux | \
 // RUN:   llvm-readobj -t | FileCheck %s
 
 // This used to crash. Make sure it produce the correct symbol.
 
 // CHECK:       Symbol {
 // CHECK:         Name: _ZN4llvm11SmallVectorIcLj0EEC2Ev (12)
 // CHECK-NEXT:    Value: 0x0
 // CHECK-NEXT:    Size: 0
 // CHECK-NEXT:    Binding: Local (0x0)
 // CHECK-NEXT:    Type: None (0x0)
-// CHECK-NEXT:    Other: 64
+// CHECK-NEXT:    Other [ (0x40)
+// CHECK-NEXT:    ]
 // CHECK-NEXT:    Section: .group
 // CHECK-NEXT:  }
 
 
   .section  .text._ZN4llvm11SmallVectorIcLj0EEC2Ev,"axG",@progbits,_ZN4llvm11SmallVectorIcLj0EEC2Ev,comdat
 .Ltmp2:
   addis 2, 12, .TOC.-.Ltmp2@ha
 .Ltmp3:
   .localentry _ZN4llvm11SmallVectorIcLj0EEC2Ev, .Ltmp3-.Ltmp2

test/Object/yaml2obj-elf-symbol-visibility.yaml

 # OBJ-NEXT:   Section: .data (0x1)
 # OBJ-NEXT: }
 # OBJ-NEXT: Symbol {
 # OBJ-NEXT:   Name: internal (8)
 # OBJ-NEXT:   Value: 0x8
 # OBJ-NEXT:   Size: 4
 # OBJ-NEXT:   Binding: Global (0x1)
 # OBJ-NEXT:   Type: Object (0x1)
-# OBJ-NEXT:   Other: 1
+# OBJ-NEXT:   Other [ (0x1)
+# OBJ-NEXT:     STV_INTERNAL
+# OBJ-NEXT:   ]
 # OBJ-NEXT:   Section: .data (0x1)
 # OBJ-NEXT: }
 # OBJ-NEXT: Symbol {
 # OBJ-NEXT:   Name: hidden (1)
 # OBJ-NEXT:   Value: 0xC
 # OBJ-NEXT:   Size: 4
 # OBJ-NEXT:   Binding: Global (0x1)
 # OBJ-NEXT:   Type: Object (0x1)
-# OBJ-NEXT:   Other: 2
+# OBJ-NEXT:   Other [ (0x2)
+# OBJ-NEXT:     STV_HIDDEN
+# OBJ-NEXT:   ]
 # OBJ-NEXT:   Section: .data (0x1)
 # OBJ-NEXT: }
 # OBJ-NEXT: Symbol {
 # OBJ-NEXT:   Name: protected (17)
 # OBJ-NEXT:   Value: 0x10
 # OBJ-NEXT:   Size: 4
 # OBJ-NEXT:   Binding: Global (0x1)
 # OBJ-NEXT:   Type: Object (0x1)
-# OBJ-NEXT:   Other: 163
+# OBJ-NEXT:   Other [ (0xA3)
+# OBJ-NEXT:     STO_MIPS_MICROMIPS
+# OBJ-NEXT:     STO_MIPS_PIC
+# OBJ-NEXT:     STV_PROTECTED
+# OBJ-NEXT:   ]
 # OBJ-NEXT:   Section: .data (0x1)
 # OBJ-NEXT: }
 
 # YAML:      Symbols:
 # YAML-NEXT:   Global:
 # YAML-NEXT:     - Name:            default1
 # YAML-NEXT:       Type:            STT_OBJECT
 # YAML-NEXT:       Section:         .data

test/tools/llvm-readobj/mips-st-other.test

+RUN: llvm-readobj -symbols %p/Inputs/st-other.obj.elf-mips \
+RUN:   | FileCheck -check-prefix=MREG %s
+RUN: llvm-readobj -symbols %p/Inputs/st-other.obj.elf-mips16 \
+RUN:   | FileCheck -check-prefix=M16 %s
+
+MREG:      Name: foo
+MREG-NEXT: Value: 0x0
+MREG-NEXT: Size: 0
+MREG-NEXT: Binding: Global
+MREG-NEXT: Type: None
+MREG-NEXT: Other [ (0x29)
+MREG-NEXT:   STO_MIPS_PIC (0x20)
+MREG-NEXT:   STO_MIPS_PLT (0x8)
+MREG-NEXT:   STV_INTERNAL (0x1)
+MREG-NEXT: ]
+
+M16:      Name: foo
+M16-NEXT: Value: 0x0
+M16-NEXT: Size: 0
+M16-NEXT: Binding: Global
+M16-NEXT: Type: None
+M16-NEXT: Other [ (0xF1)
+M16-NEXT:   STO_MIPS_MIPS16 (0xF0)
+M16-NEXT:   STV_INTERNAL (0x1)
+M16-NEXT: ]

tools/llvm-readobj/ELFDumper.cpp

static const EnumEntry<unsigned> ElfHeaderMipsFlags[] = {
   LLVM_READOBJ_ENUM_ENT(ELF, EF_MIPS_ARCH_32),
   LLVM_READOBJ_ENUM_ENT(ELF, EF_MIPS_ARCH_64),
   LLVM_READOBJ_ENUM_ENT(ELF, EF_MIPS_ARCH_32R2),
   LLVM_READOBJ_ENUM_ENT(ELF, EF_MIPS_ARCH_64R2),
   LLVM_READOBJ_ENUM_ENT(ELF, EF_MIPS_ARCH_32R6),
   LLVM_READOBJ_ENUM_ENT(ELF, EF_MIPS_ARCH_64R6)
 };
 
+static const EnumEntry<unsigned> ElfSymOtherFlags[] = {
+  LLVM_READOBJ_ENUM_ENT(ELF, STV_INTERNAL),
+  LLVM_READOBJ_ENUM_ENT(ELF, STV_HIDDEN),
+  LLVM_READOBJ_ENUM_ENT(ELF, STV_PROTECTED)
+};
+
+static const EnumEntry<unsigned> ElfMipsSymOtherFlags[] = {
+  LLVM_READOBJ_ENUM_ENT(ELF, STO_MIPS_OPTIONAL),
+  LLVM_READOBJ_ENUM_ENT(ELF, STO_MIPS_PLT),
+  LLVM_READOBJ_ENUM_ENT(ELF, STO_MIPS_PIC),
+  LLVM_READOBJ_ENUM_ENT(ELF, STO_MIPS_MICROMIPS)
+};
+
+static const EnumEntry<unsigned> ElfMips16SymOtherFlags[] = {
+  LLVM_READOBJ_ENUM_ENT(ELF, STO_MIPS_OPTIONAL),
+  LLVM_READOBJ_ENUM_ENT(ELF, STO_MIPS_PLT),
+  LLVM_READOBJ_ENUM_ENT(ELF, STO_MIPS_MIPS16)
+};
+
 template <typename ELFT>
 ELFDumper<ELFT>::ELFDumper(const ELFFile<ELFT> *Obj, StreamWriter &Writer)
     : ObjDumper(Writer), Obj(Obj) {
 
   SmallVector<const Elf_Phdr *, 4> LoadSegments;
   for (const Elf_Phdr &Phdr : Obj->program_headers()) {
     if (Phdr.p_type == ELF::PT_DYNAMIC) {
       DynamicTable = createDRIFrom(&Phdr, sizeof(Elf_Dyn));
void LLVMStyle<ELFT>::printSymbol(const ELFO *Obj, const Elf_Sym *Symbol,
   W.printHex("Value", Symbol->st_value);
   W.printNumber("Size", Symbol->st_size);
   W.printEnum("Binding", Symbol->getBinding(), makeArrayRef(ElfSymbolBindings));
   if (Obj->getHeader()->e_machine == ELF::EM_AMDGPU &&
       SymbolType >= ELF::STT_LOOS && SymbolType < ELF::STT_HIOS)
     W.printEnum("Type", SymbolType, makeArrayRef(AMDGPUSymbolTypes));
   else
     W.printEnum("Type", SymbolType, makeArrayRef(ElfSymbolTypes));
-  W.printNumber("Other", Symbol->st_other);
+  if (Symbol->st_other == 0)
+    // Usually st_other flag is zero. Do not pollute the output
+    // by flags enumeration in that case.
+    W.printNumber("Other", 0);
+  else {
+    std::vector<EnumEntry<unsigned>> SymOtherFlags(std::begin(ElfSymOtherFlags),
+                                                   std::end(ElfSymOtherFlags));
+    if (Obj->getHeader()->e_machine == EM_MIPS) {
+      // Someones in their infinite wisdom decided to make STO_MIPS_MIPS16
+      // flag overlapped with other ST_MIPS_xxx flags. So consider both
+      // cases separately.
+      if ((Symbol->st_other & STO_MIPS_MIPS16) == STO_MIPS_MIPS16)
+        SymOtherFlags.insert(SymOtherFlags.end(),
+                             std::begin(ElfMips16SymOtherFlags),
+                             std::end(ElfMips16SymOtherFlags));
+      else
+        SymOtherFlags.insert(SymOtherFlags.end(),
+                             std::begin(ElfMipsSymOtherFlags),
+                             std::end(ElfMipsSymOtherFlags));
+    }
+    W.printFlags("Other", Symbol->st_other, makeArrayRef(SymOtherFlags), 0x3u);
+  }
   W.printHex("Section", SectionName, SectionIndex);
 }
 
 template <class ELFT> void LLVMStyle<ELFT>::printSymbols(const ELFO *Obj) {
   ListScope Group(W, "Symbols");
   this->dumper()->printSymbolsHelper(false);
 }