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"
39 * \defgroup IR Intermediate representation nodes
47 * Each concrete class derived from \c ir_instruction has a value in this
48 * enumerant. The value for the type is stored in \c ir_instruction::ir_type
49 * by the constructor. While using type tags is not very C++, it is extremely
50 * convenient. For example, during debugging you can simply inspect
51 * \c ir_instruction::ir_type to find out the actual type of the object.
53 * In addition, it is possible to use a switch-statement based on \c
54 * \c ir_instruction::ir_type to select different behavior for different object
55 * types. For functions that have only slight differences for several object
56 * types, this allows writing very straightforward, readable code.
60 * Zero is unused so that the IR validator can detect cases where
61 * \c ir_instruction::ir_type has not been initialized.
68 ir_type_dereference_array
,
69 ir_type_dereference_record
,
70 ir_type_dereference_variable
,
74 ir_type_function_signature
,
81 ir_type_max
/**< maximum ir_type enum number, for validation */
85 * Base class of all IR instructions
87 class ir_instruction
: public exec_node
{
89 enum ir_node_type ir_type
;
90 const struct glsl_type
*type
;
92 /** ir_print_visitor helper for debugging. */
93 void print(void) const;
95 virtual void accept(ir_visitor
*) = 0;
96 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*) = 0;
97 virtual ir_instruction
*clone(void *mem_ctx
,
98 struct hash_table
*ht
) const = 0;
101 * \name IR instruction downcast functions
103 * These functions either cast the object to a derived class or return
104 * \c NULL if the object's type does not match the specified derived class.
105 * Additional downcast functions will be added as needed.
108 virtual class ir_variable
* as_variable() { return NULL
; }
109 virtual class ir_function
* as_function() { return NULL
; }
110 virtual class ir_dereference
* as_dereference() { return NULL
; }
111 virtual class ir_dereference_array
* as_dereference_array() { return NULL
; }
112 virtual class ir_dereference_variable
*as_dereference_variable() { return NULL
; }
113 virtual class ir_expression
* as_expression() { return NULL
; }
114 virtual class ir_rvalue
* as_rvalue() { return NULL
; }
115 virtual class ir_loop
* as_loop() { return NULL
; }
116 virtual class ir_assignment
* as_assignment() { return NULL
; }
117 virtual class ir_call
* as_call() { return NULL
; }
118 virtual class ir_return
* as_return() { return NULL
; }
119 virtual class ir_if
* as_if() { return NULL
; }
120 virtual class ir_swizzle
* as_swizzle() { return NULL
; }
121 virtual class ir_constant
* as_constant() { return NULL
; }
122 virtual class ir_discard
* as_discard() { return NULL
; }
128 ir_type
= ir_type_unset
;
134 class ir_rvalue
: public ir_instruction
{
136 virtual ir_rvalue
*clone(void *mem_ctx
, struct hash_table
*) const = 0;
138 virtual ir_constant
*constant_expression_value() = 0;
140 virtual ir_rvalue
* as_rvalue()
145 ir_rvalue
*as_rvalue_to_saturate();
147 virtual bool is_lvalue() const
153 * Get the variable that is ultimately referenced by an r-value
155 virtual ir_variable
*variable_referenced() const
162 * If an r-value is a reference to a whole variable, get that variable
165 * Pointer to a variable that is completely dereferenced by the r-value. If
166 * the r-value is not a dereference or the dereference does not access the
167 * entire variable (i.e., it's just one array element, struct field), \c NULL
170 virtual ir_variable
*whole_variable_referenced()
176 * Determine if an r-value has the value zero
178 * The base implementation of this function always returns \c false. The
179 * \c ir_constant class over-rides this function to return \c true \b only
180 * for vector and scalar types that have all elements set to the value
181 * zero (or \c false for booleans).
183 * \sa ir_constant::has_value, ir_rvalue::is_one, ir_rvalue::is_negative_one
185 virtual bool is_zero() const;
188 * Determine if an r-value has the value one
190 * The base implementation of this function always returns \c false. The
191 * \c ir_constant class over-rides this function to return \c true \b only
192 * for vector and scalar types that have all elements set to the value
193 * one (or \c true for booleans).
195 * \sa ir_constant::has_value, ir_rvalue::is_zero, ir_rvalue::is_negative_one
197 virtual bool is_one() const;
200 * Determine if an r-value has the value negative one
202 * The base implementation of this function always returns \c false. The
203 * \c ir_constant class over-rides this function to return \c true \b only
204 * for vector and scalar types that have all elements set to the value
205 * negative one. For boolean times, the result is always \c false.
207 * \sa ir_constant::has_value, ir_rvalue::is_zero, ir_rvalue::is_one
209 virtual bool is_negative_one() const;
217 * Variable storage classes
219 enum ir_variable_mode
{
220 ir_var_auto
= 0, /**< Function local variables and globals. */
221 ir_var_uniform
, /**< Variable declared as a uniform. */
225 ir_var_const_in
, /**< "in" param that must be a constant expression */
226 ir_var_system_value
, /**< Ex: front-face, instance-id, etc. */
227 ir_var_temporary
/**< Temporary variable generated during compilation. */
230 enum ir_variable_interpolation
{
237 * \brief Layout qualifiers for gl_FragDepth.
239 * The AMD/ARB_conservative_depth extensions allow gl_FragDepth to be redeclared
240 * with a layout qualifier.
242 enum ir_depth_layout
{
243 ir_depth_layout_none
, /**< No depth layout is specified. */
245 ir_depth_layout_greater
,
246 ir_depth_layout_less
,
247 ir_depth_layout_unchanged
251 * \brief Convert depth layout qualifier to string.
254 depth_layout_string(ir_depth_layout layout
);
257 * Description of built-in state associated with a uniform
259 * \sa ir_variable::state_slots
261 struct ir_state_slot
{
266 class ir_variable
: public ir_instruction
{
268 ir_variable(const struct glsl_type
*, const char *, ir_variable_mode
);
270 virtual ir_variable
*clone(void *mem_ctx
, struct hash_table
*ht
) const;
272 virtual ir_variable
*as_variable()
277 virtual void accept(ir_visitor
*v
)
282 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
286 * Get the string value for the interpolation qualifier
288 * \return The string that would be used in a shader to specify \c
289 * mode will be returned.
291 * This function should only be used on a shader input or output variable.
293 const char *interpolation_string() const;
296 * Delcared name of the variable
301 * Highest element accessed with a constant expression array index
303 * Not used for non-array variables.
305 unsigned max_array_access
;
308 * Is the variable read-only?
310 * This is set for variables declared as \c const, shader inputs,
313 unsigned read_only
:1;
315 unsigned invariant
:1;
318 * Has this variable been used for reading or writing?
320 * Several GLSL semantic checks require knowledge of whether or not a
321 * variable has been used. For example, it is an error to redeclare a
322 * variable as invariant after it has been used.
327 * Storage class of the variable.
329 * \sa ir_variable_mode
334 * Interpolation mode for shader inputs / outputs
336 * \sa ir_variable_interpolation
338 unsigned interpolation
:2;
341 * \name ARB_fragment_coord_conventions
344 unsigned origin_upper_left
:1;
345 unsigned pixel_center_integer
:1;
349 * \brief Layout qualifier for gl_FragDepth.
351 * This is not equal to \c ir_depth_layout_none if and only if this
352 * variable is \c gl_FragDepth and a layout qualifier is specified.
354 ir_depth_layout depth_layout
;
357 * Was the location explicitly set in the shader?
359 * If the location is explicitly set in the shader, it \b cannot be changed
360 * by the linker or by the API (e.g., calls to \c glBindAttribLocation have
363 unsigned explicit_location
:1;
366 * Storage location of the base of this variable
368 * The precise meaning of this field depends on the nature of the variable.
370 * - Vertex shader input: one of the values from \c gl_vert_attrib.
371 * - Vertex shader output: one of the values from \c gl_vert_result.
372 * - Fragment shader input: one of the values from \c gl_frag_attrib.
373 * - Fragment shader output: one of the values from \c gl_frag_result.
374 * - Uniforms: Per-stage uniform slot number.
375 * - Other: This field is not currently used.
377 * If the variable is a uniform, shader input, or shader output, and the
378 * slot has not been assigned, the value will be -1.
383 * Built-in state that backs this uniform
385 * Once set at variable creation, \c state_slots must remain invariant.
386 * This is because, ideally, this array would be shared by all clones of
387 * this variable in the IR tree. In other words, we'd really like for it
388 * to be a fly-weight.
390 * If the variable is not a uniform, \c num_state_slots will be zero and
391 * \c state_slots will be \c NULL.
394 unsigned num_state_slots
; /**< Number of state slots used */
395 ir_state_slot
*state_slots
; /**< State descriptors. */
399 * Emit a warning if this variable is accessed.
401 const char *warn_extension
;
404 * Value assigned in the initializer of a variable declared "const"
406 ir_constant
*constant_value
;
412 * The representation of a function instance; may be the full definition or
413 * simply a prototype.
415 class ir_function_signature
: public ir_instruction
{
416 /* An ir_function_signature will be part of the list of signatures in
420 ir_function_signature(const glsl_type
*return_type
);
422 virtual ir_function_signature
*clone(void *mem_ctx
,
423 struct hash_table
*ht
) const;
424 ir_function_signature
*clone_prototype(void *mem_ctx
,
425 struct hash_table
*ht
) const;
427 virtual void accept(ir_visitor
*v
)
432 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
435 * Get the name of the function for which this is a signature
437 const char *function_name() const;
440 * Get a handle to the function for which this is a signature
442 * There is no setter function, this function returns a \c const pointer,
443 * and \c ir_function_signature::_function is private for a reason. The
444 * only way to make a connection between a function and function signature
445 * is via \c ir_function::add_signature. This helps ensure that certain
446 * invariants (i.e., a function signature is in the list of signatures for
447 * its \c _function) are met.
449 * \sa ir_function::add_signature
451 inline const class ir_function
*function() const
453 return this->_function
;
457 * Check whether the qualifiers match between this signature's parameters
458 * and the supplied parameter list. If not, returns the name of the first
459 * parameter with mismatched qualifiers (for use in error messages).
461 const char *qualifiers_match(exec_list
*params
);
464 * Replace the current parameter list with the given one. This is useful
465 * if the current information came from a prototype, and either has invalid
466 * or missing parameter names.
468 void replace_parameters(exec_list
*new_params
);
471 * Function return type.
473 * \note This discards the optional precision qualifier.
475 const struct glsl_type
*return_type
;
478 * List of ir_variable of function parameters.
480 * This represents the storage. The paramaters passed in a particular
481 * call will be in ir_call::actual_paramaters.
483 struct exec_list parameters
;
485 /** Whether or not this function has a body (which may be empty). */
486 unsigned is_defined
:1;
488 /** Whether or not this function signature is a built-in. */
489 unsigned is_builtin
:1;
491 /** Body of instructions in the function. */
492 struct exec_list body
;
495 /** Function of which this signature is one overload. */
496 class ir_function
*_function
;
498 friend class ir_function
;
503 * Header for tracking multiple overloaded functions with the same name.
504 * Contains a list of ir_function_signatures representing each of the
507 class ir_function
: public ir_instruction
{
509 ir_function(const char *name
);
511 virtual ir_function
*clone(void *mem_ctx
, struct hash_table
*ht
) const;
513 virtual ir_function
*as_function()
518 virtual void accept(ir_visitor
*v
)
523 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
525 void add_signature(ir_function_signature
*sig
)
527 sig
->_function
= this;
528 this->signatures
.push_tail(sig
);
532 * Get an iterator for the set of function signatures
534 exec_list_iterator
iterator()
536 return signatures
.iterator();
540 * Find a signature that matches a set of actual parameters, taking implicit
541 * conversions into account.
543 ir_function_signature
*matching_signature(const exec_list
*actual_param
);
546 * Find a signature that exactly matches a set of actual parameters without
547 * any implicit type conversions.
549 ir_function_signature
*exact_matching_signature(const exec_list
*actual_ps
);
552 * Name of the function.
556 /** Whether or not this function has a signature that isn't a built-in. */
557 bool has_user_signature();
560 * List of ir_function_signature for each overloaded function with this name.
562 struct exec_list signatures
;
565 inline const char *ir_function_signature::function_name() const
567 return this->_function
->name
;
573 * IR instruction representing high-level if-statements
575 class ir_if
: public ir_instruction
{
577 ir_if(ir_rvalue
*condition
)
578 : condition(condition
)
580 ir_type
= ir_type_if
;
583 virtual ir_if
*clone(void *mem_ctx
, struct hash_table
*ht
) const;
585 virtual ir_if
*as_if()
590 virtual void accept(ir_visitor
*v
)
595 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
597 ir_rvalue
*condition
;
598 /** List of ir_instruction for the body of the then branch */
599 exec_list then_instructions
;
600 /** List of ir_instruction for the body of the else branch */
601 exec_list else_instructions
;
606 * IR instruction representing a high-level loop structure.
608 class ir_loop
: public ir_instruction
{
612 virtual ir_loop
*clone(void *mem_ctx
, struct hash_table
*ht
) const;
614 virtual void accept(ir_visitor
*v
)
619 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
621 virtual ir_loop
*as_loop()
627 * Get an iterator for the instructions of the loop body
629 exec_list_iterator
iterator()
631 return body_instructions
.iterator();
634 /** List of ir_instruction that make up the body of the loop. */
635 exec_list body_instructions
;
638 * \name Loop counter and controls
640 * Represents a loop like a FORTRAN \c do-loop.
643 * If \c from and \c to are the same value, the loop will execute once.
646 ir_rvalue
*from
; /** Value of the loop counter on the first
647 * iteration of the loop.
649 ir_rvalue
*to
; /** Value of the loop counter on the last
650 * iteration of the loop.
652 ir_rvalue
*increment
;
653 ir_variable
*counter
;
656 * Comparison operation in the loop terminator.
658 * If any of the loop control fields are non-\c NULL, this field must be
659 * one of \c ir_binop_less, \c ir_binop_greater, \c ir_binop_lequal,
660 * \c ir_binop_gequal, \c ir_binop_equal, or \c ir_binop_nequal.
667 class ir_assignment
: public ir_instruction
{
669 ir_assignment(ir_rvalue
*lhs
, ir_rvalue
*rhs
, ir_rvalue
*condition
= NULL
);
672 * Construct an assignment with an explicit write mask
675 * Since a write mask is supplied, the LHS must already be a bare
676 * \c ir_dereference. The cannot be any swizzles in the LHS.
678 ir_assignment(ir_dereference
*lhs
, ir_rvalue
*rhs
, ir_rvalue
*condition
,
679 unsigned write_mask
);
681 virtual ir_assignment
*clone(void *mem_ctx
, struct hash_table
*ht
) const;
683 virtual ir_constant
*constant_expression_value();
685 virtual void accept(ir_visitor
*v
)
690 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
692 virtual ir_assignment
* as_assignment()
698 * Get a whole variable written by an assignment
700 * If the LHS of the assignment writes a whole variable, the variable is
701 * returned. Otherwise \c NULL is returned. Examples of whole-variable
704 * - Assigning to a scalar
705 * - Assigning to all components of a vector
706 * - Whole array (or matrix) assignment
707 * - Whole structure assignment
709 ir_variable
*whole_variable_written();
712 * Set the LHS of an assignment
714 void set_lhs(ir_rvalue
*lhs
);
717 * Left-hand side of the assignment.
719 * This should be treated as read only. If you need to set the LHS of an
720 * assignment, use \c ir_assignment::set_lhs.
725 * Value being assigned
730 * Optional condition for the assignment.
732 ir_rvalue
*condition
;
736 * Component mask written
738 * For non-vector types in the LHS, this field will be zero. For vector
739 * types, a bit will be set for each component that is written. Note that
740 * for \c vec2 and \c vec3 types only the lower bits will ever be set.
742 * A partially-set write mask means that each enabled channel gets
743 * the value from a consecutive channel of the rhs. For example,
744 * to write just .xyw of gl_FrontColor with color:
746 * (assign (constant bool (1)) (xyw)
747 * (var_ref gl_FragColor)
748 * (swiz xyw (var_ref color)))
750 unsigned write_mask
:4;
753 /* Update ir_expression::num_operands() and operator_strs when
754 * updating this list.
756 enum ir_expression_operation
{
765 ir_unop_exp
, /**< Log base e on gentype */
766 ir_unop_log
, /**< Natural log on gentype */
769 ir_unop_f2i
, /**< Float-to-integer conversion. */
770 ir_unop_i2f
, /**< Integer-to-float conversion. */
771 ir_unop_f2b
, /**< Float-to-boolean conversion */
772 ir_unop_b2f
, /**< Boolean-to-float conversion */
773 ir_unop_i2b
, /**< int-to-boolean conversion */
774 ir_unop_b2i
, /**< Boolean-to-int conversion */
775 ir_unop_u2f
, /**< Unsigned-to-float conversion. */
776 ir_unop_i2u
, /**< Integer-to-unsigned conversion. */
777 ir_unop_u2i
, /**< Unsigned-to-integer conversion. */
781 * \name Unary floating-point rounding operations.
792 * \name Trigonometric operations.
797 ir_unop_sin_reduced
, /**< Reduced range sin. [-pi, pi] */
798 ir_unop_cos_reduced
, /**< Reduced range cos. [-pi, pi] */
802 * \name Partial derivatives.
812 * A sentinel marking the last of the unary operations.
814 ir_last_unop
= ir_unop_noise
,
822 * Takes one of two combinations of arguments:
827 * Does not take integer types.
832 * \name Binary comparison operators which return a boolean vector.
833 * The type of both operands must be equal.
843 * Returns single boolean for whether all components of operands[0]
844 * equal the components of operands[1].
848 * Returns single boolean for whether any component of operands[0]
849 * is not equal to the corresponding component of operands[1].
855 * \name Bit-wise binary operations.
876 * A sentinel marking the last of the binary operations.
878 ir_last_binop
= ir_binop_pow
,
883 * A sentinel marking the last of all operations.
885 ir_last_opcode
= ir_last_binop
888 class ir_expression
: public ir_rvalue
{
891 * Constructor for unary operation expressions
893 ir_expression(int op
, const struct glsl_type
*type
, ir_rvalue
*);
894 ir_expression(int op
, ir_rvalue
*);
897 * Constructor for binary operation expressions
899 ir_expression(int op
, const struct glsl_type
*type
,
900 ir_rvalue
*, ir_rvalue
*);
901 ir_expression(int op
, ir_rvalue
*op0
, ir_rvalue
*op1
);
904 * Constructor for quad operator expressions
906 ir_expression(int op
, const struct glsl_type
*type
,
907 ir_rvalue
*, ir_rvalue
*, ir_rvalue
*, ir_rvalue
*);
909 virtual ir_expression
*as_expression()
914 virtual ir_expression
*clone(void *mem_ctx
, struct hash_table
*ht
) const;
917 * Attempt to constant-fold the expression
919 * If the expression cannot be constant folded, this method will return
922 virtual ir_constant
*constant_expression_value();
925 * Determine the number of operands used by an expression
927 static unsigned int get_num_operands(ir_expression_operation
);
930 * Determine the number of operands used by an expression
932 unsigned int get_num_operands() const
934 return (this->operation
== ir_quadop_vector
)
935 ? this->type
->vector_elements
: get_num_operands(operation
);
939 * Return a string representing this expression's operator.
941 const char *operator_string();
944 * Return a string representing this expression's operator.
946 static const char *operator_string(ir_expression_operation
);
950 * Do a reverse-lookup to translate the given string into an operator.
952 static ir_expression_operation
get_operator(const char *);
954 virtual void accept(ir_visitor
*v
)
959 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
961 ir_expression_operation operation
;
962 ir_rvalue
*operands
[4];
967 * IR instruction representing a function call
969 class ir_call
: public ir_rvalue
{
971 ir_call(ir_function_signature
*callee
, exec_list
*actual_parameters
)
974 ir_type
= ir_type_call
;
975 assert(callee
->return_type
!= NULL
);
976 type
= callee
->return_type
;
977 actual_parameters
->move_nodes_to(& this->actual_parameters
);
978 this->use_builtin
= callee
->is_builtin
;
981 virtual ir_call
*clone(void *mem_ctx
, struct hash_table
*ht
) const;
983 virtual ir_constant
*constant_expression_value();
985 virtual ir_call
*as_call()
990 virtual void accept(ir_visitor
*v
)
995 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
998 * Get a generic ir_call object when an error occurs
1000 * Any allocation will be performed with 'ctx' as ralloc owner.
1002 static ir_call
*get_error_instruction(void *ctx
);
1005 * Get an iterator for the set of acutal parameters
1007 exec_list_iterator
iterator()
1009 return actual_parameters
.iterator();
1013 * Get the name of the function being called.
1015 const char *callee_name() const
1017 return callee
->function_name();
1021 * Get the function signature bound to this function call
1023 ir_function_signature
*get_callee()
1029 * Set the function call target
1031 void set_callee(ir_function_signature
*sig
);
1034 * Generates an inline version of the function before @ir,
1035 * returning the return value of the function.
1037 ir_rvalue
*generate_inline(ir_instruction
*ir
);
1039 /* List of ir_rvalue of paramaters passed in this call. */
1040 exec_list actual_parameters
;
1042 /** Should this call only bind to a built-in function? */
1049 this->ir_type
= ir_type_call
;
1052 ir_function_signature
*callee
;
1057 * \name Jump-like IR instructions.
1059 * These include \c break, \c continue, \c return, and \c discard.
1062 class ir_jump
: public ir_instruction
{
1066 ir_type
= ir_type_unset
;
1070 class ir_return
: public ir_jump
{
1075 this->ir_type
= ir_type_return
;
1078 ir_return(ir_rvalue
*value
)
1081 this->ir_type
= ir_type_return
;
1084 virtual ir_return
*clone(void *mem_ctx
, struct hash_table
*) const;
1086 virtual ir_return
*as_return()
1091 ir_rvalue
*get_value() const
1096 virtual void accept(ir_visitor
*v
)
1101 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1108 * Jump instructions used inside loops
1110 * These include \c break and \c continue. The \c break within a loop is
1111 * different from the \c break within a switch-statement.
1113 * \sa ir_switch_jump
1115 class ir_loop_jump
: public ir_jump
{
1122 ir_loop_jump(jump_mode mode
)
1124 this->ir_type
= ir_type_loop_jump
;
1129 virtual ir_loop_jump
*clone(void *mem_ctx
, struct hash_table
*) const;
1131 virtual void accept(ir_visitor
*v
)
1136 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1138 bool is_break() const
1140 return mode
== jump_break
;
1143 bool is_continue() const
1145 return mode
== jump_continue
;
1148 /** Mode selector for the jump instruction. */
1149 enum jump_mode mode
;
1151 /** Loop containing this break instruction. */
1156 * IR instruction representing discard statements.
1158 class ir_discard
: public ir_jump
{
1162 this->ir_type
= ir_type_discard
;
1163 this->condition
= NULL
;
1166 ir_discard(ir_rvalue
*cond
)
1168 this->ir_type
= ir_type_discard
;
1169 this->condition
= cond
;
1172 virtual ir_discard
*clone(void *mem_ctx
, struct hash_table
*ht
) const;
1174 virtual void accept(ir_visitor
*v
)
1179 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1181 virtual ir_discard
*as_discard()
1186 ir_rvalue
*condition
;
1192 * Texture sampling opcodes used in ir_texture
1194 enum ir_texture_opcode
{
1195 ir_tex
, /**< Regular texture look-up */
1196 ir_txb
, /**< Texture look-up with LOD bias */
1197 ir_txl
, /**< Texture look-up with explicit LOD */
1198 ir_txd
, /**< Texture look-up with partial derivatvies */
1199 ir_txf
, /**< Texel fetch with explicit LOD */
1200 ir_txs
/**< Texture size */
1205 * IR instruction to sample a texture
1207 * The specific form of the IR instruction depends on the \c mode value
1208 * selected from \c ir_texture_opcodes. In the printed IR, these will
1211 * Texel offset (0 or an expression)
1212 * | Projection divisor
1213 * | | Shadow comparitor
1216 * (tex <type> <sampler> <coordinate> 0 1 ( ))
1217 * (txb <type> <sampler> <coordinate> 0 1 ( ) <bias>)
1218 * (txl <type> <sampler> <coordinate> 0 1 ( ) <lod>)
1219 * (txd <type> <sampler> <coordinate> 0 1 ( ) (dPdx dPdy))
1220 * (txf <type> <sampler> <coordinate> 0 <lod>)
1221 * (txs <type> <sampler> <lod>)
1223 class ir_texture
: public ir_rvalue
{
1225 ir_texture(enum ir_texture_opcode op
)
1226 : op(op
), projector(NULL
), shadow_comparitor(NULL
), offset(NULL
)
1228 this->ir_type
= ir_type_texture
;
1231 virtual ir_texture
*clone(void *mem_ctx
, struct hash_table
*) const;
1233 virtual ir_constant
*constant_expression_value();
1235 virtual void accept(ir_visitor
*v
)
1240 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1243 * Return a string representing the ir_texture_opcode.
1245 const char *opcode_string();
1247 /** Set the sampler and type. */
1248 void set_sampler(ir_dereference
*sampler
, const glsl_type
*type
);
1251 * Do a reverse-lookup to translate a string into an ir_texture_opcode.
1253 static ir_texture_opcode
get_opcode(const char *);
1255 enum ir_texture_opcode op
;
1257 /** Sampler to use for the texture access. */
1258 ir_dereference
*sampler
;
1260 /** Texture coordinate to sample */
1261 ir_rvalue
*coordinate
;
1264 * Value used for projective divide.
1266 * If there is no projective divide (the common case), this will be
1267 * \c NULL. Optimization passes should check for this to point to a constant
1268 * of 1.0 and replace that with \c NULL.
1270 ir_rvalue
*projector
;
1273 * Coordinate used for comparison on shadow look-ups.
1275 * If there is no shadow comparison, this will be \c NULL. For the
1276 * \c ir_txf opcode, this *must* be \c NULL.
1278 ir_rvalue
*shadow_comparitor
;
1280 /** Texel offset. */
1284 ir_rvalue
*lod
; /**< Floating point LOD */
1285 ir_rvalue
*bias
; /**< Floating point LOD bias */
1287 ir_rvalue
*dPdx
; /**< Partial derivative of coordinate wrt X */
1288 ir_rvalue
*dPdy
; /**< Partial derivative of coordinate wrt Y */
1294 struct ir_swizzle_mask
{
1301 * Number of components in the swizzle.
1303 unsigned num_components
:3;
1306 * Does the swizzle contain duplicate components?
1308 * L-value swizzles cannot contain duplicate components.
1310 unsigned has_duplicates
:1;
1314 class ir_swizzle
: public ir_rvalue
{
1316 ir_swizzle(ir_rvalue
*, unsigned x
, unsigned y
, unsigned z
, unsigned w
,
1319 ir_swizzle(ir_rvalue
*val
, const unsigned *components
, unsigned count
);
1321 ir_swizzle(ir_rvalue
*val
, ir_swizzle_mask mask
);
1323 virtual ir_swizzle
*clone(void *mem_ctx
, struct hash_table
*) const;
1325 virtual ir_constant
*constant_expression_value();
1327 virtual ir_swizzle
*as_swizzle()
1333 * Construct an ir_swizzle from the textual representation. Can fail.
1335 static ir_swizzle
*create(ir_rvalue
*, const char *, unsigned vector_length
);
1337 virtual void accept(ir_visitor
*v
)
1342 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1344 bool is_lvalue() const
1346 return val
->is_lvalue() && !mask
.has_duplicates
;
1350 * Get the variable that is ultimately referenced by an r-value
1352 virtual ir_variable
*variable_referenced() const;
1355 ir_swizzle_mask mask
;
1359 * Initialize the mask component of a swizzle
1361 * This is used by the \c ir_swizzle constructors.
1363 void init_mask(const unsigned *components
, unsigned count
);
1367 class ir_dereference
: public ir_rvalue
{
1369 virtual ir_dereference
*clone(void *mem_ctx
, struct hash_table
*) const = 0;
1371 virtual ir_dereference
*as_dereference()
1376 bool is_lvalue() const;
1379 * Get the variable that is ultimately referenced by an r-value
1381 virtual ir_variable
*variable_referenced() const = 0;
1385 class ir_dereference_variable
: public ir_dereference
{
1387 ir_dereference_variable(ir_variable
*var
);
1389 virtual ir_dereference_variable
*clone(void *mem_ctx
,
1390 struct hash_table
*) const;
1392 virtual ir_constant
*constant_expression_value();
1394 virtual ir_dereference_variable
*as_dereference_variable()
1400 * Get the variable that is ultimately referenced by an r-value
1402 virtual ir_variable
*variable_referenced() const
1407 virtual ir_variable
*whole_variable_referenced()
1409 /* ir_dereference_variable objects always dereference the entire
1410 * variable. However, if this dereference is dereferenced by anything
1411 * else, the complete deferefernce chain is not a whole-variable
1412 * dereference. This method should only be called on the top most
1413 * ir_rvalue in a dereference chain.
1418 virtual void accept(ir_visitor
*v
)
1423 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1426 * Object being dereferenced.
1432 class ir_dereference_array
: public ir_dereference
{
1434 ir_dereference_array(ir_rvalue
*value
, ir_rvalue
*array_index
);
1436 ir_dereference_array(ir_variable
*var
, ir_rvalue
*array_index
);
1438 virtual ir_dereference_array
*clone(void *mem_ctx
,
1439 struct hash_table
*) const;
1441 virtual ir_constant
*constant_expression_value();
1443 virtual ir_dereference_array
*as_dereference_array()
1449 * Get the variable that is ultimately referenced by an r-value
1451 virtual ir_variable
*variable_referenced() const
1453 return this->array
->variable_referenced();
1456 virtual void accept(ir_visitor
*v
)
1461 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1464 ir_rvalue
*array_index
;
1467 void set_array(ir_rvalue
*value
);
1471 class ir_dereference_record
: public ir_dereference
{
1473 ir_dereference_record(ir_rvalue
*value
, const char *field
);
1475 ir_dereference_record(ir_variable
*var
, const char *field
);
1477 virtual ir_dereference_record
*clone(void *mem_ctx
,
1478 struct hash_table
*) const;
1480 virtual ir_constant
*constant_expression_value();
1483 * Get the variable that is ultimately referenced by an r-value
1485 virtual ir_variable
*variable_referenced() const
1487 return this->record
->variable_referenced();
1490 virtual void accept(ir_visitor
*v
)
1495 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1503 * Data stored in an ir_constant
1505 union ir_constant_data
{
1513 class ir_constant
: public ir_rvalue
{
1515 ir_constant(const struct glsl_type
*type
, const ir_constant_data
*data
);
1516 ir_constant(bool b
);
1517 ir_constant(unsigned int u
);
1519 ir_constant(float f
);
1522 * Construct an ir_constant from a list of ir_constant values
1524 ir_constant(const struct glsl_type
*type
, exec_list
*values
);
1527 * Construct an ir_constant from a scalar component of another ir_constant
1529 * The new \c ir_constant inherits the type of the component from the
1533 * In the case of a matrix constant, the new constant is a scalar, \b not
1536 ir_constant(const ir_constant
*c
, unsigned i
);
1539 * Return a new ir_constant of the specified type containing all zeros.
1541 static ir_constant
*zero(void *mem_ctx
, const glsl_type
*type
);
1543 virtual ir_constant
*clone(void *mem_ctx
, struct hash_table
*) const;
1545 virtual ir_constant
*constant_expression_value();
1547 virtual ir_constant
*as_constant()
1552 virtual void accept(ir_visitor
*v
)
1557 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1560 * Get a particular component of a constant as a specific type
1562 * This is useful, for example, to get a value from an integer constant
1563 * as a float or bool. This appears frequently when constructors are
1564 * called with all constant parameters.
1567 bool get_bool_component(unsigned i
) const;
1568 float get_float_component(unsigned i
) const;
1569 int get_int_component(unsigned i
) const;
1570 unsigned get_uint_component(unsigned i
) const;
1573 ir_constant
*get_array_element(unsigned i
) const;
1575 ir_constant
*get_record_field(const char *name
);
1578 * Determine whether a constant has the same value as another constant
1580 * \sa ir_constant::is_zero, ir_constant::is_one,
1581 * ir_constant::is_negative_one
1583 bool has_value(const ir_constant
*) const;
1585 virtual bool is_zero() const;
1586 virtual bool is_one() const;
1587 virtual bool is_negative_one() const;
1590 * Value of the constant.
1592 * The field used to back the values supplied by the constant is determined
1593 * by the type associated with the \c ir_instruction. Constants may be
1594 * scalars, vectors, or matrices.
1596 union ir_constant_data value
;
1598 /* Array elements */
1599 ir_constant
**array_elements
;
1601 /* Structure fields */
1602 exec_list components
;
1606 * Parameterless constructor only used by the clone method
1614 * Apply a visitor to each IR node in a list
1617 visit_exec_list(exec_list
*list
, ir_visitor
*visitor
);
1620 * Validate invariants on each IR node in a list
1622 void validate_ir_tree(exec_list
*instructions
);
1624 struct _mesa_glsl_parse_state
;
1625 struct gl_shader_program
;
1628 * Detect whether an unlinked shader contains static recursion
1630 * If the list of instructions is determined to contain static recursion,
1631 * \c _mesa_glsl_error will be called to emit error messages for each function
1632 * that is in the recursion cycle.
1635 detect_recursion_unlinked(struct _mesa_glsl_parse_state
*state
,
1636 exec_list
*instructions
);
1639 * Detect whether a linked shader contains static recursion
1641 * If the list of instructions is determined to contain static recursion,
1642 * \c link_error_printf will be called to emit error messages for each function
1643 * that is in the recursion cycle. In addition,
1644 * \c gl_shader_program::LinkStatus will be set to false.
1647 detect_recursion_linked(struct gl_shader_program
*prog
,
1648 exec_list
*instructions
);
1651 * Make a clone of each IR instruction in a list
1653 * \param in List of IR instructions that are to be cloned
1654 * \param out List to hold the cloned instructions
1657 clone_ir_list(void *mem_ctx
, exec_list
*out
, const exec_list
*in
);
1660 _mesa_glsl_initialize_variables(exec_list
*instructions
,
1661 struct _mesa_glsl_parse_state
*state
);
1664 _mesa_glsl_initialize_functions(_mesa_glsl_parse_state
*state
);
1667 _mesa_glsl_release_functions(void);
1670 reparent_ir(exec_list
*list
, void *mem_ctx
);
1672 struct glsl_symbol_table
;
1675 import_prototypes(const exec_list
*source
, exec_list
*dest
,
1676 struct glsl_symbol_table
*symbols
, void *mem_ctx
);
1679 ir_has_call(ir_instruction
*ir
);
1682 do_set_program_inouts(exec_list
*instructions
, struct gl_program
*prog
);
1685 prototype_string(const glsl_type
*return_type
, const char *name
,
1686 exec_list
*parameters
);