ax-ipi 0.5.9

ArceOS IPI management module
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

use alloc::collections::VecDeque;

use crate::event::{Callback, IpiEvent};

/// A queue of IPI events.
///
/// It internally uses a `VecDeque` to store the events, make it
/// possible to pop these events using FIFO order.
pub struct IpiEventQueue {
    events: VecDeque<IpiEvent>,
}

impl IpiEventQueue {
    /// Create a new empty timer list.
    pub fn new() -> Self {
        Self {
            events: VecDeque::new(),
        }
    }

    /// Whether there is no event.
    #[allow(dead_code)]
    #[inline]
    pub fn is_empty(&self) -> bool {
        self.events.is_empty()
    }

    /// Push a new event into the queue.
    pub fn push(&mut self, src_cpu_id: usize, callback: Callback) {
        self.events.push_back(IpiEvent {
            src_cpu_id,
            callback,
        });
    }

    /// Try to pop the latest event that exists in the queue.
    ///
    /// Return `None` if no event is available.
    #[must_use]
    pub fn pop_one(&mut self) -> Option<(usize, Callback)> {
        if let Some(e) = self.events.pop_front() {
            Some((e.src_cpu_id, e.callback))
        } else {
            None
        }
    }
}

impl Default for IpiEventQueue {
    fn default() -> Self {
        Self::new()
    }
}