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    ir_variable *is_break_var;
  44    class ast_switch_statement *switch_nesting_ast;
  45
  46    /** Table of constant values already used in case labels */
  47    struct hash_table *labels_ht;
  48    class ast_case_label *previous_default;
  49
  50    bool is_switch_innermost; // if switch stmt is closest to break, ...
  51 };
  52
  53 const char *
  54 glsl_compute_version_string(void *mem_ctx, bool is_es, unsigned version);
  55
  56 typedef struct YYLTYPE {
  57    int first_line;
  58    int first_column;
  59    int last_line;
  60    int last_column;
  61    unsigned source;
  62 } YYLTYPE;
  63 # define YYLTYPE_IS_DECLARED 1
  64 # define YYLTYPE_IS_TRIVIAL 1
  65
  66 extern void _mesa_glsl_error(YYLTYPE *locp, _mesa_glsl_parse_state *state,
  67                              const char *fmt, ...);
  68
  69
  70 struct _mesa_glsl_parse_state {
  71    _mesa_glsl_parse_state(struct gl_context *_ctx, gl_shader_stage stage,
  72                           void *mem_ctx);
  73
  74    DECLARE_RALLOC_CXX_OPERATORS(_mesa_glsl_parse_state);
  75
  76    /**
  77     * Generate a string representing the GLSL version currently being compiled
  78     * (useful for error messages).
  79     */
  80    const char *get_version_string()
  81    {
  82       return glsl_compute_version_string(this, this->es_shader,
  83                                          this->language_version);
  84    }
  85
  86    /**
  87     * Determine whether the current GLSL version is sufficiently high to
  88     * support a certain feature.
  89     *
  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.
  93     *
  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
  96     * feature.
  97     */
  98    bool is_version(unsigned required_glsl_version,
  99                    unsigned required_glsl_es_version) const
 100    {
 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;
 105    }
 106
 107    bool check_version(unsigned required_glsl_version,
 108                       unsigned required_glsl_es_version,
 109                       YYLTYPE *locp, const char *fmt, ...) PRINTFLIKE(5, 6);
 110
 111    bool check_precision_qualifiers_allowed(YYLTYPE *locp)
 112    {
 113       return check_version(130, 100, locp,
 114                            "precision qualifiers are forbidden");
 115    }
 116
 117    bool check_bitwise_operations_allowed(YYLTYPE *locp)
 118    {
 119       return check_version(130, 300, locp, "bit-wise operations are forbidden");
 120    }
 121
 122    bool check_explicit_attrib_location_allowed(YYLTYPE *locp,
 123                                                const ir_variable *var)
 124    {
 125       if (!this->has_explicit_attrib_location()) {
 126          const char *const requirement = this->es_shader
 127             ? "GLSL ES 300"
 128             : "GL_ARB_explicit_attrib_location extension or GLSL 330";
 129
 130          _mesa_glsl_error(locp, this, "%s explicit location requires %s",
 131                           mode_string(var), requirement);
 132          return false;
 133       }
 134
 135       return true;
 136    }
 137
 138    bool has_explicit_attrib_location() const
 139    {
 140       return ARB_explicit_attrib_location_enable || is_version(330, 300);
 141    }
 142
 143    bool has_uniform_buffer_objects() const
 144    {
 145       return ARB_uniform_buffer_object_enable || is_version(140, 300);
 146    }
 147
 148    void process_version_directive(YYLTYPE *locp, int version,
 149                                   const char *ident);
 150
 151    struct gl_context *const ctx;
 152    void *scanner;
 153    exec_list translation_unit;
 154    glsl_symbol_table *symbols;
 155
 156    unsigned num_uniform_blocks;
 157    unsigned uniform_block_array_size;
 158    struct gl_uniform_block *uniform_blocks;
 159
 160    unsigned num_supported_versions;
 161    struct {
 162       unsigned ver;
 163       bool es;
 164    } supported_versions[12];
 165
 166    bool es_shader;
 167    unsigned language_version;
 168    gl_shader_stage stage;
 169
 170    /**
 171     * Number of nested struct_specifier levels
 172     *
 173     * Outside a struct_specifer, this is zero.
 174     */
 175    unsigned struct_specifier_depth;
 176
 177    /**
 178     * Default uniform layout qualifiers tracked during parsing.
 179     * Currently affects uniform blocks and uniform buffer variables in
 180     * those blocks.
 181     */
 182    struct ast_type_qualifier *default_uniform_qualifier;
 183
 184    /**
 185     * True if a geometry shader input primitive type was specified using a
 186     * layout directive.
 187     *
 188     * Note: this value is computed at ast_to_hir time rather than at parse
 189     * time.
 190     */
 191    bool gs_input_prim_type_specified;
 192
 193    /**
 194     * If gs_input_prim_type_specified is true, the primitive type that was
 195     * specified.  Otherwise ignored.
 196     */
 197    GLenum gs_input_prim_type;
 198
 199    /**
 200     * True if a compute shader input local size was specified using a layout
 201     * directive.
 202     *
 203     * Note: this value is computed at ast_to_hir time rather than at parse
 204     * time.
 205     */
 206    bool cs_input_local_size_specified;
 207
 208    /**
 209     * If cs_input_local_size_specified is true, the local size that was
 210     * specified.  Otherwise ignored.
 211     */
 212    unsigned cs_input_local_size[3];
 213
 214    /** Output layout qualifiers from GLSL 1.50. (geometry shader controls)*/
 215    struct ast_type_qualifier *out_qualifier;
 216
 217    /**
 218     * Printable list of GLSL versions supported by the current context
 219     *
 220     * \note
 221     * This string should probably be generated per-context instead of per
 222     * invokation of the compiler.  This should be changed when the method of
 223     * tracking supported GLSL versions changes.
 224     */
 225    const char *supported_version_string;
 226
 227    /**
 228     * Implementation defined limits that affect built-in variables, etc.
 229     *
 230     * \sa struct gl_constants (in mtypes.h)
 231     */
 232    struct {
 233       /* 1.10 */
 234       unsigned MaxLights;
 235       unsigned MaxClipPlanes;
 236       unsigned MaxTextureUnits;
 237       unsigned MaxTextureCoords;
 238       unsigned MaxVertexAttribs;
 239       unsigned MaxVertexUniformComponents;
 240       unsigned MaxVertexTextureImageUnits;
 241       unsigned MaxCombinedTextureImageUnits;
 242       unsigned MaxTextureImageUnits;
 243       unsigned MaxFragmentUniformComponents;
 244
 245       /* ARB_draw_buffers */
 246       unsigned MaxDrawBuffers;
 247
 248       /* 3.00 ES */
 249       int MinProgramTexelOffset;
 250       int MaxProgramTexelOffset;
 251
 252       /* 1.50 */
 253       unsigned MaxVertexOutputComponents;
 254       unsigned MaxGeometryInputComponents;
 255       unsigned MaxGeometryOutputComponents;
 256       unsigned MaxFragmentInputComponents;
 257       unsigned MaxGeometryTextureImageUnits;
 258       unsigned MaxGeometryOutputVertices;
 259       unsigned MaxGeometryTotalOutputComponents;
 260       unsigned MaxGeometryUniformComponents;
 261
 262       /* ARB_shader_atomic_counters */
 263       unsigned MaxVertexAtomicCounters;
 264       unsigned MaxGeometryAtomicCounters;
 265       unsigned MaxFragmentAtomicCounters;
 266       unsigned MaxCombinedAtomicCounters;
 267       unsigned MaxAtomicBufferBindings;
 268
 269       /* ARB_compute_shader */
 270       unsigned MaxComputeWorkGroupCount[3];
 271       unsigned MaxComputeWorkGroupSize[3];
 272    } Const;
 273
 274    /**
 275     * During AST to IR conversion, pointer to current IR function
 276     *
 277     * Will be \c NULL whenever the AST to IR conversion is not inside a
 278     * function definition.
 279     */
 280    class ir_function_signature *current_function;
 281
 282    /**
 283     * During AST to IR conversion, pointer to the toplevel IR
 284     * instruction list being generated.
 285     */
 286    exec_list *toplevel_ir;
 287
 288    /** Have we found a return statement in this function? */
 289    bool found_return;
 290
 291    /** Was there an error during compilation? */
 292    bool error;
 293
 294    /**
 295     * Are all shader inputs / outputs invariant?
 296     *
 297     * This is set when the 'STDGL invariant(all)' pragma is used.
 298     */
 299    bool all_invariant;
 300
 301    /** Loop or switch statement containing the current instructions. */
 302    class ast_iteration_statement *loop_nesting_ast;
 303
 304    struct glsl_switch_state switch_state;
 305
 306    /** List of structures defined in user code. */
 307    const glsl_type **user_structures;
 308    unsigned num_user_structures;
 309
 310    char *info_log;
 311
 312    /**
 313     * \name Enable bits for GLSL extensions
 314     */
 315    /*@{*/
 316    bool ARB_arrays_of_arrays_enable;
 317    bool ARB_arrays_of_arrays_warn;
 318    bool ARB_draw_buffers_enable;
 319    bool ARB_draw_buffers_warn;
 320    bool ARB_draw_instanced_enable;
 321    bool ARB_draw_instanced_warn;
 322    bool ARB_explicit_attrib_location_enable;
 323    bool ARB_explicit_attrib_location_warn;
 324    bool ARB_fragment_coord_conventions_enable;
 325    bool ARB_fragment_coord_conventions_warn;
 326    bool ARB_texture_rectangle_enable;
 327    bool ARB_texture_rectangle_warn;
 328    bool ARB_texture_gather_enable;
 329    bool ARB_texture_gather_warn;
 330    bool EXT_texture_array_enable;
 331    bool EXT_texture_array_warn;
 332    bool ARB_shader_texture_lod_enable;
 333    bool ARB_shader_texture_lod_warn;
 334    bool ARB_shader_stencil_export_enable;
 335    bool ARB_shader_stencil_export_warn;
 336    bool AMD_conservative_depth_enable;
 337    bool AMD_conservative_depth_warn;
 338    bool ARB_conservative_depth_enable;
 339    bool ARB_conservative_depth_warn;
 340    bool AMD_shader_stencil_export_enable;
 341    bool AMD_shader_stencil_export_warn;
 342    bool OES_texture_3D_enable;
 343    bool OES_texture_3D_warn;
 344    bool OES_EGL_image_external_enable;
 345    bool OES_EGL_image_external_warn;
 346    bool ARB_shader_bit_encoding_enable;
 347    bool ARB_shader_bit_encoding_warn;
 348    bool ARB_uniform_buffer_object_enable;
 349    bool ARB_uniform_buffer_object_warn;
 350    bool OES_standard_derivatives_enable;
 351    bool OES_standard_derivatives_warn;
 352    bool ARB_texture_cube_map_array_enable;
 353    bool ARB_texture_cube_map_array_warn;
 354    bool ARB_shading_language_packing_enable;
 355    bool ARB_shading_language_packing_warn;
 356    bool ARB_texture_multisample_enable;
 357    bool ARB_texture_multisample_warn;
 358    bool ARB_texture_query_levels_enable;
 359    bool ARB_texture_query_levels_warn;
 360    bool ARB_texture_query_lod_enable;
 361    bool ARB_texture_query_lod_warn;
 362    bool ARB_gpu_shader5_enable;
 363    bool ARB_gpu_shader5_warn;
 364    bool AMD_vertex_shader_layer_enable;
 365    bool AMD_vertex_shader_layer_warn;
 366    bool ARB_shading_language_420pack_enable;
 367    bool ARB_shading_language_420pack_warn;
 368    bool ARB_sample_shading_enable;
 369    bool ARB_sample_shading_warn;
 370    bool EXT_shader_integer_mix_enable;
 371    bool EXT_shader_integer_mix_warn;
 372    bool ARB_shader_atomic_counters_enable;
 373    bool ARB_shader_atomic_counters_warn;
 374    bool AMD_shader_trinary_minmax_enable;
 375    bool AMD_shader_trinary_minmax_warn;
 376    bool ARB_viewport_array_enable;
 377    bool ARB_viewport_array_warn;
 378    bool ARB_compute_shader_enable;
 379    bool ARB_compute_shader_warn;
 380    /*@}*/
 381
 382    /** Extensions supported by the OpenGL implementation. */
 383    const struct gl_extensions *extensions;
 384
 385    bool uses_builtin_functions;
 386
 387    /**
 388     * For geometry shaders, size of the most recently seen input declaration
 389     * that was a sized array, or 0 if no sized input array declarations have
 390     * been seen.
 391     *
 392     * Unused for other shader types.
 393     */
 394    unsigned gs_input_size;
 395
 396    /** Atomic counter offsets by binding */
 397    unsigned atomic_counter_offsets[MAX_COMBINED_ATOMIC_BUFFERS];
 398 };
 399
 400 # define YYLLOC_DEFAULT(Current, Rhs, N)                        \
 401 do {                                                            \
 402    if (N)                                                       \
 403    {                                                            \
 404       (Current).first_line   = YYRHSLOC(Rhs, 1).first_line;     \
 405       (Current).first_column = YYRHSLOC(Rhs, 1).first_column;   \
 406       (Current).last_line    = YYRHSLOC(Rhs, N).last_line;      \
 407       (Current).last_column  = YYRHSLOC(Rhs, N).last_column;    \
 408    }                                                            \
 409    else                                                         \
 410    {                                                            \
 411       (Current).first_line   = (Current).last_line =            \
 412          YYRHSLOC(Rhs, 0).last_line;                            \
 413       (Current).first_column = (Current).last_column =          \
 414          YYRHSLOC(Rhs, 0).last_column;                          \
 415    }                                                            \
 416    (Current).source = 0;                                        \
 417 } while (0)
 418
 419 /**
 420  * Emit a warning to the shader log
 421  *
 422  * \sa _mesa_glsl_error
 423  */
 424 extern void _mesa_glsl_warning(const YYLTYPE *locp,
 425                                _mesa_glsl_parse_state *state,
 426                                const char *fmt, ...);
 427
 428 extern void _mesa_glsl_lexer_ctor(struct _mesa_glsl_parse_state *state,
 429                                   const char *string);
 430
 431 extern void _mesa_glsl_lexer_dtor(struct _mesa_glsl_parse_state *state);
 432
 433 union YYSTYPE;
 434 extern int _mesa_glsl_lexer_lex(union YYSTYPE *yylval, YYLTYPE *yylloc,
 435                                 void *scanner);
 436
 437 extern int _mesa_glsl_parse(struct _mesa_glsl_parse_state *);
 438
 439 /**
 440  * Process elements of the #extension directive
 441  *
 442  * \return
 443  * If \c name and \c behavior are valid, \c true is returned.  Otherwise
 444  * \c false is returned.
 445  */
 446 extern bool _mesa_glsl_process_extension(const char *name, YYLTYPE *name_locp,
 447                                          const char *behavior,
 448                                          YYLTYPE *behavior_locp,
 449                                          _mesa_glsl_parse_state *state);
 450
 451 #endif /* __cplusplus */
 452
 453
 454 /*
 455  * These definitions apply to C and C++
 456  */
 457 #ifdef __cplusplus
 458 extern "C" {
 459 #endif
 460
 461 /**
 462  * Get the textual name of the specified shader stage (which is a
 463  * gl_shader_stage).
 464  */
 465 extern const char *
 466 _mesa_shader_stage_to_string(unsigned stage);
 467
 468 extern int glcpp_preprocess(void *ctx, const char **shader, char **info_log,
 469                       const struct gl_extensions *extensions, struct gl_context *gl_ctx);
 470
 471 extern void _mesa_destroy_shader_compiler(void);
 472 extern void _mesa_destroy_shader_compiler_caches(void);
 473
 474 #ifdef __cplusplus
 475 }
 476 #endif
 477
 478
 479 #endif /* GLSL_PARSER_EXTRAS_H */