ax-task 0.8.2

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

//! Root-domain SCHED_DEADLINE bandwidth admission.

use crate::{sched::DeadlinePolicy, thread::TaskError};

pub(crate) const DEADLINE_UTILIZATION_SCALE: u64 = 1_000_000_000;

/// Admission accounting for one online root domain.
#[derive(Clone, Copy, Debug, Eq, PartialEq)]
pub(crate) struct DeadlineAdmission {
    cap_percent: u8,
    online_cpus: u32,
    reserved_scaled: u64,
}

impl DeadlineAdmission {
    /// Creates empty admission state.
    pub(crate) const fn new(cap_percent: u8) -> Self {
        Self {
            cap_percent,
            online_cpus: 0,
            reserved_scaled: 0,
        }
    }

    /// Updates the number of CPUs belonging to the online root domain.
    pub(crate) const fn set_online_cpus(&mut self, online_cpus: u32) {
        self.online_cpus = online_cpus;
    }

    /// Reserves utilization for a Deadline policy.
    ///
    /// # Errors
    ///
    /// Returns [`TaskError::DeadlineAdmission`] if the reservation exceeds the
    /// configured root-domain cap.
    #[cfg(test)]
    fn reserve(&mut self, policy: DeadlinePolicy) -> Result<u64, TaskError> {
        let utilization = Self::utilization(policy);
        self.reserve_utilization(utilization)?;
        Ok(utilization)
    }

    pub(crate) fn reserve_utilization(&mut self, utilization: u64) -> Result<(), TaskError> {
        self.replace_utilization(0, utilization)
    }

    pub(crate) fn replace_utilization(
        &mut self,
        old_utilization: u64,
        new_utilization: u64,
    ) -> Result<(), TaskError> {
        let without_old = self
            .reserved_scaled
            .checked_sub(old_utilization)
            .ok_or(TaskError::InvalidConfiguration)?;
        let next = without_old
            .checked_add(new_utilization)
            .ok_or(TaskError::DeadlineAdmission)?;
        if next > self.capacity_scaled() {
            return Err(TaskError::DeadlineAdmission);
        }
        self.reserved_scaled = next;
        Ok(())
    }

    pub(crate) fn utilization(policy: DeadlinePolicy) -> u64 {
        scaled_utilization(policy)
    }

    /// Releases a value returned by [`Self::reserve`].
    #[cfg(test)]
    fn release(&mut self, utilization: u64) -> Result<(), TaskError> {
        self.replace_utilization(utilization, 0)
    }

    /// Returns the currently reserved fixed-point utilization.
    pub const fn reserved_scaled(self) -> u64 {
        self.reserved_scaled
    }

    /// Returns the fixed-point capacity of the online root domain.
    pub const fn capacity_scaled(self) -> u64 {
        (self.online_cpus as u64) * (self.cap_percent as u64) * DEADLINE_UTILIZATION_SCALE / 100
    }
}

fn scaled_utilization(policy: DeadlinePolicy) -> u64 {
    let numerator = (policy.runtime_ns() as u128) * (DEADLINE_UTILIZATION_SCALE as u128);
    let period = policy.period_ns() as u128;
    u64::try_from(numerator.div_ceil(period))
        .expect("a validated Deadline reservation cannot exceed one CPU")
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::sched::DeadlineFlags;

    #[test]
    fn enforces_the_root_domain_cap() {
        let mut admission = DeadlineAdmission::new(95);
        admission.set_online_cpus(1);
        let half = DeadlinePolicy::new(5, 10, 10, DeadlineFlags::NONE).unwrap();
        let first = admission.reserve(half).unwrap();
        assert_eq!(first, 500_000_000);
        assert_eq!(admission.reserve(half), Err(TaskError::DeadlineAdmission));
        admission.release(first).unwrap();
        assert_eq!(admission.release(1), Err(TaskError::InvalidConfiguration));
        assert_eq!(admission.reserved_scaled(), 0);
    }
}