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_expression
* as_expression() { return NULL
; }
124 virtual class ir_rvalue
* as_rvalue() { return NULL
; }
125 virtual class ir_loop
* as_loop() { return NULL
; }
126 virtual class ir_assignment
* as_assignment() { return NULL
; }
127 virtual class ir_call
* as_call() { return NULL
; }
128 virtual class ir_return
* as_return() { return NULL
; }
129 virtual class ir_if
* as_if() { return NULL
; }
130 virtual class ir_swizzle
* as_swizzle() { return NULL
; }
131 virtual class ir_constant
* as_constant() { return NULL
; }
132 virtual class ir_discard
* as_discard() { return NULL
; }
138 ir_type
= ir_type_unset
;
144 * The base class for all "values"/expression trees.
146 class ir_rvalue
: public ir_instruction
{
148 const struct glsl_type
*type
;
150 virtual ir_rvalue
*clone(void *mem_ctx
, struct hash_table
*) const;
152 virtual void accept(ir_visitor
*v
)
157 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
159 virtual ir_constant
*constant_expression_value(struct hash_table
*variable_context
= NULL
);
161 virtual ir_rvalue
* as_rvalue()
166 ir_rvalue
*as_rvalue_to_saturate();
168 virtual bool is_lvalue() const
174 * Get the variable that is ultimately referenced by an r-value
176 virtual ir_variable
*variable_referenced() const
183 * If an r-value is a reference to a whole variable, get that variable
186 * Pointer to a variable that is completely dereferenced by the r-value. If
187 * the r-value is not a dereference or the dereference does not access the
188 * entire variable (i.e., it's just one array element, struct field), \c NULL
191 virtual ir_variable
*whole_variable_referenced()
197 * Determine if an r-value has the value zero
199 * The base implementation of this function always returns \c false. The
200 * \c ir_constant class over-rides this function to return \c true \b only
201 * for vector and scalar types that have all elements set to the value
202 * zero (or \c false for booleans).
204 * \sa ir_constant::has_value, ir_rvalue::is_one, ir_rvalue::is_negative_one,
205 * ir_constant::is_basis
207 virtual bool is_zero() const;
210 * Determine if an r-value has the value one
212 * The base implementation of this function always returns \c false. The
213 * \c ir_constant class over-rides this function to return \c true \b only
214 * for vector and scalar types that have all elements set to the value
215 * one (or \c true for booleans).
217 * \sa ir_constant::has_value, ir_rvalue::is_zero, ir_rvalue::is_negative_one,
218 * ir_constant::is_basis
220 virtual bool is_one() const;
223 * Determine if an r-value has the value negative one
225 * The base implementation of this function always returns \c false. The
226 * \c ir_constant class over-rides this function to return \c true \b only
227 * for vector and scalar types that have all elements set to the value
228 * negative one. For boolean types, the result is always \c false.
230 * \sa ir_constant::has_value, ir_rvalue::is_zero, ir_rvalue::is_one
231 * ir_constant::is_basis
233 virtual bool is_negative_one() const;
236 * Determine if an r-value is a basis vector
238 * The base implementation of this function always returns \c false. The
239 * \c ir_constant class over-rides this function to return \c true \b only
240 * for vector and scalar types that have one element set to the value one,
241 * and the other elements set to the value zero. For boolean types, the
242 * result is always \c false.
244 * \sa ir_constant::has_value, ir_rvalue::is_zero, ir_rvalue::is_one,
245 * is_constant::is_negative_one
247 virtual bool is_basis() const;
251 * Return a generic value of error_type.
253 * Allocation will be performed with 'mem_ctx' as ralloc owner.
255 static ir_rvalue
*error_value(void *mem_ctx
);
263 * Variable storage classes
265 enum ir_variable_mode
{
266 ir_var_auto
= 0, /**< Function local variables and globals. */
267 ir_var_uniform
, /**< Variable declared as a uniform. */
272 ir_var_function_inout
,
273 ir_var_const_in
, /**< "in" param that must be a constant expression */
274 ir_var_system_value
, /**< Ex: front-face, instance-id, etc. */
275 ir_var_temporary
/**< Temporary variable generated during compilation. */
279 * \brief Layout qualifiers for gl_FragDepth.
281 * The AMD/ARB_conservative_depth extensions allow gl_FragDepth to be redeclared
282 * with a layout qualifier.
284 enum ir_depth_layout
{
285 ir_depth_layout_none
, /**< No depth layout is specified. */
287 ir_depth_layout_greater
,
288 ir_depth_layout_less
,
289 ir_depth_layout_unchanged
293 * \brief Convert depth layout qualifier to string.
296 depth_layout_string(ir_depth_layout layout
);
299 * Description of built-in state associated with a uniform
301 * \sa ir_variable::state_slots
303 struct ir_state_slot
{
308 class ir_variable
: public ir_instruction
{
310 ir_variable(const struct glsl_type
*, const char *, ir_variable_mode
);
312 virtual ir_variable
*clone(void *mem_ctx
, struct hash_table
*ht
) const;
314 virtual ir_variable
*as_variable()
319 virtual void accept(ir_visitor
*v
)
324 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
328 * Get the string value for the interpolation qualifier
330 * \return The string that would be used in a shader to specify \c
331 * mode will be returned.
333 * This function is used to generate error messages of the form "shader
334 * uses %s interpolation qualifier", so in the case where there is no
335 * interpolation qualifier, it returns "no".
337 * This function should only be used on a shader input or output variable.
339 const char *interpolation_string() const;
342 * Determine how this variable should be interpolated based on its
343 * interpolation qualifier (if present), whether it is gl_Color or
344 * gl_SecondaryColor, and whether flatshading is enabled in the current GL
347 * The return value will always be either INTERP_QUALIFIER_SMOOTH,
348 * INTERP_QUALIFIER_NOPERSPECTIVE, or INTERP_QUALIFIER_FLAT.
350 glsl_interp_qualifier
determine_interpolation_mode(bool flat_shade
);
353 * Determine whether or not a variable is part of a uniform block.
355 inline bool is_in_uniform_block() const
357 return this->mode
== ir_var_uniform
&& this->interface_type
!= NULL
;
361 * Determine whether or not a variable is the declaration of an interface
364 * For the first declaration below, there will be an \c ir_variable named
365 * "instance" whose type and whose instance_type will be the same
366 * \cglsl_type. For the second declaration, there will be an \c ir_variable
367 * named "f" whose type is float and whose instance_type is B2.
369 * "instance" is an interface instance variable, but "f" is not.
379 inline bool is_interface_instance() const
381 const glsl_type
*const t
= this->type
;
383 return (t
== this->interface_type
)
384 || (t
->is_array() && t
->fields
.array
== this->interface_type
);
388 * Declared type of the variable
390 const struct glsl_type
*type
;
393 * Declared name of the variable
398 * Highest element accessed with a constant expression array index
400 * Not used for non-array variables.
402 unsigned max_array_access
;
405 * Is the variable read-only?
407 * This is set for variables declared as \c const, shader inputs,
410 unsigned read_only
:1;
412 unsigned invariant
:1;
415 * Has this variable been used for reading or writing?
417 * Several GLSL semantic checks require knowledge of whether or not a
418 * variable has been used. For example, it is an error to redeclare a
419 * variable as invariant after it has been used.
421 * This is only maintained in the ast_to_hir.cpp path, not in
422 * Mesa's fixed function or ARB program paths.
427 * Has this variable been statically assigned?
429 * This answers whether the variable was assigned in any path of
430 * the shader during ast_to_hir. This doesn't answer whether it is
431 * still written after dead code removal, nor is it maintained in
432 * non-ast_to_hir.cpp (GLSL parsing) paths.
437 * Storage class of the variable.
439 * \sa ir_variable_mode
444 * Interpolation mode for shader inputs / outputs
446 * \sa ir_variable_interpolation
448 unsigned interpolation
:2;
451 * \name ARB_fragment_coord_conventions
454 unsigned origin_upper_left
:1;
455 unsigned pixel_center_integer
:1;
459 * Was the location explicitly set in the shader?
461 * If the location is explicitly set in the shader, it \b cannot be changed
462 * by the linker or by the API (e.g., calls to \c glBindAttribLocation have
465 unsigned explicit_location
:1;
466 unsigned explicit_index
:1;
469 * Does this variable have an initializer?
471 * This is used by the linker to cross-validiate initializers of global
474 unsigned has_initializer
:1;
477 * Is this variable a generic output or input that has not yet been matched
478 * up to a variable in another stage of the pipeline?
480 * This is used by the linker as scratch storage while assigning locations
481 * to generic inputs and outputs.
483 unsigned is_unmatched_generic_inout
:1;
486 * If non-zero, then this variable may be packed along with other variables
487 * into a single varying slot, so this offset should be applied when
488 * accessing components. For example, an offset of 1 means that the x
489 * component of this variable is actually stored in component y of the
490 * location specified by \c location.
492 unsigned location_frac
:2;
495 * \brief Layout qualifier for gl_FragDepth.
497 * This is not equal to \c ir_depth_layout_none if and only if this
498 * variable is \c gl_FragDepth and a layout qualifier is specified.
500 ir_depth_layout depth_layout
;
503 * Storage location of the base of this variable
505 * The precise meaning of this field depends on the nature of the variable.
507 * - Vertex shader input: one of the values from \c gl_vert_attrib.
508 * - Vertex shader output: one of the values from \c gl_vert_result.
509 * - Fragment shader input: one of the values from \c gl_frag_attrib.
510 * - Fragment shader output: one of the values from \c gl_frag_result.
511 * - Uniforms: Per-stage uniform slot number for default uniform block.
512 * - Uniforms: Index within the uniform block definition for UBO members.
513 * - Other: This field is not currently used.
515 * If the variable is a uniform, shader input, or shader output, and the
516 * slot has not been assigned, the value will be -1.
521 * output index for dual source blending.
526 * Built-in state that backs this uniform
528 * Once set at variable creation, \c state_slots must remain invariant.
529 * This is because, ideally, this array would be shared by all clones of
530 * this variable in the IR tree. In other words, we'd really like for it
531 * to be a fly-weight.
533 * If the variable is not a uniform, \c num_state_slots will be zero and
534 * \c state_slots will be \c NULL.
537 unsigned num_state_slots
; /**< Number of state slots used */
538 ir_state_slot
*state_slots
; /**< State descriptors. */
542 * Emit a warning if this variable is accessed.
544 const char *warn_extension
;
547 * Value assigned in the initializer of a variable declared "const"
549 ir_constant
*constant_value
;
552 * Constant expression assigned in the initializer of the variable
555 * This field and \c ::constant_value are distinct. Even if the two fields
556 * refer to constants with the same value, they must point to separate
559 ir_constant
*constant_initializer
;
562 * For variables that are in an interface block or are an instance of an
563 * interface block, this is the \c GLSL_TYPE_INTERFACE type for that block.
565 * \sa ir_variable::location
567 const glsl_type
*interface_type
;
573 * The representation of a function instance; may be the full definition or
574 * simply a prototype.
576 class ir_function_signature
: public ir_instruction
{
577 /* An ir_function_signature will be part of the list of signatures in
581 ir_function_signature(const glsl_type
*return_type
);
583 virtual ir_function_signature
*clone(void *mem_ctx
,
584 struct hash_table
*ht
) const;
585 ir_function_signature
*clone_prototype(void *mem_ctx
,
586 struct hash_table
*ht
) const;
588 virtual void accept(ir_visitor
*v
)
593 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
596 * Attempt to evaluate this function as a constant expression,
597 * given a list of the actual parameters and the variable context.
598 * Returns NULL for non-built-ins.
600 ir_constant
*constant_expression_value(exec_list
*actual_parameters
, struct hash_table
*variable_context
);
603 * Get the name of the function for which this is a signature
605 const char *function_name() const;
608 * Get a handle to the function for which this is a signature
610 * There is no setter function, this function returns a \c const pointer,
611 * and \c ir_function_signature::_function is private for a reason. The
612 * only way to make a connection between a function and function signature
613 * is via \c ir_function::add_signature. This helps ensure that certain
614 * invariants (i.e., a function signature is in the list of signatures for
615 * its \c _function) are met.
617 * \sa ir_function::add_signature
619 inline const class ir_function
*function() const
621 return this->_function
;
625 * Check whether the qualifiers match between this signature's parameters
626 * and the supplied parameter list. If not, returns the name of the first
627 * parameter with mismatched qualifiers (for use in error messages).
629 const char *qualifiers_match(exec_list
*params
);
632 * Replace the current parameter list with the given one. This is useful
633 * if the current information came from a prototype, and either has invalid
634 * or missing parameter names.
636 void replace_parameters(exec_list
*new_params
);
639 * Function return type.
641 * \note This discards the optional precision qualifier.
643 const struct glsl_type
*return_type
;
646 * List of ir_variable of function parameters.
648 * This represents the storage. The paramaters passed in a particular
649 * call will be in ir_call::actual_paramaters.
651 struct exec_list parameters
;
653 /** Whether or not this function has a body (which may be empty). */
654 unsigned is_defined
:1;
656 /** Whether or not this function signature is a built-in. */
657 unsigned is_builtin
:1;
659 /** Body of instructions in the function. */
660 struct exec_list body
;
663 /** Function of which this signature is one overload. */
664 class ir_function
*_function
;
666 /** Function signature of which this one is a prototype clone */
667 const ir_function_signature
*origin
;
669 friend class ir_function
;
672 * Helper function to run a list of instructions for constant
673 * expression evaluation.
675 * The hash table represents the values of the visible variables.
676 * There are no scoping issues because the table is indexed on
677 * ir_variable pointers, not variable names.
679 * Returns false if the expression is not constant, true otherwise,
680 * and the value in *result if result is non-NULL.
682 bool constant_expression_evaluate_expression_list(const struct exec_list
&body
,
683 struct hash_table
*variable_context
,
684 ir_constant
**result
);
689 * Header for tracking multiple overloaded functions with the same name.
690 * Contains a list of ir_function_signatures representing each of the
693 class ir_function
: public ir_instruction
{
695 ir_function(const char *name
);
697 virtual ir_function
*clone(void *mem_ctx
, struct hash_table
*ht
) const;
699 virtual ir_function
*as_function()
704 virtual void accept(ir_visitor
*v
)
709 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
711 void add_signature(ir_function_signature
*sig
)
713 sig
->_function
= this;
714 this->signatures
.push_tail(sig
);
718 * Get an iterator for the set of function signatures
720 exec_list_iterator
iterator()
722 return signatures
.iterator();
726 * Find a signature that matches a set of actual parameters, taking implicit
727 * conversions into account. Also flags whether the match was exact.
729 ir_function_signature
*matching_signature(const exec_list
*actual_param
,
730 bool *match_is_exact
);
733 * Find a signature that matches a set of actual parameters, taking implicit
734 * conversions into account.
736 ir_function_signature
*matching_signature(const exec_list
*actual_param
);
739 * Find a signature that exactly matches a set of actual parameters without
740 * any implicit type conversions.
742 ir_function_signature
*exact_matching_signature(const exec_list
*actual_ps
);
745 * Name of the function.
749 /** Whether or not this function has a signature that isn't a built-in. */
750 bool has_user_signature();
753 * List of ir_function_signature for each overloaded function with this name.
755 struct exec_list signatures
;
758 inline const char *ir_function_signature::function_name() const
760 return this->_function
->name
;
766 * IR instruction representing high-level if-statements
768 class ir_if
: public ir_instruction
{
770 ir_if(ir_rvalue
*condition
)
771 : condition(condition
)
773 ir_type
= ir_type_if
;
776 virtual ir_if
*clone(void *mem_ctx
, struct hash_table
*ht
) const;
778 virtual ir_if
*as_if()
783 virtual void accept(ir_visitor
*v
)
788 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
790 ir_rvalue
*condition
;
791 /** List of ir_instruction for the body of the then branch */
792 exec_list then_instructions
;
793 /** List of ir_instruction for the body of the else branch */
794 exec_list else_instructions
;
799 * IR instruction representing a high-level loop structure.
801 class ir_loop
: public ir_instruction
{
805 virtual ir_loop
*clone(void *mem_ctx
, struct hash_table
*ht
) const;
807 virtual void accept(ir_visitor
*v
)
812 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
814 virtual ir_loop
*as_loop()
820 * Get an iterator for the instructions of the loop body
822 exec_list_iterator
iterator()
824 return body_instructions
.iterator();
827 /** List of ir_instruction that make up the body of the loop. */
828 exec_list body_instructions
;
831 * \name Loop counter and controls
833 * Represents a loop like a FORTRAN \c do-loop.
836 * If \c from and \c to are the same value, the loop will execute once.
839 ir_rvalue
*from
; /** Value of the loop counter on the first
840 * iteration of the loop.
842 ir_rvalue
*to
; /** Value of the loop counter on the last
843 * iteration of the loop.
845 ir_rvalue
*increment
;
846 ir_variable
*counter
;
849 * Comparison operation in the loop terminator.
851 * If any of the loop control fields are non-\c NULL, this field must be
852 * one of \c ir_binop_less, \c ir_binop_greater, \c ir_binop_lequal,
853 * \c ir_binop_gequal, \c ir_binop_equal, or \c ir_binop_nequal.
860 class ir_assignment
: public ir_instruction
{
862 ir_assignment(ir_rvalue
*lhs
, ir_rvalue
*rhs
, ir_rvalue
*condition
= NULL
);
865 * Construct an assignment with an explicit write mask
868 * Since a write mask is supplied, the LHS must already be a bare
869 * \c ir_dereference. The cannot be any swizzles in the LHS.
871 ir_assignment(ir_dereference
*lhs
, ir_rvalue
*rhs
, ir_rvalue
*condition
,
872 unsigned write_mask
);
874 virtual ir_assignment
*clone(void *mem_ctx
, struct hash_table
*ht
) const;
876 virtual ir_constant
*constant_expression_value(struct hash_table
*variable_context
= NULL
);
878 virtual void accept(ir_visitor
*v
)
883 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
885 virtual ir_assignment
* as_assignment()
891 * Get a whole variable written by an assignment
893 * If the LHS of the assignment writes a whole variable, the variable is
894 * returned. Otherwise \c NULL is returned. Examples of whole-variable
897 * - Assigning to a scalar
898 * - Assigning to all components of a vector
899 * - Whole array (or matrix) assignment
900 * - Whole structure assignment
902 ir_variable
*whole_variable_written();
905 * Set the LHS of an assignment
907 void set_lhs(ir_rvalue
*lhs
);
910 * Left-hand side of the assignment.
912 * This should be treated as read only. If you need to set the LHS of an
913 * assignment, use \c ir_assignment::set_lhs.
918 * Value being assigned
923 * Optional condition for the assignment.
925 ir_rvalue
*condition
;
929 * Component mask written
931 * For non-vector types in the LHS, this field will be zero. For vector
932 * types, a bit will be set for each component that is written. Note that
933 * for \c vec2 and \c vec3 types only the lower bits will ever be set.
935 * A partially-set write mask means that each enabled channel gets
936 * the value from a consecutive channel of the rhs. For example,
937 * to write just .xyw of gl_FrontColor with color:
939 * (assign (constant bool (1)) (xyw)
940 * (var_ref gl_FragColor)
941 * (swiz xyw (var_ref color)))
943 unsigned write_mask
:4;
946 /* Update ir_expression::get_num_operands() and operator_strs when
947 * updating this list.
949 enum ir_expression_operation
{
958 ir_unop_exp
, /**< Log base e on gentype */
959 ir_unop_log
, /**< Natural log on gentype */
962 ir_unop_f2i
, /**< Float-to-integer conversion. */
963 ir_unop_f2u
, /**< Float-to-unsigned conversion. */
964 ir_unop_i2f
, /**< Integer-to-float conversion. */
965 ir_unop_f2b
, /**< Float-to-boolean conversion */
966 ir_unop_b2f
, /**< Boolean-to-float conversion */
967 ir_unop_i2b
, /**< int-to-boolean conversion */
968 ir_unop_b2i
, /**< Boolean-to-int conversion */
969 ir_unop_u2f
, /**< Unsigned-to-float conversion. */
970 ir_unop_i2u
, /**< Integer-to-unsigned conversion. */
971 ir_unop_u2i
, /**< Unsigned-to-integer conversion. */
972 ir_unop_bitcast_i2f
, /**< Bit-identical int-to-float "conversion" */
973 ir_unop_bitcast_f2i
, /**< Bit-identical float-to-int "conversion" */
974 ir_unop_bitcast_u2f
, /**< Bit-identical uint-to-float "conversion" */
975 ir_unop_bitcast_f2u
, /**< Bit-identical float-to-uint "conversion" */
979 * \name Unary floating-point rounding operations.
990 * \name Trigonometric operations.
995 ir_unop_sin_reduced
, /**< Reduced range sin. [-pi, pi] */
996 ir_unop_cos_reduced
, /**< Reduced range cos. [-pi, pi] */
1000 * \name Partial derivatives.
1008 * \name Floating point pack and unpack operations.
1011 ir_unop_pack_snorm_2x16
,
1012 ir_unop_pack_snorm_4x8
,
1013 ir_unop_pack_unorm_2x16
,
1014 ir_unop_pack_unorm_4x8
,
1015 ir_unop_pack_half_2x16
,
1016 ir_unop_unpack_snorm_2x16
,
1017 ir_unop_unpack_snorm_4x8
,
1018 ir_unop_unpack_unorm_2x16
,
1019 ir_unop_unpack_unorm_4x8
,
1020 ir_unop_unpack_half_2x16
,
1024 * \name Lowered floating point unpacking operations.
1026 * \see lower_packing_builtins_visitor::split_unpack_half_2x16
1029 ir_unop_unpack_half_2x16_split_x
,
1030 ir_unop_unpack_half_2x16_split_y
,
1036 * A sentinel marking the last of the unary operations.
1038 ir_last_unop
= ir_unop_noise
,
1046 * Takes one of two combinations of arguments:
1049 * - mod(vecN, float)
1051 * Does not take integer types.
1056 * \name Binary comparison operators which return a boolean vector.
1057 * The type of both operands must be equal.
1067 * Returns single boolean for whether all components of operands[0]
1068 * equal the components of operands[1].
1072 * Returns single boolean for whether any component of operands[0]
1073 * is not equal to the corresponding component of operands[1].
1075 ir_binop_any_nequal
,
1079 * \name Bit-wise binary operations.
1100 * \name Lowered floating point packing operations.
1102 * \see lower_packing_builtins_visitor::split_pack_half_2x16
1105 ir_binop_pack_half_2x16_split
,
1109 * Load a value the size of a given GLSL type from a uniform block.
1111 * operand0 is the ir_constant uniform block index in the linked shader.
1112 * operand1 is a byte offset within the uniform block.
1117 * A sentinel marking the last of the binary operations.
1119 ir_last_binop
= ir_binop_ubo_load
,
1124 * A sentinel marking the last of all operations.
1126 ir_last_opcode
= ir_quadop_vector
1129 class ir_expression
: public ir_rvalue
{
1131 ir_expression(int op
, const struct glsl_type
*type
,
1132 ir_rvalue
*op0
, ir_rvalue
*op1
= NULL
,
1133 ir_rvalue
*op2
= NULL
, ir_rvalue
*op3
= NULL
);
1136 * Constructor for unary operation expressions
1138 ir_expression(int op
, ir_rvalue
*);
1141 * Constructor for binary operation expressions
1143 ir_expression(int op
, ir_rvalue
*op0
, ir_rvalue
*op1
);
1145 virtual ir_expression
*as_expression()
1150 virtual ir_expression
*clone(void *mem_ctx
, struct hash_table
*ht
) const;
1153 * Attempt to constant-fold the expression
1155 * The "variable_context" hash table links ir_variable * to ir_constant *
1156 * that represent the variables' values. \c NULL represents an empty
1159 * If the expression cannot be constant folded, this method will return
1162 virtual ir_constant
*constant_expression_value(struct hash_table
*variable_context
= NULL
);
1165 * Determine the number of operands used by an expression
1167 static unsigned int get_num_operands(ir_expression_operation
);
1170 * Determine the number of operands used by an expression
1172 unsigned int get_num_operands() const
1174 return (this->operation
== ir_quadop_vector
)
1175 ? this->type
->vector_elements
: get_num_operands(operation
);
1179 * Return a string representing this expression's operator.
1181 const char *operator_string();
1184 * Return a string representing this expression's operator.
1186 static const char *operator_string(ir_expression_operation
);
1190 * Do a reverse-lookup to translate the given string into an operator.
1192 static ir_expression_operation
get_operator(const char *);
1194 virtual void accept(ir_visitor
*v
)
1199 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1201 ir_expression_operation operation
;
1202 ir_rvalue
*operands
[4];
1207 * HIR instruction representing a high-level function call, containing a list
1208 * of parameters and returning a value in the supplied temporary.
1210 class ir_call
: public ir_instruction
{
1212 ir_call(ir_function_signature
*callee
,
1213 ir_dereference_variable
*return_deref
,
1214 exec_list
*actual_parameters
)
1215 : return_deref(return_deref
), callee(callee
)
1217 ir_type
= ir_type_call
;
1218 assert(callee
->return_type
!= NULL
);
1219 actual_parameters
->move_nodes_to(& this->actual_parameters
);
1220 this->use_builtin
= callee
->is_builtin
;
1223 virtual ir_call
*clone(void *mem_ctx
, struct hash_table
*ht
) const;
1225 virtual ir_constant
*constant_expression_value(struct hash_table
*variable_context
= NULL
);
1227 virtual ir_call
*as_call()
1232 virtual void accept(ir_visitor
*v
)
1237 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1240 * Get an iterator for the set of acutal parameters
1242 exec_list_iterator
iterator()
1244 return actual_parameters
.iterator();
1248 * Get the name of the function being called.
1250 const char *callee_name() const
1252 return callee
->function_name();
1256 * Generates an inline version of the function before @ir,
1257 * storing the return value in return_deref.
1259 void generate_inline(ir_instruction
*ir
);
1262 * Storage for the function's return value.
1263 * This must be NULL if the return type is void.
1265 ir_dereference_variable
*return_deref
;
1268 * The specific function signature being called.
1270 ir_function_signature
*callee
;
1272 /* List of ir_rvalue of paramaters passed in this call. */
1273 exec_list actual_parameters
;
1275 /** Should this call only bind to a built-in function? */
1281 * \name Jump-like IR instructions.
1283 * These include \c break, \c continue, \c return, and \c discard.
1286 class ir_jump
: public ir_instruction
{
1290 ir_type
= ir_type_unset
;
1294 class ir_return
: public ir_jump
{
1299 this->ir_type
= ir_type_return
;
1302 ir_return(ir_rvalue
*value
)
1305 this->ir_type
= ir_type_return
;
1308 virtual ir_return
*clone(void *mem_ctx
, struct hash_table
*) const;
1310 virtual ir_return
*as_return()
1315 ir_rvalue
*get_value() const
1320 virtual void accept(ir_visitor
*v
)
1325 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1332 * Jump instructions used inside loops
1334 * These include \c break and \c continue. The \c break within a loop is
1335 * different from the \c break within a switch-statement.
1337 * \sa ir_switch_jump
1339 class ir_loop_jump
: public ir_jump
{
1346 ir_loop_jump(jump_mode mode
)
1348 this->ir_type
= ir_type_loop_jump
;
1352 virtual ir_loop_jump
*clone(void *mem_ctx
, struct hash_table
*) const;
1354 virtual void accept(ir_visitor
*v
)
1359 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1361 bool is_break() const
1363 return mode
== jump_break
;
1366 bool is_continue() const
1368 return mode
== jump_continue
;
1371 /** Mode selector for the jump instruction. */
1372 enum jump_mode mode
;
1376 * IR instruction representing discard statements.
1378 class ir_discard
: public ir_jump
{
1382 this->ir_type
= ir_type_discard
;
1383 this->condition
= NULL
;
1386 ir_discard(ir_rvalue
*cond
)
1388 this->ir_type
= ir_type_discard
;
1389 this->condition
= cond
;
1392 virtual ir_discard
*clone(void *mem_ctx
, struct hash_table
*ht
) const;
1394 virtual void accept(ir_visitor
*v
)
1399 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1401 virtual ir_discard
*as_discard()
1406 ir_rvalue
*condition
;
1412 * Texture sampling opcodes used in ir_texture
1414 enum ir_texture_opcode
{
1415 ir_tex
, /**< Regular texture look-up */
1416 ir_txb
, /**< Texture look-up with LOD bias */
1417 ir_txl
, /**< Texture look-up with explicit LOD */
1418 ir_txd
, /**< Texture look-up with partial derivatvies */
1419 ir_txf
, /**< Texel fetch with explicit LOD */
1420 ir_txs
/**< Texture size */
1425 * IR instruction to sample a texture
1427 * The specific form of the IR instruction depends on the \c mode value
1428 * selected from \c ir_texture_opcodes. In the printed IR, these will
1431 * Texel offset (0 or an expression)
1432 * | Projection divisor
1433 * | | Shadow comparitor
1436 * (tex <type> <sampler> <coordinate> 0 1 ( ))
1437 * (txb <type> <sampler> <coordinate> 0 1 ( ) <bias>)
1438 * (txl <type> <sampler> <coordinate> 0 1 ( ) <lod>)
1439 * (txd <type> <sampler> <coordinate> 0 1 ( ) (dPdx dPdy))
1440 * (txf <type> <sampler> <coordinate> 0 <lod>)
1441 * (txs <type> <sampler> <lod>)
1443 class ir_texture
: public ir_rvalue
{
1445 ir_texture(enum ir_texture_opcode op
)
1446 : op(op
), sampler(NULL
), coordinate(NULL
), projector(NULL
),
1447 shadow_comparitor(NULL
), offset(NULL
)
1449 this->ir_type
= ir_type_texture
;
1452 virtual ir_texture
*clone(void *mem_ctx
, struct hash_table
*) const;
1454 virtual ir_constant
*constant_expression_value(struct hash_table
*variable_context
= NULL
);
1456 virtual void accept(ir_visitor
*v
)
1461 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1464 * Return a string representing the ir_texture_opcode.
1466 const char *opcode_string();
1468 /** Set the sampler and type. */
1469 void set_sampler(ir_dereference
*sampler
, const glsl_type
*type
);
1472 * Do a reverse-lookup to translate a string into an ir_texture_opcode.
1474 static ir_texture_opcode
get_opcode(const char *);
1476 enum ir_texture_opcode op
;
1478 /** Sampler to use for the texture access. */
1479 ir_dereference
*sampler
;
1481 /** Texture coordinate to sample */
1482 ir_rvalue
*coordinate
;
1485 * Value used for projective divide.
1487 * If there is no projective divide (the common case), this will be
1488 * \c NULL. Optimization passes should check for this to point to a constant
1489 * of 1.0 and replace that with \c NULL.
1491 ir_rvalue
*projector
;
1494 * Coordinate used for comparison on shadow look-ups.
1496 * If there is no shadow comparison, this will be \c NULL. For the
1497 * \c ir_txf opcode, this *must* be \c NULL.
1499 ir_rvalue
*shadow_comparitor
;
1501 /** Texel offset. */
1505 ir_rvalue
*lod
; /**< Floating point LOD */
1506 ir_rvalue
*bias
; /**< Floating point LOD bias */
1508 ir_rvalue
*dPdx
; /**< Partial derivative of coordinate wrt X */
1509 ir_rvalue
*dPdy
; /**< Partial derivative of coordinate wrt Y */
1515 struct ir_swizzle_mask
{
1522 * Number of components in the swizzle.
1524 unsigned num_components
:3;
1527 * Does the swizzle contain duplicate components?
1529 * L-value swizzles cannot contain duplicate components.
1531 unsigned has_duplicates
:1;
1535 class ir_swizzle
: public ir_rvalue
{
1537 ir_swizzle(ir_rvalue
*, unsigned x
, unsigned y
, unsigned z
, unsigned w
,
1540 ir_swizzle(ir_rvalue
*val
, const unsigned *components
, unsigned count
);
1542 ir_swizzle(ir_rvalue
*val
, ir_swizzle_mask mask
);
1544 virtual ir_swizzle
*clone(void *mem_ctx
, struct hash_table
*) const;
1546 virtual ir_constant
*constant_expression_value(struct hash_table
*variable_context
= NULL
);
1548 virtual ir_swizzle
*as_swizzle()
1554 * Construct an ir_swizzle from the textual representation. Can fail.
1556 static ir_swizzle
*create(ir_rvalue
*, const char *, unsigned vector_length
);
1558 virtual void accept(ir_visitor
*v
)
1563 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1565 bool is_lvalue() const
1567 return val
->is_lvalue() && !mask
.has_duplicates
;
1571 * Get the variable that is ultimately referenced by an r-value
1573 virtual ir_variable
*variable_referenced() const;
1576 ir_swizzle_mask mask
;
1580 * Initialize the mask component of a swizzle
1582 * This is used by the \c ir_swizzle constructors.
1584 void init_mask(const unsigned *components
, unsigned count
);
1588 class ir_dereference
: public ir_rvalue
{
1590 virtual ir_dereference
*clone(void *mem_ctx
, struct hash_table
*) const = 0;
1592 virtual ir_dereference
*as_dereference()
1597 bool is_lvalue() const;
1600 * Get the variable that is ultimately referenced by an r-value
1602 virtual ir_variable
*variable_referenced() const = 0;
1605 * Get the constant that is ultimately referenced by an r-value,
1606 * in a constant expression evaluation context.
1608 * The offset is used when the reference is to a specific column of
1611 virtual void constant_referenced(struct hash_table
*variable_context
, ir_constant
*&store
, int &offset
) const = 0;
1615 class ir_dereference_variable
: public ir_dereference
{
1617 ir_dereference_variable(ir_variable
*var
);
1619 virtual ir_dereference_variable
*clone(void *mem_ctx
,
1620 struct hash_table
*) const;
1622 virtual ir_constant
*constant_expression_value(struct hash_table
*variable_context
= NULL
);
1624 virtual ir_dereference_variable
*as_dereference_variable()
1630 * Get the variable that is ultimately referenced by an r-value
1632 virtual ir_variable
*variable_referenced() const
1638 * Get the constant that is ultimately referenced by an r-value,
1639 * in a constant expression evaluation context.
1641 * The offset is used when the reference is to a specific column of
1644 virtual void constant_referenced(struct hash_table
*variable_context
, ir_constant
*&store
, int &offset
) const;
1646 virtual ir_variable
*whole_variable_referenced()
1648 /* ir_dereference_variable objects always dereference the entire
1649 * variable. However, if this dereference is dereferenced by anything
1650 * else, the complete deferefernce chain is not a whole-variable
1651 * dereference. This method should only be called on the top most
1652 * ir_rvalue in a dereference chain.
1657 virtual void accept(ir_visitor
*v
)
1662 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1665 * Object being dereferenced.
1671 class ir_dereference_array
: public ir_dereference
{
1673 ir_dereference_array(ir_rvalue
*value
, ir_rvalue
*array_index
);
1675 ir_dereference_array(ir_variable
*var
, ir_rvalue
*array_index
);
1677 virtual ir_dereference_array
*clone(void *mem_ctx
,
1678 struct hash_table
*) const;
1680 virtual ir_constant
*constant_expression_value(struct hash_table
*variable_context
= NULL
);
1682 virtual ir_dereference_array
*as_dereference_array()
1688 * Get the variable that is ultimately referenced by an r-value
1690 virtual ir_variable
*variable_referenced() const
1692 return this->array
->variable_referenced();
1696 * Get the constant that is ultimately referenced by an r-value,
1697 * in a constant expression evaluation context.
1699 * The offset is used when the reference is to a specific column of
1702 virtual void constant_referenced(struct hash_table
*variable_context
, ir_constant
*&store
, int &offset
) const;
1704 virtual void accept(ir_visitor
*v
)
1709 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1712 ir_rvalue
*array_index
;
1715 void set_array(ir_rvalue
*value
);
1719 class ir_dereference_record
: public ir_dereference
{
1721 ir_dereference_record(ir_rvalue
*value
, const char *field
);
1723 ir_dereference_record(ir_variable
*var
, const char *field
);
1725 virtual ir_dereference_record
*clone(void *mem_ctx
,
1726 struct hash_table
*) const;
1728 virtual ir_constant
*constant_expression_value(struct hash_table
*variable_context
= NULL
);
1731 * Get the variable that is ultimately referenced by an r-value
1733 virtual ir_variable
*variable_referenced() const
1735 return this->record
->variable_referenced();
1739 * Get the constant that is ultimately referenced by an r-value,
1740 * in a constant expression evaluation context.
1742 * The offset is used when the reference is to a specific column of
1745 virtual void constant_referenced(struct hash_table
*variable_context
, ir_constant
*&store
, int &offset
) const;
1747 virtual void accept(ir_visitor
*v
)
1752 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1760 * Data stored in an ir_constant
1762 union ir_constant_data
{
1770 class ir_constant
: public ir_rvalue
{
1772 ir_constant(const struct glsl_type
*type
, const ir_constant_data
*data
);
1773 ir_constant(bool b
);
1774 ir_constant(unsigned int u
);
1776 ir_constant(float f
);
1779 * Construct an ir_constant from a list of ir_constant values
1781 ir_constant(const struct glsl_type
*type
, exec_list
*values
);
1784 * Construct an ir_constant from a scalar component of another ir_constant
1786 * The new \c ir_constant inherits the type of the component from the
1790 * In the case of a matrix constant, the new constant is a scalar, \b not
1793 ir_constant(const ir_constant
*c
, unsigned i
);
1796 * Return a new ir_constant of the specified type containing all zeros.
1798 static ir_constant
*zero(void *mem_ctx
, const glsl_type
*type
);
1800 virtual ir_constant
*clone(void *mem_ctx
, struct hash_table
*) const;
1802 virtual ir_constant
*constant_expression_value(struct hash_table
*variable_context
= NULL
);
1804 virtual ir_constant
*as_constant()
1809 virtual void accept(ir_visitor
*v
)
1814 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1817 * Get a particular component of a constant as a specific type
1819 * This is useful, for example, to get a value from an integer constant
1820 * as a float or bool. This appears frequently when constructors are
1821 * called with all constant parameters.
1824 bool get_bool_component(unsigned i
) const;
1825 float get_float_component(unsigned i
) const;
1826 int get_int_component(unsigned i
) const;
1827 unsigned get_uint_component(unsigned i
) const;
1830 ir_constant
*get_array_element(unsigned i
) const;
1832 ir_constant
*get_record_field(const char *name
);
1835 * Copy the values on another constant at a given offset.
1837 * The offset is ignored for array or struct copies, it's only for
1838 * scalars or vectors into vectors or matrices.
1840 * With identical types on both sides and zero offset it's clone()
1841 * without creating a new object.
1844 void copy_offset(ir_constant
*src
, int offset
);
1847 * Copy the values on another constant at a given offset and
1848 * following an assign-like mask.
1850 * The mask is ignored for scalars.
1852 * Note that this function only handles what assign can handle,
1853 * i.e. at most a vector as source and a column of a matrix as
1857 void copy_masked_offset(ir_constant
*src
, int offset
, unsigned int mask
);
1860 * Determine whether a constant has the same value as another constant
1862 * \sa ir_constant::is_zero, ir_constant::is_one,
1863 * ir_constant::is_negative_one, ir_constant::is_basis
1865 bool has_value(const ir_constant
*) const;
1867 virtual bool is_zero() const;
1868 virtual bool is_one() const;
1869 virtual bool is_negative_one() const;
1870 virtual bool is_basis() const;
1873 * Value of the constant.
1875 * The field used to back the values supplied by the constant is determined
1876 * by the type associated with the \c ir_instruction. Constants may be
1877 * scalars, vectors, or matrices.
1879 union ir_constant_data value
;
1881 /* Array elements */
1882 ir_constant
**array_elements
;
1884 /* Structure fields */
1885 exec_list components
;
1889 * Parameterless constructor only used by the clone method
1897 * Apply a visitor to each IR node in a list
1900 visit_exec_list(exec_list
*list
, ir_visitor
*visitor
);
1903 * Validate invariants on each IR node in a list
1905 void validate_ir_tree(exec_list
*instructions
);
1907 struct _mesa_glsl_parse_state
;
1908 struct gl_shader_program
;
1911 * Detect whether an unlinked shader contains static recursion
1913 * If the list of instructions is determined to contain static recursion,
1914 * \c _mesa_glsl_error will be called to emit error messages for each function
1915 * that is in the recursion cycle.
1918 detect_recursion_unlinked(struct _mesa_glsl_parse_state
*state
,
1919 exec_list
*instructions
);
1922 * Detect whether a linked shader contains static recursion
1924 * If the list of instructions is determined to contain static recursion,
1925 * \c link_error_printf will be called to emit error messages for each function
1926 * that is in the recursion cycle. In addition,
1927 * \c gl_shader_program::LinkStatus will be set to false.
1930 detect_recursion_linked(struct gl_shader_program
*prog
,
1931 exec_list
*instructions
);
1934 * Make a clone of each IR instruction in a list
1936 * \param in List of IR instructions that are to be cloned
1937 * \param out List to hold the cloned instructions
1940 clone_ir_list(void *mem_ctx
, exec_list
*out
, const exec_list
*in
);
1943 _mesa_glsl_initialize_variables(exec_list
*instructions
,
1944 struct _mesa_glsl_parse_state
*state
);
1947 _mesa_glsl_initialize_functions(_mesa_glsl_parse_state
*state
);
1950 _mesa_glsl_release_functions(void);
1953 reparent_ir(exec_list
*list
, void *mem_ctx
);
1955 struct glsl_symbol_table
;
1958 import_prototypes(const exec_list
*source
, exec_list
*dest
,
1959 struct glsl_symbol_table
*symbols
, void *mem_ctx
);
1962 ir_has_call(ir_instruction
*ir
);
1965 do_set_program_inouts(exec_list
*instructions
, struct gl_program
*prog
,
1966 bool is_fragment_shader
);
1969 prototype_string(const glsl_type
*return_type
, const char *name
,
1970 exec_list
*parameters
);