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
;
92 /** ir_print_visitor helper for debugging. */
93 void print(void) const;
95 virtual void accept(ir_visitor
*) = 0;
96 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*) = 0;
97 virtual ir_instruction
*clone(void *mem_ctx
,
98 struct hash_table
*ht
) const = 0;
101 * \name IR instruction downcast functions
103 * These functions either cast the object to a derived class or return
104 * \c NULL if the object's type does not match the specified derived class.
105 * Additional downcast functions will be added as needed.
108 virtual class ir_variable
* as_variable() { return NULL
; }
109 virtual class ir_function
* as_function() { return NULL
; }
110 virtual class ir_dereference
* as_dereference() { return NULL
; }
111 virtual class ir_dereference_array
* as_dereference_array() { return NULL
; }
112 virtual class ir_dereference_variable
*as_dereference_variable() { return NULL
; }
113 virtual class ir_expression
* as_expression() { return NULL
; }
114 virtual class ir_rvalue
* as_rvalue() { return NULL
; }
115 virtual class ir_loop
* as_loop() { return NULL
; }
116 virtual class ir_assignment
* as_assignment() { return NULL
; }
117 virtual class ir_call
* as_call() { return NULL
; }
118 virtual class ir_return
* as_return() { return NULL
; }
119 virtual class ir_if
* as_if() { return NULL
; }
120 virtual class ir_swizzle
* as_swizzle() { return NULL
; }
121 virtual class ir_constant
* as_constant() { return NULL
; }
122 virtual class ir_discard
* as_discard() { return NULL
; }
128 ir_type
= ir_type_unset
;
134 * The base class for all "values"/expression trees.
136 class ir_rvalue
: public ir_instruction
{
138 const struct glsl_type
*type
;
140 virtual ir_rvalue
*clone(void *mem_ctx
, struct hash_table
*) const;
142 virtual void accept(ir_visitor
*v
)
147 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
149 virtual ir_constant
*constant_expression_value();
151 virtual ir_rvalue
* as_rvalue()
156 ir_rvalue
*as_rvalue_to_saturate();
158 virtual bool is_lvalue() const
164 * Get the variable that is ultimately referenced by an r-value
166 virtual ir_variable
*variable_referenced() const
173 * If an r-value is a reference to a whole variable, get that variable
176 * Pointer to a variable that is completely dereferenced by the r-value. If
177 * the r-value is not a dereference or the dereference does not access the
178 * entire variable (i.e., it's just one array element, struct field), \c NULL
181 virtual ir_variable
*whole_variable_referenced()
187 * Determine if an r-value has the value zero
189 * The base implementation of this function always returns \c false. The
190 * \c ir_constant class over-rides this function to return \c true \b only
191 * for vector and scalar types that have all elements set to the value
192 * zero (or \c false for booleans).
194 * \sa ir_constant::has_value, ir_rvalue::is_one, ir_rvalue::is_negative_one
196 virtual bool is_zero() const;
199 * Determine if an r-value has the value one
201 * The base implementation of this function always returns \c false. The
202 * \c ir_constant class over-rides this function to return \c true \b only
203 * for vector and scalar types that have all elements set to the value
204 * one (or \c true for booleans).
206 * \sa ir_constant::has_value, ir_rvalue::is_zero, ir_rvalue::is_negative_one
208 virtual bool is_one() const;
211 * Determine if an r-value has the value negative one
213 * The base implementation of this function always returns \c false. The
214 * \c ir_constant class over-rides this function to return \c true \b only
215 * for vector and scalar types that have all elements set to the value
216 * negative one. For boolean times, the result is always \c false.
218 * \sa ir_constant::has_value, ir_rvalue::is_zero, ir_rvalue::is_one
220 virtual bool is_negative_one() const;
224 * Return a generic value of error_type.
226 * Allocation will be performed with 'mem_ctx' as ralloc owner.
228 static ir_rvalue
*error_value(void *mem_ctx
);
236 * Variable storage classes
238 enum ir_variable_mode
{
239 ir_var_auto
= 0, /**< Function local variables and globals. */
240 ir_var_uniform
, /**< Variable declared as a uniform. */
244 ir_var_const_in
, /**< "in" param that must be a constant expression */
245 ir_var_system_value
, /**< Ex: front-face, instance-id, etc. */
246 ir_var_temporary
/**< Temporary variable generated during compilation. */
250 * \brief Layout qualifiers for gl_FragDepth.
252 * The AMD/ARB_conservative_depth extensions allow gl_FragDepth to be redeclared
253 * with a layout qualifier.
255 enum ir_depth_layout
{
256 ir_depth_layout_none
, /**< No depth layout is specified. */
258 ir_depth_layout_greater
,
259 ir_depth_layout_less
,
260 ir_depth_layout_unchanged
264 * \brief Convert depth layout qualifier to string.
267 depth_layout_string(ir_depth_layout layout
);
270 * Description of built-in state associated with a uniform
272 * \sa ir_variable::state_slots
274 struct ir_state_slot
{
279 class ir_variable
: public ir_instruction
{
281 ir_variable(const struct glsl_type
*, const char *, ir_variable_mode
);
283 virtual ir_variable
*clone(void *mem_ctx
, struct hash_table
*ht
) const;
285 virtual ir_variable
*as_variable()
290 virtual void accept(ir_visitor
*v
)
295 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
299 * Get the string value for the interpolation qualifier
301 * \return The string that would be used in a shader to specify \c
302 * mode will be returned.
304 * This function is used to generate error messages of the form "shader
305 * uses %s interpolation qualifier", so in the case where there is no
306 * interpolation qualifier, it returns "no".
308 * This function should only be used on a shader input or output variable.
310 const char *interpolation_string() const;
313 * Determine how this variable should be interpolated based on its
314 * interpolation qualifier (if present), whether it is gl_Color or
315 * gl_SecondaryColor, and whether flatshading is enabled in the current GL
318 * The return value will always be either INTERP_QUALIFIER_SMOOTH,
319 * INTERP_QUALIFIER_NOPERSPECTIVE, or INTERP_QUALIFIER_FLAT.
321 glsl_interp_qualifier
determine_interpolation_mode(bool flat_shade
);
324 * Declared type of the variable
326 const struct glsl_type
*type
;
329 * Delcared name of the variable
334 * Highest element accessed with a constant expression array index
336 * Not used for non-array variables.
338 unsigned max_array_access
;
341 * Is the variable read-only?
343 * This is set for variables declared as \c const, shader inputs,
346 unsigned read_only
:1;
348 unsigned invariant
:1;
351 * Has this variable been used for reading or writing?
353 * Several GLSL semantic checks require knowledge of whether or not a
354 * variable has been used. For example, it is an error to redeclare a
355 * variable as invariant after it has been used.
360 * Storage class of the variable.
362 * \sa ir_variable_mode
367 * Interpolation mode for shader inputs / outputs
369 * \sa ir_variable_interpolation
371 unsigned interpolation
:2;
374 * \name ARB_fragment_coord_conventions
377 unsigned origin_upper_left
:1;
378 unsigned pixel_center_integer
:1;
382 * Was the location explicitly set in the shader?
384 * If the location is explicitly set in the shader, it \b cannot be changed
385 * by the linker or by the API (e.g., calls to \c glBindAttribLocation have
388 unsigned explicit_location
:1;
391 * Does this variable have an initializer?
393 * This is used by the linker to cross-validiate initializers of global
396 unsigned has_initializer
:1;
399 * \brief Layout qualifier for gl_FragDepth.
401 * This is not equal to \c ir_depth_layout_none if and only if this
402 * variable is \c gl_FragDepth and a layout qualifier is specified.
404 ir_depth_layout depth_layout
;
407 * Storage location of the base of this variable
409 * The precise meaning of this field depends on the nature of the variable.
411 * - Vertex shader input: one of the values from \c gl_vert_attrib.
412 * - Vertex shader output: one of the values from \c gl_vert_result.
413 * - Fragment shader input: one of the values from \c gl_frag_attrib.
414 * - Fragment shader output: one of the values from \c gl_frag_result.
415 * - Uniforms: Per-stage uniform slot number.
416 * - Other: This field is not currently used.
418 * If the variable is a uniform, shader input, or shader output, and the
419 * slot has not been assigned, the value will be -1.
424 * Built-in state that backs this uniform
426 * Once set at variable creation, \c state_slots must remain invariant.
427 * This is because, ideally, this array would be shared by all clones of
428 * this variable in the IR tree. In other words, we'd really like for it
429 * to be a fly-weight.
431 * If the variable is not a uniform, \c num_state_slots will be zero and
432 * \c state_slots will be \c NULL.
435 unsigned num_state_slots
; /**< Number of state slots used */
436 ir_state_slot
*state_slots
; /**< State descriptors. */
440 * Emit a warning if this variable is accessed.
442 const char *warn_extension
;
445 * Value assigned in the initializer of a variable declared "const"
447 ir_constant
*constant_value
;
450 * Constant expression assigned in the initializer of the variable
453 * This field and \c ::constant_value are distinct. Even if the two fields
454 * refer to constants with the same value, they must point to separate
457 ir_constant
*constant_initializer
;
463 * The representation of a function instance; may be the full definition or
464 * simply a prototype.
466 class ir_function_signature
: public ir_instruction
{
467 /* An ir_function_signature will be part of the list of signatures in
471 ir_function_signature(const glsl_type
*return_type
);
473 virtual ir_function_signature
*clone(void *mem_ctx
,
474 struct hash_table
*ht
) const;
475 ir_function_signature
*clone_prototype(void *mem_ctx
,
476 struct hash_table
*ht
) const;
478 virtual void accept(ir_visitor
*v
)
483 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
486 * Attempt to evaluate this function as a constant expression, given
487 * a list of the actual parameters. Returns NULL for non-built-ins.
489 ir_constant
*constant_expression_value(exec_list
*actual_parameters
);
492 * Get the name of the function for which this is a signature
494 const char *function_name() const;
497 * Get a handle to the function for which this is a signature
499 * There is no setter function, this function returns a \c const pointer,
500 * and \c ir_function_signature::_function is private for a reason. The
501 * only way to make a connection between a function and function signature
502 * is via \c ir_function::add_signature. This helps ensure that certain
503 * invariants (i.e., a function signature is in the list of signatures for
504 * its \c _function) are met.
506 * \sa ir_function::add_signature
508 inline const class ir_function
*function() const
510 return this->_function
;
514 * Check whether the qualifiers match between this signature's parameters
515 * and the supplied parameter list. If not, returns the name of the first
516 * parameter with mismatched qualifiers (for use in error messages).
518 const char *qualifiers_match(exec_list
*params
);
521 * Replace the current parameter list with the given one. This is useful
522 * if the current information came from a prototype, and either has invalid
523 * or missing parameter names.
525 void replace_parameters(exec_list
*new_params
);
528 * Function return type.
530 * \note This discards the optional precision qualifier.
532 const struct glsl_type
*return_type
;
535 * List of ir_variable of function parameters.
537 * This represents the storage. The paramaters passed in a particular
538 * call will be in ir_call::actual_paramaters.
540 struct exec_list parameters
;
542 /** Whether or not this function has a body (which may be empty). */
543 unsigned is_defined
:1;
545 /** Whether or not this function signature is a built-in. */
546 unsigned is_builtin
:1;
548 /** Body of instructions in the function. */
549 struct exec_list body
;
552 /** Function of which this signature is one overload. */
553 class ir_function
*_function
;
555 friend class ir_function
;
560 * Header for tracking multiple overloaded functions with the same name.
561 * Contains a list of ir_function_signatures representing each of the
564 class ir_function
: public ir_instruction
{
566 ir_function(const char *name
);
568 virtual ir_function
*clone(void *mem_ctx
, struct hash_table
*ht
) const;
570 virtual ir_function
*as_function()
575 virtual void accept(ir_visitor
*v
)
580 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
582 void add_signature(ir_function_signature
*sig
)
584 sig
->_function
= this;
585 this->signatures
.push_tail(sig
);
589 * Get an iterator for the set of function signatures
591 exec_list_iterator
iterator()
593 return signatures
.iterator();
597 * Find a signature that matches a set of actual parameters, taking implicit
598 * conversions into account. Also flags whether the match was exact.
600 ir_function_signature
*matching_signature(const exec_list
*actual_param
,
601 bool *match_is_exact
);
604 * Find a signature that matches a set of actual parameters, taking implicit
605 * conversions into account.
607 ir_function_signature
*matching_signature(const exec_list
*actual_param
);
610 * Find a signature that exactly matches a set of actual parameters without
611 * any implicit type conversions.
613 ir_function_signature
*exact_matching_signature(const exec_list
*actual_ps
);
616 * Name of the function.
620 /** Whether or not this function has a signature that isn't a built-in. */
621 bool has_user_signature();
624 * List of ir_function_signature for each overloaded function with this name.
626 struct exec_list signatures
;
629 inline const char *ir_function_signature::function_name() const
631 return this->_function
->name
;
637 * IR instruction representing high-level if-statements
639 class ir_if
: public ir_instruction
{
641 ir_if(ir_rvalue
*condition
)
642 : condition(condition
)
644 ir_type
= ir_type_if
;
647 virtual ir_if
*clone(void *mem_ctx
, struct hash_table
*ht
) const;
649 virtual ir_if
*as_if()
654 virtual void accept(ir_visitor
*v
)
659 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
661 ir_rvalue
*condition
;
662 /** List of ir_instruction for the body of the then branch */
663 exec_list then_instructions
;
664 /** List of ir_instruction for the body of the else branch */
665 exec_list else_instructions
;
670 * IR instruction representing a high-level loop structure.
672 class ir_loop
: public ir_instruction
{
676 virtual ir_loop
*clone(void *mem_ctx
, struct hash_table
*ht
) const;
678 virtual void accept(ir_visitor
*v
)
683 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
685 virtual ir_loop
*as_loop()
691 * Get an iterator for the instructions of the loop body
693 exec_list_iterator
iterator()
695 return body_instructions
.iterator();
698 /** List of ir_instruction that make up the body of the loop. */
699 exec_list body_instructions
;
702 * \name Loop counter and controls
704 * Represents a loop like a FORTRAN \c do-loop.
707 * If \c from and \c to are the same value, the loop will execute once.
710 ir_rvalue
*from
; /** Value of the loop counter on the first
711 * iteration of the loop.
713 ir_rvalue
*to
; /** Value of the loop counter on the last
714 * iteration of the loop.
716 ir_rvalue
*increment
;
717 ir_variable
*counter
;
720 * Comparison operation in the loop terminator.
722 * If any of the loop control fields are non-\c NULL, this field must be
723 * one of \c ir_binop_less, \c ir_binop_greater, \c ir_binop_lequal,
724 * \c ir_binop_gequal, \c ir_binop_equal, or \c ir_binop_nequal.
731 class ir_assignment
: public ir_instruction
{
733 ir_assignment(ir_rvalue
*lhs
, ir_rvalue
*rhs
, ir_rvalue
*condition
= NULL
);
736 * Construct an assignment with an explicit write mask
739 * Since a write mask is supplied, the LHS must already be a bare
740 * \c ir_dereference. The cannot be any swizzles in the LHS.
742 ir_assignment(ir_dereference
*lhs
, ir_rvalue
*rhs
, ir_rvalue
*condition
,
743 unsigned write_mask
);
745 virtual ir_assignment
*clone(void *mem_ctx
, struct hash_table
*ht
) const;
747 virtual ir_constant
*constant_expression_value();
749 virtual void accept(ir_visitor
*v
)
754 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
756 virtual ir_assignment
* as_assignment()
762 * Get a whole variable written by an assignment
764 * If the LHS of the assignment writes a whole variable, the variable is
765 * returned. Otherwise \c NULL is returned. Examples of whole-variable
768 * - Assigning to a scalar
769 * - Assigning to all components of a vector
770 * - Whole array (or matrix) assignment
771 * - Whole structure assignment
773 ir_variable
*whole_variable_written();
776 * Set the LHS of an assignment
778 void set_lhs(ir_rvalue
*lhs
);
781 * Left-hand side of the assignment.
783 * This should be treated as read only. If you need to set the LHS of an
784 * assignment, use \c ir_assignment::set_lhs.
789 * Value being assigned
794 * Optional condition for the assignment.
796 ir_rvalue
*condition
;
800 * Component mask written
802 * For non-vector types in the LHS, this field will be zero. For vector
803 * types, a bit will be set for each component that is written. Note that
804 * for \c vec2 and \c vec3 types only the lower bits will ever be set.
806 * A partially-set write mask means that each enabled channel gets
807 * the value from a consecutive channel of the rhs. For example,
808 * to write just .xyw of gl_FrontColor with color:
810 * (assign (constant bool (1)) (xyw)
811 * (var_ref gl_FragColor)
812 * (swiz xyw (var_ref color)))
814 unsigned write_mask
:4;
817 /* Update ir_expression::num_operands() and operator_strs when
818 * updating this list.
820 enum ir_expression_operation
{
829 ir_unop_exp
, /**< Log base e on gentype */
830 ir_unop_log
, /**< Natural log on gentype */
833 ir_unop_f2i
, /**< Float-to-integer conversion. */
834 ir_unop_i2f
, /**< Integer-to-float conversion. */
835 ir_unop_f2b
, /**< Float-to-boolean conversion */
836 ir_unop_b2f
, /**< Boolean-to-float conversion */
837 ir_unop_i2b
, /**< int-to-boolean conversion */
838 ir_unop_b2i
, /**< Boolean-to-int conversion */
839 ir_unop_u2f
, /**< Unsigned-to-float conversion. */
840 ir_unop_i2u
, /**< Integer-to-unsigned conversion. */
841 ir_unop_u2i
, /**< Unsigned-to-integer conversion. */
845 * \name Unary floating-point rounding operations.
856 * \name Trigonometric operations.
861 ir_unop_sin_reduced
, /**< Reduced range sin. [-pi, pi] */
862 ir_unop_cos_reduced
, /**< Reduced range cos. [-pi, pi] */
866 * \name Partial derivatives.
876 * A sentinel marking the last of the unary operations.
878 ir_last_unop
= ir_unop_noise
,
886 * Takes one of two combinations of arguments:
891 * Does not take integer types.
896 * \name Binary comparison operators which return a boolean vector.
897 * The type of both operands must be equal.
907 * Returns single boolean for whether all components of operands[0]
908 * equal the components of operands[1].
912 * Returns single boolean for whether any component of operands[0]
913 * is not equal to the corresponding component of operands[1].
919 * \name Bit-wise binary operations.
940 * A sentinel marking the last of the binary operations.
942 ir_last_binop
= ir_binop_pow
,
947 * A sentinel marking the last of all operations.
949 ir_last_opcode
= ir_last_binop
952 class ir_expression
: public ir_rvalue
{
955 * Constructor for unary operation expressions
957 ir_expression(int op
, const struct glsl_type
*type
, ir_rvalue
*);
958 ir_expression(int op
, ir_rvalue
*);
961 * Constructor for binary operation expressions
963 ir_expression(int op
, const struct glsl_type
*type
,
964 ir_rvalue
*, ir_rvalue
*);
965 ir_expression(int op
, ir_rvalue
*op0
, ir_rvalue
*op1
);
968 * Constructor for quad operator expressions
970 ir_expression(int op
, const struct glsl_type
*type
,
971 ir_rvalue
*, ir_rvalue
*, ir_rvalue
*, ir_rvalue
*);
973 virtual ir_expression
*as_expression()
978 virtual ir_expression
*clone(void *mem_ctx
, struct hash_table
*ht
) const;
981 * Attempt to constant-fold the expression
983 * If the expression cannot be constant folded, this method will return
986 virtual ir_constant
*constant_expression_value();
989 * Determine the number of operands used by an expression
991 static unsigned int get_num_operands(ir_expression_operation
);
994 * Determine the number of operands used by an expression
996 unsigned int get_num_operands() const
998 return (this->operation
== ir_quadop_vector
)
999 ? this->type
->vector_elements
: get_num_operands(operation
);
1003 * Return a string representing this expression's operator.
1005 const char *operator_string();
1008 * Return a string representing this expression's operator.
1010 static const char *operator_string(ir_expression_operation
);
1014 * Do a reverse-lookup to translate the given string into an operator.
1016 static ir_expression_operation
get_operator(const char *);
1018 virtual void accept(ir_visitor
*v
)
1023 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1025 ir_expression_operation operation
;
1026 ir_rvalue
*operands
[4];
1031 * HIR instruction representing a high-level function call, containing a list
1032 * of parameters and returning a value in the supplied temporary.
1034 class ir_call
: public ir_instruction
{
1036 ir_call(ir_function_signature
*callee
,
1037 ir_dereference_variable
*return_deref
,
1038 exec_list
*actual_parameters
)
1039 : return_deref(return_deref
), callee(callee
)
1041 ir_type
= ir_type_call
;
1042 assert(callee
->return_type
!= NULL
);
1043 actual_parameters
->move_nodes_to(& this->actual_parameters
);
1044 this->use_builtin
= callee
->is_builtin
;
1047 virtual ir_call
*clone(void *mem_ctx
, struct hash_table
*ht
) const;
1049 virtual ir_constant
*constant_expression_value();
1051 virtual ir_call
*as_call()
1056 virtual void accept(ir_visitor
*v
)
1061 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1064 * Get an iterator for the set of acutal parameters
1066 exec_list_iterator
iterator()
1068 return actual_parameters
.iterator();
1072 * Get the name of the function being called.
1074 const char *callee_name() const
1076 return callee
->function_name();
1080 * Generates an inline version of the function before @ir,
1081 * storing the return value in return_deref.
1083 void generate_inline(ir_instruction
*ir
);
1086 * Storage for the function's return value.
1087 * This must be NULL if the return type is void.
1089 ir_dereference_variable
*return_deref
;
1092 * The specific function signature being called.
1094 ir_function_signature
*callee
;
1096 /* List of ir_rvalue of paramaters passed in this call. */
1097 exec_list actual_parameters
;
1099 /** Should this call only bind to a built-in function? */
1105 * \name Jump-like IR instructions.
1107 * These include \c break, \c continue, \c return, and \c discard.
1110 class ir_jump
: public ir_instruction
{
1114 ir_type
= ir_type_unset
;
1118 class ir_return
: public ir_jump
{
1123 this->ir_type
= ir_type_return
;
1126 ir_return(ir_rvalue
*value
)
1129 this->ir_type
= ir_type_return
;
1132 virtual ir_return
*clone(void *mem_ctx
, struct hash_table
*) const;
1134 virtual ir_return
*as_return()
1139 ir_rvalue
*get_value() const
1144 virtual void accept(ir_visitor
*v
)
1149 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1156 * Jump instructions used inside loops
1158 * These include \c break and \c continue. The \c break within a loop is
1159 * different from the \c break within a switch-statement.
1161 * \sa ir_switch_jump
1163 class ir_loop_jump
: public ir_jump
{
1170 ir_loop_jump(jump_mode mode
)
1172 this->ir_type
= ir_type_loop_jump
;
1177 virtual ir_loop_jump
*clone(void *mem_ctx
, struct hash_table
*) const;
1179 virtual void accept(ir_visitor
*v
)
1184 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1186 bool is_break() const
1188 return mode
== jump_break
;
1191 bool is_continue() const
1193 return mode
== jump_continue
;
1196 /** Mode selector for the jump instruction. */
1197 enum jump_mode mode
;
1199 /** Loop containing this break instruction. */
1204 * IR instruction representing discard statements.
1206 class ir_discard
: public ir_jump
{
1210 this->ir_type
= ir_type_discard
;
1211 this->condition
= NULL
;
1214 ir_discard(ir_rvalue
*cond
)
1216 this->ir_type
= ir_type_discard
;
1217 this->condition
= cond
;
1220 virtual ir_discard
*clone(void *mem_ctx
, struct hash_table
*ht
) const;
1222 virtual void accept(ir_visitor
*v
)
1227 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1229 virtual ir_discard
*as_discard()
1234 ir_rvalue
*condition
;
1240 * Texture sampling opcodes used in ir_texture
1242 enum ir_texture_opcode
{
1243 ir_tex
, /**< Regular texture look-up */
1244 ir_txb
, /**< Texture look-up with LOD bias */
1245 ir_txl
, /**< Texture look-up with explicit LOD */
1246 ir_txd
, /**< Texture look-up with partial derivatvies */
1247 ir_txf
, /**< Texel fetch with explicit LOD */
1248 ir_txs
/**< Texture size */
1253 * IR instruction to sample a texture
1255 * The specific form of the IR instruction depends on the \c mode value
1256 * selected from \c ir_texture_opcodes. In the printed IR, these will
1259 * Texel offset (0 or an expression)
1260 * | Projection divisor
1261 * | | Shadow comparitor
1264 * (tex <type> <sampler> <coordinate> 0 1 ( ))
1265 * (txb <type> <sampler> <coordinate> 0 1 ( ) <bias>)
1266 * (txl <type> <sampler> <coordinate> 0 1 ( ) <lod>)
1267 * (txd <type> <sampler> <coordinate> 0 1 ( ) (dPdx dPdy))
1268 * (txf <type> <sampler> <coordinate> 0 <lod>)
1269 * (txs <type> <sampler> <lod>)
1271 class ir_texture
: public ir_rvalue
{
1273 ir_texture(enum ir_texture_opcode op
)
1274 : op(op
), projector(NULL
), shadow_comparitor(NULL
), offset(NULL
)
1276 this->ir_type
= ir_type_texture
;
1279 virtual ir_texture
*clone(void *mem_ctx
, struct hash_table
*) const;
1281 virtual ir_constant
*constant_expression_value();
1283 virtual void accept(ir_visitor
*v
)
1288 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1291 * Return a string representing the ir_texture_opcode.
1293 const char *opcode_string();
1295 /** Set the sampler and type. */
1296 void set_sampler(ir_dereference
*sampler
, const glsl_type
*type
);
1299 * Do a reverse-lookup to translate a string into an ir_texture_opcode.
1301 static ir_texture_opcode
get_opcode(const char *);
1303 enum ir_texture_opcode op
;
1305 /** Sampler to use for the texture access. */
1306 ir_dereference
*sampler
;
1308 /** Texture coordinate to sample */
1309 ir_rvalue
*coordinate
;
1312 * Value used for projective divide.
1314 * If there is no projective divide (the common case), this will be
1315 * \c NULL. Optimization passes should check for this to point to a constant
1316 * of 1.0 and replace that with \c NULL.
1318 ir_rvalue
*projector
;
1321 * Coordinate used for comparison on shadow look-ups.
1323 * If there is no shadow comparison, this will be \c NULL. For the
1324 * \c ir_txf opcode, this *must* be \c NULL.
1326 ir_rvalue
*shadow_comparitor
;
1328 /** Texel offset. */
1332 ir_rvalue
*lod
; /**< Floating point LOD */
1333 ir_rvalue
*bias
; /**< Floating point LOD bias */
1335 ir_rvalue
*dPdx
; /**< Partial derivative of coordinate wrt X */
1336 ir_rvalue
*dPdy
; /**< Partial derivative of coordinate wrt Y */
1342 struct ir_swizzle_mask
{
1349 * Number of components in the swizzle.
1351 unsigned num_components
:3;
1354 * Does the swizzle contain duplicate components?
1356 * L-value swizzles cannot contain duplicate components.
1358 unsigned has_duplicates
:1;
1362 class ir_swizzle
: public ir_rvalue
{
1364 ir_swizzle(ir_rvalue
*, unsigned x
, unsigned y
, unsigned z
, unsigned w
,
1367 ir_swizzle(ir_rvalue
*val
, const unsigned *components
, unsigned count
);
1369 ir_swizzle(ir_rvalue
*val
, ir_swizzle_mask mask
);
1371 virtual ir_swizzle
*clone(void *mem_ctx
, struct hash_table
*) const;
1373 virtual ir_constant
*constant_expression_value();
1375 virtual ir_swizzle
*as_swizzle()
1381 * Construct an ir_swizzle from the textual representation. Can fail.
1383 static ir_swizzle
*create(ir_rvalue
*, const char *, unsigned vector_length
);
1385 virtual void accept(ir_visitor
*v
)
1390 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1392 bool is_lvalue() const
1394 return val
->is_lvalue() && !mask
.has_duplicates
;
1398 * Get the variable that is ultimately referenced by an r-value
1400 virtual ir_variable
*variable_referenced() const;
1403 ir_swizzle_mask mask
;
1407 * Initialize the mask component of a swizzle
1409 * This is used by the \c ir_swizzle constructors.
1411 void init_mask(const unsigned *components
, unsigned count
);
1415 class ir_dereference
: public ir_rvalue
{
1417 virtual ir_dereference
*clone(void *mem_ctx
, struct hash_table
*) const = 0;
1419 virtual ir_dereference
*as_dereference()
1424 bool is_lvalue() const;
1427 * Get the variable that is ultimately referenced by an r-value
1429 virtual ir_variable
*variable_referenced() const = 0;
1433 class ir_dereference_variable
: public ir_dereference
{
1435 ir_dereference_variable(ir_variable
*var
);
1437 virtual ir_dereference_variable
*clone(void *mem_ctx
,
1438 struct hash_table
*) const;
1440 virtual ir_constant
*constant_expression_value();
1442 virtual ir_dereference_variable
*as_dereference_variable()
1448 * Get the variable that is ultimately referenced by an r-value
1450 virtual ir_variable
*variable_referenced() const
1455 virtual ir_variable
*whole_variable_referenced()
1457 /* ir_dereference_variable objects always dereference the entire
1458 * variable. However, if this dereference is dereferenced by anything
1459 * else, the complete deferefernce chain is not a whole-variable
1460 * dereference. This method should only be called on the top most
1461 * ir_rvalue in a dereference chain.
1466 virtual void accept(ir_visitor
*v
)
1471 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1474 * Object being dereferenced.
1480 class ir_dereference_array
: public ir_dereference
{
1482 ir_dereference_array(ir_rvalue
*value
, ir_rvalue
*array_index
);
1484 ir_dereference_array(ir_variable
*var
, ir_rvalue
*array_index
);
1486 virtual ir_dereference_array
*clone(void *mem_ctx
,
1487 struct hash_table
*) const;
1489 virtual ir_constant
*constant_expression_value();
1491 virtual ir_dereference_array
*as_dereference_array()
1497 * Get the variable that is ultimately referenced by an r-value
1499 virtual ir_variable
*variable_referenced() const
1501 return this->array
->variable_referenced();
1504 virtual void accept(ir_visitor
*v
)
1509 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1512 ir_rvalue
*array_index
;
1515 void set_array(ir_rvalue
*value
);
1519 class ir_dereference_record
: public ir_dereference
{
1521 ir_dereference_record(ir_rvalue
*value
, const char *field
);
1523 ir_dereference_record(ir_variable
*var
, const char *field
);
1525 virtual ir_dereference_record
*clone(void *mem_ctx
,
1526 struct hash_table
*) const;
1528 virtual ir_constant
*constant_expression_value();
1531 * Get the variable that is ultimately referenced by an r-value
1533 virtual ir_variable
*variable_referenced() const
1535 return this->record
->variable_referenced();
1538 virtual void accept(ir_visitor
*v
)
1543 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1551 * Data stored in an ir_constant
1553 union ir_constant_data
{
1561 class ir_constant
: public ir_rvalue
{
1563 ir_constant(const struct glsl_type
*type
, const ir_constant_data
*data
);
1564 ir_constant(bool b
);
1565 ir_constant(unsigned int u
);
1567 ir_constant(float f
);
1570 * Construct an ir_constant from a list of ir_constant values
1572 ir_constant(const struct glsl_type
*type
, exec_list
*values
);
1575 * Construct an ir_constant from a scalar component of another ir_constant
1577 * The new \c ir_constant inherits the type of the component from the
1581 * In the case of a matrix constant, the new constant is a scalar, \b not
1584 ir_constant(const ir_constant
*c
, unsigned i
);
1587 * Return a new ir_constant of the specified type containing all zeros.
1589 static ir_constant
*zero(void *mem_ctx
, const glsl_type
*type
);
1591 virtual ir_constant
*clone(void *mem_ctx
, struct hash_table
*) const;
1593 virtual ir_constant
*constant_expression_value();
1595 virtual ir_constant
*as_constant()
1600 virtual void accept(ir_visitor
*v
)
1605 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1608 * Get a particular component of a constant as a specific type
1610 * This is useful, for example, to get a value from an integer constant
1611 * as a float or bool. This appears frequently when constructors are
1612 * called with all constant parameters.
1615 bool get_bool_component(unsigned i
) const;
1616 float get_float_component(unsigned i
) const;
1617 int get_int_component(unsigned i
) const;
1618 unsigned get_uint_component(unsigned i
) const;
1621 ir_constant
*get_array_element(unsigned i
) const;
1623 ir_constant
*get_record_field(const char *name
);
1626 * Determine whether a constant has the same value as another constant
1628 * \sa ir_constant::is_zero, ir_constant::is_one,
1629 * ir_constant::is_negative_one
1631 bool has_value(const ir_constant
*) const;
1633 virtual bool is_zero() const;
1634 virtual bool is_one() const;
1635 virtual bool is_negative_one() const;
1638 * Value of the constant.
1640 * The field used to back the values supplied by the constant is determined
1641 * by the type associated with the \c ir_instruction. Constants may be
1642 * scalars, vectors, or matrices.
1644 union ir_constant_data value
;
1646 /* Array elements */
1647 ir_constant
**array_elements
;
1649 /* Structure fields */
1650 exec_list components
;
1654 * Parameterless constructor only used by the clone method
1662 * Apply a visitor to each IR node in a list
1665 visit_exec_list(exec_list
*list
, ir_visitor
*visitor
);
1668 * Validate invariants on each IR node in a list
1670 void validate_ir_tree(exec_list
*instructions
);
1672 struct _mesa_glsl_parse_state
;
1673 struct gl_shader_program
;
1676 * Detect whether an unlinked shader contains static recursion
1678 * If the list of instructions is determined to contain static recursion,
1679 * \c _mesa_glsl_error will be called to emit error messages for each function
1680 * that is in the recursion cycle.
1683 detect_recursion_unlinked(struct _mesa_glsl_parse_state
*state
,
1684 exec_list
*instructions
);
1687 * Detect whether a linked shader contains static recursion
1689 * If the list of instructions is determined to contain static recursion,
1690 * \c link_error_printf will be called to emit error messages for each function
1691 * that is in the recursion cycle. In addition,
1692 * \c gl_shader_program::LinkStatus will be set to false.
1695 detect_recursion_linked(struct gl_shader_program
*prog
,
1696 exec_list
*instructions
);
1699 * Make a clone of each IR instruction in a list
1701 * \param in List of IR instructions that are to be cloned
1702 * \param out List to hold the cloned instructions
1705 clone_ir_list(void *mem_ctx
, exec_list
*out
, const exec_list
*in
);
1708 _mesa_glsl_initialize_variables(exec_list
*instructions
,
1709 struct _mesa_glsl_parse_state
*state
);
1712 _mesa_glsl_initialize_functions(_mesa_glsl_parse_state
*state
);
1715 _mesa_glsl_release_functions(void);
1718 reparent_ir(exec_list
*list
, void *mem_ctx
);
1720 struct glsl_symbol_table
;
1723 import_prototypes(const exec_list
*source
, exec_list
*dest
,
1724 struct glsl_symbol_table
*symbols
, void *mem_ctx
);
1727 ir_has_call(ir_instruction
*ir
);
1730 do_set_program_inouts(exec_list
*instructions
, struct gl_program
*prog
,
1731 bool is_fragment_shader
);
1734 prototype_string(const glsl_type
*return_type
, const char *name
,
1735 exec_list
*parameters
);