173e0bf6d84cbe7444e9955df16c4d6734ae7715
2 # Copyright (C) 2018 Red Hat
3 # Copyright (C) 2014 Intel Corporation
5 # Permission is hereby granted, free of charge, to any person obtaining a
6 # copy of this software and associated documentation files (the "Software"),
7 # to deal in the Software without restriction, including without limitation
8 # the rights to use, copy, modify, merge, publish, distribute, sublicense,
9 # and/or sell copies of the Software, and to permit persons to whom the
10 # Software is furnished to do so, subject to the following conditions:
12 # The above copyright notice and this permission notice (including the next
13 # paragraph) shall be included in all copies or substantial portions of the
16 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
19 # THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
21 # FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
25 # This file defines all the available intrinsics in one place.
27 # The Intrinsic class corresponds one-to-one with nir_intrinsic_info
30 class Intrinsic(object):
31 """Class that represents all the information about an intrinsic opcode.
32 NOTE: this must be kept in sync with nir_intrinsic_info.
34 def __init__(self
, name
, src_components
, dest_components
,
35 indices
, flags
, sysval
, bit_sizes
):
38 - name: the intrinsic name
39 - src_components: list of the number of components per src, 0 means
40 vectorized instruction with number of components given in the
41 num_components field in nir_intrinsic_instr.
42 - dest_components: number of destination components, -1 means no
43 dest, 0 means number of components given in num_components field
44 in nir_intrinsic_instr.
45 - indices: list of constant indicies
46 - flags: list of semantic flags
47 - sysval: is this a system-value intrinsic
48 - bit_sizes: allowed dest bit_sizes
50 assert isinstance(name
, str)
51 assert isinstance(src_components
, list)
53 assert isinstance(src_components
[0], int)
54 assert isinstance(dest_components
, int)
55 assert isinstance(indices
, list)
57 assert isinstance(indices
[0], str)
58 assert isinstance(flags
, list)
60 assert isinstance(flags
[0], str)
61 assert isinstance(sysval
, bool)
63 assert isinstance(bit_sizes
[0], int)
66 self
.num_srcs
= len(src_components
)
67 self
.src_components
= src_components
68 self
.has_dest
= (dest_components
>= 0)
69 self
.dest_components
= dest_components
70 self
.num_indices
= len(indices
)
71 self
.indices
= indices
74 self
.bit_sizes
= bit_sizes
80 # A constant 'base' value that is added to an offset src:
81 BASE
= "NIR_INTRINSIC_BASE"
82 # For store instructions, a writemask:
83 WRMASK
= "NIR_INTRINSIC_WRMASK"
84 # The stream-id for GS emit_vertex/end_primitive intrinsics:
85 STREAM_ID
= "NIR_INTRINSIC_STREAM_ID"
86 # The clip-plane id for load_user_clip_plane intrinsics:
87 UCP_ID
= "NIR_INTRINSIC_UCP_ID"
88 # The amount of data, starting from BASE, that this instruction
89 # may access. This is used to provide bounds if the offset is
91 RANGE
= "NIR_INTRINSIC_RANGE"
92 # The vulkan descriptor set binding for vulkan_resource_index
94 DESC_SET
= "NIR_INTRINSIC_DESC_SET"
95 # The vulkan descriptor set binding for vulkan_resource_index
97 BINDING
= "NIR_INTRINSIC_BINDING"
99 COMPONENT
= "NIR_INTRINSIC_COMPONENT"
100 # Interpolation mode (only meaningful for FS inputs)
101 INTERP_MODE
= "NIR_INTRINSIC_INTERP_MODE"
102 # A binary nir_op to use when performing a reduction or scan operation
103 REDUCTION_OP
= "NIR_INTRINSIC_REDUCTION_OP"
104 # Cluster size for reduction operations
105 CLUSTER_SIZE
= "NIR_INTRINSIC_CLUSTER_SIZE"
106 # Parameter index for a load_param intrinsic
107 PARAM_IDX
= "NIR_INTRINSIC_PARAM_IDX"
108 # Image dimensionality for image intrinsics
109 IMAGE_DIM
= "NIR_INTRINSIC_IMAGE_DIM"
110 # Non-zero if we are accessing an array image
111 IMAGE_ARRAY
= "NIR_INTRINSIC_IMAGE_ARRAY"
112 # Access qualifiers for image and memory access intrinsics
113 ACCESS
= "NIR_INTRINSIC_ACCESS"
114 # Image format for image intrinsics
115 FORMAT
= "NIR_INTRINSIC_FORMAT"
116 # Offset or address alignment
117 ALIGN_MUL
= "NIR_INTRINSIC_ALIGN_MUL"
118 ALIGN_OFFSET
= "NIR_INTRINSIC_ALIGN_OFFSET"
119 # The vulkan descriptor type for vulkan_resource_index
120 DESC_TYPE
= "NIR_INTRINSIC_DESC_TYPE"
126 CAN_ELIMINATE
= "NIR_INTRINSIC_CAN_ELIMINATE"
127 CAN_REORDER
= "NIR_INTRINSIC_CAN_REORDER"
131 def intrinsic(name
, src_comp
=[], dest_comp
=-1, indices
=[],
132 flags
=[], sysval
=False, bit_sizes
=[]):
133 assert name
not in INTR_OPCODES
134 INTR_OPCODES
[name
] = Intrinsic(name
, src_comp
, dest_comp
,
135 indices
, flags
, sysval
, bit_sizes
)
137 intrinsic("nop", flags
=[CAN_ELIMINATE
])
139 intrinsic("load_param", dest_comp
=0, indices
=[PARAM_IDX
], flags
=[CAN_ELIMINATE
])
141 intrinsic("load_deref", dest_comp
=0, src_comp
=[-1],
142 indices
=[ACCESS
], flags
=[CAN_ELIMINATE
])
143 intrinsic("store_deref", src_comp
=[-1, 0], indices
=[WRMASK
, ACCESS
])
144 intrinsic("copy_deref", src_comp
=[-1, -1])
146 # Interpolation of input. The interp_deref_at* intrinsics are similar to the
147 # load_var intrinsic acting on a shader input except that they interpolate the
148 # input differently. The at_sample and at_offset intrinsics take an
149 # additional source that is an integer sample id or a vec2 position offset
152 intrinsic("interp_deref_at_centroid", dest_comp
=0, src_comp
=[1],
153 flags
=[ CAN_ELIMINATE
, CAN_REORDER
])
154 intrinsic("interp_deref_at_sample", src_comp
=[1, 1], dest_comp
=0,
155 flags
=[CAN_ELIMINATE
, CAN_REORDER
])
156 intrinsic("interp_deref_at_offset", src_comp
=[1, 2], dest_comp
=0,
157 flags
=[CAN_ELIMINATE
, CAN_REORDER
])
159 # Gets the length of an unsized array at the end of a buffer
160 intrinsic("deref_buffer_array_length", src_comp
=[-1], dest_comp
=1,
161 flags
=[CAN_ELIMINATE
, CAN_REORDER
])
163 # Ask the driver for the size of a given buffer. It takes the buffer index
165 intrinsic("get_buffer_size", src_comp
=[-1], dest_comp
=1,
166 flags
=[CAN_ELIMINATE
, CAN_REORDER
])
168 # a barrier is an intrinsic with no inputs/outputs but which can't be moved
169 # around/optimized in general
176 # Memory barrier with semantics analogous to the memoryBarrier() GLSL
178 barrier("memory_barrier")
180 # Shader clock intrinsic with semantics analogous to the clock2x32ARB()
182 # The latter can be used as code motion barrier, which is currently not
184 intrinsic("shader_clock", dest_comp
=2, flags
=[CAN_ELIMINATE
])
186 # Shader ballot intrinsics with semantics analogous to the
189 # readInvocationARB()
190 # readFirstInvocationARB()
192 # GLSL functions from ARB_shader_ballot.
193 intrinsic("ballot", src_comp
=[1], dest_comp
=0, flags
=[CAN_ELIMINATE
])
194 intrinsic("read_invocation", src_comp
=[0, 1], dest_comp
=0, flags
=[CAN_ELIMINATE
])
195 intrinsic("read_first_invocation", src_comp
=[0], dest_comp
=0, flags
=[CAN_ELIMINATE
])
197 # Additional SPIR-V ballot intrinsics
199 # These correspond to the SPIR-V opcodes
201 # OpGroupUniformElect
202 # OpSubgroupFirstInvocationKHR
203 intrinsic("elect", dest_comp
=1, flags
=[CAN_ELIMINATE
])
204 intrinsic("first_invocation", dest_comp
=1, flags
=[CAN_ELIMINATE
])
206 # Memory barrier with semantics analogous to the compute shader
207 # groupMemoryBarrier(), memoryBarrierAtomicCounter(), memoryBarrierBuffer(),
208 # memoryBarrierImage() and memoryBarrierShared() GLSL intrinsics.
209 barrier("group_memory_barrier")
210 barrier("memory_barrier_atomic_counter")
211 barrier("memory_barrier_buffer")
212 barrier("memory_barrier_image")
213 barrier("memory_barrier_shared")
214 barrier("begin_invocation_interlock")
215 barrier("end_invocation_interlock")
217 # A conditional discard, with a single boolean source.
218 intrinsic("discard_if", src_comp
=[1])
220 # ARB_shader_group_vote intrinsics
221 intrinsic("vote_any", src_comp
=[1], dest_comp
=1, flags
=[CAN_ELIMINATE
])
222 intrinsic("vote_all", src_comp
=[1], dest_comp
=1, flags
=[CAN_ELIMINATE
])
223 intrinsic("vote_feq", src_comp
=[0], dest_comp
=1, flags
=[CAN_ELIMINATE
])
224 intrinsic("vote_ieq", src_comp
=[0], dest_comp
=1, flags
=[CAN_ELIMINATE
])
226 # Ballot ALU operations from SPIR-V.
228 # These operations work like their ALU counterparts except that the operate
229 # on a uvec4 which is treated as a 128bit integer. Also, they are, in
230 # general, free to ignore any bits which are above the subgroup size.
231 intrinsic("ballot_bitfield_extract", src_comp
=[4, 1], dest_comp
=1, flags
=[CAN_ELIMINATE
])
232 intrinsic("ballot_bit_count_reduce", src_comp
=[4], dest_comp
=1, flags
=[CAN_ELIMINATE
])
233 intrinsic("ballot_bit_count_inclusive", src_comp
=[4], dest_comp
=1, flags
=[CAN_ELIMINATE
])
234 intrinsic("ballot_bit_count_exclusive", src_comp
=[4], dest_comp
=1, flags
=[CAN_ELIMINATE
])
235 intrinsic("ballot_find_lsb", src_comp
=[4], dest_comp
=1, flags
=[CAN_ELIMINATE
])
236 intrinsic("ballot_find_msb", src_comp
=[4], dest_comp
=1, flags
=[CAN_ELIMINATE
])
238 # Shuffle operations from SPIR-V.
239 intrinsic("shuffle", src_comp
=[0, 1], dest_comp
=0, flags
=[CAN_ELIMINATE
])
240 intrinsic("shuffle_xor", src_comp
=[0, 1], dest_comp
=0, flags
=[CAN_ELIMINATE
])
241 intrinsic("shuffle_up", src_comp
=[0, 1], dest_comp
=0, flags
=[CAN_ELIMINATE
])
242 intrinsic("shuffle_down", src_comp
=[0, 1], dest_comp
=0, flags
=[CAN_ELIMINATE
])
244 # Quad operations from SPIR-V.
245 intrinsic("quad_broadcast", src_comp
=[0, 1], dest_comp
=0, flags
=[CAN_ELIMINATE
])
246 intrinsic("quad_swap_horizontal", src_comp
=[0], dest_comp
=0, flags
=[CAN_ELIMINATE
])
247 intrinsic("quad_swap_vertical", src_comp
=[0], dest_comp
=0, flags
=[CAN_ELIMINATE
])
248 intrinsic("quad_swap_diagonal", src_comp
=[0], dest_comp
=0, flags
=[CAN_ELIMINATE
])
250 intrinsic("reduce", src_comp
=[0], dest_comp
=0, indices
=[REDUCTION_OP
, CLUSTER_SIZE
],
251 flags
=[CAN_ELIMINATE
])
252 intrinsic("inclusive_scan", src_comp
=[0], dest_comp
=0, indices
=[REDUCTION_OP
],
253 flags
=[CAN_ELIMINATE
])
254 intrinsic("exclusive_scan", src_comp
=[0], dest_comp
=0, indices
=[REDUCTION_OP
],
255 flags
=[CAN_ELIMINATE
])
257 # Basic Geometry Shader intrinsics.
259 # emit_vertex implements GLSL's EmitStreamVertex() built-in. It takes a single
260 # index, which is the stream ID to write to.
262 # end_primitive implements GLSL's EndPrimitive() built-in.
263 intrinsic("emit_vertex", indices
=[STREAM_ID
])
264 intrinsic("end_primitive", indices
=[STREAM_ID
])
266 # Geometry Shader intrinsics with a vertex count.
268 # Alternatively, drivers may implement these intrinsics, and use
269 # nir_lower_gs_intrinsics() to convert from the basic intrinsics.
271 # These maintain a count of the number of vertices emitted, as an additional
272 # unsigned integer source.
273 intrinsic("emit_vertex_with_counter", src_comp
=[1], indices
=[STREAM_ID
])
274 intrinsic("end_primitive_with_counter", src_comp
=[1], indices
=[STREAM_ID
])
275 intrinsic("set_vertex_count", src_comp
=[1])
279 # The *_var variants take an atomic_uint nir_variable, while the other,
280 # lowered, variants take a constant buffer index and register offset.
282 def atomic(name
, flags
=[]):
283 intrinsic(name
+ "_deref", src_comp
=[-1], dest_comp
=1, flags
=flags
)
284 intrinsic(name
, src_comp
=[1], dest_comp
=1, indices
=[BASE
], flags
=flags
)
287 intrinsic(name
+ "_deref", src_comp
=[-1, 1], dest_comp
=1)
288 intrinsic(name
, src_comp
=[1, 1], dest_comp
=1, indices
=[BASE
])
291 intrinsic(name
+ "_deref", src_comp
=[-1, 1, 1], dest_comp
=1)
292 intrinsic(name
, src_comp
=[1, 1, 1], dest_comp
=1, indices
=[BASE
])
294 atomic("atomic_counter_inc")
295 atomic("atomic_counter_pre_dec")
296 atomic("atomic_counter_post_dec")
297 atomic("atomic_counter_read", flags
=[CAN_ELIMINATE
])
298 atomic2("atomic_counter_add")
299 atomic2("atomic_counter_min")
300 atomic2("atomic_counter_max")
301 atomic2("atomic_counter_and")
302 atomic2("atomic_counter_or")
303 atomic2("atomic_counter_xor")
304 atomic2("atomic_counter_exchange")
305 atomic3("atomic_counter_comp_swap")
307 # Image load, store and atomic intrinsics.
309 # All image intrinsics come in three versions. One which take an image target
310 # passed as a deref chain as the first source, one which takes an index as the
311 # first source, and one which takes a bindless handle as the first source.
312 # In the first version, the image variable contains the memory and layout
313 # qualifiers that influence the semantics of the intrinsic. In the second and
314 # third, the image format and access qualifiers are provided as constant
317 # All image intrinsics take a four-coordinate vector and a sample index as
318 # 2nd and 3rd sources, determining the location within the image that will be
319 # accessed by the intrinsic. Components not applicable to the image target
320 # in use are undefined. Image store takes an additional four-component
321 # argument with the value to be written, and image atomic operations take
322 # either one or two additional scalar arguments with the same meaning as in
323 # the ARB_shader_image_load_store specification.
324 def image(name
, src_comp
=[], **kwargs
):
325 intrinsic("image_deref_" + name
, src_comp
=[1] + src_comp
, **kwargs
)
326 intrinsic("image_" + name
, src_comp
=[1] + src_comp
,
327 indices
=[IMAGE_DIM
, IMAGE_ARRAY
, FORMAT
, ACCESS
], **kwargs
)
328 intrinsic("bindless_image_" + name
, src_comp
=[1] + src_comp
,
329 indices
=[IMAGE_DIM
, IMAGE_ARRAY
, FORMAT
, ACCESS
], **kwargs
)
331 image("load", src_comp
=[4, 1], dest_comp
=0, flags
=[CAN_ELIMINATE
])
332 image("store", src_comp
=[4, 1, 0])
333 image("atomic_add", src_comp
=[4, 1, 1], dest_comp
=1)
334 image("atomic_min", src_comp
=[4, 1, 1], dest_comp
=1)
335 image("atomic_max", src_comp
=[4, 1, 1], dest_comp
=1)
336 image("atomic_and", src_comp
=[4, 1, 1], dest_comp
=1)
337 image("atomic_or", src_comp
=[4, 1, 1], dest_comp
=1)
338 image("atomic_xor", src_comp
=[4, 1, 1], dest_comp
=1)
339 image("atomic_exchange", src_comp
=[4, 1, 1], dest_comp
=1)
340 image("atomic_comp_swap", src_comp
=[4, 1, 1, 1], dest_comp
=1)
341 image("atomic_fadd", src_comp
=[1, 4, 1, 1], dest_comp
=1)
342 image("size", dest_comp
=0, flags
=[CAN_ELIMINATE
, CAN_REORDER
])
343 image("samples", dest_comp
=1, flags
=[CAN_ELIMINATE
, CAN_REORDER
])
345 # Intel-specific query for loading from the brw_image_param struct passed
346 # into the shader as a uniform. The variable is a deref to the image
347 # variable. The const index specifies which of the six parameters to load.
348 intrinsic("image_deref_load_param_intel", src_comp
=[1], dest_comp
=0,
349 indices
=[BASE
], flags
=[CAN_ELIMINATE
, CAN_REORDER
])
350 image("load_raw_intel", src_comp
=[1], dest_comp
=0,
351 flags
=[CAN_ELIMINATE
])
352 image("store_raw_intel", src_comp
=[1, 0])
354 # Vulkan descriptor set intrinsics
356 # The Vulkan API uses a different binding model from GL. In the Vulkan
357 # API, all external resources are represented by a tuple:
359 # (descriptor set, binding, array index)
361 # where the array index is the only thing allowed to be indirect. The
362 # vulkan_surface_index intrinsic takes the descriptor set and binding as
363 # its first two indices and the array index as its source. The third
364 # index is a nir_variable_mode in case that's useful to the backend.
366 # The intended usage is that the shader will call vulkan_surface_index to
367 # get an index and then pass that as the buffer index ubo/ssbo calls.
369 # The vulkan_resource_reindex intrinsic takes a resource index in src0
370 # (the result of a vulkan_resource_index or vulkan_resource_reindex) which
371 # corresponds to the tuple (set, binding, index) and computes an index
372 # corresponding to tuple (set, binding, idx + src1).
373 intrinsic("vulkan_resource_index", src_comp
=[1], dest_comp
=0,
374 indices
=[DESC_SET
, BINDING
, DESC_TYPE
],
375 flags
=[CAN_ELIMINATE
, CAN_REORDER
])
376 intrinsic("vulkan_resource_reindex", src_comp
=[0, 1], dest_comp
=0,
377 indices
=[DESC_TYPE
], flags
=[CAN_ELIMINATE
, CAN_REORDER
])
378 intrinsic("load_vulkan_descriptor", src_comp
=[-1], dest_comp
=0,
379 indices
=[DESC_TYPE
], flags
=[CAN_ELIMINATE
, CAN_REORDER
])
381 # variable atomic intrinsics
383 # All of these variable atomic memory operations read a value from memory,
384 # compute a new value using one of the operations below, write the new value
385 # to memory, and return the original value read.
387 # All operations take 2 sources except CompSwap that takes 3. These sources
390 # 0: A deref to the memory on which to perform the atomic
391 # 1: The data parameter to the atomic function (i.e. the value to add
392 # in shared_atomic_add, etc).
393 # 2: For CompSwap only: the second data parameter.
394 intrinsic("deref_atomic_add", src_comp
=[-1, 1], dest_comp
=1, indices
=[ACCESS
])
395 intrinsic("deref_atomic_imin", src_comp
=[-1, 1], dest_comp
=1, indices
=[ACCESS
])
396 intrinsic("deref_atomic_umin", src_comp
=[-1, 1], dest_comp
=1, indices
=[ACCESS
])
397 intrinsic("deref_atomic_imax", src_comp
=[-1, 1], dest_comp
=1, indices
=[ACCESS
])
398 intrinsic("deref_atomic_umax", src_comp
=[-1, 1], dest_comp
=1, indices
=[ACCESS
])
399 intrinsic("deref_atomic_and", src_comp
=[-1, 1], dest_comp
=1, indices
=[ACCESS
])
400 intrinsic("deref_atomic_or", src_comp
=[-1, 1], dest_comp
=1, indices
=[ACCESS
])
401 intrinsic("deref_atomic_xor", src_comp
=[-1, 1], dest_comp
=1, indices
=[ACCESS
])
402 intrinsic("deref_atomic_exchange", src_comp
=[-1, 1], dest_comp
=1, indices
=[ACCESS
])
403 intrinsic("deref_atomic_comp_swap", src_comp
=[-1, 1, 1], dest_comp
=1, indices
=[ACCESS
])
404 intrinsic("deref_atomic_fadd", src_comp
=[-1, 1], dest_comp
=1, indices
=[ACCESS
])
405 intrinsic("deref_atomic_fmin", src_comp
=[-1, 1], dest_comp
=1, indices
=[ACCESS
])
406 intrinsic("deref_atomic_fmax", src_comp
=[-1, 1], dest_comp
=1, indices
=[ACCESS
])
407 intrinsic("deref_atomic_fcomp_swap", src_comp
=[-1, 1, 1], dest_comp
=1, indices
=[ACCESS
])
409 # SSBO atomic intrinsics
411 # All of the SSBO atomic memory operations read a value from memory,
412 # compute a new value using one of the operations below, write the new
413 # value to memory, and return the original value read.
415 # All operations take 3 sources except CompSwap that takes 4. These
418 # 0: The SSBO buffer index.
419 # 1: The offset into the SSBO buffer of the variable that the atomic
420 # operation will operate on.
421 # 2: The data parameter to the atomic function (i.e. the value to add
422 # in ssbo_atomic_add, etc).
423 # 3: For CompSwap only: the second data parameter.
424 intrinsic("ssbo_atomic_add", src_comp
=[1, 1, 1], dest_comp
=1, indices
=[ACCESS
])
425 intrinsic("ssbo_atomic_imin", src_comp
=[1, 1, 1], dest_comp
=1, indices
=[ACCESS
])
426 intrinsic("ssbo_atomic_umin", src_comp
=[1, 1, 1], dest_comp
=1, indices
=[ACCESS
])
427 intrinsic("ssbo_atomic_imax", src_comp
=[1, 1, 1], dest_comp
=1, indices
=[ACCESS
])
428 intrinsic("ssbo_atomic_umax", src_comp
=[1, 1, 1], dest_comp
=1, indices
=[ACCESS
])
429 intrinsic("ssbo_atomic_and", src_comp
=[1, 1, 1], dest_comp
=1, indices
=[ACCESS
])
430 intrinsic("ssbo_atomic_or", src_comp
=[1, 1, 1], dest_comp
=1, indices
=[ACCESS
])
431 intrinsic("ssbo_atomic_xor", src_comp
=[1, 1, 1], dest_comp
=1, indices
=[ACCESS
])
432 intrinsic("ssbo_atomic_exchange", src_comp
=[1, 1, 1], dest_comp
=1, indices
=[ACCESS
])
433 intrinsic("ssbo_atomic_comp_swap", src_comp
=[1, 1, 1, 1], dest_comp
=1, indices
=[ACCESS
])
434 intrinsic("ssbo_atomic_fadd", src_comp
=[1, 1, 1], dest_comp
=1, indices
=[ACCESS
])
435 intrinsic("ssbo_atomic_fmin", src_comp
=[1, 1, 1], dest_comp
=1, indices
=[ACCESS
])
436 intrinsic("ssbo_atomic_fmax", src_comp
=[1, 1, 1], dest_comp
=1, indices
=[ACCESS
])
437 intrinsic("ssbo_atomic_fcomp_swap", src_comp
=[1, 1, 1, 1], dest_comp
=1, indices
=[ACCESS
])
439 # CS shared variable atomic intrinsics
441 # All of the shared variable atomic memory operations read a value from
442 # memory, compute a new value using one of the operations below, write the
443 # new value to memory, and return the original value read.
445 # All operations take 2 sources except CompSwap that takes 3. These
448 # 0: The offset into the shared variable storage region that the atomic
449 # operation will operate on.
450 # 1: The data parameter to the atomic function (i.e. the value to add
451 # in shared_atomic_add, etc).
452 # 2: For CompSwap only: the second data parameter.
453 intrinsic("shared_atomic_add", src_comp
=[1, 1], dest_comp
=1, indices
=[BASE
])
454 intrinsic("shared_atomic_imin", src_comp
=[1, 1], dest_comp
=1, indices
=[BASE
])
455 intrinsic("shared_atomic_umin", src_comp
=[1, 1], dest_comp
=1, indices
=[BASE
])
456 intrinsic("shared_atomic_imax", src_comp
=[1, 1], dest_comp
=1, indices
=[BASE
])
457 intrinsic("shared_atomic_umax", src_comp
=[1, 1], dest_comp
=1, indices
=[BASE
])
458 intrinsic("shared_atomic_and", src_comp
=[1, 1], dest_comp
=1, indices
=[BASE
])
459 intrinsic("shared_atomic_or", src_comp
=[1, 1], dest_comp
=1, indices
=[BASE
])
460 intrinsic("shared_atomic_xor", src_comp
=[1, 1], dest_comp
=1, indices
=[BASE
])
461 intrinsic("shared_atomic_exchange", src_comp
=[1, 1], dest_comp
=1, indices
=[BASE
])
462 intrinsic("shared_atomic_comp_swap", src_comp
=[1, 1, 1], dest_comp
=1, indices
=[BASE
])
463 intrinsic("shared_atomic_fadd", src_comp
=[1, 1], dest_comp
=1, indices
=[BASE
])
464 intrinsic("shared_atomic_fmin", src_comp
=[1, 1], dest_comp
=1, indices
=[BASE
])
465 intrinsic("shared_atomic_fmax", src_comp
=[1, 1], dest_comp
=1, indices
=[BASE
])
466 intrinsic("shared_atomic_fcomp_swap", src_comp
=[1, 1, 1], dest_comp
=1, indices
=[BASE
])
468 # Global atomic intrinsics
470 # All of the shared variable atomic memory operations read a value from
471 # memory, compute a new value using one of the operations below, write the
472 # new value to memory, and return the original value read.
474 # All operations take 2 sources except CompSwap that takes 3. These
477 # 0: The memory address that the atomic operation will operate on.
478 # 1: The data parameter to the atomic function (i.e. the value to add
479 # in shared_atomic_add, etc).
480 # 2: For CompSwap only: the second data parameter.
481 intrinsic("global_atomic_add", src_comp
=[1, 1], dest_comp
=1, indices
=[BASE
])
482 intrinsic("global_atomic_imin", src_comp
=[1, 1], dest_comp
=1, indices
=[BASE
])
483 intrinsic("global_atomic_umin", src_comp
=[1, 1], dest_comp
=1, indices
=[BASE
])
484 intrinsic("global_atomic_imax", src_comp
=[1, 1], dest_comp
=1, indices
=[BASE
])
485 intrinsic("global_atomic_umax", src_comp
=[1, 1], dest_comp
=1, indices
=[BASE
])
486 intrinsic("global_atomic_and", src_comp
=[1, 1], dest_comp
=1, indices
=[BASE
])
487 intrinsic("global_atomic_or", src_comp
=[1, 1], dest_comp
=1, indices
=[BASE
])
488 intrinsic("global_atomic_xor", src_comp
=[1, 1], dest_comp
=1, indices
=[BASE
])
489 intrinsic("global_atomic_exchange", src_comp
=[1, 1], dest_comp
=1, indices
=[BASE
])
490 intrinsic("global_atomic_comp_swap", src_comp
=[1, 1, 1], dest_comp
=1, indices
=[BASE
])
491 intrinsic("global_atomic_fadd", src_comp
=[1, 1], dest_comp
=1, indices
=[BASE
])
492 intrinsic("global_atomic_fmin", src_comp
=[1, 1], dest_comp
=1, indices
=[BASE
])
493 intrinsic("global_atomic_fmax", src_comp
=[1, 1], dest_comp
=1, indices
=[BASE
])
494 intrinsic("global_atomic_fcomp_swap", src_comp
=[1, 1, 1], dest_comp
=1, indices
=[BASE
])
496 def system_value(name
, dest_comp
, indices
=[], bit_sizes
=[32]):
497 intrinsic("load_" + name
, [], dest_comp
, indices
,
498 flags
=[CAN_ELIMINATE
, CAN_REORDER
], sysval
=True,
501 system_value("frag_coord", 4)
502 system_value("front_face", 1, bit_sizes
=[1, 32])
503 system_value("vertex_id", 1)
504 system_value("vertex_id_zero_base", 1)
505 system_value("first_vertex", 1)
506 system_value("is_indexed_draw", 1)
507 system_value("base_vertex", 1)
508 system_value("instance_id", 1)
509 system_value("base_instance", 1)
510 system_value("draw_id", 1)
511 system_value("sample_id", 1)
512 # sample_id_no_per_sample is like sample_id but does not imply per-
513 # sample shading. See the lower_helper_invocation option.
514 system_value("sample_id_no_per_sample", 1)
515 system_value("sample_pos", 2)
516 system_value("sample_mask_in", 1)
517 system_value("primitive_id", 1)
518 system_value("invocation_id", 1)
519 system_value("tess_coord", 3)
520 system_value("tess_level_outer", 4)
521 system_value("tess_level_inner", 2)
522 system_value("patch_vertices_in", 1)
523 system_value("local_invocation_id", 3)
524 system_value("local_invocation_index", 1)
525 system_value("work_group_id", 3)
526 system_value("user_clip_plane", 4, indices
=[UCP_ID
])
527 system_value("num_work_groups", 3)
528 system_value("helper_invocation", 1, bit_sizes
=[1, 32])
529 system_value("alpha_ref_float", 1)
530 system_value("layer_id", 1)
531 system_value("view_index", 1)
532 system_value("subgroup_size", 1)
533 system_value("subgroup_invocation", 1)
534 system_value("subgroup_eq_mask", 0, bit_sizes
=[32, 64])
535 system_value("subgroup_ge_mask", 0, bit_sizes
=[32, 64])
536 system_value("subgroup_gt_mask", 0, bit_sizes
=[32, 64])
537 system_value("subgroup_le_mask", 0, bit_sizes
=[32, 64])
538 system_value("subgroup_lt_mask", 0, bit_sizes
=[32, 64])
539 system_value("num_subgroups", 1)
540 system_value("subgroup_id", 1)
541 system_value("local_group_size", 3)
542 system_value("global_invocation_id", 3, bit_sizes
=[32, 64])
543 system_value("global_invocation_index", 1, bit_sizes
=[32, 64])
544 system_value("work_dim", 1)
545 # Driver-specific viewport scale/offset parameters.
547 # VC4 and V3D need to emit a scaled version of the position in the vertex
548 # shaders for binning, and having system values lets us move the math for that
551 # Panfrost needs to implement all coordinate transformation in the
552 # vertex shader; system values allow us to share this routine in NIR.
553 system_value("viewport_x_scale", 1)
554 system_value("viewport_y_scale", 1)
555 system_value("viewport_z_scale", 1)
556 system_value("viewport_z_offset", 1)
557 system_value("viewport_scale", 3)
558 system_value("viewport_offset", 3)
560 # Blend constant color values. Float values are clamped.#
561 system_value("blend_const_color_r_float", 1)
562 system_value("blend_const_color_g_float", 1)
563 system_value("blend_const_color_b_float", 1)
564 system_value("blend_const_color_a_float", 1)
565 system_value("blend_const_color_rgba8888_unorm", 1)
566 system_value("blend_const_color_aaaa8888_unorm", 1)
568 # Barycentric coordinate intrinsics.
570 # These set up the barycentric coordinates for a particular interpolation.
571 # The first three are for the simple cases: pixel, centroid, or per-sample
572 # (at gl_SampleID). The next two handle interpolating at a specified
573 # sample location, or interpolating with a vec2 offset,
575 # The interp_mode index should be either the INTERP_MODE_SMOOTH or
576 # INTERP_MODE_NOPERSPECTIVE enum values.
578 # The vec2 value produced by these intrinsics is intended for use as the
579 # barycoord source of a load_interpolated_input intrinsic.
581 def barycentric(name
, src_comp
=[]):
582 intrinsic("load_barycentric_" + name
, src_comp
=src_comp
, dest_comp
=2,
583 indices
=[INTERP_MODE
], flags
=[CAN_ELIMINATE
, CAN_REORDER
])
587 barycentric("centroid")
588 barycentric("sample")
589 # src[] = { sample_id }.
590 barycentric("at_sample", [1])
591 # src[] = { offset.xy }.
592 barycentric("at_offset", [2])
594 # Load operations pull data from some piece of GPU memory. All load
595 # operations operate in terms of offsets into some piece of theoretical
596 # memory. Loads from externally visible memory (UBO and SSBO) simply take a
597 # byte offset as a source. Loads from opaque memory (uniforms, inputs, etc.)
598 # take a base+offset pair where the base (const_index[0]) gives the location
599 # of the start of the variable being loaded and and the offset source is a
600 # offset into that variable.
602 # Uniform load operations have a second "range" index that specifies the
603 # range (starting at base) of the data from which we are loading. If
604 # const_index[1] == 0, then the range is unknown.
606 # Some load operations such as UBO/SSBO load and per_vertex loads take an
607 # additional source to specify which UBO/SSBO/vertex to load from.
609 # The exact address type depends on the lowering pass that generates the
610 # load/store intrinsics. Typically, this is vec4 units for things such as
611 # varying slots and float units for fragment shader inputs. UBO and SSBO
612 # offsets are always in bytes.
614 def load(name
, num_srcs
, indices
=[], flags
=[]):
615 intrinsic("load_" + name
, [1] * num_srcs
, dest_comp
=0, indices
=indices
,
618 # src[] = { offset }.
619 load("uniform", 1, [BASE
, RANGE
], [CAN_ELIMINATE
, CAN_REORDER
])
620 # src[] = { buffer_index, offset }.
621 load("ubo", 2, [ACCESS
, ALIGN_MUL
, ALIGN_OFFSET
], flags
=[CAN_ELIMINATE
, CAN_REORDER
])
622 # src[] = { offset }.
623 load("input", 1, [BASE
, COMPONENT
], [CAN_ELIMINATE
, CAN_REORDER
])
624 # src[] = { vertex, offset }.
625 load("per_vertex_input", 2, [BASE
, COMPONENT
], [CAN_ELIMINATE
, CAN_REORDER
])
626 # src[] = { barycoord, offset }.
627 intrinsic("load_interpolated_input", src_comp
=[2, 1], dest_comp
=0,
628 indices
=[BASE
, COMPONENT
], flags
=[CAN_ELIMINATE
, CAN_REORDER
])
630 # src[] = { buffer_index, offset }.
631 load("ssbo", 2, [ACCESS
, ALIGN_MUL
, ALIGN_OFFSET
], [CAN_ELIMINATE
])
632 # src[] = { offset }.
633 load("output", 1, [BASE
, COMPONENT
], flags
=[CAN_ELIMINATE
])
634 # src[] = { vertex, offset }.
635 load("per_vertex_output", 2, [BASE
, COMPONENT
], [CAN_ELIMINATE
])
636 # src[] = { offset }.
637 load("shared", 1, [BASE
, ALIGN_MUL
, ALIGN_OFFSET
], [CAN_ELIMINATE
])
638 # src[] = { offset }.
639 load("push_constant", 1, [BASE
, RANGE
], [CAN_ELIMINATE
, CAN_REORDER
])
640 # src[] = { offset }.
641 load("constant", 1, [BASE
, RANGE
], [CAN_ELIMINATE
, CAN_REORDER
])
642 # src[] = { address }.
643 load("global", 1, [ACCESS
, ALIGN_MUL
, ALIGN_OFFSET
], [CAN_ELIMINATE
])
644 # src[] = { address }.
645 load("kernel_input", 1, [BASE
, RANGE
, ALIGN_MUL
, ALIGN_OFFSET
], [CAN_ELIMINATE
, CAN_REORDER
])
647 # Stores work the same way as loads, except now the first source is the value
648 # to store and the second (and possibly third) source specify where to store
649 # the value. SSBO and shared memory stores also have a write mask as
652 def store(name
, num_srcs
, indices
=[], flags
=[]):
653 intrinsic("store_" + name
, [0] + ([1] * (num_srcs
- 1)), indices
=indices
, flags
=flags
)
655 # src[] = { value, offset }.
656 store("output", 2, [BASE
, WRMASK
, COMPONENT
])
657 # src[] = { value, vertex, offset }.
658 store("per_vertex_output", 3, [BASE
, WRMASK
, COMPONENT
])
659 # src[] = { value, block_index, offset }
660 store("ssbo", 3, [WRMASK
, ACCESS
, ALIGN_MUL
, ALIGN_OFFSET
])
661 # src[] = { value, offset }.
662 store("shared", 2, [BASE
, WRMASK
, ALIGN_MUL
, ALIGN_OFFSET
])
663 # src[] = { value, address }.
664 store("global", 2, [WRMASK
, ACCESS
, ALIGN_MUL
, ALIGN_OFFSET
])
667 # IR3-specific version of most SSBO intrinsics. The only different
668 # compare to the originals is that they add an extra source to hold
669 # the dword-offset, which is needed by the backend code apart from
670 # the byte-offset already provided by NIR in one of the sources.
672 # NIR lowering pass 'ir3_nir_lower_io_offset' will replace the
673 # original SSBO intrinsics by these, placing the computed
674 # dword-offset always in the last source.
676 # The float versions are not handled because those are not supported
678 intrinsic("store_ssbo_ir3", src_comp
=[0, 1, 1, 1],
679 indices
=[WRMASK
, ACCESS
, ALIGN_MUL
, ALIGN_OFFSET
])
680 intrinsic("load_ssbo_ir3", src_comp
=[1, 1, 1], dest_comp
=0,
681 indices
=[ACCESS
, ALIGN_MUL
, ALIGN_OFFSET
], flags
=[CAN_ELIMINATE
])
682 intrinsic("ssbo_atomic_add_ir3", src_comp
=[1, 1, 1, 1], dest_comp
=1)
683 intrinsic("ssbo_atomic_imin_ir3", src_comp
=[1, 1, 1, 1], dest_comp
=1)
684 intrinsic("ssbo_atomic_umin_ir3", src_comp
=[1, 1, 1, 1], dest_comp
=1)
685 intrinsic("ssbo_atomic_imax_ir3", src_comp
=[1, 1, 1, 1], dest_comp
=1)
686 intrinsic("ssbo_atomic_umax_ir3", src_comp
=[1, 1, 1, 1], dest_comp
=1)
687 intrinsic("ssbo_atomic_and_ir3", src_comp
=[1, 1, 1, 1], dest_comp
=1)
688 intrinsic("ssbo_atomic_or_ir3", src_comp
=[1, 1, 1, 1], dest_comp
=1)
689 intrinsic("ssbo_atomic_xor_ir3", src_comp
=[1, 1, 1, 1], dest_comp
=1)
690 intrinsic("ssbo_atomic_exchange_ir3", src_comp
=[1, 1, 1, 1], dest_comp
=1)
691 intrinsic("ssbo_atomic_comp_swap_ir3", src_comp
=[1, 1, 1, 1, 1], dest_comp
=1)