1 /*
2 * Copyright 2018 Collabora Ltd.
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 ZINK_PROGRAM_H
25 #define ZINK_PROGRAM_H
26
27 #include "zink_types.h"
28 #ifdef __cplusplus
29 extern "C" {
30 #endif
31 #include "util/u_prim.h"
32
33 struct compute_pipeline_cache_entry {
34 struct zink_compute_pipeline_state state;
35 VkPipeline pipeline;
36 };
37
38 #define ZINK_MAX_INLINED_VARIANTS 5
39
40 static inline enum zink_descriptor_type
zink_desc_type_from_vktype(VkDescriptorType type)41 zink_desc_type_from_vktype(VkDescriptorType type)
42 {
43 switch (type) {
44 case VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER:
45 case VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC:
46 return ZINK_DESCRIPTOR_TYPE_UBO;
47 case VK_DESCRIPTOR_TYPE_SAMPLED_IMAGE:
48 case VK_DESCRIPTOR_TYPE_SAMPLER:
49 case VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER:
50 case VK_DESCRIPTOR_TYPE_UNIFORM_TEXEL_BUFFER:
51 return ZINK_DESCRIPTOR_TYPE_SAMPLER_VIEW;
52 case VK_DESCRIPTOR_TYPE_STORAGE_BUFFER:
53 return ZINK_DESCRIPTOR_TYPE_SSBO;
54 case VK_DESCRIPTOR_TYPE_STORAGE_IMAGE:
55 case VK_DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER:
56 return ZINK_DESCRIPTOR_TYPE_IMAGE;
57 default:
58 unreachable("unhandled descriptor type");
59 }
60 }
61
62 static inline VkPrimitiveTopology
zink_primitive_topology(enum mesa_prim mode)63 zink_primitive_topology(enum mesa_prim mode)
64 {
65 switch (mode) {
66 case MESA_PRIM_POINTS:
67 return VK_PRIMITIVE_TOPOLOGY_POINT_LIST;
68
69 case MESA_PRIM_LINES:
70 return VK_PRIMITIVE_TOPOLOGY_LINE_LIST;
71
72 case MESA_PRIM_LINE_STRIP:
73 return VK_PRIMITIVE_TOPOLOGY_LINE_STRIP;
74
75 case MESA_PRIM_TRIANGLES:
76 return VK_PRIMITIVE_TOPOLOGY_TRIANGLE_LIST;
77
78 case MESA_PRIM_TRIANGLE_STRIP:
79 return VK_PRIMITIVE_TOPOLOGY_TRIANGLE_STRIP;
80
81 case MESA_PRIM_TRIANGLE_FAN:
82 return VK_PRIMITIVE_TOPOLOGY_TRIANGLE_FAN;
83
84 case MESA_PRIM_LINE_STRIP_ADJACENCY:
85 return VK_PRIMITIVE_TOPOLOGY_LINE_STRIP_WITH_ADJACENCY;
86
87 case MESA_PRIM_LINES_ADJACENCY:
88 return VK_PRIMITIVE_TOPOLOGY_LINE_LIST_WITH_ADJACENCY;
89
90 case MESA_PRIM_TRIANGLE_STRIP_ADJACENCY:
91 return VK_PRIMITIVE_TOPOLOGY_TRIANGLE_STRIP_WITH_ADJACENCY;
92
93 case MESA_PRIM_TRIANGLES_ADJACENCY:
94 return VK_PRIMITIVE_TOPOLOGY_TRIANGLE_LIST_WITH_ADJACENCY;
95
96 case MESA_PRIM_PATCHES:
97 return VK_PRIMITIVE_TOPOLOGY_PATCH_LIST;
98
99 case MESA_PRIM_QUADS:
100 return VK_PRIMITIVE_TOPOLOGY_LINE_LIST_WITH_ADJACENCY;
101
102 default:
103 unreachable("unexpected enum mesa_prim");
104 }
105 }
106
107 void
108 zink_delete_shader_state(struct pipe_context *pctx, void *cso);
109 void *
110 zink_create_gfx_shader_state(struct pipe_context *pctx, const struct pipe_shader_state *shader);
111
112 unsigned
113 zink_program_num_bindings_typed(const struct zink_program *pg, enum zink_descriptor_type type);
114
115 unsigned
116 zink_program_num_bindings(const struct zink_program *pg);
117
118 bool
119 zink_program_descriptor_is_buffer(struct zink_context *ctx, gl_shader_stage stage, enum zink_descriptor_type type, unsigned i);
120
121 void
122 zink_gfx_program_update(struct zink_context *ctx);
123 void
124 zink_gfx_program_update_optimal(struct zink_context *ctx);
125
126
127 struct zink_gfx_library_key *
128 zink_create_pipeline_lib(struct zink_screen *screen, struct zink_gfx_program *prog, struct zink_gfx_pipeline_state *state);
129 uint32_t hash_gfx_output(const void *key);
130 uint32_t hash_gfx_output_ds3(const void *key);
131 uint32_t hash_gfx_input(const void *key);
132 uint32_t hash_gfx_input_dynamic(const void *key);
133
134 void
135 zink_gfx_program_compile_queue(struct zink_context *ctx, struct zink_gfx_pipeline_cache_entry *pc_entry);
136 void
137 zink_program_finish(struct zink_context *ctx, struct zink_program *pg);
138
139 static inline unsigned
get_primtype_idx(enum mesa_prim mode)140 get_primtype_idx(enum mesa_prim mode)
141 {
142 if (mode == MESA_PRIM_PATCHES)
143 return 3;
144 switch (u_reduced_prim(mode)) {
145 case MESA_PRIM_POINTS:
146 return 0;
147 case MESA_PRIM_LINES:
148 return 1;
149 default:
150 return 2;
151 }
152 }
153
154 struct zink_gfx_program *
155 zink_create_gfx_program(struct zink_context *ctx,
156 struct zink_shader **stages,
157 unsigned vertices_per_patch,
158 uint32_t gfx_hash);
159
160 void
161 zink_destroy_gfx_program(struct zink_screen *screen,
162 struct zink_gfx_program *prog);
163 void
164 zink_gfx_lib_cache_unref(struct zink_screen *screen, struct zink_gfx_lib_cache *libs);
165 void
166 zink_program_init(struct zink_context *ctx);
167
168 void
169 debug_describe_zink_gfx_program(char* buf, const struct zink_gfx_program *ptr);
170
171 static inline bool
zink_gfx_program_reference(struct zink_screen * screen,struct zink_gfx_program ** dst,struct zink_gfx_program * src)172 zink_gfx_program_reference(struct zink_screen *screen,
173 struct zink_gfx_program **dst,
174 struct zink_gfx_program *src)
175 {
176 struct zink_gfx_program *old_dst = dst ? *dst : NULL;
177 bool ret = false;
178
179 if (pipe_reference_described(old_dst ? &old_dst->base.reference : NULL, &src->base.reference,
180 (debug_reference_descriptor)debug_describe_zink_gfx_program)) {
181 zink_destroy_gfx_program(screen, old_dst);
182 ret = true;
183 }
184 if (dst) *dst = src;
185 return ret;
186 }
187
188 void
189 zink_destroy_compute_program(struct zink_screen *screen,
190 struct zink_compute_program *comp);
191
192 void
193 debug_describe_zink_compute_program(char* buf, const struct zink_compute_program *ptr);
194
195 static inline bool
zink_compute_program_reference(struct zink_screen * screen,struct zink_compute_program ** dst,struct zink_compute_program * src)196 zink_compute_program_reference(struct zink_screen *screen,
197 struct zink_compute_program **dst,
198 struct zink_compute_program *src)
199 {
200 struct zink_compute_program *old_dst = dst ? *dst : NULL;
201 bool ret = false;
202
203 if (pipe_reference_described(old_dst ? &old_dst->base.reference : NULL, &src->base.reference,
204 (debug_reference_descriptor)debug_describe_zink_compute_program)) {
205 zink_destroy_compute_program(screen, old_dst);
206 ret = true;
207 }
208 if (dst) *dst = src;
209 return ret;
210 }
211
212 static inline bool
zink_program_reference(struct zink_screen * screen,struct zink_program ** dst,struct zink_program * src)213 zink_program_reference(struct zink_screen *screen,
214 struct zink_program **dst,
215 struct zink_program *src)
216 {
217 struct zink_program *pg = src ? src : dst ? *dst : NULL;
218 if (!pg)
219 return false;
220 if (pg->is_compute) {
221 struct zink_compute_program *comp = (struct zink_compute_program*)pg;
222 return zink_compute_program_reference(screen, &comp, NULL);
223 } else {
224 struct zink_gfx_program *prog = (struct zink_gfx_program*)pg;
225 return zink_gfx_program_reference(screen, &prog, NULL);
226 }
227 }
228
229 VkPipelineLayout
230 zink_pipeline_layout_create(struct zink_screen *screen, VkDescriptorSetLayout *dsl, unsigned num_dsl, bool is_compute, VkPipelineLayoutCreateFlags flags);
231
232 void
233 zink_program_update_compute_pipeline_state(struct zink_context *ctx, struct zink_compute_program *comp, const struct pipe_grid_info *info);
234 void
235 zink_update_compute_program(struct zink_context *ctx);
236 VkPipeline
237 zink_get_compute_pipeline(struct zink_screen *screen,
238 struct zink_compute_program *comp,
239 struct zink_compute_pipeline_state *state);
240
241 static inline bool
zink_program_has_descriptors(const struct zink_program * pg)242 zink_program_has_descriptors(const struct zink_program *pg)
243 {
244 return pg->num_dsl > 0;
245 }
246
247 static inline struct zink_fs_key_base *
zink_set_fs_base_key(struct zink_context * ctx)248 zink_set_fs_base_key(struct zink_context *ctx)
249 {
250 ctx->dirty_gfx_stages |= BITFIELD_BIT(MESA_SHADER_FRAGMENT);
251 return zink_screen(ctx->base.screen)->optimal_keys ?
252 &ctx->gfx_pipeline_state.shader_keys_optimal.key.fs :
253 &ctx->gfx_pipeline_state.shader_keys.key[MESA_SHADER_FRAGMENT].key.fs.base;
254 }
255
256 static inline const struct zink_fs_key_base *
zink_get_fs_base_key(const struct zink_context * ctx)257 zink_get_fs_base_key(const struct zink_context *ctx)
258 {
259 return zink_screen(ctx->base.screen)->optimal_keys ?
260 &ctx->gfx_pipeline_state.shader_keys_optimal.key.fs :
261 &ctx->gfx_pipeline_state.shader_keys.key[MESA_SHADER_FRAGMENT].key.fs.base;
262 }
263
264 static inline struct zink_fs_key *
zink_set_fs_key(struct zink_context * ctx)265 zink_set_fs_key(struct zink_context *ctx)
266 {
267 assert(!zink_screen(ctx->base.screen)->optimal_keys);
268 ctx->dirty_gfx_stages |= BITFIELD_BIT(MESA_SHADER_FRAGMENT);
269 return &ctx->gfx_pipeline_state.shader_keys.key[MESA_SHADER_FRAGMENT].key.fs;
270 }
271
272 static inline const struct zink_fs_key *
zink_get_fs_key(const struct zink_context * ctx)273 zink_get_fs_key(const struct zink_context *ctx)
274 {
275 assert(!zink_screen(ctx->base.screen)->optimal_keys);
276 return &ctx->gfx_pipeline_state.shader_keys.key[MESA_SHADER_FRAGMENT].key.fs;
277 }
278
279 static inline struct zink_gs_key *
zink_set_gs_key(struct zink_context * ctx)280 zink_set_gs_key(struct zink_context *ctx)
281 {
282 ctx->dirty_gfx_stages |= BITFIELD_BIT(MESA_SHADER_GEOMETRY);
283 assert(!zink_screen(ctx->base.screen)->optimal_keys);
284 return &ctx->gfx_pipeline_state.shader_keys.key[MESA_SHADER_GEOMETRY].key.gs;
285 }
286
287 static inline const struct zink_gs_key *
zink_get_gs_key(const struct zink_context * ctx)288 zink_get_gs_key(const struct zink_context *ctx)
289 {
290 return &ctx->gfx_pipeline_state.shader_keys.key[MESA_SHADER_GEOMETRY].key.gs;
291 }
292
293 static inline bool
zink_set_tcs_key_patches(struct zink_context * ctx,uint8_t patch_vertices)294 zink_set_tcs_key_patches(struct zink_context *ctx, uint8_t patch_vertices)
295 {
296 struct zink_tcs_key *tcs = zink_screen(ctx->base.screen)->optimal_keys ?
297 &ctx->gfx_pipeline_state.shader_keys_optimal.key.tcs :
298 &ctx->gfx_pipeline_state.shader_keys.key[MESA_SHADER_TESS_CTRL].key.tcs;
299 if (tcs->patch_vertices == patch_vertices)
300 return false;
301 ctx->dirty_gfx_stages |= BITFIELD_BIT(MESA_SHADER_TESS_CTRL);
302 tcs->patch_vertices = patch_vertices;
303 return true;
304 }
305
306 static inline const struct zink_tcs_key *
zink_get_tcs_key(const struct zink_context * ctx)307 zink_get_tcs_key(const struct zink_context *ctx)
308 {
309 return zink_screen(ctx->base.screen)->optimal_keys ?
310 &ctx->gfx_pipeline_state.shader_keys_optimal.key.tcs :
311 &ctx->gfx_pipeline_state.shader_keys.key[MESA_SHADER_TESS_CTRL].key.tcs;
312 }
313
314 void
315 zink_update_fs_key_samples(struct zink_context *ctx);
316
317 void
318 zink_update_gs_key_rectangular_line(struct zink_context *ctx);
319
320 static inline struct zink_vs_key *
zink_set_vs_key(struct zink_context * ctx)321 zink_set_vs_key(struct zink_context *ctx)
322 {
323 ctx->dirty_gfx_stages |= BITFIELD_BIT(MESA_SHADER_VERTEX);
324 assert(!zink_screen(ctx->base.screen)->optimal_keys);
325 return &ctx->gfx_pipeline_state.shader_keys.key[MESA_SHADER_VERTEX].key.vs;
326 }
327
328 static inline const struct zink_vs_key *
zink_get_vs_key(const struct zink_context * ctx)329 zink_get_vs_key(const struct zink_context *ctx)
330 {
331 assert(!zink_screen(ctx->base.screen)->optimal_keys);
332 return &ctx->gfx_pipeline_state.shader_keys.key[MESA_SHADER_VERTEX].key.vs;
333 }
334
335 static inline struct zink_vs_key_base *
zink_set_last_vertex_key(struct zink_context * ctx)336 zink_set_last_vertex_key(struct zink_context *ctx)
337 {
338 ctx->last_vertex_stage_dirty = true;
339 return zink_screen(ctx->base.screen)->optimal_keys ?
340 &ctx->gfx_pipeline_state.shader_keys_optimal.key.vs_base :
341 &ctx->gfx_pipeline_state.shader_keys.last_vertex.key.vs_base;
342 }
343
344 static inline const struct zink_vs_key_base *
zink_get_last_vertex_key(const struct zink_context * ctx)345 zink_get_last_vertex_key(const struct zink_context *ctx)
346 {
347 return zink_screen(ctx->base.screen)->optimal_keys ?
348 &ctx->gfx_pipeline_state.shader_keys_optimal.key.vs_base :
349 &ctx->gfx_pipeline_state.shader_keys.last_vertex.key.vs_base;
350 }
351
352 static inline void
zink_set_fs_point_coord_key(struct zink_context * ctx)353 zink_set_fs_point_coord_key(struct zink_context *ctx)
354 {
355 const struct zink_fs_key_base *fs = zink_get_fs_base_key(ctx);
356 bool disable = ctx->gfx_pipeline_state.rast_prim != MESA_PRIM_POINTS;
357 uint8_t coord_replace_bits = disable ? 0 : ctx->rast_state->base.sprite_coord_enable;
358 bool point_coord_yinvert = disable ? false : !!ctx->rast_state->base.sprite_coord_mode;
359 if (fs->coord_replace_bits != coord_replace_bits || fs->point_coord_yinvert != point_coord_yinvert) {
360 zink_set_fs_base_key(ctx)->coord_replace_bits = coord_replace_bits;
361 zink_set_fs_base_key(ctx)->point_coord_yinvert = point_coord_yinvert;
362 }
363 }
364
365 void
366 zink_set_primitive_emulation_keys(struct zink_context *ctx);
367
368 void
369 zink_create_primitive_emulation_gs(struct zink_context *ctx);
370
371 static inline const struct zink_shader_key_base *
zink_get_shader_key_base(const struct zink_context * ctx,gl_shader_stage pstage)372 zink_get_shader_key_base(const struct zink_context *ctx, gl_shader_stage pstage)
373 {
374 assert(!zink_screen(ctx->base.screen)->optimal_keys);
375 return &ctx->gfx_pipeline_state.shader_keys.key[pstage].base;
376 }
377
378 static inline struct zink_shader_key_base *
zink_set_shader_key_base(struct zink_context * ctx,gl_shader_stage pstage)379 zink_set_shader_key_base(struct zink_context *ctx, gl_shader_stage pstage)
380 {
381 ctx->dirty_gfx_stages |= BITFIELD_BIT(pstage);
382 assert(!zink_screen(ctx->base.screen)->optimal_keys);
383 return &ctx->gfx_pipeline_state.shader_keys.key[pstage].base;
384 }
385
386 static inline void
zink_set_zs_needs_shader_swizzle_key(struct zink_context * ctx,gl_shader_stage pstage,bool swizzle_update)387 zink_set_zs_needs_shader_swizzle_key(struct zink_context *ctx, gl_shader_stage pstage, bool swizzle_update)
388 {
389 if (!zink_screen(ctx->base.screen)->driver_compiler_workarounds.needs_zs_shader_swizzle) {
390 if (pstage != MESA_SHADER_FRAGMENT)
391 return;
392 const struct zink_fs_key_base *fs = zink_get_fs_base_key(ctx);
393 bool enable = ctx->gfx_stages[MESA_SHADER_FRAGMENT] && (ctx->gfx_stages[MESA_SHADER_FRAGMENT]->fs.legacy_shadow_mask & ctx->di.zs_swizzle[pstage].mask) > 0;
394 if (enable != fs->shadow_needs_shader_swizzle || (enable && swizzle_update))
395 zink_set_fs_base_key(ctx)->shadow_needs_shader_swizzle = enable;
396 return;
397 }
398 bool enable = !!ctx->di.zs_swizzle[pstage].mask;
399 const struct zink_shader_key_base *key = zink_get_shader_key_base(ctx, pstage);
400 if (enable != key->needs_zs_shader_swizzle || (enable && swizzle_update))
401 zink_set_shader_key_base(ctx, pstage)->needs_zs_shader_swizzle = enable;
402 }
403
404 ALWAYS_INLINE static bool
zink_can_use_pipeline_libs(const struct zink_context * ctx)405 zink_can_use_pipeline_libs(const struct zink_context *ctx)
406 {
407 return
408 !ctx->gfx_pipeline_state.render_pass &&
409 /* this is just terrible */
410 !zink_get_fs_base_key(ctx)->shadow_needs_shader_swizzle &&
411 /* TODO: is sample shading even possible to handle with GPL? */
412 !ctx->gfx_stages[MESA_SHADER_FRAGMENT]->info.fs.uses_sample_shading &&
413 !zink_get_fs_base_key(ctx)->fbfetch_ms &&
414 !ctx->gfx_pipeline_state.force_persample_interp &&
415 !ctx->gfx_pipeline_state.min_samples &&
416 !ctx->fb_state.viewmask &&
417 !ctx->is_generated_gs_bound;
418 }
419
420 /* stricter requirements */
421 ALWAYS_INLINE static bool
zink_can_use_shader_objects(const struct zink_context * ctx)422 zink_can_use_shader_objects(const struct zink_context *ctx)
423 {
424 return
425 !ctx->gfx_pipeline_state.render_pass &&
426 ZINK_SHADER_KEY_OPTIMAL_IS_DEFAULT(ctx->gfx_pipeline_state.optimal_key) &&
427 /* TODO: is sample shading even possible to handle with GPL? */
428 !ctx->gfx_stages[MESA_SHADER_FRAGMENT]->info.fs.uses_sample_shading &&
429 !ctx->gfx_pipeline_state.force_persample_interp &&
430 !ctx->gfx_pipeline_state.min_samples &&
431 !ctx->is_generated_gs_bound;
432 }
433
434 bool
435 zink_set_rasterizer_discard(struct zink_context *ctx, bool disable);
436 void
437 zink_driver_thread_add_job(struct pipe_screen *pscreen, void *data,
438 struct util_queue_fence *fence,
439 pipe_driver_thread_func execute,
440 pipe_driver_thread_func cleanup,
441 const size_t job_size);
442 equals_gfx_pipeline_state_func
443 zink_get_gfx_pipeline_eq_func(struct zink_screen *screen, struct zink_gfx_program *prog);
444
445 /* determines whether the 'samples' shader key is valid */
446 static inline bool
zink_shader_uses_samples(const struct zink_shader * zs)447 zink_shader_uses_samples(const struct zink_shader *zs)
448 {
449 assert(zs->info.stage == MESA_SHADER_FRAGMENT);
450 return zs->info.fs.uses_sample_qualifier || zs->info.outputs_written & BITFIELD64_BIT(FRAG_RESULT_SAMPLE_MASK);
451 }
452
453 static inline uint32_t
zink_sanitize_optimal_key(struct zink_shader ** shaders,uint32_t val)454 zink_sanitize_optimal_key(struct zink_shader **shaders, uint32_t val)
455 {
456 union zink_shader_key_optimal k;
457 if (shaders[MESA_SHADER_TESS_EVAL] && !shaders[MESA_SHADER_TESS_CTRL])
458 k.val = val;
459 else
460 k.val = zink_shader_key_optimal_no_tcs(val);
461 if (!zink_shader_uses_samples(shaders[MESA_SHADER_FRAGMENT]))
462 k.fs.samples = false;
463 if (!(shaders[MESA_SHADER_FRAGMENT]->info.outputs_written & BITFIELD64_BIT(FRAG_RESULT_DATA1)))
464 k.fs.force_dual_color_blend = false;
465 return k.val;
466 }
467 #ifdef __cplusplus
468 }
469 #endif
470
471 #endif
472