src/freedreno/vulkan/tu_shader.c

   1 /*
   2  * Copyright © 2019 Google LLC
   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 "tu_private.h"
  25
  26 #include "spirv/nir_spirv.h"
  27 #include "util/mesa-sha1.h"
  28
  29 #include "ir3/ir3_nir.h"
  30
  31 static nir_shader *
  32 tu_spirv_to_nir(struct ir3_compiler *compiler,
  33                 const uint32_t *words,
  34                 size_t word_count,
  35                 gl_shader_stage stage,
  36                 const char *entry_point_name,
  37                 const VkSpecializationInfo *spec_info)
  38 {
  39    /* TODO these are made-up */
  40    const struct spirv_to_nir_options spirv_options = {
  41       .frag_coord_is_sysval = true,
  42       .lower_ubo_ssbo_access_to_offsets = true,
  43       .caps = { false },
  44    };
  45    const nir_shader_compiler_options *nir_options =
  46       ir3_get_compiler_options(compiler);
  47
  48    /* convert VkSpecializationInfo */
  49    struct nir_spirv_specialization *spec = NULL;
  50    uint32_t num_spec = 0;
  51    if (spec_info && spec_info->mapEntryCount) {
  52       spec = malloc(sizeof(*spec) * spec_info->mapEntryCount);
  53       if (!spec)
  54          return NULL;
  55
  56       for (uint32_t i = 0; i < spec_info->mapEntryCount; i++) {
  57          const VkSpecializationMapEntry *entry = &spec_info->pMapEntries[i];
  58          const void *data = spec_info->pData + entry->offset;
  59          assert(data + entry->size <= spec_info->pData + spec_info->dataSize);
  60          spec[i].id = entry->constantID;
  61          if (entry->size == 8)
  62             spec[i].data64 = *(const uint64_t *) data;
  63          else
  64             spec[i].data32 = *(const uint32_t *) data;
  65          spec[i].defined_on_module = false;
  66       }
  67
  68       num_spec = spec_info->mapEntryCount;
  69    }
  70
  71    nir_shader *nir =
  72       spirv_to_nir(words, word_count, spec, num_spec, stage, entry_point_name,
  73                    &spirv_options, nir_options);
  74
  75    free(spec);
  76
  77    assert(nir->info.stage == stage);
  78    nir_validate_shader(nir, "after spirv_to_nir");
  79
  80    return nir;
  81 }
  82
  83 static void
  84 tu_sort_variables_by_location(struct exec_list *variables)
  85 {
  86    struct exec_list sorted;
  87    exec_list_make_empty(&sorted);
  88
  89    nir_foreach_variable_safe(var, variables)
  90    {
  91       exec_node_remove(&var->node);
  92
  93       /* insert the variable into the sorted list */
  94       nir_variable *next = NULL;
  95       nir_foreach_variable(tmp, &sorted)
  96       {
  97          if (var->data.location < tmp->data.location) {
  98             next = tmp;
  99             break;
 100          }
 101       }
 102       if (next)
 103          exec_node_insert_node_before(&next->node, &var->node);
 104       else
 105          exec_list_push_tail(&sorted, &var->node);
 106    }
 107
 108    exec_list_move_nodes_to(&sorted, variables);
 109 }
 110
 111 static unsigned
 112 map_add(struct tu_descriptor_map *map, int set, int binding)
 113 {
 114    unsigned index;
 115    for (index = 0; index < map->num; index++) {
 116       if (set == map->set[index] && binding == map->binding[index])
 117          break;
 118    }
 119
 120    assert(index < ARRAY_SIZE(map->set));
 121
 122    map->set[index] = set;
 123    map->binding[index] = binding;
 124    map->num = MAX2(map->num, index + 1);
 125    return index;
 126 }
 127
 128 static void
 129 lower_tex_src_to_offset(nir_builder *b, nir_tex_instr *instr, unsigned src_idx,
 130                         struct tu_shader *shader)
 131 {
 132    nir_ssa_def *index = NULL;
 133    unsigned base_index = 0;
 134    unsigned array_elements = 1;
 135    nir_tex_src *src = &instr->src[src_idx];
 136    bool is_sampler = src->src_type == nir_tex_src_sampler_deref;
 137
 138    /* We compute first the offsets */
 139    nir_deref_instr *deref = nir_instr_as_deref(src->src.ssa->parent_instr);
 140    while (deref->deref_type != nir_deref_type_var) {
 141       assert(deref->parent.is_ssa);
 142       nir_deref_instr *parent =
 143          nir_instr_as_deref(deref->parent.ssa->parent_instr);
 144
 145       assert(deref->deref_type == nir_deref_type_array);
 146
 147       if (nir_src_is_const(deref->arr.index) && index == NULL) {
 148          /* We're still building a direct index */
 149          base_index += nir_src_as_uint(deref->arr.index) * array_elements;
 150       } else {
 151          if (index == NULL) {
 152             /* We used to be direct but not anymore */
 153             index = nir_imm_int(b, base_index);
 154             base_index = 0;
 155          }
 156
 157          index = nir_iadd(b, index,
 158                           nir_imul(b, nir_imm_int(b, array_elements),
 159                                    nir_ssa_for_src(b, deref->arr.index, 1)));
 160       }
 161
 162       array_elements *= glsl_get_length(parent->type);
 163
 164       deref = parent;
 165    }
 166
 167    if (index)
 168       index = nir_umin(b, index, nir_imm_int(b, array_elements - 1));
 169
 170    /* We have the offsets, we apply them, rewriting the source or removing
 171     * instr if needed
 172     */
 173    if (index) {
 174       nir_instr_rewrite_src(&instr->instr, &src->src,
 175                             nir_src_for_ssa(index));
 176
 177       src->src_type = is_sampler ?
 178          nir_tex_src_sampler_offset :
 179          nir_tex_src_texture_offset;
 180
 181       instr->texture_array_size = array_elements;
 182    } else {
 183       nir_tex_instr_remove_src(instr, src_idx);
 184    }
 185
 186    if (array_elements > 1)
 187       tu_finishme("texture/sampler array");
 188
 189    if (is_sampler) {
 190       instr->sampler_index = map_add(&shader->sampler_map,
 191                                      deref->var->data.descriptor_set,
 192                                      deref->var->data.binding);
 193       instr->sampler_index += base_index;
 194    } else {
 195       instr->texture_index = map_add(&shader->texture_map,
 196                                      deref->var->data.descriptor_set,
 197                                      deref->var->data.binding);
 198       instr->texture_index += base_index;
 199       instr->texture_array_size = array_elements;
 200    }
 201 }
 202
 203 static bool
 204 lower_sampler(nir_builder *b, nir_tex_instr *instr, struct tu_shader *shader)
 205 {
 206    int texture_idx =
 207       nir_tex_instr_src_index(instr, nir_tex_src_texture_deref);
 208
 209    if (texture_idx >= 0)
 210       lower_tex_src_to_offset(b, instr, texture_idx, shader);
 211
 212    int sampler_idx =
 213       nir_tex_instr_src_index(instr, nir_tex_src_sampler_deref);
 214
 215    if (sampler_idx >= 0)
 216       lower_tex_src_to_offset(b, instr, sampler_idx, shader);
 217
 218    if (texture_idx < 0 && sampler_idx < 0)
 219       return false;
 220
 221    return true;
 222 }
 223
 224 static bool
 225 lower_intrinsic(nir_builder *b, nir_intrinsic_instr *instr,
 226                 struct tu_shader *shader)
 227 {
 228    if (instr->intrinsic != nir_intrinsic_vulkan_resource_index)
 229       return false;
 230
 231    nir_const_value *const_val = nir_src_as_const_value(instr->src[0]);
 232    if (!const_val || const_val->u32 != 0) {
 233       tu_finishme("non-zero vulkan_resource_index array index");
 234       return false;
 235    }
 236
 237    if (nir_intrinsic_desc_type(instr) != VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER) {
 238       tu_finishme("non-ubo vulkan_resource_index");
 239       return false;
 240    }
 241
 242    unsigned index = map_add(&shader->ubo_map,
 243                             nir_intrinsic_desc_set(instr),
 244                             nir_intrinsic_binding(instr));
 245
 246    b->cursor = nir_before_instr(&instr->instr);
 247    /* skip index 0 because ir3 treats it differently */
 248    nir_ssa_def_rewrite_uses(&instr->dest.ssa,
 249                             nir_src_for_ssa(nir_imm_int(b, index + 1)));
 250    nir_instr_remove(&instr->instr);
 251
 252    return true;
 253 }
 254
 255 static bool
 256 lower_impl(nir_function_impl *impl, struct tu_shader *shader)
 257 {
 258    nir_builder b;
 259    nir_builder_init(&b, impl);
 260    bool progress = false;
 261
 262    nir_foreach_block(block, impl) {
 263       nir_foreach_instr_safe(instr, block) {
 264          switch (instr->type) {
 265          case nir_instr_type_tex:
 266             progress |= lower_sampler(&b, nir_instr_as_tex(instr), shader);
 267             break;
 268          case nir_instr_type_intrinsic:
 269             progress |= lower_intrinsic(&b, nir_instr_as_intrinsic(instr), shader);
 270             break;
 271          default:
 272             break;
 273          }
 274       }
 275    }
 276
 277    return progress;
 278 }
 279
 280 static bool
 281 tu_lower_io(nir_shader *shader, struct tu_shader *tu_shader)
 282 {
 283    bool progress = false;
 284
 285    nir_foreach_function(function, shader) {
 286       if (function->impl)
 287          progress |= lower_impl(function->impl, tu_shader);
 288    }
 289
 290    return progress;
 291 }
 292
 293 struct tu_shader *
 294 tu_shader_create(struct tu_device *dev,
 295                  gl_shader_stage stage,
 296                  const VkPipelineShaderStageCreateInfo *stage_info,
 297                  const VkAllocationCallbacks *alloc)
 298 {
 299    const struct tu_shader_module *module =
 300       tu_shader_module_from_handle(stage_info->module);
 301    struct tu_shader *shader;
 302
 303    const uint32_t max_variant_count = (stage == MESA_SHADER_VERTEX) ? 2 : 1;
 304    shader = vk_zalloc2(
 305       &dev->alloc, alloc,
 306       sizeof(*shader) + sizeof(struct ir3_shader_variant) * max_variant_count,
 307       8, VK_SYSTEM_ALLOCATION_SCOPE_COMMAND);
 308    if (!shader)
 309       return NULL;
 310
 311    /* translate SPIR-V to NIR */
 312    assert(module->code_size % 4 == 0);
 313    nir_shader *nir = tu_spirv_to_nir(
 314       dev->compiler, (const uint32_t *) module->code, module->code_size / 4,
 315       stage, stage_info->pName, stage_info->pSpecializationInfo);
 316    if (!nir) {
 317       vk_free2(&dev->alloc, alloc, shader);
 318       return NULL;
 319    }
 320
 321    if (unlikely(dev->physical_device->instance->debug_flags & TU_DEBUG_NIR)) {
 322       fprintf(stderr, "translated nir:\n");
 323       nir_print_shader(nir, stderr);
 324    }
 325
 326    /* multi step inlining procedure */
 327    NIR_PASS_V(nir, nir_lower_constant_initializers, nir_var_function_temp);
 328    NIR_PASS_V(nir, nir_lower_returns);
 329    NIR_PASS_V(nir, nir_inline_functions);
 330    NIR_PASS_V(nir, nir_opt_deref);
 331    foreach_list_typed_safe(nir_function, func, node, &nir->functions) {
 332       if (!func->is_entrypoint)
 333          exec_node_remove(&func->node);
 334    }
 335    assert(exec_list_length(&nir->functions) == 1);
 336    NIR_PASS_V(nir, nir_lower_constant_initializers, ~nir_var_function_temp);
 337
 338    /* Split member structs.  We do this before lower_io_to_temporaries so that
 339     * it doesn't lower system values to temporaries by accident.
 340     */
 341    NIR_PASS_V(nir, nir_split_var_copies);
 342    NIR_PASS_V(nir, nir_split_per_member_structs);
 343
 344    NIR_PASS_V(nir, nir_remove_dead_variables,
 345               nir_var_shader_in | nir_var_shader_out | nir_var_system_value | nir_var_mem_shared);
 346
 347    NIR_PASS_V(nir, nir_propagate_invariant);
 348
 349    NIR_PASS_V(nir, nir_lower_io_to_temporaries, nir_shader_get_entrypoint(nir), true, true);
 350
 351    NIR_PASS_V(nir, nir_lower_global_vars_to_local);
 352    NIR_PASS_V(nir, nir_split_var_copies);
 353    NIR_PASS_V(nir, nir_lower_var_copies);
 354
 355    NIR_PASS_V(nir, nir_opt_copy_prop_vars);
 356    NIR_PASS_V(nir, nir_opt_combine_stores, nir_var_all);
 357
 358    /* ir3 doesn't support indirect input/output */
 359    NIR_PASS_V(nir, nir_lower_indirect_derefs, nir_var_shader_in | nir_var_shader_out);
 360
 361    switch (stage) {
 362    case MESA_SHADER_VERTEX:
 363       tu_sort_variables_by_location(&nir->outputs);
 364       break;
 365    case MESA_SHADER_TESS_CTRL:
 366    case MESA_SHADER_TESS_EVAL:
 367    case MESA_SHADER_GEOMETRY:
 368       tu_sort_variables_by_location(&nir->inputs);
 369       tu_sort_variables_by_location(&nir->outputs);
 370       break;
 371    case MESA_SHADER_FRAGMENT:
 372       tu_sort_variables_by_location(&nir->inputs);
 373       break;
 374    case MESA_SHADER_COMPUTE:
 375       break;
 376    default:
 377       unreachable("invalid gl_shader_stage");
 378       break;
 379    }
 380
 381    nir_assign_io_var_locations(&nir->inputs, &nir->num_inputs, stage);
 382    nir_assign_io_var_locations(&nir->outputs, &nir->num_outputs, stage);
 383
 384    NIR_PASS_V(nir, nir_lower_system_values);
 385    NIR_PASS_V(nir, nir_lower_frexp);
 386
 387    NIR_PASS_V(nir, tu_lower_io, shader);
 388
 389    NIR_PASS_V(nir, nir_lower_io, nir_var_all, ir3_glsl_type_size, 0);
 390
 391    if (stage == MESA_SHADER_FRAGMENT) {
 392       /* NOTE: lower load_barycentric_at_sample first, since it
 393        * produces load_barycentric_at_offset:
 394        */
 395       NIR_PASS_V(nir, ir3_nir_lower_load_barycentric_at_sample);
 396       NIR_PASS_V(nir, ir3_nir_lower_load_barycentric_at_offset);
 397
 398       NIR_PASS_V(nir, ir3_nir_move_varying_inputs);
 399    }
 400
 401    NIR_PASS_V(nir, nir_lower_io_arrays_to_elements_no_indirects, false);
 402
 403    nir_shader_gather_info(nir, nir_shader_get_entrypoint(nir));
 404
 405    shader->ir3_shader.compiler = dev->compiler;
 406    shader->ir3_shader.type = stage;
 407    shader->ir3_shader.nir = nir;
 408
 409    return shader;
 410 }
 411
 412 void
 413 tu_shader_destroy(struct tu_device *dev,
 414                   struct tu_shader *shader,
 415                   const VkAllocationCallbacks *alloc)
 416 {
 417    if (shader->ir3_shader.nir)
 418       ralloc_free(shader->ir3_shader.nir);
 419
 420    for (uint32_t i = 0; i < 1 + shader->has_binning_pass; i++) {
 421       if (shader->variants[i].ir)
 422          ir3_destroy(shader->variants[i].ir);
 423    }
 424
 425    if (shader->ir3_shader.const_state.immediates)
 426            free(shader->ir3_shader.const_state.immediates);
 427    if (shader->binary)
 428       free(shader->binary);
 429    if (shader->binning_binary)
 430       free(shader->binning_binary);
 431
 432    vk_free2(&dev->alloc, alloc, shader);
 433 }
 434
 435 void
 436 tu_shader_compile_options_init(
 437    struct tu_shader_compile_options *options,
 438    const VkGraphicsPipelineCreateInfo *pipeline_info)
 439 {
 440    *options = (struct tu_shader_compile_options) {
 441       /* TODO ir3_key */
 442
 443       /* TODO: VK_PIPELINE_CREATE_DISABLE_OPTIMIZATION_BIT
 444        * some optimizations need to happen otherwise shader might not compile
 445        */
 446       .optimize = true,
 447       .include_binning_pass = true,
 448    };
 449 }
 450
 451 static uint32_t *
 452 tu_compile_shader_variant(struct ir3_shader *shader,
 453                           const struct ir3_shader_key *key,
 454                           struct ir3_shader_variant *nonbinning,
 455                           struct ir3_shader_variant *variant)
 456 {
 457    variant->shader = shader;
 458    variant->type = shader->type;
 459    variant->key = *key;
 460    variant->binning_pass = !!nonbinning;
 461    variant->nonbinning = nonbinning;
 462
 463    int ret = ir3_compile_shader_nir(shader->compiler, variant);
 464    if (ret)
 465       return NULL;
 466
 467    /* when assemble fails, we rely on tu_shader_destroy to clean up the
 468     * variant
 469     */
 470    return ir3_shader_assemble(variant, shader->compiler->gpu_id);
 471 }
 472
 473 VkResult
 474 tu_shader_compile(struct tu_device *dev,
 475                   struct tu_shader *shader,
 476                   const struct tu_shader *next_stage,
 477                   const struct tu_shader_compile_options *options,
 478                   const VkAllocationCallbacks *alloc)
 479 {
 480    if (options->optimize) {
 481       /* ignore the key for the first pass of optimization */
 482       ir3_optimize_nir(&shader->ir3_shader, shader->ir3_shader.nir, NULL);
 483
 484       if (unlikely(dev->physical_device->instance->debug_flags &
 485                    TU_DEBUG_NIR)) {
 486          fprintf(stderr, "optimized nir:\n");
 487          nir_print_shader(shader->ir3_shader.nir, stderr);
 488       }
 489    }
 490
 491    shader->binary = tu_compile_shader_variant(
 492       &shader->ir3_shader, &options->key, NULL, &shader->variants[0]);
 493    if (!shader->binary)
 494       return VK_ERROR_OUT_OF_HOST_MEMORY;
 495
 496    /* compile another variant for the binning pass */
 497    if (options->include_binning_pass &&
 498        shader->ir3_shader.type == MESA_SHADER_VERTEX) {
 499       shader->binning_binary = tu_compile_shader_variant(
 500          &shader->ir3_shader, &options->key, &shader->variants[0],
 501          &shader->variants[1]);
 502       if (!shader->binning_binary)
 503          return VK_ERROR_OUT_OF_HOST_MEMORY;
 504
 505       shader->has_binning_pass = true;
 506    }
 507
 508    if (unlikely(dev->physical_device->instance->debug_flags & TU_DEBUG_IR3)) {
 509       fprintf(stderr, "disassembled ir3:\n");
 510       fprintf(stderr, "shader: %s\n",
 511               gl_shader_stage_name(shader->ir3_shader.type));
 512       ir3_shader_disasm(&shader->variants[0], shader->binary, stderr);
 513
 514       if (shader->has_binning_pass) {
 515          fprintf(stderr, "disassembled ir3:\n");
 516          fprintf(stderr, "shader: %s (binning)\n",
 517                  gl_shader_stage_name(shader->ir3_shader.type));
 518          ir3_shader_disasm(&shader->variants[1], shader->binning_binary,
 519                            stderr);
 520       }
 521    }
 522
 523    return VK_SUCCESS;
 524 }
 525
 526 VkResult
 527 tu_CreateShaderModule(VkDevice _device,
 528                       const VkShaderModuleCreateInfo *pCreateInfo,
 529                       const VkAllocationCallbacks *pAllocator,
 530                       VkShaderModule *pShaderModule)
 531 {
 532    TU_FROM_HANDLE(tu_device, device, _device);
 533    struct tu_shader_module *module;
 534
 535    assert(pCreateInfo->sType == VK_STRUCTURE_TYPE_SHADER_MODULE_CREATE_INFO);
 536    assert(pCreateInfo->flags == 0);
 537    assert(pCreateInfo->codeSize % 4 == 0);
 538
 539    module = vk_alloc2(&device->alloc, pAllocator,
 540                       sizeof(*module) + pCreateInfo->codeSize, 8,
 541                       VK_SYSTEM_ALLOCATION_SCOPE_OBJECT);
 542    if (module == NULL)
 543       return vk_error(device->instance, VK_ERROR_OUT_OF_HOST_MEMORY);
 544
 545    module->code_size = pCreateInfo->codeSize;
 546    memcpy(module->code, pCreateInfo->pCode, pCreateInfo->codeSize);
 547
 548    _mesa_sha1_compute(module->code, module->code_size, module->sha1);
 549
 550    *pShaderModule = tu_shader_module_to_handle(module);
 551
 552    return VK_SUCCESS;
 553 }
 554
 555 void
 556 tu_DestroyShaderModule(VkDevice _device,
 557                        VkShaderModule _module,
 558                        const VkAllocationCallbacks *pAllocator)
 559 {
 560    TU_FROM_HANDLE(tu_device, device, _device);
 561    TU_FROM_HANDLE(tu_shader_module, module, _module);
 562
 563    if (!module)
 564       return;
 565
 566    vk_free2(&device->alloc, pAllocator, module);
 567 }