src/amd/vulkan/radv_shader.c

   1 /*
   2  * Copyright © 2016 Red Hat.
   3  * Copyright © 2016 Bas Nieuwenhuizen
   4  *
   5  * based in part on anv driver which is:
   6  * Copyright © 2015 Intel Corporation
   7  *
   8  * Permission is hereby granted, free of charge, to any person obtaining a
   9  * copy of this software and associated documentation files (the "Software"),
  10  * to deal in the Software without restriction, including without limitation
  11  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
  12  * and/or sell copies of the Software, and to permit persons to whom the
  13  * Software is furnished to do so, subject to the following conditions:
  14  *
  15  * The above copyright notice and this permission notice (including the next
  16  * paragraph) shall be included in all copies or substantial portions of the
  17  * Software.
  18  *
  19  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  20  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  21  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  22  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  23  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  24  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
  25  * IN THE SOFTWARE.
  26  */
  27
  28 #include "util/mesa-sha1.h"
  29 #include "util/u_atomic.h"
  30 #include "radv_debug.h"
  31 #include "radv_private.h"
  32 #include "radv_shader.h"
  33 #include "nir/nir.h"
  34 #include "nir/nir_builder.h"
  35 #include "spirv/nir_spirv.h"
  36
  37 #include <llvm-c/Core.h>
  38 #include <llvm-c/TargetMachine.h>
  39
  40 #include "sid.h"
  41 #include "gfx9d.h"
  42 #include "r600d_common.h"
  43 #include "ac_binary.h"
  44 #include "ac_llvm_util.h"
  45 #include "ac_nir_to_llvm.h"
  46 #include "vk_format.h"
  47 #include "util/debug.h"
  48 #include "ac_exp_param.h"
  49
  50 static const struct nir_shader_compiler_options nir_options = {
  51         .vertex_id_zero_based = true,
  52         .lower_scmp = true,
  53         .lower_flrp32 = true,
  54         .lower_fsat = true,
  55         .lower_fdiv = true,
  56         .lower_sub = true,
  57         .lower_pack_snorm_2x16 = true,
  58         .lower_pack_snorm_4x8 = true,
  59         .lower_pack_unorm_2x16 = true,
  60         .lower_pack_unorm_4x8 = true,
  61         .lower_unpack_snorm_2x16 = true,
  62         .lower_unpack_snorm_4x8 = true,
  63         .lower_unpack_unorm_2x16 = true,
  64         .lower_unpack_unorm_4x8 = true,
  65         .lower_extract_byte = true,
  66         .lower_extract_word = true,
  67         .max_unroll_iterations = 32
  68 };
  69
  70 VkResult radv_CreateShaderModule(
  71         VkDevice                                    _device,
  72         const VkShaderModuleCreateInfo*             pCreateInfo,
  73         const VkAllocationCallbacks*                pAllocator,
  74         VkShaderModule*                             pShaderModule)
  75 {
  76         RADV_FROM_HANDLE(radv_device, device, _device);
  77         struct radv_shader_module *module;
  78
  79         assert(pCreateInfo->sType == VK_STRUCTURE_TYPE_SHADER_MODULE_CREATE_INFO);
  80         assert(pCreateInfo->flags == 0);
  81
  82         module = vk_alloc2(&device->alloc, pAllocator,
  83                              sizeof(*module) + pCreateInfo->codeSize, 8,
  84                              VK_SYSTEM_ALLOCATION_SCOPE_OBJECT);
  85         if (module == NULL)
  86                 return vk_error(VK_ERROR_OUT_OF_HOST_MEMORY);
  87
  88         module->nir = NULL;
  89         module->size = pCreateInfo->codeSize;
  90         memcpy(module->data, pCreateInfo->pCode, module->size);
  91
  92         _mesa_sha1_compute(module->data, module->size, module->sha1);
  93
  94         *pShaderModule = radv_shader_module_to_handle(module);
  95
  96         return VK_SUCCESS;
  97 }
  98
  99 void radv_DestroyShaderModule(
 100         VkDevice                                    _device,
 101         VkShaderModule                              _module,
 102         const VkAllocationCallbacks*                pAllocator)
 103 {
 104         RADV_FROM_HANDLE(radv_device, device, _device);
 105         RADV_FROM_HANDLE(radv_shader_module, module, _module);
 106
 107         if (!module)
 108                 return;
 109
 110         vk_free2(&device->alloc, pAllocator, module);
 111 }
 112
 113 static void
 114 radv_optimize_nir(struct nir_shader *shader)
 115 {
 116         bool progress;
 117
 118         do {
 119                 progress = false;
 120
 121                 NIR_PASS_V(shader, nir_lower_vars_to_ssa);
 122                 NIR_PASS_V(shader, nir_lower_64bit_pack);
 123                 NIR_PASS_V(shader, nir_lower_alu_to_scalar);
 124                 NIR_PASS_V(shader, nir_lower_phis_to_scalar);
 125
 126                 NIR_PASS(progress, shader, nir_copy_prop);
 127                 NIR_PASS(progress, shader, nir_opt_remove_phis);
 128                 NIR_PASS(progress, shader, nir_opt_dce);
 129                 if (nir_opt_trivial_continues(shader)) {
 130                         progress = true;
 131                         NIR_PASS(progress, shader, nir_copy_prop);
 132                         NIR_PASS(progress, shader, nir_opt_dce);
 133                 }
 134                 NIR_PASS(progress, shader, nir_opt_if);
 135                 NIR_PASS(progress, shader, nir_opt_dead_cf);
 136                 NIR_PASS(progress, shader, nir_opt_cse);
 137                 NIR_PASS(progress, shader, nir_opt_peephole_select, 8);
 138                 NIR_PASS(progress, shader, nir_opt_algebraic);
 139                 NIR_PASS(progress, shader, nir_opt_constant_folding);
 140                 NIR_PASS(progress, shader, nir_opt_undef);
 141                 NIR_PASS(progress, shader, nir_opt_conditional_discard);
 142                 if (shader->options->max_unroll_iterations) {
 143                         NIR_PASS(progress, shader, nir_opt_loop_unroll, 0);
 144                 }
 145         } while (progress);
 146 }
 147
 148 nir_shader *
 149 radv_shader_compile_to_nir(struct radv_device *device,
 150                            struct radv_shader_module *module,
 151                            const char *entrypoint_name,
 152                            gl_shader_stage stage,
 153                            const VkSpecializationInfo *spec_info)
 154 {
 155         if (strcmp(entrypoint_name, "main") != 0) {
 156                 radv_finishme("Multiple shaders per module not really supported");
 157         }
 158
 159         nir_shader *nir;
 160         nir_function *entry_point;
 161         if (module->nir) {
 162                 /* Some things such as our meta clear/blit code will give us a NIR
 163                  * shader directly.  In that case, we just ignore the SPIR-V entirely
 164                  * and just use the NIR shader */
 165                 nir = module->nir;
 166                 nir->options = &nir_options;
 167                 nir_validate_shader(nir);
 168
 169                 assert(exec_list_length(&nir->functions) == 1);
 170                 struct exec_node *node = exec_list_get_head(&nir->functions);
 171                 entry_point = exec_node_data(nir_function, node, node);
 172         } else {
 173                 uint32_t *spirv = (uint32_t *) module->data;
 174                 assert(module->size % 4 == 0);
 175
 176                 if (device->debug_flags & RADV_DEBUG_DUMP_SPIRV)
 177                         radv_print_spirv(module, stderr);
 178
 179                 uint32_t num_spec_entries = 0;
 180                 struct nir_spirv_specialization *spec_entries = NULL;
 181                 if (spec_info && spec_info->mapEntryCount > 0) {
 182                         num_spec_entries = spec_info->mapEntryCount;
 183                         spec_entries = malloc(num_spec_entries * sizeof(*spec_entries));
 184                         for (uint32_t i = 0; i < num_spec_entries; i++) {
 185                                 VkSpecializationMapEntry entry = spec_info->pMapEntries[i];
 186                                 const void *data = spec_info->pData + entry.offset;
 187                                 assert(data + entry.size <= spec_info->pData + spec_info->dataSize);
 188
 189                                 spec_entries[i].id = spec_info->pMapEntries[i].constantID;
 190                                 if (spec_info->dataSize == 8)
 191                                         spec_entries[i].data64 = *(const uint64_t *)data;
 192                                 else
 193                                         spec_entries[i].data32 = *(const uint32_t *)data;
 194                         }
 195                 }
 196                 const struct nir_spirv_supported_extensions supported_ext = {
 197                         .draw_parameters = true,
 198                         .float64 = true,
 199                         .image_read_without_format = true,
 200                         .image_write_without_format = true,
 201                         .tessellation = true,
 202                         .int64 = true,
 203                         .multiview = true,
 204                         .variable_pointers = true,
 205                 };
 206                 entry_point = spirv_to_nir(spirv, module->size / 4,
 207                                            spec_entries, num_spec_entries,
 208                                            stage, entrypoint_name, &supported_ext, &nir_options);
 209                 nir = entry_point->shader;
 210                 assert(nir->stage == stage);
 211                 nir_validate_shader(nir);
 212
 213                 free(spec_entries);
 214
 215                 /* We have to lower away local constant initializers right before we
 216                  * inline functions.  That way they get properly initialized at the top
 217                  * of the function and not at the top of its caller.
 218                  */
 219                 NIR_PASS_V(nir, nir_lower_constant_initializers, nir_var_local);
 220                 NIR_PASS_V(nir, nir_lower_returns);
 221                 NIR_PASS_V(nir, nir_inline_functions);
 222
 223                 /* Pick off the single entrypoint that we want */
 224                 foreach_list_typed_safe(nir_function, func, node, &nir->functions) {
 225                         if (func != entry_point)
 226                                 exec_node_remove(&func->node);
 227                 }
 228                 assert(exec_list_length(&nir->functions) == 1);
 229                 entry_point->name = ralloc_strdup(entry_point, "main");
 230
 231                 NIR_PASS_V(nir, nir_remove_dead_variables,
 232                            nir_var_shader_in | nir_var_shader_out | nir_var_system_value);
 233
 234                 /* Now that we've deleted all but the main function, we can go ahead and
 235                  * lower the rest of the constant initializers.
 236                  */
 237                 NIR_PASS_V(nir, nir_lower_constant_initializers, ~0);
 238                 NIR_PASS_V(nir, nir_lower_system_values);
 239                 NIR_PASS_V(nir, nir_lower_clip_cull_distance_arrays);
 240         }
 241
 242         /* Vulkan uses the separate-shader linking model */
 243         nir->info.separate_shader = true;
 244
 245         nir_shader_gather_info(nir, entry_point->impl);
 246
 247         nir_variable_mode indirect_mask = 0;
 248         indirect_mask |= nir_var_shader_in;
 249         indirect_mask |= nir_var_local;
 250
 251         nir_lower_indirect_derefs(nir, indirect_mask);
 252
 253         static const nir_lower_tex_options tex_options = {
 254           .lower_txp = ~0,
 255         };
 256
 257         nir_lower_tex(nir, &tex_options);
 258
 259         nir_lower_vars_to_ssa(nir);
 260         nir_lower_var_copies(nir);
 261         nir_lower_global_vars_to_local(nir);
 262         nir_remove_dead_variables(nir, nir_var_local);
 263         radv_optimize_nir(nir);
 264
 265         if (device->debug_flags & RADV_DEBUG_DUMP_SHADERS)
 266                 nir_print_shader(nir, stderr);
 267
 268         return nir;
 269 }
 270
 271 void *
 272 radv_alloc_shader_memory(struct radv_device *device,
 273                          struct radv_shader_variant *shader)
 274 {
 275         mtx_lock(&device->shader_slab_mutex);
 276         list_for_each_entry(struct radv_shader_slab, slab, &device->shader_slabs, slabs) {
 277                 uint64_t offset = 0;
 278                 list_for_each_entry(struct radv_shader_variant, s, &slab->shaders, slab_list) {
 279                         if (s->bo_offset - offset >= shader->code_size) {
 280                                 shader->bo = slab->bo;
 281                                 shader->bo_offset = offset;
 282                                 list_addtail(&shader->slab_list, &s->slab_list);
 283                                 mtx_unlock(&device->shader_slab_mutex);
 284                                 return slab->ptr + offset;
 285                         }
 286                         offset = align_u64(s->bo_offset + s->code_size, 256);
 287                 }
 288                 if (slab->size - offset >= shader->code_size) {
 289                         shader->bo = slab->bo;
 290                         shader->bo_offset = offset;
 291                         list_addtail(&shader->slab_list, &slab->shaders);
 292                         mtx_unlock(&device->shader_slab_mutex);
 293                         return slab->ptr + offset;
 294                 }
 295         }
 296
 297         mtx_unlock(&device->shader_slab_mutex);
 298         struct radv_shader_slab *slab = calloc(1, sizeof(struct radv_shader_slab));
 299
 300         slab->size = 256 * 1024;
 301         slab->bo = device->ws->buffer_create(device->ws, slab->size, 256,
 302                                              RADEON_DOMAIN_VRAM, 0);
 303         slab->ptr = (char*)device->ws->buffer_map(slab->bo);
 304         list_inithead(&slab->shaders);
 305
 306         mtx_lock(&device->shader_slab_mutex);
 307         list_add(&slab->slabs, &device->shader_slabs);
 308
 309         shader->bo = slab->bo;
 310         shader->bo_offset = 0;
 311         list_add(&shader->slab_list, &slab->shaders);
 312         mtx_unlock(&device->shader_slab_mutex);
 313         return slab->ptr;
 314 }
 315
 316 void
 317 radv_destroy_shader_slabs(struct radv_device *device)
 318 {
 319         list_for_each_entry_safe(struct radv_shader_slab, slab, &device->shader_slabs, slabs) {
 320                 device->ws->buffer_destroy(slab->bo);
 321                 free(slab);
 322         }
 323         mtx_destroy(&device->shader_slab_mutex);
 324 }
 325
 326 static void
 327 radv_fill_shader_variant(struct radv_device *device,
 328                          struct radv_shader_variant *variant,
 329                          struct ac_shader_binary *binary,
 330                          gl_shader_stage stage)
 331 {
 332         bool scratch_enabled = variant->config.scratch_bytes_per_wave > 0;
 333         unsigned vgpr_comp_cnt = 0;
 334
 335         if (scratch_enabled && !device->llvm_supports_spill)
 336                 radv_finishme("shader scratch support only available with LLVM 4.0");
 337
 338         variant->code_size = binary->code_size;
 339         variant->rsrc2 = S_00B12C_USER_SGPR(variant->info.num_user_sgprs) |
 340                         S_00B12C_SCRATCH_EN(scratch_enabled);
 341
 342         switch (stage) {
 343         case MESA_SHADER_TESS_EVAL:
 344                 vgpr_comp_cnt = 3;
 345                 /* fallthrough */
 346         case MESA_SHADER_TESS_CTRL:
 347                 variant->rsrc2 |= S_00B42C_OC_LDS_EN(1);
 348                 break;
 349         case MESA_SHADER_VERTEX:
 350         case MESA_SHADER_GEOMETRY:
 351                 vgpr_comp_cnt = variant->info.vs.vgpr_comp_cnt;
 352                 break;
 353         case MESA_SHADER_FRAGMENT:
 354                 break;
 355         case MESA_SHADER_COMPUTE:
 356                 variant->rsrc2 |=
 357                         S_00B84C_TGID_X_EN(1) | S_00B84C_TGID_Y_EN(1) |
 358                         S_00B84C_TGID_Z_EN(1) | S_00B84C_TIDIG_COMP_CNT(2) |
 359                         S_00B84C_TG_SIZE_EN(1) |
 360                         S_00B84C_LDS_SIZE(variant->config.lds_size);
 361                 break;
 362         default:
 363                 unreachable("unsupported shader type");
 364                 break;
 365         }
 366
 367         variant->rsrc1 =  S_00B848_VGPRS((variant->config.num_vgprs - 1) / 4) |
 368                 S_00B848_SGPRS((variant->config.num_sgprs - 1) / 8) |
 369                 S_00B128_VGPR_COMP_CNT(vgpr_comp_cnt) |
 370                 S_00B848_DX10_CLAMP(1) |
 371                 S_00B848_FLOAT_MODE(variant->config.float_mode);
 372
 373         void *ptr = radv_alloc_shader_memory(device, variant);
 374         memcpy(ptr, binary->code, binary->code_size);
 375 }
 376
 377 static struct radv_shader_variant *
 378 shader_variant_create(struct radv_device *device,
 379                       struct nir_shader *shader,
 380                       gl_shader_stage stage,
 381                       struct ac_nir_compiler_options *options,
 382                       bool gs_copy_shader,
 383                       void **code_out,
 384                       unsigned *code_size_out)
 385 {
 386         enum radeon_family chip_family = device->physical_device->rad_info.family;
 387         bool dump_shaders = device->debug_flags & RADV_DEBUG_DUMP_SHADERS;
 388         enum ac_target_machine_options tm_options = 0;
 389         struct radv_shader_variant *variant;
 390         struct ac_shader_binary binary;
 391         LLVMTargetMachineRef tm;
 392
 393         variant = calloc(1, sizeof(struct radv_shader_variant));
 394         if (!variant)
 395                 return NULL;
 396
 397         options->family = chip_family;
 398         options->chip_class = device->physical_device->rad_info.chip_class;
 399
 400         if (options->supports_spill)
 401                 tm_options |= AC_TM_SUPPORTS_SPILL;
 402         if (device->instance->perftest_flags & RADV_PERFTEST_SISCHED)
 403                 tm_options |= AC_TM_SISCHED;
 404         tm = ac_create_target_machine(chip_family, tm_options);
 405
 406         if (gs_copy_shader) {
 407                 ac_create_gs_copy_shader(tm, shader, &binary, &variant->config,
 408                                          &variant->info, options, dump_shaders);
 409         } else {
 410                 ac_compile_nir_shader(tm, &binary, &variant->config,
 411                                       &variant->info, shader, options,
 412                                       dump_shaders);
 413         }
 414
 415         LLVMDisposeTargetMachine(tm);
 416
 417         radv_fill_shader_variant(device, variant, &binary, stage);
 418
 419         if (code_out) {
 420                 *code_out = binary.code;
 421                 *code_size_out = binary.code_size;
 422         } else
 423                 free(binary.code);
 424         free(binary.config);
 425         free(binary.rodata);
 426         free(binary.global_symbol_offsets);
 427         free(binary.relocs);
 428         free(binary.disasm_string);
 429         variant->ref_count = 1;
 430         return variant;
 431 }
 432
 433 struct radv_shader_variant *
 434 radv_shader_variant_create(struct radv_device *device,
 435                            struct nir_shader *shader,
 436                            struct radv_pipeline_layout *layout,
 437                            const struct ac_shader_variant_key *key,
 438                            void **code_out,
 439                            unsigned *code_size_out)
 440 {
 441         struct ac_nir_compiler_options options = {0};
 442
 443         options.layout = layout;
 444         if (key)
 445                 options.key = *key;
 446
 447         options.unsafe_math = !!(device->debug_flags & RADV_DEBUG_UNSAFE_MATH);
 448         options.supports_spill = device->llvm_supports_spill;
 449
 450         return shader_variant_create(device, shader, shader->stage,
 451                                      &options, false, code_out, code_size_out);
 452 }
 453
 454 struct radv_shader_variant *
 455 radv_create_gs_copy_shader(struct radv_device *device,
 456                            struct nir_shader *shader,
 457                            void **code_out,
 458                            unsigned *code_size_out,
 459                            bool multiview)
 460 {
 461         struct ac_nir_compiler_options options = {0};
 462
 463         options.key.has_multiview_view_index = multiview;
 464
 465         return shader_variant_create(device, shader, MESA_SHADER_VERTEX,
 466                                      &options, true, code_out, code_size_out);
 467 }
 468
 469 void
 470 radv_shader_variant_destroy(struct radv_device *device,
 471                             struct radv_shader_variant *variant)
 472 {
 473         if (!p_atomic_dec_zero(&variant->ref_count))
 474                 return;
 475
 476         mtx_lock(&device->shader_slab_mutex);
 477         list_del(&variant->slab_list);
 478         mtx_unlock(&device->shader_slab_mutex);
 479
 480         free(variant);
 481 }
 482
 483 uint32_t
 484 radv_shader_stage_to_user_data_0(gl_shader_stage stage, bool has_gs,
 485                                  bool has_tess)
 486 {
 487         switch (stage) {
 488         case MESA_SHADER_FRAGMENT:
 489                 return R_00B030_SPI_SHADER_USER_DATA_PS_0;
 490         case MESA_SHADER_VERTEX:
 491                 if (has_tess)
 492                         return R_00B530_SPI_SHADER_USER_DATA_LS_0;
 493                 else
 494                         return has_gs ? R_00B330_SPI_SHADER_USER_DATA_ES_0 : R_00B130_SPI_SHADER_USER_DATA_VS_0;
 495         case MESA_SHADER_GEOMETRY:
 496                 return R_00B230_SPI_SHADER_USER_DATA_GS_0;
 497         case MESA_SHADER_COMPUTE:
 498                 return R_00B900_COMPUTE_USER_DATA_0;
 499         case MESA_SHADER_TESS_CTRL:
 500                 return R_00B430_SPI_SHADER_USER_DATA_HS_0;
 501         case MESA_SHADER_TESS_EVAL:
 502                 if (has_gs)
 503                         return R_00B330_SPI_SHADER_USER_DATA_ES_0;
 504                 else
 505                         return R_00B130_SPI_SHADER_USER_DATA_VS_0;
 506         default:
 507                 unreachable("unknown shader");
 508         }
 509 }
 510
 511 const char *
 512 radv_get_shader_name(struct radv_shader_variant *var, gl_shader_stage stage)
 513 {
 514         switch (stage) {
 515         case MESA_SHADER_VERTEX: return var->info.vs.as_ls ? "Vertex Shader as LS" : var->info.vs.as_es ? "Vertex Shader as ES" : "Vertex Shader as VS";
 516         case MESA_SHADER_GEOMETRY: return "Geometry Shader";
 517         case MESA_SHADER_FRAGMENT: return "Pixel Shader";
 518         case MESA_SHADER_COMPUTE: return "Compute Shader";
 519         case MESA_SHADER_TESS_CTRL: return "Tessellation Control Shader";
 520         case MESA_SHADER_TESS_EVAL: return var->info.tes.as_es ? "Tessellation Evaluation Shader as ES" : "Tessellation Evaluation Shader as VS";
 521         default:
 522                 return "Unknown shader";
 523         };
 524 }
 525