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_precision_qualifiers_allowed(YYLTYPE
*locp
)
120 return check_version(130, 100, locp
,
121 "precision qualifiers are forbidden");
124 bool check_bitwise_operations_allowed(YYLTYPE
*locp
)
126 return check_version(130, 300, locp
, "bit-wise operations are forbidden");
129 bool check_explicit_attrib_stream_allowed(YYLTYPE
*locp
)
131 if (!this->has_explicit_attrib_stream()) {
132 const char *const requirement
= "GL_ARB_gpu_shader5 extension or GLSL 4.00";
134 _mesa_glsl_error(locp
, this, "explicit stream requires %s",
142 bool check_explicit_attrib_location_allowed(YYLTYPE
*locp
,
143 const ir_variable
*var
)
145 if (!this->has_explicit_attrib_location()) {
146 const char *const requirement
= this->es_shader
148 : "GL_ARB_explicit_attrib_location extension or GLSL 3.30";
150 _mesa_glsl_error(locp
, this, "%s explicit location requires %s",
151 mode_string(var
), requirement
);
158 bool check_separate_shader_objects_allowed(YYLTYPE
*locp
,
159 const ir_variable
*var
)
161 if (!this->has_separate_shader_objects()) {
162 const char *const requirement
= this->es_shader
163 ? "GL_EXT_separate_shader_objects extension or GLSL ES 3.10"
164 : "GL_ARB_separate_shader_objects extension or GLSL 4.20";
166 _mesa_glsl_error(locp
, this, "%s explicit location requires %s",
167 mode_string(var
), requirement
);
174 bool check_explicit_uniform_location_allowed(YYLTYPE
*locp
,
177 if (!this->has_explicit_attrib_location() ||
178 !this->has_explicit_uniform_location()) {
179 const char *const requirement
= this->es_shader
181 : "GL_ARB_explicit_uniform_location and either "
182 "GL_ARB_explicit_attrib_location or GLSL 3.30.";
184 _mesa_glsl_error(locp
, this,
185 "uniform explicit location requires %s",
193 bool has_atomic_counters() const
195 return ARB_shader_atomic_counters_enable
|| is_version(420, 310);
198 bool has_explicit_attrib_stream() const
200 return ARB_gpu_shader5_enable
|| is_version(400, 0);
203 bool has_explicit_attrib_location() const
205 return ARB_explicit_attrib_location_enable
|| is_version(330, 300);
208 bool has_explicit_uniform_location() const
210 return ARB_explicit_uniform_location_enable
|| is_version(430, 310);
213 bool has_uniform_buffer_objects() const
215 return ARB_uniform_buffer_object_enable
|| is_version(140, 300);
218 bool has_shader_storage_buffer_objects() const
220 return ARB_shader_storage_buffer_object_enable
|| is_version(430, 0);
223 bool has_separate_shader_objects() const
225 return ARB_separate_shader_objects_enable
|| is_version(410, 310)
226 || EXT_separate_shader_objects_enable
;
229 bool has_double() const
231 return ARB_gpu_shader_fp64_enable
|| is_version(400, 0);
234 void process_version_directive(YYLTYPE
*locp
, int version
,
237 struct gl_context
*const ctx
;
239 exec_list translation_unit
;
240 glsl_symbol_table
*symbols
;
242 unsigned num_supported_versions
;
246 } supported_versions
[15];
249 unsigned language_version
;
250 unsigned forced_language_version
;
251 gl_shader_stage stage
;
254 * Number of nested struct_specifier levels
256 * Outside a struct_specifier, this is zero.
258 unsigned struct_specifier_depth
;
261 * Default uniform layout qualifiers tracked during parsing.
262 * Currently affects uniform blocks and uniform buffer variables in
265 struct ast_type_qualifier
*default_uniform_qualifier
;
268 * Variables to track different cases if a fragment shader redeclares
269 * built-in variable gl_FragCoord.
271 * Note: These values are computed at ast_to_hir time rather than at parse
274 bool fs_redeclares_gl_fragcoord
;
275 bool fs_origin_upper_left
;
276 bool fs_pixel_center_integer
;
277 bool fs_redeclares_gl_fragcoord_with_no_layout_qualifiers
;
280 * True if a geometry shader input primitive type or tessellation control
281 * output vertices were specified using a layout directive.
283 * Note: these values are computed at ast_to_hir time rather than at parse
286 bool gs_input_prim_type_specified
;
287 bool tcs_output_vertices_specified
;
290 * Input layout qualifiers from GLSL 1.50 (geometry shader controls),
291 * and GLSL 4.00 (tessellation evaluation shader)
293 struct ast_type_qualifier
*in_qualifier
;
296 * True if a compute shader input local size was specified using a layout
299 * Note: this value is computed at ast_to_hir time rather than at parse
302 bool cs_input_local_size_specified
;
305 * If cs_input_local_size_specified is true, the local size that was
306 * specified. Otherwise ignored.
308 unsigned cs_input_local_size
[3];
311 * Output layout qualifiers from GLSL 1.50 (geometry shader controls),
312 * and GLSL 4.00 (tessellation control shader).
314 struct ast_type_qualifier
*out_qualifier
;
317 * Printable list of GLSL versions supported by the current context
320 * This string should probably be generated per-context instead of per
321 * invokation of the compiler. This should be changed when the method of
322 * tracking supported GLSL versions changes.
324 const char *supported_version_string
;
327 * Implementation defined limits that affect built-in variables, etc.
329 * \sa struct gl_constants (in mtypes.h)
334 unsigned MaxClipPlanes
;
335 unsigned MaxTextureUnits
;
336 unsigned MaxTextureCoords
;
337 unsigned MaxVertexAttribs
;
338 unsigned MaxVertexUniformComponents
;
339 unsigned MaxVertexTextureImageUnits
;
340 unsigned MaxCombinedTextureImageUnits
;
341 unsigned MaxTextureImageUnits
;
342 unsigned MaxFragmentUniformComponents
;
344 /* ARB_draw_buffers */
345 unsigned MaxDrawBuffers
;
348 int MinProgramTexelOffset
;
349 int MaxProgramTexelOffset
;
352 unsigned MaxVertexOutputComponents
;
353 unsigned MaxGeometryInputComponents
;
354 unsigned MaxGeometryOutputComponents
;
355 unsigned MaxFragmentInputComponents
;
356 unsigned MaxGeometryTextureImageUnits
;
357 unsigned MaxGeometryOutputVertices
;
358 unsigned MaxGeometryTotalOutputComponents
;
359 unsigned MaxGeometryUniformComponents
;
361 /* ARB_shader_atomic_counters */
362 unsigned MaxVertexAtomicCounters
;
363 unsigned MaxGeometryAtomicCounters
;
364 unsigned MaxFragmentAtomicCounters
;
365 unsigned MaxCombinedAtomicCounters
;
366 unsigned MaxAtomicBufferBindings
;
368 /* These are also atomic counter related, but they weren't added to
369 * until atomic counters were added to core in GLSL 4.20 and GLSL ES
372 unsigned MaxVertexAtomicCounterBuffers
;
373 unsigned MaxGeometryAtomicCounterBuffers
;
374 unsigned MaxFragmentAtomicCounterBuffers
;
375 unsigned MaxCombinedAtomicCounterBuffers
;
376 unsigned MaxAtomicCounterBufferSize
;
378 /* ARB_compute_shader */
379 unsigned MaxComputeWorkGroupCount
[3];
380 unsigned MaxComputeWorkGroupSize
[3];
382 /* ARB_shader_image_load_store */
383 unsigned MaxImageUnits
;
384 unsigned MaxCombinedImageUnitsAndFragmentOutputs
;
385 unsigned MaxImageSamples
;
386 unsigned MaxVertexImageUniforms
;
387 unsigned MaxGeometryImageUniforms
;
388 unsigned MaxFragmentImageUniforms
;
389 unsigned MaxCombinedImageUniforms
;
391 /* ARB_viewport_array */
392 unsigned MaxViewports
;
394 /* ARB_tessellation_shader */
395 unsigned MaxPatchVertices
;
399 * During AST to IR conversion, pointer to current IR function
401 * Will be \c NULL whenever the AST to IR conversion is not inside a
402 * function definition.
404 class ir_function_signature
*current_function
;
407 * During AST to IR conversion, pointer to the toplevel IR
408 * instruction list being generated.
410 exec_list
*toplevel_ir
;
412 /** Have we found a return statement in this function? */
415 /** Was there an error during compilation? */
419 * Are all shader inputs / outputs invariant?
421 * This is set when the 'STDGL invariant(all)' pragma is used.
425 /** Loop or switch statement containing the current instructions. */
426 class ast_iteration_statement
*loop_nesting_ast
;
428 struct glsl_switch_state switch_state
;
430 /** List of structures defined in user code. */
431 const glsl_type
**user_structures
;
432 unsigned num_user_structures
;
437 * \name Enable bits for GLSL extensions
440 /* ARB extensions go here, sorted alphabetically.
442 bool ARB_arrays_of_arrays_enable
;
443 bool ARB_arrays_of_arrays_warn
;
444 bool ARB_compute_shader_enable
;
445 bool ARB_compute_shader_warn
;
446 bool ARB_conservative_depth_enable
;
447 bool ARB_conservative_depth_warn
;
448 bool ARB_derivative_control_enable
;
449 bool ARB_derivative_control_warn
;
450 bool ARB_draw_buffers_enable
;
451 bool ARB_draw_buffers_warn
;
452 bool ARB_draw_instanced_enable
;
453 bool ARB_draw_instanced_warn
;
454 bool ARB_explicit_attrib_location_enable
;
455 bool ARB_explicit_attrib_location_warn
;
456 bool ARB_explicit_uniform_location_enable
;
457 bool ARB_explicit_uniform_location_warn
;
458 bool ARB_fragment_coord_conventions_enable
;
459 bool ARB_fragment_coord_conventions_warn
;
460 bool ARB_fragment_layer_viewport_enable
;
461 bool ARB_fragment_layer_viewport_warn
;
462 bool ARB_gpu_shader5_enable
;
463 bool ARB_gpu_shader5_warn
;
464 bool ARB_gpu_shader_fp64_enable
;
465 bool ARB_gpu_shader_fp64_warn
;
466 bool ARB_sample_shading_enable
;
467 bool ARB_sample_shading_warn
;
468 bool ARB_separate_shader_objects_enable
;
469 bool ARB_separate_shader_objects_warn
;
470 bool ARB_shader_atomic_counters_enable
;
471 bool ARB_shader_atomic_counters_warn
;
472 bool ARB_shader_bit_encoding_enable
;
473 bool ARB_shader_bit_encoding_warn
;
474 bool ARB_shader_image_load_store_enable
;
475 bool ARB_shader_image_load_store_warn
;
476 bool ARB_shader_precision_enable
;
477 bool ARB_shader_precision_warn
;
478 bool ARB_shader_stencil_export_enable
;
479 bool ARB_shader_stencil_export_warn
;
480 bool ARB_shader_storage_buffer_object_enable
;
481 bool ARB_shader_storage_buffer_object_warn
;
482 bool ARB_shader_texture_lod_enable
;
483 bool ARB_shader_texture_lod_warn
;
484 bool ARB_shading_language_420pack_enable
;
485 bool ARB_shading_language_420pack_warn
;
486 bool ARB_shading_language_packing_enable
;
487 bool ARB_shading_language_packing_warn
;
488 bool ARB_tessellation_shader_enable
;
489 bool ARB_tessellation_shader_warn
;
490 bool ARB_texture_cube_map_array_enable
;
491 bool ARB_texture_cube_map_array_warn
;
492 bool ARB_texture_gather_enable
;
493 bool ARB_texture_gather_warn
;
494 bool ARB_texture_multisample_enable
;
495 bool ARB_texture_multisample_warn
;
496 bool ARB_texture_query_levels_enable
;
497 bool ARB_texture_query_levels_warn
;
498 bool ARB_texture_query_lod_enable
;
499 bool ARB_texture_query_lod_warn
;
500 bool ARB_texture_rectangle_enable
;
501 bool ARB_texture_rectangle_warn
;
502 bool ARB_uniform_buffer_object_enable
;
503 bool ARB_uniform_buffer_object_warn
;
504 bool ARB_vertex_attrib_64bit_enable
;
505 bool ARB_vertex_attrib_64bit_warn
;
506 bool ARB_viewport_array_enable
;
507 bool ARB_viewport_array_warn
;
509 /* KHR extensions go here, sorted alphabetically.
512 /* OES extensions go here, sorted alphabetically.
514 bool OES_EGL_image_external_enable
;
515 bool OES_EGL_image_external_warn
;
516 bool OES_standard_derivatives_enable
;
517 bool OES_standard_derivatives_warn
;
518 bool OES_texture_3D_enable
;
519 bool OES_texture_3D_warn
;
521 /* All other extensions go here, sorted alphabetically.
523 bool AMD_conservative_depth_enable
;
524 bool AMD_conservative_depth_warn
;
525 bool AMD_shader_stencil_export_enable
;
526 bool AMD_shader_stencil_export_warn
;
527 bool AMD_shader_trinary_minmax_enable
;
528 bool AMD_shader_trinary_minmax_warn
;
529 bool AMD_vertex_shader_layer_enable
;
530 bool AMD_vertex_shader_layer_warn
;
531 bool AMD_vertex_shader_viewport_index_enable
;
532 bool AMD_vertex_shader_viewport_index_warn
;
533 bool EXT_draw_buffers_enable
;
534 bool EXT_draw_buffers_warn
;
535 bool EXT_separate_shader_objects_enable
;
536 bool EXT_separate_shader_objects_warn
;
537 bool EXT_shader_integer_mix_enable
;
538 bool EXT_shader_integer_mix_warn
;
539 bool EXT_texture_array_enable
;
540 bool EXT_texture_array_warn
;
543 /** Extensions supported by the OpenGL implementation. */
544 const struct gl_extensions
*extensions
;
546 bool uses_builtin_functions
;
547 bool fs_uses_gl_fragcoord
;
550 * For geometry shaders, size of the most recently seen input declaration
551 * that was a sized array, or 0 if no sized input array declarations have
554 * Unused for other shader types.
556 unsigned gs_input_size
;
558 bool fs_early_fragment_tests
;
561 * For tessellation control shaders, size of the most recently seen output
562 * declaration that was a sized array, or 0 if no sized output array
563 * declarations have been seen.
565 * Unused for other shader types.
567 unsigned tcs_output_size
;
569 /** Atomic counter offsets by binding */
570 unsigned atomic_counter_offsets
[MAX_COMBINED_ATOMIC_BUFFERS
];
572 bool allow_extension_directive_midshader
;
575 # define YYLLOC_DEFAULT(Current, Rhs, N) \
579 (Current).first_line = YYRHSLOC(Rhs, 1).first_line; \
580 (Current).first_column = YYRHSLOC(Rhs, 1).first_column; \
581 (Current).last_line = YYRHSLOC(Rhs, N).last_line; \
582 (Current).last_column = YYRHSLOC(Rhs, N).last_column; \
586 (Current).first_line = (Current).last_line = \
587 YYRHSLOC(Rhs, 0).last_line; \
588 (Current).first_column = (Current).last_column = \
589 YYRHSLOC(Rhs, 0).last_column; \
591 (Current).source = 0; \
595 * Emit a warning to the shader log
597 * \sa _mesa_glsl_error
599 extern void _mesa_glsl_warning(const YYLTYPE
*locp
,
600 _mesa_glsl_parse_state
*state
,
601 const char *fmt
, ...);
603 extern void _mesa_glsl_lexer_ctor(struct _mesa_glsl_parse_state
*state
,
606 extern void _mesa_glsl_lexer_dtor(struct _mesa_glsl_parse_state
*state
);
609 extern int _mesa_glsl_lexer_lex(union YYSTYPE
*yylval
, YYLTYPE
*yylloc
,
612 extern int _mesa_glsl_parse(struct _mesa_glsl_parse_state
*);
615 * Process elements of the #extension directive
618 * If \c name and \c behavior are valid, \c true is returned. Otherwise
619 * \c false is returned.
621 extern bool _mesa_glsl_process_extension(const char *name
, YYLTYPE
*name_locp
,
622 const char *behavior
,
623 YYLTYPE
*behavior_locp
,
624 _mesa_glsl_parse_state
*state
);
626 #endif /* __cplusplus */
630 * These definitions apply to C and C++
637 * Get the textual name of the specified shader stage (which is a
641 _mesa_shader_stage_to_string(unsigned stage
);
644 _mesa_shader_stage_to_abbrev(unsigned stage
);
646 extern int glcpp_preprocess(void *ctx
, const char **shader
, char **info_log
,
647 const struct gl_extensions
*extensions
, struct gl_context
*gl_ctx
);
649 extern void _mesa_destroy_shader_compiler(void);
650 extern void _mesa_destroy_shader_compiler_caches(void);
657 #endif /* GLSL_PARSER_EXTRAS_H */