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, 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->num_uniform_blocks
= 0;
70 this->uniform_block_array_size
= 0;
71 this->uniform_blocks
= NULL
;
73 this->info_log
= ralloc_strdup(mem_ctx
, "");
75 this->loop_nesting_ast
= NULL
;
77 this->struct_specifier_depth
= 0;
79 this->uses_builtin_functions
= false;
81 /* Set default language version and extensions */
82 this->language_version
= ctx
->Const
.ForceGLSLVersion
?
83 ctx
->Const
.ForceGLSLVersion
: 110;
84 this->es_shader
= false;
85 this->ARB_texture_rectangle_enable
= true;
87 /* OpenGL ES 2.0 has different defaults from desktop GL. */
88 if (ctx
->API
== API_OPENGLES2
) {
89 this->language_version
= 100;
90 this->es_shader
= true;
91 this->ARB_texture_rectangle_enable
= false;
94 this->extensions
= &ctx
->Extensions
;
96 this->Const
.MaxLights
= ctx
->Const
.MaxLights
;
97 this->Const
.MaxClipPlanes
= ctx
->Const
.MaxClipPlanes
;
98 this->Const
.MaxTextureUnits
= ctx
->Const
.MaxTextureUnits
;
99 this->Const
.MaxTextureCoords
= ctx
->Const
.MaxTextureCoordUnits
;
100 this->Const
.MaxVertexAttribs
= ctx
->Const
.Program
[MESA_SHADER_VERTEX
].MaxAttribs
;
101 this->Const
.MaxVertexUniformComponents
= ctx
->Const
.Program
[MESA_SHADER_VERTEX
].MaxUniformComponents
;
102 this->Const
.MaxVertexTextureImageUnits
= ctx
->Const
.Program
[MESA_SHADER_VERTEX
].MaxTextureImageUnits
;
103 this->Const
.MaxCombinedTextureImageUnits
= ctx
->Const
.MaxCombinedTextureImageUnits
;
104 this->Const
.MaxTextureImageUnits
= ctx
->Const
.Program
[MESA_SHADER_FRAGMENT
].MaxTextureImageUnits
;
105 this->Const
.MaxFragmentUniformComponents
= ctx
->Const
.Program
[MESA_SHADER_FRAGMENT
].MaxUniformComponents
;
106 this->Const
.MinProgramTexelOffset
= ctx
->Const
.MinProgramTexelOffset
;
107 this->Const
.MaxProgramTexelOffset
= ctx
->Const
.MaxProgramTexelOffset
;
109 this->Const
.MaxDrawBuffers
= ctx
->Const
.MaxDrawBuffers
;
112 this->Const
.MaxVertexOutputComponents
= ctx
->Const
.Program
[MESA_SHADER_VERTEX
].MaxOutputComponents
;
113 this->Const
.MaxGeometryInputComponents
= ctx
->Const
.Program
[MESA_SHADER_GEOMETRY
].MaxInputComponents
;
114 this->Const
.MaxGeometryOutputComponents
= ctx
->Const
.Program
[MESA_SHADER_GEOMETRY
].MaxOutputComponents
;
115 this->Const
.MaxFragmentInputComponents
= ctx
->Const
.Program
[MESA_SHADER_FRAGMENT
].MaxInputComponents
;
116 this->Const
.MaxGeometryTextureImageUnits
= ctx
->Const
.Program
[MESA_SHADER_GEOMETRY
].MaxTextureImageUnits
;
117 this->Const
.MaxGeometryOutputVertices
= ctx
->Const
.MaxGeometryOutputVertices
;
118 this->Const
.MaxGeometryTotalOutputComponents
= ctx
->Const
.MaxGeometryTotalOutputComponents
;
119 this->Const
.MaxGeometryUniformComponents
= ctx
->Const
.Program
[MESA_SHADER_GEOMETRY
].MaxUniformComponents
;
121 this->Const
.MaxVertexAtomicCounters
= ctx
->Const
.Program
[MESA_SHADER_VERTEX
].MaxAtomicCounters
;
122 this->Const
.MaxGeometryAtomicCounters
= ctx
->Const
.Program
[MESA_SHADER_GEOMETRY
].MaxAtomicCounters
;
123 this->Const
.MaxFragmentAtomicCounters
= ctx
->Const
.Program
[MESA_SHADER_FRAGMENT
].MaxAtomicCounters
;
124 this->Const
.MaxCombinedAtomicCounters
= ctx
->Const
.MaxCombinedAtomicCounters
;
125 this->Const
.MaxAtomicBufferBindings
= ctx
->Const
.MaxAtomicBufferBindings
;
127 /* Compute shader constants */
128 for (unsigned i
= 0; i
< Elements(this->Const
.MaxComputeWorkGroupCount
); i
++)
129 this->Const
.MaxComputeWorkGroupCount
[i
] = ctx
->Const
.MaxComputeWorkGroupCount
[i
];
130 for (unsigned i
= 0; i
< Elements(this->Const
.MaxComputeWorkGroupSize
); i
++)
131 this->Const
.MaxComputeWorkGroupSize
[i
] = ctx
->Const
.MaxComputeWorkGroupSize
[i
];
133 this->current_function
= NULL
;
134 this->toplevel_ir
= NULL
;
135 this->found_return
= false;
136 this->all_invariant
= false;
137 this->user_structures
= NULL
;
138 this->num_user_structures
= 0;
140 /* Populate the list of supported GLSL versions */
141 /* FINISHME: Once the OpenGL 3.0 'forward compatible' context or
142 * the OpenGL 3.2 Core context is supported, this logic will need
143 * change. Older versions of GLSL are no longer supported
144 * outside the compatibility contexts of 3.x.
146 this->num_supported_versions
= 0;
147 if (_mesa_is_desktop_gl(ctx
)) {
148 for (unsigned i
= 0; i
< ARRAY_SIZE(known_desktop_glsl_versions
); i
++) {
149 if (known_desktop_glsl_versions
[i
] <= ctx
->Const
.GLSLVersion
) {
150 this->supported_versions
[this->num_supported_versions
].ver
151 = known_desktop_glsl_versions
[i
];
152 this->supported_versions
[this->num_supported_versions
].es
= false;
153 this->num_supported_versions
++;
157 if (ctx
->API
== API_OPENGLES2
|| ctx
->Extensions
.ARB_ES2_compatibility
) {
158 this->supported_versions
[this->num_supported_versions
].ver
= 100;
159 this->supported_versions
[this->num_supported_versions
].es
= true;
160 this->num_supported_versions
++;
162 if (_mesa_is_gles3(ctx
) || ctx
->Extensions
.ARB_ES3_compatibility
) {
163 this->supported_versions
[this->num_supported_versions
].ver
= 300;
164 this->supported_versions
[this->num_supported_versions
].es
= true;
165 this->num_supported_versions
++;
167 assert(this->num_supported_versions
168 <= ARRAY_SIZE(this->supported_versions
));
170 /* Create a string for use in error messages to tell the user which GLSL
171 * versions are supported.
173 char *supported
= ralloc_strdup(this, "");
174 for (unsigned i
= 0; i
< this->num_supported_versions
; i
++) {
175 unsigned ver
= this->supported_versions
[i
].ver
;
176 const char *const prefix
= (i
== 0)
178 : ((i
== this->num_supported_versions
- 1) ? ", and " : ", ");
179 const char *const suffix
= (this->supported_versions
[i
].es
) ? " ES" : "";
181 ralloc_asprintf_append(& supported
, "%s%u.%02u%s",
183 ver
/ 100, ver
% 100,
187 this->supported_version_string
= supported
;
189 if (ctx
->Const
.ForceGLSLExtensionsWarn
)
190 _mesa_glsl_process_extension("all", NULL
, "warn", NULL
, this);
192 this->default_uniform_qualifier
= new(this) ast_type_qualifier();
193 this->default_uniform_qualifier
->flags
.q
.shared
= 1;
194 this->default_uniform_qualifier
->flags
.q
.column_major
= 1;
196 this->gs_input_prim_type_specified
= false;
197 this->gs_input_prim_type
= GL_POINTS
;
198 this->gs_input_size
= 0;
199 this->out_qualifier
= new(this) ast_type_qualifier();
200 memset(this->atomic_counter_offsets
, 0,
201 sizeof(this->atomic_counter_offsets
));
205 * Determine whether the current GLSL version is sufficiently high to support
206 * a certain feature, and generate an error message if it isn't.
208 * \param required_glsl_version and \c required_glsl_es_version are
209 * interpreted as they are in _mesa_glsl_parse_state::is_version().
211 * \param locp is the parser location where the error should be reported.
213 * \param fmt (and additional arguments) constitute a printf-style error
214 * message to report if the version check fails. Information about the
215 * current and required GLSL versions will be appended. So, for example, if
216 * the GLSL version being compiled is 1.20, and check_version(130, 300, locp,
217 * "foo unsupported") is called, the error message will be "foo unsupported in
218 * GLSL 1.20 (GLSL 1.30 or GLSL 3.00 ES required)".
221 _mesa_glsl_parse_state::check_version(unsigned required_glsl_version
,
222 unsigned required_glsl_es_version
,
223 YYLTYPE
*locp
, const char *fmt
, ...)
225 if (this->is_version(required_glsl_version
, required_glsl_es_version
))
230 char *problem
= ralloc_vasprintf(this, fmt
, args
);
232 const char *glsl_version_string
233 = glsl_compute_version_string(this, false, required_glsl_version
);
234 const char *glsl_es_version_string
235 = glsl_compute_version_string(this, true, required_glsl_es_version
);
236 const char *requirement_string
= "";
237 if (required_glsl_version
&& required_glsl_es_version
) {
238 requirement_string
= ralloc_asprintf(this, " (%s or %s required)",
240 glsl_es_version_string
);
241 } else if (required_glsl_version
) {
242 requirement_string
= ralloc_asprintf(this, " (%s required)",
243 glsl_version_string
);
244 } else if (required_glsl_es_version
) {
245 requirement_string
= ralloc_asprintf(this, " (%s required)",
246 glsl_es_version_string
);
248 _mesa_glsl_error(locp
, this, "%s in %s%s",
249 problem
, this->get_version_string(),
256 * Process a GLSL #version directive.
258 * \param version is the integer that follows the #version token.
260 * \param ident is a string identifier that follows the integer, if any is
261 * present. Otherwise NULL.
264 _mesa_glsl_parse_state::process_version_directive(YYLTYPE
*locp
, int version
,
267 bool es_token_present
= false;
269 if (strcmp(ident
, "es") == 0) {
270 es_token_present
= true;
271 } else if (version
>= 150) {
272 if (strcmp(ident
, "core") == 0) {
273 /* Accept the token. There's no need to record that this is
274 * a core profile shader since that's the only profile we support.
276 } else if (strcmp(ident
, "compatibility") == 0) {
277 _mesa_glsl_error(locp
, this,
278 "the compatibility profile is not supported");
280 _mesa_glsl_error(locp
, this,
281 "\"%s\" is not a valid shading language profile; "
282 "if present, it must be \"core\"", ident
);
285 _mesa_glsl_error(locp
, this,
286 "illegal text following version number");
290 this->es_shader
= es_token_present
;
291 if (version
== 100) {
292 if (es_token_present
) {
293 _mesa_glsl_error(locp
, this,
294 "GLSL 1.00 ES should be selected using "
297 this->es_shader
= true;
301 if (this->es_shader
) {
302 this->ARB_texture_rectangle_enable
= false;
305 this->language_version
= version
;
307 bool supported
= false;
308 for (unsigned i
= 0; i
< this->num_supported_versions
; i
++) {
309 if (this->supported_versions
[i
].ver
== (unsigned) version
310 && this->supported_versions
[i
].es
== this->es_shader
) {
317 _mesa_glsl_error(locp
, this, "%s is not supported. "
318 "Supported versions are: %s",
319 this->get_version_string(),
320 this->supported_version_string
);
322 /* On exit, the language_version must be set to a valid value.
323 * Later calls to _mesa_glsl_initialize_types will misbehave if
324 * the version is invalid.
326 switch (this->ctx
->API
) {
327 case API_OPENGL_COMPAT
:
328 case API_OPENGL_CORE
:
329 this->language_version
= this->ctx
->Const
.GLSLVersion
;
333 assert(!"Should not get here.");
337 this->language_version
= 100;
345 * Translate a gl_shader_stage to a short shader stage name for debug
346 * printouts and error messages.
349 _mesa_shader_stage_to_string(unsigned stage
)
352 case MESA_SHADER_VERTEX
: return "vertex";
353 case MESA_SHADER_FRAGMENT
: return "fragment";
354 case MESA_SHADER_GEOMETRY
: return "geometry";
357 assert(!"Should not get here.");
361 /* This helper function will append the given message to the shader's
362 info log and report it via GL_ARB_debug_output. Per that extension,
363 'type' is one of the enum values classifying the message, and
364 'id' is the implementation-defined ID of the given message. */
366 _mesa_glsl_msg(const YYLTYPE
*locp
, _mesa_glsl_parse_state
*state
,
367 GLenum type
, const char *fmt
, va_list ap
)
369 bool error
= (type
== MESA_DEBUG_TYPE_ERROR
);
372 assert(state
->info_log
!= NULL
);
374 /* Get the offset that the new message will be written to. */
375 int msg_offset
= strlen(state
->info_log
);
377 ralloc_asprintf_append(&state
->info_log
, "%u:%u(%u): %s: ",
381 error
? "error" : "warning");
382 ralloc_vasprintf_append(&state
->info_log
, fmt
, ap
);
384 const char *const msg
= &state
->info_log
[msg_offset
];
385 struct gl_context
*ctx
= state
->ctx
;
387 /* Report the error via GL_ARB_debug_output. */
388 _mesa_shader_debug(ctx
, type
, &msg_id
, msg
, strlen(msg
));
390 ralloc_strcat(&state
->info_log
, "\n");
394 _mesa_glsl_error(YYLTYPE
*locp
, _mesa_glsl_parse_state
*state
,
395 const char *fmt
, ...)
402 _mesa_glsl_msg(locp
, state
, MESA_DEBUG_TYPE_ERROR
, fmt
, ap
);
408 _mesa_glsl_warning(const YYLTYPE
*locp
, _mesa_glsl_parse_state
*state
,
409 const char *fmt
, ...)
414 _mesa_glsl_msg(locp
, state
, MESA_DEBUG_TYPE_OTHER
, fmt
, ap
);
420 * Enum representing the possible behaviors that can be specified in
421 * an #extension directive.
431 * Element type for _mesa_glsl_supported_extensions
433 struct _mesa_glsl_extension
{
435 * Name of the extension when referred to in a GLSL extension
440 /** True if this extension is available to desktop GL shaders */
443 /** True if this extension is available to GLES shaders */
447 * Flag in the gl_extensions struct indicating whether this
448 * extension is supported by the driver, or
449 * &gl_extensions::dummy_true if supported by all drivers.
451 * Note: the type (GLboolean gl_extensions::*) is a "pointer to
452 * member" type, the type-safe alternative to the "offsetof" macro.
455 * - foo bar::* p declares p to be an "offset" to a field of type
456 * foo that exists within struct bar
457 * - &bar::baz computes the "offset" of field baz within struct bar
458 * - x.*p accesses the field of x that exists at "offset" p
459 * - x->*p is equivalent to (*x).*p
461 const GLboolean
gl_extensions::* supported_flag
;
464 * Flag in the _mesa_glsl_parse_state struct that should be set
465 * when this extension is enabled.
467 * See note in _mesa_glsl_extension::supported_flag about "pointer
470 bool _mesa_glsl_parse_state::* enable_flag
;
473 * Flag in the _mesa_glsl_parse_state struct that should be set
474 * when the shader requests "warn" behavior for this extension.
476 * See note in _mesa_glsl_extension::supported_flag about "pointer
479 bool _mesa_glsl_parse_state::* warn_flag
;
482 bool compatible_with_state(const _mesa_glsl_parse_state
*state
) const;
483 void set_flags(_mesa_glsl_parse_state
*state
, ext_behavior behavior
) const;
486 #define EXT(NAME, GL, ES, SUPPORTED_FLAG) \
487 { "GL_" #NAME, GL, ES, &gl_extensions::SUPPORTED_FLAG, \
488 &_mesa_glsl_parse_state::NAME##_enable, \
489 &_mesa_glsl_parse_state::NAME##_warn }
492 * Table of extensions that can be enabled/disabled within a shader,
493 * and the conditions under which they are supported.
495 static const _mesa_glsl_extension _mesa_glsl_supported_extensions
[] = {
496 /* API availability */
497 /* name GL ES supported flag */
498 EXT(ARB_arrays_of_arrays
, true, false, ARB_arrays_of_arrays
),
499 EXT(ARB_conservative_depth
, true, false, ARB_conservative_depth
),
500 EXT(ARB_draw_buffers
, true, false, dummy_true
),
501 EXT(ARB_draw_instanced
, true, false, ARB_draw_instanced
),
502 EXT(ARB_explicit_attrib_location
, true, false, ARB_explicit_attrib_location
),
503 EXT(ARB_fragment_coord_conventions
, true, false, ARB_fragment_coord_conventions
),
504 EXT(ARB_texture_rectangle
, true, false, dummy_true
),
505 EXT(EXT_texture_array
, true, false, EXT_texture_array
),
506 EXT(ARB_shader_texture_lod
, true, false, ARB_shader_texture_lod
),
507 EXT(ARB_shader_stencil_export
, true, false, ARB_shader_stencil_export
),
508 EXT(AMD_conservative_depth
, true, false, ARB_conservative_depth
),
509 EXT(AMD_shader_stencil_export
, true, false, ARB_shader_stencil_export
),
510 EXT(OES_texture_3D
, false, true, EXT_texture3D
),
511 EXT(OES_EGL_image_external
, false, true, OES_EGL_image_external
),
512 EXT(ARB_shader_bit_encoding
, true, false, ARB_shader_bit_encoding
),
513 EXT(ARB_uniform_buffer_object
, true, false, ARB_uniform_buffer_object
),
514 EXT(OES_standard_derivatives
, false, true, OES_standard_derivatives
),
515 EXT(ARB_texture_cube_map_array
, true, false, ARB_texture_cube_map_array
),
516 EXT(ARB_shading_language_packing
, true, false, ARB_shading_language_packing
),
517 EXT(ARB_shading_language_420pack
, true, false, ARB_shading_language_420pack
),
518 EXT(ARB_texture_multisample
, true, false, ARB_texture_multisample
),
519 EXT(ARB_texture_query_levels
, true, false, ARB_texture_query_levels
),
520 EXT(ARB_texture_query_lod
, true, false, ARB_texture_query_lod
),
521 EXT(ARB_gpu_shader5
, true, false, ARB_gpu_shader5
),
522 EXT(AMD_vertex_shader_layer
, true, false, AMD_vertex_shader_layer
),
523 EXT(EXT_shader_integer_mix
, true, true, EXT_shader_integer_mix
),
524 EXT(ARB_texture_gather
, true, false, ARB_texture_gather
),
525 EXT(ARB_shader_atomic_counters
, true, false, ARB_shader_atomic_counters
),
526 EXT(ARB_sample_shading
, true, false, ARB_sample_shading
),
527 EXT(AMD_shader_trinary_minmax
, true, false, dummy_true
),
528 EXT(ARB_viewport_array
, true, false, ARB_viewport_array
),
529 EXT(ARB_compute_shader
, true, false, ARB_compute_shader
),
536 * Determine whether a given extension is compatible with the target,
537 * API, and extension information in the current parser state.
539 bool _mesa_glsl_extension::compatible_with_state(const _mesa_glsl_parse_state
*
542 /* Check that this extension matches whether we are compiling
543 * for desktop GL or GLES.
545 if (state
->es_shader
) {
546 if (!this->avail_in_ES
) return false;
548 if (!this->avail_in_GL
) return false;
551 /* Check that this extension is supported by the OpenGL
554 * Note: the ->* operator indexes into state->extensions by the
555 * offset this->supported_flag. See
556 * _mesa_glsl_extension::supported_flag for more info.
558 return state
->extensions
->*(this->supported_flag
);
562 * Set the appropriate flags in the parser state to establish the
563 * given behavior for this extension.
565 void _mesa_glsl_extension::set_flags(_mesa_glsl_parse_state
*state
,
566 ext_behavior behavior
) const
568 /* Note: the ->* operator indexes into state by the
569 * offsets this->enable_flag and this->warn_flag. See
570 * _mesa_glsl_extension::supported_flag for more info.
572 state
->*(this->enable_flag
) = (behavior
!= extension_disable
);
573 state
->*(this->warn_flag
) = (behavior
== extension_warn
);
577 * Find an extension by name in _mesa_glsl_supported_extensions. If
578 * the name is not found, return NULL.
580 static const _mesa_glsl_extension
*find_extension(const char *name
)
582 for (unsigned i
= 0; i
< Elements(_mesa_glsl_supported_extensions
); ++i
) {
583 if (strcmp(name
, _mesa_glsl_supported_extensions
[i
].name
) == 0) {
584 return &_mesa_glsl_supported_extensions
[i
];
592 _mesa_glsl_process_extension(const char *name
, YYLTYPE
*name_locp
,
593 const char *behavior_string
, YYLTYPE
*behavior_locp
,
594 _mesa_glsl_parse_state
*state
)
596 ext_behavior behavior
;
597 if (strcmp(behavior_string
, "warn") == 0) {
598 behavior
= extension_warn
;
599 } else if (strcmp(behavior_string
, "require") == 0) {
600 behavior
= extension_require
;
601 } else if (strcmp(behavior_string
, "enable") == 0) {
602 behavior
= extension_enable
;
603 } else if (strcmp(behavior_string
, "disable") == 0) {
604 behavior
= extension_disable
;
606 _mesa_glsl_error(behavior_locp
, state
,
607 "unknown extension behavior `%s'",
612 if (strcmp(name
, "all") == 0) {
613 if ((behavior
== extension_enable
) || (behavior
== extension_require
)) {
614 _mesa_glsl_error(name_locp
, state
, "cannot %s all extensions",
615 (behavior
== extension_enable
)
616 ? "enable" : "require");
620 i
< Elements(_mesa_glsl_supported_extensions
); ++i
) {
621 const _mesa_glsl_extension
*extension
622 = &_mesa_glsl_supported_extensions
[i
];
623 if (extension
->compatible_with_state(state
)) {
624 _mesa_glsl_supported_extensions
[i
].set_flags(state
, behavior
);
629 const _mesa_glsl_extension
*extension
= find_extension(name
);
630 if (extension
&& extension
->compatible_with_state(state
)) {
631 extension
->set_flags(state
, behavior
);
633 static const char *const fmt
= "extension `%s' unsupported in %s shader";
635 if (behavior
== extension_require
) {
636 _mesa_glsl_error(name_locp
, state
, fmt
,
637 name
, _mesa_shader_stage_to_string(state
->stage
));
640 _mesa_glsl_warning(name_locp
, state
, fmt
,
641 name
, _mesa_shader_stage_to_string(state
->stage
));
651 * Recurses through <type> and <expr> if <expr> is an aggregate initializer
652 * and sets <expr>'s <constructor_type> field to <type>. Gives later functions
653 * (process_array_constructor, et al) sufficient information to do type
656 * Operates on assignments involving an aggregate initializer. E.g.,
658 * vec4 pos = {1.0, -1.0, 0.0, 1.0};
660 * or more ridiculously,
673 * {1.0, 2.0, 3.0, 4.0}, // a[0].v[0]
674 * {5.0, 6.0, 7.0, 8.0} // a[0].v[1]
679 * {1.0, 2.0, 3.0, 4.0}, // a[1].v[0]
680 * {5.0, 6.0, 7.0, 8.0} // a[1].v[1]
686 * {1.0, 2.0, 3.0, 4.0}, // b.v[0]
687 * {5.0, 6.0, 7.0, 8.0} // b.v[1]
693 * This pass is necessary because the right-hand side of <type> e = { ... }
694 * doesn't contain sufficient information to determine if the types match.
697 _mesa_ast_set_aggregate_type(const glsl_type
*type
,
698 ast_expression
*expr
)
700 ast_aggregate_initializer
*ai
= (ast_aggregate_initializer
*)expr
;
701 ai
->constructor_type
= type
;
703 /* If the aggregate is an array, recursively set its elements' types. */
704 if (type
->is_array()) {
705 /* Each array element has the type type->element_type().
707 * E.g., if <type> if struct S[2] we want to set each element's type to
710 for (exec_node
*expr_node
= ai
->expressions
.head
;
711 !expr_node
->is_tail_sentinel();
712 expr_node
= expr_node
->next
) {
713 ast_expression
*expr
= exec_node_data(ast_expression
, expr_node
,
716 if (expr
->oper
== ast_aggregate
)
717 _mesa_ast_set_aggregate_type(type
->element_type(), expr
);
720 /* If the aggregate is a struct, recursively set its fields' types. */
721 } else if (type
->is_record()) {
722 exec_node
*expr_node
= ai
->expressions
.head
;
724 /* Iterate through the struct's fields. */
725 for (unsigned i
= 0; !expr_node
->is_tail_sentinel() && i
< type
->length
;
726 i
++, expr_node
= expr_node
->next
) {
727 ast_expression
*expr
= exec_node_data(ast_expression
, expr_node
,
730 if (expr
->oper
== ast_aggregate
) {
731 _mesa_ast_set_aggregate_type(type
->fields
.structure
[i
].type
, expr
);
734 /* If the aggregate is a matrix, set its columns' types. */
735 } else if (type
->is_matrix()) {
736 for (exec_node
*expr_node
= ai
->expressions
.head
;
737 !expr_node
->is_tail_sentinel();
738 expr_node
= expr_node
->next
) {
739 ast_expression
*expr
= exec_node_data(ast_expression
, expr_node
,
742 if (expr
->oper
== ast_aggregate
)
743 _mesa_ast_set_aggregate_type(type
->column_type(), expr
);
750 _mesa_ast_type_qualifier_print(const struct ast_type_qualifier
*q
)
752 if (q
->flags
.q
.constant
)
755 if (q
->flags
.q
.invariant
)
756 printf("invariant ");
758 if (q
->flags
.q
.attribute
)
759 printf("attribute ");
761 if (q
->flags
.q
.varying
)
764 if (q
->flags
.q
.in
&& q
->flags
.q
.out
)
774 if (q
->flags
.q
.centroid
)
776 if (q
->flags
.q
.sample
)
778 if (q
->flags
.q
.uniform
)
780 if (q
->flags
.q
.smooth
)
784 if (q
->flags
.q
.noperspective
)
785 printf("noperspective ");
790 ast_node::print(void) const
792 printf("unhandled node ");
796 ast_node::ast_node(void)
798 this->location
.source
= 0;
799 this->location
.line
= 0;
800 this->location
.column
= 0;
805 ast_opt_array_dimensions_print(const ast_array_specifier
*array_specifier
)
808 array_specifier
->print();
813 ast_compound_statement::print(void) const
817 foreach_list_const(n
, &this->statements
) {
818 ast_node
*ast
= exec_node_data(ast_node
, n
, link
);
826 ast_compound_statement::ast_compound_statement(int new_scope
,
827 ast_node
*statements
)
829 this->new_scope
= new_scope
;
831 if (statements
!= NULL
) {
832 this->statements
.push_degenerate_list_at_head(&statements
->link
);
838 ast_expression::print(void) const
852 subexpressions
[0]->print();
853 printf("%s ", operator_string(oper
));
854 subexpressions
[1]->print();
857 case ast_field_selection
:
858 subexpressions
[0]->print();
859 printf(". %s ", primary_expression
.identifier
);
868 printf("%s ", operator_string(oper
));
869 subexpressions
[0]->print();
874 subexpressions
[0]->print();
875 printf("%s ", operator_string(oper
));
878 case ast_conditional
:
879 subexpressions
[0]->print();
881 subexpressions
[1]->print();
883 subexpressions
[2]->print();
886 case ast_array_index
:
887 subexpressions
[0]->print();
889 subexpressions
[1]->print();
893 case ast_function_call
: {
894 subexpressions
[0]->print();
897 foreach_list_const (n
, &this->expressions
) {
898 if (n
!= this->expressions
.get_head())
901 ast_node
*ast
= exec_node_data(ast_node
, n
, link
);
910 printf("%s ", primary_expression
.identifier
);
913 case ast_int_constant
:
914 printf("%d ", primary_expression
.int_constant
);
917 case ast_uint_constant
:
918 printf("%u ", primary_expression
.uint_constant
);
921 case ast_float_constant
:
922 printf("%f ", primary_expression
.float_constant
);
925 case ast_bool_constant
:
927 primary_expression
.bool_constant
933 foreach_list_const(n
, & this->expressions
) {
934 if (n
!= this->expressions
.get_head())
937 ast_node
*ast
= exec_node_data(ast_node
, n
, link
);
944 case ast_aggregate
: {
946 foreach_list_const(n
, & this->expressions
) {
947 if (n
!= this->expressions
.get_head())
950 ast_node
*ast
= exec_node_data(ast_node
, n
, link
);
963 ast_expression::ast_expression(int oper
,
966 ast_expression
*ex2
) :
969 this->oper
= ast_operators(oper
);
970 this->subexpressions
[0] = ex0
;
971 this->subexpressions
[1] = ex1
;
972 this->subexpressions
[2] = ex2
;
973 this->non_lvalue_description
= NULL
;
978 ast_expression_statement::print(void) const
987 ast_expression_statement::ast_expression_statement(ast_expression
*ex
) :
995 ast_function::print(void) const
997 return_type
->print();
998 printf(" %s (", identifier
);
1000 foreach_list_const(n
, & this->parameters
) {
1001 ast_node
*ast
= exec_node_data(ast_node
, n
, link
);
1009 ast_function::ast_function(void)
1010 : return_type(NULL
), identifier(NULL
), is_definition(false),
1018 ast_fully_specified_type::print(void) const
1020 _mesa_ast_type_qualifier_print(& qualifier
);
1026 ast_parameter_declarator::print(void) const
1030 printf("%s ", identifier
);
1031 ast_opt_array_dimensions_print(array_specifier
);
1036 ast_function_definition::print(void) const
1044 ast_declaration::print(void) const
1046 printf("%s ", identifier
);
1047 ast_opt_array_dimensions_print(array_specifier
);
1051 initializer
->print();
1056 ast_declaration::ast_declaration(const char *identifier
,
1057 ast_array_specifier
*array_specifier
,
1058 ast_expression
*initializer
)
1060 this->identifier
= identifier
;
1061 this->array_specifier
= array_specifier
;
1062 this->initializer
= initializer
;
1067 ast_declarator_list::print(void) const
1069 assert(type
|| invariant
);
1074 printf("invariant ");
1076 foreach_list_const (ptr
, & this->declarations
) {
1077 if (ptr
!= this->declarations
.get_head())
1080 ast_node
*ast
= exec_node_data(ast_node
, ptr
, link
);
1088 ast_declarator_list::ast_declarator_list(ast_fully_specified_type
*type
)
1091 this->invariant
= false;
1095 ast_jump_statement::print(void) const
1099 printf("continue; ");
1106 if (opt_return_value
)
1107 opt_return_value
->print();
1112 printf("discard; ");
1118 ast_jump_statement::ast_jump_statement(int mode
, ast_expression
*return_value
)
1119 : opt_return_value(NULL
)
1121 this->mode
= ast_jump_modes(mode
);
1123 if (mode
== ast_return
)
1124 opt_return_value
= return_value
;
1129 ast_selection_statement::print(void) const
1135 then_statement
->print();
1137 if (else_statement
) {
1139 else_statement
->print();
1145 ast_selection_statement::ast_selection_statement(ast_expression
*condition
,
1146 ast_node
*then_statement
,
1147 ast_node
*else_statement
)
1149 this->condition
= condition
;
1150 this->then_statement
= then_statement
;
1151 this->else_statement
= else_statement
;
1156 ast_switch_statement::print(void) const
1158 printf("switch ( ");
1159 test_expression
->print();
1166 ast_switch_statement::ast_switch_statement(ast_expression
*test_expression
,
1169 this->test_expression
= test_expression
;
1175 ast_switch_body::print(void) const
1178 if (stmts
!= NULL
) {
1185 ast_switch_body::ast_switch_body(ast_case_statement_list
*stmts
)
1187 this->stmts
= stmts
;
1191 void ast_case_label::print(void) const
1193 if (test_value
!= NULL
) {
1195 test_value
->print();
1198 printf("default: ");
1203 ast_case_label::ast_case_label(ast_expression
*test_value
)
1205 this->test_value
= test_value
;
1209 void ast_case_label_list::print(void) const
1211 foreach_list_const(n
, & this->labels
) {
1212 ast_node
*ast
= exec_node_data(ast_node
, n
, link
);
1219 ast_case_label_list::ast_case_label_list(void)
1224 void ast_case_statement::print(void) const
1227 foreach_list_const(n
, & this->stmts
) {
1228 ast_node
*ast
= exec_node_data(ast_node
, n
, link
);
1235 ast_case_statement::ast_case_statement(ast_case_label_list
*labels
)
1237 this->labels
= labels
;
1241 void ast_case_statement_list::print(void) const
1243 foreach_list_const(n
, & this->cases
) {
1244 ast_node
*ast
= exec_node_data(ast_node
, n
, link
);
1250 ast_case_statement_list::ast_case_statement_list(void)
1256 ast_iteration_statement::print(void) const
1262 init_statement
->print();
1269 if (rest_expression
)
1270 rest_expression
->print();
1296 ast_iteration_statement::ast_iteration_statement(int mode
,
1298 ast_node
*condition
,
1299 ast_expression
*rest_expression
,
1302 this->mode
= ast_iteration_modes(mode
);
1303 this->init_statement
= init
;
1304 this->condition
= condition
;
1305 this->rest_expression
= rest_expression
;
1311 ast_struct_specifier::print(void) const
1313 printf("struct %s { ", name
);
1314 foreach_list_const(n
, &this->declarations
) {
1315 ast_node
*ast
= exec_node_data(ast_node
, n
, link
);
1322 ast_struct_specifier::ast_struct_specifier(const char *identifier
,
1323 ast_declarator_list
*declarator_list
)
1325 if (identifier
== NULL
) {
1326 static unsigned anon_count
= 1;
1327 identifier
= ralloc_asprintf(this, "#anon_struct_%04x", anon_count
);
1331 this->declarations
.push_degenerate_list_at_head(&declarator_list
->link
);
1332 is_declaration
= true;
1336 set_shader_inout_layout(struct gl_shader
*shader
,
1337 struct _mesa_glsl_parse_state
*state
)
1339 if (shader
->Stage
!= MESA_SHADER_GEOMETRY
) {
1340 /* Should have been prevented by the parser. */
1341 assert(!state
->gs_input_prim_type_specified
);
1342 assert(!state
->out_qualifier
->flags
.i
);
1345 if (shader
->Stage
!= MESA_SHADER_COMPUTE
) {
1346 /* Should have been prevented by the parser. */
1347 assert(!state
->cs_input_local_size_specified
);
1350 switch (shader
->Stage
) {
1351 case MESA_SHADER_GEOMETRY
:
1352 shader
->Geom
.VerticesOut
= 0;
1353 if (state
->out_qualifier
->flags
.q
.max_vertices
)
1354 shader
->Geom
.VerticesOut
= state
->out_qualifier
->max_vertices
;
1356 if (state
->gs_input_prim_type_specified
) {
1357 shader
->Geom
.InputType
= state
->gs_input_prim_type
;
1359 shader
->Geom
.InputType
= PRIM_UNKNOWN
;
1362 if (state
->out_qualifier
->flags
.q
.prim_type
) {
1363 shader
->Geom
.OutputType
= state
->out_qualifier
->prim_type
;
1365 shader
->Geom
.OutputType
= PRIM_UNKNOWN
;
1369 case MESA_SHADER_COMPUTE
:
1370 if (state
->cs_input_local_size_specified
) {
1371 for (int i
= 0; i
< 3; i
++)
1372 shader
->Comp
.LocalSize
[i
] = state
->cs_input_local_size
[i
];
1374 for (int i
= 0; i
< 3; i
++)
1375 shader
->Comp
.LocalSize
[i
] = 0;
1380 /* Nothing to do. */
1388 _mesa_glsl_compile_shader(struct gl_context
*ctx
, struct gl_shader
*shader
,
1389 bool dump_ast
, bool dump_hir
)
1391 struct _mesa_glsl_parse_state
*state
=
1392 new(shader
) _mesa_glsl_parse_state(ctx
, shader
->Stage
, shader
);
1393 const char *source
= shader
->Source
;
1395 state
->error
= glcpp_preprocess(state
, &source
, &state
->info_log
,
1396 &ctx
->Extensions
, ctx
);
1398 if (!state
->error
) {
1399 _mesa_glsl_lexer_ctor(state
, source
);
1400 _mesa_glsl_parse(state
);
1401 _mesa_glsl_lexer_dtor(state
);
1405 foreach_list_const(n
, &state
->translation_unit
) {
1406 ast_node
*ast
= exec_node_data(ast_node
, n
, link
);
1412 ralloc_free(shader
->ir
);
1413 shader
->ir
= new(shader
) exec_list
;
1414 if (!state
->error
&& !state
->translation_unit
.is_empty())
1415 _mesa_ast_to_hir(shader
->ir
, state
);
1417 if (!state
->error
) {
1418 validate_ir_tree(shader
->ir
);
1420 /* Print out the unoptimized IR. */
1422 _mesa_print_ir(shader
->ir
, state
);
1427 if (!state
->error
&& !shader
->ir
->is_empty()) {
1428 struct gl_shader_compiler_options
*options
=
1429 &ctx
->ShaderCompilerOptions
[shader
->Stage
];
1431 /* Do some optimization at compile time to reduce shader IR size
1432 * and reduce later work if the same shader is linked multiple times
1434 while (do_common_optimization(shader
->ir
, false, false, 32, options
))
1437 validate_ir_tree(shader
->ir
);
1440 if (shader
->InfoLog
)
1441 ralloc_free(shader
->InfoLog
);
1443 shader
->symbols
= state
->symbols
;
1444 shader
->CompileStatus
= !state
->error
;
1445 shader
->InfoLog
= state
->info_log
;
1446 shader
->Version
= state
->language_version
;
1447 shader
->IsES
= state
->es_shader
;
1448 shader
->uses_builtin_functions
= state
->uses_builtin_functions
;
1450 if (shader
->UniformBlocks
)
1451 ralloc_free(shader
->UniformBlocks
);
1452 shader
->NumUniformBlocks
= state
->num_uniform_blocks
;
1453 shader
->UniformBlocks
= state
->uniform_blocks
;
1454 ralloc_steal(shader
, shader
->UniformBlocks
);
1457 set_shader_inout_layout(shader
, state
);
1459 /* Retain any live IR, but trash the rest. */
1460 reparent_ir(shader
->ir
, shader
->ir
);
1467 * Do the set of common optimizations passes
1469 * \param ir List of instructions to be optimized
1470 * \param linked Is the shader linked? This enables
1471 * optimizations passes that remove code at
1472 * global scope and could cause linking to
1474 * \param uniform_locations_assigned Have locations already been assigned for
1475 * uniforms? This prevents the declarations
1476 * of unused uniforms from being removed.
1477 * The setting of this flag only matters if
1478 * \c linked is \c true.
1479 * \param max_unroll_iterations Maximum number of loop iterations to be
1480 * unrolled. Setting to 0 disables loop
1482 * \param options The driver's preferred shader options.
1485 do_common_optimization(exec_list
*ir
, bool linked
,
1486 bool uniform_locations_assigned
,
1487 unsigned max_unroll_iterations
,
1488 const struct gl_shader_compiler_options
*options
)
1490 GLboolean progress
= GL_FALSE
;
1492 progress
= lower_instructions(ir
, SUB_TO_ADD_NEG
) || progress
;
1495 progress
= do_function_inlining(ir
) || progress
;
1496 progress
= do_dead_functions(ir
) || progress
;
1497 progress
= do_structure_splitting(ir
) || progress
;
1499 progress
= do_if_simplification(ir
) || progress
;
1500 progress
= opt_flatten_nested_if_blocks(ir
) || progress
;
1501 progress
= do_copy_propagation(ir
) || progress
;
1502 progress
= do_copy_propagation_elements(ir
) || progress
;
1504 if (options
->OptimizeForAOS
&& !linked
)
1505 progress
= opt_flip_matrices(ir
) || progress
;
1507 if (linked
&& options
->OptimizeForAOS
) {
1508 progress
= do_vectorize(ir
) || progress
;
1512 progress
= do_dead_code(ir
, uniform_locations_assigned
) || progress
;
1514 progress
= do_dead_code_unlinked(ir
) || progress
;
1515 progress
= do_dead_code_local(ir
) || progress
;
1516 progress
= do_tree_grafting(ir
) || progress
;
1517 progress
= do_constant_propagation(ir
) || progress
;
1519 progress
= do_constant_variable(ir
) || progress
;
1521 progress
= do_constant_variable_unlinked(ir
) || progress
;
1522 progress
= do_constant_folding(ir
) || progress
;
1523 progress
= do_cse(ir
) || progress
;
1524 progress
= do_algebraic(ir
) || progress
;
1525 progress
= do_lower_jumps(ir
) || progress
;
1526 progress
= do_vec_index_to_swizzle(ir
) || progress
;
1527 progress
= lower_vector_insert(ir
, false) || progress
;
1528 progress
= do_swizzle_swizzle(ir
) || progress
;
1529 progress
= do_noop_swizzle(ir
) || progress
;
1531 progress
= optimize_split_arrays(ir
, linked
) || progress
;
1532 progress
= optimize_redundant_jumps(ir
) || progress
;
1534 loop_state
*ls
= analyze_loop_variables(ir
);
1535 if (ls
->loop_found
) {
1536 progress
= set_loop_controls(ir
, ls
) || progress
;
1537 progress
= unroll_loops(ir
, ls
, max_unroll_iterations
) || progress
;
1547 * To be called at GL teardown time, this frees compiler datastructures.
1549 * After calling this, any previously compiled shaders and shader
1550 * programs would be invalid. So this should happen at approximately
1554 _mesa_destroy_shader_compiler(void)
1556 _mesa_destroy_shader_compiler_caches();
1558 _mesa_glsl_release_types();
1562 * Releases compiler caches to trade off performance for memory.
1564 * Intended to be used with glReleaseShaderCompiler().
1567 _mesa_destroy_shader_compiler_caches(void)
1569 _mesa_glsl_release_builtin_functions();