242 lines · cpp
1//===-- PdbYaml.cpp ------------------------------------------- *- C++ --*-===//2//3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.4// See https://llvm.org/LICENSE.txt for license information.5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception6//7//===----------------------------------------------------------------------===//8 9#include "PdbYaml.h"10 11#include "llvm/ADT/StringExtras.h"12#include "llvm/DebugInfo/CodeView/CVTypeVisitor.h"13#include "llvm/DebugInfo/PDB/Native/PDBFile.h"14#include "llvm/DebugInfo/PDB/Native/RawTypes.h"15#include "llvm/DebugInfo/PDB/Native/TpiHashing.h"16#include "llvm/DebugInfo/PDB/PDBTypes.h"17#include "llvm/ObjectYAML/CodeViewYAMLDebugSections.h"18#include "llvm/ObjectYAML/CodeViewYAMLTypes.h"19 20using namespace llvm;21using namespace llvm::pdb;22using namespace llvm::pdb::yaml;23using namespace llvm::yaml;24 25LLVM_YAML_IS_SEQUENCE_VECTOR(llvm::pdb::yaml::CoffSectionHeader)26LLVM_YAML_IS_SEQUENCE_VECTOR(llvm::pdb::yaml::NamedStreamMapping)27LLVM_YAML_IS_SEQUENCE_VECTOR(llvm::pdb::yaml::PdbDbiModuleInfo)28LLVM_YAML_IS_SEQUENCE_VECTOR(llvm::pdb::yaml::StreamBlockList)29LLVM_YAML_IS_FLOW_SEQUENCE_VECTOR(llvm::pdb::PdbRaw_FeatureSig)30 31namespace llvm {32namespace yaml {33 34template <> struct ScalarEnumerationTraits<llvm::pdb::PDB_Machine> {35 static void enumeration(IO &io, llvm::pdb::PDB_Machine &Value) {36 io.enumCase(Value, "Invalid", PDB_Machine::Invalid);37 io.enumCase(Value, "Am33", PDB_Machine::Am33);38 io.enumCase(Value, "Amd64", PDB_Machine::Amd64);39 io.enumCase(Value, "Arm", PDB_Machine::Arm);40 io.enumCase(Value, "ArmNT", PDB_Machine::ArmNT);41 io.enumCase(Value, "Ebc", PDB_Machine::Ebc);42 io.enumCase(Value, "x86", PDB_Machine::x86);43 io.enumCase(Value, "Ia64", PDB_Machine::Ia64);44 io.enumCase(Value, "M32R", PDB_Machine::M32R);45 io.enumCase(Value, "Mips16", PDB_Machine::Mips16);46 io.enumCase(Value, "MipsFpu", PDB_Machine::MipsFpu);47 io.enumCase(Value, "MipsFpu16", PDB_Machine::MipsFpu16);48 io.enumCase(Value, "PowerPCFP", PDB_Machine::PowerPCFP);49 io.enumCase(Value, "R4000", PDB_Machine::R4000);50 io.enumCase(Value, "SH3", PDB_Machine::SH3);51 io.enumCase(Value, "SH3DSP", PDB_Machine::SH3DSP);52 io.enumCase(Value, "Thumb", PDB_Machine::Thumb);53 io.enumCase(Value, "WceMipsV2", PDB_Machine::WceMipsV2);54 io.enumCase(Value, "Arm64", PDB_Machine::Arm64);55 }56};57 58template <> struct ScalarEnumerationTraits<llvm::pdb::PdbRaw_DbiVer> {59 static void enumeration(IO &io, llvm::pdb::PdbRaw_DbiVer &Value) {60 io.enumCase(Value, "V41", llvm::pdb::PdbRaw_DbiVer::PdbDbiVC41);61 io.enumCase(Value, "V50", llvm::pdb::PdbRaw_DbiVer::PdbDbiV50);62 io.enumCase(Value, "V60", llvm::pdb::PdbRaw_DbiVer::PdbDbiV60);63 io.enumCase(Value, "V70", llvm::pdb::PdbRaw_DbiVer::PdbDbiV70);64 io.enumCase(Value, "V110", llvm::pdb::PdbRaw_DbiVer::PdbDbiV110);65 }66};67 68template <> struct ScalarEnumerationTraits<llvm::pdb::PdbRaw_ImplVer> {69 static void enumeration(IO &io, llvm::pdb::PdbRaw_ImplVer &Value) {70 io.enumCase(Value, "VC2", llvm::pdb::PdbRaw_ImplVer::PdbImplVC2);71 io.enumCase(Value, "VC4", llvm::pdb::PdbRaw_ImplVer::PdbImplVC4);72 io.enumCase(Value, "VC41", llvm::pdb::PdbRaw_ImplVer::PdbImplVC41);73 io.enumCase(Value, "VC50", llvm::pdb::PdbRaw_ImplVer::PdbImplVC50);74 io.enumCase(Value, "VC98", llvm::pdb::PdbRaw_ImplVer::PdbImplVC98);75 io.enumCase(Value, "VC70Dep", llvm::pdb::PdbRaw_ImplVer::PdbImplVC70Dep);76 io.enumCase(Value, "VC70", llvm::pdb::PdbRaw_ImplVer::PdbImplVC70);77 io.enumCase(Value, "VC80", llvm::pdb::PdbRaw_ImplVer::PdbImplVC80);78 io.enumCase(Value, "VC110", llvm::pdb::PdbRaw_ImplVer::PdbImplVC110);79 io.enumCase(Value, "VC140", llvm::pdb::PdbRaw_ImplVer::PdbImplVC140);80 }81};82 83template <> struct ScalarEnumerationTraits<llvm::pdb::PdbRaw_TpiVer> {84 static void enumeration(IO &io, llvm::pdb::PdbRaw_TpiVer &Value) {85 io.enumCase(Value, "VC40", llvm::pdb::PdbRaw_TpiVer::PdbTpiV40);86 io.enumCase(Value, "VC41", llvm::pdb::PdbRaw_TpiVer::PdbTpiV41);87 io.enumCase(Value, "VC50", llvm::pdb::PdbRaw_TpiVer::PdbTpiV50);88 io.enumCase(Value, "VC70", llvm::pdb::PdbRaw_TpiVer::PdbTpiV70);89 io.enumCase(Value, "VC80", llvm::pdb::PdbRaw_TpiVer::PdbTpiV80);90 }91};92 93template <> struct ScalarEnumerationTraits<llvm::pdb::PdbRaw_FeatureSig> {94 static void enumeration(IO &io, PdbRaw_FeatureSig &Features) {95 io.enumCase(Features, "MinimalDebugInfo",96 PdbRaw_FeatureSig::MinimalDebugInfo);97 io.enumCase(Features, "NoTypeMerge", PdbRaw_FeatureSig::NoTypeMerge);98 io.enumCase(Features, "VC110", PdbRaw_FeatureSig::VC110);99 io.enumCase(Features, "VC140", PdbRaw_FeatureSig::VC140);100 }101};102}103}104 105void MappingTraits<PdbObject>::mapping(IO &IO, PdbObject &Obj) {106 IO.mapOptional("MSF", Obj.Headers);107 IO.mapOptional("StreamSizes", Obj.StreamSizes);108 IO.mapOptional("StreamMap", Obj.StreamMap);109 IO.mapOptional("StringTable", Obj.StringTable);110 IO.mapOptional("PdbStream", Obj.PdbStream);111 IO.mapOptional("DbiStream", Obj.DbiStream);112 IO.mapOptional("TpiStream", Obj.TpiStream);113 IO.mapOptional("IpiStream", Obj.IpiStream);114 IO.mapOptional("PublicsStream", Obj.PublicsStream);115}116 117void MappingTraits<MSFHeaders>::mapping(IO &IO, MSFHeaders &Obj) {118 IO.mapOptional("SuperBlock", Obj.SuperBlock);119 IO.mapOptional("NumDirectoryBlocks", Obj.NumDirectoryBlocks);120 IO.mapOptional("DirectoryBlocks", Obj.DirectoryBlocks);121 IO.mapOptional("NumStreams", Obj.NumStreams);122 IO.mapOptional("FileSize", Obj.FileSize);123}124 125void MappingTraits<msf::SuperBlock>::mapping(IO &IO, msf::SuperBlock &SB) {126 if (!IO.outputting()) {127 ::memcpy(SB.MagicBytes, msf::Magic, sizeof(msf::Magic));128 }129 130 using u32 = support::ulittle32_t;131 IO.mapOptional("BlockSize", SB.BlockSize, u32(4096U));132 IO.mapOptional("FreeBlockMap", SB.FreeBlockMapBlock, u32(0U));133 IO.mapOptional("NumBlocks", SB.NumBlocks, u32(0U));134 IO.mapOptional("NumDirectoryBytes", SB.NumDirectoryBytes, u32(0U));135 IO.mapOptional("Unknown1", SB.Unknown1, u32(0U));136 IO.mapOptional("BlockMapAddr", SB.BlockMapAddr, u32(0U));137}138 139CoffSectionHeader::CoffSectionHeader() = default;140 141CoffSectionHeader::CoffSectionHeader(const object::coff_section &Section)142 : Name(Section.Name), VirtualSize(Section.VirtualSize),143 VirtualAddress(Section.VirtualAddress),144 SizeOfRawData(Section.SizeOfRawData),145 PointerToRawData(Section.PointerToRawData),146 PointerToRelocations(Section.PointerToRelocations),147 PointerToLinenumbers(Section.PointerToLinenumbers),148 NumberOfRelocations(Section.NumberOfRelocations),149 NumberOfLinenumbers(Section.NumberOfLinenumbers),150 Characteristics(Section.Characteristics) {}151 152object::coff_section CoffSectionHeader::toCoffSection() const {153 object::coff_section Sec;154 std::memset(Sec.Name, 0, COFF::NameSize);155 std::memcpy(Sec.Name, Name.data(),156 std::min(static_cast<size_t>(COFF::NameSize), Name.size()));157 Sec.VirtualSize = VirtualSize;158 Sec.VirtualAddress = VirtualAddress;159 Sec.SizeOfRawData = SizeOfRawData;160 Sec.PointerToRawData = PointerToRawData;161 Sec.PointerToRelocations = PointerToRelocations;162 Sec.PointerToLinenumbers = PointerToLinenumbers;163 Sec.NumberOfRelocations = NumberOfRelocations;164 Sec.NumberOfLinenumbers = NumberOfLinenumbers;165 Sec.Characteristics = Characteristics;166 return Sec;167}168 169void MappingTraits<CoffSectionHeader>::mapping(IO &IO, CoffSectionHeader &Obj) {170 IO.mapRequired("Name", Obj.Name);171 IO.mapOptional("VirtualSize", Obj.VirtualSize);172 IO.mapOptional("VirtualAddress", Obj.VirtualAddress);173 IO.mapOptional("SizeOfRawData", Obj.SizeOfRawData);174 IO.mapOptional("PointerToRawData", Obj.PointerToRawData);175 IO.mapOptional("PointerToRelocations", Obj.PointerToRelocations);176 IO.mapOptional("PointerToLinenumbers", Obj.PointerToLinenumbers);177 IO.mapOptional("NumberOfRelocations", Obj.NumberOfRelocations);178 IO.mapOptional("NumberOfLinenumbers", Obj.NumberOfLinenumbers);179 IO.mapOptional("Characteristics", Obj.Characteristics);180}181 182void MappingTraits<StreamBlockList>::mapping(IO &IO, StreamBlockList &SB) {183 IO.mapRequired("Stream", SB.Blocks);184}185 186void MappingTraits<PdbInfoStream>::mapping(IO &IO, PdbInfoStream &Obj) {187 IO.mapOptional("Age", Obj.Age, 1U);188 IO.mapOptional("Guid", Obj.Guid);189 IO.mapOptional("Signature", Obj.Signature, 0U);190 IO.mapOptional("Features", Obj.Features);191 IO.mapOptional("Version", Obj.Version, PdbImplVC70);192}193 194void MappingTraits<PdbDbiStream>::mapping(IO &IO, PdbDbiStream &Obj) {195 IO.mapOptional("VerHeader", Obj.VerHeader, PdbDbiV70);196 IO.mapOptional("Age", Obj.Age, 1U);197 IO.mapOptional("BuildNumber", Obj.BuildNumber, uint16_t(0U));198 IO.mapOptional("PdbDllVersion", Obj.PdbDllVersion, 0U);199 IO.mapOptional("PdbDllRbld", Obj.PdbDllRbld, uint16_t(0U));200 IO.mapOptional("Flags", Obj.Flags, uint16_t(1U));201 IO.mapOptional("MachineType", Obj.MachineType, PDB_Machine::x86);202 // This is a workaround for IO not having document context with the203 // machine type. The machine type is needed to properly parse Register enums204 // in the PDB.205 if (!IO.getContext()) {206 Obj.FakeHeader.Machine = static_cast<uint16_t>(Obj.MachineType);207 IO.setContext(&Obj.FakeHeader);208 }209 IO.mapOptional("Modules", Obj.ModInfos);210 IO.mapOptional("SectionHeaders", Obj.SectionHeaders);211}212 213void MappingTraits<PdbTpiStream>::mapping(IO &IO,214 pdb::yaml::PdbTpiStream &Obj) {215 IO.mapOptional("Version", Obj.Version, PdbTpiV80);216 IO.mapRequired("Records", Obj.Records);217}218 219void MappingTraits<PdbPublicsStream>::mapping(220 IO &IO, pdb::yaml::PdbPublicsStream &Obj) {221 IO.mapRequired("Records", Obj.PubSyms);222}223 224void MappingTraits<NamedStreamMapping>::mapping(IO &IO,225 NamedStreamMapping &Obj) {226 IO.mapRequired("Name", Obj.StreamName);227 IO.mapRequired("StreamNum", Obj.StreamNumber);228}229 230void MappingTraits<PdbModiStream>::mapping(IO &IO, PdbModiStream &Obj) {231 IO.mapOptional("Signature", Obj.Signature, 4U);232 IO.mapRequired("Records", Obj.Symbols);233}234 235void MappingTraits<PdbDbiModuleInfo>::mapping(IO &IO, PdbDbiModuleInfo &Obj) {236 IO.mapRequired("Module", Obj.Mod);237 IO.mapOptional("ObjFile", Obj.Obj, Obj.Mod);238 IO.mapOptional("SourceFiles", Obj.SourceFiles);239 IO.mapOptional("Subsections", Obj.Subsections);240 IO.mapOptional("Modi", Obj.Modi);241}242