Atmosphere/libraries/libstratosphere/source/fssystem/fssystem_romfs_filesystem.cpp

/*
 * Copyright (c) 2018-2020 Atmosphère-NX
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms and conditions of the GNU General Public License,
 * version 2, as published by the Free Software Foundation.
 *
 * This program is distributed in the hope it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
 * more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
#include <stratosphere.hpp>

namespace ams::fssystem {

    namespace {

        constexpr size_t CalculateRequiredWorkingMemorySize(const RomFileSystemInformation &header) {
            return header.directory_bucket_size + header.directory_entry_size + header.file_bucket_size + header.file_entry_size;
        }

        class RomFsFile : public ams::fs::fsa::IFile, public ams::fs::impl::Newable {
            private:
                RomFsFileSystem *parent;
                s64 start;
                s64 end;
            private:
                s64 GetSize() const {
                    return this->end - this->start;
                }
            public:
                RomFsFile(RomFsFileSystem *p, s64 s, s64 e) : parent(p), start(s), end(e) { /* ... */ }
                virtual ~RomFsFile() { /* ... */ }
            public:
                virtual Result ReadImpl(size_t *out, s64 offset, void *buffer, size_t size, const fs::ReadOption &option) override {
                    R_TRY(buffers::DoContinuouslyUntilBufferIsAllocated([=, this]() -> Result {
                        size_t read_size = 0;
                        R_TRY(this->DryRead(std::addressof(read_size), offset, size, option, fs::OpenMode_Read));

                        R_TRY(this->parent->GetBaseStorage()->Read(offset + this->start, buffer, read_size));
                        *out = read_size;

                        return ResultSuccess();
                    }, AMS_CURRENT_FUNCTION_NAME));

                    return ResultSuccess();
                }

                virtual Result GetSizeImpl(s64 *out) override {
                    *out = this->GetSize();
                    return ResultSuccess();
                }

                virtual Result FlushImpl() override {
                    return ResultSuccess();
                }

                virtual Result WriteImpl(s64 offset, const void *buffer, size_t size, const fs::WriteOption &option) override {
                    bool needs_append;
                    R_TRY(this->DryWrite(std::addressof(needs_append), offset, size, option, fs::OpenMode_Read));
                    AMS_ASSERT(needs_append == false);
                    return fs::ResultUnsupportedOperationInRomFsFileA();
                }

                virtual Result SetSizeImpl(s64 size) override {
                    R_TRY(this->DrySetSize(size, fs::OpenMode_Read));
                    return fs::ResultUnsupportedOperationInRomFsFileA();
                }

                virtual Result OperateRangeImpl(void *dst, size_t dst_size, fs::OperationId op_id, s64 offset, s64 size, const void *src, size_t src_size) override {
                    switch (op_id) {
                        case fs::OperationId::InvalidateCache:
                        case fs::OperationId::QueryRange:
                            {
                                R_UNLESS(offset >= 0,          fs::ResultOutOfRange());
                                R_UNLESS(this->GetSize() >= 0, fs::ResultOutOfRange());

                                auto operate_size = size;
                                if (offset + operate_size > this->GetSize() || offset + operate_size < offset) {
                                    operate_size = this->GetSize() - offset;
                                }

                                R_TRY(buffers::DoContinuouslyUntilBufferIsAllocated([=, this]() -> Result {
                                    R_TRY(this->parent->GetBaseStorage()->OperateRange(dst, dst_size, op_id, this->start + offset, operate_size, src, src_size));
                                    return ResultSuccess();
                                }, AMS_CURRENT_FUNCTION_NAME));
                                return ResultSuccess();
                            }
                        default:
                            return fs::ResultUnsupportedOperationInRomFsFileB();
                    }
                }
            public:
                virtual sf::cmif::DomainObjectId GetDomainObjectId() const override {
                    AMS_ABORT();
                }
        };

        class RomFsDirectory : public ams::fs::fsa::IDirectory, public ams::fs::impl::Newable {
            private:
                using FindPosition = RomFsFileSystem::RomFileTable::FindPosition;
            private:
                RomFsFileSystem *parent;
                FindPosition current_find;
                FindPosition first_find;
                fs::OpenDirectoryMode mode;
            public:
                RomFsDirectory(RomFsFileSystem *p, const FindPosition &f, fs::OpenDirectoryMode m) : parent(p), current_find(f), first_find(f), mode(m) { /* ... */ }
                virtual ~RomFsDirectory() override { /* ... */ }
            public:
                virtual Result ReadImpl(s64 *out_count, fs::DirectoryEntry *out_entries, s64 max_entries) {
                    R_TRY(buffers::DoContinuouslyUntilBufferIsAllocated([=, this]() -> Result {
                        return this->ReadImpl(out_count, std::addressof(this->current_find), out_entries, max_entries);
                    }, AMS_CURRENT_FUNCTION_NAME));
                    return ResultSuccess();
                }

                virtual Result GetEntryCountImpl(s64 *out) {
                    FindPosition find = this->first_find;

                    R_TRY(buffers::DoContinuouslyUntilBufferIsAllocated([&]() -> Result {
                        R_TRY(this->ReadImpl(out, std::addressof(find), nullptr, 0));
                        return ResultSuccess();
                    }, AMS_CURRENT_FUNCTION_NAME));
                    return ResultSuccess();
                }
            private:
                Result ReadImpl(s64 *out_count, FindPosition *find, fs::DirectoryEntry *out_entries, s64 max_entries) {
                    constexpr size_t NameBufferSize = fs::EntryNameLengthMax + 1;
                    RomPathChar name[NameBufferSize];
                    s32 i = 0;

                    if (this->mode & fs::OpenDirectoryMode_Directory) {
                        while (i < max_entries || out_entries == nullptr) {
                            R_TRY_CATCH(this->parent->GetRomFileTable()->FindNextDirectory(name, find)) {
                                R_CATCH(fs::ResultDbmFindFinished) { break; }
                            } R_END_TRY_CATCH;

                            if (out_entries) {
                                R_UNLESS(strnlen(name, NameBufferSize) < NameBufferSize, fs::ResultTooLongPath());
                                strncpy(out_entries[i].name, name, fs::EntryNameLengthMax);
                                out_entries[i].name[fs::EntryNameLengthMax] = '\x00';
                                out_entries[i].type = fs::DirectoryEntryType_Directory;
                                out_entries[i].file_size = 0;
                            }

                            i++;
                        }
                    }

                    if (this->mode & fs::OpenDirectoryMode_File) {
                        while (i < max_entries || out_entries == nullptr) {
                            auto file_pos = find->next_file;

                            R_TRY_CATCH(this->parent->GetRomFileTable()->FindNextFile(name, find)) {
                                R_CATCH(fs::ResultDbmFindFinished) { break; }
                            } R_END_TRY_CATCH;

                            if (out_entries) {
                                R_UNLESS(strnlen(name, NameBufferSize) < NameBufferSize, fs::ResultTooLongPath());
                                strncpy(out_entries[i].name, name, fs::EntryNameLengthMax);
                                out_entries[i].name[fs::EntryNameLengthMax] = '\x00';
                                out_entries[i].type = fs::DirectoryEntryType_File;

                                RomFsFileSystem::RomFileTable::FileInfo file_info;
                                R_TRY(this->parent->GetRomFileTable()->OpenFile(std::addressof(file_info), this->parent->GetRomFileTable()->ConvertToFileId(file_pos)));
                                out_entries[i].file_size = file_info.size.Get();
                            }

                            i++;
                        }
                    }

                    *out_count = i;
                    return ResultSuccess();
                }
            public:
                virtual sf::cmif::DomainObjectId GetDomainObjectId() const override {
                    AMS_ABORT();
                }
        };

    }


    RomFsFileSystem::RomFsFileSystem() : base_storage() {
        /* ... */
    }

    RomFsFileSystem::~RomFsFileSystem() {
        /* ... */
    }

    fs::IStorage *RomFsFileSystem::GetBaseStorage() {
        return this->base_storage;
    }

    RomFsFileSystem::RomFileTable *RomFsFileSystem::GetRomFileTable() {
        return std::addressof(this->rom_file_table);
    }

    Result RomFsFileSystem::GetRequiredWorkingMemorySize(size_t *out, fs::IStorage *storage) {
        RomFileSystemInformation header;

        R_TRY(buffers::DoContinuouslyUntilBufferIsAllocated([&]() -> Result {
            R_TRY(storage->Read(0, std::addressof(header), sizeof(header)));
            return ResultSuccess();
        }, AMS_CURRENT_FUNCTION_NAME));

        *out = CalculateRequiredWorkingMemorySize(header);
        return ResultSuccess();
    }

    Result RomFsFileSystem::Initialize(fs::IStorage *base, void *work, size_t work_size, bool use_cache) {
        AMS_ABORT_UNLESS(!use_cache || work != nullptr);
        AMS_ABORT_UNLESS(base != nullptr);

        /* Register blocking context for the scope. */
        buffers::ScopedBufferManagerContextRegistration _sr;
        buffers::EnableBlockingBufferManagerAllocation();

        /* Read the header. */
        RomFileSystemInformation header;
        R_TRY(base->Read(0, std::addressof(header), sizeof(header)));

        /* Set up our storages. */
        if (use_cache) {
            const size_t needed_size = CalculateRequiredWorkingMemorySize(header);
            R_UNLESS(work_size >= needed_size, fs::ResultAllocationFailureInRomFsFileSystemA());

            u8 *buf = static_cast<u8 *>(work);
            auto dir_bucket_buf  = buf; buf += header.directory_bucket_size;
            auto dir_entry_buf   = buf; buf += header.directory_entry_size;
            auto file_bucket_buf = buf; buf += header.file_bucket_size;
            auto file_entry_buf  = buf; buf += header.file_entry_size;

            R_TRY(base->Read(header.directory_bucket_offset, dir_bucket_buf,  static_cast<size_t>(header.directory_bucket_size)));
            R_TRY(base->Read(header.directory_entry_offset,  dir_entry_buf,   static_cast<size_t>(header.directory_entry_size)));
            R_TRY(base->Read(header.file_bucket_offset,      file_bucket_buf, static_cast<size_t>(header.file_bucket_size)));
            R_TRY(base->Read(header.file_entry_offset,       file_entry_buf,  static_cast<size_t>(header.file_entry_size)));

            this->dir_bucket_storage.reset(new fs::MemoryStorage(dir_bucket_buf, header.directory_bucket_size));
            this->dir_entry_storage.reset(new fs::MemoryStorage(dir_entry_buf, header.directory_entry_size));
            this->file_bucket_storage.reset(new fs::MemoryStorage(file_bucket_buf, header.file_bucket_size));
            this->file_entry_storage.reset(new fs::MemoryStorage(file_entry_buf, header.file_entry_size));
        } else {
            this->dir_bucket_storage.reset(new fs::SubStorage(base, header.directory_bucket_offset, header.directory_bucket_size));
            this->dir_entry_storage.reset(new fs::SubStorage(base, header.directory_entry_offset, header.directory_entry_size));
            this->file_bucket_storage.reset(new fs::SubStorage(base, header.file_bucket_offset, header.file_bucket_size));
            this->file_entry_storage.reset(new fs::SubStorage(base, header.file_entry_offset, header.file_entry_size));
        }

        /* Ensure we allocated storages successfully. */
        R_UNLESS(this->dir_bucket_storage  != nullptr, fs::ResultAllocationFailureInRomFsFileSystemB());
        R_UNLESS(this->dir_entry_storage   != nullptr, fs::ResultAllocationFailureInRomFsFileSystemB());
        R_UNLESS(this->file_bucket_storage != nullptr, fs::ResultAllocationFailureInRomFsFileSystemB());
        R_UNLESS(this->file_entry_storage  != nullptr, fs::ResultAllocationFailureInRomFsFileSystemB());

        /* Initialize the rom table. */
        R_TRY(this->rom_file_table.Initialize(this->dir_bucket_storage.get(),  0, static_cast<u32>(header.directory_bucket_size),
                                              this->dir_entry_storage.get(),   0, static_cast<u32>(header.directory_entry_size),
                                              this->file_bucket_storage.get(), 0, static_cast<u32>(header.file_bucket_size),
                                              this->file_entry_storage.get(),  0, static_cast<u32>(header.file_entry_size)));

        /* Set members. */
        this->entry_size = header.body_offset;
        this->base_storage = base;
        return ResultSuccess();
    }

    Result RomFsFileSystem::Initialize(std::shared_ptr<fs::IStorage> base, void *work, size_t work_size, bool use_cache) {
        this->shared_storage = std::move(base);
        return this->Initialize(this->shared_storage.get(), work, work_size, use_cache);
    }

    Result RomFsFileSystem::GetFileInfo(RomFileTable::FileInfo *out, const char *path) {
        R_TRY(buffers::DoContinuouslyUntilBufferIsAllocated([=, this]() -> Result {
            R_TRY_CATCH(this->rom_file_table.OpenFile(out, path)) {
                R_CONVERT(fs::ResultDbmNotFound,         fs::ResultPathNotFound());
            } R_END_TRY_CATCH;

            return ResultSuccess();
        }, AMS_CURRENT_FUNCTION_NAME));

        return ResultSuccess();
    }

    Result RomFsFileSystem::GetFileBaseOffset(s64 *out, const char *path) {
        RomFileTable::FileInfo info;
        R_TRY(this->GetFileInfo(std::addressof(info), path));
        *out = this->entry_size + info.offset.Get();
        return ResultSuccess();
    }

    Result RomFsFileSystem::CreateFileImpl(const char *path, s64 size, int flags) {
        return fs::ResultUnsupportedOperationInRomFsFileSystemA();
    }

    Result RomFsFileSystem::DeleteFileImpl(const char *path) {
        return fs::ResultUnsupportedOperationInRomFsFileSystemA();
    }

    Result RomFsFileSystem::CreateDirectoryImpl(const char *path) {
        return fs::ResultUnsupportedOperationInRomFsFileSystemA();
    }

    Result RomFsFileSystem::DeleteDirectoryImpl(const char *path) {
        return fs::ResultUnsupportedOperationInRomFsFileSystemA();
    }

    Result RomFsFileSystem::DeleteDirectoryRecursivelyImpl(const char *path) {
        return fs::ResultUnsupportedOperationInRomFsFileSystemA();
    }

    Result RomFsFileSystem::RenameFileImpl(const char *old_path, const char *new_path) {
        return fs::ResultUnsupportedOperationInRomFsFileSystemA();
    }

    Result RomFsFileSystem::RenameDirectoryImpl(const char *old_path, const char *new_path) {
        return fs::ResultUnsupportedOperationInRomFsFileSystemA();
    }

    Result RomFsFileSystem::GetEntryTypeImpl(fs::DirectoryEntryType *out, const char *path) {
        R_TRY(buffers::DoContinuouslyUntilBufferIsAllocated([=, this]() -> Result {
            RomDirectoryInfo dir_info;

            R_TRY_CATCH(this->rom_file_table.GetDirectoryInformation(std::addressof(dir_info), path)) {
                R_CONVERT(fs::ResultDbmNotFound, fs::ResultPathNotFound())
                R_CATCH(fs::ResultDbmInvalidOperation) {
                    RomFileTable::FileInfo file_info;
                    R_TRY(this->GetFileInfo(std::addressof(file_info), path));

                    *out = fs::DirectoryEntryType_File;
                    return ResultSuccess();
                }
            } R_END_TRY_CATCH;

            *out = fs::DirectoryEntryType_Directory;
            return ResultSuccess();
        }, AMS_CURRENT_FUNCTION_NAME));

        return ResultSuccess();
    }

    Result RomFsFileSystem::OpenFileImpl(std::unique_ptr<fs::fsa::IFile> *out_file, const char *path, fs::OpenMode mode) {
        R_UNLESS(mode == fs::OpenMode_Read, fs::ResultInvalidOpenMode());

        RomFileTable::FileInfo file_info;
        R_TRY(this->GetFileInfo(std::addressof(file_info), path));

        auto file = std::make_unique<RomFsFile>(this, this->entry_size + file_info.offset.Get(), this->entry_size + file_info.offset.Get() + file_info.size.Get());
        R_UNLESS(file != nullptr, fs::ResultAllocationFailureInRomFsFileSystemC());

        *out_file = std::move(file);
        return ResultSuccess();
    }

    Result RomFsFileSystem::OpenDirectoryImpl(std::unique_ptr<fs::fsa::IDirectory> *out_dir, const char *path, fs::OpenDirectoryMode mode) {
        RomFileTable::FindPosition find;
        R_TRY(buffers::DoContinuouslyUntilBufferIsAllocated([&]() -> Result {
            R_TRY_CATCH(this->rom_file_table.FindOpen(std::addressof(find), path)) {
                R_CONVERT(fs::ResultDbmNotFound,         fs::ResultPathNotFound())
            } R_END_TRY_CATCH;

            return ResultSuccess();
        }, AMS_CURRENT_FUNCTION_NAME));

        auto dir = std::make_unique<RomFsDirectory>(this, find, mode);
        R_UNLESS(dir != nullptr, fs::ResultAllocationFailureInRomFsFileSystemD());

        *out_dir = std::move(dir);
        return ResultSuccess();
    }

    Result RomFsFileSystem::CommitImpl() {
        return ResultSuccess();
    }

    Result RomFsFileSystem::GetFreeSpaceSizeImpl(s64 *out, const char *path) {
        *out = 0;
        return ResultSuccess();
    }

    Result RomFsFileSystem::CleanDirectoryRecursivelyImpl(const char *path) {
        return fs::ResultUnsupportedOperationInRomFsFileSystemA();
    }

    Result RomFsFileSystem::CommitProvisionallyImpl(s64 counter) {
        return fs::ResultUnsupportedOperationInRomFsFileSystemB();
    }

}