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 ir_variable
*is_break_var
;
44 class ast_switch_statement
*switch_nesting_ast
;
46 /** Table of constant values already used in case labels */
47 struct hash_table
*labels_ht
;
48 class ast_case_label
*previous_default
;
50 bool is_switch_innermost
; // if switch stmt is closest to break, ...
54 glsl_compute_version_string(void *mem_ctx
, bool is_es
, unsigned version
);
56 typedef struct YYLTYPE
{
63 # define YYLTYPE_IS_DECLARED 1
64 # define YYLTYPE_IS_TRIVIAL 1
66 extern void _mesa_glsl_error(YYLTYPE
*locp
, _mesa_glsl_parse_state
*state
,
67 const char *fmt
, ...);
70 struct _mesa_glsl_parse_state
{
71 _mesa_glsl_parse_state(struct gl_context
*_ctx
, gl_shader_stage stage
,
74 DECLARE_RALLOC_CXX_OPERATORS(_mesa_glsl_parse_state
);
77 * Generate a string representing the GLSL version currently being compiled
78 * (useful for error messages).
80 const char *get_version_string()
82 return glsl_compute_version_string(this, this->es_shader
,
83 this->language_version
);
87 * Determine whether the current GLSL version is sufficiently high to
88 * support a certain feature.
90 * \param required_glsl_version is the desktop GLSL version that is
91 * required to support the feature, or 0 if no version of desktop GLSL
92 * supports the feature.
94 * \param required_glsl_es_version is the GLSL ES version that is required
95 * to support the feature, or 0 if no version of GLSL ES suports the
98 bool is_version(unsigned required_glsl_version
,
99 unsigned required_glsl_es_version
) const
101 unsigned required_version
= this->es_shader
?
102 required_glsl_es_version
: required_glsl_version
;
103 return required_version
!= 0
104 && this->language_version
>= required_version
;
107 bool check_version(unsigned required_glsl_version
,
108 unsigned required_glsl_es_version
,
109 YYLTYPE
*locp
, const char *fmt
, ...) PRINTFLIKE(5, 6);
111 bool check_precision_qualifiers_allowed(YYLTYPE
*locp
)
113 return check_version(130, 100, locp
,
114 "precision qualifiers are forbidden");
117 bool check_bitwise_operations_allowed(YYLTYPE
*locp
)
119 return check_version(130, 300, locp
, "bit-wise operations are forbidden");
122 bool check_explicit_attrib_location_allowed(YYLTYPE
*locp
,
123 const ir_variable
*var
)
125 if (!this->has_explicit_attrib_location()) {
126 const char *const requirement
= this->es_shader
128 : "GL_ARB_explicit_attrib_location extension or GLSL 330";
130 _mesa_glsl_error(locp
, this, "%s explicit location requires %s",
131 mode_string(var
), requirement
);
138 bool check_separate_shader_objects_allowed(YYLTYPE
*locp
,
139 const ir_variable
*var
)
141 if (!this->has_separate_shader_objects()) {
142 const char *const requirement
= this->es_shader
143 ? "GL_EXT_separate_shader_objects (not supported by this "
145 : "GL_ARB_separate_shader_objects extension or GLSL 420";
147 _mesa_glsl_error(locp
, this, "%s explicit location requires %s",
148 mode_string(var
), requirement
);
155 bool has_explicit_attrib_location() const
157 return ARB_explicit_attrib_location_enable
|| is_version(330, 300);
160 bool has_uniform_buffer_objects() const
162 return ARB_uniform_buffer_object_enable
|| is_version(140, 300);
165 bool has_separate_shader_objects() const
167 return ARB_separate_shader_objects_enable
|| is_version(410, 0);
170 void process_version_directive(YYLTYPE
*locp
, int version
,
173 struct gl_context
*const ctx
;
175 exec_list translation_unit
;
176 glsl_symbol_table
*symbols
;
178 unsigned num_uniform_blocks
;
179 unsigned uniform_block_array_size
;
180 struct gl_uniform_block
*uniform_blocks
;
182 unsigned num_supported_versions
;
186 } supported_versions
[12];
189 unsigned language_version
;
190 gl_shader_stage stage
;
193 * Number of nested struct_specifier levels
195 * Outside a struct_specifer, this is zero.
197 unsigned struct_specifier_depth
;
200 * Default uniform layout qualifiers tracked during parsing.
201 * Currently affects uniform blocks and uniform buffer variables in
204 struct ast_type_qualifier
*default_uniform_qualifier
;
207 * True if a geometry shader input primitive type was specified using a
210 * Note: this value is computed at ast_to_hir time rather than at parse
213 bool gs_input_prim_type_specified
;
215 /** Input layout qualifiers from GLSL 1.50. (geometry shader controls)*/
216 struct ast_type_qualifier
*in_qualifier
;
219 * True if a compute shader input local size was specified using a layout
222 * Note: this value is computed at ast_to_hir time rather than at parse
225 bool cs_input_local_size_specified
;
228 * If cs_input_local_size_specified is true, the local size that was
229 * specified. Otherwise ignored.
231 unsigned cs_input_local_size
[3];
233 /** Output layout qualifiers from GLSL 1.50. (geometry shader controls)*/
234 struct ast_type_qualifier
*out_qualifier
;
237 * Printable list of GLSL versions supported by the current context
240 * This string should probably be generated per-context instead of per
241 * invokation of the compiler. This should be changed when the method of
242 * tracking supported GLSL versions changes.
244 const char *supported_version_string
;
247 * Implementation defined limits that affect built-in variables, etc.
249 * \sa struct gl_constants (in mtypes.h)
254 unsigned MaxClipPlanes
;
255 unsigned MaxTextureUnits
;
256 unsigned MaxTextureCoords
;
257 unsigned MaxVertexAttribs
;
258 unsigned MaxVertexUniformComponents
;
259 unsigned MaxVertexTextureImageUnits
;
260 unsigned MaxCombinedTextureImageUnits
;
261 unsigned MaxTextureImageUnits
;
262 unsigned MaxFragmentUniformComponents
;
264 /* ARB_draw_buffers */
265 unsigned MaxDrawBuffers
;
268 int MinProgramTexelOffset
;
269 int MaxProgramTexelOffset
;
272 unsigned MaxVertexOutputComponents
;
273 unsigned MaxGeometryInputComponents
;
274 unsigned MaxGeometryOutputComponents
;
275 unsigned MaxFragmentInputComponents
;
276 unsigned MaxGeometryTextureImageUnits
;
277 unsigned MaxGeometryOutputVertices
;
278 unsigned MaxGeometryTotalOutputComponents
;
279 unsigned MaxGeometryUniformComponents
;
281 /* ARB_shader_atomic_counters */
282 unsigned MaxVertexAtomicCounters
;
283 unsigned MaxGeometryAtomicCounters
;
284 unsigned MaxFragmentAtomicCounters
;
285 unsigned MaxCombinedAtomicCounters
;
286 unsigned MaxAtomicBufferBindings
;
288 /* ARB_compute_shader */
289 unsigned MaxComputeWorkGroupCount
[3];
290 unsigned MaxComputeWorkGroupSize
[3];
292 /* ARB_shader_image_load_store */
293 unsigned MaxImageUnits
;
294 unsigned MaxCombinedImageUnitsAndFragmentOutputs
;
295 unsigned MaxImageSamples
;
296 unsigned MaxVertexImageUniforms
;
297 unsigned MaxGeometryImageUniforms
;
298 unsigned MaxFragmentImageUniforms
;
299 unsigned MaxCombinedImageUniforms
;
303 * During AST to IR conversion, pointer to current IR function
305 * Will be \c NULL whenever the AST to IR conversion is not inside a
306 * function definition.
308 class ir_function_signature
*current_function
;
311 * During AST to IR conversion, pointer to the toplevel IR
312 * instruction list being generated.
314 exec_list
*toplevel_ir
;
316 /** Have we found a return statement in this function? */
319 /** Was there an error during compilation? */
323 * Are all shader inputs / outputs invariant?
325 * This is set when the 'STDGL invariant(all)' pragma is used.
329 /** Loop or switch statement containing the current instructions. */
330 class ast_iteration_statement
*loop_nesting_ast
;
332 struct glsl_switch_state switch_state
;
334 /** List of structures defined in user code. */
335 const glsl_type
**user_structures
;
336 unsigned num_user_structures
;
341 * \name Enable bits for GLSL extensions
344 bool ARB_arrays_of_arrays_enable
;
345 bool ARB_arrays_of_arrays_warn
;
346 bool ARB_draw_buffers_enable
;
347 bool ARB_draw_buffers_warn
;
348 bool ARB_draw_instanced_enable
;
349 bool ARB_draw_instanced_warn
;
350 bool ARB_explicit_attrib_location_enable
;
351 bool ARB_explicit_attrib_location_warn
;
352 bool ARB_fragment_coord_conventions_enable
;
353 bool ARB_fragment_coord_conventions_warn
;
354 bool ARB_texture_rectangle_enable
;
355 bool ARB_texture_rectangle_warn
;
356 bool ARB_texture_gather_enable
;
357 bool ARB_texture_gather_warn
;
358 bool EXT_texture_array_enable
;
359 bool EXT_texture_array_warn
;
360 bool ARB_separate_shader_objects_enable
;
361 bool ARB_separate_shader_objects_warn
;
362 bool ARB_shader_texture_lod_enable
;
363 bool ARB_shader_texture_lod_warn
;
364 bool ARB_shader_stencil_export_enable
;
365 bool ARB_shader_stencil_export_warn
;
366 bool AMD_conservative_depth_enable
;
367 bool AMD_conservative_depth_warn
;
368 bool ARB_conservative_depth_enable
;
369 bool ARB_conservative_depth_warn
;
370 bool AMD_shader_stencil_export_enable
;
371 bool AMD_shader_stencil_export_warn
;
372 bool OES_texture_3D_enable
;
373 bool OES_texture_3D_warn
;
374 bool OES_EGL_image_external_enable
;
375 bool OES_EGL_image_external_warn
;
376 bool ARB_shader_bit_encoding_enable
;
377 bool ARB_shader_bit_encoding_warn
;
378 bool ARB_uniform_buffer_object_enable
;
379 bool ARB_uniform_buffer_object_warn
;
380 bool OES_standard_derivatives_enable
;
381 bool OES_standard_derivatives_warn
;
382 bool ARB_texture_cube_map_array_enable
;
383 bool ARB_texture_cube_map_array_warn
;
384 bool ARB_shading_language_packing_enable
;
385 bool ARB_shading_language_packing_warn
;
386 bool ARB_texture_multisample_enable
;
387 bool ARB_texture_multisample_warn
;
388 bool ARB_texture_query_levels_enable
;
389 bool ARB_texture_query_levels_warn
;
390 bool ARB_texture_query_lod_enable
;
391 bool ARB_texture_query_lod_warn
;
392 bool ARB_gpu_shader5_enable
;
393 bool ARB_gpu_shader5_warn
;
394 bool AMD_vertex_shader_layer_enable
;
395 bool AMD_vertex_shader_layer_warn
;
396 bool ARB_shading_language_420pack_enable
;
397 bool ARB_shading_language_420pack_warn
;
398 bool ARB_sample_shading_enable
;
399 bool ARB_sample_shading_warn
;
400 bool EXT_shader_integer_mix_enable
;
401 bool EXT_shader_integer_mix_warn
;
402 bool ARB_shader_atomic_counters_enable
;
403 bool ARB_shader_atomic_counters_warn
;
404 bool AMD_shader_trinary_minmax_enable
;
405 bool AMD_shader_trinary_minmax_warn
;
406 bool ARB_viewport_array_enable
;
407 bool ARB_viewport_array_warn
;
408 bool ARB_compute_shader_enable
;
409 bool ARB_compute_shader_warn
;
410 bool ARB_shader_image_load_store_enable
;
411 bool ARB_shader_image_load_store_warn
;
414 /** Extensions supported by the OpenGL implementation. */
415 const struct gl_extensions
*extensions
;
417 bool uses_builtin_functions
;
420 * For geometry shaders, size of the most recently seen input declaration
421 * that was a sized array, or 0 if no sized input array declarations have
424 * Unused for other shader types.
426 unsigned gs_input_size
;
428 bool early_fragment_tests
;
430 /** Atomic counter offsets by binding */
431 unsigned atomic_counter_offsets
[MAX_COMBINED_ATOMIC_BUFFERS
];
434 # define YYLLOC_DEFAULT(Current, Rhs, N) \
438 (Current).first_line = YYRHSLOC(Rhs, 1).first_line; \
439 (Current).first_column = YYRHSLOC(Rhs, 1).first_column; \
440 (Current).last_line = YYRHSLOC(Rhs, N).last_line; \
441 (Current).last_column = YYRHSLOC(Rhs, N).last_column; \
445 (Current).first_line = (Current).last_line = \
446 YYRHSLOC(Rhs, 0).last_line; \
447 (Current).first_column = (Current).last_column = \
448 YYRHSLOC(Rhs, 0).last_column; \
450 (Current).source = 0; \
454 * Emit a warning to the shader log
456 * \sa _mesa_glsl_error
458 extern void _mesa_glsl_warning(const YYLTYPE
*locp
,
459 _mesa_glsl_parse_state
*state
,
460 const char *fmt
, ...);
462 extern void _mesa_glsl_lexer_ctor(struct _mesa_glsl_parse_state
*state
,
465 extern void _mesa_glsl_lexer_dtor(struct _mesa_glsl_parse_state
*state
);
468 extern int _mesa_glsl_lexer_lex(union YYSTYPE
*yylval
, YYLTYPE
*yylloc
,
471 extern int _mesa_glsl_parse(struct _mesa_glsl_parse_state
*);
474 * Process elements of the #extension directive
477 * If \c name and \c behavior are valid, \c true is returned. Otherwise
478 * \c false is returned.
480 extern bool _mesa_glsl_process_extension(const char *name
, YYLTYPE
*name_locp
,
481 const char *behavior
,
482 YYLTYPE
*behavior_locp
,
483 _mesa_glsl_parse_state
*state
);
485 #endif /* __cplusplus */
489 * These definitions apply to C and C++
496 * Get the textual name of the specified shader stage (which is a
500 _mesa_shader_stage_to_string(unsigned stage
);
502 extern int glcpp_preprocess(void *ctx
, const char **shader
, char **info_log
,
503 const struct gl_extensions
*extensions
, struct gl_context
*gl_ctx
);
505 extern void _mesa_destroy_shader_compiler(void);
506 extern void _mesa_destroy_shader_compiler_caches(void);
513 #endif /* GLSL_PARSER_EXTRAS_H */