2 * Copyright © 2012 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
21 * DEALINGS IN THE SOFTWARE.
25 * \file lower_ubo_reference.cpp
27 * IR lower pass to replace dereferences of variables in a uniform
28 * buffer object with usage of ir_binop_ubo_load expressions, each of
29 * which can read data up to the size of a vec4.
31 * This relieves drivers of the responsibility to deal with tricky UBO
32 * layout issues like std140 structures and row_major matrices on
37 #include "ir_builder.h"
38 #include "ir_rvalue_visitor.h"
39 #include "main/macros.h"
40 #include "glsl_parser_extras.h"
42 using namespace ir_builder
;
45 * Determine if a thing being dereferenced is row-major
47 * There is some trickery here.
49 * If the thing being dereferenced is a member of uniform block \b without an
50 * instance name, then the name of the \c ir_variable is the field name of an
51 * interface type. If this field is row-major, then the thing referenced is
54 * If the thing being dereferenced is a member of uniform block \b with an
55 * instance name, then the last dereference in the tree will be an
56 * \c ir_dereference_record. If that record field is row-major, then the
57 * thing referenced is row-major.
60 is_dereferenced_thing_row_major(const ir_rvalue
*deref
)
63 const ir_rvalue
*ir
= deref
;
66 matrix
= matrix
|| ir
->type
->without_array()->is_matrix();
68 switch (ir
->ir_type
) {
69 case ir_type_dereference_array
: {
70 const ir_dereference_array
*const array_deref
=
71 (const ir_dereference_array
*) ir
;
73 ir
= array_deref
->array
;
77 case ir_type_dereference_record
: {
78 const ir_dereference_record
*const record_deref
=
79 (const ir_dereference_record
*) ir
;
81 ir
= record_deref
->record
;
83 const int idx
= ir
->type
->field_index(record_deref
->field
);
86 const enum glsl_matrix_layout matrix_layout
=
87 glsl_matrix_layout(ir
->type
->fields
.structure
[idx
].matrix_layout
);
89 switch (matrix_layout
) {
90 case GLSL_MATRIX_LAYOUT_INHERITED
:
92 case GLSL_MATRIX_LAYOUT_COLUMN_MAJOR
:
94 case GLSL_MATRIX_LAYOUT_ROW_MAJOR
:
95 return matrix
|| deref
->type
->without_array()->is_record();
101 case ir_type_dereference_variable
: {
102 const ir_dereference_variable
*const var_deref
=
103 (const ir_dereference_variable
*) ir
;
105 const enum glsl_matrix_layout matrix_layout
=
106 glsl_matrix_layout(var_deref
->var
->data
.matrix_layout
);
108 switch (matrix_layout
) {
109 case GLSL_MATRIX_LAYOUT_INHERITED
:
112 case GLSL_MATRIX_LAYOUT_COLUMN_MAJOR
:
114 case GLSL_MATRIX_LAYOUT_ROW_MAJOR
:
115 return matrix
|| deref
->type
->without_array()->is_record();
118 unreachable("invalid matrix layout");
127 /* The tree must have ended with a dereference that wasn't an
128 * ir_dereference_variable. That is invalid, and it should be impossible.
130 unreachable("invalid dereference tree");
135 class lower_ubo_reference_visitor
: public ir_rvalue_enter_visitor
{
137 lower_ubo_reference_visitor(struct gl_shader
*shader
)
142 void handle_rvalue(ir_rvalue
**rvalue
);
143 ir_visitor_status
visit_enter(ir_assignment
*ir
);
145 void setup_for_load_or_store(ir_variable
*var
,
148 unsigned *const_offset
,
152 ir_expression
*ubo_load(const struct glsl_type
*type
,
154 ir_call
*ssbo_load(const struct glsl_type
*type
,
157 void check_for_ssbo_store(ir_assignment
*ir
);
158 void write_to_memory(ir_dereference
*deref
,
160 ir_variable
*write_var
,
161 unsigned write_mask
);
162 ir_call
*ssbo_store(ir_rvalue
*deref
, ir_rvalue
*offset
,
163 unsigned write_mask
);
165 void emit_access(bool is_write
, ir_dereference
*deref
,
166 ir_variable
*base_offset
, unsigned int deref_offset
,
167 bool row_major
, int matrix_columns
,
168 unsigned packing
, unsigned write_mask
);
170 ir_visitor_status
visit_enter(class ir_expression
*);
171 ir_expression
*calculate_ssbo_unsized_array_length(ir_expression
*expr
);
172 void check_ssbo_unsized_array_length_expression(class ir_expression
*);
173 void check_ssbo_unsized_array_length_assignment(ir_assignment
*ir
);
175 ir_expression
*process_ssbo_unsized_array_length(ir_rvalue
**,
178 ir_expression
*emit_ssbo_get_buffer_size();
180 unsigned calculate_unsized_array_stride(ir_dereference
*deref
,
183 ir_call
*lower_ssbo_atomic_intrinsic(ir_call
*ir
);
184 ir_call
*check_for_ssbo_atomic_intrinsic(ir_call
*ir
);
185 ir_visitor_status
visit_enter(ir_call
*ir
);
188 struct gl_shader
*shader
;
189 struct gl_uniform_buffer_variable
*ubo_var
;
190 ir_rvalue
*uniform_block
;
192 bool is_shader_storage
;
196 * Determine the name of the interface block field
198 * This is the name of the specific member as it would appear in the
199 * \c gl_uniform_buffer_variable::Name field in the shader's
200 * \c UniformBlocks array.
203 interface_field_name(void *mem_ctx
, char *base_name
, ir_rvalue
*d
,
204 ir_rvalue
**nonconst_block_index
)
206 ir_rvalue
*previous_index
= NULL
;
207 *nonconst_block_index
= NULL
;
210 switch (d
->ir_type
) {
211 case ir_type_dereference_variable
: {
212 ir_dereference_variable
*v
= (ir_dereference_variable
*) d
;
214 && v
->var
->is_interface_instance()
215 && v
->var
->type
->is_array()) {
217 ir_constant
*const_index
= previous_index
->as_constant();
219 *nonconst_block_index
= previous_index
;
220 return ralloc_asprintf(mem_ctx
, "%s[0]", base_name
);
222 return ralloc_asprintf(mem_ctx
,
225 const_index
->get_uint_component(0));
234 case ir_type_dereference_record
: {
235 ir_dereference_record
*r
= (ir_dereference_record
*) d
;
237 d
= r
->record
->as_dereference();
241 case ir_type_dereference_array
: {
242 ir_dereference_array
*a
= (ir_dereference_array
*) d
;
244 d
= a
->array
->as_dereference();
245 previous_index
= a
->array_index
;
249 case ir_type_swizzle
: {
250 ir_swizzle
*s
= (ir_swizzle
*) d
;
252 d
= s
->val
->as_dereference();
256 assert(!"Should not get here.");
261 assert(!"Should not get here.");
266 lower_ubo_reference_visitor::setup_for_load_or_store(ir_variable
*var
,
269 unsigned *const_offset
,
274 /* Determine the name of the interface block */
275 ir_rvalue
*nonconst_block_index
;
276 const char *const field_name
=
277 interface_field_name(mem_ctx
, (char *) var
->get_interface_type()->name
,
278 deref
, &nonconst_block_index
);
280 /* Locate the ubo block by interface name */
281 this->uniform_block
= NULL
;
282 for (unsigned i
= 0; i
< shader
->NumUniformBlocks
; i
++) {
283 if (strcmp(field_name
, shader
->UniformBlocks
[i
].Name
) == 0) {
285 ir_constant
*index
= new(mem_ctx
) ir_constant(i
);
287 if (nonconst_block_index
) {
288 if (nonconst_block_index
->type
!= glsl_type::uint_type
)
289 nonconst_block_index
= i2u(nonconst_block_index
);
290 this->uniform_block
= add(nonconst_block_index
, index
);
292 this->uniform_block
= index
;
295 this->is_shader_storage
= shader
->UniformBlocks
[i
].IsShaderStorage
;
297 struct gl_uniform_block
*block
= &shader
->UniformBlocks
[i
];
299 this->ubo_var
= var
->is_interface_instance()
300 ? &block
->Uniforms
[0] : &block
->Uniforms
[var
->data
.location
];
306 assert(this->uniform_block
);
308 *offset
= new(mem_ctx
) ir_constant(0u);
310 *row_major
= is_dereferenced_thing_row_major(deref
);
313 /* Calculate the offset to the start of the region of the UBO
314 * dereferenced by *rvalue. This may be a variable offset if an
315 * array dereference has a variable index.
318 switch (deref
->ir_type
) {
319 case ir_type_dereference_variable
: {
320 *const_offset
+= ubo_var
->Offset
;
325 case ir_type_dereference_array
: {
326 ir_dereference_array
*deref_array
= (ir_dereference_array
*) deref
;
327 unsigned array_stride
;
328 if (deref_array
->array
->type
->is_matrix() && *row_major
) {
329 /* When loading a vector out of a row major matrix, the
330 * step between the columns (vectors) is the size of a
331 * float, while the step between the rows (elements of a
332 * vector) is handled below in emit_ubo_loads.
335 if (deref_array
->array
->type
->is_double())
337 *matrix_columns
= deref_array
->array
->type
->matrix_columns
;
338 } else if (deref_array
->type
->is_interface()) {
339 /* We're processing an array dereference of an interface instance
340 * array. The thing being dereferenced *must* be a variable
341 * dereference because interfaces cannot be embedded in other
342 * types. In terms of calculating the offsets for the lowering
343 * pass, we don't care about the array index. All elements of an
344 * interface instance array will have the same offsets relative to
345 * the base of the block that backs them.
347 assert(deref_array
->array
->as_dereference_variable());
348 deref
= deref_array
->array
->as_dereference();
351 /* Whether or not the field is row-major (because it might be a
352 * bvec2 or something) does not affect the array itself. We need
353 * to know whether an array element in its entirety is row-major.
355 const bool array_row_major
=
356 is_dereferenced_thing_row_major(deref_array
);
358 /* The array type will give the correct interface packing
361 if (packing
== GLSL_INTERFACE_PACKING_STD430
) {
362 array_stride
= deref_array
->type
->std430_array_stride(array_row_major
);
364 array_stride
= deref_array
->type
->std140_size(array_row_major
);
365 array_stride
= glsl_align(array_stride
, 16);
369 ir_rvalue
*array_index
= deref_array
->array_index
;
370 if (array_index
->type
->base_type
== GLSL_TYPE_INT
)
371 array_index
= i2u(array_index
);
373 ir_constant
*const_index
=
374 array_index
->constant_expression_value(NULL
);
376 *const_offset
+= array_stride
* const_index
->value
.u
[0];
378 *offset
= add(*offset
,
380 new(mem_ctx
) ir_constant(array_stride
)));
382 deref
= deref_array
->array
->as_dereference();
386 case ir_type_dereference_record
: {
387 ir_dereference_record
*deref_record
= (ir_dereference_record
*) deref
;
388 const glsl_type
*struct_type
= deref_record
->record
->type
;
389 unsigned intra_struct_offset
= 0;
391 for (unsigned int i
= 0; i
< struct_type
->length
; i
++) {
392 const glsl_type
*type
= struct_type
->fields
.structure
[i
].type
;
394 ir_dereference_record
*field_deref
= new(mem_ctx
)
395 ir_dereference_record(deref_record
->record
,
396 struct_type
->fields
.structure
[i
].name
);
397 const bool field_row_major
=
398 is_dereferenced_thing_row_major(field_deref
);
400 ralloc_free(field_deref
);
402 unsigned field_align
= 0;
404 if (packing
== GLSL_INTERFACE_PACKING_STD430
)
405 field_align
= type
->std430_base_alignment(field_row_major
);
407 field_align
= type
->std140_base_alignment(field_row_major
);
409 intra_struct_offset
= glsl_align(intra_struct_offset
, field_align
);
411 if (strcmp(struct_type
->fields
.structure
[i
].name
,
412 deref_record
->field
) == 0)
415 if (packing
== GLSL_INTERFACE_PACKING_STD430
)
416 intra_struct_offset
+= type
->std430_size(field_row_major
);
418 intra_struct_offset
+= type
->std140_size(field_row_major
);
420 /* If the field just examined was itself a structure, apply rule
423 * "The structure may have padding at the end; the base offset
424 * of the member following the sub-structure is rounded up to
425 * the next multiple of the base alignment of the structure."
427 if (type
->without_array()->is_record()) {
428 intra_struct_offset
= glsl_align(intra_struct_offset
,
434 *const_offset
+= intra_struct_offset
;
435 deref
= deref_record
->record
->as_dereference();
439 case ir_type_swizzle
: {
440 ir_swizzle
*deref_swizzle
= (ir_swizzle
*) deref
;
442 assert(deref_swizzle
->mask
.num_components
== 1);
444 *const_offset
+= deref_swizzle
->mask
.x
* sizeof(int);
445 deref
= deref_swizzle
->val
->as_dereference();
450 assert(!"not reached");
458 lower_ubo_reference_visitor::handle_rvalue(ir_rvalue
**rvalue
)
463 ir_dereference
*deref
= (*rvalue
)->as_dereference();
467 ir_variable
*var
= deref
->variable_referenced();
468 if (!var
|| !var
->is_in_buffer_block())
471 mem_ctx
= ralloc_parent(shader
->ir
);
473 ir_rvalue
*offset
= NULL
;
474 unsigned const_offset
;
477 unsigned packing
= var
->get_interface_type()->interface_packing
;
479 /* Compute the offset to the start if the dereference as well as other
480 * information we need to configure the write
482 setup_for_load_or_store(var
, deref
,
483 &offset
, &const_offset
,
484 &row_major
, &matrix_columns
,
488 /* Now that we've calculated the offset to the start of the
489 * dereference, walk over the type and emit loads into a temporary.
491 const glsl_type
*type
= (*rvalue
)->type
;
492 ir_variable
*load_var
= new(mem_ctx
) ir_variable(type
,
495 base_ir
->insert_before(load_var
);
497 ir_variable
*load_offset
= new(mem_ctx
) ir_variable(glsl_type::uint_type
,
498 "ubo_load_temp_offset",
500 base_ir
->insert_before(load_offset
);
501 base_ir
->insert_before(assign(load_offset
, offset
));
503 deref
= new(mem_ctx
) ir_dereference_variable(load_var
);
504 emit_access(false, deref
, load_offset
, const_offset
,
505 row_major
, matrix_columns
, packing
, 0);
512 lower_ubo_reference_visitor::ubo_load(const glsl_type
*type
,
515 ir_rvalue
*block_ref
= this->uniform_block
->clone(mem_ctx
, NULL
);
517 ir_expression(ir_binop_ubo_load
,
525 shader_storage_buffer_object(const _mesa_glsl_parse_state
*state
)
527 return state
->ARB_shader_storage_buffer_object_enable
;
531 lower_ubo_reference_visitor::ssbo_store(ir_rvalue
*deref
,
535 exec_list sig_params
;
537 ir_variable
*block_ref
= new(mem_ctx
)
538 ir_variable(glsl_type::uint_type
, "block_ref" , ir_var_function_in
);
539 sig_params
.push_tail(block_ref
);
541 ir_variable
*offset_ref
= new(mem_ctx
)
542 ir_variable(glsl_type::uint_type
, "offset" , ir_var_function_in
);
543 sig_params
.push_tail(offset_ref
);
545 ir_variable
*val_ref
= new(mem_ctx
)
546 ir_variable(deref
->type
, "value" , ir_var_function_in
);
547 sig_params
.push_tail(val_ref
);
549 ir_variable
*writemask_ref
= new(mem_ctx
)
550 ir_variable(glsl_type::uint_type
, "write_mask" , ir_var_function_in
);
551 sig_params
.push_tail(writemask_ref
);
553 ir_function_signature
*sig
= new(mem_ctx
)
554 ir_function_signature(glsl_type::void_type
, shader_storage_buffer_object
);
556 sig
->replace_parameters(&sig_params
);
557 sig
->is_intrinsic
= true;
559 ir_function
*f
= new(mem_ctx
) ir_function("__intrinsic_store_ssbo");
560 f
->add_signature(sig
);
562 exec_list call_params
;
563 call_params
.push_tail(this->uniform_block
->clone(mem_ctx
, NULL
));
564 call_params
.push_tail(offset
->clone(mem_ctx
, NULL
));
565 call_params
.push_tail(deref
->clone(mem_ctx
, NULL
));
566 call_params
.push_tail(new(mem_ctx
) ir_constant(write_mask
));
567 return new(mem_ctx
) ir_call(sig
, NULL
, &call_params
);
571 lower_ubo_reference_visitor::ssbo_load(const struct glsl_type
*type
,
574 exec_list sig_params
;
576 ir_variable
*block_ref
= new(mem_ctx
)
577 ir_variable(glsl_type::uint_type
, "block_ref" , ir_var_function_in
);
578 sig_params
.push_tail(block_ref
);
580 ir_variable
*offset_ref
= new(mem_ctx
)
581 ir_variable(glsl_type::uint_type
, "offset_ref" , ir_var_function_in
);
582 sig_params
.push_tail(offset_ref
);
584 ir_function_signature
*sig
=
585 new(mem_ctx
) ir_function_signature(type
, shader_storage_buffer_object
);
587 sig
->replace_parameters(&sig_params
);
588 sig
->is_intrinsic
= true;
590 ir_function
*f
= new(mem_ctx
) ir_function("__intrinsic_load_ssbo");
591 f
->add_signature(sig
);
593 ir_variable
*result
= new(mem_ctx
)
594 ir_variable(type
, "ssbo_load_result", ir_var_temporary
);
595 base_ir
->insert_before(result
);
596 ir_dereference_variable
*deref_result
= new(mem_ctx
)
597 ir_dereference_variable(result
);
599 exec_list call_params
;
600 call_params
.push_tail(this->uniform_block
->clone(mem_ctx
, NULL
));
601 call_params
.push_tail(offset
->clone(mem_ctx
, NULL
));
603 return new(mem_ctx
) ir_call(sig
, deref_result
, &call_params
);
607 writemask_for_size(unsigned n
)
609 return ((1 << n
) - 1);
613 * Takes a deref and recursively calls itself to break the deref down to the
614 * point that the reads or writes generated are contiguous scalars or vectors.
617 lower_ubo_reference_visitor::emit_access(bool is_write
,
618 ir_dereference
*deref
,
619 ir_variable
*base_offset
,
620 unsigned int deref_offset
,
626 if (deref
->type
->is_record()) {
627 unsigned int field_offset
= 0;
629 for (unsigned i
= 0; i
< deref
->type
->length
; i
++) {
630 const struct glsl_struct_field
*field
=
631 &deref
->type
->fields
.structure
[i
];
632 ir_dereference
*field_deref
=
633 new(mem_ctx
) ir_dereference_record(deref
->clone(mem_ctx
, NULL
),
637 glsl_align(field_offset
,
638 field
->type
->std140_base_alignment(row_major
));
640 emit_access(is_write
, field_deref
, base_offset
,
641 deref_offset
+ field_offset
,
642 row_major
, 1, packing
,
643 writemask_for_size(field_deref
->type
->vector_elements
));
645 field_offset
+= field
->type
->std140_size(row_major
);
650 if (deref
->type
->is_array()) {
651 unsigned array_stride
= packing
== GLSL_INTERFACE_PACKING_STD430
?
652 deref
->type
->fields
.array
->std430_array_stride(row_major
) :
653 glsl_align(deref
->type
->fields
.array
->std140_size(row_major
), 16);
655 for (unsigned i
= 0; i
< deref
->type
->length
; i
++) {
656 ir_constant
*element
= new(mem_ctx
) ir_constant(i
);
657 ir_dereference
*element_deref
=
658 new(mem_ctx
) ir_dereference_array(deref
->clone(mem_ctx
, NULL
),
660 emit_access(is_write
, element_deref
, base_offset
,
661 deref_offset
+ i
* array_stride
,
662 row_major
, 1, packing
,
663 writemask_for_size(element_deref
->type
->vector_elements
));
668 if (deref
->type
->is_matrix()) {
669 for (unsigned i
= 0; i
< deref
->type
->matrix_columns
; i
++) {
670 ir_constant
*col
= new(mem_ctx
) ir_constant(i
);
671 ir_dereference
*col_deref
=
672 new(mem_ctx
) ir_dereference_array(deref
->clone(mem_ctx
, NULL
), col
);
675 /* For a row-major matrix, the next column starts at the next
678 int size_mul
= deref
->type
->is_double() ? 8 : 4;
679 emit_access(is_write
, col_deref
, base_offset
,
680 deref_offset
+ i
* size_mul
,
681 row_major
, deref
->type
->matrix_columns
, packing
,
682 writemask_for_size(col_deref
->type
->vector_elements
));
686 /* std430 doesn't round up vec2 size to a vec4 size */
687 if (packing
== GLSL_INTERFACE_PACKING_STD430
&&
688 deref
->type
->vector_elements
== 2 &&
689 !deref
->type
->is_double()) {
692 /* std140 always rounds the stride of arrays (and matrices) to a
693 * vec4, so matrices are always 16 between columns/rows. With
694 * doubles, they will be 32 apart when there are more than 2 rows.
696 * For both std140 and std430, if the member is a
697 * three-'component vector with components consuming N basic
698 * machine units, the base alignment is 4N. For vec4, base
701 size_mul
= (deref
->type
->is_double() &&
702 deref
->type
->vector_elements
> 2) ? 32 : 16;
705 emit_access(is_write
, col_deref
, base_offset
,
706 deref_offset
+ i
* size_mul
,
707 row_major
, deref
->type
->matrix_columns
, packing
,
708 writemask_for_size(col_deref
->type
->vector_elements
));
714 assert(deref
->type
->is_scalar() || deref
->type
->is_vector());
718 add(base_offset
, new(mem_ctx
) ir_constant(deref_offset
));
720 base_ir
->insert_after(ssbo_store(deref
, offset
, write_mask
));
722 if (!this->is_shader_storage
) {
723 base_ir
->insert_before(assign(deref
->clone(mem_ctx
, NULL
),
724 ubo_load(deref
->type
, offset
)));
726 ir_call
*load_ssbo
= ssbo_load(deref
->type
, offset
);
727 base_ir
->insert_before(load_ssbo
);
728 ir_rvalue
*value
= load_ssbo
->return_deref
->as_rvalue()->clone(mem_ctx
, NULL
);
729 base_ir
->insert_before(assign(deref
->clone(mem_ctx
, NULL
), value
));
733 unsigned N
= deref
->type
->is_double() ? 8 : 4;
735 /* We're dereffing a column out of a row-major matrix, so we
736 * gather the vector from each stored row.
738 assert(deref
->type
->base_type
== GLSL_TYPE_FLOAT
||
739 deref
->type
->base_type
== GLSL_TYPE_DOUBLE
);
740 /* Matrices, row_major or not, are stored as if they were
741 * arrays of vectors of the appropriate size in std140.
742 * Arrays have their strides rounded up to a vec4, so the
743 * matrix stride is always 16. However a double matrix may either be 16
744 * or 32 depending on the number of columns.
746 assert(matrix_columns
<= 4);
747 unsigned matrix_stride
= glsl_align(matrix_columns
* N
, 16);
749 const glsl_type
*deref_type
= deref
->type
->base_type
== GLSL_TYPE_FLOAT
?
750 glsl_type::float_type
: glsl_type::double_type
;
752 for (unsigned i
= 0; i
< deref
->type
->vector_elements
; i
++) {
753 ir_rvalue
*chan_offset
=
755 new(mem_ctx
) ir_constant(deref_offset
+ i
* matrix_stride
));
757 base_ir
->insert_after(ssbo_store(swizzle(deref
, i
, 1), chan_offset
, 1));
759 if (!this->is_shader_storage
) {
760 base_ir
->insert_before(assign(deref
->clone(mem_ctx
, NULL
),
761 ubo_load(deref_type
, chan_offset
),
764 ir_call
*load_ssbo
= ssbo_load(deref_type
, chan_offset
);
765 base_ir
->insert_before(load_ssbo
);
766 ir_rvalue
*value
= load_ssbo
->return_deref
->as_rvalue()->clone(mem_ctx
, NULL
);
767 base_ir
->insert_before(assign(deref
->clone(mem_ctx
, NULL
),
777 lower_ubo_reference_visitor::write_to_memory(ir_dereference
*deref
,
779 ir_variable
*write_var
,
782 ir_rvalue
*offset
= NULL
;
783 unsigned const_offset
;
786 unsigned packing
= var
->get_interface_type()->interface_packing
;
788 /* Compute the offset to the start if the dereference as well as other
789 * information we need to configure the write
791 setup_for_load_or_store(var
, deref
,
792 &offset
, &const_offset
,
793 &row_major
, &matrix_columns
,
797 /* Now emit writes from the temporary to memory */
798 ir_variable
*write_offset
=
799 new(mem_ctx
) ir_variable(glsl_type::uint_type
,
800 "ssbo_store_temp_offset",
803 base_ir
->insert_before(write_offset
);
804 base_ir
->insert_before(assign(write_offset
, offset
));
806 deref
= new(mem_ctx
) ir_dereference_variable(write_var
);
807 emit_access(true, deref
, write_offset
, const_offset
,
808 row_major
, matrix_columns
, packing
, write_mask
);
812 lower_ubo_reference_visitor::visit_enter(ir_expression
*ir
)
814 check_ssbo_unsized_array_length_expression(ir
);
815 return rvalue_visit(ir
);
819 lower_ubo_reference_visitor::calculate_ssbo_unsized_array_length(ir_expression
*expr
)
821 if (expr
->operation
!=
822 ir_expression_operation(ir_unop_ssbo_unsized_array_length
))
825 ir_rvalue
*rvalue
= expr
->operands
[0]->as_rvalue();
827 !rvalue
->type
->is_array() || !rvalue
->type
->is_unsized_array())
830 ir_dereference
*deref
= expr
->operands
[0]->as_dereference();
834 ir_variable
*var
= expr
->operands
[0]->variable_referenced();
835 if (!var
|| !var
->is_in_shader_storage_block())
837 return process_ssbo_unsized_array_length(&rvalue
, deref
, var
);
841 lower_ubo_reference_visitor::check_ssbo_unsized_array_length_expression(ir_expression
*ir
)
844 ir_expression_operation(ir_unop_ssbo_unsized_array_length
)) {
845 /* Don't replace this unop if it is found alone. It is going to be
846 * removed by the optimization passes or replaced if it is part of
847 * an ir_assignment or another ir_expression.
852 for (unsigned i
= 0; i
< ir
->get_num_operands(); i
++) {
853 if (ir
->operands
[i
]->ir_type
!= ir_type_expression
)
855 ir_expression
*expr
= (ir_expression
*) ir
->operands
[i
];
856 ir_expression
*temp
= calculate_ssbo_unsized_array_length(expr
);
861 ir
->operands
[i
] = temp
;
866 lower_ubo_reference_visitor::check_ssbo_unsized_array_length_assignment(ir_assignment
*ir
)
868 if (!ir
->rhs
|| ir
->rhs
->ir_type
!= ir_type_expression
)
871 ir_expression
*expr
= (ir_expression
*) ir
->rhs
;
872 ir_expression
*temp
= calculate_ssbo_unsized_array_length(expr
);
882 lower_ubo_reference_visitor::emit_ssbo_get_buffer_size()
884 ir_rvalue
*block_ref
= this->uniform_block
->clone(mem_ctx
, NULL
);
885 return new(mem_ctx
) ir_expression(ir_unop_get_buffer_size
,
891 lower_ubo_reference_visitor::calculate_unsized_array_stride(ir_dereference
*deref
,
894 unsigned array_stride
= 0;
896 switch (deref
->ir_type
) {
897 case ir_type_dereference_variable
:
899 ir_dereference_variable
*deref_var
= (ir_dereference_variable
*)deref
;
900 const struct glsl_type
*unsized_array_type
= NULL
;
901 /* An unsized array can be sized by other lowering passes, so pick
902 * the first field of the array which has the data type of the unsized
905 unsized_array_type
= deref_var
->var
->type
->fields
.array
;
907 /* Whether or not the field is row-major (because it might be a
908 * bvec2 or something) does not affect the array itself. We need
909 * to know whether an array element in its entirety is row-major.
911 const bool array_row_major
=
912 is_dereferenced_thing_row_major(deref_var
);
914 if (packing
== GLSL_INTERFACE_PACKING_STD430
) {
915 array_stride
= unsized_array_type
->std430_array_stride(array_row_major
);
917 array_stride
= unsized_array_type
->std140_size(array_row_major
);
918 array_stride
= glsl_align(array_stride
, 16);
922 case ir_type_dereference_record
:
924 ir_dereference_record
*deref_record
= (ir_dereference_record
*) deref
;
925 const struct glsl_type
*deref_record_type
=
926 deref_record
->record
->as_dereference()->type
;
927 unsigned record_length
= deref_record_type
->length
;
928 /* Unsized array is always the last element of the interface */
929 const struct glsl_type
*unsized_array_type
=
930 deref_record_type
->fields
.structure
[record_length
- 1].type
->fields
.array
;
932 const bool array_row_major
=
933 is_dereferenced_thing_row_major(deref_record
);
935 if (packing
== GLSL_INTERFACE_PACKING_STD430
) {
936 array_stride
= unsized_array_type
->std430_array_stride(array_row_major
);
938 array_stride
= unsized_array_type
->std140_size(array_row_major
);
939 array_stride
= glsl_align(array_stride
, 16);
944 unreachable("Unsupported dereference type");
950 lower_ubo_reference_visitor::process_ssbo_unsized_array_length(ir_rvalue
**rvalue
,
951 ir_dereference
*deref
,
954 mem_ctx
= ralloc_parent(*rvalue
);
956 ir_rvalue
*base_offset
= NULL
;
957 unsigned const_offset
;
960 unsigned packing
= var
->get_interface_type()->interface_packing
;
961 int unsized_array_stride
= calculate_unsized_array_stride(deref
, packing
);
963 /* Compute the offset to the start if the dereference as well as other
964 * information we need to calculate the length.
966 setup_for_load_or_store(var
, deref
,
967 &base_offset
, &const_offset
,
968 &row_major
, &matrix_columns
,
971 * max((buffer_object_size - offset_of_array) / stride_of_array, 0)
973 ir_expression
*buffer_size
= emit_ssbo_get_buffer_size();
975 ir_expression
*offset_of_array
= new(mem_ctx
)
976 ir_expression(ir_binop_add
, base_offset
,
977 new(mem_ctx
) ir_constant(const_offset
));
978 ir_expression
*offset_of_array_int
= new(mem_ctx
)
979 ir_expression(ir_unop_u2i
, offset_of_array
);
981 ir_expression
*sub
= new(mem_ctx
)
982 ir_expression(ir_binop_sub
, buffer_size
, offset_of_array_int
);
983 ir_expression
*div
= new(mem_ctx
)
984 ir_expression(ir_binop_div
, sub
,
985 new(mem_ctx
) ir_constant(unsized_array_stride
));
986 ir_expression
*max
= new(mem_ctx
)
987 ir_expression(ir_binop_max
, div
, new(mem_ctx
) ir_constant(0));
993 lower_ubo_reference_visitor::check_for_ssbo_store(ir_assignment
*ir
)
998 ir_rvalue
*rvalue
= ir
->lhs
->as_rvalue();
1002 ir_dereference
*deref
= ir
->lhs
->as_dereference();
1006 ir_variable
*var
= ir
->lhs
->variable_referenced();
1007 if (!var
|| !var
->is_in_buffer_block())
1010 /* We have a write to a buffer variable, so declare a temporary and rewrite
1011 * the assignment so that the temporary is the LHS.
1013 mem_ctx
= ralloc_parent(shader
->ir
);
1015 const glsl_type
*type
= rvalue
->type
;
1016 ir_variable
*write_var
= new(mem_ctx
) ir_variable(type
,
1019 base_ir
->insert_before(write_var
);
1020 ir
->lhs
= new(mem_ctx
) ir_dereference_variable(write_var
);
1022 /* Now we have to write the value assigned to the temporary back to memory */
1023 write_to_memory(deref
, var
, write_var
, ir
->write_mask
);
1029 lower_ubo_reference_visitor::visit_enter(ir_assignment
*ir
)
1031 check_ssbo_unsized_array_length_assignment(ir
);
1032 check_for_ssbo_store(ir
);
1033 return rvalue_visit(ir
);
1036 /* Lowers the intrinsic call to a new internal intrinsic that swaps the
1037 * access to the buffer variable in the first parameter by an offset
1038 * and block index. This involves creating the new internal intrinsic
1039 * (i.e. the new function signature).
1042 lower_ubo_reference_visitor::lower_ssbo_atomic_intrinsic(ir_call
*ir
)
1044 /* SSBO atomics usually have 2 parameters, the buffer variable and an
1045 * integer argument. The exception is CompSwap, that has an additional
1046 * integer parameter.
1048 int param_count
= ir
->actual_parameters
.length();
1049 assert(param_count
== 2 || param_count
== 3);
1051 /* First argument must be a scalar integer buffer variable */
1052 exec_node
*param
= ir
->actual_parameters
.get_head();
1053 ir_instruction
*inst
= (ir_instruction
*) param
;
1054 assert(inst
->ir_type
== ir_type_dereference_variable
||
1055 inst
->ir_type
== ir_type_dereference_array
||
1056 inst
->ir_type
== ir_type_dereference_record
||
1057 inst
->ir_type
== ir_type_swizzle
);
1059 ir_rvalue
*deref
= (ir_rvalue
*) inst
;
1060 assert(deref
->type
->is_scalar() && deref
->type
->is_integer());
1062 ir_variable
*var
= deref
->variable_referenced();
1065 /* Compute the offset to the start if the dereference and the
1068 mem_ctx
= ralloc_parent(shader
->ir
);
1070 ir_rvalue
*offset
= NULL
;
1071 unsigned const_offset
;
1074 unsigned packing
= var
->get_interface_type()->interface_packing
;
1076 setup_for_load_or_store(var
, deref
,
1077 &offset
, &const_offset
,
1078 &row_major
, &matrix_columns
,
1082 assert(matrix_columns
== 1);
1084 ir_rvalue
*deref_offset
=
1085 add(offset
, new(mem_ctx
) ir_constant(const_offset
));
1086 ir_rvalue
*block_index
= this->uniform_block
->clone(mem_ctx
, NULL
);
1088 /* Create the new internal function signature that will take a block
1089 * index and offset instead of a buffer variable
1091 exec_list sig_params
;
1092 ir_variable
*sig_param
= new(mem_ctx
)
1093 ir_variable(glsl_type::uint_type
, "block_ref" , ir_var_function_in
);
1094 sig_params
.push_tail(sig_param
);
1096 sig_param
= new(mem_ctx
)
1097 ir_variable(glsl_type::uint_type
, "offset" , ir_var_function_in
);
1098 sig_params
.push_tail(sig_param
);
1100 const glsl_type
*type
= deref
->type
->base_type
== GLSL_TYPE_INT
?
1101 glsl_type::int_type
: glsl_type::uint_type
;
1102 param
= param
->get_next();
1103 sig_param
= new(mem_ctx
)
1104 ir_variable(type
, "data1", ir_var_function_in
);
1105 sig_params
.push_tail(sig_param
);
1107 if (param_count
== 3) {
1108 param
= param
->get_next();
1109 sig_param
= new(mem_ctx
)
1110 ir_variable(type
, "data2", ir_var_function_in
);
1111 sig_params
.push_tail(sig_param
);
1114 ir_function_signature
*sig
=
1115 new(mem_ctx
) ir_function_signature(deref
->type
,
1116 shader_storage_buffer_object
);
1118 sig
->replace_parameters(&sig_params
);
1119 sig
->is_intrinsic
= true;
1122 sprintf(func_name
, "%s_internal", ir
->callee_name());
1123 ir_function
*f
= new(mem_ctx
) ir_function(func_name
);
1124 f
->add_signature(sig
);
1126 /* Now, create the call to the internal intrinsic */
1127 exec_list call_params
;
1128 call_params
.push_tail(block_index
);
1129 call_params
.push_tail(deref_offset
);
1130 param
= ir
->actual_parameters
.get_head()->get_next();
1131 ir_rvalue
*param_as_rvalue
= ((ir_instruction
*) param
)->as_rvalue();
1132 call_params
.push_tail(param_as_rvalue
->clone(mem_ctx
, NULL
));
1133 if (param_count
== 3) {
1134 param
= param
->get_next();
1135 param_as_rvalue
= ((ir_instruction
*) param
)->as_rvalue();
1136 call_params
.push_tail(param_as_rvalue
->clone(mem_ctx
, NULL
));
1138 ir_dereference_variable
*return_deref
=
1139 ir
->return_deref
->clone(mem_ctx
, NULL
);
1140 return new(mem_ctx
) ir_call(sig
, return_deref
, &call_params
);
1144 lower_ubo_reference_visitor::check_for_ssbo_atomic_intrinsic(ir_call
*ir
)
1146 const char *callee
= ir
->callee_name();
1147 if (!strcmp("__intrinsic_ssbo_atomic_add", callee
) ||
1148 !strcmp("__intrinsic_ssbo_atomic_min", callee
) ||
1149 !strcmp("__intrinsic_ssbo_atomic_max", callee
) ||
1150 !strcmp("__intrinsic_ssbo_atomic_and", callee
) ||
1151 !strcmp("__intrinsic_ssbo_atomic_or", callee
) ||
1152 !strcmp("__intrinsic_ssbo_atomic_xor", callee
) ||
1153 !strcmp("__intrinsic_ssbo_atomic_exchange", callee
) ||
1154 !strcmp("__intrinsic_ssbo_atomic_comp_swap", callee
)) {
1155 return lower_ssbo_atomic_intrinsic(ir
);
1163 lower_ubo_reference_visitor::visit_enter(ir_call
*ir
)
1165 ir_call
*new_ir
= check_for_ssbo_atomic_intrinsic(ir
);
1168 base_ir
->replace_with(new_ir
);
1169 return visit_continue_with_parent
;
1172 return rvalue_visit(ir
);
1176 } /* unnamed namespace */
1179 lower_ubo_reference(struct gl_shader
*shader
, exec_list
*instructions
)
1181 lower_ubo_reference_visitor
v(shader
);
1183 /* Loop over the instructions lowering references, because we take
1184 * a deref of a UBO array using a UBO dereference as the index will
1185 * produce a collection of instructions all of which have cloned
1186 * UBO dereferences for that array index.
1190 visit_list_elements(&v
, instructions
);
1191 } while (v
.progress
);