Atmosphere/libraries/libstratosphere/source/fs/fs_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::fs {

    namespace {

        Result ConvertNcaCorruptedResult(Result res) {
            AMS_ASSERT(fs::ResultNcaCorrupted::Includes(res));

            R_TRY_CATCH(res) {
                R_CONVERT(fs::ResultInvalidNcaFileSystemType,                   fs::ResultInvalidRomNcaFileSystemType())
                R_CONVERT(fs::ResultInvalidAcidFileSize,                        fs::ResultInvalidRomAcidFileSize())
                R_CONVERT(fs::ResultInvalidAcidSize,                            fs::ResultInvalidRomAcidSize())
                R_CONVERT(fs::ResultInvalidAcid,                                fs::ResultInvalidRomAcid())
                R_CONVERT(fs::ResultAcidVerificationFailed,                     fs::ResultRomAcidVerificationFailed())
                R_CONVERT(fs::ResultInvalidNcaSignature,                        fs::ResultInvalidRomNcaSignature())
                R_CONVERT(fs::ResultNcaHeaderSignature1VerificationFailed,      fs::ResultRomNcaHeaderSignature1VerificationFailed())
                R_CONVERT(fs::ResultNcaHeaderSignature2VerificationFailed,      fs::ResultRomNcaHeaderSignature2VerificationFailed())
                R_CONVERT(fs::ResultNcaFsHeaderHashVerificationFailed,          fs::ResultRomNcaFsHeaderHashVerificationFailed())
                R_CONVERT(fs::ResultInvalidNcaKeyIndex,                         fs::ResultInvalidRomNcaKeyIndex())
                R_CONVERT(fs::ResultInvalidNcaFsHeaderHashType,                 fs::ResultInvalidRomNcaFsHeaderHashType())
                R_CONVERT(fs::ResultInvalidNcaFsHeaderEncryptionType,           fs::ResultInvalidRomNcaFsHeaderEncryptionType())
                R_CONVERT(fs::ResultInvalidHierarchicalSha256BlockSize,         fs::ResultInvalidRomHierarchicalSha256BlockSize())
                R_CONVERT(fs::ResultInvalidHierarchicalSha256LayerCount,        fs::ResultInvalidRomHierarchicalSha256LayerCount())
                R_CONVERT(fs::ResultHierarchicalSha256BaseStorageTooLarge,      fs::ResultRomHierarchicalSha256BaseStorageTooLarge())
                R_CONVERT(fs::ResultHierarchicalSha256HashVerificationFailed,   fs::ResultRomHierarchicalSha256HashVerificationFailed())
                R_CATCH_ALL() { /* ... */ }
            } R_END_TRY_CATCH;

            AMS_ASSERT(false);
            return fs::ResultNcaCorrupted();
        }

        Result ConvertIntegrityVerificationStorageCorruptedResult(Result res) {
            AMS_ASSERT(fs::ResultIntegrityVerificationStorageCorrupted::Includes(res));

            R_TRY_CATCH(res) {
                R_CONVERT(fs::ResultIncorrectIntegrityVerificationMagic,                fs::ResultIncorrectRomIntegrityVerificationMagic())
                R_CONVERT(fs::ResultInvalidZeroHash,                                    fs::ResultInvalidRomZeroHash())
                R_CONVERT(fs::ResultNonRealDataVerificationFailed,                      fs::ResultRomNonRealDataVerificationFailed())
                R_CONVERT(fs::ResultInvalidHierarchicalIntegrityVerificationLayerCount, fs::ResultInvalidRomHierarchicalIntegrityVerificationLayerCount())
                R_CONVERT(fs::ResultClearedRealDataVerificationFailed,                  fs::ResultClearedRomRealDataVerificationFailed())
                R_CONVERT(fs::ResultUnclearedRealDataVerificationFailed,                fs::ResultUnclearedRomRealDataVerificationFailed())
                R_CATCH_ALL() { /* ... */ }
            } R_END_TRY_CATCH;

            AMS_ASSERT(false);
            return fs::ResultIntegrityVerificationStorageCorrupted();
        }

        Result ConvertBuiltInStorageCorruptedResult(Result res) {
            AMS_ASSERT(fs::ResultBuiltInStorageCorrupted::Includes(res));

            R_TRY_CATCH(res) {
                R_CONVERT(fs::ResultGptHeaderVerificationFailed, fs::ResultRomGptHeaderVerificationFailed())
                R_CATCH_ALL() { /* ... */ }
            } R_END_TRY_CATCH;

            AMS_ASSERT(false);
            return fs::ResultBuiltInStorageCorrupted();
        }

        Result ConvertPartitionFileSystemCorruptedResult(Result res) {
            AMS_ASSERT(fs::ResultPartitionFileSystemCorrupted::Includes(res));

            R_TRY_CATCH(res) {
                R_CONVERT(fs::ResultInvalidSha256PartitionHashTarget,           fs::ResultInvalidRomSha256PartitionHashTarget())
                R_CONVERT(fs::ResultSha256PartitionHashVerificationFailed,      fs::ResultRomSha256PartitionHashVerificationFailed())
                R_CONVERT(fs::ResultPartitionSignatureVerificationFailed,       fs::ResultRomPartitionSignatureVerificationFailed())
                R_CONVERT(fs::ResultSha256PartitionSignatureVerificationFailed, fs::ResultRomSha256PartitionSignatureVerificationFailed())
                R_CONVERT(fs::ResultInvalidPartitionEntryOffset,                fs::ResultInvalidRomPartitionEntryOffset())
                R_CONVERT(fs::ResultInvalidSha256PartitionMetaDataSize,         fs::ResultInvalidRomSha256PartitionMetaDataSize())
                R_CATCH_ALL() { /* ... */ }
            } R_END_TRY_CATCH;

            AMS_ASSERT(false);
            return fs::ResultPartitionFileSystemCorrupted();
        }

        Result ConvertFatFileSystemCorruptedResult(Result res) {
            AMS_ASSERT(fs::ResultFatFileSystemCorrupted::Includes(res));

            return res;
        }

        Result ConvertHostFileSystemCorruptedResult(Result res) {
            AMS_ASSERT(fs::ResultHostFileSystemCorrupted::Includes(res));

            R_TRY_CATCH(res) {
                R_CONVERT(fs::ResultHostEntryCorrupted,    fs::ResultRomHostEntryCorrupted())
                R_CONVERT(fs::ResultHostFileDataCorrupted, fs::ResultRomHostFileDataCorrupted())
                R_CONVERT(fs::ResultHostFileCorrupted,     fs::ResultRomHostFileCorrupted())
                R_CONVERT(fs::ResultInvalidHostHandle,     fs::ResultInvalidRomHostHandle())
                R_CATCH_ALL() { /* ... */ }
            } R_END_TRY_CATCH;

            AMS_ASSERT(false);
            return fs::ResultHostFileSystemCorrupted();
        }

        Result ConvertDatabaseCorruptedResult(Result res) {
            AMS_ASSERT(fs::ResultDatabaseCorrupted::Includes(res));

            R_TRY_CATCH(res) {
                R_CONVERT(fs::ResultInvalidAllocationTableBlock,     fs::ResultInvalidRomAllocationTableBlock())
                R_CONVERT(fs::ResultInvalidKeyValueListElementIndex, fs::ResultInvalidRomKeyValueListElementIndex())
                R_CATCH_ALL() { /* ... */ }
            } R_END_TRY_CATCH;

            AMS_ASSERT(false);
            return fs::ResultDatabaseCorrupted();
        }

        Result ConvertRomFsResult(Result res) {
            R_TRY_CATCH(res) {
                R_CONVERT(fs::ResultUnsupportedVersion,                    fs::ResultUnsupportedRomVersion())
                R_CONVERT(fs::ResultNcaCorrupted,                          ConvertNcaCorruptedResult(res))
                R_CONVERT(fs::ResultIntegrityVerificationStorageCorrupted, ConvertIntegrityVerificationStorageCorruptedResult(res))
                R_CONVERT(fs::ResultBuiltInStorageCorrupted,               ConvertBuiltInStorageCorruptedResult(res))
                R_CONVERT(fs::ResultPartitionFileSystemCorrupted,          ConvertPartitionFileSystemCorruptedResult(res))
                R_CONVERT(fs::ResultFatFileSystemCorrupted,                ConvertFatFileSystemCorruptedResult(res))
                R_CONVERT(fs::ResultHostFileSystemCorrupted,               ConvertHostFileSystemCorruptedResult(res))
                R_CONVERT(fs::ResultDatabaseCorrupted,                     ConvertDatabaseCorruptedResult(res))
                R_CONVERT(fs::ResultNotFound,                              fs::ResultPathNotFound())
                R_CONVERT(fs::ResultPermissionDenied,                      fs::ResultTargetLocked())
                R_CONVERT(fs::ResultIncompatiblePath,                      fs::ResultPathNotFound())
            } R_END_TRY_CATCH;

            return ResultSuccess();
        }

        Result ReadFile(IStorage *storage, s64 offset, void *buffer, size_t size) {
            AMS_ASSERT(storage != nullptr);
            AMS_ASSERT(offset >= 0);
            AMS_ASSERT(buffer != nullptr || size == 0);

            return ConvertRomFsResult(storage->Read(offset, buffer, size));
        }

        Result ReadFileHeader(IStorage *storage, RomFileSystemInformation *out) {
            AMS_ASSERT(storage != nullptr);
            AMS_ASSERT(out != nullptr);

            return ReadFile(storage, 0, out, sizeof(*out));
        }

        constexpr size_t CalculateRequiredWorkingMemorySize(const RomFileSystemInformation &header) {
            const size_t needed_size = header.directory_bucket_size + header.directory_entry_size + header.file_bucket_size + header.file_entry_size;
            return util::AlignUp(needed_size, 8);
        }

        class RomFsFile : public fsa::IFile, public impl::Newable {
            private:
                RomFsFileSystem *parent;
                s64 start;
                s64 end;
            public:
                RomFsFile(RomFsFileSystem *p, s64 s, s64 e) : parent(p), start(s), end(e) { /* ... */ }
                virtual ~RomFsFile() { /* ... */ }

                Result VerifyArguments(size_t *out, s64 offset, void *buf, size_t size, const fs::ReadOption &option) {
                    R_TRY(DryRead(out, offset, size, option, fs::OpenMode_Read));

                    AMS_ASSERT(this->GetStorage() != nullptr);
                    AMS_ASSERT(offset >= 0);
                    AMS_ASSERT(buf != nullptr || size == 0);

                    return ResultSuccess();
                }

                Result ConvertResult(Result res) const {
                    return ConvertRomFsResult(res);
                }

                s64 GetOffset() const {
                    return this->start;
                }

                s64 GetSize() const {
                    return this->end - this->start;
                }

                IStorage *GetStorage() {
                    return this->parent->GetBaseStorage();
                }
            public:
                virtual Result ReadImpl(size_t *out, s64 offset, void *buffer, size_t size, const fs::ReadOption &option) override {
                    size_t read_size = 0;
                    R_TRY(this->VerifyArguments(std::addressof(read_size), offset, buffer, size, option));

                    R_TRY(this->ConvertResult(this->GetStorage()->Read(offset + this->start, buffer, size)));
                    *out = read_size;

                    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 {
                    return fs::ResultUnsupportedOperationInRomFsFileA();
                }

                virtual Result SetSizeImpl(s64 size) override {
                    return fs::ResultUnsupportedOperationInRomFsFileA();
                }

                virtual Result OperateRangeImpl(