7f8151b9b9
Previously, we were returning a value that was way too big, causing an integer overflow in Fractured Souls. According to wwylele, the biggest oberserved save size for 3DS is 1MB, so this new value should leave plenty of room, even if games use a bigger size.
361 lines
13 KiB
C++
361 lines
13 KiB
C++
// Copyright 2016 Citra Emulator Project
|
|
// Licensed under GPLv2 or any later version
|
|
// Refer to the license.txt file included.
|
|
|
|
#include "common/archives.h"
|
|
#include "common/file_util.h"
|
|
#include "core/file_sys/disk_archive.h"
|
|
#include "core/file_sys/errors.h"
|
|
#include "core/file_sys/path_parser.h"
|
|
#include "core/file_sys/savedata_archive.h"
|
|
|
|
////////////////////////////////////////////////////////////////////////////////////////////////////
|
|
// FileSys namespace
|
|
|
|
namespace FileSys {
|
|
|
|
class SaveDataDelayGenerator : public DelayGenerator {
|
|
public:
|
|
u64 GetReadDelayNs(std::size_t length) override {
|
|
// The delay was measured on O3DS and O2DS with
|
|
// https://gist.github.com/B3n30/ac40eac20603f519ff106107f4ac9182
|
|
// from the results the average of each length was taken.
|
|
static constexpr u64 slope(183);
|
|
static constexpr u64 offset(524879);
|
|
static constexpr u64 minimum(631826);
|
|
u64 IPCDelayNanoseconds = std::max<u64>(static_cast<u64>(length) * slope + offset, minimum);
|
|
return IPCDelayNanoseconds;
|
|
}
|
|
|
|
u64 GetOpenDelayNs() override {
|
|
// This is the delay measured on O3DS and O2DS with
|
|
// https://gist.github.com/FearlessTobi/c37e143c314789251f98f2c45cd706d2
|
|
// from the results the average of each length was taken.
|
|
static constexpr u64 IPCDelayNanoseconds(269082);
|
|
return IPCDelayNanoseconds;
|
|
}
|
|
|
|
SERIALIZE_DELAY_GENERATOR
|
|
};
|
|
|
|
ResultVal<std::unique_ptr<FileBackend>> SaveDataArchive::OpenFile(const Path& path,
|
|
const Mode& mode) const {
|
|
LOG_DEBUG(Service_FS, "called path={} mode={:01X}", path.DebugStr(), mode.hex);
|
|
|
|
const PathParser path_parser(path);
|
|
|
|
if (!path_parser.IsValid()) {
|
|
LOG_ERROR(Service_FS, "Invalid path {}", path.DebugStr());
|
|
return ERROR_INVALID_PATH;
|
|
}
|
|
|
|
if (mode.hex == 0) {
|
|
LOG_ERROR(Service_FS, "Empty open mode");
|
|
return ERROR_UNSUPPORTED_OPEN_FLAGS;
|
|
}
|
|
|
|
if (mode.create_flag && !mode.write_flag) {
|
|
LOG_ERROR(Service_FS, "Create flag set but write flag not set");
|
|
return ERROR_UNSUPPORTED_OPEN_FLAGS;
|
|
}
|
|
|
|
const auto full_path = path_parser.BuildHostPath(mount_point);
|
|
|
|
switch (path_parser.GetHostStatus(mount_point)) {
|
|
case PathParser::InvalidMountPoint:
|
|
LOG_CRITICAL(Service_FS, "(unreachable) Invalid mount point {}", mount_point);
|
|
return ERROR_FILE_NOT_FOUND;
|
|
case PathParser::PathNotFound:
|
|
LOG_ERROR(Service_FS, "Path not found {}", full_path);
|
|
return ERROR_PATH_NOT_FOUND;
|
|
case PathParser::FileInPath:
|
|
case PathParser::DirectoryFound:
|
|
LOG_ERROR(Service_FS, "Unexpected file or directory in {}", full_path);
|
|
return ERROR_UNEXPECTED_FILE_OR_DIRECTORY;
|
|
case PathParser::NotFound:
|
|
if (!mode.create_flag) {
|
|
LOG_ERROR(Service_FS, "Non-existing file {} can't be open without mode create.",
|
|
full_path);
|
|
return ERROR_FILE_NOT_FOUND;
|
|
} else {
|
|
// Create the file
|
|
FileUtil::CreateEmptyFile(full_path);
|
|
}
|
|
break;
|
|
case PathParser::FileFound:
|
|
break; // Expected 'success' case
|
|
}
|
|
|
|
FileUtil::IOFile file(full_path, mode.write_flag ? "r+b" : "rb");
|
|
if (!file.IsOpen()) {
|
|
LOG_CRITICAL(Service_FS, "(unreachable) Unknown error opening {}", full_path);
|
|
return ERROR_FILE_NOT_FOUND;
|
|
}
|
|
|
|
std::unique_ptr<DelayGenerator> delay_generator = std::make_unique<SaveDataDelayGenerator>();
|
|
auto disk_file = std::make_unique<DiskFile>(std::move(file), mode, std::move(delay_generator));
|
|
return MakeResult<std::unique_ptr<FileBackend>>(std::move(disk_file));
|
|
}
|
|
|
|
ResultCode SaveDataArchive::DeleteFile(const Path& path) const {
|
|
const PathParser path_parser(path);
|
|
|
|
if (!path_parser.IsValid()) {
|
|
LOG_ERROR(Service_FS, "Invalid path {}", path.DebugStr());
|
|
return ERROR_INVALID_PATH;
|
|
}
|
|
|
|
const auto full_path = path_parser.BuildHostPath(mount_point);
|
|
|
|
switch (path_parser.GetHostStatus(mount_point)) {
|
|
case PathParser::InvalidMountPoint:
|
|
LOG_CRITICAL(Service_FS, "(unreachable) Invalid mount point {}", mount_point);
|
|
return ERROR_FILE_NOT_FOUND;
|
|
case PathParser::PathNotFound:
|
|
LOG_ERROR(Service_FS, "Path not found {}", full_path);
|
|
return ERROR_PATH_NOT_FOUND;
|
|
case PathParser::FileInPath:
|
|
case PathParser::DirectoryFound:
|
|
case PathParser::NotFound:
|
|
LOG_ERROR(Service_FS, "File not found {}", full_path);
|
|
return ERROR_FILE_NOT_FOUND;
|
|
case PathParser::FileFound:
|
|
break; // Expected 'success' case
|
|
}
|
|
|
|
if (FileUtil::Delete(full_path)) {
|
|
return RESULT_SUCCESS;
|
|
}
|
|
|
|
LOG_CRITICAL(Service_FS, "(unreachable) Unknown error deleting {}", full_path);
|
|
return ERROR_FILE_NOT_FOUND;
|
|
}
|
|
|
|
ResultCode SaveDataArchive::RenameFile(const Path& src_path, const Path& dest_path) const {
|
|
const PathParser path_parser_src(src_path);
|
|
|
|
// TODO: Verify these return codes with HW
|
|
if (!path_parser_src.IsValid()) {
|
|
LOG_ERROR(Service_FS, "Invalid src path {}", src_path.DebugStr());
|
|
return ERROR_INVALID_PATH;
|
|
}
|
|
|
|
const PathParser path_parser_dest(dest_path);
|
|
|
|
if (!path_parser_dest.IsValid()) {
|
|
LOG_ERROR(Service_FS, "Invalid dest path {}", dest_path.DebugStr());
|
|
return ERROR_INVALID_PATH;
|
|
}
|
|
|
|
const auto src_path_full = path_parser_src.BuildHostPath(mount_point);
|
|
const auto dest_path_full = path_parser_dest.BuildHostPath(mount_point);
|
|
|
|
if (FileUtil::Rename(src_path_full, dest_path_full)) {
|
|
return RESULT_SUCCESS;
|
|
}
|
|
|
|
// TODO(yuriks): This code probably isn't right, it'll return a Status even if the file didn't
|
|
// exist or similar. Verify.
|
|
return ResultCode(ErrorDescription::NoData, ErrorModule::FS, // TODO: verify description
|
|
ErrorSummary::NothingHappened, ErrorLevel::Status);
|
|
}
|
|
|
|
template <typename T>
|
|
static ResultCode DeleteDirectoryHelper(const Path& path, const std::string& mount_point,
|
|
T deleter) {
|
|
const PathParser path_parser(path);
|
|
|
|
if (!path_parser.IsValid()) {
|
|
LOG_ERROR(Service_FS, "Invalid path {}", path.DebugStr());
|
|
return ERROR_INVALID_PATH;
|
|
}
|
|
|
|
if (path_parser.IsRootDirectory())
|
|
return ERROR_DIRECTORY_NOT_EMPTY;
|
|
|
|
const auto full_path = path_parser.BuildHostPath(mount_point);
|
|
|
|
switch (path_parser.GetHostStatus(mount_point)) {
|
|
case PathParser::InvalidMountPoint:
|
|
LOG_CRITICAL(Service_FS, "(unreachable) Invalid mount point {}", mount_point);
|
|
return ERROR_PATH_NOT_FOUND;
|
|
case PathParser::PathNotFound:
|
|
case PathParser::NotFound:
|
|
LOG_ERROR(Service_FS, "Path not found {}", full_path);
|
|
return ERROR_PATH_NOT_FOUND;
|
|
case PathParser::FileInPath:
|
|
case PathParser::FileFound:
|
|
LOG_ERROR(Service_FS, "Unexpected file or directory {}", full_path);
|
|
return ERROR_UNEXPECTED_FILE_OR_DIRECTORY;
|
|
case PathParser::DirectoryFound:
|
|
break; // Expected 'success' case
|
|
}
|
|
|
|
if (deleter(full_path)) {
|
|
return RESULT_SUCCESS;
|
|
}
|
|
|
|
LOG_ERROR(Service_FS, "Directory not empty {}", full_path);
|
|
return ERROR_DIRECTORY_NOT_EMPTY;
|
|
}
|
|
|
|
ResultCode SaveDataArchive::DeleteDirectory(const Path& path) const {
|
|
return DeleteDirectoryHelper(path, mount_point, FileUtil::DeleteDir);
|
|
}
|
|
|
|
ResultCode SaveDataArchive::DeleteDirectoryRecursively(const Path& path) const {
|
|
return DeleteDirectoryHelper(
|
|
path, mount_point, [](const std::string& p) { return FileUtil::DeleteDirRecursively(p); });
|
|
}
|
|
|
|
ResultCode SaveDataArchive::CreateFile(const FileSys::Path& path, u64 size) const {
|
|
const PathParser path_parser(path);
|
|
|
|
if (!path_parser.IsValid()) {
|
|
LOG_ERROR(Service_FS, "Invalid path {}", path.DebugStr());
|
|
return ERROR_INVALID_PATH;
|
|
}
|
|
|
|
const auto full_path = path_parser.BuildHostPath(mount_point);
|
|
|
|
switch (path_parser.GetHostStatus(mount_point)) {
|
|
case PathParser::InvalidMountPoint:
|
|
LOG_CRITICAL(Service_FS, "(unreachable) Invalid mount point {}", mount_point);
|
|
return ERROR_FILE_NOT_FOUND;
|
|
case PathParser::PathNotFound:
|
|
LOG_ERROR(Service_FS, "Path not found {}", full_path);
|
|
return ERROR_PATH_NOT_FOUND;
|
|
case PathParser::FileInPath:
|
|
LOG_ERROR(Service_FS, "Unexpected file in path {}", full_path);
|
|
return ERROR_UNEXPECTED_FILE_OR_DIRECTORY;
|
|
case PathParser::DirectoryFound:
|
|
case PathParser::FileFound:
|
|
LOG_ERROR(Service_FS, "{} already exists", full_path);
|
|
return ERROR_FILE_ALREADY_EXISTS;
|
|
case PathParser::NotFound:
|
|
break; // Expected 'success' case
|
|
}
|
|
|
|
if (size == 0) {
|
|
FileUtil::CreateEmptyFile(full_path);
|
|
return RESULT_SUCCESS;
|
|
}
|
|
|
|
FileUtil::IOFile file(full_path, "wb");
|
|
// Creates a sparse file (or a normal file on filesystems without the concept of sparse files)
|
|
// We do this by seeking to the right size, then writing a single null byte.
|
|
if (file.Seek(size - 1, SEEK_SET) && file.WriteBytes("", 1) == 1) {
|
|
return RESULT_SUCCESS;
|
|
}
|
|
|
|
LOG_ERROR(Service_FS, "Too large file");
|
|
return ResultCode(ErrorDescription::TooLarge, ErrorModule::FS, ErrorSummary::OutOfResource,
|
|
ErrorLevel::Info);
|
|
}
|
|
|
|
ResultCode SaveDataArchive::CreateDirectory(const Path& path) const {
|
|
const PathParser path_parser(path);
|
|
|
|
if (!path_parser.IsValid()) {
|
|
LOG_ERROR(Service_FS, "Invalid path {}", path.DebugStr());
|
|
return ERROR_INVALID_PATH;
|
|
}
|
|
|
|
const auto full_path = path_parser.BuildHostPath(mount_point);
|
|
|
|
switch (path_parser.GetHostStatus(mount_point)) {
|
|
case PathParser::InvalidMountPoint:
|
|
LOG_CRITICAL(Service_FS, "(unreachable) Invalid mount point {}", mount_point);
|
|
return ERROR_FILE_NOT_FOUND;
|
|
case PathParser::PathNotFound:
|
|
LOG_ERROR(Service_FS, "Path not found {}", full_path);
|
|
return ERROR_PATH_NOT_FOUND;
|
|
case PathParser::FileInPath:
|
|
LOG_ERROR(Service_FS, "Unexpected file in path {}", full_path);
|
|
return ERROR_UNEXPECTED_FILE_OR_DIRECTORY;
|
|
case PathParser::DirectoryFound:
|
|
case PathParser::FileFound:
|
|
LOG_ERROR(Service_FS, "{} already exists", full_path);
|
|
return ERROR_DIRECTORY_ALREADY_EXISTS;
|
|
case PathParser::NotFound:
|
|
break; // Expected 'success' case
|
|
}
|
|
|
|
if (FileUtil::CreateDir(mount_point + path.AsString())) {
|
|
return RESULT_SUCCESS;
|
|
}
|
|
|
|
LOG_CRITICAL(Service_FS, "(unreachable) Unknown error creating {}", mount_point);
|
|
return ResultCode(ErrorDescription::NoData, ErrorModule::FS, ErrorSummary::Canceled,
|
|
ErrorLevel::Status);
|
|
}
|
|
|
|
ResultCode SaveDataArchive::RenameDirectory(const Path& src_path, const Path& dest_path) const {
|
|
const PathParser path_parser_src(src_path);
|
|
|
|
// TODO: Verify these return codes with HW
|
|
if (!path_parser_src.IsValid()) {
|
|
LOG_ERROR(Service_FS, "Invalid src path {}", src_path.DebugStr());
|
|
return ERROR_INVALID_PATH;
|
|
}
|
|
|
|
const PathParser path_parser_dest(dest_path);
|
|
|
|
if (!path_parser_dest.IsValid()) {
|
|
LOG_ERROR(Service_FS, "Invalid dest path {}", dest_path.DebugStr());
|
|
return ERROR_INVALID_PATH;
|
|
}
|
|
|
|
const auto src_path_full = path_parser_src.BuildHostPath(mount_point);
|
|
const auto dest_path_full = path_parser_dest.BuildHostPath(mount_point);
|
|
|
|
if (FileUtil::Rename(src_path_full, dest_path_full)) {
|
|
return RESULT_SUCCESS;
|
|
}
|
|
|
|
// TODO(yuriks): This code probably isn't right, it'll return a Status even if the file didn't
|
|
// exist or similar. Verify.
|
|
return ResultCode(ErrorDescription::NoData, ErrorModule::FS, // TODO: verify description
|
|
ErrorSummary::NothingHappened, ErrorLevel::Status);
|
|
}
|
|
|
|
ResultVal<std::unique_ptr<DirectoryBackend>> SaveDataArchive::OpenDirectory(
|
|
const Path& path) const {
|
|
const PathParser path_parser(path);
|
|
|
|
if (!path_parser.IsValid()) {
|
|
LOG_ERROR(Service_FS, "Invalid path {}", path.DebugStr());
|
|
return ERROR_INVALID_PATH;
|
|
}
|
|
|
|
const auto full_path = path_parser.BuildHostPath(mount_point);
|
|
|
|
switch (path_parser.GetHostStatus(mount_point)) {
|
|
case PathParser::InvalidMountPoint:
|
|
LOG_CRITICAL(Service_FS, "(unreachable) Invalid mount point {}", mount_point);
|
|
return ERROR_FILE_NOT_FOUND;
|
|
case PathParser::PathNotFound:
|
|
case PathParser::NotFound:
|
|
LOG_ERROR(Service_FS, "Path not found {}", full_path);
|
|
return ERROR_PATH_NOT_FOUND;
|
|
case PathParser::FileInPath:
|
|
case PathParser::FileFound:
|
|
LOG_ERROR(Service_FS, "Unexpected file in path {}", full_path);
|
|
return ERROR_UNEXPECTED_FILE_OR_DIRECTORY;
|
|
case PathParser::DirectoryFound:
|
|
break; // Expected 'success' case
|
|
}
|
|
|
|
auto directory = std::make_unique<DiskDirectory>(full_path);
|
|
return MakeResult<std::unique_ptr<DirectoryBackend>>(std::move(directory));
|
|
}
|
|
|
|
u64 SaveDataArchive::GetFreeBytes() const {
|
|
// TODO: Stubbed to return 32MiB
|
|
return 1024 * 1024 * 32;
|
|
}
|
|
|
|
} // namespace FileSys
|
|
|
|
SERIALIZE_EXPORT_IMPL(FileSys::SaveDataArchive)
|
|
SERIALIZE_EXPORT_IMPL(FileSys::SaveDataDelayGenerator)
|