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
; }
130 ir_type
= ir_type_unset
;
136 class ir_rvalue
: public ir_instruction
{
138 virtual ir_rvalue
*clone(void *mem_ctx
, struct hash_table
*) const = 0;
140 virtual ir_constant
*constant_expression_value() = 0;
142 virtual ir_rvalue
* as_rvalue()
147 ir_rvalue
*as_rvalue_to_saturate();
149 virtual bool is_lvalue()
155 * Get the variable that is ultimately referenced by an r-value
157 virtual ir_variable
*variable_referenced()
164 * If an r-value is a reference to a whole variable, get that variable
167 * Pointer to a variable that is completely dereferenced by the r-value. If
168 * the r-value is not a dereference or the dereference does not access the
169 * entire variable (i.e., it's just one array element, struct field), \c NULL
172 virtual ir_variable
*whole_variable_referenced()
178 * Determine if an r-value has the value zero
180 * The base implementation of this function always returns \c false. The
181 * \c ir_constant class over-rides this function to return \c true \b only
182 * for vector and scalar types that have all elements set to the value
183 * zero (or \c false for booleans).
185 * \sa ir_constant::has_value, ir_rvalue::is_one, ir_rvalue::is_negative_one
187 virtual bool is_zero() const;
190 * Determine if an r-value has the value one
192 * The base implementation of this function always returns \c false. The
193 * \c ir_constant class over-rides this function to return \c true \b only
194 * for vector and scalar types that have all elements set to the value
195 * one (or \c true for booleans).
197 * \sa ir_constant::has_value, ir_rvalue::is_zero, ir_rvalue::is_negative_one
199 virtual bool is_one() const;
202 * Determine if an r-value has the value negative one
204 * The base implementation of this function always returns \c false. The
205 * \c ir_constant class over-rides this function to return \c true \b only
206 * for vector and scalar types that have all elements set to the value
207 * negative one. For boolean times, the result is always \c false.
209 * \sa ir_constant::has_value, ir_rvalue::is_zero, ir_rvalue::is_one
211 virtual bool is_negative_one() const;
219 * Variable storage classes
221 enum ir_variable_mode
{
222 ir_var_auto
= 0, /**< Function local variables and globals. */
223 ir_var_uniform
, /**< Variable declared as a uniform. */
227 ir_var_temporary
/**< Temporary variable generated during compilation. */
230 enum ir_variable_interpolation
{
237 class ir_variable
: public ir_instruction
{
239 ir_variable(const struct glsl_type
*, const char *, ir_variable_mode
);
241 virtual ir_variable
*clone(void *mem_ctx
, struct hash_table
*ht
) const;
243 virtual ir_variable
*as_variable()
248 virtual void accept(ir_visitor
*v
)
253 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
257 * Get the string value for the interpolation qualifier
259 * \return The string that would be used in a shader to specify \c
260 * mode will be returned.
262 * This function should only be used on a shader input or output variable.
264 const char *interpolation_string() const;
267 * Calculate the number of slots required to hold this variable
269 * This is used to determine how many uniform or varying locations a variable
270 * occupies. The count is in units of floating point components.
272 unsigned component_slots() const;
275 * Delcared name of the variable
280 * Highest element accessed with a constant expression array index
282 * Not used for non-array variables.
284 unsigned max_array_access
;
287 * Is the variable read-only?
289 * This is set for variables declared as \c const, shader inputs,
292 unsigned read_only
:1;
294 unsigned invariant
:1;
297 * Storage class of the variable.
299 * \sa ir_variable_mode
304 * Interpolation mode for shader inputs / outputs
306 * \sa ir_variable_interpolation
308 unsigned interpolation
:2;
311 * Flag that the whole array is assignable
313 * In GLSL 1.20 and later whole arrays are assignable (and comparable for
314 * equality). This flag enables this behavior.
316 unsigned array_lvalue
:1;
319 * \name ARB_fragment_coord_conventions
322 unsigned origin_upper_left
:1;
323 unsigned pixel_center_integer
:1;
327 * Was the location explicitly set in the shader?
329 * If the location is explicitly set in the shader, it \b cannot be changed
330 * by the linker or by the API (e.g., calls to \c glBindAttribLocation have
333 unsigned explicit_location
:1;
336 * Storage location of the base of this variable
338 * The precise meaning of this field depends on the nature of the variable.
340 * - Vertex shader input: one of the values from \c gl_vert_attrib.
341 * - Vertex shader output: one of the values from \c gl_vert_result.
342 * - Fragment shader input: one of the values from \c gl_frag_attrib.
343 * - Fragment shader output: one of the values from \c gl_frag_result.
344 * - Uniforms: Per-stage uniform slot number.
345 * - Other: This field is not currently used.
347 * If the variable is a uniform, shader input, or shader output, and the
348 * slot has not been assigned, the value will be -1.
353 * Emit a warning if this variable is accessed.
355 const char *warn_extension
;
358 * Value assigned in the initializer of a variable declared "const"
360 ir_constant
*constant_value
;
366 * The representation of a function instance; may be the full definition or
367 * simply a prototype.
369 class ir_function_signature
: public ir_instruction
{
370 /* An ir_function_signature will be part of the list of signatures in
374 ir_function_signature(const glsl_type
*return_type
);
376 virtual ir_function_signature
*clone(void *mem_ctx
,
377 struct hash_table
*ht
) const;
379 virtual void accept(ir_visitor
*v
)
384 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
387 * Get the name of the function for which this is a signature
389 const char *function_name() const;
392 * Get a handle to the function for which this is a signature
394 * There is no setter function, this function returns a \c const pointer,
395 * and \c ir_function_signature::_function is private for a reason. The
396 * only way to make a connection between a function and function signature
397 * is via \c ir_function::add_signature. This helps ensure that certain
398 * invariants (i.e., a function signature is in the list of signatures for
399 * its \c _function) are met.
401 * \sa ir_function::add_signature
403 inline const class ir_function
*function() const
405 return this->_function
;
409 * Check whether the qualifiers match between this signature's parameters
410 * and the supplied parameter list. If not, returns the name of the first
411 * parameter with mismatched qualifiers (for use in error messages).
413 const char *qualifiers_match(exec_list
*params
);
416 * Replace the current parameter list with the given one. This is useful
417 * if the current information came from a prototype, and either has invalid
418 * or missing parameter names.
420 void replace_parameters(exec_list
*new_params
);
423 * Function return type.
425 * \note This discards the optional precision qualifier.
427 const struct glsl_type
*return_type
;
430 * List of ir_variable of function parameters.
432 * This represents the storage. The paramaters passed in a particular
433 * call will be in ir_call::actual_paramaters.
435 struct exec_list parameters
;
437 /** Whether or not this function has a body (which may be empty). */
438 unsigned is_defined
:1;
440 /** Whether or not this function signature is a built-in. */
441 unsigned is_builtin
:1;
443 /** Body of instructions in the function. */
444 struct exec_list body
;
447 /** Function of which this signature is one overload. */
448 class ir_function
*_function
;
450 friend class ir_function
;
455 * Header for tracking multiple overloaded functions with the same name.
456 * Contains a list of ir_function_signatures representing each of the
459 class ir_function
: public ir_instruction
{
461 ir_function(const char *name
);
463 virtual ir_function
*clone(void *mem_ctx
, struct hash_table
*ht
) const;
465 virtual ir_function
*as_function()
470 virtual void accept(ir_visitor
*v
)
475 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
477 void add_signature(ir_function_signature
*sig
)
479 sig
->_function
= this;
480 this->signatures
.push_tail(sig
);
484 * Get an iterator for the set of function signatures
486 exec_list_iterator
iterator()
488 return signatures
.iterator();
492 * Find a signature that matches a set of actual parameters, taking implicit
493 * conversions into account.
495 ir_function_signature
*matching_signature(const exec_list
*actual_param
);
498 * Find a signature that exactly matches a set of actual parameters without
499 * any implicit type conversions.
501 ir_function_signature
*exact_matching_signature(const exec_list
*actual_ps
);
504 * Name of the function.
508 /** Whether or not this function has a signature that isn't a built-in. */
509 bool has_user_signature();
512 * List of ir_function_signature for each overloaded function with this name.
514 struct exec_list signatures
;
517 inline const char *ir_function_signature::function_name() const
519 return this->_function
->name
;
525 * IR instruction representing high-level if-statements
527 class ir_if
: public ir_instruction
{
529 ir_if(ir_rvalue
*condition
)
530 : condition(condition
)
532 ir_type
= ir_type_if
;
535 virtual ir_if
*clone(void *mem_ctx
, struct hash_table
*ht
) const;
537 virtual ir_if
*as_if()
542 virtual void accept(ir_visitor
*v
)
547 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
549 ir_rvalue
*condition
;
550 /** List of ir_instruction for the body of the then branch */
551 exec_list then_instructions
;
552 /** List of ir_instruction for the body of the else branch */
553 exec_list else_instructions
;
558 * IR instruction representing a high-level loop structure.
560 class ir_loop
: public ir_instruction
{
564 virtual ir_loop
*clone(void *mem_ctx
, struct hash_table
*ht
) const;
566 virtual void accept(ir_visitor
*v
)
571 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
573 virtual ir_loop
*as_loop()
579 * Get an iterator for the instructions of the loop body
581 exec_list_iterator
iterator()
583 return body_instructions
.iterator();
586 /** List of ir_instruction that make up the body of the loop. */
587 exec_list body_instructions
;
590 * \name Loop counter and controls
592 * Represents a loop like a FORTRAN \c do-loop.
595 * If \c from and \c to are the same value, the loop will execute once.
598 ir_rvalue
*from
; /** Value of the loop counter on the first
599 * iteration of the loop.
601 ir_rvalue
*to
; /** Value of the loop counter on the last
602 * iteration of the loop.
604 ir_rvalue
*increment
;
605 ir_variable
*counter
;
608 * Comparison operation in the loop terminator.
610 * If any of the loop control fields are non-\c NULL, this field must be
611 * one of \c ir_binop_less, \c ir_binop_greater, \c ir_binop_lequal,
612 * \c ir_binop_gequal, \c ir_binop_equal, or \c ir_binop_nequal.
619 class ir_assignment
: public ir_instruction
{
621 ir_assignment(ir_rvalue
*lhs
, ir_rvalue
*rhs
, ir_rvalue
*condition
);
624 * Construct an assignment with an explicit write mask
627 * Since a write mask is supplied, the LHS must already be a bare
628 * \c ir_dereference. The cannot be any swizzles in the LHS.
630 ir_assignment(ir_dereference
*lhs
, ir_rvalue
*rhs
, ir_rvalue
*condition
,
631 unsigned write_mask
);
633 virtual ir_assignment
*clone(void *mem_ctx
, struct hash_table
*ht
) const;
635 virtual ir_constant
*constant_expression_value();
637 virtual void accept(ir_visitor
*v
)
642 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
644 virtual ir_assignment
* as_assignment()
650 * Get a whole variable written by an assignment
652 * If the LHS of the assignment writes a whole variable, the variable is
653 * returned. Otherwise \c NULL is returned. Examples of whole-variable
656 * - Assigning to a scalar
657 * - Assigning to all components of a vector
658 * - Whole array (or matrix) assignment
659 * - Whole structure assignment
661 ir_variable
*whole_variable_written();
664 * Set the LHS of an assignment
666 void set_lhs(ir_rvalue
*lhs
);
669 * Left-hand side of the assignment.
671 * This should be treated as read only. If you need to set the LHS of an
672 * assignment, use \c ir_assignment::set_lhs.
677 * Value being assigned
682 * Optional condition for the assignment.
684 ir_rvalue
*condition
;
688 * Component mask written
690 * For non-vector types in the LHS, this field will be zero. For vector
691 * types, a bit will be set for each component that is written. Note that
692 * for \c vec2 and \c vec3 types only the lower bits will ever be set.
694 * A partially-set write mask means that each enabled channel gets
695 * the value from a consecutive channel of the rhs. For example,
696 * to write just .xyw of gl_FrontColor with color:
698 * (assign (constant bool (1)) (xyw)
699 * (var_ref gl_FragColor)
700 * (swiz xyw (var_ref color)))
702 unsigned write_mask
:4;
705 /* Update ir_expression::num_operands() and operator_strs when
706 * updating this list.
708 enum ir_expression_operation
{
717 ir_unop_exp
, /**< Log base e on gentype */
718 ir_unop_log
, /**< Natural log on gentype */
721 ir_unop_f2i
, /**< Float-to-integer conversion. */
722 ir_unop_i2f
, /**< Integer-to-float conversion. */
723 ir_unop_f2b
, /**< Float-to-boolean conversion */
724 ir_unop_b2f
, /**< Boolean-to-float conversion */
725 ir_unop_i2b
, /**< int-to-boolean conversion */
726 ir_unop_b2i
, /**< Boolean-to-int conversion */
727 ir_unop_u2f
, /**< Unsigned-to-float conversion. */
731 * \name Unary floating-point rounding operations.
742 * \name Trigonometric operations.
747 ir_unop_sin_reduced
, /**< Reduced range sin. [-pi, pi] */
748 ir_unop_cos_reduced
, /**< Reduced range cos. [-pi, pi] */
752 * \name Partial derivatives.
762 * A sentinel marking the last of the unary operations.
764 ir_last_unop
= ir_unop_noise
,
772 * Takes one of two combinations of arguments:
777 * Does not take integer types.
782 * \name Binary comparison operators which return a boolean vector.
783 * The type of both operands must be equal.
793 * Returns single boolean for whether all components of operands[0]
794 * equal the components of operands[1].
798 * Returns single boolean for whether any component of operands[0]
799 * is not equal to the corresponding component of operands[1].
805 * \name Bit-wise binary operations.
826 * A sentinel marking the last of the binary operations.
828 ir_last_binop
= ir_binop_pow
,
833 * A sentinel marking the last of all operations.
835 ir_last_opcode
= ir_last_binop
838 class ir_expression
: public ir_rvalue
{
841 * Constructor for unary operation expressions
843 ir_expression(int op
, const struct glsl_type
*type
, ir_rvalue
*);
846 * Constructor for binary operation expressions
848 ir_expression(int op
, const struct glsl_type
*type
,
849 ir_rvalue
*, ir_rvalue
*);
852 * Constructor for quad operator expressions
854 ir_expression(int op
, const struct glsl_type
*type
,
855 ir_rvalue
*, ir_rvalue
*, ir_rvalue
*, ir_rvalue
*);
857 virtual ir_expression
*as_expression()
862 virtual ir_expression
*clone(void *mem_ctx
, struct hash_table
*ht
) const;
865 * Attempt to constant-fold the expression
867 * If the expression cannot be constant folded, this method will return
870 virtual ir_constant
*constant_expression_value();
873 * Determine the number of operands used by an expression
875 static unsigned int get_num_operands(ir_expression_operation
);
878 * Determine the number of operands used by an expression
880 unsigned int get_num_operands() const
882 return (this->operation
== ir_quadop_vector
)
883 ? this->type
->vector_elements
: get_num_operands(operation
);
887 * Return a string representing this expression's operator.
889 const char *operator_string();
892 * Return a string representing this expression's operator.
894 static const char *operator_string(ir_expression_operation
);
898 * Do a reverse-lookup to translate the given string into an operator.
900 static ir_expression_operation
get_operator(const char *);
902 virtual void accept(ir_visitor
*v
)
907 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
909 ir_expression_operation operation
;
910 ir_rvalue
*operands
[4];
915 * IR instruction representing a function call
917 class ir_call
: public ir_rvalue
{
919 ir_call(ir_function_signature
*callee
, exec_list
*actual_parameters
)
922 ir_type
= ir_type_call
;
923 assert(callee
->return_type
!= NULL
);
924 type
= callee
->return_type
;
925 actual_parameters
->move_nodes_to(& this->actual_parameters
);
928 virtual ir_call
*clone(void *mem_ctx
, struct hash_table
*ht
) const;
930 virtual ir_constant
*constant_expression_value();
932 virtual ir_call
*as_call()
937 virtual void accept(ir_visitor
*v
)
942 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
945 * Get a generic ir_call object when an error occurs
947 * Any allocation will be performed with 'ctx' as talloc owner.
949 static ir_call
*get_error_instruction(void *ctx
);
952 * Get an iterator for the set of acutal parameters
954 exec_list_iterator
iterator()
956 return actual_parameters
.iterator();
960 * Get the name of the function being called.
962 const char *callee_name() const
964 return callee
->function_name();
968 * Get the function signature bound to this function call
970 ir_function_signature
*get_callee()
976 * Set the function call target
978 void set_callee(ir_function_signature
*sig
);
981 * Generates an inline version of the function before @ir,
982 * returning the return value of the function.
984 ir_rvalue
*generate_inline(ir_instruction
*ir
);
986 /* List of ir_rvalue of paramaters passed in this call. */
987 exec_list actual_parameters
;
993 this->ir_type
= ir_type_call
;
996 ir_function_signature
*callee
;
1001 * \name Jump-like IR instructions.
1003 * These include \c break, \c continue, \c return, and \c discard.
1006 class ir_jump
: public ir_instruction
{
1010 ir_type
= ir_type_unset
;
1014 class ir_return
: public ir_jump
{
1019 this->ir_type
= ir_type_return
;
1022 ir_return(ir_rvalue
*value
)
1025 this->ir_type
= ir_type_return
;
1028 virtual ir_return
*clone(void *mem_ctx
, struct hash_table
*) const;
1030 virtual ir_return
*as_return()
1035 ir_rvalue
*get_value() const
1040 virtual void accept(ir_visitor
*v
)
1045 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1052 * Jump instructions used inside loops
1054 * These include \c break and \c continue. The \c break within a loop is
1055 * different from the \c break within a switch-statement.
1057 * \sa ir_switch_jump
1059 class ir_loop_jump
: public ir_jump
{
1066 ir_loop_jump(jump_mode mode
)
1068 this->ir_type
= ir_type_loop_jump
;
1073 virtual ir_loop_jump
*clone(void *mem_ctx
, struct hash_table
*) const;
1075 virtual void accept(ir_visitor
*v
)
1080 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1082 bool is_break() const
1084 return mode
== jump_break
;
1087 bool is_continue() const
1089 return mode
== jump_continue
;
1092 /** Mode selector for the jump instruction. */
1093 enum jump_mode mode
;
1095 /** Loop containing this break instruction. */
1100 * IR instruction representing discard statements.
1102 class ir_discard
: public ir_jump
{
1106 this->ir_type
= ir_type_discard
;
1107 this->condition
= NULL
;
1110 ir_discard(ir_rvalue
*cond
)
1112 this->ir_type
= ir_type_discard
;
1113 this->condition
= cond
;
1116 virtual ir_discard
*clone(void *mem_ctx
, struct hash_table
*ht
) const;
1118 virtual void accept(ir_visitor
*v
)
1123 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1125 ir_rvalue
*condition
;
1131 * Texture sampling opcodes used in ir_texture
1133 enum ir_texture_opcode
{
1134 ir_tex
, /**< Regular texture look-up */
1135 ir_txb
, /**< Texture look-up with LOD bias */
1136 ir_txl
, /**< Texture look-up with explicit LOD */
1137 ir_txd
, /**< Texture look-up with partial derivatvies */
1138 ir_txf
/**< Texel fetch with explicit LOD */
1143 * IR instruction to sample a texture
1145 * The specific form of the IR instruction depends on the \c mode value
1146 * selected from \c ir_texture_opcodes. In the printed IR, these will
1150 * | Projection divisor
1151 * | | Shadow comparitor
1154 * (tex (sampler) (coordinate) (0 0 0) (1) ( ))
1155 * (txb (sampler) (coordinate) (0 0 0) (1) ( ) (bias))
1156 * (txl (sampler) (coordinate) (0 0 0) (1) ( ) (lod))
1157 * (txd (sampler) (coordinate) (0 0 0) (1) ( ) (dPdx dPdy))
1158 * (txf (sampler) (coordinate) (0 0 0) (lod))
1160 class ir_texture
: public ir_rvalue
{
1162 ir_texture(enum ir_texture_opcode op
)
1163 : op(op
), projector(NULL
), shadow_comparitor(NULL
)
1165 this->ir_type
= ir_type_texture
;
1168 virtual ir_texture
*clone(void *mem_ctx
, struct hash_table
*) const;
1170 virtual ir_constant
*constant_expression_value();
1172 virtual void accept(ir_visitor
*v
)
1177 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1180 * Return a string representing the ir_texture_opcode.
1182 const char *opcode_string();
1184 /** Set the sampler and infer the type. */
1185 void set_sampler(ir_dereference
*sampler
);
1188 * Do a reverse-lookup to translate a string into an ir_texture_opcode.
1190 static ir_texture_opcode
get_opcode(const char *);
1192 enum ir_texture_opcode op
;
1194 /** Sampler to use for the texture access. */
1195 ir_dereference
*sampler
;
1197 /** Texture coordinate to sample */
1198 ir_rvalue
*coordinate
;
1201 * Value used for projective divide.
1203 * If there is no projective divide (the common case), this will be
1204 * \c NULL. Optimization passes should check for this to point to a constant
1205 * of 1.0 and replace that with \c NULL.
1207 ir_rvalue
*projector
;
1210 * Coordinate used for comparison on shadow look-ups.
1212 * If there is no shadow comparison, this will be \c NULL. For the
1213 * \c ir_txf opcode, this *must* be \c NULL.
1215 ir_rvalue
*shadow_comparitor
;
1217 /** Explicit texel offsets. */
1218 signed char offsets
[3];
1221 ir_rvalue
*lod
; /**< Floating point LOD */
1222 ir_rvalue
*bias
; /**< Floating point LOD bias */
1224 ir_rvalue
*dPdx
; /**< Partial derivative of coordinate wrt X */
1225 ir_rvalue
*dPdy
; /**< Partial derivative of coordinate wrt Y */
1231 struct ir_swizzle_mask
{
1238 * Number of components in the swizzle.
1240 unsigned num_components
:3;
1243 * Does the swizzle contain duplicate components?
1245 * L-value swizzles cannot contain duplicate components.
1247 unsigned has_duplicates
:1;
1251 class ir_swizzle
: public ir_rvalue
{
1253 ir_swizzle(ir_rvalue
*, unsigned x
, unsigned y
, unsigned z
, unsigned w
,
1256 ir_swizzle(ir_rvalue
*val
, const unsigned *components
, unsigned count
);
1258 ir_swizzle(ir_rvalue
*val
, ir_swizzle_mask mask
);
1260 virtual ir_swizzle
*clone(void *mem_ctx
, struct hash_table
*) const;
1262 virtual ir_constant
*constant_expression_value();
1264 virtual ir_swizzle
*as_swizzle()
1270 * Construct an ir_swizzle from the textual representation. Can fail.
1272 static ir_swizzle
*create(ir_rvalue
*, const char *, unsigned vector_length
);
1274 virtual void accept(ir_visitor
*v
)
1279 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1283 return val
->is_lvalue() && !mask
.has_duplicates
;
1287 * Get the variable that is ultimately referenced by an r-value
1289 virtual ir_variable
*variable_referenced();
1292 ir_swizzle_mask mask
;
1296 * Initialize the mask component of a swizzle
1298 * This is used by the \c ir_swizzle constructors.
1300 void init_mask(const unsigned *components
, unsigned count
);
1304 class ir_dereference
: public ir_rvalue
{
1306 virtual ir_dereference
*clone(void *mem_ctx
, struct hash_table
*) const = 0;
1308 virtual ir_dereference
*as_dereference()
1316 * Get the variable that is ultimately referenced by an r-value
1318 virtual ir_variable
*variable_referenced() = 0;
1322 class ir_dereference_variable
: public ir_dereference
{
1324 ir_dereference_variable(ir_variable
*var
);
1326 virtual ir_dereference_variable
*clone(void *mem_ctx
,
1327 struct hash_table
*) const;
1329 virtual ir_constant
*constant_expression_value();
1331 virtual ir_dereference_variable
*as_dereference_variable()
1337 * Get the variable that is ultimately referenced by an r-value
1339 virtual ir_variable
*variable_referenced()
1344 virtual ir_variable
*whole_variable_referenced()
1346 /* ir_dereference_variable objects always dereference the entire
1347 * variable. However, if this dereference is dereferenced by anything
1348 * else, the complete deferefernce chain is not a whole-variable
1349 * dereference. This method should only be called on the top most
1350 * ir_rvalue in a dereference chain.
1355 virtual void accept(ir_visitor
*v
)
1360 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1363 * Object being dereferenced.
1369 class ir_dereference_array
: public ir_dereference
{
1371 ir_dereference_array(ir_rvalue
*value
, ir_rvalue
*array_index
);
1373 ir_dereference_array(ir_variable
*var
, ir_rvalue
*array_index
);
1375 virtual ir_dereference_array
*clone(void *mem_ctx
,
1376 struct hash_table
*) const;
1378 virtual ir_constant
*constant_expression_value();
1380 virtual ir_dereference_array
*as_dereference_array()
1386 * Get the variable that is ultimately referenced by an r-value
1388 virtual ir_variable
*variable_referenced()
1390 return this->array
->variable_referenced();
1393 virtual void accept(ir_visitor
*v
)
1398 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1401 ir_rvalue
*array_index
;
1404 void set_array(ir_rvalue
*value
);
1408 class ir_dereference_record
: public ir_dereference
{
1410 ir_dereference_record(ir_rvalue
*value
, const char *field
);
1412 ir_dereference_record(ir_variable
*var
, const char *field
);
1414 virtual ir_dereference_record
*clone(void *mem_ctx
,
1415 struct hash_table
*) const;
1417 virtual ir_constant
*constant_expression_value();
1420 * Get the variable that is ultimately referenced by an r-value
1422 virtual ir_variable
*variable_referenced()
1424 return this->record
->variable_referenced();
1427 virtual void accept(ir_visitor
*v
)
1432 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1440 * Data stored in an ir_constant
1442 union ir_constant_data
{
1450 class ir_constant
: public ir_rvalue
{
1452 ir_constant(const struct glsl_type
*type
, const ir_constant_data
*data
);
1453 ir_constant(bool b
);
1454 ir_constant(unsigned int u
);
1456 ir_constant(float f
);
1459 * Construct an ir_constant from a list of ir_constant values
1461 ir_constant(const struct glsl_type
*type
, exec_list
*values
);
1464 * Construct an ir_constant from a scalar component of another ir_constant
1466 * The new \c ir_constant inherits the type of the component from the
1470 * In the case of a matrix constant, the new constant is a scalar, \b not
1473 ir_constant(const ir_constant
*c
, unsigned i
);
1476 * Return a new ir_constant of the specified type containing all zeros.
1478 static ir_constant
*zero(void *mem_ctx
, const glsl_type
*type
);
1480 virtual ir_constant
*clone(void *mem_ctx
, struct hash_table
*) const;
1482 virtual ir_constant
*constant_expression_value();
1484 virtual ir_constant
*as_constant()
1489 virtual void accept(ir_visitor
*v
)
1494 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1497 * Get a particular component of a constant as a specific type
1499 * This is useful, for example, to get a value from an integer constant
1500 * as a float or bool. This appears frequently when constructors are
1501 * called with all constant parameters.
1504 bool get_bool_component(unsigned i
) const;
1505 float get_float_component(unsigned i
) const;
1506 int get_int_component(unsigned i
) const;
1507 unsigned get_uint_component(unsigned i
) const;
1510 ir_constant
*get_array_element(unsigned i
) const;
1512 ir_constant
*get_record_field(const char *name
);
1515 * Determine whether a constant has the same value as another constant
1517 * \sa ir_constant::is_zero, ir_constant::is_one,
1518 * ir_constant::is_negative_one
1520 bool has_value(const ir_constant
*) const;
1522 virtual bool is_zero() const;
1523 virtual bool is_one() const;
1524 virtual bool is_negative_one() const;
1527 * Value of the constant.
1529 * The field used to back the values supplied by the constant is determined
1530 * by the type associated with the \c ir_instruction. Constants may be
1531 * scalars, vectors, or matrices.
1533 union ir_constant_data value
;
1535 /* Array elements */
1536 ir_constant
**array_elements
;
1538 /* Structure fields */
1539 exec_list components
;
1543 * Parameterless constructor only used by the clone method
1551 * Apply a visitor to each IR node in a list
1554 visit_exec_list(exec_list
*list
, ir_visitor
*visitor
);
1557 * Validate invariants on each IR node in a list
1559 void validate_ir_tree(exec_list
*instructions
);
1562 * Make a clone of each IR instruction in a list
1564 * \param in List of IR instructions that are to be cloned
1565 * \param out List to hold the cloned instructions
1568 clone_ir_list(void *mem_ctx
, exec_list
*out
, const exec_list
*in
);
1571 _mesa_glsl_initialize_variables(exec_list
*instructions
,
1572 struct _mesa_glsl_parse_state
*state
);
1575 _mesa_glsl_initialize_functions(exec_list
*instructions
,
1576 struct _mesa_glsl_parse_state
*state
);
1579 _mesa_glsl_release_functions(void);
1582 reparent_ir(exec_list
*list
, void *mem_ctx
);
1584 struct glsl_symbol_table
;
1587 import_prototypes(const exec_list
*source
, exec_list
*dest
,
1588 struct glsl_symbol_table
*symbols
, void *mem_ctx
);
1591 ir_has_call(ir_instruction
*ir
);
1594 do_set_program_inouts(exec_list
*instructions
, struct gl_program
*prog
);