3d3dcc2e8e7d1695aeb2535a029c87cef939fcb7
[mesa.git] / src / amd / common / ac_shader_abi.h
1 /*
2 * Copyright 2017 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
24 #ifndef AC_SHADER_ABI_H
25 #define AC_SHADER_ABI_H
26
27 #include <llvm-c/Core.h>
28
29 #include "compiler/shader_enums.h"
30
31 enum ac_descriptor_type {
32 AC_DESC_IMAGE,
33 AC_DESC_FMASK,
34 AC_DESC_SAMPLER,
35 AC_DESC_BUFFER,
36 };
37
38 /* Document the shader ABI during compilation. This is what allows radeonsi and
39 * radv to share a compiler backend.
40 */
41 struct ac_shader_abi {
42 LLVMValueRef base_vertex;
43 LLVMValueRef start_instance;
44 LLVMValueRef draw_id;
45 LLVMValueRef vertex_id;
46 LLVMValueRef instance_id;
47 LLVMValueRef tcs_patch_id;
48 LLVMValueRef tcs_rel_ids;
49 LLVMValueRef tes_patch_id;
50 LLVMValueRef gs_prim_id;
51 LLVMValueRef gs_invocation_id;
52 LLVMValueRef frag_pos[4];
53 LLVMValueRef front_face;
54 LLVMValueRef ancillary;
55 LLVMValueRef sample_coverage;
56 LLVMValueRef prim_mask;
57 LLVMValueRef workgroup_ids[3];
58
59 /* For VS and PS: pre-loaded shader inputs.
60 *
61 * Currently only used for NIR shaders; indexed by variables'
62 * driver_location.
63 */
64 LLVMValueRef *inputs;
65
66 void (*emit_outputs)(struct ac_shader_abi *abi,
67 unsigned max_outputs,
68 LLVMValueRef *addrs);
69
70 void (*emit_vertex)(struct ac_shader_abi *abi,
71 unsigned stream,
72 LLVMValueRef *addrs);
73
74 void (*emit_primitive)(struct ac_shader_abi *abi,
75 unsigned stream);
76
77 LLVMValueRef (*load_inputs)(struct ac_shader_abi *abi,
78 unsigned location,
79 unsigned driver_location,
80 unsigned component,
81 unsigned num_components,
82 unsigned vertex_index,
83 unsigned const_index,
84 LLVMTypeRef type);
85
86 LLVMValueRef (*load_tess_varyings)(struct ac_shader_abi *abi,
87 LLVMValueRef vertex_index,
88 LLVMValueRef param_index,
89 unsigned const_index,
90 unsigned location,
91 unsigned driver_location,
92 unsigned component,
93 unsigned num_components,
94 bool is_patch,
95 bool is_compact,
96 bool load_inputs);
97
98 void (*store_tcs_outputs)(struct ac_shader_abi *abi,
99 LLVMValueRef vertex_index,
100 LLVMValueRef param_index,
101 unsigned const_index,
102 unsigned location,
103 unsigned driver_location,
104 LLVMValueRef src,
105 unsigned component,
106 bool is_patch,
107 bool is_compact,
108 unsigned writemask);
109
110 LLVMValueRef (*load_tess_coord)(struct ac_shader_abi *abi,
111 LLVMTypeRef type,
112 unsigned num_components);
113
114 LLVMValueRef (*load_patch_vertices_in)(struct ac_shader_abi *abi);
115
116 LLVMValueRef (*load_tess_level)(struct ac_shader_abi *abi,
117 unsigned varying_id);
118
119
120 LLVMValueRef (*load_ubo)(struct ac_shader_abi *abi, LLVMValueRef index);
121
122 /**
123 * Load the descriptor for the given buffer.
124 *
125 * \param buffer the buffer as presented in NIR: this is the descriptor
126 * in Vulkan, and the buffer index in OpenGL/Gallium
127 * \param write whether buffer contents will be written
128 */
129 LLVMValueRef (*load_ssbo)(struct ac_shader_abi *abi,
130 LLVMValueRef buffer, bool write);
131
132 /**
133 * Load a descriptor associated to a sampler.
134 *
135 * \param descriptor_set the descriptor set index (only for Vulkan)
136 * \param base_index the base index of the sampler variable
137 * \param constant_index constant part of an array index (or 0, if the
138 * sampler variable is not an array)
139 * \param index non-constant part of an array index (may be NULL)
140 * \param desc_type the type of descriptor to load
141 * \param image whether the descriptor is loaded for an image operation
142 */
143 LLVMValueRef (*load_sampler_desc)(struct ac_shader_abi *abi,
144 unsigned descriptor_set,
145 unsigned base_index,
146 unsigned constant_index,
147 LLVMValueRef index,
148 enum ac_descriptor_type desc_type,
149 bool image, bool write);
150
151 LLVMValueRef (*lookup_interp_param)(struct ac_shader_abi *abi,
152 enum glsl_interp_mode interp,
153 unsigned location);
154
155 LLVMValueRef (*load_sample_position)(struct ac_shader_abi *abi,
156 LLVMValueRef sample_id);
157
158 /* Whether to clamp the shadow reference value to [0,1]on VI. Radeonsi currently
159 * uses it due to promoting D16 to D32, but radv needs it off. */
160 bool clamp_shadow_reference;
161 };
162
163 #endif /* AC_SHADER_ABI_H */