pdbdump: Rename NumberOfSymbols -> SymbolRecordStreamIndex.

[ruiu]

Summary

It seems that the field's value is the the stream index that
contains symbol records, at least for empty.pdb.

[zturner]

Can you rename GSSyms while you're at it?

[ruiu]

How?

[zturner]

In D20441#434663, @ruiu wrote:

How?

GlobalSymbolStreamIndex

[ruiu]

Ah, okay, so originally it has "sn" prefix, so it must be a stream index. Will do.

[ruiu]

• Update as per zturner's comment

[zturner]

looks good

include/llvm/DebugInfo/PDB/Raw/DbiStream.h

public:
   bool hasCTypes() const;
   bool isStripped() const;
 
   uint16_t getBuildMajorVersion() const;
   uint16_t getBuildMinorVersion() const;
 
   uint32_t getPdbDllVersion() const;
 
-  uint32_t getNumberOfSymbols() const;
+  uint32_t getSymRecordStreamIndex() const;
 
   PDB_Machine getMachineType() const;
 
   ArrayRef<ModuleInfoEx> modules() const;
 
 private:
   Error initializeFileInfo();
 

lib/DebugInfo/PDB/Raw/DbiStream.cpp

 const uint16_t BuildMajorMask = 0x7F00;
 const uint16_t BuildMajorShift = 8;
 }
 
 struct DbiStream::HeaderInfo {
   little32_t VersionSignature;
   ulittle32_t VersionHeader;
   ulittle32_t Age;                     // Should match InfoStream.
-  ulittle16_t GSSyms;                  // Number of global symbols
+  ulittle16_t GlobalSymbolStreamIndex; // Global symbol stream #
   ulittle16_t BuildNumber;             // See DbiBuildNo structure.
-  ulittle16_t PublicSymbolStreamIndex; // Number of public symbols
+  ulittle16_t PublicSymbolStreamIndex; // Public symbols stream #
   ulittle16_t PdbDllVersion;           // version of mspdbNNN.dll
-  ulittle16_t SymRecords;              // Number of symbols
+  ulittle16_t SymRecordStreamIndex;    // Symbol records stream #
   ulittle16_t PdbDllRbld;              // rbld number of mspdbNNN.dll
   little32_t ModiSubstreamSize;        // Size of module info stream
   little32_t SecContrSubstreamSize;    // Size of sec. contribution stream
   little32_t SectionMapSize;           // Size of sec. map substream
   little32_t FileInfoSize;             // Size of file info substream
   little32_t TypeServerSize;      // Size of type server map
   ulittle32_t MFCTypeServerIndex; // Index of MFC Type Server
   little32_t OptionalDbgHdrSize;  // Size of DbgHeader info

 }
 
 uint16_t DbiStream::getBuildMinorVersion() const {
   return (Header->BuildNumber & BuildMinorMask) >> BuildMinorShift;
 }
 
 uint32_t DbiStream::getPdbDllVersion() const { return Header->PdbDllVersion; }
 
-uint32_t DbiStream::getNumberOfSymbols() const { return Header->SymRecords; }
+uint32_t DbiStream::getSymRecordStreamIndex() const {
+  return Header->SymRecordStreamIndex;
+}
 
 PDB_Machine DbiStream::getMachineType() const {
   uint16_t Machine = Header->MachineType;
   return static_cast<PDB_Machine>(Machine);
 }
 
 ArrayRef<ModuleInfoEx> DbiStream::modules() const { return ModuleInfos; }
 

test/DebugInfo/PDB/pdbdump-headers.test

 ; EMPTY-NEXT: }
 ; EMPTY-NEXT: DBI Stream {
 ; EMPTY-NEXT:   Dbi Version: 19990903
 ; EMPTY-NEXT:   Age: 1
 ; EMPTY-NEXT:   Incremental Linking: Yes
 ; EMPTY-NEXT:   Has CTypes: No
 ; EMPTY-NEXT:   Is Stripped: No
 ; EMPTY-NEXT:   Machine Type: x86
-; EMPTY-NEXT:   Number of Symbols: 8
+; EMPTY-NEXT:   Symbol Record Stream Index: 8
 ; EMPTY-NEXT:   Toolchain Version: 12.0
 ; EMPTY-NEXT:   mspdb120.dll version: 12.0.31101
 ; EMPTY-NEXT:   Modules [
 ; EMPTY-NEXT:     {
 ; EMPTY-NEXT:       Name: d:\src\llvm\test\DebugInfo\PDB\Inputs\empty.obj
 ; EMPTY-NEXT:       Debug Stream Index: 12
 ; EMPTY-NEXT:       Object File Name: d:\src\llvm\test\DebugInfo\PDB\Inputs\empty.obj
 ; EMPTY-NEXT:       Num Files: 1

 ; BIG-NEXT: }
 ; BIG-NEXT: DBI Stream {
 ; BIG-NEXT:   Dbi Version: 19990903
 ; BIG-NEXT:   Age: 1
 ; BIG-NEXT:   Incremental Linking: Yes
 ; BIG-NEXT:   Has CTypes: No
 ; BIG-NEXT:   Is Stripped: No
 ; BIG-NEXT:   Machine Type: x86
-; BIG-NEXT:   Number of Symbols: 9
+; BIG-NEXT:   Symbol Record Stream Index: 9
 ; BIG-NEXT:   Toolchain Version: 14.0
 ; BIG-NEXT:   mspdb140.dll version: 14.0.23918
 ; BIG-NEXT:   Modules [
 ; BIG-NEXT:     {
 ; BIG-NEXT:       Name: D:\src\llvm\test\tools\llvm-symbolizer\pdb\Inputs\test.obj
 ; BIG-NEXT:       Debug Stream Index: 12
 ; BIG-NEXT:       Object File Name: D:\src\llvm\test\tools\llvm-symbolizer\pdb\Inputs\test.obj
 ; BIG-NEXT:       Num Files: 1

tools/llvm-pdbdump/llvm-pdbdump.cpp

static Error dumpDbiStream(ScopedPrinter &P, PDBFile &File) {
 
   DictScope D(P, "DBI Stream");
   P.printNumber("Dbi Version", DS.getDbiVersion());
   P.printNumber("Age", DS.getAge());
   P.printBoolean("Incremental Linking", DS.isIncrementallyLinked());
   P.printBoolean("Has CTypes", DS.hasCTypes());
   P.printBoolean("Is Stripped", DS.isStripped());
   P.printObject("Machine Type", DS.getMachineType());
-  P.printNumber("Number of Symbols", DS.getNumberOfSymbols());
+  P.printNumber("Symbol Record Stream Index", DS.getSymRecordStreamIndex());
 
   uint16_t Major = DS.getBuildMajorVersion();
   uint16_t Minor = DS.getBuildMinorVersion();
   P.printVersion("Toolchain Version", Major, Minor);
 
   std::string DllName;
   raw_string_ostream DllStream(DllName);
   DllStream << "mspdb" << Major << Minor << ".dll version";