SPIR-V NonSemantic Shader DebugInfo Instructions

DebugInfoNone

Other instructions can refer to this one in case the debugging information is unknown, not available, or not applicable.

Result Type must be OpTypeVoid.

5

12

<id>
Result Type

Result <id>

<id> Set

0

DebugBuildIdentifier

A build identifier for the shader that can be used to tie debug information to a SPIR-V module even if the two are separated, as long as the identifier is present in both.

When removing debug information from a module tools should preserve this instruction and any DebugStoragePath, to allow users to locate the correct debug information again.

The identifier must be a lowercase hexadecimal string - digits and the characters [a-f] - with at least 32 characters.

Result Type must be OpTypeVoid.

Identifier is an OpString holding the hexadecimal representation of a GUID for this build.

Flags is a 32-bit integer constant containing a value from the BuildIdentifierFlags table.

7

12

<id>
Result Type

Result <id>

<id> Set

105

<id> Identifier

<id> Flags

DebugStoragePath

A hint for consumers as to where to store this shader’s debug information. If the debug information has been split apart and is identified with DebugBuildIdentifier, this path can provide a hint as to where the debug information has been stored.

It is optional, and may be automatically generated based on a common prefix and the identifier itself.

Interpretation of the path and the storage method are not specified here, but commonly the path will be a relative path on disk, which is searched relative to externally agreed search paths.

Result Type must be OpTypeVoid.

Identifier is an OpString holding the absolute or relative path to the stored SPIR-V module.

6

12

<id>
Result Type

Result <id>

<id> Set

106

<id> Path

DebugCompilationUnit

Describe a source compilation unit. A compilation unit is the single source input to a SPIR-V front-end after any preprocessing has occurred. Multiple compilation units can be linked together to produce a SPIR-V module, and the same source file can be used for multiple compilation units if different compilation settings are used each time.

The Result <id> of this instruction represents a lexical scope.

Result Type must be OpTypeVoid.

Version is version of the SPIRV debug information format, stored in a 32-bit integer OpConstant.

DWARF Version is version of the DWARF standard this specification is compatible with, stored in a 32-bit integer OpConstant.

Source is a DebugSource instruction representing the text of the initial input file before pre-processing.

Language is a 32-bit integer OpConstant. The value is the source programming language of this particular compilation unit. Possible values of this operand are described in the Source Language section of the core SPIR-V specification.

9

12

<id>
Result Type

Result <id>

<id> Set

1

<id> Version

<id> DWARF version

<id> Source

<id> Language

DebugSource

Describe the source program. It can be either the primary source file or a file added via a #include directive.

Result Type must be OpTypeVoid.

File is an OpString holding the name of the source file including its full path.

Text is an OpString that contains text of the source program the SPIR-V module is derived from.

6+

12

<id>
Result Type

Result <id>

<id> Set

35

<id> File

Optional
<id> Text

DebugSourceContinued

Continue specifying source text from the previous instruction.

The previous instruction must be a DebugSource or DebugSourceContinued instruction. The previous instruction must use the same extended instruction set <id> as this one, and it must contain some text string id.

The text strings specified in both instructions are nul terminated, and the contents of the string in this instruction is appended immediately after before the nul in the previous instruction’s string to form the joined text.

Result Type must be OpTypeVoid.

Text is an OpString that contains text to append.

6

12

<id>
Result Type

Result <id>

<id> Set

102

<id> Text

DebugEntryPoint

Describe the compilation environment for an OpEntryPoint.

Result Type must be OpTypeVoid.

Entry Point is the <id> of the DebugFunction corresponding to the OpFunction referenced in the OpEntryPoint. This function must also have a DebugFunctionDefinition in the first basic block of that OpFunction.

Compilation Unit is the <id> of the DebugCompilationUnit that produced the entry point.

Compiler Signature is an OpString describing the compiler and version used for compilation.

Command-line Arguments is an OpString containing the command line arguments passed to the compiler.

9

12

<id>
Result Type

Result <id>

