src/compiler/nir/nir_lower_system_values.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  *    Connor Abbott (cwabbott0@gmail.com)
  25  *
  26  */
  27
  28 #include "nir.h"
  29 #include "nir_builder.h"
  30
  31 static bool
  32 convert_block(nir_block *block, nir_builder *b)
  33 {
  34    bool progress = false;
  35
  36    nir_foreach_instr_safe(instr, block) {
  37       if (instr->type != nir_instr_type_intrinsic)
  38          continue;
  39
  40       nir_intrinsic_instr *load_var = nir_instr_as_intrinsic(instr);
  41
  42       if (load_var->intrinsic != nir_intrinsic_load_var)
  43          continue;
  44
  45       nir_variable *var = load_var->variables[0]->var;
  46       if (var->data.mode != nir_var_system_value)
  47          continue;
  48
  49       b->cursor = nir_after_instr(&load_var->instr);
  50
  51       nir_ssa_def *sysval = NULL;
  52       switch (var->data.location) {
  53       case SYSTEM_VALUE_GLOBAL_INVOCATION_ID: {
  54          /* From the GLSL man page for gl_GlobalInvocationID:
  55           *
  56           *    "The value of gl_GlobalInvocationID is equal to
  57           *    gl_WorkGroupID * gl_WorkGroupSize + gl_LocalInvocationID"
  58           */
  59
  60          nir_const_value local_size;
  61          memset(&local_size, 0, sizeof(local_size));
  62          local_size.u32[0] = b->shader->info.cs.local_size[0];
  63          local_size.u32[1] = b->shader->info.cs.local_size[1];
  64          local_size.u32[2] = b->shader->info.cs.local_size[2];
  65
  66          nir_ssa_def *group_id = nir_load_work_group_id(b);
  67          nir_ssa_def *local_id = nir_load_local_invocation_id(b);
  68
  69          sysval = nir_iadd(b, nir_imul(b, group_id,
  70                                        nir_build_imm(b, 3, 32, local_size)),
  71                               local_id);
  72          break;
  73       }
  74
  75       case SYSTEM_VALUE_LOCAL_INVOCATION_INDEX: {
  76          /* If lower_cs_local_index_from_id is true, then we derive the local
  77           * index from the local id.
  78           */
  79          if (!b->shader->options->lower_cs_local_index_from_id)
  80             break;
  81
  82          /* From the GLSL man page for gl_LocalInvocationIndex:
  83           *
  84           *    "The value of gl_LocalInvocationIndex is equal to
  85           *    gl_LocalInvocationID.z * gl_WorkGroupSize.x *
  86           *    gl_WorkGroupSize.y + gl_LocalInvocationID.y *
  87           *    gl_WorkGroupSize.x + gl_LocalInvocationID.x"
  88           */
  89          nir_ssa_def *local_id = nir_load_local_invocation_id(b);
  90
  91          nir_ssa_def *size_x =
  92             nir_imm_int(b, b->shader->info.cs.local_size[0]);
  93          nir_ssa_def *size_y =
  94             nir_imm_int(b, b->shader->info.cs.local_size[1]);
  95
  96          sysval = nir_imul(b, nir_channel(b, local_id, 2),
  97                               nir_imul(b, size_x, size_y));
  98          sysval = nir_iadd(b, sysval,
  99                               nir_imul(b, nir_channel(b, local_id, 1), size_x));
 100          sysval = nir_iadd(b, sysval, nir_channel(b, local_id, 0));
 101          break;
 102       }
 103
 104       case SYSTEM_VALUE_LOCAL_GROUP_SIZE: {
 105          nir_const_value local_size;
 106          memset(&local_size, 0, sizeof(local_size));
 107          local_size.u32[0] = b->shader->info.cs.local_size[0];
 108          local_size.u32[1] = b->shader->info.cs.local_size[1];
 109          local_size.u32[2] = b->shader->info.cs.local_size[2];
 110          sysval = nir_build_imm(b, 3, 32, local_size);
 111          break;
 112       }
 113
 114       case SYSTEM_VALUE_VERTEX_ID:
 115          if (b->shader->options->vertex_id_zero_based) {
 116             sysval = nir_iadd(b,
 117                               nir_load_vertex_id_zero_base(b),
 118                               nir_load_first_vertex(b));
 119          } else {
 120             sysval = nir_load_vertex_id(b);
 121          }
 122          break;
 123
 124       case SYSTEM_VALUE_BASE_VERTEX:
 125          /**
 126           * From the OpenGL 4.6 (11.1.3.9 Shader Inputs) specification:
 127           *
 128           * "gl_BaseVertex holds the integer value passed to the baseVertex
 129           * parameter to the command that resulted in the current shader
 130           * invocation. In the case where the command has no baseVertex
 131           * parameter, the value of gl_BaseVertex is zero."
 132           */
 133          if (b->shader->options->lower_base_vertex)
 134             sysval = nir_iand(b,
 135                               nir_load_is_indexed_draw(b),
 136                               nir_load_first_vertex(b));
 137          break;
 138
 139       case SYSTEM_VALUE_INSTANCE_INDEX:
 140          sysval = nir_iadd(b,
 141                            nir_load_instance_id(b),
 142                            nir_load_base_instance(b));
 143          break;
 144
 145       case SYSTEM_VALUE_SUBGROUP_EQ_MASK:
 146       case SYSTEM_VALUE_SUBGROUP_GE_MASK:
 147       case SYSTEM_VALUE_SUBGROUP_GT_MASK:
 148       case SYSTEM_VALUE_SUBGROUP_LE_MASK:
 149       case SYSTEM_VALUE_SUBGROUP_LT_MASK: {
 150          nir_intrinsic_op op =
 151             nir_intrinsic_from_system_value(var->data.location);
 152          nir_intrinsic_instr *load = nir_intrinsic_instr_create(b->shader, op);
 153          nir_ssa_dest_init_for_type(&load->instr, &load->dest,
 154                                     var->type, NULL);
 155          load->num_components = load->dest.ssa.num_components;
 156          nir_builder_instr_insert(b, &load->instr);
 157          sysval = &load->dest.ssa;
 158          break;
 159       }
 160
 161       case SYSTEM_VALUE_DEVICE_INDEX:
 162          if (b->shader->options->lower_device_index_to_zero)
 163             sysval = nir_imm_int(b, 0);
 164          break;
 165
 166       default:
 167          break;
 168       }
 169
 170       if (sysval == NULL) {
 171          nir_intrinsic_op sysval_op =
 172             nir_intrinsic_from_system_value(var->data.location);
 173          sysval = nir_load_system_value(b, sysval_op, 0);
 174       }
 175
 176       nir_ssa_def_rewrite_uses(&load_var->dest.ssa, nir_src_for_ssa(sysval));
 177       nir_instr_remove(&load_var->instr);
 178
 179       progress = true;
 180    }
 181
 182    return progress;
 183 }
 184
 185 static bool
 186 convert_impl(nir_function_impl *impl)
 187 {
 188    bool progress = false;
 189    nir_builder builder;
 190    nir_builder_init(&builder, impl);
 191
 192    nir_foreach_block(block, impl) {
 193       progress |= convert_block(block, &builder);
 194    }
 195
 196    nir_metadata_preserve(impl, nir_metadata_block_index |
 197                                nir_metadata_dominance);
 198    return progress;
 199 }
 200
 201 bool
 202 nir_lower_system_values(nir_shader *shader)
 203 {
 204    bool progress = false;
 205
 206    nir_foreach_function(function, shader) {
 207       if (function->impl)
 208          progress = convert_impl(function->impl) || progress;
 209    }
 210
 211    exec_list_make_empty(&shader->system_values);
 212
 213    return progress;
 214 }