[llvm-nm/objdump/size] Add tests for dumping symbol tables with invalid sh_size.

This change adds tests for llvm-nm, llvm-objdump and llvm-size when dumping symbol tables with invalid sh_size (sh_size % sizeof(Elf_Sym) != 0).

Reviewed By: jhenderson, MaskRay

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

Author: higuoxing

llvm/test/tools/llvm-nm/invalid-symbol-table-size.test

@@ -0,0 +1,33 @@
+## This test ensures llvm-nm emits a helpful error message when dumping a symbol table
+## whose sh_size isn't a multiple of the symbol size (sh_size % sizeof(Elf_Sym) != 0).
+
+## a) Broken .symtab symbol table. Valid .dynsym symbol table.
+# RUN: yaml2obj -DBITS=32 -DSIZE=33 -DDYNSIZE=32 %s -o %t.32-bit.o
+# RUN: not llvm-nm %t.32-bit.o 2>&1 | FileCheck -DSIZE=33 -DSYMSIZE=16 -DINDEX=2 %s
+# RUN: yaml2obj -DBITS=64 -DSIZE=49 -DDYNSIZE=48 %s -o %t.64-bit.o
+# RUN: not llvm-nm %t.64-bit.o 2>&1 | FileCheck -DSIZE=49 -DSYMSIZE=24 -DINDEX=2 %s
+
+## b) Broken .dynsym symbol table. Valid .symtab symbol table.
+# RUN: yaml2obj -DBITS=32 -DSIZE=32 -DDYNSIZE=33 %s -o %t.32-bit.o
+# RUN: not llvm-nm --dynamic %t.32-bit.o 2>&1 | FileCheck -DSIZE=33 -DSYMSIZE=16 -DINDEX=3 %s
+# RUN: yaml2obj -DBITS=64 -DSIZE=48 -DDYNSIZE=49 %s -o %t.64-bit.o
+# RUN: not llvm-nm --dynamic %t.64-bit.o 2>&1 | FileCheck -DSIZE=49 -DSYMSIZE=24 -DINDEX=3 %s
+
+# CHECK: error: {{.*}} section [index [[INDEX]]] has an invalid sh_size ([[SIZE]]) which is not a multiple of its sh_entsize ([[SYMSIZE]])
+
+--- !ELF
+FileHeader:
+  Class:   ELFCLASS[[BITS]]
+  Data:    ELFDATA2LSB
+  Type:    ET_DYN
+  Machine: EM_X86_64
+Sections:
+  - Name:    .dynstr
+    Type:    SHT_STRTAB
+    Content: "00"
+  - Name:    .symtab
+    Type:    SHT_SYMTAB
+    Size:    [[SIZE]]
+  - Name:    .dynsym
+    Type:    SHT_DYNSYM
+    Size:    [[DYNSIZE]]

llvm/test/tools/llvm-objdump/invalid-symbol-table-size.test

@@ -0,0 +1,33 @@
+## This test ensures llvm-objdump emits a helpful error message when dumping a symbol table
+## whose sh_size isn't a multiple of the symbol size (sh_size % sizeof(Elf_Sym) != 0).
+
+## a) Broken .symtab symbol table. Valid .dynsym symbol table.
+# RUN: yaml2obj -DBITS=32 -DSIZE=33 -DDYNSIZE=32 %s -o %t.32-bit.o
+# RUN: not llvm-objdump --syms %t.32-bit.o 2>&1 | FileCheck -DSIZE=33 -DSYMSIZE=16 -DINDEX=2 %s
+# RUN: yaml2obj -DBITS=64 -DSIZE=49 -DDYNSIZE=48 %s -o %t.64-bit.o
+# RUN: not llvm-objdump --syms %t.64-bit.o 2>&1 | FileCheck -DSIZE=49 -DSYMSIZE=24 -DINDEX=2 %s
+
+## b) Broken .dynsym symbol table. Valid .symtab symbol table.
+# RUN: yaml2obj -DBITS=32 -DSIZE=32 -DDYNSIZE=33 %s -o %t.32-bit.o
+# RUN: not llvm-objdump --dynamic-syms %t.32-bit.o 2>&1 | FileCheck -DSIZE=33 -DSYMSIZE=16 -DINDEX=3 %s
+# RUN: yaml2obj -DBITS=64 -DSIZE=48 -DDYNSIZE=49 %s -o %t.64-bit.o
+# RUN: not llvm-objdump --dynamic-syms %t.64-bit.o 2>&1 | FileCheck -DSIZE=49 -DSYMSIZE=24 -DINDEX=3 %s
+
+# CHECK: error: {{.*}} section [index [[INDEX]]] has an invalid sh_size ([[SIZE]]) which is not a multiple of its sh_entsize ([[SYMSIZE]])
+
+--- !ELF
+FileHeader:
+  Class:   ELFCLASS[[BITS]]
+  Data:    ELFDATA2LSB
+  Type:    ET_DYN
+  Machine: EM_X86_64
+Sections:
+  - Name:    .dynstr
+    Type:    SHT_STRTAB
+    Content: "00"
+  - Name:    .symtab
+    Type:    SHT_SYMTAB
+    Size:    [[SIZE]]
+  - Name:    .dynsym
+    Type:    SHT_DYNSYM
+    Size:    [[DYNSIZE]]

