2 * Copyright 2012 Advanced Micro Devices, Inc.
5 * Permission is hereby granted, free of charge, to any person obtaining a
6 * copy of this software and associated documentation files (the "Software"),
7 * to deal in the Software without restriction, including without limitation
8 * on the rights to use, copy, modify, merge, publish, distribute, sub
9 * license, and/or sell copies of the Software, and to permit persons to whom
10 * the Software is furnished to do so, subject to the following conditions:
12 * The above copyright notice and this permission notice (including the next
13 * paragraph) shall be included in all copies or substantial portions of the
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL
19 * THE AUTHOR(S) AND/OR THEIR SUPPLIERS BE LIABLE FOR ANY CLAIM,
20 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
21 * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
22 * USE OR OTHER DEALINGS IN THE SOFTWARE.
25 /* The compiler middle-end architecture: Explaining (non-)monolithic shaders
26 * -------------------------------------------------------------------------
28 * Typically, there is one-to-one correspondence between API and HW shaders,
29 * that is, for every API shader, there is exactly one shader binary in
32 * The problem with that is that we also have to emulate some API states
33 * (e.g. alpha-test, and many others) in shaders too. The two obvious ways
34 * to deal with it are:
35 * - each shader has multiple variants for each combination of emulated states,
36 * and the variants are compiled on demand, possibly relying on a shader
37 * cache for good performance
38 * - patch shaders at the binary level
40 * This driver uses something completely different. The emulated states are
41 * usually implemented at the beginning or end of shaders. Therefore, we can
42 * split the shader into 3 parts:
43 * - prolog part (shader code dependent on states)
44 * - main part (the API shader)
45 * - epilog part (shader code dependent on states)
47 * Each part is compiled as a separate shader and the final binaries are
48 * concatenated. This type of shader is called non-monolithic, because it
49 * consists of multiple independent binaries. Creating a new shader variant
50 * is therefore only a concatenation of shader parts (binaries) and doesn't
51 * involve any compilation. The main shader parts are the only parts that are
52 * compiled when applications create shader objects. The prolog and epilog
53 * parts are compiled on the first use and saved, so that their binaries can
54 * be reused by many other shaders.
56 * One of the roles of the prolog part is to compute vertex buffer addresses
57 * for vertex shaders. A few of the roles of the epilog part are color buffer
58 * format conversions in pixel shaders that we have to do manually, and write
59 * tessellation factors in tessellation control shaders. The prolog and epilog
60 * have many other important responsibilities in various shader stages.
61 * They don't just "emulate legacy stuff".
63 * Monolithic shaders are shaders where the parts are combined before LLVM
64 * compilation, and the whole thing is compiled and optimized as one unit with
65 * one binary on the output. The result is the same as the non-monolithic
66 * shader, but the final code can be better, because LLVM can optimize across
67 * all shader parts. Monolithic shaders aren't usually used except for these
70 * 1) Some rarely-used states require modification of the main shader part
71 * itself, and in such cases, only the monolithic shader variant is
72 * compiled, and that's always done on the first use.
74 * 2) When we do cross-stage optimizations for separate shader objects and
75 * e.g. eliminate unused shader varyings, the resulting optimized shader
76 * variants are always compiled as monolithic shaders, and always
77 * asynchronously (i.e. not stalling ongoing rendering). We call them
78 * "optimized monolithic" shaders. The important property here is that
79 * the non-monolithic unoptimized shader variant is always available for use
80 * when the asynchronous compilation of the optimized shader is not done
83 * Starting with GFX9 chips, some shader stages are merged, and the number of
84 * shader parts per shader increased. The complete new list of shader parts is:
85 * - 1st shader: prolog part
86 * - 1st shader: main part
87 * - 2nd shader: prolog part
88 * - 2nd shader: main part
89 * - 2nd shader: epilog part
92 /* How linking shader inputs and outputs between vertex, tessellation, and
93 * geometry shaders works.
95 * Inputs and outputs between shaders are stored in a buffer. This buffer
96 * lives in LDS (typical case for tessellation), but it can also live
97 * in memory (ESGS). Each input or output has a fixed location within a vertex.
98 * The highest used input or output determines the stride between vertices.
100 * Since GS and tessellation are only possible in the OpenGL core profile,
101 * only these semantics are valid for per-vertex data:
108 * CULLDIST0..1 (not implemented)
111 * For example, a shader only writing GENERIC0 has the output stride of 5.
113 * Only these semantics are valid for per-patch data:
121 * That's how independent shaders agree on input and output locations.
122 * The si_shader_io_get_unique_index function assigns the locations.
124 * For tessellation, other required information for calculating the input and
125 * output addresses like the vertex stride, the patch stride, and the offsets
126 * where per-vertex and per-patch data start, is passed to the shader via
127 * user data SGPRs. The offsets and strides are calculated at draw time and
128 * aren't available at compile time.
134 #include "ac_binary.h"
135 #include "ac_llvm_build.h"
136 #include "ac_llvm_util.h"
137 #include "util/simple_mtx.h"
138 #include "util/u_inlines.h"
139 #include "util/u_live_shader_cache.h"
140 #include "util/u_queue.h"
144 // Use LDS symbols when supported by LLVM. Can be disabled for testing the old
145 // path on newer LLVM for now. Should be removed in the long term.
146 #define USE_LDS_SYMBOLS (true)
152 #define SI_MAX_ATTRIBS 16
153 #define SI_MAX_VS_OUTPUTS 40
155 /* Shader IO unique indices are supported for VARYING_SLOT_VARn with an
156 * index smaller than this.
158 #define SI_MAX_IO_GENERIC 32
160 #define SI_NGG_PRIM_EDGE_FLAG_BITS ((1 << 9) | (1 << 19) | (1 << 29))
162 /* SGPR user data indices */
165 SI_SGPR_RW_BUFFERS
, /* rings (& stream-out, VS only) */
166 SI_SGPR_BINDLESS_SAMPLERS_AND_IMAGES
,
167 SI_SGPR_CONST_AND_SHADER_BUFFERS
, /* or just a constant buffer 0 pointer */
168 SI_SGPR_SAMPLERS_AND_IMAGES
,
169 SI_NUM_RESOURCE_SGPRS
,
171 /* API VS, TES without GS, GS copy shader */
172 SI_SGPR_VS_STATE_BITS
= SI_NUM_RESOURCE_SGPRS
,
173 SI_NUM_VS_STATE_RESOURCE_SGPRS
,
175 /* all VS variants */
176 SI_SGPR_BASE_VERTEX
= SI_NUM_VS_STATE_RESOURCE_SGPRS
,
177 SI_SGPR_START_INSTANCE
,
181 SI_SGPR_VS_BLIT_DATA
= SI_SGPR_CONST_AND_SHADER_BUFFERS
,
184 SI_SGPR_TES_OFFCHIP_LAYOUT
= SI_NUM_VS_STATE_RESOURCE_SGPRS
,
185 SI_SGPR_TES_OFFCHIP_ADDR
,
186 SI_TES_NUM_USER_SGPR
,
188 /* GFX6-8: TCS only */
189 GFX6_SGPR_TCS_OFFCHIP_LAYOUT
= SI_NUM_RESOURCE_SGPRS
,
190 GFX6_SGPR_TCS_OUT_OFFSETS
,
191 GFX6_SGPR_TCS_OUT_LAYOUT
,
192 GFX6_SGPR_TCS_IN_LAYOUT
,
193 GFX6_TCS_NUM_USER_SGPR
,
195 /* GFX9: Merged shaders. */
196 /* 2ND_CONST_AND_SHADER_BUFFERS is set in USER_DATA_ADDR_LO (SGPR0). */
197 /* 2ND_SAMPLERS_AND_IMAGES is set in USER_DATA_ADDR_HI (SGPR1). */
198 GFX9_MERGED_NUM_USER_SGPR
= SI_VS_NUM_USER_SGPR
,
200 /* GFX9: Merged LS-HS (VS-TCS) only. */
201 GFX9_SGPR_TCS_OFFCHIP_LAYOUT
= GFX9_MERGED_NUM_USER_SGPR
,
202 GFX9_SGPR_TCS_OUT_OFFSETS
,
203 GFX9_SGPR_TCS_OUT_LAYOUT
,
204 GFX9_TCS_NUM_USER_SGPR
,
207 GFX6_GS_NUM_USER_SGPR
= SI_NUM_RESOURCE_SGPRS
,
208 GFX9_VSGS_NUM_USER_SGPR
= SI_VS_NUM_USER_SGPR
,
209 GFX9_TESGS_NUM_USER_SGPR
= SI_TES_NUM_USER_SGPR
,
210 SI_GSCOPY_NUM_USER_SGPR
= SI_NUM_VS_STATE_RESOURCE_SGPRS
,
213 SI_SGPR_ALPHA_REF
= SI_NUM_RESOURCE_SGPRS
,
216 /* The value has to be 12, because the hw requires that descriptors
217 * are aligned to 4 SGPRs.
219 SI_SGPR_VS_VB_DESCRIPTOR_FIRST
= 12,
222 /* LLVM function parameter indices */
225 SI_NUM_RESOURCE_PARAMS
= 4,
227 /* PS only parameters */
228 SI_PARAM_ALPHA_REF
= SI_NUM_RESOURCE_PARAMS
,
230 SI_PARAM_PERSP_SAMPLE
,
231 SI_PARAM_PERSP_CENTER
,
232 SI_PARAM_PERSP_CENTROID
,
233 SI_PARAM_PERSP_PULL_MODEL
,
234 SI_PARAM_LINEAR_SAMPLE
,
235 SI_PARAM_LINEAR_CENTER
,
236 SI_PARAM_LINEAR_CENTROID
,
237 SI_PARAM_LINE_STIPPLE_TEX
,
238 SI_PARAM_POS_X_FLOAT
,
239 SI_PARAM_POS_Y_FLOAT
,
240 SI_PARAM_POS_Z_FLOAT
,
241 SI_PARAM_POS_W_FLOAT
,
244 SI_PARAM_SAMPLE_COVERAGE
,
245 SI_PARAM_POS_FIXED_PT
,
247 SI_NUM_PARAMS
= SI_PARAM_POS_FIXED_PT
+ 9, /* +8 for COLOR[0..1] */
250 /* Fields of driver-defined VS state SGPR. */
251 #define S_VS_STATE_CLAMP_VERTEX_COLOR(x) (((unsigned)(x)&0x1) << 0)
252 #define C_VS_STATE_CLAMP_VERTEX_COLOR 0xFFFFFFFE
253 #define S_VS_STATE_INDEXED(x) (((unsigned)(x)&0x1) << 1)
254 #define C_VS_STATE_INDEXED 0xFFFFFFFD
255 #define S_VS_STATE_OUTPRIM(x) (((unsigned)(x)&0x3) << 2)
256 #define C_VS_STATE_OUTPRIM 0xFFFFFFF3
257 #define S_VS_STATE_PROVOKING_VTX_INDEX(x) (((unsigned)(x)&0x3) << 4)
258 #define C_VS_STATE_PROVOKING_VTX_INDEX 0xFFFFFFCF
259 #define S_VS_STATE_STREAMOUT_QUERY_ENABLED(x) (((unsigned)(x)&0x1) << 6)
260 #define C_VS_STATE_STREAMOUT_QUERY_ENABLED 0xFFFFFFBF
261 #define S_VS_STATE_SMALL_PRIM_PRECISION(x) (((unsigned)(x)&0xF) << 7)
262 #define C_VS_STATE_SMALL_PRIM_PRECISION 0xFFFFF87F
263 #define S_VS_STATE_LS_OUT_PATCH_SIZE(x) (((unsigned)(x)&0x1FFF) << 11)
264 #define C_VS_STATE_LS_OUT_PATCH_SIZE 0xFF0007FF
265 #define S_VS_STATE_LS_OUT_VERTEX_SIZE(x) (((unsigned)(x)&0xFF) << 24)
266 #define C_VS_STATE_LS_OUT_VERTEX_SIZE 0x00FFFFFF
270 /* These represent the number of SGPRs the shader uses. */
271 SI_VS_BLIT_SGPRS_POS
= 3,
272 SI_VS_BLIT_SGPRS_POS_COLOR
= 7,
273 SI_VS_BLIT_SGPRS_POS_TEXCOORD
= 9,
276 #define SI_NGG_CULL_VIEW_SMALLPRIMS (1 << 0) /* view.xy + small prims */
277 #define SI_NGG_CULL_BACK_FACE (1 << 1) /* back faces */
278 #define SI_NGG_CULL_FRONT_FACE (1 << 2) /* front faces */
279 #define SI_NGG_CULL_GS_FAST_LAUNCH_TRI_LIST (1 << 3) /* GS fast launch: triangles */
280 #define SI_NGG_CULL_GS_FAST_LAUNCH_TRI_STRIP (1 << 4) /* GS fast launch: triangle strip */
281 #define SI_NGG_CULL_GS_FAST_LAUNCH_ALL (0x3 << 3) /* GS fast launch (both prim types) */
284 * For VS shader keys, describe any fixups required for vertex fetch.
286 * \ref log_size, \ref format, and the number of channels are interpreted as
287 * by \ref ac_build_opencoded_load_format.
289 * Note: all bits 0 (size = 1 byte, num channels = 1, format = float) is an
290 * impossible format and indicates that no fixup is needed (just use
291 * buffer_load_format_xyzw).
293 union si_vs_fix_fetch
{
295 uint8_t log_size
: 2; /* 1, 2, 4, 8 or bytes per channel */
296 uint8_t num_channels_m1
: 2; /* number of channels minus 1 */
297 uint8_t format
: 3; /* AC_FETCH_FORMAT_xxx */
298 uint8_t reverse
: 1; /* reverse XYZ channels */
305 /* State of the context creating the shader object. */
306 struct si_compiler_ctx_state
{
307 /* Should only be used by si_init_shader_selector_async and
308 * si_build_shader_variant if thread_index == -1 (non-threaded). */
309 struct ac_llvm_compiler
*compiler
;
311 /* Used if thread_index == -1 or if debug.async is true. */
312 struct pipe_debug_callback debug
;
314 /* Used for creating the log string for gallium/ddebug. */
315 bool is_debug_context
;
318 struct si_shader_info
{
321 gl_shader_stage stage
;
325 ubyte input_semantic
[PIPE_MAX_SHADER_INPUTS
];
326 ubyte input_interpolate
[PIPE_MAX_SHADER_INPUTS
];
327 ubyte input_usage_mask
[PIPE_MAX_SHADER_INPUTS
];
328 ubyte output_semantic
[PIPE_MAX_SHADER_OUTPUTS
];
329 char output_semantic_to_slot
[VARYING_SLOT_TESS_MAX
];
330 ubyte output_usagemask
[PIPE_MAX_SHADER_OUTPUTS
];
331 ubyte output_readmask
[PIPE_MAX_SHADER_OUTPUTS
];
332 ubyte output_streams
[PIPE_MAX_SHADER_OUTPUTS
];
334 ubyte color_interpolate
[2];
335 ubyte color_interpolate_loc
[2];
337 int constbuf0_num_slots
;
338 unsigned const_buffers_declared
; /**< bitmask of declared const buffers */
339 ubyte num_stream_output_components
[4];
341 uint num_memory_instructions
; /**< sampler, buffer, and image instructions */
343 ubyte colors_read
; /**< which color components are read by the FS */
344 ubyte colors_written
;
345 bool color0_writes_all_cbufs
; /**< gl_FragColor */
346 bool reads_samplemask
; /**< does fragment shader read sample mask? */
347 bool reads_tess_factors
; /**< If TES reads TESSINNER or TESSOUTER */
348 bool writes_z
; /**< does fragment shader write Z value? */
349 bool writes_stencil
; /**< does fragment shader write stencil value? */
350 bool writes_samplemask
; /**< does fragment shader write sample mask? */
351 bool writes_edgeflag
; /**< vertex shader outputs edgeflag */
352 bool uses_kill
; /**< KILL or KILL_IF instruction used? */
353 bool uses_persp_center
;
354 bool uses_persp_centroid
;
355 bool uses_persp_sample
;
356 bool uses_linear_center
;
357 bool uses_linear_centroid
;
358 bool uses_linear_sample
;
359 bool uses_persp_opcode_interp_sample
;
360 bool uses_linear_opcode_interp_sample
;
361 bool uses_instanceid
;
363 bool uses_vertexid_nobase
;
364 bool uses_basevertex
;
368 bool uses_invocationid
;
369 bool uses_thread_id
[3];
370 bool uses_block_id
[3];
371 bool uses_block_size
;
373 bool uses_subgroup_info
;
374 bool writes_position
;
376 bool writes_clipvertex
;
378 bool writes_viewport_index
;
380 bool writes_memory
; /**< contains stores or atomics to buffers or images */
381 bool uses_derivatives
;
382 bool uses_bindless_samplers
;
383 bool uses_bindless_images
;
385 unsigned clipdist_writemask
;
386 unsigned culldist_writemask
;
387 unsigned num_written_culldistance
;
388 unsigned num_written_clipdistance
;
390 unsigned images_declared
; /**< bitmask of declared images */
392 /** Whether all codepaths write tess factors in all invocations. */
393 bool tessfactors_are_def_in_all_invocs
;
396 /* A shader selector is a gallium CSO and contains shader variants and
397 * binaries for one NIR program. This can be shared by multiple contexts.
399 struct si_shader_selector
{
400 struct util_live_shader base
;
401 struct si_screen
*screen
;
402 struct util_queue_fence ready
;
403 struct si_compiler_ctx_state compiler_ctx_state
;
406 struct si_shader
*first_variant
; /* immutable after the first variant */
407 struct si_shader
*last_variant
; /* mutable */
409 /* The compiled NIR shader without a prolog and/or epilog (not
410 * uploaded to a buffer object).
412 struct si_shader
*main_shader_part
;
413 struct si_shader
*main_shader_part_ls
; /* as_ls is set in the key */
414 struct si_shader
*main_shader_part_es
; /* as_es is set in the key */
415 struct si_shader
*main_shader_part_ngg
; /* as_ngg is set in the key */
416 struct si_shader
*main_shader_part_ngg_es
; /* for Wave32 TES before legacy GS */
418 struct si_shader
*gs_copy_shader
;
420 struct nir_shader
*nir
;
424 struct pipe_stream_output_info so
;
425 struct si_shader_info info
;
427 ubyte const_and_shader_buf_descriptors_index
;
428 ubyte sampler_and_images_descriptors_index
;
429 bool vs_needs_prolog
;
430 bool prim_discard_cs_allowed
;
431 bool ngg_culling_allowed
;
432 ubyte cs_shaderbufs_sgpr_index
;
433 ubyte cs_num_shaderbufs_in_user_sgprs
;
434 ubyte cs_images_sgpr_index
;
435 ubyte cs_images_num_sgprs
;
436 ubyte cs_num_images_in_user_sgprs
;
437 unsigned num_vs_inputs
;
438 unsigned num_vbos_in_user_sgprs
;
439 unsigned pa_cl_vs_out_cntl
;
445 unsigned esgs_itemsize
; /* vertex stride */
446 unsigned lshs_vertex_stride
;
449 unsigned gs_input_verts_per_prim
;
450 unsigned gs_output_prim
;
451 unsigned gs_max_out_vertices
;
452 unsigned gs_num_invocations
;
453 unsigned max_gs_stream
; /* count - 1 */
454 unsigned gsvs_vertex_size
;
455 unsigned max_gsvs_emit_size
;
456 unsigned enabled_streamout_buffer_mask
;
457 bool tess_turns_off_ngg
;
460 unsigned color_attr_index
[2];
461 unsigned db_shader_control
;
462 /* Set 0xf or 0x0 (4 bits) per each written output.
463 * ANDed with spi_shader_col_format.
465 unsigned colors_written_4bit
;
467 uint64_t outputs_written_before_ps
; /* "get_unique_index" bits */
468 uint64_t outputs_written
; /* "get_unique_index" bits */
469 uint32_t patch_outputs_written
; /* "get_unique_index_patch" bits */
471 uint64_t inputs_read
; /* "get_unique_index" bits */
473 /* bitmasks of used descriptor slots */
474 uint64_t active_const_and_shader_buffers
;
475 uint64_t active_samplers_and_images
;
478 /* Valid shader configurations:
480 * API shaders VS | TCS | TES | GS |pass| PS
481 * are compiled as: | | | |thru|
483 * Only VS & PS: VS | | | | | PS
484 * GFX6 - with GS: ES | | | GS | VS | PS
485 * - with tess: LS | HS | VS | | | PS
486 * - with both: LS | HS | ES | GS | VS | PS
487 * GFX9 - with GS: -> | | | GS | VS | PS
488 * - with tess: -> | HS | VS | | | PS
489 * - with both: -> | HS | -> | GS | VS | PS
491 * NGG - VS & PS: GS | | | | | PS
492 * (GFX10+) - with GS: -> | | | GS | | PS
493 * - with tess: -> | HS | GS | | | PS
494 * - with both: -> | HS | -> | GS | | PS
496 * -> = merged with the next stage
499 /* Use the byte alignment for all following structure members for optimal
500 * shader key memory footprint.
502 #pragma pack(push, 1)
504 /* Common VS bits between the shader key and the prolog key. */
505 struct si_vs_prolog_bits
{
506 /* - If neither "is_one" nor "is_fetched" has a bit set, the instance
508 * - If "is_one" has a bit set, the instance divisor is 1.
509 * - If "is_fetched" has a bit set, the instance divisor will be loaded
510 * from the constant buffer.
512 uint16_t instance_divisor_is_one
; /* bitmask of inputs */
513 uint16_t instance_divisor_is_fetched
; /* bitmask of inputs */
514 unsigned ls_vgpr_fix
: 1;
515 unsigned unpack_instance_id_from_vertex_id
: 1;
518 /* Common TCS bits between the shader key and the epilog key. */
519 struct si_tcs_epilog_bits
{
520 unsigned prim_mode
: 3;
521 unsigned invoc0_tess_factors_are_def
: 1;
522 unsigned tes_reads_tess_factors
: 1;
525 struct si_gs_prolog_bits
{
526 unsigned tri_strip_adj_fix
: 1;
527 unsigned gfx9_prev_is_vs
: 1;
530 /* Common PS bits between the shader key and the prolog key. */
531 struct si_ps_prolog_bits
{
532 unsigned color_two_side
: 1;
533 unsigned flatshade_colors
: 1;
534 unsigned poly_stipple
: 1;
535 unsigned force_persp_sample_interp
: 1;
536 unsigned force_linear_sample_interp
: 1;
537 unsigned force_persp_center_interp
: 1;
538 unsigned force_linear_center_interp
: 1;
539 unsigned bc_optimize_for_persp
: 1;
540 unsigned bc_optimize_for_linear
: 1;
541 unsigned samplemask_log_ps_iter
: 3;
544 /* Common PS bits between the shader key and the epilog key. */
545 struct si_ps_epilog_bits
{
546 unsigned spi_shader_col_format
;
547 unsigned color_is_int8
: 8;
548 unsigned color_is_int10
: 8;
549 unsigned last_cbuf
: 3;
550 unsigned alpha_func
: 3;
551 unsigned alpha_to_one
: 1;
552 unsigned poly_line_smoothing
: 1;
553 unsigned clamp_color
: 1;
556 union si_shader_part_key
{
558 struct si_vs_prolog_bits states
;
559 unsigned num_input_sgprs
: 6;
560 /* For merged stages such as LS-HS, HS input VGPRs are first. */
561 unsigned num_merged_next_stage_vgprs
: 3;
562 unsigned num_inputs
: 5;
566 unsigned as_prim_discard_cs
: 1;
567 unsigned has_ngg_cull_inputs
: 1; /* from the NGG cull shader */
568 unsigned gs_fast_launch_tri_list
: 1; /* for NGG culling */
569 unsigned gs_fast_launch_tri_strip
: 1; /* for NGG culling */
570 /* Prologs for monolithic shaders shouldn't set EXEC. */
571 unsigned is_monolithic
: 1;
574 struct si_tcs_epilog_bits states
;
577 struct si_gs_prolog_bits states
;
578 /* Prologs of monolithic shaders shouldn't set EXEC. */
579 unsigned is_monolithic
: 1;
583 struct si_ps_prolog_bits states
;
584 unsigned num_input_sgprs
: 6;
585 unsigned num_input_vgprs
: 5;
586 /* Color interpolation and two-side color selection. */
587 unsigned colors_read
: 8; /* color input components read */
588 unsigned num_interp_inputs
: 5; /* BCOLOR is at this location */
589 unsigned face_vgpr_index
: 5;
590 unsigned ancillary_vgpr_index
: 5;
592 char color_attr_index
[2];
593 signed char color_interp_vgpr_index
[2]; /* -1 == constant */
596 struct si_ps_epilog_bits states
;
597 unsigned colors_written
: 8;
598 unsigned writes_z
: 1;
599 unsigned writes_stencil
: 1;
600 unsigned writes_samplemask
: 1;
604 struct si_shader_key
{
605 /* Prolog and epilog flags. */
608 struct si_vs_prolog_bits prolog
;
611 struct si_vs_prolog_bits ls_prolog
; /* for merged LS-HS */
612 struct si_shader_selector
*ls
; /* for merged LS-HS */
613 struct si_tcs_epilog_bits epilog
;
614 } tcs
; /* tessellation control shader */
616 struct si_vs_prolog_bits vs_prolog
; /* for merged ES-GS */
617 struct si_shader_selector
*es
; /* for merged ES-GS */
618 struct si_gs_prolog_bits prolog
;
621 struct si_ps_prolog_bits prolog
;
622 struct si_ps_epilog_bits epilog
;
626 /* These three are initially set according to the NEXT_SHADER property,
627 * or guessed if the property doesn't seem correct.
629 unsigned as_es
: 1; /* export shader, which precedes GS */
630 unsigned as_ls
: 1; /* local shader, which precedes TCS */
631 unsigned as_ngg
: 1; /* VS, TES, or GS compiled as NGG primitive shader */
633 /* Flags for monolithic compilation only. */
635 /* Whether fetch should be opencoded according to vs_fix_fetch.
636 * Otherwise, if vs_fix_fetch is non-zero, buffer_load_format_xyzw
637 * with minimal fixups is used. */
638 uint16_t vs_fetch_opencode
;
639 union si_vs_fix_fetch vs_fix_fetch
[SI_MAX_ATTRIBS
];
642 uint64_t ff_tcs_inputs_to_copy
; /* for fixed-func TCS */
643 /* When PS needs PrimID and GS is disabled. */
644 unsigned vs_export_prim_id
: 1;
646 unsigned interpolate_at_sample_force_center
: 1;
647 unsigned fbfetch_msaa
: 1;
648 unsigned fbfetch_is_1D
: 1;
649 unsigned fbfetch_layered
: 1;
654 /* Optimization flags for asynchronous compilation only. */
656 /* For HW VS (it can be VS, TES, GS) */
657 uint64_t kill_outputs
; /* "get_unique_index" bits */
658 unsigned clip_disable
: 1;
660 /* For NGG VS and TES. */
661 unsigned ngg_culling
: 5; /* SI_NGG_CULL_* */
663 /* For shaders where monolithic variants have better code.
665 * This is a flag that has no effect on code generation,
666 * but forces monolithic shaders to be used as soon as
667 * possible, because it's in the "opt" group.
669 unsigned prefer_mono
: 1;
671 /* Primitive discard compute shader. */
672 unsigned vs_as_prim_discard_cs
: 1;
673 unsigned cs_prim_type
: 4;
674 unsigned cs_indexed
: 1;
675 unsigned cs_instancing
: 1;
676 unsigned cs_primitive_restart
: 1;
677 unsigned cs_provoking_vertex_first
: 1;
678 unsigned cs_need_correct_orientation
: 1;
679 unsigned cs_cull_front
: 1;
680 unsigned cs_cull_back
: 1;
681 unsigned cs_cull_z
: 1;
682 unsigned cs_halfz_clip_space
: 1;
686 /* Restore the pack alignment to default. */
689 /* GCN-specific shader info. */
690 struct si_shader_binary_info
{
691 ubyte vs_output_param_offset
[SI_MAX_VS_OUTPUTS
];
692 ubyte num_input_sgprs
;
693 ubyte num_input_vgprs
;
694 signed char face_vgpr_index
;
695 signed char ancillary_vgpr_index
;
696 bool uses_instanceid
;
697 ubyte nr_pos_exports
;
698 ubyte nr_param_exports
;
699 unsigned private_mem_vgprs
;
700 unsigned max_simd_waves
;
703 struct si_shader_binary
{
704 const char *elf_buffer
;
707 char *llvm_ir_string
;
710 struct gfx9_gs_info
{
711 unsigned es_verts_per_subgroup
;
712 unsigned gs_prims_per_subgroup
;
713 unsigned gs_inst_prims_in_subgroup
;
714 unsigned max_prims_per_subgroup
;
715 unsigned esgs_ring_size
; /* in bytes */
719 struct si_compiler_ctx_state compiler_ctx_state
;
721 struct si_shader_selector
*selector
;
722 struct si_shader_selector
*previous_stage_sel
; /* for refcounting */
723 struct si_shader
*next_variant
;
725 struct si_shader_part
*prolog
;
726 struct si_shader
*previous_stage
; /* for GFX9 */
727 struct si_shader_part
*prolog2
;
728 struct si_shader_part
*epilog
;
730 struct si_pm4_state
*pm4
;
731 struct si_resource
*bo
;
732 struct si_resource
*scratch_bo
;
733 struct si_shader_key key
;
734 struct util_queue_fence ready
;
735 bool compilation_failed
;
738 bool is_binary_shared
;
739 bool is_gs_copy_shader
;
741 /* The following data is all that's needed for binary shaders. */
742 struct si_shader_binary binary
;
743 struct ac_shader_config config
;
744 struct si_shader_binary_info info
;
747 uint16_t ngg_emit_size
; /* in dwords */
748 uint16_t hw_max_esverts
;
749 uint16_t max_gsprims
;
750 uint16_t max_out_verts
;
751 uint16_t prim_amp_factor
;
752 bool max_vert_out_per_gs_instance
;
755 /* Shader key + LLVM IR + disassembly + statistics.
756 * Generated for debug contexts only.
759 size_t shader_log_size
;
761 struct gfx9_gs_info gs_info
;
763 /* For save precompute context registers values. */
766 unsigned vgt_gsvs_ring_offset_1
;
767 unsigned vgt_gsvs_ring_offset_2
;
768 unsigned vgt_gsvs_ring_offset_3
;
769 unsigned vgt_gsvs_ring_itemsize
;
770 unsigned vgt_gs_max_vert_out
;
771 unsigned vgt_gs_vert_itemsize
;
772 unsigned vgt_gs_vert_itemsize_1
;
773 unsigned vgt_gs_vert_itemsize_2
;
774 unsigned vgt_gs_vert_itemsize_3
;
775 unsigned vgt_gs_instance_cnt
;
776 unsigned vgt_gs_onchip_cntl
;
777 unsigned vgt_gs_max_prims_per_subgroup
;
778 unsigned vgt_esgs_ring_itemsize
;
782 unsigned ge_max_output_per_subgroup
;
783 unsigned ge_ngg_subgrp_cntl
;
784 unsigned vgt_primitiveid_en
;
785 unsigned vgt_gs_onchip_cntl
;
786 unsigned vgt_gs_instance_cnt
;
787 unsigned vgt_esgs_ring_itemsize
;
788 unsigned spi_vs_out_config
;
789 unsigned spi_shader_idx_format
;
790 unsigned spi_shader_pos_format
;
791 unsigned pa_cl_vte_cntl
;
792 unsigned pa_cl_ngg_cntl
;
793 unsigned vgt_gs_max_vert_out
; /* for API GS */
794 unsigned ge_pc_alloc
; /* uconfig register */
798 unsigned vgt_gs_mode
;
799 unsigned vgt_primitiveid_en
;
800 unsigned vgt_reuse_off
;
801 unsigned spi_vs_out_config
;
802 unsigned spi_shader_pos_format
;
803 unsigned pa_cl_vte_cntl
;
804 unsigned ge_pc_alloc
; /* uconfig register */
808 unsigned spi_ps_input_ena
;
809 unsigned spi_ps_input_addr
;
810 unsigned spi_baryc_cntl
;
811 unsigned spi_ps_in_control
;
812 unsigned spi_shader_z_format
;
813 unsigned spi_shader_col_format
;
814 unsigned cb_shader_mask
;
818 /*For save precompute registers value */
819 unsigned vgt_tf_param
; /* VGT_TF_PARAM */
820 unsigned vgt_vertex_reuse_block_cntl
; /* VGT_VERTEX_REUSE_BLOCK_CNTL */
821 unsigned pa_cl_vs_out_cntl
;
825 struct si_shader_part
{
826 struct si_shader_part
*next
;
827 union si_shader_part_key key
;
828 struct si_shader_binary binary
;
829 struct ac_shader_config config
;
833 bool si_compile_shader(struct si_screen
*sscreen
, struct ac_llvm_compiler
*compiler
,
834 struct si_shader
*shader
, struct pipe_debug_callback
*debug
);
835 bool si_create_shader_variant(struct si_screen
*sscreen
, struct ac_llvm_compiler
*compiler
,
836 struct si_shader
*shader
, struct pipe_debug_callback
*debug
);
837 void si_shader_destroy(struct si_shader
*shader
);
838 unsigned si_shader_io_get_unique_index_patch(unsigned semantic
);
839 unsigned si_shader_io_get_unique_index(unsigned semantic
, bool is_varying
);
840 bool si_shader_binary_upload(struct si_screen
*sscreen
, struct si_shader
*shader
,
841 uint64_t scratch_va
);
842 void si_shader_dump(struct si_screen
*sscreen
, struct si_shader
*shader
,
843 struct pipe_debug_callback
*debug
, FILE *f
, bool check_debug_option
);
844 void si_shader_dump_stats_for_shader_db(struct si_screen
*screen
, struct si_shader
*shader
,
845 struct pipe_debug_callback
*debug
);
846 void si_multiwave_lds_size_workaround(struct si_screen
*sscreen
, unsigned *lds_size
);
847 const char *si_get_shader_name(const struct si_shader
*shader
);
848 void si_shader_binary_clean(struct si_shader_binary
*binary
);
850 /* si_shader_llvm_gs.c */
851 struct si_shader
*si_generate_gs_copy_shader(struct si_screen
*sscreen
,
852 struct ac_llvm_compiler
*compiler
,
853 struct si_shader_selector
*gs_selector
,
854 struct pipe_debug_callback
*debug
);
856 /* si_shader_nir.c */
857 void si_nir_scan_shader(const struct nir_shader
*nir
, struct si_shader_info
*info
);
858 void si_finalize_nir(struct pipe_screen
*screen
, void *nirptr
, bool optimize
);
860 /* si_state_shaders.c */
861 void gfx9_get_gs_info(struct si_shader_selector
*es
, struct si_shader_selector
*gs
,
862 struct gfx9_gs_info
*out
);
864 /* Inline helpers. */
866 /* Return the pointer to the main shader part's pointer. */
867 static inline struct si_shader
**si_get_main_shader_part(struct si_shader_selector
*sel
,
868 struct si_shader_key
*key
)
871 return &sel
->main_shader_part_ls
;
872 if (key
->as_es
&& key
->as_ngg
)
873 return &sel
->main_shader_part_ngg_es
;
875 return &sel
->main_shader_part_es
;
877 return &sel
->main_shader_part_ngg
;
878 return &sel
->main_shader_part
;
881 static inline bool gfx10_is_ngg_passthrough(struct si_shader
*shader
)
883 struct si_shader_selector
*sel
= shader
->selector
;
885 return sel
->info
.stage
!= MESA_SHADER_GEOMETRY
&& !sel
->so
.num_outputs
&& !sel
->info
.writes_edgeflag
&&
886 !shader
->key
.opt
.ngg_culling
&&
887 (sel
->info
.stage
!= MESA_SHADER_VERTEX
|| !shader
->key
.mono
.u
.vs_export_prim_id
);
890 static inline bool si_shader_uses_bindless_samplers(struct si_shader_selector
*selector
)
892 return selector
? selector
->info
.uses_bindless_samplers
: false;
895 static inline bool si_shader_uses_bindless_images(struct si_shader_selector
*selector
)
897 return selector
? selector
->info
.uses_bindless_images
: false;