Google Git
Sign in
webkit / WebKit / 43b3b88a0f183213f2e5936dc9491c857b881fd8 / . / Source / ThirdParty / ANGLE / src / libANGLE / renderer / vulkan / vk_helpers.cpp
blob: 48ca412461b09fc8e271f56005611b8d8feacfc7 [file] [log] [blame]
//
// Copyright 2018 The ANGLE Project Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
//
// vk_helpers:
// Helper utility classes that manage Vulkan resources.
#include "libANGLE/renderer/vulkan/vk_helpers.h"
#include "common/utilities.h"
#include "common/vulkan/vk_headers.h"
#include "image_util/loadimage.h"
#include "libANGLE/Context.h"
#include "libANGLE/renderer/driver_utils.h"
#include "libANGLE/renderer/renderer_utils.h"
#include "libANGLE/renderer/vulkan/BufferVk.h"
#include "libANGLE/renderer/vulkan/ContextVk.h"
#include "libANGLE/renderer/vulkan/DisplayVk.h"
#include "libANGLE/renderer/vulkan/FramebufferVk.h"
#include "libANGLE/renderer/vulkan/RenderTargetVk.h"
#include "libANGLE/renderer/vulkan/RendererVk.h"
#include "libANGLE/renderer/vulkan/android/vk_android_utils.h"
#include "libANGLE/renderer/vulkan/vk_utils.h"
#include "libANGLE/trace.h"
namespace rx
{
namespace vk
{
namespace
{
// ANGLE_robust_resource_initialization requires color textures to be initialized to zero.
constexpr VkClearColorValue kRobustInitColorValue = {{0, 0, 0, 0}};
// When emulating a texture, we want the emulated channels to be 0, with alpha 1.
constexpr VkClearColorValue kEmulatedInitColorValue = {{0, 0, 0, 1.0f}};
// ANGLE_robust_resource_initialization requires depth to be initialized to 1 and stencil to 0.
// We are fine with these values for emulated depth/stencil textures too.
constexpr VkClearDepthStencilValue kRobustInitDepthStencilValue = {1.0f, 0};
constexpr VkImageAspectFlags kDepthStencilAspects =
VK_IMAGE_ASPECT_STENCIL_BIT | VK_IMAGE_ASPECT_DEPTH_BIT;
constexpr angle::PackedEnumMap<PipelineStage, VkPipelineStageFlagBits> kPipelineStageFlagBitMap = {
{PipelineStage::TopOfPipe, VK_PIPELINE_STAGE_TOP_OF_PIPE_BIT},
{PipelineStage::DrawIndirect, VK_PIPELINE_STAGE_DRAW_INDIRECT_BIT},
{PipelineStage::VertexInput, VK_PIPELINE_STAGE_VERTEX_INPUT_BIT},
{PipelineStage::VertexShader, VK_PIPELINE_STAGE_VERTEX_SHADER_BIT},
{PipelineStage::TessellationControl, VK_PIPELINE_STAGE_TESSELLATION_CONTROL_SHADER_BIT},
{PipelineStage::TessellationEvaluation, VK_PIPELINE_STAGE_TESSELLATION_EVALUATION_SHADER_BIT},
{PipelineStage::GeometryShader, VK_PIPELINE_STAGE_GEOMETRY_SHADER_BIT},
{PipelineStage::TransformFeedback, VK_PIPELINE_STAGE_TRANSFORM_FEEDBACK_BIT_EXT},
{PipelineStage::EarlyFragmentTest, VK_PIPELINE_STAGE_EARLY_FRAGMENT_TESTS_BIT},
{PipelineStage::FragmentShader, VK_PIPELINE_STAGE_FRAGMENT_SHADER_BIT},
{PipelineStage::LateFragmentTest, VK_PIPELINE_STAGE_LATE_FRAGMENT_TESTS_BIT},
{PipelineStage::ColorAttachmentOutput, VK_PIPELINE_STAGE_COLOR_ATTACHMENT_OUTPUT_BIT},
{PipelineStage::ComputeShader, VK_PIPELINE_STAGE_COMPUTE_SHADER_BIT},
{PipelineStage::Transfer, VK_PIPELINE_STAGE_TRANSFER_BIT},
{PipelineStage::BottomOfPipe, VK_PIPELINE_STAGE_BOTTOM_OF_PIPE_BIT},
{PipelineStage::Host, VK_PIPELINE_STAGE_HOST_BIT}};
constexpr gl::ShaderMap<PipelineStage> kPipelineStageShaderMap = {
{gl::ShaderType::Vertex, PipelineStage::VertexShader},
{gl::ShaderType::TessControl, PipelineStage::TessellationControl},
{gl::ShaderType::TessEvaluation, PipelineStage::TessellationEvaluation},
{gl::ShaderType::Geometry, PipelineStage::GeometryShader},
{gl::ShaderType::Fragment, PipelineStage::FragmentShader},
{gl::ShaderType::Compute, PipelineStage::ComputeShader},
};
constexpr size_t kDefaultPoolAllocatorPageSize = 16 * 1024;
struct ImageMemoryBarrierData
{
char name[44];
// The Vk layout corresponding to the ImageLayout key.
VkImageLayout layout;
// The stage in which the image is used (or Bottom/Top if not using any specific stage). Unless
// Bottom/Top (Bottom used for transition to and Top used for transition from), the two values
// should match.
VkPipelineStageFlags dstStageMask;
VkPipelineStageFlags srcStageMask;
// Access mask when transitioning into this layout.
VkAccessFlags dstAccessMask;
// Access mask when transitioning out from this layout. Note that source access mask never
// needs a READ bit, as WAR hazards don't need memory barriers (just execution barriers).
VkAccessFlags srcAccessMask;
// Read or write.
ResourceAccess type;
// *CommandBufferHelper track an array of PipelineBarriers. This indicates which array element
// this should be merged into. Right now we track individual barrier for every PipelineStage. If
// layout has a single stage mask bit, we use that stage as index. If layout has multiple stage
// mask bits, we pick the lowest stage as the index since it is the first stage that needs
// barrier.
PipelineStage barrierIndex;
};
constexpr VkPipelineStageFlags kPreFragmentStageFlags =
VK_PIPELINE_STAGE_VERTEX_SHADER_BIT | VK_PIPELINE_STAGE_TESSELLATION_CONTROL_SHADER_BIT |
VK_PIPELINE_STAGE_TESSELLATION_EVALUATION_SHADER_BIT | VK_PIPELINE_STAGE_GEOMETRY_SHADER_BIT;
constexpr VkPipelineStageFlags kAllShadersPipelineStageFlags =
kPreFragmentStageFlags | VK_PIPELINE_STAGE_FRAGMENT_SHADER_BIT |
VK_PIPELINE_STAGE_COMPUTE_SHADER_BIT;
constexpr VkPipelineStageFlags kAllDepthStencilPipelineStageFlags =
VK_PIPELINE_STAGE_EARLY_FRAGMENT_TESTS_BIT | VK_PIPELINE_STAGE_LATE_FRAGMENT_TESTS_BIT;
// clang-format off
constexpr angle::PackedEnumMap<ImageLayout, ImageMemoryBarrierData> kImageMemoryBarrierData = {
{
ImageLayout::Undefined,
ImageMemoryBarrierData{
"Undefined",
VK_IMAGE_LAYOUT_UNDEFINED,
VK_PIPELINE_STAGE_BOTTOM_OF_PIPE_BIT,
VK_PIPELINE_STAGE_TOP_OF_PIPE_BIT,
// Transition to: we don't expect to transition into Undefined.
0,
// Transition from: there's no data in the image to care about.
0,
ResourceAccess::ReadOnly,
PipelineStage::InvalidEnum,
},
},
{
ImageLayout::ColorAttachment,
ImageMemoryBarrierData{
"ColorAttachment",
VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL,
VK_PIPELINE_STAGE_COLOR_ATTACHMENT_OUTPUT_BIT,
VK_PIPELINE_STAGE_COLOR_ATTACHMENT_OUTPUT_BIT,
// Transition to: all reads and writes must happen after barrier.
VK_ACCESS_COLOR_ATTACHMENT_READ_BIT | VK_ACCESS_COLOR_ATTACHMENT_WRITE_BIT,
// Transition from: all writes must finish before barrier.
VK_ACCESS_COLOR_ATTACHMENT_WRITE_BIT,
ResourceAccess::Write,
PipelineStage::ColorAttachmentOutput,
},
},
{
ImageLayout::ColorAttachmentAndFragmentShaderRead,
ImageMemoryBarrierData{
"ColorAttachmentAndFragmentShaderRead",
VK_IMAGE_LAYOUT_GENERAL,
VK_PIPELINE_STAGE_COLOR_ATTACHMENT_OUTPUT_BIT | VK_PIPELINE_STAGE_FRAGMENT_SHADER_BIT,
VK_PIPELINE_STAGE_COLOR_ATTACHMENT_OUTPUT_BIT | VK_PIPELINE_STAGE_FRAGMENT_SHADER_BIT,
// Transition to: all reads and writes must happen after barrier.
VK_ACCESS_COLOR_ATTACHMENT_READ_BIT | VK_ACCESS_COLOR_ATTACHMENT_WRITE_BIT | VK_ACCESS_SHADER_READ_BIT,
// Transition from: all writes must finish before barrier.
VK_ACCESS_COLOR_ATTACHMENT_WRITE_BIT,
ResourceAccess::Write,
PipelineStage::FragmentShader,
},
},
{
ImageLayout::ColorAttachmentAndAllShadersRead,
ImageMemoryBarrierData{
"ColorAttachmentAndAllShadersRead",
VK_IMAGE_LAYOUT_GENERAL,
VK_PIPELINE_STAGE_COLOR_ATTACHMENT_OUTPUT_BIT | kAllShadersPipelineStageFlags,
VK_PIPELINE_STAGE_COLOR_ATTACHMENT_OUTPUT_BIT | kAllShadersPipelineStageFlags,
// Transition to: all reads and writes must happen after barrier.
VK_ACCESS_COLOR_ATTACHMENT_READ_BIT | VK_ACCESS_COLOR_ATTACHMENT_WRITE_BIT | VK_ACCESS_SHADER_READ_BIT,
// Transition from: all writes must finish before barrier.
VK_ACCESS_COLOR_ATTACHMENT_WRITE_BIT,
ResourceAccess::Write,
// In case of multiple destination stages, We barrier the earliest stage
PipelineStage::VertexShader,
},
},
{
ImageLayout::DSAttachmentWriteAndFragmentShaderRead,
ImageMemoryBarrierData{
"DSAttachmentWriteAndFragmentShaderRead",
VK_IMAGE_LAYOUT_GENERAL,
kAllDepthStencilPipelineStageFlags | VK_PIPELINE_STAGE_FRAGMENT_SHADER_BIT,
kAllDepthStencilPipelineStageFlags | VK_PIPELINE_STAGE_FRAGMENT_SHADER_BIT,
// Transition to: all reads and writes must happen after barrier.
VK_ACCESS_DEPTH_STENCIL_ATTACHMENT_READ_BIT | VK_ACCESS_DEPTH_STENCIL_ATTACHMENT_WRITE_BIT | VK_ACCESS_SHADER_READ_BIT,
// Transition from: all writes must finish before barrier.
VK_ACCESS_DEPTH_STENCIL_ATTACHMENT_WRITE_BIT,
ResourceAccess::Write,
PipelineStage::FragmentShader,
},
},
{
ImageLayout::DSAttachmentWriteAndAllShadersRead,
ImageMemoryBarrierData{
"DSAttachmentWriteAndAllShadersRead",
VK_IMAGE_LAYOUT_GENERAL,
kAllDepthStencilPipelineStageFlags | kAllShadersPipelineStageFlags,
kAllDepthStencilPipelineStageFlags | kAllShadersPipelineStageFlags,
// Transition to: all reads and writes must happen after barrier.
VK_ACCESS_DEPTH_STENCIL_ATTACHMENT_READ_BIT | VK_ACCESS_DEPTH_STENCIL_ATTACHMENT_WRITE_BIT | VK_ACCESS_SHADER_READ_BIT,
// Transition from: all writes must finish before barrier.
VK_ACCESS_DEPTH_STENCIL_ATTACHMENT_WRITE_BIT,
ResourceAccess::Write,
// In case of multiple destination stages, We barrier the earliest stage
PipelineStage::VertexShader,
},
},
{
ImageLayout::DSAttachmentReadAndFragmentShaderRead,
ImageMemoryBarrierData{
"DSAttachmentReadAndFragmentShaderRead",
VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL,
VK_PIPELINE_STAGE_FRAGMENT_SHADER_BIT | kAllDepthStencilPipelineStageFlags,
VK_PIPELINE_STAGE_FRAGMENT_SHADER_BIT | kAllDepthStencilPipelineStageFlags,
// Transition to: all reads must happen after barrier.
VK_ACCESS_SHADER_READ_BIT | VK_ACCESS_DEPTH_STENCIL_ATTACHMENT_READ_BIT,
// Transition from: RAR and WAR don't need memory barrier.
0,
ResourceAccess::ReadOnly,
PipelineStage::EarlyFragmentTest,
},
},
{
ImageLayout::DSAttachmentReadAndAllShadersRead,
ImageMemoryBarrierData{
"DSAttachmentReadAndAllShadersRead",
VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL,
kAllShadersPipelineStageFlags | kAllDepthStencilPipelineStageFlags,
kAllShadersPipelineStageFlags | kAllDepthStencilPipelineStageFlags,
// Transition to: all reads must happen after barrier.
VK_ACCESS_SHADER_READ_BIT | VK_ACCESS_DEPTH_STENCIL_ATTACHMENT_READ_BIT,
// Transition from: RAR and WAR don't need memory barrier.
0,
ResourceAccess::ReadOnly,
PipelineStage::VertexShader,
},
},
{
ImageLayout::DepthStencilAttachmentReadOnly,
ImageMemoryBarrierData{
"DepthStencilAttachmentReadOnly",
VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL,
kAllDepthStencilPipelineStageFlags,
kAllDepthStencilPipelineStageFlags,
// Transition to: all reads must happen after barrier.
VK_ACCESS_DEPTH_STENCIL_ATTACHMENT_READ_BIT,
// Transition from: RAR and WAR don't need memory barrier.
0,
ResourceAccess::ReadOnly,
PipelineStage::EarlyFragmentTest,
},
},
{
ImageLayout::DepthStencilAttachment,
ImageMemoryBarrierData{
"DepthStencilAttachment",
VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL,
kAllDepthStencilPipelineStageFlags,
kAllDepthStencilPipelineStageFlags,
// Transition to: all reads and writes must happen after barrier.
VK_ACCESS_DEPTH_STENCIL_ATTACHMENT_READ_BIT | VK_ACCESS_DEPTH_STENCIL_ATTACHMENT_WRITE_BIT,
// Transition from: all writes must finish before barrier.
VK_ACCESS_DEPTH_STENCIL_ATTACHMENT_WRITE_BIT,
ResourceAccess::Write,
PipelineStage::EarlyFragmentTest,
},
},
{
ImageLayout::DepthStencilResolveAttachment,
ImageMemoryBarrierData{
"DepthStencilResolveAttachment",
VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL,
// Note: depth/stencil resolve uses color output stage and mask!
VK_PIPELINE_STAGE_COLOR_ATTACHMENT_OUTPUT_BIT,
VK_PIPELINE_STAGE_COLOR_ATTACHMENT_OUTPUT_BIT,
// Transition to: all reads and writes must happen after barrier.
VK_ACCESS_COLOR_ATTACHMENT_WRITE_BIT,
// Transition from: all writes must finish before barrier.
VK_ACCESS_COLOR_ATTACHMENT_WRITE_BIT,
ResourceAccess::Write,
PipelineStage::ColorAttachmentOutput,
},
},
{
ImageLayout::Present,
ImageMemoryBarrierData{
"Present",
VK_IMAGE_LAYOUT_PRESENT_SRC_KHR,
VK_PIPELINE_STAGE_BOTTOM_OF_PIPE_BIT,
VK_PIPELINE_STAGE_TOP_OF_PIPE_BIT,
// transition to: vkQueuePresentKHR automatically performs the appropriate memory barriers:
//
// > Any writes to memory backing the images referenced by the pImageIndices and
// > pSwapchains members of pPresentInfo, that are available before vkQueuePresentKHR
// > is executed, are automatically made visible to the read access performed by the
// > presentation engine.
0,
// Transition from: RAR and WAR don't need memory barrier.
0,
ResourceAccess::ReadOnly,
PipelineStage::BottomOfPipe,
},
},
{
ImageLayout::SharedPresent,
ImageMemoryBarrierData{
"SharedPresent",
VK_IMAGE_LAYOUT_SHARED_PRESENT_KHR,
VK_PIPELINE_STAGE_BOTTOM_OF_PIPE_BIT,
VK_PIPELINE_STAGE_TOP_OF_PIPE_BIT,
// Transition to: all reads and writes must happen after barrier.
VK_ACCESS_MEMORY_READ_BIT | VK_ACCESS_MEMORY_WRITE_BIT,
// Transition from: all writes must finish before barrier.
VK_ACCESS_MEMORY_WRITE_BIT,
ResourceAccess::Write,
PipelineStage::BottomOfPipe,
},
},
{
ImageLayout::ExternalPreInitialized,
ImageMemoryBarrierData{
"ExternalPreInitialized",
// Binding a VkImage with an initial layout of VK_IMAGE_LAYOUT_UNDEFINED to external
// memory whose content has already been defined does not make the content undefined
// (see 12.8.1. External Resource Sharing).
//
// Note that for external memory objects, if the content is already defined, the
// ownership rules imply that the first operation on the texture must be a call to
// glWaitSemaphoreEXT that grants ownership of the image and informs us of the true
// layout. If the content is not already defined, the first operation may not be a
// glWaitSemaphore, but in this case undefined layout is appropriate.
VK_IMAGE_LAYOUT_UNDEFINED,
VK_PIPELINE_STAGE_BOTTOM_OF_PIPE_BIT,
VK_PIPELINE_STAGE_HOST_BIT | VK_PIPELINE_STAGE_ALL_COMMANDS_BIT,
// Transition to: we don't expect to transition into PreInitialized.
0,
// Transition from: all writes must finish before barrier.
VK_ACCESS_MEMORY_WRITE_BIT,
ResourceAccess::ReadOnly,
PipelineStage::InvalidEnum,
},
},
{
ImageLayout::ExternalShadersReadOnly,
ImageMemoryBarrierData{
"ExternalShadersReadOnly",
VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL,
VK_PIPELINE_STAGE_ALL_COMMANDS_BIT,
VK_PIPELINE_STAGE_ALL_COMMANDS_BIT,
// Transition to: all reads must happen after barrier.
VK_ACCESS_SHADER_READ_BIT,
// Transition from: RAR and WAR don't need memory barrier.
0,
ResourceAccess::ReadOnly,
// In case of multiple destination stages, We barrier the earliest stage
PipelineStage::TopOfPipe,
},
},
{
ImageLayout::ExternalShadersWrite,
ImageMemoryBarrierData{
"ExternalShadersWrite",
VK_IMAGE_LAYOUT_GENERAL,
VK_PIPELINE_STAGE_ALL_COMMANDS_BIT,
VK_PIPELINE_STAGE_ALL_COMMANDS_BIT,
// Transition to: all reads and writes must happen after barrier.
VK_ACCESS_SHADER_READ_BIT | VK_ACCESS_SHADER_WRITE_BIT,
// Transition from: all writes must finish before barrier.
VK_ACCESS_SHADER_WRITE_BIT,
ResourceAccess::Write,
// In case of multiple destination stages, We barrier the earliest stage
PipelineStage::TopOfPipe,
},
},
{
ImageLayout::TransferSrc,
ImageMemoryBarrierData{
"TransferSrc",
VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL,
VK_PIPELINE_STAGE_TRANSFER_BIT,
VK_PIPELINE_STAGE_TRANSFER_BIT,
// Transition to: all reads must happen after barrier.
VK_ACCESS_TRANSFER_READ_BIT,
// Transition from: RAR and WAR don't need memory barrier.
0,
ResourceAccess::ReadOnly,
PipelineStage::Transfer,
},
},
{
ImageLayout::TransferDst,
ImageMemoryBarrierData{
"TransferDst",
VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL,
VK_PIPELINE_STAGE_TRANSFER_BIT,
VK_PIPELINE_STAGE_TRANSFER_BIT,
// Transition to: all writes must happen after barrier.
VK_ACCESS_TRANSFER_WRITE_BIT,
// Transition from: all writes must finish before barrier.
VK_ACCESS_TRANSFER_WRITE_BIT,
ResourceAccess::Write,
PipelineStage::Transfer,
},
},
{
ImageLayout::VertexShaderReadOnly,
ImageMemoryBarrierData{
"VertexShaderReadOnly",
VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL,
VK_PIPELINE_STAGE_VERTEX_SHADER_BIT,
VK_PIPELINE_STAGE_VERTEX_SHADER_BIT,
// Transition to: all reads must happen after barrier.
VK_ACCESS_SHADER_READ_BIT,
// Transition from: RAR and WAR don't need memory barrier.
0,
ResourceAccess::ReadOnly,
PipelineStage::VertexShader,
},
},
{
ImageLayout::VertexShaderWrite,
ImageMemoryBarrierData{
"VertexShaderWrite",
VK_IMAGE_LAYOUT_GENERAL,
VK_PIPELINE_STAGE_VERTEX_SHADER_BIT,
VK_PIPELINE_STAGE_VERTEX_SHADER_BIT,
// Transition to: all reads and writes must happen after barrier.
VK_ACCESS_SHADER_READ_BIT | VK_ACCESS_SHADER_WRITE_BIT,
// Transition from: all writes must finish before barrier.
VK_ACCESS_SHADER_WRITE_BIT,
ResourceAccess::Write,
PipelineStage::VertexShader,
},
},
{
ImageLayout::PreFragmentShadersReadOnly,
ImageMemoryBarrierData{
"PreFragmentShadersReadOnly",
VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL,
kPreFragmentStageFlags,
kPreFragmentStageFlags,
// Transition to: all reads must happen after barrier.
VK_ACCESS_SHADER_READ_BIT,
// Transition from: RAR and WAR don't need memory barrier.
0,
ResourceAccess::ReadOnly,
// In case of multiple destination stages, We barrier the earliest stage
PipelineStage::VertexShader,
},
},
{
ImageLayout::PreFragmentShadersWrite,
ImageMemoryBarrierData{
"PreFragmentShadersWrite",
VK_IMAGE_LAYOUT_GENERAL,
kPreFragmentStageFlags,
kPreFragmentStageFlags,
// Transition to: all reads and writes must happen after barrier.
VK_ACCESS_SHADER_READ_BIT | VK_ACCESS_SHADER_WRITE_BIT,
// Transition from: all writes must finish before barrier.
VK_ACCESS_SHADER_WRITE_BIT,
ResourceAccess::Write,
// In case of multiple destination stages, We barrier the earliest stage
PipelineStage::VertexShader,
},
},
{
ImageLayout::FragmentShaderReadOnly,
ImageMemoryBarrierData{
"FragmentShaderReadOnly",
VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL,
VK_PIPELINE_STAGE_FRAGMENT_SHADER_BIT,
VK_PIPELINE_STAGE_FRAGMENT_SHADER_BIT,
// Transition to: all reads must happen after barrier.
VK_ACCESS_SHADER_READ_BIT,
// Transition from: RAR and WAR don't need memory barrier.
0,
ResourceAccess::ReadOnly,
PipelineStage::FragmentShader,
},
},
{
ImageLayout::FragmentShaderWrite,
ImageMemoryBarrierData{
"FragmentShaderWrite",
VK_IMAGE_LAYOUT_GENERAL,
VK_PIPELINE_STAGE_FRAGMENT_SHADER_BIT,
VK_PIPELINE_STAGE_FRAGMENT_SHADER_BIT,
// Transition to: all reads and writes must happen after barrier.
VK_ACCESS_SHADER_READ_BIT | VK_ACCESS_SHADER_WRITE_BIT,
// Transition from: all writes must finish before barrier.
VK_ACCESS_SHADER_WRITE_BIT,
ResourceAccess::Write,
PipelineStage::FragmentShader,
},
},
{
ImageLayout::ComputeShaderReadOnly,
ImageMemoryBarrierData{
"ComputeShaderReadOnly",
VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL,
VK_PIPELINE_STAGE_COMPUTE_SHADER_BIT,
VK_PIPELINE_STAGE_COMPUTE_SHADER_BIT,
// Transition to: all reads must happen after barrier.
VK_ACCESS_SHADER_READ_BIT,
// Transition from: RAR and WAR don't need memory barrier.
0,
ResourceAccess::ReadOnly,
PipelineStage::ComputeShader,
},
},
{
ImageLayout::ComputeShaderWrite,
ImageMemoryBarrierData{
"ComputeShaderWrite",
VK_IMAGE_LAYOUT_GENERAL,
VK_PIPELINE_STAGE_COMPUTE_SHADER_BIT,
VK_PIPELINE_STAGE_COMPUTE_SHADER_BIT,
// Transition to: all reads and writes must happen after barrier.
VK_ACCESS_SHADER_READ_BIT | VK_ACCESS_SHADER_WRITE_BIT,
// Transition from: all writes must finish before barrier.
VK_ACCESS_SHADER_WRITE_BIT,
ResourceAccess::Write,
PipelineStage::ComputeShader,
},
},
{
ImageLayout::AllGraphicsShadersReadOnly,
ImageMemoryBarrierData{
"AllGraphicsShadersReadOnly",
VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL,
kAllShadersPipelineStageFlags,
kAllShadersPipelineStageFlags,
// Transition to: all reads must happen after barrier.
VK_ACCESS_SHADER_READ_BIT,
// Transition from: RAR and WAR don't need memory barrier.
0,
ResourceAccess::ReadOnly,
// In case of multiple destination stages, We barrier the earliest stage
PipelineStage::VertexShader,
},
},
{
ImageLayout::AllGraphicsShadersWrite,
ImageMemoryBarrierData{
"AllGraphicsShadersWrite",
VK_IMAGE_LAYOUT_GENERAL,
kAllShadersPipelineStageFlags,
kAllShadersPipelineStageFlags,
// Transition to: all reads and writes must happen after barrier.
VK_ACCESS_SHADER_READ_BIT | VK_ACCESS_SHADER_WRITE_BIT,
// Transition from: all writes must finish before barrier.
VK_ACCESS_SHADER_WRITE_BIT,
ResourceAccess::Write,
// In case of multiple destination stages, We barrier the earliest stage
PipelineStage::VertexShader,
},
},
};
// clang-format on
VkPipelineStageFlags GetImageLayoutSrcStageMask(Context *context,
const ImageMemoryBarrierData &transition)
{
return transition.srcStageMask & context->getRenderer()->getSupportedVulkanPipelineStageMask();
}
VkPipelineStageFlags GetImageLayoutDstStageMask(Context *context,
const ImageMemoryBarrierData &transition)
{
return transition.dstStageMask & context->getRenderer()->getSupportedVulkanPipelineStageMask();
}
void HandlePrimitiveRestart(ContextVk *contextVk,
gl::DrawElementsType glIndexType,
GLsizei indexCount,
const uint8_t *srcPtr,
uint8_t *outPtr)
{
switch (glIndexType)
{
case gl::DrawElementsType::UnsignedByte:
if (contextVk->getFeatures().supportsIndexTypeUint8.enabled)
{
CopyLineLoopIndicesWithRestart<uint8_t, uint8_t>(indexCount, srcPtr, outPtr);
}
else
{
CopyLineLoopIndicesWithRestart<uint8_t, uint16_t>(indexCount, srcPtr, outPtr);
}
break;
case gl::DrawElementsType::UnsignedShort:
CopyLineLoopIndicesWithRestart<uint16_t, uint16_t>(indexCount, srcPtr, outPtr);
break;
case gl::DrawElementsType::UnsignedInt:
CopyLineLoopIndicesWithRestart<uint32_t, uint32_t>(indexCount, srcPtr, outPtr);
break;
default:
UNREACHABLE();
}
}
bool HasBothDepthAndStencilAspects(VkImageAspectFlags aspectFlags)
{
return IsMaskFlagSet(aspectFlags, kDepthStencilAspects);
}
uint8_t GetContentDefinedLayerRangeBits(uint32_t layerStart,
uint32_t layerCount,
uint32_t maxLayerCount)
{
uint8_t layerRangeBits = layerCount >= maxLayerCount ? static_cast<uint8_t>(~0u)
: angle::BitMask<uint8_t>(layerCount);
layerRangeBits <<= layerStart;
return layerRangeBits;
}
uint32_t GetImageLayerCountForView(const ImageHelper &image)
{
// Depth > 1 means this is a 3D texture and depth is our layer count
return image.getExtents().depth > 1 ? image.getExtents().depth : image.getLayerCount();
}
void ReleaseImageViews(ImageViewVector *imageViewVector, std::vector<GarbageObject> *garbage)
{
for (ImageView &imageView : *imageViewVector)
{
if (imageView.valid())
{
garbage->emplace_back(GetGarbage(&imageView));
}
}
imageViewVector->clear();
}
void DestroyImageViews(ImageViewVector *imageViewVector, VkDevice device)
{
for (ImageView &imageView : *imageViewVector)
{
imageView.destroy(device);
}
imageViewVector->clear();
}
ImageView *GetLevelImageView(ImageViewVector *imageViews, LevelIndex levelVk, uint32_t levelCount)
{
// Lazily allocate the storage for image views. We allocate the full level count because we
// don't want to trigger any std::vector reallocations. Reallocations could invalidate our
// view pointers.
if (imageViews->empty())
{
imageViews->resize(levelCount);
}
ASSERT(imageViews->size() > levelVk.get());
return &(*imageViews)[levelVk.get()];
}
ImageView *GetLevelLayerImageView(LayerLevelImageViewVector *imageViews,
LevelIndex levelVk,
uint32_t layer,
uint32_t levelCount,
uint32_t layerCount)
{
// Lazily allocate the storage for image views. We allocate the full layer count because we
// don't want to trigger any std::vector reallocations. Reallocations could invalidate our
// view pointers.
if (imageViews->empty())
{
imageViews->resize(layerCount);
}
ASSERT(imageViews->size() > layer);
return GetLevelImageView(&(*imageViews)[layer], levelVk, levelCount);
}
// Special rules apply to VkBufferImageCopy with depth/stencil. The components are tightly packed
// into a depth or stencil section of the destination buffer. See the spec:
// https://www.khronos.org/registry/vulkan/specs/1.1-extensions/man/html/VkBufferImageCopy.html
const angle::Format &GetDepthStencilImageToBufferFormat(const angle::Format &imageFormat,
VkImageAspectFlagBits copyAspect)
{
if (copyAspect == VK_IMAGE_ASPECT_STENCIL_BIT)
{
ASSERT(imageFormat.id == angle::FormatID::D24_UNORM_S8_UINT ||
imageFormat.id == angle::FormatID::D32_FLOAT_S8X24_UINT ||
imageFormat.id == angle::FormatID::S8_UINT);
return angle::Format::Get(angle::FormatID::S8_UINT);
}
ASSERT(copyAspect == VK_IMAGE_ASPECT_DEPTH_BIT);
switch (imageFormat.id)
{
case angle::FormatID::D16_UNORM:
return imageFormat;
case angle::FormatID::D24_UNORM_X8_UINT:
return imageFormat;
case angle::FormatID::D24_UNORM_S8_UINT:
return angle::Format::Get(angle::FormatID::D24_UNORM_X8_UINT);
case angle::FormatID::D32_FLOAT:
return imageFormat;
case angle::FormatID::D32_FLOAT_S8X24_UINT:
return angle::Format::Get(angle::FormatID::D32_FLOAT);
default:
UNREACHABLE();
return imageFormat;
}
}
VkClearValue GetRobustResourceClearValue(const angle::Format &intendedFormat,
const angle::Format &actualFormat)
{
VkClearValue clearValue = {};
if (intendedFormat.hasDepthOrStencilBits())
{
clearValue.depthStencil = kRobustInitDepthStencilValue;
}
else
{
clearValue.color = HasEmulatedImageChannels(intendedFormat, actualFormat)
? kEmulatedInitColorValue
: kRobustInitColorValue;
}
return clearValue;
}
#if !defined(ANGLE_PLATFORM_MACOS) && !defined(ANGLE_PLATFORM_ANDROID)
bool IsExternalQueueFamily(uint32_t queueFamilyIndex)
{
return queueFamilyIndex == VK_QUEUE_FAMILY_EXTERNAL ||
queueFamilyIndex == VK_QUEUE_FAMILY_FOREIGN_EXT;
}
#endif
bool IsShaderReadOnlyLayout(const ImageMemoryBarrierData &imageLayout)
{
// We also use VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL for texture sample from depth
// texture. See GetImageReadLayout() for detail.
return imageLayout.layout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL ||
imageLayout.layout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL;
}
bool IsAnySubresourceContentDefined(const gl::TexLevelArray<angle::BitSet8<8>> &contentDefined)
{
for (const angle::BitSet8<8> &levelContentDefined : contentDefined)
{
if (levelContentDefined.any())
{
return true;
}
}
return false;
}
void ExtendRenderPassInvalidateArea(const gl::Rectangle &invalidateArea, gl::Rectangle *out)
{
if (out->empty())
{
*out = invalidateArea;
}
else
{
gl::ExtendRectangle(*out, invalidateArea, out);
}
}
bool CanCopyWithTransferForCopyImage(RendererVk *renderer,
ImageHelper *srcImage,
VkImageTiling srcTilingMode,
ImageHelper *dstImage,
VkImageTiling dstTilingMode)
{
// Neither source nor destination formats can be emulated for copy image through transfer,
// unless they are emulated with the same format!
bool isFormatCompatible =
(!srcImage->hasEmulatedImageFormat() && !dstImage->hasEmulatedImageFormat()) ||
srcImage->getActualFormatID() == dstImage->getActualFormatID();
// If neither formats are emulated, GL validation ensures that pixelBytes is the same for both.
ASSERT(!isFormatCompatible ||
srcImage->getActualFormat().pixelBytes == dstImage->getActualFormat().pixelBytes);
return isFormatCompatible &&
CanCopyWithTransfer(renderer, srcImage->getActualFormatID(), srcTilingMode,
dstImage->getActualFormatID(), dstTilingMode);
}
void ReleaseBufferListToRenderer(RendererVk *renderer, BufferHelperPointerVector *buffers)
{
for (std::unique_ptr<BufferHelper> &toFree : *buffers)
{
toFree->release(renderer);
}
buffers->clear();
}
void DestroyBufferList(RendererVk *renderer, BufferHelperPointerVector *buffers)
{
for (std::unique_ptr<BufferHelper> &toDestroy : *buffers)
{
toDestroy->destroy(renderer);
}
buffers->clear();
}
// Helper functions used below
char GetLoadOpShorthand(RenderPassLoadOp loadOp)
{
switch (loadOp)
{
case RenderPassLoadOp::Clear:
return 'C';
case RenderPassLoadOp::Load:
return 'L';
case RenderPassLoadOp::None:
return 'N';
default:
return 'D';
}
}
char GetStoreOpShorthand(RenderPassStoreOp storeOp)
{
switch (storeOp)
{
case RenderPassStoreOp::Store:
return 'S';
case RenderPassStoreOp::None:
return 'N';
default:
return 'D';
}
}
template <typename CommandBufferHelperT>
void RecycleCommandBufferHelper(VkDevice device,
std::vector<CommandBufferHelperT *> *freeList,
CommandBufferHelperT **commandBufferHelper,
priv::SecondaryCommandBuffer *commandBuffer)
{
freeList->push_back(*commandBufferHelper);
}
template <typename CommandBufferHelperT>
void RecycleCommandBufferHelper(VkDevice device,
std::vector<CommandBufferHelperT *> *freeList,
CommandBufferHelperT **commandBufferHelper,
VulkanSecondaryCommandBuffer *commandBuffer)
{
CommandPool *pool = (*commandBufferHelper)->getCommandPool();
pool->freeCommandBuffers(device, 1, commandBuffer->ptr());
commandBuffer->releaseHandle();
SafeDelete(*commandBufferHelper);
}
ANGLE_MAYBE_UNUSED void ResetSecondaryCommandBuffer(
std::vector<priv::SecondaryCommandBuffer> *resetList,
priv::SecondaryCommandBuffer &&commandBuffer)
{
commandBuffer.reset();
}
ANGLE_MAYBE_UNUSED void ResetSecondaryCommandBuffer(
std::vector<VulkanSecondaryCommandBuffer> *resetList,
VulkanSecondaryCommandBuffer &&commandBuffer)
{
resetList->push_back(std::move(commandBuffer));
}
bool IsClear(UpdateSource updateSource)
{
return updateSource == UpdateSource::Clear ||
updateSource == UpdateSource::ClearEmulatedChannelsOnly ||
updateSource == UpdateSource::ClearAfterInvalidate;
}
bool IsClearOfAllChannels(UpdateSource updateSource)
{
return updateSource == UpdateSource::Clear ||
updateSource == UpdateSource::ClearAfterInvalidate;
}
angle::Result InitDynamicDescriptorPool(Context *context,
const DescriptorSetLayoutDesc &descriptorSetLayoutDesc,
VkDescriptorSetLayout descriptorSetLayout,
uint32_t descriptorCountMultiplier,
DynamicDescriptorPool *poolToInit)
{
std::vector<VkDescriptorPoolSize> descriptorPoolSizes;
DescriptorSetLayoutBindingVector bindingVector;
std::vector<VkSampler> immutableSamplers;
descriptorSetLayoutDesc.unpackBindings(&bindingVector, &immutableSamplers);
for (const VkDescriptorSetLayoutBinding &binding : bindingVector)
{
if (binding.descriptorCount > 0)
{
VkDescriptorPoolSize poolSize = {};
poolSize.type = binding.descriptorType;
poolSize.descriptorCount = binding.descriptorCount * descriptorCountMultiplier;
descriptorPoolSizes.emplace_back(poolSize);
}
}
if (descriptorPoolSizes.empty())
{
if (context->getRenderer()->getFeatures().bindEmptyForUnusedDescriptorSets.enabled)
{
// For this workaround, we have to create an empty descriptor set for each descriptor
// set index, so make sure their pools are initialized.
VkDescriptorPoolSize poolSize = {};
// The type doesn't matter, since it's not actually used for anything.
poolSize.type = VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER;
poolSize.descriptorCount = 1;
descriptorPoolSizes.emplace_back(poolSize);
}
else
{
return angle::Result::Continue;
}
}
if (!descriptorPoolSizes.empty())
{
ANGLE_TRY(poolToInit->init(context, descriptorPoolSizes.data(), descriptorPoolSizes.size(),
descriptorSetLayout));
}
return angle::Result::Continue;
}
} // anonymous namespace
// This is an arbitrary max. We can change this later if necessary.
uint32_t DynamicDescriptorPool::mMaxSetsPerPool = 16;
uint32_t DynamicDescriptorPool::mMaxSetsPerPoolMultiplier = 2;
VkImageCreateFlags GetImageCreateFlags(gl::TextureType textureType)
{
switch (textureType)
{
case gl::TextureType::CubeMap:
case gl::TextureType::CubeMapArray:
return VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT;
case gl::TextureType::_3D:
return VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT;
default:
return 0;
}
}
ImageLayout GetImageLayoutFromGLImageLayout(GLenum layout)
{
switch (layout)
{
case GL_NONE:
return ImageLayout::Undefined;
case GL_LAYOUT_GENERAL_EXT:
return ImageLayout::ExternalShadersWrite;
case GL_LAYOUT_COLOR_ATTACHMENT_EXT:
return ImageLayout::ColorAttachment;
case GL_LAYOUT_DEPTH_STENCIL_ATTACHMENT_EXT:
case GL_LAYOUT_DEPTH_STENCIL_READ_ONLY_EXT:
case GL_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_EXT:
case GL_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_EXT:
// Note: once VK_KHR_separate_depth_stencil_layouts becomes core or ubiquitous, we
// should optimize depth/stencil image layout transitions to only be performed on the
// aspect that needs transition. In that case, these four layouts can be distinguished
// and optimized. Note that the exact equivalent of these layouts are specified in
// VK_KHR_maintenance2, which are also usable, granted we transition the pair of
// depth/stencil layouts accordingly elsewhere in ANGLE.
return ImageLayout::DepthStencilAttachment;
case GL_LAYOUT_SHADER_READ_ONLY_EXT:
return ImageLayout::ExternalShadersReadOnly;
case GL_LAYOUT_TRANSFER_SRC_EXT:
return ImageLayout::TransferSrc;
case GL_LAYOUT_TRANSFER_DST_EXT:
return ImageLayout::TransferDst;
default:
UNREACHABLE();
return vk::ImageLayout::Undefined;
}
}
GLenum ConvertImageLayoutToGLImageLayout(ImageLayout layout)
{
switch (kImageMemoryBarrierData[layout].layout)
{
case VK_IMAGE_LAYOUT_UNDEFINED:
return GL_NONE;
case VK_IMAGE_LAYOUT_GENERAL:
return GL_LAYOUT_GENERAL_EXT;
case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
return GL_LAYOUT_COLOR_ATTACHMENT_EXT;
case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
return GL_LAYOUT_DEPTH_STENCIL_ATTACHMENT_EXT;
case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
return GL_LAYOUT_DEPTH_STENCIL_READ_ONLY_EXT;
case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
return GL_LAYOUT_SHADER_READ_ONLY_EXT;
case VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL:
return GL_LAYOUT_TRANSFER_SRC_EXT;
case VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL:
return GL_LAYOUT_TRANSFER_DST_EXT;
case VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL:
return GL_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_EXT;
case VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL:
return GL_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_EXT;
default:
break;
}
UNREACHABLE();
return GL_NONE;
}
VkImageLayout ConvertImageLayoutToVkImageLayout(ImageLayout imageLayout)
{
return kImageMemoryBarrierData[imageLayout].layout;
}
bool FormatHasNecessaryFeature(RendererVk *renderer,
angle::FormatID formatID,
VkImageTiling tilingMode,
VkFormatFeatureFlags featureBits)
{
return (tilingMode == VK_IMAGE_TILING_OPTIMAL)
? renderer->hasImageFormatFeatureBits(formatID, featureBits)
: renderer->hasLinearImageFormatFeatureBits(formatID, featureBits);
}
bool CanCopyWithTransfer(RendererVk *renderer,
angle::FormatID srcFormatID,
VkImageTiling srcTilingMode,
angle::FormatID dstFormatID,
VkImageTiling dstTilingMode)
{
// Checks that the formats in the copy transfer have the appropriate tiling and transfer bits
bool isTilingCompatible = srcTilingMode == dstTilingMode;
bool srcFormatHasNecessaryFeature = FormatHasNecessaryFeature(
renderer, srcFormatID, srcTilingMode, VK_FORMAT_FEATURE_TRANSFER_SRC_BIT);
bool dstFormatHasNecessaryFeature = FormatHasNecessaryFeature(
renderer, dstFormatID, dstTilingMode, VK_FORMAT_FEATURE_TRANSFER_DST_BIT);
return isTilingCompatible && srcFormatHasNecessaryFeature && dstFormatHasNecessaryFeature;
}
// PackedClearValuesArray implementation
PackedClearValuesArray::PackedClearValuesArray() : mValues{} {}
PackedClearValuesArray::~PackedClearValuesArray() = default;
PackedClearValuesArray::PackedClearValuesArray(const PackedClearValuesArray &other) = default;
PackedClearValuesArray &PackedClearValuesArray::operator=(const PackedClearValuesArray &rhs) =
default;
void PackedClearValuesArray::store(PackedAttachmentIndex index,
VkImageAspectFlags aspectFlags,
const VkClearValue &clearValue)
{
ASSERT(aspectFlags != 0);
if (aspectFlags != VK_IMAGE_ASPECT_STENCIL_BIT)
{
storeNoDepthStencil(index, clearValue);
}
}
void PackedClearValuesArray::storeNoDepthStencil(PackedAttachmentIndex index,
const VkClearValue &clearValue)
{
mValues[index.get()] = clearValue;
}
// RenderPassAttachment implementation
RenderPassAttachment::RenderPassAttachment()
{
reset();
}
void RenderPassAttachment::init(ImageHelper *image,
gl::LevelIndex levelIndex,
uint32_t layerIndex,
uint32_t layerCount,
VkImageAspectFlagBits aspect)
{
ASSERT(mImage == nullptr);
mImage = image;
mLevelIndex = levelIndex;
mLayerIndex = layerIndex;
mLayerCount = layerCount;
mAspect = aspect;
mImage->setRenderPassUsageFlag(RenderPassUsage::RenderTargetAttachment);
}
void RenderPassAttachment::reset()
{
mImage = nullptr;
mAccess = ResourceAccess::Unused;
mInvalidatedCmdCount = kInfiniteCmdCount;
mDisabledCmdCount = kInfiniteCmdCount;
mInvalidateArea = gl::Rectangle();
}
void RenderPassAttachment::onAccess(ResourceAccess access, uint32_t currentCmdCount)
{
// Update the access for optimizing this render pass's loadOp
UpdateAccess(&mAccess, access);
// Update the invalidate state for optimizing this render pass's storeOp
if (onAccessImpl(access, currentCmdCount))
{
// The attachment is no longer invalid, so restore its content.
restoreContent();
}
}
void RenderPassAttachment::invalidate(const gl::Rectangle &invalidateArea,
bool isAttachmentEnabled,
uint32_t currentCmdCount)
{
// Keep track of the command count in the render pass at the time of invalidation. If there are
// more commands in the future, invalidate must be undone.
mInvalidatedCmdCount = currentCmdCount;
// Also track the command count if the attachment is currently disabled.
mDisabledCmdCount = isAttachmentEnabled ? kInfiniteCmdCount : currentCmdCount;
// Set/extend the invalidate area.
ExtendRenderPassInvalidateArea(invalidateArea, &mInvalidateArea);
}
void RenderPassAttachment::onRenderAreaGrowth(ContextVk *contextVk,
const gl::Rectangle &newRenderArea)
{
// Remove invalidate if it's no longer applicable.
if (mInvalidateArea.empty() || mInvalidateArea.encloses(newRenderArea))
{
return;
}
ANGLE_VK_PERF_WARNING(contextVk, GL_DEBUG_SEVERITY_LOW,
"InvalidateSubFramebuffer discarded due to increased scissor region");
mInvalidateArea = gl::Rectangle();
mInvalidatedCmdCount = kInfiniteCmdCount;
}
void RenderPassAttachment::finalizeLoadStore(Context *context,
uint32_t currentCmdCount,
bool hasUnresolveAttachment,
RenderPassLoadOp *loadOp,
RenderPassStoreOp *storeOp,
bool *isInvalidatedOut)
{
// Ensure we don't write to a read-only attachment. (ReadOnly -> !Write)
ASSERT(!mImage->hasRenderPassUsageFlag(RenderPassUsage::ReadOnlyAttachment) ||
mAccess != ResourceAccess::Write);
// If the attachment is invalidated, skip the store op. If we are not loading or clearing the
// attachment and the attachment has not been used, auto-invalidate it.
const bool notLoaded = *loadOp == RenderPassLoadOp::DontCare && !hasUnresolveAttachment;
if (isInvalidated(currentCmdCount) || (notLoaded && mAccess != ResourceAccess::Write))
{
*storeOp = RenderPassStoreOp::DontCare;
*isInvalidatedOut = true;
}
else if (hasWriteAfterInvalidate(currentCmdCount))
{
// The attachment was invalidated, but is now valid. Let the image know the contents are
// now defined so a future render pass would use loadOp=LOAD.
restoreContent();
}
// For read only depth stencil, we can use StoreOpNone if available. DontCare is still
// preferred, so do this after handling DontCare.
const bool supportsLoadStoreOpNone =
context->getRenderer()->getFeatures().supportsRenderPassLoadStoreOpNone.enabled;
const bool supportsStoreOpNone =
supportsLoadStoreOpNone ||
context->getRenderer()->getFeatures().supportsRenderPassStoreOpNone.enabled;
if (mAccess == ResourceAccess::ReadOnly && supportsStoreOpNone)
{
if (*storeOp == RenderPassStoreOp::Store && *loadOp != RenderPassLoadOp::Clear)
{
*storeOp = RenderPassStoreOp::None;
}
}
if (mAccess == ResourceAccess::Unused)
{
if (*storeOp != RenderPassStoreOp::DontCare)
{
switch (*loadOp)
{
case RenderPassLoadOp::Clear:
// Cannot optimize away the ops if the attachment is cleared (even if not used
// afterwards)
break;
case RenderPassLoadOp::Load:
// Make sure the attachment is neither loaded nor stored (as it's neither used
// nor invalidated), if possible.
if (supportsLoadStoreOpNone)
{
*loadOp = RenderPassLoadOp::None;
}
if (supportsStoreOpNone)
{
*storeOp = RenderPassStoreOp::None;
}
break;
case RenderPassLoadOp::DontCare:
// loadOp=DontCare should be covered by storeOp=DontCare below.
break;
case RenderPassLoadOp::None:
default:
// loadOp=None is never decided upfront.
UNREACHABLE();
break;
}
}
}
if (mAccess == ResourceAccess::Unused || (mAccess == ResourceAccess::ReadOnly && notLoaded))
{
if (*storeOp == RenderPassStoreOp::DontCare)
{
// If we are loading or clearing the attachment, but the attachment has not been used,
// and the data has also not been stored back into attachment, then just skip the
// load/clear op. If loadOp/storeOp=None is supported, prefer that to reduce the amount
// of synchronization; DontCare is a write operation, while None is not.
if (supportsLoadStoreOpNone)
{
*loadOp = RenderPassLoadOp::None;
*storeOp = RenderPassStoreOp::None;
}
else
{
*loadOp = RenderPassLoadOp::DontCare;
}
}
}
}
void RenderPassAttachment::restoreContent()
{
// Note that the image may have been deleted since the render pass has started.
if (mImage)
{
ASSERT(mImage->valid());
if (mAspect == VK_IMAGE_ASPECT_STENCIL_BIT)
{
mImage->restoreSubresourceStencilContent(mLevelIndex, mLayerIndex, mLayerCount);
}
else
{
mImage->restoreSubresourceContent(mLevelIndex, mLayerIndex, mLayerCount);
}
mInvalidateArea = gl::Rectangle();
}
}
bool RenderPassAttachment::hasWriteAfterInvalidate(uint32_t currentCmdCount) const
{
return (mInvalidatedCmdCount != kInfiniteCmdCount &&
std::min(mDisabledCmdCount, currentCmdCount) != mInvalidatedCmdCount);
}
bool RenderPassAttachment::isInvalidated(uint32_t currentCmdCount) const
{
return mInvalidatedCmdCount != kInfiniteCmdCount &&
std::min(mDisabledCmdCount, currentCmdCount) == mInvalidatedCmdCount;
}
bool RenderPassAttachment::onAccessImpl(ResourceAccess access, uint32_t currentCmdCount)
{
if (mInvalidatedCmdCount == kInfiniteCmdCount)
{
// If never invalidated or no longer invalidated, return early.
return false;
}
if (access == ResourceAccess::Write)
{
// Drawing to this attachment is being enabled. Assume that drawing will immediately occur
// after this attachment is enabled, and that means that the attachment will no longer be
// invalidated.
mInvalidatedCmdCount = kInfiniteCmdCount;
mDisabledCmdCount = kInfiniteCmdCount;
// Return true to indicate that the store op should remain STORE and that mContentDefined
// should be set to true;
return true;
}
// Drawing to this attachment is being disabled.
if (hasWriteAfterInvalidate(currentCmdCount))
{
// The attachment was previously drawn while enabled, and so is no longer invalidated.
mInvalidatedCmdCount = kInfiniteCmdCount;
mDisabledCmdCount = kInfiniteCmdCount;
// Return true to indicate that the store op should remain STORE and that mContentDefined
// should be set to true;
return true;
}
// Use the latest CmdCount at the start of being disabled. At the end of the render pass,
// cmdCountDisabled is <= the actual command count, and so it's compared with
// cmdCountInvalidated. If the same, the attachment is still invalidated.
mDisabledCmdCount = currentCmdCount;
return false;
}
// CommandBufferHelperCommon implementation.
CommandBufferHelperCommon::CommandBufferHelperCommon()
: mPipelineBarriers(),
mPipelineBarrierMask(),
mCommandPool(nullptr),
mHasShaderStorageOutput(false),
mHasGLMemoryBarrierIssued(false),
mResourceUseList()
{}
CommandBufferHelperCommon::~CommandBufferHelperCommon() {}
void CommandBufferHelperCommon::initializeImpl(Context *context, CommandPool *commandPool)
{
ASSERT(mUsedBuffers.empty());
mAllocator.initialize(kDefaultPoolAllocatorPageSize, 1);
// Push a scope into the pool allocator so we can easily free and re-init on reset()
mAllocator.push();
mCommandPool = commandPool;
}
void CommandBufferHelperCommon::resetImpl()
{
mAllocator.pop();
mAllocator.push();
mUsedBuffers.clear();
ASSERT(mResourceUseList.empty());
}
void CommandBufferHelperCommon::bufferRead(ContextVk *contextVk,
VkAccessFlags readAccessType,
PipelineStage readStage,
BufferHelper *buffer)
{
VkPipelineStageFlagBits stageBits = kPipelineStageFlagBitMap[readStage];
if (buffer->recordReadBarrier(readAccessType, stageBits, &mPipelineBarriers[readStage]))
{
mPipelineBarrierMask.set(readStage);
}
ASSERT(!usesBufferForWrite(*buffer));
if (!mUsedBuffers.contains(buffer->getBufferSerial()))
{
mUsedBuffers.insert(buffer->getBufferSerial(), BufferAccess::Read);
buffer->retainReadOnly(&mResourceUseList);
}
}
void CommandBufferHelperCommon::bufferWrite(ContextVk *contextVk,
VkAccessFlags writeAccessType,
PipelineStage writeStage,
AliasingMode aliasingMode,
BufferHelper *buffer)
{
buffer->retainReadWrite(&mResourceUseList);
VkPipelineStageFlagBits stageBits = kPipelineStageFlagBitMap[writeStage];
if (buffer->recordWriteBarrier(writeAccessType, stageBits, &mPipelineBarriers[writeStage]))
{
mPipelineBarrierMask.set(writeStage);
}
// Storage buffers are special. They can alias one another in a shader.
// We support aliasing by not tracking storage buffers. This works well with the GL API
// because storage buffers are required to be externally synchronized.
// Compute / XFB emulation buffers are not allowed to alias.
if (aliasingMode == AliasingMode::Disallowed)
{
ASSERT(!usesBuffer(*buffer));
mUsedBuffers.insert(buffer->getBufferSerial(), BufferAccess::Write);
}
// Make sure host-visible buffer writes result in a barrier inserted at the end of the frame to
// make the results visible to the host. The buffer may be mapped by the application in the
// future.
if (buffer->isHostVisible())
{
contextVk->onHostVisibleBufferWrite();
}
}
bool CommandBufferHelperCommon::usesBuffer(const BufferHelper &buffer) const
{
return mUsedBuffers.contains(buffer.getBufferSerial());
}
bool CommandBufferHelperCommon::usesBufferForWrite(const BufferHelper &buffer) const
{
BufferAccess access;
if (!mUsedBuffers.get(buffer.getBufferSerial(), &access))
{
return false;
}
return access == BufferAccess::Write;
}
void CommandBufferHelperCommon::executeBarriers(const angle::FeaturesVk &features,
PrimaryCommandBuffer *primary)
{
// make a local copy for faster access
PipelineStagesMask mask = mPipelineBarrierMask;
if (mask.none())
{
return;
}
if (features.preferAggregateBarrierCalls.enabled)
{
PipelineStagesMask::Iterator iter = mask.begin();
PipelineBarrier &barrier = mPipelineBarriers[*iter];
for (++iter; iter != mask.end(); ++iter)
{
barrier.merge(&mPipelineBarriers[*iter]);
}
barrier.execute(primary);
}
else
{
for (PipelineStage pipelineStage : mask)
{
PipelineBarrier &barrier = mPipelineBarriers[pipelineStage];
barrier.execute(primary);
}
}
mPipelineBarrierMask.reset();
}
void CommandBufferHelperCommon::imageReadImpl(ContextVk *contextVk,
VkImageAspectFlags aspectFlags,
ImageLayout imageLayout,
ImageHelper *image,
bool *needLayoutTransition)
{
if (image->isReadBarrierNecessary(imageLayout))
{
updateImageLayoutAndBarrier(contextVk, image, aspectFlags, imageLayout);
*needLayoutTransition = true;
}
}
void CommandBufferHelperCommon::imageWriteImpl(ContextVk *contextVk,
gl::LevelIndex level,
uint32_t layerStart,
uint32_t layerCount,
VkImageAspectFlags aspectFlags,
ImageLayout imageLayout,
AliasingMode aliasingMode,
ImageHelper *image)
{
image->retain(&mResourceUseList);
image->onWrite(level, 1, layerStart, layerCount, aspectFlags);
// Write always requires a barrier
updateImageLayoutAndBarrier(contextVk, image, aspectFlags, imageLayout);
}
void CommandBufferHelperCommon::updateImageLayoutAndBarrier(Context *context,
ImageHelper *image,
VkImageAspectFlags aspectFlags,
ImageLayout imageLayout)
{
PipelineStage barrierIndex = kImageMemoryBarrierData[imageLayout].barrierIndex;
ASSERT(barrierIndex != PipelineStage::InvalidEnum);
PipelineBarrier *barrier = &mPipelineBarriers[barrierIndex];
if (image->updateLayoutAndBarrier(context, aspectFlags, imageLayout, barrier))
{
mPipelineBarrierMask.set(barrierIndex);
}
}
void CommandBufferHelperCommon::addCommandDiagnosticsCommon(std::ostringstream *out)
{
*out << "Memory Barrier: ";
for (PipelineBarrier &barrier : mPipelineBarriers)
{
if (!barrier.isEmpty())
{
barrier.addDiagnosticsString(*out);
}
}
*out << "\\l";
}
void CommandBufferHelperCommon::retainResource(Resource *resource)
{
resource->retain(&mResourceUseList);
}
void CommandBufferHelperCommon::retainReadOnlyResource(ReadWriteResource *readWriteResource)
{
readWriteResource->retainReadOnly(&mResourceUseList);
}
void CommandBufferHelperCommon::retainReadWriteResource(ReadWriteResource *readWriteResource)
{
readWriteResource->retainReadWrite(&mResourceUseList);
}
// OutsideRenderPassCommandBufferHelper implementation.
OutsideRenderPassCommandBufferHelper::OutsideRenderPassCommandBufferHelper() {}
OutsideRenderPassCommandBufferHelper::~OutsideRenderPassCommandBufferHelper() {}
angle::Result OutsideRenderPassCommandBufferHelper::initialize(Context *context,
CommandPool *commandPool)
{
initializeImpl(context, commandPool);
return initializeCommandBuffer(context);
}
angle::Result OutsideRenderPassCommandBufferHelper::initializeCommandBuffer(Context *context)
{
return mCommandBuffer.initialize(context, mCommandPool, false, &mAllocator);
}
angle::Result OutsideRenderPassCommandBufferHelper::reset(Context *context)
{
resetImpl();
// Reset and re-initialize the command buffer
context->getRenderer()->resetOutsideRenderPassCommandBuffer(std::move(mCommandBuffer));
return initializeCommandBuffer(context);
}
void OutsideRenderPassCommandBufferHelper::imageRead(ContextVk *contextVk,
VkImageAspectFlags aspectFlags,
ImageLayout imageLayout,
ImageHelper *image)
{
bool needLayoutTransition = false;
imageReadImpl(contextVk, aspectFlags, imageLayout, image, &needLayoutTransition);
image->retain(&mResourceUseList);
}
void OutsideRenderPassCommandBufferHelper::imageWrite(ContextVk *contextVk,
gl::LevelIndex level,
uint32_t layerStart,
uint32_t layerCount,
VkImageAspectFlags aspectFlags,
ImageLayout imageLayout,
AliasingMode aliasingMode,
ImageHelper *image)
{
imageWriteImpl(contextVk, level, layerStart, layerCount, aspectFlags, imageLayout, aliasingMode,
image);
}
angle::Result OutsideRenderPassCommandBufferHelper::flushToPrimary(Context *context,
PrimaryCommandBuffer *primary)
{
ANGLE_TRACE_EVENT0("gpu.angle", "OutsideRenderPassCommandBufferHelper::flushToPrimary");
ASSERT(!empty());
// Commands that are added to primary before beginRenderPass command
executeBarriers(context->getRenderer()->getFeatures(), primary);
ANGLE_TRY(mCommandBuffer.end(context));
mCommandBuffer.executeCommands(primary);
// Restart the command buffer.
return reset(context);
}
void OutsideRenderPassCommandBufferHelper::addCommandDiagnostics(ContextVk *contextVk)
{
std::ostringstream out;
addCommandDiagnosticsCommon(&out);
out << mCommandBuffer.dumpCommands("\\l");
contextVk->addCommandBufferDiagnostics(out.str());
}
// RenderPassCommandBufferHelper implementation.
RenderPassCommandBufferHelper::RenderPassCommandBufferHelper()
: mCurrentSubpass(0),
mCounter(0),
mClearValues{},
mRenderPassStarted(false),
mTransformFeedbackCounterBuffers{},
mTransformFeedbackCounterBufferOffsets{},
mValidTransformFeedbackBufferCount(0),
mRebindTransformFeedbackBuffers(false),
mIsTransformFeedbackActiveUnpaused(false),
mPreviousSubpassesCmdCount(0),
mDepthStencilAttachmentIndex(kAttachmentIndexInvalid),
mColorAttachmentsCount(0),
mImageOptimizeForPresent(nullptr)
{}
RenderPassCommandBufferHelper::~RenderPassCommandBufferHelper()
{
mFramebuffer.setHandle(VK_NULL_HANDLE);
}
angle::Result RenderPassCommandBufferHelper::initialize(Context *context, CommandPool *commandPool)
{
initializeImpl(context, commandPool);
return initializeCommandBuffer(context);
}
angle::Result RenderPassCommandBufferHelper::initializeCommandBuffer(Context *context)
{
return getCommandBuffer().initialize(context, mCommandPool, true, &mAllocator);
}
angle::Result RenderPassCommandBufferHelper::reset(Context *context)
{
resetImpl();
for (PackedAttachmentIndex index = kAttachmentIndexZero; index < mColorAttachmentsCount;
++index)
{
mColorAttachments[index].reset();
mColorResolveAttachments[index].reset();
}
mDepthAttachment.reset();
mDepthResolveAttachment.reset();
mStencilAttachment.reset();
mStencilResolveAttachment.reset();
mRenderPassStarted = false;
mValidTransformFeedbackBufferCount = 0;
mRebindTransformFeedbackBuffers = false;
mHasShaderStorageOutput = false;
mHasGLMemoryBarrierIssued = false;
mPreviousSubpassesCmdCount = 0;
mColorAttachmentsCount = PackedAttachmentCount(0);
mDepthStencilAttachmentIndex = kAttachmentIndexInvalid;
mRenderPassUsedImages.clear();
mRenderPassImagesWithLayoutTransition.clear();
mImageOptimizeForPresent = nullptr;
// Reset and re-initialize the command buffers
for (uint32_t subpass = 0; subpass <= mCurrentSubpass; ++subpass)
{
context->getRenderer()->resetRenderPassCommandBuffer(std::move(mCommandBuffers[subpass]));
}
mCurrentSubpass = 0;
return initializeCommandBuffer(context);
}
void RenderPassCommandBufferHelper::imageRead(ContextVk *contextVk,
VkImageAspectFlags aspectFlags,
ImageLayout imageLayout,
ImageHelper *image)
{
bool needLayoutTransition = false;
imageReadImpl(contextVk, aspectFlags, imageLayout, image, &needLayoutTransition);
if (needLayoutTransition && !isImageWithLayoutTransition(*image))
{
mRenderPassImagesWithLayoutTransition.insert(image->getImageSerial());
}
// As noted in the header we don't support multiple read layouts for Images.
// We allow duplicate uses in the RP to accommodate for normal GL sampler usage.
if (!usesImage(*image))
{
mRenderPassUsedImages.insert(image->getImageSerial());
image->retain(&mResourceUseList);
}
}
void RenderPassCommandBufferHelper::imageWrite(ContextVk *contextVk,
gl::LevelIndex level,
uint32_t layerStart,
uint32_t layerCount,
VkImageAspectFlags aspectFlags,
ImageLayout imageLayout,
AliasingMode aliasingMode,
ImageHelper *image)
{
imageWriteImpl(contextVk, level, layerStart, layerCount, aspectFlags, imageLayout, aliasingMode,
image);
if (!isImageWithLayoutTransition(*image))
{
mRenderPassImagesWithLayoutTransition.insert(image->getImageSerial());
}
// When used as a storage image we allow for aliased writes.
if (aliasingMode == AliasingMode::Disallowed)
{
ASSERT(!usesImage(*image));
}
if (!usesImage(*image))
{
mRenderPassUsedImages.insert(image->getImageSerial());
}
}
void RenderPassCommandBufferHelper::colorImagesDraw(gl::LevelIndex level,
uint32_t layerStart,
uint32_t layerCount,
ImageHelper *image,
ImageHelper *resolveImage,
PackedAttachmentIndex packedAttachmentIndex)
{
ASSERT(packedAttachmentIndex < mColorAttachmentsCount);
image->retain(&mResourceUseList);
if (!usesImage(*image))
{
// This is possible due to different layers of the same texture being attached to different
// attachments
mRenderPassUsedImages.insert(image->getImageSerial());
}
mColorAttachments[packedAttachmentIndex].init(image, level, layerStart, layerCount,
VK_IMAGE_ASPECT_COLOR_BIT);
if (resolveImage)
{
resolveImage->retain(&mResourceUseList);
if (!usesImage(*resolveImage))
{
mRenderPassUsedImages.insert(resolveImage->getImageSerial());
}
mColorResolveAttachments[packedAttachmentIndex].init(resolveImage, level, layerStart,
layerCount, VK_IMAGE_ASPECT_COLOR_BIT);
}
}
void RenderPassCommandBufferHelper::depthStencilImagesDraw(gl::LevelIndex level,
uint32_t layerStart,
uint32_t layerCount,
ImageHelper *image,
ImageHelper *resolveImage)
{
ASSERT(!usesImage(*image));
ASSERT(!resolveImage || !usesImage(*resolveImage));
// Because depthStencil buffer's read/write property can change while we build renderpass, we
// defer the image layout changes until endRenderPass time or when images going away so that we
// only insert layout change barrier once.
image->retain(&mResourceUseList);
mRenderPassUsedImages.insert(image->getImageSerial());
mDepthAttachment.init(image, level, layerStart, layerCount, VK_IMAGE_ASPECT_DEPTH_BIT);
mStencilAttachment.init(image, level, layerStart, layerCount, VK_IMAGE_ASPECT_STENCIL_BIT);
if (resolveImage)
{
// Note that the resolve depth/stencil image has the same level/layer index as the
// depth/stencil image as currently it can only ever come from
// multisampled-render-to-texture renderbuffers.
resolveImage->retain(&mResourceUseList);
mRenderPassUsedImages.insert(resolveImage->getImageSerial());
mDepthResolveAttachment.init(resolveImage, level, layerStart, layerCount,
VK_IMAGE_ASPECT_DEPTH_BIT);
mStencilResolveAttachment.init(resolveImage, level, layerStart, layerCount,
VK_IMAGE_ASPECT_STENCIL_BIT);
}
}
void RenderPassCommandBufferHelper::onColorAccess(PackedAttachmentIndex packedAttachmentIndex,
ResourceAccess access)
{
ASSERT(packedAttachmentIndex < mColorAttachmentsCount);
mColorAttachments[packedAttachmentIndex].onAccess(access, getRenderPassWriteCommandCount());
}
void RenderPassCommandBufferHelper::onDepthAccess(ResourceAccess access)
{
mDepthAttachment.onAccess(access, getRenderPassWriteCommandCount());
}
void RenderPassCommandBufferHelper::onStencilAccess(ResourceAccess access)
{
mStencilAttachment.onAccess(access, getRenderPassWriteCommandCount());
}
void RenderPassCommandBufferHelper::updateStartedRenderPassWithDepthMode(
bool readOnlyDepthStencilMode)
{
ASSERT(mRenderPassStarted);
ASSERT(mDepthAttachment.getImage() == mStencilAttachment.getImage());
ASSERT(mDepthResolveAttachment.getImage() == mStencilResolveAttachment.getImage());
ImageHelper *depthStencilImage = mDepthAttachment.getImage();
ImageHelper *depthStencilResolveImage = mDepthResolveAttachment.getImage();
if (depthStencilImage)
{
if (readOnlyDepthStencilMode)
{
depthStencilImage->setRenderPassUsageFlag(RenderPassUsage::ReadOnlyAttachment);
}
else
{
depthStencilImage->clearRenderPassUsageFlag(RenderPassUsage::ReadOnlyAttachment);
}
if (depthStencilResolveImage)
{
if (readOnlyDepthStencilMode)
{
depthStencilResolveImage->setRenderPassUsageFlag(
RenderPassUsage::ReadOnlyAttachment);
}
else
{
depthStencilResolveImage->clearRenderPassUsageFlag(
RenderPassUsage::ReadOnlyAttachment);
}
}
}
}
void RenderPassCommandBufferHelper::finalizeColorImageLayout(
Context *context,
ImageHelper *image,
PackedAttachmentIndex packedAttachmentIndex,
bool isResolveImage)
{
ASSERT(packedAttachmentIndex < mColorAttachmentsCount);
ASSERT(image != nullptr);
// Do layout change.
ImageLayout imageLayout;
if (image->usedByCurrentRenderPassAsAttachmentAndSampler())
{
// texture code already picked layout and inserted barrier
imageLayout = image->getCurrentImageLayout();
ASSERT(imageLayout == ImageLayout::ColorAttachmentAndFragmentShaderRead ||
imageLayout == ImageLayout::ColorAttachmentAndAllShadersRead);
}
else
{
imageLayout = ImageLayout::ColorAttachment;
updateImageLayoutAndBarrier(context, image, VK_IMAGE_ASPECT_COLOR_BIT, imageLayout);
}
if (!isResolveImage)
{
mAttachmentOps.setLayouts(packedAttachmentIndex, imageLayout, imageLayout);
}
if (mImageOptimizeForPresent == image)
{
ASSERT(packedAttachmentIndex == kAttachmentIndexZero);
// Use finalLayout instead of extra barrier for layout change to present
mImageOptimizeForPresent->setCurrentImageLayout(ImageLayout::Present);
// TODO(syoussefi): We currently don't store the layout of the resolve attachments, so once
// multisampled backbuffers are optimized to use resolve attachments, this information needs
// to be stored somewhere. http://anglebug.com/7150
SetBitField(mAttachmentOps[packedAttachmentIndex].finalLayout,
mImageOptimizeForPresent->getCurrentImageLayout());
mImageOptimizeForPresent = nullptr;
}
if (isResolveImage)
{
// Note: the color image will have its flags reset after load/store ops are determined.
image->resetRenderPassUsageFlags();
}
}
void RenderPassCommandBufferHelper::finalizeColorImageLoadStore(
Context *context,
PackedAttachmentIndex packedAttachmentIndex)
{
PackedAttachmentOpsDesc &ops = mAttachmentOps[packedAttachmentIndex];
RenderPassLoadOp loadOp = static_cast<RenderPassLoadOp>(ops.loadOp);
RenderPassStoreOp storeOp = static_cast<RenderPassStoreOp>(ops.storeOp);
// This has to be called after layout been finalized
ASSERT(ops.initialLayout != static_cast<uint16_t>(ImageLayout::Undefined));
uint32_t currentCmdCount = getRenderPassWriteCommandCount();
bool isInvalidated = false;
RenderPassAttachment &colorAttachment = mColorAttachments[packedAttachmentIndex];
colorAttachment.finalizeLoadStore(context, currentCmdCount,
mRenderPassDesc.getColorUnresolveAttachmentMask().any(),
&loadOp, &storeOp, &isInvalidated);
if (isInvalidated)
{
ops.isInvalidated = true;
}
if (!ops.isInvalidated)
{
mColorResolveAttachments[packedAttachmentIndex].restoreContent();
}
// If the image is being written to, mark its contents defined.
// This has to be done after storeOp has been finalized.
if (storeOp == RenderPassStoreOp::Store)
{
colorAttachment.restoreContent();
}
SetBitField(ops.loadOp, loadOp);
SetBitField(ops.storeOp, storeOp);
}
void RenderPassCommandBufferHelper::finalizeDepthStencilImageLayout(Context *context)
{
ASSERT(mDepthAttachment.getImage() != nullptr);
ASSERT(mDepthAttachment.getImage() == mStencilAttachment.getImage());
ImageHelper *depthStencilImage = mDepthAttachment.getImage();
// Do depth stencil layout change.
ImageLayout imageLayout;
bool barrierRequired;
if (depthStencilImage->usedByCurrentRenderPassAsAttachmentAndSampler())
{
// texture code already picked layout and inserted barrier
imageLayout = depthStencilImage->getCurrentImageLayout();
if (depthStencilImage->hasRenderPassUsageFlag(RenderPassUsage::ReadOnlyAttachment))
{
ASSERT(imageLayout == ImageLayout::DSAttachmentReadAndFragmentShaderRead ||
imageLayout == ImageLayout::DSAttachmentReadAndAllShadersRead);
barrierRequired = depthStencilImage->isReadBarrierNecessary(imageLayout);
}
else
{
ASSERT(imageLayout == ImageLayout::DSAttachmentWriteAndFragmentShaderRead ||
imageLayout == ImageLayout::DSAttachmentWriteAndAllShadersRead);
barrierRequired = true;
}
}
else if (depthStencilImage->hasRenderPassUsageFlag(RenderPassUsage::ReadOnlyAttachment))
{
imageLayout = ImageLayout::DepthStencilAttachmentReadOnly;
barrierRequired = depthStencilImage->isReadBarrierNecessary(imageLayout);
}
else
{
// Write always requires a barrier
imageLayout = ImageLayout::DepthStencilAttachment;
barrierRequired = true;
}
mAttachmentOps.setLayouts(mDepthStencilAttachmentIndex, imageLayout, imageLayout);
if (barrierRequired)
{
const angle::Format &format = depthStencilImage->getActualFormat();
ASSERT(format.hasDepthOrStencilBits());
VkImageAspectFlags aspectFlags = GetDepthStencilAspectFlags(format);
updateImageLayoutAndBarrier(context, depthStencilImage, aspectFlags, imageLayout);
}
}
void RenderPassCommandBufferHelper::finalizeDepthStencilResolveImageLayout(Context *context)
{
ASSERT(mDepthResolveAttachment.getImage() != nullptr);
ASSERT(mDepthResolveAttachment.getImage() == mStencilResolveAttachment.getImage());
ImageHelper *depthStencilResolveImage = mDepthResolveAttachment.getImage();
ASSERT(!depthStencilResolveImage->hasRenderPassUsageFlag(RenderPassUsage::ReadOnlyAttachment));
ImageLayout imageLayout = ImageLayout::DepthStencilResolveAttachment;
const angle::Format &format = depthStencilResolveImage->getActualFormat();
ASSERT(format.hasDepthOrStencilBits());
VkImageAspectFlags aspectFlags = GetDepthStencilAspectFlags(format);
updateImageLayoutAndBarrier(context, depthStencilResolveImage, aspectFlags, imageLayout);
if (!depthStencilResolveImage->hasRenderPassUsageFlag(RenderPassUsage::ReadOnlyAttachment))
{
ASSERT(mDepthStencilAttachmentIndex != kAttachmentIndexInvalid);
const PackedAttachmentOpsDesc &dsOps = mAttachmentOps[mDepthStencilAttachmentIndex];
// If the image is being written to, mark its contents defined.
if (!dsOps.isInvalidated)
{
mDepthResolveAttachment.restoreContent();
}
if (!dsOps.isStencilInvalidated)
{
mStencilResolveAttachment.restoreContent();
}
}
depthStencilResolveImage->resetRenderPassUsageFlags();
}
void RenderPassCommandBufferHelper::finalizeImageLayout(Context *context, const ImageHelper *image)
{
if (image->hasRenderPassUsageFlag(RenderPassUsage::RenderTargetAttachment))
{
for (PackedAttachmentIndex index = kAttachmentIndexZero; index < mColorAttachmentsCount;
++index)
{
if (mColorAttachments[index].getImage() == image)
{
finalizeColorImageLayoutAndLoadStore(context, index);
mColorAttachments[index].reset();
}
else if (mColorResolveAttachments[index].getImage() == image)
{
finalizeColorImageLayout(context, mColorResolveAttachments[index].getImage(), index,
true);
mColorResolveAttachments[index].reset();
}
}
}
if (mDepthAttachment.getImage() == image)
{
finalizeDepthStencilImageLayoutAndLoadStore(context);
mDepthAttachment.reset();
mStencilAttachment.reset();
}
if (mDepthResolveAttachment.getImage() == image)
{
finalizeDepthStencilResolveImageLayout(context);
mDepthResolveAttachment.reset();
mStencilResolveAttachment.reset();
}
}
void RenderPassCommandBufferHelper::finalizeDepthStencilLoadStore(Context *context)
{
ASSERT(mDepthStencilAttachmentIndex != kAttachmentIndexInvalid);
PackedAttachmentOpsDesc &dsOps = mAttachmentOps[mDepthStencilAttachmentIndex];
RenderPassLoadOp depthLoadOp = static_cast<RenderPassLoadOp>(dsOps.loadOp);
RenderPassStoreOp depthStoreOp = static_cast<RenderPassStoreOp>(dsOps.storeOp);
RenderPassLoadOp stencilLoadOp = static_cast<RenderPassLoadOp>(dsOps.stencilLoadOp);
RenderPassStoreOp stencilStoreOp = static_cast<RenderPassStoreOp>(dsOps.stencilStoreOp);
// This has to be called after layout been finalized
ASSERT(dsOps.initialLayout != static_cast<uint16_t>(ImageLayout::Undefined));
uint32_t currentCmdCount = getRenderPassWriteCommandCount();
bool isDepthInvalidated = false;
bool isStencilInvalidated = false;
mDepthAttachment.finalizeLoadStore(context, currentCmdCount,
mRenderPassDesc.hasDepthUnresolveAttachment(), &depthLoadOp,
&depthStoreOp, &isDepthInvalidated);
mStencilAttachment.finalizeLoadStore(context, currentCmdCount,
mRenderPassDesc.hasStencilUnresolveAttachment(),
&stencilLoadOp, &stencilStoreOp, &isStencilInvalidated);
if (isDepthInvalidated)
{
dsOps.isInvalidated = true;
}
if (isStencilInvalidated)
{
dsOps.isStencilInvalidated = true;
}
// This has to be done after storeOp has been finalized.
ASSERT(mDepthAttachment.getImage() == mStencilAttachment.getImage());
if (!mDepthAttachment.getImage()->hasRenderPassUsageFlag(RenderPassUsage::ReadOnlyAttachment))
{
// If the image is being written to, mark its contents defined.
if (depthStoreOp == RenderPassStoreOp::Store)
{
mDepthAttachment.restoreContent();
}
if (stencilStoreOp == RenderPassStoreOp::Store)
{
mStencilAttachment.restoreContent();
}
}
SetBitField(dsOps.loadOp, depthLoadOp);
SetBitField(dsOps.storeOp, depthStoreOp);
SetBitField(dsOps.stencilLoadOp, stencilLoadOp);
SetBitField(dsOps.stencilStoreOp, stencilStoreOp);
}
void RenderPassCommandBufferHelper::finalizeColorImageLayoutAndLoadStore(
Context *context,
PackedAttachmentIndex packedAttachmentIndex)
{
finalizeColorImageLayout(context, mColorAttachments[packedAttachmentIndex].getImage(),
packedAttachmentIndex, false);
finalizeColorImageLoadStore(context, packedAttachmentIndex);
mColorAttachments[packedAttachmentIndex].getImage()->resetRenderPassUsageFlags();
}
void RenderPassCommandBufferHelper::finalizeDepthStencilImageLayoutAndLoadStore(Context *context)
{
finalizeDepthStencilImageLayout(context);
finalizeDepthStencilLoadStore(context);
ASSERT(mDepthAttachment.getImage() == mStencilAttachment.getImage());
mDepthAttachment.getImage()->resetRenderPassUsageFlags();
}
angle::Result RenderPassCommandBufferHelper::beginRenderPass(
ContextVk *contextVk,
const Framebuffer &framebuffer,
const gl::Rectangle &renderArea,
const RenderPassDesc &renderPassDesc,
const AttachmentOpsArray &renderPassAttachmentOps,
const PackedAttachmentCount colorAttachmentCount,
const PackedAttachmentIndex depthStencilAttachmentIndex,
const PackedClearValuesArray &clearValues,
RenderPassCommandBuffer **commandBufferOut)
{
ASSERT(!mRenderPassStarted);
mRenderPassDesc = renderPassDesc;
mAttachmentOps = renderPassAttachmentOps;
mDepthStencilAttachmentIndex = depthStencilAttachmentIndex;
mColorAttachmentsCount = colorAttachmentCount;
mFramebuffer.setHandle(framebuffer.getHandle());
mRenderArea = renderArea;
mClearValues = clearValues;
*commandBufferOut = &getCommandBuffer();
mRenderPassStarted = true;
mCounter++;
return beginRenderPassCommandBuffer(contextVk);
}
angle::Result RenderPassCommandBufferHelper::beginRenderPassCommandBuffer(ContextVk *contextVk)
{
VkCommandBufferInheritanceInfo inheritanceInfo = {};
ANGLE_TRY(RenderPassCommandBuffer::InitializeRenderPassInheritanceInfo(
contextVk, mFramebuffer, mRenderPassDesc, &inheritanceInfo));
inheritanceInfo.subpass = mCurrentSubpass;
return getCommandBuffer().begin(contextVk, inheritanceInfo);
}
angle::Result RenderPassCommandBufferHelper::endRenderPass(ContextVk *contextVk)
{
ANGLE_TRY(endRenderPassCommandBuffer(contextVk));
for (PackedAttachmentIndex index = kAttachmentIndexZero; index < mColorAttachmentsCount;
++index)
{
if (mColorAttachments[index].getImage() != nullptr)
{
finalizeColorImageLayoutAndLoadStore(contextVk, index);
}
if (mColorResolveAttachments[index].getImage() != nullptr)
{
finalizeColorImageLayout(contextVk, mColorResolveAttachments[index].getImage(), index,
true);
}
}
if (mDepthStencilAttachmentIndex == kAttachmentIndexInvalid)
{
return angle::Result::Continue;
}
// Do depth stencil layout change and load store optimization.
ASSERT(mDepthAttachment.getImage() == mStencilAttachment.getImage());
ASSERT(mDepthResolveAttachment.getImage() == mStencilResolveAttachment.getImage());
if (mDepthAttachment.getImage() != nullptr)
{
finalizeDepthStencilImageLayoutAndLoadStore(contextVk);
}
if (mDepthResolveAttachment.getImage() != nullptr)
{
finalizeDepthStencilResolveImageLayout(contextVk);
}
return angle::Result::Continue;
}
angle::Result RenderPassCommandBufferHelper::endRenderPassCommandBuffer(ContextVk *contextVk)
{
return getCommandBuffer().end(contextVk);
}
angle::Result RenderPassCommandBufferHelper::nextSubpass(ContextVk *contextVk,
RenderPassCommandBuffer **commandBufferOut)
{
if (RenderPassCommandBuffer::ExecutesInline())
{
// When using ANGLE secondary command buffers, the commands are inline and are executed on
// the primary command buffer. This means that vkCmdNextSubpass can be intermixed with the
// rest of the commands, and there is no need to split command buffers.
//
// Note also that the command buffer handle doesn't change in this case.
getCommandBuffer().nextSubpass(VK_SUBPASS_CONTENTS_INLINE);
return angle::Result::Continue;
}
// When using Vulkan secondary command buffers, each subpass's contents must be recorded in a
// separate command buffer that is vkCmdExecuteCommands'ed in the primary command buffer.
// vkCmdNextSubpass calls must also be issued in the primary command buffer.
//
// To support this, a list of command buffers are kept, one for each subpass. When moving to
// the next subpass, the previous command buffer is ended and a new one is initialized and
// begun.
// Accumulate command count for tracking purposes.
mPreviousSubpassesCmdCount = getRenderPassWriteCommandCount();
ANGLE_TRY(endRenderPassCommandBuffer(contextVk));
markClosed();
++mCurrentSubpass;
ASSERT(mCurrentSubpass < kMaxSubpassCount);
ANGLE_TRY(initializeCommandBuffer(contextVk));
ANGLE_TRY(beginRenderPassCommandBuffer(contextVk));
markOpen();
// Return the new command buffer handle
*commandBufferOut = &getCommandBuffer();
return angle::Result::Continue;
}
void RenderPassCommandBufferHelper::beginTransformFeedback(size_t validBufferCount,
const VkBuffer *counterBuffers,
const VkDeviceSize *counterBufferOffsets,
bool rebindBuffers)
{
mValidTransformFeedbackBufferCount = static_cast<uint32_t>(validBufferCount);
mRebindTransformFeedbackBuffers = rebindBuffers;
for (size_t index = 0; index < validBufferCount; index++)
{
mTransformFeedbackCounterBuffers[index] = counterBuffers[index];
mTransformFeedbackCounterBufferOffsets[index] = counterBufferOffsets[index];
}
}
void RenderPassCommandBufferHelper::endTransformFeedback()
{
pauseTransformFeedback();
mValidTransformFeedbackBufferCount = 0;
}
void RenderPassCommandBufferHelper::invalidateRenderPassColorAttachment(
const gl::State &state,
size_t colorIndexGL,
PackedAttachmentIndex attachmentIndex,
const gl::Rectangle &invalidateArea)
{
// Color write is enabled if:
//
// - Draw buffer is enabled (this is implicit, as invalidate only affects enabled draw buffers)
// - Color output is not entirely masked
// - Rasterizer-discard is not enabled
const gl::BlendStateExt &blendStateExt = state.getBlendStateExt();
const bool isColorWriteEnabled =
blendStateExt.getColorMaskIndexed(colorIndexGL) != 0 && state.isRasterizerDiscardEnabled();
mColorAttachments[attachmentIndex].invalidate(invalidateArea, isColorWriteEnabled,
getRenderPassWriteCommandCount());
}
void RenderPassCommandBufferHelper::invalidateRenderPassDepthAttachment(
const gl::DepthStencilState &dsState,
const gl::Rectangle &invalidateArea)
{
const bool isDepthWriteEnabled = dsState.depthTest && dsState.depthMask;
mDepthAttachment.invalidate(invalidateArea, isDepthWriteEnabled,
getRenderPassWriteCommandCount());
}
void RenderPassCommandBufferHelper::invalidateRenderPassStencilAttachment(
const gl::DepthStencilState &dsState,
const gl::Rectangle &invalidateArea)
{
const bool isStencilWriteEnabled =
dsState.stencilTest && (!dsState.isStencilNoOp() || !dsState.isStencilBackNoOp());
mStencilAttachment.invalidate(invalidateArea, isStencilWriteEnabled,
getRenderPassWriteCommandCount());
}
angle::Result RenderPassCommandBufferHelper::flushToPrimary(Context *context,
PrimaryCommandBuffer *primary,
const RenderPass *renderPass)
{
ANGLE_TRACE_EVENT0("gpu.angle", "RenderPassCommandBufferHelper::flushToPrimary");
ASSERT(mRenderPassStarted);
// Commands that are added to primary before beginRenderPass command
executeBarriers(context->getRenderer()->getFeatures(), primary);
ASSERT(renderPass != nullptr);
VkRenderPassBeginInfo beginInfo = {};
beginInfo.sType = VK_STRUCTURE_TYPE_RENDER_PASS_BEGIN_INFO;
beginInfo.renderPass = renderPass->getHandle();
beginInfo.framebuffer = mFramebuffer.getHandle();
beginInfo.renderArea.offset.x = static_cast<uint32_t>(mRenderArea.x);
beginInfo.renderArea.offset.y = static_cast<uint32_t>(mRenderArea.y);
beginInfo.renderArea.extent.width = static_cast<uint32_t>(mRenderArea.width);
beginInfo.renderArea.extent.height = static_cast<uint32_t>(mRenderArea.height);
beginInfo.clearValueCount = static_cast<uint32_t>(mRenderPassDesc.attachmentCount());
beginInfo.pClearValues = mClearValues.data();
// Run commands inside the RenderPass.
constexpr VkSubpassContents kSubpassContents =
RenderPassCommandBuffer::ExecutesInline() ? VK_SUBPASS_CONTENTS_INLINE
: VK_SUBPASS_CONTENTS_SECONDARY_COMMAND_BUFFERS;
primary->beginRenderPass(beginInfo, kSubpassContents);
for (uint32_t subpass = 0; subpass <= mCurrentSubpass; ++subpass)
{
if (subpass > 0)
{
primary->nextSubpass(kSubpassContents);
}
mCommandBuffers[subpass].executeCommands(primary);
}
primary->endRenderPass();
// Restart the command buffer.
return reset(context);
}
void RenderPassCommandBufferHelper::updateRenderPassForResolve(ContextVk *contextVk,
Framebuffer *newFramebuffer,
const RenderPassDesc &renderPassDesc)
{
ASSERT(newFramebuffer);
mFramebuffer.setHandle(newFramebuffer->getHandle());
mRenderPassDesc = renderPassDesc;
}
void RenderPassCommandBufferHelper::resumeTransformFeedback()
{
ASSERT(isTransformFeedbackStarted());
uint32_t numCounterBuffers =
mRebindTransformFeedbackBuffers ? 0 : mValidTransformFeedbackBufferCount;
mRebindTransformFeedbackBuffers = false;
mIsTransformFeedbackActiveUnpaused = true;
getCommandBuffer().beginTransformFeedback(0, numCounterBuffers,
mTransformFeedbackCounterBuffers.data(),
mTransformFeedbackCounterBufferOffsets.data());
}
void RenderPassCommandBufferHelper::pauseTransformFeedback()
{
ASSERT(isTransformFeedbackStarted() && isTransformFeedbackActiveUnpaused());
mIsTransformFeedbackActiveUnpaused = false;
getCommandBuffer().endTransformFeedback(0, mValidTransformFeedbackBufferCount,
mTransformFeedbackCounterBuffers.data(),
mTransformFeedbackCounterBufferOffsets.data());
}
void RenderPassCommandBufferHelper::updateRenderPassColorClear(PackedAttachmentIndex colorIndexVk,
const VkClearValue &clearValue)
{
mAttachmentOps.setClearOp(colorIndexVk);
mClearValues.store(colorIndexVk, VK_IMAGE_ASPECT_COLOR_BIT, clearValue);
}
void RenderPassCommandBufferHelper::updateRenderPassDepthStencilClear(
VkImageAspectFlags aspectFlags,
const VkClearValue &clearValue)
{
// Don't overwrite prior clear values for individual aspects.
VkClearValue combinedClearValue = mClearValues[mDepthStencilAttachmentIndex];
if ((aspectFlags & VK_IMAGE_ASPECT_DEPTH_BIT) != 0)
{
mAttachmentOps.setClearOp(mDepthStencilAttachmentIndex);
combinedClearValue.depthStencil.depth = clearValue.depthStencil.depth;
}
if ((aspectFlags & VK_IMAGE_ASPECT_STENCIL_BIT) != 0)
{
mAttachmentOps.setClearStencilOp(mDepthStencilAttachmentIndex);
combinedClearValue.depthStencil.stencil = clearValue.depthStencil.stencil;
}
// Bypass special D/S handling. This clear values array stores values packed.
mClearValues.storeNoDepthStencil(mDepthStencilAttachmentIndex, combinedClearValue);
}
void RenderPassCommandBufferHelper::growRenderArea(ContextVk *contextVk,
const gl::Rectangle &newRenderArea)
{
// The render area is grown such that it covers both the previous and the new render areas.
gl::GetEnclosingRectangle(mRenderArea, newRenderArea, &mRenderArea);
// Remove invalidates that are no longer applicable.
mDepthAttachment.onRenderAreaGrowth(contextVk, mRenderArea);
mStencilAttachment.onRenderAreaGrowth(contextVk, mRenderArea);
}
void RenderPassCommandBufferHelper::addCommandDiagnostics(ContextVk *contextVk)
{
std::ostringstream out;
addCommandDiagnosticsCommon(&out);
size_t attachmentCount = mRenderPassDesc.attachmentCount();
size_t depthStencilAttachmentCount = mRenderPassDesc.hasDepthStencilAttachment() ? 1 : 0;
size_t colorAttachmentCount = attachmentCount - depthStencilAttachmentCount;
PackedAttachmentIndex attachmentIndexVk(0);
std::string loadOps, storeOps;
if (colorAttachmentCount > 0)
{
loadOps += " Color: ";
storeOps += " Color: ";
for (size_t i = 0; i < colorAttachmentCount; ++i)
{
loadOps += GetLoadOpShorthand(
static_cast<RenderPassLoadOp>(mAttachmentOps[attachmentIndexVk].loadOp));
storeOps += GetStoreOpShorthand(
static_cast<RenderPassStoreOp>(mAttachmentOps[attachmentIndexVk].storeOp));
++attachmentIndexVk;
}
}
if (depthStencilAttachmentCount > 0)
{
ASSERT(depthStencilAttachmentCount == 1);
loadOps += " Depth/Stencil: ";
storeOps += " Depth/Stencil: ";
loadOps += GetLoadOpShorthand(
static_cast<RenderPassLoadOp>(mAttachmentOps[attachmentIndexVk].loadOp));
loadOps += GetLoadOpShorthand(
static_cast<RenderPassLoadOp>(mAttachmentOps[attachmentIndexVk].stencilLoadOp));
storeOps += GetStoreOpShorthand(
static_cast<RenderPassStoreOp>(mAttachmentOps[attachmentIndexVk].storeOp));
storeOps += GetStoreOpShorthand(
static_cast<RenderPassStoreOp>(mAttachmentOps[attachmentIndexVk].stencilStoreOp));
}
if (attachmentCount > 0)
{
out << "LoadOp: " << loadOps << "\\l";
out << "StoreOp: " << storeOps << "\\l";
}
for (uint32_t subpass = 0; subpass <= mCurrentSubpass; ++subpass)
{
if (subpass > 0)
{
out << "Next Subpass"
<< "\\l";
}
out << mCommandBuffers[subpass].dumpCommands("\\l");
}
contextVk->addCommandBufferDiagnostics(out.str());
}
// CommandBufferRecycler implementation.
template <typename CommandBufferT, typename CommandBufferHelperT>
void CommandBufferRecycler<CommandBufferT, CommandBufferHelperT>::onDestroy()
{
for (CommandBufferHelperT *commandBufferHelper : mCommandBufferHelperFreeList)
{
SafeDelete(commandBufferHelper);
}
mCommandBufferHelperFreeList.clear();
ASSERT(mSecondaryCommandBuffersToReset.empty());
}
template void CommandBufferRecycler<OutsideRenderPassCommandBuffer,
OutsideRenderPassCommandBufferHelper>::onDestroy();
template void
CommandBufferRecycler<RenderPassCommandBuffer, RenderPassCommandBufferHelper>::onDestroy();
template <typename CommandBufferT, typename CommandBufferHelperT>
angle::Result CommandBufferRecycler<CommandBufferT, CommandBufferHelperT>::getCommandBufferHelper(
Context *context,
CommandPool *commandPool,
CommandBufferHelperT **commandBufferHelperOut)
{
if (mCommandBufferHelperFreeList.empty())
{
CommandBufferHelperT *commandBuffer = new CommandBufferHelperT();
*commandBufferHelperOut = commandBuffer;
return commandBuffer->initialize(context, commandPool);
}
else
{
CommandBufferHelperT *commandBuffer = mCommandBufferHelperFreeList.back();
mCommandBufferHelperFreeList.pop_back();
*commandBufferHelperOut = commandBuffer;
return angle::Result::Continue;
}
}
template angle::Result
CommandBufferRecycler<OutsideRenderPassCommandBuffer, OutsideRenderPassCommandBufferHelper>::
getCommandBufferHelper(Context *context,
CommandPool *commandPool,
OutsideRenderPassCommandBufferHelper **commandBufferHelperOut);
template angle::Result
CommandBufferRecycler<RenderPassCommandBuffer, RenderPassCommandBufferHelper>::
getCommandBufferHelper(Context *context,
CommandPool *commandPool,
RenderPassCommandBufferHelper **commandBufferHelperOut);
template <typename CommandBufferT, typename CommandBufferHelperT>
void CommandBufferRecycler<CommandBufferT, CommandBufferHelperT>::recycleCommandBufferHelper(
VkDevice device,
CommandBufferHelperT **commandBuffer)
{
ASSERT((*commandBuffer)->empty());
(*commandBuffer)->markOpen();
RecycleCommandBufferHelper(device, &mCommandBufferHelperFreeList, commandBuffer,
&(*commandBuffer)->getCommandBuffer());
}
template void
CommandBufferRecycler<OutsideRenderPassCommandBuffer, OutsideRenderPassCommandBufferHelper>::
recycleCommandBufferHelper(VkDevice device,
OutsideRenderPassCommandBufferHelper **commandBuffer);
template void CommandBufferRecycler<RenderPassCommandBuffer, RenderPassCommandBufferHelper>::
recycleCommandBufferHelper(VkDevice device, RenderPassCommandBufferHelper **commandBuffer);
template <typename CommandBufferT, typename CommandBufferHelperT>
void CommandBufferRecycler<CommandBufferT, CommandBufferHelperT>::resetCommandBuffer(
CommandBufferT &&commandBuffer)
{
ResetSecondaryCommandBuffer(&mSecondaryCommandBuffersToReset, std::move(commandBuffer));
}
// DynamicBuffer implementation.
DynamicBuffer::DynamicBuffer()
: mUsage(0),
mHostVisible(false),
mInitialSize(0),
mNextAllocationOffset(0),
mSize(0),
mAlignment(0),
mMemoryPropertyFlags(0)
{}
DynamicBuffer::DynamicBuffer(DynamicBuffer &&other)
: mUsage(other.mUsage),
mHostVisible(other.mHostVisible),
mInitialSize(other.mInitialSize),
mBuffer(std::move(other.mBuffer)),
mNextAllocationOffset(other.mNextAllocationOffset),
mSize(other.mSize),
mAlignment(other.mAlignment),
mMemoryPropertyFlags(other.mMemoryPropertyFlags),
mInFlightBuffers(std::move(other.mInFlightBuffers)),
mBufferFreeList(std::move(other.mBufferFreeList))
{}
void DynamicBuffer::init(RendererVk *renderer,
VkBufferUsageFlags usage,
size_t alignment,
size_t initialSize,
bool hostVisible)
{
mUsage = usage;
mHostVisible = hostVisible;
mMemoryPropertyFlags =
(hostVisible) ? VK_MEMORY_PROPERTY_HOST_VISIBLE_BIT : VK_MEMORY_PROPERTY_DEVICE_LOCAL_BIT;
// Check that we haven't overridden the initial size of the buffer in setMinimumSizeForTesting.
if (mInitialSize == 0)
{
mInitialSize = initialSize;
mSize = 0;
}
// Workaround for the mock ICD not supporting allocations greater than 0x1000.
// Could be removed if https://github.com/KhronosGroup/Vulkan-Tools/issues/84 is fixed.
if (renderer->isMockICDEnabled())
{
mSize = std::min<size_t>(mSize, 0x1000);
}
requireAlignment(renderer, alignment);
}
DynamicBuffer::~DynamicBuffer()
{
ASSERT(mBuffer == nullptr);
ASSERT(mInFlightBuffers.empty());
ASSERT(mBufferFreeList.empty());
}
angle::Result DynamicBuffer::allocateNewBuffer(Context *context)
{
context->getPerfCounters().dynamicBufferAllocations++;
// Allocate the buffer
ASSERT(!mBuffer);
mBuffer = std::make_unique<BufferHelper>();
VkBufferCreateInfo createInfo = {};
createInfo.sType = VK_STRUCTURE_TYPE_BUFFER_CREATE_INFO;
createInfo.flags = 0;
createInfo.size = mSize;
createInfo.usage = mUsage;
createInfo.sharingMode = VK_SHARING_MODE_EXCLUSIVE;
createInfo.queueFamilyIndexCount = 0;
createInfo.pQueueFamilyIndices = nullptr;
return mBuffer->init(context, createInfo, mMemoryPropertyFlags);
}
bool DynamicBuffer::allocateFromCurrentBuffer(size_t sizeInBytes, BufferHelper **bufferHelperOut)
{
mNextAllocationOffset =
roundUp<uint32_t>(mNextAllocationOffset, static_cast<uint32_t>(mAlignment));
ASSERT(bufferHelperOut);
size_t sizeToAllocate = roundUp(sizeInBytes, mAlignment);
angle::base::CheckedNumeric<size_t> checkedNextWriteOffset = mNextAllocationOffset;
checkedNextWriteOffset += sizeToAllocate;
if (!checkedNextWriteOffset.IsValid() || checkedNextWriteOffset.ValueOrDie() > mSize)
{
return false;
}
ASSERT(mBuffer != nullptr);
ASSERT(mHostVisible);
ASSERT(mBuffer->getMappedMemory());
mBuffer->setSuballocationOffsetAndSize(mNextAllocationOffset, sizeToAllocate);
*bufferHelperOut = mBuffer.get();
mNextAllocationOffset += static_cast<uint32_t>(sizeToAllocate);
return true;
}
angle::Result DynamicBuffer::allocate(Context *context,
size_t sizeInBytes,
BufferHelper **bufferHelperOut,
bool *newBufferAllocatedOut)
{
bool newBuffer = !allocateFromCurrentBuffer(sizeInBytes, bufferHelperOut);
if (newBufferAllocatedOut)
{
*newBufferAllocatedOut = newBuffer;
}
if (!newBuffer)
{
return angle::Result::Continue;
}
size_t sizeToAllocate = roundUp(sizeInBytes, mAlignment);
if (mBuffer)
{
// Make sure the buffer is not released externally.
ASSERT(mBuffer->valid());
mInFlightBuffers.push_back(std::move(mBuffer));
ASSERT(!mBuffer);
}
RendererVk *renderer = context->getRenderer();
const size_t sizeIgnoringHistory = std::max(mInitialSize, sizeToAllocate);
if (sizeToAllocate > mSize || sizeIgnoringHistory < mSize / 4)
{
mSize = sizeIgnoringHistory;
// Clear the free list since the free buffers are now either too small or too big.
ReleaseBufferListToRenderer(renderer, &mBufferFreeList);
}
// The front of the free list should be the oldest. Thus if it is in use the rest of the
// free list should be in use as well.
if (mBufferFreeList.empty() ||
mBufferFreeList.front()->isCurrentlyInUse(renderer->getLastCompletedQueueSerial()))
{
ANGLE_TRY(allocateNewBuffer(context));
}
else
{
mBuffer = std::move(mBufferFreeList.front());
mBufferFreeList.erase(mBufferFreeList.begin());
}
ASSERT(mBuffer->getBlockMemorySize() == mSize);
mNextAllocationOffset = 0;
ASSERT(mBuffer != nullptr);
mBuffer->setSuballocationOffsetAndSize(mNextAllocationOffset, sizeToAllocate);
*bufferHelperOut = mBuffer.get();
mNextAllocationOffset += static_cast<uint32_t>(sizeToAllocate);
return angle::Result::Continue;
}
void DynamicBuffer::release(RendererVk *renderer)
{
reset();
ReleaseBufferListToRenderer(renderer, &mInFlightBuffers);
ReleaseBufferListToRenderer(renderer, &mBufferFreeList);
if (mBuffer)
{
mBuffer->release(renderer);
mBuffer.reset(nullptr);
}
}
void DynamicBuffer::releaseInFlightBuffersToResourceUseList(ContextVk *contextVk)
{
ResourceUseList resourceUseList;
for (std::unique_ptr<BufferHelper> &bufferHelper : mInFlightBuffers)
{
// This function is used only for internal buffers, and they are all read-only.
// It's possible this may change in the future, but there isn't a good way to detect that,
// unfortunately.
bufferHelper->retainReadOnly(&resourceUseList);
// We only keep free buffers that have the same size. Note that bufferHelper's size is
// suballocation's size. We need to use the whole block memory size here.
if (bufferHelper->getBlockMemorySize() != mSize)
{
bufferHelper->release(contextVk->getRenderer());
}
else
{
mBufferFreeList.push_back(std::move(bufferHelper));
}
}
mInFlightBuffers.clear();
contextVk->getShareGroupVk()->acquireResourceUseList(std::move(resourceUseList));
}
void DynamicBuffer::destroy(RendererVk *renderer)
{
reset();
DestroyBufferList(renderer, &mInFlightBuffers);
DestroyBufferList(renderer, &mBufferFreeList);
if (mBuffer)
{
mBuffer->unmap(renderer);
mBuffer->destroy(renderer);
mBuffer.reset(nullptr);
}
}
void DynamicBuffer::requireAlignment(RendererVk *renderer, size_t alignment)
{
ASSERT(alignment > 0);
size_t prevAlignment = mAlignment;
// If alignment was never set, initialize it with the atom size limit.
if (prevAlignment == 0)
{
prevAlignment =
static_cast<size_t>(renderer->getPhysicalDeviceProperties().limits.nonCoherentAtomSize);
ASSERT(gl::isPow2(prevAlignment));
}
// We need lcm(prevAlignment, alignment). Usually, one divides the other so std::max() could be
// used instead. Only known case where this assumption breaks is for 3-component types with
// 16- or 32-bit channels, so that's special-cased to avoid a full-fledged lcm implementation.
if (gl::isPow2(prevAlignment * alignment))
{
ASSERT(alignment % prevAlignment == 0 || prevAlignment % alignment == 0);
alignment = std::max(prevAlignment, alignment);
}
else
{
ASSERT(prevAlignment % 3 != 0 || gl::isPow2(prevAlignment / 3));
ASSERT(alignment % 3 != 0 || gl::isPow2(alignment / 3));
prevAlignment = prevAlignment % 3 == 0 ? prevAlignment / 3 : prevAlignment;
alignment = alignment % 3 == 0 ? alignment / 3 : alignment;
alignment = std::max(prevAlignment, alignment) * 3;
}
// If alignment has changed, make sure the next allocation is done at an aligned offset.
if (alignment != mAlignment)
{
mNextAllocationOffset = roundUp(mNextAllocationOffset, static_cast<uint32_t>(alignment));
}
mAlignment = alignment;
}
void DynamicBuffer::setMinimumSizeForTesting(size_t minSize)
{
// This will really only have an effect next time we call allocate.
mInitialSize = minSize;
// Forces a new allocation on the next allocate.
mSize = 0;
}
void DynamicBuffer::reset()
{
mSize = 0;
mNextAllocationOffset = 0;
}
// BufferPool implementation.
BufferPool::BufferPool()
: mVirtualBlockCreateFlags(vma::VirtualBlockCreateFlagBits::GENERAL),
mUsage(0),
mHostVisible(false),
mSize(0),
mMemoryTypeIndex(0),
mTotalMemorySize(0),
mNumberOfNewBuffersNeededSinceLastPrune(0)
{}
BufferPool::BufferPool(BufferPool &&other)
: mVirtualBlockCreateFlags(other.mVirtualBlockCreateFlags),
mUsage(other.mUsage),
mHostVisible(other.mHostVisible),
mSize(other.mSize),
mMemoryTypeIndex(other.mMemoryTypeIndex)
{}
void BufferPool::initWithFlags(RendererVk *renderer,
vma::VirtualBlockCreateFlags flags,
VkBufferUsageFlags usage,
VkDeviceSize initialSize,
uint32_t memoryTypeIndex,
VkMemoryPropertyFlags memoryPropertyFlags)
{
mVirtualBlockCreateFlags = flags;
mUsage = usage;
mMemoryTypeIndex = memoryTypeIndex;
if (initialSize)
{
// Should be power of two
ASSERT(gl::isPow2(initialSize));
mSize = initialSize;
}
else
{
mSize = renderer->getPreferedBufferBlockSize(memoryTypeIndex);
}
mHostVisible = ((memoryPropertyFlags & VK_MEMORY_PROPERTY_HOST_VISIBLE_BIT) != 0);
}
BufferPool::~BufferPool()
{
ASSERT(mBufferBlocks.empty());
ASSERT(mEmptyBufferBlocks.empty());
}
void BufferPool::pruneEmptyBuffers(RendererVk *renderer)
{
// First try to walk through mBuffers and move empty buffers to mEmptyBuffer and remove null
// pointers for allocation performance.
// The expectation is that we will find none needs to be compacted in most calls.
bool needsCompact = false;
for (std::unique_ptr<BufferBlock> &block : mBufferBlocks)
{
if (block->isEmpty())
{
// We will always free empty buffers that has smaller size. Or if the empty buffer has
// been found empty for long enough time, or we accumulated too many empty buffers, we
// also free it.
if (block->getMemorySize() < mSize)
{
mTotalMemorySize -= block->getMemorySize();
block->destroy(renderer);
block.reset();
}
else
{
mEmptyBufferBlocks.push_back(std::move(block));
}
needsCompact = true;
}
}
// Now remove the null pointers that left by empty buffers all at once, if any.
if (needsCompact)
{
BufferBlockPointerVector compactedBlocks;
for (std::unique_ptr<BufferBlock> &block : mBufferBlocks)
{
if (block)
{
compactedBlocks.push_back(std::move(block));
}
}
mBufferBlocks = std::move(compactedBlocks);
}
// Decide how many empty buffers to keep around and trim down the excessive empty buffers. We
// keep track of how many buffers are needed since last prune. Assume we are in stable state,
// which means we may still need that many empty buffers in next prune cycle. To reduce chance
// to call into vulkan driver to allocate new buffers, we try to keep that many empty buffers
// around, subject to the maximum cap. If we overestimate, next cycle they used fewer buffers,
// we will trim excessive empty buffers at next prune call. Or if we underestimate, we will end
// up have to call into vulkan driver allocate new buffers, but next cycle we should correct
// ourselves to keep enough number of empty buffers around.
size_t buffersToKeep = std::min(mNumberOfNewBuffersNeededSinceLastPrune,
static_cast<size_t>(kMaxTotalEmptyBufferBytes / mSize));
while (mEmptyBufferBlocks.size() > buffersToKeep)
{
std::unique_ptr<BufferBlock> &block = mEmptyBufferBlocks.back();
mTotalMemorySize -= block->getMemorySize();
block->destroy(renderer);
mEmptyBufferBlocks.pop_back();
}
mNumberOfNewBuffersNeededSinceLastPrune = 0;
}
angle::Result BufferPool::allocateNewBuffer(Context *context, VkDeviceSize sizeInBytes)
{
RendererVk *renderer = context->getRenderer();
const Allocator &allocator = renderer->getAllocator();
VkDeviceSize heapSize =
renderer->getMemoryProperties().getHeapSizeForMemoryType(mMemoryTypeIndex);
// First ensure we are not exceeding the heapSize to avoid the validation error.
ANGLE_VK_CHECK(context, sizeInBytes <= heapSize, VK_ERROR_OUT_OF_DEVICE_MEMORY);
// Double the size until meet the requirement. This also helps reducing the fragmentation. Since
// this is global pool, we have less worry about memory waste.
VkDeviceSize newSize = mSize;
while (newSize < sizeInBytes)
{
newSize <<= 1;
}
mSize = std::min(newSize, heapSize);
// Allocate buffer
VkBufferCreateInfo createInfo = {};
createInfo.sType = VK_STRUCTURE_TYPE_BUFFER_CREATE_INFO;
createInfo.flags = 0;
createInfo.size = mSize;
createInfo.usage = mUsage;
createInfo.sharingMode = VK_SHARING_MODE_EXCLUSIVE;
createInfo.queueFamilyIndexCount = 0;
createInfo.pQueueFamilyIndices = nullptr;
VkMemoryPropertyFlags memoryPropertyFlags;
allocator.getMemoryTypeProperties(mMemoryTypeIndex, &memoryPropertyFlags);
DeviceScoped<Buffer> buffer(renderer->getDevice());
ANGLE_VK_TRY(context, buffer.get().init(context->getDevice(), createInfo));
DeviceScoped<DeviceMemory> deviceMemory(renderer->getDevice());
VkMemoryPropertyFlags memoryPropertyFlagsOut;
VkDeviceSize sizeOut;
ANGLE_TRY(AllocateBufferMemory(context, memoryPropertyFlags, &memoryPropertyFlagsOut, nullptr,
&buffer.get(), &deviceMemory.get(), &sizeOut));
ASSERT(sizeOut >= mSize);
// Allocate bufferBlock
std::unique_ptr<BufferBlock> block = std::make_unique<BufferBlock>();
ANGLE_TRY(block->init(context, buffer.get(), mVirtualBlockCreateFlags, deviceMemory.get(),
memoryPropertyFlagsOut, mSize));
if (mHostVisible)
{
ANGLE_VK_TRY(context, block->map(context->getDevice()));
}
mTotalMemorySize += block->getMemorySize();
// Append the bufferBlock into the pool
mBufferBlocks.push_back(std::move(block));
context->getPerfCounters().allocateNewBufferBlockCalls++;
return angle::Result::Continue;
}
angle::Result BufferPool::allocateBuffer(Context *context,
VkDeviceSize sizeInBytes,
VkDeviceSize alignment,
BufferSuballocation *suballocation)
{
ASSERT(alignment);
VkDeviceSize offset;
VkDeviceSize alignedSize = roundUp(sizeInBytes, alignment);
if (alignedSize >= kMaxBufferSizeForSuballocation)
{
VkDeviceSize heapSize =
context->getRenderer()->getMemoryProperties().getHeapSizeForMemoryType(
mMemoryTypeIndex);
// First ensure we are not exceeding the heapSize to avoid the validation error.
ANGLE_VK_CHECK(context, sizeInBytes <= heapSize, VK_ERROR_OUT_OF_DEVICE_MEMORY);
// Allocate buffer
VkBufferCreateInfo createInfo = {};
createInfo.sType = VK_STRUCTURE_TYPE_BUFFER_CREATE_INFO;
createInfo.flags = 0;
createInfo.size = alignedSize;
createInfo.usage = mUsage;
createInfo.sharingMode = VK_SHARING_MODE_EXCLUSIVE;
createInfo.queueFamilyIndexCount = 0;
createInfo.pQueueFamilyIndices = nullptr;
VkMemoryPropertyFlags memoryPropertyFlags;
const Allocator &allocator = context->getRenderer()->getAllocator();
allocator.getMemoryTypeProperties(mMemoryTypeIndex, &memoryPropertyFlags);
DeviceScoped<Buffer> buffer(context->getDevice());
ANGLE_VK_TRY(context, buffer.get().init(context->getDevice(), createInfo));
DeviceScoped<DeviceMemory> deviceMemory(context->getDevice());
VkMemoryPropertyFlags memoryPropertyFlagsOut;
VkDeviceSize sizeOut;
ANGLE_TRY(AllocateBufferMemory(context, memoryPropertyFlags, &memoryPropertyFlagsOut,
nullptr, &buffer.get(), &deviceMemory.get(), &sizeOut));
ASSERT(sizeOut >= alignedSize);
suballocation->initWithEntireBuffer(context, buffer.get(), deviceMemory.get(),
memoryPropertyFlagsOut, alignedSize);
if (mHostVisible)
{
ANGLE_VK_TRY(context, suballocation->map(context));
}
return angle::Result::Continue;
}
// We always allocate from reverse order so that older buffers have a chance to be empty. The
// assumption is that to allocate from new buffers first may have a better chance to leave the
// older buffers completely empty and we may able to free it.
for (auto iter = mBufferBlocks.rbegin(); iter != mBufferBlocks.rend();)
{
std::unique_ptr<BufferBlock> &block = *iter;
if (block->isEmpty() && block->getMemorySize() < mSize)
{
// Don't try to allocate from an empty buffer that has smaller size. It will get
// released when pruneEmptyBuffers get called later on.
++iter;
continue;
}
if (block->allocate(alignedSize, alignment, &offset) == VK_SUCCESS)
{
suballocation->init(context->getDevice(), block.get(), offset, alignedSize);
return angle::Result::Continue;
}
++iter;
}
// Try to allocate from empty buffers
while (!mEmptyBufferBlocks.empty())
{
std::unique_ptr<BufferBlock> &block = mEmptyBufferBlocks.back();
if (block->getMemorySize() < mSize)
{
mTotalMemorySize -= block->getMemorySize();
block->destroy(context->getRenderer());
mEmptyBufferBlocks.pop_back();
}
else
{
ANGLE_VK_TRY(context, block->allocate(alignedSize, alignment, &offset));
suballocation->init(context->getDevice(), block.get(), offset, alignedSize);
mBufferBlocks.push_back(std::move(block));
mEmptyBufferBlocks.pop_back();
mNumberOfNewBuffersNeededSinceLastPrune++;
return angle::Result::Continue;
}
}
// Failed to allocate from empty buffer. Now try to allocate a new buffer.
ANGLE_TRY(allocateNewBuffer(context, alignedSize));
// Sub-allocate from the bufferBlock.
std::unique_ptr<BufferBlock> &block = mBufferBlocks.back();
ANGLE_VK_CHECK(context, block->allocate(alignedSize, alignment, &offset) == VK_SUCCESS,
VK_ERROR_OUT_OF_DEVICE_MEMORY);
suballocation->init(context->getDevice(), block.get(), offset, alignedSize);
mNumberOfNewBuffersNeededSinceLastPrune++;
return angle::Result::Continue;
}
void BufferPool::destroy(RendererVk *renderer, bool orphanNonEmptyBufferBlock)
{
for (std::unique_ptr<BufferBlock> &block : mBufferBlocks)
{
if (block->isEmpty())
{
block->destroy(renderer);
}
else
{
// When orphan is not allowed, all BufferBlocks must be empty.
ASSERT(orphanNonEmptyBufferBlock);
renderer->addBufferBlockToOrphanList(block.release());
}
}
mBufferBlocks.clear();
for (std::unique_ptr<BufferBlock> &block : mEmptyBufferBlocks)
{
block->destroy(renderer);
}
mEmptyBufferBlocks.clear();
}
VkDeviceSize BufferPool::getTotalEmptyMemorySize() const
{
VkDeviceSize totalMemorySize = 0;
for (const std::unique_ptr<BufferBlock> &block : mEmptyBufferBlocks)
{
totalMemorySize += block->getMemorySize();
}
return totalMemorySize;
}
void BufferPool::addStats(std::ostringstream *out) const
{
VkDeviceSize totalUnusedBytes = 0;
VkDeviceSize totalMemorySize = 0;
*out << "[ ";
for (const std::unique_ptr<BufferBlock> &block : mBufferBlocks)
{
vma::StatInfo statInfo;
block->calculateStats(&statInfo);
*out << statInfo.unusedBytes / 1024 << "/" << block->getMemorySize() / 1024 << " ";
totalUnusedBytes += statInfo.unusedBytes;
totalMemorySize += block->getMemorySize();
}
*out << "]"
<< " total: " << totalUnusedBytes << "/" << totalMemorySize;
*out << " emptyBuffers [memorySize:" << getTotalEmptyMemorySize()
<< " count:" << mEmptyBufferBlocks.size()
<< " needed: " << mNumberOfNewBuffersNeededSinceLastPrune << "]";
}
// DescriptorPoolHelper implementation.
DescriptorPoolHelper::DescriptorPoolHelper() : mFreeDescriptorSets(0) {}
DescriptorPoolHelper::~DescriptorPoolHelper() = default;
bool DescriptorPoolHelper::hasCapacity(uint32_t descriptorSetCount) const
{
return mFreeDescriptorSets >= descriptorSetCount;
}
angle::Result DescriptorPoolHelper::init(Context *context,
const std::vector<VkDescriptorPoolSize> &poolSizesIn,
uint32_t maxSets)
{
RendererVk *renderer = context->getRenderer();
if (mDescriptorPool.valid())
{
ASSERT(!isCurrentlyInUse(renderer->getLastCompletedQueueSerial()));
mDescriptorPool.destroy(renderer->getDevice());
}
// Make a copy of the pool sizes, so we can grow them to satisfy the specified maxSets.
std::vector<VkDescriptorPoolSize> poolSizes = poolSizesIn;
for (VkDescriptorPoolSize &poolSize : poolSizes)
{
poolSize.descriptorCount *= maxSets;
}
VkDescriptorPoolCreateInfo descriptorPoolInfo = {};
descriptorPoolInfo.sType = VK_STRUCTURE_TYPE_DESCRIPTOR_POOL_CREATE_INFO;
descriptorPoolInfo.flags = 0;
descriptorPoolInfo.maxSets = maxSets;
descriptorPoolInfo.poolSizeCount = static_cast<uint32_t>(poolSizes.size());
descriptorPoolInfo.pPoolSizes = poolSizes.data();
mFreeDescriptorSets = maxSets;
ANGLE_VK_TRY(context, mDescriptorPool.init(renderer->getDevice(), descriptorPoolInfo));
return angle::Result::Continue;
}
void DescriptorPoolHelper::destroy(RendererVk *renderer, VulkanCacheType cacheType)
{
mDescriptorPool.destroy(renderer->getDevice());
mDescriptorSetCache.resetCache();
}
void DescriptorPoolHelper::release(ContextVk *contextVk, VulkanCacheType cacheType)
{
contextVk->addGarbage(&mDescriptorPool);
mDescriptorSetCache.resetCache();
}
angle::Result DescriptorPoolHelper::allocateDescriptorSets(
Context *context,
CommandBufferHelperCommon *commandBufferHelper,
const DescriptorSetLayout &descriptorSetLayout,
uint32_t descriptorSetCount,
VkDescriptorSet *descriptorSetsOut)
{
VkDescriptorSetAllocateInfo allocInfo = {};
allocInfo.sType = VK_STRUCTURE_TYPE_DESCRIPTOR_SET_ALLOCATE_INFO;
allocInfo.descriptorPool = mDescriptorPool.getHandle();
allocInfo.descriptorSetCount = descriptorSetCount;
allocInfo.pSetLayouts = descriptorSetLayout.ptr();
ASSERT(mFreeDescriptorSets >= descriptorSetCount);
mFreeDescriptorSets -= descriptorSetCount;
ANGLE_VK_TRY(context, mDescriptorPool.allocateDescriptorSets(context->getDevice(), allocInfo,
descriptorSetsOut));
// The pool is still in use every time a new descriptor set is allocated from it.
commandBufferHelper->retainResource(this);
return angle::Result::Continue;
}
angle::Result DescriptorPoolHelper::allocateAndCacheDescriptorSet(
Context *context,
CommandBufferHelperCommon *commandBufferHelper,
const DescriptorSetDesc &desc,
const DescriptorSetLayout &descriptorSetLayout,
VkDescriptorSet *descriptorSetOut)
{
ANGLE_TRY(allocateDescriptorSets(context, commandBufferHelper, descriptorSetLayout, 1,
descriptorSetOut));
mDescriptorSetCache.insertDescriptorSet(desc, *descriptorSetOut);
return angle::Result::Continue;
}
bool DescriptorPoolHelper::getCachedDescriptorSet(const DescriptorSetDesc &desc,
VkDescriptorSet *descriptorSetOut)
{
return mDescriptorSetCache.getDescriptorSet(desc, descriptorSetOut);
}
void DescriptorPoolHelper::resetCache()
{
mDescriptorSetCache.resetCache();
}
// DynamicDescriptorPool implementation.
DynamicDescriptorPool::DynamicDescriptorPool()
: mCurrentPoolIndex(0), mCachedDescriptorSetLayout(VK_NULL_HANDLE)
{}
DynamicDescriptorPool::~DynamicDescriptorPool() = default;
DynamicDescriptorPool::DynamicDescriptorPool(DynamicDescriptorPool &&other)
: DynamicDescriptorPool()
{
*this = std::move(other);
}
DynamicDescriptorPool &DynamicDescriptorPool::operator=(DynamicDescriptorPool &&other)
{
std::swap(mCurrentPoolIndex, other.mCurrentPoolIndex);
std::swap(mDescriptorPools, other.mDescriptorPools);
std::swap(mPoolSizes, other.mPoolSizes);
std::swap(mCachedDescriptorSetLayout, other.mCachedDescriptorSetLayout);
return *this;
}
angle::Result DynamicDescriptorPool::init(Context *context,
const VkDescriptorPoolSize *setSizes,
size_t setSizeCount,
VkDescriptorSetLayout descriptorSetLayout)
{
ASSERT(setSizes);
ASSERT(setSizeCount);
ASSERT(mCurrentPoolIndex == 0);
ASSERT(mDescriptorPools.empty() ||
(mDescriptorPools.size() == 1 &&
mDescriptorPools[mCurrentPoolIndex]->get().hasCapacity(mMaxSetsPerPool)));
ASSERT(mCachedDescriptorSetLayout == VK_NULL_HANDLE);
mPoolSizes.assign(setSizes, setSizes + setSizeCount);
mCachedDescriptorSetLayout = descriptorSetLayout;
mDescriptorPools.push_back(new RefCountedDescriptorPoolHelper());
mCurrentPoolIndex = mDescriptorPools.size() - 1;
return mDescriptorPools[mCurrentPoolIndex]->get().init(context, mPoolSizes, mMaxSetsPerPool);
}
void DynamicDescriptorPool::destroy(RendererVk *renderer, VulkanCacheType cacheType)
{
for (RefCountedDescriptorPoolHelper *pool : mDescriptorPools)
{
ASSERT(!pool->isReferenced());
pool->get().destroy(renderer, cacheType);
delete pool;
}
mDescriptorPools.clear();
mCurrentPoolIndex = 0;
mCachedDescriptorSetLayout = VK_NULL_HANDLE;
}
void DynamicDescriptorPool::release(ContextVk *contextVk, VulkanCacheType cacheType)
{
for (RefCountedDescriptorPoolHelper *pool : mDescriptorPools)
{
ASSERT(!pool->isReferenced());
pool->get().release(contextVk, cacheType);
delete pool;
}
mDescriptorPools.clear();
mCurrentPoolIndex = 0;
mCachedDescriptorSetLayout = VK_NULL_HANDLE;
}
angle::Result DynamicDescriptorPool::allocateDescriptorSets(
Context *context,
CommandBufferHelperCommon *commandBufferHelper,
const DescriptorSetLayout &descriptorSetLayout,
uint32_t descriptorSetCount,
RefCountedDescriptorPoolBinding *bindingOut,
VkDescriptorSet *descriptorSetsOut)
{
ASSERT(!mDescriptorPools.empty());
ASSERT(descriptorSetLayout.getHandle() == mCachedDescriptorSetLayout);
if (!bindingOut->valid() || !bindingOut->get().hasCapacity(descriptorSetCount))
{
if (!mDescriptorPools[mCurrentPoolIndex]->get().hasCapacity(descriptorSetCount))
{
ANGLE_TRY(allocateNewPool(context));
}
bindingOut->set(mDescriptorPools[mCurrentPoolIndex]);
}
++context->getPerfCounters().descriptorSetAllocations;
return bindingOut->get().allocateDescriptorSets(
context, commandBufferHelper, descriptorSetLayout, descriptorSetCount, descriptorSetsOut);
}
angle::Result DynamicDescriptorPool::getOrAllocateDescriptorSet(
Context *context,
CommandBufferHelperCommon *commandBufferHelper,
const DescriptorSetDesc &desc,
const DescriptorSetLayout &descriptorSetLayout,
RefCountedDescriptorPoolBinding *bindingOut,
VkDescriptorSet *descriptorSetOut,
DescriptorCacheResult *cacheResultOut)
{
// First scan the descriptor pools.
for (RefCountedDescriptorPoolHelper *pool : mDescriptorPools)
{
if (pool->get().getCachedDescriptorSet(desc, descriptorSetOut))
{
*cacheResultOut = DescriptorCacheResult::CacheHit;
bindingOut->set(pool);
mCacheStats.hit();
return angle::Result::Continue;
}
}
mCacheStats.missAndIncrementSize();
ASSERT(!mDescriptorPools.empty());
ASSERT(descriptorSetLayout.getHandle() == mCachedDescriptorSetLayout);
constexpr uint32_t kDescriptorSetCount = 1;
if (!bindingOut->valid() || !bindingOut->get().hasCapacity(kDescriptorSetCount))
{
if (!mDescriptorPools[mCurrentPoolIndex]->get().hasCapacity(kDescriptorSetCount))
{
ANGLE_TRY(allocateNewPool(context));
}
}
bindingOut->set(mDescriptorPools[mCurrentPoolIndex]);
ANGLE_TRY(mDescriptorPools[mCurrentPoolIndex]->get().allocateAndCacheDescriptorSet(
context, commandBufferHelper, desc, descriptorSetLayout, descriptorSetOut));
*cacheResultOut = DescriptorCacheResult::NewAllocation;
++context->getPerfCounters().descriptorSetAllocations;
return angle::Result::Continue;
}
angle::Result DynamicDescriptorPool::allocateNewPool(Context *context)
{
bool found = false;
Serial lastCompletedSerial = context->getRenderer()->getLastCompletedQueueSerial();
for (size_t poolIndex = 0; poolIndex < mDescriptorPools.size(); ++poolIndex)
{
if (!mDescriptorPools[poolIndex]->isReferenced() &&
!mDescriptorPools[poolIndex]->get().isCurrentlyInUse(lastCompletedSerial))
{
mCurrentPoolIndex = poolIndex;
found = true;
mDescriptorPools[poolIndex]->get().resetCache();
break;
}
}
if (!found)
{
mDescriptorPools.push_back(new RefCountedDescriptorPoolHelper());
mCurrentPoolIndex = mDescriptorPools.size() - 1;
static constexpr size_t kMaxPools = 99999;
ANGLE_VK_CHECK(context, mDescriptorPools.size() < kMaxPools, VK_ERROR_TOO_MANY_OBJECTS);
}
// This pool is getting hot, so grow its max size to try and prevent allocating another pool in
// the future.
if (mMaxSetsPerPool < kMaxSetsPerPoolMax)
{
mMaxSetsPerPool *= mMaxSetsPerPoolMultiplier;
}
return mDescriptorPools[mCurrentPoolIndex]->get().init(context, mPoolSizes, mMaxSetsPerPool);
}
// For testing only!
uint32_t DynamicDescriptorPool::GetMaxSetsPerPoolForTesting()
{
return mMaxSetsPerPool;
}
// For testing only!
void DynamicDescriptorPool::SetMaxSetsPerPoolForTesting(uint32_t maxSetsPerPool)
{
mMaxSetsPerPool = maxSetsPerPool;
}
// For testing only!
uint32_t DynamicDescriptorPool::GetMaxSetsPerPoolMultiplierForTesting()
{
return mMaxSetsPerPoolMultiplier;
}
// For testing only!
void DynamicDescriptorPool::SetMaxSetsPerPoolMultiplierForTesting(uint32_t maxSetsPerPoolMultiplier)
{
mMaxSetsPerPoolMultiplier = maxSetsPerPoolMultiplier;
}
// DynamicallyGrowingPool implementation
template <typename Pool>
DynamicallyGrowingPool<Pool>::DynamicallyGrowingPool()
: mPoolSize(0), mCurrentPool(0), mCurrentFreeEntry(0)
{}
template <typename Pool>
DynamicallyGrowingPool<Pool>::~DynamicallyGrowingPool() = default;
template <typename Pool>
angle::Result DynamicallyGrowingPool<Pool>::initEntryPool(Context *contextVk, uint32_t poolSize)
{
ASSERT(mPools.empty());
mPoolSize = poolSize;
mCurrentFreeEntry = poolSize;
return angle::Result::Continue;
}
template <typename Pool>
void DynamicallyGrowingPool<Pool>::destroyEntryPool(VkDevice device)
{
for (PoolResource &resource : mPools)
{
destroyPoolImpl(device, resource.pool);
}
mPools.clear();
}
template <typename Pool>
bool DynamicallyGrowingPool<Pool>::findFreeEntryPool(ContextVk *contextVk)
{
Serial lastCompletedQueueSerial = contextVk->getLastCompletedQueueSerial();
for (size_t poolIndex = 0; poolIndex < mPools.size(); ++poolIndex)
{
PoolResource &pool = mPools[poolIndex];
if (pool.freedCount == mPoolSize && !pool.isCurrentlyInUse(lastCompletedQueueSerial))
{
mCurrentPool = poolIndex;
mCurrentFreeEntry = 0;
pool.freedCount = 0;
return true;
}
}
return false;
}
template <typename Pool>
angle::Result DynamicallyGrowingPool<Pool>::allocateNewEntryPool(ContextVk *contextVk, Pool &&pool)
{
mPools.emplace_back(std::move(pool), 0);
mCurrentPool = mPools.size() - 1;
mCurrentFreeEntry = 0;
return angle::Result::Continue;
}
template <typename Pool>
void DynamicallyGrowingPool<Pool>::onEntryFreed(ContextVk *contextVk, size_t poolIndex)
{
ASSERT(poolIndex < mPools.size() && mPools[poolIndex].freedCount < mPoolSize);
ResourceUseList resourceUseList;
mPools[poolIndex].retain(&resourceUseList);
contextVk->getShareGroupVk()->acquireResourceUseList(std::move(resourceUseList));
++mPools[poolIndex].freedCount;
}
template <typename Pool>
angle::Result DynamicallyGrowingPool<Pool>::allocatePoolEntries(ContextVk *contextVk,
uint32_t entryCount,
uint32_t *poolIndex,
uint32_t *currentEntryOut)
{
if (mCurrentFreeEntry + entryCount > mPoolSize)
{
if (!findFreeEntryPool(contextVk))
{
Pool newPool;
ANGLE_TRY(allocatePoolImpl(contextVk, newPool, mPoolSize));
ANGLE_TRY(allocateNewEntryPool(contextVk, std::move(newPool)));
}
}
*poolIndex = static_cast<uint32_t>(mCurrentPool);
*currentEntryOut = mCurrentFreeEntry;
mCurrentFreeEntry += entryCount;
return angle::Result::Continue;
}
template <typename Pool>
DynamicallyGrowingPool<Pool>::PoolResource::PoolResource(Pool &&poolIn, uint32_t freedCountIn)
: pool(std::move(poolIn)), freedCount(freedCountIn)
{}
template <typename Pool>
DynamicallyGrowingPool<Pool>::PoolResource::PoolResource(PoolResource &&other)
: pool(std::move(other.pool)), freedCount(other.freedCount)
{}
// DynamicQueryPool implementation
DynamicQueryPool::DynamicQueryPool() = default;
DynamicQueryPool::~DynamicQueryPool() = default;
angle::Result DynamicQueryPool::init(ContextVk *contextVk, VkQueryType type, uint32_t poolSize)
{
ANGLE_TRY(initEntryPool(contextVk, poolSize));
mQueryType = type;
return angle::Result::Continue;
}
void DynamicQueryPool::destroy(VkDevice device)
{
destroyEntryPool(device);
}
void DynamicQueryPool::destroyPoolImpl(VkDevice device, QueryPool &poolToDestroy)
{
poolToDestroy.destroy(device);
}
angle::Result DynamicQueryPool::allocateQuery(ContextVk *contextVk,
QueryHelper *queryOut,
uint32_t queryCount)
{
ASSERT(!queryOut->valid());
uint32_t currentPool = 0;
uint32_t queryIndex = 0;
ANGLE_TRY(allocatePoolEntries(contextVk, queryCount, &currentPool, &queryIndex));
queryOut->init(this, currentPool, queryIndex, queryCount);
return angle::Result::Continue;
}
angle::Result DynamicQueryPool::allocatePoolImpl(ContextVk *contextVk,
QueryPool &poolToAllocate,
uint32_t entriesToAllocate)
{
VkQueryPoolCreateInfo queryPoolInfo = {};
queryPoolInfo.sType = VK_STRUCTURE_TYPE_QUERY_POOL_CREATE_INFO;
queryPoolInfo.flags = 0;
queryPoolInfo.queryType = this->mQueryType;
queryPoolInfo.queryCount = entriesToAllocate;
queryPoolInfo.pipelineStatistics = 0;
if (this->mQueryType == VK_QUERY_TYPE_PIPELINE_STATISTICS)
{
queryPoolInfo.pipelineStatistics = VK_QUERY_PIPELINE_STATISTIC_CLIPPING_INVOCATIONS_BIT;
}
ANGLE_VK_TRY(contextVk, poolToAllocate.init(contextVk->getDevice(), queryPoolInfo));
return angle::Result::Continue;
}
void DynamicQueryPool::freeQuery(ContextVk *contextVk, QueryHelper *query)
{
if (query->valid())
{
size_t poolIndex = query->mQueryPoolIndex;
ASSERT(getQueryPool(poolIndex).valid());
onEntryFreed(contextVk, poolIndex);
query->deinit();
}
}
// QueryResult implementation
void QueryResult::setResults(uint64_t *results, uint32_t queryCount)
{
ASSERT(mResults[0] == 0 && mResults[1] == 0);
// Accumulate the query results. For multiview, where multiple query indices are used to return
// the results, it's undefined how the results are distributed between indices, but the sum is
// guaranteed to be the desired result.
for (uint32_t query = 0; query < queryCount; ++query)
{
for (uint32_t perQueryIndex = 0; perQueryIndex < mIntsPerResult; ++perQueryIndex)
{
mResults[perQueryIndex] += results[query * mIntsPerResult + perQueryIndex];
}
}
}
// QueryHelper implementation
QueryHelper::QueryHelper()
: mDynamicQueryPool(nullptr),
mQueryPoolIndex(0),
mQuery(0),
mQueryCount(0),
mStatus(QueryStatus::Inactive)
{}
QueryHelper::~QueryHelper() {}
// Move constructor
QueryHelper::QueryHelper(QueryHelper &&rhs)
: Resource(std::move(rhs)),
mDynamicQueryPool(rhs.mDynamicQueryPool),
mQueryPoolIndex(rhs.mQueryPoolIndex),
mQuery(rhs.mQuery),
mQueryCount(rhs.mQueryCount)
{
rhs.mDynamicQueryPool = nullptr;
rhs.mQueryPoolIndex = 0;
rhs.mQuery = 0;
rhs.mQueryCount = 0;
}
QueryHelper &QueryHelper::operator=(QueryHelper &&rhs)
{
std::swap(mDynamicQueryPool, rhs.mDynamicQueryPool);
std::swap(mQueryPoolIndex, rhs.mQueryPoolIndex);
std::swap(mQuery, rhs.mQuery);
std::swap(mQueryCount, rhs.mQueryCount);
return *this;
}
void QueryHelper::init(const DynamicQueryPool *dynamicQueryPool,
const size_t queryPoolIndex,
uint32_t query,
uint32_t queryCount)
{
mDynamicQueryPool = dynamicQueryPool;
mQueryPoolIndex = queryPoolIndex;
mQuery = query;
mQueryCount = queryCount;
ASSERT(mQueryCount <= gl::IMPLEMENTATION_ANGLE_MULTIVIEW_MAX_VIEWS);
}
void QueryHelper::deinit()
{
mDynamicQueryPool = nullptr;
mQueryPoolIndex = 0;
mQuery = 0;
mQueryCount = 0;
mUse.release();
mUse.init();
mStatus = QueryStatus::Inactive;
}
template <typename CommandBufferT>
void QueryHelper::beginQueryImpl(ContextVk *contextVk,
OutsideRenderPassCommandBuffer *resetCommandBuffer,
CommandBufferT *commandBuffer)
{
ASSERT(mStatus != QueryStatus::Active);
const QueryPool &queryPool = getQueryPool();
resetQueryPoolImpl(contextVk, queryPool, resetCommandBuffer);
commandBuffer->beginQuery(queryPool, mQuery, 0);
mStatus = QueryStatus::Active;
}
template <typename CommandBufferT>
void QueryHelper::endQueryImpl(ContextVk *contextVk, CommandBufferT *commandBuffer)
{
ASSERT(mStatus != QueryStatus::Ended);
commandBuffer->endQuery(getQueryPool(), mQuery);
mStatus = QueryStatus::Ended;
}
angle::Result QueryHelper::beginQuery(ContextVk *contextVk)
{
if (contextVk->hasStartedRenderPass())
{
ANGLE_TRY(contextVk->flushCommandsAndEndRenderPass(
RenderPassClosureReason::BeginNonRenderPassQuery));
}
OutsideRenderPassCommandBuffer *commandBuffer;
ANGLE_TRY(contextVk->getOutsideRenderPassCommandBuffer({}, &commandBuffer));
ANGLE_TRY(contextVk->handleGraphicsEventLog(rx::GraphicsEventCmdBuf::InOutsideCmdBufQueryCmd));
beginQueryImpl(contextVk, commandBuffer, commandBuffer);
return angle::Result::Continue;
}
angle::Result QueryHelper::endQuery(ContextVk *contextVk)
{
if (contextVk->hasStartedRenderPass())
{
ANGLE_TRY(contextVk->flushCommandsAndEndRenderPass(
RenderPassClosureReason::EndNonRenderPassQuery));
}
CommandBufferAccess access;
OutsideRenderPassCommandBuffer *commandBuffer;
access.onQueryAccess(this);
ANGLE_TRY(contextVk->getOutsideRenderPassCommandBuffer(access, &commandBuffer));
ANGLE_TRY(contextVk->handleGraphicsEventLog(rx::GraphicsEventCmdBuf::InOutsideCmdBufQueryCmd));
endQueryImpl(contextVk, commandBuffer);
return angle::Result::Continue;
}
template <typename CommandBufferT>
void QueryHelper::resetQueryPoolImpl(ContextVk *contextVk,
const QueryPool &queryPool,
CommandBufferT *commandBuffer)
{
RendererVk *renderer = contextVk->getRenderer();
if (vkResetQueryPoolEXT != nullptr && renderer->getFeatures().supportsHostQueryReset.enabled)
{
vkResetQueryPoolEXT(contextVk->getDevice(), queryPool.getHandle(), mQuery, mQueryCount);
}
else
{
commandBuffer->resetQueryPool(queryPool, mQuery, mQueryCount);
}
}
angle::Result QueryHelper::beginRenderPassQuery(ContextVk *contextVk)
{
OutsideRenderPassCommandBuffer *outsideRenderPassCommandBuffer;
ANGLE_TRY(contextVk->getOutsideRenderPassCommandBuffer({}, &outsideRenderPassCommandBuffer));
RenderPassCommandBuffer *renderPassCommandBuffer =
&contextVk->getStartedRenderPassCommands().getCommandBuffer();
beginQueryImpl(contextVk, outsideRenderPassCommandBuffer, renderPassCommandBuffer);
return angle::Result::Continue;
}
void QueryHelper::endRenderPassQuery(ContextVk *contextVk)
{
if (mStatus == QueryStatus::Active)
{
endQueryImpl(contextVk, &contextVk->getStartedRenderPassCommands().getCommandBuffer());
contextVk->getStartedRenderPassCommands().retainResource(this);
}
}
angle::Result QueryHelper::flushAndWriteTimestamp(ContextVk *contextVk)
{
if (contextVk->hasStartedRenderPass())
{
ANGLE_TRY(
contextVk->flushCommandsAndEndRenderPass(RenderPassClosureReason::TimestampQuery));
}
CommandBufferAccess access;
OutsideRenderPassCommandBuffer *commandBuffer;
access.onQueryAccess(this);
ANGLE_TRY(contextVk->getOutsideRenderPassCommandBuffer(access, &commandBuffer));
writeTimestamp(contextVk, commandBuffer);
return angle::Result::Continue;
}
void QueryHelper::writeTimestampToPrimary(ContextVk *contextVk, PrimaryCommandBuffer *primary)
{
// Note that commands may not be flushed at this point.
const QueryPool &queryPool = getQueryPool();
resetQueryPoolImpl(contextVk, queryPool, primary);
primary->writeTimestamp(VK_PIPELINE_STAGE_BOTTOM_OF_PIPE_BIT, queryPool, mQuery);
}
void QueryHelper::writeTimestamp(ContextVk *contextVk,
OutsideRenderPassCommandBuffer *commandBuffer)
{
const QueryPool &queryPool = getQueryPool();
resetQueryPoolImpl(contextVk, queryPool, commandBuffer);
commandBuffer->writeTimestamp(VK_PIPELINE_STAGE_BOTTOM_OF_PIPE_BIT, queryPool, mQuery);
}
bool QueryHelper::hasSubmittedCommands() const
{
return mUse.getSerial().valid();
}
angle::Result QueryHelper::getUint64ResultNonBlocking(ContextVk *contextVk,
QueryResult *resultOut,
bool *availableOut)
{
ASSERT(valid());
VkResult result;
// Ensure that we only wait if we have inserted a query in command buffer. Otherwise you will
// wait forever and trigger GPU timeout.
if (hasSubmittedCommands())
{
constexpr VkQueryResultFlags kFlags = VK_QUERY_RESULT_64_BIT;
result = getResultImpl(contextVk, kFlags, resultOut);
}
else
{
result = VK_SUCCESS;
*resultOut = 0;
}
if (result == VK_NOT_READY)
{
*availableOut = false;
return angle::Result::Continue;
}
else
{
ANGLE_VK_TRY(contextVk, result);
*availableOut = true;
}
return angle::Result::Continue;
}
angle::Result QueryHelper::getUint64Result(ContextVk *contextVk, QueryResult *resultOut)
{
ASSERT(valid());
if (hasSubmittedCommands())
{
constexpr VkQueryResultFlags kFlags = VK_QUERY_RESULT_64_BIT | VK_QUERY_RESULT_WAIT_BIT;
ANGLE_VK_TRY(contextVk, getResultImpl(contextVk, kFlags, resultOut));
}
else
{
*resultOut = 0;
}
return angle::Result::Continue;
}
VkResult QueryHelper::getResultImpl(ContextVk *contextVk,
const VkQueryResultFlags flags,
QueryResult *resultOut)
{
std::array<uint64_t, 2 * gl::IMPLEMENTATION_ANGLE_MULTIVIEW_MAX_VIEWS> results;
VkDevice device = contextVk->getDevice();
VkResult result = getQueryPool().getResults(device, mQuery, mQueryCount, sizeof(results),
results.data(), sizeof(uint64_t), flags);
if (result == VK_SUCCESS)
{
resultOut->setResults(results.data(), mQueryCount);
}
return result;
}
// DynamicSemaphorePool implementation
DynamicSemaphorePool::DynamicSemaphorePool() = default;
DynamicSemaphorePool::~DynamicSemaphorePool() = default;
angle::Result DynamicSemaphorePool::init(ContextVk *contextVk, uint32_t poolSize)
{
ANGLE_TRY(initEntryPool(contextVk, poolSize));
return angle::Result::Continue;
}
void DynamicSemaphorePool::destroy(VkDevice device)
{
destroyEntryPool(device);
}
angle::Result DynamicSemaphorePool::allocateSemaphore(ContextVk *contextVk,
SemaphoreHelper *semaphoreOut)
{
ASSERT(!semaphoreOut->getSemaphore());
uint32_t currentPool = 0;
uint32_t currentEntry = 0;
ANGLE_TRY(allocatePoolEntries(contextVk, 1, &currentPool, &currentEntry));
semaphoreOut->init(currentPool, &getPool(currentPool)[currentEntry]);
return angle::Result::Continue;
}
void DynamicSemaphorePool::freeSemaphore(ContextVk *contextVk, SemaphoreHelper *semaphore)
{
if (semaphore->getSemaphore())
{
onEntryFreed(contextVk, semaphore->getSemaphorePoolIndex());
semaphore->deinit();
}
}
angle::Result DynamicSemaphorePool::allocatePoolImpl(ContextVk *contextVk,
std::vector<Semaphore> &poolToAllocate,
uint32_t entriesToAllocate)
{
poolToAllocate.resize(entriesToAllocate);
for (Semaphore &semaphore : poolToAllocate)
{
ANGLE_VK_TRY(contextVk, semaphore.init(contextVk->getDevice()));
}
return angle::Result::Continue;
}
void DynamicSemaphorePool::destroyPoolImpl(VkDevice device, std::vector<Semaphore> &poolToDestroy)
{
for (Semaphore &semaphore : poolToDestroy)
{
semaphore.destroy(device);
}
}
// SemaphoreHelper implementation
SemaphoreHelper::SemaphoreHelper() : mSemaphorePoolIndex(0), mSemaphore(0) {}
SemaphoreHelper::~SemaphoreHelper() {}
SemaphoreHelper::SemaphoreHelper(SemaphoreHelper &&other)
: mSemaphorePoolIndex(other.mSemaphorePoolIndex), mSemaphore(other.mSemaphore)
{
other.mSemaphore = nullptr;
}
SemaphoreHelper &SemaphoreHelper::operator=(SemaphoreHelper &&other)
{
std::swap(mSemaphorePoolIndex, other.mSemaphorePoolIndex);
std::swap(mSemaphore, other.mSemaphore);
return *this;
}
void SemaphoreHelper::init(const size_t semaphorePoolIndex, const Semaphore *semaphore)
{
mSemaphorePoolIndex = semaphorePoolIndex;
mSemaphore = semaphore;
}
void SemaphoreHelper::deinit()
{
mSemaphorePoolIndex = 0;
mSemaphore = nullptr;
}
// LineLoopHelper implementation.
LineLoopHelper::LineLoopHelper(RendererVk *renderer) {}
LineLoopHelper::~LineLoopHelper() = default;
angle::Result LineLoopHelper::getIndexBufferForDrawArrays(ContextVk *contextVk,
uint32_t clampedVertexCount,
GLint firstVertex,
BufferHelper **bufferOut)
{
size_t allocateBytes = sizeof(uint32_t) * (static_cast<size_t>(clampedVertexCount) + 1);
ANGLE_TRY(mDynamicIndexBuffer.allocateForVertexConversion(contextVk, allocateBytes,
MemoryHostVisibility::Visible));
uint32_t *indices = reinterpret_cast<uint32_t *>(mDynamicIndexBuffer.getMappedMemory());
// Note: there could be an overflow in this addition.
uint32_t unsignedFirstVertex = static_cast<uint32_t>(firstVertex);
uint32_t vertexCount = (clampedVertexCount + unsignedFirstVertex);
for (uint32_t vertexIndex = unsignedFirstVertex; vertexIndex < vertexCount; vertexIndex++)
{
*indices++ = vertexIndex;
}
*indices = unsignedFirstVertex;
// Since we are not using the VK_MEMORY_PROPERTY_HOST_COHERENT_BIT flag when creating the
// device memory in the StreamingBuffer, we always need to make sure we flush it after
// writing.
ANGLE_TRY(mDynamicIndexBuffer.flush(contextVk->getRenderer()));
*bufferOut = &mDynamicIndexBuffer;
return angle::Result::Continue;
}
angle::Result LineLoopHelper::getIndexBufferForElementArrayBuffer(ContextVk *contextVk,
BufferVk *elementArrayBufferVk,
gl::DrawElementsType glIndexType,
int indexCount,
intptr_t elementArrayOffset,
BufferHelper **bufferOut,
uint32_t *indexCountOut)
{
if (glIndexType == gl::DrawElementsType::UnsignedByte ||
contextVk->getState().isPrimitiveRestartEnabled())
{
ANGLE_TRACE_EVENT0("gpu.angle", "LineLoopHelper::getIndexBufferForElementArrayBuffer");
void *srcDataMapping = nullptr;
ANGLE_TRY(elementArrayBufferVk->mapImpl(contextVk, GL_MAP_READ_BIT, &srcDataMapping));
ANGLE_TRY(streamIndices(contextVk, glIndexType, indexCount,
static_cast<const uint8_t *>(srcDataMapping) + elementArrayOffset,
bufferOut, indexCountOut));
ANGLE_TRY(elementArrayBufferVk->unmapImpl(contextVk));
return angle::Result::Continue;
}
*indexCountOut = indexCount + 1;
size_t unitSize = contextVk->getVkIndexTypeSize(glIndexType);
size_t allocateBytes = unitSize * (indexCount + 1) + 1;
ANGLE_TRY(mDynamicIndexBuffer.allocateForVertexConversion(contextVk, allocateBytes,
MemoryHostVisibility::Visible));
BufferHelper *sourceBuffer = &elementArrayBufferVk->getBuffer();
VkDeviceSize sourceOffset =
static_cast<VkDeviceSize>(elementArrayOffset) + sourceBuffer->getOffset();
uint64_t unitCount = static_cast<VkDeviceSize>(indexCount);
angle::FixedVector<VkBufferCopy, 2> copies = {
{sourceOffset, mDynamicIndexBuffer.getOffset(), unitCount * unitSize},
{sourceOffset, mDynamicIndexBuffer.getOffset() + unitCount * unitSize, unitSize},
};
vk::CommandBufferAccess access;
access.onBufferTransferWrite(&mDynamicIndexBuffer);
access.onBufferTransferRead(sourceBuffer);
vk::OutsideRenderPassCommandBuffer *commandBuffer;
ANGLE_TRY(contextVk->getOutsideRenderPassCommandBuffer(access, &commandBuffer));
commandBuffer->copyBuffer(sourceBuffer->getBuffer(), mDynamicIndexBuffer.getBuffer(),
static_cast<uint32_t>(copies.size()), copies.data());
ANGLE_TRY(mDynamicIndexBuffer.flush(contextVk->getRenderer()));
*bufferOut = &mDynamicIndexBuffer;
return angle::Result::Continue;
}
angle::Result LineLoopHelper::streamIndices(ContextVk *contextVk,
gl::DrawElementsType glIndexType,
GLsizei indexCount,
const uint8_t *srcPtr,
BufferHelper **bufferOut,
uint32_t *indexCountOut)
{
size_t unitSize = contextVk->getVkIndexTypeSize(glIndexType);
uint32_t numOutIndices = indexCount + 1;
if (contextVk->getState().isPrimitiveRestartEnabled())
{
numOutIndices = GetLineLoopWithRestartIndexCount(glIndexType, indexCount, srcPtr);
}
*indexCountOut = numOutIndices;
ANGLE_TRY(mDynamicIndexBuffer.allocateForVertexConversion(contextVk, unitSize * numOutIndices,
MemoryHostVisibility::Visible));
uint8_t *indices = mDynamicIndexBuffer.getMappedMemory();
if (contextVk->getState().isPrimitiveRestartEnabled())
{
HandlePrimitiveRestart(contextVk, glIndexType, indexCount, srcPtr, indices);
}
else
{
if (contextVk->shouldConvertUint8VkIndexType(glIndexType))
{
// If vulkan doesn't support uint8 index types, we need to emulate it.
VkIndexType indexType = contextVk->getVkIndexType(glIndexType);
ASSERT(indexType == VK_INDEX_TYPE_UINT16);
uint16_t *indicesDst = reinterpret_cast<uint16_t *>(indices);
for (int i = 0; i < indexCount; i++)
{
indicesDst[i] = srcPtr[i];
}
indicesDst[indexCount] = srcPtr[0];
}
else
{
memcpy(indices, srcPtr, unitSize * indexCount);
memcpy(indices + unitSize * indexCount, srcPtr, unitSize);
}
}
ANGLE_TRY(mDynamicIndexBuffer.flush(contextVk->getRenderer()));
*bufferOut = &mDynamicIndexBuffer;
return angle::Result::Continue;
}
angle::Result LineLoopHelper::streamIndicesIndirect(ContextVk *contextVk,
gl::DrawElementsType glIndexType,
BufferHelper *indexBuffer,
BufferHelper *indirectBuffer,
VkDeviceSize indirectBufferOffset,
BufferHelper **indexBufferOut,
BufferHelper **indirectBufferOut)
{
size_t unitSize = contextVk->getVkIndexTypeSize(glIndexType);
size_t allocateBytes = static_cast<size_t>(indexBuffer->getSize() + unitSize);
if (contextVk->getState().isPrimitiveRestartEnabled())
{
// If primitive restart, new index buffer is 135% the size of the original index buffer. The
// smallest lineloop with primitive restart is 3 indices (point 1, point 2 and restart
// value) when converted to linelist becomes 4 vertices. Expansion of 4/3. Any larger
// lineloops would have less overhead and require less extra space. Any incomplete
// primitives can be dropped or left incomplete and thus not increase the size of the
// destination index buffer. Since we don't know the number of indices being used we'll use
// the size of the index buffer as allocated as the index count.
size_t numInputIndices = static_cast<size_t>(indexBuffer->getSize() / unitSize);
size_t numNewInputIndices = ((numInputIndices * 4) / 3) + 1;
allocateBytes = static_cast<size_t>(numNewInputIndices * unitSize);
}
// Allocate buffer for results
ANGLE_TRY(mDynamicIndexBuffer.allocateForVertexConversion(contextVk, allocateBytes,
MemoryHostVisibility::Visible));
ANGLE_TRY(mDynamicIndirectBuffer.allocateForVertexConversion(
contextVk, sizeof(VkDrawIndexedIndirectCommand), MemoryHostVisibility::Visible));
*indexBufferOut = &mDynamicIndexBuffer;
*indirectBufferOut = &mDynamicIndirectBuffer;
BufferHelper *dstIndexBuffer = &mDynamicIndexBuffer;
BufferHelper *dstIndirectBuffer = &mDynamicIndirectBuffer;
// Copy relevant section of the source into destination at allocated offset. Note that the
// offset returned by allocate() above is in bytes. As is the indices offset pointer.
UtilsVk::ConvertLineLoopIndexIndirectParameters params = {};
params.indirectBufferOffset = static_cast<uint32_t>(indirectBufferOffset);
params.dstIndirectBufferOffset = 0;
params.srcIndexBufferOffset = 0;
params.dstIndexBufferOffset = 0;
params.indicesBitsWidth = static_cast<uint32_t>(unitSize * 8);
return contextVk->getUtils().convertLineLoopIndexIndirectBuffer(
contextVk, indirectBuffer, dstIndirectBuffer, dstIndexBuffer, indexBuffer, params);
}
angle::Result LineLoopHelper::streamArrayIndirect(ContextVk *contextVk,
size_t vertexCount,
BufferHelper *arrayIndirectBuffer,
VkDeviceSize arrayIndirectBufferOffset,
BufferHelper **indexBufferOut,
BufferHelper **indexIndirectBufferOut)
{
auto unitSize = sizeof(uint32_t);
size_t allocateBytes = static_cast<size_t>((vertexCount + 1) * unitSize);
ANGLE_TRY(mDynamicIndexBuffer.allocateForVertexConversion(contextVk, allocateBytes,
MemoryHostVisibility::Visible));
ANGLE_TRY(mDynamicIndirectBuffer.allocateForVertexConversion(
contextVk, sizeof(VkDrawIndexedIndirectCommand), MemoryHostVisibility::Visible));
*indexBufferOut = &mDynamicIndexBuffer;
*indexIndirectBufferOut = &mDynamicIndirectBuffer;
BufferHelper *dstIndexBuffer = &mDynamicIndexBuffer;
BufferHelper *dstIndirectBuffer = &mDynamicIndirectBuffer;
// Copy relevant section of the source into destination at allocated offset. Note that the
// offset returned by allocate() above is in bytes. As is the indices offset pointer.
UtilsVk::ConvertLineLoopArrayIndirectParameters params = {};
params.indirectBufferOffset = static_cast<uint32_t>(arrayIndirectBufferOffset);
params.dstIndirectBufferOffset = 0;
params.dstIndexBufferOffset = 0;
return contextVk->getUtils().convertLineLoopArrayIndirectBuffer(
contextVk, arrayIndirectBuffer, dstIndirectBuffer, dstIndexBuffer, params);
}
void LineLoopHelper::release(ContextVk *contextVk)
{
mDynamicIndexBuffer.release(contextVk->getRenderer());
mDynamicIndirectBuffer.release(contextVk->getRenderer());
}
void LineLoopHelper::destroy(RendererVk *renderer)
{
mDynamicIndexBuffer.destroy(renderer);
mDynamicIndirectBuffer.destroy(renderer);
}
// static
void LineLoopHelper::Draw(uint32_t count,
uint32_t baseVertex,
RenderPassCommandBuffer *commandBuffer)
{
// Our first index is always 0 because that's how we set it up in createIndexBuffer*.
commandBuffer->drawIndexedBaseVertex(count, baseVertex);
}
PipelineStage GetPipelineStage(gl::ShaderType stage)
{
const PipelineStage pipelineStage = kPipelineStageShaderMap[stage];
ASSERT(pipelineStage == PipelineStage::VertexShader ||
pipelineStage == PipelineStage::TessellationControl ||
pipelineStage == PipelineStage::TessellationEvaluation ||
pipelineStage == PipelineStage::GeometryShader ||
pipelineStage == PipelineStage::FragmentShader ||
pipelineStage == PipelineStage::ComputeShader);
return pipelineStage;
}
// PipelineBarrier implementation.
void PipelineBarrier::addDiagnosticsString(std::ostringstream &out) const
{
if (mMemoryBarrierSrcAccess != 0 || mMemoryBarrierDstAccess != 0)
{
out << "Src: 0x" << std::hex << mMemoryBarrierSrcAccess << " &rarr; Dst: 0x" << std::hex
<< mMemoryBarrierDstAccess << std::endl;
}
}
// BufferHelper implementation.
BufferHelper::BufferHelper()
: mCurrentQueueFamilyIndex(std::numeric_limits<uint32_t>::max()),
mCurrentWriteAccess(0),
mCurrentReadAccess(0),
mCurrentWriteStages(0),
mCurrentReadStages(0),
mSerial()
{}
BufferHelper::~BufferHelper() = default;
BufferHelper::BufferHelper(BufferHelper &&other)
{
*this = std::move(other);
}
BufferHelper &BufferHelper::operator=(BufferHelper &&other)
{
ReadWriteResource::operator=(std::move(other));
mSuballocation = std::move(other.mSuballocation);
mBufferForVertexArray = std::move(other.mBufferForVertexArray);
mCurrentQueueFamilyIndex = other.mCurrentQueueFamilyIndex;
mCurrentWriteAccess = other.mCurrentWriteAccess;
mCurrentReadAccess = other.mCurrentReadAccess;
mCurrentWriteStages = other.mCurrentWriteStages;
mCurrentReadStages = other.mCurrentReadStages;
mSerial = other.mSerial;
return *this;
}
angle::Result BufferHelper::init(Context *context,
const VkBufferCreateInfo &requestedCreateInfo,
VkMemoryPropertyFlags memoryPropertyFlags)
{
RendererVk *renderer = context->getRenderer();
const Allocator &allocator = renderer->getAllocator();
initializeBarrierTracker(context);
VkBufferCreateInfo modifiedCreateInfo;
const VkBufferCreateInfo *createInfo = &requestedCreateInfo;
if (renderer->getFeatures().padBuffersToMaxVertexAttribStride.enabled)
{
const VkDeviceSize maxVertexAttribStride = renderer->getMaxVertexAttribStride();
ASSERT(maxVertexAttribStride);
modifiedCreateInfo = requestedCreateInfo;
modifiedCreateInfo.size += maxVertexAttribStride;
createInfo = &modifiedCreateInfo;
}
VkMemoryPropertyFlags requiredFlags =
(memoryPropertyFlags & VK_MEMORY_PROPERTY_HOST_VISIBLE_BIT);
VkMemoryPropertyFlags preferredFlags =
(memoryPropertyFlags & (~VK_MEMORY_PROPERTY_HOST_VISIBLE_BIT));
bool persistentlyMapped = renderer->getFeatures().persistentlyMappedBuffers.enabled;
// Check that the allocation is not too large.
uint32_t memoryTypeIndex = kInvalidMemoryTypeIndex;
ANGLE_VK_TRY(context, allocator.findMemoryTypeIndexForBufferInfo(
*createInfo, requiredFlags, preferredFlags, persistentlyMapped,
&memoryTypeIndex));
VkDeviceSize heapSize =
renderer->getMemoryProperties().getHeapSizeForMemoryType(memoryTypeIndex);
ANGLE_VK_CHECK(context, createInfo->size <= heapSize, VK_ERROR_OUT_OF_DEVICE_MEMORY);
// Allocate buffer object
DeviceScoped<Buffer> buffer(renderer->getDevice());
ANGLE_VK_TRY(context, buffer.get().init(context->getDevice(), *createInfo));
DeviceScoped<DeviceMemory> deviceMemory(renderer->getDevice());
VkMemoryPropertyFlags memoryPropertyFlagsOut;
VkDeviceSize sizeOut;
ANGLE_TRY(AllocateBufferMemory(context, requiredFlags, &memoryPropertyFlagsOut, nullptr,
&buffer.get(), &deviceMemory.get(), &sizeOut));
ASSERT(sizeOut >= createInfo->size);
mSuballocation.initWithEntireBuffer(context, buffer.get(), deviceMemory.get(),
memoryPropertyFlagsOut, requestedCreateInfo.size);
if (isHostVisible())
{
uint8_t *ptrOut;
ANGLE_TRY(map(context, &ptrOut));
}
if (renderer->getFeatures().allocateNonZeroMemory.enabled)
{
ANGLE_TRY(initializeNonZeroMemory(context, createInfo->usage, createInfo->size));
}
return angle::Result::Continue;
}
angle::Result BufferHelper::initExternal(ContextVk *contextVk,
VkMemoryPropertyFlags memoryProperties,
const VkBufferCreateInfo &requestedCreateInfo,
GLeglClientBufferEXT clientBuffer)
{
ASSERT(IsAndroid());
RendererVk *renderer = contextVk->getRenderer();
initializeBarrierTracker(contextVk);
VkBufferCreateInfo modifiedCreateInfo = requestedCreateInfo;
VkExternalMemoryBufferCreateInfo externCreateInfo = {};
externCreateInfo.sType = VK_STRUCTURE_TYPE_EXTERNAL_MEMORY_BUFFER_CREATE_INFO;
externCreateInfo.handleTypes =
VK_EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID;
externCreateInfo.pNext = nullptr;
modifiedCreateInfo.pNext = &externCreateInfo;
DeviceScoped<Buffer> buffer(renderer->getDevice());
ANGLE_VK_TRY(contextVk, buffer.get().init(renderer->getDevice(), modifiedCreateInfo));
DeviceScoped<DeviceMemory> deviceMemory(renderer->getDevice());
VkMemoryPropertyFlags memoryPropertyFlagsOut;
ANGLE_TRY(InitAndroidExternalMemory(contextVk, clientBuffer, memoryProperties, &buffer.get(),
&memoryPropertyFlagsOut, &deviceMemory.get()));
mSuballocation.initWithEntireBuffer(contextVk, buffer.get(), deviceMemory.get(),
memoryPropertyFlagsOut, requestedCreateInfo.size);
if (isHostVisible())
{
uint8_t *ptrOut;
ANGLE_TRY(map(contextVk, &ptrOut));
}
return angle::Result::Continue;
}
angle::Result BufferHelper::initSuballocation(ContextVk *contextVk,
uint32_t memoryTypeIndex,
size_t size,
size_t alignment)
{
RendererVk *renderer = contextVk->getRenderer();
// We should reset these in case the BufferHelper object has been released and called
// initSuballocation again.
initializeBarrierTracker(contextVk);
if (renderer->getFeatures().padBuffersToMaxVertexAttribStride.enabled)
{
const VkDeviceSize maxVertexAttribStride = renderer->getMaxVertexAttribStride();
ASSERT(maxVertexAttribStride);
size += maxVertexAttribStride;
}
vk::BufferPool *pool = contextVk->getDefaultBufferPool(size, memoryTypeIndex);
ANGLE_TRY(pool->allocateBuffer(contextVk, size, alignment, &mSuballocation));
if (renderer->getFeatures().allocateNonZeroMemory.enabled)
{
ANGLE_TRY(initializeNonZeroMemory(contextVk, GetDefaultBufferUsageFlags(renderer), size));
}
return angle::Result::Continue;
}
angle::Result BufferHelper::allocateForCopyBuffer(ContextVk *contextVk,
size_t size,
MemoryCoherency coherency)
{
RendererVk *renderer = contextVk->getRenderer();
uint32_t memoryTypeIndex = renderer->getStagingBufferMemoryTypeIndex(coherency);
size_t alignment = renderer->getStagingBufferAlignment();
return initSuballocation(contextVk, memoryTypeIndex, size, alignment);
}
angle::Result BufferHelper::allocateForVertexConversion(ContextVk *contextVk,
size_t size,
MemoryHostVisibility hostVisibility)
{
RendererVk *renderer = contextVk->getRenderer();
if (valid())
{
// If size is big enough and it is idle, then just reuse the existing buffer.
if (size <= getSize() &&
(hostVisibility == MemoryHostVisibility::Visible) == isHostVisible())
{
if (!isCurrentlyInUse(contextVk->getLastCompletedQueueSerial()))
{
initializeBarrierTracker(contextVk);
return angle::Result::Continue;
}
else if (hostVisibility == MemoryHostVisibility::NonVisible)
{
// For device local buffer, we can reuse the buffer even if it is still GPU busy.
// The memory barrier should take care of this.
return angle::Result::Continue;
}
}
release(renderer);
}
uint32_t memoryTypeIndex = renderer->getVertexConversionBufferMemoryTypeIndex(hostVisibility);
size_t alignment = static_cast<size_t>(renderer->getVertexConversionBufferAlignment());
// The size is retrieved and used in descriptor set. The descriptor set wants aligned size,
// otherwise there are test failures. Note that underline VMA allocation always allocate aligned
// size anyway.
size_t sizeToAllocate = roundUp(size, alignment);
return initSuballocation(contextVk, memoryTypeIndex, sizeToAllocate, alignment);
}
angle::Result BufferHelper::allocateForCopyImage(ContextVk *contextVk,
size_t size,
MemoryCoherency coherency,
angle::FormatID formatId,
VkDeviceSize *offset,
uint8_t **dataPtr)
{
RendererVk *renderer = contextVk->getRenderer();
// When a buffer is used in copyImage, the offset must be multiple of pixel bytes. This may
// result in non-power of two alignment. VMA's virtual allocator can not handle non-power of two
// alignment. We have to adjust offset manually.
uint32_t memoryTypeIndex = renderer->getStagingBufferMemoryTypeIndex(coherency);
size_t imageCopyAlignment = GetImageCopyBufferAlignment(formatId);
// Add extra padding for potential offset alignment
size_t allocationSize = size + imageCopyAlignment;
allocationSize = roundUp(allocationSize, imageCopyAlignment);
size_t stagingAlignment = static_cast<size_t>(renderer->getStagingBufferAlignment());
ANGLE_TRY(initSuballocation(contextVk, memoryTypeIndex, allocationSize, stagingAlignment));
*offset = roundUp(getOffset(), static_cast<VkDeviceSize>(imageCopyAlignment));
*dataPtr = getMappedMemory() + (*offset) - getOffset();
return angle::Result::Continue;
}
ANGLE_INLINE void BufferHelper::initializeBarrierTracker(Context *context)
{
RendererVk *renderer = context->getRenderer();
mCurrentQueueFamilyIndex = renderer->getQueueFamilyIndex();
mSerial = renderer->getResourceSerialFactory().generateBufferSerial();
mCurrentWriteAccess = 0;
mCurrentReadAccess = 0;
mCurrentWriteStages = 0;
mCurrentReadStages = 0;
}
angle::Result BufferHelper::initializeNonZeroMemory(Context *context,
VkBufferUsageFlags usage,
VkDeviceSize size)
{
RendererVk *renderer = context->getRenderer();
// This memory can't be mapped, so the buffer must be marked as a transfer destination so we
// can use a staging resource to initialize it to a non-zero value. If the memory is
// mappable we do the initialization in AllocateBufferMemory.
if (!isHostVisible() && (usage & VK_BUFFER_USAGE_TRANSFER_DST_BIT) != 0)
{
ASSERT((usage & VK_BUFFER_USAGE_TRANSFER_DST_BIT) != 0);
// Staging buffer memory is non-zero-initialized in 'init'.
StagingBuffer stagingBuffer;
ANGLE_TRY(stagingBuffer.init(context, size, StagingUsage::Both));
PrimaryCommandBuffer commandBuffer;
ANGLE_TRY(renderer->getCommandBufferOneOff(context, false, &commandBuffer));
// Queue a DMA copy.
VkBufferCopy copyRegion = {};
copyRegion.srcOffset = 0;
copyRegion.dstOffset = 0;
copyRegion.size = size;
commandBuffer.copyBuffer(stagingBuffer.getBuffer(), getBuffer(), 1, &copyRegion);
ANGLE_VK_TRY(context, commandBuffer.end());
Serial serial;
ANGLE_TRY(renderer->queueSubmitOneOff(context, std::move(commandBuffer), false,
egl::ContextPriority::Medium, nullptr, 0, nullptr,
vk::SubmitPolicy::AllowDeferred, &serial));
stagingBuffer.collectGarbage(renderer, serial);
// Update both SharedResourceUse objects, since mReadOnlyUse tracks when the buffer can be
// destroyed, and mReadWriteUse tracks when the write has completed.
mReadOnlyUse.updateSerialOneOff(serial);
mReadWriteUse.updateSerialOneOff(serial);
}
else if (isHostVisible())
{
// Can map the memory.
// Pick an arbitrary value to initialize non-zero memory for sanitization.
constexpr int kNonZeroInitValue = 55;
uint8_t *mapPointer = mSuballocation.getMappedMemory();
memset(mapPointer, kNonZeroInitValue, static_cast<size_t>(getSize()));
if (!isCoherent())
{
mSuballocation.flush(renderer->getDevice());
}
}
return angle::Result::Continue;
}
const Buffer &BufferHelper::getBufferForVertexArray(ContextVk *contextVk,
VkDeviceSize actualDataSize,
VkDeviceSize *offsetOut)
{
ASSERT(mSuballocation.valid());
ASSERT(actualDataSize <= mSuballocation.getSize());
if (!contextVk->isRobustResourceInitEnabled() || !mSuballocation.isSuballocated())
{
*offsetOut = mSuballocation.getOffset();
return mSuballocation.getBuffer();
}
if (!mBufferForVertexArray.valid())
{
// Allocate buffer that is backed by sub-range of the memory for vertex array usage. This is
// only needed when robust resource init is enabled so that vulkan driver will know the
// exact size of the vertex buffer it is supposedly to use and prevent out of bound access.
VkBufferCreateInfo createInfo = {};
createInfo.sType = VK_STRUCTURE_TYPE_BUFFER_CREATE_INFO;
createInfo.flags = 0;
createInfo.size = actualDataSize;
createInfo.usage = kVertexBufferUsageFlags | kIndexBufferUsageFlags;
createInfo.sharingMode = VK_SHARING_MODE_EXCLUSIVE;
createInfo.queueFamilyIndexCount = 0;
createInfo.pQueueFamilyIndices = nullptr;
mBufferForVertexArray.init(contextVk->getDevice(), createInfo);
VkMemoryRequirements memoryRequirements;
mBufferForVertexArray.getMemoryRequirements(contextVk->getDevice(), &memoryRequirements);
ASSERT(contextVk->getRenderer()->isMockICDEnabled() ||
mSuballocation.getSize() >= memoryRequirements.size);
ASSERT(!contextVk->getRenderer()->isMockICDEnabled() ||
mSuballocation.getOffset() % memoryRequirements.alignment == 0);
mBufferForVertexArray.bindMemory(contextVk->getDevice(), mSuballocation.getDeviceMemory(),
mSuballocation.getOffset());
}
*offsetOut = 0;
return mBufferForVertexArray;
}
void BufferHelper::destroy(RendererVk *renderer)
{
unmap(renderer);
mBufferForVertexArray.destroy(renderer->getDevice());
mSuballocation.destroy(renderer);
}
void BufferHelper::release(RendererVk *renderer)
{
unmap(renderer);
if (mSuballocation.valid())
{
renderer->collectSuballocationGarbage(mReadOnlyUse, std::move(mSuballocation),
std::move(mBufferForVertexArray));
if (mReadWriteUse.isCurrentlyInUse(renderer->getLastCompletedQueueSerial()))
{
mReadWriteUse.release();
mReadWriteUse.init();
}
}
ASSERT(!mBufferForVertexArray.valid());
}
angle::Result BufferHelper::copyFromBuffer(ContextVk *contextVk,
BufferHelper *srcBuffer,
uint32_t regionCount,
const VkBufferCopy *copyRegions)
{
// Check for self-dependency.
vk::CommandBufferAccess access;
if (srcBuffer->getBufferSerial() == getBufferSerial())
{
access.onBufferSelfCopy(this);
}
else
{
access.onBufferTransferRead(srcBuffer);
access.onBufferTransferWrite(this);
}
OutsideRenderPassCommandBuffer *commandBuffer;
ANGLE_TRY(contextVk->getOutsideRenderPassCommandBuffer(access, &commandBuffer));
commandBuffer->copyBuffer(srcBuffer->getBuffer(), getBuffer(), regionCount, copyRegions);
return angle::Result::Continue;
}
angle::Result BufferHelper::map(Context *context, uint8_t **ptrOut)
{
if (!mSuballocation.isMapped())
{
ANGLE_VK_TRY(context, mSuballocation.map(context));
}
*ptrOut = mSuballocation.getMappedMemory();
return angle::Result::Continue;
}
angle::Result BufferHelper::mapWithOffset(ContextVk *contextVk, uint8_t **ptrOut, size_t offset)
{
uint8_t *mapBufPointer;
ANGLE_TRY(map(contextVk, &mapBufPointer));
*ptrOut = mapBufPointer + offset;
return angle::Result::Continue;
}
angle::Result BufferHelper::flush(RendererVk *renderer, VkDeviceSize offset, VkDeviceSize size)
{
mSuballocation.flush(renderer->getDevice());
return angle::Result::Continue;
}
angle::Result BufferHelper::flush(RendererVk *renderer)
{
return flush(renderer, 0, getSize());
}
angle::Result BufferHelper::invalidate(RendererVk *renderer, VkDeviceSize offset, VkDeviceSize size)
{
mSuballocation.invalidate(renderer->getDevice());
return angle::Result::Continue;
}
angle::Result BufferHelper::invalidate(RendererVk *renderer)
{
return invalidate(renderer, 0, getSize());
}
void BufferHelper::changeQueue(uint32_t newQueueFamilyIndex,
OutsideRenderPassCommandBuffer *commandBuffer)
{
VkBufferMemoryBarrier bufferMemoryBarrier = {};
bufferMemoryBarrier.sType = VK_STRUCTURE_TYPE_BUFFER_MEMORY_BARRIER;
bufferMemoryBarrier.srcAccessMask = 0;
bufferMemoryBarrier.dstAccessMask = 0;
bufferMemoryBarrier.srcQueueFamilyIndex = mCurrentQueueFamilyIndex;
bufferMemoryBarrier.dstQueueFamilyIndex = newQueueFamilyIndex;
bufferMemoryBarrier.buffer = getBuffer().getHandle();
bufferMemoryBarrier.offset = getOffset();
bufferMemoryBarrier.size = getSize();
commandBuffer->bufferBarrier(VK_PIPELINE_STAGE_ALL_COMMANDS_BIT,
VK_PIPELINE_STAGE_ALL_COMMANDS_BIT, &bufferMemoryBarrier);
mCurrentQueueFamilyIndex = newQueueFamilyIndex;
}
void BufferHelper::acquireFromExternal(ContextVk *contextVk,
uint32_t externalQueueFamilyIndex,
uint32_t rendererQueueFamilyIndex,
OutsideRenderPassCommandBuffer *commandBuffer)
{
mCurrentQueueFamilyIndex = externalQueueFamilyIndex;
changeQueue(rendererQueueFamilyIndex, commandBuffer);
}
void BufferHelper::releaseToExternal(ContextVk *contextVk,
uint32_t rendererQueueFamilyIndex,
uint32_t externalQueueFamilyIndex,
OutsideRenderPassCommandBuffer *commandBuffer)
{
ASSERT(mCurrentQueueFamilyIndex == rendererQueueFamilyIndex);
changeQueue(externalQueueFamilyIndex, commandBuffer);
}
bool BufferHelper::isReleasedToExternal() const
{
#if !defined(ANGLE_PLATFORM_MACOS) && !defined(ANGLE_PLATFORM_ANDROID)
return IsExternalQueueFamily(mCurrentQueueFamilyIndex);
#else
// TODO(anglebug.com/4635): Implement external memory barriers on Mac/Android.
return false;
#endif
}
bool BufferHelper::recordReadBarrier(VkAccessFlags readAccessType,
VkPipelineStageFlags readStage,
PipelineBarrier *barrier)
{
bool barrierModified = false;
// If there was a prior write and we are making a read that is either a new access type or from
// a new stage, we need a barrier
if (mCurrentWriteAccess != 0 && (((mCurrentReadAccess & readAccessType) != readAccessType) ||
((mCurrentReadStages & readStage) != readStage)))
{
barrier->mergeMemoryBarrier(mCurrentWriteStages, readStage, mCurrentWriteAccess,
readAccessType);
barrierModified = true;
}
// Accumulate new read usage.
mCurrentReadAccess |= readAccessType;
mCurrentReadStages |= readStage;
return barrierModified;
}
bool BufferHelper::recordWriteBarrier(VkAccessFlags writeAccessType,
VkPipelineStageFlags writeStage,
PipelineBarrier *barrier)
{
bool barrierModified = false;
// We don't need to check mCurrentReadStages here since if it is not zero, mCurrentReadAccess
// must not be zero as well. stage is finer grain than accessType.
ASSERT((!mCurrentReadStages && !mCurrentReadAccess) ||
(mCurrentReadStages && mCurrentReadAccess));
if (mCurrentReadAccess != 0 || mCurrentWriteAccess != 0)
{
VkPipelineStageFlags srcStageMask = mCurrentWriteStages | mCurrentReadStages;
barrier->mergeMemoryBarrier(srcStageMask, writeStage, mCurrentWriteAccess, writeAccessType);
barrierModified = true;
}
// Reset usages on the new write.
mCurrentWriteAccess = writeAccessType;
mCurrentReadAccess = 0;
mCurrentWriteStages = writeStage;
mCurrentReadStages = 0;
return barrierModified;
}
void BufferHelper::fillWithColor(const angle::Color<uint8_t> &color,
const gl::InternalFormat &internalFormat)
{
uint32_t count =
static_cast<uint32_t>(getSize()) / static_cast<uint32_t>(internalFormat.pixelBytes);
void *buffer = static_cast<void *>(getMappedMemory());
switch (internalFormat.internalFormat)
{
case GL_RGB565:
{
uint16_t pixelColor =
((color.blue & 0xF8) << 11) | ((color.green & 0xFC) << 5) | (color.red & 0xF8);
uint16_t *pixelPtr = static_cast<uint16_t *>(buffer);
std::fill_n<uint16_t *, uint32_t, uint16_t>(pixelPtr, count, pixelColor);
}
break;
case GL_RGBA8:
{
uint32_t pixelColor =
(color.alpha << 24) | (color.blue << 16) | (color.green << 8) | (color.red);
uint32_t *pixelPtr = static_cast<uint32_t *>(buffer);
std::fill_n<uint32_t *, uint32_t, uint32_t>(pixelPtr, count, pixelColor);
}
break;
case GL_BGR565_ANGLEX:
{
uint16_t pixelColor =
((color.red & 0xF8) << 11) | ((color.green & 0xFC) << 5) | (color.blue & 0xF8);
uint16_t *pixelPtr = static_cast<uint16_t *>(buffer);
std::fill_n<uint16_t *, uint32_t, uint16_t>(pixelPtr, count, pixelColor);
}
break;
case GL_BGRA8_EXT:
{
uint32_t pixelColor =
(color.alpha << 24) | (color.red << 16) | (color.green << 8) | (color.blue);
uint32_t *pixelPtr = static_cast<uint32_t *>(buffer);
std::fill_n<uint32_t *, uint32_t, uint32_t>(pixelPtr, count, pixelColor);
}
break;
default:
UNREACHABLE(); // Unsupported format
}
}
// ImageHelper implementation.
ImageHelper::ImageHelper()
{
resetCachedProperties();
}
ImageHelper::ImageHelper(ImageHelper &&other)
: Resource(std::move(other)),
mImage(std::move(other.mImage)),
mDeviceMemory(std::move(other.mDeviceMemory)),
mImageType(other.mImageType),
mTilingMode(other.mTilingMode),
mCreateFlags(other.mCreateFlags),
mUsage(other.mUsage),
mExtents(other.mExtents),
mRotatedAspectRatio(other.mRotatedAspectRatio),
mIntendedFormatID(other.mIntendedFormatID),
mActualFormatID(other.mActualFormatID),
mSamples(other.mSamples),
mImageSerial(other.mImageSerial),
mCurrentLayout(other.mCurrentLayout),
mCurrentQueueFamilyIndex(other.mCurrentQueueFamilyIndex),
mLastNonShaderReadOnlyLayout(other.mLastNonShaderReadOnlyLayout),
mCurrentShaderReadStageMask(other.mCurrentShaderReadStageMask),
mYcbcrConversionDesc(other.mYcbcrConversionDesc),
mFirstAllocatedLevel(other.mFirstAllocatedLevel),
mLayerCount(other.mLayerCount),
mLevelCount(other.mLevelCount),
mSubresourceUpdates(std::move(other.mSubresourceUpdates)),
mCurrentSingleClearValue(std::move(other.mCurrentSingleClearValue)),
mContentDefined(std::move(other.mContentDefined)),
mStencilContentDefined(std::move(other.mStencilContentDefined)),
mImageAndViewGarbage(std::move(other.mImageAndViewGarbage))
{
ASSERT(this != &other);
other.resetCachedProperties();
}
ImageHelper::~ImageHelper()
{
ASSERT(!valid());
}
void ImageHelper::resetCachedProperties()
{
mImageType = VK_IMAGE_TYPE_2D;
mTilingMode = VK_IMAGE_TILING_OPTIMAL;
mCreateFlags = kVkImageCreateFlagsNone;
mUsage = 0;
mExtents = {};
mRotatedAspectRatio = false;
mIntendedFormatID = angle::FormatID::NONE;
mActualFormatID = angle::FormatID::NONE;
mSamples = 1;
mImageSerial = kInvalidImageSerial;
mCurrentLayout = ImageLayout::Undefined;
mCurrentQueueFamilyIndex = std::numeric_limits<uint32_t>::max();
mLastNonShaderReadOnlyLayout = ImageLayout::Undefined;
mCurrentShaderReadStageMask = 0;
mFirstAllocatedLevel = gl::LevelIndex(0);
mLayerCount = 0;
mLevelCount = 0;
mYcbcrConversionDesc.reset();
mCurrentSingleClearValue.reset();
mRenderPassUsageFlags.reset();
setEntireContentUndefined();
}
void ImageHelper::setEntireContentDefined()
{
for (LevelContentDefinedMask &levelContentDefined : mContentDefined)
{
levelContentDefined.set();
}
for (LevelContentDefinedMask &levelContentDefined : mStencilContentDefined)
{
levelContentDefined.set();
}
}
void ImageHelper::setEntireContentUndefined()
{
for (LevelContentDefinedMask &levelContentDefined : mContentDefined)
{
levelContentDefined.reset();
}
for (LevelContentDefinedMask &levelContentDefined : mStencilContentDefined)
{
levelContentDefined.reset();
}
// Note: this function is only called during init/release, so unlike
// invalidateSubresourceContentImpl, it doesn't attempt to make sure emulated formats have a
// clear staged.
}
void ImageHelper::setContentDefined(LevelIndex levelStart,
uint32_t levelCount,
uint32_t layerStart,
uint32_t layerCount,
VkImageAspectFlags aspectFlags)
{
// Mark the range as defined. Layers above 8 are discarded, and are always assumed to have
// defined contents.
if (layerStart >= kMaxContentDefinedLayerCount)
{
return;
}
uint8_t layerRangeBits =
GetContentDefinedLayerRangeBits(layerStart, layerCount, kMaxContentDefinedLayerCount);
for (uint32_t levelOffset = 0; levelOffset < levelCount; ++levelOffset)
{
LevelIndex level = levelStart + levelOffset;
if ((aspectFlags & ~VK_IMAGE_ASPECT_STENCIL_BIT) != 0)
{
getLevelContentDefined(level) |= layerRangeBits;
}
if ((aspectFlags & VK_IMAGE_ASPECT_STENCIL_BIT) != 0)
{
getLevelStencilContentDefined(level) |= layerRangeBits;
}
}
}
ImageHelper::LevelContentDefinedMask &ImageHelper::getLevelContentDefined(LevelIndex level)
{
return mContentDefined[level.get()];
}
ImageHelper::LevelContentDefinedMask &ImageHelper::getLevelStencilContentDefined(LevelIndex level)
{
return mStencilContentDefined[level.get()];
}
const ImageHelper::LevelContentDefinedMask &ImageHelper::getLevelContentDefined(
LevelIndex level) const
{
return mContentDefined[level.get()];
}
const ImageHelper::LevelContentDefinedMask &ImageHelper::getLevelStencilContentDefined(
LevelIndex level) const
{
return mStencilContentDefined[level.get()];
}
angle::Result ImageHelper::init(Context *context,
gl::TextureType textureType,
const VkExtent3D &extents,
const Format &format,
GLint samples,
VkImageUsageFlags usage,
gl::LevelIndex firstLevel,
uint32_t mipLevels,
uint32_t layerCount,
bool isRobustResourceInitEnabled,
bool hasProtectedContent)
{
return initExternal(context, textureType, extents, format.getIntendedFormatID(),
format.getActualRenderableImageFormatID(), samples, usage,
kVkImageCreateFlagsNone, ImageLayout::Undefined, nullptr, firstLevel,
mipLevels, layerCount, isRobustResourceInitEnabled, hasProtectedContent);
}
angle::Result ImageHelper::initMSAASwapchain(Context *context,
gl::TextureType textureType,
const VkExtent3D &extents,
bool rotatedAspectRatio,
const Format &format,
GLint samples,
VkImageUsageFlags usage,
gl::LevelIndex firstLevel,
uint32_t mipLevels,
uint32_t layerCount,
bool isRobustResourceInitEnabled,
bool hasProtectedContent)
{
ANGLE_TRY(initExternal(context, textureType, extents, format.getIntendedFormatID(),
format.getActualRenderableImageFormatID(), samples, usage,
kVkImageCreateFlagsNone, ImageLayout::Undefined, nullptr, firstLevel,
mipLevels, layerCount, isRobustResourceInitEnabled,
hasProtectedContent));
if (rotatedAspectRatio)
{
std::swap(mExtents.width, mExtents.height);
}
mRotatedAspectRatio = rotatedAspectRatio;
return angle::Result::Continue;
}
angle::Result ImageHelper::initExternal(Context *context,
gl::TextureType textureType,
const VkExtent3D &extents,
angle::FormatID intendedFormatID,
angle::FormatID actualFormatID,
GLint samples,
VkImageUsageFlags usage,
VkImageCreateFlags additionalCreateFlags,
ImageLayout initialLayout,
const void *externalImageCreateInfo,
gl::LevelIndex firstLevel,
uint32_t mipLevels,
uint32_t layerCount,
bool isRobustResourceInitEnabled,
bool hasProtectedContent)
{
ASSERT(!valid());
ASSERT(!IsAnySubresourceContentDefined(mContentDefined));
ASSERT(!IsAnySubresourceContentDefined(mStencilContentDefined));
RendererVk *rendererVk = context->getRenderer();
mImageType = gl_vk::GetImageType(textureType);
mExtents = extents;
mRotatedAspectRatio = false;
mIntendedFormatID = intendedFormatID;
mActualFormatID = actualFormatID;
mSamples = std::max(samples, 1);
mImageSerial = context->getRenderer()->getResourceSerialFactory().generateImageSerial();
mFirstAllocatedLevel = firstLevel;
mLevelCount = mipLevels;
mLayerCount = layerCount;
mCreateFlags = GetImageCreateFlags(textureType) | additionalCreateFlags;
mUsage = usage;
// Validate that mLayerCount is compatible with the texture type
ASSERT(textureType != gl::TextureType::_3D || mLayerCount == 1);
ASSERT(textureType != gl::TextureType::_2DArray || mExtents.depth == 1);
ASSERT(textureType != gl::TextureType::External || mLayerCount == 1);
ASSERT(textureType != gl::TextureType::Rectangle || mLayerCount == 1);
ASSERT(textureType != gl::TextureType::CubeMap || mLayerCount == gl::kCubeFaceCount);
ASSERT(textureType != gl::TextureType::CubeMapArray || mLayerCount % gl::kCubeFaceCount == 0);
// If externalImageCreateInfo is provided, use that directly. Otherwise derive the necessary
// pNext chain.
const void *imageCreateInfoPNext = externalImageCreateInfo;
VkImageFormatListCreateInfoKHR imageFormatListInfoStorage;
ImageListFormats imageListFormatsStorage;
if (externalImageCreateInfo == nullptr)
{
imageCreateInfoPNext =
DeriveCreateInfoPNext(context, actualFormatID, nullptr, &imageFormatListInfoStorage,
&imageListFormatsStorage, &mCreateFlags);
}
else
{
// Derive the tiling for external images.
deriveExternalImageTiling(externalImageCreateInfo);
}
mYcbcrConversionDesc.reset();
const angle::Format &actualFormat = angle::Format::Get(actualFormatID);
VkFormat actualVkFormat = GetVkFormatFromFormatID(actualFormatID);
if (actualFormat.isYUV)
{
// The Vulkan spec states: If sampler is used and the VkFormat of the image is a
// multi-planar format, the image must have been created with
// VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT
mCreateFlags |= VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT;
// The Vulkan spec states: The potential format features of the sampler YCBCR conversion
// must support VK_FORMAT_FEATURE_MIDPOINT_CHROMA_SAMPLES_BIT or
// VK_FORMAT_FEATURE_COSITED_CHROMA_SAMPLES_BIT
constexpr VkFormatFeatureFlags kChromaSubSampleFeatureBits =
VK_FORMAT_FEATURE_COSITED_CHROMA_SAMPLES_BIT |
VK_FORMAT_FEATURE_MIDPOINT_CHROMA_SAMPLES_BIT;
VkFormatFeatureFlags supportedChromaSubSampleFeatureBits =
rendererVk->getImageFormatFeatureBits(mActualFormatID, kChromaSubSampleFeatureBits);
VkChromaLocation supportedLocation = ((supportedChromaSubSampleFeatureBits &
VK_FORMAT_FEATURE_COSITED_CHROMA_SAMPLES_BIT) != 0)
? VK_CHROMA_LOCATION_COSITED_EVEN
: VK_CHROMA_LOCATION_MIDPOINT;
VkSamplerYcbcrModelConversion conversionModel = VK_SAMPLER_YCBCR_MODEL_CONVERSION_YCBCR_601;
VkSamplerYcbcrRange colorRange = VK_SAMPLER_YCBCR_RANGE_ITU_NARROW;
VkFilter chromaFilter = VK_FILTER_NEAREST;
VkComponentMapping components = {
VK_COMPONENT_SWIZZLE_IDENTITY,
VK_COMPONENT_SWIZZLE_IDENTITY,
VK_COMPONENT_SWIZZLE_IDENTITY,
VK_COMPONENT_SWIZZLE_IDENTITY,
};
// Create the VkSamplerYcbcrConversion to associate with image views and samplers
// Update the SamplerYcbcrConversionCache key
mYcbcrConversionDesc.update(rendererVk, 0, conversionModel, colorRange, supportedLocation,
supportedLocation, chromaFilter, components, intendedFormatID);
}
if (hasProtectedContent)
{
mCreateFlags |= VK_IMAGE_CREATE_PROTECTED_BIT;
}
VkImageCreateInfo imageInfo = {};
imageInfo.sType = VK_STRUCTURE_TYPE_IMAGE_CREATE_INFO;
imageInfo.pNext = imageCreateInfoPNext;
imageInfo.flags = mCreateFlags;
imageInfo.imageType = mImageType;
imageInfo.format = actualVkFormat;
imageInfo.extent = mExtents;
imageInfo.mipLevels = mLevelCount;
imageInfo.arrayLayers = mLayerCount;
imageInfo.samples = gl_vk::GetSamples(mSamples);
imageInfo.tiling = mTilingMode;
imageInfo.usage = mUsage;
imageInfo.sharingMode = VK_SHARING_MODE_EXCLUSIVE;
imageInfo.queueFamilyIndexCount = 0;
imageInfo.pQueueFamilyIndices = nullptr;
imageInfo.initialLayout = ConvertImageLayoutToVkImageLayout(initialLayout);
mCurrentLayout = initialLayout;
ANGLE_VK_TRY(context, mImage.init(context->getDevice(), imageInfo));
mVkImageCreateInfo = imageInfo;
mVkImageCreateInfo.pNext = nullptr;
mVkImageCreateInfo.initialLayout = VK_IMAGE_LAYOUT_UNDEFINED;
stageClearIfEmulatedFormat(isRobustResourceInitEnabled, externalImageCreateInfo != nullptr);
// Consider the contents defined for any image that has the PREINITIALIZED layout, or is
// imported from external.
if (initialLayout != ImageLayout::Undefined || externalImageCreateInfo != nullptr)
{
setEntireContentDefined();
}
return angle::Result::Continue;
}
const void *ImageHelper::DeriveCreateInfoPNext(
Context *context,
angle::FormatID actualFormatID,
const void *pNext,
VkImageFormatListCreateInfoKHR *imageFormatListInfoStorage,
std::array<VkFormat, kImageListFormatCount> *imageListFormatsStorage,
VkImageCreateFlags *createFlagsOut)
{
// With the introduction of sRGB related GLES extensions any sample/render target could be
// respecified causing it to be interpreted in a different colorspace. Create the VkImage
// accordingly.
RendererVk *rendererVk = context->getRenderer();
const angle::Format &actualFormat = angle::Format::Get(actualFormatID);
angle::FormatID additionalFormat =
actualFormat.isSRGB ? ConvertToLinear(actualFormatID) : ConvertToSRGB(actualFormatID);
(*imageListFormatsStorage)[0] = vk::GetVkFormatFromFormatID(actualFormatID);
(*imageListFormatsStorage)[1] = vk::GetVkFormatFromFormatID(additionalFormat);
if (rendererVk->getFeatures().supportsImageFormatList.enabled &&
rendererVk->haveSameFormatFeatureBits(actualFormatID, additionalFormat))
{
// Add VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT to VkImage create flag
*createFlagsOut |= VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT;
// There is just 1 additional format we might use to create a VkImageView for this
// VkImage
imageFormatListInfoStorage->sType = VK_STRUCTURE_TYPE_IMAGE_FORMAT_LIST_CREATE_INFO_KHR;
imageFormatListInfoStorage->pNext = pNext;
imageFormatListInfoStorage->viewFormatCount = kImageListFormatCount;
imageFormatListInfoStorage->pViewFormats = imageListFormatsStorage->data();
pNext = imageFormatListInfoStorage;
}
return pNext;
}
void ImageHelper::deriveExternalImageTiling(const void *createInfoChain)
{
const VkBaseInStructure *chain = reinterpret_cast<const VkBaseInStructure *>(createInfoChain);
while (chain != nullptr)
{
if (chain->sType == VK_STRUCTURE_TYPE_IMAGE_DRM_FORMAT_MODIFIER_LIST_CREATE_INFO_EXT ||
chain->sType == VK_STRUCTURE_TYPE_IMAGE_DRM_FORMAT_MODIFIER_EXPLICIT_CREATE_INFO_EXT)
{
mTilingMode = VK_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT;
return;
}
chain = reinterpret_cast<const VkBaseInStructure *>(chain->pNext);
}
}
void ImageHelper::releaseImage(RendererVk *renderer)
{
CollectGarbage(&mImageAndViewGarbage, &mImage, &mDeviceMemory);
// Notify us if the application pattern causes the views to keep getting reallocated and create
// infinite garbage
ASSERT(mImageAndViewGarbage.size() <= 1000);
releaseImageAndViewGarbage(renderer);
setEntireContentUndefined();
}
void ImageHelper::releaseImageFromShareContexts(RendererVk *renderer, ContextVk *contextVk)
{
if (contextVk && mImageSerial.valid())
{
const ContextVkSet &shareContextSet = contextVk->getShareGroupVk()->getContexts();
for (ContextVk *ctx : shareContextSet)
{
ctx->finalizeImageLayout(this);
}
}
releaseImage(renderer);
}
void ImageHelper::collectViewGarbage(RendererVk *renderer, vk::ImageViewHelper *imageView)
{
imageView->release(renderer, mImageAndViewGarbage);
// If we do not have any ImageHelper::mUse retained in ResourceUseList, make a cloned copy of
// ImageHelper::mUse and use it to free any garbage in mImageAndViewGarbage immediately.
if (!mUse.usedInRecordedCommands() && !mImageAndViewGarbage.empty())
{
// clone ImageHelper::mUse
rx::vk::SharedResourceUse clonedmUse;
clonedmUse.init();
clonedmUse.updateSerialOneOff(mUse.getSerial());
renderer->collectGarbage(std::move(clonedmUse), std::move(mImageAndViewGarbage));
}
ASSERT(mImageAndViewGarbage.size() <= 1000);
}
void ImageHelper::releaseStagedUpdates(RendererVk *renderer)
{
ASSERT(validateSubresourceUpdateRefCountsConsistent());
// Remove updates that never made it to the texture.
for (std::vector<SubresourceUpdate> &levelUpdates : mSubresourceUpdates)
{
for (SubresourceUpdate &update : levelUpdates)
{
update.release(renderer);
}
}
ASSERT(validateSubresourceUpdateRefCountsConsistent());
mSubresourceUpdates.clear();
mCurrentSingleClearValue.reset();
}
void ImageHelper::resetImageWeakReference()
{
mImage.reset();
mImageSerial = kInvalidImageSerial;
mRotatedAspectRatio = false;
}
void ImageHelper::releaseImageAndViewGarbage(RendererVk *renderer)
{
if (!mImageAndViewGarbage.empty())
{
renderer->collectGarbage(std::move(mUse), std::move(mImageAndViewGarbage));
}
else
{
mUse.release();
}
mUse.init();
mImageSerial = kInvalidImageSerial;
}
angle::Result ImageHelper::initializeNonZeroMemory(Context *context,
bool hasProtectedContent,
VkDeviceSize size)
{
const angle::Format &angleFormat = getActualFormat();
bool isCompressedFormat = angleFormat.isBlock;
if (angleFormat.isYUV)
{
// VUID-vkCmdClearColorImage-image-01545
// vkCmdClearColorImage(): format must not be one of the formats requiring sampler YCBCR
// conversion for VK_IMAGE_ASPECT_COLOR_BIT image views
return angle::Result::Continue;
}
RendererVk *renderer = context->getRenderer();
PrimaryCommandBuffer commandBuffer;
ANGLE_TRY(renderer->getCommandBufferOneOff(context, hasProtectedContent, &commandBuffer));
// Queue a DMA copy.
barrierImpl(context, getAspectFlags(), ImageLayout::TransferDst, mCurrentQueueFamilyIndex,
&commandBuffer);
StagingBuffer stagingBuffer;
if (isCompressedFormat)
{
// If format is compressed, set its contents through buffer copies.
// The staging buffer memory is non-zero-initialized in 'init'.
ANGLE_TRY(stagingBuffer.init(context, size, StagingUsage::Write));
for (LevelIndex level(0); level < LevelIndex(mLevelCount); ++level)
{
VkBufferImageCopy copyRegion = {};
gl_vk::GetExtent(getLevelExtents(level), &copyRegion.imageExtent);
copyRegion.imageSubresource.aspectMask = getAspectFlags();
copyRegion.imageSubresource.layerCount = mLayerCount;
// If image has depth and stencil, copy to each individually per Vulkan spec.
bool hasBothDepthAndStencil = isCombinedDepthStencilFormat();
if (hasBothDepthAndStencil)
{
copyRegion.imageSubresource.aspectMask = VK_IMAGE_ASPECT_DEPTH_BIT;
}
commandBuffer.copyBufferToImage(stagingBuffer.getBuffer().getHandle(), mImage,
VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, 1, &copyRegion);
if (hasBothDepthAndStencil)
{
copyRegion.imageSubresource.aspectMask = VK_IMAGE_ASPECT_STENCIL_BIT;
commandBuffer.copyBufferToImage(stagingBuffer.getBuffer().getHandle(), mImage,
VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, 1,
&copyRegion);
}
}
}
else
{
// Otherwise issue clear commands.
VkImageSubresourceRange subresource = {};
subresource.aspectMask = getAspectFlags();
subresource.baseMipLevel = 0;
subresource.levelCount = mLevelCount;
subresource.baseArrayLayer = 0;
subresource.layerCount = mLayerCount;
// Arbitrary value to initialize the memory with. Note: the given uint value, reinterpreted
// as float is about 0.7.
constexpr uint32_t kInitValue = 0x3F345678;
constexpr float kInitValueFloat = 0.12345f;
if ((subresource.aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) != 0)
{
VkClearColorValue clearValue;
clearValue.uint32[0] = kInitValue;
clearValue.uint32[1] = kInitValue;
clearValue.uint32[2] = kInitValue;
clearValue.uint32[3] = kInitValue;
commandBuffer.clearColorImage(mImage, getCurrentLayout(), clearValue, 1, &subresource);
}
else
{
VkClearDepthStencilValue clearValue;
clearValue.depth = kInitValueFloat;
clearValue.stencil = kInitValue;
commandBuffer.clearDepthStencilImage(mImage, getCurrentLayout(), clearValue, 1,
&subresource);
}
}
ANGLE_VK_TRY(context, commandBuffer.end());
Serial serial;
ANGLE_TRY(renderer->queueSubmitOneOff(context, std::move(commandBuffer), hasProtectedContent,
egl::ContextPriority::Medium, nullptr, 0, nullptr,
vk::SubmitPolicy::AllowDeferred, &serial));
if (isCompressedFormat)
{
stagingBuffer.collectGarbage(renderer, serial);
}
mUse.updateSerialOneOff(serial);
return angle::Result::Continue;
}
angle::Result ImageHelper::initMemory(Context *context,
bool hasProtectedContent,
const MemoryProperties &memoryProperties,
VkMemoryPropertyFlags flags)
{
// TODO(jmadill): Memory sub-allocation. http://anglebug.com/2162
VkDeviceSize size;
if (hasProtectedContent)
{
flags |= VK_MEMORY_PROPERTY_PROTECTED_BIT;
}
ANGLE_TRY(AllocateImageMemory(context, flags, &flags, nullptr, &mImage, &mDeviceMemory, &size));
mCurrentQueueFamilyIndex = context->getRenderer()->getQueueFamilyIndex();
RendererVk *renderer = context->getRenderer();
if (renderer->getFeatures().allocateNonZeroMemory.enabled)
{
// Can't map the memory. Use a staging resource.
if ((flags & VK_MEMORY_PROPERTY_HOST_VISIBLE_BIT) == 0)
{
ANGLE_TRY(initializeNonZeroMemory(context, hasProtectedContent, size));
}
}
return angle::Result::Continue;
}
angle::Result ImageHelper::initExternalMemory(Context *context,
const MemoryProperties &memoryProperties,
const VkMemoryRequirements &memoryRequirements,
uint32_t extraAllocationInfoCount,
const void **extraAllocationInfo,
uint32_t currentQueueFamilyIndex,
VkMemoryPropertyFlags flags)
{
// Vulkan allows up to 4 memory planes.
constexpr size_t kMaxMemoryPlanes = 4;
constexpr VkImageAspectFlagBits kMemoryPlaneAspects[kMaxMemoryPlanes] = {
VK_IMAGE_ASPECT_MEMORY_PLANE_0_BIT_EXT,
VK_IMAGE_ASPECT_MEMORY_PLANE_1_BIT_EXT,
VK_IMAGE_ASPECT_MEMORY_PLANE_2_BIT_EXT,
VK_IMAGE_ASPECT_MEMORY_PLANE_3_BIT_EXT,
};
ASSERT(extraAllocationInfoCount <= kMaxMemoryPlanes);
VkBindImagePlaneMemoryInfoKHR bindImagePlaneMemoryInfo = {};
bindImagePlaneMemoryInfo.sType = VK_STRUCTURE_TYPE_BIND_IMAGE_PLANE_MEMORY_INFO;
const VkBindImagePlaneMemoryInfoKHR *bindImagePlaneMemoryInfoPtr =
extraAllocationInfoCount == 1 ? nullptr : &bindImagePlaneMemoryInfo;
for (uint32_t memoryPlane = 0; memoryPlane < extraAllocationInfoCount; ++memoryPlane)
{
bindImagePlaneMemoryInfo.planeAspect = kMemoryPlaneAspects[memoryPlane];
ANGLE_TRY(AllocateImageMemoryWithRequirements(
context, flags, memoryRequirements, extraAllocationInfo[memoryPlane],
bindImagePlaneMemoryInfoPtr, &mImage, &mDeviceMemory));
}
mCurrentQueueFamilyIndex = currentQueueFamilyIndex;
return angle::Result::Continue;
}
angle::Result ImageHelper::initImageView(Context *context,
gl::TextureType textureType,
VkImageAspectFlags aspectMask,
const gl::SwizzleState &swizzleMap,
ImageView *imageViewOut,
LevelIndex baseMipLevelVk,
uint32_t levelCount)
{
return initLayerImageView(context, textureType, aspectMask, swizzleMap, imageViewOut,
baseMipLevelVk, levelCount, 0, mLayerCount,
gl::SrgbWriteControlMode::Default);
}
angle::Result ImageHelper::initLayerImageView(Context *context,
gl::TextureType textureType,
VkImageAspectFlags aspectMask,
const gl::SwizzleState &swizzleMap,
ImageView *imageViewOut,
LevelIndex baseMipLevelVk,
uint32_t levelCount,
uint32_t baseArrayLayer,
uint32_t layerCount,
gl::SrgbWriteControlMode mode) const
{
angle::FormatID actualFormat = mActualFormatID;
// If we are initializing an imageview for use with EXT_srgb_write_control, we need to override
// the format to its linear counterpart. Formats that cannot be reinterpreted are exempt from
// this requirement.
if (mode == gl::SrgbWriteControlMode::Linear)
{
angle::FormatID linearFormat = ConvertToLinear(actualFormat);
if (linearFormat != angle::FormatID::NONE)
{
actualFormat = linearFormat;
}
}
return initLayerImageViewImpl(context, textureType, aspectMask, swizzleMap, imageViewOut,
baseMipLevelVk, levelCount, baseArrayLayer, layerCount,
GetVkFormatFromFormatID(actualFormat), 0);
}
angle::Result ImageHelper::initLayerImageViewImpl(Context *context,
gl::TextureType textureType,
VkImageAspectFlags aspectMask,
const gl::SwizzleState &swizzleMap,
ImageView *imageViewOut,
LevelIndex baseMipLevelVk,
uint32_t levelCount,
uint32_t baseArrayLayer,
uint32_t layerCount,
VkFormat imageFormat,
VkImageUsageFlags usageFlags) const
{
VkImageViewCreateInfo viewInfo = {};
viewInfo.sType = VK_STRUCTURE_TYPE_IMAGE_VIEW_CREATE_INFO;
viewInfo.flags = 0;
viewInfo.image = mImage.getHandle();
viewInfo.viewType = gl_vk::GetImageViewType(textureType);
viewInfo.format = imageFormat;
if (swizzleMap.swizzleRequired() && !mYcbcrConversionDesc.valid())
{
viewInfo.components.r = gl_vk::GetSwizzle(swizzleMap.swizzleRed);
viewInfo.components.g = gl_vk::GetSwizzle(swizzleMap.swizzleGreen);
viewInfo.components.b = gl_vk::GetSwizzle(swizzleMap.swizzleBlue);
viewInfo.components.a = gl_vk::GetSwizzle(swizzleMap.swizzleAlpha);
}
else
{
viewInfo.components.r = VK_COMPONENT_SWIZZLE_IDENTITY;
viewInfo.components.g = VK_COMPONENT_SWIZZLE_IDENTITY;
viewInfo.components.b = VK_COMPONENT_SWIZZLE_IDENTITY;
viewInfo.components.a = VK_COMPONENT_SWIZZLE_IDENTITY;
}
viewInfo.subresourceRange.aspectMask = aspectMask;
viewInfo.subresourceRange.baseMipLevel = baseMipLevelVk.get();
viewInfo.subresourceRange.levelCount = levelCount;
viewInfo.subresourceRange.baseArrayLayer = baseArrayLayer;
viewInfo.subresourceRange.layerCount = layerCount;
VkImageViewUsageCreateInfo imageViewUsageCreateInfo = {};
if (usageFlags)
{
imageViewUsageCreateInfo.sType = VK_STRUCTURE_TYPE_IMAGE_VIEW_USAGE_CREATE_INFO;
imageViewUsageCreateInfo.usage = usageFlags;
viewInfo.pNext = &imageViewUsageCreateInfo;
}
VkSamplerYcbcrConversionInfo yuvConversionInfo = {};
if (mYcbcrConversionDesc.valid())
{
ASSERT((context->getRenderer()->getFeatures().supportsYUVSamplerConversion.enabled));
yuvConversionInfo.sType = VK_STRUCTURE_TYPE_SAMPLER_YCBCR_CONVERSION_INFO;
yuvConversionInfo.pNext = nullptr;
ANGLE_TRY(context->getRenderer()->getYuvConversionCache().getSamplerYcbcrConversion(
context, mYcbcrConversionDesc, &yuvConversionInfo.conversion));
AddToPNextChain(&viewInfo, &yuvConversionInfo);
// VUID-VkImageViewCreateInfo-image-02399
// If image has an external format, format must be VK_FORMAT_UNDEFINED
if (mYcbcrConversionDesc.getExternalFormat() != 0)
{
viewInfo.format = VK_FORMAT_UNDEFINED;
}
}
ANGLE_VK_TRY(context, imageViewOut->init(context->getDevice(), viewInfo));
return angle::Result::Continue;
}
angle::Result ImageHelper::initReinterpretedLayerImageView(Context *context,
gl::TextureType textureType,
VkImageAspectFlags aspectMask,
const gl::SwizzleState &swizzleMap,
ImageView *imageViewOut,
LevelIndex baseMipLevelVk,
uint32_t levelCount,
uint32_t baseArrayLayer,
uint32_t layerCount,
VkImageUsageFlags imageUsageFlags,
angle::FormatID imageViewFormat) const
{
VkImageUsageFlags usageFlags =
imageUsageFlags & GetMaximalImageUsageFlags(context->getRenderer(), imageViewFormat);
return initLayerImageViewImpl(context, textureType, aspectMask, swizzleMap, imageViewOut,
baseMipLevelVk, levelCount, baseArrayLayer, layerCount,
vk::GetVkFormatFromFormatID(imageViewFormat), usageFlags);
}
void ImageHelper::destroy(RendererVk *renderer)
{
// destroy any pending garbage objects (most likely from ImageViewHelper) at this point
for (GarbageObject &object : mImageAndViewGarbage)
{
object.destroy(renderer);
}
VkDevice device = renderer->getDevice();
mImage.destroy(device);
mDeviceMemory.destroy(device);
mCurrentLayout = ImageLayout::Undefined;
mImageType = VK_IMAGE_TYPE_2D;
mLayerCount = 0;
mLevelCount = 0;
setEntireContentUndefined();
}
void ImageHelper::init2DWeakReference(Context *context,
VkImage handle,
const gl::Extents &glExtents,
bool rotatedAspectRatio,
angle::FormatID intendedFormatID,
angle::FormatID actualFormatID,
GLint samples,
bool isRobustResourceInitEnabled)
{
ASSERT(!valid());
ASSERT(!IsAnySubresourceContentDefined(mContentDefined));
ASSERT(!IsAnySubresourceContentDefined(mStencilContentDefined));
gl_vk::GetExtent(glExtents, &mExtents);
mRotatedAspectRatio = rotatedAspectRatio;
mIntendedFormatID = intendedFormatID;
mActualFormatID = actualFormatID;
mSamples = std::max(samples, 1);
mImageSerial = context->getRenderer()->getResourceSerialFactory().generateImageSerial();
mCurrentQueueFamilyIndex = context->getRenderer()->getQueueFamilyIndex();
mCurrentLayout = ImageLayout::Undefined;
mLayerCount = 1;
mLevelCount = 1;
mImage.setHandle(handle);
stageClearIfEmulatedFormat(isRobustResourceInitEnabled, false);
}
angle::Result ImageHelper::init2DStaging(Context *context,
bool hasProtectedContent,
const MemoryProperties &memoryProperties,
const gl::Extents &glExtents,
angle::FormatID intendedFormatID,
angle::FormatID actualFormatID,
VkImageUsageFlags usage,
uint32_t layerCount)
{
gl_vk::GetExtent(glExtents, &mExtents);
return initStaging(context, hasProtectedContent, memoryProperties, VK_IMAGE_TYPE_2D, mExtents,
intendedFormatID, actualFormatID, 1, usage, 1, layerCount);
}
angle::Result ImageHelper::initStaging(Context *context,
bool hasProtectedContent,
const MemoryProperties &memoryProperties,
VkImageType imageType,
const VkExtent3D &extents,
angle::FormatID intendedFormatID,
angle::FormatID actualFormatID,
GLint samples,
VkImageUsageFlags usage,
uint32_t mipLevels,
uint32_t layerCount)
{
ASSERT(!valid());
ASSERT(!IsAnySubresourceContentDefined(mContentDefined));
ASSERT(!IsAnySubresourceContentDefined(mStencilContentDefined));
mImageType = imageType;
mExtents = extents;
mRotatedAspectRatio = false;
mIntendedFormatID = intendedFormatID;
mActualFormatID = actualFormatID;
mSamples = std::max(samples, 1);
mImageSerial = context->getRenderer()->getResourceSerialFactory().generateImageSerial();
mLayerCount = layerCount;
mLevelCount = mipLevels;
mUsage = usage;
// Validate that mLayerCount is compatible with the image type
ASSERT(imageType != VK_IMAGE_TYPE_3D || mLayerCount == 1);
ASSERT(imageType != VK_IMAGE_TYPE_2D || mExtents.depth == 1);
mCurrentLayout = ImageLayout::Undefined;
VkImageCreateInfo imageInfo = {};
imageInfo.sType = VK_STRUCTURE_TYPE_IMAGE_CREATE_INFO;
imageInfo.flags = hasProtectedContent ? VK_IMAGE_CREATE_PROTECTED_BIT : 0;
imageInfo.imageType = mImageType;
imageInfo.format = GetVkFormatFromFormatID(actualFormatID);
imageInfo.extent = mExtents;
imageInfo.mipLevels = mLevelCount;
imageInfo.arrayLayers = mLayerCount;
imageInfo.samples = gl_vk::GetSamples(mSamples);
imageInfo.tiling = VK_IMAGE_TILING_OPTIMAL;
imageInfo.usage = usage;
imageInfo.sharingMode = VK_SHARING_MODE_EXCLUSIVE;
imageInfo.queueFamilyIndexCount = 0;
imageInfo.pQueueFamilyIndices = nullptr;
imageInfo.initialLayout = getCurrentLayout();
ANGLE_VK_TRY(context, mImage.init(context->getDevice(), imageInfo));
mVkImageCreateInfo = imageInfo;
mVkImageCreateInfo.pNext = nullptr;
mVkImageCreateInfo.initialLayout = VK_IMAGE_LAYOUT_UNDEFINED;
// Allocate and bind device-local memory.
VkMemoryPropertyFlags memoryPropertyFlags = VK_MEMORY_PROPERTY_DEVICE_LOCAL_BIT;
if (hasProtectedContent)
{
memoryPropertyFlags |= VK_MEMORY_PROPERTY_PROTECTED_BIT;
}
ANGLE_TRY(initMemory(context, hasProtectedContent, memoryProperties, memoryPropertyFlags));
return angle::Result::Continue;
}
angle::Result ImageHelper::initImplicitMultisampledRenderToTexture(
Context *context,
bool hasProtectedContent,
const MemoryProperties &memoryProperties,
gl::TextureType textureType,
GLint samples,
const ImageHelper &resolveImage,
bool isRobustResourceInitEnabled)
{
ASSERT(!valid());
ASSERT(samples > 1);
ASSERT(!IsAnySubresourceContentDefined(mContentDefined));
ASSERT(!IsAnySubresourceContentDefined(mStencilContentDefined));
// The image is used as either color or depth/stencil attachment. Additionally, its memory is
// lazily allocated as the contents are discarded at the end of the renderpass and with tiling
// GPUs no actual backing memory is required.
//
// Note that the Vulkan image is created with or without VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT
// based on whether the memory that will be used to create the image would have
// VK_MEMORY_PROPERTY_LAZILY_ALLOCATED_BIT. TRANSIENT is provided if there is any memory that
// supports LAZILY_ALLOCATED. However, based on actual image requirements, such a memory may
// not be suitable for the image. We don't support such a case, which will result in the
// |initMemory| call below failing.
const bool hasLazilyAllocatedMemory = memoryProperties.hasLazilyAllocatedMemory();
const VkImageUsageFlags kMultisampledUsageFlags =
(hasLazilyAllocatedMemory ? VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT : 0) |
(resolveImage.getAspectFlags() == VK_IMAGE_ASPECT_COLOR_BIT
? VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT
: VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT);
const VkImageCreateFlags kMultisampledCreateFlags =
hasProtectedContent ? VK_IMAGE_CREATE_PROTECTED_BIT : 0;
ANGLE_TRY(initExternal(context, textureType, resolveImage.getExtents(),
resolveImage.getIntendedFormatID(), resolveImage.getActualFormatID(),
samples, kMultisampledUsageFlags, kMultisampledCreateFlags,
ImageLayout::Undefined, nullptr, resolveImage.getFirstAllocatedLevel(),
resolveImage.getLevelCount(), resolveImage.getLayerCount(),
isRobustResourceInitEnabled, hasProtectedContent));
// Remove the emulated format clear from the multisampled image if any. There is one already
// staged on the resolve image if needed.
removeStagedUpdates(context, getFirstAllocatedLevel(), getLastAllocatedLevel());
const VkMemoryPropertyFlags kMultisampledMemoryFlags =
VK_MEMORY_PROPERTY_DEVICE_LOCAL_BIT |
(hasLazilyAllocatedMemory ? VK_MEMORY_PROPERTY_LAZILY_ALLOCATED_BIT : 0) |
(hasProtectedContent ? VK_MEMORY_PROPERTY_PROTECTED_BIT : 0);
// If this ever fails, it can be retried without the LAZILY_ALLOCATED flag (which will probably
// still fail), but ideally that means GL_EXT_multisampled_render_to_texture should not be
// advertized on this platform in the first place.
return initMemory(context, hasProtectedContent, memoryProperties, kMultisampledMemoryFlags);
}
VkImageAspectFlags ImageHelper::getAspectFlags() const
{
return GetFormatAspectFlags(angle::Format::Get(mActualFormatID));
}
bool ImageHelper::isCombinedDepthStencilFormat() const
{
return (getAspectFlags() & kDepthStencilAspects) == kDepthStencilAspects;
}
VkImageLayout ImageHelper::getCurrentLayout() const
{
return ConvertImageLayoutToVkImageLayout(mCurrentLayout);
}
gl::Extents ImageHelper::getLevelExtents(LevelIndex levelVk) const
{
// Level 0 should be the size of the extents, after that every time you increase a level
// you shrink the extents by half.
uint32_t width = std::max(mExtents.width >> levelVk.get(), 1u);
uint32_t height = std::max(mExtents.height >> levelVk.get(), 1u);
uint32_t depth = std::max(mExtents.depth >> levelVk.get(), 1u);
return gl::Extents(width, height, depth);
}
gl::Extents ImageHelper::getLevelExtents2D(LevelIndex levelVk) const
{
gl::Extents extents = getLevelExtents(levelVk);
extents.depth = 1;
return extents;
}
const VkExtent3D ImageHelper::getRotatedExtents() const
{
VkExtent3D extents = mExtents;
if (mRotatedAspectRatio)
{
std::swap(extents.width, extents.height);
}
return extents;
}
gl::Extents ImageHelper::getRotatedLevelExtents2D(LevelIndex levelVk) const
{
gl::Extents extents = getLevelExtents2D(levelVk);
if (mRotatedAspectRatio)
{
std::swap(extents.width, extents.height);
}
return extents;
}
bool ImageHelper::isDepthOrStencil() const
{
return getActualFormat().hasDepthOrStencilBits();
}
void ImageHelper::setRenderPassUsageFlag(RenderPassUsage flag)
{
mRenderPassUsageFlags.set(flag);
}
void ImageHelper::clearRenderPassUsageFlag(RenderPassUsage flag)
{
mRenderPassUsageFlags.reset(flag);
}
void ImageHelper::resetRenderPassUsageFlags()
{
mRenderPassUsageFlags.reset();
}
bool ImageHelper::hasRenderPassUsageFlag(RenderPassUsage flag) const
{
return mRenderPassUsageFlags.test(flag);
}
bool ImageHelper::usedByCurrentRenderPassAsAttachmentAndSampler() const
{
return mRenderPassUsageFlags[RenderPassUsage::RenderTargetAttachment] &&
mRenderPassUsageFlags[RenderPassUsage::TextureSampler];
}
bool ImageHelper::isReadBarrierNecessary(ImageLayout newLayout) const
{
// If transitioning to a different layout, we need always need a barrier.
if (mCurrentLayout != newLayout)
{
return true;
}
// RAR (read-after-read) is not a hazard and doesn't require a barrier.
//
// RAW (read-after-write) hazards always require a memory barrier. This can only happen if the
// layout (same as new layout) is writable which in turn is only possible if the image is
// simultaneously bound for shader write (i.e. the layout is GENERAL or SHARED_PRESENT).
const ImageMemoryBarrierData &layoutData = kImageMemoryBarrierData[mCurrentLayout];
return layoutData.type == ResourceAccess::Write;
}
void ImageHelper::changeLayoutAndQueue(Context *context,
VkImageAspectFlags aspectMask,
ImageLayout newLayout,
uint32_t newQueueFamilyIndex,
OutsideRenderPassCommandBuffer *commandBuffer)
{
ASSERT(isQueueChangeNeccesary(newQueueFamilyIndex));
barrierImpl(context, aspectMask, newLayout, newQueueFamilyIndex, commandBuffer);
}
void ImageHelper::acquireFromExternal(ContextVk *contextVk,
uint32_t externalQueueFamilyIndex,
uint32_t rendererQueueFamilyIndex,
ImageLayout currentLayout,
OutsideRenderPassCommandBuffer *commandBuffer)
{
// The image must be newly allocated or have been released to the external
// queue. If this is not the case, it's an application bug, so ASSERT might
// eventually need to change to a warning.
ASSERT(mCurrentLayout == ImageLayout::ExternalPreInitialized ||
mCurrentQueueFamilyIndex == externalQueueFamilyIndex);
mCurrentLayout = currentLayout;
mCurrentQueueFamilyIndex = externalQueueFamilyIndex;
changeLayoutAndQueue(contextVk, getAspectFlags(), mCurrentLayout, rendererQueueFamilyIndex,
commandBuffer);
// It is unknown how the external has modified the image, so assume every subresource has
// defined content. That is unless the layout is Undefined.
if (currentLayout == ImageLayout::Undefined)
{
setEntireContentUndefined();
}
else
{
setEntireContentDefined();
}
}
void ImageHelper::releaseToExternal(ContextVk *contextVk,
uint32_t rendererQueueFamilyIndex,
uint32_t externalQueueFamilyIndex,
ImageLayout desiredLayout,
OutsideRenderPassCommandBuffer *commandBuffer)
{
ASSERT(mCurrentQueueFamilyIndex == rendererQueueFamilyIndex);
changeLayoutAndQueue(contextVk, getAspectFlags(), desiredLayout, externalQueueFamilyIndex,
commandBuffer);
}
bool ImageHelper::isReleasedToExternal() const
{
#if !defined(ANGLE_PLATFORM_MACOS) && !defined(ANGLE_PLATFORM_ANDROID)
return IsExternalQueueFamily(mCurrentQueueFamilyIndex);
#else
// TODO(anglebug.com/4635): Implement external memory barriers on Mac/Android.
return false;
#endif
}
LevelIndex ImageHelper::toVkLevel(gl::LevelIndex levelIndexGL) const
{
return gl_vk::GetLevelIndex(levelIndexGL, mFirstAllocatedLevel);
}
gl::LevelIndex ImageHelper::toGLLevel(LevelIndex levelIndexVk) const
{
return vk_gl::GetLevelIndex(levelIndexVk, mFirstAllocatedLevel);
}
ANGLE_INLINE void ImageHelper::initImageMemoryBarrierStruct(
VkImageAspectFlags aspectMask,
ImageLayout newLayout,
uint32_t newQueueFamilyIndex,
VkImageMemoryBarrier *imageMemoryBarrier) const
{
const ImageMemoryBarrierData &transitionFrom = kImageMemoryBarrierData[mCurrentLayout];
const ImageMemoryBarrierData &transitionTo = kImageMemoryBarrierData[newLayout];
imageMemoryBarrier->sType = VK_STRUCTURE_TYPE_IMAGE_MEMORY_BARRIER;
imageMemoryBarrier->srcAccessMask = transitionFrom.srcAccessMask;
imageMemoryBarrier->dstAccessMask = transitionTo.dstAccessMask;
imageMemoryBarrier->oldLayout = transitionFrom.layout;
imageMemoryBarrier->newLayout = transitionTo.layout;
imageMemoryBarrier->srcQueueFamilyIndex = mCurrentQueueFamilyIndex;
imageMemoryBarrier->dstQueueFamilyIndex = newQueueFamilyIndex;
imageMemoryBarrier->image = mImage.getHandle();
// Transition the whole resource.
imageMemoryBarrier->subresourceRange.aspectMask = aspectMask;
imageMemoryBarrier->subresourceRange.baseMipLevel = 0;
imageMemoryBarrier->subresourceRange.levelCount = mLevelCount;
imageMemoryBarrier->subresourceRange.baseArrayLayer = 0;
imageMemoryBarrier->subresourceRange.layerCount = mLayerCount;
}
// Generalized to accept both "primary" and "secondary" command buffers.
template <typename CommandBufferT>
void ImageHelper::barrierImpl(Context *context,
VkImageAspectFlags aspectMask,
ImageLayout newLayout,
uint32_t newQueueFamilyIndex,
CommandBufferT *commandBuffer)
{
if (mCurrentLayout == ImageLayout::SharedPresent)
{
const ImageMemoryBarrierData &transition = kImageMemoryBarrierData[mCurrentLayout];
VkMemoryBarrier memoryBarrier = {};
memoryBarrier.sType = VK_STRUCTURE_TYPE_MEMORY_BARRIER;
memoryBarrier.srcAccessMask = transition.srcAccessMask;
memoryBarrier.dstAccessMask = transition.dstAccessMask;
commandBuffer->memoryBarrier(transition.srcStageMask, transition.dstStageMask,
&memoryBarrier);
return;
}
// Make sure we never transition out of SharedPresent
ASSERT(mCurrentLayout != ImageLayout::SharedPresent || newLayout == ImageLayout::SharedPresent);
const ImageMemoryBarrierData &transitionFrom = kImageMemoryBarrierData[mCurrentLayout];
const ImageMemoryBarrierData &transitionTo = kImageMemoryBarrierData[newLayout];
VkImageMemoryBarrier imageMemoryBarrier = {};
initImageMemoryBarrierStruct(aspectMask, newLayout, newQueueFamilyIndex, &imageMemoryBarrier);
// There might be other shaderRead operations there other than the current layout.
VkPipelineStageFlags srcStageMask = GetImageLayoutSrcStageMask(context, transitionFrom);
if (mCurrentShaderReadStageMask)
{
srcStageMask |= mCurrentShaderReadStageMask;
mCurrentShaderReadStageMask = 0;
mLastNonShaderReadOnlyLayout = ImageLayout::Undefined;
}
commandBuffer->imageBarrier(srcStageMask, GetImageLayoutDstStageMask(context, transitionTo),
imageMemoryBarrier);
mCurrentLayout = newLayout;
mCurrentQueueFamilyIndex = newQueueFamilyIndex;
}
template void ImageHelper::barrierImpl<priv::CommandBuffer>(Context *context,
VkImageAspectFlags aspectMask,
ImageLayout newLayout,
uint32_t newQueueFamilyIndex,
priv::CommandBuffer *commandBuffer);
bool ImageHelper::updateLayoutAndBarrier(Context *context,
VkImageAspectFlags aspectMask,
ImageLayout newLayout,
PipelineBarrier *barrier)
{
// Once you transition to ImageLayout::SharedPresent, you never transition out of it.
if (mCurrentLayout == ImageLayout::SharedPresent)
{
newLayout = ImageLayout::SharedPresent;
}
bool barrierModified = false;
if (newLayout == mCurrentLayout)
{
const ImageMemoryBarrierData &layoutData = kImageMemoryBarrierData[mCurrentLayout];
// RAR is not a hazard and doesn't require a barrier, especially as the image layout hasn't
// changed. The following asserts that such a barrier is not attempted.
ASSERT(layoutData.type == ResourceAccess::Write);
// No layout change, only memory barrier is required
barrier->mergeMemoryBarrier(GetImageLayoutSrcStageMask(context, layoutData),
GetImageLayoutDstStageMask(context, layoutData),
layoutData.srcAccessMask, layoutData.dstAccessMask);
barrierModified = true;
}
else
{
const ImageMemoryBarrierData &transitionFrom = kImageMemoryBarrierData[mCurrentLayout];
const ImageMemoryBarrierData &transitionTo = kImageMemoryBarrierData[newLayout];
VkPipelineStageFlags srcStageMask = GetImageLayoutSrcStageMask(context, transitionFrom);
VkPipelineStageFlags dstStageMask = GetImageLayoutDstStageMask(context, transitionTo);
if ((transitionFrom.layout == transitionTo.layout) && IsShaderReadOnlyLayout(transitionTo))
{
// If we are switching between different shader stage reads, then there is no actual
// layout change or access type change. We only need a barrier if we are making a read
// that is from a new stage. Also note that we barrier against previous non-shaderRead
// layout. We do not barrier between one shaderRead and another shaderRead.
bool isNewReadStage = (mCurrentShaderReadStageMask & dstStageMask) != dstStageMask;
if (isNewReadStage)
{
const ImageMemoryBarrierData &layoutData =
kImageMemoryBarrierData[mLastNonShaderReadOnlyLayout];
barrier->mergeMemoryBarrier(GetImageLayoutSrcStageMask(context, layoutData),
dstStageMask, layoutData.srcAccessMask,
transitionTo.dstAccessMask);
barrierModified = true;
// Accumulate new read stage.
mCurrentShaderReadStageMask |= dstStageMask;
}
}
else
{
VkImageMemoryBarrier imageMemoryBarrier = {};
initImageMemoryBarrierStruct(aspectMask, newLayout, mCurrentQueueFamilyIndex,
&imageMemoryBarrier);
// if we transition from shaderReadOnly, we must add in stashed shader stage masks since
// there might be outstanding shader reads from stages other than current layout. We do
// not insert barrier between one shaderRead to another shaderRead
if (mCurrentShaderReadStageMask)
{
srcStageMask |= mCurrentShaderReadStageMask;
mCurrentShaderReadStageMask = 0;
mLastNonShaderReadOnlyLayout = ImageLayout::Undefined;
}
barrier->mergeImageBarrier(srcStageMask, dstStageMask, imageMemoryBarrier);
barrierModified = true;
// If we are transition into shaderRead layout, remember the last
// non-shaderRead layout here.
if (IsShaderReadOnlyLayout(transitionTo))
{
mLastNonShaderReadOnlyLayout = mCurrentLayout;
mCurrentShaderReadStageMask = dstStageMask;
}
}
mCurrentLayout = newLayout;
}
return barrierModified;
}
void ImageHelper::clearColor(const VkClearColorValue &color,
LevelIndex baseMipLevelVk,
uint32_t levelCount,
uint32_t baseArrayLayer,
uint32_t layerCount,
OutsideRenderPassCommandBuffer *commandBuffer)
{
ASSERT(valid());
ASSERT(mCurrentLayout == ImageLayout::TransferDst ||
mCurrentLayout == ImageLayout::SharedPresent);
VkImageSubresourceRange range = {};
range.aspectMask = VK_IMAGE_ASPECT_COLOR_BIT;
range.baseMipLevel = baseMipLevelVk.get();
range.levelCount = levelCount;
range.baseArrayLayer = baseArrayLayer;
range.layerCount = layerCount;
if (mImageType == VK_IMAGE_TYPE_3D)
{
ASSERT(baseArrayLayer == 0);
ASSERT(layerCount == 1 ||
layerCount == static_cast<uint32_t>(getLevelExtents(baseMipLevelVk).depth));
range.layerCount = 1;
}
commandBuffer->clearColorImage(mImage, getCurrentLayout(), color, 1, &range);
}
void ImageHelper::clearDepthStencil(VkImageAspectFlags clearAspectFlags,
const VkClearDepthStencilValue &depthStencil,
LevelIndex baseMipLevelVk,
uint32_t levelCount,
uint32_t baseArrayLayer,
uint32_t layerCount,
OutsideRenderPassCommandBuffer *commandBuffer)
{
ASSERT(valid());
ASSERT(mCurrentLayout == ImageLayout::TransferDst);
VkImageSubresourceRange range = {};
range.aspectMask = clearAspectFlags;
range.baseMipLevel = baseMipLevelVk.get();
range.levelCount = levelCount;
range.baseArrayLayer = baseArrayLayer;
range.layerCount = layerCount;
if (mImageType == VK_IMAGE_TYPE_3D)
{
ASSERT(baseArrayLayer == 0);
ASSERT(layerCount == 1 ||
layerCount == static_cast<uint32_t>(getLevelExtents(baseMipLevelVk).depth));
range.layerCount = 1;
}
commandBuffer->clearDepthStencilImage(mImage, getCurrentLayout(), depthStencil, 1, &range);
}
void ImageHelper::clear(VkImageAspectFlags aspectFlags,
const VkClearValue &value,
LevelIndex mipLevel,
uint32_t baseArrayLayer,
uint32_t layerCount,
OutsideRenderPassCommandBuffer *commandBuffer)
{
const angle::Format &angleFormat = getActualFormat();
bool isDepthStencil = angleFormat.depthBits > 0 || angleFormat.stencilBits > 0;
if (isDepthStencil)
{
clearDepthStencil(aspectFlags, value.depthStencil, mipLevel, 1, baseArrayLayer, layerCount,
commandBuffer);
}
else
{
ASSERT(!angleFormat.isBlock);
clearColor(value.color, mipLevel, 1, baseArrayLayer, layerCount, commandBuffer);
}
}
angle::Result ImageHelper::clearEmulatedChannels(ContextVk *contextVk,
VkColorComponentFlags colorMaskFlags,
const VkClearValue &value,
LevelIndex mipLevel,
uint32_t baseArrayLayer,
uint32_t layerCount)
{
const gl::Extents levelExtents = getLevelExtents(mipLevel);
if (levelExtents.depth > 1)
{
// Currently not implemented for 3D textures
UNIMPLEMENTED();
return angle::Result::Continue;
}
UtilsVk::ClearImageParameters params = {};
params.clearArea = {0, 0, levelExtents.width, levelExtents.height};
params.dstMip = mipLevel;
params.colorMaskFlags = colorMaskFlags;
params.colorClearValue = value.color;
for (uint32_t layerIndex = 0; layerIndex < layerCount; ++layerIndex)
{
params.dstLayer = baseArrayLayer + layerIndex;
ANGLE_TRY(contextVk->getUtils().clearImage(contextVk, this, params));
}
return angle::Result::Continue;
}
// static
void ImageHelper::Copy(ImageHelper *srcImage,
ImageHelper *dstImage,
const gl::Offset &srcOffset,
const gl::Offset &dstOffset,
const gl::Extents &copySize,
const VkImageSubresourceLayers &srcSubresource,
const VkImageSubresourceLayers &dstSubresource,
OutsideRenderPassCommandBuffer *commandBuffer)
{
ASSERT(commandBuffer->valid() && srcImage->valid() && dstImage->valid());
ASSERT(srcImage->getCurrentLayout() == VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL);
ASSERT(dstImage->getCurrentLayout() == VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL);
VkImageCopy region = {};
region.srcSubresource = srcSubresource;
region.srcOffset.x = srcOffset.x;
region.srcOffset.y = srcOffset.y;
region.srcOffset.z = srcOffset.z;
region.dstSubresource = dstSubresource;
region.dstOffset.x = dstOffset.x;
region.dstOffset.y = dstOffset.y;
region.dstOffset.z = dstOffset.z;
region.extent.width = copySize.width;
region.extent.height = copySize.height;
region.extent.depth = copySize.depth;
commandBuffer->copyImage(srcImage->getImage(), srcImage->getCurrentLayout(),
dstImage->getImage(), dstImage->getCurrentLayout(), 1, &region);
}
// static
angle::Result ImageHelper::CopyImageSubData(const gl::Context *context,
ImageHelper *srcImage,
GLint srcLevel,
GLint srcX,
GLint srcY,
GLint srcZ,
ImageHelper *dstImage,
GLint dstLevel,
GLint dstX,
GLint dstY,
GLint dstZ,
GLsizei srcWidth,
GLsizei srcHeight,
GLsizei srcDepth)
{
ContextVk *contextVk = GetImpl(context);
VkImageTiling srcTilingMode = srcImage->getTilingMode();
VkImageTiling destTilingMode = dstImage->getTilingMode();
const gl::LevelIndex srcLevelGL = gl::LevelIndex(srcLevel);
const gl::LevelIndex dstLevelGL = gl::LevelIndex(dstLevel);
if (CanCopyWithTransferForCopyImage(contextVk->getRenderer(), srcImage, srcTilingMode, dstImage,
destTilingMode))
{
bool isSrc3D = srcImage->getType() == VK_IMAGE_TYPE_3D;
bool isDst3D = dstImage->getType() == VK_IMAGE_TYPE_3D;
VkImageCopy region = {};
region.srcSubresource.aspectMask = VK_IMAGE_ASPECT_COLOR_BIT;
region.srcSubresource.mipLevel = srcImage->toVkLevel(srcLevelGL).get();
region.srcSubresource.baseArrayLayer = isSrc3D ? 0 : srcZ;
region.srcSubresource.layerCount = isSrc3D ? 1 : srcDepth;
region.dstSubresource.aspectMask = VK_IMAGE_ASPECT_COLOR_BIT;
region.dstSubresource.mipLevel = dstImage->toVkLevel(dstLevelGL).get();
region.dstSubresource.baseArrayLayer = isDst3D ? 0 : dstZ;
region.dstSubresource.layerCount = isDst3D ? 1 : srcDepth;
region.srcOffset.x = srcX;
region.srcOffset.y = srcY;
region.srcOffset.z = isSrc3D ? srcZ : 0;
region.dstOffset.x = dstX;
region.dstOffset.y = dstY;
region.dstOffset.z = isDst3D ? dstZ : 0;
region.extent.width = srcWidth;
region.extent.height = srcHeight;
region.extent.depth = (isSrc3D || isDst3D) ? srcDepth : 1;
CommandBufferAccess access;
access.onImageTransferRead(VK_IMAGE_ASPECT_COLOR_BIT, srcImage);
access.onImageTransferWrite(dstLevelGL, 1, region.dstSubresource.baseArrayLayer,
region.dstSubresource.layerCount, VK_IMAGE_ASPECT_COLOR_BIT,
dstImage);
OutsideRenderPassCommandBuffer *commandBuffer;
ANGLE_TRY(contextVk->getOutsideRenderPassCommandBuffer(access, &commandBuffer));
ASSERT(srcImage->valid() && dstImage->valid());
ASSERT(srcImage->getCurrentLayout() == VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL);
ASSERT(dstImage->getCurrentLayout() == VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL);
commandBuffer->copyImage(srcImage->getImage(), srcImage->getCurrentLayout(),
dstImage->getImage(), dstImage->getCurrentLayout(), 1, &region);
}
else if (!srcImage->getIntendedFormat().isBlock && !dstImage->getIntendedFormat().isBlock)
{
// The source and destination image formats may be using a fallback in the case of RGB
// images. A compute shader is used in such a case to perform the copy.
UtilsVk &utilsVk = contextVk->getUtils();
UtilsVk::CopyImageBitsParameters params;
params.srcOffset[0] = srcX;
params.srcOffset[1] = srcY;
params.srcOffset[2] = srcZ;
params.srcLevel = srcLevelGL;
params.dstOffset[0] = dstX;
params.dstOffset[1] = dstY;
params.dstOffset[2] = dstZ;
params.dstLevel = dstLevelGL;
params.copyExtents[0] = srcWidth;
params.copyExtents[1] = srcHeight;
params.copyExtents[2] = srcDepth;
ANGLE_TRY(utilsVk.copyImageBits(contextVk, dstImage, srcImage, params));
}
else
{
// No support for emulated compressed formats.
UNIMPLEMENTED();
ANGLE_VK_CHECK(contextVk, false, VK_ERROR_FEATURE_NOT_PRESENT);
}
return angle::Result::Continue;
}
angle::Result ImageHelper::generateMipmapsWithBlit(ContextVk *contextVk,
LevelIndex baseLevel,
LevelIndex maxLevel)
{
CommandBufferAccess access;
gl::LevelIndex baseLevelGL = toGLLevel(baseLevel);
access.onImageTransferWrite(baseLevelGL + 1, maxLevel.get(), 0, mLayerCount,
VK_IMAGE_ASPECT_COLOR_BIT, this);
OutsideRenderPassCommandBuffer *commandBuffer;
ANGLE_TRY(contextVk->getOutsideRenderPassCommandBuffer(access, &commandBuffer));
// We are able to use blitImage since the image format we are using supports it.
int32_t mipWidth = mExtents.width;
int32_t mipHeight = mExtents.height;
int32_t mipDepth = mExtents.depth;
// Manually manage the image memory barrier because it uses a lot more parameters than our
// usual one.
VkImageMemoryBarrier barrier = {};
barrier.sType = VK_STRUCTURE_TYPE_IMAGE_MEMORY_BARRIER;
barrier.image = mImage.getHandle();
barrier.srcQueueFamilyIndex = VK_QUEUE_FAMILY_IGNORED;
barrier.dstQueueFamilyIndex = VK_QUEUE_FAMILY_IGNORED;
barrier.subresourceRange.aspectMask = VK_IMAGE_ASPECT_COLOR_BIT;
barrier.subresourceRange.baseArrayLayer = 0;
barrier.subresourceRange.layerCount = mLayerCount;
barrier.subresourceRange.levelCount = 1;
const VkFilter filter =
gl_vk::GetFilter(CalculateGenerateMipmapFilter(contextVk, getActualFormatID()));
for (LevelIndex mipLevel(1); mipLevel <= LevelIndex(mLevelCount); ++mipLevel)
{
int32_t nextMipWidth = std::max<int32_t>(1, mipWidth >> 1);
int32_t nextMipHeight = std::max<int32_t>(1, mipHeight >> 1);
int32_t nextMipDepth = std::max<int32_t>(1, mipDepth >> 1);
if (mipLevel > baseLevel && mipLevel <= maxLevel)
{
barrier.subresourceRange.baseMipLevel = mipLevel.get() - 1;
barrier.oldLayout = getCurrentLayout();
barrier.newLayout = VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL;
barrier.srcAccessMask = VK_ACCESS_TRANSFER_WRITE_BIT;
barrier.dstAccessMask = VK_ACCESS_TRANSFER_READ_BIT;
// We can do it for all layers at once.
commandBuffer->imageBarrier(VK_PIPELINE_STAGE_TRANSFER_BIT,
VK_PIPELINE_STAGE_TRANSFER_BIT, barrier);
VkImageBlit blit = {};
blit.srcOffsets[0] = {0, 0, 0};
blit.srcOffsets[1] = {mipWidth, mipHeight, mipDepth};
blit.srcSubresource.aspectMask = VK_IMAGE_ASPECT_COLOR_BIT;
blit.srcSubresource.mipLevel = mipLevel.get() - 1;
blit.srcSubresource.baseArrayLayer = 0;
blit.srcSubresource.layerCount = mLayerCount;
blit.dstOffsets[0] = {0, 0, 0};
blit.dstOffsets[1] = {nextMipWidth, nextMipHeight, nextMipDepth};
blit.dstSubresource.aspectMask = VK_IMAGE_ASPECT_COLOR_BIT;
blit.dstSubresource.mipLevel = mipLevel.get();
blit.dstSubresource.baseArrayLayer = 0;
blit.dstSubresource.layerCount = mLayerCount;
commandBuffer->blitImage(mImage, VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, mImage,
VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, 1, &blit, filter);
}
mipWidth = nextMipWidth;
mipHeight = nextMipHeight;
mipDepth = nextMipDepth;
}
// Transition all mip level to the same layout so we can declare our whole image layout to one
// ImageLayout. FragmentShaderReadOnly is picked here since this is the most reasonable usage
// after glGenerateMipmap call.
barrier.oldLayout = VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL;
barrier.newLayout = VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL;
barrier.dstAccessMask = VK_ACCESS_SHADER_READ_BIT;
if (baseLevel.get() > 0)
{
// [0:baseLevel-1] from TRANSFER_DST to SHADER_READ
barrier.subresourceRange.baseMipLevel = 0;
barrier.subresourceRange.levelCount = baseLevel.get();
commandBuffer->imageBarrier(VK_PIPELINE_STAGE_TRANSFER_BIT,
VK_PIPELINE_STAGE_FRAGMENT_SHADER_BIT, barrier);
}
// [maxLevel:mLevelCount-1] from TRANSFER_DST to SHADER_READ
ASSERT(mLevelCount > maxLevel.get());
barrier.subresourceRange.baseMipLevel = maxLevel.get();
barrier.subresourceRange.levelCount = mLevelCount - maxLevel.get();
commandBuffer->imageBarrier(VK_PIPELINE_STAGE_TRANSFER_BIT,
VK_PIPELINE_STAGE_FRAGMENT_SHADER_BIT, barrier);
// [baseLevel:maxLevel-1] from TRANSFER_SRC to SHADER_READ
barrier.oldLayout = VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL;
barrier.subresourceRange.baseMipLevel = baseLevel.get();
barrier.subresourceRange.levelCount = maxLevel.get() - baseLevel.get();
commandBuffer->imageBarrier(VK_PIPELINE_STAGE_TRANSFER_BIT,
VK_PIPELINE_STAGE_FRAGMENT_SHADER_BIT, barrier);
// This is just changing the internal state of the image helper so that the next call
// to changeLayout will use this layout as the "oldLayout" argument.
// mLastNonShaderReadOnlyLayout is used to ensure previous write are made visible to reads,
// since the only write here is transfer, hence mLastNonShaderReadOnlyLayout is set to
// ImageLayout::TransferDst.
mLastNonShaderReadOnlyLayout = ImageLayout::TransferDst;
mCurrentShaderReadStageMask = VK_PIPELINE_STAGE_FRAGMENT_SHADER_BIT;
mCurrentLayout = ImageLayout::FragmentShaderReadOnly;
return angle::Result::Continue;
}
void ImageHelper::resolve(ImageHelper *dst,
const VkImageResolve &region,
OutsideRenderPassCommandBuffer *commandBuffer)
{
ASSERT(mCurrentLayout == ImageLayout::TransferSrc ||
mCurrentLayout == ImageLayout::SharedPresent);
commandBuffer->resolveImage(getImage(), VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, dst->getImage(),
VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, 1, &region);
}
void ImageHelper::removeSingleSubresourceStagedUpdates(ContextVk *contextVk,
gl::LevelIndex levelIndexGL,
uint32_t layerIndex,
uint32_t layerCount)
{
mCurrentSingleClearValue.reset();
// Find any staged updates for this index and remove them from the pending list.
std::vector<SubresourceUpdate> *levelUpdates = getLevelUpdates(levelIndexGL);
if (levelUpdates == nullptr)
{
return;
}
for (size_t index = 0; index < levelUpdates->size();)
{
auto update = levelUpdates->begin() + index;
if (update->isUpdateToLayers(layerIndex, layerCount))
{
update->release(contextVk->getRenderer());
levelUpdates->erase(update);
}
else
{
index++;
}
}
}
void ImageHelper::removeSingleStagedClearAfterInvalidate(gl::LevelIndex levelIndexGL,
uint32_t layerIndex,
uint32_t layerCount)
{
// When this function is called, it's expected that there may be at most one
// ClearAfterInvalidate update pending to this subresource, and that's a color clear due to
// emulated channels after invalidate. This function removes that update.
std::vector<SubresourceUpdate> *levelUpdates = getLevelUpdates(levelIndexGL);
if (levelUpdates == nullptr)
{
return;
}
for (size_t index = 0; index < levelUpdates->size(); ++index)
{
auto update = levelUpdates->begin() + index;
if (update->updateSource == UpdateSource::ClearAfterInvalidate &&
update->isUpdateToLayers(layerIndex, layerCount))
{
// It's a clear, so doesn't need to be released.
levelUpdates->erase(update);
// There's only one such clear possible.
return;
}
}
}
void ImageHelper::removeStagedUpdates(Context *context,
gl::LevelIndex levelGLStart,
gl::LevelIndex levelGLEnd)
{
ASSERT(validateSubresourceUpdateRefCountsConsistent());
// Remove all updates to levels [start, end].
for (gl::LevelIndex level = levelGLStart; level <= levelGLEnd; ++level)
{
std::vector<SubresourceUpdate> *levelUpdates = getLevelUpdates(level);
if (levelUpdates == nullptr)
{
ASSERT(static_cast<size_t>(level.get()) >= mSubresourceUpdates.size());
return;
}
for (SubresourceUpdate &update : *levelUpdates)
{
update.release(context->getRenderer());
}
levelUpdates->clear();
}
ASSERT(validateSubresourceUpdateRefCountsConsistent());
}
angle::Result ImageHelper::stageSubresourceUpdateImpl(ContextVk *contextVk,
const gl::ImageIndex &index,
const gl::Extents &glExtents,
const gl::Offset &offset,
const gl::InternalFormat &formatInfo,
const gl::PixelUnpackState &unpack,
GLenum type,
const uint8_t *pixels,
const Format &vkFormat,
ImageAccess access,
const GLuint inputRowPitch,
const GLuint inputDepthPitch,
const GLuint inputSkipBytes)
{
const angle::Format &storageFormat = vkFormat.getActualImageFormat(access);
size_t outputRowPitch;
size_t outputDepthPitch;
size_t stencilAllocationSize = 0;
uint32_t bufferRowLength;
uint32_t bufferImageHeight;
size_t allocationSize;
LoadImageFunctionInfo loadFunctionInfo = vkFormat.getTextureLoadFunction(access, type);
LoadImageFunction stencilLoadFunction = nullptr;
if (storageFormat.isBlock)
{
const gl::InternalFormat &storageFormatInfo = vkFormat.getInternalFormatInfo(type);
GLuint rowPitch;
GLuint depthPitch;
GLuint totalSize;
ANGLE_VK_CHECK_MATH(contextVk, storageFormatInfo.computeCompressedImageSize(
gl::Extents(glExtents.width, 1, 1), &rowPitch));
ANGLE_VK_CHECK_MATH(contextVk,
storageFormatInfo.computeCompressedImageSize(
gl::Extents(glExtents.width, glExtents.height, 1), &depthPitch));
ANGLE_VK_CHECK_MATH(contextVk,
storageFormatInfo.computeCompressedImageSize(glExtents, &totalSize));
outputRowPitch = rowPitch;
outputDepthPitch = depthPitch;
allocationSize = totalSize;
ANGLE_VK_CHECK_MATH(
contextVk, storageFormatInfo.computeBufferRowLength(glExtents.width, &bufferRowLength));
ANGLE_VK_CHECK_MATH(contextVk, storageFormatInfo.computeBufferImageHeight(
glExtents.height, &bufferImageHeight));
}
else
{
ASSERT(storageFormat.pixelBytes != 0);
if (storageFormat.id == angle::FormatID::D24_UNORM_S8_UINT)
{
stencilLoadFunction = angle::LoadX24S8ToS8;
}
if (storageFormat.id == angle::FormatID::D32_FLOAT_S8X24_UINT)
{
// If depth is D32FLOAT_S8, we must pack D32F tightly (no stencil) for CopyBufferToImage
outputRowPitch = sizeof(float) * glExtents.width;
// The generic load functions don't handle tightly packing D32FS8 to D32F & S8 so call
// special case load functions.
switch (type)
{
case GL_UNSIGNED_INT:
loadFunctionInfo.loadFunction = angle::LoadD32ToD32F;
stencilLoadFunction = nullptr;
break;
case GL_DEPTH32F_STENCIL8:
case GL_FLOAT_32_UNSIGNED_INT_24_8_REV:
loadFunctionInfo.loadFunction = angle::LoadD32FS8X24ToD32F;
stencilLoadFunction = angle::LoadX32S8ToS8;
break;
case GL_UNSIGNED_INT_24_8_OES:
loadFunctionInfo.loadFunction = angle::LoadD24S8ToD32F;
stencilLoadFunction = angle::LoadX24S8ToS8;
break;
default:
UNREACHABLE();
}
}
else
{
outputRowPitch = storageFormat.pixelBytes * glExtents.width;
}
outputDepthPitch = outputRowPitch * glExtents.height;
bufferRowLength = glExtents.width;
bufferImageHeight = glExtents.height;
allocationSize = outputDepthPitch * glExtents.depth;
// Note: because the LoadImageFunctionInfo functions are limited to copying a single
// component, we have to special case packed depth/stencil use and send the stencil as a
// separate chunk.
if (storageFormat.depthBits > 0 && storageFormat.stencilBits > 0 &&
formatInfo.depthBits > 0 && formatInfo.stencilBits > 0)
{
// Note: Stencil is always one byte
stencilAllocationSize = glExtents.width * glExtents.height * glExtents.depth;
allocationSize += stencilAllocationSize;
}
}
std::unique_ptr<RefCounted<BufferHelper>> stagingBuffer =
std::make_unique<RefCounted<BufferHelper>>();
BufferHelper *currentBuffer = &stagingBuffer->get();
uint8_t *stagingPointer;
VkDeviceSize stagingOffset;
ANGLE_TRY(currentBuffer->allocateForCopyImage(contextVk, allocationSize,
MemoryCoherency::NonCoherent, storageFormat.id,
&stagingOffset, &stagingPointer));
const uint8_t *source = pixels + static_cast<ptrdiff_t>(inputSkipBytes);
loadFunctionInfo.loadFunction(glExtents.width, glExtents.height, glExtents.depth, source,
inputRowPitch, inputDepthPitch, stagingPointer, outputRowPitch,
outputDepthPitch);
// YUV formats need special handling.
if (storageFormat.isYUV)
{
gl::YuvFormatInfo yuvInfo(formatInfo.internalFormat, glExtents);
constexpr VkImageAspectFlagBits kPlaneAspectFlags[3] = {
VK_IMAGE_ASPECT_PLANE_0_BIT, VK_IMAGE_ASPECT_PLANE_1_BIT, VK_IMAGE_ASPECT_PLANE_2_BIT};
// We only support mip level 0 and layerCount of 1 for YUV formats.
ASSERT(index.getLevelIndex() == 0);
ASSERT(index.getLayerCount() == 1);
for (uint32_t plane = 0; plane < yuvInfo.planeCount; plane++)
{
VkBufferImageCopy copy = {};
copy.bufferOffset = stagingOffset + yuvInfo.planeOffset[plane];
copy.bufferRowLength = 0;
copy.bufferImageHeight = 0;
copy.imageSubresource.mipLevel = 0;
copy.imageSubresource.layerCount = 1;
gl_vk::GetOffset(offset, &copy.imageOffset);
gl_vk::GetExtent(yuvInfo.planeExtent[plane], &copy.imageExtent);
copy.imageSubresource.baseArrayLayer = 0;
copy.imageSubresource.aspectMask = kPlaneAspectFlags[plane];
appendSubresourceUpdate(
gl::LevelIndex(0),
SubresourceUpdate(stagingBuffer.get(), currentBuffer, copy, storageFormat.id));
}
stagingBuffer.release();
return angle::Result::Continue;
}
VkBufferImageCopy copy = {};
VkImageAspectFlags aspectFlags = GetFormatAspectFlags(storageFormat);
copy.bufferOffset = stagingOffset;
copy.bufferRowLength = bufferRowLength;
copy.bufferImageHeight = bufferImageHeight;
gl::LevelIndex updateLevelGL(index.getLevelIndex());
copy.imageSubresource.mipLevel = updateLevelGL.get();
copy.imageSubresource.layerCount = index.getLayerCount();
gl_vk::GetOffset(offset, &copy.imageOffset);
gl_vk::GetExtent(glExtents, &copy.imageExtent);
if (gl::IsArrayTextureType(index.getType()))
{
copy.imageSubresource.baseArrayLayer = offset.z;
copy.imageOffset.z = 0;
copy.imageExtent.depth = 1;
}
else
{
copy.imageSubresource.baseArrayLayer = index.hasLayer() ? index.getLayerIndex() : 0;
}
if (stencilAllocationSize > 0)
{
// Note: Stencil is always one byte
ASSERT((aspectFlags & VK_IMAGE_ASPECT_STENCIL_BIT) != 0);
// Skip over depth data.
stagingPointer += outputDepthPitch * glExtents.depth;
stagingOffset += outputDepthPitch * glExtents.depth;
// recompute pitch for stencil data
outputRowPitch = glExtents.width;
outputDepthPitch = outputRowPitch * glExtents.height;
ASSERT(stencilLoadFunction != nullptr);
stencilLoadFunction(glExtents.width, glExtents.height, glExtents.depth, source,
inputRowPitch, inputDepthPitch, stagingPointer, outputRowPitch,
outputDepthPitch);
VkBufferImageCopy stencilCopy = {};
stencilCopy.bufferOffset = stagingOffset;
stencilCopy.bufferRowLength = bufferRowLength;
stencilCopy.bufferImageHeight = bufferImageHeight;
stencilCopy.imageSubresource.mipLevel = copy.imageSubresource.mipLevel;
stencilCopy.imageSubresource.baseArrayLayer = copy.imageSubresource.baseArrayLayer;
stencilCopy.imageSubresource.layerCount = copy.imageSubresource.layerCount;
stencilCopy.imageOffset = copy.imageOffset;
stencilCopy.imageExtent = copy.imageExtent;
stencilCopy.imageSubresource.aspectMask = VK_IMAGE_ASPECT_STENCIL_BIT;
appendSubresourceUpdate(updateLevelGL, SubresourceUpdate(stagingBuffer.get(), currentBuffer,
stencilCopy, storageFormat.id));
aspectFlags &= ~VK_IMAGE_ASPECT_STENCIL_BIT;
}
if (HasBothDepthAndStencilAspects(aspectFlags))
{
// We still have both depth and stencil aspect bits set. That means we have a destination
// buffer that is packed depth stencil and that the application is only loading one aspect.
// Figure out which aspect the user is touching and remove the unused aspect bit.
if (formatInfo.stencilBits > 0)
{
aspectFlags &= ~VK_IMAGE_ASPECT_DEPTH_BIT;
}
else
{
aspectFlags &= ~VK_IMAGE_ASPECT_STENCIL_BIT;
}
}
if (aspectFlags)
{
copy.imageSubresource.aspectMask = aspectFlags;
appendSubresourceUpdate(updateLevelGL, SubresourceUpdate(stagingBuffer.get(), currentBuffer,
copy, storageFormat.id));
}
stagingBuffer.release();
return angle::Result::Continue;
}
angle::Result ImageHelper::reformatStagedBufferUpdates(ContextVk *contextVk,
angle::FormatID srcFormatID,
angle::FormatID dstFormatID)
{
RendererVk *renderer = contextVk->getRenderer();
const angle::Format &srcFormat = angle::Format::Get(srcFormatID);
const angle::Format &dstFormat = angle::Format::Get(dstFormatID);
const gl::InternalFormat &dstFormatInfo =
gl::GetSizedInternalFormatInfo(dstFormat.glInternalFormat);
for (std::vector<SubresourceUpdate> &levelUpdates : mSubresourceUpdates)
{
for (SubresourceUpdate &update : levelUpdates)
{
// Right now whenever we stage update from a source image, the formats always match.
ASSERT(valid() || update.updateSource != UpdateSource::Image ||
update.data.image.formatID == srcFormatID);
if (update.updateSource == UpdateSource::Buffer &&
update.data.buffer.formatID == srcFormatID)
{
const VkBufferImageCopy &copy = update.data.buffer.copyRegion;
// Source and dst data are tightly packed
GLuint srcDataRowPitch = copy.imageExtent.width * srcFormat.pixelBytes;
GLuint dstDataRowPitch = copy.imageExtent.width * dstFormat.pixelBytes;
GLuint srcDataDepthPitch = srcDataRowPitch * copy.imageExtent.height;
GLuint dstDataDepthPitch = dstDataRowPitch * copy.imageExtent.height;
// Retrieve source buffer
vk::BufferHelper *srcBuffer = update.data.buffer.bufferHelper;
ASSERT(srcBuffer->isMapped());
// The bufferOffset is relative to the buffer block. We have to use the buffer
// block's memory pointer to get the source data pointer.
uint8_t *srcData = srcBuffer->getBlockMemory() + copy.bufferOffset;
// Allocate memory with dstFormat
std::unique_ptr<RefCounted<BufferHelper>> stagingBuffer =
std::make_unique<RefCounted<BufferHelper>>();
BufferHelper *dstBuffer = &stagingBuffer->get();
uint8_t *dstData;
VkDeviceSize dstBufferOffset;
size_t dstBufferSize = dstDataDepthPitch * copy.imageExtent.depth;
ANGLE_TRY(dstBuffer->allocateForCopyImage(contextVk, dstBufferSize,
MemoryCoherency::NonCoherent, dstFormatID,
&dstBufferOffset, &dstData));
rx::PixelReadFunction pixelReadFunction = srcFormat.pixelReadFunction;
rx::PixelWriteFunction pixelWriteFunction = dstFormat.pixelWriteFunction;
CopyImageCHROMIUM(srcData, srcDataRowPitch, srcFormat.pixelBytes, srcDataDepthPitch,
pixelReadFunction, dstData, dstDataRowPitch, dstFormat.pixelBytes,
dstDataDepthPitch, pixelWriteFunction, dstFormatInfo.format,
dstFormatInfo.componentType, copy.imageExtent.width,
copy.imageExtent.height, copy.imageExtent.depth, false, false,
false);
// Replace srcBuffer with dstBuffer
update.data.buffer.bufferHelper = dstBuffer;
update.data.buffer.formatID = dstFormatID;
update.data.buffer.copyRegion.bufferOffset = dstBufferOffset;
// Let update structure owns the staging buffer
if (update.refCounted.buffer)
{
update.refCounted.buffer->releaseRef();
if (!update.refCounted.buffer->isReferenced())
{
update.refCounted.buffer->get().release(renderer);
SafeDelete(update.refCounted.buffer);
}
}
update.refCounted.buffer = stagingBuffer.release();
update.refCounted.buffer->addRef();
}
}
}
return angle::Result::Continue;
}
angle::Result ImageHelper::CalculateBufferInfo(ContextVk *contextVk,
const gl::Extents &glExtents,
const gl::InternalFormat &formatInfo,
const gl::PixelUnpackState &unpack,
GLenum type,
bool is3D,
GLuint *inputRowPitch,
GLuint *inputDepthPitch,
GLuint *inputSkipBytes)
{
// YUV formats need special handling.
if (gl::IsYuvFormat(formatInfo.internalFormat))
{
gl::YuvFormatInfo yuvInfo(formatInfo.internalFormat, glExtents);
// row pitch = Y plane row pitch
*inputRowPitch = yuvInfo.planePitch[0];
// depth pitch = Y plane size + chroma plane size
*inputDepthPitch = yuvInfo.planeSize[0] + yuvInfo.planeSize[1] + yuvInfo.planeSize[2];
*inputSkipBytes = 0;
return angle::Result::Continue;
}
ANGLE_VK_CHECK_MATH(contextVk,
formatInfo.computeRowPitch(type, glExtents.width, unpack.alignment,
unpack.rowLength, inputRowPitch));
ANGLE_VK_CHECK_MATH(contextVk,
formatInfo.computeDepthPitch(glExtents.height, unpack.imageHeight,
*inputRowPitch, inputDepthPitch));
ANGLE_VK_CHECK_MATH(
contextVk, formatInfo.computeSkipBytes(type, *inputRowPitch, *inputDepthPitch, unpack, is3D,
inputSkipBytes));
return angle::Result::Continue;
}
void ImageHelper::onWrite(gl::LevelIndex levelStart,
uint32_t levelCount,
uint32_t layerStart,
uint32_t layerCount,
VkImageAspectFlags aspectFlags)
{
mCurrentSingleClearValue.reset();
// Mark contents of the given subresource as defined.
setContentDefined(toVkLevel(levelStart), levelCount, layerStart, layerCount, aspectFlags);
}
void ImageHelper::updateImmutableSamplerState(const gl::SamplerState &samplerState)
{
// VUID-VkSamplerCreateInfo-minFilter VkCreateSampler:
// VK_FORMAT_FEATURE_SAMPLED_IMAGE_YCBCR_CONVERSION_SEPARATE_RECONSTRUCTION_FILTER_BIT
// specifies that the format can have different chroma, min, and mag filters. However,
// VK_FORMAT_FEATURE_SAMPLED_IMAGE_YCBCR_CONVERSION_SEPARATE_RECONSTRUCTION_FILTER_BIT is
// not supported for VkSamplerYcbcrConversionCreateInfo.format = VK_FORMAT_UNDEFINED so
// chromaFilter needs to be equal to minFilter/magFilter.
if (mYcbcrConversionDesc.getExternalFormat() != 0)
{
ASSERT(samplerState.getMinFilter() == samplerState.getMagFilter());
mYcbcrConversionDesc.updateChromaFilter(gl_vk::GetFilter(samplerState.getMinFilter()));
}
}
bool ImageHelper::hasSubresourceDefinedContent(gl::LevelIndex level,
uint32_t layerIndex,
uint32_t layerCount) const
{
if (layerIndex >= kMaxContentDefinedLayerCount)
{
return true;
}
uint8_t layerRangeBits =
GetContentDefinedLayerRangeBits(layerIndex, layerCount, kMaxContentDefinedLayerCount);
return (getLevelContentDefined(toVkLevel(level)) & LevelContentDefinedMask(layerRangeBits))
.any();
}
bool ImageHelper::hasSubresourceDefinedStencilContent(gl::LevelIndex level,
uint32_t layerIndex,
uint32_t layerCount) const
{
if (layerIndex >= kMaxContentDefinedLayerCount)
{
return true;
}
uint8_t layerRangeBits =
GetContentDefinedLayerRangeBits(layerIndex, layerCount, kMaxContentDefinedLayerCount);
return (getLevelStencilContentDefined(toVkLevel(level)) &
LevelContentDefinedMask(layerRangeBits))
.any();
}
void ImageHelper::invalidateSubresourceContent(ContextVk *contextVk,
gl::LevelIndex level,
uint32_t layerIndex,
uint32_t layerCount,
bool *preferToKeepContentsDefinedOut)
{
invalidateSubresourceContentImpl(
contextVk, level, layerIndex, layerCount,
static_cast<VkImageAspectFlagBits>(getAspectFlags() & ~VK_IMAGE_ASPECT_STENCIL_BIT),
&getLevelContentDefined(toVkLevel(level)), preferToKeepContentsDefinedOut);
}
void ImageHelper::invalidateSubresourceStencilContent(ContextVk *contextVk,
gl::LevelIndex level,
uint32_t layerIndex,
uint32_t layerCount,
bool *preferToKeepContentsDefinedOut)
{
invalidateSubresourceContentImpl(
contextVk, level, layerIndex, layerCount, VK_IMAGE_ASPECT_STENCIL_BIT,
&getLevelStencilContentDefined(toVkLevel(level)), preferToKeepContentsDefinedOut);
}
void ImageHelper::invalidateSubresourceContentImpl(ContextVk *contextVk,
gl::LevelIndex level,
uint32_t layerIndex,
uint32_t layerCount,
VkImageAspectFlagBits aspect,
LevelContentDefinedMask *contentDefinedMask,
bool *preferToKeepContentsDefinedOut)
{
// If the aspect being invalidated doesn't exist, skip invalidation altogether.
if ((getAspectFlags() & aspect) == 0)
{
if (preferToKeepContentsDefinedOut)
{
// Let the caller know that this invalidate request was ignored.
*preferToKeepContentsDefinedOut = true;
}
return;
}
// If the color format is emulated and has extra channels, those channels need to stay cleared.
// On some devices, it's cheaper to skip invalidating the framebuffer attachment, while on
// others it's cheaper to invalidate but then re-clear the image.
//
// For depth/stencil formats, each channel is separately invalidated, so the invalidate is
// simply skipped for the emulated channel on all devices.
const bool hasEmulatedChannels = hasEmulatedImageChannels();
bool skip = false;
switch (aspect)
{
case VK_IMAGE_ASPECT_DEPTH_BIT:
skip = hasEmulatedDepthChannel();
break;
case VK_IMAGE_ASPECT_STENCIL_BIT:
skip = hasEmulatedStencilChannel();
break;
case VK_IMAGE_ASPECT_COLOR_BIT:
skip = hasEmulatedChannels &&
contextVk->getFeatures().preferSkippingInvalidateForEmulatedFormats.enabled;
break;
default:
UNREACHABLE();
skip = true;
}
if (preferToKeepContentsDefinedOut)
{
*preferToKeepContentsDefinedOut = skip;
}
if (skip)
{
return;
}
if (layerIndex >= kMaxContentDefinedLayerCount)
{
const char *aspectName = "color";
if (aspect == VK_IMAGE_ASPECT_DEPTH_BIT)
{
aspectName = "depth";
}
else if (aspect == VK_IMAGE_ASPECT_STENCIL_BIT)
{
aspectName = "stencil";
}
ANGLE_VK_PERF_WARNING(
contextVk, GL_DEBUG_SEVERITY_LOW,
"glInvalidateFramebuffer (%s) ineffective on attachments with layer >= 8", aspectName);
return;
}
uint8_t layerRangeBits =
GetContentDefinedLayerRangeBits(layerIndex, layerCount, kMaxContentDefinedLayerCount);
*contentDefinedMask &= static_cast<uint8_t>(~layerRangeBits);
// If there are emulated channels, stage a clear to make sure those channels continue to contain
// valid values.
if (hasEmulatedChannels && aspect == VK_IMAGE_ASPECT_COLOR_BIT)
{
VkClearValue clearValue;
clearValue.color = kEmulatedInitColorValue;
prependSubresourceUpdate(
level, SubresourceUpdate(aspect, clearValue, level, layerIndex, layerCount));
mSubresourceUpdates[level.get()].front().updateSource = UpdateSource::ClearAfterInvalidate;
}
}
void ImageHelper::restoreSubresourceContent(gl::LevelIndex level,
uint32_t layerIndex,
uint32_t layerCount)
{
restoreSubresourceContentImpl(
level, layerIndex, layerCount,
static_cast<VkImageAspectFlagBits>(getAspectFlags() & ~VK_IMAGE_ASPECT_STENCIL_BIT),
&getLevelContentDefined(toVkLevel(level)));
}
void ImageHelper::restoreSubresourceStencilContent(gl::LevelIndex level,
uint32_t layerIndex,
uint32_t layerCount)
{
restoreSubresourceContentImpl(level, layerIndex, layerCount, VK_IMAGE_ASPECT_STENCIL_BIT,
&getLevelStencilContentDefined(toVkLevel(level)));
}
void ImageHelper::restoreSubresourceContentImpl(gl::LevelIndex level,
uint32_t layerIndex,
uint32_t layerCount,
VkImageAspectFlagBits aspect,
LevelContentDefinedMask *contentDefinedMask)
{
if (layerIndex >= kMaxContentDefinedLayerCount)
{
return;
}
uint8_t layerRangeBits =
GetContentDefinedLayerRangeBits(layerIndex, layerCount, kMaxContentDefinedLayerCount);
switch (aspect)
{
case VK_IMAGE_ASPECT_DEPTH_BIT:
// Emulated depth channel should never have been marked invalid, so it can retain its
// cleared value.
ASSERT(!hasEmulatedDepthChannel() ||
(contentDefinedMask->bits() & layerRangeBits) == layerRangeBits);
break;
case VK_IMAGE_ASPECT_STENCIL_BIT:
// Emulated stencil channel should never have been marked invalid, so it can retain its
// cleared value.
ASSERT(!hasEmulatedStencilChannel() ||
(contentDefinedMask->bits() & layerRangeBits) == layerRangeBits);
break;
case VK_IMAGE_ASPECT_COLOR_BIT:
// This function is called on attachments during a render pass when it's determined that
// they should no longer be considered invalidated. For an attachment with emulated
// format that has extra channels, invalidateSubresourceContentImpl may have proactively
// inserted a clear so that the extra channels continue to have defined values. That
// clear should be removed.
if (hasEmulatedImageChannels())
{
removeSingleStagedClearAfterInvalidate(level, layerIndex, layerCount);
}
// Additionally, as the resource has been rewritten to in the render pass, its no longer
// cleared to the cached value.
mCurrentSingleClearValue.reset();
break;
default:
UNREACHABLE();
break;
}
*contentDefinedMask |= layerRangeBits;
}
angle::Result ImageHelper::stageSubresourceUpdate(ContextVk *contextVk,
const gl::ImageIndex &index,
const gl::Extents &glExtents,
const gl::Offset &offset,
const gl::InternalFormat &formatInfo,
const gl::PixelUnpackState &unpack,
GLenum type,
const uint8_t *pixels,
const Format &vkFormat,
ImageAccess access)
{
GLuint inputRowPitch = 0;
GLuint inputDepthPitch = 0;
GLuint inputSkipBytes = 0;
ANGLE_TRY(CalculateBufferInfo(contextVk, glExtents, formatInfo, unpack, type, index.usesTex3D(),
&inputRowPitch, &inputDepthPitch, &inputSkipBytes));
ANGLE_TRY(stageSubresourceUpdateImpl(contextVk, index, glExtents, offset, formatInfo, unpack,
type, pixels, vkFormat, access, inputRowPitch,
inputDepthPitch, inputSkipBytes));
return angle::Result::Continue;
}
angle::Result ImageHelper::stageSubresourceUpdateAndGetData(ContextVk *contextVk,
size_t allocationSize,
const gl::ImageIndex &imageIndex,
const gl::Extents &glExtents,
const gl::Offset &offset,
uint8_t **dstData,
angle::FormatID formatID)
{
std::unique_ptr<RefCounted<BufferHelper>> stagingBuffer =
std::make_unique<RefCounted<BufferHelper>>();
BufferHelper *currentBuffer = &stagingBuffer->get();
VkDeviceSize stagingOffset;
ANGLE_TRY(currentBuffer->allocateForCopyImage(contextVk, allocationSize,
MemoryCoherency::NonCoherent, formatID,
&stagingOffset, dstData));
gl::LevelIndex updateLevelGL(imageIndex.getLevelIndex());
VkBufferImageCopy copy = {};
copy.bufferOffset = stagingOffset;
copy.bufferRowLength = glExtents.width;
copy.bufferImageHeight = glExtents.height;
copy.imageSubresource.aspectMask = VK_IMAGE_ASPECT_COLOR_BIT;
copy.imageSubresource.mipLevel = updateLevelGL.get();
copy.imageSubresource.baseArrayLayer = imageIndex.hasLayer() ? imageIndex.getLayerIndex() : 0;
copy.imageSubresource.layerCount = imageIndex.getLayerCount();
// Note: Only support color now
ASSERT((mActualFormatID == angle::FormatID::NONE) ||
(getAspectFlags() == VK_IMAGE_ASPECT_COLOR_BIT));
gl_vk::GetOffset(offset, &copy.imageOffset);
gl_vk::GetExtent(glExtents, &copy.imageExtent);
appendSubresourceUpdate(
updateLevelGL, SubresourceUpdate(stagingBuffer.release(), currentBuffer, copy, formatID));
return angle::Result::Continue;
}
angle::Result ImageHelper::stageSubresourceUpdateFromFramebuffer(
const gl::Context *context,
const gl::ImageIndex &index,
const gl::Rectangle &sourceArea,
const gl::Offset &dstOffset,
const gl::Extents &dstExtent,
const gl::InternalFormat &formatInfo,
ImageAccess access,
FramebufferVk *framebufferVk)
{
ContextVk *contextVk = GetImpl(context);
// If the extents and offset is outside the source image, we need to clip.
gl::Rectangle clippedRectangle;
const gl::Extents readExtents = framebufferVk->getReadImageExtents();
if (!ClipRectangle(sourceArea, gl::Rectangle(0, 0, readExtents.width, readExtents.height),
&clippedRectangle))
{
// Empty source area, nothing to do.
return angle::Result::Continue;
}
bool isViewportFlipEnabled = contextVk->isViewportFlipEnabledForDrawFBO();
if (isViewportFlipEnabled)
{
clippedRectangle.y = readExtents.height - clippedRectangle.y - clippedRectangle.height;
}
// 1- obtain a buffer handle to copy to
RendererVk *renderer = contextVk->getRenderer();
const Format &vkFormat = renderer->getFormat(formatInfo.sizedInternalFormat);
const angle::Format &storageFormat = vkFormat.getActualImageFormat(access);
LoadImageFunctionInfo loadFunction = vkFormat.getTextureLoadFunction(access, formatInfo.type);
size_t outputRowPitch = storageFormat.pixelBytes * clippedRectangle.width;
size_t outputDepthPitch = outputRowPitch * clippedRectangle.height;
std::unique_ptr<RefCounted<BufferHelper>> stagingBuffer =
std::make_unique<RefCounted<BufferHelper>>();
BufferHelper *currentBuffer = &stagingBuffer->get();
uint8_t *stagingPointer;
VkDeviceSize stagingOffset;
// The destination is only one layer deep.
size_t allocationSize = outputDepthPitch;
ANGLE_TRY(currentBuffer->allocateForCopyImage(contextVk, allocationSize,
MemoryCoherency::NonCoherent, storageFormat.id,
&stagingOffset, &stagingPointer));
const angle::Format &copyFormat =
GetFormatFromFormatType(formatInfo.internalFormat, formatInfo.type);
PackPixelsParams params(clippedRectangle, copyFormat, static_cast<GLuint>(outputRowPitch),
isViewportFlipEnabled, nullptr, 0);
RenderTargetVk *readRenderTarget = framebufferVk->getColorReadRenderTarget();
// 2- copy the source image region to the pixel buffer using a cpu readback
if (loadFunction.requiresConversion)
{
// When a conversion is required, we need to use the loadFunction to read from a temporary
// buffer instead so its an even slower path.
size_t bufferSize =
storageFormat.pixelBytes * clippedRectangle.width * clippedRectangle.height;
angle::MemoryBuffer *memoryBuffer = nullptr;
ANGLE_VK_CHECK_ALLOC(contextVk, context->getScratchBuffer(bufferSize, &memoryBuffer));
// Read into the scratch buffer
ANGLE_TRY(framebufferVk->readPixelsImpl(contextVk, clippedRectangle, params,
VK_IMAGE_ASPECT_COLOR_BIT, readRenderTarget,
memoryBuffer->data()));
// Load from scratch buffer to our pixel buffer
loadFunction.loadFunction(clippedRectangle.width, clippedRectangle.height, 1,
memoryBuffer->data(), outputRowPitch, 0, stagingPointer,
outputRowPitch, 0);
}
else
{
// We read directly from the framebuffer into our pixel buffer.
ANGLE_TRY(framebufferVk->readPixelsImpl(contextVk, clippedRectangle, params,
VK_IMAGE_ASPECT_COLOR_BIT, readRenderTarget,
stagingPointer));
}
gl::LevelIndex updateLevelGL(index.getLevelIndex());
// 3- enqueue the destination image subresource update
VkBufferImageCopy copyToImage = {};
copyToImage.bufferOffset = static_cast<VkDeviceSize>(stagingOffset);
copyToImage.bufferRowLength = 0; // Tightly packed data can be specified as 0.
copyToImage.bufferImageHeight = clippedRectangle.height;
copyToImage.imageSubresource.aspectMask = VK_IMAGE_ASPECT_COLOR_BIT;
copyToImage.imageSubresource.mipLevel = updateLevelGL.get();
copyToImage.imageSubresource.baseArrayLayer = index.hasLayer() ? index.getLayerIndex() : 0;
copyToImage.imageSubresource.layerCount = index.getLayerCount();
gl_vk::GetOffset(dstOffset, &copyToImage.imageOffset);
gl_vk::GetExtent(dstExtent, &copyToImage.imageExtent);
// 3- enqueue the destination image subresource update
appendSubresourceUpdate(updateLevelGL, SubresourceUpdate(stagingBuffer.release(), currentBuffer,
copyToImage, storageFormat.id));
return angle::Result::Continue;
}
void ImageHelper::stageSubresourceUpdateFromImage(RefCounted<ImageHelper> *image,
const gl::ImageIndex &index,
LevelIndex srcMipLevel,
const gl::Offset &destOffset,
const gl::Extents &glExtents,
const VkImageType imageType)
{
gl::LevelIndex updateLevelGL(index.getLevelIndex());
VkImageAspectFlags imageAspectFlags = vk::GetFormatAspectFlags(image->get().getActualFormat());
VkImageCopy copyToImage = {};
copyToImage.srcSubresource.aspectMask = imageAspectFlags;
copyToImage.srcSubresource.mipLevel = srcMipLevel.get();
copyToImage.srcSubresource.layerCount = index.getLayerCount();
copyToImage.dstSubresource.aspectMask = imageAspectFlags;
copyToImage.dstSubresource.mipLevel = updateLevelGL.get();
if (imageType == VK_IMAGE_TYPE_3D)
{
// These values must be set explicitly to follow the Vulkan spec:
// https://www.khronos.org/registry/vulkan/specs/1.1-extensions/man/html/VkImageCopy.html
// If either of the calling command's srcImage or dstImage parameters are of VkImageType
// VK_IMAGE_TYPE_3D, the baseArrayLayer and layerCount members of the corresponding
// subresource must be 0 and 1, respectively
copyToImage.dstSubresource.baseArrayLayer = 0;
copyToImage.dstSubresource.layerCount = 1;
// Preserve the assumption that destOffset.z == "dstSubresource.baseArrayLayer"
ASSERT(destOffset.z == (index.hasLayer() ? index.getLayerIndex() : 0));
}
else
{
copyToImage.dstSubresource.baseArrayLayer = index.hasLayer() ? index.getLayerIndex() : 0;
copyToImage.dstSubresource.layerCount = index.getLayerCount();
}
gl_vk::GetOffset(destOffset, &copyToImage.dstOffset);
gl_vk::GetExtent(glExtents, &copyToImage.extent);
appendSubresourceUpdate(
updateLevelGL, SubresourceUpdate(image, copyToImage, image->get().getActualFormatID()));
}
void ImageHelper::stageSubresourceUpdatesFromAllImageLevels(RefCounted<ImageHelper> *image,
gl::LevelIndex baseLevel)
{
for (LevelIndex levelVk(0); levelVk < LevelIndex(image->get().getLevelCount()); ++levelVk)
{
const gl::LevelIndex levelGL = vk_gl::GetLevelIndex(levelVk, baseLevel);
const gl::ImageIndex index =
gl::ImageIndex::Make2DArrayRange(levelGL.get(), 0, image->get().getLayerCount());
stageSubresourceUpdateFromImage(image, index, levelVk, gl::kOffsetZero,
image->get().getLevelExtents(levelVk),
image->get().getType());
}
}
void ImageHelper::stageClear(const gl::ImageIndex &index,
VkImageAspectFlags aspectFlags,
const VkClearValue &clearValue)
{
gl::LevelIndex updateLevelGL(index.getLevelIndex());
appendSubresourceUpdate(updateLevelGL, SubresourceUpdate(aspectFlags, clearValue, index));
}
void ImageHelper::stageRobustResourceClear(const gl::ImageIndex &index)
{
const VkImageAspectFlags aspectFlags = getAspectFlags();
ASSERT(mActualFormatID != angle::FormatID::NONE);
VkClearValue clearValue = GetRobustResourceClearValue(getIntendedFormat(), getActualFormat());
gl::LevelIndex updateLevelGL(index.getLevelIndex());
appendSubresourceUpdate(updateLevelGL, SubresourceUpdate(aspectFlags, clearValue, index));
}
angle::Result ImageHelper::stageResourceClearWithFormat(ContextVk *contextVk,
const gl::ImageIndex &index,
const gl::Extents &glExtents,
const angle::Format &intendedFormat,
const angle::Format &imageFormat,
const VkClearValue &clearValue)
{
// Robust clears must only be staged if we do not have any prior data for this subresource.
ASSERT(!hasStagedUpdatesForSubresource(gl::LevelIndex(index.getLevelIndex()),
index.getLayerIndex(), index.getLayerCount()));
const VkImageAspectFlags aspectFlags = GetFormatAspectFlags(imageFormat);
gl::LevelIndex updateLevelGL(index.getLevelIndex());
if (imageFormat.isBlock)
{
// This only supports doing an initial clear to 0, not clearing to a specific encoded RGBA
// value
ASSERT((clearValue.color.int32[0] == 0) && (clearValue.color.int32[1] == 0) &&
(clearValue.color.int32[2] == 0) && (clearValue.color.int32[3] == 0));
const gl::InternalFormat &formatInfo =
gl::GetSizedInternalFormatInfo(imageFormat.glInternalFormat);
GLuint totalSize;
ANGLE_VK_CHECK_MATH(contextVk,
formatInfo.computeCompressedImageSize(glExtents, &totalSize));
std::unique_ptr<RefCounted<BufferHelper>> stagingBuffer =
std::make_unique<RefCounted<BufferHelper>>();
BufferHelper *currentBuffer = &stagingBuffer->get();
uint8_t *stagingPointer;
VkDeviceSize stagingOffset;
ANGLE_TRY(currentBuffer->allocateForCopyImage(contextVk, totalSize,
MemoryCoherency::NonCoherent, imageFormat.id,
&stagingOffset, &stagingPointer));
memset(stagingPointer, 0, totalSize);
VkBufferImageCopy copyRegion = {};
copyRegion.bufferOffset = stagingOffset;
copyRegion.imageExtent.width = glExtents.width;
copyRegion.imageExtent.height = glExtents.height;
copyRegion.imageExtent.depth = glExtents.depth;
copyRegion.imageSubresource.mipLevel = updateLevelGL.get();
copyRegion.imageSubresource.aspectMask = aspectFlags;
copyRegion.imageSubresource.baseArrayLayer = index.hasLayer() ? index.getLayerIndex() : 0;
copyRegion.imageSubresource.layerCount = index.getLayerCount();
// The update structure owns the staging buffer.
appendSubresourceUpdate(
updateLevelGL,
SubresourceUpdate(stagingBuffer.release(), currentBuffer, copyRegion, imageFormat.id));
}
else
{
appendSubresourceUpdate(updateLevelGL, SubresourceUpdate(aspectFlags, clearValue, index));
}
return angle::Result::Continue;
}
angle::Result ImageHelper::stageRobustResourceClearWithFormat(ContextVk *contextVk,
const gl::ImageIndex &index,
const gl::Extents &glExtents,
const angle::Format &intendedFormat,
const angle::Format &imageFormat)
{
VkClearValue clearValue = GetRobustResourceClearValue(intendedFormat, imageFormat);
return stageResourceClearWithFormat(contextVk, index, glExtents, intendedFormat, imageFormat,
clearValue);
}
void ImageHelper::stageClearIfEmulatedFormat(bool isRobustResourceInitEnabled, bool isExternalImage)
{
// Skip staging extra clears if robust resource init is enabled.
if (!hasEmulatedImageChannels() || isRobustResourceInitEnabled)
{
return;
}
VkClearValue clearValue = {};
if (getIntendedFormat().hasDepthOrStencilBits())
{
clearValue.depthStencil = kRobustInitDepthStencilValue;
}
else
{
clearValue.color = kEmulatedInitColorValue;
}
const VkImageAspectFlags aspectFlags = getAspectFlags();
// If the image has an emulated channel and robust resource init is not enabled, always clear
// it. These channels will be masked out in future writes, and shouldn't contain uninitialized
// values.
//
// For external images, we cannot clear the image entirely, as it may contain data in the
// non-emulated channels. For depth/stencil images, clear is already per aspect, but for color
// images we would need to take a special path where we only clear the emulated channels.
const bool clearOnlyEmulatedChannels =
isExternalImage && !getIntendedFormat().hasDepthOrStencilBits();
const VkColorComponentFlags colorMaskFlags =
clearOnlyEmulatedChannels ? getEmulatedChannelsMask() : 0;
for (LevelIndex level(0); level < LevelIndex(mLevelCount); ++level)
{
gl::LevelIndex updateLevelGL = toGLLevel(level);
gl::ImageIndex index =
gl::ImageIndex::Make2DArrayRange(updateLevelGL.get(), 0, mLayerCount);
if (clearOnlyEmulatedChannels)
{
prependSubresourceUpdate(updateLevelGL,
SubresourceUpdate(colorMaskFlags, clearValue.color, index));
}
else
{
prependSubresourceUpdate(updateLevelGL,
SubresourceUpdate(aspectFlags, clearValue, index));
}
}
}
bool ImageHelper::verifyEmulatedClearsAreBeforeOtherUpdates(
const std::vector<SubresourceUpdate> &updates)
{
bool isIteratingEmulatedClears = true;
for (const SubresourceUpdate &update : updates)
{
// If anything other than ClearEmulatedChannelsOnly is visited, there cannot be any
// ClearEmulatedChannelsOnly updates after that.
if (update.updateSource != UpdateSource::ClearEmulatedChannelsOnly)
{
isIteratingEmulatedClears = false;
}
else if (!isIteratingEmulatedClears)
{
// If ClearEmulatedChannelsOnly is visited after another update, that's an error.
return false;
}
}
// Additionally, verify that emulated clear is not applied multiple times.
if (updates.size() >= 2 && updates[1].updateSource == UpdateSource::ClearEmulatedChannelsOnly)
{
return false;
}
return true;
}
void ImageHelper::stageSelfAsSubresourceUpdates(ContextVk *contextVk,
uint32_t levelCount,
gl::TexLevelMask skipLevelsMask)
{
// Nothing to do if every level must be skipped
gl::TexLevelMask levelsMask(angle::BitMask<uint32_t>(levelCount) << mFirstAllocatedLevel.get());
if ((~skipLevelsMask & levelsMask).none())
{
return;
}
// Because we are cloning this object to another object, we must finalize the layout if it is
// being used by current renderpass as attachment. Otherwise we are copying the incorrect layout
// since it is determined at endRenderPass time.
contextVk->finalizeImageLayout(this);
std::unique_ptr<RefCounted<ImageHelper>> prevImage =
std::make_unique<RefCounted<ImageHelper>>();
// Move the necessary information for staged update to work, and keep the rest as part of this
// object.
// Usage info
prevImage->get().Resource::operator=(std::move(*this));
// Vulkan objects
prevImage->get().mImage = std::move(mImage);
prevImage->get().mDeviceMemory = std::move(mDeviceMemory);
// Barrier information. Note: mLevelCount is set to levelCount so that only the necessary
// levels are transitioned when flushing the update.
prevImage->get().mIntendedFormatID = mIntendedFormatID;
prevImage->get().mActualFormatID = mActualFormatID;
prevImage->get().mCurrentLayout = mCurrentLayout;
prevImage->get().mCurrentQueueFamilyIndex = mCurrentQueueFamilyIndex;
prevImage->get().mLastNonShaderReadOnlyLayout = mLastNonShaderReadOnlyLayout;
prevImage->get().mCurrentShaderReadStageMask = mCurrentShaderReadStageMask;
prevImage->get().mLevelCount = levelCount;
prevImage->get().mLayerCount = mLayerCount;
prevImage->get().mImageSerial = mImageSerial;
prevImage->get().mImageAndViewGarbage = std::move(mImageAndViewGarbage);
// Reset information for current (invalid) image.
mCurrentLayout = ImageLayout::Undefined;
mCurrentQueueFamilyIndex = std::numeric_limits<uint32_t>::max();
mLastNonShaderReadOnlyLayout = ImageLayout::Undefined;
mCurrentShaderReadStageMask = 0;
mImageSerial = kInvalidImageSerial;
setEntireContentUndefined();
// Stage updates from the previous image.
for (LevelIndex levelVk(0); levelVk < LevelIndex(levelCount); ++levelVk)
{
gl::LevelIndex levelGL = toGLLevel(levelVk);
if (skipLevelsMask.test(levelGL.get()))
{
continue;
}
const gl::ImageIndex index =
gl::ImageIndex::Make2DArrayRange(levelGL.get(), 0, mLayerCount);
stageSubresourceUpdateFromImage(prevImage.get(), index, levelVk, gl::kOffsetZero,
getLevelExtents(levelVk), mImageType);
}
ASSERT(levelCount > 0);
prevImage.release();
}
angle::Result ImageHelper::flushSingleSubresourceStagedUpdates(ContextVk *contextVk,
gl::LevelIndex levelGL,
uint32_t layer,
uint32_t layerCount,
ClearValuesArray *deferredClears,
uint32_t deferredClearIndex)
{
std::vector<SubresourceUpdate> *levelUpdates = getLevelUpdates(levelGL);
if (levelUpdates == nullptr || levelUpdates->empty())
{
return angle::Result::Continue;
}
LevelIndex levelVk = toVkLevel(levelGL);
// Handle deferred clears. Search the updates list for a matching clear index.
if (deferredClears)
{
Optional<size_t> foundClear;
for (size_t updateIndex = 0; updateIndex < levelUpdates->size(); ++updateIndex)
{
SubresourceUpdate &update = (*levelUpdates)[updateIndex];
if (update.isUpdateToLayers(layer, layerCount))
{
// On any data update, exit out. We'll need to do a full upload.
const bool isClear = IsClearOfAllChannels(update.updateSource);
const uint32_t updateLayerCount = isClear ? update.data.clear.layerCount : 0;
const uint32_t imageLayerCount =
mImageType == VK_IMAGE_TYPE_3D ? getLevelExtents(levelVk).depth : mLayerCount;
if (!isClear || (updateLayerCount != layerCount &&
!(update.data.clear.layerCount == VK_REMAINING_ARRAY_LAYERS &&
imageLayerCount == layerCount)))
{
foundClear.reset();
break;
}
// Otherwise track the latest clear update index.
foundClear = updateIndex;
}
}
// If we have a valid index we defer the clear using the clear reference.
if (foundClear.valid())
{
size_t foundIndex = foundClear.value();
const ClearUpdate &update = (*levelUpdates)[foundIndex].data.clear;
// Note that this set command handles combined or separate depth/stencil clears.
deferredClears->store(deferredClearIndex, update.aspectFlags, update.value);
// Do not call onWrite as it removes mCurrentSingleClearValue, but instead call
// setContentDefined directly.
setContentDefined(toVkLevel(levelGL), 1, layer, layerCount, update.aspectFlags);
// We process the updates again to erase any clears for this level.
removeSingleSubresourceStagedUpdates(contextVk, levelGL, layer, layerCount);
return angle::Result::Continue;
}
// Otherwise we proceed with a normal update.
}
return flushStagedUpdates(contextVk, levelGL, levelGL + 1, layer, layer + layerCount, {});
}
angle::Result ImageHelper::flushStagedUpdates(ContextVk *contextVk,
gl::LevelIndex levelGLStart,
gl::LevelIndex levelGLEnd,
uint32_t layerStart,
uint32_t layerEnd,
gl::TexLevelMask skipLevelsMask)
{
RendererVk *renderer = contextVk->getRenderer();
if (!hasStagedUpdatesInLevels(levelGLStart, levelGLEnd))
{
return angle::Result::Continue;
}
removeSupersededUpdates(contextVk, skipLevelsMask);
// If a clear is requested and we know it was previously cleared with the same value, we drop
// the clear.
if (mCurrentSingleClearValue.valid())
{
std::vector<SubresourceUpdate> *levelUpdates =
getLevelUpdates(gl::LevelIndex(mCurrentSingleClearValue.value().levelIndex));
if (levelUpdates && levelUpdates->size() == 1)
{
SubresourceUpdate &update = (*levelUpdates)[0];
if (IsClearOfAllChannels(update.updateSource) &&
mCurrentSingleClearValue.value() == update.data.clear)
{
ASSERT(levelGLStart + 1 == levelGLEnd);
setContentDefined(toVkLevel(levelGLStart), 1, layerStart, layerEnd - layerStart,
update.data.clear.aspectFlags);
ANGLE_VK_PERF_WARNING(contextVk, GL_DEBUG_SEVERITY_LOW,
"Repeated Clear on framebuffer attachment dropped");
update.release(contextVk->getRenderer());
levelUpdates->clear();
return angle::Result::Continue;
}
}
}
ASSERT(validateSubresourceUpdateRefCountsConsistent());
const VkImageAspectFlags aspectFlags = GetFormatAspectFlags(getActualFormat());
// For each level, upload layers that don't conflict in parallel. The layer is hashed to
// `layer % 64` and used to track whether that subresource is currently in transfer. If so, a
// barrier is inserted. If mLayerCount > 64, there will be a few unnecessary barriers.
//
// Note: when a barrier is necessary when uploading updates to a level, we could instead move to
// the next level and continue uploads in parallel. Once all levels need a barrier, a single
// barrier can be issued and we could continue with the rest of the updates from the first
// level.
constexpr uint32_t kMaxParallelSubresourceUpload = 64;
// Start in TransferDst. Don't yet mark any subresource as having defined contents; that is
// done with fine granularity as updates are applied. This is achieved by specifying a layer
// that is outside the tracking range.
CommandBufferAccess access;
access.onImageTransferWrite(levelGLStart, 1, kMaxContentDefinedLayerCount, 0, aspectFlags,
this);
OutsideRenderPassCommandBuffer *commandBuffer;
ANGLE_TRY(contextVk->getOutsideRenderPassCommandBuffer(access, &commandBuffer));
for (gl::LevelIndex updateMipLevelGL = levelGLStart; updateMipLevelGL < levelGLEnd;
++updateMipLevelGL)
{
std::vector<SubresourceUpdate> *levelUpdates = getLevelUpdates(updateMipLevelGL);
if (levelUpdates == nullptr)
{
ASSERT(static_cast<size_t>(updateMipLevelGL.get()) >= mSubresourceUpdates.size());
break;
}
std::vector<SubresourceUpdate> updatesToKeep;
// Hash map of uploads in progress. See comment on kMaxParallelSubresourceUpload.
uint64_t subresourceUploadsInProgress = 0;
for (SubresourceUpdate &update : *levelUpdates)
{
ASSERT(IsClear(update.updateSource) ||
(update.updateSource == UpdateSource::Buffer &&
update.data.buffer.bufferHelper != nullptr) ||
(update.updateSource == UpdateSource::Image &&
update.refCounted.image != nullptr && update.refCounted.image->isReferenced() &&
update.refCounted.image->get().valid()));
uint32_t updateBaseLayer, updateLayerCount;
update.getDestSubresource(mLayerCount, &updateBaseLayer, &updateLayerCount);
// If the update layers don't intersect the requested layers, skip the update.
const bool areUpdateLayersOutsideRange =
updateBaseLayer + updateLayerCount <= layerStart || updateBaseLayer >= layerEnd;
const LevelIndex updateMipLevelVk = toVkLevel(updateMipLevelGL);
// Additionally, if updates to this level are specifically asked to be skipped, skip
// them. This can happen when recreating an image that has been partially incompatibly
// redefined, in which case only updates to the levels that haven't been redefined
// should be flushed.
if (areUpdateLayersOutsideRange || skipLevelsMask.test(updateMipLevelGL.get()))
{
updatesToKeep.emplace_back(std::move(update));
continue;
}
// The updates were holding gl::LevelIndex values so that they would not need
// modification when the base level of the texture changes. Now that the update is
// about to take effect, we need to change miplevel to LevelIndex.
if (IsClear(update.updateSource))
{
update.data.clear.levelIndex = updateMipLevelVk.get();
}
else if (update.updateSource == UpdateSource::Buffer)
{
if (update.data.buffer.formatID != mActualFormatID)
{
// TODD: http://anglebug.com/6368, we should handle this in higher level code.
// If we have incompatible updates, skip but keep it.
updatesToKeep.emplace_back(std::move(update));
continue;
}
update.data.buffer.copyRegion.imageSubresource.mipLevel = updateMipLevelVk.get();
}
else if (update.updateSource == UpdateSource::Image)
{
if (update.data.image.formatID != mActualFormatID)
{
// If we have incompatible updates, skip but keep it.
updatesToKeep.emplace_back(std::move(update));
continue;
}
update.data.image.copyRegion.dstSubresource.mipLevel = updateMipLevelVk.get();
}
if (updateLayerCount >= kMaxParallelSubresourceUpload)
{
// If there are more subresources than bits we can track, always insert a barrier.
recordWriteBarrier(contextVk, aspectFlags, ImageLayout::TransferDst, commandBuffer);
subresourceUploadsInProgress = std::numeric_limits<uint64_t>::max();
}
else
{
const uint64_t subresourceHashRange = angle::BitMask<uint64_t>(updateLayerCount);
const uint32_t subresourceHashOffset =
updateBaseLayer % kMaxParallelSubresourceUpload;
const uint64_t subresourceHash =
ANGLE_ROTL64(subresourceHashRange, subresourceHashOffset);
if ((subresourceUploadsInProgress & subresourceHash) != 0)
{
// If there's overlap in subresource upload, issue a barrier.
recordWriteBarrier(contextVk, aspectFlags, ImageLayout::TransferDst,
commandBuffer);
subresourceUploadsInProgress = 0;
}
subresourceUploadsInProgress |= subresourceHash;
}
if (IsClearOfAllChannels(update.updateSource))
{
clear(update.data.clear.aspectFlags, update.data.clear.value, updateMipLevelVk,
updateBaseLayer, updateLayerCount, commandBuffer);
// Remember the latest operation is a clear call
mCurrentSingleClearValue = update.data.clear;
// Do not call onWrite as it removes mCurrentSingleClearValue, but instead call
// setContentDefined directly.
setContentDefined(updateMipLevelVk, 1, updateBaseLayer, updateLayerCount,
update.data.clear.aspectFlags);
}
else if (update.updateSource == UpdateSource::ClearEmulatedChannelsOnly)
{
ANGLE_TRY(clearEmulatedChannels(contextVk, update.data.clear.colorMaskFlags,
update.data.clear.value, updateMipLevelVk,
updateBaseLayer, updateLayerCount));
// Do not call onWrite. Even though some channels of the image are cleared, don't
// consider the contents defined. Also, since clearing emulated channels is a
// one-time thing that's superseded by Clears, |mCurrentSingleClearValue| is
// irrelevant and can't have a value.
ASSERT(!mCurrentSingleClearValue.valid());
// Refresh the command buffer because clearEmulatedChannels may have flushed it.
// This also transitions the image back to TransferDst, in case it's no longer in
// that layout.
ANGLE_TRY(contextVk->getOutsideRenderPassCommandBuffer(access, &commandBuffer));
}
else if (update.updateSource == UpdateSource::Buffer)
{
BufferUpdate &bufferUpdate = update.data.buffer;
BufferHelper *currentBuffer = bufferUpdate.bufferHelper;
ASSERT(currentBuffer && currentBuffer->valid());
ANGLE_TRY(currentBuffer->flush(renderer));
CommandBufferAccess bufferAccess;
bufferAccess.onBufferTransferRead(currentBuffer);
ANGLE_TRY(
contextVk->getOutsideRenderPassCommandBuffer(bufferAccess, &commandBuffer));
VkBufferImageCopy *copyRegion = &update.data.buffer.copyRegion;
commandBuffer->copyBufferToImage(currentBuffer->getBuffer().getHandle(), mImage,
getCurrentLayout(), 1, copyRegion);
ANGLE_TRY(contextVk->onCopyUpdate(currentBuffer->getSize()));
onWrite(updateMipLevelGL, 1, updateBaseLayer, updateLayerCount,
copyRegion->imageSubresource.aspectMask);
}
else
{
ASSERT(update.updateSource == UpdateSource::Image);
CommandBufferAccess imageAccess;
imageAccess.onImageTransferRead(aspectFlags, &update.refCounted.image->get());
ANGLE_TRY(
contextVk->getOutsideRenderPassCommandBuffer(imageAccess, &commandBuffer));
VkImageCopy *copyRegion = &update.data.image.copyRegion;
commandBuffer->copyImage(update.refCounted.image->get().getImage(),
update.refCounted.image->get().getCurrentLayout(), mImage,
getCurrentLayout(), 1, copyRegion);
onWrite(updateMipLevelGL, 1, updateBaseLayer, updateLayerCount,
copyRegion->dstSubresource.aspectMask);
}
update.release(contextVk->getRenderer());
}
// Only remove the updates that were actually applied to the image.
*levelUpdates = std::move(updatesToKeep);
}
// Compact mSubresourceUpdates, then check if there are any updates left.
size_t compactSize;
for (compactSize = mSubresourceUpdates.size(); compactSize > 0; --compactSize)
{
if (!mSubresourceUpdates[compactSize - 1].empty())
{
break;
}
}
mSubresourceUpdates.resize(compactSize);
ASSERT(validateSubresourceUpdateRefCountsConsistent());
// If no updates left, release the staging buffers to save memory.
if (mSubresourceUpdates.empty())
{
onStateChange(angle::SubjectMessage::InitializationComplete);
}
return angle::Result::Continue;
}
angle::Result ImageHelper::flushAllStagedUpdates(ContextVk *contextVk)
{
return flushStagedUpdates(contextVk, mFirstAllocatedLevel, mFirstAllocatedLevel + mLevelCount,
0, mLayerCount, {});
}
bool ImageHelper::hasStagedUpdatesForSubresource(gl::LevelIndex levelGL,
uint32_t layer,
uint32_t layerCount) const
{
// Check to see if any updates are staged for the given level and layer
const std::vector<SubresourceUpdate> *levelUpdates = getLevelUpdates(levelGL);
if (levelUpdates == nullptr || levelUpdates->empty())
{
return false;
}
for (const SubresourceUpdate &update : *levelUpdates)
{
uint32_t updateBaseLayer, updateLayerCount;
update.getDestSubresource(mLayerCount, &updateBaseLayer, &updateLayerCount);
const uint32_t updateLayerEnd = updateBaseLayer + updateLayerCount;
const uint32_t layerEnd = layer + layerCount;
if ((layer >= updateBaseLayer && layer < updateLayerEnd) ||
(layerEnd > updateBaseLayer && layerEnd <= updateLayerEnd))
{
// The layers intersect with the update range
return true;
}
}
return false;
}
bool ImageHelper::removeStagedClearUpdatesAndReturnColor(gl::LevelIndex levelGL,
const VkClearColorValue **color)
{
std::vector<SubresourceUpdate> *levelUpdates = getLevelUpdates(levelGL);
if (levelUpdates == nullptr || levelUpdates->empty())
{
return false;
}
bool result = false;
for (size_t index = 0; index < levelUpdates->size();)
{
auto update = levelUpdates->begin() + index;
if (IsClearOfAllChannels(update->updateSource))
{
if (color != nullptr)
{
*color = &update->data.clear.value.color;
}
levelUpdates->erase(update);
result = true;
}
}
return result;
}
gl::LevelIndex ImageHelper::getLastAllocatedLevel() const
{
return mFirstAllocatedLevel + mLevelCount - 1;
}
bool ImageHelper::hasStagedUpdatesInAllocatedLevels() const
{
return hasStagedUpdatesInLevels(mFirstAllocatedLevel, getLastAllocatedLevel() + 1);
}
bool ImageHelper::hasStagedUpdatesInLevels(gl::LevelIndex levelStart, gl::LevelIndex levelEnd) const
{
for (gl::LevelIndex level = levelStart; level < levelEnd; ++level)
{
const std::vector<SubresourceUpdate> *levelUpdates = getLevelUpdates(level);
if (levelUpdates == nullptr)
{
ASSERT(static_cast<size_t>(level.get()) >= mSubresourceUpdates.size());
return false;
}
if (!levelUpdates->empty())
{
return true;
}
}
return false;
}
bool ImageHelper::hasStagedImageUpdatesWithMismatchedFormat(gl::LevelIndex levelStart,
gl::LevelIndex levelEnd,
angle::FormatID formatID) const
{
for (gl::LevelIndex level = levelStart; level < levelEnd; ++level)
{
const std::vector<SubresourceUpdate> *levelUpdates = getLevelUpdates(level);
if (levelUpdates == nullptr)
{
continue;
}
for (const SubresourceUpdate &update : *levelUpdates)
{
if (update.updateSource == UpdateSource::Image &&
update.data.image.formatID != formatID)
{
return true;
}
}
}
return false;
}
bool ImageHelper::validateSubresourceUpdateBufferRefConsistent(
RefCounted<BufferHelper> *buffer) const
{
if (buffer == nullptr)
{
return true;
}
uint32_t refs = 0;
for (const std::vector<SubresourceUpdate> &levelUpdates : mSubresourceUpdates)
{
for (const SubresourceUpdate &update : levelUpdates)
{
if (update.updateSource == UpdateSource::Buffer && update.refCounted.buffer == buffer)
{
++refs;
}
}
}
return buffer->isRefCountAsExpected(refs);
}
bool ImageHelper::validateSubresourceUpdateImageRefConsistent(RefCounted<ImageHelper> *image) const
{
if (image == nullptr)
{
return true;
}
uint32_t refs = 0;
for (const std::vector<SubresourceUpdate> &levelUpdates : mSubresourceUpdates)
{
for (const SubresourceUpdate &update : levelUpdates)
{
if (update.updateSource == UpdateSource::Image && update.refCounted.image == image)
{
++refs;
}
}
}
return image->isRefCountAsExpected(refs);
}
bool ImageHelper::validateSubresourceUpdateRefCountsConsistent() const
{
for (const std::vector<SubresourceUpdate> &levelUpdates : mSubresourceUpdates)
{
for (const SubresourceUpdate &update : levelUpdates)
{
if (update.updateSource == UpdateSource::Image)
{
if (!validateSubresourceUpdateImageRefConsistent(update.refCounted.image))
{
return false;
}
}
else if (update.updateSource == UpdateSource::Buffer)
{
if (!validateSubresourceUpdateBufferRefConsistent(update.refCounted.buffer))
{
return false;
}
}
}
}
return true;
}
void ImageHelper::removeSupersededUpdates(ContextVk *contextVk, gl::TexLevelMask skipLevelsMask)
{
if (mLayerCount > 64)
{
// Not implemented for images with more than 64 layers. A 64-bit mask is used for
// efficiency, hence the limit.
return;
}
ASSERT(validateSubresourceUpdateRefCountsConsistent());
RendererVk *renderer = contextVk->getRenderer();
// Go over updates in reverse order, and mark the layers they completely overwrite. If an
// update is encountered whose layers are all already marked, that update is superseded by
// future updates, so it can be dropped. This tracking is done per level. If the aspect being
// written to is color/depth or stencil, index 0 or 1 is used respectively. This is so
// that if a depth write for example covers the whole subresource, a stencil write to that same
// subresource is not dropped.
constexpr size_t kIndexColorOrDepth = 0;
constexpr size_t kIndexStencil = 1;
uint64_t supersededLayers[2] = {};
gl::Extents levelExtents = {};
// Note: this lambda only needs |this|, but = is specified because clang warns about kIndex* not
// needing capture, while MSVC fails to compile without capturing them.
auto markLayersAndDropSuperseded = [=, &supersededLayers,
&levelExtents](SubresourceUpdate &update) {
uint32_t updateBaseLayer, updateLayerCount;
update.getDestSubresource(mLayerCount, &updateBaseLayer, &updateLayerCount);
const VkImageAspectFlags aspectMask = update.getDestAspectFlags();
const bool hasColorOrDepth =
(aspectMask & (VK_IMAGE_ASPECT_COLOR_BIT | VK_IMAGE_ASPECT_PLANE_0_BIT |
VK_IMAGE_ASPECT_PLANE_1_BIT | VK_IMAGE_ASPECT_PLANE_2_BIT |
VK_IMAGE_ASPECT_DEPTH_BIT)) != 0;
const bool hasStencil = (aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) != 0;
// Test if the update is to layers that are all superseded. In that case, drop the update.
ASSERT(updateLayerCount <= 64);
uint64_t updateLayersMask = updateLayerCount >= 64
? ~static_cast<uint64_t>(0)
: angle::BitMask<uint64_t>(updateLayerCount);
updateLayersMask <<= updateBaseLayer;
const bool isColorOrDepthSuperseded =
!hasColorOrDepth ||
(supersededLayers[kIndexColorOrDepth] & updateLayersMask) == updateLayersMask;
const bool isStencilSuperseded =
!hasStencil || (supersededLayers[kIndexStencil] & updateLayersMask) == updateLayersMask;
if (isColorOrDepthSuperseded && isStencilSuperseded)
{
ANGLE_VK_PERF_WARNING(contextVk, GL_DEBUG_SEVERITY_LOW,
"Dropped image update that is superseded by an overlapping one");
update.release(renderer);
return true;
}
// Get the area this update affects. Note that clear updates always clear the whole
// subresource.
gl::Box updateBox(gl::kOffsetZero, levelExtents);
if (update.updateSource == UpdateSource::Buffer)
{
updateBox = gl::Box(update.data.buffer.copyRegion.imageOffset,
update.data.buffer.copyRegion.imageExtent);
}
else if (update.updateSource == UpdateSource::Image)
{
updateBox = gl::Box(update.data.image.copyRegion.dstOffset,
update.data.image.copyRegion.extent);
}
// Only if the update is to the whole subresource, mark its layers.
if (updateBox.coversSameExtent(levelExtents))
{
if (hasColorOrDepth)
{
supersededLayers[kIndexColorOrDepth] |= updateLayersMask;
}
if (hasStencil)
{
supersededLayers[kIndexStencil] |= updateLayersMask;
}
}
return false;
};
for (LevelIndex levelVk(0); levelVk < LevelIndex(mLevelCount); ++levelVk)
{
gl::LevelIndex levelGL = toGLLevel(levelVk);
std::vector<SubresourceUpdate> *levelUpdates = getLevelUpdates(levelGL);
if (levelUpdates == nullptr)
{
ASSERT(static_cast<size_t>(levelGL.get()) >= mSubresourceUpdates.size());
break;
}
// If level is skipped (because incompatibly redefined), don't remove any of its updates.
if (skipLevelsMask.test(levelGL.get()))
{
continue;
}
// ClearEmulatedChannelsOnly updates can only be in the beginning of the list of updates.
// They don't entirely clear the image, so they cannot supersede any update.
ASSERT(verifyEmulatedClearsAreBeforeOtherUpdates(*levelUpdates));
levelExtents = getLevelExtents(levelVk);
supersededLayers[kIndexColorOrDepth] = 0;
supersededLayers[kIndexStencil] = 0;
levelUpdates->erase(levelUpdates->rend().base(),
std::remove_if(levelUpdates->rbegin(), levelUpdates->rend(),
markLayersAndDropSuperseded)
.base());
}
ASSERT(validateSubresourceUpdateRefCountsConsistent());
}
angle::Result ImageHelper::copyImageDataToBuffer(ContextVk *contextVk,
gl::LevelIndex sourceLevelGL,
uint32_t layerCount,
uint32_t baseLayer,
const gl::Box &sourceArea,
BufferHelper *dstBuffer,
uint8_t **outDataPtr)
{
ANGLE_TRACE_EVENT0("gpu.angle", "ImageHelper::copyImageDataToBuffer");
const angle::Format &imageFormat = getActualFormat();
// Two VK formats (one depth-only, one combined depth/stencil) use an extra byte for depth.
// From https://www.khronos.org/registry/vulkan/specs/1.1/html/vkspec.html#VkBufferImageCopy:
// data copied to or from the depth aspect of a VK_FORMAT_X8_D24_UNORM_PACK32 or
// VK_FORMAT_D24_UNORM_S8_UINT format is packed with one 32-bit word per texel...
// So make sure if we hit the depth/stencil format that we have 5 bytes per pixel (4 for depth
// data, 1 for stencil). NOTE that depth-only VK_FORMAT_X8_D24_UNORM_PACK32 already has 4 bytes
// per pixel which is sufficient to contain its depth aspect (no stencil aspect).
uint32_t pixelBytes = imageFormat.pixelBytes;
uint32_t depthBytesPerPixel = imageFormat.depthBits >> 3;
if (getActualVkFormat() == VK_FORMAT_D24_UNORM_S8_UINT)
{
pixelBytes = 5;
depthBytesPerPixel = 4;
}
size_t bufferSize =
sourceArea.width * sourceArea.height * sourceArea.depth * pixelBytes * layerCount;
const VkImageAspectFlags aspectFlags = getAspectFlags();
// Allocate coherent staging buffer
ASSERT(dstBuffer != nullptr && !dstBuffer->valid());
VkDeviceSize dstOffset;
ANGLE_TRY(dstBuffer->allocateForCopyImage(contextVk, bufferSize, MemoryCoherency::Coherent,
imageFormat.id, &dstOffset, outDataPtr));
VkBuffer bufferHandle = dstBuffer->getBuffer().getHandle();
LevelIndex sourceLevelVk = toVkLevel(sourceLevelGL);
VkBufferImageCopy regions[2] = {};
uint32_t regionCount = 1;
// Default to non-combined DS case
regions[0].bufferOffset = dstOffset;
regions[0].bufferRowLength = 0;
regions[0].bufferImageHeight = 0;
regions[0].imageExtent.width = sourceArea.width;
regions[0].imageExtent.height = sourceArea.height;
regions[0].imageExtent.depth = sourceArea.depth;
regions[0].imageOffset.x = sourceArea.x;
regions[0].imageOffset.y = sourceArea.y;
regions[0].imageOffset.z = sourceArea.z;
regions[0].imageSubresource.aspectMask = aspectFlags;
regions[0].imageSubresource.baseArrayLayer = baseLayer;
regions[0].imageSubresource.layerCount = layerCount;
regions[0].imageSubresource.mipLevel = sourceLevelVk.get();
if (isCombinedDepthStencilFormat())
{
// For combined DS image we'll copy depth and stencil aspects separately
// Depth aspect comes first in buffer and can use most settings from above
regions[0].imageSubresource.aspectMask = VK_IMAGE_ASPECT_DEPTH_BIT;
// Get depth data size since stencil data immediately follows depth data in buffer
const VkDeviceSize depthSize = depthBytesPerPixel * sourceArea.width * sourceArea.height *
sourceArea.depth * layerCount;
// Double-check that we allocated enough buffer space (always 1 byte per stencil)
ASSERT(bufferSize >= (depthSize + (sourceArea.width * sourceArea.height * sourceArea.depth *
layerCount)));
// Copy stencil data into buffer immediately following the depth data
const VkDeviceSize stencilOffset = dstOffset + depthSize;
regions[1] = regions[0];
regions[1].bufferOffset = stencilOffset;
regions[1].imageSubresource.aspectMask = VK_IMAGE_ASPECT_STENCIL_BIT;
regionCount++;
}
CommandBufferAccess access;
access.onBufferTransferWrite(dstBuffer);
access.onImageTransferRead(aspectFlags, this);
OutsideRenderPassCommandBuffer *commandBuffer;
ANGLE_TRY(contextVk->getOutsideRenderPassCommandBuffer(access, &commandBuffer));
commandBuffer->copyImageToBuffer(mImage, getCurrentLayout(), bufferHandle, regionCount,
regions);
return angle::Result::Continue;
}
angle::Result ImageHelper::copySurfaceImageToBuffer(DisplayVk *displayVk,
gl::LevelIndex sourceLevelGL,
uint32_t layerCount,
uint32_t baseLayer,
const gl::Box &sourceArea,
vk::BufferHelper *bufferHelper)
{
ANGLE_TRACE_EVENT0("gpu.angle", "ImageHelper::copySurfaceImageToBuffer");
RendererVk *rendererVk = displayVk->getRenderer();
VkBufferImageCopy region = {};
region.bufferOffset = 0;
region.bufferRowLength = 0;
region.bufferImageHeight = 0;
region.imageExtent.width = sourceArea.width;
region.imageExtent.height = sourceArea.height;
region.imageExtent.depth = sourceArea.depth;
region.imageOffset.x = sourceArea.x;
region.imageOffset.y = sourceArea.y;
region.imageOffset.z = sourceArea.z;
region.imageSubresource.aspectMask = getAspectFlags();
region.imageSubresource.baseArrayLayer = baseLayer;
region.imageSubresource.layerCount = layerCount;
region.imageSubresource.mipLevel = toVkLevel(sourceLevelGL).get();
PrimaryCommandBuffer primaryCommandBuffer;
ANGLE_TRY(rendererVk->getCommandBufferOneOff(displayVk, false, &primaryCommandBuffer));
barrierImpl(displayVk, getAspectFlags(), ImageLayout::TransferSrc, mCurrentQueueFamilyIndex,
&primaryCommandBuffer);
primaryCommandBuffer.copyImageToBuffer(mImage, getCurrentLayout(),
bufferHelper->getBuffer().getHandle(), 1, &region);
ANGLE_VK_TRY(displayVk, primaryCommandBuffer.end());
// Create fence for the submission
VkFenceCreateInfo fenceInfo = {};
fenceInfo.sType = VK_STRUCTURE_TYPE_FENCE_CREATE_INFO;
fenceInfo.flags = 0;
vk::DeviceScoped<vk::Fence> fence(rendererVk->getDevice());
ANGLE_VK_TRY(displayVk, fence.get().init(rendererVk->getDevice(), fenceInfo));
Serial serial;
ANGLE_TRY(rendererVk->queueSubmitOneOff(displayVk, std::move(primaryCommandBuffer), false,
egl::ContextPriority::Medium, nullptr, 0, &fence.get(),
vk::SubmitPolicy::EnsureSubmitted, &serial));
ANGLE_VK_TRY(displayVk,
fence.get().wait(rendererVk->getDevice(), rendererVk->getMaxFenceWaitTimeNs()));
return angle::Result::Continue;
}
angle::Result ImageHelper::copyBufferToSurfaceImage(DisplayVk *displayVk,
gl::LevelIndex sourceLevelGL,
uint32_t layerCount,
uint32_t baseLayer,
const gl::Box &sourceArea,
vk::BufferHelper *bufferHelper)
{
ANGLE_TRACE_EVENT0("gpu.angle", "ImageHelper::copyBufferToSurfaceImage");
RendererVk *rendererVk = displayVk->getRenderer();
VkBufferImageCopy region = {};
region.bufferOffset = 0;
region.bufferRowLength = 0;
region.bufferImageHeight = 0;
region.imageExtent.width = sourceArea.width;
region.imageExtent.height = sourceArea.height;
region.imageExtent.depth = sourceArea.depth;
region.imageOffset.x = sourceArea.x;
region.imageOffset.y = sourceArea.y;
region.imageOffset.z = sourceArea.z;
region.imageSubresource.aspectMask = getAspectFlags();
region.imageSubresource.baseArrayLayer = baseLayer;
region.imageSubresource.layerCount = layerCount;
region.imageSubresource.mipLevel = toVkLevel(sourceLevelGL).get();
PrimaryCommandBuffer commandBuffer;
ANGLE_TRY(rendererVk->getCommandBufferOneOff(displayVk, false, &commandBuffer));
barrierImpl(displayVk, getAspectFlags(), ImageLayout::TransferDst, mCurrentQueueFamilyIndex,
&commandBuffer);
commandBuffer.copyBufferToImage(bufferHelper->getBuffer().getHandle(), mImage,
getCurrentLayout(), 1, &region);
ANGLE_VK_TRY(displayVk, commandBuffer.end());
// Create fence for the submission
VkFenceCreateInfo fenceInfo = {};
fenceInfo.sType = VK_STRUCTURE_TYPE_FENCE_CREATE_INFO;
fenceInfo.flags = 0;
vk::DeviceScoped<vk::Fence> fence(rendererVk->getDevice());
ANGLE_VK_TRY(displayVk, fence.get().init(rendererVk->getDevice(), fenceInfo));
Serial serial;
ANGLE_TRY(rendererVk->queueSubmitOneOff(displayVk, std::move(commandBuffer), false,
egl::ContextPriority::Medium, nullptr, 0, &fence.get(),
vk::SubmitPolicy::EnsureSubmitted, &serial));
ANGLE_VK_TRY(displayVk,
fence.get().wait(rendererVk->getDevice(), rendererVk->getMaxFenceWaitTimeNs()));
return angle::Result::Continue;
}
// static
angle::Result ImageHelper::GetReadPixelsParams(ContextVk *contextVk,
const gl::PixelPackState &packState,
gl::Buffer *packBuffer,
GLenum format,
GLenum type,
const gl::Rectangle &area,
const gl::Rectangle &clippedArea,
PackPixelsParams *paramsOut,
GLuint *skipBytesOut)
{
const gl::InternalFormat &sizedFormatInfo = gl::GetInternalFormatInfo(format, type);
GLuint outputPitch = 0;
ANGLE_VK_CHECK_MATH(contextVk,
sizedFormatInfo.computeRowPitch(type, area.width, packState.alignment,
packState.rowLength, &outputPitch));
ANGLE_VK_CHECK_MATH(contextVk, sizedFormatInfo.computeSkipBytes(type, outputPitch, 0, packState,
false, skipBytesOut));
*skipBytesOut += (clippedArea.x - area.x) * sizedFormatInfo.pixelBytes +
(clippedArea.y - area.y) * outputPitch;
const angle::Format &angleFormat = GetFormatFromFormatType(format, type);
*paramsOut = PackPixelsParams(clippedArea, angleFormat, outputPitch, packState.reverseRowOrder,
packBuffer, 0);
return angle::Result::Continue;
}
angle::Result ImageHelper::readPixelsForGetImage(ContextVk *contextVk,
const gl::PixelPackState &packState,
gl::Buffer *packBuffer,
gl::LevelIndex levelGL,
uint32_t layer,
uint32_t layerCount,
GLenum format,
GLenum type,
void *pixels)
{
const angle::Format &angleFormat = GetFormatFromFormatType(format, type);
VkImageAspectFlagBits aspectFlags = {};
if (angleFormat.redBits > 0 || angleFormat.blueBits > 0 || angleFormat.greenBits > 0 ||
angleFormat.alphaBits > 0 || angleFormat.luminanceBits > 0)
{
aspectFlags = VK_IMAGE_ASPECT_COLOR_BIT;
}
else
{
if (angleFormat.depthBits > 0)
{
if (angleFormat.stencilBits != 0)
{
// TODO (anglebug.com/4688) Support combined depth stencil for GetTexImage
WARN() << "Unable to pull stencil from combined depth/stencil for GetTexImage";
}
aspectFlags = VK_IMAGE_ASPECT_DEPTH_BIT;
}
else if (angleFormat.stencilBits > 0)
{
aspectFlags = VK_IMAGE_ASPECT_STENCIL_BIT;
}
}
ASSERT(aspectFlags != 0);
PackPixelsParams params;
GLuint outputSkipBytes = 0;
const LevelIndex levelVk = toVkLevel(levelGL);
const gl::Extents mipExtents = getLevelExtents(levelVk);
gl::Rectangle area(0, 0, mipExtents.width, mipExtents.height);
ANGLE_TRY(GetReadPixelsParams(contextVk, packState, packBuffer, format, type, area, area,
&params, &outputSkipBytes));
if (mExtents.depth > 1 || layerCount > 1)
{
ASSERT(layer == 0);
ASSERT(layerCount == 1 || mipExtents.depth == 1);
uint32_t lastLayer = std::max(static_cast<uint32_t>(mipExtents.depth), layerCount);
// Depth > 1 means this is a 3D texture and we need to copy all layers
for (uint32_t mipLayer = 0; mipLayer < lastLayer; mipLayer++)
{
ANGLE_TRY(readPixels(contextVk, area, params, aspectFlags, levelGL, mipLayer,
static_cast<uint8_t *>(pixels) + outputSkipBytes));
outputSkipBytes += mipExtents.width * mipExtents.height *
gl::GetInternalFormatInfo(format, type).pixelBytes;
}
}
else
{
ANGLE_TRY(readPixels(contextVk, area, params, aspectFlags, levelGL, layer,
static_cast<uint8_t *>(pixels) + outputSkipBytes));
}
return angle::Result::Continue;
}
angle::Result ImageHelper::readPixelsForCompressedGetImage(ContextVk *contextVk,
const gl::PixelPackState &packState,
gl::Buffer *packBuffer,
gl::LevelIndex levelGL,
uint32_t layer,
uint32_t layerCount,
void *pixels)
{
PackPixelsParams params;
GLuint outputSkipBytes = 0;
const LevelIndex levelVk = toVkLevel(levelGL);
gl::Extents mipExtents = getLevelExtents(levelVk);
gl::Rectangle area(0, 0, mipExtents.width, mipExtents.height);
VkImageAspectFlagBits aspectFlags = VK_IMAGE_ASPECT_COLOR_BIT;
const angle::Format *readFormat = &getActualFormat();
// TODO(anglebug.com/6177): Implement encoding for emuluated compression formats
ANGLE_VK_CHECK(contextVk, readFormat->isBlock, VK_ERROR_FORMAT_NOT_SUPPORTED);
if (mExtents.depth > 1 || layerCount > 1)
{
ASSERT(layer == 0);
ASSERT(layerCount == 1 || mipExtents.depth == 1);
uint32_t lastLayer = std::max(static_cast<uint32_t>(mipExtents.depth), layerCount);
const vk::Format &vkFormat = contextVk->getRenderer()->getFormat(readFormat->id);
const gl::InternalFormat &storageFormatInfo =
vkFormat.getInternalFormatInfo(readFormat->componentType);
// Calculate size for one layer
mipExtents.depth = 1;
GLuint layerSize;
ANGLE_VK_CHECK_MATH(contextVk,
storageFormatInfo.computeCompressedImageSize(mipExtents, &layerSize));
// Depth > 1 means this is a 3D texture and we need to copy all layers
for (uint32_t mipLayer = 0; mipLayer < lastLayer; mipLayer++)
{
ANGLE_TRY(readPixels(contextVk, area, params, aspectFlags, levelGL, mipLayer,
static_cast<uint8_t *>(pixels) + outputSkipBytes));
outputSkipBytes += layerSize;
}
}
else
{
ANGLE_TRY(readPixels(contextVk, area, params, aspectFlags, levelGL, layer,
static_cast<uint8_t *>(pixels) + outputSkipBytes));
}
return angle::Result::Continue;
}
bool ImageHelper::canCopyWithTransformForReadPixels(const PackPixelsParams &packPixelsParams,
const angle::Format *readFormat)
{
ASSERT(mActualFormatID != angle::FormatID::NONE && mIntendedFormatID != angle::FormatID::NONE);
// Only allow copies to PBOs with identical format.
const bool isSameFormatCopy = *readFormat == *packPixelsParams.destFormat;
// Disallow any transformation.
const bool needsTransformation =
packPixelsParams.rotation != SurfaceRotation::Identity || packPixelsParams.reverseRowOrder;
// Disallow copies when the output pitch cannot be correctly specified in Vulkan.
const bool isPitchMultipleOfTexelSize =
packPixelsParams.outputPitch % readFormat->pixelBytes == 0;
// Don't allow copies from emulated formats for simplicity.
return !hasEmulatedImageFormat() && isSameFormatCopy && !needsTransformation &&
isPitchMultipleOfTexelSize;
}
angle::Result ImageHelper::readPixels(ContextVk *contextVk,
const gl::Rectangle &area,
const PackPixelsParams &packPixelsParams,
VkImageAspectFlagBits copyAspectFlags,
gl::LevelIndex levelGL,
uint32_t layer,
void *pixels)
{
ANGLE_TRACE_EVENT0("gpu.angle", "ImageHelper::readPixels");
RendererVk *renderer = contextVk->getRenderer();
// If the source image is multisampled, we need to resolve it into a temporary image before
// performing a readback.
bool isMultisampled = mSamples > 1;
RendererScoped<ImageHelper> resolvedImage(contextVk->getRenderer());
ImageHelper *src = this;
ASSERT(!hasStagedUpdatesForSubresource(levelGL, layer, 1));
if (isMultisampled)
{
ANGLE_TRY(resolvedImage.get().init2DStaging(
contextVk, contextVk->hasProtectedContent(), renderer->getMemoryProperties(),
gl::Extents(area.width, area.height, 1), mIntendedFormatID, mActualFormatID,
VK_IMAGE_USAGE_TRANSFER_SRC_BIT | VK_IMAGE_USAGE_TRANSFER_DST_BIT, 1));
}
VkImageAspectFlags layoutChangeAspectFlags = src->getAspectFlags();
// Note that although we're reading from the image, we need to update the layout below.
CommandBufferAccess access;
access.onImageTransferRead(layoutChangeAspectFlags, this);
if (isMultisampled)
{
access.onImageTransferWrite(gl::LevelIndex(0), 1, 0, 1, layoutChangeAspectFlags,
&resolvedImage.get());
}
OutsideRenderPassCommandBuffer *commandBuffer;
ANGLE_TRY(contextVk->getOutsideRenderPassCommandBuffer(access, &commandBuffer));
const angle::Format *readFormat = &getActualFormat();
const vk::Format &vkFormat = contextVk->getRenderer()->getFormat(readFormat->id);
const gl::InternalFormat &storageFormatInfo =
vkFormat.getInternalFormatInfo(readFormat->componentType);
if (copyAspectFlags != VK_IMAGE_ASPECT_COLOR_BIT)
{
readFormat = &GetDepthStencilImageToBufferFormat(*readFormat, copyAspectFlags);
}
VkOffset3D srcOffset = {area.x, area.y, 0};
VkImageSubresourceLayers srcSubresource = {};
srcSubresource.aspectMask = copyAspectFlags;
srcSubresource.mipLevel = toVkLevel(levelGL).get();
srcSubresource.baseArrayLayer = layer;
srcSubresource.layerCount = 1;
VkExtent3D srcExtent = {static_cast<uint32_t>(area.width), static_cast<uint32_t>(area.height),
1};
if (mExtents.depth > 1)
{
// Depth > 1 means this is a 3D texture and we need special handling
srcOffset.z = layer;
srcSubresource.baseArrayLayer = 0;
}
if (isMultisampled)
{
// Note: resolve only works on color images (not depth/stencil).
ASSERT(copyAspectFlags == VK_IMAGE_ASPECT_COLOR_BIT);
VkImageResolve resolveRegion = {};
resolveRegion.srcSubresource = srcSubresource;
resolveRegion.srcOffset = srcOffset;
resolveRegion.dstSubresource.aspectMask = copyAspectFlags;
resolveRegion.dstSubresource.mipLevel = 0;
resolveRegion.dstSubresource.baseArrayLayer = 0;
resolveRegion.dstSubresource.layerCount = 1;
resolveRegion.dstOffset = {};
resolveRegion.extent = srcExtent;
resolve(&resolvedImage.get(), resolveRegion, commandBuffer);
CommandBufferAccess readAccess;
readAccess.onImageTransferRead(layoutChangeAspectFlags, &resolvedImage.get());
ANGLE_TRY(contextVk->getOutsideRenderPassCommandBuffer(readAccess, &commandBuffer));
// Make the resolved image the target of buffer copy.
src = &resolvedImage.get();
srcOffset = {0, 0, 0};
srcSubresource.baseArrayLayer = 0;
srcSubresource.layerCount = 1;
srcSubresource.mipLevel = 0;
}
// If PBO and if possible, copy directly on the GPU.
if (packPixelsParams.packBuffer &&
canCopyWithTransformForReadPixels(packPixelsParams, readFormat))
{
BufferHelper &packBuffer = GetImpl(packPixelsParams.packBuffer)->getBuffer();
VkDeviceSize packBufferOffset = packBuffer.getOffset();
CommandBufferAccess copyAccess;
copyAccess.onBufferTransferWrite(&packBuffer);
copyAccess.onImageTransferRead(copyAspectFlags, src);
OutsideRenderPassCommandBuffer *copyCommandBuffer;
ANGLE_TRY(contextVk->getOutsideRenderPassCommandBuffer(copyAccess, &copyCommandBuffer));
ASSERT(packPixelsParams.outputPitch % readFormat->pixelBytes == 0);
VkBufferImageCopy region = {};
region.bufferImageHeight = srcExtent.height;
region.bufferOffset =
packBufferOffset + packPixelsParams.offset + reinterpret_cast<ptrdiff_t>(pixels);
region.bufferRowLength = packPixelsParams.outputPitch / readFormat->pixelBytes;
region.imageExtent = srcExtent;
region.imageOffset = srcOffset;
region.imageSubresource = srcSubresource;
copyCommandBuffer->copyImageToBuffer(src->getImage(), src->getCurrentLayout(),
packBuffer.getBuffer().getHandle(), 1, &region);
return angle::Result::Continue;
}
RendererScoped<vk::BufferHelper> readBuffer(renderer);
vk::BufferHelper *stagingBuffer = &readBuffer.get();
uint8_t *readPixelBuffer = nullptr;
VkDeviceSize stagingOffset = 0;
size_t allocationSize = readFormat->pixelBytes * area.width * area.height;
ANGLE_TRY(stagingBuffer->allocateForCopyImage(contextVk, allocationSize,
MemoryCoherency::Coherent, mActualFormatID,
&stagingOffset, &readPixelBuffer));
VkBuffer bufferHandle = stagingBuffer->getBuffer().getHandle();
VkBufferImageCopy region = {};
region.bufferImageHeight = srcExtent.height;
region.bufferOffset = stagingOffset;
region.bufferRowLength = srcExtent.width;
region.imageExtent = srcExtent;
region.imageOffset = srcOffset;
region.imageSubresource = srcSubresource;
// For compressed textures, vkCmdCopyImageToBuffer requires
// a region that is a multiple of the block size.
if (readFormat->isBlock)
{
region.bufferRowLength =
roundUp(region.bufferRowLength, storageFormatInfo.compressedBlockWidth);
region.bufferImageHeight =
roundUp(region.bufferImageHeight, storageFormatInfo.compressedBlockHeight);
}
CommandBufferAccess readbackAccess;
readbackAccess.onBufferTransferWrite(stagingBuffer);
OutsideRenderPassCommandBuffer *readbackCommandBuffer;
ANGLE_TRY(contextVk->getOutsideRenderPassCommandBuffer(readbackAccess, &readbackCommandBuffer));
readbackCommandBuffer->copyImageToBuffer(src->getImage(), src->getCurrentLayout(), bufferHandle,
1, &region);
ANGLE_VK_PERF_WARNING(contextVk, GL_DEBUG_SEVERITY_HIGH, "GPU stall due to ReadPixels");
// Triggers a full finish.
// TODO(jmadill): Don't block on asynchronous readback.
ANGLE_TRY(contextVk->finishImpl(RenderPassClosureReason::GLReadPixels));
if (readFormat->isBlock)
{
const LevelIndex levelVk = toVkLevel(levelGL);
gl::Extents levelExtents = getLevelExtents(levelVk);
// Calculate size of one layer
levelExtents.depth = 1;
GLuint layerSize;
ANGLE_VK_CHECK_MATH(contextVk,
storageFormatInfo.computeCompressedImageSize(levelExtents, &layerSize));
memcpy(pixels, readPixelBuffer, layerSize);
}
else if (packPixelsParams.packBuffer)
{
// Must map the PBO in order to read its contents (and then unmap it later)
BufferVk *packBufferVk = GetImpl(packPixelsParams.packBuffer);
void *mapPtr = nullptr;
ANGLE_TRY(packBufferVk->mapImpl(contextVk, GL_MAP_WRITE_BIT, &mapPtr));
uint8_t *dst = static_cast<uint8_t *>(mapPtr) + reinterpret_cast<ptrdiff_t>(pixels);
PackPixels(packPixelsParams, *readFormat, area.width * readFormat->pixelBytes,
readPixelBuffer, static_cast<uint8_t *>(dst));
ANGLE_TRY(packBufferVk->unmapImpl(contextVk));
}
else
{
PackPixels(packPixelsParams, *readFormat, area.width * readFormat->pixelBytes,
readPixelBuffer, static_cast<uint8_t *>(pixels));
}
return angle::Result::Continue;
}
// ImageHelper::SubresourceUpdate implementation
ImageHelper::SubresourceUpdate::SubresourceUpdate() : updateSource(UpdateSource::Buffer)
{
data.buffer.bufferHelper = nullptr;
refCounted.buffer = nullptr;
}
ImageHelper::SubresourceUpdate::~SubresourceUpdate() {}
ImageHelper::SubresourceUpdate::SubresourceUpdate(RefCounted<BufferHelper> *bufferIn,
BufferHelper *bufferHelperIn,
const VkBufferImageCopy &copyRegionIn,
angle::FormatID formatID)
: updateSource(UpdateSource::Buffer)
{
refCounted.buffer = bufferIn;
if (refCounted.buffer != nullptr)
{
refCounted.buffer->addRef();
}
data.buffer.bufferHelper = bufferHelperIn;
data.buffer.copyRegion = copyRegionIn;
data.buffer.formatID = formatID;
}
ImageHelper::SubresourceUpdate::SubresourceUpdate(RefCounted<ImageHelper> *imageIn,
const VkImageCopy &copyRegionIn,
angle::FormatID formatID)
: updateSource(UpdateSource::Image)
{
refCounted.image = imageIn;
refCounted.image->addRef();
data.image.copyRegion = copyRegionIn;
data.image.formatID = formatID;
}
ImageHelper::SubresourceUpdate::SubresourceUpdate(VkImageAspectFlags aspectFlags,
const VkClearValue &clearValue,
const gl::ImageIndex &imageIndex)
: SubresourceUpdate(
aspectFlags,
clearValue,
gl::LevelIndex(imageIndex.getLevelIndex()),
imageIndex.hasLayer() ? imageIndex.getLayerIndex() : 0,
imageIndex.hasLayer() ? imageIndex.getLayerCount() : VK_REMAINING_ARRAY_LAYERS)
{}
ImageHelper::SubresourceUpdate::SubresourceUpdate(VkImageAspectFlags aspectFlags,
const VkClearValue &clearValue,
gl::LevelIndex level,
uint32_t layerIndex,
uint32_t layerCount)
: updateSource(UpdateSource::Clear)
{
refCounted.image = nullptr;
data.clear.aspectFlags = aspectFlags;
data.clear.value = clearValue;
data.clear.levelIndex = level.get();
data.clear.layerIndex = layerIndex;
data.clear.layerCount = layerCount;
data.clear.colorMaskFlags = 0;
}
ImageHelper::SubresourceUpdate::SubresourceUpdate(VkColorComponentFlags colorMaskFlags,
const VkClearColorValue &clearValue,
const gl::ImageIndex &imageIndex)
: updateSource(UpdateSource::ClearEmulatedChannelsOnly)
{
refCounted.image = nullptr;
data.clear.aspectFlags = VK_IMAGE_ASPECT_COLOR_BIT;
data.clear.value.color = clearValue;
data.clear.levelIndex = imageIndex.getLevelIndex();
data.clear.layerIndex = imageIndex.hasLayer() ? imageIndex.getLayerIndex() : 0;
data.clear.layerCount =
imageIndex.hasLayer() ? imageIndex.getLayerCount() : VK_REMAINING_ARRAY_LAYERS;
data.clear.colorMaskFlags = colorMaskFlags;
}
ImageHelper::SubresourceUpdate::SubresourceUpdate(SubresourceUpdate &&other)
: updateSource(other.updateSource)
{
switch (updateSource)
{
case UpdateSource::Clear:
case UpdateSource::ClearEmulatedChannelsOnly:
case UpdateSource::ClearAfterInvalidate:
data.clear = other.data.clear;
refCounted.buffer = nullptr;
break;
case UpdateSource::Buffer:
data.buffer = other.data.buffer;
refCounted.buffer = other.refCounted.buffer;
other.refCounted.buffer = nullptr;
break;
case UpdateSource::Image:
data.image = other.data.image;
refCounted.image = other.refCounted.image;
other.refCounted.image = nullptr;
break;
default:
UNREACHABLE();
}
}
ImageHelper::SubresourceUpdate &ImageHelper::SubresourceUpdate::operator=(SubresourceUpdate &&other)
{
// Given that the update is a union of three structs, we can't use std::swap on the fields. For
// example, |this| may be an Image update and |other| may be a Buffer update.
// The following could work:
//
// SubresourceUpdate oldThis;
// Set oldThis to this->field based on updateSource
// Set this->otherField to other.otherField based on other.updateSource
// Set other.field to oldThis->field based on updateSource
// std::Swap(updateSource, other.updateSource);
//
// It's much simpler to just swap the memory instead.
SubresourceUpdate oldThis;
memcpy(&oldThis, this, sizeof(*this));
memcpy(this, &other, sizeof(*this));
memcpy(&other, &oldThis, sizeof(*this));
return *this;
}
void ImageHelper::SubresourceUpdate::release(RendererVk *renderer)
{
if (updateSource == UpdateSource::Image)
{
refCounted.image->releaseRef();
if (!refCounted.image->isReferenced())
{
// Staging images won't be used in render pass attachments.
refCounted.image->get().releaseImage(renderer);
refCounted.image->get().releaseStagedUpdates(renderer);
SafeDelete(refCounted.image);
}
refCounted.image = nullptr;
}
else if (updateSource == UpdateSource::Buffer && refCounted.buffer != nullptr)
{
refCounted.buffer->releaseRef();
if (!refCounted.buffer->isReferenced())
{
refCounted.buffer->get().release(renderer);
SafeDelete(refCounted.buffer);
}
refCounted.buffer = nullptr;
}
}
bool ImageHelper::SubresourceUpdate::isUpdateToLayers(uint32_t layerIndex,
uint32_t layerCount) const
{
uint32_t updateBaseLayer, updateLayerCount;
getDestSubresource(gl::ImageIndex::kEntireLevel, &updateBaseLayer, &updateLayerCount);
return updateBaseLayer == layerIndex &&
(updateLayerCount == layerCount || updateLayerCount == VK_REMAINING_ARRAY_LAYERS);
}
void ImageHelper::SubresourceUpdate::getDestSubresource(uint32_t imageLayerCount,
uint32_t *baseLayerOut,
uint32_t *layerCountOut) const
{
if (IsClear(updateSource))
{
*baseLayerOut = data.clear.layerIndex;
*layerCountOut = data.clear.layerCount;
if (*layerCountOut == static_cast<uint32_t>(gl::ImageIndex::kEntireLevel))
{
*layerCountOut = imageLayerCount;
}
}
else
{
const VkImageSubresourceLayers &dstSubresource =
updateSource == UpdateSource::Buffer ? data.buffer.copyRegion.imageSubresource
: data.image.copyRegion.dstSubresource;
*baseLayerOut = dstSubresource.baseArrayLayer;
*layerCountOut = dstSubresource.layerCount;
ASSERT(*layerCountOut != static_cast<uint32_t>(gl::ImageIndex::kEntireLevel));
}
}
VkImageAspectFlags ImageHelper::SubresourceUpdate::getDestAspectFlags() const
{
if (IsClear(updateSource))
{
return data.clear.aspectFlags;
}
else if (updateSource == UpdateSource::Buffer)
{
return data.buffer.copyRegion.imageSubresource.aspectMask;
}
else
{
ASSERT(updateSource == UpdateSource::Image);
return data.image.copyRegion.dstSubresource.aspectMask;
}
}
std::vector<ImageHelper::SubresourceUpdate> *ImageHelper::getLevelUpdates(gl::LevelIndex level)
{
return static_cast<size_t>(level.get()) < mSubresourceUpdates.size()
? &mSubresourceUpdates[level.get()]
: nullptr;
}
const std::vector<ImageHelper::SubresourceUpdate> *ImageHelper::getLevelUpdates(
gl::LevelIndex level) const
{
return static_cast<size_t>(level.get()) < mSubresourceUpdates.size()
? &mSubresourceUpdates[level.get()]
: nullptr;
}
void ImageHelper::appendSubresourceUpdate(gl::LevelIndex level, SubresourceUpdate &&update)
{
if (mSubresourceUpdates.size() <= static_cast<size_t>(level.get()))
{
mSubresourceUpdates.resize(level.get() + 1);
}
mSubresourceUpdates[level.get()].emplace_back(std::move(update));
onStateChange(angle::SubjectMessage::SubjectChanged);
}
void ImageHelper::prependSubresourceUpdate(gl::LevelIndex level, SubresourceUpdate &&update)
{
if (mSubresourceUpdates.size() <= static_cast<size_t>(level.get()))
{
mSubresourceUpdates.resize(level.get() + 1);
}
mSubresourceUpdates[level.get()].insert(mSubresourceUpdates[level.get()].begin(),
std::move(update));
onStateChange(angle::SubjectMessage::SubjectChanged);
}
bool ImageHelper::hasEmulatedImageChannels() const
{
const angle::Format &angleFmt = getIntendedFormat();
const angle::Format &textureFmt = getActualFormat();
// The red channel is never emulated.
ASSERT((angleFmt.redBits != 0 || angleFmt.luminanceBits != 0 || angleFmt.alphaBits != 0) ==
(textureFmt.redBits != 0));
return (angleFmt.alphaBits == 0 && textureFmt.alphaBits > 0) ||
(angleFmt.blueBits == 0 && textureFmt.blueBits > 0) ||
(angleFmt.greenBits == 0 && textureFmt.greenBits > 0) ||
(angleFmt.depthBits == 0 && textureFmt.depthBits > 0) ||
(angleFmt.stencilBits == 0 && textureFmt.stencilBits > 0);
}
bool ImageHelper::hasEmulatedDepthChannel() const
{
return getIntendedFormat().depthBits == 0 && getActualFormat().depthBits > 0;
}
bool ImageHelper::hasEmulatedStencilChannel() const
{
return getIntendedFormat().stencilBits == 0 && getActualFormat().stencilBits > 0;
}
VkColorComponentFlags ImageHelper::getEmulatedChannelsMask() const
{
const angle::Format &angleFmt = getIntendedFormat();
const angle::Format &textureFmt = getActualFormat();
ASSERT(!angleFmt.hasDepthOrStencilBits());
VkColorComponentFlags emulatedChannelsMask = 0;
if (angleFmt.alphaBits == 0 && textureFmt.alphaBits > 0)
{
emulatedChannelsMask |= VK_COLOR_COMPONENT_A_BIT;
}
if (angleFmt.blueBits == 0 && textureFmt.blueBits > 0)
{
emulatedChannelsMask |= VK_COLOR_COMPONENT_B_BIT;
}
if (angleFmt.greenBits == 0 && textureFmt.greenBits > 0)
{
emulatedChannelsMask |= VK_COLOR_COMPONENT_G_BIT;
}
// The red channel is never emulated.
ASSERT((angleFmt.redBits != 0 || angleFmt.luminanceBits != 0 || angleFmt.alphaBits != 0) ==
(textureFmt.redBits != 0));
return emulatedChannelsMask;
}
// FramebufferHelper implementation.
FramebufferHelper::FramebufferHelper() = default;
FramebufferHelper::~FramebufferHelper() = default;
FramebufferHelper::FramebufferHelper(FramebufferHelper &&other) : Resource(std::move(other))
{
mFramebuffer = std::move(other.mFramebuffer);
}
FramebufferHelper &FramebufferHelper::operator=(FramebufferHelper &&other)
{
std::swap(mUse, other.mUse);
std::swap(mFramebuffer, other.mFramebuffer);
return *this;
}
angle::Result FramebufferHelper::init(ContextVk *contextVk,
const VkFramebufferCreateInfo &createInfo)
{
ANGLE_VK_TRY(contextVk, mFramebuffer.init(contextVk->getDevice(), createInfo));
return angle::Result::Continue;
}
void FramebufferHelper::release(ContextVk *contextVk)
{
contextVk->addGarbage(&mFramebuffer);
}
LayerMode GetLayerMode(const vk::ImageHelper &image, uint32_t layerCount)
{
const uint32_t imageLayerCount = GetImageLayerCountForView(image);
const bool allLayers = layerCount == imageLayerCount;
ASSERT(allLayers || layerCount > 0 && layerCount <= gl::IMPLEMENTATION_MAX_TEXTURE_LEVELS);
return allLayers ? LayerMode::All : static_cast<LayerMode>(layerCount);
}
// ImageViewHelper implementation.
ImageViewHelper::ImageViewHelper() : mCurrentBaseMaxLevelHash(0), mLinearColorspace(true) {}
ImageViewHelper::ImageViewHelper(ImageViewHelper &&other)
{
std::swap(mCurrentBaseMaxLevelHash, other.mCurrentBaseMaxLevelHash);
std::swap(mLinearColorspace, other.mLinearColorspace);
std::swap(mPerLevelRangeLinearReadImageViews, other.mPerLevelRangeLinearReadImageViews);
std::swap(mPerLevelRangeSRGBReadImageViews, other.mPerLevelRangeSRGBReadImageViews);
std::swap(mPerLevelRangeLinearFetchImageViews, other.mPerLevelRangeLinearFetchImageViews);
std::swap(mPerLevelRangeSRGBFetchImageViews, other.mPerLevelRangeSRGBFetchImageViews);
std::swap(mPerLevelRangeLinearCopyImageViews, other.mPerLevelRangeLinearCopyImageViews);
std::swap(mPerLevelRangeSRGBCopyImageViews, other.mPerLevelRangeSRGBCopyImageViews);
std::swap(mPerLevelRangeStencilReadImageViews, other.mPerLevelRangeStencilReadImageViews);
std::swap(mLayerLevelDrawImageViews, other.mLayerLevelDrawImageViews);
std::swap(mLayerLevelDrawImageViewsLinear, other.mLayerLevelDrawImageViewsLinear);
std::swap(mSubresourceDrawImageViews, other.mSubresourceDrawImageViews);
std::swap(mLevelStorageImageViews, other.mLevelStorageImageViews);
std::swap(mLayerLevelStorageImageViews, other.mLayerLevelStorageImageViews);
std::swap(mImageViewSerial, other.mImageViewSerial);
}
ImageViewHelper::~ImageViewHelper() {}
void ImageViewHelper::init(RendererVk *renderer)
{
if (!mImageViewSerial.valid())
{
mImageViewSerial = renderer->getResourceSerialFactory().generateImageOrBufferViewSerial();
}
}
void ImageViewHelper::release(RendererVk *renderer, std::vector<vk::GarbageObject> &garbage)
{
mCurrentBaseMaxLevelHash = 0;
// Release the read views
ReleaseImageViews(&mPerLevelRangeLinearReadImageViews, &garbage);
ReleaseImageViews(&mPerLevelRangeSRGBReadImageViews, &garbage);
ReleaseImageViews(&mPerLevelRangeLinearFetchImageViews, &garbage);
ReleaseImageViews(&mPerLevelRangeSRGBFetchImageViews, &garbage);
ReleaseImageViews(&mPerLevelRangeLinearCopyImageViews, &garbage);
ReleaseImageViews(&mPerLevelRangeSRGBCopyImageViews, &garbage);
ReleaseImageViews(&mPerLevelRangeStencilReadImageViews, &garbage);
// Release the draw views
for (ImageViewVector &layerViews : mLayerLevelDrawImageViews)
{
for (ImageView &imageView : layerViews)
{
if (imageView.valid())
{
garbage.emplace_back(GetGarbage(&imageView));
}
}
}
mLayerLevelDrawImageViews.clear();
for (ImageViewVector &layerViews : mLayerLevelDrawImageViewsLinear)
{
for (ImageView &imageView : layerViews)
{
if (imageView.valid())
{
garbage.emplace_back(GetGarbage(&imageView));
}
}
}
mLayerLevelDrawImageViewsLinear.clear();
for (auto &iter : mSubresourceDrawImageViews)
{
std::unique_ptr<ImageView> &imageView = iter.second;
if (imageView->valid())
{
garbage.emplace_back(GetGarbage(imageView.get()));
}
}
mSubresourceDrawImageViews.clear();
// Release the storage views
ReleaseImageViews(&mLevelStorageImageViews, &garbage);
for (ImageViewVector &layerViews : mLayerLevelStorageImageViews)
{
for (ImageView &imageView : layerViews)
{
if (imageView.valid())
{
garbage.emplace_back(GetGarbage(&imageView));
}
}
}
mLayerLevelStorageImageViews.clear();
// Update image view serial.
mImageViewSerial = renderer->getResourceSerialFactory().generateImageOrBufferViewSerial();
}
bool ImageViewHelper::isImageViewGarbageEmpty() const
{
return mPerLevelRangeLinearReadImageViews.empty() &&
mPerLevelRangeLinearCopyImageViews.empty() &&
mPerLevelRangeLinearFetchImageViews.empty() &&
mPerLevelRangeSRGBReadImageViews.empty() && mPerLevelRangeSRGBCopyImageViews.empty() &&
mPerLevelRangeSRGBFetchImageViews.empty() &&
mPerLevelRangeStencilReadImageViews.empty() && mLayerLevelDrawImageViews.empty() &&
mLayerLevelDrawImageViewsLinear.empty() && mSubresourceDrawImageViews.empty() &&
mLayerLevelStorageImageViews.empty();
}
void ImageViewHelper::destroy(VkDevice device)
{
mCurrentBaseMaxLevelHash = 0;
// Release the read views
DestroyImageViews(&mPerLevelRangeLinearReadImageViews, device);
DestroyImageViews(&mPerLevelRangeSRGBReadImageViews, device);
DestroyImageViews(&mPerLevelRangeLinearFetchImageViews, device);
DestroyImageViews(&mPerLevelRangeSRGBFetchImageViews, device);
DestroyImageViews(&mPerLevelRangeLinearCopyImageViews, device);
DestroyImageViews(&mPerLevelRangeSRGBCopyImageViews, device);
DestroyImageViews(&mPerLevelRangeStencilReadImageViews, device);
// Release the draw views
for (ImageViewVector &layerViews : mLayerLevelDrawImageViews)
{
for (ImageView &imageView : layerViews)
{
imageView.destroy(device);
}
}
mLayerLevelDrawImageViews.clear();
for (ImageViewVector &layerViews : mLayerLevelDrawImageViewsLinear)
{
for (ImageView &imageView : layerViews)
{
imageView.destroy(device);
}
}
mLayerLevelDrawImageViewsLinear.clear();
for (auto &iter : mSubresourceDrawImageViews)
{
std::unique_ptr<ImageView> &imageView = iter.second;
imageView->destroy(device);
}
mSubresourceDrawImageViews.clear();
// Release the storage views
DestroyImageViews(&mLevelStorageImageViews, device);
for (ImageViewVector &layerViews : mLayerLevelStorageImageViews)
{
for (ImageView &imageView : layerViews)
{
imageView.destroy(device);
}
}
mLayerLevelStorageImageViews.clear();
mImageViewSerial = kInvalidImageOrBufferViewSerial;
}
angle::Result ImageViewHelper::initReadViews(ContextVk *contextVk,
gl::TextureType viewType,
const ImageHelper &image,
const gl::SwizzleState &formatSwizzle,
const gl::SwizzleState &readSwizzle,
LevelIndex baseLevel,
uint32_t levelCount,
uint32_t baseLayer,
uint32_t layerCount,
bool requiresSRGBViews,
VkImageUsageFlags imageUsageFlags)
{
ASSERT(levelCount > 0);
const uint32_t maxLevel = levelCount - 1;
ASSERT(maxLevel < 16);
ASSERT(baseLevel.get() < 16);
mCurrentBaseMaxLevelHash = static_cast<uint8_t>(baseLevel.get() << 4 | maxLevel);
if (mCurrentBaseMaxLevelHash >= mPerLevelRangeLinearReadImageViews.size())
{
const uint32_t maxViewCount = mCurrentBaseMaxLevelHash + 1;
mPerLevelRangeLinearReadImageViews.resize(maxViewCount);
mPerLevelRangeSRGBReadImageViews.resize(maxViewCount);
mPerLevelRangeLinearFetchImageViews.resize(maxViewCount);
mPerLevelRangeSRGBFetchImageViews.resize(maxViewCount);
mPerLevelRangeLinearCopyImageViews.resize(maxViewCount);
mPerLevelRangeSRGBCopyImageViews.resize(maxViewCount);
mPerLevelRangeStencilReadImageViews.resize(maxViewCount);
}
// Determine if we already have ImageViews for the new max level
if (getReadImageView().valid())
{
return angle::Result::Continue;
}
// Since we don't have a readImageView, we must create ImageViews for the new max level
ANGLE_TRY(initReadViewsImpl(contextVk, viewType, image, formatSwizzle, readSwizzle, baseLevel,
levelCount, baseLayer, layerCount));
if (requiresSRGBViews)
{
ANGLE_TRY(initSRGBReadViewsImpl(contextVk, viewType, image, formatSwizzle, readSwizzle,
baseLevel, levelCount, baseLayer, layerCount,
imageUsageFlags));
}
return angle::Result::Continue;
}
angle::Result ImageViewHelper::initReadViewsImpl(ContextVk *contextVk,
gl::TextureType viewType,
const ImageHelper &image,
const gl::SwizzleState &formatSwizzle,
const gl::SwizzleState &readSwizzle,
LevelIndex baseLevel,
uint32_t levelCount,
uint32_t baseLayer,
uint32_t layerCount)
{
ASSERT(mImageViewSerial.valid());
const VkImageAspectFlags aspectFlags = GetFormatAspectFlags(image.getIntendedFormat());
mLinearColorspace = !image.getActualFormat().isSRGB;
if (HasBothDepthAndStencilAspects(aspectFlags))
{
ANGLE_TRY(image.initLayerImageView(
contextVk, viewType, VK_IMAGE_ASPECT_DEPTH_BIT, readSwizzle, &getReadImageView(),
baseLevel, levelCount, baseLayer, layerCount, gl::SrgbWriteControlMode::Default));
ANGLE_TRY(image.initLayerImageView(
contextVk, viewType, VK_IMAGE_ASPECT_STENCIL_BIT, readSwizzle,
&mPerLevelRangeStencilReadImageViews[mCurrentBaseMaxLevelHash], baseLevel, levelCount,
baseLayer, layerCount, gl::SrgbWriteControlMode::Default));
}
else
{
ANGLE_TRY(image.initLayerImageView(contextVk, viewType, aspectFlags, readSwizzle,
&getReadImageView(), baseLevel, levelCount, baseLayer,
layerCount, gl::SrgbWriteControlMode::Default));
}
gl::TextureType fetchType = viewType;
if (viewType == gl::TextureType::CubeMap || viewType == gl::TextureType::_2DArray ||
viewType == gl::TextureType::_2DMultisampleArray)
{
fetchType = Get2DTextureType(layerCount, image.getSamples());
ANGLE_TRY(image.initLayerImageView(contextVk, fetchType, aspectFlags, readSwizzle,
&getFetchImageView(), baseLevel, levelCount, baseLayer,
layerCount, gl::SrgbWriteControlMode::Default));
}
ANGLE_TRY(image.initLayerImageView(contextVk, fetchType, aspectFlags, formatSwizzle,
&getCopyImageView(), baseLevel, levelCount, baseLayer,
layerCount, gl::SrgbWriteControlMode::Default));
return angle::Result::Continue;
}
angle::Result ImageViewHelper::initSRGBReadViewsImpl(ContextVk *contextVk,
gl::TextureType viewType,
const ImageHelper &image,
const gl::SwizzleState &formatSwizzle,
const gl::SwizzleState &readSwizzle,
LevelIndex baseLevel,
uint32_t levelCount,
uint32_t baseLayer,
uint32_t layerCount,
VkImageUsageFlags imageUsageFlags)
{
// When we select the linear/srgb counterpart formats, we must first make sure they're
// actually supported by the ICD. If they are not supported by the ICD, then we treat that as if
// there is no counterpart format. (In this case, the relevant extension should not be exposed)
angle::FormatID srgbOverrideFormat = ConvertToSRGB(image.getActualFormatID());
ASSERT((srgbOverrideFormat == angle::FormatID::NONE) ||
(HasNonRenderableTextureFormatSupport(contextVk->getRenderer(), srgbOverrideFormat)));
angle::FormatID linearOverrideFormat = ConvertToLinear(image.getActualFormatID());
ASSERT((linearOverrideFormat == angle::FormatID::NONE) ||
(HasNonRenderableTextureFormatSupport(contextVk->getRenderer(), linearOverrideFormat)));
angle::FormatID linearFormat = (linearOverrideFormat != angle::FormatID::NONE)
? linearOverrideFormat
: image.getActualFormatID();
ASSERT(linearFormat != angle::FormatID::NONE);
const VkImageAspectFlags aspectFlags = GetFormatAspectFlags(image.getIntendedFormat());
if (!mPerLevelRangeLinearReadImageViews[mCurrentBaseMaxLevelHash].valid())
{
ANGLE_TRY(image.initReinterpretedLayerImageView(
contextVk, viewType, aspectFlags, readSwizzle,
&mPerLevelRangeLinearReadImageViews[mCurrentBaseMaxLevelHash], baseLevel, levelCount,
baseLayer, layerCount, imageUsageFlags, linearFormat));
}
if (srgbOverrideFormat != angle::FormatID::NONE &&
!mPerLevelRangeSRGBReadImageViews[mCurrentBaseMaxLevelHash].valid())
{
ANGLE_TRY(image.initReinterpretedLayerImageView(
contextVk, viewType, aspectFlags, readSwizzle,
&mPerLevelRangeSRGBReadImageViews[mCurrentBaseMaxLevelHash], baseLevel, levelCount,
baseLayer, layerCount, imageUsageFlags, srgbOverrideFormat));
}
gl::TextureType fetchType = viewType;
if (viewType == gl::TextureType::CubeMap || viewType == gl::TextureType::_2DArray ||
viewType == gl::TextureType::_2DMultisampleArray)
{
fetchType = Get2DTextureType(layerCount, image.getSamples());
if (!mPerLevelRangeLinearFetchImageViews[mCurrentBaseMaxLevelHash].valid())
{
ANGLE_TRY(image.initReinterpretedLayerImageView(
contextVk, fetchType, aspectFlags, readSwizzle,
&mPerLevelRangeLinearFetchImageViews[mCurrentBaseMaxLevelHash], baseLevel,
levelCount, baseLayer, layerCount, imageUsageFlags, linearFormat));
}
if (srgbOverrideFormat != angle::FormatID::NONE &&
!mPerLevelRangeSRGBFetchImageViews[mCurrentBaseMaxLevelHash].valid())
{
ANGLE_TRY(image.initReinterpretedLayerImageView(
contextVk, fetchType, aspectFlags, readSwizzle,
&mPerLevelRangeSRGBFetchImageViews[mCurrentBaseMaxLevelHash], baseLevel, levelCount,
baseLayer, layerCount, imageUsageFlags, srgbOverrideFormat));
}
}
if (!mPerLevelRangeLinearCopyImageViews[mCurrentBaseMaxLevelHash].valid())
{
ANGLE_TRY(image.initReinterpretedLayerImageView(
contextVk, fetchType, aspectFlags, formatSwizzle,
&mPerLevelRangeLinearCopyImageViews[mCurrentBaseMaxLevelHash], baseLevel, levelCount,
baseLayer, layerCount, imageUsageFlags, linearFormat));
}
if (srgbOverrideFormat != angle::FormatID::NONE &&
!mPerLevelRangeSRGBCopyImageViews[mCurrentBaseMaxLevelHash].valid())
{
ANGLE_TRY(image.initReinterpretedLayerImageView(
contextVk, fetchType, aspectFlags, formatSwizzle,
&mPerLevelRangeSRGBCopyImageViews[mCurrentBaseMaxLevelHash], baseLevel, levelCount,
baseLayer, layerCount, imageUsageFlags, srgbOverrideFormat));
}
return angle::Result::Continue;
}
angle::Result ImageViewHelper::getLevelStorageImageView(Context *context,
gl::TextureType viewType,
const ImageHelper &image,
LevelIndex levelVk,
uint32_t layer,
VkImageUsageFlags imageUsageFlags,
angle::FormatID formatID,
const ImageView **imageViewOut)
{
ASSERT(mImageViewSerial.valid());
ImageView *imageView =
GetLevelImageView(&mLevelStorageImageViews, levelVk, image.getLevelCount());
*imageViewOut = imageView;
if (imageView->valid())
{
return angle::Result::Continue;
}
// Create the view. Note that storage images are not affected by swizzle parameters.
return image.initReinterpretedLayerImageView(context, viewType, image.getAspectFlags(),
gl::SwizzleState(), imageView, levelVk, 1, layer,
image.getLayerCount(), imageUsageFlags, formatID);
}
angle::Result ImageViewHelper::getLevelLayerStorageImageView(Context *contextVk,
const ImageHelper &image,
LevelIndex levelVk,
uint32_t layer,
VkImageUsageFlags imageUsageFlags,
angle::FormatID formatID,
const ImageView **imageViewOut)
{
ASSERT(image.valid());
ASSERT(mImageViewSerial.valid());
ASSERT(!image.getActualFormat().isBlock);
ImageView *imageView =
GetLevelLayerImageView(&mLayerLevelStorageImageViews, levelVk, layer, image.getLevelCount(),
GetImageLayerCountForView(image));
*imageViewOut = imageView;
if (imageView->valid())
{
return angle::Result::Continue;
}
// Create the view. Note that storage images are not affected by swizzle parameters.
gl::TextureType viewType = Get2DTextureType(1, image.getSamples());
return image.initReinterpretedLayerImageView(contextVk, viewType, image.getAspectFlags(),
gl::SwizzleState(), imageView, levelVk, 1, layer,
1, imageUsageFlags, formatID);
}
angle::Result ImageViewHelper::getLevelDrawImageView(Context *context,
const ImageHelper &image,
LevelIndex levelVk,
uint32_t layer,
uint32_t layerCount,
gl::SrgbWriteControlMode mode,
const ImageView **imageViewOut)
{
ASSERT(image.valid());
ASSERT(mImageViewSerial.valid());
ASSERT(!image.getActualFormat().isBlock);
ImageSubresourceRange range = MakeImageSubresourceDrawRange(
image.toGLLevel(levelVk), layer, GetLayerMode(image, layerCount), mode);
std::unique_ptr<ImageView> &view = mSubresourceDrawImageViews[range];
if (view)
{
*imageViewOut = view.get();
return angle::Result::Continue;
}
view = std::make_unique<ImageView>();
*imageViewOut = view.get();
// Lazily allocate the image view.
// Note that these views are specifically made to be used as framebuffer attachments, and
// therefore don't have swizzle.
gl::TextureType viewType = Get2DTextureType(layerCount, image.getSamples());
return image.initLayerImageView(context, viewType, image.getAspectFlags(), gl::SwizzleState(),
view.get(), levelVk, 1, layer, layerCount, mode);
}
angle::Result ImageViewHelper::getLevelLayerDrawImageView(Context *context,
const ImageHelper &image,
LevelIndex levelVk,
uint32_t layer,
gl::SrgbWriteControlMode mode,
const ImageView **imageViewOut)
{
ASSERT(image.valid());
ASSERT(mImageViewSerial.valid());
ASSERT(!image.getActualFormat().isBlock);
LayerLevelImageViewVector &imageViews = (mode == gl::SrgbWriteControlMode::Linear)
? mLayerLevelDrawImageViewsLinear
: mLayerLevelDrawImageViews;
// Lazily allocate the storage for image views
ImageView *imageView = GetLevelLayerImageView(
&imageViews, levelVk, layer, image.getLevelCount(), GetImageLayerCountForView(image));
*imageViewOut = imageView;
if (imageView->valid())
{
return angle::Result::Continue;
}
// Lazily allocate the image view itself.
// Note that these views are specifically made to be used as framebuffer attachments, and
// therefore don't have swizzle.
gl::TextureType viewType = Get2DTextureType(1, image.getSamples());
return image.initLayerImageView(context, viewType, image.getAspectFlags(), gl::SwizzleState(),
imageView, levelVk, 1, layer, 1, mode);
}
ImageOrBufferViewSubresourceSerial ImageViewHelper::getSubresourceSerial(
gl::LevelIndex levelGL,
uint32_t levelCount,
uint32_t layer,
LayerMode layerMode,
SrgbDecodeMode srgbDecodeMode,
gl::SrgbOverride srgbOverrideMode) const
{
ASSERT(mImageViewSerial.valid());
ImageOrBufferViewSubresourceSerial serial;
serial.viewSerial = mImageViewSerial;
serial.subresource = MakeImageSubresourceReadRange(levelGL, levelCount, layer, layerMode,
srgbDecodeMode, srgbOverrideMode);
return serial;
}
ImageSubresourceRange MakeImageSubresourceReadRange(gl::LevelIndex level,
uint32_t levelCount,
uint32_t layer,
LayerMode layerMode,
SrgbDecodeMode srgbDecodeMode,
gl::SrgbOverride srgbOverrideMode)
{
ImageSubresourceRange range;
SetBitField(range.level, level.get());
SetBitField(range.levelCount, levelCount);
SetBitField(range.layer, layer);
SetBitField(range.layerMode, layerMode);
SetBitField(range.srgbDecodeMode, srgbDecodeMode);
SetBitField(range.srgbMode, srgbOverrideMode);
return range;
}
ImageSubresourceRange MakeImageSubresourceDrawRange(gl::LevelIndex level,
uint32_t layer,
LayerMode layerMode,
gl::SrgbWriteControlMode srgbWriteControlMode)
{
ImageSubresourceRange range;
SetBitField(range.level, level.get());
SetBitField(range.levelCount, 1);
SetBitField(range.layer, layer);
SetBitField(range.layerMode, layerMode);
SetBitField(range.srgbDecodeMode, 0);
SetBitField(range.srgbMode, srgbWriteControlMode);
return range;
}
// BufferViewHelper implementation.
BufferViewHelper::BufferViewHelper() : mOffset(0), mSize(0) {}
BufferViewHelper::BufferViewHelper(BufferViewHelper &&other) : Resource(std::move(other))
{
std::swap(mOffset, other.mOffset);
std::swap(mSize, other.mSize);
std::swap(mViews, other.mViews);
std::swap(mViewSerial, other.mViewSerial);
}
BufferViewHelper::~BufferViewHelper() {}
void BufferViewHelper::init(RendererVk *renderer, VkDeviceSize offset, VkDeviceSize size)
{
ASSERT(mViews.empty());
mOffset = offset;
mSize = size;
if (!mViewSerial.valid())
{
mViewSerial = renderer->getResourceSerialFactory().generateImageOrBufferViewSerial();
}
}
void BufferViewHelper::release(ContextVk *contextVk)
{
contextVk->flushDescriptorSetUpdates();
std::vector<GarbageObject> garbage;
for (auto &formatAndView : mViews)
{
BufferView &view = formatAndView.second;
ASSERT(view.valid());
garbage.emplace_back(GetGarbage(&view));
}
if (!garbage.empty())
{
RendererVk *rendererVk = contextVk->getRenderer();
rendererVk->collectGarbage(std::move(mUse), std::move(garbage));
// Ensure the resource use is always valid.
mUse.init();
// Update image view serial.
mViewSerial = rendererVk->getResourceSerialFactory().generateImageOrBufferViewSerial();
}
mViews.clear();
mOffset = 0;
mSize = 0;
}
void BufferViewHelper::destroy(VkDevice device)
{
for (auto &formatAndView : mViews)
{
BufferView &view = formatAndView.second;
view.destroy(device);
}
mViews.clear();
mOffset = 0;
mSize = 0;
mViewSerial = kInvalidImageOrBufferViewSerial;
}
angle::Result BufferViewHelper::getView(Context *context,
const BufferHelper &buffer,
VkDeviceSize bufferOffset,
const Format &format,
const BufferView **viewOut)
{
ASSERT(format.valid());
VkFormat viewVkFormat = format.getActualBufferVkFormat(false);
auto iter = mViews.find(viewVkFormat);
if (iter != mViews.end())
{
*viewOut = &iter->second;
return angle::Result::Continue;
}
// If the size is not a multiple of pixelBytes, remove the extra bytes. The last element cannot
// be read anyway, and this is a requirement of Vulkan (for size to be a multiple of format
// texel block size).
const angle::Format &bufferFormat = format.getActualBufferFormat(false);
const GLuint pixelBytes = bufferFormat.pixelBytes;
VkDeviceSize size = mSize - mSize % pixelBytes;
VkBufferViewCreateInfo viewCreateInfo = {};
viewCreateInfo.sType = VK_STRUCTURE_TYPE_BUFFER_VIEW_CREATE_INFO;
viewCreateInfo.buffer = buffer.getBuffer().getHandle();
viewCreateInfo.format = viewVkFormat;
viewCreateInfo.offset = mOffset + bufferOffset;
viewCreateInfo.range = size;
BufferView view;
ANGLE_VK_TRY(context, view.init(context->getDevice(), viewCreateInfo));
// Cache the view
auto insertIter = mViews.insert({viewVkFormat, std::move(view)});
*viewOut = &insertIter.first->second;
ASSERT(insertIter.second);
return angle::Result::Continue;
}
ImageOrBufferViewSubresourceSerial BufferViewHelper::getSerial() const
{
ASSERT(mViewSerial.valid());
ImageOrBufferViewSubresourceSerial serial = {};
serial.viewSerial = mViewSerial;
return serial;
}
// ShaderProgramHelper implementation.
ShaderProgramHelper::ShaderProgramHelper() : mSpecializationConstants{} {}
ShaderProgramHelper::~ShaderProgramHelper() = default;
bool ShaderProgramHelper::valid(const gl::ShaderType shaderType) const
{
return mShaders[shaderType].valid();
}
void ShaderProgramHelper::destroy(RendererVk *rendererVk)
{
mGraphicsPipelines.destroy(rendererVk);
mComputePipeline.destroy(rendererVk->getDevice());
for (BindingPointer<ShaderAndSerial> &shader : mShaders)
{
shader.reset();
}
}
void ShaderProgramHelper::release(ContextVk *contextVk)
{
mGraphicsPipelines.release(contextVk);
contextVk->addGarbage(&mComputePipeline.getPipeline());
for (BindingPointer<ShaderAndSerial> &shader : mShaders)
{
shader.reset();
}
}
void ShaderProgramHelper::setShader(gl::ShaderType shaderType, RefCounted<ShaderAndSerial> *shader)
{
mShaders[shaderType].set(shader);
}
void ShaderProgramHelper::setSpecializationConstant(sh::vk::SpecializationConstantId id,
uint32_t value)
{
ASSERT(id < sh::vk::SpecializationConstantId::EnumCount);
switch (id)
{
case sh::vk::SpecializationConstantId::LineRasterEmulation:
mSpecializationConstants.lineRasterEmulation = value;
break;
case sh::vk::SpecializationConstantId::SurfaceRotation:
mSpecializationConstants.surfaceRotation = value;
break;
case sh::vk::SpecializationConstantId::Dither:
mSpecializationConstants.dither = value;
break;
default:
UNREACHABLE();
break;
}
}
angle::Result ShaderProgramHelper::getComputePipeline(Context *context,
const PipelineLayout &pipelineLayout,
PipelineHelper **pipelineOut)
{
if (mComputePipeline.valid())
{
*pipelineOut = &mComputePipeline;
return angle::Result::Continue;
}
RendererVk *renderer = context->getRenderer();
VkPipelineShaderStageCreateInfo shaderStage = {};
VkComputePipelineCreateInfo createInfo = {};
shaderStage.sType = VK_STRUCTURE_TYPE_PIPELINE_SHADER_STAGE_CREATE_INFO;
shaderStage.flags = 0;
shaderStage.stage = VK_SHADER_STAGE_COMPUTE_BIT;
shaderStage.module = mShaders[gl::ShaderType::Compute].get().get().getHandle();
shaderStage.pName = "main";
shaderStage.pSpecializationInfo = nullptr;
createInfo.sType = VK_STRUCTURE_TYPE_COMPUTE_PIPELINE_CREATE_INFO;
createInfo.flags = 0;
createInfo.stage = shaderStage;
createInfo.layout = pipelineLayout.getHandle();
createInfo.basePipelineHandle = VK_NULL_HANDLE;
createInfo.basePipelineIndex = 0;
PipelineCache *pipelineCache = nullptr;
ANGLE_TRY(renderer->getPipelineCache(&pipelineCache));
ANGLE_VK_TRY(context, mComputePipeline.getPipeline().initCompute(context->getDevice(),
createInfo, *pipelineCache));
*pipelineOut = &mComputePipeline;
return angle::Result::Continue;
}
// ActiveHandleCounter implementation.
ActiveHandleCounter::ActiveHandleCounter() : mActiveCounts{}, mAllocatedCounts{} {}
ActiveHandleCounter::~ActiveHandleCounter() = default;
// CommandBufferAccess implementation.
CommandBufferAccess::CommandBufferAccess() = default;
CommandBufferAccess::~CommandBufferAccess() = default;
void CommandBufferAccess::onBufferRead(VkAccessFlags readAccessType,
PipelineStage readStage,
BufferHelper *buffer)
{
ASSERT(!buffer->isReleasedToExternal());
mReadBuffers.emplace_back(buffer, readAccessType, readStage);
}
void CommandBufferAccess::onBufferWrite(VkAccessFlags writeAccessType,
PipelineStage writeStage,
BufferHelper *buffer)
{
ASSERT(!buffer->isReleasedToExternal());
mWriteBuffers.emplace_back(buffer, writeAccessType, writeStage);
}
void CommandBufferAccess::onImageRead(VkImageAspectFlags aspectFlags,
ImageLayout imageLayout,
ImageHelper *image)
{
ASSERT(!image->isReleasedToExternal());
ASSERT(image->getImageSerial().valid());
mReadImages.emplace_back(image, aspectFlags, imageLayout);
}
void CommandBufferAccess::onImageWrite(gl::LevelIndex levelStart,
uint32_t levelCount,
uint32_t layerStart,
uint32_t layerCount,
VkImageAspectFlags aspectFlags,
ImageLayout imageLayout,
ImageHelper *image)
{
ASSERT(!image->isReleasedToExternal());
ASSERT(image->getImageSerial().valid());
mWriteImages.emplace_back(CommandBufferImageAccess{image, aspectFlags, imageLayout}, levelStart,
levelCount, layerStart, layerCount);
}
void CommandBufferAccess::onBufferExternalAcquireRelease(BufferHelper *buffer)
{
mExternalAcquireReleaseBuffers.emplace_back(CommandBufferBufferExternalAcquireRelease{buffer});
}
void CommandBufferAccess::onResourceAccess(Resource *resource)
{
mAccessResources.emplace_back(CommandBufferResourceAccess{resource});
}
// DescriptorMetaCache implementation.
MetaDescriptorPool::MetaDescriptorPool() = default;
MetaDescriptorPool::~MetaDescriptorPool()
{
ASSERT(mPayload.empty());
}
void MetaDescriptorPool::destroy(RendererVk *rendererVk, VulkanCacheType cacheType)
{
for (auto &iter : mPayload)
{
RefCountedDescriptorPool &refCountedPool = iter.second;
ASSERT(!refCountedPool.isReferenced());
refCountedPool.get().destroy(rendererVk, cacheType);
}
mPayload.clear();
}
angle::Result MetaDescriptorPool::bindCachedDescriptorPool(
Context *context,
const DescriptorSetLayoutDesc &descriptorSetLayoutDesc,
uint32_t descriptorCountMultiplier,
DescriptorSetLayoutCache *descriptorSetLayoutCache,
DescriptorPoolPointer *descriptorPoolOut)
{
auto cacheIter = mPayload.find(descriptorSetLayoutDesc);
if (cacheIter != mPayload.end())
{
RefCountedDescriptorPool &descriptorPool = cacheIter->second;
descriptorPoolOut->set(&descriptorPool);
return angle::Result::Continue;
}
BindingPointer<DescriptorSetLayout> descriptorSetLayout;
ANGLE_TRY(descriptorSetLayoutCache->getDescriptorSetLayout(context, descriptorSetLayoutDesc,
&descriptorSetLayout));
DynamicDescriptorPool newDescriptorPool;
ANGLE_TRY(InitDynamicDescriptorPool(context, descriptorSetLayoutDesc,
descriptorSetLayout.get().getHandle(),
descriptorCountMultiplier, &newDescriptorPool));
auto insertIter = mPayload.emplace(descriptorSetLayoutDesc,
RefCountedDescriptorPool(std::move(newDescriptorPool)));
RefCountedDescriptorPool &descriptorPool = insertIter.first->second;
descriptorPoolOut->set(&descriptorPool);
return angle::Result::Continue;
}
static_assert(static_cast<uint32_t>(PresentMode::ImmediateKHR) == VK_PRESENT_MODE_IMMEDIATE_KHR,
"PresentMode must be updated");
static_assert(static_cast<uint32_t>(PresentMode::MailboxKHR) == VK_PRESENT_MODE_MAILBOX_KHR,
"PresentMode must be updated");
static_assert(static_cast<uint32_t>(PresentMode::FifoKHR) == VK_PRESENT_MODE_FIFO_KHR,
"PresentMode must be updated");
static_assert(static_cast<uint32_t>(PresentMode::FifoRelaxedKHR) ==
VK_PRESENT_MODE_FIFO_RELAXED_KHR,
"PresentMode must be updated");
static_assert(static_cast<uint32_t>(PresentMode::SharedDemandRefreshKHR) ==
VK_PRESENT_MODE_SHARED_DEMAND_REFRESH_KHR,
"PresentMode must be updated");
static_assert(static_cast<uint32_t>(PresentMode::SharedContinuousRefreshKHR) ==
VK_PRESENT_MODE_SHARED_CONTINUOUS_REFRESH_KHR,
"PresentMode must be updated");
VkPresentModeKHR ConvertPresentModeToVkPresentMode(PresentMode presentMode)
{
return static_cast<VkPresentModeKHR>(presentMode);
}
PresentMode ConvertVkPresentModeToPresentMode(VkPresentModeKHR vkPresentMode)
{
return static_cast<PresentMode>(vkPresentMode);
}
} // namespace vk
} // namespace rx