Convert everything from the talloc API to the ralloc API.
[mesa.git] / src / glsl / ast_function.cpp
1 /*
2 * Copyright © 2010 Intel Corporation
3 *
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:
10 *
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
13 * Software.
14 *
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.
22 */
23
24 #include "glsl_symbol_table.h"
25 #include "ast.h"
26 #include "glsl_types.h"
27 #include "ir.h"
28 #include "main/core.h" /* for MIN2 */
29
30 static ir_rvalue *
31 convert_component(ir_rvalue *src, const glsl_type *desired_type);
32
33 bool
34 apply_implicit_conversion(const glsl_type *to, ir_rvalue * &from,
35 struct _mesa_glsl_parse_state *state);
36
37 static unsigned
38 process_parameters(exec_list *instructions, exec_list *actual_parameters,
39 exec_list *parameters,
40 struct _mesa_glsl_parse_state *state)
41 {
42 unsigned count = 0;
43
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);
47
48 ir_constant *const constant = result->constant_expression_value();
49 if (constant != NULL)
50 result = constant;
51
52 actual_parameters->push_tail(result);
53 count++;
54 }
55
56 return count;
57 }
58
59
60 /**
61 * Generate a source prototype for a function signature
62 *
63 * \param return_type Return type of the function. May be \c NULL.
64 * \param name Name of the function.
65 * \param parameters Parameter list for the function. This may be either a
66 * formal or actual parameter list. Only the type is used.
67 *
68 * \return
69 * A ralloced string representing the prototype of the function.
70 */
71 char *
72 prototype_string(const glsl_type *return_type, const char *name,
73 exec_list *parameters)
74 {
75 char *str = NULL;
76
77 if (return_type != NULL)
78 ralloc_asprintf(&str, "%s ", return_type->name);
79
80 ralloc_asprintf_append(&str, "%s(", name);
81
82 const char *comma = "";
83 foreach_list(node, parameters) {
84 const ir_instruction *const param = (ir_instruction *) node;
85
86 ralloc_asprintf_append(&str, "%s%s", comma, param->type->name);
87 comma = ", ";
88 }
89
90 ralloc_strcat(&str, ")");
91 return str;
92 }
93
94
95 static ir_rvalue *
96 match_function_by_name(exec_list *instructions, const char *name,
97 YYLTYPE *loc, exec_list *actual_parameters,
98 struct _mesa_glsl_parse_state *state)
99 {
100 void *ctx = state;
101 ir_function *f = state->symbols->get_function(name);
102 ir_function_signature *sig;
103
104 sig = f ? f->matching_signature(actual_parameters) : NULL;
105
106 /* FINISHME: This doesn't handle the case where shader X contains a
107 * FINISHME: matching signature but shader X + N contains an _exact_
108 * FINISHME: matching signature.
109 */
110 if (sig == NULL && (f == NULL || state->es_shader || !f->has_user_signature()) && state->symbols->get_type(name) == NULL && (state->language_version == 110 || state->symbols->get_variable(name) == NULL)) {
111 /* The current shader doesn't contain a matching function or signature.
112 * Before giving up, look for the prototype in the built-in functions.
113 */
114 for (unsigned i = 0; i < state->num_builtins_to_link; i++) {
115 ir_function *builtin;
116 builtin = state->builtins_to_link[i]->symbols->get_function(name);
117 sig = builtin ? builtin->matching_signature(actual_parameters) : NULL;
118 if (sig != NULL) {
119 if (f == NULL) {
120 f = new(ctx) ir_function(name);
121 state->symbols->add_global_function(f);
122 emit_function(state, instructions, f);
123 }
124
125 f->add_signature(sig->clone_prototype(f, NULL));
126 break;
127 }
128 }
129 }
130
131 if (sig != NULL) {
132 /* Verify that 'out' and 'inout' actual parameters are lvalues. This
133 * isn't done in ir_function::matching_signature because that function
134 * cannot generate the necessary diagnostics.
135 */
136 exec_list_iterator actual_iter = actual_parameters->iterator();
137 exec_list_iterator formal_iter = sig->parameters.iterator();
138
139 while (actual_iter.has_next()) {
140 ir_rvalue *actual = (ir_rvalue *) actual_iter.get();
141 ir_variable *formal = (ir_variable *) formal_iter.get();
142
143 assert(actual != NULL);
144 assert(formal != NULL);
145
146 if ((formal->mode == ir_var_out)
147 || (formal->mode == ir_var_inout)) {
148 const char *mode = NULL;
149 switch (formal->mode) {
150 case ir_var_out: mode = "out"; break;
151 case ir_var_inout: mode = "inout"; break;
152 default: assert(false); break;
153 }
154 /* FIXME: 'loc' is incorrect (as of 2011-01-21). It is always
155 * FIXME: 0:0(0).
156 */
157 if (actual->variable_referenced()
158 && actual->variable_referenced()->read_only) {
159 _mesa_glsl_error(loc, state,
160 "function parameter '%s %s' references the "
161 "read-only variable '%s'",
162 mode, formal->name,
163 actual->variable_referenced()->name);
164
165 } else if (!actual->is_lvalue()) {
166 _mesa_glsl_error(loc, state,
167 "function parameter '%s %s' is not an lvalue",
168 mode, formal->name);
169 }
170 }
171
172 if (formal->type->is_numeric() || formal->type->is_boolean()) {
173 ir_rvalue *converted = convert_component(actual, formal->type);
174 actual->replace_with(converted);
175 }
176
177 actual_iter.next();
178 formal_iter.next();
179 }
180
181 /* Always insert the call in the instruction stream, and return a deref
182 * of its return val if it returns a value, since we don't know if
183 * the rvalue is going to be assigned to anything or not.
184 */
185 ir_call *call = new(ctx) ir_call(sig, actual_parameters);
186 if (!sig->return_type->is_void()) {
187 ir_variable *var;
188 ir_dereference_variable *deref;
189
190 var = new(ctx) ir_variable(sig->return_type,
191 ralloc_asprintf(ctx, "%s_retval",
192 sig->function_name()),
193 ir_var_temporary);
194 instructions->push_tail(var);
195
196 deref = new(ctx) ir_dereference_variable(var);
197 ir_assignment *assign = new(ctx) ir_assignment(deref, call, NULL);
198 instructions->push_tail(assign);
199 if (state->language_version >= 120)
200 var->constant_value = call->constant_expression_value();
201
202 deref = new(ctx) ir_dereference_variable(var);
203 return deref;
204 } else {
205 instructions->push_tail(call);
206 return NULL;
207 }
208 } else {
209 char *str = prototype_string(NULL, name, actual_parameters);
210
211 _mesa_glsl_error(loc, state, "no matching function for call to `%s'",
212 str);
213 ralloc_free(str);
214
215 const char *prefix = "candidates are: ";
216
217 for (int i = -1; i < state->num_builtins_to_link; i++) {
218 glsl_symbol_table *syms = i >= 0 ? state->builtins_to_link[i]->symbols
219 : state->symbols;
220 f = syms->get_function(name);
221 if (f == NULL)
222 continue;
223
224 foreach_list (node, &f->signatures) {
225 ir_function_signature *sig = (ir_function_signature *) node;
226
227 str = prototype_string(sig->return_type, f->name, &sig->parameters);
228 _mesa_glsl_error(loc, state, "%s%s\n", prefix, str);
229 ralloc_free(str);
230
231 prefix = " ";
232 }
233
234 }
235
236 return ir_call::get_error_instruction(ctx);
237 }
238 }
239
240
241 /**
242 * Perform automatic type conversion of constructor parameters
243 *
244 * This implements the rules in the "Conversion and Scalar Constructors"
245 * section (GLSL 1.10 section 5.4.1), not the "Implicit Conversions" rules.
246 */
247 static ir_rvalue *
248 convert_component(ir_rvalue *src, const glsl_type *desired_type)
249 {
250 void *ctx = ralloc_parent(src);
251 const unsigned a = desired_type->base_type;
252 const unsigned b = src->type->base_type;
253 ir_expression *result = NULL;
254
255 if (src->type->is_error())
256 return src;
257
258 assert(a <= GLSL_TYPE_BOOL);
259 assert(b <= GLSL_TYPE_BOOL);
260
261 if ((a == b) || (src->type->is_integer() && desired_type->is_integer()))
262 return src;
263
264 switch (a) {
265 case GLSL_TYPE_UINT:
266 case GLSL_TYPE_INT:
267 if (b == GLSL_TYPE_FLOAT)
268 result = new(ctx) ir_expression(ir_unop_f2i, desired_type, src, NULL);
269 else {
270 assert(b == GLSL_TYPE_BOOL);
271 result = new(ctx) ir_expression(ir_unop_b2i, desired_type, src, NULL);
272 }
273 break;
274 case GLSL_TYPE_FLOAT:
275 switch (b) {
276 case GLSL_TYPE_UINT:
277 result = new(ctx) ir_expression(ir_unop_u2f, desired_type, src, NULL);
278 break;
279 case GLSL_TYPE_INT:
280 result = new(ctx) ir_expression(ir_unop_i2f, desired_type, src, NULL);
281 break;
282 case GLSL_TYPE_BOOL:
283 result = new(ctx) ir_expression(ir_unop_b2f, desired_type, src, NULL);
284 break;
285 }
286 break;
287 case GLSL_TYPE_BOOL:
288 switch (b) {
289 case GLSL_TYPE_UINT:
290 case GLSL_TYPE_INT:
291 result = new(ctx) ir_expression(ir_unop_i2b, desired_type, src, NULL);
292 break;
293 case GLSL_TYPE_FLOAT:
294 result = new(ctx) ir_expression(ir_unop_f2b, desired_type, src, NULL);
295 break;
296 }
297 break;
298 }
299
300 assert(result != NULL);
301
302 /* Try constant folding; it may fold in the conversion we just added. */
303 ir_constant *const constant = result->constant_expression_value();
304 return (constant != NULL) ? (ir_rvalue *) constant : (ir_rvalue *) result;
305 }
306
307 /**
308 * Dereference a specific component from a scalar, vector, or matrix
309 */
310 static ir_rvalue *
311 dereference_component(ir_rvalue *src, unsigned component)
312 {
313 void *ctx = ralloc_parent(src);
314 assert(component < src->type->components());
315
316 /* If the source is a constant, just create a new constant instead of a
317 * dereference of the existing constant.
318 */
319 ir_constant *constant = src->as_constant();
320 if (constant)
321 return new(ctx) ir_constant(constant, component);
322
323 if (src->type->is_scalar()) {
324 return src;
325 } else if (src->type->is_vector()) {
326 return new(ctx) ir_swizzle(src, component, 0, 0, 0, 1);
327 } else {
328 assert(src->type->is_matrix());
329
330 /* Dereference a row of the matrix, then call this function again to get
331 * a specific element from that row.
332 */
333 const int c = component / src->type->column_type()->vector_elements;
334 const int r = component % src->type->column_type()->vector_elements;
335 ir_constant *const col_index = new(ctx) ir_constant(c);
336 ir_dereference *const col = new(ctx) ir_dereference_array(src, col_index);
337
338 col->type = src->type->column_type();
339
340 return dereference_component(col, r);
341 }
342
343 assert(!"Should not get here.");
344 return NULL;
345 }
346
347
348 static ir_rvalue *
349 process_array_constructor(exec_list *instructions,
350 const glsl_type *constructor_type,
351 YYLTYPE *loc, exec_list *parameters,
352 struct _mesa_glsl_parse_state *state)
353 {
354 void *ctx = state;
355 /* Array constructors come in two forms: sized and unsized. Sized array
356 * constructors look like 'vec4[2](a, b)', where 'a' and 'b' are vec4
357 * variables. In this case the number of parameters must exactly match the
358 * specified size of the array.
359 *
360 * Unsized array constructors look like 'vec4[](a, b)', where 'a' and 'b'
361 * are vec4 variables. In this case the size of the array being constructed
362 * is determined by the number of parameters.
363 *
364 * From page 52 (page 58 of the PDF) of the GLSL 1.50 spec:
365 *
366 * "There must be exactly the same number of arguments as the size of
367 * the array being constructed. If no size is present in the
368 * constructor, then the array is explicitly sized to the number of
369 * arguments provided. The arguments are assigned in order, starting at
370 * element 0, to the elements of the constructed array. Each argument
371 * must be the same type as the element type of the array, or be a type
372 * that can be converted to the element type of the array according to
373 * Section 4.1.10 "Implicit Conversions.""
374 */
375 exec_list actual_parameters;
376 const unsigned parameter_count =
377 process_parameters(instructions, &actual_parameters, parameters, state);
378
379 if ((parameter_count == 0)
380 || ((constructor_type->length != 0)
381 && (constructor_type->length != parameter_count))) {
382 const unsigned min_param = (constructor_type->length == 0)
383 ? 1 : constructor_type->length;
384
385 _mesa_glsl_error(loc, state, "array constructor must have %s %u "
386 "parameter%s",
387 (constructor_type->length != 0) ? "at least" : "exactly",
388 min_param, (min_param <= 1) ? "" : "s");
389 return ir_call::get_error_instruction(ctx);
390 }
391
392 if (constructor_type->length == 0) {
393 constructor_type =
394 glsl_type::get_array_instance(constructor_type->element_type(),
395 parameter_count);
396 assert(constructor_type != NULL);
397 assert(constructor_type->length == parameter_count);
398 }
399
400 bool all_parameters_are_constant = true;
401
402 /* Type cast each parameter and, if possible, fold constants. */
403 foreach_list_safe(n, &actual_parameters) {
404 ir_rvalue *ir = (ir_rvalue *) n;
405 ir_rvalue *result = ir;
406
407 /* Apply implicit conversions (not the scalar constructor rules!) */
408 if (constructor_type->element_type()->is_float()) {
409 const glsl_type *desired_type =
410 glsl_type::get_instance(GLSL_TYPE_FLOAT,
411 ir->type->vector_elements,
412 ir->type->matrix_columns);
413 result = convert_component(ir, desired_type);
414 }
415
416 if (result->type != constructor_type->element_type()) {
417 _mesa_glsl_error(loc, state, "type error in array constructor: "
418 "expected: %s, found %s",
419 constructor_type->element_type()->name,
420 result->type->name);
421 }
422
423 /* Attempt to convert the parameter to a constant valued expression.
424 * After doing so, track whether or not all the parameters to the
425 * constructor are trivially constant valued expressions.
426 */
427 ir_rvalue *const constant = result->constant_expression_value();
428
429 if (constant != NULL)
430 result = constant;
431 else
432 all_parameters_are_constant = false;
433
434 ir->replace_with(result);
435 }
436
437 if (all_parameters_are_constant)
438 return new(ctx) ir_constant(constructor_type, &actual_parameters);
439
440 ir_variable *var = new(ctx) ir_variable(constructor_type, "array_ctor",
441 ir_var_temporary);
442 instructions->push_tail(var);
443
444 int i = 0;
445 foreach_list(node, &actual_parameters) {
446 ir_rvalue *rhs = (ir_rvalue *) node;
447 ir_rvalue *lhs = new(ctx) ir_dereference_array(var,
448 new(ctx) ir_constant(i));
449
450 ir_instruction *assignment = new(ctx) ir_assignment(lhs, rhs, NULL);
451 instructions->push_tail(assignment);
452
453 i++;
454 }
455
456 return new(ctx) ir_dereference_variable(var);
457 }
458
459
460 /**
461 * Try to convert a record constructor to a constant expression
462 */
463 static ir_constant *
464 constant_record_constructor(const glsl_type *constructor_type,
465 exec_list *parameters, void *mem_ctx)
466 {
467 foreach_list(node, parameters) {
468 ir_constant *constant = ((ir_instruction *) node)->as_constant();
469 if (constant == NULL)
470 return NULL;
471 node->replace_with(constant);
472 }
473
474 return new(mem_ctx) ir_constant(constructor_type, parameters);
475 }
476
477
478 /**
479 * Determine if a list consists of a single scalar r-value
480 */
481 bool
482 single_scalar_parameter(exec_list *parameters)
483 {
484 const ir_rvalue *const p = (ir_rvalue *) parameters->head;
485 assert(((ir_rvalue *)p)->as_rvalue() != NULL);
486
487 return (p->type->is_scalar() && p->next->is_tail_sentinel());
488 }
489
490
491 /**
492 * Generate inline code for a vector constructor
493 *
494 * The generated constructor code will consist of a temporary variable
495 * declaration of the same type as the constructor. A sequence of assignments
496 * from constructor parameters to the temporary will follow.
497 *
498 * \return
499 * An \c ir_dereference_variable of the temprorary generated in the constructor
500 * body.
501 */
502 ir_rvalue *
503 emit_inline_vector_constructor(const glsl_type *type,
504 exec_list *instructions,
505 exec_list *parameters,
506 void *ctx)
507 {
508 assert(!parameters->is_empty());
509
510 ir_variable *var = new(ctx) ir_variable(type, "vec_ctor", ir_var_temporary);
511 instructions->push_tail(var);
512
513 /* There are two kinds of vector constructors.
514 *
515 * - Construct a vector from a single scalar by replicating that scalar to
516 * all components of the vector.
517 *
518 * - Construct a vector from an arbirary combination of vectors and
519 * scalars. The components of the constructor parameters are assigned
520 * to the vector in order until the vector is full.
521 */
522 const unsigned lhs_components = type->components();
523 if (single_scalar_parameter(parameters)) {
524 ir_rvalue *first_param = (ir_rvalue *)parameters->head;
525 ir_rvalue *rhs = new(ctx) ir_swizzle(first_param, 0, 0, 0, 0,
526 lhs_components);
527 ir_dereference_variable *lhs = new(ctx) ir_dereference_variable(var);
528 const unsigned mask = (1U << lhs_components) - 1;
529
530 assert(rhs->type == lhs->type);
531
532 ir_instruction *inst = new(ctx) ir_assignment(lhs, rhs, NULL, mask);
533 instructions->push_tail(inst);
534 } else {
535 unsigned base_component = 0;
536 unsigned base_lhs_component = 0;
537 ir_constant_data data;
538 unsigned constant_mask = 0, constant_components = 0;
539
540 memset(&data, 0, sizeof(data));
541
542 foreach_list(node, parameters) {
543 ir_rvalue *param = (ir_rvalue *) node;
544 unsigned rhs_components = param->type->components();
545
546 /* Do not try to assign more components to the vector than it has!
547 */
548 if ((rhs_components + base_lhs_component) > lhs_components) {
549 rhs_components = lhs_components - base_lhs_component;
550 }
551
552 const ir_constant *const c = param->as_constant();
553 if (c != NULL) {
554 for (unsigned i = 0; i < rhs_components; i++) {
555 switch (c->type->base_type) {
556 case GLSL_TYPE_UINT:
557 data.u[i + base_component] = c->get_uint_component(i);
558 break;
559 case GLSL_TYPE_INT:
560 data.i[i + base_component] = c->get_int_component(i);
561 break;
562 case GLSL_TYPE_FLOAT:
563 data.f[i + base_component] = c->get_float_component(i);
564 break;
565 case GLSL_TYPE_BOOL:
566 data.b[i + base_component] = c->get_bool_component(i);
567 break;
568 default:
569 assert(!"Should not get here.");
570 break;
571 }
572 }
573
574 /* Mask of fields to be written in the assignment.
575 */
576 constant_mask |= ((1U << rhs_components) - 1) << base_lhs_component;
577 constant_components += rhs_components;
578
579 base_component += rhs_components;
580 }
581 /* Advance the component index by the number of components
582 * that were just assigned.
583 */
584 base_lhs_component += rhs_components;
585 }
586
587 if (constant_mask != 0) {
588 ir_dereference *lhs = new(ctx) ir_dereference_variable(var);
589 const glsl_type *rhs_type = glsl_type::get_instance(var->type->base_type,
590 constant_components,
591 1);
592 ir_rvalue *rhs = new(ctx) ir_constant(rhs_type, &data);
593
594 ir_instruction *inst =
595 new(ctx) ir_assignment(lhs, rhs, NULL, constant_mask);
596 instructions->push_tail(inst);
597 }
598
599 base_component = 0;
600 foreach_list(node, parameters) {
601 ir_rvalue *param = (ir_rvalue *) node;
602 unsigned rhs_components = param->type->components();
603
604 /* Do not try to assign more components to the vector than it has!
605 */
606 if ((rhs_components + base_component) > lhs_components) {
607 rhs_components = lhs_components - base_component;
608 }
609
610 const ir_constant *const c = param->as_constant();
611 if (c == NULL) {
612 /* Mask of fields to be written in the assignment.
613 */
614 const unsigned write_mask = ((1U << rhs_components) - 1)
615 << base_component;
616
617 ir_dereference *lhs = new(ctx) ir_dereference_variable(var);
618
619 /* Generate a swizzle so that LHS and RHS sizes match.
620 */
621 ir_rvalue *rhs =
622 new(ctx) ir_swizzle(param, 0, 1, 2, 3, rhs_components);
623
624 ir_instruction *inst =
625 new(ctx) ir_assignment(lhs, rhs, NULL, write_mask);
626 instructions->push_tail(inst);
627 }
628
629 /* Advance the component index by the number of components that were
630 * just assigned.
631 */
632 base_component += rhs_components;
633 }
634 }
635 return new(ctx) ir_dereference_variable(var);
636 }
637
638
639 /**
640 * Generate assignment of a portion of a vector to a portion of a matrix column
641 *
642 * \param src_base First component of the source to be used in assignment
643 * \param column Column of destination to be assiged
644 * \param row_base First component of the destination column to be assigned
645 * \param count Number of components to be assigned
646 *
647 * \note
648 * \c src_base + \c count must be less than or equal to the number of components
649 * in the source vector.
650 */
651 ir_instruction *
652 assign_to_matrix_column(ir_variable *var, unsigned column, unsigned row_base,
653 ir_rvalue *src, unsigned src_base, unsigned count,
654 void *mem_ctx)
655 {
656 ir_constant *col_idx = new(mem_ctx) ir_constant(column);
657 ir_dereference *column_ref = new(mem_ctx) ir_dereference_array(var, col_idx);
658
659 assert(column_ref->type->components() >= (row_base + count));
660 assert(src->type->components() >= (src_base + count));
661
662 /* Generate a swizzle that extracts the number of components from the source
663 * that are to be assigned to the column of the matrix.
664 */
665 if (count < src->type->vector_elements) {
666 src = new(mem_ctx) ir_swizzle(src,
667 src_base + 0, src_base + 1,
668 src_base + 2, src_base + 3,
669 count);
670 }
671
672 /* Mask of fields to be written in the assignment.
673 */
674 const unsigned write_mask = ((1U << count) - 1) << row_base;
675
676 return new(mem_ctx) ir_assignment(column_ref, src, NULL, write_mask);
677 }
678
679
680 /**
681 * Generate inline code for a matrix constructor
682 *
683 * The generated constructor code will consist of a temporary variable
684 * declaration of the same type as the constructor. A sequence of assignments
685 * from constructor parameters to the temporary will follow.
686 *
687 * \return
688 * An \c ir_dereference_variable of the temprorary generated in the constructor
689 * body.
690 */
691 ir_rvalue *
692 emit_inline_matrix_constructor(const glsl_type *type,
693 exec_list *instructions,
694 exec_list *parameters,
695 void *ctx)
696 {
697 assert(!parameters->is_empty());
698
699 ir_variable *var = new(ctx) ir_variable(type, "mat_ctor", ir_var_temporary);
700 instructions->push_tail(var);
701
702 /* There are three kinds of matrix constructors.
703 *
704 * - Construct a matrix from a single scalar by replicating that scalar to
705 * along the diagonal of the matrix and setting all other components to
706 * zero.
707 *
708 * - Construct a matrix from an arbirary combination of vectors and
709 * scalars. The components of the constructor parameters are assigned
710 * to the matrix in colum-major order until the matrix is full.
711 *
712 * - Construct a matrix from a single matrix. The source matrix is copied
713 * to the upper left portion of the constructed matrix, and the remaining
714 * elements take values from the identity matrix.
715 */
716 ir_rvalue *const first_param = (ir_rvalue *) parameters->head;
717 if (single_scalar_parameter(parameters)) {
718 /* Assign the scalar to the X component of a vec4, and fill the remaining
719 * components with zero.
720 */
721 ir_variable *rhs_var =
722 new(ctx) ir_variable(glsl_type::vec4_type, "mat_ctor_vec",
723 ir_var_temporary);
724 instructions->push_tail(rhs_var);
725
726 ir_constant_data zero;
727 zero.f[0] = 0.0;
728 zero.f[1] = 0.0;
729 zero.f[2] = 0.0;
730 zero.f[3] = 0.0;
731
732 ir_instruction *inst =
733 new(ctx) ir_assignment(new(ctx) ir_dereference_variable(rhs_var),
734 new(ctx) ir_constant(rhs_var->type, &zero),
735 NULL);
736 instructions->push_tail(inst);
737
738 ir_dereference *const rhs_ref = new(ctx) ir_dereference_variable(rhs_var);
739
740 inst = new(ctx) ir_assignment(rhs_ref, first_param, NULL, 0x01);
741 instructions->push_tail(inst);
742
743 /* Assign the temporary vector to each column of the destination matrix
744 * with a swizzle that puts the X component on the diagonal of the
745 * matrix. In some cases this may mean that the X component does not
746 * get assigned into the column at all (i.e., when the matrix has more
747 * columns than rows).
748 */
749 static const unsigned rhs_swiz[4][4] = {
750 { 0, 1, 1, 1 },
751 { 1, 0, 1, 1 },
752 { 1, 1, 0, 1 },
753 { 1, 1, 1, 0 }
754 };
755
756 const unsigned cols_to_init = MIN2(type->matrix_columns,
757 type->vector_elements);
758 for (unsigned i = 0; i < cols_to_init; i++) {
759 ir_constant *const col_idx = new(ctx) ir_constant(i);
760 ir_rvalue *const col_ref = new(ctx) ir_dereference_array(var, col_idx);
761
762 ir_rvalue *const rhs_ref = new(ctx) ir_dereference_variable(rhs_var);
763 ir_rvalue *const rhs = new(ctx) ir_swizzle(rhs_ref, rhs_swiz[i],
764 type->vector_elements);
765
766 inst = new(ctx) ir_assignment(col_ref, rhs, NULL);
767 instructions->push_tail(inst);
768 }
769
770 for (unsigned i = cols_to_init; i < type->matrix_columns; i++) {
771 ir_constant *const col_idx = new(ctx) ir_constant(i);
772 ir_rvalue *const col_ref = new(ctx) ir_dereference_array(var, col_idx);
773
774 ir_rvalue *const rhs_ref = new(ctx) ir_dereference_variable(rhs_var);
775 ir_rvalue *const rhs = new(ctx) ir_swizzle(rhs_ref, 1, 1, 1, 1,
776 type->vector_elements);
777
778 inst = new(ctx) ir_assignment(col_ref, rhs, NULL);
779 instructions->push_tail(inst);
780 }
781 } else if (first_param->type->is_matrix()) {
782 /* From page 50 (56 of the PDF) of the GLSL 1.50 spec:
783 *
784 * "If a matrix is constructed from a matrix, then each component
785 * (column i, row j) in the result that has a corresponding
786 * component (column i, row j) in the argument will be initialized
787 * from there. All other components will be initialized to the
788 * identity matrix. If a matrix argument is given to a matrix
789 * constructor, it is an error to have any other arguments."
790 */
791 assert(first_param->next->is_tail_sentinel());
792 ir_rvalue *const src_matrix = first_param;
793
794 /* If the source matrix is smaller, pre-initialize the relavent parts of
795 * the destination matrix to the identity matrix.
796 */
797 if ((src_matrix->type->matrix_columns < var->type->matrix_columns)
798 || (src_matrix->type->vector_elements < var->type->vector_elements)) {
799
800 /* If the source matrix has fewer rows, every column of the destination
801 * must be initialized. Otherwise only the columns in the destination
802 * that do not exist in the source must be initialized.
803 */
804 unsigned col =
805 (src_matrix->type->vector_elements < var->type->vector_elements)
806 ? 0 : src_matrix->type->matrix_columns;
807
808 const glsl_type *const col_type = var->type->column_type();
809 for (/* empty */; col < var->type->matrix_columns; col++) {
810 ir_constant_data ident;
811
812 ident.f[0] = 0.0;
813 ident.f[1] = 0.0;
814 ident.f[2] = 0.0;
815 ident.f[3] = 0.0;
816
817 ident.f[col] = 1.0;
818
819 ir_rvalue *const rhs = new(ctx) ir_constant(col_type, &ident);
820
821 ir_rvalue *const lhs =
822 new(ctx) ir_dereference_array(var, new(ctx) ir_constant(col));
823
824 ir_instruction *inst = new(ctx) ir_assignment(lhs, rhs, NULL);
825 instructions->push_tail(inst);
826 }
827 }
828
829 /* Assign columns from the source matrix to the destination matrix.
830 *
831 * Since the parameter will be used in the RHS of multiple assignments,
832 * generate a temporary and copy the paramter there.
833 */
834 ir_variable *const rhs_var =
835 new(ctx) ir_variable(first_param->type, "mat_ctor_mat",
836 ir_var_temporary);
837 instructions->push_tail(rhs_var);
838
839 ir_dereference *const rhs_var_ref =
840 new(ctx) ir_dereference_variable(rhs_var);
841 ir_instruction *const inst =
842 new(ctx) ir_assignment(rhs_var_ref, first_param, NULL);
843 instructions->push_tail(inst);
844
845 const unsigned last_row = MIN2(src_matrix->type->vector_elements,
846 var->type->vector_elements);
847 const unsigned last_col = MIN2(src_matrix->type->matrix_columns,
848 var->type->matrix_columns);
849
850 unsigned swiz[4] = { 0, 0, 0, 0 };
851 for (unsigned i = 1; i < last_row; i++)
852 swiz[i] = i;
853
854 const unsigned write_mask = (1U << last_row) - 1;
855
856 for (unsigned i = 0; i < last_col; i++) {
857 ir_dereference *const lhs =
858 new(ctx) ir_dereference_array(var, new(ctx) ir_constant(i));
859 ir_rvalue *const rhs_col =
860 new(ctx) ir_dereference_array(rhs_var, new(ctx) ir_constant(i));
861
862 /* If one matrix has columns that are smaller than the columns of the
863 * other matrix, wrap the column access of the larger with a swizzle
864 * so that the LHS and RHS of the assignment have the same size (and
865 * therefore have the same type).
866 *
867 * It would be perfectly valid to unconditionally generate the
868 * swizzles, this this will typically result in a more compact IR tree.
869 */
870 ir_rvalue *rhs;
871 if (lhs->type->vector_elements != rhs_col->type->vector_elements) {
872 rhs = new(ctx) ir_swizzle(rhs_col, swiz, last_row);
873 } else {
874 rhs = rhs_col;
875 }
876
877 ir_instruction *inst =
878 new(ctx) ir_assignment(lhs, rhs, NULL, write_mask);
879 instructions->push_tail(inst);
880 }
881 } else {
882 const unsigned cols = type->matrix_columns;
883 const unsigned rows = type->vector_elements;
884 unsigned col_idx = 0;
885 unsigned row_idx = 0;
886
887 foreach_list (node, parameters) {
888 ir_rvalue *const rhs = (ir_rvalue *) node;
889 const unsigned components_remaining_this_column = rows - row_idx;
890 unsigned rhs_components = rhs->type->components();
891 unsigned rhs_base = 0;
892
893 /* Since the parameter might be used in the RHS of two assignments,
894 * generate a temporary and copy the paramter there.
895 */
896 ir_variable *rhs_var =
897 new(ctx) ir_variable(rhs->type, "mat_ctor_vec", ir_var_temporary);
898 instructions->push_tail(rhs_var);
899
900 ir_dereference *rhs_var_ref =
901 new(ctx) ir_dereference_variable(rhs_var);
902 ir_instruction *inst = new(ctx) ir_assignment(rhs_var_ref, rhs, NULL);
903 instructions->push_tail(inst);
904
905 /* Assign the current parameter to as many components of the matrix
906 * as it will fill.
907 *
908 * NOTE: A single vector parameter can span two matrix columns. A
909 * single vec4, for example, can completely fill a mat2.
910 */
911 if (rhs_components >= components_remaining_this_column) {
912 const unsigned count = MIN2(rhs_components,
913 components_remaining_this_column);
914
915 rhs_var_ref = new(ctx) ir_dereference_variable(rhs_var);
916
917 ir_instruction *inst = assign_to_matrix_column(var, col_idx,
918 row_idx,
919 rhs_var_ref, 0,
920 count, ctx);
921 instructions->push_tail(inst);
922
923 rhs_base = count;
924
925 col_idx++;
926 row_idx = 0;
927 }
928
929 /* If there is data left in the parameter and components left to be
930 * set in the destination, emit another assignment. It is possible
931 * that the assignment could be of a vec4 to the last element of the
932 * matrix. In this case col_idx==cols, but there is still data
933 * left in the source parameter. Obviously, don't emit an assignment
934 * to data outside the destination matrix.
935 */
936 if ((col_idx < cols) && (rhs_base < rhs_components)) {
937 const unsigned count = rhs_components - rhs_base;
938
939 rhs_var_ref = new(ctx) ir_dereference_variable(rhs_var);
940
941 ir_instruction *inst = assign_to_matrix_column(var, col_idx,
942 row_idx,
943 rhs_var_ref,
944 rhs_base,
945 count, ctx);
946 instructions->push_tail(inst);
947
948 row_idx += count;
949 }
950 }
951 }
952
953 return new(ctx) ir_dereference_variable(var);
954 }
955
956
957 ir_rvalue *
958 emit_inline_record_constructor(const glsl_type *type,
959 exec_list *instructions,
960 exec_list *parameters,
961 void *mem_ctx)
962 {
963 ir_variable *const var =
964 new(mem_ctx) ir_variable(type, "record_ctor", ir_var_temporary);
965 ir_dereference_variable *const d = new(mem_ctx) ir_dereference_variable(var);
966
967 instructions->push_tail(var);
968
969 exec_node *node = parameters->head;
970 for (unsigned i = 0; i < type->length; i++) {
971 assert(!node->is_tail_sentinel());
972
973 ir_dereference *const lhs =
974 new(mem_ctx) ir_dereference_record(d->clone(mem_ctx, NULL),
975 type->fields.structure[i].name);
976
977 ir_rvalue *const rhs = ((ir_instruction *) node)->as_rvalue();
978 assert(rhs != NULL);
979
980 ir_instruction *const assign = new(mem_ctx) ir_assignment(lhs, rhs, NULL);
981
982 instructions->push_tail(assign);
983 node = node->next;
984 }
985
986 return d;
987 }
988
989
990 ir_rvalue *
991 ast_function_expression::hir(exec_list *instructions,
992 struct _mesa_glsl_parse_state *state)
993 {
994 void *ctx = state;
995 /* There are three sorts of function calls.
996 *
997 * 1. constructors - The first subexpression is an ast_type_specifier.
998 * 2. methods - Only the .length() method of array types.
999 * 3. functions - Calls to regular old functions.
1000 *
1001 * Method calls are actually detected when the ast_field_selection
1002 * expression is handled.
1003 */
1004 if (is_constructor()) {
1005 const ast_type_specifier *type = (ast_type_specifier *) subexpressions[0];
1006 YYLTYPE loc = type->get_location();
1007 const char *name;
1008
1009 const glsl_type *const constructor_type = type->glsl_type(& name, state);
1010
1011
1012 /* Constructors for samplers are illegal.
1013 */
1014 if (constructor_type->is_sampler()) {
1015 _mesa_glsl_error(& loc, state, "cannot construct sampler type `%s'",
1016 constructor_type->name);
1017 return ir_call::get_error_instruction(ctx);
1018 }
1019
1020 if (constructor_type->is_array()) {
1021 if (state->language_version <= 110) {
1022 _mesa_glsl_error(& loc, state,
1023 "array constructors forbidden in GLSL 1.10");
1024 return ir_call::get_error_instruction(ctx);
1025 }
1026
1027 return process_array_constructor(instructions, constructor_type,
1028 & loc, &this->expressions, state);
1029 }
1030
1031
1032 /* There are two kinds of constructor call. Constructors for built-in
1033 * language types, such as mat4 and vec2, are free form. The only
1034 * requirement is that the parameters must provide enough values of the
1035 * correct scalar type. Constructors for arrays and structures must
1036 * have the exact number of parameters with matching types in the
1037 * correct order. These constructors follow essentially the same type
1038 * matching rules as functions.
1039 */
1040 if (!constructor_type->is_numeric() && !constructor_type->is_boolean())
1041 return ir_call::get_error_instruction(ctx);
1042
1043 /* Total number of components of the type being constructed. */
1044 const unsigned type_components = constructor_type->components();
1045
1046 /* Number of components from parameters that have actually been
1047 * consumed. This is used to perform several kinds of error checking.
1048 */
1049 unsigned components_used = 0;
1050
1051 unsigned matrix_parameters = 0;
1052 unsigned nonmatrix_parameters = 0;
1053 exec_list actual_parameters;
1054
1055 foreach_list (n, &this->expressions) {
1056 ast_node *ast = exec_node_data(ast_node, n, link);
1057 ir_rvalue *result = ast->hir(instructions, state)->as_rvalue();
1058
1059 /* From page 50 (page 56 of the PDF) of the GLSL 1.50 spec:
1060 *
1061 * "It is an error to provide extra arguments beyond this
1062 * last used argument."
1063 */
1064 if (components_used >= type_components) {
1065 _mesa_glsl_error(& loc, state, "too many parameters to `%s' "
1066 "constructor",
1067 constructor_type->name);
1068 return ir_call::get_error_instruction(ctx);
1069 }
1070
1071 if (!result->type->is_numeric() && !result->type->is_boolean()) {
1072 _mesa_glsl_error(& loc, state, "cannot construct `%s' from a "
1073 "non-numeric data type",
1074 constructor_type->name);
1075 return ir_call::get_error_instruction(ctx);
1076 }
1077
1078 /* Count the number of matrix and nonmatrix parameters. This
1079 * is used below to enforce some of the constructor rules.
1080 */
1081 if (result->type->is_matrix())
1082 matrix_parameters++;
1083 else
1084 nonmatrix_parameters++;
1085
1086 actual_parameters.push_tail(result);
1087 components_used += result->type->components();
1088 }
1089
1090 /* From page 28 (page 34 of the PDF) of the GLSL 1.10 spec:
1091 *
1092 * "It is an error to construct matrices from other matrices. This
1093 * is reserved for future use."
1094 */
1095 if (state->language_version == 110 && matrix_parameters > 0
1096 && constructor_type->is_matrix()) {
1097 _mesa_glsl_error(& loc, state, "cannot construct `%s' from a "
1098 "matrix in GLSL 1.10",
1099 constructor_type->name);
1100 return ir_call::get_error_instruction(ctx);
1101 }
1102
1103 /* From page 50 (page 56 of the PDF) of the GLSL 1.50 spec:
1104 *
1105 * "If a matrix argument is given to a matrix constructor, it is
1106 * an error to have any other arguments."
1107 */
1108 if ((matrix_parameters > 0)
1109 && ((matrix_parameters + nonmatrix_parameters) > 1)
1110 && constructor_type->is_matrix()) {
1111 _mesa_glsl_error(& loc, state, "for matrix `%s' constructor, "
1112 "matrix must be only parameter",
1113 constructor_type->name);
1114 return ir_call::get_error_instruction(ctx);
1115 }
1116
1117 /* From page 28 (page 34 of the PDF) of the GLSL 1.10 spec:
1118 *
1119 * "In these cases, there must be enough components provided in the
1120 * arguments to provide an initializer for every component in the
1121 * constructed value."
1122 */
1123 if (components_used < type_components && components_used != 1
1124 && matrix_parameters == 0) {
1125 _mesa_glsl_error(& loc, state, "too few components to construct "
1126 "`%s'",
1127 constructor_type->name);
1128 return ir_call::get_error_instruction(ctx);
1129 }
1130
1131 /* Later, we cast each parameter to the same base type as the
1132 * constructor. Since there are no non-floating point matrices, we
1133 * need to break them up into a series of column vectors.
1134 */
1135 if (constructor_type->base_type != GLSL_TYPE_FLOAT) {
1136 foreach_list_safe(n, &actual_parameters) {
1137 ir_rvalue *matrix = (ir_rvalue *) n;
1138
1139 if (!matrix->type->is_matrix())
1140 continue;
1141
1142 /* Create a temporary containing the matrix. */
1143 ir_variable *var = new(ctx) ir_variable(matrix->type, "matrix_tmp",
1144 ir_var_temporary);
1145 instructions->push_tail(var);
1146 instructions->push_tail(new(ctx) ir_assignment(new(ctx)
1147 ir_dereference_variable(var), matrix, NULL));
1148 var->constant_value = matrix->constant_expression_value();
1149
1150 /* Replace the matrix with dereferences of its columns. */
1151 for (int i = 0; i < matrix->type->matrix_columns; i++) {
1152 matrix->insert_before(new (ctx) ir_dereference_array(var,
1153 new(ctx) ir_constant(i)));
1154 }
1155 matrix->remove();
1156 }
1157 }
1158
1159 bool all_parameters_are_constant = true;
1160
1161 /* Type cast each parameter and, if possible, fold constants.*/
1162 foreach_list_safe(n, &actual_parameters) {
1163 ir_rvalue *ir = (ir_rvalue *) n;
1164
1165 const glsl_type *desired_type =
1166 glsl_type::get_instance(constructor_type->base_type,
1167 ir->type->vector_elements,
1168 ir->type->matrix_columns);
1169 ir_rvalue *result = convert_component(ir, desired_type);
1170
1171 /* Attempt to convert the parameter to a constant valued expression.
1172 * After doing so, track whether or not all the parameters to the
1173 * constructor are trivially constant valued expressions.
1174 */
1175 ir_rvalue *const constant = result->constant_expression_value();
1176
1177 if (constant != NULL)
1178 result = constant;
1179 else
1180 all_parameters_are_constant = false;
1181
1182 if (result != ir) {
1183 ir->replace_with(result);
1184 }
1185 }
1186
1187 /* If all of the parameters are trivially constant, create a
1188 * constant representing the complete collection of parameters.
1189 */
1190 if (all_parameters_are_constant) {
1191 return new(ctx) ir_constant(constructor_type, &actual_parameters);
1192 } else if (constructor_type->is_scalar()) {
1193 return dereference_component((ir_rvalue *) actual_parameters.head,
1194 0);
1195 } else if (constructor_type->is_vector()) {
1196 return emit_inline_vector_constructor(constructor_type,
1197 instructions,
1198 &actual_parameters,
1199 ctx);
1200 } else {
1201 assert(constructor_type->is_matrix());
1202 return emit_inline_matrix_constructor(constructor_type,
1203 instructions,
1204 &actual_parameters,
1205 ctx);
1206 }
1207 } else {
1208 const ast_expression *id = subexpressions[0];
1209 YYLTYPE loc = id->get_location();
1210 exec_list actual_parameters;
1211
1212 process_parameters(instructions, &actual_parameters, &this->expressions,
1213 state);
1214
1215 const glsl_type *const type =
1216 state->symbols->get_type(id->primary_expression.identifier);
1217
1218 if ((type != NULL) && type->is_record()) {
1219 exec_node *node = actual_parameters.head;
1220 for (unsigned i = 0; i < type->length; i++) {
1221 ir_rvalue *ir = (ir_rvalue *) node;
1222
1223 if (node->is_tail_sentinel()) {
1224 _mesa_glsl_error(&loc, state,
1225 "insufficient parameters to constructor "
1226 "for `%s'",
1227 type->name);
1228 return ir_call::get_error_instruction(ctx);
1229 }
1230
1231 if (apply_implicit_conversion(type->fields.structure[i].type, ir,
1232 state)) {
1233 node->replace_with(ir);
1234 } else {
1235 _mesa_glsl_error(&loc, state,
1236 "parameter type mismatch in constructor "
1237 "for `%s.%s' (%s vs %s)",
1238 type->name,
1239 type->fields.structure[i].name,
1240 ir->type->name,
1241 type->fields.structure[i].type->name);
1242 return ir_call::get_error_instruction(ctx);;
1243 }
1244
1245 node = node->next;
1246 }
1247
1248 if (!node->is_tail_sentinel()) {
1249 _mesa_glsl_error(&loc, state, "too many parameters in constructor "
1250 "for `%s'", type->name);
1251 return ir_call::get_error_instruction(ctx);
1252 }
1253
1254 ir_rvalue *const constant =
1255 constant_record_constructor(type, &actual_parameters, state);
1256
1257 return (constant != NULL)
1258 ? constant
1259 : emit_inline_record_constructor(type, instructions,
1260 &actual_parameters, state);
1261 }
1262
1263 return match_function_by_name(instructions,
1264 id->primary_expression.identifier, & loc,
1265 &actual_parameters, state);
1266 }
1267
1268 return ir_call::get_error_instruction(ctx);
1269 }