archive-manager.hh

Go to the documentation of this file.

/*
 
MIT License
 
Copyright (c) 2025 PCSX-Redux authors
 
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
 
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
 
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
 
*/
 
#pragma once
 
#include <EASTL/array.h>
#include <EASTL/functional.h>
#include <EASTL/string_view.h>
#include <stdint.h>
 
#include <coroutine>
 
#include "common/util/bitfield.hh"
#include "common/util/djbhash.h"
#include "psyqo/buffer.hh"
#include "psyqo/iso9660-parser.hh"
#include "psyqo/task.hh"
#include "psyqo/utility-polyfill.h"
 
namespace psyqo::paths {
 
class ArchiveManager {
    struct InitAwaiterWithFilename {
        InitAwaiterWithFilename(eastl::string_view name, ISO9660Parser &parser, ArchiveManager &manager)
            : m_name(name), m_parser(parser), m_manager(manager) {}
        bool await_ready() const { return false; }
        template <typename U>
        void await_suspend(std::coroutine_handle<U> handle) {
            m_manager.initialize(m_name, m_parser, [handle, this](bool success) {
                m_success = success;
                handle.resume();
            });
        }
        bool await_resume() { return m_success; }
 
      private:
        eastl::string_view m_name;
        ISO9660Parser &m_parser;
        ArchiveManager &m_manager;
        bool m_success;
    };
    struct InitAwaiter {
        InitAwaiter(uint32_t LBA, CDRom &device, ArchiveManager &manager)
            : m_LBA(LBA), m_device(device), m_manager(manager) {}
        bool await_ready() const { return false; }
        template <typename U>
        void await_suspend(std::coroutine_handle<U> handle) {
            m_manager.initialize(m_LBA, m_device, [handle, this](bool success) {
                m_success = success;
                handle.resume();
            });
        }
        bool await_resume() { return m_success; }
 
      private:
        uint32_t m_LBA;
        CDRom &m_device;
        ArchiveManager &m_manager;
        bool m_success;
    };
 
  public:
    union IndexEntry;
 
  private:
    struct ReadFileAwaiter {
        ReadFileAwaiter(const IndexEntry *entry, CDRom &device, ArchiveManager &manager)
            : m_entry(entry), m_device(device), m_manager(manager) {}
        constexpr bool await_ready() const { return false; }
        template <typename U>
        void await_suspend(std::coroutine_handle<U> handle) {
            m_manager.readFile(m_entry, m_device, [handle, this](Buffer<uint8_t> &&data) {
                m_data = eastl::move(data);
                handle.resume();
            });
        }
        Buffer<uint8_t> await_resume() { return eastl::move(m_data); }
 
      private:
        const IndexEntry *m_entry;
        CDRom &m_device;
        ArchiveManager &m_manager;
        Buffer<uint8_t> m_data;
    };
 
  public:
    union IndexEntry {
        enum class Method : uint32_t {
            NONE = 0,
            UCL_NRV2E = 1,
            LZ4 = 2,
            // Raw sectors stored as-is, such as an STR movie with interleaved
            // XA audio, meant to be streamed rather than loaded. The entry's
            // first 32-bit field holds the sector count instead of the
            // decompressed size and padding. `readFile` refuses these.
            STREAM = 3,
            COUNT = 4,
        };
        typedef Utilities::BitSpan<uint32_t, 21> DecompSizeField;
        typedef Utilities::BitSpan<uint32_t, 11> PaddingField;
        typedef Utilities::BitSpan<uint32_t, 19> SectorOffsetField;
        typedef Utilities::BitSpan<uint32_t, 10> CompressedSizeField;
        typedef Utilities::BitSpan<Method, 3> MethodField;
        typedef Utilities::BitField<DecompSizeField, PaddingField, SectorOffsetField, CompressedSizeField, MethodField>
            CompressedEntry;
        // Return the decompressed size of the file in bytes.
        uint32_t getDecompSize() const { return entry.get<DecompSizeField>(); }
        // Return the padding size in bytes. This is only relevant for
        // compressed files. The padding is used at the beginning of the
        // compressed data to align it to a 2048 byte boundary, and
        // allows in-place decompression of the data.
        uint32_t getPadding() const { return entry.get<PaddingField>(); }
        // Return the offset from the beginning of the archive to the compressed data in sectors.
        // This includes the index sectors at the beginning of the archive.
        uint32_t getSectorOffset() const { return entry.get<SectorOffsetField>(); }
        // Return the size of the compressed data in sectors. For uncompressed
        // data, this is the same as the size of the data in bytes, just rounded
        // up to the next 2048 byte boundary.
        uint32_t getCompressedSize() const { return entry.get<CompressedSizeField>(); }
        // Return the compression method used to compress the data.
        Method getCompressionMethod() const { return entry.get<MethodField>(); }
        // Return the number of sectors of a STREAM entry.
        uint32_t getStreamSectors() const { return asArray[2]; }
        uint32_t asArray[4];
        struct {
            uint64_t hash;
            CompressedEntry entry;
        };
    };
 
    void initialize(eastl::string_view archiveName, ISO9660Parser &parser, eastl::function<void(bool)> &&callback) {
        setupInitQueue(archiveName, parser, eastl::move(callback));
        m_queueInitFilename.run();
    }
    psyqo::TaskQueue::Task scheduleInitialize(eastl::string_view archiveName, ISO9660Parser &parser) {
        setupInitQueue(archiveName, parser, {});
        return m_queueInitFilename.schedule();
    }
    InitAwaiterWithFilename initialize(eastl::string_view archiveName, ISO9660Parser &parser) {
        return {archiveName, parser, *this};
    }
    void initialize(uint32_t LBA, CDRom &device, eastl::function<void(bool)> &&callback) {
        setupInitQueue(LBA, device, eastl::move(callback));
        m_queue.run();
    }
    psyqo::TaskQueue::Task scheduleInitialize(uint32_t LBA, CDRom &device) {
        setupInitQueue(LBA, device, {});
        return m_queue.schedule();
    }
    InitAwaiter initialize(uint32_t LBA, CDRom &device) { return {LBA, device, *this}; }
 
