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.
36 #include "glsl_types.h"
38 #include "ir_visitor.h"
39 #include "ir_hierarchical_visitor.h"
42 * \defgroup IR Intermediate representation nodes
50 * Each concrete class derived from \c ir_instruction has a value in this
51 * enumerant. The value for the type is stored in \c ir_instruction::ir_type
52 * by the constructor. While using type tags is not very C++, it is extremely
53 * convenient. For example, during debugging you can simply inspect
54 * \c ir_instruction::ir_type to find out the actual type of the object.
56 * In addition, it is possible to use a switch-statement based on \c
57 * \c ir_instruction::ir_type to select different behavior for different object
58 * types. For functions that have only slight differences for several object
59 * types, this allows writing very straightforward, readable code.
63 * Zero is unused so that the IR validator can detect cases where
64 * \c ir_instruction::ir_type has not been initialized.
71 ir_type_dereference_array
,
72 ir_type_dereference_record
,
73 ir_type_dereference_variable
,
77 ir_type_function_signature
,
84 ir_type_max
/**< maximum ir_type enum number, for validation */
88 * Base class of all IR instructions
90 class ir_instruction
: public exec_node
{
92 enum ir_node_type ir_type
;
93 const struct glsl_type
*type
;
95 /** ir_print_visitor helper for debugging. */
96 void print(void) const;
98 virtual void accept(ir_visitor
*) = 0;
99 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*) = 0;
100 virtual ir_instruction
*clone(void *mem_ctx
,
101 struct hash_table
*ht
) const = 0;
104 * \name IR instruction downcast functions
106 * These functions either cast the object to a derived class or return
107 * \c NULL if the object's type does not match the specified derived class.
108 * Additional downcast functions will be added as needed.
111 virtual class ir_variable
* as_variable() { return NULL
; }
112 virtual class ir_function
* as_function() { return NULL
; }
113 virtual class ir_dereference
* as_dereference() { return NULL
; }
114 virtual class ir_dereference_array
* as_dereference_array() { return NULL
; }
115 virtual class ir_dereference_variable
*as_dereference_variable() { return NULL
; }
116 virtual class ir_expression
* as_expression() { return NULL
; }
117 virtual class ir_rvalue
* as_rvalue() { return NULL
; }
118 virtual class ir_loop
* as_loop() { return NULL
; }
119 virtual class ir_assignment
* as_assignment() { return NULL
; }
120 virtual class ir_call
* as_call() { return NULL
; }
121 virtual class ir_return
* as_return() { return NULL
; }
122 virtual class ir_if
* as_if() { return NULL
; }
123 virtual class ir_swizzle
* as_swizzle() { return NULL
; }
124 virtual class ir_constant
* as_constant() { return NULL
; }
125 virtual class ir_discard
* as_discard() { return NULL
; }
131 ir_type
= ir_type_unset
;
137 class ir_rvalue
: public ir_instruction
{
139 virtual ir_rvalue
*clone(void *mem_ctx
, struct hash_table
*) const = 0;
141 virtual ir_constant
*constant_expression_value() = 0;
143 virtual ir_rvalue
* as_rvalue()
148 ir_rvalue
*as_rvalue_to_saturate();
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()
179 * Determine if an r-value has the value zero
181 * The base implementation of this function always returns \c false. The
182 * \c ir_constant class over-rides this function to return \c true \b only
183 * for vector and scalar types that have all elements set to the value
184 * zero (or \c false for booleans).
186 * \sa ir_constant::has_value, ir_rvalue::is_one, ir_rvalue::is_negative_one
188 virtual bool is_zero() const;
191 * Determine if an r-value has the value one
193 * The base implementation of this function always returns \c false. The
194 * \c ir_constant class over-rides this function to return \c true \b only
195 * for vector and scalar types that have all elements set to the value
196 * one (or \c true for booleans).
198 * \sa ir_constant::has_value, ir_rvalue::is_zero, ir_rvalue::is_negative_one
200 virtual bool is_one() const;
203 * Determine if an r-value has the value negative one
205 * The base implementation of this function always returns \c false. The
206 * \c ir_constant class over-rides this function to return \c true \b only
207 * for vector and scalar types that have all elements set to the value
208 * negative one. For boolean times, the result is always \c false.
210 * \sa ir_constant::has_value, ir_rvalue::is_zero, ir_rvalue::is_one
212 virtual bool is_negative_one() const;
220 * Variable storage classes
222 enum ir_variable_mode
{
223 ir_var_auto
= 0, /**< Function local variables and globals. */
224 ir_var_uniform
, /**< Variable declared as a uniform. */
228 ir_var_temporary
/**< Temporary variable generated during compilation. */
231 enum ir_variable_interpolation
{
238 class ir_variable
: public ir_instruction
{
240 ir_variable(const struct glsl_type
*, const char *, ir_variable_mode
);
242 virtual ir_variable
*clone(void *mem_ctx
, struct hash_table
*ht
) const;
244 virtual ir_variable
*as_variable()
249 virtual void accept(ir_visitor
*v
)
254 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
258 * Get the string value for the interpolation qualifier
260 * \return The string that would be used in a shader to specify \c
261 * mode will be returned.
263 * This function should only be used on a shader input or output variable.
265 const char *interpolation_string() const;
268 * Calculate the number of slots required to hold this variable
270 * This is used to determine how many uniform or varying locations a variable
271 * occupies. The count is in units of floating point components.
273 unsigned component_slots() const;
276 * Delcared name of the variable
281 * Highest element accessed with a constant expression array index
283 * Not used for non-array variables.
285 unsigned max_array_access
;
288 * Is the variable read-only?
290 * This is set for variables declared as \c const, shader inputs,
293 unsigned read_only
:1;
295 unsigned invariant
:1;
298 * Storage class of the variable.
300 * \sa ir_variable_mode
305 * Interpolation mode for shader inputs / outputs
307 * \sa ir_variable_interpolation
309 unsigned interpolation
:2;
312 * Flag that the whole array is assignable
314 * In GLSL 1.20 and later whole arrays are assignable (and comparable for
315 * equality). This flag enables this behavior.
317 unsigned array_lvalue
:1;
320 * \name ARB_fragment_coord_conventions
323 unsigned origin_upper_left
:1;
324 unsigned pixel_center_integer
:1;
328 * Was the location explicitly set in the shader?
330 * If the location is explicitly set in the shader, it \b cannot be changed
331 * by the linker or by the API (e.g., calls to \c glBindAttribLocation have
334 unsigned explicit_location
:1;
337 * Storage location of the base of this variable
339 * The precise meaning of this field depends on the nature of the variable.
341 * - Vertex shader input: one of the values from \c gl_vert_attrib.
342 * - Vertex shader output: one of the values from \c gl_vert_result.
343 * - Fragment shader input: one of the values from \c gl_frag_attrib.
344 * - Fragment shader output: one of the values from \c gl_frag_result.
345 * - Uniforms: Per-stage uniform slot number.
346 * - Other: This field is not currently used.
348 * If the variable is a uniform, shader input, or shader output, and the
349 * slot has not been assigned, the value will be -1.
354 * Emit a warning if this variable is accessed.
356 const char *warn_extension
;
359 * Value assigned in the initializer of a variable declared "const"
361 ir_constant
*constant_value
;
367 * The representation of a function instance; may be the full definition or
368 * simply a prototype.
370 class ir_function_signature
: public ir_instruction
{
371 /* An ir_function_signature will be part of the list of signatures in
375 ir_function_signature(const glsl_type
*return_type
);
377 virtual ir_function_signature
*clone(void *mem_ctx
,
378 struct hash_table
*ht
) const;
379 ir_function_signature
*clone_prototype(void *mem_ctx
,
380 struct hash_table
*ht
) const;
382 virtual void accept(ir_visitor
*v
)
387 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
390 * Get the name of the function for which this is a signature
392 const char *function_name() const;
395 * Get a handle to the function for which this is a signature
397 * There is no setter function, this function returns a \c const pointer,
398 * and \c ir_function_signature::_function is private for a reason. The
399 * only way to make a connection between a function and function signature
400 * is via \c ir_function::add_signature. This helps ensure that certain
401 * invariants (i.e., a function signature is in the list of signatures for
402 * its \c _function) are met.
404 * \sa ir_function::add_signature
406 inline const class ir_function
*function() const
408 return this->_function
;
412 * Check whether the qualifiers match between this signature's parameters
413 * and the supplied parameter list. If not, returns the name of the first
414 * parameter with mismatched qualifiers (for use in error messages).
416 const char *qualifiers_match(exec_list
*params
);
419 * Replace the current parameter list with the given one. This is useful
420 * if the current information came from a prototype, and either has invalid
421 * or missing parameter names.
423 void replace_parameters(exec_list
*new_params
);
426 * Function return type.
428 * \note This discards the optional precision qualifier.
430 const struct glsl_type
*return_type
;
433 * List of ir_variable of function parameters.
435 * This represents the storage. The paramaters passed in a particular
436 * call will be in ir_call::actual_paramaters.
438 struct exec_list parameters
;
440 /** Whether or not this function has a body (which may be empty). */
441 unsigned is_defined
:1;
443 /** Whether or not this function signature is a built-in. */
444 unsigned is_builtin
:1;
446 /** Body of instructions in the function. */
447 struct exec_list body
;
450 /** Function of which this signature is one overload. */
451 class ir_function
*_function
;
453 friend class ir_function
;
458 * Header for tracking multiple overloaded functions with the same name.
459 * Contains a list of ir_function_signatures representing each of the
462 class ir_function
: public ir_instruction
{
464 ir_function(const char *name
);
466 virtual ir_function
*clone(void *mem_ctx
, struct hash_table
*ht
) const;
468 virtual ir_function
*as_function()
473 virtual void accept(ir_visitor
*v
)
478 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
480 void add_signature(ir_function_signature
*sig
)
482 sig
->_function
= this;
483 this->signatures
.push_tail(sig
);
487 * Get an iterator for the set of function signatures
489 exec_list_iterator
iterator()
491 return signatures
.iterator();
495 * Find a signature that matches a set of actual parameters, taking implicit
496 * conversions into account.
498 ir_function_signature
*matching_signature(const exec_list
*actual_param
);
501 * Find a signature that exactly matches a set of actual parameters without
502 * any implicit type conversions.
504 ir_function_signature
*exact_matching_signature(const exec_list
*actual_ps
);
507 * Name of the function.
511 /** Whether or not this function has a signature that isn't a built-in. */
512 bool has_user_signature();
515 * List of ir_function_signature for each overloaded function with this name.
517 struct exec_list signatures
;
520 inline const char *ir_function_signature::function_name() const
522 return this->_function
->name
;
528 * IR instruction representing high-level if-statements
530 class ir_if
: public ir_instruction
{
532 ir_if(ir_rvalue
*condition
)
533 : condition(condition
)
535 ir_type
= ir_type_if
;
538 virtual ir_if
*clone(void *mem_ctx
, struct hash_table
*ht
) const;
540 virtual ir_if
*as_if()
545 virtual void accept(ir_visitor
*v
)
550 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
552 ir_rvalue
*condition
;
553 /** List of ir_instruction for the body of the then branch */
554 exec_list then_instructions
;
555 /** List of ir_instruction for the body of the else branch */
556 exec_list else_instructions
;
561 * IR instruction representing a high-level loop structure.
563 class ir_loop
: public ir_instruction
{
567 virtual ir_loop
*clone(void *mem_ctx
, struct hash_table
*ht
) const;
569 virtual void accept(ir_visitor
*v
)
574 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
576 virtual ir_loop
*as_loop()
582 * Get an iterator for the instructions of the loop body
584 exec_list_iterator
iterator()
586 return body_instructions
.iterator();
589 /** List of ir_instruction that make up the body of the loop. */
590 exec_list body_instructions
;
593 * \name Loop counter and controls
595 * Represents a loop like a FORTRAN \c do-loop.
598 * If \c from and \c to are the same value, the loop will execute once.
601 ir_rvalue
*from
; /** Value of the loop counter on the first
602 * iteration of the loop.
604 ir_rvalue
*to
; /** Value of the loop counter on the last
605 * iteration of the loop.
607 ir_rvalue
*increment
;
608 ir_variable
*counter
;
611 * Comparison operation in the loop terminator.
613 * If any of the loop control fields are non-\c NULL, this field must be
614 * one of \c ir_binop_less, \c ir_binop_greater, \c ir_binop_lequal,
615 * \c ir_binop_gequal, \c ir_binop_equal, or \c ir_binop_nequal.
622 class ir_assignment
: public ir_instruction
{
624 ir_assignment(ir_rvalue
*lhs
, ir_rvalue
*rhs
, ir_rvalue
*condition
);
627 * Construct an assignment with an explicit write mask
630 * Since a write mask is supplied, the LHS must already be a bare
631 * \c ir_dereference. The cannot be any swizzles in the LHS.
633 ir_assignment(ir_dereference
*lhs
, ir_rvalue
*rhs
, ir_rvalue
*condition
,
634 unsigned write_mask
);
636 virtual ir_assignment
*clone(void *mem_ctx
, struct hash_table
*ht
) const;
638 virtual ir_constant
*constant_expression_value();
640 virtual void accept(ir_visitor
*v
)
645 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
647 virtual ir_assignment
* as_assignment()
653 * Get a whole variable written by an assignment
655 * If the LHS of the assignment writes a whole variable, the variable is
656 * returned. Otherwise \c NULL is returned. Examples of whole-variable
659 * - Assigning to a scalar
660 * - Assigning to all components of a vector
661 * - Whole array (or matrix) assignment
662 * - Whole structure assignment
664 ir_variable
*whole_variable_written();
667 * Set the LHS of an assignment
669 void set_lhs(ir_rvalue
*lhs
);
672 * Left-hand side of the assignment.
674 * This should be treated as read only. If you need to set the LHS of an
675 * assignment, use \c ir_assignment::set_lhs.
680 * Value being assigned
685 * Optional condition for the assignment.
687 ir_rvalue
*condition
;
691 * Component mask written
693 * For non-vector types in the LHS, this field will be zero. For vector
694 * types, a bit will be set for each component that is written. Note that
695 * for \c vec2 and \c vec3 types only the lower bits will ever be set.
697 * A partially-set write mask means that each enabled channel gets
698 * the value from a consecutive channel of the rhs. For example,
699 * to write just .xyw of gl_FrontColor with color:
701 * (assign (constant bool (1)) (xyw)
702 * (var_ref gl_FragColor)
703 * (swiz xyw (var_ref color)))
705 unsigned write_mask
:4;
708 /* Update ir_expression::num_operands() and operator_strs when
709 * updating this list.
711 enum ir_expression_operation
{
720 ir_unop_exp
, /**< Log base e on gentype */
721 ir_unop_log
, /**< Natural log on gentype */
724 ir_unop_f2i
, /**< Float-to-integer conversion. */
725 ir_unop_i2f
, /**< Integer-to-float conversion. */
726 ir_unop_f2b
, /**< Float-to-boolean conversion */
727 ir_unop_b2f
, /**< Boolean-to-float conversion */
728 ir_unop_i2b
, /**< int-to-boolean conversion */
729 ir_unop_b2i
, /**< Boolean-to-int conversion */
730 ir_unop_u2f
, /**< Unsigned-to-float conversion. */
734 * \name Unary floating-point rounding operations.
745 * \name Trigonometric operations.
750 ir_unop_sin_reduced
, /**< Reduced range sin. [-pi, pi] */
751 ir_unop_cos_reduced
, /**< Reduced range cos. [-pi, pi] */
755 * \name Partial derivatives.
765 * A sentinel marking the last of the unary operations.
767 ir_last_unop
= ir_unop_noise
,
775 * Takes one of two combinations of arguments:
780 * Does not take integer types.
785 * \name Binary comparison operators which return a boolean vector.
786 * The type of both operands must be equal.
796 * Returns single boolean for whether all components of operands[0]
797 * equal the components of operands[1].
801 * Returns single boolean for whether any component of operands[0]
802 * is not equal to the corresponding component of operands[1].
808 * \name Bit-wise binary operations.
829 * A sentinel marking the last of the binary operations.
831 ir_last_binop
= ir_binop_pow
,
836 * A sentinel marking the last of all operations.
838 ir_last_opcode
= ir_last_binop
841 class ir_expression
: public ir_rvalue
{
844 * Constructor for unary operation expressions
846 ir_expression(int op
, const struct glsl_type
*type
, ir_rvalue
*);
847 ir_expression(int op
, ir_rvalue
*);
850 * Constructor for binary operation expressions
852 ir_expression(int op
, const struct glsl_type
*type
,
853 ir_rvalue
*, ir_rvalue
*);
854 ir_expression(int op
, ir_rvalue
*op0
, ir_rvalue
*op1
);
857 * Constructor for quad operator expressions
859 ir_expression(int op
, const struct glsl_type
*type
,
860 ir_rvalue
*, ir_rvalue
*, ir_rvalue
*, ir_rvalue
*);
862 virtual ir_expression
*as_expression()
867 virtual ir_expression
*clone(void *mem_ctx
, struct hash_table
*ht
) const;
870 * Attempt to constant-fold the expression
872 * If the expression cannot be constant folded, this method will return
875 virtual ir_constant
*constant_expression_value();
878 * Determine the number of operands used by an expression
880 static unsigned int get_num_operands(ir_expression_operation
);
883 * Determine the number of operands used by an expression
885 unsigned int get_num_operands() const
887 return (this->operation
== ir_quadop_vector
)
888 ? this->type
->vector_elements
: get_num_operands(operation
);
892 * Return a string representing this expression's operator.
894 const char *operator_string();
897 * Return a string representing this expression's operator.
899 static const char *operator_string(ir_expression_operation
);
903 * Do a reverse-lookup to translate the given string into an operator.
905 static ir_expression_operation
get_operator(const char *);
907 virtual void accept(ir_visitor
*v
)
912 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
914 ir_expression_operation operation
;
915 ir_rvalue
*operands
[4];
920 * IR instruction representing a function call
922 class ir_call
: public ir_rvalue
{
924 ir_call(ir_function_signature
*callee
, exec_list
*actual_parameters
)
927 ir_type
= ir_type_call
;
928 assert(callee
->return_type
!= NULL
);
929 type
= callee
->return_type
;
930 actual_parameters
->move_nodes_to(& this->actual_parameters
);
933 virtual ir_call
*clone(void *mem_ctx
, struct hash_table
*ht
) const;
935 virtual ir_constant
*constant_expression_value();
937 virtual ir_call
*as_call()
942 virtual void accept(ir_visitor
*v
)
947 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
950 * Get a generic ir_call object when an error occurs
952 * Any allocation will be performed with 'ctx' as talloc owner.
954 static ir_call
*get_error_instruction(void *ctx
);
957 * Get an iterator for the set of acutal parameters
959 exec_list_iterator
iterator()
961 return actual_parameters
.iterator();
965 * Get the name of the function being called.
967 const char *callee_name() const
969 return callee
->function_name();
973 * Get the function signature bound to this function call
975 ir_function_signature
*get_callee()
981 * Set the function call target
983 void set_callee(ir_function_signature
*sig
);
986 * Generates an inline version of the function before @ir,
987 * returning the return value of the function.
989 ir_rvalue
*generate_inline(ir_instruction
*ir
);
991 /* List of ir_rvalue of paramaters passed in this call. */
992 exec_list actual_parameters
;
998 this->ir_type
= ir_type_call
;
1001 ir_function_signature
*callee
;
1006 * \name Jump-like IR instructions.
1008 * These include \c break, \c continue, \c return, and \c discard.
1011 class ir_jump
: public ir_instruction
{
1015 ir_type
= ir_type_unset
;
1019 class ir_return
: public ir_jump
{
1024 this->ir_type
= ir_type_return
;
1027 ir_return(ir_rvalue
*value
)
1030 this->ir_type
= ir_type_return
;
1033 virtual ir_return
*clone(void *mem_ctx
, struct hash_table
*) const;
1035 virtual ir_return
*as_return()
1040 ir_rvalue
*get_value() const
1045 virtual void accept(ir_visitor
*v
)
1050 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1057 * Jump instructions used inside loops
1059 * These include \c break and \c continue. The \c break within a loop is
1060 * different from the \c break within a switch-statement.
1062 * \sa ir_switch_jump
1064 class ir_loop_jump
: public ir_jump
{
1071 ir_loop_jump(jump_mode mode
)
1073 this->ir_type
= ir_type_loop_jump
;
1078 virtual ir_loop_jump
*clone(void *mem_ctx
, struct hash_table
*) const;
1080 virtual void accept(ir_visitor
*v
)
1085 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1087 bool is_break() const
1089 return mode
== jump_break
;
1092 bool is_continue() const
1094 return mode
== jump_continue
;
1097 /** Mode selector for the jump instruction. */
1098 enum jump_mode mode
;
1100 /** Loop containing this break instruction. */
1105 * IR instruction representing discard statements.
1107 class ir_discard
: public ir_jump
{
1111 this->ir_type
= ir_type_discard
;
1112 this->condition
= NULL
;
1115 ir_discard(ir_rvalue
*cond
)
1117 this->ir_type
= ir_type_discard
;
1118 this->condition
= cond
;
1121 virtual ir_discard
*clone(void *mem_ctx
, struct hash_table
*ht
) const;
1123 virtual void accept(ir_visitor
*v
)
1128 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1130 virtual ir_discard
*as_discard()
1135 ir_rvalue
*condition
;
1141 * Texture sampling opcodes used in ir_texture
1143 enum ir_texture_opcode
{
1144 ir_tex
, /**< Regular texture look-up */
1145 ir_txb
, /**< Texture look-up with LOD bias */
1146 ir_txl
, /**< Texture look-up with explicit LOD */
1147 ir_txd
, /**< Texture look-up with partial derivatvies */
1148 ir_txf
/**< Texel fetch with explicit LOD */
1153 * IR instruction to sample a texture
1155 * The specific form of the IR instruction depends on the \c mode value
1156 * selected from \c ir_texture_opcodes. In the printed IR, these will
1160 * | Projection divisor
1161 * | | Shadow comparitor
1164 * (tex (sampler) (coordinate) (0 0 0) (1) ( ))
1165 * (txb (sampler) (coordinate) (0 0 0) (1) ( ) (bias))
1166 * (txl (sampler) (coordinate) (0 0 0) (1) ( ) (lod))
1167 * (txd (sampler) (coordinate) (0 0 0) (1) ( ) (dPdx dPdy))
1168 * (txf (sampler) (coordinate) (0 0 0) (lod))
1170 class ir_texture
: public ir_rvalue
{
1172 ir_texture(enum ir_texture_opcode op
)
1173 : op(op
), projector(NULL
), shadow_comparitor(NULL
)
1175 this->ir_type
= ir_type_texture
;
1178 virtual ir_texture
*clone(void *mem_ctx
, struct hash_table
*) const;
1180 virtual ir_constant
*constant_expression_value();
1182 virtual void accept(ir_visitor
*v
)
1187 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1190 * Return a string representing the ir_texture_opcode.
1192 const char *opcode_string();
1194 /** Set the sampler and infer the type. */
1195 void set_sampler(ir_dereference
*sampler
);
1198 * Do a reverse-lookup to translate a string into an ir_texture_opcode.
1200 static ir_texture_opcode
get_opcode(const char *);
1202 enum ir_texture_opcode op
;
1204 /** Sampler to use for the texture access. */
1205 ir_dereference
*sampler
;
1207 /** Texture coordinate to sample */
1208 ir_rvalue
*coordinate
;
1211 * Value used for projective divide.
1213 * If there is no projective divide (the common case), this will be
1214 * \c NULL. Optimization passes should check for this to point to a constant
1215 * of 1.0 and replace that with \c NULL.
1217 ir_rvalue
*projector
;
1220 * Coordinate used for comparison on shadow look-ups.
1222 * If there is no shadow comparison, this will be \c NULL. For the
1223 * \c ir_txf opcode, this *must* be \c NULL.
1225 ir_rvalue
*shadow_comparitor
;
1227 /** Explicit texel offsets. */
1228 signed char offsets
[3];
1231 ir_rvalue
*lod
; /**< Floating point LOD */
1232 ir_rvalue
*bias
; /**< Floating point LOD bias */
1234 ir_rvalue
*dPdx
; /**< Partial derivative of coordinate wrt X */
1235 ir_rvalue
*dPdy
; /**< Partial derivative of coordinate wrt Y */
1241 struct ir_swizzle_mask
{
1248 * Number of components in the swizzle.
1250 unsigned num_components
:3;
1253 * Does the swizzle contain duplicate components?
1255 * L-value swizzles cannot contain duplicate components.
1257 unsigned has_duplicates
:1;
1261 class ir_swizzle
: public ir_rvalue
{
1263 ir_swizzle(ir_rvalue
*, unsigned x
, unsigned y
, unsigned z
, unsigned w
,
1266 ir_swizzle(ir_rvalue
*val
, const unsigned *components
, unsigned count
);
1268 ir_swizzle(ir_rvalue
*val
, ir_swizzle_mask mask
);
1270 virtual ir_swizzle
*clone(void *mem_ctx
, struct hash_table
*) const;
1272 virtual ir_constant
*constant_expression_value();
1274 virtual ir_swizzle
*as_swizzle()
1280 * Construct an ir_swizzle from the textual representation. Can fail.
1282 static ir_swizzle
*create(ir_rvalue
*, const char *, unsigned vector_length
);
1284 virtual void accept(ir_visitor
*v
)
1289 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1293 return val
->is_lvalue() && !mask
.has_duplicates
;
1297 * Get the variable that is ultimately referenced by an r-value
1299 virtual ir_variable
*variable_referenced();
1302 ir_swizzle_mask mask
;
1306 * Initialize the mask component of a swizzle
1308 * This is used by the \c ir_swizzle constructors.
1310 void init_mask(const unsigned *components
, unsigned count
);
1314 class ir_dereference
: public ir_rvalue
{
1316 virtual ir_dereference
*clone(void *mem_ctx
, struct hash_table
*) const = 0;
1318 virtual ir_dereference
*as_dereference()
1326 * Get the variable that is ultimately referenced by an r-value
1328 virtual ir_variable
*variable_referenced() = 0;
1332 class ir_dereference_variable
: public ir_dereference
{
1334 ir_dereference_variable(ir_variable
*var
);
1336 virtual ir_dereference_variable
*clone(void *mem_ctx
,
1337 struct hash_table
*) const;
1339 virtual ir_constant
*constant_expression_value();
1341 virtual ir_dereference_variable
*as_dereference_variable()
1347 * Get the variable that is ultimately referenced by an r-value
1349 virtual ir_variable
*variable_referenced()
1354 virtual ir_variable
*whole_variable_referenced()
1356 /* ir_dereference_variable objects always dereference the entire
1357 * variable. However, if this dereference is dereferenced by anything
1358 * else, the complete deferefernce chain is not a whole-variable
1359 * dereference. This method should only be called on the top most
1360 * ir_rvalue in a dereference chain.
1365 virtual void accept(ir_visitor
*v
)
1370 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1373 * Object being dereferenced.
1379 class ir_dereference_array
: public ir_dereference
{
1381 ir_dereference_array(ir_rvalue
*value
, ir_rvalue
*array_index
);
1383 ir_dereference_array(ir_variable
*var
, ir_rvalue
*array_index
);
1385 virtual ir_dereference_array
*clone(void *mem_ctx
,
1386 struct hash_table
*) const;
1388 virtual ir_constant
*constant_expression_value();
1390 virtual ir_dereference_array
*as_dereference_array()
1396 * Get the variable that is ultimately referenced by an r-value
1398 virtual ir_variable
*variable_referenced()
1400 return this->array
->variable_referenced();
1403 virtual void accept(ir_visitor
*v
)
1408 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1411 ir_rvalue
*array_index
;
1414 void set_array(ir_rvalue
*value
);
1418 class ir_dereference_record
: public ir_dereference
{
1420 ir_dereference_record(ir_rvalue
*value
, const char *field
);
1422 ir_dereference_record(ir_variable
*var
, const char *field
);
1424 virtual ir_dereference_record
*clone(void *mem_ctx
,
1425 struct hash_table
*) const;
1427 virtual ir_constant
*constant_expression_value();
1430 * Get the variable that is ultimately referenced by an r-value
1432 virtual ir_variable
*variable_referenced()
1434 return this->record
->variable_referenced();
1437 virtual void accept(ir_visitor
*v
)
1442 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1450 * Data stored in an ir_constant
1452 union ir_constant_data
{
1460 class ir_constant
: public ir_rvalue
{
1462 ir_constant(const struct glsl_type
*type
, const ir_constant_data
*data
);
1463 ir_constant(bool b
);
1464 ir_constant(unsigned int u
);
1466 ir_constant(float f
);
1469 * Construct an ir_constant from a list of ir_constant values
1471 ir_constant(const struct glsl_type
*type
, exec_list
*values
);
1474 * Construct an ir_constant from a scalar component of another ir_constant
1476 * The new \c ir_constant inherits the type of the component from the
1480 * In the case of a matrix constant, the new constant is a scalar, \b not
1483 ir_constant(const ir_constant
*c
, unsigned i
);
1486 * Return a new ir_constant of the specified type containing all zeros.
1488 static ir_constant
*zero(void *mem_ctx
, const glsl_type
*type
);
1490 virtual ir_constant
*clone(void *mem_ctx
, struct hash_table
*) const;
1492 virtual ir_constant
*constant_expression_value();
1494 virtual ir_constant
*as_constant()
1499 virtual void accept(ir_visitor
*v
)
1504 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1507 * Get a particular component of a constant as a specific type
1509 * This is useful, for example, to get a value from an integer constant
1510 * as a float or bool. This appears frequently when constructors are
1511 * called with all constant parameters.
1514 bool get_bool_component(unsigned i
) const;
1515 float get_float_component(unsigned i
) const;
1516 int get_int_component(unsigned i
) const;
1517 unsigned get_uint_component(unsigned i
) const;
1520 ir_constant
*get_array_element(unsigned i
) const;
1522 ir_constant
*get_record_field(const char *name
);
1525 * Determine whether a constant has the same value as another constant
1527 * \sa ir_constant::is_zero, ir_constant::is_one,
1528 * ir_constant::is_negative_one
1530 bool has_value(const ir_constant
*) const;
1532 virtual bool is_zero() const;
1533 virtual bool is_one() const;
1534 virtual bool is_negative_one() const;
1537 * Value of the constant.
1539 * The field used to back the values supplied by the constant is determined
1540 * by the type associated with the \c ir_instruction. Constants may be
1541 * scalars, vectors, or matrices.
1543 union ir_constant_data value
;
1545 /* Array elements */
1546 ir_constant
**array_elements
;
1548 /* Structure fields */
1549 exec_list components
;
1553 * Parameterless constructor only used by the clone method
1561 * Apply a visitor to each IR node in a list
1564 visit_exec_list(exec_list
*list
, ir_visitor
*visitor
);
1567 * Validate invariants on each IR node in a list
1569 void validate_ir_tree(exec_list
*instructions
);
1572 * Make a clone of each IR instruction in a list
1574 * \param in List of IR instructions that are to be cloned
1575 * \param out List to hold the cloned instructions
1578 clone_ir_list(void *mem_ctx
, exec_list
*out
, const exec_list
*in
);
1581 _mesa_glsl_initialize_variables(exec_list
*instructions
,
1582 struct _mesa_glsl_parse_state
*state
);
1585 _mesa_glsl_initialize_functions(_mesa_glsl_parse_state
*state
);
1588 _mesa_glsl_release_functions(void);
1591 reparent_ir(exec_list
*list
, void *mem_ctx
);
1593 struct glsl_symbol_table
;
1596 import_prototypes(const exec_list
*source
, exec_list
*dest
,
1597 struct glsl_symbol_table
*symbols
, void *mem_ctx
);
1600 ir_has_call(ir_instruction
*ir
);
1603 do_set_program_inouts(exec_list
*instructions
, struct gl_program
*prog
);