use crate::future::Future; use crate::runtime::task::harness::Harness; use crate::runtime::task::{Header, Schedule}; use std::marker::PhantomData; use std::mem::ManuallyDrop; use std::ops; use std::ptr::NonNull; use std::task::{RawWaker, RawWakerVTable, Waker}; pub(super) struct WakerRef<'a, S: 'static> { waker: ManuallyDrop, _p: PhantomData<(&'a Header, S)>, } /// Returns a `WakerRef` which avoids having to pre-emptively increase the /// refcount if there is no need to do so. pub(super) fn waker_ref(header: &Header) -> WakerRef<'_, S> where T: Future, S: Schedule, { // `Waker::will_wake` uses the VTABLE pointer as part of the check. This // means that `will_wake` will always return false when using the current // task's waker. (discussion at rust-lang/rust#66281). // // To fix this, we use a single vtable. Since we pass in a reference at this // point and not an *owned* waker, we must ensure that `drop` is never // called on this waker instance. This is done by wrapping it with // `ManuallyDrop` and then never calling drop. let waker = unsafe { ManuallyDrop::new(Waker::from_raw(raw_waker::(header))) }; WakerRef { waker, _p: PhantomData, } } impl ops::Deref for WakerRef<'_, S> { type Target = Waker; fn deref(&self) -> &Waker { &self.waker } } cfg_trace! { macro_rules! trace { ($harness:expr, $op:expr) => { if let Some(id) = $harness.id() { tracing::trace!( target: "tokio::task::waker", op = $op, task.id = id.into_u64(), ); } } } } cfg_not_trace! { macro_rules! trace { ($harness:expr, $op:expr) => { // noop let _ = &$harness; } } } unsafe fn clone_waker(ptr: *const ()) -> RawWaker where T: Future, S: Schedule, { let header = ptr as *const Header; let ptr = NonNull::new_unchecked(ptr as *mut Header); let harness = Harness::::from_raw(ptr); trace!(harness, "waker.clone"); (*header).state.ref_inc(); raw_waker::(header) } unsafe fn drop_waker(ptr: *const ()) where T: Future, S: Schedule, { let ptr = NonNull::new_unchecked(ptr as *mut Header); let harness = Harness::::from_raw(ptr); trace!(harness, "waker.drop"); harness.drop_reference(); } unsafe fn wake_by_val(ptr: *const ()) where T: Future, S: Schedule, { let ptr = NonNull::new_unchecked(ptr as *mut Header); let harness = Harness::::from_raw(ptr); trace!(harness, "waker.wake"); harness.wake_by_val(); } // Wake without consuming the waker unsafe fn wake_by_ref(ptr: *const ()) where T: Future, S: Schedule, { let ptr = NonNull::new_unchecked(ptr as *mut Header); let harness = Harness::::from_raw(ptr); trace!(harness, "waker.wake_by_ref"); harness.wake_by_ref(); } fn raw_waker(header: *const Header) -> RawWaker where T: Future, S: Schedule, { let ptr = header as *const (); let vtable = &RawWakerVTable::new( clone_waker::, wake_by_val::, wake_by_ref::, drop_waker::, ); RawWaker::new(ptr, vtable) }