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