preempt-rt 0.3.1

A lightweight Rust library for using the kernel's PREEMPT_RT scheduling functionality
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

use crate::sched::{IntoSchedParams, Scheduler};
use std::thread;

/// Spawn a thread with the provided scheduler and params.
///
/// Params can either be a SchedParams struct, or an i32 representing the desired priority.
/// This function validates that the priority is between min and max for the scheduler before
/// attempting to set it. It panics if the priority is outside the allowed range or setting the
/// scheduler returns an error code.
pub fn spawn<F, T>(
    scheduler: Scheduler,
    params: impl IntoSchedParams,
    f: F,
) -> thread::JoinHandle<T>
where
    F: FnOnce() -> T,
    F: Send + 'static,
    T: Send + 'static,
{
    try_spawn(scheduler, params, move |set_result| {
        set_result.expect("failed to set scheduler");
        f()
    })
}

/// Spawn a thread and attempt to set the schedule of the current thread. The result of setting
/// the scheduler is provided to the thread closure as an argument.
///
/// Params can either be a SchedParams struct, or an i32 representing the desired priority.
/// This function validates that the priority is between min and max for the scheduler before
/// attempting to set it. Failures will continue execution and pass through the Result to the
/// thread closure.
#[cfg(target_os = "linux")]
pub fn try_spawn<F, T>(
    scheduler: Scheduler,
    params: impl IntoSchedParams,
    f: F,
) -> thread::JoinHandle<T>
where
    F: FnOnce(crate::sched::RtResult<()>) -> T,
    F: Send + 'static,
    T: Send + 'static,
{
    let params = params.into_sched_params();
    thread::spawn(move || {
        let set_result = scheduler
            .with_params(params)
            .and_then(|ps| ps.set_current());
        f(set_result)
    })
}

/// Spawn a thread and attempt to set the schedule of the current thread. The result of setting
/// the scheduler is provided to the thread closure as an argument.
///
/// Params can either be a SchedParams struct, or an i32 representing the desired priority.
/// This function validates that the priority is between min and max for the scheduler before
/// attempting to set it. Failures will continue execution and pass through the Result to the
/// thread closure.
///
/// This is a stub version of the function that always passes PreemptRtError::NonLinuxPlatform
/// to the thread closure.
#[cfg(all(feature = "non-linux-stubs", target_os = "macos"))]
pub fn try_spawn<F, T>(
    _scheduler: Scheduler,
    _params: impl IntoSchedParams,
    f: F,
) -> thread::JoinHandle<T>
where
    F: FnOnce(crate::sched::RtResult<()>) -> T,
    F: Send + 'static,
    T: Send + 'static,
{
    thread::spawn(move || f(Err(crate::sched::PreemptRtError::NonLinuxPlatform("macos"))))
}