ax-task 0.8.0

OS-independent IRQ-safe SMP task scheduling core
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
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

//! Completion ownership for asynchronous remote affinity changes.

use alloc::sync::Arc;
use core::sync::atomic::{AtomicU64, Ordering};

use crate::{
    sync::WaitQueue,
    thread::{TaskError, ThreadCore, ThreadHandle, ThreadState},
};

/// Per-thread completion sequence shared by concurrent affinity setters.
#[derive(Debug)]
pub(crate) struct ThreadAffinityCompletion {
    completed_generation: AtomicU64,
    waiters: WaitQueue,
}

impl ThreadAffinityCompletion {
    pub(crate) const fn new(completed_generation: u64) -> Self {
        Self {
            completed_generation: AtomicU64::new(completed_generation),
            waiters: WaitQueue::new(),
        }
    }

    pub(crate) fn publish(&self, generation: u64) -> bool {
        let mut completed = self.completed_generation.load(Ordering::Acquire);
        loop {
            if completed >= generation {
                return false;
            }
            match self.completed_generation.compare_exchange_weak(
                completed,
                generation,
                Ordering::Release,
                Ordering::Acquire,
            ) {
                Ok(_) => return true,
                Err(observed) => completed = observed,
            }
        }
    }

    pub(crate) fn completed_generation(&self) -> u64 {
        self.completed_generation.load(Ordering::Acquire)
    }

    pub(crate) fn notify_waiters(&self) {
        self.waiters.notify_all();
    }

    fn wait_for(&self, request: &ThreadAffinityChange) -> Result<(), TaskError> {
        self.waiters
            .try_wait_until(|| request.try_result().is_some())?;
        request
            .try_result()
            .expect("affinity wait predicate resolved the request")
    }
}

/// Move-only completion for one generation of a remote affinity change.
#[derive(Debug)]
#[must_use = "dropping the change leaves the affinity update asynchronous"]
pub struct ThreadAffinityChange {
    thread: ThreadHandle,
    generation: u64,
}

impl ThreadAffinityChange {
    pub(crate) fn new(core: Arc<ThreadCore>, generation: u64) -> Self {
        Self {
            thread: ThreadHandle::from_core(core),
            generation,
        }
    }

    /// Returns the generation assigned to this affinity change.
    pub const fn generation(&self) -> u64 {
        self.generation
    }

    /// Observes completion, target exit, or a still-pending owner transition.
    pub fn try_result(&self) -> Option<Result<(), TaskError>> {
        if self
            .thread
            .core
            .affinity_completion()
            .completed_generation()
            >= self.generation
        {
            Some(Ok(()))
        } else if self.thread.state() == ThreadState::Exited {
            Some(Err(TaskError::StaleThreadId))
        } else {
            None
        }
    }

    /// Sleeps until the owner runqueue orders this generation.
    ///
    /// A later concurrent affinity update may supersede this request. In that
    /// case both requests complete after the owner has installed the latest
    /// placement, matching Linux's shared pending-affinity completion.
    ///
    /// # Errors
    ///
    /// Returns [`TaskError::StaleThreadId`] if the target exits before the
    /// generation completes, and propagates scheduler blocking failures.
    pub fn wait(self) -> Result<(), TaskError> {
        self.thread.core.affinity_completion().wait_for(&self)
    }
}