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

#[cfg(feature = "priority_boost")]
use core::sync::atomic::Ordering;
use r3_core::kernel::{traits::KernelBase as _, BoostPriorityError};

use crate::{error::BadContextError, KernelTraits, System};
#[cfg(feature = "priority_boost")]
use crate::{klock, task};

/// If the current context is not a task context, return `Err(BadContext)`.
pub(super) fn expect_task_context<Traits: KernelTraits>() -> Result<(), BadContextError> {
    if !Traits::is_task_context() {
        Err(BadContextError::BadContext)
    } else {
        Ok(())
    }
}

/// If the current context is not waitable, return `Err(BadContext)`.
pub(super) fn expect_waitable_context<Traits: KernelTraits>() -> Result<(), BadContextError> {
    if !Traits::is_task_context() || System::<Traits>::raw_is_priority_boost_active() {
        Err(BadContextError::BadContext)
    } else {
        Ok(())
    }
}

/// Implements `Kernel::boost_priority`.
#[cfg(feature = "priority_boost")]
pub(super) fn boost_priority<Traits: KernelTraits>() -> Result<(), BoostPriorityError> {
    if Traits::is_cpu_lock_active()
        || !Traits::is_task_context()
        || System::<Traits>::raw_is_priority_boost_active()
    {
        Err(BoostPriorityError::BadContext)
    } else {
        Traits::state()
            .priority_boost
            .store(true, Ordering::Relaxed);
        Ok(())
    }
}

/// Implements `Kernel::unboost_priority`.
#[cfg(feature = "priority_boost")]
pub(super) fn unboost_priority<Traits: KernelTraits>() -> Result<(), BoostPriorityError> {
    if !Traits::is_task_context() || !System::<Traits>::raw_is_priority_boost_active() {
        Err(BoostPriorityError::BadContext)
    } else {
        // Acquire CPU Lock after checking other states so that
        // `drop_in_place(&mut lock)` doesn't get emitted twice
        let lock = klock::lock_cpu()?;
        Traits::state()
            .priority_boost
            .store(false, Ordering::Relaxed);

        // Check pending preemption
        task::unlock_cpu_and_check_preemption::<Traits>(lock);
        Ok(())
    }
}

/// Implements `Kernel::unboost_priority`.
#[cfg(not(feature = "priority_boost"))]
#[expect(clippy::extra_unused_type_parameters)]
pub(super) fn unboost_priority<Traits: KernelTraits>() -> Result<(), BoostPriorityError> {
    // Priority Boost is disabled statically, so this function will always
    // return `BadContext`
    Err(BoostPriorityError::BadContext)
}