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.
25 * \file ir_constant_expression.cpp
26 * Evaluate and process constant valued expressions
28 * In GLSL, constant valued expressions are used in several places. These
29 * must be processed and evaluated very early in the compilation process.
32 * * Initializers for uniforms
33 * * Initializers for \c const variables
38 #include "ir_visitor.h"
39 #include "glsl_types.h"
42 * Visitor class for evaluating constant expressions
44 class ir_constant_visitor
: public ir_visitor
{
52 virtual ~ir_constant_visitor()
60 * As typical for the visitor pattern, there must be one \c visit method for
61 * each concrete subclass of \c ir_instruction. Virtual base classes within
62 * the hierarchy should not have \c visit methods.
65 virtual void visit(ir_variable
*);
66 virtual void visit(ir_function_signature
*);
67 virtual void visit(ir_function
*);
68 virtual void visit(ir_expression
*);
69 virtual void visit(ir_texture
*);
70 virtual void visit(ir_swizzle
*);
71 virtual void visit(ir_dereference_variable
*);
72 virtual void visit(ir_dereference_array
*);
73 virtual void visit(ir_dereference_record
*);
74 virtual void visit(ir_assignment
*);
75 virtual void visit(ir_constant
*);
76 virtual void visit(ir_call
*);
77 virtual void visit(ir_return
*);
78 virtual void visit(ir_discard
*);
79 virtual void visit(ir_if
*);
80 virtual void visit(ir_loop
*);
81 virtual void visit(ir_loop_jump
*);
85 * Value of the constant expression.
88 * This field will be \c NULL if the expression is not constant valued.
90 /* FINIHSME: This cannot hold values for constant arrays or structures. */
96 ir_instruction::constant_expression_value()
98 ir_constant_visitor visitor
;
100 this->accept(& visitor
);
101 return visitor
.value
;
106 ir_constant_visitor::visit(ir_variable
*ir
)
114 ir_constant_visitor::visit(ir_function_signature
*ir
)
122 ir_constant_visitor::visit(ir_function
*ir
)
129 ir_constant_visitor::visit(ir_expression
*ir
)
132 ir_constant
*op
[2] = { NULL
, NULL
};
133 ir_constant_data data
;
135 memset(&data
, 0, sizeof(data
));
137 for (unsigned operand
= 0; operand
< ir
->get_num_operands(); operand
++) {
138 op
[operand
] = ir
->operands
[operand
]->constant_expression_value();
144 assert(op
[0]->type
->base_type
== op
[1]->type
->base_type
);
146 bool op0_scalar
= op
[0]->type
->is_scalar();
147 bool op1_scalar
= op
[1] != NULL
&& op
[1]->type
->is_scalar();
149 /* When iterating over a vector or matrix's components, we want to increase
150 * the loop counter. However, for scalars, we want to stay at 0.
152 unsigned c0_inc
= op0_scalar
? 0 : 1;
153 unsigned c1_inc
= op1_scalar
? 0 : 1;
155 if (op1_scalar
|| !op
[1]) {
156 components
= op
[0]->type
->components();
158 components
= op
[1]->type
->components();
161 switch (ir
->operation
) {
162 case ir_unop_logic_not
:
163 assert(op
[0]->type
->base_type
== GLSL_TYPE_BOOL
);
164 for (unsigned c
= 0; c
< ir
->operands
[0]->type
->components(); c
++)
165 data
.b
[c
] = !op
[0]->value
.b
[c
];
169 assert(op
[0]->type
->base_type
== GLSL_TYPE_FLOAT
);
170 for (unsigned c
= 0; c
< ir
->operands
[0]->type
->components(); c
++) {
171 data
.i
[c
] = op
[0]->value
.f
[c
];
175 assert(op
[0]->type
->base_type
== GLSL_TYPE_UINT
||
176 op
[0]->type
->base_type
== GLSL_TYPE_INT
);
177 for (unsigned c
= 0; c
< ir
->operands
[0]->type
->components(); c
++) {
178 if (op
[0]->type
->base_type
== GLSL_TYPE_INT
)
179 data
.f
[c
] = op
[0]->value
.i
[c
];
181 data
.f
[c
] = op
[0]->value
.u
[c
];
185 assert(op
[0]->type
->base_type
== GLSL_TYPE_BOOL
);
186 for (unsigned c
= 0; c
< ir
->operands
[0]->type
->components(); c
++) {
187 data
.f
[c
] = op
[0]->value
.b
[c
] ? 1.0 : 0.0;
191 assert(op
[0]->type
->base_type
== GLSL_TYPE_FLOAT
);
192 for (unsigned c
= 0; c
< ir
->operands
[0]->type
->components(); c
++) {
193 data
.b
[c
] = bool(op
[0]->value
.f
[c
]);
197 assert(op
[0]->type
->base_type
== GLSL_TYPE_BOOL
);
198 for (unsigned c
= 0; c
< ir
->operands
[0]->type
->components(); c
++) {
199 data
.u
[c
] = op
[0]->value
.b
[c
] ? 1 : 0;
203 assert(op
[0]->type
->is_integer());
204 for (unsigned c
= 0; c
< ir
->operands
[0]->type
->components(); c
++) {
205 data
.b
[c
] = bool(op
[0]->value
.u
[c
]);
210 assert(op
[0]->type
->base_type
== GLSL_TYPE_FLOAT
);
211 for (unsigned c
= 0; c
< ir
->operands
[0]->type
->components(); c
++) {
212 data
.f
[c
] = truncf(op
[0]->value
.f
[c
]);
217 assert(op
[0]->type
->base_type
== GLSL_TYPE_FLOAT
);
218 for (unsigned c
= 0; c
< ir
->operands
[0]->type
->components(); c
++) {
219 data
.f
[c
] = ceilf(op
[0]->value
.f
[c
]);
224 assert(op
[0]->type
->base_type
== GLSL_TYPE_FLOAT
);
225 for (unsigned c
= 0; c
< ir
->operands
[0]->type
->components(); c
++) {
226 data
.f
[c
] = floorf(op
[0]->value
.f
[c
]);
231 for (unsigned c
= 0; c
< ir
->operands
[0]->type
->components(); c
++) {
232 switch (ir
->type
->base_type
) {
239 case GLSL_TYPE_FLOAT
:
240 data
.f
[c
] = op
[0]->value
.f
[c
] - floor(op
[0]->value
.f
[c
]);
249 for (unsigned c
= 0; c
< ir
->operands
[0]->type
->components(); c
++) {
250 switch (ir
->type
->base_type
) {
252 data
.u
[c
] = -op
[0]->value
.u
[c
];
255 data
.i
[c
] = -op
[0]->value
.i
[c
];
257 case GLSL_TYPE_FLOAT
:
258 data
.f
[c
] = -op
[0]->value
.f
[c
];
267 for (unsigned c
= 0; c
< ir
->operands
[0]->type
->components(); c
++) {
268 switch (ir
->type
->base_type
) {
270 data
.u
[c
] = op
[0]->value
.u
[c
];
273 data
.i
[c
] = op
[0]->value
.i
[c
];
275 data
.i
[c
] = -data
.i
[c
];
277 case GLSL_TYPE_FLOAT
:
278 data
.f
[c
] = fabs(op
[0]->value
.f
[c
]);
287 for (unsigned c
= 0; c
< ir
->operands
[0]->type
->components(); c
++) {
288 switch (ir
->type
->base_type
) {
290 data
.u
[c
] = op
[0]->value
.i
[c
] > 0;
293 data
.i
[c
] = (op
[0]->value
.i
[c
] > 0) - (op
[0]->value
.i
[c
] < 0);
295 case GLSL_TYPE_FLOAT
:
296 data
.f
[c
] = float((op
[0]->value
.f
[c
] > 0)-(op
[0]->value
.f
[c
] < 0));
305 assert(op
[0]->type
->base_type
== GLSL_TYPE_FLOAT
);
306 for (unsigned c
= 0; c
< ir
->operands
[0]->type
->components(); c
++) {
307 switch (ir
->type
->base_type
) {
309 if (op
[0]->value
.u
[c
] != 0.0)
310 data
.u
[c
] = 1 / op
[0]->value
.u
[c
];
313 if (op
[0]->value
.i
[c
] != 0.0)
314 data
.i
[c
] = 1 / op
[0]->value
.i
[c
];
316 case GLSL_TYPE_FLOAT
:
317 if (op
[0]->value
.f
[c
] != 0.0)
318 data
.f
[c
] = 1.0 / op
[0]->value
.f
[c
];
327 assert(op
[0]->type
->base_type
== GLSL_TYPE_FLOAT
);
328 for (unsigned c
= 0; c
< ir
->operands
[0]->type
->components(); c
++) {
329 data
.f
[c
] = 1.0 / sqrtf(op
[0]->value
.f
[c
]);
334 assert(op
[0]->type
->base_type
== GLSL_TYPE_FLOAT
);
335 for (unsigned c
= 0; c
< ir
->operands
[0]->type
->components(); c
++) {
336 data
.f
[c
] = sqrtf(op
[0]->value
.f
[c
]);
341 assert(op
[0]->type
->base_type
== GLSL_TYPE_FLOAT
);
342 for (unsigned c
= 0; c
< ir
->operands
[0]->type
->components(); c
++) {
343 data
.f
[c
] = expf(op
[0]->value
.f
[c
]);
348 assert(op
[0]->type
->base_type
== GLSL_TYPE_FLOAT
);
349 for (unsigned c
= 0; c
< ir
->operands
[0]->type
->components(); c
++) {
350 data
.f
[c
] = exp2f(op
[0]->value
.f
[c
]);
355 assert(op
[0]->type
->base_type
== GLSL_TYPE_FLOAT
);
356 for (unsigned c
= 0; c
< ir
->operands
[0]->type
->components(); c
++) {
357 data
.f
[c
] = logf(op
[0]->value
.f
[c
]);
362 assert(op
[0]->type
->base_type
== GLSL_TYPE_FLOAT
);
363 for (unsigned c
= 0; c
< ir
->operands
[0]->type
->components(); c
++) {
364 data
.f
[c
] = log2f(op
[0]->value
.f
[c
]);
370 assert(op
[0]->type
->base_type
== GLSL_TYPE_FLOAT
);
371 for (unsigned c
= 0; c
< ir
->operands
[0]->type
->components(); c
++) {
377 assert(op
[0]->type
->is_vector() && op
[1]->type
->is_vector());
379 for (unsigned c
= 0; c
< op
[0]->type
->components(); c
++) {
380 switch (ir
->operands
[0]->type
->base_type
) {
382 data
.u
[0] += op
[0]->value
.u
[c
] * op
[1]->value
.u
[c
];
385 data
.i
[0] += op
[0]->value
.i
[c
] * op
[1]->value
.i
[c
];
387 case GLSL_TYPE_FLOAT
:
388 data
.f
[0] += op
[0]->value
.f
[c
] * op
[1]->value
.f
[c
];
397 assert(op
[0]->type
== op
[1]->type
|| op0_scalar
|| op1_scalar
);
398 for (unsigned c
= 0, c0
= 0, c1
= 0;
400 c0
+= c0_inc
, c1
+= c1_inc
, c
++) {
402 switch (ir
->operands
[0]->type
->base_type
) {
404 data
.u
[c
] = op
[0]->value
.u
[c0
] + op
[1]->value
.u
[c1
];
407 data
.i
[c
] = op
[0]->value
.i
[c0
] + op
[1]->value
.i
[c1
];
409 case GLSL_TYPE_FLOAT
:
410 data
.f
[c
] = op
[0]->value
.f
[c0
] + op
[1]->value
.f
[c1
];
419 assert(op
[0]->type
== op
[1]->type
|| op0_scalar
|| op1_scalar
);
420 for (unsigned c
= 0, c0
= 0, c1
= 0;
422 c0
+= c0_inc
, c1
+= c1_inc
, c
++) {
424 switch (ir
->operands
[0]->type
->base_type
) {
426 data
.u
[c
] = op
[0]->value
.u
[c0
] - op
[1]->value
.u
[c1
];
429 data
.i
[c
] = op
[0]->value
.i
[c0
] - op
[1]->value
.i
[c1
];
431 case GLSL_TYPE_FLOAT
:
432 data
.f
[c
] = op
[0]->value
.f
[c0
] - op
[1]->value
.f
[c1
];
441 /* Check for equal types, or unequal types involving scalars */
442 if ((op
[0]->type
== op
[1]->type
&& !op
[0]->type
->is_matrix())
443 || op0_scalar
|| op1_scalar
) {
444 for (unsigned c
= 0, c0
= 0, c1
= 0;
446 c0
+= c0_inc
, c1
+= c1_inc
, c
++) {
448 switch (ir
->operands
[0]->type
->base_type
) {
450 data
.u
[c
] = op
[0]->value
.u
[c0
] * op
[1]->value
.u
[c1
];
453 data
.i
[c
] = op
[0]->value
.i
[c0
] * op
[1]->value
.i
[c1
];
455 case GLSL_TYPE_FLOAT
:
456 data
.f
[c
] = op
[0]->value
.f
[c0
] * op
[1]->value
.f
[c1
];
463 assert(op
[0]->type
->is_matrix() || op
[1]->type
->is_matrix());
465 /* Multiply an N-by-M matrix with an M-by-P matrix. Since either
466 * matrix can be a GLSL vector, either N or P can be 1.
468 * For vec*mat, the vector is treated as a row vector. This
469 * means the vector is a 1-row x M-column matrix.
471 * For mat*vec, the vector is treated as a column vector. Since
472 * matrix_columns is 1 for vectors, this just works.
474 const unsigned n
= op
[0]->type
->is_vector()
475 ? 1 : op
[0]->type
->vector_elements
;
476 const unsigned m
= op
[1]->type
->vector_elements
;
477 const unsigned p
= op
[1]->type
->matrix_columns
;
478 for (unsigned j
= 0; j
< p
; j
++) {
479 for (unsigned i
= 0; i
< n
; i
++) {
480 for (unsigned k
= 0; k
< m
; k
++) {
481 data
.f
[i
+n
*j
] += op
[0]->value
.f
[i
+n
*k
]*op
[1]->value
.f
[k
+m
*j
];
489 assert(op
[0]->type
== op
[1]->type
|| op0_scalar
|| op1_scalar
);
490 for (unsigned c
= 0, c0
= 0, c1
= 0;
492 c0
+= c0_inc
, c1
+= c1_inc
, c
++) {
494 switch (ir
->operands
[0]->type
->base_type
) {
496 data
.u
[c
] = op
[0]->value
.u
[c0
] / op
[1]->value
.u
[c1
];
499 data
.i
[c
] = op
[0]->value
.i
[c0
] / op
[1]->value
.i
[c1
];
501 case GLSL_TYPE_FLOAT
:
502 data
.f
[c
] = op
[0]->value
.f
[c0
] / op
[1]->value
.f
[c1
];
510 case ir_binop_logic_and
:
511 assert(op
[0]->type
->base_type
== GLSL_TYPE_BOOL
);
512 for (unsigned c
= 0; c
< ir
->operands
[0]->type
->components(); c
++)
513 data
.b
[c
] = op
[0]->value
.b
[c
] && op
[1]->value
.b
[c
];
515 case ir_binop_logic_xor
:
516 assert(op
[0]->type
->base_type
== GLSL_TYPE_BOOL
);
517 for (unsigned c
= 0; c
< ir
->operands
[0]->type
->components(); c
++)
518 data
.b
[c
] = op
[0]->value
.b
[c
] ^ op
[1]->value
.b
[c
];
520 case ir_binop_logic_or
:
521 assert(op
[0]->type
->base_type
== GLSL_TYPE_BOOL
);
522 for (unsigned c
= 0; c
< ir
->operands
[0]->type
->components(); c
++)
523 data
.b
[c
] = op
[0]->value
.b
[c
] || op
[1]->value
.b
[c
];
527 switch (ir
->operands
[0]->type
->base_type
) {
529 data
.b
[0] = op
[0]->value
.u
[0] < op
[1]->value
.u
[0];
532 data
.b
[0] = op
[0]->value
.i
[0] < op
[1]->value
.i
[0];
534 case GLSL_TYPE_FLOAT
:
535 data
.b
[0] = op
[0]->value
.f
[0] < op
[1]->value
.f
[0];
541 case ir_binop_greater
:
542 switch (ir
->operands
[0]->type
->base_type
) {
544 data
.b
[0] = op
[0]->value
.u
[0] > op
[1]->value
.u
[0];
547 data
.b
[0] = op
[0]->value
.i
[0] > op
[1]->value
.i
[0];
549 case GLSL_TYPE_FLOAT
:
550 data
.b
[0] = op
[0]->value
.f
[0] > op
[1]->value
.f
[0];
556 case ir_binop_lequal
:
557 switch (ir
->operands
[0]->type
->base_type
) {
559 data
.b
[0] = op
[0]->value
.u
[0] <= op
[1]->value
.u
[0];
562 data
.b
[0] = op
[0]->value
.i
[0] <= op
[1]->value
.i
[0];
564 case GLSL_TYPE_FLOAT
:
565 data
.b
[0] = op
[0]->value
.f
[0] <= op
[1]->value
.f
[0];
571 case ir_binop_gequal
:
572 switch (ir
->operands
[0]->type
->base_type
) {
574 data
.b
[0] = op
[0]->value
.u
[0] >= op
[1]->value
.u
[0];
577 data
.b
[0] = op
[0]->value
.i
[0] >= op
[1]->value
.i
[0];
579 case GLSL_TYPE_FLOAT
:
580 data
.b
[0] = op
[0]->value
.f
[0] >= op
[1]->value
.f
[0];
589 for (unsigned c
= 0; c
< ir
->operands
[0]->type
->components(); c
++) {
590 switch (ir
->operands
[0]->type
->base_type
) {
592 data
.b
[0] = data
.b
[0] && op
[0]->value
.u
[c
] == op
[1]->value
.u
[c
];
595 data
.b
[0] = data
.b
[0] && op
[0]->value
.i
[c
] == op
[1]->value
.i
[c
];
597 case GLSL_TYPE_FLOAT
:
598 data
.b
[0] = data
.b
[0] && op
[0]->value
.f
[c
] == op
[1]->value
.f
[c
];
601 data
.b
[0] = data
.b
[0] && op
[0]->value
.b
[c
] == op
[1]->value
.b
[c
];
608 case ir_binop_nequal
:
610 for (unsigned c
= 0; c
< ir
->operands
[0]->type
->components(); c
++) {
611 switch (ir
->operands
[0]->type
->base_type
) {
613 data
.b
[0] = data
.b
[0] || op
[0]->value
.u
[c
] != op
[1]->value
.u
[c
];
616 data
.b
[0] = data
.b
[0] || op
[0]->value
.i
[c
] != op
[1]->value
.i
[c
];
618 case GLSL_TYPE_FLOAT
:
619 data
.b
[0] = data
.b
[0] || op
[0]->value
.f
[c
] != op
[1]->value
.f
[c
];
622 data
.b
[0] = data
.b
[0] || op
[0]->value
.b
[c
] != op
[1]->value
.b
[c
];
631 /* FINISHME: Should handle all expression types. */
635 void *ctx
= talloc_parent(ir
);
636 this->value
= new(ctx
) ir_constant(ir
->type
, &data
);
641 ir_constant_visitor::visit(ir_texture
*ir
)
643 // FINISHME: Do stuff with texture lookups
650 ir_constant_visitor::visit(ir_swizzle
*ir
)
652 ir_constant
*v
= ir
->val
->constant_expression_value();
657 ir_constant_data data
;
659 const unsigned swiz_idx
[4] = {
660 ir
->mask
.x
, ir
->mask
.y
, ir
->mask
.z
, ir
->mask
.w
663 for (unsigned i
= 0; i
< ir
->mask
.num_components
; i
++) {
664 switch (v
->type
->base_type
) {
666 case GLSL_TYPE_INT
: data
.u
[i
] = v
->value
.u
[swiz_idx
[i
]]; break;
667 case GLSL_TYPE_FLOAT
: data
.f
[i
] = v
->value
.f
[swiz_idx
[i
]]; break;
668 case GLSL_TYPE_BOOL
: data
.b
[i
] = v
->value
.b
[swiz_idx
[i
]]; break;
669 default: assert(!"Should not get here."); break;
673 void *ctx
= talloc_parent(ir
);
674 this->value
= new(ctx
) ir_constant(ir
->type
, &data
);
680 ir_constant_visitor::visit(ir_dereference_variable
*ir
)
684 ir_variable
*var
= ir
->variable_referenced();
685 if (var
&& var
->constant_value
)
686 value
= var
->constant_value
->clone(NULL
);
691 ir_constant_visitor::visit(ir_dereference_array
*ir
)
693 void *ctx
= talloc_parent(ir
);
694 ir_constant
*array
= ir
->array
->constant_expression_value();
695 ir_constant
*idx
= ir
->array_index
->constant_expression_value();
699 if ((array
!= NULL
) && (idx
!= NULL
)) {
700 if (array
->type
->is_matrix()) {
701 /* Array access of a matrix results in a vector.
703 const unsigned column
= idx
->value
.u
[0];
705 const glsl_type
*const column_type
= array
->type
->column_type();
707 /* Offset in the constant matrix to the first element of the column
710 const unsigned mat_idx
= column
* column_type
->vector_elements
;
712 ir_constant_data data
;
714 switch (column_type
->base_type
) {
717 for (unsigned i
= 0; i
< column_type
->vector_elements
; i
++)
718 data
.u
[i
] = array
->value
.u
[mat_idx
+ i
];
722 case GLSL_TYPE_FLOAT
:
723 for (unsigned i
= 0; i
< column_type
->vector_elements
; i
++)
724 data
.f
[i
] = array
->value
.f
[mat_idx
+ i
];
729 assert(!"Should not get here.");
733 this->value
= new(ctx
) ir_constant(column_type
, &data
);
734 } else if (array
->type
->is_vector()) {
735 const unsigned component
= idx
->value
.u
[0];
737 this->value
= new(ctx
) ir_constant(array
, component
);
739 /* FINISHME: Handle access of constant arrays. */
746 ir_constant_visitor::visit(ir_dereference_record
*ir
)
748 ir_constant
*v
= ir
->record
->constant_expression_value();
750 this->value
= (v
!= NULL
) ? v
->get_record_field(ir
->field
) : NULL
;
755 ir_constant_visitor::visit(ir_assignment
*ir
)
763 ir_constant_visitor::visit(ir_constant
*ir
)
770 ir_constant_visitor::visit(ir_call
*ir
)
778 ir_constant_visitor::visit(ir_return
*ir
)
786 ir_constant_visitor::visit(ir_discard
*ir
)
794 ir_constant_visitor::visit(ir_if
*ir
)
802 ir_constant_visitor::visit(ir_loop
*ir
)
810 ir_constant_visitor::visit(ir_loop_jump
*ir
)