mesa/glsl: move uses_gl_fragcoord to gl_shader
[mesa.git] / src / compiler / glsl / linker.cpp
1 /*
2 * Copyright © 2010 Intel Corporation
3 *
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:
10 *
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
13 * Software.
14 *
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.
22 */
23
24 /**
25 * \file linker.cpp
26 * GLSL linker implementation
27 *
28 * Given a set of shaders that are to be linked to generate a final program,
29 * there are three distinct stages.
30 *
31 * In the first stage shaders are partitioned into groups based on the shader
32 * type. All shaders of a particular type (e.g., vertex shaders) are linked
33 * together.
34 *
35 * - Undefined references in each shader are resolve to definitions in
36 * another shader.
37 * - Types and qualifiers of uniforms, outputs, and global variables defined
38 * in multiple shaders with the same name are verified to be the same.
39 * - Initializers for uniforms and global variables defined
40 * in multiple shaders with the same name are verified to be the same.
41 *
42 * The result, in the terminology of the GLSL spec, is a set of shader
43 * executables for each processing unit.
44 *
45 * After the first stage is complete, a series of semantic checks are performed
46 * on each of the shader executables.
47 *
48 * - Each shader executable must define a \c main function.
49 * - Each vertex shader executable must write to \c gl_Position.
50 * - Each fragment shader executable must write to either \c gl_FragData or
51 * \c gl_FragColor.
52 *
53 * In the final stage individual shader executables are linked to create a
54 * complete exectuable.
55 *
56 * - Types of uniforms defined in multiple shader stages with the same name
57 * are verified to be the same.
58 * - Initializers for uniforms defined in multiple shader stages with the
59 * same name are verified to be the same.
60 * - Types and qualifiers of outputs defined in one stage are verified to
61 * be the same as the types and qualifiers of inputs defined with the same
62 * name in a later stage.
63 *
64 * \author Ian Romanick <ian.d.romanick@intel.com>
65 */
66
67 #include <ctype.h>
68 #include "util/strndup.h"
69 #include "main/core.h"
70 #include "glsl_symbol_table.h"
71 #include "glsl_parser_extras.h"
72 #include "ir.h"
73 #include "program.h"
74 #include "program/prog_instruction.h"
75 #include "program/program.h"
76 #include "util/set.h"
77 #include "util/string_to_uint_map.h"
78 #include "linker.h"
79 #include "link_varyings.h"
80 #include "ir_optimization.h"
81 #include "ir_rvalue_visitor.h"
82 #include "ir_uniform.h"
83
84 #include "main/shaderobj.h"
85 #include "main/enums.h"
86
87
88 namespace {
89
90 /**
91 * Visitor that determines whether or not a variable is ever written.
92 */
93 class find_assignment_visitor : public ir_hierarchical_visitor {
94 public:
95 find_assignment_visitor(const char *name)
96 : name(name), found(false)
97 {
98 /* empty */
99 }
100
101 virtual ir_visitor_status visit_enter(ir_assignment *ir)
102 {
103 ir_variable *const var = ir->lhs->variable_referenced();
104
105 if (strcmp(name, var->name) == 0) {
106 found = true;
107 return visit_stop;
108 }
109
110 return visit_continue_with_parent;
111 }
112
113 virtual ir_visitor_status visit_enter(ir_call *ir)
114 {
115 foreach_two_lists(formal_node, &ir->callee->parameters,
116 actual_node, &ir->actual_parameters) {
117 ir_rvalue *param_rval = (ir_rvalue *) actual_node;
118 ir_variable *sig_param = (ir_variable *) formal_node;
119
120 if (sig_param->data.mode == ir_var_function_out ||
121 sig_param->data.mode == ir_var_function_inout) {
122 ir_variable *var = param_rval->variable_referenced();
123 if (var && strcmp(name, var->name) == 0) {
124 found = true;
125 return visit_stop;
126 }
127 }
128 }
129
130 if (ir->return_deref != NULL) {
131 ir_variable *const var = ir->return_deref->variable_referenced();
132
133 if (strcmp(name, var->name) == 0) {
134 found = true;
135 return visit_stop;
136 }
137 }
138
139 return visit_continue_with_parent;
140 }
141
142 bool variable_found()
143 {
144 return found;
145 }
146
147 private:
148 const char *name; /**< Find writes to a variable with this name. */
149 bool found; /**< Was a write to the variable found? */
150 };
151
152
153 /**
154 * Visitor that determines whether or not a variable is ever read.
155 */
156 class find_deref_visitor : public ir_hierarchical_visitor {
157 public:
158 find_deref_visitor(const char *name)
159 : name(name), found(false)
160 {
161 /* empty */
162 }
163
164 virtual ir_visitor_status visit(ir_dereference_variable *ir)
165 {
166 if (strcmp(this->name, ir->var->name) == 0) {
167 this->found = true;
168 return visit_stop;
169 }
170
171 return visit_continue;
172 }
173
174 bool variable_found() const
175 {
176 return this->found;
177 }
178
179 private:
180 const char *name; /**< Find writes to a variable with this name. */
181 bool found; /**< Was a write to the variable found? */
182 };
183
184
185 /**
186 * A visitor helper that provides methods for updating the types of
187 * ir_dereferences. Classes that update variable types (say, updating
188 * array sizes) will want to use this so that dereference types stay in sync.
189 */
190 class deref_type_updater : public ir_hierarchical_visitor {
191 public:
192 virtual ir_visitor_status visit(ir_dereference_variable *ir)
193 {
194 ir->type = ir->var->type;
195 return visit_continue;
196 }
197
198 virtual ir_visitor_status visit_leave(ir_dereference_array *ir)
199 {
200 const glsl_type *const vt = ir->array->type;
201 if (vt->is_array())
202 ir->type = vt->fields.array;
203 return visit_continue;
204 }
205
206 virtual ir_visitor_status visit_leave(ir_dereference_record *ir)
207 {
208 for (unsigned i = 0; i < ir->record->type->length; i++) {
209 const struct glsl_struct_field *field =
210 &ir->record->type->fields.structure[i];
211 if (strcmp(field->name, ir->field) == 0) {
212 ir->type = field->type;
213 break;
214 }
215 }
216 return visit_continue;
217 }
218 };
219
220
221 class array_resize_visitor : public deref_type_updater {
222 public:
223 unsigned num_vertices;
224 gl_shader_program *prog;
225 gl_shader_stage stage;
226
227 array_resize_visitor(unsigned num_vertices,
228 gl_shader_program *prog,
229 gl_shader_stage stage)
230 {
231 this->num_vertices = num_vertices;
232 this->prog = prog;
233 this->stage = stage;
234 }
235
236 virtual ~array_resize_visitor()
237 {
238 /* empty */
239 }
240
241 virtual ir_visitor_status visit(ir_variable *var)
242 {
243 if (!var->type->is_array() || var->data.mode != ir_var_shader_in ||
244 var->data.patch)
245 return visit_continue;
246
247 unsigned size = var->type->length;
248
249 if (stage == MESA_SHADER_GEOMETRY) {
250 /* Generate a link error if the shader has declared this array with
251 * an incorrect size.
252 */
253 if (!var->data.implicit_sized_array &&
254 size && size != this->num_vertices) {
255 linker_error(this->prog, "size of array %s declared as %u, "
256 "but number of input vertices is %u\n",
257 var->name, size, this->num_vertices);
258 return visit_continue;
259 }
260
261 /* Generate a link error if the shader attempts to access an input
262 * array using an index too large for its actual size assigned at
263 * link time.
264 */
265 if (var->data.max_array_access >= (int)this->num_vertices) {
266 linker_error(this->prog, "%s shader accesses element %i of "
267 "%s, but only %i input vertices\n",
268 _mesa_shader_stage_to_string(this->stage),
269 var->data.max_array_access, var->name, this->num_vertices);
270 return visit_continue;
271 }
272 }
273
274 var->type = glsl_type::get_array_instance(var->type->fields.array,
275 this->num_vertices);
276 var->data.max_array_access = this->num_vertices - 1;
277
278 return visit_continue;
279 }
280 };
281
282 /**
283 * Visitor that determines the highest stream id to which a (geometry) shader
284 * emits vertices. It also checks whether End{Stream}Primitive is ever called.
285 */
286 class find_emit_vertex_visitor : public ir_hierarchical_visitor {
287 public:
288 find_emit_vertex_visitor(int max_allowed)
289 : max_stream_allowed(max_allowed),
290 invalid_stream_id(0),
291 invalid_stream_id_from_emit_vertex(false),
292 end_primitive_found(false),
293 uses_non_zero_stream(false)
294 {
295 /* empty */
296 }
297
298 virtual ir_visitor_status visit_leave(ir_emit_vertex *ir)
299 {
300 int stream_id = ir->stream_id();
301
302 if (stream_id < 0) {
303 invalid_stream_id = stream_id;
304 invalid_stream_id_from_emit_vertex = true;
305 return visit_stop;
306 }
307
308 if (stream_id > max_stream_allowed) {
309 invalid_stream_id = stream_id;
310 invalid_stream_id_from_emit_vertex = true;
311 return visit_stop;
312 }
313
314 if (stream_id != 0)
315 uses_non_zero_stream = true;
316
317 return visit_continue;
318 }
319
320 virtual ir_visitor_status visit_leave(ir_end_primitive *ir)
321 {
322 end_primitive_found = true;
323
324 int stream_id = ir->stream_id();
325
326 if (stream_id < 0) {
327 invalid_stream_id = stream_id;
328 invalid_stream_id_from_emit_vertex = false;
329 return visit_stop;
330 }
331
332 if (stream_id > max_stream_allowed) {
333 invalid_stream_id = stream_id;
334 invalid_stream_id_from_emit_vertex = false;
335 return visit_stop;
336 }
337
338 if (stream_id != 0)
339 uses_non_zero_stream = true;
340
341 return visit_continue;
342 }
343
344 bool error()
345 {
346 return invalid_stream_id != 0;
347 }
348
349 const char *error_func()
350 {
351 return invalid_stream_id_from_emit_vertex ?
352 "EmitStreamVertex" : "EndStreamPrimitive";
353 }
354
355 int error_stream()
356 {
357 return invalid_stream_id;
358 }
359
360 bool uses_streams()
361 {
362 return uses_non_zero_stream;
363 }
364
365 bool uses_end_primitive()
366 {
367 return end_primitive_found;
368 }
369
370 private:
371 int max_stream_allowed;
372 int invalid_stream_id;
373 bool invalid_stream_id_from_emit_vertex;
374 bool end_primitive_found;
375 bool uses_non_zero_stream;
376 };
377
378 /* Class that finds array derefs and check if indexes are dynamic. */
379 class dynamic_sampler_array_indexing_visitor : public ir_hierarchical_visitor
380 {
381 public:
382 dynamic_sampler_array_indexing_visitor() :
383 dynamic_sampler_array_indexing(false)
384 {
385 }
386
387 ir_visitor_status visit_enter(ir_dereference_array *ir)
388 {
389 if (!ir->variable_referenced())
390 return visit_continue;
391
392 if (!ir->variable_referenced()->type->contains_sampler())
393 return visit_continue;
394
395 if (!ir->array_index->constant_expression_value()) {
396 dynamic_sampler_array_indexing = true;
397 return visit_stop;
398 }
399 return visit_continue;
400 }
401
402 bool uses_dynamic_sampler_array_indexing()
403 {
404 return dynamic_sampler_array_indexing;
405 }
406
407 private:
408 bool dynamic_sampler_array_indexing;
409 };
410
411 } /* anonymous namespace */
412
413 void
414 linker_error(gl_shader_program *prog, const char *fmt, ...)
415 {
416 va_list ap;
417
418 ralloc_strcat(&prog->data->InfoLog, "error: ");
419 va_start(ap, fmt);
420 ralloc_vasprintf_append(&prog->data->InfoLog, fmt, ap);
421 va_end(ap);
422
423 prog->data->LinkStatus = false;
424 }
425
426
427 void
428 linker_warning(gl_shader_program *prog, const char *fmt, ...)
429 {
430 va_list ap;
431
432 ralloc_strcat(&prog->data->InfoLog, "warning: ");
433 va_start(ap, fmt);
434 ralloc_vasprintf_append(&prog->data->InfoLog, fmt, ap);
435 va_end(ap);
436
437 }
438
439
440 /**
441 * Given a string identifying a program resource, break it into a base name
442 * and an optional array index in square brackets.
443 *
444 * If an array index is present, \c out_base_name_end is set to point to the
445 * "[" that precedes the array index, and the array index itself is returned
446 * as a long.
447 *
448 * If no array index is present (or if the array index is negative or
449 * mal-formed), \c out_base_name_end, is set to point to the null terminator
450 * at the end of the input string, and -1 is returned.
451 *
452 * Only the final array index is parsed; if the string contains other array
453 * indices (or structure field accesses), they are left in the base name.
454 *
455 * No attempt is made to check that the base name is properly formed;
456 * typically the caller will look up the base name in a hash table, so
457 * ill-formed base names simply turn into hash table lookup failures.
458 */
459 long
460 parse_program_resource_name(const GLchar *name,
461 const GLchar **out_base_name_end)
462 {
463 /* Section 7.3.1 ("Program Interfaces") of the OpenGL 4.3 spec says:
464 *
465 * "When an integer array element or block instance number is part of
466 * the name string, it will be specified in decimal form without a "+"
467 * or "-" sign or any extra leading zeroes. Additionally, the name
468 * string will not include white space anywhere in the string."
469 */
470
471 const size_t len = strlen(name);
472 *out_base_name_end = name + len;
473
474 if (len == 0 || name[len-1] != ']')
475 return -1;
476
477 /* Walk backwards over the string looking for a non-digit character. This
478 * had better be the opening bracket for an array index.
479 *
480 * Initially, i specifies the location of the ']'. Since the string may
481 * contain only the ']' charcater, walk backwards very carefully.
482 */
483 unsigned i;
484 for (i = len - 1; (i > 0) && isdigit(name[i-1]); --i)
485 /* empty */ ;
486
487 if ((i == 0) || name[i-1] != '[')
488 return -1;
489
490 long array_index = strtol(&name[i], NULL, 10);
491 if (array_index < 0)
492 return -1;
493
494 /* Check for leading zero */
495 if (name[i] == '0' && name[i+1] != ']')
496 return -1;
497
498 *out_base_name_end = name + (i - 1);
499 return array_index;
500 }
501
502
503 void
504 link_invalidate_variable_locations(exec_list *ir)
505 {
506 foreach_in_list(ir_instruction, node, ir) {
507 ir_variable *const var = node->as_variable();
508
509 if (var == NULL)
510 continue;
511
512 /* Only assign locations for variables that lack an explicit location.
513 * Explicit locations are set for all built-in variables, generic vertex
514 * shader inputs (via layout(location=...)), and generic fragment shader
515 * outputs (also via layout(location=...)).
516 */
517 if (!var->data.explicit_location) {
518 var->data.location = -1;
519 var->data.location_frac = 0;
520 }
521
522 /* ir_variable::is_unmatched_generic_inout is used by the linker while
523 * connecting outputs from one stage to inputs of the next stage.
524 */
525 if (var->data.explicit_location &&
526 var->data.location < VARYING_SLOT_VAR0) {
527 var->data.is_unmatched_generic_inout = 0;
528 } else {
529 var->data.is_unmatched_generic_inout = 1;
530 }
531 }
532 }
533
534
535 /**
536 * Set clip_distance_array_size based and cull_distance_array_size on the given
537 * shader.
538 *
539 * Also check for errors based on incorrect usage of gl_ClipVertex and
540 * gl_ClipDistance and gl_CullDistance.
541 * Additionally test whether the arrays gl_ClipDistance and gl_CullDistance
542 * exceed the maximum size defined by gl_MaxCombinedClipAndCullDistances.
543 *
544 * Return false if an error was reported.
545 */
546 static void
547 analyze_clip_cull_usage(struct gl_shader_program *prog,
548 struct gl_linked_shader *shader,
549 struct gl_context *ctx,
550 GLuint *clip_distance_array_size,
551 GLuint *cull_distance_array_size)
552 {
553 *clip_distance_array_size = 0;
554 *cull_distance_array_size = 0;
555
556 if (prog->data->Version >= (prog->IsES ? 300 : 130)) {
557 /* From section 7.1 (Vertex Shader Special Variables) of the
558 * GLSL 1.30 spec:
559 *
560 * "It is an error for a shader to statically write both
561 * gl_ClipVertex and gl_ClipDistance."
562 *
563 * This does not apply to GLSL ES shaders, since GLSL ES defines neither
564 * gl_ClipVertex nor gl_ClipDistance. However with
565 * GL_EXT_clip_cull_distance, this functionality is exposed in ES 3.0.
566 */
567 find_assignment_visitor clip_distance("gl_ClipDistance");
568 find_assignment_visitor cull_distance("gl_CullDistance");
569
570 clip_distance.run(shader->ir);
571 cull_distance.run(shader->ir);
572
573 /* From the ARB_cull_distance spec:
574 *
575 * It is a compile-time or link-time error for the set of shaders forming
576 * a program to statically read or write both gl_ClipVertex and either
577 * gl_ClipDistance or gl_CullDistance.
578 *
579 * This does not apply to GLSL ES shaders, since GLSL ES doesn't define
580 * gl_ClipVertex.
581 */
582 if (!prog->IsES) {
583 find_assignment_visitor clip_vertex("gl_ClipVertex");
584
585 clip_vertex.run(shader->ir);
586
587 if (clip_vertex.variable_found() && clip_distance.variable_found()) {
588 linker_error(prog, "%s shader writes to both `gl_ClipVertex' "
589 "and `gl_ClipDistance'\n",
590 _mesa_shader_stage_to_string(shader->Stage));
591 return;
592 }
593 if (clip_vertex.variable_found() && cull_distance.variable_found()) {
594 linker_error(prog, "%s shader writes to both `gl_ClipVertex' "
595 "and `gl_CullDistance'\n",
596 _mesa_shader_stage_to_string(shader->Stage));
597 return;
598 }
599 }
600
601 if (clip_distance.variable_found()) {
602 ir_variable *clip_distance_var =
603 shader->symbols->get_variable("gl_ClipDistance");
604 assert(clip_distance_var);
605 *clip_distance_array_size = clip_distance_var->type->length;
606 }
607 if (cull_distance.variable_found()) {
608 ir_variable *cull_distance_var =
609 shader->symbols->get_variable("gl_CullDistance");
610 assert(cull_distance_var);
611 *cull_distance_array_size = cull_distance_var->type->length;
612 }
613 /* From the ARB_cull_distance spec:
614 *
615 * It is a compile-time or link-time error for the set of shaders forming
616 * a program to have the sum of the sizes of the gl_ClipDistance and
617 * gl_CullDistance arrays to be larger than
618 * gl_MaxCombinedClipAndCullDistances.
619 */
620 if ((*clip_distance_array_size + *cull_distance_array_size) >
621 ctx->Const.MaxClipPlanes) {
622 linker_error(prog, "%s shader: the combined size of "
623 "'gl_ClipDistance' and 'gl_CullDistance' size cannot "
624 "be larger than "
625 "gl_MaxCombinedClipAndCullDistances (%u)",
626 _mesa_shader_stage_to_string(shader->Stage),
627 ctx->Const.MaxClipPlanes);
628 }
629 }
630 }
631
632
633 /**
634 * Verify that a vertex shader executable meets all semantic requirements.
635 *
636 * Also sets prog->Vert.ClipDistanceArraySize and
637 * prog->Vert.CullDistanceArraySize as a side effect.
638 *
639 * \param shader Vertex shader executable to be verified
640 */
641 void
642 validate_vertex_shader_executable(struct gl_shader_program *prog,
643 struct gl_linked_shader *shader,
644 struct gl_context *ctx)
645 {
646 if (shader == NULL)
647 return;
648
649 /* From the GLSL 1.10 spec, page 48:
650 *
651 * "The variable gl_Position is available only in the vertex
652 * language and is intended for writing the homogeneous vertex
653 * position. All executions of a well-formed vertex shader
654 * executable must write a value into this variable. [...] The
655 * variable gl_Position is available only in the vertex
656 * language and is intended for writing the homogeneous vertex
657 * position. All executions of a well-formed vertex shader
658 * executable must write a value into this variable."
659 *
660 * while in GLSL 1.40 this text is changed to:
661 *
662 * "The variable gl_Position is available only in the vertex
663 * language and is intended for writing the homogeneous vertex
664 * position. It can be written at any time during shader
665 * execution. It may also be read back by a vertex shader
666 * after being written. This value will be used by primitive
667 * assembly, clipping, culling, and other fixed functionality
668 * operations, if present, that operate on primitives after
669 * vertex processing has occurred. Its value is undefined if
670 * the vertex shader executable does not write gl_Position."
671 *
672 * All GLSL ES Versions are similar to GLSL 1.40--failing to write to
673 * gl_Position is not an error.
674 */
675 if (prog->data->Version < (prog->IsES ? 300 : 140)) {
676 find_assignment_visitor find("gl_Position");
677 find.run(shader->ir);
678 if (!find.variable_found()) {
679 if (prog->IsES) {
680 linker_warning(prog,
681 "vertex shader does not write to `gl_Position'. "
682 "Its value is undefined. \n");
683 } else {
684 linker_error(prog,
685 "vertex shader does not write to `gl_Position'. \n");
686 }
687 return;
688 }
689 }
690
691 analyze_clip_cull_usage(prog, shader, ctx,
692 &prog->Vert.ClipDistanceArraySize,
693 &prog->Vert.CullDistanceArraySize);
694 }
695
696 void
697 validate_tess_eval_shader_executable(struct gl_shader_program *prog,
698 struct gl_linked_shader *shader,
699 struct gl_context *ctx)
700 {
701 if (shader == NULL)
702 return;
703
704 analyze_clip_cull_usage(prog, shader, ctx,
705 &prog->TessEval.ClipDistanceArraySize,
706 &prog->TessEval.CullDistanceArraySize);
707 }
708
709
710 /**
711 * Verify that a fragment shader executable meets all semantic requirements
712 *
713 * \param shader Fragment shader executable to be verified
714 */
715 void
716 validate_fragment_shader_executable(struct gl_shader_program *prog,
717 struct gl_linked_shader *shader)
718 {
719 if (shader == NULL)
720 return;
721
722 find_assignment_visitor frag_color("gl_FragColor");
723 find_assignment_visitor frag_data("gl_FragData");
724
725 frag_color.run(shader->ir);
726 frag_data.run(shader->ir);
727
728 if (frag_color.variable_found() && frag_data.variable_found()) {
729 linker_error(prog, "fragment shader writes to both "
730 "`gl_FragColor' and `gl_FragData'\n");
731 }
732 }
733
734 /**
735 * Verify that a geometry shader executable meets all semantic requirements
736 *
737 * Also sets prog->Geom.VerticesIn, and prog->Geom.ClipDistanceArraySize and
738 * prog->Geom.CullDistanceArraySize as a side effect.
739 *
740 * \param shader Geometry shader executable to be verified
741 */
742 void
743 validate_geometry_shader_executable(struct gl_shader_program *prog,
744 struct gl_linked_shader *shader,
745 struct gl_context *ctx)
746 {
747 if (shader == NULL)
748 return;
749
750 unsigned num_vertices = vertices_per_prim(shader->info.Geom.InputType);
751 prog->Geom.VerticesIn = num_vertices;
752
753 analyze_clip_cull_usage(prog, shader, ctx,
754 &prog->Geom.ClipDistanceArraySize,
755 &prog->Geom.CullDistanceArraySize);
756 }
757
758 /**
759 * Check if geometry shaders emit to non-zero streams and do corresponding
760 * validations.
761 */
762 static void
763 validate_geometry_shader_emissions(struct gl_context *ctx,
764 struct gl_shader_program *prog)
765 {
766 struct gl_linked_shader *sh = prog->_LinkedShaders[MESA_SHADER_GEOMETRY];
767
768 if (sh != NULL) {
769 find_emit_vertex_visitor emit_vertex(ctx->Const.MaxVertexStreams - 1);
770 emit_vertex.run(sh->ir);
771 if (emit_vertex.error()) {
772 linker_error(prog, "Invalid call %s(%d). Accepted values for the "
773 "stream parameter are in the range [0, %d].\n",
774 emit_vertex.error_func(),
775 emit_vertex.error_stream(),
776 ctx->Const.MaxVertexStreams - 1);
777 }
778 prog->Geom.UsesStreams = emit_vertex.uses_streams();
779 prog->Geom.UsesEndPrimitive = emit_vertex.uses_end_primitive();
780
781 /* From the ARB_gpu_shader5 spec:
782 *
783 * "Multiple vertex streams are supported only if the output primitive
784 * type is declared to be "points". A program will fail to link if it
785 * contains a geometry shader calling EmitStreamVertex() or
786 * EndStreamPrimitive() if its output primitive type is not "points".
787 *
788 * However, in the same spec:
789 *
790 * "The function EmitVertex() is equivalent to calling EmitStreamVertex()
791 * with <stream> set to zero."
792 *
793 * And:
794 *
795 * "The function EndPrimitive() is equivalent to calling
796 * EndStreamPrimitive() with <stream> set to zero."
797 *
798 * Since we can call EmitVertex() and EndPrimitive() when we output
799 * primitives other than points, calling EmitStreamVertex(0) or
800 * EmitEndPrimitive(0) should not produce errors. This it also what Nvidia
801 * does. Currently we only set prog->Geom.UsesStreams to TRUE when
802 * EmitStreamVertex() or EmitEndPrimitive() are called with a non-zero
803 * stream.
804 */
805 if (prog->Geom.UsesStreams && sh->info.Geom.OutputType != GL_POINTS) {
806 linker_error(prog, "EmitStreamVertex(n) and EndStreamPrimitive(n) "
807 "with n>0 requires point output\n");
808 }
809 }
810 }
811
812 bool
813 validate_intrastage_arrays(struct gl_shader_program *prog,
814 ir_variable *const var,
815 ir_variable *const existing)
816 {
817 /* Consider the types to be "the same" if both types are arrays
818 * of the same type and one of the arrays is implicitly sized.
819 * In addition, set the type of the linked variable to the
820 * explicitly sized array.
821 */
822 if (var->type->is_array() && existing->type->is_array()) {
823 if ((var->type->fields.array == existing->type->fields.array) &&
824 ((var->type->length == 0)|| (existing->type->length == 0))) {
825 if (var->type->length != 0) {
826 if ((int)var->type->length <= existing->data.max_array_access) {
827 linker_error(prog, "%s `%s' declared as type "
828 "`%s' but outermost dimension has an index"
829 " of `%i'\n",
830 mode_string(var),
831 var->name, var->type->name,
832 existing->data.max_array_access);
833 }
834 existing->type = var->type;
835 return true;
836 } else if (existing->type->length != 0) {
837 if((int)existing->type->length <= var->data.max_array_access &&
838 !existing->data.from_ssbo_unsized_array) {
839 linker_error(prog, "%s `%s' declared as type "
840 "`%s' but outermost dimension has an index"
841 " of `%i'\n",
842 mode_string(var),
843 var->name, existing->type->name,
844 var->data.max_array_access);
845 }
846 return true;
847 }
848 } else {
849 /* The arrays of structs could have different glsl_type pointers but
850 * they are actually the same type. Use record_compare() to check that.
851 */
852 if (existing->type->fields.array->is_record() &&
853 var->type->fields.array->is_record() &&
854 existing->type->fields.array->record_compare(var->type->fields.array))
855 return true;
856 }
857 }
858 return false;
859 }
860
861
862 /**
863 * Perform validation of global variables used across multiple shaders
864 */
865 void
866 cross_validate_globals(struct gl_shader_program *prog,
867 struct exec_list *ir, glsl_symbol_table *variables,
868 bool uniforms_only)
869 {
870 foreach_in_list(ir_instruction, node, ir) {
871 ir_variable *const var = node->as_variable();
872
873 if (var == NULL)
874 continue;
875
876 if (uniforms_only && (var->data.mode != ir_var_uniform && var->data.mode != ir_var_shader_storage))
877 continue;
878
879 /* don't cross validate subroutine uniforms */
880 if (var->type->contains_subroutine())
881 continue;
882
883 /* Don't cross validate temporaries that are at global scope. These
884 * will eventually get pulled into the shaders 'main'.
885 */
886 if (var->data.mode == ir_var_temporary)
887 continue;
888
889 /* If a global with this name has already been seen, verify that the
890 * new instance has the same type. In addition, if the globals have
891 * initializers, the values of the initializers must be the same.
892 */
893 ir_variable *const existing = variables->get_variable(var->name);
894 if (existing != NULL) {
895 /* Check if types match. Interface blocks have some special
896 * rules so we handle those elsewhere.
897 */
898 if (var->type != existing->type &&
899 !var->is_interface_instance()) {
900 if (!validate_intrastage_arrays(prog, var, existing)) {
901 if (var->type->is_record() && existing->type->is_record()
902 && existing->type->record_compare(var->type)) {
903 existing->type = var->type;
904 } else {
905 /* If it is an unsized array in a Shader Storage Block,
906 * two different shaders can access to different elements.
907 * Because of that, they might be converted to different
908 * sized arrays, then check that they are compatible but
909 * ignore the array size.
910 */
911 if (!(var->data.mode == ir_var_shader_storage &&
912 var->data.from_ssbo_unsized_array &&
913 existing->data.mode == ir_var_shader_storage &&
914 existing->data.from_ssbo_unsized_array &&
915 var->type->gl_type == existing->type->gl_type)) {
916 linker_error(prog, "%s `%s' declared as type "
917 "`%s' and type `%s'\n",
918 mode_string(var),
919 var->name, var->type->name,
920 existing->type->name);
921 return;
922 }
923 }
924 }
925 }
926
927 if (var->data.explicit_location) {
928 if (existing->data.explicit_location
929 && (var->data.location != existing->data.location)) {
930 linker_error(prog, "explicit locations for %s "
931 "`%s' have differing values\n",
932 mode_string(var), var->name);
933 return;
934 }
935
936 if (var->data.location_frac != existing->data.location_frac) {
937 linker_error(prog, "explicit components for %s `%s' have "
938 "differing values\n", mode_string(var), var->name);
939 return;
940 }
941
942 existing->data.location = var->data.location;
943 existing->data.explicit_location = true;
944 } else {
945 /* Check if uniform with implicit location was marked explicit
946 * by earlier shader stage. If so, mark it explicit in this stage
947 * too to make sure later processing does not treat it as
948 * implicit one.
949 */
950 if (existing->data.explicit_location) {
951 var->data.location = existing->data.location;
952 var->data.explicit_location = true;
953 }
954 }
955
956 /* From the GLSL 4.20 specification:
957 * "A link error will result if two compilation units in a program
958 * specify different integer-constant bindings for the same
959 * opaque-uniform name. However, it is not an error to specify a
960 * binding on some but not all declarations for the same name"
961 */
962 if (var->data.explicit_binding) {
963 if (existing->data.explicit_binding &&
964 var->data.binding != existing->data.binding) {
965 linker_error(prog, "explicit bindings for %s "
966 "`%s' have differing values\n",
967 mode_string(var), var->name);
968 return;
969 }
970
971 existing->data.binding = var->data.binding;
972 existing->data.explicit_binding = true;
973 }
974
975 if (var->type->contains_atomic() &&
976 var->data.offset != existing->data.offset) {
977 linker_error(prog, "offset specifications for %s "
978 "`%s' have differing values\n",
979 mode_string(var), var->name);
980 return;
981 }
982
983 /* Validate layout qualifiers for gl_FragDepth.
984 *
985 * From the AMD/ARB_conservative_depth specs:
986 *
987 * "If gl_FragDepth is redeclared in any fragment shader in a
988 * program, it must be redeclared in all fragment shaders in
989 * that program that have static assignments to
990 * gl_FragDepth. All redeclarations of gl_FragDepth in all
991 * fragment shaders in a single program must have the same set
992 * of qualifiers."
993 */
994 if (strcmp(var->name, "gl_FragDepth") == 0) {
995 bool layout_declared = var->data.depth_layout != ir_depth_layout_none;
996 bool layout_differs =
997 var->data.depth_layout != existing->data.depth_layout;
998
999 if (layout_declared && layout_differs) {
1000 linker_error(prog,
1001 "All redeclarations of gl_FragDepth in all "
1002 "fragment shaders in a single program must have "
1003 "the same set of qualifiers.\n");
1004 }
1005
1006 if (var->data.used && layout_differs) {
1007 linker_error(prog,
1008 "If gl_FragDepth is redeclared with a layout "
1009 "qualifier in any fragment shader, it must be "
1010 "redeclared with the same layout qualifier in "
1011 "all fragment shaders that have assignments to "
1012 "gl_FragDepth\n");
1013 }
1014 }
1015
1016 /* Page 35 (page 41 of the PDF) of the GLSL 4.20 spec says:
1017 *
1018 * "If a shared global has multiple initializers, the
1019 * initializers must all be constant expressions, and they
1020 * must all have the same value. Otherwise, a link error will
1021 * result. (A shared global having only one initializer does
1022 * not require that initializer to be a constant expression.)"
1023 *
1024 * Previous to 4.20 the GLSL spec simply said that initializers
1025 * must have the same value. In this case of non-constant
1026 * initializers, this was impossible to determine. As a result,
1027 * no vendor actually implemented that behavior. The 4.20
1028 * behavior matches the implemented behavior of at least one other
1029 * vendor, so we'll implement that for all GLSL versions.
1030 */
1031 if (var->constant_initializer != NULL) {
1032 if (existing->constant_initializer != NULL) {
1033 if (!var->constant_initializer->has_value(existing->constant_initializer)) {
1034 linker_error(prog, "initializers for %s "
1035 "`%s' have differing values\n",
1036 mode_string(var), var->name);
1037 return;
1038 }
1039 } else {
1040 /* If the first-seen instance of a particular uniform did
1041 * not have an initializer but a later instance does,
1042 * replace the former with the later.
1043 */
1044 variables->replace_variable(existing->name, var);
1045 }
1046 }
1047
1048 if (var->data.has_initializer) {
1049 if (existing->data.has_initializer
1050 && (var->constant_initializer == NULL
1051 || existing->constant_initializer == NULL)) {
1052 linker_error(prog,
1053 "shared global variable `%s' has multiple "
1054 "non-constant initializers.\n",
1055 var->name);
1056 return;
1057 }
1058 }
1059
1060 if (existing->data.invariant != var->data.invariant) {
1061 linker_error(prog, "declarations for %s `%s' have "
1062 "mismatching invariant qualifiers\n",
1063 mode_string(var), var->name);
1064 return;
1065 }
1066 if (existing->data.centroid != var->data.centroid) {
1067 linker_error(prog, "declarations for %s `%s' have "
1068 "mismatching centroid qualifiers\n",
1069 mode_string(var), var->name);
1070 return;
1071 }
1072 if (existing->data.sample != var->data.sample) {
1073 linker_error(prog, "declarations for %s `%s` have "
1074 "mismatching sample qualifiers\n",
1075 mode_string(var), var->name);
1076 return;
1077 }
1078 if (existing->data.image_format != var->data.image_format) {
1079 linker_error(prog, "declarations for %s `%s` have "
1080 "mismatching image format qualifiers\n",
1081 mode_string(var), var->name);
1082 return;
1083 }
1084
1085 /* Only in GLSL ES 3.10, the precision qualifier should not match
1086 * between block members defined in matched block names within a
1087 * shader interface.
1088 *
1089 * In GLSL ES 3.00 and ES 3.20, precision qualifier for each block
1090 * member should match.
1091 */
1092 if (prog->IsES && (prog->data->Version != 310 ||
1093 !var->get_interface_type()) &&
1094 existing->data.precision != var->data.precision) {
1095 linker_error(prog, "declarations for %s `%s` have "
1096 "mismatching precision qualifiers\n",
1097 mode_string(var), var->name);
1098 return;
1099 }
1100 } else
1101 variables->add_variable(var);
1102 }
1103 }
1104
1105
1106 /**
1107 * Perform validation of uniforms used across multiple shader stages
1108 */
1109 void
1110 cross_validate_uniforms(struct gl_shader_program *prog)
1111 {
1112 glsl_symbol_table variables;
1113 for (unsigned i = 0; i < MESA_SHADER_STAGES; i++) {
1114 if (prog->_LinkedShaders[i] == NULL)
1115 continue;
1116
1117 cross_validate_globals(prog, prog->_LinkedShaders[i]->ir, &variables,
1118 true);
1119 }
1120 }
1121
1122 /**
1123 * Accumulates the array of buffer blocks and checks that all definitions of
1124 * blocks agree on their contents.
1125 */
1126 static bool
1127 interstage_cross_validate_uniform_blocks(struct gl_shader_program *prog,
1128 bool validate_ssbo)
1129 {
1130 int *InterfaceBlockStageIndex[MESA_SHADER_STAGES];
1131 struct gl_uniform_block *blks = NULL;
1132 unsigned *num_blks = validate_ssbo ? &prog->data->NumShaderStorageBlocks :
1133 &prog->data->NumUniformBlocks;
1134
1135 unsigned max_num_buffer_blocks = 0;
1136 for (unsigned i = 0; i < MESA_SHADER_STAGES; i++) {
1137 if (prog->_LinkedShaders[i]) {
1138 if (validate_ssbo) {
1139 max_num_buffer_blocks +=
1140 prog->_LinkedShaders[i]->Program->info.num_ssbos;
1141 } else {
1142 max_num_buffer_blocks +=
1143 prog->_LinkedShaders[i]->Program->info.num_ubos;
1144 }
1145 }
1146 }
1147
1148 for (unsigned i = 0; i < MESA_SHADER_STAGES; i++) {
1149 struct gl_linked_shader *sh = prog->_LinkedShaders[i];
1150
1151 InterfaceBlockStageIndex[i] = new int[max_num_buffer_blocks];
1152 for (unsigned int j = 0; j < max_num_buffer_blocks; j++)
1153 InterfaceBlockStageIndex[i][j] = -1;
1154
1155 if (sh == NULL)
1156 continue;
1157
1158 unsigned sh_num_blocks;
1159 struct gl_uniform_block **sh_blks;
1160 if (validate_ssbo) {
1161 sh_num_blocks = prog->_LinkedShaders[i]->Program->info.num_ssbos;
1162 sh_blks = sh->Program->sh.ShaderStorageBlocks;
1163 } else {
1164 sh_num_blocks = prog->_LinkedShaders[i]->Program->info.num_ubos;
1165 sh_blks = sh->Program->sh.UniformBlocks;
1166 }
1167
1168 for (unsigned int j = 0; j < sh_num_blocks; j++) {
1169 int index = link_cross_validate_uniform_block(prog, &blks, num_blks,
1170 sh_blks[j]);
1171
1172 if (index == -1) {
1173 linker_error(prog, "buffer block `%s' has mismatching "
1174 "definitions\n", sh_blks[j]->Name);
1175
1176 for (unsigned k = 0; k <= i; k++) {
1177 delete[] InterfaceBlockStageIndex[k];
1178 }
1179 return false;
1180 }
1181
1182 InterfaceBlockStageIndex[i][index] = j;
1183 }
1184 }
1185
1186 /* Update per stage block pointers to point to the program list.
1187 * FIXME: We should be able to free the per stage blocks here.
1188 */
1189 for (unsigned i = 0; i < MESA_SHADER_STAGES; i++) {
1190 for (unsigned j = 0; j < *num_blks; j++) {
1191 int stage_index = InterfaceBlockStageIndex[i][j];
1192
1193 if (stage_index != -1) {
1194 struct gl_linked_shader *sh = prog->_LinkedShaders[i];
1195
1196 struct gl_uniform_block **sh_blks = validate_ssbo ?
1197 sh->Program->sh.ShaderStorageBlocks :
1198 sh->Program->sh.UniformBlocks;
1199
1200 blks[j].stageref |= sh_blks[stage_index]->stageref;
1201 sh_blks[stage_index] = &blks[j];
1202 }
1203 }
1204 }
1205
1206 for (unsigned i = 0; i < MESA_SHADER_STAGES; i++) {
1207 delete[] InterfaceBlockStageIndex[i];
1208 }
1209
1210 if (validate_ssbo)
1211 prog->data->ShaderStorageBlocks = blks;
1212 else
1213 prog->data->UniformBlocks = blks;
1214
1215 return true;
1216 }
1217
1218
1219 /**
1220 * Populates a shaders symbol table with all global declarations
1221 */
1222 static void
1223 populate_symbol_table(gl_linked_shader *sh)
1224 {
1225 sh->symbols = new(sh) glsl_symbol_table;
1226
1227 foreach_in_list(ir_instruction, inst, sh->ir) {
1228 ir_variable *var;
1229 ir_function *func;
1230
1231 if ((func = inst->as_function()) != NULL) {
1232 sh->symbols->add_function(func);
1233 } else if ((var = inst->as_variable()) != NULL) {
1234 if (var->data.mode != ir_var_temporary)
1235 sh->symbols->add_variable(var);
1236 }
1237 }
1238 }
1239
1240
1241 /**
1242 * Remap variables referenced in an instruction tree
1243 *
1244 * This is used when instruction trees are cloned from one shader and placed in
1245 * another. These trees will contain references to \c ir_variable nodes that
1246 * do not exist in the target shader. This function finds these \c ir_variable
1247 * references and replaces the references with matching variables in the target
1248 * shader.
1249 *
1250 * If there is no matching variable in the target shader, a clone of the
1251 * \c ir_variable is made and added to the target shader. The new variable is
1252 * added to \b both the instruction stream and the symbol table.
1253 *
1254 * \param inst IR tree that is to be processed.
1255 * \param symbols Symbol table containing global scope symbols in the
1256 * linked shader.
1257 * \param instructions Instruction stream where new variable declarations
1258 * should be added.
1259 */
1260 void
1261 remap_variables(ir_instruction *inst, struct gl_linked_shader *target,
1262 hash_table *temps)
1263 {
1264 class remap_visitor : public ir_hierarchical_visitor {
1265 public:
1266 remap_visitor(struct gl_linked_shader *target, hash_table *temps)
1267 {
1268 this->target = target;
1269 this->symbols = target->symbols;
1270 this->instructions = target->ir;
1271 this->temps = temps;
1272 }
1273
1274 virtual ir_visitor_status visit(ir_dereference_variable *ir)
1275 {
1276 if (ir->var->data.mode == ir_var_temporary) {
1277 hash_entry *entry = _mesa_hash_table_search(temps, ir->var);
1278 ir_variable *var = entry ? (ir_variable *) entry->data : NULL;
1279
1280 assert(var != NULL);
1281 ir->var = var;
1282 return visit_continue;
1283 }
1284
1285 ir_variable *const existing =
1286 this->symbols->get_variable(ir->var->name);
1287 if (existing != NULL)
1288 ir->var = existing;
1289 else {
1290 ir_variable *copy = ir->var->clone(this->target, NULL);
1291
1292 this->symbols->add_variable(copy);
1293 this->instructions->push_head(copy);
1294 ir->var = copy;
1295 }
1296
1297 return visit_continue;
1298 }
1299
1300 private:
1301 struct gl_linked_shader *target;
1302 glsl_symbol_table *symbols;
1303 exec_list *instructions;
1304 hash_table *temps;
1305 };
1306
1307 remap_visitor v(target, temps);
1308
1309 inst->accept(&v);
1310 }
1311
1312
1313 /**
1314 * Move non-declarations from one instruction stream to another
1315 *
1316 * The intended usage pattern of this function is to pass the pointer to the
1317 * head sentinel of a list (i.e., a pointer to the list cast to an \c exec_node
1318 * pointer) for \c last and \c false for \c make_copies on the first
1319 * call. Successive calls pass the return value of the previous call for
1320 * \c last and \c true for \c make_copies.
1321 *
1322 * \param instructions Source instruction stream
1323 * \param last Instruction after which new instructions should be
1324 * inserted in the target instruction stream
1325 * \param make_copies Flag selecting whether instructions in \c instructions
1326 * should be copied (via \c ir_instruction::clone) into the
1327 * target list or moved.
1328 *
1329 * \return
1330 * The new "last" instruction in the target instruction stream. This pointer
1331 * is suitable for use as the \c last parameter of a later call to this
1332 * function.
1333 */
1334 exec_node *
1335 move_non_declarations(exec_list *instructions, exec_node *last,
1336 bool make_copies, gl_linked_shader *target)
1337 {
1338 hash_table *temps = NULL;
1339
1340 if (make_copies)
1341 temps = _mesa_hash_table_create(NULL, _mesa_hash_pointer,
1342 _mesa_key_pointer_equal);
1343
1344 foreach_in_list_safe(ir_instruction, inst, instructions) {
1345 if (inst->as_function())
1346 continue;
1347
1348 ir_variable *var = inst->as_variable();
1349 if ((var != NULL) && (var->data.mode != ir_var_temporary))
1350 continue;
1351
1352 assert(inst->as_assignment()
1353 || inst->as_call()
1354 || inst->as_if() /* for initializers with the ?: operator */
1355 || ((var != NULL) && (var->data.mode == ir_var_temporary)));
1356
1357 if (make_copies) {
1358 inst = inst->clone(target, NULL);
1359
1360 if (var != NULL)
1361 _mesa_hash_table_insert(temps, var, inst);
1362 else
1363 remap_variables(inst, target, temps);
1364 } else {
1365 inst->remove();
1366 }
1367
1368 last->insert_after(inst);
1369 last = inst;
1370 }
1371
1372 if (make_copies)
1373 _mesa_hash_table_destroy(temps, NULL);
1374
1375 return last;
1376 }
1377
1378
1379 /**
1380 * This class is only used in link_intrastage_shaders() below but declaring
1381 * it inside that function leads to compiler warnings with some versions of
1382 * gcc.
1383 */
1384 class array_sizing_visitor : public deref_type_updater {
1385 public:
1386 array_sizing_visitor()
1387 : mem_ctx(ralloc_context(NULL)),
1388 unnamed_interfaces(_mesa_hash_table_create(NULL, _mesa_hash_pointer,
1389 _mesa_key_pointer_equal))
1390 {
1391 }
1392
1393 ~array_sizing_visitor()
1394 {
1395 _mesa_hash_table_destroy(this->unnamed_interfaces, NULL);
1396 ralloc_free(this->mem_ctx);
1397 }
1398
1399 virtual ir_visitor_status visit(ir_variable *var)
1400 {
1401 const glsl_type *type_without_array;
1402 bool implicit_sized_array = var->data.implicit_sized_array;
1403 fixup_type(&var->type, var->data.max_array_access,
1404 var->data.from_ssbo_unsized_array,
1405 &implicit_sized_array);
1406 var->data.implicit_sized_array = implicit_sized_array;
1407 type_without_array = var->type->without_array();
1408 if (var->type->is_interface()) {
1409 if (interface_contains_unsized_arrays(var->type)) {
1410 const glsl_type *new_type =
1411 resize_interface_members(var->type,
1412 var->get_max_ifc_array_access(),
1413 var->is_in_shader_storage_block());
1414 var->type = new_type;
1415 var->change_interface_type(new_type);
1416 }
1417 } else if (type_without_array->is_interface()) {
1418 if (interface_contains_unsized_arrays(type_without_array)) {
1419 const glsl_type *new_type =
1420 resize_interface_members(type_without_array,
1421 var->get_max_ifc_array_access(),
1422 var->is_in_shader_storage_block());
1423 var->change_interface_type(new_type);
1424 var->type = update_interface_members_array(var->type, new_type);
1425 }
1426 } else if (const glsl_type *ifc_type = var->get_interface_type()) {
1427 /* Store a pointer to the variable in the unnamed_interfaces
1428 * hashtable.
1429 */
1430 hash_entry *entry =
1431 _mesa_hash_table_search(this->unnamed_interfaces,
1432 ifc_type);
1433
1434 ir_variable **interface_vars = entry ? (ir_variable **) entry->data : NULL;
1435
1436 if (interface_vars == NULL) {
1437 interface_vars = rzalloc_array(mem_ctx, ir_variable *,
1438 ifc_type->length);
1439 _mesa_hash_table_insert(this->unnamed_interfaces, ifc_type,
1440 interface_vars);
1441 }
1442 unsigned index = ifc_type->field_index(var->name);
1443 assert(index < ifc_type->length);
1444 assert(interface_vars[index] == NULL);
1445 interface_vars[index] = var;
1446 }
1447 return visit_continue;
1448 }
1449
1450 /**
1451 * For each unnamed interface block that was discovered while running the
1452 * visitor, adjust the interface type to reflect the newly assigned array
1453 * sizes, and fix up the ir_variable nodes to point to the new interface
1454 * type.
1455 */
1456 void fixup_unnamed_interface_types()
1457 {
1458 hash_table_call_foreach(this->unnamed_interfaces,
1459 fixup_unnamed_interface_type, NULL);
1460 }
1461
1462 private:
1463 /**
1464 * If the type pointed to by \c type represents an unsized array, replace
1465 * it with a sized array whose size is determined by max_array_access.
1466 */
1467 static void fixup_type(const glsl_type **type, unsigned max_array_access,
1468 bool from_ssbo_unsized_array, bool *implicit_sized)
1469 {
1470 if (!from_ssbo_unsized_array && (*type)->is_unsized_array()) {
1471 *type = glsl_type::get_array_instance((*type)->fields.array,
1472 max_array_access + 1);
1473 *implicit_sized = true;
1474 assert(*type != NULL);
1475 }
1476 }
1477
1478 static const glsl_type *
1479 update_interface_members_array(const glsl_type *type,
1480 const glsl_type *new_interface_type)
1481 {
1482 const glsl_type *element_type = type->fields.array;
1483 if (element_type->is_array()) {
1484 const glsl_type *new_array_type =
1485 update_interface_members_array(element_type, new_interface_type);
1486 return glsl_type::get_array_instance(new_array_type, type->length);
1487 } else {
1488 return glsl_type::get_array_instance(new_interface_type,
1489 type->length);
1490 }
1491 }
1492
1493 /**
1494 * Determine whether the given interface type contains unsized arrays (if
1495 * it doesn't, array_sizing_visitor doesn't need to process it).
1496 */
1497 static bool interface_contains_unsized_arrays(const glsl_type *type)
1498 {
1499 for (unsigned i = 0; i < type->length; i++) {
1500 const glsl_type *elem_type = type->fields.structure[i].type;
1501 if (elem_type->is_unsized_array())
1502 return true;
1503 }
1504 return false;
1505 }
1506
1507 /**
1508 * Create a new interface type based on the given type, with unsized arrays
1509 * replaced by sized arrays whose size is determined by
1510 * max_ifc_array_access.
1511 */
1512 static const glsl_type *
1513 resize_interface_members(const glsl_type *type,
1514 const int *max_ifc_array_access,
1515 bool is_ssbo)
1516 {
1517 unsigned num_fields = type->length;
1518 glsl_struct_field *fields = new glsl_struct_field[num_fields];
1519 memcpy(fields, type->fields.structure,
1520 num_fields * sizeof(*fields));
1521 for (unsigned i = 0; i < num_fields; i++) {
1522 bool implicit_sized_array = fields[i].implicit_sized_array;
1523 /* If SSBO last member is unsized array, we don't replace it by a sized
1524 * array.
1525 */
1526 if (is_ssbo && i == (num_fields - 1))
1527 fixup_type(&fields[i].type, max_ifc_array_access[i],
1528 true, &implicit_sized_array);
1529 else
1530 fixup_type(&fields[i].type, max_ifc_array_access[i],
1531 false, &implicit_sized_array);
1532 fields[i].implicit_sized_array = implicit_sized_array;
1533 }
1534 glsl_interface_packing packing =
1535 (glsl_interface_packing) type->interface_packing;
1536 bool row_major = (bool) type->interface_row_major;
1537 const glsl_type *new_ifc_type =
1538 glsl_type::get_interface_instance(fields, num_fields,
1539 packing, row_major, type->name);
1540 delete [] fields;
1541 return new_ifc_type;
1542 }
1543
1544 static void fixup_unnamed_interface_type(const void *key, void *data,
1545 void *)
1546 {
1547 const glsl_type *ifc_type = (const glsl_type *) key;
1548 ir_variable **interface_vars = (ir_variable **) data;
1549 unsigned num_fields = ifc_type->length;
1550 glsl_struct_field *fields = new glsl_struct_field[num_fields];
1551 memcpy(fields, ifc_type->fields.structure,
1552 num_fields * sizeof(*fields));
1553 bool interface_type_changed = false;
1554 for (unsigned i = 0; i < num_fields; i++) {
1555 if (interface_vars[i] != NULL &&
1556 fields[i].type != interface_vars[i]->type) {
1557 fields[i].type = interface_vars[i]->type;
1558 interface_type_changed = true;
1559 }
1560 }
1561 if (!interface_type_changed) {
1562 delete [] fields;
1563 return;
1564 }
1565 glsl_interface_packing packing =
1566 (glsl_interface_packing) ifc_type->interface_packing;
1567 bool row_major = (bool) ifc_type->interface_row_major;
1568 const glsl_type *new_ifc_type =
1569 glsl_type::get_interface_instance(fields, num_fields, packing,
1570 row_major, ifc_type->name);
1571 delete [] fields;
1572 for (unsigned i = 0; i < num_fields; i++) {
1573 if (interface_vars[i] != NULL)
1574 interface_vars[i]->change_interface_type(new_ifc_type);
1575 }
1576 }
1577
1578 /**
1579 * Memory context used to allocate the data in \c unnamed_interfaces.
1580 */
1581 void *mem_ctx;
1582
1583 /**
1584 * Hash table from const glsl_type * to an array of ir_variable *'s
1585 * pointing to the ir_variables constituting each unnamed interface block.
1586 */
1587 hash_table *unnamed_interfaces;
1588 };
1589
1590 /**
1591 * Check for conflicting xfb_stride default qualifiers and store buffer stride
1592 * for later use.
1593 */
1594 static void
1595 link_xfb_stride_layout_qualifiers(struct gl_context *ctx,
1596 struct gl_shader_program *prog,
1597 struct gl_linked_shader *linked_shader,
1598 struct gl_shader **shader_list,
1599 unsigned num_shaders)
1600 {
1601 for (unsigned i = 0; i < MAX_FEEDBACK_BUFFERS; i++) {
1602 linked_shader->info.TransformFeedback.BufferStride[i] = 0;
1603 }
1604
1605 for (unsigned i = 0; i < num_shaders; i++) {
1606 struct gl_shader *shader = shader_list[i];
1607
1608 for (unsigned j = 0; j < MAX_FEEDBACK_BUFFERS; j++) {
1609 if (shader->info.TransformFeedback.BufferStride[j]) {
1610 if (linked_shader->info.TransformFeedback.BufferStride[j] != 0 &&
1611 shader->info.TransformFeedback.BufferStride[j] != 0 &&
1612 linked_shader->info.TransformFeedback.BufferStride[j] !=
1613 shader->info.TransformFeedback.BufferStride[j]) {
1614 linker_error(prog,
1615 "intrastage shaders defined with conflicting "
1616 "xfb_stride for buffer %d (%d and %d)\n", j,
1617 linked_shader->
1618 info.TransformFeedback.BufferStride[j],
1619 shader->info.TransformFeedback.BufferStride[j]);
1620 return;
1621 }
1622
1623 if (shader->info.TransformFeedback.BufferStride[j])
1624 linked_shader->info.TransformFeedback.BufferStride[j] =
1625 shader->info.TransformFeedback.BufferStride[j];
1626 }
1627 }
1628 }
1629
1630 for (unsigned j = 0; j < MAX_FEEDBACK_BUFFERS; j++) {
1631 if (linked_shader->info.TransformFeedback.BufferStride[j]) {
1632 prog->TransformFeedback.BufferStride[j] =
1633 linked_shader->info.TransformFeedback.BufferStride[j];
1634
1635 /* We will validate doubles at a later stage */
1636 if (prog->TransformFeedback.BufferStride[j] % 4) {
1637 linker_error(prog, "invalid qualifier xfb_stride=%d must be a "
1638 "multiple of 4 or if its applied to a type that is "
1639 "or contains a double a multiple of 8.",
1640 prog->TransformFeedback.BufferStride[j]);
1641 return;
1642 }
1643
1644 if (prog->TransformFeedback.BufferStride[j] / 4 >
1645 ctx->Const.MaxTransformFeedbackInterleavedComponents) {
1646 linker_error(prog,
1647 "The MAX_TRANSFORM_FEEDBACK_INTERLEAVED_COMPONENTS "
1648 "limit has been exceeded.");
1649 return;
1650 }
1651 }
1652 }
1653 }
1654
1655 /**
1656 * Performs the cross-validation of tessellation control shader vertices and
1657 * layout qualifiers for the attached tessellation control shaders,
1658 * and propagates them to the linked TCS and linked shader program.
1659 */
1660 static void
1661 link_tcs_out_layout_qualifiers(struct gl_shader_program *prog,
1662 struct gl_program *gl_prog,
1663 struct gl_shader **shader_list,
1664 unsigned num_shaders)
1665 {
1666 if (gl_prog->info.stage != MESA_SHADER_TESS_CTRL)
1667 return;
1668
1669 gl_prog->info.tess.tcs_vertices_out = 0;
1670
1671 /* From the GLSL 4.0 spec (chapter 4.3.8.2):
1672 *
1673 * "All tessellation control shader layout declarations in a program
1674 * must specify the same output patch vertex count. There must be at
1675 * least one layout qualifier specifying an output patch vertex count
1676 * in any program containing tessellation control shaders; however,
1677 * such a declaration is not required in all tessellation control
1678 * shaders."
1679 */
1680
1681 for (unsigned i = 0; i < num_shaders; i++) {
1682 struct gl_shader *shader = shader_list[i];
1683
1684 if (shader->info.TessCtrl.VerticesOut != 0) {
1685 if (gl_prog->info.tess.tcs_vertices_out != 0 &&
1686 gl_prog->info.tess.tcs_vertices_out !=
1687 (unsigned) shader->info.TessCtrl.VerticesOut) {
1688 linker_error(prog, "tessellation control shader defined with "
1689 "conflicting output vertex count (%d and %d)\n",
1690 gl_prog->info.tess.tcs_vertices_out,
1691 shader->info.TessCtrl.VerticesOut);
1692 return;
1693 }
1694 gl_prog->info.tess.tcs_vertices_out =
1695 shader->info.TessCtrl.VerticesOut;
1696 }
1697 }
1698
1699 /* Just do the intrastage -> interstage propagation right now,
1700 * since we already know we're in the right type of shader program
1701 * for doing it.
1702 */
1703 if (gl_prog->info.tess.tcs_vertices_out == 0) {
1704 linker_error(prog, "tessellation control shader didn't declare "
1705 "vertices out layout qualifier\n");
1706 return;
1707 }
1708 }
1709
1710
1711 /**
1712 * Performs the cross-validation of tessellation evaluation shader
1713 * primitive type, vertex spacing, ordering and point_mode layout qualifiers
1714 * for the attached tessellation evaluation shaders, and propagates them
1715 * to the linked TES and linked shader program.
1716 */
1717 static void
1718 link_tes_in_layout_qualifiers(struct gl_shader_program *prog,
1719 struct gl_linked_shader *linked_shader,
1720 struct gl_shader **shader_list,
1721 unsigned num_shaders)
1722 {
1723 linked_shader->info.TessEval.PrimitiveMode = PRIM_UNKNOWN;
1724 linked_shader->info.TessEval.Spacing = TESS_SPACING_UNSPECIFIED;
1725 linked_shader->info.TessEval.VertexOrder = 0;
1726 linked_shader->info.TessEval.PointMode = -1;
1727
1728 if (linked_shader->Stage != MESA_SHADER_TESS_EVAL)
1729 return;
1730
1731 /* From the GLSL 4.0 spec (chapter 4.3.8.1):
1732 *
1733 * "At least one tessellation evaluation shader (compilation unit) in
1734 * a program must declare a primitive mode in its input layout.
1735 * Declaration vertex spacing, ordering, and point mode identifiers is
1736 * optional. It is not required that all tessellation evaluation
1737 * shaders in a program declare a primitive mode. If spacing or
1738 * vertex ordering declarations are omitted, the tessellation
1739 * primitive generator will use equal spacing or counter-clockwise
1740 * vertex ordering, respectively. If a point mode declaration is
1741 * omitted, the tessellation primitive generator will produce lines or
1742 * triangles according to the primitive mode."
1743 */
1744
1745 for (unsigned i = 0; i < num_shaders; i++) {
1746 struct gl_shader *shader = shader_list[i];
1747
1748 if (shader->info.TessEval.PrimitiveMode != PRIM_UNKNOWN) {
1749 if (linked_shader->info.TessEval.PrimitiveMode != PRIM_UNKNOWN &&
1750 linked_shader->info.TessEval.PrimitiveMode !=
1751 shader->info.TessEval.PrimitiveMode) {
1752 linker_error(prog, "tessellation evaluation shader defined with "
1753 "conflicting input primitive modes.\n");
1754 return;
1755 }
1756 linked_shader->info.TessEval.PrimitiveMode = shader->info.TessEval.PrimitiveMode;
1757 }
1758
1759 if (shader->info.TessEval.Spacing != 0) {
1760 if (linked_shader->info.TessEval.Spacing != 0 &&
1761 linked_shader->info.TessEval.Spacing !=
1762 shader->info.TessEval.Spacing) {
1763 linker_error(prog, "tessellation evaluation shader defined with "
1764 "conflicting vertex spacing.\n");
1765 return;
1766 }
1767 linked_shader->info.TessEval.Spacing = shader->info.TessEval.Spacing;
1768 }
1769
1770 if (shader->info.TessEval.VertexOrder != 0) {
1771 if (linked_shader->info.TessEval.VertexOrder != 0 &&
1772 linked_shader->info.TessEval.VertexOrder !=
1773 shader->info.TessEval.VertexOrder) {
1774 linker_error(prog, "tessellation evaluation shader defined with "
1775 "conflicting ordering.\n");
1776 return;
1777 }
1778 linked_shader->info.TessEval.VertexOrder =
1779 shader->info.TessEval.VertexOrder;
1780 }
1781
1782 if (shader->info.TessEval.PointMode != -1) {
1783 if (linked_shader->info.TessEval.PointMode != -1 &&
1784 linked_shader->info.TessEval.PointMode !=
1785 shader->info.TessEval.PointMode) {
1786 linker_error(prog, "tessellation evaluation shader defined with "
1787 "conflicting point modes.\n");
1788 return;
1789 }
1790 linked_shader->info.TessEval.PointMode =
1791 shader->info.TessEval.PointMode;
1792 }
1793
1794 }
1795
1796 /* Just do the intrastage -> interstage propagation right now,
1797 * since we already know we're in the right type of shader program
1798 * for doing it.
1799 */
1800 if (linked_shader->info.TessEval.PrimitiveMode == PRIM_UNKNOWN) {
1801 linker_error(prog,
1802 "tessellation evaluation shader didn't declare input "
1803 "primitive modes.\n");
1804 return;
1805 }
1806
1807 if (linked_shader->info.TessEval.Spacing == TESS_SPACING_UNSPECIFIED)
1808 linked_shader->info.TessEval.Spacing = TESS_SPACING_EQUAL;
1809
1810 if (linked_shader->info.TessEval.VertexOrder == 0)
1811 linked_shader->info.TessEval.VertexOrder = GL_CCW;
1812
1813 if (linked_shader->info.TessEval.PointMode == -1)
1814 linked_shader->info.TessEval.PointMode = GL_FALSE;
1815 }
1816
1817
1818 /**
1819 * Performs the cross-validation of layout qualifiers specified in
1820 * redeclaration of gl_FragCoord for the attached fragment shaders,
1821 * and propagates them to the linked FS and linked shader program.
1822 */
1823 static void
1824 link_fs_inout_layout_qualifiers(struct gl_shader_program *prog,
1825 struct gl_linked_shader *linked_shader,
1826 struct gl_shader **shader_list,
1827 unsigned num_shaders)
1828 {
1829 bool redeclares_gl_fragcoord = false;
1830 bool uses_gl_fragcoord = false;
1831 linked_shader->info.origin_upper_left = false;
1832 linked_shader->info.pixel_center_integer = false;
1833
1834 if (linked_shader->Stage != MESA_SHADER_FRAGMENT ||
1835 (prog->data->Version < 150 &&
1836 !prog->ARB_fragment_coord_conventions_enable))
1837 return;
1838
1839 for (unsigned i = 0; i < num_shaders; i++) {
1840 struct gl_shader *shader = shader_list[i];
1841 /* From the GLSL 1.50 spec, page 39:
1842 *
1843 * "If gl_FragCoord is redeclared in any fragment shader in a program,
1844 * it must be redeclared in all the fragment shaders in that program
1845 * that have a static use gl_FragCoord."
1846 */
1847 if ((redeclares_gl_fragcoord && !shader->redeclares_gl_fragcoord &&
1848 shader->uses_gl_fragcoord)
1849 || (shader->redeclares_gl_fragcoord && !redeclares_gl_fragcoord &&
1850 uses_gl_fragcoord)) {
1851 linker_error(prog, "fragment shader defined with conflicting "
1852 "layout qualifiers for gl_FragCoord\n");
1853 }
1854
1855 /* From the GLSL 1.50 spec, page 39:
1856 *
1857 * "All redeclarations of gl_FragCoord in all fragment shaders in a
1858 * single program must have the same set of qualifiers."
1859 */
1860 if (redeclares_gl_fragcoord && shader->redeclares_gl_fragcoord &&
1861 (shader->info.origin_upper_left !=
1862 linked_shader->info.origin_upper_left ||
1863 shader->info.pixel_center_integer !=
1864 linked_shader->info.pixel_center_integer)) {
1865 linker_error(prog, "fragment shader defined with conflicting "
1866 "layout qualifiers for gl_FragCoord\n");
1867 }
1868
1869 /* Update the linked shader state. Note that uses_gl_fragcoord should
1870 * accumulate the results. The other values should replace. If there
1871 * are multiple redeclarations, all the fields except uses_gl_fragcoord
1872 * are already known to be the same.
1873 */
1874 if (shader->redeclares_gl_fragcoord || shader->uses_gl_fragcoord) {
1875 redeclares_gl_fragcoord = shader->redeclares_gl_fragcoord;
1876 uses_gl_fragcoord |= shader->uses_gl_fragcoord;
1877 linked_shader->info.origin_upper_left =
1878 shader->info.origin_upper_left;
1879 linked_shader->info.pixel_center_integer =
1880 shader->info.pixel_center_integer;
1881 }
1882
1883 linked_shader->Program->info.fs.early_fragment_tests |=
1884 shader->EarlyFragmentTests;
1885 linked_shader->info.InnerCoverage |=
1886 shader->info.InnerCoverage;
1887 linked_shader->Program->info.fs.post_depth_coverage |=
1888 shader->info.PostDepthCoverage;
1889
1890 linked_shader->Program->sh.fs.BlendSupport |= shader->BlendSupport;
1891 }
1892 }
1893
1894 /**
1895 * Performs the cross-validation of geometry shader max_vertices and
1896 * primitive type layout qualifiers for the attached geometry shaders,
1897 * and propagates them to the linked GS and linked shader program.
1898 */
1899 static void
1900 link_gs_inout_layout_qualifiers(struct gl_shader_program *prog,
1901 struct gl_linked_shader *linked_shader,
1902 struct gl_shader **shader_list,
1903 unsigned num_shaders)
1904 {
1905 linked_shader->info.Geom.VerticesOut = -1;
1906 linked_shader->info.Geom.Invocations = 0;
1907 linked_shader->info.Geom.InputType = PRIM_UNKNOWN;
1908 linked_shader->info.Geom.OutputType = PRIM_UNKNOWN;
1909
1910 /* No in/out qualifiers defined for anything but GLSL 1.50+
1911 * geometry shaders so far.
1912 */
1913 if (linked_shader->Stage != MESA_SHADER_GEOMETRY ||
1914 prog->data->Version < 150)
1915 return;
1916
1917 /* From the GLSL 1.50 spec, page 46:
1918 *
1919 * "All geometry shader output layout declarations in a program
1920 * must declare the same layout and same value for
1921 * max_vertices. There must be at least one geometry output
1922 * layout declaration somewhere in a program, but not all
1923 * geometry shaders (compilation units) are required to
1924 * declare it."
1925 */
1926
1927 for (unsigned i = 0; i < num_shaders; i++) {
1928 struct gl_shader *shader = shader_list[i];
1929
1930 if (shader->info.Geom.InputType != PRIM_UNKNOWN) {
1931 if (linked_shader->info.Geom.InputType != PRIM_UNKNOWN &&
1932 linked_shader->info.Geom.InputType !=
1933 shader->info.Geom.InputType) {
1934 linker_error(prog, "geometry shader defined with conflicting "
1935 "input types\n");
1936 return;
1937 }
1938 linked_shader->info.Geom.InputType = shader->info.Geom.InputType;
1939 }
1940
1941 if (shader->info.Geom.OutputType != PRIM_UNKNOWN) {
1942 if (linked_shader->info.Geom.OutputType != PRIM_UNKNOWN &&
1943 linked_shader->info.Geom.OutputType !=
1944 shader->info.Geom.OutputType) {
1945 linker_error(prog, "geometry shader defined with conflicting "
1946 "output types\n");
1947 return;
1948 }
1949 linked_shader->info.Geom.OutputType = shader->info.Geom.OutputType;
1950 }
1951
1952 if (shader->info.Geom.VerticesOut != -1) {
1953 if (linked_shader->info.Geom.VerticesOut != -1 &&
1954 linked_shader->info.Geom.VerticesOut !=
1955 shader->info.Geom.VerticesOut) {
1956 linker_error(prog, "geometry shader defined with conflicting "
1957 "output vertex count (%d and %d)\n",
1958 linked_shader->info.Geom.VerticesOut,
1959 shader->info.Geom.VerticesOut);
1960 return;
1961 }
1962 linked_shader->info.Geom.VerticesOut = shader->info.Geom.VerticesOut;
1963 }
1964
1965 if (shader->info.Geom.Invocations != 0) {
1966 if (linked_shader->info.Geom.Invocations != 0 &&
1967 linked_shader->info.Geom.Invocations !=
1968 shader->info.Geom.Invocations) {
1969 linker_error(prog, "geometry shader defined with conflicting "
1970 "invocation count (%d and %d)\n",
1971 linked_shader->info.Geom.Invocations,
1972 shader->info.Geom.Invocations);
1973 return;
1974 }
1975 linked_shader->info.Geom.Invocations = shader->info.Geom.Invocations;
1976 }
1977 }
1978
1979 /* Just do the intrastage -> interstage propagation right now,
1980 * since we already know we're in the right type of shader program
1981 * for doing it.
1982 */
1983 if (linked_shader->info.Geom.InputType == PRIM_UNKNOWN) {
1984 linker_error(prog,
1985 "geometry shader didn't declare primitive input type\n");
1986 return;
1987 }
1988
1989 if (linked_shader->info.Geom.OutputType == PRIM_UNKNOWN) {
1990 linker_error(prog,
1991 "geometry shader didn't declare primitive output type\n");
1992 return;
1993 }
1994
1995 if (linked_shader->info.Geom.VerticesOut == -1) {
1996 linker_error(prog,
1997 "geometry shader didn't declare max_vertices\n");
1998 return;
1999 }
2000
2001 if (linked_shader->info.Geom.Invocations == 0)
2002 linked_shader->info.Geom.Invocations = 1;
2003 }
2004
2005
2006 /**
2007 * Perform cross-validation of compute shader local_size_{x,y,z} layout
2008 * qualifiers for the attached compute shaders, and propagate them to the
2009 * linked CS and linked shader program.
2010 */
2011 static void
2012 link_cs_input_layout_qualifiers(struct gl_shader_program *prog,
2013 struct gl_linked_shader *linked_shader,
2014 struct gl_shader **shader_list,
2015 unsigned num_shaders)
2016 {
2017 for (int i = 0; i < 3; i++)
2018 linked_shader->info.Comp.LocalSize[i] = 0;
2019
2020 linked_shader->info.Comp.LocalSizeVariable = false;
2021
2022 /* This function is called for all shader stages, but it only has an effect
2023 * for compute shaders.
2024 */
2025 if (linked_shader->Stage != MESA_SHADER_COMPUTE)
2026 return;
2027
2028 /* From the ARB_compute_shader spec, in the section describing local size
2029 * declarations:
2030 *
2031 * If multiple compute shaders attached to a single program object
2032 * declare local work-group size, the declarations must be identical;
2033 * otherwise a link-time error results. Furthermore, if a program
2034 * object contains any compute shaders, at least one must contain an
2035 * input layout qualifier specifying the local work sizes of the
2036 * program, or a link-time error will occur.
2037 */
2038 for (unsigned sh = 0; sh < num_shaders; sh++) {
2039 struct gl_shader *shader = shader_list[sh];
2040
2041 if (shader->info.Comp.LocalSize[0] != 0) {
2042 if (linked_shader->info.Comp.LocalSize[0] != 0) {
2043 for (int i = 0; i < 3; i++) {
2044 if (linked_shader->info.Comp.LocalSize[i] !=
2045 shader->info.Comp.LocalSize[i]) {
2046 linker_error(prog, "compute shader defined with conflicting "
2047 "local sizes\n");
2048 return;
2049 }
2050 }
2051 }
2052 for (int i = 0; i < 3; i++) {
2053 linked_shader->info.Comp.LocalSize[i] =
2054 shader->info.Comp.LocalSize[i];
2055 }
2056 } else if (shader->info.Comp.LocalSizeVariable) {
2057 if (linked_shader->info.Comp.LocalSize[0] != 0) {
2058 /* The ARB_compute_variable_group_size spec says:
2059 *
2060 * If one compute shader attached to a program declares a
2061 * variable local group size and a second compute shader
2062 * attached to the same program declares a fixed local group
2063 * size, a link-time error results.
2064 */
2065 linker_error(prog, "compute shader defined with both fixed and "
2066 "variable local group size\n");
2067 return;
2068 }
2069 linked_shader->info.Comp.LocalSizeVariable = true;
2070 }
2071 }
2072
2073 /* Just do the intrastage -> interstage propagation right now,
2074 * since we already know we're in the right type of shader program
2075 * for doing it.
2076 */
2077 if (linked_shader->info.Comp.LocalSize[0] == 0 &&
2078 !linked_shader->info.Comp.LocalSizeVariable) {
2079 linker_error(prog, "compute shader must contain a fixed or a variable "
2080 "local group size\n");
2081 return;
2082 }
2083 for (int i = 0; i < 3; i++)
2084 prog->Comp.LocalSize[i] = linked_shader->info.Comp.LocalSize[i];
2085
2086 prog->Comp.LocalSizeVariable =
2087 linked_shader->info.Comp.LocalSizeVariable;
2088 }
2089
2090
2091 /**
2092 * Combine a group of shaders for a single stage to generate a linked shader
2093 *
2094 * \note
2095 * If this function is supplied a single shader, it is cloned, and the new
2096 * shader is returned.
2097 */
2098 struct gl_linked_shader *
2099 link_intrastage_shaders(void *mem_ctx,
2100 struct gl_context *ctx,
2101 struct gl_shader_program *prog,
2102 struct gl_shader **shader_list,
2103 unsigned num_shaders,
2104 bool allow_missing_main)
2105 {
2106 struct gl_uniform_block *ubo_blocks = NULL;
2107 struct gl_uniform_block *ssbo_blocks = NULL;
2108 unsigned num_ubo_blocks = 0;
2109 unsigned num_ssbo_blocks = 0;
2110
2111 /* Check that global variables defined in multiple shaders are consistent.
2112 */
2113 glsl_symbol_table variables;
2114 for (unsigned i = 0; i < num_shaders; i++) {
2115 if (shader_list[i] == NULL)
2116 continue;
2117 cross_validate_globals(prog, shader_list[i]->ir, &variables, false);
2118 }
2119
2120 if (!prog->data->LinkStatus)
2121 return NULL;
2122
2123 /* Check that interface blocks defined in multiple shaders are consistent.
2124 */
2125 validate_intrastage_interface_blocks(prog, (const gl_shader **)shader_list,
2126 num_shaders);
2127 if (!prog->data->LinkStatus)
2128 return NULL;
2129
2130 /* Check that there is only a single definition of each function signature
2131 * across all shaders.
2132 */
2133 for (unsigned i = 0; i < (num_shaders - 1); i++) {
2134 foreach_in_list(ir_instruction, node, shader_list[i]->ir) {
2135 ir_function *const f = node->as_function();
2136
2137 if (f == NULL)
2138 continue;
2139
2140 for (unsigned j = i + 1; j < num_shaders; j++) {
2141 ir_function *const other =
2142 shader_list[j]->symbols->get_function(f->name);
2143
2144 /* If the other shader has no function (and therefore no function
2145 * signatures) with the same name, skip to the next shader.
2146 */
2147 if (other == NULL)
2148 continue;
2149
2150 foreach_in_list(ir_function_signature, sig, &f->signatures) {
2151 if (!sig->is_defined)
2152 continue;
2153
2154 ir_function_signature *other_sig =
2155 other->exact_matching_signature(NULL, &sig->parameters);
2156
2157 if (other_sig != NULL && other_sig->is_defined) {
2158 linker_error(prog, "function `%s' is multiply defined\n",
2159 f->name);
2160 return NULL;
2161 }
2162 }
2163 }
2164 }
2165 }
2166
2167 /* Find the shader that defines main, and make a clone of it.
2168 *
2169 * Starting with the clone, search for undefined references. If one is
2170 * found, find the shader that defines it. Clone the reference and add
2171 * it to the shader. Repeat until there are no undefined references or
2172 * until a reference cannot be resolved.
2173 */
2174 gl_shader *main = NULL;
2175 for (unsigned i = 0; i < num_shaders; i++) {
2176 if (_mesa_get_main_function_signature(shader_list[i]->symbols)) {
2177 main = shader_list[i];
2178 break;
2179 }
2180 }
2181
2182 if (main == NULL && allow_missing_main)
2183 main = shader_list[0];
2184
2185 if (main == NULL) {
2186 linker_error(prog, "%s shader lacks `main'\n",
2187 _mesa_shader_stage_to_string(shader_list[0]->Stage));
2188 return NULL;
2189 }
2190
2191 gl_linked_shader *linked = rzalloc(NULL, struct gl_linked_shader);
2192 linked->Stage = shader_list[0]->Stage;
2193
2194 /* Create program and attach it to the linked shader */
2195 struct gl_program *gl_prog =
2196 ctx->Driver.NewProgram(ctx,
2197 _mesa_shader_stage_to_program(shader_list[0]->Stage),
2198 prog->Name, false);
2199 if (!gl_prog) {
2200 prog->data->LinkStatus = false;
2201 _mesa_delete_linked_shader(ctx, linked);
2202 return NULL;
2203 }
2204
2205 _mesa_reference_shader_program_data(ctx, &gl_prog->sh.data, prog->data);
2206
2207 /* Don't use _mesa_reference_program() just take ownership */
2208 linked->Program = gl_prog;
2209
2210 linked->ir = new(linked) exec_list;
2211 clone_ir_list(mem_ctx, linked->ir, main->ir);
2212
2213 link_fs_inout_layout_qualifiers(prog, linked, shader_list, num_shaders);
2214 link_tcs_out_layout_qualifiers(prog, gl_prog, shader_list, num_shaders);
2215 link_tes_in_layout_qualifiers(prog, linked, shader_list, num_shaders);
2216 link_gs_inout_layout_qualifiers(prog, linked, shader_list, num_shaders);
2217 link_cs_input_layout_qualifiers(prog, linked, shader_list, num_shaders);
2218 link_xfb_stride_layout_qualifiers(ctx, prog, linked, shader_list,
2219 num_shaders);
2220
2221 populate_symbol_table(linked);
2222
2223 /* The pointer to the main function in the final linked shader (i.e., the
2224 * copy of the original shader that contained the main function).
2225 */
2226 ir_function_signature *const main_sig =
2227 _mesa_get_main_function_signature(linked->symbols);
2228
2229 /* Move any instructions other than variable declarations or function
2230 * declarations into main.
2231 */
2232 if (main_sig != NULL) {
2233 exec_node *insertion_point =
2234 move_non_declarations(linked->ir, (exec_node *) &main_sig->body, false,
2235 linked);
2236
2237 for (unsigned i = 0; i < num_shaders; i++) {
2238 if (shader_list[i] == main)
2239 continue;
2240
2241 insertion_point = move_non_declarations(shader_list[i]->ir,
2242 insertion_point, true, linked);
2243 }
2244 }
2245
2246 if (!link_function_calls(prog, linked, shader_list, num_shaders)) {
2247 _mesa_delete_linked_shader(ctx, linked);
2248 return NULL;
2249 }
2250
2251 /* Make a pass over all variable declarations to ensure that arrays with
2252 * unspecified sizes have a size specified. The size is inferred from the
2253 * max_array_access field.
2254 */
2255 array_sizing_visitor v;
2256 v.run(linked->ir);
2257 v.fixup_unnamed_interface_types();
2258
2259 /* Link up uniform blocks defined within this stage. */
2260 link_uniform_blocks(mem_ctx, ctx, prog, linked, &ubo_blocks,
2261 &num_ubo_blocks, &ssbo_blocks, &num_ssbo_blocks);
2262
2263 if (!prog->data->LinkStatus) {
2264 _mesa_delete_linked_shader(ctx, linked);
2265 return NULL;
2266 }
2267
2268 /* Copy ubo blocks to linked shader list */
2269 linked->Program->sh.UniformBlocks =
2270 ralloc_array(linked, gl_uniform_block *, num_ubo_blocks);
2271 ralloc_steal(linked, ubo_blocks);
2272 for (unsigned i = 0; i < num_ubo_blocks; i++) {
2273 linked->Program->sh.UniformBlocks[i] = &ubo_blocks[i];
2274 }
2275 linked->Program->info.num_ubos = num_ubo_blocks;
2276
2277 /* Copy ssbo blocks to linked shader list */
2278 linked->Program->sh.ShaderStorageBlocks =
2279 ralloc_array(linked, gl_uniform_block *, num_ssbo_blocks);
2280 ralloc_steal(linked, ssbo_blocks);
2281 for (unsigned i = 0; i < num_ssbo_blocks; i++) {
2282 linked->Program->sh.ShaderStorageBlocks[i] = &ssbo_blocks[i];
2283 }
2284 linked->Program->info.num_ssbos = num_ssbo_blocks;
2285
2286 /* At this point linked should contain all of the linked IR, so
2287 * validate it to make sure nothing went wrong.
2288 */
2289 validate_ir_tree(linked->ir);
2290
2291 /* Set the size of geometry shader input arrays */
2292 if (linked->Stage == MESA_SHADER_GEOMETRY) {
2293 unsigned num_vertices = vertices_per_prim(linked->info.Geom.InputType);
2294 array_resize_visitor input_resize_visitor(num_vertices, prog,
2295 MESA_SHADER_GEOMETRY);
2296 foreach_in_list(ir_instruction, ir, linked->ir) {
2297 ir->accept(&input_resize_visitor);
2298 }
2299 }
2300
2301 if (ctx->Const.VertexID_is_zero_based)
2302 lower_vertex_id(linked);
2303
2304 #ifdef DEBUG
2305 /* Compute the source checksum. */
2306 linked->SourceChecksum = 0;
2307 for (unsigned i = 0; i < num_shaders; i++) {
2308 if (shader_list[i] == NULL)
2309 continue;
2310 linked->SourceChecksum ^= shader_list[i]->SourceChecksum;
2311 }
2312 #endif
2313
2314 return linked;
2315 }
2316
2317 /**
2318 * Update the sizes of linked shader uniform arrays to the maximum
2319 * array index used.
2320 *
2321 * From page 81 (page 95 of the PDF) of the OpenGL 2.1 spec:
2322 *
2323 * If one or more elements of an array are active,
2324 * GetActiveUniform will return the name of the array in name,
2325 * subject to the restrictions listed above. The type of the array
2326 * is returned in type. The size parameter contains the highest
2327 * array element index used, plus one. The compiler or linker
2328 * determines the highest index used. There will be only one
2329 * active uniform reported by the GL per uniform array.
2330
2331 */
2332 static void
2333 update_array_sizes(struct gl_shader_program *prog)
2334 {
2335 for (unsigned i = 0; i < MESA_SHADER_STAGES; i++) {
2336 if (prog->_LinkedShaders[i] == NULL)
2337 continue;
2338
2339 bool types_were_updated = false;
2340
2341 foreach_in_list(ir_instruction, node, prog->_LinkedShaders[i]->ir) {
2342 ir_variable *const var = node->as_variable();
2343
2344 if ((var == NULL) || (var->data.mode != ir_var_uniform) ||
2345 !var->type->is_array())
2346 continue;
2347
2348 /* GL_ARB_uniform_buffer_object says that std140 uniforms
2349 * will not be eliminated. Since we always do std140, just
2350 * don't resize arrays in UBOs.
2351 *
2352 * Atomic counters are supposed to get deterministic
2353 * locations assigned based on the declaration ordering and
2354 * sizes, array compaction would mess that up.
2355 *
2356 * Subroutine uniforms are not removed.
2357 */
2358 if (var->is_in_buffer_block() || var->type->contains_atomic() ||
2359 var->type->contains_subroutine() || var->constant_initializer)
2360 continue;
2361
2362 int size = var->data.max_array_access;
2363 for (unsigned j = 0; j < MESA_SHADER_STAGES; j++) {
2364 if (prog->_LinkedShaders[j] == NULL)
2365 continue;
2366
2367 foreach_in_list(ir_instruction, node2, prog->_LinkedShaders[j]->ir) {
2368 ir_variable *other_var = node2->as_variable();
2369 if (!other_var)
2370 continue;
2371
2372 if (strcmp(var->name, other_var->name) == 0 &&
2373 other_var->data.max_array_access > size) {
2374 size = other_var->data.max_array_access;
2375 }
2376 }
2377 }
2378
2379 if (size + 1 != (int)var->type->length) {
2380 /* If this is a built-in uniform (i.e., it's backed by some
2381 * fixed-function state), adjust the number of state slots to
2382 * match the new array size. The number of slots per array entry
2383 * is not known. It seems safe to assume that the total number of
2384 * slots is an integer multiple of the number of array elements.
2385 * Determine the number of slots per array element by dividing by
2386 * the old (total) size.
2387 */
2388 const unsigned num_slots = var->get_num_state_slots();
2389 if (num_slots > 0) {
2390 var->set_num_state_slots((size + 1)
2391 * (num_slots / var->type->length));
2392 }
2393
2394 var->type = glsl_type::get_array_instance(var->type->fields.array,
2395 size + 1);
2396 types_were_updated = true;
2397 }
2398 }
2399
2400 /* Update the types of dereferences in case we changed any. */
2401 if (types_were_updated) {
2402 deref_type_updater v;
2403 v.run(prog->_LinkedShaders[i]->ir);
2404 }
2405 }
2406 }
2407
2408 /**
2409 * Resize tessellation evaluation per-vertex inputs to the size of
2410 * tessellation control per-vertex outputs.
2411 */
2412 static void
2413 resize_tes_inputs(struct gl_context *ctx,
2414 struct gl_shader_program *prog)
2415 {
2416 if (prog->_LinkedShaders[MESA_SHADER_TESS_EVAL] == NULL)
2417 return;
2418
2419 gl_linked_shader *const tcs = prog->_LinkedShaders[MESA_SHADER_TESS_CTRL];
2420 gl_linked_shader *const tes = prog->_LinkedShaders[MESA_SHADER_TESS_EVAL];
2421
2422 /* If no control shader is present, then the TES inputs are statically
2423 * sized to MaxPatchVertices; the actual size of the arrays won't be
2424 * known until draw time.
2425 */
2426 const int num_vertices = tcs
2427 ? tcs->Program->info.tess.tcs_vertices_out
2428 : ctx->Const.MaxPatchVertices;
2429
2430 array_resize_visitor input_resize_visitor(num_vertices, prog,
2431 MESA_SHADER_TESS_EVAL);
2432 foreach_in_list(ir_instruction, ir, tes->ir) {
2433 ir->accept(&input_resize_visitor);
2434 }
2435
2436 if (tcs || ctx->Const.LowerTESPatchVerticesIn) {
2437 /* Convert the gl_PatchVerticesIn system value into a constant, since
2438 * the value is known at this point.
2439 */
2440 foreach_in_list(ir_instruction, ir, tes->ir) {
2441 ir_variable *var = ir->as_variable();
2442 if (var && var->data.mode == ir_var_system_value &&
2443 var->data.location == SYSTEM_VALUE_VERTICES_IN) {
2444 void *mem_ctx = ralloc_parent(var);
2445 var->data.location = 0;
2446 var->data.explicit_location = false;
2447 if (tcs) {
2448 var->data.mode = ir_var_auto;
2449 var->constant_value = new(mem_ctx) ir_constant(num_vertices);
2450 } else {
2451 var->data.mode = ir_var_uniform;
2452 var->data.how_declared = ir_var_hidden;
2453 var->allocate_state_slots(1);
2454 ir_state_slot *slot0 = &var->get_state_slots()[0];
2455 slot0->swizzle = SWIZZLE_XXXX;
2456 slot0->tokens[0] = STATE_INTERNAL;
2457 slot0->tokens[1] = STATE_TES_PATCH_VERTICES_IN;
2458 for (int i = 2; i < STATE_LENGTH; i++)
2459 slot0->tokens[i] = 0;
2460 }
2461 }
2462 }
2463 }
2464 }
2465
2466 /**
2467 * Find a contiguous set of available bits in a bitmask.
2468 *
2469 * \param used_mask Bits representing used (1) and unused (0) locations
2470 * \param needed_count Number of contiguous bits needed.
2471 *
2472 * \return
2473 * Base location of the available bits on success or -1 on failure.
2474 */
2475 int
2476 find_available_slots(unsigned used_mask, unsigned needed_count)
2477 {
2478 unsigned needed_mask = (1 << needed_count) - 1;
2479 const int max_bit_to_test = (8 * sizeof(used_mask)) - needed_count;
2480
2481 /* The comparison to 32 is redundant, but without it GCC emits "warning:
2482 * cannot optimize possibly infinite loops" for the loop below.
2483 */
2484 if ((needed_count == 0) || (max_bit_to_test < 0) || (max_bit_to_test > 32))
2485 return -1;
2486
2487 for (int i = 0; i <= max_bit_to_test; i++) {
2488 if ((needed_mask & ~used_mask) == needed_mask)
2489 return i;
2490
2491 needed_mask <<= 1;
2492 }
2493
2494 return -1;
2495 }
2496
2497
2498 /**
2499 * Assign locations for either VS inputs or FS outputs
2500 *
2501 * \param mem_ctx Temporary ralloc context used for linking
2502 * \param prog Shader program whose variables need locations assigned
2503 * \param constants Driver specific constant values for the program.
2504 * \param target_index Selector for the program target to receive location
2505 * assignmnets. Must be either \c MESA_SHADER_VERTEX or
2506 * \c MESA_SHADER_FRAGMENT.
2507 *
2508 * \return
2509 * If locations are successfully assigned, true is returned. Otherwise an
2510 * error is emitted to the shader link log and false is returned.
2511 */
2512 bool
2513 assign_attribute_or_color_locations(void *mem_ctx,
2514 gl_shader_program *prog,
2515 struct gl_constants *constants,
2516 unsigned target_index)
2517 {
2518 /* Maximum number of generic locations. This corresponds to either the
2519 * maximum number of draw buffers or the maximum number of generic
2520 * attributes.
2521 */
2522 unsigned max_index = (target_index == MESA_SHADER_VERTEX) ?
2523 constants->Program[target_index].MaxAttribs :
2524 MAX2(constants->MaxDrawBuffers, constants->MaxDualSourceDrawBuffers);
2525
2526 /* Mark invalid locations as being used.
2527 */
2528 unsigned used_locations = (max_index >= 32)
2529 ? ~0 : ~((1 << max_index) - 1);
2530 unsigned double_storage_locations = 0;
2531
2532 assert((target_index == MESA_SHADER_VERTEX)
2533 || (target_index == MESA_SHADER_FRAGMENT));
2534
2535 gl_linked_shader *const sh = prog->_LinkedShaders[target_index];
2536 if (sh == NULL)
2537 return true;
2538
2539 /* Operate in a total of four passes.
2540 *
2541 * 1. Invalidate the location assignments for all vertex shader inputs.
2542 *
2543 * 2. Assign locations for inputs that have user-defined (via
2544 * glBindVertexAttribLocation) locations and outputs that have
2545 * user-defined locations (via glBindFragDataLocation).
2546 *
2547 * 3. Sort the attributes without assigned locations by number of slots
2548 * required in decreasing order. Fragmentation caused by attribute
2549 * locations assigned by the application may prevent large attributes
2550 * from having enough contiguous space.
2551 *
2552 * 4. Assign locations to any inputs without assigned locations.
2553 */
2554
2555 const int generic_base = (target_index == MESA_SHADER_VERTEX)
2556 ? (int) VERT_ATTRIB_GENERIC0 : (int) FRAG_RESULT_DATA0;
2557
2558 const enum ir_variable_mode direction =
2559 (target_index == MESA_SHADER_VERTEX)
2560 ? ir_var_shader_in : ir_var_shader_out;
2561
2562
2563 /* Temporary storage for the set of attributes that need locations assigned.
2564 */
2565 struct temp_attr {
2566 unsigned slots;
2567 ir_variable *var;
2568
2569 /* Used below in the call to qsort. */
2570 static int compare(const void *a, const void *b)
2571 {
2572 const temp_attr *const l = (const temp_attr *) a;
2573 const temp_attr *const r = (const temp_attr *) b;
2574
2575 /* Reversed because we want a descending order sort below. */
2576 return r->slots - l->slots;
2577 }
2578 } to_assign[32];
2579 assert(max_index <= 32);
2580
2581 /* Temporary array for the set of attributes that have locations assigned.
2582 */
2583 ir_variable *assigned[16];
2584
2585 unsigned num_attr = 0;
2586 unsigned assigned_attr = 0;
2587
2588 foreach_in_list(ir_instruction, node, sh->ir) {
2589 ir_variable *const var = node->as_variable();
2590
2591 if ((var == NULL) || (var->data.mode != (unsigned) direction))
2592 continue;
2593
2594 if (var->data.explicit_location) {
2595 var->data.is_unmatched_generic_inout = 0;
2596 if ((var->data.location >= (int)(max_index + generic_base))
2597 || (var->data.location < 0)) {
2598 linker_error(prog,
2599 "invalid explicit location %d specified for `%s'\n",
2600 (var->data.location < 0)
2601 ? var->data.location
2602 : var->data.location - generic_base,
2603 var->name);
2604 return false;
2605 }
2606 } else if (target_index == MESA_SHADER_VERTEX) {
2607 unsigned binding;
2608
2609 if (prog->AttributeBindings->get(binding, var->name)) {
2610 assert(binding >= VERT_ATTRIB_GENERIC0);
2611 var->data.location = binding;
2612 var->data.is_unmatched_generic_inout = 0;
2613 }
2614 } else if (target_index == MESA_SHADER_FRAGMENT) {
2615 unsigned binding;
2616 unsigned index;
2617 const char *name = var->name;
2618 const glsl_type *type = var->type;
2619
2620 while (type) {
2621 /* Check if there's a binding for the variable name */
2622 if (prog->FragDataBindings->get(binding, name)) {
2623 assert(binding >= FRAG_RESULT_DATA0);
2624 var->data.location = binding;
2625 var->data.is_unmatched_generic_inout = 0;
2626
2627 if (prog->FragDataIndexBindings->get(index, name)) {
2628 var->data.index = index;
2629 }
2630 break;
2631 }
2632
2633 /* If not, but it's an array type, look for name[0] */
2634 if (type->is_array()) {
2635 name = ralloc_asprintf(mem_ctx, "%s[0]", name);
2636 type = type->fields.array;
2637 continue;
2638 }
2639
2640 break;
2641 }
2642 }
2643
2644 if (strcmp(var->name, "gl_LastFragData") == 0)
2645 continue;
2646
2647 /* From GL4.5 core spec, section 15.2 (Shader Execution):
2648 *
2649 * "Output binding assignments will cause LinkProgram to fail:
2650 * ...
2651 * If the program has an active output assigned to a location greater
2652 * than or equal to the value of MAX_DUAL_SOURCE_DRAW_BUFFERS and has
2653 * an active output assigned an index greater than or equal to one;"
2654 */
2655 if (target_index == MESA_SHADER_FRAGMENT && var->data.index >= 1 &&
2656 var->data.location - generic_base >=
2657 (int) constants->MaxDualSourceDrawBuffers) {
2658 linker_error(prog,
2659 "output location %d >= GL_MAX_DUAL_SOURCE_DRAW_BUFFERS "
2660 "with index %u for %s\n",
2661 var->data.location - generic_base, var->data.index,
2662 var->name);
2663 return false;
2664 }
2665
2666 const unsigned slots = var->type->count_attribute_slots(target_index == MESA_SHADER_VERTEX);
2667
2668 /* If the variable is not a built-in and has a location statically
2669 * assigned in the shader (presumably via a layout qualifier), make sure
2670 * that it doesn't collide with other assigned locations. Otherwise,
2671 * add it to the list of variables that need linker-assigned locations.
2672 */
2673 if (var->data.location != -1) {
2674 if (var->data.location >= generic_base && var->data.index < 1) {
2675 /* From page 61 of the OpenGL 4.0 spec:
2676 *
2677 * "LinkProgram will fail if the attribute bindings assigned
2678 * by BindAttribLocation do not leave not enough space to
2679 * assign a location for an active matrix attribute or an
2680 * active attribute array, both of which require multiple
2681 * contiguous generic attributes."
2682 *
2683 * I think above text prohibits the aliasing of explicit and
2684 * automatic assignments. But, aliasing is allowed in manual
2685 * assignments of attribute locations. See below comments for
2686 * the details.
2687 *
2688 * From OpenGL 4.0 spec, page 61:
2689 *
2690 * "It is possible for an application to bind more than one
2691 * attribute name to the same location. This is referred to as
2692 * aliasing. This will only work if only one of the aliased
2693 * attributes is active in the executable program, or if no
2694 * path through the shader consumes more than one attribute of
2695 * a set of attributes aliased to the same location. A link
2696 * error can occur if the linker determines that every path
2697 * through the shader consumes multiple aliased attributes,
2698 * but implementations are not required to generate an error
2699 * in this case."
2700 *
2701 * From GLSL 4.30 spec, page 54:
2702 *
2703 * "A program will fail to link if any two non-vertex shader
2704 * input variables are assigned to the same location. For
2705 * vertex shaders, multiple input variables may be assigned
2706 * to the same location using either layout qualifiers or via
2707 * the OpenGL API. However, such aliasing is intended only to
2708 * support vertex shaders where each execution path accesses
2709 * at most one input per each location. Implementations are
2710 * permitted, but not required, to generate link-time errors
2711 * if they detect that every path through the vertex shader
2712 * executable accesses multiple inputs assigned to any single
2713 * location. For all shader types, a program will fail to link
2714 * if explicit location assignments leave the linker unable
2715 * to find space for other variables without explicit
2716 * assignments."
2717 *
2718 * From OpenGL ES 3.0 spec, page 56:
2719 *
2720 * "Binding more than one attribute name to the same location
2721 * is referred to as aliasing, and is not permitted in OpenGL
2722 * ES Shading Language 3.00 vertex shaders. LinkProgram will
2723 * fail when this condition exists. However, aliasing is
2724 * possible in OpenGL ES Shading Language 1.00 vertex shaders.
2725 * This will only work if only one of the aliased attributes
2726 * is active in the executable program, or if no path through
2727 * the shader consumes more than one attribute of a set of
2728 * attributes aliased to the same location. A link error can
2729 * occur if the linker determines that every path through the
2730 * shader consumes multiple aliased attributes, but implemen-
2731 * tations are not required to generate an error in this case."
2732 *
2733 * After looking at above references from OpenGL, OpenGL ES and
2734 * GLSL specifications, we allow aliasing of vertex input variables
2735 * in: OpenGL 2.0 (and above) and OpenGL ES 2.0.
2736 *
2737 * NOTE: This is not required by the spec but its worth mentioning
2738 * here that we're not doing anything to make sure that no path
2739 * through the vertex shader executable accesses multiple inputs
2740 * assigned to any single location.
2741 */
2742
2743 /* Mask representing the contiguous slots that will be used by
2744 * this attribute.
2745 */
2746 const unsigned attr = var->data.location - generic_base;
2747 const unsigned use_mask = (1 << slots) - 1;
2748 const char *const string = (target_index == MESA_SHADER_VERTEX)
2749 ? "vertex shader input" : "fragment shader output";
2750
2751 /* Generate a link error if the requested locations for this
2752 * attribute exceed the maximum allowed attribute location.
2753 */
2754 if (attr + slots > max_index) {
2755 linker_error(prog,
2756 "insufficient contiguous locations "
2757 "available for %s `%s' %d %d %d\n", string,
2758 var->name, used_locations, use_mask, attr);
2759 return false;
2760 }
2761
2762 /* Generate a link error if the set of bits requested for this
2763 * attribute overlaps any previously allocated bits.
2764 */
2765 if ((~(use_mask << attr) & used_locations) != used_locations) {
2766 if (target_index == MESA_SHADER_FRAGMENT && !prog->IsES) {
2767 /* From section 4.4.2 (Output Layout Qualifiers) of the GLSL
2768 * 4.40 spec:
2769 *
2770 * "Additionally, for fragment shader outputs, if two
2771 * variables are placed within the same location, they
2772 * must have the same underlying type (floating-point or
2773 * integer). No component aliasing of output variables or
2774 * members is allowed.
2775 */
2776 for (unsigned i = 0; i < assigned_attr; i++) {
2777 unsigned assigned_slots =
2778 assigned[i]->type->count_attribute_slots(false);
2779 unsigned assig_attr =
2780 assigned[i]->data.location - generic_base;
2781 unsigned assigned_use_mask = (1 << assigned_slots) - 1;
2782
2783 if ((assigned_use_mask << assig_attr) &
2784 (use_mask << attr)) {
2785
2786 const glsl_type *assigned_type =
2787 assigned[i]->type->without_array();
2788 const glsl_type *type = var->type->without_array();
2789 if (assigned_type->base_type != type->base_type) {
2790 linker_error(prog, "types do not match for aliased"
2791 " %ss %s and %s\n", string,
2792 assigned[i]->name, var->name);
2793 return false;
2794 }
2795
2796 unsigned assigned_component_mask =
2797 ((1 << assigned_type->vector_elements) - 1) <<
2798 assigned[i]->data.location_frac;
2799 unsigned component_mask =
2800 ((1 << type->vector_elements) - 1) <<
2801 var->data.location_frac;
2802 if (assigned_component_mask & component_mask) {
2803 linker_error(prog, "overlapping component is "
2804 "assigned to %ss %s and %s "
2805 "(component=%d)\n",
2806 string, assigned[i]->name, var->name,
2807 var->data.location_frac);
2808 return false;
2809 }
2810 }
2811 }
2812 } else if (target_index == MESA_SHADER_FRAGMENT ||
2813 (prog->IsES && prog->data->Version >= 300)) {
2814 linker_error(prog, "overlapping location is assigned "
2815 "to %s `%s' %d %d %d\n", string, var->name,
2816 used_locations, use_mask, attr);
2817 return false;
2818 } else {
2819 linker_warning(prog, "overlapping location is assigned "
2820 "to %s `%s' %d %d %d\n", string, var->name,
2821 used_locations, use_mask, attr);
2822 }
2823 }
2824
2825 used_locations |= (use_mask << attr);
2826
2827 /* From the GL 4.5 core spec, section 11.1.1 (Vertex Attributes):
2828 *
2829 * "A program with more than the value of MAX_VERTEX_ATTRIBS
2830 * active attribute variables may fail to link, unless
2831 * device-dependent optimizations are able to make the program
2832 * fit within available hardware resources. For the purposes
2833 * of this test, attribute variables of the type dvec3, dvec4,
2834 * dmat2x3, dmat2x4, dmat3, dmat3x4, dmat4x3, and dmat4 may
2835 * count as consuming twice as many attributes as equivalent
2836 * single-precision types. While these types use the same number
2837 * of generic attributes as their single-precision equivalents,
2838 * implementations are permitted to consume two single-precision
2839 * vectors of internal storage for each three- or four-component
2840 * double-precision vector."
2841 *
2842 * Mark this attribute slot as taking up twice as much space
2843 * so we can count it properly against limits. According to
2844 * issue (3) of the GL_ARB_vertex_attrib_64bit behavior, this
2845 * is optional behavior, but it seems preferable.
2846 */
2847 if (var->type->without_array()->is_dual_slot())
2848 double_storage_locations |= (use_mask << attr);
2849 }
2850
2851 assigned[assigned_attr] = var;
2852 assigned_attr++;
2853
2854 continue;
2855 }
2856
2857 if (num_attr >= max_index) {
2858 linker_error(prog, "too many %s (max %u)",
2859 target_index == MESA_SHADER_VERTEX ?
2860 "vertex shader inputs" : "fragment shader outputs",
2861 max_index);
2862 return false;
2863 }
2864 to_assign[num_attr].slots = slots;
2865 to_assign[num_attr].var = var;
2866 num_attr++;
2867 }
2868
2869 if (target_index == MESA_SHADER_VERTEX) {
2870 unsigned total_attribs_size =
2871 _mesa_bitcount(used_locations & ((1 << max_index) - 1)) +
2872 _mesa_bitcount(double_storage_locations);
2873 if (total_attribs_size > max_index) {
2874 linker_error(prog,
2875 "attempt to use %d vertex attribute slots only %d available ",
2876 total_attribs_size, max_index);
2877 return false;
2878 }
2879 }
2880
2881 /* If all of the attributes were assigned locations by the application (or
2882 * are built-in attributes with fixed locations), return early. This should
2883 * be the common case.
2884 */
2885 if (num_attr == 0)
2886 return true;
2887
2888 qsort(to_assign, num_attr, sizeof(to_assign[0]), temp_attr::compare);
2889
2890 if (target_index == MESA_SHADER_VERTEX) {
2891 /* VERT_ATTRIB_GENERIC0 is a pseudo-alias for VERT_ATTRIB_POS. It can
2892 * only be explicitly assigned by via glBindAttribLocation. Mark it as
2893 * reserved to prevent it from being automatically allocated below.
2894 */
2895 find_deref_visitor find("gl_Vertex");
2896 find.run(sh->ir);
2897 if (find.variable_found())
2898 used_locations |= (1 << 0);
2899 }
2900
2901 for (unsigned i = 0; i < num_attr; i++) {
2902 /* Mask representing the contiguous slots that will be used by this
2903 * attribute.
2904 */
2905 const unsigned use_mask = (1 << to_assign[i].slots) - 1;
2906
2907 int location = find_available_slots(used_locations, to_assign[i].slots);
2908
2909 if (location < 0) {
2910 const char *const string = (target_index == MESA_SHADER_VERTEX)
2911 ? "vertex shader input" : "fragment shader output";
2912
2913 linker_error(prog,
2914 "insufficient contiguous locations "
2915 "available for %s `%s'\n",
2916 string, to_assign[i].var->name);
2917 return false;
2918 }
2919
2920 to_assign[i].var->data.location = generic_base + location;
2921 to_assign[i].var->data.is_unmatched_generic_inout = 0;
2922 used_locations |= (use_mask << location);
2923
2924 if (to_assign[i].var->type->without_array()->is_dual_slot())
2925 double_storage_locations |= (use_mask << location);
2926 }
2927
2928 /* Now that we have all the locations, from the GL 4.5 core spec, section
2929 * 11.1.1 (Vertex Attributes), dvec3, dvec4, dmat2x3, dmat2x4, dmat3,
2930 * dmat3x4, dmat4x3, and dmat4 count as consuming twice as many attributes
2931 * as equivalent single-precision types.
2932 */
2933 if (target_index == MESA_SHADER_VERTEX) {
2934 unsigned total_attribs_size =
2935 _mesa_bitcount(used_locations & ((1 << max_index) - 1)) +
2936 _mesa_bitcount(double_storage_locations);
2937 if (total_attribs_size > max_index) {
2938 linker_error(prog,
2939 "attempt to use %d vertex attribute slots only %d available ",
2940 total_attribs_size, max_index);
2941 return false;
2942 }
2943 }
2944
2945 return true;
2946 }
2947
2948 /**
2949 * Match explicit locations of outputs to inputs and deactivate the
2950 * unmatch flag if found so we don't optimise them away.
2951 */
2952 static void
2953 match_explicit_outputs_to_inputs(gl_linked_shader *producer,
2954 gl_linked_shader *consumer)
2955 {
2956 glsl_symbol_table parameters;
2957 ir_variable *explicit_locations[MAX_VARYINGS_INCL_PATCH][4] =
2958 { {NULL, NULL} };
2959
2960 /* Find all shader outputs in the "producer" stage.
2961 */
2962 foreach_in_list(ir_instruction, node, producer->ir) {
2963 ir_variable *const var = node->as_variable();
2964
2965 if ((var == NULL) || (var->data.mode != ir_var_shader_out))
2966 continue;
2967
2968 if (var->data.explicit_location &&
2969 var->data.location >= VARYING_SLOT_VAR0) {
2970 const unsigned idx = var->data.location - VARYING_SLOT_VAR0;
2971 if (explicit_locations[idx][var->data.location_frac] == NULL)
2972 explicit_locations[idx][var->data.location_frac] = var;
2973 }
2974 }
2975
2976 /* Match inputs to outputs */
2977 foreach_in_list(ir_instruction, node, consumer->ir) {
2978 ir_variable *const input = node->as_variable();
2979
2980 if ((input == NULL) || (input->data.mode != ir_var_shader_in))
2981 continue;
2982
2983 ir_variable *output = NULL;
2984 if (input->data.explicit_location
2985 && input->data.location >= VARYING_SLOT_VAR0) {
2986 output = explicit_locations[input->data.location - VARYING_SLOT_VAR0]
2987 [input->data.location_frac];
2988
2989 if (output != NULL){
2990 input->data.is_unmatched_generic_inout = 0;
2991 output->data.is_unmatched_generic_inout = 0;
2992 }
2993 }
2994 }
2995 }
2996
2997 /**
2998 * Store the gl_FragDepth layout in the gl_shader_program struct.
2999 */
3000 static void
3001 store_fragdepth_layout(struct gl_shader_program *prog)
3002 {
3003 if (prog->_LinkedShaders[MESA_SHADER_FRAGMENT] == NULL) {
3004 return;
3005 }
3006
3007 struct exec_list *ir = prog->_LinkedShaders[MESA_SHADER_FRAGMENT]->ir;
3008
3009 /* We don't look up the gl_FragDepth symbol directly because if
3010 * gl_FragDepth is not used in the shader, it's removed from the IR.
3011 * However, the symbol won't be removed from the symbol table.
3012 *
3013 * We're only interested in the cases where the variable is NOT removed
3014 * from the IR.
3015 */
3016 foreach_in_list(ir_instruction, node, ir) {
3017 ir_variable *const var = node->as_variable();
3018
3019 if (var == NULL || var->data.mode != ir_var_shader_out) {
3020 continue;
3021 }
3022
3023 if (strcmp(var->name, "gl_FragDepth") == 0) {
3024 switch (var->data.depth_layout) {
3025 case ir_depth_layout_none:
3026 prog->FragDepthLayout = FRAG_DEPTH_LAYOUT_NONE;
3027 return;
3028 case ir_depth_layout_any:
3029 prog->FragDepthLayout = FRAG_DEPTH_LAYOUT_ANY;
3030 return;
3031 case ir_depth_layout_greater:
3032 prog->FragDepthLayout = FRAG_DEPTH_LAYOUT_GREATER;
3033 return;
3034 case ir_depth_layout_less:
3035 prog->FragDepthLayout = FRAG_DEPTH_LAYOUT_LESS;
3036 return;
3037 case ir_depth_layout_unchanged:
3038 prog->FragDepthLayout = FRAG_DEPTH_LAYOUT_UNCHANGED;
3039 return;
3040 default:
3041 assert(0);
3042 return;
3043 }
3044 }
3045 }
3046 }
3047
3048 /**
3049 * Validate the resources used by a program versus the implementation limits
3050 */
3051 static void
3052 check_resources(struct gl_context *ctx, struct gl_shader_program *prog)
3053 {
3054 unsigned total_uniform_blocks = 0;
3055 unsigned total_shader_storage_blocks = 0;
3056
3057 for (unsigned i = 0; i < MESA_SHADER_STAGES; i++) {
3058 struct gl_linked_shader *sh = prog->_LinkedShaders[i];
3059
3060 if (sh == NULL)
3061 continue;
3062
3063 if (sh->Program->info.num_textures >
3064 ctx->Const.Program[i].MaxTextureImageUnits) {
3065 linker_error(prog, "Too many %s shader texture samplers\n",
3066 _mesa_shader_stage_to_string(i));
3067 }
3068
3069 if (sh->num_uniform_components >
3070 ctx->Const.Program[i].MaxUniformComponents) {
3071 if (ctx->Const.GLSLSkipStrictMaxUniformLimitCheck) {
3072 linker_warning(prog, "Too many %s shader default uniform block "
3073 "components, but the driver will try to optimize "
3074 "them out; this is non-portable out-of-spec "
3075 "behavior\n",
3076 _mesa_shader_stage_to_string(i));
3077 } else {
3078 linker_error(prog, "Too many %s shader default uniform block "
3079 "components\n",
3080 _mesa_shader_stage_to_string(i));
3081 }
3082 }
3083
3084 if (sh->num_combined_uniform_components >
3085 ctx->Const.Program[i].MaxCombinedUniformComponents) {
3086 if (ctx->Const.GLSLSkipStrictMaxUniformLimitCheck) {
3087 linker_warning(prog, "Too many %s shader uniform components, "
3088 "but the driver will try to optimize them out; "
3089 "this is non-portable out-of-spec behavior\n",
3090 _mesa_shader_stage_to_string(i));
3091 } else {
3092 linker_error(prog, "Too many %s shader uniform components\n",
3093 _mesa_shader_stage_to_string(i));
3094 }
3095 }
3096
3097 total_shader_storage_blocks += sh->Program->info.num_ssbos;
3098 total_uniform_blocks += sh->Program->info.num_ubos;
3099
3100 const unsigned max_uniform_blocks =
3101 ctx->Const.Program[i].MaxUniformBlocks;
3102 if (max_uniform_blocks < sh->Program->info.num_ubos) {
3103 linker_error(prog, "Too many %s uniform blocks (%d/%d)\n",
3104 _mesa_shader_stage_to_string(i),
3105 sh->Program->info.num_ubos, max_uniform_blocks);
3106 }
3107
3108 const unsigned max_shader_storage_blocks =
3109 ctx->Const.Program[i].MaxShaderStorageBlocks;
3110 if (max_shader_storage_blocks < sh->Program->info.num_ssbos) {
3111 linker_error(prog, "Too many %s shader storage blocks (%d/%d)\n",
3112 _mesa_shader_stage_to_string(i),
3113 sh->Program->info.num_ssbos, max_shader_storage_blocks);
3114 }
3115 }
3116
3117 if (total_uniform_blocks > ctx->Const.MaxCombinedUniformBlocks) {
3118 linker_error(prog, "Too many combined uniform blocks (%d/%d)\n",
3119 total_uniform_blocks, ctx->Const.MaxCombinedUniformBlocks);
3120 }
3121
3122 if (total_shader_storage_blocks > ctx->Const.MaxCombinedShaderStorageBlocks) {
3123 linker_error(prog, "Too many combined shader storage blocks (%d/%d)\n",
3124 total_shader_storage_blocks,
3125 ctx->Const.MaxCombinedShaderStorageBlocks);
3126 }
3127
3128 for (unsigned i = 0; i < prog->data->NumUniformBlocks; i++) {
3129 if (prog->data->UniformBlocks[i].UniformBufferSize >
3130 ctx->Const.MaxUniformBlockSize) {
3131 linker_error(prog, "Uniform block %s too big (%d/%d)\n",
3132 prog->data->UniformBlocks[i].Name,
3133 prog->data->UniformBlocks[i].UniformBufferSize,
3134 ctx->Const.MaxUniformBlockSize);
3135 }
3136 }
3137
3138 for (unsigned i = 0; i < prog->data->NumShaderStorageBlocks; i++) {
3139 if (prog->data->ShaderStorageBlocks[i].UniformBufferSize >
3140 ctx->Const.MaxShaderStorageBlockSize) {
3141 linker_error(prog, "Shader storage block %s too big (%d/%d)\n",
3142 prog->data->ShaderStorageBlocks[i].Name,
3143 prog->data->ShaderStorageBlocks[i].UniformBufferSize,
3144 ctx->Const.MaxShaderStorageBlockSize);
3145 }
3146 }
3147 }
3148
3149 static void
3150 link_calculate_subroutine_compat(struct gl_shader_program *prog)
3151 {
3152 unsigned mask = prog->data->linked_stages;
3153 while (mask) {
3154 const int i = u_bit_scan(&mask);
3155 struct gl_program *p = prog->_LinkedShaders[i]->Program;
3156
3157 for (unsigned j = 0; j < p->sh.NumSubroutineUniformRemapTable; j++) {
3158 if (p->sh.SubroutineUniformRemapTable[j] == INACTIVE_UNIFORM_EXPLICIT_LOCATION)
3159 continue;
3160
3161 struct gl_uniform_storage *uni = p->sh.SubroutineUniformRemapTable[j];
3162
3163 if (!uni)
3164 continue;
3165
3166 int count = 0;
3167 if (p->sh.NumSubroutineFunctions == 0) {
3168 linker_error(prog, "subroutine uniform %s defined but no valid functions found\n", uni->type->name);
3169 continue;
3170 }
3171 for (unsigned f = 0; f < p->sh.NumSubroutineFunctions; f++) {
3172 struct gl_subroutine_function *fn = &p->sh.SubroutineFunctions[f];
3173 for (int k = 0; k < fn->num_compat_types; k++) {
3174 if (fn->types[k] == uni->type) {
3175 count++;
3176 break;
3177 }
3178 }
3179 }
3180 uni->num_compatible_subroutines = count;
3181 }
3182 }
3183 }
3184
3185 static void
3186 check_subroutine_resources(struct gl_shader_program *prog)
3187 {
3188 unsigned mask = prog->data->linked_stages;
3189 while (mask) {
3190 const int i = u_bit_scan(&mask);
3191 struct gl_program *p = prog->_LinkedShaders[i]->Program;
3192
3193 if (p->sh.NumSubroutineUniformRemapTable > MAX_SUBROUTINE_UNIFORM_LOCATIONS) {
3194 linker_error(prog, "Too many %s shader subroutine uniforms\n",
3195 _mesa_shader_stage_to_string(i));
3196 }
3197 }
3198 }
3199 /**
3200 * Validate shader image resources.
3201 */
3202 static void
3203 check_image_resources(struct gl_context *ctx, struct gl_shader_program *prog)
3204 {
3205 unsigned total_image_units = 0;
3206 unsigned fragment_outputs = 0;
3207 unsigned total_shader_storage_blocks = 0;
3208
3209 if (!ctx->Extensions.ARB_shader_image_load_store)
3210 return;
3211
3212 for (unsigned i = 0; i < MESA_SHADER_STAGES; i++) {
3213 struct gl_linked_shader *sh = prog->_LinkedShaders[i];
3214
3215 if (sh) {
3216 if (sh->Program->info.num_images > ctx->Const.Program[i].MaxImageUniforms)
3217 linker_error(prog, "Too many %s shader image uniforms (%u > %u)\n",
3218 _mesa_shader_stage_to_string(i),
3219 sh->Program->info.num_images,
3220 ctx->Const.Program[i].MaxImageUniforms);
3221
3222 total_image_units += sh->Program->info.num_images;
3223 total_shader_storage_blocks += sh->Program->info.num_ssbos;
3224
3225 if (i == MESA_SHADER_FRAGMENT) {
3226 foreach_in_list(ir_instruction, node, sh->ir) {
3227 ir_variable *var = node->as_variable();
3228 if (var && var->data.mode == ir_var_shader_out)
3229 /* since there are no double fs outputs - pass false */
3230 fragment_outputs += var->type->count_attribute_slots(false);
3231 }
3232 }
3233 }
3234 }
3235
3236 if (total_image_units > ctx->Const.MaxCombinedImageUniforms)
3237 linker_error(prog, "Too many combined image uniforms\n");
3238
3239 if (total_image_units + fragment_outputs + total_shader_storage_blocks >
3240 ctx->Const.MaxCombinedShaderOutputResources)
3241 linker_error(prog, "Too many combined image uniforms, shader storage "
3242 " buffers and fragment outputs\n");
3243 }
3244
3245
3246 /**
3247 * Initializes explicit location slots to INACTIVE_UNIFORM_EXPLICIT_LOCATION
3248 * for a variable, checks for overlaps between other uniforms using explicit
3249 * locations.
3250 */
3251 static int
3252 reserve_explicit_locations(struct gl_shader_program *prog,
3253 string_to_uint_map *map, ir_variable *var)
3254 {
3255 unsigned slots = var->type->uniform_locations();
3256 unsigned max_loc = var->data.location + slots - 1;
3257 unsigned return_value = slots;
3258
3259 /* Resize remap table if locations do not fit in the current one. */
3260 if (max_loc + 1 > prog->NumUniformRemapTable) {
3261 prog->UniformRemapTable =
3262 reralloc(prog, prog->UniformRemapTable,
3263 gl_uniform_storage *,
3264 max_loc + 1);
3265
3266 if (!prog->UniformRemapTable) {
3267 linker_error(prog, "Out of memory during linking.\n");
3268 return -1;
3269 }
3270
3271 /* Initialize allocated space. */
3272 for (unsigned i = prog->NumUniformRemapTable; i < max_loc + 1; i++)
3273 prog->UniformRemapTable[i] = NULL;
3274
3275 prog->NumUniformRemapTable = max_loc + 1;
3276 }
3277
3278 for (unsigned i = 0; i < slots; i++) {
3279 unsigned loc = var->data.location + i;
3280
3281 /* Check if location is already used. */
3282 if (prog->UniformRemapTable[loc] == INACTIVE_UNIFORM_EXPLICIT_LOCATION) {
3283
3284 /* Possibly same uniform from a different stage, this is ok. */
3285 unsigned hash_loc;
3286 if (map->get(hash_loc, var->name) && hash_loc == loc - i) {
3287 return_value = 0;
3288 continue;
3289 }
3290
3291 /* ARB_explicit_uniform_location specification states:
3292 *
3293 * "No two default-block uniform variables in the program can have
3294 * the same location, even if they are unused, otherwise a compiler
3295 * or linker error will be generated."
3296 */
3297 linker_error(prog,
3298 "location qualifier for uniform %s overlaps "
3299 "previously used location\n",
3300 var->name);
3301 return -1;
3302 }
3303
3304 /* Initialize location as inactive before optimization
3305 * rounds and location assignment.
3306 */
3307 prog->UniformRemapTable[loc] = INACTIVE_UNIFORM_EXPLICIT_LOCATION;
3308 }
3309
3310 /* Note, base location used for arrays. */
3311 map->put(var->data.location, var->name);
3312
3313 return return_value;
3314 }
3315
3316 static bool
3317 reserve_subroutine_explicit_locations(struct gl_shader_program *prog,
3318 struct gl_program *p,
3319 ir_variable *var)
3320 {
3321 unsigned slots = var->type->uniform_locations();
3322 unsigned max_loc = var->data.location + slots - 1;
3323
3324 /* Resize remap table if locations do not fit in the current one. */
3325 if (max_loc + 1 > p->sh.NumSubroutineUniformRemapTable) {
3326 p->sh.SubroutineUniformRemapTable =
3327 reralloc(p, p->sh.SubroutineUniformRemapTable,
3328 gl_uniform_storage *,
3329 max_loc + 1);
3330
3331 if (!p->sh.SubroutineUniformRemapTable) {
3332 linker_error(prog, "Out of memory during linking.\n");
3333 return false;
3334 }
3335
3336 /* Initialize allocated space. */
3337 for (unsigned i = p->sh.NumSubroutineUniformRemapTable; i < max_loc + 1; i++)
3338 p->sh.SubroutineUniformRemapTable[i] = NULL;
3339
3340 p->sh.NumSubroutineUniformRemapTable = max_loc + 1;
3341 }
3342
3343 for (unsigned i = 0; i < slots; i++) {
3344 unsigned loc = var->data.location + i;
3345
3346 /* Check if location is already used. */
3347 if (p->sh.SubroutineUniformRemapTable[loc] == INACTIVE_UNIFORM_EXPLICIT_LOCATION) {
3348
3349 /* ARB_explicit_uniform_location specification states:
3350 * "No two subroutine uniform variables can have the same location
3351 * in the same shader stage, otherwise a compiler or linker error
3352 * will be generated."
3353 */
3354 linker_error(prog,
3355 "location qualifier for uniform %s overlaps "
3356 "previously used location\n",
3357 var->name);
3358 return false;
3359 }
3360
3361 /* Initialize location as inactive before optimization
3362 * rounds and location assignment.
3363 */
3364 p->sh.SubroutineUniformRemapTable[loc] = INACTIVE_UNIFORM_EXPLICIT_LOCATION;
3365 }
3366
3367 return true;
3368 }
3369 /**
3370 * Check and reserve all explicit uniform locations, called before
3371 * any optimizations happen to handle also inactive uniforms and
3372 * inactive array elements that may get trimmed away.
3373 */
3374 static void
3375 check_explicit_uniform_locations(struct gl_context *ctx,
3376 struct gl_shader_program *prog)
3377 {
3378 prog->NumExplicitUniformLocations = 0;
3379
3380 if (!ctx->Extensions.ARB_explicit_uniform_location)
3381 return;
3382
3383 /* This map is used to detect if overlapping explicit locations
3384 * occur with the same uniform (from different stage) or a different one.
3385 */
3386 string_to_uint_map *uniform_map = new string_to_uint_map;
3387
3388 if (!uniform_map) {
3389 linker_error(prog, "Out of memory during linking.\n");
3390 return;
3391 }
3392
3393 unsigned entries_total = 0;
3394 unsigned mask = prog->data->linked_stages;
3395 while (mask) {
3396 const int i = u_bit_scan(&mask);
3397 struct gl_program *p = prog->_LinkedShaders[i]->Program;
3398
3399 foreach_in_list(ir_instruction, node, prog->_LinkedShaders[i]->ir) {
3400 ir_variable *var = node->as_variable();
3401 if (!var || var->data.mode != ir_var_uniform)
3402 continue;
3403
3404 if (var->data.explicit_location) {
3405 bool ret = false;
3406 if (var->type->without_array()->is_subroutine())
3407 ret = reserve_subroutine_explicit_locations(prog, p, var);
3408 else {
3409 int slots = reserve_explicit_locations(prog, uniform_map,
3410 var);
3411 if (slots != -1) {
3412 ret = true;
3413 entries_total += slots;
3414 }
3415 }
3416 if (!ret) {
3417 delete uniform_map;
3418 return;
3419 }
3420 }
3421 }
3422 }
3423
3424 struct empty_uniform_block *current_block = NULL;
3425
3426 for (unsigned i = 0; i < prog->NumUniformRemapTable; i++) {
3427 /* We found empty space in UniformRemapTable. */
3428 if (prog->UniformRemapTable[i] == NULL) {
3429 /* We've found the beginning of a new continous block of empty slots */
3430 if (!current_block || current_block->start + current_block->slots != i) {
3431 current_block = rzalloc(prog, struct empty_uniform_block);
3432 current_block->start = i;
3433 exec_list_push_tail(&prog->EmptyUniformLocations,
3434 &current_block->link);
3435 }
3436
3437 /* The current block continues, so we simply increment its slots */
3438 current_block->slots++;
3439 }
3440 }
3441
3442 delete uniform_map;
3443 prog->NumExplicitUniformLocations = entries_total;
3444 }
3445
3446 static bool
3447 should_add_buffer_variable(struct gl_shader_program *shProg,
3448 GLenum type, const char *name)
3449 {
3450 bool found_interface = false;
3451 unsigned block_name_len = 0;
3452 const char *block_name_dot = strchr(name, '.');
3453
3454 /* These rules only apply to buffer variables. So we return
3455 * true for the rest of types.
3456 */
3457 if (type != GL_BUFFER_VARIABLE)
3458 return true;
3459
3460 for (unsigned i = 0; i < shProg->data->NumShaderStorageBlocks; i++) {
3461 const char *block_name = shProg->data->ShaderStorageBlocks[i].Name;
3462 block_name_len = strlen(block_name);
3463
3464 const char *block_square_bracket = strchr(block_name, '[');
3465 if (block_square_bracket) {
3466 /* The block is part of an array of named interfaces,
3467 * for the name comparison we ignore the "[x]" part.
3468 */
3469 block_name_len -= strlen(block_square_bracket);
3470 }
3471
3472 if (block_name_dot) {
3473 /* Check if the variable name starts with the interface
3474 * name. The interface name (if present) should have the
3475 * length than the interface block name we are comparing to.
3476 */
3477 unsigned len = strlen(name) - strlen(block_name_dot);
3478 if (len != block_name_len)
3479 continue;
3480 }
3481
3482 if (strncmp(block_name, name, block_name_len) == 0) {
3483 found_interface = true;
3484 break;
3485 }
3486 }
3487
3488 /* We remove the interface name from the buffer variable name,
3489 * including the dot that follows it.
3490 */
3491 if (found_interface)
3492 name = name + block_name_len + 1;
3493
3494 /* The ARB_program_interface_query spec says:
3495 *
3496 * "For an active shader storage block member declared as an array, an
3497 * entry will be generated only for the first array element, regardless
3498 * of its type. For arrays of aggregate types, the enumeration rules
3499 * are applied recursively for the single enumerated array element."
3500 */
3501 const char *struct_first_dot = strchr(name, '.');
3502 const char *first_square_bracket = strchr(name, '[');
3503
3504 /* The buffer variable is on top level and it is not an array */
3505 if (!first_square_bracket) {
3506 return true;
3507 /* The shader storage block member is a struct, then generate the entry */
3508 } else if (struct_first_dot && struct_first_dot < first_square_bracket) {
3509 return true;
3510 } else {
3511 /* Shader storage block member is an array, only generate an entry for the
3512 * first array element.
3513 */
3514 if (strncmp(first_square_bracket, "[0]", 3) == 0)
3515 return true;
3516 }
3517
3518 return false;
3519 }
3520
3521 static bool
3522 add_program_resource(struct gl_shader_program *prog,
3523 struct set *resource_set,
3524 GLenum type, const void *data, uint8_t stages)
3525 {
3526 assert(data);
3527
3528 /* If resource already exists, do not add it again. */
3529 if (_mesa_set_search(resource_set, data))
3530 return true;
3531
3532 prog->data->ProgramResourceList =
3533 reralloc(prog,
3534 prog->data->ProgramResourceList,
3535 gl_program_resource,
3536 prog->data->NumProgramResourceList + 1);
3537
3538 if (!prog->data->ProgramResourceList) {
3539 linker_error(prog, "Out of memory during linking.\n");
3540 return false;
3541 }
3542
3543 struct gl_program_resource *res =
3544 &prog->data->ProgramResourceList[prog->data->NumProgramResourceList];
3545
3546 res->Type = type;
3547 res->Data = data;
3548 res->StageReferences = stages;
3549
3550 prog->data->NumProgramResourceList++;
3551
3552 _mesa_set_add(resource_set, data);
3553
3554 return true;
3555 }
3556
3557 /* Function checks if a variable var is a packed varying and
3558 * if given name is part of packed varying's list.
3559 *
3560 * If a variable is a packed varying, it has a name like
3561 * 'packed:a,b,c' where a, b and c are separate variables.
3562 */
3563 static bool
3564 included_in_packed_varying(ir_variable *var, const char *name)
3565 {
3566 if (strncmp(var->name, "packed:", 7) != 0)
3567 return false;
3568
3569 char *list = strdup(var->name + 7);
3570 assert(list);
3571
3572 bool found = false;
3573 char *saveptr;
3574 char *token = strtok_r(list, ",", &saveptr);
3575 while (token) {
3576 if (strcmp(token, name) == 0) {
3577 found = true;
3578 break;
3579 }
3580 token = strtok_r(NULL, ",", &saveptr);
3581 }
3582 free(list);
3583 return found;
3584 }
3585
3586 /**
3587 * Function builds a stage reference bitmask from variable name.
3588 */
3589 static uint8_t
3590 build_stageref(struct gl_shader_program *shProg, const char *name,
3591 unsigned mode)
3592 {
3593 uint8_t stages = 0;
3594
3595 /* Note, that we assume MAX 8 stages, if there will be more stages, type
3596 * used for reference mask in gl_program_resource will need to be changed.
3597 */
3598 assert(MESA_SHADER_STAGES < 8);
3599
3600 for (unsigned i = 0; i < MESA_SHADER_STAGES; i++) {
3601 struct gl_linked_shader *sh = shProg->_LinkedShaders[i];
3602 if (!sh)
3603 continue;
3604
3605 /* Shader symbol table may contain variables that have
3606 * been optimized away. Search IR for the variable instead.
3607 */
3608 foreach_in_list(ir_instruction, node, sh->ir) {
3609 ir_variable *var = node->as_variable();
3610 if (var) {
3611 unsigned baselen = strlen(var->name);
3612
3613 if (included_in_packed_varying(var, name)) {
3614 stages |= (1 << i);
3615 break;
3616 }
3617
3618 /* Type needs to match if specified, otherwise we might
3619 * pick a variable with same name but different interface.
3620 */
3621 if (var->data.mode != mode)
3622 continue;
3623
3624 if (strncmp(var->name, name, baselen) == 0) {
3625 /* Check for exact name matches but also check for arrays and
3626 * structs.
3627 */
3628 if (name[baselen] == '\0' ||
3629 name[baselen] == '[' ||
3630 name[baselen] == '.') {
3631 stages |= (1 << i);
3632 break;
3633 }
3634 }
3635 }
3636 }
3637 }
3638 return stages;
3639 }
3640
3641 /**
3642 * Create gl_shader_variable from ir_variable class.
3643 */
3644 static gl_shader_variable *
3645 create_shader_variable(struct gl_shader_program *shProg,
3646 const ir_variable *in,
3647 const char *name, const glsl_type *type,
3648 const glsl_type *interface_type,
3649 bool use_implicit_location, int location,
3650 const glsl_type *outermost_struct_type)
3651 {
3652 gl_shader_variable *out = ralloc(shProg, struct gl_shader_variable);
3653 if (!out)
3654 return NULL;
3655
3656 /* Since gl_VertexID may be lowered to gl_VertexIDMESA, but applications
3657 * expect to see gl_VertexID in the program resource list. Pretend.
3658 */
3659 if (in->data.mode == ir_var_system_value &&
3660 in->data.location == SYSTEM_VALUE_VERTEX_ID_ZERO_BASE) {
3661 out->name = ralloc_strdup(shProg, "gl_VertexID");
3662 } else if ((in->data.mode == ir_var_shader_out &&
3663 in->data.location == VARYING_SLOT_TESS_LEVEL_OUTER) ||
3664 (in->data.mode == ir_var_system_value &&
3665 in->data.location == SYSTEM_VALUE_TESS_LEVEL_OUTER)) {
3666 out->name = ralloc_strdup(shProg, "gl_TessLevelOuter");
3667 type = glsl_type::get_array_instance(glsl_type::float_type, 4);
3668 } else if ((in->data.mode == ir_var_shader_out &&
3669 in->data.location == VARYING_SLOT_TESS_LEVEL_INNER) ||
3670 (in->data.mode == ir_var_system_value &&
3671 in->data.location == SYSTEM_VALUE_TESS_LEVEL_INNER)) {
3672 out->name = ralloc_strdup(shProg, "gl_TessLevelInner");
3673 type = glsl_type::get_array_instance(glsl_type::float_type, 2);
3674 } else {
3675 out->name = ralloc_strdup(shProg, name);
3676 }
3677
3678 if (!out->name)
3679 return NULL;
3680
3681 /* The ARB_program_interface_query spec says:
3682 *
3683 * "Not all active variables are assigned valid locations; the
3684 * following variables will have an effective location of -1:
3685 *
3686 * * uniforms declared as atomic counters;
3687 *
3688 * * members of a uniform block;
3689 *
3690 * * built-in inputs, outputs, and uniforms (starting with "gl_"); and
3691 *
3692 * * inputs or outputs not declared with a "location" layout
3693 * qualifier, except for vertex shader inputs and fragment shader
3694 * outputs."
3695 */
3696 if (in->type->base_type == GLSL_TYPE_ATOMIC_UINT ||
3697 is_gl_identifier(in->name) ||
3698 !(in->data.explicit_location || use_implicit_location)) {
3699 out->location = -1;
3700 } else {
3701 out->location = location;
3702 }
3703
3704 out->type = type;
3705 out->outermost_struct_type = outermost_struct_type;
3706 out->interface_type = interface_type;
3707 out->component = in->data.location_frac;
3708 out->index = in->data.index;
3709 out->patch = in->data.patch;
3710 out->mode = in->data.mode;
3711 out->interpolation = in->data.interpolation;
3712 out->explicit_location = in->data.explicit_location;
3713 out->precision = in->data.precision;
3714
3715 return out;
3716 }
3717
3718 static const glsl_type *
3719 resize_to_max_patch_vertices(const struct gl_context *ctx,
3720 const glsl_type *type)
3721 {
3722 if (!type)
3723 return NULL;
3724
3725 return glsl_type::get_array_instance(type->fields.array,
3726 ctx->Const.MaxPatchVertices);
3727 }
3728
3729 static bool
3730 add_shader_variable(const struct gl_context *ctx,
3731 struct gl_shader_program *shProg,
3732 struct set *resource_set,
3733 unsigned stage_mask,
3734 GLenum programInterface, ir_variable *var,
3735 const char *name, const glsl_type *type,
3736 bool use_implicit_location, int location,
3737 const glsl_type *outermost_struct_type = NULL)
3738 {
3739 const glsl_type *interface_type = var->get_interface_type();
3740
3741 if (outermost_struct_type == NULL) {
3742 /* Unsized (non-patch) TCS output/TES input arrays are implicitly
3743 * sized to gl_MaxPatchVertices. Internally, we shrink them to a
3744 * smaller size.
3745 *
3746 * This can cause trouble with SSO programs. Since the TCS declares
3747 * the number of output vertices, we can always shrink TCS output
3748 * arrays. However, the TES might not be linked with a TCS, in
3749 * which case it won't know the size of the patch. In other words,
3750 * the TCS and TES may disagree on the (smaller) array sizes. This
3751 * can result in the resource names differing across stages, causing
3752 * SSO validation failures and other cascading issues.
3753 *
3754 * Expanding the array size to the full gl_MaxPatchVertices fixes
3755 * these issues. It's also what program interface queries expect,
3756 * as that is the official size of the array.
3757 */
3758 if (var->data.tess_varying_implicit_sized_array) {
3759 type = resize_to_max_patch_vertices(ctx, type);
3760 interface_type = resize_to_max_patch_vertices(ctx, interface_type);
3761 }
3762
3763 if (var->data.from_named_ifc_block) {
3764 const char *interface_name = interface_type->name;
3765
3766 if (interface_type->is_array()) {
3767 /* Issue #16 of the ARB_program_interface_query spec says:
3768 *
3769 * "* If a variable is a member of an interface block without an
3770 * instance name, it is enumerated using just the variable name.
3771 *
3772 * * If a variable is a member of an interface block with an
3773 * instance name, it is enumerated as "BlockName.Member", where
3774 * "BlockName" is the name of the interface block (not the
3775 * instance name) and "Member" is the name of the variable."
3776 *
3777 * In particular, it indicates that it should be "BlockName",
3778 * not "BlockName[array length]". The conformance suite and
3779 * dEQP both require this behavior.
3780 *
3781 * Here, we unwrap the extra array level added by named interface
3782 * block array lowering so we have the correct variable type. We
3783 * also unwrap the interface type when constructing the name.
3784 *
3785 * We leave interface_type the same so that ES 3.x SSO pipeline
3786 * validation can enforce the rules requiring array length to
3787 * match on interface blocks.
3788 */
3789 type = type->fields.array;
3790
3791 interface_name = interface_type->fields.array->name;
3792 }
3793
3794 name = ralloc_asprintf(shProg, "%s.%s", interface_name, name);
3795 }
3796 }
3797
3798 switch (type->base_type) {
3799 case GLSL_TYPE_STRUCT: {
3800 /* The ARB_program_interface_query spec says:
3801 *
3802 * "For an active variable declared as a structure, a separate entry
3803 * will be generated for each active structure member. The name of
3804 * each entry is formed by concatenating the name of the structure,
3805 * the "." character, and the name of the structure member. If a
3806 * structure member to enumerate is itself a structure or array,
3807 * these enumeration rules are applied recursively."
3808 */
3809 if (outermost_struct_type == NULL)
3810 outermost_struct_type = type;
3811
3812 unsigned field_location = location;
3813 for (unsigned i = 0; i < type->length; i++) {
3814 const struct glsl_struct_field *field = &type->fields.structure[i];
3815 char *field_name = ralloc_asprintf(shProg, "%s.%s", name, field->name);
3816 if (!add_shader_variable(ctx, shProg, resource_set,
3817 stage_mask, programInterface,
3818 var, field_name, field->type,
3819 use_implicit_location, field_location,
3820 outermost_struct_type))
3821 return false;
3822
3823 field_location += field->type->count_attribute_slots(false);
3824 }
3825 return true;
3826 }
3827
3828 default: {
3829 /* The ARB_program_interface_query spec says:
3830 *
3831 * "For an active variable declared as a single instance of a basic
3832 * type, a single entry will be generated, using the variable name
3833 * from the shader source."
3834 */
3835 gl_shader_variable *sha_v =
3836 create_shader_variable(shProg, var, name, type, interface_type,
3837 use_implicit_location, location,
3838 outermost_struct_type);
3839 if (!sha_v)
3840 return false;
3841
3842 return add_program_resource(shProg, resource_set,
3843 programInterface, sha_v, stage_mask);
3844 }
3845 }
3846 }
3847
3848 static bool
3849 add_interface_variables(const struct gl_context *ctx,
3850 struct gl_shader_program *shProg,
3851 struct set *resource_set,
3852 unsigned stage, GLenum programInterface)
3853 {
3854 exec_list *ir = shProg->_LinkedShaders[stage]->ir;
3855
3856 foreach_in_list(ir_instruction, node, ir) {
3857 ir_variable *var = node->as_variable();
3858
3859 if (!var || var->data.how_declared == ir_var_hidden)
3860 continue;
3861
3862 int loc_bias;
3863
3864 switch (var->data.mode) {
3865 case ir_var_system_value:
3866 case ir_var_shader_in:
3867 if (programInterface != GL_PROGRAM_INPUT)
3868 continue;
3869 loc_bias = (stage == MESA_SHADER_VERTEX) ? int(VERT_ATTRIB_GENERIC0)
3870 : int(VARYING_SLOT_VAR0);
3871 break;
3872 case ir_var_shader_out:
3873 if (programInterface != GL_PROGRAM_OUTPUT)
3874 continue;
3875 loc_bias = (stage == MESA_SHADER_FRAGMENT) ? int(FRAG_RESULT_DATA0)
3876 : int(VARYING_SLOT_VAR0);
3877 break;
3878 default:
3879 continue;
3880 };
3881
3882 if (var->data.patch)
3883 loc_bias = int(VARYING_SLOT_PATCH0);
3884
3885 /* Skip packed varyings, packed varyings are handled separately
3886 * by add_packed_varyings.
3887 */
3888 if (strncmp(var->name, "packed:", 7) == 0)
3889 continue;
3890
3891 /* Skip fragdata arrays, these are handled separately
3892 * by add_fragdata_arrays.
3893 */
3894 if (strncmp(var->name, "gl_out_FragData", 15) == 0)
3895 continue;
3896
3897 const bool vs_input_or_fs_output =
3898 (stage == MESA_SHADER_VERTEX && var->data.mode == ir_var_shader_in) ||
3899 (stage == MESA_SHADER_FRAGMENT && var->data.mode == ir_var_shader_out);
3900
3901 if (!add_shader_variable(ctx, shProg, resource_set,
3902 1 << stage, programInterface,
3903 var, var->name, var->type, vs_input_or_fs_output,
3904 var->data.location - loc_bias))
3905 return false;
3906 }
3907 return true;
3908 }
3909
3910 static bool
3911 add_packed_varyings(const struct gl_context *ctx,
3912 struct gl_shader_program *shProg,
3913 struct set *resource_set,
3914 int stage, GLenum type)
3915 {
3916 struct gl_linked_shader *sh = shProg->_LinkedShaders[stage];
3917 GLenum iface;
3918
3919 if (!sh || !sh->packed_varyings)
3920 return true;
3921
3922 foreach_in_list(ir_instruction, node, sh->packed_varyings) {
3923 ir_variable *var = node->as_variable();
3924 if (var) {
3925 switch (var->data.mode) {
3926 case ir_var_shader_in:
3927 iface = GL_PROGRAM_INPUT;
3928 break;
3929 case ir_var_shader_out:
3930 iface = GL_PROGRAM_OUTPUT;
3931 break;
3932 default:
3933 unreachable("unexpected type");
3934 }
3935
3936 if (type == iface) {
3937 const int stage_mask =
3938 build_stageref(shProg, var->name, var->data.mode);
3939 if (!add_shader_variable(ctx, shProg, resource_set,
3940 stage_mask,
3941 iface, var, var->name, var->type, false,
3942 var->data.location - VARYING_SLOT_VAR0))
3943 return false;
3944 }
3945 }
3946 }
3947 return true;
3948 }
3949
3950 static bool
3951 add_fragdata_arrays(const struct gl_context *ctx,
3952 struct gl_shader_program *shProg,
3953 struct set *resource_set)
3954 {
3955 struct gl_linked_shader *sh = shProg->_LinkedShaders[MESA_SHADER_FRAGMENT];
3956
3957 if (!sh || !sh->fragdata_arrays)
3958 return true;
3959
3960 foreach_in_list(ir_instruction, node, sh->fragdata_arrays) {
3961 ir_variable *var = node->as_variable();
3962 if (var) {
3963 assert(var->data.mode == ir_var_shader_out);
3964
3965 if (!add_shader_variable(ctx, shProg, resource_set,
3966 1 << MESA_SHADER_FRAGMENT,
3967 GL_PROGRAM_OUTPUT, var, var->name, var->type,
3968 true, var->data.location - FRAG_RESULT_DATA0))
3969 return false;
3970 }
3971 }
3972 return true;
3973 }
3974
3975 static char*
3976 get_top_level_name(const char *name)
3977 {
3978 const char *first_dot = strchr(name, '.');
3979 const char *first_square_bracket = strchr(name, '[');
3980 int name_size = 0;
3981
3982 /* The ARB_program_interface_query spec says:
3983 *
3984 * "For the property TOP_LEVEL_ARRAY_SIZE, a single integer identifying
3985 * the number of active array elements of the top-level shader storage
3986 * block member containing to the active variable is written to
3987 * <params>. If the top-level block member is not declared as an
3988 * array, the value one is written to <params>. If the top-level block
3989 * member is an array with no declared size, the value zero is written
3990 * to <params>."
3991 */
3992
3993 /* The buffer variable is on top level.*/
3994 if (!first_square_bracket && !first_dot)
3995 name_size = strlen(name);
3996 else if ((!first_square_bracket ||
3997 (first_dot && first_dot < first_square_bracket)))
3998 name_size = first_dot - name;
3999 else
4000 name_size = first_square_bracket - name;
4001
4002 return strndup(name, name_size);
4003 }
4004
4005 static char*
4006 get_var_name(const char *name)
4007 {
4008 const char *first_dot = strchr(name, '.');
4009
4010 if (!first_dot)
4011 return strdup(name);
4012
4013 return strndup(first_dot+1, strlen(first_dot) - 1);
4014 }
4015
4016 static bool
4017 is_top_level_shader_storage_block_member(const char* name,
4018 const char* interface_name,
4019 const char* field_name)
4020 {
4021 bool result = false;
4022
4023 /* If the given variable is already a top-level shader storage
4024 * block member, then return array_size = 1.
4025 * We could have two possibilities: if we have an instanced
4026 * shader storage block or not instanced.
4027 *
4028 * For the first, we check create a name as it was in top level and
4029 * compare it with the real name. If they are the same, then
4030 * the variable is already at top-level.
4031 *
4032 * Full instanced name is: interface name + '.' + var name +
4033 * NULL character
4034 */
4035 int name_length = strlen(interface_name) + 1 + strlen(field_name) + 1;
4036 char *full_instanced_name = (char *) calloc(name_length, sizeof(char));
4037 if (!full_instanced_name) {
4038 fprintf(stderr, "%s: Cannot allocate space for name\n", __func__);
4039 return false;
4040 }
4041
4042 snprintf(full_instanced_name, name_length, "%s.%s",
4043 interface_name, field_name);
4044
4045 /* Check if its top-level shader storage block member of an
4046 * instanced interface block, or of a unnamed interface block.
4047 */
4048 if (strcmp(name, full_instanced_name) == 0 ||
4049 strcmp(name, field_name) == 0)
4050 result = true;
4051
4052 free(full_instanced_name);
4053 return result;
4054 }
4055
4056 static int
4057 get_array_size(struct gl_uniform_storage *uni, const glsl_struct_field *field,
4058 char *interface_name, char *var_name)
4059 {
4060 /* The ARB_program_interface_query spec says:
4061 *
4062 * "For the property TOP_LEVEL_ARRAY_SIZE, a single integer identifying
4063 * the number of active array elements of the top-level shader storage
4064 * block member containing to the active variable is written to
4065 * <params>. If the top-level block member is not declared as an
4066 * array, the value one is written to <params>. If the top-level block
4067 * member is an array with no declared size, the value zero is written
4068 * to <params>."
4069 */
4070 if (is_top_level_shader_storage_block_member(uni->name,
4071 interface_name,
4072 var_name))
4073 return 1;
4074 else if (field->type->is_unsized_array())
4075 return 0;
4076 else if (field->type->is_array())
4077 return field->type->length;
4078
4079 return 1;
4080 }
4081
4082 static int
4083 get_array_stride(struct gl_uniform_storage *uni, const glsl_type *interface,
4084 const glsl_struct_field *field, char *interface_name,
4085 char *var_name)
4086 {
4087 /* The ARB_program_interface_query spec says:
4088 *
4089 * "For the property TOP_LEVEL_ARRAY_STRIDE, a single integer
4090 * identifying the stride between array elements of the top-level
4091 * shader storage block member containing the active variable is
4092 * written to <params>. For top-level block members declared as
4093 * arrays, the value written is the difference, in basic machine units,
4094 * between the offsets of the active variable for consecutive elements
4095 * in the top-level array. For top-level block members not declared as
4096 * an array, zero is written to <params>."
4097 */
4098 if (field->type->is_array()) {
4099 const enum glsl_matrix_layout matrix_layout =
4100 glsl_matrix_layout(field->matrix_layout);
4101 bool row_major = matrix_layout == GLSL_MATRIX_LAYOUT_ROW_MAJOR;
4102 const glsl_type *array_type = field->type->fields.array;
4103
4104 if (is_top_level_shader_storage_block_member(uni->name,
4105 interface_name,
4106 var_name))
4107 return 0;
4108
4109 if (interface->interface_packing != GLSL_INTERFACE_PACKING_STD430) {
4110 if (array_type->is_record() || array_type->is_array())
4111 return glsl_align(array_type->std140_size(row_major), 16);
4112 else
4113 return MAX2(array_type->std140_base_alignment(row_major), 16);
4114 } else {
4115 return array_type->std430_array_stride(row_major);
4116 }
4117 }
4118 return 0;
4119 }
4120
4121 static void
4122 calculate_array_size_and_stride(struct gl_shader_program *shProg,
4123 struct gl_uniform_storage *uni)
4124 {
4125 int block_index = uni->block_index;
4126 int array_size = -1;
4127 int array_stride = -1;
4128 char *var_name = get_top_level_name(uni->name);
4129 char *interface_name =
4130 get_top_level_name(uni->is_shader_storage ?
4131 shProg->data->ShaderStorageBlocks[block_index].Name :
4132 shProg->data->UniformBlocks[block_index].Name);
4133
4134 if (strcmp(var_name, interface_name) == 0) {
4135 /* Deal with instanced array of SSBOs */
4136 char *temp_name = get_var_name(uni->name);
4137 if (!temp_name) {
4138 linker_error(shProg, "Out of memory during linking.\n");
4139 goto write_top_level_array_size_and_stride;
4140 }
4141 free(var_name);
4142 var_name = get_top_level_name(temp_name);
4143 free(temp_name);
4144 if (!var_name) {
4145 linker_error(shProg, "Out of memory during linking.\n");
4146 goto write_top_level_array_size_and_stride;
4147 }
4148 }
4149
4150 for (unsigned i = 0; i < MESA_SHADER_STAGES; i++) {
4151 const gl_linked_shader *sh = shProg->_LinkedShaders[i];
4152 if (sh == NULL)
4153 continue;
4154
4155 foreach_in_list(ir_instruction, node, sh->ir) {
4156 ir_variable *var = node->as_variable();
4157 if (!var || !var->get_interface_type() ||
4158 var->data.mode != ir_var_shader_storage)
4159 continue;
4160
4161 const glsl_type *interface = var->get_interface_type();
4162
4163 if (strcmp(interface_name, interface->name) != 0)
4164 continue;
4165
4166 for (unsigned i = 0; i < interface->length; i++) {
4167 const glsl_struct_field *field = &interface->fields.structure[i];
4168 if (strcmp(field->name, var_name) != 0)
4169 continue;
4170
4171 array_stride = get_array_stride(uni, interface, field,
4172 interface_name, var_name);
4173 array_size = get_array_size(uni, field, interface_name, var_name);
4174 goto write_top_level_array_size_and_stride;
4175 }
4176 }
4177 }
4178 write_top_level_array_size_and_stride:
4179 free(interface_name);
4180 free(var_name);
4181 uni->top_level_array_stride = array_stride;
4182 uni->top_level_array_size = array_size;
4183 }
4184
4185 /**
4186 * Builds up a list of program resources that point to existing
4187 * resource data.
4188 */
4189 void
4190 build_program_resource_list(struct gl_context *ctx,
4191 struct gl_shader_program *shProg)
4192 {
4193 /* Rebuild resource list. */
4194 if (shProg->data->ProgramResourceList) {
4195 ralloc_free(shProg->data->ProgramResourceList);
4196 shProg->data->ProgramResourceList = NULL;
4197 shProg->data->NumProgramResourceList = 0;
4198 }
4199
4200 int input_stage = MESA_SHADER_STAGES, output_stage = 0;
4201
4202 /* Determine first input and final output stage. These are used to
4203 * detect which variables should be enumerated in the resource list
4204 * for GL_PROGRAM_INPUT and GL_PROGRAM_OUTPUT.
4205 */
4206 for (unsigned i = 0; i < MESA_SHADER_STAGES; i++) {
4207 if (!shProg->_LinkedShaders[i])
4208 continue;
4209 if (input_stage == MESA_SHADER_STAGES)
4210 input_stage = i;
4211 output_stage = i;
4212 }
4213
4214 /* Empty shader, no resources. */
4215 if (input_stage == MESA_SHADER_STAGES && output_stage == 0)
4216 return;
4217
4218 struct set *resource_set = _mesa_set_create(NULL,
4219 _mesa_hash_pointer,
4220 _mesa_key_pointer_equal);
4221
4222 /* Program interface needs to expose varyings in case of SSO. */
4223 if (shProg->SeparateShader) {
4224 if (!add_packed_varyings(ctx, shProg, resource_set,
4225 input_stage, GL_PROGRAM_INPUT))
4226 return;
4227
4228 if (!add_packed_varyings(ctx, shProg, resource_set,
4229 output_stage, GL_PROGRAM_OUTPUT))
4230 return;
4231 }
4232
4233 if (!add_fragdata_arrays(ctx, shProg, resource_set))
4234 return;
4235
4236 /* Add inputs and outputs to the resource list. */
4237 if (!add_interface_variables(ctx, shProg, resource_set,
4238 input_stage, GL_PROGRAM_INPUT))
4239 return;
4240
4241 if (!add_interface_variables(ctx, shProg, resource_set,
4242 output_stage, GL_PROGRAM_OUTPUT))
4243 return;
4244
4245 struct gl_transform_feedback_info *linked_xfb =
4246 shProg->xfb_program->sh.LinkedTransformFeedback;
4247
4248 /* Add transform feedback varyings. */
4249 if (linked_xfb->NumVarying > 0) {
4250 for (int i = 0; i < linked_xfb->NumVarying; i++) {
4251 if (!add_program_resource(shProg, resource_set,
4252 GL_TRANSFORM_FEEDBACK_VARYING,
4253 &linked_xfb->Varyings[i], 0))
4254 return;
4255 }
4256 }
4257
4258 /* Add transform feedback buffers. */
4259 for (unsigned i = 0; i < ctx->Const.MaxTransformFeedbackBuffers; i++) {
4260 if ((linked_xfb->ActiveBuffers >> i) & 1) {
4261 linked_xfb->Buffers[i].Binding = i;
4262 if (!add_program_resource(shProg, resource_set,
4263 GL_TRANSFORM_FEEDBACK_BUFFER,
4264 &linked_xfb->Buffers[i], 0))
4265 return;
4266 }
4267 }
4268
4269 /* Add uniforms from uniform storage. */
4270 for (unsigned i = 0; i < shProg->data->NumUniformStorage; i++) {
4271 /* Do not add uniforms internally used by Mesa. */
4272 if (shProg->data->UniformStorage[i].hidden)
4273 continue;
4274
4275 uint8_t stageref =
4276 build_stageref(shProg, shProg->data->UniformStorage[i].name,
4277 ir_var_uniform);
4278
4279 /* Add stagereferences for uniforms in a uniform block. */
4280 bool is_shader_storage =
4281 shProg->data->UniformStorage[i].is_shader_storage;
4282 int block_index = shProg->data->UniformStorage[i].block_index;
4283 if (block_index != -1) {
4284 stageref |= is_shader_storage ?
4285 shProg->data->ShaderStorageBlocks[block_index].stageref :
4286 shProg->data->UniformBlocks[block_index].stageref;
4287 }
4288
4289 GLenum type = is_shader_storage ? GL_BUFFER_VARIABLE : GL_UNIFORM;
4290 if (!should_add_buffer_variable(shProg, type,
4291 shProg->data->UniformStorage[i].name))
4292 continue;
4293
4294 if (is_shader_storage) {
4295 calculate_array_size_and_stride(shProg,
4296 &shProg->data->UniformStorage[i]);
4297 }
4298
4299 if (!add_program_resource(shProg, resource_set, type,
4300 &shProg->data->UniformStorage[i], stageref))
4301 return;
4302 }
4303
4304 /* Add program uniform blocks. */
4305 for (unsigned i = 0; i < shProg->data->NumUniformBlocks; i++) {
4306 if (!add_program_resource(shProg, resource_set, GL_UNIFORM_BLOCK,
4307 &shProg->data->UniformBlocks[i], 0))
4308 return;
4309 }
4310
4311 /* Add program shader storage blocks. */
4312 for (unsigned i = 0; i < shProg->data->NumShaderStorageBlocks; i++) {
4313 if (!add_program_resource(shProg, resource_set, GL_SHADER_STORAGE_BLOCK,
4314 &shProg->data->ShaderStorageBlocks[i], 0))
4315 return;
4316 }
4317
4318 /* Add atomic counter buffers. */
4319 for (unsigned i = 0; i < shProg->data->NumAtomicBuffers; i++) {
4320 if (!add_program_resource(shProg, resource_set, GL_ATOMIC_COUNTER_BUFFER,
4321 &shProg->data->AtomicBuffers[i], 0))
4322 return;
4323 }
4324
4325 for (unsigned i = 0; i < shProg->data->NumUniformStorage; i++) {
4326 GLenum type;
4327 if (!shProg->data->UniformStorage[i].hidden)
4328 continue;
4329
4330 for (int j = MESA_SHADER_VERTEX; j < MESA_SHADER_STAGES; j++) {
4331 if (!shProg->data->UniformStorage[i].opaque[j].active ||
4332 !shProg->data->UniformStorage[i].type->is_subroutine())
4333 continue;
4334
4335 type = _mesa_shader_stage_to_subroutine_uniform((gl_shader_stage)j);
4336 /* add shader subroutines */
4337 if (!add_program_resource(shProg, resource_set,
4338 type, &shProg->data->UniformStorage[i], 0))
4339 return;
4340 }
4341 }
4342
4343 unsigned mask = shProg->data->linked_stages;
4344 while (mask) {
4345 const int i = u_bit_scan(&mask);
4346 struct gl_program *p = shProg->_LinkedShaders[i]->Program;
4347
4348 GLuint type = _mesa_shader_stage_to_subroutine((gl_shader_stage)i);
4349 for (unsigned j = 0; j < p->sh.NumSubroutineFunctions; j++) {
4350 if (!add_program_resource(shProg, resource_set,
4351 type, &p->sh.SubroutineFunctions[j], 0))
4352 return;
4353 }
4354 }
4355
4356 _mesa_set_destroy(resource_set, NULL);
4357 }
4358
4359 /**
4360 * This check is done to make sure we allow only constant expression
4361 * indexing and "constant-index-expression" (indexing with an expression
4362 * that includes loop induction variable).
4363 */
4364 static bool
4365 validate_sampler_array_indexing(struct gl_context *ctx,
4366 struct gl_shader_program *prog)
4367 {
4368 dynamic_sampler_array_indexing_visitor v;
4369 for (unsigned i = 0; i < MESA_SHADER_STAGES; i++) {
4370 if (prog->_LinkedShaders[i] == NULL)
4371 continue;
4372
4373 bool no_dynamic_indexing =
4374 ctx->Const.ShaderCompilerOptions[i].EmitNoIndirectSampler;
4375
4376 /* Search for array derefs in shader. */
4377 v.run(prog->_LinkedShaders[i]->ir);
4378 if (v.uses_dynamic_sampler_array_indexing()) {
4379 const char *msg = "sampler arrays indexed with non-constant "
4380 "expressions is forbidden in GLSL %s %u";
4381 /* Backend has indicated that it has no dynamic indexing support. */
4382 if (no_dynamic_indexing) {
4383 linker_error(prog, msg, prog->IsES ? "ES" : "",
4384 prog->data->Version);
4385 return false;
4386 } else {
4387 linker_warning(prog, msg, prog->IsES ? "ES" : "",
4388 prog->data->Version);
4389 }
4390 }
4391 }
4392 return true;
4393 }
4394
4395 static void
4396 link_assign_subroutine_types(struct gl_shader_program *prog)
4397 {
4398 unsigned mask = prog->data->linked_stages;
4399 while (mask) {
4400 const int i = u_bit_scan(&mask);
4401 gl_program *p = prog->_LinkedShaders[i]->Program;
4402
4403 p->sh.MaxSubroutineFunctionIndex = 0;
4404 foreach_in_list(ir_instruction, node, prog->_LinkedShaders[i]->ir) {
4405 ir_function *fn = node->as_function();
4406 if (!fn)
4407 continue;
4408
4409 if (fn->is_subroutine)
4410 p->sh.NumSubroutineUniformTypes++;
4411
4412 if (!fn->num_subroutine_types)
4413 continue;
4414
4415 /* these should have been calculated earlier. */
4416 assert(fn->subroutine_index != -1);
4417 if (p->sh.NumSubroutineFunctions + 1 > MAX_SUBROUTINES) {
4418 linker_error(prog, "Too many subroutine functions declared.\n");
4419 return;
4420 }
4421 p->sh.SubroutineFunctions = reralloc(p, p->sh.SubroutineFunctions,
4422 struct gl_subroutine_function,
4423 p->sh.NumSubroutineFunctions + 1);
4424 p->sh.SubroutineFunctions[p->sh.NumSubroutineFunctions].name = ralloc_strdup(p, fn->name);
4425 p->sh.SubroutineFunctions[p->sh.NumSubroutineFunctions].num_compat_types = fn->num_subroutine_types;
4426 p->sh.SubroutineFunctions[p->sh.NumSubroutineFunctions].types =
4427 ralloc_array(p, const struct glsl_type *,
4428 fn->num_subroutine_types);
4429
4430 /* From Section 4.4.4(Subroutine Function Layout Qualifiers) of the
4431 * GLSL 4.5 spec:
4432 *
4433 * "Each subroutine with an index qualifier in the shader must be
4434 * given a unique index, otherwise a compile or link error will be
4435 * generated."
4436 */
4437 for (unsigned j = 0; j < p->sh.NumSubroutineFunctions; j++) {
4438 if (p->sh.SubroutineFunctions[j].index != -1 &&
4439 p->sh.SubroutineFunctions[j].index == fn->subroutine_index) {
4440 linker_error(prog, "each subroutine index qualifier in the "
4441 "shader must be unique\n");
4442 return;
4443 }
4444 }
4445 p->sh.SubroutineFunctions[p->sh.NumSubroutineFunctions].index =
4446 fn->subroutine_index;
4447
4448 if (fn->subroutine_index > (int)p->sh.MaxSubroutineFunctionIndex)
4449 p->sh.MaxSubroutineFunctionIndex = fn->subroutine_index;
4450
4451 for (int j = 0; j < fn->num_subroutine_types; j++)
4452 p->sh.SubroutineFunctions[p->sh.NumSubroutineFunctions].types[j] = fn->subroutine_types[j];
4453 p->sh.NumSubroutineFunctions++;
4454 }
4455 }
4456 }
4457
4458 static void
4459 set_always_active_io(exec_list *ir, ir_variable_mode io_mode)
4460 {
4461 assert(io_mode == ir_var_shader_in || io_mode == ir_var_shader_out);
4462
4463 foreach_in_list(ir_instruction, node, ir) {
4464 ir_variable *const var = node->as_variable();
4465
4466 if (var == NULL || var->data.mode != io_mode)
4467 continue;
4468
4469 /* Don't set always active on builtins that haven't been redeclared */
4470 if (var->data.how_declared == ir_var_declared_implicitly)
4471 continue;
4472
4473 var->data.always_active_io = true;
4474 }
4475 }
4476
4477 /**
4478 * When separate shader programs are enabled, only input/outputs between
4479 * the stages of a multi-stage separate program can be safely removed
4480 * from the shader interface. Other inputs/outputs must remain active.
4481 */
4482 static void
4483 disable_varying_optimizations_for_sso(struct gl_shader_program *prog)
4484 {
4485 unsigned first, last;
4486 assert(prog->SeparateShader);
4487
4488 first = MESA_SHADER_STAGES;
4489 last = 0;
4490
4491 /* Determine first and last stage. Excluding the compute stage */
4492 for (unsigned i = 0; i < MESA_SHADER_COMPUTE; i++) {
4493 if (!prog->_LinkedShaders[i])
4494 continue;
4495 if (first == MESA_SHADER_STAGES)
4496 first = i;
4497 last = i;
4498 }
4499
4500 if (first == MESA_SHADER_STAGES)
4501 return;
4502
4503 for (unsigned stage = 0; stage < MESA_SHADER_STAGES; stage++) {
4504 gl_linked_shader *sh = prog->_LinkedShaders[stage];
4505 if (!sh)
4506 continue;
4507
4508 if (first == last) {
4509 /* For a single shader program only allow inputs to the vertex shader
4510 * and outputs from the fragment shader to be removed.
4511 */
4512 if (stage != MESA_SHADER_VERTEX)
4513 set_always_active_io(sh->ir, ir_var_shader_in);
4514 if (stage != MESA_SHADER_FRAGMENT)
4515 set_always_active_io(sh->ir, ir_var_shader_out);
4516 } else {
4517 /* For multi-stage separate shader programs only allow inputs and
4518 * outputs between the shader stages to be removed as well as inputs
4519 * to the vertex shader and outputs from the fragment shader.
4520 */
4521 if (stage == first && stage != MESA_SHADER_VERTEX)
4522 set_always_active_io(sh->ir, ir_var_shader_in);
4523 else if (stage == last && stage != MESA_SHADER_FRAGMENT)
4524 set_always_active_io(sh->ir, ir_var_shader_out);
4525 }
4526 }
4527 }
4528
4529 static void
4530 link_and_validate_uniforms(struct gl_context *ctx,
4531 struct gl_shader_program *prog)
4532 {
4533 update_array_sizes(prog);
4534 link_assign_uniform_locations(prog, ctx);
4535
4536 link_assign_atomic_counter_resources(ctx, prog);
4537 link_calculate_subroutine_compat(prog);
4538 check_resources(ctx, prog);
4539 check_subroutine_resources(prog);
4540 check_image_resources(ctx, prog);
4541 link_check_atomic_counter_resources(ctx, prog);
4542 }
4543
4544 static bool
4545 link_varyings_and_uniforms(unsigned first, unsigned last,
4546 struct gl_context *ctx,
4547 struct gl_shader_program *prog, void *mem_ctx)
4548 {
4549 /* Mark all generic shader inputs and outputs as unpaired. */
4550 for (unsigned i = MESA_SHADER_VERTEX; i <= MESA_SHADER_FRAGMENT; i++) {
4551 if (prog->_LinkedShaders[i] != NULL) {
4552 link_invalidate_variable_locations(prog->_LinkedShaders[i]->ir);
4553 }
4554 }
4555
4556 unsigned prev = first;
4557 for (unsigned i = prev + 1; i <= MESA_SHADER_FRAGMENT; i++) {
4558 if (prog->_LinkedShaders[i] == NULL)
4559 continue;
4560
4561 match_explicit_outputs_to_inputs(prog->_LinkedShaders[prev],
4562 prog->_LinkedShaders[i]);
4563 prev = i;
4564 }
4565
4566 if (!assign_attribute_or_color_locations(mem_ctx, prog, &ctx->Const,
4567 MESA_SHADER_VERTEX)) {
4568 return false;
4569 }
4570
4571 if (!assign_attribute_or_color_locations(mem_ctx, prog, &ctx->Const,
4572 MESA_SHADER_FRAGMENT)) {
4573 return false;
4574 }
4575
4576 /* Find the program used for xfb. Even if we don't use xfb we still want to
4577 * set this so we can fill the default values for program interface query.
4578 */
4579 prog->xfb_program = prog->_LinkedShaders[last]->Program;
4580 for (int i = MESA_SHADER_GEOMETRY; i >= MESA_SHADER_VERTEX; i--) {
4581 if (prog->_LinkedShaders[i] == NULL)
4582 continue;
4583
4584 prog->xfb_program = prog->_LinkedShaders[i]->Program;
4585 break;
4586 }
4587
4588 if (!link_varyings(prog, first, last, ctx, mem_ctx))
4589 return false;
4590
4591 link_and_validate_uniforms(ctx, prog);
4592
4593 if (!prog->data->LinkStatus)
4594 return false;
4595
4596 for (unsigned i = 0; i < MESA_SHADER_STAGES; i++) {
4597 if (prog->_LinkedShaders[i] == NULL)
4598 continue;
4599
4600 const struct gl_shader_compiler_options *options =
4601 &ctx->Const.ShaderCompilerOptions[i];
4602
4603 if (options->LowerBufferInterfaceBlocks)
4604 lower_ubo_reference(prog->_LinkedShaders[i],
4605 options->ClampBlockIndicesToArrayBounds);
4606
4607 if (i == MESA_SHADER_COMPUTE)
4608 lower_shared_reference(prog->_LinkedShaders[i],
4609 &prog->Comp.SharedSize);
4610
4611 lower_vector_derefs(prog->_LinkedShaders[i]);
4612 do_vec_index_to_swizzle(prog->_LinkedShaders[i]->ir);
4613 }
4614
4615 return true;
4616 }
4617
4618 void
4619 link_shaders(struct gl_context *ctx, struct gl_shader_program *prog)
4620 {
4621 prog->data->LinkStatus = true; /* All error paths will set this to false */
4622 prog->data->Validated = false;
4623
4624 /* Section 7.3 (Program Objects) of the OpenGL 4.5 Core Profile spec says:
4625 *
4626 * "Linking can fail for a variety of reasons as specified in the
4627 * OpenGL Shading Language Specification, as well as any of the
4628 * following reasons:
4629 *
4630 * - No shader objects are attached to program."
4631 *
4632 * The Compatibility Profile specification does not list the error. In
4633 * Compatibility Profile missing shader stages are replaced by
4634 * fixed-function. This applies to the case where all stages are
4635 * missing.
4636 */
4637 if (prog->NumShaders == 0) {
4638 if (ctx->API != API_OPENGL_COMPAT)
4639 linker_error(prog, "no shaders attached to the program\n");
4640 return;
4641 }
4642
4643 void *mem_ctx = ralloc_context(NULL); // temporary linker context
4644
4645 prog->ARB_fragment_coord_conventions_enable = false;
4646
4647 /* Separate the shaders into groups based on their type.
4648 */
4649 struct gl_shader **shader_list[MESA_SHADER_STAGES];
4650 unsigned num_shaders[MESA_SHADER_STAGES];
4651
4652 for (int i = 0; i < MESA_SHADER_STAGES; i++) {
4653 shader_list[i] = (struct gl_shader **)
4654 calloc(prog->NumShaders, sizeof(struct gl_shader *));
4655 num_shaders[i] = 0;
4656 }
4657
4658 unsigned min_version = UINT_MAX;
4659 unsigned max_version = 0;
4660 for (unsigned i = 0; i < prog->NumShaders; i++) {
4661 min_version = MIN2(min_version, prog->Shaders[i]->Version);
4662 max_version = MAX2(max_version, prog->Shaders[i]->Version);
4663
4664 if (prog->Shaders[i]->IsES != prog->Shaders[0]->IsES) {
4665 linker_error(prog, "all shaders must use same shading "
4666 "language version\n");
4667 goto done;
4668 }
4669
4670 if (prog->Shaders[i]->ARB_fragment_coord_conventions_enable) {
4671 prog->ARB_fragment_coord_conventions_enable = true;
4672 }
4673
4674 gl_shader_stage shader_type = prog->Shaders[i]->Stage;
4675 shader_list[shader_type][num_shaders[shader_type]] = prog->Shaders[i];
4676 num_shaders[shader_type]++;
4677 }
4678
4679 /* In desktop GLSL, different shader versions may be linked together. In
4680 * GLSL ES, all shader versions must be the same.
4681 */
4682 if (prog->Shaders[0]->IsES && min_version != max_version) {
4683 linker_error(prog, "all shaders must use same shading "
4684 "language version\n");
4685 goto done;
4686 }
4687
4688 prog->data->Version = max_version;
4689 prog->IsES = prog->Shaders[0]->IsES;
4690
4691 /* Some shaders have to be linked with some other shaders present.
4692 */
4693 if (!prog->SeparateShader) {
4694 if (num_shaders[MESA_SHADER_GEOMETRY] > 0 &&
4695 num_shaders[MESA_SHADER_VERTEX] == 0) {
4696 linker_error(prog, "Geometry shader must be linked with "
4697 "vertex shader\n");
4698 goto done;
4699 }
4700 if (num_shaders[MESA_SHADER_TESS_EVAL] > 0 &&
4701 num_shaders[MESA_SHADER_VERTEX] == 0) {
4702 linker_error(prog, "Tessellation evaluation shader must be linked "
4703 "with vertex shader\n");
4704 goto done;
4705 }
4706 if (num_shaders[MESA_SHADER_TESS_CTRL] > 0 &&
4707 num_shaders[MESA_SHADER_VERTEX] == 0) {
4708 linker_error(prog, "Tessellation control shader must be linked with "
4709 "vertex shader\n");
4710 goto done;
4711 }
4712
4713 /* The spec is self-contradictory here. It allows linking without a tess
4714 * eval shader, but that can only be used with transform feedback and
4715 * rasterization disabled. However, transform feedback isn't allowed
4716 * with GL_PATCHES, so it can't be used.
4717 *
4718 * More investigation showed that the idea of transform feedback after
4719 * a tess control shader was dropped, because some hw vendors couldn't
4720 * support tessellation without a tess eval shader, but the linker
4721 * section wasn't updated to reflect that.
4722 *
4723 * All specifications (ARB_tessellation_shader, GL 4.0-4.5) have this
4724 * spec bug.
4725 *
4726 * Do what's reasonable and always require a tess eval shader if a tess
4727 * control shader is present.
4728 */
4729 if (num_shaders[MESA_SHADER_TESS_CTRL] > 0 &&
4730 num_shaders[MESA_SHADER_TESS_EVAL] == 0) {
4731 linker_error(prog, "Tessellation control shader must be linked with "
4732 "tessellation evaluation shader\n");
4733 goto done;
4734 }
4735 }
4736
4737 /* Compute shaders have additional restrictions. */
4738 if (num_shaders[MESA_SHADER_COMPUTE] > 0 &&
4739 num_shaders[MESA_SHADER_COMPUTE] != prog->NumShaders) {
4740 linker_error(prog, "Compute shaders may not be linked with any other "
4741 "type of shader\n");
4742 }
4743
4744 /* Link all shaders for a particular stage and validate the result.
4745 */
4746 for (int stage = 0; stage < MESA_SHADER_STAGES; stage++) {
4747 if (num_shaders[stage] > 0) {
4748 gl_linked_shader *const sh =
4749 link_intrastage_shaders(mem_ctx, ctx, prog, shader_list[stage],
4750 num_shaders[stage], false);
4751
4752 if (!prog->data->LinkStatus) {
4753 if (sh)
4754 _mesa_delete_linked_shader(ctx, sh);
4755 goto done;
4756 }
4757
4758 switch (stage) {
4759 case MESA_SHADER_VERTEX:
4760 validate_vertex_shader_executable(prog, sh, ctx);
4761 break;
4762 case MESA_SHADER_TESS_CTRL:
4763 /* nothing to be done */
4764 break;
4765 case MESA_SHADER_TESS_EVAL:
4766 validate_tess_eval_shader_executable(prog, sh, ctx);
4767 break;
4768 case MESA_SHADER_GEOMETRY:
4769 validate_geometry_shader_executable(prog, sh, ctx);
4770 break;
4771 case MESA_SHADER_FRAGMENT:
4772 validate_fragment_shader_executable(prog, sh);
4773 break;
4774 }
4775 if (!prog->data->LinkStatus) {
4776 if (sh)
4777 _mesa_delete_linked_shader(ctx, sh);
4778 goto done;
4779 }
4780
4781 prog->_LinkedShaders[stage] = sh;
4782 prog->data->linked_stages |= 1 << stage;
4783 }
4784 }
4785
4786 if (num_shaders[MESA_SHADER_GEOMETRY] > 0) {
4787 prog->LastClipDistanceArraySize = prog->Geom.ClipDistanceArraySize;
4788 prog->LastCullDistanceArraySize = prog->Geom.CullDistanceArraySize;
4789 } else if (num_shaders[MESA_SHADER_TESS_EVAL] > 0) {
4790 prog->LastClipDistanceArraySize = prog->TessEval.ClipDistanceArraySize;
4791 prog->LastCullDistanceArraySize = prog->TessEval.CullDistanceArraySize;
4792 } else if (num_shaders[MESA_SHADER_VERTEX] > 0) {
4793 prog->LastClipDistanceArraySize = prog->Vert.ClipDistanceArraySize;
4794 prog->LastCullDistanceArraySize = prog->Vert.CullDistanceArraySize;
4795 } else {
4796 prog->LastClipDistanceArraySize = 0; /* Not used */
4797 prog->LastCullDistanceArraySize = 0; /* Not used */
4798 }
4799
4800 /* Here begins the inter-stage linking phase. Some initial validation is
4801 * performed, then locations are assigned for uniforms, attributes, and
4802 * varyings.
4803 */
4804 cross_validate_uniforms(prog);
4805 if (!prog->data->LinkStatus)
4806 goto done;
4807
4808 unsigned first, last, prev;
4809
4810 first = MESA_SHADER_STAGES;
4811 last = 0;
4812
4813 /* Determine first and last stage. */
4814 for (unsigned i = 0; i < MESA_SHADER_STAGES; i++) {
4815 if (!prog->_LinkedShaders[i])
4816 continue;
4817 if (first == MESA_SHADER_STAGES)
4818 first = i;
4819 last = i;
4820 }
4821
4822 check_explicit_uniform_locations(ctx, prog);
4823 link_assign_subroutine_types(prog);
4824
4825 if (!prog->data->LinkStatus)
4826 goto done;
4827
4828 resize_tes_inputs(ctx, prog);
4829
4830 /* Validate the inputs of each stage with the output of the preceding
4831 * stage.
4832 */
4833 prev = first;
4834 for (unsigned i = prev + 1; i <= MESA_SHADER_FRAGMENT; i++) {
4835 if (prog->_LinkedShaders[i] == NULL)
4836 continue;
4837
4838 validate_interstage_inout_blocks(prog, prog->_LinkedShaders[prev],
4839 prog->_LinkedShaders[i]);
4840 if (!prog->data->LinkStatus)
4841 goto done;
4842
4843 cross_validate_outputs_to_inputs(prog,
4844 prog->_LinkedShaders[prev],
4845 prog->_LinkedShaders[i]);
4846 if (!prog->data->LinkStatus)
4847 goto done;
4848
4849 prev = i;
4850 }
4851
4852 /* Cross-validate uniform blocks between shader stages */
4853 validate_interstage_uniform_blocks(prog, prog->_LinkedShaders);
4854 if (!prog->data->LinkStatus)
4855 goto done;
4856
4857 for (unsigned int i = 0; i < MESA_SHADER_STAGES; i++) {
4858 if (prog->_LinkedShaders[i] != NULL)
4859 lower_named_interface_blocks(mem_ctx, prog->_LinkedShaders[i]);
4860 }
4861
4862 /* Implement the GLSL 1.30+ rule for discard vs infinite loops Do
4863 * it before optimization because we want most of the checks to get
4864 * dropped thanks to constant propagation.
4865 *
4866 * This rule also applies to GLSL ES 3.00.
4867 */
4868 if (max_version >= (prog->IsES ? 300 : 130)) {
4869 struct gl_linked_shader *sh = prog->_LinkedShaders[MESA_SHADER_FRAGMENT];
4870 if (sh) {
4871 lower_discard_flow(sh->ir);
4872 }
4873 }
4874
4875 if (prog->SeparateShader)
4876 disable_varying_optimizations_for_sso(prog);
4877
4878 /* Process UBOs */
4879 if (!interstage_cross_validate_uniform_blocks(prog, false))
4880 goto done;
4881
4882 /* Process SSBOs */
4883 if (!interstage_cross_validate_uniform_blocks(prog, true))
4884 goto done;
4885
4886 /* Do common optimization before assigning storage for attributes,
4887 * uniforms, and varyings. Later optimization could possibly make
4888 * some of that unused.
4889 */
4890 for (unsigned i = 0; i < MESA_SHADER_STAGES; i++) {
4891 if (prog->_LinkedShaders[i] == NULL)
4892 continue;
4893
4894 detect_recursion_linked(prog, prog->_LinkedShaders[i]->ir);
4895 if (!prog->data->LinkStatus)
4896 goto done;
4897
4898 if (ctx->Const.ShaderCompilerOptions[i].LowerCombinedClipCullDistance) {
4899 lower_clip_cull_distance(prog, prog->_LinkedShaders[i]);
4900 }
4901
4902 if (ctx->Const.LowerTessLevel) {
4903 lower_tess_level(prog->_LinkedShaders[i]);
4904 }
4905
4906 if (ctx->Const.GLSLOptimizeConservatively) {
4907 /* Run it just once. */
4908 do_common_optimization(prog->_LinkedShaders[i]->ir, true, false,
4909 &ctx->Const.ShaderCompilerOptions[i],
4910 ctx->Const.NativeIntegers);
4911 } else {
4912 /* Repeat it until it stops making changes. */
4913 while (do_common_optimization(prog->_LinkedShaders[i]->ir, true, false,
4914 &ctx->Const.ShaderCompilerOptions[i],
4915 ctx->Const.NativeIntegers))
4916 ;
4917 }
4918
4919 lower_const_arrays_to_uniforms(prog->_LinkedShaders[i]->ir, i);
4920 propagate_invariance(prog->_LinkedShaders[i]->ir);
4921 }
4922
4923 /* Validation for special cases where we allow sampler array indexing
4924 * with loop induction variable. This check emits a warning or error
4925 * depending if backend can handle dynamic indexing.
4926 */
4927 if ((!prog->IsES && prog->data->Version < 130) ||
4928 (prog->IsES && prog->data->Version < 300)) {
4929 if (!validate_sampler_array_indexing(ctx, prog))
4930 goto done;
4931 }
4932
4933 /* Check and validate stream emissions in geometry shaders */
4934 validate_geometry_shader_emissions(ctx, prog);
4935
4936 store_fragdepth_layout(prog);
4937
4938 if(!link_varyings_and_uniforms(first, last, ctx, prog, mem_ctx))
4939 goto done;
4940
4941 /* OpenGL ES < 3.1 requires that a vertex shader and a fragment shader both
4942 * be present in a linked program. GL_ARB_ES2_compatibility doesn't say
4943 * anything about shader linking when one of the shaders (vertex or
4944 * fragment shader) is absent. So, the extension shouldn't change the
4945 * behavior specified in GLSL specification.
4946 *
4947 * From OpenGL ES 3.1 specification (7.3 Program Objects):
4948 * "Linking can fail for a variety of reasons as specified in the
4949 * OpenGL ES Shading Language Specification, as well as any of the
4950 * following reasons:
4951 *
4952 * ...
4953 *
4954 * * program contains objects to form either a vertex shader or
4955 * fragment shader, and program is not separable, and does not
4956 * contain objects to form both a vertex shader and fragment
4957 * shader."
4958 *
4959 * However, the only scenario in 3.1+ where we don't require them both is
4960 * when we have a compute shader. For example:
4961 *
4962 * - No shaders is a link error.
4963 * - Geom or Tess without a Vertex shader is a link error which means we
4964 * always require a Vertex shader and hence a Fragment shader.
4965 * - Finally a Compute shader linked with any other stage is a link error.
4966 */
4967 if (!prog->SeparateShader && ctx->API == API_OPENGLES2 &&
4968 num_shaders[MESA_SHADER_COMPUTE] == 0) {
4969 if (prog->_LinkedShaders[MESA_SHADER_VERTEX] == NULL) {
4970 linker_error(prog, "program lacks a vertex shader\n");
4971 } else if (prog->_LinkedShaders[MESA_SHADER_FRAGMENT] == NULL) {
4972 linker_error(prog, "program lacks a fragment shader\n");
4973 }
4974 }
4975
4976 done:
4977 for (unsigned i = 0; i < MESA_SHADER_STAGES; i++) {
4978 free(shader_list[i]);
4979 if (prog->_LinkedShaders[i] == NULL)
4980 continue;
4981
4982 /* Do a final validation step to make sure that the IR wasn't
4983 * invalidated by any modifications performed after intrastage linking.
4984 */
4985 validate_ir_tree(prog->_LinkedShaders[i]->ir);
4986
4987 /* Retain any live IR, but trash the rest. */
4988 reparent_ir(prog->_LinkedShaders[i]->ir, prog->_LinkedShaders[i]->ir);
4989
4990 /* The symbol table in the linked shaders may contain references to
4991 * variables that were removed (e.g., unused uniforms). Since it may
4992 * contain junk, there is no possible valid use. Delete it and set the
4993 * pointer to NULL.
4994 */
4995 delete prog->_LinkedShaders[i]->symbols;
4996 prog->_LinkedShaders[i]->symbols = NULL;
4997 }
4998
4999 ralloc_free(mem_ctx);
5000 }