tokio 1.52.1

An event-driven, non-blocking I/O platform for writing asynchronous I/O backed applications.
Documentation 
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

use crate::loom::sync::atomic::AtomicPtr;
use crate::runtime::task::{Header, Notified, RawTask};

use std::marker::PhantomData;
use std::ptr;
use std::ptr::NonNull;
use std::sync::atomic::Ordering::SeqCst;

/// An atomic cell which can contain a pointer to a [`Notified`] task.
///
/// This is similar to the `crate::util::AtomicCell` type, but specialized to
/// hold a task pointer --- this type "remembers" the task's scheduler generic
/// when a task is stored in the cell, so that the pointer can be turned back
/// into a [`Notified`] task with the correct generic type when it is retrieved.
pub(crate) struct AtomicNotified<S: 'static> {
    task: AtomicPtr<Header>,
    _scheduler: PhantomData<S>,
}

impl<S: 'static> AtomicNotified<S> {
    pub(crate) fn empty() -> Self {
        Self {
            task: AtomicPtr::new(ptr::null_mut()),
            _scheduler: PhantomData,
        }
    }

    pub(crate) fn swap(&self, task: Option<Notified<S>>) -> Option<Notified<S>> {
        let new = task
            .map(|t| t.into_raw().header_ptr().as_ptr())
            .unwrap_or_else(ptr::null_mut);
        let old = self.task.swap(new, SeqCst);
        NonNull::new(old).map(|ptr| unsafe {
            // Safety: since we only allow tasks with the same scheduler type to
            // be placed in this cell, we know that the pointed task's scheduler
            // type matches the type parameter S.
            Notified::from_raw(RawTask::from_raw(ptr))
        })
    }

    pub(crate) fn take(&self) -> Option<Notified<S>> {
        self.swap(None)
    }

    pub(crate) fn is_some(&self) -> bool {
        !self.task.load(SeqCst).is_null()
    }
}

unsafe impl<S: Send> Send for AtomicNotified<S> {}
unsafe impl<S: Send> Sync for AtomicNotified<S> {}

impl<S> Drop for AtomicNotified<S> {
    fn drop(&mut self) {
        // Ensure the task reference is dropped if this cell is dropped.
        let _ = self.take();
    }
}