contrib/llvm/tools/llvm-pdbutil/PdbYaml.cpp

   1 //===- PdbYAML.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 "PdbYaml.h"
  11
  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"
  27
  28 using namespace llvm;
  29 using namespace llvm::pdb;
  30 using namespace llvm::pdb::yaml;
  31 using namespace llvm::yaml;
  32
  33 LLVM_YAML_IS_SEQUENCE_VECTOR(llvm::pdb::yaml::NamedStreamMapping)
  34 LLVM_YAML_IS_SEQUENCE_VECTOR(llvm::pdb::yaml::PdbDbiModuleInfo)
  35 LLVM_YAML_IS_SEQUENCE_VECTOR(llvm::pdb::yaml::StreamBlockList)
  36 LLVM_YAML_IS_FLOW_SEQUENCE_VECTOR(llvm::pdb::PdbRaw_FeatureSig)
  37
  38 namespace llvm {
  39 namespace yaml {
  40
  41 template <> struct ScalarTraits<llvm::pdb::PDB_UniqueId> {
  42   static void output(const llvm::pdb::PDB_UniqueId &S, void *,
  43                      llvm::raw_ostream &OS) {
  44     OS << S;
  45   }
  46
  47   static StringRef input(StringRef Scalar, void *Ctx,
  48                          llvm::pdb::PDB_UniqueId &S) {
  49     if (Scalar.size() != 38)
  50       return "GUID strings are 38 characters long";
  51     if (Scalar[0] != '{' || Scalar[37] != '}')
  52       return "GUID is not enclosed in {}";
  53     if (Scalar[9] != '-' || Scalar[14] != '-' || Scalar[19] != '-' ||
  54         Scalar[24] != '-')
  55       return "GUID sections are not properly delineated with dashes";
  56
  57     uint8_t *OutBuffer = S.Guid;
  58     for (auto Iter = Scalar.begin(); Iter != Scalar.end();) {
  59       if (*Iter == '-' || *Iter == '{' || *Iter == '}') {
  60         ++Iter;
  61         continue;
  62       }
  63       uint8_t Value = (llvm::hexDigitValue(*Iter) << 4);
  64       ++Iter;
  65       Value |= llvm::hexDigitValue(*Iter);
  66       ++Iter;
  67       *OutBuffer++ = Value;
  68     }
  69
  70     return "";
  71   }
  72
  73   static bool mustQuote(StringRef Scalar) { return needsQuotes(Scalar); }
  74 };
  75
  76 template <> struct ScalarEnumerationTraits<llvm::pdb::PDB_Machine> {
  77   static void enumeration(IO &io, llvm::pdb::PDB_Machine &Value) {
  78     io.enumCase(Value, "Invalid", PDB_Machine::Invalid);
  79     io.enumCase(Value, "Am33", PDB_Machine::Am33);
  80     io.enumCase(Value, "Amd64", PDB_Machine::Amd64);
  81     io.enumCase(Value, "Arm", PDB_Machine::Arm);
  82     io.enumCase(Value, "ArmNT", PDB_Machine::ArmNT);
  83     io.enumCase(Value, "Ebc", PDB_Machine::Ebc);
  84     io.enumCase(Value, "x86", PDB_Machine::x86);
  85     io.enumCase(Value, "Ia64", PDB_Machine::Ia64);
  86     io.enumCase(Value, "M32R", PDB_Machine::M32R);
  87     io.enumCase(Value, "Mips16", PDB_Machine::Mips16);
  88     io.enumCase(Value, "MipsFpu", PDB_Machine::MipsFpu);
  89     io.enumCase(Value, "MipsFpu16", PDB_Machine::MipsFpu16);
  90     io.enumCase(Value, "PowerPCFP", PDB_Machine::PowerPCFP);
  91     io.enumCase(Value, "R4000", PDB_Machine::R4000);
  92     io.enumCase(Value, "SH3", PDB_Machine::SH3);
  93     io.enumCase(Value, "SH3DSP", PDB_Machine::SH3DSP);
  94     io.enumCase(Value, "Thumb", PDB_Machine::Thumb);
  95     io.enumCase(Value, "WceMipsV2", PDB_Machine::WceMipsV2);
  96   }
  97 };
  98
  99 template <> struct ScalarEnumerationTraits<llvm::pdb::PdbRaw_DbiVer> {
 100   static void enumeration(IO &io, llvm::pdb::PdbRaw_DbiVer &Value) {
 101     io.enumCase(Value, "V41", llvm::pdb::PdbRaw_DbiVer::PdbDbiVC41);
 102     io.enumCase(Value, "V50", llvm::pdb::PdbRaw_DbiVer::PdbDbiV50);
 103     io.enumCase(Value, "V60", llvm::pdb::PdbRaw_DbiVer::PdbDbiV60);
 104     io.enumCase(Value, "V70", llvm::pdb::PdbRaw_DbiVer::PdbDbiV70);
 105     io.enumCase(Value, "V110", llvm::pdb::PdbRaw_DbiVer::PdbDbiV110);
 106   }
 107 };
 108
 109 template <> struct ScalarEnumerationTraits<llvm::pdb::PdbRaw_ImplVer> {
 110   static void enumeration(IO &io, llvm::pdb::PdbRaw_ImplVer &Value) {
 111     io.enumCase(Value, "VC2", llvm::pdb::PdbRaw_ImplVer::PdbImplVC2);
 112     io.enumCase(Value, "VC4", llvm::pdb::PdbRaw_ImplVer::PdbImplVC4);
 113     io.enumCase(Value, "VC41", llvm::pdb::PdbRaw_ImplVer::PdbImplVC41);
 114     io.enumCase(Value, "VC50", llvm::pdb::PdbRaw_ImplVer::PdbImplVC50);
 115     io.enumCase(Value, "VC98", llvm::pdb::PdbRaw_ImplVer::PdbImplVC98);
 116     io.enumCase(Value, "VC70Dep", llvm::pdb::PdbRaw_ImplVer::PdbImplVC70Dep);
 117     io.enumCase(Value, "VC70", llvm::pdb::PdbRaw_ImplVer::PdbImplVC70);
 118     io.enumCase(Value, "VC80", llvm::pdb::PdbRaw_ImplVer::PdbImplVC80);
 119     io.enumCase(Value, "VC110", llvm::pdb::PdbRaw_ImplVer::PdbImplVC110);
 120     io.enumCase(Value, "VC140", llvm::pdb::PdbRaw_ImplVer::PdbImplVC140);
 121   }
 122 };
 123
 124 template <> struct ScalarEnumerationTraits<llvm::pdb::PdbRaw_TpiVer> {
 125   static void enumeration(IO &io, llvm::pdb::PdbRaw_TpiVer &Value) {
 126     io.enumCase(Value, "VC40", llvm::pdb::PdbRaw_TpiVer::PdbTpiV40);
 127     io.enumCase(Value, "VC41", llvm::pdb::PdbRaw_TpiVer::PdbTpiV41);
 128     io.enumCase(Value, "VC50", llvm::pdb::PdbRaw_TpiVer::PdbTpiV50);
 129     io.enumCase(Value, "VC70", llvm::pdb::PdbRaw_TpiVer::PdbTpiV70);
 130     io.enumCase(Value, "VC80", llvm::pdb::PdbRaw_TpiVer::PdbTpiV80);
 131   }
 132 };
 133
 134 template <> struct ScalarEnumerationTraits<llvm::pdb::PdbRaw_FeatureSig> {
 135   static void enumeration(IO &io, PdbRaw_FeatureSig &Features) {
 136     io.enumCase(Features, "MinimalDebugInfo",
 137                 PdbRaw_FeatureSig::MinimalDebugInfo);
 138     io.enumCase(Features, "NoTypeMerge", PdbRaw_FeatureSig::NoTypeMerge);
 139     io.enumCase(Features, "VC110", PdbRaw_FeatureSig::VC110);
 140     io.enumCase(Features, "VC140", PdbRaw_FeatureSig::VC140);
 141   }
 142 };
 143 }
 144 }
 145
 146 void MappingTraits<PdbObject>::mapping(IO &IO, PdbObject &Obj) {
 147   IO.mapOptional("MSF", Obj.Headers);
 148   IO.mapOptional("StreamSizes", Obj.StreamSizes);
 149   IO.mapOptional("StreamMap", Obj.StreamMap);
 150   IO.mapOptional("StringTable", Obj.StringTable);
 151   IO.mapOptional("PdbStream", Obj.PdbStream);
 152   IO.mapOptional("DbiStream", Obj.DbiStream);
 153   IO.mapOptional("TpiStream", Obj.TpiStream);
 154   IO.mapOptional("IpiStream", Obj.IpiStream);
 155 }
 156
 157 void MappingTraits<MSFHeaders>::mapping(IO &IO, MSFHeaders &Obj) {
 158   IO.mapOptional("SuperBlock", Obj.SuperBlock);
 159   IO.mapOptional("NumDirectoryBlocks", Obj.NumDirectoryBlocks);
 160   IO.mapOptional("DirectoryBlocks", Obj.DirectoryBlocks);
 161   IO.mapOptional("NumStreams", Obj.NumStreams);
 162   IO.mapOptional("FileSize", Obj.FileSize);
 163 }
 164
 165 void MappingTraits<msf::SuperBlock>::mapping(IO &IO, msf::SuperBlock &SB) {
 166   if (!IO.outputting()) {
 167     ::memcpy(SB.MagicBytes, msf::Magic, sizeof(msf::Magic));
 168   }
 169
 170   using u32 = support::ulittle32_t;
 171   IO.mapOptional("BlockSize", SB.BlockSize, u32(4096U));
 172   IO.mapOptional("FreeBlockMap", SB.FreeBlockMapBlock, u32(0U));
 173   IO.mapOptional("NumBlocks", SB.NumBlocks, u32(0U));
 174   IO.mapOptional("NumDirectoryBytes", SB.NumDirectoryBytes, u32(0U));
 175   IO.mapOptional("Unknown1", SB.Unknown1, u32(0U));
 176   IO.mapOptional("BlockMapAddr", SB.BlockMapAddr, u32(0U));
 177 }
 178
 179 void MappingTraits<StreamBlockList>::mapping(IO &IO, StreamBlockList &SB) {
 180   IO.mapRequired("Stream", SB.Blocks);
 181 }
 182
 183 void MappingTraits<PdbInfoStream>::mapping(IO &IO, PdbInfoStream &Obj) {
 184   IO.mapOptional("Age", Obj.Age, 1U);
 185   IO.mapOptional("Guid", Obj.Guid);
 186   IO.mapOptional("Signature", Obj.Signature, 0U);
 187   IO.mapOptional("Features", Obj.Features);
 188   IO.mapOptional("Version", Obj.Version, PdbImplVC70);
 189 }
 190
 191 void MappingTraits<PdbDbiStream>::mapping(IO &IO, PdbDbiStream &Obj) {
 192   IO.mapOptional("VerHeader", Obj.VerHeader, PdbDbiV70);
 193   IO.mapOptional("Age", Obj.Age, 1U);
 194   IO.mapOptional("BuildNumber", Obj.BuildNumber, uint16_t(0U));
 195   IO.mapOptional("PdbDllVersion", Obj.PdbDllVersion, 0U);
 196   IO.mapOptional("PdbDllRbld", Obj.PdbDllRbld, uint16_t(0U));
 197   IO.mapOptional("Flags", Obj.Flags, uint16_t(1U));
 198   IO.mapOptional("MachineType", Obj.MachineType, PDB_Machine::x86);
 199   IO.mapOptional("Modules", Obj.ModInfos);
 200 }
 201
 202 void MappingTraits<PdbTpiStream>::mapping(IO &IO,
 203                                           pdb::yaml::PdbTpiStream &Obj) {
 204   IO.mapOptional("Version", Obj.Version, PdbTpiV80);
 205   IO.mapRequired("Records", Obj.Records);
 206 }
 207
 208 void MappingTraits<NamedStreamMapping>::mapping(IO &IO,
 209                                                 NamedStreamMapping &Obj) {
 210   IO.mapRequired("Name", Obj.StreamName);
 211   IO.mapRequired("StreamNum", Obj.StreamNumber);
 212 }
 213
 214 void MappingTraits<PdbModiStream>::mapping(IO &IO, PdbModiStream &Obj) {
 215   IO.mapOptional("Signature", Obj.Signature, 4U);
 216   IO.mapRequired("Records", Obj.Symbols);
 217 }
 218
 219 void MappingTraits<PdbDbiModuleInfo>::mapping(IO &IO, PdbDbiModuleInfo &Obj) {
 220   IO.mapRequired("Module", Obj.Mod);
 221   IO.mapOptional("ObjFile", Obj.Obj, Obj.Mod);
 222   IO.mapOptional("SourceFiles", Obj.SourceFiles);
 223   IO.mapOptional("Subsections", Obj.Subsections);
 224   IO.mapOptional("Modi", Obj.Modi);
 225 }