contrib/llvm/tools/llvm-pdbdump/LLVMOutputStyle.cpp

   1 //===- LLVMOutputStyle.cpp ------------------------------------ *- C++ --*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9
  10 #include "LLVMOutputStyle.h"
  11
  12 #include "llvm-pdbdump.h"
  13 #include "llvm/DebugInfo/CodeView/EnumTables.h"
  14 #include "llvm/DebugInfo/CodeView/ModuleSubstreamVisitor.h"
  15 #include "llvm/DebugInfo/CodeView/SymbolDumper.h"
  16 #include "llvm/DebugInfo/PDB/PDBExtras.h"
  17 #include "llvm/DebugInfo/PDB/Raw/DbiStream.h"
  18 #include "llvm/DebugInfo/PDB/Raw/EnumTables.h"
  19 #include "llvm/DebugInfo/PDB/Raw/ISectionContribVisitor.h"
  20 #include "llvm/DebugInfo/PDB/Raw/IndexedStreamData.h"
  21 #include "llvm/DebugInfo/PDB/Raw/InfoStream.h"
  22 #include "llvm/DebugInfo/PDB/Raw/ModInfo.h"
  23 #include "llvm/DebugInfo/PDB/Raw/ModStream.h"
  24 #include "llvm/DebugInfo/PDB/Raw/PDBFile.h"
  25 #include "llvm/DebugInfo/PDB/Raw/PublicsStream.h"
  26 #include "llvm/DebugInfo/PDB/Raw/RawError.h"
  27 #include "llvm/DebugInfo/PDB/Raw/TpiStream.h"
  28 #include "llvm/Object/COFF.h"
  29
  30 #include <unordered_map>
  31
  32 using namespace llvm;
  33 using namespace llvm::codeview;
  34 using namespace llvm::pdb;
  35
  36 static void printSectionOffset(llvm::raw_ostream &OS,
  37                                const SectionOffset &Off) {
  38   OS << Off.Off << ", " << Off.Isect;
  39 }
  40
  41 LLVMOutputStyle::LLVMOutputStyle(PDBFile &File)
  42     : File(File), P(outs()), TD(&P, false) {}
  43
  44 Error LLVMOutputStyle::dump() {
  45   if (auto EC = dumpFileHeaders())
  46     return EC;
  47
  48   if (auto EC = dumpStreamSummary())
  49     return EC;
  50
  51   if (auto EC = dumpStreamBlocks())
  52     return EC;
  53
  54   if (auto EC = dumpStreamData())
  55     return EC;
  56
  57   if (auto EC = dumpInfoStream())
  58     return EC;
  59
  60   if (auto EC = dumpNamedStream())
  61     return EC;
  62
  63   if (auto EC = dumpTpiStream(StreamTPI))
  64     return EC;
  65
  66   if (auto EC = dumpTpiStream(StreamIPI))
  67     return EC;
  68
  69   if (auto EC = dumpDbiStream())
  70     return EC;
  71
  72   if (auto EC = dumpSectionContribs())
  73     return EC;
  74
  75   if (auto EC = dumpSectionMap())
  76     return EC;
  77
  78   if (auto EC = dumpPublicsStream())
  79     return EC;
  80
  81   if (auto EC = dumpSectionHeaders())
  82     return EC;
  83
  84   if (auto EC = dumpFpoStream())
  85     return EC;
  86
  87   flush();
  88
  89   return Error::success();
  90 }
  91
  92 Error LLVMOutputStyle::dumpFileHeaders() {
  93   if (!opts::raw::DumpHeaders)
  94     return Error::success();
  95
  96   DictScope D(P, "FileHeaders");
  97   P.printNumber("BlockSize", File.getBlockSize());
  98   P.printNumber("FreeBlockMap", File.getFreeBlockMapBlock());
  99   P.printNumber("NumBlocks", File.getBlockCount());
 100   P.printNumber("NumDirectoryBytes", File.getNumDirectoryBytes());
 101   P.printNumber("Unknown1", File.getUnknown1());
 102   P.printNumber("BlockMapAddr", File.getBlockMapIndex());
 103   P.printNumber("NumDirectoryBlocks", File.getNumDirectoryBlocks());
 104
 105   // The directory is not contiguous.  Instead, the block map contains a
 106   // contiguous list of block numbers whose contents, when concatenated in
 107   // order, make up the directory.
 108   P.printList("DirectoryBlocks", File.getDirectoryBlockArray());
 109   P.printNumber("NumStreams", File.getNumStreams());
 110   return Error::success();
 111 }
 112
 113 Error LLVMOutputStyle::dumpStreamSummary() {
 114   if (!opts::raw::DumpStreamSummary)
 115     return Error::success();
 116
 117   // It's OK if we fail to load some of these streams, we still attempt to print
 118   // what we can.
 119   auto Dbi = File.getPDBDbiStream();
 120   auto Tpi = File.getPDBTpiStream();
 121   auto Ipi = File.getPDBIpiStream();
 122   auto Info = File.getPDBInfoStream();
 123
 124   ListScope L(P, "Streams");
 125   uint32_t StreamCount = File.getNumStreams();
 126   std::unordered_map<uint16_t, const ModuleInfoEx *> ModStreams;
 127   std::unordered_map<uint16_t, std::string> NamedStreams;
 128
 129   if (Dbi) {
 130     for (auto &ModI : Dbi->modules()) {
 131       uint16_t SN = ModI.Info.getModuleStreamIndex();
 132       ModStreams[SN] = &ModI;
 133     }
 134   }
 135   if (Info) {
 136     for (auto &NSE : Info->named_streams()) {
 137       NamedStreams[NSE.second] = NSE.first();
 138     }
 139   }
 140
 141   for (uint16_t StreamIdx = 0; StreamIdx < StreamCount; ++StreamIdx) {
 142     std::string Label("Stream ");
 143     Label += to_string(StreamIdx);
 144     std::string Value;
 145     if (StreamIdx == OldMSFDirectory)
 146       Value = "Old MSF Directory";
 147     else if (StreamIdx == StreamPDB)
 148       Value = "PDB Stream";
 149     else if (StreamIdx == StreamDBI)
 150       Value = "DBI Stream";
 151     else if (StreamIdx == StreamTPI)
 152       Value = "TPI Stream";
 153     else if (StreamIdx == StreamIPI)
 154       Value = "IPI Stream";
 155     else if (Dbi && StreamIdx == Dbi->getGlobalSymbolStreamIndex())
 156       Value = "Global Symbol Hash";
 157     else if (Dbi && StreamIdx == Dbi->getPublicSymbolStreamIndex())
 158       Value = "Public Symbol Hash";
 159     else if (Dbi && StreamIdx == Dbi->getSymRecordStreamIndex())
 160       Value = "Public Symbol Records";
 161     else if (Tpi && StreamIdx == Tpi->getTypeHashStreamIndex())
 162       Value = "TPI Hash";
 163     else if (Tpi && StreamIdx == Tpi->getTypeHashStreamAuxIndex())
 164       Value = "TPI Aux Hash";
 165     else if (Ipi && StreamIdx == Ipi->getTypeHashStreamIndex())
 166       Value = "IPI Hash";
 167     else if (Ipi && StreamIdx == Ipi->getTypeHashStreamAuxIndex())
 168       Value = "IPI Aux Hash";
 169     else if (Dbi &&
 170              StreamIdx == Dbi->getDebugStreamIndex(DbgHeaderType::Exception))
 171       Value = "Exception Data";
 172     else if (Dbi && StreamIdx == Dbi->getDebugStreamIndex(DbgHeaderType::Fixup))
 173       Value = "Fixup Data";
 174     else if (Dbi && StreamIdx == Dbi->getDebugStreamIndex(DbgHeaderType::FPO))
 175       Value = "FPO Data";
 176     else if (Dbi &&
 177              StreamIdx == Dbi->getDebugStreamIndex(DbgHeaderType::NewFPO))
 178       Value = "New FPO Data";
 179     else if (Dbi &&
 180              StreamIdx == Dbi->getDebugStreamIndex(DbgHeaderType::OmapFromSrc))
 181       Value = "Omap From Source Data";
 182     else if (Dbi &&
 183              StreamIdx == Dbi->getDebugStreamIndex(DbgHeaderType::OmapToSrc))
 184       Value = "Omap To Source Data";
 185     else if (Dbi && StreamIdx == Dbi->getDebugStreamIndex(DbgHeaderType::Pdata))
 186       Value = "Pdata";
 187     else if (Dbi &&
 188              StreamIdx == Dbi->getDebugStreamIndex(DbgHeaderType::SectionHdr))
 189       Value = "Section Header Data";
 190     else if (Dbi &&
 191              StreamIdx ==
 192                  Dbi->getDebugStreamIndex(DbgHeaderType::SectionHdrOrig))
 193       Value = "Section Header Original Data";
 194     else if (Dbi &&
 195              StreamIdx == Dbi->getDebugStreamIndex(DbgHeaderType::TokenRidMap))
 196       Value = "Token Rid Data";
 197     else if (Dbi && StreamIdx == Dbi->getDebugStreamIndex(DbgHeaderType::Xdata))
 198       Value = "Xdata";
 199     else {
 200       auto ModIter = ModStreams.find(StreamIdx);
 201       auto NSIter = NamedStreams.find(StreamIdx);
 202       if (ModIter != ModStreams.end()) {
 203         Value = "Module \"";
 204         Value += ModIter->second->Info.getModuleName().str();
 205         Value += "\"";
 206       } else if (NSIter != NamedStreams.end()) {
 207         Value = "Named Stream \"";
 208         Value += NSIter->second;
 209         Value += "\"";
 210       } else {
 211         Value = "???";
 212       }
 213     }
 214     Value = "[" + Value + "]";
 215     Value =
 216         Value + " (" + to_string(File.getStreamByteSize(StreamIdx)) + " bytes)";
 217
 218     P.printString(Label, Value);
 219   }
 220
 221   // Consume errors from missing streams.
 222   if (!Dbi)
 223     consumeError(Dbi.takeError());
 224   if (!Tpi)
 225     consumeError(Tpi.takeError());
 226   if (!Ipi)
 227     consumeError(Ipi.takeError());
 228   if (!Info)
 229     consumeError(Info.takeError());
 230
 231   P.flush();
 232   return Error::success();
 233 }
 234
 235 Error LLVMOutputStyle::dumpStreamBlocks() {
 236   if (!opts::raw::DumpStreamBlocks)
 237     return Error::success();
 238
 239   ListScope L(P, "StreamBlocks");
 240   uint32_t StreamCount = File.getNumStreams();
 241   for (uint32_t StreamIdx = 0; StreamIdx < StreamCount; ++StreamIdx) {
 242     std::string Name("Stream ");
 243     Name += to_string(StreamIdx);
 244     auto StreamBlocks = File.getStreamBlockList(StreamIdx);
 245     P.printList(Name, StreamBlocks);
 246   }
 247   return Error::success();
 248 }
 249
 250 Error LLVMOutputStyle::dumpStreamData() {
 251   uint32_t StreamCount = File.getNumStreams();
 252   StringRef DumpStreamStr = opts::raw::DumpStreamDataIdx;
 253   uint32_t DumpStreamNum;
 254   if (DumpStreamStr.getAsInteger(/*Radix=*/0U, DumpStreamNum))
 255     return Error::success();
 256
 257   if (DumpStreamNum >= StreamCount)
 258     return make_error<RawError>(raw_error_code::no_stream);
 259
 260   auto S = MappedBlockStream::createIndexedStream(DumpStreamNum, File);
 261   if (!S)
 262     return S.takeError();
 263   codeview::StreamReader R(**S);
 264   while (R.bytesRemaining() > 0) {
 265     ArrayRef<uint8_t> Data;
 266     uint32_t BytesToReadInBlock = std::min(
 267         R.bytesRemaining(), static_cast<uint32_t>(File.getBlockSize()));
 268     if (auto EC = R.readBytes(Data, BytesToReadInBlock))
 269       return EC;
 270     P.printBinaryBlock(
 271         "Data",
 272         StringRef(reinterpret_cast<const char *>(Data.begin()), Data.size()));
 273   }
 274   return Error::success();
 275 }
 276
 277 Error LLVMOutputStyle::dumpInfoStream() {
 278   if (!opts::raw::DumpHeaders)
 279     return Error::success();
 280   auto IS = File.getPDBInfoStream();
 281   if (!IS)
 282     return IS.takeError();
 283
 284   DictScope D(P, "PDB Stream");
 285   P.printNumber("Version", IS->getVersion());
 286   P.printHex("Signature", IS->getSignature());
 287   P.printNumber("Age", IS->getAge());
 288   P.printObject("Guid", IS->getGuid());
 289   return Error::success();
 290 }
 291
 292 Error LLVMOutputStyle::dumpNamedStream() {
 293   if (opts::raw::DumpStreamDataName.empty())
 294     return Error::success();
 295
 296   auto IS = File.getPDBInfoStream();
 297   if (!IS)
 298     return IS.takeError();
 299
 300   uint32_t NameStreamIndex =
 301       IS->getNamedStreamIndex(opts::raw::DumpStreamDataName);
 302   if (NameStreamIndex == 0 || NameStreamIndex >= File.getNumStreams())
 303     return make_error<RawError>(raw_error_code::no_stream);
 304
 305   if (NameStreamIndex != 0) {
 306     std::string Name("Stream '");
 307     Name += opts::raw::DumpStreamDataName;
 308     Name += "'";
 309     DictScope D(P, Name);
 310     P.printNumber("Index", NameStreamIndex);
 311
 312     auto NameStream =
 313         MappedBlockStream::createIndexedStream(NameStreamIndex, File);
 314     if (!NameStream)
 315       return NameStream.takeError();
 316     codeview::StreamReader Reader(**NameStream);
 317
 318     NameHashTable NameTable;
 319     if (auto EC = NameTable.load(Reader))
 320       return EC;
 321
 322     P.printHex("Signature", NameTable.getSignature());
 323     P.printNumber("Version", NameTable.getHashVersion());
 324     P.printNumber("Name Count", NameTable.getNameCount());
 325     ListScope L(P, "Names");
 326     for (uint32_t ID : NameTable.name_ids()) {
 327       StringRef Str = NameTable.getStringForID(ID);
 328       if (!Str.empty())
 329         P.printString(to_string(ID), Str);
 330     }
 331   }
 332   return Error::success();
 333 }
 334
 335 static void printTypeIndexOffset(raw_ostream &OS,
 336                                  const TypeIndexOffset &TIOff) {
 337   OS << "{" << TIOff.Type.getIndex() << ", " << TIOff.Offset << "}";
 338 }
 339
 340 static void dumpTpiHash(ScopedPrinter &P, TpiStream &Tpi) {
 341   if (!opts::raw::DumpTpiHash)
 342     return;
 343   DictScope DD(P, "Hash");
 344   P.printNumber("Number of Hash Buckets", Tpi.NumHashBuckets());
 345   P.printNumber("Hash Key Size", Tpi.getHashKeySize());
 346   P.printList("Values", Tpi.getHashValues());
 347   P.printList("Type Index Offsets", Tpi.getTypeIndexOffsets(),
 348               printTypeIndexOffset);
 349   P.printList("Hash Adjustments", Tpi.getHashAdjustments(),
 350               printTypeIndexOffset);
 351 }
 352
 353 Error LLVMOutputStyle::dumpTpiStream(uint32_t StreamIdx) {
 354   assert(StreamIdx == StreamTPI || StreamIdx == StreamIPI);
 355
 356   bool DumpRecordBytes = false;
 357   bool DumpRecords = false;
 358   StringRef Label;
 359   StringRef VerLabel;
 360   if (StreamIdx == StreamTPI) {
 361     DumpRecordBytes = opts::raw::DumpTpiRecordBytes;
 362     DumpRecords = opts::raw::DumpTpiRecords;
 363     Label = "Type Info Stream (TPI)";
 364     VerLabel = "TPI Version";
 365   } else if (StreamIdx == StreamIPI) {
 366     DumpRecordBytes = opts::raw::DumpIpiRecordBytes;
 367     DumpRecords = opts::raw::DumpIpiRecords;
 368     Label = "Type Info Stream (IPI)";
 369     VerLabel = "IPI Version";
 370   }
 371   if (!DumpRecordBytes && !DumpRecords && !opts::raw::DumpModuleSyms)
 372     return Error::success();
 373
 374   auto Tpi = (StreamIdx == StreamTPI) ? File.getPDBTpiStream()
 375                                       : File.getPDBIpiStream();
 376   if (!Tpi)
 377     return Tpi.takeError();
 378
 379   if (DumpRecords || DumpRecordBytes) {
 380     DictScope D(P, Label);
 381
 382     P.printNumber(VerLabel, Tpi->getTpiVersion());
 383     P.printNumber("Record count", Tpi->NumTypeRecords());
 384
 385     ListScope L(P, "Records");
 386
 387     bool HadError = false;
 388     for (auto &Type : Tpi->types(&HadError)) {
 389       DictScope DD(P, "");
 390
 391       if (DumpRecords) {
 392         if (auto EC = TD.dump(Type))
 393           return EC;
 394       }
 395
 396       if (DumpRecordBytes)
 397         P.printBinaryBlock("Bytes", Type.Data);
 398     }
 399     dumpTpiHash(P, *Tpi);
 400     if (HadError)
 401       return make_error<RawError>(raw_error_code::corrupt_file,
 402                                   "TPI stream contained corrupt record");
 403   } else if (opts::raw::DumpModuleSyms) {
 404     // Even if the user doesn't want to dump type records, we still need to
 405     // iterate them in order to build the list of types so that we can print
 406     // them when dumping module symbols. So when they want to dump symbols
 407     // but not types, use a null output stream.
 408     ScopedPrinter *OldP = TD.getPrinter();
 409     TD.setPrinter(nullptr);
 410
 411     bool HadError = false;
 412     for (auto &Type : Tpi->types(&HadError)) {
 413       if (auto EC = TD.dump(Type))
 414         return EC;
 415     }
 416
 417     TD.setPrinter(OldP);
 418     dumpTpiHash(P, *Tpi);
 419     if (HadError)
 420       return make_error<RawError>(raw_error_code::corrupt_file,
 421                                   "TPI stream contained corrupt record");
 422   }
 423   P.flush();
 424   return Error::success();
 425 }
 426
 427 Error LLVMOutputStyle::dumpDbiStream() {
 428   bool DumpModules = opts::raw::DumpModules || opts::raw::DumpModuleSyms ||
 429                      opts::raw::DumpModuleFiles || opts::raw::DumpLineInfo;
 430   if (!opts::raw::DumpHeaders && !DumpModules)
 431     return Error::success();
 432
 433   auto DS = File.getPDBDbiStream();
 434   if (!DS)
 435     return DS.takeError();
 436
 437   DictScope D(P, "DBI Stream");
 438   P.printNumber("Dbi Version", DS->getDbiVersion());
 439   P.printNumber("Age", DS->getAge());
 440   P.printBoolean("Incremental Linking", DS->isIncrementallyLinked());
 441   P.printBoolean("Has CTypes", DS->hasCTypes());
 442   P.printBoolean("Is Stripped", DS->isStripped());
 443   P.printObject("Machine Type", DS->getMachineType());
 444   P.printNumber("Symbol Record Stream Index", DS->getSymRecordStreamIndex());
 445   P.printNumber("Public Symbol Stream Index", DS->getPublicSymbolStreamIndex());
 446   P.printNumber("Global Symbol Stream Index", DS->getGlobalSymbolStreamIndex());
 447
 448   uint16_t Major = DS->getBuildMajorVersion();
 449   uint16_t Minor = DS->getBuildMinorVersion();
 450   P.printVersion("Toolchain Version", Major, Minor);
 451
 452   std::string DllName;
 453   raw_string_ostream DllStream(DllName);
 454   DllStream << "mspdb" << Major << Minor << ".dll version";
 455   DllStream.flush();
 456   P.printVersion(DllName, Major, Minor, DS->getPdbDllVersion());
 457
 458   if (DumpModules) {
 459     ListScope L(P, "Modules");
 460     for (auto &Modi : DS->modules()) {
 461       DictScope DD(P);
 462       P.printString("Name", Modi.Info.getModuleName().str());
 463       P.printNumber("Debug Stream Index", Modi.Info.getModuleStreamIndex());
 464       P.printString("Object File Name", Modi.Info.getObjFileName().str());
 465       P.printNumber("Num Files", Modi.Info.getNumberOfFiles());
 466       P.printNumber("Source File Name Idx", Modi.Info.getSourceFileNameIndex());
 467       P.printNumber("Pdb File Name Idx", Modi.Info.getPdbFilePathNameIndex());
 468       P.printNumber("Line Info Byte Size", Modi.Info.getLineInfoByteSize());
 469       P.printNumber("C13 Line Info Byte Size",
 470                     Modi.Info.getC13LineInfoByteSize());
 471       P.printNumber("Symbol Byte Size", Modi.Info.getSymbolDebugInfoByteSize());
 472       P.printNumber("Type Server Index", Modi.Info.getTypeServerIndex());
 473       P.printBoolean("Has EC Info", Modi.Info.hasECInfo());
 474       if (opts::raw::DumpModuleFiles) {
 475         std::string FileListName =
 476             to_string(Modi.SourceFiles.size()) + " Contributing Source Files";
 477         ListScope LL(P, FileListName);
 478         for (auto File : Modi.SourceFiles)
 479           P.printString(File.str());
 480       }
 481       bool HasModuleDI =
 482           (Modi.Info.getModuleStreamIndex() < File.getNumStreams());
 483       bool ShouldDumpSymbols =
 484           (opts::raw::DumpModuleSyms || opts::raw::DumpSymRecordBytes);
 485       if (HasModuleDI && (ShouldDumpSymbols || opts::raw::DumpLineInfo)) {
 486         auto ModStreamData = MappedBlockStream::createIndexedStream(
 487             Modi.Info.getModuleStreamIndex(), File);
 488         if (!ModStreamData)
 489           return ModStreamData.takeError();
 490         ModStream ModS(Modi.Info, std::move(*ModStreamData));
 491         if (auto EC = ModS.reload())
 492           return EC;
 493
 494         if (ShouldDumpSymbols) {
 495           ListScope SS(P, "Symbols");
 496           codeview::CVSymbolDumper SD(P, TD, nullptr, false);
 497           bool HadError = false;
 498           for (const auto &S : ModS.symbols(&HadError)) {
 499             DictScope DD(P, "");
 500
 501             if (opts::raw::DumpModuleSyms)
 502               SD.dump(S);
 503             if (opts::raw::DumpSymRecordBytes)
 504               P.printBinaryBlock("Bytes", S.Data);
 505           }
 506           if (HadError)
 507             return make_error<RawError>(
 508                 raw_error_code::corrupt_file,
 509                 "DBI stream contained corrupt symbol record");
 510         }
 511         if (opts::raw::DumpLineInfo) {
 512           ListScope SS(P, "LineInfo");
 513           bool HadError = false;
 514           // Define a locally scoped visitor to print the different
 515           // substream types types.
 516           class RecordVisitor : public codeview::IModuleSubstreamVisitor {
 517           public:
 518             RecordVisitor(ScopedPrinter &P, PDBFile &F) : P(P), F(F) {}
 519             Error visitUnknown(ModuleSubstreamKind Kind,
 520                                StreamRef Stream) override {
 521               DictScope DD(P, "Unknown");
 522               ArrayRef<uint8_t> Data;
 523               StreamReader R(Stream);
 524               if (auto EC = R.readBytes(Data, R.bytesRemaining())) {
 525                 return make_error<RawError>(
 526                     raw_error_code::corrupt_file,
 527                     "DBI stream contained corrupt line info record");
 528               }
 529               P.printBinaryBlock("Data", Data);
 530               return Error::success();
 531             }
 532             Error
 533             visitFileChecksums(StreamRef Data,
 534                                const FileChecksumArray &Checksums) override {
 535               DictScope DD(P, "FileChecksums");
 536               for (const auto &C : Checksums) {
 537                 DictScope DDD(P, "Checksum");
 538                 if (auto Result = getFileNameForOffset(C.FileNameOffset))
 539                   P.printString("FileName", Result.get());
 540                 else
 541                   return Result.takeError();
 542                 P.flush();
 543                 P.printEnum("Kind", uint8_t(C.Kind), getFileChecksumNames());
 544                 P.printBinaryBlock("Checksum", C.Checksum);
 545               }
 546               return Error::success();
 547             }
 548
 549             Error visitLines(StreamRef Data, const LineSubstreamHeader *Header,
 550                              const LineInfoArray &Lines) override {
 551               DictScope DD(P, "Lines");
 552               for (const auto &L : Lines) {
 553                 if (auto Result = getFileNameForOffset2(L.NameIndex))
 554                   P.printString("FileName", Result.get());
 555                 else
 556                   return Result.takeError();
 557                 P.flush();
 558                 for (const auto &N : L.LineNumbers) {
 559                   DictScope DDD(P, "Line");
 560                   LineInfo LI(N.Flags);
 561                   P.printNumber("Offset", N.Offset);
 562                   if (LI.isAlwaysStepInto())
 563                     P.printString("StepInto", StringRef("Always"));
 564                   else if (LI.isNeverStepInto())
 565                     P.printString("StepInto", StringRef("Never"));
 566                   else
 567                     P.printNumber("LineNumberStart", LI.getStartLine());
 568                   P.printNumber("EndDelta", LI.getLineDelta());
 569                   P.printBoolean("IsStatement", LI.isStatement());
 570                 }
 571                 for (const auto &C : L.Columns) {
 572                   DictScope DDD(P, "Column");
 573                   P.printNumber("Start", C.StartColumn);
 574                   P.printNumber("End", C.EndColumn);
 575                 }
 576               }
 577               return Error::success();
 578             }
 579
 580           private:
 581             Expected<StringRef> getFileNameForOffset(uint32_t Offset) {
 582               auto ST = F.getStringTable();
 583               if (!ST)
 584                 return ST.takeError();
 585
 586               return ST->getStringForID(Offset);
 587             }
 588             Expected<StringRef> getFileNameForOffset2(uint32_t Offset) {
 589               auto DS = F.getPDBDbiStream();
 590               if (!DS)
 591                 return DS.takeError();
 592               return DS->getFileNameForIndex(Offset);
 593             }
 594             ScopedPrinter &P;
 595             PDBFile &F;
 596           };
 597
 598           RecordVisitor V(P, File);
 599           for (const auto &L : ModS.lines(&HadError)) {
 600             if (auto EC = codeview::visitModuleSubstream(L, V))
 601               return EC;
 602           }
 603         }
 604       }
 605     }
 606   }
 607   return Error::success();
 608 }
 609
 610 Error LLVMOutputStyle::dumpSectionContribs() {
 611   if (!opts::raw::DumpSectionContribs)
 612     return Error::success();
 613
 614   auto Dbi = File.getPDBDbiStream();
 615   if (!Dbi)
 616     return Dbi.takeError();
 617
 618   ListScope L(P, "Section Contributions");
 619   class Visitor : public ISectionContribVisitor {
 620   public:
 621     Visitor(ScopedPrinter &P, DbiStream &DS) : P(P), DS(DS) {}
 622     void visit(const SectionContrib &SC) override {
 623       DictScope D(P, "Contribution");
 624       P.printNumber("ISect", SC.ISect);
 625       P.printNumber("Off", SC.Off);
 626       P.printNumber("Size", SC.Size);
 627       P.printFlags("Characteristics", SC.Characteristics,
 628                    codeview::getImageSectionCharacteristicNames(),
 629                    COFF::SectionCharacteristics(0x00F00000));
 630       {
 631         DictScope DD(P, "Module");
 632         P.printNumber("Index", SC.Imod);
 633         auto M = DS.modules();
 634         if (M.size() > SC.Imod) {
 635           P.printString("Name", M[SC.Imod].Info.getModuleName());
 636         }
 637       }
 638       P.printNumber("Data CRC", SC.DataCrc);
 639       P.printNumber("Reloc CRC", SC.RelocCrc);
 640       P.flush();
 641     }
 642     void visit(const SectionContrib2 &SC) override {
 643       visit(SC.Base);
 644       P.printNumber("ISect Coff", SC.ISectCoff);
 645       P.flush();
 646     }
 647
 648   private:
 649     ScopedPrinter &P;
 650     DbiStream &DS;
 651   };
 652   Visitor V(P, *Dbi);
 653   Dbi->visitSectionContributions(V);
 654   return Error::success();
 655 }
 656
 657 Error LLVMOutputStyle::dumpSectionMap() {
 658   if (!opts::raw::DumpSectionMap)
 659     return Error::success();
 660
 661   auto Dbi = File.getPDBDbiStream();
 662   if (!Dbi)
 663     return Dbi.takeError();
 664
 665   ListScope L(P, "Section Map");
 666   for (auto &M : Dbi->getSectionMap()) {
 667     DictScope D(P, "Entry");
 668     P.printFlags("Flags", M.Flags, getOMFSegMapDescFlagNames());
 669     P.printNumber("Flags", M.Flags);
 670     P.printNumber("Ovl", M.Ovl);
 671     P.printNumber("Group", M.Group);
 672     P.printNumber("Frame", M.Frame);
 673     P.printNumber("SecName", M.SecName);
 674     P.printNumber("ClassName", M.ClassName);
 675     P.printNumber("Offset", M.Offset);
 676     P.printNumber("SecByteLength", M.SecByteLength);
 677     P.flush();
 678   }
 679   return Error::success();
 680 }
 681
 682 Error LLVMOutputStyle::dumpPublicsStream() {
 683   if (!opts::raw::DumpPublics)
 684     return Error::success();
 685
 686   DictScope D(P, "Publics Stream");
 687   auto Publics = File.getPDBPublicsStream();
 688   if (!Publics)
 689     return Publics.takeError();
 690
 691   auto Dbi = File.getPDBDbiStream();
 692   if (!Dbi)
 693     return Dbi.takeError();
 694
 695   P.printNumber("Stream number", Dbi->getPublicSymbolStreamIndex());
 696   P.printNumber("SymHash", Publics->getSymHash());
 697   P.printNumber("AddrMap", Publics->getAddrMap());
 698   P.printNumber("Number of buckets", Publics->getNumBuckets());
 699   P.printList("Hash Buckets", Publics->getHashBuckets());
 700   P.printList("Address Map", Publics->getAddressMap());
 701   P.printList("Thunk Map", Publics->getThunkMap());
 702   P.printList("Section Offsets", Publics->getSectionOffsets(),
 703               printSectionOffset);
 704   ListScope L(P, "Symbols");
 705   codeview::CVSymbolDumper SD(P, TD, nullptr, false);
 706   bool HadError = false;
 707   for (auto S : Publics->getSymbols(&HadError)) {
 708     DictScope DD(P, "");
 709
 710     SD.dump(S);
 711     if (opts::raw::DumpSymRecordBytes)
 712       P.printBinaryBlock("Bytes", S.Data);
 713   }
 714   if (HadError)
 715     return make_error<RawError>(
 716         raw_error_code::corrupt_file,
 717         "Public symbol stream contained corrupt record");
 718
 719   return Error::success();
 720 }
 721
 722 Error LLVMOutputStyle::dumpSectionHeaders() {
 723   if (!opts::raw::DumpSectionHeaders)
 724     return Error::success();
 725
 726   auto Dbi = File.getPDBDbiStream();
 727   if (!Dbi)
 728     return Dbi.takeError();
 729
 730   ListScope D(P, "Section Headers");
 731   for (const object::coff_section &Section : Dbi->getSectionHeaders()) {
 732     DictScope DD(P, "");
 733
 734     // If a name is 8 characters long, there is no NUL character at end.
 735     StringRef Name(Section.Name, strnlen(Section.Name, sizeof(Section.Name)));
 736     P.printString("Name", Name);
 737     P.printNumber("Virtual Size", Section.VirtualSize);
 738     P.printNumber("Virtual Address", Section.VirtualAddress);
 739     P.printNumber("Size of Raw Data", Section.SizeOfRawData);
 740     P.printNumber("File Pointer to Raw Data", Section.PointerToRawData);
 741     P.printNumber("File Pointer to Relocations", Section.PointerToRelocations);
 742     P.printNumber("File Pointer to Linenumbers", Section.PointerToLinenumbers);
 743     P.printNumber("Number of Relocations", Section.NumberOfRelocations);
 744     P.printNumber("Number of Linenumbers", Section.NumberOfLinenumbers);
 745     P.printFlags("Characteristics", Section.Characteristics,
 746                  getImageSectionCharacteristicNames());
 747   }
 748   return Error::success();
 749 }
 750
 751 Error LLVMOutputStyle::dumpFpoStream() {
 752   if (!opts::raw::DumpFpo)
 753     return Error::success();
 754
 755   auto Dbi = File.getPDBDbiStream();
 756   if (!Dbi)
 757     return Dbi.takeError();
 758
 759   ListScope D(P, "New FPO");
 760   for (const object::FpoData &Fpo : Dbi->getFpoRecords()) {
 761     DictScope DD(P, "");
 762     P.printNumber("Offset", Fpo.Offset);
 763     P.printNumber("Size", Fpo.Size);
 764     P.printNumber("Number of locals", Fpo.NumLocals);
 765     P.printNumber("Number of params", Fpo.NumParams);
 766     P.printNumber("Size of Prolog", Fpo.getPrologSize());
 767     P.printNumber("Number of Saved Registers", Fpo.getNumSavedRegs());
 768     P.printBoolean("Has SEH", Fpo.hasSEH());
 769     P.printBoolean("Use BP", Fpo.useBP());
 770     P.printNumber("Frame Pointer", Fpo.getFP());
 771   }
 772   return Error::success();
 773 }
 774
 775 void LLVMOutputStyle::flush() { P.flush(); }