2 * Copyright © 2008, 2009 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.
29 #include "main/core.h" /* for struct gl_context */
30 #include "main/context.h"
31 #include "main/shaderobj.h"
36 #include "glsl_parser_extras.h"
37 #include "glsl_parser.h"
38 #include "ir_optimization.h"
39 #include "loop_analysis.h"
42 * Format a short human-readable description of the given GLSL version.
45 glsl_compute_version_string(void *mem_ctx
, bool is_es
, unsigned version
)
47 return ralloc_asprintf(mem_ctx
, "GLSL%s %d.%02d", is_es
? " ES" : "",
48 version
/ 100, version
% 100);
52 static unsigned known_desktop_glsl_versions
[] =
53 { 110, 120, 130, 140, 150, 330, 400, 410, 420, 430 };
56 _mesa_glsl_parse_state::_mesa_glsl_parse_state(struct gl_context
*_ctx
,
57 GLenum target
, void *mem_ctx
)
58 : ctx(_ctx
), switch_state()
61 case GL_VERTEX_SHADER
: this->target
= MESA_SHADER_VERTEX
; break;
62 case GL_FRAGMENT_SHADER
: this->target
= MESA_SHADER_FRAGMENT
; break;
63 case GL_GEOMETRY_SHADER
: this->target
= MESA_SHADER_GEOMETRY
; break;
67 this->translation_unit
.make_empty();
68 this->symbols
= new(mem_ctx
) glsl_symbol_table
;
70 this->num_uniform_blocks
= 0;
71 this->uniform_block_array_size
= 0;
72 this->uniform_blocks
= NULL
;
74 this->info_log
= ralloc_strdup(mem_ctx
, "");
76 this->loop_nesting_ast
= NULL
;
78 this->struct_specifier_depth
= 0;
80 this->uses_builtin_functions
= false;
82 /* Set default language version and extensions */
83 this->language_version
= ctx
->Const
.ForceGLSLVersion
?
84 ctx
->Const
.ForceGLSLVersion
: 110;
85 this->es_shader
= false;
86 this->ARB_texture_rectangle_enable
= true;
88 /* OpenGL ES 2.0 has different defaults from desktop GL. */
89 if (ctx
->API
== API_OPENGLES2
) {
90 this->language_version
= 100;
91 this->es_shader
= true;
92 this->ARB_texture_rectangle_enable
= false;
95 this->extensions
= &ctx
->Extensions
;
97 this->Const
.MaxLights
= ctx
->Const
.MaxLights
;
98 this->Const
.MaxClipPlanes
= ctx
->Const
.MaxClipPlanes
;
99 this->Const
.MaxTextureUnits
= ctx
->Const
.MaxTextureUnits
;
100 this->Const
.MaxTextureCoords
= ctx
->Const
.MaxTextureCoordUnits
;
101 this->Const
.MaxVertexAttribs
= ctx
->Const
.VertexProgram
.MaxAttribs
;
102 this->Const
.MaxVertexUniformComponents
= ctx
->Const
.VertexProgram
.MaxUniformComponents
;
103 this->Const
.MaxVertexTextureImageUnits
= ctx
->Const
.VertexProgram
.MaxTextureImageUnits
;
104 this->Const
.MaxCombinedTextureImageUnits
= ctx
->Const
.MaxCombinedTextureImageUnits
;
105 this->Const
.MaxTextureImageUnits
= ctx
->Const
.FragmentProgram
.MaxTextureImageUnits
;
106 this->Const
.MaxFragmentUniformComponents
= ctx
->Const
.FragmentProgram
.MaxUniformComponents
;
107 this->Const
.MinProgramTexelOffset
= ctx
->Const
.MinProgramTexelOffset
;
108 this->Const
.MaxProgramTexelOffset
= ctx
->Const
.MaxProgramTexelOffset
;
110 this->Const
.MaxDrawBuffers
= ctx
->Const
.MaxDrawBuffers
;
113 this->Const
.MaxVertexOutputComponents
= ctx
->Const
.VertexProgram
.MaxOutputComponents
;
114 this->Const
.MaxGeometryInputComponents
= ctx
->Const
.GeometryProgram
.MaxInputComponents
;
115 this->Const
.MaxGeometryOutputComponents
= ctx
->Const
.GeometryProgram
.MaxOutputComponents
;
116 this->Const
.MaxFragmentInputComponents
= ctx
->Const
.FragmentProgram
.MaxInputComponents
;
117 this->Const
.MaxGeometryTextureImageUnits
= ctx
->Const
.GeometryProgram
.MaxTextureImageUnits
;
118 this->Const
.MaxGeometryOutputVertices
= ctx
->Const
.MaxGeometryOutputVertices
;
119 this->Const
.MaxGeometryTotalOutputComponents
= ctx
->Const
.MaxGeometryTotalOutputComponents
;
120 this->Const
.MaxGeometryUniformComponents
= ctx
->Const
.GeometryProgram
.MaxUniformComponents
;
122 this->Const
.MaxVertexAtomicCounters
= ctx
->Const
.VertexProgram
.MaxAtomicCounters
;
123 this->Const
.MaxGeometryAtomicCounters
= ctx
->Const
.GeometryProgram
.MaxAtomicCounters
;
124 this->Const
.MaxFragmentAtomicCounters
= ctx
->Const
.FragmentProgram
.MaxAtomicCounters
;
125 this->Const
.MaxCombinedAtomicCounters
= ctx
->Const
.MaxCombinedAtomicCounters
;
126 this->Const
.MaxAtomicBufferBindings
= ctx
->Const
.MaxAtomicBufferBindings
;
128 this->current_function
= NULL
;
129 this->toplevel_ir
= NULL
;
130 this->found_return
= false;
131 this->all_invariant
= false;
132 this->user_structures
= NULL
;
133 this->num_user_structures
= 0;
135 /* Populate the list of supported GLSL versions */
136 /* FINISHME: Once the OpenGL 3.0 'forward compatible' context or
137 * the OpenGL 3.2 Core context is supported, this logic will need
138 * change. Older versions of GLSL are no longer supported
139 * outside the compatibility contexts of 3.x.
141 this->num_supported_versions
= 0;
142 if (_mesa_is_desktop_gl(ctx
)) {
143 for (unsigned i
= 0; i
< ARRAY_SIZE(known_desktop_glsl_versions
); i
++) {
144 if (known_desktop_glsl_versions
[i
] <= ctx
->Const
.GLSLVersion
) {
145 this->supported_versions
[this->num_supported_versions
].ver
146 = known_desktop_glsl_versions
[i
];
147 this->supported_versions
[this->num_supported_versions
].es
= false;
148 this->num_supported_versions
++;
152 if (ctx
->API
== API_OPENGLES2
|| ctx
->Extensions
.ARB_ES2_compatibility
) {
153 this->supported_versions
[this->num_supported_versions
].ver
= 100;
154 this->supported_versions
[this->num_supported_versions
].es
= true;
155 this->num_supported_versions
++;
157 if (_mesa_is_gles3(ctx
) || ctx
->Extensions
.ARB_ES3_compatibility
) {
158 this->supported_versions
[this->num_supported_versions
].ver
= 300;
159 this->supported_versions
[this->num_supported_versions
].es
= true;
160 this->num_supported_versions
++;
162 assert(this->num_supported_versions
163 <= ARRAY_SIZE(this->supported_versions
));
165 /* Create a string for use in error messages to tell the user which GLSL
166 * versions are supported.
168 char *supported
= ralloc_strdup(this, "");
169 for (unsigned i
= 0; i
< this->num_supported_versions
; i
++) {
170 unsigned ver
= this->supported_versions
[i
].ver
;
171 const char *const prefix
= (i
== 0)
173 : ((i
== this->num_supported_versions
- 1) ? ", and " : ", ");
174 const char *const suffix
= (this->supported_versions
[i
].es
) ? " ES" : "";
176 ralloc_asprintf_append(& supported
, "%s%u.%02u%s",
178 ver
/ 100, ver
% 100,
182 this->supported_version_string
= supported
;
184 if (ctx
->Const
.ForceGLSLExtensionsWarn
)
185 _mesa_glsl_process_extension("all", NULL
, "warn", NULL
, this);
187 this->default_uniform_qualifier
= new(this) ast_type_qualifier();
188 this->default_uniform_qualifier
->flags
.q
.shared
= 1;
189 this->default_uniform_qualifier
->flags
.q
.column_major
= 1;
191 this->gs_input_prim_type_specified
= false;
192 this->gs_input_prim_type
= GL_POINTS
;
193 this->gs_input_size
= 0;
194 this->out_qualifier
= new(this) ast_type_qualifier();
195 memset(this->atomic_counter_offsets
, 0,
196 sizeof(this->atomic_counter_offsets
));
200 * Determine whether the current GLSL version is sufficiently high to support
201 * a certain feature, and generate an error message if it isn't.
203 * \param required_glsl_version and \c required_glsl_es_version are
204 * interpreted as they are in _mesa_glsl_parse_state::is_version().
206 * \param locp is the parser location where the error should be reported.
208 * \param fmt (and additional arguments) constitute a printf-style error
209 * message to report if the version check fails. Information about the
210 * current and required GLSL versions will be appended. So, for example, if
211 * the GLSL version being compiled is 1.20, and check_version(130, 300, locp,
212 * "foo unsupported") is called, the error message will be "foo unsupported in
213 * GLSL 1.20 (GLSL 1.30 or GLSL 3.00 ES required)".
216 _mesa_glsl_parse_state::check_version(unsigned required_glsl_version
,
217 unsigned required_glsl_es_version
,
218 YYLTYPE
*locp
, const char *fmt
, ...)
220 if (this->is_version(required_glsl_version
, required_glsl_es_version
))
225 char *problem
= ralloc_vasprintf(this, fmt
, args
);
227 const char *glsl_version_string
228 = glsl_compute_version_string(this, false, required_glsl_version
);
229 const char *glsl_es_version_string
230 = glsl_compute_version_string(this, true, required_glsl_es_version
);
231 const char *requirement_string
= "";
232 if (required_glsl_version
&& required_glsl_es_version
) {
233 requirement_string
= ralloc_asprintf(this, " (%s or %s required)",
235 glsl_es_version_string
);
236 } else if (required_glsl_version
) {
237 requirement_string
= ralloc_asprintf(this, " (%s required)",
238 glsl_version_string
);
239 } else if (required_glsl_es_version
) {
240 requirement_string
= ralloc_asprintf(this, " (%s required)",
241 glsl_es_version_string
);
243 _mesa_glsl_error(locp
, this, "%s in %s%s",
244 problem
, this->get_version_string(),
251 * Process a GLSL #version directive.
253 * \param version is the integer that follows the #version token.
255 * \param ident is a string identifier that follows the integer, if any is
256 * present. Otherwise NULL.
259 _mesa_glsl_parse_state::process_version_directive(YYLTYPE
*locp
, int version
,
262 bool es_token_present
= false;
264 if (strcmp(ident
, "es") == 0) {
265 es_token_present
= true;
266 } else if (version
>= 150) {
267 if (strcmp(ident
, "core") == 0) {
268 /* Accept the token. There's no need to record that this is
269 * a core profile shader since that's the only profile we support.
271 } else if (strcmp(ident
, "compatibility") == 0) {
272 _mesa_glsl_error(locp
, this,
273 "the compatibility profile is not supported");
275 _mesa_glsl_error(locp
, this,
276 "\"%s\" is not a valid shading language profile; "
277 "if present, it must be \"core\"", ident
);
280 _mesa_glsl_error(locp
, this,
281 "illegal text following version number");
285 this->es_shader
= es_token_present
;
286 if (version
== 100) {
287 if (es_token_present
) {
288 _mesa_glsl_error(locp
, this,
289 "GLSL 1.00 ES should be selected using "
292 this->es_shader
= true;
296 this->language_version
= version
;
298 bool supported
= false;
299 for (unsigned i
= 0; i
< this->num_supported_versions
; i
++) {
300 if (this->supported_versions
[i
].ver
== (unsigned) version
301 && this->supported_versions
[i
].es
== this->es_shader
) {
308 _mesa_glsl_error(locp
, this, "%s is not supported. "
309 "Supported versions are: %s",
310 this->get_version_string(),
311 this->supported_version_string
);
313 /* On exit, the language_version must be set to a valid value.
314 * Later calls to _mesa_glsl_initialize_types will misbehave if
315 * the version is invalid.
317 switch (this->ctx
->API
) {
318 case API_OPENGL_COMPAT
:
319 case API_OPENGL_CORE
:
320 this->language_version
= this->ctx
->Const
.GLSLVersion
;
324 assert(!"Should not get here.");
328 this->language_version
= 100;
337 * Translate a GLenum to a short shader stage name for debug printouts and
340 * It recognizes the PROGRAM variants of the names so it can be used
341 * with a struct gl_program->Target, not just a struct
345 _mesa_shader_enum_to_string(GLenum type
)
348 case GL_VERTEX_SHADER
:
349 case GL_VERTEX_PROGRAM_ARB
:
351 case GL_FRAGMENT_SHADER
:
352 case GL_FRAGMENT_PROGRAM_ARB
:
354 case GL_GEOMETRY_SHADER
:
357 assert(!"Should not get here.");
365 * Translate a gl_shader_type to a short shader stage name for debug printouts
366 * and error messages.
369 _mesa_shader_type_to_string(unsigned target
)
372 case MESA_SHADER_VERTEX
: return "vertex";
373 case MESA_SHADER_FRAGMENT
: return "fragment";
374 case MESA_SHADER_GEOMETRY
: return "geometry";
377 assert(!"Should not get here.");
381 /* This helper function will append the given message to the shader's
382 info log and report it via GL_ARB_debug_output. Per that extension,
383 'type' is one of the enum values classifying the message, and
384 'id' is the implementation-defined ID of the given message. */
386 _mesa_glsl_msg(const YYLTYPE
*locp
, _mesa_glsl_parse_state
*state
,
387 GLenum type
, const char *fmt
, va_list ap
)
389 bool error
= (type
== MESA_DEBUG_TYPE_ERROR
);
392 assert(state
->info_log
!= NULL
);
394 /* Get the offset that the new message will be written to. */
395 int msg_offset
= strlen(state
->info_log
);
397 ralloc_asprintf_append(&state
->info_log
, "%u:%u(%u): %s: ",
401 error
? "error" : "warning");
402 ralloc_vasprintf_append(&state
->info_log
, fmt
, ap
);
404 const char *const msg
= &state
->info_log
[msg_offset
];
405 struct gl_context
*ctx
= state
->ctx
;
407 /* Report the error via GL_ARB_debug_output. */
408 _mesa_shader_debug(ctx
, type
, &msg_id
, msg
, strlen(msg
));
410 ralloc_strcat(&state
->info_log
, "\n");
414 _mesa_glsl_error(YYLTYPE
*locp
, _mesa_glsl_parse_state
*state
,
415 const char *fmt
, ...)
422 _mesa_glsl_msg(locp
, state
, MESA_DEBUG_TYPE_ERROR
, fmt
, ap
);
428 _mesa_glsl_warning(const YYLTYPE
*locp
, _mesa_glsl_parse_state
*state
,
429 const char *fmt
, ...)
434 _mesa_glsl_msg(locp
, state
, MESA_DEBUG_TYPE_OTHER
, fmt
, ap
);
440 * Enum representing the possible behaviors that can be specified in
441 * an #extension directive.
451 * Element type for _mesa_glsl_supported_extensions
453 struct _mesa_glsl_extension
{
455 * Name of the extension when referred to in a GLSL extension
460 /** True if this extension is available to desktop GL shaders */
463 /** True if this extension is available to GLES shaders */
467 * Flag in the gl_extensions struct indicating whether this
468 * extension is supported by the driver, or
469 * &gl_extensions::dummy_true if supported by all drivers.
471 * Note: the type (GLboolean gl_extensions::*) is a "pointer to
472 * member" type, the type-safe alternative to the "offsetof" macro.
475 * - foo bar::* p declares p to be an "offset" to a field of type
476 * foo that exists within struct bar
477 * - &bar::baz computes the "offset" of field baz within struct bar
478 * - x.*p accesses the field of x that exists at "offset" p
479 * - x->*p is equivalent to (*x).*p
481 const GLboolean
gl_extensions::* supported_flag
;
484 * Flag in the _mesa_glsl_parse_state struct that should be set
485 * when this extension is enabled.
487 * See note in _mesa_glsl_extension::supported_flag about "pointer
490 bool _mesa_glsl_parse_state::* enable_flag
;
493 * Flag in the _mesa_glsl_parse_state struct that should be set
494 * when the shader requests "warn" behavior for this extension.
496 * See note in _mesa_glsl_extension::supported_flag about "pointer
499 bool _mesa_glsl_parse_state::* warn_flag
;
502 bool compatible_with_state(const _mesa_glsl_parse_state
*state
) const;
503 void set_flags(_mesa_glsl_parse_state
*state
, ext_behavior behavior
) const;
506 #define EXT(NAME, GL, ES, SUPPORTED_FLAG) \
507 { "GL_" #NAME, GL, ES, &gl_extensions::SUPPORTED_FLAG, \
508 &_mesa_glsl_parse_state::NAME##_enable, \
509 &_mesa_glsl_parse_state::NAME##_warn }
512 * Table of extensions that can be enabled/disabled within a shader,
513 * and the conditions under which they are supported.
515 static const _mesa_glsl_extension _mesa_glsl_supported_extensions
[] = {
516 /* API availability */
517 /* name GL ES supported flag */
518 EXT(ARB_conservative_depth
, true, false, ARB_conservative_depth
),
519 EXT(ARB_draw_buffers
, true, false, dummy_true
),
520 EXT(ARB_draw_instanced
, true, false, ARB_draw_instanced
),
521 EXT(ARB_explicit_attrib_location
, true, false, ARB_explicit_attrib_location
),
522 EXT(ARB_fragment_coord_conventions
, true, false, ARB_fragment_coord_conventions
),
523 EXT(ARB_texture_rectangle
, true, false, dummy_true
),
524 EXT(EXT_texture_array
, true, false, EXT_texture_array
),
525 EXT(ARB_shader_texture_lod
, true, false, ARB_shader_texture_lod
),
526 EXT(ARB_shader_stencil_export
, true, false, ARB_shader_stencil_export
),
527 EXT(AMD_conservative_depth
, true, false, ARB_conservative_depth
),
528 EXT(AMD_shader_stencil_export
, true, false, ARB_shader_stencil_export
),
529 EXT(OES_texture_3D
, false, true, EXT_texture3D
),
530 EXT(OES_EGL_image_external
, false, true, OES_EGL_image_external
),
531 EXT(ARB_shader_bit_encoding
, true, false, ARB_shader_bit_encoding
),
532 EXT(ARB_uniform_buffer_object
, true, false, ARB_uniform_buffer_object
),
533 EXT(OES_standard_derivatives
, false, true, OES_standard_derivatives
),
534 EXT(ARB_texture_cube_map_array
, true, false, ARB_texture_cube_map_array
),
535 EXT(ARB_shading_language_packing
, true, false, ARB_shading_language_packing
),
536 EXT(ARB_shading_language_420pack
, true, false, ARB_shading_language_420pack
),
537 EXT(ARB_texture_multisample
, true, false, ARB_texture_multisample
),
538 EXT(ARB_texture_query_levels
, true, false, ARB_texture_query_levels
),
539 EXT(ARB_texture_query_lod
, true, false, ARB_texture_query_lod
),
540 EXT(ARB_gpu_shader5
, true, false, ARB_gpu_shader5
),
541 EXT(AMD_vertex_shader_layer
, true, false, AMD_vertex_shader_layer
),
542 EXT(EXT_shader_integer_mix
, true, true, EXT_shader_integer_mix
),
543 EXT(ARB_texture_gather
, true, false, ARB_texture_gather
),
544 EXT(ARB_shader_atomic_counters
, true, false, ARB_shader_atomic_counters
),
545 EXT(ARB_sample_shading
, true, false, ARB_sample_shading
),
546 EXT(AMD_shader_trinary_minmax
, true, false, dummy_true
),
553 * Determine whether a given extension is compatible with the target,
554 * API, and extension information in the current parser state.
556 bool _mesa_glsl_extension::compatible_with_state(const _mesa_glsl_parse_state
*
559 /* Check that this extension matches whether we are compiling
560 * for desktop GL or GLES.
562 if (state
->es_shader
) {
563 if (!this->avail_in_ES
) return false;
565 if (!this->avail_in_GL
) return false;
568 /* Check that this extension is supported by the OpenGL
571 * Note: the ->* operator indexes into state->extensions by the
572 * offset this->supported_flag. See
573 * _mesa_glsl_extension::supported_flag for more info.
575 return state
->extensions
->*(this->supported_flag
);
579 * Set the appropriate flags in the parser state to establish the
580 * given behavior for this extension.
582 void _mesa_glsl_extension::set_flags(_mesa_glsl_parse_state
*state
,
583 ext_behavior behavior
) const
585 /* Note: the ->* operator indexes into state by the
586 * offsets this->enable_flag and this->warn_flag. See
587 * _mesa_glsl_extension::supported_flag for more info.
589 state
->*(this->enable_flag
) = (behavior
!= extension_disable
);
590 state
->*(this->warn_flag
) = (behavior
== extension_warn
);
594 * Find an extension by name in _mesa_glsl_supported_extensions. If
595 * the name is not found, return NULL.
597 static const _mesa_glsl_extension
*find_extension(const char *name
)
599 for (unsigned i
= 0; i
< Elements(_mesa_glsl_supported_extensions
); ++i
) {
600 if (strcmp(name
, _mesa_glsl_supported_extensions
[i
].name
) == 0) {
601 return &_mesa_glsl_supported_extensions
[i
];
609 _mesa_glsl_process_extension(const char *name
, YYLTYPE
*name_locp
,
610 const char *behavior_string
, YYLTYPE
*behavior_locp
,
611 _mesa_glsl_parse_state
*state
)
613 ext_behavior behavior
;
614 if (strcmp(behavior_string
, "warn") == 0) {
615 behavior
= extension_warn
;
616 } else if (strcmp(behavior_string
, "require") == 0) {
617 behavior
= extension_require
;
618 } else if (strcmp(behavior_string
, "enable") == 0) {
619 behavior
= extension_enable
;
620 } else if (strcmp(behavior_string
, "disable") == 0) {
621 behavior
= extension_disable
;
623 _mesa_glsl_error(behavior_locp
, state
,
624 "unknown extension behavior `%s'",
629 if (strcmp(name
, "all") == 0) {
630 if ((behavior
== extension_enable
) || (behavior
== extension_require
)) {
631 _mesa_glsl_error(name_locp
, state
, "cannot %s all extensions",
632 (behavior
== extension_enable
)
633 ? "enable" : "require");
637 i
< Elements(_mesa_glsl_supported_extensions
); ++i
) {
638 const _mesa_glsl_extension
*extension
639 = &_mesa_glsl_supported_extensions
[i
];
640 if (extension
->compatible_with_state(state
)) {
641 _mesa_glsl_supported_extensions
[i
].set_flags(state
, behavior
);
646 const _mesa_glsl_extension
*extension
= find_extension(name
);
647 if (extension
&& extension
->compatible_with_state(state
)) {
648 extension
->set_flags(state
, behavior
);
650 static const char *const fmt
= "extension `%s' unsupported in %s shader";
652 if (behavior
== extension_require
) {
653 _mesa_glsl_error(name_locp
, state
, fmt
,
654 name
, _mesa_shader_type_to_string(state
->target
));
657 _mesa_glsl_warning(name_locp
, state
, fmt
,
658 name
, _mesa_shader_type_to_string(state
->target
));
668 * Returns the name of the type of a column of a matrix. E.g.,
674 _mesa_ast_get_matrix_column_type_name(const char *matrix_type_name
)
676 static const char *vec_name
[] = { "vec2", "vec3", "vec4" };
678 /* The number of elements in a row of a matrix is specified by the last
679 * character of the matrix type name.
681 long rows
= strtol(matrix_type_name
+ strlen(matrix_type_name
) - 1,
683 return vec_name
[rows
- 2];
687 * Recurses through <type> and <expr> if <expr> is an aggregate initializer
688 * and sets <expr>'s <constructor_type> field to <type>. Gives later functions
689 * (process_array_constructor, et al) sufficient information to do type
692 * Operates on assignments involving an aggregate initializer. E.g.,
694 * vec4 pos = {1.0, -1.0, 0.0, 1.0};
696 * or more ridiculously,
709 * {1.0, 2.0, 3.0, 4.0}, // a[0].v[0]
710 * {5.0, 6.0, 7.0, 8.0} // a[0].v[1]
715 * {1.0, 2.0, 3.0, 4.0}, // a[1].v[0]
716 * {5.0, 6.0, 7.0, 8.0} // a[1].v[1]
722 * {1.0, 2.0, 3.0, 4.0}, // b.v[0]
723 * {5.0, 6.0, 7.0, 8.0} // b.v[1]
729 * This pass is necessary because the right-hand side of <type> e = { ... }
730 * doesn't contain sufficient information to determine if the types match.
733 _mesa_ast_set_aggregate_type(const ast_type_specifier
*type
,
734 ast_expression
*expr
,
735 _mesa_glsl_parse_state
*state
)
738 ast_aggregate_initializer
*ai
= (ast_aggregate_initializer
*)expr
;
739 ai
->constructor_type
= (ast_type_specifier
*)type
;
741 bool is_declaration
= ai
->constructor_type
->structure
!= NULL
;
742 if (!is_declaration
) {
743 /* Look up <type> name in the symbol table to see if it's a struct. */
744 const ast_type_specifier
*struct_type
=
745 state
->symbols
->get_type_ast(type
->type_name
);
746 ai
->constructor_type
->structure
=
747 struct_type
? new(ctx
) ast_struct_specifier(*struct_type
->structure
)
751 /* If the aggregate is an array, recursively set its elements' types. */
752 if (type
->is_array
) {
753 /* We want to set the element type which is not an array itself, so make
754 * a copy of the array type and set its is_array field to false.
756 * E.g., if <type> if struct S[2] we want to set each element's type to
759 * FINISHME: Update when ARB_array_of_arrays is supported.
761 const ast_type_specifier
*non_array_type
=
762 new(ctx
) ast_type_specifier(type
, false, NULL
);
764 for (exec_node
*expr_node
= ai
->expressions
.head
;
765 !expr_node
->is_tail_sentinel();
766 expr_node
= expr_node
->next
) {
767 ast_expression
*expr
= exec_node_data(ast_expression
, expr_node
,
770 if (expr
->oper
== ast_aggregate
)
771 _mesa_ast_set_aggregate_type(non_array_type
, expr
, state
);
774 /* If the aggregate is a struct, recursively set its fields' types. */
775 } else if (ai
->constructor_type
->structure
) {
776 ai
->constructor_type
->structure
->is_declaration
= is_declaration
;
777 exec_node
*expr_node
= ai
->expressions
.head
;
779 /* Iterate through the struct's fields' declarations. E.g., iterate from
780 * "float a, b" to "int c" in the struct below.
787 for (exec_node
*decl_list_node
=
788 ai
->constructor_type
->structure
->declarations
.head
;
789 !decl_list_node
->is_tail_sentinel();
790 decl_list_node
= decl_list_node
->next
) {
791 ast_declarator_list
*decl_list
= exec_node_data(ast_declarator_list
,
792 decl_list_node
, link
);
794 for (exec_node
*decl_node
= decl_list
->declarations
.head
;
795 !decl_node
->is_tail_sentinel() && !expr_node
->is_tail_sentinel();
796 decl_node
= decl_node
->next
, expr_node
= expr_node
->next
) {
797 ast_declaration
*decl
= exec_node_data(ast_declaration
, decl_node
,
799 ast_expression
*expr
= exec_node_data(ast_expression
, expr_node
,
802 bool is_array
= decl_list
->type
->specifier
->is_array
;
803 ast_expression
*array_size
= decl_list
->type
->specifier
->array_size
;
805 /* Recognize variable declarations with the bracketed size attached
806 * to the type rather than the variable name as arrays. E.g.,
811 * are both arrays, but <a>'s array_size is decl->array_size, while
812 * <b>'s array_size is decl_list->type->specifier->array_size.
815 /* FINISHME: Update when ARB_array_of_arrays is supported. */
816 is_array
= decl
->is_array
;
817 array_size
= decl
->array_size
;
820 /* Declaration shadows the <type> parameter. */
821 ast_type_specifier
*type
=
822 new(ctx
) ast_type_specifier(decl_list
->type
->specifier
,
823 is_array
, array_size
);
825 if (expr
->oper
== ast_aggregate
)
826 _mesa_ast_set_aggregate_type(type
, expr
, state
);
830 /* If the aggregate is a matrix, set its columns' types. */
832 const glsl_type
*const constructor_type
=
833 ai
->constructor_type
->glsl_type(&name
, state
);
835 if (constructor_type
->is_matrix()) {
836 for (exec_node
*expr_node
= ai
->expressions
.head
;
837 !expr_node
->is_tail_sentinel();
838 expr_node
= expr_node
->next
) {
839 ast_expression
*expr
= exec_node_data(ast_expression
, expr_node
,
842 /* Declaration shadows the <type> parameter. */
843 ast_type_specifier
*type
= new(ctx
)
844 ast_type_specifier(_mesa_ast_get_matrix_column_type_name(name
));
846 if (expr
->oper
== ast_aggregate
)
847 _mesa_ast_set_aggregate_type(type
, expr
, state
);
855 _mesa_ast_type_qualifier_print(const struct ast_type_qualifier
*q
)
857 if (q
->flags
.q
.constant
)
860 if (q
->flags
.q
.invariant
)
861 printf("invariant ");
863 if (q
->flags
.q
.attribute
)
864 printf("attribute ");
866 if (q
->flags
.q
.varying
)
869 if (q
->flags
.q
.in
&& q
->flags
.q
.out
)
879 if (q
->flags
.q
.centroid
)
881 if (q
->flags
.q
.sample
)
883 if (q
->flags
.q
.uniform
)
885 if (q
->flags
.q
.smooth
)
889 if (q
->flags
.q
.noperspective
)
890 printf("noperspective ");
895 ast_node::print(void) const
897 printf("unhandled node ");
901 ast_node::ast_node(void)
903 this->location
.source
= 0;
904 this->location
.line
= 0;
905 this->location
.column
= 0;
910 ast_opt_array_size_print(bool is_array
, const ast_expression
*array_size
)
924 ast_compound_statement::print(void) const
928 foreach_list_const(n
, &this->statements
) {
929 ast_node
*ast
= exec_node_data(ast_node
, n
, link
);
937 ast_compound_statement::ast_compound_statement(int new_scope
,
938 ast_node
*statements
)
940 this->new_scope
= new_scope
;
942 if (statements
!= NULL
) {
943 this->statements
.push_degenerate_list_at_head(&statements
->link
);
949 ast_expression::print(void) const
963 subexpressions
[0]->print();
964 printf("%s ", operator_string(oper
));
965 subexpressions
[1]->print();
968 case ast_field_selection
:
969 subexpressions
[0]->print();
970 printf(". %s ", primary_expression
.identifier
);
979 printf("%s ", operator_string(oper
));
980 subexpressions
[0]->print();
985 subexpressions
[0]->print();
986 printf("%s ", operator_string(oper
));
989 case ast_conditional
:
990 subexpressions
[0]->print();
992 subexpressions
[1]->print();
994 subexpressions
[2]->print();
997 case ast_array_index
:
998 subexpressions
[0]->print();
1000 subexpressions
[1]->print();
1004 case ast_function_call
: {
1005 subexpressions
[0]->print();
1008 foreach_list_const (n
, &this->expressions
) {
1009 if (n
!= this->expressions
.get_head())
1012 ast_node
*ast
= exec_node_data(ast_node
, n
, link
);
1020 case ast_identifier
:
1021 printf("%s ", primary_expression
.identifier
);
1024 case ast_int_constant
:
1025 printf("%d ", primary_expression
.int_constant
);
1028 case ast_uint_constant
:
1029 printf("%u ", primary_expression
.uint_constant
);
1032 case ast_float_constant
:
1033 printf("%f ", primary_expression
.float_constant
);
1036 case ast_bool_constant
:
1038 primary_expression
.bool_constant
1039 ? "true" : "false");
1042 case ast_sequence
: {
1044 foreach_list_const(n
, & this->expressions
) {
1045 if (n
!= this->expressions
.get_head())
1048 ast_node
*ast
= exec_node_data(ast_node
, n
, link
);
1055 case ast_aggregate
: {
1057 foreach_list_const(n
, & this->expressions
) {
1058 if (n
!= this->expressions
.get_head())
1061 ast_node
*ast
= exec_node_data(ast_node
, n
, link
);
1074 ast_expression::ast_expression(int oper
,
1075 ast_expression
*ex0
,
1076 ast_expression
*ex1
,
1077 ast_expression
*ex2
) :
1078 primary_expression()
1080 this->oper
= ast_operators(oper
);
1081 this->subexpressions
[0] = ex0
;
1082 this->subexpressions
[1] = ex1
;
1083 this->subexpressions
[2] = ex2
;
1084 this->non_lvalue_description
= NULL
;
1089 ast_expression_statement::print(void) const
1092 expression
->print();
1098 ast_expression_statement::ast_expression_statement(ast_expression
*ex
) :
1106 ast_function::print(void) const
1108 return_type
->print();
1109 printf(" %s (", identifier
);
1111 foreach_list_const(n
, & this->parameters
) {
1112 ast_node
*ast
= exec_node_data(ast_node
, n
, link
);
1120 ast_function::ast_function(void)
1121 : return_type(NULL
), identifier(NULL
), is_definition(false),
1129 ast_fully_specified_type::print(void) const
1131 _mesa_ast_type_qualifier_print(& qualifier
);
1137 ast_parameter_declarator::print(void) const
1141 printf("%s ", identifier
);
1142 ast_opt_array_size_print(is_array
, array_size
);
1147 ast_function_definition::print(void) const
1155 ast_declaration::print(void) const
1157 printf("%s ", identifier
);
1158 ast_opt_array_size_print(is_array
, array_size
);
1162 initializer
->print();
1167 ast_declaration::ast_declaration(const char *identifier
, bool is_array
,
1168 ast_expression
*array_size
,
1169 ast_expression
*initializer
)
1171 this->identifier
= identifier
;
1172 this->is_array
= is_array
;
1173 this->array_size
= array_size
;
1174 this->initializer
= initializer
;
1179 ast_declarator_list::print(void) const
1181 assert(type
|| invariant
);
1186 printf("invariant ");
1188 foreach_list_const (ptr
, & this->declarations
) {
1189 if (ptr
!= this->declarations
.get_head())
1192 ast_node
*ast
= exec_node_data(ast_node
, ptr
, link
);
1200 ast_declarator_list::ast_declarator_list(ast_fully_specified_type
*type
)
1203 this->invariant
= false;
1207 ast_jump_statement::print(void) const
1211 printf("continue; ");
1218 if (opt_return_value
)
1219 opt_return_value
->print();
1224 printf("discard; ");
1230 ast_jump_statement::ast_jump_statement(int mode
, ast_expression
*return_value
)
1231 : opt_return_value(NULL
)
1233 this->mode
= ast_jump_modes(mode
);
1235 if (mode
== ast_return
)
1236 opt_return_value
= return_value
;
1241 ast_selection_statement::print(void) const
1247 then_statement
->print();
1249 if (else_statement
) {
1251 else_statement
->print();
1257 ast_selection_statement::ast_selection_statement(ast_expression
*condition
,
1258 ast_node
*then_statement
,
1259 ast_node
*else_statement
)
1261 this->condition
= condition
;
1262 this->then_statement
= then_statement
;
1263 this->else_statement
= else_statement
;
1268 ast_switch_statement::print(void) const
1270 printf("switch ( ");
1271 test_expression
->print();
1278 ast_switch_statement::ast_switch_statement(ast_expression
*test_expression
,
1281 this->test_expression
= test_expression
;
1287 ast_switch_body::print(void) const
1290 if (stmts
!= NULL
) {
1297 ast_switch_body::ast_switch_body(ast_case_statement_list
*stmts
)
1299 this->stmts
= stmts
;
1303 void ast_case_label::print(void) const
1305 if (test_value
!= NULL
) {
1307 test_value
->print();
1310 printf("default: ");
1315 ast_case_label::ast_case_label(ast_expression
*test_value
)
1317 this->test_value
= test_value
;
1321 void ast_case_label_list::print(void) const
1323 foreach_list_const(n
, & this->labels
) {
1324 ast_node
*ast
= exec_node_data(ast_node
, n
, link
);
1331 ast_case_label_list::ast_case_label_list(void)
1336 void ast_case_statement::print(void) const
1339 foreach_list_const(n
, & this->stmts
) {
1340 ast_node
*ast
= exec_node_data(ast_node
, n
, link
);
1347 ast_case_statement::ast_case_statement(ast_case_label_list
*labels
)
1349 this->labels
= labels
;
1353 void ast_case_statement_list::print(void) const
1355 foreach_list_const(n
, & this->cases
) {
1356 ast_node
*ast
= exec_node_data(ast_node
, n
, link
);
1362 ast_case_statement_list::ast_case_statement_list(void)
1368 ast_iteration_statement::print(void) const
1374 init_statement
->print();
1381 if (rest_expression
)
1382 rest_expression
->print();
1408 ast_iteration_statement::ast_iteration_statement(int mode
,
1410 ast_node
*condition
,
1411 ast_expression
*rest_expression
,
1414 this->mode
= ast_iteration_modes(mode
);
1415 this->init_statement
= init
;
1416 this->condition
= condition
;
1417 this->rest_expression
= rest_expression
;
1423 ast_struct_specifier::print(void) const
1425 printf("struct %s { ", name
);
1426 foreach_list_const(n
, &this->declarations
) {
1427 ast_node
*ast
= exec_node_data(ast_node
, n
, link
);
1434 ast_struct_specifier::ast_struct_specifier(const char *identifier
,
1435 ast_declarator_list
*declarator_list
)
1437 if (identifier
== NULL
) {
1438 static unsigned anon_count
= 1;
1439 identifier
= ralloc_asprintf(this, "#anon_struct_%04x", anon_count
);
1443 this->declarations
.push_degenerate_list_at_head(&declarator_list
->link
);
1444 is_declaration
= true;
1448 set_shader_inout_layout(struct gl_shader
*shader
,
1449 struct _mesa_glsl_parse_state
*state
)
1451 if (shader
->Type
!= GL_GEOMETRY_SHADER
) {
1452 /* Should have been prevented by the parser. */
1453 assert(!state
->gs_input_prim_type_specified
);
1454 assert(!state
->out_qualifier
->flags
.i
);
1458 shader
->Geom
.VerticesOut
= 0;
1459 if (state
->out_qualifier
->flags
.q
.max_vertices
)
1460 shader
->Geom
.VerticesOut
= state
->out_qualifier
->max_vertices
;
1462 if (state
->gs_input_prim_type_specified
) {
1463 shader
->Geom
.InputType
= state
->gs_input_prim_type
;
1465 shader
->Geom
.InputType
= PRIM_UNKNOWN
;
1468 if (state
->out_qualifier
->flags
.q
.prim_type
) {
1469 shader
->Geom
.OutputType
= state
->out_qualifier
->prim_type
;
1471 shader
->Geom
.OutputType
= PRIM_UNKNOWN
;
1478 _mesa_glsl_compile_shader(struct gl_context
*ctx
, struct gl_shader
*shader
,
1479 bool dump_ast
, bool dump_hir
)
1481 struct _mesa_glsl_parse_state
*state
=
1482 new(shader
) _mesa_glsl_parse_state(ctx
, shader
->Type
, shader
);
1483 const char *source
= shader
->Source
;
1485 state
->error
= glcpp_preprocess(state
, &source
, &state
->info_log
,
1486 &ctx
->Extensions
, ctx
);
1488 if (!state
->error
) {
1489 _mesa_glsl_lexer_ctor(state
, source
);
1490 _mesa_glsl_parse(state
);
1491 _mesa_glsl_lexer_dtor(state
);
1495 foreach_list_const(n
, &state
->translation_unit
) {
1496 ast_node
*ast
= exec_node_data(ast_node
, n
, link
);
1502 ralloc_free(shader
->ir
);
1503 shader
->ir
= new(shader
) exec_list
;
1504 if (!state
->error
&& !state
->translation_unit
.is_empty())
1505 _mesa_ast_to_hir(shader
->ir
, state
);
1507 if (!state
->error
) {
1508 validate_ir_tree(shader
->ir
);
1510 /* Print out the unoptimized IR. */
1512 _mesa_print_ir(shader
->ir
, state
);
1517 if (!state
->error
&& !shader
->ir
->is_empty()) {
1518 struct gl_shader_compiler_options
*options
=
1519 &ctx
->ShaderCompilerOptions
[_mesa_shader_type_to_index(shader
->Type
)];
1521 /* Do some optimization at compile time to reduce shader IR size
1522 * and reduce later work if the same shader is linked multiple times
1524 while (do_common_optimization(shader
->ir
, false, false, 32, options
))
1527 validate_ir_tree(shader
->ir
);
1530 if (shader
->InfoLog
)
1531 ralloc_free(shader
->InfoLog
);
1533 shader
->symbols
= state
->symbols
;
1534 shader
->CompileStatus
= !state
->error
;
1535 shader
->InfoLog
= state
->info_log
;
1536 shader
->Version
= state
->language_version
;
1537 shader
->IsES
= state
->es_shader
;
1538 shader
->uses_builtin_functions
= state
->uses_builtin_functions
;
1540 if (shader
->UniformBlocks
)
1541 ralloc_free(shader
->UniformBlocks
);
1542 shader
->NumUniformBlocks
= state
->num_uniform_blocks
;
1543 shader
->UniformBlocks
= state
->uniform_blocks
;
1544 ralloc_steal(shader
, shader
->UniformBlocks
);
1547 set_shader_inout_layout(shader
, state
);
1549 /* Retain any live IR, but trash the rest. */
1550 reparent_ir(shader
->ir
, shader
->ir
);
1557 * Do the set of common optimizations passes
1559 * \param ir List of instructions to be optimized
1560 * \param linked Is the shader linked? This enables
1561 * optimizations passes that remove code at
1562 * global scope and could cause linking to
1564 * \param uniform_locations_assigned Have locations already been assigned for
1565 * uniforms? This prevents the declarations
1566 * of unused uniforms from being removed.
1567 * The setting of this flag only matters if
1568 * \c linked is \c true.
1569 * \param max_unroll_iterations Maximum number of loop iterations to be
1570 * unrolled. Setting to 0 disables loop
1572 * \param options The driver's preferred shader options.
1575 do_common_optimization(exec_list
*ir
, bool linked
,
1576 bool uniform_locations_assigned
,
1577 unsigned max_unroll_iterations
,
1578 const struct gl_shader_compiler_options
*options
)
1580 GLboolean progress
= GL_FALSE
;
1582 progress
= lower_instructions(ir
, SUB_TO_ADD_NEG
) || progress
;
1585 progress
= do_function_inlining(ir
) || progress
;
1586 progress
= do_dead_functions(ir
) || progress
;
1587 progress
= do_structure_splitting(ir
) || progress
;
1589 progress
= do_if_simplification(ir
) || progress
;
1590 progress
= opt_flatten_nested_if_blocks(ir
) || progress
;
1591 progress
= do_copy_propagation(ir
) || progress
;
1592 progress
= do_copy_propagation_elements(ir
) || progress
;
1594 if (options
->PreferDP4
&& !linked
)
1595 progress
= opt_flip_matrices(ir
) || progress
;
1598 progress
= do_dead_code(ir
, uniform_locations_assigned
) || progress
;
1600 progress
= do_dead_code_unlinked(ir
) || progress
;
1601 progress
= do_dead_code_local(ir
) || progress
;
1602 progress
= do_tree_grafting(ir
) || progress
;
1603 progress
= do_constant_propagation(ir
) || progress
;
1605 progress
= do_constant_variable(ir
) || progress
;
1607 progress
= do_constant_variable_unlinked(ir
) || progress
;
1608 progress
= do_constant_folding(ir
) || progress
;
1609 progress
= do_cse(ir
) || progress
;
1610 progress
= do_algebraic(ir
) || progress
;
1611 progress
= do_lower_jumps(ir
) || progress
;
1612 progress
= do_vec_index_to_swizzle(ir
) || progress
;
1613 progress
= lower_vector_insert(ir
, false) || progress
;
1614 progress
= do_swizzle_swizzle(ir
) || progress
;
1615 progress
= do_noop_swizzle(ir
) || progress
;
1617 progress
= optimize_split_arrays(ir
, linked
) || progress
;
1618 progress
= optimize_redundant_jumps(ir
) || progress
;
1620 loop_state
*ls
= analyze_loop_variables(ir
);
1621 if (ls
->loop_found
) {
1622 progress
= set_loop_controls(ir
, ls
) || progress
;
1623 progress
= unroll_loops(ir
, ls
, max_unroll_iterations
) || progress
;
1633 * To be called at GL teardown time, this frees compiler datastructures.
1635 * After calling this, any previously compiled shaders and shader
1636 * programs would be invalid. So this should happen at approximately
1640 _mesa_destroy_shader_compiler(void)
1642 _mesa_destroy_shader_compiler_caches();
1644 _mesa_glsl_release_types();
1648 * Releases compiler caches to trade off performance for memory.
1650 * Intended to be used with glReleaseShaderCompiler().
1653 _mesa_destroy_shader_compiler_caches(void)
1655 _mesa_glsl_release_builtin_functions();