Debug Information Extended Instruction Set Specification

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

DebugCompilationUnit

Describe compilation unit.

Result Type must be OpTypeVoid

Source is an OpSource providing text of the primary source program this module was derived from.

Version is version of SPIRV debug information specification.

DWARF Version is version of DWARF standard this specification is compatible with.

8

12

<id>
Result Type

Result <id>

<id> Set

1

<id> Source

Literal Number Version

Literal Number DWARF version

DebugTypeBasic

Describe basic data types.

Result Type must be OpTypeVoid

Name represents the name of the type as it appears in the source program. May be empty.

Size is an OpConstant with integral type and its value is amount of storage in bits, needed to hold an instance of the type.

Encoding describes how the base type is encoded.

8

12

<id>
Result Type

Result <id>

<id> Set

2

<id> Name

<id> Size

Encoding

DebugTypePointer

Describe pointer or reference data types.

Result Type must be OpTypeVoid

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

Storage Class is the class of the memory where the pointed object is allocated. Possible values of this operand are described in the "Storage Class" section of the core SPIR-V specification.

Flags is a single word literal formed by bitwise OR-ing values from the Debug Info Flags table.

8

12

<id>
Result Type

Result <id>

<id> Set

3

<id> Base Type

Storage Class

Literal Flags

DebugTypeQualifier

Describe const, volatile and restrict qualified data types. Types with multiple qualifiers are represented as a sequence of single qualified types.

Result Type must be OpTypeVoid

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

Type Qaulifier is a literal value from the TypeQualifiers table.

7

12

<id>
Result Type

Result <id>

<id> Set

4

<id> Base Type

Type Qaulifier

DebugTypeArray

Describe array data types

Result Type must be OpTypeVoid

Base Type is debugging instruction which describes type of element of the array

Component Count is an OpConstant with integral result type, and its value is the number of elements in the corresponding dimension of the array. Number and order of Component Count operands must match with number and order of array dimensions as they appear in the source program.

7+

12

<id>
Result Type

Result <id>

<id> Set

5

<id> Base Type

<id> Component Count, …​

DebugTypeVector

Describe vector data types

Result Type must be OpTypeVoid

Base Type is id of debugging instruction which describes type of element of the vector

Component Count is a single word literal denoting number of elements in the vector.

7

12

<id>
Result Type

Result <id>

<id> Set

6

<id> Base Type

Literal Number
Component Count

DebugTypedef

Describe a C and C++ typedef declaration

Result Type must be OpTypeVoid

Name is OpString which is 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 an OpSource providing text of the primary source program this module was derived from.

Line is a single word literal denoting the source line number at which the declaration appears in the Source

Column is a single word literal denoting column number at which the first character of the declaration appears on the Line.

Parent is a debug instruction which represents the parent lexical scope of the declaration.

11

12

<id>
Result Type

Result <id>

<id> Set

7

<id> Name

<id> Base Type

<id> Source

Literal Number Line

Literal Number Column

<id> Parent

DebugTypeFunction

Describe a function type

Result Type must be OpTypeVoid

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

Parameter Types are debug instructions which describe type of parameters of the function

6+

12

<id>
Result Type

Result <id>

<id> Set

8

<id> Return Type

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

DebugTypeEnum

Describe enumeration types

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 debbuging instruction which 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 an OpSource providing text of the primary source program this module was derived from.

Line is a single word literal denoting the source line number at which the enumeration declaration appears in the Source.

Column is a single word literal denoting column number at which the first character of the enumeration declaration appears on the Line.

Parent is a debug instruction which represents a parent lexical scope.

Size is an OpConstant with integral result type, and its value is the number of bits required to hold an instance of the enumeration.

Flags is a single word literal formed by bitwise OR-ing values from the Debug Info Flags table.

Enumerators are encoded as trailing pairs of Value and corresponding Name. Values must be id of OpConstant instruction, with integer result type. Name must be id of OpString instruction.

13+

12

<id>
Result Type

Result <id>

<id> Set

9

<id> Name

<id> Underlying Type

<id> Source

Literal Number Line

Literal Number Column

<id>, Parent

<id> Size

Literal Flags

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

DebugTypeComposite

Describe structure, class and union data types

Result Type must be OpTypeVoid

Tag specifies the kind of composite type

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

Source is an OpSource providing text of the primary source program this module was derived from.

Line is a single word literal denoting the source line number at which the type declaration appears in the Source

Column is a single word literal denoting column number at which the first character of the declaration appears on the Line

Parent is a debug instruction which represents parent lexical scope. Must be one of the following: DebugCompilationUnit, DebugFunction, DebugLexicalBlock or other DebugTypeComposite

Size is an OpConstant with integral type and its value is the number of bits required to hold an instance of the composite type.

Flags is a single word literal formed by bitwise OR-ing values from the Debug Info Flags table.

