ast.h revision 1256a5dcc86014d48bdc6fd10ea5a2fa11241667
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#pragma once 26#ifndef AST_H 27#define AST_H 28 29#include "list.h" 30#include "glsl_parser_extras.h" 31 32struct _mesa_glsl_parse_state; 33 34struct YYLTYPE; 35 36/** 37 * \defgroup AST Abstract syntax tree node definitions 38 * 39 * An abstract syntax tree is generated by the parser. This is a fairly 40 * direct representation of the gramma derivation for the source program. 41 * No symantic checking is done during the generation of the AST. Only 42 * syntactic checking is done. Symantic checking is performed by a later 43 * stage that converts the AST to a more generic intermediate representation. 44 * 45 *@{ 46 */ 47/** 48 * Base class of all abstract syntax tree nodes 49 */ 50class ast_node { 51public: 52 /* Callers of this ralloc-based new need not call delete. It's 53 * easier to just ralloc_free 'ctx' (or any of its ancestors). */ 54 static void* operator new(size_t size, void *ctx) 55 { 56 void *node; 57 58 node = rzalloc_size(ctx, size); 59 assert(node != NULL); 60 61 return node; 62 } 63 64 /* If the user *does* call delete, that's OK, we will just 65 * ralloc_free in that case. */ 66 static void operator delete(void *table) 67 { 68 ralloc_free(table); 69 } 70 71 /** 72 * Print an AST node in something approximating the original GLSL code 73 */ 74 virtual void print(void) const; 75 76 /** 77 * Convert the AST node to the high-level intermediate representation 78 */ 79 virtual ir_rvalue *hir(exec_list *instructions, 80 struct _mesa_glsl_parse_state *state); 81 82 /** 83 * Retrieve the source location of an AST node 84 * 85 * This function is primarily used to get the source position of an AST node 86 * into a form that can be passed to \c _mesa_glsl_error. 87 * 88 * \sa _mesa_glsl_error, ast_node::set_location 89 */ 90 struct YYLTYPE get_location(void) const 91 { 92 struct YYLTYPE locp; 93 94 locp.source = this->location.source; 95 locp.first_line = this->location.line; 96 locp.first_column = this->location.column; 97 locp.last_line = locp.first_line; 98 locp.last_column = locp.first_column; 99 100 return locp; 101 } 102 103 /** 104 * Set the source location of an AST node from a parser location 105 * 106 * \sa ast_node::get_location 107 */ 108 void set_location(const struct YYLTYPE &locp) 109 { 110 this->location.source = locp.source; 111 this->location.line = locp.first_line; 112 this->location.column = locp.first_column; 113 } 114 115 /** 116 * Source location of the AST node. 117 */ 118 struct { 119 unsigned source; /**< GLSL source number. */ 120 unsigned line; /**< Line number within the source string. */ 121 unsigned column; /**< Column in the line. */ 122 } location; 123 124 exec_node link; 125 126protected: 127 /** 128 * The only constructor is protected so that only derived class objects can 129 * be created. 130 */ 131 ast_node(void); 132}; 133 134 135/** 136 * Operators for AST expression nodes. 137 */ 138enum ast_operators { 139 ast_assign, 140 ast_plus, /**< Unary + operator. */ 141 ast_neg, 142 ast_add, 143 ast_sub, 144 ast_mul, 145 ast_div, 146 ast_mod, 147 ast_lshift, 148 ast_rshift, 149 ast_less, 150 ast_greater, 151 ast_lequal, 152 ast_gequal, 153 ast_equal, 154 ast_nequal, 155 ast_bit_and, 156 ast_bit_xor, 157 ast_bit_or, 158 ast_bit_not, 159 ast_logic_and, 160 ast_logic_xor, 161 ast_logic_or, 162 ast_logic_not, 163 164 ast_mul_assign, 165 ast_div_assign, 166 ast_mod_assign, 167 ast_add_assign, 168 ast_sub_assign, 169 ast_ls_assign, 170 ast_rs_assign, 171 ast_and_assign, 172 ast_xor_assign, 173 ast_or_assign, 174 175 ast_conditional, 176 177 ast_pre_inc, 178 ast_pre_dec, 179 ast_post_inc, 180 ast_post_dec, 181 ast_field_selection, 182 ast_array_index, 183 184 ast_function_call, 185 186 ast_identifier, 187 ast_int_constant, 188 ast_uint_constant, 189 ast_float_constant, 190 ast_bool_constant, 191 192 ast_sequence 193}; 194 195/** 196 * Representation of any sort of expression. 197 */ 198class ast_expression : public ast_node { 199public: 200 ast_expression(int oper, ast_expression *, 201 ast_expression *, ast_expression *); 202 203 ast_expression(const char *identifier) : 204 oper(ast_identifier) 205 { 206 subexpressions[0] = NULL; 207 subexpressions[1] = NULL; 208 subexpressions[2] = NULL; 209 primary_expression.identifier = identifier; 210 this->non_lvalue_description = NULL; 211 } 212 213 static const char *operator_string(enum ast_operators op); 214 215 virtual ir_rvalue *hir(exec_list *instructions, 216 struct _mesa_glsl_parse_state *state); 217 218 virtual void print(void) const; 219 220 enum ast_operators oper; 221 222 ast_expression *subexpressions[3]; 223 224 union { 225 const char *identifier; 226 int int_constant; 227 float float_constant; 228 unsigned uint_constant; 229 int bool_constant; 230 } primary_expression; 231 232 233 /** 234 * List of expressions for an \c ast_sequence or parameters for an 235 * \c ast_function_call 236 */ 237 exec_list expressions; 238 239 /** 240 * For things that can't be l-values, this describes what it is. 241 * 242 * This text is used by the code that generates IR for assignments to 243 * detect and emit useful messages for assignments to some things that 244 * can't be l-values. For example, pre- or post-incerement expressions. 245 * 246 * \note 247 * This pointer may be \c NULL. 248 */ 249 const char *non_lvalue_description; 250}; 251 252class ast_expression_bin : public ast_expression { 253public: 254 ast_expression_bin(int oper, ast_expression *, ast_expression *); 255 256 virtual void print(void) const; 257}; 258 259/** 260 * Subclass of expressions for function calls 261 */ 262class ast_function_expression : public ast_expression { 263public: 264 ast_function_expression(ast_expression *callee) 265 : ast_expression(ast_function_call, callee, 266 NULL, NULL), 267 cons(false) 268 { 269 /* empty */ 270 } 271 272 ast_function_expression(class ast_type_specifier *type) 273 : ast_expression(ast_function_call, (ast_expression *) type, 274 NULL, NULL), 275 cons(true) 276 { 277 /* empty */ 278 } 279 280 bool is_constructor() const 281 { 282 return cons; 283 } 284 285 virtual ir_rvalue *hir(exec_list *instructions, 286 struct _mesa_glsl_parse_state *state); 287 288private: 289 /** 290 * Is this function call actually a constructor? 291 */ 292 bool cons; 293}; 294 295 296/** 297 * Number of possible operators for an ast_expression 298 * 299 * This is done as a define instead of as an additional value in the enum so 300 * that the compiler won't generate spurious messages like "warning: 301 * enumeration value ‘ast_num_operators’ not handled in switch" 302 */ 303#define AST_NUM_OPERATORS (ast_sequence + 1) 304 305 306class ast_compound_statement : public ast_node { 307public: 308 ast_compound_statement(int new_scope, ast_node *statements); 309 virtual void print(void) const; 310 311 virtual ir_rvalue *hir(exec_list *instructions, 312 struct _mesa_glsl_parse_state *state); 313 314 int new_scope; 315 exec_list statements; 316}; 317 318class ast_declaration : public ast_node { 319public: 320 ast_declaration(const char *identifier, int is_array, ast_expression *array_size, 321 ast_expression *initializer); 322 virtual void print(void) const; 323 324 const char *identifier; 325 326 int is_array; 327 ast_expression *array_size; 328 329 ast_expression *initializer; 330}; 331 332 333enum { 334 ast_precision_none = 0, /**< Absence of precision qualifier. */ 335 ast_precision_high, 336 ast_precision_medium, 337 ast_precision_low 338}; 339 340struct ast_type_qualifier { 341 union { 342 struct { 343 unsigned invariant:1; 344 unsigned constant:1; 345 unsigned attribute:1; 346 unsigned varying:1; 347 unsigned in:1; 348 unsigned out:1; 349 unsigned centroid:1; 350 unsigned uniform:1; 351 unsigned smooth:1; 352 unsigned flat:1; 353 unsigned noperspective:1; 354 355 /** \name Layout qualifiers for GL_ARB_fragment_coord_conventions */ 356 /*@{*/ 357 unsigned origin_upper_left:1; 358 unsigned pixel_center_integer:1; 359 /*@}*/ 360 361 /** 362 * Flag set if GL_ARB_explicit_attrib_location "location" layout 363 * qualifier is used. 364 */ 365 unsigned explicit_location:1; 366 /** 367 * Flag set if GL_ARB_explicit_attrib_location "index" layout 368 * qualifier is used. 369 */ 370 unsigned explicit_index:1; 371 372 /** \name Layout qualifiers for GL_AMD_conservative_depth */ 373 /** \{ */ 374 unsigned depth_any:1; 375 unsigned depth_greater:1; 376 unsigned depth_less:1; 377 unsigned depth_unchanged:1; 378 /** \} */ 379 } 380 /** \brief Set of flags, accessed by name. */ 381 q; 382 383 /** \brief Set of flags, accessed as a bitmask. */ 384 unsigned i; 385 } flags; 386 387 /** 388 * Location specified via GL_ARB_explicit_attrib_location layout 389 * 390 * \note 391 * This field is only valid if \c explicit_location is set. 392 */ 393 int location; 394 /** 395 * Index specified via GL_ARB_explicit_attrib_location layout 396 * 397 * \note 398 * This field is only valid if \c explicit_index is set. 399 */ 400 int index; 401 402 /** 403 * Return true if and only if an interpolation qualifier is present. 404 */ 405 bool has_interpolation() const; 406 407 /** 408 * \brief Return string representation of interpolation qualifier. 409 * 410 * If an interpolation qualifier is present, then return that qualifier's 411 * string representation. Otherwise, return null. For example, if the 412 * noperspective bit is set, then this returns "noperspective". 413 * 414 * If multiple interpolation qualifiers are somehow present, then the 415 * returned string is undefined but not null. 416 */ 417 const char *interpolation_string() const; 418}; 419 420class ast_struct_specifier : public ast_node { 421public: 422 ast_struct_specifier(const char *identifier, ast_node *declarator_list); 423 virtual void print(void) const; 424 425 virtual ir_rvalue *hir(exec_list *instructions, 426 struct _mesa_glsl_parse_state *state); 427 428 const char *name; 429 exec_list declarations; 430}; 431 432 433 434class ast_type_specifier : public ast_node { 435public: 436 /** Construct a type specifier from a type name */ 437 ast_type_specifier(const char *name) 438 : type_name(name), structure(NULL), 439 is_array(false), array_size(NULL), precision(ast_precision_none), 440 is_precision_statement(false) 441 { 442 /* empty */ 443 } 444 445 /** Construct a type specifier from a structure definition */ 446 ast_type_specifier(ast_struct_specifier *s) 447 : type_name(s->name), structure(s), 448 is_array(false), array_size(NULL), precision(ast_precision_none), 449 is_precision_statement(false) 450 { 451 /* empty */ 452 } 453 454 const struct glsl_type *glsl_type(const char **name, 455 struct _mesa_glsl_parse_state *state) 456 const; 457 458 virtual void print(void) const; 459 460 ir_rvalue *hir(exec_list *, struct _mesa_glsl_parse_state *); 461 462 const char *type_name; 463 ast_struct_specifier *structure; 464 465 int is_array; 466 ast_expression *array_size; 467 468 unsigned precision:2; 469 470 bool is_precision_statement; 471}; 472 473 474class ast_fully_specified_type : public ast_node { 475public: 476 virtual void print(void) const; 477 bool has_qualifiers() const; 478 479 ast_type_qualifier qualifier; 480 ast_type_specifier *specifier; 481}; 482 483 484class ast_declarator_list : public ast_node { 485public: 486 ast_declarator_list(ast_fully_specified_type *); 487 virtual void print(void) const; 488 489 virtual ir_rvalue *hir(exec_list *instructions, 490 struct _mesa_glsl_parse_state *state); 491 492 ast_fully_specified_type *type; 493 exec_list declarations; 494 495 /** 496 * Special flag for vertex shader "invariant" declarations. 497 * 498 * Vertex shaders can contain "invariant" variable redeclarations that do 499 * not include a type. For example, "invariant gl_Position;". This flag 500 * is used to note these cases when no type is specified. 501 */ 502 int invariant; 503}; 504 505 506class ast_parameter_declarator : public ast_node { 507public: 508 ast_parameter_declarator() 509 { 510 this->identifier = NULL; 511 this->is_array = false; 512 this->array_size = 0; 513 } 514 515 virtual void print(void) const; 516 517 virtual ir_rvalue *hir(exec_list *instructions, 518 struct _mesa_glsl_parse_state *state); 519 520 ast_fully_specified_type *type; 521 const char *identifier; 522 int is_array; 523 ast_expression *array_size; 524 525 static void parameters_to_hir(exec_list *ast_parameters, 526 bool formal, exec_list *ir_parameters, 527 struct _mesa_glsl_parse_state *state); 528 529private: 530 /** Is this parameter declaration part of a formal parameter list? */ 531 bool formal_parameter; 532 533 /** 534 * Is this parameter 'void' type? 535 * 536 * This field is set by \c ::hir. 537 */ 538 bool is_void; 539}; 540 541 542class ast_function : public ast_node { 543public: 544 ast_function(void); 545 546 virtual void print(void) const; 547 548 virtual ir_rvalue *hir(exec_list *instructions, 549 struct _mesa_glsl_parse_state *state); 550 551 ast_fully_specified_type *return_type; 552 const char *identifier; 553 554 exec_list parameters; 555 556private: 557 /** 558 * Is this prototype part of the function definition? 559 * 560 * Used by ast_function_definition::hir to process the parameters, etc. 561 * of the function. 562 * 563 * \sa ::hir 564 */ 565 bool is_definition; 566 567 /** 568 * Function signature corresponding to this function prototype instance 569 * 570 * Used by ast_function_definition::hir to process the parameters, etc. 571 * of the function. 572 * 573 * \sa ::hir 574 */ 575 class ir_function_signature *signature; 576 577 friend class ast_function_definition; 578}; 579 580 581class ast_expression_statement : public ast_node { 582public: 583 ast_expression_statement(ast_expression *); 584 virtual void print(void) const; 585 586 virtual ir_rvalue *hir(exec_list *instructions, 587 struct _mesa_glsl_parse_state *state); 588 589 ast_expression *expression; 590}; 591 592 593class ast_case_label : public ast_node { 594public: 595 ast_case_label(ast_expression *test_value); 596 virtual void print(void) const; 597 598 virtual ir_rvalue *hir(exec_list *instructions, 599 struct _mesa_glsl_parse_state *state); 600 601 /** 602 * An test value of NULL means 'default'. 603 */ 604 ast_expression *test_value; 605}; 606 607 608class ast_case_label_list : public ast_node { 609public: 610 ast_case_label_list(void); 611 virtual void print(void) const; 612 613 virtual ir_rvalue *hir(exec_list *instructions, 614 struct _mesa_glsl_parse_state *state); 615 616 /** 617 * A list of case labels. 618 */ 619 exec_list labels; 620}; 621 622 623class ast_case_statement : public ast_node { 624public: 625 ast_case_statement(ast_case_label_list *labels); 626 virtual void print(void) const; 627 628 virtual ir_rvalue *hir(exec_list *instructions, 629 struct _mesa_glsl_parse_state *state); 630 631 ast_case_label_list *labels; 632 633 /** 634 * A list of statements. 635 */ 636 exec_list stmts; 637}; 638 639 640class ast_case_statement_list : public ast_node { 641public: 642 ast_case_statement_list(void); 643 virtual void print(void) const; 644 645 virtual ir_rvalue *hir(exec_list *instructions, 646 struct _mesa_glsl_parse_state *state); 647 648 /** 649 * A list of cases. 650 */ 651 exec_list cases; 652}; 653 654 655class ast_switch_body : public ast_node { 656public: 657 ast_switch_body(ast_case_statement_list *stmts); 658 virtual void print(void) const; 659 660 virtual ir_rvalue *hir(exec_list *instructions, 661 struct _mesa_glsl_parse_state *state); 662 663 ast_case_statement_list *stmts; 664}; 665 666 667class ast_selection_statement : public ast_node { 668public: 669 ast_selection_statement(ast_expression *condition, 670 ast_node *then_statement, 671 ast_node *else_statement); 672 virtual void print(void) const; 673 674 virtual ir_rvalue *hir(exec_list *instructions, 675 struct _mesa_glsl_parse_state *state); 676 677 ast_expression *condition; 678 ast_node *then_statement; 679 ast_node *else_statement; 680}; 681 682 683class ast_switch_statement : public ast_node { 684public: 685 ast_switch_statement(ast_expression *test_expression, 686 ast_node *body); 687 virtual void print(void) const; 688 689 virtual ir_rvalue *hir(exec_list *instructions, 690 struct _mesa_glsl_parse_state *state); 691 692 ast_expression *test_expression; 693 ast_node *body; 694 695protected: 696 void test_to_hir(exec_list *, struct _mesa_glsl_parse_state *); 697}; 698 699class ast_iteration_statement : public ast_node { 700public: 701 ast_iteration_statement(int mode, ast_node *init, ast_node *condition, 702 ast_expression *rest_expression, ast_node *body); 703 704 virtual void print(void) const; 705 706 virtual ir_rvalue *hir(exec_list *, struct _mesa_glsl_parse_state *); 707 708 enum ast_iteration_modes { 709 ast_for, 710 ast_while, 711 ast_do_while 712 } mode; 713 714 715 ast_node *init_statement; 716 ast_node *condition; 717 ast_expression *rest_expression; 718 719 ast_node *body; 720 721private: 722 /** 723 * Generate IR from the condition of a loop 724 * 725 * This is factored out of ::hir because some loops have the condition 726 * test at the top (for and while), and others have it at the end (do-while). 727 */ 728 void condition_to_hir(class ir_loop *, struct _mesa_glsl_parse_state *); 729}; 730 731 732class ast_jump_statement : public ast_node { 733public: 734 ast_jump_statement(int mode, ast_expression *return_value); 735 virtual void print(void) const; 736 737 virtual ir_rvalue *hir(exec_list *instructions, 738 struct _mesa_glsl_parse_state *state); 739 740 enum ast_jump_modes { 741 ast_continue, 742 ast_break, 743 ast_return, 744 ast_discard 745 } mode; 746 747 ast_expression *opt_return_value; 748}; 749 750 751class ast_function_definition : public ast_node { 752public: 753 virtual void print(void) const; 754 755 virtual ir_rvalue *hir(exec_list *instructions, 756 struct _mesa_glsl_parse_state *state); 757 758 ast_function *prototype; 759 ast_compound_statement *body; 760}; 761/*@}*/ 762 763extern void 764_mesa_ast_to_hir(exec_list *instructions, struct _mesa_glsl_parse_state *state); 765 766extern ir_rvalue * 767_mesa_ast_field_selection_to_hir(const ast_expression *expr, 768 exec_list *instructions, 769 struct _mesa_glsl_parse_state *state); 770 771void 772emit_function(_mesa_glsl_parse_state *state, ir_function *f); 773 774#endif /* AST_H */ 775