src/libstd/future.rs

   1 //! Asynchronous values.
   2
   3 use core::cell::Cell;
   4 use core::marker::Unpin;
   5 use core::ops::{Drop, Generator, GeneratorState};
   6 use core::option::Option;
   7 use core::pin::Pin;
   8 use core::ptr::NonNull;
   9 use core::task::{Context, Poll};
  10
  11 #[doc(inline)]
  12 #[stable(feature = "futures_api", since = "1.36.0")]
  13 pub use core::future::*;
  14
  15 /// Wrap a generator in a future.
  16 ///
  17 /// This function returns a `GenFuture` underneath, but hides it in `impl Trait` to give
  18 /// better error messages (`impl Future` rather than `GenFuture<[closure.....]>`).
  19 #[doc(hidden)]
  20 #[unstable(feature = "gen_future", issue = "50547")]
  21 pub fn from_generator<T: Generator<Yield = ()>>(x: T) -> impl Future<Output = T::Return> {
  22     GenFuture(x)
  23 }
  24
  25 /// A wrapper around generators used to implement `Future` for `async`/`await` code.
  26 #[doc(hidden)]
  27 #[unstable(feature = "gen_future", issue = "50547")]
  28 #[derive(Copy, Clone, Debug, Eq, PartialEq, Ord, PartialOrd, Hash)]
  29 struct GenFuture<T: Generator<Yield = ()>>(T);
  30
  31 // We rely on the fact that async/await futures are immovable in order to create
  32 // self-referential borrows in the underlying generator.
  33 impl<T: Generator<Yield = ()>> !Unpin for GenFuture<T> {}
  34
  35 #[doc(hidden)]
  36 #[unstable(feature = "gen_future", issue = "50547")]
  37 impl<T: Generator<Yield = ()>> Future for GenFuture<T> {
  38     type Output = T::Return;
  39     fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output> {
  40         // Safe because we're !Unpin + !Drop mapping to a ?Unpin value
  41         let gen = unsafe { Pin::map_unchecked_mut(self, |s| &mut s.0) };
  42         let _guard = unsafe { set_task_context(cx) };
  43         match gen.resume(
  44             #[cfg(not(bootstrap))]
  45             (),
  46         ) {
  47             GeneratorState::Yielded(()) => Poll::Pending,
  48             GeneratorState::Complete(x) => Poll::Ready(x),
  49         }
  50     }
  51 }
  52
  53 thread_local! {
  54     static TLS_CX: Cell<Option<NonNull<Context<'static>>>> = Cell::new(None);
  55 }
  56
  57 struct SetOnDrop(Option<NonNull<Context<'static>>>);
  58
  59 impl Drop for SetOnDrop {
  60     fn drop(&mut self) {
  61         TLS_CX.with(|tls_cx| {
  62             tls_cx.set(self.0.take());
  63         });
  64     }
  65 }
  66
  67 // Safety: the returned guard must drop before `cx` is dropped and before
  68 // any previous guard is dropped.
  69 unsafe fn set_task_context(cx: &mut Context<'_>) -> SetOnDrop {
  70     // transmute the context's lifetime to 'static so we can store it.
  71     let cx = core::mem::transmute::<&mut Context<'_>, &mut Context<'static>>(cx);
  72     let old_cx = TLS_CX.with(|tls_cx| tls_cx.replace(Some(NonNull::from(cx))));
  73     SetOnDrop(old_cx)
  74 }
  75
  76 #[doc(hidden)]
  77 #[unstable(feature = "gen_future", issue = "50547")]
  78 /// Polls a future in the current thread-local task waker.
  79 pub fn poll_with_tls_context<F>(f: Pin<&mut F>) -> Poll<F::Output>
  80 where
  81     F: Future,
  82 {
  83     let cx_ptr = TLS_CX.with(|tls_cx| {
  84         // Clear the entry so that nested `get_task_waker` calls
  85         // will fail or set their own value.
  86         tls_cx.replace(None)
  87     });
  88     let _reset = SetOnDrop(cx_ptr);
  89
  90     let mut cx_ptr = cx_ptr.expect(
  91         "TLS Context not set. This is a rustc bug. \
  92         Please file an issue on https://github.com/rust-lang/rust.",
  93     );
  94
  95     // Safety: we've ensured exclusive access to the context by
  96     // removing the pointer from TLS, only to be replaced once
  97     // we're done with it.
  98     //
  99     // The pointer that was inserted came from an `&mut Context<'_>`,
 100     // so it is safe to treat as mutable.
 101     unsafe { F::poll(f, cx_ptr.as_mut()) }
 102 }