1 /*
2 * Copyright © 2022 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 * 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
20 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
21 * IN THE SOFTWARE.
22 */
23 #ifndef VK_META_H
24 #define VK_META_H
25
26 #include "vk_limits.h"
27 #include "vk_object.h"
28
29 #include "util/simple_mtx.h"
30
31 #include "compiler/nir/nir.h"
32
33 #ifdef __cplusplus
34 extern "C" {
35 #endif
36
37 struct hash_table;
38 struct vk_command_buffer;
39 struct vk_buffer;
40 struct vk_device;
41 struct vk_image;
42
43 struct vk_meta_rect {
44 uint32_t x0, y0, x1, y1;
45 float z;
46 uint32_t layer;
47 };
48
49 #define VK_PRIMITIVE_TOPOLOGY_META_RECT_LIST_MESA (VkPrimitiveTopology)11
50 #define VK_IMAGE_VIEW_CREATE_INTERNAL_MESA (VkImageViewCreateFlagBits)0x40000000
51
52 struct vk_meta_copy_image_properties {
53 union {
54 struct {
55 /* Format to use for the image view of a color aspect.
56 * Format must not be compressed and be in the RGB/sRGB colorspace.
57 */
58 VkFormat view_format;
59 } color;
60
61 struct {
62 struct {
63 /* Format to use for the image view of a depth aspect.
64 * Format must not be compressed and be in the RGB/sRGB colorspace.
65 */
66 VkFormat view_format;
67
68 /* Describe the depth/stencil componant layout. Bits in the mask
69 * must be consecutive and match the original depth bit size.
70 */
71 uint8_t component_mask;
72 } depth;
73
74 struct {
75 /* Format to use for the image view of a stencil aspect.
76 * Format must not be compressed and be in the RGB/sRGB colorspace.
77 */
78 VkFormat view_format;
79
80 /* Describe the depth/stencil componant layout. Bits in the mask
81 * must be consecutive and match the original depth bit size.
82 */
83 uint8_t component_mask;
84 } stencil;
85 };
86 };
87
88 /* Size of the image tile. Used to select the optimal workgroup size. */
89 VkExtent3D tile_size;
90 };
91
92 enum vk_meta_buffer_chunk_size_id {
93 VK_META_BUFFER_1_BYTE_CHUNK = 0,
94 VK_META_BUFFER_2_BYTE_CHUNK,
95 VK_META_BUFFER_4_BYTE_CHUNK,
96 VK_META_BUFFER_8_BYTE_CHUNK,
97 VK_META_BUFFER_16_BYTE_CHUNK,
98 VK_META_BUFFER_CHUNK_SIZE_COUNT,
99 };
100
101 struct vk_meta_device {
102 struct hash_table *cache;
103 simple_mtx_t cache_mtx;
104
105 uint32_t max_bind_map_buffer_size_B;
106 bool use_layered_rendering;
107 bool use_gs_for_layer;
108 bool use_stencil_export;
109
110 struct {
111 /* Optimal workgroup size for each possible chunk size. This should be
112 * chosen to keep things cache-friendly (something big enough to maximize
113 * cache hits on executing threads, but small enough to not trash the
114 * cache) while keeping GPU utilization high enough to not make copies
115 * fast enough.
116 */
117 uint32_t optimal_wg_size[VK_META_BUFFER_CHUNK_SIZE_COUNT];
118 } buffer_access;
119
120 VkResult (*cmd_bind_map_buffer)(struct vk_command_buffer *cmd,
121 struct vk_meta_device *meta,
122 VkBuffer buffer,
123 void **map_out);
124
125 void (*cmd_draw_rects)(struct vk_command_buffer *cmd,
126 struct vk_meta_device *meta,
127 uint32_t rect_count,
128 const struct vk_meta_rect *rects);
129
130 void (*cmd_draw_volume)(struct vk_command_buffer *cmd,
131 struct vk_meta_device *meta,
132 const struct vk_meta_rect *rect,
133 uint32_t layer_count);
134 };
135
136 static inline uint32_t
vk_meta_buffer_access_wg_size(const struct vk_meta_device * meta,uint32_t chunk_size)137 vk_meta_buffer_access_wg_size(const struct vk_meta_device *meta,
138 uint32_t chunk_size)
139 {
140 assert(util_is_power_of_two_nonzero(chunk_size));
141 unsigned idx = ffs(chunk_size) - 1;
142
143 assert(idx < ARRAY_SIZE(meta->buffer_access.optimal_wg_size));
144 assert(meta->buffer_access.optimal_wg_size[idx] != 0);
145
146 return meta->buffer_access.optimal_wg_size[idx];
147 }
148
149 VkResult vk_meta_device_init(struct vk_device *device,
150 struct vk_meta_device *meta);
151 void vk_meta_device_finish(struct vk_device *device,
152 struct vk_meta_device *meta);
153
154 /** Keys should start with one of these to ensure uniqueness */
155 enum vk_meta_object_key_type {
156 VK_META_OBJECT_KEY_TYPE_INVALID = 0,
157 VK_META_OBJECT_KEY_CLEAR_PIPELINE,
158 VK_META_OBJECT_KEY_BLIT_PIPELINE,
159 VK_META_OBJECT_KEY_BLIT_SAMPLER,
160 VK_META_OBJECT_KEY_COPY_BUFFER_PIPELINE,
161 VK_META_OBJECT_KEY_COPY_IMAGE_TO_BUFFER_PIPELINE,
162 VK_META_OBJECT_KEY_COPY_BUFFER_TO_IMAGE_PIPELINE,
163 VK_META_OBJECT_KEY_COPY_IMAGE_PIPELINE,
164 VK_META_OBJECT_KEY_FILL_BUFFER_PIPELINE,
165 };
166
167 uint64_t vk_meta_lookup_object(struct vk_meta_device *meta,
168 VkObjectType obj_type,
169 const void *key_data, size_t key_size);
170
171 uint64_t vk_meta_cache_object(struct vk_device *device,
172 struct vk_meta_device *meta,
173 const void *key_data, size_t key_size,
174 VkObjectType obj_type,
175 uint64_t handle);
176
177 static inline VkDescriptorSetLayout
vk_meta_lookup_descriptor_set_layout(struct vk_meta_device * meta,const void * key_data,size_t key_size)178 vk_meta_lookup_descriptor_set_layout(struct vk_meta_device *meta,
179 const void *key_data, size_t key_size)
180 {
181 return (VkDescriptorSetLayout)
182 vk_meta_lookup_object(meta, VK_OBJECT_TYPE_DESCRIPTOR_SET_LAYOUT,
183 key_data, key_size);
184 }
185
186 static inline VkPipelineLayout
vk_meta_lookup_pipeline_layout(struct vk_meta_device * meta,const void * key_data,size_t key_size)187 vk_meta_lookup_pipeline_layout(struct vk_meta_device *meta,
188 const void *key_data, size_t key_size)
189 {
190 return (VkPipelineLayout)
191 vk_meta_lookup_object(meta, VK_OBJECT_TYPE_PIPELINE_LAYOUT,
192 key_data, key_size);
193 }
194
195 static inline VkPipeline
vk_meta_lookup_pipeline(struct vk_meta_device * meta,const void * key_data,size_t key_size)196 vk_meta_lookup_pipeline(struct vk_meta_device *meta,
197 const void *key_data, size_t key_size)
198 {
199 return (VkPipeline)vk_meta_lookup_object(meta, VK_OBJECT_TYPE_PIPELINE,
200 key_data, key_size);
201 }
202
203 static inline VkSampler
vk_meta_lookup_sampler(struct vk_meta_device * meta,const void * key_data,size_t key_size)204 vk_meta_lookup_sampler(struct vk_meta_device *meta,
205 const void *key_data, size_t key_size)
206 {
207 return (VkSampler)vk_meta_lookup_object(meta, VK_OBJECT_TYPE_SAMPLER,
208 key_data, key_size);
209 }
210
211 struct vk_meta_rendering_info {
212 uint32_t view_mask;
213 uint32_t samples;
214 uint32_t color_attachment_count;
215 VkFormat color_attachment_formats[MESA_VK_MAX_COLOR_ATTACHMENTS];
216 VkColorComponentFlags color_attachment_write_masks[MESA_VK_MAX_COLOR_ATTACHMENTS];
217 VkFormat depth_attachment_format;
218 VkFormat stencil_attachment_format;
219 };
220
221 VkResult
222 vk_meta_create_descriptor_set_layout(struct vk_device *device,
223 struct vk_meta_device *meta,
224 const VkDescriptorSetLayoutCreateInfo *info,
225 const void *key_data, size_t key_size,
226 VkDescriptorSetLayout *layout_out);
227
228 VkResult
229 vk_meta_create_pipeline_layout(struct vk_device *device,
230 struct vk_meta_device *meta,
231 const VkPipelineLayoutCreateInfo *info,
232 const void *key_data, size_t key_size,
233 VkPipelineLayout *layout_out);
234
235 VkResult
236 vk_meta_get_pipeline_layout(struct vk_device *device,
237 struct vk_meta_device *meta,
238 const VkDescriptorSetLayoutCreateInfo *desc_info,
239 const VkPushConstantRange *push_range,
240 const void *key_data, size_t key_size,
241 VkPipelineLayout *layout_out);
242
243 VkResult
244 vk_meta_create_graphics_pipeline(struct vk_device *device,
245 struct vk_meta_device *meta,
246 const VkGraphicsPipelineCreateInfo *info,
247 const struct vk_meta_rendering_info *render,
248 const void *key_data, size_t key_size,
249 VkPipeline *pipeline_out);
250
251 VkResult
252 vk_meta_create_compute_pipeline(struct vk_device *device,
253 struct vk_meta_device *meta,
254 const VkComputePipelineCreateInfo *info,
255 const void *key_data, size_t key_size,
256 VkPipeline *pipeline_out);
257
258 VkResult
259 vk_meta_create_sampler(struct vk_device *device,
260 struct vk_meta_device *meta,
261 const VkSamplerCreateInfo *info,
262 const void *key_data, size_t key_size,
263 VkSampler *sampler_out);
264
265 VkResult vk_meta_create_buffer(struct vk_command_buffer *cmd,
266 struct vk_meta_device *meta,
267 const VkBufferCreateInfo *info,
268 VkBuffer *buffer_out);
269
270 VkResult vk_meta_create_buffer_view(struct vk_command_buffer *cmd,
271 struct vk_meta_device *meta,
272 const VkBufferViewCreateInfo *info,
273 VkBufferView *buffer_view_out);
274
275 #define VK_IMAGE_VIEW_CREATE_DRIVER_INTERNAL_BIT_MESA 0x80000000
276
277 VkResult vk_meta_create_image_view(struct vk_command_buffer *cmd,
278 struct vk_meta_device *meta,
279 const VkImageViewCreateInfo *info,
280 VkImageView *image_view_out);
281
282 void vk_meta_draw_rects(struct vk_command_buffer *cmd,
283 struct vk_meta_device *meta,
284 uint32_t rect_count,
285 const struct vk_meta_rect *rects);
286
287 void vk_meta_draw_volume(struct vk_command_buffer *cmd,
288 struct vk_meta_device *meta,
289 const struct vk_meta_rect *rect,
290 uint32_t layer_count);
291
292 void vk_meta_clear_attachments(struct vk_command_buffer *cmd,
293 struct vk_meta_device *meta,
294 const struct vk_meta_rendering_info *render,
295 uint32_t attachment_count,
296 const VkClearAttachment *attachments,
297 uint32_t rect_count,
298 const VkClearRect *rects);
299
300 void vk_meta_clear_rendering(struct vk_meta_device *meta,
301 struct vk_command_buffer *cmd,
302 const VkRenderingInfo *pRenderingInfo);
303
304 void vk_meta_clear_color_image(struct vk_command_buffer *cmd,
305 struct vk_meta_device *meta,
306 struct vk_image *image,
307 VkImageLayout image_layout,
308 VkFormat format,
309 const VkClearColorValue *color,
310 uint32_t range_count,
311 const VkImageSubresourceRange *ranges);
312
313 void vk_meta_clear_depth_stencil_image(struct vk_command_buffer *cmd,
314 struct vk_meta_device *meta,
315 struct vk_image *image,
316 VkImageLayout image_layout,
317 const VkClearDepthStencilValue *depth_stencil,
318 uint32_t range_count,
319 const VkImageSubresourceRange *ranges);
320
321 void vk_meta_blit_image(struct vk_command_buffer *cmd,
322 struct vk_meta_device *meta,
323 struct vk_image *src_image,
324 VkFormat src_format,
325 VkImageLayout src_image_layout,
326 struct vk_image *dst_image,
327 VkFormat dst_format,
328 VkImageLayout dst_image_layout,
329 uint32_t region_count,
330 const VkImageBlit2 *regions,
331 VkFilter filter);
332
333 void vk_meta_blit_image2(struct vk_command_buffer *cmd,
334 struct vk_meta_device *meta,
335 const VkBlitImageInfo2 *blit);
336
337 void vk_meta_resolve_image(struct vk_command_buffer *cmd,
338 struct vk_meta_device *meta,
339 struct vk_image *src_image,
340 VkFormat src_format,
341 VkImageLayout src_image_layout,
342 struct vk_image *dst_image,
343 VkFormat dst_format,
344 VkImageLayout dst_image_layout,
345 uint32_t region_count,
346 const VkImageResolve2 *regions,
347 VkResolveModeFlagBits resolve_mode,
348 VkResolveModeFlagBits stencil_resolve_mode);
349
350 void vk_meta_resolve_image2(struct vk_command_buffer *cmd,
351 struct vk_meta_device *meta,
352 const VkResolveImageInfo2 *resolve);
353
354 void vk_meta_resolve_rendering(struct vk_command_buffer *cmd,
355 struct vk_meta_device *meta,
356 const VkRenderingInfo *pRenderingInfo);
357
358 VkDeviceAddress vk_meta_buffer_address(struct vk_device *device,
359 VkBuffer buffer, uint64_t offset,
360 uint64_t range);
361
362 void vk_meta_copy_buffer(struct vk_command_buffer *cmd,
363 struct vk_meta_device *meta,
364 const VkCopyBufferInfo2 *info);
365
366 void vk_meta_copy_image_to_buffer(
367 struct vk_command_buffer *cmd, struct vk_meta_device *meta,
368 const VkCopyImageToBufferInfo2 *info,
369 const struct vk_meta_copy_image_properties *img_props);
370
371 void vk_meta_copy_buffer_to_image(
372 struct vk_command_buffer *cmd, struct vk_meta_device *meta,
373 const VkCopyBufferToImageInfo2 *info,
374 const struct vk_meta_copy_image_properties *img_props,
375 VkPipelineBindPoint bind_point);
376
377 void vk_meta_copy_image(struct vk_command_buffer *cmd,
378 struct vk_meta_device *meta,
379 const VkCopyImageInfo2 *info,
380 const struct vk_meta_copy_image_properties *src_props,
381 const struct vk_meta_copy_image_properties *dst_props,
382 VkPipelineBindPoint bind_point);
383
384 void vk_meta_update_buffer(struct vk_command_buffer *cmd,
385 struct vk_meta_device *meta, VkBuffer buffer,
386 VkDeviceSize offset, VkDeviceSize size,
387 const void *data);
388
389 void vk_meta_fill_buffer(struct vk_command_buffer *cmd,
390 struct vk_meta_device *meta, VkBuffer buffer,
391 VkDeviceSize offset, VkDeviceSize size, uint32_t data);
392
393 #ifdef __cplusplus
394 }
395 #endif
396
397 #endif /* VK_META_H */
398