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
)
38 : index(0), offset(0), buffer_size(0), variables(variables
),
39 num_variables(num_variables
), mem_ctx(mem_ctx
), is_array_instance(false)
44 void process(const glsl_type
*type
, const char *name
)
47 this->buffer_size
= 0;
48 this->is_array_instance
= strchr(name
, ']') != NULL
;
49 this->program_resource_visitor::process(type
, name
);
55 gl_uniform_buffer_variable
*variables
;
56 unsigned num_variables
;
58 bool is_array_instance
;
61 virtual void visit_field(const glsl_type
*type
, const char *name
,
67 assert(!"Should not get here.");
70 virtual void visit_field(const glsl_type
*type
, const char *name
,
71 bool row_major
, const glsl_type
*record_type
,
74 assert(this->index
< this->num_variables
);
76 gl_uniform_buffer_variable
*v
= &this->variables
[this->index
++];
78 v
->Name
= ralloc_strdup(mem_ctx
, name
);
80 v
->RowMajor
= type
->without_array()->is_matrix() && row_major
;
82 if (this->is_array_instance
) {
83 v
->IndexName
= ralloc_strdup(mem_ctx
, name
);
85 char *open_bracket
= strchr(v
->IndexName
, '[');
86 assert(open_bracket
!= NULL
);
88 char *close_bracket
= strchr(open_bracket
, ']');
89 assert(close_bracket
!= NULL
);
91 /* Length of the tail without the ']' but with the NUL.
93 unsigned len
= strlen(close_bracket
+ 1) + 1;
95 memmove(open_bracket
, close_bracket
+ 1, len
);
97 v
->IndexName
= v
->Name
;
100 const unsigned alignment
= record_type
101 ? record_type
->std140_base_alignment(v
->RowMajor
)
102 : type
->std140_base_alignment(v
->RowMajor
);
103 unsigned size
= type
->std140_size(v
->RowMajor
);
105 this->offset
= glsl_align(this->offset
, alignment
);
106 v
->Offset
= this->offset
;
108 /* If this is the last field of a structure, apply rule #9. The
109 * GL_ARB_uniform_buffer_object spec says:
111 * "The structure may have padding at the end; the base offset of
112 * the member following the sub-structure is rounded up to the next
113 * multiple of the base alignment of the structure."
115 * last_field won't be set if this is the last field of a UBO that is
116 * not a named instance.
118 this->offset
+= size
;
120 this->offset
= glsl_align(this->offset
, 16);
122 /* From the GL_ARB_uniform_buffer_object spec:
124 * "For uniform blocks laid out according to [std140] rules, the
125 * minimum buffer object size returned by the
126 * UNIFORM_BLOCK_DATA_SIZE query is derived by taking the offset of
127 * the last basic machine unit consumed by the last uniform of the
128 * uniform block (including any end-of-array or end-of-structure
129 * padding), adding one, and rounding up to the next multiple of
130 * the base alignment required for a vec4."
132 this->buffer_size
= glsl_align(this->offset
, 16);
135 virtual void visit_field(const glsl_struct_field
*field
)
137 /* FINISHME: When support for doubles (dvec4, etc.) is added to the
138 * FINISHME: compiler, this may be incorrect for a structure in a UBO
139 * FINISHME: like struct s { struct { float f } s1; dvec4 v; };.
141 this->offset
= glsl_align(this->offset
,
142 field
->type
->std140_base_alignment(false));
146 class count_block_size
: public program_resource_visitor
{
148 count_block_size() : num_active_uniforms(0)
153 unsigned num_active_uniforms
;
156 virtual void visit_field(const glsl_type
*type
, const char *name
,
162 this->num_active_uniforms
++;
166 } /* anonymous namespace */
169 const glsl_type
*type
;
170 bool has_instance_name
;
174 link_uniform_blocks(void *mem_ctx
,
175 struct gl_shader_program
*prog
,
176 struct gl_shader
**shader_list
,
177 unsigned num_shaders
,
178 struct gl_uniform_block
**blocks_ret
)
180 /* This hash table will track all of the uniform blocks that have been
181 * encountered. Since blocks with the same block-name must be the same,
182 * the hash is organized by block-name.
184 struct hash_table
*block_hash
=
185 _mesa_hash_table_create(mem_ctx
, _mesa_key_hash_string
,
186 _mesa_key_string_equal
);
188 if (block_hash
== NULL
) {
189 _mesa_error_no_memory(__func__
);
190 linker_error(prog
, "out of memory\n");
194 /* Determine which uniform blocks are active.
196 link_uniform_block_active_visitor
v(mem_ctx
, block_hash
, prog
);
197 for (unsigned i
= 0; i
< num_shaders
; i
++) {
198 visit_list_elements(&v
, shader_list
[i
]->ir
);
201 /* Count the number of active uniform blocks. Count the total number of
202 * active slots in those uniform blocks.
204 unsigned num_blocks
= 0;
205 unsigned num_variables
= 0;
206 count_block_size block_size
;
207 struct hash_entry
*entry
;
209 hash_table_foreach (block_hash
, entry
) {
210 const struct link_uniform_block_active
*const b
=
211 (const struct link_uniform_block_active
*) entry
->data
;
213 const glsl_type
*const block_type
=
214 b
->type
->is_array() ? b
->type
->fields
.array
: b
->type
;
216 assert((b
->num_array_elements
> 0) == b
->type
->is_array());
218 block_size
.num_active_uniforms
= 0;
219 block_size
.process(block_type
, "");
221 if (b
->num_array_elements
> 0) {
222 num_blocks
+= b
->num_array_elements
;
223 num_variables
+= b
->num_array_elements
224 * block_size
.num_active_uniforms
;
227 num_variables
+= block_size
.num_active_uniforms
;
232 if (num_blocks
== 0) {
233 assert(num_variables
== 0);
234 _mesa_hash_table_destroy(block_hash
, NULL
);
238 assert(num_variables
!= 0);
240 /* Allocate storage to hold all of the informatation related to uniform
241 * blocks that can be queried through the API.
243 gl_uniform_block
*blocks
=
244 ralloc_array(mem_ctx
, gl_uniform_block
, num_blocks
);
245 gl_uniform_buffer_variable
*variables
=
246 ralloc_array(blocks
, gl_uniform_buffer_variable
, num_variables
);
248 /* Add each variable from each uniform block to the API tracking
252 ubo_visitor
parcel(blocks
, variables
, num_variables
);
254 STATIC_ASSERT(unsigned(GLSL_INTERFACE_PACKING_STD140
)
255 == unsigned(ubo_packing_std140
));
256 STATIC_ASSERT(unsigned(GLSL_INTERFACE_PACKING_SHARED
)
257 == unsigned(ubo_packing_shared
));
258 STATIC_ASSERT(unsigned(GLSL_INTERFACE_PACKING_PACKED
)
259 == unsigned(ubo_packing_packed
));
262 hash_table_foreach (block_hash
, entry
) {
263 const struct link_uniform_block_active
*const b
=
264 (const struct link_uniform_block_active
*) entry
->data
;
265 const glsl_type
*block_type
= b
->type
;
267 if (b
->num_array_elements
> 0) {
268 const char *const name
= block_type
->fields
.array
->name
;
270 assert(b
->has_instance_name
);
271 for (unsigned j
= 0; j
< b
->num_array_elements
; j
++) {
272 blocks
[i
].Name
= ralloc_asprintf(blocks
, "%s[%u]", name
,
273 b
->array_elements
[j
]);
274 blocks
[i
].Uniforms
= &variables
[parcel
.index
];
276 /* The GL_ARB_shading_language_420pack spec says:
278 * "If the binding identifier is used with a uniform block
279 * instanced as an array then the first element of the array
280 * takes the specified block binding and each subsequent
281 * element takes the next consecutive uniform block binding
284 blocks
[i
].Binding
= (b
->has_binding
) ? b
->binding
+ j
: 0;
286 blocks
[i
].UniformBufferSize
= 0;
288 gl_uniform_block_packing(block_type
->interface_packing
);
290 parcel
.process(block_type
->fields
.array
,
293 blocks
[i
].UniformBufferSize
= parcel
.buffer_size
;
295 blocks
[i
].NumUniforms
=
296 (unsigned)(ptrdiff_t)(&variables
[parcel
.index
] - blocks
[i
].Uniforms
);
301 blocks
[i
].Name
= ralloc_strdup(blocks
, block_type
->name
);
302 blocks
[i
].Uniforms
= &variables
[parcel
.index
];
303 blocks
[i
].Binding
= (b
->has_binding
) ? b
->binding
: 0;
304 blocks
[i
].UniformBufferSize
= 0;
306 gl_uniform_block_packing(block_type
->interface_packing
);
308 parcel
.process(block_type
,
309 b
->has_instance_name
? block_type
->name
: "");
311 blocks
[i
].UniformBufferSize
= parcel
.buffer_size
;
313 blocks
[i
].NumUniforms
=
314 (unsigned)(ptrdiff_t)(&variables
[parcel
.index
] - blocks
[i
].Uniforms
);
320 assert(parcel
.index
== num_variables
);
322 _mesa_hash_table_destroy(block_hash
, NULL
);
324 *blocks_ret
= blocks
;
329 link_uniform_blocks_are_compatible(const gl_uniform_block
*a
,
330 const gl_uniform_block
*b
)
332 assert(strcmp(a
->Name
, b
->Name
) == 0);
334 /* Page 35 (page 42 of the PDF) in section 4.3.7 of the GLSL 1.50 spec says:
336 * "Matched block names within an interface (as defined above) must
337 * match in terms of having the same number of declarations with the
338 * same sequence of types and the same sequence of member names, as
339 * well as having the same member-wise layout qualification....if a
340 * matching block is declared as an array, then the array sizes must
341 * also match... Any mismatch will generate a link error."
343 * Arrays are not yet supported, so there is no check for that.
345 if (a
->NumUniforms
!= b
->NumUniforms
)
348 if (a
->_Packing
!= b
->_Packing
)
351 for (unsigned i
= 0; i
< a
->NumUniforms
; i
++) {
352 if (strcmp(a
->Uniforms
[i
].Name
, b
->Uniforms
[i
].Name
) != 0)
355 if (a
->Uniforms
[i
].Type
!= b
->Uniforms
[i
].Type
)
358 if (a
->Uniforms
[i
].RowMajor
!= b
->Uniforms
[i
].RowMajor
)