src/dawn/native/vulkan/ShaderModuleVk.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_SHADERMODULEVK_H_
#define SRC_DAWN_NATIVE_VULKAN_SHADERMODULEVK_H_

#include <memory>
#include <mutex>
#include <optional>
#include <string>
#include <utility>
#include <vector>

#include "partition_alloc/pointers/raw_ptr.h"
#include "src/dawn/common/HashUtils.h"
#include "src/dawn/common/vulkan_platform.h"
#include "src/dawn/native/Error.h"
#include "src/dawn/native/ShaderModule.h"
#include "src/dawn/native/vulkan/DeviceVk.h"

namespace dawn::native {

struct ProgrammableStage;

namespace vulkan {

class Device;
class PipelineLayout;

class ShaderModule final : public ShaderModuleBase {
  public:
    static ResultOrError<Ref<ShaderModule>> Create(
        Device* device,
        const UnpackedPtr<ShaderModuleDescriptor>& descriptor,
        const std::vector<tint::wgsl::Extension>& internalExtensions);

    struct ModuleAndSpirv {
        VkShaderModule module = VK_NULL_HANDLE;
        raw_ptr<Device> device = nullptr;
        std::vector<uint32_t> spirv;
        bool hasInputAttachment = false;
        Extent3D workgroupSize;
        std::optional<uint32_t> explicitSubgroupSize;

        ModuleAndSpirv() = default;
        ModuleAndSpirv(ModuleAndSpirv&& o)
            : module(o.module),
              device(o.device),
              spirv(std::move(o.spirv)),
              hasInputAttachment(o.hasInputAttachment),
              workgroupSize(o.workgroupSize),
              explicitSubgroupSize(o.explicitSubgroupSize) {
            o.module = VK_NULL_HANDLE;
            o.device = nullptr;
        }

        ~ModuleAndSpirv() { CleanupVkModule(); }

        ModuleAndSpirv& operator=(ModuleAndSpirv&& o) {
            if (this == &o) {
                return *this;
            }

            CleanupVkModule();

            module = o.module;
            o.module = VK_NULL_HANDLE;

            device = o.device;
            o.device = nullptr;

            spirv = std::move(o.spirv);
            hasInputAttachment = o.hasInputAttachment;
            workgroupSize = o.workgroupSize;
            explicitSubgroupSize = o.explicitSubgroupSize;

            return *this;
        }

        void CleanupVkModule() {
            if (module != VK_NULL_HANDLE && device != nullptr) {
                device->fn.DestroyShaderModule(device->GetVkDevice(), module, nullptr);
            }
            module = VK_NULL_HANDLE;
            device = nullptr;
        }

        ModuleAndSpirv(const ModuleAndSpirv&) = delete;
        ModuleAndSpirv& operator=(const ModuleAndSpirv&) = delete;
    };
    struct CompileParameters {
        // Kept without defaults as they must be provided.
        raw_ptr<const ProgrammableStage> stage;
        raw_ptr<const PipelineLayout> layout;
        ImmediateMask immediateMask;
        raw_ptr<const absl::flat_hash_set<APIBindPoint>> ycbcrExternalTextures;

        std::optional<uint32_t> polyfillPixelCenter = std::nullopt;
        bool emitPointSize = false;
        bool pipelineUsesFramebufferFetch = false;
        bool needsMultisampledFramebufferFetch = false;
    };

    ResultOrUnknownError<ModuleAndSpirv> GetHandleAndSpirv(const CompileParameters& in);

  private:
    ShaderModule(Device* device,
                 const UnpackedPtr<ShaderModuleDescriptor>& descriptor,
                 std::vector<tint::wgsl::Extension> internalExtensions);
    ~ShaderModule() override;
};

}  // namespace vulkan

}  // namespace dawn::native

#endif  // SRC_DAWN_NATIVE_VULKAN_SHADERMODULEVK_H_