<id> Set

107

<id> Entry Point

<id> Compilation Unit

<id> Compiler Signature

<id> Command-line Arguments

DebugTypeBasic

Describe a basic data type.

Result Type must be OpTypeVoid.

Name is an OpString representing the name of the type as it appears in the source program. May be empty.

Size is an OpConstant with 32-bit or 64-bit integer type and its value is the number of bits required to hold an instance of the type.

Encoding is a 32-bit integer OpConstant describing how the base type is encoded.

Flags is the <id> of a 32-bit integer OpConstant formed by the bitwise-OR of values from the Debug Info Flags table.

Note: If flags contains the FlagUnknownPhysicalLayout flag, the Size is a placeholder value based on an assumed memory layout and may not correspond to the exact size of the composite by the implementation.

9

12

<id>
Result Type

Result <id>

<id> Set

2

<id> Name

<id> Size

<id> Encoding

<id> Flags

DebugTypePointer

Describe a pointer or reference data type.

Result Type must be OpTypeVoid.

Base Type is the <id> of a debugging instruction that represents the pointee type.

Storage Class is a 32-bit integer OpConstant containing the class of the memory where the object pointed to is allocated. Possible values of this operand are described in the Storage Class section of the core SPIR-V specification.

Flags is the <id> of a 32-bit integer OpConstant formed by the bitwise-OR of values from the Debug Info Flags table.

8

12

<id>
Result Type

Result <id>

<id> Set

3

<id> Base Type

<id> Storage Class

<id> Flags

DebugTypeQualifier

Describe a const, volatile, or restrict qualified data type. A type with multiple qualifiers are represented as a sequence of DebugTypeQualifier instructions.

Result Type must be OpTypeVoid.

Base Type is debug instruction that represents the type being qualified.

Type Qualifier is a 32-bit integer constant containing a value from the TypeQualifiers table.

7

12

<id>
Result Type

Result <id>

<id> Set

4

<id> Base Type

<id> Type Qualifier

DebugTypeArray

Describe a array data type.

Result Type must be OpTypeVoid.

Base Type is a debugging instruction that describes the element type of the array.

Component Count is the number of elements in the corresponding dimension of the array. The number and order of Component Count operands must match with the number and order of array dimensions as they appear in the source program. Component Count must be a Result <id> of an OpConstant, DebugGlobalVariable, or DebugLocalVariable. If it is an OpConstant, its type must be a 32-bit or 64-bit integer type. Otherwise its type must be a DebugTypeBasic whose Size is 32 or 64 and whose Encoding is Unsigned. If the OpConstant value is set to 0, this indicates an array with an unknown size at compile time which is sized at runtime, corresponding to the SPIR-V OpTypeRuntimeArray type.

7+

12

<id>
Result Type

Result <id>

<id> Set

5

<id> Base Type

<id> Component Count, …​

DebugTypeVector

Describe a vector data type.

Result Type must be OpTypeVoid.

Base Type is the <id> of a debugging instruction that describes the type of element of the vector.

Component Count is the <id> of a 32-bit integer OpConstant denoting the number of elements in the vector.

7

12

<id>
Result Type

Result <id>

<id> Set

6

<id> Base Type

<id>
Component Count

DebugTypeMatrix

Describe a matrix data type.

Result Type must be OpTypeVoid.

Vector Type is the <id> of a debugging instruction that describes the type of vector in the matrix.

Vector Count is the <id> of a 32-bit integer OpConstant denoting the number of vectors in the matrix.

Column Major is the <id> of a boolean OpConstant denoting whether the matrix is column major. If it is True then the matrix is column major with each Vector Type representing a column and Vector Count giving the number of columns. If it is False then correspondingly the matrix is row major with each vector being a row.

8

12

<id>
Result Type

Result <id>

<id> Set

108

<id> Vector Type

<id>
Vector Count

<id>
Column Major

DebugTypedef

Describe a C/C++ typedef declaration.

Result Type must be OpTypeVoid.

