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.
24 #include "main/core.h"
27 #include "ir_uniform.h"
28 #include "link_uniform_block_active_visitor.h"
29 #include "util/hash_table.h"
34 class ubo_visitor
: public program_resource_visitor
{
36 ubo_visitor(void *mem_ctx
, gl_uniform_buffer_variable
*variables
,
37 unsigned num_variables
, struct gl_shader_program
*prog
)
38 : index(0), offset(0), buffer_size(0), variables(variables
),
39 num_variables(num_variables
), mem_ctx(mem_ctx
), is_array_instance(false),
45 void process(const glsl_type
*type
, const char *name
)
48 this->buffer_size
= 0;
49 this->is_array_instance
= strchr(name
, ']') != NULL
;
50 this->program_resource_visitor::process(type
, name
);
56 gl_uniform_buffer_variable
*variables
;
57 unsigned num_variables
;
59 bool is_array_instance
;
60 struct gl_shader_program
*prog
;
63 virtual void enter_record(const glsl_type
*type
, const char *,
64 bool row_major
, const enum glsl_interface_packing packing
) {
65 assert(type
->is_record());
66 if (packing
== GLSL_INTERFACE_PACKING_STD430
)
67 this->offset
= glsl_align(
68 this->offset
, type
->std430_base_alignment(row_major
));
70 this->offset
= glsl_align(
71 this->offset
, type
->std140_base_alignment(row_major
));
74 virtual void leave_record(const glsl_type
*type
, const char *,
75 bool row_major
, const enum glsl_interface_packing packing
) {
76 assert(type
->is_record());
78 /* If this is the last field of a structure, apply rule #9. The
79 * GL_ARB_uniform_buffer_object spec says:
81 * "The structure may have padding at the end; the base offset of
82 * the member following the sub-structure is rounded up to the next
83 * multiple of the base alignment of the structure."
85 if (packing
== GLSL_INTERFACE_PACKING_STD430
)
86 this->offset
= glsl_align(
87 this->offset
, type
->std430_base_alignment(row_major
));
89 this->offset
= glsl_align(
90 this->offset
, type
->std140_base_alignment(row_major
));
93 virtual void set_buffer_offset(unsigned offset
)
95 this->offset
= offset
;
98 virtual void visit_field(const glsl_type
*type
, const char *name
,
99 bool row_major
, const glsl_type
*,
100 const enum glsl_interface_packing packing
,
103 assert(this->index
< this->num_variables
);
105 gl_uniform_buffer_variable
*v
= &this->variables
[this->index
++];
107 v
->Name
= ralloc_strdup(mem_ctx
, name
);
109 v
->RowMajor
= type
->without_array()->is_matrix() && row_major
;
111 if (this->is_array_instance
) {
112 v
->IndexName
= ralloc_strdup(mem_ctx
, name
);
114 char *open_bracket
= strchr(v
->IndexName
, '[');
115 assert(open_bracket
!= NULL
);
117 char *close_bracket
= strchr(open_bracket
, '.') - 1;
118 assert(close_bracket
!= NULL
);
120 /* Length of the tail without the ']' but with the NUL.
122 unsigned len
= strlen(close_bracket
+ 1) + 1;
124 memmove(open_bracket
, close_bracket
+ 1, len
);
126 v
->IndexName
= v
->Name
;
129 unsigned alignment
= 0;
132 /* From ARB_program_interface_query:
134 * "If the final member of an active shader storage block is array
135 * with no declared size, the minimum buffer size is computed
136 * assuming the array was declared as an array with one element."
138 * For that reason, we use the base type of the unsized array to calculate
139 * its size. We don't need to check if the unsized array is the last member
140 * of a shader storage block (that check was already done by the parser).
142 const glsl_type
*type_for_size
= type
;
143 if (type
->is_unsized_array()) {
145 type_for_size
= type
->without_array();
148 if (packing
== GLSL_INTERFACE_PACKING_STD430
) {
149 alignment
= type
->std430_base_alignment(v
->RowMajor
);
150 size
= type_for_size
->std430_size(v
->RowMajor
);
152 alignment
= type
->std140_base_alignment(v
->RowMajor
);
153 size
= type_for_size
->std140_size(v
->RowMajor
);
156 this->offset
= glsl_align(this->offset
, alignment
);
157 v
->Offset
= this->offset
;
159 this->offset
+= size
;
161 /* From the GL_ARB_uniform_buffer_object spec:
163 * "For uniform blocks laid out according to [std140] rules, the
164 * minimum buffer object size returned by the
165 * UNIFORM_BLOCK_DATA_SIZE query is derived by taking the offset of
166 * the last basic machine unit consumed by the last uniform of the
167 * uniform block (including any end-of-array or end-of-structure
168 * padding), adding one, and rounding up to the next multiple of
169 * the base alignment required for a vec4."
171 this->buffer_size
= glsl_align(this->offset
, 16);
175 class count_block_size
: public program_resource_visitor
{
177 count_block_size() : num_active_uniforms(0)
182 unsigned num_active_uniforms
;
185 virtual void visit_field(const glsl_type
* /* type */,
186 const char * /* name */,
187 bool /* row_major */,
188 const glsl_type
* /* record_type */,
189 const enum glsl_interface_packing
,
190 bool /* last_field */)
192 this->num_active_uniforms
++;
196 } /* anonymous namespace */
199 const glsl_type
*type
;
200 bool has_instance_name
;
204 process_block_array(struct uniform_block_array_elements
*ub_array
, char **name
,
205 size_t name_length
, gl_uniform_block
*blocks
,
206 ubo_visitor
*parcel
, gl_uniform_buffer_variable
*variables
,
207 const struct link_uniform_block_active
*const b
,
208 unsigned *block_index
, unsigned *binding_offset
,
209 struct gl_context
*ctx
, struct gl_shader_program
*prog
)
212 for (unsigned j
= 0; j
< ub_array
->num_array_elements
; j
++) {
213 size_t new_length
= name_length
;
215 /* Append the subscript to the current variable name */
216 ralloc_asprintf_rewrite_tail(name
, &new_length
, "[%u]",
217 ub_array
->array_elements
[j
]);
219 process_block_array(ub_array
->array
, name
, new_length
, blocks
,
220 parcel
, variables
, b
, block_index
,
221 binding_offset
, ctx
, prog
);
224 unsigned i
= *block_index
;
225 const glsl_type
*type
= b
->type
->without_array();
227 blocks
[i
].Name
= ralloc_strdup(blocks
, *name
);
228 blocks
[i
].Uniforms
= &variables
[(*parcel
).index
];
230 /* The GL_ARB_shading_language_420pack spec says:
232 * "If the binding identifier is used with a uniform block
233 * instanced as an array then the first element of the array
234 * takes the specified block binding and each subsequent
235 * element takes the next consecutive uniform block binding
238 blocks
[i
].Binding
= (b
->has_binding
) ? b
->binding
+ *binding_offset
: 0;
240 blocks
[i
].UniformBufferSize
= 0;
241 blocks
[i
]._Packing
= gl_uniform_block_packing(type
->interface_packing
);
242 blocks
[i
]._RowMajor
= type
->get_interface_row_major();
244 parcel
->process(type
, blocks
[i
].Name
);
246 blocks
[i
].UniformBufferSize
= parcel
->buffer_size
;
248 /* Check SSBO size is lower than maximum supported size for SSBO */
249 if (b
->is_shader_storage
&&
250 parcel
->buffer_size
> ctx
->Const
.MaxShaderStorageBlockSize
) {
251 linker_error(prog
, "shader storage block `%s' has size %d, "
252 "which is larger than than the maximum allowed (%d)",
255 ctx
->Const
.MaxShaderStorageBlockSize
);
257 blocks
[i
].NumUniforms
=
258 (unsigned)(ptrdiff_t)(&variables
[parcel
->index
] - blocks
[i
].Uniforms
);
260 *block_index
= *block_index
+ 1;
261 *binding_offset
= *binding_offset
+ 1;
265 /* This function resizes the array types of the block so that later we can use
266 * this new size to correctly calculate the offest for indirect indexing.
268 static const glsl_type
*
269 resize_block_array(const glsl_type
*type
,
270 struct uniform_block_array_elements
*ub_array
)
272 if (type
->is_array()) {
273 struct uniform_block_array_elements
*child_array
=
274 type
->fields
.array
->is_array() ? ub_array
->array
: NULL
;
275 const glsl_type
*new_child_type
=
276 resize_block_array(type
->fields
.array
, child_array
);
278 const glsl_type
*new_type
=
279 glsl_type::get_array_instance(new_child_type
,
280 ub_array
->num_array_elements
);
281 ub_array
->ir
->array
->type
= new_type
;
289 create_buffer_blocks(void *mem_ctx
, struct gl_context
*ctx
,
290 struct gl_shader_program
*prog
,
291 struct gl_uniform_block
**out_blks
, unsigned num_blocks
,
292 struct hash_table
*block_hash
, unsigned num_variables
,
293 bool create_ubo_blocks
)
295 if (num_blocks
== 0) {
296 assert(num_variables
== 0);
300 assert(num_variables
!= 0);
302 /* Allocate storage to hold all of the information related to uniform
303 * blocks that can be queried through the API.
305 struct gl_uniform_block
*blocks
= rzalloc_array(mem_ctx
, gl_uniform_block
, num_blocks
);
306 gl_uniform_buffer_variable
*variables
=
307 ralloc_array(blocks
, gl_uniform_buffer_variable
, num_variables
);
309 /* Add each variable from each uniform block to the API tracking
312 ubo_visitor
parcel(blocks
, variables
, num_variables
, prog
);
314 STATIC_ASSERT(unsigned(GLSL_INTERFACE_PACKING_STD140
)
315 == unsigned(ubo_packing_std140
));
316 STATIC_ASSERT(unsigned(GLSL_INTERFACE_PACKING_SHARED
)
317 == unsigned(ubo_packing_shared
));
318 STATIC_ASSERT(unsigned(GLSL_INTERFACE_PACKING_PACKED
)
319 == unsigned(ubo_packing_packed
));
320 STATIC_ASSERT(unsigned(GLSL_INTERFACE_PACKING_STD430
)
321 == unsigned(ubo_packing_std430
));
324 struct hash_entry
*entry
;
325 hash_table_foreach (block_hash
, entry
) {
326 const struct link_uniform_block_active
*const b
=
327 (const struct link_uniform_block_active
*) entry
->data
;
328 const glsl_type
*block_type
= b
->type
;
330 if ((create_ubo_blocks
&& !b
->is_shader_storage
) ||
331 (!create_ubo_blocks
&& b
->is_shader_storage
)) {
333 if (b
->array
!= NULL
) {
334 unsigned binding_offset
= 0;
335 char *name
= ralloc_strdup(NULL
,
336 block_type
->without_array()->name
);
337 size_t name_length
= strlen(name
);
339 assert(b
->has_instance_name
);
340 process_block_array(b
->array
, &name
, name_length
, blocks
, &parcel
,
341 variables
, b
, &i
, &binding_offset
, ctx
, prog
);
344 blocks
[i
].Name
= ralloc_strdup(blocks
, block_type
->name
);
345 blocks
[i
].Uniforms
= &variables
[parcel
.index
];
346 blocks
[i
].Binding
= (b
->has_binding
) ? b
->binding
: 0;
347 blocks
[i
].UniformBufferSize
= 0;
349 gl_uniform_block_packing(block_type
->interface_packing
);
350 blocks
[i
]._RowMajor
= block_type
->get_interface_row_major();
352 parcel
.process(block_type
,
353 b
->has_instance_name
? block_type
->name
: "");
355 blocks
[i
].UniformBufferSize
= parcel
.buffer_size
;
357 /* Check SSBO size is lower than maximum supported size for SSBO
359 if (b
->is_shader_storage
&&
360 parcel
.buffer_size
> ctx
->Const
.MaxShaderStorageBlockSize
) {
361 linker_error(prog
, "shader storage block `%s' has size %d, "
362 "which is larger than than the maximum allowed (%d)",
363 block_type
->name
, parcel
.buffer_size
,
364 ctx
->Const
.MaxShaderStorageBlockSize
);
366 blocks
[i
].NumUniforms
= (unsigned)(ptrdiff_t)
367 (&variables
[parcel
.index
] - blocks
[i
].Uniforms
);
375 assert(parcel
.index
== num_variables
);
379 link_uniform_blocks(void *mem_ctx
,
380 struct gl_context
*ctx
,
381 struct gl_shader_program
*prog
,
382 struct gl_linked_shader
*shader
,
383 struct gl_uniform_block
**ubo_blocks
,
384 unsigned *num_ubo_blocks
,
385 struct gl_uniform_block
**ssbo_blocks
,
386 unsigned *num_ssbo_blocks
)
388 /* This hash table will track all of the uniform blocks that have been
389 * encountered. Since blocks with the same block-name must be the same,
390 * the hash is organized by block-name.
392 struct hash_table
*block_hash
=
393 _mesa_hash_table_create(mem_ctx
, _mesa_key_hash_string
,
394 _mesa_key_string_equal
);
396 if (block_hash
== NULL
) {
397 _mesa_error_no_memory(__func__
);
398 linker_error(prog
, "out of memory\n");
402 /* Determine which uniform blocks are active.
404 link_uniform_block_active_visitor
v(mem_ctx
, block_hash
, prog
);
405 visit_list_elements(&v
, shader
->ir
);
407 /* Count the number of active uniform blocks. Count the total number of
408 * active slots in those uniform blocks.
410 unsigned num_ubo_variables
= 0;
411 unsigned num_ssbo_variables
= 0;
412 count_block_size block_size
;
413 struct hash_entry
*entry
;
415 hash_table_foreach (block_hash
, entry
) {
416 struct link_uniform_block_active
*const b
=
417 (struct link_uniform_block_active
*) entry
->data
;
419 assert((b
->array
!= NULL
) == b
->type
->is_array());
421 if (b
->array
!= NULL
&&
422 (b
->type
->without_array()->interface_packing
==
423 GLSL_INTERFACE_PACKING_PACKED
)) {
424 b
->type
= resize_block_array(b
->type
, b
->array
);
425 b
->var
->type
= b
->type
;
428 block_size
.num_active_uniforms
= 0;
429 block_size
.process(b
->type
->without_array(), "");
431 if (b
->array
!= NULL
) {
432 unsigned aoa_size
= b
->type
->arrays_of_arrays_size();
433 if (b
->is_shader_storage
) {
434 *num_ssbo_blocks
+= aoa_size
;
435 num_ssbo_variables
+= aoa_size
* block_size
.num_active_uniforms
;
437 *num_ubo_blocks
+= aoa_size
;
438 num_ubo_variables
+= aoa_size
* block_size
.num_active_uniforms
;
441 if (b
->is_shader_storage
) {
442 (*num_ssbo_blocks
)++;
443 num_ssbo_variables
+= block_size
.num_active_uniforms
;
446 num_ubo_variables
+= block_size
.num_active_uniforms
;
452 create_buffer_blocks(mem_ctx
, ctx
, prog
, ubo_blocks
, *num_ubo_blocks
,
453 block_hash
, num_ubo_variables
, true);
454 create_buffer_blocks(mem_ctx
, ctx
, prog
, ssbo_blocks
, *num_ssbo_blocks
,
455 block_hash
, num_ssbo_variables
, false);
457 _mesa_hash_table_destroy(block_hash
, NULL
);
461 link_uniform_blocks_are_compatible(const gl_uniform_block
*a
,
462 const gl_uniform_block
*b
)
464 assert(strcmp(a
->Name
, b
->Name
) == 0);
466 /* Page 35 (page 42 of the PDF) in section 4.3.7 of the GLSL 1.50 spec says:
468 * "Matched block names within an interface (as defined above) must
469 * match in terms of having the same number of declarations with the
470 * same sequence of types and the same sequence of member names, as
471 * well as having the same member-wise layout qualification....if a
472 * matching block is declared as an array, then the array sizes must
473 * also match... Any mismatch will generate a link error."
475 * Arrays are not yet supported, so there is no check for that.
477 if (a
->NumUniforms
!= b
->NumUniforms
)
480 if (a
->_Packing
!= b
->_Packing
)
483 if (a
->_RowMajor
!= b
->_RowMajor
)
486 for (unsigned i
= 0; i
< a
->NumUniforms
; i
++) {
487 if (strcmp(a
->Uniforms
[i
].Name
, b
->Uniforms
[i
].Name
) != 0)
490 if (a
->Uniforms
[i
].Type
!= b
->Uniforms
[i
].Type
)
493 if (a
->Uniforms
[i
].RowMajor
!= b
->Uniforms
[i
].RowMajor
)
501 * Merges a uniform block into an array of uniform blocks that may or
502 * may not already contain a copy of it.
504 * Returns the index of the new block in the array.
507 link_cross_validate_uniform_block(void *mem_ctx
,
508 struct gl_uniform_block
**linked_blocks
,
509 unsigned int *num_linked_blocks
,
510 struct gl_uniform_block
*new_block
)
512 for (unsigned int i
= 0; i
< *num_linked_blocks
; i
++) {
513 struct gl_uniform_block
*old_block
= &(*linked_blocks
)[i
];
515 if (strcmp(old_block
->Name
, new_block
->Name
) == 0)
516 return link_uniform_blocks_are_compatible(old_block
, new_block
)
520 *linked_blocks
= reralloc(mem_ctx
, *linked_blocks
,
521 struct gl_uniform_block
,
522 *num_linked_blocks
+ 1);
523 int linked_block_index
= (*num_linked_blocks
)++;
524 struct gl_uniform_block
*linked_block
= &(*linked_blocks
)[linked_block_index
];
526 memcpy(linked_block
, new_block
, sizeof(*new_block
));
527 linked_block
->Uniforms
= ralloc_array(*linked_blocks
,
528 struct gl_uniform_buffer_variable
,
529 linked_block
->NumUniforms
);
531 memcpy(linked_block
->Uniforms
,
533 sizeof(*linked_block
->Uniforms
) * linked_block
->NumUniforms
);
535 linked_block
->Name
= ralloc_strdup(*linked_blocks
, linked_block
->Name
);
537 for (unsigned int i
= 0; i
< linked_block
->NumUniforms
; i
++) {
538 struct gl_uniform_buffer_variable
*ubo_var
=
539 &linked_block
->Uniforms
[i
];
541 if (ubo_var
->Name
== ubo_var
->IndexName
) {
542 ubo_var
->Name
= ralloc_strdup(*linked_blocks
, ubo_var
->Name
);
543 ubo_var
->IndexName
= ubo_var
->Name
;
545 ubo_var
->Name
= ralloc_strdup(*linked_blocks
, ubo_var
->Name
);
546 ubo_var
->IndexName
= ralloc_strdup(*linked_blocks
, ubo_var
->IndexName
);
550 return linked_block_index
;