blob: 846ef552ea9f6fadc6d5e5f2573469d0a9bada75 [file] [log] [blame]
/*
* Copyright (c) 2023-2025 The Khronos Group Inc.
* Copyright (c) 2023-2025 Valve Corporation
* Copyright (c) 2023-2025 LunarG, Inc.
* Copyright (c) 2023-2025 Google, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*/
#include "../framework/layer_validation_tests.h"
#include <algorithm>
bool HostImageCopyTest::CopyLayoutSupported(const std::vector<VkImageLayout> &src_layouts,
const std::vector<VkImageLayout> &dst_layouts, VkImageLayout layout) {
return ((std::find(src_layouts.begin(), src_layouts.end(), layout) != src_layouts.end()) &&
(std::find(dst_layouts.begin(), dst_layouts.end(), layout) != dst_layouts.end()));
}
void HostImageCopyTest::InitHostImageCopyTest() {
SetTargetApiVersion(VK_API_VERSION_1_2);
AddRequiredExtensions(VK_EXT_HOST_IMAGE_COPY_EXTENSION_NAME);
AddRequiredFeature(vkt::Feature::hostImageCopy);
RETURN_IF_SKIP(Init());
image_ci = vkt::Image::ImageCreateInfo2D(
width, height, 1, 1, format,
VK_IMAGE_USAGE_HOST_TRANSFER_BIT | VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT | VK_IMAGE_USAGE_TRANSFER_SRC_BIT);
VkPhysicalDeviceHostImageCopyPropertiesEXT host_image_copy_props = vku::InitStructHelper();
GetPhysicalDeviceProperties2(host_image_copy_props);
copy_src_layouts.resize(host_image_copy_props.copySrcLayoutCount);
copy_dst_layouts.resize(host_image_copy_props.copyDstLayoutCount);
host_image_copy_props.pCopySrcLayouts = copy_src_layouts.data();
host_image_copy_props.pCopyDstLayouts = copy_dst_layouts.data();
GetPhysicalDeviceProperties2(host_image_copy_props);
if (!CopyLayoutSupported(copy_src_layouts, copy_dst_layouts, VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL) ||
!CopyLayoutSupported(copy_src_layouts, copy_dst_layouts, VK_IMAGE_LAYOUT_GENERAL)) {
GTEST_SKIP() << "Required formats/features not supported";
}
}
class PositiveHostImageCopy : public HostImageCopyTest {};
TEST_F(PositiveHostImageCopy, BasicUsage) {
TEST_DESCRIPTION("Use VK_EXT_host_image_copy to copy to and from host memory");
RETURN_IF_SKIP(InitHostImageCopyTest());
if (IsPlatformMockICD()) {
GTEST_SKIP() << "Positive host image copy test requires a driver that can copy.";
}
if (!CopyLayoutSupported(copy_src_layouts, copy_dst_layouts, VK_IMAGE_LAYOUT_GENERAL)) {
GTEST_SKIP() << "Required formats/features not supported";
}
VkImageLayout layout = VK_IMAGE_LAYOUT_GENERAL;
vkt::Image image(*m_device, image_ci);
image.SetLayout(layout);
std::vector<uint8_t> pixels(width * height * 4);
// Fill image with random values
for (auto &channel : pixels) {
const uint32_t r = static_cast<uint32_t>(std::rand());
channel = static_cast<uint8_t>((r & 0xffu) | ((r >> 8) & 0xff) | ((r >> 16) & 0xff) | (r >> 24));
}
VkMemoryToImageCopy region_to_image = vku::InitStructHelper();
region_to_image.pHostPointer = pixels.data();
region_to_image.imageSubresource = {VK_IMAGE_ASPECT_COLOR_BIT, 0, 0, 1};
region_to_image.imageExtent = {width, height, 1};
VkCopyMemoryToImageInfo copy_to_image = vku::InitStructHelper();
copy_to_image.dstImage = image;
copy_to_image.dstImageLayout = layout;
copy_to_image.regionCount = 1;
copy_to_image.pRegions = &region_to_image;
VkResult result = vk::CopyMemoryToImageEXT(*m_device, &copy_to_image);
ASSERT_EQ(VK_SUCCESS, result);
// Copy back to host memory
std::vector<uint8_t> welcome_back(width * height * 4);
VkImageToMemoryCopy region_from_image = vku::InitStructHelper();
region_from_image.pHostPointer = welcome_back.data();
region_from_image.imageSubresource = {VK_IMAGE_ASPECT_COLOR_BIT, 0, 0, 1};
region_from_image.imageExtent = {width, height, 1};
VkCopyImageToMemoryInfo copy_from_image = vku::InitStructHelper();
copy_from_image.srcImage = image;
copy_from_image.srcImageLayout = layout;
copy_from_image.regionCount = 1;
copy_from_image.pRegions = &region_from_image;
result = vk::CopyImageToMemoryEXT(*m_device, &copy_from_image);
ASSERT_EQ(VK_SUCCESS, result);
ASSERT_EQ(pixels, welcome_back);
// Copy from one image to another
vkt::Image image2(*m_device, image_ci);
image2.SetLayout(layout);
VkImageCopy2 image_copy_2 = vku::InitStructHelper();
image_copy_2.srcSubresource = {VK_IMAGE_ASPECT_COLOR_BIT, 0, 0, 1};
image_copy_2.dstSubresource = {VK_IMAGE_ASPECT_COLOR_BIT, 0, 0, 1};
image_copy_2.extent = {width, height, 1};
VkCopyImageToImageInfo copy_image_to_image = vku::InitStructHelper();
copy_image_to_image.regionCount = 1;
copy_image_to_image.pRegions = &image_copy_2;
copy_image_to_image.srcImageLayout = layout;
copy_image_to_image.dstImageLayout = layout;
copy_image_to_image.srcImage = image;
copy_image_to_image.dstImage = image2;
result = vk::CopyImageToImageEXT(*m_device, &copy_image_to_image);
ASSERT_EQ(VK_SUCCESS, result);
// Copy back from destination image to memory
std::vector<uint8_t> after_image_copy(width * height * 4);
copy_from_image.srcImage = image2;
region_from_image.pHostPointer = after_image_copy.data();
result = vk::CopyImageToMemoryEXT(*m_device, &copy_from_image);
ASSERT_EQ(VK_SUCCESS, result);
ASSERT_EQ(pixels, after_image_copy);
// Do a layout transition, then use the image in new layout
VkHostImageLayoutTransitionInfo transition_info = vku::InitStructHelper();
transition_info.newLayout = VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL;
transition_info.oldLayout = VK_IMAGE_LAYOUT_GENERAL;
transition_info.subresourceRange = {VK_IMAGE_ASPECT_COLOR_BIT, 0, 1, 0, 1};
transition_info.image = image2;
result = vk::TransitionImageLayoutEXT(*m_device, 1, &transition_info);
ASSERT_EQ(VK_SUCCESS, result);
VkImageSubresourceRange image_sub_range{VK_IMAGE_ASPECT_COLOR_BIT, 0, 1, 0, 1};
VkImageMemoryBarrier image_barrier =
image2.ImageMemoryBarrier(0, 0, VK_IMAGE_LAYOUT_UNDEFINED, VK_IMAGE_LAYOUT_GENERAL, image_sub_range);
image_barrier.oldLayout = VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL;
image_barrier.newLayout = VK_IMAGE_LAYOUT_GENERAL;
m_command_buffer.Begin();
vk::CmdPipelineBarrier(m_command_buffer, VK_PIPELINE_STAGE_ALL_COMMANDS_BIT, VK_PIPELINE_STAGE_ALL_COMMANDS_BIT, 0, 0, nullptr,
0, nullptr, 1, &image_barrier);
m_command_buffer.End();
m_default_queue->SubmitAndWait(m_command_buffer);
// Get memory size of tiled image
VkImageSubresource2 subresource = vku::InitStructHelper();
subresource.imageSubresource.aspectMask = VK_IMAGE_ASPECT_COLOR_BIT;
VkSubresourceHostMemcpySize host_copy_size = vku::InitStructHelper();
VkSubresourceLayout2 subresource_layout = vku::InitStructHelper(&host_copy_size);
vk::GetImageSubresourceLayout2EXT(*m_device, image, &subresource, &subresource_layout);
ASSERT_NE(host_copy_size.size, 0);
VkHostImageCopyDevicePerformanceQuery perf_data = vku::InitStructHelper();
VkImageFormatProperties2 image_format_properties = vku::InitStructHelper(&perf_data);
VkPhysicalDeviceImageFormatInfo2 image_format_info = vku::InitStructHelper();
image_format_info.format = VK_FORMAT_R8G8B8A8_UNORM;
image_format_info.type = VK_IMAGE_TYPE_2D;
image_format_info.tiling = VK_IMAGE_TILING_OPTIMAL;
image_format_info.usage = VK_IMAGE_USAGE_HOST_TRANSFER_BIT;
vk::GetPhysicalDeviceImageFormatProperties2(Gpu(), &image_format_info, &image_format_properties);
}
TEST_F(PositiveHostImageCopy, BasicUsage14) {
TEST_DESCRIPTION("Make sure 1.4 works for Host Copy Image");
SetTargetApiVersion(VK_API_VERSION_1_4);
AddRequiredFeature(vkt::Feature::separateDepthStencilLayouts);
AddRequiredFeature(vkt::Feature::hostImageCopy);
RETURN_IF_SKIP(Init());
VkPhysicalDeviceHostImageCopyPropertiesEXT host_image_copy_props = vku::InitStructHelper();
GetPhysicalDeviceProperties2(host_image_copy_props);
copy_src_layouts.resize(host_image_copy_props.copySrcLayoutCount);
copy_dst_layouts.resize(host_image_copy_props.copyDstLayoutCount);
host_image_copy_props.pCopySrcLayouts = copy_src_layouts.data();
host_image_copy_props.pCopyDstLayouts = copy_dst_layouts.data();
GetPhysicalDeviceProperties2(host_image_copy_props);
if (!CopyLayoutSupported(copy_src_layouts, copy_dst_layouts, VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL) ||
!CopyLayoutSupported(copy_src_layouts, copy_dst_layouts, VK_IMAGE_LAYOUT_GENERAL)) {
GTEST_SKIP() << "Required formats/features not supported";
}
if (IsPlatformMockICD()) {
GTEST_SKIP() << "Positive host image copy test requires a driver that can copy.";
}
if (!CopyLayoutSupported(copy_src_layouts, copy_dst_layouts, VK_IMAGE_LAYOUT_GENERAL)) {
GTEST_SKIP() << "Required formats/features not supported";
}
VkImageLayout layout = VK_IMAGE_LAYOUT_GENERAL;
image_ci = vkt::Image::ImageCreateInfo2D(
width, height, 1, 1, format,
VK_IMAGE_USAGE_HOST_TRANSFER_BIT | VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT | VK_IMAGE_USAGE_TRANSFER_SRC_BIT);
vkt::Image image(*m_device, image_ci);
image.SetLayout(layout);
std::vector<uint8_t> pixels(width * height * 4);
// Fill image with random values
for (auto &channel : pixels) {
const uint32_t r = static_cast<uint32_t>(std::rand());
channel = static_cast<uint8_t>((r & 0xffu) | ((r >> 8) & 0xff) | ((r >> 16) & 0xff) | (r >> 24));
}
VkMemoryToImageCopy region_to_image = vku::InitStructHelper();
region_to_image.pHostPointer = pixels.data();
region_to_image.imageSubresource.aspectMask = VK_IMAGE_ASPECT_COLOR_BIT;
region_to_image.imageSubresource.layerCount = 1;
region_to_image.imageExtent = {width, height, 1};
VkCopyMemoryToImageInfo copy_to_image = vku::InitStructHelper();
copy_to_image.dstImage = image;
copy_to_image.dstImageLayout = layout;
copy_to_image.regionCount = 1;
copy_to_image.pRegions = &region_to_image;
VkResult result = vk::CopyMemoryToImage(*m_device, &copy_to_image);
ASSERT_EQ(VK_SUCCESS, result);
// Copy back to host memory
std::vector<uint8_t> welcome_back(width * height * 4);
VkImageToMemoryCopy region_from_image = vku::InitStructHelper();
region_from_image.pHostPointer = welcome_back.data();
region_from_image.imageSubresource.aspectMask = VK_IMAGE_ASPECT_COLOR_BIT;
region_from_image.imageSubresource.layerCount = 1;
region_from_image.imageExtent = {width, height, 1};
VkCopyImageToMemoryInfo copy_from_image = vku::InitStructHelper();
copy_from_image.srcImage = image;
copy_from_image.srcImageLayout = layout;
copy_from_image.regionCount = 1;
copy_from_image.pRegions = &region_from_image;
result = vk::CopyImageToMemory(*m_device, &copy_from_image);
ASSERT_EQ(VK_SUCCESS, result);
ASSERT_EQ(pixels, welcome_back);
// Copy from one image to another
vkt::Image image2(*m_device, image_ci);
image2.SetLayout(layout);
VkImageCopy2 image_copy_2 = vku::InitStructHelper();
image_copy_2.srcSubresource = {VK_IMAGE_ASPECT_COLOR_BIT, 0, 0, 1};
image_copy_2.dstSubresource = {VK_IMAGE_ASPECT_COLOR_BIT, 0, 0, 1};
image_copy_2.extent = {width, height, 1};
VkCopyImageToImageInfo copy_image_to_image = vku::InitStructHelper();
copy_image_to_image.regionCount = 1;
copy_image_to_image.pRegions = &image_copy_2;
copy_image_to_image.srcImageLayout = layout;
copy_image_to_image.dstImageLayout = layout;
copy_image_to_image.srcImage = image;
copy_image_to_image.dstImage = image2;
result = vk::CopyImageToImage(*m_device, &copy_image_to_image);
ASSERT_EQ(VK_SUCCESS, result);
// Copy back from destination image to memory
std::vector<uint8_t> after_image_copy(width * height * 4);
copy_from_image.srcImage = image2;
region_from_image.pHostPointer = after_image_copy.data();
result = vk::CopyImageToMemory(*m_device, &copy_from_image);
ASSERT_EQ(VK_SUCCESS, result);
ASSERT_EQ(pixels, after_image_copy);
// Do a layout transition, then use the image in new layout
VkHostImageLayoutTransitionInfo transition_info = vku::InitStructHelper();
transition_info.newLayout = VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL;
transition_info.oldLayout = VK_IMAGE_LAYOUT_GENERAL;
transition_info.subresourceRange = {VK_IMAGE_ASPECT_COLOR_BIT, 0, 1, 0, 1};
transition_info.image = image2;
result = vk::TransitionImageLayout(*m_device, 1, &transition_info);
ASSERT_EQ(VK_SUCCESS, result);
VkImageSubresourceRange image_sub_range = {VK_IMAGE_ASPECT_COLOR_BIT, 0, 1, 0, 1};
VkImageMemoryBarrier image_barrier =
image2.ImageMemoryBarrier(0, 0, VK_IMAGE_LAYOUT_UNDEFINED, VK_IMAGE_LAYOUT_GENERAL, image_sub_range);
image_barrier.oldLayout = VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL;
image_barrier.newLayout = VK_IMAGE_LAYOUT_GENERAL;
m_command_buffer.Begin();
vk::CmdPipelineBarrier(m_command_buffer, VK_PIPELINE_STAGE_ALL_COMMANDS_BIT, VK_PIPELINE_STAGE_ALL_COMMANDS_BIT, 0, 0, nullptr,
0, nullptr, 1, &image_barrier);
m_command_buffer.End();
m_default_queue->SubmitAndWait(m_command_buffer);
// Get memory size of tiled image
VkImageSubresource2 subresource = vku::InitStructHelper();
subresource.imageSubresource.aspectMask = VK_IMAGE_ASPECT_COLOR_BIT;
VkSubresourceHostMemcpySize host_copy_size = vku::InitStructHelper();
VkSubresourceLayout2 subresource_layout = vku::InitStructHelper(&host_copy_size);
vk::GetImageSubresourceLayout2(*m_device, image, &subresource, &subresource_layout);
ASSERT_NE(host_copy_size.size, 0);
VkHostImageCopyDevicePerformanceQuery perf_data = vku::InitStructHelper();
VkImageFormatProperties2 image_format_properties = vku::InitStructHelper(&perf_data);
VkPhysicalDeviceImageFormatInfo2 image_format_info = vku::InitStructHelper();
image_format_info.format = VK_FORMAT_R8G8B8A8_UNORM;
image_format_info.type = VK_IMAGE_TYPE_2D;
image_format_info.tiling = VK_IMAGE_TILING_OPTIMAL;
image_format_info.usage = VK_IMAGE_USAGE_HOST_TRANSFER_BIT;
vk::GetPhysicalDeviceImageFormatProperties2(Gpu(), &image_format_info, &image_format_properties);
}
TEST_F(PositiveHostImageCopy, CopyImageToMemoryMipLevel) {
TEST_DESCRIPTION("Use only selected image mip level to memory");
RETURN_IF_SKIP(InitHostImageCopyTest());
image_ci.mipLevels = 4;
VkImageLayout layout = VK_IMAGE_LAYOUT_GENERAL;
vkt::Image image(*m_device, image_ci);
image.SetLayout(layout);
const uint32_t buffer_size = width * height * 4u;
std::vector<uint8_t> data(buffer_size);
VkImageToMemoryCopy region = vku::InitStructHelper();
region.pHostPointer = data.data();
region.memoryRowLength = 0u;
region.memoryImageHeight = 0u;
region.imageSubresource = {VK_IMAGE_ASPECT_COLOR_BIT, 3u, 0u, 1u};
region.imageOffset = {0u, 0u, 0u};
region.imageExtent = {4u, 4u, 1u};
VkCopyImageToMemoryInfo copy_to_image_memory = vku::InitStructHelper();
copy_to_image_memory.flags = VK_HOST_IMAGE_COPY_MEMCPY;
copy_to_image_memory.srcImage = image;
copy_to_image_memory.srcImageLayout = layout;
copy_to_image_memory.regionCount = 1u;
copy_to_image_memory.pRegions = &region;
vk::CopyImageToMemoryEXT(*m_device, &copy_to_image_memory);
}
TEST_F(PositiveHostImageCopy, CompressedFormat) {
AddRequiredFeature(vkt::Feature::textureCompressionBC);
RETURN_IF_SKIP(InitHostImageCopyTest());
VkImageFormatProperties img_prop = {};
if (VK_SUCCESS != vk::GetPhysicalDeviceImageFormatProperties(m_device->Physical(), VK_FORMAT_BC3_SRGB_BLOCK, image_ci.imageType,
image_ci.tiling, image_ci.usage, image_ci.flags, &img_prop)) {
GTEST_SKIP() << "Image format properties not supported";
}
image_ci.format = VK_FORMAT_BC3_SRGB_BLOCK;
vkt::Image image(*m_device, image_ci);
image.SetLayout(VK_IMAGE_LAYOUT_GENERAL);
std::vector<uint8_t> pixels(width * height * 4);
VkMemoryToImageCopyEXT region_to_image = vku::InitStructHelper();
region_to_image.pHostPointer = pixels.data();
region_to_image.imageSubresource = {VK_IMAGE_ASPECT_COLOR_BIT, 0, 0, 1};
region_to_image.imageExtent = {width, height, 1};
VkCopyMemoryToImageInfoEXT copy_to_image = vku::InitStructHelper();
copy_to_image.dstImage = image;
copy_to_image.dstImageLayout = VK_IMAGE_LAYOUT_GENERAL;
copy_to_image.regionCount = 1;
copy_to_image.pRegions = &region_to_image;
VkResult result = vk::CopyMemoryToImageEXT(*m_device, &copy_to_image);
ASSERT_EQ(VK_SUCCESS, result);
}
TEST_F(PositiveHostImageCopy, TransitionImageLayoutDepthWrongAspect) {
RETURN_IF_SKIP(InitHostImageCopyTest());
VkImageCreateInfo depth_image_ci = vku::InitStructHelper();
depth_image_ci.imageType = VK_IMAGE_TYPE_2D;
depth_image_ci.format = VK_FORMAT_D32_SFLOAT;
depth_image_ci.extent = {32u, 32u, 1u};
depth_image_ci.mipLevels = 1u;
depth_image_ci.arrayLayers = 1u;
depth_image_ci.samples = VK_SAMPLE_COUNT_1_BIT;
depth_image_ci.tiling = VK_IMAGE_TILING_OPTIMAL;
depth_image_ci.usage = VK_IMAGE_USAGE_HOST_TRANSFER_BIT;
depth_image_ci.initialLayout = VK_IMAGE_LAYOUT_UNDEFINED;
VkPhysicalDeviceImageFormatInfo2 image_format_info = vku::InitStructHelper();
image_format_info.format = depth_image_ci.format;
image_format_info.type = depth_image_ci.imageType;
image_format_info.tiling = depth_image_ci.tiling;
image_format_info.usage = depth_image_ci.usage;
image_format_info.flags = depth_image_ci.flags;
VkImageFormatProperties2 image_format_properties = vku::InitStructHelper();
VkResult res =
vk::GetPhysicalDeviceImageFormatProperties2(m_device->physical_device_, &image_format_info, &image_format_properties);
if (res == VK_ERROR_FORMAT_NOT_SUPPORTED) {
GTEST_SKIP() << "Required format not supported";
}
if (!(m_device->FormatFeaturesOptimal(depth_image_ci.format) & VK_FORMAT_FEATURE_2_HOST_IMAGE_TRANSFER_BIT)) {
GTEST_SKIP() << "Device does not support host image on depth format";
}
vkt::Image image(*m_device, depth_image_ci, vkt::set_layout);
VkImageSubresourceRange range = {VK_IMAGE_ASPECT_DEPTH_BIT, 0u, 1u, 0u, 1u};
VkHostImageLayoutTransitionInfo transition_info = vku::InitStructHelper();
transition_info.image = image;
transition_info.oldLayout = VK_IMAGE_LAYOUT_UNDEFINED;
transition_info.newLayout = VK_IMAGE_LAYOUT_GENERAL;
transition_info.subresourceRange = range;
vk::TransitionImageLayoutEXT(*m_device, 1, &transition_info);
}