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 extension"
144 : "GL_ARB_separate_shader_objects extension or GLSL 420";
146 _mesa_glsl_error(locp
, this, "%s explicit location requires %s",
147 mode_string(var
), requirement
);
154 bool has_explicit_attrib_location() const
156 return ARB_explicit_attrib_location_enable
|| is_version(330, 300);
159 bool has_uniform_buffer_objects() const
161 return ARB_uniform_buffer_object_enable
|| is_version(140, 300);
164 bool has_separate_shader_objects() const
166 return ARB_separate_shader_objects_enable
|| is_version(410, 0)
167 || EXT_separate_shader_objects_enable
;
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_supported_versions
;
182 } supported_versions
[12];
185 unsigned language_version
;
186 gl_shader_stage stage
;
189 * Number of nested struct_specifier levels
191 * Outside a struct_specifer, this is zero.
193 unsigned struct_specifier_depth
;
196 * Default uniform layout qualifiers tracked during parsing.
197 * Currently affects uniform blocks and uniform buffer variables in
200 struct ast_type_qualifier
*default_uniform_qualifier
;
203 * Variables to track different cases if a fragment shader redeclares
204 * built-in variable gl_FragCoord.
206 * Note: These values are computed at ast_to_hir time rather than at parse
209 bool fs_redeclares_gl_fragcoord
;
210 bool fs_origin_upper_left
;
211 bool fs_pixel_center_integer
;
212 bool fs_redeclares_gl_fragcoord_with_no_layout_qualifiers
;
215 * True if a geometry shader input primitive type was specified using a
218 * Note: this value is computed at ast_to_hir time rather than at parse
221 bool gs_input_prim_type_specified
;
223 /** Input layout qualifiers from GLSL 1.50. (geometry shader controls)*/
224 struct ast_type_qualifier
*in_qualifier
;
227 * True if a compute shader input local size was specified using a layout
230 * Note: this value is computed at ast_to_hir time rather than at parse
233 bool cs_input_local_size_specified
;
236 * If cs_input_local_size_specified is true, the local size that was
237 * specified. Otherwise ignored.
239 unsigned cs_input_local_size
[3];
241 /** Output layout qualifiers from GLSL 1.50. (geometry shader controls)*/
242 struct ast_type_qualifier
*out_qualifier
;
245 * Printable list of GLSL versions supported by the current context
248 * This string should probably be generated per-context instead of per
249 * invokation of the compiler. This should be changed when the method of
250 * tracking supported GLSL versions changes.
252 const char *supported_version_string
;
255 * Implementation defined limits that affect built-in variables, etc.
257 * \sa struct gl_constants (in mtypes.h)
262 unsigned MaxClipPlanes
;
263 unsigned MaxTextureUnits
;
264 unsigned MaxTextureCoords
;
265 unsigned MaxVertexAttribs
;
266 unsigned MaxVertexUniformComponents
;
267 unsigned MaxVertexTextureImageUnits
;
268 unsigned MaxCombinedTextureImageUnits
;
269 unsigned MaxTextureImageUnits
;
270 unsigned MaxFragmentUniformComponents
;
272 /* ARB_draw_buffers */
273 unsigned MaxDrawBuffers
;
276 int MinProgramTexelOffset
;
277 int MaxProgramTexelOffset
;
280 unsigned MaxVertexOutputComponents
;
281 unsigned MaxGeometryInputComponents
;
282 unsigned MaxGeometryOutputComponents
;
283 unsigned MaxFragmentInputComponents
;
284 unsigned MaxGeometryTextureImageUnits
;
285 unsigned MaxGeometryOutputVertices
;
286 unsigned MaxGeometryTotalOutputComponents
;
287 unsigned MaxGeometryUniformComponents
;
289 /* ARB_shader_atomic_counters */
290 unsigned MaxVertexAtomicCounters
;
291 unsigned MaxGeometryAtomicCounters
;
292 unsigned MaxFragmentAtomicCounters
;
293 unsigned MaxCombinedAtomicCounters
;
294 unsigned MaxAtomicBufferBindings
;
296 /* ARB_compute_shader */
297 unsigned MaxComputeWorkGroupCount
[3];
298 unsigned MaxComputeWorkGroupSize
[3];
300 /* ARB_shader_image_load_store */
301 unsigned MaxImageUnits
;
302 unsigned MaxCombinedImageUnitsAndFragmentOutputs
;
303 unsigned MaxImageSamples
;
304 unsigned MaxVertexImageUniforms
;
305 unsigned MaxGeometryImageUniforms
;
306 unsigned MaxFragmentImageUniforms
;
307 unsigned MaxCombinedImageUniforms
;
311 * During AST to IR conversion, pointer to current IR function
313 * Will be \c NULL whenever the AST to IR conversion is not inside a
314 * function definition.
316 class ir_function_signature
*current_function
;
319 * During AST to IR conversion, pointer to the toplevel IR
320 * instruction list being generated.
322 exec_list
*toplevel_ir
;
324 /** Have we found a return statement in this function? */
327 /** Was there an error during compilation? */
331 * Are all shader inputs / outputs invariant?
333 * This is set when the 'STDGL invariant(all)' pragma is used.
337 /** Loop or switch statement containing the current instructions. */
338 class ast_iteration_statement
*loop_nesting_ast
;
340 struct glsl_switch_state switch_state
;
342 /** List of structures defined in user code. */
343 const glsl_type
**user_structures
;
344 unsigned num_user_structures
;
349 * \name Enable bits for GLSL extensions
352 /* ARB extensions go here, sorted alphabetically.
354 bool ARB_arrays_of_arrays_enable
;
355 bool ARB_arrays_of_arrays_warn
;
356 bool ARB_compute_shader_enable
;
357 bool ARB_compute_shader_warn
;
358 bool ARB_conservative_depth_enable
;
359 bool ARB_conservative_depth_warn
;
360 bool ARB_draw_buffers_enable
;
361 bool ARB_draw_buffers_warn
;
362 bool ARB_draw_instanced_enable
;
363 bool ARB_draw_instanced_warn
;
364 bool ARB_explicit_attrib_location_enable
;
365 bool ARB_explicit_attrib_location_warn
;
366 bool ARB_fragment_coord_conventions_enable
;
367 bool ARB_fragment_coord_conventions_warn
;
368 bool ARB_gpu_shader5_enable
;
369 bool ARB_gpu_shader5_warn
;
370 bool ARB_sample_shading_enable
;
371 bool ARB_sample_shading_warn
;
372 bool ARB_separate_shader_objects_enable
;
373 bool ARB_separate_shader_objects_warn
;
374 bool ARB_shader_atomic_counters_enable
;
375 bool ARB_shader_atomic_counters_warn
;
376 bool ARB_shader_bit_encoding_enable
;
377 bool ARB_shader_bit_encoding_warn
;
378 bool ARB_shader_image_load_store_enable
;
379 bool ARB_shader_image_load_store_warn
;
380 bool ARB_shader_stencil_export_enable
;
381 bool ARB_shader_stencil_export_warn
;
382 bool ARB_shader_texture_lod_enable
;
383 bool ARB_shader_texture_lod_warn
;
384 bool ARB_shading_language_420pack_enable
;
385 bool ARB_shading_language_420pack_warn
;
386 bool ARB_shading_language_packing_enable
;
387 bool ARB_shading_language_packing_warn
;
388 bool ARB_texture_cube_map_array_enable
;
389 bool ARB_texture_cube_map_array_warn
;
390 bool ARB_texture_gather_enable
;
391 bool ARB_texture_gather_warn
;
392 bool ARB_texture_multisample_enable
;
393 bool ARB_texture_multisample_warn
;
394 bool ARB_texture_query_levels_enable
;
395 bool ARB_texture_query_levels_warn
;
396 bool ARB_texture_query_lod_enable
;
397 bool ARB_texture_query_lod_warn
;
398 bool ARB_texture_rectangle_enable
;
399 bool ARB_texture_rectangle_warn
;
400 bool ARB_uniform_buffer_object_enable
;
401 bool ARB_uniform_buffer_object_warn
;
402 bool ARB_viewport_array_enable
;
403 bool ARB_viewport_array_warn
;
405 /* KHR extensions go here, sorted alphabetically.
408 /* OES extensions go here, sorted alphabetically.
410 bool OES_EGL_image_external_enable
;
411 bool OES_EGL_image_external_warn
;
412 bool OES_standard_derivatives_enable
;
413 bool OES_standard_derivatives_warn
;
414 bool OES_texture_3D_enable
;
415 bool OES_texture_3D_warn
;
417 /* All other extensions go here, sorted alphabetically.
419 bool AMD_conservative_depth_enable
;
420 bool AMD_conservative_depth_warn
;
421 bool AMD_shader_stencil_export_enable
;
422 bool AMD_shader_stencil_export_warn
;
423 bool AMD_shader_trinary_minmax_enable
;
424 bool AMD_shader_trinary_minmax_warn
;
425 bool AMD_vertex_shader_layer_enable
;
426 bool AMD_vertex_shader_layer_warn
;
427 bool EXT_separate_shader_objects_enable
;
428 bool EXT_separate_shader_objects_warn
;
429 bool EXT_shader_integer_mix_enable
;
430 bool EXT_shader_integer_mix_warn
;
431 bool EXT_texture_array_enable
;
432 bool EXT_texture_array_warn
;
435 /** Extensions supported by the OpenGL implementation. */
436 const struct gl_extensions
*extensions
;
438 bool uses_builtin_functions
;
439 bool fs_uses_gl_fragcoord
;
442 * For geometry shaders, size of the most recently seen input declaration
443 * that was a sized array, or 0 if no sized input array declarations have
446 * Unused for other shader types.
448 unsigned gs_input_size
;
450 bool early_fragment_tests
;
452 /** Atomic counter offsets by binding */
453 unsigned atomic_counter_offsets
[MAX_COMBINED_ATOMIC_BUFFERS
];
456 # define YYLLOC_DEFAULT(Current, Rhs, N) \
460 (Current).first_line = YYRHSLOC(Rhs, 1).first_line; \
461 (Current).first_column = YYRHSLOC(Rhs, 1).first_column; \
462 (Current).last_line = YYRHSLOC(Rhs, N).last_line; \
463 (Current).last_column = YYRHSLOC(Rhs, N).last_column; \
467 (Current).first_line = (Current).last_line = \
468 YYRHSLOC(Rhs, 0).last_line; \
469 (Current).first_column = (Current).last_column = \
470 YYRHSLOC(Rhs, 0).last_column; \
472 (Current).source = 0; \
476 * Emit a warning to the shader log
478 * \sa _mesa_glsl_error
480 extern void _mesa_glsl_warning(const YYLTYPE
*locp
,
481 _mesa_glsl_parse_state
*state
,
482 const char *fmt
, ...);
484 extern void _mesa_glsl_lexer_ctor(struct _mesa_glsl_parse_state
*state
,
487 extern void _mesa_glsl_lexer_dtor(struct _mesa_glsl_parse_state
*state
);
490 extern int _mesa_glsl_lexer_lex(union YYSTYPE
*yylval
, YYLTYPE
*yylloc
,
493 extern int _mesa_glsl_parse(struct _mesa_glsl_parse_state
*);
496 * Process elements of the #extension directive
499 * If \c name and \c behavior are valid, \c true is returned. Otherwise
500 * \c false is returned.
502 extern bool _mesa_glsl_process_extension(const char *name
, YYLTYPE
*name_locp
,
503 const char *behavior
,
504 YYLTYPE
*behavior_locp
,
505 _mesa_glsl_parse_state
*state
);
507 #endif /* __cplusplus */
511 * These definitions apply to C and C++
518 * Get the textual name of the specified shader stage (which is a
522 _mesa_shader_stage_to_string(unsigned stage
);
524 extern int glcpp_preprocess(void *ctx
, const char **shader
, char **info_log
,
525 const struct gl_extensions
*extensions
, struct gl_context
*gl_ctx
);
527 extern void _mesa_destroy_shader_compiler(void);
528 extern void _mesa_destroy_shader_compiler_caches(void);
535 #endif /* GLSL_PARSER_EXTRAS_H */