Members must be ids of DebugTypeMember, DebugFunction or DebugTypeInheritance.

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 @ symbol to avoid clashes with user defined names.

13+

12

<id>
Result Type

Result <id>

<id> Set

10

<id> Name

Tag

<id> Source

Literal Number Line

Literal Number Column

<id> Parent

<id> Size

Literal 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 which represents type of the member

Source is an OpSource providing text of the primary source program this module was derived from.

Line is a single word literal denoting the source line number at which the member declaration appears in the Source

Column is a single word literal denoting column number at which the firs t character of the member declaration appears on the Line

Parent is a debug instruction which represents a composite type containing this member.

Offset is an OpConstant with integral type and its value is offset in bits from the beginning of the Containig Type.

Size is an OpConstant with integral type and its value is the number of bits the Base type occupies within the Containig Type.

Flags is a single word literal formed by bitwise OR-ing values from the Debug Info Flags table.

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

14+

12

<id>
Result Type

Result <id>

<id> Set

11

<id> Name

<id> Type

<id> Source

Literal Number Line

Literal Number Column

<id> Parent

<id> Offset

<id> Size

Flags

Optional <id> Value

DebugTypeInheritance

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

Result Type must be OpTypeVoid

Child is a debug instruction representing a derived class or struct in C++.

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 offset of the Parent Type in bits in layout of the Child Type

Size is an OpConstant with integral type and its value is the number of bits the Parent type occupies within the Child Type.

Flags is a single word literal formed by bitwise OR-ing values from the Debug Info Flags table.

10

12

<id>
Result Type

Result <id>

<id> Set

12

<id> Child

<id> Parent

<id> Offset

<id> Size

Flags

DebugTypePtrToMember

Describe a 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 class, struct or function which 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 integer result type. For template type parameter Value operand must not be used

Source is an OpSource providing text of the primary source program this module was derived from.

Line is a single word literal denoting the source line number at which the template parameter declaration appears in the Source

Column is a single word literal denoting column number at which the first character of the template parameter declaration appears on the Line

11

12

<id>
Result Type

Result <id>

<id> Set

15

<id> Name

<id> Actual Type

<id> Value

<id> Source

Literal Number Line

Literal Number 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 an OpSource providing text of the primary source program this module was derived from.

Line is a single word literal denoting the source line number at which the template template parameter declaration appears in the Source

Column is a single word literal denoting column number at which the first character of the template template parameter declaration appears on the Line

10

12

<id>
Result Type

Result <id>

<id> Set

16

<id> Name

<id> Template Name

<id> Source

Literal Number Line

Literal Number Column

DebugTypeTemplateParameterPack

Describe 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 an OpSource providing text of the primary source program this module was derived from.

Line is a single word literal denoting the source line number at which the template parameter pack declaration appears in the Source

Column is a single word literal denoting column number at which the first character of the template parameter pack declaration appears on the Line

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

Literal Number Line

Literal Number Column

<id>…​ Template parameters

DebugGlobalVariable

Describe a 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 which represents type of the variable.

Source is an OpSource providing text of the primary source program this module was derived from.

Line is a single word literal denoting the source line number at which the global variable declaration appears in the Source

Column is a single word literal denoting column number at which the first character of the global variable declaration appears on the Line

Parent is a debug instruction which represents parent lexical scope. Must be one of the following: DebugCompilationUnit, DebugFunction, DebugLexicalBlock or DebugTypeComposite

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

Variable is id of the global variable or constant which is described by this instruction. If the variable is optimized out, this operand must be DebugInfoNone.

Flags is a single word literal formed by bitwise OR-ing values from the Debug Info Flags table.

If the global variable represents a defining declaration for 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

Literal Number Line

Literal Number Column

<id> Parent

<id> Linkage Name

<id> Variable

Flags

Optional <id> Static Member Declaration

DebugFunctionDeclaration

Describe 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 which represents type of the function.

Source is an OpSource providing text of the primary source program this module was derived from.

Line is a single word literal denoting the source line number at which the function declaration appears in the Source

Column is a single word literal denoting column number at which the first character of the function declaration appears on the Line

Parent is a debug instruction which represents parent lexical scope.

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

Flags is a single word literal formed by bitwise OR-ing values from the Debug Info Flags table.

13

12

<id>
Result Type

Result <id>

<id> Set

19

<id> Name

<id> Type

<id> Source

Literal Number Line

Literal Number Column

<id> Parent

<id> Linkage Name

Flags

DebugFunction

Describe function or method definition or 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 which represents type of the function.

Source is an OpSource providing text of the primary source program this module was derived from.

Line is a single word literal denoting the source line number at which the function declaration appears in the Source

Column is a single word literal denoting column number at which the first character of the function declaration appears on the Line

Parent is a debug instruction which represents parent lexical scope.

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

Flags is a single word literal formed by bitwise OR-ing values from the Debug Info Flags table.

Scope Line a single word literal denoting line number in the source program at which the function scope begins.

