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    /* Callers of this ralloc-based new need not call delete. It's
  77     * easier to just ralloc_free 'ctx' (or any of its ancestors). */
  78    static void* operator new(size_t size, void *ctx)
  79    {
  80       void *mem = rzalloc_size(ctx, size);
  81       assert(mem != NULL);
  82
  83       return mem;
  84    }
  85
  86    /* If the user *does* call delete, that's OK, we will just
  87     * ralloc_free in that case. */
  88    static void operator delete(void *mem)
  89    {
  90       ralloc_free(mem);
  91    }
  92
  93    /**
  94     * Generate a string representing the GLSL version currently being compiled
  95     * (useful for error messages).
  96     */
  97    const char *get_version_string()
  98    {
  99       return glsl_compute_version_string(this, this->es_shader,
 100                                          this->language_version);
 101    }
 102
 103    /**
 104     * Determine whether the current GLSL version is sufficiently high to
 105     * support a certain feature.
 106     *
 107     * \param required_glsl_version is the desktop GLSL version that is
 108     * required to support the feature, or 0 if no version of desktop GLSL
 109     * supports the feature.
 110     *
 111     * \param required_glsl_es_version is the GLSL ES version that is required
 112     * to support the feature, or 0 if no version of GLSL ES suports the
 113     * feature.
 114     */
 115    bool is_version(unsigned required_glsl_version,
 116                    unsigned required_glsl_es_version)
 117    {
 118       unsigned required_version = this->es_shader ?
 119          required_glsl_es_version : required_glsl_version;
 120       return required_version != 0
 121          && this->language_version >= required_version;
 122    }
 123
 124    bool check_version(unsigned required_glsl_version,
 125                       unsigned required_glsl_es_version,
 126                       YYLTYPE *locp, const char *fmt, ...) PRINTFLIKE(5, 6);
 127
 128    bool check_precision_qualifiers_allowed(YYLTYPE *locp)
 129    {
 130       return check_version(130, 100, locp,
 131                            "precision qualifiers are forbidden");
 132    }
 133
 134    bool check_bitwise_operations_allowed(YYLTYPE *locp)
 135    {
 136       return check_version(130, 300, locp, "bit-wise operations are forbidden");
 137    }
 138
 139    void process_version_directive(YYLTYPE *locp, int version,
 140                                   const char *ident);
 141
 142    struct gl_context *const ctx;
 143    void *scanner;
 144    exec_list translation_unit;
 145    glsl_symbol_table *symbols;
 146
 147    unsigned num_uniform_blocks;
 148    unsigned uniform_block_array_size;
 149    struct gl_uniform_block *uniform_blocks;
 150
 151    unsigned num_supported_versions;
 152    struct {
 153       unsigned ver;
 154       bool es;
 155    } supported_versions[12];
 156
 157    bool es_shader;
 158    unsigned language_version;
 159    enum _mesa_glsl_parser_targets target;
 160
 161    /**
 162     * Default uniform layout qualifiers tracked during parsing.
 163     * Currently affects uniform blocks and uniform buffer variables in
 164     * those blocks.
 165     */
 166    struct ast_type_qualifier *default_uniform_qualifier;
 167
 168    /**
 169     * Printable list of GLSL versions supported by the current context
 170     *
 171     * \note
 172     * This string should probably be generated per-context instead of per
 173     * invokation of the compiler.  This should be changed when the method of
 174     * tracking supported GLSL versions changes.
 175     */
 176    const char *supported_version_string;
 177
 178    /**
 179     * Implementation defined limits that affect built-in variables, etc.
 180     *
 181     * \sa struct gl_constants (in mtypes.h)
 182     */
 183    struct {
 184       /* 1.10 */
 185       unsigned MaxLights;
 186       unsigned MaxClipPlanes;
 187       unsigned MaxTextureUnits;
 188       unsigned MaxTextureCoords;
 189       unsigned MaxVertexAttribs;
 190       unsigned MaxVertexUniformComponents;
 191       unsigned MaxVaryingFloats;
 192       unsigned MaxVertexTextureImageUnits;
 193       unsigned MaxCombinedTextureImageUnits;
 194       unsigned MaxTextureImageUnits;
 195       unsigned MaxFragmentUniformComponents;
 196
 197       /* ARB_draw_buffers */
 198       unsigned MaxDrawBuffers;
 199
 200       /* 3.00 ES */
 201       int MinProgramTexelOffset;
 202       int MaxProgramTexelOffset;
 203    } Const;
 204
 205    /**
 206     * During AST to IR conversion, pointer to current IR function
 207     *
 208     * Will be \c NULL whenever the AST to IR conversion is not inside a
 209     * function definition.
 210     */
 211    class ir_function_signature *current_function;
 212
 213    /**
 214     * During AST to IR conversion, pointer to the toplevel IR
 215     * instruction list being generated.
 216     */
 217    exec_list *toplevel_ir;
 218
 219    /** Have we found a return statement in this function? */
 220    bool found_return;
 221
 222    /** Was there an error during compilation? */
 223    bool error;
 224
 225    /**
 226     * Are all shader inputs / outputs invariant?
 227     *
 228     * This is set when the 'STDGL invariant(all)' pragma is used.
 229     */
 230    bool all_invariant;
 231
 232    /** Loop or switch statement containing the current instructions. */
 233    class ast_iteration_statement *loop_nesting_ast;
 234
 235    struct glsl_switch_state switch_state;
 236
 237    /** List of structures defined in user code. */
 238    const glsl_type **user_structures;
 239    unsigned num_user_structures;
 240
 241    char *info_log;
 242
 243    /**
 244     * \name Enable bits for GLSL extensions
 245     */
 246    /*@{*/
 247    bool ARB_draw_buffers_enable;
 248    bool ARB_draw_buffers_warn;
 249    bool ARB_draw_instanced_enable;
 250    bool ARB_draw_instanced_warn;
 251    bool ARB_explicit_attrib_location_enable;
 252    bool ARB_explicit_attrib_location_warn;
 253    bool ARB_fragment_coord_conventions_enable;
 254    bool ARB_fragment_coord_conventions_warn;
 255    bool ARB_texture_rectangle_enable;
 256    bool ARB_texture_rectangle_warn;
 257    bool EXT_texture_array_enable;
 258    bool EXT_texture_array_warn;
 259    bool ARB_shader_texture_lod_enable;
 260    bool ARB_shader_texture_lod_warn;
 261    bool ARB_shader_stencil_export_enable;
 262    bool ARB_shader_stencil_export_warn;
 263    bool AMD_conservative_depth_enable;
 264    bool AMD_conservative_depth_warn;
 265    bool ARB_conservative_depth_enable;
 266    bool ARB_conservative_depth_warn;
 267    bool AMD_shader_stencil_export_enable;
 268    bool AMD_shader_stencil_export_warn;
 269    bool OES_texture_3D_enable;
 270    bool OES_texture_3D_warn;
 271    bool OES_EGL_image_external_enable;
 272    bool OES_EGL_image_external_warn;
 273    bool ARB_shader_bit_encoding_enable;
 274    bool ARB_shader_bit_encoding_warn;
 275    bool ARB_uniform_buffer_object_enable;
 276    bool ARB_uniform_buffer_object_warn;
 277    bool OES_standard_derivatives_enable;
 278    bool OES_standard_derivatives_warn;
 279    bool ARB_texture_cube_map_array_enable;
 280    bool ARB_texture_cube_map_array_warn;
 281    bool ARB_shading_language_packing_enable;
 282    bool ARB_shading_language_packing_warn;
 283    bool ARB_texture_multisample_enable;
 284    bool ARB_texture_multisample_warn;
 285    bool ARB_texture_query_lod_enable;
 286    bool ARB_texture_query_lod_warn;
 287    bool ARB_gpu_shader5_enable;
 288    bool ARB_gpu_shader5_warn;
 289    bool AMD_vertex_shader_layer_enable;
 290    bool AMD_vertex_shader_layer_warn;
 291    bool ARB_shading_language_420pack_enable;
 292    bool ARB_shading_language_420pack_warn;
 293    /*@}*/
 294
 295    /** Extensions supported by the OpenGL implementation. */
 296    const struct gl_extensions *extensions;
 297
 298    /** Shaders containing built-in functions that are used for linking. */
 299    struct gl_shader *builtins_to_link[16];
 300    unsigned num_builtins_to_link;
 301 };
 302
 303 # define YYLLOC_DEFAULT(Current, Rhs, N)                        \
 304 do {                                                            \
 305    if (N)                                                       \
 306    {                                                            \
 307       (Current).first_line   = YYRHSLOC(Rhs, 1).first_line;     \
 308       (Current).first_column = YYRHSLOC(Rhs, 1).first_column;   \
 309       (Current).last_line    = YYRHSLOC(Rhs, N).last_line;      \
 310       (Current).last_column  = YYRHSLOC(Rhs, N).last_column;    \
 311    }                                                            \
 312    else                                                         \
 313    {                                                            \
 314       (Current).first_line   = (Current).last_line =            \
 315          YYRHSLOC(Rhs, 0).last_line;                            \
 316       (Current).first_column = (Current).last_column =          \
 317          YYRHSLOC(Rhs, 0).last_column;                          \
 318    }                                                            \
 319    (Current).source = 0;                                        \
 320 } while (0)
 321
 322 extern void _mesa_glsl_error(YYLTYPE *locp, _mesa_glsl_parse_state *state,
 323                              const char *fmt, ...);
 324
 325 /**
 326  * Emit a warning to the shader log
 327  *
 328  * \sa _mesa_glsl_error
 329  */
 330 extern void _mesa_glsl_warning(const YYLTYPE *locp,
 331                                _mesa_glsl_parse_state *state,
 332                                const char *fmt, ...);
 333
 334 extern void _mesa_glsl_lexer_ctor(struct _mesa_glsl_parse_state *state,
 335                                   const char *string);
 336
 337 extern void _mesa_glsl_lexer_dtor(struct _mesa_glsl_parse_state *state);
 338
 339 union YYSTYPE;
 340 extern int _mesa_glsl_lex(union YYSTYPE *yylval, YYLTYPE *yylloc,
 341                           void *scanner);
 342
 343 extern int _mesa_glsl_parse(struct _mesa_glsl_parse_state *);
 344
 345 /**
 346  * Process elements of the #extension directive
 347  *
 348  * \return
 349  * If \c name and \c behavior are valid, \c true is returned.  Otherwise
 350  * \c false is returned.
 351  */
 352 extern bool _mesa_glsl_process_extension(const char *name, YYLTYPE *name_locp,
 353                                          const char *behavior,
 354                                          YYLTYPE *behavior_locp,
 355                                          _mesa_glsl_parse_state *state);
 356
 357 /**
 358  * Get the textual name of the specified shader target
 359  */
 360 extern const char *
 361 _mesa_glsl_shader_target_name(enum _mesa_glsl_parser_targets target);
 362
 363
 364 #endif /* __cplusplus */
 365
 366
 367 /*
 368  * These definitions apply to C and C++
 369  */
 370 #ifdef __cplusplus
 371 extern "C" {
 372 #endif
 373
 374 extern int glcpp_preprocess(void *ctx, const char **shader, char **info_log,
 375                       const struct gl_extensions *extensions, struct gl_context *gl_ctx);
 376
 377 extern void _mesa_destroy_shader_compiler(void);
 378 extern void _mesa_destroy_shader_compiler_caches(void);
 379
 380 #ifdef __cplusplus
 381 }
 382 #endif
 383
 384
 385 #endif /* GLSL_PARSER_EXTRAS_H */