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