1 //===- PdbYAML.cpp -------------------------------------------- *- C++ --*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
12 #include "llvm/ADT/StringExtras.h"
13 #include "llvm/DebugInfo/CodeView/CVSymbolVisitor.h"
14 #include "llvm/DebugInfo/CodeView/CVTypeVisitor.h"
15 #include "llvm/DebugInfo/CodeView/DebugStringTableSubsection.h"
16 #include "llvm/DebugInfo/CodeView/SymbolDeserializer.h"
17 #include "llvm/DebugInfo/CodeView/SymbolVisitorCallbackPipeline.h"
18 #include "llvm/DebugInfo/CodeView/TypeSerializer.h"
19 #include "llvm/DebugInfo/CodeView/TypeVisitorCallbackPipeline.h"
20 #include "llvm/DebugInfo/PDB/Native/PDBFile.h"
21 #include "llvm/DebugInfo/PDB/Native/RawTypes.h"
22 #include "llvm/DebugInfo/PDB/Native/TpiHashing.h"
23 #include "llvm/DebugInfo/PDB/PDBExtras.h"
24 #include "llvm/DebugInfo/PDB/PDBTypes.h"
25 #include "llvm/ObjectYAML/CodeViewYAMLDebugSections.h"
26 #include "llvm/ObjectYAML/CodeViewYAMLTypes.h"
29 using namespace llvm::pdb;
30 using namespace llvm::pdb::yaml;
31 using namespace llvm::yaml;
33 LLVM_YAML_IS_FLOW_SEQUENCE_VECTOR(uint32_t)
34 LLVM_YAML_IS_SEQUENCE_VECTOR(llvm::StringRef)
35 LLVM_YAML_IS_SEQUENCE_VECTOR(llvm::pdb::yaml::NamedStreamMapping)
36 LLVM_YAML_IS_SEQUENCE_VECTOR(llvm::pdb::yaml::PdbDbiModuleInfo)
37 LLVM_YAML_IS_SEQUENCE_VECTOR(llvm::pdb::yaml::StreamBlockList)
38 LLVM_YAML_IS_FLOW_SEQUENCE_VECTOR(llvm::pdb::PdbRaw_FeatureSig)
43 template <> struct ScalarTraits<llvm::pdb::PDB_UniqueId> {
44 static void output(const llvm::pdb::PDB_UniqueId &S, void *,
45 llvm::raw_ostream &OS) {
49 static StringRef input(StringRef Scalar, void *Ctx,
50 llvm::pdb::PDB_UniqueId &S) {
51 if (Scalar.size() != 38)
52 return "GUID strings are 38 characters long";
53 if (Scalar[0] != '{' || Scalar[37] != '}')
54 return "GUID is not enclosed in {}";
55 if (Scalar[9] != '-' || Scalar[14] != '-' || Scalar[19] != '-' ||
57 return "GUID sections are not properly delineated with dashes";
59 uint8_t *OutBuffer = S.Guid;
60 for (auto Iter = Scalar.begin(); Iter != Scalar.end();) {
61 if (*Iter == '-' || *Iter == '{' || *Iter == '}') {
65 uint8_t Value = (llvm::hexDigitValue(*Iter) << 4);
67 Value |= llvm::hexDigitValue(*Iter);
75 static bool mustQuote(StringRef Scalar) { return needsQuotes(Scalar); }
78 template <> struct ScalarEnumerationTraits<llvm::pdb::PDB_Machine> {
79 static void enumeration(IO &io, llvm::pdb::PDB_Machine &Value) {
80 io.enumCase(Value, "Invalid", PDB_Machine::Invalid);
81 io.enumCase(Value, "Am33", PDB_Machine::Am33);
82 io.enumCase(Value, "Amd64", PDB_Machine::Amd64);
83 io.enumCase(Value, "Arm", PDB_Machine::Arm);
84 io.enumCase(Value, "ArmNT", PDB_Machine::ArmNT);
85 io.enumCase(Value, "Ebc", PDB_Machine::Ebc);
86 io.enumCase(Value, "x86", PDB_Machine::x86);
87 io.enumCase(Value, "Ia64", PDB_Machine::Ia64);
88 io.enumCase(Value, "M32R", PDB_Machine::M32R);
89 io.enumCase(Value, "Mips16", PDB_Machine::Mips16);
90 io.enumCase(Value, "MipsFpu", PDB_Machine::MipsFpu);
91 io.enumCase(Value, "MipsFpu16", PDB_Machine::MipsFpu16);
92 io.enumCase(Value, "PowerPCFP", PDB_Machine::PowerPCFP);
93 io.enumCase(Value, "R4000", PDB_Machine::R4000);
94 io.enumCase(Value, "SH3", PDB_Machine::SH3);
95 io.enumCase(Value, "SH3DSP", PDB_Machine::SH3DSP);
96 io.enumCase(Value, "Thumb", PDB_Machine::Thumb);
97 io.enumCase(Value, "WceMipsV2", PDB_Machine::WceMipsV2);
101 template <> struct ScalarEnumerationTraits<llvm::pdb::PdbRaw_DbiVer> {
102 static void enumeration(IO &io, llvm::pdb::PdbRaw_DbiVer &Value) {
103 io.enumCase(Value, "V41", llvm::pdb::PdbRaw_DbiVer::PdbDbiVC41);
104 io.enumCase(Value, "V50", llvm::pdb::PdbRaw_DbiVer::PdbDbiV50);
105 io.enumCase(Value, "V60", llvm::pdb::PdbRaw_DbiVer::PdbDbiV60);
106 io.enumCase(Value, "V70", llvm::pdb::PdbRaw_DbiVer::PdbDbiV70);
107 io.enumCase(Value, "V110", llvm::pdb::PdbRaw_DbiVer::PdbDbiV110);
111 template <> struct ScalarEnumerationTraits<llvm::pdb::PdbRaw_ImplVer> {
112 static void enumeration(IO &io, llvm::pdb::PdbRaw_ImplVer &Value) {
113 io.enumCase(Value, "VC2", llvm::pdb::PdbRaw_ImplVer::PdbImplVC2);
114 io.enumCase(Value, "VC4", llvm::pdb::PdbRaw_ImplVer::PdbImplVC4);
115 io.enumCase(Value, "VC41", llvm::pdb::PdbRaw_ImplVer::PdbImplVC41);
116 io.enumCase(Value, "VC50", llvm::pdb::PdbRaw_ImplVer::PdbImplVC50);
117 io.enumCase(Value, "VC98", llvm::pdb::PdbRaw_ImplVer::PdbImplVC98);
118 io.enumCase(Value, "VC70Dep", llvm::pdb::PdbRaw_ImplVer::PdbImplVC70Dep);
119 io.enumCase(Value, "VC70", llvm::pdb::PdbRaw_ImplVer::PdbImplVC70);
120 io.enumCase(Value, "VC80", llvm::pdb::PdbRaw_ImplVer::PdbImplVC80);
121 io.enumCase(Value, "VC110", llvm::pdb::PdbRaw_ImplVer::PdbImplVC110);
122 io.enumCase(Value, "VC140", llvm::pdb::PdbRaw_ImplVer::PdbImplVC140);
126 template <> struct ScalarEnumerationTraits<llvm::pdb::PdbRaw_TpiVer> {
127 static void enumeration(IO &io, llvm::pdb::PdbRaw_TpiVer &Value) {
128 io.enumCase(Value, "VC40", llvm::pdb::PdbRaw_TpiVer::PdbTpiV40);
129 io.enumCase(Value, "VC41", llvm::pdb::PdbRaw_TpiVer::PdbTpiV41);
130 io.enumCase(Value, "VC50", llvm::pdb::PdbRaw_TpiVer::PdbTpiV50);
131 io.enumCase(Value, "VC70", llvm::pdb::PdbRaw_TpiVer::PdbTpiV70);
132 io.enumCase(Value, "VC80", llvm::pdb::PdbRaw_TpiVer::PdbTpiV80);
136 template <> struct ScalarEnumerationTraits<llvm::pdb::PdbRaw_FeatureSig> {
137 static void enumeration(IO &io, PdbRaw_FeatureSig &Features) {
138 io.enumCase(Features, "MinimalDebugInfo",
139 PdbRaw_FeatureSig::MinimalDebugInfo);
140 io.enumCase(Features, "NoTypeMerge", PdbRaw_FeatureSig::NoTypeMerge);
141 io.enumCase(Features, "VC110", PdbRaw_FeatureSig::VC110);
142 io.enumCase(Features, "VC140", PdbRaw_FeatureSig::VC140);
148 void MappingTraits<PdbObject>::mapping(IO &IO, PdbObject &Obj) {
149 IO.mapOptional("MSF", Obj.Headers);
150 IO.mapOptional("StreamSizes", Obj.StreamSizes);
151 IO.mapOptional("StreamMap", Obj.StreamMap);
152 IO.mapOptional("StringTable", Obj.StringTable);
153 IO.mapOptional("PdbStream", Obj.PdbStream);
154 IO.mapOptional("DbiStream", Obj.DbiStream);
155 IO.mapOptional("TpiStream", Obj.TpiStream);
156 IO.mapOptional("IpiStream", Obj.IpiStream);
159 void MappingTraits<MSFHeaders>::mapping(IO &IO, MSFHeaders &Obj) {
160 IO.mapOptional("SuperBlock", Obj.SuperBlock);
161 IO.mapOptional("NumDirectoryBlocks", Obj.NumDirectoryBlocks);
162 IO.mapOptional("DirectoryBlocks", Obj.DirectoryBlocks);
163 IO.mapOptional("NumStreams", Obj.NumStreams);
164 IO.mapOptional("FileSize", Obj.FileSize);
167 void MappingTraits<msf::SuperBlock>::mapping(IO &IO, msf::SuperBlock &SB) {
168 if (!IO.outputting()) {
169 ::memcpy(SB.MagicBytes, msf::Magic, sizeof(msf::Magic));
172 using u32 = support::ulittle32_t;
173 IO.mapOptional("BlockSize", SB.BlockSize, u32(4096U));
174 IO.mapOptional("FreeBlockMap", SB.FreeBlockMapBlock, u32(0U));
175 IO.mapOptional("NumBlocks", SB.NumBlocks, u32(0U));
176 IO.mapOptional("NumDirectoryBytes", SB.NumDirectoryBytes, u32(0U));
177 IO.mapOptional("Unknown1", SB.Unknown1, u32(0U));
178 IO.mapOptional("BlockMapAddr", SB.BlockMapAddr, u32(0U));
181 void MappingTraits<StreamBlockList>::mapping(IO &IO, StreamBlockList &SB) {
182 IO.mapRequired("Stream", SB.Blocks);
185 void MappingTraits<PdbInfoStream>::mapping(IO &IO, PdbInfoStream &Obj) {
186 IO.mapOptional("Age", Obj.Age, 1U);
187 IO.mapOptional("Guid", Obj.Guid);
188 IO.mapOptional("Signature", Obj.Signature, 0U);
189 IO.mapOptional("Features", Obj.Features);
190 IO.mapOptional("Version", Obj.Version, PdbImplVC70);
193 void MappingTraits<PdbDbiStream>::mapping(IO &IO, PdbDbiStream &Obj) {
194 IO.mapOptional("VerHeader", Obj.VerHeader, PdbDbiV70);
195 IO.mapOptional("Age", Obj.Age, 1U);
196 IO.mapOptional("BuildNumber", Obj.BuildNumber, uint16_t(0U));
197 IO.mapOptional("PdbDllVersion", Obj.PdbDllVersion, 0U);
198 IO.mapOptional("PdbDllRbld", Obj.PdbDllRbld, uint16_t(0U));
199 IO.mapOptional("Flags", Obj.Flags, uint16_t(1U));
200 IO.mapOptional("MachineType", Obj.MachineType, PDB_Machine::x86);
201 IO.mapOptional("Modules", Obj.ModInfos);
204 void MappingTraits<PdbTpiStream>::mapping(IO &IO,
205 pdb::yaml::PdbTpiStream &Obj) {
206 IO.mapOptional("Version", Obj.Version, PdbTpiV80);
207 IO.mapRequired("Records", Obj.Records);
210 void MappingTraits<NamedStreamMapping>::mapping(IO &IO,
211 NamedStreamMapping &Obj) {
212 IO.mapRequired("Name", Obj.StreamName);
213 IO.mapRequired("StreamNum", Obj.StreamNumber);
216 void MappingTraits<PdbModiStream>::mapping(IO &IO, PdbModiStream &Obj) {
217 IO.mapOptional("Signature", Obj.Signature, 4U);
218 IO.mapRequired("Records", Obj.Symbols);
221 void MappingTraits<PdbDbiModuleInfo>::mapping(IO &IO, PdbDbiModuleInfo &Obj) {
222 IO.mapRequired("Module", Obj.Mod);
223 IO.mapOptional("ObjFile", Obj.Obj, Obj.Mod);
224 IO.mapOptional("SourceFiles", Obj.SourceFiles);
225 IO.mapOptional("Subsections", Obj.Subsections);
226 IO.mapOptional("Modi", Obj.Modi);