Name is an OpString that represents a new name for the Base Type.

Base Type is a debugging instruction representing the type for which a new name is being declared.

Source is a DebugSource instruction representing the text of the source program containing the typedef declaration.

Line is the <id> of a 32-bit integer OpConstant denoting the source line number at which the declaration appears in the Source.

Column is the <id> of a 32-bit integer OpConstant denoting the column number at which the first character of the declaration appears.

Parent is the <id> of a debug instruction that represents the lexical scope that contains the typedef declaration.

11

12

<id>
Result Type

Result <id>

<id> Set

7

<id> Name

<id> Base Type

<id> Source

<id> Line

<id> Column

<id> Parent

DebugTypeFunction

Describe a function type.

Result Type must be OpTypeVoid.

Flags is the <id> of a 32-bit integer OpConstant formed by the bitwise-OR of values from the Debug Info Flags table.

Return Type is a debug instruction that represents the type of return value of the function. If the function has no return value, this operand is OpTypeVoid.

Parameter Types are debug instructions that describe the type of parameters of the function.

7+

12

<id>
Result Type

Result <id>

<id> Set

8

<id> Flags

<id> Return Type

Optional <id>, <id>, …​ Parameter Types

DebugTypeEnum

Describe an enumeration type.

Result Type must be OpTypeVoid.

Name is an OpString holding the name of the enumeration as it appears in the source program.

Underlying Type is a debugging instruction that describes the underlying type of the enum in the source program. If the underlying type is not specified in the source program, this operand must refer to DebugInfoNone.

Source is a DebugSource instruction representing the text of the source program containing the enum declaration.

Line is the <id> of a 32-bit integer OpConstant denoting the source line number at which the enumeration declaration appears in the Source.

Column is the <id> of a 32-bit integer OpConstant denoting the column number at which the first character of the enumeration declaration appears.

Parent is the <id> of a debug instruction that represents the lexical scope that contains the enumeration type.

Size is an OpConstant with 32-bit or 64-bit integer type and its value is the number of bits required to hold an instance of the enumeration type.

Flags is the <id> of a 32-bit integer OpConstant formed by the bitwise-OR of values from the Debug Info Flags table.

Enumerators are encoded as trailing pairs of Value and corresponding Name. Values must be the <id> of OpConstant instructions, with a 32-bit integer result type. Name must be the <id> of an OpString instruction.

13+

12

<id>
Result Type

Result <id>

<id> Set

9

<id> Name

<id> Underlying Type

<id> Source

<id> Line

<id> Column

<id> Parent

<id> Size

<id> Flags

<id> Value,
<id> Name,
<id> Value,
<id> Name, …​

DebugTypeComposite

Describe a structure, class, or union data type. The Result <id> of this instruction represents a lexical scope.

Result Type must be OpTypeVoid.

Tag is the <id> of a 32-bit integer OpConstant with a value from the Composite Types table that specifies the kind of the composite type.

Name is an OpString holding the name of the type as it appears in the source program.

Source is a DebugSource instruction representing the text of the source program containing the type declaration.

Line is the <id> of a 32-bit integer OpConstant denoting the source line number at which the type declaration appears in the Source.

Column is the <id> of a 32-bit integer OpConstant denoting the column number at which the first character of the type declaration appears.

Parent is the <id> of a debug instruction that represents the lexical scope that contains the composite type. It must be one of the following: DebugCompilationUnit, DebugFunction, DebugLexicalBlock, or DebugTypeComposite.

Linkage Name is an OpString, holding the linkage name or mangled name of the composite.

Size is an OpConstant with 32-bit or 64-bit integer type and its value is the number of bits required to hold an instance of the composite type.

Flags is the <id> of a 32-bit integer OpConstant formed by the bitwise-OR of values from the Debug Info Flags table.

Members must be the <id>s of DebugTypeMember, DebugFunction, or DebugTypeInheritance. This could be a forward reference.

