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 for (unsigned c
= 0; c
< ir
->operands
[0]->type
->components(); c
++) {
211 switch (ir
->type
->base_type
) {
218 case GLSL_TYPE_FLOAT
:
219 data
.f
[c
] = op
[0]->value
.f
[c
] - floor(op
[0]->value
.f
[c
]);
228 for (unsigned c
= 0; c
< ir
->operands
[0]->type
->components(); c
++) {
229 switch (ir
->type
->base_type
) {
231 data
.u
[c
] = -op
[0]->value
.u
[c
];
234 data
.i
[c
] = -op
[0]->value
.i
[c
];
236 case GLSL_TYPE_FLOAT
:
237 data
.f
[c
] = -op
[0]->value
.f
[c
];
246 for (unsigned c
= 0; c
< ir
->operands
[0]->type
->components(); c
++) {
247 switch (ir
->type
->base_type
) {
249 data
.u
[c
] = op
[0]->value
.u
[c
];
252 data
.i
[c
] = op
[0]->value
.i
[c
];
254 data
.i
[c
] = -data
.i
[c
];
256 case GLSL_TYPE_FLOAT
:
257 data
.f
[c
] = fabs(op
[0]->value
.f
[c
]);
266 for (unsigned c
= 0; c
< ir
->operands
[0]->type
->components(); c
++) {
267 switch (ir
->type
->base_type
) {
269 data
.u
[c
] = op
[0]->value
.i
[c
] > 0;
272 data
.i
[c
] = (op
[0]->value
.i
[c
] > 0) - (op
[0]->value
.i
[c
] < 0);
274 case GLSL_TYPE_FLOAT
:
275 data
.f
[c
] = float((op
[0]->value
.f
[c
] > 0)-(op
[0]->value
.f
[c
] < 0));
284 assert(op
[0]->type
->base_type
== GLSL_TYPE_FLOAT
);
285 for (unsigned c
= 0; c
< ir
->operands
[0]->type
->components(); c
++) {
286 switch (ir
->type
->base_type
) {
288 if (op
[0]->value
.u
[c
] != 0.0)
289 data
.u
[c
] = 1 / op
[0]->value
.u
[c
];
292 if (op
[0]->value
.i
[c
] != 0.0)
293 data
.i
[c
] = 1 / op
[0]->value
.i
[c
];
295 case GLSL_TYPE_FLOAT
:
296 if (op
[0]->value
.f
[c
] != 0.0)
297 data
.f
[c
] = 1.0 / op
[0]->value
.f
[c
];
306 assert(op
[0]->type
->base_type
== GLSL_TYPE_FLOAT
);
307 for (unsigned c
= 0; c
< ir
->operands
[0]->type
->components(); c
++) {
308 data
.f
[c
] = 1.0 / sqrtf(op
[0]->value
.f
[c
]);
313 assert(op
[0]->type
->base_type
== GLSL_TYPE_FLOAT
);
314 for (unsigned c
= 0; c
< ir
->operands
[0]->type
->components(); c
++) {
315 data
.f
[c
] = sqrtf(op
[0]->value
.f
[c
]);
320 assert(op
[0]->type
->base_type
== GLSL_TYPE_FLOAT
);
321 for (unsigned c
= 0; c
< ir
->operands
[0]->type
->components(); c
++) {
322 data
.f
[c
] = expf(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
] = logf(op
[0]->value
.f
[c
]);
335 assert(op
[0]->type
->base_type
== GLSL_TYPE_FLOAT
);
336 for (unsigned c
= 0; c
< ir
->operands
[0]->type
->components(); c
++) {
342 assert(op
[0]->type
->is_vector() && op
[1]->type
->is_vector());
344 for (unsigned c
= 0; c
< op
[0]->type
->components(); c
++) {
345 switch (ir
->operands
[0]->type
->base_type
) {
347 data
.u
[0] += op
[0]->value
.u
[c
] * op
[1]->value
.u
[c
];
350 data
.i
[0] += op
[0]->value
.i
[c
] * op
[1]->value
.i
[c
];
352 case GLSL_TYPE_FLOAT
:
353 data
.f
[0] += op
[0]->value
.f
[c
] * op
[1]->value
.f
[c
];
362 assert(op
[0]->type
== op
[1]->type
|| op0_scalar
|| op1_scalar
);
363 for (unsigned c
= 0, c0
= 0, c1
= 0;
365 c0
+= c0_inc
, c1
+= c1_inc
, c
++) {
367 switch (ir
->operands
[0]->type
->base_type
) {
369 data
.u
[c
] = op
[0]->value
.u
[c0
] + op
[1]->value
.u
[c1
];
372 data
.i
[c
] = op
[0]->value
.i
[c0
] + op
[1]->value
.i
[c1
];
374 case GLSL_TYPE_FLOAT
:
375 data
.f
[c
] = op
[0]->value
.f
[c0
] + op
[1]->value
.f
[c1
];
384 assert(op
[0]->type
== op
[1]->type
|| op0_scalar
|| op1_scalar
);
385 for (unsigned c
= 0, c0
= 0, c1
= 0;
387 c0
+= c0_inc
, c1
+= c1_inc
, c
++) {
389 switch (ir
->operands
[0]->type
->base_type
) {
391 data
.u
[c
] = op
[0]->value
.u
[c0
] - op
[1]->value
.u
[c1
];
394 data
.i
[c
] = op
[0]->value
.i
[c0
] - op
[1]->value
.i
[c1
];
396 case GLSL_TYPE_FLOAT
:
397 data
.f
[c
] = op
[0]->value
.f
[c0
] - op
[1]->value
.f
[c1
];
406 /* Check for equal types, or unequal types involving scalars */
407 if ((op
[0]->type
== op
[1]->type
&& !op
[0]->type
->is_matrix())
408 || op0_scalar
|| op1_scalar
) {
409 for (unsigned c
= 0, c0
= 0, c1
= 0;
411 c0
+= c0_inc
, c1
+= c1_inc
, c
++) {
413 switch (ir
->operands
[0]->type
->base_type
) {
415 data
.u
[c
] = op
[0]->value
.u
[c0
] * op
[1]->value
.u
[c1
];
418 data
.i
[c
] = op
[0]->value
.i
[c0
] * op
[1]->value
.i
[c1
];
420 case GLSL_TYPE_FLOAT
:
421 data
.f
[c
] = op
[0]->value
.f
[c0
] * op
[1]->value
.f
[c1
];
428 assert(op
[0]->type
->is_matrix() || op
[1]->type
->is_matrix());
430 /* Multiply an N-by-M matrix with an M-by-P matrix. Since either
431 * matrix can be a GLSL vector, either N or P can be 1.
433 * For vec*mat, the vector is treated as a row vector. This
434 * means the vector is a 1-row x M-column matrix.
436 * For mat*vec, the vector is treated as a column vector. Since
437 * matrix_columns is 1 for vectors, this just works.
439 const unsigned n
= op
[0]->type
->is_vector()
440 ? 1 : op
[0]->type
->vector_elements
;
441 const unsigned m
= op
[1]->type
->vector_elements
;
442 const unsigned p
= op
[1]->type
->matrix_columns
;
443 for (unsigned j
= 0; j
< p
; j
++) {
444 for (unsigned i
= 0; i
< n
; i
++) {
445 for (unsigned k
= 0; k
< m
; k
++) {
446 data
.f
[i
+n
*j
] += op
[0]->value
.f
[i
+n
*k
]*op
[1]->value
.f
[k
+m
*j
];
454 assert(op
[0]->type
== op
[1]->type
|| op0_scalar
|| op1_scalar
);
455 for (unsigned c
= 0, c0
= 0, c1
= 0;
457 c0
+= c0_inc
, c1
+= c1_inc
, c
++) {
459 switch (ir
->operands
[0]->type
->base_type
) {
461 data
.u
[c
] = op
[0]->value
.u
[c0
] / op
[1]->value
.u
[c1
];
464 data
.i
[c
] = op
[0]->value
.i
[c0
] / op
[1]->value
.i
[c1
];
466 case GLSL_TYPE_FLOAT
:
467 data
.f
[c
] = op
[0]->value
.f
[c0
] / op
[1]->value
.f
[c1
];
475 case ir_binop_logic_and
:
476 assert(op
[0]->type
->base_type
== GLSL_TYPE_BOOL
);
477 for (unsigned c
= 0; c
< ir
->operands
[0]->type
->components(); c
++)
478 data
.b
[c
] = op
[0]->value
.b
[c
] && op
[1]->value
.b
[c
];
480 case ir_binop_logic_xor
:
481 assert(op
[0]->type
->base_type
== GLSL_TYPE_BOOL
);
482 for (unsigned c
= 0; c
< ir
->operands
[0]->type
->components(); c
++)
483 data
.b
[c
] = op
[0]->value
.b
[c
] ^ op
[1]->value
.b
[c
];
485 case ir_binop_logic_or
:
486 assert(op
[0]->type
->base_type
== GLSL_TYPE_BOOL
);
487 for (unsigned c
= 0; c
< ir
->operands
[0]->type
->components(); c
++)
488 data
.b
[c
] = op
[0]->value
.b
[c
] || op
[1]->value
.b
[c
];
492 switch (ir
->operands
[0]->type
->base_type
) {
494 data
.b
[0] = op
[0]->value
.u
[0] < op
[1]->value
.u
[0];
497 data
.b
[0] = op
[0]->value
.i
[0] < op
[1]->value
.i
[0];
499 case GLSL_TYPE_FLOAT
:
500 data
.b
[0] = op
[0]->value
.f
[0] < op
[1]->value
.f
[0];
506 case ir_binop_greater
:
507 switch (ir
->operands
[0]->type
->base_type
) {
509 data
.b
[0] = op
[0]->value
.u
[0] > op
[1]->value
.u
[0];
512 data
.b
[0] = op
[0]->value
.i
[0] > op
[1]->value
.i
[0];
514 case GLSL_TYPE_FLOAT
:
515 data
.b
[0] = op
[0]->value
.f
[0] > op
[1]->value
.f
[0];
521 case ir_binop_lequal
:
522 switch (ir
->operands
[0]->type
->base_type
) {
524 data
.b
[0] = op
[0]->value
.u
[0] <= op
[1]->value
.u
[0];
527 data
.b
[0] = op
[0]->value
.i
[0] <= op
[1]->value
.i
[0];
529 case GLSL_TYPE_FLOAT
:
530 data
.b
[0] = op
[0]->value
.f
[0] <= op
[1]->value
.f
[0];
536 case ir_binop_gequal
:
537 switch (ir
->operands
[0]->type
->base_type
) {
539 data
.b
[0] = op
[0]->value
.u
[0] >= op
[1]->value
.u
[0];
542 data
.b
[0] = op
[0]->value
.i
[0] >= op
[1]->value
.i
[0];
544 case GLSL_TYPE_FLOAT
:
545 data
.b
[0] = op
[0]->value
.f
[0] >= op
[1]->value
.f
[0];
554 for (unsigned c
= 0; c
< ir
->operands
[0]->type
->components(); c
++) {
555 switch (ir
->operands
[0]->type
->base_type
) {
557 data
.b
[0] = data
.b
[0] && op
[0]->value
.u
[c
] == op
[1]->value
.u
[c
];
560 data
.b
[0] = data
.b
[0] && op
[0]->value
.i
[c
] == op
[1]->value
.i
[c
];
562 case GLSL_TYPE_FLOAT
:
563 data
.b
[0] = data
.b
[0] && op
[0]->value
.f
[c
] == op
[1]->value
.f
[c
];
566 data
.b
[0] = data
.b
[0] && op
[0]->value
.b
[c
] == op
[1]->value
.b
[c
];
573 case ir_binop_nequal
:
575 for (unsigned c
= 0; c
< ir
->operands
[0]->type
->components(); c
++) {
576 switch (ir
->operands
[0]->type
->base_type
) {
578 data
.b
[0] = data
.b
[0] || op
[0]->value
.u
[c
] != op
[1]->value
.u
[c
];
581 data
.b
[0] = data
.b
[0] || op
[0]->value
.i
[c
] != op
[1]->value
.i
[c
];
583 case GLSL_TYPE_FLOAT
:
584 data
.b
[0] = data
.b
[0] || op
[0]->value
.f
[c
] != op
[1]->value
.f
[c
];
587 data
.b
[0] = data
.b
[0] || op
[0]->value
.b
[c
] != op
[1]->value
.b
[c
];
596 /* FINISHME: Should handle all expression types. */
600 void *ctx
= talloc_parent(ir
);
601 this->value
= new(ctx
) ir_constant(ir
->type
, &data
);
606 ir_constant_visitor::visit(ir_texture
*ir
)
608 // FINISHME: Do stuff with texture lookups
615 ir_constant_visitor::visit(ir_swizzle
*ir
)
617 ir_constant
*v
= ir
->val
->constant_expression_value();
622 ir_constant_data data
;
624 const unsigned swiz_idx
[4] = {
625 ir
->mask
.x
, ir
->mask
.y
, ir
->mask
.z
, ir
->mask
.w
628 for (unsigned i
= 0; i
< ir
->mask
.num_components
; i
++) {
629 switch (v
->type
->base_type
) {
631 case GLSL_TYPE_INT
: data
.u
[i
] = v
->value
.u
[swiz_idx
[i
]]; break;
632 case GLSL_TYPE_FLOAT
: data
.f
[i
] = v
->value
.f
[swiz_idx
[i
]]; break;
633 case GLSL_TYPE_BOOL
: data
.b
[i
] = v
->value
.b
[swiz_idx
[i
]]; break;
634 default: assert(!"Should not get here."); break;
638 void *ctx
= talloc_parent(ir
);
639 this->value
= new(ctx
) ir_constant(ir
->type
, &data
);
645 ir_constant_visitor::visit(ir_dereference_variable
*ir
)
649 ir_variable
*var
= ir
->variable_referenced();
650 if (var
&& var
->constant_value
)
651 value
= var
->constant_value
->clone(NULL
);
656 ir_constant_visitor::visit(ir_dereference_array
*ir
)
658 void *ctx
= talloc_parent(ir
);
659 ir_constant
*array
= ir
->array
->constant_expression_value();
660 ir_constant
*idx
= ir
->array_index
->constant_expression_value();
664 if ((array
!= NULL
) && (idx
!= NULL
)) {
665 if (array
->type
->is_matrix()) {
666 /* Array access of a matrix results in a vector.
668 const unsigned column
= idx
->value
.u
[0];
670 const glsl_type
*const column_type
= array
->type
->column_type();
672 /* Offset in the constant matrix to the first element of the column
675 const unsigned mat_idx
= column
* column_type
->vector_elements
;
677 ir_constant_data data
;
679 switch (column_type
->base_type
) {
682 for (unsigned i
= 0; i
< column_type
->vector_elements
; i
++)
683 data
.u
[i
] = array
->value
.u
[mat_idx
+ i
];
687 case GLSL_TYPE_FLOAT
:
688 for (unsigned i
= 0; i
< column_type
->vector_elements
; i
++)
689 data
.f
[i
] = array
->value
.f
[mat_idx
+ i
];
694 assert(!"Should not get here.");
698 this->value
= new(ctx
) ir_constant(column_type
, &data
);
699 } else if (array
->type
->is_vector()) {
700 const unsigned component
= idx
->value
.u
[0];
702 this->value
= new(ctx
) ir_constant(array
, component
);
704 /* FINISHME: Handle access of constant arrays. */
711 ir_constant_visitor::visit(ir_dereference_record
*ir
)
713 ir_constant
*v
= ir
->record
->constant_expression_value();
715 this->value
= (v
!= NULL
) ? v
->get_record_field(ir
->field
) : NULL
;
720 ir_constant_visitor::visit(ir_assignment
*ir
)
728 ir_constant_visitor::visit(ir_constant
*ir
)
735 ir_constant_visitor::visit(ir_call
*ir
)
743 ir_constant_visitor::visit(ir_return
*ir
)
751 ir_constant_visitor::visit(ir_discard
*ir
)
759 ir_constant_visitor::visit(ir_if
*ir
)
767 ir_constant_visitor::visit(ir_loop
*ir
)
775 ir_constant_visitor::visit(ir_loop_jump
*ir
)