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