From: Zachary Turner Date: Mon, 13 Mar 2017 14:57:45 +0000 (+0000) Subject: [llvm-pdbdump] Add support for dumping symbols from Yaml -> PDB. X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=00ea544948006ad27602b656c5eb3e2b2051c1be;p=llvm [llvm-pdbdump] Add support for dumping symbols from Yaml -> PDB. Previously we could round-trip type records from PDB -> Yaml -> PDB, but for symbols we could only go from PDB -> Yaml. This completes the round-tripping for symbols as well. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@297625 91177308-0d34-0410-b5e6-96231b3b80d8 --- diff --git a/include/llvm/DebugInfo/CodeView/SymbolSerializer.h b/include/llvm/DebugInfo/CodeView/SymbolSerializer.h index 894e623f078..54fcd092c4e 100644 --- a/include/llvm/DebugInfo/CodeView/SymbolSerializer.h +++ b/include/llvm/DebugInfo/CodeView/SymbolSerializer.h @@ -29,7 +29,10 @@ namespace codeview { class SymbolSerializer : public SymbolVisitorCallbacks { uint32_t RecordStart = 0; - BinaryStreamWriter &Writer; + BumpPtrAllocator &Storage; + std::vector RecordBuffer; + MutableBinaryByteStream Stream; + BinaryStreamWriter Writer; SymbolRecordMapping Mapping; Optional CurrentSymbol; @@ -43,40 +46,10 @@ class SymbolSerializer : public SymbolVisitorCallbacks { } public: - explicit SymbolSerializer(BinaryStreamWriter &Writer) - : Writer(Writer), Mapping(Writer) {} + explicit SymbolSerializer(BumpPtrAllocator &Storage); - virtual Error visitSymbolBegin(CVSymbol &Record) override { - assert(!CurrentSymbol.hasValue() && "Already in a symbol mapping!"); - - RecordStart = Writer.getOffset(); - if (auto EC = writeRecordPrefix(Record.kind())) - return EC; - - CurrentSymbol = Record.kind(); - if (auto EC = Mapping.visitSymbolBegin(Record)) - return EC; - - return Error::success(); - } - - virtual Error visitSymbolEnd(CVSymbol &Record) override { - assert(CurrentSymbol.hasValue() && "Not in a symbol mapping!"); - - if (auto EC = Mapping.visitSymbolEnd(Record)) - return EC; - - uint32_t RecordEnd = Writer.getOffset(); - Writer.setOffset(RecordStart); - uint16_t Length = RecordEnd - Writer.getOffset() - 2; - if (auto EC = Writer.writeInteger(Length)) - return EC; - - Writer.setOffset(RecordEnd); - CurrentSymbol.reset(); - - return Error::success(); - } + virtual Error visitSymbolBegin(CVSymbol &Record) override; + virtual Error visitSymbolEnd(CVSymbol &Record) override; #define SYMBOL_RECORD(EnumName, EnumVal, Name) \ virtual Error visitKnownRecord(CVSymbol &CVR, Name &Record) override { \ diff --git a/lib/DebugInfo/CodeView/CMakeLists.txt b/lib/DebugInfo/CodeView/CMakeLists.txt index 63c1832b3f2..a120484cdbe 100644 --- a/lib/DebugInfo/CodeView/CMakeLists.txt +++ b/lib/DebugInfo/CodeView/CMakeLists.txt @@ -12,6 +12,7 @@ add_llvm_library(LLVMDebugInfoCodeView RecordSerialization.cpp SymbolRecordMapping.cpp SymbolDumper.cpp + SymbolSerializer.cpp TypeDatabase.cpp TypeDatabaseVisitor.cpp TypeDumpVisitor.cpp diff --git a/lib/DebugInfo/CodeView/SymbolSerializer.cpp b/lib/DebugInfo/CodeView/SymbolSerializer.cpp new file mode 100644 index 00000000000..251cc431f52 --- /dev/null +++ b/lib/DebugInfo/CodeView/SymbolSerializer.cpp @@ -0,0 +1,52 @@ +//===- SymbolSerializer.cpp -------------------------------------*- C++ -*-===// +// +// The LLVM Compiler Infrastructure +// +// This file is distributed under the University of Illinois Open Source +// License. See LICENSE.TXT for details. +// +//===----------------------------------------------------------------------===// + +#include "llvm/DebugInfo/CodeView/SymbolSerializer.h" + +using namespace llvm; +using namespace llvm::codeview; + +SymbolSerializer::SymbolSerializer(BumpPtrAllocator &Allocator) + : Storage(Allocator), RecordBuffer(MaxRecordLength), Stream(RecordBuffer, llvm::support::little), + Writer(Stream), Mapping(Writer) { } + +Error SymbolSerializer::visitSymbolBegin(CVSymbol &Record) { + assert(!CurrentSymbol.hasValue() && "Already in a symbol mapping!"); + + Writer.setOffset(0); + + if (auto EC = writeRecordPrefix(Record.kind())) + return EC; + + CurrentSymbol = Record.kind(); + if (auto EC = Mapping.visitSymbolBegin(Record)) + return EC; + + return Error::success(); +} + +Error SymbolSerializer::visitSymbolEnd(CVSymbol &Record) { + assert(CurrentSymbol.hasValue() && "Not in a symbol mapping!"); + + if (auto EC = Mapping.visitSymbolEnd(Record)) + return EC; + + uint32_t RecordEnd = Writer.getOffset(); + uint16_t Length = RecordEnd - 2; + Writer.setOffset(0); + if (auto EC = Writer.writeInteger(Length)) + return EC; + + uint8_t *StableStorage = Storage.Allocate(RecordEnd); + ::memcpy(StableStorage, &RecordBuffer[0], RecordEnd); + Record.RecordData = ArrayRef(StableStorage, RecordEnd); + CurrentSymbol.reset(); + + return Error::success(); +} diff --git a/tools/llvm-pdbdump/PdbYaml.cpp b/tools/llvm-pdbdump/PdbYaml.cpp index ba2acf7e7f1..9877af0a07c 100644 --- a/tools/llvm-pdbdump/PdbYaml.cpp +++ b/tools/llvm-pdbdump/PdbYaml.cpp @@ -16,6 +16,7 @@ #include "llvm/DebugInfo/CodeView/CVSymbolVisitor.h" #include "llvm/DebugInfo/CodeView/CVTypeVisitor.h" #include "llvm/DebugInfo/CodeView/SymbolDeserializer.h" +#include "llvm/DebugInfo/CodeView/SymbolSerializer.h" #include "llvm/DebugInfo/CodeView/SymbolVisitorCallbackPipeline.h" #include "llvm/DebugInfo/CodeView/TypeDeserializer.h" #include "llvm/DebugInfo/CodeView/TypeSerializer.h" @@ -137,14 +138,23 @@ template <> struct ScalarEnumerationTraits { } void MappingTraits::mapping(IO &IO, PdbObject &Obj) { + // Create a single serialization context that will be passed through the + // entire process of serializing / deserializing a Tpi Stream. This is + // especially important when we are going from Pdb -> Yaml because we need + // to maintain state in a TypeTableBuilder across mappings, and at the end of + // the entire process, we need to have one TypeTableBuilder that has every + // record. + pdb::yaml::SerializationContext Context(IO, Obj.Allocator); + + IO.mapOptional("MSF", Obj.Headers); IO.mapOptional("StreamSizes", Obj.StreamSizes); IO.mapOptional("StreamMap", Obj.StreamMap); IO.mapOptional("StringTable", Obj.StringTable); IO.mapOptional("PdbStream", Obj.PdbStream); - IO.mapOptional("DbiStream", Obj.DbiStream); - IO.mapOptionalWithContext("TpiStream", Obj.TpiStream, Obj.Allocator); - IO.mapOptionalWithContext("IpiStream", Obj.IpiStream, Obj.Allocator); + IO.mapOptionalWithContext("DbiStream", Obj.DbiStream, Context); + IO.mapOptionalWithContext("TpiStream", Obj.TpiStream, Context); + IO.mapOptionalWithContext("IpiStream", Obj.IpiStream, Context); } void MappingTraits::mapping(IO &IO, MSFHeaders &Obj) { @@ -179,7 +189,7 @@ void MappingTraits::mapping(IO &IO, PdbInfoStream &Obj) { IO.mapRequired("Version", Obj.Version); } -void MappingTraits::mapping(IO &IO, PdbDbiStream &Obj) { +void MappingContextTraits::mapping(IO &IO, PdbDbiStream &Obj, pdb::yaml::SerializationContext &Context) { IO.mapRequired("VerHeader", Obj.VerHeader); IO.mapRequired("Age", Obj.Age); IO.mapRequired("BuildNumber", Obj.BuildNumber); @@ -187,19 +197,11 @@ void MappingTraits::mapping(IO &IO, PdbDbiStream &Obj) { IO.mapRequired("PdbDllRbld", Obj.PdbDllRbld); IO.mapRequired("Flags", Obj.Flags); IO.mapRequired("MachineType", Obj.MachineType); - IO.mapOptional("Modules", Obj.ModInfos); + IO.mapOptionalWithContext("Modules", Obj.ModInfos, Context); } -void MappingContextTraits::mapping( - IO &IO, pdb::yaml::PdbTpiStream &Obj, BumpPtrAllocator &Allocator) { - // Create a single serialization context that will be passed through the - // entire process of serializing / deserializing a Tpi Stream. This is - // especially important when we are going from Pdb -> Yaml because we need - // to maintain state in a TypeTableBuilder across mappings, and at the end of - // the entire process, we need to have one TypeTableBuilder that has every - // record. - pdb::yaml::SerializationContext Context(IO, Allocator); - +void MappingContextTraits::mapping( + IO &IO, pdb::yaml::PdbTpiStream &Obj, pdb::yaml::SerializationContext &Context) { IO.mapRequired("Version", Obj.Version); IO.mapRequired("Records", Obj.Records, Context); } @@ -210,8 +212,9 @@ void MappingTraits::mapping(IO &IO, IO.mapRequired("StreamNum", Obj.StreamNumber); } -void MappingTraits::mapping(IO &IO, PdbSymbolRecord &Obj) { +void MappingContextTraits::mapping(IO &IO, PdbSymbolRecord &Obj, pdb::yaml::SerializationContext &Context) { codeview::SymbolVisitorCallbackPipeline Pipeline; + codeview::SymbolSerializer Serializer(Context.Allocator); codeview::SymbolDeserializer Deserializer(nullptr); codeview::yaml::YamlSymbolDumper Dumper(IO); @@ -220,23 +223,26 @@ void MappingTraits::mapping(IO &IO, PdbSymbolRecord &Obj) { Pipeline.addCallbackToPipeline(Deserializer); Pipeline.addCallbackToPipeline(Dumper); } else { - return; + // For the other way around, dump it into a concrete structure, and then + // serialize it into the CVRecord. + Pipeline.addCallbackToPipeline(Dumper); + Pipeline.addCallbackToPipeline(Serializer); } codeview::CVSymbolVisitor Visitor(Pipeline); consumeError(Visitor.visitSymbolRecord(Obj.Record)); } -void MappingTraits::mapping(IO &IO, PdbModiStream &Obj) { +void MappingContextTraits::mapping(IO &IO, PdbModiStream &Obj, pdb::yaml::SerializationContext &Context) { IO.mapRequired("Signature", Obj.Signature); - IO.mapRequired("Records", Obj.Symbols); + IO.mapRequired("Records", Obj.Symbols, Context); } -void MappingTraits::mapping(IO &IO, PdbDbiModuleInfo &Obj) { +void MappingContextTraits::mapping(IO &IO, PdbDbiModuleInfo &Obj, pdb::yaml::SerializationContext &Context) { IO.mapRequired("Module", Obj.Mod); IO.mapRequired("ObjFile", Obj.Obj); IO.mapOptional("SourceFiles", Obj.SourceFiles); - IO.mapOptional("Modi", Obj.Modi); + IO.mapOptionalWithContext("Modi", Obj.Modi, Context); } void MappingContextTraits:: diff --git a/tools/llvm-pdbdump/PdbYaml.h b/tools/llvm-pdbdump/PdbYaml.h index c5b49522b45..3b9b8e5c813 100644 --- a/tools/llvm-pdbdump/PdbYaml.h +++ b/tools/llvm-pdbdump/PdbYaml.h @@ -138,30 +138,30 @@ template <> struct MappingTraits { static void mapping(IO &IO, pdb::yaml::PdbInfoStream &Obj); }; -template <> struct MappingTraits { - static void mapping(IO &IO, pdb::yaml::PdbDbiStream &Obj); +template <> struct MappingContextTraits { + static void mapping(IO &IO, pdb::yaml::PdbDbiStream &Obj, pdb::yaml::SerializationContext &Context); }; template <> -struct MappingContextTraits { +struct MappingContextTraits { static void mapping(IO &IO, pdb::yaml::PdbTpiStream &Obj, - llvm::BumpPtrAllocator &Allocator); + pdb::yaml::SerializationContext &Context); }; template <> struct MappingTraits { static void mapping(IO &IO, pdb::yaml::NamedStreamMapping &Obj); }; -template <> struct MappingTraits { - static void mapping(IO &IO, pdb::yaml::PdbSymbolRecord &Obj); +template <> struct MappingContextTraits { + static void mapping(IO &IO, pdb::yaml::PdbSymbolRecord &Obj, pdb::yaml::SerializationContext &Context); }; -template <> struct MappingTraits { - static void mapping(IO &IO, pdb::yaml::PdbModiStream &Obj); +template <> struct MappingContextTraits { + static void mapping(IO &IO, pdb::yaml::PdbModiStream &Obj, pdb::yaml::SerializationContext &Context); }; -template <> struct MappingTraits { - static void mapping(IO &IO, pdb::yaml::PdbDbiModuleInfo &Obj); +template <> struct MappingContextTraits { + static void mapping(IO &IO, pdb::yaml::PdbDbiModuleInfo &Obj, pdb::yaml::SerializationContext &Context); }; template <> diff --git a/tools/llvm-pdbdump/YamlSymbolDumper.cpp b/tools/llvm-pdbdump/YamlSymbolDumper.cpp index 210260a03b5..431bf404fb0 100644 --- a/tools/llvm-pdbdump/YamlSymbolDumper.cpp +++ b/tools/llvm-pdbdump/YamlSymbolDumper.cpp @@ -113,6 +113,7 @@ template <> struct ScalarEnumerationTraits { for (const auto &E : RegNames) { io.enumCase(Reg, E.Name.str().c_str(), static_cast(E.Value)); } + io.enumFallback(Reg); } };