CacheLoader.hpp

//------------------------------------------------------------------------------
/*
    This file is part of clio: https://github.com/XRPLF/clio
    Copyright (c) 2024, the clio developers.
 
    Permission to use, copy, modify, and distribute this software for any
    purpose with or without fee is hereby granted, provided that the above
    copyright notice and this permission notice appear in all copies.
 
    THE  SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
    WITH  REGARD  TO  THIS  SOFTWARE  INCLUDING  ALL  IMPLIED  WARRANTIES  OF
    MERCHANTABILITY  AND  FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
    ANY  SPECIAL,  DIRECT,  INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
    WHATSOEVER  RESULTING  FROM  LOSS  OF USE, DATA OR PROFITS, WHETHER IN AN
    ACTION  OF  CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
    OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*/
//==============================================================================
 
#pragma once
 
#include "data/BackendInterface.hpp"
#include "data/LedgerCacheInterface.hpp"
#include "data/Types.hpp"
#include "etl/CacheLoaderInterface.hpp"
#include "etl/CacheLoaderSettings.hpp"
#include "etl/impl/CacheLoader.hpp"
#include "etl/impl/CursorFromAccountProvider.hpp"
#include "etl/impl/CursorFromDiffProvider.hpp"
#include "etl/impl/CursorFromFixDiffNumProvider.hpp"
#include "util/Assert.hpp"
#include "util/Profiler.hpp"
#include "util/async/context/BasicExecutionContext.hpp"
#include "util/config/ConfigDefinition.hpp"
#include "util/log/Logger.hpp"
 
#include <algorithm>
#include <cstdint>
#include <functional>
#include <memory>
#include <utility>
 
namespace etl {

template <typename ExecutionContextType = util::async::CoroExecutionContext>
class CacheLoader : public CacheLoaderInterface {
    using CacheLoaderType = impl::CacheLoaderImpl<data::LedgerCacheInterface>;
 
    util::Logger log_{"ETL"};
    std::shared_ptr<BackendInterface> backend_;
    std::reference_wrapper<data::LedgerCacheInterface> cache_;
 
    CacheLoaderSettings settings_;
    ExecutionContextType ctx_;
    std::unique_ptr<CacheLoaderType> loader_;
 
public:
    CacheLoader(
        util::config::ClioConfigDefinition const& config,
        std::shared_ptr<BackendInterface> backend,
        data::LedgerCacheInterface& cache
    )
        : backend_{std::move(backend)}
        , cache_{cache}
        , settings_{makeCacheLoaderSettings(config)}
        , ctx_{settings_.numThreads}
    {
    }

    void
    load(uint32_t const seq) override
    {
        ASSERT(not cache_.get().isFull(), "Cache must not be full. seq = {}", seq);
 
        if (settings_.isDisabled()) {
            cache_.get().setDisabled();
            LOG(log_.warn()) << "Cache is disabled. Not loading";
            return;
        }
 
        if (loadCacheFromFile()) {
            return;
        }
 
        std::shared_ptr<impl::BaseCursorProvider> provider;
        if (settings_.numCacheCursorsFromDiff != 0) {
            LOG(log_.info()) << "Loading cache with cursor from num_cursors_from_diff="
                             << settings_.numCacheCursorsFromDiff;
            provider = std::make_shared<impl::CursorFromDiffProvider>(
                backend_, settings_.numCacheCursorsFromDiff
            );
        } else if (settings_.numCacheCursorsFromAccount != 0) {
            LOG(log_.info()) << "Loading cache with cursor from num_cursors_from_account="
                             << settings_.numCacheCursorsFromAccount;
            provider = std::make_shared<impl::CursorFromAccountProvider>(
                backend_, settings_.numCacheCursorsFromAccount, settings_.cachePageFetchSize
            );
        } else {
            LOG(log_.info()) << "Loading cache with cursor from num_diffs="
                             << settings_.numCacheDiffs;
            provider = std::make_shared<impl::CursorFromFixDiffNumProvider>(
                backend_, settings_.numCacheDiffs
            );
        }
 
        loader_ = std::make_unique<CacheLoaderType>(
            ctx_,
            backend_,
            cache_,
            seq,
            settings_.numCacheMarkers,
            settings_.cachePageFetchSize,
            provider->getCursors(seq)
        );
 
        if (settings_.isSync()) {
            loader_->wait();
            ASSERT(cache_.get().isFull(), "Cache must be full after sync load. seq = {}", seq);
        }
    }

    void
    stop() noexcept override
    {
        if (loader_ != nullptr)
            loader_->stop();
    }

    void
    wait() noexcept override
    {
        if (loader_ != nullptr)
            loader_->wait();
    }
 
private:
    bool
    loadCacheFromFile()
    {
        if (not settings_.cacheFileSettings.has_value()) {
            return false;
        }
        LOG(log_.info()) << "Loading ledger cache from " << settings_.cacheFileSettings->path;
        auto const minLatestSequence =
            backend_->fetchLedgerRange()
                .transform([this](data::LedgerRange const& range) {
                    return std::max(
                        range.maxSequence - settings_.cacheFileSettings->maxAge, range.minSequence
                    );
                })
                .value_or(0);
 
        auto const [success, duration_ms] = util::timed([&]() {
            return cache_.get().loadFromFile(settings_.cacheFileSettings->path, minLatestSequence);
        });
 
        if (not success.has_value()) {
            LOG(log_.warn()) << "Error loading cache from file: " << success.error();
            return false;
        }
 
        LOG(log_.info()) << "Loaded cache from file in " << duration_ms
                         << " ms. Latest sequence: " << cache_.get().latestLedgerSequence();
        backend_->forceUpdateRange(cache_.get().latestLedgerSequence());
        return true;
    }
};
 
}  // namespace etl