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 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230
use alloc::collections::VecDeque;
use alloc::sync::Arc;
use spinlock::SpinRaw;
use crate::{
schedule::{add_to_wait_queue, in_wait_queue, remove_from_wait_queue},
AxRunQueue, AxTaskRef, CurrentTask, RUN_QUEUE,
};
/// A queue to store sleeping tasks.
///
/// # Examples
///
/// ```
/// use axtask::WaitQueue;
/// use core::sync::atomic::{AtomicU32, Ordering};
///
/// static VALUE: AtomicU32 = AtomicU32::new(0);
/// static WQ: WaitQueue = WaitQueue::new();
///
/// axtask::init_scheduler();
/// // spawn a new task that updates `VALUE` and notifies the main task
/// axtask::spawn(|| {
/// assert_eq!(VALUE.load(Ordering::Relaxed), 0);
/// VALUE.fetch_add(1, Ordering::Relaxed);
/// WQ.notify_one(true); // wake up the main task
/// });
///
/// WQ.wait(); // block until `notify()` is called
/// assert_eq!(VALUE.load(Ordering::Relaxed), 1);
/// ```
pub struct WaitQueue {
queue: SpinRaw<VecDeque<AxTaskRef>>, // we already disabled IRQs when lock the `RUN_QUEUE`
}
impl WaitQueue {
/// Creates an empty wait queue.
pub const fn new() -> Self {
Self {
queue: SpinRaw::new(VecDeque::new()),
}
}
/// Creates an empty wait queue with space for at least `capacity` elements.
pub fn with_capacity(capacity: usize) -> Self {
Self {
queue: SpinRaw::new(VecDeque::with_capacity(capacity)),
}
}
fn cancel_events(&self, curr: CurrentTask) {
// A task can be wake up only one events (timer or `notify()`), remove
// the event from another queue.
if in_wait_queue(curr.as_task_ref()) {
// wake up by timer (timeout).
// `RUN_QUEUE` is not locked here, so disable IRQs.
let _guard = kernel_guard::IrqSave::new();
self.queue.lock().retain(|t| !curr.ptr_eq(t));
// curr.set_in_wait_queue(false);
remove_from_wait_queue(curr.as_task_ref());
}
#[cfg(feature = "irq")]
if crate::schedule::in_timer_list(curr.as_task_ref()) {
// timeout was set but not triggered (wake up by `WaitQueue::notify()`)
crate::timers::cancel_alarm(curr.as_task_ref());
}
}
/// Blocks the current task and put it into the wait queue, until other task
/// notifies it.
pub fn wait(&self) {
RUN_QUEUE.lock().block_current(|task| {
// task.set_in_wait_queue(true);
add_to_wait_queue(&task);
self.queue.lock().push_back(task)
});
self.cancel_events(crate::current());
}
/// Blocks the current task and put it into the wait queue, until the given
/// `condition` becomes true.
///
/// Note that even other tasks notify this task, it will not wake up until
/// the condition becomes true.
pub fn wait_until<F>(&self, condition: F)
where
F: Fn() -> bool,
{
loop {
let mut rq = RUN_QUEUE.lock();
if condition() {
break;
}
rq.block_current(|task| {
// task.set_in_wait_queue(true);
add_to_wait_queue(&task);
self.queue.lock().push_back(task);
});
}
self.cancel_events(crate::current());
}
/// Blocks the current task and put it into the wait queue, until other tasks
/// notify it, or the given duration has elapsed.
#[cfg(feature = "irq")]
pub fn wait_timeout(&self, dur: core::time::Duration) -> bool {
use crate::schedule::{add_to_wait_queue, in_wait_queue};
let curr = crate::current();
let deadline = axhal::time::current_time() + dur;
debug!(
"task wait_timeout: {} deadline={:?}",
curr.id_name(),
deadline
);
crate::timers::set_alarm_wakeup(deadline, curr.clone());
RUN_QUEUE.lock().block_current(|task| {
// task.set_in_wait_queue(true);
add_to_wait_queue(&task);
self.queue.lock().push_back(task)
});
// let timeout = curr.in_wait_queue(); // still in the wait queue, must have timed out
let timeout = in_wait_queue(curr.as_task_ref());
self.cancel_events(curr);
timeout
}
/// Blocks the current task and put it into the wait queue, until the given
/// `condition` becomes true, or the given duration has elapsed.
///
/// Note that even other tasks notify this task, it will not wake up until
/// the above conditions are met.
#[cfg(feature = "irq")]
pub fn wait_timeout_until<F>(&self, dur: core::time::Duration, condition: F) -> bool
where
F: Fn() -> bool,
{
let curr = crate::current();
let deadline = axhal::time::current_time() + dur;
debug!(
"task wait_timeout: {}, deadline={:?}",
curr.id_name(),
deadline
);
crate::timers::set_alarm_wakeup(deadline, curr.clone());
let mut timeout = true;
while axhal::time::current_time() < deadline {
let mut rq = RUN_QUEUE.lock();
if condition() {
timeout = false;
break;
}
rq.block_current(|task| {
// task.set_in_wait_queue(true);
add_to_wait_queue(&task);
self.queue.lock().push_back(task);
});
}
self.cancel_events(curr);
timeout
}
/// Wakes up one task in the wait queue, usually the first one.
///
/// If `resched` is true, the current task will be preempted when the
/// preemption is enabled.
pub fn notify_one(&self, resched: bool) -> bool {
let mut rq = RUN_QUEUE.lock();
if !self.queue.lock().is_empty() {
self.notify_one_locked(resched, &mut rq)
} else {
false
}
}
/// Wakes all tasks in the wait queue.
///
/// If `resched` is true, the current task will be preempted when the
/// preemption is enabled.
pub fn notify_all(&self, resched: bool) {
loop {
let mut rq = RUN_QUEUE.lock();
if let Some(task) = self.queue.lock().pop_front() {
// task.set_in_wait_queue(false);
remove_from_wait_queue(&task);
rq.unblock_task(task, resched);
} else {
break;
}
drop(rq); // we must unlock `RUN_QUEUE` after unlocking `self.queue`.
}
}
/// Wake up the given task in the wait queue.
///
/// If `resched` is true, the current task will be preempted when the
/// preemption is enabled.
pub fn notify_task(&self, resched: bool, task: &AxTaskRef) -> bool {
let mut rq = RUN_QUEUE.lock();
let mut wq = self.queue.lock();
if let Some(index) = wq.iter().position(|t| Arc::ptr_eq(t, task)) {
// task.set_in_wait_queue(false);
remove_from_wait_queue(task);
rq.unblock_task(wq.remove(index).unwrap(), resched);
true
} else {
false
}
}
pub(crate) fn notify_one_locked(&self, resched: bool, rq: &mut AxRunQueue) -> bool {
if let Some(task) = self.queue.lock().pop_front() {
// task.set_in_wait_queue(false);
remove_from_wait_queue(&task);
rq.unblock_task(task, resched);
true
} else {
false
}
}
pub(crate) fn notify_all_locked(&self, resched: bool, rq: &mut AxRunQueue) {
while let Some(task) = self.queue.lock().pop_front() {
// task.set_in_wait_queue(false);
remove_from_wait_queue(&task);
rq.unblock_task(task, resched);
}
}
}