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 for (unsigned c
= 0; c
< ir
->operands
[0]->type
->components(); c
++) {
218 switch (ir
->type
->base_type
) {
225 case GLSL_TYPE_FLOAT
:
226 data
.f
[c
] = op
[0]->value
.f
[c
] - floor(op
[0]->value
.f
[c
]);
235 for (unsigned c
= 0; c
< ir
->operands
[0]->type
->components(); c
++) {
236 switch (ir
->type
->base_type
) {
238 data
.u
[c
] = -op
[0]->value
.u
[c
];
241 data
.i
[c
] = -op
[0]->value
.i
[c
];
243 case GLSL_TYPE_FLOAT
:
244 data
.f
[c
] = -op
[0]->value
.f
[c
];
253 for (unsigned c
= 0; c
< ir
->operands
[0]->type
->components(); c
++) {
254 switch (ir
->type
->base_type
) {
256 data
.u
[c
] = op
[0]->value
.u
[c
];
259 data
.i
[c
] = op
[0]->value
.i
[c
];
261 data
.i
[c
] = -data
.i
[c
];
263 case GLSL_TYPE_FLOAT
:
264 data
.f
[c
] = fabs(op
[0]->value
.f
[c
]);
273 for (unsigned c
= 0; c
< ir
->operands
[0]->type
->components(); c
++) {
274 switch (ir
->type
->base_type
) {
276 data
.u
[c
] = op
[0]->value
.i
[c
] > 0;
279 data
.i
[c
] = (op
[0]->value
.i
[c
] > 0) - (op
[0]->value
.i
[c
] < 0);
281 case GLSL_TYPE_FLOAT
:
282 data
.f
[c
] = float((op
[0]->value
.f
[c
] > 0)-(op
[0]->value
.f
[c
] < 0));
291 assert(op
[0]->type
->base_type
== GLSL_TYPE_FLOAT
);
292 for (unsigned c
= 0; c
< ir
->operands
[0]->type
->components(); c
++) {
293 switch (ir
->type
->base_type
) {
295 if (op
[0]->value
.u
[c
] != 0.0)
296 data
.u
[c
] = 1 / op
[0]->value
.u
[c
];
299 if (op
[0]->value
.i
[c
] != 0.0)
300 data
.i
[c
] = 1 / op
[0]->value
.i
[c
];
302 case GLSL_TYPE_FLOAT
:
303 if (op
[0]->value
.f
[c
] != 0.0)
304 data
.f
[c
] = 1.0 / 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
] = 1.0 / 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
] = sqrtf(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
] = expf(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
] = exp2f(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
] = logf(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
] = log2f(op
[0]->value
.f
[c
]);
356 assert(op
[0]->type
->base_type
== GLSL_TYPE_FLOAT
);
357 for (unsigned c
= 0; c
< ir
->operands
[0]->type
->components(); c
++) {
363 assert(op
[0]->type
->is_vector() && op
[1]->type
->is_vector());
365 for (unsigned c
= 0; c
< op
[0]->type
->components(); c
++) {
366 switch (ir
->operands
[0]->type
->base_type
) {
368 data
.u
[0] += op
[0]->value
.u
[c
] * op
[1]->value
.u
[c
];
371 data
.i
[0] += op
[0]->value
.i
[c
] * op
[1]->value
.i
[c
];
373 case GLSL_TYPE_FLOAT
:
374 data
.f
[0] += op
[0]->value
.f
[c
] * op
[1]->value
.f
[c
];
383 assert(op
[0]->type
== op
[1]->type
|| op0_scalar
|| op1_scalar
);
384 for (unsigned c
= 0, c0
= 0, c1
= 0;
386 c0
+= c0_inc
, c1
+= c1_inc
, c
++) {
388 switch (ir
->operands
[0]->type
->base_type
) {
390 data
.u
[c
] = op
[0]->value
.u
[c0
] + op
[1]->value
.u
[c1
];
393 data
.i
[c
] = op
[0]->value
.i
[c0
] + op
[1]->value
.i
[c1
];
395 case GLSL_TYPE_FLOAT
:
396 data
.f
[c
] = op
[0]->value
.f
[c0
] + op
[1]->value
.f
[c1
];
405 assert(op
[0]->type
== op
[1]->type
|| op0_scalar
|| op1_scalar
);
406 for (unsigned c
= 0, c0
= 0, c1
= 0;
408 c0
+= c0_inc
, c1
+= c1_inc
, c
++) {
410 switch (ir
->operands
[0]->type
->base_type
) {
412 data
.u
[c
] = op
[0]->value
.u
[c0
] - op
[1]->value
.u
[c1
];
415 data
.i
[c
] = op
[0]->value
.i
[c0
] - op
[1]->value
.i
[c1
];
417 case GLSL_TYPE_FLOAT
:
418 data
.f
[c
] = op
[0]->value
.f
[c0
] - op
[1]->value
.f
[c1
];
427 /* Check for equal types, or unequal types involving scalars */
428 if ((op
[0]->type
== op
[1]->type
&& !op
[0]->type
->is_matrix())
429 || op0_scalar
|| op1_scalar
) {
430 for (unsigned c
= 0, c0
= 0, c1
= 0;
432 c0
+= c0_inc
, c1
+= c1_inc
, c
++) {
434 switch (ir
->operands
[0]->type
->base_type
) {
436 data
.u
[c
] = op
[0]->value
.u
[c0
] * op
[1]->value
.u
[c1
];
439 data
.i
[c
] = op
[0]->value
.i
[c0
] * op
[1]->value
.i
[c1
];
441 case GLSL_TYPE_FLOAT
:
442 data
.f
[c
] = op
[0]->value
.f
[c0
] * op
[1]->value
.f
[c1
];
449 assert(op
[0]->type
->is_matrix() || op
[1]->type
->is_matrix());
451 /* Multiply an N-by-M matrix with an M-by-P matrix. Since either
452 * matrix can be a GLSL vector, either N or P can be 1.
454 * For vec*mat, the vector is treated as a row vector. This
455 * means the vector is a 1-row x M-column matrix.
457 * For mat*vec, the vector is treated as a column vector. Since
458 * matrix_columns is 1 for vectors, this just works.
460 const unsigned n
= op
[0]->type
->is_vector()
461 ? 1 : op
[0]->type
->vector_elements
;
462 const unsigned m
= op
[1]->type
->vector_elements
;
463 const unsigned p
= op
[1]->type
->matrix_columns
;
464 for (unsigned j
= 0; j
< p
; j
++) {
465 for (unsigned i
= 0; i
< n
; i
++) {
466 for (unsigned k
= 0; k
< m
; k
++) {
467 data
.f
[i
+n
*j
] += op
[0]->value
.f
[i
+n
*k
]*op
[1]->value
.f
[k
+m
*j
];
475 assert(op
[0]->type
== op
[1]->type
|| op0_scalar
|| op1_scalar
);
476 for (unsigned c
= 0, c0
= 0, c1
= 0;
478 c0
+= c0_inc
, c1
+= c1_inc
, c
++) {
480 switch (ir
->operands
[0]->type
->base_type
) {
482 data
.u
[c
] = op
[0]->value
.u
[c0
] / op
[1]->value
.u
[c1
];
485 data
.i
[c
] = op
[0]->value
.i
[c0
] / op
[1]->value
.i
[c1
];
487 case GLSL_TYPE_FLOAT
:
488 data
.f
[c
] = op
[0]->value
.f
[c0
] / op
[1]->value
.f
[c1
];
496 case ir_binop_logic_and
:
497 assert(op
[0]->type
->base_type
== GLSL_TYPE_BOOL
);
498 for (unsigned c
= 0; c
< ir
->operands
[0]->type
->components(); c
++)
499 data
.b
[c
] = op
[0]->value
.b
[c
] && op
[1]->value
.b
[c
];
501 case ir_binop_logic_xor
:
502 assert(op
[0]->type
->base_type
== GLSL_TYPE_BOOL
);
503 for (unsigned c
= 0; c
< ir
->operands
[0]->type
->components(); c
++)
504 data
.b
[c
] = op
[0]->value
.b
[c
] ^ op
[1]->value
.b
[c
];
506 case ir_binop_logic_or
:
507 assert(op
[0]->type
->base_type
== GLSL_TYPE_BOOL
);
508 for (unsigned c
= 0; c
< ir
->operands
[0]->type
->components(); c
++)
509 data
.b
[c
] = op
[0]->value
.b
[c
] || op
[1]->value
.b
[c
];
513 switch (ir
->operands
[0]->type
->base_type
) {
515 data
.b
[0] = op
[0]->value
.u
[0] < op
[1]->value
.u
[0];
518 data
.b
[0] = op
[0]->value
.i
[0] < op
[1]->value
.i
[0];
520 case GLSL_TYPE_FLOAT
:
521 data
.b
[0] = op
[0]->value
.f
[0] < op
[1]->value
.f
[0];
527 case ir_binop_greater
:
528 switch (ir
->operands
[0]->type
->base_type
) {
530 data
.b
[0] = op
[0]->value
.u
[0] > op
[1]->value
.u
[0];
533 data
.b
[0] = op
[0]->value
.i
[0] > op
[1]->value
.i
[0];
535 case GLSL_TYPE_FLOAT
:
536 data
.b
[0] = op
[0]->value
.f
[0] > op
[1]->value
.f
[0];
542 case ir_binop_lequal
:
543 switch (ir
->operands
[0]->type
->base_type
) {
545 data
.b
[0] = op
[0]->value
.u
[0] <= op
[1]->value
.u
[0];
548 data
.b
[0] = op
[0]->value
.i
[0] <= op
[1]->value
.i
[0];
550 case GLSL_TYPE_FLOAT
:
551 data
.b
[0] = op
[0]->value
.f
[0] <= op
[1]->value
.f
[0];
557 case ir_binop_gequal
:
558 switch (ir
->operands
[0]->type
->base_type
) {
560 data
.b
[0] = op
[0]->value
.u
[0] >= op
[1]->value
.u
[0];
563 data
.b
[0] = op
[0]->value
.i
[0] >= op
[1]->value
.i
[0];
565 case GLSL_TYPE_FLOAT
:
566 data
.b
[0] = op
[0]->value
.f
[0] >= op
[1]->value
.f
[0];
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
];
594 case ir_binop_nequal
:
596 for (unsigned c
= 0; c
< ir
->operands
[0]->type
->components(); c
++) {
597 switch (ir
->operands
[0]->type
->base_type
) {
599 data
.b
[0] = data
.b
[0] || op
[0]->value
.u
[c
] != op
[1]->value
.u
[c
];
602 data
.b
[0] = data
.b
[0] || op
[0]->value
.i
[c
] != op
[1]->value
.i
[c
];
604 case GLSL_TYPE_FLOAT
:
605 data
.b
[0] = data
.b
[0] || op
[0]->value
.f
[c
] != op
[1]->value
.f
[c
];
608 data
.b
[0] = data
.b
[0] || op
[0]->value
.b
[c
] != op
[1]->value
.b
[c
];
617 /* FINISHME: Should handle all expression types. */
621 void *ctx
= talloc_parent(ir
);
622 this->value
= new(ctx
) ir_constant(ir
->type
, &data
);
627 ir_constant_visitor::visit(ir_texture
*ir
)
629 // FINISHME: Do stuff with texture lookups
636 ir_constant_visitor::visit(ir_swizzle
*ir
)
638 ir_constant
*v
= ir
->val
->constant_expression_value();
643 ir_constant_data data
;
645 const unsigned swiz_idx
[4] = {
646 ir
->mask
.x
, ir
->mask
.y
, ir
->mask
.z
, ir
->mask
.w
649 for (unsigned i
= 0; i
< ir
->mask
.num_components
; i
++) {
650 switch (v
->type
->base_type
) {
652 case GLSL_TYPE_INT
: data
.u
[i
] = v
->value
.u
[swiz_idx
[i
]]; break;
653 case GLSL_TYPE_FLOAT
: data
.f
[i
] = v
->value
.f
[swiz_idx
[i
]]; break;
654 case GLSL_TYPE_BOOL
: data
.b
[i
] = v
->value
.b
[swiz_idx
[i
]]; break;
655 default: assert(!"Should not get here."); break;
659 void *ctx
= talloc_parent(ir
);
660 this->value
= new(ctx
) ir_constant(ir
->type
, &data
);
666 ir_constant_visitor::visit(ir_dereference_variable
*ir
)
670 ir_variable
*var
= ir
->variable_referenced();
671 if (var
&& var
->constant_value
)
672 value
= var
->constant_value
->clone(NULL
);
677 ir_constant_visitor::visit(ir_dereference_array
*ir
)
679 void *ctx
= talloc_parent(ir
);
680 ir_constant
*array
= ir
->array
->constant_expression_value();
681 ir_constant
*idx
= ir
->array_index
->constant_expression_value();
685 if ((array
!= NULL
) && (idx
!= NULL
)) {
686 if (array
->type
->is_matrix()) {
687 /* Array access of a matrix results in a vector.
689 const unsigned column
= idx
->value
.u
[0];
691 const glsl_type
*const column_type
= array
->type
->column_type();
693 /* Offset in the constant matrix to the first element of the column
696 const unsigned mat_idx
= column
* column_type
->vector_elements
;
698 ir_constant_data data
;
700 switch (column_type
->base_type
) {
703 for (unsigned i
= 0; i
< column_type
->vector_elements
; i
++)
704 data
.u
[i
] = array
->value
.u
[mat_idx
+ i
];
708 case GLSL_TYPE_FLOAT
:
709 for (unsigned i
= 0; i
< column_type
->vector_elements
; i
++)
710 data
.f
[i
] = array
->value
.f
[mat_idx
+ i
];
715 assert(!"Should not get here.");
719 this->value
= new(ctx
) ir_constant(column_type
, &data
);
720 } else if (array
->type
->is_vector()) {
721 const unsigned component
= idx
->value
.u
[0];
723 this->value
= new(ctx
) ir_constant(array
, component
);
725 /* FINISHME: Handle access of constant arrays. */
732 ir_constant_visitor::visit(ir_dereference_record
*ir
)
734 ir_constant
*v
= ir
->record
->constant_expression_value();
736 this->value
= (v
!= NULL
) ? v
->get_record_field(ir
->field
) : NULL
;
741 ir_constant_visitor::visit(ir_assignment
*ir
)
749 ir_constant_visitor::visit(ir_constant
*ir
)
756 ir_constant_visitor::visit(ir_call
*ir
)
764 ir_constant_visitor::visit(ir_return
*ir
)
772 ir_constant_visitor::visit(ir_discard
*ir
)
780 ir_constant_visitor::visit(ir_if
*ir
)
788 ir_constant_visitor::visit(ir_loop
*ir
)
796 ir_constant_visitor::visit(ir_loop_jump
*ir
)