panfrost: XMLify beginning of shader descriptor
[mesa.git] / src / gallium / drivers / panfrost / pan_context.h
1 /*
2 * © Copyright 2018 Alyssa Rosenzweig
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 * 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:
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 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 FROM,
20 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 * SOFTWARE.
22 *
23 */
24
25 #ifndef __BUILDER_H__
26 #define __BUILDER_H__
27
28 #define _LARGEFILE64_SOURCE 1
29 #define CACHE_LINE_SIZE 1024 /* TODO */
30 #include <sys/mman.h>
31 #include <assert.h>
32 #include "pan_resource.h"
33 #include "pan_job.h"
34 #include "pan_blend.h"
35 #include "pan_encoder.h"
36 #include "pan_texture.h"
37
38 #include "pipe/p_compiler.h"
39 #include "pipe/p_config.h"
40 #include "pipe/p_context.h"
41 #include "pipe/p_defines.h"
42 #include "pipe/p_format.h"
43 #include "pipe/p_screen.h"
44 #include "pipe/p_state.h"
45 #include "util/u_blitter.h"
46 #include "util/hash_table.h"
47
48 #include "midgard/midgard_compile.h"
49 #include "compiler/shader_enums.h"
50
51 /* Forward declare to avoid extra header dep */
52 struct prim_convert_context;
53
54 #define MAX_VARYINGS 4096
55
56 #define SET_BIT(lval, bit, cond) \
57 if (cond) \
58 lval |= (bit); \
59 else \
60 lval &= ~(bit);
61
62 struct panfrost_constant_buffer {
63 struct pipe_constant_buffer cb[PIPE_MAX_CONSTANT_BUFFERS];
64 uint32_t enabled_mask;
65 uint32_t dirty_mask;
66 };
67
68 struct panfrost_query {
69 /* Passthrough from Gallium */
70 unsigned type;
71 unsigned index;
72
73 /* For computed queries. 64-bit to prevent overflow */
74 struct {
75 uint64_t start;
76 uint64_t end;
77 };
78
79 /* Memory for the GPU to writeback the value of the query */
80 struct panfrost_bo *bo;
81 };
82
83 struct panfrost_fence {
84 struct pipe_reference reference;
85 uint32_t syncobj;
86 bool signaled;
87 };
88
89 struct panfrost_streamout {
90 struct pipe_stream_output_target *targets[PIPE_MAX_SO_BUFFERS];
91 uint32_t offsets[PIPE_MAX_SO_BUFFERS];
92 unsigned num_targets;
93 };
94
95 struct panfrost_context {
96 /* Gallium context */
97 struct pipe_context base;
98
99 /* Bound job batch and map of panfrost_batch_key to job batches */
100 struct panfrost_batch *batch;
101 struct hash_table *batches;
102
103 /* panfrost_bo -> panfrost_bo_access */
104 struct hash_table *accessed_bos;
105
106 /* Within a launch_grid call.. */
107 const struct pipe_grid_info *compute_grid;
108
109 /* Bit mask for supported PIPE_DRAW for this hardware */
110 unsigned draw_modes;
111
112 struct pipe_framebuffer_state pipe_framebuffer;
113 struct panfrost_streamout streamout;
114
115 bool active_queries;
116 uint64_t prims_generated;
117 uint64_t tf_prims_generated;
118 struct panfrost_query *occlusion_query;
119
120 unsigned vertex_count;
121 unsigned instance_count;
122 enum pipe_prim_type active_prim;
123
124 /* If instancing is enabled, vertex count padded for instance; if
125 * it is disabled, just equal to plain vertex count */
126 unsigned padded_count;
127
128 /* TODO: Multiple uniform buffers (index =/= 0), finer updates? */
129
130 struct panfrost_constant_buffer constant_buffer[PIPE_SHADER_TYPES];
131
132 struct panfrost_rasterizer *rasterizer;
133 struct panfrost_shader_variants *shader[PIPE_SHADER_TYPES];
134 struct panfrost_vertex_state *vertex;
135
136 struct pipe_vertex_buffer vertex_buffers[PIPE_MAX_ATTRIBS];
137 uint32_t vb_mask;
138
139 struct pipe_shader_buffer ssbo[PIPE_SHADER_TYPES][PIPE_MAX_SHADER_BUFFERS];
140 uint32_t ssbo_mask[PIPE_SHADER_TYPES];
141
142 struct panfrost_sampler_state *samplers[PIPE_SHADER_TYPES][PIPE_MAX_SAMPLERS];
143 unsigned sampler_count[PIPE_SHADER_TYPES];
144
145 struct panfrost_sampler_view *sampler_views[PIPE_SHADER_TYPES][PIPE_MAX_SHADER_SAMPLER_VIEWS];
146 unsigned sampler_view_count[PIPE_SHADER_TYPES];
147
148 struct primconvert_context *primconvert;
149 struct blitter_context *blitter;
150
151 /* Blitting the wallpaper (the old contents of the framebuffer back to
152 * itself) uses a dedicated u_blitter instance versus general blit()
153 * callbacks from Gallium, as the blit() callback can trigger
154 * wallpapering without Gallium realising, which in turns u_blitter
155 * errors due to unsupported reucrsion */
156
157 struct blitter_context *blitter_wallpaper;
158 struct panfrost_batch *wallpaper_batch;
159
160 struct panfrost_blend_state *blend;
161
162 struct pipe_viewport_state pipe_viewport;
163 struct pipe_scissor_state scissor;
164 struct pipe_blend_color blend_color;
165 struct panfrost_zsa_state *depth_stencil;
166 struct pipe_stencil_ref stencil_ref;
167 unsigned sample_mask;
168 unsigned min_samples;
169
170 struct panfrost_blend_state blit_blend;
171 };
172
173 /* Corresponds to the CSO */
174
175 struct panfrost_rasterizer {
176 struct pipe_rasterizer_state base;
177 };
178
179 /* Variants bundle together to form the backing CSO, bundling multiple
180 * shaders with varying emulated features baked in */
181
182 /* A shader state corresponds to the actual, current variant of the shader */
183 struct panfrost_shader_state {
184 /* Compiled, mapped descriptor, ready for the hardware */
185 bool compiled;
186 struct mali_shader_packed shader;
187
188 /* Non-descript information */
189 unsigned uniform_count;
190 unsigned work_reg_count;
191 bool can_discard;
192 bool writes_point_size;
193 bool writes_depth;
194 bool writes_stencil;
195 bool reads_point_coord;
196 bool reads_face;
197 bool reads_frag_coord;
198 bool writes_global;
199 unsigned stack_size;
200 unsigned shared_size;
201
202 /* Does the fragment shader have side effects? In particular, if output
203 * is masked out, is it legal to skip shader execution? */
204 bool fs_sidefx;
205
206 /* For Bifrost - output type for each RT */
207 enum bifrost_shader_type blend_types[BIFROST_MAX_RENDER_TARGET_COUNT];
208
209 unsigned attribute_count, varying_count;
210 enum mali_format varyings[PIPE_MAX_ATTRIBS];
211 gl_varying_slot varyings_loc[PIPE_MAX_ATTRIBS];
212 struct pipe_stream_output_info stream_output;
213 uint64_t so_mask;
214
215 unsigned sysval_count;
216 unsigned sysval[MAX_SYSVAL_COUNT];
217
218 uint16_t point_sprite_mask;
219 unsigned point_sprite_upper_left : 1;
220
221 /* Should we enable helper invocations */
222 bool helper_invocations;
223
224 /* GPU-executable memory */
225 struct panfrost_bo *bo;
226
227 BITSET_WORD outputs_read;
228 enum pipe_format rt_formats[8];
229 };
230
231 /* A collection of varyings (the CSO) */
232 struct panfrost_shader_variants {
233 /* A panfrost_shader_variants can represent a shader for
234 * either graphics or compute */
235
236 bool is_compute;
237
238 union {
239 struct pipe_shader_state base;
240 struct pipe_compute_state cbase;
241 };
242
243 struct panfrost_shader_state *variants;
244 unsigned variant_space;
245
246 unsigned variant_count;
247
248 /* The current active variant */
249 unsigned active_variant;
250 };
251
252 struct panfrost_vertex_state {
253 unsigned num_elements;
254
255 struct pipe_vertex_element pipe[PIPE_MAX_ATTRIBS];
256 unsigned formats[PIPE_MAX_ATTRIBS];
257 };
258
259 struct panfrost_zsa_state {
260 struct pipe_depth_stencil_alpha_state base;
261
262 /* Precomputed stencil state */
263 struct mali_stencil_packed stencil_front;
264 struct mali_stencil_packed stencil_back;
265 u8 stencil_mask_front;
266 u8 stencil_mask_back;
267 };
268
269 struct panfrost_sampler_state {
270 struct pipe_sampler_state base;
271 struct mali_midgard_sampler_packed hw;
272 };
273
274 /* Misnomer: Sampler view corresponds to textures, not samplers */
275
276 struct panfrost_sampler_view {
277 struct pipe_sampler_view base;
278 struct panfrost_bo *bo;
279 struct mali_bifrost_texture_packed bifrost_descriptor;
280 mali_ptr texture_bo;
281 uint64_t modifier;
282 };
283
284 static inline struct panfrost_context *
285 pan_context(struct pipe_context *pcontext)
286 {
287 return (struct panfrost_context *) pcontext;
288 }
289
290 static inline struct panfrost_shader_state *
291 panfrost_get_shader_state(struct panfrost_context *ctx,
292 enum pipe_shader_type st)
293 {
294 struct panfrost_shader_variants *all = ctx->shader[st];
295
296 if (!all)
297 return NULL;
298
299 return &all->variants[all->active_variant];
300 }
301
302 struct pipe_context *
303 panfrost_create_context(struct pipe_screen *screen, void *priv, unsigned flags);
304
305 bool
306 panfrost_writes_point_size(struct panfrost_context *ctx);
307
308 struct panfrost_transfer
309 panfrost_vertex_tiler_job(struct panfrost_context *ctx, bool is_tiler);
310
311 void
312 panfrost_flush(
313 struct pipe_context *pipe,
314 struct pipe_fence_handle **fence,
315 unsigned flags);
316
317 mali_ptr panfrost_sfbd_fragment(struct panfrost_batch *batch, bool has_draws);
318 mali_ptr panfrost_mfbd_fragment(struct panfrost_batch *batch, bool has_draws);
319
320 void
321 panfrost_attach_mfbd(struct panfrost_batch *batch, unsigned vertex_count);
322
323 void
324 panfrost_attach_sfbd(struct panfrost_batch *batch, unsigned vertex_count);
325
326 struct midgard_tiler_descriptor
327 panfrost_emit_midg_tiler(struct panfrost_batch *batch, unsigned vertex_count);
328
329 mali_ptr
330 panfrost_fragment_job(struct panfrost_batch *batch, bool has_draws);
331
332 void
333 panfrost_shader_compile(struct panfrost_context *ctx,
334 enum pipe_shader_ir ir_type,
335 const void *ir,
336 gl_shader_stage stage,
337 struct panfrost_shader_state *state,
338 uint64_t *outputs_written);
339
340 unsigned
341 panfrost_ubo_count(struct panfrost_context *ctx, enum pipe_shader_type stage);
342
343 void
344 panfrost_create_sampler_view_bo(struct panfrost_sampler_view *so,
345 struct pipe_context *pctx,
346 struct pipe_resource *texture);
347
348 /* Instancing */
349
350 mali_ptr
351 panfrost_vertex_buffer_address(struct panfrost_context *ctx, unsigned i);
352
353 /* Compute */
354
355 void
356 panfrost_compute_context_init(struct pipe_context *pctx);
357
358
359 #endif