future_queue/

future_queue_grouped.rs

// Copyright (c) The buffer-unordered-weighted Contributors
// SPDX-License-Identifier: MIT OR Apache-2.0

use crate::{
    global_weight::GlobalWeight, peekable_fused::PeekableFused, slots::SlotReservations,
    FutureQueueContext,
};
use debug_ignore::DebugIgnore;
use fnv::FnvHashMap;
use futures_util::{
    ready,
    stream::{Fuse, FusedStream, FuturesUnordered},
    Future, Stream, StreamExt,
};
use pin_project_lite::pin_project;
use std::{
    borrow::Borrow,
    collections::VecDeque,
    fmt,
    hash::Hash,
    pin::Pin,
    task::{Context, Poll},
};

pin_project! {
    /// Stream for the [`future_queue_grouped`](crate::StreamExt::future_queue_grouped) method.
    #[must_use = "streams do nothing unless polled"]
    pub struct FutureQueueGrouped<St, K>
    where
        St: Stream,
        St::Item: GroupedWeightedFuture,
     {
        #[pin]
        stream: PeekableFused<Fuse<St>>,
        #[pin]
        in_progress_queue: PeekableFused<InProgressQueue<St>>,
        global_weight: GlobalWeight,
        slots: SlotReservations,
        group_store: GroupStore<<St::Item as GroupedWeightedFuture>::Q, K, <St::Item as GroupedWeightedFuture>::F>,
        extra_verify: bool,
    }
}

type InProgressQueue<St> = FuturesUnordered<
    FutureWithGW<
        <<St as Stream>::Item as GroupedWeightedFuture>::Future,
        <<St as Stream>::Item as GroupedWeightedFuture>::Q,
    >,
>;

impl<St, K> fmt::Debug for FutureQueueGrouped<St, K>
where
    St: Stream + fmt::Debug,
    St::Item: GroupedWeightedFuture,
    <St::Item as GroupedWeightedFuture>::Future: fmt::Debug,
    <<St::Item as GroupedWeightedFuture>::Future as Future>::Output: fmt::Debug,
    K: fmt::Debug,
    <St::Item as GroupedWeightedFuture>::Q: fmt::Debug,
{
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.debug_struct("FutureQueueGrouped")
            .field("stream", &self.stream)
            .field("in_progress_queue", &self.in_progress_queue)
            .field("global_weight", &self.global_weight)
            .field("slots", &self.slots)
            .field("group_store", &self.group_store)
            .field("extra_verify", &self.extra_verify)
            .finish()
    }
}

