| // Copyright 2018 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/vulkan/ComputePipelineVk.h" |
| |
| #include <memory> |
| #include <utility> |
| #include <vector> |
| |
| #include "dawn/native/CreatePipelineAsyncEvent.h" |
| #include "dawn/native/vulkan/DeviceVk.h" |
| #include "dawn/native/vulkan/FencedDeleter.h" |
| #include "dawn/native/vulkan/PipelineCacheVk.h" |
| #include "dawn/native/vulkan/PipelineLayoutVk.h" |
| #include "dawn/native/vulkan/ShaderModuleVk.h" |
| #include "dawn/native/vulkan/UtilsVulkan.h" |
| #include "dawn/native/vulkan/VulkanError.h" |
| #include "dawn/platform/metrics/HistogramMacros.h" |
| |
| namespace dawn::native::vulkan { |
| |
| // static |
| Ref<ComputePipeline> ComputePipeline::CreateUninitialized( |
| Device* device, |
| const UnpackedPtr<ComputePipelineDescriptor>& descriptor) { |
| return AcquireRef(new ComputePipeline(device, descriptor)); |
| } |
| |
| MaybeError ComputePipeline::InitializeImpl() { |
| Device* device = ToBackend(GetDevice()); |
| const PipelineLayout* layout = ToBackend(GetLayout()); |
| |
| // Vulkan devices need cache UUID field to be serialized into pipeline cache keys. |
| StreamIn(&mCacheKey, device->GetDeviceInfo().properties.pipelineCacheUUID); |
| |
| VkComputePipelineCreateInfo createInfo; |
| createInfo.sType = VK_STRUCTURE_TYPE_COMPUTE_PIPELINE_CREATE_INFO; |
| createInfo.pNext = nullptr; |
| createInfo.flags = 0; |
| createInfo.layout = layout->GetHandle(); |
| createInfo.basePipelineHandle = VkPipeline{}; |
| createInfo.basePipelineIndex = -1; |
| |
| createInfo.stage.sType = VK_STRUCTURE_TYPE_PIPELINE_SHADER_STAGE_CREATE_INFO; |
| createInfo.stage.pNext = nullptr; |
| createInfo.stage.flags = 0; |
| createInfo.stage.stage = VK_SHADER_STAGE_COMPUTE_BIT; |
| // Generate a new VkShaderModule with BindingRemapper tint transform for each pipeline |
| const ProgrammableStage& computeStage = GetStage(SingleShaderStage::Compute); |
| ShaderModule* module = ToBackend(computeStage.module.Get()); |
| |
| ShaderModule::ModuleAndSpirv moduleAndSpirv; |
| DAWN_TRY_ASSIGN( |
| moduleAndSpirv, |
| module->GetHandleAndSpirv( |
| SingleShaderStage::Compute, computeStage, layout, |
| /*clampFragDepth*/ false, |
| /*emitPointSize*/ false, |
| /* maxSubgroupSizeForFullSubgroups */ |
| IsFullSubgroupsRequired() |
| ? std::make_optional(device->GetLimits().experimentalSubgroupLimits.maxSubgroupSize) |
| : std::nullopt)); |
| |
| createInfo.stage.module = moduleAndSpirv.module; |
| createInfo.stage.pName = moduleAndSpirv.remappedEntryPoint.c_str(); |
| |
| if (IsFullSubgroupsRequired()) { |
| // Workgroup size validation is handled in ValidateComputeStageWorkgroupSize when compiling |
| // shader module. Vulkan device that support ChromiumExperimentalSubgroups must support |
| // computeFullSubgroups. |
| DAWN_ASSERT(device->GetDeviceInfo().subgroupSizeControlFeatures.computeFullSubgroups); |
| createInfo.stage.flags |= VK_PIPELINE_SHADER_STAGE_CREATE_REQUIRE_FULL_SUBGROUPS_BIT | |
| VK_PIPELINE_SHADER_STAGE_CREATE_ALLOW_VARYING_SUBGROUP_SIZE_BIT; |
| } |
| |
| createInfo.stage.pSpecializationInfo = nullptr; |
| |
| VkPipelineShaderStageRequiredSubgroupSizeCreateInfoEXT subgroupSizeInfo = {}; |
| PNextChainBuilder stageExtChain(&createInfo.stage); |
| |
| uint32_t computeSubgroupSize = device->GetComputeSubgroupSize(); |
| // If experimental full subgroups is required, pipeline is created with varying subgroup size |
| // enabled, and thus do not use explicit subgroup size control. |
| if (computeSubgroupSize != 0u && !IsFullSubgroupsRequired()) { |
| DAWN_ASSERT(device->GetDeviceInfo().HasExt(DeviceExt::SubgroupSizeControl)); |
| subgroupSizeInfo.requiredSubgroupSize = computeSubgroupSize; |
| stageExtChain.Add( |
| &subgroupSizeInfo, |
| VK_STRUCTURE_TYPE_PIPELINE_SHADER_STAGE_REQUIRED_SUBGROUP_SIZE_CREATE_INFO_EXT); |
| } |
| |
| // Record cache key information now since the createInfo is not stored. |
| StreamIn(&mCacheKey, createInfo, layout, |
| stream::Iterable(moduleAndSpirv.spirv, moduleAndSpirv.wordCount)); |
| |
| // Try to see if we have anything in the blob cache. |
| platform::metrics::DawnHistogramTimer cacheTimer(GetDevice()->GetPlatform()); |
| Ref<PipelineCache> cache = ToBackend(GetDevice()->GetOrCreatePipelineCache(GetCacheKey())); |
| if (cache->CacheHit()) { |
| DAWN_TRY(CheckVkSuccess( |
| device->fn.CreateComputePipelines(device->GetVkDevice(), cache->GetHandle(), 1, |
| &createInfo, nullptr, &*mHandle), |
| "CreateComputePipelines")); |
| cacheTimer.RecordMicroseconds("Vulkan.CreateComputePipelines.CacheHit"); |
| } else { |
| cacheTimer.Reset(); |
| DAWN_TRY(CheckVkSuccess( |
| device->fn.CreateComputePipelines(device->GetVkDevice(), cache->GetHandle(), 1, |
| &createInfo, nullptr, &*mHandle), |
| "CreateComputePipelines")); |
| cacheTimer.RecordMicroseconds("Vulkan.CreateComputePipelines.CacheMiss"); |
| } |
| // TODO(dawn:549): Flush is currently in the same thread, but perhaps deferrable. |
| DAWN_TRY(cache->FlushIfNeeded()); |
| |
| SetLabelImpl(); |
| |
| return {}; |
| } |
| |
| void ComputePipeline::SetLabelImpl() { |
| SetDebugName(ToBackend(GetDevice()), mHandle, "Dawn_ComputePipeline", GetLabel()); |
| } |
| |
| ComputePipeline::~ComputePipeline() = default; |
| |
| void ComputePipeline::DestroyImpl() { |
| ComputePipelineBase::DestroyImpl(); |
| |
| if (mHandle != VK_NULL_HANDLE) { |
| ToBackend(GetDevice())->GetFencedDeleter()->DeleteWhenUnused(mHandle); |
| mHandle = VK_NULL_HANDLE; |
| } |
| } |
| |
| VkPipeline ComputePipeline::GetHandle() const { |
| return mHandle; |
| } |
| |
| } // namespace dawn::native::vulkan |