src/tests/white_box/QueryInternalShaderTests.cpp - dawn - Git at Google

 // Copyright 2020 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 "tests/DawnTest.h"

 #include "dawn_native/Buffer.h"
 #include "dawn_native/CommandEncoder.h"
 #include "dawn_native/QueryHelper.h"
 #include "utils/WGPUHelpers.h"

 namespace {

     void EncodeConvertTimestampsToNanoseconds(wgpu::CommandEncoder encoder,
                                               wgpu::Buffer timestamps,
                                               wgpu::Buffer availability,
                                               wgpu::Buffer params) {
         ASSERT_TRUE(
             dawn::native::EncodeConvertTimestampsToNanoseconds(
                 dawn::native::FromAPI(encoder.Get()), dawn::native::FromAPI(timestamps.Get()),
                 dawn::native::FromAPI(availability.Get()), dawn::native::FromAPI(params.Get()))
                 .IsSuccess());
     }

     class InternalShaderExpectation : public detail::Expectation {
       public:
         ~InternalShaderExpectation() override = default;

         InternalShaderExpectation(const uint64_t* values, const unsigned int count) {
             mExpected.assign(values, values + count);
         }

         // Expect the actual results are approximately equal to the expected values.
         testing::AssertionResult Check(const void* data, size_t size) override {
             DAWN_ASSERT(size == sizeof(uint64_t) * mExpected.size());
             constexpr static float kErrorToleranceRatio = 0.002f;

             const uint64_t* actual = static_cast<const uint64_t*>(data);
             for (size_t i = 0; i < mExpected.size(); ++i) {
                 if (mExpected[i] == 0 && actual[i] != 0) {
                     return testing::AssertionFailure()
                            << "Expected data[" << i << "] to be 0, actual " << actual[i]
                            << std::endl;
                 }

                 if (abs(static_cast<int64_t>(mExpected[i] - actual[i])) >
                     mExpected[i] * kErrorToleranceRatio) {
                     return testing::AssertionFailure()
                            << "Expected data[" << i << "] to be " << mExpected[i] << ", actual "
                            << actual[i] << ". Error rate is larger than " << kErrorToleranceRatio
                            << std::endl;
                 }
             }

             return testing::AssertionSuccess();
         }

       private:
         std::vector<uint64_t> mExpected;
     };

 }  // anonymous namespace

 constexpr static uint64_t kSentinelValue = ~uint64_t(0u);

 // A gpu frequency on Intel D3D12 (ticks/second)
 constexpr uint64_t kGPUFrequency = 12000048u;
 constexpr uint64_t kNsPerSecond = 1000000000u;
 // Timestamp period in nanoseconds
 constexpr float kPeriod = static_cast<float>(kNsPerSecond) / kGPUFrequency;

 class QueryInternalShaderTests : public DawnTest {
   protected:
     // Original timestamp values in query set for testing
     const std::vector<uint64_t> querySetValues = {
         kSentinelValue,  // garbage data which is not written at beginning
         10079569507,     // t0
         10394415012,     // t1
         kSentinelValue,  // garbage data which is not written between timestamps
         11713454943,     // t2
         38912556941,     // t3 (big value)
         10080295766,     // t4 (reset)
         12159966783,     // t5 (after reset)
         12651224612,     // t6
         39872473956,     // t7
     };

     const uint32_t kQueryCount = querySetValues.size();

     // Timestamps available state
     const std::vector<uint32_t> availabilities = {0, 1, 1, 0, 1, 1, 1, 1, 1, 1};

     const std::vector<uint64_t> GetExpectedResults(const std::vector<uint64_t>& origin,
                                                    uint32_t start,
                                                    uint32_t firstQuery,
                                                    uint32_t queryCount) {
         std::vector<uint64_t> expected(origin.begin(), origin.end());
         for (size_t i = 0; i < queryCount; i++) {
             if (availabilities[firstQuery + i] == 0) {
                 // Not a available timestamp, write 0
                 expected[start + i] = 0u;
             } else {
                 // Maybe the timestamp * period is larger than the maximum of uint64, so cast the
                 // delta value to double (higher precision than float)
                 expected[start + i] =
                     static_cast<uint64_t>(static_cast<double>(origin[start + i]) * kPeriod);
             }
         }
         return expected;
     }

     void RunTest(uint32_t firstQuery, uint32_t queryCount, uint32_t destinationOffset) {
         ASSERT(destinationOffset % 256 == 0);

         uint64_t size = queryCount * sizeof(uint64_t) + destinationOffset;

         // The resolve buffer storing original timestamps and the converted values
         wgpu::BufferDescriptor timestampsDesc;
         timestampsDesc.size = size;
         timestampsDesc.usage = wgpu::BufferUsage::QueryResolve | wgpu::BufferUsage::CopySrc |
                                wgpu::BufferUsage::CopyDst;
         wgpu::Buffer timestampsBuffer = device.CreateBuffer(&timestampsDesc);

         // Set sentinel values to check the slots before the destination offset should not be
         // converted
         std::vector<uint64_t> timestampValues(size / sizeof(uint64_t), 1u);
         uint32_t start = destinationOffset / sizeof(uint64_t);
         for (uint32_t i = 0; i < queryCount; i++) {
             timestampValues[start + i] = querySetValues[firstQuery + 1];
         }
         // Write sentinel values and orignal timestamps to timestamps buffer
         queue.WriteBuffer(timestampsBuffer, 0, timestampValues.data(), size);

         // The buffer indicating which values are available timestamps
         wgpu::Buffer availabilityBuffer =
             utils::CreateBufferFromData(device, availabilities.data(),
                                         kQueryCount * sizeof(uint32_t), wgpu::BufferUsage::Storage);

         // The params uniform buffer
         dawn::native::TimestampParams params = {firstQuery, queryCount, destinationOffset, kPeriod};
         wgpu::Buffer paramsBuffer = utils::CreateBufferFromData(device, &params, sizeof(params),
                                                                 wgpu::BufferUsage::Uniform);

         wgpu::CommandEncoder encoder = device.CreateCommandEncoder();
         EncodeConvertTimestampsToNanoseconds(encoder, timestampsBuffer, availabilityBuffer,
                                              paramsBuffer);
         wgpu::CommandBuffer commands = encoder.Finish();
         queue.Submit(1, &commands);

         const std::vector<uint64_t> expected =
             GetExpectedResults(timestampValues, start, firstQuery, queryCount);

         EXPECT_BUFFER(timestampsBuffer, 0, size,
                       new InternalShaderExpectation(expected.data(), size / sizeof(uint64_t)));
     }

   private:
 };

 // Test the accuracy of timestamp compute shader which uses unsigned 32-bit integers to simulate
 // unsigned 64-bit integers (timestamps) multiplied by float (period).
 // The arguments pass to timestamp internal pipeline:
 // - The timestamps buffer contains the original timestamps resolved from query set (created
 //   manually here), and will be used to store the results processed by the compute shader.
 //   Expect 0 for unavailable timestamps and nanoseconds for available timestamps in an expected
 //   error tolerance ratio.
 // - The availability buffer passes the data of which slot in timestamps buffer is an initialized
 //   timestamp.
 // - The params buffer passes the timestamp count, the offset in timestamps buffer and the
 //   timestamp period (here use GPU frequency (HZ) on Intel D3D12 to calculate the period in
 //   ns for testing).
 TEST_P(QueryInternalShaderTests, TimestampComputeShader) {
     // TODO(crbug.com/dawn/741): Test output is wrong with D3D12 + WARP.
     DAWN_SUPPRESS_TEST_IF(IsD3D12() && IsWARP());

     DAWN_TEST_UNSUPPORTED_IF(UsesWire());

     // Convert timestamps in timestamps buffer with offset 0
     // Test for ResolveQuerySet(querySet, 0, kQueryCount, timestampsBuffer, 0)
     RunTest(0, kQueryCount, 0);

     // Convert timestamps in timestamps buffer with offset 256
     // Test for ResolveQuerySet(querySet, 1, kQueryCount - 1, timestampsBuffer, 256)
     RunTest(1, kQueryCount - 1, 256);

     // Convert partial timestamps in timestamps buffer with offset 256
     // Test for ResolveQuerySet(querySet, 1, 4, timestampsBuffer, 256)
     RunTest(1, 4, 256);
 }

 DAWN_INSTANTIATE_TEST(QueryInternalShaderTests, D3D12Backend(), MetalBackend(), VulkanBackend());
	// Copyright 2020 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 "tests/DawnTest.h"

	#include "dawn_native/Buffer.h"
	#include "dawn_native/CommandEncoder.h"
	#include "dawn_native/QueryHelper.h"
	#include "utils/WGPUHelpers.h"

	namespace {

	void EncodeConvertTimestampsToNanoseconds(wgpu::CommandEncoder encoder,
	wgpu::Buffer timestamps,
	wgpu::Buffer availability,
	wgpu::Buffer params) {
	ASSERT_TRUE(
	dawn::native::EncodeConvertTimestampsToNanoseconds(
	dawn::native::FromAPI(encoder.Get()), dawn::native::FromAPI(timestamps.Get()),
	dawn::native::FromAPI(availability.Get()), dawn::native::FromAPI(params.Get()))
	.IsSuccess());
	}

	class InternalShaderExpectation : public detail::Expectation {
	public:
	~InternalShaderExpectation() override = default;

	InternalShaderExpectation(const uint64_t* values, const unsigned int count) {
	mExpected.assign(values, values + count);
	}

	// Expect the actual results are approximately equal to the expected values.
	testing::AssertionResult Check(const void* data, size_t size) override {
	DAWN_ASSERT(size == sizeof(uint64_t) * mExpected.size());
	constexpr static float kErrorToleranceRatio = 0.002f;

	const uint64_t* actual = static_cast<const uint64_t*>(data);
	for (size_t i = 0; i < mExpected.size(); ++i) {
	if (mExpected[i] == 0 && actual[i] != 0) {
	return testing::AssertionFailure()
	<< "Expected data[" << i << "] to be 0, actual " << actual[i]
	<< std::endl;
	}

	if (abs(static_cast<int64_t>(mExpected[i] - actual[i])) >
	mExpected[i] * kErrorToleranceRatio) {
	return testing::AssertionFailure()
	<< "Expected data[" << i << "] to be " << mExpected[i] << ", actual "
	<< actual[i] << ". Error rate is larger than " << kErrorToleranceRatio
	<< std::endl;
	}
	}

	return testing::AssertionSuccess();
	}

	private:
	std::vector<uint64_t> mExpected;
	};

	} // anonymous namespace

	constexpr static uint64_t kSentinelValue = ~uint64_t(0u);

	// A gpu frequency on Intel D3D12 (ticks/second)
	constexpr uint64_t kGPUFrequency = 12000048u;
	constexpr uint64_t kNsPerSecond = 1000000000u;
	// Timestamp period in nanoseconds
	constexpr float kPeriod = static_cast<float>(kNsPerSecond) / kGPUFrequency;

	class QueryInternalShaderTests : public DawnTest {
	protected:
	// Original timestamp values in query set for testing
	const std::vector<uint64_t> querySetValues = {
	kSentinelValue, // garbage data which is not written at beginning
	10079569507, // t0
	10394415012, // t1
	kSentinelValue, // garbage data which is not written between timestamps
	11713454943, // t2
	38912556941, // t3 (big value)
	10080295766, // t4 (reset)
	12159966783, // t5 (after reset)
	12651224612, // t6
	39872473956, // t7
	};

	const uint32_t kQueryCount = querySetValues.size();

	// Timestamps available state
	const std::vector<uint32_t> availabilities = {0, 1, 1, 0, 1, 1, 1, 1, 1, 1};

	const std::vector<uint64_t> GetExpectedResults(const std::vector<uint64_t>& origin,
	uint32_t start,
	uint32_t firstQuery,
	uint32_t queryCount) {
	std::vector<uint64_t> expected(origin.begin(), origin.end());
	for (size_t i = 0; i < queryCount; i++) {
	if (availabilities[firstQuery + i] == 0) {
	// Not a available timestamp, write 0
	expected[start + i] = 0u;
	} else {
	// Maybe the timestamp * period is larger than the maximum of uint64, so cast the
	// delta value to double (higher precision than float)
	expected[start + i] =
	static_cast<uint64_t>(static_cast<double>(origin[start + i]) * kPeriod);
	}
	}
	return expected;
	}

	void RunTest(uint32_t firstQuery, uint32_t queryCount, uint32_t destinationOffset) {
	ASSERT(destinationOffset % 256 == 0);

	uint64_t size = queryCount * sizeof(uint64_t) + destinationOffset;

	// The resolve buffer storing original timestamps and the converted values
	wgpu::BufferDescriptor timestampsDesc;
	timestampsDesc.size = size;
	timestampsDesc.usage = wgpu::BufferUsage::QueryResolve \| wgpu::BufferUsage::CopySrc \|
	wgpu::BufferUsage::CopyDst;
	wgpu::Buffer timestampsBuffer = device.CreateBuffer(&timestampsDesc);

	// Set sentinel values to check the slots before the destination offset should not be
	// converted
	std::vector<uint64_t> timestampValues(size / sizeof(uint64_t), 1u);
	uint32_t start = destinationOffset / sizeof(uint64_t);
	for (uint32_t i = 0; i < queryCount; i++) {
	timestampValues[start + i] = querySetValues[firstQuery + 1];
	}
	// Write sentinel values and orignal timestamps to timestamps buffer
	queue.WriteBuffer(timestampsBuffer, 0, timestampValues.data(), size);

	// The buffer indicating which values are available timestamps
	wgpu::Buffer availabilityBuffer =
	utils::CreateBufferFromData(device, availabilities.data(),
	kQueryCount * sizeof(uint32_t), wgpu::BufferUsage::Storage);

	// The params uniform buffer
	dawn::native::TimestampParams params = {firstQuery, queryCount, destinationOffset, kPeriod};
	wgpu::Buffer paramsBuffer = utils::CreateBufferFromData(device, &params, sizeof(params),
	wgpu::BufferUsage::Uniform);

	wgpu::CommandEncoder encoder = device.CreateCommandEncoder();
	EncodeConvertTimestampsToNanoseconds(encoder, timestampsBuffer, availabilityBuffer,
	paramsBuffer);
	wgpu::CommandBuffer commands = encoder.Finish();
	queue.Submit(1, &commands);

	const std::vector<uint64_t> expected =
	GetExpectedResults(timestampValues, start, firstQuery, queryCount);

	EXPECT_BUFFER(timestampsBuffer, 0, size,
	new InternalShaderExpectation(expected.data(), size / sizeof(uint64_t)));
	}

	private:
	};

	// Test the accuracy of timestamp compute shader which uses unsigned 32-bit integers to simulate
	// unsigned 64-bit integers (timestamps) multiplied by float (period).
	// The arguments pass to timestamp internal pipeline:
	// - The timestamps buffer contains the original timestamps resolved from query set (created
	// manually here), and will be used to store the results processed by the compute shader.
	// Expect 0 for unavailable timestamps and nanoseconds for available timestamps in an expected
	// error tolerance ratio.
	// - The availability buffer passes the data of which slot in timestamps buffer is an initialized
	// timestamp.
	// - The params buffer passes the timestamp count, the offset in timestamps buffer and the
	// timestamp period (here use GPU frequency (HZ) on Intel D3D12 to calculate the period in
	// ns for testing).
	TEST_P(QueryInternalShaderTests, TimestampComputeShader) {
	// TODO(crbug.com/dawn/741): Test output is wrong with D3D12 + WARP.
	DAWN_SUPPRESS_TEST_IF(IsD3D12() && IsWARP());

	DAWN_TEST_UNSUPPORTED_IF(UsesWire());

	// Convert timestamps in timestamps buffer with offset 0
	// Test for ResolveQuerySet(querySet, 0, kQueryCount, timestampsBuffer, 0)
	RunTest(0, kQueryCount, 0);

	// Convert timestamps in timestamps buffer with offset 256
	// Test for ResolveQuerySet(querySet, 1, kQueryCount - 1, timestampsBuffer, 256)
	RunTest(1, kQueryCount - 1, 256);

	// Convert partial timestamps in timestamps buffer with offset 256
	// Test for ResolveQuerySet(querySet, 1, 4, timestampsBuffer, 256)
	RunTest(1, 4, 256);
	}

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