Note: If flags contains the FlagUnknownPhysicalLayout flag, the Size is a placeholder value based on an assumed memory layout and may not correspond to the exact size of the composite by the implementation. Size will be at least greater than or equal to the highest Offset of any element in Members plus that members Size. The order of members in memory can be determined by the order of their Offset parameter.

Note: To represent a source language opaque type, this instruction must have no Members operands, Size operand must be DebugInfoNone, and Name must start with @ to avoid clashes with user defined names.

14+

12

<id>
Result Type

Result <id>

<id> Set

10

<id> Name

Tag

<id> Source

<id> Line

<id> Column

<id> Parent

<id> Linkage Name

<id> Size

<id> Flags

<id>, <id>, …​ Members

DebugTypeMember

Describe a data member of a structure, class, or union.

Result Type must be OpTypeVoid.

Name is an OpString holding the name of the member as it appears in the source program.

Type is a debug type instruction that represents the type of the member.

Source is a DebugSource instruction representing the text of the source program containing the member declaration.

Line is the <id> of a 32-bit integer OpConstant denoting the source line number at which the member declaration appears in the Source.

Column is the <id> of a 32-bit integer OpConstant denoting the column number at which the first character of the member declaration appears.

Offset is an OpConstant with integral type, and its value is the memory offset in bits from the beginning of the Scope type.

Size is an OpConstant with 32-bit or 64-bit integer type and its value is the number of bits the member occupies within the Scope type.

Flags is the <id> of a 32-bit integer OpConstant formed by the bitwise-OR of values from the Debug Info Flags table.

Value is an OpConstant representing initialization value in case of const static qualified member in C++.

Note: If flags contains the FlagUnknownPhysicalLayout flag, the Size and Offset are placeholder values based on an assumed memory layout and may not correspond to the exact size of the composite by the implementation. Size will be greater than zero.

13+

12

<id>
Result Type

Result <id>

<id> Set

11

<id> Name

<id> Type

<id> Source

<id> Line

<id> Column

<id> Offset

<id> Size

<id> Flags

Optional <id> Value

DebugTypeInheritance

Describe the inheritance relationship with a parent class or structure. The Result of this instruction can be used as a member of a composite type.

Result Type must be OpTypeVoid.

Parent is a debug instruction representing a class or structure the Child Type is derived from.

Offset is an OpConstant with integral type and its value is the offset of the Parent Type in bits in layout of the Child Type.

Size is an OpConstant with 32-bit or 64-bit integer type and its value is the number of bits the Parent type occupies within the Child Type.

Flags is the <id> of a 32-bit integer OpConstant formed by the bitwise-OR of values from the Debug Info Flags table.

9

12

<id>
Result Type

Result <id>

<id> Set

12

<id> Parent

<id> Offset

<id> Size

<id> Flags

DebugTypePtrToMember

Describe the type of an object that is a pointer to a structure or class member.

Result Type must be OpTypeVoid.

Member Type is a debug instruction representing the type of the member.

Parent is a debug instruction, representing a structure or class type.

7

12

<id>
Result Type

Result <id>

<id> Set

13

<id> Member Type

<id> Parent

DebugTypeTemplate

Describe an instantiated template of class, struct, or function in C++.

Result Type must be OpTypeVoid.

Target is a debug instruction representing the class, struct, or function that has template parameter(s).

Parameters are debug instructions representing the template parameters for this particular instantiation.

7

12

<id>
Result Type

Result <id>

<id> Set

14

<id> Target

<id>…​ Parameters

DebugTypeTemplateParameter

Describe a formal parameter of a C++ template instantiation.

Result Type must be OpTypeVoid.

Name is an OpString holding the name of the template parameter.

Actual Type is a debug instruction representing the actual type of the formal parameter for this particular instantiation.

If this instruction describes a template value parameter, the Value is represented by an OpConstant with an integer result type. For a template type parameter, the Value operand must be the Result <id> of DebugInfoNone.

Source is a DebugSource instruction representing the text of the source program containing the template instantiation.

Line is the <id> of a 32-bit integer OpConstant denoting the source line number at which the template parameter declaration appears in the Source.

