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.
32 #include "util/ralloc.h"
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.
62 ir_type_dereference_array
,
63 ir_type_dereference_record
,
64 ir_type_dereference_variable
,
73 ir_type_function_signature
,
80 ir_type_end_primitive
,
82 ir_type_max
, /**< maximum ir_type enum number, for validation */
83 ir_type_unset
= ir_type_max
88 * Base class of all IR instructions
90 class ir_instruction
: public exec_node
{
92 enum ir_node_type ir_type
;
95 * GCC 4.7+ and clang warn when deleting an ir_instruction unless
96 * there's a virtual destructor present. Because we almost
97 * universally use ralloc for our memory management of
98 * ir_instructions, the destructor doesn't need to do any work.
100 virtual ~ir_instruction()
104 /** ir_print_visitor helper for debugging. */
105 void print(void) const;
106 void fprint(FILE *f
) const;
108 virtual void accept(ir_visitor
*) = 0;
109 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*) = 0;
110 virtual ir_instruction
*clone(void *mem_ctx
,
111 struct hash_table
*ht
) const = 0;
113 bool is_rvalue() const
115 return ir_type
== ir_type_dereference_array
||
116 ir_type
== ir_type_dereference_record
||
117 ir_type
== ir_type_dereference_variable
||
118 ir_type
== ir_type_constant
||
119 ir_type
== ir_type_expression
||
120 ir_type
== ir_type_swizzle
||
121 ir_type
== ir_type_texture
;
124 bool is_dereference() const
126 return ir_type
== ir_type_dereference_array
||
127 ir_type
== ir_type_dereference_record
||
128 ir_type
== ir_type_dereference_variable
;
133 return ir_type
== ir_type_loop_jump
||
134 ir_type
== ir_type_return
||
135 ir_type
== ir_type_discard
;
139 * \name IR instruction downcast functions
141 * These functions either cast the object to a derived class or return
142 * \c NULL if the object's type does not match the specified derived class.
143 * Additional downcast functions will be added as needed.
146 #define AS_BASE(TYPE) \
147 class ir_##TYPE *as_##TYPE() \
149 assume(this != NULL); \
150 return is_##TYPE() ? (ir_##TYPE *) this : NULL; \
152 const class ir_##TYPE *as_##TYPE() const \
154 assume(this != NULL); \
155 return is_##TYPE() ? (ir_##TYPE *) this : NULL; \
163 #define AS_CHILD(TYPE) \
164 class ir_##TYPE * as_##TYPE() \
166 assume(this != NULL); \
167 return ir_type == ir_type_##TYPE ? (ir_##TYPE *) this : NULL; \
169 const class ir_##TYPE * as_##TYPE() const \
171 assume(this != NULL); \
172 return ir_type == ir_type_##TYPE ? (const ir_##TYPE *) this : NULL; \
176 AS_CHILD(dereference_array
)
177 AS_CHILD(dereference_variable
)
178 AS_CHILD(dereference_record
)
193 * IR equality method: Return true if the referenced instruction would
194 * return the same value as this one.
196 * This intended to be used for CSE and algebraic optimizations, on rvalues
197 * in particular. No support for other instruction types (assignments,
198 * jumps, calls, etc.) is planned.
200 virtual bool equals(const ir_instruction
*ir
,
201 enum ir_node_type ignore
= ir_type_unset
) const;
204 ir_instruction(enum ir_node_type t
)
212 assert(!"Should not get here.");
218 * The base class for all "values"/expression trees.
220 class ir_rvalue
: public ir_instruction
{
222 const struct glsl_type
*type
;
224 virtual ir_rvalue
*clone(void *mem_ctx
, struct hash_table
*) const;
226 virtual void accept(ir_visitor
*v
)
231 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
233 virtual ir_constant
*constant_expression_value(struct hash_table
*variable_context
= NULL
);
235 ir_rvalue
*as_rvalue_to_saturate();
237 virtual bool is_lvalue() const
243 * Get the variable that is ultimately referenced by an r-value
245 virtual ir_variable
*variable_referenced() const
252 * If an r-value is a reference to a whole variable, get that variable
255 * Pointer to a variable that is completely dereferenced by the r-value. If
256 * the r-value is not a dereference or the dereference does not access the
257 * entire variable (i.e., it's just one array element, struct field), \c NULL
260 virtual ir_variable
*whole_variable_referenced()
266 * Determine if an r-value has the value zero
268 * The base implementation of this function always returns \c false. The
269 * \c ir_constant class over-rides this function to return \c true \b only
270 * for vector and scalar types that have all elements set to the value
271 * zero (or \c false for booleans).
273 * \sa ir_constant::has_value, ir_rvalue::is_one, ir_rvalue::is_negative_one
275 virtual bool is_zero() const;
278 * Determine if an r-value has the value one
280 * The base implementation of this function always returns \c false. The
281 * \c ir_constant class over-rides this function to return \c true \b only
282 * for vector and scalar types that have all elements set to the value
283 * one (or \c true for booleans).
285 * \sa ir_constant::has_value, ir_rvalue::is_zero, ir_rvalue::is_negative_one
287 virtual bool is_one() const;
290 * Determine if an r-value has the value negative one
292 * The base implementation of this function always returns \c false. The
293 * \c ir_constant class over-rides this function to return \c true \b only
294 * for vector and scalar types that have all elements set to the value
295 * negative one. For boolean types, the result is always \c false.
297 * \sa ir_constant::has_value, ir_rvalue::is_zero, ir_rvalue::is_one
299 virtual bool is_negative_one() const;
302 * Determine if an r-value is an unsigned integer constant which can be
305 * \sa ir_constant::is_uint16_constant.
307 virtual bool is_uint16_constant() const { return false; }
310 * Return a generic value of error_type.
312 * Allocation will be performed with 'mem_ctx' as ralloc owner.
314 static ir_rvalue
*error_value(void *mem_ctx
);
317 ir_rvalue(enum ir_node_type t
);
322 * Variable storage classes
324 enum ir_variable_mode
{
325 ir_var_auto
= 0, /**< Function local variables and globals. */
326 ir_var_uniform
, /**< Variable declared as a uniform. */
327 ir_var_shader_storage
, /**< Variable declared as an ssbo. */
332 ir_var_function_inout
,
333 ir_var_const_in
, /**< "in" param that must be a constant expression */
334 ir_var_system_value
, /**< Ex: front-face, instance-id, etc. */
335 ir_var_temporary
, /**< Temporary variable generated during compilation. */
336 ir_var_mode_count
/**< Number of variable modes */
340 * Enum keeping track of how a variable was declared. For error checking of
341 * the gl_PerVertex redeclaration rules.
343 enum ir_var_declaration_type
{
345 * Normal declaration (for most variables, this means an explicit
346 * declaration. Exception: temporaries are always implicitly declared, but
347 * they still use ir_var_declared_normally).
349 * Note: an ir_variable that represents a named interface block uses
350 * ir_var_declared_normally.
352 ir_var_declared_normally
= 0,
355 * Variable was explicitly declared (or re-declared) in an unnamed
358 ir_var_declared_in_block
,
361 * Variable is an implicitly declared built-in that has not been explicitly
362 * re-declared by the shader.
364 ir_var_declared_implicitly
,
367 * Variable is implicitly generated by the compiler and should not be
368 * visible via the API.
374 * \brief Layout qualifiers for gl_FragDepth.
376 * The AMD/ARB_conservative_depth extensions allow gl_FragDepth to be redeclared
377 * with a layout qualifier.
379 enum ir_depth_layout
{
380 ir_depth_layout_none
, /**< No depth layout is specified. */
382 ir_depth_layout_greater
,
383 ir_depth_layout_less
,
384 ir_depth_layout_unchanged
388 * \brief Convert depth layout qualifier to string.
391 depth_layout_string(ir_depth_layout layout
);
394 * Description of built-in state associated with a uniform
396 * \sa ir_variable::state_slots
398 struct ir_state_slot
{
405 * Get the string value for an interpolation qualifier
407 * \return The string that would be used in a shader to specify \c
408 * mode will be returned.
410 * This function is used to generate error messages of the form "shader
411 * uses %s interpolation qualifier", so in the case where there is no
412 * interpolation qualifier, it returns "no".
414 * This function should only be used on a shader input or output variable.
416 const char *interpolation_string(unsigned interpolation
);
419 class ir_variable
: public ir_instruction
{
421 ir_variable(const struct glsl_type
*, const char *, ir_variable_mode
);
423 virtual ir_variable
*clone(void *mem_ctx
, struct hash_table
*ht
) const;
425 virtual void accept(ir_visitor
*v
)
430 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
434 * Determine how this variable should be interpolated based on its
435 * interpolation qualifier (if present), whether it is gl_Color or
436 * gl_SecondaryColor, and whether flatshading is enabled in the current GL
439 * The return value will always be either INTERP_QUALIFIER_SMOOTH,
440 * INTERP_QUALIFIER_NOPERSPECTIVE, or INTERP_QUALIFIER_FLAT.
442 glsl_interp_qualifier
determine_interpolation_mode(bool flat_shade
);
445 * Determine whether or not a variable is part of a uniform or
446 * shader storage block.
448 inline bool is_in_buffer_block() const
450 return (this->data
.mode
== ir_var_uniform
||
451 this->data
.mode
== ir_var_shader_storage
) &&
452 this->interface_type
!= NULL
;
456 * Determine whether or not a variable is the declaration of an interface
459 * For the first declaration below, there will be an \c ir_variable named
460 * "instance" whose type and whose instance_type will be the same
461 * \cglsl_type. For the second declaration, there will be an \c ir_variable
462 * named "f" whose type is float and whose instance_type is B2.
464 * "instance" is an interface instance variable, but "f" is not.
474 inline bool is_interface_instance() const
476 return this->type
->without_array() == this->interface_type
;
480 * Set this->interface_type on a newly created variable.
482 void init_interface_type(const struct glsl_type
*type
)
484 assert(this->interface_type
== NULL
);
485 this->interface_type
= type
;
486 if (this->is_interface_instance()) {
487 this->u
.max_ifc_array_access
=
488 rzalloc_array(this, unsigned, type
->length
);
493 * Change this->interface_type on a variable that previously had a
494 * different, but compatible, interface_type. This is used during linking
495 * to set the size of arrays in interface blocks.
497 void change_interface_type(const struct glsl_type
*type
)
499 if (this->u
.max_ifc_array_access
!= NULL
) {
500 /* max_ifc_array_access has already been allocated, so make sure the
501 * new interface has the same number of fields as the old one.
503 assert(this->interface_type
->length
== type
->length
);
505 this->interface_type
= type
;
509 * Change this->interface_type on a variable that previously had a
510 * different, and incompatible, interface_type. This is used during
511 * compilation to handle redeclaration of the built-in gl_PerVertex
514 void reinit_interface_type(const struct glsl_type
*type
)
516 if (this->u
.max_ifc_array_access
!= NULL
) {
518 /* Redeclaring gl_PerVertex is only allowed if none of the built-ins
519 * it defines have been accessed yet; so it's safe to throw away the
520 * old max_ifc_array_access pointer, since all of its values are
523 for (unsigned i
= 0; i
< this->interface_type
->length
; i
++)
524 assert(this->u
.max_ifc_array_access
[i
] == 0);
526 ralloc_free(this->u
.max_ifc_array_access
);
527 this->u
.max_ifc_array_access
= NULL
;
529 this->interface_type
= NULL
;
530 init_interface_type(type
);
533 const glsl_type
*get_interface_type() const
535 return this->interface_type
;
539 * Get the max_ifc_array_access pointer
541 * A "set" function is not needed because the array is dynmically allocated
544 inline unsigned *get_max_ifc_array_access()
546 assert(this->data
._num_state_slots
== 0);
547 return this->u
.max_ifc_array_access
;
550 inline unsigned get_num_state_slots() const
552 assert(!this->is_interface_instance()
553 || this->data
._num_state_slots
== 0);
554 return this->data
._num_state_slots
;
557 inline void set_num_state_slots(unsigned n
)
559 assert(!this->is_interface_instance()
561 this->data
._num_state_slots
= n
;
564 inline ir_state_slot
*get_state_slots()
566 return this->is_interface_instance() ? NULL
: this->u
.state_slots
;
569 inline const ir_state_slot
*get_state_slots() const
571 return this->is_interface_instance() ? NULL
: this->u
.state_slots
;
574 inline ir_state_slot
*allocate_state_slots(unsigned n
)
576 assert(!this->is_interface_instance());
578 this->u
.state_slots
= ralloc_array(this, ir_state_slot
, n
);
579 this->data
._num_state_slots
= 0;
581 if (this->u
.state_slots
!= NULL
)
582 this->data
._num_state_slots
= n
;
584 return this->u
.state_slots
;
587 inline bool is_name_ralloced() const
589 return this->name
!= ir_variable::tmp_name
;
593 * Enable emitting extension warnings for this variable
595 void enable_extension_warning(const char *extension
);
598 * Get the extension warning string for this variable
600 * If warnings are not enabled, \c NULL is returned.
602 const char *get_extension_warning() const;
605 * Declared type of the variable
607 const struct glsl_type
*type
;
610 * Declared name of the variable
614 struct ir_variable_data
{
617 * Is the variable read-only?
619 * This is set for variables declared as \c const, shader inputs,
622 unsigned read_only
:1;
626 unsigned invariant
:1;
630 * Has this variable been used for reading or writing?
632 * Several GLSL semantic checks require knowledge of whether or not a
633 * variable has been used. For example, it is an error to redeclare a
634 * variable as invariant after it has been used.
636 * This is only maintained in the ast_to_hir.cpp path, not in
637 * Mesa's fixed function or ARB program paths.
642 * Has this variable been statically assigned?
644 * This answers whether the variable was assigned in any path of
645 * the shader during ast_to_hir. This doesn't answer whether it is
646 * still written after dead code removal, nor is it maintained in
647 * non-ast_to_hir.cpp (GLSL parsing) paths.
652 * Enum indicating how the variable was declared. See
653 * ir_var_declaration_type.
655 * This is used to detect certain kinds of illegal variable redeclarations.
657 unsigned how_declared
:2;
660 * Storage class of the variable.
662 * \sa ir_variable_mode
667 * Interpolation mode for shader inputs / outputs
669 * \sa ir_variable_interpolation
671 unsigned interpolation
:2;
674 * \name ARB_fragment_coord_conventions
677 unsigned origin_upper_left
:1;
678 unsigned pixel_center_integer
:1;
682 * Was the location explicitly set in the shader?
684 * If the location is explicitly set in the shader, it \b cannot be changed
685 * by the linker or by the API (e.g., calls to \c glBindAttribLocation have
688 unsigned explicit_location
:1;
689 unsigned explicit_index
:1;
692 * Do we have a Vulkan (group, index) qualifier for this variable?
697 * Was an initial binding explicitly set in the shader?
699 * If so, constant_value contains an integer ir_constant representing the
700 * initial binding point.
702 unsigned explicit_binding
:1;
705 * Does this variable have an initializer?
707 * This is used by the linker to cross-validiate initializers of global
710 unsigned has_initializer
:1;
713 * Is this variable a generic output or input that has not yet been matched
714 * up to a variable in another stage of the pipeline?
716 * This is used by the linker as scratch storage while assigning locations
717 * to generic inputs and outputs.
719 unsigned is_unmatched_generic_inout
:1;
722 * If non-zero, then this variable may be packed along with other variables
723 * into a single varying slot, so this offset should be applied when
724 * accessing components. For example, an offset of 1 means that the x
725 * component of this variable is actually stored in component y of the
726 * location specified by \c location.
728 unsigned location_frac
:2;
731 * Layout of the matrix. Uses glsl_matrix_layout values.
733 unsigned matrix_layout
:2;
736 * Non-zero if this variable was created by lowering a named interface
737 * block which was not an array.
739 * Note that this variable and \c from_named_ifc_block_array will never
742 unsigned from_named_ifc_block_nonarray
:1;
745 * Non-zero if this variable was created by lowering a named interface
746 * block which was an array.
748 * Note that this variable and \c from_named_ifc_block_nonarray will never
751 unsigned from_named_ifc_block_array
:1;
754 * Non-zero if the variable must be a shader input. This is useful for
755 * constraints on function parameters.
757 unsigned must_be_shader_input
:1;
760 * Output index for dual source blending.
763 * The GLSL spec only allows the values 0 or 1 for the index in \b dual
766 * This is now also used for the Vulkan descriptor set index.
771 * \brief Layout qualifier for gl_FragDepth.
773 * This is not equal to \c ir_depth_layout_none if and only if this
774 * variable is \c gl_FragDepth and a layout qualifier is specified.
776 ir_depth_layout depth_layout
:3;
779 * ARB_shader_image_load_store qualifiers.
781 unsigned image_read_only
:1; /**< "readonly" qualifier. */
782 unsigned image_write_only
:1; /**< "writeonly" qualifier. */
783 unsigned image_coherent
:1;
784 unsigned image_volatile
:1;
785 unsigned image_restrict
:1;
788 * Emit a warning if this variable is accessed.
791 uint8_t warn_extension_index
;
794 /** Image internal format if specified explicitly, otherwise GL_NONE. */
795 uint16_t image_format
;
799 * Number of state slots used
802 * This could be stored in as few as 7-bits, if necessary. If it is made
803 * smaller, add an assertion to \c ir_variable::allocate_state_slots to
806 uint16_t _num_state_slots
;
810 * Initial binding point for a sampler, atomic, or UBO.
812 * For array types, this represents the binding point for the first element.
817 * Vulkan descriptor set for the resource.
822 * Storage location of the base of this variable
824 * The precise meaning of this field depends on the nature of the variable.
826 * - Vertex shader input: one of the values from \c gl_vert_attrib.
827 * - Vertex shader output: one of the values from \c gl_varying_slot.
828 * - Geometry shader input: one of the values from \c gl_varying_slot.
829 * - Geometry shader output: one of the values from \c gl_varying_slot.
830 * - Fragment shader input: one of the values from \c gl_varying_slot.
831 * - Fragment shader output: one of the values from \c gl_frag_result.
832 * - Uniforms: Per-stage uniform slot number for default uniform block.
833 * - Uniforms: Index within the uniform block definition for UBO members.
834 * - Other: This field is not currently used.
836 * If the variable is a uniform, shader input, or shader output, and the
837 * slot has not been assigned, the value will be -1.
842 * Vertex stream output identifier.
847 * Location an atomic counter is stored at.
854 * Highest element accessed with a constant expression array index
856 * Not used for non-array variables.
858 unsigned max_array_access
;
861 * Allow (only) ir_variable direct access private members.
863 friend class ir_variable
;
867 * Value assigned in the initializer of a variable declared "const"
869 ir_constant
*constant_value
;
872 * Constant expression assigned in the initializer of the variable
875 * This field and \c ::constant_value are distinct. Even if the two fields
876 * refer to constants with the same value, they must point to separate
879 ir_constant
*constant_initializer
;
882 static const char *const warn_extension_table
[];
886 * For variables which satisfy the is_interface_instance() predicate,
887 * this points to an array of integers such that if the ith member of
888 * the interface block is an array, max_ifc_array_access[i] is the
889 * maximum array element of that member that has been accessed. If the
890 * ith member of the interface block is not an array,
891 * max_ifc_array_access[i] is unused.
893 * For variables whose type is not an interface block, this pointer is
896 unsigned *max_ifc_array_access
;
899 * Built-in state that backs this uniform
901 * Once set at variable creation, \c state_slots must remain invariant.
903 * If the variable is not a uniform, \c _num_state_slots will be zero
904 * and \c state_slots will be \c NULL.
906 ir_state_slot
*state_slots
;
910 * For variables that are in an interface block or are an instance of an
911 * interface block, this is the \c GLSL_TYPE_INTERFACE type for that block.
913 * \sa ir_variable::location
915 const glsl_type
*interface_type
;
918 * Name used for anonymous compiler temporaries
920 static const char tmp_name
[];
924 * Should the construct keep names for ir_var_temporary variables?
926 * When this global is false, names passed to the constructor for
927 * \c ir_var_temporary variables will be dropped. Instead, the variable will
928 * be named "compiler_temp". This name will be in static storage.
931 * \b NEVER change the mode of an \c ir_var_temporary.
934 * This variable is \b not thread-safe. It is global, \b not
935 * per-context. It begins life false. A context can, at some point, make
936 * it true. From that point on, it will be true forever. This should be
937 * okay since it will only be set true while debugging.
939 static bool temporaries_allocate_names
;
943 * A function that returns whether a built-in function is available in the
944 * current shading language (based on version, ES or desktop, and extensions).
946 typedef bool (*builtin_available_predicate
)(const _mesa_glsl_parse_state
*);
950 * The representation of a function instance; may be the full definition or
951 * simply a prototype.
953 class ir_function_signature
: public ir_instruction
{
954 /* An ir_function_signature will be part of the list of signatures in
958 ir_function_signature(const glsl_type
*return_type
,
959 builtin_available_predicate builtin_avail
= NULL
);
961 virtual ir_function_signature
*clone(void *mem_ctx
,
962 struct hash_table
*ht
) const;
963 ir_function_signature
*clone_prototype(void *mem_ctx
,
964 struct hash_table
*ht
) const;
966 virtual void accept(ir_visitor
*v
)
971 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
974 * Attempt to evaluate this function as a constant expression,
975 * given a list of the actual parameters and the variable context.
976 * Returns NULL for non-built-ins.
978 ir_constant
*constant_expression_value(exec_list
*actual_parameters
, struct hash_table
*variable_context
);
981 * Get the name of the function for which this is a signature
983 const char *function_name() const;
986 * Get a handle to the function for which this is a signature
988 * There is no setter function, this function returns a \c const pointer,
989 * and \c ir_function_signature::_function is private for a reason. The
990 * only way to make a connection between a function and function signature
991 * is via \c ir_function::add_signature. This helps ensure that certain
992 * invariants (i.e., a function signature is in the list of signatures for
993 * its \c _function) are met.
995 * \sa ir_function::add_signature
997 inline const class ir_function
*function() const
999 return this->_function
;
1003 * Check whether the qualifiers match between this signature's parameters
1004 * and the supplied parameter list. If not, returns the name of the first
1005 * parameter with mismatched qualifiers (for use in error messages).
1007 const char *qualifiers_match(exec_list
*params
);
1010 * Replace the current parameter list with the given one. This is useful
1011 * if the current information came from a prototype, and either has invalid
1012 * or missing parameter names.
1014 void replace_parameters(exec_list
*new_params
);
1017 * Function return type.
1019 * \note This discards the optional precision qualifier.
1021 const struct glsl_type
*return_type
;
1024 * List of ir_variable of function parameters.
1026 * This represents the storage. The paramaters passed in a particular
1027 * call will be in ir_call::actual_paramaters.
1029 struct exec_list parameters
;
1031 /** Whether or not this function has a body (which may be empty). */
1032 unsigned is_defined
:1;
1034 /** Whether or not this function signature is a built-in. */
1035 bool is_builtin() const;
1038 * Whether or not this function is an intrinsic to be implemented
1043 /** Whether or not a built-in is available for this shader. */
1044 bool is_builtin_available(const _mesa_glsl_parse_state
*state
) const;
1046 /** Body of instructions in the function. */
1047 struct exec_list body
;
1051 * A function pointer to a predicate that answers whether a built-in
1052 * function is available in the current shader. NULL if not a built-in.
1054 builtin_available_predicate builtin_avail
;
1056 /** Function of which this signature is one overload. */
1057 class ir_function
*_function
;
1059 /** Function signature of which this one is a prototype clone */
1060 const ir_function_signature
*origin
;
1062 friend class ir_function
;
1065 * Helper function to run a list of instructions for constant
1066 * expression evaluation.
1068 * The hash table represents the values of the visible variables.
1069 * There are no scoping issues because the table is indexed on
1070 * ir_variable pointers, not variable names.
1072 * Returns false if the expression is not constant, true otherwise,
1073 * and the value in *result if result is non-NULL.
1075 bool constant_expression_evaluate_expression_list(const struct exec_list
&body
,
1076 struct hash_table
*variable_context
,
1077 ir_constant
**result
);
1082 * Header for tracking multiple overloaded functions with the same name.
1083 * Contains a list of ir_function_signatures representing each of the
1086 class ir_function
: public ir_instruction
{
1088 ir_function(const char *name
);
1090 virtual ir_function
*clone(void *mem_ctx
, struct hash_table
*ht
) const;
1092 virtual void accept(ir_visitor
*v
)
1097 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1099 void add_signature(ir_function_signature
*sig
)
1101 sig
->_function
= this;
1102 this->signatures
.push_tail(sig
);
1106 * Find a signature that matches a set of actual parameters, taking implicit
1107 * conversions into account. Also flags whether the match was exact.
1109 ir_function_signature
*matching_signature(_mesa_glsl_parse_state
*state
,
1110 const exec_list
*actual_param
,
1111 bool allow_builtins
,
1112 bool *match_is_exact
);
1115 * Find a signature that matches a set of actual parameters, taking implicit
1116 * conversions into account.
1118 ir_function_signature
*matching_signature(_mesa_glsl_parse_state
*state
,
1119 const exec_list
*actual_param
,
1120 bool allow_builtins
);
1123 * Find a signature that exactly matches a set of actual parameters without
1124 * any implicit type conversions.
1126 ir_function_signature
*exact_matching_signature(_mesa_glsl_parse_state
*state
,
1127 const exec_list
*actual_ps
);
1130 * Name of the function.
1134 /** Whether or not this function has a signature that isn't a built-in. */
1135 bool has_user_signature();
1138 * List of ir_function_signature for each overloaded function with this name.
1140 struct exec_list signatures
;
1143 * is this function a subroutine type declaration
1144 * e.g. subroutine void type1(float arg1);
1149 * is this function associated to a subroutine type
1150 * e.g. subroutine (type1, type2) function_name { function_body };
1151 * would have num_subroutine_types 2,
1152 * and pointers to the type1 and type2 types.
1154 int num_subroutine_types
;
1155 const struct glsl_type
**subroutine_types
;
1158 inline const char *ir_function_signature::function_name() const
1160 return this->_function
->name
;
1166 * IR instruction representing high-level if-statements
1168 class ir_if
: public ir_instruction
{
1170 ir_if(ir_rvalue
*condition
)
1171 : ir_instruction(ir_type_if
), condition(condition
)
1175 virtual ir_if
*clone(void *mem_ctx
, struct hash_table
*ht
) const;
1177 virtual void accept(ir_visitor
*v
)
1182 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1184 ir_rvalue
*condition
;
1185 /** List of ir_instruction for the body of the then branch */
1186 exec_list then_instructions
;
1187 /** List of ir_instruction for the body of the else branch */
1188 exec_list else_instructions
;
1193 * IR instruction representing a high-level loop structure.
1195 class ir_loop
: public ir_instruction
{
1199 virtual ir_loop
*clone(void *mem_ctx
, struct hash_table
*ht
) const;
1201 virtual void accept(ir_visitor
*v
)
1206 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1208 /** List of ir_instruction that make up the body of the loop. */
1209 exec_list body_instructions
;
1213 class ir_assignment
: public ir_instruction
{
1215 ir_assignment(ir_rvalue
*lhs
, ir_rvalue
*rhs
, ir_rvalue
*condition
= NULL
);
1218 * Construct an assignment with an explicit write mask
1221 * Since a write mask is supplied, the LHS must already be a bare
1222 * \c ir_dereference. The cannot be any swizzles in the LHS.
1224 ir_assignment(ir_dereference
*lhs
, ir_rvalue
*rhs
, ir_rvalue
*condition
,
1225 unsigned write_mask
);
1227 virtual ir_assignment
*clone(void *mem_ctx
, struct hash_table
*ht
) const;
1229 virtual ir_constant
*constant_expression_value(struct hash_table
*variable_context
= NULL
);
1231 virtual void accept(ir_visitor
*v
)
1236 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1239 * Get a whole variable written by an assignment
1241 * If the LHS of the assignment writes a whole variable, the variable is
1242 * returned. Otherwise \c NULL is returned. Examples of whole-variable
1245 * - Assigning to a scalar
1246 * - Assigning to all components of a vector
1247 * - Whole array (or matrix) assignment
1248 * - Whole structure assignment
1250 ir_variable
*whole_variable_written();
1253 * Set the LHS of an assignment
1255 void set_lhs(ir_rvalue
*lhs
);
1258 * Left-hand side of the assignment.
1260 * This should be treated as read only. If you need to set the LHS of an
1261 * assignment, use \c ir_assignment::set_lhs.
1263 ir_dereference
*lhs
;
1266 * Value being assigned
1271 * Optional condition for the assignment.
1273 ir_rvalue
*condition
;
1277 * Component mask written
1279 * For non-vector types in the LHS, this field will be zero. For vector
1280 * types, a bit will be set for each component that is written. Note that
1281 * for \c vec2 and \c vec3 types only the lower bits will ever be set.
1283 * A partially-set write mask means that each enabled channel gets
1284 * the value from a consecutive channel of the rhs. For example,
1285 * to write just .xyw of gl_FrontColor with color:
1287 * (assign (constant bool (1)) (xyw)
1288 * (var_ref gl_FragColor)
1289 * (swiz xyw (var_ref color)))
1291 unsigned write_mask
:4;
1294 /* Update ir_expression::get_num_operands() and operator_strs when
1295 * updating this list.
1297 enum ir_expression_operation
{
1306 ir_unop_exp
, /**< Log base e on gentype */
1307 ir_unop_log
, /**< Natural log on gentype */
1310 ir_unop_f2i
, /**< Float-to-integer conversion. */
1311 ir_unop_f2u
, /**< Float-to-unsigned conversion. */
1312 ir_unop_i2f
, /**< Integer-to-float conversion. */
1313 ir_unop_f2b
, /**< Float-to-boolean conversion */
1314 ir_unop_b2f
, /**< Boolean-to-float conversion */
1315 ir_unop_i2b
, /**< int-to-boolean conversion */
1316 ir_unop_b2i
, /**< Boolean-to-int conversion */
1317 ir_unop_u2f
, /**< Unsigned-to-float conversion. */
1318 ir_unop_i2u
, /**< Integer-to-unsigned conversion. */
1319 ir_unop_u2i
, /**< Unsigned-to-integer conversion. */
1320 ir_unop_d2f
, /**< Double-to-float conversion. */
1321 ir_unop_f2d
, /**< Float-to-double conversion. */
1322 ir_unop_d2i
, /**< Double-to-integer conversion. */
1323 ir_unop_i2d
, /**< Integer-to-double conversion. */
1324 ir_unop_d2u
, /**< Double-to-unsigned conversion. */
1325 ir_unop_u2d
, /**< Unsigned-to-double conversion. */
1326 ir_unop_d2b
, /**< Double-to-boolean conversion. */
1327 ir_unop_bitcast_i2f
, /**< Bit-identical int-to-float "conversion" */
1328 ir_unop_bitcast_f2i
, /**< Bit-identical float-to-int "conversion" */
1329 ir_unop_bitcast_u2f
, /**< Bit-identical uint-to-float "conversion" */
1330 ir_unop_bitcast_f2u
, /**< Bit-identical float-to-uint "conversion" */
1334 * \name Unary floating-point rounding operations.
1345 * \name Trigonometric operations.
1353 * \name Partial derivatives.
1357 ir_unop_dFdx_coarse
,
1360 ir_unop_dFdy_coarse
,
1365 * \name Floating point pack and unpack operations.
1368 ir_unop_pack_snorm_2x16
,
1369 ir_unop_pack_snorm_4x8
,
1370 ir_unop_pack_unorm_2x16
,
1371 ir_unop_pack_unorm_4x8
,
1372 ir_unop_pack_half_2x16
,
1373 ir_unop_unpack_snorm_2x16
,
1374 ir_unop_unpack_snorm_4x8
,
1375 ir_unop_unpack_unorm_2x16
,
1376 ir_unop_unpack_unorm_4x8
,
1377 ir_unop_unpack_half_2x16
,
1381 * \name Lowered floating point unpacking operations.
1383 * \see lower_packing_builtins_visitor::split_unpack_half_2x16
1386 ir_unop_unpack_half_2x16_split_x
,
1387 ir_unop_unpack_half_2x16_split_y
,
1391 * \name Bit operations, part of ARB_gpu_shader5.
1394 ir_unop_bitfield_reverse
,
1403 * \name Double packing, part of ARB_gpu_shader_fp64.
1406 ir_unop_pack_double_2x32
,
1407 ir_unop_unpack_double_2x32
,
1415 ir_unop_subroutine_to_int
,
1417 * Interpolate fs input at centroid
1419 * operand0 is the fs input.
1421 ir_unop_interpolate_at_centroid
,
1424 * A sentinel marking the last of the unary operations.
1426 ir_last_unop
= ir_unop_interpolate_at_centroid
,
1430 ir_binop_mul
, /**< Floating-point or low 32-bit integer multiply. */
1431 ir_binop_imul_high
, /**< Calculates the high 32-bits of a 64-bit multiply. */
1435 * Returns the carry resulting from the addition of the two arguments.
1442 * Returns the borrow resulting from the subtraction of the second argument
1443 * from the first argument.
1450 * Takes one of two combinations of arguments:
1453 * - mod(vecN, float)
1455 * Does not take integer types.
1460 * \name Binary comparison operators which return a boolean vector.
1461 * The type of both operands must be equal.
1471 * Returns single boolean for whether all components of operands[0]
1472 * equal the components of operands[1].
1476 * Returns single boolean for whether any component of operands[0]
1477 * is not equal to the corresponding component of operands[1].
1479 ir_binop_any_nequal
,
1483 * \name Bit-wise binary operations.
1504 * \name Lowered floating point packing operations.
1506 * \see lower_packing_builtins_visitor::split_pack_half_2x16
1509 ir_binop_pack_half_2x16_split
,
1513 * \name First half of a lowered bitfieldInsert() operation.
1515 * \see lower_instructions::bitfield_insert_to_bfm_bfi
1522 * Load a value the size of a given GLSL type from a uniform block.
1524 * operand0 is the ir_constant uniform block index in the linked shader.
1525 * operand1 is a byte offset within the uniform block.
1530 * \name Multiplies a number by two to a power, part of ARB_gpu_shader5.
1537 * Extract a scalar from a vector
1539 * operand0 is the vector
1540 * operand1 is the index of the field to read from operand0
1542 ir_binop_vector_extract
,
1545 * Interpolate fs input at offset
1547 * operand0 is the fs input
1548 * operand1 is the offset from the pixel center
1550 ir_binop_interpolate_at_offset
,
1553 * Interpolate fs input at sample position
1555 * operand0 is the fs input
1556 * operand1 is the sample ID
1558 ir_binop_interpolate_at_sample
,
1561 * A sentinel marking the last of the binary operations.
1563 ir_last_binop
= ir_binop_interpolate_at_sample
,
1566 * \name Fused floating-point multiply-add, part of ARB_gpu_shader5.
1575 * \name Conditional Select
1577 * A vector conditional select instruction (like ?:, but operating per-
1578 * component on vectors).
1580 * \see lower_instructions_visitor::ldexp_to_arith
1587 * \name Second half of a lowered bitfieldInsert() operation.
1589 * \see lower_instructions::bitfield_insert_to_bfm_bfi
1595 ir_triop_bitfield_extract
,
1598 * Generate a value with one field of a vector changed
1600 * operand0 is the vector
1601 * operand1 is the value to write into the vector result
1602 * operand2 is the index in operand0 to be modified
1604 ir_triop_vector_insert
,
1607 * A sentinel marking the last of the ternary operations.
1609 ir_last_triop
= ir_triop_vector_insert
,
1611 ir_quadop_bitfield_insert
,
1616 * A sentinel marking the last of the ternary operations.
1618 ir_last_quadop
= ir_quadop_vector
,
1621 * A sentinel marking the last of all operations.
1623 ir_last_opcode
= ir_quadop_vector
1626 class ir_expression
: public ir_rvalue
{
1628 ir_expression(int op
, const struct glsl_type
*type
,
1629 ir_rvalue
*op0
, ir_rvalue
*op1
= NULL
,
1630 ir_rvalue
*op2
= NULL
, ir_rvalue
*op3
= NULL
);
1633 * Constructor for unary operation expressions
1635 ir_expression(int op
, ir_rvalue
*);
1638 * Constructor for binary operation expressions
1640 ir_expression(int op
, ir_rvalue
*op0
, ir_rvalue
*op1
);
1643 * Constructor for ternary operation expressions
1645 ir_expression(int op
, ir_rvalue
*op0
, ir_rvalue
*op1
, ir_rvalue
*op2
);
1647 virtual bool equals(const ir_instruction
*ir
,
1648 enum ir_node_type ignore
= ir_type_unset
) const;
1650 virtual ir_expression
*clone(void *mem_ctx
, struct hash_table
*ht
) const;
1653 * Attempt to constant-fold the expression
1655 * The "variable_context" hash table links ir_variable * to ir_constant *
1656 * that represent the variables' values. \c NULL represents an empty
1659 * If the expression cannot be constant folded, this method will return
1662 virtual ir_constant
*constant_expression_value(struct hash_table
*variable_context
= NULL
);
1665 * Determine the number of operands used by an expression
1667 static unsigned int get_num_operands(ir_expression_operation
);
1670 * Determine the number of operands used by an expression
1672 unsigned int get_num_operands() const
1674 return (this->operation
== ir_quadop_vector
)
1675 ? this->type
->vector_elements
: get_num_operands(operation
);
1679 * Return whether the expression operates on vectors horizontally.
1681 bool is_horizontal() const
1683 return operation
== ir_binop_all_equal
||
1684 operation
== ir_binop_any_nequal
||
1685 operation
== ir_unop_any
||
1686 operation
== ir_binop_dot
||
1687 operation
== ir_quadop_vector
;
1691 * Return a string representing this expression's operator.
1693 const char *operator_string();
1696 * Return a string representing this expression's operator.
1698 static const char *operator_string(ir_expression_operation
);
1702 * Do a reverse-lookup to translate the given string into an operator.
1704 static ir_expression_operation
get_operator(const char *);
1706 virtual void accept(ir_visitor
*v
)
1711 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1713 ir_expression_operation operation
;
1714 ir_rvalue
*operands
[4];
1719 * HIR instruction representing a high-level function call, containing a list
1720 * of parameters and returning a value in the supplied temporary.
1722 class ir_call
: public ir_instruction
{
1724 ir_call(ir_function_signature
*callee
,
1725 ir_dereference_variable
*return_deref
,
1726 exec_list
*actual_parameters
)
1727 : ir_instruction(ir_type_call
), return_deref(return_deref
), callee(callee
), sub_var(NULL
), array_idx(NULL
)
1729 assert(callee
->return_type
!= NULL
);
1730 actual_parameters
->move_nodes_to(& this->actual_parameters
);
1731 this->use_builtin
= callee
->is_builtin();
1734 ir_call(ir_function_signature
*callee
,
1735 ir_dereference_variable
*return_deref
,
1736 exec_list
*actual_parameters
,
1737 ir_variable
*var
, ir_rvalue
*array_idx
)
1738 : ir_instruction(ir_type_call
), return_deref(return_deref
), callee(callee
), sub_var(var
), array_idx(array_idx
)
1740 assert(callee
->return_type
!= NULL
);
1741 actual_parameters
->move_nodes_to(& this->actual_parameters
);
1742 this->use_builtin
= callee
->is_builtin();
1745 virtual ir_call
*clone(void *mem_ctx
, struct hash_table
*ht
) const;
1747 virtual ir_constant
*constant_expression_value(struct hash_table
*variable_context
= NULL
);
1749 virtual void accept(ir_visitor
*v
)
1754 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1757 * Get the name of the function being called.
1759 const char *callee_name() const
1761 return callee
->function_name();
1765 * Generates an inline version of the function before @ir,
1766 * storing the return value in return_deref.
1768 void generate_inline(ir_instruction
*ir
);
1771 * Storage for the function's return value.
1772 * This must be NULL if the return type is void.
1774 ir_dereference_variable
*return_deref
;
1777 * The specific function signature being called.
1779 ir_function_signature
*callee
;
1781 /* List of ir_rvalue of paramaters passed in this call. */
1782 exec_list actual_parameters
;
1784 /** Should this call only bind to a built-in function? */
1788 * ARB_shader_subroutine support -
1789 * the subroutine uniform variable and array index
1790 * rvalue to be used in the lowering pass later.
1792 ir_variable
*sub_var
;
1793 ir_rvalue
*array_idx
;
1798 * \name Jump-like IR instructions.
1800 * These include \c break, \c continue, \c return, and \c discard.
1803 class ir_jump
: public ir_instruction
{
1805 ir_jump(enum ir_node_type t
)
1811 class ir_return
: public ir_jump
{
1814 : ir_jump(ir_type_return
), value(NULL
)
1818 ir_return(ir_rvalue
*value
)
1819 : ir_jump(ir_type_return
), value(value
)
1823 virtual ir_return
*clone(void *mem_ctx
, struct hash_table
*) const;
1825 ir_rvalue
*get_value() const
1830 virtual void accept(ir_visitor
*v
)
1835 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1842 * Jump instructions used inside loops
1844 * These include \c break and \c continue. The \c break within a loop is
1845 * different from the \c break within a switch-statement.
1847 * \sa ir_switch_jump
1849 class ir_loop_jump
: public ir_jump
{
1856 ir_loop_jump(jump_mode mode
)
1857 : ir_jump(ir_type_loop_jump
)
1862 virtual ir_loop_jump
*clone(void *mem_ctx
, struct hash_table
*) const;
1864 virtual void accept(ir_visitor
*v
)
1869 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1871 bool is_break() const
1873 return mode
== jump_break
;
1876 bool is_continue() const
1878 return mode
== jump_continue
;
1881 /** Mode selector for the jump instruction. */
1882 enum jump_mode mode
;
1886 * IR instruction representing discard statements.
1888 class ir_discard
: public ir_jump
{
1891 : ir_jump(ir_type_discard
)
1893 this->condition
= NULL
;
1896 ir_discard(ir_rvalue
*cond
)
1897 : ir_jump(ir_type_discard
)
1899 this->condition
= cond
;
1902 virtual ir_discard
*clone(void *mem_ctx
, struct hash_table
*ht
) const;
1904 virtual void accept(ir_visitor
*v
)
1909 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1911 ir_rvalue
*condition
;
1917 * Texture sampling opcodes used in ir_texture
1919 enum ir_texture_opcode
{
1920 ir_tex
, /**< Regular texture look-up */
1921 ir_txb
, /**< Texture look-up with LOD bias */
1922 ir_txl
, /**< Texture look-up with explicit LOD */
1923 ir_txd
, /**< Texture look-up with partial derivatvies */
1924 ir_txf
, /**< Texel fetch with explicit LOD */
1925 ir_txf_ms
, /**< Multisample texture fetch */
1926 ir_txs
, /**< Texture size */
1927 ir_lod
, /**< Texture lod query */
1928 ir_tg4
, /**< Texture gather */
1929 ir_query_levels
/**< Texture levels query */
1934 * IR instruction to sample a texture
1936 * The specific form of the IR instruction depends on the \c mode value
1937 * selected from \c ir_texture_opcodes. In the printed IR, these will
1940 * Texel offset (0 or an expression)
1941 * | Projection divisor
1942 * | | Shadow comparitor
1945 * (tex <type> <sampler> <coordinate> 0 1 ( ))
1946 * (txb <type> <sampler> <coordinate> 0 1 ( ) <bias>)
1947 * (txl <type> <sampler> <coordinate> 0 1 ( ) <lod>)
1948 * (txd <type> <sampler> <coordinate> 0 1 ( ) (dPdx dPdy))
1949 * (txf <type> <sampler> <coordinate> 0 <lod>)
1951 * <type> <sampler> <coordinate> <sample_index>)
1952 * (txs <type> <sampler> <lod>)
1953 * (lod <type> <sampler> <coordinate>)
1954 * (tg4 <type> <sampler> <coordinate> <offset> <component>)
1955 * (query_levels <type> <sampler>)
1957 class ir_texture
: public ir_rvalue
{
1959 ir_texture(enum ir_texture_opcode op
)
1960 : ir_rvalue(ir_type_texture
),
1961 op(op
), sampler(NULL
), coordinate(NULL
), projector(NULL
),
1962 shadow_comparitor(NULL
), offset(NULL
)
1964 memset(&lod_info
, 0, sizeof(lod_info
));
1967 virtual ir_texture
*clone(void *mem_ctx
, struct hash_table
*) const;
1969 virtual ir_constant
*constant_expression_value(struct hash_table
*variable_context
= NULL
);
1971 virtual void accept(ir_visitor
*v
)
1976 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1978 virtual bool equals(const ir_instruction
*ir
,
1979 enum ir_node_type ignore
= ir_type_unset
) const;
1982 * Return a string representing the ir_texture_opcode.
1984 const char *opcode_string();
1986 /** Set the sampler and type. */
1987 void set_sampler(ir_dereference
*sampler
, const glsl_type
*type
);
1990 * Do a reverse-lookup to translate a string into an ir_texture_opcode.
1992 static ir_texture_opcode
get_opcode(const char *);
1994 enum ir_texture_opcode op
;
1996 /** Sampler to use for the texture access. */
1997 ir_dereference
*sampler
;
1999 /** Texture coordinate to sample */
2000 ir_rvalue
*coordinate
;
2003 * Value used for projective divide.
2005 * If there is no projective divide (the common case), this will be
2006 * \c NULL. Optimization passes should check for this to point to a constant
2007 * of 1.0 and replace that with \c NULL.
2009 ir_rvalue
*projector
;
2012 * Coordinate used for comparison on shadow look-ups.
2014 * If there is no shadow comparison, this will be \c NULL. For the
2015 * \c ir_txf opcode, this *must* be \c NULL.
2017 ir_rvalue
*shadow_comparitor
;
2019 /** Texel offset. */
2023 ir_rvalue
*lod
; /**< Floating point LOD */
2024 ir_rvalue
*bias
; /**< Floating point LOD bias */
2025 ir_rvalue
*sample_index
; /**< MSAA sample index */
2026 ir_rvalue
*component
; /**< Gather component selector */
2028 ir_rvalue
*dPdx
; /**< Partial derivative of coordinate wrt X */
2029 ir_rvalue
*dPdy
; /**< Partial derivative of coordinate wrt Y */
2035 struct ir_swizzle_mask
{
2042 * Number of components in the swizzle.
2044 unsigned num_components
:3;
2047 * Does the swizzle contain duplicate components?
2049 * L-value swizzles cannot contain duplicate components.
2051 unsigned has_duplicates
:1;
2055 class ir_swizzle
: public ir_rvalue
{
2057 ir_swizzle(ir_rvalue
*, unsigned x
, unsigned y
, unsigned z
, unsigned w
,
2060 ir_swizzle(ir_rvalue
*val
, const unsigned *components
, unsigned count
);
2062 ir_swizzle(ir_rvalue
*val
, ir_swizzle_mask mask
);
2064 virtual ir_swizzle
*clone(void *mem_ctx
, struct hash_table
*) const;
2066 virtual ir_constant
*constant_expression_value(struct hash_table
*variable_context
= NULL
);
2069 * Construct an ir_swizzle from the textual representation. Can fail.
2071 static ir_swizzle
*create(ir_rvalue
*, const char *, unsigned vector_length
);
2073 virtual void accept(ir_visitor
*v
)
2078 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
2080 virtual bool equals(const ir_instruction
*ir
,
2081 enum ir_node_type ignore
= ir_type_unset
) const;
2083 bool is_lvalue() const
2085 return val
->is_lvalue() && !mask
.has_duplicates
;
2089 * Get the variable that is ultimately referenced by an r-value
2091 virtual ir_variable
*variable_referenced() const;
2094 ir_swizzle_mask mask
;
2098 * Initialize the mask component of a swizzle
2100 * This is used by the \c ir_swizzle constructors.
2102 void init_mask(const unsigned *components
, unsigned count
);
2106 class ir_dereference
: public ir_rvalue
{
2108 virtual ir_dereference
*clone(void *mem_ctx
, struct hash_table
*) const = 0;
2110 bool is_lvalue() const;
2113 * Get the variable that is ultimately referenced by an r-value
2115 virtual ir_variable
*variable_referenced() const = 0;
2118 ir_dereference(enum ir_node_type t
)
2125 class ir_dereference_variable
: public ir_dereference
{
2127 ir_dereference_variable(ir_variable
*var
);
2129 virtual ir_dereference_variable
*clone(void *mem_ctx
,
2130 struct hash_table
*) const;
2132 virtual ir_constant
*constant_expression_value(struct hash_table
*variable_context
= NULL
);
2134 virtual bool equals(const ir_instruction
*ir
,
2135 enum ir_node_type ignore
= ir_type_unset
) const;
2138 * Get the variable that is ultimately referenced by an r-value
2140 virtual ir_variable
*variable_referenced() const
2145 virtual ir_variable
*whole_variable_referenced()
2147 /* ir_dereference_variable objects always dereference the entire
2148 * variable. However, if this dereference is dereferenced by anything
2149 * else, the complete deferefernce chain is not a whole-variable
2150 * dereference. This method should only be called on the top most
2151 * ir_rvalue in a dereference chain.
2156 virtual void accept(ir_visitor
*v
)
2161 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
2164 * Object being dereferenced.
2170 class ir_dereference_array
: public ir_dereference
{
2172 ir_dereference_array(ir_rvalue
*value
, ir_rvalue
*array_index
);
2174 ir_dereference_array(ir_variable
*var
, ir_rvalue
*array_index
);
2176 virtual ir_dereference_array
*clone(void *mem_ctx
,
2177 struct hash_table
*) const;
2179 virtual ir_constant
*constant_expression_value(struct hash_table
*variable_context
= NULL
);
2181 virtual bool equals(const ir_instruction
*ir
,
2182 enum ir_node_type ignore
= ir_type_unset
) const;
2185 * Get the variable that is ultimately referenced by an r-value
2187 virtual ir_variable
*variable_referenced() const
2189 return this->array
->variable_referenced();
2192 virtual void accept(ir_visitor
*v
)
2197 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
2200 ir_rvalue
*array_index
;
2203 void set_array(ir_rvalue
*value
);
2207 class ir_dereference_record
: public ir_dereference
{
2209 ir_dereference_record(ir_rvalue
*value
, const char *field
);
2211 ir_dereference_record(ir_variable
*var
, const char *field
);
2213 virtual ir_dereference_record
*clone(void *mem_ctx
,
2214 struct hash_table
*) const;
2216 virtual ir_constant
*constant_expression_value(struct hash_table
*variable_context
= NULL
);
2219 * Get the variable that is ultimately referenced by an r-value
2221 virtual ir_variable
*variable_referenced() const
2223 return this->record
->variable_referenced();
2226 virtual void accept(ir_visitor
*v
)
2231 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
2239 * Data stored in an ir_constant
2241 union ir_constant_data
{
2250 class ir_constant
: public ir_rvalue
{
2252 ir_constant(const struct glsl_type
*type
, const ir_constant_data
*data
);
2253 ir_constant(bool b
, unsigned vector_elements
=1);
2254 ir_constant(unsigned int u
, unsigned vector_elements
=1);
2255 ir_constant(int i
, unsigned vector_elements
=1);
2256 ir_constant(float f
, unsigned vector_elements
=1);
2257 ir_constant(double d
, unsigned vector_elements
=1);
2260 * Construct an ir_constant from a list of ir_constant values
2262 ir_constant(const struct glsl_type
*type
, exec_list
*values
);
2265 * Construct an ir_constant from a scalar component of another ir_constant
2267 * The new \c ir_constant inherits the type of the component from the
2271 * In the case of a matrix constant, the new constant is a scalar, \b not
2274 ir_constant(const ir_constant
*c
, unsigned i
);
2277 * Return a new ir_constant of the specified type containing all zeros.
2279 static ir_constant
*zero(void *mem_ctx
, const glsl_type
*type
);
2281 virtual ir_constant
*clone(void *mem_ctx
, struct hash_table
*) const;
2283 virtual ir_constant
*constant_expression_value(struct hash_table
*variable_context
= NULL
);
2285 virtual void accept(ir_visitor
*v
)
2290 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
2292 virtual bool equals(const ir_instruction
*ir
,
2293 enum ir_node_type ignore
= ir_type_unset
) const;
2296 * Get a particular component of a constant as a specific type
2298 * This is useful, for example, to get a value from an integer constant
2299 * as a float or bool. This appears frequently when constructors are
2300 * called with all constant parameters.
2303 bool get_bool_component(unsigned i
) const;
2304 float get_float_component(unsigned i
) const;
2305 double get_double_component(unsigned i
) const;
2306 int get_int_component(unsigned i
) const;
2307 unsigned get_uint_component(unsigned i
) const;
2310 ir_constant
*get_array_element(unsigned i
) const;
2312 ir_constant
*get_record_field(const char *name
);
2315 * Copy the values on another constant at a given offset.
2317 * The offset is ignored for array or struct copies, it's only for
2318 * scalars or vectors into vectors or matrices.
2320 * With identical types on both sides and zero offset it's clone()
2321 * without creating a new object.
2324 void copy_offset(ir_constant
*src
, int offset
);
2327 * Copy the values on another constant at a given offset and
2328 * following an assign-like mask.
2330 * The mask is ignored for scalars.
2332 * Note that this function only handles what assign can handle,
2333 * i.e. at most a vector as source and a column of a matrix as
2337 void copy_masked_offset(ir_constant
*src
, int offset
, unsigned int mask
);
2340 * Determine whether a constant has the same value as another constant
2342 * \sa ir_constant::is_zero, ir_constant::is_one,
2343 * ir_constant::is_negative_one
2345 bool has_value(const ir_constant
*) const;
2348 * Return true if this ir_constant represents the given value.
2350 * For vectors, this checks that each component is the given value.
2352 virtual bool is_value(float f
, int i
) const;
2353 virtual bool is_zero() const;
2354 virtual bool is_one() const;
2355 virtual bool is_negative_one() const;
2358 * Return true for constants that could be stored as 16-bit unsigned values.
2360 * Note that this will return true even for signed integer ir_constants, as
2361 * long as the value is non-negative and fits in 16-bits.
2363 virtual bool is_uint16_constant() const;
2366 * Value of the constant.
2368 * The field used to back the values supplied by the constant is determined
2369 * by the type associated with the \c ir_instruction. Constants may be
2370 * scalars, vectors, or matrices.
2372 union ir_constant_data value
;
2374 /* Array elements */
2375 ir_constant
**array_elements
;
2377 /* Structure fields */
2378 exec_list components
;
2382 * Parameterless constructor only used by the clone method
2388 * IR instruction to emit a vertex in a geometry shader.
2390 class ir_emit_vertex
: public ir_instruction
{
2392 ir_emit_vertex(ir_rvalue
*stream
)
2393 : ir_instruction(ir_type_emit_vertex
),
2399 virtual void accept(ir_visitor
*v
)
2404 virtual ir_emit_vertex
*clone(void *mem_ctx
, struct hash_table
*ht
) const
2406 return new(mem_ctx
) ir_emit_vertex(this->stream
->clone(mem_ctx
, ht
));
2409 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
2411 int stream_id() const
2413 return stream
->as_constant()->value
.i
[0];
2420 * IR instruction to complete the current primitive and start a new one in a
2423 class ir_end_primitive
: public ir_instruction
{
2425 ir_end_primitive(ir_rvalue
*stream
)
2426 : ir_instruction(ir_type_end_primitive
),
2432 virtual void accept(ir_visitor
*v
)
2437 virtual ir_end_primitive
*clone(void *mem_ctx
, struct hash_table
*ht
) const
2439 return new(mem_ctx
) ir_end_primitive(this->stream
->clone(mem_ctx
, ht
));
2442 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
2444 int stream_id() const
2446 return stream
->as_constant()->value
.i
[0];
2453 * IR instruction for tessellation control and compute shader barrier.
2455 class ir_barrier
: public ir_instruction
{
2458 : ir_instruction(ir_type_barrier
)
2462 virtual void accept(ir_visitor
*v
)
2467 virtual ir_barrier
*clone(void *mem_ctx
, struct hash_table
*) const
2469 return new(mem_ctx
) ir_barrier();
2472 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
2478 * Apply a visitor to each IR node in a list
2481 visit_exec_list(exec_list
*list
, ir_visitor
*visitor
);
2484 * Validate invariants on each IR node in a list
2486 void validate_ir_tree(exec_list
*instructions
);
2488 struct _mesa_glsl_parse_state
;
2489 struct gl_shader_program
;
2492 * Detect whether an unlinked shader contains static recursion
2494 * If the list of instructions is determined to contain static recursion,
2495 * \c _mesa_glsl_error will be called to emit error messages for each function
2496 * that is in the recursion cycle.
2499 detect_recursion_unlinked(struct _mesa_glsl_parse_state
*state
,
2500 exec_list
*instructions
);
2503 * Detect whether a linked shader contains static recursion
2505 * If the list of instructions is determined to contain static recursion,
2506 * \c link_error_printf will be called to emit error messages for each function
2507 * that is in the recursion cycle. In addition,
2508 * \c gl_shader_program::LinkStatus will be set to false.
2511 detect_recursion_linked(struct gl_shader_program
*prog
,
2512 exec_list
*instructions
);
2515 * Make a clone of each IR instruction in a list
2517 * \param in List of IR instructions that are to be cloned
2518 * \param out List to hold the cloned instructions
2521 clone_ir_list(void *mem_ctx
, exec_list
*out
, const exec_list
*in
);
2524 _mesa_glsl_initialize_variables(exec_list
*instructions
,
2525 struct _mesa_glsl_parse_state
*state
);
2528 _mesa_glsl_initialize_functions(_mesa_glsl_parse_state
*state
);
2531 _mesa_glsl_initialize_builtin_functions();
2533 extern ir_function_signature
*
2534 _mesa_glsl_find_builtin_function(_mesa_glsl_parse_state
*state
,
2535 const char *name
, exec_list
*actual_parameters
);
2537 extern ir_function
*
2538 _mesa_glsl_find_builtin_function_by_name(_mesa_glsl_parse_state
*state
,
2542 _mesa_glsl_get_builtin_function_shader(void);
2545 _mesa_glsl_release_functions(void);
2548 _mesa_glsl_release_builtin_functions(void);
2551 reparent_ir(exec_list
*list
, void *mem_ctx
);
2553 struct glsl_symbol_table
;
2556 import_prototypes(const exec_list
*source
, exec_list
*dest
,
2557 struct glsl_symbol_table
*symbols
, void *mem_ctx
);
2560 ir_has_call(ir_instruction
*ir
);
2563 do_set_program_inouts(exec_list
*instructions
, struct gl_program
*prog
,
2564 gl_shader_stage shader_stage
);
2567 prototype_string(const glsl_type
*return_type
, const char *name
,
2568 exec_list
*parameters
);
2571 mode_string(const ir_variable
*var
);
2574 * Built-in / reserved GL variables names start with "gl_"
2577 is_gl_identifier(const char *s
)
2579 return s
&& s
[0] == 'g' && s
[1] == 'l' && s
[2] == '_';
2583 #endif /* __cplusplus */
2585 extern void _mesa_print_ir(FILE *f
, struct exec_list
*instructions
,
2586 struct _mesa_glsl_parse_state
*state
);
2589 fprint_ir(FILE *f
, const void *instruction
);
2596 vertices_per_prim(GLenum prim
);