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
//! # local-pool-with-id //! A minor variation on a [LocalPool](https://docs.rs/futures/0.3/futures/executor/struct.LocalPool.html) executor which exposes unique IDs for tracking future completion. //! //! This should almost be a drop in replacement for the existing LocalPool. All existing traits are still implemented. There are two API differences: //! 1. New `(Local)SpawnWithId` traits have been implemented. These accept the same arguments as their non-ID counterparts but return a unique ID that can be used to identify whether a spawned future has been completed. //! 2. `try_run_one` now returns an `Option<usize>` instead of a boolean. This usize will correspond to the ID received from the previous APIs and can be used with external tracking mechanism to know if a future is complete. //! //! ## Motivation //! The existing `LocalPool` allowed you to run all futures, opaquely, in a non-blocking way or to, blockingly, run a single future to completion and retrieve it's output. By providing tracking IDs, we can use an external lookup to infer which futures are finished and ask them for their results directly. //! //! ## Example //! ```rust //! use local_pool_with_id::SpawnWithIdExt; //! use futures::prelude::*; //! //! let mut spawned_ids = std::collections::HashSet::new(); //! let mut pool = local_pool_with_id::LocalPool::new(); //! let spawner = pool.spawner(); //! //! let (id1, handle1) = spawner //! .spawn_with_handle(futures::future::ready(1i32)) //! .unwrap(); //! let (id2, handle2) = spawner //! .spawn_with_handle(futures::future::ready(2u32)) //! .unwrap(); //! //! spawned_ids.insert(id1); //! spawned_ids.insert(id2); //! //! while !spawned_ids.is_empty() { //! if let Some(completed) = pool.try_run_one() { //! assert!(spawned_ids.remove(&completed)) //! } //! } //! //! assert_eq!(handle1.now_or_never().unwrap(), 1); //! assert_eq!(handle2.now_or_never().unwrap(), 2); //! ``` use futures::executor::enter; use futures::future::{FutureObj, LocalFutureObj, RemoteHandle}; use futures::prelude::*; use futures::stream::FuturesUnordered; use futures::task::{waker_ref, ArcWake, LocalSpawn, Spawn, SpawnError}; use std::cell::RefCell; use std::pin::Pin; use std::rc::{Rc, Weak}; use std::sync::atomic::{AtomicBool, Ordering}; use std::sync::Arc; use std::task::{Context, Poll}; use std::thread; use std::thread::Thread; #[must_use = "futures do nothing unless you `.await` or poll them"] #[derive(Debug)] struct IndexWrapper<T> { data: T, // A future or a future's output index: usize, } impl<T> IndexWrapper<T> { pin_utils::unsafe_pinned!(data: T); } impl<T> Future for IndexWrapper<T> where T: Future, { type Output = IndexWrapper<T::Output>; fn poll(mut self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output> { self.as_mut() .data() .as_mut() .poll(cx) .map(|output| IndexWrapper { data: output, index: self.index, }) } } /// A single-threaded task pool for polling futures to completion. /// /// This executor allows you to multiplex any number of tasks onto a single /// thread. It's appropriate to poll strictly I/O-bound futures that do very /// little work in between I/O actions. /// /// To get a handle to the pool that implements /// [`Spawn`](futures_task::Spawn), use the /// [`spawner()`](LocalPool::spawner) method. Because the executor is /// single-threaded, it supports a special form of task spawning for non-`Send` /// futures, via [`spawn_local_obj`](futures_task::LocalSpawn::spawn_local_obj). #[derive(Debug)] pub struct LocalPool { pool: FuturesUnordered<IndexWrapper<LocalFutureObj<'static, ()>>>, incoming: Rc<Incoming>, } /// A handle to a [`LocalPool`](LocalPool) that implements /// [`Spawn`](futures_task::Spawn). #[derive(Clone, Debug)] pub struct LocalSpawner { incoming: Weak<Incoming>, } #[derive(Debug, Default)] struct IncomingTracking { queue: Vec<(usize, LocalFutureObj<'static, ()>)>, index: usize, } type Incoming = RefCell<IncomingTracking>; pub(crate) struct ThreadNotify { /// The (single) executor thread. thread: Thread, /// A flag to ensure a wakeup (i.e. `unpark()`) is not "forgotten" /// before the next `park()`, which may otherwise happen if the code /// being executed as part of the future(s) being polled makes use of /// park / unpark calls of its own, i.e. we cannot assume that no other /// code uses park / unpark on the executing `thread`. unparked: AtomicBool, } thread_local! { static CURRENT_THREAD_NOTIFY: Arc<ThreadNotify> = Arc::new(ThreadNotify { thread: thread::current(), unparked: AtomicBool::new(false), }); } impl ArcWake for ThreadNotify { fn wake_by_ref(arc_self: &Arc<Self>) { // Make sure the wakeup is remembered until the next `park()`. let unparked = arc_self.unparked.swap(true, Ordering::Relaxed); if !unparked { // If the thread has not been unparked yet, it must be done // now. If it was actually parked, it will run again, // otherwise the token made available by `unpark` // may be consumed before reaching `park()`, but `unparked` // ensures it is not forgotten. arc_self.thread.unpark(); } } } // Set up and run a basic single-threaded spawner loop, invoking `f` on each // turn. fn run_executor<T, F: FnMut(&mut Context<'_>) -> Poll<T>>(mut f: F) -> T { let _enter = enter().expect( "cannot execute `LocalPool` executor from within \ another executor", ); CURRENT_THREAD_NOTIFY.with(|thread_notify| { let waker = waker_ref(thread_notify); let mut cx = Context::from_waker(&waker); loop { if let Poll::Ready(t) = f(&mut cx) { return t; } // Consume the wakeup that occurred while executing `f`, if any. let unparked = thread_notify.unparked.swap(false, Ordering::Acquire); if !unparked { // No wakeup occurred. It may occur now, right before parking, // but in that case the token made available by `unpark()` // is guaranteed to still be available and `park()` is a no-op. thread::park(); // When the thread is unparked, `unparked` will have been set // and needs to be unset before the next call to `f` to avoid // a redundant loop iteration. thread_notify.unparked.store(false, Ordering::Release); } } }) } fn poll_executor<T, F: FnMut(&mut Context<'_>) -> T>(mut f: F) -> T { let _enter = enter().expect( "cannot execute `LocalPool` executor from within \ another executor", ); CURRENT_THREAD_NOTIFY.with(|thread_notify| { let waker = waker_ref(thread_notify); let mut cx = Context::from_waker(&waker); f(&mut cx) }) } impl LocalPool { /// Create a new, empty pool of tasks. pub fn new() -> LocalPool { LocalPool { pool: FuturesUnordered::new(), incoming: Default::default(), } } /// Get a clonable handle to the pool as a [`Spawn`]. pub fn spawner(&self) -> LocalSpawner { LocalSpawner { incoming: Rc::downgrade(&self.incoming), } } /// Run all tasks in the pool to completion. /// /// ``` /// use local_pool_with_id::LocalPool; /// /// let mut pool = LocalPool::new(); /// /// // ... spawn some initial tasks using `spawn.spawn()` or `spawn.spawn_local()` /// /// // run *all* tasks in the pool to completion, including any newly-spawned ones. /// pool.run(); /// ``` /// /// The function will block the calling thread until *all* tasks in the pool /// are complete, including any spawned while running existing tasks. pub fn run(&mut self) { run_executor(|cx| self.poll_pool(cx)) } /// Runs all the tasks in the pool until the given future completes. /// /// ``` /// use local_pool_with_id::LocalPool; /// /// let mut pool = LocalPool::new(); /// # let my_app = async {}; /// /// // run tasks in the pool until `my_app` completes /// pool.run_until(my_app); /// ``` /// /// The function will block the calling thread *only* until the future `f` /// completes; there may still be incomplete tasks in the pool, which will /// be inert after the call completes, but can continue with further use of /// one of the pool's run or poll methods. While the function is running, /// however, all tasks in the pool will try to make progress. pub fn run_until<F: Future>(&mut self, future: F) -> F::Output { pin_utils::pin_mut!(future); run_executor(|cx| { { // if our main task is done, so are we let result = future.as_mut().poll(cx); if let Poll::Ready(output) = result { return Poll::Ready(output); } } let _ = self.poll_pool(cx); Poll::Pending }) } /// Runs all tasks and returns after completing one future or until no more progress /// can be made. Returns the associated ID if one future was completed, `None` otherwise. /// /// ``` /// use local_pool_with_id::LocalPool; /// use futures::task::LocalSpawnExt; /// use futures::future::{ready, pending}; /// /// let mut pool = LocalPool::new(); /// let spawner = pool.spawner(); /// /// spawner.spawn_local(ready(())).unwrap(); /// spawner.spawn_local(ready(())).unwrap(); /// spawner.spawn_local(pending()).unwrap(); /// /// // Run the two ready tasks and returns the IDs for them. /// assert!(pool.try_run_one().is_some()); /// assert!(pool.try_run_one().is_some()); /// /// // the remaining task can not be completed /// assert!(pool.try_run_one().is_none()); // returns false /// ``` /// /// This function will not block the calling thread and will return the moment /// that there are no tasks left for which progress can be made or after exactly one /// task was completed; Remaining incomplete tasks in the pool can continue with /// further use of one of the pool's run or poll methods. /// Though only one task will be completed, progress may be made on multiple tasks. pub fn try_run_one(&mut self) -> Option<usize> { poll_executor(|ctx| { loop { let ret = self.poll_pool_once(ctx); // return if we have executed a future if let Poll::Ready(Some(key)) = ret { return Some(key); } // if there are no new incoming futures // then there is no feature that can make progress // and we can return without having completed a single future if self.incoming.borrow().queue.is_empty() { return None; } } }) } /// Runs all tasks in the pool and returns if no more progress can be made /// on any task. /// /// ``` /// use local_pool_with_id::LocalPool; /// use futures::task::LocalSpawnExt; /// use futures::future::{ready, pending}; /// /// let mut pool = LocalPool::new(); /// let spawner = pool.spawner(); /// /// spawner.spawn_local(ready(())).unwrap(); /// spawner.spawn_local(ready(())).unwrap(); /// spawner.spawn_local(pending()).unwrap(); /// /// // Runs the two ready task and returns. /// // The empty task remains in the pool. /// pool.run_until_stalled(); /// ``` /// /// This function will not block the calling thread and will return the moment /// that there are no tasks left for which progress can be made; /// remaining incomplete tasks in the pool can continue with further use of one /// of the pool's run or poll methods. While the function is running, all tasks /// in the pool will try to make progress. pub fn run_until_stalled(&mut self) { poll_executor(|ctx| { let _ = self.poll_pool(ctx); }); } // Make maximal progress on the entire pool of spawned task, returning `Ready` // if the pool is empty and `Pending` if no further progress can be made. fn poll_pool(&mut self, cx: &mut Context<'_>) -> Poll<()> { // state for the FuturesUnordered, which will never be used loop { let ret = self.poll_pool_once(cx); // we queued up some new tasks; add them and poll again if !self.incoming.borrow().queue.is_empty() { continue; } // no queued tasks; we may be done match ret { Poll::Pending => return Poll::Pending, Poll::Ready(None) => return Poll::Ready(()), _ => {} } } } // Try make minimal progress on the pool of spawned tasks fn poll_pool_once(&mut self, cx: &mut Context<'_>) -> Poll<Option<usize>> { // empty the incoming queue of newly-spawned tasks { let mut incoming = self.incoming.borrow_mut(); for (key, task) in incoming.queue.drain(..) { self.pool.push(IndexWrapper { data: task, index: key, }) } } // try to execute the next ready future self.pool .poll_next_unpin(cx) .map(|poll| poll.map(|wrapper| wrapper.index)) } } impl Default for LocalPool { fn default() -> Self { Self::new() } } impl Spawn for LocalSpawner { fn spawn_obj(&self, future: FutureObj<'static, ()>) -> Result<(), SpawnError> { self.spawn_obj_with_id(future).map(|_| ()) } fn status(&self) -> Result<(), SpawnError> { if self.incoming.upgrade().is_some() { Ok(()) } else { Err(SpawnError::shutdown()) } } } impl LocalSpawn for LocalSpawner { fn spawn_local_obj(&self, future: LocalFutureObj<'static, ()>) -> Result<(), SpawnError> { self.spawn_local_obj_with_id(future).map(|_| ()) } fn status_local(&self) -> Result<(), SpawnError> { if self.incoming.upgrade().is_some() { Ok(()) } else { Err(SpawnError::shutdown()) } } } impl SpawnWithId for LocalSpawner { fn spawn_obj_with_id(&self, future: FutureObj<'static, ()>) -> Result<usize, SpawnError> { if let Some(incoming) = self.incoming.upgrade() { let mut incoming = incoming.borrow_mut(); let id = incoming.index; incoming.index += 1; incoming.queue.push((id, future.into())); Ok(id) } else { Err(SpawnError::shutdown()) } } } impl LocalSpawnWithId for LocalSpawner { fn spawn_local_obj_with_id( &self, future: LocalFutureObj<'static, ()>, ) -> Result<usize, SpawnError> { if let Some(incoming) = self.incoming.upgrade() { let mut incoming = incoming.borrow_mut(); let id = incoming.index; incoming.index += 1; incoming.queue.push((id, future)); Ok(id) } else { Err(SpawnError::shutdown()) } } } pub trait SpawnWithId { fn spawn_obj_with_id(&self, future: FutureObj<'static, ()>) -> Result<usize, SpawnError>; } pub trait LocalSpawnWithId { fn spawn_local_obj_with_id( &self, future: LocalFutureObj<'static, ()>, ) -> Result<usize, SpawnError>; } impl<Sp: ?Sized> SpawnWithIdExt for Sp where Sp: SpawnWithId {} impl<Sp: ?Sized> LocalSpawnWithIdExt for Sp where Sp: LocalSpawnWithId {} /// Extension trait for `Spawn`. pub trait SpawnWithIdExt: SpawnWithId { /// Spawns a task that polls the given future with output `()` to /// completion. /// /// This method returns a [`Result`] that contains a [`SpawnError`] if /// spawning fails. /// /// You can use [`spawn_with_handle`](SpawnWithIdExt::spawn_with_handle) if /// you want to spawn a future with output other than `()` or if you want /// to be able to await its completion. /// /// Note this method will eventually be replaced with the upcoming /// `Spawn::spawn` method which will take a `dyn Future` as input. /// Technical limitations prevent `Spawn::spawn` from being implemented /// today. Feel free to use this method in the meantime. /// /// ``` /// use local_pool_with_id::LocalPool; /// use local_pool_with_id::SpawnWithIdExt; /// /// let executor = LocalPool::new(); /// let spawner = executor.spawner(); /// /// let future = async { /* ... */ }; /// spawner.spawn(future).unwrap(); /// ``` fn spawn<Fut>(&self, future: Fut) -> Result<usize, SpawnError> where Fut: Future<Output = ()> + Send + 'static, { self.spawn_obj_with_id(FutureObj::new(Box::new(future))) } /// Spawns a task that polls the given future to completion and returns a /// future that resolves to the spawned future's output. /// /// This method returns a [`Result`] that contains a [`RemoteHandle`](futures::future::RemoteHandle), or, if /// spawning fails, a [`SpawnError`]. [`RemoteHandle`](futures::future::RemoteHandle) is a future that /// resolves to the output of the spawned future. /// /// ``` /// use futures::executor::block_on; /// use futures::future; /// use local_pool_with_id::LocalPool; /// use local_pool_with_id::SpawnWithIdExt; /// /// let mut executor = LocalPool::new(); /// let spawner = executor.spawner(); /// /// let future = future::ready(1); /// let (id, join_handle_fut) = spawner.spawn_with_handle(future).unwrap(); /// assert_eq!(executor.run_until(join_handle_fut), 1); /// ``` fn spawn_with_handle<Fut>( &self, future: Fut, ) -> Result<(usize, RemoteHandle<Fut::Output>), SpawnError> where Fut: Future + Send + 'static, Fut::Output: Send, { let (future, handle) = future.remote_handle(); let id = self.spawn(future)?; Ok((id, handle)) } } /// Extension trait for `LocalSpawn`. pub trait LocalSpawnWithIdExt: LocalSpawnWithId { /// Spawns a task that polls the given future with output `()` to /// completion. /// /// This method returns a [`Result`] that contains a [`SpawnError`] if /// spawning fails. /// /// You can use [`spawn_with_handle`](SpawnWithIdExt::spawn_with_handle) if /// you want to spawn a future with output other than `()` or if you want /// to be able to await its completion. /// /// Note this method will eventually be replaced with the upcoming /// `Spawn::spawn` method which will take a `dyn Future` as input. /// Technical limitations prevent `Spawn::spawn` from being implemented /// today. Feel free to use this method in the meantime. /// /// ``` /// use local_pool_with_id::LocalPool; /// use local_pool_with_id::LocalSpawnWithIdExt; /// /// let executor = LocalPool::new(); /// let spawner = executor.spawner(); /// /// let future = async { /* ... */ }; /// spawner.spawn_local(future).unwrap(); /// ``` fn spawn_local<Fut>(&self, future: Fut) -> Result<usize, SpawnError> where Fut: Future<Output = ()> + 'static, { self.spawn_local_obj_with_id(LocalFutureObj::new(Box::new(future))) } /// Spawns a task that polls the given future to completion and returns a /// future that resolves to the spawned future's output. /// /// This method returns a [`Result`] that contains a [`RemoteHandle`](futures::future::RemoteHandle), or, if /// spawning fails, a [`SpawnError`]. [`RemoteHandle`](futures::future::RemoteHandle) is a future that /// resolves to the output of the spawned future. /// /// ``` /// use local_pool_with_id::LocalPool; /// use local_pool_with_id::LocalSpawnWithIdExt; /// /// let mut executor = LocalPool::new(); /// let spawner = executor.spawner(); /// /// let future = async { 1 }; /// let (id, join_handle_fut) = spawner.spawn_local_with_handle(future).unwrap(); /// assert_eq!(executor.run_until(join_handle_fut), 1); /// ``` fn spawn_local_with_handle<Fut>( &self, future: Fut, ) -> Result<(usize, RemoteHandle<Fut::Output>), SpawnError> where Fut: Future + 'static, { let (future, handle) = future.remote_handle(); let id = self.spawn_local(future)?; Ok((id, handle)) } } #[cfg(test)] mod tests { use super::*; #[test] fn tracking() { let mut spawned_ids = std::collections::HashSet::new(); let mut pool = LocalPool::new(); let spawner = pool.spawner(); let (id1, handle1) = spawner .spawn_with_handle(futures::future::ready(1i32)) .unwrap(); let (id2, handle2) = spawner .spawn_with_handle(futures::future::ready(2u32)) .unwrap(); spawned_ids.insert(id1); spawned_ids.insert(id2); while !spawned_ids.is_empty() { if let Some(completed) = pool.try_run_one() { assert!(spawned_ids.remove(&completed)) } } assert_eq!(handle1.now_or_never().unwrap(), 1); assert_eq!(handle2.now_or_never().unwrap(), 2); } }