src/compiler/glsl/ast.h

   1 /* -*- c++ -*- */
   2 /*
   3  * Copyright © 2009 Intel Corporation
   4  *
   5  * Permission is hereby granted, free of charge, to any person obtaining a
   6  * copy of this software and associated documentation files (the "Software"),
   7  * to deal in the Software without restriction, including without limitation
   8  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
   9  * and/or sell copies of the Software, and to permit persons to whom the
  10  * Software is furnished to do so, subject to the following conditions:
  11  *
  12  * The above copyright notice and this permission notice (including the next
  13  * paragraph) shall be included in all copies or substantial portions of the
  14  * Software.
  15  *
  16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  19  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  21  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  22  * DEALINGS IN THE SOFTWARE.
  23  */
  24
  25 #ifndef AST_H
  26 #define AST_H
  27
  28 #include "list.h"
  29 #include "glsl_parser_extras.h"
  30 #include "compiler/glsl_types.h"
  31 #include "util/bitset.h"
  32
  33 struct _mesa_glsl_parse_state;
  34
  35 struct YYLTYPE;
  36
  37 /**
  38  * \defgroup AST Abstract syntax tree node definitions
  39  *
  40  * An abstract syntax tree is generated by the parser.  This is a fairly
  41  * direct representation of the gramma derivation for the source program.
  42  * No symantic checking is done during the generation of the AST.  Only
  43  * syntactic checking is done.  Symantic checking is performed by a later
  44  * stage that converts the AST to a more generic intermediate representation.
  45  *
  46  *@{
  47  */
  48 /**
  49  * Base class of all abstract syntax tree nodes
  50  */
  51 class ast_node {
  52 public:
  53    DECLARE_LINEAR_ZALLOC_CXX_OPERATORS(ast_node);
  54
  55    /**
  56     * Print an AST node in something approximating the original GLSL code
  57     */
  58    virtual void print(void) const;
  59
  60    /**
  61     * Convert the AST node to the high-level intermediate representation
  62     */
  63    virtual ir_rvalue *hir(exec_list *instructions,
  64                           struct _mesa_glsl_parse_state *state);
  65
  66    virtual bool has_sequence_subexpression() const;
  67
  68    /**
  69     * Retrieve the source location of an AST node
  70     *
  71     * This function is primarily used to get the source position of an AST node
  72     * into a form that can be passed to \c _mesa_glsl_error.
  73     *
  74     * \sa _mesa_glsl_error, ast_node::set_location
  75     */
  76    struct YYLTYPE get_location(void) const
  77    {
  78       struct YYLTYPE locp;
  79
  80       locp.source = this->location.source;
  81       locp.first_line = this->location.first_line;
  82       locp.first_column = this->location.first_column;
  83       locp.last_line = this->location.last_line;
  84       locp.last_column = this->location.last_column;
  85
  86       return locp;
  87    }
  88
  89    /**
  90     * Set the source location of an AST node from a parser location
  91     *
  92     * \sa ast_node::get_location
  93     */
  94    void set_location(const struct YYLTYPE &locp)
  95    {
  96       this->location.source = locp.source;
  97       this->location.first_line = locp.first_line;
  98       this->location.first_column = locp.first_column;
  99       this->location.last_line = locp.last_line;
 100       this->location.last_column = locp.last_column;
 101    }
 102
 103    /**
 104     * Set the source location range of an AST node using two location nodes
 105     *
 106     * \sa ast_node::set_location
 107     */
 108    void set_location_range(const struct YYLTYPE &begin, const struct YYLTYPE &end)
 109    {
 110       this->location.source = begin.source;
 111       this->location.first_line = begin.first_line;
 112       this->location.last_line = end.last_line;
 113       this->location.first_column = begin.first_column;
 114       this->location.last_column = end.last_column;
 115    }
 116
 117    /**
 118     * Source location of the AST node.
 119     */
 120    struct {
 121       unsigned source;          /**< GLSL source number. */
 122       unsigned first_line;      /**< First line number within the source string. */
 123       unsigned first_column;    /**< First column in the first line. */
 124       unsigned last_line;       /**< Last line number within the source string. */
 125       unsigned last_column;     /**< Last column in the last line. */
 126    } location;
 127
 128    exec_node link;
 129
 130    virtual void set_is_lhs(bool);
 131
 132 protected:
 133    /**
 134     * The only constructor is protected so that only derived class objects can
 135     * be created.
 136     */
 137    ast_node(void);
 138 };
 139
 140
 141 /**
 142  * Operators for AST expression nodes.
 143  */
 144 enum ast_operators {
 145    ast_assign,
 146    ast_plus,        /**< Unary + operator. */
 147    ast_neg,
 148    ast_add,
 149    ast_sub,
 150    ast_mul,
 151    ast_div,
 152    ast_mod,
 153    ast_lshift,
 154    ast_rshift,
 155    ast_less,
 156    ast_greater,
 157    ast_lequal,
 158    ast_gequal,
 159    ast_equal,
 160    ast_nequal,
 161    ast_bit_and,
 162    ast_bit_xor,
 163    ast_bit_or,
 164    ast_bit_not,
 165    ast_logic_and,
 166    ast_logic_xor,
 167    ast_logic_or,
 168    ast_logic_not,
 169
 170    ast_mul_assign,
 171    ast_div_assign,
 172    ast_mod_assign,
 173    ast_add_assign,
 174    ast_sub_assign,
 175    ast_ls_assign,
 176    ast_rs_assign,
 177    ast_and_assign,
 178    ast_xor_assign,
 179    ast_or_assign,
 180
 181    ast_conditional,
 182
 183    ast_pre_inc,
 184    ast_pre_dec,
 185    ast_post_inc,
 186    ast_post_dec,
 187    ast_field_selection,
 188    ast_array_index,
 189    ast_unsized_array_dim,
 190
 191    ast_function_call,
 192
 193    ast_identifier,
 194    ast_int_constant,
 195    ast_uint_constant,
 196    ast_float_constant,
 197    ast_bool_constant,
 198    ast_double_constant,
 199    ast_int64_constant,
 200    ast_uint64_constant,
 201
 202    ast_sequence,
 203    ast_aggregate
 204
 205    /**
 206     * Number of possible operators for an ast_expression
 207     *
 208     * This is done as a define instead of as an additional value in the enum so
 209     * that the compiler won't generate spurious messages like "warning:
 210     * enumeration value ‘ast_num_operators’ not handled in switch"
 211     */
 212    #define AST_NUM_OPERATORS (ast_aggregate + 1)
 213 };
 214
 215 /**
 216  * Representation of any sort of expression.
 217  */
 218 class ast_expression : public ast_node {
 219 public:
 220    ast_expression(int oper, ast_expression *,
 221                   ast_expression *, ast_expression *);
 222
 223    ast_expression(const char *identifier) :
 224       oper(ast_identifier)
 225    {
 226       subexpressions[0] = NULL;
 227       subexpressions[1] = NULL;
 228       subexpressions[2] = NULL;
 229       primary_expression.identifier = identifier;
 230       this->non_lvalue_description = NULL;
 231       this->is_lhs = false;
 232    }
 233
 234    static const char *operator_string(enum ast_operators op);
 235
 236    virtual ir_rvalue *hir(exec_list *instructions,
 237                           struct _mesa_glsl_parse_state *state);
 238
 239    virtual void hir_no_rvalue(exec_list *instructions,
 240                               struct _mesa_glsl_parse_state *state);
 241
 242    virtual bool has_sequence_subexpression() const;
 243
 244    ir_rvalue *do_hir(exec_list *instructions,
 245                      struct _mesa_glsl_parse_state *state,
 246                      bool needs_rvalue);
 247
 248    virtual void print(void) const;
 249
 250    enum ast_operators oper;
 251
 252    ast_expression *subexpressions[3];
 253
 254    union {
 255       const char *identifier;
 256       int int_constant;
 257       float float_constant;
 258       unsigned uint_constant;
 259       int bool_constant;
 260       double double_constant;
 261       uint64_t uint64_constant;
 262       int64_t int64_constant;
 263    } primary_expression;
 264
 265
 266    /**
 267     * List of expressions for an \c ast_sequence or parameters for an
 268     * \c ast_function_call
 269     */
 270    exec_list expressions;
 271
 272    /**
 273     * For things that can't be l-values, this describes what it is.
 274     *
 275     * This text is used by the code that generates IR for assignments to
 276     * detect and emit useful messages for assignments to some things that
 277     * can't be l-values.  For example, pre- or post-incerement expressions.
 278     *
 279     * \note
 280     * This pointer may be \c NULL.
 281     */
 282    const char *non_lvalue_description;
 283
 284    void set_is_lhs(bool new_value);
 285
 286 private:
 287    bool is_lhs;
 288 };
 289
 290 class ast_expression_bin : public ast_expression {
 291 public:
 292    ast_expression_bin(int oper, ast_expression *, ast_expression *);
 293
 294    virtual void print(void) const;
 295 };
 296
 297 /**
 298  * Subclass of expressions for function calls
 299  */
 300 class ast_function_expression : public ast_expression {
 301 public:
 302    ast_function_expression(ast_expression *callee)
 303       : ast_expression(ast_function_call, callee,
 304                        NULL, NULL),
 305         cons(false)
 306    {
 307       /* empty */
 308    }
 309
 310    ast_function_expression(class ast_type_specifier *type)
 311       : ast_expression(ast_function_call, (ast_expression *) type,
 312                        NULL, NULL),
 313         cons(true)
 314    {
 315       /* empty */
 316    }
 317
 318    bool is_constructor() const
 319    {
 320       return cons;
 321    }
 322
 323    virtual ir_rvalue *hir(exec_list *instructions,
 324                           struct _mesa_glsl_parse_state *state);
 325
 326    virtual void hir_no_rvalue(exec_list *instructions,
 327                               struct _mesa_glsl_parse_state *state);
 328
 329    virtual bool has_sequence_subexpression() const;
 330
 331 private:
 332    /**
 333     * Is this function call actually a constructor?
 334     */
 335    bool cons;
 336    ir_rvalue *
 337    handle_method(exec_list *instructions,
 338                  struct _mesa_glsl_parse_state *state);
 339 };
 340
 341 class ast_subroutine_list : public ast_node
 342 {
 343 public:
 344    virtual void print(void) const;
 345    exec_list declarations;
 346 };
 347
 348 class ast_array_specifier : public ast_node {
 349 public:
 350    ast_array_specifier(const struct YYLTYPE &locp, ast_expression *dim)
 351    {
 352       set_location(locp);
 353       array_dimensions.push_tail(&dim->link);
 354    }
 355
 356    void add_dimension(ast_expression *dim)
 357    {
 358       array_dimensions.push_tail(&dim->link);
 359    }
 360
 361    bool is_single_dimension() const
 362    {
 363       return this->array_dimensions.get_tail_raw()->prev != NULL &&
 364              this->array_dimensions.get_tail_raw()->prev->is_head_sentinel();
 365    }
 366
 367    virtual void print(void) const;
 368
 369    /* This list contains objects of type ast_node containing the
 370     * array dimensions in outermost-to-innermost order.
 371     */
 372    exec_list array_dimensions;
 373 };
 374
 375 class ast_layout_expression : public ast_node {
 376 public:
 377    ast_layout_expression(const struct YYLTYPE &locp, ast_expression *expr)
 378    {
 379       set_location(locp);
 380       layout_const_expressions.push_tail(&expr->link);
 381    }
 382
 383    bool process_qualifier_constant(struct _mesa_glsl_parse_state *state,
 384                                    const char *qual_indentifier,
 385                                    unsigned *value, bool can_be_zero);
 386
 387    void merge_qualifier(ast_layout_expression *l_expr)
 388    {
 389       layout_const_expressions.append_list(&l_expr->layout_const_expressions);
 390    }
 391
 392    exec_list layout_const_expressions;
 393 };
 394
 395 /**
 396  * C-style aggregate initialization class
 397  *
 398  * Represents C-style initializers of vectors, matrices, arrays, and
 399  * structures. E.g., vec3 pos = {1.0, 0.0, -1.0} is equivalent to
 400  * vec3 pos = vec3(1.0, 0.0, -1.0).
 401  *
 402  * Specified in GLSL 4.20 and GL_ARB_shading_language_420pack.
 403  *
 404  * \sa _mesa_ast_set_aggregate_type
 405  */
 406 class ast_aggregate_initializer : public ast_expression {
 407 public:
 408    ast_aggregate_initializer()
 409       : ast_expression(ast_aggregate, NULL, NULL, NULL),
 410         constructor_type(NULL)
 411    {
 412       /* empty */
 413    }
 414
 415    /**
 416     * glsl_type of the aggregate, which is inferred from the LHS of whatever
 417     * the aggregate is being used to initialize.  This can't be inferred at
 418     * parse time (since the parser deals with ast_type_specifiers, not
 419     * glsl_types), so the parser leaves it NULL.  However, the ast-to-hir
 420     * conversion code makes sure to fill it in with the appropriate type
 421     * before hir() is called.
 422     */
 423    const glsl_type *constructor_type;
 424
 425    virtual ir_rvalue *hir(exec_list *instructions,
 426                           struct _mesa_glsl_parse_state *state);
 427
 428    virtual void hir_no_rvalue(exec_list *instructions,
 429                               struct _mesa_glsl_parse_state *state);
 430 };
 431
 432
 433 class ast_compound_statement : public ast_node {
 434 public:
 435    ast_compound_statement(int new_scope, ast_node *statements);
 436    virtual void print(void) const;
 437
 438    virtual ir_rvalue *hir(exec_list *instructions,
 439                           struct _mesa_glsl_parse_state *state);
 440
 441    int new_scope;
 442    exec_list statements;
 443 };
 444
 445 class ast_declaration : public ast_node {
 446 public:
 447    ast_declaration(const char *identifier,
 448                    ast_array_specifier *array_specifier,
 449                    ast_expression *initializer);
 450    virtual void print(void) const;
 451
 452    const char *identifier;
 453
 454    ast_array_specifier *array_specifier;
 455
 456    ast_expression *initializer;
 457 };
 458
 459
 460 enum {
 461    ast_precision_none = 0, /**< Absence of precision qualifier. */
 462    ast_precision_high,
 463    ast_precision_medium,
 464    ast_precision_low
 465 };
 466
 467 enum {
 468    ast_depth_none = 0, /**< Absence of depth qualifier. */
 469    ast_depth_any,
 470    ast_depth_greater,
 471    ast_depth_less,
 472    ast_depth_unchanged
 473 };
 474
 475 struct ast_type_qualifier {
 476    DECLARE_RALLOC_CXX_OPERATORS(ast_type_qualifier);
 477    /* Note: this bitset needs to have at least as many bits as the 'q'
 478     * struct has flags, below.  Previously, the size was 128 instead of 96.
 479     * But an apparent bug in GCC 5.4.0 causes bad SSE code generation
 480     * elsewhere, leading to a crash.  96 bits works around the issue.
 481     * See https://bugs.freedesktop.org/show_bug.cgi?id=105497
 482     */
 483    DECLARE_BITSET_T(bitset_t, 96);
 484
 485    union flags {
 486       struct {
 487          unsigned invariant:1;
 488          unsigned precise:1;
 489          unsigned constant:1;
 490          unsigned attribute:1;
 491          unsigned varying:1;
 492          unsigned in:1;
 493          unsigned out:1;
 494          unsigned centroid:1;
 495          unsigned sample:1;
 496          unsigned patch:1;
 497          unsigned uniform:1;
 498          unsigned buffer:1;
 499          unsigned shared_storage:1;
 500          unsigned smooth:1;
 501          unsigned flat:1;
 502          unsigned noperspective:1;
 503
 504          /** \name Layout qualifiers for GL_ARB_fragment_coord_conventions */
 505          /*@{*/
 506          unsigned origin_upper_left:1;
 507          unsigned pixel_center_integer:1;
 508          /*@}*/
 509
 510          /**
 511           * Flag set if GL_ARB_enhanced_layouts "align" layout qualifier is
 512           * used.
 513           */
 514          unsigned explicit_align:1;
 515
 516          /**
 517           * Flag set if GL_ARB_explicit_attrib_location "location" layout
 518           * qualifier is used.
 519           */
 520          unsigned explicit_location:1;
 521          /**
 522           * Flag set if GL_ARB_explicit_attrib_location "index" layout
 523           * qualifier is used.
 524           */
 525          unsigned explicit_index:1;
 526
 527          /**
 528           * Flag set if GL_ARB_enhanced_layouts "component" layout
 529           * qualifier is used.
 530           */
 531          unsigned explicit_component:1;
 532
 533          /**
 534           * Flag set if GL_ARB_shading_language_420pack "binding" layout
 535           * qualifier is used.
 536           */
 537          unsigned explicit_binding:1;
 538
 539          /**
 540           * Flag set if GL_ARB_shader_atomic counter "offset" layout
 541           * qualifier is used.
 542           */
 543          unsigned explicit_offset:1;
 544
 545          /** \name Layout qualifiers for GL_AMD_conservative_depth */
 546          /** \{ */
 547          unsigned depth_type:1;
 548          /** \} */
 549
 550          /** \name Layout qualifiers for GL_ARB_uniform_buffer_object */
 551          /** \{ */
 552          unsigned std140:1;
 553          unsigned std430:1;
 554          unsigned shared:1;
 555          unsigned packed:1;
 556          unsigned column_major:1;
 557          unsigned row_major:1;
 558          /** \} */
 559
 560          /** \name Layout qualifiers for GLSL 1.50 geometry shaders */
 561          /** \{ */
 562          unsigned prim_type:1;
 563          unsigned max_vertices:1;
 564          /** \} */
 565
 566          /**
 567           * local_size_{x,y,z} flags for compute shaders.  Bit 0 represents
 568           * local_size_x, and so on.
 569           */
 570          unsigned local_size:3;
 571
 572          /** \name Layout qualifiers for ARB_compute_variable_group_size. */
 573          /** \{ */
 574          unsigned local_size_variable:1;
 575          /** \} */
 576
 577          /** \name Layout and memory qualifiers for ARB_shader_image_load_store. */
 578          /** \{ */
 579          unsigned early_fragment_tests:1;
 580          unsigned explicit_image_format:1;
 581          unsigned coherent:1;
 582          unsigned _volatile:1;
 583          unsigned restrict_flag:1;
 584          unsigned read_only:1; /**< "readonly" qualifier. */
 585          unsigned write_only:1; /**< "writeonly" qualifier. */
 586          /** \} */
 587
 588          /** \name Layout qualifiers for GL_ARB_gpu_shader5 */
 589          /** \{ */
 590          unsigned invocations:1;
 591          unsigned stream:1; /**< Has stream value assigned  */
 592          unsigned explicit_stream:1; /**< stream value assigned explicitly by shader code */
 593          /** \} */
 594
 595          /** \name Layout qualifiers for GL_ARB_enhanced_layouts */
 596          /** \{ */
 597          unsigned explicit_xfb_offset:1; /**< xfb_offset value assigned explicitly by shader code */
 598          unsigned xfb_buffer:1; /**< Has xfb_buffer value assigned  */
 599          unsigned explicit_xfb_buffer:1; /**< xfb_buffer value assigned explicitly by shader code */
 600          unsigned xfb_stride:1; /**< Is xfb_stride value yet to be merged with global values  */
 601          unsigned explicit_xfb_stride:1; /**< xfb_stride value assigned explicitly by shader code */
 602          /** \} */
 603
 604          /** \name Layout qualifiers for GL_ARB_tessellation_shader */
 605          /** \{ */
 606          /* tess eval input layout */
 607          /* gs prim_type reused for primitive mode */
 608          unsigned vertex_spacing:1;
 609          unsigned ordering:1;
 610          unsigned point_mode:1;
 611          /* tess control output layout */
 612          unsigned vertices:1;
 613          /** \} */
 614
 615          /** \name Qualifiers for GL_ARB_shader_subroutine */
 616          /** \{ */
 617          unsigned subroutine:1;  /**< Is this marked 'subroutine' */
 618          /** \} */
 619
 620          /** \name Qualifiers for GL_KHR_blend_equation_advanced */
 621          /** \{ */
 622          unsigned blend_support:1; /**< Are there any blend_support_ qualifiers */
 623          /** \} */
 624
 625          /**
 626           * Flag set if GL_ARB_post_depth_coverage layout qualifier is used.
 627           */
 628          unsigned post_depth_coverage:1;
 629          /**
 630           * Flag set if GL_INTEL_conservartive_rasterization layout qualifier
 631           * is used.
 632           */
 633          unsigned inner_coverage:1;
 634
 635          /** \name Layout qualifiers for GL_ARB_bindless_texture */
 636          /** \{ */
 637          unsigned bindless_sampler:1;
 638          unsigned bindless_image:1;
 639          unsigned bound_sampler:1;
 640          unsigned bound_image:1;
 641          /** \} */
 642
 643          /** \name Layout qualifiers for GL_EXT_shader_framebuffer_fetch_non_coherent */
 644          /** \{ */
 645          unsigned non_coherent:1;
 646          /** \} */
 647       }
 648       /** \brief Set of flags, accessed by name. */
 649       q;
 650
 651       /** \brief Set of flags, accessed as a bitmask. */
 652       bitset_t i;
 653    } flags;
 654
 655    /** Precision of the type (highp/medium/lowp). */
 656    unsigned precision:2;
 657
 658    /** Type of layout qualifiers for GL_AMD_conservative_depth. */
 659    unsigned depth_type:3;
 660
 661    /**
 662     * Alignment specified via GL_ARB_enhanced_layouts "align" layout qualifier
 663     */
 664    ast_expression *align;
 665
 666    /** Geometry shader invocations for GL_ARB_gpu_shader5. */
 667    ast_layout_expression *invocations;
 668
 669    /**
 670     * Location specified via GL_ARB_explicit_attrib_location layout
 671     *
 672     * \note
 673     * This field is only valid if \c explicit_location is set.
 674     */
 675    ast_expression *location;
 676    /**
 677     * Index specified via GL_ARB_explicit_attrib_location layout
 678     *
 679     * \note
 680     * This field is only valid if \c explicit_index is set.
 681     */
 682    ast_expression *index;
 683
 684    /**
 685     * Component specified via GL_ARB_enhaced_layouts
 686     *
 687     * \note
 688     * This field is only valid if \c explicit_component is set.
 689     */
 690    ast_expression *component;
 691
 692    /** Maximum output vertices in GLSL 1.50 geometry shaders. */
 693    ast_layout_expression *max_vertices;
 694
 695    /** Stream in GLSL 1.50 geometry shaders. */
 696    ast_expression *stream;
 697
 698    /** xfb_buffer specified via the GL_ARB_enhanced_layouts keyword. */
 699    ast_expression *xfb_buffer;
 700
 701    /** xfb_stride specified via the GL_ARB_enhanced_layouts keyword. */
 702    ast_expression *xfb_stride;
 703
 704    /** global xfb_stride values for each buffer */
 705    ast_layout_expression *out_xfb_stride[MAX_FEEDBACK_BUFFERS];
 706
 707    /**
 708     * Input or output primitive type in GLSL 1.50 geometry shaders
 709     * and tessellation shaders.
 710     */
 711    GLenum prim_type;
 712
 713    /**
 714     * Binding specified via GL_ARB_shading_language_420pack's "binding" keyword.
 715     *
 716     * \note
 717     * This field is only valid if \c explicit_binding is set.
 718     */
 719    ast_expression *binding;
 720
 721    /**
 722     * Offset specified via GL_ARB_shader_atomic_counter's or
 723     * GL_ARB_enhanced_layouts "offset" keyword, or by GL_ARB_enhanced_layouts
 724     * "xfb_offset" keyword.
 725     *
 726     * \note
 727     * This field is only valid if \c explicit_offset is set.
 728     */
 729    ast_expression *offset;
 730
 731    /**
 732     * Local size specified via GL_ARB_compute_shader's "local_size_{x,y,z}"
 733     * layout qualifier.  Element i of this array is only valid if
 734     * flags.q.local_size & (1 << i) is set.
 735     */
 736    ast_layout_expression *local_size[3];
 737
 738    /** Tessellation evaluation shader: vertex spacing (equal, fractional even/odd) */
 739    enum gl_tess_spacing vertex_spacing;
 740
 741    /** Tessellation evaluation shader: vertex ordering (CW or CCW) */
 742    GLenum ordering;
 743
 744    /** Tessellation evaluation shader: point mode */
 745    bool point_mode;
 746
 747    /** Tessellation control shader: number of output vertices */
 748    ast_layout_expression *vertices;
 749
 750    /**
 751     * Image format specified with an ARB_shader_image_load_store
 752     * layout qualifier.
 753     *
 754     * \note
 755     * This field is only valid if \c explicit_image_format is set.
 756     */
 757    GLenum image_format;
 758
 759    /**
 760     * Base type of the data read from or written to this image.  Only
 761     * the following enumerants are allowed: GLSL_TYPE_UINT,
 762     * GLSL_TYPE_INT, GLSL_TYPE_FLOAT.
 763     *
 764     * \note
 765     * This field is only valid if \c explicit_image_format is set.
 766     */
 767    glsl_base_type image_base_type;
 768
 769    /**
 770     * Return true if and only if an interpolation qualifier is present.
 771     */
 772    bool has_interpolation() const;
 773
 774    /**
 775     * Return whether a layout qualifier is present.
 776     */
 777    bool has_layout() const;
 778
 779    /**
 780     * Return whether a storage qualifier is present.
 781     */
 782    bool has_storage() const;
 783
 784    /**
 785     * Return whether an auxiliary storage qualifier is present.
 786     */
 787    bool has_auxiliary_storage() const;
 788
 789    /**
 790     * Return true if and only if a memory qualifier is present.
 791     */
 792    bool has_memory() const;
 793
 794    /**
 795     * Return true if the qualifier is a subroutine declaration.
 796     */
 797    bool is_subroutine_decl() const;
 798
 799    bool merge_qualifier(YYLTYPE *loc,
 800                         _mesa_glsl_parse_state *state,
 801                         const ast_type_qualifier &q,
 802                         bool is_single_layout_merge,
 803                         bool is_multiple_layouts_merge = false);
 804
 805    /**
 806     * Validate current qualifier against the global out one.
 807     */
 808    bool validate_out_qualifier(YYLTYPE *loc,
 809                                _mesa_glsl_parse_state *state);
 810
 811    /**
 812     * Merge current qualifier into the global out one.
 813     */
 814    bool merge_into_out_qualifier(YYLTYPE *loc,
 815                                  _mesa_glsl_parse_state *state,
 816                                  ast_node* &node);
 817
 818    /**
 819     * Validate current qualifier against the global in one.
 820     */
 821    bool validate_in_qualifier(YYLTYPE *loc,
 822                               _mesa_glsl_parse_state *state);
 823
 824    /**
 825     * Merge current qualifier into the global in one.
 826     */
 827    bool merge_into_in_qualifier(YYLTYPE *loc,
 828                                 _mesa_glsl_parse_state *state,
 829                                 ast_node* &node);
 830
 831    /**
 832     * Push pending layout qualifiers to the global values.
 833     */
 834    bool push_to_global(YYLTYPE *loc,
 835                        _mesa_glsl_parse_state *state);
 836
 837    bool validate_flags(YYLTYPE *loc,
 838                        _mesa_glsl_parse_state *state,
 839                        const ast_type_qualifier &allowed_flags,
 840                        const char *message, const char *name);
 841
 842    ast_subroutine_list *subroutine_list;
 843 };
 844
 845 class ast_declarator_list;
 846
 847 class ast_struct_specifier : public ast_node {
 848 public:
 849    ast_struct_specifier(const char *identifier,
 850                         ast_declarator_list *declarator_list);
 851    virtual void print(void) const;
 852
 853    virtual ir_rvalue *hir(exec_list *instructions,
 854                           struct _mesa_glsl_parse_state *state);
 855
 856    const char *name;
 857    ast_type_qualifier *layout;
 858    /* List of ast_declarator_list * */
 859    exec_list declarations;
 860    bool is_declaration;
 861    const glsl_type *type;
 862 };
 863
 864
 865
 866 class ast_type_specifier : public ast_node {
 867 public:
 868    /** Construct a type specifier from a type name */
 869    ast_type_specifier(const char *name)
 870       : type(NULL), type_name(name), structure(NULL), array_specifier(NULL),
 871         default_precision(ast_precision_none)
 872    {
 873       /* empty */
 874    }
 875
 876    /** Construct a type specifier from a structure definition */
 877    ast_type_specifier(ast_struct_specifier *s)
 878       : type(NULL), type_name(s->name), structure(s), array_specifier(NULL),
 879         default_precision(ast_precision_none)
 880    {
 881       /* empty */
 882    }
 883
 884    ast_type_specifier(const glsl_type *t)
 885       : type(t), type_name(t->name), structure(NULL), array_specifier(NULL),
 886         default_precision(ast_precision_none)
 887    {
 888       /* empty */
 889    }
 890
 891    const struct glsl_type *glsl_type(const char **name,
 892                                      struct _mesa_glsl_parse_state *state)
 893       const;
 894
 895    virtual void print(void) const;
 896
 897    ir_rvalue *hir(exec_list *, struct _mesa_glsl_parse_state *);
 898
 899    const struct glsl_type *type;
 900    const char *type_name;
 901    ast_struct_specifier *structure;
 902
 903    ast_array_specifier *array_specifier;
 904
 905    /** For precision statements, this is the given precision; otherwise none. */
 906    unsigned default_precision:2;
 907 };
 908
 909
 910 class ast_fully_specified_type : public ast_node {
 911 public:
 912    virtual void print(void) const;
 913    bool has_qualifiers(_mesa_glsl_parse_state *state) const;
 914
 915    ast_fully_specified_type() : qualifier(), specifier(NULL)
 916    {
 917    }
 918
 919    const struct glsl_type *glsl_type(const char **name,
 920                                      struct _mesa_glsl_parse_state *state)
 921       const;
 922
 923    ast_type_qualifier qualifier;
 924    ast_type_specifier *specifier;
 925 };
 926
 927
 928 class ast_declarator_list : public ast_node {
 929 public:
 930    ast_declarator_list(ast_fully_specified_type *);
 931    virtual void print(void) const;
 932
 933    virtual ir_rvalue *hir(exec_list *instructions,
 934                           struct _mesa_glsl_parse_state *state);
 935
 936    ast_fully_specified_type *type;
 937    /** List of 'ast_declaration *' */
 938    exec_list declarations;
 939
 940    /**
 941     * Flags for redeclarations. In these cases, no type is specified, to
 942     * `type` is allowed to be NULL. In all other cases, this would be an error.
 943     */
 944    int invariant;     /** < `invariant` redeclaration */
 945    int precise;       /** < `precise` redeclaration */
 946 };
 947
 948
 949 class ast_parameter_declarator : public ast_node {
 950 public:
 951    ast_parameter_declarator() :
 952       type(NULL),
 953       identifier(NULL),
 954       array_specifier(NULL),
 955       formal_parameter(false),
 956       is_void(false)
 957    {
 958       /* empty */
 959    }
 960
 961    virtual void print(void) const;
 962
 963    virtual ir_rvalue *hir(exec_list *instructions,
 964                           struct _mesa_glsl_parse_state *state);
 965
 966    ast_fully_specified_type *type;
 967    const char *identifier;
 968    ast_array_specifier *array_specifier;
 969
 970    static void parameters_to_hir(exec_list *ast_parameters,
 971                                  bool formal, exec_list *ir_parameters,
 972                                  struct _mesa_glsl_parse_state *state);
 973
 974 private:
 975    /** Is this parameter declaration part of a formal parameter list? */
 976    bool formal_parameter;
 977
 978    /**
 979     * Is this parameter 'void' type?
 980     *
 981     * This field is set by \c ::hir.
 982     */
 983    bool is_void;
 984 };
 985
 986
 987 class ast_function : public ast_node {
 988 public:
 989    ast_function(void);
 990
 991    virtual void print(void) const;
 992
 993    virtual ir_rvalue *hir(exec_list *instructions,
 994                           struct _mesa_glsl_parse_state *state);
 995
 996    ast_fully_specified_type *return_type;
 997    const char *identifier;
 998
 999    exec_list parameters;
1000
1001 private:
1002    /**
1003     * Is this prototype part of the function definition?
1004     *
1005     * Used by ast_function_definition::hir to process the parameters, etc.
1006     * of the function.
1007     *
1008     * \sa ::hir
1009     */
1010    bool is_definition;
1011
1012    /**
1013     * Function signature corresponding to this function prototype instance
1014     *
1015     * Used by ast_function_definition::hir to process the parameters, etc.
1016     * of the function.
1017     *
1018     * \sa ::hir
1019     */
1020    class ir_function_signature *signature;
1021
1022    friend class ast_function_definition;
1023 };
1024
1025
1026 class ast_expression_statement : public ast_node {
1027 public:
1028    ast_expression_statement(ast_expression *);
1029    virtual void print(void) const;
1030
1031    virtual ir_rvalue *hir(exec_list *instructions,
1032                           struct _mesa_glsl_parse_state *state);
1033
1034    ast_expression *expression;
1035 };
1036
1037
1038 class ast_case_label : public ast_node {
1039 public:
1040    ast_case_label(ast_expression *test_value);
1041    virtual void print(void) const;
1042
1043    virtual ir_rvalue *hir(exec_list *instructions,
1044                           struct _mesa_glsl_parse_state *state);
1045
1046    /**
1047     * An test value of NULL means 'default'.
1048     */
1049    ast_expression *test_value;
1050 };
1051
1052
1053 class ast_case_label_list : public ast_node {
1054 public:
1055    ast_case_label_list(void);
1056    virtual void print(void) const;
1057
1058    virtual ir_rvalue *hir(exec_list *instructions,
1059                           struct _mesa_glsl_parse_state *state);
1060
1061    /**
1062     * A list of case labels.
1063     */
1064    exec_list labels;
1065 };
1066
1067
1068 class ast_case_statement : public ast_node {
1069 public:
1070    ast_case_statement(ast_case_label_list *labels);
1071    virtual void print(void) const;
1072
1073    virtual ir_rvalue *hir(exec_list *instructions,
1074                           struct _mesa_glsl_parse_state *state);
1075
1076    ast_case_label_list *labels;
1077
1078    /**
1079     * A list of statements.
1080     */
1081    exec_list stmts;
1082 };
1083
1084
1085 class ast_case_statement_list : public ast_node {
1086 public:
1087    ast_case_statement_list(void);
1088    virtual void print(void) const;
1089
1090    virtual ir_rvalue *hir(exec_list *instructions,
1091                           struct _mesa_glsl_parse_state *state);
1092
1093    /**
1094     * A list of cases.
1095     */
1096    exec_list cases;
1097 };
1098
1099
1100 class ast_switch_body : public ast_node {
1101 public:
1102    ast_switch_body(ast_case_statement_list *stmts);
1103    virtual void print(void) const;
1104
1105    virtual ir_rvalue *hir(exec_list *instructions,
1106                           struct _mesa_glsl_parse_state *state);
1107
1108    ast_case_statement_list *stmts;
1109 };
1110
1111
1112 class ast_selection_statement : public ast_node {
1113 public:
1114    ast_selection_statement(ast_expression *condition,
1115                            ast_node *then_statement,
1116                            ast_node *else_statement);
1117    virtual void print(void) const;
1118
1119    virtual ir_rvalue *hir(exec_list *instructions,
1120                           struct _mesa_glsl_parse_state *state);
1121
1122    ast_expression *condition;
1123    ast_node *then_statement;
1124    ast_node *else_statement;
1125 };
1126
1127
1128 class ast_switch_statement : public ast_node {
1129 public:
1130    ast_switch_statement(ast_expression *test_expression,
1131                         ast_node *body);
1132    virtual void print(void) const;
1133
1134    virtual ir_rvalue *hir(exec_list *instructions,
1135                           struct _mesa_glsl_parse_state *state);
1136
1137    ast_expression *test_expression;
1138    ast_node *body;
1139
1140 protected:
1141    void test_to_hir(exec_list *, struct _mesa_glsl_parse_state *);
1142 };
1143
1144 class ast_iteration_statement : public ast_node {
1145 public:
1146    ast_iteration_statement(int mode, ast_node *init, ast_node *condition,
1147                            ast_expression *rest_expression, ast_node *body);
1148
1149    virtual void print(void) const;
1150
1151    virtual ir_rvalue *hir(exec_list *, struct _mesa_glsl_parse_state *);
1152
1153    enum ast_iteration_modes {
1154       ast_for,
1155       ast_while,
1156       ast_do_while
1157    } mode;
1158
1159
1160    ast_node *init_statement;
1161    ast_node *condition;
1162    ast_expression *rest_expression;
1163
1164    ast_node *body;
1165
1166    /**
1167     * Generate IR from the condition of a loop
1168     *
1169     * This is factored out of ::hir because some loops have the condition
1170     * test at the top (for and while), and others have it at the end (do-while).
1171     */
1172    void condition_to_hir(exec_list *, struct _mesa_glsl_parse_state *);
1173 };
1174
1175
1176 class ast_jump_statement : public ast_node {
1177 public:
1178    ast_jump_statement(int mode, ast_expression *return_value);
1179    virtual void print(void) const;
1180
1181    virtual ir_rvalue *hir(exec_list *instructions,
1182                           struct _mesa_glsl_parse_state *state);
1183
1184    enum ast_jump_modes {
1185       ast_continue,
1186       ast_break,
1187       ast_return,
1188       ast_discard
1189    } mode;
1190
1191    ast_expression *opt_return_value;
1192 };
1193
1194
1195 class ast_function_definition : public ast_node {
1196 public:
1197    ast_function_definition() : prototype(NULL), body(NULL)
1198    {
1199    }
1200
1201    virtual void print(void) const;
1202
1203    virtual ir_rvalue *hir(exec_list *instructions,
1204                           struct _mesa_glsl_parse_state *state);
1205
1206    ast_function *prototype;
1207    ast_compound_statement *body;
1208 };
1209
1210 class ast_interface_block : public ast_node {
1211 public:
1212    ast_interface_block(const char *instance_name,
1213                        ast_array_specifier *array_specifier)
1214    : block_name(NULL), instance_name(instance_name),
1215      array_specifier(array_specifier)
1216    {
1217    }
1218
1219    virtual ir_rvalue *hir(exec_list *instructions,
1220                           struct _mesa_glsl_parse_state *state);
1221
1222    ast_type_qualifier default_layout;
1223    ast_type_qualifier layout;
1224    const char *block_name;
1225
1226    /**
1227     * Declared name of the block instance, if specified.
1228     *
1229     * If the block does not have an instance name, this field will be
1230     * \c NULL.
1231     */
1232    const char *instance_name;
1233
1234    /** List of ast_declarator_list * */
1235    exec_list declarations;
1236
1237    /**
1238     * Declared array size of the block instance
1239     *
1240     * If the block is not declared as an array or if the block instance array
1241     * is unsized, this field will be \c NULL.
1242     */
1243    ast_array_specifier *array_specifier;
1244 };
1245
1246
1247 /**
1248  * AST node representing a declaration of the output layout for tessellation
1249  * control shaders.
1250  */
1251 class ast_tcs_output_layout : public ast_node
1252 {
1253 public:
1254    ast_tcs_output_layout(const struct YYLTYPE &locp)
1255    {
1256       set_location(locp);
1257    }
1258
1259    virtual ir_rvalue *hir(exec_list *instructions,
1260                           struct _mesa_glsl_parse_state *state);
1261 };
1262
1263
1264 /**
1265  * AST node representing a declaration of the input layout for geometry
1266  * shaders.
1267  */
1268 class ast_gs_input_layout : public ast_node
1269 {
1270 public:
1271    ast_gs_input_layout(const struct YYLTYPE &locp, GLenum prim_type)
1272       : prim_type(prim_type)
1273    {
1274       set_location(locp);
1275    }
1276
1277    virtual ir_rvalue *hir(exec_list *instructions,
1278                           struct _mesa_glsl_parse_state *state);
1279
1280 private:
1281    const GLenum prim_type;
1282 };
1283
1284
1285 /**
1286  * AST node representing a decalaration of the input layout for compute
1287  * shaders.
1288  */
1289 class ast_cs_input_layout : public ast_node
1290 {
1291 public:
1292    ast_cs_input_layout(const struct YYLTYPE &locp,
1293                        ast_layout_expression *const *local_size)
1294    {
1295       for (int i = 0; i < 3; i++) {
1296          this->local_size[i] = local_size[i];
1297       }
1298       set_location(locp);
1299    }
1300
1301    virtual ir_rvalue *hir(exec_list *instructions,
1302                           struct _mesa_glsl_parse_state *state);
1303
1304 private:
1305    ast_layout_expression *local_size[3];
1306 };
1307
1308 /*@}*/
1309
1310 extern void
1311 _mesa_ast_to_hir(exec_list *instructions, struct _mesa_glsl_parse_state *state);
1312
1313 extern ir_rvalue *
1314 _mesa_ast_field_selection_to_hir(const ast_expression *expr,
1315                                  exec_list *instructions,
1316                                  struct _mesa_glsl_parse_state *state);
1317
1318 extern ir_rvalue *
1319 _mesa_ast_array_index_to_hir(void *mem_ctx,
1320                              struct _mesa_glsl_parse_state *state,
1321                              ir_rvalue *array, ir_rvalue *idx,
1322                              YYLTYPE &loc, YYLTYPE &idx_loc);
1323
1324 extern void
1325 _mesa_ast_set_aggregate_type(const glsl_type *type,
1326                              ast_expression *expr);
1327
1328 void
1329 emit_function(_mesa_glsl_parse_state *state, ir_function *f);
1330
1331 extern void
1332 check_builtin_array_max_size(const char *name, unsigned size,
1333                              YYLTYPE loc, struct _mesa_glsl_parse_state *state);
1334
1335 extern void _mesa_ast_process_interface_block(YYLTYPE *locp,
1336                                               _mesa_glsl_parse_state *state,
1337                                               ast_interface_block *const block,
1338                                               const struct ast_type_qualifier &q);
1339
1340 extern bool
1341 process_qualifier_constant(struct _mesa_glsl_parse_state *state,
1342                            YYLTYPE *loc,
1343                            const char *qual_indentifier,
1344                            ast_expression *const_expression,
1345                            unsigned *value);
1346 #endif /* AST_H */