TaskQueue.hpp

//------------------------------------------------------------------------------
/*
    This file is part of clio: https://github.com/XRPLF/clio
    Copyright (c) 2025, 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 "etl/Models.hpp"
#include "util/Assert.hpp"
#include "util/Mutex.hpp"
 
#include <atomic>
#include <condition_variable>
#include <cstddef>
#include <cstdint>
#include <mutex>
#include <optional>
#include <queue>
#include <utility>
#include <vector>
 
namespace etl::impl {
 
struct ReverseOrderComparator {
    [[nodiscard]] bool
    operator()(model::LedgerData const& lhs, model::LedgerData const& rhs) const noexcept
    {
        return lhs.seq > rhs.seq;
    }
};

class TaskQueue {
    struct Data {
        std::uint32_t expectedSequence;
        std::priority_queue<
            model::LedgerData,
            std::vector<model::LedgerData>,
            ReverseOrderComparator>
            forwardLoadQueue;
 
        Data(std::uint32_t seq) : expectedSequence(seq)
        {
        }
    };
 
    std::size_t limit_;
    std::uint32_t increment_;
    util::Mutex<Data> data_;
 
    std::condition_variable cv_;
    std::atomic_bool stopping_ = false;
 
public:
    struct Settings {
        std::uint32_t startSeq = 0u;  // sequence to start from (for dequeue)
        std::uint32_t increment =
            1u;  // increment sequence by this value once dequeue was successful
        std::optional<std::size_t> limit = std::nullopt;
    };

    explicit TaskQueue(Settings settings)
        : limit_(settings.limit.value_or(0uz))
        , increment_(settings.increment)
        , data_(settings.startSeq)
    {
    }
 
    ~TaskQueue()
    {
        ASSERT(stopping_, "stop() must be called before destroying the TaskQueue");
    }

    [[nodiscard]] bool
    enqueue(model::LedgerData item)
    {
        auto lock = data_.lock();
 
        if (limit_ == 0uz or lock->forwardLoadQueue.size() < limit_) {
            lock->forwardLoadQueue.push(std::move(item));
            cv_.notify_all();
 
            return true;
        }
 
        return false;
    }

    [[nodiscard]] std::optional<model::LedgerData>
    dequeue()
    {
        auto lock = data_.lock();
        std::optional<model::LedgerData> out;
 
        if (not lock->forwardLoadQueue.empty() &&
            lock->forwardLoadQueue.top().seq == lock->expectedSequence) {
            out.emplace(lock->forwardLoadQueue.top());
            lock->forwardLoadQueue.pop();
            lock->expectedSequence += increment_;
        }
 
        return out;
    }

    [[nodiscard]] bool
    empty()
    {
        return data_.lock()->forwardLoadQueue.empty();
    }

    void
    awaitTask()
    {
        if (stopping_)
            return;
 
        auto lock = data_.lock<std::unique_lock>();
        cv_.wait(lock, [&] { return stopping_ or not lock->forwardLoadQueue.empty(); });
    }

    void
    stop()
    {
        // unblock all waiters
        stopping_ = true;
        cv_.notify_all();
    }
};
 
}  // namespace etl::impl