3 * Copyright © 2010 Intel Corporation
5 * Permission is hereby granted, free of charge, to any person obtaining a
6 * copy of this software and associated documentation files (the "Software"),
7 * to deal in the Software without restriction, including without limitation
8 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
9 * and/or sell copies of the Software, and to permit persons to whom the
10 * Software is furnished to do so, subject to the following conditions:
12 * The above copyright notice and this permission notice (including the next
13 * paragraph) shall be included in all copies or substantial portions of the
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
19 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
21 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
22 * DEALINGS IN THE SOFTWARE.
33 #include "glsl_types.h"
35 #include "ir_visitor.h"
36 #include "ir_hierarchical_visitor.h"
37 #include "main/mtypes.h"
40 * \defgroup IR Intermediate representation nodes
48 * Each concrete class derived from \c ir_instruction has a value in this
49 * enumerant. The value for the type is stored in \c ir_instruction::ir_type
50 * by the constructor. While using type tags is not very C++, it is extremely
51 * convenient. For example, during debugging you can simply inspect
52 * \c ir_instruction::ir_type to find out the actual type of the object.
54 * In addition, it is possible to use a switch-statement based on \c
55 * \c ir_instruction::ir_type to select different behavior for different object
56 * types. For functions that have only slight differences for several object
57 * types, this allows writing very straightforward, readable code.
61 * Zero is unused so that the IR validator can detect cases where
62 * \c ir_instruction::ir_type has not been initialized.
69 ir_type_dereference_array
,
70 ir_type_dereference_record
,
71 ir_type_dereference_variable
,
75 ir_type_function_signature
,
82 ir_type_max
/**< maximum ir_type enum number, for validation */
86 * Base class of all IR instructions
88 class ir_instruction
: public exec_node
{
90 enum ir_node_type ir_type
;
91 const struct glsl_type
*type
;
93 /** ir_print_visitor helper for debugging. */
94 void print(void) const;
96 virtual void accept(ir_visitor
*) = 0;
97 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*) = 0;
98 virtual ir_instruction
*clone(void *mem_ctx
,
99 struct hash_table
*ht
) const = 0;
102 * \name IR instruction downcast functions
104 * These functions either cast the object to a derived class or return
105 * \c NULL if the object's type does not match the specified derived class.
106 * Additional downcast functions will be added as needed.
109 virtual class ir_variable
* as_variable() { return NULL
; }
110 virtual class ir_function
* as_function() { return NULL
; }
111 virtual class ir_dereference
* as_dereference() { return NULL
; }
112 virtual class ir_dereference_array
* as_dereference_array() { return NULL
; }
113 virtual class ir_dereference_variable
*as_dereference_variable() { return NULL
; }
114 virtual class ir_expression
* as_expression() { return NULL
; }
115 virtual class ir_rvalue
* as_rvalue() { return NULL
; }
116 virtual class ir_loop
* as_loop() { return NULL
; }
117 virtual class ir_assignment
* as_assignment() { return NULL
; }
118 virtual class ir_call
* as_call() { return NULL
; }
119 virtual class ir_return
* as_return() { return NULL
; }
120 virtual class ir_if
* as_if() { return NULL
; }
121 virtual class ir_swizzle
* as_swizzle() { return NULL
; }
122 virtual class ir_constant
* as_constant() { return NULL
; }
123 virtual class ir_discard
* as_discard() { return NULL
; }
129 ir_type
= ir_type_unset
;
135 class ir_rvalue
: public ir_instruction
{
137 virtual ir_rvalue
*clone(void *mem_ctx
, struct hash_table
*) const = 0;
139 virtual ir_constant
*constant_expression_value() = 0;
141 virtual ir_rvalue
* as_rvalue()
146 ir_rvalue
*as_rvalue_to_saturate();
148 virtual bool is_lvalue() const
154 * Get the variable that is ultimately referenced by an r-value
156 virtual ir_variable
*variable_referenced() const
163 * If an r-value is a reference to a whole variable, get that variable
166 * Pointer to a variable that is completely dereferenced by the r-value. If
167 * the r-value is not a dereference or the dereference does not access the
168 * entire variable (i.e., it's just one array element, struct field), \c NULL
171 virtual ir_variable
*whole_variable_referenced()
177 * Determine if an r-value has the value zero
179 * The base implementation of this function always returns \c false. The
180 * \c ir_constant class over-rides this function to return \c true \b only
181 * for vector and scalar types that have all elements set to the value
182 * zero (or \c false for booleans).
184 * \sa ir_constant::has_value, ir_rvalue::is_one, ir_rvalue::is_negative_one
186 virtual bool is_zero() const;
189 * Determine if an r-value has the value one
191 * The base implementation of this function always returns \c false. The
192 * \c ir_constant class over-rides this function to return \c true \b only
193 * for vector and scalar types that have all elements set to the value
194 * one (or \c true for booleans).
196 * \sa ir_constant::has_value, ir_rvalue::is_zero, ir_rvalue::is_negative_one
198 virtual bool is_one() const;
201 * Determine if an r-value has the value negative one
203 * The base implementation of this function always returns \c false. The
204 * \c ir_constant class over-rides this function to return \c true \b only
205 * for vector and scalar types that have all elements set to the value
206 * negative one. For boolean times, the result is always \c false.
208 * \sa ir_constant::has_value, ir_rvalue::is_zero, ir_rvalue::is_one
210 virtual bool is_negative_one() const;
218 * Variable storage classes
220 enum ir_variable_mode
{
221 ir_var_auto
= 0, /**< Function local variables and globals. */
222 ir_var_uniform
, /**< Variable declared as a uniform. */
226 ir_var_const_in
, /**< "in" param that must be a constant expression */
227 ir_var_system_value
, /**< Ex: front-face, instance-id, etc. */
228 ir_var_temporary
/**< Temporary variable generated during compilation. */
232 * \brief Layout qualifiers for gl_FragDepth.
234 * The AMD/ARB_conservative_depth extensions allow gl_FragDepth to be redeclared
235 * with a layout qualifier.
237 enum ir_depth_layout
{
238 ir_depth_layout_none
, /**< No depth layout is specified. */
240 ir_depth_layout_greater
,
241 ir_depth_layout_less
,
242 ir_depth_layout_unchanged
246 * \brief Convert depth layout qualifier to string.
249 depth_layout_string(ir_depth_layout layout
);
252 * Description of built-in state associated with a uniform
254 * \sa ir_variable::state_slots
256 struct ir_state_slot
{
261 class ir_variable
: public ir_instruction
{
263 ir_variable(const struct glsl_type
*, const char *, ir_variable_mode
);
265 virtual ir_variable
*clone(void *mem_ctx
, struct hash_table
*ht
) const;
267 virtual ir_variable
*as_variable()
272 virtual void accept(ir_visitor
*v
)
277 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
281 * Get the string value for the interpolation qualifier
283 * \return The string that would be used in a shader to specify \c
284 * mode will be returned.
286 * This function is used to generate error messages of the form "shader
287 * uses %s interpolation qualifier", so in the case where there is no
288 * interpolation qualifier, it returns "no".
290 * This function should only be used on a shader input or output variable.
292 const char *interpolation_string() const;
295 * Determine how this variable should be interpolated based on its
296 * interpolation qualifier (if present), whether it is gl_Color or
297 * gl_SecondaryColor, and whether flatshading is enabled in the current GL
300 * The return value will always be either INTERP_QUALIFIER_SMOOTH,
301 * INTERP_QUALIFIER_NOPERSPECTIVE, or INTERP_QUALIFIER_FLAT.
303 glsl_interp_qualifier
determine_interpolation_mode(bool flat_shade
);
306 * Delcared name of the variable
311 * Highest element accessed with a constant expression array index
313 * Not used for non-array variables.
315 unsigned max_array_access
;
318 * Is the variable read-only?
320 * This is set for variables declared as \c const, shader inputs,
323 unsigned read_only
:1;
325 unsigned invariant
:1;
328 * Has this variable been used for reading or writing?
330 * Several GLSL semantic checks require knowledge of whether or not a
331 * variable has been used. For example, it is an error to redeclare a
332 * variable as invariant after it has been used.
337 * Storage class of the variable.
339 * \sa ir_variable_mode
344 * Interpolation mode for shader inputs / outputs
346 * \sa ir_variable_interpolation
348 unsigned interpolation
:2;
351 * \name ARB_fragment_coord_conventions
354 unsigned origin_upper_left
:1;
355 unsigned pixel_center_integer
:1;
359 * Was the location explicitly set in the shader?
361 * If the location is explicitly set in the shader, it \b cannot be changed
362 * by the linker or by the API (e.g., calls to \c glBindAttribLocation have
365 unsigned explicit_location
:1;
368 * Does this variable have an initializer?
370 * This is used by the linker to cross-validiate initializers of global
373 unsigned has_initializer
:1;
376 * \brief Layout qualifier for gl_FragDepth.
378 * This is not equal to \c ir_depth_layout_none if and only if this
379 * variable is \c gl_FragDepth and a layout qualifier is specified.
381 ir_depth_layout depth_layout
;
384 * Storage location of the base of this variable
386 * The precise meaning of this field depends on the nature of the variable.
388 * - Vertex shader input: one of the values from \c gl_vert_attrib.
389 * - Vertex shader output: one of the values from \c gl_vert_result.
390 * - Fragment shader input: one of the values from \c gl_frag_attrib.
391 * - Fragment shader output: one of the values from \c gl_frag_result.
392 * - Uniforms: Per-stage uniform slot number.
393 * - Other: This field is not currently used.
395 * If the variable is a uniform, shader input, or shader output, and the
396 * slot has not been assigned, the value will be -1.
401 * Built-in state that backs this uniform
403 * Once set at variable creation, \c state_slots must remain invariant.
404 * This is because, ideally, this array would be shared by all clones of
405 * this variable in the IR tree. In other words, we'd really like for it
406 * to be a fly-weight.
408 * If the variable is not a uniform, \c num_state_slots will be zero and
409 * \c state_slots will be \c NULL.
412 unsigned num_state_slots
; /**< Number of state slots used */
413 ir_state_slot
*state_slots
; /**< State descriptors. */
417 * Emit a warning if this variable is accessed.
419 const char *warn_extension
;
422 * Value assigned in the initializer of a variable declared "const"
424 ir_constant
*constant_value
;
427 * Constant expression assigned in the initializer of the variable
430 * This field and \c ::constant_value are distinct. Even if the two fields
431 * refer to constants with the same value, they must point to separate
434 ir_constant
*constant_initializer
;
440 * The representation of a function instance; may be the full definition or
441 * simply a prototype.
443 class ir_function_signature
: public ir_instruction
{
444 /* An ir_function_signature will be part of the list of signatures in
448 ir_function_signature(const glsl_type
*return_type
);
450 virtual ir_function_signature
*clone(void *mem_ctx
,
451 struct hash_table
*ht
) const;
452 ir_function_signature
*clone_prototype(void *mem_ctx
,
453 struct hash_table
*ht
) const;
455 virtual void accept(ir_visitor
*v
)
460 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
463 * Get the name of the function for which this is a signature
465 const char *function_name() const;
468 * Get a handle to the function for which this is a signature
470 * There is no setter function, this function returns a \c const pointer,
471 * and \c ir_function_signature::_function is private for a reason. The
472 * only way to make a connection between a function and function signature
473 * is via \c ir_function::add_signature. This helps ensure that certain
474 * invariants (i.e., a function signature is in the list of signatures for
475 * its \c _function) are met.
477 * \sa ir_function::add_signature
479 inline const class ir_function
*function() const
481 return this->_function
;
485 * Check whether the qualifiers match between this signature's parameters
486 * and the supplied parameter list. If not, returns the name of the first
487 * parameter with mismatched qualifiers (for use in error messages).
489 const char *qualifiers_match(exec_list
*params
);
492 * Replace the current parameter list with the given one. This is useful
493 * if the current information came from a prototype, and either has invalid
494 * or missing parameter names.
496 void replace_parameters(exec_list
*new_params
);
499 * Function return type.
501 * \note This discards the optional precision qualifier.
503 const struct glsl_type
*return_type
;
506 * List of ir_variable of function parameters.
508 * This represents the storage. The paramaters passed in a particular
509 * call will be in ir_call::actual_paramaters.
511 struct exec_list parameters
;
513 /** Whether or not this function has a body (which may be empty). */
514 unsigned is_defined
:1;
516 /** Whether or not this function signature is a built-in. */
517 unsigned is_builtin
:1;
519 /** Body of instructions in the function. */
520 struct exec_list body
;
523 /** Function of which this signature is one overload. */
524 class ir_function
*_function
;
526 friend class ir_function
;
531 * Header for tracking multiple overloaded functions with the same name.
532 * Contains a list of ir_function_signatures representing each of the
535 class ir_function
: public ir_instruction
{
537 ir_function(const char *name
);
539 virtual ir_function
*clone(void *mem_ctx
, struct hash_table
*ht
) const;
541 virtual ir_function
*as_function()
546 virtual void accept(ir_visitor
*v
)
551 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
553 void add_signature(ir_function_signature
*sig
)
555 sig
->_function
= this;
556 this->signatures
.push_tail(sig
);
560 * Get an iterator for the set of function signatures
562 exec_list_iterator
iterator()
564 return signatures
.iterator();
568 * Find a signature that matches a set of actual parameters, taking implicit
569 * conversions into account. Also flags whether the match was exact.
571 ir_function_signature
*matching_signature(const exec_list
*actual_param
,
572 bool *match_is_exact
);
575 * Find a signature that matches a set of actual parameters, taking implicit
576 * conversions into account.
578 ir_function_signature
*matching_signature(const exec_list
*actual_param
);
581 * Find a signature that exactly matches a set of actual parameters without
582 * any implicit type conversions.
584 ir_function_signature
*exact_matching_signature(const exec_list
*actual_ps
);
587 * Name of the function.
591 /** Whether or not this function has a signature that isn't a built-in. */
592 bool has_user_signature();
595 * List of ir_function_signature for each overloaded function with this name.
597 struct exec_list signatures
;
600 inline const char *ir_function_signature::function_name() const
602 return this->_function
->name
;
608 * IR instruction representing high-level if-statements
610 class ir_if
: public ir_instruction
{
612 ir_if(ir_rvalue
*condition
)
613 : condition(condition
)
615 ir_type
= ir_type_if
;
618 virtual ir_if
*clone(void *mem_ctx
, struct hash_table
*ht
) const;
620 virtual ir_if
*as_if()
625 virtual void accept(ir_visitor
*v
)
630 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
632 ir_rvalue
*condition
;
633 /** List of ir_instruction for the body of the then branch */
634 exec_list then_instructions
;
635 /** List of ir_instruction for the body of the else branch */
636 exec_list else_instructions
;
641 * IR instruction representing a high-level loop structure.
643 class ir_loop
: public ir_instruction
{
647 virtual ir_loop
*clone(void *mem_ctx
, struct hash_table
*ht
) const;
649 virtual void accept(ir_visitor
*v
)
654 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
656 virtual ir_loop
*as_loop()
662 * Get an iterator for the instructions of the loop body
664 exec_list_iterator
iterator()
666 return body_instructions
.iterator();
669 /** List of ir_instruction that make up the body of the loop. */
670 exec_list body_instructions
;
673 * \name Loop counter and controls
675 * Represents a loop like a FORTRAN \c do-loop.
678 * If \c from and \c to are the same value, the loop will execute once.
681 ir_rvalue
*from
; /** Value of the loop counter on the first
682 * iteration of the loop.
684 ir_rvalue
*to
; /** Value of the loop counter on the last
685 * iteration of the loop.
687 ir_rvalue
*increment
;
688 ir_variable
*counter
;
691 * Comparison operation in the loop terminator.
693 * If any of the loop control fields are non-\c NULL, this field must be
694 * one of \c ir_binop_less, \c ir_binop_greater, \c ir_binop_lequal,
695 * \c ir_binop_gequal, \c ir_binop_equal, or \c ir_binop_nequal.
702 class ir_assignment
: public ir_instruction
{
704 ir_assignment(ir_rvalue
*lhs
, ir_rvalue
*rhs
, ir_rvalue
*condition
= NULL
);
707 * Construct an assignment with an explicit write mask
710 * Since a write mask is supplied, the LHS must already be a bare
711 * \c ir_dereference. The cannot be any swizzles in the LHS.
713 ir_assignment(ir_dereference
*lhs
, ir_rvalue
*rhs
, ir_rvalue
*condition
,
714 unsigned write_mask
);
716 virtual ir_assignment
*clone(void *mem_ctx
, struct hash_table
*ht
) const;
718 virtual ir_constant
*constant_expression_value();
720 virtual void accept(ir_visitor
*v
)
725 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
727 virtual ir_assignment
* as_assignment()
733 * Get a whole variable written by an assignment
735 * If the LHS of the assignment writes a whole variable, the variable is
736 * returned. Otherwise \c NULL is returned. Examples of whole-variable
739 * - Assigning to a scalar
740 * - Assigning to all components of a vector
741 * - Whole array (or matrix) assignment
742 * - Whole structure assignment
744 ir_variable
*whole_variable_written();
747 * Set the LHS of an assignment
749 void set_lhs(ir_rvalue
*lhs
);
752 * Left-hand side of the assignment.
754 * This should be treated as read only. If you need to set the LHS of an
755 * assignment, use \c ir_assignment::set_lhs.
760 * Value being assigned
765 * Optional condition for the assignment.
767 ir_rvalue
*condition
;
771 * Component mask written
773 * For non-vector types in the LHS, this field will be zero. For vector
774 * types, a bit will be set for each component that is written. Note that
775 * for \c vec2 and \c vec3 types only the lower bits will ever be set.
777 * A partially-set write mask means that each enabled channel gets
778 * the value from a consecutive channel of the rhs. For example,
779 * to write just .xyw of gl_FrontColor with color:
781 * (assign (constant bool (1)) (xyw)
782 * (var_ref gl_FragColor)
783 * (swiz xyw (var_ref color)))
785 unsigned write_mask
:4;
788 /* Update ir_expression::num_operands() and operator_strs when
789 * updating this list.
791 enum ir_expression_operation
{
800 ir_unop_exp
, /**< Log base e on gentype */
801 ir_unop_log
, /**< Natural log on gentype */
804 ir_unop_f2i
, /**< Float-to-integer conversion. */
805 ir_unop_i2f
, /**< Integer-to-float conversion. */
806 ir_unop_f2b
, /**< Float-to-boolean conversion */
807 ir_unop_b2f
, /**< Boolean-to-float conversion */
808 ir_unop_i2b
, /**< int-to-boolean conversion */
809 ir_unop_b2i
, /**< Boolean-to-int conversion */
810 ir_unop_u2f
, /**< Unsigned-to-float conversion. */
811 ir_unop_i2u
, /**< Integer-to-unsigned conversion. */
812 ir_unop_u2i
, /**< Unsigned-to-integer conversion. */
816 * \name Unary floating-point rounding operations.
827 * \name Trigonometric operations.
832 ir_unop_sin_reduced
, /**< Reduced range sin. [-pi, pi] */
833 ir_unop_cos_reduced
, /**< Reduced range cos. [-pi, pi] */
837 * \name Partial derivatives.
847 * A sentinel marking the last of the unary operations.
849 ir_last_unop
= ir_unop_noise
,
857 * Takes one of two combinations of arguments:
862 * Does not take integer types.
867 * \name Binary comparison operators which return a boolean vector.
868 * The type of both operands must be equal.
878 * Returns single boolean for whether all components of operands[0]
879 * equal the components of operands[1].
883 * Returns single boolean for whether any component of operands[0]
884 * is not equal to the corresponding component of operands[1].
890 * \name Bit-wise binary operations.
911 * A sentinel marking the last of the binary operations.
913 ir_last_binop
= ir_binop_pow
,
918 * A sentinel marking the last of all operations.
920 ir_last_opcode
= ir_last_binop
923 class ir_expression
: public ir_rvalue
{
926 * Constructor for unary operation expressions
928 ir_expression(int op
, const struct glsl_type
*type
, ir_rvalue
*);
929 ir_expression(int op
, ir_rvalue
*);
932 * Constructor for binary operation expressions
934 ir_expression(int op
, const struct glsl_type
*type
,
935 ir_rvalue
*, ir_rvalue
*);
936 ir_expression(int op
, ir_rvalue
*op0
, ir_rvalue
*op1
);
939 * Constructor for quad operator expressions
941 ir_expression(int op
, const struct glsl_type
*type
,
942 ir_rvalue
*, ir_rvalue
*, ir_rvalue
*, ir_rvalue
*);
944 virtual ir_expression
*as_expression()
949 virtual ir_expression
*clone(void *mem_ctx
, struct hash_table
*ht
) const;
952 * Attempt to constant-fold the expression
954 * If the expression cannot be constant folded, this method will return
957 virtual ir_constant
*constant_expression_value();
960 * Determine the number of operands used by an expression
962 static unsigned int get_num_operands(ir_expression_operation
);
965 * Determine the number of operands used by an expression
967 unsigned int get_num_operands() const
969 return (this->operation
== ir_quadop_vector
)
970 ? this->type
->vector_elements
: get_num_operands(operation
);
974 * Return a string representing this expression's operator.
976 const char *operator_string();
979 * Return a string representing this expression's operator.
981 static const char *operator_string(ir_expression_operation
);
985 * Do a reverse-lookup to translate the given string into an operator.
987 static ir_expression_operation
get_operator(const char *);
989 virtual void accept(ir_visitor
*v
)
994 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
996 ir_expression_operation operation
;
997 ir_rvalue
*operands
[4];
1002 * IR instruction representing a function call
1004 class ir_call
: public ir_rvalue
{
1006 ir_call(ir_function_signature
*callee
, exec_list
*actual_parameters
)
1009 ir_type
= ir_type_call
;
1010 assert(callee
->return_type
!= NULL
);
1011 type
= callee
->return_type
;
1012 actual_parameters
->move_nodes_to(& this->actual_parameters
);
1013 this->use_builtin
= callee
->is_builtin
;
1016 virtual ir_call
*clone(void *mem_ctx
, struct hash_table
*ht
) const;
1018 virtual ir_constant
*constant_expression_value();
1020 virtual ir_call
*as_call()
1025 virtual void accept(ir_visitor
*v
)
1030 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1033 * Get a generic ir_call object when an error occurs
1035 * Any allocation will be performed with 'ctx' as ralloc owner.
1037 static ir_call
*get_error_instruction(void *ctx
);
1040 * Get an iterator for the set of acutal parameters
1042 exec_list_iterator
iterator()
1044 return actual_parameters
.iterator();
1048 * Get the name of the function being called.
1050 const char *callee_name() const
1052 return callee
->function_name();
1056 * Get the function signature bound to this function call
1058 ir_function_signature
*get_callee()
1064 * Set the function call target
1066 void set_callee(ir_function_signature
*sig
);
1069 * Generates an inline version of the function before @ir,
1070 * returning the return value of the function.
1072 ir_rvalue
*generate_inline(ir_instruction
*ir
);
1074 /* List of ir_rvalue of paramaters passed in this call. */
1075 exec_list actual_parameters
;
1077 /** Should this call only bind to a built-in function? */
1084 this->ir_type
= ir_type_call
;
1087 ir_function_signature
*callee
;
1092 * \name Jump-like IR instructions.
1094 * These include \c break, \c continue, \c return, and \c discard.
1097 class ir_jump
: public ir_instruction
{
1101 ir_type
= ir_type_unset
;
1105 class ir_return
: public ir_jump
{
1110 this->ir_type
= ir_type_return
;
1113 ir_return(ir_rvalue
*value
)
1116 this->ir_type
= ir_type_return
;
1119 virtual ir_return
*clone(void *mem_ctx
, struct hash_table
*) const;
1121 virtual ir_return
*as_return()
1126 ir_rvalue
*get_value() const
1131 virtual void accept(ir_visitor
*v
)
1136 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1143 * Jump instructions used inside loops
1145 * These include \c break and \c continue. The \c break within a loop is
1146 * different from the \c break within a switch-statement.
1148 * \sa ir_switch_jump
1150 class ir_loop_jump
: public ir_jump
{
1157 ir_loop_jump(jump_mode mode
)
1159 this->ir_type
= ir_type_loop_jump
;
1164 virtual ir_loop_jump
*clone(void *mem_ctx
, struct hash_table
*) const;
1166 virtual void accept(ir_visitor
*v
)
1171 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1173 bool is_break() const
1175 return mode
== jump_break
;
1178 bool is_continue() const
1180 return mode
== jump_continue
;
1183 /** Mode selector for the jump instruction. */
1184 enum jump_mode mode
;
1186 /** Loop containing this break instruction. */
1191 * IR instruction representing discard statements.
1193 class ir_discard
: public ir_jump
{
1197 this->ir_type
= ir_type_discard
;
1198 this->condition
= NULL
;
1201 ir_discard(ir_rvalue
*cond
)
1203 this->ir_type
= ir_type_discard
;
1204 this->condition
= cond
;
1207 virtual ir_discard
*clone(void *mem_ctx
, struct hash_table
*ht
) const;
1209 virtual void accept(ir_visitor
*v
)
1214 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1216 virtual ir_discard
*as_discard()
1221 ir_rvalue
*condition
;
1227 * Texture sampling opcodes used in ir_texture
1229 enum ir_texture_opcode
{
1230 ir_tex
, /**< Regular texture look-up */
1231 ir_txb
, /**< Texture look-up with LOD bias */
1232 ir_txl
, /**< Texture look-up with explicit LOD */
1233 ir_txd
, /**< Texture look-up with partial derivatvies */
1234 ir_txf
, /**< Texel fetch with explicit LOD */
1235 ir_txs
/**< Texture size */
1240 * IR instruction to sample a texture
1242 * The specific form of the IR instruction depends on the \c mode value
1243 * selected from \c ir_texture_opcodes. In the printed IR, these will
1246 * Texel offset (0 or an expression)
1247 * | Projection divisor
1248 * | | Shadow comparitor
1251 * (tex <type> <sampler> <coordinate> 0 1 ( ))
1252 * (txb <type> <sampler> <coordinate> 0 1 ( ) <bias>)
1253 * (txl <type> <sampler> <coordinate> 0 1 ( ) <lod>)
1254 * (txd <type> <sampler> <coordinate> 0 1 ( ) (dPdx dPdy))
1255 * (txf <type> <sampler> <coordinate> 0 <lod>)
1256 * (txs <type> <sampler> <lod>)
1258 class ir_texture
: public ir_rvalue
{
1260 ir_texture(enum ir_texture_opcode op
)
1261 : op(op
), projector(NULL
), shadow_comparitor(NULL
), offset(NULL
)
1263 this->ir_type
= ir_type_texture
;
1266 virtual ir_texture
*clone(void *mem_ctx
, struct hash_table
*) const;
1268 virtual ir_constant
*constant_expression_value();
1270 virtual void accept(ir_visitor
*v
)
1275 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1278 * Return a string representing the ir_texture_opcode.
1280 const char *opcode_string();
1282 /** Set the sampler and type. */
1283 void set_sampler(ir_dereference
*sampler
, const glsl_type
*type
);
1286 * Do a reverse-lookup to translate a string into an ir_texture_opcode.
1288 static ir_texture_opcode
get_opcode(const char *);
1290 enum ir_texture_opcode op
;
1292 /** Sampler to use for the texture access. */
1293 ir_dereference
*sampler
;
1295 /** Texture coordinate to sample */
1296 ir_rvalue
*coordinate
;
1299 * Value used for projective divide.
1301 * If there is no projective divide (the common case), this will be
1302 * \c NULL. Optimization passes should check for this to point to a constant
1303 * of 1.0 and replace that with \c NULL.
1305 ir_rvalue
*projector
;
1308 * Coordinate used for comparison on shadow look-ups.
1310 * If there is no shadow comparison, this will be \c NULL. For the
1311 * \c ir_txf opcode, this *must* be \c NULL.
1313 ir_rvalue
*shadow_comparitor
;
1315 /** Texel offset. */
1319 ir_rvalue
*lod
; /**< Floating point LOD */
1320 ir_rvalue
*bias
; /**< Floating point LOD bias */
1322 ir_rvalue
*dPdx
; /**< Partial derivative of coordinate wrt X */
1323 ir_rvalue
*dPdy
; /**< Partial derivative of coordinate wrt Y */
1329 struct ir_swizzle_mask
{
1336 * Number of components in the swizzle.
1338 unsigned num_components
:3;
1341 * Does the swizzle contain duplicate components?
1343 * L-value swizzles cannot contain duplicate components.
1345 unsigned has_duplicates
:1;
1349 class ir_swizzle
: public ir_rvalue
{
1351 ir_swizzle(ir_rvalue
*, unsigned x
, unsigned y
, unsigned z
, unsigned w
,
1354 ir_swizzle(ir_rvalue
*val
, const unsigned *components
, unsigned count
);
1356 ir_swizzle(ir_rvalue
*val
, ir_swizzle_mask mask
);
1358 virtual ir_swizzle
*clone(void *mem_ctx
, struct hash_table
*) const;
1360 virtual ir_constant
*constant_expression_value();
1362 virtual ir_swizzle
*as_swizzle()
1368 * Construct an ir_swizzle from the textual representation. Can fail.
1370 static ir_swizzle
*create(ir_rvalue
*, const char *, unsigned vector_length
);
1372 virtual void accept(ir_visitor
*v
)
1377 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1379 bool is_lvalue() const
1381 return val
->is_lvalue() && !mask
.has_duplicates
;
1385 * Get the variable that is ultimately referenced by an r-value
1387 virtual ir_variable
*variable_referenced() const;
1390 ir_swizzle_mask mask
;
1394 * Initialize the mask component of a swizzle
1396 * This is used by the \c ir_swizzle constructors.
1398 void init_mask(const unsigned *components
, unsigned count
);
1402 class ir_dereference
: public ir_rvalue
{
1404 virtual ir_dereference
*clone(void *mem_ctx
, struct hash_table
*) const = 0;
1406 virtual ir_dereference
*as_dereference()
1411 bool is_lvalue() const;
1414 * Get the variable that is ultimately referenced by an r-value
1416 virtual ir_variable
*variable_referenced() const = 0;
1420 class ir_dereference_variable
: public ir_dereference
{
1422 ir_dereference_variable(ir_variable
*var
);
1424 virtual ir_dereference_variable
*clone(void *mem_ctx
,
1425 struct hash_table
*) const;
1427 virtual ir_constant
*constant_expression_value();
1429 virtual ir_dereference_variable
*as_dereference_variable()
1435 * Get the variable that is ultimately referenced by an r-value
1437 virtual ir_variable
*variable_referenced() const
1442 virtual ir_variable
*whole_variable_referenced()
1444 /* ir_dereference_variable objects always dereference the entire
1445 * variable. However, if this dereference is dereferenced by anything
1446 * else, the complete deferefernce chain is not a whole-variable
1447 * dereference. This method should only be called on the top most
1448 * ir_rvalue in a dereference chain.
1453 virtual void accept(ir_visitor
*v
)
1458 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1461 * Object being dereferenced.
1467 class ir_dereference_array
: public ir_dereference
{
1469 ir_dereference_array(ir_rvalue
*value
, ir_rvalue
*array_index
);
1471 ir_dereference_array(ir_variable
*var
, ir_rvalue
*array_index
);
1473 virtual ir_dereference_array
*clone(void *mem_ctx
,
1474 struct hash_table
*) const;
1476 virtual ir_constant
*constant_expression_value();
1478 virtual ir_dereference_array
*as_dereference_array()
1484 * Get the variable that is ultimately referenced by an r-value
1486 virtual ir_variable
*variable_referenced() const
1488 return this->array
->variable_referenced();
1491 virtual void accept(ir_visitor
*v
)
1496 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1499 ir_rvalue
*array_index
;
1502 void set_array(ir_rvalue
*value
);
1506 class ir_dereference_record
: public ir_dereference
{
1508 ir_dereference_record(ir_rvalue
*value
, const char *field
);
1510 ir_dereference_record(ir_variable
*var
, const char *field
);
1512 virtual ir_dereference_record
*clone(void *mem_ctx
,
1513 struct hash_table
*) const;
1515 virtual ir_constant
*constant_expression_value();
1518 * Get the variable that is ultimately referenced by an r-value
1520 virtual ir_variable
*variable_referenced() const
1522 return this->record
->variable_referenced();
1525 virtual void accept(ir_visitor
*v
)
1530 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1538 * Data stored in an ir_constant
1540 union ir_constant_data
{
1548 class ir_constant
: public ir_rvalue
{
1550 ir_constant(const struct glsl_type
*type
, const ir_constant_data
*data
);
1551 ir_constant(bool b
);
1552 ir_constant(unsigned int u
);
1554 ir_constant(float f
);
1557 * Construct an ir_constant from a list of ir_constant values
1559 ir_constant(const struct glsl_type
*type
, exec_list
*values
);
1562 * Construct an ir_constant from a scalar component of another ir_constant
1564 * The new \c ir_constant inherits the type of the component from the
1568 * In the case of a matrix constant, the new constant is a scalar, \b not
1571 ir_constant(const ir_constant
*c
, unsigned i
);
1574 * Return a new ir_constant of the specified type containing all zeros.
1576 static ir_constant
*zero(void *mem_ctx
, const glsl_type
*type
);
1578 virtual ir_constant
*clone(void *mem_ctx
, struct hash_table
*) const;
1580 virtual ir_constant
*constant_expression_value();
1582 virtual ir_constant
*as_constant()
1587 virtual void accept(ir_visitor
*v
)
1592 virtual ir_visitor_status
accept(ir_hierarchical_visitor
*);
1595 * Get a particular component of a constant as a specific type
1597 * This is useful, for example, to get a value from an integer constant
1598 * as a float or bool. This appears frequently when constructors are
1599 * called with all constant parameters.
1602 bool get_bool_component(unsigned i
) const;
1603 float get_float_component(unsigned i
) const;
1604 int get_int_component(unsigned i
) const;
1605 unsigned get_uint_component(unsigned i
) const;
1608 ir_constant
*get_array_element(unsigned i
) const;
1610 ir_constant
*get_record_field(const char *name
);
1613 * Determine whether a constant has the same value as another constant
1615 * \sa ir_constant::is_zero, ir_constant::is_one,
1616 * ir_constant::is_negative_one
1618 bool has_value(const ir_constant
*) const;
1620 virtual bool is_zero() const;
1621 virtual bool is_one() const;
1622 virtual bool is_negative_one() const;
1625 * Value of the constant.
1627 * The field used to back the values supplied by the constant is determined
1628 * by the type associated with the \c ir_instruction. Constants may be
1629 * scalars, vectors, or matrices.
1631 union ir_constant_data value
;
1633 /* Array elements */
1634 ir_constant
**array_elements
;
1636 /* Structure fields */
1637 exec_list components
;
1641 * Parameterless constructor only used by the clone method
1649 * Apply a visitor to each IR node in a list
1652 visit_exec_list(exec_list
*list
, ir_visitor
*visitor
);
1655 * Validate invariants on each IR node in a list
1657 void validate_ir_tree(exec_list
*instructions
);
1659 struct _mesa_glsl_parse_state
;
1660 struct gl_shader_program
;
1663 * Detect whether an unlinked shader contains static recursion
1665 * If the list of instructions is determined to contain static recursion,
1666 * \c _mesa_glsl_error will be called to emit error messages for each function
1667 * that is in the recursion cycle.
1670 detect_recursion_unlinked(struct _mesa_glsl_parse_state
*state
,
1671 exec_list
*instructions
);
1674 * Detect whether a linked shader contains static recursion
1676 * If the list of instructions is determined to contain static recursion,
1677 * \c link_error_printf will be called to emit error messages for each function
1678 * that is in the recursion cycle. In addition,
1679 * \c gl_shader_program::LinkStatus will be set to false.
1682 detect_recursion_linked(struct gl_shader_program
*prog
,
1683 exec_list
*instructions
);
1686 * Make a clone of each IR instruction in a list
1688 * \param in List of IR instructions that are to be cloned
1689 * \param out List to hold the cloned instructions
1692 clone_ir_list(void *mem_ctx
, exec_list
*out
, const exec_list
*in
);
1695 _mesa_glsl_initialize_variables(exec_list
*instructions
,
1696 struct _mesa_glsl_parse_state
*state
);
1699 _mesa_glsl_initialize_functions(_mesa_glsl_parse_state
*state
);
1702 _mesa_glsl_release_functions(void);
1705 reparent_ir(exec_list
*list
, void *mem_ctx
);
1707 struct glsl_symbol_table
;
1710 import_prototypes(const exec_list
*source
, exec_list
*dest
,
1711 struct glsl_symbol_table
*symbols
, void *mem_ctx
);
1714 ir_has_call(ir_instruction
*ir
);
1717 do_set_program_inouts(exec_list
*instructions
, struct gl_program
*prog
,
1718 bool is_fragment_shader
);
1721 prototype_string(const glsl_type
*return_type
, const char *name
,
1722 exec_list
*parameters
);