Column is the <id> of a 32-bit integer OpConstant denoting the column number at which the first character of the template parameter declaration appears.

11

12

<id>
Result Type

Result <id>

<id> Set

15

<id> Name

<id> Actual Type

<id> Value

<id> Source

<id> Line

<id> Column

DebugTypeTemplateTemplateParameter

Describe a template template parameter of a C++ template instantiation.

Result Type must be OpTypeVoid.

Name is an OpString holding the name of the template template parameter

Template Name is an OpString holding the name of the template used as template parameter in this particular instantiation.

Source is a DebugSource instruction representing the text of the source program containing the template instantiation.

Line is the <id> of a 32-bit integer OpConstant denoting the source line number at which the template template parameter declaration appears in the Source.

Column is the <id> of a 32-bit integer OpConstant denoting the column number at which the first character of the template template parameter declaration appears.

10

12

<id>
Result Type

Result <id>

<id> Set

16

<id> Name

<id> Template Name

<id> Source

<id> Line

<id> Column

DebugTypeTemplateParameterPack

Describe the expanded template parameter pack in a variadic template instantiation in C++.

Result Type must be OpTypeVoid.

Name is an OpString holding the name of the template parameter pack.

Source is a DebugSource instruction representing the text of the source program containing the template instantiation.

Line is the <id> of a 32-bit integer OpConstant denoting the source line number at which the template parameter pack declaration appears in the Source.

Column is the <id> of a 32-bit integer OpConstant denoting the column number at which the first character of the template parameter pack declaration appears.

Template parameters are DebugTypeTemplateParameters describing the expanded parameter pack in the variadic template instantiation.

10+

12

<id>
Result Type

Result <id>

<id> Set

17

<id> Name

<id> Source

<id> Line

<id> Column

<id>…​ Template parameters

DebugGlobalVariable

Describe a source global variable.

Result Type must be OpTypeVoid.

Name is an OpString, holding the name of the variable as it appears in the source program.

Type is a debug instruction that represents the type of the variable.

Source is a DebugSource instruction representing the text of the source program containing the source global variable declaration.

Line is the <id> of a 32-bit integer OpConstant denoting the source line number at which the source global variable declaration appears in the Source.

Column is the <id> of a 32-bit integer OpConstant denoting the column number at which the first character of the source global variable declaration appears.

Parent is the <id> of a debug instruction that represents the lexical scope that contains the source global variable declaration. It must be one of the following: DebugCompilationUnit, DebugFunction, DebugLexicalBlock, or DebugTypeComposite.

Linkage Name is an OpString, holding the linkage name of the variable.

Variable can hold two kinds of values. First it can hold the <id> of the source global variable or constant that is described by this instruction. If the variable is optimized out, this operand can be the <id> of a DebugExpression instruction that contains the constant value of the variable that was optimized out. Otherwise this operand must be DebugInfoNone.

Flags is the <id> of a 32-bit integer OpConstant formed by the bitwise-OR of values from the Debug Info Flags table.

If the source global variable represents a defining declaration for a C++ static data member of a structure, class, or union, the optional Static Member Declaration operand refers to the debugging type of the previously declared variable, i.e. DebugTypeMember.

14+

12

<id>
Result Type

Result <id>

<id> Set

18

<id> Name

<id> Type

<id> Source

<id> Line

<id> Column

<id> Parent

<id> Linkage Name

<id> Variable

<id> Flags

Optional <id> Static Member Declaration

DebugFunctionDeclaration

Describe a function or method declaration.

Result Type must be OpTypeVoid.

Name is an OpString, holding the name of the function as it appears in the source program.

Type is an DebugTypeFunction instruction that represents the type of the function.

Source is a DebugSource instruction representing the text of the source program containing the function declaration.

Line is the <id> of a 32-bit integer OpConstant denoting the source line number at which the function declaration appears in the Source.

Column is the <id> of a 32-bit integer OpConstant denoting the column number at which the first character of the function declaration appears.

