file_sys: Repurpose 3DS IVFC code for Switch ROMFS.

src/core/CMakeLists.txt

@@ -13,10 +13,10 @@ add_library(core STATIC
     file_sys/disk_archive.h
     file_sys/errors.h
     file_sys/file_backend.h
-    file_sys/ivfc_archive.cpp
-    file_sys/ivfc_archive.h
     file_sys/path_parser.cpp
     file_sys/path_parser.h
+    file_sys/romfs_archive.cpp
+    file_sys/romfs_archive.h
     file_sys/savedata_archive.cpp
     file_sys/savedata_archive.h
     file_sys/title_metadata.cpp

src/core/file_sys/romfs_archive.cpp

@@ -1,4 +1,4 @@
-// Copyright 2014 Citra Emulator Project
+// Copyright 2018 yuzu emulator team
 // Licensed under GPLv2 or any later version
 // Refer to the license.txt file included.
 
@@ -6,84 +6,79 @@
 #include <memory>
 #include "common/common_types.h"
 #include "common/logging/log.h"
-#include "core/file_sys/ivfc_archive.h"
+#include "core/file_sys/romfs_archive.h"
-
-////////////////////////////////////////////////////////////////////////////////////////////////////
-// FileSys namespace
 
 namespace FileSys {
 
-std::string IVFCArchive::GetName() const {
+std::string ROMFSArchive::GetName() const {
-    return "IVFC";
+    return "RomFS";
 }
 
-ResultVal<std::unique_ptr<FileBackend>> IVFCArchive::OpenFile(const Path& path,
+ResultVal<std::unique_ptr<FileBackend>> ROMFSArchive::OpenFile(const Path& path,
                                                                const Mode& mode) const {
     return MakeResult<std::unique_ptr<FileBackend>>(
-        std::make_unique<IVFCFile>(romfs_file, data_offset, data_size));
+        std::make_unique<ROMFSFile>(romfs_file, data_offset, data_size));
 }
 
-ResultCode IVFCArchive::DeleteFile(const Path& path) const {
+ResultCode ROMFSArchive::DeleteFile(const Path& path) const {
-    LOG_CRITICAL(Service_FS, "Attempted to delete a file from an IVFC archive (%s).",
+    LOG_CRITICAL(Service_FS, "Attempted to delete a file from an ROMFS archive (%s).",
                  GetName().c_str());
     // TODO(bunnei): Use correct error code
     return ResultCode(-1);
 }
 
-ResultCode IVFCArchive::RenameFile(const Path& src_path, const Path& dest_path) const {
+ResultCode ROMFSArchive::RenameFile(const Path& src_path, const Path& dest_path) const {
-    LOG_CRITICAL(Service_FS, "Attempted to rename a file within an IVFC archive (%s).",
+    LOG_CRITICAL(Service_FS, "Attempted to rename a file within an ROMFS archive (%s).",
                  GetName().c_str());
     // TODO(wwylele): Use correct error code
     return ResultCode(-1);
 }
 
-ResultCode IVFCArchive::DeleteDirectory(const Path& path) const {
+ResultCode ROMFSArchive::DeleteDirectory(const Path& path) const {
-    LOG_CRITICAL(Service_FS, "Attempted to delete a directory from an IVFC archive (%s).",
+    LOG_CRITICAL(Service_FS, "Attempted to delete a directory from an ROMFS archive (%s).",
                  GetName().c_str());
     // TODO(wwylele): Use correct error code
     return ResultCode(-1);
 }
 
-ResultCode IVFCArchive::DeleteDirectoryRecursively(const Path& path) const {
+ResultCode ROMFSArchive::DeleteDirectoryRecursively(const Path& path) const {
-    LOG_CRITICAL(Service_FS, "Attempted to delete a directory from an IVFC archive (%s).",
+    LOG_CRITICAL(Service_FS, "Attempted to delete a directory from an ROMFS archive (%s).",
                  GetName().c_str());
     // TODO(wwylele): Use correct error code
     return ResultCode(-1);
 }
 
-ResultCode IVFCArchive::CreateFile(const Path& path, u64 size) const {
+ResultCode ROMFSArchive::CreateFile(const Path& path, u64 size) const {
-    LOG_CRITICAL(Service_FS, "Attempted to create a file in an IVFC archive (%s).",
+    LOG_CRITICAL(Service_FS, "Attempted to create a file in an ROMFS archive (%s).",
                  GetName().c_str());
     // TODO(bunnei): Use correct error code
     return ResultCode(-1);
 }
 
-ResultCode IVFCArchive::CreateDirectory(const Path& path) const {
+ResultCode ROMFSArchive::CreateDirectory(const Path& path) const {
-    LOG_CRITICAL(Service_FS, "Attempted to create a directory in an IVFC archive (%s).",
+    LOG_CRITICAL(Service_FS, "Attempted to create a directory in an ROMFS archive (%s).",
                  GetName().c_str());
     // TODO(wwylele): Use correct error code
     return ResultCode(-1);
 }
 
-ResultCode IVFCArchive::RenameDirectory(const Path& src_path, const Path& dest_path) const {
+ResultCode ROMFSArchive::RenameDirectory(const Path& src_path, const Path& dest_path) const {
-    LOG_CRITICAL(Service_FS, "Attempted to rename a file within an IVFC archive (%s).",
+    LOG_CRITICAL(Service_FS, "Attempted to rename a file within an ROMFS archive (%s).",
                  GetName().c_str());
     // TODO(wwylele): Use correct error code
     return ResultCode(-1);
 }
 
-ResultVal<std::unique_ptr<DirectoryBackend>> IVFCArchive::OpenDirectory(const Path& path) const {
+ResultVal<std::unique_ptr<DirectoryBackend>> ROMFSArchive::OpenDirectory(const Path& path) const {
-    return MakeResult<std::unique_ptr<DirectoryBackend>>(std::make_unique<IVFCDirectory>());
+    return MakeResult<std::unique_ptr<DirectoryBackend>>(std::make_unique<ROMFSDirectory>());
 }
 
-u64 IVFCArchive::GetFreeBytes() const {
+u64 ROMFSArchive::GetFreeBytes() const {
-    LOG_WARNING(Service_FS, "Attempted to get the free space in an IVFC archive");
+    LOG_WARNING(Service_FS, "Attempted to get the free space in an ROMFS archive");
     return 0;
 }
 
-////////////////////////////////////////////////////////////////////////////////////////////////////
+ResultVal<size_t> ROMFSFile::Read(const u64 offset, const size_t length, u8* buffer) const {
-
-ResultVal<size_t> IVFCFile::Read(const u64 offset, const size_t length, u8* buffer) const {
     LOG_TRACE(Service_FS, "called offset=%llu, length=%zu", offset, length);
     romfs_file->Seek(data_offset + offset, SEEK_SET);
     size_t read_length = (size_t)std::min((u64)length, data_size - offset);
@@ -91,19 +86,19 @@ ResultVal<size_t> IVFCFile::Read(const u64 offset, const size_t length, u8* buff
     return MakeResult<size_t>(romfs_file->ReadBytes(buffer, read_length));
 }
 
-ResultVal<size_t> IVFCFile::Write(const u64 offset, const size_t length, const bool flush,
+ResultVal<size_t> ROMFSFile::Write(const u64 offset, const size_t length, const bool flush,
                                    const u8* buffer) const {
-    LOG_ERROR(Service_FS, "Attempted to write to IVFC file");
+    LOG_ERROR(Service_FS, "Attempted to write to ROMFS file");
     // TODO(Subv): Find error code
     return MakeResult<size_t>(0);
 }
 
-u64 IVFCFile::GetSize() const {
+u64 ROMFSFile::GetSize() const {
     return data_size;
 }
 
-bool IVFCFile::SetSize(const u64 size) const {
+bool ROMFSFile::SetSize(const u64 size) const {
-    LOG_ERROR(Service_FS, "Attempted to set the size of an IVFC file");
+    LOG_ERROR(Service_FS, "Attempted to set the size of an ROMFS file");
     return false;
 }
 

src/core/file_sys/romfs_archive.h

@@ -1,4 +1,4 @@
-// Copyright 2014 Citra Emulator Project
+// Copyright 2018 yuzu emulator team
 // Licensed under GPLv2 or any later version
 // Refer to the license.txt file included.
 
@@ -15,19 +15,16 @@
 #include "core/file_sys/file_backend.h"
 #include "core/hle/result.h"
 
-////////////////////////////////////////////////////////////////////////////////////////////////////
-// FileSys namespace
-
 namespace FileSys {
 
 /**
- * Helper which implements an interface to deal with IVFC images used in some archives
+ * Helper which implements an interface to deal with Switch .istorage ROMFS images used in some
- * This should be subclassed by concrete archive types, which will provide the
+ * archives This should be subclassed by concrete archive types, which will provide the input data
- * input data (load the raw IVFC archive) and override any required methods
+ * (load the raw ROMFS archive) and override any required methods
  */
-class IVFCArchive : public ArchiveBackend {
+class ROMFSArchive : public ArchiveBackend {
 public:
-    IVFCArchive(std::shared_ptr<FileUtil::IOFile> file, u64 offset, u64 size)
+    ROMFSArchive(std::shared_ptr<FileUtil::IOFile> file, u64 offset, u64 size)
         : romfs_file(file), data_offset(offset), data_size(size) {}
 
     std::string GetName() const override;
@@ -50,9 +47,9 @@ protected:
     u64 data_size;
 };
 
-class IVFCFile : public FileBackend {
+class ROMFSFile : public FileBackend {
 public:
-    IVFCFile(std::shared_ptr<FileUtil::IOFile> file, u64 offset, u64 size)
+    ROMFSFile(std::shared_ptr<FileUtil::IOFile> file, u64 offset, u64 size)
         : romfs_file(file), data_offset(offset), data_size(size) {}
 
     ResultVal<size_t> Read(u64 offset, size_t length, u8* buffer) const override;
@@ -70,7 +67,7 @@ private:
     u64 data_size;
 };
 
-class IVFCDirectory : public DirectoryBackend {
+class ROMFSDirectory : public DirectoryBackend {
 public:
     u32 Read(const u32 count, Entry* entries) override {
         return 0;