impl<St, K> FutureQueueGrouped<St, K>
where
    St: Stream,
    St::Item: GroupedWeightedFuture,
    <St::Item as GroupedWeightedFuture>::Q: Eq + Hash + fmt::Debug,
    K: Eq + Hash + fmt::Debug + Borrow<<St::Item as GroupedWeightedFuture>::Q>,
{
    pub(super) fn new(
        stream: St,
        max_global_weight: usize,
        id_data: impl IntoIterator<Item = (K, usize)>,
    ) -> Self {
        let id_data_store = GroupStore::new(id_data);
        Self {
            stream: PeekableFused::new(stream.fuse()),
            in_progress_queue: PeekableFused::new(FuturesUnordered::new()),
            global_weight: GlobalWeight::new(max_global_weight),
            slots: SlotReservations::with_capacity(max_global_weight),
            group_store: id_data_store,
            extra_verify: false,
        }
    }

    /// Sets a mode where extra internal verifications are performed.
    #[doc(hidden)]
    pub fn set_extra_verify(&mut self, verify: bool) {
        self.extra_verify = verify;
        self.slots.set_check_reserved(verify);
        for data in self.group_store.group_data.values_mut() {
            data.slots.set_check_reserved(verify);
        }
    }

    /// Returns the maximum weight of futures allowed to be run by this adaptor.
    pub fn max_global_weight(&self) -> usize {
        self.global_weight.max()
    }

    /// Returns the current global weight of futures.
    pub fn current_global_weight(&self) -> usize {
        self.global_weight.current()
    }

    /// Returns the maximum weight of futures allowed to be run within this group.
    pub fn max_group_weight<Q>(&self, id: &Q) -> Option<usize>
    where
        Q: Eq + Hash + fmt::Debug + ?Sized,
        K: Borrow<Q>,
    {
        self.group_store
            .group_data
            .get(id)
            .map(|id_data| id_data.max_weight)
    }

    /// Returns the current weight of futures being run within this group.
    pub fn current_group_weight<Q>(&self, id: &Q) -> Option<usize>
    where
        Q: Eq + Hash + fmt::Debug + ?Sized,
        K: Borrow<Q>,
    {
        self.group_store
            .group_data
            .get(id)
            .map(|id_data| id_data.current_weight)
    }

    /// Acquires a reference to the underlying sink or stream that this combinator is
    /// pulling from.
    pub fn get_ref(&self) -> &St {
        self.stream.get_ref().get_ref()
    }

    /// Acquires a mutable reference to the underlying sink or stream that this
    /// combinator is pulling from.
    ///
    /// Note that care must be taken to avoid tampering with the state of the
    /// sink or stream which may otherwise confuse this combinator.
    pub fn get_mut(&mut self) -> &mut St {
        self.stream.get_mut().get_mut()
    }

    /// Acquires a pinned mutable reference to the underlying sink or stream that this
    /// combinator is pulling from.
    ///
    /// Note that care must be taken to avoid tampering with the state of the
    /// sink or stream which may otherwise confuse this combinator.
    pub fn get_pin_mut(self: Pin<&mut Self>) -> core::pin::Pin<&mut St> {
        self.project().stream.get_pin_mut().get_pin_mut()
    }

    /// Consumes this combinator, returning the underlying sink or stream.
    ///
    /// Note that this may discard intermediate state of this combinator, so
    /// care should be taken to avoid losing resources when this is called.
    pub fn into_inner(self) -> St {
        self.stream.into_inner().into_inner()
    }

    // ---
    // Helper methods
    // ---

    /// Verifies that there are no queue heads that can be started.
    fn verify_no_startable_queue_heads(&self) {
        for (id, data) in &self.group_store.group_data {
            if let Some(&(weight, _, _)) = data.queued.front() {
                assert!(
                    !data.can_start(weight, &self.global_weight),
                    "for group {id:?}, the queued future at the head (weight {weight}) fits \
                     within both the global weight ({}/{}) and the group weight ({}/{}), \
                     but was not started",
                    self.global_weight.current(),
                    self.global_weight.max(),
                    data.current_weight,
                    data.max_weight,
                );
            }
        }
    }

    // This returns true if any new futures were added to the in_progress_queue.
    #[allow(clippy::type_complexity)]
    fn poll_pop_in_progress(
        self: Pin<&mut Self>,
        cx: &mut Context<'_>,
    ) -> Poll<(
        Option<<<St::Item as GroupedWeightedFuture>::Future as Future>::Output>,
        bool,
    )> {
        let mut this = self.project();

        match ready!(this.in_progress_queue.poll_next_unpin(cx)) {
            Some((weight, global_slot, id_and_group_slot, output)) => {
                this.global_weight.sub_weight(weight);
                this.slots.release(global_slot);

                let mut any_queued = false;
                let in_progress_queue = this.in_progress_queue.get_ref();
                let mut start_queued = |data: &mut GroupData<_, _>| {
                    start_queued_futures(data, this.global_weight, this.slots, in_progress_queue)
                };

                if let Some((id, group_slot)) = id_and_group_slot {
                    let data = this.group_store.get_id_mut_or_unwrap(&id);
                    data.sub_weight(&id, weight);
                    data.slots.release(group_slot);

                    // Try starting a future from this group first, prioritizing
                    // the group.
                    //
                    // XXX: This behavior is left over from before the fix for
                    // #603. Maybe we don't necessarily want to prioritize this
                    // group and be globally FIFO instead? Worth thinking
                    // carefully about this in the future.
                    any_queued |= start_queued(data);
                }

                // This can unblock any group's queue head (#603).
                for data in this.group_store.group_data.values_mut() {
                    any_queued |= start_queued(data);
                }

                Poll::Ready((Some(output), any_queued))
            }
            None => Poll::Ready((None, false)),
        }
    }
}

