src/dawn/native/BindGroup.h

// Copyright 2017 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_BINDGROUP_H_
#define SRC_DAWN_NATIVE_BINDGROUP_H_

#include <array>
#include <optional>
#include <span>
#include <vector>

#include "partition_alloc/pointers/raw_ptr.h"
#include "partition_alloc/pointers/raw_ptr_exclusion.h"
#include "src/dawn/common/Constants.h"
#include "src/dawn/common/Math.h"
#include "src/dawn/native/BindGroupLayout.h"
#include "src/dawn/native/ChainUtils.h"
#include "src/dawn/native/Error.h"
#include "src/dawn/native/Forward.h"
#include "src/dawn/native/ObjectBase.h"
#include "src/dawn/native/UsageValidationMode.h"
#include "src/dawn/native/dawn_platform.h"
#include "src/utils/compiler.h"
#include "src/utils/span.h"

namespace dawn::native {

class DeviceBase;

ResultOrError<UnpackedPtr<BindGroupDescriptor>> ValidateBindGroupDescriptor(
    DeviceBase* device,
    const BindGroupDescriptor* descriptor,
    UsageValidationMode mode);

struct BufferBinding {
    // This pointer is used during BindGroupTracker::Apply, which is hot code called before every
    // draw call. The underlying buffer should be kept alive by the BindGroup, it's impossible to
    // UAF.
    RAW_PTR_EXCLUSION BufferBase* buffer = nullptr;
    uint64_t offset = 0;
    uint64_t size = 0;
};

class BindGroupBase : public ApiObjectBase {
  public:
    static Ref<BindGroupBase> MakeError(DeviceBase* device, StringView label);

    MaybeError Initialize(const UnpackedPtr<BindGroupDescriptor>& descriptor);

    ObjectType GetType() const override;

    BindGroupLayoutBase* GetFrontendLayout();
    const BindGroupLayoutBase* GetFrontendLayout() const;
    BindGroupLayoutInternalBase* GetLayout();
    const BindGroupLayoutInternalBase* GetLayout() const;

    // Getters for bindings part.
    BufferBase* GetBindingAsBuffer(BindingIndex bindingIndex) const;
    SamplerBase* GetBindingAsSampler(BindingIndex bindingIndex) const;
    TextureViewBase* GetBindingAsTextureView(BindingIndex bindingIndex) const;
    BufferBinding GetBindingAsBufferBinding(BindingIndex bindingIndex) const;
    TexelBufferViewBase* GetBindingAsTexelBufferView(BindingIndex bindingIndex) const;
    const ityp::span<uint32_t, uint64_t>& GetUnverifiedBufferSizes() const;

    // Returns the ExternalTexture bound at `bindingIndex` or nullptr if a Texture was bound in
    // lieu. `bindingIndex` must be an index for an ExternalTexture in the layout.
    Ref<ExternalTextureBase> GetBoundExternalTexture(APIBindingIndex bindingIndex) const;
    // Returns the list of all bounds ExternalTextures, with nullptr when a Texture was bound in
    // lieu. BindGroupLayoutInternalBase::GetBoundExternalTextureMap provides the index in this list
    // for a given APIBindingIndex.
    const std::vector<Ref<ExternalTextureBase>>& GetBoundExternalTextures() const;

    void ForEachUnverifiedBufferBindingIndex(std::function<void(BindingIndex, uint32_t)> fn) const;

  protected:
    // To save memory, the size of a bind group is dynamically determined and the bind group is
    // placement-allocated into memory big enough to hold the bind group with its
    // dynamically-sized bindings after it. The pointer of the memory of the beginning of the
    // binding data should be passed as |bindingDataStart|.
    BindGroupBase(DeviceBase* device,
                  const UnpackedPtr<BindGroupDescriptor>& descriptor,
                  void* bindingDataStart);

    // Helper to instantiate BindGroupBase. We pass in |derived| because BindGroupBase may not
    // be first in the allocation. The binding data is stored after the Derived class.
    template <typename Derived>
    BindGroupBase(Derived* derived,
                  DeviceBase* device,
                  const UnpackedPtr<BindGroupDescriptor>& descriptor)
        : BindGroupBase(
              device,
              descriptor,
              AlignPtr(
                  DAWN_UNSAFE_TODO(reinterpret_cast<char*>(derived) + sizeof(Derived)),
                  descriptor->layout->GetInternalBindGroupLayout()->GetBindingDataAlignment())) {
        static_assert(std::is_base_of<BindGroupBase, Derived>::value);
    }

    virtual MaybeError InitializeImpl() = 0;

    void DestroyImpl(DestroyReason reason) override;

    ~BindGroupBase() override;

  private:
    BindGroupBase(DeviceBase* device, ObjectBase::ErrorTag tag, StringView label);

    Ref<BindGroupLayoutBase> mLayout;
    BindGroupLayoutInternalBase::BindingDataPointers mBindingData;

    // This vector hosts the bound external textures of the bind group of each external texture
    // binding entry.
    // BindGroupLayoutInternalBase::GetBoundExternalTextureMap gives a map from APIBindingIndex to
    // index in this vector. Note: This vector can have null reference entry because external
    // texture binding entry can bind a texture view instead of an external texture.
    std::vector<Ref<ExternalTextureBase>> mBoundExternalTextures;
};

}  // namespace dawn::native

#endif  // SRC_DAWN_NATIVE_BINDGROUP_H_