3 * Copyright © 2010 Intel Corporation
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:
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
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.
33 #include "glsl_types.h"
35 #include "ir_visitor.h"
36 #include "ir_hierarchical_visitor.h"
37 #include "main/mtypes.h"
40 * \defgroup IR Intermediate representation nodes
48 * Each concrete class derived from \c ir_instruction has a value in this
49 * enumerant. The value for the type is stored in \c ir_instruction::ir_type
50 * by the constructor. While using type tags is not very C++, it is extremely
51 * convenient. For example, during debugging you can simply inspect
52 * \c ir_instruction::ir_type to find out the actual type of the object.
54 * In addition, it is possible to use a switch-statement based on \c
55 * \c ir_instruction::ir_type to select different behavior for different object
56 * types. For functions that have only slight differences for several object
57 * types, this allows writing very straightforward, readable code.
61 * Zero is unused so that the IR validator can detect cases where
62 * \c ir_instruction::ir_type has not been initialized.
69 ir_type_dereference_array
,
70 ir_type_dereference_record
,
71 ir_type_dereference_variable
,
75 ir_type_function_signature
,
82 ir_type_max
/**< maximum ir_type enum number, for validation */
86 * Base class of all IR instructions
88 class ir_instruction
: public exec_node
{
90 enum ir_node_type ir_type
;
91 const struct glsl_type
*type
;
93 /** ir_print_visitor helper for debugging. */
94 void print(void) const;
96 virtual void accept(ir_visitor
*) = 0;
97 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*) = 0;
98 virtual ir_instruction
*clone(void *mem_ctx
,
99 struct hash_table
*ht
) const = 0;
102 * \name IR instruction downcast functions
104 * These functions either cast the object to a derived class or return
105 * \c NULL if the object's type does not match the specified derived class.
106 * Additional downcast functions will be added as needed.
109 virtual class ir_variable
* as_variable() { return NULL
; }
110 virtual class ir_function
* as_function() { return NULL
; }
111 virtual class ir_dereference
* as_dereference() { return NULL
; }
112 virtual class ir_dereference_array
* as_dereference_array() { return NULL
; }
113 virtual class ir_dereference_variable
*as_dereference_variable() { return NULL
; }
114 virtual class ir_expression
* as_expression() { return NULL
; }
115 virtual class ir_rvalue
* as_rvalue() { return NULL
; }
116 virtual class ir_loop
* as_loop() { return NULL
; }
117 virtual class ir_assignment
* as_assignment() { return NULL
; }
118 virtual class ir_call
* as_call() { return NULL
; }
119 virtual class ir_return
* as_return() { return NULL
; }
120 virtual class ir_if
* as_if() { return NULL
; }
121 virtual class ir_swizzle
* as_swizzle() { return NULL
; }
122 virtual class ir_constant
* as_constant() { return NULL
; }
123 virtual class ir_discard
* as_discard() { return NULL
; }
129 ir_type
= ir_type_unset
;
135 class ir_rvalue
: public ir_instruction
{
137 virtual ir_rvalue
*clone(void *mem_ctx
, struct hash_table
*) const = 0;
139 virtual ir_constant
*constant_expression_value() = 0;
141 virtual ir_rvalue
* as_rvalue()
146 ir_rvalue
*as_rvalue_to_saturate();
148 virtual bool is_lvalue() const
154 * Get the variable that is ultimately referenced by an r-value
156 virtual ir_variable
*variable_referenced() const
163 * If an r-value is a reference to a whole variable, get that variable
166 * Pointer to a variable that is completely dereferenced by the r-value. If
167 * the r-value is not a dereference or the dereference does not access the
168 * entire variable (i.e., it's just one array element, struct field), \c NULL
171 virtual ir_variable
*whole_variable_referenced()
177 * Determine if an r-value has the value zero
179 * The base implementation of this function always returns \c false. The
180 * \c ir_constant class over-rides this function to return \c true \b only
181 * for vector and scalar types that have all elements set to the value
182 * zero (or \c false for booleans).
184 * \sa ir_constant::has_value, ir_rvalue::is_one, ir_rvalue::is_negative_one
186 virtual bool is_zero() const;
189 * Determine if an r-value has the value one
191 * The base implementation of this function always returns \c false. The
192 * \c ir_constant class over-rides this function to return \c true \b only
193 * for vector and scalar types that have all elements set to the value
194 * one (or \c true for booleans).
196 * \sa ir_constant::has_value, ir_rvalue::is_zero, ir_rvalue::is_negative_one
198 virtual bool is_one() const;
201 * Determine if an r-value has the value negative one
203 * The base implementation of this function always returns \c false. The
204 * \c ir_constant class over-rides this function to return \c true \b only
205 * for vector and scalar types that have all elements set to the value
206 * negative one. For boolean times, the result is always \c false.
208 * \sa ir_constant::has_value, ir_rvalue::is_zero, ir_rvalue::is_one
210 virtual bool is_negative_one() const;
218 * Variable storage classes
220 enum ir_variable_mode
{
221 ir_var_auto
= 0, /**< Function local variables and globals. */
222 ir_var_uniform
, /**< Variable declared as a uniform. */
226 ir_var_const_in
, /**< "in" param that must be a constant expression */
227 ir_var_system_value
, /**< Ex: front-face, instance-id, etc. */
228 ir_var_temporary
/**< Temporary variable generated during compilation. */
232 * \brief Layout qualifiers for gl_FragDepth.
234 * The AMD/ARB_conservative_depth extensions allow gl_FragDepth to be redeclared
235 * with a layout qualifier.
237 enum ir_depth_layout
{
238 ir_depth_layout_none
, /**< No depth layout is specified. */
240 ir_depth_layout_greater
,
241 ir_depth_layout_less
,
242 ir_depth_layout_unchanged
246 * \brief Convert depth layout qualifier to string.
249 depth_layout_string(ir_depth_layout layout
);
252 * Description of built-in state associated with a uniform
254 * \sa ir_variable::state_slots
256 struct ir_state_slot
{
261 class ir_variable
: public ir_instruction
{
263 ir_variable(const struct glsl_type
*, const char *, ir_variable_mode
);
265 virtual ir_variable
*clone(void *mem_ctx
, struct hash_table
*ht
) const;
267 virtual ir_variable
*as_variable()
272 virtual void accept(ir_visitor
*v
)
277 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
281 * Get the string value for the interpolation qualifier
283 * \return The string that would be used in a shader to specify \c
284 * mode will be returned.
286 * This function is used to generate error messages of the form "shader
287 * uses %s interpolation qualifier", so in the case where there is no
288 * interpolation qualifier, it returns "no".
290 * This function should only be used on a shader input or output variable.
292 const char *interpolation_string() const;
295 * Determine how this variable should be interpolated based on its
296 * interpolation qualifier (if present), whether it is gl_Color or
297 * gl_SecondaryColor, and whether flatshading is enabled in the current GL
300 * The return value will always be either INTERP_QUALIFIER_SMOOTH,
301 * INTERP_QUALIFIER_NOPERSPECTIVE, or INTERP_QUALIFIER_FLAT.
303 glsl_interp_qualifier
determine_interpolation_mode(bool flat_shade
);
306 * Delcared name of the variable
311 * Highest element accessed with a constant expression array index
313 * Not used for non-array variables.
315 unsigned max_array_access
;
318 * Is the variable read-only?
320 * This is set for variables declared as \c const, shader inputs,
323 unsigned read_only
:1;
325 unsigned invariant
:1;
328 * Has this variable been used for reading or writing?
330 * Several GLSL semantic checks require knowledge of whether or not a
331 * variable has been used. For example, it is an error to redeclare a
332 * variable as invariant after it has been used.
337 * Storage class of the variable.
339 * \sa ir_variable_mode
344 * Interpolation mode for shader inputs / outputs
346 * \sa ir_variable_interpolation
348 unsigned interpolation
:2;
353 * Does this variable have an initializer?
355 * This is used by the linker to cross-validiate initializers of global
358 unsigned has_initializer
:1;
361 * \brief Layout qualifier for gl_FragDepth.
363 * This is not equal to \c ir_depth_layout_none if and only if this
364 * variable is \c gl_FragDepth and a layout qualifier is specified.
366 ir_depth_layout depth_layout
;
369 * Storage location of the base of this variable
371 * The precise meaning of this field depends on the nature of the variable.
373 * - Vertex shader input: one of the values from \c gl_vert_attrib.
374 * - Vertex shader output: one of the values from \c gl_vert_result.
375 * - Fragment shader input: one of the values from \c gl_frag_attrib.
376 * - Fragment shader output: one of the values from \c gl_frag_result.
377 * - Uniforms: Per-stage uniform slot number.
378 * - Other: This field is not currently used.
380 * If the variable is a uniform, shader input, or shader output, and the
381 * slot has not been assigned, the value will be -1.
386 * Built-in state that backs this uniform
388 * Once set at variable creation, \c state_slots must remain invariant.
389 * This is because, ideally, this array would be shared by all clones of
390 * this variable in the IR tree. In other words, we'd really like for it
391 * to be a fly-weight.
393 * If the variable is not a uniform, \c num_state_slots will be zero and
394 * \c state_slots will be \c NULL.
397 unsigned num_state_slots
; /**< Number of state slots used */
398 ir_state_slot
*state_slots
; /**< State descriptors. */
402 * Emit a warning if this variable is accessed.
404 const char *warn_extension
;
407 * Value assigned in the initializer of a variable declared "const"
409 ir_constant
*constant_value
;
412 * Constant expression assigned in the initializer of the variable
415 * This field and \c ::constant_value are distinct. Even if the two fields
416 * refer to constants with the same value, they must point to separate
419 ir_constant
*constant_initializer
;
425 * The representation of a function instance; may be the full definition or
426 * simply a prototype.
428 class ir_function_signature
: public ir_instruction
{
429 /* An ir_function_signature will be part of the list of signatures in
433 ir_function_signature(const glsl_type
*return_type
);
435 virtual ir_function_signature
*clone(void *mem_ctx
,
436 struct hash_table
*ht
) const;
437 ir_function_signature
*clone_prototype(void *mem_ctx
,
438 struct hash_table
*ht
) const;
440 virtual void accept(ir_visitor
*v
)
445 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
448 * Get the name of the function for which this is a signature
450 const char *function_name() const;
453 * Get a handle to the function for which this is a signature
455 * There is no setter function, this function returns a \c const pointer,
456 * and \c ir_function_signature::_function is private for a reason. The
457 * only way to make a connection between a function and function signature
458 * is via \c ir_function::add_signature. This helps ensure that certain
459 * invariants (i.e., a function signature is in the list of signatures for
460 * its \c _function) are met.
462 * \sa ir_function::add_signature
464 inline const class ir_function
*function() const
466 return this->_function
;
470 * Check whether the qualifiers match between this signature's parameters
471 * and the supplied parameter list. If not, returns the name of the first
472 * parameter with mismatched qualifiers (for use in error messages).
474 const char *qualifiers_match(exec_list
*params
);
477 * Replace the current parameter list with the given one. This is useful
478 * if the current information came from a prototype, and either has invalid
479 * or missing parameter names.
481 void replace_parameters(exec_list
*new_params
);
484 * Function return type.
486 * \note This discards the optional precision qualifier.
488 const struct glsl_type
*return_type
;
491 * List of ir_variable of function parameters.
493 * This represents the storage. The paramaters passed in a particular
494 * call will be in ir_call::actual_paramaters.
496 struct exec_list parameters
;
498 /** Whether or not this function has a body (which may be empty). */
499 unsigned is_defined
:1;
501 /** Whether or not this function signature is a built-in. */
502 unsigned is_builtin
:1;
504 /** Body of instructions in the function. */
505 struct exec_list body
;
508 /** Function of which this signature is one overload. */
509 class ir_function
*_function
;
511 friend class ir_function
;
516 * Header for tracking multiple overloaded functions with the same name.
517 * Contains a list of ir_function_signatures representing each of the
520 class ir_function
: public ir_instruction
{
522 ir_function(const char *name
);
524 virtual ir_function
*clone(void *mem_ctx
, struct hash_table
*ht
) const;
526 virtual ir_function
*as_function()
531 virtual void accept(ir_visitor
*v
)
536 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
538 void add_signature(ir_function_signature
*sig
)
540 sig
->_function
= this;
541 this->signatures
.push_tail(sig
);
545 * Get an iterator for the set of function signatures
547 exec_list_iterator
iterator()
549 return signatures
.iterator();
553 * Find a signature that matches a set of actual parameters, taking implicit
554 * conversions into account. Also flags whether the match was exact.
556 ir_function_signature
*matching_signature(const exec_list
*actual_param
,
557 bool *match_is_exact
);
560 * Find a signature that matches a set of actual parameters, taking implicit
561 * conversions into account.
563 ir_function_signature
*matching_signature(const exec_list
*actual_param
);
566 * Find a signature that exactly matches a set of actual parameters without
567 * any implicit type conversions.
569 ir_function_signature
*exact_matching_signature(const exec_list
*actual_ps
);
572 * Name of the function.
576 /** Whether or not this function has a signature that isn't a built-in. */
577 bool has_user_signature();
580 * List of ir_function_signature for each overloaded function with this name.
582 struct exec_list signatures
;
585 inline const char *ir_function_signature::function_name() const
587 return this->_function
->name
;
593 * IR instruction representing high-level if-statements
595 class ir_if
: public ir_instruction
{
597 ir_if(ir_rvalue
*condition
)
598 : condition(condition
)
600 ir_type
= ir_type_if
;
603 virtual ir_if
*clone(void *mem_ctx
, struct hash_table
*ht
) const;
605 virtual ir_if
*as_if()
610 virtual void accept(ir_visitor
*v
)
615 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
617 ir_rvalue
*condition
;
618 /** List of ir_instruction for the body of the then branch */
619 exec_list then_instructions
;
620 /** List of ir_instruction for the body of the else branch */
621 exec_list else_instructions
;
626 * IR instruction representing a high-level loop structure.
628 class ir_loop
: public ir_instruction
{
632 virtual ir_loop
*clone(void *mem_ctx
, struct hash_table
*ht
) const;
634 virtual void accept(ir_visitor
*v
)
639 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
641 virtual ir_loop
*as_loop()
647 * Get an iterator for the instructions of the loop body
649 exec_list_iterator
iterator()
651 return body_instructions
.iterator();
654 /** List of ir_instruction that make up the body of the loop. */
655 exec_list body_instructions
;
658 * \name Loop counter and controls
660 * Represents a loop like a FORTRAN \c do-loop.
663 * If \c from and \c to are the same value, the loop will execute once.
666 ir_rvalue
*from
; /** Value of the loop counter on the first
667 * iteration of the loop.
669 ir_rvalue
*to
; /** Value of the loop counter on the last
670 * iteration of the loop.
672 ir_rvalue
*increment
;
673 ir_variable
*counter
;
676 * Comparison operation in the loop terminator.
678 * If any of the loop control fields are non-\c NULL, this field must be
679 * one of \c ir_binop_less, \c ir_binop_greater, \c ir_binop_lequal,
680 * \c ir_binop_gequal, \c ir_binop_equal, or \c ir_binop_nequal.
687 class ir_assignment
: public ir_instruction
{
689 ir_assignment(ir_rvalue
*lhs
, ir_rvalue
*rhs
, ir_rvalue
*condition
= NULL
);
692 * Construct an assignment with an explicit write mask
695 * Since a write mask is supplied, the LHS must already be a bare
696 * \c ir_dereference. The cannot be any swizzles in the LHS.
698 ir_assignment(ir_dereference
*lhs
, ir_rvalue
*rhs
, ir_rvalue
*condition
,
699 unsigned write_mask
);
701 virtual ir_assignment
*clone(void *mem_ctx
, struct hash_table
*ht
) const;
703 virtual ir_constant
*constant_expression_value();
705 virtual void accept(ir_visitor
*v
)
710 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
712 virtual ir_assignment
* as_assignment()
718 * Get a whole variable written by an assignment
720 * If the LHS of the assignment writes a whole variable, the variable is
721 * returned. Otherwise \c NULL is returned. Examples of whole-variable
724 * - Assigning to a scalar
725 * - Assigning to all components of a vector
726 * - Whole array (or matrix) assignment
727 * - Whole structure assignment
729 ir_variable
*whole_variable_written();
732 * Set the LHS of an assignment
734 void set_lhs(ir_rvalue
*lhs
);
737 * Left-hand side of the assignment.
739 * This should be treated as read only. If you need to set the LHS of an
740 * assignment, use \c ir_assignment::set_lhs.
745 * Value being assigned
750 * Optional condition for the assignment.
752 ir_rvalue
*condition
;
756 * Component mask written
758 * For non-vector types in the LHS, this field will be zero. For vector
759 * types, a bit will be set for each component that is written. Note that
760 * for \c vec2 and \c vec3 types only the lower bits will ever be set.
762 * A partially-set write mask means that each enabled channel gets
763 * the value from a consecutive channel of the rhs. For example,
764 * to write just .xyw of gl_FrontColor with color:
766 * (assign (constant bool (1)) (xyw)
767 * (var_ref gl_FragColor)
768 * (swiz xyw (var_ref color)))
770 unsigned write_mask
:4;
773 /* Update ir_expression::num_operands() and operator_strs when
774 * updating this list.
776 enum ir_expression_operation
{
785 ir_unop_exp
, /**< Log base e on gentype */
786 ir_unop_log
, /**< Natural log on gentype */
789 ir_unop_f2i
, /**< Float-to-integer conversion. */
790 ir_unop_i2f
, /**< Integer-to-float conversion. */
791 ir_unop_f2b
, /**< Float-to-boolean conversion */
792 ir_unop_b2f
, /**< Boolean-to-float conversion */
793 ir_unop_i2b
, /**< int-to-boolean conversion */
794 ir_unop_b2i
, /**< Boolean-to-int conversion */
795 ir_unop_u2f
, /**< Unsigned-to-float conversion. */
796 ir_unop_i2u
, /**< Integer-to-unsigned conversion. */
797 ir_unop_u2i
, /**< Unsigned-to-integer conversion. */
801 * \name Unary floating-point rounding operations.
812 * \name Trigonometric operations.
817 ir_unop_sin_reduced
, /**< Reduced range sin. [-pi, pi] */
818 ir_unop_cos_reduced
, /**< Reduced range cos. [-pi, pi] */
822 * \name Partial derivatives.
832 * A sentinel marking the last of the unary operations.
834 ir_last_unop
= ir_unop_noise
,
842 * Takes one of two combinations of arguments:
847 * Does not take integer types.
852 * \name Binary comparison operators which return a boolean vector.
853 * The type of both operands must be equal.
863 * Returns single boolean for whether all components of operands[0]
864 * equal the components of operands[1].
868 * Returns single boolean for whether any component of operands[0]
869 * is not equal to the corresponding component of operands[1].
875 * \name Bit-wise binary operations.
896 * A sentinel marking the last of the binary operations.
898 ir_last_binop
= ir_binop_pow
,
903 * A sentinel marking the last of all operations.
905 ir_last_opcode
= ir_last_binop
908 class ir_expression
: public ir_rvalue
{
911 * Constructor for unary operation expressions
913 ir_expression(int op
, const struct glsl_type
*type
, ir_rvalue
*);
914 ir_expression(int op
, ir_rvalue
*);
917 * Constructor for binary operation expressions
919 ir_expression(int op
, const struct glsl_type
*type
,
920 ir_rvalue
*, ir_rvalue
*);
921 ir_expression(int op
, ir_rvalue
*op0
, ir_rvalue
*op1
);
924 * Constructor for quad operator expressions
926 ir_expression(int op
, const struct glsl_type
*type
,
927 ir_rvalue
*, ir_rvalue
*, ir_rvalue
*, ir_rvalue
*);
929 virtual ir_expression
*as_expression()
934 virtual ir_expression
*clone(void *mem_ctx
, struct hash_table
*ht
) const;
937 * Attempt to constant-fold the expression
939 * If the expression cannot be constant folded, this method will return
942 virtual ir_constant
*constant_expression_value();
945 * Determine the number of operands used by an expression
947 static unsigned int get_num_operands(ir_expression_operation
);
950 * Determine the number of operands used by an expression
952 unsigned int get_num_operands() const
954 return (this->operation
== ir_quadop_vector
)
955 ? this->type
->vector_elements
: get_num_operands(operation
);
959 * Return a string representing this expression's operator.
961 const char *operator_string();
964 * Return a string representing this expression's operator.
966 static const char *operator_string(ir_expression_operation
);
970 * Do a reverse-lookup to translate the given string into an operator.
972 static ir_expression_operation
get_operator(const char *);
974 virtual void accept(ir_visitor
*v
)
979 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
981 ir_expression_operation operation
;
982 ir_rvalue
*operands
[4];
987 * IR instruction representing a function call
989 class ir_call
: public ir_rvalue
{
991 ir_call(ir_function_signature
*callee
, exec_list
*actual_parameters
)
994 ir_type
= ir_type_call
;
995 assert(callee
->return_type
!= NULL
);
996 type
= callee
->return_type
;
997 actual_parameters
->move_nodes_to(& this->actual_parameters
);
998 this->use_builtin
= callee
->is_builtin
;
1001 virtual ir_call
*clone(void *mem_ctx
, struct hash_table
*ht
) const;
1003 virtual ir_constant
*constant_expression_value();
1005 virtual ir_call
*as_call()
1010 virtual void accept(ir_visitor
*v
)
1015 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1018 * Get a generic ir_call object when an error occurs
1020 * Any allocation will be performed with 'ctx' as ralloc owner.
1022 static ir_call
*get_error_instruction(void *ctx
);
1025 * Get an iterator for the set of acutal parameters
1027 exec_list_iterator
iterator()
1029 return actual_parameters
.iterator();
1033 * Get the name of the function being called.
1035 const char *callee_name() const
1037 return callee
->function_name();
1041 * Get the function signature bound to this function call
1043 ir_function_signature
*get_callee()
1049 * Set the function call target
1051 void set_callee(ir_function_signature
*sig
);
1054 * Generates an inline version of the function before @ir,
1055 * returning the return value of the function.
1057 ir_rvalue
*generate_inline(ir_instruction
*ir
);
1059 /* List of ir_rvalue of paramaters passed in this call. */
1060 exec_list actual_parameters
;
1062 /** Should this call only bind to a built-in function? */
1069 this->ir_type
= ir_type_call
;
1072 ir_function_signature
*callee
;
1077 * \name Jump-like IR instructions.
1079 * These include \c break, \c continue, \c return, and \c discard.
1082 class ir_jump
: public ir_instruction
{
1086 ir_type
= ir_type_unset
;
1090 class ir_return
: public ir_jump
{
1095 this->ir_type
= ir_type_return
;
1098 ir_return(ir_rvalue
*value
)
1101 this->ir_type
= ir_type_return
;
1104 virtual ir_return
*clone(void *mem_ctx
, struct hash_table
*) const;
1106 virtual ir_return
*as_return()
1111 ir_rvalue
*get_value() const
1116 virtual void accept(ir_visitor
*v
)
1121 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1128 * Jump instructions used inside loops
1130 * These include \c break and \c continue. The \c break within a loop is
1131 * different from the \c break within a switch-statement.
1133 * \sa ir_switch_jump
1135 class ir_loop_jump
: public ir_jump
{
1142 ir_loop_jump(jump_mode mode
)
1144 this->ir_type
= ir_type_loop_jump
;
1148 virtual ir_loop_jump
*clone(void *mem_ctx
, struct hash_table
*) const;
1150 virtual void accept(ir_visitor
*v
)
1155 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1157 bool is_break() const
1159 return mode
== jump_break
;
1162 bool is_continue() const
1164 return mode
== jump_continue
;
1167 /** Mode selector for the jump instruction. */
1168 enum jump_mode mode
;
1172 * IR instruction representing discard statements.
1174 class ir_discard
: public ir_jump
{
1178 this->ir_type
= ir_type_discard
;
1179 this->condition
= NULL
;
1182 ir_discard(ir_rvalue
*cond
)
1184 this->ir_type
= ir_type_discard
;
1185 this->condition
= cond
;
1188 virtual ir_discard
*clone(void *mem_ctx
, struct hash_table
*ht
) const;
1190 virtual void accept(ir_visitor
*v
)
1195 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1197 virtual ir_discard
*as_discard()
1202 ir_rvalue
*condition
;
1208 * Texture sampling opcodes used in ir_texture
1210 enum ir_texture_opcode
{
1211 ir_tex
, /**< Regular texture look-up */
1212 ir_txb
, /**< Texture look-up with LOD bias */
1213 ir_txl
, /**< Texture look-up with explicit LOD */
1214 ir_txd
, /**< Texture look-up with partial derivatvies */
1215 ir_txf
, /**< Texel fetch with explicit LOD */
1216 ir_txs
/**< Texture size */
1221 * IR instruction to sample a texture
1223 * The specific form of the IR instruction depends on the \c mode value
1224 * selected from \c ir_texture_opcodes. In the printed IR, these will
1227 * Texel offset (0 or an expression)
1228 * | Projection divisor
1229 * | | Shadow comparitor
1232 * (tex <type> <sampler> <coordinate> 0 1 ( ))
1233 * (txb <type> <sampler> <coordinate> 0 1 ( ) <bias>)
1234 * (txl <type> <sampler> <coordinate> 0 1 ( ) <lod>)
1235 * (txd <type> <sampler> <coordinate> 0 1 ( ) (dPdx dPdy))
1236 * (txf <type> <sampler> <coordinate> 0 <lod>)
1237 * (txs <type> <sampler> <lod>)
1239 class ir_texture
: public ir_rvalue
{
1241 ir_texture(enum ir_texture_opcode op
)
1242 : op(op
), projector(NULL
), shadow_comparitor(NULL
), offset(NULL
)
1244 this->ir_type
= ir_type_texture
;
1247 virtual ir_texture
*clone(void *mem_ctx
, struct hash_table
*) const;
1249 virtual ir_constant
*constant_expression_value();
1251 virtual void accept(ir_visitor
*v
)
1256 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1259 * Return a string representing the ir_texture_opcode.
1261 const char *opcode_string();
1263 /** Set the sampler and type. */
1264 void set_sampler(ir_dereference
*sampler
, const glsl_type
*type
);
1267 * Do a reverse-lookup to translate a string into an ir_texture_opcode.
1269 static ir_texture_opcode
get_opcode(const char *);
1271 enum ir_texture_opcode op
;
1273 /** Sampler to use for the texture access. */
1274 ir_dereference
*sampler
;
1276 /** Texture coordinate to sample */
1277 ir_rvalue
*coordinate
;
1280 * Value used for projective divide.
1282 * If there is no projective divide (the common case), this will be
1283 * \c NULL. Optimization passes should check for this to point to a constant
1284 * of 1.0 and replace that with \c NULL.
1286 ir_rvalue
*projector
;
1289 * Coordinate used for comparison on shadow look-ups.
1291 * If there is no shadow comparison, this will be \c NULL. For the
1292 * \c ir_txf opcode, this *must* be \c NULL.
1294 ir_rvalue
*shadow_comparitor
;
1296 /** Texel offset. */
1300 ir_rvalue
*lod
; /**< Floating point LOD */
1301 ir_rvalue
*bias
; /**< Floating point LOD bias */
1303 ir_rvalue
*dPdx
; /**< Partial derivative of coordinate wrt X */
1304 ir_rvalue
*dPdy
; /**< Partial derivative of coordinate wrt Y */
1310 struct ir_swizzle_mask
{
1317 * Number of components in the swizzle.
1319 unsigned num_components
:3;
1322 * Does the swizzle contain duplicate components?
1324 * L-value swizzles cannot contain duplicate components.
1326 unsigned has_duplicates
:1;
1330 class ir_swizzle
: public ir_rvalue
{
1332 ir_swizzle(ir_rvalue
*, unsigned x
, unsigned y
, unsigned z
, unsigned w
,
1335 ir_swizzle(ir_rvalue
*val
, const unsigned *components
, unsigned count
);
1337 ir_swizzle(ir_rvalue
*val
, ir_swizzle_mask mask
);
1339 virtual ir_swizzle
*clone(void *mem_ctx
, struct hash_table
*) const;
1341 virtual ir_constant
*constant_expression_value();
1343 virtual ir_swizzle
*as_swizzle()
1349 * Construct an ir_swizzle from the textual representation. Can fail.
1351 static ir_swizzle
*create(ir_rvalue
*, const char *, unsigned vector_length
);
1353 virtual void accept(ir_visitor
*v
)
1358 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1360 bool is_lvalue() const
1362 return val
->is_lvalue() && !mask
.has_duplicates
;
1366 * Get the variable that is ultimately referenced by an r-value
1368 virtual ir_variable
*variable_referenced() const;
1371 ir_swizzle_mask mask
;
1375 * Initialize the mask component of a swizzle
1377 * This is used by the \c ir_swizzle constructors.
1379 void init_mask(const unsigned *components
, unsigned count
);
1383 class ir_dereference
: public ir_rvalue
{
1385 virtual ir_dereference
*clone(void *mem_ctx
, struct hash_table
*) const = 0;
1387 virtual ir_dereference
*as_dereference()
1392 bool is_lvalue() const;
1395 * Get the variable that is ultimately referenced by an r-value
1397 virtual ir_variable
*variable_referenced() const = 0;
1401 class ir_dereference_variable
: public ir_dereference
{
1403 ir_dereference_variable(ir_variable
*var
);
1405 virtual ir_dereference_variable
*clone(void *mem_ctx
,
1406 struct hash_table
*) const;
1408 virtual ir_constant
*constant_expression_value();
1410 virtual ir_dereference_variable
*as_dereference_variable()
1416 * Get the variable that is ultimately referenced by an r-value
1418 virtual ir_variable
*variable_referenced() const
1423 virtual ir_variable
*whole_variable_referenced()
1425 /* ir_dereference_variable objects always dereference the entire
1426 * variable. However, if this dereference is dereferenced by anything
1427 * else, the complete deferefernce chain is not a whole-variable
1428 * dereference. This method should only be called on the top most
1429 * ir_rvalue in a dereference chain.
1434 virtual void accept(ir_visitor
*v
)
1439 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1442 * Object being dereferenced.
1448 class ir_dereference_array
: public ir_dereference
{
1450 ir_dereference_array(ir_rvalue
*value
, ir_rvalue
*array_index
);
1452 ir_dereference_array(ir_variable
*var
, ir_rvalue
*array_index
);
1454 virtual ir_dereference_array
*clone(void *mem_ctx
,
1455 struct hash_table
*) const;
1457 virtual ir_constant
*constant_expression_value();
1459 virtual ir_dereference_array
*as_dereference_array()
1465 * Get the variable that is ultimately referenced by an r-value
1467 virtual ir_variable
*variable_referenced() const
1469 return this->array
->variable_referenced();
1472 virtual void accept(ir_visitor
*v
)
1477 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1480 ir_rvalue
*array_index
;
1483 void set_array(ir_rvalue
*value
);
1487 class ir_dereference_record
: public ir_dereference
{
1489 ir_dereference_record(ir_rvalue
*value
, const char *field
);
1491 ir_dereference_record(ir_variable
*var
, const char *field
);
1493 virtual ir_dereference_record
*clone(void *mem_ctx
,
1494 struct hash_table
*) const;
1496 virtual ir_constant
*constant_expression_value();
1499 * Get the variable that is ultimately referenced by an r-value
1501 virtual ir_variable
*variable_referenced() const
1503 return this->record
->variable_referenced();
1506 virtual void accept(ir_visitor
*v
)
1511 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1519 * Data stored in an ir_constant
1521 union ir_constant_data
{
1529 class ir_constant
: public ir_rvalue
{
1531 ir_constant(const struct glsl_type
*type
, const ir_constant_data
*data
);
1532 ir_constant(bool b
);
1533 ir_constant(unsigned int u
);
1535 ir_constant(float f
);
1538 * Construct an ir_constant from a list of ir_constant values
1540 ir_constant(const struct glsl_type
*type
, exec_list
*values
);
1543 * Construct an ir_constant from a scalar component of another ir_constant
1545 * The new \c ir_constant inherits the type of the component from the
1549 * In the case of a matrix constant, the new constant is a scalar, \b not
1552 ir_constant(const ir_constant
*c
, unsigned i
);
1555 * Return a new ir_constant of the specified type containing all zeros.
1557 static ir_constant
*zero(void *mem_ctx
, const glsl_type
*type
);
1559 virtual ir_constant
*clone(void *mem_ctx
, struct hash_table
*) const;
1561 virtual ir_constant
*constant_expression_value();
1563 virtual ir_constant
*as_constant()
1568 virtual void accept(ir_visitor
*v
)
1573 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1576 * Get a particular component of a constant as a specific type
1578 * This is useful, for example, to get a value from an integer constant
1579 * as a float or bool. This appears frequently when constructors are
1580 * called with all constant parameters.
1583 bool get_bool_component(unsigned i
) const;
1584 float get_float_component(unsigned i
) const;
1585 int get_int_component(unsigned i
) const;
1586 unsigned get_uint_component(unsigned i
) const;
1589 ir_constant
*get_array_element(unsigned i
) const;
1591 ir_constant
*get_record_field(const char *name
);
1594 * Determine whether a constant has the same value as another constant
1596 * \sa ir_constant::is_zero, ir_constant::is_one,
1597 * ir_constant::is_negative_one
1599 bool has_value(const ir_constant
*) const;
1601 virtual bool is_zero() const;
1602 virtual bool is_one() const;
1603 virtual bool is_negative_one() const;
1606 * Value of the constant.
1608 * The field used to back the values supplied by the constant is determined
1609 * by the type associated with the \c ir_instruction. Constants may be
1610 * scalars, vectors, or matrices.
1612 union ir_constant_data value
;
1614 /* Array elements */
1615 ir_constant
**array_elements
;
1617 /* Structure fields */
1618 exec_list components
;
1622 * Parameterless constructor only used by the clone method
1630 * Apply a visitor to each IR node in a list
1633 visit_exec_list(exec_list
*list
, ir_visitor
*visitor
);
1636 * Validate invariants on each IR node in a list
1638 void validate_ir_tree(exec_list
*instructions
);
1640 struct _mesa_glsl_parse_state
;
1641 struct gl_shader_program
;
1644 * Detect whether an unlinked shader contains static recursion
1646 * If the list of instructions is determined to contain static recursion,
1647 * \c _mesa_glsl_error will be called to emit error messages for each function
1648 * that is in the recursion cycle.
1651 detect_recursion_unlinked(struct _mesa_glsl_parse_state
*state
,
1652 exec_list
*instructions
);
1655 * Detect whether a linked shader contains static recursion
1657 * If the list of instructions is determined to contain static recursion,
1658 * \c link_error_printf will be called to emit error messages for each function
1659 * that is in the recursion cycle. In addition,
1660 * \c gl_shader_program::LinkStatus will be set to false.
1663 detect_recursion_linked(struct gl_shader_program
*prog
,
1664 exec_list
*instructions
);
1667 * Make a clone of each IR instruction in a list
1669 * \param in List of IR instructions that are to be cloned
1670 * \param out List to hold the cloned instructions
1673 clone_ir_list(void *mem_ctx
, exec_list
*out
, const exec_list
*in
);
1676 _mesa_glsl_initialize_variables(exec_list
*instructions
,
1677 struct _mesa_glsl_parse_state
*state
);
1680 _mesa_glsl_initialize_functions(_mesa_glsl_parse_state
*state
);
1683 _mesa_glsl_release_functions(void);
1686 reparent_ir(exec_list
*list
, void *mem_ctx
);
1688 struct glsl_symbol_table
;
1691 import_prototypes(const exec_list
*source
, exec_list
*dest
,
1692 struct glsl_symbol_table
*symbols
, void *mem_ctx
);
1695 ir_has_call(ir_instruction
*ir
);
1698 do_set_program_inouts(exec_list
*instructions
, struct gl_program
*prog
,
1699 bool is_fragment_shader
);
1702 prototype_string(const glsl_type
*return_type
, const char *name
,
1703 exec_list
*parameters
);