[llvm] [Docs][CodeView] Document `S_LOCAL` and `S_DEFRANGE*` (PR #190156)
Alexandre Ganea via llvm-commits
llvm-commits at lists.llvm.org
Fri Jul 3 17:11:46 PDT 2026
================
@@ -184,27 +184,156 @@ S_ENVBLOCK (0x113d)
S_LOCAL (0x113e)
^^^^^^^^^^^^^^^^
+Defines a local variable.
+This record is followed by a series of ``S_DEFRANGE*`` records that define the
+live range of this variable.
+
+All ``S_DEFRANGE*`` records consist of a header followed by
+``LocalVariableAddrRange`` and a list of ``LocalVariableAddrGap`` (until the
+record length is reached).
+
+.. code:: cpp
+
+ /// A live range of a variable.
+ struct LocalVariableAddrRange {
+ /// Starting offset in the section
+ uint32_t OffsetStart;
+ /// Index of the section
+ uint16_t ISectStart;
+ /// Size of the range
+ uint16_t Range;
+ };
+ /// A subrange of a `LocalVariableAddrRange` where a variable is _not_ live.
+ struct LocalVariableAddrGap {
+ /// Start of the range, relative to `LocalVariableAddrRange::OffsetStart`
+ uint16_t GapStartOffset;
+ /// Size of the range
+ uint16_t Range;
+ };
+
+The following records only describe the header.
+
S_DEFRANGE (0x113f)
^^^^^^^^^^^^^^^^^^^
+.. code:: cpp
+
+ struct DefrangeSymHeader {
+ /// DIA program to evaluate the value of the symbol
+ uint32_t Program;
+ };
+
S_DEFRANGE_SUBFIELD (0x1140)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+A live range of sub field of variable (e.g. ``local.i``).
+
+.. code:: cpp
+
+ struct DefrangeSubfieldSymHeader {
+ /// DIA program to evaluate the value of the symbol
+ uint32_t Program;
+ /// Offset in parent variable.
+ uint32_t OffsetInParent;
+ };
+
S_DEFRANGE_REGISTER (0x1141)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+A live range of en-registed variable.
+
+.. code:: cpp
+
+ struct DefrangeRegisterSymHeader {
+ /// Register to hold the value of the symbol
+ uint16_t Register;
+ /// May have no user name on one of control flow path
+ uint16_t MayHaveNoName : 1;
+ uint16_t Padding : 15;
+ };
+
S_DEFRANGE_FRAMEPOINTER_REL (0x1142)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+A live range of frame variable. The register for the frame pointer is specified in ``S_FRAMEPROC``.
+
+.. code:: cpp
+
+ struct DefrangeFramepointerSymHeader {
+ /// Offset from the frame pointer
+ int32_t Offset;
+ };
+
S_DEFRANGE_SUBFIELD_REGISTER (0x1143)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+A live range of sub field of variable (e.g. ``local.i``).
+
+.. code:: cpp
+
+ struct DefrangeSubfieldSymHeader {
+ /// Register to hold the value of the symbol
+ uint16_t Register;
+ /// May have no user name on one of control flow path
+ uint16_t MayHaveNoName : 1;
+ uint16_t Padding1 : 15;
+ /// Offset in parent variable
+ uint32_t OffsetInParent : 12;
+ uint32_t Padding2 : 20;
+ };
+
S_DEFRANGE_FRAMEPOINTER_REL_FULL_SCOPE (0x1144)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+A frame variable valid in all function scope.
+
+.. code:: cpp
+
+ struct DefrangeFramepointerRelFullScopeSymHeader {
+ /// Offset from the frame pointer
+ int32_t Offset;
+ };
+
S_DEFRANGE_REGISTER_REL (0x1145)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+A live range of variable relative to a register (range version of ``S_REGREL32``).
+
+.. code:: cpp
+
+ struct DefrangeRegisterRelSymHeader {
+ /// Register to hold the base pointer of the symbol
+ uint16_t Register;
+ /// Spilled member for s.i
+ uint16_t SpilledUdtMember : 1;
+ uint16_t Padding : 3;
+ /// Offset in parent variable.
+ uint16_t OffsetInParent : 12;
+ /// Offset to register
+ int32_t BasePointerOffset;
+ };
+
+S_DEFRANGE_REGISTER_REL_INDIR (0x1177)
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+A live range of variable indirectly relative to a register (range version of ``S_REGREL32_INDIR``).
+
+.. code:: cpp
+
+ struct DefrangeRegisterRelIndirSymHeader {
+ /// Register to hold the base pointer of the symbol
+ uint16_t Register;
+ /// Spilled member for s.i
+ uint16_t SpilledUdtMember : 1;
+ uint16_t Padding : 3;
+ /// Offset in parent variable.
+ uint16_t OffsetInParent : 12;
+ /// Offset to add after dereferencing `Register + BasePointerOffset`
+ int32_t OffsetInUdt;
----------------
aganea wrote:
These two fields `OffsetInUdt` and `BasePointerOffset` are reversed, as compared to what SymbolRecord.h declares.
https://github.com/llvm/llvm-project/pull/190156
More information about the llvm-commits
mailing list