3 * Copyright © 2010 Intel Corporation
5 * Permission is hereby granted, free of charge, to any person obtaining a
6 * copy of this software and associated documentation files (the "Software"),
7 * to deal in the Software without restriction, including without limitation
8 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
9 * and/or sell copies of the Software, and to permit persons to whom the
10 * Software is furnished to do so, subject to the following conditions:
12 * The above copyright notice and this permission notice (including the next
13 * paragraph) shall be included in all copies or substantial portions of the
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
19 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
21 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
22 * DEALINGS IN THE SOFTWARE.
36 #include "glsl_types.h"
38 #include "ir_visitor.h"
39 #include "ir_hierarchical_visitor.h"
42 * \defgroup IR Intermediate representation nodes
50 * Each concrete class derived from \c ir_instruction has a value in this
51 * enumerant. The value for the type is stored in \c ir_instruction::ir_type
52 * by the constructor. While using type tags is not very C++, it is extremely
53 * convenient. For example, during debugging you can simply inspect
54 * \c ir_instruction::ir_type to find out the actual type of the object.
56 * In addition, it is possible to use a switch-statement based on \c
57 * \c ir_instruction::ir_type to select different behavior for different object
58 * types. For functions that have only slight differences for several object
59 * types, this allows writing very straightforward, readable code.
63 * Zero is unused so that the IR validator can detect cases where
64 * \c ir_instruction::ir_type has not been initialized.
71 ir_type_dereference_array,
72 ir_type_dereference_record,
73 ir_type_dereference_variable,
77 ir_type_function_signature,
84 ir_type_max /**< maximum ir_type enum number, for validation */
88 * Base class of all IR instructions
90 class ir_instruction : public exec_node {
92 enum ir_node_type ir_type;
93 const struct glsl_type *type;
95 /** ir_print_visitor helper for debugging. */
96 void print(void) const;
98 virtual void accept(ir_visitor *) = 0;
99 virtual ir_visitor_status accept(ir_hierarchical_visitor *) = 0;
100 virtual ir_instruction *clone(void *mem_ctx,
101 struct hash_table *ht) const = 0;
104 * \name IR instruction downcast functions
106 * These functions either cast the object to a derived class or return
107 * \c NULL if the object's type does not match the specified derived class.
108 * Additional downcast functions will be added as needed.
111 virtual class ir_variable * as_variable() { return NULL; }
112 virtual class ir_function * as_function() { return NULL; }
113 virtual class ir_dereference * as_dereference() { return NULL; }
114 virtual class ir_dereference_array * as_dereference_array() { return NULL; }
115 virtual class ir_dereference_variable *as_dereference_variable() { return NULL; }
116 virtual class ir_expression * as_expression() { return NULL; }
117 virtual class ir_rvalue * as_rvalue() { return NULL; }
118 virtual class ir_loop * as_loop() { return NULL; }
119 virtual class ir_assignment * as_assignment() { return NULL; }
120 virtual class ir_call * as_call() { return NULL; }
121 virtual class ir_return * as_return() { return NULL; }
122 virtual class ir_if * as_if() { return NULL; }
123 virtual class ir_swizzle * as_swizzle() { return NULL; }
124 virtual class ir_constant * as_constant() { return NULL; }
125 virtual class ir_discard * as_discard() { return NULL; }
131 ir_type = ir_type_unset;
137 class ir_rvalue : public ir_instruction {
139 virtual ir_rvalue *clone(void *mem_ctx, struct hash_table *) const = 0;
141 virtual ir_constant *constant_expression_value() = 0;
143 virtual ir_rvalue * as_rvalue()
148 ir_rvalue *as_rvalue_to_saturate();
150 virtual bool is_lvalue()
156 * Get the variable that is ultimately referenced by an r-value
158 virtual ir_variable *variable_referenced()
165 * If an r-value is a reference to a whole variable, get that variable
168 * Pointer to a variable that is completely dereferenced by the r-value. If
169 * the r-value is not a dereference or the dereference does not access the
170 * entire variable (i.e., it's just one array element, struct field), \c NULL
173 virtual ir_variable *whole_variable_referenced()
179 * Determine if an r-value has the value zero
181 * The base implementation of this function always returns \c false. The
182 * \c ir_constant class over-rides this function to return \c true \b only
183 * for vector and scalar types that have all elements set to the value
184 * zero (or \c false for booleans).
186 * \sa ir_constant::has_value, ir_rvalue::is_one, ir_rvalue::is_negative_one
188 virtual bool is_zero() const;
191 * Determine if an r-value has the value one
193 * The base implementation of this function always returns \c false. The
194 * \c ir_constant class over-rides this function to return \c true \b only
195 * for vector and scalar types that have all elements set to the value
196 * one (or \c true for booleans).
198 * \sa ir_constant::has_value, ir_rvalue::is_zero, ir_rvalue::is_negative_one
200 virtual bool is_one() const;
203 * Determine if an r-value has the value negative one
205 * The base implementation of this function always returns \c false. The
206 * \c ir_constant class over-rides this function to return \c true \b only
207 * for vector and scalar types that have all elements set to the value
208 * negative one. For boolean times, the result is always \c false.
210 * \sa ir_constant::has_value, ir_rvalue::is_zero, ir_rvalue::is_one
212 virtual bool is_negative_one() const;
220 * Variable storage classes
222 enum ir_variable_mode {
223 ir_var_auto = 0, /**< Function local variables and globals. */
224 ir_var_uniform, /**< Variable declared as a uniform. */
228 ir_var_system_value, /**< Ex: front-face, instance-id, etc. */
229 ir_var_temporary /**< Temporary variable generated during compilation. */
232 enum ir_variable_interpolation {
239 class ir_variable : public ir_instruction {
241 ir_variable(const struct glsl_type *, const char *, ir_variable_mode);
243 virtual ir_variable *clone(void *mem_ctx, struct hash_table *ht) const;
245 virtual ir_variable *as_variable()
250 virtual void accept(ir_visitor *v)
255 virtual ir_visitor_status accept(ir_hierarchical_visitor *);
259 * Get the string value for the interpolation qualifier
261 * \return The string that would be used in a shader to specify \c
262 * mode will be returned.
264 * This function should only be used on a shader input or output variable.
266 const char *interpolation_string() const;
269 * Calculate the number of slots required to hold this variable
271 * This is used to determine how many uniform or varying locations a variable
272 * occupies. The count is in units of floating point components.
274 unsigned component_slots() const;
277 * Delcared name of the variable
282 * Highest element accessed with a constant expression array index
284 * Not used for non-array variables.
286 unsigned max_array_access;
289 * Is the variable read-only?
291 * This is set for variables declared as \c const, shader inputs,
294 unsigned read_only:1;
296 unsigned invariant:1;
299 * Has this variable been used for reading or writing?
301 * Several GLSL semantic checks require knowledge of whether or not a
302 * variable has been used. For example, it is an error to redeclare a
303 * variable as invariant after it has been used.
308 * Storage class of the variable.
310 * \sa ir_variable_mode
315 * Interpolation mode for shader inputs / outputs
317 * \sa ir_variable_interpolation
319 unsigned interpolation:2;
322 * Flag that the whole array is assignable
324 * In GLSL 1.20 and later whole arrays are assignable (and comparable for
325 * equality). This flag enables this behavior.
327 unsigned array_lvalue:1;
330 * \name ARB_fragment_coord_conventions
333 unsigned origin_upper_left:1;
334 unsigned pixel_center_integer:1;
338 * Was the location explicitly set in the shader?
340 * If the location is explicitly set in the shader, it \b cannot be changed
341 * by the linker or by the API (e.g., calls to \c glBindAttribLocation have
344 unsigned explicit_location:1;
347 * Storage location of the base of this variable
349 * The precise meaning of this field depends on the nature of the variable.
351 * - Vertex shader input: one of the values from \c gl_vert_attrib.
352 * - Vertex shader output: one of the values from \c gl_vert_result.
353 * - Fragment shader input: one of the values from \c gl_frag_attrib.
354 * - Fragment shader output: one of the values from \c gl_frag_result.
355 * - Uniforms: Per-stage uniform slot number.
356 * - Other: This field is not currently used.
358 * If the variable is a uniform, shader input, or shader output, and the
359 * slot has not been assigned, the value will be -1.
364 * Emit a warning if this variable is accessed.
366 const char *warn_extension;
369 * Value assigned in the initializer of a variable declared "const"
371 ir_constant *constant_value;
377 * The representation of a function instance; may be the full definition or
378 * simply a prototype.
380 class ir_function_signature : public ir_instruction {
381 /* An ir_function_signature will be part of the list of signatures in
385 ir_function_signature(const glsl_type *return_type);
387 virtual ir_function_signature *clone(void *mem_ctx,
388 struct hash_table *ht) const;
389 ir_function_signature *clone_prototype(void *mem_ctx,
390 struct hash_table *ht) const;
392 virtual void accept(ir_visitor *v)
397 virtual ir_visitor_status accept(ir_hierarchical_visitor *);
400 * Get the name of the function for which this is a signature
402 const char *function_name() const;
405 * Get a handle to the function for which this is a signature
407 * There is no setter function, this function returns a \c const pointer,
408 * and \c ir_function_signature::_function is private for a reason. The
409 * only way to make a connection between a function and function signature
410 * is via \c ir_function::add_signature. This helps ensure that certain
411 * invariants (i.e., a function signature is in the list of signatures for
412 * its \c _function) are met.
414 * \sa ir_function::add_signature
416 inline const class ir_function *function() const
418 return this->_function;
422 * Check whether the qualifiers match between this signature's parameters
423 * and the supplied parameter list. If not, returns the name of the first
424 * parameter with mismatched qualifiers (for use in error messages).
426 const char *qualifiers_match(exec_list *params);
429 * Replace the current parameter list with the given one. This is useful
430 * if the current information came from a prototype, and either has invalid
431 * or missing parameter names.
433 void replace_parameters(exec_list *new_params);
436 * Function return type.
438 * \note This discards the optional precision qualifier.
440 const struct glsl_type *return_type;
443 * List of ir_variable of function parameters.
445 * This represents the storage. The paramaters passed in a particular
446 * call will be in ir_call::actual_paramaters.
448 struct exec_list parameters;
450 /** Whether or not this function has a body (which may be empty). */
451 unsigned is_defined:1;
453 /** Whether or not this function signature is a built-in. */
454 unsigned is_builtin:1;
456 /** Body of instructions in the function. */
457 struct exec_list body;
460 /** Function of which this signature is one overload. */
461 class ir_function *_function;
463 friend class ir_function;
468 * Header for tracking multiple overloaded functions with the same name.
469 * Contains a list of ir_function_signatures representing each of the
472 class ir_function : public ir_instruction {
474 ir_function(const char *name);
476 virtual ir_function *clone(void *mem_ctx, struct hash_table *ht) const;
478 virtual ir_function *as_function()
483 virtual void accept(ir_visitor *v)
488 virtual ir_visitor_status accept(ir_hierarchical_visitor *);
490 void add_signature(ir_function_signature *sig)
492 sig->_function = this;
493 this->signatures.push_tail(sig);
497 * Get an iterator for the set of function signatures
499 exec_list_iterator iterator()
501 return signatures.iterator();
505 * Find a signature that matches a set of actual parameters, taking implicit
506 * conversions into account.
508 ir_function_signature *matching_signature(const exec_list *actual_param);
511 * Find a signature that exactly matches a set of actual parameters without
512 * any implicit type conversions.
514 ir_function_signature *exact_matching_signature(const exec_list *actual_ps);
517 * Name of the function.
521 /** Whether or not this function has a signature that isn't a built-in. */
522 bool has_user_signature();
525 * List of ir_function_signature for each overloaded function with this name.
527 struct exec_list signatures;
530 inline const char *ir_function_signature::function_name() const
532 return this->_function->name;
538 * IR instruction representing high-level if-statements
540 class ir_if : public ir_instruction {
542 ir_if(ir_rvalue *condition)
543 : condition(condition)
545 ir_type = ir_type_if;
548 virtual ir_if *clone(void *mem_ctx, struct hash_table *ht) const;
550 virtual ir_if *as_if()
555 virtual void accept(ir_visitor *v)
560 virtual ir_visitor_status accept(ir_hierarchical_visitor *);
562 ir_rvalue *condition;
563 /** List of ir_instruction for the body of the then branch */
564 exec_list then_instructions;
565 /** List of ir_instruction for the body of the else branch */
566 exec_list else_instructions;
571 * IR instruction representing a high-level loop structure.
573 class ir_loop : public ir_instruction {
577 virtual ir_loop *clone(void *mem_ctx, struct hash_table *ht) const;
579 virtual void accept(ir_visitor *v)
584 virtual ir_visitor_status accept(ir_hierarchical_visitor *);
586 virtual ir_loop *as_loop()
592 * Get an iterator for the instructions of the loop body
594 exec_list_iterator iterator()
596 return body_instructions.iterator();
599 /** List of ir_instruction that make up the body of the loop. */
600 exec_list body_instructions;
603 * \name Loop counter and controls
605 * Represents a loop like a FORTRAN \c do-loop.
608 * If \c from and \c to are the same value, the loop will execute once.
611 ir_rvalue *from; /** Value of the loop counter on the first
612 * iteration of the loop.
614 ir_rvalue *to; /** Value of the loop counter on the last
615 * iteration of the loop.
617 ir_rvalue *increment;
618 ir_variable *counter;
621 * Comparison operation in the loop terminator.
623 * If any of the loop control fields are non-\c NULL, this field must be
624 * one of \c ir_binop_less, \c ir_binop_greater, \c ir_binop_lequal,
625 * \c ir_binop_gequal, \c ir_binop_equal, or \c ir_binop_nequal.
632 class ir_assignment : public ir_instruction {
634 ir_assignment(ir_rvalue *lhs, ir_rvalue *rhs, ir_rvalue *condition);
637 * Construct an assignment with an explicit write mask
640 * Since a write mask is supplied, the LHS must already be a bare
641 * \c ir_dereference. The cannot be any swizzles in the LHS.
643 ir_assignment(ir_dereference *lhs, ir_rvalue *rhs, ir_rvalue *condition,
644 unsigned write_mask);
646 virtual ir_assignment *clone(void *mem_ctx, struct hash_table *ht) const;
648 virtual ir_constant *constant_expression_value();
650 virtual void accept(ir_visitor *v)
655 virtual ir_visitor_status accept(ir_hierarchical_visitor *);
657 virtual ir_assignment * as_assignment()
663 * Get a whole variable written by an assignment
665 * If the LHS of the assignment writes a whole variable, the variable is
666 * returned. Otherwise \c NULL is returned. Examples of whole-variable
669 * - Assigning to a scalar
670 * - Assigning to all components of a vector
671 * - Whole array (or matrix) assignment
672 * - Whole structure assignment
674 ir_variable *whole_variable_written();
677 * Set the LHS of an assignment
679 void set_lhs(ir_rvalue *lhs);
682 * Left-hand side of the assignment.
684 * This should be treated as read only. If you need to set the LHS of an
685 * assignment, use \c ir_assignment::set_lhs.
690 * Value being assigned
695 * Optional condition for the assignment.
697 ir_rvalue *condition;
701 * Component mask written
703 * For non-vector types in the LHS, this field will be zero. For vector
704 * types, a bit will be set for each component that is written. Note that
705 * for \c vec2 and \c vec3 types only the lower bits will ever be set.
707 * A partially-set write mask means that each enabled channel gets
708 * the value from a consecutive channel of the rhs. For example,
709 * to write just .xyw of gl_FrontColor with color:
711 * (assign (constant bool (1)) (xyw)
712 * (var_ref gl_FragColor)
713 * (swiz xyw (var_ref color)))
715 unsigned write_mask:4;
718 /* Update ir_expression::num_operands() and operator_strs when
719 * updating this list.
721 enum ir_expression_operation {
730 ir_unop_exp, /**< Log base e on gentype */
731 ir_unop_log, /**< Natural log on gentype */
734 ir_unop_f2i, /**< Float-to-integer conversion. */
735 ir_unop_i2f, /**< Integer-to-float conversion. */
736 ir_unop_f2b, /**< Float-to-boolean conversion */
737 ir_unop_b2f, /**< Boolean-to-float conversion */
738 ir_unop_i2b, /**< int-to-boolean conversion */
739 ir_unop_b2i, /**< Boolean-to-int conversion */
740 ir_unop_u2f, /**< Unsigned-to-float conversion. */
744 * \name Unary floating-point rounding operations.
755 * \name Trigonometric operations.
760 ir_unop_sin_reduced, /**< Reduced range sin. [-pi, pi] */
761 ir_unop_cos_reduced, /**< Reduced range cos. [-pi, pi] */
765 * \name Partial derivatives.
775 * A sentinel marking the last of the unary operations.
777 ir_last_unop = ir_unop_noise,
785 * Takes one of two combinations of arguments:
790 * Does not take integer types.
795 * \name Binary comparison operators which return a boolean vector.
796 * The type of both operands must be equal.
806 * Returns single boolean for whether all components of operands[0]
807 * equal the components of operands[1].
811 * Returns single boolean for whether any component of operands[0]
812 * is not equal to the corresponding component of operands[1].
818 * \name Bit-wise binary operations.
839 * A sentinel marking the last of the binary operations.
841 ir_last_binop = ir_binop_pow,
846 * A sentinel marking the last of all operations.
848 ir_last_opcode = ir_last_binop
851 class ir_expression : public ir_rvalue {
854 * Constructor for unary operation expressions
856 ir_expression(int op, const struct glsl_type *type, ir_rvalue *);
857 ir_expression(int op, ir_rvalue *);
860 * Constructor for binary operation expressions
862 ir_expression(int op, const struct glsl_type *type,
863 ir_rvalue *, ir_rvalue *);
864 ir_expression(int op, ir_rvalue *op0, ir_rvalue *op1);
867 * Constructor for quad operator expressions
869 ir_expression(int op, const struct glsl_type *type,
870 ir_rvalue *, ir_rvalue *, ir_rvalue *, ir_rvalue *);
872 virtual ir_expression *as_expression()
877 virtual ir_expression *clone(void *mem_ctx, struct hash_table *ht) const;
880 * Attempt to constant-fold the expression
882 * If the expression cannot be constant folded, this method will return
885 virtual ir_constant *constant_expression_value();
888 * Determine the number of operands used by an expression
890 static unsigned int get_num_operands(ir_expression_operation);
893 * Determine the number of operands used by an expression
895 unsigned int get_num_operands() const
897 return (this->operation == ir_quadop_vector)
898 ? this->type->vector_elements : get_num_operands(operation);
902 * Return a string representing this expression's operator.
904 const char *operator_string();
907 * Return a string representing this expression's operator.
909 static const char *operator_string(ir_expression_operation);
913 * Do a reverse-lookup to translate the given string into an operator.
915 static ir_expression_operation get_operator(const char *);
917 virtual void accept(ir_visitor *v)
922 virtual ir_visitor_status accept(ir_hierarchical_visitor *);
924 ir_expression_operation operation;
925 ir_rvalue *operands[4];
930 * IR instruction representing a function call
932 class ir_call : public ir_rvalue {
934 ir_call(ir_function_signature *callee, exec_list *actual_parameters)
937 ir_type = ir_type_call;
938 assert(callee->return_type != NULL);
939 type = callee->return_type;
940 actual_parameters->move_nodes_to(& this->actual_parameters);
943 virtual ir_call *clone(void *mem_ctx, struct hash_table *ht) const;
945 virtual ir_constant *constant_expression_value();
947 virtual ir_call *as_call()
952 virtual void accept(ir_visitor *v)
957 virtual ir_visitor_status accept(ir_hierarchical_visitor *);
960 * Get a generic ir_call object when an error occurs
962 * Any allocation will be performed with 'ctx' as talloc owner.
964 static ir_call *get_error_instruction(void *ctx);
967 * Get an iterator for the set of acutal parameters
969 exec_list_iterator iterator()
971 return actual_parameters.iterator();
975 * Get the name of the function being called.
977 const char *callee_name() const
979 return callee->function_name();
983 * Get the function signature bound to this function call
985 ir_function_signature *get_callee()
991 * Set the function call target
993 void set_callee(ir_function_signature *sig);
996 * Generates an inline version of the function before @ir,
997 * returning the return value of the function.
999 ir_rvalue *generate_inline(ir_instruction *ir);
1001 /* List of ir_rvalue of paramaters passed in this call. */
1002 exec_list actual_parameters;
1008 this->ir_type = ir_type_call;
1011 ir_function_signature *callee;
1016 * \name Jump-like IR instructions.
1018 * These include \c break, \c continue, \c return, and \c discard.
1021 class ir_jump : public ir_instruction {
1025 ir_type = ir_type_unset;
1029 class ir_return : public ir_jump {
1034 this->ir_type = ir_type_return;
1037 ir_return(ir_rvalue *value)
1040 this->ir_type = ir_type_return;
1043 virtual ir_return *clone(void *mem_ctx, struct hash_table *) const;
1045 virtual ir_return *as_return()
1050 ir_rvalue *get_value() const
1055 virtual void accept(ir_visitor *v)
1060 virtual ir_visitor_status accept(ir_hierarchical_visitor *);
1067 * Jump instructions used inside loops
1069 * These include \c break and \c continue. The \c break within a loop is
1070 * different from the \c break within a switch-statement.
1072 * \sa ir_switch_jump
1074 class ir_loop_jump : public ir_jump {
1081 ir_loop_jump(jump_mode mode)
1083 this->ir_type = ir_type_loop_jump;
1088 virtual ir_loop_jump *clone(void *mem_ctx, struct hash_table *) const;
1090 virtual void accept(ir_visitor *v)
1095 virtual ir_visitor_status accept(ir_hierarchical_visitor *);
1097 bool is_break() const
1099 return mode == jump_break;
1102 bool is_continue() const
1104 return mode == jump_continue;
1107 /** Mode selector for the jump instruction. */
1108 enum jump_mode mode;
1110 /** Loop containing this break instruction. */
1115 * IR instruction representing discard statements.
1117 class ir_discard : public ir_jump {
1121 this->ir_type = ir_type_discard;
1122 this->condition = NULL;
1125 ir_discard(ir_rvalue *cond)
1127 this->ir_type = ir_type_discard;
1128 this->condition = cond;
1131 virtual ir_discard *clone(void *mem_ctx, struct hash_table *ht) const;
1133 virtual void accept(ir_visitor *v)
1138 virtual ir_visitor_status accept(ir_hierarchical_visitor *);
1140 virtual ir_discard *as_discard()
1145 ir_rvalue *condition;
1151 * Texture sampling opcodes used in ir_texture
1153 enum ir_texture_opcode {
1154 ir_tex, /**< Regular texture look-up */
1155 ir_txb, /**< Texture look-up with LOD bias */
1156 ir_txl, /**< Texture look-up with explicit LOD */
1157 ir_txd, /**< Texture look-up with partial derivatvies */
1158 ir_txf /**< Texel fetch with explicit LOD */
1163 * IR instruction to sample a texture
1165 * The specific form of the IR instruction depends on the \c mode value
1166 * selected from \c ir_texture_opcodes. In the printed IR, these will
1170 * | Projection divisor
1171 * | | Shadow comparitor
1174 * (tex (sampler) (coordinate) (0 0 0) (1) ( ))
1175 * (txb (sampler) (coordinate) (0 0 0) (1) ( ) (bias))
1176 * (txl (sampler) (coordinate) (0 0 0) (1) ( ) (lod))
1177 * (txd (sampler) (coordinate) (0 0 0) (1) ( ) (dPdx dPdy))
1178 * (txf (sampler) (coordinate) (0 0 0) (lod))
1180 class ir_texture : public ir_rvalue {
1182 ir_texture(enum ir_texture_opcode op)
1183 : op(op), projector(NULL), shadow_comparitor(NULL)
1185 this->ir_type = ir_type_texture;
1188 virtual ir_texture *clone(void *mem_ctx, struct hash_table *) const;
1190 virtual ir_constant *constant_expression_value();
1192 virtual void accept(ir_visitor *v)
1197 virtual ir_visitor_status accept(ir_hierarchical_visitor *);
1200 * Return a string representing the ir_texture_opcode.
1202 const char *opcode_string();
1204 /** Set the sampler and infer the type. */
1205 void set_sampler(ir_dereference *sampler);
1208 * Do a reverse-lookup to translate a string into an ir_texture_opcode.
1210 static ir_texture_opcode get_opcode(const char *);
1212 enum ir_texture_opcode op;
1214 /** Sampler to use for the texture access. */
1215 ir_dereference *sampler;
1217 /** Texture coordinate to sample */
1218 ir_rvalue *coordinate;
1221 * Value used for projective divide.
1223 * If there is no projective divide (the common case), this will be
1224 * \c NULL. Optimization passes should check for this to point to a constant
1225 * of 1.0 and replace that with \c NULL.
1227 ir_rvalue *projector;
1230 * Coordinate used for comparison on shadow look-ups.
1232 * If there is no shadow comparison, this will be \c NULL. For the
1233 * \c ir_txf opcode, this *must* be \c NULL.
1235 ir_rvalue *shadow_comparitor;
1237 /** Explicit texel offsets. */
1238 signed char offsets[3];
1241 ir_rvalue *lod; /**< Floating point LOD */
1242 ir_rvalue *bias; /**< Floating point LOD bias */
1244 ir_rvalue *dPdx; /**< Partial derivative of coordinate wrt X */
1245 ir_rvalue *dPdy; /**< Partial derivative of coordinate wrt Y */
1251 struct ir_swizzle_mask {
1258 * Number of components in the swizzle.
1260 unsigned num_components:3;
1263 * Does the swizzle contain duplicate components?
1265 * L-value swizzles cannot contain duplicate components.
1267 unsigned has_duplicates:1;
1271 class ir_swizzle : public ir_rvalue {
1273 ir_swizzle(ir_rvalue *, unsigned x, unsigned y, unsigned z, unsigned w,
1276 ir_swizzle(ir_rvalue *val, const unsigned *components, unsigned count);
1278 ir_swizzle(ir_rvalue *val, ir_swizzle_mask mask);
1280 virtual ir_swizzle *clone(void *mem_ctx, struct hash_table *) const;
1282 virtual ir_constant *constant_expression_value();
1284 virtual ir_swizzle *as_swizzle()
1290 * Construct an ir_swizzle from the textual representation. Can fail.
1292 static ir_swizzle *create(ir_rvalue *, const char *, unsigned vector_length);
1294 virtual void accept(ir_visitor *v)
1299 virtual ir_visitor_status accept(ir_hierarchical_visitor *);
1303 return val->is_lvalue() && !mask.has_duplicates;
1307 * Get the variable that is ultimately referenced by an r-value
1309 virtual ir_variable *variable_referenced();
1312 ir_swizzle_mask mask;
1316 * Initialize the mask component of a swizzle
1318 * This is used by the \c ir_swizzle constructors.
1320 void init_mask(const unsigned *components, unsigned count);
1324 class ir_dereference : public ir_rvalue {
1326 virtual ir_dereference *clone(void *mem_ctx, struct hash_table *) const = 0;
1328 virtual ir_dereference *as_dereference()
1336 * Get the variable that is ultimately referenced by an r-value
1338 virtual ir_variable *variable_referenced() = 0;
1342 class ir_dereference_variable : public ir_dereference {
1344 ir_dereference_variable(ir_variable *var);
1346 virtual ir_dereference_variable *clone(void *mem_ctx,
1347 struct hash_table *) const;
1349 virtual ir_constant *constant_expression_value();
1351 virtual ir_dereference_variable *as_dereference_variable()
1357 * Get the variable that is ultimately referenced by an r-value
1359 virtual ir_variable *variable_referenced()
1364 virtual ir_variable *whole_variable_referenced()
1366 /* ir_dereference_variable objects always dereference the entire
1367 * variable. However, if this dereference is dereferenced by anything
1368 * else, the complete deferefernce chain is not a whole-variable
1369 * dereference. This method should only be called on the top most
1370 * ir_rvalue in a dereference chain.
1375 virtual void accept(ir_visitor *v)
1380 virtual ir_visitor_status accept(ir_hierarchical_visitor *);
1383 * Object being dereferenced.
1389 class ir_dereference_array : public ir_dereference {
1391 ir_dereference_array(ir_rvalue *value, ir_rvalue *array_index);
1393 ir_dereference_array(ir_variable *var, ir_rvalue *array_index);
1395 virtual ir_dereference_array *clone(void *mem_ctx,
1396 struct hash_table *) const;
1398 virtual ir_constant *constant_expression_value();
1400 virtual ir_dereference_array *as_dereference_array()
1406 * Get the variable that is ultimately referenced by an r-value
1408 virtual ir_variable *variable_referenced()
1410 return this->array->variable_referenced();
1413 virtual void accept(ir_visitor *v)
1418 virtual ir_visitor_status accept(ir_hierarchical_visitor *);
1421 ir_rvalue *array_index;
1424 void set_array(ir_rvalue *value);
1428 class ir_dereference_record : public ir_dereference {
1430 ir_dereference_record(ir_rvalue *value, const char *field);
1432 ir_dereference_record(ir_variable *var, const char *field);
1434 virtual ir_dereference_record *clone(void *mem_ctx,
1435 struct hash_table *) const;
1437 virtual ir_constant *constant_expression_value();
1440 * Get the variable that is ultimately referenced by an r-value
1442 virtual ir_variable *variable_referenced()
1444 return this->record->variable_referenced();
1447 virtual void accept(ir_visitor *v)
1452 virtual ir_visitor_status accept(ir_hierarchical_visitor *);
1460 * Data stored in an ir_constant
1462 union ir_constant_data {
1470 class ir_constant : public ir_rvalue {
1472 ir_constant(const struct glsl_type *type, const ir_constant_data *data);
1473 ir_constant(bool b);
1474 ir_constant(unsigned int u);
1476 ir_constant(float f);
1479 * Construct an ir_constant from a list of ir_constant values
1481 ir_constant(const struct glsl_type *type, exec_list *values);
1484 * Construct an ir_constant from a scalar component of another ir_constant
1486 * The new \c ir_constant inherits the type of the component from the
1490 * In the case of a matrix constant, the new constant is a scalar, \b not
1493 ir_constant(const ir_constant *c, unsigned i);
1496 * Return a new ir_constant of the specified type containing all zeros.
1498 static ir_constant *zero(void *mem_ctx, const glsl_type *type);
1500 virtual ir_constant *clone(void *mem_ctx, struct hash_table *) const;
1502 virtual ir_constant *constant_expression_value();
1504 virtual ir_constant *as_constant()
1509 virtual void accept(ir_visitor *v)
1514 virtual ir_visitor_status accept(ir_hierarchical_visitor *);
1517 * Get a particular component of a constant as a specific type
1519 * This is useful, for example, to get a value from an integer constant
1520 * as a float or bool. This appears frequently when constructors are
1521 * called with all constant parameters.
1524 bool get_bool_component(unsigned i) const;
1525 float get_float_component(unsigned i) const;
1526 int get_int_component(unsigned i) const;
1527 unsigned get_uint_component(unsigned i) const;
1530 ir_constant *get_array_element(unsigned i) const;
1532 ir_constant *get_record_field(const char *name);
1535 * Determine whether a constant has the same value as another constant
1537 * \sa ir_constant::is_zero, ir_constant::is_one,
1538 * ir_constant::is_negative_one
1540 bool has_value(const ir_constant *) const;
1542 virtual bool is_zero() const;
1543 virtual bool is_one() const;
1544 virtual bool is_negative_one() const;
1547 * Value of the constant.
1549 * The field used to back the values supplied by the constant is determined
1550 * by the type associated with the \c ir_instruction. Constants may be
1551 * scalars, vectors, or matrices.
1553 union ir_constant_data value;
1555 /* Array elements */
1556 ir_constant **array_elements;
1558 /* Structure fields */
1559 exec_list components;
1563 * Parameterless constructor only used by the clone method
1571 * Apply a visitor to each IR node in a list
1574 visit_exec_list(exec_list *list, ir_visitor *visitor);
1577 * Validate invariants on each IR node in a list
1579 void validate_ir_tree(exec_list *instructions);
1582 * Make a clone of each IR instruction in a list
1584 * \param in List of IR instructions that are to be cloned
1585 * \param out List to hold the cloned instructions
1588 clone_ir_list(void *mem_ctx, exec_list *out, const exec_list *in);
1591 _mesa_glsl_initialize_variables(exec_list *instructions,
1592 struct _mesa_glsl_parse_state *state);
1595 _mesa_glsl_initialize_functions(_mesa_glsl_parse_state *state);
1598 _mesa_glsl_release_functions(void);
1601 reparent_ir(exec_list *list, void *mem_ctx);
1603 struct glsl_symbol_table;
1606 import_prototypes(const exec_list *source, exec_list *dest,
1607 struct glsl_symbol_table *symbols, void *mem_ctx);
1610 ir_has_call(ir_instruction *ir);
1613 do_set_program_inouts(exec_list *instructions, struct gl_program *prog);