2 * Copyright © 2010 Intel Corporation
4 * Permission is hereby granted, free of charge, to any person obtaining a
5 * copy of this software and associated documentation files (the "Software"),
6 * to deal in the Software without restriction, including without limitation
7 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
8 * and/or sell copies of the Software, and to permit persons to whom the
9 * Software is furnished to do so, subject to the following conditions:
11 * The above copyright notice and this permission notice (including the next
12 * paragraph) shall be included in all copies or substantial portions of the
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
18 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
21 * DEALINGS IN THE SOFTWARE.
24 #include "glsl_symbol_table.h"
26 #include "glsl_types.h"
28 #include "main/core.h" /* for MIN2 */
31 convert_component(ir_rvalue
*src
, const glsl_type
*desired_type
);
34 apply_implicit_conversion(const glsl_type
*to
, ir_rvalue
* &from
,
35 struct _mesa_glsl_parse_state
*state
);
38 process_parameters(exec_list
*instructions
, exec_list
*actual_parameters
,
39 exec_list
*parameters
,
40 struct _mesa_glsl_parse_state
*state
)
44 foreach_list (n
, parameters
) {
45 ast_node
*const ast
= exec_node_data(ast_node
, n
, link
);
46 ir_rvalue
*result
= ast
->hir(instructions
, state
);
48 ir_constant
*const constant
= result
->constant_expression_value();
52 actual_parameters
->push_tail(result
);
61 * Generate a source prototype for a function signature
63 * \param return_type Return type of the function. May be \c NULL.
64 * \param name Name of the function.
65 * \param parameters List of \c ir_instruction nodes representing the
66 * parameter list for the function. This may be either a
67 * formal (\c ir_variable) or actual (\c ir_rvalue)
68 * parameter list. Only the type is used.
71 * A ralloced string representing the prototype of the function.
74 prototype_string(const glsl_type
*return_type
, const char *name
,
75 exec_list
*parameters
)
79 if (return_type
!= NULL
)
80 str
= ralloc_asprintf(NULL
, "%s ", return_type
->name
);
82 ralloc_asprintf_append(&str
, "%s(", name
);
84 const char *comma
= "";
85 foreach_list(node
, parameters
) {
86 const ir_instruction
*const param
= (ir_instruction
*) node
;
88 ralloc_asprintf_append(&str
, "%s%s", comma
, param
->type
->name
);
92 ralloc_strcat(&str
, ")");
97 * If a function call is generated, \c call_ir will point to it on exit.
98 * Otherwise \c call_ir will be set to \c NULL.
101 generate_call(exec_list
*instructions
, ir_function_signature
*sig
,
102 YYLTYPE
*loc
, exec_list
*actual_parameters
,
104 struct _mesa_glsl_parse_state
*state
)
107 exec_list post_call_conversions
;
111 /* Verify that 'out' and 'inout' actual parameters are lvalues. This
112 * isn't done in ir_function::matching_signature because that function
113 * cannot generate the necessary diagnostics.
115 * Also, validate that 'const_in' formal parameters (an extension of our
116 * IR) correspond to ir_constant actual parameters.
118 * Also, perform implicit conversion of arguments. Note: to implicitly
119 * convert out parameters, we need to place them in a temporary
120 * variable, and do the conversion after the call takes place. Since we
121 * haven't emitted the call yet, we'll place the post-call conversions
122 * in a temporary exec_list, and emit them later.
124 exec_list_iterator actual_iter
= actual_parameters
->iterator();
125 exec_list_iterator formal_iter
= sig
->parameters
.iterator();
127 while (actual_iter
.has_next()) {
128 ir_rvalue
*actual
= (ir_rvalue
*) actual_iter
.get();
129 ir_variable
*formal
= (ir_variable
*) formal_iter
.get();
131 assert(actual
!= NULL
);
132 assert(formal
!= NULL
);
134 if (formal
->mode
== ir_var_const_in
&& !actual
->as_constant()) {
135 _mesa_glsl_error(loc
, state
,
136 "parameter `%s' must be a constant expression",
138 return ir_call::get_error_instruction(ctx
);
141 if ((formal
->mode
== ir_var_out
)
142 || (formal
->mode
== ir_var_inout
)) {
143 const char *mode
= NULL
;
144 switch (formal
->mode
) {
145 case ir_var_out
: mode
= "out"; break;
146 case ir_var_inout
: mode
= "inout"; break;
147 default: assert(false); break;
149 /* FIXME: 'loc' is incorrect (as of 2011-01-21). It is always
152 if (actual
->variable_referenced()
153 && actual
->variable_referenced()->read_only
) {
154 _mesa_glsl_error(loc
, state
,
155 "function parameter '%s %s' references the "
156 "read-only variable '%s'",
158 actual
->variable_referenced()->name
);
160 } else if (!actual
->is_lvalue()) {
161 _mesa_glsl_error(loc
, state
,
162 "function parameter '%s %s' is not an lvalue",
167 if (formal
->type
->is_numeric() || formal
->type
->is_boolean()) {
168 switch (formal
->mode
) {
169 case ir_var_const_in
:
172 = convert_component(actual
, formal
->type
);
173 actual
->replace_with(converted
);
177 if (actual
->type
!= formal
->type
) {
178 /* To convert an out parameter, we need to create a
179 * temporary variable to hold the value before conversion,
180 * and then perform the conversion after the function call
183 * This has the effect of transforming code like this:
189 * Into IR that's equivalent to this:
193 * int out_parameter_conversion;
194 * f(out_parameter_conversion);
195 * value = float(out_parameter_conversion);
198 new(ctx
) ir_variable(formal
->type
,
199 "out_parameter_conversion",
201 instructions
->push_tail(tmp
);
202 ir_dereference_variable
*deref_tmp_1
203 = new(ctx
) ir_dereference_variable(tmp
);
204 ir_dereference_variable
*deref_tmp_2
205 = new(ctx
) ir_dereference_variable(tmp
);
206 ir_rvalue
*converted_tmp
207 = convert_component(deref_tmp_1
, actual
->type
);
208 ir_assignment
*assignment
209 = new(ctx
) ir_assignment(actual
, converted_tmp
);
210 post_call_conversions
.push_tail(assignment
);
211 actual
->replace_with(deref_tmp_2
);
215 /* Inout parameters should never require conversion, since that
216 * would require an implicit conversion to exist both to and
217 * from the formal parameter type, and there are no
218 * bidirectional implicit conversions.
220 assert (actual
->type
== formal
->type
);
223 assert (!"Illegal formal parameter mode");
232 /* Always insert the call in the instruction stream, and return a deref
233 * of its return val if it returns a value, since we don't know if
234 * the rvalue is going to be assigned to anything or not.
236 * Also insert any out parameter conversions after the call.
238 ir_call
*call
= new(ctx
) ir_call(sig
, actual_parameters
);
239 ir_dereference_variable
*deref
;
240 if (!sig
->return_type
->is_void()) {
241 /* If the function call is a constant expression, don't
242 * generate the instructions to call it; just generate an
243 * ir_constant representing the constant value.
245 * Function calls can only be constant expressions starting
248 if (state
->language_version
>= 120) {
249 ir_constant
*const_val
= call
->constant_expression_value();
257 var
= new(ctx
) ir_variable(sig
->return_type
,
258 ralloc_asprintf(ctx
, "%s_retval",
259 sig
->function_name()),
261 instructions
->push_tail(var
);
263 deref
= new(ctx
) ir_dereference_variable(var
);
264 ir_assignment
*assign
= new(ctx
) ir_assignment(deref
, call
, NULL
);
265 instructions
->push_tail(assign
);
268 deref
= new(ctx
) ir_dereference_variable(var
);
270 instructions
->push_tail(call
);
274 instructions
->append_list(&post_call_conversions
);
279 * Given a function name and parameter list, find the matching signature.
281 static ir_function_signature
*
282 match_function_by_name(const char *name
,
283 exec_list
*actual_parameters
,
284 struct _mesa_glsl_parse_state
*state
)
287 ir_function
*f
= state
->symbols
->get_function(name
);
288 ir_function_signature
*local_sig
= NULL
;
289 ir_function_signature
*sig
= NULL
;
291 /* Is the function hidden by a record type constructor? */
292 if (state
->symbols
->get_type(name
))
293 goto done
; /* no match */
295 /* Is the function hidden by a variable (impossible in 1.10)? */
296 if (state
->language_version
!= 110 && state
->symbols
->get_variable(name
))
297 goto done
; /* no match */
300 /* Look for a match in the local shader. If exact, we're done. */
301 bool is_exact
= false;
302 sig
= local_sig
= f
->matching_signature(actual_parameters
, &is_exact
);
306 if (!state
->es_shader
&& f
->has_user_signature()) {
307 /* In desktop GL, the presence of a user-defined signature hides any
308 * built-in signatures, so we must ignore them. In contrast, in ES2
309 * user-defined signatures add new overloads, so we must proceed.
315 /* Local shader has no exact candidates; check the built-ins. */
316 _mesa_glsl_initialize_functions(state
);
317 for (unsigned i
= 0; i
< state
->num_builtins_to_link
; i
++) {
318 ir_function
*builtin
=
319 state
->builtins_to_link
[i
]->symbols
->get_function(name
);
323 bool is_exact
= false;
324 ir_function_signature
*builtin_sig
=
325 builtin
->matching_signature(actual_parameters
, &is_exact
);
327 if (builtin_sig
== NULL
)
330 /* If the built-in signature is exact, we can stop. */
337 /* We found an inexact match, which is better than nothing. However,
338 * we should keep searching for an exact match.
346 /* If the match is from a linked built-in shader, import the prototype. */
347 if (sig
!= local_sig
) {
349 f
= new(ctx
) ir_function(name
);
350 state
->symbols
->add_global_function(f
);
351 emit_function(state
, f
);
353 f
->add_signature(sig
->clone_prototype(f
, NULL
));
360 * Raise a "no matching function" error, listing all possible overloads the
361 * compiler considered so developers can figure out what went wrong.
364 no_matching_function_error(const char *name
,
366 exec_list
*actual_parameters
,
367 _mesa_glsl_parse_state
*state
)
369 char *str
= prototype_string(NULL
, name
, actual_parameters
);
370 _mesa_glsl_error(loc
, state
, "no matching function for call to `%s'", str
);
373 const char *prefix
= "candidates are: ";
375 for (int i
= -1; i
< (int) state
->num_builtins_to_link
; i
++) {
376 glsl_symbol_table
*syms
= i
>= 0 ? state
->builtins_to_link
[i
]->symbols
378 ir_function
*f
= syms
->get_function(name
);
382 foreach_list (node
, &f
->signatures
) {
383 ir_function_signature
*sig
= (ir_function_signature
*) node
;
385 str
= prototype_string(sig
->return_type
, f
->name
, &sig
->parameters
);
386 _mesa_glsl_error(loc
, state
, "%s%s", prefix
, str
);
395 * Perform automatic type conversion of constructor parameters
397 * This implements the rules in the "Conversion and Scalar Constructors"
398 * section (GLSL 1.10 section 5.4.1), not the "Implicit Conversions" rules.
401 convert_component(ir_rvalue
*src
, const glsl_type
*desired_type
)
403 void *ctx
= ralloc_parent(src
);
404 const unsigned a
= desired_type
->base_type
;
405 const unsigned b
= src
->type
->base_type
;
406 ir_expression
*result
= NULL
;
408 if (src
->type
->is_error())
411 assert(a
<= GLSL_TYPE_BOOL
);
412 assert(b
<= GLSL_TYPE_BOOL
);
421 result
= new(ctx
) ir_expression(ir_unop_i2u
, src
);
423 case GLSL_TYPE_FLOAT
:
424 result
= new(ctx
) ir_expression(ir_unop_i2u
,
425 new(ctx
) ir_expression(ir_unop_f2i
, src
));
428 result
= new(ctx
) ir_expression(ir_unop_i2u
,
429 new(ctx
) ir_expression(ir_unop_b2i
, src
));
436 result
= new(ctx
) ir_expression(ir_unop_u2i
, src
);
438 case GLSL_TYPE_FLOAT
:
439 result
= new(ctx
) ir_expression(ir_unop_f2i
, src
);
442 result
= new(ctx
) ir_expression(ir_unop_b2i
, src
);
446 case GLSL_TYPE_FLOAT
:
449 result
= new(ctx
) ir_expression(ir_unop_u2f
, desired_type
, src
, NULL
);
452 result
= new(ctx
) ir_expression(ir_unop_i2f
, desired_type
, src
, NULL
);
455 result
= new(ctx
) ir_expression(ir_unop_b2f
, desired_type
, src
, NULL
);
462 result
= new(ctx
) ir_expression(ir_unop_i2b
,
463 new(ctx
) ir_expression(ir_unop_u2i
, src
));
466 result
= new(ctx
) ir_expression(ir_unop_i2b
, desired_type
, src
, NULL
);
468 case GLSL_TYPE_FLOAT
:
469 result
= new(ctx
) ir_expression(ir_unop_f2b
, desired_type
, src
, NULL
);
475 assert(result
!= NULL
);
476 assert(result
->type
== desired_type
);
478 /* Try constant folding; it may fold in the conversion we just added. */
479 ir_constant
*const constant
= result
->constant_expression_value();
480 return (constant
!= NULL
) ? (ir_rvalue
*) constant
: (ir_rvalue
*) result
;
484 * Dereference a specific component from a scalar, vector, or matrix
487 dereference_component(ir_rvalue
*src
, unsigned component
)
489 void *ctx
= ralloc_parent(src
);
490 assert(component
< src
->type
->components());
492 /* If the source is a constant, just create a new constant instead of a
493 * dereference of the existing constant.
495 ir_constant
*constant
= src
->as_constant();
497 return new(ctx
) ir_constant(constant
, component
);
499 if (src
->type
->is_scalar()) {
501 } else if (src
->type
->is_vector()) {
502 return new(ctx
) ir_swizzle(src
, component
, 0, 0, 0, 1);
504 assert(src
->type
->is_matrix());
506 /* Dereference a row of the matrix, then call this function again to get
507 * a specific element from that row.
509 const int c
= component
/ src
->type
->column_type()->vector_elements
;
510 const int r
= component
% src
->type
->column_type()->vector_elements
;
511 ir_constant
*const col_index
= new(ctx
) ir_constant(c
);
512 ir_dereference
*const col
= new(ctx
) ir_dereference_array(src
, col_index
);
514 col
->type
= src
->type
->column_type();
516 return dereference_component(col
, r
);
519 assert(!"Should not get here.");
525 process_array_constructor(exec_list
*instructions
,
526 const glsl_type
*constructor_type
,
527 YYLTYPE
*loc
, exec_list
*parameters
,
528 struct _mesa_glsl_parse_state
*state
)
531 /* Array constructors come in two forms: sized and unsized. Sized array
532 * constructors look like 'vec4[2](a, b)', where 'a' and 'b' are vec4
533 * variables. In this case the number of parameters must exactly match the
534 * specified size of the array.
536 * Unsized array constructors look like 'vec4[](a, b)', where 'a' and 'b'
537 * are vec4 variables. In this case the size of the array being constructed
538 * is determined by the number of parameters.
540 * From page 52 (page 58 of the PDF) of the GLSL 1.50 spec:
542 * "There must be exactly the same number of arguments as the size of
543 * the array being constructed. If no size is present in the
544 * constructor, then the array is explicitly sized to the number of
545 * arguments provided. The arguments are assigned in order, starting at
546 * element 0, to the elements of the constructed array. Each argument
547 * must be the same type as the element type of the array, or be a type
548 * that can be converted to the element type of the array according to
549 * Section 4.1.10 "Implicit Conversions.""
551 exec_list actual_parameters
;
552 const unsigned parameter_count
=
553 process_parameters(instructions
, &actual_parameters
, parameters
, state
);
555 if ((parameter_count
== 0)
556 || ((constructor_type
->length
!= 0)
557 && (constructor_type
->length
!= parameter_count
))) {
558 const unsigned min_param
= (constructor_type
->length
== 0)
559 ? 1 : constructor_type
->length
;
561 _mesa_glsl_error(loc
, state
, "array constructor must have %s %u "
563 (constructor_type
->length
!= 0) ? "at least" : "exactly",
564 min_param
, (min_param
<= 1) ? "" : "s");
565 return ir_call::get_error_instruction(ctx
);
568 if (constructor_type
->length
== 0) {
570 glsl_type::get_array_instance(constructor_type
->element_type(),
572 assert(constructor_type
!= NULL
);
573 assert(constructor_type
->length
== parameter_count
);
576 bool all_parameters_are_constant
= true;
578 /* Type cast each parameter and, if possible, fold constants. */
579 foreach_list_safe(n
, &actual_parameters
) {
580 ir_rvalue
*ir
= (ir_rvalue
*) n
;
581 ir_rvalue
*result
= ir
;
583 /* Apply implicit conversions (not the scalar constructor rules!). See
584 * the spec quote above. */
585 if (constructor_type
->element_type()->is_float()) {
586 const glsl_type
*desired_type
=
587 glsl_type::get_instance(GLSL_TYPE_FLOAT
,
588 ir
->type
->vector_elements
,
589 ir
->type
->matrix_columns
);
590 if (result
->type
->can_implicitly_convert_to(desired_type
)) {
591 /* Even though convert_component() implements the constructor
592 * conversion rules (not the implicit conversion rules), its safe
593 * to use it here because we already checked that the implicit
594 * conversion is legal.
596 result
= convert_component(ir
, desired_type
);
600 if (result
->type
!= constructor_type
->element_type()) {
601 _mesa_glsl_error(loc
, state
, "type error in array constructor: "
602 "expected: %s, found %s",
603 constructor_type
->element_type()->name
,
607 /* Attempt to convert the parameter to a constant valued expression.
608 * After doing so, track whether or not all the parameters to the
609 * constructor are trivially constant valued expressions.
611 ir_rvalue
*const constant
= result
->constant_expression_value();
613 if (constant
!= NULL
)
616 all_parameters_are_constant
= false;
618 ir
->replace_with(result
);
621 if (all_parameters_are_constant
)
622 return new(ctx
) ir_constant(constructor_type
, &actual_parameters
);
624 ir_variable
*var
= new(ctx
) ir_variable(constructor_type
, "array_ctor",
626 instructions
->push_tail(var
);
629 foreach_list(node
, &actual_parameters
) {
630 ir_rvalue
*rhs
= (ir_rvalue
*) node
;
631 ir_rvalue
*lhs
= new(ctx
) ir_dereference_array(var
,
632 new(ctx
) ir_constant(i
));
634 ir_instruction
*assignment
= new(ctx
) ir_assignment(lhs
, rhs
, NULL
);
635 instructions
->push_tail(assignment
);
640 return new(ctx
) ir_dereference_variable(var
);
645 * Try to convert a record constructor to a constant expression
648 constant_record_constructor(const glsl_type
*constructor_type
,
649 exec_list
*parameters
, void *mem_ctx
)
651 foreach_list(node
, parameters
) {
652 ir_constant
*constant
= ((ir_instruction
*) node
)->as_constant();
653 if (constant
== NULL
)
655 node
->replace_with(constant
);
658 return new(mem_ctx
) ir_constant(constructor_type
, parameters
);
663 * Determine if a list consists of a single scalar r-value
666 single_scalar_parameter(exec_list
*parameters
)
668 const ir_rvalue
*const p
= (ir_rvalue
*) parameters
->head
;
669 assert(((ir_rvalue
*)p
)->as_rvalue() != NULL
);
671 return (p
->type
->is_scalar() && p
->next
->is_tail_sentinel());
676 * Generate inline code for a vector constructor
678 * The generated constructor code will consist of a temporary variable
679 * declaration of the same type as the constructor. A sequence of assignments
680 * from constructor parameters to the temporary will follow.
683 * An \c ir_dereference_variable of the temprorary generated in the constructor
687 emit_inline_vector_constructor(const glsl_type
*type
,
688 exec_list
*instructions
,
689 exec_list
*parameters
,
692 assert(!parameters
->is_empty());
694 ir_variable
*var
= new(ctx
) ir_variable(type
, "vec_ctor", ir_var_temporary
);
695 instructions
->push_tail(var
);
697 /* There are two kinds of vector constructors.
699 * - Construct a vector from a single scalar by replicating that scalar to
700 * all components of the vector.
702 * - Construct a vector from an arbirary combination of vectors and
703 * scalars. The components of the constructor parameters are assigned
704 * to the vector in order until the vector is full.
706 const unsigned lhs_components
= type
->components();
707 if (single_scalar_parameter(parameters
)) {
708 ir_rvalue
*first_param
= (ir_rvalue
*)parameters
->head
;
709 ir_rvalue
*rhs
= new(ctx
) ir_swizzle(first_param
, 0, 0, 0, 0,
711 ir_dereference_variable
*lhs
= new(ctx
) ir_dereference_variable(var
);
712 const unsigned mask
= (1U << lhs_components
) - 1;
714 assert(rhs
->type
== lhs
->type
);
716 ir_instruction
*inst
= new(ctx
) ir_assignment(lhs
, rhs
, NULL
, mask
);
717 instructions
->push_tail(inst
);
719 unsigned base_component
= 0;
720 unsigned base_lhs_component
= 0;
721 ir_constant_data data
;
722 unsigned constant_mask
= 0, constant_components
= 0;
724 memset(&data
, 0, sizeof(data
));
726 foreach_list(node
, parameters
) {
727 ir_rvalue
*param
= (ir_rvalue
*) node
;
728 unsigned rhs_components
= param
->type
->components();
730 /* Do not try to assign more components to the vector than it has!
732 if ((rhs_components
+ base_lhs_component
) > lhs_components
) {
733 rhs_components
= lhs_components
- base_lhs_component
;
736 const ir_constant
*const c
= param
->as_constant();
738 for (unsigned i
= 0; i
< rhs_components
; i
++) {
739 switch (c
->type
->base_type
) {
741 data
.u
[i
+ base_component
] = c
->get_uint_component(i
);
744 data
.i
[i
+ base_component
] = c
->get_int_component(i
);
746 case GLSL_TYPE_FLOAT
:
747 data
.f
[i
+ base_component
] = c
->get_float_component(i
);
750 data
.b
[i
+ base_component
] = c
->get_bool_component(i
);
753 assert(!"Should not get here.");
758 /* Mask of fields to be written in the assignment.
760 constant_mask
|= ((1U << rhs_components
) - 1) << base_lhs_component
;
761 constant_components
+= rhs_components
;
763 base_component
+= rhs_components
;
765 /* Advance the component index by the number of components
766 * that were just assigned.
768 base_lhs_component
+= rhs_components
;
771 if (constant_mask
!= 0) {
772 ir_dereference
*lhs
= new(ctx
) ir_dereference_variable(var
);
773 const glsl_type
*rhs_type
= glsl_type::get_instance(var
->type
->base_type
,
776 ir_rvalue
*rhs
= new(ctx
) ir_constant(rhs_type
, &data
);
778 ir_instruction
*inst
=
779 new(ctx
) ir_assignment(lhs
, rhs
, NULL
, constant_mask
);
780 instructions
->push_tail(inst
);
784 foreach_list(node
, parameters
) {
785 ir_rvalue
*param
= (ir_rvalue
*) node
;
786 unsigned rhs_components
= param
->type
->components();
788 /* Do not try to assign more components to the vector than it has!
790 if ((rhs_components
+ base_component
) > lhs_components
) {
791 rhs_components
= lhs_components
- base_component
;
794 const ir_constant
*const c
= param
->as_constant();
796 /* Mask of fields to be written in the assignment.
798 const unsigned write_mask
= ((1U << rhs_components
) - 1)
801 ir_dereference
*lhs
= new(ctx
) ir_dereference_variable(var
);
803 /* Generate a swizzle so that LHS and RHS sizes match.
806 new(ctx
) ir_swizzle(param
, 0, 1, 2, 3, rhs_components
);
808 ir_instruction
*inst
=
809 new(ctx
) ir_assignment(lhs
, rhs
, NULL
, write_mask
);
810 instructions
->push_tail(inst
);
813 /* Advance the component index by the number of components that were
816 base_component
+= rhs_components
;
819 return new(ctx
) ir_dereference_variable(var
);
824 * Generate assignment of a portion of a vector to a portion of a matrix column
826 * \param src_base First component of the source to be used in assignment
827 * \param column Column of destination to be assiged
828 * \param row_base First component of the destination column to be assigned
829 * \param count Number of components to be assigned
832 * \c src_base + \c count must be less than or equal to the number of components
833 * in the source vector.
836 assign_to_matrix_column(ir_variable
*var
, unsigned column
, unsigned row_base
,
837 ir_rvalue
*src
, unsigned src_base
, unsigned count
,
840 ir_constant
*col_idx
= new(mem_ctx
) ir_constant(column
);
841 ir_dereference
*column_ref
= new(mem_ctx
) ir_dereference_array(var
, col_idx
);
843 assert(column_ref
->type
->components() >= (row_base
+ count
));
844 assert(src
->type
->components() >= (src_base
+ count
));
846 /* Generate a swizzle that extracts the number of components from the source
847 * that are to be assigned to the column of the matrix.
849 if (count
< src
->type
->vector_elements
) {
850 src
= new(mem_ctx
) ir_swizzle(src
,
851 src_base
+ 0, src_base
+ 1,
852 src_base
+ 2, src_base
+ 3,
856 /* Mask of fields to be written in the assignment.
858 const unsigned write_mask
= ((1U << count
) - 1) << row_base
;
860 return new(mem_ctx
) ir_assignment(column_ref
, src
, NULL
, write_mask
);
865 * Generate inline code for a matrix constructor
867 * The generated constructor code will consist of a temporary variable
868 * declaration of the same type as the constructor. A sequence of assignments
869 * from constructor parameters to the temporary will follow.
872 * An \c ir_dereference_variable of the temprorary generated in the constructor
876 emit_inline_matrix_constructor(const glsl_type
*type
,
877 exec_list
*instructions
,
878 exec_list
*parameters
,
881 assert(!parameters
->is_empty());
883 ir_variable
*var
= new(ctx
) ir_variable(type
, "mat_ctor", ir_var_temporary
);
884 instructions
->push_tail(var
);
886 /* There are three kinds of matrix constructors.
888 * - Construct a matrix from a single scalar by replicating that scalar to
889 * along the diagonal of the matrix and setting all other components to
892 * - Construct a matrix from an arbirary combination of vectors and
893 * scalars. The components of the constructor parameters are assigned
894 * to the matrix in colum-major order until the matrix is full.
896 * - Construct a matrix from a single matrix. The source matrix is copied
897 * to the upper left portion of the constructed matrix, and the remaining
898 * elements take values from the identity matrix.
900 ir_rvalue
*const first_param
= (ir_rvalue
*) parameters
->head
;
901 if (single_scalar_parameter(parameters
)) {
902 /* Assign the scalar to the X component of a vec4, and fill the remaining
903 * components with zero.
905 ir_variable
*rhs_var
=
906 new(ctx
) ir_variable(glsl_type::vec4_type
, "mat_ctor_vec",
908 instructions
->push_tail(rhs_var
);
910 ir_constant_data zero
;
916 ir_instruction
*inst
=
917 new(ctx
) ir_assignment(new(ctx
) ir_dereference_variable(rhs_var
),
918 new(ctx
) ir_constant(rhs_var
->type
, &zero
),
920 instructions
->push_tail(inst
);
922 ir_dereference
*const rhs_ref
= new(ctx
) ir_dereference_variable(rhs_var
);
924 inst
= new(ctx
) ir_assignment(rhs_ref
, first_param
, NULL
, 0x01);
925 instructions
->push_tail(inst
);
927 /* Assign the temporary vector to each column of the destination matrix
928 * with a swizzle that puts the X component on the diagonal of the
929 * matrix. In some cases this may mean that the X component does not
930 * get assigned into the column at all (i.e., when the matrix has more
931 * columns than rows).
933 static const unsigned rhs_swiz
[4][4] = {
940 const unsigned cols_to_init
= MIN2(type
->matrix_columns
,
941 type
->vector_elements
);
942 for (unsigned i
= 0; i
< cols_to_init
; i
++) {
943 ir_constant
*const col_idx
= new(ctx
) ir_constant(i
);
944 ir_rvalue
*const col_ref
= new(ctx
) ir_dereference_array(var
, col_idx
);
946 ir_rvalue
*const rhs_ref
= new(ctx
) ir_dereference_variable(rhs_var
);
947 ir_rvalue
*const rhs
= new(ctx
) ir_swizzle(rhs_ref
, rhs_swiz
[i
],
948 type
->vector_elements
);
950 inst
= new(ctx
) ir_assignment(col_ref
, rhs
, NULL
);
951 instructions
->push_tail(inst
);
954 for (unsigned i
= cols_to_init
; i
< type
->matrix_columns
; i
++) {
955 ir_constant
*const col_idx
= new(ctx
) ir_constant(i
);
956 ir_rvalue
*const col_ref
= new(ctx
) ir_dereference_array(var
, col_idx
);
958 ir_rvalue
*const rhs_ref
= new(ctx
) ir_dereference_variable(rhs_var
);
959 ir_rvalue
*const rhs
= new(ctx
) ir_swizzle(rhs_ref
, 1, 1, 1, 1,
960 type
->vector_elements
);
962 inst
= new(ctx
) ir_assignment(col_ref
, rhs
, NULL
);
963 instructions
->push_tail(inst
);
965 } else if (first_param
->type
->is_matrix()) {
966 /* From page 50 (56 of the PDF) of the GLSL 1.50 spec:
968 * "If a matrix is constructed from a matrix, then each component
969 * (column i, row j) in the result that has a corresponding
970 * component (column i, row j) in the argument will be initialized
971 * from there. All other components will be initialized to the
972 * identity matrix. If a matrix argument is given to a matrix
973 * constructor, it is an error to have any other arguments."
975 assert(first_param
->next
->is_tail_sentinel());
976 ir_rvalue
*const src_matrix
= first_param
;
978 /* If the source matrix is smaller, pre-initialize the relavent parts of
979 * the destination matrix to the identity matrix.
981 if ((src_matrix
->type
->matrix_columns
< var
->type
->matrix_columns
)
982 || (src_matrix
->type
->vector_elements
< var
->type
->vector_elements
)) {
984 /* If the source matrix has fewer rows, every column of the destination
985 * must be initialized. Otherwise only the columns in the destination
986 * that do not exist in the source must be initialized.
989 (src_matrix
->type
->vector_elements
< var
->type
->vector_elements
)
990 ? 0 : src_matrix
->type
->matrix_columns
;
992 const glsl_type
*const col_type
= var
->type
->column_type();
993 for (/* empty */; col
< var
->type
->matrix_columns
; col
++) {
994 ir_constant_data ident
;
1003 ir_rvalue
*const rhs
= new(ctx
) ir_constant(col_type
, &ident
);
1005 ir_rvalue
*const lhs
=
1006 new(ctx
) ir_dereference_array(var
, new(ctx
) ir_constant(col
));
1008 ir_instruction
*inst
= new(ctx
) ir_assignment(lhs
, rhs
, NULL
);
1009 instructions
->push_tail(inst
);
1013 /* Assign columns from the source matrix to the destination matrix.
1015 * Since the parameter will be used in the RHS of multiple assignments,
1016 * generate a temporary and copy the paramter there.
1018 ir_variable
*const rhs_var
=
1019 new(ctx
) ir_variable(first_param
->type
, "mat_ctor_mat",
1021 instructions
->push_tail(rhs_var
);
1023 ir_dereference
*const rhs_var_ref
=
1024 new(ctx
) ir_dereference_variable(rhs_var
);
1025 ir_instruction
*const inst
=
1026 new(ctx
) ir_assignment(rhs_var_ref
, first_param
, NULL
);
1027 instructions
->push_tail(inst
);
1029 const unsigned last_row
= MIN2(src_matrix
->type
->vector_elements
,
1030 var
->type
->vector_elements
);
1031 const unsigned last_col
= MIN2(src_matrix
->type
->matrix_columns
,
1032 var
->type
->matrix_columns
);
1034 unsigned swiz
[4] = { 0, 0, 0, 0 };
1035 for (unsigned i
= 1; i
< last_row
; i
++)
1038 const unsigned write_mask
= (1U << last_row
) - 1;
1040 for (unsigned i
= 0; i
< last_col
; i
++) {
1041 ir_dereference
*const lhs
=
1042 new(ctx
) ir_dereference_array(var
, new(ctx
) ir_constant(i
));
1043 ir_rvalue
*const rhs_col
=
1044 new(ctx
) ir_dereference_array(rhs_var
, new(ctx
) ir_constant(i
));
1046 /* If one matrix has columns that are smaller than the columns of the
1047 * other matrix, wrap the column access of the larger with a swizzle
1048 * so that the LHS and RHS of the assignment have the same size (and
1049 * therefore have the same type).
1051 * It would be perfectly valid to unconditionally generate the
1052 * swizzles, this this will typically result in a more compact IR tree.
1055 if (lhs
->type
->vector_elements
!= rhs_col
->type
->vector_elements
) {
1056 rhs
= new(ctx
) ir_swizzle(rhs_col
, swiz
, last_row
);
1061 ir_instruction
*inst
=
1062 new(ctx
) ir_assignment(lhs
, rhs
, NULL
, write_mask
);
1063 instructions
->push_tail(inst
);
1066 const unsigned cols
= type
->matrix_columns
;
1067 const unsigned rows
= type
->vector_elements
;
1068 unsigned col_idx
= 0;
1069 unsigned row_idx
= 0;
1071 foreach_list (node
, parameters
) {
1072 ir_rvalue
*const rhs
= (ir_rvalue
*) node
;
1073 const unsigned components_remaining_this_column
= rows
- row_idx
;
1074 unsigned rhs_components
= rhs
->type
->components();
1075 unsigned rhs_base
= 0;
1077 /* Since the parameter might be used in the RHS of two assignments,
1078 * generate a temporary and copy the paramter there.
1080 ir_variable
*rhs_var
=
1081 new(ctx
) ir_variable(rhs
->type
, "mat_ctor_vec", ir_var_temporary
);
1082 instructions
->push_tail(rhs_var
);
1084 ir_dereference
*rhs_var_ref
=
1085 new(ctx
) ir_dereference_variable(rhs_var
);
1086 ir_instruction
*inst
= new(ctx
) ir_assignment(rhs_var_ref
, rhs
, NULL
);
1087 instructions
->push_tail(inst
);
1089 /* Assign the current parameter to as many components of the matrix
1092 * NOTE: A single vector parameter can span two matrix columns. A
1093 * single vec4, for example, can completely fill a mat2.
1095 if (rhs_components
>= components_remaining_this_column
) {
1096 const unsigned count
= MIN2(rhs_components
,
1097 components_remaining_this_column
);
1099 rhs_var_ref
= new(ctx
) ir_dereference_variable(rhs_var
);
1101 ir_instruction
*inst
= assign_to_matrix_column(var
, col_idx
,
1105 instructions
->push_tail(inst
);
1113 /* If there is data left in the parameter and components left to be
1114 * set in the destination, emit another assignment. It is possible
1115 * that the assignment could be of a vec4 to the last element of the
1116 * matrix. In this case col_idx==cols, but there is still data
1117 * left in the source parameter. Obviously, don't emit an assignment
1118 * to data outside the destination matrix.
1120 if ((col_idx
< cols
) && (rhs_base
< rhs_components
)) {
1121 const unsigned count
= rhs_components
- rhs_base
;
1123 rhs_var_ref
= new(ctx
) ir_dereference_variable(rhs_var
);
1125 ir_instruction
*inst
= assign_to_matrix_column(var
, col_idx
,
1130 instructions
->push_tail(inst
);
1137 return new(ctx
) ir_dereference_variable(var
);
1142 emit_inline_record_constructor(const glsl_type
*type
,
1143 exec_list
*instructions
,
1144 exec_list
*parameters
,
1147 ir_variable
*const var
=
1148 new(mem_ctx
) ir_variable(type
, "record_ctor", ir_var_temporary
);
1149 ir_dereference_variable
*const d
= new(mem_ctx
) ir_dereference_variable(var
);
1151 instructions
->push_tail(var
);
1153 exec_node
*node
= parameters
->head
;
1154 for (unsigned i
= 0; i
< type
->length
; i
++) {
1155 assert(!node
->is_tail_sentinel());
1157 ir_dereference
*const lhs
=
1158 new(mem_ctx
) ir_dereference_record(d
->clone(mem_ctx
, NULL
),
1159 type
->fields
.structure
[i
].name
);
1161 ir_rvalue
*const rhs
= ((ir_instruction
*) node
)->as_rvalue();
1162 assert(rhs
!= NULL
);
1164 ir_instruction
*const assign
= new(mem_ctx
) ir_assignment(lhs
, rhs
, NULL
);
1166 instructions
->push_tail(assign
);
1175 ast_function_expression::hir(exec_list
*instructions
,
1176 struct _mesa_glsl_parse_state
*state
)
1179 /* There are three sorts of function calls.
1181 * 1. constructors - The first subexpression is an ast_type_specifier.
1182 * 2. methods - Only the .length() method of array types.
1183 * 3. functions - Calls to regular old functions.
1185 * Method calls are actually detected when the ast_field_selection
1186 * expression is handled.
1188 if (is_constructor()) {
1189 const ast_type_specifier
*type
= (ast_type_specifier
*) subexpressions
[0];
1190 YYLTYPE loc
= type
->get_location();
1193 const glsl_type
*const constructor_type
= type
->glsl_type(& name
, state
);
1195 /* constructor_type can be NULL if a variable with the same name as the
1196 * structure has come into scope.
1198 if (constructor_type
== NULL
) {
1199 _mesa_glsl_error(& loc
, state
, "unknown type `%s' (structure name "
1200 "may be shadowed by a variable with the same name)",
1202 return ir_call::get_error_instruction(ctx
);
1206 /* Constructors for samplers are illegal.
1208 if (constructor_type
->is_sampler()) {
1209 _mesa_glsl_error(& loc
, state
, "cannot construct sampler type `%s'",
1210 constructor_type
->name
);
1211 return ir_call::get_error_instruction(ctx
);
1214 if (constructor_type
->is_array()) {
1215 if (state
->language_version
<= 110) {
1216 _mesa_glsl_error(& loc
, state
,
1217 "array constructors forbidden in GLSL 1.10");
1218 return ir_call::get_error_instruction(ctx
);
1221 return process_array_constructor(instructions
, constructor_type
,
1222 & loc
, &this->expressions
, state
);
1226 /* There are two kinds of constructor call. Constructors for built-in
1227 * language types, such as mat4 and vec2, are free form. The only
1228 * requirement is that the parameters must provide enough values of the
1229 * correct scalar type. Constructors for arrays and structures must
1230 * have the exact number of parameters with matching types in the
1231 * correct order. These constructors follow essentially the same type
1232 * matching rules as functions.
1234 if (constructor_type
->is_record()) {
1235 exec_list actual_parameters
;
1237 process_parameters(instructions
, &actual_parameters
,
1238 &this->expressions
, state
);
1240 exec_node
*node
= actual_parameters
.head
;
1241 for (unsigned i
= 0; i
< constructor_type
->length
; i
++) {
1242 ir_rvalue
*ir
= (ir_rvalue
*) node
;
1244 if (node
->is_tail_sentinel()) {
1245 _mesa_glsl_error(&loc
, state
,
1246 "insufficient parameters to constructor "
1248 constructor_type
->name
);
1249 return ir_call::get_error_instruction(ctx
);
1252 if (apply_implicit_conversion(constructor_type
->fields
.structure
[i
].type
,
1254 node
->replace_with(ir
);
1256 _mesa_glsl_error(&loc
, state
,
1257 "parameter type mismatch in constructor "
1258 "for `%s.%s' (%s vs %s)",
1259 constructor_type
->name
,
1260 constructor_type
->fields
.structure
[i
].name
,
1262 constructor_type
->fields
.structure
[i
].type
->name
);
1263 return ir_call::get_error_instruction(ctx
);;
1269 if (!node
->is_tail_sentinel()) {
1270 _mesa_glsl_error(&loc
, state
, "too many parameters in constructor "
1271 "for `%s'", constructor_type
->name
);
1272 return ir_call::get_error_instruction(ctx
);
1275 ir_rvalue
*const constant
=
1276 constant_record_constructor(constructor_type
, &actual_parameters
,
1279 return (constant
!= NULL
)
1281 : emit_inline_record_constructor(constructor_type
, instructions
,
1282 &actual_parameters
, state
);
1285 if (!constructor_type
->is_numeric() && !constructor_type
->is_boolean())
1286 return ir_call::get_error_instruction(ctx
);
1288 /* Total number of components of the type being constructed. */
1289 const unsigned type_components
= constructor_type
->components();
1291 /* Number of components from parameters that have actually been
1292 * consumed. This is used to perform several kinds of error checking.
1294 unsigned components_used
= 0;
1296 unsigned matrix_parameters
= 0;
1297 unsigned nonmatrix_parameters
= 0;
1298 exec_list actual_parameters
;
1300 foreach_list (n
, &this->expressions
) {
1301 ast_node
*ast
= exec_node_data(ast_node
, n
, link
);
1302 ir_rvalue
*result
= ast
->hir(instructions
, state
)->as_rvalue();
1304 /* From page 50 (page 56 of the PDF) of the GLSL 1.50 spec:
1306 * "It is an error to provide extra arguments beyond this
1307 * last used argument."
1309 if (components_used
>= type_components
) {
1310 _mesa_glsl_error(& loc
, state
, "too many parameters to `%s' "
1312 constructor_type
->name
);
1313 return ir_call::get_error_instruction(ctx
);
1316 if (!result
->type
->is_numeric() && !result
->type
->is_boolean()) {
1317 _mesa_glsl_error(& loc
, state
, "cannot construct `%s' from a "
1318 "non-numeric data type",
1319 constructor_type
->name
);
1320 return ir_call::get_error_instruction(ctx
);
1323 /* Count the number of matrix and nonmatrix parameters. This
1324 * is used below to enforce some of the constructor rules.
1326 if (result
->type
->is_matrix())
1327 matrix_parameters
++;
1329 nonmatrix_parameters
++;
1331 actual_parameters
.push_tail(result
);
1332 components_used
+= result
->type
->components();
1335 /* From page 28 (page 34 of the PDF) of the GLSL 1.10 spec:
1337 * "It is an error to construct matrices from other matrices. This
1338 * is reserved for future use."
1340 if (state
->language_version
== 110 && matrix_parameters
> 0
1341 && constructor_type
->is_matrix()) {
1342 _mesa_glsl_error(& loc
, state
, "cannot construct `%s' from a "
1343 "matrix in GLSL 1.10",
1344 constructor_type
->name
);
1345 return ir_call::get_error_instruction(ctx
);
1348 /* From page 50 (page 56 of the PDF) of the GLSL 1.50 spec:
1350 * "If a matrix argument is given to a matrix constructor, it is
1351 * an error to have any other arguments."
1353 if ((matrix_parameters
> 0)
1354 && ((matrix_parameters
+ nonmatrix_parameters
) > 1)
1355 && constructor_type
->is_matrix()) {
1356 _mesa_glsl_error(& loc
, state
, "for matrix `%s' constructor, "
1357 "matrix must be only parameter",
1358 constructor_type
->name
);
1359 return ir_call::get_error_instruction(ctx
);
1362 /* From page 28 (page 34 of the PDF) of the GLSL 1.10 spec:
1364 * "In these cases, there must be enough components provided in the
1365 * arguments to provide an initializer for every component in the
1366 * constructed value."
1368 if (components_used
< type_components
&& components_used
!= 1
1369 && matrix_parameters
== 0) {
1370 _mesa_glsl_error(& loc
, state
, "too few components to construct "
1372 constructor_type
->name
);
1373 return ir_call::get_error_instruction(ctx
);
1376 /* Later, we cast each parameter to the same base type as the
1377 * constructor. Since there are no non-floating point matrices, we
1378 * need to break them up into a series of column vectors.
1380 if (constructor_type
->base_type
!= GLSL_TYPE_FLOAT
) {
1381 foreach_list_safe(n
, &actual_parameters
) {
1382 ir_rvalue
*matrix
= (ir_rvalue
*) n
;
1384 if (!matrix
->type
->is_matrix())
1387 /* Create a temporary containing the matrix. */
1388 ir_variable
*var
= new(ctx
) ir_variable(matrix
->type
, "matrix_tmp",
1390 instructions
->push_tail(var
);
1391 instructions
->push_tail(new(ctx
) ir_assignment(new(ctx
)
1392 ir_dereference_variable(var
), matrix
, NULL
));
1393 var
->constant_value
= matrix
->constant_expression_value();
1395 /* Replace the matrix with dereferences of its columns. */
1396 for (int i
= 0; i
< matrix
->type
->matrix_columns
; i
++) {
1397 matrix
->insert_before(new (ctx
) ir_dereference_array(var
,
1398 new(ctx
) ir_constant(i
)));
1404 bool all_parameters_are_constant
= true;
1406 /* Type cast each parameter and, if possible, fold constants.*/
1407 foreach_list_safe(n
, &actual_parameters
) {
1408 ir_rvalue
*ir
= (ir_rvalue
*) n
;
1410 const glsl_type
*desired_type
=
1411 glsl_type::get_instance(constructor_type
->base_type
,
1412 ir
->type
->vector_elements
,
1413 ir
->type
->matrix_columns
);
1414 ir_rvalue
*result
= convert_component(ir
, desired_type
);
1416 /* Attempt to convert the parameter to a constant valued expression.
1417 * After doing so, track whether or not all the parameters to the
1418 * constructor are trivially constant valued expressions.
1420 ir_rvalue
*const constant
= result
->constant_expression_value();
1422 if (constant
!= NULL
)
1425 all_parameters_are_constant
= false;
1428 ir
->replace_with(result
);
1432 /* If all of the parameters are trivially constant, create a
1433 * constant representing the complete collection of parameters.
1435 if (all_parameters_are_constant
) {
1436 return new(ctx
) ir_constant(constructor_type
, &actual_parameters
);
1437 } else if (constructor_type
->is_scalar()) {
1438 return dereference_component((ir_rvalue
*) actual_parameters
.head
,
1440 } else if (constructor_type
->is_vector()) {
1441 return emit_inline_vector_constructor(constructor_type
,
1446 assert(constructor_type
->is_matrix());
1447 return emit_inline_matrix_constructor(constructor_type
,
1453 const ast_expression
*id
= subexpressions
[0];
1454 const char *func_name
= id
->primary_expression
.identifier
;
1455 YYLTYPE loc
= id
->get_location();
1456 exec_list actual_parameters
;
1458 process_parameters(instructions
, &actual_parameters
, &this->expressions
,
1461 ir_function_signature
*sig
=
1462 match_function_by_name(func_name
, &actual_parameters
, state
);
1464 ir_call
*call
= NULL
;
1465 ir_rvalue
*value
= NULL
;
1467 no_matching_function_error(func_name
, &loc
, &actual_parameters
, state
);
1468 value
= ir_call::get_error_instruction(ctx
);
1470 value
= generate_call(instructions
, sig
, &loc
, &actual_parameters
,
1475 /* If a function was found, make sure that none of the 'out' or 'inout'
1476 * parameters violate the extra l-value rules.
1478 ir_function_signature
*f
= call
->get_callee();
1481 exec_node
*formal_node
= f
->parameters
.head
;
1483 foreach_list (actual_node
, &this->expressions
) {
1484 /* Both parameter lists had better be the same length!
1486 assert(!actual_node
->is_tail_sentinel());
1488 const ir_variable
*const formal_parameter
=
1489 (ir_variable
*) formal_node
;
1490 const ast_expression
*const actual_parameter
=
1491 exec_node_data(ast_expression
, actual_node
, link
);
1493 if ((formal_parameter
->mode
== ir_var_out
1494 || formal_parameter
->mode
== ir_var_inout
)
1495 && actual_parameter
->non_lvalue_description
!= NULL
) {
1496 YYLTYPE loc
= actual_parameter
->get_location();
1498 _mesa_glsl_error(&loc
, state
,
1499 "function parameter '%s %s' references a %s",
1500 (formal_parameter
->mode
== ir_var_out
)
1502 formal_parameter
->name
,
1503 actual_parameter
->non_lvalue_description
);
1504 return ir_call::get_error_instruction(ctx
);
1507 /* Only advance the formal_node pointer here because the
1508 * foreach_list business already advances actual_node.
1510 formal_node
= formal_node
->next
;
1517 return ir_call::get_error_instruction(ctx
);