70 return ScalarTraits<StringRef>::input(S, V,
T.value);
73void ScalarTraits<TypeName>::output(
const TypeName &
T,
void *V,
75 ScalarTraits<StringRef>::output(
T.value, V, R);
78void ScalarEnumerationTraits<SymbolKind>::enumeration(IO &io,
81 for (
const auto &
E : SymbolNames)
82 io.enumCase(
Value,
E.Name.str().c_str(),
E.Value);
85void ScalarBitSetTraits<CompileSym2Flags>::bitset(IO &io,
88 for (
const auto &
E : FlagNames) {
89 io.bitSetCase(Flags,
E.Name.str().c_str(),
94void ScalarBitSetTraits<CompileSym3Flags>::bitset(IO &io,
97 for (
const auto &
E : FlagNames) {
98 io.bitSetCase(Flags,
E.Name.str().c_str(),
103void ScalarBitSetTraits<ExportFlags>::bitset(IO &io,
ExportFlags &Flags) {
105 for (
const auto &
E : FlagNames) {
106 io.bitSetCase(Flags,
E.Name.str().c_str(),
111void ScalarBitSetTraits<PublicSymFlags>::bitset(IO &io,
PublicSymFlags &Flags) {
113 for (
const auto &
E : FlagNames) {
114 io.bitSetCase(Flags,
E.Name.str().c_str(),
119void ScalarBitSetTraits<LocalSymFlags>::bitset(IO &io,
LocalSymFlags &Flags) {
121 for (
const auto &
E : FlagNames) {
122 io.bitSetCase(Flags,
E.Name.str().c_str(),
127void ScalarBitSetTraits<ProcSymFlags>::bitset(IO &io,
ProcSymFlags &Flags) {
129 for (
const auto &
E : FlagNames) {
130 io.bitSetCase(Flags,
E.Name.str().c_str(),
135void ScalarBitSetTraits<FrameProcedureOptions>::bitset(
138 for (
const auto &
E : FlagNames) {
139 io.bitSetCase(Flags,
E.Name.str().c_str(),
144void ScalarEnumerationTraits<CPUType>::enumeration(IO &io,
CPUType &Cpu) {
146 for (
const auto &
E : CpuNames) {
147 io.enumCase(Cpu,
E.Name.str().c_str(),
static_cast<CPUType>(
E.Value));
151void ScalarEnumerationTraits<RegisterId>::enumeration(IO &io,
RegisterId &Reg) {
152 const auto *Header =
static_cast<COFF::header *
>(io.getContext());
153 assert(Header &&
"The IO context is not initialized");
155 std::optional<CPUType> CpuType;
158 switch (Header->Machine) {
160 CpuType = CPUType::Pentium3;
163 CpuType = CPUType::X64;
166 CpuType = CPUType::ARMNT;
170 CpuType = CPUType::ARM64;
177 for (
const auto &
E : RegNames) {
178 io.enumCase(Reg,
E.Name.str().c_str(),
static_cast<RegisterId>(
E.Value));
180 io.enumFallback<Hex16>(
Reg);
183void ScalarEnumerationTraits<TrampolineType>::enumeration(
186 for (
const auto &
E : TrampNames) {
187 io.enumCase(Tramp,
E.Name.str().c_str(),
192void ScalarEnumerationTraits<ThunkOrdinal>::enumeration(IO &io,
195 for (
const auto &
E : ThunkNames) {
196 io.enumCase(Ord,
E.Name.str().c_str(),
static_cast<ThunkOrdinal>(
E.Value));
200void ScalarEnumerationTraits<FrameCookieKind>::enumeration(
203 for (
const auto &
E : ThunkNames) {
204 io.enumCase(FC,
E.Name.str().c_str(),
213 io.mapRequired(
"OffsetStart", Range.OffsetStart);
214 io.mapRequired(
"ISectStart", Range.ISectStart);
215 io.mapRequired(
"Range", Range.Range);
221 io.mapRequired(
"Range", Gap.
Range);
228namespace CodeViewYAML {
237 virtual void map(yaml::IO &io) = 0;
248 void map(yaml::IO &io)
override;
257 return SymbolDeserializer::deserializeAs<T>(CVS,
Symbol);
266 void map(yaml::IO &io)
override;
272 Prefix.RecordKind =
Kind;
273 Prefix.RecordLen = TotalLen - 2;
274 uint8_t *Buffer =
Allocator.Allocate<uint8_t>(TotalLen);
295 io.mapRequired(
"Data", Binary);
296 if (!io.outputting()) {
299 Binary.writeAsBinary(
OS);
301 Data.assign(Str.begin(), Str.end());
306 IO.mapRequired(
"Parent", Symbol.Parent);
307 IO.mapRequired(
"End", Symbol.End);
308 IO.mapRequired(
"Next", Symbol.Next);
309 IO.mapRequired(
"Off", Symbol.Offset);
310 IO.mapRequired(
"Seg", Symbol.Segment);
311 IO.mapRequired(
"Len", Symbol.Length);
312 IO.mapRequired(
"Ordinal", Symbol.Thunk);
316 IO.mapRequired(
"Type", Symbol.Type);
317 IO.mapRequired(
"Size", Symbol.Size);
318 IO.mapRequired(
"ThunkOff", Symbol.ThunkOffset);
319 IO.mapRequired(
"TargetOff", Symbol.TargetOffset);
320 IO.mapRequired(
"ThunkSection", Symbol.ThunkSection);
321 IO.mapRequired(
"TargetSection", Symbol.TargetSection);
325 IO.mapRequired(
"SectionNumber", Symbol.SectionNumber);
326 IO.mapRequired(
"Alignment", Symbol.Alignment);
327 IO.mapRequired(
"Rva", Symbol.Rva);
328 IO.mapRequired(
"Length", Symbol.Length);
329 IO.mapRequired(
"Characteristics", Symbol.Characteristics);
330 IO.mapRequired(
"Name", Symbol.Name);
334 IO.mapRequired(
"Size", Symbol.Size);
335 IO.mapRequired(
"Characteristics", Symbol.Characteristics);
336 IO.mapRequired(
"Offset", Symbol.Offset);
337 IO.mapRequired(
"Segment", Symbol.Segment);
338 IO.mapRequired(
"Name", Symbol.Name);
342 IO.mapRequired(
"Ordinal", Symbol.Ordinal);
343 IO.mapRequired(
"Flags", Symbol.Flags);
344 IO.mapRequired(
"Name", Symbol.Name);
348 IO.mapOptional(
"PtrParent", Symbol.Parent, 0U);
349 IO.mapOptional(
"PtrEnd", Symbol.End, 0U);
350 IO.mapOptional(
"PtrNext", Symbol.Next, 0U);
351 IO.mapRequired(
"CodeSize", Symbol.CodeSize);
352 IO.mapRequired(
"DbgStart", Symbol.DbgStart);
353 IO.mapRequired(
"DbgEnd", Symbol.DbgEnd);
354 IO.mapRequired(
"FunctionType", Symbol.FunctionType);
355 IO.mapOptional(
"Offset", Symbol.CodeOffset, 0U);
356 IO.mapOptional(
"Segment", Symbol.Segment,
uint16_t(0));
357 IO.mapRequired(
"Flags", Symbol.Flags);
358 IO.mapRequired(
"DisplayName", Symbol.Name);
362 IO.mapRequired(
"Type", Symbol.Index);
363 IO.mapRequired(
"Seg", Symbol.Register);
364 IO.mapRequired(
"Name", Symbol.Name);
368 IO.mapRequired(
"Flags", Symbol.Flags);
369 IO.mapOptional(
"Offset", Symbol.Offset, 0U);
370 IO.mapOptional(
"Segment", Symbol.Segment,
uint16_t(0));
371 IO.mapRequired(
"Name", Symbol.Name);
375 IO.mapRequired(
"SumName", Symbol.SumName);
376 IO.mapRequired(
"SymOffset", Symbol.SymOffset);
377 IO.mapRequired(
"Mod", Symbol.Module);
378 IO.mapRequired(
"Name", Symbol.Name);
382 IO.mapRequired(
"Entries", Symbol.Fields);
386 IO.mapOptional(
"PtrParent", Symbol.Parent, 0U);
387 IO.mapOptional(
"PtrEnd", Symbol.End, 0U);
388 IO.mapRequired(
"Inlinee", Symbol.Inlinee);
393 IO.mapRequired(
"Type", Symbol.Type);
394 IO.mapRequired(
"Flags", Symbol.Flags);
396 IO.mapRequired(
"VarName", Symbol.Name);
400 IO.mapRequired(
"Program", Symbol.Program);
401 IO.mapRequired(
"Range", Symbol.Range);
402 IO.mapRequired(
"Gaps", Symbol.Gaps);
406 IO.mapRequired(
"Program", Symbol.Program);
407 IO.mapRequired(
"OffsetInParent", Symbol.OffsetInParent);
408 IO.mapRequired(
"Range", Symbol.Range);
409 IO.mapRequired(
"Gaps", Symbol.Gaps);
413 IO.mapRequired(
"Register", Symbol.Hdr.Register);
414 IO.mapRequired(
"MayHaveNoName", Symbol.Hdr.MayHaveNoName);
415 IO.mapRequired(
"Range", Symbol.Range);
416 IO.mapRequired(
"Gaps", Symbol.Gaps);
420 IO.mapRequired(
"Offset", Symbol.Hdr.Offset);
421 IO.mapRequired(
"Range", Symbol.Range);
422 IO.mapRequired(
"Gaps", Symbol.Gaps);
426 IO.mapRequired(
"Register", Symbol.Hdr.Register);
427 IO.mapRequired(
"MayHaveNoName", Symbol.Hdr.MayHaveNoName);
428 IO.mapRequired(
"OffsetInParent", Symbol.Hdr.OffsetInParent);
429 IO.mapRequired(
"Range", Symbol.Range);
430 IO.mapRequired(
"Gaps", Symbol.Gaps);
435 IO.mapRequired(
"Register", Symbol.Offset);
439 IO.mapRequired(
"Register", Symbol.Hdr.Register);
440 IO.mapRequired(
"Flags", Symbol.Hdr.Flags);
441 IO.mapRequired(
"BasePointerOffset", Symbol.Hdr.BasePointerOffset);
442 IO.mapRequired(
"Range", Symbol.Range);
443 IO.mapRequired(
"Gaps", Symbol.Gaps);
447 IO.mapOptional(
"PtrParent", Symbol.Parent, 0U);
448 IO.mapOptional(
"PtrEnd", Symbol.End, 0U);
449 IO.mapRequired(
"CodeSize", Symbol.CodeSize);
450 IO.mapOptional(
"Offset", Symbol.CodeOffset, 0U);
451 IO.mapOptional(
"Segment", Symbol.Segment,
uint16_t(0));
452 IO.mapRequired(
"BlockName", Symbol.Name);
456 IO.mapOptional(
"Offset", Symbol.CodeOffset, 0U);
457 IO.mapOptional(
"Segment", Symbol.Segment,
uint16_t(0));
458 IO.mapRequired(
"Flags", Symbol.Flags);
459 IO.mapRequired(
"Flags", Symbol.Flags);
460 IO.mapRequired(
"DisplayName", Symbol.Name);
464 IO.mapRequired(
"Signature", Symbol.Signature);
465 IO.mapRequired(
"ObjectName", Symbol.Name);
469 IO.mapRequired(
"Flags", Symbol.Flags);
470 IO.mapRequired(
"Machine", Symbol.Machine);
471 IO.mapRequired(
"FrontendMajor", Symbol.VersionFrontendMajor);
472 IO.mapRequired(
"FrontendMinor", Symbol.VersionFrontendMinor);
473 IO.mapRequired(
"FrontendBuild", Symbol.VersionFrontendBuild);
474 IO.mapRequired(
"BackendMajor", Symbol.VersionBackendMajor);
475 IO.mapRequired(
"BackendMinor", Symbol.VersionBackendMinor);
476 IO.mapRequired(
"BackendBuild", Symbol.VersionBackendBuild);
477 IO.mapRequired(
"Version", Symbol.Version);
481 IO.mapRequired(
"Flags", Symbol.Flags);
482 IO.mapRequired(
"Machine", Symbol.Machine);
483 IO.mapRequired(
"FrontendMajor", Symbol.VersionFrontendMajor);
484 IO.mapRequired(
"FrontendMinor", Symbol.VersionFrontendMinor);
485 IO.mapRequired(
"FrontendBuild", Symbol.VersionFrontendBuild);
486 IO.mapRequired(
"FrontendQFE", Symbol.VersionFrontendQFE);
487 IO.mapRequired(
"BackendMajor", Symbol.VersionBackendMajor);
488 IO.mapRequired(
"BackendMinor", Symbol.VersionBackendMinor);
489 IO.mapRequired(
"BackendBuild", Symbol.VersionBackendBuild);
490 IO.mapRequired(
"BackendQFE", Symbol.VersionBackendQFE);
491 IO.mapRequired(
"Version", Symbol.Version);
495 IO.mapRequired(
"TotalFrameBytes", Symbol.TotalFrameBytes);
496 IO.mapRequired(
"PaddingFrameBytes", Symbol.PaddingFrameBytes);
497 IO.mapRequired(
"OffsetToPadding", Symbol.OffsetToPadding);
498 IO.mapRequired(
"BytesOfCalleeSavedRegisters",
499 Symbol.BytesOfCalleeSavedRegisters);
500 IO.mapRequired(
"OffsetOfExceptionHandler", Symbol.OffsetOfExceptionHandler);
501 IO.mapRequired(
"SectionIdOfExceptionHandler",
502 Symbol.SectionIdOfExceptionHandler);
503 IO.mapRequired(
"Flags", Symbol.Flags);
507 IO.mapOptional(
"Offset", Symbol.CodeOffset, 0U);
508 IO.mapOptional(
"Segment", Symbol.Segment,
uint16_t(0));
509 IO.mapRequired(
"Type", Symbol.Type);
513 IO.mapRequired(
"Index", Symbol.Index);
514 IO.mapRequired(
"ModFilenameOffset", Symbol.ModFilenameOffset);
515 IO.mapRequired(
"Flags", Symbol.Flags);
516 IO.mapRequired(
"Name", Symbol.Name);
520 IO.mapOptional(
"Offset", Symbol.CodeOffset, 0U);
521 IO.mapOptional(
"Segment", Symbol.Segment,
uint16_t(0));
522 IO.mapRequired(
"CallInstructionSize", Symbol.CallInstructionSize);
523 IO.mapRequired(
"Type", Symbol.Type);
527 IO.mapRequired(
"Register", Symbol.Register);
528 IO.mapRequired(
"CookieKind", Symbol.CookieKind);
529 IO.mapRequired(
"Flags", Symbol.Flags);
533 IO.mapRequired(
"FuncID", Symbol.Indices);
537 IO.mapRequired(
"Type", Symbol.Type);
538 IO.mapRequired(
"UDTName", Symbol.Name);
542 IO.mapRequired(
"BuildId", Symbol.BuildId);
546 IO.mapRequired(
"Offset", Symbol.Offset);
547 IO.mapRequired(
"Type", Symbol.Type);
548 IO.mapRequired(
"VarName", Symbol.Name);
552 IO.mapRequired(
"Offset", Symbol.Offset);
553 IO.mapRequired(
"Type", Symbol.Type);
554 IO.mapRequired(
"Register", Symbol.Register);
555 IO.mapRequired(
"VarName", Symbol.Name);
559 IO.mapRequired(
"Type", Symbol.Type);
560 IO.mapRequired(
"Value", Symbol.Value);
561 IO.mapRequired(
"Name", Symbol.Name);
565 IO.mapRequired(
"Type", Symbol.Type);
566 IO.mapOptional(
"Offset", Symbol.DataOffset, 0U);
567 IO.mapOptional(
"Segment", Symbol.Segment,
uint16_t(0));
568 IO.mapRequired(
"DisplayName", Symbol.Name);
572 IO.mapRequired(
"Type", Symbol.Type);
573 IO.mapOptional(
"Offset", Symbol.DataOffset, 0U);
574 IO.mapOptional(
"Segment", Symbol.Segment,
uint16_t(0));
575 IO.mapRequired(
"DisplayName", Symbol.Name);
579 IO.mapRequired(
"Namespace", Symbol.Name);
583 IO.mapOptional(
"Offset", Symbol.CodeOffset, 0U);
584 IO.mapOptional(
"Segment", Symbol.Segment,
uint16_t(0));
585 IO.mapRequired(
"Strings", Symbol.Strings);
607template <
typename SymbolType>
612 auto Impl = std::make_shared<SymbolType>(Symbol.kind());
613 if (
auto EC = Impl->fromCodeViewSymbol(Symbol))
614 return std::move(
EC);
615 Result.Symbol = Impl;
621#define SYMBOL_RECORD(EnumName, EnumVal, ClassName) \
623 return fromCodeViewSymbolImpl<SymbolRecordImpl<ClassName>>(Symbol);
624#define SYMBOL_RECORD_ALIAS(EnumName, EnumVal, AliasName, ClassName) \
625 SYMBOL_RECORD(EnumName, EnumVal, ClassName)
626 switch (Symbol.kind()) {
627#include "llvm/DebugInfo/CodeView/CodeViewSymbols.def"
629 return fromCodeViewSymbolImpl<UnknownSymbolRecord>(Symbol);
631 return make_error<CodeViewError>(cv_error_code::corrupt_record);
634template <
typename ConcreteType>
637 if (!IO.outputting())
638 Obj.
Symbol = std::make_shared<ConcreteType>(Kind);
640 IO.mapRequired(Class, *Obj.
Symbol);
648 IO.mapRequired(
"Kind", Kind);
650#define SYMBOL_RECORD(EnumName, EnumVal, ClassName) \
652 mapSymbolRecordImpl<SymbolRecordImpl<ClassName>>(IO, #ClassName, Kind, \
655#define SYMBOL_RECORD_ALIAS(EnumName, EnumVal, AliasName, ClassName) \
656 SYMBOL_RECORD(EnumName, EnumVal, ClassName)
658#include "llvm/DebugInfo/CodeView/CodeViewSymbols.def"
660 mapSymbolRecordImpl<UnknownSymbolRecord>(IO,
"UnknownSym", Kind, Obj);
This file defines the BumpPtrAllocator interface.
static GCRegistry::Add< CoreCLRGC > E("coreclr", "CoreCLR-compatible GC")
static void mapSymbolRecordImpl(IO &IO, const char *Class, SymbolKind Kind, CodeViewYAML::SymbolRecord &Obj)
static Expected< CodeViewYAML::SymbolRecord > fromCodeViewSymbolImpl(CVSymbol Symbol)
assert(ImpDefSCC.getReg()==AMDGPU::SCC &&ImpDefSCC.isDef())
#define LLVM_YAML_DECLARE_BITSET_TRAITS(Type)
#define LLVM_YAML_IS_SEQUENCE_VECTOR(type)
#define LLVM_YAML_DECLARE_SCALAR_TRAITS(Type, MustQuote)
#define LLVM_YAML_IS_FLOW_SEQUENCE_VECTOR(type)
#define LLVM_YAML_STRONG_TYPEDEF(_base, _type)
#define LLVM_YAML_DECLARE_ENUM_TRAITS(Type)
An arbitrary precision integer that knows its signedness.
ArrayRef - Represent a constant reference to an array (0 or more elements consecutively in memory),...
ArrayRef< T > drop_front(size_t N=1) const
Drop the first N elements of the array.
Allocate memory in an ever growing pool, as if by bump-pointer.
Lightweight error class with error context and mandatory checking.
static ErrorSuccess success()
Create a success value.
Tagged union holding either a T or a Error.
StringRef - Represent a constant reference to a string, i.e.
The instances of the Type class are immutable: once they are created, they are never changed.
LLVM Value Representation.
CVRecord is a fat pointer (base + size pair) to a symbol or type record.
ArrayRef< uint8_t > RecordData
static CVSymbol writeOneSymbol(SymType &Sym, BumpPtrAllocator &Storage, CodeViewContainer Container)
This class implements an extremely fast bulk output stream that can only output to a stream.
A raw_ostream that writes to an std::string.
Specialized YAMLIO scalar type for representing a binary blob.
@ IMAGE_FILE_MACHINE_ARM64
@ IMAGE_FILE_MACHINE_AMD64
@ IMAGE_FILE_MACHINE_ARM64EC
@ IMAGE_FILE_MACHINE_I386
@ IMAGE_FILE_MACHINE_ARMNT
Reg
All possible values of the reg field in the ModR/M byte.
ProcSymFlags
Corresponds to the CV_PROCFLAGS bitfield.
LocalSymFlags
Corresponds to CV_LVARFLAGS bitfield.
CompileSym2Flags
Corresponds to COMPILESYM2::Flags bitfield.
CPUType
These values correspond to the CV_CPU_TYPE_e enumeration, and are documented here: https://msdn....
CompileSym3Flags
Corresponds to COMPILESYM3::Flags bitfield.
ArrayRef< EnumEntry< uint32_t > > getCompileSym2FlagNames()
ArrayRef< EnumEntry< uint16_t > > getExportSymFlagNames()
SymbolRecordKind
Distinguishes individual records in the Symbols subsection of a .debug$S section.
ArrayRef< EnumEntry< SymbolKind > > getSymbolTypeNames()
ThunkOrdinal
These values correspond to the THUNK_ORDINAL enumeration.
ArrayRef< EnumEntry< uint16_t > > getLocalFlagNames()
ArrayRef< EnumEntry< uint16_t > > getRegisterNames(CPUType Cpu)
ArrayRef< EnumEntry< uint8_t > > getThunkOrdinalNames()
ArrayRef< EnumEntry< uint8_t > > getProcSymFlagNames()
SymbolKind
Duplicate copy of the above enum, but using the official CV names.
ArrayRef< EnumEntry< unsigned > > getCPUTypeNames()
CVRecord< SymbolKind > CVSymbol
ArrayRef< EnumEntry< uint32_t > > getFrameProcSymFlagNames()
ArrayRef< EnumEntry< uint16_t > > getTrampolineNames()
PublicSymFlags
Corresponds to the CV_PUBSYMFLAGS bitfield.
ArrayRef< EnumEntry< uint32_t > > getPublicSymFlagNames()
ArrayRef< EnumEntry< uint32_t > > getCompileSym3FlagNames()
ArrayRef< EnumEntry< uint8_t > > getFrameCookieKindNames()
This is an optimization pass for GlobalISel generic memory operations.
codeview::CVSymbol toCodeViewSymbol(BumpPtrAllocator &Allocator, codeview::CodeViewContainer Container) const
std::shared_ptr< detail::SymbolRecordBase > Symbol
static Expected< SymbolRecord > fromCodeViewSymbol(codeview::CVSymbol Symbol)
SymbolRecordBase(codeview::SymbolKind K)
codeview::SymbolKind Kind
virtual void map(yaml::IO &io)=0
virtual codeview::CVSymbol toCodeViewSymbol(BumpPtrAllocator &Allocator, CodeViewContainer Container) const =0
virtual ~SymbolRecordBase()=default
virtual Error fromCodeViewSymbol(codeview::CVSymbol Type)=0
codeview::CVSymbol toCodeViewSymbol(BumpPtrAllocator &Allocator, CodeViewContainer Container) const override
void map(yaml::IO &io) override
Error fromCodeViewSymbol(codeview::CVSymbol CVS) override
SymbolRecordImpl(codeview::SymbolKind K)
std::vector< uint8_t > Data
Error fromCodeViewSymbol(CVSymbol CVS) override
void map(yaml::IO &io) override
UnknownSymbolRecord(codeview::SymbolKind K)
CVSymbol toCodeViewSymbol(BumpPtrAllocator &Allocator, CodeViewContainer Container) const override
static void mapping(IO &io, LocalVariableAddrGap &Gap)
static void mapping(IO &io, LocalVariableAddrRange &Range)
static void mapping(IO &io, SymbolRecordBase &Record)