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 "radv_debug.h"
  32 #include "radv_private.h"
  33
  34 #include "nir/nir.h"
  35
  36 /* descriptor index into scratch ring offsets */
  37 #define RING_SCRATCH 0
  38 #define RING_ESGS_VS 1
  39 #define RING_ESGS_GS 2
  40 #define RING_GSVS_VS 3
  41 #define RING_GSVS_GS 4
  42 #define RING_HS_TESS_FACTOR 5
  43 #define RING_HS_TESS_OFFCHIP 6
  44 #define RING_PS_SAMPLE_POSITIONS 7
  45
  46 // Match MAX_SETS from radv_descriptor_set.h
  47 #define RADV_UD_MAX_SETS MAX_SETS
  48
  49 #define RADV_NUM_PHYSICAL_VGPRS 256
  50
  51 struct radv_shader_module {
  52         struct nir_shader *nir;
  53         unsigned char sha1[20];
  54         uint32_t size;
  55         char data[0];
  56 };
  57
  58 enum {
  59         RADV_ALPHA_ADJUST_NONE = 0,
  60         RADV_ALPHA_ADJUST_SNORM = 1,
  61         RADV_ALPHA_ADJUST_SINT = 2,
  62         RADV_ALPHA_ADJUST_SSCALED = 3,
  63 };
  64
  65 struct radv_vs_variant_key {
  66         uint32_t instance_rate_inputs;
  67         uint32_t instance_rate_divisors[MAX_VERTEX_ATTRIBS];
  68
  69         /* For 2_10_10_10 formats the alpha is handled as unsigned by pre-vega HW.
  70          * so we may need to fix it up. */
  71         uint64_t alpha_adjust;
  72
  73         uint32_t as_es:1;
  74         uint32_t as_ls:1;
  75         uint32_t export_prim_id:1;
  76         uint32_t export_layer_id:1;
  77 };
  78
  79 struct radv_tes_variant_key {
  80         uint32_t as_es:1;
  81         uint32_t export_prim_id:1;
  82         uint32_t export_layer_id:1;
  83         uint8_t num_patches;
  84         uint8_t tcs_num_outputs;
  85 };
  86
  87 struct radv_tcs_variant_key {
  88         struct radv_vs_variant_key vs_key;
  89         unsigned primitive_mode;
  90         unsigned input_vertices;
  91         unsigned num_inputs;
  92         uint32_t tes_reads_tess_factors:1;
  93 };
  94
  95 struct radv_fs_variant_key {
  96         uint32_t col_format;
  97         uint8_t log2_ps_iter_samples;
  98         uint8_t log2_num_samples;
  99         uint32_t is_int8;
 100         uint32_t is_int10;
 101         uint32_t multisample : 1;
 102 };
 103
 104 struct radv_shader_variant_key {
 105         union {
 106                 struct radv_vs_variant_key vs;
 107                 struct radv_fs_variant_key fs;
 108                 struct radv_tes_variant_key tes;
 109                 struct radv_tcs_variant_key tcs;
 110         };
 111         bool has_multiview_view_index;
 112 };
 113
 114 struct radv_nir_compiler_options {
 115         struct radv_pipeline_layout *layout;
 116         struct radv_shader_variant_key key;
 117         bool unsafe_math;
 118         bool supports_spill;
 119         bool clamp_shadow_reference;
 120         bool dump_shader;
 121         bool dump_preoptir;
 122         bool record_llvm_ir;
 123         enum radeon_family family;
 124         enum chip_class chip_class;
 125         uint32_t tess_offchip_block_dw_size;
 126 };
 127
 128 enum radv_ud_index {
 129         AC_UD_SCRATCH_RING_OFFSETS = 0,
 130         AC_UD_PUSH_CONSTANTS = 1,
 131         AC_UD_INDIRECT_DESCRIPTOR_SETS = 2,
 132         AC_UD_VIEW_INDEX = 3,
 133         AC_UD_SHADER_START = 4,
 134         AC_UD_VS_VERTEX_BUFFERS = AC_UD_SHADER_START,
 135         AC_UD_VS_BASE_VERTEX_START_INSTANCE,
 136         AC_UD_VS_MAX_UD,
 137         AC_UD_PS_SAMPLE_POS_OFFSET = AC_UD_SHADER_START,
 138         AC_UD_PS_MAX_UD,
 139         AC_UD_CS_GRID_SIZE = AC_UD_SHADER_START,
 140         AC_UD_CS_MAX_UD,
 141         AC_UD_GS_MAX_UD,
 142         AC_UD_TCS_MAX_UD,
 143         AC_UD_TES_MAX_UD,
 144         AC_UD_MAX_UD = AC_UD_TCS_MAX_UD,
 145 };
 146 struct radv_shader_info {
 147         bool loads_push_constants;
 148         uint32_t desc_set_used_mask;
 149         bool needs_multiview_view_index;
 150         bool uses_invocation_id;
 151         bool uses_prim_id;
 152         struct {
 153                 uint64_t ls_outputs_written;
 154                 uint8_t input_usage_mask[VERT_ATTRIB_MAX];
 155                 uint8_t output_usage_mask[VARYING_SLOT_VAR31 + 1];
 156                 bool has_vertex_buffers; /* needs vertex buffers and base/start */
 157                 bool needs_draw_id;
 158                 bool needs_instance_id;
 159         } vs;
 160         struct {
 161                 uint8_t output_usage_mask[VARYING_SLOT_VAR31 + 1];
 162         } gs;
 163         struct {
 164                 uint8_t output_usage_mask[VARYING_SLOT_VAR31 + 1];
 165         } tes;
 166         struct {
 167                 bool force_persample;
 168                 bool needs_sample_positions;
 169                 bool uses_input_attachments;
 170                 bool writes_memory;
 171                 bool writes_z;
 172                 bool writes_stencil;
 173                 bool writes_sample_mask;
 174                 bool has_pcoord;
 175                 bool prim_id_input;
 176                 bool layer_input;
 177         } ps;
 178         struct {
 179                 bool uses_grid_size;
 180                 bool uses_block_id[3];
 181                 bool uses_thread_id[3];
 182                 bool uses_local_invocation_idx;
 183         } cs;
 184         struct {
 185                 uint64_t outputs_written;
 186                 uint64_t patch_outputs_written;
 187         } tcs;
 188 };
 189
 190 struct radv_userdata_info {
 191         int8_t sgpr_idx;
 192         uint8_t num_sgprs;
 193         bool indirect;
 194         uint32_t indirect_offset;
 195 };
 196
 197 struct radv_userdata_locations {
 198         struct radv_userdata_info descriptor_sets[RADV_UD_MAX_SETS];
 199         struct radv_userdata_info shader_data[AC_UD_MAX_UD];
 200 };
 201
 202 struct radv_vs_output_info {
 203         uint8_t vs_output_param_offset[VARYING_SLOT_MAX];
 204         uint8_t clip_dist_mask;
 205         uint8_t cull_dist_mask;
 206         uint8_t param_exports;
 207         bool writes_pointsize;
 208         bool writes_layer;
 209         bool writes_viewport_index;
 210         bool export_prim_id;
 211         unsigned pos_exports;
 212 };
 213
 214 struct radv_es_output_info {
 215         uint32_t esgs_itemsize;
 216 };
 217
 218 struct radv_shader_variant_info {
 219         struct radv_userdata_locations user_sgprs_locs;
 220         struct radv_shader_info info;
 221         unsigned num_user_sgprs;
 222         unsigned num_input_sgprs;
 223         unsigned num_input_vgprs;
 224         unsigned private_mem_vgprs;
 225         bool need_indirect_descriptor_sets;
 226         struct {
 227                 struct {
 228                         struct radv_vs_output_info outinfo;
 229                         struct radv_es_output_info es_info;
 230                         unsigned vgpr_comp_cnt;
 231                         bool as_es;
 232                         bool as_ls;
 233                 } vs;
 234                 struct {
 235                         unsigned num_interp;
 236                         uint32_t input_mask;
 237                         uint32_t flat_shaded_mask;
 238                         bool can_discard;
 239                         bool early_fragment_test;
 240                 } fs;
 241                 struct {
 242                         unsigned block_size[3];
 243                 } cs;
 244                 struct {
 245                         unsigned vertices_in;
 246                         unsigned vertices_out;
 247                         unsigned output_prim;
 248                         unsigned invocations;
 249                         unsigned gsvs_vertex_size;
 250                         unsigned max_gsvs_emit_size;
 251                         unsigned es_type; /* GFX9: VS or TES */
 252                 } gs;
 253                 struct {
 254                         unsigned tcs_vertices_out;
 255                         uint32_t num_patches;
 256                         uint32_t lds_size;
 257                 } tcs;
 258                 struct {
 259                         struct radv_vs_output_info outinfo;
 260                         struct radv_es_output_info es_info;
 261                         bool as_es;
 262                         unsigned primitive_mode;
 263                         enum gl_tess_spacing spacing;
 264                         bool ccw;
 265                         bool point_mode;
 266                 } tes;
 267         };
 268 };
 269
 270 struct radv_shader_variant {
 271         uint32_t ref_count;
 272
 273         struct radeon_winsys_bo *bo;
 274         uint64_t bo_offset;
 275         struct ac_shader_config config;
 276         uint32_t code_size;
 277         struct radv_shader_variant_info info;
 278         unsigned rsrc1;
 279         unsigned rsrc2;
 280
 281         /* debug only */
 282         uint32_t *spirv;
 283         uint32_t spirv_size;
 284         struct nir_shader *nir;
 285         char *disasm_string;
 286         char *llvm_ir_string;
 287
 288         struct list_head slab_list;
 289 };
 290
 291 struct radv_shader_slab {
 292         struct list_head slabs;
 293         struct list_head shaders;
 294         struct radeon_winsys_bo *bo;
 295         uint64_t size;
 296         char *ptr;
 297 };
 298
 299 void
 300 radv_optimize_nir(struct nir_shader *shader, bool optimize_conservatively);
 301
 302 nir_shader *
 303 radv_shader_compile_to_nir(struct radv_device *device,
 304                            struct radv_shader_module *module,
 305                            const char *entrypoint_name,
 306                            gl_shader_stage stage,
 307                            const VkSpecializationInfo *spec_info,
 308                            const VkPipelineCreateFlags flags);
 309
 310 void *
 311 radv_alloc_shader_memory(struct radv_device *device,
 312                           struct radv_shader_variant *shader);
 313
 314 void
 315 radv_destroy_shader_slabs(struct radv_device *device);
 316
 317 struct radv_shader_variant *
 318 radv_shader_variant_create(struct radv_device *device,
 319                            struct radv_shader_module *module,
 320                            struct nir_shader *const *shaders,
 321                            int shader_count,
 322                            struct radv_pipeline_layout *layout,
 323                            const struct radv_shader_variant_key *key,
 324                            void **code_out,
 325                            unsigned *code_size_out);
 326
 327 struct radv_shader_variant *
 328 radv_create_gs_copy_shader(struct radv_device *device, struct nir_shader *nir,
 329                            void **code_out, unsigned *code_size_out,
 330                            bool multiview);
 331
 332 void
 333 radv_shader_variant_destroy(struct radv_device *device,
 334                             struct radv_shader_variant *variant);
 335
 336 const char *
 337 radv_get_shader_name(struct radv_shader_variant *var, gl_shader_stage stage);
 338
 339 void
 340 radv_shader_dump_stats(struct radv_device *device,
 341                        struct radv_shader_variant *variant,
 342                        gl_shader_stage stage,
 343                        FILE *file);
 344
 345 static inline bool
 346 radv_can_dump_shader(struct radv_device *device,
 347                      struct radv_shader_module *module,
 348                      bool is_gs_copy_shader)
 349 {
 350         if (!(device->instance->debug_flags & RADV_DEBUG_DUMP_SHADERS))
 351                 return false;
 352
 353         /* Only dump non-meta shaders, useful for debugging purposes. */
 354         return (module && !module->nir) || is_gs_copy_shader;
 355 }
 356
 357 static inline bool
 358 radv_can_dump_shader_stats(struct radv_device *device,
 359                            struct radv_shader_module *module)
 360 {
 361         /* Only dump non-meta shader stats. */
 362         return device->instance->debug_flags & RADV_DEBUG_DUMP_SHADER_STATS &&
 363                module && !module->nir;
 364 }
 365
 366 static inline unsigned shader_io_get_unique_index(gl_varying_slot slot)
 367 {
 368         /* handle patch indices separate */
 369         if (slot == VARYING_SLOT_TESS_LEVEL_OUTER)
 370                 return 0;
 371         if (slot == VARYING_SLOT_TESS_LEVEL_INNER)
 372                 return 1;
 373         if (slot >= VARYING_SLOT_PATCH0 && slot <= VARYING_SLOT_TESS_MAX)
 374                 return 2 + (slot - VARYING_SLOT_PATCH0);
 375         if (slot == VARYING_SLOT_POS)
 376                 return 0;
 377         if (slot == VARYING_SLOT_PSIZ)
 378                 return 1;
 379         if (slot == VARYING_SLOT_CLIP_DIST0)
 380                 return 2;
 381         /* 3 is reserved for clip dist as well */
 382         if (slot >= VARYING_SLOT_VAR0 && slot <= VARYING_SLOT_VAR31)
 383                 return 4 + (slot - VARYING_SLOT_VAR0);
 384         unreachable("illegal slot in get unique index\n");
 385 }
 386
 387 static inline uint32_t
 388 radv_get_num_physical_sgprs(struct radv_physical_device *physical_device)
 389 {
 390         return physical_device->rad_info.chip_class >= VI ? 800 : 512;
 391 }
 392
 393 #endif