Compare commits

..

2 Commits

Author SHA1 Message Date
lizzie 9f20f7f4c1 2026-09-05 17:42:18
Signed-off-by: lizzie <lizzie@eden-emu.dev>
2026-09-05 17:42:18 +00:00
lizzie cc94ee2c70 2026-09-05 17:17:08
Signed-off-by: lizzie <lizzie@eden-emu.dev>
2026-09-05 17:17:08 +00:00
11 changed files with 475 additions and 624 deletions
+164 -286
View File
@@ -7,25 +7,18 @@
#include <vector> #include <vector>
#include "common/assert.h" #include "common/assert.h"
#include "common/bit_util.h"
#include "common/fs/file.h" #include "common/fs/file.h"
#include "common/fs/fs.h" #include "common/fs/fs.h"
#include "common/fs/fs_types.h"
#ifdef __ANDROID__ #ifdef __ANDROID__
#include "common/fs/fs_android.h" #include "common/fs/fs_android.h"
#endif #endif
#include "common/logging.h" #include "common/logging.h"
#include "common/literals.h"
#ifdef _WIN32 #ifdef _WIN32
#include <io.h> #include <io.h>
#include <share.h> #include <share.h>
#include <windows.h>
#else #else
#include <unistd.h> #include <unistd.h>
#include <sys/mman.h>
#include <sys/stat.h>
#include <fcntl.h>
#endif #endif
#ifdef _MSC_VER #ifdef _MSC_VER
@@ -43,13 +36,13 @@ namespace {
#ifdef _WIN32 #ifdef _WIN32
/** /**
* Converts the file access mode and file type enums to a file access mode wide string. * Converts the file access mode and file type enums to a file access mode wide string.
* *
* @param mode File access mode * @param mode File access mode
* @param type File type * @param type File type
* *
* @returns A pointer to a wide string representing the file access mode. * @returns A pointer to a wide string representing the file access mode.
*/ */
[[nodiscard]] constexpr const wchar_t* AccessModeToWStr(FileAccessMode mode, FileType type) { [[nodiscard]] constexpr const wchar_t* AccessModeToWStr(FileAccessMode mode, FileType type) {
switch (type) { switch (type) {
case FileType::BinaryFile: case FileType::BinaryFile:
@@ -86,12 +79,12 @@ namespace {
} }
/** /**
* Converts the file-share access flag enum to a Windows defined file-share access flag. * Converts the file-share access flag enum to a Windows defined file-share access flag.
* *
* @param flag File-share access flag * @param flag File-share access flag
* *
* @returns Windows defined file-share access flag. * @returns Windows defined file-share access flag.
*/ */
[[nodiscard]] constexpr int ToWindowsFileShareFlag(FileShareFlag flag) { [[nodiscard]] constexpr int ToWindowsFileShareFlag(FileShareFlag flag) {
switch (flag) { switch (flag) {
case FileShareFlag::ShareNone: case FileShareFlag::ShareNone:
@@ -109,13 +102,13 @@ namespace {
#else #else
/** /**
* Converts the file access mode and file type enums to a file access mode string. * Converts the file access mode and file type enums to a file access mode string.
* *
* @param mode File access mode * @param mode File access mode
* @param type File type * @param type File type
* *
* @returns A pointer to a string representing the file access mode. * @returns A pointer to a string representing the file access mode.
*/ */
[[nodiscard]] constexpr const char* AccessModeToStr(FileAccessMode mode, FileType type) { [[nodiscard]] constexpr const char* AccessModeToStr(FileAccessMode mode, FileType type) {
switch (type) { switch (type) {
case FileType::BinaryFile: case FileType::BinaryFile:
@@ -154,12 +147,12 @@ namespace {
#endif #endif
/** /**
* Converts the seek origin enum to a seek origin integer. * Converts the seek origin enum to a seek origin integer.
* *
* @param origin Seek origin * @param origin Seek origin
* *
* @returns Seek origin integer. * @returns Seek origin integer.
*/ */
[[nodiscard]] constexpr int ToSeekOrigin(SeekOrigin origin) { [[nodiscard]] constexpr int ToSeekOrigin(SeekOrigin origin) {
switch (origin) { switch (origin) {
case SeekOrigin::SetOrigin: case SeekOrigin::SetOrigin:
@@ -185,7 +178,7 @@ std::string ReadStringFromFile(const std::filesystem::path& path, FileType type)
} }
size_t WriteStringToFile(const std::filesystem::path& path, FileType type, size_t WriteStringToFile(const std::filesystem::path& path, FileType type,
std::string_view string) { std::string_view string) {
if (Exists(path) && !IsFile(path)) { if (Exists(path) && !IsFile(path)) {
return 0; return 0;
} }
@@ -196,7 +189,7 @@ size_t WriteStringToFile(const std::filesystem::path& path, FileType type,
} }
size_t AppendStringToFile(const std::filesystem::path& path, FileType type, size_t AppendStringToFile(const std::filesystem::path& path, FileType type,
std::string_view string) { std::string_view string) {
if (Exists(path) && !IsFile(path)) { if (Exists(path) && !IsFile(path)) {
return 0; return 0;
} }
@@ -251,189 +244,69 @@ FileType IOFile::GetType() const {
return file_type; return file_type;
} }
#if defined(__unix__)
static int PlatformMapReadOnly(IOFile& io, const char* path) {
io.mmap_fd = open(path, O_RDONLY);
if (io.mmap_fd > 0) {
struct stat st;
fstat(io.mmap_fd, &st);
io.mmap_size = st.st_size;
int map_flags = MAP_PRIVATE;
#ifdef MAP_PREFAULT_READ
// Prefaults reads so the final resulting pagetable from this big stupid mmap()
// isn't comically lazily loaded, we just coalesce everything in-place for our
// lovely mmap flags; if we didn't prefault the reads the page table will be
// constructed in-place (i.e on a read-by-read basis) causing lovely soft-faults
// which would nuke any performance gains.
//
// This of course incurs a cost in the initial mmap(2) call, but that is fine.
map_flags |= MAP_PREFAULT_READ;
#endif
#ifdef MAP_NOSYNC
// This causes physical media to not be synched to our file/memory
// This means that if the read-only file is written to, we won't see changes
// or we may see changes which are just funnily scattered, in any case
// this presumes the files won't be changed during execution
//
// Do not ever use this on write files (if we ever support that); this will create
// a fun amount of fragmentation on the disk.
map_flags |= MAP_NOSYNC;
#endif
#if defined(NDEBUG) && defined(MAP_NOCORE)
map_flags |= MAP_NOCORE;
#endif
#ifdef MAP_HUGE_2MB
map_flags |= MAP_HUGE_2MB; //2mb pages
#elif defined(MAP_ALIGNED)
// File must be big enough that it's worth to super align. We can't just super-align every
// file otherwise we will run out of alignments for actually important files :)
// System doesn't guarantee a super alignment, but if it's available it will delete
// about 3 layers(?) of the TLB tree for each read/write.
// Again the cost of faults may make this negligible gains, but hey, we gotta work
// what we gotta work with.
map_flags |= MAP_ALIGNED(21); //2^21 = 2mb use 2MB pages
#endif
io.mmap_base = (u8*)mmap(nullptr, io.mmap_size, PROT_READ, map_flags, io.mmap_fd, 0);
if (io.mmap_base == MAP_FAILED) {
close(io.mmap_fd);
io.mmap_fd = -1;
} else {
using namespace Common::Literals;
// For small files it is acceptable to use a full readahead
// See https://github.com/torvalds/linux/blob/e80d033851b3bc94c3d254ac66660ddd0a49d72c/include/linux/pagemap.h#L1392
if (u64(st.st_size) >= 256_MiB) {
posix_madvise(io.mmap_base, io.mmap_size, POSIX_MADV_RANDOM);
} else {
posix_madvise(io.mmap_base, io.mmap_size, POSIX_MADV_SEQUENTIAL);
}
}
}
return io.mmap_fd;
}
static void PlatformUnmap(IOFile& io) {
if (io.mmap_fd != -1) {
munmap(io.mmap_base, io.mmap_size);
close(io.mmap_fd);
io.mmap_fd = -1;
}
}
#elif defined(__APPLE__)
// NO IMPLEMENTATION YET
#else
static int PlatformMapReadOnly(IOFile& io, const wchar_t* path) {
io.file_handle = CreateFileW(path, GENERIC_READ, FILE_SHARE_READ, nullptr, OPEN_EXISTING, FILE_ATTRIBUTE_NORMAL | FILE_FLAG_SEQUENTIAL_SCAN, nullptr);
if (HANDLE(io.file_handle) != INVALID_HANDLE_VALUE) {
io.mapping_handle = CreateFileMappingW(HANDLE(io.file_handle), nullptr, PAGE_READONLY, 0, 0, nullptr);
if (io.mapping_handle) {
io.mmap_base = (u8*)MapViewOfFile(HANDLE(io.mapping_handle), FILE_MAP_READ, 0, 0, 0);
if (io.mmap_base) {
_LARGE_INTEGER pvalue;
GetFileSizeEx(io.file_handle, &pvalue);
io.mmap_size = uint32_t(pvalue.QuadPart);
} else {
CloseHandle(io.mapping_handle);
CloseHandle(io.file_handle);
return -1;
}
} else {
CloseHandle(io.file_handle);
return -1;
}
}
return 0;
}
static void PlatformUnmap(IOFile& io) {
if(io.mapping_handle) {
if(io.mmap_base)
UnmapViewOfFile(HANDLE(io.mmap_base));
CloseHandle(HANDLE(io.mapping_handle));
}
if(io.file_handle != INVALID_HANDLE_VALUE)
CloseHandle(HANDLE(io.file_handle));
}
#endif
void IOFile::Open(const fs::path& path, FileAccessMode mode, FileType type, FileShareFlag flag) { void IOFile::Open(const fs::path& path, FileAccessMode mode, FileType type, FileShareFlag flag) {
Close(); Close();
file_path = path; file_path = path;
file_access_mode = mode; file_access_mode = mode;
file_type = type; file_type = type;
errno = 0; errno = 0;
#ifdef _WIN32 #ifdef _WIN32
// TODO: this probably can use better logic but oh well I'm not a windowser if (flag != FileShareFlag::ShareNone) {
file_handle = nullptr; file = _wfsopen(path.c_str(), AccessModeToWStr(mode, type), ToWindowsFileShareFlag(flag));
if (type == FileType::BinaryFile && mode == FileAccessMode::Read) { } else {
if (PlatformMapReadOnly(*this, path.c_str()) == -1) { _wfopen_s(&file, path.c_str(), AccessModeToWStr(mode, type));
LOG_ERROR(Common_Filesystem, "Error mmap'ing file"); //: {}", path.c_str());
}
}
if (file_handle == nullptr) {
if (flag != FileShareFlag::ShareNone) {
file = _wfsopen(path.c_str(), AccessModeToWStr(mode, type), ToWindowsFileShareFlag(flag));
} else {
_wfopen_s(&file, path.c_str(), AccessModeToWStr(mode, type));
}
} }
#elif __ANDROID__ #elif __ANDROID__
if (Android::IsContentUri(path)) { if (Android::IsContentUri(path)) {
ASSERT_MSG(mode == FileAccessMode::Read, "Content URI file access is for read-only!"); ASSERT_MSG(mode == FileAccessMode::Read, "Content URI file access is for read-only!");
if (PlatformMapReadOnly(*this, path.c_str()) == -1) { const auto fd = Android::OpenContentUri(path, Android::OpenMode::Read);
LOG_ERROR(Common_Filesystem, "Error mmap'ing file: {}", path.c_str()); if (fd != -1) {
int const fd = Android::OpenContentUri(path, Android::OpenMode::Read); file = fdopen(fd, "r");
if (fd != -1) { const auto error_num = errno;
file = fdopen(fd, "r"); if (error_num != 0 && file == nullptr) {
if (errno != 0 && file == nullptr) LOG_ERROR(Common_Filesystem, "Error opening file: {}, error: {}", path.c_str(),
LOG_ERROR(Common_Filesystem, "Error opening file: {}, error: {}", path.c_str(), strerror(errno)); strerror(error_num));
} else {
LOG_ERROR(Common_Filesystem, "Error opening file: {}", path.c_str());
} }
} else {
LOG_ERROR(Common_Filesystem, "Error opening file: {}", path.c_str());
} }
} else { } else {
file = std::fopen(path.c_str(), AccessModeToStr(mode, type)); file = std::fopen(path.c_str(), AccessModeToStr(mode, type));
} }
#elif defined(__HAIKU__) || defined(__managarm__) || defined(__OPENORBIS__) || defined(__APPLE__)
file = std::fopen(path.c_str(), AccessModeToStr(mode, type));
#elif defined(__unix__)
if (type == FileType::BinaryFile && mode == FileAccessMode::Read) {
if (PlatformMapReadOnly(*this, path.c_str()) == -1) {
LOG_ERROR(Common_Filesystem, "Error mmap'ing file: {}", path.c_str());
}
}
if (mmap_fd == -1) {
file = std::fopen(path.c_str(), AccessModeToStr(mode, type)); // mmap(2) failed or simply we can't use it
}
#else #else
// Some other fancy OS (ahem fucking Darwin/Mac OSX)
file = std::fopen(path.c_str(), AccessModeToStr(mode, type)); file = std::fopen(path.c_str(), AccessModeToStr(mode, type));
#endif #endif
if (!IsOpen()) { if (!IsOpen()) {
const auto ec = std::error_code{errno, std::generic_category()}; const auto ec = std::error_code{errno, std::generic_category()};
LOG_ERROR(Common_Filesystem, "Failed to open the file at path={}, ec_message={}", LOG_ERROR(Common_Filesystem, "Failed to open the file at path={}, ec_message={}",
PathToUTF8String(file_path), ec.message()); PathToUTF8String(file_path), ec.message());
} }
} }
void IOFile::Close() { void IOFile::Close() {
#if defined(__APPLE__) if (!IsOpen()) {
// NO IMPLEMENTATION YET return;
#else
PlatformUnmap(*this);
#endif
if (file) {
errno = 0;
const auto close_result = std::fclose(file) == 0;
if (!close_result) {
const auto ec = std::error_code{errno, std::generic_category()};
LOG_ERROR(Common_Filesystem, "Failed to close the file at path={}, ec_message={}",
PathToUTF8String(file_path), ec.message());
}
file = nullptr;
} }
errno = 0;
const auto close_result = std::fclose(file) == 0;
if (!close_result) {
const auto ec = std::error_code{errno, std::generic_category()};
LOG_ERROR(Common_Filesystem, "Failed to close the file at path={}, ec_message={}",
PathToUTF8String(file_path), ec.message());
}
file = nullptr;
} }
bool IOFile::IsOpen() const { bool IOFile::IsOpen() const {
return file != nullptr || IsMappedFile(); return file != nullptr;
} }
std::string IOFile::ReadString(size_t length) const { std::string IOFile::ReadString(size_t length) const {
@@ -450,132 +323,137 @@ size_t IOFile::WriteString(std::span<const char> string) const {
} }
bool IOFile::Flush() const { bool IOFile::Flush() const {
ASSERT(!IsMappedFile()); if (!IsOpen()) {
if (file) { return false;
errno = 0;
auto const flush_result = std::fflush(file) == 0;
if (!flush_result) {
const auto ec = std::error_code{errno, std::generic_category()};
LOG_ERROR(Common_Filesystem, "Failed to flush the file at path={}, ec_message={}",
PathToUTF8String(file_path), ec.message());
}
return flush_result;
} }
return false;
errno = 0;
#ifdef _WIN32
const auto flush_result = std::fflush(file) == 0;
#else
const auto flush_result = std::fflush(file) == 0;
#endif
if (!flush_result) {
const auto ec = std::error_code{errno, std::generic_category()};
LOG_ERROR(Common_Filesystem, "Failed to flush the file at path={}, ec_message={}",
PathToUTF8String(file_path), ec.message());
}
return flush_result;
} }
bool IOFile::Commit() const { bool IOFile::Commit() const {
ASSERT(!IsMappedFile()); if (!IsOpen()) {
if (file) { return false;
errno = 0;
#ifdef _WIN32
const auto commit_result = std::fflush(file) == 0 && _commit(fileno(file)) == 0;
#else
const auto commit_result = std::fflush(file) == 0 && fsync(fileno(file)) == 0;
#endif
if (!commit_result) {
const auto ec = std::error_code{errno, std::generic_category()};
LOG_ERROR(Common_Filesystem, "Failed to commit the file at path={}, ec_message={}",
PathToUTF8String(file_path), ec.message());
}
return commit_result;
} }
return false;
errno = 0;
#ifdef _WIN32
const auto commit_result = std::fflush(file) == 0 && _commit(fileno(file)) == 0;
#else
const auto commit_result = std::fflush(file) == 0 && fsync(fileno(file)) == 0;
#endif
if (!commit_result) {
const auto ec = std::error_code{errno, std::generic_category()};
LOG_ERROR(Common_Filesystem, "Failed to commit the file at path={}, ec_message={}",
PathToUTF8String(file_path), ec.message());
}
return commit_result;
} }
bool IOFile::SetSize(u64 size) const { bool IOFile::SetSize(u64 size) const {
ASSERT(!IsMappedFile()); if (!IsOpen()) {
if (file) { return false;
errno = 0;
#ifdef _WIN32
const auto set_size_result = _chsize_s(fileno(file), s64(size)) == 0;
#else
const auto set_size_result = ftruncate(fileno(file), s64(size)) == 0;
#endif
if (!set_size_result) {
const auto ec = std::error_code{errno, std::generic_category()};
LOG_ERROR(Common_Filesystem, "Failed to resize the file at path={}, size={}, ec_message={}",
PathToUTF8String(file_path), size, ec.message());
}
return set_size_result;
} }
return false;
errno = 0;
#ifdef _WIN32
const auto set_size_result = _chsize_s(fileno(file), static_cast<s64>(size)) == 0;
#else
const auto set_size_result = ftruncate(fileno(file), static_cast<s64>(size)) == 0;
#endif
if (!set_size_result) {
const auto ec = std::error_code{errno, std::generic_category()};
LOG_ERROR(Common_Filesystem, "Failed to resize the file at path={}, size={}, ec_message={}",
PathToUTF8String(file_path), size, ec.message());
}
return set_size_result;
} }
u64 IOFile::GetSize() const { u64 IOFile::GetSize() const {
if (IsMappedFile()) if (!IsOpen()) {
return mmap_size; return 0;
if (file) { }
// Flush any unwritten buffered data into the file prior to retrieving the file mmap_size.
std::fflush(file);
#if __ANDROID__
u64 file_size = 0;
if (Android::IsContentUri(file_path)) {
file_size = Android::GetSize(file_path);
} else {
std::error_code ec;
file_size = fs::file_size(file_path, ec); // Flush any unwritten buffered data into the file prior to retrieving the file size.
std::fflush(file);
if (ec) { #ifdef __ANDROID__
LOG_ERROR(Common_Filesystem, "Failed to retrieve the file mmap_size of path={}, ec_message={}", u64 file_size = 0;
PathToUTF8String(file_path), ec.message()); if (Android::IsContentUri(file_path)) {
return 0; file_size = Android::GetSize(file_path);
} } else {
}
#else
std::error_code ec; std::error_code ec;
auto const file_size = fs::file_size(file_path, ec);
file_size = fs::file_size(file_path, ec);
if (ec) { if (ec) {
LOG_ERROR(Common_Filesystem, "Failed to retrieve the file mmap_size of path={}, ec_message={}", LOG_ERROR(Common_Filesystem,
PathToUTF8String(file_path), ec.message()); "Failed to retrieve the file size of path={}, ec_message={}",
PathToUTF8String(file_path), ec.message());
return 0; return 0;
} }
#endif
return file_size;
} }
return 0; #else
std::error_code ec;
const auto file_size = fs::file_size(file_path, ec);
if (ec) {
LOG_ERROR(Common_Filesystem, "Failed to retrieve the file size of path={}, ec_message={}",
PathToUTF8String(file_path), ec.message());
return 0;
}
#endif
return file_size;
} }
bool IOFile::Seek(s64 offset, SeekOrigin origin) const { bool IOFile::Seek(s64 offset, SeekOrigin origin) const {
if (IsMappedFile()) { if (!IsOpen()) {
// fuck you to whoever made this method const return false;
switch (origin) {
case SeekOrigin::SetOrigin:
mmap_offset = s64(offset);
break;
case SeekOrigin::CurrentPosition:
mmap_offset += s64(offset);
break;
case SeekOrigin::End:
mmap_offset = s64(mmap_size) + s64(offset);
break;
}
return true;
} }
if (file) {
errno = 0; errno = 0;
const auto seek_result = fseeko(file, offset, ToSeekOrigin(origin)) == 0;
if (!seek_result) { const auto seek_result = fseeko(file, offset, ToSeekOrigin(origin)) == 0;
const auto ec = std::error_code{errno, std::generic_category()};
LOG_ERROR(Common_Filesystem, "Failed to seek the file at path={}, offset={}, origin={}, ec_message={}", if (!seek_result) {
PathToUTF8String(file_path), offset, origin, ec.message()); const auto ec = std::error_code{errno, std::generic_category()};
} LOG_ERROR(Common_Filesystem,
return seek_result; "Failed to seek the file at path={}, offset={}, origin={}, ec_message={}",
PathToUTF8String(file_path), offset, origin, ec.message());
} }
return false;
return seek_result;
} }
s64 IOFile::Tell() const { s64 IOFile::Tell() const {
if (IsMappedFile()) { if (!IsOpen()) {
errno = 0; return 0;
return s64(mmap_offset);
} }
if (file) {
errno = 0; errno = 0;
return ftello(file);
} return ftello(file);
return 0;
} }
} // namespace Common::FS } // namespace Common::FS
+247 -255
View File
@@ -7,7 +7,6 @@
#pragma once #pragma once
#include <cstdio> #include <cstdio>
#include <cstring>
#include <filesystem> #include <filesystem>
#include <span> #include <span>
#include <type_traits> #include <type_traits>
@@ -25,12 +24,12 @@ enum class SeekOrigin {
}; };
/** /**
* Opens a file stream at path with the specified open mode. * Opens a file stream at path with the specified open mode.
* *
* @param file_stream Reference to file stream * @param file_stream Reference to file stream
* @param path Filesystem path * @param path Filesystem path
* @param open_mode File stream open mode * @param open_mode File stream open mode
*/ */
template <typename FileStream> template <typename FileStream>
void OpenFileStream(FileStream& file_stream, const std::filesystem::path& path, void OpenFileStream(FileStream& file_stream, const std::filesystem::path& path,
std::ios_base::openmode open_mode) { std::ios_base::openmode open_mode) {
@@ -49,14 +48,14 @@ void OpenFileStream(FileStream& file_stream, const Path& path, std::ios_base::op
#endif #endif
/** /**
* Reads an entire file at path and returns a string of the contents read from the file. * Reads an entire file at path and returns a string of the contents read from the file.
* If the filesystem object at path is not a regular file, this function returns an empty string. * If the filesystem object at path is not a regular file, this function returns an empty string.
* *
* @param path Filesystem path * @param path Filesystem path
* @param type File type * @param type File type
* *
* @returns A string of the contents read from the file. * @returns A string of the contents read from the file.
*/ */
[[nodiscard]] std::string ReadStringFromFile(const std::filesystem::path& path, FileType type); [[nodiscard]] std::string ReadStringFromFile(const std::filesystem::path& path, FileType type);
#ifdef _WIN32 #ifdef _WIN32
@@ -71,18 +70,18 @@ template <typename Path>
#endif #endif
/** /**
* Writes a string to a file at path and returns the number of characters successfully written. * Writes a string to a file at path and returns the number of characters successfully written.
* If a file already exists at path, its contents will be erased. * If a file already exists at path, its contents will be erased.
* If a file does not exist at path, it creates and opens a new empty file for writing. * If a file does not exist at path, it creates and opens a new empty file for writing.
* If the filesystem object at path exists and is not a regular file, this function returns 0. * If the filesystem object at path exists and is not a regular file, this function returns 0.
* *
* @param path Filesystem path * @param path Filesystem path
* @param type File type * @param type File type
* *
* @returns Number of characters successfully written. * @returns Number of characters successfully written.
*/ */
[[nodiscard]] size_t WriteStringToFile(const std::filesystem::path& path, FileType type, [[nodiscard]] size_t WriteStringToFile(const std::filesystem::path& path, FileType type,
std::string_view string); std::string_view string);
#ifdef _WIN32 #ifdef _WIN32
template <typename Path> template <typename Path>
@@ -96,15 +95,15 @@ template <typename Path>
#endif #endif
/** /**
* Appends a string to a file at path and returns the number of characters successfully written. * Appends a string to a file at path and returns the number of characters successfully written.
* If a file does not exist at path, it creates and opens a new empty file for appending. * If a file does not exist at path, it creates and opens a new empty file for appending.
* If the filesystem object at path exists and is not a regular file, this function returns 0. * If the filesystem object at path exists and is not a regular file, this function returns 0.
* *
* @param path Filesystem path * @param path Filesystem path
* @param type File type * @param type File type
* *
* @returns Number of characters successfully written. * @returns Number of characters successfully written.
*/ */
[[nodiscard]] size_t AppendStringToFile(const std::filesystem::path& path, FileType type, [[nodiscard]] size_t AppendStringToFile(const std::filesystem::path& path, FileType type,
std::string_view string); std::string_view string);
@@ -132,14 +131,14 @@ public:
FileShareFlag flag = FileShareFlag::ShareReadOnly); FileShareFlag flag = FileShareFlag::ShareReadOnly);
/** /**
* An IOFile is a lightweight wrapper on C Library file operations. * An IOFile is a lightweight wrapper on C Library file operations.
* Automatically closes an open file on the destruction of an IOFile object. * Automatically closes an open file on the destruction of an IOFile object.
* *
* @param path Filesystem path * @param path Filesystem path
* @param mode File access mode * @param mode File access mode
* @param type File type, default is BinaryFile. Use TextFile to open the file as a text file * @param type File type, default is BinaryFile. Use TextFile to open the file as a text file
* @param flag (Windows only) File-share access flag, default is ShareReadOnly * @param flag (Windows only) File-share access flag, default is ShareReadOnly
*/ */
explicit IOFile(const std::filesystem::path& path, FileAccessMode mode, explicit IOFile(const std::filesystem::path& path, FileAccessMode mode,
FileType type = FileType::BinaryFile, FileType type = FileType::BinaryFile,
FileShareFlag flag = FileShareFlag::ShareReadOnly); FileShareFlag flag = FileShareFlag::ShareReadOnly);
@@ -153,70 +152,84 @@ public:
IOFile& operator=(IOFile&& other) noexcept; IOFile& operator=(IOFile&& other) noexcept;
/** /**
* Gets the path of the file. * Gets the path of the file.
* *
* @returns The path of the file. * @returns The path of the file.
*/ */
[[nodiscard]] std::filesystem::path GetPath() const; [[nodiscard]] std::filesystem::path GetPath() const;
/** /**
* Gets the access mode of the file. * Gets the access mode of the file.
* *
* @returns The access mode of the file. * @returns The access mode of the file.
*/ */
[[nodiscard]] FileAccessMode GetAccessMode() const; [[nodiscard]] FileAccessMode GetAccessMode() const;
/** /**
* Gets the type of the file. * Gets the type of the file.
* *
* @returns The type of the file. * @returns The type of the file.
*/ */
[[nodiscard]] FileType GetType() const; [[nodiscard]] FileType GetType() const;
/** /**
* Opens a file at path with the specified file access mode. * Opens a file at path with the specified file access mode.
* This function behaves differently depending on the FileAccessMode. * This function behaves differently depending on the FileAccessMode.
* These behaviors are documented in each enum value of FileAccessMode. * These behaviors are documented in each enum value of FileAccessMode.
* *
* @param path Filesystem path * @param path Filesystem path
* @param mode File access mode * @param mode File access mode
* @param type File type, default is BinaryFile. Use TextFile to open the file as a text file * @param type File type, default is BinaryFile. Use TextFile to open the file as a text file
* @param flag (Windows only) File-share access flag, default is ShareReadOnly * @param flag (Windows only) File-share access flag, default is ShareReadOnly
*/ */
void Open(const std::filesystem::path& path, FileAccessMode mode, void Open(const std::filesystem::path& path, FileAccessMode mode,
FileType type = FileType::BinaryFile, FileType type = FileType::BinaryFile,
FileShareFlag flag = FileShareFlag::ShareReadOnly); FileShareFlag flag = FileShareFlag::ShareReadOnly);
// #ifdef _WIN32
// template <typename Path>
// void Open(const Path& path, FileAccessMode mode, FileType type = FileType::BinaryFile,
// FileShareFlag flag = FileShareFlag::ShareReadOnly) {
// using ValueType = typename Path::value_type;
// if constexpr (IsChar<ValueType>) {
// Open(ToU8String(path), mode, type, flag);
// } else {
// Open(std::filesystem::path{path}, mode, type, flag);
// }
// }
// #endif
/// Closes the file if it is opened. /// Closes the file if it is opened.
void Close(); void Close();
/** /**
* Checks whether the file is open. * Checks whether the file is open.
* Use this to check whether the calls to Open() or Close() succeeded. * Use this to check whether the calls to Open() or Close() succeeded.
* *
* @returns True if the file is open, false otherwise. * @returns True if the file is open, false otherwise.
*/ */
[[nodiscard]] bool IsOpen() const; [[nodiscard]] bool IsOpen() const;
/** /**
* Helper function which deduces the value type of a contiguous STL container used in ReadSpan. * Helper function which deduces the value type of a contiguous STL container used in ReadSpan.
* If T is not a contiguous container as defined by the concept IsContiguousContainer, this * If T is not a contiguous container as defined by the concept IsContiguousContainer, this
* calls ReadObject and T must be a trivially copyable object. * calls ReadObject and T must be a trivially copyable object.
* *
* See ReadSpan for more details if T is a contiguous container. * See ReadSpan for more details if T is a contiguous container.
* See ReadObject for more details if T is a trivially copyable object. * See ReadObject for more details if T is a trivially copyable object.
* *
* @tparam T Contiguous container or trivially copyable object * @tparam T Contiguous container or trivially copyable object
* *
* @param data Container of T::value_type data or reference to object * @param data Container of T::value_type data or reference to object
* *
* @returns Count of T::value_type data or objects successfully read. * @returns Count of T::value_type data or objects successfully read.
*/ */
template <typename T> template <typename T>
[[nodiscard]] size_t Read(T& data) const { [[nodiscard]] size_t Read(T& data) const {
if constexpr (IsContiguousContainer<T>) { if constexpr (IsContiguousContainer<T>) {
using ContiguousType = typename T::value_type; using ContiguousType = typename T::value_type;
static_assert(std::is_trivially_copyable_v<ContiguousType>, "Data type must be trivially copyable."); static_assert(std::is_trivially_copyable_v<ContiguousType>,
"Data type must be trivially copyable.");
return ReadSpan<ContiguousType>(data); return ReadSpan<ContiguousType>(data);
} else { } else {
return ReadObject(data) ? 1 : 0; return ReadObject(data) ? 1 : 0;
@@ -224,24 +237,25 @@ public:
} }
/** /**
* Helper function which deduces the value type of a contiguous STL container used in WriteSpan. * Helper function which deduces the value type of a contiguous STL container used in WriteSpan.
* If T is not a contiguous STL container as defined by the concept IsContiguousContainer, this * If T is not a contiguous STL container as defined by the concept IsContiguousContainer, this
* calls WriteObject and T must be a trivially copyable object. * calls WriteObject and T must be a trivially copyable object.
* *
* See WriteSpan for more details if T is a contiguous container. * See WriteSpan for more details if T is a contiguous container.
* See WriteObject for more details if T is a trivially copyable object. * See WriteObject for more details if T is a trivially copyable object.
* *
* @tparam T Contiguous container or trivially copyable object * @tparam T Contiguous container or trivially copyable object
* *
* @param data Container of T::value_type data or const reference to object * @param data Container of T::value_type data or const reference to object
* *
* @returns Count of T::value_type data or objects successfully written. * @returns Count of T::value_type data or objects successfully written.
*/ */
template <typename T> template <typename T>
[[nodiscard]] size_t Write(const T& data) const { [[nodiscard]] size_t Write(const T& data) const {
if constexpr (IsContiguousContainer<T>) { if constexpr (IsContiguousContainer<T>) {
using ContiguousType = typename T::value_type; using ContiguousType = typename T::value_type;
static_assert(std::is_trivially_copyable_v<ContiguousType>, "Data type must be trivially copyable."); static_assert(std::is_trivially_copyable_v<ContiguousType>,
"Data type must be trivially copyable.");
return WriteSpan<ContiguousType>(data); return WriteSpan<ContiguousType>(data);
} else { } else {
static_assert(std::is_trivially_copyable_v<T>, "Data type must be trivially copyable."); static_assert(std::is_trivially_copyable_v<T>, "Data type must be trivially copyable.");
@@ -250,219 +264,197 @@ public:
} }
/** /**
* Reads a span of T data from a file sequentially. * Reads a span of T data from a file sequentially.
* This function reads from the current position of the file pointer and * This function reads from the current position of the file pointer and
* advances it by the (count of T * sizeof(T)) bytes successfully read. * advances it by the (count of T * sizeof(T)) bytes successfully read.
* *
* Failures occur when: * Failures occur when:
* - The file is not open * - The file is not open
* - The opened file lacks read permissions * - The opened file lacks read permissions
* - Attempting to read beyond the end-of-file * - Attempting to read beyond the end-of-file
* *
* @tparam T Data type * @tparam T Data type
* *
* @param data Span of T data * @param data Span of T data
* *
* @returns Count of T data successfully read. * @returns Count of T data successfully read.
*/ */
template <typename T> template <typename T>
requires std::is_trivially_copyable_v<T> requires std::is_trivially_copyable_v<T>
[[nodiscard]] size_t ReadSpan(std::span<T> data) const { [[nodiscard]] size_t ReadSpan(std::span<T> data) const {
if (IsMappedFile()) { if (!IsOpen()) {
std::memcpy(data.data(), mmap_base + mmap_offset, sizeof(T) * data.size()); return 0;
return data.size();
} }
return IsOpen() ? std::fread(data.data(), sizeof(T), data.size(), file) : 0; return std::fread(data.data(), sizeof(T), data.size(), file);
} }
/** /**
* Writes a span of T data to a file sequentially. * Writes a span of T data to a file sequentially.
* This function writes from the current position of the file pointer and * This function writes from the current position of the file pointer and
* advances it by the (count of T * sizeof(T)) bytes successfully written. * advances it by the (count of T * sizeof(T)) bytes successfully written.
* *
* Failures occur when: * Failures occur when:
* - The file is not open * - The file is not open
* - The opened file lacks write permissions * - The opened file lacks write permissions
* *
* @tparam T Data type * @tparam T Data type
* *
* @param data Span of T data * @param data Span of T data
* *
* @returns Count of T data successfully written. * @returns Count of T data successfully written.
*/ */
template <typename T> template <typename T>
[[nodiscard]] size_t WriteSpan(std::span<const T> data) const { [[nodiscard]] size_t WriteSpan(std::span<const T> data) const {
static_assert(std::is_trivially_copyable_v<T>, "Data type must be trivially copyable."); static_assert(std::is_trivially_copyable_v<T>, "Data type must be trivially copyable.");
if (IsMappedFile()) {
std::memcpy(mmap_base + mmap_offset, data.data(), sizeof(T) * data.size()); if (!IsOpen()) {
return data.size(); return 0;
} }
return IsOpen() ? std::fwrite(data.data(), sizeof(T), data.size(), file) : 0;
return std::fwrite(data.data(), sizeof(T), data.size(), file);
} }
/** /**
* Reads a T object from a file sequentially. * Reads a T object from a file sequentially.
* This function reads from the current position of the file pointer and * This function reads from the current position of the file pointer and
* advances it by the sizeof(T) bytes successfully read. * advances it by the sizeof(T) bytes successfully read.
* *
* Failures occur when: * Failures occur when:
* - The file is not open * - The file is not open
* - The opened file lacks read permissions * - The opened file lacks read permissions
* - Attempting to read beyond the end-of-file * - Attempting to read beyond the end-of-file
* *
* @tparam T Data type * @tparam T Data type
* *
* @param object Reference to object * @param object Reference to object
* *
* @returns True if the object is successfully read from the file, false otherwise. * @returns True if the object is successfully read from the file, false otherwise.
*/ */
template <typename T> template <typename T>
[[nodiscard]] bool ReadObject(T& object) const { [[nodiscard]] bool ReadObject(T& object) const {
static_assert(std::is_trivially_copyable_v<T>, "Data type must be trivially copyable."); static_assert(std::is_trivially_copyable_v<T>, "Data type must be trivially copyable.");
static_assert(!std::is_pointer_v<T>, "T must not be a pointer to an object."); static_assert(!std::is_pointer_v<T>, "T must not be a pointer to an object.");
if (IsMappedFile()) {
std::memcpy(&object, mmap_base + mmap_offset, sizeof(T)); if (!IsOpen()) {
#ifdef _WIN32 return false;
return bool(sizeof(T));
#else
return sizeof(T);
#endif
} }
return IsOpen() ? std::fread(&object, sizeof(T), 1, file) == 1 : false;
return std::fread(&object, sizeof(T), 1, file) == 1;
} }
/** /**
* Writes a T object to a file sequentially. * Writes a T object to a file sequentially.
* This function writes from the current position of the file pointer and * This function writes from the current position of the file pointer and
* advances it by the sizeof(T) bytes successfully written. * advances it by the sizeof(T) bytes successfully written.
* *
* Failures occur when: * Failures occur when:
* - The file is not open * - The file is not open
* - The opened file lacks write permissions * - The opened file lacks write permissions
* *
* @tparam T Data type * @tparam T Data type
* *
* @param object Const reference to object * @param object Const reference to object
* *
* @returns True if the object is successfully written to the file, false otherwise. * @returns True if the object is successfully written to the file, false otherwise.
*/ */
template <typename T> template <typename T>
[[nodiscard]] bool WriteObject(const T& object) const { [[nodiscard]] bool WriteObject(const T& object) const {
static_assert(std::is_trivially_copyable_v<T>, "Data type must be trivially copyable."); static_assert(std::is_trivially_copyable_v<T>, "Data type must be trivially copyable.");
static_assert(!std::is_pointer_v<T>, "T must not be a pointer to an object."); static_assert(!std::is_pointer_v<T>, "T must not be a pointer to an object.");
if (IsMappedFile()) {
std::memcpy(mmap_base + mmap_offset, &object, sizeof(T)); if (!IsOpen()) {
#ifdef _WIN32 return false;
return sizeof(T) != 0;
#else
return sizeof(T);
#endif
} }
return IsOpen() ? std::fwrite(&object, sizeof(T), 1, file) == 1 : false;
return std::fwrite(&object, sizeof(T), 1, file) == 1;
} }
/** /**
* Specialized function to read a string of a given length from a file sequentially. * Specialized function to read a string of a given length from a file sequentially.
* This function writes from the current position of the file pointer and * This function writes from the current position of the file pointer and
* advances it by the number of characters successfully read. * advances it by the number of characters successfully read.
* The size of the returned string may not match length if not all bytes are successfully read. * The size of the returned string may not match length if not all bytes are successfully read.
* *
* @param length Length of the string * @param length Length of the string
* *
* @returns A string read from the file. * @returns A string read from the file.
*/ */
[[nodiscard]] std::string ReadString(size_t length) const; [[nodiscard]] std::string ReadString(size_t length) const;
/** /**
* Specialized function to write a string to a file sequentially. * Specialized function to write a string to a file sequentially.
* This function writes from the current position of the file pointer and * This function writes from the current position of the file pointer and
* advances it by the number of characters successfully written. * advances it by the number of characters successfully written.
* *
* @param string Span of const char backed std::string or std::string_view * @param string Span of const char backed std::string or std::string_view
* *
* @returns Number of characters successfully written. * @returns Number of characters successfully written.
*/ */
[[nodiscard]] size_t WriteString(std::span<const char> string) const; [[nodiscard]] size_t WriteString(std::span<const char> string) const;
/** /**
* Attempts to flush any unwritten buffered data into the file. * Attempts to flush any unwritten buffered data into the file.
* *
* @returns True if the flush was successful, false otherwise. * @returns True if the flush was successful, false otherwise.
*/ */
bool Flush() const; bool Flush() const;
/** /**
* Attempts to commit the file into the disk. * Attempts to commit the file into the disk.
* Note that this is an expensive operation as this forces the operating system to write * Note that this is an expensive operation as this forces the operating system to write
* the contents of the file associated with the file descriptor into the disk. * the contents of the file associated with the file descriptor into the disk.
* *
* @returns True if the commit was successful, false otherwise. * @returns True if the commit was successful, false otherwise.
*/ */
bool Commit() const; bool Commit() const;
/** /**
* Resizes the file to a given size. * Resizes the file to a given size.
* If the file is resized to a smaller size, the remainder of the file is discarded. * If the file is resized to a smaller size, the remainder of the file is discarded.
* If the file is resized to a larger size, the new area appears as if zero-filled. * If the file is resized to a larger size, the new area appears as if zero-filled.
* *
* Failures occur when: * Failures occur when:
* - The file is not open * - The file is not open
* *
* @param size File size in bytes * @param size File size in bytes
* *
* @returns True if the file resize succeeded, false otherwise. * @returns True if the file resize succeeded, false otherwise.
*/ */
[[nodiscard]] bool SetSize(u64 size) const; [[nodiscard]] bool SetSize(u64 size) const;
/** /**
* Gets the size of the file. * Gets the size of the file.
* *
* Failures occur when: * Failures occur when:
* - The file is not open * - The file is not open
* *
* @returns The file size in bytes of the file. Returns 0 on failure. * @returns The file size in bytes of the file. Returns 0 on failure.
*/ */
[[nodiscard]] u64 GetSize() const; [[nodiscard]] u64 GetSize() const;
/** /**
* Moves the current position of the file pointer with the specified offset and seek origin. * Moves the current position of the file pointer with the specified offset and seek origin.
* *
* @param offset Offset from seek origin * @param offset Offset from seek origin
* @param origin Seek origin * @param origin Seek origin
* *
* @returns True if the file pointer has moved to the specified offset, false otherwise. * @returns True if the file pointer has moved to the specified offset, false otherwise.
*/ */
[[nodiscard]] bool Seek(s64 offset, SeekOrigin origin = SeekOrigin::SetOrigin) const; [[nodiscard]] bool Seek(s64 offset, SeekOrigin origin = SeekOrigin::SetOrigin) const;
/** /**
* Gets the current position of the file pointer. * Gets the current position of the file pointer.
* *
* @returns The current position of the file pointer. * @returns The current position of the file pointer.
*/ */
[[nodiscard]] s64 Tell() const; [[nodiscard]] s64 Tell() const;
#ifdef _WIN32 private:
inline bool IsMappedFile() const noexcept { return mapping_handle != nullptr; }
#else // POSIX
inline bool IsMappedFile() const noexcept { return mmap_fd != -1; }
#endif
std::filesystem::path file_path; std::filesystem::path file_path;
FileAccessMode file_access_mode{}; FileAccessMode file_access_mode{};
FileType file_type{}; FileType file_type{};
std::FILE* file = nullptr; std::FILE* file = nullptr;
// Any decent system should have mmap() for files
// Systems with artifical mmap() limitations should simply change the logic within file.cpp
// and reduce the threshold for which the mmap() is set to
#ifdef _WIN32
void *mapping_handle = nullptr;
void *file_handle = nullptr;
#else // POSIX
int mmap_fd = -1;
#endif
u8* mmap_base = nullptr;
size_t mmap_size = 0;
mutable s64 mmap_offset = 0; // fuck you
}; };
} // namespace Common::FS } // namespace Common::FS
@@ -148,11 +148,11 @@ BufferCacheRuntime::BufferCacheRuntime(const Device& device_,
} }
StagingBufferMap BufferCacheRuntime::UploadStagingBuffer(size_t size) { StagingBufferMap BufferCacheRuntime::UploadStagingBuffer(size_t size) {
return staging_buffer_pool.RequestUploadBuffer(size); return staging_buffer_pool.RequestUploadBuffer(device, size);
} }
StagingBufferMap BufferCacheRuntime::DownloadStagingBuffer(size_t size, bool deferred) { StagingBufferMap BufferCacheRuntime::DownloadStagingBuffer(size_t size, bool deferred) {
return staging_buffer_pool.RequestDownloadBuffer(size, deferred); return staging_buffer_pool.RequestDownloadBuffer(device, size, deferred);
} }
void BufferCacheRuntime::FreeDeferredStagingBuffer(StagingBufferMap& buffer) { void BufferCacheRuntime::FreeDeferredStagingBuffer(StagingBufferMap& buffer) {
@@ -557,11 +557,11 @@ void TextureCacheRuntime::Finish() {
} }
StagingBufferMap TextureCacheRuntime::UploadStagingBuffer(size_t size, bool deferred) { StagingBufferMap TextureCacheRuntime::UploadStagingBuffer(size_t size, bool deferred) {
return staging_buffer_pool.RequestUploadBuffer(size); return staging_buffer_pool.RequestUploadBuffer(device, size);
} }
StagingBufferMap TextureCacheRuntime::DownloadStagingBuffer(size_t size, bool deferred) { StagingBufferMap TextureCacheRuntime::DownloadStagingBuffer(size_t size, bool deferred) {
return staging_buffer_pool.RequestDownloadBuffer(size, deferred); return staging_buffer_pool.RequestDownloadBuffer(device, size, deferred);
} }
void TextureCacheRuntime::FreeDeferredStagingBuffer(StagingBufferMap& buffer) { void TextureCacheRuntime::FreeDeferredStagingBuffer(StagingBufferMap& buffer) {
@@ -192,7 +192,7 @@ public:
if (host_visible) { if (host_visible) {
return StagingBufferRef{}; return StagingBufferRef{};
} }
return staging_pool.Request(size_bytes, MemoryUsage::Upload); return staging_pool.Request(device, size_bytes, MemoryUsage::Upload);
}(); }();
u8* staging_data = host_visible ? buffer.Mapped().data() : staging.mapped_span.data(); u8* staging_data = host_visible ? buffer.Mapped().data() : staging.mapped_span.data();
@@ -366,11 +366,11 @@ BufferCacheRuntime::BufferCacheRuntime(const Device& device_, MemoryAllocator& m
} }
StagingBufferRef BufferCacheRuntime::UploadStagingBuffer(size_t size) { StagingBufferRef BufferCacheRuntime::UploadStagingBuffer(size_t size) {
return staging_pool.Request(size, MemoryUsage::Upload); return staging_pool.Request(device, size, MemoryUsage::Upload);
} }
StagingBufferRef BufferCacheRuntime::DownloadStagingBuffer(size_t size, bool deferred) { StagingBufferRef BufferCacheRuntime::DownloadStagingBuffer(size_t size, bool deferred) {
return staging_pool.Request(size, MemoryUsage::Download, deferred); return staging_pool.Request(device, size, MemoryUsage::Download, deferred);
} }
VkFormat BufferCacheRuntime::TexelBufferFormat(VideoCore::Surface::PixelFormat format) const { VkFormat BufferCacheRuntime::TexelBufferFormat(VideoCore::Surface::PixelFormat format) const {
@@ -149,7 +149,7 @@ public:
std::span<u8> BindMappedUniformBuffer([[maybe_unused]] size_t stage, std::span<u8> BindMappedUniformBuffer([[maybe_unused]] size_t stage,
[[maybe_unused]] u32 binding_index, [[maybe_unused]] u32 binding_index,
u32 size) { u32 size) {
const StagingBufferRef ref = staging_pool.Request(size, MemoryUsage::Upload); const StagingBufferRef ref = staging_pool.Request(device, size, MemoryUsage::Upload);
guest_descriptor_queue.AddBuffer(ref.buffer, ref.device_address, guest_descriptor_queue.AddBuffer(ref.buffer, ref.device_address,
static_cast<u32>(ref.offset), size); static_cast<u32>(ref.offset), size);
return ref.mapped_span; return ref.mapped_span;
@@ -287,7 +287,7 @@ Uint8Pass::~Uint8Pass() = default;
std::pair<VkBuffer, VkDeviceSize> Uint8Pass::Assemble(u32 num_vertices, VkBuffer src_buffer, std::pair<VkBuffer, VkDeviceSize> Uint8Pass::Assemble(u32 num_vertices, VkBuffer src_buffer,
u32 src_offset) { u32 src_offset) {
const u32 staging_size = static_cast<u32>(num_vertices * sizeof(u16)); const u32 staging_size = static_cast<u32>(num_vertices * sizeof(u16));
const auto staging = staging_buffer_pool.Request(staging_size, MemoryUsage::DeviceLocal); const auto staging = staging_buffer_pool.Request(device, staging_size, MemoryUsage::DeviceLocal);
compute_pass_descriptor_queue.Acquire(scheduler, 2); compute_pass_descriptor_queue.Acquire(scheduler, 2);
compute_pass_descriptor_queue.AddBuffer(src_buffer, src_offset, num_vertices); compute_pass_descriptor_queue.AddBuffer(src_buffer, src_offset, num_vertices);
@@ -345,7 +345,7 @@ std::pair<VkBuffer, VkDeviceSize> QuadIndexedPass::Assemble(
const u32 num_tri_vertices = (is_strip ? (num_vertices - 2) / 2 : num_vertices / 4) * 6; const u32 num_tri_vertices = (is_strip ? (num_vertices - 2) / 2 : num_vertices / 4) * 6;
const std::size_t staging_size = num_tri_vertices * sizeof(u32); const std::size_t staging_size = num_tri_vertices * sizeof(u32);
const auto staging = staging_buffer_pool.Request(staging_size, MemoryUsage::DeviceLocal); const auto staging = staging_buffer_pool.Request(device, staging_size, MemoryUsage::DeviceLocal);
compute_pass_descriptor_queue.Acquire(scheduler, 2); compute_pass_descriptor_queue.Acquire(scheduler, 2);
compute_pass_descriptor_queue.AddBuffer(src_buffer, src_offset, input_size); compute_pass_descriptor_queue.AddBuffer(src_buffer, src_offset, input_size);
@@ -852,7 +852,7 @@ public:
void PushUnsyncedQueries() override { void PushUnsyncedQueries() override {
CloseCounter(); CloseCounter();
auto staging_ref = staging_pool.Request( auto staging_ref = staging_pool.Request(device,
pending_flush_queries.size() * TFBQueryBank::QUERY_SIZE, MemoryUsage::Download, true); pending_flush_queries.size() * TFBQueryBank::QUERY_SIZE, MemoryUsage::Download, true);
size_t offset_base = staging_ref.offset; size_t offset_base = staging_ref.offset;
for (auto q : pending_flush_queries) { for (auto q : pending_flush_queries) {
@@ -1657,7 +1657,7 @@ void QueryCacheRuntime::SyncValues(std::span<SyncValuesType> values, VkBuffer ba
impl->copies_setup.clear(); impl->copies_setup.clear();
impl->copies_setup.resize(impl->little_cache.size()); impl->copies_setup.resize(impl->little_cache.size());
if constexpr (SyncValuesType::GeneratesBaseBuffer) { if constexpr (SyncValuesType::GeneratesBaseBuffer) {
ref = impl->staging_pool.Request(total_size, MemoryUsage::Upload); ref = impl->staging_pool.Request(impl->device, total_size, MemoryUsage::Upload);
size_t current_offset = ref.offset; size_t current_offset = ref.offset;
size_t accumulated_size = 0; size_t accumulated_size = 0;
for (size_t i = 0; i < values.size(); i++) { for (size_t i = 0; i < values.size(); i++) {
@@ -25,29 +25,14 @@ namespace {
using namespace Common::Literals; using namespace Common::Literals;
// Maximum potential alignment of a Vulkan buffer size_t GetStreamBufferSize(const Device& device, size_t max_stream_buffer_size, size_t max_alignment) {
constexpr VkDeviceSize MAX_ALIGNMENT = 256;
// Stream buffer size in bytes
// *NIX drivers are more sensitive to increased buffers for streaming.
// Windows ones however, can intake bigger buffers and generally do not OOM.
// - GTX 960 on Windows will not OOM with 256mib
// - GT 1030 on ^NIX will OOM with 256mib
#if defined(__FreeBSD__)
constexpr VkDeviceSize MAX_STREAM_BUFFER_SIZE = 128_MiB;
#else
constexpr VkDeviceSize MAX_STREAM_BUFFER_SIZE = 256_MiB;
#endif
size_t GetStreamBufferSize(const Device& device) {
if (!device.HasDebuggingToolAttached()) { if (!device.HasDebuggingToolAttached()) {
return MAX_STREAM_BUFFER_SIZE; return max_stream_buffer_size;
} }
VkDeviceSize size{0}; VkDeviceSize size{0};
bool has_device_local_host_visible_heap{}; bool has_device_local_host_visible_heap{};
ForEachDeviceLocalHostVisibleHeap(device, [&size, &has_device_local_host_visible_heap]( ForEachDeviceLocalHostVisibleHeap(device, [&size, &has_device_local_host_visible_heap](size_t index, VkMemoryHeap& heap) {
size_t index, VkMemoryHeap& heap) {
has_device_local_host_visible_heap = true; has_device_local_host_visible_heap = true;
size = (std::max)(size, heap.size); size = (std::max)(size, heap.size);
}); });
@@ -55,28 +40,27 @@ size_t GetStreamBufferSize(const Device& device) {
// If rebar is not supported, cut the max heap size to 40%. This will allow 2 captures to be // If rebar is not supported, cut the max heap size to 40%. This will allow 2 captures to be
// loaded at the same time in RenderDoc. If rebar is supported, this shouldn't be an issue // loaded at the same time in RenderDoc. If rebar is supported, this shouldn't be an issue
// as the heap will be much larger. // as the heap will be much larger.
if (size <= MAX_STREAM_BUFFER_SIZE) { if (size <= max_stream_buffer_size) {
size = size * 40 / 100; size = size * 40 / 100;
} }
} else { } else {
size = MAX_STREAM_BUFFER_SIZE; size = max_stream_buffer_size;
} }
return (std::min)(Common::AlignUp(size, MAX_ALIGNMENT), MAX_STREAM_BUFFER_SIZE); return (std::min)(Common::AlignUp(size, max_alignment), max_stream_buffer_size);
} }
} // Anonymous namespace } // Anonymous namespace
StagingBufferPool::StagingBufferPool(const Device& device_, MemoryAllocator& memory_allocator_, StagingBufferPool::StagingBufferPool(const Device& device, MemoryAllocator& memory_allocator_, Scheduler& scheduler_)
Scheduler& scheduler_) : memory_allocator{memory_allocator_}, scheduler{scheduler_}
: device{device_}, memory_allocator{memory_allocator_}, scheduler{scheduler_}, , stream_buffer_size{GetStreamBufferSize(device, 256_MiB, 256)}
stream_buffer_size{GetStreamBufferSize(device)}, region_size{stream_buffer_size / {
StagingBufferPool::NUM_SYNCS} {
VkBufferCreateInfo stream_ci = { VkBufferCreateInfo stream_ci = {
.sType = VK_STRUCTURE_TYPE_BUFFER_CREATE_INFO, .sType = VK_STRUCTURE_TYPE_BUFFER_CREATE_INFO,
.pNext = nullptr, .pNext = nullptr,
.flags = 0, .flags = 0,
.size = stream_buffer_size, .size = stream_buffer_size,
.usage = VK_BUFFER_USAGE_TRANSFER_SRC_BIT | VK_BUFFER_USAGE_UNIFORM_BUFFER_BIT | .usage = VK_BUFFER_USAGE_TRANSFER_SRC_BIT | VK_BUFFER_USAGE_UNIFORM_BUFFER_BIT
VK_BUFFER_USAGE_INDEX_BUFFER_BIT | VK_BUFFER_USAGE_STORAGE_BUFFER_BIT, | VK_BUFFER_USAGE_INDEX_BUFFER_BIT | VK_BUFFER_USAGE_STORAGE_BUFFER_BIT,
.sharingMode = VK_SHARING_MODE_EXCLUSIVE, .sharingMode = VK_SHARING_MODE_EXCLUSIVE,
.queueFamilyIndexCount = 0, .queueFamilyIndexCount = 0,
.pQueueFamilyIndices = nullptr, .pQueueFamilyIndices = nullptr,
@@ -87,7 +71,20 @@ StagingBufferPool::StagingBufferPool(const Device& device_, MemoryAllocator& mem
if (device.IsBufferDeviceAddressSupported()) { if (device.IsBufferDeviceAddressSupported()) {
stream_ci.usage |= VK_BUFFER_USAGE_SHADER_DEVICE_ADDRESS_BIT; stream_ci.usage |= VK_BUFFER_USAGE_SHADER_DEVICE_ADDRESS_BIT;
} }
stream_buffer = memory_allocator.CreateBuffer(stream_ci, MemoryUsage::Stream); // *BSD drivers are more sensitive to increased buffers for streaming.
// Windows ones however, can intake bigger buffers and generally do not OOM.
// - GTX 960 on Windows will not OOM with 256mib
// - GT 1030 on ^BSD will OOM with 256mib
// This doesn't seem to be, however, universally true
try {
stream_buffer = memory_allocator.CreateBuffer(stream_ci, MemoryUsage::Stream);
} catch (vk::Exception& e) {
LOG_ERROR(Render_Vulkan, "Can't fit {} bytes buffer, halving", stream_ci.size);
stream_buffer_size = GetStreamBufferSize(device, 128_MiB, 256);
stream_ci.size = stream_buffer_size;
stream_buffer = memory_allocator.CreateBuffer(stream_ci, MemoryUsage::Stream);
}
region_size = stream_buffer_size / StagingBufferPool::NUM_SYNCS;
if (device.HasDebuggingToolAttached()) { if (device.HasDebuggingToolAttached()) {
stream_buffer.SetObjectNameEXT("Stream Buffer"); stream_buffer.SetObjectNameEXT("Stream Buffer");
} }
@@ -100,11 +97,10 @@ StagingBufferPool::StagingBufferPool(const Device& device_, MemoryAllocator& mem
StagingBufferPool::~StagingBufferPool() = default; StagingBufferPool::~StagingBufferPool() = default;
StagingBufferRef StagingBufferPool::Request(size_t size, MemoryUsage usage, bool deferred) { StagingBufferRef StagingBufferPool::Request(const Device& device, size_t size, MemoryUsage usage, bool deferred) {
if (!deferred && usage == MemoryUsage::Upload && size <= region_size) { return (!deferred && usage == MemoryUsage::Upload && size <= region_size)
return GetStreamBuffer(size); ? GetStreamBuffer(device, size)
} : GetStagingBuffer(device, size, usage, deferred);
return GetStagingBuffer(size, usage, deferred);
} }
void StagingBufferPool::FreeDeferred(StagingBufferRef& ref) { void StagingBufferPool::FreeDeferred(StagingBufferRef& ref) {
@@ -127,11 +123,10 @@ void StagingBufferPool::TickFrame() {
ReleaseCache(MemoryUsage::Download); ReleaseCache(MemoryUsage::Download);
} }
StagingBufferRef StagingBufferPool::GetStreamBuffer(size_t size) { StagingBufferRef StagingBufferPool::GetStreamBuffer(const Device& device, size_t size) {
if (AreRegionsActive(Region(free_iterator) + 1, if (AreRegionsActive(Region(free_iterator) + 1, (std::min)(Region(iterator + size) + 1, NUM_SYNCS))) {
(std::min)(Region(iterator + size) + 1, NUM_SYNCS))) {
// Avoid waiting for the previous usages to be free // Avoid waiting for the previous usages to be free
return GetStagingBuffer(size, MemoryUsage::Upload); return GetStagingBuffer(device, size, MemoryUsage::Upload);
} }
const u64 current_tick = scheduler.CurrentTick(); const u64 current_tick = scheduler.CurrentTick();
std::fill(sync_ticks.begin() + Region(used_iterator), sync_ticks.begin() + Region(iterator), std::fill(sync_ticks.begin() + Region(used_iterator), sync_ticks.begin() + Region(iterator),
@@ -140,15 +135,14 @@ StagingBufferRef StagingBufferPool::GetStreamBuffer(size_t size) {
free_iterator = (std::max)(free_iterator, iterator + size); free_iterator = (std::max)(free_iterator, iterator + size);
if (iterator + size >= stream_buffer_size) { if (iterator + size >= stream_buffer_size) {
std::fill(sync_ticks.begin() + Region(used_iterator), sync_ticks.begin() + NUM_SYNCS, std::fill(sync_ticks.begin() + Region(used_iterator), sync_ticks.begin() + NUM_SYNCS, current_tick);
current_tick);
used_iterator = 0; used_iterator = 0;
iterator = 0; iterator = 0;
free_iterator = size; free_iterator = size;
if (AreRegionsActive(0, Region(size) + 1)) { if (AreRegionsActive(0, Region(size) + 1)) {
// Avoid waiting for the previous usages to be free // Avoid waiting for the previous usages to be free
return GetStagingBuffer(size, MemoryUsage::Upload); return GetStagingBuffer(device, size, MemoryUsage::Upload);
} }
} }
const size_t offset = iterator; const size_t offset = iterator;
@@ -156,7 +150,7 @@ StagingBufferRef StagingBufferPool::GetStreamBuffer(size_t size) {
return StagingBufferRef{ return StagingBufferRef{
.buffer = *stream_buffer, .buffer = *stream_buffer,
.device_address = stream_buffer_address, .device_address = stream_buffer_address,
.offset = static_cast<VkDeviceSize>(offset), .offset = VkDeviceSize(offset),
.mapped_span = stream_pointer.subspan(offset, size), .mapped_span = stream_pointer.subspan(offset, size),
.usage{}, .usage{},
.log2_level{}, .log2_level{},
@@ -166,21 +160,18 @@ StagingBufferRef StagingBufferPool::GetStreamBuffer(size_t size) {
bool StagingBufferPool::AreRegionsActive(size_t region_begin, size_t region_end) const { bool StagingBufferPool::AreRegionsActive(size_t region_begin, size_t region_end) const {
const u64 gpu_tick = scheduler.GetMasterSemaphore().KnownGpuTick(); const u64 gpu_tick = scheduler.GetMasterSemaphore().KnownGpuTick();
return std::any_of(sync_ticks.begin() + region_begin, sync_ticks.begin() + region_end, return std::any_of(sync_ticks.begin() + region_begin, sync_ticks.begin() + region_end, [gpu_tick](u64 sync_tick) {
[gpu_tick](u64 sync_tick) { return gpu_tick < sync_tick; }); return gpu_tick < sync_tick;
});
}; };
StagingBufferRef StagingBufferPool::GetStagingBuffer(size_t size, MemoryUsage usage, StagingBufferRef StagingBufferPool::GetStagingBuffer(const Device& device, size_t size, MemoryUsage usage, bool deferred) {
bool deferred) { if (const std::optional<StagingBufferRef> ref = TryGetReservedBuffer(size, usage, deferred))
if (const std::optional<StagingBufferRef> ref = TryGetReservedBuffer(size, usage, deferred)) {
return *ref; return *ref;
} return CreateStagingBuffer(device, size, usage, deferred);
return CreateStagingBuffer(size, usage, deferred);
} }
std::optional<StagingBufferRef> StagingBufferPool::TryGetReservedBuffer(size_t size, std::optional<StagingBufferRef> StagingBufferPool::TryGetReservedBuffer(size_t size, MemoryUsage usage, bool deferred) {
MemoryUsage usage,
bool deferred) {
StagingBuffers& cache_level = GetCache(usage)[Common::Log2Ceil(size)]; StagingBuffers& cache_level = GetCache(usage)[Common::Log2Ceil(size)];
const auto is_free = [this](const StagingBuffer& entry) { const auto is_free = [this](const StagingBuffer& entry) {
@@ -202,7 +193,7 @@ std::optional<StagingBufferRef> StagingBufferPool::TryGetReservedBuffer(size_t s
return it->Ref(); return it->Ref();
} }
StagingBufferRef StagingBufferPool::CreateStagingBuffer(size_t size, MemoryUsage usage, bool deferred) { StagingBufferRef StagingBufferPool::CreateStagingBuffer(const Device& device, size_t size, MemoryUsage usage, bool deferred) {
auto const log2_size = Common::Log2Ceil<u32>(u32(size)); auto const log2_size = Common::Log2Ceil<u32>(u32(size));
VkBufferCreateInfo buffer_ci = { VkBufferCreateInfo buffer_ci = {
.sType = VK_STRUCTURE_TYPE_BUFFER_CREATE_INFO, .sType = VK_STRUCTURE_TYPE_BUFFER_CREATE_INFO,
@@ -33,11 +33,10 @@ class StagingBufferPool {
public: public:
static constexpr size_t NUM_SYNCS = 16; static constexpr size_t NUM_SYNCS = 16;
explicit StagingBufferPool(const Device& device, MemoryAllocator& memory_allocator, explicit StagingBufferPool(const Device& device, MemoryAllocator& memory_allocator, Scheduler& scheduler);
Scheduler& scheduler);
~StagingBufferPool(); ~StagingBufferPool();
StagingBufferRef Request(size_t size, MemoryUsage usage, bool deferred = false); StagingBufferRef Request(const Device& device, size_t size, MemoryUsage usage, bool deferred = false);
void FreeDeferred(StagingBufferRef& ref); void FreeDeferred(StagingBufferRef& ref);
[[nodiscard]] VkBuffer StreamBuf() const noexcept { [[nodiscard]] VkBuffer StreamBuf() const noexcept {
@@ -84,27 +83,18 @@ private:
static constexpr size_t NUM_LEVELS = sizeof(size_t) * CHAR_BIT; static constexpr size_t NUM_LEVELS = sizeof(size_t) * CHAR_BIT;
using StagingBuffersCache = std::array<StagingBuffers, NUM_LEVELS>; using StagingBuffersCache = std::array<StagingBuffers, NUM_LEVELS>;
StagingBufferRef GetStreamBuffer(size_t size); StagingBufferRef GetStreamBuffer(const Device& device, size_t size);
bool AreRegionsActive(size_t region_begin, size_t region_end) const; bool AreRegionsActive(size_t region_begin, size_t region_end) const;
StagingBufferRef GetStagingBuffer(const Device& device, size_t size, MemoryUsage usage, bool deferred = false);
StagingBufferRef GetStagingBuffer(size_t size, MemoryUsage usage, bool deferred = false); std::optional<StagingBufferRef> TryGetReservedBuffer(size_t size, MemoryUsage usage, bool deferred);
StagingBufferRef CreateStagingBuffer(const Device& device, size_t size, MemoryUsage usage, bool deferred);
std::optional<StagingBufferRef> TryGetReservedBuffer(size_t size, MemoryUsage usage,
bool deferred);
StagingBufferRef CreateStagingBuffer(size_t size, MemoryUsage usage, bool deferred);
StagingBuffersCache& GetCache(MemoryUsage usage); StagingBuffersCache& GetCache(MemoryUsage usage);
void ReleaseCache(MemoryUsage usage); void ReleaseCache(MemoryUsage usage);
void ReleaseLevel(StagingBuffersCache& cache, size_t log2); void ReleaseLevel(StagingBuffersCache& cache, size_t log2);
size_t Region(size_t iter) const noexcept { size_t Region(size_t iter) const noexcept {
return iter / region_size; return iter / region_size;
} }
const Device& device;
MemoryAllocator& memory_allocator; MemoryAllocator& memory_allocator;
Scheduler& scheduler; Scheduler& scheduler;
@@ -975,11 +975,11 @@ void TextureCacheRuntime::Finish() {
} }
StagingBufferRef TextureCacheRuntime::UploadStagingBuffer(size_t size, bool deferred) { StagingBufferRef TextureCacheRuntime::UploadStagingBuffer(size_t size, bool deferred) {
return staging_buffer_pool.Request(size, MemoryUsage::Upload, deferred); return staging_buffer_pool.Request(device, size, MemoryUsage::Upload, deferred);
} }
StagingBufferRef TextureCacheRuntime::DownloadStagingBuffer(size_t size, bool deferred) { StagingBufferRef TextureCacheRuntime::DownloadStagingBuffer(size_t size, bool deferred) {
return staging_buffer_pool.Request(size, MemoryUsage::Download, deferred); return staging_buffer_pool.Request(device, size, MemoryUsage::Download, deferred);
} }
void TextureCacheRuntime::FreeDeferredStagingBuffer(StagingBufferRef& ref) { void TextureCacheRuntime::FreeDeferredStagingBuffer(StagingBufferRef& ref) {