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 #define ARRAY_SIZE(x) (sizeof(x) / sizeof(x[0]))
45 * \defgroup IR Intermediate representation nodes
53 * Each concrete class derived from \c ir_instruction has a value in this
54 * enumerant. The value for the type is stored in \c ir_instruction::ir_type
55 * by the constructor. While using type tags is not very C++, it is extremely
56 * convenient. For example, during debugging you can simply inspect
57 * \c ir_instruction::ir_type to find out the actual type of the object.
59 * In addition, it is possible to use a switch-statement based on \c
60 * \c ir_instruction::ir_type to select different behavior for different object
61 * types. For functions that have only slight differences for several object
62 * types, this allows writing very straightforward, readable code.
66 * Zero is unused so that the IR validator can detect cases where
67 * \c ir_instruction::ir_type has not been initialized.
74 ir_type_dereference_array
,
75 ir_type_dereference_record
,
76 ir_type_dereference_variable
,
80 ir_type_function_signature
,
87 ir_type_max
/**< maximum ir_type enum number, for validation */
91 * Base class of all IR instructions
93 class ir_instruction
: public exec_node
{
95 enum ir_node_type ir_type
;
96 const struct glsl_type
*type
;
98 /** ir_print_visitor helper for debugging. */
99 void print(void) const;
101 virtual void accept(ir_visitor
*) = 0;
102 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*) = 0;
103 virtual ir_instruction
*clone(void *mem_ctx
,
104 struct hash_table
*ht
) const = 0;
107 * \name IR instruction downcast functions
109 * These functions either cast the object to a derived class or return
110 * \c NULL if the object's type does not match the specified derived class.
111 * Additional downcast functions will be added as needed.
114 virtual class ir_variable
* as_variable() { return NULL
; }
115 virtual class ir_function
* as_function() { return NULL
; }
116 virtual class ir_dereference
* as_dereference() { return NULL
; }
117 virtual class ir_dereference_array
* as_dereference_array() { return NULL
; }
118 virtual class ir_dereference_variable
*as_dereference_variable() { return NULL
; }
119 virtual class ir_expression
* as_expression() { return NULL
; }
120 virtual class ir_rvalue
* as_rvalue() { return NULL
; }
121 virtual class ir_loop
* as_loop() { return NULL
; }
122 virtual class ir_assignment
* as_assignment() { return NULL
; }
123 virtual class ir_call
* as_call() { return NULL
; }
124 virtual class ir_return
* as_return() { return NULL
; }
125 virtual class ir_if
* as_if() { return NULL
; }
126 virtual class ir_swizzle
* as_swizzle() { return NULL
; }
127 virtual class ir_constant
* as_constant() { return NULL
; }
133 ir_type
= ir_type_unset
;
139 class ir_rvalue
: public ir_instruction
{
141 virtual ir_rvalue
*clone(void *mem_ctx
, struct hash_table
*) const = 0;
143 virtual ir_constant
*constant_expression_value() = 0;
145 virtual ir_rvalue
* as_rvalue()
150 virtual bool is_lvalue()
156 * Get the variable that is ultimately referenced by an r-value
158 virtual ir_variable
*variable_referenced()
165 * If an r-value is a reference to a whole variable, get that variable
168 * Pointer to a variable that is completely dereferenced by the r-value. If
169 * the r-value is not a dereference or the dereference does not access the
170 * entire variable (i.e., it's just one array element, struct field), \c NULL
173 virtual ir_variable
*whole_variable_referenced()
184 * Variable storage classes
186 enum ir_variable_mode
{
187 ir_var_auto
= 0, /**< Function local variables and globals. */
188 ir_var_uniform
, /**< Variable declared as a uniform. */
192 ir_var_temporary
/**< Temporary variable generated during compilation. */
195 enum ir_variable_interpolation
{
202 class ir_variable
: public ir_instruction
{
204 ir_variable(const struct glsl_type
*, const char *, ir_variable_mode
);
206 virtual ir_variable
*clone(void *mem_ctx
, struct hash_table
*ht
) const;
208 virtual ir_variable
*as_variable()
213 virtual void accept(ir_visitor
*v
)
218 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
222 * Get the string value for the interpolation qualifier
224 * \return The string that would be used in a shader to specify \c
225 * mode will be returned.
227 * This function should only be used on a shader input or output variable.
229 const char *interpolation_string() const;
232 * Calculate the number of slots required to hold this variable
234 * This is used to determine how many uniform or varying locations a variable
235 * occupies. The count is in units of floating point components.
237 unsigned component_slots() const;
240 * Delcared name of the variable
245 * Highest element accessed with a constant expression array index
247 * Not used for non-array variables.
249 unsigned max_array_access
;
252 * Is the variable read-only?
254 * This is set for variables declared as \c const, shader inputs,
257 unsigned read_only
:1;
259 unsigned invariant
:1;
262 * Storage class of the variable.
264 * \sa ir_variable_mode
269 * Interpolation mode for shader inputs / outputs
271 * \sa ir_variable_interpolation
273 unsigned interpolation
:2;
276 * Flag that the whole array is assignable
278 * In GLSL 1.20 and later whole arrays are assignable (and comparable for
279 * equality). This flag enables this behavior.
281 unsigned array_lvalue
:1;
284 * \name ARB_fragment_coord_conventions
287 unsigned origin_upper_left
:1;
288 unsigned pixel_center_integer
:1;
292 * Was the location explicitly set in the shader?
294 * If the location is explicitly set in the shader, it \b cannot be changed
295 * by the linker or by the API (e.g., calls to \c glBindAttribLocation have
298 unsigned explicit_location
:1;
301 * Storage location of the base of this variable
303 * The precise meaning of this field depends on the nature of the variable.
305 * - Vertex shader input: one of the values from \c gl_vert_attrib.
306 * - Vertex shader output: one of the values from \c gl_vert_result.
307 * - Fragment shader input: one of the values from \c gl_frag_attrib.
308 * - Fragment shader output: one of the values from \c gl_frag_result.
309 * - Uniforms: Per-stage uniform slot number.
310 * - Other: This field is not currently used.
312 * If the variable is a uniform, shader input, or shader output, and the
313 * slot has not been assigned, the value will be -1.
318 * Emit a warning if this variable is accessed.
320 const char *warn_extension
;
323 * Value assigned in the initializer of a variable declared "const"
325 ir_constant
*constant_value
;
331 * The representation of a function instance; may be the full definition or
332 * simply a prototype.
334 class ir_function_signature
: public ir_instruction
{
335 /* An ir_function_signature will be part of the list of signatures in
339 ir_function_signature(const glsl_type
*return_type
);
341 virtual ir_function_signature
*clone(void *mem_ctx
,
342 struct hash_table
*ht
) const;
344 virtual void accept(ir_visitor
*v
)
349 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
352 * Get the name of the function for which this is a signature
354 const char *function_name() const;
357 * Get a handle to the function for which this is a signature
359 * There is no setter function, this function returns a \c const pointer,
360 * and \c ir_function_signature::_function is private for a reason. The
361 * only way to make a connection between a function and function signature
362 * is via \c ir_function::add_signature. This helps ensure that certain
363 * invariants (i.e., a function signature is in the list of signatures for
364 * its \c _function) are met.
366 * \sa ir_function::add_signature
368 inline const class ir_function
*function() const
370 return this->_function
;
374 * Check whether the qualifiers match between this signature's parameters
375 * and the supplied parameter list. If not, returns the name of the first
376 * parameter with mismatched qualifiers (for use in error messages).
378 const char *qualifiers_match(exec_list
*params
);
381 * Replace the current parameter list with the given one. This is useful
382 * if the current information came from a prototype, and either has invalid
383 * or missing parameter names.
385 void replace_parameters(exec_list
*new_params
);
388 * Function return type.
390 * \note This discards the optional precision qualifier.
392 const struct glsl_type
*return_type
;
395 * List of ir_variable of function parameters.
397 * This represents the storage. The paramaters passed in a particular
398 * call will be in ir_call::actual_paramaters.
400 struct exec_list parameters
;
402 /** Whether or not this function has a body (which may be empty). */
403 unsigned is_defined
:1;
405 /** Whether or not this function signature is a built-in. */
406 unsigned is_builtin
:1;
408 /** Body of instructions in the function. */
409 struct exec_list body
;
412 /** Function of which this signature is one overload. */
413 class ir_function
*_function
;
415 friend class ir_function
;
420 * Header for tracking multiple overloaded functions with the same name.
421 * Contains a list of ir_function_signatures representing each of the
424 class ir_function
: public ir_instruction
{
426 ir_function(const char *name
);
428 virtual ir_function
*clone(void *mem_ctx
, struct hash_table
*ht
) const;
430 virtual ir_function
*as_function()
435 virtual void accept(ir_visitor
*v
)
440 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
442 void add_signature(ir_function_signature
*sig
)
444 sig
->_function
= this;
445 this->signatures
.push_tail(sig
);
449 * Get an iterator for the set of function signatures
451 exec_list_iterator
iterator()
453 return signatures
.iterator();
457 * Find a signature that matches a set of actual parameters, taking implicit
458 * conversions into account.
460 ir_function_signature
*matching_signature(const exec_list
*actual_param
);
463 * Find a signature that exactly matches a set of actual parameters without
464 * any implicit type conversions.
466 ir_function_signature
*exact_matching_signature(const exec_list
*actual_ps
);
469 * Name of the function.
473 /** Whether or not this function has a signature that isn't a built-in. */
474 bool has_user_signature();
477 * List of ir_function_signature for each overloaded function with this name.
479 struct exec_list signatures
;
482 inline const char *ir_function_signature::function_name() const
484 return this->_function
->name
;
490 * IR instruction representing high-level if-statements
492 class ir_if
: public ir_instruction
{
494 ir_if(ir_rvalue
*condition
)
495 : condition(condition
)
497 ir_type
= ir_type_if
;
500 virtual ir_if
*clone(void *mem_ctx
, struct hash_table
*ht
) const;
502 virtual ir_if
*as_if()
507 virtual void accept(ir_visitor
*v
)
512 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
514 ir_rvalue
*condition
;
515 /** List of ir_instruction for the body of the then branch */
516 exec_list then_instructions
;
517 /** List of ir_instruction for the body of the else branch */
518 exec_list else_instructions
;
523 * IR instruction representing a high-level loop structure.
525 class ir_loop
: public ir_instruction
{
529 virtual ir_loop
*clone(void *mem_ctx
, struct hash_table
*ht
) const;
531 virtual void accept(ir_visitor
*v
)
536 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
538 virtual ir_loop
*as_loop()
544 * Get an iterator for the instructions of the loop body
546 exec_list_iterator
iterator()
548 return body_instructions
.iterator();
551 /** List of ir_instruction that make up the body of the loop. */
552 exec_list body_instructions
;
555 * \name Loop counter and controls
557 * Represents a loop like a FORTRAN \c do-loop.
560 * If \c from and \c to are the same value, the loop will execute once.
563 ir_rvalue
*from
; /** Value of the loop counter on the first
564 * iteration of the loop.
566 ir_rvalue
*to
; /** Value of the loop counter on the last
567 * iteration of the loop.
569 ir_rvalue
*increment
;
570 ir_variable
*counter
;
573 * Comparison operation in the loop terminator.
575 * If any of the loop control fields are non-\c NULL, this field must be
576 * one of \c ir_binop_less, \c ir_binop_greater, \c ir_binop_lequal,
577 * \c ir_binop_gequal, \c ir_binop_equal, or \c ir_binop_nequal.
584 class ir_assignment
: public ir_instruction
{
586 ir_assignment(ir_rvalue
*lhs
, ir_rvalue
*rhs
, ir_rvalue
*condition
);
589 * Construct an assignment with an explicit write mask
592 * Since a write mask is supplied, the LHS must already be a bare
593 * \c ir_dereference. The cannot be any swizzles in the LHS.
595 ir_assignment(ir_dereference
*lhs
, ir_rvalue
*rhs
, ir_rvalue
*condition
,
596 unsigned write_mask
);
598 virtual ir_assignment
*clone(void *mem_ctx
, struct hash_table
*ht
) const;
600 virtual ir_constant
*constant_expression_value();
602 virtual void accept(ir_visitor
*v
)
607 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
609 virtual ir_assignment
* as_assignment()
615 * Get a whole variable written by an assignment
617 * If the LHS of the assignment writes a whole variable, the variable is
618 * returned. Otherwise \c NULL is returned. Examples of whole-variable
621 * - Assigning to a scalar
622 * - Assigning to all components of a vector
623 * - Whole array (or matrix) assignment
624 * - Whole structure assignment
626 ir_variable
*whole_variable_written();
629 * Set the LHS of an assignment
631 void set_lhs(ir_rvalue
*lhs
);
634 * Left-hand side of the assignment.
636 * This should be treated as read only. If you need to set the LHS of an
637 * assignment, use \c ir_assignment::set_lhs.
642 * Value being assigned
647 * Optional condition for the assignment.
649 ir_rvalue
*condition
;
653 * Component mask written
655 * For non-vector types in the LHS, this field will be zero. For vector
656 * types, a bit will be set for each component that is written. Note that
657 * for \c vec2 and \c vec3 types only the lower bits will ever be set.
659 * A partially-set write mask means that each enabled channel gets
660 * the value from a consecutive channel of the rhs. For example,
661 * to write just .xyw of gl_FrontColor with color:
663 * (assign (constant bool (1)) (xyw)
664 * (var_ref gl_FragColor)
665 * (swiz xyw (var_ref color)))
667 unsigned write_mask
:4;
670 /* Update ir_expression::num_operands() and operator_strs when
671 * updating this list.
673 enum ir_expression_operation
{
682 ir_unop_exp
, /**< Log base e on gentype */
683 ir_unop_log
, /**< Natural log on gentype */
686 ir_unop_f2i
, /**< Float-to-integer conversion. */
687 ir_unop_i2f
, /**< Integer-to-float conversion. */
688 ir_unop_f2b
, /**< Float-to-boolean conversion */
689 ir_unop_b2f
, /**< Boolean-to-float conversion */
690 ir_unop_i2b
, /**< int-to-boolean conversion */
691 ir_unop_b2i
, /**< Boolean-to-int conversion */
692 ir_unop_u2f
, /**< Unsigned-to-float conversion. */
696 * \name Unary floating-point rounding operations.
706 * \name Trigonometric operations.
714 * \name Partial derivatives.
729 * Takes one of two combinations of arguments:
734 * Does not take integer types.
739 * \name Binary comparison operators which return a boolean vector.
740 * The type of both operands must be equal.
750 * Returns single boolean for whether all components of operands[0]
751 * equal the components of operands[1].
755 * Returns single boolean for whether any component of operands[0]
756 * is not equal to the corresponding component of operands[1].
762 * \name Bit-wise binary operations.
784 class ir_expression
: public ir_rvalue
{
786 ir_expression(int op
, const struct glsl_type
*type
,
787 ir_rvalue
*, ir_rvalue
*);
789 virtual ir_expression
*as_expression()
794 virtual ir_expression
*clone(void *mem_ctx
, struct hash_table
*ht
) const;
797 * Attempt to constant-fold the expression
799 * If the expression cannot be constant folded, this method will return
802 virtual ir_constant
*constant_expression_value();
805 * Determine the number of operands used by an expression
807 static unsigned int get_num_operands(ir_expression_operation
);
810 * Determine the number of operands used by an expression
812 unsigned int get_num_operands() const
814 return get_num_operands(operation
);
818 * Return a string representing this expression's operator.
820 const char *operator_string();
823 * Return a string representing this expression's operator.
825 static const char *operator_string(ir_expression_operation
);
829 * Do a reverse-lookup to translate the given string into an operator.
831 static ir_expression_operation
get_operator(const char *);
833 virtual void accept(ir_visitor
*v
)
838 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
840 ir_expression_operation operation
;
841 ir_rvalue
*operands
[2];
846 * IR instruction representing a function call
848 class ir_call
: public ir_rvalue
{
850 ir_call(ir_function_signature
*callee
, exec_list
*actual_parameters
)
853 ir_type
= ir_type_call
;
854 assert(callee
->return_type
!= NULL
);
855 type
= callee
->return_type
;
856 actual_parameters
->move_nodes_to(& this->actual_parameters
);
859 virtual ir_call
*clone(void *mem_ctx
, struct hash_table
*ht
) const;
861 virtual ir_constant
*constant_expression_value();
863 virtual ir_call
*as_call()
868 virtual void accept(ir_visitor
*v
)
873 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
876 * Get a generic ir_call object when an error occurs
878 * Any allocation will be performed with 'ctx' as talloc owner.
880 static ir_call
*get_error_instruction(void *ctx
);
883 * Get an iterator for the set of acutal parameters
885 exec_list_iterator
iterator()
887 return actual_parameters
.iterator();
891 * Get the name of the function being called.
893 const char *callee_name() const
895 return callee
->function_name();
899 * Get the function signature bound to this function call
901 ir_function_signature
*get_callee()
907 * Set the function call target
909 void set_callee(ir_function_signature
*sig
);
912 * Generates an inline version of the function before @ir,
913 * returning the return value of the function.
915 ir_rvalue
*generate_inline(ir_instruction
*ir
);
917 /* List of ir_rvalue of paramaters passed in this call. */
918 exec_list actual_parameters
;
924 this->ir_type
= ir_type_call
;
927 ir_function_signature
*callee
;
932 * \name Jump-like IR instructions.
934 * These include \c break, \c continue, \c return, and \c discard.
937 class ir_jump
: public ir_instruction
{
941 ir_type
= ir_type_unset
;
945 class ir_return
: public ir_jump
{
950 this->ir_type
= ir_type_return
;
953 ir_return(ir_rvalue
*value
)
956 this->ir_type
= ir_type_return
;
959 virtual ir_return
*clone(void *mem_ctx
, struct hash_table
*) const;
961 virtual ir_return
*as_return()
966 ir_rvalue
*get_value() const
971 virtual void accept(ir_visitor
*v
)
976 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
983 * Jump instructions used inside loops
985 * These include \c break and \c continue. The \c break within a loop is
986 * different from the \c break within a switch-statement.
990 class ir_loop_jump
: public ir_jump
{
997 ir_loop_jump(jump_mode mode
)
999 this->ir_type
= ir_type_loop_jump
;
1004 virtual ir_loop_jump
*clone(void *mem_ctx
, struct hash_table
*) const;
1006 virtual void accept(ir_visitor
*v
)
1011 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1013 bool is_break() const
1015 return mode
== jump_break
;
1018 bool is_continue() const
1020 return mode
== jump_continue
;
1023 /** Mode selector for the jump instruction. */
1024 enum jump_mode mode
;
1026 /** Loop containing this break instruction. */
1031 * IR instruction representing discard statements.
1033 class ir_discard
: public ir_jump
{
1037 this->ir_type
= ir_type_discard
;
1038 this->condition
= NULL
;
1041 ir_discard(ir_rvalue
*cond
)
1043 this->ir_type
= ir_type_discard
;
1044 this->condition
= cond
;
1047 virtual ir_discard
*clone(void *mem_ctx
, struct hash_table
*ht
) const;
1049 virtual void accept(ir_visitor
*v
)
1054 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1056 ir_rvalue
*condition
;
1062 * Texture sampling opcodes used in ir_texture
1064 enum ir_texture_opcode
{
1065 ir_tex
, /**< Regular texture look-up */
1066 ir_txb
, /**< Texture look-up with LOD bias */
1067 ir_txl
, /**< Texture look-up with explicit LOD */
1068 ir_txd
, /**< Texture look-up with partial derivatvies */
1069 ir_txf
/**< Texel fetch with explicit LOD */
1074 * IR instruction to sample a texture
1076 * The specific form of the IR instruction depends on the \c mode value
1077 * selected from \c ir_texture_opcodes. In the printed IR, these will
1081 * | Projection divisor
1082 * | | Shadow comparitor
1085 * (tex (sampler) (coordinate) (0 0 0) (1) ( ))
1086 * (txb (sampler) (coordinate) (0 0 0) (1) ( ) (bias))
1087 * (txl (sampler) (coordinate) (0 0 0) (1) ( ) (lod))
1088 * (txd (sampler) (coordinate) (0 0 0) (1) ( ) (dPdx dPdy))
1089 * (txf (sampler) (coordinate) (0 0 0) (lod))
1091 class ir_texture
: public ir_rvalue
{
1093 ir_texture(enum ir_texture_opcode op
)
1094 : op(op
), projector(NULL
), shadow_comparitor(NULL
)
1096 this->ir_type
= ir_type_texture
;
1099 virtual ir_texture
*clone(void *mem_ctx
, struct hash_table
*) const;
1101 virtual ir_constant
*constant_expression_value();
1103 virtual void accept(ir_visitor
*v
)
1108 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1111 * Return a string representing the ir_texture_opcode.
1113 const char *opcode_string();
1115 /** Set the sampler and infer the type. */
1116 void set_sampler(ir_dereference
*sampler
);
1119 * Do a reverse-lookup to translate a string into an ir_texture_opcode.
1121 static ir_texture_opcode
get_opcode(const char *);
1123 enum ir_texture_opcode op
;
1125 /** Sampler to use for the texture access. */
1126 ir_dereference
*sampler
;
1128 /** Texture coordinate to sample */
1129 ir_rvalue
*coordinate
;
1132 * Value used for projective divide.
1134 * If there is no projective divide (the common case), this will be
1135 * \c NULL. Optimization passes should check for this to point to a constant
1136 * of 1.0 and replace that with \c NULL.
1138 ir_rvalue
*projector
;
1141 * Coordinate used for comparison on shadow look-ups.
1143 * If there is no shadow comparison, this will be \c NULL. For the
1144 * \c ir_txf opcode, this *must* be \c NULL.
1146 ir_rvalue
*shadow_comparitor
;
1148 /** Explicit texel offsets. */
1149 signed char offsets
[3];
1152 ir_rvalue
*lod
; /**< Floating point LOD */
1153 ir_rvalue
*bias
; /**< Floating point LOD bias */
1155 ir_rvalue
*dPdx
; /**< Partial derivative of coordinate wrt X */
1156 ir_rvalue
*dPdy
; /**< Partial derivative of coordinate wrt Y */
1162 struct ir_swizzle_mask
{
1169 * Number of components in the swizzle.
1171 unsigned num_components
:3;
1174 * Does the swizzle contain duplicate components?
1176 * L-value swizzles cannot contain duplicate components.
1178 unsigned has_duplicates
:1;
1182 class ir_swizzle
: public ir_rvalue
{
1184 ir_swizzle(ir_rvalue
*, unsigned x
, unsigned y
, unsigned z
, unsigned w
,
1187 ir_swizzle(ir_rvalue
*val
, const unsigned *components
, unsigned count
);
1189 ir_swizzle(ir_rvalue
*val
, ir_swizzle_mask mask
);
1191 virtual ir_swizzle
*clone(void *mem_ctx
, struct hash_table
*) const;
1193 virtual ir_constant
*constant_expression_value();
1195 virtual ir_swizzle
*as_swizzle()
1201 * Construct an ir_swizzle from the textual representation. Can fail.
1203 static ir_swizzle
*create(ir_rvalue
*, const char *, unsigned vector_length
);
1205 virtual void accept(ir_visitor
*v
)
1210 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1214 return val
->is_lvalue() && !mask
.has_duplicates
;
1218 * Get the variable that is ultimately referenced by an r-value
1220 virtual ir_variable
*variable_referenced();
1223 ir_swizzle_mask mask
;
1227 * Initialize the mask component of a swizzle
1229 * This is used by the \c ir_swizzle constructors.
1231 void init_mask(const unsigned *components
, unsigned count
);
1235 class ir_dereference
: public ir_rvalue
{
1237 virtual ir_dereference
*clone(void *mem_ctx
, struct hash_table
*) const = 0;
1239 virtual ir_dereference
*as_dereference()
1247 * Get the variable that is ultimately referenced by an r-value
1249 virtual ir_variable
*variable_referenced() = 0;
1253 class ir_dereference_variable
: public ir_dereference
{
1255 ir_dereference_variable(ir_variable
*var
);
1257 virtual ir_dereference_variable
*clone(void *mem_ctx
,
1258 struct hash_table
*) const;
1260 virtual ir_constant
*constant_expression_value();
1262 virtual ir_dereference_variable
*as_dereference_variable()
1268 * Get the variable that is ultimately referenced by an r-value
1270 virtual ir_variable
*variable_referenced()
1275 virtual ir_variable
*whole_variable_referenced()
1277 /* ir_dereference_variable objects always dereference the entire
1278 * variable. However, if this dereference is dereferenced by anything
1279 * else, the complete deferefernce chain is not a whole-variable
1280 * dereference. This method should only be called on the top most
1281 * ir_rvalue in a dereference chain.
1286 virtual void accept(ir_visitor
*v
)
1291 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1294 * Object being dereferenced.
1300 class ir_dereference_array
: public ir_dereference
{
1302 ir_dereference_array(ir_rvalue
*value
, ir_rvalue
*array_index
);
1304 ir_dereference_array(ir_variable
*var
, ir_rvalue
*array_index
);
1306 virtual ir_dereference_array
*clone(void *mem_ctx
,
1307 struct hash_table
*) const;
1309 virtual ir_constant
*constant_expression_value();
1311 virtual ir_dereference_array
*as_dereference_array()
1317 * Get the variable that is ultimately referenced by an r-value
1319 virtual ir_variable
*variable_referenced()
1321 return this->array
->variable_referenced();
1324 virtual void accept(ir_visitor
*v
)
1329 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1332 ir_rvalue
*array_index
;
1335 void set_array(ir_rvalue
*value
);
1339 class ir_dereference_record
: public ir_dereference
{
1341 ir_dereference_record(ir_rvalue
*value
, const char *field
);
1343 ir_dereference_record(ir_variable
*var
, const char *field
);
1345 virtual ir_dereference_record
*clone(void *mem_ctx
,
1346 struct hash_table
*) const;
1348 virtual ir_constant
*constant_expression_value();
1351 * Get the variable that is ultimately referenced by an r-value
1353 virtual ir_variable
*variable_referenced()
1355 return this->record
->variable_referenced();
1358 virtual void accept(ir_visitor
*v
)
1363 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1371 * Data stored in an ir_constant
1373 union ir_constant_data
{
1381 class ir_constant
: public ir_rvalue
{
1383 ir_constant(const struct glsl_type
*type
, const ir_constant_data
*data
);
1384 ir_constant(bool b
);
1385 ir_constant(unsigned int u
);
1387 ir_constant(float f
);
1390 * Construct an ir_constant from a list of ir_constant values
1392 ir_constant(const struct glsl_type
*type
, exec_list
*values
);
1395 * Construct an ir_constant from a scalar component of another ir_constant
1397 * The new \c ir_constant inherits the type of the component from the
1401 * In the case of a matrix constant, the new constant is a scalar, \b not
1404 ir_constant(const ir_constant
*c
, unsigned i
);
1407 * Return a new ir_constant of the specified type containing all zeros.
1409 static ir_constant
*zero(void *mem_ctx
, const glsl_type
*type
);
1411 virtual ir_constant
*clone(void *mem_ctx
, struct hash_table
*) const;
1413 virtual ir_constant
*constant_expression_value();
1415 virtual ir_constant
*as_constant()
1420 virtual void accept(ir_visitor
*v
)
1425 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1428 * Get a particular component of a constant as a specific type
1430 * This is useful, for example, to get a value from an integer constant
1431 * as a float or bool. This appears frequently when constructors are
1432 * called with all constant parameters.
1435 bool get_bool_component(unsigned i
) const;
1436 float get_float_component(unsigned i
) const;
1437 int get_int_component(unsigned i
) const;
1438 unsigned get_uint_component(unsigned i
) const;
1441 ir_constant
*get_array_element(unsigned i
) const;
1443 ir_constant
*get_record_field(const char *name
);
1446 * Determine whether a constant has the same value as another constant
1448 bool has_value(const ir_constant
*) const;
1451 * Value of the constant.
1453 * The field used to back the values supplied by the constant is determined
1454 * by the type associated with the \c ir_instruction. Constants may be
1455 * scalars, vectors, or matrices.
1457 union ir_constant_data value
;
1459 /* Array elements */
1460 ir_constant
**array_elements
;
1462 /* Structure fields */
1463 exec_list components
;
1467 * Parameterless constructor only used by the clone method
1475 * Apply a visitor to each IR node in a list
1478 visit_exec_list(exec_list
*list
, ir_visitor
*visitor
);
1481 * Validate invariants on each IR node in a list
1483 void validate_ir_tree(exec_list
*instructions
);
1486 * Make a clone of each IR instruction in a list
1488 * \param in List of IR instructions that are to be cloned
1489 * \param out List to hold the cloned instructions
1492 clone_ir_list(void *mem_ctx
, exec_list
*out
, const exec_list
*in
);
1495 _mesa_glsl_initialize_variables(exec_list
*instructions
,
1496 struct _mesa_glsl_parse_state
*state
);
1499 _mesa_glsl_initialize_functions(exec_list
*instructions
,
1500 struct _mesa_glsl_parse_state
*state
);
1503 _mesa_glsl_release_functions(void);
1506 reparent_ir(exec_list
*list
, void *mem_ctx
);
1508 struct glsl_symbol_table
;
1511 import_prototypes(const exec_list
*source
, exec_list
*dest
,
1512 struct glsl_symbol_table
*symbols
, void *mem_ctx
);
1515 ir_has_call(ir_instruction
*ir
);
1518 do_set_program_inouts(exec_list
*instructions
, struct gl_program
*prog
);