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 generate_call(exec_list
*instructions
, ir_function_signature
*sig
,
98 YYLTYPE
*loc
, exec_list
*actual_parameters
,
99 struct _mesa_glsl_parse_state
*state
)
102 exec_list post_call_conversions
;
104 /* Verify that 'out' and 'inout' actual parameters are lvalues. This
105 * isn't done in ir_function::matching_signature because that function
106 * cannot generate the necessary diagnostics.
108 * Also, validate that 'const_in' formal parameters (an extension of our
109 * IR) correspond to ir_constant actual parameters.
111 * Also, perform implicit conversion of arguments. Note: to implicitly
112 * convert out parameters, we need to place them in a temporary
113 * variable, and do the conversion after the call takes place. Since we
114 * haven't emitted the call yet, we'll place the post-call conversions
115 * in a temporary exec_list, and emit them later.
117 exec_list_iterator actual_iter
= actual_parameters
->iterator();
118 exec_list_iterator formal_iter
= sig
->parameters
.iterator();
120 while (actual_iter
.has_next()) {
121 ir_rvalue
*actual
= (ir_rvalue
*) actual_iter
.get();
122 ir_variable
*formal
= (ir_variable
*) formal_iter
.get();
124 assert(actual
!= NULL
);
125 assert(formal
!= NULL
);
127 if (formal
->mode
== ir_var_const_in
&& !actual
->as_constant()) {
128 _mesa_glsl_error(loc
, state
,
129 "parameter `%s' must be a constant expression",
131 return ir_call::get_error_instruction(ctx
);
134 if ((formal
->mode
== ir_var_out
)
135 || (formal
->mode
== ir_var_inout
)) {
136 const char *mode
= NULL
;
137 switch (formal
->mode
) {
138 case ir_var_out
: mode
= "out"; break;
139 case ir_var_inout
: mode
= "inout"; break;
140 default: assert(false); break;
142 /* FIXME: 'loc' is incorrect (as of 2011-01-21). It is always
145 if (actual
->variable_referenced()
146 && actual
->variable_referenced()->read_only
) {
147 _mesa_glsl_error(loc
, state
,
148 "function parameter '%s %s' references the "
149 "read-only variable '%s'",
151 actual
->variable_referenced()->name
);
153 } else if (!actual
->is_lvalue()) {
154 _mesa_glsl_error(loc
, state
,
155 "function parameter '%s %s' is not an lvalue",
160 if (formal
->type
->is_numeric() || formal
->type
->is_boolean()) {
161 switch (formal
->mode
) {
162 case ir_var_const_in
:
165 = convert_component(actual
, formal
->type
);
166 actual
->replace_with(converted
);
170 if (actual
->type
!= formal
->type
) {
171 /* To convert an out parameter, we need to create a
172 * temporary variable to hold the value before conversion,
173 * and then perform the conversion after the function call
176 * This has the effect of transforming code like this:
182 * Into IR that's equivalent to this:
186 * int out_parameter_conversion;
187 * f(out_parameter_conversion);
188 * value = float(out_parameter_conversion);
191 new(ctx
) ir_variable(formal
->type
,
192 "out_parameter_conversion",
194 instructions
->push_tail(tmp
);
195 ir_dereference_variable
*deref_tmp_1
196 = new(ctx
) ir_dereference_variable(tmp
);
197 ir_dereference_variable
*deref_tmp_2
198 = new(ctx
) ir_dereference_variable(tmp
);
199 ir_rvalue
*converted_tmp
200 = convert_component(deref_tmp_1
, actual
->type
);
201 ir_assignment
*assignment
202 = new(ctx
) ir_assignment(actual
, converted_tmp
);
203 post_call_conversions
.push_tail(assignment
);
204 actual
->replace_with(deref_tmp_2
);
208 /* Inout parameters should never require conversion, since that
209 * would require an implicit conversion to exist both to and
210 * from the formal parameter type, and there are no
211 * bidirectional implicit conversions.
213 assert (actual
->type
== formal
->type
);
216 assert (!"Illegal formal parameter mode");
225 /* Always insert the call in the instruction stream, and return a deref
226 * of its return val if it returns a value, since we don't know if
227 * the rvalue is going to be assigned to anything or not.
229 * Also insert any out parameter conversions after the call.
231 ir_call
*call
= new(ctx
) ir_call(sig
, actual_parameters
);
232 ir_dereference_variable
*deref
;
233 if (!sig
->return_type
->is_void()) {
234 /* If the function call is a constant expression, don't
235 * generate the instructions to call it; just generate an
236 * ir_constant representing the constant value.
238 * Function calls can only be constant expressions starting
241 if (state
->language_version
>= 120) {
242 ir_constant
*const_val
= call
->constant_expression_value();
250 var
= new(ctx
) ir_variable(sig
->return_type
,
251 ralloc_asprintf(ctx
, "%s_retval",
252 sig
->function_name()),
254 instructions
->push_tail(var
);
256 deref
= new(ctx
) ir_dereference_variable(var
);
257 ir_assignment
*assign
= new(ctx
) ir_assignment(deref
, call
, NULL
);
258 instructions
->push_tail(assign
);
260 deref
= new(ctx
) ir_dereference_variable(var
);
262 instructions
->push_tail(call
);
265 instructions
->append_list(&post_call_conversions
);
270 match_function_by_name(exec_list
*instructions
, const char *name
,
271 YYLTYPE
*loc
, exec_list
*actual_parameters
,
272 struct _mesa_glsl_parse_state
*state
)
275 ir_function
*f
= state
->symbols
->get_function(name
);
276 ir_function_signature
*sig
;
278 sig
= f
? f
->matching_signature(actual_parameters
) : NULL
;
280 /* FINISHME: This doesn't handle the case where shader X contains a
281 * FINISHME: matching signature but shader X + N contains an _exact_
282 * FINISHME: matching signature.
285 && (f
== NULL
|| state
->es_shader
|| !f
->has_user_signature())
286 && state
->symbols
->get_type(name
) == NULL
287 && (state
->language_version
== 110
288 || state
->symbols
->get_variable(name
) == NULL
)) {
289 /* The current shader doesn't contain a matching function or signature.
290 * Before giving up, look for the prototype in the built-in functions.
292 _mesa_glsl_initialize_functions(state
);
293 for (unsigned i
= 0; i
< state
->num_builtins_to_link
; i
++) {
294 ir_function
*builtin
;
295 builtin
= state
->builtins_to_link
[i
]->symbols
->get_function(name
);
296 sig
= builtin
? builtin
->matching_signature(actual_parameters
) : NULL
;
299 f
= new(ctx
) ir_function(name
);
300 state
->symbols
->add_global_function(f
);
301 emit_function(state
, f
);
304 f
->add_signature(sig
->clone_prototype(f
, NULL
));
311 return generate_call(instructions
, sig
, loc
, actual_parameters
, state
);
313 char *str
= prototype_string(NULL
, name
, actual_parameters
);
315 _mesa_glsl_error(loc
, state
, "no matching function for call to `%s'",
319 const char *prefix
= "candidates are: ";
321 for (int i
= -1; i
< (int) state
->num_builtins_to_link
; i
++) {
322 glsl_symbol_table
*syms
= i
>= 0 ? state
->builtins_to_link
[i
]->symbols
324 f
= syms
->get_function(name
);
328 foreach_list (node
, &f
->signatures
) {
329 ir_function_signature
*sig
= (ir_function_signature
*) node
;
331 str
= prototype_string(sig
->return_type
, f
->name
, &sig
->parameters
);
332 _mesa_glsl_error(loc
, state
, "%s%s", prefix
, str
);
340 return ir_call::get_error_instruction(ctx
);
346 * Perform automatic type conversion of constructor parameters
348 * This implements the rules in the "Conversion and Scalar Constructors"
349 * section (GLSL 1.10 section 5.4.1), not the "Implicit Conversions" rules.
352 convert_component(ir_rvalue
*src
, const glsl_type
*desired_type
)
354 void *ctx
= ralloc_parent(src
);
355 const unsigned a
= desired_type
->base_type
;
356 const unsigned b
= src
->type
->base_type
;
357 ir_expression
*result
= NULL
;
359 if (src
->type
->is_error())
362 assert(a
<= GLSL_TYPE_BOOL
);
363 assert(b
<= GLSL_TYPE_BOOL
);
372 result
= new(ctx
) ir_expression(ir_unop_i2u
, src
);
374 case GLSL_TYPE_FLOAT
:
375 result
= new(ctx
) ir_expression(ir_unop_i2u
,
376 new(ctx
) ir_expression(ir_unop_f2i
, src
));
379 result
= new(ctx
) ir_expression(ir_unop_i2u
,
380 new(ctx
) ir_expression(ir_unop_b2i
, src
));
387 result
= new(ctx
) ir_expression(ir_unop_u2i
, src
);
389 case GLSL_TYPE_FLOAT
:
390 result
= new(ctx
) ir_expression(ir_unop_f2i
, src
);
393 result
= new(ctx
) ir_expression(ir_unop_b2i
, src
);
397 case GLSL_TYPE_FLOAT
:
400 result
= new(ctx
) ir_expression(ir_unop_u2f
, desired_type
, src
, NULL
);
403 result
= new(ctx
) ir_expression(ir_unop_i2f
, desired_type
, src
, NULL
);
406 result
= new(ctx
) ir_expression(ir_unop_b2f
, desired_type
, src
, NULL
);
413 result
= new(ctx
) ir_expression(ir_unop_i2b
,
414 new(ctx
) ir_expression(ir_unop_u2i
, src
));
417 result
= new(ctx
) ir_expression(ir_unop_i2b
, desired_type
, src
, NULL
);
419 case GLSL_TYPE_FLOAT
:
420 result
= new(ctx
) ir_expression(ir_unop_f2b
, desired_type
, src
, NULL
);
426 assert(result
!= NULL
);
427 assert(result
->type
== desired_type
);
429 /* Try constant folding; it may fold in the conversion we just added. */
430 ir_constant
*const constant
= result
->constant_expression_value();
431 return (constant
!= NULL
) ? (ir_rvalue
*) constant
: (ir_rvalue
*) result
;
435 * Dereference a specific component from a scalar, vector, or matrix
438 dereference_component(ir_rvalue
*src
, unsigned component
)
440 void *ctx
= ralloc_parent(src
);
441 assert(component
< src
->type
->components());
443 /* If the source is a constant, just create a new constant instead of a
444 * dereference of the existing constant.
446 ir_constant
*constant
= src
->as_constant();
448 return new(ctx
) ir_constant(constant
, component
);
450 if (src
->type
->is_scalar()) {
452 } else if (src
->type
->is_vector()) {
453 return new(ctx
) ir_swizzle(src
, component
, 0, 0, 0, 1);
455 assert(src
->type
->is_matrix());
457 /* Dereference a row of the matrix, then call this function again to get
458 * a specific element from that row.
460 const int c
= component
/ src
->type
->column_type()->vector_elements
;
461 const int r
= component
% src
->type
->column_type()->vector_elements
;
462 ir_constant
*const col_index
= new(ctx
) ir_constant(c
);
463 ir_dereference
*const col
= new(ctx
) ir_dereference_array(src
, col_index
);
465 col
->type
= src
->type
->column_type();
467 return dereference_component(col
, r
);
470 assert(!"Should not get here.");
476 process_array_constructor(exec_list
*instructions
,
477 const glsl_type
*constructor_type
,
478 YYLTYPE
*loc
, exec_list
*parameters
,
479 struct _mesa_glsl_parse_state
*state
)
482 /* Array constructors come in two forms: sized and unsized. Sized array
483 * constructors look like 'vec4[2](a, b)', where 'a' and 'b' are vec4
484 * variables. In this case the number of parameters must exactly match the
485 * specified size of the array.
487 * Unsized array constructors look like 'vec4[](a, b)', where 'a' and 'b'
488 * are vec4 variables. In this case the size of the array being constructed
489 * is determined by the number of parameters.
491 * From page 52 (page 58 of the PDF) of the GLSL 1.50 spec:
493 * "There must be exactly the same number of arguments as the size of
494 * the array being constructed. If no size is present in the
495 * constructor, then the array is explicitly sized to the number of
496 * arguments provided. The arguments are assigned in order, starting at
497 * element 0, to the elements of the constructed array. Each argument
498 * must be the same type as the element type of the array, or be a type
499 * that can be converted to the element type of the array according to
500 * Section 4.1.10 "Implicit Conversions.""
502 exec_list actual_parameters
;
503 const unsigned parameter_count
=
504 process_parameters(instructions
, &actual_parameters
, parameters
, state
);
506 if ((parameter_count
== 0)
507 || ((constructor_type
->length
!= 0)
508 && (constructor_type
->length
!= parameter_count
))) {
509 const unsigned min_param
= (constructor_type
->length
== 0)
510 ? 1 : constructor_type
->length
;
512 _mesa_glsl_error(loc
, state
, "array constructor must have %s %u "
514 (constructor_type
->length
!= 0) ? "at least" : "exactly",
515 min_param
, (min_param
<= 1) ? "" : "s");
516 return ir_call::get_error_instruction(ctx
);
519 if (constructor_type
->length
== 0) {
521 glsl_type::get_array_instance(constructor_type
->element_type(),
523 assert(constructor_type
!= NULL
);
524 assert(constructor_type
->length
== parameter_count
);
527 bool all_parameters_are_constant
= true;
529 /* Type cast each parameter and, if possible, fold constants. */
530 foreach_list_safe(n
, &actual_parameters
) {
531 ir_rvalue
*ir
= (ir_rvalue
*) n
;
532 ir_rvalue
*result
= ir
;
534 /* Apply implicit conversions (not the scalar constructor rules!). See
535 * the spec quote above. */
536 if (constructor_type
->element_type()->is_float()) {
537 const glsl_type
*desired_type
=
538 glsl_type::get_instance(GLSL_TYPE_FLOAT
,
539 ir
->type
->vector_elements
,
540 ir
->type
->matrix_columns
);
541 if (result
->type
->can_implicitly_convert_to(desired_type
)) {
542 /* Even though convert_component() implements the constructor
543 * conversion rules (not the implicit conversion rules), its safe
544 * to use it here because we already checked that the implicit
545 * conversion is legal.
547 result
= convert_component(ir
, desired_type
);
551 if (result
->type
!= constructor_type
->element_type()) {
552 _mesa_glsl_error(loc
, state
, "type error in array constructor: "
553 "expected: %s, found %s",
554 constructor_type
->element_type()->name
,
558 /* Attempt to convert the parameter to a constant valued expression.
559 * After doing so, track whether or not all the parameters to the
560 * constructor are trivially constant valued expressions.
562 ir_rvalue
*const constant
= result
->constant_expression_value();
564 if (constant
!= NULL
)
567 all_parameters_are_constant
= false;
569 ir
->replace_with(result
);
572 if (all_parameters_are_constant
)
573 return new(ctx
) ir_constant(constructor_type
, &actual_parameters
);
575 ir_variable
*var
= new(ctx
) ir_variable(constructor_type
, "array_ctor",
577 instructions
->push_tail(var
);
580 foreach_list(node
, &actual_parameters
) {
581 ir_rvalue
*rhs
= (ir_rvalue
*) node
;
582 ir_rvalue
*lhs
= new(ctx
) ir_dereference_array(var
,
583 new(ctx
) ir_constant(i
));
585 ir_instruction
*assignment
= new(ctx
) ir_assignment(lhs
, rhs
, NULL
);
586 instructions
->push_tail(assignment
);
591 return new(ctx
) ir_dereference_variable(var
);
596 * Try to convert a record constructor to a constant expression
599 constant_record_constructor(const glsl_type
*constructor_type
,
600 exec_list
*parameters
, void *mem_ctx
)
602 foreach_list(node
, parameters
) {
603 ir_constant
*constant
= ((ir_instruction
*) node
)->as_constant();
604 if (constant
== NULL
)
606 node
->replace_with(constant
);
609 return new(mem_ctx
) ir_constant(constructor_type
, parameters
);
614 * Determine if a list consists of a single scalar r-value
617 single_scalar_parameter(exec_list
*parameters
)
619 const ir_rvalue
*const p
= (ir_rvalue
*) parameters
->head
;
620 assert(((ir_rvalue
*)p
)->as_rvalue() != NULL
);
622 return (p
->type
->is_scalar() && p
->next
->is_tail_sentinel());
627 * Generate inline code for a vector constructor
629 * The generated constructor code will consist of a temporary variable
630 * declaration of the same type as the constructor. A sequence of assignments
631 * from constructor parameters to the temporary will follow.
634 * An \c ir_dereference_variable of the temprorary generated in the constructor
638 emit_inline_vector_constructor(const glsl_type
*type
,
639 exec_list
*instructions
,
640 exec_list
*parameters
,
643 assert(!parameters
->is_empty());
645 ir_variable
*var
= new(ctx
) ir_variable(type
, "vec_ctor", ir_var_temporary
);
646 instructions
->push_tail(var
);
648 /* There are two kinds of vector constructors.
650 * - Construct a vector from a single scalar by replicating that scalar to
651 * all components of the vector.
653 * - Construct a vector from an arbirary combination of vectors and
654 * scalars. The components of the constructor parameters are assigned
655 * to the vector in order until the vector is full.
657 const unsigned lhs_components
= type
->components();
658 if (single_scalar_parameter(parameters
)) {
659 ir_rvalue
*first_param
= (ir_rvalue
*)parameters
->head
;
660 ir_rvalue
*rhs
= new(ctx
) ir_swizzle(first_param
, 0, 0, 0, 0,
662 ir_dereference_variable
*lhs
= new(ctx
) ir_dereference_variable(var
);
663 const unsigned mask
= (1U << lhs_components
) - 1;
665 assert(rhs
->type
== lhs
->type
);
667 ir_instruction
*inst
= new(ctx
) ir_assignment(lhs
, rhs
, NULL
, mask
);
668 instructions
->push_tail(inst
);
670 unsigned base_component
= 0;
671 unsigned base_lhs_component
= 0;
672 ir_constant_data data
;
673 unsigned constant_mask
= 0, constant_components
= 0;
675 memset(&data
, 0, sizeof(data
));
677 foreach_list(node
, parameters
) {
678 ir_rvalue
*param
= (ir_rvalue
*) node
;
679 unsigned rhs_components
= param
->type
->components();
681 /* Do not try to assign more components to the vector than it has!
683 if ((rhs_components
+ base_lhs_component
) > lhs_components
) {
684 rhs_components
= lhs_components
- base_lhs_component
;
687 const ir_constant
*const c
= param
->as_constant();
689 for (unsigned i
= 0; i
< rhs_components
; i
++) {
690 switch (c
->type
->base_type
) {
692 data
.u
[i
+ base_component
] = c
->get_uint_component(i
);
695 data
.i
[i
+ base_component
] = c
->get_int_component(i
);
697 case GLSL_TYPE_FLOAT
:
698 data
.f
[i
+ base_component
] = c
->get_float_component(i
);
701 data
.b
[i
+ base_component
] = c
->get_bool_component(i
);
704 assert(!"Should not get here.");
709 /* Mask of fields to be written in the assignment.
711 constant_mask
|= ((1U << rhs_components
) - 1) << base_lhs_component
;
712 constant_components
+= rhs_components
;
714 base_component
+= rhs_components
;
716 /* Advance the component index by the number of components
717 * that were just assigned.
719 base_lhs_component
+= rhs_components
;
722 if (constant_mask
!= 0) {
723 ir_dereference
*lhs
= new(ctx
) ir_dereference_variable(var
);
724 const glsl_type
*rhs_type
= glsl_type::get_instance(var
->type
->base_type
,
727 ir_rvalue
*rhs
= new(ctx
) ir_constant(rhs_type
, &data
);
729 ir_instruction
*inst
=
730 new(ctx
) ir_assignment(lhs
, rhs
, NULL
, constant_mask
);
731 instructions
->push_tail(inst
);
735 foreach_list(node
, parameters
) {
736 ir_rvalue
*param
= (ir_rvalue
*) node
;
737 unsigned rhs_components
= param
->type
->components();
739 /* Do not try to assign more components to the vector than it has!
741 if ((rhs_components
+ base_component
) > lhs_components
) {
742 rhs_components
= lhs_components
- base_component
;
745 const ir_constant
*const c
= param
->as_constant();
747 /* Mask of fields to be written in the assignment.
749 const unsigned write_mask
= ((1U << rhs_components
) - 1)
752 ir_dereference
*lhs
= new(ctx
) ir_dereference_variable(var
);
754 /* Generate a swizzle so that LHS and RHS sizes match.
757 new(ctx
) ir_swizzle(param
, 0, 1, 2, 3, rhs_components
);
759 ir_instruction
*inst
=
760 new(ctx
) ir_assignment(lhs
, rhs
, NULL
, write_mask
);
761 instructions
->push_tail(inst
);
764 /* Advance the component index by the number of components that were
767 base_component
+= rhs_components
;
770 return new(ctx
) ir_dereference_variable(var
);
775 * Generate assignment of a portion of a vector to a portion of a matrix column
777 * \param src_base First component of the source to be used in assignment
778 * \param column Column of destination to be assiged
779 * \param row_base First component of the destination column to be assigned
780 * \param count Number of components to be assigned
783 * \c src_base + \c count must be less than or equal to the number of components
784 * in the source vector.
787 assign_to_matrix_column(ir_variable
*var
, unsigned column
, unsigned row_base
,
788 ir_rvalue
*src
, unsigned src_base
, unsigned count
,
791 ir_constant
*col_idx
= new(mem_ctx
) ir_constant(column
);
792 ir_dereference
*column_ref
= new(mem_ctx
) ir_dereference_array(var
, col_idx
);
794 assert(column_ref
->type
->components() >= (row_base
+ count
));
795 assert(src
->type
->components() >= (src_base
+ count
));
797 /* Generate a swizzle that extracts the number of components from the source
798 * that are to be assigned to the column of the matrix.
800 if (count
< src
->type
->vector_elements
) {
801 src
= new(mem_ctx
) ir_swizzle(src
,
802 src_base
+ 0, src_base
+ 1,
803 src_base
+ 2, src_base
+ 3,
807 /* Mask of fields to be written in the assignment.
809 const unsigned write_mask
= ((1U << count
) - 1) << row_base
;
811 return new(mem_ctx
) ir_assignment(column_ref
, src
, NULL
, write_mask
);
816 * Generate inline code for a matrix constructor
818 * The generated constructor code will consist of a temporary variable
819 * declaration of the same type as the constructor. A sequence of assignments
820 * from constructor parameters to the temporary will follow.
823 * An \c ir_dereference_variable of the temprorary generated in the constructor
827 emit_inline_matrix_constructor(const glsl_type
*type
,
828 exec_list
*instructions
,
829 exec_list
*parameters
,
832 assert(!parameters
->is_empty());
834 ir_variable
*var
= new(ctx
) ir_variable(type
, "mat_ctor", ir_var_temporary
);
835 instructions
->push_tail(var
);
837 /* There are three kinds of matrix constructors.
839 * - Construct a matrix from a single scalar by replicating that scalar to
840 * along the diagonal of the matrix and setting all other components to
843 * - Construct a matrix from an arbirary combination of vectors and
844 * scalars. The components of the constructor parameters are assigned
845 * to the matrix in colum-major order until the matrix is full.
847 * - Construct a matrix from a single matrix. The source matrix is copied
848 * to the upper left portion of the constructed matrix, and the remaining
849 * elements take values from the identity matrix.
851 ir_rvalue
*const first_param
= (ir_rvalue
*) parameters
->head
;
852 if (single_scalar_parameter(parameters
)) {
853 /* Assign the scalar to the X component of a vec4, and fill the remaining
854 * components with zero.
856 ir_variable
*rhs_var
=
857 new(ctx
) ir_variable(glsl_type::vec4_type
, "mat_ctor_vec",
859 instructions
->push_tail(rhs_var
);
861 ir_constant_data zero
;
867 ir_instruction
*inst
=
868 new(ctx
) ir_assignment(new(ctx
) ir_dereference_variable(rhs_var
),
869 new(ctx
) ir_constant(rhs_var
->type
, &zero
),
871 instructions
->push_tail(inst
);
873 ir_dereference
*const rhs_ref
= new(ctx
) ir_dereference_variable(rhs_var
);
875 inst
= new(ctx
) ir_assignment(rhs_ref
, first_param
, NULL
, 0x01);
876 instructions
->push_tail(inst
);
878 /* Assign the temporary vector to each column of the destination matrix
879 * with a swizzle that puts the X component on the diagonal of the
880 * matrix. In some cases this may mean that the X component does not
881 * get assigned into the column at all (i.e., when the matrix has more
882 * columns than rows).
884 static const unsigned rhs_swiz
[4][4] = {
891 const unsigned cols_to_init
= MIN2(type
->matrix_columns
,
892 type
->vector_elements
);
893 for (unsigned i
= 0; i
< cols_to_init
; i
++) {
894 ir_constant
*const col_idx
= new(ctx
) ir_constant(i
);
895 ir_rvalue
*const col_ref
= new(ctx
) ir_dereference_array(var
, col_idx
);
897 ir_rvalue
*const rhs_ref
= new(ctx
) ir_dereference_variable(rhs_var
);
898 ir_rvalue
*const rhs
= new(ctx
) ir_swizzle(rhs_ref
, rhs_swiz
[i
],
899 type
->vector_elements
);
901 inst
= new(ctx
) ir_assignment(col_ref
, rhs
, NULL
);
902 instructions
->push_tail(inst
);
905 for (unsigned i
= cols_to_init
; i
< type
->matrix_columns
; i
++) {
906 ir_constant
*const col_idx
= new(ctx
) ir_constant(i
);
907 ir_rvalue
*const col_ref
= new(ctx
) ir_dereference_array(var
, col_idx
);
909 ir_rvalue
*const rhs_ref
= new(ctx
) ir_dereference_variable(rhs_var
);
910 ir_rvalue
*const rhs
= new(ctx
) ir_swizzle(rhs_ref
, 1, 1, 1, 1,
911 type
->vector_elements
);
913 inst
= new(ctx
) ir_assignment(col_ref
, rhs
, NULL
);
914 instructions
->push_tail(inst
);
916 } else if (first_param
->type
->is_matrix()) {
917 /* From page 50 (56 of the PDF) of the GLSL 1.50 spec:
919 * "If a matrix is constructed from a matrix, then each component
920 * (column i, row j) in the result that has a corresponding
921 * component (column i, row j) in the argument will be initialized
922 * from there. All other components will be initialized to the
923 * identity matrix. If a matrix argument is given to a matrix
924 * constructor, it is an error to have any other arguments."
926 assert(first_param
->next
->is_tail_sentinel());
927 ir_rvalue
*const src_matrix
= first_param
;
929 /* If the source matrix is smaller, pre-initialize the relavent parts of
930 * the destination matrix to the identity matrix.
932 if ((src_matrix
->type
->matrix_columns
< var
->type
->matrix_columns
)
933 || (src_matrix
->type
->vector_elements
< var
->type
->vector_elements
)) {
935 /* If the source matrix has fewer rows, every column of the destination
936 * must be initialized. Otherwise only the columns in the destination
937 * that do not exist in the source must be initialized.
940 (src_matrix
->type
->vector_elements
< var
->type
->vector_elements
)
941 ? 0 : src_matrix
->type
->matrix_columns
;
943 const glsl_type
*const col_type
= var
->type
->column_type();
944 for (/* empty */; col
< var
->type
->matrix_columns
; col
++) {
945 ir_constant_data ident
;
954 ir_rvalue
*const rhs
= new(ctx
) ir_constant(col_type
, &ident
);
956 ir_rvalue
*const lhs
=
957 new(ctx
) ir_dereference_array(var
, new(ctx
) ir_constant(col
));
959 ir_instruction
*inst
= new(ctx
) ir_assignment(lhs
, rhs
, NULL
);
960 instructions
->push_tail(inst
);
964 /* Assign columns from the source matrix to the destination matrix.
966 * Since the parameter will be used in the RHS of multiple assignments,
967 * generate a temporary and copy the paramter there.
969 ir_variable
*const rhs_var
=
970 new(ctx
) ir_variable(first_param
->type
, "mat_ctor_mat",
972 instructions
->push_tail(rhs_var
);
974 ir_dereference
*const rhs_var_ref
=
975 new(ctx
) ir_dereference_variable(rhs_var
);
976 ir_instruction
*const inst
=
977 new(ctx
) ir_assignment(rhs_var_ref
, first_param
, NULL
);
978 instructions
->push_tail(inst
);
980 const unsigned last_row
= MIN2(src_matrix
->type
->vector_elements
,
981 var
->type
->vector_elements
);
982 const unsigned last_col
= MIN2(src_matrix
->type
->matrix_columns
,
983 var
->type
->matrix_columns
);
985 unsigned swiz
[4] = { 0, 0, 0, 0 };
986 for (unsigned i
= 1; i
< last_row
; i
++)
989 const unsigned write_mask
= (1U << last_row
) - 1;
991 for (unsigned i
= 0; i
< last_col
; i
++) {
992 ir_dereference
*const lhs
=
993 new(ctx
) ir_dereference_array(var
, new(ctx
) ir_constant(i
));
994 ir_rvalue
*const rhs_col
=
995 new(ctx
) ir_dereference_array(rhs_var
, new(ctx
) ir_constant(i
));
997 /* If one matrix has columns that are smaller than the columns of the
998 * other matrix, wrap the column access of the larger with a swizzle
999 * so that the LHS and RHS of the assignment have the same size (and
1000 * therefore have the same type).
1002 * It would be perfectly valid to unconditionally generate the
1003 * swizzles, this this will typically result in a more compact IR tree.
1006 if (lhs
->type
->vector_elements
!= rhs_col
->type
->vector_elements
) {
1007 rhs
= new(ctx
) ir_swizzle(rhs_col
, swiz
, last_row
);
1012 ir_instruction
*inst
=
1013 new(ctx
) ir_assignment(lhs
, rhs
, NULL
, write_mask
);
1014 instructions
->push_tail(inst
);
1017 const unsigned cols
= type
->matrix_columns
;
1018 const unsigned rows
= type
->vector_elements
;
1019 unsigned col_idx
= 0;
1020 unsigned row_idx
= 0;
1022 foreach_list (node
, parameters
) {
1023 ir_rvalue
*const rhs
= (ir_rvalue
*) node
;
1024 const unsigned components_remaining_this_column
= rows
- row_idx
;
1025 unsigned rhs_components
= rhs
->type
->components();
1026 unsigned rhs_base
= 0;
1028 /* Since the parameter might be used in the RHS of two assignments,
1029 * generate a temporary and copy the paramter there.
1031 ir_variable
*rhs_var
=
1032 new(ctx
) ir_variable(rhs
->type
, "mat_ctor_vec", ir_var_temporary
);
1033 instructions
->push_tail(rhs_var
);
1035 ir_dereference
*rhs_var_ref
=
1036 new(ctx
) ir_dereference_variable(rhs_var
);
1037 ir_instruction
*inst
= new(ctx
) ir_assignment(rhs_var_ref
, rhs
, NULL
);
1038 instructions
->push_tail(inst
);
1040 /* Assign the current parameter to as many components of the matrix
1043 * NOTE: A single vector parameter can span two matrix columns. A
1044 * single vec4, for example, can completely fill a mat2.
1046 if (rhs_components
>= components_remaining_this_column
) {
1047 const unsigned count
= MIN2(rhs_components
,
1048 components_remaining_this_column
);
1050 rhs_var_ref
= new(ctx
) ir_dereference_variable(rhs_var
);
1052 ir_instruction
*inst
= assign_to_matrix_column(var
, col_idx
,
1056 instructions
->push_tail(inst
);
1064 /* If there is data left in the parameter and components left to be
1065 * set in the destination, emit another assignment. It is possible
1066 * that the assignment could be of a vec4 to the last element of the
1067 * matrix. In this case col_idx==cols, but there is still data
1068 * left in the source parameter. Obviously, don't emit an assignment
1069 * to data outside the destination matrix.
1071 if ((col_idx
< cols
) && (rhs_base
< rhs_components
)) {
1072 const unsigned count
= rhs_components
- rhs_base
;
1074 rhs_var_ref
= new(ctx
) ir_dereference_variable(rhs_var
);
1076 ir_instruction
*inst
= assign_to_matrix_column(var
, col_idx
,
1081 instructions
->push_tail(inst
);
1088 return new(ctx
) ir_dereference_variable(var
);
1093 emit_inline_record_constructor(const glsl_type
*type
,
1094 exec_list
*instructions
,
1095 exec_list
*parameters
,
1098 ir_variable
*const var
=
1099 new(mem_ctx
) ir_variable(type
, "record_ctor", ir_var_temporary
);
1100 ir_dereference_variable
*const d
= new(mem_ctx
) ir_dereference_variable(var
);
1102 instructions
->push_tail(var
);
1104 exec_node
*node
= parameters
->head
;
1105 for (unsigned i
= 0; i
< type
->length
; i
++) {
1106 assert(!node
->is_tail_sentinel());
1108 ir_dereference
*const lhs
=
1109 new(mem_ctx
) ir_dereference_record(d
->clone(mem_ctx
, NULL
),
1110 type
->fields
.structure
[i
].name
);
1112 ir_rvalue
*const rhs
= ((ir_instruction
*) node
)->as_rvalue();
1113 assert(rhs
!= NULL
);
1115 ir_instruction
*const assign
= new(mem_ctx
) ir_assignment(lhs
, rhs
, NULL
);
1117 instructions
->push_tail(assign
);
1126 ast_function_expression::hir(exec_list
*instructions
,
1127 struct _mesa_glsl_parse_state
*state
)
1130 /* There are three sorts of function calls.
1132 * 1. constructors - The first subexpression is an ast_type_specifier.
1133 * 2. methods - Only the .length() method of array types.
1134 * 3. functions - Calls to regular old functions.
1136 * Method calls are actually detected when the ast_field_selection
1137 * expression is handled.
1139 if (is_constructor()) {
1140 const ast_type_specifier
*type
= (ast_type_specifier
*) subexpressions
[0];
1141 YYLTYPE loc
= type
->get_location();
1144 const glsl_type
*const constructor_type
= type
->glsl_type(& name
, state
);
1146 /* constructor_type can be NULL if a variable with the same name as the
1147 * structure has come into scope.
1149 if (constructor_type
== NULL
) {
1150 _mesa_glsl_error(& loc
, state
, "unknown type `%s' (structure name "
1151 "may be shadowed by a variable with the same name)",
1153 return ir_call::get_error_instruction(ctx
);
1157 /* Constructors for samplers are illegal.
1159 if (constructor_type
->is_sampler()) {
1160 _mesa_glsl_error(& loc
, state
, "cannot construct sampler type `%s'",
1161 constructor_type
->name
);
1162 return ir_call::get_error_instruction(ctx
);
1165 if (constructor_type
->is_array()) {
1166 if (state
->language_version
<= 110) {
1167 _mesa_glsl_error(& loc
, state
,
1168 "array constructors forbidden in GLSL 1.10");
1169 return ir_call::get_error_instruction(ctx
);
1172 return process_array_constructor(instructions
, constructor_type
,
1173 & loc
, &this->expressions
, state
);
1177 /* There are two kinds of constructor call. Constructors for built-in
1178 * language types, such as mat4 and vec2, are free form. The only
1179 * requirement is that the parameters must provide enough values of the
1180 * correct scalar type. Constructors for arrays and structures must
1181 * have the exact number of parameters with matching types in the
1182 * correct order. These constructors follow essentially the same type
1183 * matching rules as functions.
1185 if (constructor_type
->is_record()) {
1186 exec_list actual_parameters
;
1188 process_parameters(instructions
, &actual_parameters
,
1189 &this->expressions
, state
);
1191 exec_node
*node
= actual_parameters
.head
;
1192 for (unsigned i
= 0; i
< constructor_type
->length
; i
++) {
1193 ir_rvalue
*ir
= (ir_rvalue
*) node
;
1195 if (node
->is_tail_sentinel()) {
1196 _mesa_glsl_error(&loc
, state
,
1197 "insufficient parameters to constructor "
1199 constructor_type
->name
);
1200 return ir_call::get_error_instruction(ctx
);
1203 if (apply_implicit_conversion(constructor_type
->fields
.structure
[i
].type
,
1205 node
->replace_with(ir
);
1207 _mesa_glsl_error(&loc
, state
,
1208 "parameter type mismatch in constructor "
1209 "for `%s.%s' (%s vs %s)",
1210 constructor_type
->name
,
1211 constructor_type
->fields
.structure
[i
].name
,
1213 constructor_type
->fields
.structure
[i
].type
->name
);
1214 return ir_call::get_error_instruction(ctx
);;
1220 if (!node
->is_tail_sentinel()) {
1221 _mesa_glsl_error(&loc
, state
, "too many parameters in constructor "
1222 "for `%s'", constructor_type
->name
);
1223 return ir_call::get_error_instruction(ctx
);
1226 ir_rvalue
*const constant
=
1227 constant_record_constructor(constructor_type
, &actual_parameters
,
1230 return (constant
!= NULL
)
1232 : emit_inline_record_constructor(constructor_type
, instructions
,
1233 &actual_parameters
, state
);
1236 if (!constructor_type
->is_numeric() && !constructor_type
->is_boolean())
1237 return ir_call::get_error_instruction(ctx
);
1239 /* Total number of components of the type being constructed. */
1240 const unsigned type_components
= constructor_type
->components();
1242 /* Number of components from parameters that have actually been
1243 * consumed. This is used to perform several kinds of error checking.
1245 unsigned components_used
= 0;
1247 unsigned matrix_parameters
= 0;
1248 unsigned nonmatrix_parameters
= 0;
1249 exec_list actual_parameters
;
1251 foreach_list (n
, &this->expressions
) {
1252 ast_node
*ast
= exec_node_data(ast_node
, n
, link
);
1253 ir_rvalue
*result
= ast
->hir(instructions
, state
)->as_rvalue();
1255 /* From page 50 (page 56 of the PDF) of the GLSL 1.50 spec:
1257 * "It is an error to provide extra arguments beyond this
1258 * last used argument."
1260 if (components_used
>= type_components
) {
1261 _mesa_glsl_error(& loc
, state
, "too many parameters to `%s' "
1263 constructor_type
->name
);
1264 return ir_call::get_error_instruction(ctx
);
1267 if (!result
->type
->is_numeric() && !result
->type
->is_boolean()) {
1268 _mesa_glsl_error(& loc
, state
, "cannot construct `%s' from a "
1269 "non-numeric data type",
1270 constructor_type
->name
);
1271 return ir_call::get_error_instruction(ctx
);
1274 /* Count the number of matrix and nonmatrix parameters. This
1275 * is used below to enforce some of the constructor rules.
1277 if (result
->type
->is_matrix())
1278 matrix_parameters
++;
1280 nonmatrix_parameters
++;
1282 actual_parameters
.push_tail(result
);
1283 components_used
+= result
->type
->components();
1286 /* From page 28 (page 34 of the PDF) of the GLSL 1.10 spec:
1288 * "It is an error to construct matrices from other matrices. This
1289 * is reserved for future use."
1291 if (state
->language_version
== 110 && matrix_parameters
> 0
1292 && constructor_type
->is_matrix()) {
1293 _mesa_glsl_error(& loc
, state
, "cannot construct `%s' from a "
1294 "matrix in GLSL 1.10",
1295 constructor_type
->name
);
1296 return ir_call::get_error_instruction(ctx
);
1299 /* From page 50 (page 56 of the PDF) of the GLSL 1.50 spec:
1301 * "If a matrix argument is given to a matrix constructor, it is
1302 * an error to have any other arguments."
1304 if ((matrix_parameters
> 0)
1305 && ((matrix_parameters
+ nonmatrix_parameters
) > 1)
1306 && constructor_type
->is_matrix()) {
1307 _mesa_glsl_error(& loc
, state
, "for matrix `%s' constructor, "
1308 "matrix must be only parameter",
1309 constructor_type
->name
);
1310 return ir_call::get_error_instruction(ctx
);
1313 /* From page 28 (page 34 of the PDF) of the GLSL 1.10 spec:
1315 * "In these cases, there must be enough components provided in the
1316 * arguments to provide an initializer for every component in the
1317 * constructed value."
1319 if (components_used
< type_components
&& components_used
!= 1
1320 && matrix_parameters
== 0) {
1321 _mesa_glsl_error(& loc
, state
, "too few components to construct "
1323 constructor_type
->name
);
1324 return ir_call::get_error_instruction(ctx
);
1327 /* Later, we cast each parameter to the same base type as the
1328 * constructor. Since there are no non-floating point matrices, we
1329 * need to break them up into a series of column vectors.
1331 if (constructor_type
->base_type
!= GLSL_TYPE_FLOAT
) {
1332 foreach_list_safe(n
, &actual_parameters
) {
1333 ir_rvalue
*matrix
= (ir_rvalue
*) n
;
1335 if (!matrix
->type
->is_matrix())
1338 /* Create a temporary containing the matrix. */
1339 ir_variable
*var
= new(ctx
) ir_variable(matrix
->type
, "matrix_tmp",
1341 instructions
->push_tail(var
);
1342 instructions
->push_tail(new(ctx
) ir_assignment(new(ctx
)
1343 ir_dereference_variable(var
), matrix
, NULL
));
1344 var
->constant_value
= matrix
->constant_expression_value();
1346 /* Replace the matrix with dereferences of its columns. */
1347 for (int i
= 0; i
< matrix
->type
->matrix_columns
; i
++) {
1348 matrix
->insert_before(new (ctx
) ir_dereference_array(var
,
1349 new(ctx
) ir_constant(i
)));
1355 bool all_parameters_are_constant
= true;
1357 /* Type cast each parameter and, if possible, fold constants.*/
1358 foreach_list_safe(n
, &actual_parameters
) {
1359 ir_rvalue
*ir
= (ir_rvalue
*) n
;
1361 const glsl_type
*desired_type
=
1362 glsl_type::get_instance(constructor_type
->base_type
,
1363 ir
->type
->vector_elements
,
1364 ir
->type
->matrix_columns
);
1365 ir_rvalue
*result
= convert_component(ir
, desired_type
);
1367 /* Attempt to convert the parameter to a constant valued expression.
1368 * After doing so, track whether or not all the parameters to the
1369 * constructor are trivially constant valued expressions.
1371 ir_rvalue
*const constant
= result
->constant_expression_value();
1373 if (constant
!= NULL
)
1376 all_parameters_are_constant
= false;
1379 ir
->replace_with(result
);
1383 /* If all of the parameters are trivially constant, create a
1384 * constant representing the complete collection of parameters.
1386 if (all_parameters_are_constant
) {
1387 return new(ctx
) ir_constant(constructor_type
, &actual_parameters
);
1388 } else if (constructor_type
->is_scalar()) {
1389 return dereference_component((ir_rvalue
*) actual_parameters
.head
,
1391 } else if (constructor_type
->is_vector()) {
1392 return emit_inline_vector_constructor(constructor_type
,
1397 assert(constructor_type
->is_matrix());
1398 return emit_inline_matrix_constructor(constructor_type
,
1404 const ast_expression
*id
= subexpressions
[0];
1405 YYLTYPE loc
= id
->get_location();
1406 exec_list actual_parameters
;
1408 process_parameters(instructions
, &actual_parameters
, &this->expressions
,
1411 return match_function_by_name(instructions
,
1412 id
->primary_expression
.identifier
, & loc
,
1413 &actual_parameters
, state
);
1416 return ir_call::get_error_instruction(ctx
);