llvm/test/tools/llvm-size/invalid-symbol-table-size.test

@@ -0,0 +1,25 @@
+## This test ensures llvm-size emits a helpful error message when dumping a symbol table
+## whose sh_size isn't a multiple of the symbol size (sh_size % sizeof(Elf_Sym) != 0).
+
+## a) Test sysv output format.
+# RUN: yaml2obj -DBITS=32 -DSIZE=33 -DDYNSIZE=32 %s -o %t.32-bit.o
+# RUN: not llvm-size --common --format=sysv %t.32-bit.o 2>&1 | FileCheck -DSIZE=33 -DSYMSIZE=16 %s
+# RUN: yaml2obj -DBITS=64 -DSIZE=49 -DDYNSIZE=48 %s -o %t.64-bit.o
+# RUN: not llvm-size --common --format=sysv %t.64-bit.o 2>&1 | FileCheck -DSIZE=49 -DSYMSIZE=24 %s
+
+## b) Test berkeley output format.
+# RUN: not llvm-size --common --format=berkeley %t.32-bit.o 2>&1 | FileCheck -DSIZE=33 -DSYMSIZE=16 %s
+# RUN: not llvm-size --common --format=berkeley %t.64-bit.o 2>&1 | FileCheck -DSIZE=49 -DSYMSIZE=24 %s
+
+# CHECK: error: {{.*}} section [index 1] has an invalid sh_size ([[SIZE]]) which is not a multiple of its sh_entsize ([[SYMSIZE]])
+
+--- !ELF
+FileHeader:
+  Class:   ELFCLASS[[BITS]]
+  Data:    ELFDATA2LSB
+  Type:    ET_DYN
+  Machine: EM_X86_64
+Sections:
+  - Name:    .symtab
+    Type:    SHT_SYMTAB
+    Size:    [[SIZE]]

llvm/tools/llvm-nm/llvm-nm.cpp

@@ -1218,7 +1218,6 @@ static void dumpSymbolNamesFromObject(SymbolicFile &Obj, bool printName,
     for (BasicSymbolRef Sym : Symbols) {
       Expected<uint32_t> SymFlagsOrErr = Sym.getFlags();
       if (!SymFlagsOrErr) {
-        // TODO: Test this error.
         error(SymFlagsOrErr.takeError(), Obj.getFileName());
         return;
       }

llvm/tools/llvm-size/llvm-size.cpp

@@ -202,7 +202,6 @@ static Expected<uint64_t> getCommonSize(ObjectFile *Obj) {
     Expected<uint32_t> SymFlagsOrErr =
         Obj->getSymbolFlags(Sym.getRawDataRefImpl());
     if (!SymFlagsOrErr)
-      // TODO: Test this error.
       return SymFlagsOrErr.takeError();
     if (*SymFlagsOrErr & SymbolRef::SF_Common)
       TotalCommons += Obj->getCommonSymbolSize(Sym.getRawDataRefImpl());