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
;
93 * GCC 4.7+ and clang warn when deleting an ir_instruction unless
94 * there's a virtual destructor present. Because we almost
95 * universally use ralloc for our memory management of
96 * ir_instructions, the destructor doesn't need to do any work.
98 virtual ~ir_instruction()
102 /** ir_print_visitor helper for debugging. */
103 void print(void) const;
105 virtual void accept(ir_visitor
*) = 0;
106 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*) = 0;
107 virtual ir_instruction
*clone(void *mem_ctx
,
108 struct hash_table
*ht
) const = 0;
111 * \name IR instruction downcast functions
113 * These functions either cast the object to a derived class or return
114 * \c NULL if the object's type does not match the specified derived class.
115 * Additional downcast functions will be added as needed.
118 virtual class ir_variable
* as_variable() { return NULL
; }
119 virtual class ir_function
* as_function() { return NULL
; }
120 virtual class ir_dereference
* as_dereference() { return NULL
; }
121 virtual class ir_dereference_array
* as_dereference_array() { return NULL
; }
122 virtual class ir_dereference_variable
*as_dereference_variable() { return NULL
; }
123 virtual class ir_dereference_record
*as_dereference_record() { return NULL
; }
124 virtual class ir_expression
* as_expression() { return NULL
; }
125 virtual class ir_rvalue
* as_rvalue() { return NULL
; }
126 virtual class ir_loop
* as_loop() { return NULL
; }
127 virtual class ir_assignment
* as_assignment() { return NULL
; }
128 virtual class ir_call
* as_call() { return NULL
; }
129 virtual class ir_return
* as_return() { return NULL
; }
130 virtual class ir_if
* as_if() { return NULL
; }
131 virtual class ir_swizzle
* as_swizzle() { return NULL
; }
132 virtual class ir_constant
* as_constant() { return NULL
; }
133 virtual class ir_discard
* as_discard() { return NULL
; }
134 virtual class ir_jump
* as_jump() { return NULL
; }
140 ir_type
= ir_type_unset
;
146 * The base class for all "values"/expression trees.
148 class ir_rvalue
: public ir_instruction
{
150 const struct glsl_type
*type
;
152 virtual ir_rvalue
*clone(void *mem_ctx
, struct hash_table
*) const;
154 virtual void accept(ir_visitor
*v
)
159 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
161 virtual ir_constant
*constant_expression_value(struct hash_table
*variable_context
= NULL
);
163 virtual ir_rvalue
* as_rvalue()
168 ir_rvalue
*as_rvalue_to_saturate();
170 virtual bool is_lvalue() const
176 * Get the variable that is ultimately referenced by an r-value
178 virtual ir_variable
*variable_referenced() const
185 * If an r-value is a reference to a whole variable, get that variable
188 * Pointer to a variable that is completely dereferenced by the r-value. If
189 * the r-value is not a dereference or the dereference does not access the
190 * entire variable (i.e., it's just one array element, struct field), \c NULL
193 virtual ir_variable
*whole_variable_referenced()
199 * Determine if an r-value has the value zero
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 * zero (or \c false for booleans).
206 * \sa ir_constant::has_value, ir_rvalue::is_one, ir_rvalue::is_negative_one,
207 * ir_constant::is_basis
209 virtual bool is_zero() const;
212 * Determine if an r-value has the value one
214 * The base implementation of this function always returns \c false. The
215 * \c ir_constant class over-rides this function to return \c true \b only
216 * for vector and scalar types that have all elements set to the value
217 * one (or \c true for booleans).
219 * \sa ir_constant::has_value, ir_rvalue::is_zero, ir_rvalue::is_negative_one,
220 * ir_constant::is_basis
222 virtual bool is_one() const;
225 * Determine if an r-value has the value negative one
227 * The base implementation of this function always returns \c false. The
228 * \c ir_constant class over-rides this function to return \c true \b only
229 * for vector and scalar types that have all elements set to the value
230 * negative one. For boolean types, the result is always \c false.
232 * \sa ir_constant::has_value, ir_rvalue::is_zero, ir_rvalue::is_one
233 * ir_constant::is_basis
235 virtual bool is_negative_one() const;
238 * Determine if an r-value is a basis vector
240 * The base implementation of this function always returns \c false. The
241 * \c ir_constant class over-rides this function to return \c true \b only
242 * for vector and scalar types that have one element set to the value one,
243 * and the other elements set to the value zero. For boolean types, the
244 * result is always \c false.
246 * \sa ir_constant::has_value, ir_rvalue::is_zero, ir_rvalue::is_one,
247 * is_constant::is_negative_one
249 virtual bool is_basis() const;
253 * Return a generic value of error_type.
255 * Allocation will be performed with 'mem_ctx' as ralloc owner.
257 static ir_rvalue
*error_value(void *mem_ctx
);
265 * Variable storage classes
267 enum ir_variable_mode
{
268 ir_var_auto
= 0, /**< Function local variables and globals. */
269 ir_var_uniform
, /**< Variable declared as a uniform. */
274 ir_var_function_inout
,
275 ir_var_const_in
, /**< "in" param that must be a constant expression */
276 ir_var_system_value
, /**< Ex: front-face, instance-id, etc. */
277 ir_var_temporary
, /**< Temporary variable generated during compilation. */
278 ir_var_mode_count
/**< Number of variable modes */
282 * \brief Layout qualifiers for gl_FragDepth.
284 * The AMD/ARB_conservative_depth extensions allow gl_FragDepth to be redeclared
285 * with a layout qualifier.
287 enum ir_depth_layout
{
288 ir_depth_layout_none
, /**< No depth layout is specified. */
290 ir_depth_layout_greater
,
291 ir_depth_layout_less
,
292 ir_depth_layout_unchanged
296 * \brief Convert depth layout qualifier to string.
299 depth_layout_string(ir_depth_layout layout
);
302 * Description of built-in state associated with a uniform
304 * \sa ir_variable::state_slots
306 struct ir_state_slot
{
311 class ir_variable
: public ir_instruction
{
313 ir_variable(const struct glsl_type
*, const char *, ir_variable_mode
);
315 virtual ir_variable
*clone(void *mem_ctx
, struct hash_table
*ht
) const;
317 virtual ir_variable
*as_variable()
322 virtual void accept(ir_visitor
*v
)
327 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
331 * Get the string value for the interpolation qualifier
333 * \return The string that would be used in a shader to specify \c
334 * mode will be returned.
336 * This function is used to generate error messages of the form "shader
337 * uses %s interpolation qualifier", so in the case where there is no
338 * interpolation qualifier, it returns "no".
340 * This function should only be used on a shader input or output variable.
342 const char *interpolation_string() const;
345 * Determine how this variable should be interpolated based on its
346 * interpolation qualifier (if present), whether it is gl_Color or
347 * gl_SecondaryColor, and whether flatshading is enabled in the current GL
350 * The return value will always be either INTERP_QUALIFIER_SMOOTH,
351 * INTERP_QUALIFIER_NOPERSPECTIVE, or INTERP_QUALIFIER_FLAT.
353 glsl_interp_qualifier
determine_interpolation_mode(bool flat_shade
);
356 * Determine whether or not a variable is part of a uniform block.
358 inline bool is_in_uniform_block() const
360 return this->mode
== ir_var_uniform
&& this->interface_type
!= NULL
;
364 * Determine whether or not a variable is the declaration of an interface
367 * For the first declaration below, there will be an \c ir_variable named
368 * "instance" whose type and whose instance_type will be the same
369 * \cglsl_type. For the second declaration, there will be an \c ir_variable
370 * named "f" whose type is float and whose instance_type is B2.
372 * "instance" is an interface instance variable, but "f" is not.
382 inline bool is_interface_instance() const
384 const glsl_type
*const t
= this->type
;
386 return (t
== this->interface_type
)
387 || (t
->is_array() && t
->fields
.array
== this->interface_type
);
391 * Declared type of the variable
393 const struct glsl_type
*type
;
396 * Declared name of the variable
401 * Highest element accessed with a constant expression array index
403 * Not used for non-array variables.
405 unsigned max_array_access
;
408 * Is the variable read-only?
410 * This is set for variables declared as \c const, shader inputs,
413 unsigned read_only
:1;
415 unsigned invariant
:1;
418 * Has this variable been used for reading or writing?
420 * Several GLSL semantic checks require knowledge of whether or not a
421 * variable has been used. For example, it is an error to redeclare a
422 * variable as invariant after it has been used.
424 * This is only maintained in the ast_to_hir.cpp path, not in
425 * Mesa's fixed function or ARB program paths.
430 * Has this variable been statically assigned?
432 * This answers whether the variable was assigned in any path of
433 * the shader during ast_to_hir. This doesn't answer whether it is
434 * still written after dead code removal, nor is it maintained in
435 * non-ast_to_hir.cpp (GLSL parsing) paths.
440 * Storage class of the variable.
442 * \sa ir_variable_mode
447 * Interpolation mode for shader inputs / outputs
449 * \sa ir_variable_interpolation
451 unsigned interpolation
:2;
454 * \name ARB_fragment_coord_conventions
457 unsigned origin_upper_left
:1;
458 unsigned pixel_center_integer
:1;
462 * Was the location explicitly set in the shader?
464 * If the location is explicitly set in the shader, it \b cannot be changed
465 * by the linker or by the API (e.g., calls to \c glBindAttribLocation have
468 unsigned explicit_location
:1;
469 unsigned explicit_index
:1;
472 * Does this variable have an initializer?
474 * This is used by the linker to cross-validiate initializers of global
477 unsigned has_initializer
:1;
480 * Is this variable a generic output or input that has not yet been matched
481 * up to a variable in another stage of the pipeline?
483 * This is used by the linker as scratch storage while assigning locations
484 * to generic inputs and outputs.
486 unsigned is_unmatched_generic_inout
:1;
489 * If non-zero, then this variable may be packed along with other variables
490 * into a single varying slot, so this offset should be applied when
491 * accessing components. For example, an offset of 1 means that the x
492 * component of this variable is actually stored in component y of the
493 * location specified by \c location.
495 unsigned location_frac
:2;
498 * \brief Layout qualifier for gl_FragDepth.
500 * This is not equal to \c ir_depth_layout_none if and only if this
501 * variable is \c gl_FragDepth and a layout qualifier is specified.
503 ir_depth_layout depth_layout
;
506 * Storage location of the base of this variable
508 * The precise meaning of this field depends on the nature of the variable.
510 * - Vertex shader input: one of the values from \c gl_vert_attrib.
511 * - Vertex shader output: one of the values from \c gl_varying_slot.
512 * - Fragment shader input: one of the values from \c gl_varying_slot.
513 * - Fragment shader output: one of the values from \c gl_frag_result.
514 * - Uniforms: Per-stage uniform slot number for default uniform block.
515 * - Uniforms: Index within the uniform block definition for UBO members.
516 * - Other: This field is not currently used.
518 * If the variable is a uniform, shader input, or shader output, and the
519 * slot has not been assigned, the value will be -1.
524 * output index for dual source blending.
529 * Built-in state that backs this uniform
531 * Once set at variable creation, \c state_slots must remain invariant.
532 * This is because, ideally, this array would be shared by all clones of
533 * this variable in the IR tree. In other words, we'd really like for it
534 * to be a fly-weight.
536 * If the variable is not a uniform, \c num_state_slots will be zero and
537 * \c state_slots will be \c NULL.
540 unsigned num_state_slots
; /**< Number of state slots used */
541 ir_state_slot
*state_slots
; /**< State descriptors. */
545 * Emit a warning if this variable is accessed.
547 const char *warn_extension
;
550 * Value assigned in the initializer of a variable declared "const"
552 ir_constant
*constant_value
;
555 * Constant expression assigned in the initializer of the variable
558 * This field and \c ::constant_value are distinct. Even if the two fields
559 * refer to constants with the same value, they must point to separate
562 ir_constant
*constant_initializer
;
565 * For variables that are in an interface block or are an instance of an
566 * interface block, this is the \c GLSL_TYPE_INTERFACE type for that block.
568 * \sa ir_variable::location
570 const glsl_type
*interface_type
;
576 * The representation of a function instance; may be the full definition or
577 * simply a prototype.
579 class ir_function_signature
: public ir_instruction
{
580 /* An ir_function_signature will be part of the list of signatures in
584 ir_function_signature(const glsl_type
*return_type
);
586 virtual ir_function_signature
*clone(void *mem_ctx
,
587 struct hash_table
*ht
) const;
588 ir_function_signature
*clone_prototype(void *mem_ctx
,
589 struct hash_table
*ht
) const;
591 virtual void accept(ir_visitor
*v
)
596 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
599 * Attempt to evaluate this function as a constant expression,
600 * given a list of the actual parameters and the variable context.
601 * Returns NULL for non-built-ins.
603 ir_constant
*constant_expression_value(exec_list
*actual_parameters
, struct hash_table
*variable_context
);
606 * Get the name of the function for which this is a signature
608 const char *function_name() const;
611 * Get a handle to the function for which this is a signature
613 * There is no setter function, this function returns a \c const pointer,
614 * and \c ir_function_signature::_function is private for a reason. The
615 * only way to make a connection between a function and function signature
616 * is via \c ir_function::add_signature. This helps ensure that certain
617 * invariants (i.e., a function signature is in the list of signatures for
618 * its \c _function) are met.
620 * \sa ir_function::add_signature
622 inline const class ir_function
*function() const
624 return this->_function
;
628 * Check whether the qualifiers match between this signature's parameters
629 * and the supplied parameter list. If not, returns the name of the first
630 * parameter with mismatched qualifiers (for use in error messages).
632 const char *qualifiers_match(exec_list
*params
);
635 * Replace the current parameter list with the given one. This is useful
636 * if the current information came from a prototype, and either has invalid
637 * or missing parameter names.
639 void replace_parameters(exec_list
*new_params
);
642 * Function return type.
644 * \note This discards the optional precision qualifier.
646 const struct glsl_type
*return_type
;
649 * List of ir_variable of function parameters.
651 * This represents the storage. The paramaters passed in a particular
652 * call will be in ir_call::actual_paramaters.
654 struct exec_list parameters
;
656 /** Whether or not this function has a body (which may be empty). */
657 unsigned is_defined
:1;
659 /** Whether or not this function signature is a built-in. */
660 unsigned is_builtin
:1;
662 /** Body of instructions in the function. */
663 struct exec_list body
;
666 /** Function of which this signature is one overload. */
667 class ir_function
*_function
;
669 /** Function signature of which this one is a prototype clone */
670 const ir_function_signature
*origin
;
672 friend class ir_function
;
675 * Helper function to run a list of instructions for constant
676 * expression evaluation.
678 * The hash table represents the values of the visible variables.
679 * There are no scoping issues because the table is indexed on
680 * ir_variable pointers, not variable names.
682 * Returns false if the expression is not constant, true otherwise,
683 * and the value in *result if result is non-NULL.
685 bool constant_expression_evaluate_expression_list(const struct exec_list
&body
,
686 struct hash_table
*variable_context
,
687 ir_constant
**result
);
692 * Header for tracking multiple overloaded functions with the same name.
693 * Contains a list of ir_function_signatures representing each of the
696 class ir_function
: public ir_instruction
{
698 ir_function(const char *name
);
700 virtual ir_function
*clone(void *mem_ctx
, struct hash_table
*ht
) const;
702 virtual ir_function
*as_function()
707 virtual void accept(ir_visitor
*v
)
712 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
714 void add_signature(ir_function_signature
*sig
)
716 sig
->_function
= this;
717 this->signatures
.push_tail(sig
);
721 * Get an iterator for the set of function signatures
723 exec_list_iterator
iterator()
725 return signatures
.iterator();
729 * Find a signature that matches a set of actual parameters, taking implicit
730 * conversions into account. Also flags whether the match was exact.
732 ir_function_signature
*matching_signature(const exec_list
*actual_param
,
733 bool *match_is_exact
);
736 * Find a signature that matches a set of actual parameters, taking implicit
737 * conversions into account.
739 ir_function_signature
*matching_signature(const exec_list
*actual_param
);
742 * Find a signature that exactly matches a set of actual parameters without
743 * any implicit type conversions.
745 ir_function_signature
*exact_matching_signature(const exec_list
*actual_ps
);
748 * Name of the function.
752 /** Whether or not this function has a signature that isn't a built-in. */
753 bool has_user_signature();
756 * List of ir_function_signature for each overloaded function with this name.
758 struct exec_list signatures
;
761 inline const char *ir_function_signature::function_name() const
763 return this->_function
->name
;
769 * IR instruction representing high-level if-statements
771 class ir_if
: public ir_instruction
{
773 ir_if(ir_rvalue
*condition
)
774 : condition(condition
)
776 ir_type
= ir_type_if
;
779 virtual ir_if
*clone(void *mem_ctx
, struct hash_table
*ht
) const;
781 virtual ir_if
*as_if()
786 virtual void accept(ir_visitor
*v
)
791 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
793 ir_rvalue
*condition
;
794 /** List of ir_instruction for the body of the then branch */
795 exec_list then_instructions
;
796 /** List of ir_instruction for the body of the else branch */
797 exec_list else_instructions
;
802 * IR instruction representing a high-level loop structure.
804 class ir_loop
: public ir_instruction
{
808 virtual ir_loop
*clone(void *mem_ctx
, struct hash_table
*ht
) const;
810 virtual void accept(ir_visitor
*v
)
815 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
817 virtual ir_loop
*as_loop()
823 * Get an iterator for the instructions of the loop body
825 exec_list_iterator
iterator()
827 return body_instructions
.iterator();
830 /** List of ir_instruction that make up the body of the loop. */
831 exec_list body_instructions
;
834 * \name Loop counter and controls
836 * Represents a loop like a FORTRAN \c do-loop.
839 * If \c from and \c to are the same value, the loop will execute once.
842 ir_rvalue
*from
; /** Value of the loop counter on the first
843 * iteration of the loop.
845 ir_rvalue
*to
; /** Value of the loop counter on the last
846 * iteration of the loop.
848 ir_rvalue
*increment
;
849 ir_variable
*counter
;
852 * Comparison operation in the loop terminator.
854 * If any of the loop control fields are non-\c NULL, this field must be
855 * one of \c ir_binop_less, \c ir_binop_greater, \c ir_binop_lequal,
856 * \c ir_binop_gequal, \c ir_binop_equal, or \c ir_binop_nequal.
863 class ir_assignment
: public ir_instruction
{
865 ir_assignment(ir_rvalue
*lhs
, ir_rvalue
*rhs
, ir_rvalue
*condition
= NULL
);
868 * Construct an assignment with an explicit write mask
871 * Since a write mask is supplied, the LHS must already be a bare
872 * \c ir_dereference. The cannot be any swizzles in the LHS.
874 ir_assignment(ir_dereference
*lhs
, ir_rvalue
*rhs
, ir_rvalue
*condition
,
875 unsigned write_mask
);
877 virtual ir_assignment
*clone(void *mem_ctx
, struct hash_table
*ht
) const;
879 virtual ir_constant
*constant_expression_value(struct hash_table
*variable_context
= NULL
);
881 virtual void accept(ir_visitor
*v
)
886 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
888 virtual ir_assignment
* as_assignment()
894 * Get a whole variable written by an assignment
896 * If the LHS of the assignment writes a whole variable, the variable is
897 * returned. Otherwise \c NULL is returned. Examples of whole-variable
900 * - Assigning to a scalar
901 * - Assigning to all components of a vector
902 * - Whole array (or matrix) assignment
903 * - Whole structure assignment
905 ir_variable
*whole_variable_written();
908 * Set the LHS of an assignment
910 void set_lhs(ir_rvalue
*lhs
);
913 * Left-hand side of the assignment.
915 * This should be treated as read only. If you need to set the LHS of an
916 * assignment, use \c ir_assignment::set_lhs.
921 * Value being assigned
926 * Optional condition for the assignment.
928 ir_rvalue
*condition
;
932 * Component mask written
934 * For non-vector types in the LHS, this field will be zero. For vector
935 * types, a bit will be set for each component that is written. Note that
936 * for \c vec2 and \c vec3 types only the lower bits will ever be set.
938 * A partially-set write mask means that each enabled channel gets
939 * the value from a consecutive channel of the rhs. For example,
940 * to write just .xyw of gl_FrontColor with color:
942 * (assign (constant bool (1)) (xyw)
943 * (var_ref gl_FragColor)
944 * (swiz xyw (var_ref color)))
946 unsigned write_mask
:4;
949 /* Update ir_expression::get_num_operands() and operator_strs when
950 * updating this list.
952 enum ir_expression_operation
{
961 ir_unop_exp
, /**< Log base e on gentype */
962 ir_unop_log
, /**< Natural log on gentype */
965 ir_unop_f2i
, /**< Float-to-integer conversion. */
966 ir_unop_f2u
, /**< Float-to-unsigned conversion. */
967 ir_unop_i2f
, /**< Integer-to-float conversion. */
968 ir_unop_f2b
, /**< Float-to-boolean conversion */
969 ir_unop_b2f
, /**< Boolean-to-float conversion */
970 ir_unop_i2b
, /**< int-to-boolean conversion */
971 ir_unop_b2i
, /**< Boolean-to-int conversion */
972 ir_unop_u2f
, /**< Unsigned-to-float conversion. */
973 ir_unop_i2u
, /**< Integer-to-unsigned conversion. */
974 ir_unop_u2i
, /**< Unsigned-to-integer conversion. */
975 ir_unop_bitcast_i2f
, /**< Bit-identical int-to-float "conversion" */
976 ir_unop_bitcast_f2i
, /**< Bit-identical float-to-int "conversion" */
977 ir_unop_bitcast_u2f
, /**< Bit-identical uint-to-float "conversion" */
978 ir_unop_bitcast_f2u
, /**< Bit-identical float-to-uint "conversion" */
982 * \name Unary floating-point rounding operations.
993 * \name Trigonometric operations.
998 ir_unop_sin_reduced
, /**< Reduced range sin. [-pi, pi] */
999 ir_unop_cos_reduced
, /**< Reduced range cos. [-pi, pi] */
1003 * \name Partial derivatives.
1011 * \name Floating point pack and unpack operations.
1014 ir_unop_pack_snorm_2x16
,
1015 ir_unop_pack_snorm_4x8
,
1016 ir_unop_pack_unorm_2x16
,
1017 ir_unop_pack_unorm_4x8
,
1018 ir_unop_pack_half_2x16
,
1019 ir_unop_unpack_snorm_2x16
,
1020 ir_unop_unpack_snorm_4x8
,
1021 ir_unop_unpack_unorm_2x16
,
1022 ir_unop_unpack_unorm_4x8
,
1023 ir_unop_unpack_half_2x16
,
1027 * \name Lowered floating point unpacking operations.
1029 * \see lower_packing_builtins_visitor::split_unpack_half_2x16
1032 ir_unop_unpack_half_2x16_split_x
,
1033 ir_unop_unpack_half_2x16_split_y
,
1037 * \name Bit operations, part of ARB_gpu_shader5.
1040 ir_unop_bitfield_reverse
,
1049 * A sentinel marking the last of the unary operations.
1051 ir_last_unop
= ir_unop_noise
,
1059 * Takes one of two combinations of arguments:
1062 * - mod(vecN, float)
1064 * Does not take integer types.
1069 * \name Binary comparison operators which return a boolean vector.
1070 * The type of both operands must be equal.
1080 * Returns single boolean for whether all components of operands[0]
1081 * equal the components of operands[1].
1085 * Returns single boolean for whether any component of operands[0]
1086 * is not equal to the corresponding component of operands[1].
1088 ir_binop_any_nequal
,
1092 * \name Bit-wise binary operations.
1113 * \name Lowered floating point packing operations.
1115 * \see lower_packing_builtins_visitor::split_pack_half_2x16
1118 ir_binop_pack_half_2x16_split
,
1122 * \name First half of a lowered bitfieldInsert() operation.
1124 * \see lower_instructions::bitfield_insert_to_bfm_bfi
1131 * Load a value the size of a given GLSL type from a uniform block.
1133 * operand0 is the ir_constant uniform block index in the linked shader.
1134 * operand1 is a byte offset within the uniform block.
1139 * Extract a scalar from a vector
1141 * operand0 is the vector
1142 * operand1 is the index of the field to read from operand0
1144 ir_binop_vector_extract
,
1147 * A sentinel marking the last of the binary operations.
1149 ir_last_binop
= ir_binop_vector_extract
,
1154 * \name Second half of a lowered bitfieldInsert() operation.
1156 * \see lower_instructions::bitfield_insert_to_bfm_bfi
1162 ir_triop_bitfield_extract
,
1165 * Generate a value with one field of a vector changed
1167 * operand0 is the vector
1168 * operand1 is the value to write into the vector result
1169 * operand2 is the index in operand0 to be modified
1171 ir_triop_vector_insert
,
1174 * A sentinel marking the last of the ternary operations.
1176 ir_last_triop
= ir_triop_vector_insert
,
1178 ir_quadop_bitfield_insert
,
1183 * A sentinel marking the last of the ternary operations.
1185 ir_last_quadop
= ir_quadop_vector
,
1188 * A sentinel marking the last of all operations.
1190 ir_last_opcode
= ir_quadop_vector
1193 class ir_expression
: public ir_rvalue
{
1195 ir_expression(int op
, const struct glsl_type
*type
,
1196 ir_rvalue
*op0
, ir_rvalue
*op1
= NULL
,
1197 ir_rvalue
*op2
= NULL
, ir_rvalue
*op3
= NULL
);
1200 * Constructor for unary operation expressions
1202 ir_expression(int op
, ir_rvalue
*);
1205 * Constructor for binary operation expressions
1207 ir_expression(int op
, ir_rvalue
*op0
, ir_rvalue
*op1
);
1209 virtual ir_expression
*as_expression()
1214 virtual ir_expression
*clone(void *mem_ctx
, struct hash_table
*ht
) const;
1217 * Attempt to constant-fold the expression
1219 * The "variable_context" hash table links ir_variable * to ir_constant *
1220 * that represent the variables' values. \c NULL represents an empty
1223 * If the expression cannot be constant folded, this method will return
1226 virtual ir_constant
*constant_expression_value(struct hash_table
*variable_context
= NULL
);
1229 * Determine the number of operands used by an expression
1231 static unsigned int get_num_operands(ir_expression_operation
);
1234 * Determine the number of operands used by an expression
1236 unsigned int get_num_operands() const
1238 return (this->operation
== ir_quadop_vector
)
1239 ? this->type
->vector_elements
: get_num_operands(operation
);
1243 * Return a string representing this expression's operator.
1245 const char *operator_string();
1248 * Return a string representing this expression's operator.
1250 static const char *operator_string(ir_expression_operation
);
1254 * Do a reverse-lookup to translate the given string into an operator.
1256 static ir_expression_operation
get_operator(const char *);
1258 virtual void accept(ir_visitor
*v
)
1263 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1265 ir_expression_operation operation
;
1266 ir_rvalue
*operands
[4];
1271 * HIR instruction representing a high-level function call, containing a list
1272 * of parameters and returning a value in the supplied temporary.
1274 class ir_call
: public ir_instruction
{
1276 ir_call(ir_function_signature
*callee
,
1277 ir_dereference_variable
*return_deref
,
1278 exec_list
*actual_parameters
)
1279 : return_deref(return_deref
), callee(callee
)
1281 ir_type
= ir_type_call
;
1282 assert(callee
->return_type
!= NULL
);
1283 actual_parameters
->move_nodes_to(& this->actual_parameters
);
1284 this->use_builtin
= callee
->is_builtin
;
1287 virtual ir_call
*clone(void *mem_ctx
, struct hash_table
*ht
) const;
1289 virtual ir_constant
*constant_expression_value(struct hash_table
*variable_context
= NULL
);
1291 virtual ir_call
*as_call()
1296 virtual void accept(ir_visitor
*v
)
1301 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1304 * Get an iterator for the set of acutal parameters
1306 exec_list_iterator
iterator()
1308 return actual_parameters
.iterator();
1312 * Get the name of the function being called.
1314 const char *callee_name() const
1316 return callee
->function_name();
1320 * Generates an inline version of the function before @ir,
1321 * storing the return value in return_deref.
1323 void generate_inline(ir_instruction
*ir
);
1326 * Storage for the function's return value.
1327 * This must be NULL if the return type is void.
1329 ir_dereference_variable
*return_deref
;
1332 * The specific function signature being called.
1334 ir_function_signature
*callee
;
1336 /* List of ir_rvalue of paramaters passed in this call. */
1337 exec_list actual_parameters
;
1339 /** Should this call only bind to a built-in function? */
1345 * \name Jump-like IR instructions.
1347 * These include \c break, \c continue, \c return, and \c discard.
1350 class ir_jump
: public ir_instruction
{
1354 ir_type
= ir_type_unset
;
1358 virtual ir_jump
*as_jump()
1364 class ir_return
: public ir_jump
{
1369 this->ir_type
= ir_type_return
;
1372 ir_return(ir_rvalue
*value
)
1375 this->ir_type
= ir_type_return
;
1378 virtual ir_return
*clone(void *mem_ctx
, struct hash_table
*) const;
1380 virtual ir_return
*as_return()
1385 ir_rvalue
*get_value() const
1390 virtual void accept(ir_visitor
*v
)
1395 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1402 * Jump instructions used inside loops
1404 * These include \c break and \c continue. The \c break within a loop is
1405 * different from the \c break within a switch-statement.
1407 * \sa ir_switch_jump
1409 class ir_loop_jump
: public ir_jump
{
1416 ir_loop_jump(jump_mode mode
)
1418 this->ir_type
= ir_type_loop_jump
;
1422 virtual ir_loop_jump
*clone(void *mem_ctx
, struct hash_table
*) const;
1424 virtual void accept(ir_visitor
*v
)
1429 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1431 bool is_break() const
1433 return mode
== jump_break
;
1436 bool is_continue() const
1438 return mode
== jump_continue
;
1441 /** Mode selector for the jump instruction. */
1442 enum jump_mode mode
;
1446 * IR instruction representing discard statements.
1448 class ir_discard
: public ir_jump
{
1452 this->ir_type
= ir_type_discard
;
1453 this->condition
= NULL
;
1456 ir_discard(ir_rvalue
*cond
)
1458 this->ir_type
= ir_type_discard
;
1459 this->condition
= cond
;
1462 virtual ir_discard
*clone(void *mem_ctx
, struct hash_table
*ht
) const;
1464 virtual void accept(ir_visitor
*v
)
1469 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1471 virtual ir_discard
*as_discard()
1476 ir_rvalue
*condition
;
1482 * Texture sampling opcodes used in ir_texture
1484 enum ir_texture_opcode
{
1485 ir_tex
, /**< Regular texture look-up */
1486 ir_txb
, /**< Texture look-up with LOD bias */
1487 ir_txl
, /**< Texture look-up with explicit LOD */
1488 ir_txd
, /**< Texture look-up with partial derivatvies */
1489 ir_txf
, /**< Texel fetch with explicit LOD */
1490 ir_txf_ms
, /**< Multisample texture fetch */
1491 ir_txs
, /**< Texture size */
1492 ir_lod
/**< Texture lod query */
1497 * IR instruction to sample a texture
1499 * The specific form of the IR instruction depends on the \c mode value
1500 * selected from \c ir_texture_opcodes. In the printed IR, these will
1503 * Texel offset (0 or an expression)
1504 * | Projection divisor
1505 * | | Shadow comparitor
1508 * (tex <type> <sampler> <coordinate> 0 1 ( ))
1509 * (txb <type> <sampler> <coordinate> 0 1 ( ) <bias>)
1510 * (txl <type> <sampler> <coordinate> 0 1 ( ) <lod>)
1511 * (txd <type> <sampler> <coordinate> 0 1 ( ) (dPdx dPdy))
1512 * (txf <type> <sampler> <coordinate> 0 <lod>)
1514 * <type> <sampler> <coordinate> <sample_index>)
1515 * (txs <type> <sampler> <lod>)
1516 * (lod <type> <sampler> <coordinate>)
1518 class ir_texture
: public ir_rvalue
{
1520 ir_texture(enum ir_texture_opcode op
)
1521 : op(op
), sampler(NULL
), coordinate(NULL
), projector(NULL
),
1522 shadow_comparitor(NULL
), offset(NULL
)
1524 this->ir_type
= ir_type_texture
;
1527 virtual ir_texture
*clone(void *mem_ctx
, struct hash_table
*) const;
1529 virtual ir_constant
*constant_expression_value(struct hash_table
*variable_context
= NULL
);
1531 virtual void accept(ir_visitor
*v
)
1536 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1539 * Return a string representing the ir_texture_opcode.
1541 const char *opcode_string();
1543 /** Set the sampler and type. */
1544 void set_sampler(ir_dereference
*sampler
, const glsl_type
*type
);
1547 * Do a reverse-lookup to translate a string into an ir_texture_opcode.
1549 static ir_texture_opcode
get_opcode(const char *);
1551 enum ir_texture_opcode op
;
1553 /** Sampler to use for the texture access. */
1554 ir_dereference
*sampler
;
1556 /** Texture coordinate to sample */
1557 ir_rvalue
*coordinate
;
1560 * Value used for projective divide.
1562 * If there is no projective divide (the common case), this will be
1563 * \c NULL. Optimization passes should check for this to point to a constant
1564 * of 1.0 and replace that with \c NULL.
1566 ir_rvalue
*projector
;
1569 * Coordinate used for comparison on shadow look-ups.
1571 * If there is no shadow comparison, this will be \c NULL. For the
1572 * \c ir_txf opcode, this *must* be \c NULL.
1574 ir_rvalue
*shadow_comparitor
;
1576 /** Texel offset. */
1580 ir_rvalue
*lod
; /**< Floating point LOD */
1581 ir_rvalue
*bias
; /**< Floating point LOD bias */
1582 ir_rvalue
*sample_index
; /**< MSAA sample index */
1584 ir_rvalue
*dPdx
; /**< Partial derivative of coordinate wrt X */
1585 ir_rvalue
*dPdy
; /**< Partial derivative of coordinate wrt Y */
1591 struct ir_swizzle_mask
{
1598 * Number of components in the swizzle.
1600 unsigned num_components
:3;
1603 * Does the swizzle contain duplicate components?
1605 * L-value swizzles cannot contain duplicate components.
1607 unsigned has_duplicates
:1;
1611 class ir_swizzle
: public ir_rvalue
{
1613 ir_swizzle(ir_rvalue
*, unsigned x
, unsigned y
, unsigned z
, unsigned w
,
1616 ir_swizzle(ir_rvalue
*val
, const unsigned *components
, unsigned count
);
1618 ir_swizzle(ir_rvalue
*val
, ir_swizzle_mask mask
);
1620 virtual ir_swizzle
*clone(void *mem_ctx
, struct hash_table
*) const;
1622 virtual ir_constant
*constant_expression_value(struct hash_table
*variable_context
= NULL
);
1624 virtual ir_swizzle
*as_swizzle()
1630 * Construct an ir_swizzle from the textual representation. Can fail.
1632 static ir_swizzle
*create(ir_rvalue
*, const char *, unsigned vector_length
);
1634 virtual void accept(ir_visitor
*v
)
1639 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1641 bool is_lvalue() const
1643 return val
->is_lvalue() && !mask
.has_duplicates
;
1647 * Get the variable that is ultimately referenced by an r-value
1649 virtual ir_variable
*variable_referenced() const;
1652 ir_swizzle_mask mask
;
1656 * Initialize the mask component of a swizzle
1658 * This is used by the \c ir_swizzle constructors.
1660 void init_mask(const unsigned *components
, unsigned count
);
1664 class ir_dereference
: public ir_rvalue
{
1666 virtual ir_dereference
*clone(void *mem_ctx
, struct hash_table
*) const = 0;
1668 virtual ir_dereference
*as_dereference()
1673 bool is_lvalue() const;
1676 * Get the variable that is ultimately referenced by an r-value
1678 virtual ir_variable
*variable_referenced() const = 0;
1681 * Get the constant that is ultimately referenced by an r-value,
1682 * in a constant expression evaluation context.
1684 * The offset is used when the reference is to a specific column of
1687 virtual void constant_referenced(struct hash_table
*variable_context
, ir_constant
*&store
, int &offset
) const = 0;
1691 class ir_dereference_variable
: public ir_dereference
{
1693 ir_dereference_variable(ir_variable
*var
);
1695 virtual ir_dereference_variable
*clone(void *mem_ctx
,
1696 struct hash_table
*) const;
1698 virtual ir_constant
*constant_expression_value(struct hash_table
*variable_context
= NULL
);
1700 virtual ir_dereference_variable
*as_dereference_variable()
1706 * Get the variable that is ultimately referenced by an r-value
1708 virtual ir_variable
*variable_referenced() const
1714 * Get the constant that is ultimately referenced by an r-value,
1715 * in a constant expression evaluation context.
1717 * The offset is used when the reference is to a specific column of
1720 virtual void constant_referenced(struct hash_table
*variable_context
, ir_constant
*&store
, int &offset
) const;
1722 virtual ir_variable
*whole_variable_referenced()
1724 /* ir_dereference_variable objects always dereference the entire
1725 * variable. However, if this dereference is dereferenced by anything
1726 * else, the complete deferefernce chain is not a whole-variable
1727 * dereference. This method should only be called on the top most
1728 * ir_rvalue in a dereference chain.
1733 virtual void accept(ir_visitor
*v
)
1738 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1741 * Object being dereferenced.
1747 class ir_dereference_array
: public ir_dereference
{
1749 ir_dereference_array(ir_rvalue
*value
, ir_rvalue
*array_index
);
1751 ir_dereference_array(ir_variable
*var
, ir_rvalue
*array_index
);
1753 virtual ir_dereference_array
*clone(void *mem_ctx
,
1754 struct hash_table
*) const;
1756 virtual ir_constant
*constant_expression_value(struct hash_table
*variable_context
= NULL
);
1758 virtual ir_dereference_array
*as_dereference_array()
1764 * Get the variable that is ultimately referenced by an r-value
1766 virtual ir_variable
*variable_referenced() const
1768 return this->array
->variable_referenced();
1772 * Get the constant that is ultimately referenced by an r-value,
1773 * in a constant expression evaluation context.
1775 * The offset is used when the reference is to a specific column of
1778 virtual void constant_referenced(struct hash_table
*variable_context
, ir_constant
*&store
, int &offset
) const;
1780 virtual void accept(ir_visitor
*v
)
1785 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1788 ir_rvalue
*array_index
;
1791 void set_array(ir_rvalue
*value
);
1795 class ir_dereference_record
: public ir_dereference
{
1797 ir_dereference_record(ir_rvalue
*value
, const char *field
);
1799 ir_dereference_record(ir_variable
*var
, const char *field
);
1801 virtual ir_dereference_record
*clone(void *mem_ctx
,
1802 struct hash_table
*) const;
1804 virtual ir_constant
*constant_expression_value(struct hash_table
*variable_context
= NULL
);
1806 virtual ir_dereference_record
*as_dereference_record()
1812 * Get the variable that is ultimately referenced by an r-value
1814 virtual ir_variable
*variable_referenced() const
1816 return this->record
->variable_referenced();
1820 * Get the constant that is ultimately referenced by an r-value,
1821 * in a constant expression evaluation context.
1823 * The offset is used when the reference is to a specific column of
1826 virtual void constant_referenced(struct hash_table
*variable_context
, ir_constant
*&store
, int &offset
) const;
1828 virtual void accept(ir_visitor
*v
)
1833 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1841 * Data stored in an ir_constant
1843 union ir_constant_data
{
1851 class ir_constant
: public ir_rvalue
{
1853 ir_constant(const struct glsl_type
*type
, const ir_constant_data
*data
);
1854 ir_constant(bool b
);
1855 ir_constant(unsigned int u
);
1857 ir_constant(float f
);
1860 * Construct an ir_constant from a list of ir_constant values
1862 ir_constant(const struct glsl_type
*type
, exec_list
*values
);
1865 * Construct an ir_constant from a scalar component of another ir_constant
1867 * The new \c ir_constant inherits the type of the component from the
1871 * In the case of a matrix constant, the new constant is a scalar, \b not
1874 ir_constant(const ir_constant
*c
, unsigned i
);
1877 * Return a new ir_constant of the specified type containing all zeros.
1879 static ir_constant
*zero(void *mem_ctx
, const glsl_type
*type
);
1881 virtual ir_constant
*clone(void *mem_ctx
, struct hash_table
*) const;
1883 virtual ir_constant
*constant_expression_value(struct hash_table
*variable_context
= NULL
);
1885 virtual ir_constant
*as_constant()
1890 virtual void accept(ir_visitor
*v
)
1895 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1898 * Get a particular component of a constant as a specific type
1900 * This is useful, for example, to get a value from an integer constant
1901 * as a float or bool. This appears frequently when constructors are
1902 * called with all constant parameters.
1905 bool get_bool_component(unsigned i
) const;
1906 float get_float_component(unsigned i
) const;
1907 int get_int_component(unsigned i
) const;
1908 unsigned get_uint_component(unsigned i
) const;
1911 ir_constant
*get_array_element(unsigned i
) const;
1913 ir_constant
*get_record_field(const char *name
);
1916 * Copy the values on another constant at a given offset.
1918 * The offset is ignored for array or struct copies, it's only for
1919 * scalars or vectors into vectors or matrices.
1921 * With identical types on both sides and zero offset it's clone()
1922 * without creating a new object.
1925 void copy_offset(ir_constant
*src
, int offset
);
1928 * Copy the values on another constant at a given offset and
1929 * following an assign-like mask.
1931 * The mask is ignored for scalars.
1933 * Note that this function only handles what assign can handle,
1934 * i.e. at most a vector as source and a column of a matrix as
1938 void copy_masked_offset(ir_constant
*src
, int offset
, unsigned int mask
);
1941 * Determine whether a constant has the same value as another constant
1943 * \sa ir_constant::is_zero, ir_constant::is_one,
1944 * ir_constant::is_negative_one, ir_constant::is_basis
1946 bool has_value(const ir_constant
*) const;
1948 virtual bool is_zero() const;
1949 virtual bool is_one() const;
1950 virtual bool is_negative_one() const;
1951 virtual bool is_basis() const;
1954 * Value of the constant.
1956 * The field used to back the values supplied by the constant is determined
1957 * by the type associated with the \c ir_instruction. Constants may be
1958 * scalars, vectors, or matrices.
1960 union ir_constant_data value
;
1962 /* Array elements */
1963 ir_constant
**array_elements
;
1965 /* Structure fields */
1966 exec_list components
;
1970 * Parameterless constructor only used by the clone method
1978 * Apply a visitor to each IR node in a list
1981 visit_exec_list(exec_list
*list
, ir_visitor
*visitor
);
1984 * Validate invariants on each IR node in a list
1986 void validate_ir_tree(exec_list
*instructions
);
1988 struct _mesa_glsl_parse_state
;
1989 struct gl_shader_program
;
1992 * Detect whether an unlinked shader contains static recursion
1994 * If the list of instructions is determined to contain static recursion,
1995 * \c _mesa_glsl_error will be called to emit error messages for each function
1996 * that is in the recursion cycle.
1999 detect_recursion_unlinked(struct _mesa_glsl_parse_state
*state
,
2000 exec_list
*instructions
);
2003 * Detect whether a linked shader contains static recursion
2005 * If the list of instructions is determined to contain static recursion,
2006 * \c link_error_printf will be called to emit error messages for each function
2007 * that is in the recursion cycle. In addition,
2008 * \c gl_shader_program::LinkStatus will be set to false.
2011 detect_recursion_linked(struct gl_shader_program
*prog
,
2012 exec_list
*instructions
);
2015 * Make a clone of each IR instruction in a list
2017 * \param in List of IR instructions that are to be cloned
2018 * \param out List to hold the cloned instructions
2021 clone_ir_list(void *mem_ctx
, exec_list
*out
, const exec_list
*in
);
2024 _mesa_glsl_initialize_variables(exec_list
*instructions
,
2025 struct _mesa_glsl_parse_state
*state
);
2028 _mesa_glsl_initialize_functions(_mesa_glsl_parse_state
*state
);
2031 _mesa_glsl_release_functions(void);
2034 reparent_ir(exec_list
*list
, void *mem_ctx
);
2036 struct glsl_symbol_table
;
2039 import_prototypes(const exec_list
*source
, exec_list
*dest
,
2040 struct glsl_symbol_table
*symbols
, void *mem_ctx
);
2043 ir_has_call(ir_instruction
*ir
);
2046 do_set_program_inouts(exec_list
*instructions
, struct gl_program
*prog
,
2047 bool is_fragment_shader
);
2050 prototype_string(const glsl_type
*return_type
, const char *name
,
2051 exec_list
*parameters
);