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 opt_dead_code_local.cpp
27 * Eliminates local dead assignments from the code.
29 * This operates on basic blocks, tracking assignments and finding if
30 * they're used before the variable is completely reassigned.
32 * Compare this to ir_dead_code.cpp, which operates globally looking
33 * for assignments to variables that are never read.
37 #include "ir_basic_block.h"
38 #include "ir_optimization.h"
39 #include "compiler/glsl_types.h"
41 static bool debug
= false;
45 class assignment_entry
: public exec_node
48 /* override operator new from exec_node */
49 DECLARE_LINEAR_ZALLOC_CXX_OPERATORS(assignment_entry
)
51 assignment_entry(ir_variable
*lhs
, ir_assignment
*ir
)
57 this->unused
= ir
->write_mask
;
63 /* bitmask of xyzw channels written that haven't been used so far. */
67 class kill_for_derefs_visitor
: public ir_hierarchical_visitor
{
69 kill_for_derefs_visitor(exec_list
*assignments
)
71 this->assignments
= assignments
;
74 void use_channels(ir_variable
*const var
, int used
)
76 foreach_in_list_safe(assignment_entry
, entry
, this->assignments
) {
77 if (entry
->lhs
== var
) {
78 if (var
->type
->is_scalar() || var
->type
->is_vector()) {
80 printf("used %s (0x%01x - 0x%01x)\n", entry
->lhs
->name
,
81 entry
->unused
, used
& 0xf);
82 entry
->unused
&= ~used
;
87 printf("used %s\n", entry
->lhs
->name
);
94 virtual ir_visitor_status
visit(ir_dereference_variable
*ir
)
96 use_channels(ir
->var
, ~0);
98 return visit_continue
;
101 virtual ir_visitor_status
visit(ir_swizzle
*ir
)
103 ir_dereference_variable
*deref
= ir
->val
->as_dereference_variable();
105 return visit_continue
;
108 used
|= 1 << ir
->mask
.x
;
109 if (ir
->mask
.num_components
> 1)
110 used
|= 1 << ir
->mask
.y
;
111 if (ir
->mask
.num_components
> 2)
112 used
|= 1 << ir
->mask
.z
;
113 if (ir
->mask
.num_components
> 3)
114 used
|= 1 << ir
->mask
.w
;
116 use_channels(deref
->var
, used
);
118 return visit_continue_with_parent
;
121 virtual ir_visitor_status
visit_leave(ir_emit_vertex
*)
123 /* For the purpose of dead code elimination, emitting a vertex counts as
124 * "reading" all of the currently assigned output variables.
126 foreach_in_list_safe(assignment_entry
, entry
, this->assignments
) {
127 if (entry
->lhs
->data
.mode
== ir_var_shader_out
) {
129 printf("kill %s\n", entry
->lhs
->name
);
134 return visit_continue
;
138 exec_list
*assignments
;
141 class array_index_visit
: public ir_hierarchical_visitor
{
143 array_index_visit(ir_hierarchical_visitor
*v
)
148 virtual ir_visitor_status
visit_enter(class ir_dereference_array
*ir
)
150 ir
->array_index
->accept(visitor
);
151 return visit_continue
;
154 static void run(ir_instruction
*ir
, ir_hierarchical_visitor
*v
)
156 array_index_visit
top_visit(v
);
157 ir
->accept(& top_visit
);
160 ir_hierarchical_visitor
*visitor
;
163 } /* unnamed namespace */
166 * Adds an entry to the available copy list if it's a plain assignment
167 * of a variable to a variable.
170 process_assignment(void *lin_ctx
, ir_assignment
*ir
, exec_list
*assignments
)
172 ir_variable
*var
= NULL
;
173 bool progress
= false;
174 kill_for_derefs_visitor
v(assignments
);
176 if (ir
->condition
== NULL
) {
177 /* If this is an assignment of the form "foo = foo;", remove the whole
178 * instruction and be done with it.
180 const ir_variable
*const lhs_var
= ir
->whole_variable_written();
181 if (lhs_var
!= NULL
&& lhs_var
== ir
->rhs
->whole_variable_referenced()) {
187 /* Kill assignment entries for things used to produce this assignment. */
190 ir
->condition
->accept(&v
);
193 /* Kill assignment enties used as array indices.
195 array_index_visit::run(ir
->lhs
, &v
);
196 var
= ir
->lhs
->variable_referenced();
199 /* Now, check if we did a whole-variable assignment. */
200 if (!ir
->condition
) {
201 ir_dereference_variable
*deref_var
= ir
->lhs
->as_dereference_variable();
203 /* If it's a vector type, we can do per-channel elimination of
206 if (deref_var
&& (deref_var
->var
->type
->is_scalar() ||
207 deref_var
->var
->type
->is_vector())) {
210 printf("looking for %s.0x%01x to remove\n", var
->name
,
213 foreach_in_list_safe(assignment_entry
, entry
, assignments
) {
214 if (entry
->lhs
!= var
)
217 /* Skip if the assignment we're trying to eliminate isn't a plain
219 if (entry
->ir
->lhs
->ir_type
!= ir_type_dereference_variable
)
222 int remove
= entry
->unused
& ir
->write_mask
;
224 printf("%s 0x%01x - 0x%01x = 0x%01x\n",
226 entry
->ir
->write_mask
,
227 remove
, entry
->ir
->write_mask
& ~remove
);
233 printf("rewriting:\n ");
238 entry
->ir
->write_mask
&= ~remove
;
239 entry
->unused
&= ~remove
;
240 if (entry
->ir
->write_mask
== 0) {
241 /* Delete the dead assignment. */
245 void *mem_ctx
= ralloc_parent(entry
->ir
);
246 /* Reswizzle the RHS arguments according to the new
249 unsigned components
[4];
250 unsigned channels
= 0;
253 for (int i
= 0; i
< 4; i
++) {
254 if ((entry
->ir
->write_mask
| remove
) & (1 << i
)) {
255 if (!(remove
& (1 << i
)))
256 components
[channels
++] = next
;
261 entry
->ir
->rhs
= new(mem_ctx
) ir_swizzle(entry
->ir
->rhs
,
272 } else if (ir
->whole_variable_written() != NULL
) {
273 /* We did a whole-variable assignment. So, any instruction in
274 * the assignment list with the same LHS is dead.
277 printf("looking for %s to remove\n", var
->name
);
278 foreach_in_list_safe(assignment_entry
, entry
, assignments
) {
279 if (entry
->lhs
== var
) {
281 printf("removing %s\n", var
->name
);
290 /* Add this instruction to the assignment list available to be removed. */
291 assignment_entry
*entry
= new(lin_ctx
) assignment_entry(var
, ir
);
292 assignments
->push_tail(entry
);
295 printf("add %s\n", var
->name
);
297 printf("current entries\n");
298 foreach_in_list(assignment_entry
, entry
, assignments
) {
299 printf(" %s (0x%01x)\n", entry
->lhs
->name
, entry
->unused
);
307 dead_code_local_basic_block(ir_instruction
*first
,
308 ir_instruction
*last
,
311 ir_instruction
*ir
, *ir_next
;
312 /* List of avaialble_copy */
313 exec_list assignments
;
314 bool *out_progress
= (bool *)data
;
315 bool progress
= false;
317 void *ctx
= ralloc_context(NULL
);
318 void *lin_ctx
= linear_alloc_parent(ctx
, 0);
320 /* Safe looping, since process_assignment */
321 for (ir
= first
, ir_next
= (ir_instruction
*)first
->next
;;
322 ir
= ir_next
, ir_next
= (ir_instruction
*)ir
->next
) {
323 ir_assignment
*ir_assign
= ir
->as_assignment();
331 progress
= process_assignment(lin_ctx
, ir_assign
, &assignments
) ||
334 kill_for_derefs_visitor
kill(&assignments
);
341 *out_progress
= progress
;
346 * Does a copy propagation pass on the code present in the instruction stream.
349 do_dead_code_local(exec_list
*instructions
)
351 bool progress
= false;
353 call_for_basic_blocks(instructions
, dead_code_local_basic_block
, &progress
);