tests: Add ScratchBuffer tests
This commit is contained in:
parent
61e4f2d931
commit
64869807e2
3 changed files with 137 additions and 5 deletions
|
@ -19,16 +19,16 @@ public:
|
||||||
ScratchBuffer() = default;
|
ScratchBuffer() = default;
|
||||||
|
|
||||||
explicit ScratchBuffer(size_t initial_capacity)
|
explicit ScratchBuffer(size_t initial_capacity)
|
||||||
: last_requested_size{initial_capacity}, capacity{initial_capacity},
|
: last_requested_size{initial_capacity}, buffer_capacity{initial_capacity},
|
||||||
buffer{Common::make_unique_for_overwrite<T[]>(initial_capacity)} {}
|
buffer{Common::make_unique_for_overwrite<T[]>(initial_capacity)} {}
|
||||||
|
|
||||||
~ScratchBuffer() = default;
|
~ScratchBuffer() = default;
|
||||||
|
|
||||||
/// This will only grow the buffer's capacity if size is greater than the current capacity.
|
/// This will only grow the buffer's capacity if size is greater than the current capacity.
|
||||||
void resize(size_t size) {
|
void resize(size_t size) {
|
||||||
if (size > capacity) {
|
if (size > buffer_capacity) {
|
||||||
capacity = size;
|
buffer_capacity = size;
|
||||||
buffer = Common::make_unique_for_overwrite<T[]>(capacity);
|
buffer = Common::make_unique_for_overwrite<T[]>(buffer_capacity);
|
||||||
}
|
}
|
||||||
last_requested_size = size;
|
last_requested_size = size;
|
||||||
}
|
}
|
||||||
|
@ -65,9 +65,13 @@ public:
|
||||||
return last_requested_size;
|
return last_requested_size;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
[[nodiscard]] size_t capacity() const noexcept {
|
||||||
|
return buffer_capacity;
|
||||||
|
}
|
||||||
|
|
||||||
private:
|
private:
|
||||||
size_t last_requested_size{};
|
size_t last_requested_size{};
|
||||||
size_t capacity{};
|
size_t buffer_capacity{};
|
||||||
std::unique_ptr<T[]> buffer{};
|
std::unique_ptr<T[]> buffer{};
|
||||||
};
|
};
|
||||||
|
|
||||||
|
|
|
@ -8,6 +8,7 @@ add_executable(tests
|
||||||
common/host_memory.cpp
|
common/host_memory.cpp
|
||||||
common/param_package.cpp
|
common/param_package.cpp
|
||||||
common/ring_buffer.cpp
|
common/ring_buffer.cpp
|
||||||
|
common/scratch_buffer.cpp
|
||||||
common/unique_function.cpp
|
common/unique_function.cpp
|
||||||
core/core_timing.cpp
|
core/core_timing.cpp
|
||||||
core/internal_network/network.cpp
|
core/internal_network/network.cpp
|
||||||
|
|
127
src/tests/common/scratch_buffer.cpp
Normal file
127
src/tests/common/scratch_buffer.cpp
Normal file
|
@ -0,0 +1,127 @@
|
||||||
|
// SPDX-FileCopyrightText: Copyright 2022 yuzu Emulator Project
|
||||||
|
// SPDX-License-Identifier: GPL-2.0-or-later
|
||||||
|
|
||||||
|
#include <algorithm>
|
||||||
|
#include <array>
|
||||||
|
#include <span>
|
||||||
|
#include <catch2/catch.hpp>
|
||||||
|
#include "common/common_types.h"
|
||||||
|
#include "common/scratch_buffer.h"
|
||||||
|
|
||||||
|
namespace Common {
|
||||||
|
|
||||||
|
TEST_CASE("ScratchBuffer: Basic Test", "[common]") {
|
||||||
|
ScratchBuffer<u8> buf;
|
||||||
|
|
||||||
|
REQUIRE(buf.size() == 0U);
|
||||||
|
REQUIRE(buf.capacity() == 0U);
|
||||||
|
|
||||||
|
std::array<u8, 10> payload;
|
||||||
|
payload.fill(66);
|
||||||
|
|
||||||
|
buf.resize(payload.size());
|
||||||
|
REQUIRE(buf.size() == payload.size());
|
||||||
|
REQUIRE(buf.capacity() == payload.size());
|
||||||
|
|
||||||
|
std::memcpy(buf.data(), payload.data(), payload.size());
|
||||||
|
for (size_t i = 0; i < payload.size(); ++i) {
|
||||||
|
REQUIRE(buf[i] == payload[i]);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
TEST_CASE("ScratchBuffer: Resize Grow", "[common]") {
|
||||||
|
std::array<u8, 10> payload;
|
||||||
|
payload.fill(66);
|
||||||
|
|
||||||
|
ScratchBuffer<u8> buf(payload.size());
|
||||||
|
REQUIRE(buf.size() == payload.size());
|
||||||
|
REQUIRE(buf.capacity() == payload.size());
|
||||||
|
|
||||||
|
// Increasing the size should reallocate the buffer
|
||||||
|
buf.resize(payload.size() * 2);
|
||||||
|
REQUIRE(buf.size() == payload.size() * 2);
|
||||||
|
REQUIRE(buf.capacity() == payload.size() * 2);
|
||||||
|
|
||||||
|
// Since the buffer is not value initialized, reading its data will be garbage
|
||||||
|
}
|
||||||
|
|
||||||
|
TEST_CASE("ScratchBuffer: Resize Shrink", "[common]") {
|
||||||
|
std::array<u8, 10> payload;
|
||||||
|
payload.fill(66);
|
||||||
|
|
||||||
|
ScratchBuffer<u8> buf(payload.size());
|
||||||
|
REQUIRE(buf.size() == payload.size());
|
||||||
|
REQUIRE(buf.capacity() == payload.size());
|
||||||
|
|
||||||
|
std::memcpy(buf.data(), payload.data(), payload.size());
|
||||||
|
for (size_t i = 0; i < payload.size(); ++i) {
|
||||||
|
REQUIRE(buf[i] == payload[i]);
|
||||||
|
}
|
||||||
|
|
||||||
|
// Decreasing the size should not cause a buffer reallocation
|
||||||
|
// This can be tested by ensuring the buffer capacity and data has not changed,
|
||||||
|
buf.resize(1U);
|
||||||
|
REQUIRE(buf.size() == 1U);
|
||||||
|
REQUIRE(buf.capacity() == payload.size());
|
||||||
|
|
||||||
|
for (size_t i = 0; i < payload.size(); ++i) {
|
||||||
|
REQUIRE(buf[i] == payload[i]);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
TEST_CASE("ScratchBuffer: Span Size", "[common]") {
|
||||||
|
std::array<u8, 10> payload;
|
||||||
|
payload.fill(66);
|
||||||
|
|
||||||
|
ScratchBuffer<u8> buf(payload.size());
|
||||||
|
REQUIRE(buf.size() == payload.size());
|
||||||
|
REQUIRE(buf.capacity() == payload.size());
|
||||||
|
|
||||||
|
std::memcpy(buf.data(), payload.data(), payload.size());
|
||||||
|
for (size_t i = 0; i < payload.size(); ++i) {
|
||||||
|
REQUIRE(buf[i] == payload[i]);
|
||||||
|
}
|
||||||
|
|
||||||
|
buf.resize(3U);
|
||||||
|
REQUIRE(buf.size() == 3U);
|
||||||
|
REQUIRE(buf.capacity() == payload.size());
|
||||||
|
|
||||||
|
const auto buf_span = std::span<u8>(buf);
|
||||||
|
// The span size is the last requested size of the buffer, not its capacity
|
||||||
|
REQUIRE(buf_span.size() == buf.size());
|
||||||
|
|
||||||
|
for (size_t i = 0; i < buf_span.size(); ++i) {
|
||||||
|
REQUIRE(buf_span[i] == buf[i]);
|
||||||
|
REQUIRE(buf_span[i] == payload[i]);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
TEST_CASE("ScratchBuffer: Span Writes", "[common]") {
|
||||||
|
std::array<u8, 10> payload;
|
||||||
|
payload.fill(66);
|
||||||
|
|
||||||
|
ScratchBuffer<u8> buf(payload.size());
|
||||||
|
REQUIRE(buf.size() == payload.size());
|
||||||
|
REQUIRE(buf.capacity() == payload.size());
|
||||||
|
|
||||||
|
std::memcpy(buf.data(), payload.data(), payload.size());
|
||||||
|
for (size_t i = 0; i < payload.size(); ++i) {
|
||||||
|
REQUIRE(buf[i] == payload[i]);
|
||||||
|
}
|
||||||
|
|
||||||
|
buf.resize(3U);
|
||||||
|
REQUIRE(buf.size() == 3U);
|
||||||
|
REQUIRE(buf.capacity() == payload.size());
|
||||||
|
|
||||||
|
const auto buf_span = std::span<u8>(buf);
|
||||||
|
REQUIRE(buf_span.size() == buf.size());
|
||||||
|
|
||||||
|
for (size_t i = 0; i < buf_span.size(); ++i) {
|
||||||
|
const auto new_value = static_cast<u8>(i + 1U);
|
||||||
|
// Writes to a span of the scratch buffer will propogate to the buffer itself
|
||||||
|
buf_span[i] = new_value;
|
||||||
|
REQUIRE(buf[i] == new_value);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
} // namespace Common
|
Loading…
Reference in a new issue