use core::ptr; use core::ptr::NonNull; use atomic_polyfill::{AtomicPtr, Ordering}; use critical_section::CriticalSection; use super::TaskHeader; pub(crate) struct RunQueueItem { next: AtomicPtr<TaskHeader>, } impl RunQueueItem { pub const fn new() -> Self { Self { next: AtomicPtr::new(ptr::null_mut()), } } } /// Atomic task queue using a very, very simple lock-free linked-list queue: /// /// To enqueue a task, task.next is set to the old head, and head is atomically set to task. /// /// Dequeuing is done in batches: the queue is emptied by atomically replacing head with /// null. Then the batch is iterated following the next pointers until null is reached. /// /// Note that batches will be iterated in the reverse order as they were enqueued. This is OK /// for our purposes: it can't create fairness problems since the next batch won't run until the /// current batch is completely processed, so even if a task enqueues itself instantly (for example /// by waking its own waker) can't prevent other tasks from running. pub(crate) struct RunQueue { head: AtomicPtr<TaskHeader>, } impl RunQueue { pub const fn new() -> Self { Self { head: AtomicPtr::new(ptr::null_mut()), } } /// Enqueues an item. Returns true if the queue was empty. /// /// # Safety /// /// `item` must NOT be already enqueued in any queue. #[inline(always)] pub(crate) unsafe fn enqueue(&self, _cs: CriticalSection, task: NonNull<TaskHeader>) -> bool { let prev = self.head.load(Ordering::Relaxed); task.as_ref().run_queue_item.next.store(prev, Ordering::Relaxed); self.head.store(task.as_ptr(), Ordering::Relaxed); prev.is_null() } /// Empty the queue, then call `on_task` for each task that was in the queue. /// NOTE: It is OK for `on_task` to enqueue more tasks. In this case they're left in the queue /// and will be processed by the *next* call to `dequeue_all`, *not* the current one. pub(crate) fn dequeue_all(&self, on_task: impl Fn(NonNull<TaskHeader>)) { // Atomically empty the queue. let mut ptr = self.head.swap(ptr::null_mut(), Ordering::AcqRel); // Iterate the linked list of tasks that were previously in the queue. while let Some(task) = NonNull::new(ptr) { // If the task re-enqueues itself, the `next` pointer will get overwritten. // Therefore, first read the next pointer, and only then process the task. let next = unsafe { task.as_ref() }.run_queue_item.next.load(Ordering::Relaxed); on_task(task); ptr = next } } }