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 */
91 * Base class of all IR instructions
93 class ir_instruction
: public exec_node
{
95 enum ir_node_type ir_type
;
98 * GCC 4.7+ and clang warn when deleting an ir_instruction unless
99 * there's a virtual destructor present. Because we almost
100 * universally use ralloc for our memory management of
101 * ir_instructions, the destructor doesn't need to do any work.
103 virtual ~ir_instruction()
107 /** ir_print_visitor helper for debugging. */
108 void print(void) const;
109 void fprint(FILE *f
) const;
111 virtual void accept(ir_visitor
*) = 0;
112 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*) = 0;
113 virtual ir_instruction
*clone(void *mem_ctx
,
114 struct hash_table
*ht
) const = 0;
117 * \name IR instruction downcast functions
119 * These functions either cast the object to a derived class or return
120 * \c NULL if the object's type does not match the specified derived class.
121 * Additional downcast functions will be added as needed.
124 virtual class ir_variable
* as_variable() { return NULL
; }
125 virtual class ir_function
* as_function() { return NULL
; }
126 virtual class ir_dereference
* as_dereference() { return NULL
; }
127 virtual class ir_dereference_array
* as_dereference_array() { return NULL
; }
128 virtual class ir_dereference_variable
*as_dereference_variable() { return NULL
; }
129 virtual class ir_dereference_record
*as_dereference_record() { return NULL
; }
130 virtual class ir_expression
* as_expression() { return NULL
; }
131 virtual class ir_rvalue
* as_rvalue() { return NULL
; }
132 virtual class ir_loop
* as_loop() { return NULL
; }
133 virtual class ir_assignment
* as_assignment() { return NULL
; }
134 virtual class ir_call
* as_call() { return NULL
; }
135 virtual class ir_return
* as_return() { return NULL
; }
136 virtual class ir_if
* as_if() { return NULL
; }
137 virtual class ir_swizzle
* as_swizzle() { return NULL
; }
138 virtual class ir_texture
* as_texture() { return NULL
; }
139 virtual class ir_constant
* as_constant() { return NULL
; }
140 virtual class ir_discard
* as_discard() { return NULL
; }
141 virtual class ir_jump
* as_jump() { return NULL
; }
145 * IR equality method: Return true if the referenced instruction would
146 * return the same value as this one.
148 * This intended to be used for CSE and algebraic optimizations, on rvalues
149 * in particular. No support for other instruction types (assignments,
150 * jumps, calls, etc.) is planned.
152 virtual bool equals(ir_instruction
*ir
, enum ir_node_type ignore
= ir_type_unset
);
157 ir_type
= ir_type_unset
;
163 * The base class for all "values"/expression trees.
165 class ir_rvalue
: public ir_instruction
{
167 const struct glsl_type
*type
;
169 virtual ir_rvalue
*clone(void *mem_ctx
, struct hash_table
*) const;
171 virtual void accept(ir_visitor
*v
)
176 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
178 virtual ir_constant
*constant_expression_value(struct hash_table
*variable_context
= NULL
);
180 virtual ir_rvalue
* as_rvalue()
185 ir_rvalue
*as_rvalue_to_saturate();
187 virtual bool is_lvalue() const
193 * Get the variable that is ultimately referenced by an r-value
195 virtual ir_variable
*variable_referenced() const
202 * If an r-value is a reference to a whole variable, get that variable
205 * Pointer to a variable that is completely dereferenced by the r-value. If
206 * the r-value is not a dereference or the dereference does not access the
207 * entire variable (i.e., it's just one array element, struct field), \c NULL
210 virtual ir_variable
*whole_variable_referenced()
216 * Determine if an r-value has the value zero
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 * zero (or \c false for booleans).
223 * \sa ir_constant::has_value, ir_rvalue::is_one, ir_rvalue::is_negative_one,
224 * ir_constant::is_basis
226 virtual bool is_zero() const;
229 * Determine if an r-value has the value 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 * one (or \c true for booleans).
236 * \sa ir_constant::has_value, ir_rvalue::is_zero, ir_rvalue::is_negative_one,
237 * ir_constant::is_basis
239 virtual bool is_one() const;
242 * Determine if an r-value has the value negative one
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 all elements set to the value
247 * negative one. For boolean types, the result is always \c false.
249 * \sa ir_constant::has_value, ir_rvalue::is_zero, ir_rvalue::is_one
250 * ir_constant::is_basis
252 virtual bool is_negative_one() const;
255 * Determine if an r-value is a basis vector
257 * The base implementation of this function always returns \c false. The
258 * \c ir_constant class over-rides this function to return \c true \b only
259 * for vector and scalar types that have one element set to the value one,
260 * and the other elements set to the value zero. For boolean types, the
261 * result is always \c false.
263 * \sa ir_constant::has_value, ir_rvalue::is_zero, ir_rvalue::is_one,
264 * is_constant::is_negative_one
266 virtual bool is_basis() const;
269 * Determine if an r-value is an unsigned integer constant which can be
272 * \sa ir_constant::is_uint16_constant.
274 virtual bool is_uint16_constant() const { return false; }
277 * Return a generic value of error_type.
279 * Allocation will be performed with 'mem_ctx' as ralloc owner.
281 static ir_rvalue
*error_value(void *mem_ctx
);
289 * Variable storage classes
291 enum ir_variable_mode
{
292 ir_var_auto
= 0, /**< Function local variables and globals. */
293 ir_var_uniform
, /**< Variable declared as a uniform. */
298 ir_var_function_inout
,
299 ir_var_const_in
, /**< "in" param that must be a constant expression */
300 ir_var_system_value
, /**< Ex: front-face, instance-id, etc. */
301 ir_var_temporary
, /**< Temporary variable generated during compilation. */
302 ir_var_mode_count
/**< Number of variable modes */
306 * Enum keeping track of how a variable was declared. For error checking of
307 * the gl_PerVertex redeclaration rules.
309 enum ir_var_declaration_type
{
311 * Normal declaration (for most variables, this means an explicit
312 * declaration. Exception: temporaries are always implicitly declared, but
313 * they still use ir_var_declared_normally).
315 * Note: an ir_variable that represents a named interface block uses
316 * ir_var_declared_normally.
318 ir_var_declared_normally
= 0,
321 * Variable was explicitly declared (or re-declared) in an unnamed
324 ir_var_declared_in_block
,
327 * Variable is an implicitly declared built-in that has not been explicitly
328 * re-declared by the shader.
330 ir_var_declared_implicitly
,
334 * \brief Layout qualifiers for gl_FragDepth.
336 * The AMD/ARB_conservative_depth extensions allow gl_FragDepth to be redeclared
337 * with a layout qualifier.
339 enum ir_depth_layout
{
340 ir_depth_layout_none
, /**< No depth layout is specified. */
342 ir_depth_layout_greater
,
343 ir_depth_layout_less
,
344 ir_depth_layout_unchanged
348 * \brief Convert depth layout qualifier to string.
351 depth_layout_string(ir_depth_layout layout
);
354 * Description of built-in state associated with a uniform
356 * \sa ir_variable::state_slots
358 struct ir_state_slot
{
365 * Get the string value for an interpolation qualifier
367 * \return The string that would be used in a shader to specify \c
368 * mode will be returned.
370 * This function is used to generate error messages of the form "shader
371 * uses %s interpolation qualifier", so in the case where there is no
372 * interpolation qualifier, it returns "no".
374 * This function should only be used on a shader input or output variable.
376 const char *interpolation_string(unsigned interpolation
);
379 class ir_variable
: public ir_instruction
{
381 ir_variable(const struct glsl_type
*, const char *, ir_variable_mode
);
383 virtual ir_variable
*clone(void *mem_ctx
, struct hash_table
*ht
) const;
385 virtual ir_variable
*as_variable()
390 virtual void accept(ir_visitor
*v
)
395 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
399 * Determine how this variable should be interpolated based on its
400 * interpolation qualifier (if present), whether it is gl_Color or
401 * gl_SecondaryColor, and whether flatshading is enabled in the current GL
404 * The return value will always be either INTERP_QUALIFIER_SMOOTH,
405 * INTERP_QUALIFIER_NOPERSPECTIVE, or INTERP_QUALIFIER_FLAT.
407 glsl_interp_qualifier
determine_interpolation_mode(bool flat_shade
);
410 * Determine whether or not a variable is part of a uniform block.
412 inline bool is_in_uniform_block() const
414 return this->data
.mode
== ir_var_uniform
&& this->interface_type
!= NULL
;
418 * Determine whether or not a variable is the declaration of an interface
421 * For the first declaration below, there will be an \c ir_variable named
422 * "instance" whose type and whose instance_type will be the same
423 * \cglsl_type. For the second declaration, there will be an \c ir_variable
424 * named "f" whose type is float and whose instance_type is B2.
426 * "instance" is an interface instance variable, but "f" is not.
436 inline bool is_interface_instance() const
438 const glsl_type
*const t
= this->type
;
440 return (t
== this->interface_type
)
441 || (t
->is_array() && t
->fields
.array
== this->interface_type
);
445 * Set this->interface_type on a newly created variable.
447 void init_interface_type(const struct glsl_type
*type
)
449 assert(this->interface_type
== NULL
);
450 this->interface_type
= type
;
451 if (this->is_interface_instance()) {
452 this->max_ifc_array_access
=
453 rzalloc_array(this, unsigned, type
->length
);
458 * Change this->interface_type on a variable that previously had a
459 * different, but compatible, interface_type. This is used during linking
460 * to set the size of arrays in interface blocks.
462 void change_interface_type(const struct glsl_type
*type
)
464 if (this->max_ifc_array_access
!= NULL
) {
465 /* max_ifc_array_access has already been allocated, so make sure the
466 * new interface has the same number of fields as the old one.
468 assert(this->interface_type
->length
== type
->length
);
470 this->interface_type
= type
;
474 * Change this->interface_type on a variable that previously had a
475 * different, and incompatible, interface_type. This is used during
476 * compilation to handle redeclaration of the built-in gl_PerVertex
479 void reinit_interface_type(const struct glsl_type
*type
)
481 if (this->max_ifc_array_access
!= NULL
) {
483 /* Redeclaring gl_PerVertex is only allowed if none of the built-ins
484 * it defines have been accessed yet; so it's safe to throw away the
485 * old max_ifc_array_access pointer, since all of its values are
488 for (unsigned i
= 0; i
< this->interface_type
->length
; i
++)
489 assert(this->max_ifc_array_access
[i
] == 0);
491 ralloc_free(this->max_ifc_array_access
);
492 this->max_ifc_array_access
= NULL
;
494 this->interface_type
= NULL
;
495 init_interface_type(type
);
498 const glsl_type
*get_interface_type() const
500 return this->interface_type
;
504 * Declared type of the variable
506 const struct glsl_type
*type
;
509 * Declared name of the variable
514 * For variables which satisfy the is_interface_instance() predicate, this
515 * points to an array of integers such that if the ith member of the
516 * interface block is an array, max_ifc_array_access[i] is the maximum
517 * array element of that member that has been accessed. If the ith member
518 * of the interface block is not an array, max_ifc_array_access[i] is
521 * For variables whose type is not an interface block, this pointer is
524 unsigned *max_ifc_array_access
;
526 struct ir_variable_data
{
529 * Is the variable read-only?
531 * This is set for variables declared as \c const, shader inputs,
534 unsigned read_only
:1;
537 unsigned invariant
:1;
540 * Has this variable been used for reading or writing?
542 * Several GLSL semantic checks require knowledge of whether or not a
543 * variable has been used. For example, it is an error to redeclare a
544 * variable as invariant after it has been used.
546 * This is only maintained in the ast_to_hir.cpp path, not in
547 * Mesa's fixed function or ARB program paths.
552 * Has this variable been statically assigned?
554 * This answers whether the variable was assigned in any path of
555 * the shader during ast_to_hir. This doesn't answer whether it is
556 * still written after dead code removal, nor is it maintained in
557 * non-ast_to_hir.cpp (GLSL parsing) paths.
562 * Enum indicating how the variable was declared. See
563 * ir_var_declaration_type.
565 * This is used to detect certain kinds of illegal variable redeclarations.
567 unsigned how_declared
:2;
570 * Storage class of the variable.
572 * \sa ir_variable_mode
577 * Interpolation mode for shader inputs / outputs
579 * \sa ir_variable_interpolation
581 unsigned interpolation
:2;
584 * \name ARB_fragment_coord_conventions
587 unsigned origin_upper_left
:1;
588 unsigned pixel_center_integer
:1;
592 * Was the location explicitly set in the shader?
594 * If the location is explicitly set in the shader, it \b cannot be changed
595 * by the linker or by the API (e.g., calls to \c glBindAttribLocation have
598 unsigned explicit_location
:1;
599 unsigned explicit_index
:1;
602 * Was an initial binding explicitly set in the shader?
604 * If so, constant_value contains an integer ir_constant representing the
605 * initial binding point.
607 unsigned explicit_binding
:1;
610 * Does this variable have an initializer?
612 * This is used by the linker to cross-validiate initializers of global
615 unsigned has_initializer
:1;
618 * Is this variable a generic output or input that has not yet been matched
619 * up to a variable in another stage of the pipeline?
621 * This is used by the linker as scratch storage while assigning locations
622 * to generic inputs and outputs.
624 unsigned is_unmatched_generic_inout
:1;
627 * If non-zero, then this variable may be packed along with other variables
628 * into a single varying slot, so this offset should be applied when
629 * accessing components. For example, an offset of 1 means that the x
630 * component of this variable is actually stored in component y of the
631 * location specified by \c location.
633 unsigned location_frac
:2;
636 * Non-zero if this variable was created by lowering a named interface
637 * block which was not an array.
639 * Note that this variable and \c from_named_ifc_block_array will never
642 unsigned from_named_ifc_block_nonarray
:1;
645 * Non-zero if this variable was created by lowering a named interface
646 * block which was an array.
648 * Note that this variable and \c from_named_ifc_block_nonarray will never
651 unsigned from_named_ifc_block_array
:1;
654 * \brief Layout qualifier for gl_FragDepth.
656 * This is not equal to \c ir_depth_layout_none if and only if this
657 * variable is \c gl_FragDepth and a layout qualifier is specified.
659 ir_depth_layout depth_layout
;
662 * Storage location of the base of this variable
664 * The precise meaning of this field depends on the nature of the variable.
666 * - Vertex shader input: one of the values from \c gl_vert_attrib.
667 * - Vertex shader output: one of the values from \c gl_varying_slot.
668 * - Geometry shader input: one of the values from \c gl_varying_slot.
669 * - Geometry shader output: one of the values from \c gl_varying_slot.
670 * - Fragment shader input: one of the values from \c gl_varying_slot.
671 * - Fragment shader output: one of the values from \c gl_frag_result.
672 * - Uniforms: Per-stage uniform slot number for default uniform block.
673 * - Uniforms: Index within the uniform block definition for UBO members.
674 * - Other: This field is not currently used.
676 * If the variable is a uniform, shader input, or shader output, and the
677 * slot has not been assigned, the value will be -1.
682 * output index for dual source blending.
687 * Initial binding point for a sampler or UBO.
689 * For array types, this represents the binding point for the first element.
694 * Location an atomic counter is stored at.
697 unsigned buffer_index
;
702 * ARB_shader_image_load_store qualifiers.
705 bool read_only
; /**< "readonly" qualifier. */
706 bool write_only
; /**< "writeonly" qualifier. */
711 /** Image internal format if specified explicitly, otherwise GL_NONE. */
716 * Highest element accessed with a constant expression array index
718 * Not used for non-array variables.
720 unsigned max_array_access
;
725 * Built-in state that backs this uniform
727 * Once set at variable creation, \c state_slots must remain invariant.
728 * This is because, ideally, this array would be shared by all clones of
729 * this variable in the IR tree. In other words, we'd really like for it
730 * to be a fly-weight.
732 * If the variable is not a uniform, \c num_state_slots will be zero and
733 * \c state_slots will be \c NULL.
736 unsigned num_state_slots
; /**< Number of state slots used */
737 ir_state_slot
*state_slots
; /**< State descriptors. */
741 * Emit a warning if this variable is accessed.
743 const char *warn_extension
;
746 * Value assigned in the initializer of a variable declared "const"
748 ir_constant
*constant_value
;
751 * Constant expression assigned in the initializer of the variable
754 * This field and \c ::constant_value are distinct. Even if the two fields
755 * refer to constants with the same value, they must point to separate
758 ir_constant
*constant_initializer
;
762 * For variables that are in an interface block or are an instance of an
763 * interface block, this is the \c GLSL_TYPE_INTERFACE type for that block.
765 * \sa ir_variable::location
767 const glsl_type
*interface_type
;
771 * A function that returns whether a built-in function is available in the
772 * current shading language (based on version, ES or desktop, and extensions).
774 typedef bool (*builtin_available_predicate
)(const _mesa_glsl_parse_state
*);
778 * The representation of a function instance; may be the full definition or
779 * simply a prototype.
781 class ir_function_signature
: public ir_instruction
{
782 /* An ir_function_signature will be part of the list of signatures in
786 ir_function_signature(const glsl_type
*return_type
,
787 builtin_available_predicate builtin_avail
= NULL
);
789 virtual ir_function_signature
*clone(void *mem_ctx
,
790 struct hash_table
*ht
) const;
791 ir_function_signature
*clone_prototype(void *mem_ctx
,
792 struct hash_table
*ht
) const;
794 virtual void accept(ir_visitor
*v
)
799 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
802 * Attempt to evaluate this function as a constant expression,
803 * given a list of the actual parameters and the variable context.
804 * Returns NULL for non-built-ins.
806 ir_constant
*constant_expression_value(exec_list
*actual_parameters
, struct hash_table
*variable_context
);
809 * Get the name of the function for which this is a signature
811 const char *function_name() const;
814 * Get a handle to the function for which this is a signature
816 * There is no setter function, this function returns a \c const pointer,
817 * and \c ir_function_signature::_function is private for a reason. The
818 * only way to make a connection between a function and function signature
819 * is via \c ir_function::add_signature. This helps ensure that certain
820 * invariants (i.e., a function signature is in the list of signatures for
821 * its \c _function) are met.
823 * \sa ir_function::add_signature
825 inline const class ir_function
*function() const
827 return this->_function
;
831 * Check whether the qualifiers match between this signature's parameters
832 * and the supplied parameter list. If not, returns the name of the first
833 * parameter with mismatched qualifiers (for use in error messages).
835 const char *qualifiers_match(exec_list
*params
);
838 * Replace the current parameter list with the given one. This is useful
839 * if the current information came from a prototype, and either has invalid
840 * or missing parameter names.
842 void replace_parameters(exec_list
*new_params
);
845 * Function return type.
847 * \note This discards the optional precision qualifier.
849 const struct glsl_type
*return_type
;
852 * List of ir_variable of function parameters.
854 * This represents the storage. The paramaters passed in a particular
855 * call will be in ir_call::actual_paramaters.
857 struct exec_list parameters
;
859 /** Whether or not this function has a body (which may be empty). */
860 unsigned is_defined
:1;
862 /** Whether or not this function signature is a built-in. */
863 bool is_builtin() const;
866 * Whether or not this function is an intrinsic to be implemented
871 /** Whether or not a built-in is available for this shader. */
872 bool is_builtin_available(const _mesa_glsl_parse_state
*state
) const;
874 /** Body of instructions in the function. */
875 struct exec_list body
;
879 * A function pointer to a predicate that answers whether a built-in
880 * function is available in the current shader. NULL if not a built-in.
882 builtin_available_predicate builtin_avail
;
884 /** Function of which this signature is one overload. */
885 class ir_function
*_function
;
887 /** Function signature of which this one is a prototype clone */
888 const ir_function_signature
*origin
;
890 friend class ir_function
;
893 * Helper function to run a list of instructions for constant
894 * expression evaluation.
896 * The hash table represents the values of the visible variables.
897 * There are no scoping issues because the table is indexed on
898 * ir_variable pointers, not variable names.
900 * Returns false if the expression is not constant, true otherwise,
901 * and the value in *result if result is non-NULL.
903 bool constant_expression_evaluate_expression_list(const struct exec_list
&body
,
904 struct hash_table
*variable_context
,
905 ir_constant
**result
);
910 * Header for tracking multiple overloaded functions with the same name.
911 * Contains a list of ir_function_signatures representing each of the
914 class ir_function
: public ir_instruction
{
916 ir_function(const char *name
);
918 virtual ir_function
*clone(void *mem_ctx
, struct hash_table
*ht
) const;
920 virtual ir_function
*as_function()
925 virtual void accept(ir_visitor
*v
)
930 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
932 void add_signature(ir_function_signature
*sig
)
934 sig
->_function
= this;
935 this->signatures
.push_tail(sig
);
939 * Find a signature that matches a set of actual parameters, taking implicit
940 * conversions into account. Also flags whether the match was exact.
942 ir_function_signature
*matching_signature(_mesa_glsl_parse_state
*state
,
943 const exec_list
*actual_param
,
944 bool *match_is_exact
);
947 * Find a signature that matches a set of actual parameters, taking implicit
948 * conversions into account.
950 ir_function_signature
*matching_signature(_mesa_glsl_parse_state
*state
,
951 const exec_list
*actual_param
);
954 * Find a signature that exactly matches a set of actual parameters without
955 * any implicit type conversions.
957 ir_function_signature
*exact_matching_signature(_mesa_glsl_parse_state
*state
,
958 const exec_list
*actual_ps
);
961 * Name of the function.
965 /** Whether or not this function has a signature that isn't a built-in. */
966 bool has_user_signature();
969 * List of ir_function_signature for each overloaded function with this name.
971 struct exec_list signatures
;
974 inline const char *ir_function_signature::function_name() const
976 return this->_function
->name
;
982 * IR instruction representing high-level if-statements
984 class ir_if
: public ir_instruction
{
986 ir_if(ir_rvalue
*condition
)
987 : condition(condition
)
989 ir_type
= ir_type_if
;
992 virtual ir_if
*clone(void *mem_ctx
, struct hash_table
*ht
) const;
994 virtual ir_if
*as_if()
999 virtual void accept(ir_visitor
*v
)
1004 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1006 ir_rvalue
*condition
;
1007 /** List of ir_instruction for the body of the then branch */
1008 exec_list then_instructions
;
1009 /** List of ir_instruction for the body of the else branch */
1010 exec_list else_instructions
;
1015 * IR instruction representing a high-level loop structure.
1017 class ir_loop
: public ir_instruction
{
1021 virtual ir_loop
*clone(void *mem_ctx
, struct hash_table
*ht
) const;
1023 virtual void accept(ir_visitor
*v
)
1028 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1030 virtual ir_loop
*as_loop()
1035 /** List of ir_instruction that make up the body of the loop. */
1036 exec_list body_instructions
;
1040 class ir_assignment
: public ir_instruction
{
1042 ir_assignment(ir_rvalue
*lhs
, ir_rvalue
*rhs
, ir_rvalue
*condition
= NULL
);
1045 * Construct an assignment with an explicit write mask
1048 * Since a write mask is supplied, the LHS must already be a bare
1049 * \c ir_dereference. The cannot be any swizzles in the LHS.
1051 ir_assignment(ir_dereference
*lhs
, ir_rvalue
*rhs
, ir_rvalue
*condition
,
1052 unsigned write_mask
);
1054 virtual ir_assignment
*clone(void *mem_ctx
, struct hash_table
*ht
) const;
1056 virtual ir_constant
*constant_expression_value(struct hash_table
*variable_context
= NULL
);
1058 virtual void accept(ir_visitor
*v
)
1063 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1065 virtual ir_assignment
* as_assignment()
1071 * Get a whole variable written by an assignment
1073 * If the LHS of the assignment writes a whole variable, the variable is
1074 * returned. Otherwise \c NULL is returned. Examples of whole-variable
1077 * - Assigning to a scalar
1078 * - Assigning to all components of a vector
1079 * - Whole array (or matrix) assignment
1080 * - Whole structure assignment
1082 ir_variable
*whole_variable_written();
1085 * Set the LHS of an assignment
1087 void set_lhs(ir_rvalue
*lhs
);
1090 * Left-hand side of the assignment.
1092 * This should be treated as read only. If you need to set the LHS of an
1093 * assignment, use \c ir_assignment::set_lhs.
1095 ir_dereference
*lhs
;
1098 * Value being assigned
1103 * Optional condition for the assignment.
1105 ir_rvalue
*condition
;
1109 * Component mask written
1111 * For non-vector types in the LHS, this field will be zero. For vector
1112 * types, a bit will be set for each component that is written. Note that
1113 * for \c vec2 and \c vec3 types only the lower bits will ever be set.
1115 * A partially-set write mask means that each enabled channel gets
1116 * the value from a consecutive channel of the rhs. For example,
1117 * to write just .xyw of gl_FrontColor with color:
1119 * (assign (constant bool (1)) (xyw)
1120 * (var_ref gl_FragColor)
1121 * (swiz xyw (var_ref color)))
1123 unsigned write_mask
:4;
1126 /* Update ir_expression::get_num_operands() and operator_strs when
1127 * updating this list.
1129 enum ir_expression_operation
{
1138 ir_unop_exp
, /**< Log base e on gentype */
1139 ir_unop_log
, /**< Natural log on gentype */
1142 ir_unop_f2i
, /**< Float-to-integer conversion. */
1143 ir_unop_f2u
, /**< Float-to-unsigned conversion. */
1144 ir_unop_i2f
, /**< Integer-to-float conversion. */
1145 ir_unop_f2b
, /**< Float-to-boolean conversion */
1146 ir_unop_b2f
, /**< Boolean-to-float conversion */
1147 ir_unop_i2b
, /**< int-to-boolean conversion */
1148 ir_unop_b2i
, /**< Boolean-to-int conversion */
1149 ir_unop_u2f
, /**< Unsigned-to-float conversion. */
1150 ir_unop_i2u
, /**< Integer-to-unsigned conversion. */
1151 ir_unop_u2i
, /**< Unsigned-to-integer conversion. */
1152 ir_unop_bitcast_i2f
, /**< Bit-identical int-to-float "conversion" */
1153 ir_unop_bitcast_f2i
, /**< Bit-identical float-to-int "conversion" */
1154 ir_unop_bitcast_u2f
, /**< Bit-identical uint-to-float "conversion" */
1155 ir_unop_bitcast_f2u
, /**< Bit-identical float-to-uint "conversion" */
1159 * \name Unary floating-point rounding operations.
1170 * \name Trigonometric operations.
1175 ir_unop_sin_reduced
, /**< Reduced range sin. [-pi, pi] */
1176 ir_unop_cos_reduced
, /**< Reduced range cos. [-pi, pi] */
1180 * \name Partial derivatives.
1188 * \name Floating point pack and unpack operations.
1191 ir_unop_pack_snorm_2x16
,
1192 ir_unop_pack_snorm_4x8
,
1193 ir_unop_pack_unorm_2x16
,
1194 ir_unop_pack_unorm_4x8
,
1195 ir_unop_pack_half_2x16
,
1196 ir_unop_unpack_snorm_2x16
,
1197 ir_unop_unpack_snorm_4x8
,
1198 ir_unop_unpack_unorm_2x16
,
1199 ir_unop_unpack_unorm_4x8
,
1200 ir_unop_unpack_half_2x16
,
1204 * \name Lowered floating point unpacking operations.
1206 * \see lower_packing_builtins_visitor::split_unpack_half_2x16
1209 ir_unop_unpack_half_2x16_split_x
,
1210 ir_unop_unpack_half_2x16_split_y
,
1214 * \name Bit operations, part of ARB_gpu_shader5.
1217 ir_unop_bitfield_reverse
,
1226 * A sentinel marking the last of the unary operations.
1228 ir_last_unop
= ir_unop_noise
,
1232 ir_binop_mul
, /**< Floating-point or low 32-bit integer multiply. */
1233 ir_binop_imul_high
, /**< Calculates the high 32-bits of a 64-bit multiply. */
1237 * Returns the carry resulting from the addition of the two arguments.
1244 * Returns the borrow resulting from the subtraction of the second argument
1245 * from the first argument.
1252 * Takes one of two combinations of arguments:
1255 * - mod(vecN, float)
1257 * Does not take integer types.
1262 * \name Binary comparison operators which return a boolean vector.
1263 * The type of both operands must be equal.
1273 * Returns single boolean for whether all components of operands[0]
1274 * equal the components of operands[1].
1278 * Returns single boolean for whether any component of operands[0]
1279 * is not equal to the corresponding component of operands[1].
1281 ir_binop_any_nequal
,
1285 * \name Bit-wise binary operations.
1306 * \name Lowered floating point packing operations.
1308 * \see lower_packing_builtins_visitor::split_pack_half_2x16
1311 ir_binop_pack_half_2x16_split
,
1315 * \name First half of a lowered bitfieldInsert() operation.
1317 * \see lower_instructions::bitfield_insert_to_bfm_bfi
1324 * Load a value the size of a given GLSL type from a uniform block.
1326 * operand0 is the ir_constant uniform block index in the linked shader.
1327 * operand1 is a byte offset within the uniform block.
1332 * \name Multiplies a number by two to a power, part of ARB_gpu_shader5.
1339 * Extract a scalar from a vector
1341 * operand0 is the vector
1342 * operand1 is the index of the field to read from operand0
1344 ir_binop_vector_extract
,
1347 * A sentinel marking the last of the binary operations.
1349 ir_last_binop
= ir_binop_vector_extract
,
1352 * \name Fused floating-point multiply-add, part of ARB_gpu_shader5.
1361 * \name Conditional Select
1363 * A vector conditional select instruction (like ?:, but operating per-
1364 * component on vectors).
1366 * \see lower_instructions_visitor::ldexp_to_arith
1373 * \name Second half of a lowered bitfieldInsert() operation.
1375 * \see lower_instructions::bitfield_insert_to_bfm_bfi
1381 ir_triop_bitfield_extract
,
1384 * Generate a value with one field of a vector changed
1386 * operand0 is the vector
1387 * operand1 is the value to write into the vector result
1388 * operand2 is the index in operand0 to be modified
1390 ir_triop_vector_insert
,
1393 * A sentinel marking the last of the ternary operations.
1395 ir_last_triop
= ir_triop_vector_insert
,
1397 ir_quadop_bitfield_insert
,
1402 * A sentinel marking the last of the ternary operations.
1404 ir_last_quadop
= ir_quadop_vector
,
1407 * A sentinel marking the last of all operations.
1409 ir_last_opcode
= ir_quadop_vector
1412 class ir_expression
: public ir_rvalue
{
1414 ir_expression(int op
, const struct glsl_type
*type
,
1415 ir_rvalue
*op0
, ir_rvalue
*op1
= NULL
,
1416 ir_rvalue
*op2
= NULL
, ir_rvalue
*op3
= NULL
);
1419 * Constructor for unary operation expressions
1421 ir_expression(int op
, ir_rvalue
*);
1424 * Constructor for binary operation expressions
1426 ir_expression(int op
, ir_rvalue
*op0
, ir_rvalue
*op1
);
1429 * Constructor for ternary operation expressions
1431 ir_expression(int op
, ir_rvalue
*op0
, ir_rvalue
*op1
, ir_rvalue
*op2
);
1433 virtual ir_expression
*as_expression()
1438 virtual bool equals(ir_instruction
*ir
, enum ir_node_type ignore
= ir_type_unset
);
1440 virtual ir_expression
*clone(void *mem_ctx
, struct hash_table
*ht
) const;
1443 * Attempt to constant-fold the expression
1445 * The "variable_context" hash table links ir_variable * to ir_constant *
1446 * that represent the variables' values. \c NULL represents an empty
1449 * If the expression cannot be constant folded, this method will return
1452 virtual ir_constant
*constant_expression_value(struct hash_table
*variable_context
= NULL
);
1455 * Determine the number of operands used by an expression
1457 static unsigned int get_num_operands(ir_expression_operation
);
1460 * Determine the number of operands used by an expression
1462 unsigned int get_num_operands() const
1464 return (this->operation
== ir_quadop_vector
)
1465 ? this->type
->vector_elements
: get_num_operands(operation
);
1469 * Return whether the expression operates on vectors horizontally.
1471 bool is_horizontal() const
1473 return operation
== ir_binop_all_equal
||
1474 operation
== ir_binop_any_nequal
||
1475 operation
== ir_unop_any
||
1476 operation
== ir_binop_dot
||
1477 operation
== ir_quadop_vector
;
1481 * Return a string representing this expression's operator.
1483 const char *operator_string();
1486 * Return a string representing this expression's operator.
1488 static const char *operator_string(ir_expression_operation
);
1492 * Do a reverse-lookup to translate the given string into an operator.
1494 static ir_expression_operation
get_operator(const char *);
1496 virtual void accept(ir_visitor
*v
)
1501 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1503 ir_expression_operation operation
;
1504 ir_rvalue
*operands
[4];
1509 * HIR instruction representing a high-level function call, containing a list
1510 * of parameters and returning a value in the supplied temporary.
1512 class ir_call
: public ir_instruction
{
1514 ir_call(ir_function_signature
*callee
,
1515 ir_dereference_variable
*return_deref
,
1516 exec_list
*actual_parameters
)
1517 : return_deref(return_deref
), callee(callee
)
1519 ir_type
= ir_type_call
;
1520 assert(callee
->return_type
!= NULL
);
1521 actual_parameters
->move_nodes_to(& this->actual_parameters
);
1522 this->use_builtin
= callee
->is_builtin();
1525 virtual ir_call
*clone(void *mem_ctx
, struct hash_table
*ht
) const;
1527 virtual ir_constant
*constant_expression_value(struct hash_table
*variable_context
= NULL
);
1529 virtual ir_call
*as_call()
1534 virtual void accept(ir_visitor
*v
)
1539 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1542 * Get the name of the function being called.
1544 const char *callee_name() const
1546 return callee
->function_name();
1550 * Generates an inline version of the function before @ir,
1551 * storing the return value in return_deref.
1553 void generate_inline(ir_instruction
*ir
);
1556 * Storage for the function's return value.
1557 * This must be NULL if the return type is void.
1559 ir_dereference_variable
*return_deref
;
1562 * The specific function signature being called.
1564 ir_function_signature
*callee
;
1566 /* List of ir_rvalue of paramaters passed in this call. */
1567 exec_list actual_parameters
;
1569 /** Should this call only bind to a built-in function? */
1575 * \name Jump-like IR instructions.
1577 * These include \c break, \c continue, \c return, and \c discard.
1580 class ir_jump
: public ir_instruction
{
1584 ir_type
= ir_type_unset
;
1588 virtual ir_jump
*as_jump()
1594 class ir_return
: public ir_jump
{
1599 this->ir_type
= ir_type_return
;
1602 ir_return(ir_rvalue
*value
)
1605 this->ir_type
= ir_type_return
;
1608 virtual ir_return
*clone(void *mem_ctx
, struct hash_table
*) const;
1610 virtual ir_return
*as_return()
1615 ir_rvalue
*get_value() const
1620 virtual void accept(ir_visitor
*v
)
1625 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1632 * Jump instructions used inside loops
1634 * These include \c break and \c continue. The \c break within a loop is
1635 * different from the \c break within a switch-statement.
1637 * \sa ir_switch_jump
1639 class ir_loop_jump
: public ir_jump
{
1646 ir_loop_jump(jump_mode mode
)
1648 this->ir_type
= ir_type_loop_jump
;
1652 virtual ir_loop_jump
*clone(void *mem_ctx
, struct hash_table
*) const;
1654 virtual void accept(ir_visitor
*v
)
1659 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1661 bool is_break() const
1663 return mode
== jump_break
;
1666 bool is_continue() const
1668 return mode
== jump_continue
;
1671 /** Mode selector for the jump instruction. */
1672 enum jump_mode mode
;
1676 * IR instruction representing discard statements.
1678 class ir_discard
: public ir_jump
{
1682 this->ir_type
= ir_type_discard
;
1683 this->condition
= NULL
;
1686 ir_discard(ir_rvalue
*cond
)
1688 this->ir_type
= ir_type_discard
;
1689 this->condition
= cond
;
1692 virtual ir_discard
*clone(void *mem_ctx
, struct hash_table
*ht
) const;
1694 virtual void accept(ir_visitor
*v
)
1699 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1701 virtual ir_discard
*as_discard()
1706 ir_rvalue
*condition
;
1712 * Texture sampling opcodes used in ir_texture
1714 enum ir_texture_opcode
{
1715 ir_tex
, /**< Regular texture look-up */
1716 ir_txb
, /**< Texture look-up with LOD bias */
1717 ir_txl
, /**< Texture look-up with explicit LOD */
1718 ir_txd
, /**< Texture look-up with partial derivatvies */
1719 ir_txf
, /**< Texel fetch with explicit LOD */
1720 ir_txf_ms
, /**< Multisample texture fetch */
1721 ir_txs
, /**< Texture size */
1722 ir_lod
, /**< Texture lod query */
1723 ir_tg4
, /**< Texture gather */
1724 ir_query_levels
/**< Texture levels query */
1729 * IR instruction to sample a texture
1731 * The specific form of the IR instruction depends on the \c mode value
1732 * selected from \c ir_texture_opcodes. In the printed IR, these will
1735 * Texel offset (0 or an expression)
1736 * | Projection divisor
1737 * | | Shadow comparitor
1740 * (tex <type> <sampler> <coordinate> 0 1 ( ))
1741 * (txb <type> <sampler> <coordinate> 0 1 ( ) <bias>)
1742 * (txl <type> <sampler> <coordinate> 0 1 ( ) <lod>)
1743 * (txd <type> <sampler> <coordinate> 0 1 ( ) (dPdx dPdy))
1744 * (txf <type> <sampler> <coordinate> 0 <lod>)
1746 * <type> <sampler> <coordinate> <sample_index>)
1747 * (txs <type> <sampler> <lod>)
1748 * (lod <type> <sampler> <coordinate>)
1749 * (tg4 <type> <sampler> <coordinate> <offset> <component>)
1750 * (query_levels <type> <sampler>)
1752 class ir_texture
: public ir_rvalue
{
1754 ir_texture(enum ir_texture_opcode op
)
1755 : op(op
), sampler(NULL
), coordinate(NULL
), projector(NULL
),
1756 shadow_comparitor(NULL
), offset(NULL
)
1758 this->ir_type
= ir_type_texture
;
1759 memset(&lod_info
, 0, sizeof(lod_info
));
1762 virtual ir_texture
*clone(void *mem_ctx
, struct hash_table
*) const;
1764 virtual ir_constant
*constant_expression_value(struct hash_table
*variable_context
= NULL
);
1766 virtual void accept(ir_visitor
*v
)
1771 virtual ir_texture
*as_texture()
1776 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1778 virtual bool equals(ir_instruction
*ir
, enum ir_node_type ignore
= ir_type_unset
);
1781 * Return a string representing the ir_texture_opcode.
1783 const char *opcode_string();
1785 /** Set the sampler and type. */
1786 void set_sampler(ir_dereference
*sampler
, const glsl_type
*type
);
1789 * Do a reverse-lookup to translate a string into an ir_texture_opcode.
1791 static ir_texture_opcode
get_opcode(const char *);
1793 enum ir_texture_opcode op
;
1795 /** Sampler to use for the texture access. */
1796 ir_dereference
*sampler
;
1798 /** Texture coordinate to sample */
1799 ir_rvalue
*coordinate
;
1802 * Value used for projective divide.
1804 * If there is no projective divide (the common case), this will be
1805 * \c NULL. Optimization passes should check for this to point to a constant
1806 * of 1.0 and replace that with \c NULL.
1808 ir_rvalue
*projector
;
1811 * Coordinate used for comparison on shadow look-ups.
1813 * If there is no shadow comparison, this will be \c NULL. For the
1814 * \c ir_txf opcode, this *must* be \c NULL.
1816 ir_rvalue
*shadow_comparitor
;
1818 /** Texel offset. */
1822 ir_rvalue
*lod
; /**< Floating point LOD */
1823 ir_rvalue
*bias
; /**< Floating point LOD bias */
1824 ir_rvalue
*sample_index
; /**< MSAA sample index */
1825 ir_rvalue
*component
; /**< Gather component selector */
1827 ir_rvalue
*dPdx
; /**< Partial derivative of coordinate wrt X */
1828 ir_rvalue
*dPdy
; /**< Partial derivative of coordinate wrt Y */
1834 struct ir_swizzle_mask
{
1841 * Number of components in the swizzle.
1843 unsigned num_components
:3;
1846 * Does the swizzle contain duplicate components?
1848 * L-value swizzles cannot contain duplicate components.
1850 unsigned has_duplicates
:1;
1854 class ir_swizzle
: public ir_rvalue
{
1856 ir_swizzle(ir_rvalue
*, unsigned x
, unsigned y
, unsigned z
, unsigned w
,
1859 ir_swizzle(ir_rvalue
*val
, const unsigned *components
, unsigned count
);
1861 ir_swizzle(ir_rvalue
*val
, ir_swizzle_mask mask
);
1863 virtual ir_swizzle
*clone(void *mem_ctx
, struct hash_table
*) const;
1865 virtual ir_constant
*constant_expression_value(struct hash_table
*variable_context
= NULL
);
1867 virtual ir_swizzle
*as_swizzle()
1873 * Construct an ir_swizzle from the textual representation. Can fail.
1875 static ir_swizzle
*create(ir_rvalue
*, const char *, unsigned vector_length
);
1877 virtual void accept(ir_visitor
*v
)
1882 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1884 virtual bool equals(ir_instruction
*ir
, enum ir_node_type ignore
= ir_type_unset
);
1886 bool is_lvalue() const
1888 return val
->is_lvalue() && !mask
.has_duplicates
;
1892 * Get the variable that is ultimately referenced by an r-value
1894 virtual ir_variable
*variable_referenced() const;
1897 ir_swizzle_mask mask
;
1901 * Initialize the mask component of a swizzle
1903 * This is used by the \c ir_swizzle constructors.
1905 void init_mask(const unsigned *components
, unsigned count
);
1909 class ir_dereference
: public ir_rvalue
{
1911 virtual ir_dereference
*clone(void *mem_ctx
, struct hash_table
*) const = 0;
1913 virtual ir_dereference
*as_dereference()
1918 bool is_lvalue() const;
1921 * Get the variable that is ultimately referenced by an r-value
1923 virtual ir_variable
*variable_referenced() const = 0;
1927 class ir_dereference_variable
: public ir_dereference
{
1929 ir_dereference_variable(ir_variable
*var
);
1931 virtual ir_dereference_variable
*clone(void *mem_ctx
,
1932 struct hash_table
*) const;
1934 virtual ir_constant
*constant_expression_value(struct hash_table
*variable_context
= NULL
);
1936 virtual ir_dereference_variable
*as_dereference_variable()
1941 virtual bool equals(ir_instruction
*ir
, enum ir_node_type ignore
= ir_type_unset
);
1944 * Get the variable that is ultimately referenced by an r-value
1946 virtual ir_variable
*variable_referenced() const
1951 virtual ir_variable
*whole_variable_referenced()
1953 /* ir_dereference_variable objects always dereference the entire
1954 * variable. However, if this dereference is dereferenced by anything
1955 * else, the complete deferefernce chain is not a whole-variable
1956 * dereference. This method should only be called on the top most
1957 * ir_rvalue in a dereference chain.
1962 virtual void accept(ir_visitor
*v
)
1967 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1970 * Object being dereferenced.
1976 class ir_dereference_array
: public ir_dereference
{
1978 ir_dereference_array(ir_rvalue
*value
, ir_rvalue
*array_index
);
1980 ir_dereference_array(ir_variable
*var
, ir_rvalue
*array_index
);
1982 virtual ir_dereference_array
*clone(void *mem_ctx
,
1983 struct hash_table
*) const;
1985 virtual ir_constant
*constant_expression_value(struct hash_table
*variable_context
= NULL
);
1987 virtual ir_dereference_array
*as_dereference_array()
1992 virtual bool equals(ir_instruction
*ir
, enum ir_node_type ignore
= ir_type_unset
);
1995 * Get the variable that is ultimately referenced by an r-value
1997 virtual ir_variable
*variable_referenced() const
1999 return this->array
->variable_referenced();
2002 virtual void accept(ir_visitor
*v
)
2007 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
2010 ir_rvalue
*array_index
;
2013 void set_array(ir_rvalue
*value
);
2017 class ir_dereference_record
: public ir_dereference
{
2019 ir_dereference_record(ir_rvalue
*value
, const char *field
);
2021 ir_dereference_record(ir_variable
*var
, const char *field
);
2023 virtual ir_dereference_record
*clone(void *mem_ctx
,
2024 struct hash_table
*) const;
2026 virtual ir_constant
*constant_expression_value(struct hash_table
*variable_context
= NULL
);
2028 virtual ir_dereference_record
*as_dereference_record()
2034 * Get the variable that is ultimately referenced by an r-value
2036 virtual ir_variable
*variable_referenced() const
2038 return this->record
->variable_referenced();
2041 virtual void accept(ir_visitor
*v
)
2046 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
2054 * Data stored in an ir_constant
2056 union ir_constant_data
{
2064 class ir_constant
: public ir_rvalue
{
2066 ir_constant(const struct glsl_type
*type
, const ir_constant_data
*data
);
2067 ir_constant(bool b
, unsigned vector_elements
=1);
2068 ir_constant(unsigned int u
, unsigned vector_elements
=1);
2069 ir_constant(int i
, unsigned vector_elements
=1);
2070 ir_constant(float f
, unsigned vector_elements
=1);
2073 * Construct an ir_constant from a list of ir_constant values
2075 ir_constant(const struct glsl_type
*type
, exec_list
*values
);
2078 * Construct an ir_constant from a scalar component of another ir_constant
2080 * The new \c ir_constant inherits the type of the component from the
2084 * In the case of a matrix constant, the new constant is a scalar, \b not
2087 ir_constant(const ir_constant
*c
, unsigned i
);
2090 * Return a new ir_constant of the specified type containing all zeros.
2092 static ir_constant
*zero(void *mem_ctx
, const glsl_type
*type
);
2094 virtual ir_constant
*clone(void *mem_ctx
, struct hash_table
*) const;
2096 virtual ir_constant
*constant_expression_value(struct hash_table
*variable_context
= NULL
);
2098 virtual ir_constant
*as_constant()
2103 virtual void accept(ir_visitor
*v
)
2108 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
2110 virtual bool equals(ir_instruction
*ir
, enum ir_node_type ignore
= ir_type_unset
);
2113 * Get a particular component of a constant as a specific type
2115 * This is useful, for example, to get a value from an integer constant
2116 * as a float or bool. This appears frequently when constructors are
2117 * called with all constant parameters.
2120 bool get_bool_component(unsigned i
) const;
2121 float get_float_component(unsigned i
) const;
2122 int get_int_component(unsigned i
) const;
2123 unsigned get_uint_component(unsigned i
) const;
2126 ir_constant
*get_array_element(unsigned i
) const;
2128 ir_constant
*get_record_field(const char *name
);
2131 * Copy the values on another constant at a given offset.
2133 * The offset is ignored for array or struct copies, it's only for
2134 * scalars or vectors into vectors or matrices.
2136 * With identical types on both sides and zero offset it's clone()
2137 * without creating a new object.
2140 void copy_offset(ir_constant
*src
, int offset
);
2143 * Copy the values on another constant at a given offset and
2144 * following an assign-like mask.
2146 * The mask is ignored for scalars.
2148 * Note that this function only handles what assign can handle,
2149 * i.e. at most a vector as source and a column of a matrix as
2153 void copy_masked_offset(ir_constant
*src
, int offset
, unsigned int mask
);
2156 * Determine whether a constant has the same value as another constant
2158 * \sa ir_constant::is_zero, ir_constant::is_one,
2159 * ir_constant::is_negative_one, ir_constant::is_basis
2161 bool has_value(const ir_constant
*) const;
2164 * Return true if this ir_constant represents the given value.
2166 * For vectors, this checks that each component is the given value.
2168 virtual bool is_value(float f
, int i
) const;
2169 virtual bool is_zero() const;
2170 virtual bool is_one() const;
2171 virtual bool is_negative_one() const;
2172 virtual bool is_basis() const;
2175 * Return true for constants that could be stored as 16-bit unsigned values.
2177 * Note that this will return true even for signed integer ir_constants, as
2178 * long as the value is non-negative and fits in 16-bits.
2180 virtual bool is_uint16_constant() const;
2183 * Value of the constant.
2185 * The field used to back the values supplied by the constant is determined
2186 * by the type associated with the \c ir_instruction. Constants may be
2187 * scalars, vectors, or matrices.
2189 union ir_constant_data value
;
2191 /* Array elements */
2192 ir_constant
**array_elements
;
2194 /* Structure fields */
2195 exec_list components
;
2199 * Parameterless constructor only used by the clone method
2205 * IR instruction to emit a vertex in a geometry shader.
2207 class ir_emit_vertex
: public ir_instruction
{
2211 ir_type
= ir_type_emit_vertex
;
2214 virtual void accept(ir_visitor
*v
)
2219 virtual ir_emit_vertex
*clone(void *mem_ctx
, struct hash_table
*) const
2221 return new(mem_ctx
) ir_emit_vertex();
2224 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
2228 * IR instruction to complete the current primitive and start a new one in a
2231 class ir_end_primitive
: public ir_instruction
{
2235 ir_type
= ir_type_end_primitive
;
2238 virtual void accept(ir_visitor
*v
)
2243 virtual ir_end_primitive
*clone(void *mem_ctx
, struct hash_table
*) const
2245 return new(mem_ctx
) ir_end_primitive();
2248 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
2254 * Apply a visitor to each IR node in a list
2257 visit_exec_list(exec_list
*list
, ir_visitor
*visitor
);
2260 * Validate invariants on each IR node in a list
2262 void validate_ir_tree(exec_list
*instructions
);
2264 struct _mesa_glsl_parse_state
;
2265 struct gl_shader_program
;
2268 * Detect whether an unlinked shader contains static recursion
2270 * If the list of instructions is determined to contain static recursion,
2271 * \c _mesa_glsl_error will be called to emit error messages for each function
2272 * that is in the recursion cycle.
2275 detect_recursion_unlinked(struct _mesa_glsl_parse_state
*state
,
2276 exec_list
*instructions
);
2279 * Detect whether a linked shader contains static recursion
2281 * If the list of instructions is determined to contain static recursion,
2282 * \c link_error_printf will be called to emit error messages for each function
2283 * that is in the recursion cycle. In addition,
2284 * \c gl_shader_program::LinkStatus will be set to false.
2287 detect_recursion_linked(struct gl_shader_program
*prog
,
2288 exec_list
*instructions
);
2291 * Make a clone of each IR instruction in a list
2293 * \param in List of IR instructions that are to be cloned
2294 * \param out List to hold the cloned instructions
2297 clone_ir_list(void *mem_ctx
, exec_list
*out
, const exec_list
*in
);
2300 _mesa_glsl_initialize_variables(exec_list
*instructions
,
2301 struct _mesa_glsl_parse_state
*state
);
2304 _mesa_glsl_initialize_functions(_mesa_glsl_parse_state
*state
);
2307 _mesa_glsl_initialize_builtin_functions();
2309 extern ir_function_signature
*
2310 _mesa_glsl_find_builtin_function(_mesa_glsl_parse_state
*state
,
2311 const char *name
, exec_list
*actual_parameters
);
2314 _mesa_glsl_get_builtin_function_shader(void);
2317 _mesa_glsl_release_functions(void);
2320 _mesa_glsl_release_builtin_functions(void);
2323 reparent_ir(exec_list
*list
, void *mem_ctx
);
2325 struct glsl_symbol_table
;
2328 import_prototypes(const exec_list
*source
, exec_list
*dest
,
2329 struct glsl_symbol_table
*symbols
, void *mem_ctx
);
2332 ir_has_call(ir_instruction
*ir
);
2335 do_set_program_inouts(exec_list
*instructions
, struct gl_program
*prog
,
2336 gl_shader_stage shader_stage
);
2339 prototype_string(const glsl_type
*return_type
, const char *name
,
2340 exec_list
*parameters
);
2343 mode_string(const ir_variable
*var
);
2346 * Built-in / reserved GL variables names start with "gl_"
2349 is_gl_identifier(const char *s
)
2351 return s
&& s
[0] == 'g' && s
[1] == 'l' && s
[2] == '_';
2355 #endif /* __cplusplus */
2357 extern void _mesa_print_ir(FILE *f
, struct exec_list
*instructions
,
2358 struct _mesa_glsl_parse_state
*state
);
2361 fprint_ir(FILE *f
, const void *instruction
);
2368 vertices_per_prim(GLenum prim
);