src/gallium/drivers/radeonsi/si_shader.h

   1 /*
   2  * Copyright 2012 Advanced Micro Devices, Inc.
   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  * on the rights to use, copy, modify, merge, publish, distribute, sub
   8  * license, and/or sell copies of the Software, and to permit persons to whom
   9  * the 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 NON-INFRINGEMENT. IN NO EVENT SHALL
  18  * THE AUTHOR(S) AND/OR THEIR SUPPLIERS BE LIABLE FOR ANY CLAIM,
  19  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
  20  * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
  21  * USE OR OTHER DEALINGS IN THE SOFTWARE.
  22  *
  23  * Authors:
  24  *      Tom Stellard <thomas.stellard@amd.com>
  25  *      Michel Dänzer <michel.daenzer@amd.com>
  26  *      Christian König <christian.koenig@amd.com>
  27  */
  28
  29 /* How linking shader inputs and outputs between vertex, tessellation, and
  30  * geometry shaders works.
  31  *
  32  * Inputs and outputs between shaders are stored in a buffer. This buffer
  33  * lives in LDS (typical case for tessellation), but it can also live
  34  * in memory (ESGS). Each input or output has a fixed location within a vertex.
  35  * The highest used input or output determines the stride between vertices.
  36  *
  37  * Since GS and tessellation are only possible in the OpenGL core profile,
  38  * only these semantics are valid for per-vertex data:
  39  *
  40  *   Name             Location
  41  *
  42  *   POSITION         0
  43  *   PSIZE            1
  44  *   CLIPDIST0..1     2..3
  45  *   CULLDIST0..1     (not implemented)
  46  *   GENERIC0..31     4..35
  47  *
  48  * For example, a shader only writing GENERIC0 has the output stride of 5.
  49  *
  50  * Only these semantics are valid for per-patch data:
  51  *
  52  *   Name             Location
  53  *
  54  *   TESSOUTER        0
  55  *   TESSINNER        1
  56  *   PATCH0..29       2..31
  57  *
  58  * That's how independent shaders agree on input and output locations.
  59  * The si_shader_io_get_unique_index function assigns the locations.
  60  *
  61  * For tessellation, other required information for calculating the input and
  62  * output addresses like the vertex stride, the patch stride, and the offsets
  63  * where per-vertex and per-patch data start, is passed to the shader via
  64  * user data SGPRs. The offsets and strides are calculated at draw time and
  65  * aren't available at compile time.
  66  */
  67
  68 #ifndef SI_SHADER_H
  69 #define SI_SHADER_H
  70
  71 #include <llvm-c/Core.h> /* LLVMModuleRef */
  72 #include <llvm-c/TargetMachine.h>
  73 #include "tgsi/tgsi_scan.h"
  74 #include "util/u_queue.h"
  75 #include "si_state.h"
  76
  77 struct radeon_shader_binary;
  78 struct radeon_shader_reloc;
  79
  80 #define SI_MAX_VS_OUTPUTS       40
  81
  82 /* SGPR user data indices */
  83 enum {
  84         SI_SGPR_RW_BUFFERS,  /* rings (& stream-out, VS only) */
  85         SI_SGPR_RW_BUFFERS_HI,
  86         SI_SGPR_CONST_BUFFERS,
  87         SI_SGPR_CONST_BUFFERS_HI,
  88         SI_SGPR_SAMPLERS,  /* images & sampler states interleaved */
  89         SI_SGPR_SAMPLERS_HI,
  90         SI_SGPR_IMAGES,
  91         SI_SGPR_IMAGES_HI,
  92         SI_SGPR_SHADER_BUFFERS,
  93         SI_SGPR_SHADER_BUFFERS_HI,
  94         SI_NUM_RESOURCE_SGPRS,
  95
  96         /* all VS variants */
  97         SI_SGPR_VERTEX_BUFFERS  = SI_NUM_RESOURCE_SGPRS,
  98         SI_SGPR_VERTEX_BUFFERS_HI,
  99         SI_SGPR_BASE_VERTEX,
 100         SI_SGPR_START_INSTANCE,
 101         SI_SGPR_DRAWID,
 102         SI_ES_NUM_USER_SGPR,
 103
 104         /* hw VS only */
 105         SI_SGPR_VS_STATE_BITS   = SI_ES_NUM_USER_SGPR,
 106         SI_VS_NUM_USER_SGPR,
 107
 108         /* hw LS only */
 109         SI_SGPR_LS_OUT_LAYOUT   = SI_ES_NUM_USER_SGPR,
 110         SI_LS_NUM_USER_SGPR,
 111
 112         /* both TCS and TES */
 113         SI_SGPR_TCS_OFFCHIP_LAYOUT = SI_NUM_RESOURCE_SGPRS,
 114         SI_TES_NUM_USER_SGPR,
 115
 116         /* TCS only */
 117         SI_SGPR_TCS_OUT_OFFSETS = SI_TES_NUM_USER_SGPR,
 118         SI_SGPR_TCS_OUT_LAYOUT,
 119         SI_SGPR_TCS_IN_LAYOUT,
 120         SI_TCS_NUM_USER_SGPR,
 121
 122         /* GS limits */
 123         SI_GS_NUM_USER_SGPR = SI_NUM_RESOURCE_SGPRS,
 124         SI_GSCOPY_NUM_USER_SGPR = SI_SGPR_RW_BUFFERS_HI + 1,
 125
 126         /* PS only */
 127         SI_SGPR_ALPHA_REF       = SI_NUM_RESOURCE_SGPRS,
 128         SI_PS_NUM_USER_SGPR,
 129
 130         /* CS only */
 131         SI_SGPR_GRID_SIZE = SI_NUM_RESOURCE_SGPRS,
 132         SI_SGPR_BLOCK_SIZE = SI_SGPR_GRID_SIZE + 3,
 133         SI_CS_NUM_USER_SGPR = SI_SGPR_BLOCK_SIZE + 3
 134 };
 135
 136 /* LLVM function parameter indices */
 137 enum {
 138         SI_PARAM_RW_BUFFERS,
 139         SI_PARAM_CONST_BUFFERS,
 140         SI_PARAM_SAMPLERS,
 141         SI_PARAM_IMAGES,
 142         SI_PARAM_SHADER_BUFFERS,
 143         SI_NUM_RESOURCE_PARAMS,
 144
 145         /* VS only parameters */
 146         SI_PARAM_VERTEX_BUFFERS = SI_NUM_RESOURCE_PARAMS,
 147         SI_PARAM_BASE_VERTEX,
 148         SI_PARAM_START_INSTANCE,
 149         SI_PARAM_DRAWID,
 150         /* [0] = clamp vertex color, VS as VS only */
 151         SI_PARAM_VS_STATE_BITS,
 152         /* same value as TCS_IN_LAYOUT, VS as LS only */
 153         SI_PARAM_LS_OUT_LAYOUT = SI_PARAM_DRAWID + 1,
 154         /* the other VS parameters are assigned dynamically */
 155
 156         /* Layout of TCS outputs in the offchip buffer
 157          *   [0:8] = the number of patches per threadgroup.
 158          *   [9:15] = the number of output vertices per patch.
 159          *   [16:31] = the offset of per patch attributes in the buffer in bytes.
 160          */
 161         SI_PARAM_TCS_OFFCHIP_LAYOUT = SI_NUM_RESOURCE_PARAMS, /* for TCS & TES */
 162
 163         /* TCS only parameters. */
 164
 165         /* Offsets where TCS outputs and TCS patch outputs live in LDS:
 166          *   [0:15] = TCS output patch0 offset / 16, max = NUM_PATCHES * 32 * 32
 167          *   [16:31] = TCS output patch0 offset for per-patch / 16, max = NUM_PATCHES*32*32* + 32*32
 168          */
 169         SI_PARAM_TCS_OUT_OFFSETS,
 170
 171         /* Layout of TCS outputs / TES inputs:
 172          *   [0:12] = stride between output patches in dwords, num_outputs * num_vertices * 4, max = 32*32*4
 173          *   [13:20] = stride between output vertices in dwords = num_inputs * 4, max = 32*4
 174          *   [26:31] = gl_PatchVerticesIn, max = 32
 175          */
 176         SI_PARAM_TCS_OUT_LAYOUT,
 177
 178         /* Layout of LS outputs / TCS inputs
 179          *   [0:12] = stride between patches in dwords = num_inputs * num_vertices * 4, max = 32*32*4
 180          *   [13:20] = stride between vertices in dwords = num_inputs * 4, max = 32*4
 181          */
 182         SI_PARAM_TCS_IN_LAYOUT,
 183
 184         SI_PARAM_TCS_OC_LDS,
 185         SI_PARAM_TESS_FACTOR_OFFSET,
 186         SI_PARAM_PATCH_ID,
 187         SI_PARAM_REL_IDS,
 188
 189         /* GS only parameters */
 190         SI_PARAM_GS2VS_OFFSET = SI_NUM_RESOURCE_PARAMS,
 191         SI_PARAM_GS_WAVE_ID,
 192         SI_PARAM_VTX0_OFFSET,
 193         SI_PARAM_VTX1_OFFSET,
 194         SI_PARAM_PRIMITIVE_ID,
 195         SI_PARAM_VTX2_OFFSET,
 196         SI_PARAM_VTX3_OFFSET,
 197         SI_PARAM_VTX4_OFFSET,
 198         SI_PARAM_VTX5_OFFSET,
 199         SI_PARAM_GS_INSTANCE_ID,
 200
 201         /* PS only parameters */
 202         SI_PARAM_ALPHA_REF = SI_NUM_RESOURCE_PARAMS,
 203         SI_PARAM_PRIM_MASK,
 204         SI_PARAM_PERSP_SAMPLE,
 205         SI_PARAM_PERSP_CENTER,
 206         SI_PARAM_PERSP_CENTROID,
 207         SI_PARAM_PERSP_PULL_MODEL,
 208         SI_PARAM_LINEAR_SAMPLE,
 209         SI_PARAM_LINEAR_CENTER,
 210         SI_PARAM_LINEAR_CENTROID,
 211         SI_PARAM_LINE_STIPPLE_TEX,
 212         SI_PARAM_POS_X_FLOAT,
 213         SI_PARAM_POS_Y_FLOAT,
 214         SI_PARAM_POS_Z_FLOAT,
 215         SI_PARAM_POS_W_FLOAT,
 216         SI_PARAM_FRONT_FACE,
 217         SI_PARAM_ANCILLARY,
 218         SI_PARAM_SAMPLE_COVERAGE,
 219         SI_PARAM_POS_FIXED_PT,
 220
 221         /* CS only parameters */
 222         SI_PARAM_GRID_SIZE = SI_NUM_RESOURCE_PARAMS,
 223         SI_PARAM_BLOCK_SIZE,
 224         SI_PARAM_BLOCK_ID,
 225         SI_PARAM_THREAD_ID,
 226
 227         SI_NUM_PARAMS = SI_PARAM_POS_FIXED_PT + 9, /* +8 for COLOR[0..1] */
 228 };
 229
 230 /* SI-specific system values. */
 231 enum {
 232         TGSI_SEMANTIC_DEFAULT_TESSOUTER_SI = TGSI_SEMANTIC_COUNT,
 233         TGSI_SEMANTIC_DEFAULT_TESSINNER_SI,
 234 };
 235
 236 struct si_shader;
 237
 238 /* A shader selector is a gallium CSO and contains shader variants and
 239  * binaries for one TGSI program. This can be shared by multiple contexts.
 240  */
 241 struct si_shader_selector {
 242         struct si_screen        *screen;
 243         struct util_queue_fence ready;
 244
 245         /* Should only be used by si_init_shader_selector_async
 246          * if thread_index == -1 (non-threaded). */
 247         LLVMTargetMachineRef    tm;
 248         struct pipe_debug_callback debug;
 249         bool                    is_debug_context;
 250
 251         pipe_mutex              mutex;
 252         struct si_shader        *first_variant; /* immutable after the first variant */
 253         struct si_shader        *last_variant; /* mutable */
 254
 255         /* The compiled TGSI shader expecting a prolog and/or epilog (not
 256          * uploaded to a buffer).
 257          */
 258         struct si_shader        *main_shader_part;
 259
 260         struct si_shader        *gs_copy_shader;
 261
 262         struct tgsi_token       *tokens;
 263         struct pipe_stream_output_info  so;
 264         struct tgsi_shader_info         info;
 265
 266         /* PIPE_SHADER_[VERTEX|FRAGMENT|...] */
 267         unsigned        type;
 268
 269         /* GS parameters. */
 270         unsigned        esgs_itemsize;
 271         unsigned        gs_input_verts_per_prim;
 272         unsigned        gs_output_prim;
 273         unsigned        gs_max_out_vertices;
 274         unsigned        gs_num_invocations;
 275         unsigned        max_gs_stream; /* count - 1 */
 276         unsigned        gsvs_vertex_size;
 277         unsigned        max_gsvs_emit_size;
 278
 279         /* PS parameters. */
 280         unsigned        color_attr_index[2];
 281         unsigned        db_shader_control;
 282         /* Set 0xf or 0x0 (4 bits) per each written output.
 283          * ANDed with spi_shader_col_format.
 284          */
 285         unsigned        colors_written_4bit;
 286
 287         /* CS parameters */
 288         unsigned local_size;
 289
 290         /* masks of "get_unique_index" bits */
 291         uint64_t        outputs_written;
 292         uint32_t        patch_outputs_written;
 293 };
 294
 295 /* Valid shader configurations:
 296  *
 297  * API shaders       VS | TCS | TES | GS |pass| PS
 298  * are compiled as:     |     |     |    |thru|
 299  *                      |     |     |    |    |
 300  * Only VS & PS:     VS | --  | --  | -- | -- | PS
 301  * With GS:          ES | --  | --  | GS | VS | PS
 302  * With Tessel.:     LS | HS  | VS  | -- | -- | PS
 303  * With both:        LS | HS  | ES  | GS | VS | PS
 304  */
 305
 306 /* Common VS bits between the shader key and the prolog key. */
 307 struct si_vs_prolog_bits {
 308         unsigned        instance_divisors[SI_NUM_VERTEX_BUFFERS];
 309 };
 310
 311 /* Common VS bits between the shader key and the epilog key. */
 312 struct si_vs_epilog_bits {
 313         unsigned        export_prim_id:1; /* when PS needs it and GS is disabled */
 314         /* TODO:
 315          * - skip clipdist, culldist (including clipvertex code) exports based
 316          *   on which clip_plane_enable bits are set
 317          * - skip layer, viewport, clipdist, and culldist parameter exports
 318          *   if PS doesn't read them
 319          */
 320 };
 321
 322 /* Common TCS bits between the shader key and the epilog key. */
 323 struct si_tcs_epilog_bits {
 324         unsigned        prim_mode:3;
 325         uint64_t        inputs_to_copy;
 326 };
 327
 328 struct si_gs_prolog_bits {
 329         unsigned        tri_strip_adj_fix:1;
 330 };
 331
 332 /* Common PS bits between the shader key and the prolog key. */
 333 struct si_ps_prolog_bits {
 334         unsigned        color_two_side:1;
 335         unsigned        flatshade_colors:1;
 336         unsigned        poly_stipple:1;
 337         unsigned        force_persp_sample_interp:1;
 338         unsigned        force_linear_sample_interp:1;
 339         unsigned        force_persp_center_interp:1;
 340         unsigned        force_linear_center_interp:1;
 341         unsigned        bc_optimize_for_persp:1;
 342         unsigned        bc_optimize_for_linear:1;
 343 };
 344
 345 /* Common PS bits between the shader key and the epilog key. */
 346 struct si_ps_epilog_bits {
 347         unsigned        spi_shader_col_format;
 348         unsigned        color_is_int8:8;
 349         unsigned        last_cbuf:3;
 350         unsigned        alpha_func:3;
 351         unsigned        alpha_to_one:1;
 352         unsigned        poly_line_smoothing:1;
 353         unsigned        clamp_color:1;
 354 };
 355
 356 union si_shader_part_key {
 357         struct {
 358                 struct si_vs_prolog_bits states;
 359                 unsigned        num_input_sgprs:5;
 360                 unsigned        last_input:4;
 361         } vs_prolog;
 362         struct {
 363                 struct si_vs_epilog_bits states;
 364                 unsigned        prim_id_param_offset:5;
 365         } vs_epilog;
 366         struct {
 367                 struct si_tcs_epilog_bits states;
 368         } tcs_epilog;
 369         struct {
 370                 struct si_gs_prolog_bits states;
 371         } gs_prolog;
 372         struct {
 373                 struct si_ps_prolog_bits states;
 374                 unsigned        num_input_sgprs:5;
 375                 unsigned        num_input_vgprs:5;
 376                 /* Color interpolation and two-side color selection. */
 377                 unsigned        colors_read:8; /* color input components read */
 378                 unsigned        num_interp_inputs:5; /* BCOLOR is at this location */
 379                 unsigned        face_vgpr_index:5;
 380                 unsigned        wqm:1;
 381                 char            color_attr_index[2];
 382                 char            color_interp_vgpr_index[2]; /* -1 == constant */
 383         } ps_prolog;
 384         struct {
 385                 struct si_ps_epilog_bits states;
 386                 unsigned        colors_written:8;
 387                 unsigned        writes_z:1;
 388                 unsigned        writes_stencil:1;
 389                 unsigned        writes_samplemask:1;
 390         } ps_epilog;
 391 };
 392
 393 union si_shader_key {
 394         struct {
 395                 struct si_ps_prolog_bits prolog;
 396                 struct si_ps_epilog_bits epilog;
 397         } ps;
 398         struct {
 399                 struct si_vs_prolog_bits prolog;
 400                 struct si_vs_epilog_bits epilog;
 401                 unsigned        as_es:1; /* export shader */
 402                 unsigned        as_ls:1; /* local shader */
 403         } vs;
 404         struct {
 405                 struct si_tcs_epilog_bits epilog;
 406         } tcs; /* tessellation control shader */
 407         struct {
 408                 struct si_vs_epilog_bits epilog; /* same as VS */
 409                 unsigned        as_es:1; /* export shader */
 410         } tes; /* tessellation evaluation shader */
 411         struct {
 412                 struct si_gs_prolog_bits prolog;
 413         } gs;
 414 };
 415
 416 struct si_shader_config {
 417         unsigned                        num_sgprs;
 418         unsigned                        num_vgprs;
 419         unsigned                        spilled_sgprs;
 420         unsigned                        spilled_vgprs;
 421         unsigned                        lds_size;
 422         unsigned                        spi_ps_input_ena;
 423         unsigned                        spi_ps_input_addr;
 424         unsigned                        float_mode;
 425         unsigned                        scratch_bytes_per_wave;
 426         unsigned                        rsrc1;
 427         unsigned                        rsrc2;
 428 };
 429
 430 enum {
 431         /* SPI_PS_INPUT_CNTL_i.OFFSET[0:4] */
 432         EXP_PARAM_OFFSET_0 = 0,
 433         EXP_PARAM_OFFSET_31 = 31,
 434         /* SPI_PS_INPUT_CNTL_i.DEFAULT_VAL[0:1] */
 435         EXP_PARAM_DEFAULT_VAL_0000 = 64,
 436         EXP_PARAM_DEFAULT_VAL_0001,
 437         EXP_PARAM_DEFAULT_VAL_1110,
 438         EXP_PARAM_DEFAULT_VAL_1111,
 439 };
 440
 441 /* GCN-specific shader info. */
 442 struct si_shader_info {
 443         ubyte                   vs_output_param_offset[SI_MAX_VS_OUTPUTS];
 444         ubyte                   num_input_sgprs;
 445         ubyte                   num_input_vgprs;
 446         char                    face_vgpr_index;
 447         bool                    uses_instanceid;
 448         ubyte                   nr_pos_exports;
 449         ubyte                   nr_param_exports;
 450 };
 451
 452 struct si_shader {
 453         struct si_shader_selector       *selector;
 454         struct si_shader                *next_variant;
 455
 456         struct si_shader_part           *prolog;
 457         struct si_shader_part           *epilog;
 458
 459         struct si_pm4_state             *pm4;
 460         struct r600_resource            *bo;
 461         struct r600_resource            *scratch_bo;
 462         union si_shader_key             key;
 463         bool                            is_binary_shared;
 464         bool                            is_gs_copy_shader;
 465
 466         /* The following data is all that's needed for binary shaders. */
 467         struct radeon_shader_binary     binary;
 468         struct si_shader_config         config;
 469         struct si_shader_info           info;
 470
 471         /* Shader key + LLVM IR + disassembly + statistics.
 472          * Generated for debug contexts only.
 473          */
 474         char                            *shader_log;
 475         size_t                          shader_log_size;
 476 };
 477
 478 struct si_shader_part {
 479         struct si_shader_part *next;
 480         union si_shader_part_key key;
 481         struct radeon_shader_binary binary;
 482         struct si_shader_config config;
 483 };
 484
 485 /* si_shader.c */
 486 struct si_shader *
 487 si_generate_gs_copy_shader(struct si_screen *sscreen,
 488                            LLVMTargetMachineRef tm,
 489                            struct si_shader_selector *gs_selector,
 490                            struct pipe_debug_callback *debug);
 491 int si_compile_tgsi_shader(struct si_screen *sscreen,
 492                            LLVMTargetMachineRef tm,
 493                            struct si_shader *shader,
 494                            bool is_monolithic,
 495                            struct pipe_debug_callback *debug);
 496 int si_shader_create(struct si_screen *sscreen, LLVMTargetMachineRef tm,
 497                      struct si_shader *shader,
 498                      struct pipe_debug_callback *debug);
 499 int si_compile_llvm(struct si_screen *sscreen,
 500                     struct radeon_shader_binary *binary,
 501                     struct si_shader_config *conf,
 502                     LLVMTargetMachineRef tm,
 503                     LLVMModuleRef mod,
 504                     struct pipe_debug_callback *debug,
 505                     unsigned processor,
 506                     const char *name);
 507 void si_shader_destroy(struct si_shader *shader);
 508 unsigned si_shader_io_get_unique_index(unsigned semantic_name, unsigned index);
 509 int si_shader_binary_upload(struct si_screen *sscreen, struct si_shader *shader);
 510 void si_shader_dump(struct si_screen *sscreen, struct si_shader *shader,
 511                     struct pipe_debug_callback *debug, unsigned processor,
 512                     FILE *f);
 513 void si_shader_apply_scratch_relocs(struct si_context *sctx,
 514                         struct si_shader *shader,
 515                         struct si_shader_config *config,
 516                         uint64_t scratch_va);
 517 void si_shader_binary_read_config(struct radeon_shader_binary *binary,
 518                                   struct si_shader_config *conf,
 519                                   unsigned symbol_offset);
 520 unsigned si_get_spi_shader_z_format(bool writes_z, bool writes_stencil,
 521                                     bool writes_samplemask);
 522
 523 #endif