2 * Copyright © 2010 - 2015 Intel Corporation
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 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
8 * and/or sell copies of the Software, and to permit persons to whom the
9 * 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 NONINFRINGEMENT. IN NO EVENT SHALL
18 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
27 #include "brw_device_info.h"
28 #include "main/mtypes.h"
36 struct brw_geometry_program
;
37 union gl_constant_value
;
40 const struct brw_device_info
*devinfo
;
46 * Array of the ra classes for the unaligned contiguous register
52 * Mapping for register-allocated objects in *regs to the first
53 * GRF for that object.
55 uint8_t *ra_reg_to_grf
;
62 * Array of the ra classes for the unaligned contiguous register
63 * block sizes used, indexed by register size.
68 * Mapping from classes to ra_reg ranges. Each of the per-size
69 * classes corresponds to a range of ra_reg nodes. This array stores
70 * those ranges in the form of first ra_reg in each class and the
71 * total number of ra_reg elements in the last array element. This
72 * way the range of the i'th class is given by:
73 * [ class_to_ra_reg_range[i], class_to_ra_reg_range[i+1] )
75 int class_to_ra_reg_range
[17];
78 * Mapping for register-allocated objects in *regs to the first
79 * GRF for that object.
81 uint8_t *ra_reg_to_grf
;
84 * ra class for the aligned pairs we use for PLN, which doesn't
87 int aligned_pairs_class
;
90 void (*shader_debug_log
)(void *, const char *str
, ...) PRINTFLIKE(2, 3);
91 void (*shader_perf_log
)(void *, const char *str
, ...) PRINTFLIKE(2, 3);
93 bool scalar_stage
[MESA_SHADER_STAGES
];
94 struct gl_shader_compiler_options glsl_compiler_options
[MESA_SHADER_STAGES
];
98 brw_compiler_create(void *mem_ctx
, const struct brw_device_info
*devinfo
);
102 * Program key structures.
104 * When drawing, we look for the currently bound shaders in the program
105 * cache. This is essentially a hash table lookup, and these are the keys.
107 * Sometimes OpenGL features specified as state need to be simulated via
108 * shader code, due to a mismatch between the API and the hardware. This
109 * is often referred to as "non-orthagonal state" or "NOS". We store NOS
110 * in the program key so it's considered when searching for a program. If
111 * we haven't seen a particular combination before, we have to recompile a
112 * new specialized version.
114 * Shader compilation should not look up state in gl_context directly, but
115 * instead use the copy in the program key. This guarantees recompiles will
121 enum PACKED gen6_gather_sampler_wa
{
122 WA_SIGN
= 1, /* whether we need to sign extend */
123 WA_8BIT
= 2, /* if we have an 8bit format needing wa */
124 WA_16BIT
= 4, /* if we have a 16bit format needing wa */
128 * Sampler information needed by VS, WM, and GS program cache keys.
130 struct brw_sampler_prog_key_data
{
132 * EXT_texture_swizzle and DEPTH_TEXTURE_MODE swizzles.
134 uint16_t swizzles
[MAX_SAMPLERS
];
136 uint32_t gl_clamp_mask
[3];
139 * For RG32F, gather4's channel select is broken.
141 uint32_t gather_channel_quirk_mask
;
144 * Whether this sampler uses the compressed multisample surface layout.
146 uint32_t compressed_multisample_layout_mask
;
149 * Whether this sampler is using 16x multisampling. If so fetching from
150 * this sampler will be handled with a different instruction, ld2dms_w
156 * For Sandybridge, which shader w/a we need for gather quirks.
158 enum gen6_gather_sampler_wa gen6_gather_wa
[MAX_SAMPLERS
];
162 /** The program key for Vertex Shaders. */
163 struct brw_vs_prog_key
{
164 unsigned program_string_id
;
167 * Per-attribute workaround flags
169 uint8_t gl_attrib_wa_flags
[VERT_ATTRIB_MAX
];
171 bool copy_edgeflag
:1;
173 bool clamp_vertex_color
:1;
176 * How many user clipping planes are being uploaded to the vertex shader as
179 * These are used for lowering legacy gl_ClipVertex/gl_Position clipping to
182 unsigned nr_userclip_plane_consts
:4;
185 * For pre-Gen6 hardware, a bitfield indicating which texture coordinates
186 * are going to be replaced with point coordinates (as a consequence of a
187 * call to glTexEnvi(GL_POINT_SPRITE, GL_COORD_REPLACE, GL_TRUE)). Because
188 * our SF thread requires exact matching between VS outputs and FS inputs,
189 * these texture coordinates will need to be unconditionally included in
190 * the VUE, even if they aren't written by the vertex shader.
192 uint8_t point_coord_replace
;
194 struct brw_sampler_prog_key_data tex
;
197 /** The program key for Tessellation Control Shaders. */
198 struct brw_tcs_prog_key
200 unsigned program_string_id
;
202 GLenum tes_primitive_mode
;
204 unsigned input_vertices
;
206 /** A bitfield of per-patch outputs written. */
207 uint32_t patch_outputs_written
;
209 /** A bitfield of per-vertex outputs written. */
210 uint64_t outputs_written
;
212 struct brw_sampler_prog_key_data tex
;
215 /** The program key for Tessellation Evaluation Shaders. */
216 struct brw_tes_prog_key
218 unsigned program_string_id
;
220 /** A bitfield of per-patch inputs read. */
221 uint32_t patch_inputs_read
;
223 /** A bitfield of per-vertex inputs read. */
224 uint64_t inputs_read
;
226 struct brw_sampler_prog_key_data tex
;
229 /** The program key for Geometry Shaders. */
230 struct brw_gs_prog_key
232 unsigned program_string_id
;
234 struct brw_sampler_prog_key_data tex
;
237 /** The program key for Fragment/Pixel Shaders. */
238 struct brw_wm_prog_key
{
242 bool persample_shading
:1;
244 unsigned nr_color_regions
:5;
245 bool replicate_alpha
:1;
246 bool render_to_fbo
:1;
247 bool clamp_fragment_color
:1;
248 bool compute_pos_offset
:1;
249 bool compute_sample_id
:1;
251 bool high_quality_derivatives
:1;
253 uint16_t drawable_height
;
254 uint64_t input_slots_valid
;
255 unsigned program_string_id
;
256 GLenum alpha_test_func
; /* < For Gen4/5 MRT alpha test */
257 float alpha_test_ref
;
259 struct brw_sampler_prog_key_data tex
;
262 struct brw_cs_prog_key
{
263 uint32_t program_string_id
;
264 struct brw_sampler_prog_key_data tex
;
268 * Image metadata structure as laid out in the shader parameter
269 * buffer. Entries have to be 16B-aligned for the vec4 back-end to be
270 * able to use them. That's okay because the padding and any unused
271 * entries [most of them except when we're doing untyped surface
272 * access] will be removed by the uniform packing pass.
274 #define BRW_IMAGE_PARAM_SURFACE_IDX_OFFSET 0
275 #define BRW_IMAGE_PARAM_OFFSET_OFFSET 4
276 #define BRW_IMAGE_PARAM_SIZE_OFFSET 8
277 #define BRW_IMAGE_PARAM_STRIDE_OFFSET 12
278 #define BRW_IMAGE_PARAM_TILING_OFFSET 16
279 #define BRW_IMAGE_PARAM_SWIZZLING_OFFSET 20
280 #define BRW_IMAGE_PARAM_SIZE 24
282 struct brw_image_param
{
283 /** Surface binding table index. */
284 uint32_t surface_idx
;
286 /** Offset applied to the X and Y surface coordinates. */
289 /** Surface X, Y and Z dimensions. */
292 /** X-stride in bytes, Y-stride in pixels, horizontal slice stride in
293 * pixels, vertical slice stride in pixels.
297 /** Log2 of the tiling modulus in the X, Y and Z dimension. */
301 * Right shift to apply for bit 6 address swizzling. Two different
302 * swizzles can be specified and will be applied one after the other. The
303 * resulting address will be:
305 * addr' = addr ^ ((1 << 6) & ((addr >> swizzling[0]) ^
306 * (addr >> swizzling[1])))
308 * Use \c 0xff if any of the swizzles is not required.
310 uint32_t swizzling
[2];
313 struct brw_stage_prog_data
{
315 /** size of our binding table. */
319 * surface indices for the various groups of surfaces
321 uint32_t pull_constants_start
;
322 uint32_t texture_start
;
323 uint32_t gather_texture_start
;
327 uint32_t image_start
;
328 uint32_t shader_time_start
;
332 GLuint nr_params
; /**< number of float params/constants */
333 GLuint nr_pull_params
;
334 unsigned nr_image_params
;
336 unsigned curb_read_length
;
337 unsigned total_scratch
;
338 unsigned total_shared
;
341 * Register where the thread expects to find input data from the URB
342 * (typically uniforms, followed by vertex or fragment attributes).
344 unsigned dispatch_grf_start_reg
;
346 bool use_alt_mode
; /**< Use ALT floating point mode? Otherwise, IEEE. */
348 /* Pointers to tracked values (only valid once
349 * _mesa_load_state_parameters has been called at runtime).
351 const union gl_constant_value
**param
;
352 const union gl_constant_value
**pull_param
;
354 /** Image metadata passed to the shader as uniforms. */
355 struct brw_image_param
*image_param
;
358 /* Data about a particular attempt to compile a program. Note that
359 * there can be many of these, each in a different GL state
360 * corresponding to a different brw_wm_prog_key struct, with different
363 struct brw_wm_prog_data
{
364 struct brw_stage_prog_data base
;
366 GLuint num_varying_inputs
;
368 GLuint dispatch_grf_start_reg_16
;
370 GLuint reg_blocks_16
;
374 * surface indices the WM-specific surfaces
376 uint32_t render_target_start
;
380 uint8_t computed_depth_mode
;
381 bool computed_stencil
;
383 bool early_fragment_tests
;
386 bool uses_pos_offset
;
390 uint32_t prog_offset_16
;
393 * Mask of which interpolation modes are required by the fragment shader.
394 * Used in hardware setup on gen6+.
396 uint32_t barycentric_interp_modes
;
399 * Map from gl_varying_slot to the position within the FS setup data
400 * payload where the varying's attribute vertex deltas should be delivered.
401 * For varying slots that are not used by the FS, the value is -1.
403 int urb_setup
[VARYING_SLOT_MAX
];
406 struct brw_cs_prog_data
{
407 struct brw_stage_prog_data base
;
409 GLuint dispatch_grf_start_reg_16
;
410 unsigned local_size
[3];
413 bool uses_num_work_groups
;
414 unsigned local_invocation_id_regs
;
418 * surface indices the CS-specific surfaces
420 uint32_t work_groups_start
;
426 * Enum representing the i965-specific vertex results that don't correspond
427 * exactly to any element of gl_varying_slot. The values of this enum are
428 * assigned such that they don't conflict with gl_varying_slot.
432 BRW_VARYING_SLOT_NDC
= VARYING_SLOT_MAX
,
433 BRW_VARYING_SLOT_PAD
,
435 * Technically this is not a varying but just a placeholder that
436 * compile_sf_prog() inserts into its VUE map to cause the gl_PointCoord
437 * builtin variable to be compiled correctly. see compile_sf_prog() for
440 BRW_VARYING_SLOT_PNTC
,
441 BRW_VARYING_SLOT_COUNT
445 * Data structure recording the relationship between the gl_varying_slot enum
446 * and "slots" within the vertex URB entry (VUE). A "slot" is defined as a
447 * single octaword within the VUE (128 bits).
449 * Note that each BRW register contains 256 bits (2 octawords), so when
450 * accessing the VUE in URB_NOSWIZZLE mode, each register corresponds to two
451 * consecutive VUE slots. When accessing the VUE in URB_INTERLEAVED mode (as
452 * in a vertex shader), each register corresponds to a single VUE slot, since
453 * it contains data for two separate vertices.
457 * Bitfield representing all varying slots that are (a) stored in this VUE
458 * map, and (b) actually written by the shader. Does not include any of
459 * the additional varying slots defined in brw_varying_slot.
461 GLbitfield64 slots_valid
;
464 * Is this VUE map for a separate shader pipeline?
466 * Separable programs (GL_ARB_separate_shader_objects) can be mixed and matched
467 * without the linker having a chance to dead code eliminate unused varyings.
469 * This means that we have to use a fixed slot layout, based on the output's
470 * location field, rather than assigning slots in a compact contiguous block.
475 * Map from gl_varying_slot value to VUE slot. For gl_varying_slots that are
476 * not stored in a slot (because they are not written, or because
477 * additional processing is applied before storing them in the VUE), the
480 signed char varying_to_slot
[VARYING_SLOT_TESS_MAX
];
483 * Map from VUE slot to gl_varying_slot value. For slots that do not
484 * directly correspond to a gl_varying_slot, the value comes from
487 * For slots that are not in use, the value is BRW_VARYING_SLOT_PAD.
489 signed char slot_to_varying
[VARYING_SLOT_TESS_MAX
];
492 * Total number of VUE slots in use
497 * Number of per-patch VUE slots. Only valid for tessellation control
498 * shader outputs and tessellation evaluation shader inputs.
500 int num_per_patch_slots
;
503 * Number of per-vertex VUE slots. Only valid for tessellation control
504 * shader outputs and tessellation evaluation shader inputs.
506 int num_per_vertex_slots
;
509 void brw_print_vue_map(FILE *fp
, const struct brw_vue_map
*vue_map
);
512 * Convert a VUE slot number into a byte offset within the VUE.
514 static inline GLuint
brw_vue_slot_to_offset(GLuint slot
)
520 * Convert a vertex output (brw_varying_slot) into a byte offset within the
524 GLuint
brw_varying_to_offset(const struct brw_vue_map
*vue_map
, GLuint varying
)
526 return brw_vue_slot_to_offset(vue_map
->varying_to_slot
[varying
]);
529 void brw_compute_vue_map(const struct brw_device_info
*devinfo
,
530 struct brw_vue_map
*vue_map
,
531 GLbitfield64 slots_valid
,
532 bool separate_shader
);
534 void brw_compute_tess_vue_map(struct brw_vue_map
*const vue_map
,
535 const GLbitfield64 slots_valid
,
536 const GLbitfield is_patch
);
538 enum shader_dispatch_mode
{
539 DISPATCH_MODE_4X1_SINGLE
= 0,
540 DISPATCH_MODE_4X2_DUAL_INSTANCE
= 1,
541 DISPATCH_MODE_4X2_DUAL_OBJECT
= 2,
542 DISPATCH_MODE_SIMD8
= 3,
546 * @defgroup Tessellator parameter enumerations.
548 * These correspond to the hardware values in 3DSTATE_TE, and are provided
549 * as part of the tessellation evaluation shader.
553 enum brw_tess_partitioning
{
554 BRW_TESS_PARTITIONING_INTEGER
= 0,
555 BRW_TESS_PARTITIONING_ODD_FRACTIONAL
= 1,
556 BRW_TESS_PARTITIONING_EVEN_FRACTIONAL
= 2,
559 enum brw_tess_output_topology
{
560 BRW_TESS_OUTPUT_TOPOLOGY_POINT
= 0,
561 BRW_TESS_OUTPUT_TOPOLOGY_LINE
= 1,
562 BRW_TESS_OUTPUT_TOPOLOGY_TRI_CW
= 2,
563 BRW_TESS_OUTPUT_TOPOLOGY_TRI_CCW
= 3,
566 enum brw_tess_domain
{
567 BRW_TESS_DOMAIN_QUAD
= 0,
568 BRW_TESS_DOMAIN_TRI
= 1,
569 BRW_TESS_DOMAIN_ISOLINE
= 2,
573 struct brw_vue_prog_data
{
574 struct brw_stage_prog_data base
;
575 struct brw_vue_map vue_map
;
577 /** Should the hardware deliver input VUE handles for URB pull loads? */
578 bool include_vue_handles
;
580 GLuint urb_read_length
;
583 /* Used for calculating urb partitions. In the VS, this is the size of the
584 * URB entry used for both input and output to the thread. In the GS, this
585 * is the size of the URB entry used for output.
587 GLuint urb_entry_size
;
589 enum shader_dispatch_mode dispatch_mode
;
592 struct brw_vs_prog_data
{
593 struct brw_vue_prog_data base
;
595 GLbitfield64 inputs_read
;
597 unsigned nr_attributes
;
600 bool uses_instanceid
;
601 bool uses_basevertex
;
602 bool uses_baseinstance
;
606 struct brw_tcs_prog_data
608 struct brw_vue_prog_data base
;
610 /** Number vertices in output patch */
615 struct brw_tes_prog_data
617 struct brw_vue_prog_data base
;
619 enum brw_tess_partitioning partitioning
;
620 enum brw_tess_output_topology output_topology
;
621 enum brw_tess_domain domain
;
624 struct brw_gs_prog_data
626 struct brw_vue_prog_data base
;
629 * Size of an output vertex, measured in HWORDS (32 bytes).
631 unsigned output_vertex_size_hwords
;
633 unsigned output_topology
;
636 * Size of the control data (cut bits or StreamID bits), in hwords (32
637 * bytes). 0 if there is no control data.
639 unsigned control_data_header_size_hwords
;
642 * Format of the control data (either GEN7_GS_CONTROL_DATA_FORMAT_GSCTL_SID
643 * if the control data is StreamID bits, or
644 * GEN7_GS_CONTROL_DATA_FORMAT_GSCTL_CUT if the control data is cut bits).
645 * Ignored if control_data_header_size is 0.
647 unsigned control_data_format
;
649 bool include_primitive_id
;
652 * The number of vertices emitted, if constant - otherwise -1.
654 int static_vertex_count
;
659 * Gen6 transform feedback enabled flag.
661 bool gen6_xfb_enabled
;
664 * Gen6: Provoking vertex convention for odd-numbered triangles
670 * Gen6: Number of varyings that are output to transform feedback.
672 GLuint num_transform_feedback_bindings
:7; /* 0-BRW_MAX_SOL_BINDINGS */
675 * Gen6: Map from the index of a transform feedback binding table entry to the
676 * gl_varying_slot that should be streamed out through that binding table
679 unsigned char transform_feedback_bindings
[64 /* BRW_MAX_SOL_BINDINGS */];
682 * Gen6: Map from the index of a transform feedback binding table entry to the
683 * swizzles that should be used when streaming out data through that
684 * binding table entry.
686 unsigned char transform_feedback_swizzles
[64 /* BRW_MAX_SOL_BINDINGS */];
693 * Compile a vertex shader.
695 * Returns the final assembly and the program's size.
698 brw_compile_vs(const struct brw_compiler
*compiler
, void *log_data
,
700 const struct brw_vs_prog_key
*key
,
701 struct brw_vs_prog_data
*prog_data
,
702 const struct nir_shader
*shader
,
703 gl_clip_plane
*clip_planes
,
704 bool use_legacy_snorm_formula
,
705 int shader_time_index
,
706 unsigned *final_assembly_size
,
710 * Compile a tessellation control shader.
712 * Returns the final assembly and the program's size.
715 brw_compile_tcs(const struct brw_compiler
*compiler
,
718 const struct brw_tcs_prog_key
*key
,
719 struct brw_tcs_prog_data
*prog_data
,
720 const struct nir_shader
*nir
,
721 int shader_time_index
,
722 unsigned *final_assembly_size
,
726 * Compile a tessellation evaluation shader.
728 * Returns the final assembly and the program's size.
731 brw_compile_tes(const struct brw_compiler
*compiler
, void *log_data
,
733 const struct brw_tes_prog_key
*key
,
734 struct brw_tes_prog_data
*prog_data
,
735 const struct nir_shader
*shader
,
736 struct gl_shader_program
*shader_prog
,
737 int shader_time_index
,
738 unsigned *final_assembly_size
,
742 * Compile a vertex shader.
744 * Returns the final assembly and the program's size.
747 brw_compile_gs(const struct brw_compiler
*compiler
, void *log_data
,
749 const struct brw_gs_prog_key
*key
,
750 struct brw_gs_prog_data
*prog_data
,
751 const struct nir_shader
*shader
,
752 struct gl_shader_program
*shader_prog
,
753 int shader_time_index
,
754 unsigned *final_assembly_size
,
758 * Compile a fragment shader.
760 * Returns the final assembly and the program's size.
763 brw_compile_fs(const struct brw_compiler
*compiler
, void *log_data
,
765 const struct brw_wm_prog_key
*key
,
766 struct brw_wm_prog_data
*prog_data
,
767 const struct nir_shader
*shader
,
768 struct gl_program
*prog
,
769 int shader_time_index8
,
770 int shader_time_index16
,
772 unsigned *final_assembly_size
,
776 * Compile a compute shader.
778 * Returns the final assembly and the program's size.
781 brw_compile_cs(const struct brw_compiler
*compiler
, void *log_data
,
783 const struct brw_cs_prog_key
*key
,
784 struct brw_cs_prog_data
*prog_data
,
785 const struct nir_shader
*shader
,
786 int shader_time_index
,
787 unsigned *final_assembly_size
,
791 * Fill out local id payload for compute shader according to cs_prog_data.
794 brw_cs_fill_local_id_payload(const struct brw_cs_prog_data
*cs_prog_data
,
795 void *buffer
, uint32_t threads
, uint32_t stride
);