src/dawn/tests/unittests/native/AllowedErrorTests.cpp - dawn - Git at Google

 // Copyright 2023 The Dawn Authors
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
 // You may obtain a copy of the License at
 //
 //     http://www.apache.org/licenses/LICENSE-2.0
 //
 // Unless required by applicable law or agreed to in writing, software
 // distributed under the License is distributed on an "AS IS" BASIS,
 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 // See the License for the specific language governing permissions and
 // limitations under the License.

 #include <gtest/gtest.h>

 #include <string_view>
 #include <utility>

 #include "dawn/tests/MockCallback.h"
 #include "dawn/webgpu_cpp.h"
 #include "mocks/BufferMock.h"
 #include "mocks/ComputePipelineMock.h"
 #include "mocks/DawnMockTest.h"
 #include "mocks/DeviceMock.h"
 #include "mocks/ExternalTextureMock.h"
 #include "mocks/PipelineLayoutMock.h"
 #include "mocks/RenderPipelineMock.h"
 #include "mocks/ShaderModuleMock.h"
 #include "mocks/TextureMock.h"

 namespace dawn::native {
 namespace {

 using ::testing::_;
 using ::testing::ByMove;
 using ::testing::HasSubstr;
 using ::testing::MockCallback;
 using ::testing::NiceMock;
 using ::testing::Return;
 using ::testing::StrictMock;
 using ::testing::Test;

 static constexpr char kOomErrorMessage[] = "Out of memory error";
 static constexpr char kInternalErrorMessage[] = "Internal error";

 static constexpr std::string_view kComputeShader = R"(
         @compute @workgroup_size(1) fn main() {}
     )";

 static constexpr std::string_view kVertexShader = R"(
         @vertex fn main() -> @builtin(position) vec4f {
             return vec4f(0.0, 0.0, 0.0, 0.0);
         }
     )";

 class AllowedErrorTests : public DawnMockTest {
   public:
     AllowedErrorTests() : DawnMockTest() {
         device.SetDeviceLostCallback(mDeviceLostCb.Callback(), mDeviceLostCb.MakeUserdata(this));
         device.SetUncapturedErrorCallback(mDeviceErrorCb.Callback(),
                                           mDeviceErrorCb.MakeUserdata(this));
     }

     ~AllowedErrorTests() override { device = nullptr; }

   protected:
     // Device mock callbacks used throughout the tests.
     StrictMock<MockCallback<wgpu::DeviceLostCallback>> mDeviceLostCb;
     StrictMock<MockCallback<wgpu::ErrorCallback>> mDeviceErrorCb;
 };

 //
 // Exercise APIs where OOM errors cause a device lost.
 //

 TEST_F(AllowedErrorTests, QueueSubmit) {
     EXPECT_CALL(*(mDeviceMock->GetQueueMock()), SubmitImpl)
         .WillOnce(Return(ByMove(DAWN_OUT_OF_MEMORY_ERROR(kOomErrorMessage))));

     // Expect the device lost because of the error.
     EXPECT_CALL(mDeviceLostCb,
                 Call(WGPUDeviceLostReason_Undefined, HasSubstr(kOomErrorMessage), this))
         .Times(1);

     device.GetQueue().Submit(0, nullptr);
 }

 TEST_F(AllowedErrorTests, QueueWriteBuffer) {
     BufferDescriptor desc = {};
     desc.size = 1;
     desc.usage = wgpu::BufferUsage::CopyDst;
     BufferMock* bufferMock = new NiceMock<BufferMock>(mDeviceMock, &desc);
     wgpu::Buffer buffer = wgpu::Buffer::Acquire(ToAPI(bufferMock));

     EXPECT_CALL(*(mDeviceMock->GetQueueMock()), WriteBufferImpl)
         .WillOnce(Return(ByMove(DAWN_OUT_OF_MEMORY_ERROR(kOomErrorMessage))));

     // Expect the device lost because of the error.
     EXPECT_CALL(mDeviceLostCb,
                 Call(WGPUDeviceLostReason_Undefined, HasSubstr(kOomErrorMessage), this))
         .Times(1);

     constexpr uint8_t data = 8;
     device.GetQueue().WriteBuffer(buffer, 0, &data, 0);
 }

 TEST_F(AllowedErrorTests, QueueWriteTexture) {
     TextureDescriptor desc = {};
     desc.size.width = 1;
     desc.size.height = 1;
     desc.usage = wgpu::TextureUsage::CopyDst;
     desc.format = wgpu::TextureFormat::RGBA8Unorm;
     TextureMock* textureMock = new NiceMock<TextureMock>(mDeviceMock, &desc);
     wgpu::Texture texture = wgpu::Texture::Acquire(ToAPI(textureMock));

     EXPECT_CALL(*(mDeviceMock->GetQueueMock()), WriteTextureImpl)
         .WillOnce(Return(ByMove(DAWN_OUT_OF_MEMORY_ERROR(kOomErrorMessage))));

     // Expect the device lost because of the error.
     EXPECT_CALL(mDeviceLostCb,
                 Call(WGPUDeviceLostReason_Undefined, HasSubstr(kOomErrorMessage), this))
         .Times(1);

     constexpr uint8_t data[] = {1, 2, 4, 8};
     wgpu::ImageCopyTexture dest = {};
     dest.texture = texture;
     wgpu::TextureDataLayout layout = {};
     wgpu::Extent3D size = {1, 1};
     device.GetQueue().WriteTexture(&dest, &data, 4, &layout, &size);
 }

 // Even though OOM is allowed in buffer creation, when creating a buffer in internal workaround the
 // OOM should be masked as a device loss.
 TEST_F(AllowedErrorTests, QueueCopyTextureForBrowserOomBuffer) {
     wgpu::TextureDescriptor desc = {};
     desc.size = {4, 4};
     desc.usage = wgpu::TextureUsage::CopySrc | wgpu::TextureUsage::CopyDst |
                  wgpu::TextureUsage::RenderAttachment | wgpu::TextureUsage::TextureBinding;
     desc.format = wgpu::TextureFormat::RGBA8Unorm;

     wgpu::ImageCopyTexture src = {};
     src.texture = device.CreateTexture(&desc);
     wgpu::ImageCopyTexture dst = {};
     dst.texture = device.CreateTexture(&desc);
     wgpu::Extent3D size = {4, 4};
     wgpu::CopyTextureForBrowserOptions options = {};

     // Copying texture for browser internally allocates a buffer which we will cause to fail here.
     EXPECT_CALL(*mDeviceMock, CreateBufferImpl)
         .WillOnce(Return(ByMove(DAWN_OUT_OF_MEMORY_ERROR(kOomErrorMessage))));

     // Expect the device lost because of the error.
     EXPECT_CALL(mDeviceLostCb,
                 Call(WGPUDeviceLostReason_Undefined, HasSubstr(kOomErrorMessage), this))
         .Times(1);
     device.GetQueue().CopyTextureForBrowser(&src, &dst, &size, &options);
 }

 // Even though OOM is allowed in buffer creation, when creating a buffer in internal workaround the
 // OOM should be masked as a device loss.
 TEST_F(AllowedErrorTests, QueueCopyExternalTextureForBrowserOomBuffer) {
     wgpu::TextureDescriptor textureDesc = {};
     textureDesc.size = {4, 4};
     textureDesc.usage = wgpu::TextureUsage::CopySrc | wgpu::TextureUsage::CopyDst |
                         wgpu::TextureUsage::RenderAttachment | wgpu::TextureUsage::TextureBinding;
     textureDesc.format = wgpu::TextureFormat::RGBA8Unorm;

     wgpu::TextureViewDescriptor textureViewDesc = {};
     textureViewDesc.format = wgpu::TextureFormat::RGBA8Unorm;

     wgpu::ExternalTextureDescriptor externalTextureDesc = {};
     std::array<float, 12> placeholderConstantArray;
     externalTextureDesc.yuvToRgbConversionMatrix = placeholderConstantArray.data();
     externalTextureDesc.gamutConversionMatrix = placeholderConstantArray.data();
     externalTextureDesc.srcTransferFunctionParameters = placeholderConstantArray.data();
     externalTextureDesc.dstTransferFunctionParameters = placeholderConstantArray.data();
     externalTextureDesc.visibleSize = {4, 4};
     externalTextureDesc.plane0 = device.CreateTexture(&textureDesc).CreateView(&textureViewDesc);

     wgpu::ImageCopyExternalTexture src = {};
     src.externalTexture = device.CreateExternalTexture(&externalTextureDesc);
     wgpu::ImageCopyTexture dst = {};
     dst.texture = device.CreateTexture(&textureDesc);
     wgpu::Extent3D size = {4, 4};
     wgpu::CopyTextureForBrowserOptions options = {};

     // Copying texture for browser internally allocates a buffer which we will cause to fail here.
     EXPECT_CALL(*mDeviceMock, CreateBufferImpl)
         .WillOnce(Return(ByMove(DAWN_OUT_OF_MEMORY_ERROR(kOomErrorMessage))));

     // Expect the device lost because of the error.
     EXPECT_CALL(mDeviceLostCb,
                 Call(WGPUDeviceLostReason_Undefined, HasSubstr(kOomErrorMessage), this))
         .Times(1);
     device.GetQueue().CopyExternalTextureForBrowser(&src, &dst, &size, &options);
 }

 // OOM error from synchronously initializing a compute pipeline should result in a device loss.
 TEST_F(AllowedErrorTests, CreateComputePipeline) {
     Ref<ShaderModuleMock> csModule = ShaderModuleMock::Create(mDeviceMock, kComputeShader.data());

     ComputePipelineDescriptor desc = {};
     desc.compute.module = csModule.Get();
     desc.compute.entryPoint = "main";

     Ref<ComputePipelineMock> computePipelineMock = ComputePipelineMock::Create(mDeviceMock, &desc);
     EXPECT_CALL(*computePipelineMock.Get(), Initialize)
         .WillOnce(Return(ByMove(DAWN_OUT_OF_MEMORY_ERROR(kOomErrorMessage))));
     EXPECT_CALL(*mDeviceMock, CreateUninitializedComputePipelineImpl)
         .WillOnce(Return(ByMove(std::move(computePipelineMock))));

     // Expect the device lost because of the error.
     EXPECT_CALL(mDeviceLostCb,
                 Call(WGPUDeviceLostReason_Undefined, HasSubstr(kOomErrorMessage), this))
         .Times(1);
     device.CreateComputePipeline(ToCppAPI(&desc));
 }

 // OOM error from synchronously initializing a render pipeline should result in a device loss.
 TEST_F(AllowedErrorTests, CreateRenderPipeline) {
     Ref<ShaderModuleMock> vsModule = ShaderModuleMock::Create(mDeviceMock, kVertexShader.data());

     RenderPipelineDescriptor desc = {};
     desc.vertex.module = vsModule.Get();
     desc.vertex.entryPoint = "main";

     Ref<RenderPipelineMock> renderPipelineMock = RenderPipelineMock::Create(mDeviceMock, &desc);
     EXPECT_CALL(*renderPipelineMock.Get(), Initialize)
         .WillOnce(Return(ByMove(DAWN_OUT_OF_MEMORY_ERROR(kOomErrorMessage))));
     EXPECT_CALL(*mDeviceMock, CreateUninitializedRenderPipelineImpl)
         .WillOnce(Return(ByMove(std::move(renderPipelineMock))));

     // Expect the device lost because of the error.
     EXPECT_CALL(mDeviceLostCb,
                 Call(WGPUDeviceLostReason_Undefined, HasSubstr(kOomErrorMessage), this))
         .Times(1);
     device.CreateRenderPipeline(ToCppAPI(&desc));
 }

 // Internal error from synchronously initializing a compute pipeline should not result in a device
 // loss.
 TEST_F(AllowedErrorTests, CreateComputePipelineInternalError) {
     Ref<ShaderModuleMock> csModule = ShaderModuleMock::Create(mDeviceMock, kComputeShader.data());

     ComputePipelineDescriptor desc = {};
     desc.compute.module = csModule.Get();
     desc.compute.entryPoint = "main";

     Ref<ComputePipelineMock> computePipelineMock = ComputePipelineMock::Create(mDeviceMock, &desc);
     EXPECT_CALL(*computePipelineMock.Get(), Initialize)
         .WillOnce(Return(ByMove(DAWN_INTERNAL_ERROR(kInternalErrorMessage))));
     EXPECT_CALL(*mDeviceMock, CreateUninitializedComputePipelineImpl)
         .WillOnce(Return(ByMove(std::move(computePipelineMock))));

     // Expect the internal error.
     EXPECT_CALL(mDeviceErrorCb,
                 Call(WGPUErrorType_Internal, HasSubstr(kInternalErrorMessage), this))
         .Times(1);
     device.CreateComputePipeline(ToCppAPI(&desc));

     // Device lost should only happen due to destruction.
     EXPECT_CALL(mDeviceLostCb, Call(WGPUDeviceLostReason_Destroyed, _, this)).Times(1);
 }

 // Internal error from synchronously initializing a render pipeline should not result in a device
 // loss.
 TEST_F(AllowedErrorTests, CreateRenderPipelineInternalError) {
     Ref<ShaderModuleMock> vsModule = ShaderModuleMock::Create(mDeviceMock, kVertexShader.data());

     RenderPipelineDescriptor desc = {};
     desc.vertex.module = vsModule.Get();
     desc.vertex.entryPoint = "main";

     Ref<RenderPipelineMock> renderPipelineMock = RenderPipelineMock::Create(mDeviceMock, &desc);
     EXPECT_CALL(*renderPipelineMock.Get(), Initialize)
         .WillOnce(Return(ByMove(DAWN_INTERNAL_ERROR(kInternalErrorMessage))));
     EXPECT_CALL(*mDeviceMock, CreateUninitializedRenderPipelineImpl)
         .WillOnce(Return(ByMove(std::move(renderPipelineMock))));

     // Expect the internal error.
     EXPECT_CALL(mDeviceErrorCb,
                 Call(WGPUErrorType_Internal, HasSubstr(kInternalErrorMessage), this))
         .Times(1);
     device.CreateRenderPipeline(ToCppAPI(&desc));

     // Device lost should only happen due to destruction.
     EXPECT_CALL(mDeviceLostCb, Call(WGPUDeviceLostReason_Destroyed, _, this)).Times(1);
 }

 //
 // Exercise async APIs where OOM errors do NOT currently cause a device lost.
 //

 // OOM error from asynchronously initializing a compute pipeline should not result in a device loss.
 TEST_F(AllowedErrorTests, CreateComputePipelineAsync) {
     Ref<ShaderModuleMock> csModule = ShaderModuleMock::Create(mDeviceMock, kComputeShader.data());

     ComputePipelineDescriptor desc = {};
     desc.compute.module = csModule.Get();
     desc.compute.entryPoint = "main";

     Ref<ComputePipelineMock> computePipelineMock = ComputePipelineMock::Create(mDeviceMock, &desc);
     EXPECT_CALL(*computePipelineMock.Get(), Initialize)
         .WillOnce(Return(ByMove(DAWN_OUT_OF_MEMORY_ERROR(kOomErrorMessage))));
     EXPECT_CALL(*mDeviceMock, CreateUninitializedComputePipelineImpl)
         .WillOnce(Return(ByMove(std::move(computePipelineMock))));

     MockCallback<wgpu::CreateComputePipelineAsyncCallback> cb;
     EXPECT_CALL(
         cb, Call(WGPUCreatePipelineAsyncStatus_InternalError, _, HasSubstr(kOomErrorMessage), this))
         .Times(1);

     device.CreateComputePipelineAsync(ToCppAPI(&desc), cb.Callback(), cb.MakeUserdata(this));
     device.Tick();

     // Device lost should only happen because of destruction.
     EXPECT_CALL(mDeviceLostCb, Call(WGPUDeviceLostReason_Destroyed, _, this)).Times(1);
 }

 // OOM error from asynchronously initializing a render pipeline should not result in a device loss.
 TEST_F(AllowedErrorTests, CreateRenderPipelineAsync) {
     Ref<ShaderModuleMock> vsModule = ShaderModuleMock::Create(mDeviceMock, kVertexShader.data());

     RenderPipelineDescriptor desc = {};
     desc.vertex.module = vsModule.Get();
     desc.vertex.entryPoint = "main";

     Ref<RenderPipelineMock> renderPipelineMock = RenderPipelineMock::Create(mDeviceMock, &desc);
     EXPECT_CALL(*renderPipelineMock.Get(), Initialize)
         .WillOnce(Return(ByMove(DAWN_OUT_OF_MEMORY_ERROR(kOomErrorMessage))));
     EXPECT_CALL(*mDeviceMock, CreateUninitializedRenderPipelineImpl)
         .WillOnce(Return(ByMove(std::move(renderPipelineMock))));

     MockCallback<wgpu::CreateRenderPipelineAsyncCallback> cb;
     EXPECT_CALL(
         cb, Call(WGPUCreatePipelineAsyncStatus_InternalError, _, HasSubstr(kOomErrorMessage), this))
         .Times(1);

     device.CreateRenderPipelineAsync(ToCppAPI(&desc), cb.Callback(), cb.MakeUserdata(this));
     device.Tick();

     // Device lost should only happen because of destruction.
     EXPECT_CALL(mDeviceLostCb, Call(WGPUDeviceLostReason_Destroyed, _, this)).Times(1);
 }

 // Internal error from asynchronously initializing a compute pipeline should not result in a device
 // loss.
 TEST_F(AllowedErrorTests, CreateComputePipelineAsyncInternalError) {
     Ref<ShaderModuleMock> csModule = ShaderModuleMock::Create(mDeviceMock, kComputeShader.data());

     ComputePipelineDescriptor desc = {};
     desc.compute.module = csModule.Get();
     desc.compute.entryPoint = "main";

     Ref<ComputePipelineMock> computePipelineMock = ComputePipelineMock::Create(mDeviceMock, &desc);
     EXPECT_CALL(*computePipelineMock.Get(), Initialize)
         .WillOnce(Return(ByMove(DAWN_INTERNAL_ERROR(kInternalErrorMessage))));
     EXPECT_CALL(*mDeviceMock, CreateUninitializedComputePipelineImpl)
         .WillOnce(Return(ByMove(std::move(computePipelineMock))));

     MockCallback<wgpu::CreateComputePipelineAsyncCallback> cb;
     EXPECT_CALL(cb, Call(WGPUCreatePipelineAsyncStatus_InternalError, _,
                          HasSubstr(kInternalErrorMessage), this))
         .Times(1);

     device.CreateComputePipelineAsync(ToCppAPI(&desc), cb.Callback(), cb.MakeUserdata(this));
     device.Tick();

     // Device lost should only happen because of destruction.
     EXPECT_CALL(mDeviceLostCb, Call(WGPUDeviceLostReason_Destroyed, _, this)).Times(1);
 }

 // Internal error from asynchronously initializing a render pipeline should not result in a device
 // loss.
 TEST_F(AllowedErrorTests, CreateRenderPipelineAsyncInternalError) {
     Ref<ShaderModuleMock> vsModule = ShaderModuleMock::Create(mDeviceMock, kVertexShader.data());

     RenderPipelineDescriptor desc = {};
     desc.vertex.module = vsModule.Get();
     desc.vertex.entryPoint = "main";

     Ref<RenderPipelineMock> renderPipelineMock = RenderPipelineMock::Create(mDeviceMock, &desc);
     EXPECT_CALL(*renderPipelineMock.Get(), Initialize)
         .WillOnce(Return(ByMove(DAWN_INTERNAL_ERROR(kInternalErrorMessage))));
     EXPECT_CALL(*mDeviceMock, CreateUninitializedRenderPipelineImpl)
         .WillOnce(Return(ByMove(std::move(renderPipelineMock))));

     MockCallback<wgpu::CreateRenderPipelineAsyncCallback> cb;
     EXPECT_CALL(cb, Call(WGPUCreatePipelineAsyncStatus_InternalError, _,
                          HasSubstr(kInternalErrorMessage), this))
         .Times(1);

     device.CreateRenderPipelineAsync(ToCppAPI(&desc), cb.Callback(), cb.MakeUserdata(this));
     device.Tick();

     // Device lost should only happen because of destruction.
     EXPECT_CALL(mDeviceLostCb, Call(WGPUDeviceLostReason_Destroyed, _, this)).Times(1);
 }

 //
 // Exercise APIs where OOM error are allowed and surfaced.
 //

 // OOM error from buffer creation is allowed and surfaced directly.
 TEST_F(AllowedErrorTests, CreateBuffer) {
     EXPECT_CALL(*mDeviceMock, CreateBufferImpl)
         .WillOnce(Return(ByMove(DAWN_OUT_OF_MEMORY_ERROR(kOomErrorMessage))));

     // Expect the OOM error.
     EXPECT_CALL(mDeviceErrorCb, Call(WGPUErrorType_OutOfMemory, HasSubstr(kOomErrorMessage), this))
         .Times(1);

     wgpu::BufferDescriptor desc = {};
     desc.usage = wgpu::BufferUsage::Uniform;
     desc.size = 16;
     device.CreateBuffer(&desc);

     // Device lost should only happen because of destruction.
     EXPECT_CALL(mDeviceLostCb, Call(WGPUDeviceLostReason_Destroyed, _, this)).Times(1);
 }

 // OOM error from texture creation is allowed and surfaced directly.
 TEST_F(AllowedErrorTests, CreateTexture) {
     EXPECT_CALL(*mDeviceMock, CreateTextureImpl)
         .WillOnce(Return(ByMove(DAWN_OUT_OF_MEMORY_ERROR(kOomErrorMessage))));

     // Expect the OOM error.
     EXPECT_CALL(mDeviceErrorCb, Call(WGPUErrorType_OutOfMemory, HasSubstr(kOomErrorMessage), this))
         .Times(1);

     wgpu::TextureDescriptor desc = {};
     desc.usage = wgpu::TextureUsage::CopySrc;
     desc.size = {4, 4};
     desc.format = wgpu::TextureFormat::RGBA8Unorm;
     device.CreateTexture(&desc);

     // Device lost should only happen because of destruction.
     EXPECT_CALL(mDeviceLostCb, Call(WGPUDeviceLostReason_Destroyed, _, this)).Times(1);
 }

 // OOM error from query set creation is allowed and surfaced directly.
 TEST_F(AllowedErrorTests, CreateQuerySet) {
     EXPECT_CALL(*mDeviceMock, CreateQuerySetImpl)
         .WillOnce(Return(ByMove(DAWN_OUT_OF_MEMORY_ERROR(kOomErrorMessage))));

     // Expect the OOM error.
     EXPECT_CALL(mDeviceErrorCb, Call(WGPUErrorType_OutOfMemory, HasSubstr(kOomErrorMessage), this))
         .Times(1);

     wgpu::QuerySetDescriptor desc = {};
     desc.type = wgpu::QueryType::Occlusion;
     desc.count = 1;
     device.CreateQuerySet(&desc);

     // Device lost should only happen because of destruction.
     EXPECT_CALL(mDeviceLostCb, Call(WGPUDeviceLostReason_Destroyed, _, this)).Times(1);
 }

 TEST_F(AllowedErrorTests, InjectError) {
     // Expect the OOM error.
     EXPECT_CALL(mDeviceErrorCb, Call(WGPUErrorType_OutOfMemory, HasSubstr(kOomErrorMessage), this))
         .Times(1);

     device.InjectError(wgpu::ErrorType::OutOfMemory, kOomErrorMessage);

     // Device lost should only happen because of destruction.
     EXPECT_CALL(mDeviceLostCb, Call(WGPUDeviceLostReason_Destroyed, _, this)).Times(1);
 }

 }  // anonymous namespace
 }  // namespace dawn::native
	// Copyright 2023 The Dawn Authors
	//
	// Licensed under the Apache License, Version 2.0 (the "License");
	// you may not use this file except in compliance with the License.
	// You may obtain a copy of the License at
	//
	// http://www.apache.org/licenses/LICENSE-2.0
	//
	// Unless required by applicable law or agreed to in writing, software
	// distributed under the License is distributed on an "AS IS" BASIS,
	// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
	// See the License for the specific language governing permissions and
	// limitations under the License.

	#include <gtest/gtest.h>

	#include <string_view>
	#include <utility>

	#include "dawn/tests/MockCallback.h"
	#include "dawn/webgpu_cpp.h"
	#include "mocks/BufferMock.h"
	#include "mocks/ComputePipelineMock.h"
	#include "mocks/DawnMockTest.h"
	#include "mocks/DeviceMock.h"
	#include "mocks/ExternalTextureMock.h"
	#include "mocks/PipelineLayoutMock.h"
	#include "mocks/RenderPipelineMock.h"
	#include "mocks/ShaderModuleMock.h"
	#include "mocks/TextureMock.h"

	namespace dawn::native {
	namespace {

	using ::testing::_;
	using ::testing::ByMove;
	using ::testing::HasSubstr;
	using ::testing::MockCallback;
	using ::testing::NiceMock;
	using ::testing::Return;
	using ::testing::StrictMock;
	using ::testing::Test;

	static constexpr char kOomErrorMessage[] = "Out of memory error";
	static constexpr char kInternalErrorMessage[] = "Internal error";

	static constexpr std::string_view kComputeShader = R"(
	@compute @workgroup_size(1) fn main() {}
	)";

	static constexpr std::string_view kVertexShader = R"(
	@vertex fn main() -> @builtin(position) vec4f {
	return vec4f(0.0, 0.0, 0.0, 0.0);
	}
	)";

	class AllowedErrorTests : public DawnMockTest {
	public:
	AllowedErrorTests() : DawnMockTest() {
	device.SetDeviceLostCallback(mDeviceLostCb.Callback(), mDeviceLostCb.MakeUserdata(this));
	device.SetUncapturedErrorCallback(mDeviceErrorCb.Callback(),
	mDeviceErrorCb.MakeUserdata(this));
	}

	~AllowedErrorTests() override { device = nullptr; }

	protected:
	// Device mock callbacks used throughout the tests.
	StrictMock<MockCallback<wgpu::DeviceLostCallback>> mDeviceLostCb;
	StrictMock<MockCallback<wgpu::ErrorCallback>> mDeviceErrorCb;
	};

	//
	// Exercise APIs where OOM errors cause a device lost.
	//

	TEST_F(AllowedErrorTests, QueueSubmit) {
	EXPECT_CALL(*(mDeviceMock->GetQueueMock()), SubmitImpl)
	.WillOnce(Return(ByMove(DAWN_OUT_OF_MEMORY_ERROR(kOomErrorMessage))));

	// Expect the device lost because of the error.
	EXPECT_CALL(mDeviceLostCb,
	Call(WGPUDeviceLostReason_Undefined, HasSubstr(kOomErrorMessage), this))
	.Times(1);

	device.GetQueue().Submit(0, nullptr);
	}

	TEST_F(AllowedErrorTests, QueueWriteBuffer) {
	BufferDescriptor desc = {};
	desc.size = 1;
	desc.usage = wgpu::BufferUsage::CopyDst;
	BufferMock* bufferMock = new NiceMock<BufferMock>(mDeviceMock, &desc);
	wgpu::Buffer buffer = wgpu::Buffer::Acquire(ToAPI(bufferMock));

	EXPECT_CALL(*(mDeviceMock->GetQueueMock()), WriteBufferImpl)
	.WillOnce(Return(ByMove(DAWN_OUT_OF_MEMORY_ERROR(kOomErrorMessage))));

	// Expect the device lost because of the error.
	EXPECT_CALL(mDeviceLostCb,
	Call(WGPUDeviceLostReason_Undefined, HasSubstr(kOomErrorMessage), this))
	.Times(1);

	constexpr uint8_t data = 8;
	device.GetQueue().WriteBuffer(buffer, 0, &data, 0);
	}

	TEST_F(AllowedErrorTests, QueueWriteTexture) {
	TextureDescriptor desc = {};
	desc.size.width = 1;
	desc.size.height = 1;
	desc.usage = wgpu::TextureUsage::CopyDst;
	desc.format = wgpu::TextureFormat::RGBA8Unorm;
	TextureMock* textureMock = new NiceMock<TextureMock>(mDeviceMock, &desc);
	wgpu::Texture texture = wgpu::Texture::Acquire(ToAPI(textureMock));

	EXPECT_CALL(*(mDeviceMock->GetQueueMock()), WriteTextureImpl)
	.WillOnce(Return(ByMove(DAWN_OUT_OF_MEMORY_ERROR(kOomErrorMessage))));

	// Expect the device lost because of the error.
	EXPECT_CALL(mDeviceLostCb,
	Call(WGPUDeviceLostReason_Undefined, HasSubstr(kOomErrorMessage), this))
	.Times(1);

	constexpr uint8_t data[] = {1, 2, 4, 8};
	wgpu::ImageCopyTexture dest = {};
	dest.texture = texture;
	wgpu::TextureDataLayout layout = {};
	wgpu::Extent3D size = {1, 1};
	device.GetQueue().WriteTexture(&dest, &data, 4, &layout, &size);
	}

	// Even though OOM is allowed in buffer creation, when creating a buffer in internal workaround the
	// OOM should be masked as a device loss.
	TEST_F(AllowedErrorTests, QueueCopyTextureForBrowserOomBuffer) {
	wgpu::TextureDescriptor desc = {};
	desc.size = {4, 4};
	desc.usage = wgpu::TextureUsage::CopySrc \| wgpu::TextureUsage::CopyDst \|
	wgpu::TextureUsage::RenderAttachment \| wgpu::TextureUsage::TextureBinding;
	desc.format = wgpu::TextureFormat::RGBA8Unorm;

	wgpu::ImageCopyTexture src = {};
	src.texture = device.CreateTexture(&desc);
	wgpu::ImageCopyTexture dst = {};
	dst.texture = device.CreateTexture(&desc);
	wgpu::Extent3D size = {4, 4};
	wgpu::CopyTextureForBrowserOptions options = {};

	// Copying texture for browser internally allocates a buffer which we will cause to fail here.
	EXPECT_CALL(*mDeviceMock, CreateBufferImpl)
	.WillOnce(Return(ByMove(DAWN_OUT_OF_MEMORY_ERROR(kOomErrorMessage))));

	// Expect the device lost because of the error.
	EXPECT_CALL(mDeviceLostCb,
	Call(WGPUDeviceLostReason_Undefined, HasSubstr(kOomErrorMessage), this))
	.Times(1);
	device.GetQueue().CopyTextureForBrowser(&src, &dst, &size, &options);
	}

	// Even though OOM is allowed in buffer creation, when creating a buffer in internal workaround the
	// OOM should be masked as a device loss.
	TEST_F(AllowedErrorTests, QueueCopyExternalTextureForBrowserOomBuffer) {
	wgpu::TextureDescriptor textureDesc = {};
	textureDesc.size = {4, 4};
	textureDesc.usage = wgpu::TextureUsage::CopySrc \| wgpu::TextureUsage::CopyDst \|
	wgpu::TextureUsage::RenderAttachment \| wgpu::TextureUsage::TextureBinding;
	textureDesc.format = wgpu::TextureFormat::RGBA8Unorm;

	wgpu::TextureViewDescriptor textureViewDesc = {};
	textureViewDesc.format = wgpu::TextureFormat::RGBA8Unorm;

	wgpu::ExternalTextureDescriptor externalTextureDesc = {};
	std::array<float, 12> placeholderConstantArray;
	externalTextureDesc.yuvToRgbConversionMatrix = placeholderConstantArray.data();
	externalTextureDesc.gamutConversionMatrix = placeholderConstantArray.data();
	externalTextureDesc.srcTransferFunctionParameters = placeholderConstantArray.data();
	externalTextureDesc.dstTransferFunctionParameters = placeholderConstantArray.data();
	externalTextureDesc.visibleSize = {4, 4};
	externalTextureDesc.plane0 = device.CreateTexture(&textureDesc).CreateView(&textureViewDesc);

	wgpu::ImageCopyExternalTexture src = {};
	src.externalTexture = device.CreateExternalTexture(&externalTextureDesc);
	wgpu::ImageCopyTexture dst = {};
	dst.texture = device.CreateTexture(&textureDesc);
	wgpu::Extent3D size = {4, 4};
	wgpu::CopyTextureForBrowserOptions options = {};

	// Copying texture for browser internally allocates a buffer which we will cause to fail here.
	EXPECT_CALL(*mDeviceMock, CreateBufferImpl)
	.WillOnce(Return(ByMove(DAWN_OUT_OF_MEMORY_ERROR(kOomErrorMessage))));

	// Expect the device lost because of the error.
	EXPECT_CALL(mDeviceLostCb,
	Call(WGPUDeviceLostReason_Undefined, HasSubstr(kOomErrorMessage), this))
	.Times(1);
	device.GetQueue().CopyExternalTextureForBrowser(&src, &dst, &size, &options);
	}

	// OOM error from synchronously initializing a compute pipeline should result in a device loss.
	TEST_F(AllowedErrorTests, CreateComputePipeline) {
	Ref<ShaderModuleMock> csModule = ShaderModuleMock::Create(mDeviceMock, kComputeShader.data());

	ComputePipelineDescriptor desc = {};
	desc.compute.module = csModule.Get();
	desc.compute.entryPoint = "main";

	Ref<ComputePipelineMock> computePipelineMock = ComputePipelineMock::Create(mDeviceMock, &desc);
	EXPECT_CALL(*computePipelineMock.Get(), Initialize)
	.WillOnce(Return(ByMove(DAWN_OUT_OF_MEMORY_ERROR(kOomErrorMessage))));
	EXPECT_CALL(*mDeviceMock, CreateUninitializedComputePipelineImpl)
	.WillOnce(Return(ByMove(std::move(computePipelineMock))));

	// Expect the device lost because of the error.
	EXPECT_CALL(mDeviceLostCb,
	Call(WGPUDeviceLostReason_Undefined, HasSubstr(kOomErrorMessage), this))
	.Times(1);
	device.CreateComputePipeline(ToCppAPI(&desc));
	}

	// OOM error from synchronously initializing a render pipeline should result in a device loss.
	TEST_F(AllowedErrorTests, CreateRenderPipeline) {
	Ref<ShaderModuleMock> vsModule = ShaderModuleMock::Create(mDeviceMock, kVertexShader.data());

	RenderPipelineDescriptor desc = {};
	desc.vertex.module = vsModule.Get();
	desc.vertex.entryPoint = "main";

	Ref<RenderPipelineMock> renderPipelineMock = RenderPipelineMock::Create(mDeviceMock, &desc);
	EXPECT_CALL(*renderPipelineMock.Get(), Initialize)
	.WillOnce(Return(ByMove(DAWN_OUT_OF_MEMORY_ERROR(kOomErrorMessage))));
	EXPECT_CALL(*mDeviceMock, CreateUninitializedRenderPipelineImpl)
	.WillOnce(Return(ByMove(std::move(renderPipelineMock))));

	// Expect the device lost because of the error.
	EXPECT_CALL(mDeviceLostCb,
	Call(WGPUDeviceLostReason_Undefined, HasSubstr(kOomErrorMessage), this))
	.Times(1);
	device.CreateRenderPipeline(ToCppAPI(&desc));
	}

	// Internal error from synchronously initializing a compute pipeline should not result in a device
	// loss.
	TEST_F(AllowedErrorTests, CreateComputePipelineInternalError) {
	Ref<ShaderModuleMock> csModule = ShaderModuleMock::Create(mDeviceMock, kComputeShader.data());

	ComputePipelineDescriptor desc = {};
	desc.compute.module = csModule.Get();
	desc.compute.entryPoint = "main";

	Ref<ComputePipelineMock> computePipelineMock = ComputePipelineMock::Create(mDeviceMock, &desc);
	EXPECT_CALL(*computePipelineMock.Get(), Initialize)
	.WillOnce(Return(ByMove(DAWN_INTERNAL_ERROR(kInternalErrorMessage))));
	EXPECT_CALL(*mDeviceMock, CreateUninitializedComputePipelineImpl)
	.WillOnce(Return(ByMove(std::move(computePipelineMock))));

	// Expect the internal error.
	EXPECT_CALL(mDeviceErrorCb,
	Call(WGPUErrorType_Internal, HasSubstr(kInternalErrorMessage), this))
	.Times(1);
	device.CreateComputePipeline(ToCppAPI(&desc));

	// Device lost should only happen due to destruction.
	EXPECT_CALL(mDeviceLostCb, Call(WGPUDeviceLostReason_Destroyed, _, this)).Times(1);
	}

	// Internal error from synchronously initializing a render pipeline should not result in a device
	// loss.
	TEST_F(AllowedErrorTests, CreateRenderPipelineInternalError) {
	Ref<ShaderModuleMock> vsModule = ShaderModuleMock::Create(mDeviceMock, kVertexShader.data());

	RenderPipelineDescriptor desc = {};
	desc.vertex.module = vsModule.Get();
	desc.vertex.entryPoint = "main";

	Ref<RenderPipelineMock> renderPipelineMock = RenderPipelineMock::Create(mDeviceMock, &desc);
	EXPECT_CALL(*renderPipelineMock.Get(), Initialize)
	.WillOnce(Return(ByMove(DAWN_INTERNAL_ERROR(kInternalErrorMessage))));
	EXPECT_CALL(*mDeviceMock, CreateUninitializedRenderPipelineImpl)
	.WillOnce(Return(ByMove(std::move(renderPipelineMock))));

	// Expect the internal error.
	EXPECT_CALL(mDeviceErrorCb,
	Call(WGPUErrorType_Internal, HasSubstr(kInternalErrorMessage), this))
	.Times(1);
	device.CreateRenderPipeline(ToCppAPI(&desc));

	// Device lost should only happen due to destruction.
	EXPECT_CALL(mDeviceLostCb, Call(WGPUDeviceLostReason_Destroyed, _, this)).Times(1);
	}

	//
	// Exercise async APIs where OOM errors do NOT currently cause a device lost.
	//

	// OOM error from asynchronously initializing a compute pipeline should not result in a device loss.
	TEST_F(AllowedErrorTests, CreateComputePipelineAsync) {
	Ref<ShaderModuleMock> csModule = ShaderModuleMock::Create(mDeviceMock, kComputeShader.data());

	ComputePipelineDescriptor desc = {};
	desc.compute.module = csModule.Get();
	desc.compute.entryPoint = "main";

	Ref<ComputePipelineMock> computePipelineMock = ComputePipelineMock::Create(mDeviceMock, &desc);
	EXPECT_CALL(*computePipelineMock.Get(), Initialize)
	.WillOnce(Return(ByMove(DAWN_OUT_OF_MEMORY_ERROR(kOomErrorMessage))));
	EXPECT_CALL(*mDeviceMock, CreateUninitializedComputePipelineImpl)
	.WillOnce(Return(ByMove(std::move(computePipelineMock))));

	MockCallback<wgpu::CreateComputePipelineAsyncCallback> cb;
	EXPECT_CALL(
	cb, Call(WGPUCreatePipelineAsyncStatus_InternalError, _, HasSubstr(kOomErrorMessage), this))
	.Times(1);

	device.CreateComputePipelineAsync(ToCppAPI(&desc), cb.Callback(), cb.MakeUserdata(this));
	device.Tick();

	// Device lost should only happen because of destruction.
	EXPECT_CALL(mDeviceLostCb, Call(WGPUDeviceLostReason_Destroyed, _, this)).Times(1);
	}

	// OOM error from asynchronously initializing a render pipeline should not result in a device loss.
	TEST_F(AllowedErrorTests, CreateRenderPipelineAsync) {
	Ref<ShaderModuleMock> vsModule = ShaderModuleMock::Create(mDeviceMock, kVertexShader.data());

	RenderPipelineDescriptor desc = {};
	desc.vertex.module = vsModule.Get();
	desc.vertex.entryPoint = "main";

	Ref<RenderPipelineMock> renderPipelineMock = RenderPipelineMock::Create(mDeviceMock, &desc);
	EXPECT_CALL(*renderPipelineMock.Get(), Initialize)
	.WillOnce(Return(ByMove(DAWN_OUT_OF_MEMORY_ERROR(kOomErrorMessage))));
	EXPECT_CALL(*mDeviceMock, CreateUninitializedRenderPipelineImpl)
	.WillOnce(Return(ByMove(std::move(renderPipelineMock))));

	MockCallback<wgpu::CreateRenderPipelineAsyncCallback> cb;
	EXPECT_CALL(
	cb, Call(WGPUCreatePipelineAsyncStatus_InternalError, _, HasSubstr(kOomErrorMessage), this))
	.Times(1);

	device.CreateRenderPipelineAsync(ToCppAPI(&desc), cb.Callback(), cb.MakeUserdata(this));
	device.Tick();

	// Device lost should only happen because of destruction.
	EXPECT_CALL(mDeviceLostCb, Call(WGPUDeviceLostReason_Destroyed, _, this)).Times(1);
	}

	// Internal error from asynchronously initializing a compute pipeline should not result in a device
	// loss.
	TEST_F(AllowedErrorTests, CreateComputePipelineAsyncInternalError) {
	Ref<ShaderModuleMock> csModule = ShaderModuleMock::Create(mDeviceMock, kComputeShader.data());

	ComputePipelineDescriptor desc = {};
	desc.compute.module = csModule.Get();
	desc.compute.entryPoint = "main";

	Ref<ComputePipelineMock> computePipelineMock = ComputePipelineMock::Create(mDeviceMock, &desc);
	EXPECT_CALL(*computePipelineMock.Get(), Initialize)
	.WillOnce(Return(ByMove(DAWN_INTERNAL_ERROR(kInternalErrorMessage))));
	EXPECT_CALL(*mDeviceMock, CreateUninitializedComputePipelineImpl)
	.WillOnce(Return(ByMove(std::move(computePipelineMock))));

	MockCallback<wgpu::CreateComputePipelineAsyncCallback> cb;
	EXPECT_CALL(cb, Call(WGPUCreatePipelineAsyncStatus_InternalError, _,
	HasSubstr(kInternalErrorMessage), this))
	.Times(1);

	device.CreateComputePipelineAsync(ToCppAPI(&desc), cb.Callback(), cb.MakeUserdata(this));
	device.Tick();

	// Device lost should only happen because of destruction.
	EXPECT_CALL(mDeviceLostCb, Call(WGPUDeviceLostReason_Destroyed, _, this)).Times(1);
	}

	// Internal error from asynchronously initializing a render pipeline should not result in a device
	// loss.
	TEST_F(AllowedErrorTests, CreateRenderPipelineAsyncInternalError) {
	Ref<ShaderModuleMock> vsModule = ShaderModuleMock::Create(mDeviceMock, kVertexShader.data());

	RenderPipelineDescriptor desc = {};
	desc.vertex.module = vsModule.Get();
	desc.vertex.entryPoint = "main";

	Ref<RenderPipelineMock> renderPipelineMock = RenderPipelineMock::Create(mDeviceMock, &desc);
	EXPECT_CALL(*renderPipelineMock.Get(), Initialize)
	.WillOnce(Return(ByMove(DAWN_INTERNAL_ERROR(kInternalErrorMessage))));
	EXPECT_CALL(*mDeviceMock, CreateUninitializedRenderPipelineImpl)
	.WillOnce(Return(ByMove(std::move(renderPipelineMock))));

	MockCallback<wgpu::CreateRenderPipelineAsyncCallback> cb;
	EXPECT_CALL(cb, Call(WGPUCreatePipelineAsyncStatus_InternalError, _,
	HasSubstr(kInternalErrorMessage), this))
	.Times(1);

	device.CreateRenderPipelineAsync(ToCppAPI(&desc), cb.Callback(), cb.MakeUserdata(this));
	device.Tick();

	// Device lost should only happen because of destruction.
	EXPECT_CALL(mDeviceLostCb, Call(WGPUDeviceLostReason_Destroyed, _, this)).Times(1);
	}

	//
	// Exercise APIs where OOM error are allowed and surfaced.
	//

	// OOM error from buffer creation is allowed and surfaced directly.
	TEST_F(AllowedErrorTests, CreateBuffer) {
	EXPECT_CALL(*mDeviceMock, CreateBufferImpl)
	.WillOnce(Return(ByMove(DAWN_OUT_OF_MEMORY_ERROR(kOomErrorMessage))));

	// Expect the OOM error.
	EXPECT_CALL(mDeviceErrorCb, Call(WGPUErrorType_OutOfMemory, HasSubstr(kOomErrorMessage), this))
	.Times(1);

	wgpu::BufferDescriptor desc = {};
	desc.usage = wgpu::BufferUsage::Uniform;
	desc.size = 16;
	device.CreateBuffer(&desc);

	// Device lost should only happen because of destruction.
	EXPECT_CALL(mDeviceLostCb, Call(WGPUDeviceLostReason_Destroyed, _, this)).Times(1);
	}

	// OOM error from texture creation is allowed and surfaced directly.
	TEST_F(AllowedErrorTests, CreateTexture) {
	EXPECT_CALL(*mDeviceMock, CreateTextureImpl)
	.WillOnce(Return(ByMove(DAWN_OUT_OF_MEMORY_ERROR(kOomErrorMessage))));

	// Expect the OOM error.
	EXPECT_CALL(mDeviceErrorCb, Call(WGPUErrorType_OutOfMemory, HasSubstr(kOomErrorMessage), this))
	.Times(1);

	wgpu::TextureDescriptor desc = {};
	desc.usage = wgpu::TextureUsage::CopySrc;
	desc.size = {4, 4};
	desc.format = wgpu::TextureFormat::RGBA8Unorm;
	device.CreateTexture(&desc);

	// Device lost should only happen because of destruction.
	EXPECT_CALL(mDeviceLostCb, Call(WGPUDeviceLostReason_Destroyed, _, this)).Times(1);
	}

	// OOM error from query set creation is allowed and surfaced directly.
	TEST_F(AllowedErrorTests, CreateQuerySet) {
	EXPECT_CALL(*mDeviceMock, CreateQuerySetImpl)
	.WillOnce(Return(ByMove(DAWN_OUT_OF_MEMORY_ERROR(kOomErrorMessage))));

	// Expect the OOM error.
	EXPECT_CALL(mDeviceErrorCb, Call(WGPUErrorType_OutOfMemory, HasSubstr(kOomErrorMessage), this))
	.Times(1);

	wgpu::QuerySetDescriptor desc = {};
	desc.type = wgpu::QueryType::Occlusion;
	desc.count = 1;
	device.CreateQuerySet(&desc);

	// Device lost should only happen because of destruction.
	EXPECT_CALL(mDeviceLostCb, Call(WGPUDeviceLostReason_Destroyed, _, this)).Times(1);
	}

	TEST_F(AllowedErrorTests, InjectError) {
	// Expect the OOM error.
	EXPECT_CALL(mDeviceErrorCb, Call(WGPUErrorType_OutOfMemory, HasSubstr(kOomErrorMessage), this))
	.Times(1);

	device.InjectError(wgpu::ErrorType::OutOfMemory, kOomErrorMessage);

	// Device lost should only happen because of destruction.
	EXPECT_CALL(mDeviceLostCb, Call(WGPUDeviceLostReason_Destroyed, _, this)).Times(1);
	}

	} // anonymous namespace
	} // namespace dawn::native