glsl: Allow invariant qualifer in block members in desktop OpenGL.
[mesa.git] / src / compiler / glsl / glsl_parser_extras.cpp
1 /*
2 * Copyright © 2008, 2009 Intel Corporation
3 *
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:
10 *
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
13 * Software.
14 *
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.
22 */
23 #include <stdio.h>
24 #include <stdarg.h>
25 #include <string.h>
26 #include <assert.h>
27
28 #include "main/core.h" /* for struct gl_context */
29 #include "main/context.h"
30 #include "main/debug_output.h"
31 #include "main/shaderobj.h"
32 #include "util/u_atomic.h" /* for p_atomic_cmpxchg */
33 #include "util/ralloc.h"
34 #include "ast.h"
35 #include "glsl_parser_extras.h"
36 #include "glsl_parser.h"
37 #include "ir_optimization.h"
38 #include "loop_analysis.h"
39
40 /**
41 * Format a short human-readable description of the given GLSL version.
42 */
43 const char *
44 glsl_compute_version_string(void *mem_ctx, bool is_es, unsigned version)
45 {
46 return ralloc_asprintf(mem_ctx, "GLSL%s %d.%02d", is_es ? " ES" : "",
47 version / 100, version % 100);
48 }
49
50
51 static const unsigned known_desktop_glsl_versions[] =
52 { 110, 120, 130, 140, 150, 330, 400, 410, 420, 430, 440, 450 };
53
54
55 _mesa_glsl_parse_state::_mesa_glsl_parse_state(struct gl_context *_ctx,
56 gl_shader_stage stage,
57 void *mem_ctx)
58 : ctx(_ctx), cs_input_local_size_specified(false), cs_input_local_size(),
59 switch_state()
60 {
61 assert(stage < MESA_SHADER_STAGES);
62 this->stage = stage;
63
64 this->scanner = NULL;
65 this->translation_unit.make_empty();
66 this->symbols = new(mem_ctx) glsl_symbol_table;
67
68 this->info_log = ralloc_strdup(mem_ctx, "");
69 this->error = false;
70 this->loop_nesting_ast = NULL;
71
72 this->uses_builtin_functions = false;
73
74 /* Set default language version and extensions */
75 this->language_version = 110;
76 this->forced_language_version = ctx->Const.ForceGLSLVersion;
77 this->es_shader = false;
78 this->ARB_texture_rectangle_enable = true;
79
80 /* OpenGL ES 2.0 has different defaults from desktop GL. */
81 if (ctx->API == API_OPENGLES2) {
82 this->language_version = 100;
83 this->es_shader = true;
84 this->ARB_texture_rectangle_enable = false;
85 }
86
87 this->extensions = &ctx->Extensions;
88
89 this->Const.MaxLights = ctx->Const.MaxLights;
90 this->Const.MaxClipPlanes = ctx->Const.MaxClipPlanes;
91 this->Const.MaxTextureUnits = ctx->Const.MaxTextureUnits;
92 this->Const.MaxTextureCoords = ctx->Const.MaxTextureCoordUnits;
93 this->Const.MaxVertexAttribs = ctx->Const.Program[MESA_SHADER_VERTEX].MaxAttribs;
94 this->Const.MaxVertexUniformComponents = ctx->Const.Program[MESA_SHADER_VERTEX].MaxUniformComponents;
95 this->Const.MaxVertexTextureImageUnits = ctx->Const.Program[MESA_SHADER_VERTEX].MaxTextureImageUnits;
96 this->Const.MaxCombinedTextureImageUnits = ctx->Const.MaxCombinedTextureImageUnits;
97 this->Const.MaxTextureImageUnits = ctx->Const.Program[MESA_SHADER_FRAGMENT].MaxTextureImageUnits;
98 this->Const.MaxFragmentUniformComponents = ctx->Const.Program[MESA_SHADER_FRAGMENT].MaxUniformComponents;
99 this->Const.MinProgramTexelOffset = ctx->Const.MinProgramTexelOffset;
100 this->Const.MaxProgramTexelOffset = ctx->Const.MaxProgramTexelOffset;
101
102 this->Const.MaxDrawBuffers = ctx->Const.MaxDrawBuffers;
103
104 this->Const.MaxDualSourceDrawBuffers = ctx->Const.MaxDualSourceDrawBuffers;
105
106 /* 1.50 constants */
107 this->Const.MaxVertexOutputComponents = ctx->Const.Program[MESA_SHADER_VERTEX].MaxOutputComponents;
108 this->Const.MaxGeometryInputComponents = ctx->Const.Program[MESA_SHADER_GEOMETRY].MaxInputComponents;
109 this->Const.MaxGeometryOutputComponents = ctx->Const.Program[MESA_SHADER_GEOMETRY].MaxOutputComponents;
110 this->Const.MaxFragmentInputComponents = ctx->Const.Program[MESA_SHADER_FRAGMENT].MaxInputComponents;
111 this->Const.MaxGeometryTextureImageUnits = ctx->Const.Program[MESA_SHADER_GEOMETRY].MaxTextureImageUnits;
112 this->Const.MaxGeometryOutputVertices = ctx->Const.MaxGeometryOutputVertices;
113 this->Const.MaxGeometryTotalOutputComponents = ctx->Const.MaxGeometryTotalOutputComponents;
114 this->Const.MaxGeometryUniformComponents = ctx->Const.Program[MESA_SHADER_GEOMETRY].MaxUniformComponents;
115
116 this->Const.MaxVertexAtomicCounters = ctx->Const.Program[MESA_SHADER_VERTEX].MaxAtomicCounters;
117 this->Const.MaxTessControlAtomicCounters = ctx->Const.Program[MESA_SHADER_TESS_CTRL].MaxAtomicCounters;
118 this->Const.MaxTessEvaluationAtomicCounters = ctx->Const.Program[MESA_SHADER_TESS_EVAL].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;
123 this->Const.MaxVertexAtomicCounterBuffers =
124 ctx->Const.Program[MESA_SHADER_VERTEX].MaxAtomicBuffers;
125 this->Const.MaxTessControlAtomicCounterBuffers =
126 ctx->Const.Program[MESA_SHADER_TESS_CTRL].MaxAtomicBuffers;
127 this->Const.MaxTessEvaluationAtomicCounterBuffers =
128 ctx->Const.Program[MESA_SHADER_TESS_EVAL].MaxAtomicBuffers;
129 this->Const.MaxGeometryAtomicCounterBuffers =
130 ctx->Const.Program[MESA_SHADER_GEOMETRY].MaxAtomicBuffers;
131 this->Const.MaxFragmentAtomicCounterBuffers =
132 ctx->Const.Program[MESA_SHADER_FRAGMENT].MaxAtomicBuffers;
133 this->Const.MaxCombinedAtomicCounterBuffers =
134 ctx->Const.MaxCombinedAtomicBuffers;
135 this->Const.MaxAtomicCounterBufferSize =
136 ctx->Const.MaxAtomicBufferSize;
137
138 /* Compute shader constants */
139 for (unsigned i = 0; i < ARRAY_SIZE(this->Const.MaxComputeWorkGroupCount); i++)
140 this->Const.MaxComputeWorkGroupCount[i] = ctx->Const.MaxComputeWorkGroupCount[i];
141 for (unsigned i = 0; i < ARRAY_SIZE(this->Const.MaxComputeWorkGroupSize); i++)
142 this->Const.MaxComputeWorkGroupSize[i] = ctx->Const.MaxComputeWorkGroupSize[i];
143
144 this->Const.MaxImageUnits = ctx->Const.MaxImageUnits;
145 this->Const.MaxCombinedShaderOutputResources = ctx->Const.MaxCombinedShaderOutputResources;
146 this->Const.MaxImageSamples = ctx->Const.MaxImageSamples;
147 this->Const.MaxVertexImageUniforms = ctx->Const.Program[MESA_SHADER_VERTEX].MaxImageUniforms;
148 this->Const.MaxTessControlImageUniforms = ctx->Const.Program[MESA_SHADER_TESS_CTRL].MaxImageUniforms;
149 this->Const.MaxTessEvaluationImageUniforms = ctx->Const.Program[MESA_SHADER_TESS_EVAL].MaxImageUniforms;
150 this->Const.MaxGeometryImageUniforms = ctx->Const.Program[MESA_SHADER_GEOMETRY].MaxImageUniforms;
151 this->Const.MaxFragmentImageUniforms = ctx->Const.Program[MESA_SHADER_FRAGMENT].MaxImageUniforms;
152 this->Const.MaxCombinedImageUniforms = ctx->Const.MaxCombinedImageUniforms;
153
154 /* ARB_viewport_array */
155 this->Const.MaxViewports = ctx->Const.MaxViewports;
156
157 /* tessellation shader constants */
158 this->Const.MaxPatchVertices = ctx->Const.MaxPatchVertices;
159 this->Const.MaxTessGenLevel = ctx->Const.MaxTessGenLevel;
160 this->Const.MaxTessControlInputComponents = ctx->Const.Program[MESA_SHADER_TESS_CTRL].MaxInputComponents;
161 this->Const.MaxTessControlOutputComponents = ctx->Const.Program[MESA_SHADER_TESS_CTRL].MaxOutputComponents;
162 this->Const.MaxTessControlTextureImageUnits = ctx->Const.Program[MESA_SHADER_TESS_CTRL].MaxTextureImageUnits;
163 this->Const.MaxTessEvaluationInputComponents = ctx->Const.Program[MESA_SHADER_TESS_EVAL].MaxInputComponents;
164 this->Const.MaxTessEvaluationOutputComponents = ctx->Const.Program[MESA_SHADER_TESS_EVAL].MaxOutputComponents;
165 this->Const.MaxTessEvaluationTextureImageUnits = ctx->Const.Program[MESA_SHADER_TESS_EVAL].MaxTextureImageUnits;
166 this->Const.MaxTessPatchComponents = ctx->Const.MaxTessPatchComponents;
167 this->Const.MaxTessControlTotalOutputComponents = ctx->Const.MaxTessControlTotalOutputComponents;
168 this->Const.MaxTessControlUniformComponents = ctx->Const.Program[MESA_SHADER_TESS_CTRL].MaxUniformComponents;
169 this->Const.MaxTessEvaluationUniformComponents = ctx->Const.Program[MESA_SHADER_TESS_EVAL].MaxUniformComponents;
170
171 this->current_function = NULL;
172 this->toplevel_ir = NULL;
173 this->found_return = false;
174 this->all_invariant = false;
175 this->user_structures = NULL;
176 this->num_user_structures = 0;
177 this->num_subroutines = 0;
178 this->subroutines = NULL;
179 this->num_subroutine_types = 0;
180 this->subroutine_types = NULL;
181
182 /* supported_versions should be large enough to support the known desktop
183 * GLSL versions plus 3 GLES versions (ES 1.00, ES 3.00, and ES 3.10))
184 */
185 STATIC_ASSERT((ARRAY_SIZE(known_desktop_glsl_versions) + 3) ==
186 ARRAY_SIZE(this->supported_versions));
187
188 /* Populate the list of supported GLSL versions */
189 /* FINISHME: Once the OpenGL 3.0 'forward compatible' context or
190 * the OpenGL 3.2 Core context is supported, this logic will need
191 * change. Older versions of GLSL are no longer supported
192 * outside the compatibility contexts of 3.x.
193 */
194 this->num_supported_versions = 0;
195 if (_mesa_is_desktop_gl(ctx)) {
196 for (unsigned i = 0; i < ARRAY_SIZE(known_desktop_glsl_versions); i++) {
197 if (known_desktop_glsl_versions[i] <= ctx->Const.GLSLVersion) {
198 this->supported_versions[this->num_supported_versions].ver
199 = known_desktop_glsl_versions[i];
200 this->supported_versions[this->num_supported_versions].es = false;
201 this->num_supported_versions++;
202 }
203 }
204 }
205 if (ctx->API == API_OPENGLES2 || ctx->Extensions.ARB_ES2_compatibility) {
206 this->supported_versions[this->num_supported_versions].ver = 100;
207 this->supported_versions[this->num_supported_versions].es = true;
208 this->num_supported_versions++;
209 }
210 if (_mesa_is_gles3(ctx) || ctx->Extensions.ARB_ES3_compatibility) {
211 this->supported_versions[this->num_supported_versions].ver = 300;
212 this->supported_versions[this->num_supported_versions].es = true;
213 this->num_supported_versions++;
214 }
215 if (_mesa_is_gles31(ctx)) {
216 this->supported_versions[this->num_supported_versions].ver = 310;
217 this->supported_versions[this->num_supported_versions].es = true;
218 this->num_supported_versions++;
219 }
220
221 /* Create a string for use in error messages to tell the user which GLSL
222 * versions are supported.
223 */
224 char *supported = ralloc_strdup(this, "");
225 for (unsigned i = 0; i < this->num_supported_versions; i++) {
226 unsigned ver = this->supported_versions[i].ver;
227 const char *const prefix = (i == 0)
228 ? ""
229 : ((i == this->num_supported_versions - 1) ? ", and " : ", ");
230 const char *const suffix = (this->supported_versions[i].es) ? " ES" : "";
231
232 ralloc_asprintf_append(& supported, "%s%u.%02u%s",
233 prefix,
234 ver / 100, ver % 100,
235 suffix);
236 }
237
238 this->supported_version_string = supported;
239
240 if (ctx->Const.ForceGLSLExtensionsWarn)
241 _mesa_glsl_process_extension("all", NULL, "warn", NULL, this);
242
243 this->default_uniform_qualifier = new(this) ast_type_qualifier();
244 this->default_uniform_qualifier->flags.q.shared = 1;
245 this->default_uniform_qualifier->flags.q.column_major = 1;
246 this->default_uniform_qualifier->is_default_qualifier = true;
247
248 this->default_shader_storage_qualifier = new(this) ast_type_qualifier();
249 this->default_shader_storage_qualifier->flags.q.shared = 1;
250 this->default_shader_storage_qualifier->flags.q.column_major = 1;
251 this->default_shader_storage_qualifier->is_default_qualifier = true;
252
253 this->fs_uses_gl_fragcoord = false;
254 this->fs_redeclares_gl_fragcoord = false;
255 this->fs_origin_upper_left = false;
256 this->fs_pixel_center_integer = false;
257 this->fs_redeclares_gl_fragcoord_with_no_layout_qualifiers = false;
258
259 this->gs_input_prim_type_specified = false;
260 this->tcs_output_vertices_specified = false;
261 this->gs_input_size = 0;
262 this->in_qualifier = new(this) ast_type_qualifier();
263 this->out_qualifier = new(this) ast_type_qualifier();
264 this->fs_early_fragment_tests = false;
265 memset(this->atomic_counter_offsets, 0,
266 sizeof(this->atomic_counter_offsets));
267 this->allow_extension_directive_midshader =
268 ctx->Const.AllowGLSLExtensionDirectiveMidShader;
269 }
270
271 /**
272 * Determine whether the current GLSL version is sufficiently high to support
273 * a certain feature, and generate an error message if it isn't.
274 *
275 * \param required_glsl_version and \c required_glsl_es_version are
276 * interpreted as they are in _mesa_glsl_parse_state::is_version().
277 *
278 * \param locp is the parser location where the error should be reported.
279 *
280 * \param fmt (and additional arguments) constitute a printf-style error
281 * message to report if the version check fails. Information about the
282 * current and required GLSL versions will be appended. So, for example, if
283 * the GLSL version being compiled is 1.20, and check_version(130, 300, locp,
284 * "foo unsupported") is called, the error message will be "foo unsupported in
285 * GLSL 1.20 (GLSL 1.30 or GLSL 3.00 ES required)".
286 */
287 bool
288 _mesa_glsl_parse_state::check_version(unsigned required_glsl_version,
289 unsigned required_glsl_es_version,
290 YYLTYPE *locp, const char *fmt, ...)
291 {
292 if (this->is_version(required_glsl_version, required_glsl_es_version))
293 return true;
294
295 va_list args;
296 va_start(args, fmt);
297 char *problem = ralloc_vasprintf(this, fmt, args);
298 va_end(args);
299 const char *glsl_version_string
300 = glsl_compute_version_string(this, false, required_glsl_version);
301 const char *glsl_es_version_string
302 = glsl_compute_version_string(this, true, required_glsl_es_version);
303 const char *requirement_string = "";
304 if (required_glsl_version && required_glsl_es_version) {
305 requirement_string = ralloc_asprintf(this, " (%s or %s required)",
306 glsl_version_string,
307 glsl_es_version_string);
308 } else if (required_glsl_version) {
309 requirement_string = ralloc_asprintf(this, " (%s required)",
310 glsl_version_string);
311 } else if (required_glsl_es_version) {
312 requirement_string = ralloc_asprintf(this, " (%s required)",
313 glsl_es_version_string);
314 }
315 _mesa_glsl_error(locp, this, "%s in %s%s",
316 problem, this->get_version_string(),
317 requirement_string);
318
319 return false;
320 }
321
322 /**
323 * Process a GLSL #version directive.
324 *
325 * \param version is the integer that follows the #version token.
326 *
327 * \param ident is a string identifier that follows the integer, if any is
328 * present. Otherwise NULL.
329 */
330 void
331 _mesa_glsl_parse_state::process_version_directive(YYLTYPE *locp, int version,
332 const char *ident)
333 {
334 bool es_token_present = false;
335 if (ident) {
336 if (strcmp(ident, "es") == 0) {
337 es_token_present = true;
338 } else if (version >= 150) {
339 if (strcmp(ident, "core") == 0) {
340 /* Accept the token. There's no need to record that this is
341 * a core profile shader since that's the only profile we support.
342 */
343 } else if (strcmp(ident, "compatibility") == 0) {
344 _mesa_glsl_error(locp, this,
345 "the compatibility profile is not supported");
346 } else {
347 _mesa_glsl_error(locp, this,
348 "\"%s\" is not a valid shading language profile; "
349 "if present, it must be \"core\"", ident);
350 }
351 } else {
352 _mesa_glsl_error(locp, this,
353 "illegal text following version number");
354 }
355 }
356
357 this->es_shader = es_token_present;
358 if (version == 100) {
359 if (es_token_present) {
360 _mesa_glsl_error(locp, this,
361 "GLSL 1.00 ES should be selected using "
362 "`#version 100'");
363 } else {
364 this->es_shader = true;
365 }
366 }
367
368 if (this->es_shader) {
369 this->ARB_texture_rectangle_enable = false;
370 }
371
372 if (this->forced_language_version)
373 this->language_version = this->forced_language_version;
374 else
375 this->language_version = version;
376
377 bool supported = false;
378 for (unsigned i = 0; i < this->num_supported_versions; i++) {
379 if (this->supported_versions[i].ver == this->language_version
380 && this->supported_versions[i].es == this->es_shader) {
381 supported = true;
382 break;
383 }
384 }
385
386 if (!supported) {
387 _mesa_glsl_error(locp, this, "%s is not supported. "
388 "Supported versions are: %s",
389 this->get_version_string(),
390 this->supported_version_string);
391
392 /* On exit, the language_version must be set to a valid value.
393 * Later calls to _mesa_glsl_initialize_types will misbehave if
394 * the version is invalid.
395 */
396 switch (this->ctx->API) {
397 case API_OPENGL_COMPAT:
398 case API_OPENGL_CORE:
399 this->language_version = this->ctx->Const.GLSLVersion;
400 break;
401
402 case API_OPENGLES:
403 assert(!"Should not get here.");
404 /* FALLTHROUGH */
405
406 case API_OPENGLES2:
407 this->language_version = 100;
408 break;
409 }
410 }
411 }
412
413
414 /* This helper function will append the given message to the shader's
415 info log and report it via GL_ARB_debug_output. Per that extension,
416 'type' is one of the enum values classifying the message, and
417 'id' is the implementation-defined ID of the given message. */
418 static void
419 _mesa_glsl_msg(const YYLTYPE *locp, _mesa_glsl_parse_state *state,
420 GLenum type, const char *fmt, va_list ap)
421 {
422 bool error = (type == MESA_DEBUG_TYPE_ERROR);
423 GLuint msg_id = 0;
424
425 assert(state->info_log != NULL);
426
427 /* Get the offset that the new message will be written to. */
428 int msg_offset = strlen(state->info_log);
429
430 ralloc_asprintf_append(&state->info_log, "%u:%u(%u): %s: ",
431 locp->source,
432 locp->first_line,
433 locp->first_column,
434 error ? "error" : "warning");
435 ralloc_vasprintf_append(&state->info_log, fmt, ap);
436
437 const char *const msg = &state->info_log[msg_offset];
438 struct gl_context *ctx = state->ctx;
439
440 /* Report the error via GL_ARB_debug_output. */
441 _mesa_shader_debug(ctx, type, &msg_id, msg);
442
443 ralloc_strcat(&state->info_log, "\n");
444 }
445
446 void
447 _mesa_glsl_error(YYLTYPE *locp, _mesa_glsl_parse_state *state,
448 const char *fmt, ...)
449 {
450 va_list ap;
451
452 state->error = true;
453
454 va_start(ap, fmt);
455 _mesa_glsl_msg(locp, state, MESA_DEBUG_TYPE_ERROR, fmt, ap);
456 va_end(ap);
457 }
458
459
460 void
461 _mesa_glsl_warning(const YYLTYPE *locp, _mesa_glsl_parse_state *state,
462 const char *fmt, ...)
463 {
464 va_list ap;
465
466 va_start(ap, fmt);
467 _mesa_glsl_msg(locp, state, MESA_DEBUG_TYPE_OTHER, fmt, ap);
468 va_end(ap);
469 }
470
471
472 /**
473 * Enum representing the possible behaviors that can be specified in
474 * an #extension directive.
475 */
476 enum ext_behavior {
477 extension_disable,
478 extension_enable,
479 extension_require,
480 extension_warn
481 };
482
483 /**
484 * Element type for _mesa_glsl_supported_extensions
485 */
486 struct _mesa_glsl_extension {
487 /**
488 * Name of the extension when referred to in a GLSL extension
489 * statement
490 */
491 const char *name;
492
493 /** True if this extension is available to desktop GL shaders */
494 bool avail_in_GL;
495
496 /** True if this extension is available to GLES shaders */
497 bool avail_in_ES;
498
499 /**
500 * Flag in the gl_extensions struct indicating whether this
501 * extension is supported by the driver, or
502 * &gl_extensions::dummy_true if supported by all drivers.
503 *
504 * Note: the type (GLboolean gl_extensions::*) is a "pointer to
505 * member" type, the type-safe alternative to the "offsetof" macro.
506 * In a nutshell:
507 *
508 * - foo bar::* p declares p to be an "offset" to a field of type
509 * foo that exists within struct bar
510 * - &bar::baz computes the "offset" of field baz within struct bar
511 * - x.*p accesses the field of x that exists at "offset" p
512 * - x->*p is equivalent to (*x).*p
513 */
514 const GLboolean gl_extensions::* supported_flag;
515
516 /**
517 * Flag in the _mesa_glsl_parse_state struct that should be set
518 * when this extension is enabled.
519 *
520 * See note in _mesa_glsl_extension::supported_flag about "pointer
521 * to member" types.
522 */
523 bool _mesa_glsl_parse_state::* enable_flag;
524
525 /**
526 * Flag in the _mesa_glsl_parse_state struct that should be set
527 * when the shader requests "warn" behavior for this extension.
528 *
529 * See note in _mesa_glsl_extension::supported_flag about "pointer
530 * to member" types.
531 */
532 bool _mesa_glsl_parse_state::* warn_flag;
533
534
535 bool compatible_with_state(const _mesa_glsl_parse_state *state) const;
536 void set_flags(_mesa_glsl_parse_state *state, ext_behavior behavior) const;
537 };
538
539 #define EXT(NAME, GL, ES, SUPPORTED_FLAG) \
540 { "GL_" #NAME, GL, ES, &gl_extensions::SUPPORTED_FLAG, \
541 &_mesa_glsl_parse_state::NAME##_enable, \
542 &_mesa_glsl_parse_state::NAME##_warn }
543
544 /**
545 * Table of extensions that can be enabled/disabled within a shader,
546 * and the conditions under which they are supported.
547 */
548 static const _mesa_glsl_extension _mesa_glsl_supported_extensions[] = {
549 /* API availability */
550 /* name GL ES supported flag */
551
552 /* ARB extensions go here, sorted alphabetically.
553 */
554 EXT(ARB_arrays_of_arrays, true, false, ARB_arrays_of_arrays),
555 EXT(ARB_compute_shader, true, false, ARB_compute_shader),
556 EXT(ARB_conservative_depth, true, false, ARB_conservative_depth),
557 EXT(ARB_derivative_control, true, false, ARB_derivative_control),
558 EXT(ARB_draw_buffers, true, false, dummy_true),
559 EXT(ARB_draw_instanced, true, false, ARB_draw_instanced),
560 EXT(ARB_enhanced_layouts, true, false, ARB_enhanced_layouts),
561 EXT(ARB_explicit_attrib_location, true, false, ARB_explicit_attrib_location),
562 EXT(ARB_explicit_uniform_location, true, false, ARB_explicit_uniform_location),
563 EXT(ARB_fragment_coord_conventions, true, false, ARB_fragment_coord_conventions),
564 EXT(ARB_fragment_layer_viewport, true, false, ARB_fragment_layer_viewport),
565 EXT(ARB_gpu_shader5, true, false, ARB_gpu_shader5),
566 EXT(ARB_gpu_shader_fp64, true, false, ARB_gpu_shader_fp64),
567 EXT(ARB_sample_shading, true, false, ARB_sample_shading),
568 EXT(ARB_separate_shader_objects, true, false, dummy_true),
569 EXT(ARB_shader_atomic_counters, true, false, ARB_shader_atomic_counters),
570 EXT(ARB_shader_bit_encoding, true, false, ARB_shader_bit_encoding),
571 EXT(ARB_shader_clock, true, false, ARB_shader_clock),
572 EXT(ARB_shader_draw_parameters, true, false, ARB_shader_draw_parameters),
573 EXT(ARB_shader_image_load_store, true, false, ARB_shader_image_load_store),
574 EXT(ARB_shader_image_size, true, false, ARB_shader_image_size),
575 EXT(ARB_shader_precision, true, false, ARB_shader_precision),
576 EXT(ARB_shader_stencil_export, true, false, ARB_shader_stencil_export),
577 EXT(ARB_shader_storage_buffer_object, true, true, ARB_shader_storage_buffer_object),
578 EXT(ARB_shader_subroutine, true, false, ARB_shader_subroutine),
579 EXT(ARB_shader_texture_image_samples, true, false, ARB_shader_texture_image_samples),
580 EXT(ARB_shader_texture_lod, true, false, ARB_shader_texture_lod),
581 EXT(ARB_shading_language_420pack, true, false, ARB_shading_language_420pack),
582 EXT(ARB_shading_language_packing, true, false, ARB_shading_language_packing),
583 EXT(ARB_tessellation_shader, true, false, ARB_tessellation_shader),
584 EXT(ARB_texture_cube_map_array, true, false, ARB_texture_cube_map_array),
585 EXT(ARB_texture_gather, true, false, ARB_texture_gather),
586 EXT(ARB_texture_multisample, true, false, ARB_texture_multisample),
587 EXT(ARB_texture_query_levels, true, false, ARB_texture_query_levels),
588 EXT(ARB_texture_query_lod, true, false, ARB_texture_query_lod),
589 EXT(ARB_texture_rectangle, true, false, dummy_true),
590 EXT(ARB_uniform_buffer_object, true, false, ARB_uniform_buffer_object),
591 EXT(ARB_vertex_attrib_64bit, true, false, ARB_vertex_attrib_64bit),
592 EXT(ARB_viewport_array, true, false, ARB_viewport_array),
593
594 /* KHR extensions go here, sorted alphabetically.
595 */
596
597 /* OES extensions go here, sorted alphabetically.
598 */
599 EXT(OES_EGL_image_external, false, true, OES_EGL_image_external),
600 EXT(OES_geometry_point_size, false, true, OES_geometry_shader),
601 EXT(OES_geometry_shader, false, true, OES_geometry_shader),
602 EXT(OES_standard_derivatives, false, true, OES_standard_derivatives),
603 EXT(OES_texture_3D, false, true, dummy_true),
604 EXT(OES_texture_storage_multisample_2d_array, false, true, ARB_texture_multisample),
605
606 /* All other extensions go here, sorted alphabetically.
607 */
608 EXT(AMD_conservative_depth, true, false, ARB_conservative_depth),
609 EXT(AMD_shader_stencil_export, true, false, ARB_shader_stencil_export),
610 EXT(AMD_shader_trinary_minmax, true, false, dummy_true),
611 EXT(AMD_vertex_shader_layer, true, false, AMD_vertex_shader_layer),
612 EXT(AMD_vertex_shader_viewport_index, true, false, AMD_vertex_shader_viewport_index),
613 EXT(EXT_blend_func_extended, false, true, ARB_blend_func_extended),
614 EXT(EXT_draw_buffers, false, true, dummy_true),
615 EXT(EXT_separate_shader_objects, false, true, dummy_true),
616 EXT(EXT_shader_integer_mix, true, true, EXT_shader_integer_mix),
617 EXT(EXT_shader_samples_identical, true, true, EXT_shader_samples_identical),
618 EXT(EXT_texture_array, true, false, EXT_texture_array),
619 };
620
621 #undef EXT
622
623
624 /**
625 * Determine whether a given extension is compatible with the target,
626 * API, and extension information in the current parser state.
627 */
628 bool _mesa_glsl_extension::compatible_with_state(const _mesa_glsl_parse_state *
629 state) const
630 {
631 /* Check that this extension matches whether we are compiling
632 * for desktop GL or GLES.
633 */
634 if (state->es_shader) {
635 if (!this->avail_in_ES) return false;
636 } else {
637 if (!this->avail_in_GL) return false;
638 }
639
640 /* Check that this extension is supported by the OpenGL
641 * implementation.
642 *
643 * Note: the ->* operator indexes into state->extensions by the
644 * offset this->supported_flag. See
645 * _mesa_glsl_extension::supported_flag for more info.
646 */
647 return state->extensions->*(this->supported_flag);
648 }
649
650 /**
651 * Set the appropriate flags in the parser state to establish the
652 * given behavior for this extension.
653 */
654 void _mesa_glsl_extension::set_flags(_mesa_glsl_parse_state *state,
655 ext_behavior behavior) const
656 {
657 /* Note: the ->* operator indexes into state by the
658 * offsets this->enable_flag and this->warn_flag. See
659 * _mesa_glsl_extension::supported_flag for more info.
660 */
661 state->*(this->enable_flag) = (behavior != extension_disable);
662 state->*(this->warn_flag) = (behavior == extension_warn);
663 }
664
665 /**
666 * Find an extension by name in _mesa_glsl_supported_extensions. If
667 * the name is not found, return NULL.
668 */
669 static const _mesa_glsl_extension *find_extension(const char *name)
670 {
671 for (unsigned i = 0; i < ARRAY_SIZE(_mesa_glsl_supported_extensions); ++i) {
672 if (strcmp(name, _mesa_glsl_supported_extensions[i].name) == 0) {
673 return &_mesa_glsl_supported_extensions[i];
674 }
675 }
676 return NULL;
677 }
678
679
680 bool
681 _mesa_glsl_process_extension(const char *name, YYLTYPE *name_locp,
682 const char *behavior_string, YYLTYPE *behavior_locp,
683 _mesa_glsl_parse_state *state)
684 {
685 ext_behavior behavior;
686 if (strcmp(behavior_string, "warn") == 0) {
687 behavior = extension_warn;
688 } else if (strcmp(behavior_string, "require") == 0) {
689 behavior = extension_require;
690 } else if (strcmp(behavior_string, "enable") == 0) {
691 behavior = extension_enable;
692 } else if (strcmp(behavior_string, "disable") == 0) {
693 behavior = extension_disable;
694 } else {
695 _mesa_glsl_error(behavior_locp, state,
696 "unknown extension behavior `%s'",
697 behavior_string);
698 return false;
699 }
700
701 if (strcmp(name, "all") == 0) {
702 if ((behavior == extension_enable) || (behavior == extension_require)) {
703 _mesa_glsl_error(name_locp, state, "cannot %s all extensions",
704 (behavior == extension_enable)
705 ? "enable" : "require");
706 return false;
707 } else {
708 for (unsigned i = 0;
709 i < ARRAY_SIZE(_mesa_glsl_supported_extensions); ++i) {
710 const _mesa_glsl_extension *extension
711 = &_mesa_glsl_supported_extensions[i];
712 if (extension->compatible_with_state(state)) {
713 _mesa_glsl_supported_extensions[i].set_flags(state, behavior);
714 }
715 }
716 }
717 } else {
718 const _mesa_glsl_extension *extension = find_extension(name);
719 if (extension && extension->compatible_with_state(state)) {
720 extension->set_flags(state, behavior);
721 } else {
722 static const char fmt[] = "extension `%s' unsupported in %s shader";
723
724 if (behavior == extension_require) {
725 _mesa_glsl_error(name_locp, state, fmt,
726 name, _mesa_shader_stage_to_string(state->stage));
727 return false;
728 } else {
729 _mesa_glsl_warning(name_locp, state, fmt,
730 name, _mesa_shader_stage_to_string(state->stage));
731 }
732 }
733 }
734
735 return true;
736 }
737
738
739 /**
740 * Recurses through <type> and <expr> if <expr> is an aggregate initializer
741 * and sets <expr>'s <constructor_type> field to <type>. Gives later functions
742 * (process_array_constructor, et al) sufficient information to do type
743 * checking.
744 *
745 * Operates on assignments involving an aggregate initializer. E.g.,
746 *
747 * vec4 pos = {1.0, -1.0, 0.0, 1.0};
748 *
749 * or more ridiculously,
750 *
751 * struct S {
752 * vec4 v[2];
753 * };
754 *
755 * struct {
756 * S a[2], b;
757 * int c;
758 * } aggregate = {
759 * {
760 * {
761 * {
762 * {1.0, 2.0, 3.0, 4.0}, // a[0].v[0]
763 * {5.0, 6.0, 7.0, 8.0} // a[0].v[1]
764 * } // a[0].v
765 * }, // a[0]
766 * {
767 * {
768 * {1.0, 2.0, 3.0, 4.0}, // a[1].v[0]
769 * {5.0, 6.0, 7.0, 8.0} // a[1].v[1]
770 * } // a[1].v
771 * } // a[1]
772 * }, // a
773 * {
774 * {
775 * {1.0, 2.0, 3.0, 4.0}, // b.v[0]
776 * {5.0, 6.0, 7.0, 8.0} // b.v[1]
777 * } // b.v
778 * }, // b
779 * 4 // c
780 * };
781 *
782 * This pass is necessary because the right-hand side of <type> e = { ... }
783 * doesn't contain sufficient information to determine if the types match.
784 */
785 void
786 _mesa_ast_set_aggregate_type(const glsl_type *type,
787 ast_expression *expr)
788 {
789 ast_aggregate_initializer *ai = (ast_aggregate_initializer *)expr;
790 ai->constructor_type = type;
791
792 /* If the aggregate is an array, recursively set its elements' types. */
793 if (type->is_array()) {
794 /* Each array element has the type type->fields.array.
795 *
796 * E.g., if <type> if struct S[2] we want to set each element's type to
797 * struct S.
798 */
799 for (exec_node *expr_node = ai->expressions.head;
800 !expr_node->is_tail_sentinel();
801 expr_node = expr_node->next) {
802 ast_expression *expr = exec_node_data(ast_expression, expr_node,
803 link);
804
805 if (expr->oper == ast_aggregate)
806 _mesa_ast_set_aggregate_type(type->fields.array, expr);
807 }
808
809 /* If the aggregate is a struct, recursively set its fields' types. */
810 } else if (type->is_record()) {
811 exec_node *expr_node = ai->expressions.head;
812
813 /* Iterate through the struct's fields. */
814 for (unsigned i = 0; !expr_node->is_tail_sentinel() && i < type->length;
815 i++, expr_node = expr_node->next) {
816 ast_expression *expr = exec_node_data(ast_expression, expr_node,
817 link);
818
819 if (expr->oper == ast_aggregate) {
820 _mesa_ast_set_aggregate_type(type->fields.structure[i].type, expr);
821 }
822 }
823 /* If the aggregate is a matrix, set its columns' types. */
824 } else if (type->is_matrix()) {
825 for (exec_node *expr_node = ai->expressions.head;
826 !expr_node->is_tail_sentinel();
827 expr_node = expr_node->next) {
828 ast_expression *expr = exec_node_data(ast_expression, expr_node,
829 link);
830
831 if (expr->oper == ast_aggregate)
832 _mesa_ast_set_aggregate_type(type->column_type(), expr);
833 }
834 }
835 }
836
837 void
838 _mesa_ast_process_interface_block(YYLTYPE *locp,
839 _mesa_glsl_parse_state *state,
840 ast_interface_block *const block,
841 const struct ast_type_qualifier &q)
842 {
843 if (q.flags.q.buffer) {
844 if (!state->has_shader_storage_buffer_objects()) {
845 _mesa_glsl_error(locp, state,
846 "#version 430 / GL_ARB_shader_storage_buffer_object "
847 "required for defining shader storage blocks");
848 } else if (state->ARB_shader_storage_buffer_object_warn) {
849 _mesa_glsl_warning(locp, state,
850 "#version 430 / GL_ARB_shader_storage_buffer_object "
851 "required for defining shader storage blocks");
852 }
853 } else if (q.flags.q.uniform) {
854 if (!state->has_uniform_buffer_objects()) {
855 _mesa_glsl_error(locp, state,
856 "#version 140 / GL_ARB_uniform_buffer_object "
857 "required for defining uniform blocks");
858 } else if (state->ARB_uniform_buffer_object_warn) {
859 _mesa_glsl_warning(locp, state,
860 "#version 140 / GL_ARB_uniform_buffer_object "
861 "required for defining uniform blocks");
862 }
863 } else {
864 if (state->es_shader || state->language_version < 150) {
865 _mesa_glsl_error(locp, state,
866 "#version 150 required for using "
867 "interface blocks");
868 }
869 }
870
871 /* From the GLSL 1.50.11 spec, section 4.3.7 ("Interface Blocks"):
872 * "It is illegal to have an input block in a vertex shader
873 * or an output block in a fragment shader"
874 */
875 if ((state->stage == MESA_SHADER_VERTEX) && q.flags.q.in) {
876 _mesa_glsl_error(locp, state,
877 "`in' interface block is not allowed for "
878 "a vertex shader");
879 } else if ((state->stage == MESA_SHADER_FRAGMENT) && q.flags.q.out) {
880 _mesa_glsl_error(locp, state,
881 "`out' interface block is not allowed for "
882 "a fragment shader");
883 }
884
885 /* Since block arrays require names, and both features are added in
886 * the same language versions, we don't have to explicitly
887 * version-check both things.
888 */
889 if (block->instance_name != NULL) {
890 state->check_version(150, 300, locp, "interface blocks with "
891 "an instance name are not allowed");
892 }
893
894 uint64_t interface_type_mask;
895 struct ast_type_qualifier temp_type_qualifier;
896
897 /* Get a bitmask containing only the in/out/uniform/buffer
898 * flags, allowing us to ignore other irrelevant flags like
899 * interpolation qualifiers.
900 */
901 temp_type_qualifier.flags.i = 0;
902 temp_type_qualifier.flags.q.uniform = true;
903 temp_type_qualifier.flags.q.in = true;
904 temp_type_qualifier.flags.q.out = true;
905 temp_type_qualifier.flags.q.buffer = true;
906 interface_type_mask = temp_type_qualifier.flags.i;
907
908 /* Get the block's interface qualifier. The interface_qualifier
909 * production rule guarantees that only one bit will be set (and
910 * it will be in/out/uniform).
911 */
912 uint64_t block_interface_qualifier = q.flags.i;
913
914 block->layout.flags.i |= block_interface_qualifier;
915
916 if (state->stage == MESA_SHADER_GEOMETRY &&
917 state->has_explicit_attrib_stream()) {
918 /* Assign global layout's stream value. */
919 block->layout.flags.q.stream = 1;
920 block->layout.flags.q.explicit_stream = 0;
921 block->layout.stream = state->out_qualifier->stream;
922 }
923
924 foreach_list_typed (ast_declarator_list, member, link, &block->declarations) {
925 ast_type_qualifier& qualifier = member->type->qualifier;
926 if ((qualifier.flags.i & interface_type_mask) == 0) {
927 /* GLSLangSpec.1.50.11, 4.3.7 (Interface Blocks):
928 * "If no optional qualifier is used in a member declaration, the
929 * qualifier of the variable is just in, out, or uniform as declared
930 * by interface-qualifier."
931 */
932 qualifier.flags.i |= block_interface_qualifier;
933 } else if ((qualifier.flags.i & interface_type_mask) !=
934 block_interface_qualifier) {
935 /* GLSLangSpec.1.50.11, 4.3.7 (Interface Blocks):
936 * "If optional qualifiers are used, they can include interpolation
937 * and storage qualifiers and they must declare an input, output,
938 * or uniform variable consistent with the interface qualifier of
939 * the block."
940 */
941 _mesa_glsl_error(locp, state,
942 "uniform/in/out qualifier on "
943 "interface block member does not match "
944 "the interface block");
945 }
946
947 if (!(q.flags.q.in || q.flags.q.out) && qualifier.flags.q.invariant)
948 _mesa_glsl_error(locp, state,
949 "invariant qualifiers can be used only "
950 "in interface block members for shader "
951 "inputs or outputs");
952 }
953 }
954
955 void
956 _mesa_ast_type_qualifier_print(const struct ast_type_qualifier *q)
957 {
958 if (q->flags.q.subroutine)
959 printf("subroutine ");
960
961 if (q->flags.q.subroutine_def) {
962 printf("subroutine (");
963 q->subroutine_list->print();
964 printf(")");
965 }
966
967 if (q->flags.q.constant)
968 printf("const ");
969
970 if (q->flags.q.invariant)
971 printf("invariant ");
972
973 if (q->flags.q.attribute)
974 printf("attribute ");
975
976 if (q->flags.q.varying)
977 printf("varying ");
978
979 if (q->flags.q.in && q->flags.q.out)
980 printf("inout ");
981 else {
982 if (q->flags.q.in)
983 printf("in ");
984
985 if (q->flags.q.out)
986 printf("out ");
987 }
988
989 if (q->flags.q.centroid)
990 printf("centroid ");
991 if (q->flags.q.sample)
992 printf("sample ");
993 if (q->flags.q.patch)
994 printf("patch ");
995 if (q->flags.q.uniform)
996 printf("uniform ");
997 if (q->flags.q.buffer)
998 printf("buffer ");
999 if (q->flags.q.smooth)
1000 printf("smooth ");
1001 if (q->flags.q.flat)
1002 printf("flat ");
1003 if (q->flags.q.noperspective)
1004 printf("noperspective ");
1005 }
1006
1007
1008 void
1009 ast_node::print(void) const
1010 {
1011 printf("unhandled node ");
1012 }
1013
1014
1015 ast_node::ast_node(void)
1016 {
1017 this->location.source = 0;
1018 this->location.first_line = 0;
1019 this->location.first_column = 0;
1020 this->location.last_line = 0;
1021 this->location.last_column = 0;
1022 }
1023
1024
1025 static void
1026 ast_opt_array_dimensions_print(const ast_array_specifier *array_specifier)
1027 {
1028 if (array_specifier)
1029 array_specifier->print();
1030 }
1031
1032
1033 void
1034 ast_compound_statement::print(void) const
1035 {
1036 printf("{\n");
1037
1038 foreach_list_typed(ast_node, ast, link, &this->statements) {
1039 ast->print();
1040 }
1041
1042 printf("}\n");
1043 }
1044
1045
1046 ast_compound_statement::ast_compound_statement(int new_scope,
1047 ast_node *statements)
1048 {
1049 this->new_scope = new_scope;
1050
1051 if (statements != NULL) {
1052 this->statements.push_degenerate_list_at_head(&statements->link);
1053 }
1054 }
1055
1056
1057 void
1058 ast_expression::print(void) const
1059 {
1060 switch (oper) {
1061 case ast_assign:
1062 case ast_mul_assign:
1063 case ast_div_assign:
1064 case ast_mod_assign:
1065 case ast_add_assign:
1066 case ast_sub_assign:
1067 case ast_ls_assign:
1068 case ast_rs_assign:
1069 case ast_and_assign:
1070 case ast_xor_assign:
1071 case ast_or_assign:
1072 subexpressions[0]->print();
1073 printf("%s ", operator_string(oper));
1074 subexpressions[1]->print();
1075 break;
1076
1077 case ast_field_selection:
1078 subexpressions[0]->print();
1079 printf(". %s ", primary_expression.identifier);
1080 break;
1081
1082 case ast_plus:
1083 case ast_neg:
1084 case ast_bit_not:
1085 case ast_logic_not:
1086 case ast_pre_inc:
1087 case ast_pre_dec:
1088 printf("%s ", operator_string(oper));
1089 subexpressions[0]->print();
1090 break;
1091
1092 case ast_post_inc:
1093 case ast_post_dec:
1094 subexpressions[0]->print();
1095 printf("%s ", operator_string(oper));
1096 break;
1097
1098 case ast_conditional:
1099 subexpressions[0]->print();
1100 printf("? ");
1101 subexpressions[1]->print();
1102 printf(": ");
1103 subexpressions[2]->print();
1104 break;
1105
1106 case ast_array_index:
1107 subexpressions[0]->print();
1108 printf("[ ");
1109 subexpressions[1]->print();
1110 printf("] ");
1111 break;
1112
1113 case ast_function_call: {
1114 subexpressions[0]->print();
1115 printf("( ");
1116
1117 foreach_list_typed (ast_node, ast, link, &this->expressions) {
1118 if (&ast->link != this->expressions.get_head())
1119 printf(", ");
1120
1121 ast->print();
1122 }
1123
1124 printf(") ");
1125 break;
1126 }
1127
1128 case ast_identifier:
1129 printf("%s ", primary_expression.identifier);
1130 break;
1131
1132 case ast_int_constant:
1133 printf("%d ", primary_expression.int_constant);
1134 break;
1135
1136 case ast_uint_constant:
1137 printf("%u ", primary_expression.uint_constant);
1138 break;
1139
1140 case ast_float_constant:
1141 printf("%f ", primary_expression.float_constant);
1142 break;
1143
1144 case ast_double_constant:
1145 printf("%f ", primary_expression.double_constant);
1146 break;
1147
1148 case ast_bool_constant:
1149 printf("%s ",
1150 primary_expression.bool_constant
1151 ? "true" : "false");
1152 break;
1153
1154 case ast_sequence: {
1155 printf("( ");
1156 foreach_list_typed (ast_node, ast, link, & this->expressions) {
1157 if (&ast->link != this->expressions.get_head())
1158 printf(", ");
1159
1160 ast->print();
1161 }
1162 printf(") ");
1163 break;
1164 }
1165
1166 case ast_aggregate: {
1167 printf("{ ");
1168 foreach_list_typed (ast_node, ast, link, & this->expressions) {
1169 if (&ast->link != this->expressions.get_head())
1170 printf(", ");
1171
1172 ast->print();
1173 }
1174 printf("} ");
1175 break;
1176 }
1177
1178 default:
1179 assert(0);
1180 break;
1181 }
1182 }
1183
1184 ast_expression::ast_expression(int oper,
1185 ast_expression *ex0,
1186 ast_expression *ex1,
1187 ast_expression *ex2) :
1188 primary_expression()
1189 {
1190 this->oper = ast_operators(oper);
1191 this->subexpressions[0] = ex0;
1192 this->subexpressions[1] = ex1;
1193 this->subexpressions[2] = ex2;
1194 this->non_lvalue_description = NULL;
1195 }
1196
1197
1198 void
1199 ast_expression_statement::print(void) const
1200 {
1201 if (expression)
1202 expression->print();
1203
1204 printf("; ");
1205 }
1206
1207
1208 ast_expression_statement::ast_expression_statement(ast_expression *ex) :
1209 expression(ex)
1210 {
1211 /* empty */
1212 }
1213
1214
1215 void
1216 ast_function::print(void) const
1217 {
1218 return_type->print();
1219 printf(" %s (", identifier);
1220
1221 foreach_list_typed(ast_node, ast, link, & this->parameters) {
1222 ast->print();
1223 }
1224
1225 printf(")");
1226 }
1227
1228
1229 ast_function::ast_function(void)
1230 : return_type(NULL), identifier(NULL), is_definition(false),
1231 signature(NULL)
1232 {
1233 /* empty */
1234 }
1235
1236
1237 void
1238 ast_fully_specified_type::print(void) const
1239 {
1240 _mesa_ast_type_qualifier_print(& qualifier);
1241 specifier->print();
1242 }
1243
1244
1245 void
1246 ast_parameter_declarator::print(void) const
1247 {
1248 type->print();
1249 if (identifier)
1250 printf("%s ", identifier);
1251 ast_opt_array_dimensions_print(array_specifier);
1252 }
1253
1254
1255 void
1256 ast_function_definition::print(void) const
1257 {
1258 prototype->print();
1259 body->print();
1260 }
1261
1262
1263 void
1264 ast_declaration::print(void) const
1265 {
1266 printf("%s ", identifier);
1267 ast_opt_array_dimensions_print(array_specifier);
1268
1269 if (initializer) {
1270 printf("= ");
1271 initializer->print();
1272 }
1273 }
1274
1275
1276 ast_declaration::ast_declaration(const char *identifier,
1277 ast_array_specifier *array_specifier,
1278 ast_expression *initializer)
1279 {
1280 this->identifier = identifier;
1281 this->array_specifier = array_specifier;
1282 this->initializer = initializer;
1283 }
1284
1285
1286 void
1287 ast_declarator_list::print(void) const
1288 {
1289 assert(type || invariant);
1290
1291 if (type)
1292 type->print();
1293 else if (invariant)
1294 printf("invariant ");
1295 else
1296 printf("precise ");
1297
1298 foreach_list_typed (ast_node, ast, link, & this->declarations) {
1299 if (&ast->link != this->declarations.get_head())
1300 printf(", ");
1301
1302 ast->print();
1303 }
1304
1305 printf("; ");
1306 }
1307
1308
1309 ast_declarator_list::ast_declarator_list(ast_fully_specified_type *type)
1310 {
1311 this->type = type;
1312 this->invariant = false;
1313 this->precise = false;
1314 }
1315
1316 void
1317 ast_jump_statement::print(void) const
1318 {
1319 switch (mode) {
1320 case ast_continue:
1321 printf("continue; ");
1322 break;
1323 case ast_break:
1324 printf("break; ");
1325 break;
1326 case ast_return:
1327 printf("return ");
1328 if (opt_return_value)
1329 opt_return_value->print();
1330
1331 printf("; ");
1332 break;
1333 case ast_discard:
1334 printf("discard; ");
1335 break;
1336 }
1337 }
1338
1339
1340 ast_jump_statement::ast_jump_statement(int mode, ast_expression *return_value)
1341 : opt_return_value(NULL)
1342 {
1343 this->mode = ast_jump_modes(mode);
1344
1345 if (mode == ast_return)
1346 opt_return_value = return_value;
1347 }
1348
1349
1350 void
1351 ast_selection_statement::print(void) const
1352 {
1353 printf("if ( ");
1354 condition->print();
1355 printf(") ");
1356
1357 then_statement->print();
1358
1359 if (else_statement) {
1360 printf("else ");
1361 else_statement->print();
1362 }
1363 }
1364
1365
1366 ast_selection_statement::ast_selection_statement(ast_expression *condition,
1367 ast_node *then_statement,
1368 ast_node *else_statement)
1369 {
1370 this->condition = condition;
1371 this->then_statement = then_statement;
1372 this->else_statement = else_statement;
1373 }
1374
1375
1376 void
1377 ast_switch_statement::print(void) const
1378 {
1379 printf("switch ( ");
1380 test_expression->print();
1381 printf(") ");
1382
1383 body->print();
1384 }
1385
1386
1387 ast_switch_statement::ast_switch_statement(ast_expression *test_expression,
1388 ast_node *body)
1389 {
1390 this->test_expression = test_expression;
1391 this->body = body;
1392 }
1393
1394
1395 void
1396 ast_switch_body::print(void) const
1397 {
1398 printf("{\n");
1399 if (stmts != NULL) {
1400 stmts->print();
1401 }
1402 printf("}\n");
1403 }
1404
1405
1406 ast_switch_body::ast_switch_body(ast_case_statement_list *stmts)
1407 {
1408 this->stmts = stmts;
1409 }
1410
1411
1412 void ast_case_label::print(void) const
1413 {
1414 if (test_value != NULL) {
1415 printf("case ");
1416 test_value->print();
1417 printf(": ");
1418 } else {
1419 printf("default: ");
1420 }
1421 }
1422
1423
1424 ast_case_label::ast_case_label(ast_expression *test_value)
1425 {
1426 this->test_value = test_value;
1427 }
1428
1429
1430 void ast_case_label_list::print(void) const
1431 {
1432 foreach_list_typed(ast_node, ast, link, & this->labels) {
1433 ast->print();
1434 }
1435 printf("\n");
1436 }
1437
1438
1439 ast_case_label_list::ast_case_label_list(void)
1440 {
1441 }
1442
1443
1444 void ast_case_statement::print(void) const
1445 {
1446 labels->print();
1447 foreach_list_typed(ast_node, ast, link, & this->stmts) {
1448 ast->print();
1449 printf("\n");
1450 }
1451 }
1452
1453
1454 ast_case_statement::ast_case_statement(ast_case_label_list *labels)
1455 {
1456 this->labels = labels;
1457 }
1458
1459
1460 void ast_case_statement_list::print(void) const
1461 {
1462 foreach_list_typed(ast_node, ast, link, & this->cases) {
1463 ast->print();
1464 }
1465 }
1466
1467
1468 ast_case_statement_list::ast_case_statement_list(void)
1469 {
1470 }
1471
1472
1473 void
1474 ast_iteration_statement::print(void) const
1475 {
1476 switch (mode) {
1477 case ast_for:
1478 printf("for( ");
1479 if (init_statement)
1480 init_statement->print();
1481 printf("; ");
1482
1483 if (condition)
1484 condition->print();
1485 printf("; ");
1486
1487 if (rest_expression)
1488 rest_expression->print();
1489 printf(") ");
1490
1491 body->print();
1492 break;
1493
1494 case ast_while:
1495 printf("while ( ");
1496 if (condition)
1497 condition->print();
1498 printf(") ");
1499 body->print();
1500 break;
1501
1502 case ast_do_while:
1503 printf("do ");
1504 body->print();
1505 printf("while ( ");
1506 if (condition)
1507 condition->print();
1508 printf("); ");
1509 break;
1510 }
1511 }
1512
1513
1514 ast_iteration_statement::ast_iteration_statement(int mode,
1515 ast_node *init,
1516 ast_node *condition,
1517 ast_expression *rest_expression,
1518 ast_node *body)
1519 {
1520 this->mode = ast_iteration_modes(mode);
1521 this->init_statement = init;
1522 this->condition = condition;
1523 this->rest_expression = rest_expression;
1524 this->body = body;
1525 }
1526
1527
1528 void
1529 ast_struct_specifier::print(void) const
1530 {
1531 printf("struct %s { ", name);
1532 foreach_list_typed(ast_node, ast, link, &this->declarations) {
1533 ast->print();
1534 }
1535 printf("} ");
1536 }
1537
1538
1539 ast_struct_specifier::ast_struct_specifier(const char *identifier,
1540 ast_declarator_list *declarator_list)
1541 {
1542 if (identifier == NULL) {
1543 static mtx_t mutex = _MTX_INITIALIZER_NP;
1544 static unsigned anon_count = 1;
1545 unsigned count;
1546
1547 mtx_lock(&mutex);
1548 count = anon_count++;
1549 mtx_unlock(&mutex);
1550
1551 identifier = ralloc_asprintf(this, "#anon_struct_%04x", count);
1552 }
1553 name = identifier;
1554 this->declarations.push_degenerate_list_at_head(&declarator_list->link);
1555 is_declaration = true;
1556 }
1557
1558 void ast_subroutine_list::print(void) const
1559 {
1560 foreach_list_typed (ast_node, ast, link, & this->declarations) {
1561 if (&ast->link != this->declarations.get_head())
1562 printf(", ");
1563 ast->print();
1564 }
1565 }
1566
1567 static void
1568 set_shader_inout_layout(struct gl_shader *shader,
1569 struct _mesa_glsl_parse_state *state)
1570 {
1571 /* Should have been prevented by the parser. */
1572 if (shader->Stage == MESA_SHADER_TESS_CTRL) {
1573 assert(!state->in_qualifier->flags.i);
1574 } else if (shader->Stage == MESA_SHADER_TESS_EVAL) {
1575 assert(!state->out_qualifier->flags.i);
1576 } else if (shader->Stage != MESA_SHADER_GEOMETRY) {
1577 assert(!state->in_qualifier->flags.i);
1578 assert(!state->out_qualifier->flags.i);
1579 }
1580
1581 if (shader->Stage != MESA_SHADER_COMPUTE) {
1582 /* Should have been prevented by the parser. */
1583 assert(!state->cs_input_local_size_specified);
1584 }
1585
1586 if (shader->Stage != MESA_SHADER_FRAGMENT) {
1587 /* Should have been prevented by the parser. */
1588 assert(!state->fs_uses_gl_fragcoord);
1589 assert(!state->fs_redeclares_gl_fragcoord);
1590 assert(!state->fs_pixel_center_integer);
1591 assert(!state->fs_origin_upper_left);
1592 assert(!state->fs_early_fragment_tests);
1593 }
1594
1595 switch (shader->Stage) {
1596 case MESA_SHADER_TESS_CTRL:
1597 shader->TessCtrl.VerticesOut = 0;
1598 if (state->tcs_output_vertices_specified) {
1599 unsigned vertices;
1600 if (state->out_qualifier->vertices->
1601 process_qualifier_constant(state, "vertices", &vertices,
1602 false)) {
1603
1604 YYLTYPE loc = state->out_qualifier->vertices->get_location();
1605 if (vertices > state->Const.MaxPatchVertices) {
1606 _mesa_glsl_error(&loc, state, "vertices (%d) exceeds "
1607 "GL_MAX_PATCH_VERTICES", vertices);
1608 }
1609 shader->TessCtrl.VerticesOut = vertices;
1610 }
1611 }
1612 break;
1613 case MESA_SHADER_TESS_EVAL:
1614 shader->TessEval.PrimitiveMode = PRIM_UNKNOWN;
1615 if (state->in_qualifier->flags.q.prim_type)
1616 shader->TessEval.PrimitiveMode = state->in_qualifier->prim_type;
1617
1618 shader->TessEval.Spacing = 0;
1619 if (state->in_qualifier->flags.q.vertex_spacing)
1620 shader->TessEval.Spacing = state->in_qualifier->vertex_spacing;
1621
1622 shader->TessEval.VertexOrder = 0;
1623 if (state->in_qualifier->flags.q.ordering)
1624 shader->TessEval.VertexOrder = state->in_qualifier->ordering;
1625
1626 shader->TessEval.PointMode = -1;
1627 if (state->in_qualifier->flags.q.point_mode)
1628 shader->TessEval.PointMode = state->in_qualifier->point_mode;
1629 break;
1630 case MESA_SHADER_GEOMETRY:
1631 shader->Geom.VerticesOut = 0;
1632 if (state->out_qualifier->flags.q.max_vertices) {
1633 unsigned qual_max_vertices;
1634 if (state->out_qualifier->max_vertices->
1635 process_qualifier_constant(state, "max_vertices",
1636 &qual_max_vertices, true)) {
1637 shader->Geom.VerticesOut = qual_max_vertices;
1638 }
1639 }
1640
1641 if (state->gs_input_prim_type_specified) {
1642 shader->Geom.InputType = state->in_qualifier->prim_type;
1643 } else {
1644 shader->Geom.InputType = PRIM_UNKNOWN;
1645 }
1646
1647 if (state->out_qualifier->flags.q.prim_type) {
1648 shader->Geom.OutputType = state->out_qualifier->prim_type;
1649 } else {
1650 shader->Geom.OutputType = PRIM_UNKNOWN;
1651 }
1652
1653 shader->Geom.Invocations = 0;
1654 if (state->in_qualifier->flags.q.invocations) {
1655 unsigned invocations;
1656 if (state->in_qualifier->invocations->
1657 process_qualifier_constant(state, "invocations",
1658 &invocations, false)) {
1659
1660 YYLTYPE loc = state->in_qualifier->invocations->get_location();
1661 if (invocations > MAX_GEOMETRY_SHADER_INVOCATIONS) {
1662 _mesa_glsl_error(&loc, state,
1663 "invocations (%d) exceeds "
1664 "GL_MAX_GEOMETRY_SHADER_INVOCATIONS",
1665 invocations);
1666 }
1667 shader->Geom.Invocations = invocations;
1668 }
1669 }
1670 break;
1671
1672 case MESA_SHADER_COMPUTE:
1673 if (state->cs_input_local_size_specified) {
1674 for (int i = 0; i < 3; i++)
1675 shader->Comp.LocalSize[i] = state->cs_input_local_size[i];
1676 } else {
1677 for (int i = 0; i < 3; i++)
1678 shader->Comp.LocalSize[i] = 0;
1679 }
1680 break;
1681
1682 case MESA_SHADER_FRAGMENT:
1683 shader->redeclares_gl_fragcoord = state->fs_redeclares_gl_fragcoord;
1684 shader->uses_gl_fragcoord = state->fs_uses_gl_fragcoord;
1685 shader->pixel_center_integer = state->fs_pixel_center_integer;
1686 shader->origin_upper_left = state->fs_origin_upper_left;
1687 shader->ARB_fragment_coord_conventions_enable =
1688 state->ARB_fragment_coord_conventions_enable;
1689 shader->EarlyFragmentTests = state->fs_early_fragment_tests;
1690 break;
1691
1692 default:
1693 /* Nothing to do. */
1694 break;
1695 }
1696 }
1697
1698 extern "C" {
1699
1700 void
1701 _mesa_glsl_compile_shader(struct gl_context *ctx, struct gl_shader *shader,
1702 bool dump_ast, bool dump_hir)
1703 {
1704 struct _mesa_glsl_parse_state *state =
1705 new(shader) _mesa_glsl_parse_state(ctx, shader->Stage, shader);
1706 const char *source = shader->Source;
1707
1708 if (ctx->Const.GenerateTemporaryNames)
1709 (void) p_atomic_cmpxchg(&ir_variable::temporaries_allocate_names,
1710 false, true);
1711
1712 state->error = glcpp_preprocess(state, &source, &state->info_log,
1713 &ctx->Extensions, ctx);
1714
1715 if (!state->error) {
1716 _mesa_glsl_lexer_ctor(state, source);
1717 _mesa_glsl_parse(state);
1718 _mesa_glsl_lexer_dtor(state);
1719 }
1720
1721 if (dump_ast) {
1722 foreach_list_typed(ast_node, ast, link, &state->translation_unit) {
1723 ast->print();
1724 }
1725 printf("\n\n");
1726 }
1727
1728 ralloc_free(shader->ir);
1729 shader->ir = new(shader) exec_list;
1730 if (!state->error && !state->translation_unit.is_empty())
1731 _mesa_ast_to_hir(shader->ir, state);
1732
1733 if (!state->error) {
1734 validate_ir_tree(shader->ir);
1735
1736 /* Print out the unoptimized IR. */
1737 if (dump_hir) {
1738 _mesa_print_ir(stdout, shader->ir, state);
1739 }
1740 }
1741
1742
1743 if (!state->error && !shader->ir->is_empty()) {
1744 struct gl_shader_compiler_options *options =
1745 &ctx->Const.ShaderCompilerOptions[shader->Stage];
1746
1747 lower_subroutine(shader->ir, state);
1748 /* Do some optimization at compile time to reduce shader IR size
1749 * and reduce later work if the same shader is linked multiple times
1750 */
1751 while (do_common_optimization(shader->ir, false, false, options,
1752 ctx->Const.NativeIntegers))
1753 ;
1754
1755 validate_ir_tree(shader->ir);
1756
1757 enum ir_variable_mode other;
1758 switch (shader->Stage) {
1759 case MESA_SHADER_VERTEX:
1760 other = ir_var_shader_in;
1761 break;
1762 case MESA_SHADER_FRAGMENT:
1763 other = ir_var_shader_out;
1764 break;
1765 default:
1766 /* Something invalid to ensure optimize_dead_builtin_uniforms
1767 * doesn't remove anything other than uniforms or constants.
1768 */
1769 other = ir_var_mode_count;
1770 break;
1771 }
1772
1773 optimize_dead_builtin_variables(shader->ir, other);
1774
1775 validate_ir_tree(shader->ir);
1776 }
1777
1778 if (shader->InfoLog)
1779 ralloc_free(shader->InfoLog);
1780
1781 if (!state->error)
1782 set_shader_inout_layout(shader, state);
1783
1784 shader->symbols = new(shader->ir) glsl_symbol_table;
1785 shader->CompileStatus = !state->error;
1786 shader->InfoLog = state->info_log;
1787 shader->Version = state->language_version;
1788 shader->IsES = state->es_shader;
1789 shader->uses_builtin_functions = state->uses_builtin_functions;
1790
1791 /* Retain any live IR, but trash the rest. */
1792 reparent_ir(shader->ir, shader->ir);
1793
1794 /* Destroy the symbol table. Create a new symbol table that contains only
1795 * the variables and functions that still exist in the IR. The symbol
1796 * table will be used later during linking.
1797 *
1798 * There must NOT be any freed objects still referenced by the symbol
1799 * table. That could cause the linker to dereference freed memory.
1800 *
1801 * We don't have to worry about types or interface-types here because those
1802 * are fly-weights that are looked up by glsl_type.
1803 */
1804 foreach_in_list (ir_instruction, ir, shader->ir) {
1805 switch (ir->ir_type) {
1806 case ir_type_function:
1807 shader->symbols->add_function((ir_function *) ir);
1808 break;
1809 case ir_type_variable: {
1810 ir_variable *const var = (ir_variable *) ir;
1811
1812 if (var->data.mode != ir_var_temporary)
1813 shader->symbols->add_variable(var);
1814 break;
1815 }
1816 default:
1817 break;
1818 }
1819 }
1820
1821 _mesa_glsl_initialize_derived_variables(shader);
1822
1823 delete state->symbols;
1824 ralloc_free(state);
1825 }
1826
1827 } /* extern "C" */
1828 /**
1829 * Do the set of common optimizations passes
1830 *
1831 * \param ir List of instructions to be optimized
1832 * \param linked Is the shader linked? This enables
1833 * optimizations passes that remove code at
1834 * global scope and could cause linking to
1835 * fail.
1836 * \param uniform_locations_assigned Have locations already been assigned for
1837 * uniforms? This prevents the declarations
1838 * of unused uniforms from being removed.
1839 * The setting of this flag only matters if
1840 * \c linked is \c true.
1841 * \param max_unroll_iterations Maximum number of loop iterations to be
1842 * unrolled. Setting to 0 disables loop
1843 * unrolling.
1844 * \param options The driver's preferred shader options.
1845 */
1846 bool
1847 do_common_optimization(exec_list *ir, bool linked,
1848 bool uniform_locations_assigned,
1849 const struct gl_shader_compiler_options *options,
1850 bool native_integers)
1851 {
1852 const bool debug = false;
1853 GLboolean progress = GL_FALSE;
1854
1855 #define OPT(PASS, ...) do { \
1856 if (debug) { \
1857 fprintf(stderr, "START GLSL optimization %s\n", #PASS); \
1858 const bool opt_progress = PASS(__VA_ARGS__); \
1859 progress = opt_progress || progress; \
1860 if (opt_progress) \
1861 _mesa_print_ir(stderr, ir, NULL); \
1862 fprintf(stderr, "GLSL optimization %s: %s progress\n", \
1863 #PASS, opt_progress ? "made" : "no"); \
1864 } else { \
1865 progress = PASS(__VA_ARGS__) || progress; \
1866 } \
1867 } while (false)
1868
1869 OPT(lower_instructions, ir, SUB_TO_ADD_NEG);
1870
1871 if (linked) {
1872 OPT(do_function_inlining, ir);
1873 OPT(do_dead_functions, ir);
1874 OPT(do_structure_splitting, ir);
1875 }
1876 OPT(do_if_simplification, ir);
1877 OPT(opt_flatten_nested_if_blocks, ir);
1878 OPT(opt_conditional_discard, ir);
1879 OPT(do_copy_propagation, ir);
1880 OPT(do_copy_propagation_elements, ir);
1881
1882 if (options->OptimizeForAOS && !linked)
1883 OPT(opt_flip_matrices, ir);
1884
1885 if (linked && options->OptimizeForAOS) {
1886 OPT(do_vectorize, ir);
1887 }
1888
1889 if (linked)
1890 OPT(do_dead_code, ir, uniform_locations_assigned);
1891 else
1892 OPT(do_dead_code_unlinked, ir);
1893 OPT(do_dead_code_local, ir);
1894 OPT(do_tree_grafting, ir);
1895 OPT(do_constant_propagation, ir);
1896 if (linked)
1897 OPT(do_constant_variable, ir);
1898 else
1899 OPT(do_constant_variable_unlinked, ir);
1900 OPT(do_constant_folding, ir);
1901 OPT(do_minmax_prune, ir);
1902 OPT(do_rebalance_tree, ir);
1903 OPT(do_algebraic, ir, native_integers, options);
1904 OPT(do_lower_jumps, ir);
1905 OPT(do_vec_index_to_swizzle, ir);
1906 OPT(lower_vector_insert, ir, false);
1907 OPT(do_swizzle_swizzle, ir);
1908 OPT(do_noop_swizzle, ir);
1909
1910 OPT(optimize_split_arrays, ir, linked);
1911 OPT(optimize_redundant_jumps, ir);
1912
1913 loop_state *ls = analyze_loop_variables(ir);
1914 if (ls->loop_found) {
1915 OPT(set_loop_controls, ir, ls);
1916 OPT(unroll_loops, ir, ls, options);
1917 }
1918 delete ls;
1919
1920 #undef OPT
1921
1922 return progress;
1923 }
1924
1925 extern "C" {
1926
1927 /**
1928 * To be called at GL teardown time, this frees compiler datastructures.
1929 *
1930 * After calling this, any previously compiled shaders and shader
1931 * programs would be invalid. So this should happen at approximately
1932 * program exit.
1933 */
1934 void
1935 _mesa_destroy_shader_compiler(void)
1936 {
1937 _mesa_destroy_shader_compiler_caches();
1938
1939 _mesa_glsl_release_types();
1940 }
1941
1942 /**
1943 * Releases compiler caches to trade off performance for memory.
1944 *
1945 * Intended to be used with glReleaseShaderCompiler().
1946 */
1947 void
1948 _mesa_destroy_shader_compiler_caches(void)
1949 {
1950 _mesa_glsl_release_builtin_functions();
1951 }
1952
1953 }