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

//! Scheduling policy, CPU placement and runtime accounting.

use crate::{
    runtime::context::{runtime_task_system, validate_task_context},
    thread::TaskError,
};
pub use crate::{
    sched::{
        affinity::ThreadAffinityChange,
        algorithm::SchedulerTimestamp,
        policy::{DeadlineFlags, DeadlinePolicy, FairMode, Nice, RtPriority, SchedulePolicy},
    },
    thread::spec::CpuSet,
};

/// A logical processor identifier in the configured topology.
#[repr(transparent)]
#[derive(Clone, Copy, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
pub struct CpuId(u32);

impl CpuId {
    /// Creates a logical processor identifier.
    pub const fn new(value: u32) -> Self {
        Self(value)
    }

    /// Returns the numeric identifier.
    pub const fn as_u32(self) -> u32 {
        self.0
    }

    /// Returns the identifier as an array index.
    pub const fn as_usize(self) -> usize {
        self.0 as usize
    }
}

/// Returns cumulative non-idle runtime charged by one online CPU.
pub fn cpu_busy_runtime_ns(cpu: CpuId) -> Result<u64, TaskError> {
    runtime_task_system()?.cpu_busy_runtime_ns(cpu)
}

/// Returns the fixed topology width accepted by scheduler affinity masks.
pub fn cpu_topology_len() -> Result<usize, TaskError> {
    Ok(runtime_task_system()?.cpu_topology_len())
}

/// Returns the CPUs that currently accept runnable placement.
///
/// Unlike [`cpu_topology_len`], this snapshot excludes possible CPUs that have
/// not completed scheduler online publication or no longer accept new work.
pub fn active_cpu_set() -> Result<CpuSet, TaskError> {
    validate_task_context()?;
    Ok(runtime_task_system()?.active_cpu_set())
}

pub(crate) mod algorithm;

pub(crate) mod system;

pub(crate) mod policy;

pub(crate) mod affinity;

pub use crate::sched::system::{
    ChargeOutcome, DeadlineActivity, DeadlineActivitySnapshot, DeadlineBandwidthSnapshot,
    DeadlineRuntimeSnapshot, SchedulingClass,
};