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"
34 #include "util/ralloc.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 const unsigned known_desktop_glsl_versions
[] =
53 { 110, 120, 130, 140, 150, 330, 400, 410, 420, 430, 440 };
56 _mesa_glsl_parse_state::_mesa_glsl_parse_state(struct gl_context
*_ctx
,
57 gl_shader_stage stage
,
59 : ctx(_ctx
), cs_input_local_size_specified(false), cs_input_local_size(),
62 assert(stage
< MESA_SHADER_STAGES
);
66 this->translation_unit
.make_empty();
67 this->symbols
= new(mem_ctx
) glsl_symbol_table
;
69 this->info_log
= ralloc_strdup(mem_ctx
, "");
71 this->loop_nesting_ast
= NULL
;
73 this->struct_specifier_depth
= 0;
75 this->uses_builtin_functions
= false;
77 /* Set default language version and extensions */
78 this->language_version
= ctx
->Const
.ForceGLSLVersion
?
79 ctx
->Const
.ForceGLSLVersion
: 110;
80 this->es_shader
= false;
81 this->ARB_texture_rectangle_enable
= true;
83 /* OpenGL ES 2.0 has different defaults from desktop GL. */
84 if (ctx
->API
== API_OPENGLES2
) {
85 this->language_version
= 100;
86 this->es_shader
= true;
87 this->ARB_texture_rectangle_enable
= false;
90 this->extensions
= &ctx
->Extensions
;
92 this->Const
.MaxLights
= ctx
->Const
.MaxLights
;
93 this->Const
.MaxClipPlanes
= ctx
->Const
.MaxClipPlanes
;
94 this->Const
.MaxTextureUnits
= ctx
->Const
.MaxTextureUnits
;
95 this->Const
.MaxTextureCoords
= ctx
->Const
.MaxTextureCoordUnits
;
96 this->Const
.MaxVertexAttribs
= ctx
->Const
.Program
[MESA_SHADER_VERTEX
].MaxAttribs
;
97 this->Const
.MaxVertexUniformComponents
= ctx
->Const
.Program
[MESA_SHADER_VERTEX
].MaxUniformComponents
;
98 this->Const
.MaxVertexTextureImageUnits
= ctx
->Const
.Program
[MESA_SHADER_VERTEX
].MaxTextureImageUnits
;
99 this->Const
.MaxCombinedTextureImageUnits
= ctx
->Const
.MaxCombinedTextureImageUnits
;
100 this->Const
.MaxTextureImageUnits
= ctx
->Const
.Program
[MESA_SHADER_FRAGMENT
].MaxTextureImageUnits
;
101 this->Const
.MaxFragmentUniformComponents
= ctx
->Const
.Program
[MESA_SHADER_FRAGMENT
].MaxUniformComponents
;
102 this->Const
.MinProgramTexelOffset
= ctx
->Const
.MinProgramTexelOffset
;
103 this->Const
.MaxProgramTexelOffset
= ctx
->Const
.MaxProgramTexelOffset
;
105 this->Const
.MaxDrawBuffers
= ctx
->Const
.MaxDrawBuffers
;
108 this->Const
.MaxVertexOutputComponents
= ctx
->Const
.Program
[MESA_SHADER_VERTEX
].MaxOutputComponents
;
109 this->Const
.MaxGeometryInputComponents
= ctx
->Const
.Program
[MESA_SHADER_GEOMETRY
].MaxInputComponents
;
110 this->Const
.MaxGeometryOutputComponents
= ctx
->Const
.Program
[MESA_SHADER_GEOMETRY
].MaxOutputComponents
;
111 this->Const
.MaxFragmentInputComponents
= ctx
->Const
.Program
[MESA_SHADER_FRAGMENT
].MaxInputComponents
;
112 this->Const
.MaxGeometryTextureImageUnits
= ctx
->Const
.Program
[MESA_SHADER_GEOMETRY
].MaxTextureImageUnits
;
113 this->Const
.MaxGeometryOutputVertices
= ctx
->Const
.MaxGeometryOutputVertices
;
114 this->Const
.MaxGeometryTotalOutputComponents
= ctx
->Const
.MaxGeometryTotalOutputComponents
;
115 this->Const
.MaxGeometryUniformComponents
= ctx
->Const
.Program
[MESA_SHADER_GEOMETRY
].MaxUniformComponents
;
117 this->Const
.MaxVertexAtomicCounters
= ctx
->Const
.Program
[MESA_SHADER_VERTEX
].MaxAtomicCounters
;
118 this->Const
.MaxGeometryAtomicCounters
= ctx
->Const
.Program
[MESA_SHADER_GEOMETRY
].MaxAtomicCounters
;
119 this->Const
.MaxFragmentAtomicCounters
= ctx
->Const
.Program
[MESA_SHADER_FRAGMENT
].MaxAtomicCounters
;
120 this->Const
.MaxCombinedAtomicCounters
= ctx
->Const
.MaxCombinedAtomicCounters
;
121 this->Const
.MaxAtomicBufferBindings
= ctx
->Const
.MaxAtomicBufferBindings
;
123 /* Compute shader constants */
124 for (unsigned i
= 0; i
< Elements(this->Const
.MaxComputeWorkGroupCount
); i
++)
125 this->Const
.MaxComputeWorkGroupCount
[i
] = ctx
->Const
.MaxComputeWorkGroupCount
[i
];
126 for (unsigned i
= 0; i
< Elements(this->Const
.MaxComputeWorkGroupSize
); i
++)
127 this->Const
.MaxComputeWorkGroupSize
[i
] = ctx
->Const
.MaxComputeWorkGroupSize
[i
];
129 this->Const
.MaxImageUnits
= ctx
->Const
.MaxImageUnits
;
130 this->Const
.MaxCombinedImageUnitsAndFragmentOutputs
= ctx
->Const
.MaxCombinedImageUnitsAndFragmentOutputs
;
131 this->Const
.MaxImageSamples
= ctx
->Const
.MaxImageSamples
;
132 this->Const
.MaxVertexImageUniforms
= ctx
->Const
.Program
[MESA_SHADER_VERTEX
].MaxImageUniforms
;
133 this->Const
.MaxGeometryImageUniforms
= ctx
->Const
.Program
[MESA_SHADER_GEOMETRY
].MaxImageUniforms
;
134 this->Const
.MaxFragmentImageUniforms
= ctx
->Const
.Program
[MESA_SHADER_FRAGMENT
].MaxImageUniforms
;
135 this->Const
.MaxCombinedImageUniforms
= ctx
->Const
.MaxCombinedImageUniforms
;
137 this->current_function
= NULL
;
138 this->toplevel_ir
= NULL
;
139 this->found_return
= false;
140 this->all_invariant
= false;
141 this->user_structures
= NULL
;
142 this->num_user_structures
= 0;
144 /* Populate the list of supported GLSL versions */
145 /* FINISHME: Once the OpenGL 3.0 'forward compatible' context or
146 * the OpenGL 3.2 Core context is supported, this logic will need
147 * change. Older versions of GLSL are no longer supported
148 * outside the compatibility contexts of 3.x.
150 this->num_supported_versions
= 0;
151 if (_mesa_is_desktop_gl(ctx
)) {
152 for (unsigned i
= 0; i
< ARRAY_SIZE(known_desktop_glsl_versions
); i
++) {
153 if (known_desktop_glsl_versions
[i
] <= ctx
->Const
.GLSLVersion
) {
154 this->supported_versions
[this->num_supported_versions
].ver
155 = known_desktop_glsl_versions
[i
];
156 this->supported_versions
[this->num_supported_versions
].es
= false;
157 this->num_supported_versions
++;
161 if (ctx
->API
== API_OPENGLES2
|| ctx
->Extensions
.ARB_ES2_compatibility
) {
162 this->supported_versions
[this->num_supported_versions
].ver
= 100;
163 this->supported_versions
[this->num_supported_versions
].es
= true;
164 this->num_supported_versions
++;
166 if (_mesa_is_gles3(ctx
) || ctx
->Extensions
.ARB_ES3_compatibility
) {
167 this->supported_versions
[this->num_supported_versions
].ver
= 300;
168 this->supported_versions
[this->num_supported_versions
].es
= true;
169 this->num_supported_versions
++;
171 assert(this->num_supported_versions
172 <= ARRAY_SIZE(this->supported_versions
));
174 /* Create a string for use in error messages to tell the user which GLSL
175 * versions are supported.
177 char *supported
= ralloc_strdup(this, "");
178 for (unsigned i
= 0; i
< this->num_supported_versions
; i
++) {
179 unsigned ver
= this->supported_versions
[i
].ver
;
180 const char *const prefix
= (i
== 0)
182 : ((i
== this->num_supported_versions
- 1) ? ", and " : ", ");
183 const char *const suffix
= (this->supported_versions
[i
].es
) ? " ES" : "";
185 ralloc_asprintf_append(& supported
, "%s%u.%02u%s",
187 ver
/ 100, ver
% 100,
191 this->supported_version_string
= supported
;
193 if (ctx
->Const
.ForceGLSLExtensionsWarn
)
194 _mesa_glsl_process_extension("all", NULL
, "warn", NULL
, this);
196 this->default_uniform_qualifier
= new(this) ast_type_qualifier();
197 this->default_uniform_qualifier
->flags
.q
.shared
= 1;
198 this->default_uniform_qualifier
->flags
.q
.column_major
= 1;
200 this->fs_uses_gl_fragcoord
= false;
201 this->fs_redeclares_gl_fragcoord
= false;
202 this->fs_origin_upper_left
= false;
203 this->fs_pixel_center_integer
= false;
204 this->fs_redeclares_gl_fragcoord_with_no_layout_qualifiers
= false;
206 this->gs_input_prim_type_specified
= false;
207 this->gs_input_size
= 0;
208 this->in_qualifier
= new(this) ast_type_qualifier();
209 this->out_qualifier
= new(this) ast_type_qualifier();
210 this->early_fragment_tests
= false;
211 memset(this->atomic_counter_offsets
, 0,
212 sizeof(this->atomic_counter_offsets
));
213 this->allow_extension_directive_midshader
=
214 ctx
->Const
.AllowGLSLExtensionDirectiveMidShader
;
218 * Determine whether the current GLSL version is sufficiently high to support
219 * a certain feature, and generate an error message if it isn't.
221 * \param required_glsl_version and \c required_glsl_es_version are
222 * interpreted as they are in _mesa_glsl_parse_state::is_version().
224 * \param locp is the parser location where the error should be reported.
226 * \param fmt (and additional arguments) constitute a printf-style error
227 * message to report if the version check fails. Information about the
228 * current and required GLSL versions will be appended. So, for example, if
229 * the GLSL version being compiled is 1.20, and check_version(130, 300, locp,
230 * "foo unsupported") is called, the error message will be "foo unsupported in
231 * GLSL 1.20 (GLSL 1.30 or GLSL 3.00 ES required)".
234 _mesa_glsl_parse_state::check_version(unsigned required_glsl_version
,
235 unsigned required_glsl_es_version
,
236 YYLTYPE
*locp
, const char *fmt
, ...)
238 if (this->is_version(required_glsl_version
, required_glsl_es_version
))
243 char *problem
= ralloc_vasprintf(this, fmt
, args
);
245 const char *glsl_version_string
246 = glsl_compute_version_string(this, false, required_glsl_version
);
247 const char *glsl_es_version_string
248 = glsl_compute_version_string(this, true, required_glsl_es_version
);
249 const char *requirement_string
= "";
250 if (required_glsl_version
&& required_glsl_es_version
) {
251 requirement_string
= ralloc_asprintf(this, " (%s or %s required)",
253 glsl_es_version_string
);
254 } else if (required_glsl_version
) {
255 requirement_string
= ralloc_asprintf(this, " (%s required)",
256 glsl_version_string
);
257 } else if (required_glsl_es_version
) {
258 requirement_string
= ralloc_asprintf(this, " (%s required)",
259 glsl_es_version_string
);
261 _mesa_glsl_error(locp
, this, "%s in %s%s",
262 problem
, this->get_version_string(),
269 * Process a GLSL #version directive.
271 * \param version is the integer that follows the #version token.
273 * \param ident is a string identifier that follows the integer, if any is
274 * present. Otherwise NULL.
277 _mesa_glsl_parse_state::process_version_directive(YYLTYPE
*locp
, int version
,
280 bool es_token_present
= false;
282 if (strcmp(ident
, "es") == 0) {
283 es_token_present
= true;
284 } else if (version
>= 150) {
285 if (strcmp(ident
, "core") == 0) {
286 /* Accept the token. There's no need to record that this is
287 * a core profile shader since that's the only profile we support.
289 } else if (strcmp(ident
, "compatibility") == 0) {
290 _mesa_glsl_error(locp
, this,
291 "the compatibility profile is not supported");
293 _mesa_glsl_error(locp
, this,
294 "\"%s\" is not a valid shading language profile; "
295 "if present, it must be \"core\"", ident
);
298 _mesa_glsl_error(locp
, this,
299 "illegal text following version number");
303 this->es_shader
= es_token_present
;
304 if (version
== 100) {
305 if (es_token_present
) {
306 _mesa_glsl_error(locp
, this,
307 "GLSL 1.00 ES should be selected using "
310 this->es_shader
= true;
314 if (this->es_shader
) {
315 this->ARB_texture_rectangle_enable
= false;
318 this->language_version
= version
;
320 bool supported
= false;
321 for (unsigned i
= 0; i
< this->num_supported_versions
; i
++) {
322 if (this->supported_versions
[i
].ver
== (unsigned) version
323 && this->supported_versions
[i
].es
== this->es_shader
) {
330 _mesa_glsl_error(locp
, this, "%s is not supported. "
331 "Supported versions are: %s",
332 this->get_version_string(),
333 this->supported_version_string
);
335 /* On exit, the language_version must be set to a valid value.
336 * Later calls to _mesa_glsl_initialize_types will misbehave if
337 * the version is invalid.
339 switch (this->ctx
->API
) {
340 case API_OPENGL_COMPAT
:
341 case API_OPENGL_CORE
:
342 this->language_version
= this->ctx
->Const
.GLSLVersion
;
346 assert(!"Should not get here.");
350 this->language_version
= 100;
358 * Translate a gl_shader_stage to a short shader stage name for debug
359 * printouts and error messages.
362 _mesa_shader_stage_to_string(unsigned stage
)
365 case MESA_SHADER_VERTEX
: return "vertex";
366 case MESA_SHADER_FRAGMENT
: return "fragment";
367 case MESA_SHADER_GEOMETRY
: return "geometry";
370 assert(!"Should not get here.");
374 /* This helper function will append the given message to the shader's
375 info log and report it via GL_ARB_debug_output. Per that extension,
376 'type' is one of the enum values classifying the message, and
377 'id' is the implementation-defined ID of the given message. */
379 _mesa_glsl_msg(const YYLTYPE
*locp
, _mesa_glsl_parse_state
*state
,
380 GLenum type
, const char *fmt
, va_list ap
)
382 bool error
= (type
== MESA_DEBUG_TYPE_ERROR
);
385 assert(state
->info_log
!= NULL
);
387 /* Get the offset that the new message will be written to. */
388 int msg_offset
= strlen(state
->info_log
);
390 ralloc_asprintf_append(&state
->info_log
, "%u:%u(%u): %s: ",
394 error
? "error" : "warning");
395 ralloc_vasprintf_append(&state
->info_log
, fmt
, ap
);
397 const char *const msg
= &state
->info_log
[msg_offset
];
398 struct gl_context
*ctx
= state
->ctx
;
400 /* Report the error via GL_ARB_debug_output. */
401 _mesa_shader_debug(ctx
, type
, &msg_id
, msg
, strlen(msg
));
403 ralloc_strcat(&state
->info_log
, "\n");
407 _mesa_glsl_error(YYLTYPE
*locp
, _mesa_glsl_parse_state
*state
,
408 const char *fmt
, ...)
415 _mesa_glsl_msg(locp
, state
, MESA_DEBUG_TYPE_ERROR
, fmt
, ap
);
421 _mesa_glsl_warning(const YYLTYPE
*locp
, _mesa_glsl_parse_state
*state
,
422 const char *fmt
, ...)
427 _mesa_glsl_msg(locp
, state
, MESA_DEBUG_TYPE_OTHER
, fmt
, ap
);
433 * Enum representing the possible behaviors that can be specified in
434 * an #extension directive.
444 * Element type for _mesa_glsl_supported_extensions
446 struct _mesa_glsl_extension
{
448 * Name of the extension when referred to in a GLSL extension
453 /** True if this extension is available to desktop GL shaders */
456 /** True if this extension is available to GLES shaders */
460 * Flag in the gl_extensions struct indicating whether this
461 * extension is supported by the driver, or
462 * &gl_extensions::dummy_true if supported by all drivers.
464 * Note: the type (GLboolean gl_extensions::*) is a "pointer to
465 * member" type, the type-safe alternative to the "offsetof" macro.
468 * - foo bar::* p declares p to be an "offset" to a field of type
469 * foo that exists within struct bar
470 * - &bar::baz computes the "offset" of field baz within struct bar
471 * - x.*p accesses the field of x that exists at "offset" p
472 * - x->*p is equivalent to (*x).*p
474 const GLboolean
gl_extensions::* supported_flag
;
477 * Flag in the _mesa_glsl_parse_state struct that should be set
478 * when this extension is enabled.
480 * See note in _mesa_glsl_extension::supported_flag about "pointer
483 bool _mesa_glsl_parse_state::* enable_flag
;
486 * Flag in the _mesa_glsl_parse_state struct that should be set
487 * when the shader requests "warn" behavior for this extension.
489 * See note in _mesa_glsl_extension::supported_flag about "pointer
492 bool _mesa_glsl_parse_state::* warn_flag
;
495 bool compatible_with_state(const _mesa_glsl_parse_state
*state
) const;
496 void set_flags(_mesa_glsl_parse_state
*state
, ext_behavior behavior
) const;
499 #define EXT(NAME, GL, ES, SUPPORTED_FLAG) \
500 { "GL_" #NAME, GL, ES, &gl_extensions::SUPPORTED_FLAG, \
501 &_mesa_glsl_parse_state::NAME##_enable, \
502 &_mesa_glsl_parse_state::NAME##_warn }
505 * Table of extensions that can be enabled/disabled within a shader,
506 * and the conditions under which they are supported.
508 static const _mesa_glsl_extension _mesa_glsl_supported_extensions
[] = {
509 /* API availability */
510 /* name GL ES supported flag */
512 /* ARB extensions go here, sorted alphabetically.
514 EXT(ARB_arrays_of_arrays
, true, false, ARB_arrays_of_arrays
),
515 EXT(ARB_compute_shader
, true, false, ARB_compute_shader
),
516 EXT(ARB_conservative_depth
, true, false, ARB_conservative_depth
),
517 EXT(ARB_draw_buffers
, true, false, dummy_true
),
518 EXT(ARB_draw_instanced
, true, false, ARB_draw_instanced
),
519 EXT(ARB_explicit_attrib_location
, true, false, ARB_explicit_attrib_location
),
520 EXT(ARB_explicit_uniform_location
, true, false, ARB_explicit_uniform_location
),
521 EXT(ARB_fragment_coord_conventions
, true, false, ARB_fragment_coord_conventions
),
522 EXT(ARB_fragment_layer_viewport
, true, false, ARB_fragment_layer_viewport
),
523 EXT(ARB_gpu_shader5
, true, false, ARB_gpu_shader5
),
524 EXT(ARB_sample_shading
, true, false, ARB_sample_shading
),
525 EXT(ARB_separate_shader_objects
, true, false, dummy_true
),
526 EXT(ARB_shader_atomic_counters
, true, false, ARB_shader_atomic_counters
),
527 EXT(ARB_shader_bit_encoding
, true, false, ARB_shader_bit_encoding
),
528 EXT(ARB_shader_image_load_store
, true, false, ARB_shader_image_load_store
),
529 EXT(ARB_shader_stencil_export
, true, false, ARB_shader_stencil_export
),
530 EXT(ARB_shader_texture_lod
, true, false, ARB_shader_texture_lod
),
531 EXT(ARB_shading_language_420pack
, true, false, ARB_shading_language_420pack
),
532 EXT(ARB_shading_language_packing
, true, false, ARB_shading_language_packing
),
533 EXT(ARB_texture_cube_map_array
, true, false, ARB_texture_cube_map_array
),
534 EXT(ARB_texture_gather
, true, false, ARB_texture_gather
),
535 EXT(ARB_texture_multisample
, true, false, ARB_texture_multisample
),
536 EXT(ARB_texture_query_levels
, true, false, ARB_texture_query_levels
),
537 EXT(ARB_texture_query_lod
, true, false, ARB_texture_query_lod
),
538 EXT(ARB_texture_rectangle
, true, false, dummy_true
),
539 EXT(ARB_uniform_buffer_object
, true, false, ARB_uniform_buffer_object
),
540 EXT(ARB_viewport_array
, true, false, ARB_viewport_array
),
542 /* KHR extensions go here, sorted alphabetically.
545 /* OES extensions go here, sorted alphabetically.
547 EXT(OES_EGL_image_external
, false, true, OES_EGL_image_external
),
548 EXT(OES_standard_derivatives
, false, true, OES_standard_derivatives
),
549 EXT(OES_texture_3D
, false, true, EXT_texture3D
),
551 /* All other extensions go here, sorted alphabetically.
553 EXT(AMD_conservative_depth
, true, false, ARB_conservative_depth
),
554 EXT(AMD_shader_stencil_export
, true, false, ARB_shader_stencil_export
),
555 EXT(AMD_shader_trinary_minmax
, true, false, dummy_true
),
556 EXT(AMD_vertex_shader_layer
, true, false, AMD_vertex_shader_layer
),
557 EXT(AMD_vertex_shader_viewport_index
, true, false, AMD_vertex_shader_viewport_index
),
558 EXT(EXT_separate_shader_objects
, false, true, dummy_true
),
559 EXT(EXT_shader_integer_mix
, true, true, EXT_shader_integer_mix
),
560 EXT(EXT_texture_array
, true, false, EXT_texture_array
),
567 * Determine whether a given extension is compatible with the target,
568 * API, and extension information in the current parser state.
570 bool _mesa_glsl_extension::compatible_with_state(const _mesa_glsl_parse_state
*
573 /* Check that this extension matches whether we are compiling
574 * for desktop GL or GLES.
576 if (state
->es_shader
) {
577 if (!this->avail_in_ES
) return false;
579 if (!this->avail_in_GL
) return false;
582 /* Check that this extension is supported by the OpenGL
585 * Note: the ->* operator indexes into state->extensions by the
586 * offset this->supported_flag. See
587 * _mesa_glsl_extension::supported_flag for more info.
589 return state
->extensions
->*(this->supported_flag
);
593 * Set the appropriate flags in the parser state to establish the
594 * given behavior for this extension.
596 void _mesa_glsl_extension::set_flags(_mesa_glsl_parse_state
*state
,
597 ext_behavior behavior
) const
599 /* Note: the ->* operator indexes into state by the
600 * offsets this->enable_flag and this->warn_flag. See
601 * _mesa_glsl_extension::supported_flag for more info.
603 state
->*(this->enable_flag
) = (behavior
!= extension_disable
);
604 state
->*(this->warn_flag
) = (behavior
== extension_warn
);
608 * Find an extension by name in _mesa_glsl_supported_extensions. If
609 * the name is not found, return NULL.
611 static const _mesa_glsl_extension
*find_extension(const char *name
)
613 for (unsigned i
= 0; i
< Elements(_mesa_glsl_supported_extensions
); ++i
) {
614 if (strcmp(name
, _mesa_glsl_supported_extensions
[i
].name
) == 0) {
615 return &_mesa_glsl_supported_extensions
[i
];
623 _mesa_glsl_process_extension(const char *name
, YYLTYPE
*name_locp
,
624 const char *behavior_string
, YYLTYPE
*behavior_locp
,
625 _mesa_glsl_parse_state
*state
)
627 ext_behavior behavior
;
628 if (strcmp(behavior_string
, "warn") == 0) {
629 behavior
= extension_warn
;
630 } else if (strcmp(behavior_string
, "require") == 0) {
631 behavior
= extension_require
;
632 } else if (strcmp(behavior_string
, "enable") == 0) {
633 behavior
= extension_enable
;
634 } else if (strcmp(behavior_string
, "disable") == 0) {
635 behavior
= extension_disable
;
637 _mesa_glsl_error(behavior_locp
, state
,
638 "unknown extension behavior `%s'",
643 if (strcmp(name
, "all") == 0) {
644 if ((behavior
== extension_enable
) || (behavior
== extension_require
)) {
645 _mesa_glsl_error(name_locp
, state
, "cannot %s all extensions",
646 (behavior
== extension_enable
)
647 ? "enable" : "require");
651 i
< Elements(_mesa_glsl_supported_extensions
); ++i
) {
652 const _mesa_glsl_extension
*extension
653 = &_mesa_glsl_supported_extensions
[i
];
654 if (extension
->compatible_with_state(state
)) {
655 _mesa_glsl_supported_extensions
[i
].set_flags(state
, behavior
);
660 const _mesa_glsl_extension
*extension
= find_extension(name
);
661 if (extension
&& extension
->compatible_with_state(state
)) {
662 extension
->set_flags(state
, behavior
);
664 static const char fmt
[] = "extension `%s' unsupported in %s shader";
666 if (behavior
== extension_require
) {
667 _mesa_glsl_error(name_locp
, state
, fmt
,
668 name
, _mesa_shader_stage_to_string(state
->stage
));
671 _mesa_glsl_warning(name_locp
, state
, fmt
,
672 name
, _mesa_shader_stage_to_string(state
->stage
));
682 * Recurses through <type> and <expr> if <expr> is an aggregate initializer
683 * and sets <expr>'s <constructor_type> field to <type>. Gives later functions
684 * (process_array_constructor, et al) sufficient information to do type
687 * Operates on assignments involving an aggregate initializer. E.g.,
689 * vec4 pos = {1.0, -1.0, 0.0, 1.0};
691 * or more ridiculously,
704 * {1.0, 2.0, 3.0, 4.0}, // a[0].v[0]
705 * {5.0, 6.0, 7.0, 8.0} // a[0].v[1]
710 * {1.0, 2.0, 3.0, 4.0}, // a[1].v[0]
711 * {5.0, 6.0, 7.0, 8.0} // a[1].v[1]
717 * {1.0, 2.0, 3.0, 4.0}, // b.v[0]
718 * {5.0, 6.0, 7.0, 8.0} // b.v[1]
724 * This pass is necessary because the right-hand side of <type> e = { ... }
725 * doesn't contain sufficient information to determine if the types match.
728 _mesa_ast_set_aggregate_type(const glsl_type
*type
,
729 ast_expression
*expr
)
731 ast_aggregate_initializer
*ai
= (ast_aggregate_initializer
*)expr
;
732 ai
->constructor_type
= type
;
734 /* If the aggregate is an array, recursively set its elements' types. */
735 if (type
->is_array()) {
736 /* Each array element has the type type->element_type().
738 * E.g., if <type> if struct S[2] we want to set each element's type to
741 for (exec_node
*expr_node
= ai
->expressions
.head
;
742 !expr_node
->is_tail_sentinel();
743 expr_node
= expr_node
->next
) {
744 ast_expression
*expr
= exec_node_data(ast_expression
, expr_node
,
747 if (expr
->oper
== ast_aggregate
)
748 _mesa_ast_set_aggregate_type(type
->element_type(), expr
);
751 /* If the aggregate is a struct, recursively set its fields' types. */
752 } else if (type
->is_record()) {
753 exec_node
*expr_node
= ai
->expressions
.head
;
755 /* Iterate through the struct's fields. */
756 for (unsigned i
= 0; !expr_node
->is_tail_sentinel() && i
< type
->length
;
757 i
++, expr_node
= expr_node
->next
) {
758 ast_expression
*expr
= exec_node_data(ast_expression
, expr_node
,
761 if (expr
->oper
== ast_aggregate
) {
762 _mesa_ast_set_aggregate_type(type
->fields
.structure
[i
].type
, expr
);
765 /* If the aggregate is a matrix, set its columns' types. */
766 } else if (type
->is_matrix()) {
767 for (exec_node
*expr_node
= ai
->expressions
.head
;
768 !expr_node
->is_tail_sentinel();
769 expr_node
= expr_node
->next
) {
770 ast_expression
*expr
= exec_node_data(ast_expression
, expr_node
,
773 if (expr
->oper
== ast_aggregate
)
774 _mesa_ast_set_aggregate_type(type
->column_type(), expr
);
781 _mesa_ast_type_qualifier_print(const struct ast_type_qualifier
*q
)
783 if (q
->flags
.q
.constant
)
786 if (q
->flags
.q
.invariant
)
787 printf("invariant ");
789 if (q
->flags
.q
.attribute
)
790 printf("attribute ");
792 if (q
->flags
.q
.varying
)
795 if (q
->flags
.q
.in
&& q
->flags
.q
.out
)
805 if (q
->flags
.q
.centroid
)
807 if (q
->flags
.q
.sample
)
809 if (q
->flags
.q
.uniform
)
811 if (q
->flags
.q
.smooth
)
815 if (q
->flags
.q
.noperspective
)
816 printf("noperspective ");
821 ast_node::print(void) const
823 printf("unhandled node ");
827 ast_node::ast_node(void)
829 this->location
.source
= 0;
830 this->location
.first_line
= 0;
831 this->location
.first_column
= 0;
832 this->location
.last_line
= 0;
833 this->location
.last_column
= 0;
838 ast_opt_array_dimensions_print(const ast_array_specifier
*array_specifier
)
841 array_specifier
->print();
846 ast_compound_statement::print(void) const
850 foreach_list_typed(ast_node
, ast
, link
, &this->statements
) {
858 ast_compound_statement::ast_compound_statement(int new_scope
,
859 ast_node
*statements
)
861 this->new_scope
= new_scope
;
863 if (statements
!= NULL
) {
864 this->statements
.push_degenerate_list_at_head(&statements
->link
);
870 ast_expression::print(void) const
884 subexpressions
[0]->print();
885 printf("%s ", operator_string(oper
));
886 subexpressions
[1]->print();
889 case ast_field_selection
:
890 subexpressions
[0]->print();
891 printf(". %s ", primary_expression
.identifier
);
900 printf("%s ", operator_string(oper
));
901 subexpressions
[0]->print();
906 subexpressions
[0]->print();
907 printf("%s ", operator_string(oper
));
910 case ast_conditional
:
911 subexpressions
[0]->print();
913 subexpressions
[1]->print();
915 subexpressions
[2]->print();
918 case ast_array_index
:
919 subexpressions
[0]->print();
921 subexpressions
[1]->print();
925 case ast_function_call
: {
926 subexpressions
[0]->print();
929 foreach_list_typed (ast_node
, ast
, link
, &this->expressions
) {
930 if (&ast
->link
!= this->expressions
.get_head())
941 printf("%s ", primary_expression
.identifier
);
944 case ast_int_constant
:
945 printf("%d ", primary_expression
.int_constant
);
948 case ast_uint_constant
:
949 printf("%u ", primary_expression
.uint_constant
);
952 case ast_float_constant
:
953 printf("%f ", primary_expression
.float_constant
);
956 case ast_bool_constant
:
958 primary_expression
.bool_constant
964 foreach_list_typed (ast_node
, ast
, link
, & this->expressions
) {
965 if (&ast
->link
!= this->expressions
.get_head())
974 case ast_aggregate
: {
976 foreach_list_typed (ast_node
, ast
, link
, & this->expressions
) {
977 if (&ast
->link
!= this->expressions
.get_head())
992 ast_expression::ast_expression(int oper
,
995 ast_expression
*ex2
) :
998 this->oper
= ast_operators(oper
);
999 this->subexpressions
[0] = ex0
;
1000 this->subexpressions
[1] = ex1
;
1001 this->subexpressions
[2] = ex2
;
1002 this->non_lvalue_description
= NULL
;
1007 ast_expression_statement::print(void) const
1010 expression
->print();
1016 ast_expression_statement::ast_expression_statement(ast_expression
*ex
) :
1024 ast_function::print(void) const
1026 return_type
->print();
1027 printf(" %s (", identifier
);
1029 foreach_list_typed(ast_node
, ast
, link
, & this->parameters
) {
1037 ast_function::ast_function(void)
1038 : return_type(NULL
), identifier(NULL
), is_definition(false),
1046 ast_fully_specified_type::print(void) const
1048 _mesa_ast_type_qualifier_print(& qualifier
);
1054 ast_parameter_declarator::print(void) const
1058 printf("%s ", identifier
);
1059 ast_opt_array_dimensions_print(array_specifier
);
1064 ast_function_definition::print(void) const
1072 ast_declaration::print(void) const
1074 printf("%s ", identifier
);
1075 ast_opt_array_dimensions_print(array_specifier
);
1079 initializer
->print();
1084 ast_declaration::ast_declaration(const char *identifier
,
1085 ast_array_specifier
*array_specifier
,
1086 ast_expression
*initializer
)
1088 this->identifier
= identifier
;
1089 this->array_specifier
= array_specifier
;
1090 this->initializer
= initializer
;
1095 ast_declarator_list::print(void) const
1097 assert(type
|| invariant
);
1102 printf("invariant ");
1106 foreach_list_typed (ast_node
, ast
, link
, & this->declarations
) {
1107 if (&ast
->link
!= this->declarations
.get_head())
1117 ast_declarator_list::ast_declarator_list(ast_fully_specified_type
*type
)
1120 this->invariant
= false;
1121 this->precise
= false;
1125 ast_jump_statement::print(void) const
1129 printf("continue; ");
1136 if (opt_return_value
)
1137 opt_return_value
->print();
1142 printf("discard; ");
1148 ast_jump_statement::ast_jump_statement(int mode
, ast_expression
*return_value
)
1149 : opt_return_value(NULL
)
1151 this->mode
= ast_jump_modes(mode
);
1153 if (mode
== ast_return
)
1154 opt_return_value
= return_value
;
1159 ast_selection_statement::print(void) const
1165 then_statement
->print();
1167 if (else_statement
) {
1169 else_statement
->print();
1175 ast_selection_statement::ast_selection_statement(ast_expression
*condition
,
1176 ast_node
*then_statement
,
1177 ast_node
*else_statement
)
1179 this->condition
= condition
;
1180 this->then_statement
= then_statement
;
1181 this->else_statement
= else_statement
;
1186 ast_switch_statement::print(void) const
1188 printf("switch ( ");
1189 test_expression
->print();
1196 ast_switch_statement::ast_switch_statement(ast_expression
*test_expression
,
1199 this->test_expression
= test_expression
;
1205 ast_switch_body::print(void) const
1208 if (stmts
!= NULL
) {
1215 ast_switch_body::ast_switch_body(ast_case_statement_list
*stmts
)
1217 this->stmts
= stmts
;
1221 void ast_case_label::print(void) const
1223 if (test_value
!= NULL
) {
1225 test_value
->print();
1228 printf("default: ");
1233 ast_case_label::ast_case_label(ast_expression
*test_value
)
1235 this->test_value
= test_value
;
1239 void ast_case_label_list::print(void) const
1241 foreach_list_typed(ast_node
, ast
, link
, & this->labels
) {
1248 ast_case_label_list::ast_case_label_list(void)
1253 void ast_case_statement::print(void) const
1256 foreach_list_typed(ast_node
, ast
, link
, & this->stmts
) {
1263 ast_case_statement::ast_case_statement(ast_case_label_list
*labels
)
1265 this->labels
= labels
;
1269 void ast_case_statement_list::print(void) const
1271 foreach_list_typed(ast_node
, ast
, link
, & this->cases
) {
1277 ast_case_statement_list::ast_case_statement_list(void)
1283 ast_iteration_statement::print(void) const
1289 init_statement
->print();
1296 if (rest_expression
)
1297 rest_expression
->print();
1323 ast_iteration_statement::ast_iteration_statement(int mode
,
1325 ast_node
*condition
,
1326 ast_expression
*rest_expression
,
1329 this->mode
= ast_iteration_modes(mode
);
1330 this->init_statement
= init
;
1331 this->condition
= condition
;
1332 this->rest_expression
= rest_expression
;
1338 ast_struct_specifier::print(void) const
1340 printf("struct %s { ", name
);
1341 foreach_list_typed(ast_node
, ast
, link
, &this->declarations
) {
1348 ast_struct_specifier::ast_struct_specifier(const char *identifier
,
1349 ast_declarator_list
*declarator_list
)
1351 if (identifier
== NULL
) {
1352 static unsigned anon_count
= 1;
1353 identifier
= ralloc_asprintf(this, "#anon_struct_%04x", anon_count
);
1357 this->declarations
.push_degenerate_list_at_head(&declarator_list
->link
);
1358 is_declaration
= true;
1362 set_shader_inout_layout(struct gl_shader
*shader
,
1363 struct _mesa_glsl_parse_state
*state
)
1365 if (shader
->Stage
!= MESA_SHADER_GEOMETRY
) {
1366 /* Should have been prevented by the parser. */
1367 assert(!state
->in_qualifier
->flags
.i
);
1368 assert(!state
->out_qualifier
->flags
.i
);
1371 if (shader
->Stage
!= MESA_SHADER_COMPUTE
) {
1372 /* Should have been prevented by the parser. */
1373 assert(!state
->cs_input_local_size_specified
);
1376 if (shader
->Stage
!= MESA_SHADER_FRAGMENT
) {
1377 /* Should have been prevented by the parser. */
1378 assert(!state
->fs_uses_gl_fragcoord
);
1379 assert(!state
->fs_redeclares_gl_fragcoord
);
1380 assert(!state
->fs_pixel_center_integer
);
1381 assert(!state
->fs_origin_upper_left
);
1384 switch (shader
->Stage
) {
1385 case MESA_SHADER_GEOMETRY
:
1386 shader
->Geom
.VerticesOut
= 0;
1387 if (state
->out_qualifier
->flags
.q
.max_vertices
)
1388 shader
->Geom
.VerticesOut
= state
->out_qualifier
->max_vertices
;
1390 if (state
->gs_input_prim_type_specified
) {
1391 shader
->Geom
.InputType
= state
->in_qualifier
->prim_type
;
1393 shader
->Geom
.InputType
= PRIM_UNKNOWN
;
1396 if (state
->out_qualifier
->flags
.q
.prim_type
) {
1397 shader
->Geom
.OutputType
= state
->out_qualifier
->prim_type
;
1399 shader
->Geom
.OutputType
= PRIM_UNKNOWN
;
1402 shader
->Geom
.Invocations
= 0;
1403 if (state
->in_qualifier
->flags
.q
.invocations
)
1404 shader
->Geom
.Invocations
= state
->in_qualifier
->invocations
;
1407 case MESA_SHADER_COMPUTE
:
1408 if (state
->cs_input_local_size_specified
) {
1409 for (int i
= 0; i
< 3; i
++)
1410 shader
->Comp
.LocalSize
[i
] = state
->cs_input_local_size
[i
];
1412 for (int i
= 0; i
< 3; i
++)
1413 shader
->Comp
.LocalSize
[i
] = 0;
1417 case MESA_SHADER_FRAGMENT
:
1418 shader
->redeclares_gl_fragcoord
= state
->fs_redeclares_gl_fragcoord
;
1419 shader
->uses_gl_fragcoord
= state
->fs_uses_gl_fragcoord
;
1420 shader
->pixel_center_integer
= state
->fs_pixel_center_integer
;
1421 shader
->origin_upper_left
= state
->fs_origin_upper_left
;
1422 shader
->ARB_fragment_coord_conventions_enable
=
1423 state
->ARB_fragment_coord_conventions_enable
;
1427 /* Nothing to do. */
1435 _mesa_glsl_compile_shader(struct gl_context
*ctx
, struct gl_shader
*shader
,
1436 bool dump_ast
, bool dump_hir
)
1438 struct _mesa_glsl_parse_state
*state
=
1439 new(shader
) _mesa_glsl_parse_state(ctx
, shader
->Stage
, shader
);
1440 const char *source
= shader
->Source
;
1442 state
->error
= glcpp_preprocess(state
, &source
, &state
->info_log
,
1443 &ctx
->Extensions
, ctx
);
1445 if (!state
->error
) {
1446 _mesa_glsl_lexer_ctor(state
, source
);
1447 _mesa_glsl_parse(state
);
1448 _mesa_glsl_lexer_dtor(state
);
1452 foreach_list_typed(ast_node
, ast
, link
, &state
->translation_unit
) {
1458 ralloc_free(shader
->ir
);
1459 shader
->ir
= new(shader
) exec_list
;
1460 if (!state
->error
&& !state
->translation_unit
.is_empty())
1461 _mesa_ast_to_hir(shader
->ir
, state
);
1463 if (!state
->error
) {
1464 validate_ir_tree(shader
->ir
);
1466 /* Print out the unoptimized IR. */
1468 _mesa_print_ir(stdout
, shader
->ir
, state
);
1473 if (!state
->error
&& !shader
->ir
->is_empty()) {
1474 struct gl_shader_compiler_options
*options
=
1475 &ctx
->ShaderCompilerOptions
[shader
->Stage
];
1477 /* Do some optimization at compile time to reduce shader IR size
1478 * and reduce later work if the same shader is linked multiple times
1480 while (do_common_optimization(shader
->ir
, false, false, options
,
1481 ctx
->Const
.NativeIntegers
))
1484 validate_ir_tree(shader
->ir
);
1487 if (shader
->InfoLog
)
1488 ralloc_free(shader
->InfoLog
);
1490 shader
->symbols
= state
->symbols
;
1491 shader
->CompileStatus
= !state
->error
;
1492 shader
->InfoLog
= state
->info_log
;
1493 shader
->Version
= state
->language_version
;
1494 shader
->IsES
= state
->es_shader
;
1495 shader
->uses_builtin_functions
= state
->uses_builtin_functions
;
1498 set_shader_inout_layout(shader
, state
);
1500 /* Retain any live IR, but trash the rest. */
1501 reparent_ir(shader
->ir
, shader
->ir
);
1508 * Do the set of common optimizations passes
1510 * \param ir List of instructions to be optimized
1511 * \param linked Is the shader linked? This enables
1512 * optimizations passes that remove code at
1513 * global scope and could cause linking to
1515 * \param uniform_locations_assigned Have locations already been assigned for
1516 * uniforms? This prevents the declarations
1517 * of unused uniforms from being removed.
1518 * The setting of this flag only matters if
1519 * \c linked is \c true.
1520 * \param max_unroll_iterations Maximum number of loop iterations to be
1521 * unrolled. Setting to 0 disables loop
1523 * \param options The driver's preferred shader options.
1526 do_common_optimization(exec_list
*ir
, bool linked
,
1527 bool uniform_locations_assigned
,
1528 const struct gl_shader_compiler_options
*options
,
1529 bool native_integers
)
1531 GLboolean progress
= GL_FALSE
;
1533 progress
= lower_instructions(ir
, SUB_TO_ADD_NEG
) || progress
;
1536 progress
= do_function_inlining(ir
) || progress
;
1537 progress
= do_dead_functions(ir
) || progress
;
1538 progress
= do_structure_splitting(ir
) || progress
;
1540 progress
= do_if_simplification(ir
) || progress
;
1541 progress
= opt_flatten_nested_if_blocks(ir
) || progress
;
1542 progress
= do_copy_propagation(ir
) || progress
;
1543 progress
= do_copy_propagation_elements(ir
) || progress
;
1545 if (options
->OptimizeForAOS
&& !linked
)
1546 progress
= opt_flip_matrices(ir
) || progress
;
1548 if (linked
&& options
->OptimizeForAOS
) {
1549 progress
= do_vectorize(ir
) || progress
;
1553 progress
= do_dead_code(ir
, uniform_locations_assigned
) || progress
;
1555 progress
= do_dead_code_unlinked(ir
) || progress
;
1556 progress
= do_dead_code_local(ir
) || progress
;
1557 progress
= do_tree_grafting(ir
) || progress
;
1558 progress
= do_constant_propagation(ir
) || progress
;
1560 progress
= do_constant_variable(ir
) || progress
;
1562 progress
= do_constant_variable_unlinked(ir
) || progress
;
1563 progress
= do_constant_folding(ir
) || progress
;
1564 progress
= do_cse(ir
) || progress
;
1565 progress
= do_rebalance_tree(ir
) || progress
;
1566 progress
= do_algebraic(ir
, native_integers
, options
) || progress
;
1567 progress
= do_lower_jumps(ir
) || progress
;
1568 progress
= do_vec_index_to_swizzle(ir
) || progress
;
1569 progress
= lower_vector_insert(ir
, false) || progress
;
1570 progress
= do_swizzle_swizzle(ir
) || progress
;
1571 progress
= do_noop_swizzle(ir
) || progress
;
1573 progress
= optimize_split_arrays(ir
, linked
) || progress
;
1574 progress
= optimize_redundant_jumps(ir
) || progress
;
1576 loop_state
*ls
= analyze_loop_variables(ir
);
1577 if (ls
->loop_found
) {
1578 progress
= set_loop_controls(ir
, ls
) || progress
;
1579 progress
= unroll_loops(ir
, ls
, options
) || progress
;
1589 * To be called at GL teardown time, this frees compiler datastructures.
1591 * After calling this, any previously compiled shaders and shader
1592 * programs would be invalid. So this should happen at approximately
1596 _mesa_destroy_shader_compiler(void)
1598 _mesa_destroy_shader_compiler_caches();
1600 _mesa_glsl_release_types();
1604 * Releases compiler caches to trade off performance for memory.
1606 * Intended to be used with glReleaseShaderCompiler().
1609 _mesa_destroy_shader_compiler_caches(void)
1611 _mesa_glsl_release_builtin_functions();