Parent is the <id> of a debug instruction that represents the lexical scope that contains the function declaration.

Linkage Name is an OpString, holding the linkage name of the function.

Flags is the <id> of a 32-bit integer OpConstant formed by the bitwise-OR of values from the Debug Info Flags table.

13

12

<id>
Result Type

Result <id>

<id> Set

19

<id> Name

<id> Type

<id> Source

<id> Line

<id> Column

<id> Parent

<id> Linkage Name

<id> Flags

DebugFunction

Describe a function or method definition. The Result <id> of this instruction represents a lexical scope.

Result Type must be OpTypeVoid.

Name is an OpString, holding the name of the function as it appears in the source program.

Type is an DebugTypeFunction instruction that represents the type of the function.

Source is a DebugSource instruction representing the text of the source program containing the function definition.

Line is the <id> of a 32-bit integer OpConstant denoting the source line number at which the function declaration appears in the Source.

Column is the <id> of a 32-bit integer OpConstant denoting the column number at which the first character of the function declaration appears.

Parent is the <id> of a debug instruction that represents the lexical scope that contains the function definition.

Linkage Name is an OpString, holding the linkage name of the function.

Flags is the <id> of a 32-bit integer OpConstant formed by the bitwise-OR of values from the Debug Info Flags table.

Scope Line is the <id> of a 32-bit integer OpConstant denoting the line number in the source program at which the function lexical scope begins.

Declaration is DebugFunctionDeclaration that represents non-defining declaration of the function.

14+

12

<id>
Result Type

Result <id>

<id> Set

20

<id> Name

<id> Type

<id> Source

<id> Line

<id> Column

<id> Parent

<id> Linkage Name

<id> Flags

<id> Scope Line

Optional <id> Declaration

DebugFunctionDefinition

Describe a function definition. This instruction must appear in the entry basic block of an OpFunction and there must be at most one such instruction.

The referenced DebugFunction must not be referenced by any other DebugFunctionDefinition.

Result Type must be OpTypeVoid.

Function is the <id> of a DebugFunction instruction that describes this function.

Definition is the <id> of the OpFunction that this instruction is inside.

7

12

<id>
Result Type

Result <id>

<id> Set

101

<id> Function

<id> Definition

DebugLexicalBlock

Describe a lexical block in the source program. The Result <id> of this instruction represents a lexical scope.

Result Type must be OpTypeVoid.

Source is a DebugSource instruction representing the text of the source program containing the lexical block.

Line is the <id> of a 32-bit integer OpConstant denoting the source line number at which the lexical block begins in the Source.

Column is the <id> of a 32-bit integer OpConstant denoting the column number at which the lexical block begins.

Parent is the <id> of a debug instruction that represents the lexical scope containing the lexical block. Entities in the global lexical scope should have Parent referring to a DebugCompilationUnit.

The presence of the Name operand indicates that this instruction represents a C++ namespace. This operand refers to an OpString holding the name of the namespace. For anonymous C++ namespaces, the name must be an empty string.

9+

12

<id>
Result Type

Result <id>

<id> Set

21

<id> Source

<id> Line

<id> Column

<id> Parent

Optional <id> Name

DebugLexicalBlockDiscriminator

Distinguish lexical blocks on a single line in the source program.

Result Type must be OpTypeVoid.

Source is a DebugSource instruction representing the text of the source program containing the lexical block.

Parent is the <id> of a debug instruction that represents the lexical scope containing the lexical block.

Discriminator is the <id> of a 32-bit integer OpConstant denoting a DWARF discriminator value for instructions in the lexical block.

8

12

<id>
Result Type

Result <id>

<id> Set

22

<id> Source

<id> Discriminator

<id> Parent

DebugScope

Provide information about a previously declared lexical scope. This instruction delimits the start of a contiguous group of instructions, to be ended by any of the following: the next end of block, the next DebugScope instruction, or the next DebugNoScope instruction.

This instruction must only appear within a block.

