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 * UBO's 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 * Returns true if we're processing a stage whose inputs are arrays indexed
69 * by a vertex number (such as geometry shader inputs).
72 is_per_vertex_input(struct lower_io_state
*state
, nir_variable
*var
)
74 gl_shader_stage stage
= state
->builder
.shader
->stage
;
76 return var
->data
.mode
== nir_var_shader_in
&& !var
->data
.patch
&&
77 (stage
== MESA_SHADER_TESS_CTRL
||
78 stage
== MESA_SHADER_TESS_EVAL
||
79 stage
== MESA_SHADER_GEOMETRY
);
83 is_per_vertex_output(struct lower_io_state
*state
, nir_variable
*var
)
85 gl_shader_stage stage
= state
->builder
.shader
->stage
;
86 return var
->data
.mode
== nir_var_shader_out
&& !var
->data
.patch
&&
87 stage
== MESA_SHADER_TESS_CTRL
;
91 get_io_offset(nir_builder
*b
, nir_deref_var
*deref
,
92 nir_ssa_def
**vertex_index
,
93 int (*type_size
)(const struct glsl_type
*))
95 nir_deref
*tail
= &deref
->deref
;
97 /* For per-vertex input arrays (i.e. geometry shader inputs), keep the
98 * outermost array index separate. Process the rest normally.
100 if (vertex_index
!= NULL
) {
102 nir_deref_array
*deref_array
= nir_deref_as_array(tail
);
104 nir_ssa_def
*vtx
= nir_imm_int(b
, deref_array
->base_offset
);
105 if (deref_array
->deref_array_type
== nir_deref_array_type_indirect
) {
106 vtx
= nir_iadd(b
, vtx
, nir_ssa_for_src(b
, deref_array
->indirect
, 1));
111 /* Just emit code and let constant-folding go to town */
112 nir_ssa_def
*offset
= nir_imm_int(b
, 0);
114 while (tail
->child
!= NULL
) {
115 const struct glsl_type
*parent_type
= tail
->type
;
118 if (tail
->deref_type
== nir_deref_type_array
) {
119 nir_deref_array
*deref_array
= nir_deref_as_array(tail
);
120 unsigned size
= type_size(tail
->type
);
122 offset
= nir_iadd(b
, offset
,
123 nir_imm_int(b
, size
* deref_array
->base_offset
));
125 if (deref_array
->deref_array_type
== nir_deref_array_type_indirect
) {
127 nir_imul(b
, nir_imm_int(b
, size
),
128 nir_ssa_for_src(b
, deref_array
->indirect
, 1));
130 offset
= nir_iadd(b
, offset
, mul
);
132 } else if (tail
->deref_type
== nir_deref_type_struct
) {
133 nir_deref_struct
*deref_struct
= nir_deref_as_struct(tail
);
135 unsigned field_offset
= 0;
136 for (unsigned i
= 0; i
< deref_struct
->index
; i
++) {
137 field_offset
+= type_size(glsl_get_struct_field(parent_type
, i
));
139 offset
= nir_iadd(b
, offset
, nir_imm_int(b
, field_offset
));
146 static nir_intrinsic_instr
*
147 lower_load(nir_intrinsic_instr
*intrin
, struct lower_io_state
*state
,
148 nir_ssa_def
*vertex_index
, nir_ssa_def
*offset
)
150 const nir_shader
*nir
= state
->builder
.shader
;
151 nir_variable
*var
= intrin
->variables
[0]->var
;
152 nir_variable_mode mode
= var
->data
.mode
;
153 nir_ssa_def
*barycentric
= NULL
;
157 case nir_var_shader_in
:
158 if (nir
->stage
== MESA_SHADER_FRAGMENT
&&
159 nir
->options
->use_interpolated_input_intrinsics
&&
160 var
->data
.interpolation
!= INTERP_MODE_FLAT
) {
161 assert(vertex_index
== NULL
);
163 nir_intrinsic_op bary_op
;
164 if (var
->data
.sample
||
165 (state
->options
& nir_lower_io_force_sample_interpolation
))
166 bary_op
= nir_intrinsic_load_barycentric_sample
;
167 else if (var
->data
.centroid
)
168 bary_op
= nir_intrinsic_load_barycentric_centroid
;
170 bary_op
= nir_intrinsic_load_barycentric_pixel
;
172 barycentric
= nir_load_barycentric(&state
->builder
, bary_op
,
173 var
->data
.interpolation
);
174 op
= nir_intrinsic_load_interpolated_input
;
176 op
= vertex_index
? nir_intrinsic_load_per_vertex_input
:
177 nir_intrinsic_load_input
;
180 case nir_var_shader_out
:
181 op
= vertex_index
? nir_intrinsic_load_per_vertex_output
:
182 nir_intrinsic_load_output
;
184 case nir_var_uniform
:
185 op
= nir_intrinsic_load_uniform
;
188 op
= nir_intrinsic_load_shared
;
191 unreachable("Unknown variable mode");
194 nir_intrinsic_instr
*load
= nir_intrinsic_instr_create(state
->mem_ctx
, op
);
195 load
->num_components
= intrin
->num_components
;
197 nir_intrinsic_set_base(load
, var
->data
.driver_location
);
198 if (mode
== nir_var_shader_in
|| mode
== nir_var_shader_out
)
199 nir_intrinsic_set_component(load
, var
->data
.location_frac
);
201 if (load
->intrinsic
== nir_intrinsic_load_uniform
)
202 nir_intrinsic_set_range(load
, state
->type_size(var
->type
));
205 load
->src
[0] = nir_src_for_ssa(vertex_index
);
206 load
->src
[1] = nir_src_for_ssa(offset
);
207 } else if (barycentric
) {
208 load
->src
[0] = nir_src_for_ssa(barycentric
);
209 load
->src
[1] = nir_src_for_ssa(offset
);
211 load
->src
[0] = nir_src_for_ssa(offset
);
217 static nir_intrinsic_instr
*
218 lower_store(nir_intrinsic_instr
*intrin
, struct lower_io_state
*state
,
219 nir_ssa_def
*vertex_index
, nir_ssa_def
*offset
)
221 nir_variable
*var
= intrin
->variables
[0]->var
;
222 nir_variable_mode mode
= var
->data
.mode
;
225 if (mode
== nir_var_shared
) {
226 op
= nir_intrinsic_store_shared
;
228 assert(mode
== nir_var_shader_out
);
229 op
= vertex_index
? nir_intrinsic_store_per_vertex_output
:
230 nir_intrinsic_store_output
;
233 nir_intrinsic_instr
*store
= nir_intrinsic_instr_create(state
->mem_ctx
, op
);
234 store
->num_components
= intrin
->num_components
;
236 nir_src_copy(&store
->src
[0], &intrin
->src
[0], store
);
238 nir_intrinsic_set_base(store
, var
->data
.driver_location
);
240 if (mode
== nir_var_shader_out
)
241 nir_intrinsic_set_component(store
, var
->data
.location_frac
);
243 nir_intrinsic_set_write_mask(store
, nir_intrinsic_write_mask(intrin
));
246 store
->src
[1] = nir_src_for_ssa(vertex_index
);
248 store
->src
[vertex_index
? 2 : 1] = nir_src_for_ssa(offset
);
253 static nir_intrinsic_instr
*
254 lower_atomic(nir_intrinsic_instr
*intrin
, struct lower_io_state
*state
,
257 nir_variable
*var
= intrin
->variables
[0]->var
;
259 assert(var
->data
.mode
== nir_var_shared
);
262 switch (intrin
->intrinsic
) {
263 #define OP(O) case nir_intrinsic_var_##O: op = nir_intrinsic_shared_##O; break;
276 unreachable("Invalid atomic");
279 nir_intrinsic_instr
*atomic
=
280 nir_intrinsic_instr_create(state
->mem_ctx
, op
);
282 nir_intrinsic_set_base(atomic
, var
->data
.driver_location
);
284 atomic
->src
[0] = nir_src_for_ssa(offset
);
285 for (unsigned i
= 0; i
< nir_intrinsic_infos
[intrin
->intrinsic
].num_srcs
; i
++) {
286 nir_src_copy(&atomic
->src
[i
+1], &intrin
->src
[i
], atomic
);
292 static nir_intrinsic_instr
*
293 lower_interpolate_at(nir_intrinsic_instr
*intrin
, struct lower_io_state
*state
,
296 nir_variable
*var
= intrin
->variables
[0]->var
;
298 assert(var
->data
.mode
== nir_var_shader_in
);
300 /* Ignore interpolateAt() for flat variables - flat is flat. */
301 if (var
->data
.interpolation
== INTERP_MODE_FLAT
)
302 return lower_load(intrin
, state
, NULL
, offset
);
304 nir_intrinsic_op bary_op
;
305 switch (intrin
->intrinsic
) {
306 case nir_intrinsic_interp_var_at_centroid
:
307 bary_op
= (state
->options
& nir_lower_io_force_sample_interpolation
) ?
308 nir_intrinsic_load_barycentric_sample
:
309 nir_intrinsic_load_barycentric_centroid
;
311 case nir_intrinsic_interp_var_at_sample
:
312 bary_op
= nir_intrinsic_load_barycentric_at_sample
;
314 case nir_intrinsic_interp_var_at_offset
:
315 bary_op
= nir_intrinsic_load_barycentric_at_offset
;
318 unreachable("Bogus interpolateAt() intrinsic.");
321 nir_intrinsic_instr
*bary_setup
=
322 nir_intrinsic_instr_create(state
->mem_ctx
, bary_op
);
324 nir_ssa_dest_init(&bary_setup
->instr
, &bary_setup
->dest
, 2, 32, NULL
);
325 nir_intrinsic_set_interp_mode(bary_setup
, var
->data
.interpolation
);
327 if (intrin
->intrinsic
!= nir_intrinsic_interp_var_at_centroid
)
328 nir_src_copy(&bary_setup
->src
[0], &intrin
->src
[0], bary_setup
);
330 nir_builder_instr_insert(&state
->builder
, &bary_setup
->instr
);
332 nir_intrinsic_instr
*load
=
333 nir_intrinsic_instr_create(state
->mem_ctx
,
334 nir_intrinsic_load_interpolated_input
);
335 load
->num_components
= intrin
->num_components
;
337 nir_intrinsic_set_base(load
, var
->data
.driver_location
);
338 nir_intrinsic_set_component(load
, var
->data
.location_frac
);
340 load
->src
[0] = nir_src_for_ssa(&bary_setup
->dest
.ssa
);
341 load
->src
[1] = nir_src_for_ssa(offset
);
347 nir_lower_io_block(nir_block
*block
,
348 struct lower_io_state
*state
)
350 nir_builder
*b
= &state
->builder
;
351 const nir_shader_compiler_options
*options
= b
->shader
->options
;
353 nir_foreach_instr_safe(instr
, block
) {
354 if (instr
->type
!= nir_instr_type_intrinsic
)
357 nir_intrinsic_instr
*intrin
= nir_instr_as_intrinsic(instr
);
359 switch (intrin
->intrinsic
) {
360 case nir_intrinsic_load_var
:
361 case nir_intrinsic_store_var
:
362 case nir_intrinsic_var_atomic_add
:
363 case nir_intrinsic_var_atomic_imin
:
364 case nir_intrinsic_var_atomic_umin
:
365 case nir_intrinsic_var_atomic_imax
:
366 case nir_intrinsic_var_atomic_umax
:
367 case nir_intrinsic_var_atomic_and
:
368 case nir_intrinsic_var_atomic_or
:
369 case nir_intrinsic_var_atomic_xor
:
370 case nir_intrinsic_var_atomic_exchange
:
371 case nir_intrinsic_var_atomic_comp_swap
:
372 /* We can lower the io for this nir instrinsic */
374 case nir_intrinsic_interp_var_at_centroid
:
375 case nir_intrinsic_interp_var_at_sample
:
376 case nir_intrinsic_interp_var_at_offset
:
377 /* We can optionally lower these to load_interpolated_input */
378 if (options
->use_interpolated_input_intrinsics
)
381 /* We can't lower the io for this nir instrinsic, so skip it */
385 nir_variable
*var
= intrin
->variables
[0]->var
;
386 nir_variable_mode mode
= var
->data
.mode
;
388 if ((state
->modes
& mode
) == 0)
391 if (mode
!= nir_var_shader_in
&&
392 mode
!= nir_var_shader_out
&&
393 mode
!= nir_var_shared
&&
394 mode
!= nir_var_uniform
)
397 b
->cursor
= nir_before_instr(instr
);
399 const bool per_vertex
=
400 is_per_vertex_input(state
, var
) || is_per_vertex_output(state
, var
);
403 nir_ssa_def
*vertex_index
= NULL
;
405 offset
= get_io_offset(b
, intrin
->variables
[0],
406 per_vertex
? &vertex_index
: NULL
,
409 nir_intrinsic_instr
*replacement
;
411 switch (intrin
->intrinsic
) {
412 case nir_intrinsic_load_var
:
413 replacement
= lower_load(intrin
, state
, vertex_index
, offset
);
416 case nir_intrinsic_store_var
:
417 replacement
= lower_store(intrin
, state
, vertex_index
, offset
);
420 case nir_intrinsic_var_atomic_add
:
421 case nir_intrinsic_var_atomic_imin
:
422 case nir_intrinsic_var_atomic_umin
:
423 case nir_intrinsic_var_atomic_imax
:
424 case nir_intrinsic_var_atomic_umax
:
425 case nir_intrinsic_var_atomic_and
:
426 case nir_intrinsic_var_atomic_or
:
427 case nir_intrinsic_var_atomic_xor
:
428 case nir_intrinsic_var_atomic_exchange
:
429 case nir_intrinsic_var_atomic_comp_swap
:
430 assert(vertex_index
== NULL
);
431 replacement
= lower_atomic(intrin
, state
, offset
);
434 case nir_intrinsic_interp_var_at_centroid
:
435 case nir_intrinsic_interp_var_at_sample
:
436 case nir_intrinsic_interp_var_at_offset
:
437 assert(vertex_index
== NULL
);
438 replacement
= lower_interpolate_at(intrin
, state
, offset
);
445 if (nir_intrinsic_infos
[intrin
->intrinsic
].has_dest
) {
446 if (intrin
->dest
.is_ssa
) {
447 nir_ssa_dest_init(&replacement
->instr
, &replacement
->dest
,
448 intrin
->dest
.ssa
.num_components
,
449 intrin
->dest
.ssa
.bit_size
, NULL
);
450 nir_ssa_def_rewrite_uses(&intrin
->dest
.ssa
,
451 nir_src_for_ssa(&replacement
->dest
.ssa
));
453 nir_dest_copy(&replacement
->dest
, &intrin
->dest
, state
->mem_ctx
);
457 nir_instr_insert_before(&intrin
->instr
, &replacement
->instr
);
458 nir_instr_remove(&intrin
->instr
);
465 nir_lower_io_impl(nir_function_impl
*impl
,
466 nir_variable_mode modes
,
467 int (*type_size
)(const struct glsl_type
*),
468 nir_lower_io_options options
)
470 struct lower_io_state state
;
472 nir_builder_init(&state
.builder
, impl
);
473 state
.mem_ctx
= ralloc_parent(impl
);
475 state
.type_size
= type_size
;
476 state
.options
= options
;
478 nir_foreach_block(block
, impl
) {
479 nir_lower_io_block(block
, &state
);
482 nir_metadata_preserve(impl
, nir_metadata_block_index
|
483 nir_metadata_dominance
);
487 nir_lower_io(nir_shader
*shader
, nir_variable_mode modes
,
488 int (*type_size
)(const struct glsl_type
*),
489 nir_lower_io_options options
)
491 nir_foreach_function(function
, shader
) {
492 if (function
->impl
) {
493 nir_lower_io_impl(function
->impl
, modes
, type_size
, options
);
499 * Return the offset soruce for a load/store intrinsic.
502 nir_get_io_offset_src(nir_intrinsic_instr
*instr
)
504 switch (instr
->intrinsic
) {
505 case nir_intrinsic_load_input
:
506 case nir_intrinsic_load_output
:
507 case nir_intrinsic_load_uniform
:
508 return &instr
->src
[0];
509 case nir_intrinsic_load_ubo
:
510 case nir_intrinsic_load_ssbo
:
511 case nir_intrinsic_load_per_vertex_input
:
512 case nir_intrinsic_load_per_vertex_output
:
513 case nir_intrinsic_load_interpolated_input
:
514 case nir_intrinsic_store_output
:
515 return &instr
->src
[1];
516 case nir_intrinsic_store_ssbo
:
517 case nir_intrinsic_store_per_vertex_output
:
518 return &instr
->src
[2];
525 * Return the vertex index source for a load/store per_vertex intrinsic.
528 nir_get_io_vertex_index_src(nir_intrinsic_instr
*instr
)
530 switch (instr
->intrinsic
) {
531 case nir_intrinsic_load_per_vertex_input
:
532 case nir_intrinsic_load_per_vertex_output
:
533 return &instr
->src
[0];
534 case nir_intrinsic_store_per_vertex_output
:
535 return &instr
->src
[1];