src/compiler/nir/nir_propagate_invariant.c

   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
  21  * DEALINGS IN THE SOFTWARE.
  22  */
  23
  24 #include "nir.h"
  25
  26 static void
  27 add_src(nir_src *src, struct set *invariants)
  28 {
  29    if (src->is_ssa) {
  30       _mesa_set_add(invariants, src->ssa);
  31    } else {
  32       _mesa_set_add(invariants, src->reg.reg);
  33    }
  34 }
  35
  36 static bool
  37 add_src_cb(nir_src *src, void *state)
  38 {
  39    add_src(src, state);
  40    return true;
  41 }
  42
  43 static bool
  44 dest_is_invariant(nir_dest *dest, struct set *invariants)
  45 {
  46    if (dest->is_ssa) {
  47       return _mesa_set_search(invariants, &dest->ssa);
  48    } else {
  49       return _mesa_set_search(invariants, dest->reg.reg);
  50    }
  51 }
  52
  53 static void
  54 add_cf_node(nir_cf_node *cf, struct set *invariants)
  55 {
  56    if (cf->type == nir_cf_node_if) {
  57       nir_if *if_stmt = nir_cf_node_as_if(cf);
  58       add_src(&if_stmt->condition, invariants);
  59    }
  60
  61    if (cf->parent)
  62       add_cf_node(cf->parent, invariants);
  63 }
  64
  65 static void
  66 add_var(nir_variable *var, struct set *invariants)
  67 {
  68    _mesa_set_add(invariants, var);
  69 }
  70
  71 static bool
  72 var_is_invariant(nir_variable *var, struct set * invariants)
  73 {
  74    return var->data.invariant || _mesa_set_search(invariants, var);
  75 }
  76
  77 static nir_variable *
  78 intrinsic_get_var(nir_intrinsic_instr *intrin, unsigned i)
  79 {
  80    if (nir_intrinsic_infos[intrin->intrinsic].num_variables == 0)
  81       return nir_deref_instr_get_variable(nir_src_as_deref(intrin->src[i]));
  82    else
  83       return intrin->variables[i]->var;
  84 }
  85
  86 static void
  87 propagate_invariant_instr(nir_instr *instr, struct set *invariants)
  88 {
  89    switch (instr->type) {
  90    case nir_instr_type_alu: {
  91       nir_alu_instr *alu = nir_instr_as_alu(instr);
  92       if (!dest_is_invariant(&alu->dest.dest, invariants))
  93          break;
  94
  95       alu->exact = true;
  96       nir_foreach_src(instr, add_src_cb, invariants);
  97       break;
  98    }
  99
 100    case nir_instr_type_tex: {
 101       nir_tex_instr *tex = nir_instr_as_tex(instr);
 102       if (dest_is_invariant(&tex->dest, invariants))
 103          nir_foreach_src(instr, add_src_cb, invariants);
 104       break;
 105    }
 106
 107    case nir_instr_type_intrinsic: {
 108       nir_intrinsic_instr *intrin = nir_instr_as_intrinsic(instr);
 109       switch (intrin->intrinsic) {
 110       case nir_intrinsic_copy_var:
 111       case nir_intrinsic_copy_deref:
 112          /* If the destination is invariant then so is the source */
 113          if (var_is_invariant(intrinsic_get_var(intrin, 0), invariants))
 114             add_var(intrinsic_get_var(intrin, 1), invariants);
 115          break;
 116
 117       case nir_intrinsic_load_var:
 118       case nir_intrinsic_load_deref:
 119          if (dest_is_invariant(&intrin->dest, invariants))
 120             add_var(intrinsic_get_var(intrin, 0), invariants);
 121          break;
 122
 123       case nir_intrinsic_store_var:
 124          if (var_is_invariant(intrin->variables[0]->var, invariants))
 125             add_src(&intrin->src[0], invariants);
 126          break;
 127
 128       case nir_intrinsic_store_deref:
 129          if (var_is_invariant(intrinsic_get_var(intrin, 0), invariants))
 130             add_src(&intrin->src[1], invariants);
 131          break;
 132
 133       default:
 134          /* Nothing to do */
 135          break;
 136       }
 137    }
 138
 139    case nir_instr_type_deref:
 140    case nir_instr_type_jump:
 141    case nir_instr_type_ssa_undef:
 142    case nir_instr_type_load_const:
 143       break; /* Nothing to do */
 144
 145    case nir_instr_type_phi: {
 146       nir_phi_instr *phi = nir_instr_as_phi(instr);
 147       if (!dest_is_invariant(&phi->dest, invariants))
 148          break;
 149
 150       nir_foreach_phi_src(src, phi) {
 151          add_src(&src->src, invariants);
 152          add_cf_node(&src->pred->cf_node, invariants);
 153       }
 154       break;
 155    }
 156
 157    case nir_instr_type_call:
 158       unreachable("This pass must be run after function inlining");
 159
 160    case nir_instr_type_parallel_copy:
 161    default:
 162       unreachable("Cannot have this instruction type");
 163    }
 164 }
 165
 166 static bool
 167 propagate_invariant_impl(nir_function_impl *impl, struct set *invariants)
 168 {
 169    bool progress = false;
 170
 171    while (true) {
 172       uint32_t prev_entries = invariants->entries;
 173
 174       nir_foreach_block_reverse(block, impl) {
 175          nir_foreach_instr_reverse(instr, block)
 176             propagate_invariant_instr(instr, invariants);
 177       }
 178
 179       /* Keep running until we make no more progress. */
 180       if (invariants->entries > prev_entries) {
 181          progress = true;
 182          continue;
 183       } else {
 184          break;
 185       }
 186    }
 187
 188    if (progress) {
 189       nir_metadata_preserve(impl, nir_metadata_block_index |
 190                                   nir_metadata_dominance |
 191                                   nir_metadata_live_ssa_defs);
 192    }
 193
 194    return progress;
 195 }
 196
 197 bool
 198 nir_propagate_invariant(nir_shader *shader)
 199 {
 200    /* Hash set of invariant things */
 201    struct set *invariants = _mesa_set_create(NULL, _mesa_hash_pointer,
 202                                              _mesa_key_pointer_equal);
 203
 204    bool progress = false;
 205    nir_foreach_function(function, shader) {
 206       if (function->impl && propagate_invariant_impl(function->impl, invariants))
 207          progress = true;
 208    }
 209
 210    _mesa_set_destroy(invariants, NULL);
 211
 212    return progress;
 213 }