impl<St, K> FutureQueueGrouped<St, K>
where
    St: Stream,
    St::Item: GroupedWeightedFuture,
    <St::Item as GroupedWeightedFuture>::Q: Eq + Hash + fmt::Debug,
    K: Eq + Hash + fmt::Debug + Borrow<<St::Item as GroupedWeightedFuture>::Q>,
{
    fn poll_next_impl(
        mut self: Pin<&mut Self>,
        cx: &mut Context<'_>,
    ) -> Poll<Option<<<St::Item as GroupedWeightedFuture>::Future as Future>::Output>> {
        // First, attempt to pull the next value from the in progress queue.
        // Don't return early on Pending, since the stream must be polled to
        // register its waker.
        let (return_output, mut any_queued) = match self.as_mut().poll_pop_in_progress(cx) {
            Poll::Ready(ret) => ret,
            Poll::Pending => (None, false),
        };

        let mut this = self.as_mut().project();

        // Next, let's try to spawn off as many futures as possible by filling up our queue of
        // futures.

        while let Poll::Ready(Some(weighted_future)) = this.stream.as_mut().poll_peek(cx) {
            let weight = weighted_future.weight();
            if !this.global_weight.has_space_for(weight) {
                // Global limits would be exceeded, break out of the loop. Consider this
                // item next time.
                break;
            }
            // We *do not* care about the group limit before pulling this item out. That's because
            // if the group is full, it will be queued up in the group queue.

            // Grab the next element from the queue.
            let (weight, id, future_fn) = match this.stream.as_mut().poll_next(cx) {
                Poll::Ready(Some(weighted_future)) => weighted_future.into_components(),
                _ => unreachable!("we just peeked at this item"),
            };

            if let Some(id) = id {
                // Is this group full?
                let data = this.group_store.get_id_mut_or_unwrap(&id);
                if data.has_space_for(weight) {
                    start_grouped_future(
                        weight,
                        id,
                        future_fn,
                        data,
                        this.global_weight,
                        this.slots,
                        this.in_progress_queue.get_ref(),
                    );
                    any_queued = true;
                } else {
                    data.queued.push_back((weight, id, DebugIgnore(future_fn)));
                }
            } else {
                // No ID associated with this future.
                this.global_weight.add_weight(weight);

                let global_slot = this.slots.reserve();
                let cx = FutureQueueContext {
                    global_slot,
                    group_slot: None,
                };
                let future = future_fn(cx);

                this.in_progress_queue.get_ref().push(FutureWithGW::new(
                    weight,
                    global_slot,
                    None,
                    future,
                ));
                any_queued = true;
            }
        }

        if any_queued {
            // Start any futures that were just queued up. If this returns Pending, then that's fine --
            // the task will be scheduled on the waker.
            let _ = this.in_progress_queue.as_mut().poll_peek(cx);
        }

        if let Some(output) = return_output {
            // A value was returned from the in-progress queue.
            Poll::Ready(Some(output))
        } else {
            match (
                self.stream.is_done(),
                self.in_progress_queue.is_terminated(),
            ) {
                (true, true) => {
                    // No more futures left to schedule. (Note that poll_pop_in_progress would have
                    // drained all futures in any queue.)
                    debug_assert_eq!(
                        self.group_store.num_queued_futures(),
                        0,
                        "no futures should be left in any group queue"
                    );
                    Poll::Ready(None)
                }
                (false, true) => {
                    // The in-progress queue is empty, but the stream is still pending.
                    // (Note that Poll::Pending is OK to return here because this can only happen in
                    // the Poll::Pending case above.)
                    Poll::Pending
                }
                (_, false) => {
                    // There are still futures in the in-progress queue. We need to poll the
                    // in-progress queue to start any futures in it.
                    let (output, any_queued) = ready!(self.as_mut().poll_pop_in_progress(cx));
                    if any_queued {
                        // It's possible that poll_pop_in_progress might have added more futures to the queue.
                        let this = self.project();
                        let _ = this.in_progress_queue.poll_peek(cx);
                    }
                    Poll::Ready(output)
                }
            }
        }
    }
}

