mirror of
				https://github.com/PabloMK7/citra.git
				synced 2025-10-31 22:00:05 +00:00 
			
		
		
		
	FS: Allow multiple instances of the same archive type to be open at once
This commit is contained in:
		
							parent
							
								
									4468625080
								
							
						
					
					
						commit
						3f1a3952d7
					
				
					 19 changed files with 199 additions and 159 deletions
				
			
		|  | @ -180,20 +180,6 @@ public: | |||
|     virtual ~ArchiveBackend() { | ||||
|     } | ||||
| 
 | ||||
|     /**
 | ||||
|      * Tries to open the archive of this type with the specified path | ||||
|      * @param path Path to the archive | ||||
|      * @return ResultCode of the operation | ||||
|      */ | ||||
|     virtual ResultCode Open(const Path& path) = 0; | ||||
| 
 | ||||
|     /**
 | ||||
|      * Deletes the archive contents and then re-creates the base folder | ||||
|      * @param path Path to the archive | ||||
|      * @return ResultCode of the operation, 0 on success | ||||
|      */ | ||||
|     virtual ResultCode Format(const Path& path) const = 0; | ||||
| 
 | ||||
|     /**
 | ||||
|      * Get a descriptive name for the archive (e.g. "RomFS", "SaveData", etc.) | ||||
|      */ | ||||
|  | @ -260,4 +246,29 @@ public: | |||
|     virtual std::unique_ptr<DirectoryBackend> OpenDirectory(const Path& path) const = 0; | ||||
| }; | ||||
| 
 | ||||
| class ArchiveFactory : NonCopyable { | ||||
| public: | ||||
|     virtual ~ArchiveFactory() { | ||||
|     } | ||||
| 
 | ||||
|     /**
 | ||||
|      * Get a descriptive name for the archive (e.g. "RomFS", "SaveData", etc.) | ||||
|      */ | ||||
|     virtual std::string GetName() const = 0; | ||||
| 
 | ||||
|     /**
 | ||||
|      * Tries to open the archive of this type with the specified path | ||||
|      * @param path Path to the archive | ||||
|      * @return An ArchiveBackend corresponding operating specified archive path. | ||||
|      */ | ||||
|     virtual ResultVal<std::unique_ptr<ArchiveBackend>> Open(const Path& path) = 0; | ||||
| 
 | ||||
|     /**
 | ||||
|      * Deletes the archive contents and then re-creates the base folder | ||||
|      * @param path Path to the archive | ||||
|      * @return ResultCode of the operation, 0 on success | ||||
|      */ | ||||
|     virtual ResultCode Format(const Path& path) = 0; | ||||
| }; | ||||
| 
 | ||||
| } // namespace FileSys
 | ||||
|  |  | |||
|  | @ -6,6 +6,7 @@ | |||
| 
 | ||||
| #include "common/common_types.h" | ||||
| #include "common/file_util.h" | ||||
| #include "common/make_unique.h" | ||||
| 
 | ||||
| #include "core/file_sys/archive_extsavedata.h" | ||||
| #include "core/file_sys/disk_archive.h" | ||||
|  | @ -33,12 +34,12 @@ std::string GetExtDataContainerPath(const std::string& mount_point, bool shared) | |||
|             SYSTEM_ID.c_str(), SDCARD_ID.c_str()); | ||||
| } | ||||
| 
 | ||||
