2 * Copyright © 2011 Intel Corporation
4 * Permission is hereby granted, free of charge, to any person obtaining a
5 * copy of this software and associated documentation files (the "Software"),
6 * to deal in the Software without restriction, including without limitation
7 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
8 * and/or sell copies of the Software, and to permit persons to whom the
9 * Software is furnished to do so, subject to the following conditions:
11 * The above copyright notice and this permission notice (including the next
12 * paragraph) shall be included in all copies or substantial portions of the
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
18 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
21 * DEALINGS IN THE SOFTWARE.
25 * \file shader_query.cpp
26 * C-to-C++ bridge functions to query GLSL shader data
28 * \author Ian Romanick <ian.d.romanick@intel.com>
31 #include "main/context.h"
32 #include "main/core.h"
33 #include "main/enums.h"
34 #include "main/shaderapi.h"
35 #include "main/shaderobj.h"
36 #include "main/uniforms.h"
37 #include "glsl/glsl_symbol_table.h"
39 #include "glsl/program.h"
40 #include "program/hash_table.h"
41 #include "util/strndup.h"
45 program_resource_location(struct gl_shader_program
*shProg
,
46 struct gl_program_resource
*res
, const char *name
,
47 unsigned array_index
);
50 * Declare convenience functions to return resource data in a given type.
51 * Warning! this is not type safe so be *very* careful when using these.
53 #define DECL_RESOURCE_FUNC(name, type) \
54 const type * RESOURCE_ ## name (gl_program_resource *res) { \
56 return (type *) res->Data; \
59 DECL_RESOURCE_FUNC(VAR
, ir_variable
);
60 DECL_RESOURCE_FUNC(UBO
, gl_uniform_block
);
61 DECL_RESOURCE_FUNC(UNI
, gl_uniform_storage
);
62 DECL_RESOURCE_FUNC(ATC
, gl_active_atomic_buffer
);
63 DECL_RESOURCE_FUNC(XFB
, gl_transform_feedback_varying_info
);
64 DECL_RESOURCE_FUNC(SUB
, gl_subroutine_function
);
67 _mesa_BindAttribLocation(GLhandleARB program
, GLuint index
,
68 const GLcharARB
*name
)
70 GET_CURRENT_CONTEXT(ctx
);
72 struct gl_shader_program
*const shProg
=
73 _mesa_lookup_shader_program_err(ctx
, program
, "glBindAttribLocation");
80 if (strncmp(name
, "gl_", 3) == 0) {
81 _mesa_error(ctx
, GL_INVALID_OPERATION
,
82 "glBindAttribLocation(illegal name)");
86 if (index
>= ctx
->Const
.Program
[MESA_SHADER_VERTEX
].MaxAttribs
) {
87 _mesa_error(ctx
, GL_INVALID_VALUE
, "glBindAttribLocation(index)");
91 /* Replace the current value if it's already in the list. Add
92 * VERT_ATTRIB_GENERIC0 because that's how the linker differentiates
93 * between built-in attributes and user-defined attributes.
95 shProg
->AttributeBindings
->put(index
+ VERT_ATTRIB_GENERIC0
, name
);
98 * Note that this attribute binding won't go into effect until
99 * glLinkProgram is called again.
104 is_active_attrib(const ir_variable
*var
)
109 switch (var
->data
.mode
) {
110 case ir_var_shader_in
:
111 return var
->data
.location
!= -1;
113 case ir_var_system_value
:
114 /* From GL 4.3 core spec, section 11.1.1 (Vertex Attributes):
115 * "For GetActiveAttrib, all active vertex shader input variables
116 * are enumerated, including the special built-in inputs gl_VertexID
117 * and gl_InstanceID."
119 return var
->data
.location
== SYSTEM_VALUE_VERTEX_ID
||
120 var
->data
.location
== SYSTEM_VALUE_VERTEX_ID_ZERO_BASE
||
121 var
->data
.location
== SYSTEM_VALUE_INSTANCE_ID
;
129 _mesa_GetActiveAttrib(GLhandleARB program
, GLuint desired_index
,
130 GLsizei maxLength
, GLsizei
* length
, GLint
* size
,
131 GLenum
* type
, GLcharARB
* name
)
133 GET_CURRENT_CONTEXT(ctx
);
134 struct gl_shader_program
*shProg
;
137 _mesa_error(ctx
, GL_INVALID_VALUE
, "glGetActiveAttrib(maxLength < 0)");
141 shProg
= _mesa_lookup_shader_program_err(ctx
, program
, "glGetActiveAttrib");
145 if (!shProg
->LinkStatus
) {
146 _mesa_error(ctx
, GL_INVALID_VALUE
,
147 "glGetActiveAttrib(program not linked)");
151 if (shProg
->_LinkedShaders
[MESA_SHADER_VERTEX
] == NULL
) {
152 _mesa_error(ctx
, GL_INVALID_VALUE
, "glGetActiveAttrib(no vertex shader)");
156 struct gl_program_resource
*res
=
157 _mesa_program_resource_find_index(shProg
, GL_PROGRAM_INPUT
,
160 /* User asked for index that does not exist. */
162 _mesa_error(ctx
, GL_INVALID_VALUE
, "glGetActiveAttrib(index)");
166 const ir_variable
*const var
= RESOURCE_VAR(res
);
168 if (!is_active_attrib(var
))
171 const char *var_name
= var
->name
;
173 /* Since gl_VertexID may be lowered to gl_VertexIDMESA, we need to
174 * consider gl_VertexIDMESA as gl_VertexID for purposes of checking
177 if (var
->data
.mode
== ir_var_system_value
&&
178 var
->data
.location
== SYSTEM_VALUE_VERTEX_ID_ZERO_BASE
) {
179 var_name
= "gl_VertexID";
182 _mesa_copy_string(name
, maxLength
, length
, var_name
);
185 _mesa_program_resource_prop(shProg
, res
, desired_index
, GL_ARRAY_SIZE
,
186 size
, "glGetActiveAttrib");
189 _mesa_program_resource_prop(shProg
, res
, desired_index
, GL_TYPE
,
190 (GLint
*) type
, "glGetActiveAttrib");
194 _mesa_GetAttribLocation(GLhandleARB program
, const GLcharARB
* name
)
196 GET_CURRENT_CONTEXT(ctx
);
197 struct gl_shader_program
*const shProg
=
198 _mesa_lookup_shader_program_err(ctx
, program
, "glGetAttribLocation");
204 if (!shProg
->LinkStatus
) {
205 _mesa_error(ctx
, GL_INVALID_OPERATION
,
206 "glGetAttribLocation(program not linked)");
213 /* Not having a vertex shader is not an error.
215 if (shProg
->_LinkedShaders
[MESA_SHADER_VERTEX
] == NULL
)
218 unsigned array_index
= 0;
219 struct gl_program_resource
*res
=
220 _mesa_program_resource_find_name(shProg
, GL_PROGRAM_INPUT
, name
,
226 GLint loc
= program_resource_location(shProg
, res
, name
, array_index
);
228 /* The extra check against against 0 is made because of builtin-attribute
229 * locations that have offset applied. Function program_resource_location
230 * can return built-in attribute locations < 0 and glGetAttribLocation
231 * cannot be used on "conventional" attributes.
233 * From page 95 of the OpenGL 3.0 spec:
235 * "If name is not an active attribute, if name is a conventional
236 * attribute, or if an error occurs, -1 will be returned."
238 return (loc
>= 0) ? loc
: -1;
242 _mesa_count_active_attribs(struct gl_shader_program
*shProg
)
244 if (!shProg
->LinkStatus
245 || shProg
->_LinkedShaders
[MESA_SHADER_VERTEX
] == NULL
) {
249 struct gl_program_resource
*res
= shProg
->ProgramResourceList
;
251 for (unsigned j
= 0; j
< shProg
->NumProgramResourceList
; j
++, res
++) {
252 if (res
->Type
== GL_PROGRAM_INPUT
&&
253 res
->StageReferences
& (1 << MESA_SHADER_VERTEX
) &&
254 is_active_attrib(RESOURCE_VAR(res
)))
262 _mesa_longest_attribute_name_length(struct gl_shader_program
*shProg
)
264 if (!shProg
->LinkStatus
265 || shProg
->_LinkedShaders
[MESA_SHADER_VERTEX
] == NULL
) {
269 struct gl_program_resource
*res
= shProg
->ProgramResourceList
;
271 for (unsigned j
= 0; j
< shProg
->NumProgramResourceList
; j
++, res
++) {
272 if (res
->Type
== GL_PROGRAM_INPUT
&&
273 res
->StageReferences
& (1 << MESA_SHADER_VERTEX
)) {
275 const size_t length
= strlen(RESOURCE_VAR(res
)->name
);
276 if (length
>= longest
)
277 longest
= length
+ 1;
285 _mesa_BindFragDataLocation(GLuint program
, GLuint colorNumber
,
288 _mesa_BindFragDataLocationIndexed(program
, colorNumber
, 0, name
);
292 _mesa_BindFragDataLocationIndexed(GLuint program
, GLuint colorNumber
,
293 GLuint index
, const GLchar
*name
)
295 GET_CURRENT_CONTEXT(ctx
);
297 struct gl_shader_program
*const shProg
=
298 _mesa_lookup_shader_program_err(ctx
, program
, "glBindFragDataLocationIndexed");
305 if (strncmp(name
, "gl_", 3) == 0) {
306 _mesa_error(ctx
, GL_INVALID_OPERATION
, "glBindFragDataLocationIndexed(illegal name)");
311 _mesa_error(ctx
, GL_INVALID_VALUE
, "glBindFragDataLocationIndexed(index)");
315 if (index
== 0 && colorNumber
>= ctx
->Const
.MaxDrawBuffers
) {
316 _mesa_error(ctx
, GL_INVALID_VALUE
, "glBindFragDataLocationIndexed(colorNumber)");
320 if (index
== 1 && colorNumber
>= ctx
->Const
.MaxDualSourceDrawBuffers
) {
321 _mesa_error(ctx
, GL_INVALID_VALUE
, "glBindFragDataLocationIndexed(colorNumber)");
325 /* Replace the current value if it's already in the list. Add
326 * FRAG_RESULT_DATA0 because that's how the linker differentiates
327 * between built-in attributes and user-defined attributes.
329 shProg
->FragDataBindings
->put(colorNumber
+ FRAG_RESULT_DATA0
, name
);
330 shProg
->FragDataIndexBindings
->put(index
, name
);
332 * Note that this binding won't go into effect until
333 * glLinkProgram is called again.
339 _mesa_GetFragDataIndex(GLuint program
, const GLchar
*name
)
341 GET_CURRENT_CONTEXT(ctx
);
342 struct gl_shader_program
*const shProg
=
343 _mesa_lookup_shader_program_err(ctx
, program
, "glGetFragDataIndex");
349 if (!shProg
->LinkStatus
) {
350 _mesa_error(ctx
, GL_INVALID_OPERATION
,
351 "glGetFragDataIndex(program not linked)");
358 if (strncmp(name
, "gl_", 3) == 0) {
359 _mesa_error(ctx
, GL_INVALID_OPERATION
,
360 "glGetFragDataIndex(illegal name)");
364 /* Not having a fragment shader is not an error.
366 if (shProg
->_LinkedShaders
[MESA_SHADER_FRAGMENT
] == NULL
)
369 return _mesa_program_resource_location_index(shProg
, GL_PROGRAM_OUTPUT
,
374 _mesa_GetFragDataLocation(GLuint program
, const GLchar
*name
)
376 GET_CURRENT_CONTEXT(ctx
);
377 struct gl_shader_program
*const shProg
=
378 _mesa_lookup_shader_program_err(ctx
, program
, "glGetFragDataLocation");
384 if (!shProg
->LinkStatus
) {
385 _mesa_error(ctx
, GL_INVALID_OPERATION
,
386 "glGetFragDataLocation(program not linked)");
393 if (strncmp(name
, "gl_", 3) == 0) {
394 _mesa_error(ctx
, GL_INVALID_OPERATION
,
395 "glGetFragDataLocation(illegal name)");
399 /* Not having a fragment shader is not an error.
401 if (shProg
->_LinkedShaders
[MESA_SHADER_FRAGMENT
] == NULL
)
404 unsigned array_index
= 0;
405 struct gl_program_resource
*res
=
406 _mesa_program_resource_find_name(shProg
, GL_PROGRAM_OUTPUT
, name
,
412 GLint loc
= program_resource_location(shProg
, res
, name
, array_index
);
414 /* The extra check against against 0 is made because of builtin-attribute
415 * locations that have offset applied. Function program_resource_location
416 * can return built-in attribute locations < 0 and glGetFragDataLocation
417 * cannot be used on "conventional" attributes.
419 * From page 95 of the OpenGL 3.0 spec:
421 * "If name is not an active attribute, if name is a conventional
422 * attribute, or if an error occurs, -1 will be returned."
424 return (loc
>= 0) ? loc
: -1;
428 _mesa_program_resource_name(struct gl_program_resource
*res
)
430 const ir_variable
*var
;
432 case GL_UNIFORM_BLOCK
:
433 case GL_SHADER_STORAGE_BLOCK
:
434 return RESOURCE_UBO(res
)->Name
;
435 case GL_TRANSFORM_FEEDBACK_VARYING
:
436 return RESOURCE_XFB(res
)->Name
;
437 case GL_PROGRAM_INPUT
:
438 var
= RESOURCE_VAR(res
);
439 /* Special case gl_VertexIDMESA -> gl_VertexID. */
440 if (var
->data
.mode
== ir_var_system_value
&&
441 var
->data
.location
== SYSTEM_VALUE_VERTEX_ID_ZERO_BASE
) {
442 return "gl_VertexID";
445 case GL_PROGRAM_OUTPUT
:
446 return RESOURCE_VAR(res
)->name
;
448 case GL_BUFFER_VARIABLE
:
449 return RESOURCE_UNI(res
)->name
;
450 case GL_VERTEX_SUBROUTINE_UNIFORM
:
451 case GL_GEOMETRY_SUBROUTINE_UNIFORM
:
452 case GL_FRAGMENT_SUBROUTINE_UNIFORM
:
453 case GL_COMPUTE_SUBROUTINE_UNIFORM
:
454 case GL_TESS_CONTROL_SUBROUTINE_UNIFORM
:
455 case GL_TESS_EVALUATION_SUBROUTINE_UNIFORM
:
456 return RESOURCE_UNI(res
)->name
+ MESA_SUBROUTINE_PREFIX_LEN
;
457 case GL_VERTEX_SUBROUTINE
:
458 case GL_GEOMETRY_SUBROUTINE
:
459 case GL_FRAGMENT_SUBROUTINE
:
460 case GL_COMPUTE_SUBROUTINE
:
461 case GL_TESS_CONTROL_SUBROUTINE
:
462 case GL_TESS_EVALUATION_SUBROUTINE
:
463 return RESOURCE_SUB(res
)->name
;
465 assert(!"support for resource type not implemented");
472 _mesa_program_resource_array_size(struct gl_program_resource
*res
)
475 case GL_TRANSFORM_FEEDBACK_VARYING
:
476 return RESOURCE_XFB(res
)->Size
> 1 ?
477 RESOURCE_XFB(res
)->Size
: 0;
478 case GL_PROGRAM_INPUT
:
479 case GL_PROGRAM_OUTPUT
:
480 return RESOURCE_VAR(res
)->type
->length
;
482 case GL_VERTEX_SUBROUTINE_UNIFORM
:
483 case GL_GEOMETRY_SUBROUTINE_UNIFORM
:
484 case GL_FRAGMENT_SUBROUTINE_UNIFORM
:
485 case GL_COMPUTE_SUBROUTINE_UNIFORM
:
486 case GL_TESS_CONTROL_SUBROUTINE_UNIFORM
:
487 case GL_TESS_EVALUATION_SUBROUTINE_UNIFORM
:
488 return RESOURCE_UNI(res
)->array_elements
;
489 case GL_BUFFER_VARIABLE
:
491 if (RESOURCE_UNI(res
)->array_stride
> 0 &&
492 RESOURCE_UNI(res
)->array_elements
== 0)
495 return RESOURCE_UNI(res
)->array_elements
;
496 case GL_VERTEX_SUBROUTINE
:
497 case GL_GEOMETRY_SUBROUTINE
:
498 case GL_FRAGMENT_SUBROUTINE
:
499 case GL_COMPUTE_SUBROUTINE
:
500 case GL_TESS_CONTROL_SUBROUTINE
:
501 case GL_TESS_EVALUATION_SUBROUTINE
:
502 case GL_ATOMIC_COUNTER_BUFFER
:
503 case GL_UNIFORM_BLOCK
:
504 case GL_SHADER_STORAGE_BLOCK
:
507 assert(!"support for resource type not implemented");
513 * Checks if array subscript is valid and if so sets array_index.
516 valid_array_index(const GLchar
*name
, unsigned *array_index
)
519 const GLchar
*out_base_name_end
;
521 idx
= parse_program_resource_name(name
, &out_base_name_end
);
531 /* Find a program resource with specific name in given interface.
533 struct gl_program_resource
*
534 _mesa_program_resource_find_name(struct gl_shader_program
*shProg
,
535 GLenum programInterface
, const char *name
,
536 unsigned *array_index
)
538 struct gl_program_resource
*res
= shProg
->ProgramResourceList
;
539 for (unsigned i
= 0; i
< shProg
->NumProgramResourceList
; i
++, res
++) {
540 if (res
->Type
!= programInterface
)
543 /* Resource basename. */
544 const char *rname
= _mesa_program_resource_name(res
);
545 unsigned baselen
= strlen(rname
);
546 unsigned baselen_without_array_index
= baselen
;
547 const char *rname_last_square_bracket
= strrchr(rname
, '[');
549 bool rname_has_array_index_zero
= false;
550 /* From ARB_program_interface_query spec:
552 * "uint GetProgramResourceIndex(uint program, enum programInterface,
555 * If <name> exactly matches the name string of one of the active
556 * resources for <programInterface>, the index of the matched resource is
557 * returned. Additionally, if <name> would exactly match the name string
558 * of an active resource if "[0]" were appended to <name>, the index of
559 * the matched resource is returned. [...]"
561 * "A string provided to GetProgramResourceLocation or
562 * GetProgramResourceLocationIndex is considered to match an active variable
565 * * the string exactly matches the name of the active variable;
567 * * if the string identifies the base name of an active array, where the
568 * string would exactly match the name of the variable if the suffix
569 * "[0]" were appended to the string; [...]"
571 /* Remove array's index from interface block name comparison only if
572 * array's index is zero and the resulting string length is the same
573 * than the provided name's length.
575 if (rname_last_square_bracket
) {
576 baselen_without_array_index
-= strlen(rname_last_square_bracket
);
577 rname_has_array_index_zero
=
578 (strncmp(rname_last_square_bracket
, "[0]\0", 4) == 0) &&
579 (baselen_without_array_index
== strlen(name
));
582 if (strncmp(rname
, name
, baselen
) == 0)
584 else if (rname_has_array_index_zero
&&
585 strncmp(rname
, name
, baselen_without_array_index
) == 0)
589 switch (programInterface
) {
590 case GL_UNIFORM_BLOCK
:
591 case GL_SHADER_STORAGE_BLOCK
:
592 /* Basename match, check if array or struct. */
593 if (rname_has_array_index_zero
||
594 name
[baselen
] == '\0' ||
595 name
[baselen
] == '[' ||
596 name
[baselen
] == '.') {
600 case GL_TRANSFORM_FEEDBACK_VARYING
:
601 case GL_BUFFER_VARIABLE
:
603 case GL_VERTEX_SUBROUTINE_UNIFORM
:
604 case GL_GEOMETRY_SUBROUTINE_UNIFORM
:
605 case GL_FRAGMENT_SUBROUTINE_UNIFORM
:
606 case GL_COMPUTE_SUBROUTINE_UNIFORM
:
607 case GL_TESS_CONTROL_SUBROUTINE_UNIFORM
:
608 case GL_TESS_EVALUATION_SUBROUTINE_UNIFORM
:
609 case GL_VERTEX_SUBROUTINE
:
610 case GL_GEOMETRY_SUBROUTINE
:
611 case GL_FRAGMENT_SUBROUTINE
:
612 case GL_COMPUTE_SUBROUTINE
:
613 case GL_TESS_CONTROL_SUBROUTINE
:
614 case GL_TESS_EVALUATION_SUBROUTINE
:
615 if (name
[baselen
] == '.') {
619 case GL_PROGRAM_INPUT
:
620 case GL_PROGRAM_OUTPUT
:
621 if (name
[baselen
] == '\0') {
623 } else if (name
[baselen
] == '[' &&
624 valid_array_index(name
, array_index
)) {
629 assert(!"not implemented for given interface");
637 calc_resource_index(struct gl_shader_program
*shProg
,
638 struct gl_program_resource
*res
)
642 for (i
= 0; i
< shProg
->NumProgramResourceList
; i
++) {
643 if (&shProg
->ProgramResourceList
[i
] == res
)
645 if (shProg
->ProgramResourceList
[i
].Type
== res
->Type
)
648 return GL_INVALID_INDEX
;
652 * Calculate index for the given resource.
655 _mesa_program_resource_index(struct gl_shader_program
*shProg
,
656 struct gl_program_resource
*res
)
659 return GL_INVALID_INDEX
;
662 case GL_ATOMIC_COUNTER_BUFFER
:
663 return RESOURCE_ATC(res
) - shProg
->AtomicBuffers
;
664 case GL_UNIFORM_BLOCK
:
665 case GL_SHADER_STORAGE_BLOCK
:
666 case GL_TRANSFORM_FEEDBACK_VARYING
:
668 return calc_resource_index(shProg
, res
);
673 * Find a program resource that points to given data.
675 static struct gl_program_resource
*
676 program_resource_find_data(struct gl_shader_program
*shProg
, void *data
)
678 struct gl_program_resource
*res
= shProg
->ProgramResourceList
;
679 for (unsigned i
= 0; i
< shProg
->NumProgramResourceList
; i
++, res
++) {
680 if (res
->Data
== data
)
686 /* Find a program resource with specific index in given interface.
688 struct gl_program_resource
*
689 _mesa_program_resource_find_index(struct gl_shader_program
*shProg
,
690 GLenum programInterface
, GLuint index
)
692 struct gl_program_resource
*res
= shProg
->ProgramResourceList
;
695 for (unsigned i
= 0; i
< shProg
->NumProgramResourceList
; i
++, res
++) {
696 if (res
->Type
!= programInterface
)
700 case GL_UNIFORM_BLOCK
:
701 case GL_ATOMIC_COUNTER_BUFFER
:
702 case GL_SHADER_STORAGE_BLOCK
:
703 if (_mesa_program_resource_index(shProg
, res
) == index
)
706 case GL_TRANSFORM_FEEDBACK_VARYING
:
707 case GL_PROGRAM_INPUT
:
708 case GL_PROGRAM_OUTPUT
:
710 case GL_VERTEX_SUBROUTINE_UNIFORM
:
711 case GL_GEOMETRY_SUBROUTINE_UNIFORM
:
712 case GL_FRAGMENT_SUBROUTINE_UNIFORM
:
713 case GL_COMPUTE_SUBROUTINE_UNIFORM
:
714 case GL_TESS_CONTROL_SUBROUTINE_UNIFORM
:
715 case GL_TESS_EVALUATION_SUBROUTINE_UNIFORM
:
716 case GL_VERTEX_SUBROUTINE
:
717 case GL_GEOMETRY_SUBROUTINE
:
718 case GL_FRAGMENT_SUBROUTINE
:
719 case GL_COMPUTE_SUBROUTINE
:
720 case GL_TESS_CONTROL_SUBROUTINE
:
721 case GL_TESS_EVALUATION_SUBROUTINE
:
722 case GL_BUFFER_VARIABLE
:
723 if (++idx
== (int) index
)
727 assert(!"not implemented for given interface");
733 /* Function returns if resource name is expected to have index
737 * Page 61 (page 73 of the PDF) in section 2.11 of the OpenGL ES 3.0
740 * "If the active uniform is an array, the uniform name returned in
741 * name will always be the name of the uniform array appended with
744 * The same text also appears in the OpenGL 4.2 spec. It does not,
745 * however, appear in any previous spec. Previous specifications are
746 * ambiguous in this regard. However, either name can later be passed
747 * to glGetUniformLocation (and related APIs), so there shouldn't be any
748 * harm in always appending "[0]" to uniform array names.
750 * Geometry shader stage has different naming convention where the 'normal'
751 * condition is an array, therefore for variables referenced in geometry
752 * stage we do not add '[0]'.
754 * Note, that TCS outputs and TES inputs should not have index appended
758 add_index_to_name(struct gl_program_resource
*res
)
760 bool add_index
= !(((res
->Type
== GL_PROGRAM_INPUT
) &&
761 res
->StageReferences
& (1 << MESA_SHADER_GEOMETRY
)));
763 /* Transform feedback varyings have array index already appended
766 if (res
->Type
== GL_TRANSFORM_FEEDBACK_VARYING
)
772 /* Get name length of a program resource. This consists of
773 * base name + 3 for '[0]' if resource is an array.
776 _mesa_program_resource_name_len(struct gl_program_resource
*res
)
778 unsigned length
= strlen(_mesa_program_resource_name(res
));
779 if (_mesa_program_resource_array_size(res
) && add_index_to_name(res
))
784 /* Get full name of a program resource.
787 _mesa_get_program_resource_name(struct gl_shader_program
*shProg
,
788 GLenum programInterface
, GLuint index
,
789 GLsizei bufSize
, GLsizei
*length
,
790 GLchar
*name
, const char *caller
)
792 GET_CURRENT_CONTEXT(ctx
);
794 /* Find resource with given interface and index. */
795 struct gl_program_resource
*res
=
796 _mesa_program_resource_find_index(shProg
, programInterface
, index
);
798 /* The error INVALID_VALUE is generated if <index> is greater than
799 * or equal to the number of entries in the active resource list for
800 * <programInterface>.
803 _mesa_error(ctx
, GL_INVALID_VALUE
, "%s(index %u)", caller
, index
);
808 _mesa_error(ctx
, GL_INVALID_VALUE
, "%s(bufSize %d)", caller
, bufSize
);
815 length
= &localLength
;
817 _mesa_copy_string(name
, bufSize
, length
, _mesa_program_resource_name(res
));
819 if (_mesa_program_resource_array_size(res
) && add_index_to_name(res
)) {
822 /* The comparison is strange because *length does *NOT* include the
823 * terminating NUL, but maxLength does.
825 for (i
= 0; i
< 3 && (*length
+ i
+ 1) < bufSize
; i
++)
826 name
[*length
+ i
] = "[0]"[i
];
828 name
[*length
+ i
] = '\0';
835 program_resource_location(struct gl_shader_program
*shProg
,
836 struct gl_program_resource
*res
, const char *name
,
837 unsigned array_index
)
839 /* Built-in locations should report GL_INVALID_INDEX. */
840 if (is_gl_identifier(name
))
841 return GL_INVALID_INDEX
;
843 /* VERT_ATTRIB_GENERIC0 and FRAG_RESULT_DATA0 are decremented as these
844 * offsets are used internally to differentiate between built-in attributes
845 * and user-defined attributes.
848 case GL_PROGRAM_INPUT
:
849 /* If the input is an array, fail if the index is out of bounds. */
851 && array_index
>= RESOURCE_VAR(res
)->type
->length
) {
854 return RESOURCE_VAR(res
)->data
.location
+ array_index
- VERT_ATTRIB_GENERIC0
;
855 case GL_PROGRAM_OUTPUT
:
856 /* If the output is an array, fail if the index is out of bounds. */
858 && array_index
>= RESOURCE_VAR(res
)->type
->length
) {
861 return RESOURCE_VAR(res
)->data
.location
+ array_index
- FRAG_RESULT_DATA0
;
863 /* If the uniform is built-in, fail. */
864 if (RESOURCE_UNI(res
)->builtin
)
867 /* From page 79 of the OpenGL 4.2 spec:
869 * "A valid name cannot be a structure, an array of structures, or any
870 * portion of a single vector or a matrix."
872 if (RESOURCE_UNI(res
)->type
->without_array()->is_record())
875 /* From the GL_ARB_uniform_buffer_object spec:
877 * "The value -1 will be returned if <name> does not correspond to an
878 * active uniform variable name in <program>, if <name> is associated
879 * with a named uniform block, or if <name> starts with the reserved
882 if (RESOURCE_UNI(res
)->block_index
!= -1 ||
883 RESOURCE_UNI(res
)->atomic_buffer_index
!= -1)
887 case GL_VERTEX_SUBROUTINE_UNIFORM
:
888 case GL_GEOMETRY_SUBROUTINE_UNIFORM
:
889 case GL_FRAGMENT_SUBROUTINE_UNIFORM
:
890 case GL_COMPUTE_SUBROUTINE_UNIFORM
:
891 case GL_TESS_CONTROL_SUBROUTINE_UNIFORM
:
892 case GL_TESS_EVALUATION_SUBROUTINE_UNIFORM
:
893 /* If the uniform is an array, fail if the index is out of bounds. */
895 && array_index
>= RESOURCE_UNI(res
)->array_elements
) {
899 /* location in remap table + array element offset */
900 return RESOURCE_UNI(res
)->remap_location
+ array_index
;
907 * Function implements following location queries:
908 * glGetUniformLocation
911 _mesa_program_resource_location(struct gl_shader_program
*shProg
,
912 GLenum programInterface
, const char *name
)
914 unsigned array_index
= 0;
915 struct gl_program_resource
*res
=
916 _mesa_program_resource_find_name(shProg
, programInterface
, name
,
919 /* Resource not found. */
923 return program_resource_location(shProg
, res
, name
, array_index
);
927 * Function implements following index queries:
931 _mesa_program_resource_location_index(struct gl_shader_program
*shProg
,
932 GLenum programInterface
, const char *name
)
934 struct gl_program_resource
*res
=
935 _mesa_program_resource_find_name(shProg
, programInterface
, name
, NULL
);
937 /* Non-existent variable or resource is not referenced by fragment stage. */
938 if (!res
|| !(res
->StageReferences
& (1 << MESA_SHADER_FRAGMENT
)))
941 return RESOURCE_VAR(res
)->data
.index
;
945 stage_from_enum(GLenum ref
)
948 case GL_REFERENCED_BY_VERTEX_SHADER
:
949 return MESA_SHADER_VERTEX
;
950 case GL_REFERENCED_BY_TESS_CONTROL_SHADER
:
951 return MESA_SHADER_TESS_CTRL
;
952 case GL_REFERENCED_BY_TESS_EVALUATION_SHADER
:
953 return MESA_SHADER_TESS_EVAL
;
954 case GL_REFERENCED_BY_GEOMETRY_SHADER
:
955 return MESA_SHADER_GEOMETRY
;
956 case GL_REFERENCED_BY_FRAGMENT_SHADER
:
957 return MESA_SHADER_FRAGMENT
;
958 case GL_REFERENCED_BY_COMPUTE_SHADER
:
959 return MESA_SHADER_COMPUTE
;
961 assert(!"shader stage not supported");
962 return MESA_SHADER_STAGES
;
967 * Check if resource is referenced by given 'referenced by' stage enum.
968 * ATC and UBO resources hold stage references of their own.
971 is_resource_referenced(struct gl_shader_program
*shProg
,
972 struct gl_program_resource
*res
,
973 GLuint index
, uint8_t stage
)
975 /* First, check if we even have such a stage active. */
976 if (!shProg
->_LinkedShaders
[stage
])
979 if (res
->Type
== GL_ATOMIC_COUNTER_BUFFER
)
980 return RESOURCE_ATC(res
)->StageReferences
[stage
];
982 if (res
->Type
== GL_UNIFORM_BLOCK
|| res
->Type
== GL_SHADER_STORAGE_BLOCK
)
983 return shProg
->UniformBlockStageIndex
[stage
][index
] != -1;
985 return res
->StageReferences
& (1 << stage
);
989 get_buffer_property(struct gl_shader_program
*shProg
,
990 struct gl_program_resource
*res
, const GLenum prop
,
991 GLint
*val
, const char *caller
)
993 GET_CURRENT_CONTEXT(ctx
);
994 if (res
->Type
!= GL_UNIFORM_BLOCK
&&
995 res
->Type
!= GL_ATOMIC_COUNTER_BUFFER
&&
996 res
->Type
!= GL_SHADER_STORAGE_BLOCK
)
997 goto invalid_operation
;
999 if (res
->Type
== GL_UNIFORM_BLOCK
) {
1001 case GL_BUFFER_BINDING
:
1002 *val
= RESOURCE_UBO(res
)->Binding
;
1004 case GL_BUFFER_DATA_SIZE
:
1005 *val
= RESOURCE_UBO(res
)->UniformBufferSize
;
1007 case GL_NUM_ACTIVE_VARIABLES
:
1009 for (unsigned i
= 0; i
< RESOURCE_UBO(res
)->NumUniforms
; i
++) {
1010 const char *iname
= RESOURCE_UBO(res
)->Uniforms
[i
].IndexName
;
1011 struct gl_program_resource
*uni
=
1012 _mesa_program_resource_find_name(shProg
, GL_UNIFORM
, iname
,
1019 case GL_ACTIVE_VARIABLES
: {
1020 unsigned num_values
= 0;
1021 for (unsigned i
= 0; i
< RESOURCE_UBO(res
)->NumUniforms
; i
++) {
1022 const char *iname
= RESOURCE_UBO(res
)->Uniforms
[i
].IndexName
;
1023 struct gl_program_resource
*uni
=
1024 _mesa_program_resource_find_name(shProg
, GL_UNIFORM
, iname
,
1029 _mesa_program_resource_index(shProg
, uni
);
1035 } else if (res
->Type
== GL_SHADER_STORAGE_BLOCK
) {
1037 case GL_BUFFER_BINDING
:
1038 *val
= RESOURCE_UBO(res
)->Binding
;
1040 case GL_BUFFER_DATA_SIZE
:
1041 *val
= RESOURCE_UBO(res
)->UniformBufferSize
;
1043 case GL_NUM_ACTIVE_VARIABLES
:
1045 for (unsigned i
= 0; i
< RESOURCE_UBO(res
)->NumUniforms
; i
++) {
1046 const char *iname
= RESOURCE_UBO(res
)->Uniforms
[i
].IndexName
;
1047 struct gl_program_resource
*uni
=
1048 _mesa_program_resource_find_name(shProg
, GL_BUFFER_VARIABLE
,
1055 case GL_ACTIVE_VARIABLES
: {
1056 unsigned num_values
= 0;
1057 for (unsigned i
= 0; i
< RESOURCE_UBO(res
)->NumUniforms
; i
++) {
1058 const char *iname
= RESOURCE_UBO(res
)->Uniforms
[i
].IndexName
;
1059 struct gl_program_resource
*uni
=
1060 _mesa_program_resource_find_name(shProg
, GL_BUFFER_VARIABLE
,
1065 _mesa_program_resource_index(shProg
, uni
);
1071 } else if (res
->Type
== GL_ATOMIC_COUNTER_BUFFER
) {
1073 case GL_BUFFER_BINDING
:
1074 *val
= RESOURCE_ATC(res
)->Binding
;
1076 case GL_BUFFER_DATA_SIZE
:
1077 *val
= RESOURCE_ATC(res
)->MinimumSize
;
1079 case GL_NUM_ACTIVE_VARIABLES
:
1080 *val
= RESOURCE_ATC(res
)->NumUniforms
;
1082 case GL_ACTIVE_VARIABLES
:
1083 for (unsigned i
= 0; i
< RESOURCE_ATC(res
)->NumUniforms
; i
++) {
1084 /* Active atomic buffer contains index to UniformStorage. Find
1085 * out gl_program_resource via data pointer and then calculate
1086 * index of that uniform.
1088 unsigned idx
= RESOURCE_ATC(res
)->Uniforms
[i
];
1089 struct gl_program_resource
*uni
=
1090 program_resource_find_data(shProg
,
1091 &shProg
->UniformStorage
[idx
]);
1093 *val
++ = _mesa_program_resource_index(shProg
, uni
);
1095 return RESOURCE_ATC(res
)->NumUniforms
;
1098 assert(!"support for property type not implemented");
1101 _mesa_error(ctx
, GL_INVALID_OPERATION
, "%s(%s prop %s)", caller
,
1102 _mesa_enum_to_string(res
->Type
),
1103 _mesa_enum_to_string(prop
));
1109 _mesa_program_resource_prop(struct gl_shader_program
*shProg
,
1110 struct gl_program_resource
*res
, GLuint index
,
1111 const GLenum prop
, GLint
*val
, const char *caller
)
1113 GET_CURRENT_CONTEXT(ctx
);
1115 #define VALIDATE_TYPE(type)\
1116 if (res->Type != type)\
1117 goto invalid_operation;
1119 #define VALIDATE_TYPE_2(type1, type2)\
1120 if (res->Type != type1 && res->Type != type2)\
1121 goto invalid_operation;
1124 case GL_NAME_LENGTH
:
1125 switch (res
->Type
) {
1126 case GL_ATOMIC_COUNTER_BUFFER
:
1127 goto invalid_operation
;
1129 /* Resource name length + terminator. */
1130 *val
= _mesa_program_resource_name_len(res
) + 1;
1134 switch (res
->Type
) {
1136 case GL_BUFFER_VARIABLE
:
1137 *val
= RESOURCE_UNI(res
)->type
->gl_type
;
1139 case GL_PROGRAM_INPUT
:
1140 case GL_PROGRAM_OUTPUT
:
1141 *val
= RESOURCE_VAR(res
)->type
->gl_type
;
1143 case GL_TRANSFORM_FEEDBACK_VARYING
:
1144 *val
= RESOURCE_XFB(res
)->Type
;
1147 goto invalid_operation
;
1150 switch (res
->Type
) {
1152 case GL_BUFFER_VARIABLE
:
1153 /* Test if a buffer variable is an array or an unsized array.
1154 * Unsized arrays return zero as array size.
1156 if (RESOURCE_UNI(res
)->is_shader_storage
&&
1157 RESOURCE_UNI(res
)->array_stride
> 0)
1158 *val
= RESOURCE_UNI(res
)->array_elements
;
1160 *val
= MAX2(RESOURCE_UNI(res
)->array_elements
, 1);
1162 case GL_PROGRAM_INPUT
:
1163 case GL_PROGRAM_OUTPUT
:
1164 *val
= MAX2(_mesa_program_resource_array_size(res
), 1);
1166 case GL_TRANSFORM_FEEDBACK_VARYING
:
1167 *val
= MAX2(RESOURCE_XFB(res
)->Size
, 1);
1170 goto invalid_operation
;
1173 VALIDATE_TYPE_2(GL_UNIFORM
, GL_BUFFER_VARIABLE
);
1174 *val
= RESOURCE_UNI(res
)->offset
;
1176 case GL_BLOCK_INDEX
:
1177 VALIDATE_TYPE_2(GL_UNIFORM
, GL_BUFFER_VARIABLE
);
1178 *val
= RESOURCE_UNI(res
)->block_index
;
1180 case GL_ARRAY_STRIDE
:
1181 VALIDATE_TYPE_2(GL_UNIFORM
, GL_BUFFER_VARIABLE
);
1182 *val
= RESOURCE_UNI(res
)->array_stride
;
1184 case GL_MATRIX_STRIDE
:
1185 VALIDATE_TYPE_2(GL_UNIFORM
, GL_BUFFER_VARIABLE
);
1186 *val
= RESOURCE_UNI(res
)->matrix_stride
;
1188 case GL_IS_ROW_MAJOR
:
1189 VALIDATE_TYPE_2(GL_UNIFORM
, GL_BUFFER_VARIABLE
);
1190 *val
= RESOURCE_UNI(res
)->row_major
;
1192 case GL_ATOMIC_COUNTER_BUFFER_INDEX
:
1193 VALIDATE_TYPE(GL_UNIFORM
);
1194 *val
= RESOURCE_UNI(res
)->atomic_buffer_index
;
1196 case GL_BUFFER_BINDING
:
1197 case GL_BUFFER_DATA_SIZE
:
1198 case GL_NUM_ACTIVE_VARIABLES
:
1199 case GL_ACTIVE_VARIABLES
:
1200 return get_buffer_property(shProg
, res
, prop
, val
, caller
);
1201 case GL_REFERENCED_BY_COMPUTE_SHADER
:
1202 if (!_mesa_has_compute_shaders(ctx
))
1205 case GL_REFERENCED_BY_VERTEX_SHADER
:
1206 case GL_REFERENCED_BY_TESS_CONTROL_SHADER
:
1207 case GL_REFERENCED_BY_TESS_EVALUATION_SHADER
:
1208 case GL_REFERENCED_BY_GEOMETRY_SHADER
:
1209 case GL_REFERENCED_BY_FRAGMENT_SHADER
:
1210 switch (res
->Type
) {
1212 case GL_PROGRAM_INPUT
:
1213 case GL_PROGRAM_OUTPUT
:
1214 case GL_UNIFORM_BLOCK
:
1215 case GL_BUFFER_VARIABLE
:
1216 case GL_SHADER_STORAGE_BLOCK
:
1217 case GL_ATOMIC_COUNTER_BUFFER
:
1218 *val
= is_resource_referenced(shProg
, res
, index
,
1219 stage_from_enum(prop
));
1222 goto invalid_operation
;
1225 switch (res
->Type
) {
1227 case GL_PROGRAM_INPUT
:
1228 case GL_PROGRAM_OUTPUT
:
1229 *val
= program_resource_location(shProg
, res
,
1230 _mesa_program_resource_name(res
),
1234 goto invalid_operation
;
1236 case GL_LOCATION_INDEX
:
1237 if (res
->Type
!= GL_PROGRAM_OUTPUT
)
1238 goto invalid_operation
;
1239 *val
= RESOURCE_VAR(res
)->data
.index
;
1242 case GL_NUM_COMPATIBLE_SUBROUTINES
:
1243 if (res
->Type
!= GL_VERTEX_SUBROUTINE_UNIFORM
&&
1244 res
->Type
!= GL_FRAGMENT_SUBROUTINE_UNIFORM
&&
1245 res
->Type
!= GL_GEOMETRY_SUBROUTINE_UNIFORM
&&
1246 res
->Type
!= GL_COMPUTE_SUBROUTINE_UNIFORM
&&
1247 res
->Type
!= GL_TESS_CONTROL_SUBROUTINE_UNIFORM
&&
1248 res
->Type
!= GL_TESS_EVALUATION_SUBROUTINE_UNIFORM
)
1249 goto invalid_operation
;
1250 *val
= RESOURCE_UNI(res
)->num_compatible_subroutines
;
1252 case GL_COMPATIBLE_SUBROUTINES
: {
1253 const struct gl_uniform_storage
*uni
;
1254 struct gl_shader
*sh
;
1258 if (res
->Type
!= GL_VERTEX_SUBROUTINE_UNIFORM
&&
1259 res
->Type
!= GL_FRAGMENT_SUBROUTINE_UNIFORM
&&
1260 res
->Type
!= GL_GEOMETRY_SUBROUTINE_UNIFORM
&&
1261 res
->Type
!= GL_COMPUTE_SUBROUTINE_UNIFORM
&&
1262 res
->Type
!= GL_TESS_CONTROL_SUBROUTINE_UNIFORM
&&
1263 res
->Type
!= GL_TESS_EVALUATION_SUBROUTINE_UNIFORM
)
1264 goto invalid_operation
;
1265 uni
= RESOURCE_UNI(res
);
1267 sh
= shProg
->_LinkedShaders
[_mesa_shader_stage_from_subroutine_uniform(res
->Type
)];
1269 for (i
= 0; i
< sh
->NumSubroutineFunctions
; i
++) {
1270 struct gl_subroutine_function
*fn
= &sh
->SubroutineFunctions
[i
];
1271 for (j
= 0; j
< fn
->num_compat_types
; j
++) {
1272 if (fn
->types
[j
] == uni
->type
) {
1281 case GL_TOP_LEVEL_ARRAY_SIZE
:
1282 VALIDATE_TYPE(GL_BUFFER_VARIABLE
);
1283 *val
= RESOURCE_UNI(res
)->top_level_array_size
;
1286 case GL_TOP_LEVEL_ARRAY_STRIDE
:
1287 VALIDATE_TYPE(GL_BUFFER_VARIABLE
);
1288 *val
= RESOURCE_UNI(res
)->top_level_array_stride
;
1291 /* GL_ARB_tessellation_shader */
1292 case GL_IS_PER_PATCH
:
1293 switch (res
->Type
) {
1294 case GL_PROGRAM_INPUT
:
1295 case GL_PROGRAM_OUTPUT
:
1296 *val
= RESOURCE_VAR(res
)->data
.patch
;
1299 goto invalid_operation
;
1305 #undef VALIDATE_TYPE
1306 #undef VALIDATE_TYPE_2
1309 _mesa_error(ctx
, GL_INVALID_ENUM
, "%s(%s prop %s)", caller
,
1310 _mesa_enum_to_string(res
->Type
),
1311 _mesa_enum_to_string(prop
));
1315 _mesa_error(ctx
, GL_INVALID_OPERATION
, "%s(%s prop %s)", caller
,
1316 _mesa_enum_to_string(res
->Type
),
1317 _mesa_enum_to_string(prop
));
1322 _mesa_get_program_resourceiv(struct gl_shader_program
*shProg
,
1323 GLenum programInterface
, GLuint index
, GLsizei propCount
,
1324 const GLenum
*props
, GLsizei bufSize
,
1325 GLsizei
*length
, GLint
*params
)
1327 GET_CURRENT_CONTEXT(ctx
);
1328 GLint
*val
= (GLint
*) params
;
1329 const GLenum
*prop
= props
;
1332 struct gl_program_resource
*res
=
1333 _mesa_program_resource_find_index(shProg
, programInterface
, index
);
1335 /* No such resource found or bufSize negative. */
1336 if (!res
|| bufSize
< 0) {
1337 _mesa_error(ctx
, GL_INVALID_VALUE
,
1338 "glGetProgramResourceiv(%s index %d bufSize %d)",
1339 _mesa_enum_to_string(programInterface
), index
, bufSize
);
1343 /* Write propCount values until error occurs or bufSize reached. */
1344 for (int i
= 0; i
< propCount
&& i
< bufSize
; i
++, val
++, prop
++) {
1346 _mesa_program_resource_prop(shProg
, res
, index
, *prop
, val
,
1347 "glGetProgramResourceiv");
1349 /* Error happened. */
1350 if (props_written
== 0)
1353 amount
+= props_written
;
1356 /* If <length> is not NULL, the actual number of integer values
1357 * written to <params> will be written to <length>.