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