| Archive_ExtSaveData::Archive_ExtSaveData(const std::string& mount_location, bool shared) | ||||
|         : DiskArchive(GetExtDataContainerPath(mount_location, shared)) { | ||||
| ArchiveFactory_ExtSaveData::ArchiveFactory_ExtSaveData(const std::string& mount_location, bool shared) | ||||
|         : mount_point(GetExtDataContainerPath(mount_location, shared)) { | ||||
|     LOG_INFO(Service_FS, "Directory %s set as base for ExtSaveData.", mount_point.c_str()); | ||||
| } | ||||
| 
 | ||||
| bool Archive_ExtSaveData::Initialize() { | ||||
| bool ArchiveFactory_ExtSaveData::Initialize() { | ||||
|     if (!FileUtil::CreateFullPath(mount_point)) { | ||||
|         LOG_ERROR(Service_FS, "Unable to create ExtSaveData base path."); | ||||
|         return false; | ||||
|  | @ -47,18 +48,18 @@ bool Archive_ExtSaveData::Initialize() { | |||
|     return true; | ||||
| } | ||||
| 
 | ||||
| ResultCode Archive_ExtSaveData::Open(const Path& path) { | ||||
| ResultVal<std::unique_ptr<ArchiveBackend>> ArchiveFactory_ExtSaveData::Open(const Path& path) { | ||||
|     std::string fullpath = GetExtSaveDataPath(mount_point, path); | ||||
|     if (!FileUtil::Exists(fullpath)) { | ||||
|         // TODO(Subv): Check error code, this one is probably wrong
 | ||||
|         return ResultCode(ErrorDescription::FS_NotFormatted, ErrorModule::FS, | ||||
|             ErrorSummary::InvalidState, ErrorLevel::Status); | ||||
|     } | ||||
|     concrete_mount_point = fullpath; | ||||
|     return RESULT_SUCCESS; | ||||
|     auto archive = Common::make_unique<DiskArchive>(fullpath); | ||||
|     return MakeResult<std::unique_ptr<ArchiveBackend>>(std::move(archive)); | ||||
| } | ||||
| 
 | ||||
| ResultCode Archive_ExtSaveData::Format(const Path& path) const { | ||||
| ResultCode ArchiveFactory_ExtSaveData::Format(const Path& path) { | ||||
|     std::string fullpath = GetExtSaveDataPath(mount_point, path); | ||||
|     FileUtil::CreateFullPath(fullpath); | ||||
|     return RESULT_SUCCESS; | ||||
|  |  | |||
|  | @ -15,9 +15,9 @@ | |||
| namespace FileSys { | ||||
| 
 | ||||
| /// File system interface to the ExtSaveData archive
 | ||||
| class Archive_ExtSaveData final : public DiskArchive { | ||||
| class ArchiveFactory_ExtSaveData final : public ArchiveFactory { | ||||
| public: | ||||
|     Archive_ExtSaveData(const std::string& mount_point, bool shared); | ||||
|     ArchiveFactory_ExtSaveData(const std::string& mount_point, bool shared); | ||||
| 
 | ||||
|     /**
 | ||||
|      * Initialize the archive. | ||||
|  | @ -25,21 +25,20 @@ public: | |||
|      */ | ||||
|     bool Initialize(); | ||||
| 
 | ||||
|     ResultCode Open(const Path& path) override; | ||||
|     ResultCode Format(const Path& path) const override; | ||||
|     std::string GetName() const override { return "ExtSaveData"; } | ||||
| 
 | ||||
|     const std::string& GetMountPoint() const override { | ||||
|         return concrete_mount_point; | ||||
|     } | ||||
|     ResultVal<std::unique_ptr<ArchiveBackend>> Open(const Path& path) override; | ||||
|     ResultCode Format(const Path& path) override; | ||||
| 
 | ||||
| protected: | ||||
|     const std::string& GetMountPoint() const { return mount_point; } | ||||
| 
 | ||||
| private: | ||||
|     /**
 | ||||
|      * This holds the full directory path for this archive, it is only set after a successful call to Open,  | ||||
|      * this is formed as <base extsavedatapath>/<type>/<high>/<low>.  | ||||
|      * This holds the full directory path for this archive, it is only set after a successful call | ||||
|      * to Open, this is formed as <base extsavedatapath>/<type>/<high>/<low>.  | ||||
|      * See GetExtSaveDataPath for the code that extracts this data from an archive path. | ||||
|      */ | ||||
|     std::string concrete_mount_point; | ||||
|     std::string mount_point; | ||||
| }; | ||||
| 
 | ||||
| /**
 | ||||
|  |  | |||
|  | @ -15,11 +15,24 @@ | |||
| 
 | ||||
| namespace FileSys { | ||||
| 
 | ||||
| Archive_RomFS::Archive_RomFS(const Loader::AppLoader& app_loader) { | ||||
| ArchiveFactory_RomFS::ArchiveFactory_RomFS(const Loader::AppLoader& app_loader) | ||||
|         : romfs_data(std::make_shared<std::vector<u8>>()) { | ||||
|     // Load the RomFS from the app
 | ||||
|     if (Loader::ResultStatus::Success != app_loader.ReadRomFS(raw_data)) { | ||||
|     if (Loader::ResultStatus::Success != app_loader.ReadRomFS(*romfs_data)) { | ||||
|         LOG_ERROR(Service_FS, "Unable to read RomFS!"); | ||||
|     } | ||||
| } | ||||
| 
 | ||||
| ResultVal<std::unique_ptr<ArchiveBackend>> ArchiveFactory_RomFS::Open(const Path& path) { | ||||
|     auto archive = Common::make_unique<IVFCArchive>(romfs_data); | ||||
|     return MakeResult<std::unique_ptr<ArchiveBackend>>(std::move(archive)); | ||||
| } | ||||
| 
 | ||||
| ResultCode ArchiveFactory_RomFS::Format(const Path& path) { | ||||
|     LOG_ERROR(Service_FS, "Attempted to format a RomFS archive."); | ||||
|     // TODO: Verify error code
 | ||||
|     return ResultCode(ErrorDescription::NotAuthorized, ErrorModule::FS, | ||||
|             ErrorSummary::NotSupported, ErrorLevel::Permanent); | ||||
| } | ||||
| 
 | ||||
| } // namespace FileSys
 | ||||
|  |  | |||
|  | @ -4,6 +4,7 @@ | |||
| 
 | ||||
| #pragma once | ||||
| 
 | ||||
| #include <memory> | ||||
| #include <vector> | ||||
| 
 | ||||
| #include "common/common_types.h" | ||||
|  | @ -17,12 +18,16 @@ | |||
| namespace FileSys { | ||||
| 
 | ||||
| /// File system interface to the RomFS archive
 | ||||
| class Archive_RomFS final : public IVFCArchive { | ||||
| class ArchiveFactory_RomFS final : public ArchiveFactory { | ||||
| public: | ||||
|     Archive_RomFS(const Loader::AppLoader& app_loader); | ||||
|     ArchiveFactory_RomFS(const Loader::AppLoader& app_loader); | ||||
| 
 | ||||
|     std::string GetName() const override { return "RomFS"; } | ||||
|     ResultCode Open(const Path& path) override { return RESULT_SUCCESS; } | ||||
|     ResultVal<std::unique_ptr<ArchiveBackend>> Open(const Path& path) override; | ||||
|     ResultCode Format(const Path& path) override; | ||||
| 
 | ||||
| private: | ||||
|     std::shared_ptr<std::vector<u8>> romfs_data; | ||||
| }; | ||||
| 
 | ||||
| } // namespace FileSys
 | ||||
|  |  | |||
|  | @ -6,6 +6,7 @@ | |||
| 
 | ||||
| #include "common/common_types.h" | ||||
| #include "common/file_util.h" | ||||
| #include "common/make_unique.h" | ||||
| 
 | ||||
| #include "core/file_sys/archive_savedata.h" | ||||
| #include "core/file_sys/disk_archive.h" | ||||
|  | @ -28,26 +29,28 @@ static std::string GetSaveDataPath(const std::string& mount_location, u64 progra | |||
|     return Common::StringFromFormat("%s%08x/%08x/data/00000001/", mount_location.c_str(), high, low); | ||||
| } | ||||
| 
 | ||||
| Archive_SaveData::Archive_SaveData(const std::string& sdmc_directory) | ||||
|         : DiskArchive(GetSaveDataContainerPath(sdmc_directory)) { | ||||
| ArchiveFactory_SaveData::ArchiveFactory_SaveData(const std::string& sdmc_directory) | ||||
|         : mount_point(GetSaveDataContainerPath(sdmc_directory)) { | ||||
|     LOG_INFO(Service_FS, "Directory %s set as SaveData.", this->mount_point.c_str()); | ||||
| } | ||||
| 
 | ||||
| ResultCode Archive_SaveData::Open(const Path& path) { | ||||
|     if (concrete_mount_point.empty()) | ||||
|         concrete_mount_point = GetSaveDataPath(mount_point, Kernel::g_program_id); | ||||
| ResultVal<std::unique_ptr<ArchiveBackend>> ArchiveFactory_SaveData::Open(const Path& path) { | ||||
|     std::string concrete_mount_point = GetSaveDataPath(mount_point, Kernel::g_program_id); | ||||
|     if (!FileUtil::Exists(concrete_mount_point)) { | ||||
|         // When a SaveData archive is created for the first time, it is not yet formatted
 | ||||
|         // and the save file/directory structure expected by the game has not yet been initialized. 
 | ||||
|         // Returning the NotFormatted error code will signal the game to provision the SaveData archive 
 | ||||
|         // with the files and folders that it expects. 
 | ||||
|         // and the save file/directory structure expected by the game has not yet been initialized.
 | ||||
|         // Returning the NotFormatted error code will signal the game to provision the SaveData archive
 | ||||
|         // with the files and folders that it expects.
 | ||||
|         return ResultCode(ErrorDescription::FS_NotFormatted, ErrorModule::FS, | ||||
|             ErrorSummary::InvalidState, ErrorLevel::Status); | ||||
|     } | ||||
|     return RESULT_SUCCESS; | ||||
| 
 | ||||
|     auto archive = Common::make_unique<DiskArchive>(std::move(concrete_mount_point)); | ||||
|     return MakeResult<std::unique_ptr<ArchiveBackend>>(std::move(archive)); | ||||
| } | ||||
| 
 | ||||
| ResultCode Archive_SaveData::Format(const Path& path) const { | ||||
| ResultCode ArchiveFactory_SaveData::Format(const Path& path) { | ||||
|     std::string concrete_mount_point = GetSaveDataPath(mount_point, Kernel::g_program_id); | ||||
|     FileUtil::DeleteDirRecursively(concrete_mount_point); | ||||
|     FileUtil::CreateFullPath(concrete_mount_point); | ||||
|     return RESULT_SUCCESS; | ||||
|  |  | |||
|  | @ -15,22 +15,17 @@ | |||
| namespace FileSys { | ||||
| 
 | ||||
| /// File system interface to the SaveData archive
 | ||||
| class Archive_SaveData final : public DiskArchive { | ||||
| class ArchiveFactory_SaveData final : public ArchiveFactory { | ||||
| public: | ||||
|     Archive_SaveData(const std::string& mount_point); | ||||
|     ArchiveFactory_SaveData(const std::string& mount_point); | ||||
| 
 | ||||
|     std::string GetName() const override { return "SaveData"; } | ||||
| 
 | ||||
|     ResultCode Open(const Path& path) override; | ||||
|     ResultVal<std::unique_ptr<ArchiveBackend>> Open(const Path& path) override; | ||||
|     ResultCode Format(const Path& path) override; | ||||
| 
 | ||||
|     ResultCode Format(const Path& path) const override; | ||||
| 
 | ||||
|     const std::string& GetMountPoint() const override { | ||||
|         return concrete_mount_point; | ||||
|     } | ||||
| 
 | ||||
| protected: | ||||
|     std::string concrete_mount_point; | ||||
| private: | ||||
|     std::string mount_point; | ||||
| }; | ||||
| 
 | ||||
| } // namespace FileSys
 | ||||
|  |  | |||
|  | @ -3,6 +3,7 @@ | |||
| // Refer to the license.txt file included.
 | ||||
| 
 | ||||
| #include "common/file_util.h" | ||||
| #include "common/make_unique.h" | ||||
| 
 | ||||
| #include "core/file_sys/archive_savedatacheck.h" | ||||
| #include "core/hle/service/fs/archive.h" | ||||
|  | @ -21,32 +22,33 @@ static std::string GetSaveDataCheckPath(const std::string& mount_point, u32 high | |||
|             mount_point.c_str(), high, low); | ||||
| } | ||||
| 
 | ||||
| Archive_SaveDataCheck::Archive_SaveDataCheck(const std::string& nand_directory) : | ||||
| ArchiveFactory_SaveDataCheck::ArchiveFactory_SaveDataCheck(const std::string& nand_directory) : | ||||
|         mount_point(GetSaveDataCheckContainerPath(nand_directory)) { | ||||
| } | ||||
| 
 | ||||
| ResultCode Archive_SaveDataCheck::Open(const Path& path) { | ||||
|     // TODO(Subv): We should not be overwriting raw_data everytime this function is called,
 | ||||
|     // but until we use factory classes to create the archives at runtime instead of creating them beforehand
 | ||||
|     // and allow multiple archives of the same type to be open at the same time without clobbering each other,
 | ||||
|     // we won't be able to maintain the state of each archive, hence we overwrite it every time it's needed.
 | ||||
|     // There are a number of problems with this, for example opening a file in this archive, then opening
 | ||||
|     // this archive again with a different path, will corrupt the previously open file.
 | ||||
| ResultVal<std::unique_ptr<ArchiveBackend>> ArchiveFactory_SaveDataCheck::Open(const Path& path) { | ||||
|     auto vec = path.AsBinary(); | ||||
|     const u32* data = reinterpret_cast<u32*>(vec.data()); | ||||
|     std::string file_path = GetSaveDataCheckPath(mount_point, data[1], data[0]); | ||||
|     FileUtil::IOFile file(file_path, "rb"); | ||||
| 
 | ||||
|     std::fill(raw_data.begin(), raw_data.end(), 0); | ||||
| 
 | ||||
|     if (!file.IsOpen()) { | ||||
|         return ResultCode(-1); // TODO(Subv): Find the right error code
 | ||||
|     } | ||||
|     auto size = file.GetSize(); | ||||
|     raw_data.resize(size); | ||||
|     file.ReadBytes(raw_data.data(), size); | ||||
|     auto raw_data = std::make_shared<std::vector<u8>>(size); | ||||
|     file.ReadBytes(raw_data->data(), size); | ||||
|     file.Close(); | ||||
|     return RESULT_SUCCESS; | ||||
| 
 | ||||
|     auto archive = Common::make_unique<IVFCArchive>(std::move(raw_data)); | ||||
|     return MakeResult<std::unique_ptr<ArchiveBackend>>(std::move(archive)); | ||||
| } | ||||
| 
 | ||||
| ResultCode ArchiveFactory_SaveDataCheck::Format(const Path& path) { | ||||
|     LOG_ERROR(Service_FS, "Attempted to format a SaveDataCheck archive."); | ||||
|     // TODO: Verify error code
 | ||||
|     return ResultCode(ErrorDescription::NotAuthorized, ErrorModule::FS, | ||||
|         ErrorSummary::NotSupported, ErrorLevel::Permanent); | ||||
| } | ||||
| 
 | ||||
| } // namespace FileSys
 | ||||
|  |  | |||
|  | @ -17,12 +17,14 @@ | |||
| namespace FileSys { | ||||
| 
 | ||||
| /// File system interface to the SaveDataCheck archive
 | ||||
| class Archive_SaveDataCheck final : public IVFCArchive { | ||||
| class ArchiveFactory_SaveDataCheck final : public ArchiveFactory { | ||||
| public: | ||||
|     Archive_SaveDataCheck(const std::string& mount_point); | ||||
|     ArchiveFactory_SaveDataCheck(const std::string& mount_point); | ||||
| 
 | ||||
|     std::string GetName() const override { return "SaveDataCheck"; } | ||||
|     ResultCode Open(const Path& path) override; | ||||
| 
 | ||||
|     ResultVal<std::unique_ptr<ArchiveBackend>> Open(const Path& path) override; | ||||
|     ResultCode Format(const Path& path) override; | ||||
| 
 | ||||
| private: | ||||
|     std::string mount_point; | ||||
|  |  | |||
|  | @ -6,6 +6,7 @@ | |||
| 
 | ||||
| #include "common/common_types.h" | ||||
| #include "common/file_util.h" | ||||
| #include "common/make_unique.h" | ||||
| 
 | ||||
| #include "core/file_sys/archive_sdmc.h" | ||||
| #include "core/file_sys/disk_archive.h" | ||||
|  | @ -16,17 +17,17 @@ | |||
| 
 | ||||
| namespace FileSys { | ||||
| 
 | ||||
| Archive_SDMC::Archive_SDMC(const std::string& sdmc_directory) : DiskArchive(sdmc_directory) { | ||||
| ArchiveFactory_SDMC::ArchiveFactory_SDMC(const std::string& sdmc_directory) : sdmc_directory(sdmc_directory) { | ||||
|     LOG_INFO(Service_FS, "Directory %s set as SDMC.", sdmc_directory.c_str()); | ||||
| } | ||||
| 
 | ||||
| bool Archive_SDMC::Initialize() { | ||||
| bool ArchiveFactory_SDMC::Initialize() { | ||||
|     if (!Settings::values.use_virtual_sd) { | ||||
|         LOG_WARNING(Service_FS, "SDMC disabled by config."); | ||||
|         return false; | ||||
|     } | ||||
| 
 | ||||
|     if (!FileUtil::CreateFullPath(mount_point)) { | ||||
|     if (!FileUtil::CreateFullPath(sdmc_directory)) { | ||||
|         LOG_ERROR(Service_FS, "Unable to create SDMC path."); | ||||
|         return false; | ||||
|     } | ||||
|  | @ -34,4 +35,14 @@ bool Archive_SDMC::Initialize() { | |||
|     return true; | ||||
| } | ||||
| 
 | ||||
| ResultVal<std::unique_ptr<ArchiveBackend>> ArchiveFactory_SDMC::Open(const Path& path) { | ||||
|     auto archive = Common::make_unique<DiskArchive>(sdmc_directory); | ||||
|     return MakeResult<std::unique_ptr<ArchiveBackend>>(std::move(archive)); | ||||
| } | ||||
| 
 | ||||
| ResultCode ArchiveFactory_SDMC::Format(const Path& path) { | ||||
|     // This is kind of an undesirable operation, so let's just ignore it. :)
 | ||||
|     return RESULT_SUCCESS; | ||||
| } | ||||
| 
 | ||||
| } // namespace FileSys
 | ||||
|  |  | |||
|  | @ -15,9 +15,9 @@ | |||
| namespace FileSys { | ||||
| 
 | ||||
| /// File system interface to the SDMC archive
 | ||||
| class Archive_SDMC final : public DiskArchive { | ||||
| class ArchiveFactory_SDMC final : public ArchiveFactory { | ||||
| public: | ||||
|     Archive_SDMC(const std::string& mount_point); | ||||
|     ArchiveFactory_SDMC(const std::string& mount_point); | ||||
| 
 | ||||
|     /**
 | ||||
|      * Initialize the archive. | ||||
|  | @ -26,6 +26,12 @@ public: | |||
|     bool Initialize(); | ||||
| 
 | ||||
|     std::string GetName() const override { return "SDMC"; } | ||||
| 
 | ||||
|     ResultVal<std::unique_ptr<ArchiveBackend>> Open(const Path& path) override; | ||||
|     ResultCode Format(const Path& path) override; | ||||
| 
 | ||||
| private: | ||||
|     std::string sdmc_directory; | ||||
| }; | ||||
| 
 | ||||
| } // namespace FileSys
 | ||||
|  |  | |||
|  | @ -18,26 +18,26 @@ namespace FileSys { | |||
| 
 | ||||
| std::unique_ptr<FileBackend> DiskArchive::OpenFile(const Path& path, const Mode mode) const { | ||||
|     LOG_DEBUG(Service_FS, "called path=%s mode=%01X", path.DebugStr().c_str(), mode.hex); | ||||
|     auto file = Common::make_unique<DiskFile>(this, path, mode); | ||||
|     auto file = Common::make_unique<DiskFile>(*this, path, mode); | ||||
|     if (!file->Open()) | ||||
|         return nullptr; | ||||
|     return std::move(file); | ||||
| } | ||||
| 
 | ||||
| bool DiskArchive::DeleteFile(const Path& path) const { | ||||
|     return FileUtil::Delete(GetMountPoint() + path.AsString()); | ||||
|     return FileUtil::Delete(mount_point + path.AsString()); | ||||
| } | ||||
| 
 | ||||
| bool DiskArchive::RenameFile(const Path& src_path, const Path& dest_path) const { | ||||
|     return FileUtil::Rename(GetMountPoint() + src_path.AsString(), GetMountPoint() + dest_path.AsString()); | ||||
|     return FileUtil::Rename(mount_point + src_path.AsString(), mount_point + dest_path.AsString()); | ||||
| } | ||||
| 
 | ||||
| bool DiskArchive::DeleteDirectory(const Path& path) const { | ||||
|     return FileUtil::DeleteDir(GetMountPoint() + path.AsString()); | ||||
|     return FileUtil::DeleteDir(mount_point + path.AsString()); | ||||
| } | ||||
| 
 | ||||
| ResultCode DiskArchive::CreateFile(const FileSys::Path& path, u32 size) const { | ||||
|     std::string full_path = GetMountPoint() + path.AsString(); | ||||
|     std::string full_path = mount_point + path.AsString(); | ||||
| 
 | ||||
|     if (FileUtil::Exists(full_path)) | ||||
|         return ResultCode(ErrorDescription::AlreadyExists, ErrorModule::FS, ErrorSummary::NothingHappened, ErrorLevel::Info); | ||||
|  | @ -58,16 +58,16 @@ ResultCode DiskArchive::CreateFile(const FileSys::Path& path, u32 size) const { | |||
| 
 | ||||
| 
 | ||||
| bool DiskArchive::CreateDirectory(const Path& path) const { | ||||
|     return FileUtil::CreateDir(GetMountPoint() + path.AsString()); | ||||
|     return FileUtil::CreateDir(mount_point + path.AsString()); | ||||
| } | ||||
| 
 | ||||
| bool DiskArchive::RenameDirectory(const Path& src_path, const Path& dest_path) const { | ||||
|     return FileUtil::Rename(GetMountPoint() + src_path.AsString(), GetMountPoint() + dest_path.AsString()); | ||||
|     return FileUtil::Rename(mount_point + src_path.AsString(), mount_point + dest_path.AsString()); | ||||
| } | ||||
| 
 | ||||
| std::unique_ptr<DirectoryBackend> DiskArchive::OpenDirectory(const Path& path) const { | ||||
|     LOG_DEBUG(Service_FS, "called path=%s", path.DebugStr().c_str()); | ||||
|     auto directory = Common::make_unique<DiskDirectory>(this, path); | ||||
|     auto directory = Common::make_unique<DiskDirectory>(*this, path); | ||||
|     if (!directory->Open()) | ||||
|         return nullptr; | ||||
|     return std::move(directory); | ||||
|  | @ -75,13 +75,12 @@ std::unique_ptr<DirectoryBackend> DiskArchive::OpenDirectory(const Path& path) c | |||
| 
 | ||||
| ////////////////////////////////////////////////////////////////////////////////////////////////////
 | ||||
| 
 | ||||
| DiskFile::DiskFile(const DiskArchive* archive, const Path& path, const Mode mode) { | ||||
| DiskFile::DiskFile(const DiskArchive& archive, const Path& path, const Mode mode) { | ||||
|     // TODO(Link Mauve): normalize path into an absolute path without "..", it can currently bypass
 | ||||
|     // the root directory we set while opening the archive.
 | ||||
|     // For example, opening /../../etc/passwd can give the emulated program your users list.
 | ||||
|     this->path = archive->GetMountPoint() + path.AsString(); | ||||
|     this->path = archive.mount_point + path.AsString(); | ||||
|     this->mode.hex = mode.hex; | ||||
|     this->archive = archive; | ||||
| } | ||||
| 
 | ||||
| bool DiskFile::Open() { | ||||
|  | @ -134,12 +133,11 @@ bool DiskFile::Close() const { | |||
| 
 | ||||
| ////////////////////////////////////////////////////////////////////////////////////////////////////
 | ||||
| 
 | ||||
| DiskDirectory::DiskDirectory(const DiskArchive* archive, const Path& path) { | ||||
| DiskDirectory::DiskDirectory(const DiskArchive& archive, const Path& path) { | ||||
|     // TODO(Link Mauve): normalize path into an absolute path without "..", it can currently bypass
 | ||||
|     // the root directory we set while opening the archive.
 | ||||
|     // For example, opening /../../usr/bin can give the emulated program your installed programs.
 | ||||
|     this->path = archive->GetMountPoint() + path.AsString(); | ||||
|     this->archive = archive; | ||||
|     this->path = archive.mount_point + path.AsString(); | ||||
| } | ||||
| 
 | ||||
| bool DiskDirectory::Open() { | ||||
|  |  | |||
|  | @ -24,8 +24,8 @@ class DiskArchive : public ArchiveBackend { | |||
| public: | ||||
|     DiskArchive(const std::string& mount_point_) : mount_point(mount_point_) {} | ||||
| 
 | ||||
|     virtual std::string GetName() const = 0; | ||||
|     virtual ResultCode Format(const Path& path) const { return RESULT_SUCCESS; } | ||||
|     virtual std::string GetName() const { return "DiskArchive: " + mount_point; } | ||||
| 
 | ||||
|     std::unique_ptr<FileBackend> OpenFile(const Path& path, const Mode mode) const override; | ||||
|     bool DeleteFile(const Path& path) const override; | ||||
|     bool RenameFile(const Path& src_path, const Path& dest_path) const override; | ||||
|  | @ -35,26 +35,17 @@ public: | |||
|     bool RenameDirectory(const Path& src_path, const Path& dest_path) const override; | ||||
|     std::unique_ptr<DirectoryBackend> OpenDirectory(const Path& path) const override; | ||||
| 
 | ||||
|     virtual ResultCode Open(const Path& path) override { | ||||
|         return RESULT_SUCCESS; | ||||
|     } | ||||
| 
 | ||||
|     /**
 | ||||
|      * Getter for the path used for this Archive | ||||
|      * @return Mount point of that passthrough archive | ||||
|      */ | ||||
|     virtual const std::string& GetMountPoint() const { | ||||
|         return mount_point; | ||||
|     } | ||||
| 
 | ||||
| protected: | ||||
|     friend class DiskFile; | ||||
|     friend class DiskDirectory; | ||||
| 
 | ||||
|     std::string mount_point; | ||||
| }; | ||||
| 
 | ||||
| class DiskFile : public FileBackend { | ||||
| public: | ||||
|     DiskFile(); | ||||
|     DiskFile(const DiskArchive* archive, const Path& path, const Mode mode); | ||||
|     DiskFile(const DiskArchive& archive, const Path& path, const Mode mode); | ||||
| 
 | ||||
|     bool Open() override; | ||||
|     size_t Read(const u64 offset, const u32 length, u8* buffer) const override; | ||||
|  | @ -68,7 +59,6 @@ public: | |||
|     } | ||||
| 
 | ||||
| protected: | ||||
|     const DiskArchive* archive; | ||||
|     std::string path; | ||||
|     Mode mode; | ||||
|     std::unique_ptr<FileUtil::IOFile> file; | ||||
|  | @ -77,7 +67,7 @@ protected: | |||
| class DiskDirectory : public DirectoryBackend { | ||||
| public: | ||||
|     DiskDirectory(); | ||||
|     DiskDirectory(const DiskArchive* archive, const Path& path); | ||||
|     DiskDirectory(const DiskArchive& archive, const Path& path); | ||||
| 
 | ||||
|     ~DiskDirectory() override { | ||||
|         Close(); | ||||
|  | @ -91,7 +81,6 @@ public: | |||
|     } | ||||
| 
 | ||||
| protected: | ||||
|     const DiskArchive* archive; | ||||
|     std::string path; | ||||
|     u32 total_entries_in_directory; | ||||
|     FileUtil::FSTEntry directory; | ||||
|  |  | |||
|  | @ -15,11 +15,15 @@ | |||
| 
 | ||||
| namespace FileSys { | ||||
| 
 | ||||
| IVFCArchive::IVFCArchive() { | ||||
| IVFCArchive::IVFCArchive(std::shared_ptr<const std::vector<u8>> data) : data(data) { | ||||
| } | ||||
| 
 | ||||
| std::string IVFCArchive::GetName() const { | ||||
|     return "IVFC"; | ||||
| } | ||||
| 
 | ||||
| std::unique_ptr<FileBackend> IVFCArchive::OpenFile(const Path& path, const Mode mode) const { | ||||
|     return Common::make_unique<IVFCFile>(this); | ||||
|     return Common::make_unique<IVFCFile>(data); | ||||
| } | ||||
| 
 | ||||
| bool IVFCArchive::DeleteFile(const Path& path) const { | ||||
|  | @ -57,31 +61,25 @@ std::unique_ptr<DirectoryBackend> IVFCArchive::OpenDirectory(const Path& path) c | |||
|     return Common::make_unique<IVFCDirectory>(); | ||||
| } | ||||
| 
 | ||||
| ResultCode IVFCArchive::Format(const Path& path) const { | ||||
|     LOG_CRITICAL(Service_FS, "Attempted to format an IVFC archive (%s).", GetName().c_str()); | ||||
|     // TODO: Verify error code
 | ||||
|     return ResultCode(ErrorDescription::NotAuthorized, ErrorModule::FS, ErrorSummary::NotSupported, ErrorLevel::Permanent); | ||||
| } | ||||
| 
 | ||||
| ////////////////////////////////////////////////////////////////////////////////////////////////////
 | ||||
| 
 | ||||
| size_t IVFCFile::Read(const u64 offset, const u32 length, u8* buffer) const { | ||||
|     LOG_TRACE(Service_FS, "called offset=%llu, length=%d", offset, length); | ||||
|     memcpy(buffer, &archive->raw_data[(u32)offset], length); | ||||
|     memcpy(buffer, data->data() + offset, length); | ||||
|     return length; | ||||
| } | ||||
| 
 | ||||
| size_t IVFCFile::Write(const u64 offset, const u32 length, const u32 flush, const u8* buffer) const { | ||||
|     LOG_CRITICAL(Service_FS, "Attempted to write to IVFC file in archive %s.", archive->GetName().c_str()); | ||||
|     LOG_ERROR(Service_FS, "Attempted to write to IVFC file"); | ||||
|     return 0; | ||||
| } | ||||
| 
 | ||||
| size_t IVFCFile::GetSize() const { | ||||
|     return sizeof(u8) * archive->raw_data.size(); | ||||
|     return sizeof(u8) * data->size(); | ||||
| } | ||||
| 
 | ||||
| bool IVFCFile::SetSize(const u64 size) const { | ||||
|     LOG_CRITICAL(Service_FS, "Attempted to set the size of an IVFC file in archive %s", archive->GetName().c_str()); | ||||
|     LOG_ERROR(Service_FS, "Attempted to set the size of an IVFC file"); | ||||
|     return false; | ||||
| } | ||||
| 
 | ||||
|  |  | |||
|  | @ -4,6 +4,7 @@ | |||
| 
 | ||||
| #pragma once | ||||
| 
 | ||||
| #include <memory> | ||||
| #include <vector> | ||||
| 
 | ||||
| #include "common/common_types.h" | ||||
|  | @ -23,7 +24,9 @@ namespace FileSys { | |||
|  */ | ||||
| class IVFCArchive : public ArchiveBackend { | ||||
| public: | ||||
|     IVFCArchive(); | ||||
|     IVFCArchive(std::shared_ptr<const std::vector<u8>> data); | ||||
| 
 | ||||
|     std::string GetName() const override; | ||||
| 
 | ||||
|     std::unique_ptr<FileBackend> OpenFile(const Path& path, const Mode mode) const override; | ||||
|     bool DeleteFile(const Path& path) const override; | ||||
|  | @ -33,16 +36,14 @@ public: | |||
|     bool CreateDirectory(const Path& path) const override; | ||||
|     bool RenameDirectory(const Path& src_path, const Path& dest_path) const override; | ||||
|     std::unique_ptr<DirectoryBackend> OpenDirectory(const Path& path) const override; | ||||
|     ResultCode Format(const Path& path) const override; | ||||
| 
 | ||||
| protected: | ||||
|     friend class IVFCFile; | ||||
|     std::vector<u8> raw_data; | ||||
|     std::shared_ptr<const std::vector<u8>> data; | ||||
| }; | ||||
| 
 | ||||
| class IVFCFile : public FileBackend { | ||||
| public: | ||||
|     IVFCFile(const IVFCArchive* archive) : archive(archive) {} | ||||
|     IVFCFile(std::shared_ptr<const std::vector<u8>> data) : data(data) {} | ||||
| 
 | ||||
|     bool Open() override { return true; } | ||||
|     size_t Read(const u64 offset, const u32 length, u8* buffer) const override; | ||||
|  | @ -53,7 +54,7 @@ public: | |||
|     void Flush() const override { } | ||||
| 
 | ||||
| private: | ||||
|     const IVFCArchive* archive; | ||||
|     std::shared_ptr<const std::vector<u8>> data; | ||||
| }; | ||||
| 
 | ||||
| class IVFCDirectory : public DirectoryBackend { | ||||
|  |  | |||
|  | @ -5,6 +5,8 @@ | |||
| #include <memory> | ||||
| #include <unordered_map> | ||||
| 
 | ||||
| #include <boost/container/flat_map.hpp> | ||||
| 
 | ||||
| #include "common/common_types.h" | ||||
| #include "common/file_util.h" | ||||
| #include "common/make_unique.h" | ||||
|  | @ -233,22 +235,23 @@ public: | |||
| ////////////////////////////////////////////////////////////////////////////////////////////////////
 | ||||
| 
 | ||||
| using FileSys::ArchiveBackend; | ||||
| using FileSys::ArchiveFactory; | ||||
| 
 | ||||
| /**
 | ||||
|  * Map of registered archives, identified by id code. Once an archive is registered here, it is | ||||
|  * never removed until the FS service is shut down. | ||||
|  */ | ||||
| static std::unordered_map<ArchiveIdCode, std::unique_ptr<ArchiveBackend>> id_code_map; | ||||
| static boost::container::flat_map<ArchiveIdCode, std::unique_ptr<ArchiveFactory>> id_code_map; | ||||
| 
 | ||||
| /**
 | ||||
|  * Map of active archive handles. Values are pointers to the archives in `idcode_map`. | ||||
|  */ | ||||
| static std::unordered_map<ArchiveHandle, ArchiveBackend*> handle_map; | ||||
| static std::unordered_map<ArchiveHandle, std::unique_ptr<ArchiveBackend>> handle_map; | ||||
| static ArchiveHandle next_handle; | ||||
| 
 | ||||
| static ArchiveBackend* GetArchive(ArchiveHandle handle) { | ||||
|     auto itr = handle_map.find(handle); | ||||
|     return (itr == handle_map.end()) ? nullptr : itr->second; | ||||
|     return (itr == handle_map.end()) ? nullptr : itr->second.get(); | ||||
| } | ||||
| 
 | ||||
| ResultVal<ArchiveHandle> OpenArchive(ArchiveIdCode id_code, FileSys::Path& archive_path) { | ||||
|  | @ -261,15 +264,13 @@ ResultVal<ArchiveHandle> OpenArchive(ArchiveIdCode id_code, FileSys::Path& archi | |||
|                           ErrorSummary::NotFound, ErrorLevel::Permanent); | ||||
|     } | ||||
| 
 | ||||
|     ResultCode res = itr->second->Open(archive_path); | ||||
|     if (!res.IsSuccess()) | ||||
|         return res; | ||||
|     CASCADE_RESULT(std::unique_ptr<ArchiveBackend> res, itr->second->Open(archive_path)); | ||||
| 
 | ||||
|     // This should never even happen in the first place with 64-bit handles, 
 | ||||
|     while (handle_map.count(next_handle) != 0) { | ||||
|         ++next_handle; | ||||
|     } | ||||
|     handle_map.emplace(next_handle, itr->second.get()); | ||||
|     handle_map.emplace(next_handle, std::move(res)); | ||||
|     return MakeResult<ArchiveHandle>(next_handle++); | ||||
| } | ||||
| 
 | ||||
|  | @ -282,11 +283,11 @@ ResultCode CloseArchive(ArchiveHandle handle) { | |||
| 
 | ||||
| // TODO(yuriks): This might be what the fs:REG service is for. See the Register/Unregister calls in
 | ||||
| // http://3dbrew.org/wiki/Filesystem_services#ProgramRegistry_service_.22fs:REG.22
 | ||||
| ResultCode CreateArchive(std::unique_ptr<FileSys::ArchiveBackend>&& backend, ArchiveIdCode id_code) { | ||||
|     auto result = id_code_map.emplace(id_code, std::move(backend)); | ||||
| ResultCode RegisterArchiveType(std::unique_ptr<FileSys::ArchiveFactory>&& factory, ArchiveIdCode id_code) { | ||||
|     auto result = id_code_map.emplace(id_code, std::move(factory)); | ||||
| 
 | ||||
|     bool inserted = result.second; | ||||
|     _dbg_assert_msg_(Service_FS, inserted, "Tried to register more than one archive with same id code"); | ||||
|     _assert_msg_(Service_FS, inserted, "Tried to register more than one archive with same id code"); | ||||
| 
 | ||||
|     auto& archive = result.first->second; | ||||
|     LOG_DEBUG(Service_FS, "Registered archive %s with id code 0x%08X", archive->GetName().c_str(), id_code); | ||||
|  | @ -450,32 +451,32 @@ void ArchiveInit() { | |||
| 
 | ||||
|     std::string sdmc_directory = FileUtil::GetUserPath(D_SDMC_IDX); | ||||
|     std::string nand_directory = FileUtil::GetUserPath(D_NAND_IDX); | ||||
|     auto sdmc_archive = Common::make_unique<FileSys::Archive_SDMC>(sdmc_directory); | ||||
|     if (sdmc_archive->Initialize()) | ||||
|         CreateArchive(std::move(sdmc_archive), ArchiveIdCode::SDMC); | ||||
|     auto sdmc_factory = Common::make_unique<FileSys::ArchiveFactory_SDMC>(sdmc_directory); | ||||
|     if (sdmc_factory->Initialize()) | ||||
|         RegisterArchiveType(std::move(sdmc_factory), ArchiveIdCode::SDMC); | ||||
|     else | ||||
|         LOG_ERROR(Service_FS, "Can't instantiate SDMC archive with path %s", sdmc_directory.c_str()); | ||||
|      | ||||
|     // Create the SaveData archive
 | ||||
|     auto savedata_archive = Common::make_unique<FileSys::Archive_SaveData>(sdmc_directory); | ||||
|     CreateArchive(std::move(savedata_archive), ArchiveIdCode::SaveData); | ||||
|     auto savedata_factory = Common::make_unique<FileSys::ArchiveFactory_SaveData>(sdmc_directory); | ||||
|     RegisterArchiveType(std::move(savedata_factory), ArchiveIdCode::SaveData); | ||||
| 
 | ||||
|     auto extsavedata_archive = Common::make_unique<FileSys::Archive_ExtSaveData>(sdmc_directory, false); | ||||
|     if (extsavedata_archive->Initialize()) | ||||
|         CreateArchive(std::move(extsavedata_archive), ArchiveIdCode::ExtSaveData); | ||||
|     auto extsavedata_factory = Common::make_unique<FileSys::ArchiveFactory_ExtSaveData>(sdmc_directory, false); | ||||
|     if (extsavedata_factory->Initialize()) | ||||
|         RegisterArchiveType(std::move(extsavedata_factory), ArchiveIdCode::ExtSaveData); | ||||
|     else | ||||
|         LOG_ERROR(Service_FS, "Can't instantiate ExtSaveData archive with path %s", extsavedata_archive->GetMountPoint().c_str()); | ||||
|         LOG_ERROR(Service_FS, "Can't instantiate ExtSaveData archive with path %s", extsavedata_factory->GetMountPoint().c_str()); | ||||
| 
 | ||||
|     auto sharedextsavedata_archive = Common::make_unique<FileSys::Archive_ExtSaveData>(nand_directory, true); | ||||
|     if (sharedextsavedata_archive->Initialize()) | ||||
|         CreateArchive(std::move(sharedextsavedata_archive), ArchiveIdCode::SharedExtSaveData); | ||||
|     auto sharedextsavedata_factory = Common::make_unique<FileSys::ArchiveFactory_ExtSaveData>(nand_directory, true); | ||||
|     if (sharedextsavedata_factory->Initialize()) | ||||
|         RegisterArchiveType(std::move(sharedextsavedata_factory), ArchiveIdCode::SharedExtSaveData); | ||||
|     else | ||||
|         LOG_ERROR(Service_FS, "Can't instantiate SharedExtSaveData archive with path %s",  | ||||
|             sharedextsavedata_archive->GetMountPoint().c_str()); | ||||
|             sharedextsavedata_factory->GetMountPoint().c_str()); | ||||
| 
 | ||||
|     // Create the SaveDataCheck archive, basically a small variation of the RomFS archive
 | ||||
|     auto savedatacheck_archive = Common::make_unique<FileSys::Archive_SaveDataCheck>(nand_directory); | ||||
|     CreateArchive(std::move(savedatacheck_archive), ArchiveIdCode::SaveDataCheck); | ||||
|     auto savedatacheck_factory = Common::make_unique<FileSys::ArchiveFactory_SaveDataCheck>(nand_directory); | ||||
|     RegisterArchiveType(std::move(savedatacheck_factory), ArchiveIdCode::SaveDataCheck); | ||||
| } | ||||
| 
 | ||||
| /// Shutdown archives
 | ||||
|  |  | |||
|  | @ -51,11 +51,11 @@ ResultVal<ArchiveHandle> OpenArchive(ArchiveIdCode id_code, FileSys::Path& archi | |||
| ResultCode CloseArchive(ArchiveHandle handle); | ||||
| 
 | ||||
| /**
 | ||||
|  * Creates an Archive | ||||
|  * Registers an Archive type, instances of which can later be opened using its IdCode. | ||||
|  * @param backend File system backend interface to the archive | ||||
|  * @param id_code Id code used to access this type of archive | ||||
|  */ | ||||
| ResultCode CreateArchive(std::unique_ptr<FileSys::ArchiveBackend>&& backend, ArchiveIdCode id_code); | ||||
| ResultCode RegisterArchiveType(std::unique_ptr<FileSys::ArchiveFactory>&& factory, ArchiveIdCode id_code); | ||||
| 
 | ||||
| /**
 | ||||
|  * Open a File from an Archive | ||||
|  |  | |||
|  | @ -4,8 +4,9 @@ | |||
| 
 | ||||
| #include "common/log.h" | ||||
| #include "common/make_unique.h" | ||||
| #include "core/file_sys/archive_extsavedata.h" | ||||
| 
 | ||||
| #include "core/hle/hle.h" | ||||
| #include "core/hle/service/fs/archive.h" | ||||
| #include "core/hle/service/ptm_u.h" | ||||
| 
 | ||||
| ////////////////////////////////////////////////////////////////////////////////////////////////////
 | ||||
|  | @ -28,7 +29,6 @@ struct GameCoin { | |||
|     u8 day; | ||||
| }; | ||||
| static const GameCoin default_game_coin = { 0x4F00, 42, 0, 0, 0, 2014, 12, 29 }; | ||||
| static std::unique_ptr<FileSys::Archive_ExtSaveData> ptm_shared_extsavedata; | ||||
| static const std::vector<u8> ptm_shared_extdata_id = {0, 0, 0, 0, 0x0B, 0, 0, 0xF0, 0, 0, 0, 0}; | ||||
| 
 | ||||
| /// Charge levels used by PTM functions
 | ||||
|  | @ -138,6 +138,10 @@ const Interface::FunctionInfo FunctionTable[] = { | |||
| 
 | ||||
| Interface::Interface() { | ||||
|     Register(FunctionTable); | ||||
| 
 | ||||
|     // TODO(Subv): This code needs to be updated to not directly create archives and use the
 | ||||
|     //             standard archive.h interfaces.
 | ||||
| #if 0 | ||||
|     // Create the SharedExtSaveData archive 0xF000000B and the gamecoin.dat file
 | ||||
|     // TODO(Subv): In the future we should use the FS service to query this archive
 | ||||
|     std::string nand_directory = FileUtil::GetUserPath(D_NAND_IDX); | ||||
|  | @ -165,6 +169,7 @@ Interface::Interface() { | |||
|             gamecoin->Close(); | ||||
|         } | ||||
|     } | ||||
| #endif | ||||
| } | ||||
| 
 | ||||
| } // namespace
 | ||||
|  |  | |||
|  | @ -127,7 +127,7 @@ ResultStatus LoadFile(const std::string& filename) { | |||
|         // Load application and RomFS
 | ||||
|         if (ResultStatus::Success == app_loader.Load()) { | ||||
|             Kernel::g_program_id = app_loader.GetProgramId(); | ||||
|             Service::FS::CreateArchive(Common::make_unique<FileSys::Archive_RomFS>(app_loader), Service::FS::ArchiveIdCode::RomFS); | ||||
|             Service::FS::RegisterArchiveType(Common::make_unique<FileSys::ArchiveFactory_RomFS>(app_loader), Service::FS::ArchiveIdCode::RomFS); | ||||
|             return ResultStatus::Success; | ||||
|         } | ||||
|         break; | ||||
|  |  | |||
		Loading…
	
	Add table
		Add a link
		
	
		Reference in a new issue