impl<St, K> Stream for FutureQueueGrouped<St, K>
where
    St: Stream,
    St::Item: GroupedWeightedFuture,
    <St::Item as GroupedWeightedFuture>::Q: Eq + Hash + fmt::Debug,
    K: Eq + Hash + fmt::Debug + Borrow<<St::Item as GroupedWeightedFuture>::Q>,
{
    type Item = <<St::Item as GroupedWeightedFuture>::Future as Future>::Output;

    fn poll_next(mut self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Option<Self::Item>> {
        let ret = self.as_mut().poll_next_impl(cx);
        if self.extra_verify {
            self.verify_no_startable_queue_heads();
        }
        ret
    }

    fn size_hint(&self) -> (usize, Option<usize>) {
        // The minimum size is the in progress queue + any queued futures.
        let queue_len =
            self.in_progress_queue.size_hint().0 + self.group_store.num_queued_futures();
        let (lower, upper) = self.stream.size_hint();
        let lower = lower.saturating_add(queue_len);
        let upper = match upper {
            Some(x) => x.checked_add(queue_len),
            None => None,
        };
        (lower, upper)
    }
}

/// Attempts to start queued futures.
///
/// Returns true if any futures were started.
fn start_queued_futures<Q, F, Fut>(
    data: &mut GroupData<Q, F>,
    global_weight: &mut GlobalWeight,
    slots: &mut SlotReservations,
    in_progress_queue: &FuturesUnordered<FutureWithGW<Fut, Q>>,
) -> bool
where
    Q: fmt::Debug,
    F: FnOnce(FutureQueueContext) -> Fut,
{
    let mut any_started = false;
    while let Some(&(weight, _, _)) = data.queued.front() {
        if !data.can_start(weight, global_weight) {
            break;
        }

        let (weight, id, future_fn) = data
            .queued
            .pop_front()
            .expect("front() returned Some, so pop_front() returns Some");
        start_grouped_future(
            weight,
            id,
            future_fn.0,
            data,
            global_weight,
            slots,
            in_progress_queue,
        );
        any_started = true;
    }
    any_started
}

/// Starts a grouped future, adding it to the in-progress queue.
///
/// The caller must have checked that there is space in both the global and
/// group weights for this future. (See [`GroupData::can_start`].)
fn start_grouped_future<Q, F, Fut>(
    weight: usize,
    id: Q,
    future_fn: F,
    data: &mut GroupData<Q, F>,
    global_weight: &mut GlobalWeight,
    slots: &mut SlotReservations,
    in_progress_queue: &FuturesUnordered<FutureWithGW<Fut, Q>>,
) where
    Q: fmt::Debug,
    F: FnOnce(FutureQueueContext) -> Fut,
{
    global_weight.add_weight(weight);
    data.add_weight(&id, weight);

    let global_slot = slots.reserve();
    let group_slot = data.slots.reserve();

    let cx = FutureQueueContext {
        global_slot,
        group_slot: Some(group_slot),
    };
    let future = future_fn(cx);

    in_progress_queue.push(FutureWithGW::new(
        weight,
        global_slot,
        Some((id, group_slot)),
        future,
    ));
}

struct GroupStore<Q, K, F> {
    group_data: FnvHashMap<K, GroupData<Q, F>>,
}

impl<Q: fmt::Debug, K: fmt::Debug, F> fmt::Debug for GroupStore<Q, K, F> {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.debug_struct("GroupStore")
            .field("group_data", &self.group_data)
            .finish()
    }
}

impl<Q, K, F> GroupStore<Q, K, F>
where
    Q: Hash + Eq + fmt::Debug,
    K: Eq + Hash + fmt::Debug + Borrow<Q>,
{
    fn new(ids: impl IntoIterator<Item = (K, usize)>) -> Self {
        let id_data = ids
            .into_iter()
            .map(|(id, weight)| {
                let data = GroupData {
                    current_weight: 0,
                    max_weight: weight,
                    slots: SlotReservations::with_capacity(weight),
                    queued: VecDeque::new(),
                };
                (id, data)
            })
            .collect();

        Self {
            group_data: id_data,
        }
    }

    fn get_id_mut_or_unwrap(&mut self, id: &Q) -> &mut GroupData<Q, F> {
        if self.group_data.contains_key(id) {
            // Can't just use get_mut above because we're going to run into
            // https://doc.rust-lang.org/nomicon/lifetime-mismatch.html#improperly-reduced-borrows
            // with the else branch.
            self.group_data.get_mut(id).unwrap()
        } else {
            panic!(
                "unknown semaphore ID: {:?} (known IDs: {:?})",
                id,
                self.group_data.keys()
            );
        }
    }

    fn num_queued_futures(&self) -> usize {
        self.group_data.values().map(|data| data.queued.len()).sum()
    }
}

