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"
42 * \defgroup IR Intermediate representation nodes
50 * Each concrete class derived from \c ir_instruction has a value in this
51 * enumerant. The value for the type is stored in \c ir_instruction::ir_type
52 * by the constructor. While using type tags is not very C++, it is extremely
53 * convenient. For example, during debugging you can simply inspect
54 * \c ir_instruction::ir_type to find out the actual type of the object.
56 * In addition, it is possible to use a switch-statement based on \c
57 * \c ir_instruction::ir_type to select different behavior for different object
58 * types. For functions that have only slight differences for several object
59 * types, this allows writing very straightforward, readable code.
63 * Zero is unused so that the IR validator can detect cases where
64 * \c ir_instruction::ir_type has not been initialized.
71 ir_type_dereference_array
,
72 ir_type_dereference_record
,
73 ir_type_dereference_variable
,
77 ir_type_function_signature
,
85 ir_type_end_primitive
,
86 ir_type_max
/**< maximum ir_type enum number, for validation */
90 * Base class of all IR instructions
92 class ir_instruction
: public exec_node
{
94 enum ir_node_type ir_type
;
97 * GCC 4.7+ and clang warn when deleting an ir_instruction unless
98 * there's a virtual destructor present. Because we almost
99 * universally use ralloc for our memory management of
100 * ir_instructions, the destructor doesn't need to do any work.
102 virtual ~ir_instruction()
106 /** ir_print_visitor helper for debugging. */
107 void print(void) const;
109 virtual void accept(ir_visitor
*) = 0;
110 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*) = 0;
111 virtual ir_instruction
*clone(void *mem_ctx
,
112 struct hash_table
*ht
) const = 0;
115 * \name IR instruction downcast functions
117 * These functions either cast the object to a derived class or return
118 * \c NULL if the object's type does not match the specified derived class.
119 * Additional downcast functions will be added as needed.
122 virtual class ir_variable
* as_variable() { return NULL
; }
123 virtual class ir_function
* as_function() { return NULL
; }
124 virtual class ir_dereference
* as_dereference() { return NULL
; }
125 virtual class ir_dereference_array
* as_dereference_array() { return NULL
; }
126 virtual class ir_dereference_variable
*as_dereference_variable() { return NULL
; }
127 virtual class ir_dereference_record
*as_dereference_record() { return NULL
; }
128 virtual class ir_expression
* as_expression() { return NULL
; }
129 virtual class ir_rvalue
* as_rvalue() { return NULL
; }
130 virtual class ir_loop
* as_loop() { return NULL
; }
131 virtual class ir_assignment
* as_assignment() { return NULL
; }
132 virtual class ir_call
* as_call() { return NULL
; }
133 virtual class ir_return
* as_return() { return NULL
; }
134 virtual class ir_if
* as_if() { return NULL
; }
135 virtual class ir_swizzle
* as_swizzle() { return NULL
; }
136 virtual class ir_texture
* as_texture() { return NULL
; }
137 virtual class ir_constant
* as_constant() { return NULL
; }
138 virtual class ir_discard
* as_discard() { return NULL
; }
139 virtual class ir_jump
* as_jump() { return NULL
; }
143 * IR equality method: Return true if the referenced instruction would
144 * return the same value as this one.
146 * This intended to be used for CSE and algebraic optimizations, on rvalues
147 * in particular. No support for other instruction types (assignments,
148 * jumps, calls, etc.) is planned.
150 virtual bool equals(ir_instruction
*ir
);
155 ir_type
= ir_type_unset
;
161 * The base class for all "values"/expression trees.
163 class ir_rvalue
: public ir_instruction
{
165 const struct glsl_type
*type
;
167 virtual ir_rvalue
*clone(void *mem_ctx
, struct hash_table
*) const;
169 virtual void accept(ir_visitor
*v
)
174 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
176 virtual ir_constant
*constant_expression_value(struct hash_table
*variable_context
= NULL
);
178 virtual ir_rvalue
* as_rvalue()
183 ir_rvalue
*as_rvalue_to_saturate();
185 virtual bool is_lvalue() const
191 * Get the variable that is ultimately referenced by an r-value
193 virtual ir_variable
*variable_referenced() const
200 * If an r-value is a reference to a whole variable, get that variable
203 * Pointer to a variable that is completely dereferenced by the r-value. If
204 * the r-value is not a dereference or the dereference does not access the
205 * entire variable (i.e., it's just one array element, struct field), \c NULL
208 virtual ir_variable
*whole_variable_referenced()
214 * Determine if an r-value has the value zero
216 * The base implementation of this function always returns \c false. The
217 * \c ir_constant class over-rides this function to return \c true \b only
218 * for vector and scalar types that have all elements set to the value
219 * zero (or \c false for booleans).
221 * \sa ir_constant::has_value, ir_rvalue::is_one, ir_rvalue::is_negative_one,
222 * ir_constant::is_basis
224 virtual bool is_zero() const;
227 * Determine if an r-value has the value one
229 * The base implementation of this function always returns \c false. The
230 * \c ir_constant class over-rides this function to return \c true \b only
231 * for vector and scalar types that have all elements set to the value
232 * one (or \c true for booleans).
234 * \sa ir_constant::has_value, ir_rvalue::is_zero, ir_rvalue::is_negative_one,
235 * ir_constant::is_basis
237 virtual bool is_one() const;
240 * Determine if an r-value has the value negative one
242 * The base implementation of this function always returns \c false. The
243 * \c ir_constant class over-rides this function to return \c true \b only
244 * for vector and scalar types that have all elements set to the value
245 * negative one. For boolean types, the result is always \c false.
247 * \sa ir_constant::has_value, ir_rvalue::is_zero, ir_rvalue::is_one
248 * ir_constant::is_basis
250 virtual bool is_negative_one() const;
253 * Determine if an r-value is a basis vector
255 * The base implementation of this function always returns \c false. The
256 * \c ir_constant class over-rides this function to return \c true \b only
257 * for vector and scalar types that have one element set to the value one,
258 * and the other elements set to the value zero. For boolean types, the
259 * result is always \c false.
261 * \sa ir_constant::has_value, ir_rvalue::is_zero, ir_rvalue::is_one,
262 * is_constant::is_negative_one
264 virtual bool is_basis() const;
268 * Return a generic value of error_type.
270 * Allocation will be performed with 'mem_ctx' as ralloc owner.
272 static ir_rvalue
*error_value(void *mem_ctx
);
280 * Variable storage classes
282 enum ir_variable_mode
{
283 ir_var_auto
= 0, /**< Function local variables and globals. */
284 ir_var_uniform
, /**< Variable declared as a uniform. */
289 ir_var_function_inout
,
290 ir_var_const_in
, /**< "in" param that must be a constant expression */
291 ir_var_system_value
, /**< Ex: front-face, instance-id, etc. */
292 ir_var_temporary
, /**< Temporary variable generated during compilation. */
293 ir_var_mode_count
/**< Number of variable modes */
297 * Enum keeping track of how a variable was declared. For error checking of
298 * the gl_PerVertex redeclaration rules.
300 enum ir_var_declaration_type
{
302 * Normal declaration (for most variables, this means an explicit
303 * declaration. Exception: temporaries are always implicitly declared, but
304 * they still use ir_var_declared_normally).
306 * Note: an ir_variable that represents a named interface block uses
307 * ir_var_declared_normally.
309 ir_var_declared_normally
= 0,
312 * Variable was explicitly declared (or re-declared) in an unnamed
315 ir_var_declared_in_block
,
318 * Variable is an implicitly declared built-in that has not been explicitly
319 * re-declared by the shader.
321 ir_var_declared_implicitly
,
325 * \brief Layout qualifiers for gl_FragDepth.
327 * The AMD/ARB_conservative_depth extensions allow gl_FragDepth to be redeclared
328 * with a layout qualifier.
330 enum ir_depth_layout
{
331 ir_depth_layout_none
, /**< No depth layout is specified. */
333 ir_depth_layout_greater
,
334 ir_depth_layout_less
,
335 ir_depth_layout_unchanged
339 * \brief Convert depth layout qualifier to string.
342 depth_layout_string(ir_depth_layout layout
);
345 * Description of built-in state associated with a uniform
347 * \sa ir_variable::state_slots
349 struct ir_state_slot
{
356 * Get the string value for an interpolation qualifier
358 * \return The string that would be used in a shader to specify \c
359 * mode will be returned.
361 * This function is used to generate error messages of the form "shader
362 * uses %s interpolation qualifier", so in the case where there is no
363 * interpolation qualifier, it returns "no".
365 * This function should only be used on a shader input or output variable.
367 const char *interpolation_string(unsigned interpolation
);
370 class ir_variable
: public ir_instruction
{
372 ir_variable(const struct glsl_type
*, const char *, ir_variable_mode
);
374 virtual ir_variable
*clone(void *mem_ctx
, struct hash_table
*ht
) const;
376 virtual ir_variable
*as_variable()
381 virtual void accept(ir_visitor
*v
)
386 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
390 * Determine how this variable should be interpolated based on its
391 * interpolation qualifier (if present), whether it is gl_Color or
392 * gl_SecondaryColor, and whether flatshading is enabled in the current GL
395 * The return value will always be either INTERP_QUALIFIER_SMOOTH,
396 * INTERP_QUALIFIER_NOPERSPECTIVE, or INTERP_QUALIFIER_FLAT.
398 glsl_interp_qualifier
determine_interpolation_mode(bool flat_shade
);
401 * Determine whether or not a variable is part of a uniform block.
403 inline bool is_in_uniform_block() const
405 return this->mode
== ir_var_uniform
&& this->interface_type
!= NULL
;
409 * Determine whether or not a variable is the declaration of an interface
412 * For the first declaration below, there will be an \c ir_variable named
413 * "instance" whose type and whose instance_type will be the same
414 * \cglsl_type. For the second declaration, there will be an \c ir_variable
415 * named "f" whose type is float and whose instance_type is B2.
417 * "instance" is an interface instance variable, but "f" is not.
427 inline bool is_interface_instance() const
429 const glsl_type
*const t
= this->type
;
431 return (t
== this->interface_type
)
432 || (t
->is_array() && t
->fields
.array
== this->interface_type
);
436 * Set this->interface_type on a newly created variable.
438 void init_interface_type(const struct glsl_type
*type
)
440 assert(this->interface_type
== NULL
);
441 this->interface_type
= type
;
442 if (this->is_interface_instance()) {
443 this->max_ifc_array_access
=
444 rzalloc_array(this, unsigned, type
->length
);
449 * Change this->interface_type on a variable that previously had a
450 * different, but compatible, interface_type. This is used during linking
451 * to set the size of arrays in interface blocks.
453 void change_interface_type(const struct glsl_type
*type
)
455 if (this->max_ifc_array_access
!= NULL
) {
456 /* max_ifc_array_access has already been allocated, so make sure the
457 * new interface has the same number of fields as the old one.
459 assert(this->interface_type
->length
== type
->length
);
461 this->interface_type
= type
;
465 * Change this->interface_type on a variable that previously had a
466 * different, and incompatible, interface_type. This is used during
467 * compilation to handle redeclaration of the built-in gl_PerVertex
470 void reinit_interface_type(const struct glsl_type
*type
)
472 if (this->max_ifc_array_access
!= NULL
) {
474 /* Redeclaring gl_PerVertex is only allowed if none of the built-ins
475 * it defines have been accessed yet; so it's safe to throw away the
476 * old max_ifc_array_access pointer, since all of its values are
479 for (unsigned i
= 0; i
< this->interface_type
->length
; i
++)
480 assert(this->max_ifc_array_access
[i
] == 0);
482 ralloc_free(this->max_ifc_array_access
);
483 this->max_ifc_array_access
= NULL
;
485 this->interface_type
= NULL
;
486 init_interface_type(type
);
489 const glsl_type
*get_interface_type() const
491 return this->interface_type
;
495 * Declared type of the variable
497 const struct glsl_type
*type
;
500 * Declared name of the variable
505 * Highest element accessed with a constant expression array index
507 * Not used for non-array variables.
509 unsigned max_array_access
;
512 * For variables which satisfy the is_interface_instance() predicate, this
513 * points to an array of integers such that if the ith member of the
514 * interface block is an array, max_ifc_array_access[i] is the maximum
515 * array element of that member that has been accessed. If the ith member
516 * of the interface block is not an array, max_ifc_array_access[i] is
519 * For variables whose type is not an interface block, this pointer is
522 unsigned *max_ifc_array_access
;
525 * Is the variable read-only?
527 * This is set for variables declared as \c const, shader inputs,
530 unsigned read_only
:1;
533 unsigned invariant
:1;
536 * Has this variable been used for reading or writing?
538 * Several GLSL semantic checks require knowledge of whether or not a
539 * variable has been used. For example, it is an error to redeclare a
540 * variable as invariant after it has been used.
542 * This is only maintained in the ast_to_hir.cpp path, not in
543 * Mesa's fixed function or ARB program paths.
548 * Has this variable been statically assigned?
550 * This answers whether the variable was assigned in any path of
551 * the shader during ast_to_hir. This doesn't answer whether it is
552 * still written after dead code removal, nor is it maintained in
553 * non-ast_to_hir.cpp (GLSL parsing) paths.
558 * Enum indicating how the variable was declared. See
559 * ir_var_declaration_type.
561 * This is used to detect certain kinds of illegal variable redeclarations.
563 unsigned how_declared
:2;
566 * Storage class of the variable.
568 * \sa ir_variable_mode
573 * Interpolation mode for shader inputs / outputs
575 * \sa ir_variable_interpolation
577 unsigned interpolation
:2;
580 * \name ARB_fragment_coord_conventions
583 unsigned origin_upper_left
:1;
584 unsigned pixel_center_integer
:1;
588 * Was the location explicitly set in the shader?
590 * If the location is explicitly set in the shader, it \b cannot be changed
591 * by the linker or by the API (e.g., calls to \c glBindAttribLocation have
594 unsigned explicit_location
:1;
595 unsigned explicit_index
:1;
598 * Was an initial binding explicitly set in the shader?
600 * If so, constant_value contains an integer ir_constant representing the
601 * initial binding point.
603 unsigned explicit_binding
:1;
606 * Does this variable have an initializer?
608 * This is used by the linker to cross-validiate initializers of global
611 unsigned has_initializer
:1;
614 * Is this variable a generic output or input that has not yet been matched
615 * up to a variable in another stage of the pipeline?
617 * This is used by the linker as scratch storage while assigning locations
618 * to generic inputs and outputs.
620 unsigned is_unmatched_generic_inout
:1;
623 * If non-zero, then this variable may be packed along with other variables
624 * into a single varying slot, so this offset should be applied when
625 * accessing components. For example, an offset of 1 means that the x
626 * component of this variable is actually stored in component y of the
627 * location specified by \c location.
629 unsigned location_frac
:2;
632 * Non-zero if this variable was created by lowering a named interface
633 * block which was not an array.
635 * Note that this variable and \c from_named_ifc_block_array will never
638 unsigned from_named_ifc_block_nonarray
:1;
641 * Non-zero if this variable was created by lowering a named interface
642 * block which was an array.
644 * Note that this variable and \c from_named_ifc_block_nonarray will never
647 unsigned from_named_ifc_block_array
:1;
650 * \brief Layout qualifier for gl_FragDepth.
652 * This is not equal to \c ir_depth_layout_none if and only if this
653 * variable is \c gl_FragDepth and a layout qualifier is specified.
655 ir_depth_layout depth_layout
;
658 * Storage location of the base of this variable
660 * The precise meaning of this field depends on the nature of the variable.
662 * - Vertex shader input: one of the values from \c gl_vert_attrib.
663 * - Vertex shader output: one of the values from \c gl_varying_slot.
664 * - Geometry shader input: one of the values from \c gl_varying_slot.
665 * - Geometry shader output: one of the values from \c gl_varying_slot.
666 * - Fragment shader input: one of the values from \c gl_varying_slot.
667 * - Fragment shader output: one of the values from \c gl_frag_result.
668 * - Uniforms: Per-stage uniform slot number for default uniform block.
669 * - Uniforms: Index within the uniform block definition for UBO members.
670 * - Other: This field is not currently used.
672 * If the variable is a uniform, shader input, or shader output, and the
673 * slot has not been assigned, the value will be -1.
678 * output index for dual source blending.
683 * Initial binding point for a sampler or UBO.
685 * For array types, this represents the binding point for the first element.
690 * Location an atomic counter is stored at.
693 unsigned buffer_index
;
698 * Built-in state that backs this uniform
700 * Once set at variable creation, \c state_slots must remain invariant.
701 * This is because, ideally, this array would be shared by all clones of
702 * this variable in the IR tree. In other words, we'd really like for it
703 * to be a fly-weight.
705 * If the variable is not a uniform, \c num_state_slots will be zero and
706 * \c state_slots will be \c NULL.
709 unsigned num_state_slots
; /**< Number of state slots used */
710 ir_state_slot
*state_slots
; /**< State descriptors. */
714 * Emit a warning if this variable is accessed.
716 const char *warn_extension
;
719 * Value assigned in the initializer of a variable declared "const"
721 ir_constant
*constant_value
;
724 * Constant expression assigned in the initializer of the variable
727 * This field and \c ::constant_value are distinct. Even if the two fields
728 * refer to constants with the same value, they must point to separate
731 ir_constant
*constant_initializer
;
735 * For variables that are in an interface block or are an instance of an
736 * interface block, this is the \c GLSL_TYPE_INTERFACE type for that block.
738 * \sa ir_variable::location
740 const glsl_type
*interface_type
;
744 * A function that returns whether a built-in function is available in the
745 * current shading language (based on version, ES or desktop, and extensions).
747 typedef bool (*builtin_available_predicate
)(const _mesa_glsl_parse_state
*);
751 * The representation of a function instance; may be the full definition or
752 * simply a prototype.
754 class ir_function_signature
: public ir_instruction
{
755 /* An ir_function_signature will be part of the list of signatures in
759 ir_function_signature(const glsl_type
*return_type
,
760 builtin_available_predicate builtin_avail
= NULL
);
762 virtual ir_function_signature
*clone(void *mem_ctx
,
763 struct hash_table
*ht
) const;
764 ir_function_signature
*clone_prototype(void *mem_ctx
,
765 struct hash_table
*ht
) const;
767 virtual void accept(ir_visitor
*v
)
772 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
775 * Attempt to evaluate this function as a constant expression,
776 * given a list of the actual parameters and the variable context.
777 * Returns NULL for non-built-ins.
779 ir_constant
*constant_expression_value(exec_list
*actual_parameters
, struct hash_table
*variable_context
);
782 * Get the name of the function for which this is a signature
784 const char *function_name() const;
787 * Get a handle to the function for which this is a signature
789 * There is no setter function, this function returns a \c const pointer,
790 * and \c ir_function_signature::_function is private for a reason. The
791 * only way to make a connection between a function and function signature
792 * is via \c ir_function::add_signature. This helps ensure that certain
793 * invariants (i.e., a function signature is in the list of signatures for
794 * its \c _function) are met.
796 * \sa ir_function::add_signature
798 inline const class ir_function
*function() const
800 return this->_function
;
804 * Check whether the qualifiers match between this signature's parameters
805 * and the supplied parameter list. If not, returns the name of the first
806 * parameter with mismatched qualifiers (for use in error messages).
808 const char *qualifiers_match(exec_list
*params
);
811 * Replace the current parameter list with the given one. This is useful
812 * if the current information came from a prototype, and either has invalid
813 * or missing parameter names.
815 void replace_parameters(exec_list
*new_params
);
818 * Function return type.
820 * \note This discards the optional precision qualifier.
822 const struct glsl_type
*return_type
;
825 * List of ir_variable of function parameters.
827 * This represents the storage. The paramaters passed in a particular
828 * call will be in ir_call::actual_paramaters.
830 struct exec_list parameters
;
832 /** Whether or not this function has a body (which may be empty). */
833 unsigned is_defined
:1;
835 /** Whether or not this function signature is a built-in. */
836 bool is_builtin() const;
839 * Whether or not this function is an intrinsic to be implemented
844 /** Whether or not a built-in is available for this shader. */
845 bool is_builtin_available(const _mesa_glsl_parse_state
*state
) const;
847 /** Body of instructions in the function. */
848 struct exec_list body
;
852 * A function pointer to a predicate that answers whether a built-in
853 * function is available in the current shader. NULL if not a built-in.
855 builtin_available_predicate builtin_avail
;
857 /** Function of which this signature is one overload. */
858 class ir_function
*_function
;
860 /** Function signature of which this one is a prototype clone */
861 const ir_function_signature
*origin
;
863 friend class ir_function
;
866 * Helper function to run a list of instructions for constant
867 * expression evaluation.
869 * The hash table represents the values of the visible variables.
870 * There are no scoping issues because the table is indexed on
871 * ir_variable pointers, not variable names.
873 * Returns false if the expression is not constant, true otherwise,
874 * and the value in *result if result is non-NULL.
876 bool constant_expression_evaluate_expression_list(const struct exec_list
&body
,
877 struct hash_table
*variable_context
,
878 ir_constant
**result
);
883 * Header for tracking multiple overloaded functions with the same name.
884 * Contains a list of ir_function_signatures representing each of the
887 class ir_function
: public ir_instruction
{
889 ir_function(const char *name
);
891 virtual ir_function
*clone(void *mem_ctx
, struct hash_table
*ht
) const;
893 virtual ir_function
*as_function()
898 virtual void accept(ir_visitor
*v
)
903 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
905 void add_signature(ir_function_signature
*sig
)
907 sig
->_function
= this;
908 this->signatures
.push_tail(sig
);
912 * Get an iterator for the set of function signatures
914 exec_list_iterator
iterator()
916 return signatures
.iterator();
920 * Find a signature that matches a set of actual parameters, taking implicit
921 * conversions into account. Also flags whether the match was exact.
923 ir_function_signature
*matching_signature(_mesa_glsl_parse_state
*state
,
924 const exec_list
*actual_param
,
925 bool *match_is_exact
);
928 * Find a signature that matches a set of actual parameters, taking implicit
929 * conversions into account.
931 ir_function_signature
*matching_signature(_mesa_glsl_parse_state
*state
,
932 const exec_list
*actual_param
);
935 * Find a signature that exactly matches a set of actual parameters without
936 * any implicit type conversions.
938 ir_function_signature
*exact_matching_signature(_mesa_glsl_parse_state
*state
,
939 const exec_list
*actual_ps
);
942 * Name of the function.
946 /** Whether or not this function has a signature that isn't a built-in. */
947 bool has_user_signature();
950 * List of ir_function_signature for each overloaded function with this name.
952 struct exec_list signatures
;
955 inline const char *ir_function_signature::function_name() const
957 return this->_function
->name
;
963 * IR instruction representing high-level if-statements
965 class ir_if
: public ir_instruction
{
967 ir_if(ir_rvalue
*condition
)
968 : condition(condition
)
970 ir_type
= ir_type_if
;
973 virtual ir_if
*clone(void *mem_ctx
, struct hash_table
*ht
) const;
975 virtual ir_if
*as_if()
980 virtual void accept(ir_visitor
*v
)
985 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
987 ir_rvalue
*condition
;
988 /** List of ir_instruction for the body of the then branch */
989 exec_list then_instructions
;
990 /** List of ir_instruction for the body of the else branch */
991 exec_list else_instructions
;
996 * IR instruction representing a high-level loop structure.
998 class ir_loop
: public ir_instruction
{
1002 virtual ir_loop
*clone(void *mem_ctx
, struct hash_table
*ht
) const;
1004 virtual void accept(ir_visitor
*v
)
1009 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1011 virtual ir_loop
*as_loop()
1017 * Get an iterator for the instructions of the loop body
1019 exec_list_iterator
iterator()
1021 return body_instructions
.iterator();
1024 /** List of ir_instruction that make up the body of the loop. */
1025 exec_list body_instructions
;
1028 * \name Loop counter and controls
1030 * Represents a loop like a FORTRAN \c do-loop.
1033 * If \c from and \c to are the same value, the loop will execute once.
1038 * Value which should be assigned to \c counter before the first iteration
1039 * of the loop. Must be non-null whenever \c counter is non-null, and vice
1045 * Value which \c counter should be compared to in order to determine
1046 * whether to exit the loop. Must be non-null whenever \c counter is
1047 * non-null, and vice versa.
1052 * Value which should be added to \c counter at the end of each loop
1053 * iteration. Must be non-null whenever \c counter is non-null, and vice
1056 ir_rvalue
*increment
;
1059 * Variable which counts loop iterations. This is a brand new ir_variable
1060 * declaration (not a reference to a previously declared ir_variable, as in
1061 * ir_dereference_variable).
1063 ir_variable
*counter
;
1066 * Comparison operation in the loop terminator.
1068 * If any of the loop control fields are non-\c NULL, this field must be
1069 * one of \c ir_binop_less, \c ir_binop_greater, \c ir_binop_lequal,
1070 * \c ir_binop_gequal, \c ir_binop_equal, or \c ir_binop_nequal.
1072 * Ignored if \c counter is NULL.
1079 class ir_assignment
: public ir_instruction
{
1081 ir_assignment(ir_rvalue
*lhs
, ir_rvalue
*rhs
, ir_rvalue
*condition
= NULL
);
1084 * Construct an assignment with an explicit write mask
1087 * Since a write mask is supplied, the LHS must already be a bare
1088 * \c ir_dereference. The cannot be any swizzles in the LHS.
1090 ir_assignment(ir_dereference
*lhs
, ir_rvalue
*rhs
, ir_rvalue
*condition
,
1091 unsigned write_mask
);
1093 virtual ir_assignment
*clone(void *mem_ctx
, struct hash_table
*ht
) const;
1095 virtual ir_constant
*constant_expression_value(struct hash_table
*variable_context
= NULL
);
1097 virtual void accept(ir_visitor
*v
)
1102 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1104 virtual ir_assignment
* as_assignment()
1110 * Get a whole variable written by an assignment
1112 * If the LHS of the assignment writes a whole variable, the variable is
1113 * returned. Otherwise \c NULL is returned. Examples of whole-variable
1116 * - Assigning to a scalar
1117 * - Assigning to all components of a vector
1118 * - Whole array (or matrix) assignment
1119 * - Whole structure assignment
1121 ir_variable
*whole_variable_written();
1124 * Set the LHS of an assignment
1126 void set_lhs(ir_rvalue
*lhs
);
1129 * Left-hand side of the assignment.
1131 * This should be treated as read only. If you need to set the LHS of an
1132 * assignment, use \c ir_assignment::set_lhs.
1134 ir_dereference
*lhs
;
1137 * Value being assigned
1142 * Optional condition for the assignment.
1144 ir_rvalue
*condition
;
1148 * Component mask written
1150 * For non-vector types in the LHS, this field will be zero. For vector
1151 * types, a bit will be set for each component that is written. Note that
1152 * for \c vec2 and \c vec3 types only the lower bits will ever be set.
1154 * A partially-set write mask means that each enabled channel gets
1155 * the value from a consecutive channel of the rhs. For example,
1156 * to write just .xyw of gl_FrontColor with color:
1158 * (assign (constant bool (1)) (xyw)
1159 * (var_ref gl_FragColor)
1160 * (swiz xyw (var_ref color)))
1162 unsigned write_mask
:4;
1165 /* Update ir_expression::get_num_operands() and operator_strs when
1166 * updating this list.
1168 enum ir_expression_operation
{
1177 ir_unop_exp
, /**< Log base e on gentype */
1178 ir_unop_log
, /**< Natural log on gentype */
1181 ir_unop_f2i
, /**< Float-to-integer conversion. */
1182 ir_unop_f2u
, /**< Float-to-unsigned conversion. */
1183 ir_unop_i2f
, /**< Integer-to-float conversion. */
1184 ir_unop_f2b
, /**< Float-to-boolean conversion */
1185 ir_unop_b2f
, /**< Boolean-to-float conversion */
1186 ir_unop_i2b
, /**< int-to-boolean conversion */
1187 ir_unop_b2i
, /**< Boolean-to-int conversion */
1188 ir_unop_u2f
, /**< Unsigned-to-float conversion. */
1189 ir_unop_i2u
, /**< Integer-to-unsigned conversion. */
1190 ir_unop_u2i
, /**< Unsigned-to-integer conversion. */
1191 ir_unop_bitcast_i2f
, /**< Bit-identical int-to-float "conversion" */
1192 ir_unop_bitcast_f2i
, /**< Bit-identical float-to-int "conversion" */
1193 ir_unop_bitcast_u2f
, /**< Bit-identical uint-to-float "conversion" */
1194 ir_unop_bitcast_f2u
, /**< Bit-identical float-to-uint "conversion" */
1198 * \name Unary floating-point rounding operations.
1209 * \name Trigonometric operations.
1214 ir_unop_sin_reduced
, /**< Reduced range sin. [-pi, pi] */
1215 ir_unop_cos_reduced
, /**< Reduced range cos. [-pi, pi] */
1219 * \name Partial derivatives.
1227 * \name Floating point pack and unpack operations.
1230 ir_unop_pack_snorm_2x16
,
1231 ir_unop_pack_snorm_4x8
,
1232 ir_unop_pack_unorm_2x16
,
1233 ir_unop_pack_unorm_4x8
,
1234 ir_unop_pack_half_2x16
,
1235 ir_unop_unpack_snorm_2x16
,
1236 ir_unop_unpack_snorm_4x8
,
1237 ir_unop_unpack_unorm_2x16
,
1238 ir_unop_unpack_unorm_4x8
,
1239 ir_unop_unpack_half_2x16
,
1243 * \name Lowered floating point unpacking operations.
1245 * \see lower_packing_builtins_visitor::split_unpack_half_2x16
1248 ir_unop_unpack_half_2x16_split_x
,
1249 ir_unop_unpack_half_2x16_split_y
,
1253 * \name Bit operations, part of ARB_gpu_shader5.
1256 ir_unop_bitfield_reverse
,
1265 * A sentinel marking the last of the unary operations.
1267 ir_last_unop
= ir_unop_noise
,
1271 ir_binop_mul
, /**< Floating-point or low 32-bit integer multiply. */
1272 ir_binop_imul_high
, /**< Calculates the high 32-bits of a 64-bit multiply. */
1276 * Returns the carry resulting from the addition of the two arguments.
1283 * Returns the borrow resulting from the subtraction of the second argument
1284 * from the first argument.
1291 * Takes one of two combinations of arguments:
1294 * - mod(vecN, float)
1296 * Does not take integer types.
1301 * \name Binary comparison operators which return a boolean vector.
1302 * The type of both operands must be equal.
1312 * Returns single boolean for whether all components of operands[0]
1313 * equal the components of operands[1].
1317 * Returns single boolean for whether any component of operands[0]
1318 * is not equal to the corresponding component of operands[1].
1320 ir_binop_any_nequal
,
1324 * \name Bit-wise binary operations.
1345 * \name Lowered floating point packing operations.
1347 * \see lower_packing_builtins_visitor::split_pack_half_2x16
1350 ir_binop_pack_half_2x16_split
,
1354 * \name First half of a lowered bitfieldInsert() operation.
1356 * \see lower_instructions::bitfield_insert_to_bfm_bfi
1363 * Load a value the size of a given GLSL type from a uniform block.
1365 * operand0 is the ir_constant uniform block index in the linked shader.
1366 * operand1 is a byte offset within the uniform block.
1371 * \name Multiplies a number by two to a power, part of ARB_gpu_shader5.
1378 * Extract a scalar from a vector
1380 * operand0 is the vector
1381 * operand1 is the index of the field to read from operand0
1383 ir_binop_vector_extract
,
1386 * A sentinel marking the last of the binary operations.
1388 ir_last_binop
= ir_binop_vector_extract
,
1391 * \name Fused floating-point multiply-add, part of ARB_gpu_shader5.
1400 * \name Conditional Select
1402 * A vector conditional select instruction (like ?:, but operating per-
1403 * component on vectors).
1405 * \see lower_instructions_visitor::ldexp_to_arith
1412 * \name Second half of a lowered bitfieldInsert() operation.
1414 * \see lower_instructions::bitfield_insert_to_bfm_bfi
1420 ir_triop_bitfield_extract
,
1423 * Generate a value with one field of a vector changed
1425 * operand0 is the vector
1426 * operand1 is the value to write into the vector result
1427 * operand2 is the index in operand0 to be modified
1429 ir_triop_vector_insert
,
1432 * A sentinel marking the last of the ternary operations.
1434 ir_last_triop
= ir_triop_vector_insert
,
1436 ir_quadop_bitfield_insert
,
1441 * A sentinel marking the last of the ternary operations.
1443 ir_last_quadop
= ir_quadop_vector
,
1446 * A sentinel marking the last of all operations.
1448 ir_last_opcode
= ir_quadop_vector
1451 class ir_expression
: public ir_rvalue
{
1453 ir_expression(int op
, const struct glsl_type
*type
,
1454 ir_rvalue
*op0
, ir_rvalue
*op1
= NULL
,
1455 ir_rvalue
*op2
= NULL
, ir_rvalue
*op3
= NULL
);
1458 * Constructor for unary operation expressions
1460 ir_expression(int op
, ir_rvalue
*);
1463 * Constructor for binary operation expressions
1465 ir_expression(int op
, ir_rvalue
*op0
, ir_rvalue
*op1
);
1468 * Constructor for ternary operation expressions
1470 ir_expression(int op
, ir_rvalue
*op0
, ir_rvalue
*op1
, ir_rvalue
*op2
);
1472 virtual ir_expression
*as_expression()
1477 virtual bool equals(ir_instruction
*ir
);
1479 virtual ir_expression
*clone(void *mem_ctx
, struct hash_table
*ht
) const;
1482 * Attempt to constant-fold the expression
1484 * The "variable_context" hash table links ir_variable * to ir_constant *
1485 * that represent the variables' values. \c NULL represents an empty
1488 * If the expression cannot be constant folded, this method will return
1491 virtual ir_constant
*constant_expression_value(struct hash_table
*variable_context
= NULL
);
1494 * Determine the number of operands used by an expression
1496 static unsigned int get_num_operands(ir_expression_operation
);
1499 * Determine the number of operands used by an expression
1501 unsigned int get_num_operands() const
1503 return (this->operation
== ir_quadop_vector
)
1504 ? this->type
->vector_elements
: get_num_operands(operation
);
1508 * Return a string representing this expression's operator.
1510 const char *operator_string();
1513 * Return a string representing this expression's operator.
1515 static const char *operator_string(ir_expression_operation
);
1519 * Do a reverse-lookup to translate the given string into an operator.
1521 static ir_expression_operation
get_operator(const char *);
1523 virtual void accept(ir_visitor
*v
)
1528 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1530 ir_expression_operation operation
;
1531 ir_rvalue
*operands
[4];
1536 * HIR instruction representing a high-level function call, containing a list
1537 * of parameters and returning a value in the supplied temporary.
1539 class ir_call
: public ir_instruction
{
1541 ir_call(ir_function_signature
*callee
,
1542 ir_dereference_variable
*return_deref
,
1543 exec_list
*actual_parameters
)
1544 : return_deref(return_deref
), callee(callee
)
1546 ir_type
= ir_type_call
;
1547 assert(callee
->return_type
!= NULL
);
1548 actual_parameters
->move_nodes_to(& this->actual_parameters
);
1549 this->use_builtin
= callee
->is_builtin();
1552 virtual ir_call
*clone(void *mem_ctx
, struct hash_table
*ht
) const;
1554 virtual ir_constant
*constant_expression_value(struct hash_table
*variable_context
= NULL
);
1556 virtual ir_call
*as_call()
1561 virtual void accept(ir_visitor
*v
)
1566 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1569 * Get an iterator for the set of acutal parameters
1571 exec_list_iterator
iterator()
1573 return actual_parameters
.iterator();
1577 * Get the name of the function being called.
1579 const char *callee_name() const
1581 return callee
->function_name();
1585 * Generates an inline version of the function before @ir,
1586 * storing the return value in return_deref.
1588 void generate_inline(ir_instruction
*ir
);
1591 * Storage for the function's return value.
1592 * This must be NULL if the return type is void.
1594 ir_dereference_variable
*return_deref
;
1597 * The specific function signature being called.
1599 ir_function_signature
*callee
;
1601 /* List of ir_rvalue of paramaters passed in this call. */
1602 exec_list actual_parameters
;
1604 /** Should this call only bind to a built-in function? */
1610 * \name Jump-like IR instructions.
1612 * These include \c break, \c continue, \c return, and \c discard.
1615 class ir_jump
: public ir_instruction
{
1619 ir_type
= ir_type_unset
;
1623 virtual ir_jump
*as_jump()
1629 class ir_return
: public ir_jump
{
1634 this->ir_type
= ir_type_return
;
1637 ir_return(ir_rvalue
*value
)
1640 this->ir_type
= ir_type_return
;
1643 virtual ir_return
*clone(void *mem_ctx
, struct hash_table
*) const;
1645 virtual ir_return
*as_return()
1650 ir_rvalue
*get_value() const
1655 virtual void accept(ir_visitor
*v
)
1660 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1667 * Jump instructions used inside loops
1669 * These include \c break and \c continue. The \c break within a loop is
1670 * different from the \c break within a switch-statement.
1672 * \sa ir_switch_jump
1674 class ir_loop_jump
: public ir_jump
{
1681 ir_loop_jump(jump_mode mode
)
1683 this->ir_type
= ir_type_loop_jump
;
1687 virtual ir_loop_jump
*clone(void *mem_ctx
, struct hash_table
*) const;
1689 virtual void accept(ir_visitor
*v
)
1694 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1696 bool is_break() const
1698 return mode
== jump_break
;
1701 bool is_continue() const
1703 return mode
== jump_continue
;
1706 /** Mode selector for the jump instruction. */
1707 enum jump_mode mode
;
1711 * IR instruction representing discard statements.
1713 class ir_discard
: public ir_jump
{
1717 this->ir_type
= ir_type_discard
;
1718 this->condition
= NULL
;
1721 ir_discard(ir_rvalue
*cond
)
1723 this->ir_type
= ir_type_discard
;
1724 this->condition
= cond
;
1727 virtual ir_discard
*clone(void *mem_ctx
, struct hash_table
*ht
) const;
1729 virtual void accept(ir_visitor
*v
)
1734 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1736 virtual ir_discard
*as_discard()
1741 ir_rvalue
*condition
;
1747 * Texture sampling opcodes used in ir_texture
1749 enum ir_texture_opcode
{
1750 ir_tex
, /**< Regular texture look-up */
1751 ir_txb
, /**< Texture look-up with LOD bias */
1752 ir_txl
, /**< Texture look-up with explicit LOD */
1753 ir_txd
, /**< Texture look-up with partial derivatvies */
1754 ir_txf
, /**< Texel fetch with explicit LOD */
1755 ir_txf_ms
, /**< Multisample texture fetch */
1756 ir_txs
, /**< Texture size */
1757 ir_lod
, /**< Texture lod query */
1758 ir_tg4
, /**< Texture gather */
1759 ir_query_levels
/**< Texture levels query */
1764 * IR instruction to sample a texture
1766 * The specific form of the IR instruction depends on the \c mode value
1767 * selected from \c ir_texture_opcodes. In the printed IR, these will
1770 * Texel offset (0 or an expression)
1771 * | Projection divisor
1772 * | | Shadow comparitor
1775 * (tex <type> <sampler> <coordinate> 0 1 ( ))
1776 * (txb <type> <sampler> <coordinate> 0 1 ( ) <bias>)
1777 * (txl <type> <sampler> <coordinate> 0 1 ( ) <lod>)
1778 * (txd <type> <sampler> <coordinate> 0 1 ( ) (dPdx dPdy))
1779 * (txf <type> <sampler> <coordinate> 0 <lod>)
1781 * <type> <sampler> <coordinate> <sample_index>)
1782 * (txs <type> <sampler> <lod>)
1783 * (lod <type> <sampler> <coordinate>)
1784 * (tg4 <type> <sampler> <coordinate> <offset> <component>)
1785 * (query_levels <type> <sampler>)
1787 class ir_texture
: public ir_rvalue
{
1789 ir_texture(enum ir_texture_opcode op
)
1790 : op(op
), sampler(NULL
), coordinate(NULL
), projector(NULL
),
1791 shadow_comparitor(NULL
), offset(NULL
)
1793 this->ir_type
= ir_type_texture
;
1794 memset(&lod_info
, 0, sizeof(lod_info
));
1797 virtual ir_texture
*clone(void *mem_ctx
, struct hash_table
*) const;
1799 virtual ir_constant
*constant_expression_value(struct hash_table
*variable_context
= NULL
);
1801 virtual void accept(ir_visitor
*v
)
1806 virtual ir_texture
*as_texture()
1811 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1813 virtual bool equals(ir_instruction
*ir
);
1816 * Return a string representing the ir_texture_opcode.
1818 const char *opcode_string();
1820 /** Set the sampler and type. */
1821 void set_sampler(ir_dereference
*sampler
, const glsl_type
*type
);
1824 * Do a reverse-lookup to translate a string into an ir_texture_opcode.
1826 static ir_texture_opcode
get_opcode(const char *);
1828 enum ir_texture_opcode op
;
1830 /** Sampler to use for the texture access. */
1831 ir_dereference
*sampler
;
1833 /** Texture coordinate to sample */
1834 ir_rvalue
*coordinate
;
1837 * Value used for projective divide.
1839 * If there is no projective divide (the common case), this will be
1840 * \c NULL. Optimization passes should check for this to point to a constant
1841 * of 1.0 and replace that with \c NULL.
1843 ir_rvalue
*projector
;
1846 * Coordinate used for comparison on shadow look-ups.
1848 * If there is no shadow comparison, this will be \c NULL. For the
1849 * \c ir_txf opcode, this *must* be \c NULL.
1851 ir_rvalue
*shadow_comparitor
;
1853 /** Texel offset. */
1857 ir_rvalue
*lod
; /**< Floating point LOD */
1858 ir_rvalue
*bias
; /**< Floating point LOD bias */
1859 ir_rvalue
*sample_index
; /**< MSAA sample index */
1860 ir_rvalue
*component
; /**< Gather component selector */
1862 ir_rvalue
*dPdx
; /**< Partial derivative of coordinate wrt X */
1863 ir_rvalue
*dPdy
; /**< Partial derivative of coordinate wrt Y */
1869 struct ir_swizzle_mask
{
1876 * Number of components in the swizzle.
1878 unsigned num_components
:3;
1881 * Does the swizzle contain duplicate components?
1883 * L-value swizzles cannot contain duplicate components.
1885 unsigned has_duplicates
:1;
1889 class ir_swizzle
: public ir_rvalue
{
1891 ir_swizzle(ir_rvalue
*, unsigned x
, unsigned y
, unsigned z
, unsigned w
,
1894 ir_swizzle(ir_rvalue
*val
, const unsigned *components
, unsigned count
);
1896 ir_swizzle(ir_rvalue
*val
, ir_swizzle_mask mask
);
1898 virtual ir_swizzle
*clone(void *mem_ctx
, struct hash_table
*) const;
1900 virtual ir_constant
*constant_expression_value(struct hash_table
*variable_context
= NULL
);
1902 virtual ir_swizzle
*as_swizzle()
1908 * Construct an ir_swizzle from the textual representation. Can fail.
1910 static ir_swizzle
*create(ir_rvalue
*, const char *, unsigned vector_length
);
1912 virtual void accept(ir_visitor
*v
)
1917 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1919 virtual bool equals(ir_instruction
*ir
);
1921 bool is_lvalue() const
1923 return val
->is_lvalue() && !mask
.has_duplicates
;
1927 * Get the variable that is ultimately referenced by an r-value
1929 virtual ir_variable
*variable_referenced() const;
1932 ir_swizzle_mask mask
;
1936 * Initialize the mask component of a swizzle
1938 * This is used by the \c ir_swizzle constructors.
1940 void init_mask(const unsigned *components
, unsigned count
);
1944 class ir_dereference
: public ir_rvalue
{
1946 virtual ir_dereference
*clone(void *mem_ctx
, struct hash_table
*) const = 0;
1948 virtual ir_dereference
*as_dereference()
1953 bool is_lvalue() const;
1956 * Get the variable that is ultimately referenced by an r-value
1958 virtual ir_variable
*variable_referenced() const = 0;
1961 * Get the constant that is ultimately referenced by an r-value,
1962 * in a constant expression evaluation context.
1964 * The offset is used when the reference is to a specific column of
1967 virtual void constant_referenced(struct hash_table
*variable_context
, ir_constant
*&store
, int &offset
) const = 0;
1971 class ir_dereference_variable
: public ir_dereference
{
1973 ir_dereference_variable(ir_variable
*var
);
1975 virtual ir_dereference_variable
*clone(void *mem_ctx
,
1976 struct hash_table
*) const;
1978 virtual ir_constant
*constant_expression_value(struct hash_table
*variable_context
= NULL
);
1980 virtual ir_dereference_variable
*as_dereference_variable()
1985 virtual bool equals(ir_instruction
*ir
);
1988 * Get the variable that is ultimately referenced by an r-value
1990 virtual ir_variable
*variable_referenced() const
1996 * Get the constant that is ultimately referenced by an r-value,
1997 * in a constant expression evaluation context.
1999 * The offset is used when the reference is to a specific column of
2002 virtual void constant_referenced(struct hash_table
*variable_context
, ir_constant
*&store
, int &offset
) const;
2004 virtual ir_variable
*whole_variable_referenced()
2006 /* ir_dereference_variable objects always dereference the entire
2007 * variable. However, if this dereference is dereferenced by anything
2008 * else, the complete deferefernce chain is not a whole-variable
2009 * dereference. This method should only be called on the top most
2010 * ir_rvalue in a dereference chain.
2015 virtual void accept(ir_visitor
*v
)
2020 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
2023 * Object being dereferenced.
2029 class ir_dereference_array
: public ir_dereference
{
2031 ir_dereference_array(ir_rvalue
*value
, ir_rvalue
*array_index
);
2033 ir_dereference_array(ir_variable
*var
, ir_rvalue
*array_index
);
2035 virtual ir_dereference_array
*clone(void *mem_ctx
,
2036 struct hash_table
*) const;
2038 virtual ir_constant
*constant_expression_value(struct hash_table
*variable_context
= NULL
);
2040 virtual ir_dereference_array
*as_dereference_array()
2045 virtual bool equals(ir_instruction
*ir
);
2048 * Get the variable that is ultimately referenced by an r-value
2050 virtual ir_variable
*variable_referenced() const
2052 return this->array
->variable_referenced();
2056 * Get the constant that is ultimately referenced by an r-value,
2057 * in a constant expression evaluation context.
2059 * The offset is used when the reference is to a specific column of
2062 virtual void constant_referenced(struct hash_table
*variable_context
, ir_constant
*&store
, int &offset
) const;
2064 virtual void accept(ir_visitor
*v
)
2069 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
2072 ir_rvalue
*array_index
;
2075 void set_array(ir_rvalue
*value
);
2079 class ir_dereference_record
: public ir_dereference
{
2081 ir_dereference_record(ir_rvalue
*value
, const char *field
);
2083 ir_dereference_record(ir_variable
*var
, const char *field
);
2085 virtual ir_dereference_record
*clone(void *mem_ctx
,
2086 struct hash_table
*) const;
2088 virtual ir_constant
*constant_expression_value(struct hash_table
*variable_context
= NULL
);
2090 virtual ir_dereference_record
*as_dereference_record()
2096 * Get the variable that is ultimately referenced by an r-value
2098 virtual ir_variable
*variable_referenced() const
2100 return this->record
->variable_referenced();
2104 * Get the constant that is ultimately referenced by an r-value,
2105 * in a constant expression evaluation context.
2107 * The offset is used when the reference is to a specific column of
2110 virtual void constant_referenced(struct hash_table
*variable_context
, ir_constant
*&store
, int &offset
) const;
2112 virtual void accept(ir_visitor
*v
)
2117 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
2125 * Data stored in an ir_constant
2127 union ir_constant_data
{
2135 class ir_constant
: public ir_rvalue
{
2137 ir_constant(const struct glsl_type
*type
, const ir_constant_data
*data
);
2138 ir_constant(bool b
, unsigned vector_elements
=1);
2139 ir_constant(unsigned int u
, unsigned vector_elements
=1);
2140 ir_constant(int i
, unsigned vector_elements
=1);
2141 ir_constant(float f
, unsigned vector_elements
=1);
2144 * Construct an ir_constant from a list of ir_constant values
2146 ir_constant(const struct glsl_type
*type
, exec_list
*values
);
2149 * Construct an ir_constant from a scalar component of another ir_constant
2151 * The new \c ir_constant inherits the type of the component from the
2155 * In the case of a matrix constant, the new constant is a scalar, \b not
2158 ir_constant(const ir_constant
*c
, unsigned i
);
2161 * Return a new ir_constant of the specified type containing all zeros.
2163 static ir_constant
*zero(void *mem_ctx
, const glsl_type
*type
);
2165 virtual ir_constant
*clone(void *mem_ctx
, struct hash_table
*) const;
2167 virtual ir_constant
*constant_expression_value(struct hash_table
*variable_context
= NULL
);
2169 virtual ir_constant
*as_constant()
2174 virtual void accept(ir_visitor
*v
)
2179 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
2181 virtual bool equals(ir_instruction
*ir
);
2184 * Get a particular component of a constant as a specific type
2186 * This is useful, for example, to get a value from an integer constant
2187 * as a float or bool. This appears frequently when constructors are
2188 * called with all constant parameters.
2191 bool get_bool_component(unsigned i
) const;
2192 float get_float_component(unsigned i
) const;
2193 int get_int_component(unsigned i
) const;
2194 unsigned get_uint_component(unsigned i
) const;
2197 ir_constant
*get_array_element(unsigned i
) const;
2199 ir_constant
*get_record_field(const char *name
);
2202 * Copy the values on another constant at a given offset.
2204 * The offset is ignored for array or struct copies, it's only for
2205 * scalars or vectors into vectors or matrices.
2207 * With identical types on both sides and zero offset it's clone()
2208 * without creating a new object.
2211 void copy_offset(ir_constant
*src
, int offset
);
2214 * Copy the values on another constant at a given offset and
2215 * following an assign-like mask.
2217 * The mask is ignored for scalars.
2219 * Note that this function only handles what assign can handle,
2220 * i.e. at most a vector as source and a column of a matrix as
2224 void copy_masked_offset(ir_constant
*src
, int offset
, unsigned int mask
);
2227 * Determine whether a constant has the same value as another constant
2229 * \sa ir_constant::is_zero, ir_constant::is_one,
2230 * ir_constant::is_negative_one, ir_constant::is_basis
2232 bool has_value(const ir_constant
*) const;
2234 virtual bool is_zero() const;
2235 virtual bool is_one() const;
2236 virtual bool is_negative_one() const;
2237 virtual bool is_basis() const;
2240 * Value of the constant.
2242 * The field used to back the values supplied by the constant is determined
2243 * by the type associated with the \c ir_instruction. Constants may be
2244 * scalars, vectors, or matrices.
2246 union ir_constant_data value
;
2248 /* Array elements */
2249 ir_constant
**array_elements
;
2251 /* Structure fields */
2252 exec_list components
;
2256 * Parameterless constructor only used by the clone method
2264 * IR instruction to emit a vertex in a geometry shader.
2266 class ir_emit_vertex
: public ir_instruction
{
2270 ir_type
= ir_type_emit_vertex
;
2273 virtual void accept(ir_visitor
*v
)
2278 virtual ir_emit_vertex
*clone(void *mem_ctx
, struct hash_table
*) const
2280 return new(mem_ctx
) ir_emit_vertex();
2283 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
2287 * IR instruction to complete the current primitive and start a new one in a
2290 class ir_end_primitive
: public ir_instruction
{
2294 ir_type
= ir_type_end_primitive
;
2297 virtual void accept(ir_visitor
*v
)
2302 virtual ir_end_primitive
*clone(void *mem_ctx
, struct hash_table
*) const
2304 return new(mem_ctx
) ir_end_primitive();
2307 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
2311 * Apply a visitor to each IR node in a list
2314 visit_exec_list(exec_list
*list
, ir_visitor
*visitor
);
2317 * Validate invariants on each IR node in a list
2319 void validate_ir_tree(exec_list
*instructions
);
2321 struct _mesa_glsl_parse_state
;
2322 struct gl_shader_program
;
2325 * Detect whether an unlinked shader contains static recursion
2327 * If the list of instructions is determined to contain static recursion,
2328 * \c _mesa_glsl_error will be called to emit error messages for each function
2329 * that is in the recursion cycle.
2332 detect_recursion_unlinked(struct _mesa_glsl_parse_state
*state
,
2333 exec_list
*instructions
);
2336 * Detect whether a linked shader contains static recursion
2338 * If the list of instructions is determined to contain static recursion,
2339 * \c link_error_printf will be called to emit error messages for each function
2340 * that is in the recursion cycle. In addition,
2341 * \c gl_shader_program::LinkStatus will be set to false.
2344 detect_recursion_linked(struct gl_shader_program
*prog
,
2345 exec_list
*instructions
);
2348 * Make a clone of each IR instruction in a list
2350 * \param in List of IR instructions that are to be cloned
2351 * \param out List to hold the cloned instructions
2354 clone_ir_list(void *mem_ctx
, exec_list
*out
, const exec_list
*in
);
2357 _mesa_glsl_initialize_variables(exec_list
*instructions
,
2358 struct _mesa_glsl_parse_state
*state
);
2361 _mesa_glsl_initialize_functions(_mesa_glsl_parse_state
*state
);
2364 _mesa_glsl_initialize_builtin_functions();
2366 extern ir_function_signature
*
2367 _mesa_glsl_find_builtin_function(_mesa_glsl_parse_state
*state
,
2368 const char *name
, exec_list
*actual_parameters
);
2371 _mesa_glsl_get_builtin_function_shader(void);
2374 _mesa_glsl_release_functions(void);
2377 _mesa_glsl_release_builtin_functions(void);
2380 reparent_ir(exec_list
*list
, void *mem_ctx
);
2382 struct glsl_symbol_table
;
2385 import_prototypes(const exec_list
*source
, exec_list
*dest
,
2386 struct glsl_symbol_table
*symbols
, void *mem_ctx
);
2389 ir_has_call(ir_instruction
*ir
);
2392 do_set_program_inouts(exec_list
*instructions
, struct gl_program
*prog
,
2393 GLenum shader_type
);
2396 prototype_string(const glsl_type
*return_type
, const char *name
,
2397 exec_list
*parameters
);
2400 mode_string(const ir_variable
*var
);
2403 #endif /* __cplusplus */
2405 extern void _mesa_print_ir(struct exec_list
*instructions
,
2406 struct _mesa_glsl_parse_state
*state
);
2413 vertices_per_prim(GLenum prim
);