//===- llvm-pdbdump.cpp - Dump debug info from a PDB file -------*- C++ -*-===// // // The LLVM Compiler Infrastructure // // This file is distributed under the University of Illinois Open Source // License. See LICENSE.TXT for details. // //===----------------------------------------------------------------------===// // // Dumps debug information present in PDB files. This utility makes use of // the Microsoft Windows SDK, so will not compile or run on non-Windows // platforms. // //===----------------------------------------------------------------------===// #include "llvm-pdbdump.h" #include "CompilandDumper.h" #include "ExternalSymbolDumper.h" #include "FunctionDumper.h" #include "LLVMOutputStyle.h" #include "LinePrinter.h" #include "OutputStyle.h" #include "TypeDumper.h" #include "VariableDumper.h" #include "YAMLOutputStyle.h" #include "llvm/ADT/ArrayRef.h" #include "llvm/ADT/BitVector.h" #include "llvm/ADT/DenseMap.h" #include "llvm/ADT/StringExtras.h" #include "llvm/Config/config.h" #include "llvm/DebugInfo/CodeView/ByteStream.h" #include "llvm/DebugInfo/PDB/GenericError.h" #include "llvm/DebugInfo/PDB/IPDBEnumChildren.h" #include "llvm/DebugInfo/PDB/IPDBRawSymbol.h" #include "llvm/DebugInfo/PDB/IPDBSession.h" #include "llvm/DebugInfo/PDB/PDB.h" #include "llvm/DebugInfo/PDB/PDBSymbolCompiland.h" #include "llvm/DebugInfo/PDB/PDBSymbolData.h" #include "llvm/DebugInfo/PDB/PDBSymbolExe.h" #include "llvm/DebugInfo/PDB/PDBSymbolFunc.h" #include "llvm/DebugInfo/PDB/PDBSymbolThunk.h" #include "llvm/DebugInfo/PDB/Raw/DbiStream.h" #include "llvm/DebugInfo/PDB/Raw/DbiStreamBuilder.h" #include "llvm/DebugInfo/PDB/Raw/InfoStream.h" #include "llvm/DebugInfo/PDB/Raw/InfoStreamBuilder.h" #include "llvm/DebugInfo/PDB/Raw/PDBFile.h" #include "llvm/DebugInfo/PDB/Raw/PDBFileBuilder.h" #include "llvm/DebugInfo/PDB/Raw/RawConstants.h" #include "llvm/DebugInfo/PDB/Raw/RawError.h" #include "llvm/DebugInfo/PDB/Raw/RawSession.h" #include "llvm/Support/COM.h" #include "llvm/Support/CommandLine.h" #include "llvm/Support/ConvertUTF.h" #include "llvm/Support/FileOutputBuffer.h" #include "llvm/Support/FileSystem.h" #include "llvm/Support/Format.h" #include "llvm/Support/ManagedStatic.h" #include "llvm/Support/MemoryBuffer.h" #include "llvm/Support/PrettyStackTrace.h" #include "llvm/Support/Process.h" #include "llvm/Support/ScopedPrinter.h" #include "llvm/Support/Signals.h" #include "llvm/Support/raw_ostream.h" using namespace llvm; using namespace llvm::codeview; using namespace llvm::pdb; namespace { // A simple adapter that acts like a ByteStream but holds ownership over // and underlying FileOutputBuffer. class FileBufferByteStream : public ByteStream<true> { public: FileBufferByteStream(std::unique_ptr<FileOutputBuffer> Buffer) : ByteStream(MutableArrayRef<uint8_t>(Buffer->getBufferStart(), Buffer->getBufferEnd())), FileBuffer(std::move(Buffer)) {} Error commit() const override { if (FileBuffer->commit()) return llvm::make_error<RawError>(raw_error_code::not_writable); return Error::success(); } private: std::unique_ptr<FileOutputBuffer> FileBuffer; }; } namespace opts { cl::SubCommand RawSubcommand("raw", "Dump raw structure of the PDB file"); cl::SubCommand PrettySubcommand("pretty", "Dump semantic information about types and symbols"); cl::SubCommand YamlToPdbSubcommand("yaml2pdb", "Generate a PDB file from a YAML description"); cl::SubCommand PdbToYamlSubcommand("pdb2yaml", "Generate a detailed YAML description of a PDB File"); cl::OptionCategory TypeCategory("Symbol Type Options"); cl::OptionCategory FilterCategory("Filtering Options"); cl::OptionCategory OtherOptions("Other Options"); namespace pretty { cl::list<std::string> InputFilenames(cl::Positional, cl::desc("<input PDB files>"), cl::OneOrMore, cl::sub(PrettySubcommand)); cl::opt<bool> Compilands("compilands", cl::desc("Display compilands"), cl::cat(TypeCategory), cl::sub(PrettySubcommand)); cl::opt<bool> Symbols("symbols", cl::desc("Display symbols for each compiland"), cl::cat(TypeCategory), cl::sub(PrettySubcommand)); cl::opt<bool> Globals("globals", cl::desc("Dump global symbols"), cl::cat(TypeCategory), cl::sub(PrettySubcommand)); cl::opt<bool> Externals("externals", cl::desc("Dump external symbols"), cl::cat(TypeCategory), cl::sub(PrettySubcommand)); cl::opt<bool> Types("types", cl::desc("Display types"), cl::cat(TypeCategory), cl::sub(PrettySubcommand)); cl::opt<bool> Lines("lines", cl::desc("Line tables"), cl::cat(TypeCategory), cl::sub(PrettySubcommand)); cl::opt<bool> All("all", cl::desc("Implies all other options in 'Symbol Types' category"), cl::cat(TypeCategory), cl::sub(PrettySubcommand)); cl::opt<uint64_t> LoadAddress( "load-address", cl::desc("Assume the module is loaded at the specified address"), cl::cat(OtherOptions), cl::sub(PrettySubcommand)); cl::list<std::string> ExcludeTypes( "exclude-types", cl::desc("Exclude types by regular expression"), cl::ZeroOrMore, cl::cat(FilterCategory), cl::sub(PrettySubcommand)); cl::list<std::string> ExcludeSymbols( "exclude-symbols", cl::desc("Exclude symbols by regular expression"), cl::ZeroOrMore, cl::cat(FilterCategory), cl::sub(PrettySubcommand)); cl::list<std::string> ExcludeCompilands( "exclude-compilands", cl::desc("Exclude compilands by regular expression"), cl::ZeroOrMore, cl::cat(FilterCategory), cl::sub(PrettySubcommand)); cl::list<std::string> IncludeTypes( "include-types", cl::desc("Include only types which match a regular expression"), cl::ZeroOrMore, cl::cat(FilterCategory), cl::sub(PrettySubcommand)); cl::list<std::string> IncludeSymbols( "include-symbols", cl::desc("Include only symbols which match a regular expression"), cl::ZeroOrMore, cl::cat(FilterCategory), cl::sub(PrettySubcommand)); cl::list<std::string> IncludeCompilands( "include-compilands", cl::desc("Include only compilands those which match a regular expression"), cl::ZeroOrMore, cl::cat(FilterCategory), cl::sub(PrettySubcommand)); cl::opt<bool> ExcludeCompilerGenerated( "no-compiler-generated", cl::desc("Don't show compiler generated types and symbols"), cl::cat(FilterCategory), cl::sub(PrettySubcommand)); cl::opt<bool> ExcludeSystemLibraries("no-system-libs", cl::desc("Don't show symbols from system libraries"), cl::cat(FilterCategory), cl::sub(PrettySubcommand)); cl::opt<bool> NoClassDefs("no-class-definitions", cl::desc("Don't display full class definitions"), cl::cat(FilterCategory), cl::sub(PrettySubcommand)); cl::opt<bool> NoEnumDefs("no-enum-definitions", cl::desc("Don't display full enum definitions"), cl::cat(FilterCategory), cl::sub(PrettySubcommand)); } namespace raw { cl::OptionCategory MsfOptions("MSF Container Options"); cl::OptionCategory TypeOptions("Type Record Options"); cl::OptionCategory FileOptions("Module & File Options"); cl::OptionCategory SymbolOptions("Symbol Options"); cl::OptionCategory MiscOptions("Miscellaneous Options"); // MSF OPTIONS cl::opt<bool> DumpHeaders("headers", cl::desc("dump PDB headers"), cl::cat(MsfOptions), cl::sub(RawSubcommand)); cl::opt<bool> DumpStreamBlocks("stream-blocks", cl::desc("dump PDB stream blocks"), cl::cat(MsfOptions), cl::sub(RawSubcommand)); cl::opt<bool> DumpStreamSummary("stream-summary", cl::desc("dump summary of the PDB streams"), cl::cat(MsfOptions), cl::sub(RawSubcommand)); // TYPE OPTIONS cl::opt<bool> DumpTpiRecords("tpi-records", cl::desc("dump CodeView type records from TPI stream"), cl::cat(TypeOptions), cl::sub(RawSubcommand)); cl::opt<bool> DumpTpiRecordBytes( "tpi-record-bytes", cl::desc("dump CodeView type record raw bytes from TPI stream"), cl::cat(TypeOptions), cl::sub(RawSubcommand)); cl::opt<bool> DumpTpiHash("tpi-hash", cl::desc("dump CodeView TPI hash stream"), cl::cat(TypeOptions), cl::sub(RawSubcommand)); cl::opt<bool> DumpIpiRecords("ipi-records", cl::desc("dump CodeView type records from IPI stream"), cl::cat(TypeOptions), cl::sub(RawSubcommand)); cl::opt<bool> DumpIpiRecordBytes( "ipi-record-bytes", cl::desc("dump CodeView type record raw bytes from IPI stream"), cl::cat(TypeOptions), cl::sub(RawSubcommand)); // MODULE & FILE OPTIONS cl::opt<bool> DumpModules("modules", cl::desc("dump compiland information"), cl::cat(FileOptions), cl::sub(RawSubcommand)); cl::opt<bool> DumpModuleFiles("module-files", cl::desc("dump file information"), cl::cat(FileOptions), cl::sub(RawSubcommand)); cl::opt<bool> DumpLineInfo("line-info", cl::desc("dump file and line information"), cl::cat(FileOptions), cl::sub(RawSubcommand)); // SYMBOL OPTIONS cl::opt<bool> DumpModuleSyms("module-syms", cl::desc("dump module symbols"), cl::cat(SymbolOptions), cl::sub(RawSubcommand)); cl::opt<bool> DumpPublics("publics", cl::desc("dump Publics stream data"), cl::cat(SymbolOptions), cl::sub(RawSubcommand)); cl::opt<bool> DumpSymRecordBytes("sym-record-bytes", cl::desc("dump CodeView symbol record raw bytes"), cl::cat(SymbolOptions), cl::sub(RawSubcommand)); // MISCELLANEOUS OPTIONS cl::opt<bool> DumpSectionContribs("section-contribs", cl::desc("dump section contributions"), cl::cat(MiscOptions), cl::sub(RawSubcommand)); cl::opt<bool> DumpSectionMap("section-map", cl::desc("dump section map"), cl::cat(MiscOptions), cl::sub(RawSubcommand)); cl::opt<bool> DumpSectionHeaders("section-headers", cl::desc("dump section headers"), cl::cat(MiscOptions), cl::sub(RawSubcommand)); cl::opt<bool> DumpFpo("fpo", cl::desc("dump FPO records"), cl::cat(MiscOptions), cl::sub(RawSubcommand)); cl::opt<std::string> DumpStreamDataIdx("stream", cl::desc("dump stream data"), cl::cat(MiscOptions), cl::sub(RawSubcommand)); cl::opt<std::string> DumpStreamDataName("stream-name", cl::desc("dump stream data"), cl::cat(MiscOptions), cl::sub(RawSubcommand)); cl::opt<bool> RawAll("all", cl::desc("Implies most other options."), cl::cat(MiscOptions), cl::sub(RawSubcommand)); cl::list<std::string> InputFilenames(cl::Positional, cl::desc("<input PDB files>"), cl::OneOrMore, cl::sub(RawSubcommand)); } namespace yaml2pdb { cl::opt<std::string> YamlPdbOutputFile("pdb", cl::desc("the name of the PDB file to write"), cl::sub(YamlToPdbSubcommand)); cl::list<std::string> InputFilename(cl::Positional, cl::desc("<input YAML file>"), cl::Required, cl::sub(YamlToPdbSubcommand)); } namespace pdb2yaml { cl::opt<bool> NoFileHeaders("no-file-headers", cl::desc("Do not dump MSF file headers (you will not be able " "to generate a fresh PDB from the resulting YAML)"), cl::sub(PdbToYamlSubcommand), cl::init(false)); cl::opt<bool> StreamMetadata( "stream-metadata", cl::desc("Dump the number of streams and each stream's size"), cl::sub(PdbToYamlSubcommand), cl::init(false)); cl::opt<bool> StreamDirectory( "stream-directory", cl::desc("Dump each stream's block map (implies -stream-metadata)"), cl::sub(PdbToYamlSubcommand), cl::init(false)); cl::opt<bool> PdbStream( "pdb-stream", cl::desc("Dump the PDB Stream (Stream 1) (implies -stream-metadata)"), cl::sub(PdbToYamlSubcommand), cl::init(false)); cl::opt<bool> DbiStream( "dbi-stream", cl::desc("Dump the DBI Stream (Stream 2) (implies -stream-metadata)"), cl::sub(PdbToYamlSubcommand), cl::init(false)); cl::list<std::string> InputFilename(cl::Positional, cl::desc("<input PDB file>"), cl::Required, cl::sub(PdbToYamlSubcommand)); } } static ExitOnError ExitOnErr; static void yamlToPdb(StringRef Path) { ErrorOr<std::unique_ptr<MemoryBuffer>> ErrorOrBuffer = MemoryBuffer::getFileOrSTDIN(Path, /*FileSize=*/-1, /*RequiresNullTerminator=*/false); if (ErrorOrBuffer.getError()) { ExitOnErr(make_error<GenericError>(generic_error_code::invalid_path, Path)); } std::unique_ptr<MemoryBuffer> &Buffer = ErrorOrBuffer.get(); llvm::yaml::Input In(Buffer->getBuffer()); pdb::yaml::PdbObject YamlObj; In >> YamlObj; if (!YamlObj.Headers.hasValue()) ExitOnErr(make_error<GenericError>(generic_error_code::unspecified, "Yaml does not contain MSF headers")); auto OutFileOrError = FileOutputBuffer::create( opts::yaml2pdb::YamlPdbOutputFile, YamlObj.Headers->FileSize); if (OutFileOrError.getError()) ExitOnErr(make_error<GenericError>(generic_error_code::invalid_path, opts::yaml2pdb::YamlPdbOutputFile)); auto FileByteStream = llvm::make_unique<FileBufferByteStream>(std::move(*OutFileOrError)); PDBFileBuilder Builder(std::move(FileByteStream)); ExitOnErr(Builder.setSuperBlock(YamlObj.Headers->SuperBlock)); if (YamlObj.StreamSizes.hasValue()) { Builder.setStreamSizes(YamlObj.StreamSizes.getValue()); } Builder.setDirectoryBlocks(YamlObj.Headers->DirectoryBlocks); if (YamlObj.StreamMap.hasValue()) { std::vector<ArrayRef<support::ulittle32_t>> StreamMap; for (auto &E : YamlObj.StreamMap.getValue()) { StreamMap.push_back(E.Blocks); } Builder.setStreamMap(StreamMap); } else { ExitOnErr(Builder.generateSimpleStreamMap()); } if (YamlObj.PdbStream.hasValue()) { auto &InfoBuilder = Builder.getInfoBuilder(); InfoBuilder.setAge(YamlObj.PdbStream->Age); InfoBuilder.setGuid(YamlObj.PdbStream->Guid); InfoBuilder.setSignature(YamlObj.PdbStream->Signature); InfoBuilder.setVersion(YamlObj.PdbStream->Version); } if (YamlObj.DbiStream.hasValue()) { auto &DbiBuilder = Builder.getDbiBuilder(); DbiBuilder.setAge(YamlObj.DbiStream->Age); DbiBuilder.setBuildNumber(YamlObj.DbiStream->BuildNumber); DbiBuilder.setFlags(YamlObj.DbiStream->Flags); DbiBuilder.setMachineType(YamlObj.DbiStream->MachineType); DbiBuilder.setPdbDllRbld(YamlObj.DbiStream->PdbDllRbld); DbiBuilder.setPdbDllVersion(YamlObj.DbiStream->PdbDllVersion); DbiBuilder.setVersionHeader(YamlObj.DbiStream->VerHeader); } auto Pdb = Builder.build(); ExitOnErr(Pdb.takeError()); auto &PdbFile = *Pdb; ExitOnErr(PdbFile->commit()); } static void pdb2Yaml(StringRef Path) { std::unique_ptr<IPDBSession> Session; ExitOnErr(loadDataForPDB(PDB_ReaderType::Raw, Path, Session)); RawSession *RS = static_cast<RawSession *>(Session.get()); PDBFile &File = RS->getPDBFile(); auto O = llvm::make_unique<YAMLOutputStyle>(File); O = llvm::make_unique<YAMLOutputStyle>(File); ExitOnErr(O->dump()); } static void dumpRaw(StringRef Path) { std::unique_ptr<IPDBSession> Session; ExitOnErr(loadDataForPDB(PDB_ReaderType::Raw, Path, Session)); RawSession *RS = static_cast<RawSession *>(Session.get()); PDBFile &File = RS->getPDBFile(); auto O = llvm::make_unique<LLVMOutputStyle>(File); ExitOnErr(O->dump()); } static void dumpPretty(StringRef Path) { std::unique_ptr<IPDBSession> Session; ExitOnErr(loadDataForPDB(PDB_ReaderType::DIA, Path, Session)); if (opts::pretty::LoadAddress) Session->setLoadAddress(opts::pretty::LoadAddress); LinePrinter Printer(2, outs()); auto GlobalScope(Session->getGlobalScope()); std::string FileName(GlobalScope->getSymbolsFileName()); WithColor(Printer, PDB_ColorItem::None).get() << "Summary for "; WithColor(Printer, PDB_ColorItem::Path).get() << FileName; Printer.Indent(); uint64_t FileSize = 0; Printer.NewLine(); WithColor(Printer, PDB_ColorItem::Identifier).get() << "Size"; if (!sys::fs::file_size(FileName, FileSize)) { Printer << ": " << FileSize << " bytes"; } else { Printer << ": (Unable to obtain file size)"; } Printer.NewLine(); WithColor(Printer, PDB_ColorItem::Identifier).get() << "Guid"; Printer << ": " << GlobalScope->getGuid(); Printer.NewLine(); WithColor(Printer, PDB_ColorItem::Identifier).get() << "Age"; Printer << ": " << GlobalScope->getAge(); Printer.NewLine(); WithColor(Printer, PDB_ColorItem::Identifier).get() << "Attributes"; Printer << ": "; if (GlobalScope->hasCTypes()) outs() << "HasCTypes "; if (GlobalScope->hasPrivateSymbols()) outs() << "HasPrivateSymbols "; Printer.Unindent(); if (opts::pretty::Compilands) { Printer.NewLine(); WithColor(Printer, PDB_ColorItem::SectionHeader).get() << "---COMPILANDS---"; Printer.Indent(); auto Compilands = GlobalScope->findAllChildren<PDBSymbolCompiland>(); CompilandDumper Dumper(Printer); CompilandDumpFlags options = CompilandDumper::Flags::None; if (opts::pretty::Lines) options = options | CompilandDumper::Flags::Lines; while (auto Compiland = Compilands->getNext()) Dumper.start(*Compiland, options); Printer.Unindent(); } if (opts::pretty::Types) { Printer.NewLine(); WithColor(Printer, PDB_ColorItem::SectionHeader).get() << "---TYPES---"; Printer.Indent(); TypeDumper Dumper(Printer); Dumper.start(*GlobalScope); Printer.Unindent(); } if (opts::pretty::Symbols) { Printer.NewLine(); WithColor(Printer, PDB_ColorItem::SectionHeader).get() << "---SYMBOLS---"; Printer.Indent(); auto Compilands = GlobalScope->findAllChildren<PDBSymbolCompiland>(); CompilandDumper Dumper(Printer); while (auto Compiland = Compilands->getNext()) Dumper.start(*Compiland, true); Printer.Unindent(); } if (opts::pretty::Globals) { Printer.NewLine(); WithColor(Printer, PDB_ColorItem::SectionHeader).get() << "---GLOBALS---"; Printer.Indent(); { FunctionDumper Dumper(Printer); auto Functions = GlobalScope->findAllChildren<PDBSymbolFunc>(); while (auto Function = Functions->getNext()) { Printer.NewLine(); Dumper.start(*Function, FunctionDumper::PointerType::None); } } { auto Vars = GlobalScope->findAllChildren<PDBSymbolData>(); VariableDumper Dumper(Printer); while (auto Var = Vars->getNext()) Dumper.start(*Var); } { auto Thunks = GlobalScope->findAllChildren<PDBSymbolThunk>(); CompilandDumper Dumper(Printer); while (auto Thunk = Thunks->getNext()) Dumper.dump(*Thunk); } Printer.Unindent(); } if (opts::pretty::Externals) { Printer.NewLine(); WithColor(Printer, PDB_ColorItem::SectionHeader).get() << "---EXTERNALS---"; Printer.Indent(); ExternalSymbolDumper Dumper(Printer); Dumper.start(*GlobalScope); } if (opts::pretty::Lines) { Printer.NewLine(); } outs().flush(); } int main(int argc_, const char *argv_[]) { // Print a stack trace if we signal out. sys::PrintStackTraceOnErrorSignal(argv_[0]); PrettyStackTraceProgram X(argc_, argv_); ExitOnErr.setBanner("llvm-pdbdump: "); SmallVector<const char *, 256> argv; SpecificBumpPtrAllocator<char> ArgAllocator; ExitOnErr(errorCodeToError(sys::Process::GetArgumentVector( argv, makeArrayRef(argv_, argc_), ArgAllocator))); llvm_shutdown_obj Y; // Call llvm_shutdown() on exit. cl::ParseCommandLineOptions(argv.size(), argv.data(), "LLVM PDB Dumper\n"); // These options are shared by two subcommands. if ((opts::PdbToYamlSubcommand || opts::RawSubcommand) && opts::raw::RawAll) { opts::raw::DumpHeaders = true; opts::raw::DumpModules = true; opts::raw::DumpModuleFiles = true; opts::raw::DumpModuleSyms = true; opts::raw::DumpPublics = true; opts::raw::DumpSectionHeaders = true; opts::raw::DumpStreamSummary = true; opts::raw::DumpStreamBlocks = true; opts::raw::DumpTpiRecords = true; opts::raw::DumpTpiHash = true; opts::raw::DumpIpiRecords = true; opts::raw::DumpSectionMap = true; opts::raw::DumpSectionContribs = true; opts::raw::DumpLineInfo = true; opts::raw::DumpFpo = true; } llvm::sys::InitializeCOMRAII COM(llvm::sys::COMThreadingMode::MultiThreaded); if (opts::PdbToYamlSubcommand) { pdb2Yaml(opts::pdb2yaml::InputFilename.front()); } else if (opts::YamlToPdbSubcommand) { yamlToPdb(opts::yaml2pdb::InputFilename.front()); } else if (opts::PrettySubcommand) { if (opts::pretty::Lines) opts::pretty::Compilands = true; if (opts::pretty::All) { opts::pretty::Compilands = true; opts::pretty::Symbols = true; opts::pretty::Globals = true; opts::pretty::Types = true; opts::pretty::Externals = true; opts::pretty::Lines = true; } // When adding filters for excluded compilands and types, we need to // remember // that these are regexes. So special characters such as * and \ need to be // escaped in the regex. In the case of a literal \, this means it needs to // be escaped again in the C++. So matching a single \ in the input // requires // 4 \es in the C++. if (opts::pretty::ExcludeCompilerGenerated) { opts::pretty::ExcludeTypes.push_back("__vc_attributes"); opts::pretty::ExcludeCompilands.push_back("\\* Linker \\*"); } if (opts::pretty::ExcludeSystemLibraries) { opts::pretty::ExcludeCompilands.push_back( "f:\\\\binaries\\\\Intermediate\\\\vctools\\\\crt_bld"); opts::pretty::ExcludeCompilands.push_back("f:\\\\dd\\\\vctools\\\\crt"); opts::pretty::ExcludeCompilands.push_back( "d:\\\\th.obj.x86fre\\\\minkernel"); } std::for_each(opts::pretty::InputFilenames.begin(), opts::pretty::InputFilenames.end(), dumpPretty); } else if (opts::RawSubcommand) { std::for_each(opts::raw::InputFilenames.begin(), opts::raw::InputFilenames.end(), dumpRaw); } outs().flush(); return 0; }