2 * Copyright 2012 Advanced Micro Devices, Inc.
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:
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
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.
24 * Tom Stellard <thomas.stellard@amd.com>
25 * Michel Dänzer <michel.daenzer@amd.com>
26 * Christian König <christian.koenig@amd.com>
29 /* How linking shader inputs and outputs between vertex, tessellation, and
30 * geometry shaders works.
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.
37 * Since GS and tessellation are only possible in the OpenGL core profile,
38 * only these semantics are valid for per-vertex data:
45 * CULLDIST0..1 (not implemented)
48 * For example, a shader only writing GENERIC0 has the output stride of 5.
50 * Only these semantics are valid for per-patch data:
58 * That's how independent shaders agree on input and output locations.
59 * The si_shader_io_get_unique_index function assigns the locations.
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.
71 #include <llvm-c/Core.h> /* LLVMModuleRef */
72 #include "tgsi/tgsi_scan.h"
75 struct radeon_shader_binary
;
76 struct radeon_shader_reloc
;
78 #define SI_MAX_VS_OUTPUTS 40
80 /* SGPR user data indices */
82 SI_SGPR_RW_BUFFERS
, /* rings (& stream-out, VS only) */
83 SI_SGPR_RW_BUFFERS_HI
,
84 SI_SGPR_CONST_BUFFERS
,
85 SI_SGPR_CONST_BUFFERS_HI
,
86 SI_SGPR_SAMPLERS
, /* images & sampler states interleaved */
90 SI_SGPR_SHADER_BUFFERS
,
91 SI_SGPR_SHADER_BUFFERS_HI
,
92 SI_NUM_RESOURCE_SGPRS
,
95 SI_SGPR_VERTEX_BUFFERS
= SI_NUM_RESOURCE_SGPRS
,
96 SI_SGPR_VERTEX_BUFFERS_HI
,
98 SI_SGPR_START_INSTANCE
,
102 SI_SGPR_VS_STATE_BITS
= SI_ES_NUM_USER_SGPR
,
106 SI_SGPR_LS_OUT_LAYOUT
= SI_ES_NUM_USER_SGPR
,
109 /* both TCS and TES */
110 SI_SGPR_TCS_OFFCHIP_LAYOUT
= SI_NUM_RESOURCE_SGPRS
,
111 SI_TES_NUM_USER_SGPR
,
114 SI_SGPR_TCS_OUT_OFFSETS
= SI_TES_NUM_USER_SGPR
,
115 SI_SGPR_TCS_OUT_LAYOUT
,
116 SI_SGPR_TCS_IN_LAYOUT
,
117 SI_TCS_NUM_USER_SGPR
,
120 SI_GS_NUM_USER_SGPR
= SI_NUM_RESOURCE_SGPRS
,
121 SI_GSCOPY_NUM_USER_SGPR
= SI_SGPR_RW_BUFFERS_HI
+ 1,
124 SI_SGPR_ALPHA_REF
= SI_NUM_RESOURCE_SGPRS
,
128 SI_SGPR_GRID_SIZE
= SI_NUM_RESOURCE_SGPRS
,
129 SI_CS_NUM_USER_SGPR
= SI_SGPR_GRID_SIZE
+ 3
132 /* LLVM function parameter indices */
135 SI_PARAM_CONST_BUFFERS
,
138 SI_PARAM_SHADER_BUFFERS
,
139 SI_NUM_RESOURCE_PARAMS
,
141 /* VS only parameters */
142 SI_PARAM_VERTEX_BUFFERS
= SI_NUM_RESOURCE_PARAMS
,
143 SI_PARAM_BASE_VERTEX
,
144 SI_PARAM_START_INSTANCE
,
145 /* [0] = clamp vertex color, VS as VS only */
146 SI_PARAM_VS_STATE_BITS
,
147 /* same value as TCS_IN_LAYOUT, VS as LS only */
148 SI_PARAM_LS_OUT_LAYOUT
= SI_PARAM_START_INSTANCE
+ 1,
149 /* the other VS parameters are assigned dynamically */
151 /* Layout of TCS outputs in the offchip buffer
152 * [0:8] = the number of patches per threadgroup.
153 * [9:15] = the number of output vertices per patch.
154 * [16:31] = the offset of per patch attributes in the buffer in bytes.
156 SI_PARAM_TCS_OFFCHIP_LAYOUT
= SI_NUM_RESOURCE_PARAMS
, /* for TCS & TES */
158 /* TCS only parameters. */
160 /* Offsets where TCS outputs and TCS patch outputs live in LDS:
161 * [0:15] = TCS output patch0 offset / 16, max = NUM_PATCHES * 32 * 32
162 * [16:31] = TCS output patch0 offset for per-patch / 16, max = NUM_PATCHES*32*32* + 32*32
164 SI_PARAM_TCS_OUT_OFFSETS
,
166 /* Layout of TCS outputs / TES inputs:
167 * [0:12] = stride between output patches in dwords, num_outputs * num_vertices * 4, max = 32*32*4
168 * [13:20] = stride between output vertices in dwords = num_inputs * 4, max = 32*4
169 * [26:31] = gl_PatchVerticesIn, max = 32
171 SI_PARAM_TCS_OUT_LAYOUT
,
173 /* Layout of LS outputs / TCS inputs
174 * [0:12] = stride between patches in dwords = num_inputs * num_vertices * 4, max = 32*32*4
175 * [13:20] = stride between vertices in dwords = num_inputs * 4, max = 32*4
177 SI_PARAM_TCS_IN_LAYOUT
,
180 SI_PARAM_TESS_FACTOR_OFFSET
,
184 /* GS only parameters */
185 SI_PARAM_GS2VS_OFFSET
= SI_NUM_RESOURCE_PARAMS
,
187 SI_PARAM_VTX0_OFFSET
,
188 SI_PARAM_VTX1_OFFSET
,
189 SI_PARAM_PRIMITIVE_ID
,
190 SI_PARAM_VTX2_OFFSET
,
191 SI_PARAM_VTX3_OFFSET
,
192 SI_PARAM_VTX4_OFFSET
,
193 SI_PARAM_VTX5_OFFSET
,
194 SI_PARAM_GS_INSTANCE_ID
,
196 /* PS only parameters */
197 SI_PARAM_ALPHA_REF
= SI_NUM_RESOURCE_PARAMS
,
199 SI_PARAM_PERSP_SAMPLE
,
200 SI_PARAM_PERSP_CENTER
,
201 SI_PARAM_PERSP_CENTROID
,
202 SI_PARAM_PERSP_PULL_MODEL
,
203 SI_PARAM_LINEAR_SAMPLE
,
204 SI_PARAM_LINEAR_CENTER
,
205 SI_PARAM_LINEAR_CENTROID
,
206 SI_PARAM_LINE_STIPPLE_TEX
,
207 SI_PARAM_POS_X_FLOAT
,
208 SI_PARAM_POS_Y_FLOAT
,
209 SI_PARAM_POS_Z_FLOAT
,
210 SI_PARAM_POS_W_FLOAT
,
213 SI_PARAM_SAMPLE_COVERAGE
,
214 SI_PARAM_POS_FIXED_PT
,
216 /* CS only parameters */
217 SI_PARAM_GRID_SIZE
= SI_NUM_RESOURCE_PARAMS
,
221 SI_NUM_PARAMS
= SI_PARAM_POS_FIXED_PT
+ 9, /* +8 for COLOR[0..1] */
224 /* SI-specific system values. */
226 TGSI_SEMANTIC_DEFAULT_TESSOUTER_SI
= TGSI_SEMANTIC_COUNT
,
227 TGSI_SEMANTIC_DEFAULT_TESSINNER_SI
,
232 /* A shader selector is a gallium CSO and contains shader variants and
233 * binaries for one TGSI program. This can be shared by multiple contexts.
235 struct si_shader_selector
{
236 struct si_screen
*screen
;
237 struct util_queue_fence ready
;
239 /* Should only be used by si_init_shader_selector_async
240 * if thread_index == -1 (non-threaded). */
241 LLVMTargetMachineRef tm
;
242 struct pipe_debug_callback debug
;
243 bool is_debug_context
;
246 struct si_shader
*first_variant
; /* immutable after the first variant */
247 struct si_shader
*last_variant
; /* mutable */
249 /* The compiled TGSI shader expecting a prolog and/or epilog (not
250 * uploaded to a buffer).
252 struct si_shader
*main_shader_part
;
254 struct tgsi_token
*tokens
;
255 struct pipe_stream_output_info so
;
256 struct tgsi_shader_info info
;
258 /* PIPE_SHADER_[VERTEX|FRAGMENT|...] */
262 unsigned esgs_itemsize
;
263 unsigned gs_input_verts_per_prim
;
264 unsigned gs_output_prim
;
265 unsigned gs_max_out_vertices
;
266 unsigned gs_num_invocations
;
267 unsigned max_gs_stream
; /* count - 1 */
268 unsigned gsvs_vertex_size
;
269 unsigned max_gsvs_emit_size
;
272 unsigned color_attr_index
[2];
273 unsigned db_shader_control
;
274 /* Set 0xf or 0x0 (4 bits) per each written output.
275 * ANDed with spi_shader_col_format.
277 unsigned colors_written_4bit
;
282 /* masks of "get_unique_index" bits */
283 uint64_t outputs_written
;
284 uint32_t patch_outputs_written
;
287 /* Valid shader configurations:
289 * API shaders VS | TCS | TES | GS |pass| PS
290 * are compiled as: | | | |thru|
292 * Only VS & PS: VS | -- | -- | -- | -- | PS
293 * With GS: ES | -- | -- | GS | VS | PS
294 * With Tessel.: LS | HS | VS | -- | -- | PS
295 * With both: LS | HS | ES | GS | VS | PS
298 /* Common VS bits between the shader key and the prolog key. */
299 struct si_vs_prolog_bits
{
300 unsigned instance_divisors
[SI_NUM_VERTEX_BUFFERS
];
303 /* Common VS bits between the shader key and the epilog key. */
304 struct si_vs_epilog_bits
{
305 unsigned export_prim_id
:1; /* when PS needs it and GS is disabled */
307 * - skip clipdist, culldist (including clipvertex code) exports based
308 * on which clip_plane_enable bits are set
309 * - skip layer, viewport, clipdist, and culldist parameter exports
310 * if PS doesn't read them
314 /* Common TCS bits between the shader key and the epilog key. */
315 struct si_tcs_epilog_bits
{
316 unsigned prim_mode
:3;
317 uint64_t inputs_to_copy
;
320 /* Common PS bits between the shader key and the prolog key. */
321 struct si_ps_prolog_bits
{
322 unsigned color_two_side
:1;
323 unsigned flatshade_colors
:1;
324 unsigned poly_stipple
:1;
325 unsigned force_persp_sample_interp
:1;
326 unsigned force_linear_sample_interp
:1;
327 unsigned force_persp_center_interp
:1;
328 unsigned force_linear_center_interp
:1;
329 unsigned bc_optimize_for_persp
:1;
330 unsigned bc_optimize_for_linear
:1;
333 /* Common PS bits between the shader key and the epilog key. */
334 struct si_ps_epilog_bits
{
335 unsigned spi_shader_col_format
;
336 unsigned color_is_int8
:8;
337 unsigned last_cbuf
:3;
338 unsigned alpha_func
:3;
339 unsigned alpha_to_one
:1;
340 unsigned poly_line_smoothing
:1;
341 unsigned clamp_color
:1;
344 union si_shader_part_key
{
346 struct si_vs_prolog_bits states
;
347 unsigned num_input_sgprs
:5;
348 unsigned last_input
:4;
351 struct si_vs_epilog_bits states
;
352 unsigned prim_id_param_offset
:5;
355 struct si_tcs_epilog_bits states
;
358 struct si_ps_prolog_bits states
;
359 unsigned num_input_sgprs
:5;
360 unsigned num_input_vgprs
:5;
361 /* Color interpolation and two-side color selection. */
362 unsigned colors_read
:8; /* color input components read */
363 unsigned num_interp_inputs
:5; /* BCOLOR is at this location */
364 unsigned face_vgpr_index
:5;
366 char color_attr_index
[2];
367 char color_interp_vgpr_index
[2]; /* -1 == constant */
370 struct si_ps_epilog_bits states
;
371 unsigned colors_written
:8;
373 unsigned writes_stencil
:1;
374 unsigned writes_samplemask
:1;
378 union si_shader_key
{
380 struct si_ps_prolog_bits prolog
;
381 struct si_ps_epilog_bits epilog
;
384 struct si_vs_prolog_bits prolog
;
385 struct si_vs_epilog_bits epilog
;
386 unsigned as_es
:1; /* export shader */
387 unsigned as_ls
:1; /* local shader */
390 struct si_tcs_epilog_bits epilog
;
391 } tcs
; /* tessellation control shader */
393 struct si_vs_epilog_bits epilog
; /* same as VS */
394 unsigned as_es
:1; /* export shader */
395 } tes
; /* tessellation evaluation shader */
398 struct si_shader_config
{
401 unsigned spilled_sgprs
;
402 unsigned spilled_vgprs
;
404 unsigned spi_ps_input_ena
;
405 unsigned spi_ps_input_addr
;
407 unsigned scratch_bytes_per_wave
;
412 /* GCN-specific shader info. */
413 struct si_shader_info
{
414 ubyte vs_output_param_offset
[SI_MAX_VS_OUTPUTS
];
415 ubyte num_input_sgprs
;
416 ubyte num_input_vgprs
;
417 char face_vgpr_index
;
418 bool uses_instanceid
;
419 ubyte nr_pos_exports
;
420 ubyte nr_param_exports
;
424 struct si_shader_selector
*selector
;
425 struct si_shader
*next_variant
;
427 struct si_shader_part
*prolog
;
428 struct si_shader_part
*epilog
;
430 struct si_shader
*gs_copy_shader
;
431 struct si_pm4_state
*pm4
;
432 struct r600_resource
*bo
;
433 struct r600_resource
*scratch_bo
;
434 union si_shader_key key
;
435 bool is_binary_shared
;
438 /* The following data is all that's needed for binary shaders. */
439 struct radeon_shader_binary binary
;
440 struct si_shader_config config
;
441 struct si_shader_info info
;
443 /* Shader key + LLVM IR + disassembly + statistics.
444 * Generated for debug contexts only.
447 size_t shader_log_size
;
450 struct si_shader_part
{
451 struct si_shader_part
*next
;
452 union si_shader_part_key key
;
453 struct radeon_shader_binary binary
;
454 struct si_shader_config config
;
457 static inline struct tgsi_shader_info
*si_get_vs_info(struct si_context
*sctx
)
459 if (sctx
->gs_shader
.cso
)
460 return &sctx
->gs_shader
.cso
->info
;
461 else if (sctx
->tes_shader
.cso
)
462 return &sctx
->tes_shader
.cso
->info
;
463 else if (sctx
->vs_shader
.cso
)
464 return &sctx
->vs_shader
.cso
->info
;
469 static inline struct si_shader
* si_get_vs_state(struct si_context
*sctx
)
471 if (sctx
->gs_shader
.current
)
472 return sctx
->gs_shader
.current
->gs_copy_shader
;
473 else if (sctx
->tes_shader
.current
)
474 return sctx
->tes_shader
.current
;
476 return sctx
->vs_shader
.current
;
479 static inline bool si_vs_exports_prim_id(struct si_shader
*shader
)
481 if (shader
->selector
->type
== PIPE_SHADER_VERTEX
)
482 return shader
->key
.vs
.epilog
.export_prim_id
;
483 else if (shader
->selector
->type
== PIPE_SHADER_TESS_EVAL
)
484 return shader
->key
.tes
.epilog
.export_prim_id
;
490 int si_compile_tgsi_shader(struct si_screen
*sscreen
,
491 LLVMTargetMachineRef tm
,
492 struct si_shader
*shader
,
494 struct pipe_debug_callback
*debug
);
495 int si_shader_create(struct si_screen
*sscreen
, LLVMTargetMachineRef tm
,
496 struct si_shader
*shader
,
497 struct pipe_debug_callback
*debug
);
498 int si_compile_llvm(struct si_screen
*sscreen
,
499 struct radeon_shader_binary
*binary
,
500 struct si_shader_config
*conf
,
501 LLVMTargetMachineRef tm
,
503 struct pipe_debug_callback
*debug
,
506 void si_shader_destroy(struct si_shader
*shader
);
507 unsigned si_shader_io_get_unique_index(unsigned semantic_name
, unsigned index
);
508 int si_shader_binary_upload(struct si_screen
*sscreen
, struct si_shader
*shader
);
509 void si_shader_dump(struct si_screen
*sscreen
, struct si_shader
*shader
,
510 struct pipe_debug_callback
*debug
, unsigned processor
,
512 void si_shader_apply_scratch_relocs(struct si_context
*sctx
,
513 struct si_shader
*shader
,
514 struct si_shader_config
*config
,
515 uint64_t scratch_va
);
516 void si_shader_binary_read_config(struct radeon_shader_binary
*binary
,
517 struct si_shader_config
*conf
,
518 unsigned symbol_offset
);