    const IndexEntry *getFirstIndexEntry() const {
        if (m_index.size() == 0) {
            return nullptr;
        }
        return &m_index[1];
    }
 
    uint32_t getIndexCount() const { return m_index[0].asArray[2] & 0xffffff; }
 
    uint32_t getSafeMarginLength() const { return ((m_index[0].asArray[2] >> 24) + 1) * 16; }
 
    const IndexEntry *getIndexEntry(eastl::string_view path) const;
    template <unsigned S>
    const IndexEntry *getIndexEntry(const char (&path)[S]) const {
        return getIndexEntry(djb::hash<uint64_t>(path));
    }
    const IndexEntry *getIndexEntry(uint64_t hash) const;
 
    uint32_t getIndexEntrySectorStart(const IndexEntry *entry) const {
        return m_archiveDirentry.LBA + entry->getSectorOffset();
    }
 
    void setBuffer(Buffer<uint8_t> &&buffer) { m_data = eastl::move(buffer); }
 
    template <unsigned S>
    void readFile(const char (&path)[S], CDRom &device, eastl::function<void(Buffer<uint8_t> &&)> &&callback) {
        setupQueue(getIndexEntry(path), device, eastl::move(callback));
        m_queue.run();
    }
    void readFile(eastl::string_view path, CDRom &device, eastl::function<void(Buffer<uint8_t> &&)> &&callback) {
        setupQueue(getIndexEntry(path), device, eastl::move(callback));
        m_queue.run();
    }
    void readFile(uint64_t hash, CDRom &device, eastl::function<void(Buffer<uint8_t> &&)> &&callback) {
        setupQueue(getIndexEntry(hash), device, eastl::move(callback));
        m_queue.run();
    }
    void readFile(const IndexEntry *entry, CDRom &device, eastl::function<void(Buffer<uint8_t> &&)> &&callback) {
        setupQueue(entry, device, eastl::move(callback));
        m_queue.run();
    }
    template <unsigned S>
    psyqo::TaskQueue::Task scheduleReadFile(const char (&path)[S], CDRom &device) {
        setupQueue(getIndexEntry(path), device, {});
        return m_queue.schedule();
    }
    psyqo::TaskQueue::Task scheduleReadFile(eastl::string_view path, CDRom &device) {
        setupQueue(getIndexEntry(path), device, {});
        return m_queue.schedule();
    }
    psyqo::TaskQueue::Task scheduleReadFile(uint64_t hash, CDRom &device) {
        setupQueue(getIndexEntry(hash), device, {});
        return m_queue.schedule();
    }
    psyqo::TaskQueue::Task scheduleReadFile(const IndexEntry *entry, CDRom &device) {
        setupQueue(entry, device, {});
        return m_queue.schedule();
    }
    template <unsigned S>
    ReadFileAwaiter readFile(const char (&path)[S], CDRom &device) {
        return {getIndexEntry(path), device, *this};
    }
    ReadFileAwaiter readFile(eastl::string_view path, CDRom &device) { return {getIndexEntry(path), device, *this}; }
    ReadFileAwaiter readFile(uint64_t hash, CDRom &device) { return {getIndexEntry(hash), device, *this}; }
    ReadFileAwaiter readFile(const IndexEntry *entry, CDRom &device) { return {entry, device, *this}; }
 
    static void registerUCL_NRV2EDecompressor() {
        s_decompressors[toUnderlying(IndexEntry::Method::UCL_NRV2E)] = &ArchiveManager::decompressUCL_NRV2E;
    }
    static void registerLZ4Decompressor() {
        s_decompressors[toUnderlying(IndexEntry::Method::LZ4)] = &ArchiveManager::decompressLZ4;
    }
 
    static void registerAllDecompressors() {
        registerUCL_NRV2EDecompressor();
        registerLZ4Decompressor();
    }
 
  private:
    eastl::function<void(bool)> m_initCallback;
    eastl::function<void(Buffer<uint8_t> &&)> m_callback;
    psyqo::TaskQueue m_queueInitFilename;
    psyqo::TaskQueue m_queue;
    Buffer<uint8_t> m_data;
    Buffer<IndexEntry> m_index;
    ISO9660Parser::DirEntry m_archiveDirentry;
    CDRom::ReadRequest m_request;
    bool m_pending = false;
    bool m_success = false;
 
    void setupInitQueue(eastl::string_view archiveName, ISO9660Parser &parser, eastl::function<void(bool)> &&callback);
    void setupInitQueue(uint32_t LBA, CDRom &device, eastl::function<void(bool)> &&callback);
    void setupQueue(const IndexEntry *entry, CDRom &device, eastl::function<void(Buffer<uint8_t> &&)> &&callback);
    uint32_t getIndexSectorCount() const {
        static_assert(sizeof(IndexEntry) == 16, "IndexEntry size is not 16 bytes");
        uint32_t indexSize = (getIndexCount() + 1) * sizeof(IndexEntry);
        return (indexSize + 2047) / 2048;
    }
    static eastl::array<void (ArchiveManager::*)(const IndexEntry *), toUnderlying(IndexEntry::Method::COUNT)>
        s_decompressors;
    void decompressUCL_NRV2E(const IndexEntry *entry);
    void decompressLZ4(const IndexEntry *entry);
};
 
}  // namespace psyqo::paths