2 * Copyright © 2014 Intel Corporation
4 * Permission is hereby granted, free of charge, to any person obtaining a
5 * copy of this software and associated documentation files (the "Software"),
6 * to deal in the Software without restriction, including without limitation
7 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
8 * and/or sell copies of the Software, and to permit persons to whom the
9 * Software is furnished to do so, subject to the following conditions:
11 * The above copyright notice and this permission notice (including the next
12 * paragraph) shall be included in all copies or substantial portions of the
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
18 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
24 * Connor Abbott (cwabbott0@gmail.com)
25 * Jason Ekstrand (jason@jlekstrand.net)
30 * This lowering pass converts references to input/output variables with
31 * loads/stores to actual input/output intrinsics.
35 #include "nir_builder.h"
36 #include "nir_deref.h"
38 struct lower_io_state
{
41 int (*type_size
)(const struct glsl_type
*type
, bool);
42 nir_variable_mode modes
;
43 nir_lower_io_options options
;
46 static nir_intrinsic_op
47 ssbo_atomic_for_deref(nir_intrinsic_op deref_op
)
50 #define OP(O) case nir_intrinsic_deref_##O: return nir_intrinsic_ssbo_##O;
67 unreachable("Invalid SSBO atomic");
71 static nir_intrinsic_op
72 global_atomic_for_deref(nir_intrinsic_op deref_op
)
75 #define OP(O) case nir_intrinsic_deref_##O: return nir_intrinsic_global_##O;
92 unreachable("Invalid SSBO atomic");
97 nir_assign_var_locations(struct exec_list
*var_list
, unsigned *size
,
98 int (*type_size
)(const struct glsl_type
*, bool))
100 unsigned location
= 0;
102 nir_foreach_variable(var
, var_list
) {
104 * UBOs have their own address spaces, so don't count them towards the
105 * number of global uniforms
107 if (var
->data
.mode
== nir_var_mem_ubo
|| var
->data
.mode
== nir_var_mem_ssbo
)
110 var
->data
.driver_location
= location
;
111 bool bindless_type_size
= var
->data
.mode
== nir_var_shader_in
||
112 var
->data
.mode
== nir_var_shader_out
||
114 location
+= type_size(var
->type
, bindless_type_size
);
121 * Return true if the given variable is a per-vertex input/output array.
122 * (such as geometry shader inputs).
125 nir_is_per_vertex_io(const nir_variable
*var
, gl_shader_stage stage
)
127 if (var
->data
.patch
|| !glsl_type_is_array(var
->type
))
130 if (var
->data
.mode
== nir_var_shader_in
)
131 return stage
== MESA_SHADER_GEOMETRY
||
132 stage
== MESA_SHADER_TESS_CTRL
||
133 stage
== MESA_SHADER_TESS_EVAL
;
135 if (var
->data
.mode
== nir_var_shader_out
)
136 return stage
== MESA_SHADER_TESS_CTRL
;
142 get_io_offset(nir_builder
*b
, nir_deref_instr
*deref
,
143 nir_ssa_def
**vertex_index
,
144 int (*type_size
)(const struct glsl_type
*, bool),
145 unsigned *component
, bool bts
)
148 nir_deref_path_init(&path
, deref
, NULL
);
150 assert(path
.path
[0]->deref_type
== nir_deref_type_var
);
151 nir_deref_instr
**p
= &path
.path
[1];
153 /* For per-vertex input arrays (i.e. geometry shader inputs), keep the
154 * outermost array index separate. Process the rest normally.
156 if (vertex_index
!= NULL
) {
157 assert((*p
)->deref_type
== nir_deref_type_array
);
158 *vertex_index
= nir_ssa_for_src(b
, (*p
)->arr
.index
, 1);
162 if (path
.path
[0]->var
->data
.compact
) {
163 assert((*p
)->deref_type
== nir_deref_type_array
);
164 assert(glsl_type_is_scalar((*p
)->type
));
166 /* We always lower indirect dereferences for "compact" array vars. */
167 const unsigned index
= nir_src_as_uint((*p
)->arr
.index
);
168 const unsigned total_offset
= *component
+ index
;
169 const unsigned slot_offset
= total_offset
/ 4;
170 *component
= total_offset
% 4;
171 return nir_imm_int(b
, type_size(glsl_vec4_type(), bts
) * slot_offset
);
174 /* Just emit code and let constant-folding go to town */
175 nir_ssa_def
*offset
= nir_imm_int(b
, 0);
178 if ((*p
)->deref_type
== nir_deref_type_array
) {
179 unsigned size
= type_size((*p
)->type
, bts
);
182 nir_imul_imm(b
, nir_ssa_for_src(b
, (*p
)->arr
.index
, 1), size
);
184 offset
= nir_iadd(b
, offset
, mul
);
185 } else if ((*p
)->deref_type
== nir_deref_type_struct
) {
186 /* p starts at path[1], so this is safe */
187 nir_deref_instr
*parent
= *(p
- 1);
189 unsigned field_offset
= 0;
190 for (unsigned i
= 0; i
< (*p
)->strct
.index
; i
++) {
191 field_offset
+= type_size(glsl_get_struct_field(parent
->type
, i
), bts
);
193 offset
= nir_iadd_imm(b
, offset
, field_offset
);
195 unreachable("Unsupported deref type");
199 nir_deref_path_finish(&path
);
204 static nir_intrinsic_instr
*
205 lower_load(nir_intrinsic_instr
*intrin
, struct lower_io_state
*state
,
206 nir_ssa_def
*vertex_index
, nir_variable
*var
, nir_ssa_def
*offset
,
209 const nir_shader
*nir
= state
->builder
.shader
;
210 nir_variable_mode mode
= var
->data
.mode
;
211 nir_ssa_def
*barycentric
= NULL
;
215 case nir_var_shader_in
:
216 if (nir
->info
.stage
== MESA_SHADER_FRAGMENT
&&
217 nir
->options
->use_interpolated_input_intrinsics
&&
218 var
->data
.interpolation
!= INTERP_MODE_FLAT
) {
219 assert(vertex_index
== NULL
);
221 nir_intrinsic_op bary_op
;
222 if (var
->data
.sample
||
223 (state
->options
& nir_lower_io_force_sample_interpolation
))
224 bary_op
= nir_intrinsic_load_barycentric_sample
;
225 else if (var
->data
.centroid
)
226 bary_op
= nir_intrinsic_load_barycentric_centroid
;
228 bary_op
= nir_intrinsic_load_barycentric_pixel
;
230 barycentric
= nir_load_barycentric(&state
->builder
, bary_op
,
231 var
->data
.interpolation
);
232 op
= nir_intrinsic_load_interpolated_input
;
234 op
= vertex_index
? nir_intrinsic_load_per_vertex_input
:
235 nir_intrinsic_load_input
;
238 case nir_var_shader_out
:
239 op
= vertex_index
? nir_intrinsic_load_per_vertex_output
:
240 nir_intrinsic_load_output
;
242 case nir_var_uniform
:
243 op
= nir_intrinsic_load_uniform
;
245 case nir_var_mem_shared
:
246 op
= nir_intrinsic_load_shared
;
249 unreachable("Unknown variable mode");
252 nir_intrinsic_instr
*load
=
253 nir_intrinsic_instr_create(state
->builder
.shader
, op
);
254 load
->num_components
= intrin
->num_components
;
256 nir_intrinsic_set_base(load
, var
->data
.driver_location
);
257 if (mode
== nir_var_shader_in
|| mode
== nir_var_shader_out
)
258 nir_intrinsic_set_component(load
, component
);
260 if (load
->intrinsic
== nir_intrinsic_load_uniform
)
261 nir_intrinsic_set_range(load
,
262 state
->type_size(var
->type
, var
->data
.bindless
));
265 load
->src
[0] = nir_src_for_ssa(vertex_index
);
266 load
->src
[1] = nir_src_for_ssa(offset
);
267 } else if (barycentric
) {
268 load
->src
[0] = nir_src_for_ssa(barycentric
);
269 load
->src
[1] = nir_src_for_ssa(offset
);
271 load
->src
[0] = nir_src_for_ssa(offset
);
277 static nir_intrinsic_instr
*
278 lower_store(nir_intrinsic_instr
*intrin
, struct lower_io_state
*state
,
279 nir_ssa_def
*vertex_index
, nir_variable
*var
, nir_ssa_def
*offset
,
282 nir_variable_mode mode
= var
->data
.mode
;
285 if (mode
== nir_var_mem_shared
) {
286 op
= nir_intrinsic_store_shared
;
288 assert(mode
== nir_var_shader_out
);
289 op
= vertex_index
? nir_intrinsic_store_per_vertex_output
:
290 nir_intrinsic_store_output
;
293 nir_intrinsic_instr
*store
=
294 nir_intrinsic_instr_create(state
->builder
.shader
, op
);
295 store
->num_components
= intrin
->num_components
;
297 nir_src_copy(&store
->src
[0], &intrin
->src
[1], store
);
299 nir_intrinsic_set_base(store
, var
->data
.driver_location
);
301 if (mode
== nir_var_shader_out
)
302 nir_intrinsic_set_component(store
, component
);
304 nir_intrinsic_set_write_mask(store
, nir_intrinsic_write_mask(intrin
));
307 store
->src
[1] = nir_src_for_ssa(vertex_index
);
309 store
->src
[vertex_index
? 2 : 1] = nir_src_for_ssa(offset
);
314 static nir_intrinsic_instr
*
315 lower_atomic(nir_intrinsic_instr
*intrin
, struct lower_io_state
*state
,
316 nir_variable
*var
, nir_ssa_def
*offset
)
318 assert(var
->data
.mode
== nir_var_mem_shared
);
321 switch (intrin
->intrinsic
) {
322 #define OP(O) case nir_intrinsic_deref_##O: op = nir_intrinsic_shared_##O; break;
336 OP(atomic_fcomp_swap
)
339 unreachable("Invalid atomic");
342 nir_intrinsic_instr
*atomic
=
343 nir_intrinsic_instr_create(state
->builder
.shader
, op
);
345 nir_intrinsic_set_base(atomic
, var
->data
.driver_location
);
347 atomic
->src
[0] = nir_src_for_ssa(offset
);
348 assert(nir_intrinsic_infos
[intrin
->intrinsic
].num_srcs
==
349 nir_intrinsic_infos
[op
].num_srcs
);
350 for (unsigned i
= 1; i
< nir_intrinsic_infos
[op
].num_srcs
; i
++) {
351 nir_src_copy(&atomic
->src
[i
], &intrin
->src
[i
], atomic
);
357 static nir_intrinsic_instr
*
358 lower_interpolate_at(nir_intrinsic_instr
*intrin
, struct lower_io_state
*state
,
359 nir_variable
*var
, nir_ssa_def
*offset
, unsigned component
)
361 assert(var
->data
.mode
== nir_var_shader_in
);
363 /* Ignore interpolateAt() for flat variables - flat is flat. */
364 if (var
->data
.interpolation
== INTERP_MODE_FLAT
)
365 return lower_load(intrin
, state
, NULL
, var
, offset
, component
);
367 nir_intrinsic_op bary_op
;
368 switch (intrin
->intrinsic
) {
369 case nir_intrinsic_interp_deref_at_centroid
:
370 bary_op
= (state
->options
& nir_lower_io_force_sample_interpolation
) ?
371 nir_intrinsic_load_barycentric_sample
:
372 nir_intrinsic_load_barycentric_centroid
;
374 case nir_intrinsic_interp_deref_at_sample
:
375 bary_op
= nir_intrinsic_load_barycentric_at_sample
;
377 case nir_intrinsic_interp_deref_at_offset
:
378 bary_op
= nir_intrinsic_load_barycentric_at_offset
;
381 unreachable("Bogus interpolateAt() intrinsic.");
384 nir_intrinsic_instr
*bary_setup
=
385 nir_intrinsic_instr_create(state
->builder
.shader
, bary_op
);
387 nir_ssa_dest_init(&bary_setup
->instr
, &bary_setup
->dest
, 2, 32, NULL
);
388 nir_intrinsic_set_interp_mode(bary_setup
, var
->data
.interpolation
);
390 if (intrin
->intrinsic
== nir_intrinsic_interp_deref_at_sample
||
391 intrin
->intrinsic
== nir_intrinsic_interp_deref_at_offset
)
392 nir_src_copy(&bary_setup
->src
[0], &intrin
->src
[1], bary_setup
);
394 nir_builder_instr_insert(&state
->builder
, &bary_setup
->instr
);
396 nir_intrinsic_instr
*load
=
397 nir_intrinsic_instr_create(state
->builder
.shader
,
398 nir_intrinsic_load_interpolated_input
);
399 load
->num_components
= intrin
->num_components
;
401 nir_intrinsic_set_base(load
, var
->data
.driver_location
);
402 nir_intrinsic_set_component(load
, component
);
404 load
->src
[0] = nir_src_for_ssa(&bary_setup
->dest
.ssa
);
405 load
->src
[1] = nir_src_for_ssa(offset
);
411 nir_lower_io_block(nir_block
*block
,
412 struct lower_io_state
*state
)
414 nir_builder
*b
= &state
->builder
;
415 const nir_shader_compiler_options
*options
= b
->shader
->options
;
416 bool progress
= false;
418 nir_foreach_instr_safe(instr
, block
) {
419 if (instr
->type
!= nir_instr_type_intrinsic
)
422 nir_intrinsic_instr
*intrin
= nir_instr_as_intrinsic(instr
);
424 switch (intrin
->intrinsic
) {
425 case nir_intrinsic_load_deref
:
426 case nir_intrinsic_store_deref
:
427 case nir_intrinsic_deref_atomic_add
:
428 case nir_intrinsic_deref_atomic_imin
:
429 case nir_intrinsic_deref_atomic_umin
:
430 case nir_intrinsic_deref_atomic_imax
:
431 case nir_intrinsic_deref_atomic_umax
:
432 case nir_intrinsic_deref_atomic_and
:
433 case nir_intrinsic_deref_atomic_or
:
434 case nir_intrinsic_deref_atomic_xor
:
435 case nir_intrinsic_deref_atomic_exchange
:
436 case nir_intrinsic_deref_atomic_comp_swap
:
437 case nir_intrinsic_deref_atomic_fadd
:
438 case nir_intrinsic_deref_atomic_fmin
:
439 case nir_intrinsic_deref_atomic_fmax
:
440 case nir_intrinsic_deref_atomic_fcomp_swap
:
441 /* We can lower the io for this nir instrinsic */
443 case nir_intrinsic_interp_deref_at_centroid
:
444 case nir_intrinsic_interp_deref_at_sample
:
445 case nir_intrinsic_interp_deref_at_offset
:
446 /* We can optionally lower these to load_interpolated_input */
447 if (options
->use_interpolated_input_intrinsics
)
450 /* We can't lower the io for this nir instrinsic, so skip it */
454 nir_deref_instr
*deref
= nir_src_as_deref(intrin
->src
[0]);
456 nir_variable
*var
= nir_deref_instr_get_variable(deref
);
457 nir_variable_mode mode
= var
->data
.mode
;
459 if ((state
->modes
& mode
) == 0)
462 if (mode
!= nir_var_shader_in
&&
463 mode
!= nir_var_shader_out
&&
464 mode
!= nir_var_mem_shared
&&
465 mode
!= nir_var_uniform
)
468 b
->cursor
= nir_before_instr(instr
);
470 const bool per_vertex
= nir_is_per_vertex_io(var
, b
->shader
->info
.stage
);
473 nir_ssa_def
*vertex_index
= NULL
;
474 unsigned component_offset
= var
->data
.location_frac
;
475 bool bindless_type_size
= mode
== nir_var_shader_in
||
476 mode
== nir_var_shader_out
||
479 offset
= get_io_offset(b
, deref
, per_vertex
? &vertex_index
: NULL
,
480 state
->type_size
, &component_offset
,
483 nir_intrinsic_instr
*replacement
;
485 switch (intrin
->intrinsic
) {
486 case nir_intrinsic_load_deref
:
487 replacement
= lower_load(intrin
, state
, vertex_index
, var
, offset
,
491 case nir_intrinsic_store_deref
:
492 replacement
= lower_store(intrin
, state
, vertex_index
, var
, offset
,
496 case nir_intrinsic_deref_atomic_add
:
497 case nir_intrinsic_deref_atomic_imin
:
498 case nir_intrinsic_deref_atomic_umin
:
499 case nir_intrinsic_deref_atomic_imax
:
500 case nir_intrinsic_deref_atomic_umax
:
501 case nir_intrinsic_deref_atomic_and
:
502 case nir_intrinsic_deref_atomic_or
:
503 case nir_intrinsic_deref_atomic_xor
:
504 case nir_intrinsic_deref_atomic_exchange
:
505 case nir_intrinsic_deref_atomic_comp_swap
:
506 case nir_intrinsic_deref_atomic_fadd
:
507 case nir_intrinsic_deref_atomic_fmin
:
508 case nir_intrinsic_deref_atomic_fmax
:
509 case nir_intrinsic_deref_atomic_fcomp_swap
:
510 assert(vertex_index
== NULL
);
511 replacement
= lower_atomic(intrin
, state
, var
, offset
);
514 case nir_intrinsic_interp_deref_at_centroid
:
515 case nir_intrinsic_interp_deref_at_sample
:
516 case nir_intrinsic_interp_deref_at_offset
:
517 assert(vertex_index
== NULL
);
518 replacement
= lower_interpolate_at(intrin
, state
, var
, offset
,
526 if (nir_intrinsic_infos
[intrin
->intrinsic
].has_dest
) {
527 if (intrin
->dest
.is_ssa
) {
528 nir_ssa_dest_init(&replacement
->instr
, &replacement
->dest
,
529 intrin
->dest
.ssa
.num_components
,
530 intrin
->dest
.ssa
.bit_size
, NULL
);
531 nir_ssa_def_rewrite_uses(&intrin
->dest
.ssa
,
532 nir_src_for_ssa(&replacement
->dest
.ssa
));
534 nir_dest_copy(&replacement
->dest
, &intrin
->dest
, &intrin
->instr
);
538 nir_instr_insert_before(&intrin
->instr
, &replacement
->instr
);
539 nir_instr_remove(&intrin
->instr
);
547 nir_lower_io_impl(nir_function_impl
*impl
,
548 nir_variable_mode modes
,
549 int (*type_size
)(const struct glsl_type
*, bool),
550 nir_lower_io_options options
)
552 struct lower_io_state state
;
553 bool progress
= false;
555 nir_builder_init(&state
.builder
, impl
);
556 state
.dead_ctx
= ralloc_context(NULL
);
558 state
.type_size
= type_size
;
559 state
.options
= options
;
561 nir_foreach_block(block
, impl
) {
562 progress
|= nir_lower_io_block(block
, &state
);
565 ralloc_free(state
.dead_ctx
);
567 nir_metadata_preserve(impl
, nir_metadata_block_index
|
568 nir_metadata_dominance
);
573 nir_lower_io(nir_shader
*shader
, nir_variable_mode modes
,
574 int (*type_size
)(const struct glsl_type
*, bool),
575 nir_lower_io_options options
)
577 bool progress
= false;
579 nir_foreach_function(function
, shader
) {
580 if (function
->impl
) {
581 progress
|= nir_lower_io_impl(function
->impl
, modes
,
590 type_scalar_size_bytes(const struct glsl_type
*type
)
592 assert(glsl_type_is_vector_or_scalar(type
) ||
593 glsl_type_is_matrix(type
));
594 return glsl_type_is_boolean(type
) ? 4 : glsl_get_bit_size(type
) / 8;
598 build_addr_iadd(nir_builder
*b
, nir_ssa_def
*addr
,
599 nir_address_format addr_format
, nir_ssa_def
*offset
)
601 assert(offset
->num_components
== 1);
602 assert(addr
->bit_size
== offset
->bit_size
);
604 switch (addr_format
) {
605 case nir_address_format_32bit_global
:
606 case nir_address_format_64bit_global
:
607 case nir_address_format_32bit_offset
:
608 assert(addr
->num_components
== 1);
609 return nir_iadd(b
, addr
, offset
);
611 case nir_address_format_64bit_bounded_global
:
612 assert(addr
->num_components
== 4);
613 return nir_vec4(b
, nir_channel(b
, addr
, 0),
614 nir_channel(b
, addr
, 1),
615 nir_channel(b
, addr
, 2),
616 nir_iadd(b
, nir_channel(b
, addr
, 3), offset
));
618 case nir_address_format_32bit_index_offset
:
619 assert(addr
->num_components
== 2);
620 return nir_vec2(b
, nir_channel(b
, addr
, 0),
621 nir_iadd(b
, nir_channel(b
, addr
, 1), offset
));
622 case nir_address_format_logical
:
623 unreachable("Unsupported address format");
625 unreachable("Invalid address format");
629 build_addr_iadd_imm(nir_builder
*b
, nir_ssa_def
*addr
,
630 nir_address_format addr_format
, int64_t offset
)
632 return build_addr_iadd(b
, addr
, addr_format
,
633 nir_imm_intN_t(b
, offset
, addr
->bit_size
));
637 addr_to_index(nir_builder
*b
, nir_ssa_def
*addr
,
638 nir_address_format addr_format
)
640 assert(addr_format
== nir_address_format_32bit_index_offset
);
641 assert(addr
->num_components
== 2);
642 return nir_channel(b
, addr
, 0);
646 addr_to_offset(nir_builder
*b
, nir_ssa_def
*addr
,
647 nir_address_format addr_format
)
649 assert(addr_format
== nir_address_format_32bit_index_offset
);
650 assert(addr
->num_components
== 2);
651 return nir_channel(b
, addr
, 1);
654 /** Returns true if the given address format resolves to a global address */
656 addr_format_is_global(nir_address_format addr_format
)
658 return addr_format
== nir_address_format_32bit_global
||
659 addr_format
== nir_address_format_64bit_global
||
660 addr_format
== nir_address_format_64bit_bounded_global
;
664 addr_to_global(nir_builder
*b
, nir_ssa_def
*addr
,
665 nir_address_format addr_format
)
667 switch (addr_format
) {
668 case nir_address_format_32bit_global
:
669 case nir_address_format_64bit_global
:
670 assert(addr
->num_components
== 1);
673 case nir_address_format_64bit_bounded_global
:
674 assert(addr
->num_components
== 4);
675 return nir_iadd(b
, nir_pack_64_2x32(b
, nir_channels(b
, addr
, 0x3)),
676 nir_u2u64(b
, nir_channel(b
, addr
, 3)));
678 case nir_address_format_32bit_index_offset
:
679 case nir_address_format_32bit_offset
:
680 case nir_address_format_logical
:
681 unreachable("Cannot get a 64-bit address with this address format");
684 unreachable("Invalid address format");
688 addr_format_needs_bounds_check(nir_address_format addr_format
)
690 return addr_format
== nir_address_format_64bit_bounded_global
;
694 addr_is_in_bounds(nir_builder
*b
, nir_ssa_def
*addr
,
695 nir_address_format addr_format
, unsigned size
)
697 assert(addr_format
== nir_address_format_64bit_bounded_global
);
698 assert(addr
->num_components
== 4);
699 return nir_ige(b
, nir_channel(b
, addr
, 2),
700 nir_iadd_imm(b
, nir_channel(b
, addr
, 3), size
));
704 build_explicit_io_load(nir_builder
*b
, nir_intrinsic_instr
*intrin
,
705 nir_ssa_def
*addr
, nir_address_format addr_format
,
706 unsigned num_components
)
708 nir_variable_mode mode
= nir_src_as_deref(intrin
->src
[0])->mode
;
712 case nir_var_mem_ubo
:
713 op
= nir_intrinsic_load_ubo
;
715 case nir_var_mem_ssbo
:
716 if (addr_format_is_global(addr_format
))
717 op
= nir_intrinsic_load_global
;
719 op
= nir_intrinsic_load_ssbo
;
721 case nir_var_mem_global
:
722 assert(addr_format_is_global(addr_format
));
723 op
= nir_intrinsic_load_global
;
725 case nir_var_shader_in
:
726 assert(addr_format_is_global(addr_format
));
727 op
= nir_intrinsic_load_kernel_input
;
730 unreachable("Unsupported explicit IO variable mode");
733 nir_intrinsic_instr
*load
= nir_intrinsic_instr_create(b
->shader
, op
);
735 if (addr_format_is_global(addr_format
)) {
736 load
->src
[0] = nir_src_for_ssa(addr_to_global(b
, addr
, addr_format
));
738 load
->src
[0] = nir_src_for_ssa(addr_to_index(b
, addr
, addr_format
));
739 load
->src
[1] = nir_src_for_ssa(addr_to_offset(b
, addr
, addr_format
));
742 if (mode
!= nir_var_mem_ubo
&& mode
!= nir_var_shader_in
)
743 nir_intrinsic_set_access(load
, nir_intrinsic_access(intrin
));
745 /* TODO: We should try and provide a better alignment. For OpenCL, we need
746 * to plumb the alignment through from SPIR-V when we have one.
748 nir_intrinsic_set_align(load
, intrin
->dest
.ssa
.bit_size
/ 8, 0);
750 assert(intrin
->dest
.is_ssa
);
751 load
->num_components
= num_components
;
752 nir_ssa_dest_init(&load
->instr
, &load
->dest
, num_components
,
753 intrin
->dest
.ssa
.bit_size
, intrin
->dest
.ssa
.name
);
755 assert(load
->dest
.ssa
.bit_size
% 8 == 0);
757 if (addr_format_needs_bounds_check(addr_format
)) {
758 /* The Vulkan spec for robustBufferAccess gives us quite a few options
759 * as to what we can do with an OOB read. Unfortunately, returning
760 * undefined values isn't one of them so we return an actual zero.
762 nir_ssa_def
*zero
= nir_imm_zero(b
, load
->num_components
,
763 load
->dest
.ssa
.bit_size
);
765 const unsigned load_size
=
766 (load
->dest
.ssa
.bit_size
/ 8) * load
->num_components
;
767 nir_push_if(b
, addr_is_in_bounds(b
, addr
, addr_format
, load_size
));
769 nir_builder_instr_insert(b
, &load
->instr
);
773 return nir_if_phi(b
, &load
->dest
.ssa
, zero
);
775 nir_builder_instr_insert(b
, &load
->instr
);
776 return &load
->dest
.ssa
;
781 build_explicit_io_store(nir_builder
*b
, nir_intrinsic_instr
*intrin
,
782 nir_ssa_def
*addr
, nir_address_format addr_format
,
783 nir_ssa_def
*value
, nir_component_mask_t write_mask
)
785 nir_variable_mode mode
= nir_src_as_deref(intrin
->src
[0])->mode
;
789 case nir_var_mem_ssbo
:
790 if (addr_format_is_global(addr_format
))
791 op
= nir_intrinsic_store_global
;
793 op
= nir_intrinsic_store_ssbo
;
795 case nir_var_mem_global
:
796 assert(addr_format_is_global(addr_format
));
797 op
= nir_intrinsic_store_global
;
800 unreachable("Unsupported explicit IO variable mode");
803 nir_intrinsic_instr
*store
= nir_intrinsic_instr_create(b
->shader
, op
);
805 store
->src
[0] = nir_src_for_ssa(value
);
806 if (addr_format_is_global(addr_format
)) {
807 store
->src
[1] = nir_src_for_ssa(addr_to_global(b
, addr
, addr_format
));
809 store
->src
[1] = nir_src_for_ssa(addr_to_index(b
, addr
, addr_format
));
810 store
->src
[2] = nir_src_for_ssa(addr_to_offset(b
, addr
, addr_format
));
813 nir_intrinsic_set_write_mask(store
, write_mask
);
815 nir_intrinsic_set_access(store
, nir_intrinsic_access(intrin
));
817 /* TODO: We should try and provide a better alignment. For OpenCL, we need
818 * to plumb the alignment through from SPIR-V when we have one.
820 nir_intrinsic_set_align(store
, value
->bit_size
/ 8, 0);
822 assert(value
->num_components
== 1 ||
823 value
->num_components
== intrin
->num_components
);
824 store
->num_components
= value
->num_components
;
826 assert(value
->bit_size
% 8 == 0);
828 if (addr_format_needs_bounds_check(addr_format
)) {
829 const unsigned store_size
= (value
->bit_size
/ 8) * store
->num_components
;
830 nir_push_if(b
, addr_is_in_bounds(b
, addr
, addr_format
, store_size
));
832 nir_builder_instr_insert(b
, &store
->instr
);
836 nir_builder_instr_insert(b
, &store
->instr
);
841 build_explicit_io_atomic(nir_builder
*b
, nir_intrinsic_instr
*intrin
,
842 nir_ssa_def
*addr
, nir_address_format addr_format
)
844 nir_variable_mode mode
= nir_src_as_deref(intrin
->src
[0])->mode
;
845 const unsigned num_data_srcs
=
846 nir_intrinsic_infos
[intrin
->intrinsic
].num_srcs
- 1;
850 case nir_var_mem_ssbo
:
851 if (addr_format_is_global(addr_format
))
852 op
= global_atomic_for_deref(intrin
->intrinsic
);
854 op
= ssbo_atomic_for_deref(intrin
->intrinsic
);
856 case nir_var_mem_global
:
857 assert(addr_format_is_global(addr_format
));
858 op
= global_atomic_for_deref(intrin
->intrinsic
);
861 unreachable("Unsupported explicit IO variable mode");
864 nir_intrinsic_instr
*atomic
= nir_intrinsic_instr_create(b
->shader
, op
);
867 if (addr_format_is_global(addr_format
)) {
868 atomic
->src
[src
++] = nir_src_for_ssa(addr_to_global(b
, addr
, addr_format
));
870 atomic
->src
[src
++] = nir_src_for_ssa(addr_to_index(b
, addr
, addr_format
));
871 atomic
->src
[src
++] = nir_src_for_ssa(addr_to_offset(b
, addr
, addr_format
));
873 for (unsigned i
= 0; i
< num_data_srcs
; i
++) {
874 atomic
->src
[src
++] = nir_src_for_ssa(intrin
->src
[1 + i
].ssa
);
877 /* Global atomics don't have access flags because they assume that the
878 * address may be non-uniform.
880 if (!addr_format_is_global(addr_format
))
881 nir_intrinsic_set_access(atomic
, nir_intrinsic_access(intrin
));
883 assert(intrin
->dest
.ssa
.num_components
== 1);
884 nir_ssa_dest_init(&atomic
->instr
, &atomic
->dest
,
885 1, intrin
->dest
.ssa
.bit_size
, intrin
->dest
.ssa
.name
);
887 assert(atomic
->dest
.ssa
.bit_size
% 8 == 0);
889 if (addr_format_needs_bounds_check(addr_format
)) {
890 const unsigned atomic_size
= atomic
->dest
.ssa
.bit_size
/ 8;
891 nir_push_if(b
, addr_is_in_bounds(b
, addr
, addr_format
, atomic_size
));
893 nir_builder_instr_insert(b
, &atomic
->instr
);
896 return nir_if_phi(b
, &atomic
->dest
.ssa
,
897 nir_ssa_undef(b
, 1, atomic
->dest
.ssa
.bit_size
));
899 nir_builder_instr_insert(b
, &atomic
->instr
);
900 return &atomic
->dest
.ssa
;
905 nir_explicit_io_address_from_deref(nir_builder
*b
, nir_deref_instr
*deref
,
906 nir_ssa_def
*base_addr
,
907 nir_address_format addr_format
)
909 assert(deref
->dest
.is_ssa
);
910 switch (deref
->deref_type
) {
911 case nir_deref_type_var
:
912 assert(deref
->mode
== nir_var_shader_in
);
913 return nir_imm_intN_t(b
, deref
->var
->data
.driver_location
,
914 deref
->dest
.ssa
.bit_size
);
916 case nir_deref_type_array
: {
917 nir_deref_instr
*parent
= nir_deref_instr_parent(deref
);
919 unsigned stride
= glsl_get_explicit_stride(parent
->type
);
920 if ((glsl_type_is_matrix(parent
->type
) &&
921 glsl_matrix_type_is_row_major(parent
->type
)) ||
922 (glsl_type_is_vector(parent
->type
) && stride
== 0))
923 stride
= type_scalar_size_bytes(parent
->type
);
927 nir_ssa_def
*index
= nir_ssa_for_src(b
, deref
->arr
.index
, 1);
928 index
= nir_i2i(b
, index
, base_addr
->bit_size
);
929 return build_addr_iadd(b
, base_addr
, addr_format
,
930 nir_imul_imm(b
, index
, stride
));
933 case nir_deref_type_ptr_as_array
: {
934 nir_ssa_def
*index
= nir_ssa_for_src(b
, deref
->arr
.index
, 1);
935 index
= nir_i2i(b
, index
, base_addr
->bit_size
);
936 unsigned stride
= nir_deref_instr_ptr_as_array_stride(deref
);
937 return build_addr_iadd(b
, base_addr
, addr_format
,
938 nir_imul_imm(b
, index
, stride
));
941 case nir_deref_type_array_wildcard
:
942 unreachable("Wildcards should be lowered by now");
945 case nir_deref_type_struct
: {
946 nir_deref_instr
*parent
= nir_deref_instr_parent(deref
);
947 int offset
= glsl_get_struct_field_offset(parent
->type
,
950 return build_addr_iadd_imm(b
, base_addr
, addr_format
, offset
);
953 case nir_deref_type_cast
:
954 /* Nothing to do here */
958 unreachable("Invalid NIR deref type");
962 nir_lower_explicit_io_instr(nir_builder
*b
,
963 nir_intrinsic_instr
*intrin
,
965 nir_address_format addr_format
)
967 b
->cursor
= nir_after_instr(&intrin
->instr
);
969 nir_deref_instr
*deref
= nir_src_as_deref(intrin
->src
[0]);
970 unsigned vec_stride
= glsl_get_explicit_stride(deref
->type
);
971 unsigned scalar_size
= type_scalar_size_bytes(deref
->type
);
972 assert(vec_stride
== 0 || glsl_type_is_vector(deref
->type
));
973 assert(vec_stride
== 0 || vec_stride
>= scalar_size
);
975 if (intrin
->intrinsic
== nir_intrinsic_load_deref
) {
977 if (vec_stride
> scalar_size
) {
978 nir_ssa_def
*comps
[4] = { NULL
, };
979 for (unsigned i
= 0; i
< intrin
->num_components
; i
++) {
980 nir_ssa_def
*comp_addr
= build_addr_iadd_imm(b
, addr
, addr_format
,
982 comps
[i
] = build_explicit_io_load(b
, intrin
, comp_addr
,
985 value
= nir_vec(b
, comps
, intrin
->num_components
);
987 value
= build_explicit_io_load(b
, intrin
, addr
, addr_format
,
988 intrin
->num_components
);
990 nir_ssa_def_rewrite_uses(&intrin
->dest
.ssa
, nir_src_for_ssa(value
));
991 } else if (intrin
->intrinsic
== nir_intrinsic_store_deref
) {
992 assert(intrin
->src
[1].is_ssa
);
993 nir_ssa_def
*value
= intrin
->src
[1].ssa
;
994 nir_component_mask_t write_mask
= nir_intrinsic_write_mask(intrin
);
995 if (vec_stride
> scalar_size
) {
996 for (unsigned i
= 0; i
< intrin
->num_components
; i
++) {
997 if (!(write_mask
& (1 << i
)))
1000 nir_ssa_def
*comp_addr
= build_addr_iadd_imm(b
, addr
, addr_format
,
1002 build_explicit_io_store(b
, intrin
, comp_addr
, addr_format
,
1003 nir_channel(b
, value
, i
), 1);
1006 build_explicit_io_store(b
, intrin
, addr
, addr_format
,
1010 nir_ssa_def
*value
=
1011 build_explicit_io_atomic(b
, intrin
, addr
, addr_format
);
1012 nir_ssa_def_rewrite_uses(&intrin
->dest
.ssa
, nir_src_for_ssa(value
));
1015 nir_instr_remove(&intrin
->instr
);
1019 lower_explicit_io_deref(nir_builder
*b
, nir_deref_instr
*deref
,
1020 nir_address_format addr_format
)
1022 /* Just delete the deref if it's not used. We can't use
1023 * nir_deref_instr_remove_if_unused here because it may remove more than
1024 * one deref which could break our list walking since we walk the list
1027 assert(list_empty(&deref
->dest
.ssa
.if_uses
));
1028 if (list_empty(&deref
->dest
.ssa
.uses
)) {
1029 nir_instr_remove(&deref
->instr
);
1033 b
->cursor
= nir_after_instr(&deref
->instr
);
1035 nir_ssa_def
*base_addr
= NULL
;
1036 if (deref
->deref_type
!= nir_deref_type_var
) {
1037 assert(deref
->parent
.is_ssa
);
1038 base_addr
= deref
->parent
.ssa
;
1041 nir_ssa_def
*addr
= nir_explicit_io_address_from_deref(b
, deref
, base_addr
,
1044 nir_instr_remove(&deref
->instr
);
1045 nir_ssa_def_rewrite_uses(&deref
->dest
.ssa
, nir_src_for_ssa(addr
));
1049 lower_explicit_io_access(nir_builder
*b
, nir_intrinsic_instr
*intrin
,
1050 nir_address_format addr_format
)
1052 assert(intrin
->src
[0].is_ssa
);
1053 nir_lower_explicit_io_instr(b
, intrin
, intrin
->src
[0].ssa
, addr_format
);
1057 lower_explicit_io_array_length(nir_builder
*b
, nir_intrinsic_instr
*intrin
,
1058 nir_address_format addr_format
)
1060 b
->cursor
= nir_after_instr(&intrin
->instr
);
1062 nir_deref_instr
*deref
= nir_src_as_deref(intrin
->src
[0]);
1064 assert(glsl_type_is_array(deref
->type
));
1065 assert(glsl_get_length(deref
->type
) == 0);
1066 unsigned stride
= glsl_get_explicit_stride(deref
->type
);
1069 assert(addr_format
== nir_address_format_32bit_index_offset
);
1070 nir_ssa_def
*addr
= &deref
->dest
.ssa
;
1071 nir_ssa_def
*index
= addr_to_index(b
, addr
, addr_format
);
1072 nir_ssa_def
*offset
= addr_to_offset(b
, addr
, addr_format
);
1074 nir_intrinsic_instr
*bsize
=
1075 nir_intrinsic_instr_create(b
->shader
, nir_intrinsic_get_buffer_size
);
1076 bsize
->src
[0] = nir_src_for_ssa(index
);
1077 nir_ssa_dest_init(&bsize
->instr
, &bsize
->dest
, 1, 32, NULL
);
1078 nir_builder_instr_insert(b
, &bsize
->instr
);
1080 nir_ssa_def
*arr_size
=
1081 nir_idiv(b
, nir_isub(b
, &bsize
->dest
.ssa
, offset
),
1082 nir_imm_int(b
, stride
));
1084 nir_ssa_def_rewrite_uses(&intrin
->dest
.ssa
, nir_src_for_ssa(arr_size
));
1085 nir_instr_remove(&intrin
->instr
);
1089 nir_lower_explicit_io_impl(nir_function_impl
*impl
, nir_variable_mode modes
,
1090 nir_address_format addr_format
)
1092 bool progress
= false;
1095 nir_builder_init(&b
, impl
);
1097 /* Walk in reverse order so that we can see the full deref chain when we
1098 * lower the access operations. We lower them assuming that the derefs
1099 * will be turned into address calculations later.
1101 nir_foreach_block_reverse(block
, impl
) {
1102 nir_foreach_instr_reverse_safe(instr
, block
) {
1103 switch (instr
->type
) {
1104 case nir_instr_type_deref
: {
1105 nir_deref_instr
*deref
= nir_instr_as_deref(instr
);
1106 if (deref
->mode
& modes
) {
1107 lower_explicit_io_deref(&b
, deref
, addr_format
);
1113 case nir_instr_type_intrinsic
: {
1114 nir_intrinsic_instr
*intrin
= nir_instr_as_intrinsic(instr
);
1115 switch (intrin
->intrinsic
) {
1116 case nir_intrinsic_load_deref
:
1117 case nir_intrinsic_store_deref
:
1118 case nir_intrinsic_deref_atomic_add
:
1119 case nir_intrinsic_deref_atomic_imin
:
1120 case nir_intrinsic_deref_atomic_umin
:
1121 case nir_intrinsic_deref_atomic_imax
:
1122 case nir_intrinsic_deref_atomic_umax
:
1123 case nir_intrinsic_deref_atomic_and
:
1124 case nir_intrinsic_deref_atomic_or
:
1125 case nir_intrinsic_deref_atomic_xor
:
1126 case nir_intrinsic_deref_atomic_exchange
:
1127 case nir_intrinsic_deref_atomic_comp_swap
:
1128 case nir_intrinsic_deref_atomic_fadd
:
1129 case nir_intrinsic_deref_atomic_fmin
:
1130 case nir_intrinsic_deref_atomic_fmax
:
1131 case nir_intrinsic_deref_atomic_fcomp_swap
: {
1132 nir_deref_instr
*deref
= nir_src_as_deref(intrin
->src
[0]);
1133 if (deref
->mode
& modes
) {
1134 lower_explicit_io_access(&b
, intrin
, addr_format
);
1140 case nir_intrinsic_deref_buffer_array_length
: {
1141 nir_deref_instr
*deref
= nir_src_as_deref(intrin
->src
[0]);
1142 if (deref
->mode
& modes
) {
1143 lower_explicit_io_array_length(&b
, intrin
, addr_format
);
1163 nir_metadata_preserve(impl
, nir_metadata_block_index
|
1164 nir_metadata_dominance
);
1171 nir_lower_explicit_io(nir_shader
*shader
, nir_variable_mode modes
,
1172 nir_address_format addr_format
)
1174 bool progress
= false;
1176 nir_foreach_function(function
, shader
) {
1177 if (function
->impl
&&
1178 nir_lower_explicit_io_impl(function
->impl
, modes
, addr_format
))
1186 * Return the offset source for a load/store intrinsic.
1189 nir_get_io_offset_src(nir_intrinsic_instr
*instr
)
1191 switch (instr
->intrinsic
) {
1192 case nir_intrinsic_load_input
:
1193 case nir_intrinsic_load_output
:
1194 case nir_intrinsic_load_shared
:
1195 case nir_intrinsic_load_uniform
:
1196 case nir_intrinsic_load_global
:
1197 case nir_intrinsic_load_scratch
:
1198 return &instr
->src
[0];
1199 case nir_intrinsic_load_ubo
:
1200 case nir_intrinsic_load_ssbo
:
1201 case nir_intrinsic_load_per_vertex_input
:
1202 case nir_intrinsic_load_per_vertex_output
:
1203 case nir_intrinsic_load_interpolated_input
:
1204 case nir_intrinsic_store_output
:
1205 case nir_intrinsic_store_shared
:
1206 case nir_intrinsic_store_global
:
1207 case nir_intrinsic_store_scratch
:
1208 return &instr
->src
[1];
1209 case nir_intrinsic_store_ssbo
:
1210 case nir_intrinsic_store_per_vertex_output
:
1211 return &instr
->src
[2];
1218 * Return the vertex index source for a load/store per_vertex intrinsic.
1221 nir_get_io_vertex_index_src(nir_intrinsic_instr
*instr
)
1223 switch (instr
->intrinsic
) {
1224 case nir_intrinsic_load_per_vertex_input
:
1225 case nir_intrinsic_load_per_vertex_output
:
1226 return &instr
->src
[0];
1227 case nir_intrinsic_store_per_vertex_output
:
1228 return &instr
->src
[1];