2 * Copyright © 2010 Intel Corporation
4 * Permission is hereby granted, free of charge, to any person obtaining a
5 * copy of this software and associated documentation files (the "Software"),
6 * to deal in the Software without restriction, including without limitation
7 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
8 * and/or sell copies of the Software, and to permit persons to whom the
9 * Software is furnished to do so, subject to the following conditions:
11 * The above copyright notice and this permission notice (including the next
12 * paragraph) shall be included in all copies or substantial portions of the
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
18 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
21 * DEALINGS IN THE SOFTWARE.
24 #include "main/imports.h"
26 #include "ir_visitor.h"
27 #include "glsl_types.h"
29 ir_rvalue::ir_rvalue()
31 this->type
= glsl_type::error_type
;
34 ir_assignment::ir_assignment(ir_rvalue
*lhs
, ir_rvalue
*rhs
,
37 this->ir_type
= ir_type_assignment
;
40 this->condition
= condition
;
44 ir_expression::ir_expression(int op
, const struct glsl_type
*type
,
45 ir_rvalue
*op0
, ir_rvalue
*op1
)
47 this->ir_type
= ir_type_expression
;
49 this->operation
= ir_expression_operation(op
);
50 this->operands
[0] = op0
;
51 this->operands
[1] = op1
;
55 ir_expression::get_num_operands(ir_expression_operation op
)
57 /* Update ir_print_visitor.cpp when updating this list. */
58 const int num_operands
[] = {
59 1, /* ir_unop_bit_not */
60 1, /* ir_unop_logic_not */
79 1, /* ir_unop_trunc */
81 1, /* ir_unop_floor */
82 1, /* ir_unop_fract */
96 2, /* ir_binop_less */
97 2, /* ir_binop_greater */
98 2, /* ir_binop_lequal */
99 2, /* ir_binop_gequal */
100 2, /* ir_binop_equal */
101 2, /* ir_binop_nequal */
103 2, /* ir_binop_lshift */
104 2, /* ir_binop_rshift */
105 2, /* ir_binop_bit_and */
106 2, /* ir_binop_bit_xor */
107 2, /* ir_binop_bit_or */
109 2, /* ir_binop_logic_and */
110 2, /* ir_binop_logic_xor */
111 2, /* ir_binop_logic_or */
113 2, /* ir_binop_dot */
114 2, /* ir_binop_cross */
115 2, /* ir_binop_min */
116 2, /* ir_binop_max */
118 2, /* ir_binop_pow */
121 assert(sizeof(num_operands
) / sizeof(num_operands
[0]) == ir_binop_pow
+ 1);
123 return num_operands
[op
];
126 static const char *const operator_strs
[] = {
180 const char *ir_expression::operator_string()
182 assert((unsigned int) operation
<=
183 sizeof(operator_strs
) / sizeof(operator_strs
[0]));
184 return operator_strs
[operation
];
187 ir_expression_operation
188 ir_expression::get_operator(const char *str
)
190 const int operator_count
= sizeof(operator_strs
) / sizeof(operator_strs
[0]);
191 for (int op
= 0; op
< operator_count
; op
++) {
192 if (strcmp(str
, operator_strs
[op
]) == 0)
193 return (ir_expression_operation
) op
;
195 return (ir_expression_operation
) -1;
198 ir_constant::ir_constant()
200 this->ir_type
= ir_type_constant
;
203 ir_constant::ir_constant(const struct glsl_type
*type
,
204 const ir_constant_data
*data
)
206 assert((type
->base_type
>= GLSL_TYPE_UINT
)
207 && (type
->base_type
<= GLSL_TYPE_BOOL
));
209 this->ir_type
= ir_type_constant
;
211 memcpy(& this->value
, data
, sizeof(this->value
));
214 ir_constant::ir_constant(float f
)
216 this->ir_type
= ir_type_constant
;
217 this->type
= glsl_type::float_type
;
218 this->value
.f
[0] = f
;
221 ir_constant::ir_constant(unsigned int u
)
223 this->ir_type
= ir_type_constant
;
224 this->type
= glsl_type::uint_type
;
225 this->value
.u
[0] = u
;
228 ir_constant::ir_constant(int i
)
230 this->ir_type
= ir_type_constant
;
231 this->type
= glsl_type::int_type
;
232 this->value
.i
[0] = i
;
235 ir_constant::ir_constant(bool b
)
237 this->ir_type
= ir_type_constant
;
238 this->type
= glsl_type::bool_type
;
239 this->value
.b
[0] = b
;
242 ir_constant::ir_constant(const ir_constant
*c
, unsigned i
)
244 this->ir_type
= ir_type_constant
;
245 this->type
= c
->type
->get_base_type();
247 switch (this->type
->base_type
) {
248 case GLSL_TYPE_UINT
: this->value
.u
[0] = c
->value
.u
[i
]; break;
249 case GLSL_TYPE_INT
: this->value
.i
[0] = c
->value
.i
[i
]; break;
250 case GLSL_TYPE_FLOAT
: this->value
.f
[0] = c
->value
.f
[i
]; break;
251 case GLSL_TYPE_BOOL
: this->value
.b
[0] = c
->value
.b
[i
]; break;
252 default: assert(!"Should not get here."); break;
256 ir_constant::ir_constant(const struct glsl_type
*type
, exec_list
*value_list
)
258 this->ir_type
= ir_type_constant
;
261 assert(type
->is_scalar() || type
->is_vector() || type
->is_matrix()
262 || type
->is_record() || type
->is_array());
264 if (type
->is_array()) {
265 this->array_elements
= talloc_array(this, ir_constant
*, type
->length
);
267 foreach_list(node
, value_list
) {
268 ir_constant
*value
= (ir_constant
*) node
;
269 assert(value
->as_constant() != NULL
);
271 this->array_elements
[i
++] = value
;
276 /* If the constant is a record, the types of each of the entries in
277 * value_list must be a 1-for-1 match with the structure components. Each
278 * entry must also be a constant. Just move the nodes from the value_list
279 * to the list in the ir_constant.
281 /* FINISHME: Should there be some type checking and / or assertions here? */
282 /* FINISHME: Should the new constant take ownership of the nodes from
283 * FINISHME: value_list, or should it make copies?
285 if (type
->is_record()) {
286 value_list
->move_nodes_to(& this->components
);
291 ir_constant
*value
= (ir_constant
*) (value_list
->head
);
293 /* Use each component from each entry in the value_list to initialize one
294 * component of the constant being constructed.
296 for (unsigned i
= 0; i
< type
->components(); /* empty */) {
297 assert(value
->as_constant() != NULL
);
298 assert(!value
->is_tail_sentinal());
300 for (unsigned j
= 0; j
< value
->type
->components(); j
++) {
301 switch (type
->base_type
) {
303 this->value
.u
[i
] = value
->get_uint_component(j
);
306 this->value
.i
[i
] = value
->get_int_component(j
);
308 case GLSL_TYPE_FLOAT
:
309 this->value
.f
[i
] = value
->get_float_component(j
);
312 this->value
.b
[i
] = value
->get_bool_component(j
);
315 /* FINISHME: What to do? Exceptions are not the answer.
321 if (i
>= type
->components())
325 value
= (ir_constant
*) value
->next
;
330 ir_constant::zero(void *mem_ctx
, const glsl_type
*type
)
332 assert(type
->is_numeric());
334 ir_constant
*c
= new(mem_ctx
) ir_constant
;
336 memset(&c
->value
, 0, sizeof(c
->value
));
342 ir_constant::get_bool_component(unsigned i
) const
344 switch (this->type
->base_type
) {
345 case GLSL_TYPE_UINT
: return this->value
.u
[i
] != 0;
346 case GLSL_TYPE_INT
: return this->value
.i
[i
] != 0;
347 case GLSL_TYPE_FLOAT
: return ((int)this->value
.f
[i
]) != 0;
348 case GLSL_TYPE_BOOL
: return this->value
.b
[i
];
349 default: assert(!"Should not get here."); break;
352 /* Must return something to make the compiler happy. This is clearly an
359 ir_constant::get_float_component(unsigned i
) const
361 switch (this->type
->base_type
) {
362 case GLSL_TYPE_UINT
: return (float) this->value
.u
[i
];
363 case GLSL_TYPE_INT
: return (float) this->value
.i
[i
];
364 case GLSL_TYPE_FLOAT
: return this->value
.f
[i
];
365 case GLSL_TYPE_BOOL
: return this->value
.b
[i
] ? 1.0 : 0.0;
366 default: assert(!"Should not get here."); break;
369 /* Must return something to make the compiler happy. This is clearly an
376 ir_constant::get_int_component(unsigned i
) const
378 switch (this->type
->base_type
) {
379 case GLSL_TYPE_UINT
: return this->value
.u
[i
];
380 case GLSL_TYPE_INT
: return this->value
.i
[i
];
381 case GLSL_TYPE_FLOAT
: return (int) this->value
.f
[i
];
382 case GLSL_TYPE_BOOL
: return this->value
.b
[i
] ? 1 : 0;
383 default: assert(!"Should not get here."); break;
386 /* Must return something to make the compiler happy. This is clearly an
393 ir_constant::get_uint_component(unsigned i
) const
395 switch (this->type
->base_type
) {
396 case GLSL_TYPE_UINT
: return this->value
.u
[i
];
397 case GLSL_TYPE_INT
: return this->value
.i
[i
];
398 case GLSL_TYPE_FLOAT
: return (unsigned) this->value
.f
[i
];
399 case GLSL_TYPE_BOOL
: return this->value
.b
[i
] ? 1 : 0;
400 default: assert(!"Should not get here."); break;
403 /* Must return something to make the compiler happy. This is clearly an
410 ir_constant::get_array_element(unsigned i
) const
412 assert(this->type
->is_array());
413 assert(i
< this->type
->length
);
415 return array_elements
[i
];
419 ir_constant::get_record_field(const char *name
)
421 int idx
= this->type
->field_index(name
);
426 if (this->components
.is_empty())
429 exec_node
*node
= this->components
.head
;
430 for (int i
= 0; i
< idx
; i
++) {
433 /* If the end of the list is encountered before the element matching the
434 * requested field is found, return NULL.
436 if (node
->is_tail_sentinal())
440 return (ir_constant
*) node
;
445 ir_constant::has_value(const ir_constant
*c
) const
447 if (this->type
!= c
->type
)
450 if (this->type
->is_array()) {
451 for (unsigned i
= 0; i
< this->type
->length
; i
++) {
452 if (this->array_elements
[i
]->has_value(c
->array_elements
[i
]))
458 if (this->type
->base_type
== GLSL_TYPE_STRUCT
) {
459 const exec_node
*a_node
= this->components
.head
;
460 const exec_node
*b_node
= c
->components
.head
;
462 while (!a_node
->is_tail_sentinal()) {
463 assert(!b_node
->is_tail_sentinal());
465 const ir_constant
*const a_field
= (ir_constant
*) a_node
;
466 const ir_constant
*const b_field
= (ir_constant
*) b_node
;
468 if (!a_field
->has_value(b_field
))
471 a_node
= a_node
->next
;
472 b_node
= b_node
->next
;
478 for (unsigned i
= 0; i
< this->type
->components(); i
++) {
479 switch (this->type
->base_type
) {
481 if (this->value
.u
[i
] != c
->value
.u
[i
])
485 if (this->value
.i
[i
] != c
->value
.i
[i
])
488 case GLSL_TYPE_FLOAT
:
489 if (this->value
.f
[i
] != c
->value
.f
[i
])
493 if (this->value
.b
[i
] != c
->value
.b
[i
])
497 assert(!"Should not get here.");
505 ir_dereference_variable::ir_dereference_variable(ir_variable
*var
)
507 this->ir_type
= ir_type_dereference_variable
;
509 this->type
= (var
!= NULL
) ? var
->type
: glsl_type::error_type
;
513 ir_dereference_array::ir_dereference_array(ir_rvalue
*value
,
514 ir_rvalue
*array_index
)
516 this->ir_type
= ir_type_dereference_array
;
517 this->array_index
= array_index
;
518 this->set_array(value
);
522 ir_dereference_array::ir_dereference_array(ir_variable
*var
,
523 ir_rvalue
*array_index
)
525 void *ctx
= talloc_parent(var
);
527 this->ir_type
= ir_type_dereference_array
;
528 this->array_index
= array_index
;
529 this->set_array(new(ctx
) ir_dereference_variable(var
));
534 ir_dereference_array::set_array(ir_rvalue
*value
)
537 this->type
= glsl_type::error_type
;
539 if (this->array
!= NULL
) {
540 const glsl_type
*const vt
= this->array
->type
;
542 if (vt
->is_array()) {
543 type
= vt
->element_type();
544 } else if (vt
->is_matrix()) {
545 type
= vt
->column_type();
546 } else if (vt
->is_vector()) {
547 type
= vt
->get_base_type();
553 ir_dereference_record::ir_dereference_record(ir_rvalue
*value
,
556 this->ir_type
= ir_type_dereference_record
;
557 this->record
= value
;
558 this->field
= talloc_strdup(this, field
);
559 this->type
= (this->record
!= NULL
)
560 ? this->record
->type
->field_type(field
) : glsl_type::error_type
;
564 ir_dereference_record::ir_dereference_record(ir_variable
*var
,
567 void *ctx
= talloc_parent(var
);
569 this->ir_type
= ir_type_dereference_record
;
570 this->record
= new(ctx
) ir_dereference_variable(var
);
571 this->field
= talloc_strdup(this, field
);
572 this->type
= (this->record
!= NULL
)
573 ? this->record
->type
->field_type(field
) : glsl_type::error_type
;
578 ir_dereference::is_lvalue()
580 ir_variable
*var
= this->variable_referenced();
582 /* Every l-value derference chain eventually ends in a variable.
584 if ((var
== NULL
) || var
->read_only
)
587 if (this->type
->is_array() && !var
->array_lvalue
)
594 const char *tex_opcode_strs
[] = { "tex", "txb", "txl", "txd", "txf" };
596 const char *ir_texture::opcode_string()
598 assert((unsigned int) op
<=
599 sizeof(tex_opcode_strs
) / sizeof(tex_opcode_strs
[0]));
600 return tex_opcode_strs
[op
];
604 ir_texture::get_opcode(const char *str
)
606 const int count
= sizeof(tex_opcode_strs
) / sizeof(tex_opcode_strs
[0]);
607 for (int op
= 0; op
< count
; op
++) {
608 if (strcmp(str
, tex_opcode_strs
[op
]) == 0)
609 return (ir_texture_opcode
) op
;
611 return (ir_texture_opcode
) -1;
616 ir_texture::set_sampler(ir_dereference
*sampler
)
618 assert(sampler
!= NULL
);
619 this->sampler
= sampler
;
621 switch (sampler
->type
->sampler_type
) {
622 case GLSL_TYPE_FLOAT
:
623 this->type
= glsl_type::vec4_type
;
626 this->type
= glsl_type::ivec4_type
;
629 this->type
= glsl_type::uvec4_type
;
636 ir_swizzle::init_mask(const unsigned *comp
, unsigned count
)
638 assert((count
>= 1) && (count
<= 4));
640 memset(&this->mask
, 0, sizeof(this->mask
));
641 this->mask
.num_components
= count
;
643 unsigned dup_mask
= 0;
646 assert(comp
[3] <= 3);
647 dup_mask
|= (1U << comp
[3])
648 & ((1U << comp
[0]) | (1U << comp
[1]) | (1U << comp
[2]));
649 this->mask
.w
= comp
[3];
652 assert(comp
[2] <= 3);
653 dup_mask
|= (1U << comp
[2])
654 & ((1U << comp
[0]) | (1U << comp
[1]));
655 this->mask
.z
= comp
[2];
658 assert(comp
[1] <= 3);
659 dup_mask
|= (1U << comp
[1])
661 this->mask
.y
= comp
[1];
664 assert(comp
[0] <= 3);
665 this->mask
.x
= comp
[0];
668 this->mask
.has_duplicates
= dup_mask
!= 0;
670 /* Based on the number of elements in the swizzle and the base type
671 * (i.e., float, int, unsigned, or bool) of the vector being swizzled,
672 * generate the type of the resulting value.
674 type
= glsl_type::get_instance(val
->type
->base_type
, mask
.num_components
, 1);
677 ir_swizzle::ir_swizzle(ir_rvalue
*val
, unsigned x
, unsigned y
, unsigned z
,
678 unsigned w
, unsigned count
)
681 const unsigned components
[4] = { x
, y
, z
, w
};
682 this->ir_type
= ir_type_swizzle
;
683 this->init_mask(components
, count
);
686 ir_swizzle::ir_swizzle(ir_rvalue
*val
, const unsigned *comp
,
690 this->ir_type
= ir_type_swizzle
;
691 this->init_mask(comp
, count
);
694 ir_swizzle::ir_swizzle(ir_rvalue
*val
, ir_swizzle_mask mask
)
696 this->ir_type
= ir_type_swizzle
;
699 this->type
= glsl_type::get_instance(val
->type
->base_type
,
700 mask
.num_components
, 1);
709 ir_swizzle::create(ir_rvalue
*val
, const char *str
, unsigned vector_length
)
711 void *ctx
= talloc_parent(val
);
713 /* For each possible swizzle character, this table encodes the value in
714 * \c idx_map that represents the 0th element of the vector. For invalid
715 * swizzle characters (e.g., 'k'), a special value is used that will allow
716 * detection of errors.
718 static const unsigned char base_idx
[26] = {
719 /* a b c d e f g h i j k l m */
720 R
, R
, I
, I
, I
, I
, R
, I
, I
, I
, I
, I
, I
,
721 /* n o p q r s t u v w x y z */
722 I
, I
, S
, S
, R
, S
, S
, I
, I
, X
, X
, X
, X
725 /* Each valid swizzle character has an entry in the previous table. This
726 * table encodes the base index encoded in the previous table plus the actual
727 * index of the swizzle character. When processing swizzles, the first
728 * character in the string is indexed in the previous table. Each character
729 * in the string is indexed in this table, and the value found there has the
730 * value form the first table subtracted. The result must be on the range
733 * For example, the string "wzyx" will get X from the first table. Each of
734 * the charcaters will get X+3, X+2, X+1, and X+0 from this table. After
735 * subtraction, the swizzle values are { 3, 2, 1, 0 }.
737 * The string "wzrg" will get X from the first table. Each of the characters
738 * will get X+3, X+2, R+0, and R+1 from this table. After subtraction, the
739 * swizzle values are { 3, 2, 4, 5 }. Since 4 and 5 are outside the range
740 * [0,3], the error is detected.
742 static const unsigned char idx_map
[26] = {
743 /* a b c d e f g h i j k l m */
744 R
+3, R
+2, 0, 0, 0, 0, R
+1, 0, 0, 0, 0, 0, 0,
745 /* n o p q r s t u v w x y z */
746 0, 0, S
+2, S
+3, R
+0, S
+0, S
+1, 0, 0, X
+3, X
+0, X
+1, X
+2
749 int swiz_idx
[4] = { 0, 0, 0, 0 };
753 /* Validate the first character in the swizzle string and look up the base
754 * index value as described above.
756 if ((str
[0] < 'a') || (str
[0] > 'z'))
759 const unsigned base
= base_idx
[str
[0] - 'a'];
762 for (i
= 0; (i
< 4) && (str
[i
] != '\0'); i
++) {
763 /* Validate the next character, and, as described above, convert it to a
766 if ((str
[i
] < 'a') || (str
[i
] > 'z'))
769 swiz_idx
[i
] = idx_map
[str
[i
] - 'a'] - base
;
770 if ((swiz_idx
[i
] < 0) || (swiz_idx
[i
] >= (int) vector_length
))
777 return new(ctx
) ir_swizzle(val
, swiz_idx
[0], swiz_idx
[1], swiz_idx
[2],
787 ir_swizzle::variable_referenced()
789 return this->val
->variable_referenced();
793 ir_variable::ir_variable(const struct glsl_type
*type
, const char *name
,
794 ir_variable_mode mode
)
795 : max_array_access(0), read_only(false), centroid(false), invariant(false),
796 shader_in(false), shader_out(false),
797 mode(mode
), interpolation(ir_var_smooth
), array_lvalue(false)
799 this->ir_type
= ir_type_variable
;
801 this->name
= talloc_strdup(this, name
);
803 this->warn_extension
= NULL
;
804 this->constant_value
= NULL
;
806 if (type
&& type
->base_type
== GLSL_TYPE_SAMPLER
)
807 this->read_only
= true;
812 ir_variable::interpolation_string() const
814 if (!this->shader_in
&& !this->shader_out
)
817 switch (this->interpolation
) {
818 case ir_var_smooth
: return "smooth";
819 case ir_var_flat
: return "flat";
820 case ir_var_noperspective
: return "noperspective";
823 assert(!"Should not get here.");
829 ir_variable::component_slots() const
831 /* FINISHME: Sparsely accessed arrays require fewer slots. */
832 return this->type
->component_slots();
836 ir_function_signature::ir_function_signature(const glsl_type
*return_type
)
837 : return_type(return_type
), is_defined(false), _function(NULL
)
839 this->ir_type
= ir_type_function_signature
;
844 ir_function_signature::qualifiers_match(exec_list
*params
)
846 exec_list_iterator iter_a
= parameters
.iterator();
847 exec_list_iterator iter_b
= params
->iterator();
849 /* check that the qualifiers match. */
850 while (iter_a
.has_next()) {
851 ir_variable
*a
= (ir_variable
*)iter_a
.get();
852 ir_variable
*b
= (ir_variable
*)iter_b
.get();
854 if (a
->read_only
!= b
->read_only
||
855 a
->mode
!= b
->mode
||
856 a
->interpolation
!= b
->interpolation
||
857 a
->centroid
!= b
->centroid
) {
859 /* parameter a's qualifiers don't match */
871 ir_function_signature::replace_parameters(exec_list
*new_params
)
873 /* Destroy all of the previous parameter information. If the previous
874 * parameter information comes from the function prototype, it may either
875 * specify incorrect parameter names or not have names at all.
877 foreach_iter(exec_list_iterator
, iter
, parameters
) {
878 assert(((ir_instruction
*) iter
.get())->as_variable() != NULL
);
883 new_params
->move_nodes_to(¶meters
);
887 ir_function::ir_function(const char *name
)
889 this->ir_type
= ir_type_function
;
890 this->name
= talloc_strdup(this, name
);
895 ir_call::get_error_instruction(void *ctx
)
897 ir_call
*call
= new(ctx
) ir_call
;
899 call
->type
= glsl_type::error_type
;
904 ir_call::set_callee(ir_function_signature
*sig
)
906 assert((this->type
== NULL
) || (this->type
== sig
->return_type
));
912 visit_exec_list(exec_list
*list
, ir_visitor
*visitor
)
914 foreach_iter(exec_list_iterator
, iter
, *list
) {
915 ((ir_instruction
*)iter
.get())->accept(visitor
);
921 steal_memory(ir_instruction
*ir
, void *new_ctx
)
923 ir_variable
*var
= ir
->as_variable();
924 ir_constant
*constant
= ir
->as_constant();
925 if (var
!= NULL
&& var
->constant_value
!= NULL
)
926 steal_memory(var
->constant_value
, ir
);
928 /* The components of aggregate constants are not visited by the normal
929 * visitor, so steal their values by hand.
931 if (constant
!= NULL
) {
932 if (constant
->type
->is_record()) {
933 foreach_iter(exec_list_iterator
, iter
, constant
->components
) {
934 ir_constant
*field
= (ir_constant
*)iter
.get();
935 steal_memory(field
, ir
);
937 } else if (constant
->type
->is_array()) {
938 for (unsigned int i
= 0; i
< constant
->type
->length
; i
++) {
939 steal_memory(constant
->array_elements
[i
], ir
);
944 talloc_steal(new_ctx
, ir
);
949 reparent_ir(exec_list
*list
, void *mem_ctx
)
951 foreach_list(node
, list
) {
952 visit_tree((ir_instruction
*) node
, steal_memory
, mem_ctx
);