[symbolizer] Avoid collecting symbols belonging to invalid sections.

[mattd]

Summary

llvm-symbolizer would originally report symbols that belonged to an invalid object file section.
Specifically the case where: *Symbol.getSection() == ObjFile.section_end()
This patch prevents the Symbolizer from collecting symbols that belong to invalid sections.

The test (from PR40591) introduces a case where two symbols have address 0,
one symbol is defined, 'foo', and the other is not defined, 'bar'. This patch will cause
the Symbolizer to keep 'foo' and ignore 'bar'.

As a side note, the logic for adding symbols to the Symbolizer's store
(SymbolizableObjectFile::addSymbol) replaces symbols with the
same <address, size> pair. At some point that logic should be revisited as in the
aforementioned case, 'bar' was overwriting 'foo' in the Symbolizer's store,
and 'foo' was forgotten.

This fixes PR40591

[jhenderson]

FWIW, I think this test belongs in the DebugInfo directory of the testsuite rather than tools/llvm-symbolizer, because it is testing functionality in the library rather than in the tool layer.

llvm/trunk/lib/DebugInfo/Symbolize/SymbolizableObjectFile.cpp

std::error_code SymbolizableObjectFile::addCoffExportSymbols(
   }
   return std::error_code();
 }
 
 std::error_code SymbolizableObjectFile::addSymbol(const SymbolRef &Symbol,
                                                   uint64_t SymbolSize,
                                                   DataExtractor *OpdExtractor,
                                                   uint64_t OpdAddress) {
+  // Avoid adding symbols from an unknown/undefined section.
+  const ObjectFile *Obj = Symbol.getObject();
+  Expected<section_iterator> Sec = Symbol.getSection();
+  if (!Sec || (Obj && Obj->section_end() == *Sec))
+    return std::error_code();
   Expected<SymbolRef::Type> SymbolTypeOrErr = Symbol.getType();
   if (!SymbolTypeOrErr)
     return errorToErrorCode(SymbolTypeOrErr.takeError());
   SymbolRef::Type SymbolType = *SymbolTypeOrErr;
   if (SymbolType != SymbolRef::ST_Function && SymbolType != SymbolRef::ST_Data)
     return std::error_code();
   Expected<uint64_t> SymbolAddressOrErr = Symbol.getAddress();
   if (!SymbolAddressOrErr)

llvm/trunk/test/tools/llvm-symbolizer/ignore-undefined-symbols.s

+# REQUIRES: x86-registered-target
+# RUN: llvm-mc --filetype=obj --triple=x86_64-pc-linux %s -o %t.o -g
+# RUN: llvm-symbolizer --obj=%t.o 0 | FileCheck %s --implicit-check-not=bar
+
+# CHECK:      foo
+# CHECK-NEXT: ignore-undefined-symbols.s:12:0
+
+.type bar,@function
+.type foo,@function
+.global foo
+foo:
+    call bar