src/amd/vulkan/radv_shader.h

   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 #ifndef RADV_SHADER_H
  29 #define RADV_SHADER_H
  30
  31 #include "ac_binary.h"
  32 #include "amd_family.h"
  33 #include "radv_constants.h"
  34
  35 #include "nir/nir.h"
  36 #include "vulkan/vulkan.h"
  37 #include "vulkan/util/vk_object.h"
  38
  39 struct radv_device;
  40
  41 struct radv_shader_module {
  42         struct vk_object_base base;
  43         struct nir_shader *nir;
  44         unsigned char sha1[20];
  45         uint32_t size;
  46         char data[0];
  47 };
  48
  49 enum {
  50         RADV_ALPHA_ADJUST_NONE = 0,
  51         RADV_ALPHA_ADJUST_SNORM = 1,
  52         RADV_ALPHA_ADJUST_SINT = 2,
  53         RADV_ALPHA_ADJUST_SSCALED = 3,
  54 };
  55
  56 struct radv_vs_out_key {
  57         uint32_t as_es:1;
  58         uint32_t as_ls:1;
  59         uint32_t as_ngg:1;
  60         uint32_t as_ngg_passthrough:1;
  61         uint32_t export_prim_id:1;
  62         uint32_t export_layer_id:1;
  63         uint32_t export_clip_dists:1;
  64         uint32_t export_viewport_index:1;
  65 };
  66
  67 struct radv_vs_variant_key {
  68         struct radv_vs_out_key out;
  69
  70         uint32_t instance_rate_inputs;
  71         uint32_t instance_rate_divisors[MAX_VERTEX_ATTRIBS];
  72         uint8_t vertex_attribute_formats[MAX_VERTEX_ATTRIBS];
  73         uint32_t vertex_attribute_bindings[MAX_VERTEX_ATTRIBS];
  74         uint32_t vertex_attribute_offsets[MAX_VERTEX_ATTRIBS];
  75         uint32_t vertex_attribute_strides[MAX_VERTEX_ATTRIBS];
  76
  77         /* For 2_10_10_10 formats the alpha is handled as unsigned by pre-vega HW.
  78          * so we may need to fix it up. */
  79         uint64_t alpha_adjust;
  80
  81         /* For some formats the channels have to be shuffled. */
  82         uint32_t post_shuffle;
  83
  84         /* Output primitive type. */
  85         uint8_t outprim;
  86 };
  87
  88 struct radv_tes_variant_key {
  89         struct radv_vs_out_key out;
  90
  91         uint8_t num_patches;
  92         uint8_t tcs_num_outputs;
  93 };
  94
  95 struct radv_tcs_variant_key {
  96         struct radv_vs_variant_key vs_key;
  97         unsigned primitive_mode;
  98         unsigned input_vertices;
  99         unsigned num_inputs;
 100         uint32_t tes_reads_tess_factors:1;
 101 };
 102
 103 struct radv_fs_variant_key {
 104         uint32_t col_format;
 105         uint8_t log2_ps_iter_samples;
 106         uint8_t num_samples;
 107         uint32_t is_int8;
 108         uint32_t is_int10;
 109 };
 110
 111 struct radv_cs_variant_key {
 112         uint8_t subgroup_size;
 113 };
 114
 115 struct radv_shader_variant_key {
 116         union {
 117                 struct radv_vs_variant_key vs;
 118                 struct radv_fs_variant_key fs;
 119                 struct radv_tes_variant_key tes;
 120                 struct radv_tcs_variant_key tcs;
 121                 struct radv_cs_variant_key cs;
 122
 123                 /* A common prefix of the vs and tes keys. */
 124                 struct radv_vs_out_key vs_common_out;
 125         };
 126         bool has_multiview_view_index;
 127 };
 128
 129 struct radv_nir_compiler_options {
 130         struct radv_pipeline_layout *layout;
 131         struct radv_shader_variant_key key;
 132         bool explicit_scratch_args;
 133         bool clamp_shadow_reference;
 134         bool robust_buffer_access;
 135         bool dump_shader;
 136         bool dump_preoptir;
 137         bool record_ir;
 138         bool record_stats;
 139         bool check_ir;
 140         bool has_ls_vgpr_init_bug;
 141         bool use_ngg_streamout;
 142         enum radeon_family family;
 143         enum chip_class chip_class;
 144         uint32_t tess_offchip_block_dw_size;
 145         uint32_t address32_hi;
 146 };
 147
 148 enum radv_ud_index {
 149         AC_UD_SCRATCH_RING_OFFSETS = 0,
 150         AC_UD_PUSH_CONSTANTS = 1,
 151         AC_UD_INLINE_PUSH_CONSTANTS = 2,
 152         AC_UD_INDIRECT_DESCRIPTOR_SETS = 3,
 153         AC_UD_VIEW_INDEX = 4,
 154         AC_UD_STREAMOUT_BUFFERS = 5,
 155         AC_UD_NGG_GS_STATE = 6,
 156         AC_UD_SHADER_START = 7,
 157         AC_UD_VS_VERTEX_BUFFERS = AC_UD_SHADER_START,
 158         AC_UD_VS_BASE_VERTEX_START_INSTANCE,
 159         AC_UD_VS_MAX_UD,
 160         AC_UD_PS_MAX_UD,
 161         AC_UD_CS_GRID_SIZE = AC_UD_SHADER_START,
 162         AC_UD_CS_MAX_UD,
 163         AC_UD_GS_MAX_UD,
 164         AC_UD_TCS_MAX_UD,
 165         AC_UD_TES_MAX_UD,
 166         AC_UD_MAX_UD = AC_UD_TCS_MAX_UD,
 167 };
 168
 169 struct radv_stream_output {
 170         uint8_t location;
 171         uint8_t buffer;
 172         uint16_t offset;
 173         uint8_t component_mask;
 174         uint8_t stream;
 175 };
 176
 177 struct radv_streamout_info {
 178         uint16_t num_outputs;
 179         struct radv_stream_output outputs[MAX_SO_OUTPUTS];
 180         uint16_t strides[MAX_SO_BUFFERS];
 181         uint32_t enabled_stream_buffers_mask;
 182 };
 183
 184 struct radv_userdata_info {
 185         int8_t sgpr_idx;
 186         uint8_t num_sgprs;
 187 };
 188
 189 struct radv_userdata_locations {
 190         struct radv_userdata_info descriptor_sets[MAX_SETS];
 191         struct radv_userdata_info shader_data[AC_UD_MAX_UD];
 192         uint32_t descriptor_sets_enabled;
 193 };
 194
 195 struct radv_vs_output_info {
 196         uint8_t vs_output_param_offset[VARYING_SLOT_MAX];
 197         uint8_t clip_dist_mask;
 198         uint8_t cull_dist_mask;
 199         uint8_t param_exports;
 200         bool writes_pointsize;
 201         bool writes_layer;
 202         bool writes_viewport_index;
 203         bool export_prim_id;
 204         unsigned pos_exports;
 205 };
 206
 207 struct radv_es_output_info {
 208        uint32_t esgs_itemsize;
 209 };
 210
 211 struct gfx9_gs_info {
 212         uint32_t vgt_gs_onchip_cntl;
 213         uint32_t vgt_gs_max_prims_per_subgroup;
 214         uint32_t vgt_esgs_ring_itemsize;
 215         uint32_t lds_size;
 216 };
 217
 218 struct gfx10_ngg_info {
 219         uint16_t ngg_emit_size; /* in dwords */
 220         uint32_t hw_max_esverts;
 221         uint32_t max_gsprims;
 222         uint32_t max_out_verts;
 223         uint32_t prim_amp_factor;
 224         uint32_t vgt_esgs_ring_itemsize;
 225         uint32_t esgs_ring_size;
 226         bool max_vert_out_per_gs_instance;
 227 };
 228
 229 struct radv_shader_info {
 230         bool loads_push_constants;
 231         bool loads_dynamic_offsets;
 232         uint8_t min_push_constant_used;
 233         uint8_t max_push_constant_used;
 234         bool has_only_32bit_push_constants;
 235         bool has_indirect_push_constants;
 236         uint8_t num_inline_push_consts;
 237         uint8_t base_inline_push_consts;
 238         uint32_t desc_set_used_mask;
 239         bool needs_multiview_view_index;
 240         bool uses_invocation_id;
 241         bool uses_prim_id;
 242         uint8_t wave_size;
 243         uint8_t ballot_bit_size;
 244         struct radv_userdata_locations user_sgprs_locs;
 245         unsigned num_user_sgprs;
 246         unsigned num_input_sgprs;
 247         unsigned num_input_vgprs;
 248         unsigned private_mem_vgprs;
 249         bool need_indirect_descriptor_sets;
 250         bool is_ngg;
 251         bool is_ngg_passthrough;
 252         struct {
 253                 uint64_t ls_outputs_written;
 254                 uint8_t input_usage_mask[VERT_ATTRIB_MAX];
 255                 uint8_t output_usage_mask[VARYING_SLOT_VAR31 + 1];
 256                 bool has_vertex_buffers; /* needs vertex buffers and base/start */
 257                 bool needs_draw_id;
 258                 bool needs_instance_id;
 259                 struct radv_vs_output_info outinfo;
 260                 struct radv_es_output_info es_info;
 261                 bool as_es;
 262                 bool as_ls;
 263                 bool export_prim_id;
 264                 uint8_t num_linked_outputs;
 265         } vs;
 266         struct {
 267                 uint8_t output_usage_mask[VARYING_SLOT_VAR31 + 1];
 268                 uint8_t num_stream_output_components[4];
 269                 uint8_t output_streams[VARYING_SLOT_VAR31 + 1];
 270                 uint8_t max_stream;
 271                 bool writes_memory;
 272                 unsigned gsvs_vertex_size;
 273                 unsigned max_gsvs_emit_size;
 274                 unsigned vertices_in;
 275                 unsigned vertices_out;
 276                 unsigned output_prim;
 277                 unsigned invocations;
 278                 unsigned es_type; /* GFX9: VS or TES */
 279                 uint8_t num_linked_inputs;
 280         } gs;
 281         struct {
 282                 uint8_t output_usage_mask[VARYING_SLOT_VAR31 + 1];
 283                 struct radv_vs_output_info outinfo;
 284                 struct radv_es_output_info es_info;
 285                 bool as_es;
 286                 unsigned primitive_mode;
 287                 enum gl_tess_spacing spacing;
 288                 bool ccw;
 289                 bool point_mode;
 290                 bool export_prim_id;
 291                 uint8_t num_linked_inputs;
 292                 uint8_t num_linked_patch_inputs;
 293                 uint8_t num_linked_outputs;
 294         } tes;
 295         struct {
 296                 bool force_persample;
 297                 bool needs_sample_positions;
 298                 bool writes_memory;
 299                 bool writes_z;
 300                 bool writes_stencil;
 301                 bool writes_sample_mask;
 302                 bool has_pcoord;
 303                 bool prim_id_input;
 304                 bool layer_input;
 305                 bool viewport_index_input;
 306                 uint8_t num_input_clips_culls;
 307                 uint32_t input_mask;
 308                 uint32_t flat_shaded_mask;
 309                 uint32_t explicit_shaded_mask;
 310                 uint32_t float16_shaded_mask;
 311                 uint32_t num_interp;
 312                 bool can_discard;
 313                 bool early_fragment_test;
 314                 bool post_depth_coverage;
 315         } ps;
 316         struct {
 317                 bool uses_grid_size;
 318                 bool uses_block_id[3];
 319                 bool uses_thread_id[3];
 320                 bool uses_local_invocation_idx;
 321                 unsigned block_size[3];
 322         } cs;
 323         struct {
 324                 uint64_t outputs_written;
 325                 uint64_t patch_outputs_written;
 326                 uint64_t tes_inputs_read;
 327                 uint64_t tes_patch_inputs_read;
 328                 unsigned tcs_vertices_out;
 329                 uint32_t num_patches;
 330                 uint32_t lds_size;
 331                 uint8_t num_linked_inputs;
 332                 uint8_t num_linked_outputs;
 333                 uint8_t num_linked_patch_outputs;
 334         } tcs;
 335
 336         struct radv_streamout_info so;
 337
 338         struct gfx9_gs_info gs_ring_info;
 339         struct gfx10_ngg_info ngg_info;
 340
 341         unsigned float_controls_mode;
 342 };
 343
 344 enum radv_shader_binary_type {
 345         RADV_BINARY_TYPE_LEGACY,
 346         RADV_BINARY_TYPE_RTLD
 347 };
 348
 349 struct radv_shader_binary {
 350         enum radv_shader_binary_type type;
 351         gl_shader_stage stage;
 352         bool is_gs_copy_shader;
 353
 354         struct radv_shader_info info;
 355
 356         /* Self-referential size so we avoid consistency issues. */
 357         uint32_t total_size;
 358 };
 359
 360 struct radv_shader_binary_legacy {
 361         struct radv_shader_binary base;
 362         struct ac_shader_config config;
 363         unsigned code_size;
 364         unsigned exec_size;
 365         unsigned ir_size;
 366         unsigned disasm_size;
 367         unsigned stats_size;
 368
 369         /* data has size of stats_size + code_size + ir_size + disasm_size + 2,
 370          * where the +2 is for 0 of the ir strings. */
 371         uint8_t data[0];
 372 };
 373
 374 struct radv_shader_binary_rtld {
 375         struct radv_shader_binary base;
 376         unsigned elf_size;
 377         unsigned llvm_ir_size;
 378         uint8_t data[0];
 379 };
 380
 381 struct radv_compiler_statistic_info {
 382         char name[32];
 383         char desc[64];
 384 };
 385
 386 struct radv_compiler_statistics {
 387         unsigned count;
 388         struct radv_compiler_statistic_info *infos;
 389         uint32_t values[];
 390 };
 391
 392 struct radv_shader_variant {
 393         uint32_t ref_count;
 394
 395         struct radeon_winsys_bo *bo;
 396         uint64_t bo_offset;
 397         struct ac_shader_config config;
 398         uint32_t code_size;
 399         uint32_t exec_size;
 400         struct radv_shader_info info;
 401
 402         /* debug only */
 403         char *spirv;
 404         uint32_t spirv_size;
 405         char *nir_string;
 406         char *disasm_string;
 407         char *ir_string;
 408         struct radv_compiler_statistics *statistics;
 409
 410         struct list_head slab_list;
 411 };
 412
 413 struct radv_shader_slab {
 414         struct list_head slabs;
 415         struct list_head shaders;
 416         struct radeon_winsys_bo *bo;
 417         uint64_t size;
 418         char *ptr;
 419 };
 420
 421 void
 422 radv_optimize_nir(struct nir_shader *shader, bool optimize_conservatively,
 423                   bool allow_copies);
 424 bool
 425 radv_nir_lower_ycbcr_textures(nir_shader *shader,
 426                              const struct radv_pipeline_layout *layout);
 427
 428 nir_shader *
 429 radv_shader_compile_to_nir(struct radv_device *device,
 430                            struct radv_shader_module *module,
 431                            const char *entrypoint_name,
 432                            gl_shader_stage stage,
 433                            const VkSpecializationInfo *spec_info,
 434                            const VkPipelineCreateFlags flags,
 435                            const struct radv_pipeline_layout *layout,
 436                            unsigned subgroup_size, unsigned ballot_bit_size);
 437
 438 void *
 439 radv_alloc_shader_memory(struct radv_device *device,
 440                           struct radv_shader_variant *shader);
 441
 442 void
 443 radv_destroy_shader_slabs(struct radv_device *device);
 444
 445 void
 446 radv_create_shaders(struct radv_pipeline *pipeline,
 447                     struct radv_device *device,
 448                     struct radv_pipeline_cache *cache,
 449                     const struct radv_pipeline_key *key,
 450                     const VkPipelineShaderStageCreateInfo **pStages,
 451                     const VkPipelineCreateFlags flags,
 452                     VkPipelineCreationFeedbackEXT *pipeline_feedback,
 453                     VkPipelineCreationFeedbackEXT **stage_feedbacks);
 454
 455 struct radv_shader_variant *
 456 radv_shader_variant_create(struct radv_device *device,
 457                            const struct radv_shader_binary *binary,
 458                            bool keep_shader_info);
 459 struct radv_shader_variant *
 460 radv_shader_variant_compile(struct radv_device *device,
 461                             struct radv_shader_module *module,
 462                             struct nir_shader *const *shaders,
 463                             int shader_count,
 464                             struct radv_pipeline_layout *layout,
 465                             const struct radv_shader_variant_key *key,
 466                             struct radv_shader_info *info,
 467                             bool keep_shader_info, bool keep_statistic_info,
 468                             struct radv_shader_binary **binary_out);
 469
 470 struct radv_shader_variant *
 471 radv_create_gs_copy_shader(struct radv_device *device, struct nir_shader *nir,
 472                            struct radv_shader_info *info,
 473                            struct radv_shader_binary **binary_out,
 474                            bool multiview,  bool keep_shader_info,
 475                            bool keep_statistic_info);
 476
 477 void
 478 radv_shader_variant_destroy(struct radv_device *device,
 479                             struct radv_shader_variant *variant);
 480
 481
 482 unsigned
 483 radv_get_max_waves(struct radv_device *device,
 484                    struct radv_shader_variant *variant,
 485                    gl_shader_stage stage);
 486
 487 unsigned
 488 radv_get_max_workgroup_size(enum chip_class chip_class,
 489                             gl_shader_stage stage,
 490                             const unsigned *sizes);
 491
 492 const char *
 493 radv_get_shader_name(struct radv_shader_info *info,
 494                      gl_shader_stage stage);
 495
 496 void
 497 radv_shader_dump_stats(struct radv_device *device,
 498                        struct radv_shader_variant *variant,
 499                        gl_shader_stage stage,
 500                        FILE *file);
 501
 502 bool
 503 radv_can_dump_shader(struct radv_device *device,
 504                      struct radv_shader_module *module,
 505                      bool is_gs_copy_shader);
 506
 507 bool
 508 radv_can_dump_shader_stats(struct radv_device *device,
 509                            struct radv_shader_module *module);
 510
 511 static inline unsigned
 512 shader_io_get_unique_index(gl_varying_slot slot)
 513 {
 514         /* handle patch indices separate */
 515         if (slot == VARYING_SLOT_TESS_LEVEL_OUTER)
 516                 return 0;
 517         if (slot == VARYING_SLOT_TESS_LEVEL_INNER)
 518                 return 1;
 519         if (slot >= VARYING_SLOT_PATCH0 && slot <= VARYING_SLOT_TESS_MAX)
 520                 return 2 + (slot - VARYING_SLOT_PATCH0);
 521         if (slot == VARYING_SLOT_POS)
 522                 return 0;
 523         if (slot == VARYING_SLOT_PSIZ)
 524                 return 1;
 525         if (slot == VARYING_SLOT_CLIP_DIST0)
 526                 return 2;
 527         if (slot == VARYING_SLOT_CLIP_DIST1)
 528                 return 3;
 529         /* 3 is reserved for clip dist as well */
 530         if (slot >= VARYING_SLOT_VAR0 && slot <= VARYING_SLOT_VAR31)
 531                 return 4 + (slot - VARYING_SLOT_VAR0);
 532         unreachable("illegal slot in get unique index\n");
 533 }
 534
 535 static inline unsigned
 536 calculate_tess_lds_size(unsigned tcs_num_input_vertices,
 537                         unsigned tcs_num_output_vertices,
 538                         unsigned tcs_num_inputs,
 539                         unsigned tcs_num_patches,
 540                         unsigned tcs_num_outputs,
 541                         unsigned tcs_num_patch_outputs)
 542 {
 543         unsigned input_vertex_size = tcs_num_inputs * 16;
 544         unsigned output_vertex_size = tcs_num_outputs * 16;
 545
 546         unsigned input_patch_size = tcs_num_input_vertices * input_vertex_size;
 547
 548         unsigned pervertex_output_patch_size = tcs_num_output_vertices * output_vertex_size;
 549         unsigned output_patch_size = pervertex_output_patch_size + tcs_num_patch_outputs * 16;
 550
 551         unsigned output_patch0_offset = input_patch_size * tcs_num_patches;
 552
 553         return output_patch0_offset + output_patch_size * tcs_num_patches;
 554 }
 555
 556 static inline unsigned
 557 get_tcs_num_patches(unsigned tcs_num_input_vertices,
 558                         unsigned tcs_num_output_vertices,
 559                         unsigned tcs_num_inputs,
 560                         unsigned tcs_num_outputs,
 561                         unsigned tcs_num_patch_outputs,
 562                         unsigned tess_offchip_block_dw_size,
 563                         enum chip_class chip_class,
 564                         enum radeon_family family)
 565 {
 566         uint32_t input_vertex_size = tcs_num_inputs * 16;
 567         uint32_t input_patch_size = tcs_num_input_vertices * input_vertex_size;
 568         uint32_t output_vertex_size = tcs_num_outputs * 16;
 569         uint32_t pervertex_output_patch_size = tcs_num_output_vertices * output_vertex_size;
 570         uint32_t output_patch_size = pervertex_output_patch_size + tcs_num_patch_outputs * 16;
 571
 572         /* Ensure that we only need one wave per SIMD so we don't need to check
 573          * resource usage. Also ensures that the number of tcs in and out
 574          * vertices per threadgroup are at most 256.
 575          */
 576         unsigned num_patches = 64 / MAX2(tcs_num_input_vertices, tcs_num_output_vertices) * 4;
 577         /* Make sure that the data fits in LDS. This assumes the shaders only
 578          * use LDS for the inputs and outputs.
 579          */
 580         unsigned hardware_lds_size = 32768;
 581
 582         /* Looks like STONEY hangs if we use more than 32 KiB LDS in a single
 583          * threadgroup, even though there is more than 32 KiB LDS.
 584          *
 585          * Test: dEQP-VK.tessellation.shader_input_output.barrier
 586          */
 587         if (chip_class >= GFX7 && family != CHIP_STONEY)
 588                 hardware_lds_size = 65536;
 589
 590         num_patches = MIN2(num_patches, hardware_lds_size / (input_patch_size + output_patch_size));
 591         /* Make sure the output data fits in the offchip buffer */
 592         num_patches = MIN2(num_patches, (tess_offchip_block_dw_size * 4) / output_patch_size);
 593         /* Not necessary for correctness, but improves performance. The
 594          * specific value is taken from the proprietary driver.
 595          */
 596         num_patches = MIN2(num_patches, 40);
 597
 598         /* GFX6 bug workaround - limit LS-HS threadgroups to only one wave. */
 599         if (chip_class == GFX6) {
 600                 unsigned one_wave = 64 / MAX2(tcs_num_input_vertices, tcs_num_output_vertices);
 601                 num_patches = MIN2(num_patches, one_wave);
 602         }
 603         return num_patches;
 604 }
 605
 606 void
 607 radv_lower_fs_io(nir_shader *nir);
 608
 609 #endif