radv: move some image info into a separate struct.
[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_begin_bufimage(cmd_buffer, &saved_state.compute);
125 else
126 radv_meta_save_graphics_reset_vport_scissor(&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_end_bufimage(cmd_buffer, &saved_state.compute);
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_begin_bufimage(cmd_buffer, &saved_state);
237 for (unsigned r = 0; r < regionCount; r++) {
238
239 /**
240 * From the Vulkan 1.0.6 spec: 18.3 Copying Data Between Images
241 * extent is the size in texels of the source image to copy in width,
242 * height and depth. 1D images use only x and width. 2D images use x, y,
243 * width and height. 3D images use x, y, z, width, height and depth.
244 *
245 *
246 * Also, convert the offsets and extent from units of texels to units of
247 * blocks - which is the highest resolution accessible in this command.
248 */
249 const VkOffset3D img_offset_el =
250 meta_region_offset_el(image, &pRegions[r].imageOffset);
251 const VkExtent3D bufferExtent = {
252 .width = pRegions[r].bufferRowLength ?
253 pRegions[r].bufferRowLength : pRegions[r].imageExtent.width,
254 .height = pRegions[r].bufferImageHeight ?
255 pRegions[r].bufferImageHeight : pRegions[r].imageExtent.height,
256 };
257 const VkExtent3D buf_extent_el =
258 meta_region_extent_el(image, &bufferExtent);
259
260 /* Start creating blit rect */
261 const VkExtent3D img_extent_el =
262 meta_region_extent_el(image, &pRegions[r].imageExtent);
263 struct radv_meta_blit2d_rect rect = {
264 .width = img_extent_el.width,
265 .height = img_extent_el.height,
266 };
267
268 /* Create blit surfaces */
269 struct radv_meta_blit2d_surf img_info =
270 blit_surf_for_image_level_layer(image,
271 &pRegions[r].imageSubresource);
272
273 struct radv_meta_blit2d_buffer buf_info = {
274 .bs = img_info.bs,
275 .format = img_info.format,
276 .buffer = buffer,
277 .offset = pRegions[r].bufferOffset,
278 .pitch = buf_extent_el.width,
279 };
280
281 if (image->type == VK_IMAGE_TYPE_3D)
282 img_info.layer = img_offset_el.z;
283 /* Loop through each 3D or array slice */
284 unsigned num_slices_3d = img_extent_el.depth;
285 unsigned num_slices_array = pRegions[r].imageSubresource.layerCount;
286 unsigned slice_3d = 0;
287 unsigned slice_array = 0;
288 while (slice_3d < num_slices_3d && slice_array < num_slices_array) {
289
290 rect.src_x = img_offset_el.x;
291 rect.src_y = img_offset_el.y;
292
293
294 /* Perform Blit */
295 radv_meta_image_to_buffer(cmd_buffer, &img_info, &buf_info, 1, &rect);
296
297 buf_info.offset += buf_extent_el.width *
298 buf_extent_el.height * buf_info.bs;
299 img_info.layer++;
300 if (image->type == VK_IMAGE_TYPE_3D)
301 slice_3d++;
302 else
303 slice_array++;
304 }
305 }
306 radv_meta_end_bufimage(cmd_buffer, &saved_state);
307 }
308
309 void radv_CmdCopyImageToBuffer(
310 VkCommandBuffer commandBuffer,
311 VkImage srcImage,
312 VkImageLayout srcImageLayout,
313 VkBuffer destBuffer,
314 uint32_t regionCount,
315 const VkBufferImageCopy* pRegions)
316 {
317 RADV_FROM_HANDLE(radv_cmd_buffer, cmd_buffer, commandBuffer);
318 RADV_FROM_HANDLE(radv_image, src_image, srcImage);
319 RADV_FROM_HANDLE(radv_buffer, dst_buffer, destBuffer);
320
321 meta_copy_image_to_buffer(cmd_buffer, dst_buffer, src_image,
322 regionCount, pRegions);
323 }
324
325 static void
326 meta_copy_image(struct radv_cmd_buffer *cmd_buffer,
327 struct radv_image *src_image,
328 struct radv_image *dest_image,
329 uint32_t regionCount,
330 const VkImageCopy *pRegions)
331 {
332 bool cs = cmd_buffer->queue_family_index == RADV_QUEUE_COMPUTE;
333 union meta_saved_state saved_state;
334
335 /* From the Vulkan 1.0 spec:
336 *
337 * vkCmdCopyImage can be used to copy image data between multisample
338 * images, but both images must have the same number of samples.
339 */
340 assert(src_image->info.samples == dest_image->info.samples);
341 if (cs)
342 radv_meta_begin_itoi(cmd_buffer, &saved_state.compute);
343 else
344 radv_meta_save_graphics_reset_vport_scissor(&saved_state.gfx, cmd_buffer);
345
346 for (unsigned r = 0; r < regionCount; r++) {
347 assert(pRegions[r].srcSubresource.aspectMask ==
348 pRegions[r].dstSubresource.aspectMask);
349
350 /* Create blit surfaces */
351 struct radv_meta_blit2d_surf b_src =
352 blit_surf_for_image_level_layer(src_image,
353 &pRegions[r].srcSubresource);
354
355 struct radv_meta_blit2d_surf b_dst =
356 blit_surf_for_image_level_layer(dest_image,
357 &pRegions[r].dstSubresource);
358
359 /* for DCC */
360 b_src.format = b_dst.format;
361
362 /**
363 * From the Vulkan 1.0.6 spec: 18.4 Copying Data Between Buffers and Images
364 * imageExtent is the size in texels of the image to copy in width, height
365 * and depth. 1D images use only x and width. 2D images use x, y, width
366 * and height. 3D images use x, y, z, width, height and depth.
367 *
368 * Also, convert the offsets and extent from units of texels to units of
369 * blocks - which is the highest resolution accessible in this command.
370 */
371 const VkOffset3D dst_offset_el =
372 meta_region_offset_el(dest_image, &pRegions[r].dstOffset);
373 const VkOffset3D src_offset_el =
374 meta_region_offset_el(src_image, &pRegions[r].srcOffset);
375 const VkExtent3D img_extent_el =
376 meta_region_extent_el(dest_image, &pRegions[r].extent);
377
378 /* Start creating blit rect */
379 struct radv_meta_blit2d_rect rect = {
380 .width = img_extent_el.width,
381 .height = img_extent_el.height,
382 };
383
384 if (dest_image->type == VK_IMAGE_TYPE_3D)
385 b_dst.layer = dst_offset_el.z;
386
387 /* Loop through each 3D or array slice */
388 unsigned num_slices_3d = img_extent_el.depth;
389 unsigned num_slices_array = pRegions[r].dstSubresource.layerCount;
390 unsigned slice_3d = 0;
391 unsigned slice_array = 0;
392 while (slice_3d < num_slices_3d && slice_array < num_slices_array) {
393
394 /* Finish creating blit rect */
395 rect.dst_x = dst_offset_el.x;
396 rect.dst_y = dst_offset_el.y;
397 rect.src_x = src_offset_el.x;
398 rect.src_y = src_offset_el.y;
399
400 /* Perform Blit */
401 if (cs)
402 radv_meta_image_to_image_cs(cmd_buffer, &b_src, &b_dst, 1, &rect);
403 else
404 radv_meta_blit2d(cmd_buffer, &b_src, NULL, &b_dst, 1, &rect);
405
406 b_src.layer++;
407 b_dst.layer++;
408 if (dest_image->type == VK_IMAGE_TYPE_3D)
409 slice_3d++;
410 else
411 slice_array++;
412 }
413 }
414
415 if (cs)
416 radv_meta_end_itoi(cmd_buffer, &saved_state.compute);
417 else
418 radv_meta_restore(&saved_state.gfx, cmd_buffer);
419 }
420
421 void radv_CmdCopyImage(
422 VkCommandBuffer commandBuffer,
423 VkImage srcImage,
424 VkImageLayout srcImageLayout,
425 VkImage destImage,
426 VkImageLayout destImageLayout,
427 uint32_t regionCount,
428 const VkImageCopy* pRegions)
429 {
430 RADV_FROM_HANDLE(radv_cmd_buffer, cmd_buffer, commandBuffer);
431 RADV_FROM_HANDLE(radv_image, src_image, srcImage);
432 RADV_FROM_HANDLE(radv_image, dest_image, destImage);
433
434 meta_copy_image(cmd_buffer, src_image, dest_image,
435 regionCount, pRegions);
436 }
437
438 void radv_blit_to_prime_linear(struct radv_cmd_buffer *cmd_buffer,
439 struct radv_image *image,
440 struct radv_image *linear_image)
441 {
442 struct VkImageCopy image_copy = { 0 };
443
444 image_copy.srcSubresource.aspectMask = VK_IMAGE_ASPECT_COLOR_BIT;
445 image_copy.srcSubresource.layerCount = 1;
446
447 image_copy.dstSubresource.aspectMask = VK_IMAGE_ASPECT_COLOR_BIT;
448 image_copy.dstSubresource.layerCount = 1;
449
450 image_copy.extent.width = image->info.width;
451 image_copy.extent.height = image->info.height;
452 image_copy.extent.depth = 1;
453
454 meta_copy_image(cmd_buffer, image, linear_image,
455 1, &image_copy);
456 }