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    DECLARE_BITSET_T(bitset_t, 128);
 478
 479    union flags {
 480       struct {
 481          unsigned invariant:1;
 482          unsigned precise:1;
 483          unsigned constant:1;
 484          unsigned attribute:1;
 485          unsigned varying:1;
 486          unsigned in:1;
 487          unsigned out:1;
 488          unsigned centroid:1;
 489          unsigned sample:1;
 490          unsigned patch:1;
 491          unsigned uniform:1;
 492          unsigned buffer:1;
 493          unsigned shared_storage:1;
 494          unsigned smooth:1;
 495          unsigned flat:1;
 496          unsigned noperspective:1;
 497
 498          /** \name Layout qualifiers for GL_ARB_fragment_coord_conventions */
 499          /*@{*/
 500          unsigned origin_upper_left:1;
 501          unsigned pixel_center_integer:1;
 502          /*@}*/
 503
 504          /**
 505           * Flag set if GL_ARB_enhanced_layouts "align" layout qualifier is
 506           * used.
 507           */
 508          unsigned explicit_align:1;
 509
 510          /**
 511           * Flag set if GL_ARB_explicit_attrib_location "location" layout
 512           * qualifier is used.
 513           */
 514          unsigned explicit_location:1;
 515          /**
 516           * Flag set if GL_ARB_explicit_attrib_location "index" layout
 517           * qualifier is used.
 518           */
 519          unsigned explicit_index:1;
 520
 521          /**
 522           * Flag set if GL_ARB_enhanced_layouts "component" layout
 523           * qualifier is used.
 524           */
 525          unsigned explicit_component:1;
 526
 527          /**
 528           * Flag set if GL_ARB_shading_language_420pack "binding" layout
 529           * qualifier is used.
 530           */
 531          unsigned explicit_binding:1;
 532
 533          /**
 534           * Flag set if GL_ARB_shader_atomic counter "offset" layout
 535           * qualifier is used.
 536           */
 537          unsigned explicit_offset:1;
 538
 539          /** \name Layout qualifiers for GL_AMD_conservative_depth */
 540          /** \{ */
 541          unsigned depth_type:1;
 542          /** \} */
 543
 544          /** \name Layout qualifiers for GL_ARB_uniform_buffer_object */
 545          /** \{ */
 546          unsigned std140:1;
 547          unsigned std430:1;
 548          unsigned shared:1;
 549          unsigned packed:1;
 550          unsigned column_major:1;
 551          unsigned row_major:1;
 552          /** \} */
 553
 554          /** \name Layout qualifiers for GLSL 1.50 geometry shaders */
 555          /** \{ */
 556          unsigned prim_type:1;
 557          unsigned max_vertices:1;
 558          /** \} */
 559
 560          /**
 561           * local_size_{x,y,z} flags for compute shaders.  Bit 0 represents
 562           * local_size_x, and so on.
 563           */
 564          unsigned local_size:3;
 565
 566          /** \name Layout qualifiers for ARB_compute_variable_group_size. */
 567          /** \{ */
 568          unsigned local_size_variable:1;
 569          /** \} */
 570
 571          /** \name Layout and memory qualifiers for ARB_shader_image_load_store. */
 572          /** \{ */
 573          unsigned early_fragment_tests:1;
 574          unsigned explicit_image_format:1;
 575          unsigned coherent:1;
 576          unsigned _volatile:1;
 577          unsigned restrict_flag:1;
 578          unsigned read_only:1; /**< "readonly" qualifier. */
 579          unsigned write_only:1; /**< "writeonly" qualifier. */
 580          /** \} */
 581
 582          /** \name Layout qualifiers for GL_ARB_gpu_shader5 */
 583          /** \{ */
 584          unsigned invocations:1;
 585          unsigned stream:1; /**< Has stream value assigned  */
 586          unsigned explicit_stream:1; /**< stream value assigned explicitly by shader code */
 587          /** \} */
 588
 589          /** \name Layout qualifiers for GL_ARB_enhanced_layouts */
 590          /** \{ */
 591          unsigned explicit_xfb_offset:1; /**< xfb_offset value assigned explicitly by shader code */
 592          unsigned xfb_buffer:1; /**< Has xfb_buffer value assigned  */
 593          unsigned explicit_xfb_buffer:1; /**< xfb_buffer value assigned explicitly by shader code */
 594          unsigned xfb_stride:1; /**< Is xfb_stride value yet to be merged with global values  */
 595          unsigned explicit_xfb_stride:1; /**< xfb_stride value assigned explicitly by shader code */
 596          /** \} */
 597
 598          /** \name Layout qualifiers for GL_ARB_tessellation_shader */
 599          /** \{ */
 600          /* tess eval input layout */
 601          /* gs prim_type reused for primitive mode */
 602          unsigned vertex_spacing:1;
 603          unsigned ordering:1;
 604          unsigned point_mode:1;
 605          /* tess control output layout */
 606          unsigned vertices:1;
 607          /** \} */
 608
 609          /** \name Qualifiers for GL_ARB_shader_subroutine */
 610          /** \{ */
 611          unsigned subroutine:1;  /**< Is this marked 'subroutine' */
 612          /** \} */
 613
 614          /** \name Qualifiers for GL_KHR_blend_equation_advanced */
 615          /** \{ */
 616          unsigned blend_support:1; /**< Are there any blend_support_ qualifiers */
 617          /** \} */
 618
 619          /**
 620           * Flag set if GL_ARB_post_depth_coverage layout qualifier is used.
 621           */
 622          unsigned post_depth_coverage:1;
 623          /**
 624           * Flag set if GL_INTEL_conservartive_rasterization layout qualifier
 625           * is used.
 626           */
 627          unsigned inner_coverage:1;
 628
 629          /** \name Layout qualifiers for GL_ARB_bindless_texture */
 630          /** \{ */
 631          unsigned bindless_sampler:1;
 632          unsigned bindless_image:1;
 633          unsigned bound_sampler:1;
 634          unsigned bound_image:1;
 635          /** \} */
 636
 637          /** \name Layout qualifiers for GL_EXT_shader_framebuffer_fetch_non_coherent */
 638          /** \{ */
 639          unsigned non_coherent:1;
 640          /** \} */
 641       }
 642       /** \brief Set of flags, accessed by name. */
 643       q;
 644
 645       /** \brief Set of flags, accessed as a bitmask. */
 646       bitset_t i;
 647    } flags;
 648
 649    /** Precision of the type (highp/medium/lowp). */
 650    unsigned precision:2;
 651
 652    /** Type of layout qualifiers for GL_AMD_conservative_depth. */
 653    unsigned depth_type:3;
 654
 655    /**
 656     * Alignment specified via GL_ARB_enhanced_layouts "align" layout qualifier
 657     */
 658    ast_expression *align;
 659
 660    /** Geometry shader invocations for GL_ARB_gpu_shader5. */
 661    ast_layout_expression *invocations;
 662
 663    /**
 664     * Location specified via GL_ARB_explicit_attrib_location layout
 665     *
 666     * \note
 667     * This field is only valid if \c explicit_location is set.
 668     */
 669    ast_expression *location;
 670    /**
 671     * Index specified via GL_ARB_explicit_attrib_location layout
 672     *
 673     * \note
 674     * This field is only valid if \c explicit_index is set.
 675     */
 676    ast_expression *index;
 677
 678    /**
 679     * Component specified via GL_ARB_enhaced_layouts
 680     *
 681     * \note
 682     * This field is only valid if \c explicit_component is set.
 683     */
 684    ast_expression *component;
 685
 686    /** Maximum output vertices in GLSL 1.50 geometry shaders. */
 687    ast_layout_expression *max_vertices;
 688
 689    /** Stream in GLSL 1.50 geometry shaders. */
 690    ast_expression *stream;
 691
 692    /** xfb_buffer specified via the GL_ARB_enhanced_layouts keyword. */
 693    ast_expression *xfb_buffer;
 694
 695    /** xfb_stride specified via the GL_ARB_enhanced_layouts keyword. */
 696    ast_expression *xfb_stride;
 697
 698    /** global xfb_stride values for each buffer */
 699    ast_layout_expression *out_xfb_stride[MAX_FEEDBACK_BUFFERS];
 700
 701    /**
 702     * Input or output primitive type in GLSL 1.50 geometry shaders
 703     * and tessellation shaders.
 704     */
 705    GLenum prim_type;
 706
 707    /**
 708     * Binding specified via GL_ARB_shading_language_420pack's "binding" keyword.
 709     *
 710     * \note
 711     * This field is only valid if \c explicit_binding is set.
 712     */
 713    ast_expression *binding;
 714
 715    /**
 716     * Offset specified via GL_ARB_shader_atomic_counter's or
 717     * GL_ARB_enhanced_layouts "offset" keyword, or by GL_ARB_enhanced_layouts
 718     * "xfb_offset" keyword.
 719     *
 720     * \note
 721     * This field is only valid if \c explicit_offset is set.
 722     */
 723    ast_expression *offset;
 724
 725    /**
 726     * Local size specified via GL_ARB_compute_shader's "local_size_{x,y,z}"
 727     * layout qualifier.  Element i of this array is only valid if
 728     * flags.q.local_size & (1 << i) is set.
 729     */
 730    ast_layout_expression *local_size[3];
 731
 732    /** Tessellation evaluation shader: vertex spacing (equal, fractional even/odd) */
 733    enum gl_tess_spacing vertex_spacing;
 734
 735    /** Tessellation evaluation shader: vertex ordering (CW or CCW) */
 736    GLenum ordering;
 737
 738    /** Tessellation evaluation shader: point mode */
 739    bool point_mode;
 740
 741    /** Tessellation control shader: number of output vertices */
 742    ast_layout_expression *vertices;
 743
 744    /**
 745     * Image format specified with an ARB_shader_image_load_store
 746     * layout qualifier.
 747     *
 748     * \note
 749     * This field is only valid if \c explicit_image_format is set.
 750     */
 751    GLenum image_format;
 752
 753    /**
 754     * Base type of the data read from or written to this image.  Only
 755     * the following enumerants are allowed: GLSL_TYPE_UINT,
 756     * GLSL_TYPE_INT, GLSL_TYPE_FLOAT.
 757     *
 758     * \note
 759     * This field is only valid if \c explicit_image_format is set.
 760     */
 761    glsl_base_type image_base_type;
 762
 763    /**
 764     * Return true if and only if an interpolation qualifier is present.
 765     */
 766    bool has_interpolation() const;
 767
 768    /**
 769     * Return whether a layout qualifier is present.
 770     */
 771    bool has_layout() const;
 772
 773    /**
 774     * Return whether a storage qualifier is present.
 775     */
 776    bool has_storage() const;
 777
 778    /**
 779     * Return whether an auxiliary storage qualifier is present.
 780     */
 781    bool has_auxiliary_storage() const;
 782
 783    /**
 784     * Return true if and only if a memory qualifier is present.
 785     */
 786    bool has_memory() const;
 787
 788    /**
 789     * Return true if the qualifier is a subroutine declaration.
 790     */
 791    bool is_subroutine_decl() const;
 792
 793    bool merge_qualifier(YYLTYPE *loc,
 794                         _mesa_glsl_parse_state *state,
 795                         const ast_type_qualifier &q,
 796                         bool is_single_layout_merge,
 797                         bool is_multiple_layouts_merge = false);
 798
 799    /**
 800     * Validate current qualifier against the global out one.
 801     */
 802    bool validate_out_qualifier(YYLTYPE *loc,
 803                                _mesa_glsl_parse_state *state);
 804
 805    /**
 806     * Merge current qualifier into the global out one.
 807     */
 808    bool merge_into_out_qualifier(YYLTYPE *loc,
 809                                  _mesa_glsl_parse_state *state,
 810                                  ast_node* &node);
 811
 812    /**
 813     * Validate current qualifier against the global in one.
 814     */
 815    bool validate_in_qualifier(YYLTYPE *loc,
 816                               _mesa_glsl_parse_state *state);
 817
 818    /**
 819     * Merge current qualifier into the global in one.
 820     */
 821    bool merge_into_in_qualifier(YYLTYPE *loc,
 822                                 _mesa_glsl_parse_state *state,
 823                                 ast_node* &node);
 824
 825    /**
 826     * Push pending layout qualifiers to the global values.
 827     */
 828    bool push_to_global(YYLTYPE *loc,
 829                        _mesa_glsl_parse_state *state);
 830
 831    bool validate_flags(YYLTYPE *loc,
 832                        _mesa_glsl_parse_state *state,
 833                        const ast_type_qualifier &allowed_flags,
 834                        const char *message, const char *name);
 835
 836    ast_subroutine_list *subroutine_list;
 837 };
 838
 839 class ast_declarator_list;
 840
 841 class ast_struct_specifier : public ast_node {
 842 public:
 843    ast_struct_specifier(const char *identifier,
 844                         ast_declarator_list *declarator_list);
 845    virtual void print(void) const;
 846
 847    virtual ir_rvalue *hir(exec_list *instructions,
 848                           struct _mesa_glsl_parse_state *state);
 849
 850    const char *name;
 851    ast_type_qualifier *layout;
 852    /* List of ast_declarator_list * */
 853    exec_list declarations;
 854    bool is_declaration;
 855    const glsl_type *type;
 856 };
 857
 858
 859
 860 class ast_type_specifier : public ast_node {
 861 public:
 862    /** Construct a type specifier from a type name */
 863    ast_type_specifier(const char *name)
 864       : type(NULL), type_name(name), structure(NULL), array_specifier(NULL),
 865         default_precision(ast_precision_none)
 866    {
 867       /* empty */
 868    }
 869
 870    /** Construct a type specifier from a structure definition */
 871    ast_type_specifier(ast_struct_specifier *s)
 872       : type(NULL), type_name(s->name), structure(s), array_specifier(NULL),
 873         default_precision(ast_precision_none)
 874    {
 875       /* empty */
 876    }
 877
 878    ast_type_specifier(const glsl_type *t)
 879       : type(t), type_name(t->name), structure(NULL), array_specifier(NULL),
 880         default_precision(ast_precision_none)
 881    {
 882       /* empty */
 883    }
 884
 885    const struct glsl_type *glsl_type(const char **name,
 886                                      struct _mesa_glsl_parse_state *state)
 887       const;
 888
 889    virtual void print(void) const;
 890
 891    ir_rvalue *hir(exec_list *, struct _mesa_glsl_parse_state *);
 892
 893    const struct glsl_type *type;
 894    const char *type_name;
 895    ast_struct_specifier *structure;
 896
 897    ast_array_specifier *array_specifier;
 898
 899    /** For precision statements, this is the given precision; otherwise none. */
 900    unsigned default_precision:2;
 901 };
 902
 903
 904 class ast_fully_specified_type : public ast_node {
 905 public:
 906    virtual void print(void) const;
 907    bool has_qualifiers(_mesa_glsl_parse_state *state) const;
 908
 909    ast_fully_specified_type() : qualifier(), specifier(NULL)
 910    {
 911    }
 912
 913    const struct glsl_type *glsl_type(const char **name,
 914                                      struct _mesa_glsl_parse_state *state)
 915       const;
 916
 917    ast_type_qualifier qualifier;
 918    ast_type_specifier *specifier;
 919 };
 920
 921
 922 class ast_declarator_list : public ast_node {
 923 public:
 924    ast_declarator_list(ast_fully_specified_type *);
 925    virtual void print(void) const;
 926
 927    virtual ir_rvalue *hir(exec_list *instructions,
 928                           struct _mesa_glsl_parse_state *state);
 929
 930    ast_fully_specified_type *type;
 931    /** List of 'ast_declaration *' */
 932    exec_list declarations;
 933
 934    /**
 935     * Flags for redeclarations. In these cases, no type is specified, to
 936     * `type` is allowed to be NULL. In all other cases, this would be an error.
 937     */
 938    int invariant;     /** < `invariant` redeclaration */
 939    int precise;       /** < `precise` redeclaration */
 940 };
 941
 942
 943 class ast_parameter_declarator : public ast_node {
 944 public:
 945    ast_parameter_declarator() :
 946       type(NULL),
 947       identifier(NULL),
 948       array_specifier(NULL),
 949       formal_parameter(false),
 950       is_void(false)
 951    {
 952       /* empty */
 953    }
 954
 955    virtual void print(void) const;
 956
 957    virtual ir_rvalue *hir(exec_list *instructions,
 958                           struct _mesa_glsl_parse_state *state);
 959
 960    ast_fully_specified_type *type;
 961    const char *identifier;
 962    ast_array_specifier *array_specifier;
 963
 964    static void parameters_to_hir(exec_list *ast_parameters,
 965                                  bool formal, exec_list *ir_parameters,
 966                                  struct _mesa_glsl_parse_state *state);
 967
 968 private:
 969    /** Is this parameter declaration part of a formal parameter list? */
 970    bool formal_parameter;
 971
 972    /**
 973     * Is this parameter 'void' type?
 974     *
 975     * This field is set by \c ::hir.
 976     */
 977    bool is_void;
 978 };
 979
 980
 981 class ast_function : public ast_node {
 982 public:
 983    ast_function(void);
 984
 985    virtual void print(void) const;
 986
 987    virtual ir_rvalue *hir(exec_list *instructions,
 988                           struct _mesa_glsl_parse_state *state);
 989
 990    ast_fully_specified_type *return_type;
 991    const char *identifier;
 992
 993    exec_list parameters;
 994
 995 private:
 996    /**
 997     * Is this prototype part of the function definition?
 998     *
 999     * Used by ast_function_definition::hir to process the parameters, etc.
1000     * of the function.
1001     *
1002     * \sa ::hir
1003     */
1004    bool is_definition;
1005
1006    /**
1007     * Function signature corresponding to this function prototype instance
1008     *
1009     * Used by ast_function_definition::hir to process the parameters, etc.
1010     * of the function.
1011     *
1012     * \sa ::hir
1013     */
1014    class ir_function_signature *signature;
1015
1016    friend class ast_function_definition;
1017 };
1018
1019
1020 class ast_expression_statement : public ast_node {
1021 public:
1022    ast_expression_statement(ast_expression *);
1023    virtual void print(void) const;
1024
1025    virtual ir_rvalue *hir(exec_list *instructions,
1026                           struct _mesa_glsl_parse_state *state);
1027
1028    ast_expression *expression;
1029 };
1030
1031
1032 class ast_case_label : public ast_node {
1033 public:
1034    ast_case_label(ast_expression *test_value);
1035    virtual void print(void) const;
1036
1037    virtual ir_rvalue *hir(exec_list *instructions,
1038                           struct _mesa_glsl_parse_state *state);
1039
1040    /**
1041     * An test value of NULL means 'default'.
1042     */
1043    ast_expression *test_value;
1044 };
1045
1046
1047 class ast_case_label_list : public ast_node {
1048 public:
1049    ast_case_label_list(void);
1050    virtual void print(void) const;
1051
1052    virtual ir_rvalue *hir(exec_list *instructions,
1053                           struct _mesa_glsl_parse_state *state);
1054
1055    /**
1056     * A list of case labels.
1057     */
1058    exec_list labels;
1059 };
1060
1061
1062 class ast_case_statement : public ast_node {
1063 public:
1064    ast_case_statement(ast_case_label_list *labels);
1065    virtual void print(void) const;
1066
1067    virtual ir_rvalue *hir(exec_list *instructions,
1068                           struct _mesa_glsl_parse_state *state);
1069
1070    ast_case_label_list *labels;
1071
1072    /**
1073     * A list of statements.
1074     */
1075    exec_list stmts;
1076 };
1077
1078
1079 class ast_case_statement_list : public ast_node {
1080 public:
1081    ast_case_statement_list(void);
1082    virtual void print(void) const;
1083
1084    virtual ir_rvalue *hir(exec_list *instructions,
1085                           struct _mesa_glsl_parse_state *state);
1086
1087    /**
1088     * A list of cases.
1089     */
1090    exec_list cases;
1091 };
1092
1093
1094 class ast_switch_body : public ast_node {
1095 public:
1096    ast_switch_body(ast_case_statement_list *stmts);
1097    virtual void print(void) const;
1098
1099    virtual ir_rvalue *hir(exec_list *instructions,
1100                           struct _mesa_glsl_parse_state *state);
1101
1102    ast_case_statement_list *stmts;
1103 };
1104
1105
1106 class ast_selection_statement : public ast_node {
1107 public:
1108    ast_selection_statement(ast_expression *condition,
1109                            ast_node *then_statement,
1110                            ast_node *else_statement);
1111    virtual void print(void) const;
1112
1113    virtual ir_rvalue *hir(exec_list *instructions,
1114                           struct _mesa_glsl_parse_state *state);
1115
1116    ast_expression *condition;
1117    ast_node *then_statement;
1118    ast_node *else_statement;
1119 };
1120
1121
1122 class ast_switch_statement : public ast_node {
1123 public:
1124    ast_switch_statement(ast_expression *test_expression,
1125                         ast_node *body);
1126    virtual void print(void) const;
1127
1128    virtual ir_rvalue *hir(exec_list *instructions,
1129                           struct _mesa_glsl_parse_state *state);
1130
1131    ast_expression *test_expression;
1132    ast_node *body;
1133
1134 protected:
1135    void test_to_hir(exec_list *, struct _mesa_glsl_parse_state *);
1136 };
1137
1138 class ast_iteration_statement : public ast_node {
1139 public:
1140    ast_iteration_statement(int mode, ast_node *init, ast_node *condition,
1141                            ast_expression *rest_expression, ast_node *body);
1142
1143    virtual void print(void) const;
1144
1145    virtual ir_rvalue *hir(exec_list *, struct _mesa_glsl_parse_state *);
1146
1147    enum ast_iteration_modes {
1148       ast_for,
1149       ast_while,
1150       ast_do_while
1151    } mode;
1152
1153
1154    ast_node *init_statement;
1155    ast_node *condition;
1156    ast_expression *rest_expression;
1157
1158    ast_node *body;
1159
1160    /**
1161     * Generate IR from the condition of a loop
1162     *
1163     * This is factored out of ::hir because some loops have the condition
1164     * test at the top (for and while), and others have it at the end (do-while).
1165     */
1166    void condition_to_hir(exec_list *, struct _mesa_glsl_parse_state *);
1167 };
1168
1169
1170 class ast_jump_statement : public ast_node {
1171 public:
1172    ast_jump_statement(int mode, ast_expression *return_value);
1173    virtual void print(void) const;
1174
1175    virtual ir_rvalue *hir(exec_list *instructions,
1176                           struct _mesa_glsl_parse_state *state);
1177
1178    enum ast_jump_modes {
1179       ast_continue,
1180       ast_break,
1181       ast_return,
1182       ast_discard
1183    } mode;
1184
1185    ast_expression *opt_return_value;
1186 };
1187
1188
1189 class ast_function_definition : public ast_node {
1190 public:
1191    ast_function_definition() : prototype(NULL), body(NULL)
1192    {
1193    }
1194
1195    virtual void print(void) const;
1196
1197    virtual ir_rvalue *hir(exec_list *instructions,
1198                           struct _mesa_glsl_parse_state *state);
1199
1200    ast_function *prototype;
1201    ast_compound_statement *body;
1202 };
1203
1204 class ast_interface_block : public ast_node {
1205 public:
1206    ast_interface_block(const char *instance_name,
1207                        ast_array_specifier *array_specifier)
1208    : block_name(NULL), instance_name(instance_name),
1209      array_specifier(array_specifier)
1210    {
1211    }
1212
1213    virtual ir_rvalue *hir(exec_list *instructions,
1214                           struct _mesa_glsl_parse_state *state);
1215
1216    ast_type_qualifier default_layout;
1217    ast_type_qualifier layout;
1218    const char *block_name;
1219
1220    /**
1221     * Declared name of the block instance, if specified.
1222     *
1223     * If the block does not have an instance name, this field will be
1224     * \c NULL.
1225     */
1226    const char *instance_name;
1227
1228    /** List of ast_declarator_list * */
1229    exec_list declarations;
1230
1231    /**
1232     * Declared array size of the block instance
1233     *
1234     * If the block is not declared as an array or if the block instance array
1235     * is unsized, this field will be \c NULL.
1236     */
1237    ast_array_specifier *array_specifier;
1238 };
1239
1240
1241 /**
1242  * AST node representing a declaration of the output layout for tessellation
1243  * control shaders.
1244  */
1245 class ast_tcs_output_layout : public ast_node
1246 {
1247 public:
1248    ast_tcs_output_layout(const struct YYLTYPE &locp)
1249    {
1250       set_location(locp);
1251    }
1252
1253    virtual ir_rvalue *hir(exec_list *instructions,
1254                           struct _mesa_glsl_parse_state *state);
1255 };
1256
1257
1258 /**
1259  * AST node representing a declaration of the input layout for geometry
1260  * shaders.
1261  */
1262 class ast_gs_input_layout : public ast_node
1263 {
1264 public:
1265    ast_gs_input_layout(const struct YYLTYPE &locp, GLenum prim_type)
1266       : prim_type(prim_type)
1267    {
1268       set_location(locp);
1269    }
1270
1271    virtual ir_rvalue *hir(exec_list *instructions,
1272                           struct _mesa_glsl_parse_state *state);
1273
1274 private:
1275    const GLenum prim_type;
1276 };
1277
1278
1279 /**
1280  * AST node representing a decalaration of the input layout for compute
1281  * shaders.
1282  */
1283 class ast_cs_input_layout : public ast_node
1284 {
1285 public:
1286    ast_cs_input_layout(const struct YYLTYPE &locp,
1287                        ast_layout_expression *const *local_size)
1288    {
1289       for (int i = 0; i < 3; i++) {
1290          this->local_size[i] = local_size[i];
1291       }
1292       set_location(locp);
1293    }
1294
1295    virtual ir_rvalue *hir(exec_list *instructions,
1296                           struct _mesa_glsl_parse_state *state);
1297
1298 private:
1299    ast_layout_expression *local_size[3];
1300 };
1301
1302 /*@}*/
1303
1304 extern void
1305 _mesa_ast_to_hir(exec_list *instructions, struct _mesa_glsl_parse_state *state);
1306
1307 extern ir_rvalue *
1308 _mesa_ast_field_selection_to_hir(const ast_expression *expr,
1309                                  exec_list *instructions,
1310                                  struct _mesa_glsl_parse_state *state);
1311
1312 extern ir_rvalue *
1313 _mesa_ast_array_index_to_hir(void *mem_ctx,
1314                              struct _mesa_glsl_parse_state *state,
1315                              ir_rvalue *array, ir_rvalue *idx,
1316                              YYLTYPE &loc, YYLTYPE &idx_loc);
1317
1318 extern void
1319 _mesa_ast_set_aggregate_type(const glsl_type *type,
1320                              ast_expression *expr);
1321
1322 void
1323 emit_function(_mesa_glsl_parse_state *state, ir_function *f);
1324
1325 extern void
1326 check_builtin_array_max_size(const char *name, unsigned size,
1327                              YYLTYPE loc, struct _mesa_glsl_parse_state *state);
1328
1329 extern void _mesa_ast_process_interface_block(YYLTYPE *locp,
1330                                               _mesa_glsl_parse_state *state,
1331                                               ast_interface_block *const block,
1332                                               const struct ast_type_qualifier &q);
1333
1334 extern bool
1335 process_qualifier_constant(struct _mesa_glsl_parse_state *state,
1336                            YYLTYPE *loc,
1337                            const char *qual_indentifier,
1338                            ast_expression *const_expression,
1339                            unsigned *value);
1340 #endif /* AST_H */