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
use alloc::sync::Arc;
use core::{
cell::UnsafeCell,
convert::identity,
fmt,
marker::PhantomData,
num::NonZeroUsize,
pin::Pin,
sync::atomic::{AtomicU8, Ordering},
};
use pin_project_lite::pin_project;
use futures_core::{
future::Future,
ready,
stream::{FusedStream, Stream},
task::{Context, Poll, Waker},
};
#[cfg(feature = "sink")]
use futures_sink::Sink;
use futures_task::{waker, ArcWake};
use crate::stream::FuturesUnordered;
/// Stream for the [`flatten_unordered`](super::StreamExt::flatten_unordered)
/// method.
pub type FlattenUnordered<St> = FlattenUnorderedWithFlowController<St, ()>;
/// There is nothing to poll and stream isn't being polled/waking/woken at the moment.
const NONE: u8 = 0;
/// Inner streams need to be polled.
const NEED_TO_POLL_INNER_STREAMS: u8 = 1;
/// The base stream needs to be polled.
const NEED_TO_POLL_STREAM: u8 = 0b10;
/// Both base stream and inner streams need to be polled.
const NEED_TO_POLL_ALL: u8 = NEED_TO_POLL_INNER_STREAMS | NEED_TO_POLL_STREAM;
/// The current stream is being polled at the moment.
const POLLING: u8 = 0b100;
/// Stream is being woken at the moment.
const WAKING: u8 = 0b1000;
/// The stream was waked and will be polled.
const WOKEN: u8 = 0b10000;
/// Internal polling state of the stream.
#[derive(Clone, Debug)]
struct SharedPollState {
state: Arc<AtomicU8>,
}
impl SharedPollState {
/// Constructs new `SharedPollState` with the given state.
fn new(value: u8) -> SharedPollState {
SharedPollState { state: Arc::new(AtomicU8::new(value)) }
}
/// Attempts to start polling, returning stored state in case of success.
/// Returns `None` if either waker is waking at the moment.
fn start_polling(
&self,
) -> Option<(u8, PollStateBomb<'_, impl FnOnce(&SharedPollState) -> u8>)> {
let value = self
.state
.fetch_update(Ordering::SeqCst, Ordering::SeqCst, |value| {
if value & WAKING == NONE {
Some(POLLING)
} else {
None
}
})
.ok()?;
let bomb = PollStateBomb::new(self, SharedPollState::reset);
Some((value, bomb))
}
/// Attempts to start the waking process and performs bitwise or with the given value.
///
/// If some waker is already in progress or stream is already woken/being polled, waking process won't start, however
/// state will be disjuncted with the given value.
fn start_waking(
&self,
to_poll: u8,
) -> Option<(u8, PollStateBomb<'_, impl FnOnce(&SharedPollState) -> u8>)> {
let value = self
.state
.fetch_update(Ordering::SeqCst, Ordering::SeqCst, |value| {
let mut next_value = value | to_poll;
if value & (WOKEN | POLLING) == NONE {
next_value |= WAKING;
}
if next_value != value {
Some(next_value)
} else {
None
}
})
.ok()?;
// Only start the waking process if we're not in the polling/waking phase and the stream isn't woken already
if value & (WOKEN | POLLING | WAKING) == NONE {
let bomb = PollStateBomb::new(self, SharedPollState::stop_waking);
Some((value, bomb))
} else {
None
}
}
/// Sets current state to
/// - `!POLLING` allowing to use wakers
/// - `WOKEN` if the state was changed during `POLLING` phase as waker will be called,
/// or `will_be_woken` flag supplied
/// - `!WAKING` as
/// * Wakers called during the `POLLING` phase won't propagate their calls
/// * `POLLING` phase can't start if some of the wakers are active
/// So no wrapped waker can touch the inner waker's cell, it's safe to poll again.
fn stop_polling(&self, to_poll: u8, will_be_woken: bool) -> u8 {
self.state
.fetch_update(Ordering::SeqCst, Ordering::SeqCst, |mut value| {
let mut next_value = to_poll;
value &= NEED_TO_POLL_ALL;
if value != NONE || will_be_woken {
next_value |= WOKEN;
}
next_value |= value;
Some(next_value & !POLLING & !WAKING)
})
.unwrap()
}
/// Toggles state to non-waking, allowing to start polling.
fn stop_waking(&self) -> u8 {
let value = self
.state
.fetch_update(Ordering::SeqCst, Ordering::SeqCst, |value| {
let next_value = value & !WAKING | WOKEN;
if next_value != value {
Some(next_value)
} else {
None
}
})
.unwrap_or_else(identity);
debug_assert!(value & (WOKEN | POLLING | WAKING) == WAKING);
value
}
/// Resets current state allowing to poll the stream and wake up wakers.
fn reset(&self) -> u8 {
self.state.swap(NEED_TO_POLL_ALL, Ordering::SeqCst)
}
}
/// Used to execute some function on the given state when dropped.
struct PollStateBomb<'a, F: FnOnce(&SharedPollState) -> u8> {
state: &'a SharedPollState,
drop: Option<F>,
}
impl<'a, F: FnOnce(&SharedPollState) -> u8> PollStateBomb<'a, F> {
/// Constructs new bomb with the given state.
fn new(state: &'a SharedPollState, drop: F) -> Self {
Self { state, drop: Some(drop) }
}
/// Deactivates bomb, forces it to not call provided function when dropped.
fn deactivate(mut self) {
self.drop.take();
}
}
impl<F: FnOnce(&SharedPollState) -> u8> Drop for PollStateBomb<'_, F> {
fn drop(&mut self) {
if let Some(drop) = self.drop.take() {
(drop)(self.state);
}
}
}
/// Will update state with the provided value on `wake_by_ref` call
/// and then, if there is a need, call `inner_waker`.
struct WrappedWaker {
inner_waker: UnsafeCell<Option<Waker>>,
poll_state: SharedPollState,
need_to_poll: u8,
}
unsafe impl Send for WrappedWaker {}
unsafe impl Sync for WrappedWaker {}
impl WrappedWaker {
/// Replaces given waker's inner_waker for polling stream/futures which will
/// update poll state on `wake_by_ref` call. Use only if you need several
/// contexts.
///
/// ## Safety
///
/// This function will modify waker's `inner_waker` via `UnsafeCell`, so
/// it should be used only during `POLLING` phase by one thread at the time.
unsafe fn replace_waker(self_arc: &mut Arc<Self>, cx: &Context<'_>) {
*self_arc.inner_waker.get() = cx.waker().clone().into();
}
/// Attempts to start the waking process for the waker with the given value.
/// If succeeded, then the stream isn't yet woken and not being polled at the moment.
fn start_waking(&self) -> Option<(u8, PollStateBomb<'_, impl FnOnce(&SharedPollState) -> u8>)> {
self.poll_state.start_waking(self.need_to_poll)
}
}
impl ArcWake for WrappedWaker {
fn wake_by_ref(self_arc: &Arc<Self>) {
if let Some((_, state_bomb)) = self_arc.start_waking() {
// Safety: now state is not `POLLING`
let waker_opt = unsafe { self_arc.inner_waker.get().as_ref().unwrap() };
if let Some(inner_waker) = waker_opt.clone() {
// Stop waking to allow polling stream
drop(state_bomb);
// Wake up inner waker
inner_waker.wake();
}
}
}
}
pin_project! {
/// Future which polls optional inner stream.
///
/// If it's `Some`, it will attempt to call `poll_next` on it,
/// returning `Some((item, next_item_fut))` in case of `Poll::Ready(Some(...))`
/// or `None` in case of `Poll::Ready(None)`.
///
/// If `poll_next` will return `Poll::Pending`, it will be forwarded to
/// the future and current task will be notified by waker.
#[must_use = "futures do nothing unless you `.await` or poll them"]
struct PollStreamFut<St> {
#[pin]
stream: Option<St>,
}
}
impl<St> PollStreamFut<St> {
/// Constructs new `PollStreamFut` using given `stream`.
fn new(stream: impl Into<Option<St>>) -> Self {
Self { stream: stream.into() }
}
}
impl<St: Stream + Unpin> Future for PollStreamFut<St> {
type Output = Option<(St::Item, PollStreamFut<St>)>;
fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output> {
let mut stream = self.project().stream;
let item = if let Some(stream) = stream.as_mut().as_pin_mut() {
ready!(stream.poll_next(cx))
} else {
None
};
let next_item_fut = PollStreamFut::new(stream.get_mut().take());
let out = item.map(|item| (item, next_item_fut));
Poll::Ready(out)
}
}
pin_project! {
/// Stream for the [`flatten_unordered`](super::StreamExt::flatten_unordered)
/// method with ability to specify flow controller.
#[project = FlattenUnorderedWithFlowControllerProj]
#[must_use = "streams do nothing unless polled"]
pub struct FlattenUnorderedWithFlowController<St, Fc> where St: Stream {
#[pin]
inner_streams: FuturesUnordered<PollStreamFut<St::Item>>,
#[pin]
stream: St,
poll_state: SharedPollState,
limit: Option<NonZeroUsize>,
is_stream_done: bool,
inner_streams_waker: Arc<WrappedWaker>,
stream_waker: Arc<WrappedWaker>,
flow_controller: PhantomData<Fc>
}
}
impl<St, Fc> fmt::Debug for FlattenUnorderedWithFlowController<St, Fc>
where
St: Stream + fmt::Debug,
St::Item: Stream + fmt::Debug,
{
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
f.debug_struct("FlattenUnorderedWithFlowController")
.field("poll_state", &self.poll_state)
.field("inner_streams", &self.inner_streams)
.field("limit", &self.limit)
.field("stream", &self.stream)
.field("is_stream_done", &self.is_stream_done)
.field("flow_controller", &self.flow_controller)
.finish()
}
}
impl<St, Fc> FlattenUnorderedWithFlowController<St, Fc>
where
St: Stream,
Fc: FlowController<St::Item, <St::Item as Stream>::Item>,
St::Item: Stream + Unpin,
{
pub(crate) fn new(
stream: St,
limit: Option<usize>,
) -> FlattenUnorderedWithFlowController<St, Fc> {
let poll_state = SharedPollState::new(NEED_TO_POLL_STREAM);
FlattenUnorderedWithFlowController {
inner_streams: FuturesUnordered::new(),
stream,
is_stream_done: false,
limit: limit.and_then(NonZeroUsize::new),
inner_streams_waker: Arc::new(WrappedWaker {
inner_waker: UnsafeCell::new(None),
poll_state: poll_state.clone(),
need_to_poll: NEED_TO_POLL_INNER_STREAMS,
}),
stream_waker: Arc::new(WrappedWaker {
inner_waker: UnsafeCell::new(None),
poll_state: poll_state.clone(),
need_to_poll: NEED_TO_POLL_STREAM,
}),
poll_state,
flow_controller: PhantomData,
}
}
delegate_access_inner!(stream, St, ());
}
/// Returns the next flow step based on the received item.
pub trait FlowController<I, O> {
/// Handles an item producing `FlowStep` describing the next flow step.
fn next_step(item: I) -> FlowStep<I, O>;
}
impl<I, O> FlowController<I, O> for () {
fn next_step(item: I) -> FlowStep<I, O> {
FlowStep::Continue(item)
}
}
/// Describes the next flow step.
#[derive(Debug, Clone)]
pub enum FlowStep<C, R> {
/// Just yields an item and continues standard flow.
Continue(C),
/// Immediately returns an underlying item from the function.
Return(R),
}
impl<St, Fc> FlattenUnorderedWithFlowControllerProj<'_, St, Fc>
where
St: Stream,
{
/// Checks if current `inner_streams` bucket size is greater than optional limit.
fn is_exceeded_limit(&self) -> bool {
self.limit.map_or(false, |limit| self.inner_streams.len() >= limit.get())
}
}
impl<St, Fc> FusedStream for FlattenUnorderedWithFlowController<St, Fc>
where
St: FusedStream,
Fc: FlowController<St::Item, <St::Item as Stream>::Item>,
St::Item: Stream + Unpin,
{
fn is_terminated(&self) -> bool {
self.stream.is_terminated() && self.inner_streams.is_empty()
}
}
impl<St, Fc> Stream for FlattenUnorderedWithFlowController<St, Fc>
where
St: Stream,
Fc: FlowController<St::Item, <St::Item as Stream>::Item>,
St::Item: Stream + Unpin,
{
type Item = <St::Item as Stream>::Item;
fn poll_next(mut self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Option<Self::Item>> {
let mut next_item = None;
let mut need_to_poll_next = NONE;
let mut this = self.as_mut().project();
// Attempt to start polling, in case some waker is holding the lock, wait in loop
let (mut poll_state_value, state_bomb) = loop {
if let Some(value) = this.poll_state.start_polling() {
break value;
}
};
// Safety: now state is `POLLING`.
unsafe {
WrappedWaker::replace_waker(this.stream_waker, cx);
WrappedWaker::replace_waker(this.inner_streams_waker, cx)
};
if poll_state_value & NEED_TO_POLL_STREAM != NONE {
let mut stream_waker = None;
// Here we need to poll the base stream.
//
// To improve performance, we will attempt to place as many items as we can
// to the `FuturesUnordered` bucket before polling inner streams
loop {
if this.is_exceeded_limit() || *this.is_stream_done {
// We either exceeded the limit or the stream is exhausted
if !*this.is_stream_done {
// The stream needs to be polled in the next iteration
need_to_poll_next |= NEED_TO_POLL_STREAM;
}
break;
} else {
let mut cx = Context::from_waker(
stream_waker.get_or_insert_with(|| waker(this.stream_waker.clone())),
);
match this.stream.as_mut().poll_next(&mut cx) {
Poll::Ready(Some(item)) => {
let next_item_fut = match Fc::next_step(item) {
// Propagates an item immediately (the main use-case is for errors)
FlowStep::Return(item) => {
need_to_poll_next |= NEED_TO_POLL_STREAM
| (poll_state_value & NEED_TO_POLL_INNER_STREAMS);
poll_state_value &= !NEED_TO_POLL_INNER_STREAMS;
next_item = Some(item);
break;
}
// Yields an item and continues processing (normal case)
FlowStep::Continue(inner_stream) => {
PollStreamFut::new(inner_stream)
}
};
// Add new stream to the inner streams bucket
this.inner_streams.as_mut().push(next_item_fut);
// Inner streams must be polled afterward
poll_state_value |= NEED_TO_POLL_INNER_STREAMS;
}
Poll::Ready(None) => {
// Mark the base stream as done
*this.is_stream_done = true;
}
Poll::Pending => {
break;
}
}
}
}
}
if poll_state_value & NEED_TO_POLL_INNER_STREAMS != NONE {
let inner_streams_waker = waker(this.inner_streams_waker.clone());
let mut cx = Context::from_waker(&inner_streams_waker);
match this.inner_streams.as_mut().poll_next(&mut cx) {
Poll::Ready(Some(Some((item, next_item_fut)))) => {
// Push next inner stream item future to the list of inner streams futures
this.inner_streams.as_mut().push(next_item_fut);
// Take the received item
next_item = Some(item);
// On the next iteration, inner streams must be polled again
need_to_poll_next |= NEED_TO_POLL_INNER_STREAMS;
}
Poll::Ready(Some(None)) => {
// On the next iteration, inner streams must be polled again
need_to_poll_next |= NEED_TO_POLL_INNER_STREAMS;
}
_ => {}
}
}
// We didn't have any `poll_next` panic, so it's time to deactivate the bomb
state_bomb.deactivate();
// Call the waker at the end of polling if
let mut force_wake =
// we need to poll the stream and didn't reach the limit yet
need_to_poll_next & NEED_TO_POLL_STREAM != NONE && !this.is_exceeded_limit()
// or we need to poll the inner streams again
|| need_to_poll_next & NEED_TO_POLL_INNER_STREAMS != NONE;
// Stop polling and swap the latest state
poll_state_value = this.poll_state.stop_polling(need_to_poll_next, force_wake);
// If state was changed during `POLLING` phase, we also need to manually call a waker
force_wake |= poll_state_value & NEED_TO_POLL_ALL != NONE;
let is_done = *this.is_stream_done && this.inner_streams.is_empty();
if next_item.is_some() || is_done {
Poll::Ready(next_item)
} else {
if force_wake {
cx.waker().wake_by_ref();
}
Poll::Pending
}
}
}
// Forwarding impl of Sink from the underlying stream
#[cfg(feature = "sink")]
impl<St, Item, Fc> Sink<Item> for FlattenUnorderedWithFlowController<St, Fc>
where
St: Stream + Sink<Item>,
{
type Error = St::Error;
delegate_sink!(stream, Item);
}