1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004
//! [<img alt="github" src="https://img.shields.io/badge/github-udoprog/unicycle-8da0cb?style=for-the-badge&logo=github" height="20">](https://github.com/udoprog/unicycle)
//! [<img alt="crates.io" src="https://img.shields.io/crates/v/unicycle.svg?style=for-the-badge&color=fc8d62&logo=rust" height="20">](https://crates.io/crates/unicycle)
//! [<img alt="docs.rs" src="https://img.shields.io/badge/docs.rs-unicycle-66c2a5?style=for-the-badge&logoColor=white&logo=data:image/svg+xml;base64,PHN2ZyByb2xlPSJpbWciIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyIgdmlld0JveD0iMCAwIDUxMiA1MTIiPjxwYXRoIGZpbGw9IiNmNWY1ZjUiIGQ9Ik00ODguNiAyNTAuMkwzOTIgMjE0VjEwNS41YzAtMTUtOS4zLTI4LjQtMjMuNC0zMy43bC0xMDAtMzcuNWMtOC4xLTMuMS0xNy4xLTMuMS0yNS4zIDBsLTEwMCAzNy41Yy0xNC4xIDUuMy0yMy40IDE4LjctMjMuNCAzMy43VjIxNGwtOTYuNiAzNi4yQzkuMyAyNTUuNSAwIDI2OC45IDAgMjgzLjlWMzk0YzAgMTMuNiA3LjcgMjYuMSAxOS45IDMyLjJsMTAwIDUwYzEwLjEgNS4xIDIyLjEgNS4xIDMyLjIgMGwxMDMuOS01MiAxMDMuOSA1MmMxMC4xIDUuMSAyMi4xIDUuMSAzMi4yIDBsMTAwLTUwYzEyLjItNi4xIDE5LjktMTguNiAxOS45LTMyLjJWMjgzLjljMC0xNS05LjMtMjguNC0yMy40LTMzLjd6TTM1OCAyMTQuOGwtODUgMzEuOXYtNjguMmw4NS0zN3Y3My4zek0xNTQgMTA0LjFsMTAyLTM4LjIgMTAyIDM4LjJ2LjZsLTEwMiA0MS40LTEwMi00MS40di0uNnptODQgMjkxLjFsLTg1IDQyLjV2LTc5LjFsODUtMzguOHY3NS40em0wLTExMmwtMTAyIDQxLjQtMTAyLTQxLjR2LS42bDEwMi0zOC4yIDEwMiAzOC4ydi42em0yNDAgMTEybC04NSA0Mi41di03OS4xbDg1LTM4Ljh2NzUuNHptMC0xMTJsLTEwMiA0MS40LTEwMi00MS40di0uNmwxMDItMzguMiAxMDIgMzguMnYuNnoiPjwvcGF0aD48L3N2Zz4K" height="20">](https://docs.rs/unicycle)
//!
//! A scheduler for driving a large number of futures.
//!
//! Unicycle provides a collection of [Unordered] types:
//!
//! * [FuturesUnordered]
//! * [StreamsUnordered]
//! * [IndexedStreamsUnordered]
//!
//! These are async abstractions that runs a set of futures or streams which may
//! complete in any order.
//! Similarly to [FuturesUnordered][futures-rs] from the [futures crate].
//! But we aim to provide a stronger guarantee of fairness (see below), and
//! better memory locality for the futures being pollled.
//!
//! **Note:** This project is experimental. It involves some amount of unsafe and
//! possibly bad assumptions which needs to be either vetted or removed before you
//! should consider putting it in production.
//!
//! <br>
//!
//! ## Features
//!
//! * `parking-lot` - To enable locking using the [parking_lot] crate (default).
//! * `futures-rs` - Enable the used of the Stream type from [futures-rs].
//! This is required to get access to [StreamsUnordered] and
//! [IndexedStreamsUnordered] since these wrap over [futures-rs] types. (default)
//!
//! <br>
//!
//! ## Examples
//!
//! ```no_miri
//! use tokio::time;
//! use std::time::Duration;
//! use unicycle::FuturesUnordered;
//!
//! #[tokio::main]
//! async fn main() {
//! let mut futures = FuturesUnordered::new();
//!
//! futures.push(time::sleep(Duration::from_secs(2)));
//! futures.push(time::sleep(Duration::from_secs(3)));
//! futures.push(time::sleep(Duration::from_secs(1)));
//!
//! while let Some(_) = futures.next().await {
//! println!("tick");
//! }
//!
//! println!("done!");
//! }
//! ```
//!
//! [Unordered] types can be created from iterators:
//!
//! ```no_miri
//! use tokio::time;
//! use std::time::Duration;
//! use unicycle::FuturesUnordered;
//!
//! #[tokio::main]
//! async fn main() {
//! let mut futures = Vec::new();
//!
//! futures.push(time::sleep(Duration::from_secs(2)));
//! futures.push(time::sleep(Duration::from_secs(3)));
//! futures.push(time::sleep(Duration::from_secs(1)));
//!
//! let mut futures = futures.into_iter().collect::<FuturesUnordered<_>>();
//!
//! while let Some(_) = futures.next().await {
//! println!("tick");
//! }
//!
//! println!("done!");
//! }
//! ```
//!
//! <br>
//!
//! ## Fairness
//!
//! You can think of abstractions like Unicycle as schedulers. They are provided
//! a set of child tasks, and try to do their best to drive them to completion.
//! In this regard, it's interesting to talk about _fairness_ in how the tasks
//! are being driven.
//!
//! The current implementation of [FuturesUnordered][futures-rs] maintains a
//! queue of tasks interested in waking up. As a task is woken up it's added to
//! the head of this queue to signal its interest in being polled. When
//! [FuturesUnordered][futures-rs] works it drains this queue in a loop and
//! polls the associated task. This process has a side effect where tasks who
//! aggressively signal interest in waking up will receive priority and be
//! polled more frequently. Since there is a higher chance that while the queue
//! is being drained, their interest will be re-added at the head of the queue
//! immeidately. This can lead to instances where a small number of tasks can
//! can cause the polling loop of [FuturesUnordered][futures-rs] to [spin
//! abnormally]. This issue was [reported by Jon Gjengset] and is improved on by
//! [limiting the amount FuturesUnordered is allowed to spin].
//!
//! Unicycle addresses this by limiting how frequently a child task may be
//! polled per _polling cycle_. This is done by tracking polling interest in two
//! separate sets. Once we are polled, we swap out the active set then take the
//! swapped out set and use as a basis for what to poll in order while limiting
//! ourselves to only poll _once_ per child task. Additional wakeups are only
//! registered in the swapped in set which will be polled the next cycle.
//!
//! This way we hope to achieve a higher degree of fairness, never favoring the
//! behavior of one particular task.
//!
//! <br>
//!
//! ## Architecture
//!
//! The [Unordered] type stores all futures being polled in a continuous storage
//! [slab] where each future is stored in a separate allocation. The header of
//! this storage is atomically reference counted and can be used to construct a
//! waker without additional allocation.
//!
//! Next to the slab we maintain two [BitSets][BitSet], one _active_ and one
//! _alternate_. When a task registers interest in waking up, the bit associated
//! with its index is set in the active set, and the latest waker passed into
//! [Unordered] is called to wake it up. Once [Unordered] is polled, it
//! atomically swaps the active and alternate [BitSets][BitSet], waits until it
//! has exclusive access to the now _alternate_ [BitSet], and drains it from all
//! the indexes which have been flagged to determine which tasks to poll. Each
//! task is then polled _once_ in order. If the task is [Ready], its result is
//! yielded. After we receive control again, we continue draining the alternate
//! set in this manner, until it is empty. When this is done we yield once, then
//! we start the cycle over again.
//!
//! [BitSet]: https://docs.rs/uniset/latest/uniset/struct.BitSet.html
//! [futures crate]: https://docs.rs/futures/latest/futures
//! [futures-rs]: https://crates.io/crates/futures
//! [futures-rs]: https://docs.rs/futures/latest/futures/stream/struct.FuturesUnordered.html
//! [FuturesUnordered]: https://docs.rs/unicycle/latest/unicycle/type.FuturesUnordered.html
//! [IndexedStreamsUnordered]: https://docs.rs/unicycle/latest/unicycle/type.IndexedStreamsUnordered.html
//! [limiting the amount FuturesUnordered is allowed to spin]: https://github.com/rust-lang/futures-rs/pull/2049
//! [parking_lot]: https://crates.io/crates/parking_lot
//! [pin API]: https://doc.rust-lang.org/std/pin/index.html
//! [Ready]: https://doc.rust-lang.org/std/task/enum.Poll.html
//! [reported by Jon Gjengset]: https://github.com/rust-lang/futures-rs/issues/2047
//! [Slab]: https://docs.rs/slab/latest/slab/struct.Slab.html
//! [slab]: https://github.com/carllerche/slab
//! [spin abnormally]: https://github.com/udoprog/unicycle/blob/main/tests/spinning_futures_unordered_test.rs
//! [StreamsUnordered]: https://docs.rs/unicycle/latest/unicycle/type.StreamsUnordered.html
//! [Unordered]: https://docs.rs/unicycle/latest/unicycle/struct.Unordered.html
#![deny(missing_docs)]
#![cfg_attr(docsrs, feature(doc_cfg))]
#![deny(rustdoc::broken_intra_doc_links)]
#![allow(clippy::should_implement_trait)]
mod lock;
mod shared;
mod task;
#[cfg(test)]
mod tests;
mod wake_set;
mod waker;
use std::future::Future;
use std::iter;
use std::marker;
use std::pin::Pin;
use std::task::{Context, Poll};
use self::task::Storage;
use self::wake_set::WakeSet;
#[cfg(feature = "futures-rs")]
use futures_core::{FusedFuture, FusedStream, Stream};
/// Our very own homemade `ready!` impl.
macro_rules! ready {
($expr:expr) => {
match $expr {
Poll::Ready(value) => value,
Poll::Pending => return Poll::Pending,
}
};
}
/// A container for an unordered collection of [Future]s.
///
/// # Examples
///
/// ```rust,no_run
/// use tokio::time;
/// use std::time::Duration;
///
/// #[tokio::main]
/// async fn main() {
/// let mut futures = unicycle::FuturesUnordered::new();
///
/// futures.push(time::sleep(Duration::from_secs(2)));
/// futures.push(time::sleep(Duration::from_secs(3)));
/// futures.push(time::sleep(Duration::from_secs(1)));
///
/// while let Some(_) = futures.next().await {
/// println!("tick");
/// }
///
/// println!("done!");
/// }
/// ```
pub type FuturesUnordered<T> = Unordered<T, Futures>;
mod private {
pub trait Sealed {}
impl Sealed for super::Futures {}
#[cfg(feature = "futures-rs")]
impl Sealed for super::Streams {}
#[cfg(feature = "futures-rs")]
impl Sealed for super::IndexedStreams {}
}
/// Trait implemented by sentinels for the [Unordered] type.
pub trait Sentinel: self::private::Sealed {}
/// Sentinel type for futures.
///
/// [Unordered] instances which handle futures have the signature
/// `Unordered<T, Futures>`, since it allows for a different implementation of
/// [Stream].
pub struct Futures(());
impl Sentinel for Futures {}
/// A container for an unordered collection of [Future]s or [Stream]s.
///
/// You should use one of the following type aliases to construct it:
/// * [FuturesUnordered]
/// * [StreamsUnordered]
/// * [IndexedStreamsUnordered]
///
/// # Examples
///
/// ```rust,no_run
/// use tokio::time;
/// use std::time::Duration;
///
/// #[tokio::main]
/// async fn main() {
/// let mut futures = unicycle::FuturesUnordered::new();
///
/// futures.push(time::sleep(Duration::from_secs(2)));
/// futures.push(time::sleep(Duration::from_secs(3)));
/// futures.push(time::sleep(Duration::from_secs(1)));
///
/// while let Some(_) = futures.next().await {
/// println!("tick");
/// }
///
/// println!("done!");
/// }
/// ```
pub struct Unordered<T, S>
where
S: Sentinel,
{
/// Slab of futures being polled.
/// They need to be pinned on the heap, since the slab might grow to
/// accomodate more futures.
slab: Storage<T>,
/// Alternate wake set, used for growing the existing set when futures are
/// added. This is then swapped out with the active set to receive polls.
alternate: *mut WakeSet,
/// Marker for the sentinel.
_marker: marker::PhantomData<S>,
}
// Safety: Unordered is ultimately a container of `T`, and is `Send` only if `T`
// themselves are `Send`.
unsafe impl<T, S> Send for Unordered<T, S>
where
T: Send,
S: Sentinel,
{
}
// Safety: Unordered is ultimately a container of `T`, and is `Sync` only if `T`
// themselves are `Sync`.
unsafe impl<T, S> Sync for Unordered<T, S>
where
T: Sync,
S: Sentinel,
{
}
impl<T, S> Unpin for Unordered<T, S> where S: Sentinel {}
impl<T, S> Unordered<T, S>
where
S: Sentinel,
Self: PollNext,
{
/// Creates a future that resolves to the next item in the unordered set.
///
/// Functions like [`StreamExt::next`] would from the [futures] crate, but
/// doesn't depend on the [Stream] trait.
///
/// [`StreamExt::next`]: https://docs.rs/futures/latest/futures/stream/trait.StreamExt.html#method.next
/// [futures]: https://crates.io/crates/futures
///
/// # Examples
///
/// ```rust
/// use tokio::time;
/// use std::time::Duration;
/// use unicycle::FuturesUnordered;
///
/// #[tokio::main]
/// async fn main() {
/// let mut futures = FuturesUnordered::new();
///
/// futures.push(time::sleep(Duration::from_secs(2)));
/// futures.push(time::sleep(Duration::from_secs(3)));
/// futures.push(time::sleep(Duration::from_secs(1)));
///
/// while let Some(_) = futures.next().await {
/// println!("tick");
/// }
///
/// println!("done!");
/// }
/// ```
pub fn next(&mut self) -> Next<'_, Self> {
Next(self)
}
}
/// Future returned by [Unordered::next].
pub struct Next<'a, T>(&'a mut T);
impl<T> Future for Next<'_, T>
where
T: Unpin + PollNext,
{
type Output = Option<T::Item>;
fn poll(mut self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output> {
Pin::new(&mut *self.0).poll_next(cx)
}
}
impl<T> FuturesUnordered<T> {
/// Construct a new, empty [FuturesUnordered].
///
/// # Examples
///
/// ```
/// use unicycle::FuturesUnordered;
///
/// let mut futures = FuturesUnordered::new();
/// assert!(futures.is_empty());
///
/// futures.push(async { 42 });
/// ```
pub fn new() -> Self {
Self::new_internal()
}
}
/// Trait for providing a `poll_next` implementation for various unordered set
/// types.
///
/// This is like the lightweight unicycle version of the [Stream] trait, but we
/// provide it here so we can shim in our own generic [next] implementation.
///
/// [next]: Unordered::next
pub trait PollNext {
/// The output of the poll.
type Item;
/// Poll the stream for the next item.
///
/// Once this completes with `Poll::Ready(None)`, no more items are expected
/// and it should not be polled again.
fn poll_next(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Option<Self::Item>>;
}
impl<T> PollNext for FuturesUnordered<T>
where
T: Future,
{
type Item = T::Output;
/// Internal poll function for `FuturesUnordered<T>`.
fn poll_next(mut self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Option<T::Output>> {
let Self {
ref mut slab,
ref mut alternate,
..
} = *self.as_mut();
if slab.is_empty() {
// Nothing to poll, nothing to add. End the stream since we don't have work to do.
return Poll::Ready(None);
}
// Safety: We have exclusive access to Unordered, which is the only
// implementation that is trying to swap the wake sets.
let (non_empty, wake_last) =
ready!(unsafe { slab.shared().poll_swap_active(cx, alternate) });
for index in wake_last.drain() {
// NB: Since we defer pollables a little, a future might
// have been polled and subsequently removed from the slab.
// So we don't treat this as an error here.
// If on the other hand it was removed _and_ re-added, we have
// a case of a spurious poll. Luckily, that doesn't bother a
// future much.
let (header, fut) = match slab.get_pin_mut(index) {
Some(value) => value,
None => continue,
};
// Construct a new lightweight waker only capable of waking by
// reference, with referential access to `shared`.
let result = self::waker::poll_with_ref(header, move |cx| fut.poll(cx));
if let Poll::Ready(result) = result {
let removed = slab.remove(index);
debug_assert!(removed);
return Poll::Ready(Some(result));
}
}
if slab.is_empty() {
return Poll::Ready(None);
}
// We need to wake again to take care of the alternate set that was
// swapped in.
if non_empty {
cx.waker().wake_by_ref();
}
Poll::Pending
}
}
impl<T, S> Unordered<T, S>
where
S: Sentinel,
{
#[inline(always)]
fn new_internal() -> Self {
Self {
slab: Storage::new(),
alternate: Box::into_raw(Box::new(WakeSet::locked())),
_marker: marker::PhantomData,
}
}
/// Get the number of elements in the collection of futures.
///
/// # Examples
///
/// ```
/// use std::future::Ready;
/// use unicycle::FuturesUnordered;
///
/// let mut futures = FuturesUnordered::<Ready<()>>::new();
/// assert_eq!(futures.len(), 0);
/// assert!(futures.is_empty());
/// ```
pub fn len(&self) -> usize {
self.slab.len()
}
/// Test if the collection of futures is empty.
///
/// # Examples
///
/// ```
/// use std::future::Ready;
/// use unicycle::FuturesUnordered;
///
/// let mut futures = FuturesUnordered::<Ready<()>>::new();
/// assert!(futures.is_empty());
/// ```
pub fn is_empty(&self) -> bool {
self.slab.is_empty()
}
/// Push the given future or stream to [Unordered] and return its task
/// index.
///
/// Newly added futures are guaranteed to be polled, but there is no
/// guarantee in which order this will happen.
///
/// Pushed tasks are pinned by the [Unordered] collection automatically.
///
/// # Examples
///
/// ```
/// use unicycle::FuturesUnordered;
///
/// let mut futures = FuturesUnordered::new();
/// assert!(futures.is_empty());
/// futures.push(async { 42 });
/// assert!(!futures.is_empty());
/// ```
pub fn push(&mut self, future: T) -> usize {
let index = self.slab.insert(future);
let (old, new) = {
// Safety: At this point we know we have exclusive access to the set.
let set = unsafe { (*self.alternate).as_mut_set() };
let old = set.capacity();
set.set(index);
let new = set.capacity();
(old, new)
};
// Fast Path: Did not grow the alternate set, so no need to grow the
// active set either.
if new <= old {
return index;
}
// Slow Path: Swap out the active set and grow it to accomodate the same
// number of elements as the now alternate set was grown to.
// This works out, because if it's non-empty, the next time we poll
// the unordered set it will be processed. It it's empty, it will be
// swapped out with the active set which now contains the newly added
// futures.
// Safety: We have unique access to the alternate set being modified.
unsafe {
self.slab
.shared()
.swap_active(&mut self.alternate)
.reserve(new);
}
index
}
/// Get a pinned mutable reference to the stream or future at the given
/// index.
///
/// # Examples
///
/// ```rust
/// use unicycle::FuturesUnordered;
/// use futures::future::poll_fn;
/// use std::future::Future as _;
///
/// #[tokio::main]
/// async fn main() {
/// let mut futures = FuturesUnordered::new();
/// let index = futures.push(async { 42 });
///
/// let result = poll_fn(|cx| {
/// futures.get_pin_mut(index).expect("expected future").poll(cx)
/// }).await;
///
/// assert_eq!(result, 42);
/// }
/// ```
pub fn get_pin_mut(&mut self, index: usize) -> Option<Pin<&mut T>> {
Some(self.slab.get_pin_mut(index)?.1)
}
/// Get a mutable reference to the stream or future at the given index.
/// Requires that the stores stream or future is [Unpin].
///
/// # Examples
///
/// ```rust
/// use unicycle::FuturesUnordered;
/// use futures::future::{ready, poll_fn};
/// use std::{pin::Pin, future::Future as _};
///
/// #[tokio::main]
/// async fn main() {
/// let mut futures = FuturesUnordered::new();
/// let index = futures.push(ready(42));
///
/// let result = poll_fn(|cx| {
/// Pin::new(futures.get_mut(index).expect("expected future")).poll(cx)
/// }).await;
///
/// assert_eq!(result, 42);
/// }
/// ```
pub fn get_mut(&mut self, index: usize) -> Option<&mut T>
where
T: Unpin,
{
self.slab.get_mut(index)
}
}
impl<T> Default for Unordered<T, Futures> {
fn default() -> Self {
Self::new()
}
}
impl<T, S> Drop for Unordered<T, S>
where
S: Sentinel,
{
fn drop(&mut self) {
// Cancel all child futures in an attempt to prevent them from
// attempting to call wake on the shared wake set.
self.slab.clear();
// We intend to drop both wake sets. Therefore we need exclusive access
// to both wakers. Unfortunately that means that at this point, any call
// to wakes will have to serialize behind the shared wake set while the
// alternate set is being dropped.
let _write = self.slab.shared().wake_set.prevent_drop_write();
// Safety: we uniquely own `alternate`, so we are responsible for
// dropping it. This is asserted when we swap it out during a poll by
// calling WakeSet::lock_exclusive. We are also the _only_ one
// swapping `wake_alternative`, so we know that can't happen here.
unsafe {
drop(Box::from_raw(self.alternate));
}
}
}
impl<T, S> iter::Extend<T> for Unordered<T, S>
where
S: Sentinel,
{
fn extend<I>(&mut self, iter: I)
where
I: IntoIterator<Item = T>,
{
for value in iter {
self.push(value);
}
}
}
impl<T> iter::FromIterator<T> for FuturesUnordered<T>
where
T: Future,
{
#[inline]
fn from_iter<I: IntoIterator<Item = T>>(iter: I) -> Self {
let mut futures = FuturesUnordered::new();
futures.extend(iter);
futures
}
}
macro_rules! cfg_futures_rs {
($($item:item)*) => {
$(
#[cfg(feature = "futures-rs")]
#[cfg_attr(docsrs, doc(cfg(feature = "futures-rs")))]
$item
)*
}
}
cfg_futures_rs! {
/// Sentinel type for streams.
///
/// [Unordered] instances which handle futures have the signature
/// `Unordered<T, Streams>`, since it allows for a different implementation of
/// [Stream].
pub struct Streams(());
impl Sentinel for Streams {}
/// Sentinel type for streams which are indexed - for each value they yield,
/// they also yield the task identifier associated with them.
///
/// [Unordered] instances which handle futures have the signature
/// `Unordered<T, IndexedStreams>`, since it allows for a different
/// implementation of [Stream].
pub struct IndexedStreams(());
impl Sentinel for IndexedStreams {}
/// A container for an unordered collection of [Stream]s.
///
/// # Examples
///
/// ```rust,no_run
/// use tokio::{net::TcpListener, time};
/// use tokio_util::codec::{Framed, LengthDelimitedCodec};
/// use std::error::Error;
///
/// #[tokio::main]
/// async fn main() -> Result<(), Box<dyn Error>> {
/// let mut listener = TcpListener::bind("127.0.0.1:8080").await?;
/// let mut clients = unicycle::StreamsUnordered::new();
///
/// loop {
/// tokio::select! {
/// result = listener.accept() => {
/// let (stream, _) = result?;
/// clients.push(Framed::new(stream, LengthDelimitedCodec::new()));
/// },
/// Some(frame) = clients.next() => {
/// println!("received frame: {:?}", frame);
/// }
/// }
/// }
/// }
/// ```
pub type StreamsUnordered<T> = Unordered<T, Streams>;
/// A container for an unordered collection of [Stream]s, which also yields the
/// index that produced the next item.
///
/// # Examples
///
/// ```rust,no_run
/// use tokio::{net::TcpListener, time};
/// use tokio_util::codec::{Framed, LengthDelimitedCodec};
/// use std::error::Error;
///
/// #[tokio::main]
/// async fn main() -> Result<(), Box<dyn Error>> {
/// let mut listener = TcpListener::bind("127.0.0.1:8080").await?;
/// let mut clients = unicycle::IndexedStreamsUnordered::new();
///
/// loop {
/// tokio::select! {
/// result = listener.accept() => {
/// let (stream, _) = result?;
/// clients.push(Framed::new(stream, LengthDelimitedCodec::new()));
/// },
/// Some((index, frame)) = clients.next() => {
/// match frame {
/// Some(frame) => println!("{}: received frame: {:?}", index, frame),
/// None => println!("{}: client disconnected", index),
/// }
/// }
/// }
/// }
/// }
/// ```
pub type IndexedStreamsUnordered<T> = Unordered<T, IndexedStreams>;
impl<T> StreamsUnordered<T> {
/// Construct a new, empty [StreamsUnordered].
///
/// # Examples
///
/// ```rust
/// use tokio_stream::iter;
/// use unicycle::StreamsUnordered;
///
/// #[tokio::main]
/// async fn main() {
/// let mut streams = StreamsUnordered::new();
/// assert!(streams.is_empty());
///
/// streams.push(iter(vec![1, 2, 3, 4]));
/// streams.push(iter(vec![5, 6, 7, 8]));
///
/// let mut received = Vec::new();
///
/// while let Some(value) = streams.next().await {
/// received.push(value);
/// }
///
/// assert_eq!(vec![5, 1, 6, 2, 7, 3, 8, 4], received);
/// }
/// ```
pub fn new() -> Self {
Self::new_internal()
}
}
impl<T> IndexedStreamsUnordered<T> {
/// Construct a new, empty [IndexedStreamsUnordered].
///
/// This is the same as [StreamsUnordered], except that it yields the index
/// of the stream who'se value was just yielded, alongside the yielded
/// value.
///
/// # Examples
///
/// ```rust
/// use tokio_stream::iter;
/// use unicycle::IndexedStreamsUnordered;
///
/// #[tokio::main]
/// async fn main() {
/// let mut streams = IndexedStreamsUnordered::new();
/// assert!(streams.is_empty());
///
/// streams.push(iter(vec![1, 2]));
/// streams.push(iter(vec![5, 6]));
///
/// let mut received = Vec::new();
///
/// while let Some(value) = streams.next().await {
/// received.push(value);
/// }
///
/// assert_eq!(
/// vec![
/// (1, Some(5)),
/// (0, Some(1)),
/// (1, Some(6)),
/// (0, Some(2)),
/// (1, None),
/// (0, None)
/// ],
/// received
/// );
/// }
/// ```
pub fn new() -> Self {
Self::new_internal()
}
}
/// Provide `Stream` implementation through `PollNext`.
impl<T, S> Stream for Unordered<T, S>
where
S: Sentinel,
Self: PollNext,
{
type Item = <Self as PollNext>::Item;
fn poll_next(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Option<Self::Item>> {
<Self as PollNext>::poll_next(self, cx)
}
}
impl<T, S> FusedStream for Unordered<T, S> where S: Sentinel, Self: PollNext, {
fn is_terminated(&self) -> bool {
self.is_empty()
}
}
impl<T> PollNext for StreamsUnordered<T>
where
T: Stream,
{
type Item = T::Item;
fn poll_next(mut self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Option<Self::Item>> {
let Self {
ref mut slab,
ref mut alternate,
..
} = *self.as_mut();
if slab.is_empty() {
// Nothing to poll, nothing to add. End the stream since we don't have work to do.
return Poll::Ready(None);
}
// Safety: We have exclusive access to Unordered, which is the only
// implementation that is trying to swap the wake sets.
let (non_empty, wake_last) = ready!(unsafe { slab.shared().poll_swap_active(cx, alternate) });
for index in wake_last.drain() {
// NB: Since we defer pollables a little, a future might
// have been polled and subsequently removed from the slab.
// So we don't treat this as an error here.
// If on the other hand it was removed _and_ re-added, we have
// a case of a spurious poll. Luckily, that doesn't bother a
// future much.
let (header, stream) = match slab.get_pin_mut(index) {
Some(value) => value,
None => continue,
};
// Construct a new lightweight waker only capable of waking by
// reference, with referential access to `shared`.
let result = self::waker::poll_with_ref(header, move |cx| stream.poll_next(cx));
if let Poll::Ready(result) = result {
match result {
Some(value) => {
cx.waker().wake_by_ref();
slab.shared().wake_set.wake(index);
return Poll::Ready(Some(value));
}
None => {
let removed = slab.remove(index);
debug_assert!(removed);
}
}
}
}
// We have successfully polled the last snapshot.
// Yield and make sure that we are polled again.
if slab.is_empty() {
return Poll::Ready(None);
}
// We need to wake again to take care of the alternate set that was
// swapped in.
if non_empty {
cx.waker().wake_by_ref();
}
Poll::Pending
}
}
impl<T> PollNext for IndexedStreamsUnordered<T>
where
T: Stream,
{
type Item = (usize, Option<T::Item>);
fn poll_next(mut self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Option<Self::Item>> {
let Self {
ref mut slab,
ref mut alternate,
..
} = *self.as_mut();
if slab.is_empty() {
// Nothing to poll, nothing to add. End the stream since we don't have work to do.
return Poll::Ready(None);
}
// Safety: We have exclusive access to Unordered, which is the only
// implementation that is trying to swap the wake sets.
let (non_empty, wake_last) = ready!(unsafe { slab.shared().poll_swap_active(cx, alternate) });
for index in wake_last.drain() {
// NB: Since we defer pollables a little, a future might
// have been polled and subsequently removed from the slab.
// So we don't treat this as an error here.
// If on the other hand it was removed _and_ re-added, we have
// a case of a spurious poll. Luckily, that doesn't bother a
// future much.
let (header, stream) = match slab.get_pin_mut(index) {
Some((header, stream)) => (header, stream),
None => continue,
};
// Construct a new lightweight waker only capable of waking by
// reference, with referential access to `shared`.
let result = self::waker::poll_with_ref(header, move |cx| stream.poll_next(cx));
if let Poll::Ready(result) = result {
match result {
Some(value) => {
cx.waker().wake_by_ref();
slab.shared().wake_set.wake(index);
return Poll::Ready(Some((index, Some(value))));
}
None => {
cx.waker().wake_by_ref();
let removed = slab.remove(index);
debug_assert!(removed);
return Poll::Ready(Some((index, None)));
}
}
}
}
// We have successfully polled the last snapshot.
// Yield and make sure that we are polled again.
if slab.is_empty() {
return Poll::Ready(None);
}
// We need to wake again to take care of the alternate set that was
// swapped in.
if non_empty {
cx.waker().wake_by_ref();
}
Poll::Pending
}
}
impl<T> iter::FromIterator<T> for StreamsUnordered<T>
where
T: Stream,
{
#[inline]
fn from_iter<I: IntoIterator<Item = T>>(iter: I) -> Self {
let mut streams = StreamsUnordered::new();
streams.extend(iter);
streams
}
}
impl<T> FusedFuture for Next<'_, T>
where
T: Unpin + PollNext + FusedStream,
{
fn is_terminated(&self) -> bool {
self.0.is_terminated()
}
}
}