src/dawn/tests/white_box/InternalStorageBufferBindingTests.cpp

// Copyright 2021 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 <utility>
#include <vector>

#include "dawn/native/BindGroup.h"
#include "dawn/native/BindGroupLayout.h"
#include "dawn/native/CommandBuffer.h"
#include "dawn/native/CommandEncoder.h"
#include "dawn/native/ComputePassEncoder.h"
#include "dawn/native/ComputePipeline.h"
#include "dawn/native/Device.h"
#include "dawn/native/PipelineLayout.h"
#include "dawn/native/Queue.h"
#include "dawn/native/dawn_platform.h"
#include "dawn/native/utils/WGPUHelpers.h"
#include "dawn/tests/DawnTest.h"

namespace dawn {
namespace {

class InternalStorageBufferBindingTests : public DawnTest {
  protected:
    static constexpr uint32_t kNumValues = 4;
    static constexpr uint32_t kIterations = 4;

    void SetUp() override {
        DawnTest::SetUp();
        DAWN_TEST_UNSUPPORTED_IF(UsesWire());
    }

    Ref<native::ComputePipelineBase> CreateComputePipelineWithInternalStorage() {
        native::DeviceBase* nativeDevice = native::FromAPI(device.Get());

        Ref<native::ShaderModuleBase> shaderModule =
            native::utils::CreateShaderModule(nativeDevice, R"(
            struct Buf {
                data : array<u32, 4>
            }

            @group(0) @binding(0) var<storage, read_write> buf : Buf;

            @compute @workgroup_size(1)
            fn main(@builtin(global_invocation_id) GlobalInvocationID : vec3u) {
                buf.data[GlobalInvocationID.x] = buf.data[GlobalInvocationID.x] + 0x1234u;
            }
        )")
                .AcquireSuccess();

        // Create binding group layout with internal storage buffer binding type
        Ref<native::BindGroupLayoutBase> bglRef =
            native::utils::MakeBindGroupLayout(
                nativeDevice,
                {{0, wgpu::ShaderStage::Compute, native::kInternalStorageBufferBinding}}, true)
                .AcquireSuccess();

        // Create pipeline layout
        Ref<native::PipelineLayoutBase> layout =
            native::utils::MakeBasicPipelineLayout(nativeDevice, bglRef).AcquireSuccess();

        native::ComputePipelineDescriptor pipelineDesc = {};
        pipelineDesc.compute.module = shaderModule.Get();
        pipelineDesc.layout = layout.Get();
        return nativeDevice->CreateComputePipeline(&pipelineDesc).AcquireSuccess();
    }
};

// Test that query resolve buffer can be bound as internal storage buffer, multiple dispatches to
// increment values in the query resolve buffer are synchronized.
TEST_P(InternalStorageBufferBindingTests, QueryResolveBufferBoundAsInternalStorageBuffer) {
    std::vector<uint32_t> data(kNumValues, 0);
    std::vector<uint32_t> expected(kNumValues, 0x1234u * kIterations);

    native::DeviceBase* nativeDevice = native::FromAPI(device.Get());

    uint64_t bufferSize = static_cast<uint64_t>(data.size() * sizeof(uint32_t));
    Ref<native::BufferBase> buffer =
        native::utils::CreateBufferFromData(nativeDevice,
                                            wgpu::BufferUsage::QueryResolve |
                                                wgpu::BufferUsage::CopySrc |
                                                wgpu::BufferUsage::CopyDst,
                                            data.data(), bufferSize)
            .AcquireSuccess();

    Ref<native::ComputePipelineBase> pipeline = CreateComputePipelineWithInternalStorage();
    Ref<native::BindGroupLayoutBase> bindGroupLayout =
        pipeline->GetBindGroupLayout(0).AcquireSuccess();
    Ref<native::BindGroupBase> bindGroup =
        native::utils::MakeBindGroup(nativeDevice, bindGroupLayout, {{0, buffer.Get()}},
                                     native::UsageValidationMode::Internal)
            .AcquireSuccess();

    Ref<native::CommandEncoderBase> encoder = nativeDevice->CreateCommandEncoder().AcquireSuccess();
    Ref<native::ComputePassEncoderBase> pass = encoder->BeginComputePass();
    pass->APISetPipeline(pipeline.Get());
    pass->APISetBindGroup(0, bindGroup.Get());
    for (uint32_t i = 0; i < kIterations; ++i) {
        pass->APIDispatchWorkgroups(kNumValues);
    }
    pass->APIEnd();
    Ref<native::CommandBufferBase> commandBuffer = encoder->Finish().AcquireSuccess();
    nativeDevice->GetQueue()->APISubmit(1, &commandBuffer.Get());

    EXPECT_BUFFER_U32_RANGE_EQ(expected.data(), native::ToAPI(buffer.Get()), 0, kNumValues);
}

DAWN_INSTANTIATE_TEST(InternalStorageBufferBindingTests,
                      D3D12Backend(),
                      MetalBackend(),
                      VulkanBackend());

}  // anonymous namespace
}  // namespace dawn