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_system_value, /**< Ex: front-face, instance-id, etc. */
226 ir_var_temporary /**< Temporary variable generated during compilation. */
229 enum ir_variable_interpolation {
236 * \brief Layout qualifiers for gl_FragDepth.
238 * The AMD_conservative_depth extension allows gl_FragDepth to be redeclared
239 * with a layout qualifier.
241 enum ir_depth_layout {
242 ir_depth_layout_none, /**< No depth layout is specified. */
244 ir_depth_layout_greater,
245 ir_depth_layout_less,
246 ir_depth_layout_unchanged
250 * \brief Convert depth layout qualifier to string.
253 depth_layout_string(ir_depth_layout layout);
255 class ir_variable : public ir_instruction {
257 ir_variable(const struct glsl_type *, const char *, ir_variable_mode);
259 virtual ir_variable *clone(void *mem_ctx, struct hash_table *ht) const;
261 virtual ir_variable *as_variable()
266 virtual void accept(ir_visitor *v)
271 virtual ir_visitor_status accept(ir_hierarchical_visitor *);
275 * Get the string value for the interpolation qualifier
277 * \return The string that would be used in a shader to specify \c
278 * mode will be returned.
280 * This function should only be used on a shader input or output variable.
282 const char *interpolation_string() const;
285 * Calculate the number of slots required to hold this variable
287 * This is used to determine how many uniform or varying locations a variable
288 * occupies. The count is in units of floating point components.
290 unsigned component_slots() const;
293 * Delcared name of the variable
298 * Highest element accessed with a constant expression array index
300 * Not used for non-array variables.
302 unsigned max_array_access;
305 * Is the variable read-only?
307 * This is set for variables declared as \c const, shader inputs,
310 unsigned read_only:1;
312 unsigned invariant:1;
315 * Has this variable been used for reading or writing?
317 * Several GLSL semantic checks require knowledge of whether or not a
318 * variable has been used. For example, it is an error to redeclare a
319 * variable as invariant after it has been used.
324 * Storage class of the variable.
326 * \sa ir_variable_mode
331 * Interpolation mode for shader inputs / outputs
333 * \sa ir_variable_interpolation
335 unsigned interpolation:2;
338 * Flag that the whole array is assignable
340 * In GLSL 1.20 and later whole arrays are assignable (and comparable for
341 * equality). This flag enables this behavior.
343 unsigned array_lvalue:1;
346 * \name ARB_fragment_coord_conventions
349 unsigned origin_upper_left:1;
350 unsigned pixel_center_integer:1;
354 * \brief Layout qualifier for gl_FragDepth.
356 * This is not equal to \c ir_depth_layout_none if and only if this
357 * variable is \c gl_FragDepth and a layout qualifier is specified.
359 ir_depth_layout depth_layout;
362 * Was the location explicitly set in the shader?
364 * If the location is explicitly set in the shader, it \b cannot be changed
365 * by the linker or by the API (e.g., calls to \c glBindAttribLocation have
368 unsigned explicit_location:1;
371 * Storage location of the base of this variable
373 * The precise meaning of this field depends on the nature of the variable.
375 * - Vertex shader input: one of the values from \c gl_vert_attrib.
376 * - Vertex shader output: one of the values from \c gl_vert_result.
377 * - Fragment shader input: one of the values from \c gl_frag_attrib.
378 * - Fragment shader output: one of the values from \c gl_frag_result.
379 * - Uniforms: Per-stage uniform slot number.
380 * - Other: This field is not currently used.
382 * If the variable is a uniform, shader input, or shader output, and the
383 * slot has not been assigned, the value will be -1.
388 * Emit a warning if this variable is accessed.
390 const char *warn_extension;
393 * Value assigned in the initializer of a variable declared "const"
395 ir_constant *constant_value;
401 * The representation of a function instance; may be the full definition or
402 * simply a prototype.
404 class ir_function_signature : public ir_instruction {
405 /* An ir_function_signature will be part of the list of signatures in
409 ir_function_signature(const glsl_type *return_type);
411 virtual ir_function_signature *clone(void *mem_ctx,
412 struct hash_table *ht) const;
413 ir_function_signature *clone_prototype(void *mem_ctx,
414 struct hash_table *ht) const;
416 virtual void accept(ir_visitor *v)
421 virtual ir_visitor_status accept(ir_hierarchical_visitor *);
424 * Get the name of the function for which this is a signature
426 const char *function_name() const;
429 * Get a handle to the function for which this is a signature
431 * There is no setter function, this function returns a \c const pointer,
432 * and \c ir_function_signature::_function is private for a reason. The
433 * only way to make a connection between a function and function signature
434 * is via \c ir_function::add_signature. This helps ensure that certain
435 * invariants (i.e., a function signature is in the list of signatures for
436 * its \c _function) are met.
438 * \sa ir_function::add_signature
440 inline const class ir_function *function() const
442 return this->_function;
446 * Check whether the qualifiers match between this signature's parameters
447 * and the supplied parameter list. If not, returns the name of the first
448 * parameter with mismatched qualifiers (for use in error messages).
450 const char *qualifiers_match(exec_list *params);
453 * Replace the current parameter list with the given one. This is useful
454 * if the current information came from a prototype, and either has invalid
455 * or missing parameter names.
457 void replace_parameters(exec_list *new_params);
460 * Function return type.
462 * \note This discards the optional precision qualifier.
464 const struct glsl_type *return_type;
467 * List of ir_variable of function parameters.
469 * This represents the storage. The paramaters passed in a particular
470 * call will be in ir_call::actual_paramaters.
472 struct exec_list parameters;
474 /** Whether or not this function has a body (which may be empty). */
475 unsigned is_defined:1;
477 /** Whether or not this function signature is a built-in. */
478 unsigned is_builtin:1;
480 /** Body of instructions in the function. */
481 struct exec_list body;
484 /** Function of which this signature is one overload. */
485 class ir_function *_function;
487 friend class ir_function;
492 * Header for tracking multiple overloaded functions with the same name.
493 * Contains a list of ir_function_signatures representing each of the
496 class ir_function : public ir_instruction {
498 ir_function(const char *name);
500 virtual ir_function *clone(void *mem_ctx, struct hash_table *ht) const;
502 virtual ir_function *as_function()
507 virtual void accept(ir_visitor *v)
512 virtual ir_visitor_status accept(ir_hierarchical_visitor *);
514 void add_signature(ir_function_signature *sig)
516 sig->_function = this;
517 this->signatures.push_tail(sig);
521 * Get an iterator for the set of function signatures
523 exec_list_iterator iterator()
525 return signatures.iterator();
529 * Find a signature that matches a set of actual parameters, taking implicit
530 * conversions into account.
532 ir_function_signature *matching_signature(const exec_list *actual_param);
535 * Find a signature that exactly matches a set of actual parameters without
536 * any implicit type conversions.
538 ir_function_signature *exact_matching_signature(const exec_list *actual_ps);
541 * Name of the function.
545 /** Whether or not this function has a signature that isn't a built-in. */
546 bool has_user_signature();
549 * List of ir_function_signature for each overloaded function with this name.
551 struct exec_list signatures;
554 inline const char *ir_function_signature::function_name() const
556 return this->_function->name;
562 * IR instruction representing high-level if-statements
564 class ir_if : public ir_instruction {
566 ir_if(ir_rvalue *condition)
567 : condition(condition)
569 ir_type = ir_type_if;
572 virtual ir_if *clone(void *mem_ctx, struct hash_table *ht) const;
574 virtual ir_if *as_if()
579 virtual void accept(ir_visitor *v)
584 virtual ir_visitor_status accept(ir_hierarchical_visitor *);
586 ir_rvalue *condition;
587 /** List of ir_instruction for the body of the then branch */
588 exec_list then_instructions;
589 /** List of ir_instruction for the body of the else branch */
590 exec_list else_instructions;
595 * IR instruction representing a high-level loop structure.
597 class ir_loop : public ir_instruction {
601 virtual ir_loop *clone(void *mem_ctx, struct hash_table *ht) const;
603 virtual void accept(ir_visitor *v)
608 virtual ir_visitor_status accept(ir_hierarchical_visitor *);
610 virtual ir_loop *as_loop()
616 * Get an iterator for the instructions of the loop body
618 exec_list_iterator iterator()
620 return body_instructions.iterator();
623 /** List of ir_instruction that make up the body of the loop. */
624 exec_list body_instructions;
627 * \name Loop counter and controls
629 * Represents a loop like a FORTRAN \c do-loop.
632 * If \c from and \c to are the same value, the loop will execute once.
635 ir_rvalue *from; /** Value of the loop counter on the first
636 * iteration of the loop.
638 ir_rvalue *to; /** Value of the loop counter on the last
639 * iteration of the loop.
641 ir_rvalue *increment;
642 ir_variable *counter;
645 * Comparison operation in the loop terminator.
647 * If any of the loop control fields are non-\c NULL, this field must be
648 * one of \c ir_binop_less, \c ir_binop_greater, \c ir_binop_lequal,
649 * \c ir_binop_gequal, \c ir_binop_equal, or \c ir_binop_nequal.
656 class ir_assignment : public ir_instruction {
658 ir_assignment(ir_rvalue *lhs, ir_rvalue *rhs, ir_rvalue *condition);
661 * Construct an assignment with an explicit write mask
664 * Since a write mask is supplied, the LHS must already be a bare
665 * \c ir_dereference. The cannot be any swizzles in the LHS.
667 ir_assignment(ir_dereference *lhs, ir_rvalue *rhs, ir_rvalue *condition,
668 unsigned write_mask);
670 virtual ir_assignment *clone(void *mem_ctx, struct hash_table *ht) const;
672 virtual ir_constant *constant_expression_value();
674 virtual void accept(ir_visitor *v)
679 virtual ir_visitor_status accept(ir_hierarchical_visitor *);
681 virtual ir_assignment * as_assignment()
687 * Get a whole variable written by an assignment
689 * If the LHS of the assignment writes a whole variable, the variable is
690 * returned. Otherwise \c NULL is returned. Examples of whole-variable
693 * - Assigning to a scalar
694 * - Assigning to all components of a vector
695 * - Whole array (or matrix) assignment
696 * - Whole structure assignment
698 ir_variable *whole_variable_written();
701 * Set the LHS of an assignment
703 void set_lhs(ir_rvalue *lhs);
706 * Left-hand side of the assignment.
708 * This should be treated as read only. If you need to set the LHS of an
709 * assignment, use \c ir_assignment::set_lhs.
714 * Value being assigned
719 * Optional condition for the assignment.
721 ir_rvalue *condition;
725 * Component mask written
727 * For non-vector types in the LHS, this field will be zero. For vector
728 * types, a bit will be set for each component that is written. Note that
729 * for \c vec2 and \c vec3 types only the lower bits will ever be set.
731 * A partially-set write mask means that each enabled channel gets
732 * the value from a consecutive channel of the rhs. For example,
733 * to write just .xyw of gl_FrontColor with color:
735 * (assign (constant bool (1)) (xyw)
736 * (var_ref gl_FragColor)
737 * (swiz xyw (var_ref color)))
739 unsigned write_mask:4;
742 /* Update ir_expression::num_operands() and operator_strs when
743 * updating this list.
745 enum ir_expression_operation {
754 ir_unop_exp, /**< Log base e on gentype */
755 ir_unop_log, /**< Natural log on gentype */
758 ir_unop_f2i, /**< Float-to-integer conversion. */
759 ir_unop_i2f, /**< Integer-to-float conversion. */
760 ir_unop_f2b, /**< Float-to-boolean conversion */
761 ir_unop_b2f, /**< Boolean-to-float conversion */
762 ir_unop_i2b, /**< int-to-boolean conversion */
763 ir_unop_b2i, /**< Boolean-to-int conversion */
764 ir_unop_u2f, /**< Unsigned-to-float conversion. */
768 * \name Unary floating-point rounding operations.
779 * \name Trigonometric operations.
784 ir_unop_sin_reduced, /**< Reduced range sin. [-pi, pi] */
785 ir_unop_cos_reduced, /**< Reduced range cos. [-pi, pi] */
789 * \name Partial derivatives.
799 * A sentinel marking the last of the unary operations.
801 ir_last_unop = ir_unop_noise,
809 * Takes one of two combinations of arguments:
814 * Does not take integer types.
819 * \name Binary comparison operators which return a boolean vector.
820 * The type of both operands must be equal.
830 * Returns single boolean for whether all components of operands[0]
831 * equal the components of operands[1].
835 * Returns single boolean for whether any component of operands[0]
836 * is not equal to the corresponding component of operands[1].
842 * \name Bit-wise binary operations.
863 * A sentinel marking the last of the binary operations.
865 ir_last_binop = ir_binop_pow,
870 * A sentinel marking the last of all operations.
872 ir_last_opcode = ir_last_binop
875 class ir_expression : public ir_rvalue {
878 * Constructor for unary operation expressions
880 ir_expression(int op, const struct glsl_type *type, ir_rvalue *);
881 ir_expression(int op, ir_rvalue *);
884 * Constructor for binary operation expressions
886 ir_expression(int op, const struct glsl_type *type,
887 ir_rvalue *, ir_rvalue *);
888 ir_expression(int op, ir_rvalue *op0, ir_rvalue *op1);
891 * Constructor for quad operator expressions
893 ir_expression(int op, const struct glsl_type *type,
894 ir_rvalue *, ir_rvalue *, ir_rvalue *, ir_rvalue *);
896 virtual ir_expression *as_expression()
901 virtual ir_expression *clone(void *mem_ctx, struct hash_table *ht) const;
904 * Attempt to constant-fold the expression
906 * If the expression cannot be constant folded, this method will return
909 virtual ir_constant *constant_expression_value();
912 * Determine the number of operands used by an expression
914 static unsigned int get_num_operands(ir_expression_operation);
917 * Determine the number of operands used by an expression
919 unsigned int get_num_operands() const
921 return (this->operation == ir_quadop_vector)
922 ? this->type->vector_elements : get_num_operands(operation);
926 * Return a string representing this expression's operator.
928 const char *operator_string();
931 * Return a string representing this expression's operator.
933 static const char *operator_string(ir_expression_operation);
937 * Do a reverse-lookup to translate the given string into an operator.
939 static ir_expression_operation get_operator(const char *);
941 virtual void accept(ir_visitor *v)
946 virtual ir_visitor_status accept(ir_hierarchical_visitor *);
948 ir_expression_operation operation;
949 ir_rvalue *operands[4];
954 * IR instruction representing a function call
956 class ir_call : public ir_rvalue {
958 ir_call(ir_function_signature *callee, exec_list *actual_parameters)
961 ir_type = ir_type_call;
962 assert(callee->return_type != NULL);
963 type = callee->return_type;
964 actual_parameters->move_nodes_to(& this->actual_parameters);
967 virtual ir_call *clone(void *mem_ctx, struct hash_table *ht) const;
969 virtual ir_constant *constant_expression_value();
971 virtual ir_call *as_call()
976 virtual void accept(ir_visitor *v)
981 virtual ir_visitor_status accept(ir_hierarchical_visitor *);
984 * Get a generic ir_call object when an error occurs
986 * Any allocation will be performed with 'ctx' as ralloc owner.
988 static ir_call *get_error_instruction(void *ctx);
991 * Get an iterator for the set of acutal parameters
993 exec_list_iterator iterator()
995 return actual_parameters.iterator();
999 * Get the name of the function being called.
1001 const char *callee_name() const
1003 return callee->function_name();
1007 * Get the function signature bound to this function call
1009 ir_function_signature *get_callee()
1015 * Set the function call target
1017 void set_callee(ir_function_signature *sig);
1020 * Generates an inline version of the function before @ir,
1021 * returning the return value of the function.
1023 ir_rvalue *generate_inline(ir_instruction *ir);
1025 /* List of ir_rvalue of paramaters passed in this call. */
1026 exec_list actual_parameters;
1032 this->ir_type = ir_type_call;
1035 ir_function_signature *callee;
1040 * \name Jump-like IR instructions.
1042 * These include \c break, \c continue, \c return, and \c discard.
1045 class ir_jump : public ir_instruction {
1049 ir_type = ir_type_unset;
1053 class ir_return : public ir_jump {
1058 this->ir_type = ir_type_return;
1061 ir_return(ir_rvalue *value)
1064 this->ir_type = ir_type_return;
1067 virtual ir_return *clone(void *mem_ctx, struct hash_table *) const;
1069 virtual ir_return *as_return()
1074 ir_rvalue *get_value() const
1079 virtual void accept(ir_visitor *v)
1084 virtual ir_visitor_status accept(ir_hierarchical_visitor *);
1091 * Jump instructions used inside loops
1093 * These include \c break and \c continue. The \c break within a loop is
1094 * different from the \c break within a switch-statement.
1096 * \sa ir_switch_jump
1098 class ir_loop_jump : public ir_jump {
1105 ir_loop_jump(jump_mode mode)
1107 this->ir_type = ir_type_loop_jump;
1112 virtual ir_loop_jump *clone(void *mem_ctx, struct hash_table *) const;
1114 virtual void accept(ir_visitor *v)
1119 virtual ir_visitor_status accept(ir_hierarchical_visitor *);
1121 bool is_break() const
1123 return mode == jump_break;
1126 bool is_continue() const
1128 return mode == jump_continue;
1131 /** Mode selector for the jump instruction. */
1132 enum jump_mode mode;
1134 /** Loop containing this break instruction. */
1139 * IR instruction representing discard statements.
1141 class ir_discard : public ir_jump {
1145 this->ir_type = ir_type_discard;
1146 this->condition = NULL;
1149 ir_discard(ir_rvalue *cond)
1151 this->ir_type = ir_type_discard;
1152 this->condition = cond;
1155 virtual ir_discard *clone(void *mem_ctx, struct hash_table *ht) const;
1157 virtual void accept(ir_visitor *v)
1162 virtual ir_visitor_status accept(ir_hierarchical_visitor *);
1164 virtual ir_discard *as_discard()
1169 ir_rvalue *condition;
1175 * Texture sampling opcodes used in ir_texture
1177 enum ir_texture_opcode {
1178 ir_tex, /**< Regular texture look-up */
1179 ir_txb, /**< Texture look-up with LOD bias */
1180 ir_txl, /**< Texture look-up with explicit LOD */
1181 ir_txd, /**< Texture look-up with partial derivatvies */
1182 ir_txf /**< Texel fetch with explicit LOD */
1187 * IR instruction to sample a texture
1189 * The specific form of the IR instruction depends on the \c mode value
1190 * selected from \c ir_texture_opcodes. In the printed IR, these will
1193 * Texel offset (0 or an expression)
1194 * | Projection divisor
1195 * | | Shadow comparitor
1198 * (tex <sampler> <coordinate> 0 1 ( ))
1199 * (txb <sampler> <coordinate> 0 1 ( ) <bias>)
1200 * (txl <sampler> <coordinate> 0 1 ( ) <lod>)
1201 * (txd <sampler> <coordinate> 0 1 ( ) (dPdx dPdy))
1202 * (txf <sampler> <coordinate> 0 <lod>)
1204 class ir_texture : public ir_rvalue {
1206 ir_texture(enum ir_texture_opcode op)
1207 : op(op), projector(NULL), shadow_comparitor(NULL), offset(NULL)
1209 this->ir_type = ir_type_texture;
1212 virtual ir_texture *clone(void *mem_ctx, struct hash_table *) const;
1214 virtual ir_constant *constant_expression_value();
1216 virtual void accept(ir_visitor *v)
1221 virtual ir_visitor_status accept(ir_hierarchical_visitor *);
1224 * Return a string representing the ir_texture_opcode.
1226 const char *opcode_string();
1228 /** Set the sampler and infer the type. */
1229 void set_sampler(ir_dereference *sampler);
1232 * Do a reverse-lookup to translate a string into an ir_texture_opcode.
1234 static ir_texture_opcode get_opcode(const char *);
1236 enum ir_texture_opcode op;
1238 /** Sampler to use for the texture access. */
1239 ir_dereference *sampler;
1241 /** Texture coordinate to sample */
1242 ir_rvalue *coordinate;
1245 * Value used for projective divide.
1247 * If there is no projective divide (the common case), this will be
1248 * \c NULL. Optimization passes should check for this to point to a constant
1249 * of 1.0 and replace that with \c NULL.
1251 ir_rvalue *projector;
1254 * Coordinate used for comparison on shadow look-ups.
1256 * If there is no shadow comparison, this will be \c NULL. For the
1257 * \c ir_txf opcode, this *must* be \c NULL.
1259 ir_rvalue *shadow_comparitor;
1261 /** Texel offset. */
1265 ir_rvalue *lod; /**< Floating point LOD */
1266 ir_rvalue *bias; /**< Floating point LOD bias */
1268 ir_rvalue *dPdx; /**< Partial derivative of coordinate wrt X */
1269 ir_rvalue *dPdy; /**< Partial derivative of coordinate wrt Y */
1275 struct ir_swizzle_mask {
1282 * Number of components in the swizzle.
1284 unsigned num_components:3;
1287 * Does the swizzle contain duplicate components?
1289 * L-value swizzles cannot contain duplicate components.
1291 unsigned has_duplicates:1;
1295 class ir_swizzle : public ir_rvalue {
1297 ir_swizzle(ir_rvalue *, unsigned x, unsigned y, unsigned z, unsigned w,
1300 ir_swizzle(ir_rvalue *val, const unsigned *components, unsigned count);
1302 ir_swizzle(ir_rvalue *val, ir_swizzle_mask mask);
1304 virtual ir_swizzle *clone(void *mem_ctx, struct hash_table *) const;
1306 virtual ir_constant *constant_expression_value();
1308 virtual ir_swizzle *as_swizzle()
1314 * Construct an ir_swizzle from the textual representation. Can fail.
1316 static ir_swizzle *create(ir_rvalue *, const char *, unsigned vector_length);
1318 virtual void accept(ir_visitor *v)
1323 virtual ir_visitor_status accept(ir_hierarchical_visitor *);
1327 return val->is_lvalue() && !mask.has_duplicates;
1331 * Get the variable that is ultimately referenced by an r-value
1333 virtual ir_variable *variable_referenced();
1336 ir_swizzle_mask mask;
1340 * Initialize the mask component of a swizzle
1342 * This is used by the \c ir_swizzle constructors.
1344 void init_mask(const unsigned *components, unsigned count);
1348 class ir_dereference : public ir_rvalue {
1350 virtual ir_dereference *clone(void *mem_ctx, struct hash_table *) const = 0;
1352 virtual ir_dereference *as_dereference()
1360 * Get the variable that is ultimately referenced by an r-value
1362 virtual ir_variable *variable_referenced() = 0;
1366 class ir_dereference_variable : public ir_dereference {
1368 ir_dereference_variable(ir_variable *var);
1370 virtual ir_dereference_variable *clone(void *mem_ctx,
1371 struct hash_table *) const;
1373 virtual ir_constant *constant_expression_value();
1375 virtual ir_dereference_variable *as_dereference_variable()
1381 * Get the variable that is ultimately referenced by an r-value
1383 virtual ir_variable *variable_referenced()
1388 virtual ir_variable *whole_variable_referenced()
1390 /* ir_dereference_variable objects always dereference the entire
1391 * variable. However, if this dereference is dereferenced by anything
1392 * else, the complete deferefernce chain is not a whole-variable
1393 * dereference. This method should only be called on the top most
1394 * ir_rvalue in a dereference chain.
1399 virtual void accept(ir_visitor *v)
1404 virtual ir_visitor_status accept(ir_hierarchical_visitor *);
1407 * Object being dereferenced.
1413 class ir_dereference_array : public ir_dereference {
1415 ir_dereference_array(ir_rvalue *value, ir_rvalue *array_index);
1417 ir_dereference_array(ir_variable *var, ir_rvalue *array_index);
1419 virtual ir_dereference_array *clone(void *mem_ctx,
1420 struct hash_table *) const;
1422 virtual ir_constant *constant_expression_value();
1424 virtual ir_dereference_array *as_dereference_array()
1430 * Get the variable that is ultimately referenced by an r-value
1432 virtual ir_variable *variable_referenced()
1434 return this->array->variable_referenced();
1437 virtual void accept(ir_visitor *v)
1442 virtual ir_visitor_status accept(ir_hierarchical_visitor *);
1445 ir_rvalue *array_index;
1448 void set_array(ir_rvalue *value);
1452 class ir_dereference_record : public ir_dereference {
1454 ir_dereference_record(ir_rvalue *value, const char *field);
1456 ir_dereference_record(ir_variable *var, const char *field);
1458 virtual ir_dereference_record *clone(void *mem_ctx,
1459 struct hash_table *) const;
1461 virtual ir_constant *constant_expression_value();
1464 * Get the variable that is ultimately referenced by an r-value
1466 virtual ir_variable *variable_referenced()
1468 return this->record->variable_referenced();
1471 virtual void accept(ir_visitor *v)
1476 virtual ir_visitor_status accept(ir_hierarchical_visitor *);
1484 * Data stored in an ir_constant
1486 union ir_constant_data {
1494 class ir_constant : public ir_rvalue {
1496 ir_constant(const struct glsl_type *type, const ir_constant_data *data);
1497 ir_constant(bool b);
1498 ir_constant(unsigned int u);
1500 ir_constant(float f);
1503 * Construct an ir_constant from a list of ir_constant values
1505 ir_constant(const struct glsl_type *type, exec_list *values);
1508 * Construct an ir_constant from a scalar component of another ir_constant
1510 * The new \c ir_constant inherits the type of the component from the
1514 * In the case of a matrix constant, the new constant is a scalar, \b not
1517 ir_constant(const ir_constant *c, unsigned i);
1520 * Return a new ir_constant of the specified type containing all zeros.
1522 static ir_constant *zero(void *mem_ctx, const glsl_type *type);
1524 virtual ir_constant *clone(void *mem_ctx, struct hash_table *) const;
1526 virtual ir_constant *constant_expression_value();
1528 virtual ir_constant *as_constant()
1533 virtual void accept(ir_visitor *v)
1538 virtual ir_visitor_status accept(ir_hierarchical_visitor *);
1541 * Get a particular component of a constant as a specific type
1543 * This is useful, for example, to get a value from an integer constant
1544 * as a float or bool. This appears frequently when constructors are
1545 * called with all constant parameters.
1548 bool get_bool_component(unsigned i) const;
1549 float get_float_component(unsigned i) const;
1550 int get_int_component(unsigned i) const;
1551 unsigned get_uint_component(unsigned i) const;
1554 ir_constant *get_array_element(unsigned i) const;
1556 ir_constant *get_record_field(const char *name);
1559 * Determine whether a constant has the same value as another constant
1561 * \sa ir_constant::is_zero, ir_constant::is_one,
1562 * ir_constant::is_negative_one
1564 bool has_value(const ir_constant *) const;
1566 virtual bool is_zero() const;
1567 virtual bool is_one() const;
1568 virtual bool is_negative_one() const;
1571 * Value of the constant.
1573 * The field used to back the values supplied by the constant is determined
1574 * by the type associated with the \c ir_instruction. Constants may be
1575 * scalars, vectors, or matrices.
1577 union ir_constant_data value;
1579 /* Array elements */
1580 ir_constant **array_elements;
1582 /* Structure fields */
1583 exec_list components;
1587 * Parameterless constructor only used by the clone method
1595 * Apply a visitor to each IR node in a list
1598 visit_exec_list(exec_list *list, ir_visitor *visitor);
1601 * Validate invariants on each IR node in a list
1603 void validate_ir_tree(exec_list *instructions);
1606 * Make a clone of each IR instruction in a list
1608 * \param in List of IR instructions that are to be cloned
1609 * \param out List to hold the cloned instructions
1612 clone_ir_list(void *mem_ctx, exec_list *out, const exec_list *in);
1615 _mesa_glsl_initialize_variables(exec_list *instructions,
1616 struct _mesa_glsl_parse_state *state);
1619 _mesa_glsl_initialize_functions(_mesa_glsl_parse_state *state);
1622 _mesa_glsl_release_functions(void);
1625 reparent_ir(exec_list *list, void *mem_ctx);
1627 struct glsl_symbol_table;
1630 import_prototypes(const exec_list *source, exec_list *dest,
1631 struct glsl_symbol_table *symbols, void *mem_ctx);
1634 ir_has_call(ir_instruction *ir);
1637 do_set_program_inouts(exec_list *instructions, struct gl_program *prog);