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.
37 #include "ir_visitor.h"
38 #include "ir_hierarchical_visitor.h"
41 * \defgroup IR Intermediate representation nodes
49 * Each concrete class derived from \c ir_instruction has a value in this
50 * enumerant. The value for the type is stored in \c ir_instruction::ir_type
51 * by the constructor. While using type tags is not very C++, it is extremely
52 * convenient. For example, during debugging you can simply inspect
53 * \c ir_instruction::ir_type to find out the actual type of the object.
55 * In addition, it is possible to use a switch-statement based on \c
56 * \c ir_instruction::ir_type to select different behavior for different object
57 * types. For functions that have only slight differences for several object
58 * types, this allows writing very straightforward, readable code.
62 * Zero is unused so that the IR validator can detect cases where
63 * \c ir_instruction::ir_type has not been initialized.
70 ir_type_dereference_array
,
71 ir_type_dereference_record
,
72 ir_type_dereference_variable
,
76 ir_type_function_signature
,
83 ir_type_max
/**< maximum ir_type enum number, for validation */
87 * Base class of all IR instructions
89 class ir_instruction
: public exec_node
{
91 enum ir_node_type ir_type
;
92 const struct glsl_type
*type
;
94 /** ir_print_visitor helper for debugging. */
95 void print(void) const;
97 virtual void accept(ir_visitor
*) = 0;
98 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*) = 0;
99 virtual ir_instruction
*clone(void *mem_ctx
,
100 struct hash_table
*ht
) const = 0;
103 * \name IR instruction downcast functions
105 * These functions either cast the object to a derived class or return
106 * \c NULL if the object's type does not match the specified derived class.
107 * Additional downcast functions will be added as needed.
110 virtual class ir_variable
* as_variable() { return NULL
; }
111 virtual class ir_function
* as_function() { return NULL
; }
112 virtual class ir_dereference
* as_dereference() { return NULL
; }
113 virtual class ir_dereference_array
* as_dereference_array() { return NULL
; }
114 virtual class ir_dereference_variable
*as_dereference_variable() { return NULL
; }
115 virtual class ir_expression
* as_expression() { return NULL
; }
116 virtual class ir_rvalue
* as_rvalue() { return NULL
; }
117 virtual class ir_loop
* as_loop() { return NULL
; }
118 virtual class ir_assignment
* as_assignment() { return NULL
; }
119 virtual class ir_call
* as_call() { return NULL
; }
120 virtual class ir_return
* as_return() { return NULL
; }
121 virtual class ir_if
* as_if() { return NULL
; }
122 virtual class ir_swizzle
* as_swizzle() { return NULL
; }
123 virtual class ir_constant
* as_constant() { return NULL
; }
129 ir_type
= ir_type_unset
;
135 class ir_rvalue
: public ir_instruction
{
137 virtual ir_rvalue
*clone(void *mem_ctx
, struct hash_table
*) const = 0;
139 virtual ir_constant
*constant_expression_value() = 0;
141 virtual ir_rvalue
* as_rvalue()
146 virtual bool is_lvalue()
152 * Get the variable that is ultimately referenced by an r-value
154 virtual ir_variable
*variable_referenced()
161 * If an r-value is a reference to a whole variable, get that variable
164 * Pointer to a variable that is completely dereferenced by the r-value. If
165 * the r-value is not a dereference or the dereference does not access the
166 * entire variable (i.e., it's just one array element, struct field), \c NULL
169 virtual ir_variable
*whole_variable_referenced()
180 * Variable storage classes
182 enum ir_variable_mode
{
183 ir_var_auto
= 0, /**< Function local variables and globals. */
184 ir_var_uniform
, /**< Variable declared as a uniform. */
188 ir_var_temporary
/**< Temporary variable generated during compilation. */
191 enum ir_variable_interpolation
{
198 class ir_variable
: public ir_instruction
{
200 ir_variable(const struct glsl_type
*, const char *, ir_variable_mode
);
202 virtual ir_variable
*clone(void *mem_ctx
, struct hash_table
*ht
) const;
204 virtual ir_variable
*as_variable()
209 virtual void accept(ir_visitor
*v
)
214 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
218 * Get the string value for the interpolation qualifier
220 * \return The string that would be used in a shader to specify \c
221 * mode will be returned.
223 * This function should only be used on a shader input or output variable.
225 const char *interpolation_string() const;
228 * Calculate the number of slots required to hold this variable
230 * This is used to determine how many uniform or varying locations a variable
231 * occupies. The count is in units of floating point components.
233 unsigned component_slots() const;
236 * Delcared name of the variable
241 * Highest element accessed with a constant expression array index
243 * Not used for non-array variables.
245 unsigned max_array_access
;
248 * Is the variable read-only?
250 * This is set for variables declared as \c const, shader inputs,
253 unsigned read_only
:1;
255 unsigned invariant
:1;
258 * Storage class of the variable.
260 * \sa ir_variable_mode
265 * Interpolation mode for shader inputs / outputs
267 * \sa ir_variable_interpolation
269 unsigned interpolation
:2;
272 * Flag that the whole array is assignable
274 * In GLSL 1.20 and later whole arrays are assignable (and comparable for
275 * equality). This flag enables this behavior.
277 unsigned array_lvalue
:1;
280 * \name ARB_fragment_coord_conventions
283 unsigned origin_upper_left
:1;
284 unsigned pixel_center_integer
:1;
288 * Was the location explicitly set in the shader?
290 * If the location is explicitly set in the shader, it \b cannot be changed
291 * by the linker or by the API (e.g., calls to \c glBindAttribLocation have
294 unsigned explicit_location
:1;
297 * Storage location of the base of this variable
299 * The precise meaning of this field depends on the nature of the variable.
301 * - Vertex shader input: one of the values from \c gl_vert_attrib.
302 * - Vertex shader output: one of the values from \c gl_vert_result.
303 * - Fragment shader input: one of the values from \c gl_frag_attrib.
304 * - Fragment shader output: one of the values from \c gl_frag_result.
305 * - Uniforms: Per-stage uniform slot number.
306 * - Other: This field is not currently used.
308 * If the variable is a uniform, shader input, or shader output, and the
309 * slot has not been assigned, the value will be -1.
314 * Emit a warning if this variable is accessed.
316 const char *warn_extension
;
319 * Value assigned in the initializer of a variable declared "const"
321 ir_constant
*constant_value
;
327 * The representation of a function instance; may be the full definition or
328 * simply a prototype.
330 class ir_function_signature
: public ir_instruction
{
331 /* An ir_function_signature will be part of the list of signatures in
335 ir_function_signature(const glsl_type
*return_type
);
337 virtual ir_function_signature
*clone(void *mem_ctx
,
338 struct hash_table
*ht
) const;
340 virtual void accept(ir_visitor
*v
)
345 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
348 * Get the name of the function for which this is a signature
350 const char *function_name() const;
353 * Get a handle to the function for which this is a signature
355 * There is no setter function, this function returns a \c const pointer,
356 * and \c ir_function_signature::_function is private for a reason. The
357 * only way to make a connection between a function and function signature
358 * is via \c ir_function::add_signature. This helps ensure that certain
359 * invariants (i.e., a function signature is in the list of signatures for
360 * its \c _function) are met.
362 * \sa ir_function::add_signature
364 inline const class ir_function
*function() const
366 return this->_function
;
370 * Check whether the qualifiers match between this signature's parameters
371 * and the supplied parameter list. If not, returns the name of the first
372 * parameter with mismatched qualifiers (for use in error messages).
374 const char *qualifiers_match(exec_list
*params
);
377 * Replace the current parameter list with the given one. This is useful
378 * if the current information came from a prototype, and either has invalid
379 * or missing parameter names.
381 void replace_parameters(exec_list
*new_params
);
384 * Function return type.
386 * \note This discards the optional precision qualifier.
388 const struct glsl_type
*return_type
;
391 * List of ir_variable of function parameters.
393 * This represents the storage. The paramaters passed in a particular
394 * call will be in ir_call::actual_paramaters.
396 struct exec_list parameters
;
398 /** Whether or not this function has a body (which may be empty). */
399 unsigned is_defined
:1;
401 /** Whether or not this function signature is a built-in. */
402 unsigned is_builtin
:1;
404 /** Body of instructions in the function. */
405 struct exec_list body
;
408 /** Function of which this signature is one overload. */
409 class ir_function
*_function
;
411 friend class ir_function
;
416 * Header for tracking multiple overloaded functions with the same name.
417 * Contains a list of ir_function_signatures representing each of the
420 class ir_function
: public ir_instruction
{
422 ir_function(const char *name
);
424 virtual ir_function
*clone(void *mem_ctx
, struct hash_table
*ht
) const;
426 virtual ir_function
*as_function()
431 virtual void accept(ir_visitor
*v
)
436 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
438 void add_signature(ir_function_signature
*sig
)
440 sig
->_function
= this;
441 this->signatures
.push_tail(sig
);
445 * Get an iterator for the set of function signatures
447 exec_list_iterator
iterator()
449 return signatures
.iterator();
453 * Find a signature that matches a set of actual parameters, taking implicit
454 * conversions into account.
456 ir_function_signature
*matching_signature(const exec_list
*actual_param
);
459 * Find a signature that exactly matches a set of actual parameters without
460 * any implicit type conversions.
462 ir_function_signature
*exact_matching_signature(const exec_list
*actual_ps
);
465 * Name of the function.
469 /** Whether or not this function has a signature that isn't a built-in. */
470 bool has_user_signature();
473 * List of ir_function_signature for each overloaded function with this name.
475 struct exec_list signatures
;
478 inline const char *ir_function_signature::function_name() const
480 return this->_function
->name
;
486 * IR instruction representing high-level if-statements
488 class ir_if
: public ir_instruction
{
490 ir_if(ir_rvalue
*condition
)
491 : condition(condition
)
493 ir_type
= ir_type_if
;
496 virtual ir_if
*clone(void *mem_ctx
, struct hash_table
*ht
) const;
498 virtual ir_if
*as_if()
503 virtual void accept(ir_visitor
*v
)
508 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
510 ir_rvalue
*condition
;
511 /** List of ir_instruction for the body of the then branch */
512 exec_list then_instructions
;
513 /** List of ir_instruction for the body of the else branch */
514 exec_list else_instructions
;
519 * IR instruction representing a high-level loop structure.
521 class ir_loop
: public ir_instruction
{
525 virtual ir_loop
*clone(void *mem_ctx
, struct hash_table
*ht
) const;
527 virtual void accept(ir_visitor
*v
)
532 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
534 virtual ir_loop
*as_loop()
540 * Get an iterator for the instructions of the loop body
542 exec_list_iterator
iterator()
544 return body_instructions
.iterator();
547 /** List of ir_instruction that make up the body of the loop. */
548 exec_list body_instructions
;
551 * \name Loop counter and controls
553 * Represents a loop like a FORTRAN \c do-loop.
556 * If \c from and \c to are the same value, the loop will execute once.
559 ir_rvalue
*from
; /** Value of the loop counter on the first
560 * iteration of the loop.
562 ir_rvalue
*to
; /** Value of the loop counter on the last
563 * iteration of the loop.
565 ir_rvalue
*increment
;
566 ir_variable
*counter
;
569 * Comparison operation in the loop terminator.
571 * If any of the loop control fields are non-\c NULL, this field must be
572 * one of \c ir_binop_less, \c ir_binop_greater, \c ir_binop_lequal,
573 * \c ir_binop_gequal, \c ir_binop_equal, or \c ir_binop_nequal.
580 class ir_assignment
: public ir_instruction
{
582 ir_assignment(ir_rvalue
*lhs
, ir_rvalue
*rhs
, ir_rvalue
*condition
);
585 * Construct an assignment with an explicit write mask
588 * Since a write mask is supplied, the LHS must already be a bare
589 * \c ir_dereference. The cannot be any swizzles in the LHS.
591 ir_assignment(ir_dereference
*lhs
, ir_rvalue
*rhs
, ir_rvalue
*condition
,
592 unsigned write_mask
);
594 virtual ir_assignment
*clone(void *mem_ctx
, struct hash_table
*ht
) const;
596 virtual ir_constant
*constant_expression_value();
598 virtual void accept(ir_visitor
*v
)
603 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
605 virtual ir_assignment
* as_assignment()
611 * Get a whole variable written by an assignment
613 * If the LHS of the assignment writes a whole variable, the variable is
614 * returned. Otherwise \c NULL is returned. Examples of whole-variable
617 * - Assigning to a scalar
618 * - Assigning to all components of a vector
619 * - Whole array (or matrix) assignment
620 * - Whole structure assignment
622 ir_variable
*whole_variable_written();
625 * Set the LHS of an assignment
627 void set_lhs(ir_rvalue
*lhs
);
630 * Left-hand side of the assignment.
632 * This should be treated as read only. If you need to set the LHS of an
633 * assignment, use \c ir_assignment::set_lhs.
638 * Value being assigned
643 * Optional condition for the assignment.
645 ir_rvalue
*condition
;
649 * Component mask written
651 * For non-vector types in the LHS, this field will be zero. For vector
652 * types, a bit will be set for each component that is written. Note that
653 * for \c vec2 and \c vec3 types only the lower bits will ever be set.
655 * A partially-set write mask means that each enabled channel gets
656 * the value from a consecutive channel of the rhs. For example,
657 * to write just .xyw of gl_FrontColor with color:
659 * (assign (constant bool (1)) (xyw)
660 * (var_ref gl_FragColor)
661 * (swiz xyw (var_ref color)))
663 unsigned write_mask
:4;
666 /* Update ir_expression::num_operands() and operator_strs when
667 * updating this list.
669 enum ir_expression_operation
{
678 ir_unop_exp
, /**< Log base e on gentype */
679 ir_unop_log
, /**< Natural log on gentype */
682 ir_unop_f2i
, /**< Float-to-integer conversion. */
683 ir_unop_i2f
, /**< Integer-to-float conversion. */
684 ir_unop_f2b
, /**< Float-to-boolean conversion */
685 ir_unop_b2f
, /**< Boolean-to-float conversion */
686 ir_unop_i2b
, /**< int-to-boolean conversion */
687 ir_unop_b2i
, /**< Boolean-to-int conversion */
688 ir_unop_u2f
, /**< Unsigned-to-float conversion. */
692 * \name Unary floating-point rounding operations.
703 * \name Trigonometric operations.
711 * \name Partial derivatives.
726 * Takes one of two combinations of arguments:
731 * Does not take integer types.
736 * \name Binary comparison operators which return a boolean vector.
737 * The type of both operands must be equal.
747 * Returns single boolean for whether all components of operands[0]
748 * equal the components of operands[1].
752 * Returns single boolean for whether any component of operands[0]
753 * is not equal to the corresponding component of operands[1].
759 * \name Bit-wise binary operations.
780 class ir_expression
: public ir_rvalue
{
782 ir_expression(int op
, const struct glsl_type
*type
,
783 ir_rvalue
*, ir_rvalue
*);
785 virtual ir_expression
*as_expression()
790 virtual ir_expression
*clone(void *mem_ctx
, struct hash_table
*ht
) const;
793 * Attempt to constant-fold the expression
795 * If the expression cannot be constant folded, this method will return
798 virtual ir_constant
*constant_expression_value();
801 * Determine the number of operands used by an expression
803 static unsigned int get_num_operands(ir_expression_operation
);
806 * Determine the number of operands used by an expression
808 unsigned int get_num_operands() const
810 return get_num_operands(operation
);
814 * Return a string representing this expression's operator.
816 const char *operator_string();
819 * Return a string representing this expression's operator.
821 static const char *operator_string(ir_expression_operation
);
825 * Do a reverse-lookup to translate the given string into an operator.
827 static ir_expression_operation
get_operator(const char *);
829 virtual void accept(ir_visitor
*v
)
834 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
836 ir_expression_operation operation
;
837 ir_rvalue
*operands
[2];
842 * IR instruction representing a function call
844 class ir_call
: public ir_rvalue
{
846 ir_call(ir_function_signature
*callee
, exec_list
*actual_parameters
)
849 ir_type
= ir_type_call
;
850 assert(callee
->return_type
!= NULL
);
851 type
= callee
->return_type
;
852 actual_parameters
->move_nodes_to(& this->actual_parameters
);
855 virtual ir_call
*clone(void *mem_ctx
, struct hash_table
*ht
) const;
857 virtual ir_constant
*constant_expression_value();
859 virtual ir_call
*as_call()
864 virtual void accept(ir_visitor
*v
)
869 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
872 * Get a generic ir_call object when an error occurs
874 * Any allocation will be performed with 'ctx' as talloc owner.
876 static ir_call
*get_error_instruction(void *ctx
);
879 * Get an iterator for the set of acutal parameters
881 exec_list_iterator
iterator()
883 return actual_parameters
.iterator();
887 * Get the name of the function being called.
889 const char *callee_name() const
891 return callee
->function_name();
895 * Get the function signature bound to this function call
897 ir_function_signature
*get_callee()
903 * Set the function call target
905 void set_callee(ir_function_signature
*sig
);
908 * Generates an inline version of the function before @ir,
909 * returning the return value of the function.
911 ir_rvalue
*generate_inline(ir_instruction
*ir
);
913 /* List of ir_rvalue of paramaters passed in this call. */
914 exec_list actual_parameters
;
920 this->ir_type
= ir_type_call
;
923 ir_function_signature
*callee
;
928 * \name Jump-like IR instructions.
930 * These include \c break, \c continue, \c return, and \c discard.
933 class ir_jump
: public ir_instruction
{
937 ir_type
= ir_type_unset
;
941 class ir_return
: public ir_jump
{
946 this->ir_type
= ir_type_return
;
949 ir_return(ir_rvalue
*value
)
952 this->ir_type
= ir_type_return
;
955 virtual ir_return
*clone(void *mem_ctx
, struct hash_table
*) const;
957 virtual ir_return
*as_return()
962 ir_rvalue
*get_value() const
967 virtual void accept(ir_visitor
*v
)
972 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
979 * Jump instructions used inside loops
981 * These include \c break and \c continue. The \c break within a loop is
982 * different from the \c break within a switch-statement.
986 class ir_loop_jump
: public ir_jump
{
993 ir_loop_jump(jump_mode mode
)
995 this->ir_type
= ir_type_loop_jump
;
1000 virtual ir_loop_jump
*clone(void *mem_ctx
, struct hash_table
*) const;
1002 virtual void accept(ir_visitor
*v
)
1007 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1009 bool is_break() const
1011 return mode
== jump_break
;
1014 bool is_continue() const
1016 return mode
== jump_continue
;
1019 /** Mode selector for the jump instruction. */
1020 enum jump_mode mode
;
1022 /** Loop containing this break instruction. */
1027 * IR instruction representing discard statements.
1029 class ir_discard
: public ir_jump
{
1033 this->ir_type
= ir_type_discard
;
1034 this->condition
= NULL
;
1037 ir_discard(ir_rvalue
*cond
)
1039 this->ir_type
= ir_type_discard
;
1040 this->condition
= cond
;
1043 virtual ir_discard
*clone(void *mem_ctx
, struct hash_table
*ht
) const;
1045 virtual void accept(ir_visitor
*v
)
1050 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1052 ir_rvalue
*condition
;
1058 * Texture sampling opcodes used in ir_texture
1060 enum ir_texture_opcode
{
1061 ir_tex
, /**< Regular texture look-up */
1062 ir_txb
, /**< Texture look-up with LOD bias */
1063 ir_txl
, /**< Texture look-up with explicit LOD */
1064 ir_txd
, /**< Texture look-up with partial derivatvies */
1065 ir_txf
/**< Texel fetch with explicit LOD */
1070 * IR instruction to sample a texture
1072 * The specific form of the IR instruction depends on the \c mode value
1073 * selected from \c ir_texture_opcodes. In the printed IR, these will
1077 * | Projection divisor
1078 * | | Shadow comparitor
1081 * (tex (sampler) (coordinate) (0 0 0) (1) ( ))
1082 * (txb (sampler) (coordinate) (0 0 0) (1) ( ) (bias))
1083 * (txl (sampler) (coordinate) (0 0 0) (1) ( ) (lod))
1084 * (txd (sampler) (coordinate) (0 0 0) (1) ( ) (dPdx dPdy))
1085 * (txf (sampler) (coordinate) (0 0 0) (lod))
1087 class ir_texture
: public ir_rvalue
{
1089 ir_texture(enum ir_texture_opcode op
)
1090 : op(op
), projector(NULL
), shadow_comparitor(NULL
)
1092 this->ir_type
= ir_type_texture
;
1095 virtual ir_texture
*clone(void *mem_ctx
, struct hash_table
*) const;
1097 virtual ir_constant
*constant_expression_value();
1099 virtual void accept(ir_visitor
*v
)
1104 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1107 * Return a string representing the ir_texture_opcode.
1109 const char *opcode_string();
1111 /** Set the sampler and infer the type. */
1112 void set_sampler(ir_dereference
*sampler
);
1115 * Do a reverse-lookup to translate a string into an ir_texture_opcode.
1117 static ir_texture_opcode
get_opcode(const char *);
1119 enum ir_texture_opcode op
;
1121 /** Sampler to use for the texture access. */
1122 ir_dereference
*sampler
;
1124 /** Texture coordinate to sample */
1125 ir_rvalue
*coordinate
;
1128 * Value used for projective divide.
1130 * If there is no projective divide (the common case), this will be
1131 * \c NULL. Optimization passes should check for this to point to a constant
1132 * of 1.0 and replace that with \c NULL.
1134 ir_rvalue
*projector
;
1137 * Coordinate used for comparison on shadow look-ups.
1139 * If there is no shadow comparison, this will be \c NULL. For the
1140 * \c ir_txf opcode, this *must* be \c NULL.
1142 ir_rvalue
*shadow_comparitor
;
1144 /** Explicit texel offsets. */
1145 signed char offsets
[3];
1148 ir_rvalue
*lod
; /**< Floating point LOD */
1149 ir_rvalue
*bias
; /**< Floating point LOD bias */
1151 ir_rvalue
*dPdx
; /**< Partial derivative of coordinate wrt X */
1152 ir_rvalue
*dPdy
; /**< Partial derivative of coordinate wrt Y */
1158 struct ir_swizzle_mask
{
1165 * Number of components in the swizzle.
1167 unsigned num_components
:3;
1170 * Does the swizzle contain duplicate components?
1172 * L-value swizzles cannot contain duplicate components.
1174 unsigned has_duplicates
:1;
1178 class ir_swizzle
: public ir_rvalue
{
1180 ir_swizzle(ir_rvalue
*, unsigned x
, unsigned y
, unsigned z
, unsigned w
,
1183 ir_swizzle(ir_rvalue
*val
, const unsigned *components
, unsigned count
);
1185 ir_swizzle(ir_rvalue
*val
, ir_swizzle_mask mask
);
1187 virtual ir_swizzle
*clone(void *mem_ctx
, struct hash_table
*) const;
1189 virtual ir_constant
*constant_expression_value();
1191 virtual ir_swizzle
*as_swizzle()
1197 * Construct an ir_swizzle from the textual representation. Can fail.
1199 static ir_swizzle
*create(ir_rvalue
*, const char *, unsigned vector_length
);
1201 virtual void accept(ir_visitor
*v
)
1206 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1210 return val
->is_lvalue() && !mask
.has_duplicates
;
1214 * Get the variable that is ultimately referenced by an r-value
1216 virtual ir_variable
*variable_referenced();
1219 ir_swizzle_mask mask
;
1223 * Initialize the mask component of a swizzle
1225 * This is used by the \c ir_swizzle constructors.
1227 void init_mask(const unsigned *components
, unsigned count
);
1231 class ir_dereference
: public ir_rvalue
{
1233 virtual ir_dereference
*clone(void *mem_ctx
, struct hash_table
*) const = 0;
1235 virtual ir_dereference
*as_dereference()
1243 * Get the variable that is ultimately referenced by an r-value
1245 virtual ir_variable
*variable_referenced() = 0;
1249 class ir_dereference_variable
: public ir_dereference
{
1251 ir_dereference_variable(ir_variable
*var
);
1253 virtual ir_dereference_variable
*clone(void *mem_ctx
,
1254 struct hash_table
*) const;
1256 virtual ir_constant
*constant_expression_value();
1258 virtual ir_dereference_variable
*as_dereference_variable()
1264 * Get the variable that is ultimately referenced by an r-value
1266 virtual ir_variable
*variable_referenced()
1271 virtual ir_variable
*whole_variable_referenced()
1273 /* ir_dereference_variable objects always dereference the entire
1274 * variable. However, if this dereference is dereferenced by anything
1275 * else, the complete deferefernce chain is not a whole-variable
1276 * dereference. This method should only be called on the top most
1277 * ir_rvalue in a dereference chain.
1282 virtual void accept(ir_visitor
*v
)
1287 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1290 * Object being dereferenced.
1296 class ir_dereference_array
: public ir_dereference
{
1298 ir_dereference_array(ir_rvalue
*value
, ir_rvalue
*array_index
);
1300 ir_dereference_array(ir_variable
*var
, ir_rvalue
*array_index
);
1302 virtual ir_dereference_array
*clone(void *mem_ctx
,
1303 struct hash_table
*) const;
1305 virtual ir_constant
*constant_expression_value();
1307 virtual ir_dereference_array
*as_dereference_array()
1313 * Get the variable that is ultimately referenced by an r-value
1315 virtual ir_variable
*variable_referenced()
1317 return this->array
->variable_referenced();
1320 virtual void accept(ir_visitor
*v
)
1325 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1328 ir_rvalue
*array_index
;
1331 void set_array(ir_rvalue
*value
);
1335 class ir_dereference_record
: public ir_dereference
{
1337 ir_dereference_record(ir_rvalue
*value
, const char *field
);
1339 ir_dereference_record(ir_variable
*var
, const char *field
);
1341 virtual ir_dereference_record
*clone(void *mem_ctx
,
1342 struct hash_table
*) const;
1344 virtual ir_constant
*constant_expression_value();
1347 * Get the variable that is ultimately referenced by an r-value
1349 virtual ir_variable
*variable_referenced()
1351 return this->record
->variable_referenced();
1354 virtual void accept(ir_visitor
*v
)
1359 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1367 * Data stored in an ir_constant
1369 union ir_constant_data
{
1377 class ir_constant
: public ir_rvalue
{
1379 ir_constant(const struct glsl_type
*type
, const ir_constant_data
*data
);
1380 ir_constant(bool b
);
1381 ir_constant(unsigned int u
);
1383 ir_constant(float f
);
1386 * Construct an ir_constant from a list of ir_constant values
1388 ir_constant(const struct glsl_type
*type
, exec_list
*values
);
1391 * Construct an ir_constant from a scalar component of another ir_constant
1393 * The new \c ir_constant inherits the type of the component from the
1397 * In the case of a matrix constant, the new constant is a scalar, \b not
1400 ir_constant(const ir_constant
*c
, unsigned i
);
1403 * Return a new ir_constant of the specified type containing all zeros.
1405 static ir_constant
*zero(void *mem_ctx
, const glsl_type
*type
);
1407 virtual ir_constant
*clone(void *mem_ctx
, struct hash_table
*) const;
1409 virtual ir_constant
*constant_expression_value();
1411 virtual ir_constant
*as_constant()
1416 virtual void accept(ir_visitor
*v
)
1421 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1424 * Get a particular component of a constant as a specific type
1426 * This is useful, for example, to get a value from an integer constant
1427 * as a float or bool. This appears frequently when constructors are
1428 * called with all constant parameters.
1431 bool get_bool_component(unsigned i
) const;
1432 float get_float_component(unsigned i
) const;
1433 int get_int_component(unsigned i
) const;
1434 unsigned get_uint_component(unsigned i
) const;
1437 ir_constant
*get_array_element(unsigned i
) const;
1439 ir_constant
*get_record_field(const char *name
);
1442 * Determine whether a constant has the same value as another constant
1444 * \sa ir_constant::is_zero, ir_constant::is_one
1446 bool has_value(const ir_constant
*) const;
1449 * Determine if a constant has the value zero
1452 * This function always returns \c false for constants that are not
1453 * scalars or vectors.
1455 * \sa ir_constant::has_value, ir_constant::is_one
1457 bool is_zero() const;
1460 * Determine if a constant has the value one
1463 * This function always returns \c false for constants that are not
1464 * scalars or vectors.
1466 * \sa ir_constant::has_value, ir_constant::is_zero
1468 bool is_one() const;
1471 * Value of the constant.
1473 * The field used to back the values supplied by the constant is determined
1474 * by the type associated with the \c ir_instruction. Constants may be
1475 * scalars, vectors, or matrices.
1477 union ir_constant_data value
;
1479 /* Array elements */
1480 ir_constant
**array_elements
;
1482 /* Structure fields */
1483 exec_list components
;
1487 * Parameterless constructor only used by the clone method
1495 * Apply a visitor to each IR node in a list
1498 visit_exec_list(exec_list
*list
, ir_visitor
*visitor
);
1501 * Validate invariants on each IR node in a list
1503 void validate_ir_tree(exec_list
*instructions
);
1506 * Make a clone of each IR instruction in a list
1508 * \param in List of IR instructions that are to be cloned
1509 * \param out List to hold the cloned instructions
1512 clone_ir_list(void *mem_ctx
, exec_list
*out
, const exec_list
*in
);
1515 _mesa_glsl_initialize_variables(exec_list
*instructions
,
1516 struct _mesa_glsl_parse_state
*state
);
1519 _mesa_glsl_initialize_functions(exec_list
*instructions
,
1520 struct _mesa_glsl_parse_state
*state
);
1523 _mesa_glsl_release_functions(void);
1526 reparent_ir(exec_list
*list
, void *mem_ctx
);
1528 struct glsl_symbol_table
;
1531 import_prototypes(const exec_list
*source
, exec_list
*dest
,
1532 struct glsl_symbol_table
*symbols
, void *mem_ctx
);
1535 ir_has_call(ir_instruction
*ir
);
1538 do_set_program_inouts(exec_list
*instructions
, struct gl_program
*prog
);