14ab50defb
It became apparent that logging can continuously spam errors that trigger file flushing. Since committing the files to disk is an expensive operation, this causes unnecessarily high disk usage. As such, we will revert Flush() to the previous behavior and add a Commit() member function in the event that this behavior is needed.
417 lines
10 KiB
C++
417 lines
10 KiB
C++
// Copyright 2021 yuzu Emulator Project
|
|
// Licensed under GPLv2 or any later version
|
|
// Refer to the license.txt file included.
|
|
|
|
#include "common/fs/file.h"
|
|
#include "common/fs/fs.h"
|
|
#include "common/fs/path_util.h"
|
|
#include "common/logging/log.h"
|
|
|
|
#ifdef _WIN32
|
|
#include <io.h>
|
|
#include <share.h>
|
|
#else
|
|
#include <unistd.h>
|
|
#endif
|
|
|
|
#ifdef _MSC_VER
|
|
#define fileno _fileno
|
|
#define fseeko _fseeki64
|
|
#define ftello _ftelli64
|
|
#endif
|
|
|
|
namespace Common::FS {
|
|
|
|
namespace fs = std::filesystem;
|
|
|
|
namespace {
|
|
|
|
#ifdef _WIN32
|
|
|
|
/**
|
|
* Converts the file access mode and file type enums to a file access mode wide string.
|
|
*
|
|
* @param mode File access mode
|
|
* @param type File type
|
|
*
|
|
* @returns A pointer to a wide string representing the file access mode.
|
|
*/
|
|
[[nodiscard]] constexpr const wchar_t* AccessModeToWStr(FileAccessMode mode, FileType type) {
|
|
switch (type) {
|
|
case FileType::BinaryFile:
|
|
switch (mode) {
|
|
case FileAccessMode::Read:
|
|
return L"rb";
|
|
case FileAccessMode::Write:
|
|
return L"wb";
|
|
case FileAccessMode::Append:
|
|
return L"ab";
|
|
case FileAccessMode::ReadWrite:
|
|
return L"r+b";
|
|
case FileAccessMode::ReadAppend:
|
|
return L"a+b";
|
|
}
|
|
break;
|
|
case FileType::TextFile:
|
|
switch (mode) {
|
|
case FileAccessMode::Read:
|
|
return L"r";
|
|
case FileAccessMode::Write:
|
|
return L"w";
|
|
case FileAccessMode::Append:
|
|
return L"a";
|
|
case FileAccessMode::ReadWrite:
|
|
return L"r+";
|
|
case FileAccessMode::ReadAppend:
|
|
return L"a+";
|
|
}
|
|
break;
|
|
}
|
|
|
|
return L"";
|
|
}
|
|
|
|
/**
|
|
* Converts the file-share access flag enum to a Windows defined file-share access flag.
|
|
*
|
|
* @param flag File-share access flag
|
|
*
|
|
* @returns Windows defined file-share access flag.
|
|
*/
|
|
[[nodiscard]] constexpr int ToWindowsFileShareFlag(FileShareFlag flag) {
|
|
switch (flag) {
|
|
case FileShareFlag::ShareNone:
|
|
default:
|
|
return _SH_DENYRW;
|
|
case FileShareFlag::ShareReadOnly:
|
|
return _SH_DENYWR;
|
|
case FileShareFlag::ShareWriteOnly:
|
|
return _SH_DENYRD;
|
|
case FileShareFlag::ShareReadWrite:
|
|
return _SH_DENYNO;
|
|
}
|
|
}
|
|
|
|
#else
|
|
|
|
/**
|
|
* Converts the file access mode and file type enums to a file access mode string.
|
|
*
|
|
* @param mode File access mode
|
|
* @param type File type
|
|
*
|
|
* @returns A pointer to a string representing the file access mode.
|
|
*/
|
|
[[nodiscard]] constexpr const char* AccessModeToStr(FileAccessMode mode, FileType type) {
|
|
switch (type) {
|
|
case FileType::BinaryFile:
|
|
switch (mode) {
|
|
case FileAccessMode::Read:
|
|
return "rb";
|
|
case FileAccessMode::Write:
|
|
return "wb";
|
|
case FileAccessMode::Append:
|
|
return "ab";
|
|
case FileAccessMode::ReadWrite:
|
|
return "r+b";
|
|
case FileAccessMode::ReadAppend:
|
|
return "a+b";
|
|
}
|
|
break;
|
|
case FileType::TextFile:
|
|
switch (mode) {
|
|
case FileAccessMode::Read:
|
|
return "r";
|
|
case FileAccessMode::Write:
|
|
return "w";
|
|
case FileAccessMode::Append:
|
|
return "a";
|
|
case FileAccessMode::ReadWrite:
|
|
return "r+";
|
|
case FileAccessMode::ReadAppend:
|
|
return "a+";
|
|
}
|
|
break;
|
|
}
|
|
|
|
return "";
|
|
}
|
|
|
|
#endif
|
|
|
|
/**
|
|
* Converts the seek origin enum to a seek origin integer.
|
|
*
|
|
* @param origin Seek origin
|
|
*
|
|
* @returns Seek origin integer.
|
|
*/
|
|
[[nodiscard]] constexpr int ToSeekOrigin(SeekOrigin origin) {
|
|
switch (origin) {
|
|
case SeekOrigin::SetOrigin:
|
|
default:
|
|
return SEEK_SET;
|
|
case SeekOrigin::CurrentPosition:
|
|
return SEEK_CUR;
|
|
case SeekOrigin::End:
|
|
return SEEK_END;
|
|
}
|
|
}
|
|
|
|
} // Anonymous namespace
|
|
|
|
std::string ReadStringFromFile(const std::filesystem::path& path, FileType type) {
|
|
if (!IsFile(path)) {
|
|
return "";
|
|
}
|
|
|
|
IOFile io_file{path, FileAccessMode::Read, type};
|
|
|
|
return io_file.ReadString(io_file.GetSize());
|
|
}
|
|
|
|
size_t WriteStringToFile(const std::filesystem::path& path, FileType type,
|
|
std::string_view string) {
|
|
if (Exists(path) && !IsFile(path)) {
|
|
return 0;
|
|
}
|
|
|
|
IOFile io_file{path, FileAccessMode::Write, type};
|
|
|
|
return io_file.WriteString(string);
|
|
}
|
|
|
|
size_t AppendStringToFile(const std::filesystem::path& path, FileType type,
|
|
std::string_view string) {
|
|
if (Exists(path) && !IsFile(path)) {
|
|
return 0;
|
|
}
|
|
|
|
IOFile io_file{path, FileAccessMode::Append, type};
|
|
|
|
return io_file.WriteString(string);
|
|
}
|
|
|
|
IOFile::IOFile() = default;
|
|
|
|
IOFile::IOFile(const std::string& path, FileAccessMode mode, FileType type, FileShareFlag flag) {
|
|
Open(path, mode, type, flag);
|
|
}
|
|
|
|
IOFile::IOFile(std::string_view path, FileAccessMode mode, FileType type, FileShareFlag flag) {
|
|
Open(path, mode, type, flag);
|
|
}
|
|
|
|
IOFile::IOFile(const fs::path& path, FileAccessMode mode, FileType type, FileShareFlag flag) {
|
|
Open(path, mode, type, flag);
|
|
}
|
|
|
|
IOFile::~IOFile() {
|
|
Close();
|
|
}
|
|
|
|
IOFile::IOFile(IOFile&& other) noexcept {
|
|
std::swap(file_path, other.file_path);
|
|
std::swap(file_access_mode, other.file_access_mode);
|
|
std::swap(file_type, other.file_type);
|
|
std::swap(file, other.file);
|
|
}
|
|
|
|
IOFile& IOFile::operator=(IOFile&& other) noexcept {
|
|
std::swap(file_path, other.file_path);
|
|
std::swap(file_access_mode, other.file_access_mode);
|
|
std::swap(file_type, other.file_type);
|
|
std::swap(file, other.file);
|
|
return *this;
|
|
}
|
|
|
|
fs::path IOFile::GetPath() const {
|
|
return file_path;
|
|
}
|
|
|
|
FileAccessMode IOFile::GetAccessMode() const {
|
|
return file_access_mode;
|
|
}
|
|
|
|
FileType IOFile::GetType() const {
|
|
return file_type;
|
|
}
|
|
|
|
void IOFile::Open(const fs::path& path, FileAccessMode mode, FileType type, FileShareFlag flag) {
|
|
Close();
|
|
|
|
file_path = path;
|
|
file_access_mode = mode;
|
|
file_type = type;
|
|
|
|
errno = 0;
|
|
|
|
#ifdef _WIN32
|
|
if (flag != FileShareFlag::ShareNone) {
|
|
file = _wfsopen(path.c_str(), AccessModeToWStr(mode, type), ToWindowsFileShareFlag(flag));
|
|
} else {
|
|
_wfopen_s(&file, path.c_str(), AccessModeToWStr(mode, type));
|
|
}
|
|
#else
|
|
file = std::fopen(path.c_str(), AccessModeToStr(mode, type));
|
|
#endif
|
|
|
|
if (!IsOpen()) {
|
|
const auto ec = std::error_code{errno, std::generic_category()};
|
|
LOG_ERROR(Common_Filesystem, "Failed to open the file at path={}, ec_message={}",
|
|
PathToUTF8String(file_path), ec.message());
|
|
}
|
|
}
|
|
|
|
void IOFile::Close() {
|
|
if (!IsOpen()) {
|
|
return;
|
|
}
|
|
|
|
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 {
|
|
return file != nullptr;
|
|
}
|
|
|
|
std::string IOFile::ReadString(size_t length) const {
|
|
std::vector<char> string_buffer(length);
|
|
|
|
const auto chars_read = ReadSpan<char>(string_buffer);
|
|
const auto string_size = chars_read != length ? chars_read : length;
|
|
|
|
return std::string{string_buffer.data(), string_size};
|
|
}
|
|
|
|
size_t IOFile::WriteString(std::span<const char> string) const {
|
|
return WriteSpan(string);
|
|
}
|
|
|
|
bool IOFile::Flush() const {
|
|
if (!IsOpen()) {
|
|
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 {
|
|
if (!IsOpen()) {
|
|
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 {
|
|
if (!IsOpen()) {
|
|
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 {
|
|
if (!IsOpen()) {
|
|
return 0;
|
|
}
|
|
|
|
// Flush any unwritten buffered data into the file prior to retrieving the file size.
|
|
std::fflush(file);
|
|
|
|
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;
|
|
}
|
|
|
|
return file_size;
|
|
}
|
|
|
|
bool IOFile::Seek(s64 offset, SeekOrigin origin) const {
|
|
if (!IsOpen()) {
|
|
return false;
|
|
}
|
|
|
|
errno = 0;
|
|
|
|
const auto seek_result = fseeko(file, offset, ToSeekOrigin(origin)) == 0;
|
|
|
|
if (!seek_result) {
|
|
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={}",
|
|
PathToUTF8String(file_path), offset, origin, ec.message());
|
|
}
|
|
|
|
return seek_result;
|
|
}
|
|
|
|
s64 IOFile::Tell() const {
|
|
if (!IsOpen()) {
|
|
return 0;
|
|
}
|
|
|
|
errno = 0;
|
|
|
|
return ftello(file);
|
|
}
|
|
|
|
} // namespace Common::FS
|