radv: remove useless radv_meta_{begin,end}_XXX() helpers
[mesa.git] / src / amd / vulkan / radv_meta_copy.c
1 /*
2 * Copyright © 2016 Intel Corporation
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
24 #include "radv_meta.h"
25 #include "vk_format.h"
26
27 static VkExtent3D
28 meta_image_block_size(const struct radv_image *image)
29 {
30 const struct vk_format_description *desc = vk_format_description(image->vk_format);
31 return (VkExtent3D) { desc->block.width, desc->block.height, 1 };
32 }
33
34 /* Returns the user-provided VkBufferImageCopy::imageExtent in units of
35 * elements rather than texels. One element equals one texel or one block
36 * if Image is uncompressed or compressed, respectively.
37 */
38 static struct VkExtent3D
39 meta_region_extent_el(const struct radv_image *image,
40 const struct VkExtent3D *extent)
41 {
42 const VkExtent3D block = meta_image_block_size(image);
43 return radv_sanitize_image_extent(image->type, (VkExtent3D) {
44 .width = DIV_ROUND_UP(extent->width , block.width),
45 .height = DIV_ROUND_UP(extent->height, block.height),
46 .depth = DIV_ROUND_UP(extent->depth , block.depth),
47 });
48 }
49
50 /* Returns the user-provided VkBufferImageCopy::imageOffset in units of
51 * elements rather than texels. One element equals one texel or one block
52 * if Image is uncompressed or compressed, respectively.
53 */
54 static struct VkOffset3D
55 meta_region_offset_el(const struct radv_image *image,
56 const struct VkOffset3D *offset)
57 {
58 const VkExtent3D block = meta_image_block_size(image);
59 return radv_sanitize_image_offset(image->type, (VkOffset3D) {
60 .x = offset->x / block.width,
61 .y = offset->y / block.height,
62 .z = offset->z / block.depth,
63 });
64 }
65
66 static VkFormat
67 vk_format_for_size(int bs)
68 {
69 switch (bs) {
70 case 1: return VK_FORMAT_R8_UINT;
71 case 2: return VK_FORMAT_R8G8_UINT;
72 case 4: return VK_FORMAT_R8G8B8A8_UINT;
73 case 8: return VK_FORMAT_R16G16B16A16_UINT;
74 case 16: return VK_FORMAT_R32G32B32A32_UINT;
75 default:
76 unreachable("Invalid format block size");
77 }
78 }
79
80 static struct radv_meta_blit2d_surf
81 blit_surf_for_image_level_layer(struct radv_image *image,
82 const VkImageSubresourceLayers *subres)
83 {
84 VkFormat format = image->vk_format;
85 if (subres->aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT)
86 format = vk_format_depth_only(format);
87 else if (subres->aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT)
88 format = vk_format_stencil_only(format);
89
90 if (!image->surface.dcc_size)
91 format = vk_format_for_size(vk_format_get_blocksize(format));
92
93 return (struct radv_meta_blit2d_surf) {
94 .format = format,
95 .bs = vk_format_get_blocksize(format),
96 .level = subres->mipLevel,
97 .layer = subres->baseArrayLayer,
98 .image = image,
99 .aspect_mask = subres->aspectMask,
100 };
101 }
102
103 union meta_saved_state {
104 struct radv_meta_saved_state gfx;
105 struct radv_meta_saved_compute_state compute;
106 };
107
108 static void
109 meta_copy_buffer_to_image(struct radv_cmd_buffer *cmd_buffer,
110 struct radv_buffer* buffer,
111 struct radv_image* image,
112 uint32_t regionCount,
113 const VkBufferImageCopy* pRegions)
114 {
115 bool cs = cmd_buffer->queue_family_index == RADV_QUEUE_COMPUTE;
116 union meta_saved_state saved_state;
117
118 /* The Vulkan 1.0 spec says "dstImage must have a sample count equal to
119 * VK_SAMPLE_COUNT_1_BIT."
120 */
121 assert(image->info.samples == 1);
122
123 if (cs)
124 radv_meta_save_compute(&saved_state.compute, cmd_buffer, 12);
125 else
126 radv_meta_save_graphics_reset_vport_scissor_novertex(&saved_state.gfx, cmd_buffer);
127
128 for (unsigned r = 0; r < regionCount; r++) {
129
130 /**
131 * From the Vulkan 1.0.6 spec: 18.3 Copying Data Between Images
132 * extent is the size in texels of the source image to copy in width,
133 * height and depth. 1D images use only x and width. 2D images use x, y,
134 * width and height. 3D images use x, y, z, width, height and depth.
135 *
136 *
137 * Also, convert the offsets and extent from units of texels to units of
138 * blocks - which is the highest resolution accessible in this command.
139 */
140 const VkOffset3D img_offset_el =
141 meta_region_offset_el(image, &pRegions[r].imageOffset);
142 const VkExtent3D bufferExtent = {
143 .width = pRegions[r].bufferRowLength ?
144 pRegions[r].bufferRowLength : pRegions[r].imageExtent.width,
145 .height = pRegions[r].bufferImageHeight ?
146 pRegions[r].bufferImageHeight : pRegions[r].imageExtent.height,
147 };
148 const VkExtent3D buf_extent_el =
149 meta_region_extent_el(image, &bufferExtent);
150
151 /* Start creating blit rect */
152 const VkExtent3D img_extent_el =
153 meta_region_extent_el(image, &pRegions[r].imageExtent);
154 struct radv_meta_blit2d_rect rect = {
155 .width = img_extent_el.width,
156 .height = img_extent_el.height,
157 };
158
159 /* Create blit surfaces */
160 struct radv_meta_blit2d_surf img_bsurf =
161 blit_surf_for_image_level_layer(image,
162 &pRegions[r].imageSubresource);
163
164 struct radv_meta_blit2d_buffer buf_bsurf = {
165 .bs = img_bsurf.bs,
166 .format = img_bsurf.format,
167 .buffer = buffer,
168 .offset = pRegions[r].bufferOffset,
169 .pitch = buf_extent_el.width,
170 };
171
172 if (image->type == VK_IMAGE_TYPE_3D)
173 img_bsurf.layer = img_offset_el.z;
174 /* Loop through each 3D or array slice */
175 unsigned num_slices_3d = img_extent_el.depth;
176 unsigned num_slices_array = pRegions[r].imageSubresource.layerCount;
177 unsigned slice_3d = 0;
178 unsigned slice_array = 0;
179 while (slice_3d < num_slices_3d && slice_array < num_slices_array) {
180
181 rect.dst_x = img_offset_el.x;
182 rect.dst_y = img_offset_el.y;
183
184
185 /* Perform Blit */
186 if (cs)
187 radv_meta_buffer_to_image_cs(cmd_buffer, &buf_bsurf, &img_bsurf, 1, &rect);
188 else
189 radv_meta_blit2d(cmd_buffer, NULL, &buf_bsurf, &img_bsurf, 1, &rect);
190
191 /* Once we've done the blit, all of the actual information about
192 * the image is embedded in the command buffer so we can just
193 * increment the offset directly in the image effectively
194 * re-binding it to different backing memory.
195 */
196 buf_bsurf.offset += buf_extent_el.width *
197 buf_extent_el.height * buf_bsurf.bs;
198 img_bsurf.layer++;
199 if (image->type == VK_IMAGE_TYPE_3D)
200 slice_3d++;
201 else
202 slice_array++;
203 }
204 }
205 if (cs)
206 radv_meta_restore_compute(&saved_state.compute, cmd_buffer, 12);
207 else
208 radv_meta_restore(&saved_state.gfx, cmd_buffer);
209 }
210
211 void radv_CmdCopyBufferToImage(
212 VkCommandBuffer commandBuffer,
213 VkBuffer srcBuffer,
214 VkImage destImage,
215 VkImageLayout destImageLayout,
216 uint32_t regionCount,
217 const VkBufferImageCopy* pRegions)
218 {
219 RADV_FROM_HANDLE(radv_cmd_buffer, cmd_buffer, commandBuffer);
220 RADV_FROM_HANDLE(radv_image, dest_image, destImage);
221 RADV_FROM_HANDLE(radv_buffer, src_buffer, srcBuffer);
222
223 meta_copy_buffer_to_image(cmd_buffer, src_buffer, dest_image,
224 regionCount, pRegions);
225 }
226
227 static void
228 meta_copy_image_to_buffer(struct radv_cmd_buffer *cmd_buffer,
229 struct radv_buffer* buffer,
230 struct radv_image* image,
231 uint32_t regionCount,
232 const VkBufferImageCopy* pRegions)
233 {
234 struct radv_meta_saved_compute_state saved_state;
235
236 radv_meta_save_compute(&saved_state, cmd_buffer, 12);
237
238 for (unsigned r = 0; r < regionCount; r++) {
239
240 /**
241 * From the Vulkan 1.0.6 spec: 18.3 Copying Data Between Images
242 * extent is the size in texels of the source image to copy in width,
243 * height and depth. 1D images use only x and width. 2D images use x, y,
244 * width and height. 3D images use x, y, z, width, height and depth.
245 *
246 *
247 * Also, convert the offsets and extent from units of texels to units of
248 * blocks - which is the highest resolution accessible in this command.
249 */
250 const VkOffset3D img_offset_el =
251 meta_region_offset_el(image, &pRegions[r].imageOffset);
252 const VkExtent3D bufferExtent = {
253 .width = pRegions[r].bufferRowLength ?
254 pRegions[r].bufferRowLength : pRegions[r].imageExtent.width,
255 .height = pRegions[r].bufferImageHeight ?
256 pRegions[r].bufferImageHeight : pRegions[r].imageExtent.height,
257 };
258 const VkExtent3D buf_extent_el =
259 meta_region_extent_el(image, &bufferExtent);
260
261 /* Start creating blit rect */
262 const VkExtent3D img_extent_el =
263 meta_region_extent_el(image, &pRegions[r].imageExtent);
264 struct radv_meta_blit2d_rect rect = {
265 .width = img_extent_el.width,
266 .height = img_extent_el.height,
267 };
268
269 /* Create blit surfaces */
270 struct radv_meta_blit2d_surf img_info =
271 blit_surf_for_image_level_layer(image,
272 &pRegions[r].imageSubresource);
273
274 struct radv_meta_blit2d_buffer buf_info = {
275 .bs = img_info.bs,
276 .format = img_info.format,
277 .buffer = buffer,
278 .offset = pRegions[r].bufferOffset,
279 .pitch = buf_extent_el.width,
280 };
281
282 if (image->type == VK_IMAGE_TYPE_3D)
283 img_info.layer = img_offset_el.z;
284 /* Loop through each 3D or array slice */
285 unsigned num_slices_3d = img_extent_el.depth;
286 unsigned num_slices_array = pRegions[r].imageSubresource.layerCount;
287 unsigned slice_3d = 0;
288 unsigned slice_array = 0;
289 while (slice_3d < num_slices_3d && slice_array < num_slices_array) {
290
291 rect.src_x = img_offset_el.x;
292 rect.src_y = img_offset_el.y;
293
294
295 /* Perform Blit */
296 radv_meta_image_to_buffer(cmd_buffer, &img_info, &buf_info, 1, &rect);
297
298 buf_info.offset += buf_extent_el.width *
299 buf_extent_el.height * buf_info.bs;
300 img_info.layer++;
301 if (image->type == VK_IMAGE_TYPE_3D)
302 slice_3d++;
303 else
304 slice_array++;
305 }
306 }
307 radv_meta_restore_compute(&saved_state, cmd_buffer, 12);
308 }
309
310 void radv_CmdCopyImageToBuffer(
311 VkCommandBuffer commandBuffer,
312 VkImage srcImage,
313 VkImageLayout srcImageLayout,
314 VkBuffer destBuffer,
315 uint32_t regionCount,
316 const VkBufferImageCopy* pRegions)
317 {
318 RADV_FROM_HANDLE(radv_cmd_buffer, cmd_buffer, commandBuffer);
319 RADV_FROM_HANDLE(radv_image, src_image, srcImage);
320 RADV_FROM_HANDLE(radv_buffer, dst_buffer, destBuffer);
321
322 meta_copy_image_to_buffer(cmd_buffer, dst_buffer, src_image,
323 regionCount, pRegions);
324 }
325
326 static void
327 meta_copy_image(struct radv_cmd_buffer *cmd_buffer,
328 struct radv_image *src_image,
329 struct radv_image *dest_image,
330 uint32_t regionCount,
331 const VkImageCopy *pRegions)
332 {
333 bool cs = cmd_buffer->queue_family_index == RADV_QUEUE_COMPUTE;
334 union meta_saved_state saved_state;
335
336 /* From the Vulkan 1.0 spec:
337 *
338 * vkCmdCopyImage can be used to copy image data between multisample
339 * images, but both images must have the same number of samples.
340 */
341 assert(src_image->info.samples == dest_image->info.samples);
342 if (cs)
343 radv_meta_save_compute(&saved_state.compute, cmd_buffer, 16);
344 else
345 radv_meta_save_graphics_reset_vport_scissor_novertex(&saved_state.gfx, cmd_buffer);
346
347 for (unsigned r = 0; r < regionCount; r++) {
348 assert(pRegions[r].srcSubresource.aspectMask ==
349 pRegions[r].dstSubresource.aspectMask);
350
351 /* Create blit surfaces */
352 struct radv_meta_blit2d_surf b_src =
353 blit_surf_for_image_level_layer(src_image,
354 &pRegions[r].srcSubresource);
355
356 struct radv_meta_blit2d_surf b_dst =
357 blit_surf_for_image_level_layer(dest_image,
358 &pRegions[r].dstSubresource);
359
360 /* for DCC */
361 b_src.format = b_dst.format;
362
363 /**
364 * From the Vulkan 1.0.6 spec: 18.4 Copying Data Between Buffers and Images
365 * imageExtent is the size in texels of the image to copy in width, height
366 * and depth. 1D images use only x and width. 2D images use x, y, width
367 * and height. 3D images use x, y, z, width, height and depth.
368 *
369 * Also, convert the offsets and extent from units of texels to units of
370 * blocks - which is the highest resolution accessible in this command.
371 */
372 const VkOffset3D dst_offset_el =
373 meta_region_offset_el(dest_image, &pRegions[r].dstOffset);
374 const VkOffset3D src_offset_el =
375 meta_region_offset_el(src_image, &pRegions[r].srcOffset);
376 const VkExtent3D img_extent_el =
377 meta_region_extent_el(dest_image, &pRegions[r].extent);
378
379 /* Start creating blit rect */
380 struct radv_meta_blit2d_rect rect = {
381 .width = img_extent_el.width,
382 .height = img_extent_el.height,
383 };
384
385 if (dest_image->type == VK_IMAGE_TYPE_3D)
386 b_dst.layer = dst_offset_el.z;
387
388 /* Loop through each 3D or array slice */
389 unsigned num_slices_3d = img_extent_el.depth;
390 unsigned num_slices_array = pRegions[r].dstSubresource.layerCount;
391 unsigned slice_3d = 0;
392 unsigned slice_array = 0;
393 while (slice_3d < num_slices_3d && slice_array < num_slices_array) {
394
395 /* Finish creating blit rect */
396 rect.dst_x = dst_offset_el.x;
397 rect.dst_y = dst_offset_el.y;
398 rect.src_x = src_offset_el.x;
399 rect.src_y = src_offset_el.y;
400
401 /* Perform Blit */
402 if (cs)
403 radv_meta_image_to_image_cs(cmd_buffer, &b_src, &b_dst, 1, &rect);
404 else
405 radv_meta_blit2d(cmd_buffer, &b_src, NULL, &b_dst, 1, &rect);
406
407 b_src.layer++;
408 b_dst.layer++;
409 if (dest_image->type == VK_IMAGE_TYPE_3D)
410 slice_3d++;
411 else
412 slice_array++;
413 }
414 }
415
416 if (cs)
417 radv_meta_restore_compute(&saved_state.compute, cmd_buffer, 16);
418 else
419 radv_meta_restore(&saved_state.gfx, cmd_buffer);
420 }
421
422 void radv_CmdCopyImage(
423 VkCommandBuffer commandBuffer,
424 VkImage srcImage,
425 VkImageLayout srcImageLayout,
426 VkImage destImage,
427 VkImageLayout destImageLayout,
428 uint32_t regionCount,
429 const VkImageCopy* pRegions)
430 {
431 RADV_FROM_HANDLE(radv_cmd_buffer, cmd_buffer, commandBuffer);
432 RADV_FROM_HANDLE(radv_image, src_image, srcImage);
433 RADV_FROM_HANDLE(radv_image, dest_image, destImage);
434
435 meta_copy_image(cmd_buffer, src_image, dest_image,
436 regionCount, pRegions);
437 }
438
439 void radv_blit_to_prime_linear(struct radv_cmd_buffer *cmd_buffer,
440 struct radv_image *image,
441 struct radv_image *linear_image)
442 {
443 struct VkImageCopy image_copy = { 0 };
444
445 image_copy.srcSubresource.aspectMask = VK_IMAGE_ASPECT_COLOR_BIT;
446 image_copy.srcSubresource.layerCount = 1;
447
448 image_copy.dstSubresource.aspectMask = VK_IMAGE_ASPECT_COLOR_BIT;
449 image_copy.dstSubresource.layerCount = 1;
450
451 image_copy.extent.width = image->info.width;
452 image_copy.extent.height = image->info.height;
453 image_copy.extent.depth = 1;
454
455 meta_copy_image(cmd_buffer, image, linear_image,
456 1, &image_copy);
457 }