mika/Atmosphere-libs
1
0
Fork 0
mirror of https://github.com/Atmosphere-NX/Atmosphere-libs.git synced 2025-11-17 02:01:18 +01:00
Code Issues Packages Projects Releases Wiki Activity
06ea58c7fa
Atmosphere-libs/libstratosphere/source/fssystem/fssystem_block_cache_buffered_storage.cpp
Michael Scire 06ea58c7fa ams: mark ams::Result [[nodiscard]] (partially complete). 
NOTE: This work is not yet fully complete; kernel is done, but
it was taking an exceedingly long time to get through libstratosphere.
Thus, I've temporarily added -Wno-error=unused-result for libstratosphere/stratosphere.

All warnings should be fixed to do the same thing Nintendo does as relevant, but this
is taking a phenomenally long time and is not actually the most important work to do,
so it can be put off for some time to prioritize other tasks for 21.0.0 support.
2025-11-15 12:57:42 -07:00

1068 lines
45 KiB
C++
Raw Blame History

/*
* Copyright (c) Atmosphère-NX
*
* This program is free software; you can redistribute it and/or modify it
* under the terms and conditions of the GNU General Public License,
* version 2, as published by the Free Software Foundation.
*
* This program is distributed in the hope it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
* more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#include <stratosphere.hpp>
namespace ams::fssystem {
BlockCacheBufferedStorage::BlockCacheBufferedStorage() : m_mutex(), m_data_storage(), m_last_result(ResultSuccess()), m_data_size(), m_verification_block_size(), m_verification_block_shift(), m_flags(), m_buffer_level(-1), m_block_cache_manager() {
/* ... */
}
BlockCacheBufferedStorage::~BlockCacheBufferedStorage() {
this->Finalize();
}
Result BlockCacheBufferedStorage::Initialize(fs::IBufferManager *bm, os::SdkRecursiveMutex *mtx, IStorage *data, s64 data_size, size_t verif_block_size, s32 max_cache_entries, bool is_real_data, s8 buffer_level, bool is_keep_burst_mode, bool is_writable) {
/* Validate preconditions. */
AMS_ASSERT(data != nullptr);
AMS_ASSERT(bm != nullptr);
AMS_ASSERT(mtx != nullptr);
AMS_ASSERT(m_mutex == nullptr);
AMS_ASSERT(m_data_storage == nullptr);
AMS_ASSERT(max_cache_entries > 0);
/* Initialize our manager. */
R_TRY(m_block_cache_manager.Initialize(bm, max_cache_entries));
/* Set members. */
m_mutex = mtx;
m_data_storage = data;
m_data_size = data_size;
m_verification_block_size = verif_block_size;
m_last_result = ResultSuccess();
m_flags = 0;
m_buffer_level = buffer_level;
m_is_writable = is_writable;
/* Calculate block shift. */
m_verification_block_shift = ILog2(static_cast<u32>(verif_block_size));
AMS_ASSERT(static_cast<size_t>(UINT64_C(1) << m_verification_block_shift) == m_verification_block_size);
/* Set burst mode. */
this->SetKeepBurstMode(is_keep_burst_mode);
/* Set real data cache. */
this->SetRealDataCache(is_real_data);
R_SUCCEED();
}
void BlockCacheBufferedStorage::Finalize() {
if (m_block_cache_manager.IsInitialized()) {
/* Invalidate all cache entries. */
static_cast<void>(this->InvalidateAllCacheEntries());
/* Finalize our block cache manager. */
m_block_cache_manager.Finalize();
/* Clear members. */
m_mutex = nullptr;
m_data_storage = nullptr;
m_data_size = 0;
m_verification_block_size = 0;
m_verification_block_shift = 0;
}
}
Result BlockCacheBufferedStorage::Read(s64 offset, void *buffer, size_t size) {
/* Validate pre-conditions. */
AMS_ASSERT(m_data_storage != nullptr);
AMS_ASSERT(m_block_cache_manager.IsInitialized());
/* Ensure we aren't already in a failed state. */
R_TRY(m_last_result);
/* Succeed if zero-size. */
R_SUCCEED_IF(size == 0);
/* Validate arguments. */
R_UNLESS(buffer != nullptr, fs::ResultNullptrArgument());
/* Determine the extents to read. */
s64 read_offset = offset;
size_t read_size = size;
R_UNLESS(read_offset < m_data_size, fs::ResultInvalidOffset());
if (static_cast<s64>(read_offset + read_size) > m_data_size) {
read_size = static_cast<size_t>(m_data_size - read_offset);
}
/* Determine the aligned range to read. */
const size_t block_alignment = m_verification_block_size;
s64 aligned_offset = util::AlignDown(read_offset, block_alignment);
s64 aligned_offset_end = util::AlignUp(read_offset + read_size, block_alignment);
AMS_ASSERT(0 <= aligned_offset && aligned_offset_end <= static_cast<s64>(util::AlignUp(m_data_size, block_alignment)));
/* Try to read using cache. */
char *dst = static_cast<char *>(buffer);
{
/* Determine if we can do bulk reads. */
constexpr s64 BulkReadSizeMax = 2_MB;
const bool bulk_read_enabled = (read_offset != aligned_offset || static_cast<s64>(read_offset + read_size) != aligned_offset_end) && aligned_offset_end - aligned_offset <= BulkReadSizeMax;
/* Read the head cache. */
CacheEntry head_entry = {};
MemoryRange head_range = {};
bool head_cache_needed = true;
R_TRY(this->ReadHeadCache(std::addressof(head_range), std::addressof(head_entry), std::addressof(head_cache_needed), std::addressof(read_offset), std::addressof(aligned_offset), aligned_offset_end, std::addressof(dst), std::addressof(read_size)));
/* We may be done after reading the head cache, so check if we are. */
R_SUCCEED_IF(aligned_offset >= aligned_offset_end);
/* Ensure we destroy the head buffer. */
auto head_guard = SCOPE_GUARD { m_block_cache_manager.ReleaseCacheEntry(std::addressof(head_entry), head_range); };
/* Read the tail cache. */
CacheEntry tail_entry = {};
MemoryRange tail_range = {};
bool tail_cache_needed = true;
R_TRY(this->ReadTailCache(std::addressof(tail_range), std::addressof(tail_entry), std::addressof(tail_cache_needed), read_offset, aligned_offset, std::addressof(aligned_offset_end), dst, std::addressof(read_size)));
/* We may be done after reading the tail cache, so check if we are. */
R_SUCCEED_IF(aligned_offset >= aligned_offset_end);
/* Ensure that we destroy the tail buffer. */
auto tail_guard = SCOPE_GUARD { m_block_cache_manager.ReleaseCacheEntry(std::addressof(tail_entry), tail_range); };
/* Try to do a bulk read. */
if (bulk_read_enabled) {
/* The bulk read will destroy our head/tail buffers. */
head_guard.Cancel();
tail_guard.Cancel();
do {
/* Do the bulk read. If we fail due to pooled buffer allocation failing, fall back to the normal read codepath. */
R_TRY_CATCH(this->BulkRead(read_offset, dst, read_size, std::addressof(head_range), std::addressof(tail_range), std::addressof(head_entry), std::addressof(tail_entry), head_cache_needed, tail_cache_needed)) {
R_CATCH(fs::ResultAllocationPooledBufferNotEnoughSize) { break; }
} R_END_TRY_CATCH;
/* Se successfully did a bulk read, so we're done. */
R_SUCCEED();
} while (0);
}
}
/* Read the data using non-bulk reads. */
while (aligned_offset < aligned_offset_end) {
/* Ensure that there is data for us to read. */
AMS_ASSERT(read_size > 0);
/* If conditions allow us to, read in burst mode. This doesn't use the cache. */
if (this->IsEnabledKeepBurstMode() && read_offset == aligned_offset && (block_alignment * 2 <= read_size)) {
const size_t aligned_size = util::AlignDown(read_size, block_alignment);
/* Flush the entries. */
R_TRY(this->UpdateLastResult(this->FlushRangeCacheEntries(read_offset, aligned_size, false)));
/* Read the data. */
R_TRY(this->UpdateLastResult(m_data_storage->Read(read_offset, dst, aligned_size)));
/* Advance. */
dst += aligned_size;
read_offset += aligned_size;
read_size -= aligned_size;
aligned_offset += aligned_size;
} else {
/* Get the buffer associated with what we're reading. */
CacheEntry entry;
MemoryRange range;
R_TRY(this->UpdateLastResult(this->GetAssociateBuffer(std::addressof(range), std::addressof(entry), aligned_offset, static_cast<size_t>(aligned_offset_end - aligned_offset), true)));
/* Determine where to read data into, and ensure that our entry is aligned. */
char *src = reinterpret_cast<char *>(range.first);
AMS_ASSERT(util::IsAligned(entry.range.size, block_alignment));
/* If the entry isn't cached, read the data. */
if (!entry.is_cached) {
if (const Result result = m_data_storage->Read(entry.range.offset, src, entry.range.size); R_FAILED(result)) {
m_block_cache_manager.ReleaseCacheEntry(std::addressof(entry), range);
R_RETURN(this->UpdateLastResult(result));
}
entry.is_cached = true;
}
/* Validate the entry extents. */
AMS_ASSERT(static_cast<s64>(entry.range.offset) <= aligned_offset);
AMS_ASSERT(aligned_offset < entry.range.GetEndOffset());
AMS_ASSERT(aligned_offset <= read_offset);
/* Copy the data. */
{
/* Determine where and how much to copy. */
const s64 buffer_offset = read_offset - entry.range.offset;
const size_t copy_size = std::min(read_size, static_cast<size_t>(entry.range.GetEndOffset() - read_offset));
/* Actually copy the data. */
std::memcpy(dst, src + buffer_offset, copy_size);
/* Advance. */
dst += copy_size;
read_offset += copy_size;
read_size -= copy_size;
}
/* Release the cache entry. */
R_TRY(this->UpdateLastResult(this->StoreOrDestroyBuffer(range, std::addressof(entry))));
aligned_offset = entry.range.GetEndOffset();
}
}
/* Ensure that we read all the data. */
AMS_ASSERT(read_size == 0);
R_SUCCEED();
}
Result BlockCacheBufferedStorage::Write(s64 offset, const void *buffer, size_t size) {
/* Validate pre-conditions. */
AMS_ASSERT(m_data_storage != nullptr);
AMS_ASSERT(m_block_cache_manager.IsInitialized());
/* Ensure we aren't already in a failed state. */
R_TRY(m_last_result);
/* Succeed if zero-size. */
R_SUCCEED_IF(size == 0);
/* Validate arguments. */
R_UNLESS(buffer != nullptr, fs::ResultNullptrArgument());
/* Determine the extents to read. */
R_UNLESS(offset < m_data_size, fs::ResultInvalidOffset());
if (static_cast<s64>(offset + size) > m_data_size) {
size = static_cast<size_t>(m_data_size - offset);
}
/* The actual extents may be zero-size, so succeed if that's the case. */
R_SUCCEED_IF(size == 0);
/* Determine the aligned range to read. */
const size_t block_alignment = m_verification_block_size;
s64 aligned_offset = util::AlignDown(offset, block_alignment);
const s64 aligned_offset_end = util::AlignUp(offset + size, block_alignment);
AMS_ASSERT(0 <= aligned_offset && aligned_offset_end <= static_cast<s64>(util::AlignUp(m_data_size, block_alignment)));
/* Write the data. */
const u8 *src = static_cast<const u8 *>(buffer);
while (aligned_offset < aligned_offset_end) {
/* If conditions allow us to, write in burst mode. This doesn't use the cache. */
if (this->IsEnabledKeepBurstMode() && offset == aligned_offset && (block_alignment * 2 <= size)) {
const size_t aligned_size = util::AlignDown(size, block_alignment);
/* Flush the entries. */
R_TRY(this->UpdateLastResult(this->FlushRangeCacheEntries(offset, aligned_size, true)));
/* Read the data. */
R_TRY(this->UpdateLastResult(m_data_storage->Write(offset, src, aligned_size)));
/* Set blocking buffer manager allocations. */
buffers::EnableBlockingBufferManagerAllocation();
/* Advance. */
src += aligned_size;
offset += aligned_size;
size -= aligned_size;
aligned_offset += aligned_size;
} else {
/* Get the buffer associated with what we're writing. */
CacheEntry entry;
MemoryRange range;
R_TRY(this->UpdateLastResult(this->GetAssociateBuffer(std::addressof(range), std::addressof(entry), aligned_offset, static_cast<size_t>(aligned_offset_end - aligned_offset), true)));
/* Determine where to write data into. */
char *dst = reinterpret_cast<char *>(range.first);
/* If the entry isn't cached and we're writing a partial entry, read in the entry. */
if (!entry.is_cached && ((offset != entry.range.offset) || (offset + size < static_cast<size_t>(entry.range.GetEndOffset())))) {
if (Result result = m_data_storage->Read(entry.range.offset, dst, entry.range.size); R_FAILED(result)) {
m_block_cache_manager.ReleaseCacheEntry(std::addressof(entry), range);
R_RETURN(this->UpdateLastResult(result));
}
}
entry.is_cached = true;
/* Validate the entry extents. */
AMS_ASSERT(static_cast<s64>(entry.range.offset) <= aligned_offset);
AMS_ASSERT(aligned_offset < entry.range.GetEndOffset());
AMS_ASSERT(aligned_offset <= offset);
/* Copy the data. */
{
/* Determine where and how much to copy. */
const s64 buffer_offset = offset - entry.range.offset;
const size_t copy_size = std::min(size, static_cast<size_t>(entry.range.GetEndOffset() - offset));
/* Actually copy the data. */
std::memcpy(dst + buffer_offset, src, copy_size);
/* Advance. */
src += copy_size;
offset += copy_size;
size -= copy_size;
}
/* Set the entry as write-back. */
entry.is_write_back = true;
/* Set blocking buffer manager allocations. */
buffers::EnableBlockingBufferManagerAllocation();
/* Store the associated buffer. */
CacheIndex index;
R_TRY(this->UpdateLastResult(this->StoreOrDestroyBuffer(std::addressof(index), range, std::addressof(entry))));
/* Set the after aligned offset. */
aligned_offset = entry.range.GetEndOffset();
/* If we need to, flush the cache entry. */
if (index >= 0 && IsEnabledKeepBurstMode() && offset == aligned_offset && (block_alignment * 2 <= size)) {
R_TRY(this->UpdateLastResult(this->FlushCacheEntry(index, false)));
}
}
}
/* Ensure that didn't end up in a failure state. */
R_TRY(m_last_result);
R_SUCCEED();
}
Result BlockCacheBufferedStorage::GetSize(s64 *out) {
/* Validate pre-conditions. */
AMS_ASSERT(out != nullptr);
AMS_ASSERT(m_data_storage != nullptr);
/* Set the size. */
*out = m_data_size;
R_SUCCEED();
}
Result BlockCacheBufferedStorage::Flush() {
/* Validate pre-conditions. */
AMS_ASSERT(m_data_storage != nullptr);
AMS_ASSERT(m_block_cache_manager.IsInitialized());
/* Ensure we aren't already in a failed state. */
R_TRY(m_last_result);
/* Flush all cache entries. */
R_TRY(this->UpdateLastResult(this->FlushAllCacheEntries()));
/* Flush the data storage. */
R_TRY(this->UpdateLastResult(m_data_storage->Flush()));
/* Set blocking buffer manager allocations. */
buffers::EnableBlockingBufferManagerAllocation();
R_SUCCEED();
}
Result BlockCacheBufferedStorage::OperateRange(void *dst, size_t dst_size, fs::OperationId op_id, s64 offset, s64 size, const void *src, size_t src_size) {
AMS_UNUSED(src, src_size);
/* Validate pre-conditions. */
AMS_ASSERT(m_data_storage != nullptr);
switch (op_id) {
case fs::OperationId::FillZero:
{
R_RETURN(this->FillZeroImpl(offset, size));
}
case fs::OperationId::DestroySignature:
{
R_RETURN(this->DestroySignatureImpl(offset, size));
}
case fs::OperationId::Invalidate:
{
R_UNLESS(!m_is_writable, fs::ResultUnsupportedOperateRangeForWritableBlockCacheBufferedStorage());
R_RETURN(this->InvalidateImpl());
}
case fs::OperationId::QueryRange:
{
R_RETURN(this->QueryRangeImpl(dst, dst_size, offset, size));
}
default:
R_THROW(fs::ResultUnsupportedOperateRangeForBlockCacheBufferedStorage());
}
}
Result BlockCacheBufferedStorage::Commit() {
/* Validate pre-conditions. */
AMS_ASSERT(m_data_storage != nullptr);
AMS_ASSERT(m_block_cache_manager.IsInitialized());
/* Ensure we aren't already in a failed state. */
R_TRY(m_last_result);
/* Flush all cache entries. */
R_TRY(this->UpdateLastResult(this->FlushAllCacheEntries()));
R_SUCCEED();
}
Result BlockCacheBufferedStorage::OnRollback() {
/* Validate pre-conditions. */
AMS_ASSERT(m_block_cache_manager.IsInitialized());
/* Ensure we aren't already in a failed state. */
R_TRY(m_last_result);
/* Release all valid entries back to the buffer manager. */
const auto max_cache_entry_count = m_block_cache_manager.GetCount();
for (auto index = 0; index < max_cache_entry_count; index++) {
if (const auto &entry = m_block_cache_manager[index]; entry.is_valid) {
m_block_cache_manager.InvalidateCacheEntry(index);
}
}
R_SUCCEED();
}
Result BlockCacheBufferedStorage::FillZeroImpl(s64 offset, s64 size) {
/* Ensure we aren't already in a failed state. */
R_TRY(m_last_result);
/* Get our storage size. */
s64 storage_size = 0;
R_TRY(this->UpdateLastResult(m_data_storage->GetSize(std::addressof(storage_size))));
/* Check the access range. */
R_UNLESS(0 <= offset && offset < storage_size, fs::ResultInvalidOffset());
/* Determine the extents to data signature for. */
auto start_offset = util::AlignDown(offset, m_verification_block_size);
auto end_offset = util::AlignUp(std::min(offset + size, storage_size), m_verification_block_size);
/* Flush the entries. */
R_TRY(this->UpdateLastResult(this->FlushRangeCacheEntries(offset, size, true)));
/* Handle any data before or after the aligned range. */
if (start_offset < offset || offset + size < end_offset) {
/* Allocate a work buffer. */
std::unique_ptr<char[], fs::impl::Deleter> work = fs::impl::MakeUnique<char[]>(m_verification_block_size);
R_UNLESS(work != nullptr, fs::ResultAllocationMemoryFailedInBlockCacheBufferedStorageB());
/* Handle data before the aligned range. */
if (start_offset < offset) {
/* Read the block. */
R_TRY(this->UpdateLastResult(m_data_storage->Read(start_offset, work.get(), m_verification_block_size)));
/* Determine the partial extents to clear. */
const auto clear_offset = static_cast<size_t>(offset - start_offset);
const auto clear_size = static_cast<size_t>(std::min(static_cast<s64>(m_verification_block_size - clear_offset), size));
/* Clear the partial block. */
std::memset(work.get() + clear_offset, 0, clear_size);
/* Write the partially cleared block. */
R_TRY(this->UpdateLastResult(m_data_storage->Write(start_offset, work.get(), m_verification_block_size)));
/* Update the start offset. */
start_offset += m_verification_block_size;
/* Set blocking buffer manager allocations. */
buffers::EnableBlockingBufferManagerAllocation();
}
/* Handle data after the aligned range. */
if (start_offset < offset + size && offset + size < end_offset) {
/* Read the block. */
const auto last_offset = end_offset - m_verification_block_size;
R_TRY(this->UpdateLastResult(m_data_storage->Read(last_offset, work.get(), m_verification_block_size)));
/* Clear the partial block. */
const auto clear_size = static_cast<size_t>((offset + size) - last_offset);
std::memset(work.get(), 0, clear_size);
/* Write the partially cleared block. */
R_TRY(this->UpdateLastResult(m_data_storage->Write(last_offset, work.get(), m_verification_block_size)));
/* Update the end offset. */
end_offset -= m_verification_block_size;
/* Set blocking buffer manager allocations. */
buffers::EnableBlockingBufferManagerAllocation();
}
}
/* We're done if there's no data to clear. */
R_SUCCEED_IF(start_offset == end_offset);
/* Clear the signature for the aligned range. */
R_TRY(this->UpdateLastResult(m_data_storage->OperateRange(fs::OperationId::FillZero, start_offset, end_offset - start_offset)));
/* Set blocking buffer manager allocations. */
buffers::EnableBlockingBufferManagerAllocation();
R_SUCCEED();
}
Result BlockCacheBufferedStorage::DestroySignatureImpl(s64 offset, s64 size) {
/* Ensure we aren't already in a failed state. */
R_TRY(m_last_result);
/* Get our storage size. */
s64 storage_size = 0;
R_TRY(this->UpdateLastResult(m_data_storage->GetSize(std::addressof(storage_size))));
/* Check the access range. */
R_UNLESS(0 <= offset && offset < storage_size, fs::ResultInvalidOffset());
/* Determine the extents to clear signature for. */
const auto start_offset = util::AlignUp(offset, m_verification_block_size);
const auto end_offset = util::AlignDown(std::min(offset + size, storage_size), m_verification_block_size);
/* Flush the entries. */
R_TRY(this->UpdateLastResult(this->FlushRangeCacheEntries(offset, size, true)));
/* Clear the signature for the aligned range. */
R_TRY(this->UpdateLastResult(m_data_storage->OperateRange(fs::OperationId::DestroySignature, start_offset, end_offset - start_offset)));
/* Set blocking buffer manager allocations. */
buffers::EnableBlockingBufferManagerAllocation();
R_SUCCEED();
}
Result BlockCacheBufferedStorage::InvalidateImpl() {
/* Invalidate cache entries. */
{
std::scoped_lock lk(*m_mutex);
m_block_cache_manager.Invalidate();
}
/* Invalidate the aligned range. */
{
Result result = m_data_storage->OperateRange(fs::OperationId::Invalidate, 0, std::numeric_limits<s64>::max());
AMS_ASSERT(!fs::ResultBufferAllocationFailed::Includes(result));
R_TRY(result);
}
/* Clear our last result if we should. */
if (fs::ResultIntegrityVerificationStorageCorrupted::Includes(m_last_result)) {
m_last_result = ResultSuccess();
}
R_SUCCEED();
}
Result BlockCacheBufferedStorage::QueryRangeImpl(void *dst, size_t dst_size, s64 offset, s64 size) {
/* Get our storage size. */
s64 storage_size = 0;
R_TRY(this->GetSize(std::addressof(storage_size)));
/* Determine the extents we can actually query. */
const auto actual_size = std::min(size, storage_size - offset);
const auto aligned_offset = util::AlignDown(offset, m_verification_block_size);
const auto aligned_offset_end = util::AlignUp(offset + actual_size, m_verification_block_size);
const auto aligned_size = aligned_offset_end - aligned_offset;
/* Query the aligned range. */
R_TRY(this->UpdateLastResult(m_data_storage->OperateRange(dst, dst_size, fs::OperationId::QueryRange, aligned_offset, aligned_size, nullptr, 0)));
R_SUCCEED();
}
Result BlockCacheBufferedStorage::GetAssociateBuffer(MemoryRange *out_range, CacheEntry *out_entry, s64 offset, size_t ideal_size, bool is_allocate_for_write) {
AMS_UNUSED(is_allocate_for_write);
/* Validate pre-conditions. */
AMS_ASSERT(m_data_storage != nullptr);
AMS_ASSERT(m_block_cache_manager.IsInitialized());
AMS_ASSERT(out_range != nullptr);
AMS_ASSERT(out_entry != nullptr);
/* Lock our mutex. */
std::scoped_lock lk(*m_mutex);
/* Get the maximum cache entry count. */
const CacheIndex max_cache_entry_count = m_block_cache_manager.GetCount();
/* Locate the index of the cache entry, if present. */
CacheIndex index;
size_t actual_size = ideal_size;
for (index = 0; index < max_cache_entry_count; ++index) {
if (const auto &entry = m_block_cache_manager[index]; entry.IsAllocated()) {
if (entry.range.IsIncluded(offset)) {
break;
}
if (offset <= entry.range.offset && entry.range.offset < static_cast<s64>(offset + actual_size)) {
actual_size = static_cast<s64>(entry.range.offset - offset);
}
}
}
/* Clear the out range. */
out_range->first = 0;
out_range->second = 0;
/* If we located an entry, use it. */
if (index != max_cache_entry_count) {
m_block_cache_manager.AcquireCacheEntry(out_entry, out_range, index);
actual_size = out_entry->range.size - (offset - out_entry->range.offset);
}
/* If we don't have an out entry, allocate one. */
if (out_range->first == 0) {
/* Ensure that the allocatable size is above a threshold. */
const auto size_threshold = m_block_cache_manager.GetAllocator()->GetTotalSize() / 8;
if (m_block_cache_manager.GetAllocator()->GetTotalAllocatableSize() < size_threshold) {
R_TRY(this->FlushAllCacheEntries());
}
/* Decide in advance on a block alignment. */
const size_t block_alignment = m_verification_block_size;
/* Ensure that the size we request is valid. */
{
AMS_ASSERT(actual_size >= 1);
actual_size = std::min(actual_size, block_alignment * 2);
}
AMS_ASSERT(actual_size >= block_alignment);
/* Allocate a buffer. */
R_TRY(buffers::AllocateBufferUsingBufferManagerContext(out_range, m_block_cache_manager.GetAllocator(), actual_size, fs::IBufferManager::BufferAttribute(m_buffer_level), [=](const MemoryRange &buffer) {
return buffer.first != 0 && block_alignment <= buffer.second;
}, AMS_CURRENT_FUNCTION_NAME));
/* Ensure our size is accurate. */
actual_size = std::min(actual_size, out_range->second);
/* Set the output entry. */
out_entry->is_valid = true;
out_entry->is_write_back = false;
out_entry->is_cached = false;
out_entry->is_flushing = false;
out_entry->handle = 0;
out_entry->memory_address = 0;
out_entry->memory_size = 0;
out_entry->range.offset = offset;
out_entry->range.size = actual_size;
out_entry->lru_counter = 0;
}
/* Check that we ended up with a coherent out range. */
AMS_ASSERT(out_range->second >= out_entry->range.size);
R_SUCCEED();
}
Result BlockCacheBufferedStorage::StoreOrDestroyBuffer(CacheIndex *out, const MemoryRange &range, CacheEntry *entry) {
/* Validate pre-conditions. */
AMS_ASSERT(out != nullptr);
/* Lock our mutex. */
std::scoped_lock lk(*m_mutex);
/* In the event that we fail, release our buffer. */
ON_RESULT_FAILURE { m_block_cache_manager.ReleaseCacheEntry(entry, range); };
/* If the entry is write-back, ensure we don't exceed certain dirtiness thresholds. */
if (entry->is_write_back) {
R_TRY(this->ControlDirtiness());
}
/* Get unused cache entry index. */
CacheIndex empty_index, lru_index;
m_block_cache_manager.GetEmptyCacheEntryIndex(std::addressof(empty_index), std::addressof(lru_index));
/* If all entries are valid, we need to invalidate one. */
if (empty_index == BlockCacheManager::InvalidCacheIndex) {
/* Invalidate the lease recently used entry. */
empty_index = lru_index;
/* Get the entry to invalidate, sanity check that we can invalidate it. */
const CacheEntry &entry_to_invalidate = m_block_cache_manager[empty_index];
AMS_ASSERT(entry_to_invalidate.is_valid);
AMS_ASSERT(!entry_to_invalidate.is_flushing);
AMS_UNUSED(entry_to_invalidate);
/* Invalidate the entry. */
R_TRY(this->FlushCacheEntry(empty_index, true));
/* Check that the entry was invalidated successfully. */
AMS_ASSERT(!entry_to_invalidate.is_valid);
AMS_ASSERT(!entry_to_invalidate.is_flushing);
}
/* Store the entry. */
if (m_block_cache_manager.SetCacheEntry(empty_index, *entry, range, fs::IBufferManager::BufferAttribute(m_buffer_level))) {
*out = empty_index;
} else {
*out = BlockCacheManager::InvalidCacheIndex;
}
R_SUCCEED();
}
Result BlockCacheBufferedStorage::FlushCacheEntry(CacheIndex index, bool invalidate) {
/* Lock our mutex. */
std::scoped_lock lk(*m_mutex);
/* Get the entry, sanity check that the entry's state allows for flush. */
auto &entry = m_block_cache_manager[index];
AMS_ASSERT(entry.is_valid);
AMS_ASSERT(!entry.is_flushing);
/* If we're not write back (i.e. an invalidate is happening), just release the buffer. */
if (!entry.is_write_back) {
AMS_ASSERT(invalidate);
m_block_cache_manager.InvalidateCacheEntry(index);
R_SUCCEED();
}
/* Note that we've started flushing, while we process. */
m_block_cache_manager.SetFlushing(index, true);
ON_SCOPE_EXIT { m_block_cache_manager.SetFlushing(index, false); };
/* Create and check our memory range. */
MemoryRange memory_range = fs::IBufferManager::MakeMemoryRange(entry.memory_address, entry.memory_size);
AMS_ASSERT(memory_range.first != 0);
AMS_ASSERT(memory_range.second >= entry.range.size);
/* Validate the entry's offset. */
AMS_ASSERT(entry.range.offset >= 0);
AMS_ASSERT(entry.range.offset < m_data_size);
AMS_ASSERT(util::IsAligned(entry.range.offset, m_verification_block_size));
/* Write back the data. */
Result result = ResultSuccess();
size_t write_size = entry.range.size;
if (R_SUCCEEDED(m_last_result)) {
/* Set blocking buffer manager allocations. */
result = m_data_storage->Write(entry.range.offset, reinterpret_cast<const void *>(memory_range.first), write_size);
/* Check the result. */
AMS_ASSERT(!fs::ResultBufferAllocationFailed::Includes(result));
} else {
result = m_last_result;
}
/* Set that we're not write-back. */
m_block_cache_manager.SetWriteBack(index, false);
/* If we're invalidating, release the buffer. Otherwise, register the flushed data. */
if (invalidate) {
m_block_cache_manager.ReleaseCacheEntry(index, memory_range);
} else {
AMS_ASSERT(entry.is_valid);
m_block_cache_manager.RegisterCacheEntry(index, memory_range, fs::IBufferManager::BufferAttribute(m_buffer_level));
}
/* Try to succeed. */
R_TRY(result);
/* We succeeded. */
R_SUCCEED();
}
Result BlockCacheBufferedStorage::FlushRangeCacheEntries(s64 offset, s64 size, bool invalidate) {
/* Validate pre-conditions. */
AMS_ASSERT(m_data_storage != nullptr);
AMS_ASSERT(m_block_cache_manager.IsInitialized());
/* Iterate over all entries that fall within the range. */
Result result = ResultSuccess();
const auto max_cache_entry_count = m_block_cache_manager.GetCount();
for (auto i = 0; i < max_cache_entry_count; ++i) {
auto &entry = m_block_cache_manager[i];
if (entry.is_valid && (entry.is_write_back || invalidate) && (entry.range.offset < (offset + size)) && (offset < entry.range.GetEndOffset())) {
const auto cur_result = this->FlushCacheEntry(i, invalidate);
if (R_FAILED(cur_result) && R_SUCCEEDED(result)) {
result = cur_result;
}
}
}
/* Try to succeed. */
R_TRY(result);
/* We succeeded. */
R_SUCCEED();
}
Result BlockCacheBufferedStorage::FlushAllCacheEntries() {
R_TRY(this->FlushRangeCacheEntries(0, std::numeric_limits<s64>::max(), false));
R_SUCCEED();
}
Result BlockCacheBufferedStorage::InvalidateAllCacheEntries() {
R_TRY(this->FlushRangeCacheEntries(0, std::numeric_limits<s64>::max(), true));
R_SUCCEED();
}
Result BlockCacheBufferedStorage::ControlDirtiness() {
/* Get and validate the max cache entry count. */
const auto max_cache_entry_count = m_block_cache_manager.GetCount();
AMS_ASSERT(max_cache_entry_count > 0);
/* Get size metrics from the buffer manager. */
const auto total_size = m_block_cache_manager.GetAllocator()->GetTotalSize();
const auto allocatable_size = m_block_cache_manager.GetAllocator()->GetTotalAllocatableSize();
/* If we have enough allocatable space, we don't need to do anything. */
R_SUCCEED_IF(allocatable_size >= total_size / 4);
/* Iterate over all entries (up to the threshold) and flush the least recently used dirty entry. */
constexpr auto Threshold = 2;
for (int n = 0; n < Threshold; ++n) {
auto flushed_index = BlockCacheManager::InvalidCacheIndex;
for (auto index = 0; index < max_cache_entry_count; ++index) {
if (auto &entry = m_block_cache_manager[index]; entry.is_valid && entry.is_write_back) {
if (flushed_index == BlockCacheManager::InvalidCacheIndex || m_block_cache_manager[flushed_index].lru_counter < entry.lru_counter) {
flushed_index = index;
}
}
}
/* If we can't flush anything, break. */
if (flushed_index == BlockCacheManager::InvalidCacheIndex) {
break;
}
R_TRY(this->FlushCacheEntry(flushed_index, false));
}
R_SUCCEED();
}
Result BlockCacheBufferedStorage::UpdateLastResult(Result result) {
/* Update the last result. */
if (R_FAILED(result) && !fs::ResultBufferAllocationFailed::Includes(result) && R_SUCCEEDED(m_last_result)) {
m_last_result = result;
}
/* Try to succeed with the result. */
R_TRY(result);
/* We succeeded. */
R_SUCCEED();
}
Result BlockCacheBufferedStorage::ReadHeadCache(MemoryRange *out_range, CacheEntry *out_entry, bool *out_cache_needed, s64 *offset, s64 *aligned_offset, s64 aligned_offset_end, char **buffer, size_t *size) {
/* Valdiate pre-conditions. */
AMS_ASSERT(out_range != nullptr);
AMS_ASSERT(out_entry != nullptr);
AMS_ASSERT(out_cache_needed != nullptr);
AMS_ASSERT(offset != nullptr);
AMS_ASSERT(aligned_offset != nullptr);
AMS_ASSERT(buffer != nullptr);
AMS_ASSERT(*buffer != nullptr);
AMS_ASSERT(size != nullptr);
AMS_ASSERT(*aligned_offset < aligned_offset_end);
/* Iterate over the region. */
CacheEntry entry = {};
MemoryRange memory_range = {};
*out_cache_needed = true;
while (*aligned_offset < aligned_offset_end) {
/* Get the associated buffer for the offset. */
R_TRY(this->UpdateLastResult(this->GetAssociateBuffer(std::addressof(memory_range), std::addressof(entry), *aligned_offset, m_verification_block_size, true)));
/* If the entry isn't cached, we're done. */
if (!entry.is_cached) {
break;
}
/* Set cache not needed. */
*out_cache_needed = false;
/* Determine the size to copy. */
const s64 buffer_offset = *offset - entry.range.offset;
const size_t copy_size = std::min(*size, static_cast<size_t>(entry.range.GetEndOffset() - *offset));
/* Copy data from the entry. */
std::memcpy(*buffer, reinterpret_cast<const void *>(memory_range.first + buffer_offset), copy_size);
/* Advance. */
*buffer += copy_size;
*offset += copy_size;
*size -= copy_size;
*aligned_offset = entry.range.GetEndOffset();
/* Handle the buffer. */
R_TRY(this->UpdateLastResult(this->StoreOrDestroyBuffer(memory_range, std::addressof(entry))));
}
/* Set the output entry. */
*out_entry = entry;
*out_range = memory_range;
R_SUCCEED();
}
Result BlockCacheBufferedStorage::ReadTailCache(MemoryRange *out_range, CacheEntry *out_entry, bool *out_cache_needed, s64 offset, s64 aligned_offset, s64 *aligned_offset_end, char *buffer, size_t *size) {
/* Valdiate pre-conditions. */
AMS_ASSERT(out_range != nullptr);
AMS_ASSERT(out_entry != nullptr);
AMS_ASSERT(out_cache_needed != nullptr);
AMS_ASSERT(aligned_offset_end != nullptr);
AMS_ASSERT(buffer != nullptr);
AMS_ASSERT(size != nullptr);
AMS_ASSERT(aligned_offset < *aligned_offset_end);
/* Iterate over the region. */
CacheEntry entry = {};
MemoryRange memory_range = {};
*out_cache_needed = true;
while (aligned_offset < *aligned_offset_end) {
/* Get the associated buffer for the offset. */
R_TRY(this->UpdateLastResult(this->GetAssociateBuffer(std::addressof(memory_range), std::addressof(entry), *aligned_offset_end - m_verification_block_size, m_verification_block_size, true)));
/* If the entry isn't cached, we're done. */
if (!entry.is_cached) {
break;
}
/* Set cache not needed. */
*out_cache_needed = false;
/* Determine the size to copy. */
const s64 buffer_offset = std::max(static_cast<s64>(0), offset - entry.range.offset);
const size_t copy_size = std::min(*size, static_cast<size_t>(offset + *size - entry.range.offset));
/* Copy data from the entry. */
std::memcpy(buffer + *size - copy_size, reinterpret_cast<const void *>(memory_range.first + buffer_offset), copy_size);
/* Advance. */
*size -= copy_size;
*aligned_offset_end = entry.range.offset;
/* Handle the buffer. */
R_TRY(this->UpdateLastResult(this->StoreOrDestroyBuffer(memory_range, std::addressof(entry))));
}
/* Set the output entry. */
*out_entry = entry;
*out_range = memory_range;
R_SUCCEED();
}
Result BlockCacheBufferedStorage::BulkRead(s64 offset, void *buffer, size_t size, MemoryRange *range_head, MemoryRange *range_tail, CacheEntry *entry_head, CacheEntry *entry_tail, bool head_cache_needed, bool tail_cache_needed) {
/* Validate pre-conditions. */
AMS_ASSERT(buffer != nullptr);
AMS_ASSERT(range_head != nullptr);
AMS_ASSERT(range_tail != nullptr);
AMS_ASSERT(entry_head != nullptr);
AMS_ASSERT(entry_tail != nullptr);
/* Determine bulk read offsets. */
const s64 read_offset = offset;
const size_t read_size = size;
const s64 aligned_offset = util::AlignDown(read_offset, m_verification_block_size);
const s64 aligned_offset_end = util::AlignUp(read_offset + read_size, m_verification_block_size);
char *dst = static_cast<char *>(buffer);
/* Prepare to do our reads. */
auto head_guard = SCOPE_GUARD { m_block_cache_manager.ReleaseCacheEntry(entry_head, *range_head); };
auto tail_guard = SCOPE_GUARD { m_block_cache_manager.ReleaseCacheEntry(entry_tail, *range_tail); };
/* Flush the entries. */
R_TRY(this->UpdateLastResult(this->FlushRangeCacheEntries(aligned_offset, aligned_offset_end - aligned_offset, false)));
/* Determine the buffer to read into. */
PooledBuffer pooled_buffer;
const size_t buffer_size = static_cast<size_t>(aligned_offset_end - aligned_offset);
char *read_buffer = nullptr;
if (read_offset == aligned_offset && read_size == buffer_size) {
read_buffer = dst;
} else if (tail_cache_needed && entry_tail->range.offset == aligned_offset && entry_tail->range.size == buffer_size) {
read_buffer = reinterpret_cast<char *>(range_tail->first);
} else if (head_cache_needed && entry_head->range.offset == aligned_offset && entry_head->range.size == buffer_size) {
read_buffer = reinterpret_cast<char *>(range_head->first);
} else {
pooled_buffer.AllocateParticularlyLarge(buffer_size, 1);
R_UNLESS(pooled_buffer.GetSize() >= buffer_size, fs::ResultAllocationPooledBufferNotEnoughSize());
read_buffer = pooled_buffer.GetBuffer();
}
/* Read the data. */
R_TRY(m_data_storage->Read(aligned_offset, read_buffer, buffer_size));
/* Copy the data out. */
if (dst != read_buffer) {
std::memcpy(dst, read_buffer + read_offset - aligned_offset, read_size);
}
/* Create a helper to populate our caches. */
const auto PopulateCacheFromPooledBuffer = [&](CacheEntry *entry, MemoryRange *range) {
AMS_ASSERT(entry != nullptr);
AMS_ASSERT(range != nullptr);
if (aligned_offset <= entry->range.offset && entry->range.GetEndOffset() <= static_cast<s64>(aligned_offset + buffer_size)) {
AMS_ASSERT(!entry->is_cached);
if (reinterpret_cast<void *>(range->first) != read_buffer) {
std::memcpy(reinterpret_cast<void *>(range->first), read_buffer + entry->range.offset - aligned_offset, entry->range.size);
}
entry->is_cached = true;
}
};
/* Populate tail cache if needed. */
if (tail_cache_needed) {
PopulateCacheFromPooledBuffer(entry_tail, range_tail);
}
/* Populate head cache if needed. */
if (head_cache_needed) {
PopulateCacheFromPooledBuffer(entry_head, range_head);
}
/* If both entries are cached, one may contain the other; in that case, we need only the larger entry. */
if (entry_head->is_cached && entry_tail->is_cached) {
if (entry_tail->range.offset <= entry_head->range.offset && entry_head->range.GetEndOffset() <= entry_tail->range.GetEndOffset()) {
entry_head->is_cached = false;
} else if (entry_head->range.offset <= entry_tail->range.offset && entry_tail->range.GetEndOffset() <= entry_head->range.GetEndOffset()) {
entry_tail->is_cached = false;
}
}
/* Destroy the tail cache. */
tail_guard.Cancel();
if (entry_tail->is_cached) {
R_TRY(this->UpdateLastResult(this->StoreOrDestroyBuffer(*range_tail, entry_tail)));
} else {
m_block_cache_manager.ReleaseCacheEntry(entry_tail, *range_tail);
}
/* Destroy the head cache. */
head_guard.Cancel();
if (entry_head->is_cached) {
R_TRY(this->UpdateLastResult(this->StoreOrDestroyBuffer(*range_head, entry_head)));
} else {
m_block_cache_manager.ReleaseCacheEntry(entry_head, *range_head);
}
R_SUCCEED();
}
}
Reference in New Issue View Git Blame Copy Permalink