1 //===- CodeView.h -----------------------------------------------*- C++ -*-===//
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-exception
7 //===----------------------------------------------------------------------===//
9 // Defines constants and basic types describing CodeView debug information.
11 //===----------------------------------------------------------------------===//
13 #ifndef LLVM_DEBUGINFO_CODEVIEW_CODEVIEW_H
14 #define LLVM_DEBUGINFO_CODEVIEW_CODEVIEW_H
17 #include <type_traits>
19 #include "llvm/Support/Endian.h"
24 /// Distinguishes individual records in .debug$T or .debug$P section or PDB type
25 /// stream. The documentation and headers talk about this as the "leaf" type.
26 enum class TypeRecordKind
: uint16_t {
27 #define TYPE_RECORD(lf_ename, value, name) name = value,
28 #include "CodeViewTypes.def"
31 /// Duplicate copy of the above enum, but using the official CV names. Useful
32 /// for reference purposes and when dealing with unknown record types.
33 enum TypeLeafKind
: uint16_t {
34 #define CV_TYPE(name, val) name = val,
35 #include "CodeViewTypes.def"
38 /// Distinguishes individual records in the Symbols subsection of a .debug$S
39 /// section. Equivalent to SYM_ENUM_e in cvinfo.h.
40 enum class SymbolRecordKind
: uint16_t {
41 #define SYMBOL_RECORD(lf_ename, value, name) name = value,
42 #include "CodeViewSymbols.def"
45 /// Duplicate copy of the above enum, but using the official CV names. Useful
46 /// for reference purposes and when dealing with unknown record types.
47 enum SymbolKind
: uint16_t {
48 #define CV_SYMBOL(name, val) name = val,
49 #include "CodeViewSymbols.def"
52 #define CV_DEFINE_ENUM_CLASS_FLAGS_OPERATORS(Class) \
53 inline Class operator|(Class a, Class b) { \
54 return static_cast<Class>( \
55 static_cast<std::underlying_type<Class>::type>(a) | \
56 static_cast<std::underlying_type<Class>::type>(b)); \
58 inline Class operator&(Class a, Class b) { \
59 return static_cast<Class>( \
60 static_cast<std::underlying_type<Class>::type>(a) & \
61 static_cast<std::underlying_type<Class>::type>(b)); \
63 inline Class operator~(Class a) { \
64 return static_cast<Class>( \
65 ~static_cast<std::underlying_type<Class>::type>(a)); \
67 inline Class &operator|=(Class &a, Class b) { \
71 inline Class &operator&=(Class &a, Class b) { \
76 /// These values correspond to the CV_CPU_TYPE_e enumeration, and are documented
77 /// here: https://msdn.microsoft.com/en-us/library/b2fc64ek.aspx
78 enum class CPUType
: uint16_t {
138 D3D11_Shader
= 0x100,
141 /// These values correspond to the CV_CFL_LANG enumeration, and are documented
142 /// here: https://msdn.microsoft.com/en-us/library/bw3aekw6.aspx
143 enum SourceLanguage
: uint8_t {
162 /// The DMD compiler emits 'D' for the CV source language. Microsoft doesn't
163 /// have an enumerator for it yet.
167 /// These values correspond to the CV_call_e enumeration, and are documented
168 /// at the following locations:
169 /// https://msdn.microsoft.com/en-us/library/b2fc64ek.aspx
170 /// https://msdn.microsoft.com/en-us/library/windows/desktop/ms680207(v=vs.85).aspx
172 enum class CallingConvention
: uint8_t {
173 NearC
= 0x00, // near right to left push, caller pops stack
174 FarC
= 0x01, // far right to left push, caller pops stack
175 NearPascal
= 0x02, // near left to right push, callee pops stack
176 FarPascal
= 0x03, // far left to right push, callee pops stack
177 NearFast
= 0x04, // near left to right push with regs, callee pops stack
178 FarFast
= 0x05, // far left to right push with regs, callee pops stack
179 NearStdCall
= 0x07, // near standard call
180 FarStdCall
= 0x08, // far standard call
181 NearSysCall
= 0x09, // near sys call
182 FarSysCall
= 0x0a, // far sys call
183 ThisCall
= 0x0b, // this call (this passed in register)
184 MipsCall
= 0x0c, // Mips call
185 Generic
= 0x0d, // Generic call sequence
186 AlphaCall
= 0x0e, // Alpha call
187 PpcCall
= 0x0f, // PPC call
188 SHCall
= 0x10, // Hitachi SuperH call
189 ArmCall
= 0x11, // ARM call
190 AM33Call
= 0x12, // AM33 call
191 TriCall
= 0x13, // TriCore Call
192 SH5Call
= 0x14, // Hitachi SuperH-5 call
193 M32RCall
= 0x15, // M32R Call
194 ClrCall
= 0x16, // clr call
196 0x17, // Marker for routines always inlined and thus lacking a convention
197 NearVector
= 0x18 // near left to right push with regs, callee pops stack
200 enum class ClassOptions
: uint16_t {
203 HasConstructorOrDestructor
= 0x0002,
204 HasOverloadedOperator
= 0x0004,
206 ContainsNestedClass
= 0x0010,
207 HasOverloadedAssignmentOperator
= 0x0020,
208 HasConversionOperator
= 0x0040,
209 ForwardReference
= 0x0080,
211 HasUniqueName
= 0x0200,
215 CV_DEFINE_ENUM_CLASS_FLAGS_OPERATORS(ClassOptions
)
217 enum class FrameProcedureOptions
: uint32_t {
219 HasAlloca
= 0x00000001,
220 HasSetJmp
= 0x00000002,
221 HasLongJmp
= 0x00000004,
222 HasInlineAssembly
= 0x00000008,
223 HasExceptionHandling
= 0x00000010,
224 MarkedInline
= 0x00000020,
225 HasStructuredExceptionHandling
= 0x00000040,
227 SecurityChecks
= 0x00000100,
228 AsynchronousExceptionHandling
= 0x00000200,
229 NoStackOrderingForSecurityChecks
= 0x00000400,
230 Inlined
= 0x00000800,
231 StrictSecurityChecks
= 0x00001000,
232 SafeBuffers
= 0x00002000,
233 EncodedLocalBasePointerMask
= 0x0000C000,
234 EncodedParamBasePointerMask
= 0x00030000,
235 ProfileGuidedOptimization
= 0x00040000,
236 ValidProfileCounts
= 0x00080000,
237 OptimizedForSpeed
= 0x00100000,
238 GuardCfg
= 0x00200000,
239 GuardCfw
= 0x00400000
241 CV_DEFINE_ENUM_CLASS_FLAGS_OPERATORS(FrameProcedureOptions
)
243 enum class FunctionOptions
: uint8_t {
247 ConstructorWithVirtualBases
= 0x04
249 CV_DEFINE_ENUM_CLASS_FLAGS_OPERATORS(FunctionOptions
)
251 enum class HfaKind
: uint8_t {
258 /// Source-level access specifier. (CV_access_e)
259 enum class MemberAccess
: uint8_t {
266 /// Part of member attribute flags. (CV_methodprop_e)
267 enum class MethodKind
: uint8_t {
272 IntroducingVirtual
= 0x04,
274 PureIntroducingVirtual
= 0x06
277 /// Equivalent to CV_fldattr_t bitfield.
278 enum class MethodOptions
: uint16_t {
281 MethodKindMask
= 0x001c,
284 NoConstruct
= 0x0080,
285 CompilerGenerated
= 0x0100,
288 CV_DEFINE_ENUM_CLASS_FLAGS_OPERATORS(MethodOptions
)
290 /// Equivalent to CV_LABEL_TYPE_e.
291 enum class LabelType
: uint16_t {
296 /// Equivalent to CV_modifier_t.
297 /// TODO: Add flag for _Atomic modifier
298 enum class ModifierOptions
: uint16_t {
304 CV_DEFINE_ENUM_CLASS_FLAGS_OPERATORS(ModifierOptions
)
306 enum class DebugSubsectionKind
: uint32_t {
311 FileChecksums
= 0xf4,
314 CrossScopeImports
= 0xf7,
315 CrossScopeExports
= 0xf8,
317 // These appear to relate to .Net assembly info.
319 FuncMDTokenMap
= 0xfa,
320 TypeMDTokenMap
= 0xfb,
321 MergedAssemblyInput
= 0xfc,
323 CoffSymbolRVA
= 0xfd,
326 /// Equivalent to CV_ptrtype_e.
327 enum class PointerKind
: uint8_t {
328 Near16
= 0x00, // 16 bit pointer
329 Far16
= 0x01, // 16:16 far pointer
330 Huge16
= 0x02, // 16:16 huge pointer
331 BasedOnSegment
= 0x03, // based on segment
332 BasedOnValue
= 0x04, // based on value of base
333 BasedOnSegmentValue
= 0x05, // based on segment value of base
334 BasedOnAddress
= 0x06, // based on address of base
335 BasedOnSegmentAddress
= 0x07, // based on segment address of base
336 BasedOnType
= 0x08, // based on type
337 BasedOnSelf
= 0x09, // based on self
338 Near32
= 0x0a, // 32 bit pointer
339 Far32
= 0x0b, // 16:32 pointer
340 Near64
= 0x0c // 64 bit pointer
343 /// Equivalent to CV_ptrmode_e.
344 enum class PointerMode
: uint8_t {
345 Pointer
= 0x00, // "normal" pointer
346 LValueReference
= 0x01, // "old" reference
347 PointerToDataMember
= 0x02, // pointer to data member
348 PointerToMemberFunction
= 0x03, // pointer to member function
349 RValueReference
= 0x04 // r-value reference
352 /// Equivalent to misc lfPointerAttr bitfields.
353 enum class PointerOptions
: uint32_t {
356 Volatile
= 0x00000200,
358 Unaligned
= 0x00000800,
359 Restrict
= 0x00001000,
360 WinRTSmartPointer
= 0x00080000,
361 LValueRefThisPointer
= 0x00100000,
362 RValueRefThisPointer
= 0x00200000
364 CV_DEFINE_ENUM_CLASS_FLAGS_OPERATORS(PointerOptions
)
366 /// Equivalent to CV_pmtype_e.
367 enum class PointerToMemberRepresentation
: uint16_t {
368 Unknown
= 0x00, // not specified (pre VC8)
369 SingleInheritanceData
= 0x01, // member data, single inheritance
370 MultipleInheritanceData
= 0x02, // member data, multiple inheritance
371 VirtualInheritanceData
= 0x03, // member data, virtual inheritance
372 GeneralData
= 0x04, // member data, most general
373 SingleInheritanceFunction
= 0x05, // member function, single inheritance
374 MultipleInheritanceFunction
= 0x06, // member function, multiple inheritance
375 VirtualInheritanceFunction
= 0x07, // member function, virtual inheritance
376 GeneralFunction
= 0x08 // member function, most general
379 enum class VFTableSlotKind
: uint8_t {
389 enum class WindowsRTClassKind
: uint8_t {
396 /// Corresponds to CV_LVARFLAGS bitfield.
397 enum class LocalSymFlags
: uint16_t {
399 IsParameter
= 1 << 0,
400 IsAddressTaken
= 1 << 1,
401 IsCompilerGenerated
= 1 << 2,
402 IsAggregate
= 1 << 3,
403 IsAggregated
= 1 << 4,
406 IsReturnValue
= 1 << 7,
407 IsOptimizedOut
= 1 << 8,
408 IsEnregisteredGlobal
= 1 << 9,
409 IsEnregisteredStatic
= 1 << 10,
411 CV_DEFINE_ENUM_CLASS_FLAGS_OPERATORS(LocalSymFlags
)
413 /// Corresponds to the CV_PUBSYMFLAGS bitfield.
414 enum class PublicSymFlags
: uint32_t {
421 CV_DEFINE_ENUM_CLASS_FLAGS_OPERATORS(PublicSymFlags
)
423 /// Corresponds to the CV_PROCFLAGS bitfield.
424 enum class ProcSymFlags
: uint8_t {
430 IsUnreachable
= 1 << 4,
431 HasCustomCallingConv
= 1 << 5,
433 HasOptimizedDebugInfo
= 1 << 7,
435 CV_DEFINE_ENUM_CLASS_FLAGS_OPERATORS(ProcSymFlags
)
437 /// Corresponds to COMPILESYM2::Flags bitfield.
438 enum class CompileSym2Flags
: uint32_t {
440 SourceLanguageMask
= 0xFF,
444 NoDataAlign
= 1 << 11,
445 ManagedPresent
= 1 << 12,
446 SecurityChecks
= 1 << 13,
449 MSILModule
= 1 << 16,
451 CV_DEFINE_ENUM_CLASS_FLAGS_OPERATORS(CompileSym2Flags
)
453 /// Corresponds to COMPILESYM3::Flags bitfield.
454 enum class CompileSym3Flags
: uint32_t {
456 SourceLanguageMask
= 0xFF,
460 NoDataAlign
= 1 << 11,
461 ManagedPresent
= 1 << 12,
462 SecurityChecks
= 1 << 13,
465 MSILModule
= 1 << 16,
470 CV_DEFINE_ENUM_CLASS_FLAGS_OPERATORS(CompileSym3Flags
)
472 enum class ExportFlags
: uint16_t {
478 HasExplicitOrdinal
= 1 << 4,
481 CV_DEFINE_ENUM_CLASS_FLAGS_OPERATORS(ExportFlags
)
483 // Corresponds to BinaryAnnotationOpcode enum.
484 enum class BinaryAnnotationsOpCode
: uint32_t {
487 ChangeCodeOffsetBase
,
495 ChangeColumnEndDelta
,
496 ChangeCodeOffsetAndLineOffset
,
497 ChangeCodeLengthAndCodeOffset
,
501 // Corresponds to CV_cookietype_e enum.
502 enum class FrameCookieKind
: uint8_t {
509 // Corresponds to CV_HREG_e enum.
510 enum class RegisterId
: uint16_t {
511 #define CV_REGISTER(name, value) name = value,
512 #include "CodeViewRegisters.def"
516 /// Two-bit value indicating which register is the designated frame pointer
517 /// register. Appears in the S_FRAMEPROC record flags.
518 enum class EncodedFramePtrReg
: uint8_t {
525 RegisterId
decodeFramePtrReg(EncodedFramePtrReg EncodedReg
, CPUType CPU
);
527 EncodedFramePtrReg
encodeFramePtrReg(RegisterId Reg
, CPUType CPU
);
529 /// These values correspond to the THUNK_ORDINAL enumeration.
530 enum class ThunkOrdinal
: uint8_t {
540 enum class TrampolineType
: uint16_t { TrampIncremental
, BranchIsland
};
542 // These values correspond to the CV_SourceChksum_t enumeration.
543 enum class FileChecksumKind
: uint8_t { None
, MD5
, SHA1
, SHA256
};
545 enum LineFlags
: uint16_t {
547 LF_HaveColumns
= 1, // CV_LINES_HAVE_COLUMNS
550 /// Data in the SUBSEC_FRAMEDATA subection.
552 support::ulittle32_t RvaStart
;
553 support::ulittle32_t CodeSize
;
554 support::ulittle32_t LocalSize
;
555 support::ulittle32_t ParamsSize
;
556 support::ulittle32_t MaxStackSize
;
557 support::ulittle32_t FrameFunc
;
558 support::ulittle16_t PrologSize
;
559 support::ulittle16_t SavedRegsSize
;
560 support::ulittle32_t Flags
;
564 IsFunctionStart
= 1 << 2,
568 // Corresponds to LocalIdAndGlobalIdPair structure.
569 // This structure information allows cross-referencing between PDBs. For
570 // example, when a PDB is being built during compilation it is not yet known
571 // what other modules may end up in the PDB at link time. So certain types of
572 // IDs may clash between the various compile time PDBs. For each affected
573 // module, a subsection would be put into the PDB containing a mapping from its
574 // local IDs to a single ID namespace for all items in the PDB file.
575 struct CrossModuleExport
{
576 support::ulittle32_t Local
;
577 support::ulittle32_t Global
;
580 struct CrossModuleImport
{
581 support::ulittle32_t ModuleNameOffset
;
582 support::ulittle32_t Count
; // Number of elements
583 // support::ulittle32_t ids[Count]; // id from referenced module
586 enum class CodeViewContainer
{ ObjectFile
, Pdb
};
588 inline uint32_t alignOf(CodeViewContainer Container
) {
589 if (Container
== CodeViewContainer::ObjectFile
)