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
),
40 is_array_instance(false), prog(prog
)
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 *,
65 const enum glsl_interface_packing packing
)
67 assert(type
->is_record());
68 if (packing
== GLSL_INTERFACE_PACKING_STD430
)
69 this->offset
= glsl_align(
70 this->offset
, type
->std430_base_alignment(row_major
));
72 this->offset
= glsl_align(
73 this->offset
, type
->std140_base_alignment(row_major
));
76 virtual void leave_record(const glsl_type
*type
, const char *,
78 const enum glsl_interface_packing packing
)
80 assert(type
->is_record());
82 /* If this is the last field of a structure, apply rule #9. The
83 * ARB_uniform_buffer_object spec says:
85 * The structure may have padding at the end; the base offset of the
86 * member following the sub-structure is rounded up to the next
87 * multiple of the base alignment of the structure.
89 if (packing
== GLSL_INTERFACE_PACKING_STD430
)
90 this->offset
= glsl_align(
91 this->offset
, type
->std430_base_alignment(row_major
));
93 this->offset
= glsl_align(
94 this->offset
, type
->std140_base_alignment(row_major
));
97 virtual void set_buffer_offset(unsigned offset
)
99 this->offset
= offset
;
102 virtual void visit_field(const glsl_type
*type
, const char *name
,
103 bool row_major
, const glsl_type
*,
104 const enum glsl_interface_packing packing
,
107 assert(this->index
< this->num_variables
);
109 gl_uniform_buffer_variable
*v
= &this->variables
[this->index
++];
111 v
->Name
= ralloc_strdup(mem_ctx
, name
);
113 v
->RowMajor
= type
->without_array()->is_matrix() && row_major
;
115 if (this->is_array_instance
) {
116 v
->IndexName
= ralloc_strdup(mem_ctx
, name
);
118 char *open_bracket
= strchr(v
->IndexName
, '[');
119 assert(open_bracket
!= NULL
);
121 char *close_bracket
= strchr(open_bracket
, '.') - 1;
122 assert(close_bracket
!= NULL
);
124 /* Length of the tail without the ']' but with the NUL.
126 unsigned len
= strlen(close_bracket
+ 1) + 1;
128 memmove(open_bracket
, close_bracket
+ 1, len
);
130 v
->IndexName
= v
->Name
;
133 unsigned alignment
= 0;
136 /* The ARB_program_interface_query spec says:
138 * If the final member of an active shader storage block is array
139 * with no declared size, the minimum buffer size is computed
140 * assuming the array was declared as an array with one element.
142 * For that reason, we use the base type of the unsized array to
143 * calculate its size. We don't need to check if the unsized array is
144 * the last member of a shader storage block (that check was already
145 * done by the parser).
147 const glsl_type
*type_for_size
= type
;
148 if (type
->is_unsized_array()) {
150 linker_error(prog
, "unsized array `%s' definition: "
151 "only last member of a shader storage block "
152 "can be defined as unsized array",
156 type_for_size
= type
->without_array();
159 if (packing
== GLSL_INTERFACE_PACKING_STD430
) {
160 alignment
= type
->std430_base_alignment(v
->RowMajor
);
161 size
= type_for_size
->std430_size(v
->RowMajor
);
163 alignment
= type
->std140_base_alignment(v
->RowMajor
);
164 size
= type_for_size
->std140_size(v
->RowMajor
);
167 this->offset
= glsl_align(this->offset
, alignment
);
168 v
->Offset
= this->offset
;
170 this->offset
+= size
;
172 /* The ARB_uniform_buffer_object spec says:
174 * For uniform blocks laid out according to [std140] rules, the
175 * minimum buffer object size returned by the UNIFORM_BLOCK_DATA_SIZE
176 * query is derived by taking the offset of the last basic machine
177 * unit consumed by the last uniform of the uniform block (including
178 * any end-of-array or end-of-structure padding), adding one, and
179 * rounding up to the next multiple of the base alignment required
182 this->buffer_size
= glsl_align(this->offset
, 16);
186 class count_block_size
: public program_resource_visitor
{
188 count_block_size() : num_active_uniforms(0)
193 unsigned num_active_uniforms
;
196 virtual void visit_field(const glsl_type
* /* type */,
197 const char * /* name */,
198 bool /* row_major */,
199 const glsl_type
* /* record_type */,
200 const enum glsl_interface_packing
,
201 bool /* last_field */)
203 this->num_active_uniforms
++;
207 } /* anonymous namespace */
210 const glsl_type
*type
;
211 bool has_instance_name
;
214 static void process_block_array_leaf(const char *name
, gl_uniform_block
*blocks
,
216 gl_uniform_buffer_variable
*variables
,
217 const struct link_uniform_block_active
*const b
,
218 unsigned *block_index
,
219 unsigned *binding_offset
,
220 unsigned linearized_index
,
221 struct gl_context
*ctx
,
222 struct gl_shader_program
*prog
);
226 * \param first_index Value of \c block_index for the first element of the
230 process_block_array(struct uniform_block_array_elements
*ub_array
, char **name
,
231 size_t name_length
, gl_uniform_block
*blocks
,
232 ubo_visitor
*parcel
, gl_uniform_buffer_variable
*variables
,
233 const struct link_uniform_block_active
*const b
,
234 unsigned *block_index
, unsigned *binding_offset
,
235 struct gl_context
*ctx
, struct gl_shader_program
*prog
,
236 unsigned first_index
)
238 for (unsigned j
= 0; j
< ub_array
->num_array_elements
; j
++) {
239 size_t new_length
= name_length
;
241 /* Append the subscript to the current variable name */
242 ralloc_asprintf_rewrite_tail(name
, &new_length
, "[%u]",
243 ub_array
->array_elements
[j
]);
245 if (ub_array
->array
) {
246 process_block_array(ub_array
->array
, name
, new_length
, blocks
,
247 parcel
, variables
, b
, block_index
,
248 binding_offset
, ctx
, prog
, first_index
);
250 process_block_array_leaf(*name
, blocks
,
251 parcel
, variables
, b
, block_index
,
252 binding_offset
, *block_index
- first_index
,
259 process_block_array_leaf(const char *name
,
260 gl_uniform_block
*blocks
,
261 ubo_visitor
*parcel
, gl_uniform_buffer_variable
*variables
,
262 const struct link_uniform_block_active
*const b
,
263 unsigned *block_index
, unsigned *binding_offset
,
264 unsigned linearized_index
,
265 struct gl_context
*ctx
, struct gl_shader_program
*prog
)
267 unsigned i
= *block_index
;
268 const glsl_type
*type
= b
->type
->without_array();
270 blocks
[i
].Name
= ralloc_strdup(blocks
, name
);
271 blocks
[i
].Uniforms
= &variables
[(*parcel
).index
];
273 /* The ARB_shading_language_420pack spec says:
275 * If the binding identifier is used with a uniform block instanced as
276 * an array then the first element of the array takes the specified
277 * block binding and each subsequent element takes the next consecutive
278 * uniform block binding point.
280 blocks
[i
].Binding
= (b
->has_binding
) ? b
->binding
+ *binding_offset
: 0;
282 blocks
[i
].UniformBufferSize
= 0;
283 blocks
[i
]._Packing
= glsl_interface_packing(type
->interface_packing
);
284 blocks
[i
]._RowMajor
= type
->get_interface_row_major();
285 blocks
[i
].linearized_array_index
= linearized_index
;
287 parcel
->process(type
, b
->has_instance_name
? blocks
[i
].Name
: "");
289 blocks
[i
].UniformBufferSize
= parcel
->buffer_size
;
291 /* Check SSBO size is lower than maximum supported size for SSBO */
292 if (b
->is_shader_storage
&&
293 parcel
->buffer_size
> ctx
->Const
.MaxShaderStorageBlockSize
) {
294 linker_error(prog
, "shader storage block `%s' has size %d, "
295 "which is larger than than the maximum allowed (%d)",
298 ctx
->Const
.MaxShaderStorageBlockSize
);
300 blocks
[i
].NumUniforms
=
301 (unsigned)(ptrdiff_t)(&variables
[parcel
->index
] - blocks
[i
].Uniforms
);
303 *block_index
= *block_index
+ 1;
304 *binding_offset
= *binding_offset
+ 1;
307 /* This function resizes the array types of the block so that later we can use
308 * this new size to correctly calculate the offest for indirect indexing.
310 static const glsl_type
*
311 resize_block_array(const glsl_type
*type
,
312 struct uniform_block_array_elements
*ub_array
)
314 if (type
->is_array()) {
315 struct uniform_block_array_elements
*child_array
=
316 type
->fields
.array
->is_array() ? ub_array
->array
: NULL
;
317 const glsl_type
*new_child_type
=
318 resize_block_array(type
->fields
.array
, child_array
);
320 const glsl_type
*new_type
=
321 glsl_type::get_array_instance(new_child_type
,
322 ub_array
->num_array_elements
);
323 ub_array
->ir
->array
->type
= new_type
;
331 create_buffer_blocks(void *mem_ctx
, struct gl_context
*ctx
,
332 struct gl_shader_program
*prog
,
333 struct gl_uniform_block
**out_blks
, unsigned num_blocks
,
334 struct hash_table
*block_hash
, unsigned num_variables
,
335 bool create_ubo_blocks
)
337 if (num_blocks
== 0) {
338 assert(num_variables
== 0);
342 assert(num_variables
!= 0);
344 /* Allocate storage to hold all of the information related to uniform
345 * blocks that can be queried through the API.
347 struct gl_uniform_block
*blocks
=
348 rzalloc_array(mem_ctx
, gl_uniform_block
, num_blocks
);
349 gl_uniform_buffer_variable
*variables
=
350 ralloc_array(blocks
, gl_uniform_buffer_variable
, num_variables
);
352 /* Add each variable from each uniform block to the API tracking
355 ubo_visitor
parcel(blocks
, variables
, num_variables
, prog
);
358 struct hash_entry
*entry
;
359 hash_table_foreach (block_hash
, entry
) {
360 const struct link_uniform_block_active
*const b
=
361 (const struct link_uniform_block_active
*) entry
->data
;
362 const glsl_type
*block_type
= b
->type
;
364 if ((create_ubo_blocks
&& !b
->is_shader_storage
) ||
365 (!create_ubo_blocks
&& b
->is_shader_storage
)) {
367 unsigned binding_offset
= 0;
368 if (b
->array
!= NULL
) {
369 char *name
= ralloc_strdup(NULL
,
370 block_type
->without_array()->name
);
371 size_t name_length
= strlen(name
);
373 assert(b
->has_instance_name
);
374 process_block_array(b
->array
, &name
, name_length
, blocks
, &parcel
,
375 variables
, b
, &i
, &binding_offset
, ctx
, prog
,
379 process_block_array_leaf(block_type
->name
, blocks
, &parcel
,
380 variables
, b
, &i
, &binding_offset
,
388 assert(parcel
.index
== num_variables
);
392 link_uniform_blocks(void *mem_ctx
,
393 struct gl_context
*ctx
,
394 struct gl_shader_program
*prog
,
395 struct gl_linked_shader
*shader
,
396 struct gl_uniform_block
**ubo_blocks
,
397 unsigned *num_ubo_blocks
,
398 struct gl_uniform_block
**ssbo_blocks
,
399 unsigned *num_ssbo_blocks
)
401 /* This hash table will track all of the uniform blocks that have been
402 * encountered. Since blocks with the same block-name must be the same,
403 * the hash is organized by block-name.
405 struct hash_table
*block_hash
=
406 _mesa_hash_table_create(mem_ctx
, _mesa_key_hash_string
,
407 _mesa_key_string_equal
);
409 if (block_hash
== NULL
) {
410 _mesa_error_no_memory(__func__
);
411 linker_error(prog
, "out of memory\n");
415 /* Determine which uniform blocks are active. */
416 link_uniform_block_active_visitor
v(mem_ctx
, block_hash
, prog
);
417 visit_list_elements(&v
, shader
->ir
);
419 /* Count the number of active uniform blocks. Count the total number of
420 * active slots in those uniform blocks.
422 unsigned num_ubo_variables
= 0;
423 unsigned num_ssbo_variables
= 0;
424 count_block_size block_size
;
425 struct hash_entry
*entry
;
427 hash_table_foreach (block_hash
, entry
) {
428 struct link_uniform_block_active
*const b
=
429 (struct link_uniform_block_active
*) entry
->data
;
431 assert((b
->array
!= NULL
) == b
->type
->is_array());
433 if (b
->array
!= NULL
&&
434 (b
->type
->without_array()->interface_packing
==
435 GLSL_INTERFACE_PACKING_PACKED
)) {
436 b
->type
= resize_block_array(b
->type
, b
->array
);
437 b
->var
->type
= b
->type
;
440 block_size
.num_active_uniforms
= 0;
441 block_size
.process(b
->type
->without_array(), "");
443 if (b
->array
!= NULL
) {
444 unsigned aoa_size
= b
->type
->arrays_of_arrays_size();
445 if (b
->is_shader_storage
) {
446 *num_ssbo_blocks
+= aoa_size
;
447 num_ssbo_variables
+= aoa_size
* block_size
.num_active_uniforms
;
449 *num_ubo_blocks
+= aoa_size
;
450 num_ubo_variables
+= aoa_size
* block_size
.num_active_uniforms
;
453 if (b
->is_shader_storage
) {
454 (*num_ssbo_blocks
)++;
455 num_ssbo_variables
+= block_size
.num_active_uniforms
;
458 num_ubo_variables
+= block_size
.num_active_uniforms
;
464 create_buffer_blocks(mem_ctx
, ctx
, prog
, ubo_blocks
, *num_ubo_blocks
,
465 block_hash
, num_ubo_variables
, true);
466 create_buffer_blocks(mem_ctx
, ctx
, prog
, ssbo_blocks
, *num_ssbo_blocks
,
467 block_hash
, num_ssbo_variables
, false);
469 _mesa_hash_table_destroy(block_hash
, NULL
);
473 link_uniform_blocks_are_compatible(const gl_uniform_block
*a
,
474 const gl_uniform_block
*b
)
476 assert(strcmp(a
->Name
, b
->Name
) == 0);
478 /* Page 35 (page 42 of the PDF) in section 4.3.7 of the GLSL 1.50 spec says:
480 * Matched block names within an interface (as defined above) must match
481 * in terms of having the same number of declarations with the same
482 * sequence of types and the same sequence of member names, as well as
483 * having the same member-wise layout qualification....if a matching
484 * block is declared as an array, then the array sizes must also
485 * match... Any mismatch will generate a link error.
487 * Arrays are not yet supported, so there is no check for that.
489 if (a
->NumUniforms
!= b
->NumUniforms
)
492 if (a
->_Packing
!= b
->_Packing
)
495 if (a
->_RowMajor
!= b
->_RowMajor
)
498 if (a
->Binding
!= b
->Binding
)
501 for (unsigned i
= 0; i
< a
->NumUniforms
; i
++) {
502 if (strcmp(a
->Uniforms
[i
].Name
, b
->Uniforms
[i
].Name
) != 0)
505 if (a
->Uniforms
[i
].Type
!= b
->Uniforms
[i
].Type
)
508 if (a
->Uniforms
[i
].RowMajor
!= b
->Uniforms
[i
].RowMajor
)
516 * Merges a uniform block into an array of uniform blocks that may or
517 * may not already contain a copy of it.
519 * Returns the index of the new block in the array.
522 link_cross_validate_uniform_block(void *mem_ctx
,
523 struct gl_uniform_block
**linked_blocks
,
524 unsigned int *num_linked_blocks
,
525 struct gl_uniform_block
*new_block
)
527 for (unsigned int i
= 0; i
< *num_linked_blocks
; i
++) {
528 struct gl_uniform_block
*old_block
= &(*linked_blocks
)[i
];
530 if (strcmp(old_block
->Name
, new_block
->Name
) == 0)
531 return link_uniform_blocks_are_compatible(old_block
, new_block
)
535 *linked_blocks
= reralloc(mem_ctx
, *linked_blocks
,
536 struct gl_uniform_block
,
537 *num_linked_blocks
+ 1);
538 int linked_block_index
= (*num_linked_blocks
)++;
539 struct gl_uniform_block
*linked_block
= &(*linked_blocks
)[linked_block_index
];
541 memcpy(linked_block
, new_block
, sizeof(*new_block
));
542 linked_block
->Uniforms
= ralloc_array(*linked_blocks
,
543 struct gl_uniform_buffer_variable
,
544 linked_block
->NumUniforms
);
546 memcpy(linked_block
->Uniforms
,
548 sizeof(*linked_block
->Uniforms
) * linked_block
->NumUniforms
);
550 linked_block
->Name
= ralloc_strdup(*linked_blocks
, linked_block
->Name
);
552 for (unsigned int i
= 0; i
< linked_block
->NumUniforms
; i
++) {
553 struct gl_uniform_buffer_variable
*ubo_var
=
554 &linked_block
->Uniforms
[i
];
556 if (ubo_var
->Name
== ubo_var
->IndexName
) {
557 ubo_var
->Name
= ralloc_strdup(*linked_blocks
, ubo_var
->Name
);
558 ubo_var
->IndexName
= ubo_var
->Name
;
560 ubo_var
->Name
= ralloc_strdup(*linked_blocks
, ubo_var
->Name
);
561 ubo_var
->IndexName
= ralloc_strdup(*linked_blocks
, ubo_var
->IndexName
);
565 return linked_block_index
;