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()
153 * Get the variable that is ultimately referenced by an r-value
155 virtual ir_variable *variable_referenced()
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_conservative_depth extension allows 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 * Calculate the number of slots required to hold this variable
298 * This is used to determine how many uniform or varying locations a variable
299 * occupies. The count is in units of floating point components.
301 unsigned component_slots() const;
304 * Delcared name of the variable
309 * Highest element accessed with a constant expression array index
311 * Not used for non-array variables.
313 unsigned max_array_access;
316 * Is the variable read-only?
318 * This is set for variables declared as \c const, shader inputs,
321 unsigned read_only:1;
323 unsigned invariant:1;
326 * Has this variable been used for reading or writing?
328 * Several GLSL semantic checks require knowledge of whether or not a
329 * variable has been used. For example, it is an error to redeclare a
330 * variable as invariant after it has been used.
335 * Storage class of the variable.
337 * \sa ir_variable_mode
342 * Interpolation mode for shader inputs / outputs
344 * \sa ir_variable_interpolation
346 unsigned interpolation:2;
349 * \name ARB_fragment_coord_conventions
352 unsigned origin_upper_left:1;
353 unsigned pixel_center_integer:1;
357 * \brief Layout qualifier for gl_FragDepth.
359 * This is not equal to \c ir_depth_layout_none if and only if this
360 * variable is \c gl_FragDepth and a layout qualifier is specified.
362 ir_depth_layout depth_layout;
365 * Was the location explicitly set in the shader?
367 * If the location is explicitly set in the shader, it \b cannot be changed
368 * by the linker or by the API (e.g., calls to \c glBindAttribLocation have
371 unsigned explicit_location:1;
374 * Storage location of the base of this variable
376 * The precise meaning of this field depends on the nature of the variable.
378 * - Vertex shader input: one of the values from \c gl_vert_attrib.
379 * - Vertex shader output: one of the values from \c gl_vert_result.
380 * - Fragment shader input: one of the values from \c gl_frag_attrib.
381 * - Fragment shader output: one of the values from \c gl_frag_result.
382 * - Uniforms: Per-stage uniform slot number.
383 * - Other: This field is not currently used.
385 * If the variable is a uniform, shader input, or shader output, and the
386 * slot has not been assigned, the value will be -1.
391 * Built-in state that backs this uniform
393 * Once set at variable creation, \c state_slots must remain invariant.
394 * This is because, ideally, this array would be shared by all clones of
395 * this variable in the IR tree. In other words, we'd really like for it
396 * to be a fly-weight.
398 * If the variable is not a uniform, \c num_state_slots will be zero and
399 * \c state_slots will be \c NULL.
402 unsigned num_state_slots; /**< Number of state slots used */
403 ir_state_slot *state_slots; /**< State descriptors. */
407 * Emit a warning if this variable is accessed.
409 const char *warn_extension;
412 * Value assigned in the initializer of a variable declared "const"
414 ir_constant *constant_value;
420 * The representation of a function instance; may be the full definition or
421 * simply a prototype.
423 class ir_function_signature : public ir_instruction {
424 /* An ir_function_signature will be part of the list of signatures in
428 ir_function_signature(const glsl_type *return_type);
430 virtual ir_function_signature *clone(void *mem_ctx,
431 struct hash_table *ht) const;
432 ir_function_signature *clone_prototype(void *mem_ctx,
433 struct hash_table *ht) const;
435 virtual void accept(ir_visitor *v)
440 virtual ir_visitor_status accept(ir_hierarchical_visitor *);
443 * Get the name of the function for which this is a signature
445 const char *function_name() const;
448 * Get a handle to the function for which this is a signature
450 * There is no setter function, this function returns a \c const pointer,
451 * and \c ir_function_signature::_function is private for a reason. The
452 * only way to make a connection between a function and function signature
453 * is via \c ir_function::add_signature. This helps ensure that certain
454 * invariants (i.e., a function signature is in the list of signatures for
455 * its \c _function) are met.
457 * \sa ir_function::add_signature
459 inline const class ir_function *function() const
461 return this->_function;
465 * Check whether the qualifiers match between this signature's parameters
466 * and the supplied parameter list. If not, returns the name of the first
467 * parameter with mismatched qualifiers (for use in error messages).
469 const char *qualifiers_match(exec_list *params);
472 * Replace the current parameter list with the given one. This is useful
473 * if the current information came from a prototype, and either has invalid
474 * or missing parameter names.
476 void replace_parameters(exec_list *new_params);
479 * Function return type.
481 * \note This discards the optional precision qualifier.
483 const struct glsl_type *return_type;
486 * List of ir_variable of function parameters.
488 * This represents the storage. The paramaters passed in a particular
489 * call will be in ir_call::actual_paramaters.
491 struct exec_list parameters;
493 /** Whether or not this function has a body (which may be empty). */
494 unsigned is_defined:1;
496 /** Whether or not this function signature is a built-in. */
497 unsigned is_builtin:1;
499 /** Body of instructions in the function. */
500 struct exec_list body;
503 /** Function of which this signature is one overload. */
504 class ir_function *_function;
506 friend class ir_function;
511 * Header for tracking multiple overloaded functions with the same name.
512 * Contains a list of ir_function_signatures representing each of the
515 class ir_function : public ir_instruction {
517 ir_function(const char *name);
519 virtual ir_function *clone(void *mem_ctx, struct hash_table *ht) const;
521 virtual ir_function *as_function()
526 virtual void accept(ir_visitor *v)
531 virtual ir_visitor_status accept(ir_hierarchical_visitor *);
533 void add_signature(ir_function_signature *sig)
535 sig->_function = this;
536 this->signatures.push_tail(sig);
540 * Get an iterator for the set of function signatures
542 exec_list_iterator iterator()
544 return signatures.iterator();
548 * Find a signature that matches a set of actual parameters, taking implicit
549 * conversions into account.
551 ir_function_signature *matching_signature(const exec_list *actual_param);
554 * Find a signature that exactly matches a set of actual parameters without
555 * any implicit type conversions.
557 ir_function_signature *exact_matching_signature(const exec_list *actual_ps);
560 * Name of the function.
564 /** Whether or not this function has a signature that isn't a built-in. */
565 bool has_user_signature();
568 * List of ir_function_signature for each overloaded function with this name.
570 struct exec_list signatures;
573 inline const char *ir_function_signature::function_name() const
575 return this->_function->name;
581 * IR instruction representing high-level if-statements
583 class ir_if : public ir_instruction {
585 ir_if(ir_rvalue *condition)
586 : condition(condition)
588 ir_type = ir_type_if;
591 virtual ir_if *clone(void *mem_ctx, struct hash_table *ht) const;
593 virtual ir_if *as_if()
598 virtual void accept(ir_visitor *v)
603 virtual ir_visitor_status accept(ir_hierarchical_visitor *);
605 ir_rvalue *condition;
606 /** List of ir_instruction for the body of the then branch */
607 exec_list then_instructions;
608 /** List of ir_instruction for the body of the else branch */
609 exec_list else_instructions;
614 * IR instruction representing a high-level loop structure.
616 class ir_loop : public ir_instruction {
620 virtual ir_loop *clone(void *mem_ctx, struct hash_table *ht) const;
622 virtual void accept(ir_visitor *v)
627 virtual ir_visitor_status accept(ir_hierarchical_visitor *);
629 virtual ir_loop *as_loop()
635 * Get an iterator for the instructions of the loop body
637 exec_list_iterator iterator()
639 return body_instructions.iterator();
642 /** List of ir_instruction that make up the body of the loop. */
643 exec_list body_instructions;
646 * \name Loop counter and controls
648 * Represents a loop like a FORTRAN \c do-loop.
651 * If \c from and \c to are the same value, the loop will execute once.
654 ir_rvalue *from; /** Value of the loop counter on the first
655 * iteration of the loop.
657 ir_rvalue *to; /** Value of the loop counter on the last
658 * iteration of the loop.
660 ir_rvalue *increment;
661 ir_variable *counter;
664 * Comparison operation in the loop terminator.
666 * If any of the loop control fields are non-\c NULL, this field must be
667 * one of \c ir_binop_less, \c ir_binop_greater, \c ir_binop_lequal,
668 * \c ir_binop_gequal, \c ir_binop_equal, or \c ir_binop_nequal.
675 class ir_assignment : public ir_instruction {
677 ir_assignment(ir_rvalue *lhs, ir_rvalue *rhs, ir_rvalue *condition = NULL);
680 * Construct an assignment with an explicit write mask
683 * Since a write mask is supplied, the LHS must already be a bare
684 * \c ir_dereference. The cannot be any swizzles in the LHS.
686 ir_assignment(ir_dereference *lhs, ir_rvalue *rhs, ir_rvalue *condition,
687 unsigned write_mask);
689 virtual ir_assignment *clone(void *mem_ctx, struct hash_table *ht) const;
691 virtual ir_constant *constant_expression_value();
693 virtual void accept(ir_visitor *v)
698 virtual ir_visitor_status accept(ir_hierarchical_visitor *);
700 virtual ir_assignment * as_assignment()
706 * Get a whole variable written by an assignment
708 * If the LHS of the assignment writes a whole variable, the variable is
709 * returned. Otherwise \c NULL is returned. Examples of whole-variable
712 * - Assigning to a scalar
713 * - Assigning to all components of a vector
714 * - Whole array (or matrix) assignment
715 * - Whole structure assignment
717 ir_variable *whole_variable_written();
720 * Set the LHS of an assignment
722 void set_lhs(ir_rvalue *lhs);
725 * Left-hand side of the assignment.
727 * This should be treated as read only. If you need to set the LHS of an
728 * assignment, use \c ir_assignment::set_lhs.
733 * Value being assigned
738 * Optional condition for the assignment.
740 ir_rvalue *condition;
744 * Component mask written
746 * For non-vector types in the LHS, this field will be zero. For vector
747 * types, a bit will be set for each component that is written. Note that
748 * for \c vec2 and \c vec3 types only the lower bits will ever be set.
750 * A partially-set write mask means that each enabled channel gets
751 * the value from a consecutive channel of the rhs. For example,
752 * to write just .xyw of gl_FrontColor with color:
754 * (assign (constant bool (1)) (xyw)
755 * (var_ref gl_FragColor)
756 * (swiz xyw (var_ref color)))
758 unsigned write_mask:4;
761 /* Update ir_expression::num_operands() and operator_strs when
762 * updating this list.
764 enum ir_expression_operation {
773 ir_unop_exp, /**< Log base e on gentype */
774 ir_unop_log, /**< Natural log on gentype */
777 ir_unop_f2i, /**< Float-to-integer conversion. */
778 ir_unop_i2f, /**< Integer-to-float conversion. */
779 ir_unop_f2b, /**< Float-to-boolean conversion */
780 ir_unop_b2f, /**< Boolean-to-float conversion */
781 ir_unop_i2b, /**< int-to-boolean conversion */
782 ir_unop_b2i, /**< Boolean-to-int conversion */
783 ir_unop_u2f, /**< Unsigned-to-float conversion. */
787 * \name Unary floating-point rounding operations.
798 * \name Trigonometric operations.
803 ir_unop_sin_reduced, /**< Reduced range sin. [-pi, pi] */
804 ir_unop_cos_reduced, /**< Reduced range cos. [-pi, pi] */
808 * \name Partial derivatives.
818 * A sentinel marking the last of the unary operations.
820 ir_last_unop = ir_unop_noise,
828 * Takes one of two combinations of arguments:
833 * Does not take integer types.
838 * \name Binary comparison operators which return a boolean vector.
839 * The type of both operands must be equal.
849 * Returns single boolean for whether all components of operands[0]
850 * equal the components of operands[1].
854 * Returns single boolean for whether any component of operands[0]
855 * is not equal to the corresponding component of operands[1].
861 * \name Bit-wise binary operations.
882 * A sentinel marking the last of the binary operations.
884 ir_last_binop = ir_binop_pow,
889 * A sentinel marking the last of all operations.
891 ir_last_opcode = ir_last_binop
894 class ir_expression : public ir_rvalue {
897 * Constructor for unary operation expressions
899 ir_expression(int op, const struct glsl_type *type, ir_rvalue *);
900 ir_expression(int op, ir_rvalue *);
903 * Constructor for binary operation expressions
905 ir_expression(int op, const struct glsl_type *type,
906 ir_rvalue *, ir_rvalue *);
907 ir_expression(int op, ir_rvalue *op0, ir_rvalue *op1);
910 * Constructor for quad operator expressions
912 ir_expression(int op, const struct glsl_type *type,
913 ir_rvalue *, ir_rvalue *, ir_rvalue *, ir_rvalue *);
915 virtual ir_expression *as_expression()
920 virtual ir_expression *clone(void *mem_ctx, struct hash_table *ht) const;
923 * Attempt to constant-fold the expression
925 * If the expression cannot be constant folded, this method will return
928 virtual ir_constant *constant_expression_value();
931 * Determine the number of operands used by an expression
933 static unsigned int get_num_operands(ir_expression_operation);
936 * Determine the number of operands used by an expression
938 unsigned int get_num_operands() const
940 return (this->operation == ir_quadop_vector)
941 ? this->type->vector_elements : get_num_operands(operation);
945 * Return a string representing this expression's operator.
947 const char *operator_string();
950 * Return a string representing this expression's operator.
952 static const char *operator_string(ir_expression_operation);
956 * Do a reverse-lookup to translate the given string into an operator.
958 static ir_expression_operation get_operator(const char *);
960 virtual void accept(ir_visitor *v)
965 virtual ir_visitor_status accept(ir_hierarchical_visitor *);
967 ir_expression_operation operation;
968 ir_rvalue *operands[4];
973 * IR instruction representing a function call
975 class ir_call : public ir_rvalue {
977 ir_call(ir_function_signature *callee, exec_list *actual_parameters)
980 ir_type = ir_type_call;
981 assert(callee->return_type != NULL);
982 type = callee->return_type;
983 actual_parameters->move_nodes_to(& this->actual_parameters);
984 this->use_builtin = callee->is_builtin;
987 virtual ir_call *clone(void *mem_ctx, struct hash_table *ht) const;
989 virtual ir_constant *constant_expression_value();
991 virtual ir_call *as_call()
996 virtual void accept(ir_visitor *v)
1001 virtual ir_visitor_status accept(ir_hierarchical_visitor *);
1004 * Get a generic ir_call object when an error occurs
1006 * Any allocation will be performed with 'ctx' as ralloc owner.
1008 static ir_call *get_error_instruction(void *ctx);
1011 * Get an iterator for the set of acutal parameters
1013 exec_list_iterator iterator()
1015 return actual_parameters.iterator();
1019 * Get the name of the function being called.
1021 const char *callee_name() const
1023 return callee->function_name();
1027 * Get the function signature bound to this function call
1029 ir_function_signature *get_callee()
1035 * Set the function call target
1037 void set_callee(ir_function_signature *sig);
1040 * Generates an inline version of the function before @ir,
1041 * returning the return value of the function.
1043 ir_rvalue *generate_inline(ir_instruction *ir);
1045 /* List of ir_rvalue of paramaters passed in this call. */
1046 exec_list actual_parameters;
1048 /** Should this call only bind to a built-in function? */
1055 this->ir_type = ir_type_call;
1058 ir_function_signature *callee;
1063 * \name Jump-like IR instructions.
1065 * These include \c break, \c continue, \c return, and \c discard.
1068 class ir_jump : public ir_instruction {
1072 ir_type = ir_type_unset;
1076 class ir_return : public ir_jump {
1081 this->ir_type = ir_type_return;
1084 ir_return(ir_rvalue *value)
1087 this->ir_type = ir_type_return;
1090 virtual ir_return *clone(void *mem_ctx, struct hash_table *) const;
1092 virtual ir_return *as_return()
1097 ir_rvalue *get_value() const
1102 virtual void accept(ir_visitor *v)
1107 virtual ir_visitor_status accept(ir_hierarchical_visitor *);
1114 * Jump instructions used inside loops
1116 * These include \c break and \c continue. The \c break within a loop is
1117 * different from the \c break within a switch-statement.
1119 * \sa ir_switch_jump
1121 class ir_loop_jump : public ir_jump {
1128 ir_loop_jump(jump_mode mode)
1130 this->ir_type = ir_type_loop_jump;
1135 virtual ir_loop_jump *clone(void *mem_ctx, struct hash_table *) const;
1137 virtual void accept(ir_visitor *v)
1142 virtual ir_visitor_status accept(ir_hierarchical_visitor *);
1144 bool is_break() const
1146 return mode == jump_break;
1149 bool is_continue() const
1151 return mode == jump_continue;
1154 /** Mode selector for the jump instruction. */
1155 enum jump_mode mode;
1157 /** Loop containing this break instruction. */
1162 * IR instruction representing discard statements.
1164 class ir_discard : public ir_jump {
1168 this->ir_type = ir_type_discard;
1169 this->condition = NULL;
1172 ir_discard(ir_rvalue *cond)
1174 this->ir_type = ir_type_discard;
1175 this->condition = cond;
1178 virtual ir_discard *clone(void *mem_ctx, struct hash_table *ht) const;
1180 virtual void accept(ir_visitor *v)
1185 virtual ir_visitor_status accept(ir_hierarchical_visitor *);
1187 virtual ir_discard *as_discard()
1192 ir_rvalue *condition;
1198 * Texture sampling opcodes used in ir_texture
1200 enum ir_texture_opcode {
1201 ir_tex, /**< Regular texture look-up */
1202 ir_txb, /**< Texture look-up with LOD bias */
1203 ir_txl, /**< Texture look-up with explicit LOD */
1204 ir_txd, /**< Texture look-up with partial derivatvies */
1205 ir_txf /**< Texel fetch with explicit LOD */
1210 * IR instruction to sample a texture
1212 * The specific form of the IR instruction depends on the \c mode value
1213 * selected from \c ir_texture_opcodes. In the printed IR, these will
1216 * Texel offset (0 or an expression)
1217 * | Projection divisor
1218 * | | Shadow comparitor
1221 * (tex <type> <sampler> <coordinate> 0 1 ( ))
1222 * (txb <type> <sampler> <coordinate> 0 1 ( ) <bias>)
1223 * (txl <type> <sampler> <coordinate> 0 1 ( ) <lod>)
1224 * (txd <type> <sampler> <coordinate> 0 1 ( ) (dPdx dPdy))
1225 * (txf <type> <sampler> <coordinate> 0 <lod>)
1227 class ir_texture : public ir_rvalue {
1229 ir_texture(enum ir_texture_opcode op)
1230 : op(op), projector(NULL), shadow_comparitor(NULL), offset(NULL)
1232 this->ir_type = ir_type_texture;
1235 virtual ir_texture *clone(void *mem_ctx, struct hash_table *) const;
1237 virtual ir_constant *constant_expression_value();
1239 virtual void accept(ir_visitor *v)
1244 virtual ir_visitor_status accept(ir_hierarchical_visitor *);
1247 * Return a string representing the ir_texture_opcode.
1249 const char *opcode_string();
1251 /** Set the sampler and type. */
1252 void set_sampler(ir_dereference *sampler, const glsl_type *type);
1255 * Do a reverse-lookup to translate a string into an ir_texture_opcode.
1257 static ir_texture_opcode get_opcode(const char *);
1259 enum ir_texture_opcode op;
1261 /** Sampler to use for the texture access. */
1262 ir_dereference *sampler;
1264 /** Texture coordinate to sample */
1265 ir_rvalue *coordinate;
1268 * Value used for projective divide.
1270 * If there is no projective divide (the common case), this will be
1271 * \c NULL. Optimization passes should check for this to point to a constant
1272 * of 1.0 and replace that with \c NULL.
1274 ir_rvalue *projector;
1277 * Coordinate used for comparison on shadow look-ups.
1279 * If there is no shadow comparison, this will be \c NULL. For the
1280 * \c ir_txf opcode, this *must* be \c NULL.
1282 ir_rvalue *shadow_comparitor;
1284 /** Texel offset. */
1288 ir_rvalue *lod; /**< Floating point LOD */
1289 ir_rvalue *bias; /**< Floating point LOD bias */
1291 ir_rvalue *dPdx; /**< Partial derivative of coordinate wrt X */
1292 ir_rvalue *dPdy; /**< Partial derivative of coordinate wrt Y */
1298 struct ir_swizzle_mask {
1305 * Number of components in the swizzle.
1307 unsigned num_components:3;
1310 * Does the swizzle contain duplicate components?
1312 * L-value swizzles cannot contain duplicate components.
1314 unsigned has_duplicates:1;
1318 class ir_swizzle : public ir_rvalue {
1320 ir_swizzle(ir_rvalue *, unsigned x, unsigned y, unsigned z, unsigned w,
1323 ir_swizzle(ir_rvalue *val, const unsigned *components, unsigned count);
1325 ir_swizzle(ir_rvalue *val, ir_swizzle_mask mask);
1327 virtual ir_swizzle *clone(void *mem_ctx, struct hash_table *) const;
1329 virtual ir_constant *constant_expression_value();
1331 virtual ir_swizzle *as_swizzle()
1337 * Construct an ir_swizzle from the textual representation. Can fail.
1339 static ir_swizzle *create(ir_rvalue *, const char *, unsigned vector_length);
1341 virtual void accept(ir_visitor *v)
1346 virtual ir_visitor_status accept(ir_hierarchical_visitor *);
1350 return val->is_lvalue() && !mask.has_duplicates;
1354 * Get the variable that is ultimately referenced by an r-value
1356 virtual ir_variable *variable_referenced();
1359 ir_swizzle_mask mask;
1363 * Initialize the mask component of a swizzle
1365 * This is used by the \c ir_swizzle constructors.
1367 void init_mask(const unsigned *components, unsigned count);
1371 class ir_dereference : public ir_rvalue {
1373 virtual ir_dereference *clone(void *mem_ctx, struct hash_table *) const = 0;
1375 virtual ir_dereference *as_dereference()
1383 * Get the variable that is ultimately referenced by an r-value
1385 virtual ir_variable *variable_referenced() = 0;
1389 class ir_dereference_variable : public ir_dereference {
1391 ir_dereference_variable(ir_variable *var);
1393 virtual ir_dereference_variable *clone(void *mem_ctx,
1394 struct hash_table *) const;
1396 virtual ir_constant *constant_expression_value();
1398 virtual ir_dereference_variable *as_dereference_variable()
1404 * Get the variable that is ultimately referenced by an r-value
1406 virtual ir_variable *variable_referenced()
1411 virtual ir_variable *whole_variable_referenced()
1413 /* ir_dereference_variable objects always dereference the entire
1414 * variable. However, if this dereference is dereferenced by anything
1415 * else, the complete deferefernce chain is not a whole-variable
1416 * dereference. This method should only be called on the top most
1417 * ir_rvalue in a dereference chain.
1422 virtual void accept(ir_visitor *v)
1427 virtual ir_visitor_status accept(ir_hierarchical_visitor *);
1430 * Object being dereferenced.
1436 class ir_dereference_array : public ir_dereference {
1438 ir_dereference_array(ir_rvalue *value, ir_rvalue *array_index);
1440 ir_dereference_array(ir_variable *var, ir_rvalue *array_index);
1442 virtual ir_dereference_array *clone(void *mem_ctx,
1443 struct hash_table *) const;
1445 virtual ir_constant *constant_expression_value();
1447 virtual ir_dereference_array *as_dereference_array()
1453 * Get the variable that is ultimately referenced by an r-value
1455 virtual ir_variable *variable_referenced()
1457 return this->array->variable_referenced();
1460 virtual void accept(ir_visitor *v)
1465 virtual ir_visitor_status accept(ir_hierarchical_visitor *);
1468 ir_rvalue *array_index;
1471 void set_array(ir_rvalue *value);
1475 class ir_dereference_record : public ir_dereference {
1477 ir_dereference_record(ir_rvalue *value, const char *field);
1479 ir_dereference_record(ir_variable *var, const char *field);
1481 virtual ir_dereference_record *clone(void *mem_ctx,
1482 struct hash_table *) const;
1484 virtual ir_constant *constant_expression_value();
1487 * Get the variable that is ultimately referenced by an r-value
1489 virtual ir_variable *variable_referenced()
1491 return this->record->variable_referenced();
1494 virtual void accept(ir_visitor *v)
1499 virtual ir_visitor_status accept(ir_hierarchical_visitor *);
1507 * Data stored in an ir_constant
1509 union ir_constant_data {
1517 class ir_constant : public ir_rvalue {
1519 ir_constant(const struct glsl_type *type, const ir_constant_data *data);
1520 ir_constant(bool b);
1521 ir_constant(unsigned int u);
1523 ir_constant(float f);
1526 * Construct an ir_constant from a list of ir_constant values
1528 ir_constant(const struct glsl_type *type, exec_list *values);
1531 * Construct an ir_constant from a scalar component of another ir_constant
1533 * The new \c ir_constant inherits the type of the component from the
1537 * In the case of a matrix constant, the new constant is a scalar, \b not
1540 ir_constant(const ir_constant *c, unsigned i);
1543 * Return a new ir_constant of the specified type containing all zeros.
1545 static ir_constant *zero(void *mem_ctx, const glsl_type *type);
1547 virtual ir_constant *clone(void *mem_ctx, struct hash_table *) const;
1549 virtual ir_constant *constant_expression_value();
1551 virtual ir_constant *as_constant()
1556 virtual void accept(ir_visitor *v)
1561 virtual ir_visitor_status accept(ir_hierarchical_visitor *);
1564 * Get a particular component of a constant as a specific type
1566 * This is useful, for example, to get a value from an integer constant
1567 * as a float or bool. This appears frequently when constructors are
1568 * called with all constant parameters.
1571 bool get_bool_component(unsigned i) const;
1572 float get_float_component(unsigned i) const;
1573 int get_int_component(unsigned i) const;
1574 unsigned get_uint_component(unsigned i) const;
1577 ir_constant *get_array_element(unsigned i) const;
1579 ir_constant *get_record_field(const char *name);
1582 * Determine whether a constant has the same value as another constant
1584 * \sa ir_constant::is_zero, ir_constant::is_one,
1585 * ir_constant::is_negative_one
1587 bool has_value(const ir_constant *) const;
1589 virtual bool is_zero() const;
1590 virtual bool is_one() const;
1591 virtual bool is_negative_one() const;
1594 * Value of the constant.
1596 * The field used to back the values supplied by the constant is determined
1597 * by the type associated with the \c ir_instruction. Constants may be
1598 * scalars, vectors, or matrices.
1600 union ir_constant_data value;
1602 /* Array elements */
1603 ir_constant **array_elements;
1605 /* Structure fields */
1606 exec_list components;
1610 * Parameterless constructor only used by the clone method
1618 * Apply a visitor to each IR node in a list
1621 visit_exec_list(exec_list *list, ir_visitor *visitor);
1624 * Validate invariants on each IR node in a list
1626 void validate_ir_tree(exec_list *instructions);
1628 struct _mesa_glsl_parse_state;
1629 struct gl_shader_program;
1632 * Detect whether an unlinked shader contains static recursion
1634 * If the list of instructions is determined to contain static recursion,
1635 * \c _mesa_glsl_error will be called to emit error messages for each function
1636 * that is in the recursion cycle.
1639 detect_recursion_unlinked(struct _mesa_glsl_parse_state *state,
1640 exec_list *instructions);
1643 * Detect whether a linked shader contains static recursion
1645 * If the list of instructions is determined to contain static recursion,
1646 * \c link_error_printf will be called to emit error messages for each function
1647 * that is in the recursion cycle. In addition,
1648 * \c gl_shader_program::LinkStatus will be set to false.
1651 detect_recursion_linked(struct gl_shader_program *prog,
1652 exec_list *instructions);
1655 * Make a clone of each IR instruction in a list
1657 * \param in List of IR instructions that are to be cloned
1658 * \param out List to hold the cloned instructions
1661 clone_ir_list(void *mem_ctx, exec_list *out, const exec_list *in);
1664 _mesa_glsl_initialize_variables(exec_list *instructions,
1665 struct _mesa_glsl_parse_state *state);
1668 _mesa_glsl_initialize_functions(_mesa_glsl_parse_state *state);
1671 _mesa_glsl_release_functions(void);
1674 reparent_ir(exec_list *list, void *mem_ctx);
1676 struct glsl_symbol_table;
1679 import_prototypes(const exec_list *source, exec_list *dest,
1680 struct glsl_symbol_table *symbols, void *mem_ctx);
1683 ir_has_call(ir_instruction *ir);
1686 do_set_program_inouts(exec_list *instructions, struct gl_program *prog);
1689 prototype_string(const glsl_type *return_type, const char *name,
1690 exec_list *parameters);