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_constant
* as_constant() { return NULL
; }
137 virtual class ir_discard
* as_discard() { return NULL
; }
138 virtual class ir_jump
* as_jump() { return NULL
; }
144 ir_type
= ir_type_unset
;
150 * The base class for all "values"/expression trees.
152 class ir_rvalue
: public ir_instruction
{
154 const struct glsl_type
*type
;
156 virtual ir_rvalue
*clone(void *mem_ctx
, struct hash_table
*) const;
158 virtual void accept(ir_visitor
*v
)
163 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
165 virtual ir_constant
*constant_expression_value(struct hash_table
*variable_context
= NULL
);
167 virtual ir_rvalue
* as_rvalue()
172 ir_rvalue
*as_rvalue_to_saturate();
174 virtual bool is_lvalue() const
180 * Get the variable that is ultimately referenced by an r-value
182 virtual ir_variable
*variable_referenced() const
189 * If an r-value is a reference to a whole variable, get that variable
192 * Pointer to a variable that is completely dereferenced by the r-value. If
193 * the r-value is not a dereference or the dereference does not access the
194 * entire variable (i.e., it's just one array element, struct field), \c NULL
197 virtual ir_variable
*whole_variable_referenced()
203 * Determine if an r-value has the value zero
205 * The base implementation of this function always returns \c false. The
206 * \c ir_constant class over-rides this function to return \c true \b only
207 * for vector and scalar types that have all elements set to the value
208 * zero (or \c false for booleans).
210 * \sa ir_constant::has_value, ir_rvalue::is_one, ir_rvalue::is_negative_one,
211 * ir_constant::is_basis
213 virtual bool is_zero() const;
216 * Determine if an r-value has the value one
218 * The base implementation of this function always returns \c false. The
219 * \c ir_constant class over-rides this function to return \c true \b only
220 * for vector and scalar types that have all elements set to the value
221 * one (or \c true for booleans).
223 * \sa ir_constant::has_value, ir_rvalue::is_zero, ir_rvalue::is_negative_one,
224 * ir_constant::is_basis
226 virtual bool is_one() const;
229 * Determine if an r-value has the value negative one
231 * The base implementation of this function always returns \c false. The
232 * \c ir_constant class over-rides this function to return \c true \b only
233 * for vector and scalar types that have all elements set to the value
234 * negative one. For boolean types, the result is always \c false.
236 * \sa ir_constant::has_value, ir_rvalue::is_zero, ir_rvalue::is_one
237 * ir_constant::is_basis
239 virtual bool is_negative_one() const;
242 * Determine if an r-value is a basis vector
244 * The base implementation of this function always returns \c false. The
245 * \c ir_constant class over-rides this function to return \c true \b only
246 * for vector and scalar types that have one element set to the value one,
247 * and the other elements set to the value zero. For boolean types, the
248 * result is always \c false.
250 * \sa ir_constant::has_value, ir_rvalue::is_zero, ir_rvalue::is_one,
251 * is_constant::is_negative_one
253 virtual bool is_basis() const;
257 * Return a generic value of error_type.
259 * Allocation will be performed with 'mem_ctx' as ralloc owner.
261 static ir_rvalue
*error_value(void *mem_ctx
);
269 * Variable storage classes
271 enum ir_variable_mode
{
272 ir_var_auto
= 0, /**< Function local variables and globals. */
273 ir_var_uniform
, /**< Variable declared as a uniform. */
278 ir_var_function_inout
,
279 ir_var_const_in
, /**< "in" param that must be a constant expression */
280 ir_var_system_value
, /**< Ex: front-face, instance-id, etc. */
281 ir_var_temporary
, /**< Temporary variable generated during compilation. */
282 ir_var_mode_count
/**< Number of variable modes */
286 * \brief Layout qualifiers for gl_FragDepth.
288 * The AMD/ARB_conservative_depth extensions allow gl_FragDepth to be redeclared
289 * with a layout qualifier.
291 enum ir_depth_layout
{
292 ir_depth_layout_none
, /**< No depth layout is specified. */
294 ir_depth_layout_greater
,
295 ir_depth_layout_less
,
296 ir_depth_layout_unchanged
300 * \brief Convert depth layout qualifier to string.
303 depth_layout_string(ir_depth_layout layout
);
306 * Description of built-in state associated with a uniform
308 * \sa ir_variable::state_slots
310 struct ir_state_slot
{
317 * Get the string value for an interpolation qualifier
319 * \return The string that would be used in a shader to specify \c
320 * mode will be returned.
322 * This function is used to generate error messages of the form "shader
323 * uses %s interpolation qualifier", so in the case where there is no
324 * interpolation qualifier, it returns "no".
326 * This function should only be used on a shader input or output variable.
328 const char *interpolation_string(unsigned interpolation
);
331 class ir_variable
: public ir_instruction
{
333 ir_variable(const struct glsl_type
*, const char *, ir_variable_mode
);
335 virtual ir_variable
*clone(void *mem_ctx
, struct hash_table
*ht
) const;
337 virtual ir_variable
*as_variable()
342 virtual void accept(ir_visitor
*v
)
347 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
351 * Determine how this variable should be interpolated based on its
352 * interpolation qualifier (if present), whether it is gl_Color or
353 * gl_SecondaryColor, and whether flatshading is enabled in the current GL
356 * The return value will always be either INTERP_QUALIFIER_SMOOTH,
357 * INTERP_QUALIFIER_NOPERSPECTIVE, or INTERP_QUALIFIER_FLAT.
359 glsl_interp_qualifier
determine_interpolation_mode(bool flat_shade
);
362 * Determine whether or not a variable is part of a uniform block.
364 inline bool is_in_uniform_block() const
366 return this->mode
== ir_var_uniform
&& this->interface_type
!= NULL
;
370 * Determine whether or not a variable is the declaration of an interface
373 * For the first declaration below, there will be an \c ir_variable named
374 * "instance" whose type and whose instance_type will be the same
375 * \cglsl_type. For the second declaration, there will be an \c ir_variable
376 * named "f" whose type is float and whose instance_type is B2.
378 * "instance" is an interface instance variable, but "f" is not.
388 inline bool is_interface_instance() const
390 const glsl_type
*const t
= this->type
;
392 return (t
== this->interface_type
)
393 || (t
->is_array() && t
->fields
.array
== this->interface_type
);
397 * Set this->interface_type on a newly created variable.
399 void init_interface_type(const struct glsl_type
*type
)
401 assert(this->interface_type
== NULL
);
402 this->interface_type
= type
;
403 if (this->is_interface_instance()) {
404 this->max_ifc_array_access
=
405 rzalloc_array(this, unsigned, type
->length
);
410 * Change this->interface_type on a variable that previously had a
411 * different, but compatible, interface_type. This is used during linking
412 * to set the size of arrays in interface blocks.
414 void change_interface_type(const struct glsl_type
*type
)
416 if (this->max_ifc_array_access
!= NULL
) {
417 /* max_ifc_array_access has already been allocated, so make sure the
418 * new interface has the same number of fields as the old one.
420 assert(this->interface_type
->length
== type
->length
);
422 this->interface_type
= type
;
426 * Change this->interface_type on a variable that previously had a
427 * different, and incompatible, interface_type. This is used during
428 * compilation to handle redeclaration of the built-in gl_PerVertex
431 void reinit_interface_type(const struct glsl_type
*type
)
433 if (this->max_ifc_array_access
!= NULL
) {
435 /* Redeclaring gl_PerVertex is only allowed if none of the built-ins
436 * it defines have been accessed yet; so it's safe to throw away the
437 * old max_ifc_array_access pointer, since all of its values are
440 for (unsigned i
= 0; i
< this->interface_type
->length
; i
++)
441 assert(this->max_ifc_array_access
[i
] == 0);
443 ralloc_free(this->max_ifc_array_access
);
444 this->max_ifc_array_access
= NULL
;
446 this->interface_type
= NULL
;
447 init_interface_type(type
);
450 const glsl_type
*get_interface_type() const
452 return this->interface_type
;
456 * Declared type of the variable
458 const struct glsl_type
*type
;
461 * Declared name of the variable
466 * Highest element accessed with a constant expression array index
468 * Not used for non-array variables.
470 unsigned max_array_access
;
473 * For variables which satisfy the is_interface_instance() predicate, this
474 * points to an array of integers such that if the ith member of the
475 * interface block is an array, max_ifc_array_access[i] is the maximum
476 * array element of that member that has been accessed. If the ith member
477 * of the interface block is not an array, max_ifc_array_access[i] is
480 * For variables whose type is not an interface block, this pointer is
483 unsigned *max_ifc_array_access
;
486 * Is the variable read-only?
488 * This is set for variables declared as \c const, shader inputs,
491 unsigned read_only
:1;
493 unsigned invariant
:1;
496 * Has this variable been used for reading or writing?
498 * Several GLSL semantic checks require knowledge of whether or not a
499 * variable has been used. For example, it is an error to redeclare a
500 * variable as invariant after it has been used.
502 * This is only maintained in the ast_to_hir.cpp path, not in
503 * Mesa's fixed function or ARB program paths.
508 * Has this variable been statically assigned?
510 * This answers whether the variable was assigned in any path of
511 * the shader during ast_to_hir. This doesn't answer whether it is
512 * still written after dead code removal, nor is it maintained in
513 * non-ast_to_hir.cpp (GLSL parsing) paths.
518 * Storage class of the variable.
520 * \sa ir_variable_mode
525 * Interpolation mode for shader inputs / outputs
527 * \sa ir_variable_interpolation
529 unsigned interpolation
:2;
532 * \name ARB_fragment_coord_conventions
535 unsigned origin_upper_left
:1;
536 unsigned pixel_center_integer
:1;
540 * Was the location explicitly set in the shader?
542 * If the location is explicitly set in the shader, it \b cannot be changed
543 * by the linker or by the API (e.g., calls to \c glBindAttribLocation have
546 unsigned explicit_location
:1;
547 unsigned explicit_index
:1;
550 * Was an initial binding explicitly set in the shader?
552 * If so, constant_value contains an integer ir_constant representing the
553 * initial binding point.
555 unsigned explicit_binding
:1;
558 * Does this variable have an initializer?
560 * This is used by the linker to cross-validiate initializers of global
563 unsigned has_initializer
:1;
566 * Is this variable a generic output or input that has not yet been matched
567 * up to a variable in another stage of the pipeline?
569 * This is used by the linker as scratch storage while assigning locations
570 * to generic inputs and outputs.
572 unsigned is_unmatched_generic_inout
:1;
575 * If non-zero, then this variable may be packed along with other variables
576 * into a single varying slot, so this offset should be applied when
577 * accessing components. For example, an offset of 1 means that the x
578 * component of this variable is actually stored in component y of the
579 * location specified by \c location.
581 unsigned location_frac
:2;
584 * Non-zero if this variable was created by lowering a named interface
585 * block which was not an array.
587 * Note that this variable and \c from_named_ifc_block_array will never
590 unsigned from_named_ifc_block_nonarray
:1;
593 * Non-zero if this variable was created by lowering a named interface
594 * block which was an array.
596 * Note that this variable and \c from_named_ifc_block_nonarray will never
599 unsigned from_named_ifc_block_array
:1;
602 * \brief Layout qualifier for gl_FragDepth.
604 * This is not equal to \c ir_depth_layout_none if and only if this
605 * variable is \c gl_FragDepth and a layout qualifier is specified.
607 ir_depth_layout depth_layout
;
610 * Storage location of the base of this variable
612 * The precise meaning of this field depends on the nature of the variable.
614 * - Vertex shader input: one of the values from \c gl_vert_attrib.
615 * - Vertex shader output: one of the values from \c gl_varying_slot.
616 * - Geometry shader input: one of the values from \c gl_varying_slot.
617 * - Geometry shader output: one of the values from \c gl_varying_slot.
618 * - Fragment shader input: one of the values from \c gl_varying_slot.
619 * - Fragment shader output: one of the values from \c gl_frag_result.
620 * - Uniforms: Per-stage uniform slot number for default uniform block.
621 * - Uniforms: Index within the uniform block definition for UBO members.
622 * - Other: This field is not currently used.
624 * If the variable is a uniform, shader input, or shader output, and the
625 * slot has not been assigned, the value will be -1.
630 * output index for dual source blending.
635 * Initial binding point for a sampler or UBO.
637 * For array types, this represents the binding point for the first element.
642 * Location an atomic counter is stored at.
645 unsigned buffer_index
;
650 * Built-in state that backs this uniform
652 * Once set at variable creation, \c state_slots must remain invariant.
653 * This is because, ideally, this array would be shared by all clones of
654 * this variable in the IR tree. In other words, we'd really like for it
655 * to be a fly-weight.
657 * If the variable is not a uniform, \c num_state_slots will be zero and
658 * \c state_slots will be \c NULL.
661 unsigned num_state_slots
; /**< Number of state slots used */
662 ir_state_slot
*state_slots
; /**< State descriptors. */
666 * Emit a warning if this variable is accessed.
668 const char *warn_extension
;
671 * Value assigned in the initializer of a variable declared "const"
673 ir_constant
*constant_value
;
676 * Constant expression assigned in the initializer of the variable
679 * This field and \c ::constant_value are distinct. Even if the two fields
680 * refer to constants with the same value, they must point to separate
683 ir_constant
*constant_initializer
;
687 * For variables that are in an interface block or are an instance of an
688 * interface block, this is the \c GLSL_TYPE_INTERFACE type for that block.
690 * \sa ir_variable::location
692 const glsl_type
*interface_type
;
696 * A function that returns whether a built-in function is available in the
697 * current shading language (based on version, ES or desktop, and extensions).
699 typedef bool (*builtin_available_predicate
)(const _mesa_glsl_parse_state
*);
703 * The representation of a function instance; may be the full definition or
704 * simply a prototype.
706 class ir_function_signature
: public ir_instruction
{
707 /* An ir_function_signature will be part of the list of signatures in
711 ir_function_signature(const glsl_type
*return_type
,
712 builtin_available_predicate builtin_avail
= NULL
);
714 virtual ir_function_signature
*clone(void *mem_ctx
,
715 struct hash_table
*ht
) const;
716 ir_function_signature
*clone_prototype(void *mem_ctx
,
717 struct hash_table
*ht
) const;
719 virtual void accept(ir_visitor
*v
)
724 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
727 * Attempt to evaluate this function as a constant expression,
728 * given a list of the actual parameters and the variable context.
729 * Returns NULL for non-built-ins.
731 ir_constant
*constant_expression_value(exec_list
*actual_parameters
, struct hash_table
*variable_context
);
734 * Get the name of the function for which this is a signature
736 const char *function_name() const;
739 * Get a handle to the function for which this is a signature
741 * There is no setter function, this function returns a \c const pointer,
742 * and \c ir_function_signature::_function is private for a reason. The
743 * only way to make a connection between a function and function signature
744 * is via \c ir_function::add_signature. This helps ensure that certain
745 * invariants (i.e., a function signature is in the list of signatures for
746 * its \c _function) are met.
748 * \sa ir_function::add_signature
750 inline const class ir_function
*function() const
752 return this->_function
;
756 * Check whether the qualifiers match between this signature's parameters
757 * and the supplied parameter list. If not, returns the name of the first
758 * parameter with mismatched qualifiers (for use in error messages).
760 const char *qualifiers_match(exec_list
*params
);
763 * Replace the current parameter list with the given one. This is useful
764 * if the current information came from a prototype, and either has invalid
765 * or missing parameter names.
767 void replace_parameters(exec_list
*new_params
);
770 * Function return type.
772 * \note This discards the optional precision qualifier.
774 const struct glsl_type
*return_type
;
777 * List of ir_variable of function parameters.
779 * This represents the storage. The paramaters passed in a particular
780 * call will be in ir_call::actual_paramaters.
782 struct exec_list parameters
;
784 /** Whether or not this function has a body (which may be empty). */
785 unsigned is_defined
:1;
787 /** Whether or not this function signature is a built-in. */
788 bool is_builtin() const;
791 * Whether or not this function is an intrinsic to be implemented
796 /** Whether or not a built-in is available for this shader. */
797 bool is_builtin_available(const _mesa_glsl_parse_state
*state
) const;
799 /** Body of instructions in the function. */
800 struct exec_list body
;
804 * A function pointer to a predicate that answers whether a built-in
805 * function is available in the current shader. NULL if not a built-in.
807 builtin_available_predicate builtin_avail
;
809 /** Function of which this signature is one overload. */
810 class ir_function
*_function
;
812 /** Function signature of which this one is a prototype clone */
813 const ir_function_signature
*origin
;
815 friend class ir_function
;
818 * Helper function to run a list of instructions for constant
819 * expression evaluation.
821 * The hash table represents the values of the visible variables.
822 * There are no scoping issues because the table is indexed on
823 * ir_variable pointers, not variable names.
825 * Returns false if the expression is not constant, true otherwise,
826 * and the value in *result if result is non-NULL.
828 bool constant_expression_evaluate_expression_list(const struct exec_list
&body
,
829 struct hash_table
*variable_context
,
830 ir_constant
**result
);
835 * Header for tracking multiple overloaded functions with the same name.
836 * Contains a list of ir_function_signatures representing each of the
839 class ir_function
: public ir_instruction
{
841 ir_function(const char *name
);
843 virtual ir_function
*clone(void *mem_ctx
, struct hash_table
*ht
) const;
845 virtual ir_function
*as_function()
850 virtual void accept(ir_visitor
*v
)
855 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
857 void add_signature(ir_function_signature
*sig
)
859 sig
->_function
= this;
860 this->signatures
.push_tail(sig
);
864 * Get an iterator for the set of function signatures
866 exec_list_iterator
iterator()
868 return signatures
.iterator();
872 * Find a signature that matches a set of actual parameters, taking implicit
873 * conversions into account. Also flags whether the match was exact.
875 ir_function_signature
*matching_signature(_mesa_glsl_parse_state
*state
,
876 const exec_list
*actual_param
,
877 bool *match_is_exact
);
880 * Find a signature that matches a set of actual parameters, taking implicit
881 * conversions into account.
883 ir_function_signature
*matching_signature(_mesa_glsl_parse_state
*state
,
884 const exec_list
*actual_param
);
887 * Find a signature that exactly matches a set of actual parameters without
888 * any implicit type conversions.
890 ir_function_signature
*exact_matching_signature(_mesa_glsl_parse_state
*state
,
891 const exec_list
*actual_ps
);
894 * Name of the function.
898 /** Whether or not this function has a signature that isn't a built-in. */
899 bool has_user_signature();
902 * List of ir_function_signature for each overloaded function with this name.
904 struct exec_list signatures
;
907 inline const char *ir_function_signature::function_name() const
909 return this->_function
->name
;
915 * IR instruction representing high-level if-statements
917 class ir_if
: public ir_instruction
{
919 ir_if(ir_rvalue
*condition
)
920 : condition(condition
)
922 ir_type
= ir_type_if
;
925 virtual ir_if
*clone(void *mem_ctx
, struct hash_table
*ht
) const;
927 virtual ir_if
*as_if()
932 virtual void accept(ir_visitor
*v
)
937 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
939 ir_rvalue
*condition
;
940 /** List of ir_instruction for the body of the then branch */
941 exec_list then_instructions
;
942 /** List of ir_instruction for the body of the else branch */
943 exec_list else_instructions
;
948 * IR instruction representing a high-level loop structure.
950 class ir_loop
: public ir_instruction
{
954 virtual ir_loop
*clone(void *mem_ctx
, struct hash_table
*ht
) const;
956 virtual void accept(ir_visitor
*v
)
961 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
963 virtual ir_loop
*as_loop()
969 * Get an iterator for the instructions of the loop body
971 exec_list_iterator
iterator()
973 return body_instructions
.iterator();
976 /** List of ir_instruction that make up the body of the loop. */
977 exec_list body_instructions
;
980 * \name Loop counter and controls
982 * Represents a loop like a FORTRAN \c do-loop.
985 * If \c from and \c to are the same value, the loop will execute once.
988 ir_rvalue
*from
; /** Value of the loop counter on the first
989 * iteration of the loop.
991 ir_rvalue
*to
; /** Value of the loop counter on the last
992 * iteration of the loop.
994 ir_rvalue
*increment
;
995 ir_variable
*counter
;
998 * Comparison operation in the loop terminator.
1000 * If any of the loop control fields are non-\c NULL, this field must be
1001 * one of \c ir_binop_less, \c ir_binop_greater, \c ir_binop_lequal,
1002 * \c ir_binop_gequal, \c ir_binop_equal, or \c ir_binop_nequal.
1009 class ir_assignment
: public ir_instruction
{
1011 ir_assignment(ir_rvalue
*lhs
, ir_rvalue
*rhs
, ir_rvalue
*condition
= NULL
);
1014 * Construct an assignment with an explicit write mask
1017 * Since a write mask is supplied, the LHS must already be a bare
1018 * \c ir_dereference. The cannot be any swizzles in the LHS.
1020 ir_assignment(ir_dereference
*lhs
, ir_rvalue
*rhs
, ir_rvalue
*condition
,
1021 unsigned write_mask
);
1023 virtual ir_assignment
*clone(void *mem_ctx
, struct hash_table
*ht
) const;
1025 virtual ir_constant
*constant_expression_value(struct hash_table
*variable_context
= NULL
);
1027 virtual void accept(ir_visitor
*v
)
1032 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1034 virtual ir_assignment
* as_assignment()
1040 * Get a whole variable written by an assignment
1042 * If the LHS of the assignment writes a whole variable, the variable is
1043 * returned. Otherwise \c NULL is returned. Examples of whole-variable
1046 * - Assigning to a scalar
1047 * - Assigning to all components of a vector
1048 * - Whole array (or matrix) assignment
1049 * - Whole structure assignment
1051 ir_variable
*whole_variable_written();
1054 * Set the LHS of an assignment
1056 void set_lhs(ir_rvalue
*lhs
);
1059 * Left-hand side of the assignment.
1061 * This should be treated as read only. If you need to set the LHS of an
1062 * assignment, use \c ir_assignment::set_lhs.
1064 ir_dereference
*lhs
;
1067 * Value being assigned
1072 * Optional condition for the assignment.
1074 ir_rvalue
*condition
;
1078 * Component mask written
1080 * For non-vector types in the LHS, this field will be zero. For vector
1081 * types, a bit will be set for each component that is written. Note that
1082 * for \c vec2 and \c vec3 types only the lower bits will ever be set.
1084 * A partially-set write mask means that each enabled channel gets
1085 * the value from a consecutive channel of the rhs. For example,
1086 * to write just .xyw of gl_FrontColor with color:
1088 * (assign (constant bool (1)) (xyw)
1089 * (var_ref gl_FragColor)
1090 * (swiz xyw (var_ref color)))
1092 unsigned write_mask
:4;
1095 /* Update ir_expression::get_num_operands() and operator_strs when
1096 * updating this list.
1098 enum ir_expression_operation
{
1107 ir_unop_exp
, /**< Log base e on gentype */
1108 ir_unop_log
, /**< Natural log on gentype */
1111 ir_unop_f2i
, /**< Float-to-integer conversion. */
1112 ir_unop_f2u
, /**< Float-to-unsigned conversion. */
1113 ir_unop_i2f
, /**< Integer-to-float conversion. */
1114 ir_unop_f2b
, /**< Float-to-boolean conversion */
1115 ir_unop_b2f
, /**< Boolean-to-float conversion */
1116 ir_unop_i2b
, /**< int-to-boolean conversion */
1117 ir_unop_b2i
, /**< Boolean-to-int conversion */
1118 ir_unop_u2f
, /**< Unsigned-to-float conversion. */
1119 ir_unop_i2u
, /**< Integer-to-unsigned conversion. */
1120 ir_unop_u2i
, /**< Unsigned-to-integer conversion. */
1121 ir_unop_bitcast_i2f
, /**< Bit-identical int-to-float "conversion" */
1122 ir_unop_bitcast_f2i
, /**< Bit-identical float-to-int "conversion" */
1123 ir_unop_bitcast_u2f
, /**< Bit-identical uint-to-float "conversion" */
1124 ir_unop_bitcast_f2u
, /**< Bit-identical float-to-uint "conversion" */
1128 * \name Unary floating-point rounding operations.
1139 * \name Trigonometric operations.
1144 ir_unop_sin_reduced
, /**< Reduced range sin. [-pi, pi] */
1145 ir_unop_cos_reduced
, /**< Reduced range cos. [-pi, pi] */
1149 * \name Partial derivatives.
1157 * \name Floating point pack and unpack operations.
1160 ir_unop_pack_snorm_2x16
,
1161 ir_unop_pack_snorm_4x8
,
1162 ir_unop_pack_unorm_2x16
,
1163 ir_unop_pack_unorm_4x8
,
1164 ir_unop_pack_half_2x16
,
1165 ir_unop_unpack_snorm_2x16
,
1166 ir_unop_unpack_snorm_4x8
,
1167 ir_unop_unpack_unorm_2x16
,
1168 ir_unop_unpack_unorm_4x8
,
1169 ir_unop_unpack_half_2x16
,
1173 * \name Lowered floating point unpacking operations.
1175 * \see lower_packing_builtins_visitor::split_unpack_half_2x16
1178 ir_unop_unpack_half_2x16_split_x
,
1179 ir_unop_unpack_half_2x16_split_y
,
1183 * \name Bit operations, part of ARB_gpu_shader5.
1186 ir_unop_bitfield_reverse
,
1195 * A sentinel marking the last of the unary operations.
1197 ir_last_unop
= ir_unop_noise
,
1201 ir_binop_mul
, /**< Floating-point or low 32-bit integer multiply. */
1202 ir_binop_imul_high
, /**< Calculates the high 32-bits of a 64-bit multiply. */
1206 * Returns the carry resulting from the addition of the two arguments.
1213 * Returns the borrow resulting from the subtraction of the second argument
1214 * from the first argument.
1221 * Takes one of two combinations of arguments:
1224 * - mod(vecN, float)
1226 * Does not take integer types.
1231 * \name Binary comparison operators which return a boolean vector.
1232 * The type of both operands must be equal.
1242 * Returns single boolean for whether all components of operands[0]
1243 * equal the components of operands[1].
1247 * Returns single boolean for whether any component of operands[0]
1248 * is not equal to the corresponding component of operands[1].
1250 ir_binop_any_nequal
,
1254 * \name Bit-wise binary operations.
1275 * \name Lowered floating point packing operations.
1277 * \see lower_packing_builtins_visitor::split_pack_half_2x16
1280 ir_binop_pack_half_2x16_split
,
1284 * \name First half of a lowered bitfieldInsert() operation.
1286 * \see lower_instructions::bitfield_insert_to_bfm_bfi
1293 * Load a value the size of a given GLSL type from a uniform block.
1295 * operand0 is the ir_constant uniform block index in the linked shader.
1296 * operand1 is a byte offset within the uniform block.
1301 * \name Multiplies a number by two to a power, part of ARB_gpu_shader5.
1308 * Extract a scalar from a vector
1310 * operand0 is the vector
1311 * operand1 is the index of the field to read from operand0
1313 ir_binop_vector_extract
,
1316 * A sentinel marking the last of the binary operations.
1318 ir_last_binop
= ir_binop_vector_extract
,
1321 * \name Fused floating-point multiply-add, part of ARB_gpu_shader5.
1330 * \name Conditional Select
1332 * A vector conditional select instruction (like ?:, but operating per-
1333 * component on vectors).
1335 * \see lower_instructions_visitor::ldexp_to_arith
1342 * \name Second half of a lowered bitfieldInsert() operation.
1344 * \see lower_instructions::bitfield_insert_to_bfm_bfi
1350 ir_triop_bitfield_extract
,
1353 * Generate a value with one field of a vector changed
1355 * operand0 is the vector
1356 * operand1 is the value to write into the vector result
1357 * operand2 is the index in operand0 to be modified
1359 ir_triop_vector_insert
,
1362 * A sentinel marking the last of the ternary operations.
1364 ir_last_triop
= ir_triop_vector_insert
,
1366 ir_quadop_bitfield_insert
,
1371 * A sentinel marking the last of the ternary operations.
1373 ir_last_quadop
= ir_quadop_vector
,
1376 * A sentinel marking the last of all operations.
1378 ir_last_opcode
= ir_quadop_vector
1381 class ir_expression
: public ir_rvalue
{
1383 ir_expression(int op
, const struct glsl_type
*type
,
1384 ir_rvalue
*op0
, ir_rvalue
*op1
= NULL
,
1385 ir_rvalue
*op2
= NULL
, ir_rvalue
*op3
= NULL
);
1388 * Constructor for unary operation expressions
1390 ir_expression(int op
, ir_rvalue
*);
1393 * Constructor for binary operation expressions
1395 ir_expression(int op
, ir_rvalue
*op0
, ir_rvalue
*op1
);
1398 * Constructor for ternary operation expressions
1400 ir_expression(int op
, ir_rvalue
*op0
, ir_rvalue
*op1
, ir_rvalue
*op2
);
1402 virtual ir_expression
*as_expression()
1407 virtual ir_expression
*clone(void *mem_ctx
, struct hash_table
*ht
) const;
1410 * Attempt to constant-fold the expression
1412 * The "variable_context" hash table links ir_variable * to ir_constant *
1413 * that represent the variables' values. \c NULL represents an empty
1416 * If the expression cannot be constant folded, this method will return
1419 virtual ir_constant
*constant_expression_value(struct hash_table
*variable_context
= NULL
);
1422 * Determine the number of operands used by an expression
1424 static unsigned int get_num_operands(ir_expression_operation
);
1427 * Determine the number of operands used by an expression
1429 unsigned int get_num_operands() const
1431 return (this->operation
== ir_quadop_vector
)
1432 ? this->type
->vector_elements
: get_num_operands(operation
);
1436 * Return a string representing this expression's operator.
1438 const char *operator_string();
1441 * Return a string representing this expression's operator.
1443 static const char *operator_string(ir_expression_operation
);
1447 * Do a reverse-lookup to translate the given string into an operator.
1449 static ir_expression_operation
get_operator(const char *);
1451 virtual void accept(ir_visitor
*v
)
1456 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1458 ir_expression_operation operation
;
1459 ir_rvalue
*operands
[4];
1464 * HIR instruction representing a high-level function call, containing a list
1465 * of parameters and returning a value in the supplied temporary.
1467 class ir_call
: public ir_instruction
{
1469 ir_call(ir_function_signature
*callee
,
1470 ir_dereference_variable
*return_deref
,
1471 exec_list
*actual_parameters
)
1472 : return_deref(return_deref
), callee(callee
)
1474 ir_type
= ir_type_call
;
1475 assert(callee
->return_type
!= NULL
);
1476 actual_parameters
->move_nodes_to(& this->actual_parameters
);
1477 this->use_builtin
= callee
->is_builtin();
1480 virtual ir_call
*clone(void *mem_ctx
, struct hash_table
*ht
) const;
1482 virtual ir_constant
*constant_expression_value(struct hash_table
*variable_context
= NULL
);
1484 virtual ir_call
*as_call()
1489 virtual void accept(ir_visitor
*v
)
1494 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1497 * Get an iterator for the set of acutal parameters
1499 exec_list_iterator
iterator()
1501 return actual_parameters
.iterator();
1505 * Get the name of the function being called.
1507 const char *callee_name() const
1509 return callee
->function_name();
1513 * Generates an inline version of the function before @ir,
1514 * storing the return value in return_deref.
1516 void generate_inline(ir_instruction
*ir
);
1519 * Storage for the function's return value.
1520 * This must be NULL if the return type is void.
1522 ir_dereference_variable
*return_deref
;
1525 * The specific function signature being called.
1527 ir_function_signature
*callee
;
1529 /* List of ir_rvalue of paramaters passed in this call. */
1530 exec_list actual_parameters
;
1532 /** Should this call only bind to a built-in function? */
1538 * \name Jump-like IR instructions.
1540 * These include \c break, \c continue, \c return, and \c discard.
1543 class ir_jump
: public ir_instruction
{
1547 ir_type
= ir_type_unset
;
1551 virtual ir_jump
*as_jump()
1557 class ir_return
: public ir_jump
{
1562 this->ir_type
= ir_type_return
;
1565 ir_return(ir_rvalue
*value
)
1568 this->ir_type
= ir_type_return
;
1571 virtual ir_return
*clone(void *mem_ctx
, struct hash_table
*) const;
1573 virtual ir_return
*as_return()
1578 ir_rvalue
*get_value() const
1583 virtual void accept(ir_visitor
*v
)
1588 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1595 * Jump instructions used inside loops
1597 * These include \c break and \c continue. The \c break within a loop is
1598 * different from the \c break within a switch-statement.
1600 * \sa ir_switch_jump
1602 class ir_loop_jump
: public ir_jump
{
1609 ir_loop_jump(jump_mode mode
)
1611 this->ir_type
= ir_type_loop_jump
;
1615 virtual ir_loop_jump
*clone(void *mem_ctx
, struct hash_table
*) const;
1617 virtual void accept(ir_visitor
*v
)
1622 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1624 bool is_break() const
1626 return mode
== jump_break
;
1629 bool is_continue() const
1631 return mode
== jump_continue
;
1634 /** Mode selector for the jump instruction. */
1635 enum jump_mode mode
;
1639 * IR instruction representing discard statements.
1641 class ir_discard
: public ir_jump
{
1645 this->ir_type
= ir_type_discard
;
1646 this->condition
= NULL
;
1649 ir_discard(ir_rvalue
*cond
)
1651 this->ir_type
= ir_type_discard
;
1652 this->condition
= cond
;
1655 virtual ir_discard
*clone(void *mem_ctx
, struct hash_table
*ht
) const;
1657 virtual void accept(ir_visitor
*v
)
1662 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1664 virtual ir_discard
*as_discard()
1669 ir_rvalue
*condition
;
1675 * Texture sampling opcodes used in ir_texture
1677 enum ir_texture_opcode
{
1678 ir_tex
, /**< Regular texture look-up */
1679 ir_txb
, /**< Texture look-up with LOD bias */
1680 ir_txl
, /**< Texture look-up with explicit LOD */
1681 ir_txd
, /**< Texture look-up with partial derivatvies */
1682 ir_txf
, /**< Texel fetch with explicit LOD */
1683 ir_txf_ms
, /**< Multisample texture fetch */
1684 ir_txs
, /**< Texture size */
1685 ir_lod
, /**< Texture lod query */
1686 ir_tg4
, /**< Texture gather */
1687 ir_query_levels
/**< Texture levels query */
1692 * IR instruction to sample a texture
1694 * The specific form of the IR instruction depends on the \c mode value
1695 * selected from \c ir_texture_opcodes. In the printed IR, these will
1698 * Texel offset (0 or an expression)
1699 * | Projection divisor
1700 * | | Shadow comparitor
1703 * (tex <type> <sampler> <coordinate> 0 1 ( ))
1704 * (txb <type> <sampler> <coordinate> 0 1 ( ) <bias>)
1705 * (txl <type> <sampler> <coordinate> 0 1 ( ) <lod>)
1706 * (txd <type> <sampler> <coordinate> 0 1 ( ) (dPdx dPdy))
1707 * (txf <type> <sampler> <coordinate> 0 <lod>)
1709 * <type> <sampler> <coordinate> <sample_index>)
1710 * (txs <type> <sampler> <lod>)
1711 * (lod <type> <sampler> <coordinate>)
1712 * (tg4 <type> <sampler> <coordinate> <offset> <component>)
1713 * (query_levels <type> <sampler>)
1715 class ir_texture
: public ir_rvalue
{
1717 ir_texture(enum ir_texture_opcode op
)
1718 : op(op
), sampler(NULL
), coordinate(NULL
), projector(NULL
),
1719 shadow_comparitor(NULL
), offset(NULL
)
1721 this->ir_type
= ir_type_texture
;
1722 memset(&lod_info
, 0, sizeof(lod_info
));
1725 virtual ir_texture
*clone(void *mem_ctx
, struct hash_table
*) const;
1727 virtual ir_constant
*constant_expression_value(struct hash_table
*variable_context
= NULL
);
1729 virtual void accept(ir_visitor
*v
)
1734 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1737 * Return a string representing the ir_texture_opcode.
1739 const char *opcode_string();
1741 /** Set the sampler and type. */
1742 void set_sampler(ir_dereference
*sampler
, const glsl_type
*type
);
1745 * Do a reverse-lookup to translate a string into an ir_texture_opcode.
1747 static ir_texture_opcode
get_opcode(const char *);
1749 enum ir_texture_opcode op
;
1751 /** Sampler to use for the texture access. */
1752 ir_dereference
*sampler
;
1754 /** Texture coordinate to sample */
1755 ir_rvalue
*coordinate
;
1758 * Value used for projective divide.
1760 * If there is no projective divide (the common case), this will be
1761 * \c NULL. Optimization passes should check for this to point to a constant
1762 * of 1.0 and replace that with \c NULL.
1764 ir_rvalue
*projector
;
1767 * Coordinate used for comparison on shadow look-ups.
1769 * If there is no shadow comparison, this will be \c NULL. For the
1770 * \c ir_txf opcode, this *must* be \c NULL.
1772 ir_rvalue
*shadow_comparitor
;
1774 /** Texel offset. */
1778 ir_rvalue
*lod
; /**< Floating point LOD */
1779 ir_rvalue
*bias
; /**< Floating point LOD bias */
1780 ir_rvalue
*sample_index
; /**< MSAA sample index */
1781 ir_rvalue
*component
; /**< Gather component selector */
1783 ir_rvalue
*dPdx
; /**< Partial derivative of coordinate wrt X */
1784 ir_rvalue
*dPdy
; /**< Partial derivative of coordinate wrt Y */
1790 struct ir_swizzle_mask
{
1797 * Number of components in the swizzle.
1799 unsigned num_components
:3;
1802 * Does the swizzle contain duplicate components?
1804 * L-value swizzles cannot contain duplicate components.
1806 unsigned has_duplicates
:1;
1810 class ir_swizzle
: public ir_rvalue
{
1812 ir_swizzle(ir_rvalue
*, unsigned x
, unsigned y
, unsigned z
, unsigned w
,
1815 ir_swizzle(ir_rvalue
*val
, const unsigned *components
, unsigned count
);
1817 ir_swizzle(ir_rvalue
*val
, ir_swizzle_mask mask
);
1819 virtual ir_swizzle
*clone(void *mem_ctx
, struct hash_table
*) const;
1821 virtual ir_constant
*constant_expression_value(struct hash_table
*variable_context
= NULL
);
1823 virtual ir_swizzle
*as_swizzle()
1829 * Construct an ir_swizzle from the textual representation. Can fail.
1831 static ir_swizzle
*create(ir_rvalue
*, const char *, unsigned vector_length
);
1833 virtual void accept(ir_visitor
*v
)
1838 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1840 bool is_lvalue() const
1842 return val
->is_lvalue() && !mask
.has_duplicates
;
1846 * Get the variable that is ultimately referenced by an r-value
1848 virtual ir_variable
*variable_referenced() const;
1851 ir_swizzle_mask mask
;
1855 * Initialize the mask component of a swizzle
1857 * This is used by the \c ir_swizzle constructors.
1859 void init_mask(const unsigned *components
, unsigned count
);
1863 class ir_dereference
: public ir_rvalue
{
1865 virtual ir_dereference
*clone(void *mem_ctx
, struct hash_table
*) const = 0;
1867 virtual ir_dereference
*as_dereference()
1872 bool is_lvalue() const;
1875 * Get the variable that is ultimately referenced by an r-value
1877 virtual ir_variable
*variable_referenced() const = 0;
1880 * Get the constant that is ultimately referenced by an r-value,
1881 * in a constant expression evaluation context.
1883 * The offset is used when the reference is to a specific column of
1886 virtual void constant_referenced(struct hash_table
*variable_context
, ir_constant
*&store
, int &offset
) const = 0;
1890 class ir_dereference_variable
: public ir_dereference
{
1892 ir_dereference_variable(ir_variable
*var
);
1894 virtual ir_dereference_variable
*clone(void *mem_ctx
,
1895 struct hash_table
*) const;
1897 virtual ir_constant
*constant_expression_value(struct hash_table
*variable_context
= NULL
);
1899 virtual ir_dereference_variable
*as_dereference_variable()
1905 * Get the variable that is ultimately referenced by an r-value
1907 virtual ir_variable
*variable_referenced() const
1913 * Get the constant that is ultimately referenced by an r-value,
1914 * in a constant expression evaluation context.
1916 * The offset is used when the reference is to a specific column of
1919 virtual void constant_referenced(struct hash_table
*variable_context
, ir_constant
*&store
, int &offset
) const;
1921 virtual ir_variable
*whole_variable_referenced()
1923 /* ir_dereference_variable objects always dereference the entire
1924 * variable. However, if this dereference is dereferenced by anything
1925 * else, the complete deferefernce chain is not a whole-variable
1926 * dereference. This method should only be called on the top most
1927 * ir_rvalue in a dereference chain.
1932 virtual void accept(ir_visitor
*v
)
1937 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1940 * Object being dereferenced.
1946 class ir_dereference_array
: public ir_dereference
{
1948 ir_dereference_array(ir_rvalue
*value
, ir_rvalue
*array_index
);
1950 ir_dereference_array(ir_variable
*var
, ir_rvalue
*array_index
);
1952 virtual ir_dereference_array
*clone(void *mem_ctx
,
1953 struct hash_table
*) const;
1955 virtual ir_constant
*constant_expression_value(struct hash_table
*variable_context
= NULL
);
1957 virtual ir_dereference_array
*as_dereference_array()
1963 * Get the variable that is ultimately referenced by an r-value
1965 virtual ir_variable
*variable_referenced() const
1967 return this->array
->variable_referenced();
1971 * Get the constant that is ultimately referenced by an r-value,
1972 * in a constant expression evaluation context.
1974 * The offset is used when the reference is to a specific column of
1977 virtual void constant_referenced(struct hash_table
*variable_context
, ir_constant
*&store
, int &offset
) const;
1979 virtual void accept(ir_visitor
*v
)
1984 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1987 ir_rvalue
*array_index
;
1990 void set_array(ir_rvalue
*value
);
1994 class ir_dereference_record
: public ir_dereference
{
1996 ir_dereference_record(ir_rvalue
*value
, const char *field
);
1998 ir_dereference_record(ir_variable
*var
, const char *field
);
2000 virtual ir_dereference_record
*clone(void *mem_ctx
,
2001 struct hash_table
*) const;
2003 virtual ir_constant
*constant_expression_value(struct hash_table
*variable_context
= NULL
);
2005 virtual ir_dereference_record
*as_dereference_record()
2011 * Get the variable that is ultimately referenced by an r-value
2013 virtual ir_variable
*variable_referenced() const
2015 return this->record
->variable_referenced();
2019 * Get the constant that is ultimately referenced by an r-value,
2020 * in a constant expression evaluation context.
2022 * The offset is used when the reference is to a specific column of
2025 virtual void constant_referenced(struct hash_table
*variable_context
, ir_constant
*&store
, int &offset
) const;
2027 virtual void accept(ir_visitor
*v
)
2032 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
2040 * Data stored in an ir_constant
2042 union ir_constant_data
{
2050 class ir_constant
: public ir_rvalue
{
2052 ir_constant(const struct glsl_type
*type
, const ir_constant_data
*data
);
2053 ir_constant(bool b
, unsigned vector_elements
=1);
2054 ir_constant(unsigned int u
, unsigned vector_elements
=1);
2055 ir_constant(int i
, unsigned vector_elements
=1);
2056 ir_constant(float f
, unsigned vector_elements
=1);
2059 * Construct an ir_constant from a list of ir_constant values
2061 ir_constant(const struct glsl_type
*type
, exec_list
*values
);
2064 * Construct an ir_constant from a scalar component of another ir_constant
2066 * The new \c ir_constant inherits the type of the component from the
2070 * In the case of a matrix constant, the new constant is a scalar, \b not
2073 ir_constant(const ir_constant
*c
, unsigned i
);
2076 * Return a new ir_constant of the specified type containing all zeros.
2078 static ir_constant
*zero(void *mem_ctx
, const glsl_type
*type
);
2080 virtual ir_constant
*clone(void *mem_ctx
, struct hash_table
*) const;
2082 virtual ir_constant
*constant_expression_value(struct hash_table
*variable_context
= NULL
);
2084 virtual ir_constant
*as_constant()
2089 virtual void accept(ir_visitor
*v
)
2094 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
2097 * Get a particular component of a constant as a specific type
2099 * This is useful, for example, to get a value from an integer constant
2100 * as a float or bool. This appears frequently when constructors are
2101 * called with all constant parameters.
2104 bool get_bool_component(unsigned i
) const;
2105 float get_float_component(unsigned i
) const;
2106 int get_int_component(unsigned i
) const;
2107 unsigned get_uint_component(unsigned i
) const;
2110 ir_constant
*get_array_element(unsigned i
) const;
2112 ir_constant
*get_record_field(const char *name
);
2115 * Copy the values on another constant at a given offset.
2117 * The offset is ignored for array or struct copies, it's only for
2118 * scalars or vectors into vectors or matrices.
2120 * With identical types on both sides and zero offset it's clone()
2121 * without creating a new object.
2124 void copy_offset(ir_constant
*src
, int offset
);
2127 * Copy the values on another constant at a given offset and
2128 * following an assign-like mask.
2130 * The mask is ignored for scalars.
2132 * Note that this function only handles what assign can handle,
2133 * i.e. at most a vector as source and a column of a matrix as
2137 void copy_masked_offset(ir_constant
*src
, int offset
, unsigned int mask
);
2140 * Determine whether a constant has the same value as another constant
2142 * \sa ir_constant::is_zero, ir_constant::is_one,
2143 * ir_constant::is_negative_one, ir_constant::is_basis
2145 bool has_value(const ir_constant
*) const;
2147 virtual bool is_zero() const;
2148 virtual bool is_one() const;
2149 virtual bool is_negative_one() const;
2150 virtual bool is_basis() const;
2153 * Value of the constant.
2155 * The field used to back the values supplied by the constant is determined
2156 * by the type associated with the \c ir_instruction. Constants may be
2157 * scalars, vectors, or matrices.
2159 union ir_constant_data value
;
2161 /* Array elements */
2162 ir_constant
**array_elements
;
2164 /* Structure fields */
2165 exec_list components
;
2169 * Parameterless constructor only used by the clone method
2177 * IR instruction to emit a vertex in a geometry shader.
2179 class ir_emit_vertex
: public ir_instruction
{
2183 ir_type
= ir_type_emit_vertex
;
2186 virtual void accept(ir_visitor
*v
)
2191 virtual ir_emit_vertex
*clone(void *mem_ctx
, struct hash_table
*) const
2193 return new(mem_ctx
) ir_emit_vertex();
2196 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
2200 * IR instruction to complete the current primitive and start a new one in a
2203 class ir_end_primitive
: public ir_instruction
{
2207 ir_type
= ir_type_end_primitive
;
2210 virtual void accept(ir_visitor
*v
)
2215 virtual ir_end_primitive
*clone(void *mem_ctx
, struct hash_table
*) const
2217 return new(mem_ctx
) ir_end_primitive();
2220 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
2224 * Apply a visitor to each IR node in a list
2227 visit_exec_list(exec_list
*list
, ir_visitor
*visitor
);
2230 * Validate invariants on each IR node in a list
2232 void validate_ir_tree(exec_list
*instructions
);
2234 struct _mesa_glsl_parse_state
;
2235 struct gl_shader_program
;
2238 * Detect whether an unlinked shader contains static recursion
2240 * If the list of instructions is determined to contain static recursion,
2241 * \c _mesa_glsl_error will be called to emit error messages for each function
2242 * that is in the recursion cycle.
2245 detect_recursion_unlinked(struct _mesa_glsl_parse_state
*state
,
2246 exec_list
*instructions
);
2249 * Detect whether a linked shader contains static recursion
2251 * If the list of instructions is determined to contain static recursion,
2252 * \c link_error_printf will be called to emit error messages for each function
2253 * that is in the recursion cycle. In addition,
2254 * \c gl_shader_program::LinkStatus will be set to false.
2257 detect_recursion_linked(struct gl_shader_program
*prog
,
2258 exec_list
*instructions
);
2261 * Make a clone of each IR instruction in a list
2263 * \param in List of IR instructions that are to be cloned
2264 * \param out List to hold the cloned instructions
2267 clone_ir_list(void *mem_ctx
, exec_list
*out
, const exec_list
*in
);
2270 _mesa_glsl_initialize_variables(exec_list
*instructions
,
2271 struct _mesa_glsl_parse_state
*state
);
2274 _mesa_glsl_initialize_functions(_mesa_glsl_parse_state
*state
);
2277 _mesa_glsl_initialize_builtin_functions();
2279 extern ir_function_signature
*
2280 _mesa_glsl_find_builtin_function(_mesa_glsl_parse_state
*state
,
2281 const char *name
, exec_list
*actual_parameters
);
2284 _mesa_glsl_release_functions(void);
2287 _mesa_glsl_release_builtin_functions(void);
2290 reparent_ir(exec_list
*list
, void *mem_ctx
);
2292 struct glsl_symbol_table
;
2295 import_prototypes(const exec_list
*source
, exec_list
*dest
,
2296 struct glsl_symbol_table
*symbols
, void *mem_ctx
);
2299 ir_has_call(ir_instruction
*ir
);
2302 do_set_program_inouts(exec_list
*instructions
, struct gl_program
*prog
,
2303 GLenum shader_type
);
2306 prototype_string(const glsl_type
*return_type
, const char *name
,
2307 exec_list
*parameters
);
2310 mode_string(const ir_variable
*var
);
2313 #endif /* __cplusplus */
2315 extern void _mesa_print_ir(struct exec_list
*instructions
,
2316 struct _mesa_glsl_parse_state
*state
);
2323 vertices_per_prim(GLenum prim
);