blob: e97a180a3fc76f4296d0b837d05f2b331149efa9 [file] [log] [blame] [edit]
// Copyright 2019 The Dawn & Tint Authors
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
//
// 1. Redistributions of source code must retain the above copyright notice, this
// list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright notice,
// this list of conditions and the following disclaimer in the documentation
// and/or other materials provided with the distribution.
//
// 3. Neither the name of the copyright holder nor the names of its
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
// DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
// FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
// DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
// SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
// CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
// OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
#include "dawn/native/PassResourceUsageTracker.h"
#include <utility>
#include "dawn/common/MatchVariant.h"
#include "dawn/native/BindGroup.h"
#include "dawn/native/Buffer.h"
#include "dawn/native/EnumMaskIterator.h"
#include "dawn/native/ExternalTexture.h"
#include "dawn/native/Format.h"
#include "dawn/native/QuerySet.h"
#include "dawn/native/Texture.h"
namespace dawn::native {
SyncScopeUsageTracker::SyncScopeUsageTracker() = default;
SyncScopeUsageTracker::SyncScopeUsageTracker(SyncScopeUsageTracker&&) = default;
SyncScopeUsageTracker::~SyncScopeUsageTracker() = default;
SyncScopeUsageTracker& SyncScopeUsageTracker::operator=(SyncScopeUsageTracker&&) = default;
void SyncScopeUsageTracker::BufferUsedAs(BufferBase* buffer,
wgpu::BufferUsage usage,
wgpu::ShaderStage shaderStages) {
// std::map's operator[] will create a new element using the default constructor
// if the key didn't exist before.
BufferSyncInfo& bufferSyncInfo = mBufferSyncInfos[buffer];
bufferSyncInfo.usage |= usage;
bufferSyncInfo.shaderStages |= shaderStages;
}
void SyncScopeUsageTracker::TextureViewUsedAs(TextureViewBase* view,
wgpu::TextureUsage usage,
wgpu::ShaderStage shaderStages) {
TextureRangeUsedAs(view->GetTexture(), view->GetSubresourceRange(), usage, shaderStages);
}
void SyncScopeUsageTracker::TextureRangeUsedAs(TextureBase* texture,
const SubresourceRange& range,
wgpu::TextureUsage usage,
wgpu::ShaderStage shaderStages) {
// Get or create a new TextureSubresourceSyncInfo for that texture (initially filled with
// wgpu::TextureUsage::None and WGPUShaderStage_None)
auto it = mTextureSyncInfos.try_emplace(
texture, texture->GetFormat().aspects, texture->GetArrayLayers(),
texture->GetNumMipLevels(),
TextureSyncInfo{wgpu::TextureUsage::None, wgpu::ShaderStage::None});
TextureSubresourceSyncInfo& textureSyncInfo = it.first->second;
textureSyncInfo.Update(
range, [usage, shaderStages](const SubresourceRange&, TextureSyncInfo* storedSyncInfo) {
storedSyncInfo->usage |= usage;
storedSyncInfo->shaderStages |= shaderStages;
});
}
void SyncScopeUsageTracker::AddRenderBundleTextureUsage(
TextureBase* texture,
const TextureSubresourceSyncInfo& textureSyncInfo) {
// Get or create a new TextureSubresourceSyncInfo for that texture (initially filled with
// wgpu::TextureUsage::None and WGPUShaderStage_None)
auto it = mTextureSyncInfos.try_emplace(
texture, texture->GetFormat().aspects, texture->GetArrayLayers(),
texture->GetNumMipLevels(),
TextureSyncInfo{wgpu::TextureUsage::None, wgpu::ShaderStage::None});
TextureSubresourceSyncInfo* passTextureSyncInfo = &it.first->second;
passTextureSyncInfo->Merge(
textureSyncInfo, [](const SubresourceRange&, TextureSyncInfo* storedSyncInfo,
const TextureSyncInfo& addedSyncInfo) {
DAWN_ASSERT((addedSyncInfo.usage & wgpu::TextureUsage::RenderAttachment) == 0);
storedSyncInfo->usage |= addedSyncInfo.usage;
storedSyncInfo->shaderStages |= addedSyncInfo.shaderStages;
});
}
void SyncScopeUsageTracker::AddBindGroup(BindGroupBase* group) {
for (BindingIndex bindingIndex{0}; bindingIndex < group->GetLayout()->GetBindingCount();
++bindingIndex) {
const BindingInfo& bindingInfo = group->GetLayout()->GetBindingInfo(bindingIndex);
MatchVariant(
bindingInfo.bindingLayout,
[&](const BufferBindingInfo& layout) {
BufferBase* buffer = group->GetBindingAsBufferBinding(bindingIndex).buffer;
switch (layout.type) {
case wgpu::BufferBindingType::Uniform:
BufferUsedAs(buffer, wgpu::BufferUsage::Uniform, bindingInfo.visibility);
break;
case wgpu::BufferBindingType::Storage:
BufferUsedAs(buffer, wgpu::BufferUsage::Storage, bindingInfo.visibility);
break;
case kInternalStorageBufferBinding:
BufferUsedAs(buffer, kInternalStorageBuffer, bindingInfo.visibility);
break;
case wgpu::BufferBindingType::ReadOnlyStorage:
BufferUsedAs(buffer, kReadOnlyStorageBuffer, bindingInfo.visibility);
break;
case wgpu::BufferBindingType::Undefined:
DAWN_UNREACHABLE();
}
},
[&](const TextureBindingInfo& layout) {
TextureViewBase* view = group->GetBindingAsTextureView(bindingIndex);
switch (layout.sampleType) {
case kInternalResolveAttachmentSampleType:
TextureViewUsedAs(view, kResolveAttachmentLoadingUsage,
bindingInfo.visibility);
break;
default:
TextureViewUsedAs(view, wgpu::TextureUsage::TextureBinding,
bindingInfo.visibility);
break;
}
},
[&](const StorageTextureBindingInfo& layout) {
TextureViewBase* view = group->GetBindingAsTextureView(bindingIndex);
switch (layout.access) {
case wgpu::StorageTextureAccess::WriteOnly:
TextureViewUsedAs(view, kWriteOnlyStorageTexture, bindingInfo.visibility);
break;
case wgpu::StorageTextureAccess::ReadWrite:
TextureViewUsedAs(view, wgpu::TextureUsage::StorageBinding,
bindingInfo.visibility);
break;
case wgpu::StorageTextureAccess::ReadOnly:
TextureViewUsedAs(view, kReadOnlyStorageTexture, bindingInfo.visibility);
break;
case wgpu::StorageTextureAccess::Undefined:
DAWN_UNREACHABLE();
}
},
[&](const SamplerBindingInfo&) {}, //
[&](const StaticSamplerBindingInfo&) {},
[&](const InputAttachmentBindingInfo&) {
// This binding is not supposed to be used on front-end.
DAWN_UNREACHABLE();
});
}
for (const Ref<ExternalTextureBase>& externalTexture : group->GetBoundExternalTextures()) {
mExternalTextureUsages.insert(externalTexture.Get());
}
}
SyncScopeResourceUsage SyncScopeUsageTracker::AcquireSyncScopeUsage() {
SyncScopeResourceUsage result;
result.buffers.reserve(mBufferSyncInfos.size());
result.bufferSyncInfos.reserve(mBufferSyncInfos.size());
result.textures.reserve(mTextureSyncInfos.size());
result.textureSyncInfos.reserve(mTextureSyncInfos.size());
for (auto& [buffer, syncInfo] : mBufferSyncInfos) {
result.buffers.push_back(buffer);
result.bufferSyncInfos.push_back(std::move(syncInfo));
}
for (auto& [texture, syncInfo] : mTextureSyncInfos) {
result.textures.push_back(texture);
result.textureSyncInfos.push_back(std::move(syncInfo));
}
for (auto* const it : mExternalTextureUsages) {
result.externalTextures.push_back(it);
}
mBufferSyncInfos.clear();
mTextureSyncInfos.clear();
mExternalTextureUsages.clear();
return result;
}
ComputePassResourceUsageTracker::ComputePassResourceUsageTracker() = default;
ComputePassResourceUsageTracker::~ComputePassResourceUsageTracker() = default;
void ComputePassResourceUsageTracker::AddDispatch(SyncScopeResourceUsage scope) {
mUsage.dispatchUsages.push_back(std::move(scope));
}
void ComputePassResourceUsageTracker::AddReferencedBuffer(BufferBase* buffer) {
mUsage.referencedBuffers.insert(buffer);
}
void ComputePassResourceUsageTracker::AddResourcesReferencedByBindGroup(BindGroupBase* group) {
for (BindingIndex index{0}; index < group->GetLayout()->GetBindingCount(); ++index) {
const BindingInfo& bindingInfo = group->GetLayout()->GetBindingInfo(index);
MatchVariant(
bindingInfo.bindingLayout,
[&](const BufferBindingInfo&) {
mUsage.referencedBuffers.insert(group->GetBindingAsBufferBinding(index).buffer);
},
[&](const TextureBindingInfo&) {
mUsage.referencedTextures.insert(
group->GetBindingAsTextureView(index)->GetTexture());
},
[&](const StorageTextureBindingInfo&) {
mUsage.referencedTextures.insert(
group->GetBindingAsTextureView(index)->GetTexture());
},
[](const SamplerBindingInfo&) {}, [](const StaticSamplerBindingInfo&) {},
[&](const InputAttachmentBindingInfo&) { DAWN_UNREACHABLE(); });
}
for (const Ref<ExternalTextureBase>& externalTexture : group->GetBoundExternalTextures()) {
mUsage.referencedExternalTextures.insert(externalTexture.Get());
}
}
ComputePassResourceUsage ComputePassResourceUsageTracker::AcquireResourceUsage() {
return std::move(mUsage);
}
RenderPassResourceUsageTracker::RenderPassResourceUsageTracker() = default;
RenderPassResourceUsageTracker::RenderPassResourceUsageTracker(RenderPassResourceUsageTracker&&) =
default;
RenderPassResourceUsageTracker::~RenderPassResourceUsageTracker() = default;
RenderPassResourceUsageTracker& RenderPassResourceUsageTracker::operator=(
RenderPassResourceUsageTracker&&) = default;
RenderPassResourceUsage RenderPassResourceUsageTracker::AcquireResourceUsage() {
RenderPassResourceUsage result;
*static_cast<SyncScopeResourceUsage*>(&result) = AcquireSyncScopeUsage();
result.querySets.reserve(mQueryAvailabilities.size());
result.queryAvailabilities.reserve(mQueryAvailabilities.size());
for (auto& it : mQueryAvailabilities) {
result.querySets.push_back(it.first);
result.queryAvailabilities.push_back(std::move(it.second));
}
mQueryAvailabilities.clear();
return result;
}
void RenderPassResourceUsageTracker::TrackQueryAvailability(QuerySetBase* querySet,
uint32_t queryIndex) {
// The query availability only needs to be tracked again on render passes for checking
// query overwrite on render pass and resetting query sets on the Vulkan backend.
DAWN_ASSERT(querySet != nullptr);
// Gets the iterator for that querySet or create a new vector of bool set to false
// if the querySet wasn't registered.
auto it = mQueryAvailabilities.try_emplace(querySet, querySet->GetQueryCount()).first;
it->second[queryIndex] = true;
}
const QueryAvailabilityMap& RenderPassResourceUsageTracker::GetQueryAvailabilityMap() const {
return mQueryAvailabilities;
}
} // namespace dawn::native