src/dawn/native/vulkan/ComputePipelineVk.h

// 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.

#ifndef SRC_DAWN_NATIVE_VULKAN_COMPUTEPIPELINEVK_H_
#define SRC_DAWN_NATIVE_VULKAN_COMPUTEPIPELINEVK_H_

#include "src/dawn/common/vulkan_platform.h"
#include "src/dawn/native/ComputePipeline.h"
#include "src/dawn/native/CreatePipelineAsyncEvent.h"
#include "src/dawn/native/Error.h"
#include "src/dawn/native/vulkan/PipelineLayoutVk.h"
#include "src/dawn/native/vulkan/PipelineVk.h"
#include "src/dawn/native/vulkan/RefCountedVkHandle.h"

namespace dawn::native::vulkan {

class Device;
struct VkPipelineLayoutObject;

class ComputePipeline final : public ComputePipelineBase {
  public:
    static Ref<ComputePipeline> CreateUninitialized(
        Device* device,
        const UnpackedPtr<ComputePipelineDescriptor>& descriptor);

    VkPipeline GetHandle() const;
    VkPipelineLayout GetVkLayout() const;

    // Specializations used to JIT pipelines.
    using Specialization = CommonPipelineSpecialization;
    ResultOrError<PipelineHandles> GetOrCreateSpecializedHandle(Specialization&& specialization);
    bool RequiresSpecialization() const;

    void ApplyDynamicState(VkCommandBuffer& commands, const ComputePipeline* prevPipeline) const {}

    // Dawn API
    void SetLabelImpl() override;

  private:
    ~ComputePipeline() override;
    void DestroyImpl(DestroyReason reason) override;
    using ComputePipelineBase::ComputePipelineBase;
    ResultOrError<Extent3D> InitializeImpl() override;

    // Initializes a pipeline for the specialization and stores it in mSpecializations.
    struct SpecializationResult {
        Extent3D workgroupSize;
        Ref<RefCountedVkHandle<VkPipeline>> pipeline;
        Ref<RefCountedVkHandle<VkPipelineLayout>> layout;
    };
    ResultOrError<SpecializationResult> InitializeSpecialization(
        const Specialization& specialization,
        bool buildCacheKey);

    // The handles are owned by a ref in mSpecializations.
    PipelineHandles mHandles = {};

    // Caches the specializations as we are most likely to reuse the overtime. Note that noop
    // specialization has mHandle cached directly but mHandle is also kept separately for
    // efficiency.
    bool mRequiresSpecialization = false;
    MutexProtected<absl::flat_hash_map<Specialization, SpecializationResult>> mSpecializations;
};

}  // namespace dawn::native::vulkan

#endif  // SRC_DAWN_NATIVE_VULKAN_COMPUTEPIPELINEVK_H_