2 * Copyright © 2013 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 link_interface_blocks.cpp
26 * Linker support for GLSL's interface blocks.
30 #include "glsl_symbol_table.h"
32 #include "main/macros.h"
33 #include "util/hash_table.h"
39 * Check if two interfaces match, according to intrastage interface matching
40 * rules. If they do, and the first interface uses an unsized array, it will
41 * be updated to reflect the array size declared in the second interface.
44 intrastage_match(ir_variable
*a
,
46 struct gl_shader_program
*prog
)
48 /* Types must match. */
49 if (a
->get_interface_type() != b
->get_interface_type()) {
50 /* Exception: if both the interface blocks are implicitly declared,
51 * don't force their types to match. They might mismatch due to the two
52 * shaders using different GLSL versions, and that's ok.
54 if (a
->data
.how_declared
!= ir_var_declared_implicitly
||
55 b
->data
.how_declared
!= ir_var_declared_implicitly
)
59 /* Presence/absence of interface names must match. */
60 if (a
->is_interface_instance() != b
->is_interface_instance())
63 /* For uniforms, instance names need not match. For shader ins/outs,
64 * it's not clear from the spec whether they need to match, but
65 * Mesa's implementation relies on them matching.
67 if (a
->is_interface_instance() && b
->data
.mode
!= ir_var_uniform
&&
68 b
->data
.mode
!= ir_var_shader_storage
&&
69 strcmp(a
->name
, b
->name
) != 0) {
73 /* If a block is an array then it must match across the shader.
74 * Unsized arrays are also processed and matched agaist sized arrays.
76 if (b
->type
!= a
->type
&&
77 (b
->is_interface_instance() || a
->is_interface_instance()) &&
78 !validate_intrastage_arrays(prog
, b
, a
))
85 * Return true if interface members mismatch and its not allowed by GLSL.
88 interstage_member_mismatch(struct gl_shader_program
*prog
,
89 const glsl_type
*c
, const glsl_type
*p
) {
91 if (c
->length
!= p
->length
)
94 for (unsigned i
= 0; i
< c
->length
; i
++) {
95 if (c
->fields
.structure
[i
].type
!= p
->fields
.structure
[i
].type
)
97 if (strcmp(c
->fields
.structure
[i
].name
,
98 p
->fields
.structure
[i
].name
) != 0)
100 if (c
->fields
.structure
[i
].location
!=
101 p
->fields
.structure
[i
].location
)
103 if (c
->fields
.structure
[i
].patch
!=
104 p
->fields
.structure
[i
].patch
)
107 /* From Section 4.5 (Interpolation Qualifiers) of the GLSL 4.40 spec:
109 * "It is a link-time error if, within the same stage, the
110 * interpolation qualifiers of variables of the same name do not
113 if (prog
->IsES
|| prog
->Version
< 440)
114 if (c
->fields
.structure
[i
].interpolation
!=
115 p
->fields
.structure
[i
].interpolation
)
118 /* From Section 4.3.4 (Input Variables) of the GLSL ES 3.0 spec:
120 * "The output of the vertex shader and the input of the fragment
121 * shader form an interface. For this interface, vertex shader
122 * output variables and fragment shader input variables of the same
123 * name must match in type and qualification (other than precision
124 * and out matching to in).
126 * The table in Section 9.2.1 Linked Shaders of the GLSL ES 3.1 spec
127 * says that centroid no longer needs to match for varyings.
129 * The table in Section 9.2.1 Linked Shaders of the GLSL ES 3.2 spec
130 * says that sample need not match for varyings.
132 if (!prog
->IsES
|| prog
->Version
< 310)
133 if (c
->fields
.structure
[i
].centroid
!=
134 p
->fields
.structure
[i
].centroid
)
137 if (c
->fields
.structure
[i
].sample
!=
138 p
->fields
.structure
[i
].sample
)
146 * Check if two interfaces match, according to interstage (in/out) interface
149 * If \c extra_array_level is true, the consumer interface is required to be
150 * an array and the producer interface is required to be a non-array.
151 * This is used for tessellation control and geometry shader consumers.
154 interstage_match(struct gl_shader_program
*prog
, ir_variable
*producer
,
155 ir_variable
*consumer
, bool extra_array_level
)
157 /* Unsized arrays should not occur during interstage linking. They
158 * should have all been assigned a size by link_intrastage_shaders.
160 assert(!consumer
->type
->is_unsized_array());
161 assert(!producer
->type
->is_unsized_array());
163 /* Types must match. */
164 if (consumer
->get_interface_type() != producer
->get_interface_type()) {
165 /* Exception: if both the interface blocks are implicitly declared,
166 * don't force their types to match. They might mismatch due to the two
167 * shaders using different GLSL versions, and that's ok.
169 * Also we store some member information such as interpolation in
170 * glsl_type that doesn't always have to match across shader stages.
171 * Therefore we make a pass over the members glsl_struct_field to make
172 * sure we don't reject shaders where fields don't need to match.
174 if ((consumer
->data
.how_declared
!= ir_var_declared_implicitly
||
175 producer
->data
.how_declared
!= ir_var_declared_implicitly
) &&
176 interstage_member_mismatch(prog
, consumer
->get_interface_type(),
177 producer
->get_interface_type()))
181 /* Ignore outermost array if geom shader */
182 const glsl_type
*consumer_instance_type
;
183 if (extra_array_level
) {
184 consumer_instance_type
= consumer
->type
->fields
.array
;
186 consumer_instance_type
= consumer
->type
;
189 /* If a block is an array then it must match across shaders.
190 * Since unsized arrays have been ruled out, we can check this by just
191 * making sure the types are equal.
193 if ((consumer
->is_interface_instance() &&
194 consumer_instance_type
->is_array()) ||
195 (producer
->is_interface_instance() &&
196 producer
->type
->is_array())) {
197 if (consumer_instance_type
!= producer
->type
)
206 * This class keeps track of a mapping from an interface block name to the
207 * necessary information about that interface block to determine whether to
208 * generate a link error.
210 * Note: this class is expected to be short lived, so it doesn't make copies
211 * of the strings it references; it simply borrows the pointers from the
214 class interface_block_definitions
217 interface_block_definitions()
218 : mem_ctx(ralloc_context(NULL
)),
219 ht(_mesa_hash_table_create(NULL
, _mesa_key_hash_string
,
220 _mesa_key_string_equal
))
224 ~interface_block_definitions()
226 ralloc_free(mem_ctx
);
227 _mesa_hash_table_destroy(ht
, NULL
);
231 * Lookup the interface definition. Return NULL if none is found.
233 ir_variable
*lookup(ir_variable
*var
)
235 if (var
->data
.explicit_location
&&
236 var
->data
.location
>= VARYING_SLOT_VAR0
) {
237 char location_str
[11];
238 snprintf(location_str
, 11, "%d", var
->data
.location
);
240 const struct hash_entry
*entry
=
241 _mesa_hash_table_search(ht
, location_str
);
242 return entry
? (ir_variable
*) entry
->data
: NULL
;
244 const struct hash_entry
*entry
=
245 _mesa_hash_table_search(ht
,
246 var
->get_interface_type()->without_array()->name
);
247 return entry
? (ir_variable
*) entry
->data
: NULL
;
252 * Add a new interface definition.
254 void store(ir_variable
*var
)
256 if (var
->data
.explicit_location
&&
257 var
->data
.location
>= VARYING_SLOT_VAR0
) {
258 /* If explicit location is given then lookup the variable by location.
259 * We turn the location into a string and use this as the hash key
260 * rather than the name. Note: We allocate enough space for a 32-bit
261 * unsigned location value which is overkill but future proof.
263 char location_str
[11];
264 snprintf(location_str
, 11, "%d", var
->data
.location
);
265 _mesa_hash_table_insert(ht
, ralloc_strdup(mem_ctx
, location_str
), var
);
267 _mesa_hash_table_insert(ht
,
268 var
->get_interface_type()->without_array()->name
, var
);
274 * Ralloc context for data structures allocated by this class.
279 * Hash table mapping interface block name to an \c
286 }; /* anonymous namespace */
290 validate_intrastage_interface_blocks(struct gl_shader_program
*prog
,
291 const gl_shader
**shader_list
,
292 unsigned num_shaders
)
294 interface_block_definitions in_interfaces
;
295 interface_block_definitions out_interfaces
;
296 interface_block_definitions uniform_interfaces
;
297 interface_block_definitions buffer_interfaces
;
299 for (unsigned int i
= 0; i
< num_shaders
; i
++) {
300 if (shader_list
[i
] == NULL
)
303 foreach_in_list(ir_instruction
, node
, shader_list
[i
]->ir
) {
304 ir_variable
*var
= node
->as_variable();
308 const glsl_type
*iface_type
= var
->get_interface_type();
310 if (iface_type
== NULL
)
313 interface_block_definitions
*definitions
;
314 switch (var
->data
.mode
) {
315 case ir_var_shader_in
:
316 definitions
= &in_interfaces
;
318 case ir_var_shader_out
:
319 definitions
= &out_interfaces
;
322 definitions
= &uniform_interfaces
;
324 case ir_var_shader_storage
:
325 definitions
= &buffer_interfaces
;
328 /* Only in, out, and uniform interfaces are legal, so we should
331 assert(!"illegal interface type");
335 ir_variable
*prev_def
= definitions
->lookup(var
);
336 if (prev_def
== NULL
) {
337 /* This is the first time we've seen the interface, so save
338 * it into the appropriate data structure.
340 definitions
->store(var
);
341 } else if (!intrastage_match(prev_def
, var
, prog
)) {
342 linker_error(prog
, "definitions of interface block `%s' do not"
343 " match\n", iface_type
->name
);
351 validate_interstage_inout_blocks(struct gl_shader_program
*prog
,
352 const gl_shader
*producer
,
353 const gl_shader
*consumer
)
355 interface_block_definitions definitions
;
356 /* VS -> GS, VS -> TCS, VS -> TES, TES -> GS */
357 const bool extra_array_level
= (producer
->Stage
== MESA_SHADER_VERTEX
&&
358 consumer
->Stage
!= MESA_SHADER_FRAGMENT
) ||
359 consumer
->Stage
== MESA_SHADER_GEOMETRY
;
361 /* Add input interfaces from the consumer to the symbol table. */
362 foreach_in_list(ir_instruction
, node
, consumer
->ir
) {
363 ir_variable
*var
= node
->as_variable();
364 if (!var
|| !var
->get_interface_type() || var
->data
.mode
!= ir_var_shader_in
)
367 definitions
.store(var
);
370 /* Verify that the producer's output interfaces match. */
371 foreach_in_list(ir_instruction
, node
, producer
->ir
) {
372 ir_variable
*var
= node
->as_variable();
373 if (!var
|| !var
->get_interface_type() || var
->data
.mode
!= ir_var_shader_out
)
376 ir_variable
*consumer_def
= definitions
.lookup(var
);
378 /* The consumer doesn't use this output block. Ignore it. */
379 if (consumer_def
== NULL
)
382 if (!interstage_match(prog
, var
, consumer_def
, extra_array_level
)) {
383 linker_error(prog
, "definitions of interface block `%s' do not "
384 "match\n", var
->get_interface_type()->name
);
392 validate_interstage_uniform_blocks(struct gl_shader_program
*prog
,
393 gl_shader
**stages
, int num_stages
)
395 interface_block_definitions definitions
;
397 for (int i
= 0; i
< num_stages
; i
++) {
398 if (stages
[i
] == NULL
)
401 const gl_shader
*stage
= stages
[i
];
402 foreach_in_list(ir_instruction
, node
, stage
->ir
) {
403 ir_variable
*var
= node
->as_variable();
404 if (!var
|| !var
->get_interface_type() ||
405 (var
->data
.mode
!= ir_var_uniform
&&
406 var
->data
.mode
!= ir_var_shader_storage
))
409 ir_variable
*old_def
= definitions
.lookup(var
);
410 if (old_def
== NULL
) {
411 definitions
.store(var
);
413 /* Interstage uniform matching rules are the same as intrastage
414 * uniform matchin rules (for uniforms, it is as though all
415 * shaders are in the same shader stage).
417 if (!intrastage_match(old_def
, var
, prog
)) {
418 linker_error(prog
, "definitions of interface block `%s' do not "
419 "match\n", var
->get_interface_type()->name
);