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       return required_version != 0
 109          && this->language_version >= required_version;
 110    }
 111
 112    bool check_version(unsigned required_glsl_version,
 113                       unsigned required_glsl_es_version,
 114                       YYLTYPE *locp, const char *fmt, ...) PRINTFLIKE(5, 6);
 115
 116    bool check_precision_qualifiers_allowed(YYLTYPE *locp)
 117    {
 118       return check_version(130, 100, locp,
 119                            "precision qualifiers are forbidden");
 120    }
 121
 122    bool check_bitwise_operations_allowed(YYLTYPE *locp)
 123    {
 124       return check_version(130, 300, locp, "bit-wise operations are forbidden");
 125    }
 126
 127    bool check_explicit_attrib_stream_allowed(YYLTYPE *locp)
 128    {
 129       if (!this->has_explicit_attrib_stream()) {
 130          const char *const requirement = "GL_ARB_gpu_shader5 extension or GLSL 400";
 131
 132          _mesa_glsl_error(locp, this, "explicit stream requires %s",
 133                           requirement);
 134          return false;
 135       }
 136
 137       return true;
 138    }
 139
 140    bool check_explicit_attrib_location_allowed(YYLTYPE *locp,
 141                                                const ir_variable *var)
 142    {
 143       if (!this->has_explicit_attrib_location()) {
 144          const char *const requirement = this->es_shader
 145             ? "GLSL ES 300"
 146             : "GL_ARB_explicit_attrib_location extension or GLSL 330";
 147
 148          _mesa_glsl_error(locp, this, "%s explicit location requires %s",
 149                           mode_string(var), requirement);
 150          return false;
 151       }
 152
 153       return true;
 154    }
 155
 156    bool check_separate_shader_objects_allowed(YYLTYPE *locp,
 157                                               const ir_variable *var)
 158    {
 159       if (!this->has_separate_shader_objects()) {
 160          const char *const requirement = this->es_shader
 161             ? "GL_EXT_separate_shader_objects extension"
 162             : "GL_ARB_separate_shader_objects extension or GLSL 420";
 163
 164          _mesa_glsl_error(locp, this, "%s explicit location requires %s",
 165                           mode_string(var), requirement);
 166          return false;
 167       }
 168
 169       return true;
 170    }
 171
 172    bool check_explicit_uniform_location_allowed(YYLTYPE *locp,
 173                                                 const ir_variable *)
 174    {
 175       if (!this->has_explicit_attrib_location() ||
 176           !this->ARB_explicit_uniform_location_enable) {
 177          _mesa_glsl_error(locp, this,
 178                           "uniform explicit location requires "
 179                           "GL_ARB_explicit_uniform_location and either "
 180                           "GL_ARB_explicit_attrib_location or GLSL 330.");
 181          return false;
 182       }
 183
 184       return true;
 185    }
 186
 187    bool has_explicit_attrib_stream() const
 188    {
 189       return ARB_gpu_shader5_enable || is_version(400, 0);
 190    }
 191
 192    bool has_explicit_attrib_location() const
 193    {
 194       return ARB_explicit_attrib_location_enable || is_version(330, 300);
 195    }
 196
 197    bool has_uniform_buffer_objects() const
 198    {
 199       return ARB_uniform_buffer_object_enable || is_version(140, 300);
 200    }
 201
 202    bool has_separate_shader_objects() const
 203    {
 204       return ARB_separate_shader_objects_enable || is_version(410, 0)
 205          || EXT_separate_shader_objects_enable;
 206    }
 207
 208    void process_version_directive(YYLTYPE *locp, int version,
 209                                   const char *ident);
 210
 211    struct gl_context *const ctx;
 212    void *scanner;
 213    exec_list translation_unit;
 214    glsl_symbol_table *symbols;
 215
 216    unsigned num_supported_versions;
 217    struct {
 218       unsigned ver;
 219       bool es;
 220    } supported_versions[14];
 221
 222    bool es_shader;
 223    unsigned language_version;
 224    gl_shader_stage stage;
 225
 226    /**
 227     * Number of nested struct_specifier levels
 228     *
 229     * Outside a struct_specifier, this is zero.
 230     */
 231    unsigned struct_specifier_depth;
 232
 233    /**
 234     * Default uniform layout qualifiers tracked during parsing.
 235     * Currently affects uniform blocks and uniform buffer variables in
 236     * those blocks.
 237     */
 238    struct ast_type_qualifier *default_uniform_qualifier;
 239
 240    /**
 241     * Variables to track different cases if a fragment shader redeclares
 242     * built-in variable gl_FragCoord.
 243     *
 244     * Note: These values are computed at ast_to_hir time rather than at parse
 245     * time.
 246     */
 247    bool fs_redeclares_gl_fragcoord;
 248    bool fs_origin_upper_left;
 249    bool fs_pixel_center_integer;
 250    bool fs_redeclares_gl_fragcoord_with_no_layout_qualifiers;
 251
 252    /**
 253     * True if a geometry shader input primitive type was specified using a
 254     * layout directive.
 255     *
 256     * Note: this value is computed at ast_to_hir time rather than at parse
 257     * time.
 258     */
 259    bool gs_input_prim_type_specified;
 260
 261    /** Input layout qualifiers from GLSL 1.50. (geometry shader controls)*/
 262    struct ast_type_qualifier *in_qualifier;
 263
 264    /**
 265     * True if a compute shader input local size was specified using a layout
 266     * directive.
 267     *
 268     * Note: this value is computed at ast_to_hir time rather than at parse
 269     * time.
 270     */
 271    bool cs_input_local_size_specified;
 272
 273    /**
 274     * If cs_input_local_size_specified is true, the local size that was
 275     * specified.  Otherwise ignored.
 276     */
 277    unsigned cs_input_local_size[3];
 278
 279    /** Output layout qualifiers from GLSL 1.50. (geometry shader controls)*/
 280    struct ast_type_qualifier *out_qualifier;
 281
 282    /**
 283     * Printable list of GLSL versions supported by the current context
 284     *
 285     * \note
 286     * This string should probably be generated per-context instead of per
 287     * invokation of the compiler.  This should be changed when the method of
 288     * tracking supported GLSL versions changes.
 289     */
 290    const char *supported_version_string;
 291
 292    /**
 293     * Implementation defined limits that affect built-in variables, etc.
 294     *
 295     * \sa struct gl_constants (in mtypes.h)
 296     */
 297    struct {
 298       /* 1.10 */
 299       unsigned MaxLights;
 300       unsigned MaxClipPlanes;
 301       unsigned MaxTextureUnits;
 302       unsigned MaxTextureCoords;
 303       unsigned MaxVertexAttribs;
 304       unsigned MaxVertexUniformComponents;
 305       unsigned MaxVertexTextureImageUnits;
 306       unsigned MaxCombinedTextureImageUnits;
 307       unsigned MaxTextureImageUnits;
 308       unsigned MaxFragmentUniformComponents;
 309
 310       /* ARB_draw_buffers */
 311       unsigned MaxDrawBuffers;
 312
 313       /* 3.00 ES */
 314       int MinProgramTexelOffset;
 315       int MaxProgramTexelOffset;
 316
 317       /* 1.50 */
 318       unsigned MaxVertexOutputComponents;
 319       unsigned MaxGeometryInputComponents;
 320       unsigned MaxGeometryOutputComponents;
 321       unsigned MaxFragmentInputComponents;
 322       unsigned MaxGeometryTextureImageUnits;
 323       unsigned MaxGeometryOutputVertices;
 324       unsigned MaxGeometryTotalOutputComponents;
 325       unsigned MaxGeometryUniformComponents;
 326
 327       /* ARB_shader_atomic_counters */
 328       unsigned MaxVertexAtomicCounters;
 329       unsigned MaxGeometryAtomicCounters;
 330       unsigned MaxFragmentAtomicCounters;
 331       unsigned MaxCombinedAtomicCounters;
 332       unsigned MaxAtomicBufferBindings;
 333
 334       /* ARB_compute_shader */
 335       unsigned MaxComputeWorkGroupCount[3];
 336       unsigned MaxComputeWorkGroupSize[3];
 337
 338       /* ARB_shader_image_load_store */
 339       unsigned MaxImageUnits;
 340       unsigned MaxCombinedImageUnitsAndFragmentOutputs;
 341       unsigned MaxImageSamples;
 342       unsigned MaxVertexImageUniforms;
 343       unsigned MaxGeometryImageUniforms;
 344       unsigned MaxFragmentImageUniforms;
 345       unsigned MaxCombinedImageUniforms;
 346
 347       /* ARB_viewport_array */
 348       unsigned MaxViewports;
 349    } Const;
 350
 351    /**
 352     * During AST to IR conversion, pointer to current IR function
 353     *
 354     * Will be \c NULL whenever the AST to IR conversion is not inside a
 355     * function definition.
 356     */
 357    class ir_function_signature *current_function;
 358
 359    /**
 360     * During AST to IR conversion, pointer to the toplevel IR
 361     * instruction list being generated.
 362     */
 363    exec_list *toplevel_ir;
 364
 365    /** Have we found a return statement in this function? */
 366    bool found_return;
 367
 368    /** Was there an error during compilation? */
 369    bool error;
 370
 371    /**
 372     * Are all shader inputs / outputs invariant?
 373     *
 374     * This is set when the 'STDGL invariant(all)' pragma is used.
 375     */
 376    bool all_invariant;
 377
 378    /** Loop or switch statement containing the current instructions. */
 379    class ast_iteration_statement *loop_nesting_ast;
 380
 381    struct glsl_switch_state switch_state;
 382
 383    /** List of structures defined in user code. */
 384    const glsl_type **user_structures;
 385    unsigned num_user_structures;
 386
 387    char *info_log;
 388
 389    /**
 390     * \name Enable bits for GLSL extensions
 391     */
 392    /*@{*/
 393    /* ARB extensions go here, sorted alphabetically.
 394     */
 395    bool ARB_arrays_of_arrays_enable;
 396    bool ARB_arrays_of_arrays_warn;
 397    bool ARB_compute_shader_enable;
 398    bool ARB_compute_shader_warn;
 399    bool ARB_conservative_depth_enable;
 400    bool ARB_conservative_depth_warn;
 401    bool ARB_derivative_control_enable;
 402    bool ARB_derivative_control_warn;
 403    bool ARB_draw_buffers_enable;
 404    bool ARB_draw_buffers_warn;
 405    bool ARB_draw_instanced_enable;
 406    bool ARB_draw_instanced_warn;
 407    bool ARB_explicit_attrib_location_enable;
 408    bool ARB_explicit_attrib_location_warn;
 409    bool ARB_explicit_uniform_location_enable;
 410    bool ARB_explicit_uniform_location_warn;
 411    bool ARB_fragment_coord_conventions_enable;
 412    bool ARB_fragment_coord_conventions_warn;
 413    bool ARB_fragment_layer_viewport_enable;
 414    bool ARB_fragment_layer_viewport_warn;
 415    bool ARB_gpu_shader5_enable;
 416    bool ARB_gpu_shader5_warn;
 417    bool ARB_sample_shading_enable;
 418    bool ARB_sample_shading_warn;
 419    bool ARB_separate_shader_objects_enable;
 420    bool ARB_separate_shader_objects_warn;
 421    bool ARB_shader_atomic_counters_enable;
 422    bool ARB_shader_atomic_counters_warn;
 423    bool ARB_shader_bit_encoding_enable;
 424    bool ARB_shader_bit_encoding_warn;
 425    bool ARB_shader_image_load_store_enable;
 426    bool ARB_shader_image_load_store_warn;
 427    bool ARB_shader_stencil_export_enable;
 428    bool ARB_shader_stencil_export_warn;
 429    bool ARB_shader_texture_lod_enable;
 430    bool ARB_shader_texture_lod_warn;
 431    bool ARB_shading_language_420pack_enable;
 432    bool ARB_shading_language_420pack_warn;
 433    bool ARB_shading_language_packing_enable;
 434    bool ARB_shading_language_packing_warn;
 435    bool ARB_texture_cube_map_array_enable;
 436    bool ARB_texture_cube_map_array_warn;
 437    bool ARB_texture_gather_enable;
 438    bool ARB_texture_gather_warn;
 439    bool ARB_texture_multisample_enable;
 440    bool ARB_texture_multisample_warn;
 441    bool ARB_texture_query_levels_enable;
 442    bool ARB_texture_query_levels_warn;
 443    bool ARB_texture_query_lod_enable;
 444    bool ARB_texture_query_lod_warn;
 445    bool ARB_texture_rectangle_enable;
 446    bool ARB_texture_rectangle_warn;
 447    bool ARB_uniform_buffer_object_enable;
 448    bool ARB_uniform_buffer_object_warn;
 449    bool ARB_viewport_array_enable;
 450    bool ARB_viewport_array_warn;
 451
 452    /* KHR extensions go here, sorted alphabetically.
 453     */
 454
 455    /* OES extensions go here, sorted alphabetically.
 456     */
 457    bool OES_EGL_image_external_enable;
 458    bool OES_EGL_image_external_warn;
 459    bool OES_standard_derivatives_enable;
 460    bool OES_standard_derivatives_warn;
 461    bool OES_texture_3D_enable;
 462    bool OES_texture_3D_warn;
 463
 464    /* All other extensions go here, sorted alphabetically.
 465     */
 466    bool AMD_conservative_depth_enable;
 467    bool AMD_conservative_depth_warn;
 468    bool AMD_shader_stencil_export_enable;
 469    bool AMD_shader_stencil_export_warn;
 470    bool AMD_shader_trinary_minmax_enable;
 471    bool AMD_shader_trinary_minmax_warn;
 472    bool AMD_vertex_shader_layer_enable;
 473    bool AMD_vertex_shader_layer_warn;
 474    bool AMD_vertex_shader_viewport_index_enable;
 475    bool AMD_vertex_shader_viewport_index_warn;
 476    bool EXT_draw_buffers_enable;
 477    bool EXT_draw_buffers_warn;
 478    bool EXT_separate_shader_objects_enable;
 479    bool EXT_separate_shader_objects_warn;
 480    bool EXT_shader_integer_mix_enable;
 481    bool EXT_shader_integer_mix_warn;
 482    bool EXT_texture_array_enable;
 483    bool EXT_texture_array_warn;
 484    /*@}*/
 485
 486    /** Extensions supported by the OpenGL implementation. */
 487    const struct gl_extensions *extensions;
 488
 489    bool uses_builtin_functions;
 490    bool fs_uses_gl_fragcoord;
 491
 492    /**
 493     * For geometry shaders, size of the most recently seen input declaration
 494     * that was a sized array, or 0 if no sized input array declarations have
 495     * been seen.
 496     *
 497     * Unused for other shader types.
 498     */
 499    unsigned gs_input_size;
 500
 501    bool early_fragment_tests;
 502
 503    /** Atomic counter offsets by binding */
 504    unsigned atomic_counter_offsets[MAX_COMBINED_ATOMIC_BUFFERS];
 505
 506    bool allow_extension_directive_midshader;
 507 };
 508
 509 # define YYLLOC_DEFAULT(Current, Rhs, N)                        \
 510 do {                                                            \
 511    if (N)                                                       \
 512    {                                                            \
 513       (Current).first_line   = YYRHSLOC(Rhs, 1).first_line;     \
 514       (Current).first_column = YYRHSLOC(Rhs, 1).first_column;   \
 515       (Current).last_line    = YYRHSLOC(Rhs, N).last_line;      \
 516       (Current).last_column  = YYRHSLOC(Rhs, N).last_column;    \
 517    }                                                            \
 518    else                                                         \
 519    {                                                            \
 520       (Current).first_line   = (Current).last_line =            \
 521          YYRHSLOC(Rhs, 0).last_line;                            \
 522       (Current).first_column = (Current).last_column =          \
 523          YYRHSLOC(Rhs, 0).last_column;                          \
 524    }                                                            \
 525    (Current).source = 0;                                        \
 526 } while (0)
 527
 528 /**
 529  * Emit a warning to the shader log
 530  *
 531  * \sa _mesa_glsl_error
 532  */
 533 extern void _mesa_glsl_warning(const YYLTYPE *locp,
 534                                _mesa_glsl_parse_state *state,
 535                                const char *fmt, ...);
 536
 537 extern void _mesa_glsl_lexer_ctor(struct _mesa_glsl_parse_state *state,
 538                                   const char *string);
 539
 540 extern void _mesa_glsl_lexer_dtor(struct _mesa_glsl_parse_state *state);
 541
 542 union YYSTYPE;
 543 extern int _mesa_glsl_lexer_lex(union YYSTYPE *yylval, YYLTYPE *yylloc,
 544                                 void *scanner);
 545
 546 extern int _mesa_glsl_parse(struct _mesa_glsl_parse_state *);
 547
 548 /**
 549  * Process elements of the #extension directive
 550  *
 551  * \return
 552  * If \c name and \c behavior are valid, \c true is returned.  Otherwise
 553  * \c false is returned.
 554  */
 555 extern bool _mesa_glsl_process_extension(const char *name, YYLTYPE *name_locp,
 556                                          const char *behavior,
 557                                          YYLTYPE *behavior_locp,
 558                                          _mesa_glsl_parse_state *state);
 559
 560 #endif /* __cplusplus */
 561
 562
 563 /*
 564  * These definitions apply to C and C++
 565  */
 566 #ifdef __cplusplus
 567 extern "C" {
 568 #endif
 569
 570 /**
 571  * Get the textual name of the specified shader stage (which is a
 572  * gl_shader_stage).
 573  */
 574 extern const char *
 575 _mesa_shader_stage_to_string(unsigned stage);
 576
 577 extern int glcpp_preprocess(void *ctx, const char **shader, char **info_log,
 578                       const struct gl_extensions *extensions, struct gl_context *gl_ctx);
 579
 580 extern void _mesa_destroy_shader_compiler(void);
 581 extern void _mesa_destroy_shader_compiler_caches(void);
 582
 583 #ifdef __cplusplus
 584 }
 585 #endif
 586
 587
 588 #endif /* GLSL_PARSER_EXTRAS_H */