struct GroupData<Q, F> {
    current_weight: usize,
    max_weight: usize,
    slots: SlotReservations,
    queued: VecDeque<(usize, Q, DebugIgnore<F>)>,
}

impl<Q: fmt::Debug, F> fmt::Debug for GroupData<Q, F> {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.debug_struct("GroupData")
            .field("current_weight", &self.current_weight)
            .field("max_weight", &self.max_weight)
            .field("slots", &self.slots)
            .field("queued", &self.queued)
            .finish()
    }
}

impl<Q: fmt::Debug, Fut> GroupData<Q, Fut> {
    fn has_space_for(&self, weight: usize) -> bool {
        let weight = weight.min(self.max_weight);
        self.current_weight <= self.max_weight - weight
    }

    fn can_start(&self, weight: usize, global_weight: &GlobalWeight) -> bool {
        global_weight.has_space_for(weight) && self.has_space_for(weight)
    }

    // The ID is passed in only for its Debug impl.
    fn add_weight(&mut self, id: &Q, weight: usize) {
        let weight = weight.min(self.max_weight);
        self.current_weight = self.current_weight.checked_add(weight).unwrap_or_else(|| {
            panic!(
                "future_queue_grouped: for id `{:?}`, added weight {} to current {}, overflowed",
                id, weight, self.current_weight,
            )
        });
    }

    fn sub_weight(&mut self, id: &Q, weight: usize) {
        let weight = weight.min(self.max_weight);
        self.current_weight = self.current_weight.checked_sub(weight).unwrap_or_else(|| {
            panic!(
                "future_queue_grouped: for id `{:?}`, sub weight {} from current {}, underflowed",
                id, weight, self.current_weight,
            )
        });
    }
}

pin_project! {
    #[must_use = "futures do nothing unless polled"]
    struct FutureWithGW<Fut, Q> {
        #[pin]
        future: Fut,
        weight: usize,
        global_slot: u64,
        // The second parameter is the group slot.
        id_and_group_slot: Option<(Q, u64)>,
    }
}

impl<Fut, Q> FutureWithGW<Fut, Q> {
    pub fn new(
        weight: usize,
        global_slot: u64,
        id_and_group_slot: Option<(Q, u64)>,
        future: Fut,
    ) -> Self {
        Self {
            future,
            weight,
            global_slot,
            id_and_group_slot,
        }
    }
}

impl<Fut, Q> Future for FutureWithGW<Fut, Q>
where
    Fut: Future,
{
    type Output = (usize, u64, Option<(Q, u64)>, Fut::Output);
    fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output> {
        let this = self.project();

        match this.future.poll(cx) {
            Poll::Pending => Poll::Pending,
            Poll::Ready(output) => Poll::Ready((
                *this.weight,
                *this.global_slot,
                this.id_and_group_slot.take(),
                output,
            )),
        }
    }
}

/// A trait for types which can be converted into functions that return a
/// `Future`, an optional group, and a weight.
///
/// Provided in case it's necessary. This trait is only implemented for `(usize, Option<Q>, impl Future)`.
pub trait GroupedWeightedFuture: private::Sealed {
    /// The function to obtain the future from.
    type F: FnOnce(FutureQueueContext) -> Self::Future;

    /// The associated `Future` type.
    type Future: Future;

    /// The associated key lookup type.
    type Q;

    /// Returns the weight.
    fn weight(&self) -> usize;

    /// Turns self into its components.
    fn into_components(self) -> (usize, Option<Self::Q>, Self::F);
}

impl<F, Fut, Q> private::Sealed for (usize, Option<Q>, F)
where
    F: FnOnce(FutureQueueContext) -> Fut,
    Fut: Future,
{
}

impl<F, Fut, Q> GroupedWeightedFuture for (usize, Option<Q>, F)
where
    F: FnOnce(FutureQueueContext) -> Fut,
    Fut: Future,
{
    type F = F;
    type Future = Fut;
    type Q = Q;

    #[inline]
    fn weight(&self) -> usize {
        self.0
    }

    #[inline]
    fn into_components(self) -> (usize, Option<Self::Q>, Self::F) {
        self
    }
}

pub(crate) mod private {
    pub trait Sealed {}
}