src/compiler/nir/nir_opt_peephole_select.c

   1 /*
   2  * Copyright © 2014 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  * Authors:
  24  *    Jason Ekstrand (jason@jlekstrand.net)
  25  *
  26  */
  27
  28 #include "nir.h"
  29 #include "nir_control_flow.h"
  30 #include "nir_search_helpers.h"
  31
  32 /*
  33  * Implements a small peephole optimization that looks for
  34  *
  35  * if (cond) {
  36  *    <then SSA defs>
  37  * } else {
  38  *    <else SSA defs>
  39  * }
  40  * phi
  41  * ...
  42  * phi
  43  *
  44  * and replaces it with:
  45  *
  46  * <then SSA defs>
  47  * <else SSA defs>
  48  * bcsel
  49  * ...
  50  * bcsel
  51  *
  52  * where the SSA defs are ALU operations or other cheap instructions (not
  53  * texturing, for example).
  54  *
  55  * If the number of ALU operations in the branches is greater than the limit
  56  * parameter, then the optimization is skipped.  In limit=0 mode, the SSA defs
  57  * must only be MOVs which we expect to get copy-propagated away once they're
  58  * out of the inner blocks.
  59  */
  60
  61 static bool
  62 block_check_for_allowed_instrs(nir_block *block, unsigned *count,
  63                                bool alu_ok, bool indirect_load_ok,
  64                                bool expensive_alu_ok)
  65 {
  66    nir_foreach_instr(instr, block) {
  67       switch (instr->type) {
  68       case nir_instr_type_intrinsic: {
  69          nir_intrinsic_instr *intrin = nir_instr_as_intrinsic(instr);
  70
  71          switch (intrin->intrinsic) {
  72          case nir_intrinsic_load_deref: {
  73             nir_deref_instr *const deref = nir_src_as_deref(intrin->src[0]);
  74
  75             switch (deref->mode) {
  76             case nir_var_shader_in:
  77             case nir_var_uniform:
  78                /* Don't try to remove flow control around an indirect load
  79                 * because that flow control may be trying to avoid invalid
  80                 * loads.
  81                 */
  82                if (!indirect_load_ok && nir_deref_instr_has_indirect(deref))
  83                   return false;
  84
  85                break;
  86
  87             default:
  88                return false;
  89             }
  90             break;
  91          }
  92
  93          case nir_intrinsic_load_uniform:
  94             if (!alu_ok)
  95                return false;
  96             break;
  97
  98          default:
  99             return false;
 100          }
 101
 102          break;
 103       }
 104
 105       case nir_instr_type_deref:
 106       case nir_instr_type_load_const:
 107          break;
 108
 109       case nir_instr_type_alu: {
 110          nir_alu_instr *mov = nir_instr_as_alu(instr);
 111          bool movelike = false;
 112
 113          switch (mov->op) {
 114          case nir_op_mov:
 115          case nir_op_fneg:
 116          case nir_op_ineg:
 117          case nir_op_fabs:
 118          case nir_op_iabs:
 119          case nir_op_vec2:
 120          case nir_op_vec3:
 121          case nir_op_vec4:
 122             movelike = true;
 123             break;
 124
 125          case nir_op_fcos:
 126          case nir_op_fdiv:
 127          case nir_op_fexp2:
 128          case nir_op_flog2:
 129          case nir_op_fmod:
 130          case nir_op_fpow:
 131          case nir_op_frcp:
 132          case nir_op_frem:
 133          case nir_op_frsq:
 134          case nir_op_fsin:
 135          case nir_op_idiv:
 136          case nir_op_irem:
 137          case nir_op_udiv:
 138             if (!alu_ok || !expensive_alu_ok)
 139                return false;
 140
 141             break;
 142
 143          default:
 144             if (!alu_ok) {
 145                /* It must be a move-like operation. */
 146                return false;
 147             }
 148             break;
 149          }
 150
 151          /* It must be SSA */
 152          if (!mov->dest.dest.is_ssa)
 153             return false;
 154
 155          if (alu_ok) {
 156             /* If the ALU operation is an fsat or a move-like operation, do
 157              * not count it.  The expectation is that it will eventually be
 158              * merged as a destination modifier or source modifier on some
 159              * other instruction.
 160              */
 161             if (mov->op != nir_op_fsat && !movelike)
 162                (*count)++;
 163          } else {
 164             /* Can't handle saturate */
 165             if (mov->dest.saturate)
 166                return false;
 167
 168             /* It cannot have any if-uses */
 169             if (!list_is_empty(&mov->dest.dest.ssa.if_uses))
 170                return false;
 171
 172             /* The only uses of this definition must be phis in the successor */
 173             nir_foreach_use(use, &mov->dest.dest.ssa) {
 174                if (use->parent_instr->type != nir_instr_type_phi ||
 175                    use->parent_instr->block != block->successors[0])
 176                   return false;
 177             }
 178          }
 179          break;
 180       }
 181
 182       default:
 183          return false;
 184       }
 185    }
 186
 187    return true;
 188 }
 189
 190 static bool
 191 nir_opt_peephole_select_block(nir_block *block, nir_shader *shader,
 192                               unsigned limit, bool indirect_load_ok,
 193                               bool expensive_alu_ok)
 194 {
 195    if (nir_cf_node_is_first(&block->cf_node))
 196       return false;
 197
 198    nir_cf_node *prev_node = nir_cf_node_prev(&block->cf_node);
 199    if (prev_node->type != nir_cf_node_if)
 200       return false;
 201
 202    nir_if *if_stmt = nir_cf_node_as_if(prev_node);
 203
 204    if (if_stmt->control == nir_selection_control_dont_flatten)
 205       return false;
 206
 207    nir_block *then_block = nir_if_first_then_block(if_stmt);
 208    nir_block *else_block = nir_if_first_else_block(if_stmt);
 209
 210    /* We can only have one block in each side ... */
 211    if (nir_if_last_then_block(if_stmt) != then_block ||
 212        nir_if_last_else_block(if_stmt) != else_block)
 213       return false;
 214
 215    if (if_stmt->control == nir_selection_control_flatten) {
 216       /* Override driver defaults */
 217       indirect_load_ok = true;
 218       expensive_alu_ok = true;
 219    }
 220
 221    /* ... and those blocks must only contain "allowed" instructions. */
 222    unsigned count = 0;
 223    if (!block_check_for_allowed_instrs(then_block, &count, limit != 0,
 224                                        indirect_load_ok, expensive_alu_ok) ||
 225        !block_check_for_allowed_instrs(else_block, &count, limit != 0,
 226                                        indirect_load_ok, expensive_alu_ok))
 227       return false;
 228
 229    if (count > limit && if_stmt->control != nir_selection_control_flatten)
 230       return false;
 231
 232    /* At this point, we know that the previous CFG node is an if-then
 233     * statement containing only moves to phi nodes in this block.  We can
 234     * just remove that entire CF node and replace all of the phi nodes with
 235     * selects.
 236     */
 237
 238    nir_block *prev_block = nir_cf_node_as_block(nir_cf_node_prev(prev_node));
 239
 240    /* First, we move the remaining instructions from the blocks to the
 241     * block before.  We have already guaranteed that this is safe by
 242     * calling block_check_for_allowed_instrs()
 243     */
 244    nir_foreach_instr_safe(instr, then_block) {
 245       exec_node_remove(&instr->node);
 246       instr->block = prev_block;
 247       exec_list_push_tail(&prev_block->instr_list, &instr->node);
 248    }
 249
 250    nir_foreach_instr_safe(instr, else_block) {
 251       exec_node_remove(&instr->node);
 252       instr->block = prev_block;
 253       exec_list_push_tail(&prev_block->instr_list, &instr->node);
 254    }
 255
 256    nir_foreach_instr_safe(instr, block) {
 257       if (instr->type != nir_instr_type_phi)
 258          break;
 259
 260       nir_phi_instr *phi = nir_instr_as_phi(instr);
 261       nir_alu_instr *sel = nir_alu_instr_create(shader, nir_op_bcsel);
 262       nir_src_copy(&sel->src[0].src, &if_stmt->condition, sel);
 263       /* Splat the condition to all channels */
 264       memset(sel->src[0].swizzle, 0, sizeof sel->src[0].swizzle);
 265
 266       assert(exec_list_length(&phi->srcs) == 2);
 267       nir_foreach_phi_src(src, phi) {
 268          assert(src->pred == then_block || src->pred == else_block);
 269          assert(src->src.is_ssa);
 270
 271          unsigned idx = src->pred == then_block ? 1 : 2;
 272          nir_src_copy(&sel->src[idx].src, &src->src, sel);
 273       }
 274
 275       nir_ssa_dest_init(&sel->instr, &sel->dest.dest,
 276                         phi->dest.ssa.num_components,
 277                         phi->dest.ssa.bit_size, phi->dest.ssa.name);
 278       sel->dest.write_mask = (1 << phi->dest.ssa.num_components) - 1;
 279
 280       nir_ssa_def_rewrite_uses(&phi->dest.ssa,
 281                                nir_src_for_ssa(&sel->dest.dest.ssa));
 282
 283       nir_instr_insert_before(&phi->instr, &sel->instr);
 284       nir_instr_remove(&phi->instr);
 285    }
 286
 287    nir_cf_node_remove(&if_stmt->cf_node);
 288    return true;
 289 }
 290
 291 static bool
 292 nir_opt_peephole_select_impl(nir_function_impl *impl, unsigned limit,
 293                              bool indirect_load_ok, bool expensive_alu_ok)
 294 {
 295    nir_shader *shader = impl->function->shader;
 296    bool progress = false;
 297
 298    nir_foreach_block_safe(block, impl) {
 299       progress |= nir_opt_peephole_select_block(block, shader, limit,
 300                                                 indirect_load_ok,
 301                                                 expensive_alu_ok);
 302    }
 303
 304    if (progress) {
 305       nir_metadata_preserve(impl, nir_metadata_none);
 306    } else {
 307 #ifndef NDEBUG
 308       impl->valid_metadata &= ~nir_metadata_not_properly_reset;
 309 #endif
 310    }
 311
 312    return progress;
 313 }
 314
 315 bool
 316 nir_opt_peephole_select(nir_shader *shader, unsigned limit,
 317                         bool indirect_load_ok, bool expensive_alu_ok)
 318 {
 319    bool progress = false;
 320
 321    nir_foreach_function(function, shader) {
 322       if (function->impl)
 323          progress |= nir_opt_peephole_select_impl(function->impl, limit,
 324                                                   indirect_load_ok,
 325                                                   expensive_alu_ok);
 326    }
 327
 328    return progress;
 329 }