Function is an OpFunction which is described by this instruction.

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

15+

12

<id>
Result Type

Result <id>

<id> Set

20

<id> Name

<id> Type

<id> Source

Literal Number Line

Literal Number Column

<id> Parent

<id> Linkage Name

Flags

Literal Number Scope Line

<id> Function

Optional <id> Declaration

DebugLexicalBlock

Describe a lexical block in the source program.

Result Type must be OpTypeVoid

Source is an OpSource providing text of the primary source program this module was derived from.

Line is a single word literal denoting the source line number at which the lexical block begins in the Source

Column is a single word literal denoting column number at which the lexical block begins.

Parent is a debug instructions describing the scope containing the current scope. Entities in the global scope should have Parent referring to DebugCompilationUnit.

Presence of the Name operand indicates that this instruction represents a C++ namespace. This operand refers to 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

Literal Number Line

Literal Number 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 an OpSource providing text of the primary source program this module was derived from.

Parent is a debug instructions describing the scope containing the current scope.

Discriminator is a single word literal denoting DWARF discriminator value for instructions in the lexical block.

8

12

<id>
Result Type

Result <id>

<id> Set

22

<id> Source

Literal Number Discriminator

<id> Parent

DebugScope

Provide information about source-level scope. This scope information applies to the instructions physically following this instruction, up to the first occurrence of any of the following: the next end of block, the next DebugScope instruction, or the next DebugNoScope instruction.

Result Type must be OpTypeVoid

Scope is a debugging instruction which describes source-level scope.

Inlined is an DebugInlinedAt instruction, which represents source-level scope and line number at which all instructions from the current scope were inlined.

6+

12

<id>
Result Type

Result <id>

<id> Set

23

<id> Scope

Optional
<id> Inlined At

DebugNoScope

Discontinue previously declared by DebugScope source-level scope.

Result Type must be OpTypeVoid

5

12

<id>
Result Type

Result <id>

<id> Set

24

DebugInlinedAt

Represent source-level scope and line number for the range of inlined instructions grouped together by an DebugScope instruction.

Result Type must be OpTypeVoid

Line is a single word literal denoting the line number in the source file where the range of instructions were inlined.

Scope is a debug instruction representing a source-level scope at which the range of instructions were inlined.

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

Literal Number Line

<id> Scope

Optional <id> Inlined

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 which represents type of the local variable.

Source is an OpSource providing text of the primary source program this module was derived from.

Line is a single word literal denoting the source line number at which the local variable declaration appears in the Source

Column is a single word literal denoting column number at which the first character of the local variable declaration appears on the Line

Parent id of a debug instruction which represents parent lexical scope.

If ArgNumber operand presents, this instruction represents a function formal parameter.

11+

12

<id>
Result Type

Result <id>

<id> Set

26

<id> Name

<id> Type

<id> Source

Literal Number Line

Literal Number Column

<id> Parent

Optional Literal Number ArgNumber

DebugInlinedVariable

Describe an inlined local variable.

Result Type must be OpTypeVoid

Variable is a debug instruction representing a local variable which 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 an id of OpVariable instruction which defines the local variable.

Expression must be an id of a DebugExpression instruction.

8

12

<id>
Result Type

Result <id>

<id> Set

28

<id> Local Variable

<id> Variable

<id> Expression

DebugValue

Represent changing of value of a local variable.

Result Type must be OpTypeVoid

Local Variable must be an id of DebugLocalVariable

Value is id of instruction, result of which is the new value of the Local Variable.

Expression is id of an DebugExpression instruction.

Indexes have the same semantics as corresponding operand(s) of OpAccessChain.

8+

12

<id>
Result Type

Result <id>

<id> Set

29

<id> Local Variable

<id> Value

<id> Expression

<id>, <id>, …​ Indexes

DebugOperation

Represent DWARF operation, that operate on a stack of values.

Result Type must be OpTypeVoid

Operation is a DWARF operation from the DWARF Operations table.

Operands are zero or more single word literals the Operation operates on.

6+

12

<id>
Result Type

Result <id>

<id> Set

30

OpCode

Optional Literal Operands …​

DebugExpression

Represent DWARF expressions, which describe how to compute a value or name location during debugging of a program. They are 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 id of OpString, which contains the name of the file which contains definition of the macro.

Line is 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 id of 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. Right parenthesis terminates the formal parameter list

Value is id of OpString, which contians text with definition of the macro.

7+

12

<id>
Result Type

Result <id>

<id> Set

32

<id> Source

Literal Number Line

<id> Name

Optional Value

DebugMacroUndef

Discontinue previous macro definition.

Result Type must be OpTypeVoid

Source is id of OpString, which contains the name of the file in which the macro is undefined

Line is line number in the source program at which the macro is rendered as undefined

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

8

12

<id>
Result Type

Result <id>

<id> Set

33

<id> Source

Literal Number Line

<id> Macro