2 * Copyright © 2010 Intel Corporation
4 * Permission is hereby granted, free of charge, to any person obtaining a
5 * copy of this software and associated documentation files (the "Software"),
6 * to deal in the Software without restriction, including without limitation
7 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
8 * and/or sell copies of the Software, and to permit persons to whom the
9 * Software is furnished to do so, subject to the following conditions:
11 * The above copyright notice and this permission notice (including the next
12 * paragraph) shall be included in all copies or substantial portions of the
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
18 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
21 * DEALINGS IN THE SOFTWARE.
25 #ifndef GLSL_PARSER_EXTRAS_H
26 #define GLSL_PARSER_EXTRAS_H
29 * Most of the definitions here only apply to C++
35 #include "glsl_symbol_table.h"
39 struct glsl_switch_state
{
40 /** Temporary variables needed for switch statement. */
41 ir_variable
*test_var
;
42 ir_variable
*is_fallthru_var
;
43 class ast_switch_statement
*switch_nesting_ast
;
45 /** Used to detect if 'continue' was called inside a switch. */
46 ir_variable
*continue_inside
;
48 /** Used to set condition if 'default' label should be chosen. */
49 ir_variable
*run_default
;
51 /** Table of constant values already used in case labels */
52 struct hash_table
*labels_ht
;
53 class ast_case_label
*previous_default
;
55 bool is_switch_innermost
; // if switch stmt is closest to break, ...
59 glsl_compute_version_string(void *mem_ctx
, bool is_es
, unsigned version
);
61 typedef struct YYLTYPE
{
68 # define YYLTYPE_IS_DECLARED 1
69 # define YYLTYPE_IS_TRIVIAL 1
71 extern void _mesa_glsl_error(YYLTYPE
*locp
, _mesa_glsl_parse_state
*state
,
72 const char *fmt
, ...);
75 struct _mesa_glsl_parse_state
{
76 _mesa_glsl_parse_state(struct gl_context
*_ctx
, gl_shader_stage stage
,
79 DECLARE_RALLOC_CXX_OPERATORS(_mesa_glsl_parse_state
);
82 * Generate a string representing the GLSL version currently being compiled
83 * (useful for error messages).
85 const char *get_version_string()
87 return glsl_compute_version_string(this, this->es_shader
,
88 this->language_version
);
92 * Determine whether the current GLSL version is sufficiently high to
93 * support a certain feature.
95 * \param required_glsl_version is the desktop GLSL version that is
96 * required to support the feature, or 0 if no version of desktop GLSL
97 * supports the feature.
99 * \param required_glsl_es_version is the GLSL ES version that is required
100 * to support the feature, or 0 if no version of GLSL ES suports the
103 bool is_version(unsigned required_glsl_version
,
104 unsigned required_glsl_es_version
) const
106 unsigned required_version
= this->es_shader
?
107 required_glsl_es_version
: required_glsl_version
;
108 unsigned this_version
= this->forced_language_version
109 ? this->forced_language_version
: this->language_version
;
110 return required_version
!= 0
111 && this_version
>= required_version
;
114 bool check_version(unsigned required_glsl_version
,
115 unsigned required_glsl_es_version
,
116 YYLTYPE
*locp
, const char *fmt
, ...) PRINTFLIKE(5, 6);
118 bool check_arrays_of_arrays_allowed(YYLTYPE
*locp
)
120 if (!(ARB_arrays_of_arrays_enable
|| is_version(430, 310))) {
121 const char *const requirement
= this->es_shader
123 : "GL_ARB_arrays_of_arrays or GLSL 4.30";
124 _mesa_glsl_error(locp
, this,
125 "%s required for defining arrays of arrays.",
132 bool check_precision_qualifiers_allowed(YYLTYPE
*locp
)
134 return check_version(130, 100, locp
,
135 "precision qualifiers are forbidden");
138 bool check_bitwise_operations_allowed(YYLTYPE
*locp
)
140 return check_version(130, 300, locp
, "bit-wise operations are forbidden");
143 bool check_explicit_attrib_stream_allowed(YYLTYPE
*locp
)
145 if (!this->has_explicit_attrib_stream()) {
146 const char *const requirement
= "GL_ARB_gpu_shader5 extension or GLSL 4.00";
148 _mesa_glsl_error(locp
, this, "explicit stream requires %s",
156 bool check_explicit_attrib_location_allowed(YYLTYPE
*locp
,
157 const ir_variable
*var
)
159 if (!this->has_explicit_attrib_location()) {
160 const char *const requirement
= this->es_shader
162 : "GL_ARB_explicit_attrib_location extension or GLSL 3.30";
164 _mesa_glsl_error(locp
, this, "%s explicit location requires %s",
165 mode_string(var
), requirement
);
172 bool check_separate_shader_objects_allowed(YYLTYPE
*locp
,
173 const ir_variable
*var
)
175 if (!this->has_separate_shader_objects()) {
176 const char *const requirement
= this->es_shader
177 ? "GL_EXT_separate_shader_objects extension or GLSL ES 3.10"
178 : "GL_ARB_separate_shader_objects extension or GLSL 4.20";
180 _mesa_glsl_error(locp
, this, "%s explicit location requires %s",
181 mode_string(var
), requirement
);
188 bool check_explicit_uniform_location_allowed(YYLTYPE
*locp
,
191 if (!this->has_explicit_attrib_location() ||
192 !this->has_explicit_uniform_location()) {
193 const char *const requirement
= this->es_shader
195 : "GL_ARB_explicit_uniform_location and either "
196 "GL_ARB_explicit_attrib_location or GLSL 3.30.";
198 _mesa_glsl_error(locp
, this,
199 "uniform explicit location requires %s",
207 bool has_atomic_counters() const
209 return ARB_shader_atomic_counters_enable
|| is_version(420, 310);
212 bool has_enhanced_layouts() const
214 return ARB_enhanced_layouts_enable
|| is_version(440, 0);
217 bool has_explicit_attrib_stream() const
219 return ARB_gpu_shader5_enable
|| is_version(400, 0);
222 bool has_explicit_attrib_location() const
224 return ARB_explicit_attrib_location_enable
|| is_version(330, 300);
227 bool has_explicit_uniform_location() const
229 return ARB_explicit_uniform_location_enable
|| is_version(430, 310);
232 bool has_uniform_buffer_objects() const
234 return ARB_uniform_buffer_object_enable
|| is_version(140, 300);
237 bool has_shader_storage_buffer_objects() const
239 return ARB_shader_storage_buffer_object_enable
|| is_version(430, 310);
242 bool has_separate_shader_objects() const
244 return ARB_separate_shader_objects_enable
|| is_version(410, 310)
245 || EXT_separate_shader_objects_enable
;
248 bool has_double() const
250 return ARB_gpu_shader_fp64_enable
|| is_version(400, 0);
253 bool has_420pack() const
255 return ARB_shading_language_420pack_enable
|| is_version(420, 0);
258 bool has_compute_shader() const
260 return ARB_compute_shader_enable
|| is_version(430, 310);
263 void process_version_directive(YYLTYPE
*locp
, int version
,
266 struct gl_context
*const ctx
;
268 exec_list translation_unit
;
269 glsl_symbol_table
*symbols
;
271 unsigned num_supported_versions
;
275 } supported_versions
[15];
278 unsigned language_version
;
279 unsigned forced_language_version
;
280 gl_shader_stage stage
;
283 * Number of nested struct_specifier levels
285 * Outside a struct_specifier, this is zero.
287 unsigned struct_specifier_depth
;
290 * Default uniform layout qualifiers tracked during parsing.
291 * Currently affects uniform blocks and uniform buffer variables in
294 struct ast_type_qualifier
*default_uniform_qualifier
;
297 * Default shader storage layout qualifiers tracked during parsing.
298 * Currently affects shader storage blocks and shader storage buffer
299 * variables in those blocks.
301 struct ast_type_qualifier
*default_shader_storage_qualifier
;
304 * Variables to track different cases if a fragment shader redeclares
305 * built-in variable gl_FragCoord.
307 * Note: These values are computed at ast_to_hir time rather than at parse
310 bool fs_redeclares_gl_fragcoord
;
311 bool fs_origin_upper_left
;
312 bool fs_pixel_center_integer
;
313 bool fs_redeclares_gl_fragcoord_with_no_layout_qualifiers
;
316 * True if a geometry shader input primitive type or tessellation control
317 * output vertices were specified using a layout directive.
319 * Note: these values are computed at ast_to_hir time rather than at parse
322 bool gs_input_prim_type_specified
;
323 bool tcs_output_vertices_specified
;
326 * Input layout qualifiers from GLSL 1.50 (geometry shader controls),
327 * and GLSL 4.00 (tessellation evaluation shader)
329 struct ast_type_qualifier
*in_qualifier
;
332 * True if a compute shader input local size was specified using a layout
335 * Note: this value is computed at ast_to_hir time rather than at parse
338 bool cs_input_local_size_specified
;
341 * If cs_input_local_size_specified is true, the local size that was
342 * specified. Otherwise ignored.
344 unsigned cs_input_local_size
[3];
347 * Output layout qualifiers from GLSL 1.50 (geometry shader controls),
348 * and GLSL 4.00 (tessellation control shader).
350 struct ast_type_qualifier
*out_qualifier
;
353 * Printable list of GLSL versions supported by the current context
356 * This string should probably be generated per-context instead of per
357 * invokation of the compiler. This should be changed when the method of
358 * tracking supported GLSL versions changes.
360 const char *supported_version_string
;
363 * Implementation defined limits that affect built-in variables, etc.
365 * \sa struct gl_constants (in mtypes.h)
370 unsigned MaxClipPlanes
;
371 unsigned MaxTextureUnits
;
372 unsigned MaxTextureCoords
;
373 unsigned MaxVertexAttribs
;
374 unsigned MaxVertexUniformComponents
;
375 unsigned MaxVertexTextureImageUnits
;
376 unsigned MaxCombinedTextureImageUnits
;
377 unsigned MaxTextureImageUnits
;
378 unsigned MaxFragmentUniformComponents
;
380 /* ARB_draw_buffers */
381 unsigned MaxDrawBuffers
;
384 int MinProgramTexelOffset
;
385 int MaxProgramTexelOffset
;
388 unsigned MaxVertexOutputComponents
;
389 unsigned MaxGeometryInputComponents
;
390 unsigned MaxGeometryOutputComponents
;
391 unsigned MaxFragmentInputComponents
;
392 unsigned MaxGeometryTextureImageUnits
;
393 unsigned MaxGeometryOutputVertices
;
394 unsigned MaxGeometryTotalOutputComponents
;
395 unsigned MaxGeometryUniformComponents
;
397 /* ARB_shader_atomic_counters */
398 unsigned MaxVertexAtomicCounters
;
399 unsigned MaxTessControlAtomicCounters
;
400 unsigned MaxTessEvaluationAtomicCounters
;
401 unsigned MaxGeometryAtomicCounters
;
402 unsigned MaxFragmentAtomicCounters
;
403 unsigned MaxCombinedAtomicCounters
;
404 unsigned MaxAtomicBufferBindings
;
406 /* These are also atomic counter related, but they weren't added to
407 * until atomic counters were added to core in GLSL 4.20 and GLSL ES
410 unsigned MaxVertexAtomicCounterBuffers
;
411 unsigned MaxTessControlAtomicCounterBuffers
;
412 unsigned MaxTessEvaluationAtomicCounterBuffers
;
413 unsigned MaxGeometryAtomicCounterBuffers
;
414 unsigned MaxFragmentAtomicCounterBuffers
;
415 unsigned MaxCombinedAtomicCounterBuffers
;
416 unsigned MaxAtomicCounterBufferSize
;
418 /* ARB_compute_shader */
419 unsigned MaxComputeWorkGroupCount
[3];
420 unsigned MaxComputeWorkGroupSize
[3];
422 /* ARB_shader_image_load_store */
423 unsigned MaxImageUnits
;
424 unsigned MaxCombinedShaderOutputResources
;
425 unsigned MaxImageSamples
;
426 unsigned MaxVertexImageUniforms
;
427 unsigned MaxTessControlImageUniforms
;
428 unsigned MaxTessEvaluationImageUniforms
;
429 unsigned MaxGeometryImageUniforms
;
430 unsigned MaxFragmentImageUniforms
;
431 unsigned MaxCombinedImageUniforms
;
433 /* ARB_viewport_array */
434 unsigned MaxViewports
;
436 /* ARB_tessellation_shader */
437 unsigned MaxPatchVertices
;
438 unsigned MaxTessGenLevel
;
439 unsigned MaxTessControlInputComponents
;
440 unsigned MaxTessControlOutputComponents
;
441 unsigned MaxTessControlTextureImageUnits
;
442 unsigned MaxTessEvaluationInputComponents
;
443 unsigned MaxTessEvaluationOutputComponents
;
444 unsigned MaxTessEvaluationTextureImageUnits
;
445 unsigned MaxTessPatchComponents
;
446 unsigned MaxTessControlTotalOutputComponents
;
447 unsigned MaxTessControlUniformComponents
;
448 unsigned MaxTessEvaluationUniformComponents
;
452 * During AST to IR conversion, pointer to current IR function
454 * Will be \c NULL whenever the AST to IR conversion is not inside a
455 * function definition.
457 class ir_function_signature
*current_function
;
460 * During AST to IR conversion, pointer to the toplevel IR
461 * instruction list being generated.
463 exec_list
*toplevel_ir
;
465 /** Have we found a return statement in this function? */
468 /** Was there an error during compilation? */
472 * Are all shader inputs / outputs invariant?
474 * This is set when the 'STDGL invariant(all)' pragma is used.
478 /** Loop or switch statement containing the current instructions. */
479 class ast_iteration_statement
*loop_nesting_ast
;
481 struct glsl_switch_state switch_state
;
483 /** List of structures defined in user code. */
484 const glsl_type
**user_structures
;
485 unsigned num_user_structures
;
490 * \name Enable bits for GLSL extensions
493 /* ARB extensions go here, sorted alphabetically.
495 bool ARB_arrays_of_arrays_enable
;
496 bool ARB_arrays_of_arrays_warn
;
497 bool ARB_compute_shader_enable
;
498 bool ARB_compute_shader_warn
;
499 bool ARB_conservative_depth_enable
;
500 bool ARB_conservative_depth_warn
;
501 bool ARB_derivative_control_enable
;
502 bool ARB_derivative_control_warn
;
503 bool ARB_draw_buffers_enable
;
504 bool ARB_draw_buffers_warn
;
505 bool ARB_draw_instanced_enable
;
506 bool ARB_draw_instanced_warn
;
507 bool ARB_enhanced_layouts_enable
;
508 bool ARB_enhanced_layouts_warn
;
509 bool ARB_explicit_attrib_location_enable
;
510 bool ARB_explicit_attrib_location_warn
;
511 bool ARB_explicit_uniform_location_enable
;
512 bool ARB_explicit_uniform_location_warn
;
513 bool ARB_fragment_coord_conventions_enable
;
514 bool ARB_fragment_coord_conventions_warn
;
515 bool ARB_fragment_layer_viewport_enable
;
516 bool ARB_fragment_layer_viewport_warn
;
517 bool ARB_gpu_shader5_enable
;
518 bool ARB_gpu_shader5_warn
;
519 bool ARB_gpu_shader_fp64_enable
;
520 bool ARB_gpu_shader_fp64_warn
;
521 bool ARB_sample_shading_enable
;
522 bool ARB_sample_shading_warn
;
523 bool ARB_separate_shader_objects_enable
;
524 bool ARB_separate_shader_objects_warn
;
525 bool ARB_shader_atomic_counters_enable
;
526 bool ARB_shader_atomic_counters_warn
;
527 bool ARB_shader_bit_encoding_enable
;
528 bool ARB_shader_bit_encoding_warn
;
529 bool ARB_shader_clock_enable
;
530 bool ARB_shader_clock_warn
;
531 bool ARB_shader_image_load_store_enable
;
532 bool ARB_shader_image_load_store_warn
;
533 bool ARB_shader_image_size_enable
;
534 bool ARB_shader_image_size_warn
;
535 bool ARB_shader_precision_enable
;
536 bool ARB_shader_precision_warn
;
537 bool ARB_shader_stencil_export_enable
;
538 bool ARB_shader_stencil_export_warn
;
539 bool ARB_shader_storage_buffer_object_enable
;
540 bool ARB_shader_storage_buffer_object_warn
;
541 bool ARB_shader_subroutine_enable
;
542 bool ARB_shader_subroutine_warn
;
543 bool ARB_shader_texture_image_samples_enable
;
544 bool ARB_shader_texture_image_samples_warn
;
545 bool ARB_shader_texture_lod_enable
;
546 bool ARB_shader_texture_lod_warn
;
547 bool ARB_shading_language_420pack_enable
;
548 bool ARB_shading_language_420pack_warn
;
549 bool ARB_shading_language_packing_enable
;
550 bool ARB_shading_language_packing_warn
;
551 bool ARB_tessellation_shader_enable
;
552 bool ARB_tessellation_shader_warn
;
553 bool ARB_texture_cube_map_array_enable
;
554 bool ARB_texture_cube_map_array_warn
;
555 bool ARB_texture_gather_enable
;
556 bool ARB_texture_gather_warn
;
557 bool ARB_texture_multisample_enable
;
558 bool ARB_texture_multisample_warn
;
559 bool ARB_texture_query_levels_enable
;
560 bool ARB_texture_query_levels_warn
;
561 bool ARB_texture_query_lod_enable
;
562 bool ARB_texture_query_lod_warn
;
563 bool ARB_texture_rectangle_enable
;
564 bool ARB_texture_rectangle_warn
;
565 bool ARB_uniform_buffer_object_enable
;
566 bool ARB_uniform_buffer_object_warn
;
567 bool ARB_vertex_attrib_64bit_enable
;
568 bool ARB_vertex_attrib_64bit_warn
;
569 bool ARB_viewport_array_enable
;
570 bool ARB_viewport_array_warn
;
572 /* KHR extensions go here, sorted alphabetically.
575 /* OES extensions go here, sorted alphabetically.
577 bool OES_EGL_image_external_enable
;
578 bool OES_EGL_image_external_warn
;
579 bool OES_standard_derivatives_enable
;
580 bool OES_standard_derivatives_warn
;
581 bool OES_texture_3D_enable
;
582 bool OES_texture_3D_warn
;
583 bool OES_texture_storage_multisample_2d_array_enable
;
584 bool OES_texture_storage_multisample_2d_array_warn
;
586 /* All other extensions go here, sorted alphabetically.
588 bool AMD_conservative_depth_enable
;
589 bool AMD_conservative_depth_warn
;
590 bool AMD_shader_stencil_export_enable
;
591 bool AMD_shader_stencil_export_warn
;
592 bool AMD_shader_trinary_minmax_enable
;
593 bool AMD_shader_trinary_minmax_warn
;
594 bool AMD_vertex_shader_layer_enable
;
595 bool AMD_vertex_shader_layer_warn
;
596 bool AMD_vertex_shader_viewport_index_enable
;
597 bool AMD_vertex_shader_viewport_index_warn
;
598 bool EXT_draw_buffers_enable
;
599 bool EXT_draw_buffers_warn
;
600 bool EXT_separate_shader_objects_enable
;
601 bool EXT_separate_shader_objects_warn
;
602 bool EXT_shader_integer_mix_enable
;
603 bool EXT_shader_integer_mix_warn
;
604 bool EXT_texture_array_enable
;
605 bool EXT_texture_array_warn
;
608 /** Extensions supported by the OpenGL implementation. */
609 const struct gl_extensions
*extensions
;
611 bool uses_builtin_functions
;
612 bool fs_uses_gl_fragcoord
;
615 * For geometry shaders, size of the most recently seen input declaration
616 * that was a sized array, or 0 if no sized input array declarations have
619 * Unused for other shader types.
621 unsigned gs_input_size
;
623 bool fs_early_fragment_tests
;
626 * For tessellation control shaders, size of the most recently seen output
627 * declaration that was a sized array, or 0 if no sized output array
628 * declarations have been seen.
630 * Unused for other shader types.
632 unsigned tcs_output_size
;
634 /** Atomic counter offsets by binding */
635 unsigned atomic_counter_offsets
[MAX_COMBINED_ATOMIC_BUFFERS
];
637 bool allow_extension_directive_midshader
;
640 * Known subroutine type declarations.
642 int num_subroutine_types
;
643 ir_function
**subroutine_types
;
646 * Functions that are associated with
650 ir_function
**subroutines
;
653 * field selection temporary parser storage -
654 * did the parser just parse a dot.
659 # define YYLLOC_DEFAULT(Current, Rhs, N) \
663 (Current).first_line = YYRHSLOC(Rhs, 1).first_line; \
664 (Current).first_column = YYRHSLOC(Rhs, 1).first_column; \
665 (Current).last_line = YYRHSLOC(Rhs, N).last_line; \
666 (Current).last_column = YYRHSLOC(Rhs, N).last_column; \
670 (Current).first_line = (Current).last_line = \
671 YYRHSLOC(Rhs, 0).last_line; \
672 (Current).first_column = (Current).last_column = \
673 YYRHSLOC(Rhs, 0).last_column; \
675 (Current).source = 0; \
679 * Emit a warning to the shader log
681 * \sa _mesa_glsl_error
683 extern void _mesa_glsl_warning(const YYLTYPE
*locp
,
684 _mesa_glsl_parse_state
*state
,
685 const char *fmt
, ...);
687 extern void _mesa_glsl_lexer_ctor(struct _mesa_glsl_parse_state
*state
,
690 extern void _mesa_glsl_lexer_dtor(struct _mesa_glsl_parse_state
*state
);
693 extern int _mesa_glsl_lexer_lex(union YYSTYPE
*yylval
, YYLTYPE
*yylloc
,
696 extern int _mesa_glsl_parse(struct _mesa_glsl_parse_state
*);
699 * Process elements of the #extension directive
702 * If \c name and \c behavior are valid, \c true is returned. Otherwise
703 * \c false is returned.
705 extern bool _mesa_glsl_process_extension(const char *name
, YYLTYPE
*name_locp
,
706 const char *behavior
,
707 YYLTYPE
*behavior_locp
,
708 _mesa_glsl_parse_state
*state
);
710 #endif /* __cplusplus */
714 * These definitions apply to C and C++
721 * Get the textual name of the specified shader stage (which is a
725 _mesa_shader_stage_to_string(unsigned stage
);
728 _mesa_shader_stage_to_abbrev(unsigned stage
);
730 extern int glcpp_preprocess(void *ctx
, const char **shader
, char **info_log
,
731 const struct gl_extensions
*extensions
, struct gl_context
*gl_ctx
);
733 extern void _mesa_destroy_shader_compiler(void);
734 extern void _mesa_destroy_shader_compiler_caches(void);
741 #endif /* GLSL_PARSER_EXTRAS_H */