glsl: Link error if fs defines conflicting qualifiers for gl_FragCoord
[mesa.git] / src / 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 "main/core.h"
68 #include "glsl_symbol_table.h"
69 #include "glsl_parser_extras.h"
70 #include "ir.h"
71 #include "program.h"
72 #include "program/hash_table.h"
73 #include "linker.h"
74 #include "link_varyings.h"
75 #include "ir_optimization.h"
76 #include "ir_rvalue_visitor.h"
77
78 extern "C" {
79 #include "main/shaderobj.h"
80 #include "main/enums.h"
81 }
82
83 void linker_error(gl_shader_program *, const char *, ...);
84
85 namespace {
86
87 /**
88 * Visitor that determines whether or not a variable is ever written.
89 */
90 class find_assignment_visitor : public ir_hierarchical_visitor {
91 public:
92 find_assignment_visitor(const char *name)
93 : name(name), found(false)
94 {
95 /* empty */
96 }
97
98 virtual ir_visitor_status visit_enter(ir_assignment *ir)
99 {
100 ir_variable *const var = ir->lhs->variable_referenced();
101
102 if (strcmp(name, var->name) == 0) {
103 found = true;
104 return visit_stop;
105 }
106
107 return visit_continue_with_parent;
108 }
109
110 virtual ir_visitor_status visit_enter(ir_call *ir)
111 {
112 foreach_two_lists(formal_node, &ir->callee->parameters,
113 actual_node, &ir->actual_parameters) {
114 ir_rvalue *param_rval = (ir_rvalue *) actual_node;
115 ir_variable *sig_param = (ir_variable *) formal_node;
116
117 if (sig_param->data.mode == ir_var_function_out ||
118 sig_param->data.mode == ir_var_function_inout) {
119 ir_variable *var = param_rval->variable_referenced();
120 if (var && strcmp(name, var->name) == 0) {
121 found = true;
122 return visit_stop;
123 }
124 }
125 }
126
127 if (ir->return_deref != NULL) {
128 ir_variable *const var = ir->return_deref->variable_referenced();
129
130 if (strcmp(name, var->name) == 0) {
131 found = true;
132 return visit_stop;
133 }
134 }
135
136 return visit_continue_with_parent;
137 }
138
139 bool variable_found()
140 {
141 return found;
142 }
143
144 private:
145 const char *name; /**< Find writes to a variable with this name. */
146 bool found; /**< Was a write to the variable found? */
147 };
148
149
150 /**
151 * Visitor that determines whether or not a variable is ever read.
152 */
153 class find_deref_visitor : public ir_hierarchical_visitor {
154 public:
155 find_deref_visitor(const char *name)
156 : name(name), found(false)
157 {
158 /* empty */
159 }
160
161 virtual ir_visitor_status visit(ir_dereference_variable *ir)
162 {
163 if (strcmp(this->name, ir->var->name) == 0) {
164 this->found = true;
165 return visit_stop;
166 }
167
168 return visit_continue;
169 }
170
171 bool variable_found() const
172 {
173 return this->found;
174 }
175
176 private:
177 const char *name; /**< Find writes to a variable with this name. */
178 bool found; /**< Was a write to the variable found? */
179 };
180
181
182 class geom_array_resize_visitor : public ir_hierarchical_visitor {
183 public:
184 unsigned num_vertices;
185 gl_shader_program *prog;
186
187 geom_array_resize_visitor(unsigned num_vertices, gl_shader_program *prog)
188 {
189 this->num_vertices = num_vertices;
190 this->prog = prog;
191 }
192
193 virtual ~geom_array_resize_visitor()
194 {
195 /* empty */
196 }
197
198 virtual ir_visitor_status visit(ir_variable *var)
199 {
200 if (!var->type->is_array() || var->data.mode != ir_var_shader_in)
201 return visit_continue;
202
203 unsigned size = var->type->length;
204
205 /* Generate a link error if the shader has declared this array with an
206 * incorrect size.
207 */
208 if (size && size != this->num_vertices) {
209 linker_error(this->prog, "size of array %s declared as %u, "
210 "but number of input vertices is %u\n",
211 var->name, size, this->num_vertices);
212 return visit_continue;
213 }
214
215 /* Generate a link error if the shader attempts to access an input
216 * array using an index too large for its actual size assigned at link
217 * time.
218 */
219 if (var->data.max_array_access >= this->num_vertices) {
220 linker_error(this->prog, "geometry shader accesses element %i of "
221 "%s, but only %i input vertices\n",
222 var->data.max_array_access, var->name, this->num_vertices);
223 return visit_continue;
224 }
225
226 var->type = glsl_type::get_array_instance(var->type->element_type(),
227 this->num_vertices);
228 var->data.max_array_access = this->num_vertices - 1;
229
230 return visit_continue;
231 }
232
233 /* Dereferences of input variables need to be updated so that their type
234 * matches the newly assigned type of the variable they are accessing. */
235 virtual ir_visitor_status visit(ir_dereference_variable *ir)
236 {
237 ir->type = ir->var->type;
238 return visit_continue;
239 }
240
241 /* Dereferences of 2D input arrays need to be updated so that their type
242 * matches the newly assigned type of the array they are accessing. */
243 virtual ir_visitor_status visit_leave(ir_dereference_array *ir)
244 {
245 const glsl_type *const vt = ir->array->type;
246 if (vt->is_array())
247 ir->type = vt->element_type();
248 return visit_continue;
249 }
250 };
251
252
253 /**
254 * Visitor that determines whether or not a shader uses ir_end_primitive.
255 */
256 class find_end_primitive_visitor : public ir_hierarchical_visitor {
257 public:
258 find_end_primitive_visitor()
259 : found(false)
260 {
261 /* empty */
262 }
263
264 virtual ir_visitor_status visit(ir_end_primitive *)
265 {
266 found = true;
267 return visit_stop;
268 }
269
270 bool end_primitive_found()
271 {
272 return found;
273 }
274
275 private:
276 bool found;
277 };
278
279 } /* anonymous namespace */
280
281 void
282 linker_error(gl_shader_program *prog, const char *fmt, ...)
283 {
284 va_list ap;
285
286 ralloc_strcat(&prog->InfoLog, "error: ");
287 va_start(ap, fmt);
288 ralloc_vasprintf_append(&prog->InfoLog, fmt, ap);
289 va_end(ap);
290
291 prog->LinkStatus = false;
292 }
293
294
295 void
296 linker_warning(gl_shader_program *prog, const char *fmt, ...)
297 {
298 va_list ap;
299
300 ralloc_strcat(&prog->InfoLog, "warning: ");
301 va_start(ap, fmt);
302 ralloc_vasprintf_append(&prog->InfoLog, fmt, ap);
303 va_end(ap);
304
305 }
306
307
308 /**
309 * Given a string identifying a program resource, break it into a base name
310 * and an optional array index in square brackets.
311 *
312 * If an array index is present, \c out_base_name_end is set to point to the
313 * "[" that precedes the array index, and the array index itself is returned
314 * as a long.
315 *
316 * If no array index is present (or if the array index is negative or
317 * mal-formed), \c out_base_name_end, is set to point to the null terminator
318 * at the end of the input string, and -1 is returned.
319 *
320 * Only the final array index is parsed; if the string contains other array
321 * indices (or structure field accesses), they are left in the base name.
322 *
323 * No attempt is made to check that the base name is properly formed;
324 * typically the caller will look up the base name in a hash table, so
325 * ill-formed base names simply turn into hash table lookup failures.
326 */
327 long
328 parse_program_resource_name(const GLchar *name,
329 const GLchar **out_base_name_end)
330 {
331 /* Section 7.3.1 ("Program Interfaces") of the OpenGL 4.3 spec says:
332 *
333 * "When an integer array element or block instance number is part of
334 * the name string, it will be specified in decimal form without a "+"
335 * or "-" sign or any extra leading zeroes. Additionally, the name
336 * string will not include white space anywhere in the string."
337 */
338
339 const size_t len = strlen(name);
340 *out_base_name_end = name + len;
341
342 if (len == 0 || name[len-1] != ']')
343 return -1;
344
345 /* Walk backwards over the string looking for a non-digit character. This
346 * had better be the opening bracket for an array index.
347 *
348 * Initially, i specifies the location of the ']'. Since the string may
349 * contain only the ']' charcater, walk backwards very carefully.
350 */
351 unsigned i;
352 for (i = len - 1; (i > 0) && isdigit(name[i-1]); --i)
353 /* empty */ ;
354
355 if ((i == 0) || name[i-1] != '[')
356 return -1;
357
358 long array_index = strtol(&name[i], NULL, 10);
359 if (array_index < 0)
360 return -1;
361
362 *out_base_name_end = name + (i - 1);
363 return array_index;
364 }
365
366
367 void
368 link_invalidate_variable_locations(exec_list *ir)
369 {
370 foreach_list(node, ir) {
371 ir_variable *const var = ((ir_instruction *) node)->as_variable();
372
373 if (var == NULL)
374 continue;
375
376 /* Only assign locations for variables that lack an explicit location.
377 * Explicit locations are set for all built-in variables, generic vertex
378 * shader inputs (via layout(location=...)), and generic fragment shader
379 * outputs (also via layout(location=...)).
380 */
381 if (!var->data.explicit_location) {
382 var->data.location = -1;
383 var->data.location_frac = 0;
384 }
385
386 /* ir_variable::is_unmatched_generic_inout is used by the linker while
387 * connecting outputs from one stage to inputs of the next stage.
388 *
389 * There are two implicit assumptions here. First, we assume that any
390 * built-in variable (i.e., non-generic in or out) will have
391 * explicit_location set. Second, we assume that any generic in or out
392 * will not have explicit_location set.
393 *
394 * This second assumption will only be valid until
395 * GL_ARB_separate_shader_objects is supported. When that extension is
396 * implemented, this function will need some modifications.
397 */
398 if (!var->data.explicit_location) {
399 var->data.is_unmatched_generic_inout = 1;
400 } else {
401 var->data.is_unmatched_generic_inout = 0;
402 }
403 }
404 }
405
406
407 /**
408 * Set UsesClipDistance and ClipDistanceArraySize based on the given shader.
409 *
410 * Also check for errors based on incorrect usage of gl_ClipVertex and
411 * gl_ClipDistance.
412 *
413 * Return false if an error was reported.
414 */
415 static void
416 analyze_clip_usage(struct gl_shader_program *prog,
417 struct gl_shader *shader, GLboolean *UsesClipDistance,
418 GLuint *ClipDistanceArraySize)
419 {
420 *ClipDistanceArraySize = 0;
421
422 if (!prog->IsES && prog->Version >= 130) {
423 /* From section 7.1 (Vertex Shader Special Variables) of the
424 * GLSL 1.30 spec:
425 *
426 * "It is an error for a shader to statically write both
427 * gl_ClipVertex and gl_ClipDistance."
428 *
429 * This does not apply to GLSL ES shaders, since GLSL ES defines neither
430 * gl_ClipVertex nor gl_ClipDistance.
431 */
432 find_assignment_visitor clip_vertex("gl_ClipVertex");
433 find_assignment_visitor clip_distance("gl_ClipDistance");
434
435 clip_vertex.run(shader->ir);
436 clip_distance.run(shader->ir);
437 if (clip_vertex.variable_found() && clip_distance.variable_found()) {
438 linker_error(prog, "%s shader writes to both `gl_ClipVertex' "
439 "and `gl_ClipDistance'\n",
440 _mesa_shader_stage_to_string(shader->Stage));
441 return;
442 }
443 *UsesClipDistance = clip_distance.variable_found();
444 ir_variable *clip_distance_var =
445 shader->symbols->get_variable("gl_ClipDistance");
446 if (clip_distance_var)
447 *ClipDistanceArraySize = clip_distance_var->type->length;
448 } else {
449 *UsesClipDistance = false;
450 }
451 }
452
453
454 /**
455 * Verify that a vertex shader executable meets all semantic requirements.
456 *
457 * Also sets prog->Vert.UsesClipDistance and prog->Vert.ClipDistanceArraySize
458 * as a side effect.
459 *
460 * \param shader Vertex shader executable to be verified
461 */
462 void
463 validate_vertex_shader_executable(struct gl_shader_program *prog,
464 struct gl_shader *shader)
465 {
466 if (shader == NULL)
467 return;
468
469 /* From the GLSL 1.10 spec, page 48:
470 *
471 * "The variable gl_Position is available only in the vertex
472 * language and is intended for writing the homogeneous vertex
473 * position. All executions of a well-formed vertex shader
474 * executable must write a value into this variable. [...] The
475 * variable gl_Position is available only in the vertex
476 * language and is intended for writing the homogeneous vertex
477 * position. All executions of a well-formed vertex shader
478 * executable must write a value into this variable."
479 *
480 * while in GLSL 1.40 this text is changed to:
481 *
482 * "The variable gl_Position is available only in the vertex
483 * language and is intended for writing the homogeneous vertex
484 * position. It can be written at any time during shader
485 * execution. It may also be read back by a vertex shader
486 * after being written. This value will be used by primitive
487 * assembly, clipping, culling, and other fixed functionality
488 * operations, if present, that operate on primitives after
489 * vertex processing has occurred. Its value is undefined if
490 * the vertex shader executable does not write gl_Position."
491 *
492 * GLSL ES 3.00 is similar to GLSL 1.40--failing to write to gl_Position is
493 * not an error.
494 */
495 if (prog->Version < (prog->IsES ? 300 : 140)) {
496 find_assignment_visitor find("gl_Position");
497 find.run(shader->ir);
498 if (!find.variable_found()) {
499 linker_error(prog, "vertex shader does not write to `gl_Position'\n");
500 return;
501 }
502 }
503
504 analyze_clip_usage(prog, shader, &prog->Vert.UsesClipDistance,
505 &prog->Vert.ClipDistanceArraySize);
506 }
507
508
509 /**
510 * Verify that a fragment shader executable meets all semantic requirements
511 *
512 * \param shader Fragment shader executable to be verified
513 */
514 void
515 validate_fragment_shader_executable(struct gl_shader_program *prog,
516 struct gl_shader *shader)
517 {
518 if (shader == NULL)
519 return;
520
521 find_assignment_visitor frag_color("gl_FragColor");
522 find_assignment_visitor frag_data("gl_FragData");
523
524 frag_color.run(shader->ir);
525 frag_data.run(shader->ir);
526
527 if (frag_color.variable_found() && frag_data.variable_found()) {
528 linker_error(prog, "fragment shader writes to both "
529 "`gl_FragColor' and `gl_FragData'\n");
530 }
531 }
532
533 /**
534 * Verify that a geometry shader executable meets all semantic requirements
535 *
536 * Also sets prog->Geom.VerticesIn, prog->Geom.UsesClipDistance, and
537 * prog->Geom.ClipDistanceArraySize as a side effect.
538 *
539 * \param shader Geometry shader executable to be verified
540 */
541 void
542 validate_geometry_shader_executable(struct gl_shader_program *prog,
543 struct gl_shader *shader)
544 {
545 if (shader == NULL)
546 return;
547
548 unsigned num_vertices = vertices_per_prim(prog->Geom.InputType);
549 prog->Geom.VerticesIn = num_vertices;
550
551 analyze_clip_usage(prog, shader, &prog->Geom.UsesClipDistance,
552 &prog->Geom.ClipDistanceArraySize);
553
554 find_end_primitive_visitor end_primitive;
555 end_primitive.run(shader->ir);
556 prog->Geom.UsesEndPrimitive = end_primitive.end_primitive_found();
557 }
558
559
560 /**
561 * Perform validation of global variables used across multiple shaders
562 */
563 void
564 cross_validate_globals(struct gl_shader_program *prog,
565 struct gl_shader **shader_list,
566 unsigned num_shaders,
567 bool uniforms_only)
568 {
569 /* Examine all of the uniforms in all of the shaders and cross validate
570 * them.
571 */
572 glsl_symbol_table variables;
573 for (unsigned i = 0; i < num_shaders; i++) {
574 if (shader_list[i] == NULL)
575 continue;
576
577 foreach_list(node, shader_list[i]->ir) {
578 ir_variable *const var = ((ir_instruction *) node)->as_variable();
579
580 if (var == NULL)
581 continue;
582
583 if (uniforms_only && (var->data.mode != ir_var_uniform))
584 continue;
585
586 /* Don't cross validate temporaries that are at global scope. These
587 * will eventually get pulled into the shaders 'main'.
588 */
589 if (var->data.mode == ir_var_temporary)
590 continue;
591
592 /* If a global with this name has already been seen, verify that the
593 * new instance has the same type. In addition, if the globals have
594 * initializers, the values of the initializers must be the same.
595 */
596 ir_variable *const existing = variables.get_variable(var->name);
597 if (existing != NULL) {
598 if (var->type != existing->type) {
599 /* Consider the types to be "the same" if both types are arrays
600 * of the same type and one of the arrays is implicitly sized.
601 * In addition, set the type of the linked variable to the
602 * explicitly sized array.
603 */
604 if (var->type->is_array()
605 && existing->type->is_array()
606 && (var->type->fields.array == existing->type->fields.array)
607 && ((var->type->length == 0)
608 || (existing->type->length == 0))) {
609 if (var->type->length != 0) {
610 existing->type = var->type;
611 }
612 } else if (var->type->is_record()
613 && existing->type->is_record()
614 && existing->type->record_compare(var->type)) {
615 existing->type = var->type;
616 } else {
617 linker_error(prog, "%s `%s' declared as type "
618 "`%s' and type `%s'\n",
619 mode_string(var),
620 var->name, var->type->name,
621 existing->type->name);
622 return;
623 }
624 }
625
626 if (var->data.explicit_location) {
627 if (existing->data.explicit_location
628 && (var->data.location != existing->data.location)) {
629 linker_error(prog, "explicit locations for %s "
630 "`%s' have differing values\n",
631 mode_string(var), var->name);
632 return;
633 }
634
635 existing->data.location = var->data.location;
636 existing->data.explicit_location = true;
637 }
638
639 /* From the GLSL 4.20 specification:
640 * "A link error will result if two compilation units in a program
641 * specify different integer-constant bindings for the same
642 * opaque-uniform name. However, it is not an error to specify a
643 * binding on some but not all declarations for the same name"
644 */
645 if (var->data.explicit_binding) {
646 if (existing->data.explicit_binding &&
647 var->data.binding != existing->data.binding) {
648 linker_error(prog, "explicit bindings for %s "
649 "`%s' have differing values\n",
650 mode_string(var), var->name);
651 return;
652 }
653
654 existing->data.binding = var->data.binding;
655 existing->data.explicit_binding = true;
656 }
657
658 if (var->type->contains_atomic() &&
659 var->data.atomic.offset != existing->data.atomic.offset) {
660 linker_error(prog, "offset specifications for %s "
661 "`%s' have differing values\n",
662 mode_string(var), var->name);
663 return;
664 }
665
666 /* Validate layout qualifiers for gl_FragDepth.
667 *
668 * From the AMD/ARB_conservative_depth specs:
669 *
670 * "If gl_FragDepth is redeclared in any fragment shader in a
671 * program, it must be redeclared in all fragment shaders in
672 * that program that have static assignments to
673 * gl_FragDepth. All redeclarations of gl_FragDepth in all
674 * fragment shaders in a single program must have the same set
675 * of qualifiers."
676 */
677 if (strcmp(var->name, "gl_FragDepth") == 0) {
678 bool layout_declared = var->data.depth_layout != ir_depth_layout_none;
679 bool layout_differs =
680 var->data.depth_layout != existing->data.depth_layout;
681
682 if (layout_declared && layout_differs) {
683 linker_error(prog,
684 "All redeclarations of gl_FragDepth in all "
685 "fragment shaders in a single program must have "
686 "the same set of qualifiers.");
687 }
688
689 if (var->data.used && layout_differs) {
690 linker_error(prog,
691 "If gl_FragDepth is redeclared with a layout "
692 "qualifier in any fragment shader, it must be "
693 "redeclared with the same layout qualifier in "
694 "all fragment shaders that have assignments to "
695 "gl_FragDepth");
696 }
697 }
698
699 /* Page 35 (page 41 of the PDF) of the GLSL 4.20 spec says:
700 *
701 * "If a shared global has multiple initializers, the
702 * initializers must all be constant expressions, and they
703 * must all have the same value. Otherwise, a link error will
704 * result. (A shared global having only one initializer does
705 * not require that initializer to be a constant expression.)"
706 *
707 * Previous to 4.20 the GLSL spec simply said that initializers
708 * must have the same value. In this case of non-constant
709 * initializers, this was impossible to determine. As a result,
710 * no vendor actually implemented that behavior. The 4.20
711 * behavior matches the implemented behavior of at least one other
712 * vendor, so we'll implement that for all GLSL versions.
713 */
714 if (var->constant_initializer != NULL) {
715 if (existing->constant_initializer != NULL) {
716 if (!var->constant_initializer->has_value(existing->constant_initializer)) {
717 linker_error(prog, "initializers for %s "
718 "`%s' have differing values\n",
719 mode_string(var), var->name);
720 return;
721 }
722 } else {
723 /* If the first-seen instance of a particular uniform did not
724 * have an initializer but a later instance does, copy the
725 * initializer to the version stored in the symbol table.
726 */
727 /* FINISHME: This is wrong. The constant_value field should
728 * FINISHME: not be modified! Imagine a case where a shader
729 * FINISHME: without an initializer is linked in two different
730 * FINISHME: programs with shaders that have differing
731 * FINISHME: initializers. Linking with the first will
732 * FINISHME: modify the shader, and linking with the second
733 * FINISHME: will fail.
734 */
735 existing->constant_initializer =
736 var->constant_initializer->clone(ralloc_parent(existing),
737 NULL);
738 }
739 }
740
741 if (var->data.has_initializer) {
742 if (existing->data.has_initializer
743 && (var->constant_initializer == NULL
744 || existing->constant_initializer == NULL)) {
745 linker_error(prog,
746 "shared global variable `%s' has multiple "
747 "non-constant initializers.\n",
748 var->name);
749 return;
750 }
751
752 /* Some instance had an initializer, so keep track of that. In
753 * this location, all sorts of initializers (constant or
754 * otherwise) will propagate the existence to the variable
755 * stored in the symbol table.
756 */
757 existing->data.has_initializer = true;
758 }
759
760 if (existing->data.invariant != var->data.invariant) {
761 linker_error(prog, "declarations for %s `%s' have "
762 "mismatching invariant qualifiers\n",
763 mode_string(var), var->name);
764 return;
765 }
766 if (existing->data.centroid != var->data.centroid) {
767 linker_error(prog, "declarations for %s `%s' have "
768 "mismatching centroid qualifiers\n",
769 mode_string(var), var->name);
770 return;
771 }
772 if (existing->data.sample != var->data.sample) {
773 linker_error(prog, "declarations for %s `%s` have "
774 "mismatching sample qualifiers\n",
775 mode_string(var), var->name);
776 return;
777 }
778 } else
779 variables.add_variable(var);
780 }
781 }
782 }
783
784
785 /**
786 * Perform validation of uniforms used across multiple shader stages
787 */
788 void
789 cross_validate_uniforms(struct gl_shader_program *prog)
790 {
791 cross_validate_globals(prog, prog->_LinkedShaders,
792 MESA_SHADER_STAGES, true);
793 }
794
795 /**
796 * Accumulates the array of prog->UniformBlocks and checks that all
797 * definitons of blocks agree on their contents.
798 */
799 static bool
800 interstage_cross_validate_uniform_blocks(struct gl_shader_program *prog)
801 {
802 unsigned max_num_uniform_blocks = 0;
803 for (unsigned i = 0; i < MESA_SHADER_STAGES; i++) {
804 if (prog->_LinkedShaders[i])
805 max_num_uniform_blocks += prog->_LinkedShaders[i]->NumUniformBlocks;
806 }
807
808 for (unsigned i = 0; i < MESA_SHADER_STAGES; i++) {
809 struct gl_shader *sh = prog->_LinkedShaders[i];
810
811 prog->UniformBlockStageIndex[i] = ralloc_array(prog, int,
812 max_num_uniform_blocks);
813 for (unsigned int j = 0; j < max_num_uniform_blocks; j++)
814 prog->UniformBlockStageIndex[i][j] = -1;
815
816 if (sh == NULL)
817 continue;
818
819 for (unsigned int j = 0; j < sh->NumUniformBlocks; j++) {
820 int index = link_cross_validate_uniform_block(prog,
821 &prog->UniformBlocks,
822 &prog->NumUniformBlocks,
823 &sh->UniformBlocks[j]);
824
825 if (index == -1) {
826 linker_error(prog, "uniform block `%s' has mismatching definitions",
827 sh->UniformBlocks[j].Name);
828 return false;
829 }
830
831 prog->UniformBlockStageIndex[i][index] = j;
832 }
833 }
834
835 return true;
836 }
837
838
839 /**
840 * Populates a shaders symbol table with all global declarations
841 */
842 static void
843 populate_symbol_table(gl_shader *sh)
844 {
845 sh->symbols = new(sh) glsl_symbol_table;
846
847 foreach_list(node, sh->ir) {
848 ir_instruction *const inst = (ir_instruction *) node;
849 ir_variable *var;
850 ir_function *func;
851
852 if ((func = inst->as_function()) != NULL) {
853 sh->symbols->add_function(func);
854 } else if ((var = inst->as_variable()) != NULL) {
855 sh->symbols->add_variable(var);
856 }
857 }
858 }
859
860
861 /**
862 * Remap variables referenced in an instruction tree
863 *
864 * This is used when instruction trees are cloned from one shader and placed in
865 * another. These trees will contain references to \c ir_variable nodes that
866 * do not exist in the target shader. This function finds these \c ir_variable
867 * references and replaces the references with matching variables in the target
868 * shader.
869 *
870 * If there is no matching variable in the target shader, a clone of the
871 * \c ir_variable is made and added to the target shader. The new variable is
872 * added to \b both the instruction stream and the symbol table.
873 *
874 * \param inst IR tree that is to be processed.
875 * \param symbols Symbol table containing global scope symbols in the
876 * linked shader.
877 * \param instructions Instruction stream where new variable declarations
878 * should be added.
879 */
880 void
881 remap_variables(ir_instruction *inst, struct gl_shader *target,
882 hash_table *temps)
883 {
884 class remap_visitor : public ir_hierarchical_visitor {
885 public:
886 remap_visitor(struct gl_shader *target,
887 hash_table *temps)
888 {
889 this->target = target;
890 this->symbols = target->symbols;
891 this->instructions = target->ir;
892 this->temps = temps;
893 }
894
895 virtual ir_visitor_status visit(ir_dereference_variable *ir)
896 {
897 if (ir->var->data.mode == ir_var_temporary) {
898 ir_variable *var = (ir_variable *) hash_table_find(temps, ir->var);
899
900 assert(var != NULL);
901 ir->var = var;
902 return visit_continue;
903 }
904
905 ir_variable *const existing =
906 this->symbols->get_variable(ir->var->name);
907 if (existing != NULL)
908 ir->var = existing;
909 else {
910 ir_variable *copy = ir->var->clone(this->target, NULL);
911
912 this->symbols->add_variable(copy);
913 this->instructions->push_head(copy);
914 ir->var = copy;
915 }
916
917 return visit_continue;
918 }
919
920 private:
921 struct gl_shader *target;
922 glsl_symbol_table *symbols;
923 exec_list *instructions;
924 hash_table *temps;
925 };
926
927 remap_visitor v(target, temps);
928
929 inst->accept(&v);
930 }
931
932
933 /**
934 * Move non-declarations from one instruction stream to another
935 *
936 * The intended usage pattern of this function is to pass the pointer to the
937 * head sentinel of a list (i.e., a pointer to the list cast to an \c exec_node
938 * pointer) for \c last and \c false for \c make_copies on the first
939 * call. Successive calls pass the return value of the previous call for
940 * \c last and \c true for \c make_copies.
941 *
942 * \param instructions Source instruction stream
943 * \param last Instruction after which new instructions should be
944 * inserted in the target instruction stream
945 * \param make_copies Flag selecting whether instructions in \c instructions
946 * should be copied (via \c ir_instruction::clone) into the
947 * target list or moved.
948 *
949 * \return
950 * The new "last" instruction in the target instruction stream. This pointer
951 * is suitable for use as the \c last parameter of a later call to this
952 * function.
953 */
954 exec_node *
955 move_non_declarations(exec_list *instructions, exec_node *last,
956 bool make_copies, gl_shader *target)
957 {
958 hash_table *temps = NULL;
959
960 if (make_copies)
961 temps = hash_table_ctor(0, hash_table_pointer_hash,
962 hash_table_pointer_compare);
963
964 foreach_list_safe(node, instructions) {
965 ir_instruction *inst = (ir_instruction *) node;
966
967 if (inst->as_function())
968 continue;
969
970 ir_variable *var = inst->as_variable();
971 if ((var != NULL) && (var->data.mode != ir_var_temporary))
972 continue;
973
974 assert(inst->as_assignment()
975 || inst->as_call()
976 || inst->as_if() /* for initializers with the ?: operator */
977 || ((var != NULL) && (var->data.mode == ir_var_temporary)));
978
979 if (make_copies) {
980 inst = inst->clone(target, NULL);
981
982 if (var != NULL)
983 hash_table_insert(temps, inst, var);
984 else
985 remap_variables(inst, target, temps);
986 } else {
987 inst->remove();
988 }
989
990 last->insert_after(inst);
991 last = inst;
992 }
993
994 if (make_copies)
995 hash_table_dtor(temps);
996
997 return last;
998 }
999
1000 /**
1001 * Get the function signature for main from a shader
1002 */
1003 static ir_function_signature *
1004 get_main_function_signature(gl_shader *sh)
1005 {
1006 ir_function *const f = sh->symbols->get_function("main");
1007 if (f != NULL) {
1008 exec_list void_parameters;
1009
1010 /* Look for the 'void main()' signature and ensure that it's defined.
1011 * This keeps the linker from accidentally pick a shader that just
1012 * contains a prototype for main.
1013 *
1014 * We don't have to check for multiple definitions of main (in multiple
1015 * shaders) because that would have already been caught above.
1016 */
1017 ir_function_signature *sig = f->matching_signature(NULL, &void_parameters);
1018 if ((sig != NULL) && sig->is_defined) {
1019 return sig;
1020 }
1021 }
1022
1023 return NULL;
1024 }
1025
1026
1027 /**
1028 * This class is only used in link_intrastage_shaders() below but declaring
1029 * it inside that function leads to compiler warnings with some versions of
1030 * gcc.
1031 */
1032 class array_sizing_visitor : public ir_hierarchical_visitor {
1033 public:
1034 array_sizing_visitor()
1035 : mem_ctx(ralloc_context(NULL)),
1036 unnamed_interfaces(hash_table_ctor(0, hash_table_pointer_hash,
1037 hash_table_pointer_compare))
1038 {
1039 }
1040
1041 ~array_sizing_visitor()
1042 {
1043 hash_table_dtor(this->unnamed_interfaces);
1044 ralloc_free(this->mem_ctx);
1045 }
1046
1047 virtual ir_visitor_status visit(ir_variable *var)
1048 {
1049 fixup_type(&var->type, var->data.max_array_access);
1050 if (var->type->is_interface()) {
1051 if (interface_contains_unsized_arrays(var->type)) {
1052 const glsl_type *new_type =
1053 resize_interface_members(var->type, var->max_ifc_array_access);
1054 var->type = new_type;
1055 var->change_interface_type(new_type);
1056 }
1057 } else if (var->type->is_array() &&
1058 var->type->fields.array->is_interface()) {
1059 if (interface_contains_unsized_arrays(var->type->fields.array)) {
1060 const glsl_type *new_type =
1061 resize_interface_members(var->type->fields.array,
1062 var->max_ifc_array_access);
1063 var->change_interface_type(new_type);
1064 var->type =
1065 glsl_type::get_array_instance(new_type, var->type->length);
1066 }
1067 } else if (const glsl_type *ifc_type = var->get_interface_type()) {
1068 /* Store a pointer to the variable in the unnamed_interfaces
1069 * hashtable.
1070 */
1071 ir_variable **interface_vars = (ir_variable **)
1072 hash_table_find(this->unnamed_interfaces, ifc_type);
1073 if (interface_vars == NULL) {
1074 interface_vars = rzalloc_array(mem_ctx, ir_variable *,
1075 ifc_type->length);
1076 hash_table_insert(this->unnamed_interfaces, interface_vars,
1077 ifc_type);
1078 }
1079 unsigned index = ifc_type->field_index(var->name);
1080 assert(index < ifc_type->length);
1081 assert(interface_vars[index] == NULL);
1082 interface_vars[index] = var;
1083 }
1084 return visit_continue;
1085 }
1086
1087 /**
1088 * For each unnamed interface block that was discovered while running the
1089 * visitor, adjust the interface type to reflect the newly assigned array
1090 * sizes, and fix up the ir_variable nodes to point to the new interface
1091 * type.
1092 */
1093 void fixup_unnamed_interface_types()
1094 {
1095 hash_table_call_foreach(this->unnamed_interfaces,
1096 fixup_unnamed_interface_type, NULL);
1097 }
1098
1099 private:
1100 /**
1101 * If the type pointed to by \c type represents an unsized array, replace
1102 * it with a sized array whose size is determined by max_array_access.
1103 */
1104 static void fixup_type(const glsl_type **type, unsigned max_array_access)
1105 {
1106 if ((*type)->is_unsized_array()) {
1107 *type = glsl_type::get_array_instance((*type)->fields.array,
1108 max_array_access + 1);
1109 assert(*type != NULL);
1110 }
1111 }
1112
1113 /**
1114 * Determine whether the given interface type contains unsized arrays (if
1115 * it doesn't, array_sizing_visitor doesn't need to process it).
1116 */
1117 static bool interface_contains_unsized_arrays(const glsl_type *type)
1118 {
1119 for (unsigned i = 0; i < type->length; i++) {
1120 const glsl_type *elem_type = type->fields.structure[i].type;
1121 if (elem_type->is_unsized_array())
1122 return true;
1123 }
1124 return false;
1125 }
1126
1127 /**
1128 * Create a new interface type based on the given type, with unsized arrays
1129 * replaced by sized arrays whose size is determined by
1130 * max_ifc_array_access.
1131 */
1132 static const glsl_type *
1133 resize_interface_members(const glsl_type *type,
1134 const unsigned *max_ifc_array_access)
1135 {
1136 unsigned num_fields = type->length;
1137 glsl_struct_field *fields = new glsl_struct_field[num_fields];
1138 memcpy(fields, type->fields.structure,
1139 num_fields * sizeof(*fields));
1140 for (unsigned i = 0; i < num_fields; i++) {
1141 fixup_type(&fields[i].type, max_ifc_array_access[i]);
1142 }
1143 glsl_interface_packing packing =
1144 (glsl_interface_packing) type->interface_packing;
1145 const glsl_type *new_ifc_type =
1146 glsl_type::get_interface_instance(fields, num_fields,
1147 packing, type->name);
1148 delete [] fields;
1149 return new_ifc_type;
1150 }
1151
1152 static void fixup_unnamed_interface_type(const void *key, void *data,
1153 void *)
1154 {
1155 const glsl_type *ifc_type = (const glsl_type *) key;
1156 ir_variable **interface_vars = (ir_variable **) data;
1157 unsigned num_fields = ifc_type->length;
1158 glsl_struct_field *fields = new glsl_struct_field[num_fields];
1159 memcpy(fields, ifc_type->fields.structure,
1160 num_fields * sizeof(*fields));
1161 bool interface_type_changed = false;
1162 for (unsigned i = 0; i < num_fields; i++) {
1163 if (interface_vars[i] != NULL &&
1164 fields[i].type != interface_vars[i]->type) {
1165 fields[i].type = interface_vars[i]->type;
1166 interface_type_changed = true;
1167 }
1168 }
1169 if (!interface_type_changed) {
1170 delete [] fields;
1171 return;
1172 }
1173 glsl_interface_packing packing =
1174 (glsl_interface_packing) ifc_type->interface_packing;
1175 const glsl_type *new_ifc_type =
1176 glsl_type::get_interface_instance(fields, num_fields, packing,
1177 ifc_type->name);
1178 delete [] fields;
1179 for (unsigned i = 0; i < num_fields; i++) {
1180 if (interface_vars[i] != NULL)
1181 interface_vars[i]->change_interface_type(new_ifc_type);
1182 }
1183 }
1184
1185 /**
1186 * Memory context used to allocate the data in \c unnamed_interfaces.
1187 */
1188 void *mem_ctx;
1189
1190 /**
1191 * Hash table from const glsl_type * to an array of ir_variable *'s
1192 * pointing to the ir_variables constituting each unnamed interface block.
1193 */
1194 hash_table *unnamed_interfaces;
1195 };
1196
1197 /**
1198 * Performs the cross-validation of layout qualifiers specified in
1199 * redeclaration of gl_FragCoord for the attached fragment shaders,
1200 * and propagates them to the linked FS and linked shader program.
1201 */
1202 static void
1203 link_fs_input_layout_qualifiers(struct gl_shader_program *prog,
1204 struct gl_shader *linked_shader,
1205 struct gl_shader **shader_list,
1206 unsigned num_shaders)
1207 {
1208 linked_shader->redeclares_gl_fragcoord = false;
1209 linked_shader->uses_gl_fragcoord = false;
1210 linked_shader->origin_upper_left = false;
1211 linked_shader->pixel_center_integer = false;
1212
1213 if (linked_shader->Stage != MESA_SHADER_FRAGMENT || prog->Version < 150)
1214 return;
1215
1216 for (unsigned i = 0; i < num_shaders; i++) {
1217 struct gl_shader *shader = shader_list[i];
1218 /* From the GLSL 1.50 spec, page 39:
1219 *
1220 * "If gl_FragCoord is redeclared in any fragment shader in a program,
1221 * it must be redeclared in all the fragment shaders in that program
1222 * that have a static use gl_FragCoord."
1223 *
1224 * Exclude the case when one of the 'linked_shader' or 'shader' redeclares
1225 * gl_FragCoord with no layout qualifiers but the other one doesn't
1226 * redeclare it. If we strictly follow GLSL 1.50 spec's language, it
1227 * should be a link error. But, generating link error for this case will
1228 * be a wrong behaviour which spec didn't intend to do and it could also
1229 * break some applications.
1230 */
1231 if ((linked_shader->redeclares_gl_fragcoord
1232 && !shader->redeclares_gl_fragcoord
1233 && shader->uses_gl_fragcoord
1234 && (linked_shader->origin_upper_left
1235 || linked_shader->pixel_center_integer))
1236 || (shader->redeclares_gl_fragcoord
1237 && !linked_shader->redeclares_gl_fragcoord
1238 && linked_shader->uses_gl_fragcoord
1239 && (shader->origin_upper_left
1240 || shader->pixel_center_integer))) {
1241 linker_error(prog, "fragment shader defined with conflicting "
1242 "layout qualifiers for gl_FragCoord\n");
1243 }
1244
1245 /* From the GLSL 1.50 spec, page 39:
1246 *
1247 * "All redeclarations of gl_FragCoord in all fragment shaders in a
1248 * single program must have the same set of qualifiers."
1249 */
1250 if (linked_shader->redeclares_gl_fragcoord && shader->redeclares_gl_fragcoord
1251 && (shader->origin_upper_left != linked_shader->origin_upper_left
1252 || shader->pixel_center_integer != linked_shader->pixel_center_integer)) {
1253 linker_error(prog, "fragment shader defined with conflicting "
1254 "layout qualifiers for gl_FragCoord\n");
1255 }
1256
1257 /* Update the linked shader state.  Note that uses_gl_fragcoord should
1258 * accumulate the results.  The other values should replace.  If there
1259 * are multiple redeclarations, all the fields except uses_gl_fragcoord
1260 * are already known to be the same.
1261 */
1262 if (shader->redeclares_gl_fragcoord || shader->uses_gl_fragcoord) {
1263 linked_shader->redeclares_gl_fragcoord =
1264 shader->redeclares_gl_fragcoord;
1265 linked_shader->uses_gl_fragcoord = linked_shader->uses_gl_fragcoord
1266 || shader->uses_gl_fragcoord;
1267 linked_shader->origin_upper_left = shader->origin_upper_left;
1268 linked_shader->pixel_center_integer = shader->pixel_center_integer;
1269 }
1270 }
1271 }
1272
1273 /**
1274 * Performs the cross-validation of geometry shader max_vertices and
1275 * primitive type layout qualifiers for the attached geometry shaders,
1276 * and propagates them to the linked GS and linked shader program.
1277 */
1278 static void
1279 link_gs_inout_layout_qualifiers(struct gl_shader_program *prog,
1280 struct gl_shader *linked_shader,
1281 struct gl_shader **shader_list,
1282 unsigned num_shaders)
1283 {
1284 linked_shader->Geom.VerticesOut = 0;
1285 linked_shader->Geom.Invocations = 0;
1286 linked_shader->Geom.InputType = PRIM_UNKNOWN;
1287 linked_shader->Geom.OutputType = PRIM_UNKNOWN;
1288
1289 /* No in/out qualifiers defined for anything but GLSL 1.50+
1290 * geometry shaders so far.
1291 */
1292 if (linked_shader->Stage != MESA_SHADER_GEOMETRY || prog->Version < 150)
1293 return;
1294
1295 /* From the GLSL 1.50 spec, page 46:
1296 *
1297 * "All geometry shader output layout declarations in a program
1298 * must declare the same layout and same value for
1299 * max_vertices. There must be at least one geometry output
1300 * layout declaration somewhere in a program, but not all
1301 * geometry shaders (compilation units) are required to
1302 * declare it."
1303 */
1304
1305 for (unsigned i = 0; i < num_shaders; i++) {
1306 struct gl_shader *shader = shader_list[i];
1307
1308 if (shader->Geom.InputType != PRIM_UNKNOWN) {
1309 if (linked_shader->Geom.InputType != PRIM_UNKNOWN &&
1310 linked_shader->Geom.InputType != shader->Geom.InputType) {
1311 linker_error(prog, "geometry shader defined with conflicting "
1312 "input types\n");
1313 return;
1314 }
1315 linked_shader->Geom.InputType = shader->Geom.InputType;
1316 }
1317
1318 if (shader->Geom.OutputType != PRIM_UNKNOWN) {
1319 if (linked_shader->Geom.OutputType != PRIM_UNKNOWN &&
1320 linked_shader->Geom.OutputType != shader->Geom.OutputType) {
1321 linker_error(prog, "geometry shader defined with conflicting "
1322 "output types\n");
1323 return;
1324 }
1325 linked_shader->Geom.OutputType = shader->Geom.OutputType;
1326 }
1327
1328 if (shader->Geom.VerticesOut != 0) {
1329 if (linked_shader->Geom.VerticesOut != 0 &&
1330 linked_shader->Geom.VerticesOut != shader->Geom.VerticesOut) {
1331 linker_error(prog, "geometry shader defined with conflicting "
1332 "output vertex count (%d and %d)\n",
1333 linked_shader->Geom.VerticesOut,
1334 shader->Geom.VerticesOut);
1335 return;
1336 }
1337 linked_shader->Geom.VerticesOut = shader->Geom.VerticesOut;
1338 }
1339
1340 if (shader->Geom.Invocations != 0) {
1341 if (linked_shader->Geom.Invocations != 0 &&
1342 linked_shader->Geom.Invocations != shader->Geom.Invocations) {
1343 linker_error(prog, "geometry shader defined with conflicting "
1344 "invocation count (%d and %d)\n",
1345 linked_shader->Geom.Invocations,
1346 shader->Geom.Invocations);
1347 return;
1348 }
1349 linked_shader->Geom.Invocations = shader->Geom.Invocations;
1350 }
1351 }
1352
1353 /* Just do the intrastage -> interstage propagation right now,
1354 * since we already know we're in the right type of shader program
1355 * for doing it.
1356 */
1357 if (linked_shader->Geom.InputType == PRIM_UNKNOWN) {
1358 linker_error(prog,
1359 "geometry shader didn't declare primitive input type\n");
1360 return;
1361 }
1362 prog->Geom.InputType = linked_shader->Geom.InputType;
1363
1364 if (linked_shader->Geom.OutputType == PRIM_UNKNOWN) {
1365 linker_error(prog,
1366 "geometry shader didn't declare primitive output type\n");
1367 return;
1368 }
1369 prog->Geom.OutputType = linked_shader->Geom.OutputType;
1370
1371 if (linked_shader->Geom.VerticesOut == 0) {
1372 linker_error(prog,
1373 "geometry shader didn't declare max_vertices\n");
1374 return;
1375 }
1376 prog->Geom.VerticesOut = linked_shader->Geom.VerticesOut;
1377
1378 if (linked_shader->Geom.Invocations == 0)
1379 linked_shader->Geom.Invocations = 1;
1380
1381 prog->Geom.Invocations = linked_shader->Geom.Invocations;
1382 }
1383
1384
1385 /**
1386 * Perform cross-validation of compute shader local_size_{x,y,z} layout
1387 * qualifiers for the attached compute shaders, and propagate them to the
1388 * linked CS and linked shader program.
1389 */
1390 static void
1391 link_cs_input_layout_qualifiers(struct gl_shader_program *prog,
1392 struct gl_shader *linked_shader,
1393 struct gl_shader **shader_list,
1394 unsigned num_shaders)
1395 {
1396 for (int i = 0; i < 3; i++)
1397 linked_shader->Comp.LocalSize[i] = 0;
1398
1399 /* This function is called for all shader stages, but it only has an effect
1400 * for compute shaders.
1401 */
1402 if (linked_shader->Stage != MESA_SHADER_COMPUTE)
1403 return;
1404
1405 /* From the ARB_compute_shader spec, in the section describing local size
1406 * declarations:
1407 *
1408 * If multiple compute shaders attached to a single program object
1409 * declare local work-group size, the declarations must be identical;
1410 * otherwise a link-time error results. Furthermore, if a program
1411 * object contains any compute shaders, at least one must contain an
1412 * input layout qualifier specifying the local work sizes of the
1413 * program, or a link-time error will occur.
1414 */
1415 for (unsigned sh = 0; sh < num_shaders; sh++) {
1416 struct gl_shader *shader = shader_list[sh];
1417
1418 if (shader->Comp.LocalSize[0] != 0) {
1419 if (linked_shader->Comp.LocalSize[0] != 0) {
1420 for (int i = 0; i < 3; i++) {
1421 if (linked_shader->Comp.LocalSize[i] !=
1422 shader->Comp.LocalSize[i]) {
1423 linker_error(prog, "compute shader defined with conflicting "
1424 "local sizes\n");
1425 return;
1426 }
1427 }
1428 }
1429 for (int i = 0; i < 3; i++)
1430 linked_shader->Comp.LocalSize[i] = shader->Comp.LocalSize[i];
1431 }
1432 }
1433
1434 /* Just do the intrastage -> interstage propagation right now,
1435 * since we already know we're in the right type of shader program
1436 * for doing it.
1437 */
1438 if (linked_shader->Comp.LocalSize[0] == 0) {
1439 linker_error(prog, "compute shader didn't declare local size\n");
1440 return;
1441 }
1442 for (int i = 0; i < 3; i++)
1443 prog->Comp.LocalSize[i] = linked_shader->Comp.LocalSize[i];
1444 }
1445
1446
1447 /**
1448 * Combine a group of shaders for a single stage to generate a linked shader
1449 *
1450 * \note
1451 * If this function is supplied a single shader, it is cloned, and the new
1452 * shader is returned.
1453 */
1454 static struct gl_shader *
1455 link_intrastage_shaders(void *mem_ctx,
1456 struct gl_context *ctx,
1457 struct gl_shader_program *prog,
1458 struct gl_shader **shader_list,
1459 unsigned num_shaders)
1460 {
1461 struct gl_uniform_block *uniform_blocks = NULL;
1462
1463 /* Check that global variables defined in multiple shaders are consistent.
1464 */
1465 cross_validate_globals(prog, shader_list, num_shaders, false);
1466 if (!prog->LinkStatus)
1467 return NULL;
1468
1469 /* Check that interface blocks defined in multiple shaders are consistent.
1470 */
1471 validate_intrastage_interface_blocks(prog, (const gl_shader **)shader_list,
1472 num_shaders);
1473 if (!prog->LinkStatus)
1474 return NULL;
1475
1476 /* Link up uniform blocks defined within this stage. */
1477 const unsigned num_uniform_blocks =
1478 link_uniform_blocks(mem_ctx, prog, shader_list, num_shaders,
1479 &uniform_blocks);
1480
1481 /* Check that there is only a single definition of each function signature
1482 * across all shaders.
1483 */
1484 for (unsigned i = 0; i < (num_shaders - 1); i++) {
1485 foreach_list(node, shader_list[i]->ir) {
1486 ir_function *const f = ((ir_instruction *) node)->as_function();
1487
1488 if (f == NULL)
1489 continue;
1490
1491 for (unsigned j = i + 1; j < num_shaders; j++) {
1492 ir_function *const other =
1493 shader_list[j]->symbols->get_function(f->name);
1494
1495 /* If the other shader has no function (and therefore no function
1496 * signatures) with the same name, skip to the next shader.
1497 */
1498 if (other == NULL)
1499 continue;
1500
1501 foreach_list(n, &f->signatures) {
1502 ir_function_signature *sig = (ir_function_signature *) n;
1503
1504 if (!sig->is_defined || sig->is_builtin())
1505 continue;
1506
1507 ir_function_signature *other_sig =
1508 other->exact_matching_signature(NULL, &sig->parameters);
1509
1510 if ((other_sig != NULL) && other_sig->is_defined
1511 && !other_sig->is_builtin()) {
1512 linker_error(prog, "function `%s' is multiply defined",
1513 f->name);
1514 return NULL;
1515 }
1516 }
1517 }
1518 }
1519 }
1520
1521 /* Find the shader that defines main, and make a clone of it.
1522 *
1523 * Starting with the clone, search for undefined references. If one is
1524 * found, find the shader that defines it. Clone the reference and add
1525 * it to the shader. Repeat until there are no undefined references or
1526 * until a reference cannot be resolved.
1527 */
1528 gl_shader *main = NULL;
1529 for (unsigned i = 0; i < num_shaders; i++) {
1530 if (get_main_function_signature(shader_list[i]) != NULL) {
1531 main = shader_list[i];
1532 break;
1533 }
1534 }
1535
1536 if (main == NULL) {
1537 linker_error(prog, "%s shader lacks `main'\n",
1538 _mesa_shader_stage_to_string(shader_list[0]->Stage));
1539 return NULL;
1540 }
1541
1542 gl_shader *linked = ctx->Driver.NewShader(NULL, 0, main->Type);
1543 linked->ir = new(linked) exec_list;
1544 clone_ir_list(mem_ctx, linked->ir, main->ir);
1545
1546 linked->UniformBlocks = uniform_blocks;
1547 linked->NumUniformBlocks = num_uniform_blocks;
1548 ralloc_steal(linked, linked->UniformBlocks);
1549
1550 link_fs_input_layout_qualifiers(prog, linked, shader_list, num_shaders);
1551 link_gs_inout_layout_qualifiers(prog, linked, shader_list, num_shaders);
1552 link_cs_input_layout_qualifiers(prog, linked, shader_list, num_shaders);
1553
1554 populate_symbol_table(linked);
1555
1556 /* The a pointer to the main function in the final linked shader (i.e., the
1557 * copy of the original shader that contained the main function).
1558 */
1559 ir_function_signature *const main_sig = get_main_function_signature(linked);
1560
1561 /* Move any instructions other than variable declarations or function
1562 * declarations into main.
1563 */
1564 exec_node *insertion_point =
1565 move_non_declarations(linked->ir, (exec_node *) &main_sig->body, false,
1566 linked);
1567
1568 for (unsigned i = 0; i < num_shaders; i++) {
1569 if (shader_list[i] == main)
1570 continue;
1571
1572 insertion_point = move_non_declarations(shader_list[i]->ir,
1573 insertion_point, true, linked);
1574 }
1575
1576 /* Check if any shader needs built-in functions. */
1577 bool need_builtins = false;
1578 for (unsigned i = 0; i < num_shaders; i++) {
1579 if (shader_list[i]->uses_builtin_functions) {
1580 need_builtins = true;
1581 break;
1582 }
1583 }
1584
1585 bool ok;
1586 if (need_builtins) {
1587 /* Make a temporary array one larger than shader_list, which will hold
1588 * the built-in function shader as well.
1589 */
1590 gl_shader **linking_shaders = (gl_shader **)
1591 calloc(num_shaders + 1, sizeof(gl_shader *));
1592 memcpy(linking_shaders, shader_list, num_shaders * sizeof(gl_shader *));
1593 linking_shaders[num_shaders] = _mesa_glsl_get_builtin_function_shader();
1594
1595 ok = link_function_calls(prog, linked, linking_shaders, num_shaders + 1);
1596
1597 free(linking_shaders);
1598 } else {
1599 ok = link_function_calls(prog, linked, shader_list, num_shaders);
1600 }
1601
1602
1603 if (!ok) {
1604 ctx->Driver.DeleteShader(ctx, linked);
1605 return NULL;
1606 }
1607
1608 /* At this point linked should contain all of the linked IR, so
1609 * validate it to make sure nothing went wrong.
1610 */
1611 validate_ir_tree(linked->ir);
1612
1613 /* Set the size of geometry shader input arrays */
1614 if (linked->Stage == MESA_SHADER_GEOMETRY) {
1615 unsigned num_vertices = vertices_per_prim(prog->Geom.InputType);
1616 geom_array_resize_visitor input_resize_visitor(num_vertices, prog);
1617 foreach_list(n, linked->ir) {
1618 ir_instruction *ir = (ir_instruction *) n;
1619 ir->accept(&input_resize_visitor);
1620 }
1621 }
1622
1623 /* Make a pass over all variable declarations to ensure that arrays with
1624 * unspecified sizes have a size specified. The size is inferred from the
1625 * max_array_access field.
1626 */
1627 array_sizing_visitor v;
1628 v.run(linked->ir);
1629 v.fixup_unnamed_interface_types();
1630
1631 return linked;
1632 }
1633
1634 /**
1635 * Update the sizes of linked shader uniform arrays to the maximum
1636 * array index used.
1637 *
1638 * From page 81 (page 95 of the PDF) of the OpenGL 2.1 spec:
1639 *
1640 * If one or more elements of an array are active,
1641 * GetActiveUniform will return the name of the array in name,
1642 * subject to the restrictions listed above. The type of the array
1643 * is returned in type. The size parameter contains the highest
1644 * array element index used, plus one. The compiler or linker
1645 * determines the highest index used. There will be only one
1646 * active uniform reported by the GL per uniform array.
1647
1648 */
1649 static void
1650 update_array_sizes(struct gl_shader_program *prog)
1651 {
1652 for (unsigned i = 0; i < MESA_SHADER_STAGES; i++) {
1653 if (prog->_LinkedShaders[i] == NULL)
1654 continue;
1655
1656 foreach_list(node, prog->_LinkedShaders[i]->ir) {
1657 ir_variable *const var = ((ir_instruction *) node)->as_variable();
1658
1659 if ((var == NULL) || (var->data.mode != ir_var_uniform) ||
1660 !var->type->is_array())
1661 continue;
1662
1663 /* GL_ARB_uniform_buffer_object says that std140 uniforms
1664 * will not be eliminated. Since we always do std140, just
1665 * don't resize arrays in UBOs.
1666 *
1667 * Atomic counters are supposed to get deterministic
1668 * locations assigned based on the declaration ordering and
1669 * sizes, array compaction would mess that up.
1670 */
1671 if (var->is_in_uniform_block() || var->type->contains_atomic())
1672 continue;
1673
1674 unsigned int size = var->data.max_array_access;
1675 for (unsigned j = 0; j < MESA_SHADER_STAGES; j++) {
1676 if (prog->_LinkedShaders[j] == NULL)
1677 continue;
1678
1679 foreach_list(node2, prog->_LinkedShaders[j]->ir) {
1680 ir_variable *other_var = ((ir_instruction *) node2)->as_variable();
1681 if (!other_var)
1682 continue;
1683
1684 if (strcmp(var->name, other_var->name) == 0 &&
1685 other_var->data.max_array_access > size) {
1686 size = other_var->data.max_array_access;
1687 }
1688 }
1689 }
1690
1691 if (size + 1 != var->type->length) {
1692 /* If this is a built-in uniform (i.e., it's backed by some
1693 * fixed-function state), adjust the number of state slots to
1694 * match the new array size. The number of slots per array entry
1695 * is not known. It seems safe to assume that the total number of
1696 * slots is an integer multiple of the number of array elements.
1697 * Determine the number of slots per array element by dividing by
1698 * the old (total) size.
1699 */
1700 if (var->num_state_slots > 0) {
1701 var->num_state_slots = (size + 1)
1702 * (var->num_state_slots / var->type->length);
1703 }
1704
1705 var->type = glsl_type::get_array_instance(var->type->fields.array,
1706 size + 1);
1707 /* FINISHME: We should update the types of array
1708 * dereferences of this variable now.
1709 */
1710 }
1711 }
1712 }
1713 }
1714
1715 /**
1716 * Find a contiguous set of available bits in a bitmask.
1717 *
1718 * \param used_mask Bits representing used (1) and unused (0) locations
1719 * \param needed_count Number of contiguous bits needed.
1720 *
1721 * \return
1722 * Base location of the available bits on success or -1 on failure.
1723 */
1724 int
1725 find_available_slots(unsigned used_mask, unsigned needed_count)
1726 {
1727 unsigned needed_mask = (1 << needed_count) - 1;
1728 const int max_bit_to_test = (8 * sizeof(used_mask)) - needed_count;
1729
1730 /* The comparison to 32 is redundant, but without it GCC emits "warning:
1731 * cannot optimize possibly infinite loops" for the loop below.
1732 */
1733 if ((needed_count == 0) || (max_bit_to_test < 0) || (max_bit_to_test > 32))
1734 return -1;
1735
1736 for (int i = 0; i <= max_bit_to_test; i++) {
1737 if ((needed_mask & ~used_mask) == needed_mask)
1738 return i;
1739
1740 needed_mask <<= 1;
1741 }
1742
1743 return -1;
1744 }
1745
1746
1747 /**
1748 * Assign locations for either VS inputs for FS outputs
1749 *
1750 * \param prog Shader program whose variables need locations assigned
1751 * \param target_index Selector for the program target to receive location
1752 * assignmnets. Must be either \c MESA_SHADER_VERTEX or
1753 * \c MESA_SHADER_FRAGMENT.
1754 * \param max_index Maximum number of generic locations. This corresponds
1755 * to either the maximum number of draw buffers or the
1756 * maximum number of generic attributes.
1757 *
1758 * \return
1759 * If locations are successfully assigned, true is returned. Otherwise an
1760 * error is emitted to the shader link log and false is returned.
1761 */
1762 bool
1763 assign_attribute_or_color_locations(gl_shader_program *prog,
1764 unsigned target_index,
1765 unsigned max_index)
1766 {
1767 /* Mark invalid locations as being used.
1768 */
1769 unsigned used_locations = (max_index >= 32)
1770 ? ~0 : ~((1 << max_index) - 1);
1771
1772 assert((target_index == MESA_SHADER_VERTEX)
1773 || (target_index == MESA_SHADER_FRAGMENT));
1774
1775 gl_shader *const sh = prog->_LinkedShaders[target_index];
1776 if (sh == NULL)
1777 return true;
1778
1779 /* Operate in a total of four passes.
1780 *
1781 * 1. Invalidate the location assignments for all vertex shader inputs.
1782 *
1783 * 2. Assign locations for inputs that have user-defined (via
1784 * glBindVertexAttribLocation) locations and outputs that have
1785 * user-defined locations (via glBindFragDataLocation).
1786 *
1787 * 3. Sort the attributes without assigned locations by number of slots
1788 * required in decreasing order. Fragmentation caused by attribute
1789 * locations assigned by the application may prevent large attributes
1790 * from having enough contiguous space.
1791 *
1792 * 4. Assign locations to any inputs without assigned locations.
1793 */
1794
1795 const int generic_base = (target_index == MESA_SHADER_VERTEX)
1796 ? (int) VERT_ATTRIB_GENERIC0 : (int) FRAG_RESULT_DATA0;
1797
1798 const enum ir_variable_mode direction =
1799 (target_index == MESA_SHADER_VERTEX)
1800 ? ir_var_shader_in : ir_var_shader_out;
1801
1802
1803 /* Temporary storage for the set of attributes that need locations assigned.
1804 */
1805 struct temp_attr {
1806 unsigned slots;
1807 ir_variable *var;
1808
1809 /* Used below in the call to qsort. */
1810 static int compare(const void *a, const void *b)
1811 {
1812 const temp_attr *const l = (const temp_attr *) a;
1813 const temp_attr *const r = (const temp_attr *) b;
1814
1815 /* Reversed because we want a descending order sort below. */
1816 return r->slots - l->slots;
1817 }
1818 } to_assign[16];
1819
1820 unsigned num_attr = 0;
1821
1822 foreach_list(node, sh->ir) {
1823 ir_variable *const var = ((ir_instruction *) node)->as_variable();
1824
1825 if ((var == NULL) || (var->data.mode != (unsigned) direction))
1826 continue;
1827
1828 if (var->data.explicit_location) {
1829 if ((var->data.location >= (int)(max_index + generic_base))
1830 || (var->data.location < 0)) {
1831 linker_error(prog,
1832 "invalid explicit location %d specified for `%s'\n",
1833 (var->data.location < 0)
1834 ? var->data.location
1835 : var->data.location - generic_base,
1836 var->name);
1837 return false;
1838 }
1839 } else if (target_index == MESA_SHADER_VERTEX) {
1840 unsigned binding;
1841
1842 if (prog->AttributeBindings->get(binding, var->name)) {
1843 assert(binding >= VERT_ATTRIB_GENERIC0);
1844 var->data.location = binding;
1845 var->data.is_unmatched_generic_inout = 0;
1846 }
1847 } else if (target_index == MESA_SHADER_FRAGMENT) {
1848 unsigned binding;
1849 unsigned index;
1850
1851 if (prog->FragDataBindings->get(binding, var->name)) {
1852 assert(binding >= FRAG_RESULT_DATA0);
1853 var->data.location = binding;
1854 var->data.is_unmatched_generic_inout = 0;
1855
1856 if (prog->FragDataIndexBindings->get(index, var->name)) {
1857 var->data.index = index;
1858 }
1859 }
1860 }
1861
1862 /* If the variable is not a built-in and has a location statically
1863 * assigned in the shader (presumably via a layout qualifier), make sure
1864 * that it doesn't collide with other assigned locations. Otherwise,
1865 * add it to the list of variables that need linker-assigned locations.
1866 */
1867 const unsigned slots = var->type->count_attribute_slots();
1868 if (var->data.location != -1) {
1869 if (var->data.location >= generic_base && var->data.index < 1) {
1870 /* From page 61 of the OpenGL 4.0 spec:
1871 *
1872 * "LinkProgram will fail if the attribute bindings assigned
1873 * by BindAttribLocation do not leave not enough space to
1874 * assign a location for an active matrix attribute or an
1875 * active attribute array, both of which require multiple
1876 * contiguous generic attributes."
1877 *
1878 * I think above text prohibits the aliasing of explicit and
1879 * automatic assignments. But, aliasing is allowed in manual
1880 * assignments of attribute locations. See below comments for
1881 * the details.
1882 *
1883 * From OpenGL 4.0 spec, page 61:
1884 *
1885 * "It is possible for an application to bind more than one
1886 * attribute name to the same location. This is referred to as
1887 * aliasing. This will only work if only one of the aliased
1888 * attributes is active in the executable program, or if no
1889 * path through the shader consumes more than one attribute of
1890 * a set of attributes aliased to the same location. A link
1891 * error can occur if the linker determines that every path
1892 * through the shader consumes multiple aliased attributes,
1893 * but implementations are not required to generate an error
1894 * in this case."
1895 *
1896 * From GLSL 4.30 spec, page 54:
1897 *
1898 * "A program will fail to link if any two non-vertex shader
1899 * input variables are assigned to the same location. For
1900 * vertex shaders, multiple input variables may be assigned
1901 * to the same location using either layout qualifiers or via
1902 * the OpenGL API. However, such aliasing is intended only to
1903 * support vertex shaders where each execution path accesses
1904 * at most one input per each location. Implementations are
1905 * permitted, but not required, to generate link-time errors
1906 * if they detect that every path through the vertex shader
1907 * executable accesses multiple inputs assigned to any single
1908 * location. For all shader types, a program will fail to link
1909 * if explicit location assignments leave the linker unable
1910 * to find space for other variables without explicit
1911 * assignments."
1912 *
1913 * From OpenGL ES 3.0 spec, page 56:
1914 *
1915 * "Binding more than one attribute name to the same location
1916 * is referred to as aliasing, and is not permitted in OpenGL
1917 * ES Shading Language 3.00 vertex shaders. LinkProgram will
1918 * fail when this condition exists. However, aliasing is
1919 * possible in OpenGL ES Shading Language 1.00 vertex shaders.
1920 * This will only work if only one of the aliased attributes
1921 * is active in the executable program, or if no path through
1922 * the shader consumes more than one attribute of a set of
1923 * attributes aliased to the same location. A link error can
1924 * occur if the linker determines that every path through the
1925 * shader consumes multiple aliased attributes, but implemen-
1926 * tations are not required to generate an error in this case."
1927 *
1928 * After looking at above references from OpenGL, OpenGL ES and
1929 * GLSL specifications, we allow aliasing of vertex input variables
1930 * in: OpenGL 2.0 (and above) and OpenGL ES 2.0.
1931 *
1932 * NOTE: This is not required by the spec but its worth mentioning
1933 * here that we're not doing anything to make sure that no path
1934 * through the vertex shader executable accesses multiple inputs
1935 * assigned to any single location.
1936 */
1937
1938 /* Mask representing the contiguous slots that will be used by
1939 * this attribute.
1940 */
1941 const unsigned attr = var->data.location - generic_base;
1942 const unsigned use_mask = (1 << slots) - 1;
1943 const char *const string = (target_index == MESA_SHADER_VERTEX)
1944 ? "vertex shader input" : "fragment shader output";
1945
1946 /* Generate a link error if the requested locations for this
1947 * attribute exceed the maximum allowed attribute location.
1948 */
1949 if (attr + slots > max_index) {
1950 linker_error(prog,
1951 "insufficient contiguous locations "
1952 "available for %s `%s' %d %d %d", string,
1953 var->name, used_locations, use_mask, attr);
1954 return false;
1955 }
1956
1957 /* Generate a link error if the set of bits requested for this
1958 * attribute overlaps any previously allocated bits.
1959 */
1960 if ((~(use_mask << attr) & used_locations) != used_locations) {
1961 if (target_index == MESA_SHADER_FRAGMENT ||
1962 (prog->IsES && prog->Version >= 300)) {
1963 linker_error(prog,
1964 "overlapping location is assigned "
1965 "to %s `%s' %d %d %d\n", string,
1966 var->name, used_locations, use_mask, attr);
1967 return false;
1968 } else {
1969 linker_warning(prog,
1970 "overlapping location is assigned "
1971 "to %s `%s' %d %d %d\n", string,
1972 var->name, used_locations, use_mask, attr);
1973 }
1974 }
1975
1976 used_locations |= (use_mask << attr);
1977 }
1978
1979 continue;
1980 }
1981
1982 to_assign[num_attr].slots = slots;
1983 to_assign[num_attr].var = var;
1984 num_attr++;
1985 }
1986
1987 /* If all of the attributes were assigned locations by the application (or
1988 * are built-in attributes with fixed locations), return early. This should
1989 * be the common case.
1990 */
1991 if (num_attr == 0)
1992 return true;
1993
1994 qsort(to_assign, num_attr, sizeof(to_assign[0]), temp_attr::compare);
1995
1996 if (target_index == MESA_SHADER_VERTEX) {
1997 /* VERT_ATTRIB_GENERIC0 is a pseudo-alias for VERT_ATTRIB_POS. It can
1998 * only be explicitly assigned by via glBindAttribLocation. Mark it as
1999 * reserved to prevent it from being automatically allocated below.
2000 */
2001 find_deref_visitor find("gl_Vertex");
2002 find.run(sh->ir);
2003 if (find.variable_found())
2004 used_locations |= (1 << 0);
2005 }
2006
2007 for (unsigned i = 0; i < num_attr; i++) {
2008 /* Mask representing the contiguous slots that will be used by this
2009 * attribute.
2010 */
2011 const unsigned use_mask = (1 << to_assign[i].slots) - 1;
2012
2013 int location = find_available_slots(used_locations, to_assign[i].slots);
2014
2015 if (location < 0) {
2016 const char *const string = (target_index == MESA_SHADER_VERTEX)
2017 ? "vertex shader input" : "fragment shader output";
2018
2019 linker_error(prog,
2020 "insufficient contiguous locations "
2021 "available for %s `%s'",
2022 string, to_assign[i].var->name);
2023 return false;
2024 }
2025
2026 to_assign[i].var->data.location = generic_base + location;
2027 to_assign[i].var->data.is_unmatched_generic_inout = 0;
2028 used_locations |= (use_mask << location);
2029 }
2030
2031 return true;
2032 }
2033
2034
2035 /**
2036 * Demote shader inputs and outputs that are not used in other stages
2037 */
2038 void
2039 demote_shader_inputs_and_outputs(gl_shader *sh, enum ir_variable_mode mode)
2040 {
2041 foreach_list(node, sh->ir) {
2042 ir_variable *const var = ((ir_instruction *) node)->as_variable();
2043
2044 if ((var == NULL) || (var->data.mode != int(mode)))
2045 continue;
2046
2047 /* A shader 'in' or 'out' variable is only really an input or output if
2048 * its value is used by other shader stages. This will cause the variable
2049 * to have a location assigned.
2050 */
2051 if (var->data.is_unmatched_generic_inout) {
2052 var->data.mode = ir_var_auto;
2053 }
2054 }
2055 }
2056
2057
2058 /**
2059 * Store the gl_FragDepth layout in the gl_shader_program struct.
2060 */
2061 static void
2062 store_fragdepth_layout(struct gl_shader_program *prog)
2063 {
2064 if (prog->_LinkedShaders[MESA_SHADER_FRAGMENT] == NULL) {
2065 return;
2066 }
2067
2068 struct exec_list *ir = prog->_LinkedShaders[MESA_SHADER_FRAGMENT]->ir;
2069
2070 /* We don't look up the gl_FragDepth symbol directly because if
2071 * gl_FragDepth is not used in the shader, it's removed from the IR.
2072 * However, the symbol won't be removed from the symbol table.
2073 *
2074 * We're only interested in the cases where the variable is NOT removed
2075 * from the IR.
2076 */
2077 foreach_list(node, ir) {
2078 ir_variable *const var = ((ir_instruction *) node)->as_variable();
2079
2080 if (var == NULL || var->data.mode != ir_var_shader_out) {
2081 continue;
2082 }
2083
2084 if (strcmp(var->name, "gl_FragDepth") == 0) {
2085 switch (var->data.depth_layout) {
2086 case ir_depth_layout_none:
2087 prog->FragDepthLayout = FRAG_DEPTH_LAYOUT_NONE;
2088 return;
2089 case ir_depth_layout_any:
2090 prog->FragDepthLayout = FRAG_DEPTH_LAYOUT_ANY;
2091 return;
2092 case ir_depth_layout_greater:
2093 prog->FragDepthLayout = FRAG_DEPTH_LAYOUT_GREATER;
2094 return;
2095 case ir_depth_layout_less:
2096 prog->FragDepthLayout = FRAG_DEPTH_LAYOUT_LESS;
2097 return;
2098 case ir_depth_layout_unchanged:
2099 prog->FragDepthLayout = FRAG_DEPTH_LAYOUT_UNCHANGED;
2100 return;
2101 default:
2102 assert(0);
2103 return;
2104 }
2105 }
2106 }
2107 }
2108
2109 /**
2110 * Validate the resources used by a program versus the implementation limits
2111 */
2112 static void
2113 check_resources(struct gl_context *ctx, struct gl_shader_program *prog)
2114 {
2115 for (unsigned i = 0; i < MESA_SHADER_STAGES; i++) {
2116 struct gl_shader *sh = prog->_LinkedShaders[i];
2117
2118 if (sh == NULL)
2119 continue;
2120
2121 if (sh->num_samplers > ctx->Const.Program[i].MaxTextureImageUnits) {
2122 linker_error(prog, "Too many %s shader texture samplers",
2123 _mesa_shader_stage_to_string(i));
2124 }
2125
2126 if (sh->num_uniform_components >
2127 ctx->Const.Program[i].MaxUniformComponents) {
2128 if (ctx->Const.GLSLSkipStrictMaxUniformLimitCheck) {
2129 linker_warning(prog, "Too many %s shader default uniform block "
2130 "components, but the driver will try to optimize "
2131 "them out; this is non-portable out-of-spec "
2132 "behavior\n",
2133 _mesa_shader_stage_to_string(i));
2134 } else {
2135 linker_error(prog, "Too many %s shader default uniform block "
2136 "components",
2137 _mesa_shader_stage_to_string(i));
2138 }
2139 }
2140
2141 if (sh->num_combined_uniform_components >
2142 ctx->Const.Program[i].MaxCombinedUniformComponents) {
2143 if (ctx->Const.GLSLSkipStrictMaxUniformLimitCheck) {
2144 linker_warning(prog, "Too many %s shader uniform components, "
2145 "but the driver will try to optimize them out; "
2146 "this is non-portable out-of-spec behavior\n",
2147 _mesa_shader_stage_to_string(i));
2148 } else {
2149 linker_error(prog, "Too many %s shader uniform components",
2150 _mesa_shader_stage_to_string(i));
2151 }
2152 }
2153 }
2154
2155 unsigned blocks[MESA_SHADER_STAGES] = {0};
2156 unsigned total_uniform_blocks = 0;
2157
2158 for (unsigned i = 0; i < prog->NumUniformBlocks; i++) {
2159 for (unsigned j = 0; j < MESA_SHADER_STAGES; j++) {
2160 if (prog->UniformBlockStageIndex[j][i] != -1) {
2161 blocks[j]++;
2162 total_uniform_blocks++;
2163 }
2164 }
2165
2166 if (total_uniform_blocks > ctx->Const.MaxCombinedUniformBlocks) {
2167 linker_error(prog, "Too many combined uniform blocks (%d/%d)",
2168 prog->NumUniformBlocks,
2169 ctx->Const.MaxCombinedUniformBlocks);
2170 } else {
2171 for (unsigned i = 0; i < MESA_SHADER_STAGES; i++) {
2172 const unsigned max_uniform_blocks =
2173 ctx->Const.Program[i].MaxUniformBlocks;
2174 if (blocks[i] > max_uniform_blocks) {
2175 linker_error(prog, "Too many %s uniform blocks (%d/%d)",
2176 _mesa_shader_stage_to_string(i),
2177 blocks[i],
2178 max_uniform_blocks);
2179 break;
2180 }
2181 }
2182 }
2183 }
2184 }
2185
2186 /**
2187 * Validate shader image resources.
2188 */
2189 static void
2190 check_image_resources(struct gl_context *ctx, struct gl_shader_program *prog)
2191 {
2192 unsigned total_image_units = 0;
2193 unsigned fragment_outputs = 0;
2194
2195 if (!ctx->Extensions.ARB_shader_image_load_store)
2196 return;
2197
2198 for (unsigned i = 0; i < MESA_SHADER_STAGES; i++) {
2199 struct gl_shader *sh = prog->_LinkedShaders[i];
2200
2201 if (sh) {
2202 if (sh->NumImages > ctx->Const.Program[i].MaxImageUniforms)
2203 linker_error(prog, "Too many %s shader image uniforms",
2204 _mesa_shader_stage_to_string(i));
2205
2206 total_image_units += sh->NumImages;
2207
2208 if (i == MESA_SHADER_FRAGMENT) {
2209 foreach_list(node, sh->ir) {
2210 ir_variable *var = ((ir_instruction *)node)->as_variable();
2211 if (var && var->data.mode == ir_var_shader_out)
2212 fragment_outputs += var->type->count_attribute_slots();
2213 }
2214 }
2215 }
2216 }
2217
2218 if (total_image_units > ctx->Const.MaxCombinedImageUniforms)
2219 linker_error(prog, "Too many combined image uniforms");
2220
2221 if (total_image_units + fragment_outputs >
2222 ctx->Const.MaxCombinedImageUnitsAndFragmentOutputs)
2223 linker_error(prog, "Too many combined image uniforms and fragment outputs");
2224 }
2225
2226 void
2227 link_shaders(struct gl_context *ctx, struct gl_shader_program *prog)
2228 {
2229 tfeedback_decl *tfeedback_decls = NULL;
2230 unsigned num_tfeedback_decls = prog->TransformFeedback.NumVarying;
2231
2232 void *mem_ctx = ralloc_context(NULL); // temporary linker context
2233
2234 prog->LinkStatus = true; /* All error paths will set this to false */
2235 prog->Validated = false;
2236 prog->_Used = false;
2237
2238 ralloc_free(prog->InfoLog);
2239 prog->InfoLog = ralloc_strdup(NULL, "");
2240
2241 ralloc_free(prog->UniformBlocks);
2242 prog->UniformBlocks = NULL;
2243 prog->NumUniformBlocks = 0;
2244 for (int i = 0; i < MESA_SHADER_STAGES; i++) {
2245 ralloc_free(prog->UniformBlockStageIndex[i]);
2246 prog->UniformBlockStageIndex[i] = NULL;
2247 }
2248
2249 ralloc_free(prog->AtomicBuffers);
2250 prog->AtomicBuffers = NULL;
2251 prog->NumAtomicBuffers = 0;
2252
2253 /* Separate the shaders into groups based on their type.
2254 */
2255 struct gl_shader **shader_list[MESA_SHADER_STAGES];
2256 unsigned num_shaders[MESA_SHADER_STAGES];
2257
2258 for (int i = 0; i < MESA_SHADER_STAGES; i++) {
2259 shader_list[i] = (struct gl_shader **)
2260 calloc(prog->NumShaders, sizeof(struct gl_shader *));
2261 num_shaders[i] = 0;
2262 }
2263
2264 unsigned min_version = UINT_MAX;
2265 unsigned max_version = 0;
2266 const bool is_es_prog =
2267 (prog->NumShaders > 0 && prog->Shaders[0]->IsES) ? true : false;
2268 for (unsigned i = 0; i < prog->NumShaders; i++) {
2269 min_version = MIN2(min_version, prog->Shaders[i]->Version);
2270 max_version = MAX2(max_version, prog->Shaders[i]->Version);
2271
2272 if (prog->Shaders[i]->IsES != is_es_prog) {
2273 linker_error(prog, "all shaders must use same shading "
2274 "language version\n");
2275 goto done;
2276 }
2277
2278 gl_shader_stage shader_type = prog->Shaders[i]->Stage;
2279 shader_list[shader_type][num_shaders[shader_type]] = prog->Shaders[i];
2280 num_shaders[shader_type]++;
2281 }
2282
2283 /* In desktop GLSL, different shader versions may be linked together. In
2284 * GLSL ES, all shader versions must be the same.
2285 */
2286 if (is_es_prog && min_version != max_version) {
2287 linker_error(prog, "all shaders must use same shading "
2288 "language version\n");
2289 goto done;
2290 }
2291
2292 prog->Version = max_version;
2293 prog->IsES = is_es_prog;
2294
2295 /* Geometry shaders have to be linked with vertex shaders.
2296 */
2297 if (num_shaders[MESA_SHADER_GEOMETRY] > 0 &&
2298 num_shaders[MESA_SHADER_VERTEX] == 0) {
2299 linker_error(prog, "Geometry shader must be linked with "
2300 "vertex shader\n");
2301 goto done;
2302 }
2303
2304 /* Compute shaders have additional restrictions. */
2305 if (num_shaders[MESA_SHADER_COMPUTE] > 0 &&
2306 num_shaders[MESA_SHADER_COMPUTE] != prog->NumShaders) {
2307 linker_error(prog, "Compute shaders may not be linked with any other "
2308 "type of shader\n");
2309 }
2310
2311 for (unsigned int i = 0; i < MESA_SHADER_STAGES; i++) {
2312 if (prog->_LinkedShaders[i] != NULL)
2313 ctx->Driver.DeleteShader(ctx, prog->_LinkedShaders[i]);
2314
2315 prog->_LinkedShaders[i] = NULL;
2316 }
2317
2318 /* Link all shaders for a particular stage and validate the result.
2319 */
2320 for (int stage = 0; stage < MESA_SHADER_STAGES; stage++) {
2321 if (num_shaders[stage] > 0) {
2322 gl_shader *const sh =
2323 link_intrastage_shaders(mem_ctx, ctx, prog, shader_list[stage],
2324 num_shaders[stage]);
2325
2326 if (!prog->LinkStatus)
2327 goto done;
2328
2329 switch (stage) {
2330 case MESA_SHADER_VERTEX:
2331 validate_vertex_shader_executable(prog, sh);
2332 break;
2333 case MESA_SHADER_GEOMETRY:
2334 validate_geometry_shader_executable(prog, sh);
2335 break;
2336 case MESA_SHADER_FRAGMENT:
2337 validate_fragment_shader_executable(prog, sh);
2338 break;
2339 }
2340 if (!prog->LinkStatus)
2341 goto done;
2342
2343 _mesa_reference_shader(ctx, &prog->_LinkedShaders[stage], sh);
2344 }
2345 }
2346
2347 if (num_shaders[MESA_SHADER_GEOMETRY] > 0)
2348 prog->LastClipDistanceArraySize = prog->Geom.ClipDistanceArraySize;
2349 else if (num_shaders[MESA_SHADER_VERTEX] > 0)
2350 prog->LastClipDistanceArraySize = prog->Vert.ClipDistanceArraySize;
2351 else
2352 prog->LastClipDistanceArraySize = 0; /* Not used */
2353
2354 /* Here begins the inter-stage linking phase. Some initial validation is
2355 * performed, then locations are assigned for uniforms, attributes, and
2356 * varyings.
2357 */
2358 cross_validate_uniforms(prog);
2359 if (!prog->LinkStatus)
2360 goto done;
2361
2362 unsigned prev;
2363
2364 for (prev = 0; prev <= MESA_SHADER_FRAGMENT; prev++) {
2365 if (prog->_LinkedShaders[prev] != NULL)
2366 break;
2367 }
2368
2369 /* Validate the inputs of each stage with the output of the preceding
2370 * stage.
2371 */
2372 for (unsigned i = prev + 1; i <= MESA_SHADER_FRAGMENT; i++) {
2373 if (prog->_LinkedShaders[i] == NULL)
2374 continue;
2375
2376 validate_interstage_inout_blocks(prog, prog->_LinkedShaders[prev],
2377 prog->_LinkedShaders[i]);
2378 if (!prog->LinkStatus)
2379 goto done;
2380
2381 cross_validate_outputs_to_inputs(prog,
2382 prog->_LinkedShaders[prev],
2383 prog->_LinkedShaders[i]);
2384 if (!prog->LinkStatus)
2385 goto done;
2386
2387 prev = i;
2388 }
2389
2390 /* Cross-validate uniform blocks between shader stages */
2391 validate_interstage_uniform_blocks(prog, prog->_LinkedShaders,
2392 MESA_SHADER_STAGES);
2393 if (!prog->LinkStatus)
2394 goto done;
2395
2396 for (unsigned int i = 0; i < MESA_SHADER_STAGES; i++) {
2397 if (prog->_LinkedShaders[i] != NULL)
2398 lower_named_interface_blocks(mem_ctx, prog->_LinkedShaders[i]);
2399 }
2400
2401 /* Implement the GLSL 1.30+ rule for discard vs infinite loops Do
2402 * it before optimization because we want most of the checks to get
2403 * dropped thanks to constant propagation.
2404 *
2405 * This rule also applies to GLSL ES 3.00.
2406 */
2407 if (max_version >= (is_es_prog ? 300 : 130)) {
2408 struct gl_shader *sh = prog->_LinkedShaders[MESA_SHADER_FRAGMENT];
2409 if (sh) {
2410 lower_discard_flow(sh->ir);
2411 }
2412 }
2413
2414 if (!interstage_cross_validate_uniform_blocks(prog))
2415 goto done;
2416
2417 /* Do common optimization before assigning storage for attributes,
2418 * uniforms, and varyings. Later optimization could possibly make
2419 * some of that unused.
2420 */
2421 for (unsigned i = 0; i < MESA_SHADER_STAGES; i++) {
2422 if (prog->_LinkedShaders[i] == NULL)
2423 continue;
2424
2425 detect_recursion_linked(prog, prog->_LinkedShaders[i]->ir);
2426 if (!prog->LinkStatus)
2427 goto done;
2428
2429 if (ctx->ShaderCompilerOptions[i].LowerClipDistance) {
2430 lower_clip_distance(prog->_LinkedShaders[i]);
2431 }
2432
2433 while (do_common_optimization(prog->_LinkedShaders[i]->ir, true, false,
2434 &ctx->ShaderCompilerOptions[i],
2435 ctx->Const.NativeIntegers))
2436 ;
2437 }
2438
2439 /* Mark all generic shader inputs and outputs as unpaired. */
2440 for (unsigned i = MESA_SHADER_VERTEX; i <= MESA_SHADER_FRAGMENT; i++) {
2441 if (prog->_LinkedShaders[i] != NULL) {
2442 link_invalidate_variable_locations(prog->_LinkedShaders[i]->ir);
2443 }
2444 }
2445
2446 /* FINISHME: The value of the max_attribute_index parameter is
2447 * FINISHME: implementation dependent based on the value of
2448 * FINISHME: GL_MAX_VERTEX_ATTRIBS. GL_MAX_VERTEX_ATTRIBS must be
2449 * FINISHME: at least 16, so hardcode 16 for now.
2450 */
2451 if (!assign_attribute_or_color_locations(prog, MESA_SHADER_VERTEX, 16)) {
2452 goto done;
2453 }
2454
2455 if (!assign_attribute_or_color_locations(prog, MESA_SHADER_FRAGMENT, MAX2(ctx->Const.MaxDrawBuffers, ctx->Const.MaxDualSourceDrawBuffers))) {
2456 goto done;
2457 }
2458
2459 unsigned first;
2460 for (first = 0; first <= MESA_SHADER_FRAGMENT; first++) {
2461 if (prog->_LinkedShaders[first] != NULL)
2462 break;
2463 }
2464
2465 if (num_tfeedback_decls != 0) {
2466 /* From GL_EXT_transform_feedback:
2467 * A program will fail to link if:
2468 *
2469 * * the <count> specified by TransformFeedbackVaryingsEXT is
2470 * non-zero, but the program object has no vertex or geometry
2471 * shader;
2472 */
2473 if (first == MESA_SHADER_FRAGMENT) {
2474 linker_error(prog, "Transform feedback varyings specified, but "
2475 "no vertex or geometry shader is present.");
2476 goto done;
2477 }
2478
2479 tfeedback_decls = ralloc_array(mem_ctx, tfeedback_decl,
2480 prog->TransformFeedback.NumVarying);
2481 if (!parse_tfeedback_decls(ctx, prog, mem_ctx, num_tfeedback_decls,
2482 prog->TransformFeedback.VaryingNames,
2483 tfeedback_decls))
2484 goto done;
2485 }
2486
2487 /* Linking the stages in the opposite order (from fragment to vertex)
2488 * ensures that inter-shader outputs written to in an earlier stage are
2489 * eliminated if they are (transitively) not used in a later stage.
2490 */
2491 int last, next;
2492 for (last = MESA_SHADER_FRAGMENT; last >= 0; last--) {
2493 if (prog->_LinkedShaders[last] != NULL)
2494 break;
2495 }
2496
2497 if (last >= 0 && last < MESA_SHADER_FRAGMENT) {
2498 gl_shader *const sh = prog->_LinkedShaders[last];
2499
2500 if (num_tfeedback_decls != 0) {
2501 /* There was no fragment shader, but we still have to assign varying
2502 * locations for use by transform feedback.
2503 */
2504 if (!assign_varying_locations(ctx, mem_ctx, prog,
2505 sh, NULL,
2506 num_tfeedback_decls, tfeedback_decls,
2507 0))
2508 goto done;
2509 }
2510
2511 do_dead_builtin_varyings(ctx, sh, NULL,
2512 num_tfeedback_decls, tfeedback_decls);
2513
2514 demote_shader_inputs_and_outputs(sh, ir_var_shader_out);
2515
2516 /* Eliminate code that is now dead due to unused outputs being demoted.
2517 */
2518 while (do_dead_code(sh->ir, false))
2519 ;
2520 }
2521 else if (first == MESA_SHADER_FRAGMENT) {
2522 /* If the program only contains a fragment shader...
2523 */
2524 gl_shader *const sh = prog->_LinkedShaders[first];
2525
2526 do_dead_builtin_varyings(ctx, NULL, sh,
2527 num_tfeedback_decls, tfeedback_decls);
2528
2529 demote_shader_inputs_and_outputs(sh, ir_var_shader_in);
2530
2531 while (do_dead_code(sh->ir, false))
2532 ;
2533 }
2534
2535 next = last;
2536 for (int i = next - 1; i >= 0; i--) {
2537 if (prog->_LinkedShaders[i] == NULL)
2538 continue;
2539
2540 gl_shader *const sh_i = prog->_LinkedShaders[i];
2541 gl_shader *const sh_next = prog->_LinkedShaders[next];
2542 unsigned gs_input_vertices =
2543 next == MESA_SHADER_GEOMETRY ? prog->Geom.VerticesIn : 0;
2544
2545 if (!assign_varying_locations(ctx, mem_ctx, prog, sh_i, sh_next,
2546 next == MESA_SHADER_FRAGMENT ? num_tfeedback_decls : 0,
2547 tfeedback_decls, gs_input_vertices))
2548 goto done;
2549
2550 do_dead_builtin_varyings(ctx, sh_i, sh_next,
2551 next == MESA_SHADER_FRAGMENT ? num_tfeedback_decls : 0,
2552 tfeedback_decls);
2553
2554 demote_shader_inputs_and_outputs(sh_i, ir_var_shader_out);
2555 demote_shader_inputs_and_outputs(sh_next, ir_var_shader_in);
2556
2557 /* Eliminate code that is now dead due to unused outputs being demoted.
2558 */
2559 while (do_dead_code(sh_i->ir, false))
2560 ;
2561 while (do_dead_code(sh_next->ir, false))
2562 ;
2563
2564 /* This must be done after all dead varyings are eliminated. */
2565 if (!check_against_output_limit(ctx, prog, sh_i))
2566 goto done;
2567 if (!check_against_input_limit(ctx, prog, sh_next))
2568 goto done;
2569
2570 next = i;
2571 }
2572
2573 if (!store_tfeedback_info(ctx, prog, num_tfeedback_decls, tfeedback_decls))
2574 goto done;
2575
2576 update_array_sizes(prog);
2577 link_assign_uniform_locations(prog);
2578 link_assign_atomic_counter_resources(ctx, prog);
2579 store_fragdepth_layout(prog);
2580
2581 check_resources(ctx, prog);
2582 check_image_resources(ctx, prog);
2583 link_check_atomic_counter_resources(ctx, prog);
2584
2585 if (!prog->LinkStatus)
2586 goto done;
2587
2588 /* OpenGL ES requires that a vertex shader and a fragment shader both be
2589 * present in a linked program. GL_ARB_ES2_compatibility doesn't say
2590 * anything about shader linking when one of the shaders (vertex or
2591 * fragment shader) is absent. So, the extension shouldn't change the
2592 * behavior specified in GLSL specification.
2593 */
2594 if (!prog->InternalSeparateShader && ctx->API == API_OPENGLES2) {
2595 if (prog->_LinkedShaders[MESA_SHADER_VERTEX] == NULL) {
2596 linker_error(prog, "program lacks a vertex shader\n");
2597 } else if (prog->_LinkedShaders[MESA_SHADER_FRAGMENT] == NULL) {
2598 linker_error(prog, "program lacks a fragment shader\n");
2599 }
2600 }
2601
2602 /* FINISHME: Assign fragment shader output locations. */
2603
2604 done:
2605 for (unsigned i = 0; i < MESA_SHADER_STAGES; i++) {
2606 free(shader_list[i]);
2607 if (prog->_LinkedShaders[i] == NULL)
2608 continue;
2609
2610 /* Do a final validation step to make sure that the IR wasn't
2611 * invalidated by any modifications performed after intrastage linking.
2612 */
2613 validate_ir_tree(prog->_LinkedShaders[i]->ir);
2614
2615 /* Retain any live IR, but trash the rest. */
2616 reparent_ir(prog->_LinkedShaders[i]->ir, prog->_LinkedShaders[i]->ir);
2617
2618 /* The symbol table in the linked shaders may contain references to
2619 * variables that were removed (e.g., unused uniforms). Since it may
2620 * contain junk, there is no possible valid use. Delete it and set the
2621 * pointer to NULL.
2622 */
2623 delete prog->_LinkedShaders[i]->symbols;
2624 prog->_LinkedShaders[i]->symbols = NULL;
2625 }
2626
2627 ralloc_free(mem_ctx);
2628 }