contrib/llvm/tools/llvm-pdbdump/YamlSymbolDumper.cpp

   1 //===- YamlSymbolDumper.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 "YamlSymbolDumper.h"
  11 #include "PdbYaml.h"
  12 #include "YamlTypeDumper.h"
  13
  14 #include "llvm/DebugInfo/CodeView/CVSymbolVisitor.h"
  15 #include "llvm/DebugInfo/CodeView/EnumTables.h"
  16 #include "llvm/DebugInfo/CodeView/SymbolDeserializer.h"
  17 #include "llvm/DebugInfo/CodeView/SymbolRecord.h"
  18 #include "llvm/DebugInfo/CodeView/SymbolVisitorCallbackPipeline.h"
  19
  20 using namespace llvm;
  21 using namespace llvm::codeview;
  22 using namespace llvm::codeview::yaml;
  23
  24 LLVM_YAML_IS_FLOW_SEQUENCE_VECTOR(TypeIndex)
  25 LLVM_YAML_IS_FLOW_SEQUENCE_VECTOR(uint64_t)
  26 LLVM_YAML_IS_SEQUENCE_VECTOR(OneMethodRecord)
  27 LLVM_YAML_IS_SEQUENCE_VECTOR(VFTableSlotKind)
  28 LLVM_YAML_IS_SEQUENCE_VECTOR(StringRef)
  29 LLVM_YAML_IS_SEQUENCE_VECTOR(CVType)
  30 LLVM_YAML_IS_SEQUENCE_VECTOR(llvm::pdb::yaml::PdbTpiFieldListRecord)
  31
  32 namespace llvm {
  33 namespace yaml {
  34 void ScalarEnumerationTraits<SymbolKind>::enumeration(IO &io,
  35                                                       SymbolKind &Value) {
  36   auto SymbolNames = getSymbolTypeNames();
  37   for (const auto &E : SymbolNames)
  38     io.enumCase(Value, E.Name.str().c_str(), E.Value);
  39 }
  40
  41 template <> struct ScalarBitSetTraits<CompileSym2Flags> {
  42   static void bitset(IO &io, CompileSym2Flags &Flags) {
  43     auto FlagNames = getCompileSym2FlagNames();
  44     for (const auto &E : FlagNames) {
  45       io.bitSetCase(Flags, E.Name.str().c_str(),
  46                     static_cast<CompileSym2Flags>(E.Value));
  47     }
  48   }
  49 };
  50
  51 template <> struct ScalarBitSetTraits<CompileSym3Flags> {
  52   static void bitset(IO &io, CompileSym3Flags &Flags) {
  53     auto FlagNames = getCompileSym3FlagNames();
  54     for (const auto &E : FlagNames) {
  55       io.bitSetCase(Flags, E.Name.str().c_str(),
  56                     static_cast<CompileSym3Flags>(E.Value));
  57     }
  58   }
  59 };
  60
  61 template <> struct ScalarBitSetTraits<ExportFlags> {
  62   static void bitset(IO &io, ExportFlags &Flags) {
  63     auto FlagNames = getExportSymFlagNames();
  64     for (const auto &E : FlagNames) {
  65       io.bitSetCase(Flags, E.Name.str().c_str(),
  66                     static_cast<ExportFlags>(E.Value));
  67     }
  68   }
  69 };
  70
  71 template <> struct ScalarBitSetTraits<LocalSymFlags> {
  72   static void bitset(IO &io, LocalSymFlags &Flags) {
  73     auto FlagNames = getLocalFlagNames();
  74     for (const auto &E : FlagNames) {
  75       io.bitSetCase(Flags, E.Name.str().c_str(),
  76                     static_cast<LocalSymFlags>(E.Value));
  77     }
  78   }
  79 };
  80
  81 template <> struct ScalarBitSetTraits<ProcSymFlags> {
  82   static void bitset(IO &io, ProcSymFlags &Flags) {
  83     auto FlagNames = getProcSymFlagNames();
  84     for (const auto &E : FlagNames) {
  85       io.bitSetCase(Flags, E.Name.str().c_str(),
  86                     static_cast<ProcSymFlags>(E.Value));
  87     }
  88   }
  89 };
  90
  91 template <> struct ScalarBitSetTraits<FrameProcedureOptions> {
  92   static void bitset(IO &io, FrameProcedureOptions &Flags) {
  93     auto FlagNames = getFrameProcSymFlagNames();
  94     for (const auto &E : FlagNames) {
  95       io.bitSetCase(Flags, E.Name.str().c_str(),
  96                     static_cast<FrameProcedureOptions>(E.Value));
  97     }
  98   }
  99 };
 100
 101 template <> struct ScalarEnumerationTraits<CPUType> {
 102   static void enumeration(IO &io, CPUType &Cpu) {
 103     auto CpuNames = getCPUTypeNames();
 104     for (const auto &E : CpuNames) {
 105       io.enumCase(Cpu, E.Name.str().c_str(), static_cast<CPUType>(E.Value));
 106     }
 107   }
 108 };
 109
 110 template <> struct ScalarEnumerationTraits<RegisterId> {
 111   static void enumeration(IO &io, RegisterId &Reg) {
 112     auto RegNames = getRegisterNames();
 113     for (const auto &E : RegNames) {
 114       io.enumCase(Reg, E.Name.str().c_str(), static_cast<RegisterId>(E.Value));
 115     }
 116   }
 117 };
 118
 119 template <> struct ScalarEnumerationTraits<TrampolineType> {
 120   static void enumeration(IO &io, TrampolineType &Tramp) {
 121     auto TrampNames = getTrampolineNames();
 122     for (const auto &E : TrampNames) {
 123       io.enumCase(Tramp, E.Name.str().c_str(),
 124                   static_cast<TrampolineType>(E.Value));
 125     }
 126   }
 127 };
 128
 129 template <> struct ScalarEnumerationTraits<ThunkOrdinal> {
 130   static void enumeration(IO &io, ThunkOrdinal &Ord) {
 131     auto ThunkNames = getThunkOrdinalNames();
 132     for (const auto &E : ThunkNames) {
 133       io.enumCase(Ord, E.Name.str().c_str(),
 134                   static_cast<ThunkOrdinal>(E.Value));
 135     }
 136   }
 137 };
 138
 139 void MappingTraits<ScopeEndSym>::mapping(IO &IO, ScopeEndSym &Obj) {}
 140
 141 void MappingTraits<Thunk32Sym>::mapping(IO &IO, Thunk32Sym &Thunk) {
 142   IO.mapRequired("Parent", Thunk.Parent);
 143   IO.mapRequired("End", Thunk.End);
 144   IO.mapRequired("Next", Thunk.Next);
 145   IO.mapRequired("Off", Thunk.Offset);
 146   IO.mapRequired("Seg", Thunk.Segment);
 147   IO.mapRequired("Len", Thunk.Length);
 148   IO.mapRequired("Ordinal", Thunk.Thunk);
 149 }
 150
 151 void MappingTraits<TrampolineSym>::mapping(IO &IO, TrampolineSym &Tramp) {
 152   IO.mapRequired("Type", Tramp.Type);
 153   IO.mapRequired("Size", Tramp.Size);
 154   IO.mapRequired("ThunkOff", Tramp.ThunkOffset);
 155   IO.mapRequired("TargetOff", Tramp.TargetOffset);
 156   IO.mapRequired("ThunkSection", Tramp.ThunkSection);
 157   IO.mapRequired("TargetSection", Tramp.TargetSection);
 158 }
 159
 160 void MappingTraits<SectionSym>::mapping(IO &IO, SectionSym &Section) {
 161   IO.mapRequired("SectionNumber", Section.SectionNumber);
 162   IO.mapRequired("Alignment", Section.Alignment);
 163   IO.mapRequired("Rva", Section.Rva);
 164   IO.mapRequired("Length", Section.Length);
 165   IO.mapRequired("Characteristics", Section.Characteristics);
 166   IO.mapRequired("Name", Section.Name);
 167 }
 168
 169 void MappingTraits<CoffGroupSym>::mapping(IO &IO, CoffGroupSym &CoffGroup) {
 170   IO.mapRequired("Size", CoffGroup.Size);
 171   IO.mapRequired("Characteristics", CoffGroup.Characteristics);
 172   IO.mapRequired("Offset", CoffGroup.Offset);
 173   IO.mapRequired("Segment", CoffGroup.Segment);
 174   IO.mapRequired("Name", CoffGroup.Name);
 175 }
 176
 177 void MappingTraits<ExportSym>::mapping(IO &IO, ExportSym &Export) {
 178   IO.mapRequired("Ordinal", Export.Ordinal);
 179   IO.mapRequired("Flags", Export.Flags);
 180   IO.mapRequired("Name", Export.Name);
 181 }
 182
 183 void MappingTraits<ProcSym>::mapping(IO &IO, ProcSym &Proc) {
 184   // TODO: Print the linkage name
 185
 186   IO.mapRequired("PtrParent", Proc.Parent);
 187   IO.mapRequired("PtrEnd", Proc.End);
 188   IO.mapRequired("PtrNext", Proc.Next);
 189   IO.mapRequired("CodeSize", Proc.CodeSize);
 190   IO.mapRequired("DbgStart", Proc.DbgStart);
 191   IO.mapRequired("DbgEnd", Proc.DbgEnd);
 192   IO.mapRequired("FunctionType", Proc.FunctionType);
 193   IO.mapRequired("Segment", Proc.Segment);
 194   IO.mapRequired("Flags", Proc.Flags);
 195   IO.mapRequired("DisplayName", Proc.Name);
 196 }
 197
 198 void MappingTraits<RegisterSym>::mapping(IO &IO, RegisterSym &Register) {
 199   IO.mapRequired("Type", Register.Index);
 200   IO.mapRequired("Seg", Register.Register);
 201   IO.mapRequired("Name", Register.Name);
 202 }
 203
 204 void MappingTraits<PublicSym32>::mapping(IO &IO, PublicSym32 &Public) {
 205   IO.mapRequired("Type", Public.Index);
 206   IO.mapRequired("Seg", Public.Segment);
 207   IO.mapRequired("Off", Public.Offset);
 208   IO.mapRequired("Name", Public.Name);
 209 }
 210
 211 void MappingTraits<ProcRefSym>::mapping(IO &IO, ProcRefSym &ProcRef) {
 212   IO.mapRequired("SumName", ProcRef.SumName);
 213   IO.mapRequired("SymOffset", ProcRef.SymOffset);
 214   IO.mapRequired("Mod", ProcRef.Module);
 215   IO.mapRequired("Name", ProcRef.Name);
 216 }
 217
 218 void MappingTraits<EnvBlockSym>::mapping(IO &IO, EnvBlockSym &EnvBlock) {
 219   IO.mapRequired("Entries", EnvBlock.Fields);
 220 }
 221
 222 void MappingTraits<InlineSiteSym>::mapping(IO &IO, InlineSiteSym &InlineSite) {
 223   IO.mapRequired("PtrParent", InlineSite.Parent);
 224   IO.mapRequired("PtrEnd", InlineSite.End);
 225   IO.mapRequired("Inlinee", InlineSite.Inlinee);
 226   // TODO: The binary annotations
 227 }
 228
 229 void MappingTraits<LocalSym>::mapping(IO &IO, LocalSym &Local) {
 230   IO.mapRequired("Type", Local.Type);
 231   IO.mapRequired("Flags", Local.Flags);
 232   IO.mapRequired("VarName", Local.Name);
 233 }
 234
 235 void MappingTraits<DefRangeSym>::mapping(IO &IO, DefRangeSym &Obj) {
 236   // TODO: Print the subfields
 237 }
 238
 239 void MappingTraits<DefRangeSubfieldSym>::mapping(IO &IO,
 240                                                  DefRangeSubfieldSym &Obj) {
 241   // TODO: Print the subfields
 242 }
 243
 244 void MappingTraits<DefRangeRegisterSym>::mapping(IO &IO,
 245                                                  DefRangeRegisterSym &Obj) {
 246   // TODO: Print the subfields
 247 }
 248
 249 void MappingTraits<DefRangeFramePointerRelSym>::mapping(
 250     IO &IO, DefRangeFramePointerRelSym &Obj) {
 251   // TODO: Print the subfields
 252 }
 253
 254 void MappingTraits<DefRangeSubfieldRegisterSym>::mapping(
 255     IO &IO, DefRangeSubfieldRegisterSym &Obj) {
 256   // TODO: Print the subfields
 257 }
 258
 259 void MappingTraits<DefRangeFramePointerRelFullScopeSym>::mapping(
 260     IO &IO, DefRangeFramePointerRelFullScopeSym &Obj) {
 261   // TODO: Print the subfields
 262 }
 263
 264 void MappingTraits<DefRangeRegisterRelSym>::mapping(
 265     IO &IO, DefRangeRegisterRelSym &Obj) {
 266   // TODO: Print the subfields
 267 }
 268
 269 void MappingTraits<BlockSym>::mapping(IO &IO, BlockSym &Block) {
 270   // TODO: Print the linkage name
 271   IO.mapRequired("PtrParent", Block.Parent);
 272   IO.mapRequired("PtrEnd", Block.End);
 273   IO.mapRequired("CodeSize", Block.CodeSize);
 274   IO.mapRequired("Segment", Block.Segment);
 275   IO.mapRequired("BlockName", Block.Name);
 276 }
 277
 278 void MappingTraits<LabelSym>::mapping(IO &IO, LabelSym &Label) {
 279   // TODO: Print the linkage name
 280   IO.mapRequired("Segment", Label.Segment);
 281   IO.mapRequired("Flags", Label.Flags);
 282   IO.mapRequired("Flags", Label.Flags);
 283   IO.mapRequired("DisplayName", Label.Name);
 284 }
 285
 286 void MappingTraits<ObjNameSym>::mapping(IO &IO, ObjNameSym &ObjName) {
 287   IO.mapRequired("Signature", ObjName.Signature);
 288   IO.mapRequired("ObjectName", ObjName.Name);
 289 }
 290
 291 void MappingTraits<Compile2Sym>::mapping(IO &IO, Compile2Sym &Compile2) {
 292   IO.mapRequired("Flags", Compile2.Flags);
 293   IO.mapRequired("Machine", Compile2.Machine);
 294   IO.mapRequired("FrontendMajor", Compile2.VersionFrontendMajor);
 295   IO.mapRequired("FrontendMinor", Compile2.VersionFrontendMinor);
 296   IO.mapRequired("FrontendBuild", Compile2.VersionFrontendBuild);
 297   IO.mapRequired("BackendMajor", Compile2.VersionBackendMajor);
 298   IO.mapRequired("BackendMinor", Compile2.VersionBackendMinor);
 299   IO.mapRequired("BackendBuild", Compile2.VersionBackendBuild);
 300   IO.mapRequired("Version", Compile2.Version);
 301 }
 302
 303 void MappingTraits<Compile3Sym>::mapping(IO &IO, Compile3Sym &Compile3) {
 304   IO.mapRequired("Flags", Compile3.Flags);
 305   IO.mapRequired("Machine", Compile3.Machine);
 306   IO.mapRequired("FrontendMajor", Compile3.VersionFrontendMajor);
 307   IO.mapRequired("FrontendMinor", Compile3.VersionFrontendMinor);
 308   IO.mapRequired("FrontendBuild", Compile3.VersionFrontendBuild);
 309   IO.mapRequired("FrontendQFE", Compile3.VersionFrontendQFE);
 310   IO.mapRequired("BackendMajor", Compile3.VersionBackendMajor);
 311   IO.mapRequired("BackendMinor", Compile3.VersionBackendMinor);
 312   IO.mapRequired("BackendBuild", Compile3.VersionBackendBuild);
 313   IO.mapRequired("BackendQFE", Compile3.VersionBackendQFE);
 314   IO.mapRequired("Version", Compile3.Version);
 315 }
 316
 317 void MappingTraits<FrameProcSym>::mapping(IO &IO, FrameProcSym &FrameProc) {
 318   IO.mapRequired("TotalFrameBytes", FrameProc.TotalFrameBytes);
 319   IO.mapRequired("PaddingFrameBytes", FrameProc.PaddingFrameBytes);
 320   IO.mapRequired("OffsetToPadding", FrameProc.OffsetToPadding);
 321   IO.mapRequired("BytesOfCalleeSavedRegisters",
 322                  FrameProc.BytesOfCalleeSavedRegisters);
 323   IO.mapRequired("OffsetOfExceptionHandler",
 324                  FrameProc.OffsetOfExceptionHandler);
 325   IO.mapRequired("SectionIdOfExceptionHandler",
 326                  FrameProc.SectionIdOfExceptionHandler);
 327   IO.mapRequired("Flags", FrameProc.Flags);
 328 }
 329
 330 void MappingTraits<CallSiteInfoSym>::mapping(IO &IO,
 331                                              CallSiteInfoSym &CallSiteInfo) {
 332   // TODO: Map Linkage Name
 333   IO.mapRequired("Segment", CallSiteInfo.Segment);
 334   IO.mapRequired("Type", CallSiteInfo.Type);
 335 }
 336
 337 void MappingTraits<FileStaticSym>::mapping(IO &IO, FileStaticSym &FileStatic) {
 338   IO.mapRequired("Index", FileStatic.Index);
 339   IO.mapRequired("ModFilenameOffset", FileStatic.ModFilenameOffset);
 340   IO.mapRequired("Flags", FileStatic.Flags);
 341   IO.mapRequired("Name", FileStatic.Name);
 342 }
 343
 344 void MappingTraits<HeapAllocationSiteSym>::mapping(
 345     IO &IO, HeapAllocationSiteSym &HeapAllocSite) {
 346   // TODO: Map Linkage Name
 347   IO.mapRequired("Segment", HeapAllocSite.Segment);
 348   IO.mapRequired("CallInstructionSize", HeapAllocSite.CallInstructionSize);
 349   IO.mapRequired("Type", HeapAllocSite.Type);
 350 }
 351
 352 void MappingTraits<FrameCookieSym>::mapping(IO &IO,
 353                                             FrameCookieSym &FrameCookie) {
 354   // TODO: Map Linkage Name
 355   IO.mapRequired("Register", FrameCookie.Register);
 356   IO.mapRequired("CookieKind", FrameCookie.CookieKind);
 357   IO.mapRequired("Flags", FrameCookie.Flags);
 358 }
 359
 360 void MappingTraits<CallerSym>::mapping(IO &IO, CallerSym &Caller) {
 361   // TODO: Correctly handle the ArrayRef in here.
 362   std::vector<TypeIndex> Indices(Caller.Indices);
 363   IO.mapRequired("FuncID", Indices);
 364 }
 365
 366 void MappingTraits<UDTSym>::mapping(IO &IO, UDTSym &UDT) {
 367   IO.mapRequired("Type", UDT.Type);
 368   IO.mapRequired("UDTName", UDT.Name);
 369 }
 370
 371 void MappingTraits<BuildInfoSym>::mapping(IO &IO, BuildInfoSym &BuildInfo) {
 372   IO.mapRequired("BuildId", BuildInfo.BuildId);
 373 }
 374
 375 void MappingTraits<BPRelativeSym>::mapping(IO &IO, BPRelativeSym &BPRel) {
 376   IO.mapRequired("Offset", BPRel.Offset);
 377   IO.mapRequired("Type", BPRel.Type);
 378   IO.mapRequired("VarName", BPRel.Name);
 379 }
 380
 381 void MappingTraits<RegRelativeSym>::mapping(IO &IO, RegRelativeSym &RegRel) {
 382   IO.mapRequired("Offset", RegRel.Offset);
 383   IO.mapRequired("Type", RegRel.Type);
 384   IO.mapRequired("Register", RegRel.Register);
 385   IO.mapRequired("VarName", RegRel.Name);
 386 }
 387
 388 void MappingTraits<ConstantSym>::mapping(IO &IO, ConstantSym &Constant) {
 389   IO.mapRequired("Type", Constant.Type);
 390   IO.mapRequired("Value", Constant.Value);
 391   IO.mapRequired("Name", Constant.Name);
 392 }
 393
 394 void MappingTraits<DataSym>::mapping(IO &IO, DataSym &Data) {
 395   // TODO: Map linkage name
 396   IO.mapRequired("Type", Data.Type);
 397   IO.mapRequired("DisplayName", Data.Name);
 398 }
 399
 400 void MappingTraits<ThreadLocalDataSym>::mapping(IO &IO,
 401                                                 ThreadLocalDataSym &Data) {
 402   // TODO: Map linkage name
 403   IO.mapRequired("Type", Data.Type);
 404   IO.mapRequired("DisplayName", Data.Name);
 405 }
 406 }
 407 }
 408
 409 Error llvm::codeview::yaml::YamlSymbolDumper::visitSymbolBegin(CVSymbol &CVR) {
 410   YamlIO.mapRequired("Kind", CVR.Type);
 411   return Error::success();
 412 }