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"
37 struct lower_io_state
{
40 int (*type_size
)(const struct glsl_type
*type
);
41 nir_variable_mode modes
;
42 nir_lower_io_options options
;
46 nir_assign_var_locations(struct exec_list
*var_list
, unsigned *size
,
47 int (*type_size
)(const struct glsl_type
*))
49 unsigned location
= 0;
51 nir_foreach_variable(var
, var_list
) {
53 * UBOs have their own address spaces, so don't count them towards the
54 * number of global uniforms
56 if ((var
->data
.mode
== nir_var_uniform
|| var
->data
.mode
== nir_var_shader_storage
) &&
57 var
->interface_type
!= NULL
)
60 var
->data
.driver_location
= location
;
61 location
+= type_size(var
->type
);
68 * Return true if the given variable is a per-vertex input/output array.
69 * (such as geometry shader inputs).
72 nir_is_per_vertex_io(const nir_variable
*var
, gl_shader_stage stage
)
74 if (var
->data
.patch
|| !glsl_type_is_array(var
->type
))
77 if (var
->data
.mode
== nir_var_shader_in
)
78 return stage
== MESA_SHADER_GEOMETRY
||
79 stage
== MESA_SHADER_TESS_CTRL
||
80 stage
== MESA_SHADER_TESS_EVAL
;
82 if (var
->data
.mode
== nir_var_shader_out
)
83 return stage
== MESA_SHADER_TESS_CTRL
;
89 get_io_offset(nir_builder
*b
, nir_deref_var
*deref
,
90 nir_ssa_def
**vertex_index
,
91 int (*type_size
)(const struct glsl_type
*),
94 nir_deref
*tail
= &deref
->deref
;
96 /* For per-vertex input arrays (i.e. geometry shader inputs), keep the
97 * outermost array index separate. Process the rest normally.
99 if (vertex_index
!= NULL
) {
101 nir_deref_array
*deref_array
= nir_deref_as_array(tail
);
103 nir_ssa_def
*vtx
= nir_imm_int(b
, deref_array
->base_offset
);
104 if (deref_array
->deref_array_type
== nir_deref_array_type_indirect
) {
105 vtx
= nir_iadd(b
, vtx
, nir_ssa_for_src(b
, deref_array
->indirect
, 1));
110 if (deref
->var
->data
.compact
) {
111 assert(tail
->child
->deref_type
== nir_deref_type_array
);
112 assert(glsl_type_is_scalar(glsl_without_array(deref
->var
->type
)));
113 nir_deref_array
*deref_array
= nir_deref_as_array(tail
->child
);
114 /* We always lower indirect dereferences for "compact" array vars. */
115 assert(deref_array
->deref_array_type
== nir_deref_array_type_direct
);
117 const unsigned total_offset
= *component
+ deref_array
->base_offset
;
118 const unsigned slot_offset
= total_offset
/ 4;
119 *component
= total_offset
% 4;
120 return nir_imm_int(b
, type_size(glsl_vec4_type()) * slot_offset
);
123 /* Just emit code and let constant-folding go to town */
124 nir_ssa_def
*offset
= nir_imm_int(b
, 0);
126 while (tail
->child
!= NULL
) {
127 const struct glsl_type
*parent_type
= tail
->type
;
130 if (tail
->deref_type
== nir_deref_type_array
) {
131 nir_deref_array
*deref_array
= nir_deref_as_array(tail
);
132 unsigned size
= type_size(tail
->type
);
134 offset
= nir_iadd(b
, offset
,
135 nir_imm_int(b
, size
* deref_array
->base_offset
));
137 if (deref_array
->deref_array_type
== nir_deref_array_type_indirect
) {
139 nir_imul(b
, nir_imm_int(b
, size
),
140 nir_ssa_for_src(b
, deref_array
->indirect
, 1));
142 offset
= nir_iadd(b
, offset
, mul
);
144 } else if (tail
->deref_type
== nir_deref_type_struct
) {
145 nir_deref_struct
*deref_struct
= nir_deref_as_struct(tail
);
147 unsigned field_offset
= 0;
148 for (unsigned i
= 0; i
< deref_struct
->index
; i
++) {
149 field_offset
+= type_size(glsl_get_struct_field(parent_type
, i
));
151 offset
= nir_iadd(b
, offset
, nir_imm_int(b
, field_offset
));
158 static nir_intrinsic_instr
*
159 lower_load(nir_intrinsic_instr
*intrin
, struct lower_io_state
*state
,
160 nir_ssa_def
*vertex_index
, nir_variable
*var
, nir_ssa_def
*offset
,
163 const nir_shader
*nir
= state
->builder
.shader
;
164 nir_variable_mode mode
= var
->data
.mode
;
165 nir_ssa_def
*barycentric
= NULL
;
169 case nir_var_shader_in
:
170 if (nir
->info
.stage
== MESA_SHADER_FRAGMENT
&&
171 nir
->options
->use_interpolated_input_intrinsics
&&
172 var
->data
.interpolation
!= INTERP_MODE_FLAT
) {
173 assert(vertex_index
== NULL
);
175 nir_intrinsic_op bary_op
;
176 if (var
->data
.sample
||
177 (state
->options
& nir_lower_io_force_sample_interpolation
))
178 bary_op
= nir_intrinsic_load_barycentric_sample
;
179 else if (var
->data
.centroid
)
180 bary_op
= nir_intrinsic_load_barycentric_centroid
;
182 bary_op
= nir_intrinsic_load_barycentric_pixel
;
184 barycentric
= nir_load_barycentric(&state
->builder
, bary_op
,
185 var
->data
.interpolation
);
186 op
= nir_intrinsic_load_interpolated_input
;
188 op
= vertex_index
? nir_intrinsic_load_per_vertex_input
:
189 nir_intrinsic_load_input
;
192 case nir_var_shader_out
:
193 op
= vertex_index
? nir_intrinsic_load_per_vertex_output
:
194 nir_intrinsic_load_output
;
196 case nir_var_uniform
:
197 op
= nir_intrinsic_load_uniform
;
200 op
= nir_intrinsic_load_shared
;
203 unreachable("Unknown variable mode");
206 nir_intrinsic_instr
*load
=
207 nir_intrinsic_instr_create(state
->builder
.shader
, op
);
208 load
->num_components
= intrin
->num_components
;
210 nir_intrinsic_set_base(load
, var
->data
.driver_location
);
211 if (mode
== nir_var_shader_in
|| mode
== nir_var_shader_out
)
212 nir_intrinsic_set_component(load
, component
);
214 if (load
->intrinsic
== nir_intrinsic_load_uniform
)
215 nir_intrinsic_set_range(load
, state
->type_size(var
->type
));
218 load
->src
[0] = nir_src_for_ssa(vertex_index
);
219 load
->src
[1] = nir_src_for_ssa(offset
);
220 } else if (barycentric
) {
221 load
->src
[0] = nir_src_for_ssa(barycentric
);
222 load
->src
[1] = nir_src_for_ssa(offset
);
224 load
->src
[0] = nir_src_for_ssa(offset
);
230 static nir_intrinsic_instr
*
231 lower_store(nir_intrinsic_instr
*intrin
, struct lower_io_state
*state
,
232 nir_ssa_def
*vertex_index
, nir_variable
*var
, nir_ssa_def
*offset
,
235 nir_variable_mode mode
= var
->data
.mode
;
238 if (mode
== nir_var_shared
) {
239 op
= nir_intrinsic_store_shared
;
241 assert(mode
== nir_var_shader_out
);
242 op
= vertex_index
? nir_intrinsic_store_per_vertex_output
:
243 nir_intrinsic_store_output
;
246 nir_intrinsic_instr
*store
=
247 nir_intrinsic_instr_create(state
->builder
.shader
, op
);
248 store
->num_components
= intrin
->num_components
;
250 if (intrin
->intrinsic
== nir_intrinsic_store_var
)
251 nir_src_copy(&store
->src
[0], &intrin
->src
[0], store
);
253 nir_src_copy(&store
->src
[0], &intrin
->src
[1], store
);
255 nir_intrinsic_set_base(store
, var
->data
.driver_location
);
257 if (mode
== nir_var_shader_out
)
258 nir_intrinsic_set_component(store
, component
);
260 nir_intrinsic_set_write_mask(store
, nir_intrinsic_write_mask(intrin
));
263 store
->src
[1] = nir_src_for_ssa(vertex_index
);
265 store
->src
[vertex_index
? 2 : 1] = nir_src_for_ssa(offset
);
270 static nir_intrinsic_instr
*
271 lower_atomic(nir_intrinsic_instr
*intrin
, struct lower_io_state
*state
,
272 nir_variable
*var
, nir_ssa_def
*offset
)
274 assert(var
->data
.mode
== nir_var_shared
);
277 switch (intrin
->intrinsic
) {
278 #define OP(O) case nir_intrinsic_var_##O: op = nir_intrinsic_shared_##O; break;
291 unreachable("Invalid atomic");
294 nir_intrinsic_instr
*atomic
=
295 nir_intrinsic_instr_create(state
->builder
.shader
, op
);
297 nir_intrinsic_set_base(atomic
, var
->data
.driver_location
);
299 atomic
->src
[0] = nir_src_for_ssa(offset
);
300 for (unsigned i
= 0; i
< nir_intrinsic_infos
[intrin
->intrinsic
].num_srcs
; i
++) {
301 nir_src_copy(&atomic
->src
[i
+1], &intrin
->src
[i
], atomic
);
307 static nir_intrinsic_instr
*
308 lower_interpolate_at(nir_intrinsic_instr
*intrin
, struct lower_io_state
*state
,
309 nir_variable
*var
, nir_ssa_def
*offset
, unsigned component
)
311 assert(var
->data
.mode
== nir_var_shader_in
);
313 /* Ignore interpolateAt() for flat variables - flat is flat. */
314 if (var
->data
.interpolation
== INTERP_MODE_FLAT
)
315 return lower_load(intrin
, state
, NULL
, var
, offset
, component
);
317 nir_intrinsic_op bary_op
;
318 switch (intrin
->intrinsic
) {
319 case nir_intrinsic_interp_var_at_centroid
:
320 case nir_intrinsic_interp_deref_at_centroid
:
321 bary_op
= (state
->options
& nir_lower_io_force_sample_interpolation
) ?
322 nir_intrinsic_load_barycentric_sample
:
323 nir_intrinsic_load_barycentric_centroid
;
325 case nir_intrinsic_interp_var_at_sample
:
326 case nir_intrinsic_interp_deref_at_sample
:
327 bary_op
= nir_intrinsic_load_barycentric_at_sample
;
329 case nir_intrinsic_interp_var_at_offset
:
330 case nir_intrinsic_interp_deref_at_offset
:
331 bary_op
= nir_intrinsic_load_barycentric_at_offset
;
334 unreachable("Bogus interpolateAt() intrinsic.");
337 nir_intrinsic_instr
*bary_setup
=
338 nir_intrinsic_instr_create(state
->builder
.shader
, bary_op
);
340 nir_ssa_dest_init(&bary_setup
->instr
, &bary_setup
->dest
, 2, 32, NULL
);
341 nir_intrinsic_set_interp_mode(bary_setup
, var
->data
.interpolation
);
343 if (intrin
->intrinsic
== nir_intrinsic_interp_var_at_sample
||
344 intrin
->intrinsic
== nir_intrinsic_interp_var_at_offset
)
345 nir_src_copy(&bary_setup
->src
[0], &intrin
->src
[0], bary_setup
);
347 if (intrin
->intrinsic
== nir_intrinsic_interp_deref_at_sample
||
348 intrin
->intrinsic
== nir_intrinsic_interp_deref_at_offset
)
349 nir_src_copy(&bary_setup
->src
[0], &intrin
->src
[1], bary_setup
);
351 nir_builder_instr_insert(&state
->builder
, &bary_setup
->instr
);
353 nir_intrinsic_instr
*load
=
354 nir_intrinsic_instr_create(state
->builder
.shader
,
355 nir_intrinsic_load_interpolated_input
);
356 load
->num_components
= intrin
->num_components
;
358 nir_intrinsic_set_base(load
, var
->data
.driver_location
);
359 nir_intrinsic_set_component(load
, component
);
361 load
->src
[0] = nir_src_for_ssa(&bary_setup
->dest
.ssa
);
362 load
->src
[1] = nir_src_for_ssa(offset
);
368 nir_lower_io_block(nir_block
*block
,
369 struct lower_io_state
*state
)
371 nir_builder
*b
= &state
->builder
;
372 const nir_shader_compiler_options
*options
= b
->shader
->options
;
373 bool progress
= false;
375 nir_foreach_instr_safe(instr
, block
) {
376 if (instr
->type
!= nir_instr_type_intrinsic
)
379 nir_intrinsic_instr
*intrin
= nir_instr_as_intrinsic(instr
);
381 switch (intrin
->intrinsic
) {
382 case nir_intrinsic_load_var
:
383 case nir_intrinsic_load_deref
:
384 case nir_intrinsic_store_var
:
385 case nir_intrinsic_store_deref
:
386 case nir_intrinsic_var_atomic_add
:
387 case nir_intrinsic_var_atomic_imin
:
388 case nir_intrinsic_var_atomic_umin
:
389 case nir_intrinsic_var_atomic_imax
:
390 case nir_intrinsic_var_atomic_umax
:
391 case nir_intrinsic_var_atomic_and
:
392 case nir_intrinsic_var_atomic_or
:
393 case nir_intrinsic_var_atomic_xor
:
394 case nir_intrinsic_var_atomic_exchange
:
395 case nir_intrinsic_var_atomic_comp_swap
:
396 /* We can lower the io for this nir instrinsic */
398 case nir_intrinsic_interp_var_at_centroid
:
399 case nir_intrinsic_interp_var_at_sample
:
400 case nir_intrinsic_interp_var_at_offset
:
401 case nir_intrinsic_interp_deref_at_centroid
:
402 case nir_intrinsic_interp_deref_at_sample
:
403 case nir_intrinsic_interp_deref_at_offset
:
404 /* We can optionally lower these to load_interpolated_input */
405 if (options
->use_interpolated_input_intrinsics
)
408 /* We can't lower the io for this nir instrinsic, so skip it */
412 nir_deref_var
*deref
;
413 nir_deref_instr
*deref_instr
= NULL
;
414 if (nir_intrinsic_infos
[intrin
->intrinsic
].num_variables
> 0) {
415 assert(nir_intrinsic_infos
[intrin
->intrinsic
].num_variables
== 1);
416 deref
= intrin
->variables
[0];
418 deref_instr
= nir_src_as_deref(intrin
->src
[0]);
419 deref
= nir_deref_instr_to_deref(deref_instr
, state
->dead_ctx
);
422 nir_variable
*var
= deref
->var
;
423 nir_variable_mode mode
= var
->data
.mode
;
425 if ((state
->modes
& mode
) == 0)
428 if (mode
!= nir_var_shader_in
&&
429 mode
!= nir_var_shader_out
&&
430 mode
!= nir_var_shared
&&
431 mode
!= nir_var_uniform
)
434 b
->cursor
= nir_before_instr(instr
);
436 const bool per_vertex
= nir_is_per_vertex_io(var
, b
->shader
->info
.stage
);
439 nir_ssa_def
*vertex_index
= NULL
;
440 unsigned component_offset
= var
->data
.location_frac
;
442 offset
= get_io_offset(b
, deref
, per_vertex
? &vertex_index
: NULL
,
443 state
->type_size
, &component_offset
);
445 nir_intrinsic_instr
*replacement
;
447 switch (intrin
->intrinsic
) {
448 case nir_intrinsic_load_var
:
449 case nir_intrinsic_load_deref
:
450 replacement
= lower_load(intrin
, state
, vertex_index
, var
, offset
,
454 case nir_intrinsic_store_var
:
455 case nir_intrinsic_store_deref
:
456 replacement
= lower_store(intrin
, state
, vertex_index
, var
, offset
,
460 case nir_intrinsic_var_atomic_add
:
461 case nir_intrinsic_var_atomic_imin
:
462 case nir_intrinsic_var_atomic_umin
:
463 case nir_intrinsic_var_atomic_imax
:
464 case nir_intrinsic_var_atomic_umax
:
465 case nir_intrinsic_var_atomic_and
:
466 case nir_intrinsic_var_atomic_or
:
467 case nir_intrinsic_var_atomic_xor
:
468 case nir_intrinsic_var_atomic_exchange
:
469 case nir_intrinsic_var_atomic_comp_swap
:
470 assert(vertex_index
== NULL
);
471 replacement
= lower_atomic(intrin
, state
, var
, offset
);
474 case nir_intrinsic_interp_var_at_centroid
:
475 case nir_intrinsic_interp_var_at_sample
:
476 case nir_intrinsic_interp_var_at_offset
:
477 case nir_intrinsic_interp_deref_at_centroid
:
478 case nir_intrinsic_interp_deref_at_sample
:
479 case nir_intrinsic_interp_deref_at_offset
:
480 assert(vertex_index
== NULL
);
481 replacement
= lower_interpolate_at(intrin
, state
, var
, offset
,
489 if (nir_intrinsic_infos
[intrin
->intrinsic
].has_dest
) {
490 if (intrin
->dest
.is_ssa
) {
491 nir_ssa_dest_init(&replacement
->instr
, &replacement
->dest
,
492 intrin
->dest
.ssa
.num_components
,
493 intrin
->dest
.ssa
.bit_size
, NULL
);
494 nir_ssa_def_rewrite_uses(&intrin
->dest
.ssa
,
495 nir_src_for_ssa(&replacement
->dest
.ssa
));
497 nir_dest_copy(&replacement
->dest
, &intrin
->dest
, &intrin
->instr
);
501 nir_instr_insert_before(&intrin
->instr
, &replacement
->instr
);
502 nir_instr_remove(&intrin
->instr
);
510 nir_lower_io_impl(nir_function_impl
*impl
,
511 nir_variable_mode modes
,
512 int (*type_size
)(const struct glsl_type
*),
513 nir_lower_io_options options
)
515 struct lower_io_state state
;
516 bool progress
= false;
518 nir_builder_init(&state
.builder
, impl
);
519 state
.dead_ctx
= ralloc_context(NULL
);
521 state
.type_size
= type_size
;
522 state
.options
= options
;
524 nir_foreach_block(block
, impl
) {
525 progress
|= nir_lower_io_block(block
, &state
);
528 ralloc_free(state
.dead_ctx
);
530 nir_metadata_preserve(impl
, nir_metadata_block_index
|
531 nir_metadata_dominance
);
536 nir_lower_io(nir_shader
*shader
, nir_variable_mode modes
,
537 int (*type_size
)(const struct glsl_type
*),
538 nir_lower_io_options options
)
540 bool progress
= false;
542 nir_foreach_function(function
, shader
) {
543 if (function
->impl
) {
544 progress
|= nir_lower_io_impl(function
->impl
, modes
,
553 * Return the offset source for a load/store intrinsic.
556 nir_get_io_offset_src(nir_intrinsic_instr
*instr
)
558 switch (instr
->intrinsic
) {
559 case nir_intrinsic_load_input
:
560 case nir_intrinsic_load_output
:
561 case nir_intrinsic_load_uniform
:
562 return &instr
->src
[0];
563 case nir_intrinsic_load_ubo
:
564 case nir_intrinsic_load_ssbo
:
565 case nir_intrinsic_load_per_vertex_input
:
566 case nir_intrinsic_load_per_vertex_output
:
567 case nir_intrinsic_load_interpolated_input
:
568 case nir_intrinsic_store_output
:
569 return &instr
->src
[1];
570 case nir_intrinsic_store_ssbo
:
571 case nir_intrinsic_store_per_vertex_output
:
572 return &instr
->src
[2];
579 * Return the vertex index source for a load/store per_vertex intrinsic.
582 nir_get_io_vertex_index_src(nir_intrinsic_instr
*instr
)
584 switch (instr
->intrinsic
) {
585 case nir_intrinsic_load_per_vertex_input
:
586 case nir_intrinsic_load_per_vertex_output
:
587 return &instr
->src
[0];
588 case nir_intrinsic_store_per_vertex_output
:
589 return &instr
->src
[1];