CodeView debug‐info types, records, and type/symbol stream builders.
Types
Name |
Description |
Code annotation symbol (S_ANNOTATION). |
|
Builds a CodeView type table by appending records without merging duplicates. |
|
LF_ARGLIST record listing the parameter types of a function. |
|
LF_ARRAY record describing an array type. |
|
BP‐relative local variable symbol (S_BPREL32). |
|
LF_BCLASS or LF_BINTERFACE record describing a non‐virtual base class. |
|
Forward iterator over compressed inline‐site binary annotations. |
|
LF_BITFIELD record describing a bit‐field member type. |
|
Lexical block symbol (S_BLOCK32). |
|
LF_BUILDINFO record describing how a translation unit was built. |
|
Build information symbol (S_BUILDINFO). |
|
Pair of CPU type and register ID for CodeView register name lookup. |
|
A raw CodeView member record: leaf kind plus undecoded payload bytes. |
|
Fat pointer (base + size) to a CodeView symbol or type record. |
|
Dumper for CodeView symbol streams found in COFF object files and PDB files. |
|
Dispatches CodeView symbol records to a |
|
Indirect call site type information (S_CALLSITEINFO). |
|
Caller or callee list symbol (S_CALLERS / S_CALLEES / S_INLINEES). |
|
LF_CLASS, LF_STRUCTURE, or LF_INTERFACE record describing a class‐like type. |
|
Base class for errors originating when parsing raw PDB files |
|
Reads, writes, or streams CodeView records through a shared field‐mapping interface. |
|
Abstract interface for emitting CodeView record bytes to an assembly stream. |
|
COFF group symbol (S_COFFGROUP). |
|
Encoded start and end column numbers for a CodeView line entry. |
|
Optional start and end column numbers for a line entry ( |
|
Compile flags symbol version 2 (S_COMPILE2). |
|
Compile flags symbol version 3 (S_COMPILE3). |
|
Constant value symbol (S_CONSTANT or S_MANCONSTANT). |
|
Serializes field or method lists that may span multiple continuation records. |
|
Maps a module‐local ID to a PDB‐wide global ID. |
|
Header for a list of IDs imported from another module. |
|
One cross‐module import entry: a header plus the imported ID list. |
|
LF_MEMBER record describing a non‐static data member. |
|
Data symbol for global or local data (S_LDATA32, S_GDATA32, and managed variants). |
|
Writable CodeView FileChecksums debug subsection. |
|
Read‐only view of a CodeView FileChecksums debug subsection. |
|
Writable CodeView cross‐module exports subsection. |
|
Read‐only view of a CodeView cross‐module exports subsection. |
|
Writable CodeView cross‐module imports subsection. |
|
Read‐only view of a CodeView cross‐module imports subsection. |
|
Writable CodeView FrameData debug subsection. |
|
Read‐only view of a CodeView FrameData debug subsection. |
|
Discriminated union of CodeView debug‐directory payloads. |
|
Mutable builder for a CodeView InlineeLines debug subsection. |
|
Read‐only view of a CodeView InlineeLines debug subsection. |
|
Writable CodeView Lines debug subsection. |
|
Read‐only view of a CodeView Lines debug subsection. |
|
Writable CodeView string table debug subsection. |
|
Read‐only view of a CodeView string table. |
|
Writable base class for a CodeView debug subsection. |
|
On‐disk header for a CodeView debug subsection. |
|
A parsed CodeView debug subsection record (kind plus payload bytes). |
|
Builds a serialized CodeView debug subsection record for writing. |
|
Read‐only base class for a CodeView debug subsection view. |
|
Callback interface for walking CodeView debug subsections. |
|
Writable CodeView COFF symbol RVA debug subsection. |
|
Read‐only view of a CodeView COFF symbol RVA debug subsection. |
|
Writable CodeView Symbols debug subsection. |
|
Read‐only view of a CodeView Symbols debug subsection. |
|
Read‐only view of an unrecognized CodeView debug subsection. |
|
One decoded binary annotation opcode and its operands. |
|
Full‐scope frame‐pointer‐relative def‐range (S_DEFRANGE_FRAMEPOINTER_REL_FULL_SCOPE). |
|
Fixed header for an S_DEFRANGE_FRAMEPOINTER_REL symbol. |
|
Def‐range for a frame‐pointer‐relative local (S_DEFRANGE_FRAMEPOINTER_REL). |
|
Fixed header for an S_DEFRANGE_REGISTER symbol. |
|
Fixed header for an S_DEFRANGE_REGISTER_REL symbol. |
|
Fixed header for an S_DEFRANGE_REGISTER_REL_INDIR symbol. |
|
S_DEFRANGE_REGISTER_REL_INDIR |
|
Def‐range for a register‐relative local (S_DEFRANGE_REGISTER_REL). |
|
Def‐range for a local that lives in a register (S_DEFRANGE_REGISTER). |
|
Fixed header for an S_DEFRANGE_SUBFIELD_REGISTER symbol. |
|
Def‐range for a register‐held subfield (S_DEFRANGE_SUBFIELD_REGISTER). |
|
Def‐range for a subfield of a local, located via a DIA program (S_DEFRANGE_SUBFIELD). |
|
Generic def‐range symbol locating a local via a DIA program (S_DEFRANGE). |
|
LF_ENDPRECOMP record marking the end of a precompiled type stream. |
|
LF_ENUM record describing an enumeration type. |
|
LF_ENUMERATE record describing a single enumerator constant. |
|
Environment block of key/value string pairs (S_ENVBLOCK). |
|
Exported symbol (S_EXPORT). |
|
Deserializes CodeView field‐list member records from a binary stream. |
|
LF_FIELDLIST record holding the raw bytes of a class or enum field list. |
|
One source‐file checksum recorded in a CodeView FileChecksums subsection. |
|
File‐static variable symbol (S_FILESTATIC). |
|
Security cookie on the stack frame (S_FRAMECOOKIE). |
|
Data in the SUBSEC_FRAMEDATA subsection. |
|
Frame procedure details symbol (S_FRAMEPROC). |
|
LF_FUNC_ID record identifying a non‐member function by scope, type, and name. |
|
A 32‐bit CodeView function identifier. |
|
This represents the 'GUID' type from windows.h. |
|
Builds a CodeView type table that merges records by globally unique hash. |
|
A hash that uniquely identifies a type record across multiple type streams. |
|
Heap allocation site symbol (S_HEAPALLOCSITE). |
|
Hot‐patchable function symbol (S_HOTPATCHFUNC). |
|
Inline site symbol describing an inlined call (S_INLINESITE). |
|
One decoded InlineeLines entry: header plus optional extra file IDs. |
|
Fixed header for one inlinee source‐line entry. |
|
Jump table symbol describing a switch dispatch table (S_ARMSWITCHTABLE). |
|
LF_LABEL record describing a near or far code label. |
|
Label symbol (S_LABEL32). |
|
Provides amortized O(1) random access to a CodeView type stream. |
|
A CodeView line mapping from a code offset to source line and column info. |
|
Header for one file's line block within a Lines subsection ( |
|
One file block of line (and optional column) entries from a Lines subsection. |
|
Extracts |
|
Header for a CodeView Lines subsection fragment ( |
|
Encoded CodeView start/end line numbers and statement flag for a line entry. |
|
One source line mapping entry ( |
|
LF_INDEX ‐ Used to chain two large LF_FIELDLIST or LF_METHODLIST records together. The first will end in an LF_INDEX record that points to the next. |
|
Local variable symbol (S_LOCAL). |
|
Gap inside a local variable address range where the variable is not live. |
|
Contiguous address range where a local variable is live. |
|
A hash of a serialized type record for de‐duplication within one stream. |
|
Equvalent to CV_fldattr_t in cvinfo.h. |
|
LF_MFUNC_ID record identifying a member function by class, type, and name. |
|
LF_MFUNCTION record describing a member function type. |
|
Tail of an LF_POINTER record when the pointer is a pointer‐to‐member. |
|
Builds a CodeView type table that merges duplicate records by local hash. |
|
LF_METHODLIST record listing the overloads of a method name. |
|
LF_MODIFIER record describing a type with const/volatile/unaligned modifiers. |
|
LF_NESTTYPE record naming a nested type within a class. |
|
Object file name symbol (S_OBJNAME). |
|
LF_ONEMETHOD record describing a single method in a field list. |
|
For method overload sets. LF_METHOD |
|
Used to forward information about PCH.OBJ (precompiled) files, when applicable. |
|
PDB 2.0 (NB10) CodeView debug‐info payload. |
|
PDB 7.0 (RSDS) CodeView debug‐info payload. |
|
LF_POINTER record describing a pointer, reference, or pointer‐to‐member. |
|
LF_PRECOMP record referencing types from a precompiled header. |
|
Procedure reference symbol (S_PROCREF or S_LPROCREF). |
|
Procedure symbol for global or local functions. |
|
LF_PROCEDURE record describing a non‐member function type. |
|
32‐bit public symbol (S_PUB32). |
|
Fixed on‐disk header for an S_PUB32 public symbol. |
|
Two‐byte length and kind prefix shared by all CodeView records. |
|
S_REGREL32_INDIR |
|
Register‐relative local variable symbol (S_REGREL32). |
|
Register variable symbol (S_REGISTER). |
|
Scope end symbol that closes a prior scope‐opening record (S_END). |
|
COFF section contribution symbol (S_SECTION). |
|
Serializes non‐continuation CodeView leaf type records into a byte buffer. |
|
LF_STMEMBER record describing a static data member. |
|
LF_STRING_ID record binding a string to an optional ID type index. |
|
LF_SUBSTR_LIST record listing substring type indices. |
|
Owns shared string‐table and checksums subsections used when building CodeView debug info. |
|
Holds non‐owning references to CodeView string‐table and checksums subsections, discovering either from a fragment range when needed. |
|
Deserializes CodeView symbol records into structured |
|
Delegate for object‐file‐specific hooks used when dumping CodeView symbols. |
|
Base class for decoded CodeView symbol records. |
|
Maps CodeView symbol records between binary streams and structured types. |
|
Serializes CodeView symbol records via SymbolVisitorCallbacks. |
|
Pipelines multiple |
|
Callback interface invoked while visiting CodeView symbol records. |
|
Interface that supplies context while visiting CodeView symbol records. |
|
Shared base for LF_CLASS, LF_STRUCTURE, LF_INTERFACE, LF_UNION, and LF_ENUM. |
|
Thread‐local data symbol (S_LTHREAD32 or S_GTHREAD32). |
|
32‐bit thunk symbol (S_THUNK32). |
|
Contiguous run of TypeIndex values within a serialized CodeView record. |
|
Trampoline symbol describing a thunk that redirects to a target (S_TRAMPOLINE). |
|
Interface for a random‐access collection of CodeView type records. |
|
Deserializes CodeView type records via TypeVisitorCallbacks. |
|
Dumper for CodeView type streams found in COFF object files and PDB files. |
|
A 32‐bit CodeView type reference. |
|
Maps a TypeIndex to a byte offset for log(N) lookup in a type stream. |
|
Base class for decoded CodeView type records. |
|
Maps CodeView type and member records through a shared CodeViewRecordIO. |
|
LF_TYPESERVER2 record referencing an external type server PDB. |
|
Abstract interface for emitting CodeView user‐defined type symbols. |
|
A TypeCollection backed by a fixed table of serialized CodeView type records. |
|
Pipelines multiple TypeVisitorCallbacks, forwarding each visit in order. |
|
Callback interface invoked while visiting CodeView type records. |
|
User‐defined type symbol (S_UDT or S_COBOLUDT). |
|
LF_UDT_MOD_SRC_LINE record mapping a UDT to a module, source file, and line. |
|
LF_UDT_SRC_LINE record mapping a UDT to a source file and line. |
|
LF_UNION record describing a union type. |
|
Using‐namespace symbol (S_UNAMESPACE). |
|
LF_VFUNCTAB record describing a virtual function pointer member. |
|
LF_VFTABLE record describing a virtual function table. |
|
LF_VTSHAPE record describing the shape of a virtual function table. |
|
LF_VBCLASS or LF_IVBCLASS record describing a virtual base class. |
|
Helper that deserializes a fixed‐size array whose length comes from |
|
Helper that deserializes the remaining stream bytes as an array of |
|
Helper that optionally deserializes |
|
|
Helper that deserializes a sequence of null‐terminated strings. |
Helper that deserializes a numeric leaf into |
|
Helper that deserializes a trailing sequence of values into a vector. |
Type Aliases
Name |
Description |
CodeView symbol record view. |
|
Variable‐length array of CodeView symbol records. |
|
CodeView type record view. |
|
Variable‐length array of CodeView type records. |
|
Iterator range over a |
|
Array of variable‐length |
Enums
Name |
Description |
Flags that can be OR'd into a debug subsection kind. |
|
Limit on the size of all codeview symbol and type records, including the RecordPrefix. MSVC does not emit any records larger than this. |
|
Maximum length of a single def‐range address range. |
|
Binary annotation opcodes used in S_INLINESITE records. |
|
Target CPU type recorded in CodeView compile symbols (CV_CPU_TYPE_e). |
|
Calling convention for a procedure or member function (CV_call_e). |
|
Attribute flags for class, struct, union, and enum type records (CV_CLASS_e). |
|
Kind of CodeView container that holds records. |
|
Corresponds to COMPILESYM2::Flags bitfield. |
|
Corresponds to COMPILESYM3::Flags bitfield. |
|
Kind of large CodeView record that may need LF_INDEX continuation segments. |
|
Kind of a CodeView debug subsection in .debug$S (or PDB equivalents). |
|
Two‐bit value indicating which register is the designated frame pointer register. Appears in the S_FRAMEPROC record flags. |
|
Flags for an S_EXPORT symbol. |
|
These values correspond to the CV_SourceChksum_t enumeration. |
|
Kind of security cookie used in an S_FRAMECOOKIE record (CV_cookietype_e). |
|
Flags describing a procedure frame (S_FRAMEPROC). |
|
Options for function type records (LF_PROCEDURE / LF_MFUNCTION). |
|
Algorithm used to compute a globally unique type hash. |
|
Homogeneous floating‐point aggregate kind for ARM calling conventions. |
|
Signature values that introduce an InlineeLines subsection. |
|
Describes how jump‐table entries encode their target address. |
|
Equivalent to CV_LABEL_TYPE_e. |
|
Flags in the line‐number contribution header (CV_DebugSLinesHeader_t::Flags). |
|
Corresponds to CV_LVARFLAGS bitfield. |
|
Source‐level access specifier. (CV_access_e) |
|
Part of member attribute flags. (CV_methodprop_e) |
|
Equivalent to CV_fldattr_t bitfield. |
|
Equivalent to CV_modifier_t. TODO: Add flag for _Atomic modifier |
|
Equivalent to CV_ptrtype_e. |
|
Equivalent to CV_ptrmode_e. |
|
Equivalent to misc lfPointerAttr bitfields. |
|
Equivalent to CV_pmtype_e. |
|
Corresponds to the CV_PROCFLAGS bitfield. |
|
Corresponds to the CV_PUBSYMFLAGS bitfield. |
|
CodeView hardware register ID (CV_HREG_e). |
|
Built‐in CodeView simple type kinds encoded in the low byte of a simple TypeIndex. |
|
Pointer/indirection mode encoded with a simple TypeIndex kind. |
|
Source language recorded in a compile symbol (CV_CFL_LANG). |
|
Duplicate copy of the above enum, but using the official CV names. Useful for reference purposes and when dealing with unknown record types. |
|
Distinguishes individual records in the Symbols subsection of a .debug$S section. Equivalent to SYM_ENUM_e in cvinfo.h. |
|
Thunk kind ordinal (THUNK_ORDINAL). |
|
Kind of TypeIndex reference embedded in a CodeView record. |
|
Trampoline kind recorded in S_TRAMPOLINE symbols. |
|
Duplicate copy of the above enum, but using the official CV names. Useful for reference purposes and when dealing with unknown record types. |
|
Distinguishes individual records in .debug\$T or .debug\$P section or PDB type stream. The documentation and headers talk about this as the "leaf" type. |
|
Kind of virtual function table slot (CV_VTS_desc_e). |
|
How type or member record bytes are supplied during visitation. |
|
Windows Runtime class kind recorded in LF_STRUCTURE / related records. |
|
Error codes for failures while reading or writing CodeView records. |
Functions
Name |
Description |
Return the error category for |
|
Return the byte alignment required for CodeView records in |
|
Compute a human‐readable name for the type at |
|
|
|
Decode a numeric leaf value that is known to be a particular type. |
|
Decode a two‐bit |
|
|
|
|
|
Encode a frame‐pointer |
|
|
|
Invoke |
|
Reinterpret a byte array as a null‐terminated C string. |
|
Reinterpret a byte array as an array of characters. Does not interpret as a C string, as StringRef has several helpers (split) that make that easy. |
|
Return the enumerator name table for |
|
Return the enumerator name table for |
|
Return the enumerator name table for |
|
Return the enumerator name table for |
|
Return the enumerator name table for |
|
Return the enumerator name table for |
|
Return the enumerator name table for |
|
Return the enumerator name table for |
|
Return the enumerator name table for |
|
Return the enumerator name table for |
|
Return the enumerator name table for |
|
Return the enumerator name table for |
|
Return the enumerator name table for |
|
Return the enumerator name table for |
|
Return the enumerator name table for |
|
Return the enumerator name table for |
|
Return the enumerator name table for |
|
Given a CVType which is assumed to be an LF_MODIFIER, return the TypeIndex of the type that the LF_MODIFIER modifies. |
|
Return the enumerator name table for |
|
Return the enumerator name table for |
|
Return the enumerator name table for |
|
Return the enumerator name table for |
|
Return the enumerator name table for |
|
Return the enumerator name table for |
|
Return the enumerator name table for |
|
Given a symbol P for which symbolOpensScope(P) == true, return the corresponding end offset. |
|
Return the parent offset of a scope‐opening symbol. |
|
Given an arbitrary codeview type index, determine its size. |
|
Given an arbitrary codeview type, return the type's size in the case of aggregate (LF_STRUCTURE, LF_CLASS, LF_INTERFACE, LF_UNION). |
|
Return the enumerator name table for |
|
Extract the name string embedded in a CodeView symbol record. |
|
Return the enumerator name table for |
|
Return the enumerator name table for |
|
Return the enumerator name table for |
|
Return the enumerator name table for |
|
Return the enumerator name table for |
|
Given an arbitrary codeview type, determine if it is an LF_STRUCTURE, LF_CLASS, LF_INTERFACE, LF_UNION. |
|
Return true if this record should be in the IPI stream of a PDB. In an object file, these record kinds will appear mixed into the .debug$T section. |
|
Given an arbitrary codeview type, determine if it is an LF_STRUCTURE, LF_CLASS, LF_INTERFACE, LF_UNION, or LF_ENUM with the forward ref class option. |
|
Return the subarray of |
|
Convert a |
|
|
|
|
|
|
|
Bitwise conjunction operators |
|
Bitwise conjunction assignment operators |
|
Return a TypeIndex equal to |
|
Subtraction operators |
|
Bitwise disjunction operators |
|
Bitwise disjunction assignment operators |
|
Bitwise negation operators |
|
Print TypeIndex |
|
Read a complete record from a stream at a random offset. |
|
Read one CodeView symbol record from |
|
Build an array serialization helper whose length comes from |
|
|
|
Build a conditional serialization helper for |
|
|
Build a helper that deserializes a sequence of null‐terminated strings. |
Build a helper that deserializes a numeric leaf into |
|
Return true if this symbol ends a scope. |
|
Return true if this symbol opens a scope. |
|
Dispatch a single debug subsection record to the appropriate visitor method. |
|
|
|
|
|
Visit every member record in a field‐list byte stream. |
|
|
|
|
|
Stream a human‐readable representation of |
|
Equality operators |
|
Inequality operators |
|
Less‐than operators |
|
Less‐than‐or‐equal operators |
|
Greater‐than operators |
|
Greater‐than‐or‐equal operators |
Using Declarations
Name |
Description |
Little‐endian signed 32‐bit integer type. |
|
Little‐endian unsigned 16‐bit integer type. |
|
Little‐endian 32‐bit unsigned integer type from |
Created with MrDocs