Result Type must be OpTypeVoid.

Scope is a previously declared lexical scope.

Inlined is a DebugInlinedAt instruction that represents the lexical scope and location to where Scope instructions were inlined.

6+

12

<id>
Result Type

Result <id>

<id> Set

23

<id> Scope

Optional
<id> Inlined

DebugNoScope

Delimit the end of a contiguous group of instructions started by the previous DebugScope.

This instruction must only appear within a block.

Result Type must be OpTypeVoid.

5

12

<id>
Result Type

Result <id>

<id> Set

24

DebugInlinedAt

Declare to where instructions grouped together by a DebugScope instruction are inlined. When a function is inlined, a DebugScope for the function or a part of the function can have an Inlined operand i.e., DebugInlinedAt, which means the set of instructions grouped by the DebugScope was inlined to the Line operand of the DebugInlinedAt of the Scope operand of the DebugInlinedAt.

Result Type must be OpTypeVoid.

Line is the <id> of a 32-bit integer OpConstant denoting the source line number where the range of instructions were inlined.

Scope is a lexical scope that contains Line.

Inlined is a debug instruction representing the next level of inlining in case of recursive inlining.

7+

12

<id>
Result Type

Result <id>

<id> Set

25

<id> Line

<id> Scope

Optional <id> Inlined

DebugLine

Specify source-level line and column information. This information applies to all following instructions, up to the first occurrence of any of the following: the next end of block, the next DebugLine instruction, or the next DebugNoLine instruction.

This instruction must only appear within a block.

Result Type must be OpTypeVoid.

Source is a previously declared DebugSource indicating the file containing the location.

Line Start is the <id> of a 32-bit integer OpConstant denoting the source line number where the location begins.

Line End is the <id> of a 32-bit integer OpConstant denoting the source line number where the location ends. This must be greater than or equal to Line End.

Column Start is the <id> of a 32-bit integer OpConstant denoting the source column number where the location begins.

Column End is the <id> of a 32-bit integer OpConstant denoting the source column number where the location ends. This must be greater than or equal to Column Start if Line Start equals Line End.

10

12

<id>
Result Type

Result <id>

<id> Set

103

<id> Source

<id> Line Start

<id> Line End

<id> Column Start

<id> Column End

DebugNoLine

Discontinue any source-level line and column information specified by any previous DebugLine instruction.

This instruction must only appear within a block.

Result Type must be OpTypeVoid.

5

12

<id>
Result Type

Result <id>

<id> Set

104

DebugLocalVariable

Describe a local variable.

Result Type must be OpTypeVoid.

Name is an OpString, holding the name of the variable as it appears in the source program.

Type is a debugging instruction that represents the type of the local variable.

Source is a DebugSource instruction representing the text of the source program containing the local variable declaration.

Line is the <id> of a 32-bit integer OpConstant denoting the source line number at which the local variable declaration appears in the Source.

Column is the <id> of a 32-bit integer OpConstant denoting the column number at which the first character of the local variable declaration appears.

Parent is the <id> of a debug instruction that represents the lexical scope that contains the the local variable declaration.

Flags is the <id> of a 32-bit integer OpConstant formed by the bitwise-OR of values from the Debug Info Flags table.

If ArgNumber operand is present, this instruction represents a function formal parameter. The argument is the <id> of a 32-bit integer OpConstant.

12+

12

<id>
Result Type

Result <id>

<id> Set

26

<id> Name

<id> Type

<id> Source

<id> Line

<id> Column

<id> Parent

<id> Flags

Optional
<id> ArgNumber

DebugInlinedVariable

Describe an inlined local variable.

Result Type must be OpTypeVoid.

Variable is a debug instruction representing a local variable that is inlined.

Inlined is an DebugInlinedAt instruction representing the inline location.

7+

12

<id>
Result Type

Result <id>

<id> Set

27

<id> Variable

<id> Inlined

DebugDeclare

Define point of declaration of a local variable.

Result Type must be OpTypeVoid.

