glsl: add tessellation shader parsing support (v2)
[mesa.git] / src / glsl / glsl_parser_extras.h
1 /*
2 * Copyright © 2010 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
24 #pragma once
25 #ifndef GLSL_PARSER_EXTRAS_H
26 #define GLSL_PARSER_EXTRAS_H
27
28 /*
29 * Most of the definitions here only apply to C++
30 */
31 #ifdef __cplusplus
32
33
34 #include <stdlib.h>
35 #include "glsl_symbol_table.h"
36
37 struct gl_context;
38
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;
44
45 /** Used to detect if 'continue' was called inside a switch. */
46 ir_variable *continue_inside;
47
48 /** Used to set condition if 'default' label should be chosen. */
49 ir_variable *run_default;
50
51 /** Table of constant values already used in case labels */
52 struct hash_table *labels_ht;
53 class ast_case_label *previous_default;
54
55 bool is_switch_innermost; // if switch stmt is closest to break, ...
56 };
57
58 const char *
59 glsl_compute_version_string(void *mem_ctx, bool is_es, unsigned version);
60
61 typedef struct YYLTYPE {
62 int first_line;
63 int first_column;
64 int last_line;
65 int last_column;
66 unsigned source;
67 } YYLTYPE;
68 # define YYLTYPE_IS_DECLARED 1
69 # define YYLTYPE_IS_TRIVIAL 1
70
71 extern void _mesa_glsl_error(YYLTYPE *locp, _mesa_glsl_parse_state *state,
72 const char *fmt, ...);
73
74
75 struct _mesa_glsl_parse_state {
76 _mesa_glsl_parse_state(struct gl_context *_ctx, gl_shader_stage stage,
77 void *mem_ctx);
78
79 DECLARE_RALLOC_CXX_OPERATORS(_mesa_glsl_parse_state);
80
81 /**
82 * Generate a string representing the GLSL version currently being compiled
83 * (useful for error messages).
84 */
85 const char *get_version_string()
86 {
87 return glsl_compute_version_string(this, this->es_shader,
88 this->language_version);
89 }
90
91 /**
92 * Determine whether the current GLSL version is sufficiently high to
93 * support a certain feature.
94 *
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.
98 *
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
101 * feature.
102 */
103 bool is_version(unsigned required_glsl_version,
104 unsigned required_glsl_es_version) const
105 {
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;
112 }
113
114 bool check_version(unsigned required_glsl_version,
115 unsigned required_glsl_es_version,
116 YYLTYPE *locp, const char *fmt, ...) PRINTFLIKE(5, 6);
117
118 bool check_precision_qualifiers_allowed(YYLTYPE *locp)
119 {
120 return check_version(130, 100, locp,
121 "precision qualifiers are forbidden");
122 }
123
124 bool check_bitwise_operations_allowed(YYLTYPE *locp)
125 {
126 return check_version(130, 300, locp, "bit-wise operations are forbidden");
127 }
128
129 bool check_explicit_attrib_stream_allowed(YYLTYPE *locp)
130 {
131 if (!this->has_explicit_attrib_stream()) {
132 const char *const requirement = "GL_ARB_gpu_shader5 extension or GLSL 4.00";
133
134 _mesa_glsl_error(locp, this, "explicit stream requires %s",
135 requirement);
136 return false;
137 }
138
139 return true;
140 }
141
142 bool check_explicit_attrib_location_allowed(YYLTYPE *locp,
143 const ir_variable *var)
144 {
145 if (!this->has_explicit_attrib_location()) {
146 const char *const requirement = this->es_shader
147 ? "GLSL ES 3.00"
148 : "GL_ARB_explicit_attrib_location extension or GLSL 3.30";
149
150 _mesa_glsl_error(locp, this, "%s explicit location requires %s",
151 mode_string(var), requirement);
152 return false;
153 }
154
155 return true;
156 }
157
158 bool check_separate_shader_objects_allowed(YYLTYPE *locp,
159 const ir_variable *var)
160 {
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";
165
166 _mesa_glsl_error(locp, this, "%s explicit location requires %s",
167 mode_string(var), requirement);
168 return false;
169 }
170
171 return true;
172 }
173
174 bool check_explicit_uniform_location_allowed(YYLTYPE *locp,
175 const ir_variable *)
176 {
177 if (!this->has_explicit_attrib_location() ||
178 !this->has_explicit_uniform_location()) {
179 const char *const requirement = this->es_shader
180 ? "GLSL ES 3.10"
181 : "GL_ARB_explicit_uniform_location and either "
182 "GL_ARB_explicit_attrib_location or GLSL 3.30.";
183
184 _mesa_glsl_error(locp, this,
185 "uniform explicit location requires %s",
186 requirement);
187 return false;
188 }
189
190 return true;
191 }
192
193 bool has_atomic_counters() const
194 {
195 return ARB_shader_atomic_counters_enable || is_version(420, 310);
196 }
197
198 bool has_explicit_attrib_stream() const
199 {
200 return ARB_gpu_shader5_enable || is_version(400, 0);
201 }
202
203 bool has_explicit_attrib_location() const
204 {
205 return ARB_explicit_attrib_location_enable || is_version(330, 300);
206 }
207
208 bool has_explicit_uniform_location() const
209 {
210 return ARB_explicit_uniform_location_enable || is_version(430, 310);
211 }
212
213 bool has_uniform_buffer_objects() const
214 {
215 return ARB_uniform_buffer_object_enable || is_version(140, 300);
216 }
217
218 bool has_shader_storage_buffer_objects() const
219 {
220 return ARB_shader_storage_buffer_object_enable || is_version(430, 0);
221 }
222
223 bool has_separate_shader_objects() const
224 {
225 return ARB_separate_shader_objects_enable || is_version(410, 310)
226 || EXT_separate_shader_objects_enable;
227 }
228
229 bool has_double() const
230 {
231 return ARB_gpu_shader_fp64_enable || is_version(400, 0);
232 }
233
234 void process_version_directive(YYLTYPE *locp, int version,
235 const char *ident);
236
237 struct gl_context *const ctx;
238 void *scanner;
239 exec_list translation_unit;
240 glsl_symbol_table *symbols;
241
242 unsigned num_supported_versions;
243 struct {
244 unsigned ver;
245 bool es;
246 } supported_versions[15];
247
248 bool es_shader;
249 unsigned language_version;
250 unsigned forced_language_version;
251 gl_shader_stage stage;
252
253 /**
254 * Number of nested struct_specifier levels
255 *
256 * Outside a struct_specifier, this is zero.
257 */
258 unsigned struct_specifier_depth;
259
260 /**
261 * Default uniform layout qualifiers tracked during parsing.
262 * Currently affects uniform blocks and uniform buffer variables in
263 * those blocks.
264 */
265 struct ast_type_qualifier *default_uniform_qualifier;
266
267 /**
268 * Variables to track different cases if a fragment shader redeclares
269 * built-in variable gl_FragCoord.
270 *
271 * Note: These values are computed at ast_to_hir time rather than at parse
272 * time.
273 */
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;
278
279 /**
280 * True if a geometry shader input primitive type or tessellation control
281 * output vertices were specified using a layout directive.
282 *
283 * Note: these values are computed at ast_to_hir time rather than at parse
284 * time.
285 */
286 bool gs_input_prim_type_specified;
287 bool tcs_output_vertices_specified;
288
289 /**
290 * Input layout qualifiers from GLSL 1.50 (geometry shader controls),
291 * and GLSL 4.00 (tessellation evaluation shader)
292 */
293 struct ast_type_qualifier *in_qualifier;
294
295 /**
296 * True if a compute shader input local size was specified using a layout
297 * directive.
298 *
299 * Note: this value is computed at ast_to_hir time rather than at parse
300 * time.
301 */
302 bool cs_input_local_size_specified;
303
304 /**
305 * If cs_input_local_size_specified is true, the local size that was
306 * specified. Otherwise ignored.
307 */
308 unsigned cs_input_local_size[3];
309
310 /**
311 * Output layout qualifiers from GLSL 1.50 (geometry shader controls),
312 * and GLSL 4.00 (tessellation control shader).
313 */
314 struct ast_type_qualifier *out_qualifier;
315
316 /**
317 * Printable list of GLSL versions supported by the current context
318 *
319 * \note
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.
323 */
324 const char *supported_version_string;
325
326 /**
327 * Implementation defined limits that affect built-in variables, etc.
328 *
329 * \sa struct gl_constants (in mtypes.h)
330 */
331 struct {
332 /* 1.10 */
333 unsigned MaxLights;
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;
343
344 /* ARB_draw_buffers */
345 unsigned MaxDrawBuffers;
346
347 /* 3.00 ES */
348 int MinProgramTexelOffset;
349 int MaxProgramTexelOffset;
350
351 /* 1.50 */
352 unsigned MaxVertexOutputComponents;
353 unsigned MaxGeometryInputComponents;
354 unsigned MaxGeometryOutputComponents;
355 unsigned MaxFragmentInputComponents;
356 unsigned MaxGeometryTextureImageUnits;
357 unsigned MaxGeometryOutputVertices;
358 unsigned MaxGeometryTotalOutputComponents;
359 unsigned MaxGeometryUniformComponents;
360
361 /* ARB_shader_atomic_counters */
362 unsigned MaxVertexAtomicCounters;
363 unsigned MaxGeometryAtomicCounters;
364 unsigned MaxFragmentAtomicCounters;
365 unsigned MaxCombinedAtomicCounters;
366 unsigned MaxAtomicBufferBindings;
367
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
370 * 3.10.
371 */
372 unsigned MaxVertexAtomicCounterBuffers;
373 unsigned MaxGeometryAtomicCounterBuffers;
374 unsigned MaxFragmentAtomicCounterBuffers;
375 unsigned MaxCombinedAtomicCounterBuffers;
376 unsigned MaxAtomicCounterBufferSize;
377
378 /* ARB_compute_shader */
379 unsigned MaxComputeWorkGroupCount[3];
380 unsigned MaxComputeWorkGroupSize[3];
381
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;
390
391 /* ARB_viewport_array */
392 unsigned MaxViewports;
393
394 /* ARB_tessellation_shader */
395 unsigned MaxPatchVertices;
396 } Const;
397
398 /**
399 * During AST to IR conversion, pointer to current IR function
400 *
401 * Will be \c NULL whenever the AST to IR conversion is not inside a
402 * function definition.
403 */
404 class ir_function_signature *current_function;
405
406 /**
407 * During AST to IR conversion, pointer to the toplevel IR
408 * instruction list being generated.
409 */
410 exec_list *toplevel_ir;
411
412 /** Have we found a return statement in this function? */
413 bool found_return;
414
415 /** Was there an error during compilation? */
416 bool error;
417
418 /**
419 * Are all shader inputs / outputs invariant?
420 *
421 * This is set when the 'STDGL invariant(all)' pragma is used.
422 */
423 bool all_invariant;
424
425 /** Loop or switch statement containing the current instructions. */
426 class ast_iteration_statement *loop_nesting_ast;
427
428 struct glsl_switch_state switch_state;
429
430 /** List of structures defined in user code. */
431 const glsl_type **user_structures;
432 unsigned num_user_structures;
433
434 char *info_log;
435
436 /**
437 * \name Enable bits for GLSL extensions
438 */
439 /*@{*/
440 /* ARB extensions go here, sorted alphabetically.
441 */
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;
508
509 /* KHR extensions go here, sorted alphabetically.
510 */
511
512 /* OES extensions go here, sorted alphabetically.
513 */
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;
520
521 /* All other extensions go here, sorted alphabetically.
522 */
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;
541 /*@}*/
542
543 /** Extensions supported by the OpenGL implementation. */
544 const struct gl_extensions *extensions;
545
546 bool uses_builtin_functions;
547 bool fs_uses_gl_fragcoord;
548
549 /**
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
552 * been seen.
553 *
554 * Unused for other shader types.
555 */
556 unsigned gs_input_size;
557
558 bool fs_early_fragment_tests;
559
560 /**
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.
564 *
565 * Unused for other shader types.
566 */
567 unsigned tcs_output_size;
568
569 /** Atomic counter offsets by binding */
570 unsigned atomic_counter_offsets[MAX_COMBINED_ATOMIC_BUFFERS];
571
572 bool allow_extension_directive_midshader;
573 };
574
575 # define YYLLOC_DEFAULT(Current, Rhs, N) \
576 do { \
577 if (N) \
578 { \
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; \
583 } \
584 else \
585 { \
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; \
590 } \
591 (Current).source = 0; \
592 } while (0)
593
594 /**
595 * Emit a warning to the shader log
596 *
597 * \sa _mesa_glsl_error
598 */
599 extern void _mesa_glsl_warning(const YYLTYPE *locp,
600 _mesa_glsl_parse_state *state,
601 const char *fmt, ...);
602
603 extern void _mesa_glsl_lexer_ctor(struct _mesa_glsl_parse_state *state,
604 const char *string);
605
606 extern void _mesa_glsl_lexer_dtor(struct _mesa_glsl_parse_state *state);
607
608 union YYSTYPE;
609 extern int _mesa_glsl_lexer_lex(union YYSTYPE *yylval, YYLTYPE *yylloc,
610 void *scanner);
611
612 extern int _mesa_glsl_parse(struct _mesa_glsl_parse_state *);
613
614 /**
615 * Process elements of the #extension directive
616 *
617 * \return
618 * If \c name and \c behavior are valid, \c true is returned. Otherwise
619 * \c false is returned.
620 */
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);
625
626 #endif /* __cplusplus */
627
628
629 /*
630 * These definitions apply to C and C++
631 */
632 #ifdef __cplusplus
633 extern "C" {
634 #endif
635
636 /**
637 * Get the textual name of the specified shader stage (which is a
638 * gl_shader_stage).
639 */
640 extern const char *
641 _mesa_shader_stage_to_string(unsigned stage);
642
643 extern const char *
644 _mesa_shader_stage_to_abbrev(unsigned stage);
645
646 extern int glcpp_preprocess(void *ctx, const char **shader, char **info_log,
647 const struct gl_extensions *extensions, struct gl_context *gl_ctx);
648
649 extern void _mesa_destroy_shader_compiler(void);
650 extern void _mesa_destroy_shader_compiler_caches(void);
651
652 #ifdef __cplusplus
653 }
654 #endif
655
656
657 #endif /* GLSL_PARSER_EXTRAS_H */