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.
33 #include "glsl_types.h"
35 #include "ir_visitor.h"
36 #include "ir_hierarchical_visitor.h"
37 #include "main/mtypes.h"
40 * \defgroup IR Intermediate representation nodes
48 * Each concrete class derived from \c ir_instruction has a value in this
49 * enumerant. The value for the type is stored in \c ir_instruction::ir_type
50 * by the constructor. While using type tags is not very C++, it is extremely
51 * convenient. For example, during debugging you can simply inspect
52 * \c ir_instruction::ir_type to find out the actual type of the object.
54 * In addition, it is possible to use a switch-statement based on \c
55 * \c ir_instruction::ir_type to select different behavior for different object
56 * types. For functions that have only slight differences for several object
57 * types, this allows writing very straightforward, readable code.
61 * Zero is unused so that the IR validator can detect cases where
62 * \c ir_instruction::ir_type has not been initialized.
69 ir_type_dereference_array
,
70 ir_type_dereference_record
,
71 ir_type_dereference_variable
,
75 ir_type_function_signature
,
82 ir_type_max
/**< maximum ir_type enum number, for validation */
86 * Base class of all IR instructions
88 class ir_instruction
: public exec_node
{
90 enum ir_node_type ir_type
;
91 const struct glsl_type
*type
;
93 /** ir_print_visitor helper for debugging. */
94 void print(void) const;
96 virtual void accept(ir_visitor
*) = 0;
97 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*) = 0;
98 virtual ir_instruction
*clone(void *mem_ctx
,
99 struct hash_table
*ht
) const = 0;
102 * \name IR instruction downcast functions
104 * These functions either cast the object to a derived class or return
105 * \c NULL if the object's type does not match the specified derived class.
106 * Additional downcast functions will be added as needed.
109 virtual class ir_variable
* as_variable() { return NULL
; }
110 virtual class ir_function
* as_function() { return NULL
; }
111 virtual class ir_dereference
* as_dereference() { return NULL
; }
112 virtual class ir_dereference_array
* as_dereference_array() { return NULL
; }
113 virtual class ir_dereference_variable
*as_dereference_variable() { return NULL
; }
114 virtual class ir_expression
* as_expression() { return NULL
; }
115 virtual class ir_rvalue
* as_rvalue() { return NULL
; }
116 virtual class ir_loop
* as_loop() { return NULL
; }
117 virtual class ir_assignment
* as_assignment() { return NULL
; }
118 virtual class ir_call
* as_call() { return NULL
; }
119 virtual class ir_return
* as_return() { return NULL
; }
120 virtual class ir_if
* as_if() { return NULL
; }
121 virtual class ir_swizzle
* as_swizzle() { return NULL
; }
122 virtual class ir_constant
* as_constant() { return NULL
; }
123 virtual class ir_discard
* as_discard() { return NULL
; }
129 ir_type
= ir_type_unset
;
135 class ir_rvalue
: public ir_instruction
{
137 virtual ir_rvalue
*clone(void *mem_ctx
, struct hash_table
*) const = 0;
139 virtual ir_constant
*constant_expression_value() = 0;
141 virtual ir_rvalue
* as_rvalue()
146 ir_rvalue
*as_rvalue_to_saturate();
148 virtual bool is_lvalue() const
154 * Get the variable that is ultimately referenced by an r-value
156 virtual ir_variable
*variable_referenced() const
163 * If an r-value is a reference to a whole variable, get that variable
166 * Pointer to a variable that is completely dereferenced by the r-value. If
167 * the r-value is not a dereference or the dereference does not access the
168 * entire variable (i.e., it's just one array element, struct field), \c NULL
171 virtual ir_variable
*whole_variable_referenced()
177 * Determine if an r-value has the value zero
179 * The base implementation of this function always returns \c false. The
180 * \c ir_constant class over-rides this function to return \c true \b only
181 * for vector and scalar types that have all elements set to the value
182 * zero (or \c false for booleans).
184 * \sa ir_constant::has_value, ir_rvalue::is_one, ir_rvalue::is_negative_one
186 virtual bool is_zero() const;
189 * Determine if an r-value has the value one
191 * The base implementation of this function always returns \c false. The
192 * \c ir_constant class over-rides this function to return \c true \b only
193 * for vector and scalar types that have all elements set to the value
194 * one (or \c true for booleans).
196 * \sa ir_constant::has_value, ir_rvalue::is_zero, ir_rvalue::is_negative_one
198 virtual bool is_one() const;
201 * Determine if an r-value has the value negative one
203 * The base implementation of this function always returns \c false. The
204 * \c ir_constant class over-rides this function to return \c true \b only
205 * for vector and scalar types that have all elements set to the value
206 * negative one. For boolean times, the result is always \c false.
208 * \sa ir_constant::has_value, ir_rvalue::is_zero, ir_rvalue::is_one
210 virtual bool is_negative_one() const;
218 * Variable storage classes
220 enum ir_variable_mode
{
221 ir_var_auto
= 0, /**< Function local variables and globals. */
222 ir_var_uniform
, /**< Variable declared as a uniform. */
226 ir_var_const_in
, /**< "in" param that must be a constant expression */
227 ir_var_system_value
, /**< Ex: front-face, instance-id, etc. */
228 ir_var_temporary
/**< Temporary variable generated during compilation. */
232 * \brief Layout qualifiers for gl_FragDepth.
234 * The AMD/ARB_conservative_depth extensions allow gl_FragDepth to be redeclared
235 * with a layout qualifier.
237 enum ir_depth_layout
{
238 ir_depth_layout_none
, /**< No depth layout is specified. */
240 ir_depth_layout_greater
,
241 ir_depth_layout_less
,
242 ir_depth_layout_unchanged
246 * \brief Convert depth layout qualifier to string.
249 depth_layout_string(ir_depth_layout layout
);
252 * Description of built-in state associated with a uniform
254 * \sa ir_variable::state_slots
256 struct ir_state_slot
{
261 class ir_variable
: public ir_instruction
{
263 ir_variable(const struct glsl_type
*, const char *, ir_variable_mode
);
265 virtual ir_variable
*clone(void *mem_ctx
, struct hash_table
*ht
) const;
267 virtual ir_variable
*as_variable()
272 virtual void accept(ir_visitor
*v
)
277 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
281 * Get the string value for the interpolation qualifier
283 * \return The string that would be used in a shader to specify \c
284 * mode will be returned.
286 * This function should only be used on a shader input or output variable.
288 const char *interpolation_string() const;
291 * Delcared name of the variable
296 * Highest element accessed with a constant expression array index
298 * Not used for non-array variables.
300 unsigned max_array_access
;
303 * Is the variable read-only?
305 * This is set for variables declared as \c const, shader inputs,
308 unsigned read_only
:1;
310 unsigned invariant
:1;
313 * Has this variable been used for reading or writing?
315 * Several GLSL semantic checks require knowledge of whether or not a
316 * variable has been used. For example, it is an error to redeclare a
317 * variable as invariant after it has been used.
322 * Storage class of the variable.
324 * \sa ir_variable_mode
329 * Interpolation mode for shader inputs / outputs
331 * \sa ir_variable_interpolation
333 unsigned interpolation
:2;
336 * \name ARB_fragment_coord_conventions
339 unsigned origin_upper_left
:1;
340 unsigned pixel_center_integer
:1;
344 * \brief Layout qualifier for gl_FragDepth.
346 * This is not equal to \c ir_depth_layout_none if and only if this
347 * variable is \c gl_FragDepth and a layout qualifier is specified.
349 ir_depth_layout depth_layout
;
352 * Was the location explicitly set in the shader?
354 * If the location is explicitly set in the shader, it \b cannot be changed
355 * by the linker or by the API (e.g., calls to \c glBindAttribLocation have
358 unsigned explicit_location
:1;
361 * Storage location of the base of this variable
363 * The precise meaning of this field depends on the nature of the variable.
365 * - Vertex shader input: one of the values from \c gl_vert_attrib.
366 * - Vertex shader output: one of the values from \c gl_vert_result.
367 * - Fragment shader input: one of the values from \c gl_frag_attrib.
368 * - Fragment shader output: one of the values from \c gl_frag_result.
369 * - Uniforms: Per-stage uniform slot number.
370 * - Other: This field is not currently used.
372 * If the variable is a uniform, shader input, or shader output, and the
373 * slot has not been assigned, the value will be -1.
378 * Built-in state that backs this uniform
380 * Once set at variable creation, \c state_slots must remain invariant.
381 * This is because, ideally, this array would be shared by all clones of
382 * this variable in the IR tree. In other words, we'd really like for it
383 * to be a fly-weight.
385 * If the variable is not a uniform, \c num_state_slots will be zero and
386 * \c state_slots will be \c NULL.
389 unsigned num_state_slots
; /**< Number of state slots used */
390 ir_state_slot
*state_slots
; /**< State descriptors. */
394 * Emit a warning if this variable is accessed.
396 const char *warn_extension
;
399 * Value assigned in the initializer of a variable declared "const"
401 ir_constant
*constant_value
;
407 * The representation of a function instance; may be the full definition or
408 * simply a prototype.
410 class ir_function_signature
: public ir_instruction
{
411 /* An ir_function_signature will be part of the list of signatures in
415 ir_function_signature(const glsl_type
*return_type
);
417 virtual ir_function_signature
*clone(void *mem_ctx
,
418 struct hash_table
*ht
) const;
419 ir_function_signature
*clone_prototype(void *mem_ctx
,
420 struct hash_table
*ht
) const;
422 virtual void accept(ir_visitor
*v
)
427 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
430 * Get the name of the function for which this is a signature
432 const char *function_name() const;
435 * Get a handle to the function for which this is a signature
437 * There is no setter function, this function returns a \c const pointer,
438 * and \c ir_function_signature::_function is private for a reason. The
439 * only way to make a connection between a function and function signature
440 * is via \c ir_function::add_signature. This helps ensure that certain
441 * invariants (i.e., a function signature is in the list of signatures for
442 * its \c _function) are met.
444 * \sa ir_function::add_signature
446 inline const class ir_function
*function() const
448 return this->_function
;
452 * Check whether the qualifiers match between this signature's parameters
453 * and the supplied parameter list. If not, returns the name of the first
454 * parameter with mismatched qualifiers (for use in error messages).
456 const char *qualifiers_match(exec_list
*params
);
459 * Replace the current parameter list with the given one. This is useful
460 * if the current information came from a prototype, and either has invalid
461 * or missing parameter names.
463 void replace_parameters(exec_list
*new_params
);
466 * Function return type.
468 * \note This discards the optional precision qualifier.
470 const struct glsl_type
*return_type
;
473 * List of ir_variable of function parameters.
475 * This represents the storage. The paramaters passed in a particular
476 * call will be in ir_call::actual_paramaters.
478 struct exec_list parameters
;
480 /** Whether or not this function has a body (which may be empty). */
481 unsigned is_defined
:1;
483 /** Whether or not this function signature is a built-in. */
484 unsigned is_builtin
:1;
486 /** Body of instructions in the function. */
487 struct exec_list body
;
490 /** Function of which this signature is one overload. */
491 class ir_function
*_function
;
493 friend class ir_function
;
498 * Header for tracking multiple overloaded functions with the same name.
499 * Contains a list of ir_function_signatures representing each of the
502 class ir_function
: public ir_instruction
{
504 ir_function(const char *name
);
506 virtual ir_function
*clone(void *mem_ctx
, struct hash_table
*ht
) const;
508 virtual ir_function
*as_function()
513 virtual void accept(ir_visitor
*v
)
518 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
520 void add_signature(ir_function_signature
*sig
)
522 sig
->_function
= this;
523 this->signatures
.push_tail(sig
);
527 * Get an iterator for the set of function signatures
529 exec_list_iterator
iterator()
531 return signatures
.iterator();
535 * Find a signature that matches a set of actual parameters, taking implicit
536 * conversions into account.
538 ir_function_signature
*matching_signature(const exec_list
*actual_param
);
541 * Find a signature that exactly matches a set of actual parameters without
542 * any implicit type conversions.
544 ir_function_signature
*exact_matching_signature(const exec_list
*actual_ps
);
547 * Name of the function.
551 /** Whether or not this function has a signature that isn't a built-in. */
552 bool has_user_signature();
555 * List of ir_function_signature for each overloaded function with this name.
557 struct exec_list signatures
;
560 inline const char *ir_function_signature::function_name() const
562 return this->_function
->name
;
568 * IR instruction representing high-level if-statements
570 class ir_if
: public ir_instruction
{
572 ir_if(ir_rvalue
*condition
)
573 : condition(condition
)
575 ir_type
= ir_type_if
;
578 virtual ir_if
*clone(void *mem_ctx
, struct hash_table
*ht
) const;
580 virtual ir_if
*as_if()
585 virtual void accept(ir_visitor
*v
)
590 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
592 ir_rvalue
*condition
;
593 /** List of ir_instruction for the body of the then branch */
594 exec_list then_instructions
;
595 /** List of ir_instruction for the body of the else branch */
596 exec_list else_instructions
;
601 * IR instruction representing a high-level loop structure.
603 class ir_loop
: public ir_instruction
{
607 virtual ir_loop
*clone(void *mem_ctx
, struct hash_table
*ht
) const;
609 virtual void accept(ir_visitor
*v
)
614 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
616 virtual ir_loop
*as_loop()
622 * Get an iterator for the instructions of the loop body
624 exec_list_iterator
iterator()
626 return body_instructions
.iterator();
629 /** List of ir_instruction that make up the body of the loop. */
630 exec_list body_instructions
;
633 * \name Loop counter and controls
635 * Represents a loop like a FORTRAN \c do-loop.
638 * If \c from and \c to are the same value, the loop will execute once.
641 ir_rvalue
*from
; /** Value of the loop counter on the first
642 * iteration of the loop.
644 ir_rvalue
*to
; /** Value of the loop counter on the last
645 * iteration of the loop.
647 ir_rvalue
*increment
;
648 ir_variable
*counter
;
651 * Comparison operation in the loop terminator.
653 * If any of the loop control fields are non-\c NULL, this field must be
654 * one of \c ir_binop_less, \c ir_binop_greater, \c ir_binop_lequal,
655 * \c ir_binop_gequal, \c ir_binop_equal, or \c ir_binop_nequal.
662 class ir_assignment
: public ir_instruction
{
664 ir_assignment(ir_rvalue
*lhs
, ir_rvalue
*rhs
, ir_rvalue
*condition
= NULL
);
667 * Construct an assignment with an explicit write mask
670 * Since a write mask is supplied, the LHS must already be a bare
671 * \c ir_dereference. The cannot be any swizzles in the LHS.
673 ir_assignment(ir_dereference
*lhs
, ir_rvalue
*rhs
, ir_rvalue
*condition
,
674 unsigned write_mask
);
676 virtual ir_assignment
*clone(void *mem_ctx
, struct hash_table
*ht
) const;
678 virtual ir_constant
*constant_expression_value();
680 virtual void accept(ir_visitor
*v
)
685 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
687 virtual ir_assignment
* as_assignment()
693 * Get a whole variable written by an assignment
695 * If the LHS of the assignment writes a whole variable, the variable is
696 * returned. Otherwise \c NULL is returned. Examples of whole-variable
699 * - Assigning to a scalar
700 * - Assigning to all components of a vector
701 * - Whole array (or matrix) assignment
702 * - Whole structure assignment
704 ir_variable
*whole_variable_written();
707 * Set the LHS of an assignment
709 void set_lhs(ir_rvalue
*lhs
);
712 * Left-hand side of the assignment.
714 * This should be treated as read only. If you need to set the LHS of an
715 * assignment, use \c ir_assignment::set_lhs.
720 * Value being assigned
725 * Optional condition for the assignment.
727 ir_rvalue
*condition
;
731 * Component mask written
733 * For non-vector types in the LHS, this field will be zero. For vector
734 * types, a bit will be set for each component that is written. Note that
735 * for \c vec2 and \c vec3 types only the lower bits will ever be set.
737 * A partially-set write mask means that each enabled channel gets
738 * the value from a consecutive channel of the rhs. For example,
739 * to write just .xyw of gl_FrontColor with color:
741 * (assign (constant bool (1)) (xyw)
742 * (var_ref gl_FragColor)
743 * (swiz xyw (var_ref color)))
745 unsigned write_mask
:4;
748 /* Update ir_expression::num_operands() and operator_strs when
749 * updating this list.
751 enum ir_expression_operation
{
760 ir_unop_exp
, /**< Log base e on gentype */
761 ir_unop_log
, /**< Natural log on gentype */
764 ir_unop_f2i
, /**< Float-to-integer conversion. */
765 ir_unop_i2f
, /**< Integer-to-float conversion. */
766 ir_unop_f2b
, /**< Float-to-boolean conversion */
767 ir_unop_b2f
, /**< Boolean-to-float conversion */
768 ir_unop_i2b
, /**< int-to-boolean conversion */
769 ir_unop_b2i
, /**< Boolean-to-int conversion */
770 ir_unop_u2f
, /**< Unsigned-to-float conversion. */
771 ir_unop_i2u
, /**< Integer-to-unsigned conversion. */
772 ir_unop_u2i
, /**< Unsigned-to-integer conversion. */
776 * \name Unary floating-point rounding operations.
787 * \name Trigonometric operations.
792 ir_unop_sin_reduced
, /**< Reduced range sin. [-pi, pi] */
793 ir_unop_cos_reduced
, /**< Reduced range cos. [-pi, pi] */
797 * \name Partial derivatives.
807 * A sentinel marking the last of the unary operations.
809 ir_last_unop
= ir_unop_noise
,
817 * Takes one of two combinations of arguments:
822 * Does not take integer types.
827 * \name Binary comparison operators which return a boolean vector.
828 * The type of both operands must be equal.
838 * Returns single boolean for whether all components of operands[0]
839 * equal the components of operands[1].
843 * Returns single boolean for whether any component of operands[0]
844 * is not equal to the corresponding component of operands[1].
850 * \name Bit-wise binary operations.
871 * A sentinel marking the last of the binary operations.
873 ir_last_binop
= ir_binop_pow
,
878 * A sentinel marking the last of all operations.
880 ir_last_opcode
= ir_last_binop
883 class ir_expression
: public ir_rvalue
{
886 * Constructor for unary operation expressions
888 ir_expression(int op
, const struct glsl_type
*type
, ir_rvalue
*);
889 ir_expression(int op
, ir_rvalue
*);
892 * Constructor for binary operation expressions
894 ir_expression(int op
, const struct glsl_type
*type
,
895 ir_rvalue
*, ir_rvalue
*);
896 ir_expression(int op
, ir_rvalue
*op0
, ir_rvalue
*op1
);
899 * Constructor for quad operator expressions
901 ir_expression(int op
, const struct glsl_type
*type
,
902 ir_rvalue
*, ir_rvalue
*, ir_rvalue
*, ir_rvalue
*);
904 virtual ir_expression
*as_expression()
909 virtual ir_expression
*clone(void *mem_ctx
, struct hash_table
*ht
) const;
912 * Attempt to constant-fold the expression
914 * If the expression cannot be constant folded, this method will return
917 virtual ir_constant
*constant_expression_value();
920 * Determine the number of operands used by an expression
922 static unsigned int get_num_operands(ir_expression_operation
);
925 * Determine the number of operands used by an expression
927 unsigned int get_num_operands() const
929 return (this->operation
== ir_quadop_vector
)
930 ? this->type
->vector_elements
: get_num_operands(operation
);
934 * Return a string representing this expression's operator.
936 const char *operator_string();
939 * Return a string representing this expression's operator.
941 static const char *operator_string(ir_expression_operation
);
945 * Do a reverse-lookup to translate the given string into an operator.
947 static ir_expression_operation
get_operator(const char *);
949 virtual void accept(ir_visitor
*v
)
954 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
956 ir_expression_operation operation
;
957 ir_rvalue
*operands
[4];
962 * IR instruction representing a function call
964 class ir_call
: public ir_rvalue
{
966 ir_call(ir_function_signature
*callee
, exec_list
*actual_parameters
)
969 ir_type
= ir_type_call
;
970 assert(callee
->return_type
!= NULL
);
971 type
= callee
->return_type
;
972 actual_parameters
->move_nodes_to(& this->actual_parameters
);
973 this->use_builtin
= callee
->is_builtin
;
976 virtual ir_call
*clone(void *mem_ctx
, struct hash_table
*ht
) const;
978 virtual ir_constant
*constant_expression_value();
980 virtual ir_call
*as_call()
985 virtual void accept(ir_visitor
*v
)
990 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
993 * Get a generic ir_call object when an error occurs
995 * Any allocation will be performed with 'ctx' as ralloc owner.
997 static ir_call
*get_error_instruction(void *ctx
);
1000 * Get an iterator for the set of acutal parameters
1002 exec_list_iterator
iterator()
1004 return actual_parameters
.iterator();
1008 * Get the name of the function being called.
1010 const char *callee_name() const
1012 return callee
->function_name();
1016 * Get the function signature bound to this function call
1018 ir_function_signature
*get_callee()
1024 * Set the function call target
1026 void set_callee(ir_function_signature
*sig
);
1029 * Generates an inline version of the function before @ir,
1030 * returning the return value of the function.
1032 ir_rvalue
*generate_inline(ir_instruction
*ir
);
1034 /* List of ir_rvalue of paramaters passed in this call. */
1035 exec_list actual_parameters
;
1037 /** Should this call only bind to a built-in function? */
1044 this->ir_type
= ir_type_call
;
1047 ir_function_signature
*callee
;
1052 * \name Jump-like IR instructions.
1054 * These include \c break, \c continue, \c return, and \c discard.
1057 class ir_jump
: public ir_instruction
{
1061 ir_type
= ir_type_unset
;
1065 class ir_return
: public ir_jump
{
1070 this->ir_type
= ir_type_return
;
1073 ir_return(ir_rvalue
*value
)
1076 this->ir_type
= ir_type_return
;
1079 virtual ir_return
*clone(void *mem_ctx
, struct hash_table
*) const;
1081 virtual ir_return
*as_return()
1086 ir_rvalue
*get_value() const
1091 virtual void accept(ir_visitor
*v
)
1096 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1103 * Jump instructions used inside loops
1105 * These include \c break and \c continue. The \c break within a loop is
1106 * different from the \c break within a switch-statement.
1108 * \sa ir_switch_jump
1110 class ir_loop_jump
: public ir_jump
{
1117 ir_loop_jump(jump_mode mode
)
1119 this->ir_type
= ir_type_loop_jump
;
1124 virtual ir_loop_jump
*clone(void *mem_ctx
, struct hash_table
*) const;
1126 virtual void accept(ir_visitor
*v
)
1131 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1133 bool is_break() const
1135 return mode
== jump_break
;
1138 bool is_continue() const
1140 return mode
== jump_continue
;
1143 /** Mode selector for the jump instruction. */
1144 enum jump_mode mode
;
1146 /** Loop containing this break instruction. */
1151 * IR instruction representing discard statements.
1153 class ir_discard
: public ir_jump
{
1157 this->ir_type
= ir_type_discard
;
1158 this->condition
= NULL
;
1161 ir_discard(ir_rvalue
*cond
)
1163 this->ir_type
= ir_type_discard
;
1164 this->condition
= cond
;
1167 virtual ir_discard
*clone(void *mem_ctx
, struct hash_table
*ht
) const;
1169 virtual void accept(ir_visitor
*v
)
1174 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1176 virtual ir_discard
*as_discard()
1181 ir_rvalue
*condition
;
1187 * Texture sampling opcodes used in ir_texture
1189 enum ir_texture_opcode
{
1190 ir_tex
, /**< Regular texture look-up */
1191 ir_txb
, /**< Texture look-up with LOD bias */
1192 ir_txl
, /**< Texture look-up with explicit LOD */
1193 ir_txd
, /**< Texture look-up with partial derivatvies */
1194 ir_txf
, /**< Texel fetch with explicit LOD */
1195 ir_txs
/**< Texture size */
1200 * IR instruction to sample a texture
1202 * The specific form of the IR instruction depends on the \c mode value
1203 * selected from \c ir_texture_opcodes. In the printed IR, these will
1206 * Texel offset (0 or an expression)
1207 * | Projection divisor
1208 * | | Shadow comparitor
1211 * (tex <type> <sampler> <coordinate> 0 1 ( ))
1212 * (txb <type> <sampler> <coordinate> 0 1 ( ) <bias>)
1213 * (txl <type> <sampler> <coordinate> 0 1 ( ) <lod>)
1214 * (txd <type> <sampler> <coordinate> 0 1 ( ) (dPdx dPdy))
1215 * (txf <type> <sampler> <coordinate> 0 <lod>)
1216 * (txs <type> <sampler> <lod>)
1218 class ir_texture
: public ir_rvalue
{
1220 ir_texture(enum ir_texture_opcode op
)
1221 : op(op
), projector(NULL
), shadow_comparitor(NULL
), offset(NULL
)
1223 this->ir_type
= ir_type_texture
;
1226 virtual ir_texture
*clone(void *mem_ctx
, struct hash_table
*) const;
1228 virtual ir_constant
*constant_expression_value();
1230 virtual void accept(ir_visitor
*v
)
1235 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1238 * Return a string representing the ir_texture_opcode.
1240 const char *opcode_string();
1242 /** Set the sampler and type. */
1243 void set_sampler(ir_dereference
*sampler
, const glsl_type
*type
);
1246 * Do a reverse-lookup to translate a string into an ir_texture_opcode.
1248 static ir_texture_opcode
get_opcode(const char *);
1250 enum ir_texture_opcode op
;
1252 /** Sampler to use for the texture access. */
1253 ir_dereference
*sampler
;
1255 /** Texture coordinate to sample */
1256 ir_rvalue
*coordinate
;
1259 * Value used for projective divide.
1261 * If there is no projective divide (the common case), this will be
1262 * \c NULL. Optimization passes should check for this to point to a constant
1263 * of 1.0 and replace that with \c NULL.
1265 ir_rvalue
*projector
;
1268 * Coordinate used for comparison on shadow look-ups.
1270 * If there is no shadow comparison, this will be \c NULL. For the
1271 * \c ir_txf opcode, this *must* be \c NULL.
1273 ir_rvalue
*shadow_comparitor
;
1275 /** Texel offset. */
1279 ir_rvalue
*lod
; /**< Floating point LOD */
1280 ir_rvalue
*bias
; /**< Floating point LOD bias */
1282 ir_rvalue
*dPdx
; /**< Partial derivative of coordinate wrt X */
1283 ir_rvalue
*dPdy
; /**< Partial derivative of coordinate wrt Y */
1289 struct ir_swizzle_mask
{
1296 * Number of components in the swizzle.
1298 unsigned num_components
:3;
1301 * Does the swizzle contain duplicate components?
1303 * L-value swizzles cannot contain duplicate components.
1305 unsigned has_duplicates
:1;
1309 class ir_swizzle
: public ir_rvalue
{
1311 ir_swizzle(ir_rvalue
*, unsigned x
, unsigned y
, unsigned z
, unsigned w
,
1314 ir_swizzle(ir_rvalue
*val
, const unsigned *components
, unsigned count
);
1316 ir_swizzle(ir_rvalue
*val
, ir_swizzle_mask mask
);
1318 virtual ir_swizzle
*clone(void *mem_ctx
, struct hash_table
*) const;
1320 virtual ir_constant
*constant_expression_value();
1322 virtual ir_swizzle
*as_swizzle()
1328 * Construct an ir_swizzle from the textual representation. Can fail.
1330 static ir_swizzle
*create(ir_rvalue
*, const char *, unsigned vector_length
);
1332 virtual void accept(ir_visitor
*v
)
1337 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1339 bool is_lvalue() const
1341 return val
->is_lvalue() && !mask
.has_duplicates
;
1345 * Get the variable that is ultimately referenced by an r-value
1347 virtual ir_variable
*variable_referenced() const;
1350 ir_swizzle_mask mask
;
1354 * Initialize the mask component of a swizzle
1356 * This is used by the \c ir_swizzle constructors.
1358 void init_mask(const unsigned *components
, unsigned count
);
1362 class ir_dereference
: public ir_rvalue
{
1364 virtual ir_dereference
*clone(void *mem_ctx
, struct hash_table
*) const = 0;
1366 virtual ir_dereference
*as_dereference()
1371 bool is_lvalue() const;
1374 * Get the variable that is ultimately referenced by an r-value
1376 virtual ir_variable
*variable_referenced() const = 0;
1380 class ir_dereference_variable
: public ir_dereference
{
1382 ir_dereference_variable(ir_variable
*var
);
1384 virtual ir_dereference_variable
*clone(void *mem_ctx
,
1385 struct hash_table
*) const;
1387 virtual ir_constant
*constant_expression_value();
1389 virtual ir_dereference_variable
*as_dereference_variable()
1395 * Get the variable that is ultimately referenced by an r-value
1397 virtual ir_variable
*variable_referenced() const
1402 virtual ir_variable
*whole_variable_referenced()
1404 /* ir_dereference_variable objects always dereference the entire
1405 * variable. However, if this dereference is dereferenced by anything
1406 * else, the complete deferefernce chain is not a whole-variable
1407 * dereference. This method should only be called on the top most
1408 * ir_rvalue in a dereference chain.
1413 virtual void accept(ir_visitor
*v
)
1418 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1421 * Object being dereferenced.
1427 class ir_dereference_array
: public ir_dereference
{
1429 ir_dereference_array(ir_rvalue
*value
, ir_rvalue
*array_index
);
1431 ir_dereference_array(ir_variable
*var
, ir_rvalue
*array_index
);
1433 virtual ir_dereference_array
*clone(void *mem_ctx
,
1434 struct hash_table
*) const;
1436 virtual ir_constant
*constant_expression_value();
1438 virtual ir_dereference_array
*as_dereference_array()
1444 * Get the variable that is ultimately referenced by an r-value
1446 virtual ir_variable
*variable_referenced() const
1448 return this->array
->variable_referenced();
1451 virtual void accept(ir_visitor
*v
)
1456 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1459 ir_rvalue
*array_index
;
1462 void set_array(ir_rvalue
*value
);
1466 class ir_dereference_record
: public ir_dereference
{
1468 ir_dereference_record(ir_rvalue
*value
, const char *field
);
1470 ir_dereference_record(ir_variable
*var
, const char *field
);
1472 virtual ir_dereference_record
*clone(void *mem_ctx
,
1473 struct hash_table
*) const;
1475 virtual ir_constant
*constant_expression_value();
1478 * Get the variable that is ultimately referenced by an r-value
1480 virtual ir_variable
*variable_referenced() const
1482 return this->record
->variable_referenced();
1485 virtual void accept(ir_visitor
*v
)
1490 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1498 * Data stored in an ir_constant
1500 union ir_constant_data
{
1508 class ir_constant
: public ir_rvalue
{
1510 ir_constant(const struct glsl_type
*type
, const ir_constant_data
*data
);
1511 ir_constant(bool b
);
1512 ir_constant(unsigned int u
);
1514 ir_constant(float f
);
1517 * Construct an ir_constant from a list of ir_constant values
1519 ir_constant(const struct glsl_type
*type
, exec_list
*values
);
1522 * Construct an ir_constant from a scalar component of another ir_constant
1524 * The new \c ir_constant inherits the type of the component from the
1528 * In the case of a matrix constant, the new constant is a scalar, \b not
1531 ir_constant(const ir_constant
*c
, unsigned i
);
1534 * Return a new ir_constant of the specified type containing all zeros.
1536 static ir_constant
*zero(void *mem_ctx
, const glsl_type
*type
);
1538 virtual ir_constant
*clone(void *mem_ctx
, struct hash_table
*) const;
1540 virtual ir_constant
*constant_expression_value();
1542 virtual ir_constant
*as_constant()
1547 virtual void accept(ir_visitor
*v
)
1552 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1555 * Get a particular component of a constant as a specific type
1557 * This is useful, for example, to get a value from an integer constant
1558 * as a float or bool. This appears frequently when constructors are
1559 * called with all constant parameters.
1562 bool get_bool_component(unsigned i
) const;
1563 float get_float_component(unsigned i
) const;
1564 int get_int_component(unsigned i
) const;
1565 unsigned get_uint_component(unsigned i
) const;
1568 ir_constant
*get_array_element(unsigned i
) const;
1570 ir_constant
*get_record_field(const char *name
);
1573 * Determine whether a constant has the same value as another constant
1575 * \sa ir_constant::is_zero, ir_constant::is_one,
1576 * ir_constant::is_negative_one
1578 bool has_value(const ir_constant
*) const;
1580 virtual bool is_zero() const;
1581 virtual bool is_one() const;
1582 virtual bool is_negative_one() const;
1585 * Value of the constant.
1587 * The field used to back the values supplied by the constant is determined
1588 * by the type associated with the \c ir_instruction. Constants may be
1589 * scalars, vectors, or matrices.
1591 union ir_constant_data value
;
1593 /* Array elements */
1594 ir_constant
**array_elements
;
1596 /* Structure fields */
1597 exec_list components
;
1601 * Parameterless constructor only used by the clone method
1609 * Apply a visitor to each IR node in a list
1612 visit_exec_list(exec_list
*list
, ir_visitor
*visitor
);
1615 * Validate invariants on each IR node in a list
1617 void validate_ir_tree(exec_list
*instructions
);
1619 struct _mesa_glsl_parse_state
;
1620 struct gl_shader_program
;
1623 * Detect whether an unlinked shader contains static recursion
1625 * If the list of instructions is determined to contain static recursion,
1626 * \c _mesa_glsl_error will be called to emit error messages for each function
1627 * that is in the recursion cycle.
1630 detect_recursion_unlinked(struct _mesa_glsl_parse_state
*state
,
1631 exec_list
*instructions
);
1634 * Detect whether a linked shader contains static recursion
1636 * If the list of instructions is determined to contain static recursion,
1637 * \c link_error_printf will be called to emit error messages for each function
1638 * that is in the recursion cycle. In addition,
1639 * \c gl_shader_program::LinkStatus will be set to false.
1642 detect_recursion_linked(struct gl_shader_program
*prog
,
1643 exec_list
*instructions
);
1646 * Make a clone of each IR instruction in a list
1648 * \param in List of IR instructions that are to be cloned
1649 * \param out List to hold the cloned instructions
1652 clone_ir_list(void *mem_ctx
, exec_list
*out
, const exec_list
*in
);
1655 _mesa_glsl_initialize_variables(exec_list
*instructions
,
1656 struct _mesa_glsl_parse_state
*state
);
1659 _mesa_glsl_initialize_functions(_mesa_glsl_parse_state
*state
);
1662 _mesa_glsl_release_functions(void);
1665 reparent_ir(exec_list
*list
, void *mem_ctx
);
1667 struct glsl_symbol_table
;
1670 import_prototypes(const exec_list
*source
, exec_list
*dest
,
1671 struct glsl_symbol_table
*symbols
, void *mem_ctx
);
1674 ir_has_call(ir_instruction
*ir
);
1677 do_set_program_inouts(exec_list
*instructions
, struct gl_program
*prog
,
1678 bool is_fragment_shader
);
1681 prototype_string(const glsl_type
*return_type
, const char *name
,
1682 exec_list
*parameters
);