Local Variable must be an <id> of DebugLocalVariable.

Variable must be the <id> of an OpVariable instruction that defines the local variable.

Expression must be an <id> of a DebugExpression instruction.

Indexes have the same semantics as the corresponding operand(s) of OpAccessChain, applied to the Local Variable.

8+

12

<id>
Result Type

Result <id>

<id> Set

28

<id> Local Variable

<id> Variable

<id> Expression

<id>, <id>, …​ Indexes

DebugValue

Represent a changing of value of a local variable.

Result Type must be OpTypeVoid.

Local Variable must be an <id> of a DebugLocalVariable.

Value is a Result <id> of a non-debug instruction. The new value of Local Variable is the result of the evaluation of Expression to Value.

Expression is the <id> of a DebugExpression instruction.

Indexes have the same semantics as the corresponding operand(s) of OpAccessChain, applied to the Local Variable.

8+

12

<id>
Result Type

Result <id>

<id> Set

29

<id> Local Variable

<id> Value

<id> Expression

<id>, <id>, …​ Indexes

DebugOperation

Represent a DWARF operation that operates on a stack of values.

Result Type must be OpTypeVoid.

Operation is a 32-bit OpConstant specifying the DWARF operation from the Debug Operations table.

Operands are zero or more 32-bit integer OpConstant <id>s.

6+

12

<id>
Result Type

Result <id>

<id> Set

30

<id> Operation

Optional <id>
Operands …​

DebugExpression

Represent a DWARF expression, which describe how to compute a value or name location during debugging of a program. This is expressed in terms of DWARF operations that operate on a stack of values.

Result Type must be OpTypeVoid.

Operation is zero or more ids of DebugOperation.

5+

12

<id>
Result Type

Result <id>

<id> Set

31

Optional <id>…​ Operation

DebugMacroDef

Represents a macro definition.

Result Type must be OpTypeVoid.

Source is the <id> of an OpString, which contains the name of the file that contains definition of the macro.

Line is <id> of a 32-bit integer OpConstant denoting the line number in the source file at which the macro is defined. If Line is zero, the macro definition is provided by compiler’s command line argument.

Name is the <id> of an OpString, which contains the name of the macro as it appears in the source program. In the case of a function-like macro definition, no whitespace characters appear between the name of the defined macro and the following left parenthesis. Formal parameters are separated by a comma without any whitespace. A right parenthesis terminates the formal parameter list.

Value is the <id> of an OpString, which contains text with definition of the macro.

7+

12

<id>
Result Type

Result <id>

<id> Set

32

<id> Source

<id> Line

<id> Name

Optional <id> Value

DebugMacroUndef

Discontinue previous macro definition.

Result Type must be OpTypeVoid.

Source is the <id> of an OpString, which contains the name of the file in which the macro is undefined.

Line is the <id> of a 32-bit integer OpConstant denoting the line number in the source program at which the macro is rendered as undefined.

Macro is the <id> of DebugMacroDef which represent the macro to be undefined.

8

12

<id>
Result Type

Result <id>

<id> Set

33

<id> Source

<id> Line

<id> Macro

DebugImportedEntity

Represents a C++ namespace using-directive, namespace alias, or using-declaration.

Name is an OpString, holding the name or alias for the imported entity.

Tag is the <id> of a 32-bit integer OpConstant with a value from the Imported Entities table which specifies the kind of the imported entity.

Source is a DebugSource instruction representing the text of the source program the Entity is being imported from.

Entity is a debug instruction representing a namespace or declaration that is being imported.

Line is the <id> of a 32-bit integer OpConstant denoting the source line number at which the using declaration appears in the Source.

Column is the <id> of a 32-bit integer OpConstant denoting the column number at which the first character of the using declaration appears.

Parent is the <id> of a debug instruction that represents the lexical scope that contains the namespace or declaration.

12

12

<id>
Result Type

Result <id>

<id> Set

34

<id> Name

<id> Tag

<id> Source

<id> Entity

<id> Line

<id> Column

<id> Parent