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"
32 #include "util/u_atomic.h" /* for p_atomic_cmpxchg */
35 #include "util/ralloc.h"
37 #include "glsl_parser_extras.h"
38 #include "glsl_parser.h"
39 #include "ir_optimization.h"
40 #include "loop_analysis.h"
43 * Format a short human-readable description of the given GLSL version.
46 glsl_compute_version_string(void *mem_ctx
, bool is_es
, unsigned version
)
48 return ralloc_asprintf(mem_ctx
, "GLSL%s %d.%02d", is_es
? " ES" : "",
49 version
/ 100, version
% 100);
53 static const unsigned known_desktop_glsl_versions
[] =
54 { 110, 120, 130, 140, 150, 330, 400, 410, 420, 430, 440 };
57 _mesa_glsl_parse_state::_mesa_glsl_parse_state(struct gl_context
*_ctx
,
58 gl_shader_stage stage
,
60 : ctx(_ctx
), cs_input_local_size_specified(false), cs_input_local_size(),
63 assert(stage
< MESA_SHADER_STAGES
);
67 this->translation_unit
.make_empty();
68 this->symbols
= new(mem_ctx
) glsl_symbol_table
;
70 this->info_log
= ralloc_strdup(mem_ctx
, "");
72 this->loop_nesting_ast
= NULL
;
74 this->struct_specifier_depth
= 0;
76 this->uses_builtin_functions
= false;
78 /* Set default language version and extensions */
79 this->language_version
= ctx
->Const
.ForceGLSLVersion
?
80 ctx
->Const
.ForceGLSLVersion
: 110;
81 this->es_shader
= false;
82 this->ARB_texture_rectangle_enable
= true;
84 /* OpenGL ES 2.0 has different defaults from desktop GL. */
85 if (ctx
->API
== API_OPENGLES2
) {
86 this->language_version
= 100;
87 this->es_shader
= true;
88 this->ARB_texture_rectangle_enable
= false;
91 this->extensions
= &ctx
->Extensions
;
93 this->Const
.MaxLights
= ctx
->Const
.MaxLights
;
94 this->Const
.MaxClipPlanes
= ctx
->Const
.MaxClipPlanes
;
95 this->Const
.MaxTextureUnits
= ctx
->Const
.MaxTextureUnits
;
96 this->Const
.MaxTextureCoords
= ctx
->Const
.MaxTextureCoordUnits
;
97 this->Const
.MaxVertexAttribs
= ctx
->Const
.Program
[MESA_SHADER_VERTEX
].MaxAttribs
;
98 this->Const
.MaxVertexUniformComponents
= ctx
->Const
.Program
[MESA_SHADER_VERTEX
].MaxUniformComponents
;
99 this->Const
.MaxVertexTextureImageUnits
= ctx
->Const
.Program
[MESA_SHADER_VERTEX
].MaxTextureImageUnits
;
100 this->Const
.MaxCombinedTextureImageUnits
= ctx
->Const
.MaxCombinedTextureImageUnits
;
101 this->Const
.MaxTextureImageUnits
= ctx
->Const
.Program
[MESA_SHADER_FRAGMENT
].MaxTextureImageUnits
;
102 this->Const
.MaxFragmentUniformComponents
= ctx
->Const
.Program
[MESA_SHADER_FRAGMENT
].MaxUniformComponents
;
103 this->Const
.MinProgramTexelOffset
= ctx
->Const
.MinProgramTexelOffset
;
104 this->Const
.MaxProgramTexelOffset
= ctx
->Const
.MaxProgramTexelOffset
;
106 this->Const
.MaxDrawBuffers
= ctx
->Const
.MaxDrawBuffers
;
109 this->Const
.MaxVertexOutputComponents
= ctx
->Const
.Program
[MESA_SHADER_VERTEX
].MaxOutputComponents
;
110 this->Const
.MaxGeometryInputComponents
= ctx
->Const
.Program
[MESA_SHADER_GEOMETRY
].MaxInputComponents
;
111 this->Const
.MaxGeometryOutputComponents
= ctx
->Const
.Program
[MESA_SHADER_GEOMETRY
].MaxOutputComponents
;
112 this->Const
.MaxFragmentInputComponents
= ctx
->Const
.Program
[MESA_SHADER_FRAGMENT
].MaxInputComponents
;
113 this->Const
.MaxGeometryTextureImageUnits
= ctx
->Const
.Program
[MESA_SHADER_GEOMETRY
].MaxTextureImageUnits
;
114 this->Const
.MaxGeometryOutputVertices
= ctx
->Const
.MaxGeometryOutputVertices
;
115 this->Const
.MaxGeometryTotalOutputComponents
= ctx
->Const
.MaxGeometryTotalOutputComponents
;
116 this->Const
.MaxGeometryUniformComponents
= ctx
->Const
.Program
[MESA_SHADER_GEOMETRY
].MaxUniformComponents
;
118 this->Const
.MaxVertexAtomicCounters
= ctx
->Const
.Program
[MESA_SHADER_VERTEX
].MaxAtomicCounters
;
119 this->Const
.MaxGeometryAtomicCounters
= ctx
->Const
.Program
[MESA_SHADER_GEOMETRY
].MaxAtomicCounters
;
120 this->Const
.MaxFragmentAtomicCounters
= ctx
->Const
.Program
[MESA_SHADER_FRAGMENT
].MaxAtomicCounters
;
121 this->Const
.MaxCombinedAtomicCounters
= ctx
->Const
.MaxCombinedAtomicCounters
;
122 this->Const
.MaxAtomicBufferBindings
= ctx
->Const
.MaxAtomicBufferBindings
;
124 /* Compute shader constants */
125 for (unsigned i
= 0; i
< Elements(this->Const
.MaxComputeWorkGroupCount
); i
++)
126 this->Const
.MaxComputeWorkGroupCount
[i
] = ctx
->Const
.MaxComputeWorkGroupCount
[i
];
127 for (unsigned i
= 0; i
< Elements(this->Const
.MaxComputeWorkGroupSize
); i
++)
128 this->Const
.MaxComputeWorkGroupSize
[i
] = ctx
->Const
.MaxComputeWorkGroupSize
[i
];
130 this->Const
.MaxImageUnits
= ctx
->Const
.MaxImageUnits
;
131 this->Const
.MaxCombinedImageUnitsAndFragmentOutputs
= ctx
->Const
.MaxCombinedImageUnitsAndFragmentOutputs
;
132 this->Const
.MaxImageSamples
= ctx
->Const
.MaxImageSamples
;
133 this->Const
.MaxVertexImageUniforms
= ctx
->Const
.Program
[MESA_SHADER_VERTEX
].MaxImageUniforms
;
134 this->Const
.MaxGeometryImageUniforms
= ctx
->Const
.Program
[MESA_SHADER_GEOMETRY
].MaxImageUniforms
;
135 this->Const
.MaxFragmentImageUniforms
= ctx
->Const
.Program
[MESA_SHADER_FRAGMENT
].MaxImageUniforms
;
136 this->Const
.MaxCombinedImageUniforms
= ctx
->Const
.MaxCombinedImageUniforms
;
138 this->current_function
= NULL
;
139 this->toplevel_ir
= NULL
;
140 this->found_return
= false;
141 this->all_invariant
= false;
142 this->user_structures
= NULL
;
143 this->num_user_structures
= 0;
145 /* Populate the list of supported GLSL versions */
146 /* FINISHME: Once the OpenGL 3.0 'forward compatible' context or
147 * the OpenGL 3.2 Core context is supported, this logic will need
148 * change. Older versions of GLSL are no longer supported
149 * outside the compatibility contexts of 3.x.
151 this->num_supported_versions
= 0;
152 if (_mesa_is_desktop_gl(ctx
)) {
153 for (unsigned i
= 0; i
< ARRAY_SIZE(known_desktop_glsl_versions
); i
++) {
154 if (known_desktop_glsl_versions
[i
] <= ctx
->Const
.GLSLVersion
) {
155 this->supported_versions
[this->num_supported_versions
].ver
156 = known_desktop_glsl_versions
[i
];
157 this->supported_versions
[this->num_supported_versions
].es
= false;
158 this->num_supported_versions
++;
162 if (ctx
->API
== API_OPENGLES2
|| ctx
->Extensions
.ARB_ES2_compatibility
) {
163 this->supported_versions
[this->num_supported_versions
].ver
= 100;
164 this->supported_versions
[this->num_supported_versions
].es
= true;
165 this->num_supported_versions
++;
167 if (_mesa_is_gles3(ctx
) || ctx
->Extensions
.ARB_ES3_compatibility
) {
168 this->supported_versions
[this->num_supported_versions
].ver
= 300;
169 this->supported_versions
[this->num_supported_versions
].es
= true;
170 this->num_supported_versions
++;
172 assert(this->num_supported_versions
173 <= ARRAY_SIZE(this->supported_versions
));
175 /* Create a string for use in error messages to tell the user which GLSL
176 * versions are supported.
178 char *supported
= ralloc_strdup(this, "");
179 for (unsigned i
= 0; i
< this->num_supported_versions
; i
++) {
180 unsigned ver
= this->supported_versions
[i
].ver
;
181 const char *const prefix
= (i
== 0)
183 : ((i
== this->num_supported_versions
- 1) ? ", and " : ", ");
184 const char *const suffix
= (this->supported_versions
[i
].es
) ? " ES" : "";
186 ralloc_asprintf_append(& supported
, "%s%u.%02u%s",
188 ver
/ 100, ver
% 100,
192 this->supported_version_string
= supported
;
194 if (ctx
->Const
.ForceGLSLExtensionsWarn
)
195 _mesa_glsl_process_extension("all", NULL
, "warn", NULL
, this);
197 this->default_uniform_qualifier
= new(this) ast_type_qualifier();
198 this->default_uniform_qualifier
->flags
.q
.shared
= 1;
199 this->default_uniform_qualifier
->flags
.q
.column_major
= 1;
201 this->fs_uses_gl_fragcoord
= false;
202 this->fs_redeclares_gl_fragcoord
= false;
203 this->fs_origin_upper_left
= false;
204 this->fs_pixel_center_integer
= false;
205 this->fs_redeclares_gl_fragcoord_with_no_layout_qualifiers
= false;
207 this->gs_input_prim_type_specified
= false;
208 this->gs_input_size
= 0;
209 this->in_qualifier
= new(this) ast_type_qualifier();
210 this->out_qualifier
= new(this) ast_type_qualifier();
211 this->early_fragment_tests
= false;
212 memset(this->atomic_counter_offsets
, 0,
213 sizeof(this->atomic_counter_offsets
));
214 this->allow_extension_directive_midshader
=
215 ctx
->Const
.AllowGLSLExtensionDirectiveMidShader
;
219 * Determine whether the current GLSL version is sufficiently high to support
220 * a certain feature, and generate an error message if it isn't.
222 * \param required_glsl_version and \c required_glsl_es_version are
223 * interpreted as they are in _mesa_glsl_parse_state::is_version().
225 * \param locp is the parser location where the error should be reported.
227 * \param fmt (and additional arguments) constitute a printf-style error
228 * message to report if the version check fails. Information about the
229 * current and required GLSL versions will be appended. So, for example, if
230 * the GLSL version being compiled is 1.20, and check_version(130, 300, locp,
231 * "foo unsupported") is called, the error message will be "foo unsupported in
232 * GLSL 1.20 (GLSL 1.30 or GLSL 3.00 ES required)".
235 _mesa_glsl_parse_state::check_version(unsigned required_glsl_version
,
236 unsigned required_glsl_es_version
,
237 YYLTYPE
*locp
, const char *fmt
, ...)
239 if (this->is_version(required_glsl_version
, required_glsl_es_version
))
244 char *problem
= ralloc_vasprintf(this, fmt
, args
);
246 const char *glsl_version_string
247 = glsl_compute_version_string(this, false, required_glsl_version
);
248 const char *glsl_es_version_string
249 = glsl_compute_version_string(this, true, required_glsl_es_version
);
250 const char *requirement_string
= "";
251 if (required_glsl_version
&& required_glsl_es_version
) {
252 requirement_string
= ralloc_asprintf(this, " (%s or %s required)",
254 glsl_es_version_string
);
255 } else if (required_glsl_version
) {
256 requirement_string
= ralloc_asprintf(this, " (%s required)",
257 glsl_version_string
);
258 } else if (required_glsl_es_version
) {
259 requirement_string
= ralloc_asprintf(this, " (%s required)",
260 glsl_es_version_string
);
262 _mesa_glsl_error(locp
, this, "%s in %s%s",
263 problem
, this->get_version_string(),
270 * Process a GLSL #version directive.
272 * \param version is the integer that follows the #version token.
274 * \param ident is a string identifier that follows the integer, if any is
275 * present. Otherwise NULL.
278 _mesa_glsl_parse_state::process_version_directive(YYLTYPE
*locp
, int version
,
281 bool es_token_present
= false;
283 if (strcmp(ident
, "es") == 0) {
284 es_token_present
= true;
285 } else if (version
>= 150) {
286 if (strcmp(ident
, "core") == 0) {
287 /* Accept the token. There's no need to record that this is
288 * a core profile shader since that's the only profile we support.
290 } else if (strcmp(ident
, "compatibility") == 0) {
291 _mesa_glsl_error(locp
, this,
292 "the compatibility profile is not supported");
294 _mesa_glsl_error(locp
, this,
295 "\"%s\" is not a valid shading language profile; "
296 "if present, it must be \"core\"", ident
);
299 _mesa_glsl_error(locp
, this,
300 "illegal text following version number");
304 this->es_shader
= es_token_present
;
305 if (version
== 100) {
306 if (es_token_present
) {
307 _mesa_glsl_error(locp
, this,
308 "GLSL 1.00 ES should be selected using "
311 this->es_shader
= true;
315 if (this->es_shader
) {
316 this->ARB_texture_rectangle_enable
= false;
319 this->language_version
= version
;
321 bool supported
= false;
322 for (unsigned i
= 0; i
< this->num_supported_versions
; i
++) {
323 if (this->supported_versions
[i
].ver
== (unsigned) version
324 && this->supported_versions
[i
].es
== this->es_shader
) {
331 _mesa_glsl_error(locp
, this, "%s is not supported. "
332 "Supported versions are: %s",
333 this->get_version_string(),
334 this->supported_version_string
);
336 /* On exit, the language_version must be set to a valid value.
337 * Later calls to _mesa_glsl_initialize_types will misbehave if
338 * the version is invalid.
340 switch (this->ctx
->API
) {
341 case API_OPENGL_COMPAT
:
342 case API_OPENGL_CORE
:
343 this->language_version
= this->ctx
->Const
.GLSLVersion
;
347 assert(!"Should not get here.");
351 this->language_version
= 100;
359 * Translate a gl_shader_stage to a short shader stage name for debug
360 * printouts and error messages.
363 _mesa_shader_stage_to_string(unsigned stage
)
366 case MESA_SHADER_VERTEX
: return "vertex";
367 case MESA_SHADER_FRAGMENT
: return "fragment";
368 case MESA_SHADER_GEOMETRY
: return "geometry";
371 assert(!"Should not get here.");
375 /* This helper function will append the given message to the shader's
376 info log and report it via GL_ARB_debug_output. Per that extension,
377 'type' is one of the enum values classifying the message, and
378 'id' is the implementation-defined ID of the given message. */
380 _mesa_glsl_msg(const YYLTYPE
*locp
, _mesa_glsl_parse_state
*state
,
381 GLenum type
, const char *fmt
, va_list ap
)
383 bool error
= (type
== MESA_DEBUG_TYPE_ERROR
);
386 assert(state
->info_log
!= NULL
);
388 /* Get the offset that the new message will be written to. */
389 int msg_offset
= strlen(state
->info_log
);
391 ralloc_asprintf_append(&state
->info_log
, "%u:%u(%u): %s: ",
395 error
? "error" : "warning");
396 ralloc_vasprintf_append(&state
->info_log
, fmt
, ap
);
398 const char *const msg
= &state
->info_log
[msg_offset
];
399 struct gl_context
*ctx
= state
->ctx
;
401 /* Report the error via GL_ARB_debug_output. */
402 _mesa_shader_debug(ctx
, type
, &msg_id
, msg
, strlen(msg
));
404 ralloc_strcat(&state
->info_log
, "\n");
408 _mesa_glsl_error(YYLTYPE
*locp
, _mesa_glsl_parse_state
*state
,
409 const char *fmt
, ...)
416 _mesa_glsl_msg(locp
, state
, MESA_DEBUG_TYPE_ERROR
, fmt
, ap
);
422 _mesa_glsl_warning(const YYLTYPE
*locp
, _mesa_glsl_parse_state
*state
,
423 const char *fmt
, ...)
428 _mesa_glsl_msg(locp
, state
, MESA_DEBUG_TYPE_OTHER
, fmt
, ap
);
434 * Enum representing the possible behaviors that can be specified in
435 * an #extension directive.
445 * Element type for _mesa_glsl_supported_extensions
447 struct _mesa_glsl_extension
{
449 * Name of the extension when referred to in a GLSL extension
454 /** True if this extension is available to desktop GL shaders */
457 /** True if this extension is available to GLES shaders */
461 * Flag in the gl_extensions struct indicating whether this
462 * extension is supported by the driver, or
463 * &gl_extensions::dummy_true if supported by all drivers.
465 * Note: the type (GLboolean gl_extensions::*) is a "pointer to
466 * member" type, the type-safe alternative to the "offsetof" macro.
469 * - foo bar::* p declares p to be an "offset" to a field of type
470 * foo that exists within struct bar
471 * - &bar::baz computes the "offset" of field baz within struct bar
472 * - x.*p accesses the field of x that exists at "offset" p
473 * - x->*p is equivalent to (*x).*p
475 const GLboolean
gl_extensions::* supported_flag
;
478 * Flag in the _mesa_glsl_parse_state struct that should be set
479 * when this extension is enabled.
481 * See note in _mesa_glsl_extension::supported_flag about "pointer
484 bool _mesa_glsl_parse_state::* enable_flag
;
487 * Flag in the _mesa_glsl_parse_state struct that should be set
488 * when the shader requests "warn" behavior for this extension.
490 * See note in _mesa_glsl_extension::supported_flag about "pointer
493 bool _mesa_glsl_parse_state::* warn_flag
;
496 bool compatible_with_state(const _mesa_glsl_parse_state
*state
) const;
497 void set_flags(_mesa_glsl_parse_state
*state
, ext_behavior behavior
) const;
500 #define EXT(NAME, GL, ES, SUPPORTED_FLAG) \
501 { "GL_" #NAME, GL, ES, &gl_extensions::SUPPORTED_FLAG, \
502 &_mesa_glsl_parse_state::NAME##_enable, \
503 &_mesa_glsl_parse_state::NAME##_warn }
506 * Table of extensions that can be enabled/disabled within a shader,
507 * and the conditions under which they are supported.
509 static const _mesa_glsl_extension _mesa_glsl_supported_extensions
[] = {
510 /* API availability */
511 /* name GL ES supported flag */
513 /* ARB extensions go here, sorted alphabetically.
515 EXT(ARB_arrays_of_arrays
, true, false, ARB_arrays_of_arrays
),
516 EXT(ARB_compute_shader
, true, false, ARB_compute_shader
),
517 EXT(ARB_conservative_depth
, true, false, ARB_conservative_depth
),
518 EXT(ARB_derivative_control
, true, false, ARB_derivative_control
),
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_explicit_uniform_location
, true, false, ARB_explicit_uniform_location
),
523 EXT(ARB_fragment_coord_conventions
, true, false, ARB_fragment_coord_conventions
),
524 EXT(ARB_fragment_layer_viewport
, true, false, ARB_fragment_layer_viewport
),
525 EXT(ARB_gpu_shader5
, true, false, ARB_gpu_shader5
),
526 EXT(ARB_sample_shading
, true, false, ARB_sample_shading
),
527 EXT(ARB_separate_shader_objects
, true, false, dummy_true
),
528 EXT(ARB_shader_atomic_counters
, true, false, ARB_shader_atomic_counters
),
529 EXT(ARB_shader_bit_encoding
, true, false, ARB_shader_bit_encoding
),
530 EXT(ARB_shader_image_load_store
, true, false, ARB_shader_image_load_store
),
531 EXT(ARB_shader_stencil_export
, true, false, ARB_shader_stencil_export
),
532 EXT(ARB_shader_texture_lod
, true, false, ARB_shader_texture_lod
),
533 EXT(ARB_shading_language_420pack
, true, false, ARB_shading_language_420pack
),
534 EXT(ARB_shading_language_packing
, true, false, ARB_shading_language_packing
),
535 EXT(ARB_texture_cube_map_array
, true, false, ARB_texture_cube_map_array
),
536 EXT(ARB_texture_gather
, true, false, ARB_texture_gather
),
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_texture_rectangle
, true, false, dummy_true
),
541 EXT(ARB_uniform_buffer_object
, true, false, ARB_uniform_buffer_object
),
542 EXT(ARB_viewport_array
, true, false, ARB_viewport_array
),
544 /* KHR extensions go here, sorted alphabetically.
547 /* OES extensions go here, sorted alphabetically.
549 EXT(OES_EGL_image_external
, false, true, OES_EGL_image_external
),
550 EXT(OES_standard_derivatives
, false, true, OES_standard_derivatives
),
551 EXT(OES_texture_3D
, false, true, EXT_texture3D
),
553 /* All other extensions go here, sorted alphabetically.
555 EXT(AMD_conservative_depth
, true, false, ARB_conservative_depth
),
556 EXT(AMD_shader_stencil_export
, true, false, ARB_shader_stencil_export
),
557 EXT(AMD_shader_trinary_minmax
, true, false, dummy_true
),
558 EXT(AMD_vertex_shader_layer
, true, false, AMD_vertex_shader_layer
),
559 EXT(AMD_vertex_shader_viewport_index
, true, false, AMD_vertex_shader_viewport_index
),
560 EXT(EXT_separate_shader_objects
, false, true, dummy_true
),
561 EXT(EXT_shader_integer_mix
, true, true, EXT_shader_integer_mix
),
562 EXT(EXT_texture_array
, true, false, EXT_texture_array
),
569 * Determine whether a given extension is compatible with the target,
570 * API, and extension information in the current parser state.
572 bool _mesa_glsl_extension::compatible_with_state(const _mesa_glsl_parse_state
*
575 /* Check that this extension matches whether we are compiling
576 * for desktop GL or GLES.
578 if (state
->es_shader
) {
579 if (!this->avail_in_ES
) return false;
581 if (!this->avail_in_GL
) return false;
584 /* Check that this extension is supported by the OpenGL
587 * Note: the ->* operator indexes into state->extensions by the
588 * offset this->supported_flag. See
589 * _mesa_glsl_extension::supported_flag for more info.
591 return state
->extensions
->*(this->supported_flag
);
595 * Set the appropriate flags in the parser state to establish the
596 * given behavior for this extension.
598 void _mesa_glsl_extension::set_flags(_mesa_glsl_parse_state
*state
,
599 ext_behavior behavior
) const
601 /* Note: the ->* operator indexes into state by the
602 * offsets this->enable_flag and this->warn_flag. See
603 * _mesa_glsl_extension::supported_flag for more info.
605 state
->*(this->enable_flag
) = (behavior
!= extension_disable
);
606 state
->*(this->warn_flag
) = (behavior
== extension_warn
);
610 * Find an extension by name in _mesa_glsl_supported_extensions. If
611 * the name is not found, return NULL.
613 static const _mesa_glsl_extension
*find_extension(const char *name
)
615 for (unsigned i
= 0; i
< Elements(_mesa_glsl_supported_extensions
); ++i
) {
616 if (strcmp(name
, _mesa_glsl_supported_extensions
[i
].name
) == 0) {
617 return &_mesa_glsl_supported_extensions
[i
];
625 _mesa_glsl_process_extension(const char *name
, YYLTYPE
*name_locp
,
626 const char *behavior_string
, YYLTYPE
*behavior_locp
,
627 _mesa_glsl_parse_state
*state
)
629 ext_behavior behavior
;
630 if (strcmp(behavior_string
, "warn") == 0) {
631 behavior
= extension_warn
;
632 } else if (strcmp(behavior_string
, "require") == 0) {
633 behavior
= extension_require
;
634 } else if (strcmp(behavior_string
, "enable") == 0) {
635 behavior
= extension_enable
;
636 } else if (strcmp(behavior_string
, "disable") == 0) {
637 behavior
= extension_disable
;
639 _mesa_glsl_error(behavior_locp
, state
,
640 "unknown extension behavior `%s'",
645 if (strcmp(name
, "all") == 0) {
646 if ((behavior
== extension_enable
) || (behavior
== extension_require
)) {
647 _mesa_glsl_error(name_locp
, state
, "cannot %s all extensions",
648 (behavior
== extension_enable
)
649 ? "enable" : "require");
653 i
< Elements(_mesa_glsl_supported_extensions
); ++i
) {
654 const _mesa_glsl_extension
*extension
655 = &_mesa_glsl_supported_extensions
[i
];
656 if (extension
->compatible_with_state(state
)) {
657 _mesa_glsl_supported_extensions
[i
].set_flags(state
, behavior
);
662 const _mesa_glsl_extension
*extension
= find_extension(name
);
663 if (extension
&& extension
->compatible_with_state(state
)) {
664 extension
->set_flags(state
, behavior
);
666 static const char fmt
[] = "extension `%s' unsupported in %s shader";
668 if (behavior
== extension_require
) {
669 _mesa_glsl_error(name_locp
, state
, fmt
,
670 name
, _mesa_shader_stage_to_string(state
->stage
));
673 _mesa_glsl_warning(name_locp
, state
, fmt
,
674 name
, _mesa_shader_stage_to_string(state
->stage
));
684 * Recurses through <type> and <expr> if <expr> is an aggregate initializer
685 * and sets <expr>'s <constructor_type> field to <type>. Gives later functions
686 * (process_array_constructor, et al) sufficient information to do type
689 * Operates on assignments involving an aggregate initializer. E.g.,
691 * vec4 pos = {1.0, -1.0, 0.0, 1.0};
693 * or more ridiculously,
706 * {1.0, 2.0, 3.0, 4.0}, // a[0].v[0]
707 * {5.0, 6.0, 7.0, 8.0} // a[0].v[1]
712 * {1.0, 2.0, 3.0, 4.0}, // a[1].v[0]
713 * {5.0, 6.0, 7.0, 8.0} // a[1].v[1]
719 * {1.0, 2.0, 3.0, 4.0}, // b.v[0]
720 * {5.0, 6.0, 7.0, 8.0} // b.v[1]
726 * This pass is necessary because the right-hand side of <type> e = { ... }
727 * doesn't contain sufficient information to determine if the types match.
730 _mesa_ast_set_aggregate_type(const glsl_type
*type
,
731 ast_expression
*expr
)
733 ast_aggregate_initializer
*ai
= (ast_aggregate_initializer
*)expr
;
734 ai
->constructor_type
= type
;
736 /* If the aggregate is an array, recursively set its elements' types. */
737 if (type
->is_array()) {
738 /* Each array element has the type type->element_type().
740 * E.g., if <type> if struct S[2] we want to set each element's type to
743 for (exec_node
*expr_node
= ai
->expressions
.head
;
744 !expr_node
->is_tail_sentinel();
745 expr_node
= expr_node
->next
) {
746 ast_expression
*expr
= exec_node_data(ast_expression
, expr_node
,
749 if (expr
->oper
== ast_aggregate
)
750 _mesa_ast_set_aggregate_type(type
->element_type(), expr
);
753 /* If the aggregate is a struct, recursively set its fields' types. */
754 } else if (type
->is_record()) {
755 exec_node
*expr_node
= ai
->expressions
.head
;
757 /* Iterate through the struct's fields. */
758 for (unsigned i
= 0; !expr_node
->is_tail_sentinel() && i
< type
->length
;
759 i
++, expr_node
= expr_node
->next
) {
760 ast_expression
*expr
= exec_node_data(ast_expression
, expr_node
,
763 if (expr
->oper
== ast_aggregate
) {
764 _mesa_ast_set_aggregate_type(type
->fields
.structure
[i
].type
, expr
);
767 /* If the aggregate is a matrix, set its columns' types. */
768 } else if (type
->is_matrix()) {
769 for (exec_node
*expr_node
= ai
->expressions
.head
;
770 !expr_node
->is_tail_sentinel();
771 expr_node
= expr_node
->next
) {
772 ast_expression
*expr
= exec_node_data(ast_expression
, expr_node
,
775 if (expr
->oper
== ast_aggregate
)
776 _mesa_ast_set_aggregate_type(type
->column_type(), expr
);
783 _mesa_ast_type_qualifier_print(const struct ast_type_qualifier
*q
)
785 if (q
->flags
.q
.constant
)
788 if (q
->flags
.q
.invariant
)
789 printf("invariant ");
791 if (q
->flags
.q
.attribute
)
792 printf("attribute ");
794 if (q
->flags
.q
.varying
)
797 if (q
->flags
.q
.in
&& q
->flags
.q
.out
)
807 if (q
->flags
.q
.centroid
)
809 if (q
->flags
.q
.sample
)
811 if (q
->flags
.q
.uniform
)
813 if (q
->flags
.q
.smooth
)
817 if (q
->flags
.q
.noperspective
)
818 printf("noperspective ");
823 ast_node::print(void) const
825 printf("unhandled node ");
829 ast_node::ast_node(void)
831 this->location
.source
= 0;
832 this->location
.first_line
= 0;
833 this->location
.first_column
= 0;
834 this->location
.last_line
= 0;
835 this->location
.last_column
= 0;
840 ast_opt_array_dimensions_print(const ast_array_specifier
*array_specifier
)
843 array_specifier
->print();
848 ast_compound_statement::print(void) const
852 foreach_list_typed(ast_node
, ast
, link
, &this->statements
) {
860 ast_compound_statement::ast_compound_statement(int new_scope
,
861 ast_node
*statements
)
863 this->new_scope
= new_scope
;
865 if (statements
!= NULL
) {
866 this->statements
.push_degenerate_list_at_head(&statements
->link
);
872 ast_expression::print(void) const
886 subexpressions
[0]->print();
887 printf("%s ", operator_string(oper
));
888 subexpressions
[1]->print();
891 case ast_field_selection
:
892 subexpressions
[0]->print();
893 printf(". %s ", primary_expression
.identifier
);
902 printf("%s ", operator_string(oper
));
903 subexpressions
[0]->print();
908 subexpressions
[0]->print();
909 printf("%s ", operator_string(oper
));
912 case ast_conditional
:
913 subexpressions
[0]->print();
915 subexpressions
[1]->print();
917 subexpressions
[2]->print();
920 case ast_array_index
:
921 subexpressions
[0]->print();
923 subexpressions
[1]->print();
927 case ast_function_call
: {
928 subexpressions
[0]->print();
931 foreach_list_typed (ast_node
, ast
, link
, &this->expressions
) {
932 if (&ast
->link
!= this->expressions
.get_head())
943 printf("%s ", primary_expression
.identifier
);
946 case ast_int_constant
:
947 printf("%d ", primary_expression
.int_constant
);
950 case ast_uint_constant
:
951 printf("%u ", primary_expression
.uint_constant
);
954 case ast_float_constant
:
955 printf("%f ", primary_expression
.float_constant
);
958 case ast_bool_constant
:
960 primary_expression
.bool_constant
966 foreach_list_typed (ast_node
, ast
, link
, & this->expressions
) {
967 if (&ast
->link
!= this->expressions
.get_head())
976 case ast_aggregate
: {
978 foreach_list_typed (ast_node
, ast
, link
, & this->expressions
) {
979 if (&ast
->link
!= this->expressions
.get_head())
994 ast_expression::ast_expression(int oper
,
997 ast_expression
*ex2
) :
1000 this->oper
= ast_operators(oper
);
1001 this->subexpressions
[0] = ex0
;
1002 this->subexpressions
[1] = ex1
;
1003 this->subexpressions
[2] = ex2
;
1004 this->non_lvalue_description
= NULL
;
1009 ast_expression_statement::print(void) const
1012 expression
->print();
1018 ast_expression_statement::ast_expression_statement(ast_expression
*ex
) :
1026 ast_function::print(void) const
1028 return_type
->print();
1029 printf(" %s (", identifier
);
1031 foreach_list_typed(ast_node
, ast
, link
, & this->parameters
) {
1039 ast_function::ast_function(void)
1040 : return_type(NULL
), identifier(NULL
), is_definition(false),
1048 ast_fully_specified_type::print(void) const
1050 _mesa_ast_type_qualifier_print(& qualifier
);
1056 ast_parameter_declarator::print(void) const
1060 printf("%s ", identifier
);
1061 ast_opt_array_dimensions_print(array_specifier
);
1066 ast_function_definition::print(void) const
1074 ast_declaration::print(void) const
1076 printf("%s ", identifier
);
1077 ast_opt_array_dimensions_print(array_specifier
);
1081 initializer
->print();
1086 ast_declaration::ast_declaration(const char *identifier
,
1087 ast_array_specifier
*array_specifier
,
1088 ast_expression
*initializer
)
1090 this->identifier
= identifier
;
1091 this->array_specifier
= array_specifier
;
1092 this->initializer
= initializer
;
1097 ast_declarator_list::print(void) const
1099 assert(type
|| invariant
);
1104 printf("invariant ");
1108 foreach_list_typed (ast_node
, ast
, link
, & this->declarations
) {
1109 if (&ast
->link
!= this->declarations
.get_head())
1119 ast_declarator_list::ast_declarator_list(ast_fully_specified_type
*type
)
1122 this->invariant
= false;
1123 this->precise
= false;
1127 ast_jump_statement::print(void) const
1131 printf("continue; ");
1138 if (opt_return_value
)
1139 opt_return_value
->print();
1144 printf("discard; ");
1150 ast_jump_statement::ast_jump_statement(int mode
, ast_expression
*return_value
)
1151 : opt_return_value(NULL
)
1153 this->mode
= ast_jump_modes(mode
);
1155 if (mode
== ast_return
)
1156 opt_return_value
= return_value
;
1161 ast_selection_statement::print(void) const
1167 then_statement
->print();
1169 if (else_statement
) {
1171 else_statement
->print();
1177 ast_selection_statement::ast_selection_statement(ast_expression
*condition
,
1178 ast_node
*then_statement
,
1179 ast_node
*else_statement
)
1181 this->condition
= condition
;
1182 this->then_statement
= then_statement
;
1183 this->else_statement
= else_statement
;
1188 ast_switch_statement::print(void) const
1190 printf("switch ( ");
1191 test_expression
->print();
1198 ast_switch_statement::ast_switch_statement(ast_expression
*test_expression
,
1201 this->test_expression
= test_expression
;
1207 ast_switch_body::print(void) const
1210 if (stmts
!= NULL
) {
1217 ast_switch_body::ast_switch_body(ast_case_statement_list
*stmts
)
1219 this->stmts
= stmts
;
1223 void ast_case_label::print(void) const
1225 if (test_value
!= NULL
) {
1227 test_value
->print();
1230 printf("default: ");
1235 ast_case_label::ast_case_label(ast_expression
*test_value
)
1237 this->test_value
= test_value
;
1241 void ast_case_label_list::print(void) const
1243 foreach_list_typed(ast_node
, ast
, link
, & this->labels
) {
1250 ast_case_label_list::ast_case_label_list(void)
1255 void ast_case_statement::print(void) const
1258 foreach_list_typed(ast_node
, ast
, link
, & this->stmts
) {
1265 ast_case_statement::ast_case_statement(ast_case_label_list
*labels
)
1267 this->labels
= labels
;
1271 void ast_case_statement_list::print(void) const
1273 foreach_list_typed(ast_node
, ast
, link
, & this->cases
) {
1279 ast_case_statement_list::ast_case_statement_list(void)
1285 ast_iteration_statement::print(void) const
1291 init_statement
->print();
1298 if (rest_expression
)
1299 rest_expression
->print();
1325 ast_iteration_statement::ast_iteration_statement(int mode
,
1327 ast_node
*condition
,
1328 ast_expression
*rest_expression
,
1331 this->mode
= ast_iteration_modes(mode
);
1332 this->init_statement
= init
;
1333 this->condition
= condition
;
1334 this->rest_expression
= rest_expression
;
1340 ast_struct_specifier::print(void) const
1342 printf("struct %s { ", name
);
1343 foreach_list_typed(ast_node
, ast
, link
, &this->declarations
) {
1350 ast_struct_specifier::ast_struct_specifier(const char *identifier
,
1351 ast_declarator_list
*declarator_list
)
1353 if (identifier
== NULL
) {
1354 static mtx_t mutex
= _MTX_INITIALIZER_NP
;
1355 static unsigned anon_count
= 1;
1359 count
= anon_count
++;
1362 identifier
= ralloc_asprintf(this, "#anon_struct_%04x", count
);
1365 this->declarations
.push_degenerate_list_at_head(&declarator_list
->link
);
1366 is_declaration
= true;
1370 set_shader_inout_layout(struct gl_shader
*shader
,
1371 struct _mesa_glsl_parse_state
*state
)
1373 if (shader
->Stage
!= MESA_SHADER_GEOMETRY
) {
1374 /* Should have been prevented by the parser. */
1375 assert(!state
->in_qualifier
->flags
.i
);
1376 assert(!state
->out_qualifier
->flags
.i
);
1379 if (shader
->Stage
!= MESA_SHADER_COMPUTE
) {
1380 /* Should have been prevented by the parser. */
1381 assert(!state
->cs_input_local_size_specified
);
1384 if (shader
->Stage
!= MESA_SHADER_FRAGMENT
) {
1385 /* Should have been prevented by the parser. */
1386 assert(!state
->fs_uses_gl_fragcoord
);
1387 assert(!state
->fs_redeclares_gl_fragcoord
);
1388 assert(!state
->fs_pixel_center_integer
);
1389 assert(!state
->fs_origin_upper_left
);
1392 switch (shader
->Stage
) {
1393 case MESA_SHADER_GEOMETRY
:
1394 shader
->Geom
.VerticesOut
= 0;
1395 if (state
->out_qualifier
->flags
.q
.max_vertices
)
1396 shader
->Geom
.VerticesOut
= state
->out_qualifier
->max_vertices
;
1398 if (state
->gs_input_prim_type_specified
) {
1399 shader
->Geom
.InputType
= state
->in_qualifier
->prim_type
;
1401 shader
->Geom
.InputType
= PRIM_UNKNOWN
;
1404 if (state
->out_qualifier
->flags
.q
.prim_type
) {
1405 shader
->Geom
.OutputType
= state
->out_qualifier
->prim_type
;
1407 shader
->Geom
.OutputType
= PRIM_UNKNOWN
;
1410 shader
->Geom
.Invocations
= 0;
1411 if (state
->in_qualifier
->flags
.q
.invocations
)
1412 shader
->Geom
.Invocations
= state
->in_qualifier
->invocations
;
1415 case MESA_SHADER_COMPUTE
:
1416 if (state
->cs_input_local_size_specified
) {
1417 for (int i
= 0; i
< 3; i
++)
1418 shader
->Comp
.LocalSize
[i
] = state
->cs_input_local_size
[i
];
1420 for (int i
= 0; i
< 3; i
++)
1421 shader
->Comp
.LocalSize
[i
] = 0;
1425 case MESA_SHADER_FRAGMENT
:
1426 shader
->redeclares_gl_fragcoord
= state
->fs_redeclares_gl_fragcoord
;
1427 shader
->uses_gl_fragcoord
= state
->fs_uses_gl_fragcoord
;
1428 shader
->pixel_center_integer
= state
->fs_pixel_center_integer
;
1429 shader
->origin_upper_left
= state
->fs_origin_upper_left
;
1430 shader
->ARB_fragment_coord_conventions_enable
=
1431 state
->ARB_fragment_coord_conventions_enable
;
1435 /* Nothing to do. */
1443 _mesa_glsl_compile_shader(struct gl_context
*ctx
, struct gl_shader
*shader
,
1444 bool dump_ast
, bool dump_hir
)
1446 struct _mesa_glsl_parse_state
*state
=
1447 new(shader
) _mesa_glsl_parse_state(ctx
, shader
->Stage
, shader
);
1448 const char *source
= shader
->Source
;
1450 if (ctx
->Const
.GenerateTemporaryNames
)
1451 (void) p_atomic_cmpxchg(&ir_variable::temporaries_allocate_names
,
1454 state
->error
= glcpp_preprocess(state
, &source
, &state
->info_log
,
1455 &ctx
->Extensions
, ctx
);
1457 if (!state
->error
) {
1458 _mesa_glsl_lexer_ctor(state
, source
);
1459 _mesa_glsl_parse(state
);
1460 _mesa_glsl_lexer_dtor(state
);
1464 foreach_list_typed(ast_node
, ast
, link
, &state
->translation_unit
) {
1470 ralloc_free(shader
->ir
);
1471 shader
->ir
= new(shader
) exec_list
;
1472 if (!state
->error
&& !state
->translation_unit
.is_empty())
1473 _mesa_ast_to_hir(shader
->ir
, state
);
1475 if (!state
->error
) {
1476 validate_ir_tree(shader
->ir
);
1478 /* Print out the unoptimized IR. */
1480 _mesa_print_ir(stdout
, shader
->ir
, state
);
1485 if (!state
->error
&& !shader
->ir
->is_empty()) {
1486 struct gl_shader_compiler_options
*options
=
1487 &ctx
->Const
.ShaderCompilerOptions
[shader
->Stage
];
1489 /* Do some optimization at compile time to reduce shader IR size
1490 * and reduce later work if the same shader is linked multiple times
1492 while (do_common_optimization(shader
->ir
, false, false, options
,
1493 ctx
->Const
.NativeIntegers
))
1496 validate_ir_tree(shader
->ir
);
1498 enum ir_variable_mode other
;
1499 switch (shader
->Stage
) {
1500 case MESA_SHADER_VERTEX
:
1501 other
= ir_var_shader_in
;
1503 case MESA_SHADER_FRAGMENT
:
1504 other
= ir_var_shader_out
;
1507 /* Something invalid to ensure optimize_dead_builtin_uniforms
1508 * doesn't remove anything other than uniforms or constants.
1510 other
= ir_var_mode_count
;
1514 optimize_dead_builtin_variables(shader
->ir
, other
);
1516 validate_ir_tree(shader
->ir
);
1519 if (shader
->InfoLog
)
1520 ralloc_free(shader
->InfoLog
);
1522 shader
->symbols
= new(shader
->ir
) glsl_symbol_table
;
1523 shader
->CompileStatus
= !state
->error
;
1524 shader
->InfoLog
= state
->info_log
;
1525 shader
->Version
= state
->language_version
;
1526 shader
->IsES
= state
->es_shader
;
1527 shader
->uses_builtin_functions
= state
->uses_builtin_functions
;
1530 set_shader_inout_layout(shader
, state
);
1532 /* Retain any live IR, but trash the rest. */
1533 reparent_ir(shader
->ir
, shader
->ir
);
1535 /* Destroy the symbol table. Create a new symbol table that contains only
1536 * the variables and functions that still exist in the IR. The symbol
1537 * table will be used later during linking.
1539 * There must NOT be any freed objects still referenced by the symbol
1540 * table. That could cause the linker to dereference freed memory.
1542 * We don't have to worry about types or interface-types here because those
1543 * are fly-weights that are looked up by glsl_type.
1545 foreach_in_list (ir_instruction
, ir
, shader
->ir
) {
1546 switch (ir
->ir_type
) {
1547 case ir_type_function
:
1548 shader
->symbols
->add_function((ir_function
*) ir
);
1550 case ir_type_variable
: {
1551 ir_variable
*const var
= (ir_variable
*) ir
;
1553 if (var
->data
.mode
!= ir_var_temporary
)
1554 shader
->symbols
->add_variable(var
);
1562 delete state
->symbols
;
1568 * Do the set of common optimizations passes
1570 * \param ir List of instructions to be optimized
1571 * \param linked Is the shader linked? This enables
1572 * optimizations passes that remove code at
1573 * global scope and could cause linking to
1575 * \param uniform_locations_assigned Have locations already been assigned for
1576 * uniforms? This prevents the declarations
1577 * of unused uniforms from being removed.
1578 * The setting of this flag only matters if
1579 * \c linked is \c true.
1580 * \param max_unroll_iterations Maximum number of loop iterations to be
1581 * unrolled. Setting to 0 disables loop
1583 * \param options The driver's preferred shader options.
1586 do_common_optimization(exec_list
*ir
, bool linked
,
1587 bool uniform_locations_assigned
,
1588 const struct gl_shader_compiler_options
*options
,
1589 bool native_integers
)
1591 GLboolean progress
= GL_FALSE
;
1593 progress
= lower_instructions(ir
, SUB_TO_ADD_NEG
) || progress
;
1596 progress
= do_function_inlining(ir
) || progress
;
1597 progress
= do_dead_functions(ir
) || progress
;
1598 progress
= do_structure_splitting(ir
) || progress
;
1600 progress
= do_if_simplification(ir
) || progress
;
1601 progress
= opt_flatten_nested_if_blocks(ir
) || progress
;
1602 progress
= do_copy_propagation(ir
) || progress
;
1603 progress
= do_copy_propagation_elements(ir
) || progress
;
1605 if (options
->OptimizeForAOS
&& !linked
)
1606 progress
= opt_flip_matrices(ir
) || progress
;
1608 if (linked
&& options
->OptimizeForAOS
) {
1609 progress
= do_vectorize(ir
) || progress
;
1613 progress
= do_dead_code(ir
, uniform_locations_assigned
) || progress
;
1615 progress
= do_dead_code_unlinked(ir
) || progress
;
1616 progress
= do_dead_code_local(ir
) || progress
;
1617 progress
= do_tree_grafting(ir
) || progress
;
1618 progress
= do_constant_propagation(ir
) || progress
;
1620 progress
= do_constant_variable(ir
) || progress
;
1622 progress
= do_constant_variable_unlinked(ir
) || progress
;
1623 progress
= do_constant_folding(ir
) || progress
;
1624 progress
= do_minmax_prune(ir
) || progress
;
1625 progress
= do_cse(ir
) || progress
;
1626 progress
= do_rebalance_tree(ir
) || progress
;
1627 progress
= do_algebraic(ir
, native_integers
, options
) || progress
;
1628 progress
= do_lower_jumps(ir
) || progress
;
1629 progress
= do_vec_index_to_swizzle(ir
) || progress
;
1630 progress
= lower_vector_insert(ir
, false) || progress
;
1631 progress
= do_swizzle_swizzle(ir
) || progress
;
1632 progress
= do_noop_swizzle(ir
) || progress
;
1634 progress
= optimize_split_arrays(ir
, linked
) || progress
;
1635 progress
= optimize_redundant_jumps(ir
) || progress
;
1637 loop_state
*ls
= analyze_loop_variables(ir
);
1638 if (ls
->loop_found
) {
1639 progress
= set_loop_controls(ir
, ls
) || progress
;
1640 progress
= unroll_loops(ir
, ls
, options
) || progress
;
1650 * To be called at GL teardown time, this frees compiler datastructures.
1652 * After calling this, any previously compiled shaders and shader
1653 * programs would be invalid. So this should happen at approximately
1657 _mesa_destroy_shader_compiler(void)
1659 _mesa_destroy_shader_compiler_caches();
1661 _mesa_glsl_release_types();
1665 * Releases compiler caches to trade off performance for memory.
1667 * Intended to be used with glReleaseShaderCompiler().
1670 _mesa_destroy_shader_compiler_caches(void)
1672 _mesa_glsl_release_builtin_functions();