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(struct hash_table
*variable_context
= NULL
);
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.
357 * This is only maintained in the ast_to_hir.cpp path, not in
358 * Mesa's fixed function or ARB program paths.
363 * Has this variable been statically assigned?
365 * This answers whether the variable was assigned in any path of
366 * the shader during ast_to_hir. This doesn't answer whether it is
367 * still written after dead code removal, nor is it maintained in
368 * non-ast_to_hir.cpp (GLSL parsing) paths.
373 * Storage class of the variable.
375 * \sa ir_variable_mode
380 * Interpolation mode for shader inputs / outputs
382 * \sa ir_variable_interpolation
384 unsigned interpolation
:2;
387 * \name ARB_fragment_coord_conventions
390 unsigned origin_upper_left
:1;
391 unsigned pixel_center_integer
:1;
395 * Was the location explicitly set in the shader?
397 * If the location is explicitly set in the shader, it \b cannot be changed
398 * by the linker or by the API (e.g., calls to \c glBindAttribLocation have
401 unsigned explicit_location
:1;
402 unsigned explicit_index
:1;
405 * Does this variable have an initializer?
407 * This is used by the linker to cross-validiate initializers of global
410 unsigned has_initializer
:1;
413 * \brief Layout qualifier for gl_FragDepth.
415 * This is not equal to \c ir_depth_layout_none if and only if this
416 * variable is \c gl_FragDepth and a layout qualifier is specified.
418 ir_depth_layout depth_layout
;
421 * Storage location of the base of this variable
423 * The precise meaning of this field depends on the nature of the variable.
425 * - Vertex shader input: one of the values from \c gl_vert_attrib.
426 * - Vertex shader output: one of the values from \c gl_vert_result.
427 * - Fragment shader input: one of the values from \c gl_frag_attrib.
428 * - Fragment shader output: one of the values from \c gl_frag_result.
429 * - Uniforms: Per-stage uniform slot number.
430 * - Other: This field is not currently used.
432 * If the variable is a uniform, shader input, or shader output, and the
433 * slot has not been assigned, the value will be -1.
438 * output index for dual source blending.
443 * Built-in state that backs this uniform
445 * Once set at variable creation, \c state_slots must remain invariant.
446 * This is because, ideally, this array would be shared by all clones of
447 * this variable in the IR tree. In other words, we'd really like for it
448 * to be a fly-weight.
450 * If the variable is not a uniform, \c num_state_slots will be zero and
451 * \c state_slots will be \c NULL.
454 unsigned num_state_slots
; /**< Number of state slots used */
455 ir_state_slot
*state_slots
; /**< State descriptors. */
459 * Emit a warning if this variable is accessed.
461 const char *warn_extension
;
464 * Value assigned in the initializer of a variable declared "const"
466 ir_constant
*constant_value
;
469 * Constant expression assigned in the initializer of the variable
472 * This field and \c ::constant_value are distinct. Even if the two fields
473 * refer to constants with the same value, they must point to separate
476 ir_constant
*constant_initializer
;
482 * The representation of a function instance; may be the full definition or
483 * simply a prototype.
485 class ir_function_signature
: public ir_instruction
{
486 /* An ir_function_signature will be part of the list of signatures in
490 ir_function_signature(const glsl_type
*return_type
);
492 virtual ir_function_signature
*clone(void *mem_ctx
,
493 struct hash_table
*ht
) const;
494 ir_function_signature
*clone_prototype(void *mem_ctx
,
495 struct hash_table
*ht
) const;
497 virtual void accept(ir_visitor
*v
)
502 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
505 * Attempt to evaluate this function as a constant expression,
506 * given a list of the actual parameters and the variable context.
507 * Returns NULL for non-built-ins.
509 ir_constant
*constant_expression_value(exec_list
*actual_parameters
, struct hash_table
*variable_context
);
512 * Get the name of the function for which this is a signature
514 const char *function_name() const;
517 * Get a handle to the function for which this is a signature
519 * There is no setter function, this function returns a \c const pointer,
520 * and \c ir_function_signature::_function is private for a reason. The
521 * only way to make a connection between a function and function signature
522 * is via \c ir_function::add_signature. This helps ensure that certain
523 * invariants (i.e., a function signature is in the list of signatures for
524 * its \c _function) are met.
526 * \sa ir_function::add_signature
528 inline const class ir_function
*function() const
530 return this->_function
;
534 * Check whether the qualifiers match between this signature's parameters
535 * and the supplied parameter list. If not, returns the name of the first
536 * parameter with mismatched qualifiers (for use in error messages).
538 const char *qualifiers_match(exec_list
*params
);
541 * Replace the current parameter list with the given one. This is useful
542 * if the current information came from a prototype, and either has invalid
543 * or missing parameter names.
545 void replace_parameters(exec_list
*new_params
);
548 * Function return type.
550 * \note This discards the optional precision qualifier.
552 const struct glsl_type
*return_type
;
555 * List of ir_variable of function parameters.
557 * This represents the storage. The paramaters passed in a particular
558 * call will be in ir_call::actual_paramaters.
560 struct exec_list parameters
;
562 /** Whether or not this function has a body (which may be empty). */
563 unsigned is_defined
:1;
565 /** Whether or not this function signature is a built-in. */
566 unsigned is_builtin
:1;
568 /** Body of instructions in the function. */
569 struct exec_list body
;
572 /** Function of which this signature is one overload. */
573 class ir_function
*_function
;
575 /** Function signature of which this one is a prototype clone */
576 const ir_function_signature
*origin
;
578 friend class ir_function
;
581 * Helper function to run a list of instructions for constant
582 * expression evaluation.
584 * The hash table represents the values of the visible variables.
585 * There are no scoping issues because the table is indexed on
586 * ir_variable pointers, not variable names.
588 * Returns false if the expression is not constant, true otherwise,
589 * and the value in *result if result is non-NULL.
591 bool constant_expression_evaluate_expression_list(const struct exec_list
&body
,
592 struct hash_table
*variable_context
,
593 ir_constant
**result
);
598 * Header for tracking multiple overloaded functions with the same name.
599 * Contains a list of ir_function_signatures representing each of the
602 class ir_function
: public ir_instruction
{
604 ir_function(const char *name
);
606 virtual ir_function
*clone(void *mem_ctx
, struct hash_table
*ht
) const;
608 virtual ir_function
*as_function()
613 virtual void accept(ir_visitor
*v
)
618 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
620 void add_signature(ir_function_signature
*sig
)
622 sig
->_function
= this;
623 this->signatures
.push_tail(sig
);
627 * Get an iterator for the set of function signatures
629 exec_list_iterator
iterator()
631 return signatures
.iterator();
635 * Find a signature that matches a set of actual parameters, taking implicit
636 * conversions into account. Also flags whether the match was exact.
638 ir_function_signature
*matching_signature(const exec_list
*actual_param
,
639 bool *match_is_exact
);
642 * Find a signature that matches a set of actual parameters, taking implicit
643 * conversions into account.
645 ir_function_signature
*matching_signature(const exec_list
*actual_param
);
648 * Find a signature that exactly matches a set of actual parameters without
649 * any implicit type conversions.
651 ir_function_signature
*exact_matching_signature(const exec_list
*actual_ps
);
654 * Name of the function.
658 /** Whether or not this function has a signature that isn't a built-in. */
659 bool has_user_signature();
662 * List of ir_function_signature for each overloaded function with this name.
664 struct exec_list signatures
;
667 inline const char *ir_function_signature::function_name() const
669 return this->_function
->name
;
675 * IR instruction representing high-level if-statements
677 class ir_if
: public ir_instruction
{
679 ir_if(ir_rvalue
*condition
)
680 : condition(condition
)
682 ir_type
= ir_type_if
;
685 virtual ir_if
*clone(void *mem_ctx
, struct hash_table
*ht
) const;
687 virtual ir_if
*as_if()
692 virtual void accept(ir_visitor
*v
)
697 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
699 ir_rvalue
*condition
;
700 /** List of ir_instruction for the body of the then branch */
701 exec_list then_instructions
;
702 /** List of ir_instruction for the body of the else branch */
703 exec_list else_instructions
;
708 * IR instruction representing a high-level loop structure.
710 class ir_loop
: public ir_instruction
{
714 virtual ir_loop
*clone(void *mem_ctx
, struct hash_table
*ht
) const;
716 virtual void accept(ir_visitor
*v
)
721 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
723 virtual ir_loop
*as_loop()
729 * Get an iterator for the instructions of the loop body
731 exec_list_iterator
iterator()
733 return body_instructions
.iterator();
736 /** List of ir_instruction that make up the body of the loop. */
737 exec_list body_instructions
;
740 * \name Loop counter and controls
742 * Represents a loop like a FORTRAN \c do-loop.
745 * If \c from and \c to are the same value, the loop will execute once.
748 ir_rvalue
*from
; /** Value of the loop counter on the first
749 * iteration of the loop.
751 ir_rvalue
*to
; /** Value of the loop counter on the last
752 * iteration of the loop.
754 ir_rvalue
*increment
;
755 ir_variable
*counter
;
758 * Comparison operation in the loop terminator.
760 * If any of the loop control fields are non-\c NULL, this field must be
761 * one of \c ir_binop_less, \c ir_binop_greater, \c ir_binop_lequal,
762 * \c ir_binop_gequal, \c ir_binop_equal, or \c ir_binop_nequal.
769 class ir_assignment
: public ir_instruction
{
771 ir_assignment(ir_rvalue
*lhs
, ir_rvalue
*rhs
, ir_rvalue
*condition
= NULL
);
774 * Construct an assignment with an explicit write mask
777 * Since a write mask is supplied, the LHS must already be a bare
778 * \c ir_dereference. The cannot be any swizzles in the LHS.
780 ir_assignment(ir_dereference
*lhs
, ir_rvalue
*rhs
, ir_rvalue
*condition
,
781 unsigned write_mask
);
783 virtual ir_assignment
*clone(void *mem_ctx
, struct hash_table
*ht
) const;
785 virtual ir_constant
*constant_expression_value(struct hash_table
*variable_context
= NULL
);
787 virtual void accept(ir_visitor
*v
)
792 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
794 virtual ir_assignment
* as_assignment()
800 * Get a whole variable written by an assignment
802 * If the LHS of the assignment writes a whole variable, the variable is
803 * returned. Otherwise \c NULL is returned. Examples of whole-variable
806 * - Assigning to a scalar
807 * - Assigning to all components of a vector
808 * - Whole array (or matrix) assignment
809 * - Whole structure assignment
811 ir_variable
*whole_variable_written();
814 * Set the LHS of an assignment
816 void set_lhs(ir_rvalue
*lhs
);
819 * Left-hand side of the assignment.
821 * This should be treated as read only. If you need to set the LHS of an
822 * assignment, use \c ir_assignment::set_lhs.
827 * Value being assigned
832 * Optional condition for the assignment.
834 ir_rvalue
*condition
;
838 * Component mask written
840 * For non-vector types in the LHS, this field will be zero. For vector
841 * types, a bit will be set for each component that is written. Note that
842 * for \c vec2 and \c vec3 types only the lower bits will ever be set.
844 * A partially-set write mask means that each enabled channel gets
845 * the value from a consecutive channel of the rhs. For example,
846 * to write just .xyw of gl_FrontColor with color:
848 * (assign (constant bool (1)) (xyw)
849 * (var_ref gl_FragColor)
850 * (swiz xyw (var_ref color)))
852 unsigned write_mask
:4;
855 /* Update ir_expression::num_operands() and operator_strs when
856 * updating this list.
858 enum ir_expression_operation
{
867 ir_unop_exp
, /**< Log base e on gentype */
868 ir_unop_log
, /**< Natural log on gentype */
871 ir_unop_f2i
, /**< Float-to-integer conversion. */
872 ir_unop_i2f
, /**< Integer-to-float conversion. */
873 ir_unop_f2b
, /**< Float-to-boolean conversion */
874 ir_unop_b2f
, /**< Boolean-to-float conversion */
875 ir_unop_i2b
, /**< int-to-boolean conversion */
876 ir_unop_b2i
, /**< Boolean-to-int conversion */
877 ir_unop_u2f
, /**< Unsigned-to-float conversion. */
878 ir_unop_i2u
, /**< Integer-to-unsigned conversion. */
879 ir_unop_u2i
, /**< Unsigned-to-integer conversion. */
883 * \name Unary floating-point rounding operations.
894 * \name Trigonometric operations.
899 ir_unop_sin_reduced
, /**< Reduced range sin. [-pi, pi] */
900 ir_unop_cos_reduced
, /**< Reduced range cos. [-pi, pi] */
904 * \name Partial derivatives.
914 * A sentinel marking the last of the unary operations.
916 ir_last_unop
= ir_unop_noise
,
924 * Takes one of two combinations of arguments:
929 * Does not take integer types.
934 * \name Binary comparison operators which return a boolean vector.
935 * The type of both operands must be equal.
945 * Returns single boolean for whether all components of operands[0]
946 * equal the components of operands[1].
950 * Returns single boolean for whether any component of operands[0]
951 * is not equal to the corresponding component of operands[1].
957 * \name Bit-wise binary operations.
978 * A sentinel marking the last of the binary operations.
980 ir_last_binop
= ir_binop_pow
,
985 * A sentinel marking the last of all operations.
987 ir_last_opcode
= ir_last_binop
990 class ir_expression
: public ir_rvalue
{
993 * Constructor for unary operation expressions
995 ir_expression(int op
, const struct glsl_type
*type
, ir_rvalue
*);
996 ir_expression(int op
, ir_rvalue
*);
999 * Constructor for binary operation expressions
1001 ir_expression(int op
, const struct glsl_type
*type
,
1002 ir_rvalue
*, ir_rvalue
*);
1003 ir_expression(int op
, ir_rvalue
*op0
, ir_rvalue
*op1
);
1006 * Constructor for quad operator expressions
1008 ir_expression(int op
, const struct glsl_type
*type
,
1009 ir_rvalue
*, ir_rvalue
*, ir_rvalue
*, ir_rvalue
*);
1011 virtual ir_expression
*as_expression()
1016 virtual ir_expression
*clone(void *mem_ctx
, struct hash_table
*ht
) const;
1019 * Attempt to constant-fold the expression
1021 * The "variable_context" hash table links ir_variable * to ir_constant *
1022 * that represent the variables' values. \c NULL represents an empty
1025 * If the expression cannot be constant folded, this method will return
1028 virtual ir_constant
*constant_expression_value(struct hash_table
*variable_context
= NULL
);
1031 * Determine the number of operands used by an expression
1033 static unsigned int get_num_operands(ir_expression_operation
);
1036 * Determine the number of operands used by an expression
1038 unsigned int get_num_operands() const
1040 return (this->operation
== ir_quadop_vector
)
1041 ? this->type
->vector_elements
: get_num_operands(operation
);
1045 * Return a string representing this expression's operator.
1047 const char *operator_string();
1050 * Return a string representing this expression's operator.
1052 static const char *operator_string(ir_expression_operation
);
1056 * Do a reverse-lookup to translate the given string into an operator.
1058 static ir_expression_operation
get_operator(const char *);
1060 virtual void accept(ir_visitor
*v
)
1065 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1067 ir_expression_operation operation
;
1068 ir_rvalue
*operands
[4];
1073 * HIR instruction representing a high-level function call, containing a list
1074 * of parameters and returning a value in the supplied temporary.
1076 class ir_call
: public ir_instruction
{
1078 ir_call(ir_function_signature
*callee
,
1079 ir_dereference_variable
*return_deref
,
1080 exec_list
*actual_parameters
)
1081 : return_deref(return_deref
), callee(callee
)
1083 ir_type
= ir_type_call
;
1084 assert(callee
->return_type
!= NULL
);
1085 actual_parameters
->move_nodes_to(& this->actual_parameters
);
1086 this->use_builtin
= callee
->is_builtin
;
1089 virtual ir_call
*clone(void *mem_ctx
, struct hash_table
*ht
) const;
1091 virtual ir_constant
*constant_expression_value(struct hash_table
*variable_context
= NULL
);
1093 virtual ir_call
*as_call()
1098 virtual void accept(ir_visitor
*v
)
1103 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1106 * Get an iterator for the set of acutal parameters
1108 exec_list_iterator
iterator()
1110 return actual_parameters
.iterator();
1114 * Get the name of the function being called.
1116 const char *callee_name() const
1118 return callee
->function_name();
1122 * Generates an inline version of the function before @ir,
1123 * storing the return value in return_deref.
1125 void generate_inline(ir_instruction
*ir
);
1128 * Storage for the function's return value.
1129 * This must be NULL if the return type is void.
1131 ir_dereference_variable
*return_deref
;
1134 * The specific function signature being called.
1136 ir_function_signature
*callee
;
1138 /* List of ir_rvalue of paramaters passed in this call. */
1139 exec_list actual_parameters
;
1141 /** Should this call only bind to a built-in function? */
1147 * \name Jump-like IR instructions.
1149 * These include \c break, \c continue, \c return, and \c discard.
1152 class ir_jump
: public ir_instruction
{
1156 ir_type
= ir_type_unset
;
1160 class ir_return
: public ir_jump
{
1165 this->ir_type
= ir_type_return
;
1168 ir_return(ir_rvalue
*value
)
1171 this->ir_type
= ir_type_return
;
1174 virtual ir_return
*clone(void *mem_ctx
, struct hash_table
*) const;
1176 virtual ir_return
*as_return()
1181 ir_rvalue
*get_value() const
1186 virtual void accept(ir_visitor
*v
)
1191 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1198 * Jump instructions used inside loops
1200 * These include \c break and \c continue. The \c break within a loop is
1201 * different from the \c break within a switch-statement.
1203 * \sa ir_switch_jump
1205 class ir_loop_jump
: public ir_jump
{
1212 ir_loop_jump(jump_mode mode
)
1214 this->ir_type
= ir_type_loop_jump
;
1219 virtual ir_loop_jump
*clone(void *mem_ctx
, struct hash_table
*) const;
1221 virtual void accept(ir_visitor
*v
)
1226 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1228 bool is_break() const
1230 return mode
== jump_break
;
1233 bool is_continue() const
1235 return mode
== jump_continue
;
1238 /** Mode selector for the jump instruction. */
1239 enum jump_mode mode
;
1241 /** Loop containing this break instruction. */
1246 * IR instruction representing discard statements.
1248 class ir_discard
: public ir_jump
{
1252 this->ir_type
= ir_type_discard
;
1253 this->condition
= NULL
;
1256 ir_discard(ir_rvalue
*cond
)
1258 this->ir_type
= ir_type_discard
;
1259 this->condition
= cond
;
1262 virtual ir_discard
*clone(void *mem_ctx
, struct hash_table
*ht
) const;
1264 virtual void accept(ir_visitor
*v
)
1269 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1271 virtual ir_discard
*as_discard()
1276 ir_rvalue
*condition
;
1282 * Texture sampling opcodes used in ir_texture
1284 enum ir_texture_opcode
{
1285 ir_tex
, /**< Regular texture look-up */
1286 ir_txb
, /**< Texture look-up with LOD bias */
1287 ir_txl
, /**< Texture look-up with explicit LOD */
1288 ir_txd
, /**< Texture look-up with partial derivatvies */
1289 ir_txf
, /**< Texel fetch with explicit LOD */
1290 ir_txs
/**< Texture size */
1295 * IR instruction to sample a texture
1297 * The specific form of the IR instruction depends on the \c mode value
1298 * selected from \c ir_texture_opcodes. In the printed IR, these will
1301 * Texel offset (0 or an expression)
1302 * | Projection divisor
1303 * | | Shadow comparitor
1306 * (tex <type> <sampler> <coordinate> 0 1 ( ))
1307 * (txb <type> <sampler> <coordinate> 0 1 ( ) <bias>)
1308 * (txl <type> <sampler> <coordinate> 0 1 ( ) <lod>)
1309 * (txd <type> <sampler> <coordinate> 0 1 ( ) (dPdx dPdy))
1310 * (txf <type> <sampler> <coordinate> 0 <lod>)
1311 * (txs <type> <sampler> <lod>)
1313 class ir_texture
: public ir_rvalue
{
1315 ir_texture(enum ir_texture_opcode op
)
1316 : op(op
), projector(NULL
), shadow_comparitor(NULL
), offset(NULL
)
1318 this->ir_type
= ir_type_texture
;
1321 virtual ir_texture
*clone(void *mem_ctx
, struct hash_table
*) const;
1323 virtual ir_constant
*constant_expression_value(struct hash_table
*variable_context
= NULL
);
1325 virtual void accept(ir_visitor
*v
)
1330 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1333 * Return a string representing the ir_texture_opcode.
1335 const char *opcode_string();
1337 /** Set the sampler and type. */
1338 void set_sampler(ir_dereference
*sampler
, const glsl_type
*type
);
1341 * Do a reverse-lookup to translate a string into an ir_texture_opcode.
1343 static ir_texture_opcode
get_opcode(const char *);
1345 enum ir_texture_opcode op
;
1347 /** Sampler to use for the texture access. */
1348 ir_dereference
*sampler
;
1350 /** Texture coordinate to sample */
1351 ir_rvalue
*coordinate
;
1354 * Value used for projective divide.
1356 * If there is no projective divide (the common case), this will be
1357 * \c NULL. Optimization passes should check for this to point to a constant
1358 * of 1.0 and replace that with \c NULL.
1360 ir_rvalue
*projector
;
1363 * Coordinate used for comparison on shadow look-ups.
1365 * If there is no shadow comparison, this will be \c NULL. For the
1366 * \c ir_txf opcode, this *must* be \c NULL.
1368 ir_rvalue
*shadow_comparitor
;
1370 /** Texel offset. */
1374 ir_rvalue
*lod
; /**< Floating point LOD */
1375 ir_rvalue
*bias
; /**< Floating point LOD bias */
1377 ir_rvalue
*dPdx
; /**< Partial derivative of coordinate wrt X */
1378 ir_rvalue
*dPdy
; /**< Partial derivative of coordinate wrt Y */
1384 struct ir_swizzle_mask
{
1391 * Number of components in the swizzle.
1393 unsigned num_components
:3;
1396 * Does the swizzle contain duplicate components?
1398 * L-value swizzles cannot contain duplicate components.
1400 unsigned has_duplicates
:1;
1404 class ir_swizzle
: public ir_rvalue
{
1406 ir_swizzle(ir_rvalue
*, unsigned x
, unsigned y
, unsigned z
, unsigned w
,
1409 ir_swizzle(ir_rvalue
*val
, const unsigned *components
, unsigned count
);
1411 ir_swizzle(ir_rvalue
*val
, ir_swizzle_mask mask
);
1413 virtual ir_swizzle
*clone(void *mem_ctx
, struct hash_table
*) const;
1415 virtual ir_constant
*constant_expression_value(struct hash_table
*variable_context
= NULL
);
1417 virtual ir_swizzle
*as_swizzle()
1423 * Construct an ir_swizzle from the textual representation. Can fail.
1425 static ir_swizzle
*create(ir_rvalue
*, const char *, unsigned vector_length
);
1427 virtual void accept(ir_visitor
*v
)
1432 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1434 bool is_lvalue() const
1436 return val
->is_lvalue() && !mask
.has_duplicates
;
1440 * Get the variable that is ultimately referenced by an r-value
1442 virtual ir_variable
*variable_referenced() const;
1445 ir_swizzle_mask mask
;
1449 * Initialize the mask component of a swizzle
1451 * This is used by the \c ir_swizzle constructors.
1453 void init_mask(const unsigned *components
, unsigned count
);
1457 class ir_dereference
: public ir_rvalue
{
1459 virtual ir_dereference
*clone(void *mem_ctx
, struct hash_table
*) const = 0;
1461 virtual ir_dereference
*as_dereference()
1466 bool is_lvalue() const;
1469 * Get the variable that is ultimately referenced by an r-value
1471 virtual ir_variable
*variable_referenced() const = 0;
1474 * Get the constant that is ultimately referenced by an r-value,
1475 * in a constant expression evaluation context.
1477 * The offset is used when the reference is to a specific column of
1480 virtual void constant_referenced(struct hash_table
*variable_context
, ir_constant
*&store
, int &offset
) const = 0;
1484 class ir_dereference_variable
: public ir_dereference
{
1486 ir_dereference_variable(ir_variable
*var
);
1488 virtual ir_dereference_variable
*clone(void *mem_ctx
,
1489 struct hash_table
*) const;
1491 virtual ir_constant
*constant_expression_value(struct hash_table
*variable_context
= NULL
);
1493 virtual ir_dereference_variable
*as_dereference_variable()
1499 * Get the variable that is ultimately referenced by an r-value
1501 virtual ir_variable
*variable_referenced() const
1507 * Get the constant that is ultimately referenced by an r-value,
1508 * in a constant expression evaluation context.
1510 * The offset is used when the reference is to a specific column of
1513 virtual void constant_referenced(struct hash_table
*variable_context
, ir_constant
*&store
, int &offset
) const;
1515 virtual ir_variable
*whole_variable_referenced()
1517 /* ir_dereference_variable objects always dereference the entire
1518 * variable. However, if this dereference is dereferenced by anything
1519 * else, the complete deferefernce chain is not a whole-variable
1520 * dereference. This method should only be called on the top most
1521 * ir_rvalue in a dereference chain.
1526 virtual void accept(ir_visitor
*v
)
1531 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1534 * Object being dereferenced.
1540 class ir_dereference_array
: public ir_dereference
{
1542 ir_dereference_array(ir_rvalue
*value
, ir_rvalue
*array_index
);
1544 ir_dereference_array(ir_variable
*var
, ir_rvalue
*array_index
);
1546 virtual ir_dereference_array
*clone(void *mem_ctx
,
1547 struct hash_table
*) const;
1549 virtual ir_constant
*constant_expression_value(struct hash_table
*variable_context
= NULL
);
1551 virtual ir_dereference_array
*as_dereference_array()
1557 * Get the variable that is ultimately referenced by an r-value
1559 virtual ir_variable
*variable_referenced() const
1561 return this->array
->variable_referenced();
1565 * Get the constant that is ultimately referenced by an r-value,
1566 * in a constant expression evaluation context.
1568 * The offset is used when the reference is to a specific column of
1571 virtual void constant_referenced(struct hash_table
*variable_context
, ir_constant
*&store
, int &offset
) const;
1573 virtual void accept(ir_visitor
*v
)
1578 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1581 ir_rvalue
*array_index
;
1584 void set_array(ir_rvalue
*value
);
1588 class ir_dereference_record
: public ir_dereference
{
1590 ir_dereference_record(ir_rvalue
*value
, const char *field
);
1592 ir_dereference_record(ir_variable
*var
, const char *field
);
1594 virtual ir_dereference_record
*clone(void *mem_ctx
,
1595 struct hash_table
*) const;
1597 virtual ir_constant
*constant_expression_value(struct hash_table
*variable_context
= NULL
);
1600 * Get the variable that is ultimately referenced by an r-value
1602 virtual ir_variable
*variable_referenced() const
1604 return this->record
->variable_referenced();
1608 * Get the constant that is ultimately referenced by an r-value,
1609 * in a constant expression evaluation context.
1611 * The offset is used when the reference is to a specific column of
1614 virtual void constant_referenced(struct hash_table
*variable_context
, ir_constant
*&store
, int &offset
) const;
1616 virtual void accept(ir_visitor
*v
)
1621 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1629 * Data stored in an ir_constant
1631 union ir_constant_data
{
1639 class ir_constant
: public ir_rvalue
{
1641 ir_constant(const struct glsl_type
*type
, const ir_constant_data
*data
);
1642 ir_constant(bool b
);
1643 ir_constant(unsigned int u
);
1645 ir_constant(float f
);
1648 * Construct an ir_constant from a list of ir_constant values
1650 ir_constant(const struct glsl_type
*type
, exec_list
*values
);
1653 * Construct an ir_constant from a scalar component of another ir_constant
1655 * The new \c ir_constant inherits the type of the component from the
1659 * In the case of a matrix constant, the new constant is a scalar, \b not
1662 ir_constant(const ir_constant
*c
, unsigned i
);
1665 * Return a new ir_constant of the specified type containing all zeros.
1667 static ir_constant
*zero(void *mem_ctx
, const glsl_type
*type
);
1669 virtual ir_constant
*clone(void *mem_ctx
, struct hash_table
*) const;
1671 virtual ir_constant
*constant_expression_value(struct hash_table
*variable_context
= NULL
);
1673 virtual ir_constant
*as_constant()
1678 virtual void accept(ir_visitor
*v
)
1683 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1686 * Get a particular component of a constant as a specific type
1688 * This is useful, for example, to get a value from an integer constant
1689 * as a float or bool. This appears frequently when constructors are
1690 * called with all constant parameters.
1693 bool get_bool_component(unsigned i
) const;
1694 float get_float_component(unsigned i
) const;
1695 int get_int_component(unsigned i
) const;
1696 unsigned get_uint_component(unsigned i
) const;
1699 ir_constant
*get_array_element(unsigned i
) const;
1701 ir_constant
*get_record_field(const char *name
);
1704 * Copy the values on another constant at a given offset.
1706 * The offset is ignored for array or struct copies, it's only for
1707 * scalars or vectors into vectors or matrices.
1709 * With identical types on both sides and zero offset it's clone()
1710 * without creating a new object.
1713 void copy_offset(ir_constant
*src
, int offset
);
1716 * Copy the values on another constant at a given offset and
1717 * following an assign-like mask.
1719 * The mask is ignored for scalars.
1721 * Note that this function only handles what assign can handle,
1722 * i.e. at most a vector as source and a column of a matrix as
1726 void copy_masked_offset(ir_constant
*src
, int offset
, unsigned int mask
);
1729 * Determine whether a constant has the same value as another constant
1731 * \sa ir_constant::is_zero, ir_constant::is_one,
1732 * ir_constant::is_negative_one
1734 bool has_value(const ir_constant
*) const;
1736 virtual bool is_zero() const;
1737 virtual bool is_one() const;
1738 virtual bool is_negative_one() const;
1741 * Value of the constant.
1743 * The field used to back the values supplied by the constant is determined
1744 * by the type associated with the \c ir_instruction. Constants may be
1745 * scalars, vectors, or matrices.
1747 union ir_constant_data value
;
1749 /* Array elements */
1750 ir_constant
**array_elements
;
1752 /* Structure fields */
1753 exec_list components
;
1757 * Parameterless constructor only used by the clone method
1765 * Apply a visitor to each IR node in a list
1768 visit_exec_list(exec_list
*list
, ir_visitor
*visitor
);
1771 * Validate invariants on each IR node in a list
1773 void validate_ir_tree(exec_list
*instructions
);
1775 struct _mesa_glsl_parse_state
;
1776 struct gl_shader_program
;
1779 * Detect whether an unlinked shader contains static recursion
1781 * If the list of instructions is determined to contain static recursion,
1782 * \c _mesa_glsl_error will be called to emit error messages for each function
1783 * that is in the recursion cycle.
1786 detect_recursion_unlinked(struct _mesa_glsl_parse_state
*state
,
1787 exec_list
*instructions
);
1790 * Detect whether a linked shader contains static recursion
1792 * If the list of instructions is determined to contain static recursion,
1793 * \c link_error_printf will be called to emit error messages for each function
1794 * that is in the recursion cycle. In addition,
1795 * \c gl_shader_program::LinkStatus will be set to false.
1798 detect_recursion_linked(struct gl_shader_program
*prog
,
1799 exec_list
*instructions
);
1802 * Make a clone of each IR instruction in a list
1804 * \param in List of IR instructions that are to be cloned
1805 * \param out List to hold the cloned instructions
1808 clone_ir_list(void *mem_ctx
, exec_list
*out
, const exec_list
*in
);
1811 _mesa_glsl_initialize_variables(exec_list
*instructions
,
1812 struct _mesa_glsl_parse_state
*state
);
1815 _mesa_glsl_initialize_functions(_mesa_glsl_parse_state
*state
);
1818 _mesa_glsl_release_functions(void);
1821 reparent_ir(exec_list
*list
, void *mem_ctx
);
1823 struct glsl_symbol_table
;
1826 import_prototypes(const exec_list
*source
, exec_list
*dest
,
1827 struct glsl_symbol_table
*symbols
, void *mem_ctx
);
1830 ir_has_call(ir_instruction
*ir
);
1833 do_set_program_inouts(exec_list
*instructions
, struct gl_program
*prog
,
1834 bool is_fragment_shader
);
1837 prototype_string(const glsl_type
*return_type
, const char *name
,
1838 exec_list
*parameters
);