src/compiler/nir/nir_lower_indirect_derefs.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 DEALINGS
  21  * IN THE SOFTWARE.
  22  */
  23
  24 #include "nir.h"
  25 #include "nir_builder.h"
  26
  27 static void
  28 emit_load_store(nir_builder *b, nir_intrinsic_instr *orig_instr,
  29                 nir_deref_var *deref, nir_deref *tail,
  30                 nir_ssa_def **dest, nir_ssa_def *src);
  31
  32 static void
  33 emit_indirect_load_store(nir_builder *b, nir_intrinsic_instr *orig_instr,
  34                          nir_deref_var *deref, nir_deref *arr_parent,
  35                          int start, int end,
  36                          nir_ssa_def **dest, nir_ssa_def *src)
  37 {
  38    nir_deref_array *arr = nir_deref_as_array(arr_parent->child);
  39    assert(arr->deref_array_type == nir_deref_array_type_indirect);
  40    assert(arr->indirect.is_ssa);
  41
  42    assert(start < end);
  43    if (start == end - 1) {
  44       /* Base case.  Just emit the load/store op */
  45       nir_deref_array direct = *arr;
  46       direct.deref_array_type = nir_deref_array_type_direct;
  47       direct.base_offset += start;
  48       direct.indirect = NIR_SRC_INIT;
  49
  50       arr_parent->child = &direct.deref;
  51       emit_load_store(b, orig_instr, deref, &direct.deref, dest, src);
  52       arr_parent->child = &arr->deref;
  53    } else {
  54       int mid = start + (end - start) / 2;
  55
  56       nir_ssa_def *then_dest, *else_dest;
  57
  58       nir_push_if(b, nir_ilt(b, arr->indirect.ssa, nir_imm_int(b, mid)));
  59       emit_indirect_load_store(b, orig_instr, deref, arr_parent,
  60                                start, mid, &then_dest, src);
  61       nir_push_else(b, NULL);
  62       emit_indirect_load_store(b, orig_instr, deref, arr_parent,
  63                                mid, end, &else_dest, src);
  64       nir_pop_if(b, NULL);
  65
  66       if (src == NULL)
  67          *dest = nir_if_phi(b, then_dest, else_dest);
  68    }
  69 }
  70
  71 static void
  72 emit_load_store(nir_builder *b, nir_intrinsic_instr *orig_instr,
  73                 nir_deref_var *deref, nir_deref *tail,
  74                 nir_ssa_def **dest, nir_ssa_def *src)
  75 {
  76    for (; tail->child; tail = tail->child) {
  77       if (tail->child->deref_type != nir_deref_type_array)
  78          continue;
  79
  80       nir_deref_array *arr = nir_deref_as_array(tail->child);
  81       if (arr->deref_array_type != nir_deref_array_type_indirect)
  82          continue;
  83
  84       int length = glsl_get_length(tail->type);
  85
  86       emit_indirect_load_store(b, orig_instr, deref, tail, -arr->base_offset,
  87                                length - arr->base_offset, dest, src);
  88       return;
  89    }
  90
  91    assert(tail && tail->child == NULL);
  92
  93    /* We reached the end of the deref chain.  Emit the instruction */
  94
  95    if (src == NULL) {
  96       /* This is a load instruction */
  97       nir_intrinsic_instr *load =
  98          nir_intrinsic_instr_create(b->shader, nir_intrinsic_load_var);
  99       load->num_components = orig_instr->num_components;
 100       load->variables[0] = nir_deref_var_clone(deref, load);
 101       unsigned bit_size = orig_instr->dest.ssa.bit_size;
 102       nir_ssa_dest_init(&load->instr, &load->dest,
 103                         load->num_components, bit_size, NULL);
 104       nir_builder_instr_insert(b, &load->instr);
 105       *dest = &load->dest.ssa;
 106    } else {
 107       /* This is a store instruction */
 108       nir_intrinsic_instr *store =
 109          nir_intrinsic_instr_create(b->shader, nir_intrinsic_store_var);
 110       store->num_components = orig_instr->num_components;
 111       nir_intrinsic_set_write_mask(store, nir_intrinsic_write_mask(orig_instr));
 112       store->variables[0] = nir_deref_var_clone(deref, store);
 113       store->src[0] = nir_src_for_ssa(src);
 114       nir_builder_instr_insert(b, &store->instr);
 115    }
 116 }
 117
 118 static bool
 119 deref_has_indirect(nir_deref_var *deref)
 120 {
 121    for (nir_deref *tail = deref->deref.child; tail; tail = tail->child) {
 122       if (tail->deref_type != nir_deref_type_array)
 123          continue;
 124
 125       nir_deref_array *arr = nir_deref_as_array(tail);
 126       if (arr->deref_array_type == nir_deref_array_type_indirect)
 127          return true;
 128    }
 129
 130    return false;
 131 }
 132
 133 static bool
 134 lower_indirect_block(nir_block *block, nir_builder *b,
 135                      nir_variable_mode modes)
 136 {
 137    bool progress = false;
 138
 139    nir_foreach_instr_safe(instr, block) {
 140       if (instr->type != nir_instr_type_intrinsic)
 141          continue;
 142
 143       nir_intrinsic_instr *intrin = nir_instr_as_intrinsic(instr);
 144       if (intrin->intrinsic != nir_intrinsic_load_var &&
 145           intrin->intrinsic != nir_intrinsic_store_var)
 146          continue;
 147
 148       if (!deref_has_indirect(intrin->variables[0]))
 149          continue;
 150
 151       /* Only lower variables whose mode is in the mask, or compact
 152        * array variables.  (We can't handle indirects on tightly packed
 153        * scalar arrays, so we need to lower them regardless.)
 154        */
 155       if (!(modes & intrin->variables[0]->var->data.mode) &&
 156           !intrin->variables[0]->var->data.compact)
 157          continue;
 158
 159       b->cursor = nir_before_instr(&intrin->instr);
 160
 161       if (intrin->intrinsic == nir_intrinsic_load_var) {
 162          nir_ssa_def *result;
 163          emit_load_store(b, intrin, intrin->variables[0],
 164                          &intrin->variables[0]->deref, &result, NULL);
 165          nir_ssa_def_rewrite_uses(&intrin->dest.ssa, nir_src_for_ssa(result));
 166       } else {
 167          assert(intrin->src[0].is_ssa);
 168          emit_load_store(b, intrin, intrin->variables[0],
 169                          &intrin->variables[0]->deref, NULL, intrin->src[0].ssa);
 170       }
 171       nir_instr_remove(&intrin->instr);
 172       progress = true;
 173    }
 174
 175    return progress;
 176 }
 177
 178 static bool
 179 lower_indirects_impl(nir_function_impl *impl, nir_variable_mode modes)
 180 {
 181    nir_builder builder;
 182    nir_builder_init(&builder, impl);
 183    bool progress = false;
 184
 185    nir_foreach_block_safe(block, impl) {
 186       progress |= lower_indirect_block(block, &builder, modes);
 187    }
 188
 189    if (progress)
 190       nir_metadata_preserve(impl, nir_metadata_none);
 191
 192    return progress;
 193 }
 194
 195 /** Lowers indirect variable loads/stores to direct loads/stores.
 196  *
 197  * The pass works by replacing any indirect load or store with an if-ladder
 198  * that does a binary search on the array index.
 199  */
 200 bool
 201 nir_lower_indirect_derefs(nir_shader *shader, nir_variable_mode modes)
 202 {
 203    bool progress = false;
 204
 205    nir_foreach_function(function, shader) {
 206       if (function->impl)
 207          progress = lower_indirects_impl(function->impl, modes) || progress;
 208    }
 209
 210    return progress;
 211 }