Skip to content

Commit 51e7c42

Browse files
committed
Update SPIR-V friendly IR doc according to recent changes
KhronosGroup#1133 added full support for SPIR-V friendly IR with SPIR-V built-in variables mapped to calls. This commit adds info to the doc about the new supported representation.
1 parent a6ca745 commit 51e7c42

File tree

1 file changed

+50
-5
lines changed

1 file changed

+50
-5
lines changed

docs/SPIRVRepresentationInLLVM.rst

+50-5
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ an obvious way. These include:
1717
* SPIR-V types mapped to LLVM types
1818
* SPIR-V instructions mapped to LLVM function calls
1919
* SPIR-V extended instructions mapped to LLVM function calls
20-
* SPIR-V builtins variables mapped to LLVM global variables
20+
* SPIR-V builtins variables mapped to LLVM function calls or LLVM global variables
2121
* SPIR-V instructions mapped to LLVM metadata
2222
* SPIR-V types mapped to LLVM opaque types
2323
* SPIR-V decorations mapped to LLVM metadata or named attributes
@@ -203,11 +203,56 @@ where
203203
* {VectorLoadOpCodeName} = vloadn|vload_half|vload_halfn|vloada_halfn
204204

205205

206-
SPIR-V Builtins Variables Mapped to LLVM Global Variables
207-
=========================================================
206+
SPIR-V Builtin Variables Mapped to LLVM Function Calls or LLVM Global Variables
207+
===============================================================================
208208

209-
SPIR-V builtin variables are mapped to LLVM global variables with unmangled
210-
name __spirv_BuiltIn{Name}.
209+
By default each access of SPIR-V builtin variable's value is mapped to LLVM
210+
function call. The unmangled names of these functions follow the convention:
211+
.. code-block:: c
212+
213+
__spirv_BuiltIn{VariableName}
214+
215+
In case SPIR-V builtin variable has vector type, the corresponding
216+
LLVM function will have an integer argument, so each access of the variable's
217+
scalar component is mapped to a function call with index argument, i.e.:
218+
219+
.. code-block:: c
220+
; For scalar variables
221+
; SPIR-V
222+
OpDecorate %__spirv_BuiltInGlobalInvocationId BuiltIn GlobalInvocationId
223+
%13 = OpLoad %uint %__spirv_BuiltInGlobalLinearId Aligned 4
224+
225+
; Will be transformed to the following LLVM IR:
226+
%0 = call spir_func i32 @_Z29__spirv_BuiltInGlobalLinearIdv()
227+
228+
; For vector variables
229+
; SPIRV
230+
OpDecorate %__spirv_BuiltInGlobalInvocationId BuiltIn GlobalInvocationId
231+
%14 = OpLoad %v3ulong %__spirv_BuiltInGlobalInvocationId Aligned 32
232+
%15 = OpCompositeExtract %ulong %14 1
233+
234+
; Can be transformed to the following LLVM IR:
235+
%0 = call spir_func i64 @_Z33__spirv_BuiltInGlobalInvocationIdi(i32 1)
236+
237+
; However SPIRV-LLVM translator will transform it to the following pattern:
238+
%1 = call spir_func i64 @_Z33__spirv_BuiltInGlobalInvocationIdi(i32 0)
239+
%2 = insertelement <3 x i64> undef, i64 %1, i32 0
240+
%3 = call spir_func i64 @_Z33__spirv_BuiltInGlobalInvocationIdi(i32 1)
241+
%4 = insertelement <3 x i64> %2, i64 %3, i32 1
242+
%5 = call spir_func i64 @_Z33__spirv_BuiltInGlobalInvocationIdi(i32 2)
243+
%6 = insertelement <3 x i64> %4, i64 %5, i32 2
244+
%7 = extractelement <3 x i64> %6, i32 1
245+
; In case some actions are performed with the variable's value in vector form.
246+
247+
SPIR-V builtin variables can also be mapped to LLVM global variables with
248+
unmangled name __spirv_BuiltIn{Name}.
249+
250+
The representation with variables is closer to SPIR-V, so it is easier to
251+
translate from SPIR-V to LLVM and back using it.
252+
Hovewer in languages like OpenCL the functionality covered by SPIR-V builtin
253+
variables is usually represented by builtin functions, so it is easier to
254+
translate from/to SPIR-V friendly IR to/from LLVM IR produced from OpenCL-like
255+
source languages. That is why both forms of mapping are supported.
211256

212257
SPIR-V instructions mapped to LLVM metadata
213258
===========================================

0 commit comments

Comments
 (0)