1 /*
2  * Copyright © 2016 Intel Corporation
3  *
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:
10  *
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
13  * Software.
14  *
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 DEALINGS
21  * IN THE SOFTWARE.
22  */
23 
24 #include "nir.h"
25 #include "nir/nir_builder.h"
26 #include "nir_constant_expressions.h"
27 #include "nir_control_flow.h"
28 #include "nir_loop_analyze.h"
29 
30 static nir_ssa_def *clone_alu_and_replace_src_defs(nir_builder *b,
31                                                    const nir_alu_instr *alu,
32                                                    nir_ssa_def **src_defs);
33 
34 /**
35  * Gets the single block that jumps back to the loop header. Already assumes
36  * there is exactly one such block.
37  */
38 static nir_block*
find_continue_block(nir_loop * loop)39 find_continue_block(nir_loop *loop)
40 {
41    nir_block *header_block = nir_loop_first_block(loop);
42    nir_block *prev_block =
43       nir_cf_node_as_block(nir_cf_node_prev(&loop->cf_node));
44 
45    assert(header_block->predecessors->entries == 2);
46 
47    set_foreach(header_block->predecessors, pred_entry) {
48       if (pred_entry->key != prev_block)
49          return (nir_block*)pred_entry->key;
50    }
51 
52    unreachable("Continue block not found!");
53 }
54 
55 /**
56  * Does a phi have one constant value from outside a loop and one from inside?
57  */
58 static bool
phi_has_constant_from_outside_and_one_from_inside_loop(nir_phi_instr * phi,const nir_block * entry_block,bool * entry_val,bool * continue_val)59 phi_has_constant_from_outside_and_one_from_inside_loop(nir_phi_instr *phi,
60                                                        const nir_block *entry_block,
61                                                        bool *entry_val,
62                                                        bool *continue_val)
63 {
64    /* We already know we have exactly one continue */
65    assert(exec_list_length(&phi->srcs) == 2);
66 
67    *entry_val = false;
68    *continue_val = false;
69 
70     nir_foreach_phi_src(src, phi) {
71        if (!nir_src_is_const(src->src))
72          return false;
73 
74        if (src->pred != entry_block) {
75           *continue_val = nir_src_as_bool(src->src);
76        } else {
77           *entry_val = nir_src_as_bool(src->src);
78        }
79     }
80 
81     return true;
82 }
83 
84 /**
85  * This optimization detects if statements at the tops of loops where the
86  * condition is a phi node of two constants and moves half of the if to above
87  * the loop and the other half of the if to the end of the loop.  A simple for
88  * loop "for (int i = 0; i < 4; i++)", when run through the SPIR-V front-end,
89  * ends up looking something like this:
90  *
91  * vec1 32 ssa_0 = load_const (0x00000000)
92  * vec1 32 ssa_1 = load_const (0xffffffff)
93  * loop {
94  *    block block_1:
95  *    vec1 32 ssa_2 = phi block_0: ssa_0, block_7: ssa_5
96  *    vec1 32 ssa_3 = phi block_0: ssa_0, block_7: ssa_1
97  *    if ssa_3 {
98  *       block block_2:
99  *       vec1 32 ssa_4 = load_const (0x00000001)
100  *       vec1 32 ssa_5 = iadd ssa_2, ssa_4
101  *    } else {
102  *       block block_3:
103  *    }
104  *    block block_4:
105  *    vec1 32 ssa_6 = load_const (0x00000004)
106  *    vec1 32 ssa_7 = ilt ssa_5, ssa_6
107  *    if ssa_7 {
108  *       block block_5:
109  *    } else {
110  *       block block_6:
111  *       break
112  *    }
113  *    block block_7:
114  * }
115  *
116  * This turns it into something like this:
117  *
118  * // Stuff from block 1
119  * // Stuff from block 3
120  * loop {
121  *    block block_1:
122  *    vec1 32 ssa_2 = phi block_0: ssa_0, block_7: ssa_5
123  *    vec1 32 ssa_6 = load_const (0x00000004)
124  *    vec1 32 ssa_7 = ilt ssa_2, ssa_6
125  *    if ssa_7 {
126  *       block block_5:
127  *    } else {
128  *       block block_6:
129  *       break
130  *    }
131  *    block block_7:
132  *    // Stuff from block 1
133  *    // Stuff from block 2
134  *    vec1 32 ssa_4 = load_const (0x00000001)
135  *    vec1 32 ssa_5 = iadd ssa_2, ssa_4
136  * }
137  */
138 static bool
opt_peel_loop_initial_if(nir_loop * loop)139 opt_peel_loop_initial_if(nir_loop *loop)
140 {
141    nir_block *header_block = nir_loop_first_block(loop);
142    nir_block *const prev_block =
143       nir_cf_node_as_block(nir_cf_node_prev(&loop->cf_node));
144 
145    /* It would be insane if this were not true */
146    assert(_mesa_set_search(header_block->predecessors, prev_block));
147 
148    /* The loop must have exactly one continue block which could be a block
149     * ending in a continue instruction or the "natural" continue from the
150     * last block in the loop back to the top.
151     */
152    if (header_block->predecessors->entries != 2)
153       return false;
154 
155    nir_cf_node *if_node = nir_cf_node_next(&header_block->cf_node);
156    if (!if_node || if_node->type != nir_cf_node_if)
157       return false;
158 
159    nir_if *nif = nir_cf_node_as_if(if_node);
160    assert(nif->condition.is_ssa);
161 
162    nir_ssa_def *cond = nif->condition.ssa;
163    if (cond->parent_instr->type != nir_instr_type_phi)
164       return false;
165 
166    nir_phi_instr *cond_phi = nir_instr_as_phi(cond->parent_instr);
167    if (cond->parent_instr->block != header_block)
168       return false;
169 
170    bool entry_val = false, continue_val = false;
171    if (!phi_has_constant_from_outside_and_one_from_inside_loop(cond_phi,
172                                                                prev_block,
173                                                                &entry_val,
174                                                                &continue_val))
175       return false;
176 
177    /* If they both execute or both don't execute, this is a job for
178     * nir_dead_cf, not this pass.
179     */
180    if ((entry_val && continue_val) || (!entry_val && !continue_val))
181       return false;
182 
183    struct exec_list *continue_list, *entry_list;
184    if (continue_val) {
185       continue_list = &nif->then_list;
186       entry_list = &nif->else_list;
187    } else {
188       continue_list = &nif->else_list;
189       entry_list = &nif->then_list;
190    }
191 
192    /* We want to be moving the contents of entry_list to above the loop so it
193     * can't contain any break or continue instructions.
194     */
195    foreach_list_typed(nir_cf_node, cf_node, node, entry_list) {
196       nir_foreach_block_in_cf_node(block, cf_node) {
197          nir_instr *last_instr = nir_block_last_instr(block);
198          if (last_instr && last_instr->type == nir_instr_type_jump)
199             return false;
200       }
201    }
202 
203    /* We're about to re-arrange a bunch of blocks so make sure that we don't
204     * have deref uses which cross block boundaries.  We don't want a deref
205     * accidentally ending up in a phi.
206     */
207    nir_rematerialize_derefs_in_use_blocks_impl(
208       nir_cf_node_get_function(&loop->cf_node));
209 
210    /* Before we do anything, convert the loop to LCSSA.  We're about to
211     * replace a bunch of SSA defs with registers and this will prevent any of
212     * it from leaking outside the loop.
213     */
214    nir_convert_loop_to_lcssa(loop);
215 
216    nir_block *after_if_block =
217       nir_cf_node_as_block(nir_cf_node_next(&nif->cf_node));
218 
219    /* Get rid of phis in the header block since we will be duplicating it */
220    nir_lower_phis_to_regs_block(header_block);
221    /* Get rid of phis after the if since dominance will change */
222    nir_lower_phis_to_regs_block(after_if_block);
223 
224    /* Get rid of SSA defs in the pieces we're about to move around */
225    nir_lower_ssa_defs_to_regs_block(header_block);
226    nir_foreach_block_in_cf_node(block, &nif->cf_node)
227       nir_lower_ssa_defs_to_regs_block(block);
228 
229    nir_cf_list header, tmp;
230    nir_cf_extract(&header, nir_before_block(header_block),
231                            nir_after_block(header_block));
232 
233    nir_cf_list_clone(&tmp, &header, &loop->cf_node, NULL);
234    nir_cf_reinsert(&tmp, nir_before_cf_node(&loop->cf_node));
235    nir_cf_extract(&tmp, nir_before_cf_list(entry_list),
236                         nir_after_cf_list(entry_list));
237    nir_cf_reinsert(&tmp, nir_before_cf_node(&loop->cf_node));
238 
239    nir_cf_reinsert(&header,
240                    nir_after_block_before_jump(find_continue_block(loop)));
241 
242    bool continue_list_jumps =
243       nir_block_ends_in_jump(exec_node_data(nir_block,
244                                             exec_list_get_tail(continue_list),
245                                             cf_node.node));
246 
247    nir_cf_extract(&tmp, nir_before_cf_list(continue_list),
248                         nir_after_cf_list(continue_list));
249 
250    /* Get continue block again as the previous reinsert might have removed the
251     * block.  Also, if both the continue list and the continue block ends in
252     * jump instructions, removes the jump from the latter, as it will not be
253     * executed if we insert the continue list before it. */
254 
255    nir_block *continue_block = find_continue_block(loop);
256 
257    if (continue_list_jumps) {
258       nir_instr *last_instr = nir_block_last_instr(continue_block);
259       if (last_instr && last_instr->type == nir_instr_type_jump)
260          nir_instr_remove(last_instr);
261    }
262 
263    nir_cf_reinsert(&tmp,
264                    nir_after_block_before_jump(continue_block));
265 
266    nir_cf_node_remove(&nif->cf_node);
267 
268    return true;
269 }
270 
271 static bool
alu_instr_is_comparison(const nir_alu_instr * alu)272 alu_instr_is_comparison(const nir_alu_instr *alu)
273 {
274    switch (alu->op) {
275    case nir_op_flt32:
276    case nir_op_fge32:
277    case nir_op_feq32:
278    case nir_op_fne32:
279    case nir_op_ilt32:
280    case nir_op_ult32:
281    case nir_op_ige32:
282    case nir_op_uge32:
283    case nir_op_ieq32:
284    case nir_op_ine32:
285       return true;
286    default:
287       return nir_alu_instr_is_comparison(alu);
288    }
289 }
290 
291 static bool
alu_instr_is_type_conversion(const nir_alu_instr * alu)292 alu_instr_is_type_conversion(const nir_alu_instr *alu)
293 {
294    return nir_op_infos[alu->op].num_inputs == 1 &&
295           nir_alu_type_get_base_type(nir_op_infos[alu->op].output_type) !=
296           nir_alu_type_get_base_type(nir_op_infos[alu->op].input_types[0]);
297 }
298 
299 /**
300  * Splits ALU instructions that have a source that is a phi node
301  *
302  * ALU instructions in the header block of a loop that meet the following
303  * criteria can be split.
304  *
305  * - The loop has no continue instructions other than the "natural" continue
306  *   at the bottom of the loop.
307  *
308  * - At least one source of the instruction is a phi node from the header block.
309  *
310  * - The phi node selects a constant or undef from the block before the loop.
311  *
312  * - Any non-phi sources of the ALU instruction come from a block that
313  *   dominates the block before the loop.  The most common failure mode for
314  *   this check is sources that are generated in the loop header block.
315  *
316  * The split process splits the original ALU instruction into two, one at the
317  * bottom of the loop and one at the block before the loop. The instruction
318  * before the loop computes the value on the first iteration, and the
319  * instruction at the bottom computes the value on the second, third, and so
320  * on. A new phi node is added to the header block that selects either the
321  * instruction before the loop or the one at the end, and uses of the original
322  * instruction are replaced by this phi.
323  *
324  * The splitting transforms a loop like:
325  *
326  *    vec1 32 ssa_8 = load_const (0x00000001)
327  *    vec1 32 ssa_10 = load_const (0x00000000)
328  *    // succs: block_1
329  *    loop {
330  *            block block_1:
331  *            // preds: block_0 block_4
332  *            vec1 32 ssa_11 = phi block_0: ssa_10, block_4: ssa_15
333  *            vec1 32 ssa_12 = phi block_0: ssa_1, block_4: ssa_15
334  *            vec1 32 ssa_13 = phi block_0: ssa_10, block_4: ssa_16
335  *            vec1 32 ssa_14 = iadd ssa_11, ssa_8
336  *            vec1 32 ssa_15 = b32csel ssa_13, ssa_14, ssa_12
337  *            ...
338  *            // succs: block_1
339  *    }
340  *
341  * into:
342  *
343  *    vec1 32 ssa_8 = load_const (0x00000001)
344  *    vec1 32 ssa_10 = load_const (0x00000000)
345  *    vec1 32 ssa_22 = iadd ssa_10, ssa_8
346  *    // succs: block_1
347  *    loop {
348  *            block block_1:
349  *            // preds: block_0 block_4
350  *            vec1 32 ssa_11 = phi block_0: ssa_10, block_4: ssa_15
351  *            vec1 32 ssa_12 = phi block_0: ssa_1, block_4: ssa_15
352  *            vec1 32 ssa_13 = phi block_0: ssa_10, block_4: ssa_16
353  *            vec1 32 ssa_21 = phi block_0: ssa_22, block_4: ssa_20
354  *            vec1 32 ssa_15 = b32csel ssa_13, ssa_21, ssa_12
355  *            ...
356  *            vec1 32 ssa_20 = iadd ssa_15, ssa_8
357  *            // succs: block_1
358  *    }
359  */
360 static bool
opt_split_alu_of_phi(nir_builder * b,nir_loop * loop)361 opt_split_alu_of_phi(nir_builder *b, nir_loop *loop)
362 {
363    bool progress = false;
364    nir_block *header_block = nir_loop_first_block(loop);
365    nir_block *const prev_block =
366       nir_cf_node_as_block(nir_cf_node_prev(&loop->cf_node));
367 
368    /* It would be insane if this were not true */
369    assert(_mesa_set_search(header_block->predecessors, prev_block));
370 
371    /* The loop must have exactly one continue block which could be a block
372     * ending in a continue instruction or the "natural" continue from the
373     * last block in the loop back to the top.
374     */
375    if (header_block->predecessors->entries != 2)
376       return false;
377 
378    nir_foreach_instr_safe(instr, header_block) {
379       if (instr->type != nir_instr_type_alu)
380          continue;
381 
382       nir_alu_instr *const alu = nir_instr_as_alu(instr);
383 
384       /* nir_op_vec{2,3,4} and nir_op_mov are excluded because they can easily
385        * lead to infinite optimization loops. Splitting comparisons can lead
386        * to loop unrolling not recognizing loop termintators, and type
387        * conversions also lead to regressions.
388        */
389       if (nir_op_is_vec(alu->op) ||
390           alu_instr_is_comparison(alu) ||
391           alu_instr_is_type_conversion(alu))
392          continue;
393 
394       bool has_phi_src_from_prev_block = false;
395       bool all_non_phi_exist_in_prev_block = true;
396       bool is_prev_result_undef = true;
397       bool is_prev_result_const = true;
398       nir_ssa_def *prev_srcs[8];     // FINISHME: Array size?
399       nir_ssa_def *continue_srcs[8]; // FINISHME: Array size?
400 
401       for (unsigned i = 0; i < nir_op_infos[alu->op].num_inputs; i++) {
402          nir_instr *const src_instr = alu->src[i].src.ssa->parent_instr;
403 
404          /* If the source is a phi in the loop header block, then the
405           * prev_srcs and continue_srcs will come from the different sources
406           * of the phi.
407           */
408          if (src_instr->type == nir_instr_type_phi &&
409              src_instr->block == header_block) {
410             nir_phi_instr *const phi = nir_instr_as_phi(src_instr);
411 
412             /* Only strictly need to NULL out the pointers when the assertions
413              * (below) are compiled in.  Debugging a NULL pointer deref in the
414              * wild is easier than debugging a random pointer deref, so set
415              * NULL unconditionally just to be safe.
416              */
417             prev_srcs[i] = NULL;
418             continue_srcs[i] = NULL;
419 
420             nir_foreach_phi_src(src_of_phi, phi) {
421                if (src_of_phi->pred == prev_block) {
422                   if (src_of_phi->src.ssa->parent_instr->type !=
423                       nir_instr_type_ssa_undef) {
424                      is_prev_result_undef = false;
425                   }
426 
427                   if (src_of_phi->src.ssa->parent_instr->type !=
428                       nir_instr_type_load_const) {
429                      is_prev_result_const = false;
430                   }
431 
432                   prev_srcs[i] = src_of_phi->src.ssa;
433                   has_phi_src_from_prev_block = true;
434                } else
435                   continue_srcs[i] = src_of_phi->src.ssa;
436             }
437 
438             assert(prev_srcs[i] != NULL);
439             assert(continue_srcs[i] != NULL);
440          } else {
441             /* If the source is not a phi (or a phi in a block other than the
442              * loop header), then the value must exist in prev_block.
443              */
444             if (!nir_block_dominates(src_instr->block, prev_block)) {
445                all_non_phi_exist_in_prev_block = false;
446                break;
447             }
448 
449             prev_srcs[i] = alu->src[i].src.ssa;
450             continue_srcs[i] = alu->src[i].src.ssa;
451          }
452       }
453 
454       if (has_phi_src_from_prev_block && all_non_phi_exist_in_prev_block &&
455           (is_prev_result_undef || is_prev_result_const)) {
456          nir_block *const continue_block = find_continue_block(loop);
457 
458          b->cursor = nir_after_block(prev_block);
459          nir_ssa_def *prev_value = clone_alu_and_replace_src_defs(b, alu, prev_srcs);
460 
461          /* Make a copy of the original ALU instruction.  Replace the sources
462           * of the new instruction that read a phi with an undef source from
463           * prev_block with the non-undef source of that phi.
464           *
465           * Insert the new instruction at the end of the continue block.
466           */
467          b->cursor = nir_after_block_before_jump(continue_block);
468 
469          nir_ssa_def *const alu_copy =
470             clone_alu_and_replace_src_defs(b, alu, continue_srcs);
471 
472          /* Make a new phi node that selects a value from prev_block and the
473           * result of the new instruction from continue_block.
474           */
475          nir_phi_instr *const phi = nir_phi_instr_create(b->shader);
476          nir_phi_src *phi_src;
477 
478          phi_src = ralloc(phi, nir_phi_src);
479          phi_src->pred = prev_block;
480          phi_src->src = nir_src_for_ssa(prev_value);
481          exec_list_push_tail(&phi->srcs, &phi_src->node);
482 
483          phi_src = ralloc(phi, nir_phi_src);
484          phi_src->pred = continue_block;
485          phi_src->src = nir_src_for_ssa(alu_copy);
486          exec_list_push_tail(&phi->srcs, &phi_src->node);
487 
488          nir_ssa_dest_init(&phi->instr, &phi->dest,
489                            alu_copy->num_components, alu_copy->bit_size, NULL);
490 
491          b->cursor = nir_after_phis(header_block);
492          nir_builder_instr_insert(b, &phi->instr);
493 
494          /* Modify all readers of the original ALU instruction to read the
495           * result of the phi.
496           */
497          nir_foreach_use_safe(use_src, &alu->dest.dest.ssa) {
498             nir_instr_rewrite_src(use_src->parent_instr,
499                                   use_src,
500                                   nir_src_for_ssa(&phi->dest.ssa));
501          }
502 
503          nir_foreach_if_use_safe(use_src, &alu->dest.dest.ssa) {
504             nir_if_rewrite_condition(use_src->parent_if,
505                                      nir_src_for_ssa(&phi->dest.ssa));
506          }
507 
508          /* Since the original ALU instruction no longer has any readers, just
509           * remove it.
510           */
511          nir_instr_remove_v(&alu->instr);
512          ralloc_free(alu);
513 
514          progress = true;
515       }
516    }
517 
518    return progress;
519 }
520 
521 /**
522  * Get the SSA value from a phi node that corresponds to a specific block
523  */
524 static nir_ssa_def *
ssa_for_phi_from_block(nir_phi_instr * phi,nir_block * block)525 ssa_for_phi_from_block(nir_phi_instr *phi, nir_block *block)
526 {
527    nir_foreach_phi_src(src, phi) {
528       if (src->pred == block)
529          return src->src.ssa;
530    }
531 
532    assert(!"Block is not a predecessor of phi.");
533    return NULL;
534 }
535 
536 /**
537  * Simplify a bcsel whose sources are all phi nodes from the loop header block
538  *
539  * bcsel instructions in a loop that meet the following criteria can be
540  * converted to phi nodes:
541  *
542  * - The loop has no continue instructions other than the "natural" continue
543  *   at the bottom of the loop.
544  *
545  * - All of the sources of the bcsel are phi nodes in the header block of the
546  *   loop.
547  *
548  * - The phi node representing the condition of the bcsel instruction chooses
549  *   only constant values.
550  *
551  * The contant value from the condition will select one of the other sources
552  * when entered from outside the loop and the remaining source when entered
553  * from the continue block.  Since each of these sources is also a phi node in
554  * the header block, the value of the phi node can be "evaluated."  These
555  * evaluated phi nodes provide the sources for a new phi node.  All users of
556  * the bcsel result are updated to use the phi node result.
557  *
558  * The replacement transforms loops like:
559  *
560  *    vec1 32 ssa_7 = undefined
561  *    vec1 32 ssa_8 = load_const (0x00000001)
562  *    vec1 32 ssa_9 = load_const (0x000000c8)
563  *    vec1 32 ssa_10 = load_const (0x00000000)
564  *    // succs: block_1
565  *    loop {
566  *            block block_1:
567  *            // preds: block_0 block_4
568  *            vec1 32 ssa_11 = phi block_0: ssa_1, block_4: ssa_14
569  *            vec1 32 ssa_12 = phi block_0: ssa_10, block_4: ssa_15
570  *            vec1 32 ssa_13 = phi block_0: ssa_7, block_4: ssa_25
571  *            vec1 32 ssa_14 = b32csel ssa_12, ssa_13, ssa_11
572  *            vec1 32 ssa_16 = ige32 ssa_14, ssa_9
573  *            ...
574  *            vec1 32 ssa_15 = load_const (0xffffffff)
575  *            ...
576  *            vec1 32 ssa_25 = iadd ssa_14, ssa_8
577  *            // succs: block_1
578  *    }
579  *
580  * into:
581  *
582  *    vec1 32 ssa_7 = undefined
583  *    vec1 32 ssa_8 = load_const (0x00000001)
584  *    vec1 32 ssa_9 = load_const (0x000000c8)
585  *    vec1 32 ssa_10 = load_const (0x00000000)
586  *    // succs: block_1
587  *    loop {
588  *            block block_1:
589  *            // preds: block_0 block_4
590  *            vec1 32 ssa_11 = phi block_0: ssa_1, block_4: ssa_14
591  *            vec1 32 ssa_12 = phi block_0: ssa_10, block_4: ssa_15
592  *            vec1 32 ssa_13 = phi block_0: ssa_7, block_4: ssa_25
593  *            vec1 32 sss_26 = phi block_0: ssa_1, block_4: ssa_25
594  *            vec1 32 ssa_16 = ige32 ssa_26, ssa_9
595  *            ...
596  *            vec1 32 ssa_15 = load_const (0xffffffff)
597  *            ...
598  *            vec1 32 ssa_25 = iadd ssa_26, ssa_8
599  *            // succs: block_1
600  *    }
601  *
602  * \note
603  * It may be possible modify this function to not require a phi node as the
604  * source of the bcsel that is selected when entering from outside the loop.
605  * The only restriction is that the source must be geneated outside the loop
606  * (since it will become the source of a phi node in the header block of the
607  * loop).
608  */
609 static bool
opt_simplify_bcsel_of_phi(nir_builder * b,nir_loop * loop)610 opt_simplify_bcsel_of_phi(nir_builder *b, nir_loop *loop)
611 {
612    bool progress = false;
613    nir_block *header_block = nir_loop_first_block(loop);
614    nir_block *const prev_block =
615       nir_cf_node_as_block(nir_cf_node_prev(&loop->cf_node));
616 
617    /* It would be insane if this were not true */
618    assert(_mesa_set_search(header_block->predecessors, prev_block));
619 
620    /* The loop must have exactly one continue block which could be a block
621     * ending in a continue instruction or the "natural" continue from the
622     * last block in the loop back to the top.
623     */
624    if (header_block->predecessors->entries != 2)
625       return false;
626 
627    /* We can move any bcsel that can guaranteed to execut on every iteration
628     * of a loop.  For now this is accomplished by only taking bcsels from the
629     * header_block.  In the future, this could be expanced to include any
630     * bcsel that must come before any break.
631     *
632     * For more details, see
633     * https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/170#note_110305
634     */
635    nir_foreach_instr_safe(instr, header_block) {
636       if (instr->type != nir_instr_type_alu)
637          continue;
638 
639       nir_alu_instr *const bcsel = nir_instr_as_alu(instr);
640       if (bcsel->op != nir_op_bcsel &&
641           bcsel->op != nir_op_b32csel &&
642           bcsel->op != nir_op_fcsel)
643          continue;
644 
645       bool match = true;
646       for (unsigned i = 0; i < 3; i++) {
647          /* FINISHME: The abs, negate and swizzled cases could be handled by
648           * adding move instructions at the bottom of the continue block and
649           * more phi nodes in the header_block.
650           */
651          if (!nir_alu_src_is_trivial_ssa(bcsel, i) ||
652              bcsel->src[i].src.ssa->parent_instr->type != nir_instr_type_phi ||
653              bcsel->src[i].src.ssa->parent_instr->block != header_block) {
654             match = false;
655             break;
656          }
657       }
658 
659       if (!match)
660          continue;
661 
662       nir_phi_instr *const cond_phi =
663          nir_instr_as_phi(bcsel->src[0].src.ssa->parent_instr);
664 
665       bool entry_val = false, continue_val = false;
666       if (!phi_has_constant_from_outside_and_one_from_inside_loop(cond_phi,
667                                                                   prev_block,
668                                                                   &entry_val,
669                                                                   &continue_val))
670          continue;
671 
672       /* If they both execute or both don't execute, this is a job for
673        * nir_dead_cf, not this pass.
674        */
675       if ((entry_val && continue_val) || (!entry_val && !continue_val))
676          continue;
677 
678       const unsigned entry_src = entry_val ? 1 : 2;
679       const unsigned continue_src = entry_val ? 2 : 1;
680 
681       /* Create a new phi node that selects the value for prev_block from
682        * the bcsel source that is selected by entry_val and the value for
683        * continue_block from the other bcsel source.  Both sources have
684        * already been verified to be phi nodes.
685        */
686       nir_block *const continue_block = find_continue_block(loop);
687       nir_phi_instr *const phi = nir_phi_instr_create(b->shader);
688       nir_phi_src *phi_src;
689 
690       phi_src = ralloc(phi, nir_phi_src);
691       phi_src->pred = prev_block;
692       phi_src->src =
693          nir_src_for_ssa(ssa_for_phi_from_block(nir_instr_as_phi(bcsel->src[entry_src].src.ssa->parent_instr),
694                                                 prev_block));
695       exec_list_push_tail(&phi->srcs, &phi_src->node);
696 
697       phi_src = ralloc(phi, nir_phi_src);
698       phi_src->pred = continue_block;
699       phi_src->src =
700          nir_src_for_ssa(ssa_for_phi_from_block(nir_instr_as_phi(bcsel->src[continue_src].src.ssa->parent_instr),
701                                                 continue_block));
702       exec_list_push_tail(&phi->srcs, &phi_src->node);
703 
704       nir_ssa_dest_init(&phi->instr,
705                         &phi->dest,
706                         nir_dest_num_components(bcsel->dest.dest),
707                         nir_dest_bit_size(bcsel->dest.dest),
708                         NULL);
709 
710       b->cursor = nir_after_phis(header_block);
711       nir_builder_instr_insert(b, &phi->instr);
712 
713       /* Modify all readers of the bcsel instruction to read the result of
714        * the phi.
715        */
716       nir_foreach_use_safe(use_src, &bcsel->dest.dest.ssa) {
717          nir_instr_rewrite_src(use_src->parent_instr,
718                                use_src,
719                                nir_src_for_ssa(&phi->dest.ssa));
720       }
721 
722       nir_foreach_if_use_safe(use_src, &bcsel->dest.dest.ssa) {
723          nir_if_rewrite_condition(use_src->parent_if,
724                                   nir_src_for_ssa(&phi->dest.ssa));
725       }
726 
727       /* Since the original bcsel instruction no longer has any readers,
728        * just remove it.
729        */
730       nir_instr_remove_v(&bcsel->instr);
731       ralloc_free(bcsel);
732 
733       progress = true;
734    }
735 
736    return progress;
737 }
738 
739 static bool
is_block_empty(nir_block * block)740 is_block_empty(nir_block *block)
741 {
742    return nir_cf_node_is_last(&block->cf_node) &&
743           exec_list_is_empty(&block->instr_list);
744 }
745 
746 static bool
nir_block_ends_in_continue(nir_block * block)747 nir_block_ends_in_continue(nir_block *block)
748 {
749    if (exec_list_is_empty(&block->instr_list))
750       return false;
751 
752    nir_instr *instr = nir_block_last_instr(block);
753    return instr->type == nir_instr_type_jump &&
754       nir_instr_as_jump(instr)->type == nir_jump_continue;
755 }
756 
757 /**
758  * This optimization turns:
759  *
760  *     loop {
761  *        ...
762  *        if (cond) {
763  *           do_work_1();
764  *           continue;
765  *        } else {
766  *        }
767  *        do_work_2();
768  *     }
769  *
770  * into:
771  *
772  *     loop {
773  *        ...
774  *        if (cond) {
775  *           do_work_1();
776  *           continue;
777  *        } else {
778  *           do_work_2();
779  *        }
780  *     }
781  *
782  * The continue should then be removed by nir_opt_trivial_continues() and the
783  * loop can potentially be unrolled.
784  *
785  * Note: Unless the function param aggressive_last_continue==true do_work_2()
786  * is only ever blocks and nested loops. We avoid nesting other if-statments
787  * in the branch as this can result in increased register pressure, and in
788  * the i965 driver it causes a large amount of spilling in shader-db.
789  * For RADV however nesting these if-statements allows further continues to be
790  * remove and provides a significant FPS boost in Doom, which is why we have
791  * opted for this special bool to enable more aggresive optimisations.
792  * TODO: The GCM pass solves most of the spilling regressions in i965, if it
793  * is ever enabled we should consider removing the aggressive_last_continue
794  * param.
795  */
796 static bool
opt_if_loop_last_continue(nir_loop * loop,bool aggressive_last_continue)797 opt_if_loop_last_continue(nir_loop *loop, bool aggressive_last_continue)
798 {
799    nir_if *nif;
800    bool then_ends_in_continue = false;
801    bool else_ends_in_continue = false;
802 
803    /* Scan the control flow of the loop from the last to the first node
804     * looking for an if-statement we can optimise.
805     */
806    nir_block *last_block = nir_loop_last_block(loop);
807    nir_cf_node *if_node = nir_cf_node_prev(&last_block->cf_node);
808    while (if_node) {
809       if (if_node->type == nir_cf_node_if) {
810          nif = nir_cf_node_as_if(if_node);
811          nir_block *then_block = nir_if_last_then_block(nif);
812          nir_block *else_block = nir_if_last_else_block(nif);
813 
814          then_ends_in_continue = nir_block_ends_in_continue(then_block);
815          else_ends_in_continue = nir_block_ends_in_continue(else_block);
816 
817          /* If both branches end in a jump do nothing, this should be handled
818           * by nir_opt_dead_cf().
819           */
820          if ((then_ends_in_continue || nir_block_ends_in_break(then_block)) &&
821              (else_ends_in_continue || nir_block_ends_in_break(else_block)))
822             return false;
823 
824          /* If continue found stop scanning and attempt optimisation, or
825           */
826          if (then_ends_in_continue || else_ends_in_continue ||
827              !aggressive_last_continue)
828             break;
829       }
830 
831       if_node = nir_cf_node_prev(if_node);
832    }
833 
834    /* If we didn't find an if to optimise return */
835    if (!then_ends_in_continue && !else_ends_in_continue)
836       return false;
837 
838    /* If there is nothing after the if-statement we bail */
839    if (&nif->cf_node == nir_cf_node_prev(&last_block->cf_node) &&
840        exec_list_is_empty(&last_block->instr_list))
841       return false;
842 
843    /* Move the last block of the loop inside the last if-statement */
844    nir_cf_list tmp;
845    nir_cf_extract(&tmp, nir_after_cf_node(if_node),
846                         nir_after_block(last_block));
847    if (then_ends_in_continue)
848       nir_cf_reinsert(&tmp, nir_after_cf_list(&nif->else_list));
849    else
850       nir_cf_reinsert(&tmp, nir_after_cf_list(&nif->then_list));
851 
852    /* In order to avoid running nir_lower_regs_to_ssa_impl() every time an if
853     * opt makes progress we leave nir_opt_trivial_continues() to remove the
854     * continue now that the end of the loop has been simplified.
855     */
856 
857    return true;
858 }
859 
860 /* Walk all the phis in the block immediately following the if statement and
861  * swap the blocks.
862  */
863 static void
rewrite_phi_predecessor_blocks(nir_if * nif,nir_block * old_then_block,nir_block * old_else_block,nir_block * new_then_block,nir_block * new_else_block)864 rewrite_phi_predecessor_blocks(nir_if *nif,
865                                nir_block *old_then_block,
866                                nir_block *old_else_block,
867                                nir_block *new_then_block,
868                                nir_block *new_else_block)
869 {
870    nir_block *after_if_block =
871       nir_cf_node_as_block(nir_cf_node_next(&nif->cf_node));
872 
873    nir_foreach_instr(instr, after_if_block) {
874       if (instr->type != nir_instr_type_phi)
875          continue;
876 
877       nir_phi_instr *phi = nir_instr_as_phi(instr);
878 
879       foreach_list_typed(nir_phi_src, src, node, &phi->srcs) {
880          if (src->pred == old_then_block) {
881             src->pred = new_then_block;
882          } else if (src->pred == old_else_block) {
883             src->pred = new_else_block;
884          }
885       }
886    }
887 }
888 
889 /**
890  * This optimization turns:
891  *
892  *     if (cond) {
893  *     } else {
894  *         do_work();
895  *     }
896  *
897  * into:
898  *
899  *     if (!cond) {
900  *         do_work();
901  *     } else {
902  *     }
903  */
904 static bool
opt_if_simplification(nir_builder * b,nir_if * nif)905 opt_if_simplification(nir_builder *b, nir_if *nif)
906 {
907    /* Only simplify if the then block is empty and the else block is not. */
908    if (!is_block_empty(nir_if_first_then_block(nif)) ||
909        is_block_empty(nir_if_first_else_block(nif)))
910       return false;
911 
912    /* Make sure the condition is a comparison operation. */
913    nir_instr *src_instr = nif->condition.ssa->parent_instr;
914    if (src_instr->type != nir_instr_type_alu)
915       return false;
916 
917    nir_alu_instr *alu_instr = nir_instr_as_alu(src_instr);
918    if (!nir_alu_instr_is_comparison(alu_instr))
919       return false;
920 
921    /* Insert the inverted instruction and rewrite the condition. */
922    b->cursor = nir_after_instr(&alu_instr->instr);
923 
924    nir_ssa_def *new_condition =
925       nir_inot(b, &alu_instr->dest.dest.ssa);
926 
927    nir_if_rewrite_condition(nif, nir_src_for_ssa(new_condition));
928 
929    /* Grab pointers to the last then/else blocks for fixing up the phis. */
930    nir_block *then_block = nir_if_last_then_block(nif);
931    nir_block *else_block = nir_if_last_else_block(nif);
932 
933    if (nir_block_ends_in_jump(else_block)) {
934       /* Even though this if statement has a jump on one side, we may still have
935        * phis afterwards.  Single-source phis can be produced by loop unrolling
936        * or dead control-flow passes and are perfectly legal.  Run a quick phi
937        * removal on the block after the if to clean up any such phis.
938        */
939       nir_block *const next_block =
940          nir_cf_node_as_block(nir_cf_node_next(&nif->cf_node));
941       nir_opt_remove_phis_block(next_block);
942    }
943 
944    rewrite_phi_predecessor_blocks(nif, then_block, else_block, else_block,
945                                   then_block);
946 
947    /* Finally, move the else block to the then block. */
948    nir_cf_list tmp;
949    nir_cf_extract(&tmp, nir_before_cf_list(&nif->else_list),
950                         nir_after_cf_list(&nif->else_list));
951    nir_cf_reinsert(&tmp, nir_before_cf_list(&nif->then_list));
952 
953    return true;
954 }
955 
956 /**
957  * This optimization simplifies potential loop terminators which then allows
958  * other passes such as opt_if_simplification() and loop unrolling to progress
959  * further:
960  *
961  *     if (cond) {
962  *        ... then block instructions ...
963  *     } else {
964  *         ...
965  *        break;
966  *     }
967  *
968  * into:
969  *
970  *     if (cond) {
971  *     } else {
972  *         ...
973  *        break;
974  *     }
975  *     ... then block instructions ...
976  */
977 static bool
opt_if_loop_terminator(nir_if * nif)978 opt_if_loop_terminator(nir_if *nif)
979 {
980    nir_block *break_blk = NULL;
981    nir_block *continue_from_blk = NULL;
982    bool continue_from_then = true;
983 
984    nir_block *last_then = nir_if_last_then_block(nif);
985    nir_block *last_else = nir_if_last_else_block(nif);
986 
987    if (nir_block_ends_in_break(last_then)) {
988       break_blk = last_then;
989       continue_from_blk = last_else;
990       continue_from_then = false;
991    } else if (nir_block_ends_in_break(last_else)) {
992       break_blk = last_else;
993       continue_from_blk = last_then;
994    }
995 
996    /* Continue if the if-statement contained no jumps at all */
997    if (!break_blk)
998       return false;
999 
1000    /* If the continue from block is empty then return as there is nothing to
1001     * move.
1002     */
1003    nir_block *first_continue_from_blk = continue_from_then ?
1004       nir_if_first_then_block(nif) :
1005       nir_if_first_else_block(nif);
1006    if (is_block_empty(first_continue_from_blk))
1007       return false;
1008 
1009    if (nir_block_ends_in_jump(continue_from_blk))
1010       return false;
1011 
1012    /* Even though this if statement has a jump on one side, we may still have
1013     * phis afterwards.  Single-source phis can be produced by loop unrolling
1014     * or dead control-flow passes and are perfectly legal.  Run a quick phi
1015     * removal on the block after the if to clean up any such phis.
1016     */
1017    nir_opt_remove_phis_block(nir_cf_node_as_block(nir_cf_node_next(&nif->cf_node)));
1018 
1019    /* Finally, move the continue from branch after the if-statement. */
1020    nir_cf_list tmp;
1021    nir_cf_extract(&tmp, nir_before_block(first_continue_from_blk),
1022                         nir_after_block(continue_from_blk));
1023    nir_cf_reinsert(&tmp, nir_after_cf_node(&nif->cf_node));
1024 
1025    return true;
1026 }
1027 
1028 static bool
evaluate_if_condition(nir_if * nif,nir_cursor cursor,bool * value)1029 evaluate_if_condition(nir_if *nif, nir_cursor cursor, bool *value)
1030 {
1031    nir_block *use_block = nir_cursor_current_block(cursor);
1032    if (nir_block_dominates(nir_if_first_then_block(nif), use_block)) {
1033       *value = true;
1034       return true;
1035    } else if (nir_block_dominates(nir_if_first_else_block(nif), use_block)) {
1036       *value = false;
1037       return true;
1038    } else {
1039       return false;
1040    }
1041 }
1042 
1043 static nir_ssa_def *
clone_alu_and_replace_src_defs(nir_builder * b,const nir_alu_instr * alu,nir_ssa_def ** src_defs)1044 clone_alu_and_replace_src_defs(nir_builder *b, const nir_alu_instr *alu,
1045                                nir_ssa_def **src_defs)
1046 {
1047    nir_alu_instr *nalu = nir_alu_instr_create(b->shader, alu->op);
1048    nalu->exact = alu->exact;
1049 
1050    nir_ssa_dest_init(&nalu->instr, &nalu->dest.dest,
1051                      alu->dest.dest.ssa.num_components,
1052                      alu->dest.dest.ssa.bit_size, alu->dest.dest.ssa.name);
1053 
1054    nalu->dest.saturate = alu->dest.saturate;
1055    nalu->dest.write_mask = alu->dest.write_mask;
1056 
1057    for (unsigned i = 0; i < nir_op_infos[alu->op].num_inputs; i++) {
1058       assert(alu->src[i].src.is_ssa);
1059       nalu->src[i].src = nir_src_for_ssa(src_defs[i]);
1060       nalu->src[i].negate = alu->src[i].negate;
1061       nalu->src[i].abs = alu->src[i].abs;
1062       memcpy(nalu->src[i].swizzle, alu->src[i].swizzle,
1063              sizeof(nalu->src[i].swizzle));
1064    }
1065 
1066    nir_builder_instr_insert(b, &nalu->instr);
1067 
1068    return &nalu->dest.dest.ssa;;
1069 }
1070 
1071 /*
1072  * This propagates if condition evaluation down the chain of some alu
1073  * instructions. For example by checking the use of some of the following alu
1074  * instruction we can eventually replace ssa_107 with NIR_TRUE.
1075  *
1076  *   loop {
1077  *      block block_1:
1078  *      vec1 32 ssa_85 = load_const (0x00000002)
1079  *      vec1 32 ssa_86 = ieq ssa_48, ssa_85
1080  *      vec1 32 ssa_87 = load_const (0x00000001)
1081  *      vec1 32 ssa_88 = ieq ssa_48, ssa_87
1082  *      vec1 32 ssa_89 = ior ssa_86, ssa_88
1083  *      vec1 32 ssa_90 = ieq ssa_48, ssa_0
1084  *      vec1 32 ssa_91 = ior ssa_89, ssa_90
1085  *      if ssa_86 {
1086  *         block block_2:
1087  *             ...
1088  *            break
1089  *      } else {
1090  *            block block_3:
1091  *      }
1092  *      block block_4:
1093  *      if ssa_88 {
1094  *            block block_5:
1095  *             ...
1096  *            break
1097  *      } else {
1098  *            block block_6:
1099  *      }
1100  *      block block_7:
1101  *      if ssa_90 {
1102  *            block block_8:
1103  *             ...
1104  *            break
1105  *      } else {
1106  *            block block_9:
1107  *      }
1108  *      block block_10:
1109  *      vec1 32 ssa_107 = inot ssa_91
1110  *      if ssa_107 {
1111  *            block block_11:
1112  *            break
1113  *      } else {
1114  *            block block_12:
1115  *      }
1116  *   }
1117  */
1118 static bool
propagate_condition_eval(nir_builder * b,nir_if * nif,nir_src * use_src,nir_src * alu_use,nir_alu_instr * alu,bool is_if_condition)1119 propagate_condition_eval(nir_builder *b, nir_if *nif, nir_src *use_src,
1120                          nir_src *alu_use, nir_alu_instr *alu,
1121                          bool is_if_condition)
1122 {
1123    bool bool_value;
1124    b->cursor = nir_before_src(alu_use, is_if_condition);
1125    if (!evaluate_if_condition(nif, b->cursor, &bool_value))
1126       return false;
1127 
1128    nir_ssa_def *def[NIR_MAX_VEC_COMPONENTS] = {0};
1129    for (unsigned i = 0; i < nir_op_infos[alu->op].num_inputs; i++) {
1130       if (alu->src[i].src.ssa == use_src->ssa) {
1131          def[i] = nir_imm_bool(b, bool_value);
1132       } else {
1133          def[i] = alu->src[i].src.ssa;
1134       }
1135    }
1136 
1137    nir_ssa_def *nalu = clone_alu_and_replace_src_defs(b, alu, def);
1138 
1139    /* Rewrite use to use new alu instruction */
1140    nir_src new_src = nir_src_for_ssa(nalu);
1141 
1142    if (is_if_condition)
1143       nir_if_rewrite_condition(alu_use->parent_if, new_src);
1144    else
1145       nir_instr_rewrite_src(alu_use->parent_instr, alu_use, new_src);
1146 
1147    return true;
1148 }
1149 
1150 static bool
can_propagate_through_alu(nir_src * src)1151 can_propagate_through_alu(nir_src *src)
1152 {
1153    if (src->parent_instr->type != nir_instr_type_alu)
1154       return false;
1155 
1156    nir_alu_instr *alu = nir_instr_as_alu(src->parent_instr);
1157    switch (alu->op) {
1158       case nir_op_ior:
1159       case nir_op_iand:
1160       case nir_op_inot:
1161       case nir_op_b2i32:
1162          return true;
1163       case nir_op_bcsel:
1164          return src == &alu->src[0].src;
1165       default:
1166          return false;
1167    }
1168 }
1169 
1170 static bool
evaluate_condition_use(nir_builder * b,nir_if * nif,nir_src * use_src,bool is_if_condition)1171 evaluate_condition_use(nir_builder *b, nir_if *nif, nir_src *use_src,
1172                        bool is_if_condition)
1173 {
1174    bool progress = false;
1175 
1176    b->cursor = nir_before_src(use_src, is_if_condition);
1177 
1178    bool bool_value;
1179    if (evaluate_if_condition(nif, b->cursor, &bool_value)) {
1180       /* Rewrite use to use const */
1181       nir_src imm_src = nir_src_for_ssa(nir_imm_bool(b, bool_value));
1182       if (is_if_condition)
1183          nir_if_rewrite_condition(use_src->parent_if, imm_src);
1184       else
1185          nir_instr_rewrite_src(use_src->parent_instr, use_src, imm_src);
1186 
1187       progress = true;
1188    }
1189 
1190    if (!is_if_condition && can_propagate_through_alu(use_src)) {
1191       nir_alu_instr *alu = nir_instr_as_alu(use_src->parent_instr);
1192 
1193       nir_foreach_use_safe(alu_use, &alu->dest.dest.ssa) {
1194          progress |= propagate_condition_eval(b, nif, use_src, alu_use, alu,
1195                                               false);
1196       }
1197 
1198       nir_foreach_if_use_safe(alu_use, &alu->dest.dest.ssa) {
1199          progress |= propagate_condition_eval(b, nif, use_src, alu_use, alu,
1200                                               true);
1201       }
1202    }
1203 
1204    return progress;
1205 }
1206 
1207 static bool
opt_if_evaluate_condition_use(nir_builder * b,nir_if * nif)1208 opt_if_evaluate_condition_use(nir_builder *b, nir_if *nif)
1209 {
1210    bool progress = false;
1211 
1212    /* Evaluate any uses of the if condition inside the if branches */
1213    assert(nif->condition.is_ssa);
1214    nir_foreach_use_safe(use_src, nif->condition.ssa) {
1215       progress |= evaluate_condition_use(b, nif, use_src, false);
1216    }
1217 
1218    nir_foreach_if_use_safe(use_src, nif->condition.ssa) {
1219       if (use_src->parent_if != nif)
1220          progress |= evaluate_condition_use(b, nif, use_src, true);
1221    }
1222 
1223    return progress;
1224 }
1225 
1226 static void
simple_merge_if(nir_if * dest_if,nir_if * src_if,bool dest_if_then,bool src_if_then)1227 simple_merge_if(nir_if *dest_if, nir_if *src_if, bool dest_if_then,
1228                 bool src_if_then)
1229 {
1230    /* Now merge the if branch */
1231    nir_block *dest_blk = dest_if_then ? nir_if_last_then_block(dest_if)
1232                                       : nir_if_last_else_block(dest_if);
1233 
1234    struct exec_list *list = src_if_then ? &src_if->then_list
1235                                         : &src_if->else_list;
1236 
1237    nir_cf_list if_cf_list;
1238    nir_cf_extract(&if_cf_list, nir_before_cf_list(list),
1239                   nir_after_cf_list(list));
1240    nir_cf_reinsert(&if_cf_list, nir_after_block(dest_blk));
1241 }
1242 
1243 static bool
opt_if_merge(nir_if * nif)1244 opt_if_merge(nir_if *nif)
1245 {
1246    bool progress = false;
1247 
1248    nir_block *next_blk = nir_cf_node_cf_tree_next(&nif->cf_node);
1249    if (next_blk && nif->condition.is_ssa) {
1250       nir_if *next_if = nir_block_get_following_if(next_blk);
1251       if (next_if && next_if->condition.is_ssa) {
1252 
1253          /* Here we merge two consecutive ifs that have the same
1254           * condition e.g:
1255           *
1256           *   if ssa_12 {
1257           *      ...
1258           *   } else {
1259           *      ...
1260           *   }
1261           *   if ssa_12 {
1262           *      ...
1263           *   } else {
1264           *      ...
1265           *   }
1266           *
1267           * Note: This only merges if-statements when the block between them
1268           * is empty. The reason we don't try to merge ifs that just have phis
1269           * between them is because this can results in increased register
1270           * pressure. For example when merging if ladders created by indirect
1271           * indexing.
1272           */
1273          if (nif->condition.ssa == next_if->condition.ssa &&
1274              exec_list_is_empty(&next_blk->instr_list)) {
1275 
1276             /* This optimization isn't made to work in this case and
1277              * opt_if_evaluate_condition_use will optimize it later.
1278              */
1279             if (nir_block_ends_in_jump(nir_if_last_then_block(nif)) ||
1280                 nir_block_ends_in_jump(nir_if_last_else_block(nif)))
1281                return false;
1282 
1283             simple_merge_if(nif, next_if, true, true);
1284             simple_merge_if(nif, next_if, false, false);
1285 
1286             nir_block *new_then_block = nir_if_last_then_block(nif);
1287             nir_block *new_else_block = nir_if_last_else_block(nif);
1288 
1289             nir_block *old_then_block = nir_if_last_then_block(next_if);
1290             nir_block *old_else_block = nir_if_last_else_block(next_if);
1291 
1292             /* Rewrite the predecessor block for any phis following the second
1293              * if-statement.
1294              */
1295             rewrite_phi_predecessor_blocks(next_if, old_then_block,
1296                                            old_else_block,
1297                                            new_then_block,
1298                                            new_else_block);
1299 
1300             /* Move phis after merged if to avoid them being deleted when we
1301              * remove the merged if-statement.
1302              */
1303             nir_block *after_next_if_block =
1304                nir_cf_node_as_block(nir_cf_node_next(&next_if->cf_node));
1305 
1306             nir_foreach_instr_safe(instr, after_next_if_block) {
1307                if (instr->type != nir_instr_type_phi)
1308                   break;
1309 
1310                exec_node_remove(&instr->node);
1311                exec_list_push_tail(&next_blk->instr_list, &instr->node);
1312                instr->block = next_blk;
1313             }
1314 
1315             nir_cf_node_remove(&next_if->cf_node);
1316 
1317             progress = true;
1318          }
1319       }
1320    }
1321 
1322    return progress;
1323 }
1324 
1325 static bool
opt_if_cf_list(nir_builder * b,struct exec_list * cf_list,bool aggressive_last_continue)1326 opt_if_cf_list(nir_builder *b, struct exec_list *cf_list,
1327                bool aggressive_last_continue)
1328 {
1329    bool progress = false;
1330    foreach_list_typed(nir_cf_node, cf_node, node, cf_list) {
1331       switch (cf_node->type) {
1332       case nir_cf_node_block:
1333          break;
1334 
1335       case nir_cf_node_if: {
1336          nir_if *nif = nir_cf_node_as_if(cf_node);
1337          progress |= opt_if_cf_list(b, &nif->then_list,
1338                                     aggressive_last_continue);
1339          progress |= opt_if_cf_list(b, &nif->else_list,
1340                                     aggressive_last_continue);
1341          progress |= opt_if_loop_terminator(nif);
1342          progress |= opt_if_merge(nif);
1343          progress |= opt_if_simplification(b, nif);
1344          break;
1345       }
1346 
1347       case nir_cf_node_loop: {
1348          nir_loop *loop = nir_cf_node_as_loop(cf_node);
1349          progress |= opt_if_cf_list(b, &loop->body,
1350                                     aggressive_last_continue);
1351          progress |= opt_simplify_bcsel_of_phi(b, loop);
1352          progress |= opt_if_loop_last_continue(loop,
1353                                                aggressive_last_continue);
1354          break;
1355       }
1356 
1357       case nir_cf_node_function:
1358          unreachable("Invalid cf type");
1359       }
1360    }
1361 
1362    return progress;
1363 }
1364 
1365 static bool
opt_peel_loop_initial_if_cf_list(struct exec_list * cf_list)1366 opt_peel_loop_initial_if_cf_list(struct exec_list *cf_list)
1367 {
1368    bool progress = false;
1369    foreach_list_typed(nir_cf_node, cf_node, node, cf_list) {
1370       switch (cf_node->type) {
1371       case nir_cf_node_block:
1372          break;
1373 
1374       case nir_cf_node_if: {
1375          nir_if *nif = nir_cf_node_as_if(cf_node);
1376          progress |= opt_peel_loop_initial_if_cf_list(&nif->then_list);
1377          progress |= opt_peel_loop_initial_if_cf_list(&nif->else_list);
1378          break;
1379       }
1380 
1381       case nir_cf_node_loop: {
1382          nir_loop *loop = nir_cf_node_as_loop(cf_node);
1383          progress |= opt_peel_loop_initial_if_cf_list(&loop->body);
1384          progress |= opt_peel_loop_initial_if(loop);
1385          break;
1386       }
1387 
1388       case nir_cf_node_function:
1389          unreachable("Invalid cf type");
1390       }
1391    }
1392 
1393    return progress;
1394 }
1395 
1396 /**
1397  * These optimisations depend on nir_metadata_block_index and therefore must
1398  * not do anything to cause the metadata to become invalid.
1399  */
1400 static bool
opt_if_safe_cf_list(nir_builder * b,struct exec_list * cf_list)1401 opt_if_safe_cf_list(nir_builder *b, struct exec_list *cf_list)
1402 {
1403    bool progress = false;
1404    foreach_list_typed(nir_cf_node, cf_node, node, cf_list) {
1405       switch (cf_node->type) {
1406       case nir_cf_node_block:
1407          break;
1408 
1409       case nir_cf_node_if: {
1410          nir_if *nif = nir_cf_node_as_if(cf_node);
1411          progress |= opt_if_safe_cf_list(b, &nif->then_list);
1412          progress |= opt_if_safe_cf_list(b, &nif->else_list);
1413          progress |= opt_if_evaluate_condition_use(b, nif);
1414          break;
1415       }
1416 
1417       case nir_cf_node_loop: {
1418          nir_loop *loop = nir_cf_node_as_loop(cf_node);
1419          progress |= opt_if_safe_cf_list(b, &loop->body);
1420          progress |= opt_split_alu_of_phi(b, loop);
1421          break;
1422       }
1423 
1424       case nir_cf_node_function:
1425          unreachable("Invalid cf type");
1426       }
1427    }
1428 
1429    return progress;
1430 }
1431 
1432 bool
nir_opt_if(nir_shader * shader,bool aggressive_last_continue)1433 nir_opt_if(nir_shader *shader, bool aggressive_last_continue)
1434 {
1435    bool progress = false;
1436 
1437    nir_foreach_function(function, shader) {
1438       if (function->impl == NULL)
1439          continue;
1440 
1441       nir_builder b;
1442       nir_builder_init(&b, function->impl);
1443 
1444       nir_metadata_require(function->impl, nir_metadata_block_index |
1445                            nir_metadata_dominance);
1446       progress = opt_if_safe_cf_list(&b, &function->impl->body);
1447       nir_metadata_preserve(function->impl, nir_metadata_block_index |
1448                             nir_metadata_dominance);
1449 
1450       bool preserve = true;
1451 
1452       if (opt_if_cf_list(&b, &function->impl->body, aggressive_last_continue)) {
1453          preserve = false;
1454          progress = true;
1455       }
1456 
1457       if (opt_peel_loop_initial_if_cf_list(&function->impl->body)) {
1458          preserve = false;
1459          progress = true;
1460 
1461          /* If that made progress, we're no longer really in SSA form.  We
1462           * need to convert registers back into SSA defs and clean up SSA defs
1463           * that don't dominate their uses.
1464           */
1465          nir_lower_regs_to_ssa_impl(function->impl);
1466       }
1467 
1468       if (preserve) {
1469          nir_metadata_preserve(function->impl, nir_metadata_none);
1470       } else {
1471          nir_metadata_preserve(function->impl, nir_metadata_all);
1472       }
1473    }
1474 
1475    return progress;
1476 }
1477